BUG-4084: Li:Save flows in operational based on barrier success
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / statistics / StatisticsContextImpl.java
index 96a0ca4ebba70f3f12ea99641c83d20303696cfe..301d0061fbd97c226ea5ce413489da571eca6589 100644 (file)
@@ -8,31 +8,33 @@
 
 package org.opendaylight.openflowplugin.impl.statistics;
 
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
 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 com.sun.org.apache.xpath.internal.operations.Bool;
+import io.netty.util.Timeout;
 import java.util.ArrayList;
-import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Iterator;
 import java.util.List;
+import javax.annotation.CheckForNull;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
+import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
-import org.opendaylight.openflowplugin.impl.rpc.RequestContextImpl;
+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.statistics.services.dedicated.StatisticsGatheringOnTheFlyService;
 import org.opendaylight.openflowplugin.impl.statistics.services.dedicated.StatisticsGatheringService;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAllFlowsStatisticsFromAllFlowTablesInputBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
-import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -42,119 +44,215 @@ import org.slf4j.LoggerFactory;
 public class StatisticsContextImpl implements StatisticsContext {
 
     private static final Logger LOG = LoggerFactory.getLogger(StatisticsContextImpl.class);
-    public static final String CONNECTION_CLOSED = "Connection closed.";
-    private final List<RequestContext> requestContexts = new ArrayList();
-    private final DeviceContext deviceContext;
+    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 List<MultipartType> collectingStatType;
 
-    private final StatisticsGatheringService statisticsGatheringService;
+    private StatisticsGatheringService statisticsGatheringService;
+    private StatisticsGatheringOnTheFlyService statisticsGatheringOnTheFlyService;
+    private Timeout pollTimeout;
 
-    public StatisticsContextImpl(final DeviceContext deviceContext) {
-        this.deviceContext = deviceContext;
+    public StatisticsContextImpl(@CheckForNull final DeviceContext deviceContext) {
+        this.deviceContext = Preconditions.checkNotNull(deviceContext);
+        devState = Preconditions.checkNotNull(deviceContext.getDeviceState());
+        emptyFuture = Futures.immediateFuture(new Boolean(false));
         statisticsGatheringService = new StatisticsGatheringService(this, deviceContext);
+        statisticsGatheringOnTheFlyService = new StatisticsGatheringOnTheFlyService(this, deviceContext);
 
-    }
-
-    private void pollFlowStatistics() {
-        final KeyedInstanceIdentifier<Node, NodeKey> nodeII = InstanceIdentifier.create(Nodes.class).child(Node.class, new NodeKey(deviceContext.getPrimaryConnectionContext().getNodeId()));
-        final NodeRef nodeRef = new NodeRef(nodeII);
-        final GetAllFlowsStatisticsFromAllFlowTablesInputBuilder builder =
-                new GetAllFlowsStatisticsFromAllFlowTablesInputBuilder();
-        builder.setNode(nodeRef);
-        //TODO : process data from result
+        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);
+        itemLifeCycleListener = new ItemLifecycleListenerImpl(deviceContext);
     }
 
     @Override
     public ListenableFuture<Boolean> gatherDynamicData() {
+        final ListenableFuture<Boolean> errorResultFuture = deviceConnectionCheck();
+        if (errorResultFuture != null) {
+            return errorResultFuture;
+        }
+        final Iterator<MultipartType> statIterator = collectingStatType.iterator();
+        final SettableFuture<Boolean> settableStatResultFuture = SettableFuture.create();
+        statChainFuture(statIterator, settableStatResultFuture);
+        return settableStatResultFuture;
+    }
 
+    private ListenableFuture<Boolean> chooseStat(final MultipartType multipartType) {
+        switch (multipartType) {
+            case OFPMPFLOW:
+                return collectFlowStatistics(multipartType);
+            case OFPMPTABLE:
+                return collectTableStatistics(multipartType);
+            case OFPMPPORTSTATS:
+                return collectPortStatistics(multipartType);
+            case OFPMPQUEUE:
+                return collectQueueStatistics(multipartType);
+            case OFPMPGROUPDESC:
+                return collectGroupDescStatistics(multipartType);
+            case OFPMPGROUP:
+                return collectGroupStatistics(multipartType);
+            case OFPMPMETERCONFIG:
+                return collectMeterConfigStatistics(multipartType);
+            case OFPMPMETER:
+                return collectMeterStatistics(multipartType);
+            default:
+                LOG.warn("Unsuported Statistics type {}", multipartType);
+                return Futures.immediateCheckedFuture(Boolean.TRUE);
+        }
+    }
 
-        final SettableFuture settableResultingFuture = SettableFuture.create();
-        ListenableFuture<Boolean> resultingFuture = settableResultingFuture ;
-
-        if (ConnectionContext.CONNECTION_STATE.WORKING.equals(deviceContext.getPrimaryConnectionContext().getConnectionState())) {
-            final DeviceState devState = deviceContext.getDeviceState();
-            ListenableFuture<Boolean> emptyFuture = Futures.immediateFuture(new Boolean(false));
-            final ListenableFuture<Boolean> flowStatistics = devState.isFlowStatisticsAvailable() ? wrapLoggingOnStatisticsRequestCall(MultipartType.OFPMPFLOW) : emptyFuture;
-
-            final ListenableFuture<Boolean> tableStatistics = devState.isTableStatisticsAvailable() ? wrapLoggingOnStatisticsRequestCall(MultipartType.OFPMPTABLE) : emptyFuture;
-
-            final ListenableFuture<Boolean> portStatistics = devState.isPortStatisticsAvailable() ? wrapLoggingOnStatisticsRequestCall(MultipartType.OFPMPPORTSTATS) : emptyFuture;
+    @Override
+    public <T> RequestContext<T> createRequestContext() {
+        final AbstractRequestContext<T> ret = new AbstractRequestContext<T>(deviceContext.getReservedXid()) {
+            @Override
+            public void close() {
+                requestContexts.remove(this);
+            }
+        };
+        requestContexts.add(ret);
+        return ret;
+    }
 
-            final ListenableFuture<Boolean> queueStatistics = devState.isQueueStatisticsAvailable() ? wrapLoggingOnStatisticsRequestCall(MultipartType.OFPMPQUEUE) : emptyFuture;
+    @Override
+    public void close() {
+        for (final RequestContext<?> requestContext : requestContexts) {
+            RequestContextUtil.closeRequestContextWithRpcError(requestContext, CONNECTION_CLOSED);
+        }
+        if (null != pollTimeout && !pollTimeout.isExpired()) {
+            pollTimeout.cancel();
+        }
+    }
 
-            final ListenableFuture<Boolean> groupDescStatistics = devState.isGroupAvailable() ? wrapLoggingOnStatisticsRequestCall(MultipartType.OFPMPGROUPDESC) : emptyFuture;
-            final ListenableFuture<Boolean> groupStatistics = devState.isGroupAvailable() ? wrapLoggingOnStatisticsRequestCall(MultipartType.OFPMPGROUP) : emptyFuture;
+    @Override
+    public void setPollTimeout(Timeout pollTimeout) {
+        this.pollTimeout = pollTimeout;
+    }
 
-            final ListenableFuture<Boolean> meterConfigStatistics = devState.isMetersAvailable() ? wrapLoggingOnStatisticsRequestCall(MultipartType.OFPMPMETERCONFIG) : emptyFuture;
-            final ListenableFuture<Boolean> meterStatistics = devState.isMetersAvailable() ? wrapLoggingOnStatisticsRequestCall(MultipartType.OFPMPMETER) : emptyFuture;
+    @Override
+    public Optional<Timeout> getPollTimeout() {
+        return Optional.fromNullable(pollTimeout);
+    }
 
+    void statChainFuture(final Iterator<MultipartType> iterator, final SettableFuture<Boolean> resultFuture) {
+        if ( ! iterator.hasNext()) {
+            resultFuture.set(Boolean.TRUE);
+            return;
+        }
+        final ListenableFuture<Boolean> deviceStatisticsCollectionFuture = chooseStat(iterator.next());
+        Futures.addCallback(deviceStatisticsCollectionFuture, new FutureCallback<Boolean>() {
+            @Override
+            public void onSuccess(final Boolean result) {
+                statChainFuture(iterator, resultFuture);
+            }
+            @Override
+            public void onFailure(final Throwable t) {
+                resultFuture.setException(t);
+            }
+        });
+    }
 
-            final ListenableFuture<List<Boolean>> allFutures = Futures.allAsList(Arrays.asList(flowStatistics, tableStatistics, groupDescStatistics, groupStatistics, meterConfigStatistics, meterStatistics, portStatistics, queueStatistics));
-            Futures.addCallback(allFutures, new FutureCallback<List<Boolean>>() {
-                @Override
-                public void onSuccess(final List<Boolean> booleans) {
-                    boolean atLeastOneSuccess = false;
-                    for (Boolean bool : booleans) {
-                        atLeastOneSuccess |= bool.booleanValue();
-                    }
-                    settableResultingFuture.set(new Boolean(atLeastOneSuccess));
-                }
-                @Override
-                public void onFailure(final Throwable throwable) {
-                    settableResultingFuture.setException(throwable);
-                }
-            });
-        } else {
+    /**
+     * 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
+     */
+    @VisibleForTesting
+    ListenableFuture<Boolean> deviceConnectionCheck() {
+        if (!ConnectionContext.CONNECTION_STATE.WORKING.equals(deviceContext.getPrimaryConnectionContext().getConnectionState())) {
+            ListenableFuture<Boolean> resultingFuture = SettableFuture.create();
             switch (deviceContext.getPrimaryConnectionContext().getConnectionState()) {
                 case RIP:
-                    resultingFuture = Futures.immediateFailedFuture(new Throwable(String.format("Device connection doesn't exist anymore. Primary connection status : %s", deviceContext.getPrimaryConnectionContext().getConnectionState())));
+                    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;
+    }
 
+    private ListenableFuture<Boolean> collectFlowStatistics(final MultipartType multipartType) {
+        return devState.isFlowStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
+                statisticsGatheringOnTheFlyService, deviceContext, /*MultipartType.OFPMPFLOW*/ multipartType) : emptyFuture;
+    }
 
-        }
-        return resultingFuture;
+    private ListenableFuture<Boolean> collectTableStatistics(final MultipartType multipartType) {
+        return devState.isTableStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
+                statisticsGatheringService, deviceContext, /*MultipartType.OFPMPTABLE*/ multipartType) : emptyFuture;
     }
 
-    private ListenableFuture<Boolean> wrapLoggingOnStatisticsRequestCall(final MultipartType type) {
-        final ListenableFuture<Boolean> future = StatisticsGatheringUtils.gatherStatistics(statisticsGatheringService, deviceContext, type);
-        Futures.addCallback(future, new FutureCallback() {
-            @Override
-            public void onSuccess(final Object o) {
-                LOG.trace("Multipart response for {} was successful.", type);
-            }
+    private ListenableFuture<Boolean> collectPortStatistics(final MultipartType multipartType) {
+        return devState.isPortStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
+                statisticsGatheringService, deviceContext, /*MultipartType.OFPMPPORTSTATS*/ multipartType) : emptyFuture;
+    }
 
-            @Override
-            public void onFailure(final Throwable throwable) {
-                LOG.trace("Multipart response for {} FAILED.", type, throwable);
-            }
-        });
-        return future;
+    private ListenableFuture<Boolean> collectQueueStatistics(final MultipartType multipartType) {
+        return devState.isQueueStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
+                statisticsGatheringService, deviceContext, /*MultipartType.OFPMPQUEUE*/ multipartType) : emptyFuture;
     }
 
-    @Override
-    public <T> void forgetRequestContext(final RequestContext<T> requestContext) {
-        requestContexts.remove(requestContexts);
+    private ListenableFuture<Boolean> collectGroupDescStatistics(final MultipartType multipartType) {
+        return devState.isGroupAvailable() ? StatisticsGatheringUtils.gatherStatistics(
+                statisticsGatheringService, deviceContext, /*MultipartType.OFPMPGROUPDESC*/ multipartType) : emptyFuture;
     }
 
-    @Override
-    public <T> SettableFuture<RpcResult<T>> storeOrFail(final RequestContext<T> data) {
-        requestContexts.add(data);
-        return data.getFuture();
+    private ListenableFuture<Boolean> collectGroupStatistics(final MultipartType multipartType) {
+        return devState.isGroupAvailable() ? StatisticsGatheringUtils.gatherStatistics(
+                statisticsGatheringService, deviceContext, /*MultipartType.OFPMPGROUP*/ multipartType) : emptyFuture;
     }
 
-    @Override
-    public <T> RequestContext<T> createRequestContext() {
-        return new RequestContextImpl<>(this);
+    private ListenableFuture<Boolean> collectMeterConfigStatistics(final MultipartType multipartType) {
+        return devState.isMetersAvailable() ? StatisticsGatheringUtils.gatherStatistics(
+                statisticsGatheringService, deviceContext, /*MultipartType.OFPMPMETERCONFIG*/ multipartType) : emptyFuture;
+    }
+
+    private ListenableFuture<Boolean> collectMeterStatistics(final MultipartType multipartType) {
+        return devState.isMetersAvailable() ? StatisticsGatheringUtils.gatherStatistics(
+                statisticsGatheringService, deviceContext, /*MultipartType.OFPMPMETER*/ multipartType) : emptyFuture;
+    }
+
+    @VisibleForTesting
+    protected void setStatisticsGatheringService(StatisticsGatheringService statisticsGatheringService) {
+        this.statisticsGatheringService = statisticsGatheringService;
+    }
+
+    @VisibleForTesting
+    protected void setStatisticsGatheringOnTheFlyService(StatisticsGatheringOnTheFlyService
+                                                             statisticsGatheringOnTheFlyService) {
+        this.statisticsGatheringOnTheFlyService = statisticsGatheringOnTheFlyService;
     }
 
     @Override
-    public void close() throws Exception {
-        for (RequestContext requestContext : requestContexts) {
-            RequestContextUtil.closeRequestContextWithRpcError(requestContext, CONNECTION_CLOSED);
-        }
+    public ItemLifecycleListener getItemLifeCycleListener() {
+        return itemLifeCycleListener;
     }
 }