Switch to MD-SAL APIs
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / statistics / StatisticsManagerImpl.java
index 68cee5bde57fa715a7d50e9c2a8fdbfa3f8c29bb..c3645b7f3d1b82671c76d45839b12695feeed4d1 100644 (file)
@@ -5,47 +5,32 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.openflowplugin.impl.statistics;
 
-import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Preconditions;
-import com.google.common.base.Verify;
-import com.google.common.collect.Iterators;
-import com.google.common.util.concurrent.FutureCallback;
-import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
-import io.netty.util.HashedWheelTimer;
-import io.netty.util.Timeout;
-import io.netty.util.TimerTask;
-import java.util.Iterator;
-import java.util.Map;
-import java.util.Optional;
-import java.util.concurrent.CancellationException;
+import com.google.common.util.concurrent.ListeningExecutorService;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
-import java.util.concurrent.Future;
 import java.util.concurrent.Semaphore;
-import java.util.concurrent.TimeUnit;
 import javax.annotation.Nonnull;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
-import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
-import org.opendaylight.openflowplugin.api.openflow.OFPContext;
+import org.opendaylight.mdsal.binding.api.RpcProviderService;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
-import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
-import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
-import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
+import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
+import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProviderFactory;
 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.OpenflowProviderConfig;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutputBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
+import org.opendaylight.yangtools.concepts.ObjectRegistration;
 import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
@@ -56,260 +41,98 @@ public class StatisticsManagerImpl implements StatisticsManager, StatisticsManag
 
     private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImpl.class);
 
-    private static final long DEFAULT_STATS_TIMEOUT_SEC = 50L;
-    private final ConvertorExecutor convertorExecutor;
-
-    private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
-    private DeviceTerminationPhaseHandler deviceTerminPhaseHandler;
-
+    private final OpenflowProviderConfig config;
+    private final ConvertorExecutor converterExecutor;
     private final ConcurrentMap<DeviceInfo, StatisticsContext> contexts = new ConcurrentHashMap<>();
-
-    private static final long basicTimerDelay = 3000;
-    private static long currentTimerDelay = basicTimerDelay;
-    private static final long maximumTimerDelay = 900000; //wait max 15 minutes for next statistics
-
-    private StatisticsWorkMode workMode = StatisticsWorkMode.COLLECTALL;
     private final Semaphore workModeGuard = new Semaphore(1, true);
-    private boolean isStatisticsPollingEnabled;
-    private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> controlServiceRegistration;
-
-    private final HashedWheelTimer hashedWheelTimer;
-
-    @Override
-    public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
-        deviceInitPhaseHandler = handler;
-    }
-
-    public StatisticsManagerImpl(final RpcProviderRegistry rpcProviderRegistry,
-                                 final boolean isStatisticsPollingEnabled,
-                                 final HashedWheelTimer hashedWheelTimer,
-                                 final ConvertorExecutor convertorExecutor) {
-        Preconditions.checkArgument(rpcProviderRegistry != null);
-       this.convertorExecutor = convertorExecutor;
-        this.controlServiceRegistration = Preconditions.checkNotNull(rpcProviderRegistry.addRpcImplementation(
-                StatisticsManagerControlService.class, this));
-        this.isStatisticsPollingEnabled = isStatisticsPollingEnabled;
-        this.hashedWheelTimer = hashedWheelTimer;
+    private final ObjectRegistration<StatisticsManagerControlService> controlServiceRegistration;
+    private final ListeningExecutorService executorService;
+    private final StatisticsWorkMode workMode = StatisticsWorkMode.COLLECTALL;
+    private boolean isStatisticsFullyDisabled;
+
+    public StatisticsManagerImpl(@Nonnull final OpenflowProviderConfig config,
+                                 @Nonnull final RpcProviderService rpcProviderRegistry,
+                                 final ConvertorExecutor convertorExecutor,
+                                 @Nonnull final ListeningExecutorService executorService) {
+        this.config = config;
+        this.converterExecutor = convertorExecutor;
+        this.controlServiceRegistration = Preconditions.checkNotNull(rpcProviderRegistry
+                .registerRpcImplementation(StatisticsManagerControlService.class, this));
+        this.executorService = executorService;
     }
 
     @Override
-    public void onDeviceContextLevelUp(final DeviceInfo deviceInfo, final LifecycleService lifecycleService) throws Exception {
-
-        final StatisticsContext statisticsContext = new StatisticsContextImpl(deviceInfo, isStatisticsPollingEnabled, lifecycleService, convertorExecutor, this);
-        Verify.verify(contexts.putIfAbsent(deviceInfo, statisticsContext) == null, "StatisticsCtx still not closed for Node {}", deviceInfo.getNodeId());
-        lifecycleService.setStatContext(statisticsContext);
-        deviceInitPhaseHandler.onDeviceContextLevelUp(deviceInfo, lifecycleService);
-    }
-
-    @VisibleForTesting
-    void pollStatistics(final DeviceState deviceState,
-                        final StatisticsContext statisticsContext,
-                        final TimeCounter timeCounter,
-                        final DeviceInfo deviceInfo) {
-
-        if (!statisticsContext.isSchedulingEnabled()) {
-            LOG.debug("Disabled statistics scheduling for device: {}", deviceInfo.getNodeId().getValue());
-            return;
-        }
-
-        LOG.debug("POLLING ALL STATISTICS for device: {}", deviceInfo.getNodeId());
-        timeCounter.markStart();
-        final ListenableFuture<Boolean> deviceStatisticsCollectionFuture = statisticsContext.gatherDynamicData();
-        Futures.addCallback(deviceStatisticsCollectionFuture, new FutureCallback<Boolean>() {
-            @Override
-            public void onSuccess(final Boolean o) {
-                timeCounter.addTimeMark();
-                calculateTimerDelay(timeCounter);
-                scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
-            }
-
-            @Override
-            public void onFailure(@Nonnull final Throwable throwable) {
-                timeCounter.addTimeMark();
-                LOG.warn("Statistics gathering for single node was not successful: {}", throwable.getMessage());
-                LOG.trace("Statistics gathering for single node was not successful.. ", throwable);
-                calculateTimerDelay(timeCounter);
-                if (throwable instanceof CancellationException) {
-                    /* This often happens when something wrong with akka or DS, so closing connection will help to restart device **/
-                    contexts.get(deviceInfo).getLifecycleService().closeConnection();
-                } else {
-                    scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
-                }
-            }
-        });
-
-        final long averageTime = TimeUnit.MILLISECONDS.toSeconds(timeCounter.getAverageTimeBetweenMarks());
-        final long STATS_TIMEOUT_SEC = averageTime > 0 ? 3 * averageTime : DEFAULT_STATS_TIMEOUT_SEC;
-        final TimerTask timerTask = timeout -> {
-            if (!deviceStatisticsCollectionFuture.isDone()) {
-                LOG.info("Statistics collection for node {} still in progress even after {} secs", deviceInfo.getNodeId(), STATS_TIMEOUT_SEC);
-                deviceStatisticsCollectionFuture.cancel(true);
-            }
-        };
-
-        hashedWheelTimer.newTimeout(timerTask, STATS_TIMEOUT_SEC, TimeUnit.SECONDS);
-    }
-
-    private void scheduleNextPolling(final DeviceState deviceState,
-                                     final DeviceInfo deviceInfo,
-                                     final StatisticsContext statisticsContext,
-                                     final TimeCounter timeCounter) {
-        LOG.debug("SCHEDULING NEXT STATISTICS POLLING for device: {}", deviceInfo.getNodeId());
-        if (!isStatisticsPollingEnabled) {
-            final Timeout pollTimeout = hashedWheelTimer.newTimeout(
-                    timeout -> pollStatistics(
-                            deviceState,
-                            statisticsContext,
-                            timeCounter,
-                            deviceInfo),
-                    currentTimerDelay,
-                    TimeUnit.MILLISECONDS);
-            statisticsContext.setPollTimeout(pollTimeout);
-        }
-    }
-
-    @VisibleForTesting
-    void calculateTimerDelay(final TimeCounter timeCounter) {
-        final long averageStatisticsGatheringTime = timeCounter.getAverageTimeBetweenMarks();
-        if (averageStatisticsGatheringTime > currentTimerDelay) {
-            currentTimerDelay *= 2;
-            if (currentTimerDelay > maximumTimerDelay) {
-                currentTimerDelay = maximumTimerDelay;
-            }
-        } else {
-            if (currentTimerDelay > basicTimerDelay) {
-                currentTimerDelay /= 2;
-            } else {
-                currentTimerDelay = basicTimerDelay;
-            }
-        }
-    }
-
-    @VisibleForTesting
-    static long getCurrentTimerDelay() {
-        return currentTimerDelay;
+    public ListenableFuture<RpcResult<GetStatisticsWorkModeOutput>> getStatisticsWorkMode(
+            GetStatisticsWorkModeInput input) {
+        return RpcResultBuilder.success(new GetStatisticsWorkModeOutputBuilder()
+                .setMode(workMode)
+                .build()).buildFuture();
     }
 
     @Override
-    public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
-        final StatisticsContext statisticsContext = contexts.remove(deviceInfo);
-        if (null != statisticsContext) {
-            LOG.trace("Removing device context from stack. No more statistics gathering for device: {}", deviceInfo.getNodeId());
-            statisticsContext.close();
-        }
-        deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
-    }
-
-    @Override
-    public Future<RpcResult<GetStatisticsWorkModeOutput>> getStatisticsWorkMode() {
-        final GetStatisticsWorkModeOutputBuilder smModeOutputBld = new GetStatisticsWorkModeOutputBuilder();
-        smModeOutputBld.setMode(workMode);
-        return RpcResultBuilder.success(smModeOutputBld.build()).buildFuture();
-    }
-
-    @Override
-    public Future<RpcResult<Void>> changeStatisticsWorkMode(ChangeStatisticsWorkModeInput input) {
-        final Future<RpcResult<Void>> result;
-        // acquire exclusive access
+    public ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> changeStatisticsWorkMode(
+            ChangeStatisticsWorkModeInput input) {
         if (workModeGuard.tryAcquire()) {
             final StatisticsWorkMode targetWorkMode = input.getMode();
-            if (!workMode.equals(targetWorkMode)) {
-                isStatisticsPollingEnabled = StatisticsWorkMode.FULLYDISABLED.equals(targetWorkMode);
-                // iterate through stats-ctx: propagate mode
-                for (Map.Entry<DeviceInfo, StatisticsContext> entry : contexts.entrySet()) {
-                    final DeviceInfo deviceInfo = entry.getKey();
-                    final StatisticsContext statisticsContext = entry.getValue();
-                    final DeviceContext deviceContext = statisticsContext.getLifecycleService().getDeviceContext();
-                    switch (targetWorkMode) {
-                        case COLLECTALL:
-                            scheduleNextPolling(deviceContext.getDeviceState(), deviceInfo, statisticsContext, new TimeCounter());
-                            for (final ItemLifeCycleSource lifeCycleSource : deviceContext.getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
-                                lifeCycleSource.setItemLifecycleListener(null);
-                            }
-                            break;
-                        case FULLYDISABLED:
-                            final Optional<Timeout> pollTimeout = statisticsContext.getPollTimeout();
-                            if (pollTimeout.isPresent()) {
-                                pollTimeout.get().cancel();
-                            }
-                            for (final ItemLifeCycleSource lifeCycleSource : deviceContext.getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
-                                lifeCycleSource.setItemLifecycleListener(statisticsContext.getItemLifeCycleListener());
-                            }
-                            break;
-                        default:
-                            LOG.warn("Statistics work mode not supported: {}", targetWorkMode);
-                    }
+            isStatisticsFullyDisabled = StatisticsWorkMode.FULLYDISABLED.equals(targetWorkMode);
+
+            contexts.values().forEach(context -> {
+                switch (targetWorkMode) {
+                    case COLLECTALL:
+                        context.enableGathering();
+                        break;
+                    case FULLYDISABLED:
+                        context.disableGathering();
+                        break;
+                    default:
+                        LOG.warn("Statistics work mode not supported: {}", targetWorkMode);
                 }
-                workMode = targetWorkMode;
-            }
+            });
+
             workModeGuard.release();
-            result = RpcResultBuilder.<Void>success().buildFuture();
-        } else {
-            result = RpcResultBuilder.<Void>failed()
-                    .withError(RpcError.ErrorType.APPLICATION, "mode change already in progress")
-                    .buildFuture();
+            return RpcResultBuilder.<ChangeStatisticsWorkModeOutput>success().buildFuture();
         }
-        return result;
+
+        return RpcResultBuilder.<ChangeStatisticsWorkModeOutput>failed()
+                .withError(RpcError.ErrorType.APPLICATION,
+                        "Statistics work mode change is already in progress")
+                .buildFuture();
     }
 
     @Override
-    public void startScheduling(final DeviceInfo deviceInfo) {
-        if (isStatisticsPollingEnabled) {
-            LOG.info("Statistics are shut down for device: {}", deviceInfo.getNodeId());
-            return;
-        }
-
-        final StatisticsContext statisticsContext = contexts.get(deviceInfo);
-
-        if (statisticsContext == null) {
-            LOG.warn("Statistics context not found for device: {}", deviceInfo.getNodeId());
-            return;
-        }
-
-        if (statisticsContext.isSchedulingEnabled()) {
-            LOG.debug("Statistics scheduling is already enabled for device: {}", deviceInfo.getNodeId());
-            return;
-        }
-
-        LOG.info("Scheduling statistics poll for device: {}", deviceInfo.getNodeId());
-
-        statisticsContext.setSchedulingEnabled(true);
-        final DeviceState deviceState = contexts.get(deviceInfo).getLifecycleService().getDeviceContext().getDeviceState();
-        scheduleNextPolling(deviceState, deviceInfo, statisticsContext, new TimeCounter());
+    public StatisticsContext createContext(@Nonnull final DeviceContext deviceContext,
+                                           final boolean useReconciliationFramework) {
+        final MultipartWriterProvider statisticsWriterProvider = MultipartWriterProviderFactory
+                .createDefaultProvider(deviceContext);
+
+        final StatisticsContext statisticsContext = new StatisticsContextImpl<>(
+                deviceContext,
+                converterExecutor,
+                statisticsWriterProvider,
+                executorService,
+                config,
+                !isStatisticsFullyDisabled && config.isIsStatisticsPollingOn(),
+                useReconciliationFramework);
+
+        contexts.put(deviceContext.getDeviceInfo(), statisticsContext);
+        return statisticsContext;
     }
 
     @Override
-    public void stopScheduling(final DeviceInfo deviceInfo) {
-        LOG.debug("Stopping statistics scheduling for device: {}", deviceInfo.getNodeId());
-        final StatisticsContext statisticsContext = contexts.get(deviceInfo);
-
-        if (statisticsContext == null) {
-            LOG.warn("Statistics context not found for device: {}", deviceInfo.getNodeId());
-            return;
-        }
-
-        statisticsContext.setSchedulingEnabled(false);
+    public void onDeviceRemoved(final DeviceInfo deviceInfo) {
+        contexts.remove(deviceInfo);
+        LOG.debug("Statistics context removed for node {}", deviceInfo);
     }
 
     @Override
     public void close() {
-        if (controlServiceRegistration != null) {
-            controlServiceRegistration.close();
-            controlServiceRegistration = null;
-        }
-        for (final Iterator<StatisticsContext> iterator = Iterators.consumingIterator(contexts.values().iterator());
-                iterator.hasNext();) {
-            iterator.next().close();
-        }
-    }
+        isStatisticsFullyDisabled = true;
+        controlServiceRegistration.close();
 
-    @Override
-    public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
-        this.deviceTerminPhaseHandler = handler;
-    }
+        for (StatisticsContext context : contexts.values()) {
+            context.close();
+        }
 
-    @Override
-    public <T extends OFPContext> T gainContext(DeviceInfo deviceInfo) {
-        return (T) contexts.get(deviceInfo);
+        contexts.clear();
     }
 }