fibmanager/impl/src/main/java/org/opendaylight/netvirt/fibmanager/EvpnVrfEntryHandler.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.fibmanager;
   9
  10 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
  11
  12 import com.google.common.base.Optional;
  13 import com.google.common.base.Preconditions;
  14 import java.math.BigInteger;
  15 import java.util.ArrayList;
  16 import java.util.Collections;
  17 import java.util.List;
  18 import java.util.Objects;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  21 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  22 import org.opendaylight.genius.datastoreutils.listeners.DataTreeEventCallbackRegistrar;
  23 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  24 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  25 import org.opendaylight.genius.mdsalutil.ActionInfo;
  26 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  27 import org.opendaylight.genius.mdsalutil.NwConstants;
  28 import org.opendaylight.genius.mdsalutil.actions.ActionGroup;
  29 import org.opendaylight.genius.mdsalutil.actions.ActionSetFieldEthernetDestination;
  30 import org.opendaylight.genius.mdsalutil.actions.ActionSetFieldTunnelId;
  31 import org.opendaylight.genius.mdsalutil.instructions.InstructionApplyActions;
  32 import org.opendaylight.genius.utils.batching.SubTransaction;
  33 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  34 import org.opendaylight.netvirt.elanmanager.api.IElanService;
  35 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
  36 import org.opendaylight.serviceutils.upgrade.UpgradeState;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelOperStatus;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelList;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.SubnetRoute;
  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.VrfTablesKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.vpnnexthops.VpnNexthop;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53
  54 public class EvpnVrfEntryHandler extends BaseVrfEntryHandler implements IVrfEntryHandler {
  55     private static final Logger LOG = LoggerFactory.getLogger(EvpnVrfEntryHandler.class);
  56     private final ManagedNewTransactionRunner txRunner;
  57     private final VrfEntryListener vrfEntryListener;
  58     private final BgpRouteVrfEntryHandler bgpRouteVrfEntryHandler;
  59     private final NexthopManager nexthopManager;
  60     private final JobCoordinator jobCoordinator;
  61     private final IElanService elanManager;
  62
  63     EvpnVrfEntryHandler(DataBroker broker, VrfEntryListener vrfEntryListener,
  64             BgpRouteVrfEntryHandler bgpRouteVrfEntryHandler, NexthopManager nexthopManager,
  65             JobCoordinator jobCoordinator, IElanService elanManager, FibUtil fibUtil,
  66             final UpgradeState upgradeState, final DataTreeEventCallbackRegistrar eventCallbacks) {
  67         super(broker, nexthopManager, null, fibUtil, upgradeState, eventCallbacks);
  68         this.txRunner = new ManagedNewTransactionRunnerImpl(broker);
  69         this.vrfEntryListener = vrfEntryListener;
  70         this.bgpRouteVrfEntryHandler = bgpRouteVrfEntryHandler;
  71         this.nexthopManager = nexthopManager;
  72         this.jobCoordinator = jobCoordinator;
  73         this.elanManager = elanManager;
  74     }
  75
  76     @Override
  77     public void createFlows(InstanceIdentifier<VrfEntry> identifier, VrfEntry vrfEntry, String rd) {
  78         LOG.info("Initiating creation of Evpn Flows");
  79         final VrfTablesKey vrfTableKey = identifier.firstKeyOf(VrfTables.class);
  80         final VpnInstanceOpDataEntry vpnInstance = getFibUtil().getVpnInstanceOpData(
  81                 vrfTableKey.getRouteDistinguisher()).get();
  82         Long vpnId = vpnInstance.getVpnId();
  83         Preconditions.checkNotNull(vpnInstance, "Vpn Instance not available " + vrfTableKey.getRouteDistinguisher());
  84         Preconditions.checkNotNull(vpnId, "Vpn Instance with rd " + vpnInstance.getVrfId()
  85                 + " has null vpnId!");
  86         if (RouteOrigin.value(vrfEntry.getOrigin()) == RouteOrigin.CONNECTED) {
  87             SubnetRoute subnetRoute = vrfEntry.augmentation(SubnetRoute.class);
  88             final List<VpnToDpnList> vpnToDpnList = vpnInstance.getVpnToDpnList();
  89             final long elanTag = subnetRoute.getElantag();
  90             LOG.trace("SubnetRoute augmented vrfentry found for rd {} prefix {} with elantag {}",
  91                     rd, vrfEntry.getDestPrefix(), elanTag);
  92             if (vpnToDpnList != null) {
  93                 jobCoordinator.enqueueJob("FIB-" + rd + "-" + vrfEntry.getDestPrefix(),
  94                     () -> Collections.singletonList(
  95                         txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION, tx -> {
  96                             for (final VpnToDpnList curDpn : vpnToDpnList) {
  97                                 if (curDpn.getDpnState() == VpnToDpnList.DpnState.Active) {
  98                                     vrfEntryListener.installSubnetRouteInFib(curDpn.getDpnId(), elanTag, rd,
  99                                         vpnId, vrfEntry, tx);
 100                                 }
 101                             }
 102                         })));
 103             }
 104             return;
 105         }
 106         Prefixes localNextHopInfo = getFibUtil().getPrefixToInterface(vpnInstance.getVpnId(), vrfEntry.getDestPrefix());
 107         List<BigInteger> localDpnId = new ArrayList<>();
 108         boolean isNatPrefix = false;
 109         if (Prefixes.PrefixCue.Nat.equals(localNextHopInfo.getPrefixCue())) {
 110             LOG.info("NAT Prefix {} with vpnId {} rd {}. Skip local dpn {} FIB processing",
 111                     vrfEntry.getDestPrefix(), vpnId, rd, localNextHopInfo.getDpnId());
 112             localDpnId.add(localNextHopInfo.getDpnId());
 113             isNatPrefix = true;
 114         } else {
 115             localDpnId = createLocalEvpnFlows(vpnInstance.getVpnId(), rd, vrfEntry,
 116                     localNextHopInfo);
 117         }
 118         createRemoteEvpnFlows(rd, vrfEntry, vpnInstance, localDpnId, vrfTableKey, isNatPrefix);
 119     }
 120
 121     @Override
 122     public void removeFlows(InstanceIdentifier<VrfEntry> identifier, VrfEntry vrfEntry, String rd) {
 123         final VrfTablesKey vrfTableKey = identifier.firstKeyOf(VrfTables.class);
 124         final VpnInstanceOpDataEntry vpnInstance = getFibUtil().getVpnInstanceOpData(
 125                 vrfTableKey.getRouteDistinguisher()).get();
 126         if (vpnInstance == null) {
 127             LOG.error("VPN Instance for rd {} is not available from VPN Op Instance Datastore", rd);
 128             return;
 129         }
 130         VpnNexthop localNextHopInfo = nexthopManager.getVpnNexthop(vpnInstance.getVpnId(),
 131                 vrfEntry.getDestPrefix());
 132         List<BigInteger> localDpnId = checkDeleteLocalEvpnFLows(vpnInstance.getVpnId(), rd, vrfEntry, localNextHopInfo);
 133         deleteRemoteEvpnFlows(rd, vrfEntry, vpnInstance, vrfTableKey, localDpnId);
 134         vrfEntryListener.cleanUpOpDataForFib(vpnInstance.getVpnId(), rd, vrfEntry);
 135     }
 136
 137     @Override
 138     public void updateFlows(InstanceIdentifier<VrfEntry> identifier, VrfEntry original, VrfEntry update, String rd) {
 139         //Not used
 140     }
 141
 142     private List<BigInteger> createLocalEvpnFlows(long vpnId, String rd, VrfEntry vrfEntry,
 143                                                   Prefixes localNextHopInfo) {
 144         List<BigInteger> returnLocalDpnId = new ArrayList<>();
 145         String localNextHopIP = vrfEntry.getDestPrefix();
 146         if (localNextHopInfo == null) {
 147             //Handle extra routes and imported routes
 148             Routes extraRoute = getVpnToExtraroute(vpnId, rd, vrfEntry.getDestPrefix());
 149             if (extraRoute != null && extraRoute.getNexthopIpList() != null) {
 150                 for (String nextHopIp : extraRoute.getNexthopIpList()) {
 151                     LOG.info("NextHop IP for destination {} is {}", vrfEntry.getDestPrefix(), nextHopIp);
 152                     if (nextHopIp != null) {
 153                         localNextHopInfo = getFibUtil().getPrefixToInterface(vpnId, nextHopIp + "/32");
 154                         if (localNextHopInfo != null) {
 155                             localNextHopIP = nextHopIp + "/32";
 156                             BigInteger dpnId = checkCreateLocalEvpnFlows(localNextHopInfo, localNextHopIP, vpnId,
 157                                     rd, vrfEntry);
 158                             returnLocalDpnId.add(dpnId);
 159                         }
 160                     }
 161                 }
 162             }
 163         } else {
 164             LOG.info("Creating local EVPN flows for prefix {} rd {} route-paths {} evi {}.",
 165                     vrfEntry.getDestPrefix(), rd, vrfEntry.getRoutePaths(), vrfEntry.getL3vni());
 166             BigInteger dpnId = checkCreateLocalEvpnFlows(localNextHopInfo, localNextHopIP, vpnId,
 167                     rd, vrfEntry);
 168             returnLocalDpnId.add(dpnId);
 169         }
 170         return returnLocalDpnId;
 171     }
 172
 173     private BigInteger checkCreateLocalEvpnFlows(Prefixes localNextHopInfo, String localNextHopIP,
 174                                                  final Long vpnId, final String rd,
 175                                                  final VrfEntry vrfEntry) {
 176         final BigInteger dpnId = localNextHopInfo.getDpnId();
 177         String jobKey = FibUtil.getCreateLocalNextHopJobKey(vpnId, dpnId, vrfEntry.getDestPrefix());
 178         final long groupId = nexthopManager.createLocalNextHop(vpnId, dpnId,
 179             localNextHopInfo.getVpnInterfaceName(), localNextHopIP, vrfEntry.getDestPrefix(),
 180             vrfEntry.getGatewayMacAddress());
 181         LOG.debug("LocalNextHopGroup {} created/reused for prefix {} rd {} evi {} route-paths {}", groupId,
 182             vrfEntry.getDestPrefix(), rd, vrfEntry.getL3vni(), vrfEntry.getRoutePaths());
 183
 184         final List<InstructionInfo> instructions = Collections.singletonList(
 185             new InstructionApplyActions(
 186                 Collections.singletonList(new ActionGroup(groupId))));
 187         jobCoordinator.enqueueJob(jobKey,
 188             () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
 189                 tx -> makeConnectedRoute(dpnId, vpnId, vrfEntry, rd, instructions, NwConstants.ADD_FLOW, tx,
 190                         null))));
 191         return dpnId;
 192     }
 193
 194     private void createRemoteEvpnFlows(String rd, VrfEntry vrfEntry, VpnInstanceOpDataEntry vpnInstance,
 195                                        List<BigInteger> localDpnId, VrfTablesKey vrfTableKey, boolean isNatPrefix) {
 196         LOG.info("Creating remote EVPN flows for prefix {} rd {} route-paths {} evi {}",
 197             vrfEntry.getDestPrefix(), rd, vrfEntry.getRoutePaths(), vrfEntry.getL3vni());
 198         List<VpnToDpnList> vpnToDpnList = vpnInstance.getVpnToDpnList();
 199         if (vpnToDpnList != null) {
 200             jobCoordinator.enqueueJob("FIB" + rd + vrfEntry.getDestPrefix(),
 201                 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(tx -> {
 202                     for (VpnToDpnList vpnDpn : vpnToDpnList) {
 203                         if (!localDpnId.contains(vpnDpn.getDpnId())) {
 204                             if (vpnDpn.getDpnState() == VpnToDpnList.DpnState.Active) {
 205                                 createRemoteFibEntry(vpnDpn.getDpnId(), vpnInstance.getVpnId(),
 206                                         vrfTableKey, vrfEntry, isNatPrefix, tx);
 207                             }
 208                         }
 209                     }
 210                 })));
 211         }
 212     }
 213
 214     private void createRemoteFibEntry(final BigInteger remoteDpnId, final long vpnId, final VrfTablesKey vrfTableKey,
 215                                       final VrfEntry vrfEntry, boolean isNatPrefix, WriteTransaction tx) {
 216
 217         String rd = vrfTableKey.getRouteDistinguisher();
 218         List<SubTransaction> subTxns =  new ArrayList<>();
 219         LOG.debug("createremotefibentry: adding route {} for rd {} with transaction {}",
 220                 vrfEntry.getDestPrefix(), rd, tx);
 221         List<NexthopManager.AdjacencyResult> tunnelInterfaceList = resolveAdjacency(remoteDpnId, vpnId, vrfEntry, rd);
 222
 223         if (tunnelInterfaceList.isEmpty()) {
 224             LOG.error("Could not get interface for route-paths: {} in vpn {}",
 225                     vrfEntry.getRoutePaths(), rd);
 226             LOG.warn("Failed to add Route: {} in vpn: {}",
 227                     vrfEntry.getDestPrefix(), rd);
 228             return;
 229         }
 230
 231         for (NexthopManager.AdjacencyResult adjacencyResult : tunnelInterfaceList) {
 232             List<ActionInfo> actionInfos = new ArrayList<>();
 233             BigInteger tunnelId = BigInteger.ZERO;
 234             String prefix = adjacencyResult.getPrefix();
 235             Prefixes prefixInfo = getFibUtil().getPrefixToInterface(vpnId, prefix);
 236             String interfaceName = prefixInfo.getVpnInterfaceName();
 237             if (RouteOrigin.BGP.getValue().equals(vrfEntry.getOrigin()) || isNatPrefix) {
 238                 tunnelId = BigInteger.valueOf(vrfEntry.getL3vni());
 239             } else if (FibUtil.isVxlanNetwork(prefixInfo.getNetworkType())) {
 240                 tunnelId = BigInteger.valueOf(prefixInfo.getSegmentationId());
 241             } else {
 242                 try {
 243                     StateTunnelList stateTunnelList = getFibUtil().getTunnelState(interfaceName);
 244                     if (stateTunnelList == null || stateTunnelList.getOperState() != TunnelOperStatus.Up) {
 245                         LOG.trace("Tunnel is not up for interface {}", interfaceName);
 246                         return;
 247                     }
 248                     tunnelId = BigInteger.valueOf(stateTunnelList.getIfIndex());
 249                 } catch (ReadFailedException e) {
 250                     LOG.error("createRemoteFibEntry: error in fetching tunnel state for interface {}",
 251                             interfaceName, e);
 252                     continue;
 253                 }
 254             }
 255             LOG.debug("adding set tunnel id action for label {}", tunnelId);
 256             String macAddress = null;
 257             String vpnName = getFibUtil().getVpnNameFromId(vpnId);
 258             if (vpnName == null) {
 259                 LOG.debug("Failed to get VPN name for vpnId {}", vpnId);
 260                 return;
 261             }
 262             if (interfaceName != null) {
 263                 macAddress = getFibUtil().getMacAddressFromPrefix(interfaceName, vpnName, prefix);
 264                 actionInfos.add(new ActionSetFieldEthernetDestination(new MacAddress(macAddress)));
 265             }
 266             actionInfos.add(new ActionSetFieldTunnelId(tunnelId));
 267             List<ActionInfo> egressActions =
 268                     nexthopManager.getEgressActionsForInterface(adjacencyResult.getInterfaceName(), actionInfos.size(),
 269                             true);
 270             if (egressActions.isEmpty()) {
 271                 LOG.error("Failed to retrieve egress action for prefix {} route-paths {} interface {}."
 272                         + " Aborting remote FIB entry creation..", vrfEntry.getDestPrefix(),
 273                         vrfEntry.getRoutePaths(), adjacencyResult.getInterfaceName());
 274                 return;
 275             }
 276             actionInfos.addAll(egressActions);
 277             List<InstructionInfo> instructions = new ArrayList<>();
 278             instructions.add(new InstructionApplyActions(actionInfos));
 279             makeConnectedRoute(remoteDpnId, vpnId, vrfEntry, rd, instructions, NwConstants.ADD_FLOW, tx, subTxns);
 280         }
 281         LOG.debug("Successfully added FIB entry for prefix {} in rd {}", vrfEntry.getDestPrefix(), rd);
 282     }
 283
 284     private void deleteRemoteEvpnFlows(String rd, VrfEntry vrfEntry, VpnInstanceOpDataEntry vpnInstance,
 285                                        VrfTablesKey vrfTableKey, List<BigInteger> localDpnIdList) {
 286         List<VpnToDpnList> vpnToDpnList = vpnInstance.getVpnToDpnList();
 287         List<SubTransaction> subTxns =  new ArrayList<>();
 288         if (vpnToDpnList != null) {
 289             jobCoordinator.enqueueJob("FIB" + rd + vrfEntry.getDestPrefix(),
 290                 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(tx -> {
 291                     final Optional<Routes> extraRouteOptional = Optional.absent();
 292                     if (localDpnIdList.size() <= 0) {
 293                         for (VpnToDpnList curDpn1 : vpnToDpnList) {
 294                             if (RouteOrigin.value(vrfEntry.getOrigin()) == RouteOrigin.BGP) {
 295                                 if (curDpn1.getDpnState() == VpnToDpnList.DpnState.Active) {
 296                                     bgpRouteVrfEntryHandler.deleteRemoteRoute(BigInteger.ZERO, curDpn1.getDpnId(),
 297                                             vpnInstance.getVpnId(), vrfTableKey, vrfEntry,
 298                                             extraRouteOptional, tx, subTxns);
 299                                 }
 300                             } else {
 301                                 deleteRemoteRoute(BigInteger.ZERO, curDpn1.getDpnId(),
 302                                         vpnInstance.getVpnId(), vrfTableKey, vrfEntry,
 303                                         extraRouteOptional, tx);
 304                             }
 305                         }
 306                     } else {
 307                         for (BigInteger localDpnId : localDpnIdList) {
 308                             for (VpnToDpnList curDpn2 : vpnToDpnList) {
 309                                 if (!Objects.equals(curDpn2.getDpnId(), localDpnId)) {
 310                                     if (RouteOrigin.value(vrfEntry.getOrigin()) == RouteOrigin.BGP) {
 311                                         if (curDpn2.getDpnState() == VpnToDpnList.DpnState.Active) {
 312                                             bgpRouteVrfEntryHandler.deleteRemoteRoute(localDpnId, curDpn2.getDpnId(),
 313                                                     vpnInstance.getVpnId(), vrfTableKey, vrfEntry,
 314                                                     extraRouteOptional, tx, subTxns);
 315                                         }
 316                                     } else {
 317                                         deleteRemoteRoute(localDpnId, curDpn2.getDpnId(),
 318                                                 vpnInstance.getVpnId(), vrfTableKey, vrfEntry,
 319                                                 extraRouteOptional, tx);
 320                                     }
 321                                 }
 322                             }
 323                         }
 324                     }
 325                 })));
 326         }
 327     }
 328
 329     private List<BigInteger> checkDeleteLocalEvpnFLows(long vpnId, String rd, VrfEntry vrfEntry,
 330                                                        VpnNexthop localNextHopInfo) {
 331         List<BigInteger> returnLocalDpnId = new ArrayList<>();
 332         if (localNextHopInfo == null) {
 333             //Handle extra routes and imported routes
 334         } else {
 335             final BigInteger dpnId = localNextHopInfo.getDpnId();
 336             jobCoordinator.enqueueJob("FIB-" + rd + "-" + vrfEntry.getDestPrefix(),
 337                 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
 338                     tx -> makeConnectedRoute(dpnId, vpnId, vrfEntry, rd, null, NwConstants.DEL_FLOW, tx,
 339                             null))));
 340             //TODO: verify below adjacency call need to be optimized (?)
 341             deleteLocalAdjacency(dpnId, vpnId, vrfEntry.getDestPrefix(), vrfEntry.getDestPrefix());
 342             returnLocalDpnId.add(dpnId);
 343         }
 344         return returnLocalDpnId;
 345     }
 346 }