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