tidy up addFlow futures
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / services / SalFlowServiceImpl.java
index fba5816a548cc19419837f704744bbbe8fce61f5..19895116001e2a5a6f206509ea3208f3fec5ab24 100644 (file)
@@ -13,21 +13,22 @@ import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.JdkFutureAdapters;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.SettableFuture;
-import java.math.BigInteger;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Iterator;
 import java.util.List;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
+import org.opendaylight.openflowplugin.api.OFConstants;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
-import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowHash;
+import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
 import org.opendaylight.openflowplugin.impl.registry.flow.FlowDescriptorFactory;
 import org.opendaylight.openflowplugin.impl.registry.flow.FlowHashFactory;
+import org.opendaylight.openflowplugin.impl.util.FlowUtil;
 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.FlowConvertor;
 import org.opendaylight.openflowplugin.openflow.md.util.FlowCreatorUtil;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
@@ -44,6 +45,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.Upda
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.OriginalFlow;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.UpdatedFlow;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInputBuilder;
 import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
@@ -59,47 +61,37 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
         super(requestContextStack, deviceContext);
     }
 
-    <T, F> ListenableFuture<RpcResult<T>> handleServiceCall(final BigInteger connectionID,
-                                                            final FlowModInputBuilder flowModInputBuilder, final Function<DataCrate<T>, ListenableFuture<RpcResult<F>>> function) {
-        LOG.debug("Calling the FlowMod RPC method on MessageDispatchService");
-
-        final RequestContext<T> requestContext = requestContextStack.createRequestContext();
-        final SettableFuture<RpcResult<T>> result = requestContextStack.storeOrFail(requestContext);
-        final DataCrate<T> dataCrate = DataCrateBuilder.<T>builder().setiDConnection(connectionID)
-                .setRequestContext(requestContext).setFlowModInputBuilder(flowModInputBuilder).build();
-
-        if (!result.isDone()) {
-            final ListenableFuture<RpcResult<F>> resultFromOFLib = function.apply(dataCrate);
-
-            final OFJResult2RequestCtxFuture<T> OFJResult2RequestCtxFuture = new OFJResult2RequestCtxFuture<>(requestContext, deviceContext);
-            OFJResult2RequestCtxFuture.processResultFromOfJava(resultFromOFLib);
-
-        } else {
-            RequestContextUtil.closeRequstContext(requestContext);
-        }
-        return result;
-    }
-
     @Override
     public Future<RpcResult<AddFlowOutput>> addFlow(final AddFlowInput input) {
+        final FlowId flowId;
+        if (null != input.getFlowRef()) {
+            flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
+        } else {
+            flowId = FlowUtil.createAlienFlowId(input.getTableId());
+        }
 
-        final FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
 
         final FlowHash flowHash = FlowHashFactory.create(input);
         final FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId);
         deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
 
         final List<FlowModInputBuilder> ofFlowModInputs = FlowConvertor.toFlowModInputs(input, version, datapathId);
-        final ListenableFuture future = processFlowModInputBuilders(ofFlowModInputs);
+        final ListenableFuture<RpcResult<AddFlowOutput>> future = processFlowModInputBuilders(ofFlowModInputs);
 
-        Futures.addCallback(future, new FutureCallback() {
+        Futures.addCallback(future, new FutureCallback<RpcResult<AddFlowOutput>>() {
             @Override
-            public void onSuccess(final Object o) {
-                LOG.debug("flow add finished without error, id={}", flowId.getValue());
+            public void onSuccess(final RpcResult<AddFlowOutput> rpcResult) {
+                messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
+                if (rpcResult.isSuccessful()) {
+                    LOG.debug("flow add finished without error, id={}", flowId.getValue());
+                } else {
+                    LOG.debug("flow add failed with error, id={}", flowId.getValue());
+                }
             }
 
             @Override
             public void onFailure(final Throwable throwable) {
+                messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
                 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
                 LOG.trace("Service call for adding flows failed, id={}.", flowId.getValue(), throwable);
             }
@@ -121,12 +113,14 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
                         Futures.addCallback(future, new FutureCallback() {
                             @Override
                             public void onSuccess(final Object o) {
+                                messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
                                 FlowHash flowHash = FlowHashFactory.create(input);
                                 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
                             }
 
                             @Override
                             public void onFailure(final Throwable throwable) {
+                                messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
                                 StringBuffer errors = new StringBuffer();
                                 try {
                                     RpcResult<Void> result = future.get();
@@ -176,6 +170,7 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
         Futures.addCallback(future, new FutureCallback() {
             @Override
             public void onSuccess(final Object o) {
+                messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
                 FlowHash flowHash = FlowHashFactory.create(original);
                 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
 
@@ -188,7 +183,7 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
 
             @Override
             public void onFailure(final Throwable throwable) {
-
+                messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
             }
         });
         return future;
@@ -197,55 +192,93 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
     private <T> ListenableFuture<RpcResult<T>> processFlowModInputBuilders(
             final List<FlowModInputBuilder> ofFlowModInputs) {
         final List<ListenableFuture<RpcResult<T>>> partialFutures = new ArrayList<>();
+
         for (FlowModInputBuilder flowModInputBuilder : ofFlowModInputs) {
-            ListenableFuture<RpcResult<T>> partialFuture = handleServiceCall(PRIMARY_CONNECTION, flowModInputBuilder,
+            DataCrateBuilder<T> dataCrateBuilder = DataCrateBuilder.<T>builder().setFlowModInputBuilder(flowModInputBuilder);
+            ListenableFuture<RpcResult<T>> partialFuture = handleServiceCall(
+                    PRIMARY_CONNECTION,
                     new Function<DataCrate<T>, ListenableFuture<RpcResult<Void>>>() {
                         @Override
                         public ListenableFuture<RpcResult<Void>> apply(final DataCrate<T> data) {
                             return createResultForFlowMod(data);
                         }
-                    });
+                    },
+                    dataCrateBuilder
+            );
             partialFutures.add(partialFuture);
         }
 
-        final ListenableFuture<List<RpcResult<T>>> allFutures = Futures.allAsList(partialFutures);
+        // processing of final (optionally composite future)
+        final ListenableFuture<List<RpcResult<T>>> allFutures = Futures.successfulAsList(partialFutures);
         final SettableFuture<RpcResult<T>> finalFuture = SettableFuture.create();
         Futures.addCallback(allFutures, new FutureCallback<List<RpcResult<T>>>() {
             @Override
             public void onSuccess(List<RpcResult<T>> results) {
-                Iterator<FlowModInputBuilder> flowModInputBldIterator = ofFlowModInputs.iterator();
                 List<RpcError> rpcErrorLot = new ArrayList<>();
-                for (RpcResult<T> rpcResult : results) {
+                RpcResultBuilder<T> resultBuilder;
+
+                Iterator<FlowModInputBuilder> flowModInputBldIterator = ofFlowModInputs.iterator();
+                Iterator<RpcResult<T>> resultIterator = results.iterator();
+
+                for (ListenableFuture<RpcResult<T>> partFutureFromRqCtx : partialFutures) {
                     FlowModInputBuilder flowModInputBld = flowModInputBldIterator.next();
-                    if (rpcResult.isSuccessful()) {
-                        Long xid = flowModInputBld.getXid();
-                        LOG.warn("Positive confirmation of flow push is not supported by OF-spec");
-                        LOG.warn("flow future result was successful [{}] = this should have never happen",
-                                xid);
-                        rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
-                                "flow future result was successful ["+xid+"] = this should have never happen"));
-                    } else {
-                        rpcErrorLot.addAll(rpcResult.getErrors());
+                    RpcResult<T> result = resultIterator.next();
+                    Long xid = flowModInputBld.getXid();
+
+
+                    LOG.trace("flowMod future processing [{}], result={}", xid, result);
+                    if (partFutureFromRqCtx.isCancelled()) { // one and only positive case
+                        if (LOG.isTraceEnabled()) {
+                            LOG.trace("flow future result was cancelled [{}] = barrier passed it without error", xid);
+                        }
+                    } else { // all negative cases
+                        if (result == null) { // there is exception or null value set
+                            try {
+                                partFutureFromRqCtx.get();
+                            } catch (Exception e) {
+                                rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
+                                        "flow future result [" + xid + "] failed with exception",
+                                        OFConstants.APPLICATION_TAG, e.getMessage(), e));
+
+                                // xid might be not available in case requestContext not even stored
+                                if (xid != null) {
+                                    deviceContext.unhookRequestCtx(new Xid(xid));
+                                }
+                            }
+                        } else {
+                            if (result.isSuccessful()) {  // positive confirmation - never happens
+                                LOG.warn("Positive confirmation of flow push is not supported by OF-spec");
+                                LOG.warn("flow future result was successful [{}] = this should have never happen",
+                                        xid);
+                                rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
+                                        "flow future result was successful [" + xid + "] = this should have never happen"));
+                            } else { // standard error occurred
+                                LOG.trace("passing original rpcErrors [{}]", xid);
+                                if (LOG.isTraceEnabled()) {
+                                    for (RpcError rpcError : result.getErrors()) {
+                                        LOG.trace("passed rpcError [{}]: {}", xid, rpcError);
+                                    }
+                                }
+                                rpcErrorLot.addAll(result.getErrors());
+                            }
+                        }
                     }
                 }
-                finalFuture.set(RpcResultBuilder.<T>failed().withRpcErrors(rpcErrorLot).build());
+
+                if (rpcErrorLot.isEmpty()) {
+                    resultBuilder = RpcResultBuilder.<T>success();
+                } else {
+                    resultBuilder = RpcResultBuilder.<T>failed().withRpcErrors(rpcErrorLot);
+                }
+
+                finalFuture.set(resultBuilder.build());
             }
 
             @Override
             public void onFailure(Throwable t) {
                 LOG.trace("Flow mods chained future failed.");
-                RpcResultBuilder<T> resultBuilder;
-                if (allFutures.isCancelled()) {
-                    if (LOG.isTraceEnabled()) {
-                        for (FlowModInputBuilder ofFlowModInput : ofFlowModInputs) {
-                            LOG.trace("flow future result was cancelled [{}] = barrier passed it without error",
-                                    ofFlowModInput.getXid());
-                        }
-                    }
-                    resultBuilder = RpcResultBuilder.<T>success();
-                } else {
-                    resultBuilder = RpcResultBuilder.<T>failed().withError(ErrorType.APPLICATION, "", t.getMessage());
-                }
+                RpcResultBuilder<T> resultBuilder = RpcResultBuilder.<T>failed()
+                        .withError(ErrorType.APPLICATION, "", t.getMessage());
                 finalFuture.set(resultBuilder.build());
             }
         });
@@ -257,12 +290,15 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
         return createResultForFlowMod(data, data.getFlowModInputBuilder());
     }
 
-    protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data, final FlowModInputBuilder flowModInput) {
+    protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data, final FlowModInputBuilder flowModInputBuilder) {
         final Xid xid = data.getRequestContext().getXid();
-        flowModInput.setXid(xid.getValue());
+        flowModInputBuilder.setXid(xid.getValue());
+        final FlowModInput flowModInput = flowModInputBuilder.build();
         Future<RpcResult<Void>> flowModResult = provideConnectionAdapter(data.getiDConnection()).flowMod(
-                flowModInput.build());
-        return JdkFutureAdapters.listenInPoolThread(flowModResult);
+                flowModInput);
+
+        final ListenableFuture<RpcResult<Void>> result = JdkFutureAdapters.listenInPoolThread(flowModResult);
+        return result;
     }
 
 }