openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/SalFlowServiceImpl.java

   1 /**
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  * <p/>
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.openflowplugin.impl.services;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.JdkFutureAdapters;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.SettableFuture;
  16 import java.math.BigInteger;
  17 import java.util.ArrayList;
  18 import java.util.Collection;
  19 import java.util.Iterator;
  20 import java.util.List;
  21 import java.util.concurrent.ExecutionException;
  22 import java.util.concurrent.Future;
  23 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  24 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  25 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  26 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  27 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
  28 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowHash;
  29 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  30 import org.opendaylight.openflowplugin.impl.registry.flow.FlowDescriptorFactory;
  31 import org.opendaylight.openflowplugin.impl.registry.flow.FlowHashFactory;
  32 import org.opendaylight.openflowplugin.impl.util.FlowUtil;
  33 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.FlowConvertor;
  34 import org.opendaylight.openflowplugin.openflow.md.util.FlowCreatorUtil;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutput;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInput;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowOutput;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowInput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowOutput;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.OriginalFlow;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.UpdatedFlow;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInput;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInputBuilder;
  51 import org.opendaylight.yangtools.yang.common.RpcError;
  52 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  53 import org.opendaylight.yangtools.yang.common.RpcResult;
  54 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  55 import org.slf4j.Logger;
  56
  57 public class SalFlowServiceImpl extends CommonService implements SalFlowService {
  58
  59     private static final Logger LOG = org.slf4j.LoggerFactory.getLogger(SalFlowServiceImpl.class);
  60
  61     public SalFlowServiceImpl(final RequestContextStack requestContextStack, final DeviceContext deviceContext) {
  62         super(requestContextStack, deviceContext);
  63     }
  64
  65     <T, F> ListenableFuture<RpcResult<T>> handleServiceCall(final BigInteger connectionID,
  66                                                             final FlowModInputBuilder flowModInputBuilder, final Function<DataCrate<T>, ListenableFuture<RpcResult<F>>> function) {
  67         LOG.debug("Calling the FlowMod RPC method on MessageDispatchService");
  68
  69         final RequestContext<T> requestContext = requestContextStack.createRequestContext();
  70         final SettableFuture<RpcResult<T>> result = requestContextStack.storeOrFail(requestContext);
  71
  72         if (!result.isDone()) {
  73
  74             final DataCrate<T> dataCrate = DataCrateBuilder.<T>builder().setiDConnection(connectionID)
  75                     .setRequestContext(requestContext).setFlowModInputBuilder(flowModInputBuilder).build();
  76
  77             requestContext.setXid(deviceContext.getNextXid());
  78
  79             LOG.trace("Hooking xid {} to device context - precaution.", requestContext.getXid().getValue());
  80             deviceContext.hookRequestCtx(requestContext.getXid(), requestContext);
  81
  82             final ListenableFuture<RpcResult<F>> resultFromOFLib = function.apply(dataCrate);
  83
  84             final OFJResult2RequestCtxFuture<T> OFJResult2RequestCtxFuture = new OFJResult2RequestCtxFuture<>(requestContext, deviceContext);
  85             OFJResult2RequestCtxFuture.processResultFromOfJava(resultFromOFLib);
  86
  87         } else {
  88             RequestContextUtil.closeRequstContext(requestContext);
  89         }
  90         return result;
  91     }
  92
  93     @Override
  94     public Future<RpcResult<AddFlowOutput>> addFlow(final AddFlowInput input) {
  95         final FlowId flowId;
  96         if (null != input.getFlowRef()) {
  97             flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
  98         } else {
  99             flowId = FlowUtil.createAlienFlowId(input.getTableId());
 100         }
 101
 102
 103         final FlowHash flowHash = FlowHashFactory.create(input);
 104         final FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId);
 105         deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
 106
 107         final List<FlowModInputBuilder> ofFlowModInputs = FlowConvertor.toFlowModInputs(input, version, datapathId);
 108         final ListenableFuture future = processFlowModInputBuilders(ofFlowModInputs);
 109
 110         Futures.addCallback(future, new FutureCallback() {
 111             @Override
 112             public void onSuccess(final Object o) {
 113                 messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
 114                 LOG.debug("flow add finished without error, id={}", flowId.getValue());
 115             }
 116
 117             @Override
 118             public void onFailure(final Throwable throwable) {
 119                 messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
 120                 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
 121                 LOG.trace("Service call for adding flows failed, id={}.", flowId.getValue(), throwable);
 122             }
 123         });
 124
 125         return future;
 126     }
 127
 128     @Override
 129     public Future<RpcResult<RemoveFlowOutput>> removeFlow(final RemoveFlowInput input) {
 130         LOG.trace("Calling remove flow for flow with ID ={}.", input.getFlowRef());
 131         return this.<RemoveFlowOutput, Void>handleServiceCall(PRIMARY_CONNECTION,
 132                 new Function<DataCrate<RemoveFlowOutput>, ListenableFuture<RpcResult<Void>>>() {
 133                     @Override
 134                     public ListenableFuture<RpcResult<Void>> apply(final DataCrate<RemoveFlowOutput> data) {
 135                         final FlowModInputBuilder ofFlowModInput = FlowConvertor.toFlowModInput(input, version,
 136                                 datapathId);
 137                         final ListenableFuture<RpcResult<Void>> future = createResultForFlowMod(data, ofFlowModInput);
 138                         Futures.addCallback(future, new FutureCallback() {
 139                             @Override
 140                             public void onSuccess(final Object o) {
 141                                 messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
 142                                 FlowHash flowHash = FlowHashFactory.create(input);
 143                                 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
 144                             }
 145
 146                             @Override
 147                             public void onFailure(final Throwable throwable) {
 148                                 messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
 149                                 StringBuffer errors = new StringBuffer();
 150                                 try {
 151                                     RpcResult<Void> result = future.get();
 152                                     Collection<RpcError> rpcErrors = result.getErrors();
 153                                     if (null != rpcErrors && rpcErrors.size() > 0) {
 154                                         for (RpcError rpcError : rpcErrors) {
 155                                             errors.append(rpcError.getMessage());
 156                                         }
 157                                     }
 158                                 } catch (InterruptedException | ExecutionException e) {
 159                                     LOG.trace("Flow modification failed. Can't read errors from RpcResult.");
 160                                 }
 161                                 LOG.trace("Flow modification failed. Errors : {}", errors.toString());
 162                             }
 163                         });
 164                         return future;
 165                     }
 166                 });
 167     }
 168
 169     @Override
 170     public Future<RpcResult<UpdateFlowOutput>> updateFlow(final UpdateFlowInput input) {
 171         final UpdateFlowInput in = input;
 172         final UpdatedFlow updated = in.getUpdatedFlow();
 173         final OriginalFlow original = in.getOriginalFlow();
 174
 175         final List<FlowModInputBuilder> allFlowMods = new ArrayList<>();
 176         List<FlowModInputBuilder> ofFlowModInputs;
 177
 178         if (!FlowCreatorUtil.canModifyFlow(original, updated, version)) {
 179             // We would need to remove original and add updated.
 180
 181             // remove flow
 182             final RemoveFlowInputBuilder removeflow = new RemoveFlowInputBuilder(original);
 183             final List<FlowModInputBuilder> ofFlowRemoveInput = FlowConvertor.toFlowModInputs(removeflow.build(),
 184                     version, datapathId);
 185             // remove flow should be the first
 186             allFlowMods.addAll(ofFlowRemoveInput);
 187             final AddFlowInputBuilder addFlowInputBuilder = new AddFlowInputBuilder(updated);
 188             ofFlowModInputs = FlowConvertor.toFlowModInputs(addFlowInputBuilder.build(), version, datapathId);
 189         } else {
 190             ofFlowModInputs = FlowConvertor.toFlowModInputs(updated, version, datapathId);
 191         }
 192
 193         allFlowMods.addAll(ofFlowModInputs);
 194         ListenableFuture future = processFlowModInputBuilders(allFlowMods);
 195         Futures.addCallback(future, new FutureCallback() {
 196             @Override
 197             public void onSuccess(final Object o) {
 198                 messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
 199                 FlowHash flowHash = FlowHashFactory.create(original);
 200                 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
 201
 202                 flowHash = FlowHashFactory.create(updated);
 203                 FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
 204                 FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(updated.getTableId(), flowId);
 205                 deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
 206
 207             }
 208
 209             @Override
 210             public void onFailure(final Throwable throwable) {
 211                 messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
 212             }
 213         });
 214         return future;
 215     }
 216
 217     private <T> ListenableFuture<RpcResult<T>> processFlowModInputBuilders(
 218             final List<FlowModInputBuilder> ofFlowModInputs) {
 219         final List<ListenableFuture<RpcResult<T>>> partialFutures = new ArrayList<>();
 220         for (FlowModInputBuilder flowModInputBuilder : ofFlowModInputs) {
 221             ListenableFuture<RpcResult<T>> partialFuture = handleServiceCall(PRIMARY_CONNECTION, flowModInputBuilder,
 222                     new Function<DataCrate<T>, ListenableFuture<RpcResult<Void>>>() {
 223                         @Override
 224                         public ListenableFuture<RpcResult<Void>> apply(final DataCrate<T> data) {
 225                             return createResultForFlowMod(data);
 226                         }
 227                     });
 228             partialFutures.add(partialFuture);
 229         }
 230
 231         final ListenableFuture<List<RpcResult<T>>> allFutures = Futures.allAsList(partialFutures);
 232         final SettableFuture<RpcResult<T>> finalFuture = SettableFuture.create();
 233         Futures.addCallback(allFutures, new FutureCallback<List<RpcResult<T>>>() {
 234             @Override
 235             public void onSuccess(List<RpcResult<T>> results) {
 236                 Iterator<FlowModInputBuilder> flowModInputBldIterator = ofFlowModInputs.iterator();
 237                 List<RpcError> rpcErrorLot = new ArrayList<>();
 238                 for (RpcResult<T> rpcResult : results) {
 239                     FlowModInputBuilder flowModInputBld = flowModInputBldIterator.next();
 240                     if (rpcResult.isSuccessful()) {
 241                         Long xid = flowModInputBld.getXid();
 242                         LOG.warn("Positive confirmation of flow push is not supported by OF-spec");
 243                         LOG.warn("flow future result was successful [{}] = this should have never happen",
 244                                 xid);
 245                         rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
 246                                 "flow future result was successful ["+xid+"] = this should have never happen"));
 247                     } else {
 248                         rpcErrorLot.addAll(rpcResult.getErrors());
 249                     }
 250                 }
 251                 finalFuture.set(RpcResultBuilder.<T>failed().withRpcErrors(rpcErrorLot).build());
 252             }
 253
 254             @Override
 255             public void onFailure(Throwable t) {
 256                 LOG.trace("Flow mods chained future failed.");
 257                 RpcResultBuilder<T> resultBuilder;
 258                 if (allFutures.isCancelled()) {
 259                     if (LOG.isTraceEnabled()) {
 260                         for (FlowModInputBuilder ofFlowModInput : ofFlowModInputs) {
 261                             LOG.trace("flow future result was cancelled [{}] = barrier passed it without error",
 262                                     ofFlowModInput.getXid());
 263                         }
 264                     }
 265                     resultBuilder = RpcResultBuilder.<T>success();
 266                 } else {
 267                     resultBuilder = RpcResultBuilder.<T>failed().withError(ErrorType.APPLICATION, "", t.getMessage());
 268                 }
 269                 finalFuture.set(resultBuilder.build());
 270             }
 271         });
 272
 273         return finalFuture;
 274     }
 275
 276     protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data) {
 277         return createResultForFlowMod(data, data.getFlowModInputBuilder());
 278     }
 279
 280     protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data, final FlowModInputBuilder flowModInputBuilder) {
 281         final Xid xid = data.getRequestContext().getXid();
 282         flowModInputBuilder.setXid(xid.getValue());
 283         final FlowModInput flowModInput = flowModInputBuilder.build();
 284         Future<RpcResult<Void>> flowModResult = provideConnectionAdapter(data.getiDConnection()).flowMod(
 285                 flowModInput);
 286
 287         final ListenableFuture<RpcResult<Void>> result = JdkFutureAdapters.listenInPoolThread(flowModResult);
 288         final RequestContext requestContext = data.getRequestContext();
 289
 290         Futures.addCallback(result, new FutureCallback<RpcResult<Void>>() {
 291             @Override
 292             public void onSuccess(final RpcResult<Void> voidRpcResult) {
 293                 if (!voidRpcResult.isSuccessful()) {
 294                     // remove current request from request cache in deviceContext
 295                     messageSpy.spyMessage(flowModInput, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 296                     deviceContext.unhookRequestCtx(requestContext.getXid());
 297                     // handle requestContext failure
 298                     StringBuilder rpcErrors = new StringBuilder();
 299                     if (null != voidRpcResult.getErrors() && voidRpcResult.getErrors().size() > 0) {
 300                         for (RpcError error : voidRpcResult.getErrors()) {
 301                             rpcErrors.append(error.getMessage());
 302                         }
 303                     }
 304                     LOG.trace("OF Java result for XID {} was not successful. Errors : {}", requestContext.getXid().getValue(), rpcErrors.toString());
 305                     requestContext.getFuture().set(
 306                             RpcResultBuilder.<T>failed().withRpcErrors(voidRpcResult.getErrors()).build());
 307                     RequestContextUtil.closeRequstContext(requestContext);
 308                 }
 309
 310             }
 311
 312             @Override
 313             public void onFailure(final Throwable throwable) {
 314                 if (result.isCancelled()) {
 315                     messageSpy.spyMessage(flowModInput, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 316                     LOG.trace("Asymmetric message - no response from OF Java expected for XID {}. Closing as successful.", requestContext.getXid().getValue());
 317                     requestContext.getFuture().set(RpcResultBuilder.<T>success().build());
 318                 } else {
 319                     messageSpy.spyMessage(flowModInput, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 320                     LOG.trace("Exception occured while processing OF Java response for XID {}.", requestContext.getXid().getValue(), throwable);
 321                     requestContext.getFuture().set(
 322                             RpcResultBuilder.<T>failed()
 323                                     .withError(RpcError.ErrorType.APPLICATION, "", "Flow translation to OF JAVA failed.")
 324                                     .build());
 325                 }
 326
 327                 RequestContextUtil.closeRequstContext(requestContext);
 328
 329             }
 330         });
 331         return result;
 332     }
 333
 334 }