Merge "Handle duplicate tunnel on multiple dpns"
[genius.git] / interfacemanager / interfacemanager-impl / src / main / java / org / opendaylight / genius / interfacemanager / listeners / InterfaceInventoryStateListener.java
index 22523f188cba9f8701c02d221936601230c8f2dd..b7333697c32d8d76cce98945bf3face8881d8ec4 100644 (file)
@@ -9,13 +9,16 @@ package org.opendaylight.genius.interfacemanager.listeners;
 
 import com.google.common.util.concurrent.ListenableFuture;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
+import org.opendaylight.genius.datastoreutils.AsyncClusteredDataTreeChangeListenerBase;
 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
+import org.opendaylight.genius.interfacemanager.IfmConstants;
 import org.opendaylight.genius.interfacemanager.IfmUtil;
+import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
 import org.opendaylight.genius.interfacemanager.commons.InterfaceMetaUtils;
 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateAddHelper;
 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateRemoveHelper;
 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateUpdateHelper;
+import org.opendaylight.genius.interfacemanager.renderer.ovs.utilities.IfmClusterUtils;
 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.AlivenessMonitorService;
@@ -29,7 +32,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.N
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-
+import java.math.BigInteger;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.Callable;
@@ -43,12 +46,12 @@ import java.util.concurrent.Callable;
  * If PortName is not unique across DPNs, this implementation can have problems.
  */
 
-public class InterfaceInventoryStateListener extends AsyncDataTreeChangeListenerBase<FlowCapableNodeConnector, InterfaceInventoryStateListener> {
+public class InterfaceInventoryStateListener extends AsyncClusteredDataTreeChangeListenerBase<FlowCapableNodeConnector, InterfaceInventoryStateListener> {
     private static final Logger LOG = LoggerFactory.getLogger(InterfaceInventoryStateListener.class);
-    private DataBroker dataBroker;
-    private IdManagerService idManager;
-    private IMdsalApiManager mdsalApiManager;
-    private AlivenessMonitorService alivenessMonitorService;
+    private final DataBroker dataBroker;
+    private final IdManagerService idManager;
+    private final IMdsalApiManager mdsalApiManager;
+    private final AlivenessMonitorService alivenessMonitorService;
 
     public InterfaceInventoryStateListener(final DataBroker dataBroker, final IdManagerService idManager,
                                            final IMdsalApiManager mdsalApiManager, final AlivenessMonitorService alivenessMonitorService) {
@@ -73,67 +76,87 @@ public class InterfaceInventoryStateListener extends AsyncDataTreeChangeListener
     @Override
     protected void remove(InstanceIdentifier<FlowCapableNodeConnector> key,
                           FlowCapableNodeConnector flowCapableNodeConnectorOld) {
-        LOG.debug("Received NodeConnector Remove Event: {}, {}", key, flowCapableNodeConnectorOld);
-        remove(key, flowCapableNodeConnectorOld, true);
+        IfmClusterUtils.runOnlyInLeaderNode(() -> {
+            LOG.debug("Received NodeConnector Remove Event: {}, {}", key, flowCapableNodeConnectorOld);
+            String portName = flowCapableNodeConnectorOld.getName();
+            NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class)).getId();
+
+            if (!InterfaceManagerCommonUtils.isNovaOrTunnelPort(portName)) {
+                portName = getDpnPrefixedPortName(nodeConnectorId, portName);
+            }
+            remove(nodeConnectorId, null, flowCapableNodeConnectorOld, portName, true);
+        });
     }
 
     @Override
     protected void update(InstanceIdentifier<FlowCapableNodeConnector> key, FlowCapableNodeConnector fcNodeConnectorOld,
                           FlowCapableNodeConnector fcNodeConnectorNew) {
-        LOG.debug("Received NodeConnector Update Event: {}, {}, {}", key, fcNodeConnectorOld, fcNodeConnectorNew);
-        String portName = fcNodeConnectorNew.getName();
-        DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
-
-        InterfaceStateUpdateWorker portStateUpdateWorker = new InterfaceStateUpdateWorker(key, fcNodeConnectorOld,
-                fcNodeConnectorNew, portName);
-        coordinator.enqueueJob(portName, portStateUpdateWorker, 3);
+        IfmClusterUtils.runOnlyInLeaderNode(() -> {
+            LOG.debug("Received NodeConnector Update Event: {}, {}, {}", key, fcNodeConnectorOld, fcNodeConnectorNew);
+            String portName = fcNodeConnectorNew.getName();
+            DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
+
+            InterfaceStateUpdateWorker portStateUpdateWorker = new InterfaceStateUpdateWorker(key, fcNodeConnectorOld,
+                    fcNodeConnectorNew, portName);
+            coordinator.enqueueJob(portName, portStateUpdateWorker, IfmConstants.JOB_MAX_RETRIES);
+        });
     }
 
     @Override
     protected void add(InstanceIdentifier<FlowCapableNodeConnector> key, FlowCapableNodeConnector fcNodeConnectorNew) {
-        LOG.debug("Received NodeConnector Add Event: {}, {}", key, fcNodeConnectorNew);
-        //VM Migration: Delete existing interface entry for older DPN
-        remove(key, fcNodeConnectorNew, false);
-        String portName = fcNodeConnectorNew.getName();
-        NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class)).getId();
-        DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
-
-        InterfaceStateAddWorker ifStateAddWorker = new InterfaceStateAddWorker(idManager, nodeConnectorId,
-                fcNodeConnectorNew, portName);
-        coordinator.enqueueJob(portName, ifStateAddWorker, 3);
-    }
-
-    /**
-     * VM Migration: VM migrated from DPN1 to DPN2.
-     * VM booted from new DPN host will preserves its configuration including ID, name and other properties.
-     * In certain vm migration scenario like nova evacuate, vm reboot
-     * it is expected to receive the events in a non-sequential manner
-     * In Nova evacuate scenario, OFPPR_ADD from DPN2 will be received before OFPPR_DELETE from DPN1.
-     * To cleanup existing entry in OperDS, remove method will be called from add()
-     *
-     */
-    private void remove(InstanceIdentifier<FlowCapableNodeConnector> key,
-                        FlowCapableNodeConnector flowCapableNodeConnectorOld, boolean isNwTrigger) {
-        LOG.debug("Received user/network NodeConnector Remove Event: {}, {}", key, flowCapableNodeConnectorOld);
-        String portName = flowCapableNodeConnectorOld.getName();
-        NodeConnectorId nodeConnectorIdNew = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class)).getId();
-
-        //VM Migration: Skip OFPPR_DELETE event received after OFPPR_ADD for same interface
-        NodeConnectorId nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(portName, dataBroker);
-        if(nodeConnectorIdOld != null && !nodeConnectorIdNew.equals(nodeConnectorIdOld)) {
-            if(isNwTrigger) {
-                LOG.info("Received NodeConnector Remove Event for the interface exists in another DPN: {}, {}", nodeConnectorIdNew, nodeConnectorIdOld);
-                return;
+        IfmClusterUtils.runOnlyInLeaderNode(() -> {
+            LOG.debug("Received NodeConnector Add Event: {}, {}", key, fcNodeConnectorNew);
+            String portName = fcNodeConnectorNew.getName();
+            NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class)).getId();
+
+            //VM Migration: Delete existing interface entry for older DPN
+            if (InterfaceManagerCommonUtils.isNovaOrTunnelPort(portName)) {
+                NodeConnectorId nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(portName, dataBroker);
+                if (nodeConnectorIdOld != null && !nodeConnectorId.equals(nodeConnectorIdOld)) {
+                    if (InterfaceManagerCommonUtils.isTunnelPort(portName)) {
+                        BigInteger oldDpnId = IfmUtil.getDpnFromNodeConnectorId(nodeConnectorIdOld);
+                        BigInteger newDpnId = IfmUtil.getDpnFromNodeConnectorId(nodeConnectorId);
+                        LOG.warn("DPNID changed for tunnel interface {}: old {} new {}", portName, oldDpnId, newDpnId);
+                        if(InterfaceMetaUtils.isPortConfiguredOnBridge(portName, oldDpnId, dataBroker) ||
+                                !InterfaceMetaUtils.isPortConfiguredOnBridge(portName, newDpnId, dataBroker)) {
+                            // Remove old interface only it wasn't configured through us and new one is.
+                            return;
+                        }
+                    }
+                    LOG.debug("Triggering NodeConnector Remove Event for the interface: {}, {}, {}", portName, nodeConnectorId, nodeConnectorIdOld);
+                    remove(nodeConnectorId, nodeConnectorIdOld, fcNodeConnectorNew, portName, false);
+                    //Adding a delay of 10sec for VM migration, so applications can process remove and add events
+                    try {
+                        Thread.sleep(IfmConstants.DELAY_TIME_IN_MILLISECOND);
+                    } catch (InterruptedException e) {
+                        LOG.error("Error while waiting for the vm migration remove events to get processed");
+                    }
+                }
+            } else {
+                portName = getDpnPrefixedPortName(nodeConnectorId, portName);
             }
-        }
+            DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
+            InterfaceStateAddWorker ifStateAddWorker = new InterfaceStateAddWorker(idManager, nodeConnectorId,
+                    fcNodeConnectorNew, portName);
+            coordinator.enqueueJob(portName, ifStateAddWorker, IfmConstants.JOB_MAX_RETRIES);
+        });
+    }
 
+    private void remove(NodeConnectorId nodeConnectorIdNew, NodeConnectorId nodeConnectorIdOld,
+                        FlowCapableNodeConnector fcNodeConnectorNew, String portName, boolean isNetworkEvent) {
+        boolean isNodePresent = InterfaceManagerCommonUtils.isNodePresent(dataBroker, nodeConnectorIdNew);
         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
-
-        InterfaceStateRemoveWorker portStateRemoveWorker = new InterfaceStateRemoveWorker(idManager,
-                nodeConnectorIdNew, nodeConnectorIdOld, flowCapableNodeConnectorOld, portName);
-        coordinator.enqueueJob(portName, portStateRemoveWorker, 3);
+        InterfaceStateRemoveWorker portStateRemoveWorker = new InterfaceStateRemoveWorker(idManager, nodeConnectorIdNew,
+                nodeConnectorIdOld, fcNodeConnectorNew, portName, portName, isNodePresent, isNetworkEvent, true);
+        coordinator.enqueueJob(portName, portStateRemoveWorker, IfmConstants.JOB_MAX_RETRIES);
     }
 
+    private String getDpnPrefixedPortName(NodeConnectorId nodeConnectorId, String portName) {
+        portName = IfmUtil.getDpnFromNodeConnectorId(nodeConnectorId).toString() +
+                IfmConstants.OF_URI_SEPARATOR +
+                portName;
+        return portName;
+    }
     private class InterfaceStateAddWorker implements Callable {
         private final NodeConnectorId nodeConnectorId;
         private final FlowCapableNodeConnector fcNodeConnectorNew;
@@ -175,10 +198,10 @@ public class InterfaceInventoryStateListener extends AsyncDataTreeChangeListener
     }
 
     private class InterfaceStateUpdateWorker implements Callable {
-        private InstanceIdentifier<FlowCapableNodeConnector> key;
+        private final InstanceIdentifier<FlowCapableNodeConnector> key;
         private final FlowCapableNodeConnector fcNodeConnectorOld;
         private final FlowCapableNodeConnector fcNodeConnectorNew;
-        private String interfaceName;
+        private final String interfaceName;
 
 
         public InterfaceStateUpdateWorker(InstanceIdentifier<FlowCapableNodeConnector> key,
@@ -219,36 +242,58 @@ public class InterfaceInventoryStateListener extends AsyncDataTreeChangeListener
 
     private class InterfaceStateRemoveWorker implements Callable {
         private final NodeConnectorId nodeConnectorIdNew;
-        private final NodeConnectorId nodeConnectorIdOld;
+        private NodeConnectorId nodeConnectorIdOld;
         FlowCapableNodeConnector fcNodeConnectorOld;
         private final String interfaceName;
+        private final String parentInterface;
         private final IdManagerService idManager;
+        private final boolean isNodePresent;
+        private final boolean isNetworkEvent;
+        private final boolean isParentInterface;
 
         public InterfaceStateRemoveWorker(IdManagerService idManager, NodeConnectorId nodeConnectorIdNew,
                                           NodeConnectorId nodeConnectorIdOld,
                                           FlowCapableNodeConnector fcNodeConnectorOld,
-                                          String portName) {
+                                          String interfaceName,
+                                          String parentInterface,
+                                          boolean isNodePresent,
+                                          boolean isNetworkEvent,
+                                          boolean isParentInterface) {
             this.nodeConnectorIdNew = nodeConnectorIdNew;
             this.nodeConnectorIdOld = nodeConnectorIdOld;
             this.fcNodeConnectorOld = fcNodeConnectorOld;
-            this.interfaceName = portName;
+            this.interfaceName = interfaceName;
+            this.parentInterface = parentInterface;
             this.idManager = idManager;
+            this.isNodePresent = isNodePresent;
+            this.isNetworkEvent = isNetworkEvent;
+            this.isParentInterface = isParentInterface;
         }
 
         @Override
         public Object call() throws Exception {
             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
             // to call the respective helpers.
-            List<ListenableFuture<Void>> futures = OvsInterfaceStateRemoveHelper.removeInterfaceStateConfiguration(idManager, mdsalApiManager, alivenessMonitorService,
-                    nodeConnectorIdNew, nodeConnectorIdOld, dataBroker, interfaceName, fcNodeConnectorOld);
+
+            List<ListenableFuture<Void>> futures = null;
+            //VM Migration: Skip OFPPR_DELETE event received after OFPPR_ADD for same interface from Older DPN
+            if (isParentInterface && isNetworkEvent) {
+                nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(interfaceName, dataBroker);
+                if(nodeConnectorIdOld != null && !nodeConnectorIdNew.equals(nodeConnectorIdOld)) {
+                    LOG.debug("Dropping the NodeConnector Remove Event for the interface: {}, {}, {}", interfaceName, nodeConnectorIdNew, nodeConnectorIdOld);
+                    return futures;
+                }
+            }
+
+            futures = OvsInterfaceStateRemoveHelper.removeInterfaceStateConfiguration(idManager, mdsalApiManager, alivenessMonitorService,
+                    nodeConnectorIdNew, nodeConnectorIdOld, dataBroker, interfaceName, fcNodeConnectorOld, isNodePresent, parentInterface);
 
             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
                 // Fetch all interfaces on this port and trigger remove worker for each of them
-                InterfaceStateRemoveWorker interfaceStateRemoveWorker = new InterfaceStateRemoveWorker(idManager,
-                        nodeConnectorIdNew, nodeConnectorIdOld, fcNodeConnectorOld, interfaceChildEntry.getChildInterface());
+                InterfaceStateRemoveWorker interfaceStateRemoveWorker = new InterfaceStateRemoveWorker(idManager, nodeConnectorIdNew,
+                        nodeConnectorIdOld, fcNodeConnectorOld, interfaceChildEntry.getChildInterface(), interfaceName, isNodePresent, isNetworkEvent, false);
                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateRemoveWorker);
-
             }
             return futures;
         }
@@ -272,4 +317,4 @@ public class InterfaceInventoryStateListener extends AsyncDataTreeChangeListener
         }
         return new ArrayList<>();
     }
-}
\ No newline at end of file
+}