applications/forwardingrules-sync/src/main/java/org/opendaylight/openflowplugin/applications/frsync/impl/SyncReactorImpl.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.applications.frsync.impl;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import com.google.common.base.Function;
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import java.util.ArrayList;
  17 import java.util.Arrays;
  18 import java.util.Collections;
  19 import java.util.List;
  20 import java.util.Map;
  21 import org.opendaylight.openflowplugin.applications.frsync.SyncPlanPushStrategy;
  22 import org.opendaylight.openflowplugin.applications.frsync.SyncReactor;
  23 import org.opendaylight.openflowplugin.applications.frsync.impl.strategy.SynchronizationDiffInput;
  24 import org.opendaylight.openflowplugin.applications.frsync.util.CrudCounts;
  25 import org.opendaylight.openflowplugin.applications.frsync.util.FlowCapableNodeLookups;
  26 import org.opendaylight.openflowplugin.applications.frsync.util.ItemSyncBox;
  27 import org.opendaylight.openflowplugin.applications.frsync.util.PathUtil;
  28 import org.opendaylight.openflowplugin.applications.frsync.util.ReconcileUtil;
  29 import org.opendaylight.openflowplugin.applications.frsync.util.SyncCrudCounters;
  30 import org.opendaylight.openflowplugin.applications.frsync.util.SyncupEntry;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.common.RpcResult;
  41 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 /**
  46  * Synchronization reactor implementation, applicable for both - syncup and reconciliation.
  47  */
  48 public class SyncReactorImpl implements SyncReactor {
  49
  50     private static final Logger LOG = LoggerFactory.getLogger(SyncReactorImpl.class);
  51     private final SyncPlanPushStrategy syncPlanPushStrategy;
  52
  53     public SyncReactorImpl(final SyncPlanPushStrategy syncPlanPushStrategy) {
  54         this.syncPlanPushStrategy = Preconditions.checkNotNull(syncPlanPushStrategy, "execution strategy is mandatory");
  55     }
  56
  57     @Override
  58     public ListenableFuture<Boolean> syncup(final InstanceIdentifier<FlowCapableNode> nodeIdent,
  59                                             final SyncupEntry syncupEntry) {
  60         final NodeId nodeId = PathUtil.digNodeId(nodeIdent);
  61         FlowCapableNode configTree = syncupEntry.getAfter();
  62         FlowCapableNode operationalTree = syncupEntry.getBefore();
  63         final SyncCrudCounters counters = new SyncCrudCounters();
  64
  65         /**
  66          * instructions:
  67          *  - extract diff changes and prepare change steps in safe order
  68          *    - optimization: decide if updates needed
  69          *  - execute chosen implementation (e.g. conventional API, bulk API, flat bulk API)
  70          *  - recommended order follows:
  71          * reconciliation strategy - phase 1: - add/update missing objects in following order:
  72          *  - table features - groups (reordered) - meters - flows
  73          * reconciliation strategy - phase 2: - remove redundant objects in following order:
  74          *  - flows - meters - groups (reordered)
  75          **/
  76
  77         final List<ItemSyncBox<Group>> groupsToAddOrUpdate = extractGroupsToAddOrUpdate(nodeId, configTree, operationalTree);
  78         final ItemSyncBox<Meter> metersToAddOrUpdate = extractMetersToAddOrUpdate(nodeId, configTree, operationalTree);
  79         final Map<TableKey, ItemSyncBox<Flow>> flowsToAddOrUpdate = extractFlowsToAddOrUpdate(nodeId, configTree, operationalTree);
  80
  81         final Map<TableKey, ItemSyncBox<Flow>> flowsToRemove = extractFlowsToRemove(nodeId, configTree, operationalTree);
  82         final ItemSyncBox<Meter> metersToRemove = extractMetersToRemove(nodeId, configTree, operationalTree);
  83         final List<ItemSyncBox<Group>> groupsToRemove = extractGroupsToRemove(nodeId, configTree, operationalTree);
  84
  85         final SynchronizationDiffInput input = new SynchronizationDiffInput(nodeIdent,
  86                 groupsToAddOrUpdate, metersToAddOrUpdate, flowsToAddOrUpdate,
  87                 flowsToRemove, metersToRemove, groupsToRemove);
  88
  89         final ListenableFuture<RpcResult<Void>> bootstrapResultFuture = RpcResultBuilder.<Void>success().buildFuture();
  90         final ListenableFuture<RpcResult<Void>> resultVehicle = syncPlanPushStrategy.executeSyncStrategy(
  91                 bootstrapResultFuture, input, counters);
  92
  93         return Futures.transform(resultVehicle, new Function<RpcResult<Void>, Boolean>() {
  94             @Override
  95             public Boolean apply(RpcResult<Void> input) {
  96                 if (input == null) {
  97                     return false;
  98                 }
  99                 if (LOG.isDebugEnabled()) {
 100                     final CrudCounts flowCrudCounts = counters.getFlowCrudCounts();
 101                     final CrudCounts meterCrudCounts = counters.getMeterCrudCounts();
 102                     final CrudCounts groupCrudCounts = counters.getGroupCrudCounts();
 103                     LOG.debug("syncup outcome[{}] (added/updated/removed): flow={}/{}/{}, group={}/{}/{}, " +
 104                                     "meter={}/{}/{}, errors={}",
 105                             nodeId.getValue(),
 106                             flowCrudCounts.getAdded(), flowCrudCounts.getUpdated(), flowCrudCounts.getRemoved(),
 107                             groupCrudCounts.getAdded(), groupCrudCounts.getUpdated(), groupCrudCounts.getRemoved(),
 108                             meterCrudCounts.getAdded(), meterCrudCounts.getUpdated(), meterCrudCounts.getRemoved(),
 109                             Arrays.toString(input.getErrors().toArray()));
 110                 }
 111                 return input.isSuccessful();
 112             }});
 113     }
 114
 115     @VisibleForTesting
 116     private static List<ItemSyncBox<Group>> extractGroupsToAddOrUpdate(final NodeId nodeId,
 117                                                                        final FlowCapableNode flowCapableNodeConfigured,
 118                                                                        final FlowCapableNode flowCapableNodeOperational) {
 119         final List<Group> groupsConfigured = ReconcileUtil.safeGroups(flowCapableNodeConfigured);
 120         final List<Group> groupsOperational = ReconcileUtil.safeGroups(flowCapableNodeOperational);
 121         final Map<Long, Group> groupOperationalMap = FlowCapableNodeLookups.wrapGroupsToMap(groupsOperational);
 122
 123         final List<Group> pendingGroups = new ArrayList<>();
 124         pendingGroups.addAll(groupsConfigured);
 125
 126         return ReconcileUtil.resolveAndDivideGroupDiffs(nodeId, groupOperationalMap, pendingGroups, true);
 127     }
 128
 129     @VisibleForTesting
 130     private static ItemSyncBox<Meter> extractMetersToAddOrUpdate(final NodeId nodeId,
 131                                                                  final FlowCapableNode flowCapableNodeConfigured,
 132                                                                  final FlowCapableNode flowCapableNodeOperational) {
 133         final List<Meter> metersConfigured = ReconcileUtil.safeMeters(flowCapableNodeConfigured);
 134         final List<Meter> metersOperational = ReconcileUtil.safeMeters(flowCapableNodeOperational);
 135         final Map<MeterId, Meter> meterOperationalMap = FlowCapableNodeLookups.wrapMetersToMap(metersOperational);
 136
 137         return ReconcileUtil.resolveMeterDiffs(nodeId, meterOperationalMap, metersConfigured, true);
 138     }
 139
 140     @VisibleForTesting
 141     private static Map<TableKey, ItemSyncBox<Flow>> extractFlowsToAddOrUpdate(final NodeId nodeId,
 142                                                                               final FlowCapableNode flowCapableNodeConfigured,
 143                                                                               final FlowCapableNode flowCapableNodeOperational) {
 144         final List<Table> tablesConfigured = ReconcileUtil.safeTables(flowCapableNodeConfigured);
 145         if (tablesConfigured.isEmpty()) {
 146             return Collections.emptyMap();
 147         }
 148
 149         final List<Table> tablesOperational = ReconcileUtil.safeTables(flowCapableNodeOperational);
 150         final Map<Short, Table> tableOperationalMap = FlowCapableNodeLookups.wrapTablesToMap(tablesOperational);
 151
 152         return ReconcileUtil.resolveFlowDiffsInAllTables(nodeId, tableOperationalMap, tablesConfigured, true);
 153     }
 154
 155     @VisibleForTesting
 156     private static Map<TableKey, ItemSyncBox<Flow>> extractFlowsToRemove(final NodeId nodeId,
 157                                                                          final FlowCapableNode flowCapableNodeConfigured,
 158                                                                          final FlowCapableNode flowCapableNodeOperational) {
 159         final List<Table> tablesOperational = ReconcileUtil.safeTables(flowCapableNodeOperational);
 160         if (tablesOperational.isEmpty()) {
 161             return Collections.emptyMap();
 162         }
 163
 164         final List<Table> tablesConfigured = ReconcileUtil.safeTables(flowCapableNodeConfigured);
 165         final Map<Short, Table> tableConfiguredMap = FlowCapableNodeLookups.wrapTablesToMap(tablesConfigured);
 166
 167         return ReconcileUtil.resolveFlowDiffsInAllTables(nodeId, tableConfiguredMap, tablesOperational, false);
 168     }
 169
 170     @VisibleForTesting
 171     private static ItemSyncBox<Meter> extractMetersToRemove(final NodeId nodeId,
 172                                                             final FlowCapableNode flowCapableNodeConfigured,
 173                                                             final FlowCapableNode flowCapableNodeOperational) {
 174         final List<Meter> metersConfigured = ReconcileUtil.safeMeters(flowCapableNodeConfigured);
 175         final List<Meter> metersOperational = ReconcileUtil.safeMeters(flowCapableNodeOperational);
 176         final Map<MeterId, Meter> meterConfiguredMap = FlowCapableNodeLookups.wrapMetersToMap(metersConfigured);
 177
 178         return ReconcileUtil.resolveMeterDiffs(nodeId, meterConfiguredMap, metersOperational, false);
 179     }
 180
 181     @VisibleForTesting
 182     private static List<ItemSyncBox<Group>> extractGroupsToRemove(final NodeId nodeId,
 183                                                                   final FlowCapableNode flowCapableNodeConfigured,
 184                                                                   final FlowCapableNode flowCapableNodeOperational) {
 185         final List<Group> groupsConfigured = ReconcileUtil.safeGroups(flowCapableNodeConfigured);
 186         final List<Group> groupsOperational = ReconcileUtil.safeGroups(flowCapableNodeOperational);
 187         final Map<Long, Group> groupConfiguredMap = FlowCapableNodeLookups.wrapGroupsToMap(groupsConfigured);
 188
 189         final List<Group> pendingGroups = new ArrayList<>();
 190         pendingGroups.addAll(groupsOperational);
 191
 192         return ReconcileUtil.resolveAndDivideGroupDiffs(nodeId, groupConfiguredMap, pendingGroups, false);
 193     }
 194 }