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