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 | */ |
Thomas Vachuska | 52f2cd1 | 2018-11-08 21:20:04 -0800 | [diff] [blame] | 16 | package org.onosproject.store.meter.impl; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 17 | |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 18 | import com.google.common.collect.Collections2; |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 19 | import com.google.common.collect.ImmutableSet; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 20 | import com.google.common.collect.Iterables; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 21 | import com.google.common.collect.Lists; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 22 | import com.google.common.collect.Maps; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 23 | import org.apache.commons.lang.math.RandomUtils; |
Charles Chan | 593acf9 | 2017-11-22 13:55:41 -0800 | [diff] [blame] | 24 | import org.onlab.util.KryoNamespace; |
Daniele Moro | 43ac289 | 2021-07-15 17:02:59 +0200 | [diff] [blame^] | 25 | import org.onosproject.core.ApplicationId; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 26 | import org.onosproject.net.DeviceId; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 27 | import org.onosproject.net.behaviour.MeterQuery; |
| 28 | import org.onosproject.net.driver.DriverHandler; |
| 29 | import org.onosproject.net.driver.DriverService; |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 30 | import org.onosproject.net.meter.Band; |
| 31 | import org.onosproject.net.meter.DefaultBand; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 32 | import org.onosproject.net.meter.DefaultMeter; |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 33 | import org.onosproject.net.meter.DefaultMeterFeatures; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 34 | import org.onosproject.net.meter.Meter; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 35 | import org.onosproject.net.meter.MeterCellId; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 36 | import org.onosproject.net.meter.MeterEvent; |
| 37 | import org.onosproject.net.meter.MeterFailReason; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 38 | import org.onosproject.net.meter.MeterFeatures; |
cansu.toprak | 409289d | 2017-10-27 10:04:05 +0300 | [diff] [blame] | 39 | import org.onosproject.net.meter.MeterFeaturesFlag; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 40 | import org.onosproject.net.meter.MeterFeaturesKey; |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 41 | import org.onosproject.net.meter.MeterId; |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 42 | import org.onosproject.net.meter.MeterKey; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 43 | import org.onosproject.net.meter.MeterOperation; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 44 | import org.onosproject.net.meter.MeterScope; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 45 | import org.onosproject.net.meter.MeterState; |
| 46 | import org.onosproject.net.meter.MeterStore; |
| 47 | import org.onosproject.net.meter.MeterStoreDelegate; |
| 48 | import org.onosproject.net.meter.MeterStoreResult; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 49 | import org.onosproject.net.meter.MeterTableKey; |
| 50 | import org.onosproject.net.pi.model.PiMeterId; |
| 51 | import org.onosproject.net.pi.runtime.PiMeterCellId; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 52 | import org.onosproject.store.AbstractStore; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 53 | import org.onosproject.store.primitives.DefaultDistributedSet; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 54 | import org.onosproject.store.serializers.KryoNamespaces; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 55 | import org.onosproject.store.service.AtomicCounterMap; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 56 | import org.onosproject.store.service.ConsistentMap; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 57 | import org.onosproject.store.service.DistributedPrimitive; |
| 58 | import org.onosproject.store.service.DistributedSet; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 59 | import org.onosproject.store.service.EventuallyConsistentMap; |
| 60 | import org.onosproject.store.service.EventuallyConsistentMapEvent; |
| 61 | import org.onosproject.store.service.EventuallyConsistentMapListener; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 62 | import org.onosproject.store.service.MapEvent; |
| 63 | import org.onosproject.store.service.MapEventListener; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 64 | import org.onosproject.store.service.Serializer; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 65 | import org.onosproject.store.service.StorageException; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 66 | import org.onosproject.store.service.StorageService; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 67 | import org.onosproject.store.service.Versioned; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 68 | import org.onosproject.store.service.WallClockTimestamp; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 69 | import org.osgi.service.component.annotations.Activate; |
| 70 | import org.osgi.service.component.annotations.Component; |
| 71 | import org.osgi.service.component.annotations.Deactivate; |
| 72 | import org.osgi.service.component.annotations.Reference; |
| 73 | import org.osgi.service.component.annotations.ReferenceCardinality; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 74 | import org.slf4j.Logger; |
| 75 | |
| 76 | import java.util.Collection; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 77 | import java.util.concurrent.ConcurrentMap; |
| 78 | import java.util.concurrent.ConcurrentHashMap; |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 79 | import java.util.List; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 80 | import java.util.Map; |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 81 | import java.util.Objects; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 82 | import java.util.Set; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 83 | import java.util.concurrent.CompletableFuture; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 84 | import java.util.stream.Collectors; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 85 | |
Thomas Vachuska | 52f2cd1 | 2018-11-08 21:20:04 -0800 | [diff] [blame] | 86 | import static org.onosproject.store.meter.impl.DistributedMeterStore.ReuseStrategy.FIRST_FIT; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 87 | import static org.onosproject.net.meter.MeterFailReason.TIMEOUT; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 88 | import static org.onosproject.net.meter.MeterCellId.MeterCellType.INDEX; |
| 89 | import static org.onosproject.net.meter.MeterCellId.MeterCellType.PIPELINE_INDEPENDENT; |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 90 | import static org.onosproject.net.meter.MeterStoreResult.Type.FAIL; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 91 | import static org.slf4j.LoggerFactory.getLogger; |
| 92 | |
| 93 | /** |
| 94 | * A distributed meter store implementation. Meters are stored consistently |
| 95 | * across the cluster. |
| 96 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 97 | @Component(immediate = true, service = MeterStore.class) |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 98 | public class DistributedMeterStore extends AbstractStore<MeterEvent, MeterStoreDelegate> |
| 99 | implements MeterStore { |
| 100 | |
| 101 | private Logger log = getLogger(getClass()); |
| 102 | |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 103 | // Meters map related objects |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 104 | private static final String METERSTORE = "onos-meter-store"; |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 105 | private ConsistentMap<MeterKey, MeterData> meters; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 106 | private MapEventListener<MeterKey, MeterData> metersMapListener = new InternalMetersMapEventListener(); |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 107 | private Map<MeterKey, MeterData> metersMap; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 108 | |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 109 | // Meters features related objects |
| 110 | private static final String METERFEATURESSTORE = "onos-meter-features-store"; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 111 | private EventuallyConsistentMap<MeterTableKey, MeterFeatures> metersFeatures; |
| 112 | private EventuallyConsistentMapListener<MeterTableKey, MeterFeatures> featuresMapListener = |
| 113 | new InternalFeaturesMapEventListener(); |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 114 | |
| 115 | // Meters id related objects |
| 116 | private static final String AVAILABLEMETERIDSTORE = "onos-meters-available-store"; |
| 117 | // Available meter identifiers |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 118 | private ConcurrentMap<MeterTableKey, DistributedSet<MeterKey>> availableMeterIds; |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 119 | // Atomic counter map for generation of new identifiers; |
| 120 | private static final String METERIDSTORE = "onos-meters-id-store"; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 121 | private AtomicCounterMap<MeterTableKey> meterIdGenerators; |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 122 | |
| 123 | // Serializer related objects |
Charles Chan | 593acf9 | 2017-11-22 13:55:41 -0800 | [diff] [blame] | 124 | private static final KryoNamespace.Builder APP_KRYO_BUILDER = KryoNamespace.newBuilder() |
| 125 | .register(KryoNamespaces.API) |
| 126 | .register(MeterKey.class) |
| 127 | .register(MeterData.class) |
| 128 | .register(DefaultMeter.class) |
| 129 | .register(DefaultBand.class) |
| 130 | .register(Band.Type.class) |
| 131 | .register(MeterState.class) |
debmaiti | 1bea289 | 2019-06-04 12:36:38 +0530 | [diff] [blame] | 132 | .register(Meter.Unit.class) |
| 133 | .register(MeterFailReason.class); |
Charles Chan | 593acf9 | 2017-11-22 13:55:41 -0800 | [diff] [blame] | 134 | private Serializer serializer = Serializer.using(Lists.newArrayList(APP_KRYO_BUILDER.build())); |
| 135 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 136 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 137 | private StorageService storageService; |
| 138 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 139 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 140 | protected DriverService driverService; |
| 141 | |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 142 | // Local cache to handle async ops through futures. |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 143 | private Map<MeterKey, CompletableFuture<MeterStoreResult>> futures = |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 144 | Maps.newConcurrentMap(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 145 | |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 146 | /** |
| 147 | * Defines possible selection strategies to reuse meter ids. |
| 148 | */ |
| 149 | enum ReuseStrategy { |
| 150 | /** |
| 151 | * Select randomly an available id. |
| 152 | */ |
| 153 | RANDOM, |
| 154 | /** |
| 155 | * Select the first one. |
| 156 | */ |
| 157 | FIRST_FIT |
| 158 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 159 | private ReuseStrategy reuseStrategy = FIRST_FIT; |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 160 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 161 | @Activate |
| 162 | public void activate() { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 163 | // Init meters map and setup the map listener |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 164 | meters = storageService.<MeterKey, MeterData>consistentMapBuilder() |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 165 | .withName(METERSTORE) |
Charles Chan | 593acf9 | 2017-11-22 13:55:41 -0800 | [diff] [blame] | 166 | .withSerializer(serializer).build(); |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 167 | meters.addListener(metersMapListener); |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 168 | metersMap = meters.asJavaMap(); |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 169 | // Init meter features map |
| 170 | metersFeatures = storageService.<MeterTableKey, MeterFeatures>eventuallyConsistentMapBuilder() |
| 171 | .withName(METERFEATURESSTORE) |
| 172 | .withTimestampProvider((key, features) -> new WallClockTimestamp()) |
| 173 | .withSerializer(KryoNamespace.newBuilder() |
| 174 | .register(KryoNamespaces.API) |
| 175 | .register(MeterTableKey.class) |
| 176 | .register(MeterFeatures.class) |
| 177 | .register(DefaultMeterFeatures.class) |
| 178 | .register(DefaultBand.class) |
| 179 | .register(Band.Type.class) |
| 180 | .register(Meter.Unit.class) |
| 181 | .register(MeterFailReason.class) |
| 182 | .register(MeterFeaturesFlag.class)).build(); |
| 183 | metersFeatures.addListener(featuresMapListener); |
| 184 | // Init the map of the available ids set |
| 185 | // Set will be created when a new Meter Features is pushed to the store |
| 186 | availableMeterIds = new ConcurrentHashMap<>(); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 187 | // Init atomic map counters |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 188 | meterIdGenerators = storageService.<MeterTableKey>atomicCounterMapBuilder() |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 189 | .withName(METERIDSTORE) |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 190 | .withSerializer(Serializer.using(KryoNamespaces.API, |
| 191 | MeterTableKey.class, |
| 192 | MeterScope.class)).build(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 193 | log.info("Started"); |
| 194 | } |
| 195 | |
| 196 | @Deactivate |
| 197 | public void deactivate() { |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 198 | meters.removeListener(metersMapListener); |
| 199 | metersFeatures.removeListener(featuresMapListener); |
| 200 | meters.destroy(); |
| 201 | metersFeatures.destroy(); |
| 202 | availableMeterIds.forEach((key, set) -> { |
| 203 | set.destroy(); |
| 204 | }); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 205 | log.info("Stopped"); |
| 206 | } |
| 207 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 208 | @Override |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 209 | public CompletableFuture<MeterStoreResult> addOrUpdateMeter(Meter meter) { |
| 210 | // Init steps |
| 211 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
| 212 | MeterKey key = MeterKey.key(meter.deviceId(), meter.meterCellId()); |
| 213 | MeterData data = new MeterData(meter, null); |
| 214 | // Store the future related to the operation |
| 215 | futures.put(key, future); |
| 216 | // Check if the meter exists |
| 217 | try { |
| 218 | meters.compute(key, (k, v) -> data); |
| 219 | } catch (StorageException e) { |
| 220 | log.error("{} thrown a storage exception: {}", e.getStackTrace()[0].getMethodName(), |
| 221 | e.getMessage(), e); |
| 222 | futures.remove(key); |
| 223 | future.completeExceptionally(e); |
| 224 | } |
| 225 | return future; |
| 226 | } |
| 227 | |
| 228 | @Override |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 229 | public CompletableFuture<MeterStoreResult> storeMeter(Meter meter) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 230 | // Init steps |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 231 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 232 | MeterKey key = MeterKey.key(meter.deviceId(), meter.meterCellId()); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 233 | // Store the future related to the operation |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 234 | futures.put(key, future); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 235 | // Store the meter data |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 236 | MeterData data = new MeterData(meter, null); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 237 | try { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 238 | meters.put(key, data); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 239 | } catch (StorageException e) { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 240 | log.error("{} thrown a storage exception: {}", e.getStackTrace()[0].getMethodName(), |
| 241 | e.getMessage(), e); |
Hwanwook Lee | 8206ad9 | 2018-01-02 18:03:50 +0900 | [diff] [blame] | 242 | futures.remove(key); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 243 | future.completeExceptionally(e); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 244 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 245 | // Done, return the future |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 246 | return future; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 247 | } |
| 248 | |
| 249 | @Override |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 250 | public CompletableFuture<MeterStoreResult> deleteMeter(Meter meter) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 251 | // Init steps |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 252 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 253 | MeterKey key = MeterKey.key(meter.deviceId(), meter.meterCellId()); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 254 | // Store the future related to the operation |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 255 | futures.put(key, future); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 256 | // Create the meter data |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 257 | MeterData data = new MeterData(meter, null); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 258 | // Update the state of the meter. It will be pruned by observing |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 259 | // that it has been removed from the dataplane. |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 260 | try { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 261 | // If it does not exist in the system |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 262 | if (meters.computeIfPresent(key, (k, v) -> data) == null) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 263 | // Complete immediately |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 264 | future.complete(MeterStoreResult.success()); |
| 265 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 266 | } catch (StorageException e) { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 267 | log.error("{} thrown a storage exception: {}", e.getStackTrace()[0].getMethodName(), |
| 268 | e.getMessage(), e); |
Hwanwook Lee | 8206ad9 | 2018-01-02 18:03:50 +0900 | [diff] [blame] | 269 | futures.remove(key); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 270 | future.completeExceptionally(e); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 271 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 272 | // Done, return the future |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 273 | return future; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 274 | } |
| 275 | |
| 276 | @Override |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 277 | public MeterStoreResult storeMeterFeatures(MeterFeatures meterfeatures) { |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 278 | // Store meter features, this is done once for each features of every device |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 279 | MeterStoreResult result = MeterStoreResult.success(); |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 280 | MeterTableKey key = MeterTableKey.key(meterfeatures.deviceId(), meterfeatures.scope()); |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 281 | try { |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 282 | metersFeatures.put(key, meterfeatures); |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 283 | } catch (StorageException e) { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 284 | log.error("{} thrown a storage exception: {}", e.getStackTrace()[0].getMethodName(), |
| 285 | e.getMessage(), e); |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 286 | result = MeterStoreResult.fail(TIMEOUT); |
| 287 | } |
| 288 | return result; |
| 289 | } |
| 290 | |
| 291 | @Override |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 292 | public MeterStoreResult storeMeterFeatures(Collection<MeterFeatures> meterfeatures) { |
| 293 | // These store operations is treated as one single operation |
| 294 | // If one of them is failed, Fail is returned |
| 295 | // But the failed operation will not block the rest. |
| 296 | MeterStoreResult result = MeterStoreResult.success(); |
| 297 | for (MeterFeatures mf : meterfeatures) { |
| 298 | if (storeMeterFeatures(mf).type() == FAIL) { |
| 299 | result = MeterStoreResult.fail(TIMEOUT); |
| 300 | } |
| 301 | } |
| 302 | return result; |
| 303 | } |
| 304 | |
| 305 | @Override |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 306 | public MeterStoreResult deleteMeterFeatures(DeviceId deviceId) { |
| 307 | MeterStoreResult result = MeterStoreResult.success(); |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 308 | try { |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 309 | Set<MeterTableKey> keys = metersFeatures.keySet().stream() |
| 310 | .filter(key -> key.deviceId().equals(deviceId)) |
| 311 | .collect(Collectors.toUnmodifiableSet()); |
| 312 | keys.forEach(k -> { |
| 313 | metersFeatures.remove(k); |
| 314 | }); |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 315 | } catch (StorageException e) { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 316 | log.error("{} thrown a storage exception: {}", e.getStackTrace()[0].getMethodName(), |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 317 | e.getMessage(), e); |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 318 | result = MeterStoreResult.fail(TIMEOUT); |
| 319 | } |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 320 | |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 321 | return result; |
| 322 | } |
| 323 | |
| 324 | @Override |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 325 | public MeterStoreResult deleteMeterFeatures(Collection<MeterFeatures> meterfeatures) { |
| 326 | // These store operations is treated as one single operation |
| 327 | // If one of them is failed, Fail is returned |
| 328 | // But the failed operation will not block the rest. |
| 329 | MeterStoreResult result = MeterStoreResult.success(); |
| 330 | for (MeterFeatures mf : meterfeatures) { |
| 331 | try { |
| 332 | MeterTableKey key = MeterTableKey.key(mf.deviceId(), mf.scope()); |
| 333 | metersFeatures.remove(key); |
| 334 | } catch (StorageException e) { |
| 335 | log.error("{} thrown a storage exception: {}", e.getStackTrace()[0].getMethodName(), |
| 336 | e.getMessage(), e); |
| 337 | result = MeterStoreResult.fail(TIMEOUT); |
| 338 | } |
| 339 | } |
| 340 | |
| 341 | return result; |
| 342 | } |
| 343 | |
| 344 | @Override |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 345 | // TODO Should we remove it ? We are not using it |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 346 | public CompletableFuture<MeterStoreResult> updateMeter(Meter meter) { |
| 347 | CompletableFuture<MeterStoreResult> future = new CompletableFuture<>(); |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 348 | MeterKey key = MeterKey.key(meter.deviceId(), meter.meterCellId()); |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 349 | futures.put(key, future); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 350 | |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 351 | MeterData data = new MeterData(meter, null); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 352 | try { |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 353 | if (meters.computeIfPresent(key, (k, v) -> data) == null) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 354 | future.complete(MeterStoreResult.fail(MeterFailReason.INVALID_METER)); |
| 355 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 356 | } catch (StorageException e) { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 357 | log.error("{} thrown a storage exception: {}", e.getStackTrace()[0].getMethodName(), |
| 358 | e.getMessage(), e); |
Hwanwook Lee | 8206ad9 | 2018-01-02 18:03:50 +0900 | [diff] [blame] | 359 | futures.remove(key); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 360 | future.completeExceptionally(e); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 361 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 362 | return future; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 363 | } |
| 364 | |
| 365 | @Override |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 366 | public Meter updateMeterState(Meter meter) { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 367 | // Update meter if present (stats workflow) |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 368 | MeterKey key = MeterKey.key(meter.deviceId(), meter.meterCellId()); |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 369 | Versioned<MeterData> value = meters.computeIfPresent(key, (k, v) -> { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 370 | DefaultMeter m = (DefaultMeter) v.meter(); |
pier | 59721bf | 2020-01-08 08:57:46 +0100 | [diff] [blame] | 371 | MeterState meterState = m.state(); |
| 372 | if (meterState == MeterState.PENDING_ADD) { |
| 373 | m.setState(meter.state()); |
| 374 | } |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 375 | m.setProcessedPackets(meter.packetsSeen()); |
| 376 | m.setProcessedBytes(meter.bytesSeen()); |
| 377 | m.setLife(meter.life()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 378 | // TODO: Prune if drops to zero. |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 379 | m.setReferenceCount(meter.referenceCount()); |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 380 | return new MeterData(m, null); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 381 | }); |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 382 | return value != null ? value.value().meter() : null; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 383 | } |
| 384 | |
| 385 | @Override |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 386 | public Meter getMeter(MeterKey key) { |
| 387 | MeterData data = Versioned.valueOrElse(meters.get(key), null); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 388 | return data == null ? null : data.meter(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 389 | } |
| 390 | |
| 391 | @Override |
| 392 | public Collection<Meter> getAllMeters() { |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 393 | return Collections2.transform(ImmutableSet.copyOf(metersMap.values()), |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 394 | MeterData::meter); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 395 | } |
| 396 | |
| 397 | @Override |
Jordi Ortiz | 9287b63 | 2017-06-22 11:01:37 +0200 | [diff] [blame] | 398 | public Collection<Meter> getAllMeters(DeviceId deviceId) { |
| 399 | return Collections2.transform( |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 400 | Collections2.filter(ImmutableSet.copyOf(metersMap.values()), |
Jordi Ortiz | 9287b63 | 2017-06-22 11:01:37 +0200 | [diff] [blame] | 401 | (MeterData m) -> m.meter().deviceId().equals(deviceId)), |
| 402 | MeterData::meter); |
| 403 | } |
| 404 | |
| 405 | @Override |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 406 | public void failedMeter(MeterOperation op, MeterFailReason reason) { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 407 | // Meter ops failed (got notification from the sb) |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 408 | MeterKey key = MeterKey.key(op.meter().deviceId(), op.meter().id()); |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 409 | meters.computeIfPresent(key, (k, v) -> new MeterData(v.meter(), reason)); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 410 | } |
| 411 | |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 412 | @Override |
| 413 | public void deleteMeterNow(Meter m) { |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 414 | // This method is renamed in onos-2.5 |
| 415 | purgeMeter(m); |
| 416 | } |
| 417 | |
| 418 | @Override |
| 419 | public void purgeMeter(Meter m) { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 420 | // Once we receive the ack from the sb |
| 421 | // create the key and remove definitely the meter |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 422 | MeterKey key = MeterKey.key(m.deviceId(), m.id()); |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 423 | try { |
| 424 | if (Versioned.valueOrNull(meters.remove(key)) != null) { |
| 425 | // Free the id |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 426 | MeterScope scope; |
| 427 | if (m.meterCellId().type() == PIPELINE_INDEPENDENT) { |
| 428 | PiMeterCellId piMeterCellId = (PiMeterCellId) m.meterCellId(); |
| 429 | scope = MeterScope.of(piMeterCellId.meterId().id()); |
| 430 | } else { |
| 431 | scope = MeterScope.globalScope(); |
| 432 | } |
| 433 | MeterTableKey meterTableKey = MeterTableKey.key(m.deviceId(), scope); |
| 434 | freeMeterId(meterTableKey, m.meterCellId()); |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 435 | } |
| 436 | } catch (StorageException e) { |
| 437 | log.error("{} thrown a storage exception: {}", e.getStackTrace()[0].getMethodName(), |
| 438 | e.getMessage(), e); |
pier | 59721bf | 2020-01-08 08:57:46 +0100 | [diff] [blame] | 439 | } |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 440 | } |
| 441 | |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 442 | @Override |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 443 | public void purgeMeter(DeviceId deviceId) { |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 444 | List<Versioned<MeterData>> metersPendingRemove = meters.stream() |
| 445 | .filter(e -> Objects.equals(e.getKey().deviceId(), deviceId)) |
| 446 | .map(Map.Entry::getValue) |
| 447 | .collect(Collectors.toList()); |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 448 | metersPendingRemove.forEach(versionedMeterKey |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 449 | -> purgeMeter(versionedMeterKey.value().meter())); |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 450 | } |
| 451 | |
| 452 | @Override |
Daniele Moro | 43ac289 | 2021-07-15 17:02:59 +0200 | [diff] [blame^] | 453 | public void purgeMeters(DeviceId deviceId, ApplicationId appId) { |
| 454 | List<Versioned<MeterData>> metersPendingRemove = meters.stream() |
| 455 | .filter(e -> Objects.equals(e.getKey().deviceId(), deviceId) && |
| 456 | e.getValue().value().meter().appId().equals(appId)) |
| 457 | .map(Map.Entry::getValue) |
| 458 | .collect(Collectors.toList()); |
| 459 | metersPendingRemove.forEach(versionedMeterKey -> deleteMeterNow(versionedMeterKey.value().meter())); |
| 460 | } |
| 461 | |
| 462 | @Override |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 463 | public long getMaxMeters(MeterFeaturesKey key) { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 464 | // Leverage the meter features to know the max id |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 465 | // Create a Meter Table key with FeaturesKey's device and global scope |
| 466 | MeterTableKey meterTableKey = MeterTableKey.key(key.deviceId(), MeterScope.globalScope()); |
| 467 | return getMaxMeters(meterTableKey); |
| 468 | } |
| 469 | |
| 470 | private long getMaxMeters(MeterTableKey key) { |
| 471 | // Leverage the meter features to know the max id |
| 472 | MeterFeatures features = metersFeatures.get(key); |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 473 | return features == null ? 0L : features.maxMeter(); |
| 474 | } |
| 475 | |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 476 | private long getStartIndex(MeterTableKey key) { |
| 477 | // Leverage the meter features to know the start id |
| 478 | // Since we are using index now |
| 479 | // if there is no features related to the key |
| 480 | // -1 is returned |
| 481 | MeterFeatures features = metersFeatures.get(key); |
| 482 | return features == null ? -1L : features.startIndex(); |
| 483 | } |
| 484 | |
| 485 | private long getEndIndex(MeterTableKey key) { |
| 486 | // Leverage the meter features to know the max id |
| 487 | // Since we are using index now |
| 488 | // if there is no features related to the key |
| 489 | // -1 is returned |
| 490 | MeterFeatures features = metersFeatures.get(key); |
| 491 | return features == null ? -1L : features.endIndex(); |
| 492 | } |
| 493 | |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 494 | // queryMaxMeters is implemented in FullMetersAvailable behaviour. |
| 495 | private long queryMaxMeters(DeviceId device) { |
| 496 | // Get driver handler for this device |
| 497 | DriverHandler handler = driverService.createHandler(device); |
| 498 | // If creation failed or the device does not have this behavior |
| 499 | if (handler == null || !handler.hasBehaviour(MeterQuery.class)) { |
| 500 | // We cannot know max meter |
| 501 | return 0L; |
| 502 | } |
| 503 | // Get the behavior |
| 504 | MeterQuery query = handler.behaviour(MeterQuery.class); |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 505 | // Insert a new available key set to the map |
| 506 | String setName = AVAILABLEMETERIDSTORE + "-" + device + "global"; |
| 507 | MeterTableKey meterTableKey = MeterTableKey.key(device, MeterScope.globalScope()); |
| 508 | insertAvailableKeySet(meterTableKey, setName); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 509 | // Return as max meter the result of the query |
| 510 | return query.getMaxMeters(); |
| 511 | } |
| 512 | |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 513 | private boolean updateMeterIdAvailability(MeterTableKey meterTableKey, MeterCellId id, |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 514 | boolean available) { |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 515 | // Retrieve the set first |
| 516 | DistributedSet<MeterKey> keySet = availableMeterIds.get(meterTableKey); |
| 517 | if (keySet == null) { |
| 518 | // A reusable set should be inserted when a features is pushed |
| 519 | log.warn("Reusable Key set for device: {} scope: {} not found", |
| 520 | meterTableKey.deviceId(), meterTableKey.scope()); |
| 521 | return false; |
| 522 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 523 | // According to available, make available or unavailable a meter key |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 524 | DeviceId deviceId = meterTableKey.deviceId(); |
| 525 | return available ? keySet.add(MeterKey.key(deviceId, id)) : |
| 526 | keySet.remove(MeterKey.key(deviceId, id)); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 527 | } |
| 528 | |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 529 | private MeterCellId getNextAvailableId(Set<MeterCellId> availableIds) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 530 | // If there are no available ids |
| 531 | if (availableIds.isEmpty()) { |
| 532 | // Just end the cycle |
| 533 | return null; |
| 534 | } |
| 535 | // If it is the first fit |
| 536 | if (reuseStrategy == FIRST_FIT || availableIds.size() == 1) { |
| 537 | return availableIds.iterator().next(); |
| 538 | } |
| 539 | // If it is random, get the size |
| 540 | int size = availableIds.size(); |
| 541 | // Return a random element |
| 542 | return Iterables.get(availableIds, RandomUtils.nextInt(size)); |
| 543 | } |
| 544 | |
| 545 | // Implements reuse strategy |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 546 | private MeterCellId firstReusableMeterId(MeterTableKey meterTableKey) { |
| 547 | // Create a Table key and use it to retrieve the reusable meterCellId set |
| 548 | DistributedSet<MeterKey> keySet = availableMeterIds.get(meterTableKey); |
| 549 | if (keySet == null) { |
| 550 | // A reusable set should be inserted when a features is pushed |
| 551 | log.warn("Reusable Key set for device: {} scope: {} not found", |
| 552 | meterTableKey.deviceId(), meterTableKey.scope()); |
| 553 | return null; |
| 554 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 555 | // Filter key related to device id, and reduce to meter ids |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 556 | Set<MeterCellId> localAvailableMeterIds = keySet.stream() |
| 557 | .filter(meterKey -> |
| 558 | meterKey.deviceId().equals(meterTableKey.deviceId())) |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 559 | .map(MeterKey::meterId) |
| 560 | .collect(Collectors.toSet()); |
| 561 | // Get next available id |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 562 | MeterCellId meterId = getNextAvailableId(localAvailableMeterIds); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 563 | // Iterate until there are items |
| 564 | while (meterId != null) { |
| 565 | // If we are able to reserve the id |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 566 | if (updateMeterIdAvailability(meterTableKey, meterId, false)) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 567 | // Just end |
| 568 | return meterId; |
| 569 | } |
| 570 | // Update the set |
| 571 | localAvailableMeterIds.remove(meterId); |
| 572 | // Try another time |
| 573 | meterId = getNextAvailableId(localAvailableMeterIds); |
| 574 | } |
| 575 | // No reusable ids |
| 576 | return null; |
| 577 | } |
| 578 | |
| 579 | @Override |
| 580 | public MeterId allocateMeterId(DeviceId deviceId) { |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 581 | // We use global scope for MeterId |
| 582 | return (MeterId) allocateMeterId(deviceId, MeterScope.globalScope()); |
| 583 | } |
| 584 | |
| 585 | @Override |
| 586 | public MeterCellId allocateMeterId(DeviceId deviceId, MeterScope meterScope) { |
| 587 | MeterTableKey meterTableKey = MeterTableKey.key(deviceId, meterScope); |
| 588 | MeterCellId meterCellId; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 589 | long id; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 590 | // First, search for reusable key |
| 591 | meterCellId = firstReusableMeterId(meterTableKey); |
| 592 | if (meterCellId != null) { |
| 593 | // A reusable key is found |
| 594 | return meterCellId; |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 595 | } |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 596 | // If there was no reusable meter id we have to generate a new value |
| 597 | // using start and end index as lower and upper bound respectively. |
| 598 | long startIndex = getStartIndex(meterTableKey); |
| 599 | long endIndex = getEndIndex(meterTableKey); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 600 | // If the device does not give us MeterFeatures |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 601 | if (startIndex == -1L || endIndex == -1L) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 602 | // MeterFeatures couldn't be retrieved, fallback to queryMeters. |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 603 | // Only meaningful to OpenFLow |
| 604 | long maxMeters = queryMaxMeters(deviceId); |
| 605 | // If we don't know the max, cannot proceed |
| 606 | if (maxMeters == 0L) { |
| 607 | return null; |
| 608 | } else { |
| 609 | // OpenFlow meter index starts from 1, ends with max-1 |
| 610 | startIndex = 1L; |
| 611 | endIndex = maxMeters - 1; |
| 612 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 613 | } |
| 614 | // Get a new value |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 615 | // If the value is smaller than the start index, get another one |
| 616 | do { |
| 617 | id = meterIdGenerators.incrementAndGet(meterTableKey); |
| 618 | } while (id < startIndex); |
| 619 | // Check with the end index, and if the value is bigger, cannot proceed |
| 620 | if (id > endIndex) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 621 | return null; |
| 622 | } |
| 623 | // Done, return the value |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 624 | // If we are using global scope, return a MeterId |
| 625 | // Else, return a PiMeterId |
| 626 | if (meterScope.isGlobal()) { |
| 627 | return MeterId.meterId(id); |
| 628 | } else { |
| 629 | return PiMeterCellId.ofIndirect(PiMeterId.of(meterScope.id()), id); |
| 630 | } |
| 631 | |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 632 | } |
| 633 | |
| 634 | @Override |
| 635 | public void freeMeterId(DeviceId deviceId, MeterId meterId) { |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 636 | MeterTableKey meterTableKey = MeterTableKey.key(deviceId, MeterScope.globalScope()); |
| 637 | freeMeterId(meterTableKey, meterId); |
| 638 | } |
| 639 | |
| 640 | private void freeMeterId(MeterTableKey meterTableKey, MeterCellId meterCellId) { |
| 641 | long index; |
| 642 | if (meterCellId.type() == PIPELINE_INDEPENDENT) { |
| 643 | PiMeterCellId piMeterCellId = (PiMeterCellId) meterCellId; |
| 644 | index = piMeterCellId.index(); |
| 645 | } else if (meterCellId.type() == INDEX) { |
| 646 | MeterId meterId = (MeterId) meterCellId; |
| 647 | index = meterId.id(); |
| 648 | } else { |
| 649 | return; |
| 650 | } |
Pier Luigi | bdcd967 | 2017-10-13 13:54:48 +0200 | [diff] [blame] | 651 | // Avoid to free meter not allocated |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 652 | if (meterIdGenerators.get(meterTableKey) < index) { |
Pier Luigi | bdcd967 | 2017-10-13 13:54:48 +0200 | [diff] [blame] | 653 | return; |
| 654 | } |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 655 | // Update the availability |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 656 | updateMeterIdAvailability(meterTableKey, meterCellId, true); |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 657 | } |
| 658 | |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 659 | // Enabling the events distribution across the cluster |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 660 | private class InternalMetersMapEventListener implements MapEventListener<MeterKey, MeterData> { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 661 | @Override |
HIGUCHI Yuta | 0574a55 | 2015-09-29 14:38:25 -0700 | [diff] [blame] | 662 | public void event(MapEvent<MeterKey, MeterData> event) { |
| 663 | MeterKey key = event.key(); |
Ray Milkey | d0f017f | 2018-09-21 12:52:34 -0700 | [diff] [blame] | 664 | Versioned<MeterData> value = event.type() == MapEvent.Type.REMOVE ? event.oldValue() : event.newValue(); |
| 665 | MeterData data = value.value(); |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 666 | MeterData oldData = Versioned.valueOrNull(event.oldValue()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 667 | switch (event.type()) { |
| 668 | case INSERT: |
| 669 | case UPDATE: |
| 670 | switch (data.meter().state()) { |
| 671 | case PENDING_ADD: |
| 672 | case PENDING_REMOVE: |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 673 | // Two cases. If there is a reason, the meter operation failed. |
| 674 | // Otherwise, we are ready to install/remove through the delegate. |
| 675 | if (data.reason().isEmpty()) { |
| 676 | notifyDelegate(new MeterEvent(data.meter().state() == MeterState.PENDING_ADD ? |
| 677 | MeterEvent.Type.METER_ADD_REQ : MeterEvent.Type.METER_REM_REQ, data.meter())); |
| 678 | } else { |
Jordi Ortiz | df28ecd | 2017-03-25 19:22:36 +0100 | [diff] [blame] | 679 | futures.computeIfPresent(key, (k, v) -> { |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 680 | v.complete(MeterStoreResult.fail(data.reason().get())); |
Jordi Ortiz | df28ecd | 2017-03-25 19:22:36 +0100 | [diff] [blame] | 681 | return null; |
| 682 | }); |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 683 | } |
| 684 | break; |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 685 | case ADDED: |
| 686 | // Transition from pending to installed |
| 687 | if (data.meter().state() == MeterState.ADDED && |
| 688 | (oldData != null && oldData.meter().state() == MeterState.PENDING_ADD)) { |
| 689 | futures.computeIfPresent(key, (k, v) -> { |
| 690 | v.complete(MeterStoreResult.success()); |
| 691 | return null; |
| 692 | }); |
| 693 | notifyDelegate(new MeterEvent(MeterEvent.Type.METER_ADDED, data.meter())); |
| 694 | // Update stats case |
| 695 | } else if (data.meter().referenceCount() == 0) { |
| 696 | notifyDelegate(new MeterEvent(MeterEvent.Type.METER_REFERENCE_COUNT_ZERO, |
| 697 | data.meter())); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 698 | } |
| 699 | break; |
| 700 | default: |
| 701 | log.warn("Unknown meter state type {}", data.meter().state()); |
| 702 | } |
| 703 | break; |
| 704 | case REMOVE: |
pierventre | 1b8afbc | 2020-07-13 14:07:05 +0200 | [diff] [blame] | 705 | // Meter removal case |
| 706 | futures.computeIfPresent(key, (k, v) -> { |
| 707 | v.complete(MeterStoreResult.success()); |
| 708 | return null; |
| 709 | }); |
| 710 | // Finally notify the delegate |
| 711 | notifyDelegate(new MeterEvent(MeterEvent.Type.METER_REMOVED, data.meter())); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 712 | break; |
| 713 | default: |
| 714 | log.warn("Unknown Map event type {}", event.type()); |
| 715 | } |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 716 | } |
| 717 | } |
| 718 | |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 719 | private class InternalFeaturesMapEventListener implements |
| 720 | EventuallyConsistentMapListener<MeterTableKey, MeterFeatures> { |
| 721 | @Override |
| 722 | public void event(EventuallyConsistentMapEvent<MeterTableKey, MeterFeatures> event) { |
| 723 | MeterTableKey meterTableKey = event.key(); |
| 724 | MeterFeatures meterFeatures = event.value(); |
| 725 | switch (event.type()) { |
| 726 | case PUT: |
| 727 | // Put a new available meter id set to the map |
| 728 | String setName = AVAILABLEMETERIDSTORE + "-" + |
| 729 | meterFeatures.deviceId() + meterFeatures.scope().id(); |
| 730 | insertAvailableKeySet(meterTableKey, setName); |
| 731 | break; |
| 732 | case REMOVE: |
| 733 | // Remove the set |
| 734 | DistributedSet<MeterKey> set = availableMeterIds.remove(meterTableKey); |
| 735 | if (set != null) { |
| 736 | set.destroy(); |
| 737 | } |
| 738 | break; |
| 739 | default: |
| 740 | break; |
| 741 | } |
| 742 | } |
| 743 | } |
| 744 | |
| 745 | private void insertAvailableKeySet(MeterTableKey meterTableKey, String setName) { |
| 746 | DistributedSet<MeterKey> availableMeterIdSet = |
| 747 | new DefaultDistributedSet<>(storageService.<MeterKey>setBuilder() |
| 748 | .withName(setName) |
| 749 | .withSerializer(Serializer.using(KryoNamespaces.API, |
| 750 | MeterKey.class)).build(), |
| 751 | DistributedPrimitive.DEFAULT_OPERATION_TIMEOUT_MILLIS); |
| 752 | availableMeterIds.put(meterTableKey, availableMeterIdSet); |
| 753 | } |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 754 | } |