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