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