flow descriptors should be always stored when addFlow is called
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / services / SalFlowServiceImpl.java
index cc349bc5101927dc9a9f99ec31fdbb91c7e03a26..3912e027980f73e6f9fdedcb1341cb3e7b4cd1dc 100644 (file)
@@ -14,21 +14,20 @@ import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.SettableFuture;
 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.openflowjava.protocol.api.connection.OutboundQueue;
-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.DeviceFlowRegistry;
 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;
@@ -68,19 +67,25 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
 
         final List<FlowModInputBuilder> ofFlowModInputs = FlowConvertor.toFlowModInputs(input, getVersion(), getDatapathId());
         final ListenableFuture<RpcResult<AddFlowOutput>> future = processFlowModInputBuilders(ofFlowModInputs);
+        final FlowId flowId;
+        if (null != input.getFlowRef()) {
+            flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
+        } else {
+            flowId = FlowUtil.createAlienFlowId(input.getTableId());
+        }
 
+        final DeviceContext deviceContext = getDeviceContext();
+        final FlowHash flowHash = FlowHashFactory.create(input, deviceContext.getPrimaryConnectionContext().getFeatures().getVersion());
+        final FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId);
+        deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
         Futures.addCallback(future, new FutureCallback<RpcResult<AddFlowOutput>>() {
 
-            final DeviceContext deviceContext = getDeviceContext();
-            final FlowHash flowHash = FlowHashFactory.create(input, deviceContext.getPrimaryConnectionContext().getFeatures().getVersion());
-            FlowId flowId = null;
+
             @Override
             public void onSuccess(final RpcResult<AddFlowOutput> rpcResult) {
                 if (rpcResult.isSuccessful()) {
-                    getMessageSpy().spyMessage(FlowModInput.class, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_SUCCESS);
                     LOG.debug("flow add finished without error, id={}", flowId.getValue());
                 } else {
-                    getMessageSpy().spyMessage(FlowModInput.class, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_FAILURE);
                     LOG.debug("flow add failed with error, id={}", flowId.getValue());
                 }
             }
@@ -88,7 +93,6 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
             @Override
             public void onFailure(final Throwable throwable) {
                 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
-                getMessageSpy().spyMessage(FlowModInput.class, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_FAILURE);
                 LOG.trace("Service call for adding flows failed, id={}.", flowId.getValue(), throwable);
             }
         });
@@ -99,15 +103,15 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
     @Override
     public Future<RpcResult<RemoveFlowOutput>> removeFlow(final RemoveFlowInput input) {
         LOG.trace("Calling remove flow for flow with ID ={}.", input.getFlowRef());
-        return this.<RemoveFlowOutput, Void>handleServiceCall(new Function<DataCrate<RemoveFlowOutput>, ListenableFuture<RpcResult<Void>>>() {
+        return this.<RemoveFlowOutput, Void>handleServiceCall(new Function<RequestContext<RemoveFlowOutput>, ListenableFuture<RpcResult<Void>>>() {
             @Override
-            public ListenableFuture<RpcResult<Void>> apply(final DataCrate<RemoveFlowOutput> data) {
+            public ListenableFuture<RpcResult<Void>> apply(final RequestContext<RemoveFlowOutput> requestContext) {
                 final FlowModInputBuilder ofFlowModInput = FlowConvertor.toFlowModInput(input, getVersion(),
                         getDatapathId());
-                final ListenableFuture<RpcResult<Void>> future = createResultForFlowMod(data, ofFlowModInput);
-                Futures.addCallback(future, new FutureCallback() {
+                final ListenableFuture<RpcResult<Void>> future = createResultForFlowMod(requestContext, ofFlowModInput);
+                Futures.addCallback(future, new FutureCallback<RpcResult<Void>>() {
                     @Override
-                    public void onSuccess(final Object o) {
+                    public void onSuccess(final RpcResult<Void> o) {
                         final DeviceContext deviceContext = getDeviceContext();
                         getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_SUCCESS);
                         FlowHash flowHash = FlowHashFactory.create(input, deviceContext.getPrimaryConnectionContext().getFeatures().getVersion());
@@ -118,7 +122,7 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
                     public void onFailure(final Throwable throwable) {
                         getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_FAILURE);
                         LOG.trace("Flow modification failed..", throwable);
-                        StringBuffer errors = new StringBuffer();
+                        StringBuilder errors = new StringBuilder();
                         try {
                             RpcResult<Void> result = future.get();
                             Collection<RpcError> rpcErrors = result.getErrors();
@@ -164,10 +168,10 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
         }
 
         allFlowMods.addAll(ofFlowModInputs);
-        ListenableFuture future = processFlowModInputBuilders(allFlowMods);
-        Futures.addCallback(future, new FutureCallback() {
+        ListenableFuture<RpcResult<UpdateFlowOutput>> future = processFlowModInputBuilders(allFlowMods);
+        Futures.addCallback(future, new FutureCallback<RpcResult<UpdateFlowOutput>>() {
             @Override
-            public void onSuccess(final Object o) {
+            public void onSuccess(final RpcResult<UpdateFlowOutput> o) {
                 final DeviceContext deviceContext = getDeviceContext();
                 getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_SUCCESS);
                 final short version = deviceContext.getPrimaryConnectionContext().getFeatures().getVersion();
@@ -193,106 +197,39 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
 
         final List<ListenableFuture<RpcResult<T>>> partialFutures = new ArrayList<>();
 
-        for (FlowModInputBuilder flowModInputBuilder : ofFlowModInputs) {
-            DataCrateBuilder<T> dataCrateBuilder = DataCrateBuilder.<T>builder().setFlowModInputBuilder(flowModInputBuilder);
+        for (final FlowModInputBuilder flowModInputBuilder : ofFlowModInputs) {
             ListenableFuture<RpcResult<T>> partialFuture = handleServiceCall(
-                    new Function<DataCrate<T>, ListenableFuture<RpcResult<Void>>>() {
+                    new Function<RequestContext<T>, ListenableFuture<RpcResult<Void>>>() {
                         @Override
-                        public ListenableFuture<RpcResult<Void>> apply(final DataCrate<T> data) {
-                            return createResultForFlowMod(data);
+                        public ListenableFuture<RpcResult<Void>> apply(final RequestContext<T> requestContext) {
+                            return createResultForFlowMod(requestContext, flowModInputBuilder);
                         }
-                    },
-                    dataCrateBuilder
-            );
+                    });
             partialFutures.add(partialFuture);
         }
 
-        // 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) {
-                List<RpcError> rpcErrorLot = new ArrayList<>();
-                RpcResultBuilder<T> resultBuilder;
-
-                Iterator<FlowModInputBuilder> flowModInputBldIterator = ofFlowModInputs.iterator();
-                Iterator<RpcResult<T>> resultIterator = results.iterator();
-
-                for (ListenableFuture<RpcResult<T>> partFutureFromRqCtx : partialFutures) {
-                    FlowModInputBuilder flowModInputBld = flowModInputBldIterator.next();
-                    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) {
-                                    final DeviceContext deviceContext = getDeviceContext();
-                                    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());
-                            }
-                        }
-                    }
-                }
-
-                if (rpcErrorLot.isEmpty()) {
-                    resultBuilder = RpcResultBuilder.<T>success();
-                } else {
-                    resultBuilder = RpcResultBuilder.<T>failed().withRpcErrors(rpcErrorLot);
-                }
-
-                finalFuture.set(resultBuilder.build());
+            public void onSuccess(final List<RpcResult<T>> results) {
+                RpcResultBuilder<T> rpcResultBuilder = RpcResultBuilder.success();
+                finalFuture.set(rpcResultBuilder.build());
             }
 
             @Override
-            public void onFailure(Throwable t) {
-                LOG.trace("Flow mods chained future failed.");
-                RpcResultBuilder<T> resultBuilder = RpcResultBuilder.<T>failed()
-                        .withError(ErrorType.APPLICATION, "", t.getMessage());
-                finalFuture.set(resultBuilder.build());
+            public void onFailure(final Throwable t) {
+                RpcResultBuilder<T> rpcResultBuilder = RpcResultBuilder.failed();
+                finalFuture.set(rpcResultBuilder.build());
             }
         });
 
         return finalFuture;
     }
 
-    protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data) {
-        return createResultForFlowMod(data, data.getFlowModInputBuilder());
-    }
-
-    protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data, final FlowModInputBuilder flowModInputBuilder) {
-        final OutboundQueue outboundQueue = getDeviceContext().getPrimaryConnectionContext().getOutboundQueueProvider().getOutboundQueue();
-        long xid = data.getRequestContext().getXid().getValue();
+    protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final RequestContext<T> requestContext, final FlowModInputBuilder flowModInputBuilder) {
+        final OutboundQueue outboundQueue = getDeviceContext().getPrimaryConnectionContext().getOutboundQueueProvider();
+        final long xid = requestContext.getXid().getValue();
         flowModInputBuilder.setXid(xid);
         final FlowModInput flowModInput = flowModInputBuilder.build();
 
@@ -300,12 +237,16 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
         outboundQueue.commitEntry(xid, flowModInput, new FutureCallback<OfHeader>() {
             @Override
             public void onSuccess(final OfHeader ofHeader) {
-                settableFuture.set(RpcResultBuilder.<Void>success().build());
+                RequestContextUtil.closeRequstContext(requestContext);
+                getMessageSpy().spyMessage(FlowModInput.class, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_SUCCESS);
+
+                settableFuture.set(SUCCESSFUL_RPCRESULT);
             }
 
             @Override
             public void onFailure(final Throwable throwable) {
-                RpcResultBuilder rpcResultBuilder = RpcResultBuilder.<Void>failed().withError(ErrorType.APPLICATION, throwable.getMessage());
+                RpcResultBuilder<Void> rpcResultBuilder = RpcResultBuilder.<Void>failed().withError(ErrorType.APPLICATION, throwable.getMessage(), throwable);
+                RequestContextUtil.closeRequstContext(requestContext);
                 settableFuture.set(rpcResultBuilder.build());
             }
         });