alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.incubator.net.meter.impl; |
| 17 | |
Konstantinos Kanonakis | a45755d | 2016-03-14 11:31:23 -0500 | [diff] [blame] | 18 | import org.apache.commons.lang3.tuple.Pair; |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 19 | import com.google.common.collect.Maps; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 20 | import org.apache.felix.scr.annotations.Activate; |
| 21 | import org.apache.felix.scr.annotations.Component; |
| 22 | import org.apache.felix.scr.annotations.Deactivate; |
| 23 | import org.apache.felix.scr.annotations.Reference; |
| 24 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 25 | import org.apache.felix.scr.annotations.Service; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 26 | import org.onlab.util.TriConsumer; |
Jian Li | 1932b93 | 2016-01-03 00:35:40 -0800 | [diff] [blame] | 27 | import org.onosproject.net.DeviceId; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 28 | import org.onosproject.net.meter.DefaultMeter; |
| 29 | import org.onosproject.net.meter.Meter; |
| 30 | import org.onosproject.net.meter.MeterEvent; |
| 31 | import org.onosproject.net.meter.MeterFailReason; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 32 | import org.onosproject.net.meter.MeterFeatures; |
Jordi Ortiz | 21daebf | 2016-12-27 18:50:14 +0100 | [diff] [blame^] | 33 | import org.onosproject.net.meter.MeterFeaturesKey; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 34 | import org.onosproject.net.meter.MeterId; |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 35 | import org.onosproject.net.meter.MeterKey; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 36 | import org.onosproject.net.meter.MeterListener; |
| 37 | import org.onosproject.net.meter.MeterOperation; |
| 38 | import org.onosproject.net.meter.MeterProvider; |
| 39 | import org.onosproject.net.meter.MeterProviderRegistry; |
| 40 | import org.onosproject.net.meter.MeterProviderService; |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 41 | import org.onosproject.net.meter.MeterRequest; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 42 | import org.onosproject.net.meter.MeterService; |
| 43 | import org.onosproject.net.meter.MeterState; |
| 44 | import org.onosproject.net.meter.MeterStore; |
| 45 | import org.onosproject.net.meter.MeterStoreDelegate; |
| 46 | import org.onosproject.net.meter.MeterStoreResult; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 47 | import org.onosproject.net.provider.AbstractListenerProviderRegistry; |
| 48 | import org.onosproject.net.provider.AbstractProviderService; |
| 49 | import org.onosproject.store.service.AtomicCounter; |
| 50 | import org.onosproject.store.service.StorageService; |
| 51 | import org.slf4j.Logger; |
| 52 | |
| 53 | import java.util.Collection; |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 54 | import java.util.Map; |
Sho SHIMIZU | 0e03f59b | 2016-06-08 17:03:48 -0700 | [diff] [blame] | 55 | import java.util.function.Function; |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 56 | import java.util.stream.Collectors; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 57 | |
| 58 | import static org.slf4j.LoggerFactory.getLogger; |
| 59 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 60 | /** |
| 61 | * Provides implementation of the meter service APIs. |
| 62 | */ |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 63 | @Component(immediate = true, enabled = true) |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 64 | @Service |
| 65 | public class MeterManager extends AbstractListenerProviderRegistry<MeterEvent, MeterListener, |
| 66 | MeterProvider, MeterProviderService> |
| 67 | implements MeterService, MeterProviderRegistry { |
| 68 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 69 | private static final String METERCOUNTERIDENTIFIER = "meter-id-counter-%s"; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 70 | private final Logger log = getLogger(getClass()); |
| 71 | private final MeterStoreDelegate delegate = new InternalMeterStoreDelegate(); |
| 72 | |
| 73 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 74 | protected StorageService storageService; |
| 75 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 76 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 77 | protected MeterStore store; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 78 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 79 | private Map<DeviceId, AtomicCounter> meterIdCounters |
| 80 | = Maps.newConcurrentMap(); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 81 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 82 | private TriConsumer<MeterRequest, MeterStoreResult, Throwable> onComplete; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 83 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 84 | @Activate |
| 85 | public void activate() { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 86 | |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 87 | store.setDelegate(delegate); |
Jordi Ortiz | 3a6f307 | 2016-11-07 10:23:48 +0100 | [diff] [blame] | 88 | eventDispatcher.addSink(MeterEvent.class, listenerRegistry); |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 89 | |
Jordi Ortiz | 3a6f307 | 2016-11-07 10:23:48 +0100 | [diff] [blame] | 90 | onComplete = (request, result, error) -> { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 91 | request.context().ifPresent(c -> { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 92 | if (error != null) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 93 | c.onError(request, MeterFailReason.UNKNOWN); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 94 | } else { |
| 95 | if (result.reason().isPresent()) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 96 | c.onError(request, result.reason().get()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 97 | } else { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 98 | c.onSuccess(request); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 99 | } |
| 100 | } |
| 101 | }); |
| 102 | |
| 103 | }; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 104 | log.info("Started"); |
| 105 | } |
| 106 | |
| 107 | @Deactivate |
| 108 | public void deactivate() { |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 109 | store.unsetDelegate(delegate); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 110 | log.info("Stopped"); |
| 111 | } |
| 112 | |
| 113 | @Override |
| 114 | protected MeterProviderService createProviderService(MeterProvider provider) { |
| 115 | return new InternalMeterProviderService(provider); |
| 116 | } |
| 117 | |
| 118 | @Override |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 119 | public Meter submit(MeterRequest request) { |
| 120 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 121 | MeterId id = allocateMeterId(request.deviceId()); |
| 122 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 123 | Meter.Builder mBuilder = DefaultMeter.builder() |
| 124 | .forDevice(request.deviceId()) |
| 125 | .fromApp(request.appId()) |
| 126 | .withBands(request.bands()) |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 127 | .withId(id) |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 128 | .withUnit(request.unit()); |
| 129 | |
| 130 | if (request.isBurst()) { |
| 131 | mBuilder.burst(); |
| 132 | } |
| 133 | DefaultMeter m = (DefaultMeter) mBuilder.build(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 134 | m.setState(MeterState.PENDING_ADD); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 135 | store.storeMeter(m).whenComplete((result, error) -> |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 136 | onComplete.accept(request, result, error)); |
| 137 | return m; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 138 | } |
| 139 | |
| 140 | @Override |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 141 | public void withdraw(MeterRequest request, MeterId meterId) { |
| 142 | Meter.Builder mBuilder = DefaultMeter.builder() |
| 143 | .forDevice(request.deviceId()) |
| 144 | .fromApp(request.appId()) |
| 145 | .withBands(request.bands()) |
| 146 | .withId(meterId) |
| 147 | .withUnit(request.unit()); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 148 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 149 | if (request.isBurst()) { |
| 150 | mBuilder.burst(); |
| 151 | } |
| 152 | |
| 153 | DefaultMeter m = (DefaultMeter) mBuilder.build(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 154 | m.setState(MeterState.PENDING_REMOVE); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 155 | store.deleteMeter(m).whenComplete((result, error) -> |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 156 | onComplete.accept(request, result, error)); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | @Override |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 160 | public Meter getMeter(DeviceId deviceId, MeterId id) { |
| 161 | MeterKey key = MeterKey.key(deviceId, id); |
| 162 | return store.getMeter(key); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 163 | } |
| 164 | |
| 165 | @Override |
Jian Li | 1932b93 | 2016-01-03 00:35:40 -0800 | [diff] [blame] | 166 | public Collection<Meter> getMeters(DeviceId deviceId) { |
| 167 | return store.getAllMeters().stream().filter(m -> |
| 168 | m.deviceId().equals(deviceId)).collect(Collectors.toList()); |
| 169 | } |
| 170 | |
| 171 | @Override |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 172 | public Collection<Meter> getAllMeters() { |
| 173 | return store.getAllMeters(); |
| 174 | } |
| 175 | |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 176 | private MeterId allocateMeterId(DeviceId deviceId) { |
Jordi Ortiz | 21daebf | 2016-12-27 18:50:14 +0100 | [diff] [blame^] | 177 | long maxMeters = store.getMaxMeters(MeterFeaturesKey.key(deviceId)); |
| 178 | |
| 179 | if (maxMeters == 0L) { |
| 180 | throw new IllegalStateException("Meters not supported by device " + deviceId); |
| 181 | } |
| 182 | |
| 183 | final long mmeters = maxMeters; |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 184 | long id = meterIdCounters.compute(deviceId, (k, v) -> { |
| 185 | if (v == null) { |
| 186 | return allocateCounter(k); |
| 187 | } |
Jordi Ortiz | 21daebf | 2016-12-27 18:50:14 +0100 | [diff] [blame^] | 188 | if (v.get() >= mmeters) { |
| 189 | throw new IllegalStateException("Maximum number of meters " + |
| 190 | meterIdCounters.get(deviceId).get() + |
| 191 | " reached for device " + deviceId); |
| 192 | } |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 193 | return v; |
| 194 | }).incrementAndGet(); |
| 195 | |
Jordi Ortiz | 21daebf | 2016-12-27 18:50:14 +0100 | [diff] [blame^] | 196 | return MeterId.meterId(id); |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 197 | } |
| 198 | |
| 199 | private AtomicCounter allocateCounter(DeviceId deviceId) { |
Madan Jampani | d5714e0 | 2016-04-19 14:15:20 -0700 | [diff] [blame] | 200 | return storageService.getAtomicCounter(String.format(METERCOUNTERIDENTIFIER, deviceId)); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | private class InternalMeterProviderService |
| 204 | extends AbstractProviderService<MeterProvider> |
| 205 | implements MeterProviderService { |
| 206 | |
| 207 | /** |
| 208 | * Creates a provider service on behalf of the specified provider. |
| 209 | * |
| 210 | * @param provider provider to which this service is being issued |
| 211 | */ |
| 212 | protected InternalMeterProviderService(MeterProvider provider) { |
| 213 | super(provider); |
| 214 | } |
| 215 | |
| 216 | @Override |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 217 | public void meterOperationFailed(MeterOperation operation, |
| 218 | MeterFailReason reason) { |
| 219 | store.failedMeter(operation, reason); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | @Override |
| 223 | public void pushMeterMetrics(DeviceId deviceId, Collection<Meter> meterEntries) { |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 224 | //FIXME: FOLLOWING CODE CANNOT BE TESTED UNTIL SOMETHING THAT |
| 225 | //FIXME: IMPLEMENTS METERS EXISTS |
Konstantinos Kanonakis | a45755d | 2016-03-14 11:31:23 -0500 | [diff] [blame] | 226 | Map<Pair<DeviceId, MeterId>, Meter> storedMeterMap = store.getAllMeters().stream() |
Sho SHIMIZU | 0e03f59b | 2016-06-08 17:03:48 -0700 | [diff] [blame] | 227 | .collect(Collectors.toMap(m -> Pair.of(m.deviceId(), m.id()), Function.identity())); |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 228 | |
| 229 | meterEntries.stream() |
Konstantinos Kanonakis | a45755d | 2016-03-14 11:31:23 -0500 | [diff] [blame] | 230 | .filter(m -> storedMeterMap.remove(Pair.of(m.deviceId(), m.id())) != null) |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 231 | .forEach(m -> store.updateMeterState(m)); |
| 232 | |
Sho SHIMIZU | a09e1bb | 2016-08-01 14:25:25 -0700 | [diff] [blame] | 233 | storedMeterMap.values().forEach(m -> { |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 234 | if (m.state() == MeterState.PENDING_ADD) { |
| 235 | provider().performMeterOperation(m.deviceId(), |
| 236 | new MeterOperation(m, |
Konstantinos Kanonakis | a45755d | 2016-03-14 11:31:23 -0500 | [diff] [blame] | 237 | MeterOperation.Type.MODIFY)); |
| 238 | } else if (m.state() == MeterState.PENDING_REMOVE) { |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 239 | store.deleteMeterNow(m); |
| 240 | } |
| 241 | }); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 242 | } |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 243 | |
| 244 | @Override |
| 245 | public void pushMeterFeatures(DeviceId deviceId, MeterFeatures meterfeatures) { |
| 246 | store.storeMeterFeatures(meterfeatures); |
| 247 | } |
| 248 | |
| 249 | @Override |
| 250 | public void deleteMeterFeatures(DeviceId deviceId) { |
| 251 | store.deleteMeterFeatures(deviceId); |
| 252 | } |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 253 | } |
| 254 | |
| 255 | private class InternalMeterStoreDelegate implements MeterStoreDelegate { |
| 256 | |
| 257 | @Override |
| 258 | public void notify(MeterEvent event) { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 259 | DeviceId deviceId = event.subject().deviceId(); |
| 260 | MeterProvider p = getProvider(event.subject().deviceId()); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 261 | switch (event.type()) { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 262 | case METER_ADD_REQ: |
| 263 | p.performMeterOperation(deviceId, new MeterOperation(event.subject(), |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 264 | MeterOperation.Type.ADD)); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 265 | break; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 266 | case METER_REM_REQ: |
| 267 | p.performMeterOperation(deviceId, new MeterOperation(event.subject(), |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 268 | MeterOperation.Type.REMOVE)); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 269 | break; |
| 270 | default: |
| 271 | log.warn("Unknown meter event {}", event.type()); |
| 272 | } |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 273 | |
| 274 | } |
| 275 | } |
| 276 | |
| 277 | } |