2 * Copyright (c) 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.vpnmanager.populator.impl;
10 import static org.opendaylight.infrautils.utils.concurrent.ListenableFutures.addErrorLogging;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
14 import java.math.BigInteger;
15 import java.util.Collections;
16 import java.util.List;
17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
18 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
20 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
21 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
22 import org.opendaylight.genius.mdsalutil.MDSALUtil;
23 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
24 import org.opendaylight.netvirt.fibmanager.api.FibHelper;
25 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
26 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
27 import org.opendaylight.netvirt.vpnmanager.VpnUtil;
28 import org.opendaylight.netvirt.vpnmanager.populator.input.L3vpnInput;
29 import org.opendaylight.netvirt.vpnmanager.populator.intfc.VpnPopulator;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.LabelRouteMap;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.SubnetRoute;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.SubnetRouteBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.label.route.map.LabelRouteInfo;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.label.route.map.LabelRouteInfoBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.label.route.map.LabelRouteInfoKey;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.AdjacencyBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
50 public abstract class L3vpnPopulator implements VpnPopulator {
51 private static final Logger LOG = LoggerFactory.getLogger(L3vpnPopulator.class);
53 protected final IBgpManager bgpManager;
54 protected final IFibManager fibManager;
55 protected final DataBroker broker;
56 protected final ManagedNewTransactionRunner txRunner;
57 protected final VpnUtil vpnUtil;
59 protected L3vpnPopulator(DataBroker dataBroker, IBgpManager bgpManager, IFibManager fibManager,
61 this.bgpManager = bgpManager;
62 this.fibManager = fibManager;
63 this.broker = dataBroker;
64 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
65 this.vpnUtil = vpnUtil;
70 public void populateFib(L3vpnInput input, WriteTransaction writeCfgTxn) {}
72 public void addSubnetRouteFibEntry(L3vpnInput input) {
73 String rd = input.getRd();
74 String vpnName = input.getVpnName();
75 String prefix = input.getSubnetIp();
76 String nextHop = input.getNextHopIp();
77 long label = input.getLabel();
78 long l3vni = input.getL3vni();
79 long elantag = input.getElanTag();
80 BigInteger dpnId = input.getDpnId();
81 String networkName = input.getNetworkName();
82 String gwMacAddress = input.getGatewayMac();
83 SubnetRoute route = new SubnetRouteBuilder().setElantag(elantag).build();
84 RouteOrigin origin = RouteOrigin.CONNECTED; // Only case when a route is considered as directly connected
85 VrfEntry vrfEntry = FibHelper.getVrfEntryBuilder(prefix, label, nextHop, origin, networkName)
86 .addAugmentation(SubnetRoute.class, route).setL3vni(l3vni).setGatewayMacAddress(gwMacAddress).build();
87 LOG.debug("Created vrfEntry for {} nexthop {} label {} and elantag {}", prefix, nextHop, label, elantag);
88 InstanceIdentifier<VrfEntry> vrfEntryId =
89 InstanceIdentifier.builder(FibEntries.class)
90 .child(VrfTables.class, new VrfTablesKey(rd))
91 .child(VrfEntry.class, new VrfEntryKey(prefix)).build();
92 Optional<VrfEntry> entry = MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, vrfEntryId);
94 if (!entry.isPresent()) {
95 List<VrfEntry> vrfEntryList = Collections.singletonList(vrfEntry);
97 InstanceIdentifier.InstanceIdentifierBuilder<VrfTables> idBuilder =
98 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd));
99 InstanceIdentifier<VrfTables> vrfTableId = idBuilder.build();
101 VrfTables vrfTableNew = new VrfTablesBuilder().setRouteDistinguisher(rd).setVrfEntry(vrfEntryList).build();
102 vpnUtil.syncUpdate(LogicalDatastoreType.CONFIGURATION, vrfTableId, vrfTableNew);
103 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Added vrfEntry for {} nexthop {} label {} rd {}"
104 + " vpnName {}", prefix, nextHop, label, rd, vpnName);
105 } else { // Found in MDSAL database
106 vpnUtil.syncWrite(LogicalDatastoreType.CONFIGURATION, vrfEntryId, vrfEntry);
107 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Updated vrfEntry for {} nexthop {} label {} rd {}"
108 + " vpnName {}", prefix, nextHop, label, rd, vpnName);
111 //Will be handled appropriately with the iRT patch for EVPN
112 if (input.getEncapType().equals(VrfEntryBase.EncapType.Mplsgre)) {
113 long vpnId = vpnUtil.getVpnId(vpnName);
114 addToLabelMapper(label, dpnId, prefix, Collections.singletonList(nextHop), vpnId, null, elantag, true, rd);
115 List<VpnInstanceOpDataEntry> vpnsToImportRoute = vpnUtil.getVpnsImportingMyRoute(vpnName);
116 if (vpnsToImportRoute.size() > 0) {
117 VrfEntry importingVrfEntry = FibHelper.getVrfEntryBuilder(prefix, label, nextHop,
118 RouteOrigin.SELF_IMPORTED, rd).addAugmentation(SubnetRoute.class, route).build();
119 List<VrfEntry> importingVrfEntryList = Collections.singletonList(importingVrfEntry);
120 for (VpnInstanceOpDataEntry vpnInstance : vpnsToImportRoute) {
121 String importingRd = vpnInstance.getVrfId();
122 InstanceIdentifier<VrfTables> importingVrfTableId =
123 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
124 new VrfTablesKey(importingRd)).build();
125 VrfTables importingVrfTable = new VrfTablesBuilder().setRouteDistinguisher(importingRd)
126 .setVrfEntry(importingVrfEntryList).build();
127 vpnUtil.syncUpdate(LogicalDatastoreType.CONFIGURATION, importingVrfTableId, importingVrfTable);
128 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Exported route rd {} prefix {} nexthop {}"
129 + " label {} to vpn {} importingRd {}", rd, prefix, nextHop, label,
130 vpnInstance.getVpnInstanceName(), importingRd);
134 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Created vrfEntry for {} nexthop {} label {} and elantag {}"
135 + "rd {} vpnName {}", prefix, nextHop, label, elantag, rd, vpnName);
138 public void addToLabelMapper(Long label, BigInteger dpnId, String prefix, List<String> nextHopIpList, Long vpnId,
139 String vpnInterfaceName, Long elanTag, boolean isSubnetRoute, String rd) {
140 Preconditions.checkNotNull(label, "addToLabelMapper: label cannot be null or empty!");
141 Preconditions.checkNotNull(prefix, "addToLabelMapper: prefix cannot be null or empty!");
142 Preconditions.checkNotNull(vpnId, "addToLabelMapper: vpnId cannot be null or empty!");
143 Preconditions.checkNotNull(rd, "addToLabelMapper: rd cannot be null or empty!");
144 if (!isSubnetRoute) {
145 // NextHop must be present for non-subnetroute entries
146 Preconditions.checkNotNull(nextHopIpList, "addToLabelMapper: nextHopIp cannot be null or empty!");
148 synchronized (label.toString().intern()) {
149 addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(tx -> {
150 LOG.info("addToLabelMapper: label {} dpn {} prefix {} nexthoplist {} vpnid {} vpnIntfcName {} rd {}"
151 + " elanTag {}", label, dpnId, prefix, nextHopIpList, vpnId, vpnInterfaceName, rd, elanTag);
153 LabelRouteInfoBuilder lriBuilder = new LabelRouteInfoBuilder();
154 lriBuilder.setLabel(label).setDpnId(dpnId).setPrefix(prefix).setNextHopIpList(nextHopIpList)
155 .setParentVpnid(vpnId).setIsSubnetRoute(isSubnetRoute);
156 if (elanTag != null) {
157 lriBuilder.setElanTag(elanTag);
159 LOG.warn("addToLabelMapper: elanTag is null for label {} prefix {} rd {} vpnId {}",
160 label, prefix, rd, vpnId);
162 if (vpnInterfaceName != null) {
163 lriBuilder.setVpnInterfaceName(vpnInterfaceName);
165 LOG.warn("addToLabelMapper: vpn interface is null for label {} prefix {} rd {} vpnId {}",
166 label, prefix, rd, vpnId);
168 lriBuilder.setParentVpnRd(rd);
169 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnUtil.getVpnInstanceOpData(rd);
170 if (vpnInstanceOpDataEntry != null) {
171 List<String> vpnInstanceNames = Collections
172 .singletonList(vpnInstanceOpDataEntry.getVpnInstanceName());
173 lriBuilder.setVpnInstanceList(vpnInstanceNames);
175 LabelRouteInfo lri = lriBuilder.build();
176 InstanceIdentifier<LabelRouteInfo> lriIid = InstanceIdentifier.builder(LabelRouteMap.class)
177 .child(LabelRouteInfo.class, new LabelRouteInfoKey(label)).build();
178 tx.merge(LogicalDatastoreType.OPERATIONAL, lriIid, lri, true);
179 LOG.info("addToLabelMapper: Added label route info to label {} prefix {} nextHopList {} vpnId {}"
180 + " interface {} rd {} elantag {}", label, prefix, nextHopIpList, vpnId, vpnInterfaceName,
183 LOG.warn("addToLabelMapper: Can't add entry to label map for label {} prefix {} nextHopList {}"
184 + " vpnId {} interface {} rd {} elantag {}, dpnId is null", label, prefix, nextHopIpList,
185 vpnId, vpnInterfaceName, rd, elanTag);
187 }), LOG, "addToLabelMapper");
192 public Adjacency createOperationalAdjacency(L3vpnInput input) {
193 return new AdjacencyBuilder().build();
196 @SuppressWarnings("checkstyle:IllegalCatch")
197 protected void addPrefixToBGP(String rd, String primaryRd, String macAddress, String prefix, String nextHopIp,
198 VrfEntry.EncapType encapType, long label, long l3vni, String gatewayMac,
199 RouteOrigin origin, WriteTransaction writeConfigTxn) {
201 List<String> nextHopList = Collections.singletonList(nextHopIp);
202 LOG.info("ADD: addPrefixToBGP: Adding Fib entry rd {} prefix {} nextHop {} label {} gwMac {}", rd, prefix,
203 nextHopList, label, gatewayMac);
204 fibManager.addOrUpdateFibEntry(primaryRd, macAddress, prefix, nextHopList,
205 encapType, (int)label, l3vni, gatewayMac, null /*parentVpnRd*/, origin, writeConfigTxn);
206 LOG.info("ADD: addPrefixToBGP: Added Fib entry rd {} prefix {} nextHop {} label {} gwMac {}", rd, prefix,
207 nextHopList, label, gatewayMac);
208 // Advertise the prefix to BGP only if nexthop ip is available
209 if (!nextHopList.isEmpty()) {
210 bgpManager.advertisePrefix(rd, macAddress, prefix, nextHopList, encapType, (int)label,
211 l3vni, 0 /*l2vni*/, gatewayMac);
213 LOG.error("addPrefixToBGP: NextHopList is null/empty. Hence rd {} prefix {} nextHop {} label {}"
214 + " gwMac {} is not advertised to BGP", rd, prefix, nextHopList, label, gatewayMac);
216 } catch (Exception e) {
217 LOG.error("addPrefixToBGP: Add prefix {} with rd {} nextHop {} label {} gwMac {} failed", prefix, rd,
218 nextHopIp, label, gatewayMac, e);