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