alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
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; |
Charles Chan | 593acf9 | 2017-11-22 13:55:41 -0800 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 20 | import com.google.common.collect.Iterables; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 21 | import com.google.common.collect.Maps; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 22 | import org.apache.commons.lang.math.RandomUtils; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Activate; |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 24 | import org.apache.felix.scr.annotations.Component; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 25 | import org.apache.felix.scr.annotations.Deactivate; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Reference; |
| 27 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 28 | import org.apache.felix.scr.annotations.Service; |
Charles Chan | 593acf9 | 2017-11-22 13:55:41 -0800 | [diff] [blame] | 29 | import org.onlab.util.KryoNamespace; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 30 | import org.onosproject.cluster.ClusterService; |
| 31 | import org.onosproject.cluster.NodeId; |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 32 | import org.onosproject.mastership.MastershipService; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 33 | import org.onosproject.net.DeviceId; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 34 | import org.onosproject.net.behaviour.MeterQuery; |
| 35 | import org.onosproject.net.driver.DriverHandler; |
| 36 | import org.onosproject.net.driver.DriverService; |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 37 | import org.onosproject.net.meter.Band; |
| 38 | import org.onosproject.net.meter.DefaultBand; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 39 | import org.onosproject.net.meter.DefaultMeter; |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 40 | import org.onosproject.net.meter.DefaultMeterFeatures; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 41 | import org.onosproject.net.meter.Meter; |
| 42 | import org.onosproject.net.meter.MeterEvent; |
| 43 | import org.onosproject.net.meter.MeterFailReason; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 44 | import org.onosproject.net.meter.MeterFeatures; |
cansu.toprak | 409289d | 2017-10-27 10:04:05 +0300 | [diff] [blame] | 45 | import org.onosproject.net.meter.MeterFeaturesFlag; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 46 | import org.onosproject.net.meter.MeterFeaturesKey; |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 47 | import org.onosproject.net.meter.MeterId; |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 48 | import org.onosproject.net.meter.MeterKey; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 49 | import org.onosproject.net.meter.MeterOperation; |
| 50 | import org.onosproject.net.meter.MeterState; |
| 51 | import org.onosproject.net.meter.MeterStore; |
| 52 | import org.onosproject.net.meter.MeterStoreDelegate; |
| 53 | import org.onosproject.net.meter.MeterStoreResult; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 54 | import org.onosproject.store.AbstractStore; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 55 | import org.onosproject.store.primitives.DefaultDistributedSet; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 56 | import org.onosproject.store.serializers.KryoNamespaces; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 57 | import org.onosproject.store.service.AtomicCounterMap; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 58 | import org.onosproject.store.service.ConsistentMap; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 59 | import org.onosproject.store.service.DistributedPrimitive; |
| 60 | import org.onosproject.store.service.DistributedSet; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 61 | import org.onosproject.store.service.MapEvent; |
| 62 | import org.onosproject.store.service.MapEventListener; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 63 | import org.onosproject.store.service.Serializer; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 64 | import org.onosproject.store.service.StorageException; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 65 | import org.onosproject.store.service.StorageService; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 66 | import org.onosproject.store.service.Versioned; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 67 | import org.slf4j.Logger; |
| 68 | |
| 69 | import java.util.Collection; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 70 | import java.util.Map; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 71 | import java.util.Set; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 72 | import java.util.concurrent.CompletableFuture; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 73 | import java.util.stream.Collectors; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 74 | |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 75 | import static org.onosproject.incubator.store.meter.impl.DistributedMeterStore.ReuseStrategy.FIRST_FIT; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 76 | import static org.onosproject.net.meter.MeterFailReason.TIMEOUT; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 77 | import static org.slf4j.LoggerFactory.getLogger; |
| 78 | |
| 79 | /** |
| 80 | * A distributed meter store implementation. Meters are stored consistently |
| 81 | * across the cluster. |
| 82 | */ |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 83 | @Component(immediate = true) |
| 84 | @Service |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 85 | public class DistributedMeterStore extends AbstractStore<MeterEvent, MeterStoreDelegate> |
| 86 | implements MeterStore { |
| 87 | |
| 88 | private Logger log = getLogger(getClass()); |
| 89 | |
| 90 | private static final String METERSTORE = "onos-meter-store"; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 91 | private static final String METERFEATURESSTORE = "onos-meter-features-store"; |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 92 | private static final String AVAILABLEMETERIDSTORE = "onos-meters-available-store"; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 93 | private static final String METERIDSTORE = "onos-meters-id-store"; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 94 | |
Charles Chan | 593acf9 | 2017-11-22 13:55:41 -0800 | [diff] [blame] | 95 | private static final KryoNamespace.Builder APP_KRYO_BUILDER = KryoNamespace.newBuilder() |
| 96 | .register(KryoNamespaces.API) |
| 97 | .register(MeterKey.class) |
| 98 | .register(MeterData.class) |
| 99 | .register(DefaultMeter.class) |
| 100 | .register(DefaultBand.class) |
| 101 | .register(Band.Type.class) |
| 102 | .register(MeterState.class) |
| 103 | .register(Meter.Unit.class); |
| 104 | |
| 105 | private Serializer serializer = Serializer.using(Lists.newArrayList(APP_KRYO_BUILDER.build())); |
| 106 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 107 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 108 | private StorageService storageService; |
| 109 | |
| 110 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 111 | private MastershipService mastershipService; |
| 112 | |
| 113 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 114 | private ClusterService clusterService; |
| 115 | |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 116 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 117 | protected DriverService driverService; |
| 118 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 119 | private ConsistentMap<MeterKey, MeterData> meters; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 120 | private NodeId local; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 121 | |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 122 | private ConsistentMap<MeterFeaturesKey, MeterFeatures> meterFeatures; |
| 123 | |
HIGUCHI Yuta | 0574a55 | 2015-09-29 14:38:25 -0700 | [diff] [blame] | 124 | private MapEventListener<MeterKey, MeterData> mapListener = new InternalMapEventListener(); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 125 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 126 | private Map<MeterKey, CompletableFuture<MeterStoreResult>> futures = |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 127 | Maps.newConcurrentMap(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 128 | |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 129 | // Available meter identifiers |
| 130 | private DistributedSet<MeterKey> availableMeterIds; |
| 131 | |
| 132 | // Atomic counter map for generation of new identifiers; |
| 133 | private AtomicCounterMap<DeviceId> meterIdGenerators; |
| 134 | |
| 135 | /** |
| 136 | * Defines possible selection strategies to reuse meter ids. |
| 137 | */ |
| 138 | enum ReuseStrategy { |
| 139 | /** |
| 140 | * Select randomly an available id. |
| 141 | */ |
| 142 | RANDOM, |
| 143 | /** |
| 144 | * Select the first one. |
| 145 | */ |
| 146 | FIRST_FIT |
| 147 | } |
| 148 | |
| 149 | private ReuseStrategy reuseStrategy = FIRST_FIT; |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 150 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 151 | @Activate |
| 152 | public void activate() { |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 153 | local = clusterService.getLocalNode().id(); |
| 154 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 155 | meters = storageService.<MeterKey, MeterData>consistentMapBuilder() |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 156 | .withName(METERSTORE) |
Charles Chan | 593acf9 | 2017-11-22 13:55:41 -0800 | [diff] [blame] | 157 | .withSerializer(serializer).build(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 158 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 159 | meters.addListener(mapListener); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 160 | |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 161 | meterFeatures = storageService.<MeterFeaturesKey, MeterFeatures>consistentMapBuilder() |
| 162 | .withName(METERFEATURESSTORE) |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 163 | .withSerializer(Serializer.using(KryoNamespaces.API, |
| 164 | MeterFeaturesKey.class, |
| 165 | MeterFeatures.class, |
| 166 | DefaultMeterFeatures.class, |
| 167 | Band.Type.class, |
| 168 | Meter.Unit.class, |
cansu.toprak | 409289d | 2017-10-27 10:04:05 +0300 | [diff] [blame] | 169 | MeterFailReason.class, |
| 170 | MeterFeaturesFlag.class)).build(); |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 171 | |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 172 | // Init the set of the available ids |
| 173 | availableMeterIds = new DefaultDistributedSet<>(storageService.<MeterKey>setBuilder() |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 174 | .withName(AVAILABLEMETERIDSTORE) |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 175 | .withSerializer(Serializer.using(KryoNamespaces.API, |
| 176 | MeterKey.class)).build(), |
| 177 | DistributedPrimitive.DEFAULT_OPERATION_TIMEOUT_MILLIS); |
| 178 | |
| 179 | // Init atomic map counters |
| 180 | meterIdGenerators = storageService.<DeviceId>atomicCounterMapBuilder() |
| 181 | .withName(METERIDSTORE) |
Yuta HIGUCHI | 872c982 | 2017-05-25 09:35:14 -0700 | [diff] [blame] | 182 | .withSerializer(Serializer.using(KryoNamespaces.API)).build(); |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 183 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 184 | log.info("Started"); |
| 185 | } |
| 186 | |
| 187 | @Deactivate |
| 188 | public void deactivate() { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 189 | meters.removeListener(mapListener); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 190 | log.info("Stopped"); |
| 191 | } |
| 192 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 193 | @Override |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 194 | public CompletableFuture<MeterStoreResult> storeMeter(Meter meter) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 195 | // Init steps |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 196 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 197 | MeterKey key = MeterKey.key(meter.deviceId(), meter.id()); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 198 | // Store the future related to the operation |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 199 | futures.put(key, future); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 200 | // Store the meter data |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 201 | MeterData data = new MeterData(meter, null, local); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 202 | try { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 203 | meters.put(key, data); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 204 | } catch (StorageException e) { |
Hwanwook Lee | 8206ad9 | 2018-01-02 18:03:50 +0900 | [diff] [blame] | 205 | futures.remove(key); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 206 | future.completeExceptionally(e); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 207 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 208 | // Done, return the future |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 209 | return future; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 210 | } |
| 211 | |
| 212 | @Override |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 213 | public CompletableFuture<MeterStoreResult> deleteMeter(Meter meter) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 214 | // Init steps |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 215 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 216 | MeterKey key = MeterKey.key(meter.deviceId(), meter.id()); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 217 | // Store the future related to the operation |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 218 | futures.put(key, future); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 219 | // Create the meter data |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 220 | MeterData data = new MeterData(meter, null, local); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 221 | // Update the state of the meter. It will be pruned by observing |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 222 | // that it has been removed from the dataplane. |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 223 | try { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 224 | // If it does not exist in the system |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 225 | if (meters.computeIfPresent(key, (k, v) -> data) == null) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 226 | // Complete immediately |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 227 | future.complete(MeterStoreResult.success()); |
| 228 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 229 | } catch (StorageException e) { |
Hwanwook Lee | 8206ad9 | 2018-01-02 18:03:50 +0900 | [diff] [blame] | 230 | futures.remove(key); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 231 | future.completeExceptionally(e); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 232 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 233 | // Done, return the future |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 234 | return future; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 235 | } |
| 236 | |
| 237 | @Override |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 238 | public MeterStoreResult storeMeterFeatures(MeterFeatures meterfeatures) { |
| 239 | MeterStoreResult result = MeterStoreResult.success(); |
| 240 | MeterFeaturesKey key = MeterFeaturesKey.key(meterfeatures.deviceId()); |
| 241 | try { |
| 242 | meterFeatures.putIfAbsent(key, meterfeatures); |
| 243 | } catch (StorageException e) { |
| 244 | result = MeterStoreResult.fail(TIMEOUT); |
| 245 | } |
| 246 | return result; |
| 247 | } |
| 248 | |
| 249 | @Override |
| 250 | public MeterStoreResult deleteMeterFeatures(DeviceId deviceId) { |
| 251 | MeterStoreResult result = MeterStoreResult.success(); |
| 252 | MeterFeaturesKey key = MeterFeaturesKey.key(deviceId); |
| 253 | try { |
| 254 | meterFeatures.remove(key); |
| 255 | } catch (StorageException e) { |
| 256 | result = MeterStoreResult.fail(TIMEOUT); |
| 257 | } |
| 258 | return result; |
| 259 | } |
| 260 | |
| 261 | @Override |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 262 | public CompletableFuture<MeterStoreResult> updateMeter(Meter meter) { |
| 263 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 264 | MeterKey key = MeterKey.key(meter.deviceId(), meter.id()); |
| 265 | futures.put(key, future); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 266 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 267 | MeterData data = new MeterData(meter, null, local); |
| 268 | try { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 269 | if (meters.computeIfPresent(key, (k, v) -> data) == null) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 270 | future.complete(MeterStoreResult.fail(MeterFailReason.INVALID_METER)); |
| 271 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 272 | } catch (StorageException e) { |
Hwanwook Lee | 8206ad9 | 2018-01-02 18:03:50 +0900 | [diff] [blame] | 273 | futures.remove(key); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 274 | future.completeExceptionally(e); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 275 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 276 | return future; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 277 | } |
| 278 | |
| 279 | @Override |
| 280 | public void updateMeterState(Meter meter) { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 281 | MeterKey key = MeterKey.key(meter.deviceId(), meter.id()); |
| 282 | meters.computeIfPresent(key, (k, v) -> { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 283 | DefaultMeter m = (DefaultMeter) v.meter(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 284 | m.setState(meter.state()); |
| 285 | m.setProcessedPackets(meter.packetsSeen()); |
| 286 | m.setProcessedBytes(meter.bytesSeen()); |
| 287 | m.setLife(meter.life()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 288 | // TODO: Prune if drops to zero. |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 289 | m.setReferenceCount(meter.referenceCount()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 290 | return new MeterData(m, null, v.origin()); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 291 | }); |
| 292 | } |
| 293 | |
| 294 | @Override |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 295 | public Meter getMeter(MeterKey key) { |
| 296 | MeterData data = Versioned.valueOrElse(meters.get(key), null); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 297 | return data == null ? null : data.meter(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 298 | } |
| 299 | |
| 300 | @Override |
| 301 | public Collection<Meter> getAllMeters() { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 302 | return Collections2.transform(meters.asJavaMap().values(), |
| 303 | MeterData::meter); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 304 | } |
| 305 | |
| 306 | @Override |
Jordi Ortiz | 9287b63 | 2017-06-22 11:01:37 +0200 | [diff] [blame] | 307 | public Collection<Meter> getAllMeters(DeviceId deviceId) { |
| 308 | return Collections2.transform( |
| 309 | Collections2.filter(meters.asJavaMap().values(), |
| 310 | (MeterData m) -> m.meter().deviceId().equals(deviceId)), |
| 311 | MeterData::meter); |
| 312 | } |
| 313 | |
| 314 | @Override |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 315 | public void failedMeter(MeterOperation op, MeterFailReason reason) { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 316 | MeterKey key = MeterKey.key(op.meter().deviceId(), op.meter().id()); |
| 317 | meters.computeIfPresent(key, (k, v) -> |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 318 | new MeterData(v.meter(), reason, v.origin())); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 319 | } |
| 320 | |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 321 | @Override |
| 322 | public void deleteMeterNow(Meter m) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 323 | // Create the key |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 324 | MeterKey key = MeterKey.key(m.deviceId(), m.id()); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 325 | // Remove the future |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 326 | futures.remove(key); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 327 | // Remove the meter |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 328 | meters.remove(key); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 329 | // Free the id |
| 330 | freeMeterId(m.deviceId(), m.id()); |
| 331 | // Finally notify the delegate |
Jordi Ortiz | df28ecd | 2017-03-25 19:22:36 +0100 | [diff] [blame] | 332 | notifyDelegate(new MeterEvent(MeterEvent.Type.METER_REMOVED, m)); |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 333 | } |
| 334 | |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 335 | @Override |
| 336 | public long getMaxMeters(MeterFeaturesKey key) { |
| 337 | MeterFeatures features = Versioned.valueOrElse(meterFeatures.get(key), null); |
| 338 | return features == null ? 0L : features.maxMeter(); |
| 339 | } |
| 340 | |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 341 | // queryMaxMeters is implemented in FullMetersAvailable behaviour. |
| 342 | private long queryMaxMeters(DeviceId device) { |
| 343 | // Get driver handler for this device |
| 344 | DriverHandler handler = driverService.createHandler(device); |
| 345 | // If creation failed or the device does not have this behavior |
| 346 | if (handler == null || !handler.hasBehaviour(MeterQuery.class)) { |
| 347 | // We cannot know max meter |
| 348 | return 0L; |
| 349 | } |
| 350 | // Get the behavior |
| 351 | MeterQuery query = handler.behaviour(MeterQuery.class); |
| 352 | // Return as max meter the result of the query |
| 353 | return query.getMaxMeters(); |
| 354 | } |
| 355 | |
| 356 | private boolean updateMeterIdAvailability(DeviceId deviceId, MeterId id, |
| 357 | boolean available) { |
| 358 | // According to available, make available or unavailable a meter key |
| 359 | return available ? availableMeterIds.add(MeterKey.key(deviceId, id)) : |
| 360 | availableMeterIds.remove(MeterKey.key(deviceId, id)); |
| 361 | } |
| 362 | |
| 363 | private MeterId getNextAvailableId(Set<MeterId> availableIds) { |
| 364 | // If there are no available ids |
| 365 | if (availableIds.isEmpty()) { |
| 366 | // Just end the cycle |
| 367 | return null; |
| 368 | } |
| 369 | // If it is the first fit |
| 370 | if (reuseStrategy == FIRST_FIT || availableIds.size() == 1) { |
| 371 | return availableIds.iterator().next(); |
| 372 | } |
| 373 | // If it is random, get the size |
| 374 | int size = availableIds.size(); |
| 375 | // Return a random element |
| 376 | return Iterables.get(availableIds, RandomUtils.nextInt(size)); |
| 377 | } |
| 378 | |
| 379 | // Implements reuse strategy |
| 380 | private MeterId firstReusableMeterId(DeviceId deviceId) { |
| 381 | // Filter key related to device id, and reduce to meter ids |
| 382 | Set<MeterId> localAvailableMeterIds = availableMeterIds.stream() |
| 383 | .filter(meterKey -> meterKey.deviceId().equals(deviceId)) |
| 384 | .map(MeterKey::meterId) |
| 385 | .collect(Collectors.toSet()); |
| 386 | // Get next available id |
| 387 | MeterId meterId = getNextAvailableId(localAvailableMeterIds); |
| 388 | // Iterate until there are items |
| 389 | while (meterId != null) { |
| 390 | // If we are able to reserve the id |
| 391 | if (updateMeterIdAvailability(deviceId, meterId, false)) { |
| 392 | // Just end |
| 393 | return meterId; |
| 394 | } |
| 395 | // Update the set |
| 396 | localAvailableMeterIds.remove(meterId); |
| 397 | // Try another time |
| 398 | meterId = getNextAvailableId(localAvailableMeterIds); |
| 399 | } |
| 400 | // No reusable ids |
| 401 | return null; |
| 402 | } |
| 403 | |
| 404 | @Override |
| 405 | public MeterId allocateMeterId(DeviceId deviceId) { |
| 406 | // Init steps |
| 407 | MeterId meterId; |
| 408 | long id; |
| 409 | // Try to reuse meter id |
| 410 | meterId = firstReusableMeterId(deviceId); |
| 411 | // We found a reusable id, return |
| 412 | if (meterId != null) { |
| 413 | return meterId; |
| 414 | } |
| 415 | // If there was no reusable MeterId we have to generate a new value |
| 416 | // using maxMeters as upper limit. |
| 417 | long maxMeters = getMaxMeters(MeterFeaturesKey.key(deviceId)); |
| 418 | // If the device does not give us MeterFeatures |
| 419 | if (maxMeters == 0L) { |
| 420 | // MeterFeatures couldn't be retrieved, fallback to queryMeters. |
| 421 | maxMeters = queryMaxMeters(deviceId); |
| 422 | } |
| 423 | // If we don't know the max, cannot proceed |
| 424 | if (maxMeters == 0L) { |
| 425 | return null; |
| 426 | } |
| 427 | // Get a new value |
| 428 | id = meterIdGenerators.incrementAndGet(deviceId); |
| 429 | // Check with the max, and if the value is bigger, cannot proceed |
| 430 | if (id >= maxMeters) { |
| 431 | return null; |
| 432 | } |
| 433 | // Done, return the value |
| 434 | return MeterId.meterId(id); |
| 435 | } |
| 436 | |
| 437 | @Override |
| 438 | public void freeMeterId(DeviceId deviceId, MeterId meterId) { |
Pier Luigi | bdcd967 | 2017-10-13 13:54:48 +0200 | [diff] [blame] | 439 | // Avoid to free meter not allocated |
| 440 | if (meterIdGenerators.get(deviceId) < meterId.id()) { |
| 441 | return; |
| 442 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 443 | // Update the availability |
| 444 | updateMeterIdAvailability(deviceId, meterId, true); |
| 445 | } |
| 446 | |
HIGUCHI Yuta | 0574a55 | 2015-09-29 14:38:25 -0700 | [diff] [blame] | 447 | private class InternalMapEventListener implements MapEventListener<MeterKey, MeterData> { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 448 | @Override |
HIGUCHI Yuta | 0574a55 | 2015-09-29 14:38:25 -0700 | [diff] [blame] | 449 | public void event(MapEvent<MeterKey, MeterData> event) { |
| 450 | MeterKey key = event.key(); |
Ray Milkey | d0f017f | 2018-09-21 12:52:34 -0700 | [diff] [blame] | 451 | Versioned<MeterData> value = event.type() == MapEvent.Type.REMOVE ? event.oldValue() : event.newValue(); |
| 452 | MeterData data = value.value(); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 453 | NodeId master = mastershipService.getMasterFor(data.meter().deviceId()); |
| 454 | switch (event.type()) { |
| 455 | case INSERT: |
| 456 | case UPDATE: |
| 457 | switch (data.meter().state()) { |
| 458 | case PENDING_ADD: |
| 459 | case PENDING_REMOVE: |
| 460 | if (!data.reason().isPresent() && local.equals(master)) { |
| 461 | notifyDelegate( |
| 462 | new MeterEvent(data.meter().state() == MeterState.PENDING_ADD ? |
| 463 | MeterEvent.Type.METER_ADD_REQ : MeterEvent.Type.METER_REM_REQ, |
| 464 | data.meter())); |
| 465 | } else if (data.reason().isPresent() && local.equals(data.origin())) { |
| 466 | MeterStoreResult msr = MeterStoreResult.fail(data.reason().get()); |
| 467 | //TODO: No future -> no friend |
HIGUCHI Yuta | 0574a55 | 2015-09-29 14:38:25 -0700 | [diff] [blame] | 468 | futures.get(key).complete(msr); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 469 | } |
| 470 | break; |
| 471 | case ADDED: |
Jordi Ortiz | df28ecd | 2017-03-25 19:22:36 +0100 | [diff] [blame] | 472 | if (local.equals(data.origin()) && |
| 473 | (data.meter().state() == MeterState.PENDING_ADD |
| 474 | || data.meter().state() == MeterState.ADDED)) { |
| 475 | futures.computeIfPresent(key, (k, v) -> { |
| 476 | notifyDelegate( |
| 477 | new MeterEvent(MeterEvent.Type.METER_ADDED, data.meter())); |
| 478 | return null; |
| 479 | }); |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 480 | } |
| 481 | break; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 482 | case REMOVED: |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 483 | if (local.equals(data.origin()) && data.meter().state() == MeterState.PENDING_REMOVE) { |
HIGUCHI Yuta | 0574a55 | 2015-09-29 14:38:25 -0700 | [diff] [blame] | 484 | futures.remove(key).complete(MeterStoreResult.success()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 485 | } |
| 486 | break; |
| 487 | default: |
| 488 | log.warn("Unknown meter state type {}", data.meter().state()); |
| 489 | } |
| 490 | break; |
| 491 | case REMOVE: |
| 492 | //Only happens at origin so we do not need to care. |
| 493 | break; |
| 494 | default: |
| 495 | log.warn("Unknown Map event type {}", event.type()); |
| 496 | } |
| 497 | |
| 498 | } |
| 499 | } |
| 500 | |
| 501 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 502 | } |