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     @Override
  75     public void populateFib(L3vpnInput input, TypedWriteTransaction<Configuration> writeCfgTxn) {
  76
  77     }
  78
  79     public void addSubnetRouteFibEntry(L3vpnInput input) {
  80         String rd = input.getRd();
  81         String vpnName = input.getVpnName();
  82         String prefix = input.getSubnetIp();
  83         String nextHop = input.getNextHopIp();
  84         long label = input.getLabel();
  85         long l3vni = input.getL3vni();
  86         long elantag = input.getElanTag();
  87         BigInteger dpnId = input.getDpnId();
  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 = MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, vrfEntryId);
 100
 101         if (!entry.isPresent()) {
 102             List<VrfEntry> vrfEntryList = Collections.singletonList(vrfEntry);
 103
 104             InstanceIdentifier.InstanceIdentifierBuilder<VrfTables> idBuilder =
 105                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd));
 106             InstanceIdentifier<VrfTables> vrfTableId = idBuilder.build();
 107
 108             VrfTables vrfTableNew = new VrfTablesBuilder().setRouteDistinguisher(rd).setVrfEntry(vrfEntryList).build();
 109             vpnUtil.syncUpdate(LogicalDatastoreType.CONFIGURATION, vrfTableId, vrfTableNew);
 110             LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Added vrfEntry for {} nexthop {} label {} rd {}"
 111                     + " vpnName {}", prefix, nextHop, label, rd, vpnName);
 112         } else { // Found in MDSAL database
 113             vpnUtil.syncWrite(LogicalDatastoreType.CONFIGURATION, vrfEntryId, vrfEntry);
 114             LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Updated vrfEntry for {} nexthop {} label {} rd {}"
 115                     + " vpnName {}", prefix, nextHop, label, rd, vpnName);
 116         }
 117
 118         //Will be handled appropriately with the iRT patch for EVPN
 119         if (input.getEncapType().equals(VrfEntryBase.EncapType.Mplsgre)) {
 120             long vpnId = vpnUtil.getVpnId(vpnName);
 121             addToLabelMapper(label, dpnId, prefix, Collections.singletonList(nextHop), vpnId, null, elantag, true, rd);
 122             List<VpnInstanceOpDataEntry> vpnsToImportRoute = vpnUtil.getVpnsImportingMyRoute(vpnName);
 123             if (vpnsToImportRoute.size() > 0) {
 124                 VrfEntry importingVrfEntry = FibHelper.getVrfEntryBuilder(prefix, label, nextHop,
 125                         RouteOrigin.SELF_IMPORTED, rd).addAugmentation(SubnetRoute.class, route).build();
 126                 List<VrfEntry> importingVrfEntryList = Collections.singletonList(importingVrfEntry);
 127                 for (VpnInstanceOpDataEntry vpnInstance : vpnsToImportRoute) {
 128                     String importingRd = vpnInstance.getVrfId();
 129                     InstanceIdentifier<VrfTables> importingVrfTableId =
 130                             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
 131                                     new VrfTablesKey(importingRd)).build();
 132                     VrfTables importingVrfTable = new VrfTablesBuilder().setRouteDistinguisher(importingRd)
 133                             .setVrfEntry(importingVrfEntryList).build();
 134                     vpnUtil.syncUpdate(LogicalDatastoreType.CONFIGURATION, importingVrfTableId, importingVrfTable);
 135                     LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Exported route rd {} prefix {} nexthop {}"
 136                             + " label {} to vpn {} importingRd {}", rd, prefix, nextHop, label,
 137                             vpnInstance.getVpnInstanceName(), importingRd);
 138                 }
 139             }
 140         }
 141         LOG.info("SUBNETROUTE: addSubnetRouteFibEntryToDS: Created vrfEntry for {} nexthop {} label {} and elantag {}"
 142                 + "rd {} vpnName {}", prefix, nextHop, label, elantag, rd, vpnName);
 143     }
 144
 145     public void addToLabelMapper(Long label, BigInteger dpnId, String prefix, List<String> nextHopIpList, Long vpnId,
 146             @Nullable String vpnInterfaceName, @Nullable Long elanTag, boolean isSubnetRoute, String rd) {
 147         final String labelStr = Preconditions.checkNotNull(label, "addToLabelMapper: label cannot be null or empty!")
 148                 .toString();
 149         Preconditions.checkNotNull(prefix, "addToLabelMapper: prefix cannot be null or empty!");
 150         Preconditions.checkNotNull(vpnId, "addToLabelMapper: vpnId cannot be null or empty!");
 151         Preconditions.checkNotNull(rd, "addToLabelMapper: rd cannot be null or empty!");
 152         if (!isSubnetRoute) {
 153             // NextHop must be present for non-subnetroute entries
 154             Preconditions.checkNotNull(nextHopIpList, "addToLabelMapper: nextHopIp cannot be null or empty!");
 155         }
 156
 157         // FIXME: separate this out somehow?
 158         final ReentrantLock lock = JvmGlobalLocks.getLockForString(labelStr);
 159         lock.lock();
 160         try {
 161             addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
 162                 LOG.info("addToLabelMapper: label {} dpn {} prefix {} nexthoplist {} vpnid {} vpnIntfcName {} rd {}"
 163                         + " elanTag {}", labelStr, dpnId, prefix, nextHopIpList, vpnId, vpnInterfaceName, rd, elanTag);
 164                 if (dpnId != null) {
 165                     LabelRouteInfoBuilder lriBuilder = new LabelRouteInfoBuilder();
 166                     lriBuilder.setLabel(label).setDpnId(dpnId).setPrefix(prefix).setNextHopIpList(nextHopIpList)
 167                     .setParentVpnid(vpnId).setIsSubnetRoute(isSubnetRoute);
 168                     if (elanTag != null) {
 169                         lriBuilder.setElanTag(elanTag);
 170                     } else {
 171                         LOG.warn("addToLabelMapper: elanTag is null for label {} prefix {} rd {} vpnId {}",
 172                                 labelStr, prefix, rd, vpnId);
 173                     }
 174                     if (vpnInterfaceName != null) {
 175                         lriBuilder.setVpnInterfaceName(vpnInterfaceName);
 176                     } else {
 177                         LOG.warn("addToLabelMapper: vpn interface is null for label {} prefix {} rd {} vpnId {}",
 178                                 labelStr, prefix, rd, vpnId);
 179                     }
 180                     lriBuilder.setParentVpnRd(rd);
 181                     VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnUtil.getVpnInstanceOpData(rd);
 182                     if (vpnInstanceOpDataEntry != null) {
 183                         List<String> vpnInstanceNames = Collections
 184                                 .singletonList(vpnInstanceOpDataEntry.getVpnInstanceName());
 185                         lriBuilder.setVpnInstanceList(vpnInstanceNames);
 186                     }
 187                     LabelRouteInfo lri = lriBuilder.build();
 188                     InstanceIdentifier<LabelRouteInfo> lriIid = InstanceIdentifier.builder(LabelRouteMap.class)
 189                             .child(LabelRouteInfo.class, new LabelRouteInfoKey(label)).build();
 190                     tx.merge(lriIid, lri, CREATE_MISSING_PARENTS);
 191                     LOG.info("addToLabelMapper: Added label route info to label {} prefix {} nextHopList {} vpnId {}"
 192                             + " interface {} rd {} elantag {}", labelStr, prefix, nextHopIpList, vpnId,
 193                             vpnInterfaceName, rd, elanTag);
 194                 } else {
 195                     LOG.warn("addToLabelMapper: Can't add entry to label map for label {} prefix {} nextHopList {}"
 196                             + " vpnId {} interface {} rd {} elantag {}, dpnId is null", labelStr, prefix, nextHopIpList,
 197                             vpnId, vpnInterfaceName, rd, elanTag);
 198                 }
 199             }), LOG, "addToLabelMapper");
 200         } finally {
 201             lock.unlock();
 202         }
 203     }
 204
 205     @Override
 206     public Adjacency createOperationalAdjacency(L3vpnInput input) {
 207         return new AdjacencyBuilder().build();
 208     }
 209
 210     @SuppressWarnings("checkstyle:IllegalCatch")
 211     protected void addPrefixToBGP(String rd, String primaryRd, @Nullable String macAddress, String prefix,
 212                                   String nextHopIp, VrfEntry.EncapType encapType, long label, long l3vni,
 213                                   String gatewayMac, RouteOrigin origin,
 214                                   TypedWriteTransaction<Configuration> writeConfigTxn) {
 215         try {
 216             List<String> nextHopList = Collections.singletonList(nextHopIp);
 217             LOG.info("ADD: addPrefixToBGP: Adding Fib entry rd {} prefix {} nextHop {} label {} gwMac {}", rd, prefix,
 218                     nextHopList, label, gatewayMac);
 219             fibManager.addOrUpdateFibEntry(primaryRd, macAddress, prefix, nextHopList,
 220                     encapType, (int)label, l3vni, gatewayMac, null /*parentVpnRd*/, origin, writeConfigTxn);
 221             LOG.info("ADD: addPrefixToBGP: Added Fib entry rd {} prefix {} nextHop {} label {} gwMac {}", rd, prefix,
 222                     nextHopList, label, gatewayMac);
 223             // Advertise the prefix to BGP only if nexthop ip is available
 224             if (!nextHopList.isEmpty()) {
 225                 bgpManager.advertisePrefix(rd, macAddress, prefix, nextHopList, encapType, (int)label,
 226                         l3vni, 0 /*l2vni*/, gatewayMac);
 227             } else {
 228                 LOG.error("addPrefixToBGP: NextHopList is null/empty. Hence rd {} prefix {} nextHop {} label {}"
 229                         + " gwMac {} is not advertised to BGP", rd, prefix, nextHopList, label, gatewayMac);
 230             }
 231         } catch (Exception e) {
 232             LOG.error("addPrefixToBGP: Add prefix {} with rd {} nextHop {} label {} gwMac {} failed", prefix, rd,
 233                     nextHopIp, label, gatewayMac, e);
 234         }
 235     }
 236 }