Move meter manager implementation out of incubator
Change-Id: Ide0905c55e0584361fe37c3c5e16c697533eb9f9
diff --git a/core/net/src/main/java/org/onosproject/net/meter/impl/MeterManager.java b/core/net/src/main/java/org/onosproject/net/meter/impl/MeterManager.java
new file mode 100644
index 0000000..1173f1d
--- /dev/null
+++ b/core/net/src/main/java/org/onosproject/net/meter/impl/MeterManager.java
@@ -0,0 +1,380 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.net.meter.impl;
+
+import com.google.common.collect.Maps;
+import org.apache.felix.scr.annotations.Activate;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Deactivate;
+import org.apache.felix.scr.annotations.Property;
+import org.apache.felix.scr.annotations.Reference;
+import org.apache.felix.scr.annotations.ReferenceCardinality;
+import org.apache.felix.scr.annotations.Service;
+import org.onlab.util.TriConsumer;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.behaviour.MeterQuery;
+import org.onosproject.net.driver.DriverHandler;
+import org.onosproject.net.driver.DriverService;
+import org.onosproject.net.meter.DefaultMeter;
+import org.onosproject.net.meter.Meter;
+import org.onosproject.net.meter.MeterEvent;
+import org.onosproject.net.meter.MeterFailReason;
+import org.onosproject.net.meter.MeterFeatures;
+import org.onosproject.net.meter.MeterFeaturesKey;
+import org.onosproject.net.meter.MeterId;
+import org.onosproject.net.meter.MeterKey;
+import org.onosproject.net.meter.MeterListener;
+import org.onosproject.net.meter.MeterOperation;
+import org.onosproject.net.meter.MeterProvider;
+import org.onosproject.net.meter.MeterProviderRegistry;
+import org.onosproject.net.meter.MeterProviderService;
+import org.onosproject.net.meter.MeterRequest;
+import org.onosproject.net.meter.MeterService;
+import org.onosproject.net.meter.MeterState;
+import org.onosproject.net.meter.MeterStore;
+import org.onosproject.net.meter.MeterStoreDelegate;
+import org.onosproject.net.meter.MeterStoreResult;
+import org.onosproject.net.provider.AbstractListenerProviderRegistry;
+import org.onosproject.net.provider.AbstractProviderService;
+import org.onosproject.store.service.AtomicCounter;
+import org.onosproject.store.service.StorageService;
+import org.slf4j.Logger;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.concurrent.ExecutorService;
+import java.util.stream.Collectors;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static java.util.concurrent.Executors.newFixedThreadPool;
+import static org.onlab.util.Tools.groupedThreads;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Provides implementation of the meter service APIs.
+ */
+@Component(immediate = true)
+@Service
+public class MeterManager
+ extends AbstractListenerProviderRegistry<MeterEvent, MeterListener, MeterProvider, MeterProviderService>
+ implements MeterService, MeterProviderRegistry {
+
+ private static final String METERCOUNTERIDENTIFIER = "meter-id-counter-%s";
+ private static final String NUM_THREAD = "numThreads";
+ private static final String WORKER_PATTERN = "installer-%d";
+ private static final String GROUP_THREAD_NAME = "onos/meter";
+
+ private static final int DEFAULT_NUM_THREADS = 4;
+ @Property(name = NUM_THREAD,
+ intValue = DEFAULT_NUM_THREADS,
+ label = "Number of worker threads")
+ private int numThreads = DEFAULT_NUM_THREADS;
+
+ private final Logger log = getLogger(getClass());
+ private final MeterStoreDelegate delegate = new InternalMeterStoreDelegate();
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected StorageService storageService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected MeterStore store;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected DriverService driverService;
+
+ private Map<DeviceId, AtomicCounter> meterIdCounters
+ = Maps.newConcurrentMap();
+
+ private TriConsumer<MeterRequest, MeterStoreResult, Throwable> onComplete;
+
+ private ExecutorService executorService;
+
+ @Activate
+ public void activate() {
+ store.setDelegate(delegate);
+ eventDispatcher.addSink(MeterEvent.class, listenerRegistry);
+
+ onComplete = (request, result, error) -> {
+ request.context().ifPresent(c -> {
+ if (error != null) {
+ c.onError(request, MeterFailReason.UNKNOWN);
+ } else {
+ if (result.reason().isPresent()) {
+ c.onError(request, result.reason().get());
+ } else {
+ c.onSuccess(request);
+ }
+ }
+ });
+
+ };
+
+ executorService = newFixedThreadPool(numThreads,
+ groupedThreads(GROUP_THREAD_NAME, WORKER_PATTERN, log));
+ log.info("Started");
+ }
+
+ @Deactivate
+ public void deactivate() {
+ store.unsetDelegate(delegate);
+ eventDispatcher.removeSink(MeterEvent.class);
+ executorService.shutdown();
+ log.info("Stopped");
+ }
+
+ @Override
+ protected MeterProviderService createProviderService(MeterProvider provider) {
+ return new InternalMeterProviderService(provider);
+ }
+
+ @Override
+ public Meter submit(MeterRequest request) {
+
+ MeterId id = allocateMeterId(request.deviceId());
+
+ Meter.Builder mBuilder = DefaultMeter.builder()
+ .forDevice(request.deviceId())
+ .fromApp(request.appId())
+ .withBands(request.bands())
+ .withId(id)
+ .withUnit(request.unit());
+
+ if (request.isBurst()) {
+ mBuilder.burst();
+ }
+ DefaultMeter m = (DefaultMeter) mBuilder.build();
+ m.setState(MeterState.PENDING_ADD);
+ store.storeMeter(m).whenComplete((result, error) ->
+ onComplete.accept(request, result, error));
+ return m;
+ }
+
+ @Override
+ public void withdraw(MeterRequest request, MeterId meterId) {
+ Meter.Builder mBuilder = DefaultMeter.builder()
+ .forDevice(request.deviceId())
+ .fromApp(request.appId())
+ .withBands(request.bands())
+ .withId(meterId)
+ .withUnit(request.unit());
+
+ if (request.isBurst()) {
+ mBuilder.burst();
+ }
+
+ DefaultMeter m = (DefaultMeter) mBuilder.build();
+ m.setState(MeterState.PENDING_REMOVE);
+ store.deleteMeter(m).whenComplete((result, error) ->
+ onComplete.accept(request, result, error));
+ }
+
+ @Override
+ public Meter getMeter(DeviceId deviceId, MeterId id) {
+ MeterKey key = MeterKey.key(deviceId, id);
+ return store.getMeter(key);
+ }
+
+ @Override
+ public Collection<Meter> getMeters(DeviceId deviceId) {
+ return store.getAllMeters().stream().filter(m ->
+ m.deviceId().equals(deviceId)).collect(Collectors.toList());
+ }
+
+ @Override
+ public Collection<Meter> getAllMeters() {
+ return store.getAllMeters();
+ }
+
+ private long queryMeters(DeviceId device) {
+ DriverHandler handler = driverService.createHandler(device);
+ if (handler == null || !handler.hasBehaviour(MeterQuery.class)) {
+ return 0L;
+ }
+ MeterQuery query = handler.behaviour(MeterQuery.class);
+ return query.getMaxMeters();
+ }
+
+ private MeterId allocateMeterId(DeviceId deviceId) {
+ // We first query the store for any previously removed meterId that could
+ // be reused. Receiving a value (not null) already means that meters
+ // are available for the device.
+ MeterId meterid = store.firstReusableMeterId(deviceId);
+ if (meterid != null) {
+ return meterid;
+ }
+ // If there was no reusable MeterId we have to generate a new value
+ // with an upper limit in maxMeters.
+ long maxMeters = store.getMaxMeters(MeterFeaturesKey.key(deviceId));
+ if (maxMeters == 0L) {
+ // MeterFeatures couldn't be retrieved, trying with queryMeters.
+ // queryMeters is implemented in FullMetersAvailable behaviour.
+ maxMeters = queryMeters(deviceId);
+ }
+
+ if (maxMeters == 0L) {
+ throw new IllegalStateException("Meters not supported by device " + deviceId);
+ }
+
+ final long mmeters = maxMeters;
+ long id = meterIdCounters.compute(deviceId, (k, v) -> {
+ if (v == null) {
+ return allocateCounter(k);
+ }
+ if (v.get() >= mmeters) {
+ throw new IllegalStateException("Maximum number of meters " +
+ meterIdCounters.get(deviceId).get() +
+ " reached for device " + deviceId);
+ }
+ return v;
+ }).incrementAndGet();
+
+ return MeterId.meterId(id);
+ }
+
+ private AtomicCounter allocateCounter(DeviceId deviceId) {
+ return storageService.getAtomicCounter(String.format(METERCOUNTERIDENTIFIER, deviceId));
+ }
+
+ private class InternalMeterProviderService
+ extends AbstractProviderService<MeterProvider>
+ implements MeterProviderService {
+
+ /**
+ * Creates a provider service on behalf of the specified provider.
+ *
+ * @param provider provider to which this service is being issued
+ */
+ protected InternalMeterProviderService(MeterProvider provider) {
+ super(provider);
+ }
+
+ @Override
+ public void meterOperationFailed(MeterOperation operation,
+ MeterFailReason reason) {
+ store.failedMeter(operation, reason);
+ }
+
+ @Override
+ public void pushMeterMetrics(DeviceId deviceId, Collection<Meter> meterEntries) {
+ Collection<Meter> allMeters = store.getAllMeters(deviceId);
+
+ Map<MeterId, Meter> meterEntriesMap = meterEntries.stream()
+ .collect(Collectors.toMap(Meter::id, Meter -> Meter));
+
+ // Look for meters defined in onos and missing in the device (restore)
+ allMeters.stream().forEach(m -> {
+ if ((m.state().equals(MeterState.PENDING_ADD) ||
+ m.state().equals(MeterState.ADDED)) &&
+ !meterEntriesMap.containsKey(m.id())) {
+ // The meter is missing in the device. Reinstall!
+ log.debug("Adding meter missing in device {} {}", deviceId, m);
+ provider().performMeterOperation(deviceId,
+ new MeterOperation(m, MeterOperation.Type.ADD));
+ }
+ });
+
+ // Look for meters defined in the device and not in onos (remove)
+ meterEntriesMap.entrySet().stream()
+ .filter(md -> !allMeters.stream().anyMatch(m -> m.id().equals(md.getKey())))
+ .forEach(mio -> {
+ // The meter is missin in onos. Uninstall!
+ log.debug("Remove meter in device not in onos {} {}", deviceId, mio.getKey());
+ Meter meter = mio.getValue();
+ provider().performMeterOperation(deviceId,
+ new MeterOperation(meter, MeterOperation.Type.REMOVE));
+ });
+
+ meterEntries.stream()
+ .filter(m -> allMeters.stream()
+ .anyMatch(sm -> sm.deviceId().equals(deviceId) && sm.id().equals(m.id())))
+ .forEach(m -> store.updateMeterState(m));
+
+ allMeters.forEach(m -> {
+ if (m.state() == MeterState.PENDING_ADD) {
+ provider().performMeterOperation(m.deviceId(),
+ new MeterOperation(m,
+ MeterOperation.Type.MODIFY));
+ } else if (m.state() == MeterState.PENDING_REMOVE) {
+ store.deleteMeterNow(m);
+ }
+ });
+ }
+
+ @Override
+ public void pushMeterFeatures(DeviceId deviceId, MeterFeatures meterfeatures) {
+ store.storeMeterFeatures(meterfeatures);
+ }
+
+ @Override
+ public void deleteMeterFeatures(DeviceId deviceId) {
+ store.deleteMeterFeatures(deviceId);
+ }
+ }
+
+ private class InternalMeterStoreDelegate implements MeterStoreDelegate {
+
+ @Override
+ public void notify(MeterEvent event) {
+ DeviceId deviceId = event.subject().deviceId();
+ switch (event.type()) {
+ case METER_ADD_REQ:
+ executorService.execute(new MeterInstaller(deviceId, event.subject(),
+ MeterOperation.Type.ADD));
+ break;
+ case METER_REM_REQ:
+ executorService.execute(new MeterInstaller(deviceId, event.subject(),
+ MeterOperation.Type.REMOVE));
+ break;
+ case METER_ADDED:
+ log.info("Meter added {}", event.subject());
+ post(new MeterEvent(MeterEvent.Type.METER_ADDED, event.subject()));
+ break;
+ case METER_REMOVED:
+ log.info("Meter removed {}", event.subject());
+ post(new MeterEvent(MeterEvent.Type.METER_REMOVED, event.subject()));
+ break;
+ default:
+ log.warn("Unknown meter event {}", event.type());
+ }
+
+ }
+ }
+ /**
+ * Task that passes the meter down to the provider.
+ */
+ private class MeterInstaller implements Runnable {
+ private final DeviceId deviceId;
+ private final Meter meter;
+ private final MeterOperation.Type op;
+
+ public MeterInstaller(DeviceId deviceId, Meter meter, MeterOperation.Type op) {
+ this.deviceId = checkNotNull(deviceId);
+ this.meter = checkNotNull(meter);
+ this.op = checkNotNull(op);
+ }
+
+ @Override
+ public void run() {
+ MeterProvider p = getProvider(this.deviceId);
+ if (p == null) {
+ log.error("Unable to recover {}'s provider", deviceId);
+ return;
+ }
+ p.performMeterOperation(deviceId, new MeterOperation(meter, op));
+ }
+ }
+
+}