vpnmanager/impl/src/main/java/org/opendaylight/netvirt/vpnmanager/populator/impl/L3vpnPopulator.java

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