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