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