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.controller.md.sal.binding.api.WriteTransaction.CREATE_MISSING_PARENTS;
11 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
12 import static org.opendaylight.infrautils.utils.concurrent.ListenableFutures.addErrorLogging;
14 import com.google.common.base.Optional;
15 import com.google.common.base.Preconditions;
16 import java.util.Collections;
17 import java.util.List;
18 import java.util.concurrent.locks.ReentrantLock;
19 import org.eclipse.jdt.annotation.Nullable;
20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
22 import org.opendaylight.genius.infra.Datastore.Configuration;
23 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
24 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
25 import org.opendaylight.genius.infra.TypedWriteTransaction;
26 import org.opendaylight.genius.mdsalutil.MDSALUtil;
27 import org.opendaylight.genius.utils.JvmGlobalLocks;
28 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
29 import org.opendaylight.netvirt.fibmanager.api.FibHelper;
30 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
31 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
32 import org.opendaylight.netvirt.vpnmanager.VpnUtil;
33 import org.opendaylight.netvirt.vpnmanager.populator.input.L3vpnInput;
34 import org.opendaylight.netvirt.vpnmanager.populator.intfc.VpnPopulator;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.LabelRouteMap;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.SubnetRoute;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.SubnetRouteBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.label.route.map.LabelRouteInfo;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.label.route.map.LabelRouteInfoBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.label.route.map.LabelRouteInfoKey;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.adjacency.list.Adjacency;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.adjacency.list.AdjacencyBuilder;
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;
57 public abstract class L3vpnPopulator implements VpnPopulator {
58 private static final Logger LOG = LoggerFactory.getLogger(L3vpnPopulator.class);
60 protected final IBgpManager bgpManager;
61 protected final IFibManager fibManager;
62 protected final DataBroker broker;
63 protected final ManagedNewTransactionRunner txRunner;
64 protected final VpnUtil vpnUtil;
66 protected L3vpnPopulator(DataBroker dataBroker, IBgpManager bgpManager, IFibManager fibManager,
68 this.bgpManager = bgpManager;
69 this.fibManager = fibManager;
70 this.broker = dataBroker;
71 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
72 this.vpnUtil = vpnUtil;
76 public void populateFib(L3vpnInput input, TypedWriteTransaction<Configuration> writeCfgTxn) {
80 public void addSubnetRouteFibEntry(L3vpnInput input) {
81 String rd = input.getRd();
82 String vpnName = input.getVpnName();
83 String prefix = input.getSubnetIp();
84 String nextHop = input.getNextHopIp();
85 Uint32 label = Uint32.valueOf(input.getLabel());
86 Uint32 l3vni = Uint32.valueOf(input.getL3vni());
87 Uint32 elantag = Uint32.valueOf(input.getElanTag());
88 Uint64 dpnId = input.getDpnId();
89 String networkName = input.getNetworkName();
90 String gwMacAddress = input.getGatewayMac();
91 SubnetRoute route = new SubnetRouteBuilder().setElantag(elantag).build();
92 RouteOrigin origin = RouteOrigin.CONNECTED; // Only case when a route is considered as directly connected
93 VrfEntry vrfEntry = FibHelper.getVrfEntryBuilder(prefix, label, nextHop, origin, networkName)
94 .addAugmentation(SubnetRoute.class, route).setL3vni(l3vni).setGatewayMacAddress(gwMacAddress).build();
95 LOG.debug("Created vrfEntry for {} nexthop {} label {} and elantag {}", prefix, nextHop, label, elantag);
96 InstanceIdentifier<VrfEntry> vrfEntryId =
97 InstanceIdentifier.builder(FibEntries.class)
98 .child(VrfTables.class, new VrfTablesKey(rd))
99 .child(VrfEntry.class, new VrfEntryKey(prefix)).build();
100 Optional<VrfEntry> entry = MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, vrfEntryId);
102 if (!entry.isPresent()) {
103 List<VrfEntry> vrfEntryList = Collections.singletonList(vrfEntry);
105 InstanceIdentifier.InstanceIdentifierBuilder<VrfTables> idBuilder =
106 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd));
107 InstanceIdentifier<VrfTables> vrfTableId = idBuilder.build();
109 VrfTables vrfTableNew = new VrfTablesBuilder().setRouteDistinguisher(rd).setVrfEntry(vrfEntryList).build();
110 vpnUtil.syncUpdate(LogicalDatastoreType.CONFIGURATION, vrfTableId, vrfTableNew);
111 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Added vrfEntry for {} nexthop {} label {} rd {}"
112 + " vpnName {}", prefix, nextHop, label, rd, vpnName);
113 } else { // Found in MDSAL database
114 vpnUtil.syncWrite(LogicalDatastoreType.CONFIGURATION, vrfEntryId, vrfEntry);
115 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Updated vrfEntry for {} nexthop {} label {} rd {}"
116 + " vpnName {}", prefix, nextHop, label, rd, vpnName);
119 //Will be handled appropriately with the iRT patch for EVPN
120 if (input.getEncapType().equals(VrfEntryBase.EncapType.Mplsgre)) {
121 Uint32 vpnId = vpnUtil.getVpnId(vpnName);
122 addToLabelMapper(label, dpnId, prefix, Collections.singletonList(nextHop), vpnId, null,
124 List<VpnInstanceOpDataEntry> vpnsToImportRoute = vpnUtil.getVpnsImportingMyRoute(vpnName);
125 if (vpnsToImportRoute.size() > 0) {
126 VrfEntry importingVrfEntry = FibHelper.getVrfEntryBuilder(prefix, label, nextHop,
127 RouteOrigin.SELF_IMPORTED, rd).addAugmentation(SubnetRoute.class, route).build();
128 List<VrfEntry> importingVrfEntryList = Collections.singletonList(importingVrfEntry);
129 for (VpnInstanceOpDataEntry vpnInstance : vpnsToImportRoute) {
130 String importingRd = vpnInstance.getVrfId();
131 InstanceIdentifier<VrfTables> importingVrfTableId =
132 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
133 new VrfTablesKey(importingRd)).build();
134 VrfTables importingVrfTable = new VrfTablesBuilder().setRouteDistinguisher(importingRd)
135 .setVrfEntry(importingVrfEntryList).build();
136 vpnUtil.syncUpdate(LogicalDatastoreType.CONFIGURATION, importingVrfTableId, importingVrfTable);
137 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Exported route rd {} prefix {} nexthop {}"
138 + " label {} to vpn {} importingRd {}", rd, prefix, nextHop, label,
139 vpnInstance.getVpnInstanceName(), importingRd);
143 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Created vrfEntry for {} nexthop {} label {} and elantag {}"
144 + "rd {} vpnName {}", prefix, nextHop, label, elantag, rd, vpnName);
147 public void addToLabelMapper(Uint32 label, Uint64 dpnId, String prefix, List<String> nextHopIpList, Uint32 vpnId,
148 @Nullable String vpnInterfaceName, @Nullable Uint32 elanTag,
149 boolean isSubnetRoute, String rd) {
150 final String labelStr = Preconditions.checkNotNull(label, "addToLabelMapper: label cannot be null or empty!")
152 Preconditions.checkNotNull(prefix, "addToLabelMapper: prefix cannot be null or empty!");
153 Preconditions.checkNotNull(vpnId, "addToLabelMapper: vpnId cannot be null or empty!");
154 Preconditions.checkNotNull(rd, "addToLabelMapper: rd cannot be null or empty!");
155 if (!isSubnetRoute) {
156 // NextHop must be present for non-subnetroute entries
157 Preconditions.checkNotNull(nextHopIpList, "addToLabelMapper: nextHopIp cannot be null or empty!");
160 // FIXME: separate this out somehow?
161 final ReentrantLock lock = JvmGlobalLocks.getLockForString(labelStr);
164 addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
165 LOG.info("addToLabelMapper: label {} dpn {} prefix {} nexthoplist {} vpnid {} vpnIntfcName {} rd {}"
166 + " elanTag {}", labelStr, dpnId, prefix, nextHopIpList, vpnId, vpnInterfaceName, rd, elanTag);
168 LabelRouteInfoBuilder lriBuilder = new LabelRouteInfoBuilder();
169 lriBuilder.setLabel(label).setDpnId(dpnId).setPrefix(prefix).setNextHopIpList(nextHopIpList)
170 .setParentVpnid(vpnId).setIsSubnetRoute(isSubnetRoute);
171 if (elanTag != null) {
172 lriBuilder.setElanTag(elanTag);
174 LOG.warn("addToLabelMapper: elanTag is null for label {} prefix {} rd {} vpnId {}",
175 labelStr, prefix, rd, vpnId);
177 if (vpnInterfaceName != null) {
178 lriBuilder.setVpnInterfaceName(vpnInterfaceName);
180 LOG.warn("addToLabelMapper: vpn interface is null for label {} prefix {} rd {} vpnId {}",
181 labelStr, prefix, rd, vpnId);
183 lriBuilder.setParentVpnRd(rd);
184 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnUtil.getVpnInstanceOpData(rd);
185 if (vpnInstanceOpDataEntry != null) {
186 List<String> vpnInstanceNames = Collections
187 .singletonList(vpnInstanceOpDataEntry.getVpnInstanceName());
188 lriBuilder.setVpnInstanceList(vpnInstanceNames);
190 LabelRouteInfo lri = lriBuilder.build();
191 InstanceIdentifier<LabelRouteInfo> lriIid = InstanceIdentifier.builder(LabelRouteMap.class)
192 .child(LabelRouteInfo.class, new LabelRouteInfoKey(label)).build();
193 tx.merge(lriIid, lri, CREATE_MISSING_PARENTS);
194 LOG.info("addToLabelMapper: Added label route info to label {} prefix {} nextHopList {} vpnId {}"
195 + " interface {} rd {} elantag {}", labelStr, prefix, nextHopIpList, vpnId,
196 vpnInterfaceName, rd, elanTag);
198 LOG.warn("addToLabelMapper: Can't add entry to label map for label {} prefix {} nextHopList {}"
199 + " vpnId {} interface {} rd {} elantag {}, dpnId is null", labelStr, prefix, nextHopIpList,
200 vpnId, vpnInterfaceName, rd, elanTag);
202 }), LOG, "addToLabelMapper");
209 public Adjacency createOperationalAdjacency(L3vpnInput input) {
210 return new AdjacencyBuilder().build();
213 @SuppressWarnings("checkstyle:IllegalCatch")
214 protected void addPrefixToBGP(String rd, String primaryRd, @Nullable String macAddress, String prefix,
215 String nextHopIp, VrfEntry.EncapType encapType, Uint32 label, Uint32 l3vni,
216 String gatewayMac, RouteOrigin origin,
217 TypedWriteTransaction<Configuration> writeConfigTxn) {
219 List<String> nextHopList = Collections.singletonList(nextHopIp);
220 LOG.info("ADD: addPrefixToBGP: Adding Fib entry rd {} prefix {} nextHop {} label {} gwMac {}", rd, prefix,
221 nextHopList, label, gatewayMac);
222 fibManager.addOrUpdateFibEntry(primaryRd, macAddress, prefix, nextHopList,
223 encapType, label, l3vni, gatewayMac, null /*parentVpnRd*/, origin, writeConfigTxn);
224 LOG.info("ADD: addPrefixToBGP: Added Fib entry rd {} prefix {} nextHop {} label {} gwMac {}", rd, prefix,
225 nextHopList, label, gatewayMac);
226 // Advertise the prefix to BGP only if nexthop ip is available
227 if (!nextHopList.isEmpty()) {
228 bgpManager.advertisePrefix(rd, macAddress, prefix, nextHopList, encapType, label,
229 l3vni, Uint32.ZERO /*l2vni*/, gatewayMac);
231 LOG.error("addPrefixToBGP: NextHopList is null/empty. Hence rd {} prefix {} nextHop {} label {}"
232 + " gwMac {} is not advertised to BGP", rd, prefix, nextHopList, label, gatewayMac);
234 } catch (Exception e) {
235 LOG.error("addPrefixToBGP: Add prefix {} with rd {} nextHop {} label {} gwMac {} failed", prefix, rd,
236 nextHopIp, label, gatewayMac, e);