vpnmanager/impl/src/main/java/org/opendaylight/netvirt/vpnmanager/VpnUtil.java

   1 /*
   2  * Copyright © 2016, 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
   9 package org.opendaylight.netvirt.vpnmanager;
  10
  11 import static java.util.Collections.emptyList;
  12 import static java.util.Objects.requireNonNull;
  13 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
  14
  15 import com.google.common.base.Optional;
  16 import com.google.common.collect.Iterators;
  17 import com.google.common.net.InetAddresses;
  18 import com.google.common.util.concurrent.FutureCallback;
  19 import com.google.common.util.concurrent.ListenableFuture;
  20 import java.math.BigInteger;
  21 import java.net.Inet4Address;
  22 import java.net.Inet6Address;
  23 import java.net.InetAddress;
  24 import java.net.UnknownHostException;
  25 import java.text.SimpleDateFormat;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.Collections;
  29 import java.util.Date;
  30 import java.util.HashMap;
  31 import java.util.HashSet;
  32 import java.util.List;
  33 import java.util.Locale;
  34 import java.util.Map;
  35 import java.util.Map.Entry;
  36 import java.util.Objects;
  37 import java.util.Set;
  38 import java.util.concurrent.ExecutionException;
  39 import java.util.concurrent.Future;
  40 import java.util.function.Predicate;
  41 import java.util.stream.Collectors;
  42 import javax.annotation.Nonnull;
  43 import javax.annotation.Nullable;
  44 import javax.inject.Singleton;
  45 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  46 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  47 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  48 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  49 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  50 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  51 import org.opendaylight.genius.infra.Datastore;
  52 import org.opendaylight.genius.infra.Datastore.Configuration;
  53 import org.opendaylight.genius.infra.Datastore.Operational;
  54 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  55 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  56 import org.opendaylight.genius.infra.TypedReadTransaction;
  57 import org.opendaylight.genius.infra.TypedReadWriteTransaction;
  58 import org.opendaylight.genius.infra.TypedWriteTransaction;
  59 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  60 import org.opendaylight.genius.mdsalutil.FlowEntity;
  61 import org.opendaylight.genius.mdsalutil.FlowEntityBuilder;
  62 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  63 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  64 import org.opendaylight.genius.mdsalutil.MatchInfo;
  65 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  66 import org.opendaylight.genius.mdsalutil.NWUtil;
  67 import org.opendaylight.genius.mdsalutil.NwConstants;
  68 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
  69 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
  70 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
  71 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  72 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
  73 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetType;
  74 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
  75 import org.opendaylight.genius.utils.ServiceIndex;
  76 import org.opendaylight.genius.utils.SystemPropertyReader;
  77 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  78 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
  79 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
  80 import org.opendaylight.netvirt.elanmanager.api.ElanHelper;
  81 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
  82 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
  83 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
  84 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
  85 import org.opendaylight.netvirt.vpnmanager.api.InterfaceUtils;
  86 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
  87 import org.opendaylight.netvirt.vpnmanager.api.VpnHelper;
  88 import org.opendaylight.netvirt.vpnmanager.iplearn.model.MacEntry;
  89 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
  90 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  91 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  92 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  93 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  94 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  95 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
  96 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  97 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.vpn._interface.VpnInstanceNames;
  98 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  99 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
 100 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
 101 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
 102 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
 103 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
 104 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
 105 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.IfIndexesInterfaceMap;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInput;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInputBuilder;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexOutput;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.Ipv6NdUtilService;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupInput;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupInputBuilder;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupOutput;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.LockManagerService;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TimeUnits;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInput;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockOutput;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInput;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInputBuilder;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockOutput;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanTagNameMap;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
 142 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesBuilder;
 143 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
 144 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
 145 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
 146 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
 147 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
 148 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
 149 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
 150 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
 151 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsBuilder;
 152 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsKey;
 153 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
 154 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
 155 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
 156 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
 157 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentrybase.RoutePaths;
 158 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
 159 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
 160 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
 161 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.Adjacencies;
 162 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesBuilder;
 163 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOp;
 164 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOpBuilder;
 165 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
 166 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventAction;
 167 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventData;
 168 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.PrefixToInterface;
 169 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetOpData;
 170 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetsAssociatedToRouteTargets;
 171 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnIdToVpnInstance;
 172 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
 173 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInterfaceOpData;
 174 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnToExtraroutes;
 175 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency;
 176 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.AdjacencyKey;
 177 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
 178 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortBuilder;
 179 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
 180 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEvent;
 181 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventBuilder;
 182 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventKey;
 183 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
 184 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
 185 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
 186 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
 187 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
 188 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntry;
 189 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntryKey;
 190 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.RouteTarget;
 191 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.RouteTargetKey;
 192 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.AssociatedSubnet;
 193 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.AssociatedSubnetKey;
 194 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpn;
 195 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpnBuilder;
 196 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpnKey;
 197 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntry;
 198 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryBuilder;
 199 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryKey;
 200 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 201 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
 202 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
 203 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnTargets;
 204 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
 205 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget;
 206 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder;
 207 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
 208 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnKey;
 209 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
 210 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder;
 211 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
 212 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalNetworks;
 213 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
 214 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.NaptSwitches;
 215 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
 216 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
 217 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIps;
 218 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.Networks;
 219 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.NetworksKey;
 220 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
 221 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitch;
 222 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitchKey;
 223 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkAttributes.NetworkType;
 224 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
 225 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
 226 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 227 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
 228 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
 229 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
 230 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
 231 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 232 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
 233 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
 234 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
 235 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
 236 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
 237 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 238 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
 239 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 240 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 241 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 242 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 243 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 244 import org.opendaylight.yangtools.yang.binding.DataObject;
 245 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 246 import org.opendaylight.yangtools.yang.common.RpcResult;
 247 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
 248 import org.slf4j.Logger;
 249 import org.slf4j.LoggerFactory;
 250
 251 @Singleton
 252 public final class VpnUtil {
 253
 254     private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
 255
 256     public static final int SINGLE_TRANSACTION_BROKER_NO_RETRY = 1;
 257
 258     private final DataBroker dataBroker;
 259     private final IdManagerService idManager;
 260     private final IFibManager fibManager;
 261     private final IBgpManager bgpManager;
 262     private final LockManagerService lockManager;
 263     private final INeutronVpnManager neutronVpnService;
 264     private final IMdsalApiManager mdsalManager;
 265     private final IInterfaceManager interfaceManager;
 266     private final JobCoordinator jobCoordinator;
 267     private final ManagedNewTransactionRunner txRunner;
 268     private final OdlInterfaceRpcService ifmRpcService;
 269
 270     /**
 271      * Class to generate timestamps with microsecond precision.
 272      * For example: MicroTimestamp.INSTANCE.get() = "2012-10-21 19:13:45.267128"
 273      */
 274     public enum MicroTimestamp {
 275         INSTANCE ;
 276
 277         private long              startDate ;
 278         private long              startNanoseconds ;
 279         private SimpleDateFormat  dateFormat ;
 280
 281         MicroTimestamp() {
 282             this.startDate = System.currentTimeMillis() ;
 283             this.startNanoseconds = System.nanoTime() ;
 284             this.dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS") ;
 285         }
 286
 287         public String get() {
 288             long microSeconds = (System.nanoTime() - this.startNanoseconds) / 1000 ;
 289             long date = this.startDate + microSeconds / 1000 ;
 290             return this.dateFormat.format(date) + String.format("%03d", microSeconds % 1000) ;
 291         }
 292     }
 293
 294     public VpnUtil(DataBroker dataBroker, IdManagerService idManager, IFibManager fibManager,
 295                    IBgpManager bgpManager, LockManagerService lockManager, INeutronVpnManager neutronVpnService,
 296                    IMdsalApiManager mdsalManager, JobCoordinator jobCoordinator, IInterfaceManager interfaceManager,
 297                    OdlInterfaceRpcService ifmRpcService) {
 298         this.dataBroker = dataBroker;
 299         this.idManager = idManager;
 300         this.fibManager = fibManager;
 301         this.bgpManager = bgpManager;
 302         this.lockManager = lockManager;
 303         this.neutronVpnService = neutronVpnService;
 304         this.mdsalManager = mdsalManager;
 305         this.interfaceManager = interfaceManager;
 306         this.jobCoordinator = jobCoordinator;
 307         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
 308         this.ifmRpcService = ifmRpcService;
 309     }
 310
 311     public static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
 312         return InstanceIdentifier.builder(VpnInterfaces.class)
 313                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
 314     }
 315
 316     static InstanceIdentifier<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntryIdentifier(String vpnInterfaceName,
 317                                                                                      String vpnName) {
 318         return InstanceIdentifier.builder(VpnInterfaceOpData.class).child(VpnInterfaceOpDataEntry.class,
 319             new VpnInterfaceOpDataEntryKey(vpnInterfaceName, vpnName)).build();
 320     }
 321
 322     static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
 323         return InstanceIdentifier.builder(VpnInstances.class)
 324                 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 325     }
 326
 327     @Nullable
 328     VpnInterface getVpnInterface(String vpnInterfaceName) {
 329         InstanceIdentifier<VpnInterface> id = getVpnInterfaceIdentifier(vpnInterfaceName);
 330         Optional<VpnInterface> vpnInterface = read(LogicalDatastoreType.CONFIGURATION, id);
 331         return vpnInterface.isPresent() ? vpnInterface.get() : null;
 332     }
 333
 334     static VpnInterfaceOpDataEntry getVpnInterfaceOpDataEntry(String intfName, String vpnName, AdjacenciesOp aug,
 335                                                        BigInteger dpnId, long lportTag,
 336                                                        String gwMac) {
 337         return new VpnInterfaceOpDataEntryBuilder().withKey(new VpnInterfaceOpDataEntryKey(intfName, vpnName))
 338             .setDpnId(dpnId).addAugmentation(AdjacenciesOp.class, aug)
 339                 .setLportTag(lportTag).setGatewayMacAddress(gwMac).build();
 340     }
 341
 342     Optional<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntry(String vpnInterfaceName, String vpnName) {
 343         InstanceIdentifier<VpnInterfaceOpDataEntry> id = getVpnInterfaceOpDataEntryIdentifier(vpnInterfaceName,
 344                                                                                               vpnName);
 345         Optional<VpnInterfaceOpDataEntry> vpnInterfaceOpDataEntry = read(LogicalDatastoreType.OPERATIONAL,
 346                 id);
 347         return vpnInterfaceOpDataEntry;
 348     }
 349
 350     static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
 351         return InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId))
 352                 .child(Prefixes.class, new PrefixesKey(ipPrefix)).build();
 353     }
 354
 355     static InstanceIdentifier<VpnIds> getPrefixToInterfaceIdentifier(long vpnId) {
 356         return InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build();
 357     }
 358
 359     static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix,
 360             Uuid networkId, NetworkType networkType, Long segmentationId, Prefixes.PrefixCue prefixCue) {
 361         return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
 362             vpnInterfaceName).setIpAddress(ipPrefix)//.setSubnetId(subnetId)
 363                 .setNetworkId(networkId).setNetworkType(networkType).setSegmentationId(segmentationId)
 364                 .setPrefixCue(prefixCue).build();
 365     }
 366
 367     static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix,
 368             Prefixes.PrefixCue prefixCue) {
 369         return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(vpnInterfaceName).setIpAddress(ipPrefix)
 370                 .setPrefixCue(prefixCue).build();
 371     }
 372
 373     Optional<Prefixes> getPrefixToInterface(long vpnId, String ipPrefix) {
 374         return read(LogicalDatastoreType.OPERATIONAL, getPrefixToInterfaceIdentifier(vpnId, getIpPrefix(ipPrefix)));
 375     }
 376
 377     /**
 378      * Get VRF table given a Route Distinguisher.
 379      *
 380      * @param rd Route-Distinguisher
 381      * @return VrfTables that holds the list of VrfEntries of the specified rd
 382      */
 383     @Nullable
 384     VrfTables getVrfTable(String rd) {
 385         InstanceIdentifier<VrfTables> id = InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
 386                 new VrfTablesKey(rd)).build();
 387         Optional<VrfTables> vrfTable = read(LogicalDatastoreType.CONFIGURATION, id);
 388         return vrfTable.isPresent() ? vrfTable.get() : null;
 389     }
 390
 391     /**
 392      * Retrieves the VrfEntries that belong to a given VPN filtered out by
 393      * Origin, searching by its Route-Distinguisher.
 394      *
 395      * @param rd Route-distinguisher of the VPN
 396      * @param originsToConsider Only entries whose origin is included in this list will be considered
 397      * @return the list of VrfEntries
 398      */
 399     public List<VrfEntry> getVrfEntriesByOrigin(String rd, List<RouteOrigin> originsToConsider) {
 400         List<VrfEntry> result = new ArrayList<>();
 401         List<VrfEntry> allVpnVrfEntries = getAllVrfEntries(rd);
 402         for (VrfEntry vrfEntry : allVpnVrfEntries) {
 403             if (originsToConsider.contains(RouteOrigin.value(vrfEntry.getOrigin()))) {
 404                 result.add(vrfEntry);
 405             }
 406         }
 407         return result;
 408     }
 409
 410     /**
 411      * Retrieves all the VrfEntries that belong to a given VPN searching by its
 412      * Route-Distinguisher.
 413      *
 414      * @param rd Route-distinguisher of the VPN
 415      * @return the list of VrfEntries
 416      */
 417     public List<VrfEntry> getAllVrfEntries(String rd) {
 418         VrfTables vrfTables = getVrfTable(rd);
 419         if (vrfTables != null && vrfTables.getVrfEntry() != null) {
 420             return vrfTables.getVrfEntry();
 421         }
 422         return emptyList();
 423     }
 424
 425     //FIXME: Implement caches for DS reads
 426     @Nullable
 427     public VpnInstance getVpnInstance(String vpnInstanceName) {
 428         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
 429             new VpnInstanceKey(vpnInstanceName)).build();
 430         Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
 431         return vpnInstance.isPresent() ? vpnInstance.get() : null;
 432     }
 433
 434     @Nonnull
 435     List<VpnInstanceOpDataEntry> getAllVpnInstanceOpData() {
 436         InstanceIdentifier<VpnInstanceOpData> id = InstanceIdentifier.builder(VpnInstanceOpData.class).build();
 437         Optional<VpnInstanceOpData> vpnInstanceOpDataOptional = read(LogicalDatastoreType.OPERATIONAL, id);
 438         return
 439             vpnInstanceOpDataOptional.isPresent() && vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry() != null
 440                 ? vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry()
 441                 : emptyList();
 442     }
 443
 444     @Nonnull
 445     List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data
 446             .vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces> getDpnVpnInterfaces(VpnInstance vpnInstance,
 447                                                                                            BigInteger dpnId) {
 448         String primaryRd = getPrimaryRd(vpnInstance);
 449         InstanceIdentifier<VpnToDpnList> dpnToVpnId = VpnHelper.getVpnToDpnListIdentifier(primaryRd, dpnId);
 450         Optional<VpnToDpnList> dpnInVpn = read(LogicalDatastoreType.OPERATIONAL, dpnToVpnId);
 451         return dpnInVpn.isPresent() && dpnInVpn.get().getVpnInterfaces() != null ? dpnInVpn.get().getVpnInterfaces()
 452             : emptyList();
 453     }
 454
 455     @Nonnull
 456     static List<String> getListOfRdsFromVpnInstance(VpnInstance vpnInstance) {
 457         VpnAfConfig vpnConfig = vpnInstance.getIpv4Family();
 458         LOG.trace("vpnConfig {}", vpnConfig);
 459         return vpnConfig.getRouteDistinguisher() != null && vpnConfig.getRouteDistinguisher() != null
 460             ? vpnConfig.getRouteDistinguisher() : emptyList();
 461     }
 462
 463     @Nullable
 464     VrfEntry getVrfEntry(String rd, String ipPrefix) {
 465         VrfTables vrfTable = getVrfTable(rd);
 466         // TODO: why check VrfTables if we later go for the specific VrfEntry?
 467         if (vrfTable != null) {
 468             InstanceIdentifier<VrfEntry> vrfEntryId =
 469                 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).child(
 470                     VrfEntry.class, new VrfEntryKey(ipPrefix)).build();
 471             Optional<VrfEntry> vrfEntry = read(LogicalDatastoreType.CONFIGURATION, vrfEntryId);
 472             if (vrfEntry.isPresent()) {
 473                 return vrfEntry.get();
 474             }
 475         }
 476         return null;
 477     }
 478
 479     @Nullable
 480     public List<Adjacency> getAdjacenciesForVpnInterfaceFromConfig(String intfName) {
 481         final InstanceIdentifier<VpnInterface> identifier = getVpnInterfaceIdentifier(intfName);
 482         InstanceIdentifier<Adjacencies> path = identifier.augmentation(Adjacencies.class);
 483         Optional<Adjacencies> adjacencies = read(LogicalDatastoreType.CONFIGURATION, path);
 484         if (adjacencies.isPresent()) {
 485             return adjacencies.get().getAdjacency();
 486         }
 487         return null;
 488     }
 489
 490     static Routes getVpnToExtraroute(String ipPrefix, List<String> nextHopList) {
 491         return new RoutesBuilder().setPrefix(ipPrefix).setNexthopIpList(nextHopList).build();
 492     }
 493
 494     @Nullable
 495     String getVpnInterfaceName(BigInteger metadata) throws InterruptedException, ExecutionException {
 496         GetInterfaceFromIfIndexInputBuilder ifIndexInputBuilder = new GetInterfaceFromIfIndexInputBuilder();
 497         BigInteger lportTag = MetaDataUtil.getLportFromMetadata(metadata);
 498         ifIndexInputBuilder.setIfIndex(lportTag.intValue());
 499         GetInterfaceFromIfIndexInput input = ifIndexInputBuilder.build();
 500         Future<RpcResult<GetInterfaceFromIfIndexOutput>> interfaceFromIfIndex =
 501                 ifmRpcService.getInterfaceFromIfIndex(input);
 502         GetInterfaceFromIfIndexOutput interfaceFromIfIndexOutput;
 503         RpcResult<GetInterfaceFromIfIndexOutput> rpcResult = interfaceFromIfIndex.get();
 504         if (rpcResult == null) {
 505             return null;
 506         }
 507         interfaceFromIfIndexOutput = rpcResult.getResult();
 508         return interfaceFromIfIndexOutput.getInterfaceName();
 509     }
 510
 511     static AllocatedRdsBuilder getRdsBuilder(String nexthop, String rd) {
 512         return new AllocatedRdsBuilder().withKey(new AllocatedRdsKey(nexthop)).setNexthop(nexthop).setRd(rd);
 513     }
 514
 515     public static Adjacencies getVpnInterfaceAugmentation(List<Adjacency> nextHopList) {
 516         return new AdjacenciesBuilder().setAdjacency(nextHopList).build();
 517     }
 518
 519     static AdjacenciesOp getVpnInterfaceOpDataEntryAugmentation(List<Adjacency> nextHopList) {
 520         return new AdjacenciesOpBuilder().setAdjacency(nextHopList).build();
 521     }
 522
 523     static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
 524         return InstanceIdentifier.builder(Interfaces.class).child(Interface.class,
 525                 new InterfaceKey(interfaceName)).build();
 526     }
 527
 528     public static BigInteger getCookieL3(int vpnId) {
 529         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0610000", 16)).add(BigInteger.valueOf(vpnId));
 530     }
 531
 532     public int getUniqueId(String poolName, String idKey) {
 533         AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 534         try {
 535             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 536             RpcResult<AllocateIdOutput> rpcResult = result.get();
 537             if (rpcResult.isSuccessful()) {
 538                 return rpcResult.getResult().getIdValue().intValue();
 539             } else {
 540                 LOG.error("getUniqueId: RPC Call to Get Unique Id from pool {} with key {} returned with Errors {}",
 541                         poolName, idKey, rpcResult.getErrors());
 542             }
 543         } catch (InterruptedException | ExecutionException e) {
 544             LOG.error("getUniqueId: Exception when getting Unique Id from pool {} for key {}", poolName, idKey, e);
 545         }
 546         return 0;
 547     }
 548
 549     void releaseId(String poolName, String idKey) {
 550         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 551         try {
 552             RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
 553             if (!rpcResult.isSuccessful()) {
 554                 LOG.error("releaseId: RPC Call to release Id for key {} from pool {} returned with Errors {}",
 555                         idKey, poolName, rpcResult.getErrors());
 556             }
 557         } catch (InterruptedException | ExecutionException e) {
 558             LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
 559         }
 560     }
 561
 562     public static String getNextHopLabelKey(String rd, String prefix) {
 563         return rd + VpnConstants.SEPARATOR + prefix;
 564     }
 565
 566     /**
 567      * Retrieves the dataplane identifier of a specific VPN, searching by its
 568      * VpnInstance name.
 569      *
 570      * @param vpnName Name of the VPN
 571      * @return the dataplane identifier of the VPN, the VrfTag.
 572      */
 573     public long getVpnId(String vpnName) {
 574         if (vpnName == null) {
 575             return VpnConstants.INVALID_ID;
 576         }
 577
 578         return read(LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName))
 579                 .toJavaUtil().map(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
 580                         .vpn.instance.to.vpn.id.VpnInstance::getVpnId).orElse(VpnConstants.INVALID_ID);
 581     }
 582
 583     /**
 584      * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
 585      *
 586      * @param vpnName Name of the VPN
 587      * @return the route-distinguisher of the VPN
 588      */
 589     public String getVpnRd(String vpnName) {
 590         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 591             .VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION,
 592                 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 593         String rd = null;
 594         if (vpnInstance.isPresent()) {
 595             rd = vpnInstance.get().getVrfId();
 596         }
 597         return rd;
 598     }
 599
 600     public static String getVpnRd(TypedReadTransaction<Configuration> confTx, String vpnName) {
 601         try {
 602             return confTx.read(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName)).get().toJavaUtil().map(
 603                 vpnInstance -> vpnInstance.getVrfId()).orElse(null);
 604         } catch (InterruptedException | ExecutionException e) {
 605             throw new RuntimeException(e);
 606         }
 607     }
 608
 609     List<String> getVpnRdsFromVpnInstanceConfig(String vpnName) {
 610         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
 611             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 612         Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
 613         return vpnInstance.isPresent() ? getListOfRdsFromVpnInstance(vpnInstance.get()) : new ArrayList<>();
 614     }
 615
 616     /**
 617      * Remove from MDSAL all those VrfEntries in a VPN that have an specific RouteOrigin.
 618      *
 619      * @param rd Route Distinguisher
 620      * @param origin Origin of the Routes to be removed (see {@link RouteOrigin})
 621      */
 622     public void removeVrfEntriesByOrigin(String rd, RouteOrigin origin) {
 623         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 624             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 625         Optional<VrfTables> vrfTablesOpc = read(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 626         if (vrfTablesOpc.isPresent()) {
 627             VrfTables vrfTables = vrfTablesOpc.get();
 628             ListenableFutures.addErrorLogging(
 629                     new ManagedNewTransactionRunnerImpl(dataBroker).callWithNewWriteOnlyTransactionAndSubmit(
 630                                                                             Datastore.CONFIGURATION, tx -> {
 631                             for (VrfEntry vrfEntry : requireNonNullElse(vrfTables.getVrfEntry(),
 632                                     Collections.<VrfEntry>emptyList())) {
 633                                 if (origin == RouteOrigin.value(vrfEntry.getOrigin())) {
 634                                     tx.delete(vpnVrfTableIid.child(VrfEntry.class, vrfEntry.key()));
 635                                 }
 636                             }
 637                         }), LOG, "Error removing VRF entries by origin");
 638         }
 639     }
 640
 641     public List<VrfEntry> findVrfEntriesByNexthop(String rd, String nexthop) {
 642         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 643             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 644         Optional<VrfTables> vrfTablesOpc = read(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 645         List<VrfEntry> matches = new ArrayList<>();
 646         if (vrfTablesOpc.isPresent()) {
 647             VrfTables vrfTables = vrfTablesOpc.get();
 648             for (VrfEntry vrfEntry : requireNonNullElse(vrfTables.getVrfEntry(), Collections.<VrfEntry>emptyList())) {
 649                 requireNonNullElse(vrfEntry.getRoutePaths(), Collections.<RoutePaths>emptyList()).stream()
 650                         .filter(routePath -> routePath.getNexthopAddress() != null && routePath.getNexthopAddress()
 651                                 .equals(nexthop)).findFirst().ifPresent(routePath -> matches.add(vrfEntry));
 652             }
 653         }
 654         return matches;
 655     }
 656
 657     public void removeVrfEntries(String rd, List<VrfEntry> vrfEntries) {
 658         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 659             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 660         ListenableFutures.addErrorLogging(
 661                 new ManagedNewTransactionRunnerImpl(dataBroker).callWithNewWriteOnlyTransactionAndSubmit(
 662                                                                             Datastore.CONFIGURATION, tx -> {
 663                         for (VrfEntry vrfEntry : vrfEntries) {
 664                             tx.delete(vpnVrfTableIid.child(VrfEntry.class, vrfEntry.key()));
 665                         }
 666                     }), LOG, "Error removing VRF entries");
 667     }
 668
 669     // TODO Clean up the exception handling
 670     @SuppressWarnings("checkstyle:IllegalCatch")
 671     public void withdrawRoutes(String rd, List<VrfEntry> vrfEntries) {
 672         vrfEntries.forEach(vrfEntry -> {
 673             try {
 674                 bgpManager.withdrawPrefix(rd, vrfEntry.getDestPrefix());
 675             } catch (Exception e) {
 676                 LOG.error("withdrawRoutes: Could not withdraw route to {} with route-paths {} in VpnRd {}",
 677                           vrfEntry.getDestPrefix(), vrfEntry.getRoutePaths(), rd);
 678             }
 679         });
 680     }
 681
 682     public boolean removeOrUpdateDSForExtraRoute(String vpnName, String primaryRd, String extraRouteRd,
 683                                                  String vpnInterfaceName, String prefix, String nextHop,
 684                                                  String nextHopTunnelIp, TypedWriteTransaction<Operational> operTx) {
 685         LOG.info("removeOrUpdateDSForExtraRoute: VPN WITHDRAW: Removing Fib Entry rd {} prefix {} nexthop {}",
 686                 extraRouteRd, prefix, nextHop);
 687         boolean areNextHopsClearedForRd = false;
 688         Optional<Routes> optVpnExtraRoutes = VpnExtraRouteHelper
 689                 .getVpnExtraroutes(dataBroker, vpnName, extraRouteRd, prefix);
 690         if (optVpnExtraRoutes.isPresent()) {
 691             List<String> nhList = optVpnExtraRoutes.get().getNexthopIpList();
 692             if (nhList != null && nhList.size() > 1) {
 693                 // If nhList is more than 1, just update vpntoextraroute and prefixtointerface DS
 694                 // For other cases, remove the corresponding tep ip from fibentry and withdraw prefix
 695                 nhList.remove(nextHop);
 696                 syncWrite(LogicalDatastoreType.OPERATIONAL,
 697                         VpnExtraRouteHelper.getVpnToExtrarouteVrfIdIdentifier(vpnName, extraRouteRd, prefix),
 698                         VpnUtil.getVpnToExtraroute(prefix, nhList));
 699                 MDSALUtil.syncDelete(dataBroker,
 700                         LogicalDatastoreType.CONFIGURATION, VpnExtraRouteHelper.getUsedRdsIdentifier(getVpnId(vpnName),
 701                                 prefix, nextHop));
 702                 LOG.debug("removeOrUpdateDSForExtraRoute: Removed vpn-to-extraroute with rd {} prefix {} nexthop {}",
 703                         extraRouteRd, prefix, nextHop);
 704                 fibManager.refreshVrfEntry(primaryRd, prefix);
 705                 operTx.delete(VpnUtil.getVpnInterfaceOpDataEntryAdjacencyIdentifier(vpnInterfaceName, vpnName, prefix));
 706                 LOG.info("VPN WITHDRAW: removeOrUpdateDSForExtraRoute: Removed Fib Entry rd {} prefix {} nexthop {}",
 707                         extraRouteRd, prefix, nextHopTunnelIp);
 708                 areNextHopsClearedForRd = true;
 709             }
 710         }
 711         return areNextHopsClearedForRd;
 712     }
 713
 714     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
 715         getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
 716         return new VpnInstanceBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
 717
 718     }
 719
 720     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
 721         getVpnIdToVpnInstance(long vpnId, String vpnName, String rd, boolean isExternalVpn) {
 722         return new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 723             .VpnIdsBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).setExternalVpn(isExternalVpn)
 724                 .build();
 725
 726     }
 727
 728     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to
 729         .vpn.instance.VpnIds> getVpnIdToVpnInstanceIdentifier(long vpnId) {
 730         return InstanceIdentifier.builder(VpnIdToVpnInstance.class).child(org.opendaylight.yang.gen.v1.urn
 731                 .opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds.class,
 732                 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 733                     .VpnIdsKey(vpnId)).build();
 734     }
 735
 736     /**
 737      * Retrieves the Vpn Name searching by its VPN Tag.
 738      *
 739      * @param vpnId Dataplane identifier of the VPN
 740      * @return the Vpn instance name
 741      */
 742     @Nullable
 743     String getVpnName(long vpnId) {
 744
 745         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
 746             .instance.VpnIds> id = getVpnIdToVpnInstanceIdentifier(vpnId);
 747         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
 748             vpnInstance
 749             = read(LogicalDatastoreType.CONFIGURATION, id);
 750         String vpnName = null;
 751         if (vpnInstance.isPresent()) {
 752             vpnName = vpnInstance.get().getVpnInstanceName();
 753         }
 754         return vpnName;
 755     }
 756
 757     public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
 758         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 759             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
 760     }
 761
 762     @Nullable
 763     public VpnInstanceOpDataEntry getVpnInstanceOpData(String rd) {
 764         return read(LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(rd)).orNull();
 765     }
 766
 767     @Nullable
 768     VpnInterface getConfiguredVpnInterface(String interfaceName) {
 769         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 770         Optional<VpnInterface> configuredVpnInterface = read(LogicalDatastoreType.CONFIGURATION, interfaceId);
 771         if (configuredVpnInterface.isPresent()) {
 772             return configuredVpnInterface.get();
 773         }
 774         return null;
 775     }
 776
 777     boolean isVpnInterfaceConfigured(String interfaceName) {
 778         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 779         return read(LogicalDatastoreType.CONFIGURATION, interfaceId).isPresent();
 780     }
 781
 782     public Optional<List<String>> getVpnHandlingIpv4AssociatedWithInterface(String interfaceName) {
 783         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 784         Optional<List<String>> vpnOptional = Optional.absent();
 785         Optional<VpnInterface> optConfiguredVpnInterface = read(LogicalDatastoreType.CONFIGURATION, interfaceId);
 786         if (optConfiguredVpnInterface.isPresent()) {
 787             VpnInterface cfgVpnInterface = optConfiguredVpnInterface.get();
 788             java.util.Optional<List<VpnInstanceNames>> optVpnInstanceList =
 789                  java.util.Optional.ofNullable(cfgVpnInterface.getVpnInstanceNames());
 790             if (optVpnInstanceList.isPresent()) {
 791                 List<String> vpnList = new ArrayList<>();
 792                 for (VpnInstanceNames vpnInstance : optVpnInstanceList.get()) {
 793                     vpnList.add(vpnInstance.getVpnName());
 794                 }
 795                 vpnOptional = Optional.of(vpnList);
 796             }
 797         }
 798         return vpnOptional;
 799     }
 800
 801     public static String getIpPrefix(String prefix) {
 802         String[] prefixValues = prefix.split("/");
 803         if (prefixValues.length == 1) {
 804             prefix = NWUtil.toIpPrefix(prefix);
 805         }
 806         return prefix;
 807     }
 808
 809     static final FutureCallback<Void> DEFAULT_CALLBACK =
 810         new FutureCallback<Void>() {
 811             @Override
 812             public void onSuccess(Void result) {
 813                 LOG.debug("Success in Datastore operation");
 814             }
 815
 816             @Override
 817             public void onFailure(Throwable error) {
 818                 LOG.error("Error in Datastore operation", error);
 819             }
 820
 821         };
 822
 823     @Deprecated
 824     private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
 825         try {
 826             return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
 827         } catch (ReadFailedException e) {
 828             throw new RuntimeException(e);
 829         }
 830     }
 831
 832     @Deprecated
 833     public <T extends DataObject> void syncWrite(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
 834                                                  T data) {
 835         try {
 836             SingleTransactionDataBroker.syncWrite(dataBroker, datastoreType, path, data);
 837         } catch (TransactionCommitFailedException e) {
 838             LOG.error("syncWrite: Error writing to datastore (path, data) : ({}, {})", path, data, e);
 839             throw new RuntimeException(e.getMessage(), e);
 840         }
 841     }
 842
 843     @Deprecated
 844     public <T extends DataObject> void syncUpdate(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
 845                                                   T data) {
 846         try {
 847             SingleTransactionDataBroker.syncUpdate(dataBroker, datastoreType, path, data);
 848         } catch (TransactionCommitFailedException e) {
 849             LOG.error("syncUpdate: Error writing to datastore (path, data) : ({}, {})", path, data, e);
 850             throw new RuntimeException(e.getMessage(), e);
 851         }
 852     }
 853
 854     static long getRemoteBCGroup(long elanTag) {
 855         return VpnConstants.ELAN_GID_MIN + elanTag % VpnConstants.ELAN_GID_MIN * 2;
 856     }
 857
 858     // interface-index-tag operational container
 859     @Nullable
 860     IfIndexInterface getInterfaceInfoByInterfaceTag(long interfaceTag) {
 861         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
 862         Optional<IfIndexInterface> existingInterfaceInfo = read(LogicalDatastoreType.OPERATIONAL, interfaceId);
 863         if (existingInterfaceInfo.isPresent()) {
 864             return existingInterfaceInfo.get();
 865         }
 866         return null;
 867     }
 868
 869     static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
 870         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
 871             new IfIndexInterfaceKey((int) interfaceTag)).build();
 872     }
 873
 874     @Nullable
 875     ElanTagName getElanInfoByElanTag(long elanTag) {
 876         InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
 877         Optional<ElanTagName> existingElanInfo = read(LogicalDatastoreType.OPERATIONAL, elanId);
 878         if (existingElanInfo.isPresent()) {
 879             return existingElanInfo.get();
 880         }
 881         return null;
 882     }
 883
 884     static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
 885         return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
 886             new ElanTagNameKey(elanTag)).build();
 887     }
 888
 889     static void removePrefixToInterfaceForVpnId(long vpnId, @Nonnull TypedWriteTransaction<Operational> operTx) {
 890         // Clean up PrefixToInterface Operational DS
 891         operTx.delete(InstanceIdentifier.builder(
 892                     PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build());
 893     }
 894
 895     static void removeVpnExtraRouteForVpn(String vpnName, @Nonnull TypedWriteTransaction<Operational> operTx) {
 896         // Clean up VPNExtraRoutes Operational DS
 897         operTx.delete(InstanceIdentifier.builder(VpnToExtraroutes.class).child(Vpn.class, new VpnKey(vpnName)).build());
 898     }
 899
 900     @SuppressWarnings("checkstyle:IllegalCatch")
 901     static void removeVpnOpInstance(String vpnName, @Nonnull TypedWriteTransaction<Operational> operTx) {
 902         // Clean up VPNInstanceOpDataEntry
 903         operTx.delete(getVpnInstanceOpDataIdentifier(vpnName));
 904     }
 905
 906     static void removeVpnInstanceToVpnId(String vpnName, @Nonnull TypedWriteTransaction<Configuration> confTx) {
 907         confTx.delete(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 908     }
 909
 910     static void removeVpnIdToVpnInstance(long vpnId, @Nonnull TypedWriteTransaction<Configuration> confTx) {
 911         confTx.delete(getVpnIdToVpnInstanceIdentifier(vpnId));
 912     }
 913
 914     static void removeL3nexthopForVpnId(long vpnId, @Nonnull TypedWriteTransaction<Operational> operTx) {
 915         // Clean up L3NextHop Operational DS
 916         operTx.delete(InstanceIdentifier.builder(L3nexthop.class).child(
 917                                     VpnNexthops.class, new VpnNexthopsKey(vpnId)).build());
 918     }
 919
 920     void scheduleVpnInterfaceForRemoval(String interfaceName, BigInteger dpnId, String vpnInstanceName,
 921                                         @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
 922         InstanceIdentifier<VpnInterfaceOpDataEntry> interfaceId =
 923                 getVpnInterfaceOpDataEntryIdentifier(interfaceName, vpnInstanceName);
 924         VpnInterfaceOpDataEntry interfaceToUpdate =
 925             new VpnInterfaceOpDataEntryBuilder().withKey(new VpnInterfaceOpDataEntryKey(interfaceName,
 926             vpnInstanceName)).setName(interfaceName).setDpnId(dpnId).setVpnInstanceName(vpnInstanceName)
 927             .build();
 928         if (writeOperTxn != null) {
 929             writeOperTxn.merge(interfaceId, interfaceToUpdate, true);
 930         } else {
 931             syncUpdate(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
 932         }
 933     }
 934
 935     public void createLearntVpnVipToPort(String vpnName, String fixedIp, String portName, String macAddress,
 936             TypedWriteTransaction<Operational> writeOperTxn) {
 937         synchronized ((vpnName + fixedIp).intern()) {
 938             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 939             LearntVpnVipToPortBuilder builder =
 940                     new LearntVpnVipToPortBuilder().withKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
 941                             vpnName).setPortFixedip(fixedIp).setPortName(portName)
 942                             .setMacAddress(macAddress.toLowerCase(Locale.getDefault()))
 943                             .setCreationTime(new SimpleDateFormat("MM/dd/yyyy h:mm:ss a").format(new Date()));
 944             if (writeOperTxn != null) {
 945                 writeOperTxn.put(id, builder.build(), true);
 946             } else {
 947                 syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
 948             }
 949             LOG.debug("createLearntVpnVipToPort: ARP/NA learned for fixedIp: {}, vpn {}, interface {}, mac {},"
 950                     + " added to LearntVpnVipToPort DS", fixedIp, vpnName, portName, macAddress);
 951         }
 952     }
 953
 954     static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
 955             String fixedIp) {
 956         return InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
 957                 new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
 958     }
 959
 960     void removeLearntVpnVipToPort(String vpnName, String fixedIp,
 961                                   @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
 962         synchronized ((vpnName + fixedIp).intern()) {
 963             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 964             if (writeOperTxn != null) {
 965                 writeOperTxn.delete(id);
 966             } else {
 967                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
 968             }
 969             LOG.debug("removeLearntVpnVipToPort: Deleted LearntVpnVipToPort entry for fixedIp: {}, vpn {}",
 970                 fixedIp, vpnName);
 971         }
 972     }
 973
 974     protected static void removeVpnPortFixedIpToPort(DataBroker broker, String vpnName, String fixedIp,
 975                                                      @Nullable TypedWriteTransaction<Configuration> writeConfigTxn) {
 976         synchronized ((vpnName + fixedIp).intern()) {
 977             InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 978             if (writeConfigTxn != null) {
 979                 writeConfigTxn.delete(id);
 980             } else {
 981                 MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, id);
 982             }
 983             LOG.debug("removeVpnPortFixedIpToPort: Deleted VpnPortipToPort entry for fixedIp: {}, vpn {}",
 984                 fixedIp, vpnName);
 985         }
 986     }
 987
 988     public void createLearntVpnVipToPortEvent(String vpnName, String srcIp, String destIP, String portName,
 989                                               String macAddress, LearntVpnVipToPortEventAction action,
 990                                               TypedWriteTransaction<Operational> writeOperTxn) {
 991         String eventId = MicroTimestamp.INSTANCE.get();
 992
 993         InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
 994         LearntVpnVipToPortEventBuilder builder = new LearntVpnVipToPortEventBuilder().withKey(
 995                 new LearntVpnVipToPortEventKey(eventId)).setVpnName(vpnName).setSrcFixedip(srcIp)
 996                 .setDestFixedip(destIP).setPortName(portName)
 997                 .setMacAddress(macAddress.toLowerCase(Locale.getDefault())).setEventAction(action);
 998         if (writeOperTxn != null) {
 999             writeOperTxn.delete(id);
1000         } else {
1001             syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
1002         }
1003         LOG.info("createLearntVpnVipToPortEvent: ARP learn event created for fixedIp: {}, vpn {}, interface {},"
1004                 + " mac {} action {} eventId {}", srcIp, vpnName, portName, macAddress, action, eventId);
1005     }
1006
1007     private static InstanceIdentifier<LearntVpnVipToPortEvent> buildLearntVpnVipToPortEventIdentifier(String eventId) {
1008         InstanceIdentifier<LearntVpnVipToPortEvent> id = InstanceIdentifier.builder(LearntVpnVipToPortEventData.class)
1009                 .child(LearntVpnVipToPortEvent.class, new LearntVpnVipToPortEventKey(eventId)).build();
1010         return id;
1011     }
1012
1013     public void removeLearntVpnVipToPortEvent(String eventId,
1014             @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
1015         InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
1016         if (writeOperTxn != null) {
1017             writeOperTxn.delete(id);
1018         } else {
1019             MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1020         }
1021         LOG.info("removeLearntVpnVipToPortEvent: Deleted Event {}", eventId);
1022
1023     }
1024
1025     public void removeMipAdjAndLearntIp(String vpnName, String vpnInterface, String prefix) {
1026         synchronized ((vpnName + prefix).intern()) {
1027             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, prefix);
1028             MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1029             LOG.info("removeMipAdjAndLearntIp: Delete learned ARP for fixedIp: {}, vpn {} removed from"
1030                             + "VpnPortipToPort DS", prefix, vpnName);
1031             String ip = VpnUtil.getIpPrefix(prefix);
1032             InstanceIdentifier<VpnInterfaceOpDataEntry> vpnInterfaceOpId = VpnUtil
1033                     .getVpnInterfaceOpDataEntryIdentifier(vpnInterface, vpnName);
1034             InstanceIdentifier<AdjacenciesOp> path = vpnInterfaceOpId.augmentation(AdjacenciesOp.class);
1035             Optional<AdjacenciesOp> adjacenciesOp = read(LogicalDatastoreType.OPERATIONAL, path);
1036             if (adjacenciesOp.isPresent()) {
1037                 InstanceIdentifier<Adjacency> adjacencyIdentifier = InstanceIdentifier.builder(VpnInterfaces.class)
1038                         .child(VpnInterface.class, new VpnInterfaceKey(vpnInterface)).augmentation(Adjacencies.class)
1039                         .child(Adjacency.class, new AdjacencyKey(ip)).build();
1040                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1041                 LOG.info("removeMipAdjAndLearntIp: Successfully Deleted Adjacency {} from interface {} vpn {}", ip,
1042                         vpnInterface, vpnName);
1043             }
1044         }
1045     }
1046
1047     public void removeMipAdjacency(String vpnInterface, String ipAddress) {
1048         String prefix = VpnUtil.getIpPrefix(ipAddress);
1049         InstanceIdentifier<Adjacency> adjacencyIdentifier = getAdjacencyIdentifier(vpnInterface, prefix);
1050         try {
1051             SingleTransactionDataBroker.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1052         } catch (TransactionCommitFailedException e) {
1053             if (e.getCause() instanceof ModifiedNodeDoesNotExistException) {
1054                 LOG.debug("vpnInterface {} is already deleted. prefix={}", vpnInterface, prefix);
1055             } else {
1056                 LOG.error("Failed to delete adjacency for vpnInterface {}, prefix {}", vpnInterface, prefix, e);
1057             }
1058         }
1059     }
1060
1061     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1062         return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1063                 NetworkMapKey(networkId)).build();
1064     }
1065
1066     static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1067         return InstanceIdentifier.builder(SubnetOpData.class)
1068                 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1069     }
1070
1071     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1072         return InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1073                 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1074     }
1075
1076     @Nullable
1077     public VpnPortipToPort getNeutronPortFromVpnPortFixedIp(String vpnName, String fixedIp) {
1078         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1079         Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
1080         if (vpnPortipToPortData.isPresent()) {
1081             return vpnPortipToPortData.get();
1082         }
1083         return null;
1084     }
1085
1086     @Nullable
1087     public static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(TypedReadTransaction<Configuration> confTx,
1088             String vpnName, String fixedIp) {
1089         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1090         try {
1091             return confTx.read(id).get().orNull();
1092         } catch (InterruptedException | ExecutionException e) {
1093             throw new RuntimeException(e);
1094         }
1095     }
1096
1097     @Nullable
1098     public LearntVpnVipToPort getLearntVpnVipToPort(String vpnName, String fixedIp) {
1099         InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1100         Optional<LearntVpnVipToPort> learntVpnVipToPort = read(LogicalDatastoreType.OPERATIONAL, id);
1101         if (learntVpnVipToPort.isPresent()) {
1102             return learntVpnVipToPort.get();
1103         }
1104         return null;
1105     }
1106
1107     @Nonnull
1108     List<BigInteger> getDpnsOnVpn(String vpnInstanceName) {
1109         List<BigInteger> result = new ArrayList<>();
1110         String rd = getVpnRd(vpnInstanceName);
1111         if (rd == null) {
1112             LOG.debug("getDpnsOnVpn: Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1113             return result;
1114         }
1115         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1116         if (vpnInstanceOpData == null) {
1117             LOG.debug("getDpnsOnVpn: Could not find OpState for VpnName={}", vpnInstanceName);
1118             return result;
1119         }
1120         List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1121         if (vpnToDpnList == null) {
1122             LOG.debug("getDpnsOnVpn: Could not find DPN footprint for VpnName={}", vpnInstanceName);
1123             return result;
1124         }
1125         for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1126             result.add(vpnToDpn.getDpnId());
1127         }
1128         return result;
1129     }
1130
1131     @Nullable
1132     String getAssociatedExternalRouter(String extIp) {
1133         InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1134                 InstanceIdentifier.builder(ExtRouters.class).build();
1135         Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1136         if (!extRouterData.isPresent()) {
1137             return null;
1138         }
1139
1140         // We need to find the router associated with the src ip of this packet.
1141         // This case is either SNAT, in which case the src ip is the same as the
1142         // router's external ip, or FIP in which case the src ip is in the router's
1143         // external leg's subnet. We first check the SNAT case because it is much
1144         // cheaper to do so because it does not require (potentially, there is a
1145         // cache) an datastore read of the neutron subnet for each external IP.
1146
1147         String routerName = null;
1148
1149         for (Routers routerData : requireNonNullElse(extRouterData.get().getRouters(),
1150                 Collections.<Routers>emptyList())) {
1151             List<ExternalIps> externalIps = requireNonNullElse(routerData.getExternalIps(), emptyList());
1152             for (ExternalIps externalIp : externalIps) {
1153                 if (Objects.equals(externalIp.getIpAddress(), extIp)) {
1154                     routerName = routerData.getRouterName();
1155                     break;
1156                 }
1157             }
1158         }
1159
1160         if (routerName != null) {
1161             return routerName;
1162         }
1163
1164         for (Routers routerData : requireNonNullElse(extRouterData.get().getRouters(),
1165                 Collections.<Routers>emptyList())) {
1166             List<ExternalIps> externalIps = requireNonNullElse(routerData.getExternalIps(), emptyList());
1167             for (ExternalIps externalIp : externalIps) {
1168                 Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1169                 if (neutronSubnet == null) {
1170                     LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1171                             externalIp.getSubnetId(), routerData);
1172                     continue;
1173                 }
1174                 if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp), neutronSubnet.getCidr())) {
1175                     routerName = routerData.getRouterName();
1176                     break;
1177                 }
1178             }
1179         }
1180
1181         return routerName;
1182     }
1183
1184     static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1185         return InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1186     }
1187
1188     @Nullable
1189     Networks getExternalNetwork(Uuid networkId) {
1190         InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1191             .child(Networks.class, new NetworksKey(networkId)).build();
1192         Optional<Networks> optionalNets = read(LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1193         return optionalNets.isPresent() ? optionalNets.get() : null;
1194     }
1195
1196     @Nullable
1197     Uuid getExternalNetworkVpnId(Uuid networkId) {
1198         Networks extNetwork = getExternalNetwork(networkId);
1199         return extNetwork != null ? extNetwork.getVpnid() : null;
1200     }
1201
1202     @Nonnull
1203     public List<Uuid> getExternalNetworkRouterIds(Uuid networkId) {
1204         Networks extNetwork = getExternalNetwork(networkId);
1205         return extNetwork != null && extNetwork.getRouterIds() != null ? extNetwork.getRouterIds() : emptyList();
1206     }
1207
1208     @Nullable
1209     Routers getExternalRouter(String routerId) {
1210         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1211                 new RoutersKey(routerId)).build();
1212         Optional<Routers> routerData = read(LogicalDatastoreType.CONFIGURATION, id);
1213         return routerData.isPresent() ? routerData.get() : null;
1214     }
1215
1216     @Nullable
1217     Routers getExternalRouter(TypedReadTransaction<Configuration> tx, String routerId)
1218             throws ExecutionException, InterruptedException {
1219         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1220             new RoutersKey(routerId)).build();
1221         return tx.read(id).get().orNull();
1222     }
1223
1224     static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1225         return InstanceIdentifier.create(Subnetmaps.class);
1226     }
1227
1228     FlowEntity buildL3vpnGatewayFlow(BigInteger dpId, String gwMacAddress, long vpnId,
1229                                                    long subnetVpnId) {
1230         List<MatchInfo> mkMatches = new ArrayList<>();
1231         Subnetmap smap = null;
1232         mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
1233         mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1234         List<InstructionInfo> mkInstructions = new ArrayList<>();
1235         mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1236         if (subnetVpnId != VpnConstants.INVALID_ID) {
1237             String vpnName = getVpnName(subnetVpnId);
1238             if (vpnName != null) {
1239                 smap = getSubnetmapFromItsUuid(Uuid.getDefaultInstance(vpnName));
1240                 if (smap != null && smap.getSubnetIp() != null) {
1241                     IpVersionChoice ipVersionChoice = getIpVersionFromString(smap.getSubnetIp());
1242                     if (ipVersionChoice == IpVersionChoice.IPV4) {
1243                         mkMatches.add(MatchEthernetType.IPV4);
1244                     } else {
1245                         mkMatches.add(MatchEthernetType.IPV6);
1246                     }
1247                 }
1248             }
1249             BigInteger subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId);
1250             mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1251         }
1252         String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress, subnetVpnId);
1253         return MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1254                 flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE, mkMatches, mkInstructions);
1255     }
1256
1257     static String getL3VpnGatewayFlowRef(short l3GwMacTable, BigInteger dpId, long vpnId, String gwMacAddress,
1258                                          long subnetVpnId) {
1259         return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1260             + NwConstants.FLOWID_SEPARATOR + l3GwMacTable + NwConstants.FLOWID_SEPARATOR + subnetVpnId;
1261     }
1262
1263     void lockSubnet(String subnetId) {
1264         TryLockInput input =
1265             new TryLockInputBuilder().setLockName(subnetId).setTime(3000L).setTimeUnit(TimeUnits.Milliseconds).build();
1266         Future<RpcResult<TryLockOutput>> result = lockManager.tryLock(input);
1267         try {
1268             if (result != null && result.get().isSuccessful()) {
1269                 LOG.debug("lockSubnet: Acquired lock for {}", subnetId);
1270             } else {
1271                 LOG.error("Unable to get lock for subnet {}", subnetId);
1272                 throw new RuntimeException("Unable to get lock for subnet " + subnetId);
1273             }
1274         } catch (InterruptedException | ExecutionException e) {
1275             LOG.error("Unable to get lock for subnet {}", subnetId, e);
1276             throw new RuntimeException("Unable to get lock for subnet " + subnetId, e);
1277         }
1278     }
1279
1280     // We store the cause, which is what we really care about
1281     @SuppressWarnings("checkstyle:AvoidHidingCauseException")
1282     public void unlockSubnet(String subnetId) {
1283         UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1284         Future<RpcResult<UnlockOutput>> result = lockManager.unlock(input);
1285         try {
1286             if (result != null && result.get().isSuccessful()) {
1287                 LOG.debug("unlockSubnet: Unlocked {}", subnetId);
1288             } else {
1289                 LOG.debug("unlockSubnet: Unable to unlock subnet {}", subnetId);
1290             }
1291         } catch (InterruptedException | ExecutionException e) {
1292             LOG.error("unlockSubnet: Unable to unlock subnet {}", subnetId);
1293             throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1294         }
1295     }
1296
1297     public Optional<IpAddress> getGatewayIpAddressFromInterface(MacEntry macEntry) {
1298         Optional<IpAddress> gatewayIp = Optional.absent();
1299         String srcInterface = macEntry.getInterfaceName();
1300         InetAddress hiddenIp = macEntry.getIpAddress();
1301         if (neutronVpnService != null) {
1302             //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1303             Port port = neutronVpnService.getNeutronPort(srcInterface);
1304             if (port != null && port.getFixedIps() != null) {
1305                 for (FixedIps portIp : port.getFixedIps()) {
1306                     if (doesInterfaceAndHiddenIpAddressTypeMatch(hiddenIp, portIp)) {
1307                         gatewayIp =
1308                                 Optional.of(neutronVpnService.getNeutronSubnet(portIp.getSubnetId()).getGatewayIp());
1309                         break;
1310                     }
1311                 }
1312             }
1313         } else {
1314             LOG.error("getGatewayIpAddressFromInterface: neutron vpn service is not configured."
1315                     + " Failed for interface {}.", srcInterface);
1316         }
1317         return gatewayIp;
1318     }
1319
1320     private boolean doesInterfaceAndHiddenIpAddressTypeMatch(InetAddress hiddenIp, FixedIps portIp) {
1321         return (hiddenIp instanceof Inet4Address && portIp.getIpAddress().getIpv4Address() != null)
1322                 || hiddenIp instanceof Inet6Address && portIp.getIpAddress().getIpv6Address() != null;
1323     }
1324
1325     public Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp) {
1326         Optional<String> gatewayMac = Optional.absent();
1327         long vpnId = getVpnId(macEntry.getVpnName());
1328         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1329             .instance.VpnIds>
1330             vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1331         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1332             vpnIdsOptional = read(LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1333         if (!vpnIdsOptional.isPresent()) {
1334             LOG.error("getGWMacAddressFromInterface: VPN {} not configured", vpnId);
1335             return gatewayMac;
1336         }
1337         VpnPortipToPort vpnTargetIpToPort =
1338                 getNeutronPortFromVpnPortFixedIp(macEntry.getVpnName(), gatewayIp.stringValue());
1339         if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1340             gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1341         } else {
1342             org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
1343                     .vpn.id.to.vpn.instance.VpnIds vpnIds = vpnIdsOptional.get();
1344             if (vpnIds.isExternalVpn()) {
1345                 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1346             }
1347         }
1348         return gatewayMac;
1349     }
1350
1351     void setupGwMacIfExternalVpn(BigInteger dpnId, String interfaceName, long vpnId,
1352                                  TypedReadWriteTransaction<Configuration> writeInvTxn, int addOrRemove, String gwMac)
1353             throws ExecutionException, InterruptedException {
1354         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1355             .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1356         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1357             .VpnIds> vpnIdsOptional = writeInvTxn.read(vpnIdsInstanceIdentifier).get();
1358         if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1359             if (gwMac == null) {
1360                 LOG.error("setupGwMacIfExternalVpn: Failed to get gwMacAddress for interface {} on dpn {} vpn {}",
1361                         interfaceName, dpnId.toString(), vpnIdsOptional.get().getVpnInstanceName());
1362                 return;
1363             }
1364             FlowEntity flowEntity = buildL3vpnGatewayFlow(dpnId, gwMac, vpnId, VpnConstants.INVALID_ID);
1365             if (addOrRemove == NwConstants.ADD_FLOW) {
1366                 mdsalManager.addFlow(writeInvTxn, flowEntity);
1367             } else if (addOrRemove == NwConstants.DEL_FLOW) {
1368                 mdsalManager.removeFlow(writeInvTxn, flowEntity);
1369             }
1370         }
1371     }
1372
1373     public Optional<String> getVpnSubnetGatewayIp(final Uuid subnetUuid) {
1374         Optional<String> gwIpAddress = Optional.absent();
1375         final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1376         final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1377                 .child(Subnets.class)
1378                 .child(Subnet.class, subnetkey);
1379         final Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1380         if (subnet.isPresent()) {
1381             Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1382             if (IpVersionV4.class.equals(ipVersionBase)) {
1383                 Subnetmap subnetmap = getSubnetmapFromItsUuid(subnetUuid);
1384                 if (subnetmap != null && subnetmap.getRouterInterfaceFixedIp() != null) {
1385                     LOG.trace("getVpnSubnetGatewayIp: Obtained subnetMap {} for vpn interface",
1386                             subnetmap.getId().getValue());
1387                     gwIpAddress = Optional.of(subnetmap.getRouterInterfaceFixedIp());
1388                 } else {
1389                     //For direct L3VPN to network association (no router) continue to use subnet-gateway IP
1390                     IpAddress gwIp = subnet.get().getGatewayIp();
1391                     if (gwIp != null && gwIp.getIpv4Address() != null) {
1392                         gwIpAddress = Optional.of(gwIp.getIpv4Address().getValue());
1393                     }
1394                 }
1395                 LOG.trace("getVpnSubnetGatewayIp: Obtained subnet-gw ip {} for vpn interface",
1396                         gwIpAddress.get());
1397             }
1398         }
1399         return gwIpAddress;
1400     }
1401
1402     @Nullable
1403     RouterToNaptSwitch getRouterToNaptSwitch(String routerName) {
1404         InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1405                 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1406         Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(LogicalDatastoreType.CONFIGURATION, id);
1407         return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1408     }
1409
1410     static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1411         return InstanceIdentifier.builder(Subnetmaps.class)
1412         .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1413
1414     }
1415
1416     @Nullable
1417     BigInteger getPrimarySwitchForRouter(String routerName) {
1418         RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(routerName);
1419         return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1420     }
1421
1422     static boolean isL3VpnOverVxLan(Long l3Vni) {
1423         return l3Vni != null && l3Vni != 0;
1424     }
1425
1426     /**
1427      * Retrieves the primary rd of a vpn instance
1428      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1429      * If rd list is empty, primary rd will be vpn instance name
1430      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1431      *
1432      * @param vpnName Name of the VPN
1433      * @return the primary rd of the VPN
1434      */
1435     public String getPrimaryRd(String vpnName) {
1436         // Retrieves the VPN Route Distinguisher by its Vpn instance name
1437         String rd = getVpnRd(vpnName);
1438         if (rd != null) {
1439             return rd;
1440         }
1441         InstanceIdentifier<VpnInstance> id  = getVpnInstanceIdentifier(vpnName);
1442         Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1443         if (vpnInstance.isPresent()) {
1444             return getPrimaryRd(vpnInstance.get());
1445         }
1446         return vpnName;
1447     }
1448
1449     /**
1450      * Retrieves the primary rd of a vpn instance
1451      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1452      * If rd list is empty, primary rd will be vpn instance name
1453      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1454      *
1455      * @param vpnInstance Config Vpn Instance Object
1456      * @return the primary rd of the VPN
1457      */
1458     static String getPrimaryRd(VpnInstance vpnInstance) {
1459         List<String> rds = null;
1460         if (vpnInstance != null) {
1461             rds = getListOfRdsFromVpnInstance(vpnInstance);
1462         }
1463         return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1464     }
1465
1466     static boolean isBgpVpn(String vpnName, String primaryRd) {
1467         return !vpnName.equals(primaryRd);
1468     }
1469
1470     java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(long vpnId, @Nullable Long parentVpnId,
1471                                                                           String prefix, String vpnName,
1472                                                                           String nextHop, BigInteger dpnId) {
1473         //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1474         //This is particularly useful during reboot scenarios.
1475         java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1476                 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1477         if (allocatedRd.isPresent()) {
1478             return allocatedRd;
1479         }
1480
1481         //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1482         List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1483         for (String usedRd : usedRds) {
1484             Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1485                     vpnName, usedRd, prefix);
1486             if (vpnExtraRoutes.isPresent()) {
1487                 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1488                 // In case of VPN importing the routes, the interface is not present in the VPN
1489                 // and has to be fetched from the VPN from which it imports
1490                 Optional<Prefixes> prefixToInterface =
1491                         getPrefixToInterface(parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1492                 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1493                     syncUpdate(LogicalDatastoreType.CONFIGURATION,
1494                             VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1495                             getRdsBuilder(nextHop, usedRd).build());
1496                     return java.util.Optional.of(usedRd);
1497                 }
1498             }
1499         }
1500         List<String> availableRds = getVpnRdsFromVpnInstanceConfig(vpnName);
1501         String rd;
1502         if (availableRds.isEmpty()) {
1503             rd = dpnId.toString();
1504             LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1505         } else {
1506             LOG.trace("Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {}",
1507                     usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1508             availableRds.removeAll(usedRds);
1509             if (availableRds.isEmpty()) {
1510                 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1511                 return java.util.Optional.empty();
1512             }
1513             // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1514             rd = availableRds.get(0);
1515         }
1516         syncUpdate(LogicalDatastoreType.CONFIGURATION,
1517                 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop), getRdsBuilder(nextHop, rd).build());
1518         return java.util.Optional.ofNullable(rd);
1519     }
1520
1521     static String getVpnNamePrefixKey(String vpnName, String prefix) {
1522         return vpnName + VpnConstants.SEPARATOR + prefix;
1523     }
1524
1525     static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1526         return InstanceIdentifier.builder(VpnInterfaces.class)
1527                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1528                 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1529     }
1530
1531     static InstanceIdentifier<Adjacency> getVpnInterfaceOpDataEntryAdjacencyIdentifier(String intfName, String vpnName,
1532                 String ipAddress) {
1533         return InstanceIdentifier.builder(VpnInterfaceOpData.class)
1534                 .child(VpnInterfaceOpDataEntry.class, new VpnInterfaceOpDataEntryKey(intfName, vpnName))
1535                 .augmentation(AdjacenciesOp.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1536     }
1537
1538     public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1539         if (externalIps == null) {
1540             return emptyList();
1541         }
1542
1543         return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1544     }
1545
1546     void bindService(final String vpnInstanceName, final String interfaceName, boolean isTunnelInterface) {
1547         jobCoordinator.enqueueJob(interfaceName,
1548             () -> Collections.singletonList(txRunner.callWithNewReadWriteTransactionAndSubmit(
1549                                                                                 Datastore.CONFIGURATION, tx -> {
1550                     BoundServices serviceInfo = isTunnelInterface
1551                             ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1552                             : getBoundServicesForVpnInterface(vpnInstanceName, interfaceName);
1553                     tx.put(InterfaceUtils.buildServiceId(interfaceName,
1554                             ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1555                                     NwConstants.L3VPN_SERVICE_INDEX)),
1556                             serviceInfo, WriteTransaction.CREATE_MISSING_PARENTS);
1557                 })), SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1558     }
1559
1560     BoundServices getBoundServicesForVpnInterface(String vpnName, String interfaceName) {
1561         List<Instruction> instructions = new ArrayList<>();
1562         int instructionKey = 0;
1563         final long vpnId = getVpnId(vpnName);
1564         List<Action> actions = Collections.singletonList(
1565                 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId).buildAction());
1566         instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1567         instructions.add(
1568                 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId),
1569                         MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1570         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1571                 ++instructionKey));
1572         BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1573                 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1574                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1575                 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1576         return serviceInfo;
1577     }
1578
1579     static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1580         int instructionKey = 0;
1581         List<Instruction> instructions = new ArrayList<>();
1582         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1583                 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1584         BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1585                 vpnName, interfaceName),
1586                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1587                         NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1588                 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1589         return serviceInfo;
1590     }
1591
1592     void unbindService(final String vpnInterfaceName, boolean isInterfaceStateDown) {
1593         if (!isInterfaceStateDown) {
1594             jobCoordinator.enqueueJob(vpnInterfaceName,
1595                 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1596                         Datastore.CONFIGURATION, tx ->
1597                         tx.delete(InterfaceUtils.buildServiceId(vpnInterfaceName,
1598                                         ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1599                                                 NwConstants.L3VPN_SERVICE_INDEX))))),
1600                 SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1601         }
1602     }
1603
1604     static FlowEntity buildFlowEntity(BigInteger dpnId, short tableId, String flowId) {
1605         return new FlowEntityBuilder().setDpnId(dpnId).setTableId(tableId).setFlowId(flowId).build();
1606     }
1607
1608     static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1609         return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1610     }
1611
1612     @Nullable
1613     org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets
1614         getExternalSubnet(Uuid subnetId) {
1615         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1616             .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1617                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1618                         .Subnets.class, new SubnetsKey(subnetId)).build();
1619         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1620             optionalSubnets = read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1621         return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1622     }
1623
1624     @Nullable
1625     public Uuid getSubnetFromExternalRouterByIp(Uuid routerId, String ip) {
1626         Routers externalRouter = getExternalRouter(routerId.getValue());
1627         if (externalRouter != null && externalRouter.getExternalIps() != null) {
1628             for (ExternalIps externalIp : externalRouter.getExternalIps()) {
1629                 if (Objects.equals(externalIp.getIpAddress(), ip)) {
1630                     return externalIp.getSubnetId();
1631                 }
1632             }
1633         }
1634         return null;
1635     }
1636
1637     static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1638         return vpnName.equals(subnetId);
1639     }
1640
1641     static Boolean getIsExternal(Network network) {
1642         return network.augmentation(NetworkL3Extension.class) != null
1643                 && network.augmentation(NetworkL3Extension.class).isExternal();
1644     }
1645
1646     @SuppressWarnings("checkstyle:linelength")
1647     @Nullable
1648     Network getNeutronNetwork(Uuid networkId) {
1649         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1650         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1651                 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1652                 Network.class, new NetworkKey(networkId));
1653         return read(LogicalDatastoreType.CONFIGURATION, inst).orNull();
1654     }
1655
1656     public static boolean isEligibleForBgp(@Nullable String rd, @Nullable String vpnName, @Nullable BigInteger dpnId,
1657             @Nullable String networkName) {
1658         if (rd != null) {
1659             if (rd.equals(vpnName)) {
1660                 return false;
1661             }
1662             if (dpnId != null && rd.equals(dpnId.toString())) {
1663                 return false;
1664             }
1665             if (rd.equals(networkName)) {
1666                 return false;
1667             }
1668             return true;
1669         }
1670         return false;
1671     }
1672
1673     static String getFibFlowRef(BigInteger dpnId, short tableId, String vpnName, int priority) {
1674         return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
1675                 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
1676     }
1677
1678     void removeExternalTunnelDemuxFlows(String vpnName) {
1679         LOG.info("Removing external tunnel flows for vpn {}", vpnName);
1680         for (BigInteger dpnId: NWUtil.getOperativeDPNs(dataBroker)) {
1681             LOG.debug("Removing external tunnel flows for vpn {} from dpn {}", vpnName, dpnId);
1682             String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
1683                     vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
1684             FlowEntity flowEntity = VpnUtil.buildFlowEntity(dpnId,
1685                     NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef);
1686             mdsalManager.removeFlow(flowEntity);
1687         }
1688     }
1689
1690     public boolean isVpnPendingDelete(String rd) {
1691         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1692         boolean isVpnPendingDelete = false;
1693         if (vpnInstanceOpData == null
1694                 || vpnInstanceOpData.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete) {
1695             isVpnPendingDelete = true;
1696         }
1697         return isVpnPendingDelete;
1698     }
1699
1700     public List<VpnInstanceOpDataEntry> getVpnsImportingMyRoute(final String vpnName) {
1701         List<VpnInstanceOpDataEntry> vpnsToImportRoute = new ArrayList<>();
1702         final String vpnRd = getVpnRd(vpnName);
1703         if (vpnRd == null) {
1704             LOG.error("getVpnsImportingMyRoute: vpn {} not present in config DS.", vpnName);
1705             return vpnsToImportRoute;
1706         }
1707         final VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpData(vpnRd);
1708         if (vpnInstanceOpDataEntry == null) {
1709             LOG.error("getVpnsImportingMyRoute: Could not retrieve vpn instance op data for {}"
1710                     + " to check for vpns importing the routes", vpnName);
1711             return vpnsToImportRoute;
1712         }
1713         Predicate<VpnInstanceOpDataEntry> excludeVpn = input -> {
1714             if (input.getVpnInstanceName() == null) {
1715                 LOG.error("getVpnsImportingMyRoute.excludeVpn: Received vpn instance with rd {} without a name.",
1716                         input.getVrfId());
1717                 return false;
1718             }
1719             return !input.getVpnInstanceName().equals(vpnName);
1720         };
1721         Predicate<VpnInstanceOpDataEntry> matchRTs = input -> {
1722             Iterable<String> commonRTs =
1723                 intersection(getRts(vpnInstanceOpDataEntry, VpnTarget.VrfRTType.ExportExtcommunity),
1724                     getRts(input, VpnTarget.VrfRTType.ImportExtcommunity));
1725             return Iterators.size(commonRTs.iterator()) > 0;
1726         };
1727         vpnsToImportRoute = getAllVpnInstanceOpData().stream().filter(excludeVpn).filter(matchRTs)
1728                 .collect(Collectors.toList());
1729         return vpnsToImportRoute;
1730     }
1731
1732     static List<String> getRts(VpnInstanceOpDataEntry vpnInstance, VpnTarget.VrfRTType rtType) {
1733         String name = vpnInstance.getVpnInstanceName();
1734         List<String> rts = new ArrayList<>();
1735         VpnTargets targets = vpnInstance.getVpnTargets();
1736         if (targets == null) {
1737             LOG.info("getRts: vpn targets not available for {}", name);
1738             return rts;
1739         }
1740         List<VpnTarget> vpnTargets = targets.getVpnTarget();
1741         if (vpnTargets == null) {
1742             LOG.info("getRts: vpnTarget values not available for {}", name);
1743             return rts;
1744         }
1745         for (VpnTarget target : vpnTargets) {
1746             //TODO: Check for RT type is Both
1747             if (target.getVrfRTType().equals(rtType) || target.getVrfRTType().equals(VpnTarget.VrfRTType.Both)) {
1748                 String rtValue = target.getVrfRTValue();
1749                 rts.add(rtValue);
1750             }
1751         }
1752         return rts;
1753     }
1754
1755     static <T> Iterable<T> intersection(final Collection<T> collection1, final Collection<T> collection2) {
1756         Set<T> intersection = new HashSet<>(collection1);
1757         intersection.retainAll(collection2);
1758         return intersection;
1759     }
1760
1761     /** Get Subnetmap from its Uuid.
1762      * @param subnetUuid the subnet's Uuid
1763      * @return the Subnetmap of Uuid or null if it is not found
1764      */
1765     @Nullable
1766     public Subnetmap getSubnetmapFromItsUuid(Uuid subnetUuid) {
1767         InstanceIdentifier<Subnetmap> id = buildSubnetmapIdentifier(subnetUuid);
1768         return read(LogicalDatastoreType.CONFIGURATION, id).orNull();
1769     }
1770
1771     boolean isAdjacencyEligibleToVpnInternet(Adjacency adjacency) {
1772         // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1773         boolean adjacencyEligible = false;
1774         IpVersionChoice ipVerChoice = getIpVersionFromString(adjacency.getIpAddress());
1775         if (ipVerChoice.isIpVersionChosen(IpVersionChoice.IPV6)) {
1776             Subnetmap sn = getSubnetmapFromItsUuid(adjacency.getSubnetId());
1777             if (sn != null && sn.getInternetVpnId() != null) {
1778                 adjacencyEligible = true;
1779             }
1780         }
1781         return adjacencyEligible;
1782     }
1783
1784     boolean isAdjacencyEligibleToVpn(Adjacency adjacency, String vpnName) {
1785         // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1786         boolean adjacencyEligible = true;
1787         // if BGPVPN internet, return false if subnetmap has not internetVpnId() filled in
1788         if (isBgpVpnInternet(vpnName)) {
1789             return isAdjacencyEligibleToVpnInternet(adjacency);
1790         }
1791         return adjacencyEligible;
1792     }
1793
1794     @Nullable
1795     String getInternetVpnFromVpnInstanceList(List<VpnInstanceNames> vpnInstanceList) {
1796         for (VpnInstanceNames vpnInstance : vpnInstanceList) {
1797             String vpnName = vpnInstance.getVpnName();
1798             if (isBgpVpnInternet(vpnName)) {
1799                 return vpnName;
1800             }
1801         }
1802         return null;
1803     }
1804
1805     /** Get boolean true if vpn is bgpvpn internet, false otherwise.
1806      * @param vpnName name of the input VPN
1807      * @return true or false
1808      */
1809     boolean isBgpVpnInternet(String vpnName) {
1810         String primaryRd = getVpnRd(vpnName);
1811         if (primaryRd == null) {
1812             LOG.error("isBgpVpnInternet VPN {}."
1813                       + "Primary RD not found", vpnName);
1814             return false;
1815         }
1816         InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1817               .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1818
1819         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1820         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1821             LOG.error("isBgpVpnInternet VPN {}."
1822                      + "VpnInstanceOpDataEntry not found", vpnName);
1823             return false;
1824         }
1825         LOG.debug("isBgpVpnInternet VPN {}."
1826              + "Successfully VpnInstanceOpDataEntry.getBgpvpnType {}",
1827              vpnName, vpnInstanceOpDataEntryOptional.get().getBgpvpnType());
1828         if (vpnInstanceOpDataEntryOptional.get().getBgpvpnType() == VpnInstanceOpDataEntry
1829                .BgpvpnType.BGPVPNInternet) {
1830             return true;
1831         }
1832         return false;
1833     }
1834
1835     /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1836      * @param ipAddress String of an representation IP address V4 or V6
1837      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1838      */
1839     public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1840         int indexIpAddress = ipAddress.indexOf('/');
1841         if (indexIpAddress >= 0) {
1842             ipAddress = ipAddress.substring(0, indexIpAddress);
1843         }
1844         try {
1845             InetAddress address = InetAddress.getByName(ipAddress);
1846             if (address instanceof Inet4Address) {
1847                 return IpVersionChoice.IPV4;
1848             } else if (address instanceof Inet6Address) {
1849                 return IpVersionChoice.IPV6;
1850             }
1851         } catch (UnknownHostException | SecurityException e) {
1852             return IpVersionChoice.UNDEFINED;
1853         }
1854         return IpVersionChoice.UNDEFINED;
1855     }
1856
1857     ListenableFuture<Void> unsetScheduledToRemoveForVpnInterface(String interfaceName) {
1858         VpnInterfaceBuilder builder = new VpnInterfaceBuilder().withKey(new VpnInterfaceKey(interfaceName));
1859         return txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> tx.merge(
1860                 VpnUtil.getVpnInterfaceIdentifier(interfaceName), builder.build(),
1861                 WriteTransaction.CREATE_MISSING_PARENTS));
1862     }
1863
1864     /**
1865      * Adds router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1866      * This will create the vlan footprint in the DPN's which are member of the VPN.
1867      *
1868      * @param vpnName the vpnName
1869      * @param dpnId  the DPN id
1870      */
1871     void addRouterPortToElanForVlanInDpn(String vpnName, BigInteger dpnId) {
1872         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1873         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1874             addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1875         }
1876     }
1877
1878     /**
1879      * Removes router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1880      * This will remove the  vlan footprint in all the DPN's which are member of the VPN.
1881      *
1882      * @param vpnName the vpn name
1883      * @param dpnId  the DPN id
1884      */
1885     void removeRouterPortFromElanForVlanInDpn(String vpnName, BigInteger dpnId) {
1886         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1887         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1888             removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
1889                     vpnName, dpnId);
1890         }
1891     }
1892
1893     /**
1894      * Adds router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
1895      * This will create the vlan footprint in all the DPN's which are member of the VPN.
1896      *
1897      * @param vpnName the vpn name
1898      */
1899     void addRouterPortToElanDpnListForVlaninAllDpn(String vpnName) {
1900         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1901         Set<BigInteger> dpnList = getDpnInElan(elanInstanceRouterPortMap);
1902         for (BigInteger dpnId : dpnList) {
1903             for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1904                 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1905             }
1906         }
1907     }
1908
1909     /**Removes router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
1910      * This will remove the vlan footprint in all the DPN's which are member of the VPN.
1911      *
1912      * @param routerInterfacePortId this will add the current subnet router port id to the map for removal
1913      * @param elanInstanceName the current elanstance being removed this will be added to map for removal
1914      * @param vpnName the vpn name
1915      */
1916     void removeRouterPortFromElanDpnListForVlanInAllDpn(String elanInstanceName,
1917             String routerInterfacePortId, String vpnName) {
1918         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1919         elanInstanceRouterPortMap.put(elanInstanceName, routerInterfacePortId);
1920         Set<BigInteger> dpnList = getDpnInElan(elanInstanceRouterPortMap);
1921         for (BigInteger dpnId : dpnList) {
1922             for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1923                 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
1924                         vpnName, dpnId);
1925             }
1926         }
1927
1928     }
1929
1930     Set<BigInteger> getDpnInElan(Map<String,String> elanInstanceRouterPortMap) {
1931         Set<BigInteger> dpnIdSet = new HashSet<>();
1932         for (String elanInstanceName : elanInstanceRouterPortMap.keySet()) {
1933             InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationalDataPath(
1934                     elanInstanceName);
1935             Optional<ElanDpnInterfacesList> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL,
1936                     elanDpnInterfaceId);
1937             if (dpnInElanInterfaces.isPresent()) {
1938                 List<DpnInterfaces> dpnInterfaces =
1939                     requireNonNullElse(dpnInElanInterfaces.get().getDpnInterfaces(), emptyList());
1940                 for (DpnInterfaces dpnInterface : dpnInterfaces) {
1941                     dpnIdSet.add(dpnInterface.getDpId());
1942                 }
1943             }
1944         }
1945         return dpnIdSet;
1946     }
1947
1948     void addRouterPortToElanDpn(String elanInstanceName, String routerInterfacePortId, BigInteger dpnId) {
1949         InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
1950                 elanInstanceName,dpnId);
1951         synchronized (elanInstanceName.intern()) {
1952             Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
1953             List<String> elanInterfaceList;
1954             DpnInterfaces dpnInterface;
1955             if (!dpnInElanInterfaces.isPresent()) {
1956                 elanInterfaceList = new ArrayList<>();
1957             } else {
1958                 dpnInterface = dpnInElanInterfaces.get();
1959                 elanInterfaceList = dpnInterface.getInterfaces();
1960             }
1961             if (!elanInterfaceList.contains(routerInterfacePortId)) {
1962                 elanInterfaceList.add(routerInterfacePortId);
1963                 dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
1964                         .withKey(new DpnInterfacesKey(dpnId)).build();
1965                 syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
1966             }
1967         }
1968
1969     }
1970
1971     void removeRouterPortFromElanDpn(String elanInstanceName, String routerInterfacePortId,
1972             String vpnName, BigInteger dpnId) {
1973         InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
1974                 elanInstanceName,dpnId);
1975         synchronized (elanInstanceName.intern()) {
1976             Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
1977             List<String> elanInterfaceList;
1978             DpnInterfaces dpnInterface;
1979             if (!dpnInElanInterfaces.isPresent()) {
1980                 LOG.info("No interface in any dpn for {}", vpnName);
1981                 return;
1982             } else {
1983                 dpnInterface = dpnInElanInterfaces.get();
1984                 elanInterfaceList = dpnInterface.getInterfaces();
1985             }
1986             if (!elanInterfaceList.contains(routerInterfacePortId)) {
1987                 LOG.info("Router port not present in DPN {} for VPN {}", dpnId, vpnName);
1988                 return;
1989             }
1990             elanInterfaceList.remove(routerInterfacePortId);
1991             dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
1992                     .withKey(new DpnInterfacesKey(dpnId)).build();
1993             syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
1994         }
1995
1996     }
1997
1998     @Nullable
1999     ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName) {
2000         InstanceIdentifier<ElanInterface> elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName);
2001         return read(LogicalDatastoreType.CONFIGURATION, elanInterfaceId).orNull();
2002     }
2003
2004     static InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName) {
2005         return InstanceIdentifier.builder(ElanInterfaces.class)
2006                 .child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build();
2007     }
2008
2009     @Nullable
2010     DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) {
2011         InstanceIdentifier<DpnInterfaces> elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName,
2012                 dpId);
2013         return read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId).orNull();
2014     }
2015
2016     @Nullable
2017     String getExternalElanInterface(String elanInstanceName, BigInteger dpnId) {
2018         DpnInterfaces dpnInterfaces = getElanInterfaceInfoByElanDpn(elanInstanceName, dpnId);
2019         if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null) {
2020             LOG.info("Elan {} does not have interfaces in DPN {}", elanInstanceName, dpnId);
2021             return null;
2022         }
2023
2024         for (String dpnInterface : dpnInterfaces.getInterfaces()) {
2025             if (interfaceManager.isExternalInterface(dpnInterface)) {
2026                 return dpnInterface;
2027             }
2028         }
2029         return null;
2030     }
2031
2032     static boolean isVlan(ElanInstance elanInstance) {
2033         return elanInstance != null && elanInstance.getSegmentType() != null
2034                 && elanInstance.getSegmentType().isAssignableFrom(SegmentTypeVlan.class)
2035                 && elanInstance.getSegmentationId() != null && elanInstance.getSegmentationId() != 0;
2036     }
2037
2038     boolean isVlan(String interfaceName) {
2039         ElanInterface elanInterface = getElanInterfaceByElanInterfaceName(interfaceName);
2040         if (elanInterface == null) {
2041             return false;
2042         }
2043         ElanInstance  elanInstance = getElanInstanceByName(elanInterface.getElanInstanceName());
2044         return isVlan(elanInstance);
2045     }
2046
2047     @Nullable
2048     ElanInstance getElanInstanceByName(String elanInstanceName) {
2049         InstanceIdentifier<ElanInstance> elanIdentifierId =
2050                 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName);
2051         return read(LogicalDatastoreType.CONFIGURATION, elanIdentifierId).orNull();
2052     }
2053
2054     @Nullable
2055     String getVpnNameFromElanIntanceName(String elanInstanceName) {
2056         Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2057         if (subnetMapsData.isPresent()) {
2058             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2059             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2060                 for (Subnetmap subnet : subnetMapList) {
2061                     if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2062                         if (subnet.getVpnId() != null) {
2063                             return subnet.getVpnId().getValue();
2064                         }
2065                     }
2066                 }
2067             }
2068         }
2069         return null;
2070     }
2071
2072     Map<String, String> getElanInstanceRouterPortMap(String vpnName) {
2073         Map<String, String> elanInstanceRouterPortMap = new HashMap<>();
2074         Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2075         if (subnetMapsData.isPresent()) {
2076             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2077             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2078                 for (Subnetmap subnet : subnetMapList) {
2079                     if (subnet.getVpnId() != null && subnet.getVpnId().getValue().equals(vpnName)
2080                             && NetworkType.VLAN.equals(subnet.getNetworkType())) {
2081                         if (subnet.getRouterInterfacePortId() == null || subnet.getNetworkId() == null) {
2082                             LOG.warn("The RouterInterfacePortId or NetworkId is null");
2083                             continue;
2084                         }
2085                         String routerInterfacePortUuid = subnet.getRouterInterfacePortId().getValue();
2086                         if (routerInterfacePortUuid != null && !routerInterfacePortUuid.isEmpty()) {
2087                             elanInstanceRouterPortMap.put(subnet.getNetworkId().getValue(),routerInterfacePortUuid);
2088                         }
2089                     }
2090                 }
2091             }
2092         }
2093         return elanInstanceRouterPortMap;
2094     }
2095
2096     @Nullable
2097     String getRouterPordIdFromElanInstance(String elanInstanceName) {
2098         Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2099         if (subnetMapsData.isPresent()) {
2100             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2101             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2102                 for (Subnetmap subnet : subnetMapList) {
2103                     if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2104                         if (subnet.getRouterInterfacePortId() != null) {
2105                             return subnet.getRouterInterfacePortId().getValue();
2106                         }
2107                     }
2108                 }
2109             }
2110         }
2111         return null;
2112     }
2113
2114     boolean shouldPopulateFibForVlan(String vpnName, @Nullable String elanInstanceName, BigInteger dpnId) {
2115         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
2116         boolean shouldPopulateFibForVlan = false;
2117         if (!elanInstanceRouterPortMap.isEmpty()) {
2118             shouldPopulateFibForVlan = true;
2119         }
2120         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap
2121                 .entrySet()) {
2122             String currentElanInstance = elanInstanceRouterEntry.getKey();
2123             if (elanInstanceName != null && elanInstanceName.equals(currentElanInstance)) {
2124                 continue;
2125             }
2126             String externalinterface = getExternalElanInterface(currentElanInstance ,dpnId);
2127             if (externalinterface == null) {
2128                 shouldPopulateFibForVlan = false;
2129                 break;
2130             }
2131         }
2132         return shouldPopulateFibForVlan;
2133     }
2134
2135     public static InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName,
2136             BigInteger dpId) {
2137         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2138                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2139                 .child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build();
2140     }
2141
2142     public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationalDataPath(String elanInstanceName) {
2143         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2144                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2145                 .build();
2146     }
2147
2148     public static boolean isMatchedPrefixToInterface(Prefixes prefix, VpnInterfaceOpDataEntry vpnInterface) {
2149         if (prefix != null && vpnInterface != null) {
2150             if (prefix.getDpnId() != null && vpnInterface.getDpnId() != null) {
2151                 if (prefix.getVpnInterfaceName() != null && vpnInterface.getName() != null) {
2152                     return prefix.getDpnId().equals(vpnInterface.getDpnId())
2153                             && prefix.getVpnInterfaceName().equalsIgnoreCase(vpnInterface.getName());
2154                 }
2155             }
2156         }
2157         return false;
2158     }
2159
2160     public static void sendNeighborSolicationToOfGroup(Ipv6NdUtilService ipv6NdUtilService, Ipv6Address srcIpv6Address,
2161             MacAddress srcMac, Ipv6Address dstIpv6Address, Long ofGroupId, BigInteger dpId) {
2162         SendNeighborSolicitationToOfGroupInput input = new SendNeighborSolicitationToOfGroupInputBuilder()
2163                 .setSourceIpv6(srcIpv6Address).setSourceLlAddress(srcMac).setTargetIpAddress(dstIpv6Address)
2164                 .setOfGroupId(ofGroupId).setDpId(dpId).build();
2165         try {
2166             Future<RpcResult<SendNeighborSolicitationToOfGroupOutput>> result = ipv6NdUtilService
2167                     .sendNeighborSolicitationToOfGroup(input);
2168             RpcResult<SendNeighborSolicitationToOfGroupOutput> rpcResult = result.get();
2169             if (!rpcResult.isSuccessful()) {
2170                 LOG.error("sendNeighborSolicitationToOfGroup: RPC Call failed for input={} and Errors={}", input,
2171                         rpcResult.getErrors());
2172             }
2173         } catch (InterruptedException | ExecutionException e) {
2174             LOG.error("Failed to send NS packet to ELAN group, input={}", input, e);
2175         }
2176     }
2177
2178     Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets.VpnTarget>
2179         getRtListForVpn(String vpnName) {
2180         Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets
2181                 .VpnTarget> rtList = new HashSet<>();
2182         InstanceIdentifier<VpnInstance> vpnInstanceId = InstanceIdentifier.builder(VpnInstances.class)
2183                 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
2184         Optional<VpnInstance> vpnInstanceOptional = read(LogicalDatastoreType.CONFIGURATION, vpnInstanceId);
2185         if (vpnInstanceOptional.isPresent()) {
2186             org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.VpnTargets
2187                     vpnTargets = vpnInstanceOptional.get().getIpv4Family().getVpnTargets();
2188             if (vpnTargets != null && vpnTargets.getVpnTarget() != null) {
2189                 rtList.addAll(vpnTargets.getVpnTarget());
2190             }
2191         }
2192         else {
2193             LOG.error("getRtListForVpn: Vpn Instance {} not present in config DS", vpnName);
2194         }
2195         return rtList;
2196     }
2197
2198     static InstanceIdentifier<AssociatedVpn> getAssociatedSubnetAndVpnIdentifier(String rt, RouteTarget.RtType rtType,
2199                                                                                  String cidr, String vpnName) {
2200         return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2201                 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr))
2202                 .child(AssociatedVpn.class, new AssociatedVpnKey(vpnName)).build();
2203     }
2204
2205     static InstanceIdentifier<AssociatedSubnet> getAssociatedSubnetIdentifier(String rt, RouteTarget.RtType rtType,
2206                                                                        String cidr) {
2207         return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2208                 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr)).build();
2209     }
2210
2211     static AssociatedVpn buildAssociatedSubnetAndVpn(String vpnName) {
2212         return new AssociatedVpnBuilder().setName(vpnName).build();
2213     }
2214
2215     static InstanceIdentifier<RouteTarget> getRouteTargetsIdentifier(String rt, RouteTarget.RtType rtType) {
2216         return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class)
2217                 .child(RouteTarget.class, new RouteTargetKey(rt, rtType)).build();
2218     }
2219
2220     Set<RouteTarget> getRouteTargetSet(Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815
2221             .vpn.af.config.vpntargets.VpnTarget> vpnTargets) {
2222         Set<RouteTarget> routeTargetSet = new HashSet<>();
2223         for (org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets
2224                 .VpnTarget rt : vpnTargets) {
2225             String rtValue = rt.getVrfRTValue();
2226             switch (rt.getVrfRTType()) {
2227                 case ImportExtcommunity: {
2228                     Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2229                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2230                     if (exportRouteTargetOptional.isPresent()) {
2231                         routeTargetSet.add(exportRouteTargetOptional.get());
2232                     }
2233                     break;
2234                 }
2235                 case ExportExtcommunity: {
2236                     Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2237                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2238                     if (importRouteTargetOptional.isPresent()) {
2239                         routeTargetSet.add(importRouteTargetOptional.get());
2240                     }
2241                     break;
2242                 }
2243                 case Both: {
2244                     Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2245                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2246                     if (exportRouteTargetOptional.isPresent()) {
2247                         routeTargetSet.add(exportRouteTargetOptional.get());
2248                     }
2249                     Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2250                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2251                     if (importRouteTargetOptional.isPresent()) {
2252                         routeTargetSet.add(importRouteTargetOptional.get());
2253                     }
2254                     break;
2255                 }
2256                 default:
2257                     LOG.error("getRouteTargetSet: Invalid rt-type {}", rt.getVrfRTType());
2258             }
2259         }
2260         return routeTargetSet;
2261     }
2262
2263     /*
2264     TODO: (vivek/kiran): Subnet overlap in a VPN detection logic should use subnet allocation pools if available
2265            rather than only CIDR.
2266            Also the Subnet overlap in a VPN detection logic to be addressed for router-based-l3vpns.
2267     */
2268     static boolean areSubnetsOverlapping(String cidr1, String cidr2) {
2269         String[] ipaddressValues1 = cidr1.split("/");
2270         int address1 = InetAddresses.coerceToInteger(InetAddresses.forString(ipaddressValues1[0]));
2271         int cidrPart1 = Integer.parseInt(ipaddressValues1[1]);
2272         String[] ipaddressValues2 = cidr2.split("/");
2273         int address2 = InetAddresses.coerceToInteger(InetAddresses.forString(ipaddressValues2[0]));
2274         int cidrPart2 = Integer.parseInt(ipaddressValues2[1]);
2275         int comparedValue = 0;
2276         int netmask = 0;
2277         if (cidrPart1 <= cidrPart2) {
2278             for (int j = 0; j < cidrPart1; ++j) {
2279                 netmask |= (1 << 31 - j);
2280             }
2281             int prefix = address2 & netmask;
2282             comparedValue = address1 ^ prefix;
2283         } else {
2284             for (int j = 0; j < cidrPart2; ++j) {
2285                 netmask |= (1 << 31 - j);
2286             }
2287             int prefix = address1 & netmask;
2288             comparedValue = address2 ^ prefix;
2289         }
2290         if (comparedValue == 0) {
2291             return  true;
2292         } else {
2293             return false;
2294         }
2295     }
2296
2297     public static String buildIpMonitorJobKey(String ip, String vpnName) {
2298         return VpnConstants.IP_MONITOR_JOB_PREFIX_KEY + "-" + vpnName + "-" + ip;
2299     }
2300
2301     public List<String> getVpnListForVpnInterface(VpnInterface vpnInter) {
2302         return requireNonNullElse(vpnInter.getVpnInstanceNames(), Collections.<VpnInstanceNames>emptyList()).stream()
2303                 .map(VpnInstanceNames::getVpnName).collect(Collectors.toList());
2304     }
2305
2306     public void updateVpnInstanceWithRdList(String vpnName, List<String> updatedRdList) {
2307         String primaryRd = getVpnRd(vpnName);
2308         if (primaryRd == null) {
2309             LOG.warn("updateVpnInstanceWithRdList: Unable to retrieve primary RD for the VPN {}. Skip to process "
2310                     + "the updated RD list {} ", vpnName, updatedRdList);
2311             return;
2312         }
2313         jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
2314             VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd);
2315             builder.setRd(updatedRdList);
2316             return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
2317                     OPERATIONAL, tx -> {
2318                     InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
2319                             .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
2320                                     new VpnInstanceOpDataEntryKey(primaryRd)).build();
2321                     tx.merge(id, builder.build(), false);
2322                     LOG.debug("updateVpnInstanceWithRdList: Successfully updated the VPN {} with list of RDs {}",
2323                             vpnName, updatedRdList);
2324                 }));
2325         });
2326     }
2327
2328     // Use Objects.requireNonNullElse instead with JDK9+
2329     @Nonnull
2330     public static <T> T requireNonNullElse(@Nullable T obj, @Nonnull T defaultObj) {
2331         return obj != null ? obj : requireNonNull(defaultObj);
2332     }
2333 }