elanmanager/elanmanager-impl/src/main/java/org/opendaylight/vpnservice/elan/internal/ElanPacketInHandler.java

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. 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.vpnservice.elan.internal;
   9
  10 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  11 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  12 import org.opendaylight.vpnservice.elan.utils.ElanConstants;
  13 import org.opendaylight.vpnservice.elan.utils.ElanUtils;
  14 //import org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo;
  15 import org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo;
  16 import org.opendaylight.vpnservice.interfacemgr.interfaces.IInterfaceManager;
  17 import org.opendaylight.vpnservice.mdsalutil.MDSALUtil;
  18 import org.opendaylight.vpnservice.mdsalutil.MetaDataUtil;
  19 import org.opendaylight.vpnservice.mdsalutil.NWUtil;
  20 import org.opendaylight.controller.liblldp.NetUtils;
  21 import org.opendaylight.vpnservice.mdsalutil.packet.Ethernet;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.NoMatch;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketInReason;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingListener;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstance;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.Elan;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagName;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntry;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntryBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntryKey;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterface;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 import java.math.BigInteger;
  40
  41 public class ElanPacketInHandler implements PacketProcessingListener {
  42
  43     private final DataBroker broker;
  44     private IInterfaceManager interfaceManager;
  45
  46     private static final Logger logger = LoggerFactory.getLogger(ElanPacketInHandler.class);
  47
  48     public ElanPacketInHandler(DataBroker dataBroker) {
  49         broker = dataBroker;
  50     }
  51
  52     public void setInterfaceManager(IInterfaceManager interfaceManager) {
  53         this.interfaceManager = interfaceManager;
  54     }
  55
  56     @Override
  57     public void onPacketReceived(PacketReceived notification) {
  58         Class<? extends PacketInReason>  pktInReason =  notification.getPacketInReason();
  59         short tableId = notification.getTableId().getValue();
  60         if(pktInReason == NoMatch.class && tableId == ElanConstants.ELAN_SMAC_TABLE) {
  61             try {
  62                 byte[] data = notification.getPayload();
  63                 Ethernet res = new Ethernet();
  64
  65                 res.deserialize(data, 0, data.length * NetUtils.NumBitsInAByte);
  66
  67                 byte[] srcMac = res.getSourceMACAddress();
  68                 String macAddress = NWUtil.toStringMacAddress(srcMac);
  69                 PhysAddress physAddress = new PhysAddress(macAddress);
  70                 BigInteger metadata = notification.getMatch().getMetadata().getMetadata();
  71                 long elanTag = MetaDataUtil.getElanTagFromMetadata(metadata);
  72
  73                 long portTag = MetaDataUtil.getLportFromMetadata(metadata).intValue();
  74
  75                 IfIndexInterface interfaceInfo = ElanUtils.getInterfaceInfoByInterfaceTag(portTag);
  76                 if (interfaceInfo == null) {
  77                     logger.warn("There is no interface for given portTag {}", portTag);
  78                     return;
  79                 }
  80                 String interfaceName = interfaceInfo.getInterfaceName();
  81                 ElanTagName elanTagName = ElanUtils.getElanInfoByElanTag(elanTag);
  82                 String elanName = elanTagName.getName();
  83                 Elan elanInfo = ElanUtils.getElanByName(elanName);
  84                 MacEntry macEntry = ElanUtils.getInterfaceMacEntriesOperationalDataPath(interfaceName, physAddress);
  85                 if(macEntry != null && macEntry.getInterface() == interfaceName) {
  86                     BigInteger macTimeStamp = macEntry.getControllerLearnedForwardingEntryTimestamp();
  87                     if (System.currentTimeMillis() > macTimeStamp.longValue()+2000) {
  88                         /*
  89                          * Protection time expired. Even though the MAC has been learnt (it is in the cache)
  90                          * the packets are punted to controller. Which means, the the flows were not successfully
  91                          * created in the DPN, but the MAC entry has been added successfully in the cache.
  92                          *
  93                          * So, the cache has to be cleared and the flows and cache should be recreated (clearing
  94                          * of cache is required so that the timestamp is updated).
  95                          */
  96                         InstanceIdentifier<MacEntry> macEntryId =  ElanUtils.getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
  97                         ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL, macEntryId);
  98                     } else {
  99                         // Protection time running. Ignore packets for 2 seconds
 100                         return;
 101                     }
 102                 } else if(macEntry != null) {
 103                     // MAC address has moved. Overwrite the mapping and replace MAC flows
 104                     long macTimeStamp = macEntry.getControllerLearnedForwardingEntryTimestamp().longValue();
 105                     if (System.currentTimeMillis() > macTimeStamp+1000) {
 106
 107                         InstanceIdentifier<MacEntry> macEntryId =  ElanUtils.getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
 108                         ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL, macEntryId);
 109                         tryAndRemoveInvalidMacEntry(elanName, macEntry);
 110                     } else {
 111                         // New FEs flood their packets on all interfaces. This can lead
 112                         // to many contradicting packet_ins. Ignore all packets received
 113                         // within 1s after the first packet_in
 114                         return;
 115                     }
 116                 }
 117                 BigInteger timeStamp = new BigInteger(String.valueOf((long)System.currentTimeMillis()));
 118                 macEntry = new MacEntryBuilder().setInterface(interfaceName).setMacAddress(physAddress).setKey(new MacEntryKey(physAddress)).setControllerLearnedForwardingEntryTimestamp(timeStamp).setIsStaticAddress(false).build();
 119                 InstanceIdentifier<MacEntry> macEntryId = ElanUtils.getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
 120                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, macEntryId, macEntry);
 121                 InstanceIdentifier<MacEntry> elanMacEntryId = ElanUtils.getMacEntryOperationalDataPath(elanName, physAddress);
 122                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, elanMacEntryId, macEntry);
 123                 ElanInstance elanInstance = ElanUtils.getElanInstanceByName(elanName);
 124                 ElanUtils.setupMacFlows(elanInstance, interfaceManager.getInterfaceInfo(interfaceName), elanInstance.getMacTimeout(), macAddress);
 125             } catch (Exception e) {
 126                 logger.trace("Failed to decode packet: {}", e);
 127             }
 128         }
 129
 130     }
 131
 132
 133     /*
 134  * Though this method is a little costlier because it uses try-catch construct, it is used
 135  * only in rare scenarios like MAC movement or invalid Static MAC having been added on a
 136  * wrong ELAN.
 137  */
 138     private void tryAndRemoveInvalidMacEntry(String elanName, MacEntry macEntry) {
 139         ElanInstance elanInfo = ElanUtils.getElanInstanceByName(elanName);
 140         if (elanInfo == null) {
 141             logger.warn(String.format("MAC %s is been added (either statically or dynamically) for an invalid Elan %s. "
 142                     + "Manual cleanup may be necessary", macEntry.getMacAddress(), elanName));
 143             return;
 144         }
 145
 146         InterfaceInfo oldInterfaceLport = interfaceManager.getInterfaceInfo(macEntry.getInterface());
 147         if (oldInterfaceLport == null) {
 148             logger.warn(String.format("MAC %s is been added (either statically or dynamically) on an invalid Logical Port %s. "
 149                     + "Manual cleanup may be necessary", macEntry.getMacAddress(), macEntry.getInterface()));
 150             return;
 151         }
 152         ElanUtils.deleteMacFlows(elanInfo, oldInterfaceLport, macEntry);
 153     }
 154
 155 }