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 org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  21 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  22 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
  23 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  24 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  25 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  26 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  27 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
  28 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
  29 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
  30 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  31 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutputBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
  37 import org.opendaylight.yangtools.yang.common.RpcError;
  38 import org.opendaylight.yangtools.yang.common.RpcResult;
  39 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 import javax.annotation.CheckForNull;
  44 import javax.annotation.Nonnull;
  45 import java.util.Iterator;
  46 import java.util.Map;
  47 import java.util.Optional;
  48 import java.util.concurrent.CancellationException;
  49 import java.util.concurrent.ConcurrentHashMap;
  50 import java.util.concurrent.ConcurrentMap;
  51 import java.util.concurrent.Future;
  52 import java.util.concurrent.Semaphore;
  53 import java.util.concurrent.TimeUnit;
  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
  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 shuttingDownStatisticsPolling;
  73     private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> controlServiceRegistration;
  74
  75     private final LifecycleConductor conductor;
  76
  77     @Override
  78     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
  79         deviceInitPhaseHandler = handler;
  80     }
  81
  82     public StatisticsManagerImpl(@CheckForNull final RpcProviderRegistry rpcProviderRegistry,
  83                                  final boolean shuttingDownStatisticsPolling,
  84                                  final LifecycleConductor lifecycleConductor) {
  85         Preconditions.checkArgument(rpcProviderRegistry != null);
  86         this.controlServiceRegistration = Preconditions.checkNotNull(rpcProviderRegistry.addRpcImplementation(
  87                 StatisticsManagerControlService.class, this));
  88         this.shuttingDownStatisticsPolling = shuttingDownStatisticsPolling;
  89         this.conductor = lifecycleConductor;
  90     }
  91
  92     @Override
  93     public void onDeviceContextLevelUp(final DeviceInfo deviceInfo) throws Exception {
  94
  95         final DeviceContext deviceContext = Preconditions.checkNotNull(conductor.getDeviceContext(deviceInfo));
  96
  97         final StatisticsContext statisticsContext = new StatisticsContextImpl(deviceInfo, shuttingDownStatisticsPolling, conductor);
  98         Verify.verify(contexts.putIfAbsent(deviceInfo, statisticsContext) == null, "StatisticsCtx still not closed for Node {}", deviceInfo.getNodeId());
  99
 100         deviceInitPhaseHandler.onDeviceContextLevelUp(deviceInfo);
 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("Disabling statistics scheduling for device: {}", deviceInfo.getNodeId());
 111             return;
 112         }
 113
 114         if (!deviceState.isValid()) {
 115             LOG.debug("Session is not valid for device: {}", deviceInfo.getNodeId());
 116             return;
 117         }
 118
 119         if (!deviceState.isStatisticsPollingEnabled()) {
 120             LOG.debug("Statistics polling is currently disabled for device: {}", deviceInfo.getNodeId());
 121             scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 122             return;
 123         }
 124
 125         LOG.debug("POLLING ALL STATISTICS for device: {}", deviceInfo.getNodeId());
 126         timeCounter.markStart();
 127         final ListenableFuture<Boolean> deviceStatisticsCollectionFuture = statisticsContext.gatherDynamicData();
 128         Futures.addCallback(deviceStatisticsCollectionFuture, new FutureCallback<Boolean>() {
 129             @Override
 130             public void onSuccess(final Boolean o) {
 131                 timeCounter.addTimeMark();
 132                 calculateTimerDelay(timeCounter);
 133                 scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 134             }
 135
 136             @Override
 137             public void onFailure(@Nonnull final Throwable throwable) {
 138                 timeCounter.addTimeMark();
 139                 LOG.warn("Statistics gathering for single node was not successful: {}", throwable.getMessage());
 140                 LOG.trace("Statistics gathering for single node was not successful.. ", throwable);
 141                 calculateTimerDelay(timeCounter);
 142                 if (throwable instanceof CancellationException) {
 143                     /** This often happens when something wrong with akka or DS, so closing connection will help to restart device **/
 144                     conductor.closeConnection(deviceInfo);
 145                 } else {
 146                     scheduleNextPolling(deviceState, deviceInfo, statisticsContext, timeCounter);
 147                 }
 148             }
 149         });
 150
 151         final long averageTime = TimeUnit.MILLISECONDS.toSeconds(timeCounter.getAverageTimeBetweenMarks());
 152         final long STATS_TIMEOUT_SEC = averageTime > 0 ? 3 * averageTime : DEFAULT_STATS_TIMEOUT_SEC;
 153         final TimerTask timerTask = timeout -> {
 154             if (!deviceStatisticsCollectionFuture.isDone()) {
 155                 LOG.info("Statistics collection for node {} still in progress even after {} secs", deviceInfo.getNodeId(), STATS_TIMEOUT_SEC);
 156                 deviceStatisticsCollectionFuture.cancel(true);
 157             }
 158         };
 159
 160         conductor.newTimeout(timerTask, STATS_TIMEOUT_SEC, TimeUnit.SECONDS);
 161     }
 162
 163     private void scheduleNextPolling(final DeviceState deviceState,
 164                                      final DeviceInfo deviceInfo,
 165                                      final StatisticsContext statisticsContext,
 166                                      final TimeCounter timeCounter) {
 167         LOG.debug("SCHEDULING NEXT STATISTICS POLLING for device: {}", deviceInfo.getNodeId());
 168         if (!shuttingDownStatisticsPolling) {
 169             final Timeout pollTimeout = conductor.newTimeout(timeout -> pollStatistics(deviceState, statisticsContext, timeCounter, deviceInfo), currentTimerDelay, TimeUnit.MILLISECONDS);
 170             statisticsContext.setPollTimeout(pollTimeout);
 171         }
 172     }
 173
 174     @VisibleForTesting
 175     void calculateTimerDelay(final TimeCounter timeCounter) {
 176         final long averageStatisticsGatheringTime = timeCounter.getAverageTimeBetweenMarks();
 177         if (averageStatisticsGatheringTime > currentTimerDelay) {
 178             currentTimerDelay *= 2;
 179             if (currentTimerDelay > maximumTimerDelay) {
 180                 currentTimerDelay = maximumTimerDelay;
 181             }
 182         } else {
 183             if (currentTimerDelay > basicTimerDelay) {
 184                 currentTimerDelay /= 2;
 185             } else {
 186                 currentTimerDelay = basicTimerDelay;
 187             }
 188         }
 189     }
 190
 191     @VisibleForTesting
 192     static long getCurrentTimerDelay() {
 193         return currentTimerDelay;
 194     }
 195
 196     @Override
 197     public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
 198         final StatisticsContext statisticsContext = contexts.remove(deviceInfo);
 199         if (null != statisticsContext) {
 200             LOG.trace("Removing device context from stack. No more statistics gathering for device: {}", deviceInfo.getNodeId());
 201             statisticsContext.close();
 202         }
 203         deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
 204     }
 205
 206     @Override
 207     public Future<RpcResult<GetStatisticsWorkModeOutput>> getStatisticsWorkMode() {
 208         final GetStatisticsWorkModeOutputBuilder smModeOutputBld = new GetStatisticsWorkModeOutputBuilder();
 209         smModeOutputBld.setMode(workMode);
 210         return RpcResultBuilder.success(smModeOutputBld.build()).buildFuture();
 211     }
 212
 213     @Override
 214     public Future<RpcResult<Void>> changeStatisticsWorkMode(ChangeStatisticsWorkModeInput input) {
 215         final Future<RpcResult<Void>> result;
 216         // acquire exclusive access
 217         if (workModeGuard.tryAcquire()) {
 218             final StatisticsWorkMode targetWorkMode = input.getMode();
 219             if (!workMode.equals(targetWorkMode)) {
 220                 shuttingDownStatisticsPolling = StatisticsWorkMode.FULLYDISABLED.equals(targetWorkMode);
 221                 // iterate through stats-ctx: propagate mode
 222                 for (Map.Entry<DeviceInfo, StatisticsContext> entry : contexts.entrySet()) {
 223                     switch (targetWorkMode) {
 224                         case COLLECTALL:
 225                             scheduleNextPolling(conductor.getDeviceContext(entry.getKey()).getDeviceState(), entry.getKey(), entry.getValue(), new TimeCounter());
 226                             for (final ItemLifeCycleSource lifeCycleSource : conductor.getDeviceContext(entry.getKey()).getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
 227                                 lifeCycleSource.setItemLifecycleListener(null);
 228                             }
 229                             break;
 230                         case FULLYDISABLED:
 231                             final Optional<Timeout> pollTimeout = entry.getValue().getPollTimeout();
 232                             if (pollTimeout.isPresent()) {
 233                                 pollTimeout.get().cancel();
 234                             }
 235                             for (final ItemLifeCycleSource lifeCycleSource : conductor.getDeviceContext(entry.getKey()).getItemLifeCycleSourceRegistry().getLifeCycleSources()) {
 236                                 lifeCycleSource.setItemLifecycleListener(entry.getValue().getItemLifeCycleListener());
 237                             }
 238                             break;
 239                         default:
 240                             LOG.warn("Statistics work mode not supported: {}", targetWorkMode);
 241                     }
 242                 }
 243                 workMode = targetWorkMode;
 244             }
 245             workModeGuard.release();
 246             result = RpcResultBuilder.<Void>success().buildFuture();
 247         } else {
 248             result = RpcResultBuilder.<Void>failed()
 249                     .withError(RpcError.ErrorType.APPLICATION, "mode change already in progress")
 250                     .buildFuture();
 251         }
 252         return result;
 253     }
 254
 255     @Override
 256     public void startScheduling(final DeviceInfo deviceInfo) {
 257         if (shuttingDownStatisticsPolling) {
 258             LOG.info("Statistics are shut down for device: {}", deviceInfo.getNodeId());
 259             return;
 260         }
 261
 262         final StatisticsContext statisticsContext = contexts.get(deviceInfo);
 263
 264         if (statisticsContext == null) {
 265             LOG.warn("Statistics context not found for device: {}", deviceInfo.getNodeId());
 266             return;
 267         }
 268
 269         if (statisticsContext.isSchedulingEnabled()) {
 270             LOG.debug("Statistics scheduling is already enabled for device: {}", deviceInfo.getNodeId());
 271             return;
 272         }
 273
 274         LOG.info("Scheduling statistics poll for device: {}", deviceInfo.getNodeId());
 275
 276         statisticsContext.setSchedulingEnabled(true);
 277         scheduleNextPolling(conductor.getDeviceContext(deviceInfo).getDeviceState(), 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     @Override
 311     public <T extends OFPContext> T gainContext(DeviceInfo deviceInfo) {
 312         return (T) contexts.get(deviceInfo);
 313     }
 314 }