/*
* Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
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 com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
import io.netty.util.Timeout;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
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.device.handlers.ClusterInitializationPhaseHandler;
import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainMastershipState;
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.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<T extends OfHeader> implements StatisticsContext {
private static final Logger LOG = LoggerFactory.getLogger(StatisticsContextImpl.class);
private static final String CONNECTION_CLOSED = "Connection closed.";
private final ItemLifecycleListener itemLifeCycleListener;
private final Collection<RequestContext<?>> requestContexts = new HashSet<>();
private final DeviceContext deviceContext;
private final DeviceState devState;
private final ListenableFuture<Boolean> emptyFuture;
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<T> statisticsGatheringService;
private StatisticsGatheringOnTheFlyService<T> statisticsGatheringOnTheFlyService;
private Timeout pollTimeout;
private final DeviceInfo deviceInfo;
private final StatisticsManager myManager;
private volatile boolean schedulingEnabled;
private volatile CONTEXT_STATE state;
private ClusterInitializationPhaseHandler clusterInitializationPhaseHandler;
private ClusterInitializationPhaseHandler initialSubmitHandler;
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.isStatisticsPollingOn = isStatisticsPollingOn;
this.convertorExecutor = convertorExecutor;
emptyFuture = Futures.immediateFuture(false);
statisticsGatheringService = new StatisticsGatheringService<>(this, deviceContext);
statisticsGatheringOnTheFlyService = new StatisticsGatheringOnTheFlyService<>(this,
deviceContext, convertorExecutor, statisticsWriterProvider);
itemLifeCycleListener = new ItemLifecycleListenerImpl(deviceContext);
statListForCollectingInitialization();
this.state = CONTEXT_STATE.INITIALIZATION;
this.deviceInfo = deviceContext.getDeviceInfo();
this.myManager = myManager;
this.lastDataGathering = null;
this.statisticsWriterProvider = statisticsWriterProvider;
}
@Override
public void statListForCollectingInitialization() {
synchronized (collectionStatTypeLock) {
final List<MultipartType> statListForCollecting = new ArrayList<>();
if (devState.isTableStatisticsAvailable()) {
statListForCollecting.add(MultipartType.OFPMPTABLE);
}
if (devState.isFlowStatisticsAvailable()) {
statListForCollecting.add(MultipartType.OFPMPFLOW);
}
if (devState.isGroupAvailable()) {
statListForCollecting.add(MultipartType.OFPMPGROUPDESC);
statListForCollecting.add(MultipartType.OFPMPGROUP);
}
if (devState.isMetersAvailable()) {
statListForCollecting.add(MultipartType.OFPMPMETERCONFIG);
statListForCollecting.add(MultipartType.OFPMPMETER);
}
if (devState.isPortStatisticsAvailable()) {
statListForCollecting.add(MultipartType.OFPMPPORTSTATS);
}
if (devState.isQueueStatisticsAvailable()) {
statListForCollecting.add(MultipartType.OFPMPQUEUE);
}
collectingStatType = ImmutableList.<MultipartType>copyOf(statListForCollecting);
}
}
@Override
public ListenableFuture<Boolean> initialGatherDynamicData() {
return gatherDynamicData(true);
}
@Override
public ListenableFuture<Boolean> gatherDynamicData(){
return gatherDynamicData(false);
}
private ListenableFuture<Boolean> gatherDynamicData(final boolean initial) {
this.lastDataGathering = null;
if (!isStatisticsPollingOn) {
LOG.debug("Statistics for device {} is not enabled.", getDeviceInfo().getNodeId().getValue());
return Futures.immediateFuture(Boolean.TRUE);
}
final ListenableFuture<Boolean> errorResultFuture = deviceConnectionCheck();
if (errorResultFuture != null) {
return errorResultFuture;
}
synchronized (collectionStatTypeLock) {
final Iterator<MultipartType> statIterator = collectingStatType.iterator();
final SettableFuture<Boolean> settableStatResultFuture = SettableFuture.create();
// write start timestamp to state snapshot container
StatisticsGatheringUtils.markDeviceStateSnapshotStart(deviceContext);
statChainFuture(statIterator, settableStatResultFuture, initial);
// write end timestamp to state snapshot container
Futures.addCallback(settableStatResultFuture, new FutureCallback<Boolean>() {
@Override
public void onSuccess(@Nullable final Boolean result) {
StatisticsGatheringUtils.markDeviceStateSnapshotEnd(deviceContext, true);
}
@Override
public void onFailure(final Throwable t) {
if (!(t instanceof TransactionChainClosedException)) {
StatisticsGatheringUtils.markDeviceStateSnapshotEnd(deviceContext, false);
}
}
});
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:
result = collectFlowStatistics(multipartType, initial);
break;
case OFPMPTABLE:
result = collectTableStatistics(multipartType);
break;
case OFPMPPORTSTATS:
result = collectPortStatistics(multipartType);
break;
case OFPMPQUEUE:
result = collectQueueStatistics(multipartType);
break;
case OFPMPGROUPDESC:
result = collectGroupDescStatistics(multipartType);
break;
case OFPMPGROUP:
result = collectGroupStatistics(multipartType);
break;
case OFPMPMETERCONFIG:
result = collectMeterConfigStatistics(multipartType);
break;
case OFPMPMETER:
result = collectMeterStatistics(multipartType);
break;
default:
LOG.warn("Unsupported Statistics type {}", multipartType);
}
return result;
}
@Override
public <T> RequestContext<T> createRequestContext() {
final AbstractRequestContext<T> ret = new AbstractRequestContext<T>(deviceInfo.reserveXidForDeviceMessage()) {
@Override
public void close() {
requestContexts.remove(this);
}
};
requestContexts.add(ret);
return ret;
}
@Override
public void close() {
if (CONTEXT_STATE.TERMINATION.equals(getState())) {
if (LOG.isDebugEnabled()) {
LOG.debug("StatisticsContext for node {} is already in TERMINATION state.", getDeviceInfo().getLOGValue());
}
} else {
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();
}
}
}
@Override
public void setSchedulingEnabled(final boolean schedulingEnabled) {
this.schedulingEnabled = schedulingEnabled;
}
@Override
public boolean isSchedulingEnabled() {
return schedulingEnabled;
}
@Override
public void setPollTimeout(final Timeout pollTimeout) {
this.pollTimeout = pollTimeout;
}
@Override
public Optional<Timeout> getPollTimeout() {
return Optional.ofNullable(pollTimeout);
}
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());
LOG.debug(errMsg);
resultFuture.setException(new ConnectionException(errMsg));
return;
}
if (!iterator.hasNext()) {
if (initial) {
Futures.addCallback(StatisticsGatheringUtils.gatherStatistics(
statisticsGatheringService,
getDeviceInfo(),
MultipartType.OFPMPPORTDESC,
deviceContext,
deviceContext,
false,
convertorExecutor,
statisticsWriterProvider), new FutureCallback<Boolean>() {
@Override
public void onSuccess(final Boolean result) {
statChainFuture(iterator, resultFuture, false);
}
@Override
public void onFailure(@Nonnull final Throwable t) {
resultFuture.setException(t);
}
});
return;
}
resultFuture.set(Boolean.TRUE);
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().getLOGValue(), nextType);
final ListenableFuture<Boolean> deviceStatisticsCollectionFuture = chooseStat(nextType, initial);
Futures.addCallback(deviceStatisticsCollectionFuture, new FutureCallback<Boolean>() {
@Override
public void onSuccess(final Boolean result) {
statChainFuture(iterator, resultFuture, initial);
}
@Override
public void onFailure(@Nonnull final Throwable t) {
resultFuture.setException(t);
}
});
}
/**
* 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 future
*/
@VisibleForTesting
ListenableFuture<Boolean> deviceConnectionCheck() {
if (!ConnectionContext.CONNECTION_STATE.WORKING.equals(deviceContext.getPrimaryConnectionContext().getConnectionState())) {
ListenableFuture<Boolean> resultingFuture;
switch (deviceContext.getPrimaryConnectionContext().getConnectionState()) {
case RIP:
final String errMsg = String.format("Device connection doesn't exist anymore. Primary connection status : %s",
deviceContext.getPrimaryConnectionContext().getConnectionState());
resultingFuture = Futures.immediateFailedFuture(new Throwable(errMsg));
break;
default:
resultingFuture = Futures.immediateCheckedFuture(Boolean.TRUE);
break;
}
return resultingFuture;
}
return null;
}
//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,
convertorExecutor,
statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectTableStatistics(final MultipartType multipartType) {
return devState.isTableStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
statisticsGatheringService,
getDeviceInfo(),
/*MultipartType.OFPMPTABLE*/ multipartType,
deviceContext,
deviceContext,
false,
convertorExecutor,
statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectPortStatistics(final MultipartType multipartType) {
return devState.isPortStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
statisticsGatheringService,
getDeviceInfo(),
/*MultipartType.OFPMPPORTSTATS*/ multipartType,
deviceContext,
deviceContext,
false,
convertorExecutor,
statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectQueueStatistics(final MultipartType multipartType) {
return !devState.isQueueStatisticsAvailable() ? emptyFuture : StatisticsGatheringUtils.gatherStatistics(
statisticsGatheringService,
getDeviceInfo(),
/*MultipartType.OFPMPQUEUE*/ multipartType,
deviceContext,
deviceContext,
false,
convertorExecutor,
statisticsWriterProvider);
}
private ListenableFuture<Boolean> collectGroupDescStatistics(final MultipartType multipartType) {
return devState.isGroupAvailable() ? StatisticsGatheringUtils.gatherStatistics(
statisticsGatheringService,
getDeviceInfo(),
/*MultipartType.OFPMPGROUPDESC*/ multipartType,
deviceContext,
deviceContext,
false,
convertorExecutor,
statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectGroupStatistics(final MultipartType multipartType) {
return devState.isGroupAvailable() ? StatisticsGatheringUtils.gatherStatistics(
statisticsGatheringService,
getDeviceInfo(),
/*MultipartType.OFPMPGROUP*/ multipartType,
deviceContext,
deviceContext,
false,
convertorExecutor,
statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectMeterConfigStatistics(final MultipartType multipartType) {
return devState.isMetersAvailable() ? StatisticsGatheringUtils.gatherStatistics(
statisticsGatheringService,
getDeviceInfo(),
/*MultipartType.OFPMPMETERCONFIG*/ multipartType,
deviceContext,
deviceContext,
false,
convertorExecutor,
statisticsWriterProvider) : emptyFuture;
}
private ListenableFuture<Boolean> collectMeterStatistics(final MultipartType multipartType) {
return devState.isMetersAvailable() ? StatisticsGatheringUtils.gatherStatistics(
statisticsGatheringService,
getDeviceInfo(),
/*MultipartType.OFPMPMETER*/ multipartType,
deviceContext,
deviceContext,
false,
convertorExecutor,
statisticsWriterProvider) : emptyFuture;
}
@VisibleForTesting
void setStatisticsGatheringService(final StatisticsGatheringService<T> statisticsGatheringService) {
this.statisticsGatheringService = statisticsGatheringService;
}
@VisibleForTesting
void setStatisticsGatheringOnTheFlyService(final StatisticsGatheringOnTheFlyService<T> statisticsGatheringOnTheFlyService) {
this.statisticsGatheringOnTheFlyService = statisticsGatheringOnTheFlyService;
}
@Override
public ItemLifecycleListener getItemLifeCycleListener () {
return itemLifeCycleListener;
}
@Override
public CONTEXT_STATE getState() {
return this.state;
}
@Override
public ServiceGroupIdentifier getServiceIdentifier() {
return this.deviceInfo.getServiceIdentifier();
}
@Override
public DeviceInfo getDeviceInfo() {
return this.deviceInfo;
}
@Override
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 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) {
mastershipChangeListener.onMasterRoleAcquired(
deviceInfo,
ContextChainMastershipState.INITIAL_GATHERING
);
if (initialSubmitHandler.initialSubmitTransaction()) {
mastershipChangeListener.onMasterRoleAcquired(
deviceInfo,
ContextChainMastershipState.INITIAL_SUBMIT
);
if (isStatisticsPollingOn) {
myManager.startScheduling(deviceInfo);
}
} else {
mastershipChangeListener.onNotAbleToStartMastershipMandatory(
deviceInfo,
"Initial transaction cannot be submitted."
);
}
}
@Override
public void onFailure(@Nonnull Throwable throwable) {
mastershipChangeListener.onNotAbleToStartMastershipMandatory(
deviceInfo,
"Initial gathering statistics unsuccessful."
);
}
});
return this.clusterInitializationPhaseHandler.onContextInstantiateService(mastershipChangeListener);
}
@Override
public void setInitialSubmitHandler(final ClusterInitializationPhaseHandler initialSubmitHandler) {
this.initialSubmitHandler = initialSubmitHandler;
}
}