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 = Preconditions.checkNotNull(salGroupsBatchService, "delegate group service must not be null");
  70         this.salMeterService = Preconditions.checkNotNull(salMetersBatchService, "delegate meter service must not be null");
  71     }
  72
  73     @Override
  74     public Future<RpcResult<ProcessFlatBatchOutput>> processFlatBatch(final ProcessFlatBatchInput input) {
  75         LOG.trace("processing flat batch @ {} : {}", PathUtil.extractNodeId(input.getNode()).getValue(), input.getBatch().size());
  76         // create plan
  77         final List<BatchPlanStep> batchPlan = FlatBatchUtil.assembleBatchPlan(input.getBatch());
  78         // add barriers where needed
  79         FlatBatchUtil.markBarriersWhereNeeded(batchPlan);
  80         // prepare chain elements
  81         final List<BatchStepJob> batchChainElements = prepareBatchChain(batchPlan, input.getNode(), input.isExitOnFirstError());
  82         // execute plan with barriers and collect outputs chain correspondingly, collect results
  83         return executeBatchPlan(batchChainElements);
  84     }
  85
  86     @VisibleForTesting
  87     Future<RpcResult<ProcessFlatBatchOutput>> executeBatchPlan(final List<BatchStepJob> batchJobsChain) {
  88         BatchStepJob batchJob;
  89         final List<ListenableFuture<RpcResult<ProcessFlatBatchOutput>>> firedJobs = new ArrayList<>();
  90         ListenableFuture<RpcResult<ProcessFlatBatchOutput>> chainSummaryResult =
  91                 FlatBatchUtil.createEmptyRpcBatchResultFuture(true);
  92
  93         for (int i = 0; i < batchJobsChain.size(); i++)  {
  94             batchJob = batchJobsChain.get(i);
  95             // wire actual job with chain
  96             firedJobs.add(Futures.transform(chainSummaryResult, batchJob.getStepFunction()));
  97             // if barrier after actual job is needed or it is the last job -> merge fired job results with chain result
  98             if ((batchJob.getPlanStep().isBarrierAfter()) || (i == batchJobsChain.size()-1)) {
  99                 firedJobs.add(0, chainSummaryResult);
 100                 chainSummaryResult = FlatBatchUtil.mergeJobsResultsFutures(firedJobs);
 101                 firedJobs.clear();
 102             }
 103         }
 104         return chainSummaryResult;
 105     }
 106
 107     @VisibleForTesting
 108     List<BatchStepJob> prepareBatchChain(final List<BatchPlanStep> batchPlan, final NodeRef node, final boolean exitOnFirstError) {
 109         // create batch API calls based on plan steps
 110         final List<BatchStepJob> chainJobs = new ArrayList<>();
 111         int stepOffset = 0;
 112         for (final BatchPlanStep planStep : batchPlan) {
 113             final int currentOffset = stepOffset;
 114             chainJobs.add(new BatchStepJob(planStep, chainInput -> {
 115                 if (exitOnFirstError && !chainInput.isSuccessful()) {
 116                     LOG.debug("error on flat batch chain occurred -> skipping step {}", planStep.getStepType());
 117                     return FlatBatchUtil.createEmptyRpcBatchResultFuture(false);
 118                 }
 119                 LOG.trace("batch progressing on step type {}, previous steps result: {}", planStep.getStepType(),
 120                         chainInput.isSuccessful());
 121                 return getChainOutput(node, planStep, currentOffset);
 122             }));
 123             stepOffset += planStep.getTaskBag().size();
 124         }
 125
 126         return chainJobs;
 127     }
 128
 129     private ListenableFuture<RpcResult<ProcessFlatBatchOutput>> getChainOutput(final NodeRef node,
 130                                                                                final BatchPlanStep planStep,
 131                                                                                final int currentOffset) {
 132         final ListenableFuture<RpcResult<ProcessFlatBatchOutput>> chainOutput;
 133
 134         switch (planStep.getStepType()) {
 135             case FLOW_ADD:
 136                 final AddFlowsBatchInput addFlowsBatchInput = FlatBatchFlowAdapters.adaptFlatBatchAddFlow(planStep, node);
 137                 final Future<RpcResult<AddFlowsBatchOutput>> resultAddFlowFuture = salFlowService.addFlowsBatch(addFlowsBatchInput);
 138                 chainOutput = FlatBatchFlowAdapters.convertFlowBatchFutureForChain(resultAddFlowFuture, currentOffset);
 139                 break;
 140             case FLOW_REMOVE:
 141                 final RemoveFlowsBatchInput removeFlowsBatchInput = FlatBatchFlowAdapters.adaptFlatBatchRemoveFlow(planStep, node);
 142                 final Future<RpcResult<RemoveFlowsBatchOutput>> resultRemoveFlowFuture = salFlowService.removeFlowsBatch(removeFlowsBatchInput);
 143                 chainOutput = FlatBatchFlowAdapters.convertFlowBatchFutureForChain(resultRemoveFlowFuture, currentOffset);
 144                 break;
 145             case FLOW_UPDATE:
 146                 final UpdateFlowsBatchInput updateFlowsBatchInput = FlatBatchFlowAdapters.adaptFlatBatchUpdateFlow(planStep, node);
 147                 final Future<RpcResult<UpdateFlowsBatchOutput>> resultUpdateFlowFuture = salFlowService.updateFlowsBatch(updateFlowsBatchInput);
 148                 chainOutput = FlatBatchFlowAdapters.convertFlowBatchFutureForChain(resultUpdateFlowFuture, currentOffset);
 149                 break;
 150             case GROUP_ADD:
 151                 final AddGroupsBatchInput addGroupsBatchInput = FlatBatchGroupAdapters.adaptFlatBatchAddGroup(planStep, node);
 152                 final Future<RpcResult<AddGroupsBatchOutput>> resultAddGroupFuture = salGroupService.addGroupsBatch(addGroupsBatchInput);
 153                 chainOutput = FlatBatchGroupAdapters.convertGroupBatchFutureForChain(resultAddGroupFuture, currentOffset);
 154                 break;
 155             case GROUP_REMOVE:
 156                 final RemoveGroupsBatchInput removeGroupsBatchInput = FlatBatchGroupAdapters.adaptFlatBatchRemoveGroup(planStep, node);
 157                 final Future<RpcResult<RemoveGroupsBatchOutput>> resultRemoveGroupFuture = salGroupService.removeGroupsBatch(removeGroupsBatchInput);
 158                 chainOutput = FlatBatchGroupAdapters.convertGroupBatchFutureForChain(resultRemoveGroupFuture, currentOffset);
 159                 break;
 160             case GROUP_UPDATE:
 161                 final UpdateGroupsBatchInput updateGroupsBatchInput = FlatBatchGroupAdapters.adaptFlatBatchUpdateGroup(planStep, node);
 162                 final Future<RpcResult<UpdateGroupsBatchOutput>> resultUpdateGroupFuture = salGroupService.updateGroupsBatch(updateGroupsBatchInput);
 163                 chainOutput = FlatBatchGroupAdapters.convertGroupBatchFutureForChain(resultUpdateGroupFuture, currentOffset);
 164                 break;
 165             case METER_ADD:
 166                 final AddMetersBatchInput addMetersBatchInput = FlatBatchMeterAdapters.adaptFlatBatchAddMeter(planStep, node);
 167                 final Future<RpcResult<AddMetersBatchOutput>> resultAddMeterFuture = salMeterService.addMetersBatch(addMetersBatchInput);
 168                 chainOutput = FlatBatchMeterAdapters.convertMeterBatchFutureForChain(resultAddMeterFuture, currentOffset);
 169                 break;
 170             case METER_REMOVE:
 171                 final RemoveMetersBatchInput removeMetersBatchInput = FlatBatchMeterAdapters.adaptFlatBatchRemoveMeter(planStep, node);
 172                 final Future<RpcResult<RemoveMetersBatchOutput>> resultRemoveMeterFuture = salMeterService.removeMetersBatch(removeMetersBatchInput);
 173                 chainOutput = FlatBatchMeterAdapters.convertMeterBatchFutureForChain(resultRemoveMeterFuture, currentOffset);
 174                 break;
 175             case METER_UPDATE:
 176                 final UpdateMetersBatchInput updateMetersBatchInput = FlatBatchMeterAdapters.adaptFlatBatchUpdateMeter(planStep, node);
 177                 final Future<RpcResult<UpdateMetersBatchOutput>> resultUpdateMeterFuture = salMeterService.updateMetersBatch(updateMetersBatchInput);
 178                 chainOutput = FlatBatchMeterAdapters.convertMeterBatchFutureForChain(resultUpdateMeterFuture, currentOffset);
 179                 break;
 180             default:
 181                 LOG.warn("Unsupported plan-step type occurred: {} -> OMITTING", planStep.getStepType());
 182                 chainOutput = FlatBatchUtil.createEmptyRpcBatchResultFuture(true);
 183         }
 184
 185         return chainOutput;
 186     }
 187 }