alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.incubator.store.meter.impl; |
| 17 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 18 | import com.google.common.collect.Collections2; |
| 19 | import com.google.common.collect.Maps; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 20 | import org.apache.felix.scr.annotations.Activate; |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 21 | import org.apache.felix.scr.annotations.Component; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 22 | import org.apache.felix.scr.annotations.Deactivate; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Reference; |
| 24 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 25 | import org.apache.felix.scr.annotations.Service; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 26 | import org.onosproject.cluster.ClusterService; |
| 27 | import org.onosproject.cluster.NodeId; |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 28 | import org.onosproject.mastership.MastershipService; |
| 29 | import org.onosproject.net.meter.Band; |
| 30 | import org.onosproject.net.meter.DefaultBand; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 31 | import org.onosproject.net.meter.DefaultMeter; |
| 32 | import org.onosproject.net.meter.Meter; |
| 33 | import org.onosproject.net.meter.MeterEvent; |
| 34 | import org.onosproject.net.meter.MeterFailReason; |
| 35 | import org.onosproject.net.meter.MeterId; |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 36 | import org.onosproject.net.meter.MeterKey; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 37 | import org.onosproject.net.meter.MeterOperation; |
| 38 | import org.onosproject.net.meter.MeterState; |
| 39 | import org.onosproject.net.meter.MeterStore; |
| 40 | import org.onosproject.net.meter.MeterStoreDelegate; |
| 41 | import org.onosproject.net.meter.MeterStoreResult; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 42 | import org.onosproject.store.AbstractStore; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 43 | import org.onosproject.store.serializers.KryoNamespaces; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 44 | import org.onosproject.store.service.ConsistentMap; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 45 | import org.onosproject.store.service.MapEvent; |
| 46 | import org.onosproject.store.service.MapEventListener; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 47 | import org.onosproject.store.service.Serializer; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 48 | import org.onosproject.store.service.StorageException; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 49 | import org.onosproject.store.service.StorageService; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 50 | import org.onosproject.store.service.Versioned; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 51 | import org.slf4j.Logger; |
| 52 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 53 | import java.util.Arrays; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 54 | import java.util.Collection; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 55 | import java.util.Map; |
| 56 | import java.util.concurrent.CompletableFuture; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 57 | |
| 58 | import static org.slf4j.LoggerFactory.getLogger; |
| 59 | |
| 60 | /** |
| 61 | * A distributed meter store implementation. Meters are stored consistently |
| 62 | * across the cluster. |
| 63 | */ |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 64 | @Component(immediate = true) |
| 65 | @Service |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 66 | public class DistributedMeterStore extends AbstractStore<MeterEvent, MeterStoreDelegate> |
| 67 | implements MeterStore { |
| 68 | |
| 69 | private Logger log = getLogger(getClass()); |
| 70 | |
| 71 | private static final String METERSTORE = "onos-meter-store"; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 72 | |
| 73 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 74 | private StorageService storageService; |
| 75 | |
| 76 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 77 | private MastershipService mastershipService; |
| 78 | |
| 79 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 80 | private ClusterService clusterService; |
| 81 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 82 | private ConsistentMap<MeterKey, MeterData> meters; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 83 | private NodeId local; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 84 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 85 | private MapEventListener mapListener = new InternalMapEventListener(); |
| 86 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 87 | private Map<MeterKey, CompletableFuture<MeterStoreResult>> futures = |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 88 | Maps.newConcurrentMap(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 89 | |
| 90 | @Activate |
| 91 | public void activate() { |
| 92 | |
| 93 | local = clusterService.getLocalNode().id(); |
| 94 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 95 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 96 | meters = storageService.<MeterKey, MeterData>consistentMapBuilder() |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 97 | .withName(METERSTORE) |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 98 | .withSerializer(Serializer.using(Arrays.asList(KryoNamespaces.API), |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 99 | MeterKey.class, |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 100 | MeterData.class, |
| 101 | DefaultMeter.class, |
| 102 | DefaultBand.class, |
| 103 | Band.Type.class, |
| 104 | MeterState.class, |
| 105 | Meter.Unit.class, |
| 106 | MeterFailReason.class, |
| 107 | MeterId.class)).build(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 108 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 109 | meters.addListener(mapListener); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 110 | |
| 111 | log.info("Started"); |
| 112 | } |
| 113 | |
| 114 | @Deactivate |
| 115 | public void deactivate() { |
| 116 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 117 | meters.removeListener(mapListener); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 118 | log.info("Stopped"); |
| 119 | } |
| 120 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 121 | |
| 122 | @Override |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 123 | public CompletableFuture<MeterStoreResult> storeMeter(Meter meter) { |
| 124 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 125 | MeterKey key = MeterKey.key(meter.deviceId(), meter.id()); |
| 126 | futures.put(key, future); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 127 | MeterData data = new MeterData(meter, null, local); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 128 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 129 | try { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 130 | meters.put(key, data); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 131 | } catch (StorageException e) { |
| 132 | future.completeExceptionally(e); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 133 | } |
| 134 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 135 | return future; |
| 136 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 137 | } |
| 138 | |
| 139 | @Override |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 140 | public CompletableFuture<MeterStoreResult> deleteMeter(Meter meter) { |
| 141 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 142 | MeterKey key = MeterKey.key(meter.deviceId(), meter.id()); |
| 143 | futures.put(key, future); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 144 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 145 | MeterData data = new MeterData(meter, null, local); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 146 | |
| 147 | // update the state of the meter. It will be pruned by observing |
| 148 | // that it has been removed from the dataplane. |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 149 | try { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 150 | if (meters.computeIfPresent(key, (k, v) -> data) == null) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 151 | future.complete(MeterStoreResult.success()); |
| 152 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 153 | } catch (StorageException e) { |
| 154 | future.completeExceptionally(e); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 155 | } |
| 156 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 157 | |
| 158 | return future; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | @Override |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 162 | public CompletableFuture<MeterStoreResult> updateMeter(Meter meter) { |
| 163 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 164 | MeterKey key = MeterKey.key(meter.deviceId(), meter.id()); |
| 165 | futures.put(key, future); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 166 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 167 | MeterData data = new MeterData(meter, null, local); |
| 168 | try { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 169 | if (meters.computeIfPresent(key, (k, v) -> data) == null) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 170 | future.complete(MeterStoreResult.fail(MeterFailReason.INVALID_METER)); |
| 171 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 172 | } catch (StorageException e) { |
| 173 | future.completeExceptionally(e); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 174 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 175 | return future; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 176 | } |
| 177 | |
| 178 | @Override |
| 179 | public void updateMeterState(Meter meter) { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 180 | MeterKey key = MeterKey.key(meter.deviceId(), meter.id()); |
| 181 | meters.computeIfPresent(key, (k, v) -> { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 182 | DefaultMeter m = (DefaultMeter) v.meter(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 183 | m.setState(meter.state()); |
| 184 | m.setProcessedPackets(meter.packetsSeen()); |
| 185 | m.setProcessedBytes(meter.bytesSeen()); |
| 186 | m.setLife(meter.life()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 187 | // TODO: Prune if drops to zero. |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 188 | m.setReferenceCount(meter.referenceCount()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 189 | return new MeterData(m, null, v.origin()); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 190 | }); |
| 191 | } |
| 192 | |
| 193 | @Override |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 194 | public Meter getMeter(MeterKey key) { |
| 195 | MeterData data = Versioned.valueOrElse(meters.get(key), null); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 196 | return data == null ? null : data.meter(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 197 | } |
| 198 | |
| 199 | @Override |
| 200 | public Collection<Meter> getAllMeters() { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 201 | return Collections2.transform(meters.asJavaMap().values(), |
| 202 | MeterData::meter); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 203 | } |
| 204 | |
| 205 | @Override |
| 206 | public void failedMeter(MeterOperation op, MeterFailReason reason) { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 207 | MeterKey key = MeterKey.key(op.meter().deviceId(), op.meter().id()); |
| 208 | meters.computeIfPresent(key, (k, v) -> |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 209 | new MeterData(v.meter(), reason, v.origin())); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 210 | } |
| 211 | |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 212 | @Override |
| 213 | public void deleteMeterNow(Meter m) { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 214 | MeterKey key = MeterKey.key(m.deviceId(), m.id()); |
| 215 | futures.remove(key); |
| 216 | meters.remove(key); |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 217 | } |
| 218 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 219 | private class InternalMapEventListener implements MapEventListener<MeterId, MeterData> { |
| 220 | @Override |
| 221 | public void event(MapEvent<MeterId, MeterData> event) { |
| 222 | MeterData data = event.value().value(); |
| 223 | NodeId master = mastershipService.getMasterFor(data.meter().deviceId()); |
| 224 | switch (event.type()) { |
| 225 | case INSERT: |
| 226 | case UPDATE: |
| 227 | switch (data.meter().state()) { |
| 228 | case PENDING_ADD: |
| 229 | case PENDING_REMOVE: |
| 230 | if (!data.reason().isPresent() && local.equals(master)) { |
| 231 | notifyDelegate( |
| 232 | new MeterEvent(data.meter().state() == MeterState.PENDING_ADD ? |
| 233 | MeterEvent.Type.METER_ADD_REQ : MeterEvent.Type.METER_REM_REQ, |
| 234 | data.meter())); |
| 235 | } else if (data.reason().isPresent() && local.equals(data.origin())) { |
| 236 | MeterStoreResult msr = MeterStoreResult.fail(data.reason().get()); |
| 237 | //TODO: No future -> no friend |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 238 | futures.get(data.meter().id()).complete(msr); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 239 | } |
| 240 | break; |
| 241 | case ADDED: |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 242 | if (local.equals(data.origin()) && data.meter().state() == MeterState.PENDING_ADD) { |
| 243 | futures.remove(data.meter().id()).complete(MeterStoreResult.success()); |
| 244 | } |
| 245 | break; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 246 | case REMOVED: |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 247 | if (local.equals(data.origin()) && data.meter().state() == MeterState.PENDING_REMOVE) { |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 248 | futures.remove(data.meter().id()).complete(MeterStoreResult.success()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 249 | } |
| 250 | break; |
| 251 | default: |
| 252 | log.warn("Unknown meter state type {}", data.meter().state()); |
| 253 | } |
| 254 | break; |
| 255 | case REMOVE: |
| 256 | //Only happens at origin so we do not need to care. |
| 257 | break; |
| 258 | default: |
| 259 | log.warn("Unknown Map event type {}", event.type()); |
| 260 | } |
| 261 | |
| 262 | } |
| 263 | } |
| 264 | |
| 265 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 266 | } |