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