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