2 * Copyright © 2017 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.evpn.utils;
10 import com.google.common.util.concurrent.ListenableFuture;
11 import java.util.ArrayList;
12 import java.util.Collections;
13 import java.util.List;
15 import java.util.Optional;
16 import java.util.concurrent.ExecutionException;
17 import javax.inject.Inject;
18 import javax.inject.Singleton;
19 import org.eclipse.jdt.annotation.Nullable;
20 import org.opendaylight.genius.infra.Datastore;
21 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
22 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
23 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
24 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
25 import org.opendaylight.mdsal.binding.api.DataBroker;
26 import org.opendaylight.mdsal.binding.api.ReadTransaction;
27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
28 import org.opendaylight.netvirt.elan.cache.ElanInstanceCache;
29 import org.opendaylight.netvirt.elan.utils.ElanConstants;
30 import org.opendaylight.netvirt.elan.utils.ElanUtils;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.macvrfentries.MacVrfEntry;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.macvrfentries.MacVrfEntryKey;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentrybase.RoutePaths;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.EvpnRdToNetworks;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.evpn.rd.to.networks.EvpnRdToNetwork;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.evpn.rd.to.networks.EvpnRdToNetworkKey;
46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
47 import org.opendaylight.yangtools.yang.common.Uint32;
48 import org.opendaylight.yangtools.yang.common.Uint64;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
53 public class EvpnMacVrfUtils {
55 private static final Logger LOG = LoggerFactory.getLogger(EvpnMacVrfUtils.class);
56 private final DataBroker dataBroker;
57 private final ManagedNewTransactionRunner txRunner;
58 private final IdManagerService idManager;
59 private final ElanEvpnFlowUtils elanEvpnFlowUtils;
60 private final IMdsalApiManager mdsalManager;
61 private final EvpnUtils evpnUtils;
62 private final JobCoordinator jobCoordinator;
63 private final ElanUtils elanUtils;
64 private final ElanInstanceCache elanInstanceCache;
67 public EvpnMacVrfUtils(final DataBroker dataBroker, final IdManagerService idManager,
68 final ElanEvpnFlowUtils elanEvpnFlowUtils, final IMdsalApiManager mdsalManager, final EvpnUtils evpnUtils,
69 final JobCoordinator jobCoordinator, final ElanUtils elanUtils, final ElanInstanceCache elanInstanceCache) {
70 this.dataBroker = dataBroker;
71 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
72 this.idManager = idManager;
73 this.elanEvpnFlowUtils = elanEvpnFlowUtils;
74 this.mdsalManager = mdsalManager;
75 this.evpnUtils = evpnUtils;
76 this.jobCoordinator = jobCoordinator;
77 this.elanUtils = elanUtils;
78 this.elanInstanceCache = elanInstanceCache;
82 private Uint32 getElanTagByMacvrfiid(InstanceIdentifier<MacVrfEntry> macVrfEntryIid) {
83 String elanName = getElanNameByMacvrfiid(macVrfEntryIid);
84 if (elanName == null) {
85 LOG.error("getElanTag: elanName is NULL for iid = {}", macVrfEntryIid);
87 ElanInstance elanInstance = elanInstanceCache.get(elanName).orElse(null);
88 if (elanInstance == null) {
92 Uint32 elanTag = elanInstance.getElanTag();
93 if (elanTag == null || elanTag.longValue() == 0L) {
94 elanTag = ElanUtils.retrieveNewElanTag(idManager, elanName);
99 public String getElanNameByMacvrfiid(InstanceIdentifier<MacVrfEntry> instanceIdentifier) {
100 try (ReadTransaction tx = dataBroker.newReadOnlyTransaction()) {
101 String rd = instanceIdentifier.firstKeyOf(VrfTables.class).getRouteDistinguisher();
102 String elanName = null;
103 InstanceIdentifier<EvpnRdToNetwork> iidEvpnRdToNet =
104 InstanceIdentifier.builder(EvpnRdToNetworks.class).child(EvpnRdToNetwork.class,
105 new EvpnRdToNetworkKey(rd)).build();
107 Optional<EvpnRdToNetwork> evpnRdToNetwork =
108 tx.read(LogicalDatastoreType.CONFIGURATION, iidEvpnRdToNet).get();
109 if (evpnRdToNetwork.isPresent()) {
110 elanName = evpnRdToNetwork.get().getNetworkId();
112 } catch (InterruptedException | ExecutionException e) {
113 LOG.error("getElanName: unable to read elanName, exception ", e);
119 public InstanceIdentifier<MacVrfEntry> getMacVrfEntryIid(String rd, MacVrfEntry macVrfEntry) {
120 return InstanceIdentifier.create(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd))
121 .child(MacVrfEntry.class, macVrfEntry.key());
124 public void updateEvpnDmacFlows(final ElanInstance elanInstance, final boolean install) {
125 String rd = evpnUtils.getEvpnRd(elanInstance);
129 final InstanceIdentifier<VrfTables> iid = InstanceIdentifier.create(FibEntries.class)
130 .child(VrfTables.class, new VrfTablesKey(rd));
131 evpnUtils.asyncReadAndExecute(LogicalDatastoreType.CONFIGURATION, iid,
132 new StringBuilder(elanInstance.getElanInstanceName()).append(":").append(rd).toString(),
133 (vrfTablesOptional) -> {
134 if (!vrfTablesOptional.isPresent()) {
137 Map<MacVrfEntryKey, MacVrfEntry> keyMacVrfEntryMap = vrfTablesOptional.get().nonnullMacVrfEntry();
138 if (keyMacVrfEntryMap == null || keyMacVrfEntryMap.isEmpty()) {
141 for (MacVrfEntry macVrfEntry : keyMacVrfEntryMap.values()) {
142 InstanceIdentifier<MacVrfEntry> macVrfEntryIid = getMacVrfEntryIid(rd, macVrfEntry);
144 addEvpnDmacFlowOnAttach(macVrfEntryIid, macVrfEntry, elanInstance);
146 removeEvpnDmacFlowOnDetach(macVrfEntryIid, macVrfEntry, elanInstance);
153 public boolean checkEvpnAttachedToNet(String elanName) {
154 ElanInstance elanInfo = elanInstanceCache.get(elanName).orElse(null);
155 String evpnName = EvpnUtils.getEvpnNameFromElan(elanInfo);
156 if (evpnName == null) {
157 LOG.error("Error : evpnName is null for elanName {}", elanName);
163 public void addEvpnDmacFlow(InstanceIdentifier<MacVrfEntry> instanceIdentifier, MacVrfEntry macVrfEntry) {
164 String elanName = getElanNameByMacvrfiid(instanceIdentifier);
165 if (elanName == null) {
166 LOG.error("Error : elanName is null for iid {}", instanceIdentifier);
170 List<DpnInterfaces> dpnInterfaceLists = elanUtils.getElanDPNByName(elanName);
171 if (checkEvpnAttachedToNet(elanName)) {
172 //TODO(Riyaz) : Check if accessing first nexthop address is right solution
173 String nexthopIP = new ArrayList<RoutePaths>(macVrfEntry.nonnullRoutePaths().values())
174 .get(0).getNexthopAddress();
175 IpAddress ipAddress = new IpAddress(new Ipv4Address(nexthopIP));
176 Uint32 elanTag = getElanTagByMacvrfiid(instanceIdentifier);
177 if (elanTag == null) {
181 String dstMacAddress = macVrfEntry.getMac();
182 long vni = macVrfEntry.getL2vni().toJava();
183 jobCoordinator.enqueueJob(dstMacAddress, () -> Collections.singletonList(
184 txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
185 tx -> dpnInterfaceLists.forEach(dpnInterfaces -> {
186 Uint64 dpId = dpnInterfaces.getDpId();
187 LOG.info("ADD: Build DMAC flow with dpId {}, nexthopIP {}, elanTag {},"
188 + "vni {}, dstMacAddress {}, elanName {} ",
189 dpId, nexthopIP, elanTag, vni, dstMacAddress, elanName);
190 ElanEvpnFlowUtils.EvpnDmacFlowBuilder dmacFlowBuilder =
191 new ElanEvpnFlowUtils.EvpnDmacFlowBuilder();
192 dmacFlowBuilder.setDpId(dpId).setNexthopIP(ipAddress.toString()).setElanTag(elanTag.longValue())
193 .setVni(vni).setDstMacAddress(dstMacAddress).setElanName(elanName);
195 elanEvpnFlowUtils.evpnBuildDmacFlowForExternalRemoteMac(dmacFlowBuilder.build());
197 mdsalManager.addFlow(tx, dpId, flow);
198 }))), ElanConstants.JOB_MAX_RETRIES);
202 public void removeEvpnDmacFlow(InstanceIdentifier<MacVrfEntry> instanceIdentifier, MacVrfEntry macVrfEntry) {
203 String elanName = getElanNameByMacvrfiid(instanceIdentifier);
204 if (elanName == null) {
205 LOG.error("Error : elanName is null for iid {}", instanceIdentifier);
208 List<DpnInterfaces> dpnInterfaceLists = elanUtils.getElanDPNByName(elanName);
210 //if (checkEvpnAttachedToNet(elanName)) {
211 //TODO(Riyaz) : Check if accessing first nexthop address is right
212 String nexthopIP = new ArrayList<RoutePaths>(macVrfEntry.nonnullRoutePaths().values())
213 .get(0).getNexthopAddress();
214 IpAddress ipAddress = new IpAddress(new Ipv4Address(nexthopIP));
215 Uint32 elanTag = getElanTagByMacvrfiid(instanceIdentifier);
216 if (elanTag == null) {
220 String macToRemove = macVrfEntry.getMac();
221 jobCoordinator.enqueueJob(macToRemove, () -> {
222 List<ListenableFuture<Void>> futures = new ArrayList<>();
223 dpnInterfaceLists.forEach(dpnInterfaces -> {
224 Uint64 dpId = dpnInterfaces.getDpId();
225 ElanEvpnFlowUtils.EvpnDmacFlowBuilder dmacFlowBuilder = new ElanEvpnFlowUtils.EvpnDmacFlowBuilder();
226 dmacFlowBuilder.setDpId(dpId).setNexthopIP(ipAddress.toString()).setElanTag(elanTag.longValue())
227 .setDstMacAddress(macToRemove);
228 LOG.info("REMOVE: Deleting DMAC Flows for external MAC. elanTag {}, dpId {},"
229 + "nexthopIP {}, macToRemove {}", elanTag, dpId, nexthopIP, macToRemove);
230 futures.addAll(elanEvpnFlowUtils.evpnDeleteDmacFlowsToExternalMac(dmacFlowBuilder.build()));
233 }, ElanConstants.JOB_MAX_RETRIES);
236 public void addEvpnDmacFlowOnAttach(InstanceIdentifier<MacVrfEntry> instanceIdentifier, MacVrfEntry macVrfEntry,
237 ElanInstance elanInstance) {
238 //String elanName = getElanNameByMacvrfiid(instanceIdentifier);
239 if (elanInstance == null) {
240 LOG.error("Error : elanName is null for iid {}", instanceIdentifier);
244 String elanName = elanInstance.getElanInstanceName();
245 List<DpnInterfaces> dpnInterfaceLists = elanUtils.getElanDPNByName(elanName);
247 if (checkEvpnAttachedToNet(elanName)) {
248 String nexthopIP = getRoutePathNexthopIp(macVrfEntry);
249 if (nexthopIP == null) {
250 LOG.debug("nexthopIP is null for iid {}", instanceIdentifier);
253 IpAddress ipAddress = new IpAddress(new Ipv4Address(nexthopIP));
254 Uint32 elanTag = elanInstance.getElanTag();
255 String dstMacAddress = macVrfEntry.getMac();
256 long vni = macVrfEntry.getL2vni().toJava();
257 jobCoordinator.enqueueJob(dstMacAddress, () -> Collections.singletonList(
258 txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
259 tx -> dpnInterfaceLists.forEach(dpnInterfaces -> {
260 Uint64 dpId = dpnInterfaces.getDpId();
261 LOG.info("ADD: Build DMAC flow with dpId {}, nexthopIP {}, elanTag {},"
262 + "vni {}, dstMacAddress {}, elanName {} ",
263 dpId, nexthopIP, elanTag, vni, dstMacAddress, elanName);
264 ElanEvpnFlowUtils.EvpnDmacFlowBuilder dmacFlowBuilder =
265 new ElanEvpnFlowUtils.EvpnDmacFlowBuilder();
266 dmacFlowBuilder.setDpId(dpId).setNexthopIP(ipAddress.toString()).setElanTag(elanTag.longValue())
267 .setVni(vni).setDstMacAddress(dstMacAddress).setElanName(elanName);
268 Flow flow = elanEvpnFlowUtils.evpnBuildDmacFlowForExternalRemoteMac(dmacFlowBuilder.build());
269 mdsalManager.addFlow(tx, dpId, flow);
270 }))), ElanConstants.JOB_MAX_RETRIES);
275 public String getRoutePathNexthopIp(MacVrfEntry macVrfEntry) {
276 if (macVrfEntry.getRoutePaths() == null || macVrfEntry.getRoutePaths().isEmpty()) {
277 LOG.debug("RoutePaths is null or empty for macvrfentry {}", macVrfEntry);
280 return new ArrayList<RoutePaths>(macVrfEntry.nonnullRoutePaths().values()).get(0).getNexthopAddress();
283 public void removeEvpnDmacFlowOnDetach(InstanceIdentifier<MacVrfEntry> instanceIdentifier, MacVrfEntry macVrfEntry,
284 ElanInstance elanInstance) {
285 //String elanName = getElanNameByMacvrfiid(instanceIdentifier);
286 if (elanInstance == null) {
287 LOG.error("Error : elanInstance is null for iid {}", instanceIdentifier);
290 List<DpnInterfaces> dpnInterfaceLists = elanUtils.getElanDPNByName(elanInstance.getElanInstanceName());
292 //if (checkEvpnAttachedToNet(elanName)) {
293 String nexthopIP = getRoutePathNexthopIp(macVrfEntry);
294 if (nexthopIP == null) {
295 LOG.debug("nexthopIP is null for iid {}", instanceIdentifier);
298 IpAddress ipAddress = new IpAddress(new Ipv4Address(nexthopIP));
299 Uint32 elanTag = elanInstance.getElanTag();
300 String macToRemove = macVrfEntry.getMac();
301 jobCoordinator.enqueueJob(macToRemove, () -> {
302 List<ListenableFuture<Void>> futures = new ArrayList<>();
303 dpnInterfaceLists.forEach(dpnInterfaces -> {
304 Uint64 dpId = dpnInterfaces.getDpId();
305 ElanEvpnFlowUtils.EvpnDmacFlowBuilder dmacFlowBuilder = new ElanEvpnFlowUtils.EvpnDmacFlowBuilder();
306 dmacFlowBuilder.setDpId(dpId).setNexthopIP(ipAddress.toString()).setElanTag(elanTag.longValue())
307 .setDstMacAddress(macToRemove);
308 LOG.info("REMOVE: Deleting DMAC Flows for external MAC. elanTag {}, dpId {},"
309 + "nexthopIP {}, macToRemove {}", elanTag, dpId, nexthopIP, macToRemove);
310 elanEvpnFlowUtils.evpnDeleteDmacFlowsToExternalMac(dmacFlowBuilder.build());
313 }, ElanConstants.JOB_MAX_RETRIES);