Bug 6193 - Change in length of DatapathId of a switch
[openflowplugin.git] / applications / forwardingrules-manager / src / main / java / org / opendaylight / openflowplugin / applications / frm / impl / FlowNodeReconciliationImpl.java
index 2b62037b373c20eade1284e0ff6d14fdcd43a556..909f4c1423b3113cea57c6c820cccc44aff45c71 100644 (file)
@@ -8,27 +8,23 @@
 
 package org.opendaylight.openflowplugin.applications.frm.impl;
 
+import java.math.BigInteger;
+import java.util.*;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
 import java.util.concurrent.atomic.AtomicInteger;
 import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Iterables;
 import com.google.common.collect.Lists;
 import com.google.common.util.concurrent.CheckedFuture;
 import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.Futures;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.ListIterator;
-import java.util.Map;
-import java.util.Set;
+
 import java.util.concurrent.Callable;
-import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
-import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
-import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
-import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
+
+import org.opendaylight.controller.md.sal.binding.api.*;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
 import org.opendaylight.openflowplugin.applications.frm.FlowNodeReconciliation;
@@ -65,12 +61,13 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.Meter
 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeaturesKey;
 import org.opendaylight.yangtools.concepts.ListenerRegistration;
-import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import javax.annotation.Nonnull;
+
 
 /**
  * forwardingrules-manager
@@ -92,7 +89,16 @@ public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
     private final ForwardingRulesManager provider;
     public static final String SEPARATOR = ":";
 
-    private ListenerRegistration<DataChangeListener> listenerRegistration;
+    private ListenerRegistration<FlowNodeReconciliationImpl> listenerRegistration;
+
+    private final int THREAD_POOL_SIZE = 4;
+    ExecutorService executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
+
+    private static final InstanceIdentifier<FlowCapableNode> II_TO_FLOW_CAPABLE_NODE
+            = InstanceIdentifier.builder(Nodes.class)
+            .child(Node.class)
+            .augmentation(FlowCapableNode.class)
+            .build();
 
     public FlowNodeReconciliationImpl (final ForwardingRulesManager manager, final DataBroker db) {
         this.provider = Preconditions.checkNotNull(manager, "ForwardingRulesManager can not be null!");
@@ -101,14 +107,17 @@ public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
         final InstanceIdentifier<FlowCapableNode> flowNodeWildCardIdentifier = InstanceIdentifier.create(Nodes.class)
                 .child(Node.class).augmentation(FlowCapableNode.class);
 
+        final DataTreeIdentifier<FlowCapableNode> treeId =
+                new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL, flowNodeWildCardIdentifier);
+
+        try {
         SimpleTaskRetryLooper looper = new SimpleTaskRetryLooper(ForwardingRulesManagerImpl.STARTUP_LOOP_TICK,
                 ForwardingRulesManagerImpl.STARTUP_LOOP_MAX_RETRIES);
-        try {
-            listenerRegistration = looper.loopUntilNoException(new Callable<ListenerRegistration<DataChangeListener>>() {
+
+            listenerRegistration = looper.loopUntilNoException(new Callable<ListenerRegistration<FlowNodeReconciliationImpl>>() {
                 @Override
-                public ListenerRegistration<DataChangeListener> call() throws Exception {
-                    return db.registerDataChangeListener(LogicalDatastoreType.OPERATIONAL,
-                            flowNodeWildCardIdentifier, FlowNodeReconciliationImpl.this, DataChangeScope.BASE);
+                public ListenerRegistration<FlowNodeReconciliationImpl> call() throws Exception {
+                    return dataBroker.registerDataTreeChangeListener(treeId, FlowNodeReconciliationImpl.this);
                 }
             });
         } catch (Exception e) {
@@ -132,46 +141,60 @@ public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
     }
 
     @Override
-    public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> changeEvent) {
-        Preconditions.checkNotNull(changeEvent,"Async ChangeEvent can not be null!");
-        /* All DataObjects for create */
-        final Set<InstanceIdentifier<?>>  createdData = changeEvent.getCreatedData() != null
-                ? changeEvent.getCreatedData().keySet() : Collections.<InstanceIdentifier<?>> emptySet();
-        /* All DataObjects for remove */
-        final Set<InstanceIdentifier<?>> removeData = changeEvent.getRemovedPaths() != null
-                ? changeEvent.getRemovedPaths() : Collections.<InstanceIdentifier<?>> emptySet();
-        /* All updated DataObjects */
-        final Map<InstanceIdentifier<?>, DataObject> updateData = changeEvent.getUpdatedData() != null
-                ? changeEvent.getUpdatedData() : Collections.<InstanceIdentifier<?>, DataObject>emptyMap();
-
-        for (InstanceIdentifier<?> entryKey : removeData) {
-            final InstanceIdentifier<FlowCapableNode> nodeIdent = entryKey
-                    .firstIdentifierOf(FlowCapableNode.class);
-            if ( ! nodeIdent.isWildcarded()) {
-                flowNodeDisconnected(nodeIdent);
+    public void onDataTreeChanged(@Nonnull Collection<DataTreeModification<FlowCapableNode>> changes) {
+        Preconditions.checkNotNull(changes, "Changes may not be null!");
+
+        for (DataTreeModification<FlowCapableNode> change : changes) {
+            final InstanceIdentifier<FlowCapableNode> key = change.getRootPath().getRootIdentifier();
+            final DataObjectModification<FlowCapableNode> mod = change.getRootNode();
+            final InstanceIdentifier<FlowCapableNode> nodeIdent =
+                    key.firstIdentifierOf(FlowCapableNode.class);
+
+            switch (mod.getModificationType()) {
+                case DELETE:
+                    if (mod.getDataAfter() == null) {
+                        remove(key, mod.getDataBefore(), nodeIdent);
+                    }
+                    break;
+                case SUBTREE_MODIFIED:
+                    //NO-OP since we donot need to reconciliate on Node-updated
+                    break;
+                case WRITE:
+                    if (mod.getDataBefore() == null) {
+                        add(key, mod.getDataAfter(), nodeIdent);
+                    }
+                    break;
+                default:
+                    throw new IllegalArgumentException("Unhandled modification type " + mod.getModificationType());
             }
         }
-        for (InstanceIdentifier<?> entryKey : createdData) {
-            final InstanceIdentifier<FlowCapableNode> nodeIdent = entryKey
-                    .firstIdentifierOf(FlowCapableNode.class);
+    }
+
+
+
+    public void remove(InstanceIdentifier<FlowCapableNode> identifier, FlowCapableNode del,
+                       InstanceIdentifier<FlowCapableNode> nodeIdent) {
+        if(compareInstanceIdentifierTail(identifier,II_TO_FLOW_CAPABLE_NODE)){
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("Node removed: {}",nodeIdent.firstKeyOf(Node.class).getId().getValue());
+            }
+
             if ( ! nodeIdent.isWildcarded()) {
-                flowNodeConnected(nodeIdent);
+                flowNodeDisconnected(nodeIdent);
             }
+
         }
+    }
 
-        // FIXME: just a hack to cover DS/operational dirty start
-        // if all conventional ways failed and there is update
-        if (removeData.isEmpty() && createdData.isEmpty() && updateData.size() == 1) {
-            for (Map.Entry<InstanceIdentifier<?>, DataObject> entry : updateData.entrySet()) {
-                // and only if this update covers top element (flow-capable-node)
-                if (FlowCapableNode.class.equals(entry.getKey().getTargetType())) {
-                    final InstanceIdentifier<FlowCapableNode> nodeIdent = entry.getKey()
-                            .firstIdentifierOf(FlowCapableNode.class);
-                    if (!nodeIdent.isWildcarded()) {
-                        // then force registration to local node cache and reconcile
-                        flowNodeConnected(nodeIdent, true);
-                    }
-                }
+    public void add(InstanceIdentifier<FlowCapableNode> identifier, FlowCapableNode add,
+                    InstanceIdentifier<FlowCapableNode> nodeIdent) {
+        if(compareInstanceIdentifierTail(identifier,II_TO_FLOW_CAPABLE_NODE)){
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("Node added: {}",nodeIdent.firstKeyOf(Node.class).getId().getValue());
+            }
+
+            if ( ! nodeIdent.isWildcarded()) {
+                flowNodeConnected(nodeIdent);
             }
         }
     }
@@ -197,40 +220,49 @@ public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
                         connectedNode.toString());
                 reconciliationPreProcess(connectedNode);
             }
-            reconciliation(connectedNode);
+            ReconciliationTask reconciliationTask = new ReconciliationTask(connectedNode);
+            executor.execute(reconciliationTask);
         }
     }
 
-    private void reconciliation(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
+    private class ReconciliationTask implements Runnable {
 
-        String sNode = nodeIdent.firstKeyOf(Node.class, NodeKey.class).getId().getValue();
-        long nDpId = getDpnIdFromNodeName(sNode);
-
-        ReadOnlyTransaction trans = provider.getReadTranaction();
-        Optional<FlowCapableNode> flowNode = Optional.absent();
+        InstanceIdentifier<FlowCapableNode> nodeIdentity;
 
-        AtomicInteger counter = new AtomicInteger();
-        //initialize the counter
-        counter.set(0);
-        try {
-            flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdent).get();
-        }
-        catch (Exception e) {
-            LOG.error("Fail with read Config/DS for Node {} !", nodeIdent, e);
+        public ReconciliationTask(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
+           nodeIdentity = nodeIdent;
         }
 
-        if (flowNode.isPresent()) {
-            /* Tables - have to be pushed before groups */
-            // CHECK if while pusing the update, updateTableInput can be null to emulate a table add
-            List<TableFeatures> tableList = flowNode.get().getTableFeatures() != null
-                    ? flowNode.get().getTableFeatures() : Collections.<TableFeatures> emptyList() ;
-            for (TableFeatures tableFeaturesItem : tableList) {
-                TableFeaturesKey tableKey = tableFeaturesItem.getKey();
-                KeyedInstanceIdentifier<TableFeatures, TableFeaturesKey> tableFeaturesII
-                    = nodeIdent.child(TableFeatures.class, new TableFeaturesKey(tableKey.getTableId()));
-                        provider.getTableFeaturesCommiter().update(tableFeaturesII, tableFeaturesItem, null, nodeIdent);
+        @Override
+        public void run() {
+
+            String sNode = nodeIdentity.firstKeyOf(Node.class, NodeKey.class).getId().getValue();
+            BigInteger nDpId = getDpnIdFromNodeName(sNode);
+
+            ReadOnlyTransaction trans = provider.getReadTranaction();
+            Optional<FlowCapableNode> flowNode = Optional.absent();
+
+            AtomicInteger counter = new AtomicInteger();
+            //initialize the counter
+            counter.set(0);
+            try {
+                flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdentity).get();
+            } catch (Exception e) {
+                LOG.error("Fail with read Config/DS for Node {} !", nodeIdentity, e);
             }
 
+            if (flowNode.isPresent()) {
+            /* Tables - have to be pushed before groups */
+                // CHECK if while pusing the update, updateTableInput can be null to emulate a table add
+                List<TableFeatures> tableList = flowNode.get().getTableFeatures() != null
+                        ? flowNode.get().getTableFeatures() : Collections.<TableFeatures>emptyList();
+                for (TableFeatures tableFeaturesItem : tableList) {
+                    TableFeaturesKey tableKey = tableFeaturesItem.getKey();
+                    KeyedInstanceIdentifier<TableFeatures, TableFeaturesKey> tableFeaturesII
+                            = nodeIdentity.child(TableFeatures.class, new TableFeaturesKey(tableKey.getTableId()));
+                    provider.getTableFeaturesCommiter().update(tableFeaturesII, tableFeaturesItem, null, nodeIdentity);
+                }
+
             /* Groups - have to be first */
                 List<Group> groups = flowNode.get().getGroup() != null
                         ? flowNode.get().getGroup() : Collections.<Group>emptyList();
@@ -241,10 +273,10 @@ public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
                 List<Group> suspectedGroups = new ArrayList<>();
 
                 while ((!(toBeInstalledGroups.isEmpty()) || !(suspectedGroups.isEmpty())) &&
-                        (counter.get()<=provider.getConfiguration().getReconciliationRetryCount())) { //also check if the counter has not crossed the threshold
+                        (counter.get() <= provider.getConfiguration().getReconciliationRetryCount())) { //also check if the counter has not crossed the threshold
 
-                    if(toBeInstalledGroups.isEmpty() && ! suspectedGroups.isEmpty()){
-                        LOG.error("These Groups are pointing to node-connectors that are not up yet {}",suspectedGroups.toString());
+                    if (toBeInstalledGroups.isEmpty() && !suspectedGroups.isEmpty()) {
+                        LOG.error("These Groups are pointing to node-connectors that are not up yet {}", suspectedGroups.toString());
                         toBeInstalledGroups.addAll(suspectedGroups);
                         break;
                     }
@@ -255,27 +287,27 @@ public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
                         boolean okToInstall = true;
                         for (Bucket bucket : group.getBuckets().getBucket()) {
                             for (Action action : bucket.getAction()) {
-                               //chained-port
+                                //chained-port
                                 if (action.getAction().getImplementedInterface().getName()
-                                        .equals("org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCase")){
-                                    String nodeConnectorUri = ((OutputActionCase)(action.getAction()))
+                                        .equals("org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCase")) {
+                                    String nodeConnectorUri = ((OutputActionCase) (action.getAction()))
                                             .getOutputAction().getOutputNodeConnector().getValue();
 
-                                    LOG.warn("Installing the group for node connector {}",nodeConnectorUri);
+                                    LOG.warn("Installing the group for node connector {}", nodeConnectorUri);
 
                                     //check if the nodeconnector is there in the multimap
                                     boolean isPresent = provider.getFlowNodeConnectorInventoryTranslatorImpl()
                                             .isNodeConnectorUpdated(nDpId, nodeConnectorUri);
                                     //if yes set okToInstall = true
 
-                                    if(isPresent){
-                                       break;
+                                    if (isPresent) {
+                                        break;
                                     }//else put it in a different list and still set okToInstall = true
                                     else {
                                         suspectedGroups.add(group);
                                         LOG.error("Not yet received the node-connector updated for {} " +
-                                                "for the group with id {}",nodeConnectorUri,group.getGroupId().toString());
-                                         break;
+                                                "for the group with id {}", nodeConnectorUri, group.getGroupId().toString());
+                                        break;
                                     }
 
 
@@ -290,21 +322,20 @@ public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
                                     }
                                 }
                             }
-                            if (!okToInstall){
+                            if (!okToInstall) {
                                 //increment retry counter value
                                 counter.incrementAndGet();
                                 break;
                             }
 
 
-
                         }
 
 
                         if (okToInstall) {
                             final KeyedInstanceIdentifier<Group, GroupKey> groupIdent =
-                                    nodeIdent.child(Group.class, group.getKey());
-                            this.provider.getGroupCommiter().add(groupIdent, group, nodeIdent);
+                                    nodeIdentity.child(Group.class, group.getKey());
+                            provider.getGroupCommiter().add(groupIdent, group, nodeIdentity);
                             alreadyInstalledGroupids.add(group.getGroupId().getValue());
                             iterator.remove();
                             // resetting the counter to zero
@@ -314,48 +345,48 @@ public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
                 }
 
             /* installation of suspected groups*/
-            if(!toBeInstalledGroups.isEmpty()){
-                for(Group group :toBeInstalledGroups){
-                    LOG.error("Installing the group {} finally although the port is not up after checking for {} times "
-                            ,group.getGroupId().toString(),provider.getConfiguration().getReconciliationRetryCount());
-                    final KeyedInstanceIdentifier<Group, GroupKey> groupIdent =
-                            nodeIdent.child(Group.class, group.getKey());
-                    this.provider.getGroupCommiter().add(groupIdent, group, nodeIdent);
+                if (!toBeInstalledGroups.isEmpty()) {
+                    for (Group group : toBeInstalledGroups) {
+                        LOG.error("Installing the group {} finally although the port is not up after checking for {} times "
+                                , group.getGroupId().toString(), provider.getConfiguration().getReconciliationRetryCount());
+                        final KeyedInstanceIdentifier<Group, GroupKey> groupIdent =
+                                nodeIdentity.child(Group.class, group.getKey());
+                        provider.getGroupCommiter().add(groupIdent, group, nodeIdentity);
+                    }
                 }
-            }
             /* Meters */
-            List<Meter> meters = flowNode.get().getMeter() != null
-                    ? flowNode.get().getMeter() : Collections.<Meter> emptyList();
-            for (Meter meter : meters) {
-                final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent =
-                        nodeIdent.child(Meter.class, meter.getKey());
-                this.provider.getMeterCommiter().add(meterIdent, meter, nodeIdent);
-            }
+                List<Meter> meters = flowNode.get().getMeter() != null
+                        ? flowNode.get().getMeter() : Collections.<Meter>emptyList();
+                for (Meter meter : meters) {
+                    final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent =
+                            nodeIdentity.child(Meter.class, meter.getKey());
+                    provider.getMeterCommiter().add(meterIdent, meter, nodeIdentity);
+                }
             /* Flows */
-            List<Table> tables = flowNode.get().getTable() != null
-                    ? flowNode.get().getTable() : Collections.<Table> emptyList();
-            for (Table table : tables) {
-                final KeyedInstanceIdentifier<Table, TableKey> tableIdent =
-                        nodeIdent.child(Table.class, table.getKey());
-                List<Flow> flows = table.getFlow() != null ? table.getFlow() : Collections.<Flow> emptyList();
-                for (Flow flow : flows) {
-                    final KeyedInstanceIdentifier<Flow, FlowKey> flowIdent =
-                            tableIdent.child(Flow.class, flow.getKey());
-                    this.provider.getFlowCommiter().add(flowIdent, flow, nodeIdent);
+                List<Table> tables = flowNode.get().getTable() != null
+                        ? flowNode.get().getTable() : Collections.<Table>emptyList();
+                for (Table table : tables) {
+                    final KeyedInstanceIdentifier<Table, TableKey> tableIdent =
+                            nodeIdentity.child(Table.class, table.getKey());
+                    List<Flow> flows = table.getFlow() != null ? table.getFlow() : Collections.<Flow>emptyList();
+                    for (Flow flow : flows) {
+                        final KeyedInstanceIdentifier<Flow, FlowKey> flowIdent =
+                                tableIdent.child(Flow.class, flow.getKey());
+                        provider.getFlowCommiter().add(flowIdent, flow, nodeIdentity);
+                    }
                 }
             }
-        }
         /* clean transaction */
-        trans.close();
+            trans.close();
+        }
     }
-       private long getDpnIdFromNodeName(String nodeName) {
+    private BigInteger getDpnIdFromNodeName(String nodeName) {
         String dpId = nodeName.substring(nodeName.lastIndexOf(SEPARATOR) + 1);
-               return Long.parseLong(dpId);
-       }
+        return new BigInteger(dpId);
+    }
 
     private void reconciliationPreProcess(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 
-
         List<InstanceIdentifier<StaleFlow>> staleFlowsToBeBulkDeleted = Lists.newArrayList();
         List<InstanceIdentifier<StaleGroup>> staleGroupsToBeBulkDeleted = Lists.newArrayList();
         List<InstanceIdentifier<StaleMeter>> staleMetersToBeBulkDeleted = Lists.newArrayList();
@@ -534,8 +565,9 @@ public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
     }
 
 
-
-
-
+    private boolean compareInstanceIdentifierTail(InstanceIdentifier<?> identifier1,
+                                                  InstanceIdentifier<?> identifier2) {
+        return Iterables.getLast(identifier1.getPathArguments()).equals(Iterables.getLast(identifier2.getPathArguments()));
+    }
 }