More elan Blueprint clean-up
[netvirt.git] / vpnservice / elanmanager / elanmanager-impl / src / main / java / org / opendaylight / netvirt / elan / internal / ElanPacketInHandler.java
index 24cf44ef6a315b391b909f407fa91568f5426d42..a827fc44dde0f588a979a05407673ad12b1e140f 100755 (executable)
@@ -7,72 +7,59 @@
  */
 package org.opendaylight.netvirt.elan.internal;
 
+import com.google.common.base.Optional;
 import java.math.BigInteger;
-
+import java.util.Arrays;
 import org.opendaylight.controller.liblldp.NetUtils;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.netvirt.elan.l2gw.utils.ElanL2GatewayUtils;
-import org.opendaylight.netvirt.elan.utils.ElanConstants;
-import org.opendaylight.netvirt.elan.utils.ElanUtils;
 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
 import org.opendaylight.genius.mdsalutil.MDSALUtil;
 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
 import org.opendaylight.genius.mdsalutil.NWUtil;
+import org.opendaylight.genius.mdsalutil.NwConstants;
 import org.opendaylight.genius.mdsalutil.packet.Ethernet;
+import org.opendaylight.netvirt.elan.l2gw.utils.ElanL2GatewayUtils;
+import org.opendaylight.netvirt.elan.utils.ElanUtils;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.NoMatch;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketInReason;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingListener;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntry;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntryBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntryKey;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.NoMatch;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketInReason;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingListener;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.base.Optional;
-
-import java.util.Arrays;
-
 @SuppressWarnings("deprecation")
 public class ElanPacketInHandler implements PacketProcessingListener {
 
+    private static final Logger LOG = LoggerFactory.getLogger(ElanPacketInHandler.class);
 
-    private ElanServiceProvider elanServiceProvider = null;
-    private static volatile ElanPacketInHandler elanPacketInHandler = null;
-    private static final Logger logger = LoggerFactory.getLogger(ElanPacketInHandler.class);
-
-    public ElanPacketInHandler(ElanServiceProvider elanServiceProvider) {
-
-        this.elanServiceProvider = elanServiceProvider;
-    }
-    public static ElanPacketInHandler getElanPacketInHandler(ElanServiceProvider elanServiceProvider) {
-        if (elanPacketInHandler == null) {
-            synchronized (ElanPacketInHandler.class) {
-                if (elanPacketInHandler == null)
-                {
-                    ElanPacketInHandler elanPacketInHandler = new ElanPacketInHandler(elanServiceProvider);
-                    return elanPacketInHandler;
+    private final DataBroker broker;
+    private final IInterfaceManager interfaceManager;
+    private final ElanUtils elanUtils;
+    private final ElanL2GatewayUtils elanL2GatewayUtils;
 
-                }
-            }
-        }
-        return elanPacketInHandler;
+    public ElanPacketInHandler(DataBroker dataBroker, final IInterfaceManager interfaceManager, ElanUtils elanUtils) {
+        broker = dataBroker;
+        this.interfaceManager = interfaceManager;
+        this.elanUtils = elanUtils;
+        this.elanL2GatewayUtils = elanUtils.getElanL2GatewayUtils();
     }
 
-
     @Override
     public void onPacketReceived(PacketReceived notification) {
-        Class<? extends PacketInReason>  pktInReason =  notification.getPacketInReason();
+        Class<? extends PacketInReason> pktInReason = notification.getPacketInReason();
         short tableId = notification.getTableId().getValue();
-        if (pktInReason == NoMatch.class && tableId == ElanConstants.ELAN_SMAC_TABLE) {
+        if (pktInReason == NoMatch.class && tableId == NwConstants.ELAN_SMAC_TABLE) {
             try {
                 byte[] data = notification.getPayload();
                 Ethernet res = new Ethernet();
@@ -87,98 +74,116 @@ public class ElanPacketInHandler implements PacketProcessingListener {
 
                 long portTag = MetaDataUtil.getLportFromMetadata(metadata).intValue();
 
-                Optional<IfIndexInterface> interfaceInfoOp = ElanUtils.getInterfaceInfoByInterfaceTag(portTag);
+                Optional<IfIndexInterface> interfaceInfoOp = elanUtils.getInterfaceInfoByInterfaceTag(portTag);
                 if (!interfaceInfoOp.isPresent()) {
-                    logger.warn("There is no interface for given portTag {}", portTag);
+                    LOG.warn("There is no interface for given portTag {}", portTag);
                     return;
                 }
                 String interfaceName = interfaceInfoOp.get().getInterfaceName();
-                ElanTagName elanTagName = ElanUtils.getElanInfoByElanTag(elanTag);
+                LOG.debug("Received a packet with srcMac: {} ElanTag: {} PortTag: {} InterfaceName: {}", macAddress,
+                        elanTag, portTag, interfaceName);
+                ElanTagName elanTagName = elanUtils.getElanInfoByElanTag(elanTag);
                 if (elanTagName == null) {
-                    logger.warn("not able to find elanTagName in elan-tag-name-map for elan tag {}", elanTag);
+                    LOG.warn("not able to find elanTagName in elan-tag-name-map for elan tag {}", elanTag);
                     return;
                 }
                 String elanName = elanTagName.getName();
-                MacEntry macEntry = ElanUtils.getInterfaceMacEntriesOperationalDataPath(interfaceName, physAddress);
+                MacEntry macEntry = elanUtils.getInterfaceMacEntriesOperationalDataPath(interfaceName, physAddress);
                 if (macEntry != null && macEntry.getInterface() == interfaceName) {
                     BigInteger macTimeStamp = macEntry.getControllerLearnedForwardingEntryTimestamp();
-                    if (System.currentTimeMillis() > macTimeStamp.longValue()+2000) {
+                    if (System.currentTimeMillis() > macTimeStamp.longValue() + 2000) {
                         /*
-                         * Protection time expired. Even though the MAC has been learnt (it is in the cache)
-                         * the packets are punted to controller. Which means, the the flows were not successfully
-                         * created in the DPN, but the MAC entry has been added successfully in the cache.
+                         * Protection time expired. Even though the MAC has been
+                         * learnt (it is in the cache) the packets are punted to
+                         * controller. Which means, the the flows were not
+                         * successfully created in the DPN, but the MAC entry
+                         * has been added successfully in the cache.
                          *
-                         * So, the cache has to be cleared and the flows and cache should be recreated (clearing
-                         * of cache is required so that the timestamp is updated).
+                         * So, the cache has to be cleared and the flows and
+                         * cache should be recreated (clearing of cache is
+                         * required so that the timestamp is updated).
                          */
-                        InstanceIdentifier<MacEntry> macEntryId =  ElanUtils.getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
-                        ElanUtils.delete(elanServiceProvider.getBroker(), LogicalDatastoreType.OPERATIONAL, macEntryId);
+                        InstanceIdentifier<MacEntry> macEntryId = ElanUtils
+                                .getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
+                        ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL, macEntryId);
                     } else {
                         // Protection time running. Ignore packets for 2 seconds
                         return;
                     }
                 } else if (macEntry != null) {
-                    // MAC address has moved. Overwrite the mapping and replace MAC flows
+                    // MAC address has moved. Overwrite the mapping and replace
+                    // MAC flows
                     long macTimeStamp = macEntry.getControllerLearnedForwardingEntryTimestamp().longValue();
-                    if (System.currentTimeMillis() > macTimeStamp+1000) {
+                    if (System.currentTimeMillis() > macTimeStamp + 1000) {
 
-                        InstanceIdentifier<MacEntry> macEntryId =  ElanUtils.getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
-                        ElanUtils.delete(elanServiceProvider.getBroker(), LogicalDatastoreType.OPERATIONAL, macEntryId);
+                        InstanceIdentifier<MacEntry> macEntryId = ElanUtils
+                                .getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
+                        ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL, macEntryId);
                         tryAndRemoveInvalidMacEntry(elanName, macEntry);
                     } else {
-                        // New FEs flood their packets on all interfaces. This can lead
-                        // to many contradicting packet_ins. Ignore all packets received
+                        // New FEs flood their packets on all interfaces. This
+                        // can lead
+                        // to many contradicting packet_ins. Ignore all packets
+                        // received
                         // within 1s after the first packet_in
                         return;
                     }
                 }
-                BigInteger timeStamp = new BigInteger(String.valueOf((long)System.currentTimeMillis()));
-                macEntry = new MacEntryBuilder().setInterface(interfaceName).setMacAddress(physAddress).setKey(new MacEntryKey(physAddress)).setControllerLearnedForwardingEntryTimestamp(timeStamp).setIsStaticAddress(false).build();
-                InstanceIdentifier<MacEntry> macEntryId = ElanUtils.getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
-                MDSALUtil.syncWrite(elanServiceProvider.getBroker(), LogicalDatastoreType.OPERATIONAL, macEntryId, macEntry);
-                InstanceIdentifier<MacEntry> elanMacEntryId = ElanUtils.getMacEntryOperationalDataPath(elanName, physAddress);
-                MDSALUtil.syncWrite(elanServiceProvider.getBroker(), LogicalDatastoreType.OPERATIONAL, elanMacEntryId, macEntry);
-                ElanInstance elanInstance = ElanUtils.getElanInstanceByName(elanName);
-                WriteTransaction flowWritetx = elanServiceProvider.getBroker().newWriteOnlyTransaction();
-                ElanUtils.setupMacFlows(elanInstance, elanServiceProvider.getInterfaceManager().getInterfaceInfo(interfaceName), elanInstance.getMacTimeout(), macAddress, flowWritetx);
+                BigInteger timeStamp = new BigInteger(String.valueOf((long) System.currentTimeMillis()));
+                macEntry = new MacEntryBuilder().setInterface(interfaceName).setMacAddress(physAddress)
+                        .setKey(new MacEntryKey(physAddress)).setControllerLearnedForwardingEntryTimestamp(timeStamp)
+                        .setIsStaticAddress(false).build();
+                InstanceIdentifier<MacEntry> macEntryId = ElanUtils
+                        .getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
+                MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, macEntryId,
+                        macEntry);
+                InstanceIdentifier<MacEntry> elanMacEntryId = ElanUtils.getMacEntryOperationalDataPath(elanName,
+                        physAddress);
+                MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, elanMacEntryId,
+                        macEntry);
+                ElanInstance elanInstance = ElanUtils.getElanInstanceByName(broker, elanName);
+                WriteTransaction flowWritetx = broker.newWriteOnlyTransaction();
+                elanUtils.setupMacFlows(elanInstance,
+                        interfaceManager.getInterfaceInfo(interfaceName),
+                        elanInstance.getMacTimeout(), macAddress, flowWritetx);
                 flowWritetx.submit();
 
-                BigInteger dpId = elanServiceProvider.getInterfaceManager().getDpnForInterface(interfaceName);
-                ElanL2GatewayUtils.scheduleAddDpnMacInExtDevices(elanInstance.getElanInstanceName(), dpId,
-                    Arrays.asList(physAddress));
+                BigInteger dpId = interfaceManager.getDpnForInterface(interfaceName);
+                elanL2GatewayUtils.scheduleAddDpnMacInExtDevices(elanInstance.getElanInstanceName(), dpId,
+                        Arrays.asList(physAddress));
             } catch (Exception e) {
-                logger.trace("Failed to decode packet: {}", e);
+                LOG.trace("Failed to decode packet: {}", e);
             }
         }
 
     }
 
-
     /*
- * Though this method is a little costlier because it uses try-catch construct, it is used
- * only in rare scenarios like MAC movement or invalid Static MAC having been added on a
* wrong ELAN.
- */
+     * Though this method is a little costlier because it uses try-catch
+     * construct, it is used only in rare scenarios like MAC movement or invalid
    * Static MAC having been added on a wrong ELAN.
    */
     private void tryAndRemoveInvalidMacEntry(String elanName, MacEntry macEntry) {
-        ElanInstance elanInfo = ElanUtils.getElanInstanceByName(elanName);
+        ElanInstance elanInfo = ElanUtils.getElanInstanceByName(broker, elanName);
         if (elanInfo == null) {
-            logger.warn(String.format("MAC %s is been added (either statically or dynamically) for an invalid Elan %s. "
-                + "Manual cleanup may be necessary", macEntry.getMacAddress(), elanName));
+            LOG.warn(String.format("MAC %s is been added (either statically or dynamically) for an invalid Elan %s. "
+                    + "Manual cleanup may be necessary", macEntry.getMacAddress(), elanName));
             return;
         }
 
-        InterfaceInfo oldInterfaceLport = elanServiceProvider.getInterfaceManager().getInterfaceInfo(macEntry.getInterface());
+        InterfaceInfo oldInterfaceLport = interfaceManager.getInterfaceInfo(macEntry.getInterface());
         if (oldInterfaceLport == null) {
-            logger.warn(String.format("MAC %s is been added (either statically or dynamically) on an invalid Logical Port %s. "
-                + "Manual cleanup may be necessary", macEntry.getMacAddress(), macEntry.getInterface()));
+            LOG.warn(
+                    String.format(
+                            "MAC %s is been added (either statically or dynamically) on an invalid Logical Port %s. "
+                                    + "Manual cleanup may be necessary",
+                            macEntry.getMacAddress(), macEntry.getInterface()));
             return;
         }
-        WriteTransaction flowDeletetx = elanServiceProvider.getBroker().newWriteOnlyTransaction();
-        ElanUtils.deleteMacFlows(elanInfo, oldInterfaceLport, macEntry, flowDeletetx);
+        WriteTransaction flowDeletetx = broker.newWriteOnlyTransaction();
+        elanUtils.deleteMacFlows(elanInfo, oldInterfaceLport, macEntry, flowDeletetx);
         flowDeletetx.submit();
-        ElanL2GatewayUtils.removeMacsFromElanExternalDevices(elanInfo, Arrays.asList(macEntry.getMacAddress()));
+        elanL2GatewayUtils.removeMacsFromElanExternalDevices(elanInfo, Arrays.asList(macEntry.getMacAddress()));
     }
 
-
-
 }