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.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.Iterator;
  19 import java.util.List;
  20 import java.util.concurrent.ExecutionException;
  21 import java.util.concurrent.Future;
  22 import org.opendaylight.openflowplugin.api.OFConstants;
  23 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  24 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  25 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  26 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  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     @Override
  66     public Future<RpcResult<AddFlowOutput>> addFlow(final AddFlowInput input) {
  67         getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_ENTERED);
  68         final FlowId flowId;
  69         if (null != input.getFlowRef()) {
  70             flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
  71         } else {
  72             flowId = FlowUtil.createAlienFlowId(input.getTableId());
  73         }
  74
  75
  76         final DeviceContext deviceContext = getDeviceContext();
  77         final FlowHash flowHash = FlowHashFactory.create(input, deviceContext.getPrimaryConnectionContext().getFeatures().getVersion());
  78         final FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId);
  79
  80         final List<FlowModInputBuilder> ofFlowModInputs = FlowConvertor.toFlowModInputs(input, getVersion(), getDatapathId());
  81         final ListenableFuture<RpcResult<AddFlowOutput>> future = processFlowModInputBuilders(ofFlowModInputs);
  82
  83         Futures.addCallback(future, new FutureCallback<RpcResult<AddFlowOutput>>() {
  84             @Override
  85             public void onSuccess(final RpcResult<AddFlowOutput> rpcResult) {
  86                 deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
  87                 if (rpcResult.isSuccessful()) {
  88                     LOG.debug("flow add finished without error, id={}", flowId.getValue());
  89                 } else {
  90                     LOG.debug("flow add failed with error, id={}", flowId.getValue());
  91                 }
  92             }
  93
  94             @Override
  95             public void onFailure(final Throwable throwable) {
  96                 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
  97                 LOG.trace("Service call for adding flows failed, id={}.", flowId.getValue(), throwable);
  98             }
  99         });
 100
 101         return future;
 102     }
 103
 104     @Override
 105     public Future<RpcResult<RemoveFlowOutput>> removeFlow(final RemoveFlowInput input) {
 106         LOG.trace("Calling remove flow for flow with ID ={}.", input.getFlowRef());
 107         return this.<RemoveFlowOutput, Void>handleServiceCall(new Function<DataCrate<RemoveFlowOutput>, ListenableFuture<RpcResult<Void>>>() {
 108             @Override
 109             public ListenableFuture<RpcResult<Void>> apply(final DataCrate<RemoveFlowOutput> data) {
 110                 final FlowModInputBuilder ofFlowModInput = FlowConvertor.toFlowModInput(input, getVersion(),
 111                         getDatapathId());
 112                 final ListenableFuture<RpcResult<Void>> future = createResultForFlowMod(data, ofFlowModInput);
 113                 Futures.addCallback(future, new FutureCallback() {
 114                     @Override
 115                     public void onSuccess(final Object o) {
 116                         final DeviceContext deviceContext = getDeviceContext();
 117                         getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_SUCCESS);
 118                         FlowHash flowHash = FlowHashFactory.create(input, deviceContext.getPrimaryConnectionContext().getFeatures().getVersion());
 119                         deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
 120                     }
 121
 122                     @Override
 123                     public void onFailure(final Throwable throwable) {
 124                         getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_FAILURE);
 125                         LOG.trace("Flow modification failed..", throwable);
 126                         StringBuffer errors = new StringBuffer();
 127                         try {
 128                             RpcResult<Void> result = future.get();
 129                             Collection<RpcError> rpcErrors = result.getErrors();
 130                             if (null != rpcErrors && rpcErrors.size() > 0) {
 131                                 for (RpcError rpcError : rpcErrors) {
 132                                     errors.append(rpcError.getMessage());
 133                                 }
 134                             }
 135                         } catch (InterruptedException | ExecutionException e) {
 136                             LOG.trace("Flow modification failed. Can't read errors from RpcResult.");
 137                         } finally {
 138                             LOG.trace("Flow modification failed. Errors : {}", errors.toString());
 139                         }
 140                     }
 141                 });
 142                 return future;
 143             }
 144         });
 145     }
 146
 147     @Override
 148     public Future<RpcResult<UpdateFlowOutput>> updateFlow(final UpdateFlowInput input) {
 149         final UpdateFlowInput in = input;
 150         final UpdatedFlow updated = in.getUpdatedFlow();
 151         final OriginalFlow original = in.getOriginalFlow();
 152
 153         final List<FlowModInputBuilder> allFlowMods = new ArrayList<>();
 154         List<FlowModInputBuilder> ofFlowModInputs;
 155
 156         if (!FlowCreatorUtil.canModifyFlow(original, updated, getVersion())) {
 157             // We would need to remove original and add updated.
 158
 159             // remove flow
 160             final RemoveFlowInputBuilder removeflow = new RemoveFlowInputBuilder(original);
 161             final List<FlowModInputBuilder> ofFlowRemoveInput = FlowConvertor.toFlowModInputs(removeflow.build(),
 162                     getVersion(), getDatapathId());
 163             // remove flow should be the first
 164             allFlowMods.addAll(ofFlowRemoveInput);
 165             final AddFlowInputBuilder addFlowInputBuilder = new AddFlowInputBuilder(updated);
 166             ofFlowModInputs = FlowConvertor.toFlowModInputs(addFlowInputBuilder.build(), getVersion(), getDatapathId());
 167         } else {
 168             ofFlowModInputs = FlowConvertor.toFlowModInputs(updated, getVersion(), getDatapathId());
 169         }
 170
 171         allFlowMods.addAll(ofFlowModInputs);
 172         ListenableFuture future = processFlowModInputBuilders(allFlowMods);
 173         Futures.addCallback(future, new FutureCallback() {
 174             @Override
 175             public void onSuccess(final Object o) {
 176                 final DeviceContext deviceContext = getDeviceContext();
 177                 getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_SUCCESS);
 178                 final short version = deviceContext.getPrimaryConnectionContext().getFeatures().getVersion();
 179                 FlowHash flowHash = FlowHashFactory.create(original, version);
 180
 181                 FlowHash updatedflowHash = FlowHashFactory.create(updated, version);
 182                 FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
 183                 FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(updated.getTableId(), flowId);
 184                 final DeviceFlowRegistry deviceFlowRegistry = deviceContext.getDeviceFlowRegistry();
 185                 deviceFlowRegistry.markToBeremoved(flowHash);
 186                 deviceFlowRegistry.store(updatedflowHash, flowDescriptor);
 187             }
 188
 189             @Override
 190             public void onFailure(final Throwable throwable) {
 191                 getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMIT_FAILURE);
 192             }
 193         });
 194         return future;
 195     }
 196
 197     private <T> ListenableFuture<RpcResult<T>> processFlowModInputBuilders(
 198             final List<FlowModInputBuilder> ofFlowModInputs) {
 199         final List<ListenableFuture<RpcResult<T>>> partialFutures = new ArrayList<>();
 200
 201         for (FlowModInputBuilder flowModInputBuilder : ofFlowModInputs) {
 202             DataCrateBuilder<T> dataCrateBuilder = DataCrateBuilder.<T>builder().setFlowModInputBuilder(flowModInputBuilder);
 203             ListenableFuture<RpcResult<T>> partialFuture = handleServiceCall(
 204                     getPrimaryConnection(),
 205                     new Function<DataCrate<T>, ListenableFuture<RpcResult<Void>>>() {
 206                         @Override
 207                         public ListenableFuture<RpcResult<Void>> apply(final DataCrate<T> data) {
 208                             return createResultForFlowMod(data);
 209                         }
 210                     },
 211                     dataCrateBuilder
 212             );
 213             partialFutures.add(partialFuture);
 214         }
 215
 216         // processing of final (optionally composite future)
 217         final ListenableFuture<List<RpcResult<T>>> allFutures = Futures.successfulAsList(partialFutures);
 218         final SettableFuture<RpcResult<T>> finalFuture = SettableFuture.create();
 219         Futures.addCallback(allFutures, new FutureCallback<List<RpcResult<T>>>() {
 220             @Override
 221             public void onSuccess(List<RpcResult<T>> results) {
 222                 List<RpcError> rpcErrorLot = new ArrayList<>();
 223                 RpcResultBuilder<T> resultBuilder;
 224
 225                 Iterator<FlowModInputBuilder> flowModInputBldIterator = ofFlowModInputs.iterator();
 226                 Iterator<RpcResult<T>> resultIterator = results.iterator();
 227
 228                 for (ListenableFuture<RpcResult<T>> partFutureFromRqCtx : partialFutures) {
 229                     FlowModInputBuilder flowModInputBld = flowModInputBldIterator.next();
 230                     RpcResult<T> result = resultIterator.next();
 231                     Long xid = flowModInputBld.getXid();
 232
 233
 234                     LOG.trace("flowMod future processing [{}], result={}", xid, result);
 235                     if (partFutureFromRqCtx.isCancelled()) { // one and only positive case
 236                         if (LOG.isTraceEnabled()) {
 237                             LOG.trace("flow future result was cancelled [{}] = barrier passed it without error", xid);
 238                         }
 239                     } else { // all negative cases
 240                         if (result == null) { // there is exception or null value set
 241                             try {
 242                                 partFutureFromRqCtx.get();
 243                             } catch (Exception e) {
 244                                 rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
 245                                         "flow future result [" + xid + "] failed with exception",
 246                                         OFConstants.APPLICATION_TAG, e.getMessage(), e));
 247
 248                                 // xid might be not available in case requestContext not even stored
 249                                 if (xid != null) {
 250                                     final DeviceContext deviceContext = getDeviceContext();
 251                                     deviceContext.unhookRequestCtx(new Xid(xid));
 252                                 }
 253                             }
 254                         } else {
 255                             if (result.isSuccessful()) {  // positive confirmation - never happens
 256                                 LOG.warn("Positive confirmation of flow push is not supported by OF-spec");
 257                                 LOG.warn("flow future result was successful [{}] = this should have never happen",
 258                                         xid);
 259                                 rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
 260                                         "flow future result was successful [" + xid + "] = this should have never happen"));
 261                             } else { // standard error occurred
 262                                 LOG.trace("passing original rpcErrors [{}]", xid);
 263                                 if (LOG.isTraceEnabled()) {
 264                                     for (RpcError rpcError : result.getErrors()) {
 265                                         LOG.trace("passed rpcError [{}]: {}", xid, rpcError);
 266                                     }
 267                                 }
 268                                 rpcErrorLot.addAll(result.getErrors());
 269                             }
 270                         }
 271                     }
 272                 }
 273
 274                 if (rpcErrorLot.isEmpty()) {
 275                     resultBuilder = RpcResultBuilder.<T>success();
 276                 } else {
 277                     resultBuilder = RpcResultBuilder.<T>failed().withRpcErrors(rpcErrorLot);
 278                 }
 279
 280                 finalFuture.set(resultBuilder.build());
 281             }
 282
 283             @Override
 284             public void onFailure(Throwable t) {
 285                 LOG.trace("Flow mods chained future failed.");
 286                 RpcResultBuilder<T> resultBuilder = RpcResultBuilder.<T>failed()
 287                         .withError(ErrorType.APPLICATION, "", t.getMessage());
 288                 finalFuture.set(resultBuilder.build());
 289             }
 290         });
 291
 292         return finalFuture;
 293     }
 294
 295     protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data) {
 296         return createResultForFlowMod(data, data.getFlowModInputBuilder());
 297     }
 298
 299     protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data, final FlowModInputBuilder flowModInputBuilder) {
 300         final Xid xid = data.getRequestContext().getXid();
 301         flowModInputBuilder.setXid(xid.getValue());
 302         final FlowModInput flowModInput = flowModInputBuilder.build();
 303         Future<RpcResult<Void>> flowModResult = provideConnectionAdapter(data.getiDConnection()).flowMod(
 304                 flowModInput);
 305
 306         final ListenableFuture<RpcResult<Void>> result = JdkFutureAdapters.listenInPoolThread(flowModResult);
 307         return result;
 308     }
 309
 310 }