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