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.Timeout;
  19 import io.netty.util.TimerTask;
  20 import java.util.Iterator;
  21 import java.util.Map;
  22 import java.util.Optional;
  23 import java.util.concurrent.CancellationException;
  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.CheckForNull;
  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.OFPContext;
  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.LifecycleConductor;
  39 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
  40 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
  41 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  42 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
  43 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInput;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutputBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
  49 import org.opendaylight.yangtools.yang.common.RpcError;
  50 import org.opendaylight.yangtools.yang.common.RpcResult;
  51 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 public class StatisticsManagerImpl implements StatisticsManager, StatisticsManagerControlService {
  56
  57     private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImpl.class);
  58
  59     private static final long DEFAULT_STATS_TIMEOUT_SEC = 50L;
  60     private final ConvertorExecutor convertorExecutor;
  61
  62     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
  63     private DeviceTerminationPhaseHandler deviceTerminPhaseHandler;
  64
  65     private final ConcurrentMap<DeviceInfo, StatisticsContext> contexts = new ConcurrentHashMap<>();
  66
  67     private static final long basicTimerDelay = 3000;
  68     private static long currentTimerDelay = basicTimerDelay;
  69     private static final long maximumTimerDelay = 900000; //wait max 15 minutes for next statistics
  70
  71     private StatisticsWorkMode workMode = StatisticsWorkMode.COLLECTALL;
  72     private final Semaphore workModeGuard = new Semaphore(1, true);
  73     private boolean shuttingDownStatisticsPolling;
  74     private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> controlServiceRegistration;
  75
  76     private final LifecycleConductor conductor;
  77
  78     @Override
  79     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
  80         deviceInitPhaseHandler = handler;
  81     }
  82
  83     public StatisticsManagerImpl(@CheckForNull final RpcProviderRegistry rpcProviderRegistry,
  84                                  final boolean shuttingDownStatisticsPolling,
  85                                  final LifecycleConductor lifecycleConductor,
  86                                  final ConvertorExecutor convertorExecutor) {
  87         this.convertorExecutor = convertorExecutor;
  88         Preconditions.checkArgument(rpcProviderRegistry != null);
  89         this.controlServiceRegistration = Preconditions.checkNotNull(rpcProviderRegistry.addRpcImplementation(
  90                 StatisticsManagerControlService.class, this));
  91         this.shuttingDownStatisticsPolling = shuttingDownStatisticsPolling;
  92         this.conductor = lifecycleConductor;
  93     }
  94
  95     @Override
  96     public void onDeviceContextLevelUp(final DeviceInfo deviceInfo, LifecycleService lifecycleService) throws Exception {
  97
  98         final StatisticsContext statisticsContext = new StatisticsContextImpl(deviceInfo, shuttingDownStatisticsPolling, conductor, convertorExecutor);
  99         Verify.verify(contexts.putIfAbsent(deviceInfo, statisticsContext) == null, "StatisticsCtx still not closed for Node {}", deviceInfo.getNodeId());
 100         lifecycleService.setStatContext(statisticsContext);
 101         deviceInitPhaseHandler.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 102     }
 103
 104     @VisibleForTesting
 105     void pollStatistics(final DeviceState deviceState,
 106                         final StatisticsContext statisticsContext,
 107                         final TimeCounter timeCounter,
 108                         final DeviceInfo deviceInfo) {
 109
 110         if (!statisticsContext.isSchedulingEnabled()) {
 111             LOG.debug("Disabling statistics scheduling for device: {}", deviceInfo.getNodeId());
 112             return;
 113         }
 114
 115         if (!deviceState.isStatisticsPollingEnabled()) {
 116             LOG.debug("Statistics polling is currently disabled for device: {}", deviceInfo.getNodeId());
 117             scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 118             return;
 119         }
 120
 121         LOG.debug("POLLING ALL STATISTICS for device: {}", deviceInfo.getNodeId());
 122         timeCounter.markStart();
 123         final ListenableFuture<Boolean> deviceStatisticsCollectionFuture = statisticsContext.gatherDynamicData();
 124         Futures.addCallback(deviceStatisticsCollectionFuture, new FutureCallback<Boolean>() {
 125             @Override
 126             public void onSuccess(final Boolean o) {
 127                 timeCounter.addTimeMark();
 128                 calculateTimerDelay(timeCounter);
 129                 scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 130             }
 131
 132             @Override
 133             public void onFailure(@Nonnull final Throwable throwable) {
 134                 timeCounter.addTimeMark();
 135                 LOG.warn("Statistics gathering for single node was not successful: {}", throwable.getMessage());
 136                 LOG.trace("Statistics gathering for single node was not successful.. ", throwable);
 137                 calculateTimerDelay(timeCounter);
 138                 if (throwable instanceof CancellationException) {
 139                     /* This often happens when something wrong with akka or DS, so closing connection will help to restart device **/
 140                     conductor.closeConnection(deviceInfo);
 141                 } else {
 142                     scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 143                 }
 144             }
 145         });
 146
 147         final long averageTime = TimeUnit.MILLISECONDS.toSeconds(timeCounter.getAverageTimeBetweenMarks());
 148         final long STATS_TIMEOUT_SEC = averageTime > 0 ? 3 * averageTime : DEFAULT_STATS_TIMEOUT_SEC;
 149         final TimerTask timerTask = timeout -> {
 150             if (!deviceStatisticsCollectionFuture.isDone()) {
 151                 LOG.info("Statistics collection for node {} still in progress even after {} secs", deviceInfo.getNodeId(), STATS_TIMEOUT_SEC);
 152                 deviceStatisticsCollectionFuture.cancel(true);
 153             }
 154         };
 155
 156         conductor.newTimeout(timerTask, STATS_TIMEOUT_SEC, TimeUnit.SECONDS);
 157     }
 158
 159     private void scheduleNextPolling(final DeviceState deviceState,
 160                                      final DeviceInfo deviceInfo,
 161                                      final StatisticsContext statisticsContext,
 162                                      final TimeCounter timeCounter) {
 163         LOG.debug("SCHEDULING NEXT STATISTICS POLLING for device: {}", deviceInfo.getNodeId());
 164         if (!shuttingDownStatisticsPolling) {
 165             final Timeout pollTimeout = conductor.newTimeout(timeout -> pollStatistics(deviceState, statisticsContext, timeCounter, deviceInfo), currentTimerDelay, 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.trace("Removing device context from stack. No more statistics gathering for device: {}", deviceInfo.getNodeId());
 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                 shuttingDownStatisticsPolling = StatisticsWorkMode.FULLYDISABLED.equals(targetWorkMode);
 217                 // iterate through stats-ctx: propagate mode
 218                 for (Map.Entry<DeviceInfo, StatisticsContext> entry : contexts.entrySet()) {
 219                     switch (targetWorkMode) {
 220                         case COLLECTALL:
 221                             scheduleNextPolling(conductor.getDeviceContext(entry.getKey()).getDeviceState(), entry.getKey(), entry.getValue(), new TimeCounter());
 222                             for (final ItemLifeCycleSource lifeCycleSource : conductor.getDeviceContext(entry.getKey()).getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
 223                                 lifeCycleSource.setItemLifecycleListener(null);
 224                             }
 225                             break;
 226                         case FULLYDISABLED:
 227                             final Optional<Timeout> pollTimeout = entry.getValue().getPollTimeout();
 228                             if (pollTimeout.isPresent()) {
 229                                 pollTimeout.get().cancel();
 230                             }
 231                             for (final ItemLifeCycleSource lifeCycleSource : conductor.getDeviceContext(entry.getKey()).getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
 232                                 lifeCycleSource.setItemLifecycleListener(entry.getValue().getItemLifeCycleListener());
 233                             }
 234                             break;
 235                         default:
 236                             LOG.warn("Statistics work mode not supported: {}", targetWorkMode);
 237                     }
 238                 }
 239                 workMode = targetWorkMode;
 240             }
 241             workModeGuard.release();
 242             result = RpcResultBuilder.<Void>success().buildFuture();
 243         } else {
 244             result = RpcResultBuilder.<Void>failed()
 245                     .withError(RpcError.ErrorType.APPLICATION, "mode change already in progress")
 246                     .buildFuture();
 247         }
 248         return result;
 249     }
 250
 251     @Override
 252     public void startScheduling(final DeviceInfo deviceInfo) {
 253         if (shuttingDownStatisticsPolling) {
 254             LOG.info("Statistics are shut down for device: {}", deviceInfo.getNodeId());
 255             return;
 256         }
 257
 258         final StatisticsContext statisticsContext = contexts.get(deviceInfo);
 259
 260         if (statisticsContext == null) {
 261             LOG.warn("Statistics context not found for device: {}", deviceInfo.getNodeId());
 262             return;
 263         }
 264
 265         if (statisticsContext.isSchedulingEnabled()) {
 266             LOG.debug("Statistics scheduling is already enabled for device: {}", deviceInfo.getNodeId());
 267             return;
 268         }
 269
 270         LOG.info("Scheduling statistics poll for device: {}", deviceInfo.getNodeId());
 271
 272         statisticsContext.setSchedulingEnabled(true);
 273         scheduleNextPolling(conductor.getDeviceContext(deviceInfo).getDeviceState(), deviceInfo, statisticsContext, new TimeCounter());
 274     }
 275
 276     @Override
 277     public void stopScheduling(final DeviceInfo deviceInfo) {
 278         LOG.debug("Stopping statistics scheduling for device: {}", deviceInfo.getNodeId());
 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         statisticsContext.setSchedulingEnabled(false);
 287     }
 288
 289     @Override
 290     public void close() {
 291         if (controlServiceRegistration != null) {
 292             controlServiceRegistration.close();
 293             controlServiceRegistration = null;
 294         }
 295         for (final Iterator<StatisticsContext> iterator = Iterators.consumingIterator(contexts.values().iterator());
 296                 iterator.hasNext();) {
 297             iterator.next().close();
 298         }
 299     }
 300
 301     @Override
 302     public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
 303         this.deviceTerminPhaseHandler = handler;
 304     }
 305
 306     @Override
 307     public <T extends OFPContext> T gainContext(DeviceInfo deviceInfo) {
 308         return (T) contexts.get(deviceInfo);
 309     }
 310 }