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