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.LoggingFutures.addErrorLogging;
11 import static org.opendaylight.mdsal.binding.util.Datastore.OPERATIONAL;
13 import com.google.common.base.Preconditions;
14 import java.util.Collections;
15 import java.util.List;
16 import java.util.Optional;
17 import java.util.concurrent.ExecutionException;
18 import java.util.concurrent.locks.ReentrantLock;
19 import org.eclipse.jdt.annotation.Nullable;
20 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
21 import org.opendaylight.genius.utils.JvmGlobalLocks;
22 import org.opendaylight.mdsal.binding.api.DataBroker;
23 import org.opendaylight.mdsal.binding.util.Datastore.Configuration;
24 import org.opendaylight.mdsal.binding.util.ManagedNewTransactionRunner;
25 import org.opendaylight.mdsal.binding.util.ManagedNewTransactionRunnerImpl;
26 import org.opendaylight.mdsal.binding.util.TypedWriteTransaction;
27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
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 String networkName = input.getNetworkName();
89 String gwMacAddress = input.getGatewayMac();
90 SubnetRoute route = new SubnetRouteBuilder().setElantag(elantag).build();
91 RouteOrigin origin = RouteOrigin.CONNECTED; // Only case when a route is considered as directly connected
92 VrfEntry vrfEntry = FibHelper.getVrfEntryBuilder(prefix, label, nextHop, origin, networkName)
93 .addAugmentation(SubnetRoute.class, route).setL3vni(l3vni).setGatewayMacAddress(gwMacAddress).build();
94 LOG.debug("Created vrfEntry for {} nexthop {} label {} and elantag {}", prefix, nextHop, label, elantag);
95 InstanceIdentifier<VrfEntry> vrfEntryId =
96 InstanceIdentifier.builder(FibEntries.class)
97 .child(VrfTables.class, new VrfTablesKey(rd))
98 .child(VrfEntry.class, new VrfEntryKey(prefix)).build();
99 Optional<VrfEntry> entry = Optional.empty();
101 entry = SingleTransactionDataBroker.syncReadOptional(broker,
102 LogicalDatastoreType.CONFIGURATION, vrfEntryId);
103 } catch (ExecutionException | InterruptedException e) {
104 LOG.error("addSubnetRouteFibEntry: Exception while reading vrfEntry for the prefix {} rd {}", prefix,
107 if (!entry.isPresent()) {
108 List<VrfEntry> vrfEntryList = Collections.singletonList(vrfEntry);
110 InstanceIdentifier.InstanceIdentifierBuilder<VrfTables> idBuilder =
111 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd));
112 InstanceIdentifier<VrfTables> vrfTableId = idBuilder.build();
114 VrfTables vrfTableNew = new VrfTablesBuilder().setRouteDistinguisher(rd).setVrfEntry(vrfEntryList).build();
115 vpnUtil.syncUpdate(LogicalDatastoreType.CONFIGURATION, vrfTableId, vrfTableNew);
116 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Added vrfEntry for {} nexthop {} label {} rd {}"
117 + " vpnName {}", prefix, nextHop, label, rd, vpnName);
118 } else { // Found in MDSAL database
119 vpnUtil.syncWrite(LogicalDatastoreType.CONFIGURATION, vrfEntryId, vrfEntry);
120 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Updated vrfEntry for {} nexthop {} label {} rd {}"
121 + " vpnName {}", prefix, nextHop, label, rd, vpnName);
124 //Will be handled appropriately with the iRT patch for EVPN
125 if (input.getEncapType().equals(VrfEntryBase.EncapType.Mplsgre)) {
126 List<VpnInstanceOpDataEntry> vpnsToImportRoute = vpnUtil.getVpnsImportingMyRoute(vpnName);
127 if (vpnsToImportRoute.size() > 0) {
128 VrfEntry importingVrfEntry = FibHelper.getVrfEntryBuilder(prefix, label, nextHop,
129 RouteOrigin.SELF_IMPORTED, rd).addAugmentation(SubnetRoute.class, route).build();
130 List<VrfEntry> importingVrfEntryList = Collections.singletonList(importingVrfEntry);
131 for (VpnInstanceOpDataEntry vpnInstance : vpnsToImportRoute) {
132 String importingRd = vpnInstance.getVrfId();
133 InstanceIdentifier<VrfTables> importingVrfTableId =
134 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
135 new VrfTablesKey(importingRd)).build();
136 VrfTables importingVrfTable = new VrfTablesBuilder().setRouteDistinguisher(importingRd)
137 .setVrfEntry(importingVrfEntryList).build();
138 vpnUtil.syncUpdate(LogicalDatastoreType.CONFIGURATION, importingVrfTableId, importingVrfTable);
139 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Exported route rd {} prefix {} nexthop {}"
140 + " label {} to vpn {} importingRd {}", rd, prefix, nextHop, label,
141 vpnInstance.getVpnInstanceName(), importingRd);
145 LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Created vrfEntry for {} nexthop {} label {} and elantag {}"
146 + "rd {} vpnName {}", prefix, nextHop, label, elantag, rd, vpnName);
149 public void addToLabelMapper(Uint32 label, Uint64 dpnId, String prefix, List<String> nextHopIpList, Uint32 vpnId,
150 @Nullable String vpnInterfaceName, @Nullable Uint32 elanTag,
151 boolean isSubnetRoute, String rd) {
152 final String labelStr = Preconditions.checkNotNull(label, "addToLabelMapper: label cannot be null or empty!")
154 Preconditions.checkNotNull(prefix, "addToLabelMapper: prefix cannot be null or empty!");
155 Preconditions.checkNotNull(vpnId, "addToLabelMapper: vpnId cannot be null or empty!");
156 Preconditions.checkNotNull(rd, "addToLabelMapper: rd cannot be null or empty!");
157 if (!isSubnetRoute) {
158 // NextHop must be present for non-subnetroute entries
159 Preconditions.checkNotNull(nextHopIpList, "addToLabelMapper: nextHopIp cannot be null or empty!");
162 // FIXME: separate this out somehow?
163 final ReentrantLock lock = JvmGlobalLocks.getLockForString(labelStr);
166 addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
167 LOG.info("addToLabelMapper: label {} dpn {} prefix {} nexthoplist {} vpnid {} vpnIntfcName {} rd {}"
168 + " elanTag {}", labelStr, dpnId, prefix, nextHopIpList, vpnId, vpnInterfaceName, rd, elanTag);
170 LabelRouteInfoBuilder lriBuilder = new LabelRouteInfoBuilder();
171 lriBuilder.setLabel(label).setDpnId(dpnId).setPrefix(prefix).setNextHopIpList(nextHopIpList)
172 .setParentVpnid(vpnId).setIsSubnetRoute(isSubnetRoute);
173 if (elanTag != null) {
174 lriBuilder.setElanTag(elanTag);
176 LOG.warn("addToLabelMapper: elanTag is null for label {} prefix {} rd {} vpnId {}",
177 labelStr, prefix, rd, vpnId);
179 if (vpnInterfaceName != null) {
180 lriBuilder.setVpnInterfaceName(vpnInterfaceName);
182 LOG.warn("addToLabelMapper: vpn interface is null for label {} prefix {} rd {} vpnId {}",
183 labelStr, prefix, rd, vpnId);
185 lriBuilder.setParentVpnRd(rd);
186 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnUtil.getVpnInstanceOpData(rd);
187 if (vpnInstanceOpDataEntry != null) {
188 List<String> vpnInstanceNames = Collections
189 .singletonList(vpnInstanceOpDataEntry.getVpnInstanceName());
190 lriBuilder.setVpnInstanceList(vpnInstanceNames);
192 LabelRouteInfo lri = lriBuilder.build();
193 InstanceIdentifier<LabelRouteInfo> lriIid = InstanceIdentifier.builder(LabelRouteMap.class)
194 .child(LabelRouteInfo.class, new LabelRouteInfoKey(label)).build();
195 tx.mergeParentStructureMerge(lriIid, lri);
196 LOG.info("addToLabelMapper: Added label route info to label {} prefix {} nextHopList {} vpnId {}"
197 + " interface {} rd {} elantag {}", labelStr, prefix, nextHopIpList, vpnId,
198 vpnInterfaceName, rd, elanTag);
200 LOG.warn("addToLabelMapper: Can't add entry to label map for label {} prefix {} nextHopList {}"
201 + " vpnId {} interface {} rd {} elantag {}, dpnId is null",
202 labelStr, prefix, nextHopIpList,
203 vpnId, vpnInterfaceName, rd, elanTag);
205 }), LOG, "addToLabelMapper");
212 public Adjacency createOperationalAdjacency(L3vpnInput input) {
213 return new AdjacencyBuilder().build();
216 @SuppressWarnings("checkstyle:IllegalCatch")
217 protected void addPrefixToBGP(String rd, String primaryRd, @Nullable String macAddress, String prefix,
218 String nextHopIp, VrfEntry.EncapType encapType, Uint32 label, Uint32 l3vni,
219 String gatewayMac, RouteOrigin origin,
220 TypedWriteTransaction<Configuration> writeConfigTxn) {
222 List<String> nextHopList = Collections.singletonList(nextHopIp);
223 LOG.info("ADD: addPrefixToBGP: Adding Fib entry rd {} prefix {} nextHop {} label {} gwMac {}", rd, prefix,
224 nextHopList, label, gatewayMac);
225 fibManager.addOrUpdateFibEntry(primaryRd, macAddress, prefix, nextHopList,
226 encapType, label, l3vni, gatewayMac, null /*parentVpnRd*/, origin, writeConfigTxn);
227 LOG.info("ADD: addPrefixToBGP: Added Fib entry rd {} prefix {} nextHop {} label {} gwMac {}", rd, prefix,
228 nextHopList, label, gatewayMac);
229 // Advertise the prefix to BGP only if nexthop ip is available
230 if (!nextHopList.isEmpty()) {
231 bgpManager.advertisePrefix(rd, macAddress, prefix, nextHopList, encapType, label,
232 l3vni, Uint32.ZERO /*l2vni*/, gatewayMac);
234 LOG.error("addPrefixToBGP: NextHopList is null/empty. Hence rd {} prefix {} nextHop {} label {}"
235 + " gwMac {} is not advertised to BGP", rd, prefix, nextHopList, label, gatewayMac);
237 } catch (Exception e) {
238 LOG.error("addPrefixToBGP: Add prefix {} with rd {} nextHop {} label {} gwMac {} failed", prefix, rd,
239 nextHopIp, label, gatewayMac, e);