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

   1 /*
   2  * Copyright (c) 2016, 2018 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 static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
  11 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
  12
  13 import com.google.common.base.Optional;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import java.math.BigInteger;
  16 import java.util.ArrayList;
  17 import java.util.Collections;
  18 import java.util.List;
  19 import java.util.Objects;
  20 import javax.inject.Inject;
  21 import javax.inject.Singleton;
  22 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  23 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  24 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  25 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  26 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
  27 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  28 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  29 import org.opendaylight.genius.mdsalutil.NWUtil;
  30 import org.opendaylight.genius.mdsalutil.NwConstants;
  31 import org.opendaylight.genius.mdsalutil.packet.Ethernet;
  32 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  33 import org.opendaylight.infrautils.utils.concurrent.LoggingFutures;
  34 import org.opendaylight.netvirt.elan.cache.ElanInstanceCache;
  35 import org.opendaylight.netvirt.elan.evpn.utils.EvpnUtils;
  36 import org.opendaylight.netvirt.elan.l2gw.utils.ElanL2GatewayUtils;
  37 import org.opendaylight.netvirt.elan.utils.ElanUtils;
  38 import org.opendaylight.openflowplugin.libraries.liblldp.PacketException;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntry;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntryBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntryKey;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.NoMatch;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketInReason;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingListener;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  52 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  53 import org.opendaylight.yangtools.yang.common.Uint32;
  54 import org.opendaylight.yangtools.yang.common.Uint64;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 @Singleton
  59 public class ElanPacketInHandler implements PacketProcessingListener {
  60
  61     private static final Logger LOG = LoggerFactory.getLogger(ElanPacketInHandler.class);
  62
  63     private final ManagedNewTransactionRunner txRunner;
  64     private final IInterfaceManager interfaceManager;
  65     private final ElanUtils elanUtils;
  66     private final ElanL2GatewayUtils elanL2GatewayUtils;
  67     private final EvpnUtils evpnUtils;
  68     private final JobCoordinator jobCoordinator;
  69     private final ElanInstanceCache elanInstanceCache;
  70     private final ElanManagerCounters elanManagerCounters;
  71
  72     @Inject
  73     public ElanPacketInHandler(DataBroker dataBroker, final IInterfaceManager interfaceManager, ElanUtils elanUtils,
  74             EvpnUtils evpnUtils, ElanL2GatewayUtils elanL2GatewayUtils, JobCoordinator jobCoordinator,
  75             ElanInstanceCache elanInstanceCache, ElanManagerCounters elanManagerCounters) {
  76         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
  77         this.interfaceManager = interfaceManager;
  78         this.elanUtils = elanUtils;
  79         this.elanL2GatewayUtils = elanL2GatewayUtils;
  80         this.evpnUtils = evpnUtils;
  81         this.jobCoordinator = jobCoordinator;
  82         this.elanInstanceCache = elanInstanceCache;
  83         this.elanManagerCounters = elanManagerCounters;
  84     }
  85
  86     @Override
  87     public void onPacketReceived(PacketReceived notification) {
  88         Class<? extends PacketInReason> pktInReason = notification.getPacketInReason();
  89         short tableId = notification.getTableId().getValue().toJava();
  90         if (pktInReason == NoMatch.class && tableId == NwConstants.ELAN_SMAC_TABLE) {
  91             elanManagerCounters.unknownSmacPktinRcv();
  92             try {
  93                 byte[] data = notification.getPayload();
  94                 Ethernet res = new Ethernet();
  95
  96                 res.deserialize(data, 0, data.length * Byte.SIZE);
  97
  98                 byte[] srcMac = res.getSourceMACAddress();
  99                 final String macAddress = NWUtil.toStringMacAddress(srcMac);
 100                 final Uint64 metadata = notification.getMatch().getMetadata().getMetadata();
 101                 final Uint32 elanTag = Uint32.valueOf(MetaDataUtil.getElanTagFromMetadata(metadata));
 102
 103                 Uint32 portTag = Uint32.valueOf(MetaDataUtil.getLportFromMetadata(metadata).longValue());
 104
 105                 Optional<IfIndexInterface> interfaceInfoOp = elanUtils.getInterfaceInfoByInterfaceTag(portTag);
 106                 if (!interfaceInfoOp.isPresent()) {
 107                     LOG.warn("There is no interface for given portTag {}", portTag);
 108                     return;
 109                 }
 110                 String interfaceName = interfaceInfoOp.get().getInterfaceName();
 111                 LOG.debug("Received a packet with srcMac: {} ElanTag: {} PortTag: {} InterfaceName: {}", macAddress,
 112                         elanTag, portTag, interfaceName);
 113                 ElanTagName elanTagName = elanUtils.getElanInfoByElanTag(elanTag);
 114                 if (elanTagName == null) {
 115                     LOG.warn("not able to find elanTagName in elan-tag-name-map for elan tag {}", elanTag);
 116                     return;
 117                 }
 118                 ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(interfaceName);
 119                 if (elanInterfaceMac == null) {
 120                     LOG.info("There is no ElanInterfaceForwardingEntryDS created for interface :{}", interfaceName);
 121                     return;
 122                 }
 123                 String elanName = elanTagName.getName();
 124                 PhysAddress physAddress = new PhysAddress(macAddress);
 125                 MacEntry oldMacEntry = elanUtils.getMacEntryForElanInstance(elanName, physAddress).orNull();
 126                 boolean isVlanOrFlatProviderIface = interfaceManager.isExternalInterface(interfaceName);
 127
 128                 Optional<IpAddress> srcIpAddress = elanUtils.getSourceIpAddress(res);
 129                 MacEntry newMacEntry = null;
 130                 BigInteger timeStamp = new BigInteger(String.valueOf(System.currentTimeMillis()));
 131                 if (!srcIpAddress.isPresent()) {
 132                     newMacEntry = new MacEntryBuilder().setInterface(interfaceName).setMacAddress(physAddress)
 133                             .withKey(new MacEntryKey(physAddress))
 134                             .setControllerLearnedForwardingEntryTimestamp(timeStamp)
 135                             .setIsStaticAddress(false).build();
 136                 } else {
 137                     newMacEntry = new MacEntryBuilder().setInterface(interfaceName).setMacAddress(physAddress)
 138                             .setIpPrefix(srcIpAddress.get()).withKey(new MacEntryKey(physAddress))
 139                             .setControllerLearnedForwardingEntryTimestamp(timeStamp)
 140                             .setIsStaticAddress(false).build();
 141                 }
 142                 if (srcIpAddress.isPresent()) {
 143                     String prefix = srcIpAddress.get().getIpv4Address().getValue();
 144                     InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(interfaceName);
 145                     ElanInstance elanInstance = elanInstanceCache.get(elanName).orNull();
 146                     evpnUtils.advertisePrefix(elanInstance, macAddress, prefix, interfaceName, interfaceInfo.getDpId());
 147                 }
 148                 enqueueJobForMacSpecificTasks(macAddress, elanTag, interfaceName, elanName, physAddress, oldMacEntry,
 149                         newMacEntry, isVlanOrFlatProviderIface);
 150
 151                 ElanInstance elanInstance = elanInstanceCache.get(elanName).orNull();
 152                 InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(interfaceName);
 153                 if (interfaceInfo == null) {
 154                     LOG.trace("Interface:{} is not present under Config DS", interfaceName);
 155                     return;
 156                 }
 157                 enqueueJobForDPNSpecificTasks(macAddress, elanTag, interfaceName, physAddress, elanInstance,
 158                         interfaceInfo, oldMacEntry, newMacEntry, isVlanOrFlatProviderIface);
 159
 160
 161             } catch (PacketException e) {
 162                 LOG.error("Failed to decode packet: {}", notification, e);
 163             }
 164         }
 165     }
 166
 167     private void enqueueJobForMacSpecificTasks(final String macAddress, final Uint32 elanTag, String interfaceName,
 168                                                String elanName, PhysAddress physAddress,
 169                                                MacEntry oldMacEntry, MacEntry newMacEntry,
 170                                                final boolean isVlanOrFlatProviderIface) {
 171         jobCoordinator.enqueueJob(getElanMacKey(elanTag, macAddress),
 172             () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
 173                 if (oldMacEntry != null && Objects.equals(oldMacEntry.getInterface(), interfaceName)) {
 174                     // This should never occur because of ovs temporary mac learning
 175                     elanManagerCounters.unknownSmacPktinForwardingEntriesRemoved();
 176                 } else if (oldMacEntry != null && !isVlanOrFlatProviderIface) {
 177                     long macTimeStamp = oldMacEntry.getControllerLearnedForwardingEntryTimestamp().longValue();
 178                     if (System.currentTimeMillis() > macTimeStamp + 1000) {
 179                         InstanceIdentifier<MacEntry> macEntryId = ElanUtils
 180                                 .getInterfaceMacEntriesIdentifierOperationalDataPath(oldMacEntry.getInterface(),
 181                                         physAddress);
 182                         tx.delete(macEntryId);
 183                     } else {
 184                         // New FEs flood their packets on all interfaces. This can lead
 185                         // to many contradicting packet_ins. Ignore all packets received
 186                         // within 1s after the first packet_in
 187                         elanManagerCounters.unknownSmacPktinMacMigrationIgnoredDueToProtection();
 188                     }
 189                 } else if (oldMacEntry != null) {
 190                     elanManagerCounters.unknownSmacPktinRemovedForRelearned();
 191                 }
 192                 // This check is required only to update elan-forwarding-tables when mac is learned
 193                 // in ports (example: VM interfaces) other than on vlan provider port.
 194                 if (!isVlanOrFlatProviderIface && oldMacEntry == null) {
 195                     InstanceIdentifier<MacEntry> elanMacEntryId =
 196                             ElanUtils.getMacEntryOperationalDataPath(elanName, physAddress);
 197                     tx.put(elanMacEntryId, newMacEntry, WriteTransaction.CREATE_MISSING_PARENTS);
 198                 }
 199             })));
 200     }
 201
 202     private static String getElanMacKey(Uint32 elanTag, String macAddress) {
 203         return "MAC-" + macAddress + " ELAN_TAG-" + elanTag.toString();
 204     }
 205
 206     private static String getElanMacDPNKey(Uint32 elanTag, String macAddress, Uint64 dpnId) {
 207         return "MAC-" + macAddress + " ELAN_TAG-" + elanTag.toString() + "DPN_ID-" + dpnId.toString();
 208     }
 209
 210     private void enqueueJobForDPNSpecificTasks(final String macAddress, final Uint32 elanTag, String interfaceName,
 211                                                PhysAddress physAddress, ElanInstance elanInstance,
 212                                                InterfaceInfo interfaceInfo, MacEntry oldMacEntry,
 213                                                MacEntry newMacEntry, boolean isVlanOrFlatProviderIface) {
 214         jobCoordinator.enqueueJob(getElanMacDPNKey(elanTag, macAddress, interfaceInfo.getDpId()), () -> {
 215             macMigrationFlowsCleanup(interfaceName, elanInstance, oldMacEntry, isVlanOrFlatProviderIface);
 216             Uint64 dpId = interfaceManager.getDpnForInterface(interfaceName);
 217             elanL2GatewayUtils.scheduleAddDpnMacInExtDevices(elanInstance.getElanInstanceName(), dpId,
 218                     Collections.singletonList(physAddress));
 219             elanManagerCounters.unknownSmacPktinLearned();
 220             List<ListenableFuture<Void>> futures = new ArrayList<>();
 221             futures.add(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION, tx -> {
 222                 futures.add(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, operTx -> {
 223                     elanUtils.setupMacFlows(elanInstance, interfaceInfo, elanInstance.getMacTimeout().toJava(),
 224                         macAddress, !isVlanOrFlatProviderIface, tx);
 225                     InstanceIdentifier<MacEntry> macEntryId =
 226                         ElanUtils.getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
 227                     operTx.put(macEntryId, newMacEntry, WriteTransaction.CREATE_MISSING_PARENTS);
 228                 }));
 229             }));
 230             return futures;
 231         });
 232     }
 233
 234     private void macMigrationFlowsCleanup(String interfaceName, ElanInstance elanInstance, MacEntry macEntry,
 235                                           boolean isVlanOrFlatProviderIface) {
 236         if (macEntry != null && !Objects.equals(macEntry.getInterface(), interfaceName)
 237                 && !isVlanOrFlatProviderIface) {
 238             tryAndRemoveInvalidMacEntry(elanInstance.getElanInstanceName(), macEntry);
 239             elanManagerCounters.unknownSmacPktinFlowsRemovedForRelearned();
 240         }
 241     }
 242
 243     /*
 244      * Though this method is a little costlier because it uses try-catch
 245      * construct, it is used only in rare scenarios like MAC movement or invalid
 246      * Static MAC having been added on a wrong ELAN.
 247      */
 248     private void tryAndRemoveInvalidMacEntry(String elanName, MacEntry macEntry) {
 249         ElanInstance elanInfo = elanInstanceCache.get(elanName).orNull();
 250         if (elanInfo == null) {
 251             LOG.warn("MAC {} is been added (either statically or dynamically) for an invalid Elan {}. "
 252                     + "Manual cleanup may be necessary", macEntry.getMacAddress(), elanName);
 253             return;
 254         }
 255
 256         InterfaceInfo oldInterfaceLport = interfaceManager.getInterfaceInfo(macEntry.getInterface());
 257         if (oldInterfaceLport == null) {
 258             LOG.warn("MAC {} is been added (either statically or dynamically) on an invalid Logical Port {}. "
 259                             + "Manual cleanup may be necessary",
 260                     macEntry.getMacAddress(), macEntry.getInterface());
 261             return;
 262         }
 263         LoggingFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION,
 264             tx -> elanUtils.deleteMacFlows(elanInfo, oldInterfaceLport, macEntry, tx)), LOG,
 265             "Error deleting invalid MAC entry");
 266         elanL2GatewayUtils.removeMacsFromElanExternalDevices(elanInfo,
 267                 Collections.singletonList(macEntry.getMacAddress()));
 268     }
 269
 270 }