openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/statistics/StatisticsManagerImpl.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.openflowplugin.impl.statistics;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.base.Verify;
  14 import com.google.common.collect.Iterators;
  15 import com.google.common.util.concurrent.FutureCallback;
  16 import com.google.common.util.concurrent.Futures;
  17 import com.google.common.util.concurrent.ListenableFuture;
  18 import io.netty.util.HashedWheelTimer;
  19 import io.netty.util.Timeout;
  20 import io.netty.util.TimerTask;
  21 import java.util.Iterator;
  22 import java.util.Map;
  23 import java.util.Optional;
  24 import java.util.concurrent.CancellationException;
  25 import java.util.concurrent.ConcurrentHashMap;
  26 import java.util.concurrent.ConcurrentMap;
  27 import java.util.concurrent.Future;
  28 import java.util.concurrent.Semaphore;
  29 import java.util.concurrent.TimeUnit;
  30 import javax.annotation.Nonnull;
  31 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  32 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  33 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  34 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  35 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  36 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  37 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
  38 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
  39 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
  40 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  41 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
  42 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInput;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutputBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
  48 import org.opendaylight.yangtools.yang.common.RpcError;
  49 import org.opendaylight.yangtools.yang.common.RpcResult;
  50 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 public class StatisticsManagerImpl implements StatisticsManager, StatisticsManagerControlService {
  55
  56     private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImpl.class);
  57
  58     private static final long DEFAULT_STATS_TIMEOUT_SEC = 50L;
  59     private final ConvertorExecutor convertorExecutor;
  60
  61     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
  62     private DeviceTerminationPhaseHandler deviceTerminPhaseHandler;
  63
  64     private final ConcurrentMap<DeviceInfo, StatisticsContext> contexts = new ConcurrentHashMap<>();
  65
  66     private static final long basicTimerDelay = 3000;
  67     private static long currentTimerDelay = basicTimerDelay;
  68     private static final long maximumTimerDelay = 900000; //wait max 15 minutes for next statistics
  69
  70     private StatisticsWorkMode workMode = StatisticsWorkMode.COLLECTALL;
  71     private final Semaphore workModeGuard = new Semaphore(1, true);
  72     private boolean isStatisticsPollingEnabled;
  73     private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> controlServiceRegistration;
  74
  75     private final HashedWheelTimer hashedWheelTimer;
  76
  77     @Override
  78     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
  79         deviceInitPhaseHandler = handler;
  80     }
  81
  82     public StatisticsManagerImpl(final RpcProviderRegistry rpcProviderRegistry,
  83                                  final boolean isStatisticsPollingEnabled,
  84                                  final HashedWheelTimer hashedWheelTimer,
  85                                  final ConvertorExecutor convertorExecutor) {
  86         Preconditions.checkArgument(rpcProviderRegistry != null);
  87         this.convertorExecutor = convertorExecutor;
  88         this.controlServiceRegistration = Preconditions.checkNotNull(rpcProviderRegistry.addRpcImplementation(
  89                 StatisticsManagerControlService.class, this));
  90         this.isStatisticsPollingEnabled = isStatisticsPollingEnabled;
  91         this.hashedWheelTimer = hashedWheelTimer;
  92     }
  93
  94     @Override
  95     public void onDeviceContextLevelUp(final DeviceInfo deviceInfo, final LifecycleService lifecycleService) throws Exception {
  96
  97         final StatisticsContext statisticsContext = new StatisticsContextImpl(deviceInfo, isStatisticsPollingEnabled, lifecycleService, convertorExecutor, this);
  98         Verify.verify(contexts.putIfAbsent(deviceInfo, statisticsContext) == null, "StatisticsCtx still not closed for Node {}", deviceInfo.getLOGValue());
  99         lifecycleService.setStatContext(statisticsContext);
 100         deviceInitPhaseHandler.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 101     }
 102
 103     @VisibleForTesting
 104     void pollStatistics(final DeviceState deviceState,
 105                         final StatisticsContext statisticsContext,
 106                         final TimeCounter timeCounter,
 107                         final DeviceInfo deviceInfo) {
 108
 109         if (!statisticsContext.isSchedulingEnabled()) {
 110             LOG.debug("Disabled statistics scheduling for device: {}", deviceInfo.getNodeId().getValue());
 111             return;
 112         }
 113
 114         LOG.debug("POLLING ALL STATISTICS for device: {}", deviceInfo.getNodeId());
 115         timeCounter.markStart();
 116         final ListenableFuture<Boolean> deviceStatisticsCollectionFuture = statisticsContext.gatherDynamicData();
 117         Futures.addCallback(deviceStatisticsCollectionFuture, new FutureCallback<Boolean>() {
 118             @Override
 119             public void onSuccess(final Boolean o) {
 120                 timeCounter.addTimeMark();
 121                 calculateTimerDelay(timeCounter);
 122                 scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 123             }
 124
 125             @Override
 126             public void onFailure(@Nonnull final Throwable throwable) {
 127                 timeCounter.addTimeMark();
 128                 LOG.warn("Statistics gathering for single node was not successful: {}", throwable.getMessage());
 129                 LOG.trace("Statistics gathering for single node was not successful.. ", throwable);
 130                 calculateTimerDelay(timeCounter);
 131                 if (throwable instanceof CancellationException) {
 132                     /* This often happens when something wrong with akka or DS, so closing connection will help to restart device **/
 133                     contexts.get(deviceInfo).getLifecycleService().closeConnection();
 134                 } else {
 135                     scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 136                 }
 137             }
 138         });
 139
 140         final long averageTime = TimeUnit.MILLISECONDS.toSeconds(timeCounter.getAverageTimeBetweenMarks());
 141         final long STATS_TIMEOUT_SEC = averageTime > 0 ? 3 * averageTime : DEFAULT_STATS_TIMEOUT_SEC;
 142         final TimerTask timerTask = timeout -> {
 143             if (!deviceStatisticsCollectionFuture.isDone()) {
 144                 LOG.info("Statistics collection for node {} still in progress even after {} secs", deviceInfo.getLOGValue(), STATS_TIMEOUT_SEC);
 145                 deviceStatisticsCollectionFuture.cancel(true);
 146             }
 147         };
 148
 149         hashedWheelTimer.newTimeout(timerTask, STATS_TIMEOUT_SEC, TimeUnit.SECONDS);
 150     }
 151
 152     private void scheduleNextPolling(final DeviceState deviceState,
 153                                      final DeviceInfo deviceInfo,
 154                                      final StatisticsContext statisticsContext,
 155                                      final TimeCounter timeCounter) {
 156         LOG.debug("SCHEDULING NEXT STATISTICS POLLING for device: {}", deviceInfo.getNodeId());
 157         if (!isStatisticsPollingEnabled) {
 158             final Timeout pollTimeout = hashedWheelTimer.newTimeout(
 159                     timeout -> pollStatistics(
 160                             deviceState,
 161                             statisticsContext,
 162                             timeCounter,
 163                             deviceInfo),
 164                     currentTimerDelay,
 165                     TimeUnit.MILLISECONDS);
 166             statisticsContext.setPollTimeout(pollTimeout);
 167         }
 168     }
 169
 170     @VisibleForTesting
 171     void calculateTimerDelay(final TimeCounter timeCounter) {
 172         final long averageStatisticsGatheringTime = timeCounter.getAverageTimeBetweenMarks();
 173         if (averageStatisticsGatheringTime > currentTimerDelay) {
 174             currentTimerDelay *= 2;
 175             if (currentTimerDelay > maximumTimerDelay) {
 176                 currentTimerDelay = maximumTimerDelay;
 177             }
 178         } else {
 179             if (currentTimerDelay > basicTimerDelay) {
 180                 currentTimerDelay /= 2;
 181             } else {
 182                 currentTimerDelay = basicTimerDelay;
 183             }
 184         }
 185     }
 186
 187     @VisibleForTesting
 188     static long getCurrentTimerDelay() {
 189         return currentTimerDelay;
 190     }
 191
 192     @Override
 193     public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
 194         final StatisticsContext statisticsContext = contexts.remove(deviceInfo);
 195         if (null != statisticsContext) {
 196             LOG.debug("Removing device context from stack. No more statistics gathering for device: {}", deviceInfo.getLOGValue());
 197             statisticsContext.close();
 198         }
 199         deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
 200     }
 201
 202     @Override
 203     public Future<RpcResult<GetStatisticsWorkModeOutput>> getStatisticsWorkMode() {
 204         final GetStatisticsWorkModeOutputBuilder smModeOutputBld = new GetStatisticsWorkModeOutputBuilder();
 205         smModeOutputBld.setMode(workMode);
 206         return RpcResultBuilder.success(smModeOutputBld.build()).buildFuture();
 207     }
 208
 209     @Override
 210     public Future<RpcResult<Void>> changeStatisticsWorkMode(ChangeStatisticsWorkModeInput input) {
 211         final Future<RpcResult<Void>> result;
 212         // acquire exclusive access
 213         if (workModeGuard.tryAcquire()) {
 214             final StatisticsWorkMode targetWorkMode = input.getMode();
 215             if (!workMode.equals(targetWorkMode)) {
 216                 isStatisticsPollingEnabled = StatisticsWorkMode.FULLYDISABLED.equals(targetWorkMode);
 217                 // iterate through stats-ctx: propagate mode
 218                 for (Map.Entry<DeviceInfo, StatisticsContext> entry : contexts.entrySet()) {
 219                     final DeviceInfo deviceInfo = entry.getKey();
 220                     final StatisticsContext statisticsContext = entry.getValue();
 221                     final DeviceContext deviceContext = statisticsContext.getLifecycleService().getDeviceContext();
 222                     switch (targetWorkMode) {
 223                         case COLLECTALL:
 224                             scheduleNextPolling(deviceContext.getDeviceState(), deviceInfo, statisticsContext, new TimeCounter());
 225                             for (final ItemLifeCycleSource lifeCycleSource : deviceContext.getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
 226                                 lifeCycleSource.setItemLifecycleListener(null);
 227                             }
 228                             break;
 229                         case FULLYDISABLED:
 230                             final Optional<Timeout> pollTimeout = statisticsContext.getPollTimeout();
 231                             if (pollTimeout.isPresent()) {
 232                                 pollTimeout.get().cancel();
 233                             }
 234                             for (final ItemLifeCycleSource lifeCycleSource : deviceContext.getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
 235                                 lifeCycleSource.setItemLifecycleListener(statisticsContext.getItemLifeCycleListener());
 236                             }
 237                             break;
 238                         default:
 239                             LOG.warn("Statistics work mode not supported: {}", targetWorkMode);
 240                     }
 241                 }
 242                 workMode = targetWorkMode;
 243             }
 244             workModeGuard.release();
 245             result = RpcResultBuilder.<Void>success().buildFuture();
 246         } else {
 247             result = RpcResultBuilder.<Void>failed()
 248                     .withError(RpcError.ErrorType.APPLICATION, "mode change already in progress")
 249                     .buildFuture();
 250         }
 251         return result;
 252     }
 253
 254     @Override
 255     public void startScheduling(final DeviceInfo deviceInfo) {
 256         if (isStatisticsPollingEnabled) {
 257             LOG.info("Statistics are shut down for device: {}", deviceInfo.getNodeId());
 258             return;
 259         }
 260
 261         final StatisticsContext statisticsContext = contexts.get(deviceInfo);
 262
 263         if (statisticsContext == null) {
 264             LOG.warn("Statistics context not found for device: {}", deviceInfo.getNodeId());
 265             return;
 266         }
 267
 268         if (statisticsContext.isSchedulingEnabled()) {
 269             LOG.debug("Statistics scheduling is already enabled for device: {}", deviceInfo.getNodeId());
 270             return;
 271         }
 272
 273         LOG.info("Scheduling statistics poll for device: {}", deviceInfo.getNodeId());
 274
 275         statisticsContext.setSchedulingEnabled(true);
 276         final DeviceState deviceState = contexts.get(deviceInfo).getLifecycleService().getDeviceContext().getDeviceState();
 277         scheduleNextPolling(deviceState, deviceInfo, statisticsContext, new TimeCounter());
 278     }
 279
 280     @Override
 281     public void stopScheduling(final DeviceInfo deviceInfo) {
 282         LOG.debug("Stopping statistics scheduling for device: {}", deviceInfo.getNodeId());
 283         final StatisticsContext statisticsContext = contexts.get(deviceInfo);
 284
 285         if (statisticsContext == null) {
 286             LOG.warn("Statistics context not found for device: {}", deviceInfo.getNodeId());
 287             return;
 288         }
 289
 290         statisticsContext.setSchedulingEnabled(false);
 291     }
 292
 293     @Override
 294     public void close() {
 295         if (controlServiceRegistration != null) {
 296             controlServiceRegistration.close();
 297             controlServiceRegistration = null;
 298         }
 299         for (final Iterator<StatisticsContext> iterator = Iterators.consumingIterator(contexts.values().iterator());
 300                 iterator.hasNext();) {
 301             iterator.next().close();
 302         }
 303     }
 304
 305     @Override
 306     public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
 307         this.deviceTerminPhaseHandler = handler;
 308     }
 309
 310 }