tidy up addFlow futures 08/18808/3
authorTimotej Kubas <tkubas@cisco.com>
Wed, 22 Apr 2015 09:31:11 +0000 (11:31 +0200)
committerTimotej Kubas <tkubas@cisco.com>
Wed, 22 Apr 2015 10:40:19 +0000 (12:40 +0200)
Change-Id: Ib29873bb207ff6b5ef63f31926c06578ace63ec8
Signed-off-by: Timotej Kubas <tkubas@cisco.com>
openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/BarrierProcessor.java
openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/rpc/RpcContextImpl.java
openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/CommonService.java
openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/OFJResult2RequestCtxFuture.java
openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/SalFlowServiceImpl.java

index feb19cc87ce2e3747758bf4f76c381de47ffced6..cdb2a79a77d160e7f3d2da751f0d606234b09cbb 100644 (file)
@@ -10,6 +10,7 @@ package org.opendaylight.openflowplugin.impl.device;
 
 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.OutstandingMessageExtractor;
+import org.opendaylight.openflowplugin.impl.services.RequestContextUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -41,8 +42,9 @@ public class BarrierProcessor {
         LOG.trace("processing barrier response [{}]", barrierXid);
         RequestContext nextRequestContext;
         while ((nextRequestContext = messageExtractor.extractNextOutstandingMessage(barrierXid)) != null ) {
-            LOG.trace("flushing outstanding request [{}]", nextRequestContext.getXid().getValue());
+            LOG.trace("flushing outstanding request [{}], closing", nextRequestContext.getXid().getValue());
             nextRequestContext.getFuture().cancel(false);
+            RequestContextUtil.closeRequstContext(nextRequestContext);
         }
     }
 }
index dbbffd4bd51193e38881fa1b08a758260f9595de..5e43c184188da2e9f72f824fd94c02b079107619 100644 (file)
@@ -7,8 +7,6 @@
  */
 package org.opendaylight.openflowplugin.impl.rpc;
 
-import org.slf4j.Logger;
-
 import com.google.common.util.concurrent.SettableFuture;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -23,6 +21,7 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
 import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
+import org.slf4j.Logger;
 
 public class RpcContextImpl implements RpcContext {
 
@@ -93,7 +92,7 @@ public class RpcContextImpl implements RpcContext {
     public <T> void forgetRequestContext(final RequestContext<T> requestContext) {
         synchronizedRequestsList.remove(requestContext);
         LOG.trace("Removed request context with xid {}. Context request in list {}.",
-                requestContext.getXid(), synchronizedRequestsList.size());
+                requestContext.getXid().getValue(), synchronizedRequestsList.size());
     }
 
     @Override
index 321b4747e42e955e8bcd039743544a0454b60073..7a60761585dc3a160ad52b665cde744edf3c439e 100644 (file)
@@ -80,15 +80,37 @@ public abstract class CommonService {
         return primaryConnectionAdapter;
     }
 
-    public <T, F> Future<RpcResult<T>> handleServiceCall(final BigInteger connectionID,
-                                                         final Function<DataCrate<T>, ListenableFuture<RpcResult<F>>> function) {
-        LOG.debug("Calling the FlowMod RPC method on MessageDispatchService");
+    /**
+     * @param connectionID connection identifier
+     * @param function     data sender
+     * @param <T>          rpc result backend type
+     * @param <F>          final rpc backend type
+     * @return
+     */
+    public <T, F> ListenableFuture<RpcResult<T>> handleServiceCall(final BigInteger connectionID,
+                                                                            final Function<DataCrate<T>, ListenableFuture<RpcResult<F>>> function) {
+        DataCrateBuilder<T> dataCrateBuilder = DataCrateBuilder.<T>builder();
+        return handleServiceCall(connectionID, function, dataCrateBuilder);
+    }
+
+    /**
+     * @param <T>
+     * @param <F>
+     * @param connectionID
+     * @param function
+     * @param dataCrateBuilder predefined data
+     * @return
+     */
+    public <T, F> ListenableFuture<RpcResult<T>> handleServiceCall(final BigInteger connectionID,
+                                                                   final Function<DataCrate<T>, ListenableFuture<RpcResult<F>>> function,
+                                                                   final DataCrateBuilder<T> dataCrateBuilder) {
+        LOG.debug("Handling general service call");
 
         final RequestContext<T> requestContext = requestContextStack.createRequestContext();
         final SettableFuture<RpcResult<T>> result = requestContextStack.storeOrFail(requestContext);
         if (!result.isDone()) {
-            final DataCrate<T> dataCrate = DataCrateBuilder.<T>builder().setiDConnection(connectionID)
-                    .setRequestContext(requestContext).build();
+            DataCrate<T> dataCrate = dataCrateBuilder.setiDConnection(connectionID).setRequestContext(requestContext)
+                    .build();
             requestContext.setXid(deviceContext.getNextXid());
 
             LOG.trace("Hooking xid {} to device context - precaution.", requestContext.getXid().getValue());
@@ -101,7 +123,6 @@ public abstract class CommonService {
 
         } else {
             messageSpy.spyMessage(requestContext, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
-            RequestContextUtil.closeRequstContext(requestContext);
         }
         return result;
     }
index cc2d15a67f233f44adc4167e9977d80415eb0f6d..91c5e315e572ea0e4a97c5f774ff44ed5d87ba75 100644 (file)
@@ -55,6 +55,7 @@ public class OFJResult2RequestCtxFuture<T> {
                             RpcResultBuilder.<T>failed().withRpcErrors(fRpcResult.getErrors()).build());
                     RequestContextUtil.closeRequstContext(requestContext);
                 }
+                // else: message was successfully sent - waiting for callback on requestContext.future to get invoked
             }
 
             @Override
@@ -66,6 +67,7 @@ public class OFJResult2RequestCtxFuture<T> {
                     requestContext.getFuture().set(RpcResultBuilder.<T>success().build());
                 } else {
                     deviceContext.getMessageSpy().spyMessage(requestContext, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
+                    deviceContext.unhookRequestCtx(requestContext.getXid());
                     LOG.trace("Exception occured while processing OF Java response for XID {}.", requestContext.getXid().getValue(), throwable);
                     requestContext.getFuture().set(
                             RpcResultBuilder.<T>failed()
index 916b546a4e4319a9209a41cf7b9cc1043acf73fd..19895116001e2a5a6f206509ea3208f3fec5ab24 100644 (file)
@@ -13,15 +13,14 @@ 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;
@@ -62,34 +61,6 @@ 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);
-
-        if (!result.isDone()) {
-
-            final DataCrate<T> dataCrate = DataCrateBuilder.<T>builder().setiDConnection(connectionID)
-                    .setRequestContext(requestContext).setFlowModInputBuilder(flowModInputBuilder).build();
-
-            requestContext.setXid(deviceContext.getNextXid());
-
-            LOG.trace("Hooking xid {} to device context - precaution.", requestContext.getXid().getValue());
-            deviceContext.hookRequestCtx(requestContext.getXid(), requestContext);
-
-            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;
@@ -105,13 +76,17 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
         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) {
+            public void onSuccess(final RpcResult<AddFlowOutput> rpcResult) {
                 messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
-                LOG.debug("flow add finished without error, id={}", flowId.getValue());
+                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
@@ -217,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());
             }
         });
@@ -285,49 +298,6 @@ public class SalFlowServiceImpl extends CommonService implements SalFlowService
                 flowModInput);
 
         final ListenableFuture<RpcResult<Void>> result = JdkFutureAdapters.listenInPoolThread(flowModResult);
-        final RequestContext requestContext = data.getRequestContext();
-
-        Futures.addCallback(result, new FutureCallback<RpcResult<Void>>() {
-            @Override
-            public void onSuccess(final RpcResult<Void> voidRpcResult) {
-                if (!voidRpcResult.isSuccessful()) {
-                    // remove current request from request cache in deviceContext
-                    messageSpy.spyMessage(flowModInput, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
-                    deviceContext.unhookRequestCtx(requestContext.getXid());
-                    // handle requestContext failure
-                    StringBuilder rpcErrors = new StringBuilder();
-                    if (null != voidRpcResult.getErrors() && voidRpcResult.getErrors().size() > 0) {
-                        for (RpcError error : voidRpcResult.getErrors()) {
-                            rpcErrors.append(error.getMessage());
-                        }
-                    }
-                    LOG.trace("OF Java result for XID {} was not successful. Errors : {}", requestContext.getXid().getValue(), rpcErrors.toString());
-                    requestContext.getFuture().set(
-                            RpcResultBuilder.<T>failed().withRpcErrors(voidRpcResult.getErrors()).build());
-                    RequestContextUtil.closeRequstContext(requestContext);
-                }
-
-            }
-
-            @Override
-            public void onFailure(final Throwable throwable) {
-                if (result.isCancelled()) {
-                    messageSpy.spyMessage(flowModInput, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
-                    LOG.trace("Asymmetric message - no response from OF Java expected for XID {}. Closing as successful.", requestContext.getXid().getValue());
-                    requestContext.getFuture().set(RpcResultBuilder.<T>success().build());
-                } else {
-                    messageSpy.spyMessage(flowModInput, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
-                    LOG.trace("Exception occured while processing OF Java response for XID {}.", requestContext.getXid().getValue(), throwable);
-                    requestContext.getFuture().set(
-                            RpcResultBuilder.<T>failed()
-                                    .withError(RpcError.ErrorType.APPLICATION, "", "Flow translation to OF JAVA failed.")
-                                    .build());
-                }
-
-                RequestContextUtil.closeRequstContext(requestContext);
-
-            }
-        });
         return result;
     }