Fix RpcResultBuilder/RpcContext raw references
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / services / SalFlowServiceImpl.java
index b0e45a0c112df3ab0960ee5825f7e0132edecbd2..7bf54bcb224976351f217c4e6036a60fadcf1893 100644 (file)
@@ -10,19 +10,18 @@ package org.opendaylight.openflowplugin.impl.services;
 import com.google.common.base.Function;
 import com.google.common.util.concurrent.FutureCallback;
 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.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.openflowjava.protocol.api.connection.OutboundQueue;
 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;
@@ -47,6 +46,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow
 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.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
 import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
 import org.opendaylight.yangtools.yang.common.RpcResult;
@@ -63,6 +63,10 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
 
     @Override
     public Future<RpcResult<AddFlowOutput>> addFlow(final AddFlowInput input) {
+        getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_ENTERED);
+
+        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();
@@ -70,18 +74,13 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
             flowId = FlowUtil.createAlienFlowId(input.getTableId());
         }
 
+        Futures.addCallback(future, new FutureCallback<RpcResult<AddFlowOutput>>() {
 
-        final FlowHash flowHash = FlowHashFactory.create(input, deviceContext);
-        final FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId);
-
-        final List<FlowModInputBuilder> ofFlowModInputs = FlowConvertor.toFlowModInputs(input, version, datapathId);
-        final ListenableFuture<RpcResult<AddFlowOutput>> future = processFlowModInputBuilders(ofFlowModInputs);
+            final DeviceContext deviceContext = getDeviceContext();
+            final FlowHash flowHash = FlowHashFactory.create(input, deviceContext.getPrimaryConnectionContext().getFeatures().getVersion());
 
-        Futures.addCallback(future, new FutureCallback<RpcResult<AddFlowOutput>>() {
             @Override
             public void onSuccess(final RpcResult<AddFlowOutput> rpcResult) {
-                messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
-                deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
                 if (rpcResult.isSuccessful()) {
                     LOG.debug("flow add finished without error, id={}", flowId.getValue());
                 } else {
@@ -91,7 +90,6 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
 
             @Override
             public void onFailure(final Throwable throwable) {
-                messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
                 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
                 LOG.trace("Service call for adding flows failed, id={}.", flowId.getValue(), throwable);
             }
@@ -103,42 +101,44 @@ 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(PRIMARY_CONNECTION,
-                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 RequestContext<RemoveFlowOutput> requestContext) {
+                final FlowModInputBuilder ofFlowModInput = FlowConvertor.toFlowModInput(input, getVersion(),
+                        getDatapathId());
+                final ListenableFuture<RpcResult<Void>> future = createResultForFlowMod(requestContext, ofFlowModInput);
+                Futures.addCallback(future, new FutureCallback<RpcResult<Void>>() {
                     @Override
-                    public ListenableFuture<RpcResult<Void>> apply(final DataCrate<RemoveFlowOutput> data) {
-                        final FlowModInputBuilder ofFlowModInput = FlowConvertor.toFlowModInput(input, version,
-                                datapathId);
-                        final ListenableFuture<RpcResult<Void>> future = createResultForFlowMod(data, ofFlowModInput);
-                        Futures.addCallback(future, new FutureCallback() {
-                            @Override
-                            public void onSuccess(final Object o) {
-                                messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
-                                FlowHash flowHash = FlowHashFactory.create(input, deviceContext);
-                                deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
-                            }
+                    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());
+                        deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
+                    }
 
-                            @Override
-                            public void onFailure(final Throwable throwable) {
-                                messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
-                                StringBuffer errors = new StringBuffer();
-                                try {
-                                    RpcResult<Void> result = future.get();
-                                    Collection<RpcError> rpcErrors = result.getErrors();
-                                    if (null != rpcErrors && rpcErrors.size() > 0) {
-                                        for (RpcError rpcError : rpcErrors) {
-                                            errors.append(rpcError.getMessage());
-                                        }
-                                    }
-                                } catch (InterruptedException | ExecutionException e) {
-                                    LOG.trace("Flow modification failed. Can't read errors from RpcResult.");
+                    @Override
+                    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();
+                        try {
+                            RpcResult<Void> result = future.get();
+                            Collection<RpcError> rpcErrors = result.getErrors();
+                            if (null != rpcErrors && rpcErrors.size() > 0) {
+                                for (RpcError rpcError : rpcErrors) {
+                                    errors.append(rpcError.getMessage());
                                 }
-                                LOG.trace("Flow modification failed. Errors : {}", errors.toString());
                             }
-                        });
-                        return future;
+                        } catch (InterruptedException | ExecutionException e) {
+                            LOG.trace("Flow modification failed. Can't read errors from RpcResult.");
+                        } finally {
+                            LOG.trace("Flow modification failed. Errors : {}", errors.toString());
+                        }
                     }
                 });
+                return future;
+            }
+        });
     }
 
     @Override
@@ -150,155 +150,107 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
         final List<FlowModInputBuilder> allFlowMods = new ArrayList<>();
         List<FlowModInputBuilder> ofFlowModInputs;
 
-        if (!FlowCreatorUtil.canModifyFlow(original, updated, version)) {
+        if (!FlowCreatorUtil.canModifyFlow(original, updated, getVersion())) {
             // We would need to remove original and add updated.
 
             // remove flow
             final RemoveFlowInputBuilder removeflow = new RemoveFlowInputBuilder(original);
             final List<FlowModInputBuilder> ofFlowRemoveInput = FlowConvertor.toFlowModInputs(removeflow.build(),
-                    version, datapathId);
+                    getVersion(), getDatapathId());
             // remove flow should be the first
             allFlowMods.addAll(ofFlowRemoveInput);
             final AddFlowInputBuilder addFlowInputBuilder = new AddFlowInputBuilder(updated);
-            ofFlowModInputs = FlowConvertor.toFlowModInputs(addFlowInputBuilder.build(), version, datapathId);
+            ofFlowModInputs = FlowConvertor.toFlowModInputs(addFlowInputBuilder.build(), getVersion(), getDatapathId());
         } else {
-            ofFlowModInputs = FlowConvertor.toFlowModInputs(updated, version, datapathId);
+            ofFlowModInputs = FlowConvertor.toFlowModInputs(updated, getVersion(), getDatapathId());
         }
 
         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) {
-                messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
-                FlowHash flowHash = FlowHashFactory.create(original, deviceContext);
-                deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
+            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();
+                FlowHash flowHash = FlowHashFactory.create(original, version);
 
-                flowHash = FlowHashFactory.create(updated, deviceContext);
+                FlowHash updatedflowHash = FlowHashFactory.create(updated, version);
                 FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
                 FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(updated.getTableId(), flowId);
-                deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
-
+                final DeviceFlowRegistry deviceFlowRegistry = deviceContext.getDeviceFlowRegistry();
+                deviceFlowRegistry.markToBeremoved(flowHash);
+                deviceFlowRegistry.store(updatedflowHash, flowDescriptor);
             }
 
             @Override
             public void onFailure(final Throwable throwable) {
-                messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
+                getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_FAILURE);
             }
         });
         return future;
     }
 
-    private <T> ListenableFuture<RpcResult<T>> processFlowModInputBuilders(
-            final List<FlowModInputBuilder> ofFlowModInputs) {
+    private <T> ListenableFuture<RpcResult<T>> processFlowModInputBuilders(final List<FlowModInputBuilder> ofFlowModInputs) {
+
         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(
-                    PRIMARY_CONNECTION,
-                    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) {
-                                    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 Xid xid = data.getRequestContext().getXid();
-        flowModInputBuilder.setXid(xid.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();
-        Future<RpcResult<Void>> flowModResult = provideConnectionAdapter(data.getiDConnection()).flowMod(
-                flowModInput);
 
-        final ListenableFuture<RpcResult<Void>> result = JdkFutureAdapters.listenInPoolThread(flowModResult);
-        return result;
+        final SettableFuture<RpcResult<Void>> settableFuture = SettableFuture.create();
+        outboundQueue.commitEntry(xid, flowModInput, new FutureCallback<OfHeader>() {
+            @Override
+            public void onSuccess(final OfHeader ofHeader) {
+                RequestContextUtil.closeRequstContext(requestContext);
+                getDeviceContext().unhookRequestCtx(requestContext.getXid());
+                getMessageSpy().spyMessage(FlowModInput.class, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_SUCCESS);
+
+                settableFuture.set(RpcResultBuilder.<Void>success().build());
+            }
+
+            @Override
+            public void onFailure(final Throwable throwable) {
+                RpcResultBuilder<Void> rpcResultBuilder = RpcResultBuilder.<Void>failed().withError(ErrorType.APPLICATION, throwable.getMessage(), throwable);
+                RequestContextUtil.closeRequstContext(requestContext);
+                getDeviceContext().unhookRequestCtx(requestContext.getXid());
+                settableFuture.set(rpcResultBuilder.build());
+            }
+        });
+        return settableFuture;
     }
 
 }