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