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