alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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 | |
| 18 | import org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
| 20 | import org.apache.felix.scr.annotations.Deactivate; |
| 21 | import org.apache.felix.scr.annotations.Reference; |
| 22 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 23 | import org.apache.felix.scr.annotations.Service; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 24 | import org.onlab.util.TriConsumer; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 25 | import org.onosproject.net.meter.DefaultMeter; |
| 26 | import org.onosproject.net.meter.Meter; |
| 27 | import org.onosproject.net.meter.MeterEvent; |
| 28 | import org.onosproject.net.meter.MeterFailReason; |
| 29 | import org.onosproject.net.meter.MeterId; |
| 30 | import org.onosproject.net.meter.MeterListener; |
| 31 | import org.onosproject.net.meter.MeterOperation; |
| 32 | import org.onosproject.net.meter.MeterProvider; |
| 33 | import org.onosproject.net.meter.MeterProviderRegistry; |
| 34 | import org.onosproject.net.meter.MeterProviderService; |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 35 | import org.onosproject.net.meter.MeterRequest; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 36 | import org.onosproject.net.meter.MeterService; |
| 37 | import org.onosproject.net.meter.MeterState; |
| 38 | import org.onosproject.net.meter.MeterStore; |
| 39 | import org.onosproject.net.meter.MeterStoreDelegate; |
| 40 | import org.onosproject.net.meter.MeterStoreResult; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 41 | import org.onosproject.net.DeviceId; |
| 42 | import org.onosproject.net.provider.AbstractListenerProviderRegistry; |
| 43 | import org.onosproject.net.provider.AbstractProviderService; |
| 44 | import org.onosproject.store.service.AtomicCounter; |
| 45 | import org.onosproject.store.service.StorageService; |
| 46 | import org.slf4j.Logger; |
| 47 | |
| 48 | import java.util.Collection; |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 49 | import java.util.Map; |
| 50 | import java.util.stream.Collectors; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 51 | |
| 52 | import static org.slf4j.LoggerFactory.getLogger; |
| 53 | |
| 54 | |
| 55 | /** |
| 56 | * Provides implementation of the meter service APIs. |
| 57 | */ |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 58 | @Component(immediate = true, enabled = true) |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 59 | @Service |
| 60 | public class MeterManager extends AbstractListenerProviderRegistry<MeterEvent, MeterListener, |
| 61 | MeterProvider, MeterProviderService> |
| 62 | implements MeterService, MeterProviderRegistry { |
| 63 | |
| 64 | private final String meterIdentifier = "meter-id-counter"; |
| 65 | private final Logger log = getLogger(getClass()); |
| 66 | private final MeterStoreDelegate delegate = new InternalMeterStoreDelegate(); |
| 67 | |
| 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 69 | protected StorageService storageService; |
| 70 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 72 | protected MeterStore store; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 73 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 74 | private AtomicCounter meterIdCounter; |
| 75 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 76 | private TriConsumer<MeterRequest, MeterStoreResult, Throwable> onComplete; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 77 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 78 | @Activate |
| 79 | public void activate() { |
| 80 | meterIdCounter = storageService.atomicCounterBuilder() |
| 81 | .withName(meterIdentifier) |
| 82 | .build(); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 83 | |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 84 | store.setDelegate(delegate); |
| 85 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 86 | onComplete = (request, result, error) -> |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 87 | { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 88 | request.context().ifPresent(c -> { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 89 | if (error != null) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 90 | c.onError(request, MeterFailReason.UNKNOWN); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 91 | } else { |
| 92 | if (result.reason().isPresent()) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 93 | c.onError(request, result.reason().get()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 94 | } else { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 95 | c.onSuccess(request); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 96 | } |
| 97 | } |
| 98 | }); |
| 99 | |
| 100 | }; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 101 | log.info("Started"); |
| 102 | } |
| 103 | |
| 104 | @Deactivate |
| 105 | public void deactivate() { |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 106 | store.unsetDelegate(delegate); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 107 | log.info("Stopped"); |
| 108 | } |
| 109 | |
| 110 | @Override |
| 111 | protected MeterProviderService createProviderService(MeterProvider provider) { |
| 112 | return new InternalMeterProviderService(provider); |
| 113 | } |
| 114 | |
| 115 | @Override |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 116 | public Meter submit(MeterRequest request) { |
| 117 | |
| 118 | Meter.Builder mBuilder = DefaultMeter.builder() |
| 119 | .forDevice(request.deviceId()) |
| 120 | .fromApp(request.appId()) |
| 121 | .withBands(request.bands()) |
| 122 | .withId(allocateMeterId()) |
| 123 | .withUnit(request.unit()); |
| 124 | |
| 125 | if (request.isBurst()) { |
| 126 | mBuilder.burst(); |
| 127 | } |
| 128 | DefaultMeter m = (DefaultMeter) mBuilder.build(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 129 | m.setState(MeterState.PENDING_ADD); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 130 | store.storeMeter(m).whenComplete((result, error) -> |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 131 | onComplete.accept(request, result, error)); |
| 132 | return m; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | @Override |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 136 | public void withdraw(MeterRequest request, MeterId meterId) { |
| 137 | Meter.Builder mBuilder = DefaultMeter.builder() |
| 138 | .forDevice(request.deviceId()) |
| 139 | .fromApp(request.appId()) |
| 140 | .withBands(request.bands()) |
| 141 | .withId(meterId) |
| 142 | .withUnit(request.unit()); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 143 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 144 | if (request.isBurst()) { |
| 145 | mBuilder.burst(); |
| 146 | } |
| 147 | |
| 148 | DefaultMeter m = (DefaultMeter) mBuilder.build(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 149 | m.setState(MeterState.PENDING_REMOVE); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 150 | store.deleteMeter(m).whenComplete((result, error) -> |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 151 | onComplete.accept(request, result, error)); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 152 | } |
| 153 | |
| 154 | @Override |
| 155 | public Meter getMeter(MeterId id) { |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 156 | return store.getMeter(id); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | @Override |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 160 | public Collection<Meter> getAllMeters() { |
| 161 | return store.getAllMeters(); |
| 162 | } |
| 163 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 164 | private MeterId allocateMeterId() { |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 165 | // FIXME: This will break one day. |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 166 | return MeterId.meterId((int) meterIdCounter.incrementAndGet()); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | private class InternalMeterProviderService |
| 170 | extends AbstractProviderService<MeterProvider> |
| 171 | implements MeterProviderService { |
| 172 | |
| 173 | /** |
| 174 | * Creates a provider service on behalf of the specified provider. |
| 175 | * |
| 176 | * @param provider provider to which this service is being issued |
| 177 | */ |
| 178 | protected InternalMeterProviderService(MeterProvider provider) { |
| 179 | super(provider); |
| 180 | } |
| 181 | |
| 182 | @Override |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 183 | public void meterOperationFailed(MeterOperation operation, |
| 184 | MeterFailReason reason) { |
| 185 | store.failedMeter(operation, reason); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | @Override |
| 189 | public void pushMeterMetrics(DeviceId deviceId, Collection<Meter> meterEntries) { |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 190 | //FIXME: FOLLOWING CODE CANNOT BE TESTED UNTIL SOMETHING THAT |
| 191 | //FIXME: IMPLEMENTS METERS EXISTS |
| 192 | Map<MeterId, Meter> storedMeterMap = store.getAllMeters().stream() |
| 193 | .collect(Collectors.toMap(Meter::id, m -> m)); |
| 194 | |
| 195 | meterEntries.stream() |
| 196 | .filter(m -> storedMeterMap.remove(m.id()) != null) |
| 197 | .forEach(m -> store.updateMeterState(m)); |
| 198 | |
| 199 | storedMeterMap.values().stream().forEach(m -> { |
| 200 | if (m.state() == MeterState.PENDING_ADD) { |
| 201 | provider().performMeterOperation(m.deviceId(), |
| 202 | new MeterOperation(m, |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 203 | MeterOperation.Type.ADD)); |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 204 | } else { |
| 205 | store.deleteMeterNow(m); |
| 206 | } |
| 207 | }); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 208 | } |
| 209 | } |
| 210 | |
| 211 | private class InternalMeterStoreDelegate implements MeterStoreDelegate { |
| 212 | |
| 213 | @Override |
| 214 | public void notify(MeterEvent event) { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 215 | DeviceId deviceId = event.subject().deviceId(); |
| 216 | MeterProvider p = getProvider(event.subject().deviceId()); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 217 | switch (event.type()) { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 218 | case METER_ADD_REQ: |
| 219 | p.performMeterOperation(deviceId, new MeterOperation(event.subject(), |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 220 | MeterOperation.Type.ADD)); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 221 | break; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 222 | case METER_REM_REQ: |
| 223 | p.performMeterOperation(deviceId, new MeterOperation(event.subject(), |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame^] | 224 | MeterOperation.Type.REMOVE)); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 225 | break; |
| 226 | default: |
| 227 | log.warn("Unknown meter event {}", event.type()); |
| 228 | } |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 229 | |
| 230 | } |
| 231 | } |
| 232 | |
| 233 | } |