openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/sal/SalFlatBatchServiceImpl.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   9 package org.opendaylight.openflowplugin.impl.services.sal;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import java.util.ArrayList;
  16 import java.util.List;
  17 import java.util.concurrent.Future;
  18 import org.opendaylight.openflowplugin.impl.services.batch.BatchPlanStep;
  19 import org.opendaylight.openflowplugin.impl.services.batch.BatchStepJob;
  20 import org.opendaylight.openflowplugin.impl.services.batch.FlatBatchFlowAdapters;
  21 import org.opendaylight.openflowplugin.impl.services.batch.FlatBatchGroupAdapters;
  22 import org.opendaylight.openflowplugin.impl.services.batch.FlatBatchMeterAdapters;
  23 import org.opendaylight.openflowplugin.impl.util.FlatBatchUtil;
  24 import org.opendaylight.openflowplugin.impl.util.PathUtil;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.ProcessFlatBatchInput;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.ProcessFlatBatchOutput;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.SalFlatBatchService;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchInput;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.RemoveFlowsBatchInput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.RemoveFlowsBatchOutput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.SalFlowsBatchService;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.UpdateFlowsBatchInput;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.UpdateFlowsBatchOutput;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.AddGroupsBatchInput;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.AddGroupsBatchOutput;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.RemoveGroupsBatchInput;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.RemoveGroupsBatchOutput;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.SalGroupsBatchService;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.UpdateGroupsBatchInput;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.UpdateGroupsBatchOutput;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.AddMetersBatchInput;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.AddMetersBatchOutput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.RemoveMetersBatchInput;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.RemoveMetersBatchOutput;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.SalMetersBatchService;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.UpdateMetersBatchInput;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.UpdateMetersBatchOutput;
  51 import org.opendaylight.yangtools.yang.common.RpcResult;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 /**
  56  * Default implementation of {@link SalFlowsBatchService} - delegates work to {@link SalFlowService}.
  57  */
  58 public class SalFlatBatchServiceImpl implements SalFlatBatchService {
  59     private static final Logger LOG = LoggerFactory.getLogger(SalFlatBatchServiceImpl.class);
  60
  61     private final SalFlowsBatchService salFlowService;
  62     private final SalGroupsBatchService salGroupService;
  63     private final SalMetersBatchService salMeterService;
  64
  65     public SalFlatBatchServiceImpl(final SalFlowsBatchService salFlowBatchService,
  66                                    final SalGroupsBatchService salGroupsBatchService,
  67                                    final SalMetersBatchService salMetersBatchService) {
  68         this.salFlowService = Preconditions.checkNotNull(salFlowBatchService, "delegate flow service must not be null");
  69         this.salGroupService =
  70                 Preconditions.checkNotNull(salGroupsBatchService, "delegate group service must not be null");
  71         this.salMeterService =
  72                 Preconditions.checkNotNull(salMetersBatchService, "delegate meter service must not be null");
  73     }
  74
  75     @Override
  76     public Future<RpcResult<ProcessFlatBatchOutput>> processFlatBatch(final ProcessFlatBatchInput input) {
  77         LOG.trace("processing flat batch @ {} : {}",
  78                   PathUtil.extractNodeId(input.getNode()).getValue(),
  79                   input.getBatch().size());
  80         // create plan
  81         final List<BatchPlanStep> batchPlan = FlatBatchUtil.assembleBatchPlan(input.getBatch());
  82         // add barriers where needed
  83         FlatBatchUtil.markBarriersWhereNeeded(batchPlan);
  84         // prepare chain elements
  85         final List<BatchStepJob> batchChainElements =
  86                 prepareBatchChain(batchPlan, input.getNode(), input.isExitOnFirstError());
  87         // execute plan with barriers and collect outputs chain correspondingly, collect results
  88         return executeBatchPlan(batchChainElements);
  89     }
  90
  91     @VisibleForTesting
  92     Future<RpcResult<ProcessFlatBatchOutput>> executeBatchPlan(final List<BatchStepJob> batchJobsChain) {
  93         BatchStepJob batchJob;
  94         final List<ListenableFuture<RpcResult<ProcessFlatBatchOutput>>> firedJobs = new ArrayList<>();
  95         ListenableFuture<RpcResult<ProcessFlatBatchOutput>> chainSummaryResult =
  96                 FlatBatchUtil.createEmptyRpcBatchResultFuture(true);
  97
  98         for (int i = 0; i < batchJobsChain.size(); i++)  {
  99             batchJob = batchJobsChain.get(i);
 100             // wire actual job with chain
 101             firedJobs.add(Futures.transformAsync(chainSummaryResult, batchJob.getStepFunction()));
 102             // if barrier after actual job is needed or it is the last job -> merge fired job results with chain result
 103             if ((batchJob.getPlanStep().isBarrierAfter()) || (i == batchJobsChain.size() - 1)) {
 104                 firedJobs.add(0, chainSummaryResult);
 105                 chainSummaryResult = FlatBatchUtil.mergeJobsResultsFutures(firedJobs);
 106                 firedJobs.clear();
 107             }
 108         }
 109         return chainSummaryResult;
 110     }
 111
 112     @VisibleForTesting
 113     List<BatchStepJob> prepareBatchChain(final List<BatchPlanStep> batchPlan,
 114                                          final NodeRef node,
 115                                          final boolean exitOnFirstError) {
 116         // create batch API calls based on plan steps
 117         final List<BatchStepJob> chainJobs = new ArrayList<>();
 118         int stepOffset = 0;
 119         for (final BatchPlanStep planStep : batchPlan) {
 120             final int currentOffset = stepOffset;
 121             chainJobs.add(new BatchStepJob(planStep, chainInput -> {
 122                 if (exitOnFirstError && !chainInput.isSuccessful()) {
 123                     LOG.debug("error on flat batch chain occurred -> skipping step {}", planStep.getStepType());
 124                     return FlatBatchUtil.createEmptyRpcBatchResultFuture(false);
 125                 }
 126                 LOG.trace("batch progressing on step type {}, previous steps result: {}", planStep.getStepType(),
 127                         chainInput.isSuccessful());
 128                 return getChainOutput(node, planStep, currentOffset);
 129             }));
 130             stepOffset += planStep.getTaskBag().size();
 131         }
 132
 133         return chainJobs;
 134     }
 135
 136     private ListenableFuture<RpcResult<ProcessFlatBatchOutput>> getChainOutput(final NodeRef node,
 137                                                                                final BatchPlanStep planStep,
 138                                                                                final int currentOffset) {
 139         final ListenableFuture<RpcResult<ProcessFlatBatchOutput>> chainOutput;
 140
 141         switch (planStep.getStepType()) {
 142             case FLOW_ADD:
 143                 final AddFlowsBatchInput addFlowsBatchInput =
 144                         FlatBatchFlowAdapters.adaptFlatBatchAddFlow(planStep, node);
 145                 final Future<RpcResult<AddFlowsBatchOutput>> resultAddFlowFuture =
 146                         salFlowService.addFlowsBatch(addFlowsBatchInput);
 147                 chainOutput = FlatBatchFlowAdapters.convertFlowBatchFutureForChain(resultAddFlowFuture, currentOffset);
 148                 break;
 149             case FLOW_REMOVE:
 150                 final RemoveFlowsBatchInput removeFlowsBatchInput =
 151                         FlatBatchFlowAdapters.adaptFlatBatchRemoveFlow(planStep, node);
 152                 final Future<RpcResult<RemoveFlowsBatchOutput>> resultRemoveFlowFuture =
 153                         salFlowService.removeFlowsBatch(removeFlowsBatchInput);
 154                 chainOutput =
 155                         FlatBatchFlowAdapters.convertFlowBatchFutureForChain(resultRemoveFlowFuture, currentOffset);
 156                 break;
 157             case FLOW_UPDATE:
 158                 final UpdateFlowsBatchInput updateFlowsBatchInput =
 159                         FlatBatchFlowAdapters.adaptFlatBatchUpdateFlow(planStep, node);
 160                 final Future<RpcResult<UpdateFlowsBatchOutput>> resultUpdateFlowFuture =
 161                         salFlowService.updateFlowsBatch(updateFlowsBatchInput);
 162                 chainOutput =
 163                         FlatBatchFlowAdapters.convertFlowBatchFutureForChain(resultUpdateFlowFuture, currentOffset);
 164                 break;
 165             case GROUP_ADD:
 166                 final AddGroupsBatchInput addGroupsBatchInput =
 167                         FlatBatchGroupAdapters.adaptFlatBatchAddGroup(planStep, node);
 168                 final Future<RpcResult<AddGroupsBatchOutput>> resultAddGroupFuture =
 169                         salGroupService.addGroupsBatch(addGroupsBatchInput);
 170                 chainOutput =
 171                         FlatBatchGroupAdapters.convertGroupBatchFutureForChain(resultAddGroupFuture, currentOffset);
 172                 break;
 173             case GROUP_REMOVE:
 174                 final RemoveGroupsBatchInput removeGroupsBatchInput =
 175                         FlatBatchGroupAdapters.adaptFlatBatchRemoveGroup(planStep, node);
 176                 final Future<RpcResult<RemoveGroupsBatchOutput>> resultRemoveGroupFuture =
 177                         salGroupService.removeGroupsBatch(removeGroupsBatchInput);
 178                 chainOutput =
 179                         FlatBatchGroupAdapters.convertGroupBatchFutureForChain(resultRemoveGroupFuture, currentOffset);
 180                 break;
 181             case GROUP_UPDATE:
 182                 final UpdateGroupsBatchInput updateGroupsBatchInput =
 183                         FlatBatchGroupAdapters.adaptFlatBatchUpdateGroup(planStep, node);
 184                 final Future<RpcResult<UpdateGroupsBatchOutput>> resultUpdateGroupFuture =
 185                         salGroupService.updateGroupsBatch(updateGroupsBatchInput);
 186                 chainOutput =
 187                         FlatBatchGroupAdapters.convertGroupBatchFutureForChain(resultUpdateGroupFuture, currentOffset);
 188                 break;
 189             case METER_ADD:
 190                 final AddMetersBatchInput addMetersBatchInput =
 191                         FlatBatchMeterAdapters.adaptFlatBatchAddMeter(planStep, node);
 192                 final Future<RpcResult<AddMetersBatchOutput>> resultAddMeterFuture =
 193                         salMeterService.addMetersBatch(addMetersBatchInput);
 194                 chainOutput =
 195                         FlatBatchMeterAdapters.convertMeterBatchFutureForChain(resultAddMeterFuture, currentOffset);
 196                 break;
 197             case METER_REMOVE:
 198                 final RemoveMetersBatchInput removeMetersBatchInput =
 199                         FlatBatchMeterAdapters.adaptFlatBatchRemoveMeter(planStep, node);
 200                 final Future<RpcResult<RemoveMetersBatchOutput>> resultRemoveMeterFuture =
 201                         salMeterService.removeMetersBatch(removeMetersBatchInput);
 202                 chainOutput =
 203                         FlatBatchMeterAdapters.convertMeterBatchFutureForChain(resultRemoveMeterFuture, currentOffset);
 204                 break;
 205             case METER_UPDATE:
 206                 final UpdateMetersBatchInput updateMetersBatchInput =
 207                         FlatBatchMeterAdapters.adaptFlatBatchUpdateMeter(planStep, node);
 208                 final Future<RpcResult<UpdateMetersBatchOutput>> resultUpdateMeterFuture =
 209                         salMeterService.updateMetersBatch(updateMetersBatchInput);
 210                 chainOutput =
 211                         FlatBatchMeterAdapters.convertMeterBatchFutureForChain(resultUpdateMeterFuture, currentOffset);
 212                 break;
 213             default:
 214                 LOG.warn("Unsupported plan-step type occurred: {} -> OMITTING", planStep.getStepType());
 215                 chainOutput = FlatBatchUtil.createEmptyRpcBatchResultFuture(true);
 216         }
 217
 218         return chainOutput;
 219     }
 220 }