* 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 java.util.Iterator;
-import java.util.Map;
-import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
-import java.util.concurrent.Future;
+import java.util.concurrent.Executor;
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.eclipse.jdt.annotation.NonNull;
+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.ChangeStatisticsWorkMode;
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.GetStatisticsWorkMode;
+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.yang.common.RpcError;
+import org.opendaylight.yangtools.concepts.Registration;
+import org.opendaylight.yangtools.yang.common.ErrorType;
import org.opendaylight.yangtools.yang.common.RpcResult;
import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import io.netty.util.HashedWheelTimer;
-import io.netty.util.Timeout;
-import io.netty.util.TimerTask;
-
-public class StatisticsManagerImpl implements StatisticsManager, StatisticsManagerControlService {
+public final class StatisticsManagerImpl implements StatisticsManager {
private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImpl.class);
- private static final long DEFAULT_STATS_TIMEOUT_SEC = 50L;
- private final ConvertorExecutor converterExecutor;
-
- private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
- private DeviceTerminationPhaseHandler deviceTerminationPhaseHandler;
-
- private final ConcurrentMap<DeviceInfo, StatisticsContext> contexts = new ConcurrentHashMap<>();
-
- private static long basicTimerDelay;
- private static long currentTimerDelay;
- private static long maximumTimerDelay; //wait time for next statistics
+ @VisibleForTesting
+ final ConcurrentMap<DeviceInfo, StatisticsContext> contexts = new ConcurrentHashMap<>();
- private StatisticsWorkMode workMode = StatisticsWorkMode.COLLECTALL;
+ private final OpenflowProviderConfig config;
+ private final ConvertorExecutor converterExecutor;
+ private final Executor executor;
private final Semaphore workModeGuard = new Semaphore(1, true);
- private boolean isStatisticsPollingOn;
- private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> controlServiceRegistration;
+ private final Registration controlServiceRegistration;
+ private final StatisticsWorkMode workMode = StatisticsWorkMode.COLLECTALL;
+ private boolean isStatisticsFullyDisabled;
- private final HashedWheelTimer hashedWheelTimer;
-
- @Override
- public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
- deviceInitPhaseHandler = handler;
- }
-
- public StatisticsManagerImpl(final RpcProviderRegistry rpcProviderRegistry,
- final boolean isStatisticsPollingOn,
- final HashedWheelTimer hashedWheelTimer,
+ public StatisticsManagerImpl(@NonNull final OpenflowProviderConfig config,
+ @NonNull final RpcProviderService rpcProviderRegistry,
final ConvertorExecutor convertorExecutor,
- final long basicTimerDelay,
- final long maximumTimerDelay) {
- Preconditions.checkArgument(rpcProviderRegistry != null);
- this.converterExecutor = convertorExecutor;
- this.controlServiceRegistration = Preconditions.checkNotNull(
- rpcProviderRegistry.addRpcImplementation(StatisticsManagerControlService.class, this)
- );
- this.isStatisticsPollingOn = isStatisticsPollingOn;
- this.basicTimerDelay = basicTimerDelay;
- this.currentTimerDelay = basicTimerDelay;
- this.maximumTimerDelay = maximumTimerDelay;
- this.hashedWheelTimer = hashedWheelTimer;
- }
-
- @Override
- public void onDeviceContextLevelUp(final DeviceInfo deviceInfo,
- final LifecycleService lifecycleService) throws Exception {
-
- final StatisticsContext statisticsContext =
- new StatisticsContextImpl(
- deviceInfo,
- isStatisticsPollingOn,
- lifecycleService,
- converterExecutor,
- this);
-
- Verify.verify(
- contexts.putIfAbsent(deviceInfo, statisticsContext) == null,
- "StatisticsCtx still not closed for Node {}", deviceInfo.getLOGValue()
- );
-
- lifecycleService.setStatContext(statisticsContext);
- lifecycleService.registerDeviceRemovedHandler(this);
- deviceInitPhaseHandler.onDeviceContextLevelUp(deviceInfo, lifecycleService);
+ @NonNull final Executor executor) {
+ this.config = config;
+ this.executor = executor;
+ converterExecutor = convertorExecutor;
+ controlServiceRegistration = rpcProviderRegistry.registerRpcImplementations(
+ (GetStatisticsWorkMode) this::getStatisticsWorkMode,
+ (ChangeStatisticsWorkMode) this::changeStatisticsWorkMode);
}
@VisibleForTesting
- void pollStatistics(final DeviceState deviceState,
- final StatisticsContext statisticsContext,
- final TimeCounter timeCounter,
- final DeviceInfo deviceInfo) {
-
- if (!statisticsContext.isSchedulingEnabled()) {
- if (LOG.isDebugEnabled()) {
- LOG.debug("Disabled statistics scheduling for device: {}", deviceInfo.getNodeId().getValue());
- }
- return;
- }
-
- if (LOG.isDebugEnabled()) {
- 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: {}", deviceInfo.getLOGValue(),
- throwable.getMessage());
- if (LOG.isTraceEnabled()) {
- LOG.trace("Gathering for node {} failure: ", deviceInfo.getLOGValue(), throwable);
- }
- calculateTimerDelay(timeCounter);
- if (throwable instanceof IllegalStateException) {
- stopScheduling(deviceInfo);
- } else {
- scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
- }
- }
- });
-
- final long averageTime = TimeUnit.MILLISECONDS.toSeconds(timeCounter.getAverageTimeBetweenMarks());
- final long statsTimeoutSec = 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.getLOGValue(), statsTimeoutSec);
- deviceStatisticsCollectionFuture.cancel(true);
- }
- };
-
- hashedWheelTimer.newTimeout(timerTask, statsTimeoutSec, TimeUnit.SECONDS);
- }
-
- private void scheduleNextPolling(final DeviceState deviceState,
- final DeviceInfo deviceInfo,
- final StatisticsContext statisticsContext,
- final TimeCounter timeCounter) {
- if (LOG.isDebugEnabled()) {
- LOG.debug("SCHEDULING NEXT STATISTICS POLLING for device: {}", deviceInfo.getNodeId());
- }
- if (isStatisticsPollingOn) {
- final Timeout pollTimeout = hashedWheelTimer.newTimeout(
- timeout -> pollStatistics(
- deviceState,
- statisticsContext,
- timeCounter,
- deviceInfo),
- currentTimerDelay,
- TimeUnit.MILLISECONDS);
- statisticsContext.setPollTimeout(pollTimeout);
- }
+ ListenableFuture<RpcResult<GetStatisticsWorkModeOutput>> getStatisticsWorkMode(
+ final GetStatisticsWorkModeInput input) {
+ return RpcResultBuilder.success(new GetStatisticsWorkModeOutputBuilder()
+ .setMode(workMode)
+ .build()).buildFuture();
}
@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;
- }
-
- @Override
- public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
- Optional.ofNullable(contexts.get(deviceInfo)).ifPresent(OFPContext::close);
- deviceTerminationPhaseHandler.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
+ ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> changeStatisticsWorkMode(
+ final ChangeStatisticsWorkModeInput input) {
if (workModeGuard.tryAcquire()) {
final StatisticsWorkMode targetWorkMode = input.getMode();
- if (!workMode.equals(targetWorkMode)) {
- isStatisticsPollingOn = !(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.gainDeviceContext();
- switch (targetWorkMode) {
- case COLLECTALL:
- scheduleNextPolling(statisticsContext.gainDeviceState(), 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(ErrorType.APPLICATION, "Statistics work mode change is already in progress")
+ .buildFuture();
}
@Override
- public void startScheduling(final DeviceInfo deviceInfo) {
- if (!isStatisticsPollingOn) {
- LOG.info("Statistics are shutdown for device: {}", deviceInfo.getNodeId());
- return;
- }
-
- final StatisticsContext statisticsContext = contexts.get(deviceInfo);
+ public StatisticsContext createContext(@NonNull final DeviceContext deviceContext,
+ final boolean useReconciliationFramework) {
+ final MultipartWriterProvider statisticsWriterProvider = MultipartWriterProviderFactory
+ .createDefaultProvider(deviceContext);
- 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;
- }
+ final StatisticsContext statisticsContext = new StatisticsContextImpl<>(
+ deviceContext,
+ converterExecutor,
+ statisticsWriterProvider,
+ executor,
+ config,
+ !isStatisticsFullyDisabled && config.getIsStatisticsPollingOn(),
+ useReconciliationFramework);
- LOG.info("Scheduling statistics poll for device: {}", deviceInfo.getNodeId());
-
- statisticsContext.setSchedulingEnabled(true);
- scheduleNextPolling(
- statisticsContext.gainDeviceState(),
- deviceInfo,
- statisticsContext,
- new TimeCounter()
- );
+ contexts.put(deviceContext.getDeviceInfo(), statisticsContext);
+ return statisticsContext;
}
@Override
- public void stopScheduling(final DeviceInfo deviceInfo) {
- if (LOG.isDebugEnabled()) {
- 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;
- }
+ isStatisticsFullyDisabled = true;
+ controlServiceRegistration.close();
- for (final Iterator<StatisticsContext> iterator = Iterators.consumingIterator(contexts.values().iterator());
- iterator.hasNext();) {
- iterator.next().close();
+ for (StatisticsContext context : contexts.values()) {
+ context.close();
}
- }
-
- @Override
- public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
- this.deviceTerminationPhaseHandler = handler;
- }
-
- @Override
- public void setIsStatisticsPollingOn(boolean isStatisticsPollingOn){
- this.isStatisticsPollingOn = isStatisticsPollingOn;
- }
-
- public void onDeviceRemoved(DeviceInfo deviceInfo) {
- contexts.remove(deviceInfo);
- LOG.debug("Statistics context removed for node {}", deviceInfo.getLOGValue());
- }
- @Override
- public void setBasicTimerDelay(final long basicTimerDelay) {
- this.basicTimerDelay = basicTimerDelay;
- }
-
- @Override
- public void setMaximumTimerDelay(final long maximumTimerDelay) {
- this.maximumTimerDelay = maximumTimerDelay;
+ contexts.clear();
}
}