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.ConcurrentHashMap;
  25 import java.util.concurrent.ConcurrentMap;
  26 import java.util.concurrent.Future;
  27 import java.util.concurrent.Semaphore;
  28 import java.util.concurrent.TimeUnit;
  29 import javax.annotation.Nonnull;
  30 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  31 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  32 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
  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 converterExecutor;
  60
  61     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
  62     private DeviceTerminationPhaseHandler deviceTerminationPhaseHandler;
  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 isStatisticsPollingOff;
  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 isStatisticsPollingOff,
  84                                  final HashedWheelTimer hashedWheelTimer,
  85                                  final ConvertorExecutor convertorExecutor) {
  86         Preconditions.checkArgument(rpcProviderRegistry != null);
  87             this.converterExecutor = convertorExecutor;
  88         this.controlServiceRegistration = Preconditions.checkNotNull(
  89                 rpcProviderRegistry.addRpcImplementation(StatisticsManagerControlService.class, this)
  90         );
  91         this.isStatisticsPollingOff = isStatisticsPollingOff;
  92         this.hashedWheelTimer = hashedWheelTimer;
  93     }
  94
  95     @Override
  96     public void onDeviceContextLevelUp(final DeviceInfo deviceInfo,
  97                                        final LifecycleService lifecycleService) throws Exception {
  98
  99         final StatisticsContext statisticsContext =
 100                 new StatisticsContextImpl(
 101                         deviceInfo,
 102                         isStatisticsPollingOff,
 103                         lifecycleService,
 104                         converterExecutor,
 105                         this);
 106
 107         Verify.verify(
 108                 contexts.putIfAbsent(deviceInfo, statisticsContext) == null,
 109                 "StatisticsCtx still not closed for Node {}", deviceInfo.getLOGValue()
 110         );
 111
 112         lifecycleService.setStatContext(statisticsContext);
 113         lifecycleService.registerDeviceRemovedHandler(this);
 114         deviceInitPhaseHandler.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 115     }
 116
 117     @VisibleForTesting
 118     void pollStatistics(final DeviceState deviceState,
 119                         final StatisticsContext statisticsContext,
 120                         final TimeCounter timeCounter,
 121                         final DeviceInfo deviceInfo) {
 122
 123         if (!statisticsContext.isSchedulingEnabled()) {
 124             if (LOG.isDebugEnabled()) {
 125                 LOG.debug("Disabled statistics scheduling for device: {}", deviceInfo.getNodeId().getValue());
 126             }
 127             return;
 128         }
 129
 130         if (LOG.isDebugEnabled()) {
 131             LOG.debug("POLLING ALL STATISTICS for device: {}", deviceInfo.getNodeId());
 132         }
 133
 134         timeCounter.markStart();
 135         final ListenableFuture<Boolean> deviceStatisticsCollectionFuture = statisticsContext.gatherDynamicData();
 136         Futures.addCallback(deviceStatisticsCollectionFuture, new FutureCallback<Boolean>() {
 137             @Override
 138             public void onSuccess(final Boolean o) {
 139                 timeCounter.addTimeMark();
 140                 calculateTimerDelay(timeCounter);
 141                 scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 142             }
 143
 144             @Override
 145             public void onFailure(@Nonnull final Throwable throwable) {
 146                 timeCounter.addTimeMark();
 147                 LOG.warn("Statistics gathering for single node {} was not successful: ", deviceInfo.getLOGValue(), throwable.getMessage());
 148                 if (LOG.isTraceEnabled()) {
 149                     LOG.trace("Gathering for node {} failure: ", deviceInfo.getLOGValue(), throwable);
 150                 }
 151                 calculateTimerDelay(timeCounter);
 152                 if (throwable instanceof IllegalStateException) {
 153                     stopScheduling(deviceInfo);
 154                 } else {
 155                     scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 156                 }
 157             }
 158         });
 159
 160         final long averageTime = TimeUnit.MILLISECONDS.toSeconds(timeCounter.getAverageTimeBetweenMarks());
 161         final long statsTimeoutSec = averageTime > 0 ? 3 * averageTime : DEFAULT_STATS_TIMEOUT_SEC;
 162         final TimerTask timerTask = timeout -> {
 163             if (!deviceStatisticsCollectionFuture.isDone()) {
 164                 LOG.info("Statistics collection for node {} still in progress even after {} secs", deviceInfo.getLOGValue(), statsTimeoutSec);
 165                 deviceStatisticsCollectionFuture.cancel(true);
 166             }
 167         };
 168
 169         hashedWheelTimer.newTimeout(timerTask, statsTimeoutSec, TimeUnit.SECONDS);
 170     }
 171
 172     private void scheduleNextPolling(final DeviceState deviceState,
 173                                      final DeviceInfo deviceInfo,
 174                                      final StatisticsContext statisticsContext,
 175                                      final TimeCounter timeCounter) {
 176         if (LOG.isDebugEnabled()) {
 177             LOG.debug("SCHEDULING NEXT STATISTICS POLLING for device: {}", deviceInfo.getNodeId());
 178         }
 179         if (!isStatisticsPollingOff) {
 180             final Timeout pollTimeout = hashedWheelTimer.newTimeout(
 181                     timeout -> pollStatistics(
 182                             deviceState,
 183                             statisticsContext,
 184                             timeCounter,
 185                             deviceInfo),
 186                     currentTimerDelay,
 187                     TimeUnit.MILLISECONDS);
 188             statisticsContext.setPollTimeout(pollTimeout);
 189         }
 190     }
 191
 192     @VisibleForTesting
 193     void calculateTimerDelay(final TimeCounter timeCounter) {
 194         final long averageStatisticsGatheringTime = timeCounter.getAverageTimeBetweenMarks();
 195         if (averageStatisticsGatheringTime > currentTimerDelay) {
 196             currentTimerDelay *= 2;
 197             if (currentTimerDelay > maximumTimerDelay) {
 198                 currentTimerDelay = maximumTimerDelay;
 199             }
 200         } else {
 201             if (currentTimerDelay > basicTimerDelay) {
 202                 currentTimerDelay /= 2;
 203             } else {
 204                 currentTimerDelay = basicTimerDelay;
 205             }
 206         }
 207     }
 208
 209     @VisibleForTesting
 210     static long getCurrentTimerDelay() {
 211         return currentTimerDelay;
 212     }
 213
 214     @Override
 215     public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
 216         Optional.ofNullable(contexts.get(deviceInfo)).ifPresent(OFPContext::close);
 217         deviceTerminationPhaseHandler.onDeviceContextLevelDown(deviceInfo);
 218     }
 219
 220     @Override
 221     public Future<RpcResult<GetStatisticsWorkModeOutput>> getStatisticsWorkMode() {
 222         final GetStatisticsWorkModeOutputBuilder smModeOutputBld = new GetStatisticsWorkModeOutputBuilder();
 223         smModeOutputBld.setMode(workMode);
 224         return RpcResultBuilder.success(smModeOutputBld.build()).buildFuture();
 225     }
 226
 227     @Override
 228     public Future<RpcResult<Void>> changeStatisticsWorkMode(ChangeStatisticsWorkModeInput input) {
 229         final Future<RpcResult<Void>> result;
 230         // acquire exclusive access
 231         if (workModeGuard.tryAcquire()) {
 232             final StatisticsWorkMode targetWorkMode = input.getMode();
 233             if (!workMode.equals(targetWorkMode)) {
 234                 isStatisticsPollingOff = StatisticsWorkMode.FULLYDISABLED.equals(targetWorkMode);
 235                 // iterate through stats-ctx: propagate mode
 236                 for (Map.Entry<DeviceInfo, StatisticsContext> entry : contexts.entrySet()) {
 237                     final DeviceInfo deviceInfo = entry.getKey();
 238                     final StatisticsContext statisticsContext = entry.getValue();
 239                     final DeviceContext deviceContext = statisticsContext.gainDeviceContext();
 240                     switch (targetWorkMode) {
 241                         case COLLECTALL:
 242                             scheduleNextPolling(statisticsContext.gainDeviceState(), deviceInfo, statisticsContext, new TimeCounter());
 243                             for (final ItemLifeCycleSource lifeCycleSource : deviceContext.getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
 244                                 lifeCycleSource.setItemLifecycleListener(null);
 245                             }
 246                             break;
 247                         case FULLYDISABLED:
 248                             final Optional<Timeout> pollTimeout = statisticsContext.getPollTimeout();
 249                             if (pollTimeout.isPresent()) {
 250                                 pollTimeout.get().cancel();
 251                             }
 252                             for (final ItemLifeCycleSource lifeCycleSource : deviceContext.getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
 253                                 lifeCycleSource.setItemLifecycleListener(statisticsContext.getItemLifeCycleListener());
 254                             }
 255                             break;
 256                         default:
 257                             LOG.warn("Statistics work mode not supported: {}", targetWorkMode);
 258                     }
 259                 }
 260                 workMode = targetWorkMode;
 261             }
 262             workModeGuard.release();
 263             result = RpcResultBuilder.<Void>success().buildFuture();
 264         } else {
 265             result = RpcResultBuilder.<Void>failed()
 266                     .withError(RpcError.ErrorType.APPLICATION, "mode change already in progress")
 267                     .buildFuture();
 268         }
 269         return result;
 270     }
 271
 272     @Override
 273     public void startScheduling(final DeviceInfo deviceInfo) {
 274         if (isStatisticsPollingOff) {
 275             LOG.info("Statistics are shutdown for device: {}", deviceInfo.getNodeId());
 276             return;
 277         }
 278
 279         final StatisticsContext statisticsContext = contexts.get(deviceInfo);
 280
 281         if (statisticsContext == null) {
 282             LOG.warn("Statistics context not found for device: {}", deviceInfo.getNodeId());
 283             return;
 284         }
 285
 286         if (statisticsContext.isSchedulingEnabled()) {
 287             LOG.debug("Statistics scheduling is already enabled for device: {}", deviceInfo.getNodeId());
 288             return;
 289         }
 290
 291         LOG.info("Scheduling statistics poll for device: {}", deviceInfo.getNodeId());
 292
 293         statisticsContext.setSchedulingEnabled(true);
 294         scheduleNextPolling(
 295                 statisticsContext.gainDeviceState(),
 296                 deviceInfo,
 297                 statisticsContext,
 298                 new TimeCounter()
 299         );
 300     }
 301
 302     @Override
 303     public void stopScheduling(final DeviceInfo deviceInfo) {
 304         if (LOG.isDebugEnabled()) {
 305             LOG.debug("Stopping statistics scheduling for device: {}", deviceInfo.getNodeId());
 306         }
 307
 308         final StatisticsContext statisticsContext = contexts.get(deviceInfo);
 309
 310         if (statisticsContext == null) {
 311             LOG.warn("Statistics context not found for device: {}", deviceInfo.getNodeId());
 312             return;
 313         }
 314
 315         statisticsContext.setSchedulingEnabled(false);
 316     }
 317
 318     @Override
 319     public void close() {
 320         if (controlServiceRegistration != null) {
 321             controlServiceRegistration.close();
 322             controlServiceRegistration = null;
 323         }
 324
 325         for (final Iterator<StatisticsContext> iterator = Iterators.consumingIterator(contexts.values().iterator());
 326                 iterator.hasNext();) {
 327             iterator.next().close();
 328         }
 329     }
 330
 331     @Override
 332     public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
 333         this.deviceTerminationPhaseHandler = handler;
 334     }
 335
 336    @Override
 337     public void setIsStatisticsPollingOff(boolean isStatisticsPollingOff){
 338         this.isStatisticsPollingOff = isStatisticsPollingOff;
 339     }
 340
 341     public void onDeviceRemoved(DeviceInfo deviceInfo) {
 342         contexts.remove(deviceInfo);
 343         LOG.debug("Statistics context removed for node {}", deviceInfo.getLOGValue());
 344     }
 345 }