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