applications/forwardingrules-manager/src/main/java/org/opendaylight/openflowplugin/applications/frm/impl/FlowNodeReconciliationImpl.java

   1 /*
   2  * Copyright (c) 2014, 2017 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 package org.opendaylight.openflowplugin.applications.frm.impl;
   9
  10 import static org.opendaylight.openflowplugin.api.openflow.ReconciliationState.ReconciliationStatus.COMPLETED;
  11 import static org.opendaylight.openflowplugin.api.openflow.ReconciliationState.ReconciliationStatus.FAILED;
  12 import static org.opendaylight.openflowplugin.api.openflow.ReconciliationState.ReconciliationStatus.STARTED;
  13
  14 import com.google.common.base.Preconditions;
  15 import com.google.common.collect.Lists;
  16 import com.google.common.util.concurrent.FluentFuture;
  17 import com.google.common.util.concurrent.FutureCallback;
  18 import com.google.common.util.concurrent.Futures;
  19 import com.google.common.util.concurrent.JdkFutureAdapters;
  20 import com.google.common.util.concurrent.ListenableFuture;
  21 import com.google.common.util.concurrent.MoreExecutors;
  22 import com.google.common.util.concurrent.ThreadFactoryBuilder;
  23 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  24 import java.math.BigInteger;
  25 import java.time.LocalDateTime;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.Collections;
  29 import java.util.HashMap;
  30 import java.util.List;
  31 import java.util.ListIterator;
  32 import java.util.Map;
  33 import java.util.Optional;
  34 import java.util.concurrent.Callable;
  35 import java.util.concurrent.ConcurrentHashMap;
  36 import java.util.concurrent.ExecutionException;
  37 import java.util.concurrent.ExecutorService;
  38 import java.util.concurrent.Executors;
  39 import java.util.concurrent.ThreadFactory;
  40 import java.util.concurrent.TimeUnit;
  41 import java.util.concurrent.TimeoutException;
  42 import java.util.concurrent.atomic.AtomicLong;
  43 import org.opendaylight.mdsal.binding.api.DataBroker;
  44 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  45 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  46 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  47 import org.opendaylight.openflowplugin.api.OFConstants;
  48 import org.opendaylight.openflowplugin.api.openflow.FlowGroupCacheManager;
  49 import org.opendaylight.openflowplugin.api.openflow.ReconciliationState;
  50 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  51 import org.opendaylight.openflowplugin.applications.frm.FlowNodeReconciliation;
  52 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
  53 import org.opendaylight.openflowplugin.applications.frm.util.FrmUtil;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.GroupActionCase;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCase;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterKey;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeter;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeterKey;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlow;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlowKey;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.Buckets;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroup;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroupKey;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInput;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInputBuilder;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesOutput;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInput;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInputBuilder;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleOutput;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.SalBundleService;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.Messages;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.MessagesBuilder;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.Message;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.MessageBuilder;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveFlowCaseBuilder;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveGroupCaseBuilder;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.bundle.remove.flow._case.RemoveFlowCaseDataBuilder;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.bundle.remove.group._case.RemoveGroupCaseDataBuilder;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleControlType;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleFlags;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleId;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.rf.state.rev170713.ResultState;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeaturesKey;
 104 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 105 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
 106 import org.opendaylight.yangtools.yang.common.RpcResult;
 107 import org.opendaylight.yangtools.yang.common.Uint32;
 108 import org.slf4j.Logger;
 109 import org.slf4j.LoggerFactory;
 110
 111 /**
 112  * Default implementation of {@link ForwardingRulesManager}.
 113  *
 114  * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
 115  */
 116 public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
 117
 118     private static final Logger LOG = LoggerFactory.getLogger(FlowNodeReconciliationImpl.class);
 119     private static final Logger OF_EVENT_LOG = LoggerFactory.getLogger("OfEventLog");
 120
 121     // The number of nanoseconds to wait for a single group to be added.
 122     private static final long ADD_GROUP_TIMEOUT = TimeUnit.SECONDS.toNanos(3);
 123
 124     // The maximum number of nanoseconds to wait for completion of add-group RPCs.
 125     private static final long MAX_ADD_GROUP_TIMEOUT = TimeUnit.SECONDS.toNanos(20);
 126     private static final String SEPARATOR = ":";
 127     private static final int THREAD_POOL_SIZE = 4;
 128     private static final ThreadFactory THREAD_FACTORY = new ThreadFactoryBuilder()
 129             .setNameFormat("BundleResync-%d")
 130             .setDaemon(false)
 131             .setUncaughtExceptionHandler((thread, ex) -> LOG.error("Uncaught exception {}", thread, ex))
 132             .build();
 133     private final DataBroker dataBroker;
 134     private final ForwardingRulesManager provider;
 135     private final String serviceName;
 136     private final int priority;
 137     private final ResultState resultState;
 138     private final Map<DeviceInfo, ListenableFuture<Boolean>> futureMap = new ConcurrentHashMap<>();
 139
 140     private final ExecutorService executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
 141
 142     private final SalBundleService salBundleService;
 143
 144     private static final AtomicLong BUNDLE_ID = new AtomicLong();
 145     private static final BundleFlags BUNDLE_FLAGS = new BundleFlags(true, true);
 146     private final Map<String, ReconciliationState> reconciliationStates;
 147
 148     public FlowNodeReconciliationImpl(final ForwardingRulesManager manager, final DataBroker db,
 149                                       final String serviceName, final int priority, final ResultState resultState,
 150                                       final FlowGroupCacheManager flowGroupCacheManager) {
 151         this.provider = Preconditions.checkNotNull(manager, "ForwardingRulesManager can not be null!");
 152         dataBroker = Preconditions.checkNotNull(db, "DataBroker can not be null!");
 153         this.serviceName = serviceName;
 154         this.priority = priority;
 155         this.resultState = resultState;
 156         salBundleService = Preconditions.checkNotNull(manager.getSalBundleService(),
 157                 "salBundleService can not be null!");
 158         reconciliationStates = flowGroupCacheManager.getReconciliationStates();
 159     }
 160
 161     @Override
 162     public void close() {
 163         if (executor != null) {
 164             executor.shutdownNow();
 165         }
 166     }
 167
 168     @Override
 169     public ListenableFuture<Boolean> reconcileConfiguration(InstanceIdentifier<FlowCapableNode> connectedNode) {
 170         LOG.info("Triggering reconciliation for device {}", connectedNode.firstKeyOf(Node.class));
 171         // Clearing the group registry cache for the connected node if exists
 172         String nodeId = FrmUtil.getNodeIdValueFromNodeIdentifier(connectedNode);
 173         provider.getDevicesGroupRegistry().clearNodeGroups(nodeId);
 174         if (provider.isStaleMarkingEnabled()) {
 175             LOG.info("Stale-Marking is ENABLED and proceeding with deletion of " + "stale-marked entities on switch {}",
 176                     connectedNode);
 177             reconciliationPreProcess(connectedNode);
 178         }
 179         if (provider.isBundleBasedReconciliationEnabled()) {
 180             BundleBasedReconciliationTask bundleBasedReconTask = new BundleBasedReconciliationTask(connectedNode);
 181             return JdkFutureAdapters.listenInPoolThread(executor.submit(bundleBasedReconTask));
 182         } else {
 183             ReconciliationTask reconciliationTask = new ReconciliationTask(connectedNode);
 184             return JdkFutureAdapters.listenInPoolThread(executor.submit(reconciliationTask));
 185         }
 186     }
 187
 188     @Override
 189     public void flowNodeDisconnected(InstanceIdentifier<FlowCapableNode> disconnectedNode) {
 190         String node = disconnectedNode.firstKeyOf(Node.class).getId().getValue();
 191         BigInteger dpnId = getDpnIdFromNodeName(node);
 192         reconciliationStates.remove(dpnId.toString());
 193     }
 194
 195     private class BundleBasedReconciliationTask implements Callable<Boolean> {
 196         final InstanceIdentifier<FlowCapableNode> nodeIdentity;
 197
 198         BundleBasedReconciliationTask(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 199             nodeIdentity = nodeIdent;
 200         }
 201
 202         @Override
 203         public Boolean call() {
 204             String node = nodeIdentity.firstKeyOf(Node.class).getId().getValue();
 205             Optional<FlowCapableNode> flowNode = Optional.empty();
 206             BundleId bundleIdValue = new BundleId(Uint32.valueOf(BUNDLE_ID.getAndIncrement()));
 207             BigInteger dpnId = getDpnIdFromNodeName(node);
 208             ExecutorService service = Executors.newSingleThreadExecutor(THREAD_FACTORY);
 209             LOG.info("Triggering bundle based reconciliation for device : {}", dpnId);
 210             try (ReadTransaction trans = provider.getReadTransaction()) {
 211                 flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdentity).get();
 212             } catch (ExecutionException | InterruptedException e) {
 213                 LOG.error("Error occurred while reading the configuration data store for node {}", nodeIdentity, e);
 214             }
 215
 216             if (flowNode.isPresent()) {
 217                 ReconciliationState reconciliationState = new ReconciliationState(
 218                         STARTED, LocalDateTime.now());
 219                 //put the dpn info into the map
 220                 reconciliationStates.put(dpnId.toString(), reconciliationState);
 221                 LOG.debug("FlowNode present for Datapath ID {}", dpnId);
 222                 OF_EVENT_LOG.debug("Bundle Reconciliation Start, Node: {}", dpnId);
 223                 final NodeRef nodeRef = new NodeRef(nodeIdentity.firstIdentifierOf(Node.class));
 224
 225                 final ControlBundleInput closeBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
 226                         .setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
 227                         .setType(BundleControlType.ONFBCTCLOSEREQUEST).build();
 228
 229                 final ControlBundleInput openBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
 230                         .setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
 231                         .setType(BundleControlType.ONFBCTOPENREQUEST).build();
 232
 233                 final ControlBundleInput commitBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
 234                         .setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
 235                         .setType(BundleControlType.ONFBCTCOMMITREQUEST).build();
 236
 237                 final AddBundleMessagesInput deleteAllFlowGroupsInput = new AddBundleMessagesInputBuilder()
 238                         .setNode(nodeRef).setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
 239                         .setMessages(createMessages(nodeRef)).build();
 240
 241                 LOG.debug("Closing openflow bundle for device {}", dpnId);
 242                 /* Close previously opened bundle on the openflow switch if any */
 243                 ListenableFuture<RpcResult<ControlBundleOutput>> closeBundle
 244                         = salBundleService.controlBundle(closeBundleInput);
 245
 246                 /* Open a new bundle on the switch */
 247                 ListenableFuture<RpcResult<ControlBundleOutput>> openBundle
 248                         = Futures.transformAsync(closeBundle, rpcResult -> {
 249                             if (rpcResult.isSuccessful()) {
 250                                 LOG.debug("Existing bundle is successfully closed for device {}", dpnId);
 251                             }
 252                             return salBundleService.controlBundle(openBundleInput);
 253                         }, service);
 254
 255                     /* Push groups and flows via bundle add messages */
 256                 ListenableFuture<RpcResult<AddBundleMessagesOutput>> deleteAllFlowGroupsFuture
 257                         = Futures.transformAsync(openBundle, rpcResult -> {
 258                             if (rpcResult.isSuccessful()) {
 259                                 LOG.debug("Open bundle is successful for device {}", dpnId);
 260                                 return salBundleService.addBundleMessages(deleteAllFlowGroupsInput);
 261                             }
 262                             return Futures.immediateFuture(null);
 263                         }, service);
 264
 265                 /* Push flows and groups via bundle add messages */
 266                 Optional<FlowCapableNode> finalFlowNode = flowNode;
 267                 ListenableFuture<List<RpcResult<AddBundleMessagesOutput>>> addbundlesFuture
 268                         = Futures.transformAsync(deleteAllFlowGroupsFuture, rpcResult -> {
 269                             if (rpcResult.isSuccessful()) {
 270                                 LOG.debug("Adding delete all flow/group message is successful for device {}", dpnId);
 271                                 return Futures.allAsList(addBundleMessages(finalFlowNode.get(), bundleIdValue,
 272                                         nodeIdentity));
 273                             }
 274                             return Futures.immediateFuture(null);
 275                         }, service);
 276
 277                     /* Commit the bundle on the openflow switch */
 278                 ListenableFuture<RpcResult<ControlBundleOutput>> commitBundleFuture
 279                         = Futures.transformAsync(addbundlesFuture, rpcResult -> {
 280                             LOG.debug("Adding bundle messages completed for device {}", dpnId);
 281                             return salBundleService.controlBundle(commitBundleInput);
 282                         }, service);
 283
 284                 /* Bundles not supported for meters */
 285                 Collection<Meter> meters = flowNode.get().nonnullMeter().values();
 286                 Futures.transformAsync(commitBundleFuture,
 287                     rpcResult -> {
 288                         if (rpcResult.isSuccessful()) {
 289                             for (Meter meter : meters) {
 290                                 final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent = nodeIdentity
 291                                         .child(Meter.class, meter.key());
 292                                 provider.getMeterCommiter().add(meterIdent, meter, nodeIdentity);
 293                             }
 294                         }
 295                         return Futures.immediateFuture(null);
 296                     }, service);
 297                 try {
 298                     RpcResult<ControlBundleOutput> bundleFuture = commitBundleFuture.get();
 299                     if (bundleFuture != null && bundleFuture.isSuccessful()) {
 300                         reconciliationState.setState(COMPLETED, LocalDateTime.now());
 301                         LOG.debug("Completing bundle based reconciliation for device ID:{}", dpnId);
 302                         OF_EVENT_LOG.debug("Bundle Reconciliation Finish, Node: {}", dpnId);
 303                         return true;
 304                     } else {
 305                         reconciliationState.setState(FAILED, LocalDateTime.now());
 306                         LOG.error("commit bundle failed for device {} with error {}", dpnId,
 307                                 commitBundleFuture.get().getErrors());
 308                         return false;
 309                     }
 310                 } catch (InterruptedException | ExecutionException e) {
 311                     reconciliationState.setState(FAILED, LocalDateTime.now());
 312                     LOG.error("Error while doing bundle based reconciliation for device ID:{}", dpnId, e);
 313                     return false;
 314                 } finally {
 315                     service.shutdown();
 316                 }
 317             }
 318             LOG.error("FlowNode not present for Datapath ID {}", dpnId);
 319             return false;
 320         }
 321     }
 322
 323     @Override
 324     public ListenableFuture<Boolean> startReconciliation(DeviceInfo node) {
 325         InstanceIdentifier<FlowCapableNode> connectedNode = node.getNodeInstanceIdentifier()
 326                 .augmentation(FlowCapableNode.class);
 327         // Clearing the group registry cache for the connected node if exists
 328         provider.getDevicesGroupRegistry().clearNodeGroups(node.toString());
 329         return futureMap.computeIfAbsent(node, future -> reconcileConfiguration(connectedNode));
 330     }
 331
 332     @Override
 333     public ListenableFuture<Boolean> endReconciliation(DeviceInfo node) {
 334         ListenableFuture<Boolean> listenableFuture = futureMap.computeIfPresent(node, (key, future) -> future);
 335         if (listenableFuture != null) {
 336             listenableFuture.cancel(true);
 337             futureMap.remove(node);
 338         }
 339         return Futures.immediateFuture(true);
 340     }
 341
 342     @Override
 343     public int getPriority() {
 344         return priority;
 345     }
 346
 347     @Override
 348     public String getName() {
 349         return serviceName;
 350     }
 351
 352     @Override
 353     public ResultState getResultState() {
 354         return resultState;
 355     }
 356
 357     private class ReconciliationTask implements Callable<Boolean> {
 358
 359         InstanceIdentifier<FlowCapableNode> nodeIdentity;
 360
 361         ReconciliationTask(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 362             nodeIdentity = nodeIdent;
 363         }
 364
 365         @Override
 366         public Boolean call() {
 367             String node = nodeIdentity.firstKeyOf(Node.class).getId().getValue();
 368             BigInteger dpnId = getDpnIdFromNodeName(node);
 369             OF_EVENT_LOG.debug("Reconciliation Start, Node: {}", dpnId);
 370
 371             Optional<FlowCapableNode> flowNode;
 372             // initialize the counter
 373             int counter = 0;
 374             try (ReadTransaction trans = provider.getReadTransaction()) {
 375                 flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdentity).get();
 376             } catch (ExecutionException | InterruptedException e) {
 377                 LOG.warn("Fail with read Config/DS for Node {} !", nodeIdentity, e);
 378                 return false;
 379             }
 380
 381             if (flowNode.isPresent()) {
 382                 /* Tables - have to be pushed before groups */
 383                 // CHECK if while pushing the update, updateTableInput can be null to emulate a
 384                 // table add
 385                 ReconciliationState reconciliationState = new ReconciliationState(
 386                         STARTED, LocalDateTime.now());
 387                 //put the dpn info into the map
 388                 reconciliationStates.put(dpnId.toString(), reconciliationState);
 389                 LOG.debug("Triggering reconciliation for node {} with state: {}", dpnId, STARTED);
 390                 Collection<TableFeatures> tableList = flowNode.get().nonnullTableFeatures().values();
 391                 for (TableFeatures tableFeaturesItem : tableList) {
 392                     TableFeaturesKey tableKey = tableFeaturesItem.key();
 393                     KeyedInstanceIdentifier<TableFeatures, TableFeaturesKey> tableFeaturesII = nodeIdentity
 394                             .child(TableFeatures.class, new TableFeaturesKey(tableKey.getTableId()));
 395                     provider.getTableFeaturesCommiter().update(tableFeaturesII, tableFeaturesItem, null, nodeIdentity);
 396                 }
 397
 398                 /* Groups - have to be first */
 399                 Collection<Group> groups = flowNode.get().nonnullGroup().values();
 400                 List<Group> toBeInstalledGroups = new ArrayList<>();
 401                 toBeInstalledGroups.addAll(groups);
 402                 // new list for suspected groups pointing to ports .. when the ports come up
 403                 // late
 404                 List<Group> suspectedGroups = new ArrayList<>();
 405                 Map<Uint32, ListenableFuture<?>> groupFutures = new HashMap<>();
 406
 407                 while ((!toBeInstalledGroups.isEmpty() || !suspectedGroups.isEmpty())
 408                         && counter <= provider.getReconciliationRetryCount()) { // also check if the counter has not
 409                                                                                 // crossed the threshold
 410
 411                     if (toBeInstalledGroups.isEmpty() && !suspectedGroups.isEmpty()) {
 412                         LOG.debug("These Groups are pointing to node-connectors that are not up yet {}",
 413                                 suspectedGroups);
 414                         toBeInstalledGroups.addAll(suspectedGroups);
 415                         break;
 416                     }
 417
 418                     ListIterator<Group> iterator = toBeInstalledGroups.listIterator();
 419                     while (iterator.hasNext()) {
 420                         Group group = iterator.next();
 421                         boolean okToInstall = true;
 422                         Buckets buckets = group.getBuckets();
 423                         Collection<Bucket> bucketList = buckets == null ? null : buckets.nonnullBucket().values();
 424                         if (bucketList == null) {
 425                             bucketList = Collections.<Bucket>emptyList();
 426                         }
 427                         for (Bucket bucket : bucketList) {
 428                             Collection<Action> actions = bucket.nonnullAction().values();
 429                             if (actions == null) {
 430                                 actions = Collections.<Action>emptyList();
 431                             }
 432                             for (Action action : actions) {
 433                                 // chained-port
 434                                 if (action.getAction().implementedInterface().getName()
 435                                         .equals("org.opendaylight.yang.gen.v1.urn.opendaylight"
 436                                                 + ".action.types.rev131112.action.action.OutputActionCase")) {
 437                                     String nodeConnectorUri = ((OutputActionCase) action.getAction()).getOutputAction()
 438                                             .getOutputNodeConnector().getValue();
 439
 440                                     LOG.debug("Installing the group for node connector {}", nodeConnectorUri);
 441
 442                                     // check if the nodeconnector is there in the multimap
 443                                     boolean isPresent = provider.getFlowNodeConnectorInventoryTranslatorImpl()
 444                                             .isNodeConnectorUpdated(dpnId, nodeConnectorUri);
 445                                     // if yes set okToInstall = true
 446
 447                                     if (isPresent) {
 448                                         break;
 449                                     } else {
 450                                         // else put it in a different list and still set okToInstall = true
 451                                         suspectedGroups.add(group);
 452                                         LOG.debug(
 453                                                 "Not yet received the node-connector updated for {} "
 454                                                         + "for the group with id {}",
 455                                                 nodeConnectorUri, group.getGroupId());
 456                                         break;
 457                                     }
 458                                 } else if (action.getAction().implementedInterface().getName()
 459                                         .equals("org.opendaylight.yang.gen.v1.urn.opendaylight"
 460                                                 + ".action.types.rev131112.action.action.GroupActionCase")) {
 461                                     // chained groups
 462                                     Uint32 groupId = ((GroupActionCase) action.getAction()).getGroupAction()
 463                                             .getGroupId();
 464                                     ListenableFuture<?> future = groupFutures.get(groupId);
 465                                     if (future == null) {
 466                                         okToInstall = false;
 467                                         break;
 468                                     }
 469                                     // Need to ensure that the group specified
 470                                     // by group-action is already installed.
 471                                     awaitGroup(node, future);
 472                                 }
 473                             }
 474                             if (!okToInstall) {
 475                                 // increment retry counter value
 476                                 counter++;
 477                                 break;
 478                             }
 479                         }
 480                         if (okToInstall) {
 481                             addGroup(groupFutures, group);
 482                             iterator.remove();
 483                             // resetting the counter to zero
 484                             counter = 0;
 485                         }
 486                     }
 487                 }
 488
 489                 /* installation of suspected groups */
 490                 if (!toBeInstalledGroups.isEmpty()) {
 491                     for (Group group : toBeInstalledGroups) {
 492                         LOG.debug(
 493                                 "Installing the group {} finally although "
 494                                         + "the port is not up after checking for {} times ",
 495                                 group.getGroupId(), provider.getReconciliationRetryCount());
 496                         addGroup(groupFutures, group);
 497                     }
 498                 }
 499                 /* Meters */
 500                 Collection<Meter> meters = flowNode.get().nonnullMeter().values();
 501                 for (Meter meter : meters) {
 502                     final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent = nodeIdentity.child(Meter.class,
 503                             meter.key());
 504                     provider.getMeterCommiter().add(meterIdent, meter, nodeIdentity);
 505                 }
 506
 507                 // Need to wait for all groups to be installed before adding
 508                 // flows.
 509                 awaitGroups(node, groupFutures.values());
 510
 511                 /* Flows */
 512                 Collection<Table> tables = flowNode.get().getTable() != null ? flowNode.get().nonnullTable().values()
 513                         : Collections.<Table>emptyList();
 514                 int flowCount = 0;
 515                 for (Table table : tables) {
 516                     final KeyedInstanceIdentifier<Table, TableKey> tableIdent = nodeIdentity.child(Table.class,
 517                             table.key());
 518                     Collection<Flow> flows = table.nonnullFlow().values();
 519                     flowCount += flows.size();
 520                     for (Flow flow : flows) {
 521                         final KeyedInstanceIdentifier<Flow, FlowKey> flowIdent = tableIdent.child(Flow.class,
 522                                 flow.key());
 523                         provider.getFlowCommiter().add(flowIdent, flow, nodeIdentity);
 524                     }
 525                 }
 526                 reconciliationState.setState(COMPLETED, LocalDateTime.now());
 527                 OF_EVENT_LOG.debug("Reconciliation Finish, Node: {}, flow count: {}", dpnId, flowCount);
 528             }
 529             return true;
 530         }
 531
 532         /**
 533          * Invoke add-group RPC, and put listenable future associated with the RPC into
 534          * the given map.
 535          *
 536          * @param map
 537          *            The map to store listenable futures associated with add-group RPC.
 538          * @param group
 539          *            The group to add.
 540          */
 541         private void addGroup(Map<Uint32, ListenableFuture<?>> map, Group group) {
 542             KeyedInstanceIdentifier<Group, GroupKey> groupIdent = nodeIdentity.child(Group.class, group.key());
 543             final Uint32 groupId = group.getGroupId().getValue();
 544             ListenableFuture<?> future = JdkFutureAdapters
 545                     .listenInPoolThread(provider.getGroupCommiter().add(groupIdent, group, nodeIdentity));
 546
 547             Futures.addCallback(future, new FutureCallback<Object>() {
 548                 @Override
 549                 public void onSuccess(Object result) {
 550                     if (LOG.isTraceEnabled()) {
 551                         LOG.trace("add-group RPC completed: node={}, id={}",
 552                                 nodeIdentity.firstKeyOf(Node.class).getId().getValue(), groupId);
 553                     }
 554                 }
 555
 556                 @Override
 557                 public void onFailure(Throwable cause) {
 558                     LOG.debug("add-group RPC failed: node={}, id={}",
 559                             nodeIdentity.firstKeyOf(Node.class).getId().getValue(), groupId, cause);
 560                 }
 561             }, MoreExecutors.directExecutor());
 562
 563             map.put(groupId, future);
 564         }
 565
 566         /**
 567          * Wait for completion of add-group RPC.
 568          *
 569          * @param nodeId
 570          *            The identifier for the target node.
 571          * @param future
 572          *            Future associated with add-group RPC that installs the target
 573          *            group.
 574          */
 575         private void awaitGroup(String nodeId, ListenableFuture<?> future) {
 576             awaitGroups(nodeId, Collections.singleton(future));
 577         }
 578
 579         /**
 580          * Wait for completion of add-group RPCs.
 581          *
 582          * @param nodeId
 583          *            The identifier for the target node.
 584          * @param futures
 585          *            A collection of futures associated with add-group RPCs.
 586          */
 587         private void awaitGroups(String nodeId, Collection<ListenableFuture<?>> futures) {
 588             if (!futures.isEmpty()) {
 589                 long timeout = Math.min(ADD_GROUP_TIMEOUT * futures.size(), MAX_ADD_GROUP_TIMEOUT);
 590                 try {
 591                     Futures.successfulAsList(futures).get(timeout, TimeUnit.NANOSECONDS);
 592                     LOG.trace("awaitGroups() completed: node={}", nodeId);
 593                 } catch (TimeoutException | InterruptedException | ExecutionException e) {
 594                     LOG.debug("add-group RPCs did not complete: node={}", nodeId);
 595                 }
 596             }
 597         }
 598     }
 599
 600     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 601             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 602     private static BigInteger getDpnIdFromNodeName(String nodeName) {
 603         String dpId = nodeName.substring(nodeName.lastIndexOf(SEPARATOR) + 1);
 604         return new BigInteger(dpId);
 605     }
 606
 607     private void reconciliationPreProcess(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 608         List<InstanceIdentifier<StaleFlow>> staleFlowsToBeBulkDeleted = Lists.newArrayList();
 609         List<InstanceIdentifier<StaleGroup>> staleGroupsToBeBulkDeleted = Lists.newArrayList();
 610         List<InstanceIdentifier<StaleMeter>> staleMetersToBeBulkDeleted = Lists.newArrayList();
 611
 612         Optional<FlowCapableNode> flowNode = Optional.empty();
 613
 614         try (ReadTransaction trans = provider.getReadTransaction()) {
 615             flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdent).get();
 616         } catch (ExecutionException | InterruptedException e) {
 617             LOG.warn("Reconciliation Pre-Processing Fail with read Config/DS for Node {} !", nodeIdent, e);
 618         }
 619
 620         if (flowNode.isPresent()) {
 621
 622             LOG.debug("Proceeding with deletion of stale-marked Flows on switch {} using Openflow interface",
 623                     nodeIdent);
 624             /* Stale-Flows - Stale-marked Flows have to be removed first for safety */
 625             Collection<Table> tables = flowNode.get().nonnullTable().values();
 626             for (Table table : tables) {
 627                 final KeyedInstanceIdentifier<Table, TableKey> tableIdent = nodeIdent.child(Table.class,
 628                         table.key());
 629                 Collection<StaleFlow> staleFlows = table.nonnullStaleFlow().values();
 630                 for (StaleFlow staleFlow : staleFlows) {
 631
 632                     FlowBuilder flowBuilder = new FlowBuilder(staleFlow);
 633                     Flow toBeDeletedFlow = flowBuilder.setId(staleFlow.getId()).build();
 634
 635                     final KeyedInstanceIdentifier<Flow, FlowKey> flowIdent = tableIdent.child(Flow.class,
 636                             toBeDeletedFlow.key());
 637
 638                     this.provider.getFlowCommiter().remove(flowIdent, toBeDeletedFlow, nodeIdent);
 639
 640                     staleFlowsToBeBulkDeleted.add(getStaleFlowInstanceIdentifier(staleFlow, nodeIdent));
 641                 }
 642             }
 643
 644             LOG.debug("Proceeding with deletion of stale-marked Groups for switch {} using Openflow interface",
 645                     nodeIdent);
 646
 647             // TODO: Should we collate the futures of RPC-calls to be sure that groups are
 648             // Flows are fully deleted
 649             // before attempting to delete groups - just in case there are references
 650
 651             /* Stale-marked Groups - Can be deleted after flows */
 652             Collection<StaleGroup> staleGroups = flowNode.get().nonnullStaleGroup().values();
 653             for (StaleGroup staleGroup : staleGroups) {
 654
 655                 GroupBuilder groupBuilder = new GroupBuilder(staleGroup);
 656                 Group toBeDeletedGroup = groupBuilder.setGroupId(staleGroup.getGroupId()).build();
 657
 658                 final KeyedInstanceIdentifier<Group, GroupKey> groupIdent = nodeIdent.child(Group.class,
 659                         toBeDeletedGroup.key());
 660
 661                 this.provider.getGroupCommiter().remove(groupIdent, toBeDeletedGroup, nodeIdent);
 662
 663                 staleGroupsToBeBulkDeleted.add(getStaleGroupInstanceIdentifier(staleGroup, nodeIdent));
 664             }
 665
 666             LOG.debug("Proceeding with deletion of stale-marked Meters for switch {} using Openflow interface",
 667                     nodeIdent);
 668             /* Stale-marked Meters - can be deleted anytime - so least priority */
 669             Collection<StaleMeter> staleMeters = flowNode.get().getStaleMeter().values();
 670
 671             for (StaleMeter staleMeter : staleMeters) {
 672
 673                 MeterBuilder meterBuilder = new MeterBuilder(staleMeter);
 674                 Meter toBeDeletedMeter = meterBuilder.setMeterId(staleMeter.getMeterId()).build();
 675
 676                 final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent = nodeIdent.child(Meter.class,
 677                         toBeDeletedMeter.key());
 678
 679                 this.provider.getMeterCommiter().remove(meterIdent, toBeDeletedMeter, nodeIdent);
 680
 681                 staleMetersToBeBulkDeleted.add(getStaleMeterInstanceIdentifier(staleMeter, nodeIdent));
 682             }
 683
 684         }
 685
 686         LOG.debug("Deleting all stale-marked flows/groups/meters of for switch {} in Configuration DS",
 687                 nodeIdent);
 688         // Now, do the bulk deletions
 689         deleteDSStaleFlows(staleFlowsToBeBulkDeleted);
 690         deleteDSStaleGroups(staleGroupsToBeBulkDeleted);
 691         deleteDSStaleMeters(staleMetersToBeBulkDeleted);
 692     }
 693
 694     private void deleteDSStaleFlows(List<InstanceIdentifier<StaleFlow>> flowsForBulkDelete) {
 695         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 696
 697         for (InstanceIdentifier<StaleFlow> staleFlowIId : flowsForBulkDelete) {
 698             writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, staleFlowIId);
 699         }
 700
 701         FluentFuture<?> submitFuture = writeTransaction.commit();
 702         handleStaleEntityDeletionResultFuture(submitFuture);
 703     }
 704
 705     private void deleteDSStaleGroups(List<InstanceIdentifier<StaleGroup>> groupsForBulkDelete) {
 706         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 707
 708         for (InstanceIdentifier<StaleGroup> staleGroupIId : groupsForBulkDelete) {
 709             writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, staleGroupIId);
 710         }
 711
 712         FluentFuture<?> submitFuture = writeTransaction.commit();
 713         handleStaleEntityDeletionResultFuture(submitFuture);
 714     }
 715
 716     private void deleteDSStaleMeters(List<InstanceIdentifier<StaleMeter>> metersForBulkDelete) {
 717         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 718
 719         for (InstanceIdentifier<StaleMeter> staleMeterIId : metersForBulkDelete) {
 720             writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, staleMeterIId);
 721         }
 722
 723         FluentFuture<?> submitFuture = writeTransaction.commit();
 724         handleStaleEntityDeletionResultFuture(submitFuture);
 725     }
 726
 727     private static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight
 728         .flow.inventory.rev130819.tables.table.StaleFlow> getStaleFlowInstanceIdentifier(
 729             StaleFlow staleFlow, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 730         return nodeIdent.child(Table.class, new TableKey(staleFlow.getTableId())).child(
 731                 org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlow.class,
 732                 new StaleFlowKey(new FlowId(staleFlow.getId())));
 733     }
 734
 735     private static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight
 736         .group.types.rev131018.groups.StaleGroup> getStaleGroupInstanceIdentifier(
 737             StaleGroup staleGroup, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 738         return nodeIdent.child(StaleGroup.class, new StaleGroupKey(new GroupId(staleGroup.getGroupId())));
 739     }
 740
 741     private static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight
 742         .flow.inventory.rev130819.meters.StaleMeter> getStaleMeterInstanceIdentifier(
 743             StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 744         return nodeIdent.child(StaleMeter.class, new StaleMeterKey(new MeterId(staleMeter.getMeterId())));
 745     }
 746
 747     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 748             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 749     private List<ListenableFuture<RpcResult<AddBundleMessagesOutput>>> addBundleMessages(final FlowCapableNode flowNode,
 750                                                          final BundleId bundleIdValue,
 751                                                          final InstanceIdentifier<FlowCapableNode> nodeIdentity) {
 752         List<ListenableFuture<RpcResult<AddBundleMessagesOutput>>> futureList = new ArrayList<>();
 753         for (Group group : flowNode.nonnullGroup().values()) {
 754             final KeyedInstanceIdentifier<Group, GroupKey> groupIdent = nodeIdentity.child(Group.class, group.key());
 755             futureList.add(provider.getBundleGroupListener().add(groupIdent, group, nodeIdentity, bundleIdValue));
 756         }
 757
 758         for (Table table : flowNode.nonnullTable().values()) {
 759             final KeyedInstanceIdentifier<Table, TableKey> tableIdent = nodeIdentity.child(Table.class, table.key());
 760             for (Flow flow : table.nonnullFlow().values()) {
 761                 final KeyedInstanceIdentifier<Flow, FlowKey> flowIdent = tableIdent.child(Flow.class, flow.key());
 762                 futureList.add(provider.getBundleFlowListener().add(flowIdent, flow, nodeIdentity, bundleIdValue));
 763             }
 764         }
 765         OF_EVENT_LOG.debug("Flow/Group count is {}", futureList.size());
 766         return futureList;
 767     }
 768
 769     private static void handleStaleEntityDeletionResultFuture(FluentFuture<?> submitFuture) {
 770         submitFuture.addCallback(new FutureCallback<Object>() {
 771             @Override
 772             public void onSuccess(Object result) {
 773                 LOG.debug("Stale entity removal success");
 774             }
 775
 776             @Override
 777             public void onFailure(Throwable throwable) {
 778                 LOG.debug("Stale entity removal failed", throwable);
 779             }
 780         }, MoreExecutors.directExecutor());
 781     }
 782
 783     private static Flow getDeleteAllFlow() {
 784         return new FlowBuilder().setTableId(OFConstants.OFPTT_ALL).build();
 785     }
 786
 787     private static Group getDeleteAllGroup() {
 788         return new GroupBuilder()
 789                 .setGroupType(GroupTypes.GroupAll)
 790                 .setGroupId(new GroupId(OFConstants.OFPG_ALL))
 791                 .build();
 792     }
 793
 794     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 795             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 796     private static Messages createMessages(final NodeRef nodeRef) {
 797         final List<Message> messages = new ArrayList<>();
 798         messages.add(new MessageBuilder().setNode(nodeRef)
 799                 .setBundleInnerMessage(new BundleRemoveFlowCaseBuilder()
 800                         .setRemoveFlowCaseData(new RemoveFlowCaseDataBuilder(getDeleteAllFlow()).build()).build())
 801                 .build());
 802
 803         messages.add(new MessageBuilder().setNode(nodeRef)
 804                 .setBundleInnerMessage(new BundleRemoveGroupCaseBuilder()
 805                         .setRemoveGroupCaseData(new RemoveGroupCaseDataBuilder(getDeleteAllGroup()).build()).build())
 806                 .build());
 807         return new MessagesBuilder().setMessage(messages).build();
 808     }
 809 }