package org.opendaylight.openflowplugin.impl.statistics;
import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Function;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterators;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
+import java.util.Objects;
import java.util.Optional;
-import java.util.concurrent.ExecutionException;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.GuardedBy;
import org.opendaylight.mdsal.common.api.TransactionChainClosedException;
import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
+import org.opendaylight.openflowplugin.api.ConnectionException;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
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.RequestContext;
-import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterInitializationPhaseHandler;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.MastershipChangeListener;
import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
import org.opendaylight.openflowplugin.impl.rpc.listener.ItemLifecycleListenerImpl;
-import org.opendaylight.openflowplugin.impl.services.RequestContextUtil;
+import org.opendaylight.openflowplugin.impl.services.util.RequestContextUtil;
+import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
import org.opendaylight.openflowplugin.impl.statistics.services.dedicated.StatisticsGatheringOnTheFlyService;
import org.opendaylight.openflowplugin.impl.statistics.services.dedicated.StatisticsGatheringService;
import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-class StatisticsContextImpl implements StatisticsContext {
+class StatisticsContextImpl<T extends OfHeader> implements StatisticsContext {
private static final Logger LOG = LoggerFactory.getLogger(StatisticsContextImpl.class);
private static final String CONNECTION_CLOSED = "Connection closed.";
private final DeviceContext deviceContext;
private final DeviceState devState;
private final ListenableFuture<Boolean> emptyFuture;
- private final boolean shuttingDownStatisticsPolling;
- private final Object COLLECTION_STAT_TYPE_LOCK = new Object();
- private final SinglePurposeMultipartReplyTranslator multipartReplyTranslator;
- @GuardedBy("COLLECTION_STAT_TYPE_LOCK")
+ private final boolean isStatisticsPollingOn;
+ private final Object collectionStatTypeLock = new Object();
+ private final ConvertorExecutor convertorExecutor;
+ private final MultipartWriterProvider statisticsWriterProvider;
+ @GuardedBy("collectionStatTypeLock")
private List<MultipartType> collectingStatType;
- private StatisticsGatheringService statisticsGatheringService;
- private StatisticsGatheringOnTheFlyService statisticsGatheringOnTheFlyService;
+ private StatisticsGatheringService<T> statisticsGatheringService;
+ private StatisticsGatheringOnTheFlyService<T> statisticsGatheringOnTheFlyService;
private Timeout pollTimeout;
private final DeviceInfo deviceInfo;
private final StatisticsManager myManager;
- private final LifecycleService lifecycleService;
private volatile boolean schedulingEnabled;
private volatile CONTEXT_STATE state;
+ private ClusterInitializationPhaseHandler clusterInitializationPhaseHandler;
+ private ClusterInitializationPhaseHandler initialSubmitHandler;
- StatisticsContextImpl(@Nonnull final DeviceInfo deviceInfo,
- final boolean shuttingDownStatisticsPolling,
- @Nonnull final LifecycleService lifecycleService,
- @Nonnull final ConvertorExecutor convertorExecutor,
- @Nonnull final StatisticsManager myManager) {
- this.lifecycleService = lifecycleService;
- this.deviceContext = lifecycleService.getDeviceContext();
+ private ListenableFuture<Boolean> lastDataGathering;
+
+ StatisticsContextImpl(final boolean isStatisticsPollingOn,
+ @Nonnull final DeviceContext deviceContext,
+ @Nonnull final ConvertorExecutor convertorExecutor,
+ @Nonnull final StatisticsManager myManager,
+ @Nonnull final MultipartWriterProvider statisticsWriterProvider) {
+ this.deviceContext = deviceContext;
this.devState = Preconditions.checkNotNull(deviceContext.getDeviceState());
- this.shuttingDownStatisticsPolling = shuttingDownStatisticsPolling;
- multipartReplyTranslator = new SinglePurposeMultipartReplyTranslator(convertorExecutor);
+ this.isStatisticsPollingOn = isStatisticsPollingOn;
+ this.convertorExecutor = convertorExecutor;
emptyFuture = Futures.immediateFuture(false);
- statisticsGatheringService = new StatisticsGatheringService(this, deviceContext);
- statisticsGatheringOnTheFlyService = new StatisticsGatheringOnTheFlyService(this, deviceContext, convertorExecutor);
+ statisticsGatheringService = new StatisticsGatheringService<>(this, deviceContext);
+ statisticsGatheringOnTheFlyService = new StatisticsGatheringOnTheFlyService<>(this,
+ deviceContext, convertorExecutor, statisticsWriterProvider);
itemLifeCycleListener = new ItemLifecycleListenerImpl(deviceContext);
statListForCollectingInitialization();
- setState(CONTEXT_STATE.INITIALIZATION);
- this.deviceInfo = deviceInfo;
+ this.state = CONTEXT_STATE.INITIALIZATION;
+ this.deviceInfo = deviceContext.getDeviceInfo();
this.myManager = myManager;
+ this.lastDataGathering = null;
+ this.statisticsWriterProvider = statisticsWriterProvider;
}
@Override
public void statListForCollectingInitialization() {
- synchronized (COLLECTION_STAT_TYPE_LOCK) {
+ synchronized (collectionStatTypeLock) {
final List<MultipartType> statListForCollecting = new ArrayList<>();
if (devState.isTableStatisticsAvailable()) {
statListForCollecting.add(MultipartType.OFPMPTABLE);
}
private ListenableFuture<Boolean> gatherDynamicData(final boolean initial) {
- if (shuttingDownStatisticsPolling) {
+ this.lastDataGathering = null;
+ if (!isStatisticsPollingOn) {
LOG.debug("Statistics for device {} is not enabled.", getDeviceInfo().getNodeId().getValue());
return Futures.immediateFuture(Boolean.TRUE);
}
if (errorResultFuture != null) {
return errorResultFuture;
}
- synchronized (COLLECTION_STAT_TYPE_LOCK) {
+ synchronized (collectionStatTypeLock) {
final Iterator<MultipartType> statIterator = collectingStatType.iterator();
final SettableFuture<Boolean> settableStatResultFuture = SettableFuture.create();
}
}
});
+ this.lastDataGathering = settableStatResultFuture;
return settableStatResultFuture;
}
}
private ListenableFuture<Boolean> chooseStat(final MultipartType multipartType, final boolean initial){
+ ListenableFuture<Boolean> result = Futures.immediateCheckedFuture(Boolean.TRUE);
+
switch (multipartType) {
case OFPMPFLOW:
- return collectFlowStatistics(multipartType, initial);
+ result = collectFlowStatistics(multipartType, initial);
+ break;
case OFPMPTABLE:
- return collectTableStatistics(multipartType);
+ result = collectTableStatistics(multipartType);
+ break;
case OFPMPPORTSTATS:
- return collectPortStatistics(multipartType);
+ result = collectPortStatistics(multipartType);
+ break;
case OFPMPQUEUE:
- return collectQueueStatistics(multipartType);
+ result = collectQueueStatistics(multipartType);
+ break;
case OFPMPGROUPDESC:
- return collectGroupDescStatistics(multipartType);
+ result = collectGroupDescStatistics(multipartType);
+ break;
case OFPMPGROUP:
- return collectGroupStatistics(multipartType);
+ result = collectGroupStatistics(multipartType);
+ break;
case OFPMPMETERCONFIG:
- return collectMeterConfigStatistics(multipartType);
+ result = collectMeterConfigStatistics(multipartType);
+ break;
case OFPMPMETER:
- return collectMeterStatistics(multipartType);
+ result = collectMeterStatistics(multipartType);
+ break;
default:
- LOG.warn("Unsuported Statistics type {}", multipartType);
- return Futures.immediateCheckedFuture(Boolean.TRUE);
+ LOG.warn("Unsupported Statistics type {}", multipartType);
}
+
+ return result;
}
public void close() {
if (CONTEXT_STATE.TERMINATION.equals(getState())) {
if (LOG.isDebugEnabled()) {
- LOG.debug("Statistics context is already in state TERMINATION.");
+ LOG.debug("StatisticsContext for node {} is already in TERMINATION state.", getDeviceInfo().getLOGValue());
}
} else {
- setState(CONTEXT_STATE.TERMINATION);
- schedulingEnabled = false;
+ try {
+ stopClusterServices(true).get();
+ } catch (Exception e) {
+ LOG.debug("Failed to close StatisticsContext for node {} with exception: ", getDeviceInfo().getLOGValue(), e);
+ }
+
+ this.state = CONTEXT_STATE.TERMINATION;
+
for (final Iterator<RequestContext<?>> iterator = Iterators.consumingIterator(requestContexts.iterator());
iterator.hasNext(); ) {
RequestContextUtil.closeRequestContextWithRpcError(iterator.next(), CONNECTION_CLOSED);
}
+
if (null != pollTimeout && !pollTimeout.isExpired()) {
pollTimeout.cancel();
}
private void statChainFuture(final Iterator<MultipartType> iterator, final SettableFuture<Boolean> resultFuture, final boolean initial) {
if (ConnectionContext.CONNECTION_STATE.RIP.equals(deviceContext.getPrimaryConnectionContext().getConnectionState())) {
final String errMsg = String.format("Device connection is closed for Node : %s.",
- getDeviceInfo().getNodeId());
+ getDeviceInfo().getNodeId());
LOG.debug(errMsg);
- resultFuture.setException(new IllegalStateException(errMsg));
+ resultFuture.setException(new ConnectionException(errMsg));
return;
}
if ( ! iterator.hasNext()) {
resultFuture.set(Boolean.TRUE);
- LOG.debug("Stats collection successfully finished for node {}", getDeviceInfo().getNodeId());
+ LOG.debug("Stats collection successfully finished for node {}", getDeviceInfo().getLOGValue());
return;
}
final MultipartType nextType = iterator.next();
- LOG.debug("Stats iterating to next type for node {} of type {}", getDeviceInfo().getNodeId(), nextType);
+ LOG.debug("Stats iterating to next type for node {} of type {}", getDeviceInfo().getLOGValue(), nextType);
final ListenableFuture<Boolean> deviceStatisticsCollectionFuture = chooseStat(nextType, initial);
Futures.addCallback(deviceStatisticsCollectionFuture, new FutureCallback<Boolean>() {
* Method checks a device state. It returns null for be able continue. Otherwise it returns immediateFuture
* which has to be returned from caller too
*
- * @return
+ * @return future
*/
@VisibleForTesting
ListenableFuture<Boolean> deviceConnectionCheck() {
switch (deviceContext.getPrimaryConnectionContext().getConnectionState()) {
case RIP:
final String errMsg = String.format("Device connection doesn't exist anymore. Primary connection status : %s",
- deviceContext.getPrimaryConnectionContext().getConnectionState());
+ deviceContext.getPrimaryConnectionContext().getConnectionState());
resultingFuture = Futures.immediateFailedFuture(new Throwable(errMsg));
break;
default:
//TODO: Refactor twice sending deviceContext into gatheringStatistics
private ListenableFuture<Boolean> collectFlowStatistics(final MultipartType multipartType, final boolean initial) {
return devState.isFlowStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
- statisticsGatheringOnTheFlyService,
- getDeviceInfo(),
- /*MultipartType.OFPMPFLOW*/ multipartType,
- deviceContext,
- deviceContext,
- initial, multipartReplyTranslator) : emptyFuture;
+ statisticsGatheringOnTheFlyService,
+ getDeviceInfo(),
+ /*MultipartType.OFPMPFLOW*/ multipartType,
+ deviceContext,
+ deviceContext,
+ initial,
+ convertorExecutor,
+ statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectTableStatistics(final MultipartType multipartType) {
return devState.isTableStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
- statisticsGatheringService,
- getDeviceInfo(),
+ statisticsGatheringService,
+ getDeviceInfo(),
/*MultipartType.OFPMPTABLE*/ multipartType,
- deviceContext,
- deviceContext,
- false, multipartReplyTranslator) : emptyFuture;
+ deviceContext,
+ deviceContext,
+ false,
+ convertorExecutor,
+ statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectPortStatistics(final MultipartType multipartType) {
return devState.isPortStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
- statisticsGatheringService,
- getDeviceInfo(),
+ statisticsGatheringService,
+ getDeviceInfo(),
/*MultipartType.OFPMPPORTSTATS*/ multipartType,
- deviceContext,
- deviceContext,
- false, multipartReplyTranslator) : emptyFuture;
+ deviceContext,
+ deviceContext,
+ false,
+ convertorExecutor,
+ statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectQueueStatistics(final MultipartType multipartType) {
return !devState.isQueueStatisticsAvailable() ? emptyFuture : StatisticsGatheringUtils.gatherStatistics(
- statisticsGatheringService,
- getDeviceInfo(),
+ statisticsGatheringService,
+ getDeviceInfo(),
/*MultipartType.OFPMPQUEUE*/ multipartType,
- deviceContext,
- deviceContext,
- false, multipartReplyTranslator);
+ deviceContext,
+ deviceContext,
+ false,
+ convertorExecutor,
+ statisticsWriterProvider);
}
private ListenableFuture<Boolean> collectGroupDescStatistics(final MultipartType multipartType) {
return devState.isGroupAvailable() ? StatisticsGatheringUtils.gatherStatistics(
- statisticsGatheringService,
- getDeviceInfo(),
+ statisticsGatheringService,
+ getDeviceInfo(),
/*MultipartType.OFPMPGROUPDESC*/ multipartType,
- deviceContext,
- deviceContext,
- false, multipartReplyTranslator) : emptyFuture;
+ deviceContext,
+ deviceContext,
+ false,
+ convertorExecutor,
+ statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectGroupStatistics(final MultipartType multipartType) {
return devState.isGroupAvailable() ? StatisticsGatheringUtils.gatherStatistics(
- statisticsGatheringService,
- getDeviceInfo(),
+ statisticsGatheringService,
+ getDeviceInfo(),
/*MultipartType.OFPMPGROUP*/ multipartType,
- deviceContext,
- deviceContext,
- false, multipartReplyTranslator) : emptyFuture;
+ deviceContext,
+ deviceContext,
+ false,
+ convertorExecutor,
+ statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectMeterConfigStatistics(final MultipartType multipartType) {
return devState.isMetersAvailable() ? StatisticsGatheringUtils.gatherStatistics(
- statisticsGatheringService,
- getDeviceInfo(),
+ statisticsGatheringService,
+ getDeviceInfo(),
/*MultipartType.OFPMPMETERCONFIG*/ multipartType,
- deviceContext,
- deviceContext,
- false, multipartReplyTranslator) : emptyFuture;
+ deviceContext,
+ deviceContext,
+ false,
+ convertorExecutor,
+ statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectMeterStatistics(final MultipartType multipartType) {
return devState.isMetersAvailable() ? StatisticsGatheringUtils.gatherStatistics(
- statisticsGatheringService,
- getDeviceInfo(),
+ statisticsGatheringService,
+ getDeviceInfo(),
/*MultipartType.OFPMPMETER*/ multipartType,
- deviceContext,
- deviceContext,
- false, multipartReplyTranslator) : emptyFuture;
+ deviceContext,
+ deviceContext,
+ false,
+ convertorExecutor,
+ statisticsWriterProvider) : emptyFuture;
}
@VisibleForTesting
- void setStatisticsGatheringService(final StatisticsGatheringService statisticsGatheringService) {
+ void setStatisticsGatheringService(final StatisticsGatheringService<T> statisticsGatheringService) {
this.statisticsGatheringService = statisticsGatheringService;
}
@VisibleForTesting
- void setStatisticsGatheringOnTheFlyService(final StatisticsGatheringOnTheFlyService
- statisticsGatheringOnTheFlyService) {
+ void setStatisticsGatheringOnTheFlyService(final StatisticsGatheringOnTheFlyService<T> statisticsGatheringOnTheFlyService) {
this.statisticsGatheringOnTheFlyService = statisticsGatheringOnTheFlyService;
}
return this.state;
}
- @Override
- public void setState(CONTEXT_STATE state) {
- this.state = state;
- }
-
@Override
public ServiceGroupIdentifier getServiceIdentifier() {
return this.deviceInfo.getServiceIdentifier();
}
@Override
- public void startupClusterServices() throws ExecutionException, InterruptedException {
- if (!this.shuttingDownStatisticsPolling) {
- this.statListForCollectingInitialization();
- this.initialGatherDynamicData();
- myManager.startScheduling(deviceInfo);
+ public ListenableFuture<Void> stopClusterServices() {
+ if (CONTEXT_STATE.TERMINATION.equals(this.state)) {
+ return Futures.immediateCancelledFuture();
}
+
+ return Futures.transform(Futures.immediateFuture(null), new Function<Object, Void>() {
+ @Nullable
+ @Override
+ public Void apply(@Nullable Object input) {
+ schedulingEnabled = false;
+ stopGatheringData();
+ return null;
+ }
+ });
}
@Override
- public ListenableFuture<Void> stopClusterServices() {
- myManager.stopScheduling(deviceInfo);
- return Futures.immediateFuture(null);
+ public DeviceState gainDeviceState() {
+ return gainDeviceContext().getDeviceState();
+ }
+
+ @Override
+ public DeviceContext gainDeviceContext() {
+ return this.deviceContext;
+ }
+
+ @Override
+ public void stopGatheringData() {
+ if (Objects.nonNull(this.lastDataGathering)) {
+ if (LOG.isDebugEnabled()) {
+ LOG.debug("Stop the running statistics gathering for node {}", this.deviceInfo.getLOGValue());
+ }
+
+ lastDataGathering.cancel(true);
+ }
+ }
+
+ @Override
+ public void setLifecycleInitializationPhaseHandler(final ClusterInitializationPhaseHandler handler) {
+ this.clusterInitializationPhaseHandler = handler;
+ }
+
+ @Override
+ public boolean onContextInstantiateService(final MastershipChangeListener mastershipChangeListener) {
+
+ LOG.info("Starting statistics context cluster services for node {}", deviceInfo.getLOGValue());
+
+ this.statListForCollectingInitialization();
+ Futures.addCallback(this.initialGatherDynamicData(), new FutureCallback<Boolean>() {
+
+ @Override
+ public void onSuccess(@Nullable Boolean aBoolean) {
+ initialSubmitHandler.initialSubmitTransaction();
+ }
+
+ @Override
+ public void onFailure(@Nonnull Throwable throwable) {
+ LOG.warn("Initial gathering statistics unsuccessful for node {}", deviceInfo.getLOGValue());
+ mastershipChangeListener.onNotAbleToStartMastership(deviceInfo);
+ }
+ });
+
+ if (this.isStatisticsPollingOn) {
+ myManager.startScheduling(deviceInfo);
+ }
+
+ return this.clusterInitializationPhaseHandler.onContextInstantiateService(mastershipChangeListener);
}
@Override
- public LifecycleService getLifecycleService() {
- return lifecycleService;
+ public void setInitialSubmitHandler(final ClusterInitializationPhaseHandler initialSubmitHandler) {
+ this.initialSubmitHandler = initialSubmitHandler;
}
}
Code Review / openflowplugin.git / blobdiff