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         return prefix.indexOf('/') != -1 ? prefix : NWUtil.toIpPrefix(prefix);
 803     }
 804
 805     static final FutureCallback<Void> DEFAULT_CALLBACK =
 806         new FutureCallback<Void>() {
 807             @Override
 808             public void onSuccess(Void result) {
 809                 LOG.debug("Success in Datastore operation");
 810             }
 811
 812             @Override
 813             public void onFailure(Throwable error) {
 814                 LOG.error("Error in Datastore operation", error);
 815             }
 816
 817         };
 818
 819     @Deprecated
 820     private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
 821         try {
 822             return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
 823         } catch (ReadFailedException e) {
 824             throw new RuntimeException(e);
 825         }
 826     }
 827
 828     @Deprecated
 829     public <T extends DataObject> void syncWrite(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
 830                                                  T data) {
 831         try {
 832             SingleTransactionDataBroker.syncWrite(dataBroker, datastoreType, path, data);
 833         } catch (TransactionCommitFailedException e) {
 834             LOG.error("syncWrite: Error writing to datastore (path, data) : ({}, {})", path, data, e);
 835             throw new RuntimeException(e.getMessage(), e);
 836         }
 837     }
 838
 839     @Deprecated
 840     public <T extends DataObject> void syncUpdate(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
 841                                                   T data) {
 842         try {
 843             SingleTransactionDataBroker.syncUpdate(dataBroker, datastoreType, path, data);
 844         } catch (TransactionCommitFailedException e) {
 845             LOG.error("syncUpdate: Error writing to datastore (path, data) : ({}, {})", path, data, e);
 846             throw new RuntimeException(e.getMessage(), e);
 847         }
 848     }
 849
 850     static long getRemoteBCGroup(long elanTag) {
 851         return VpnConstants.ELAN_GID_MIN + elanTag % VpnConstants.ELAN_GID_MIN * 2;
 852     }
 853
 854     // interface-index-tag operational container
 855     @Nullable
 856     IfIndexInterface getInterfaceInfoByInterfaceTag(long interfaceTag) {
 857         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
 858         Optional<IfIndexInterface> existingInterfaceInfo = read(LogicalDatastoreType.OPERATIONAL, interfaceId);
 859         if (existingInterfaceInfo.isPresent()) {
 860             return existingInterfaceInfo.get();
 861         }
 862         return null;
 863     }
 864
 865     static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
 866         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
 867             new IfIndexInterfaceKey((int) interfaceTag)).build();
 868     }
 869
 870     @Nullable
 871     ElanTagName getElanInfoByElanTag(long elanTag) {
 872         InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
 873         Optional<ElanTagName> existingElanInfo = read(LogicalDatastoreType.OPERATIONAL, elanId);
 874         if (existingElanInfo.isPresent()) {
 875             return existingElanInfo.get();
 876         }
 877         return null;
 878     }
 879
 880     static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
 881         return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
 882             new ElanTagNameKey(elanTag)).build();
 883     }
 884
 885     static void removePrefixToInterfaceForVpnId(long vpnId, @Nonnull TypedWriteTransaction<Operational> operTx) {
 886         // Clean up PrefixToInterface Operational DS
 887         operTx.delete(InstanceIdentifier.builder(
 888                     PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build());
 889     }
 890
 891     static void removeVpnExtraRouteForVpn(String vpnName, @Nonnull TypedWriteTransaction<Operational> operTx) {
 892         // Clean up VPNExtraRoutes Operational DS
 893         operTx.delete(InstanceIdentifier.builder(VpnToExtraroutes.class).child(Vpn.class, new VpnKey(vpnName)).build());
 894     }
 895
 896     @SuppressWarnings("checkstyle:IllegalCatch")
 897     static void removeVpnOpInstance(String vpnName, @Nonnull TypedWriteTransaction<Operational> operTx) {
 898         // Clean up VPNInstanceOpDataEntry
 899         operTx.delete(getVpnInstanceOpDataIdentifier(vpnName));
 900     }
 901
 902     static void removeVpnInstanceToVpnId(String vpnName, @Nonnull TypedWriteTransaction<Configuration> confTx) {
 903         confTx.delete(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 904     }
 905
 906     static void removeVpnIdToVpnInstance(long vpnId, @Nonnull TypedWriteTransaction<Configuration> confTx) {
 907         confTx.delete(getVpnIdToVpnInstanceIdentifier(vpnId));
 908     }
 909
 910     static void removeL3nexthopForVpnId(long vpnId, @Nonnull TypedWriteTransaction<Operational> operTx) {
 911         // Clean up L3NextHop Operational DS
 912         operTx.delete(InstanceIdentifier.builder(L3nexthop.class).child(
 913                                     VpnNexthops.class, new VpnNexthopsKey(vpnId)).build());
 914     }
 915
 916     void scheduleVpnInterfaceForRemoval(String interfaceName, BigInteger dpnId, String vpnInstanceName,
 917                                         @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
 918         InstanceIdentifier<VpnInterfaceOpDataEntry> interfaceId =
 919                 getVpnInterfaceOpDataEntryIdentifier(interfaceName, vpnInstanceName);
 920         VpnInterfaceOpDataEntry interfaceToUpdate =
 921             new VpnInterfaceOpDataEntryBuilder().withKey(new VpnInterfaceOpDataEntryKey(interfaceName,
 922             vpnInstanceName)).setName(interfaceName).setDpnId(dpnId).setVpnInstanceName(vpnInstanceName)
 923             .build();
 924         if (writeOperTxn != null) {
 925             writeOperTxn.merge(interfaceId, interfaceToUpdate, true);
 926         } else {
 927             syncUpdate(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
 928         }
 929     }
 930
 931     public void createLearntVpnVipToPort(String vpnName, String fixedIp, String portName, String macAddress,
 932             TypedWriteTransaction<Operational> writeOperTxn) {
 933         synchronized ((vpnName + fixedIp).intern()) {
 934             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 935             LearntVpnVipToPortBuilder builder =
 936                     new LearntVpnVipToPortBuilder().withKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
 937                             vpnName).setPortFixedip(fixedIp).setPortName(portName)
 938                             .setMacAddress(macAddress.toLowerCase(Locale.getDefault()))
 939                             .setCreationTime(new SimpleDateFormat("MM/dd/yyyy h:mm:ss a").format(new Date()));
 940             if (writeOperTxn != null) {
 941                 writeOperTxn.put(id, builder.build(), true);
 942             } else {
 943                 syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
 944             }
 945             LOG.debug("createLearntVpnVipToPort: ARP/NA learned for fixedIp: {}, vpn {}, interface {}, mac {},"
 946                     + " added to LearntVpnVipToPort DS", fixedIp, vpnName, portName, macAddress);
 947         }
 948     }
 949
 950     static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
 951             String fixedIp) {
 952         return InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
 953                 new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
 954     }
 955
 956     void removeLearntVpnVipToPort(String vpnName, String fixedIp,
 957                                   @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
 958         synchronized ((vpnName + fixedIp).intern()) {
 959             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 960             if (writeOperTxn != null) {
 961                 writeOperTxn.delete(id);
 962             } else {
 963                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
 964             }
 965             LOG.debug("removeLearntVpnVipToPort: Deleted LearntVpnVipToPort entry for fixedIp: {}, vpn {}",
 966                 fixedIp, vpnName);
 967         }
 968     }
 969
 970     protected static void removeVpnPortFixedIpToPort(DataBroker broker, String vpnName, String fixedIp,
 971                                                      @Nullable TypedWriteTransaction<Configuration> writeConfigTxn) {
 972         synchronized ((vpnName + fixedIp).intern()) {
 973             InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 974             if (writeConfigTxn != null) {
 975                 writeConfigTxn.delete(id);
 976             } else {
 977                 MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, id);
 978             }
 979             LOG.debug("removeVpnPortFixedIpToPort: Deleted VpnPortipToPort entry for fixedIp: {}, vpn {}",
 980                 fixedIp, vpnName);
 981         }
 982     }
 983
 984     public void createLearntVpnVipToPortEvent(String vpnName, String srcIp, String destIP, String portName,
 985                                               String macAddress, LearntVpnVipToPortEventAction action,
 986                                               TypedWriteTransaction<Operational> writeOperTxn) {
 987         String eventId = MicroTimestamp.INSTANCE.get();
 988
 989         InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
 990         LearntVpnVipToPortEventBuilder builder = new LearntVpnVipToPortEventBuilder().withKey(
 991                 new LearntVpnVipToPortEventKey(eventId)).setVpnName(vpnName).setSrcFixedip(srcIp)
 992                 .setDestFixedip(destIP).setPortName(portName)
 993                 .setMacAddress(macAddress.toLowerCase(Locale.getDefault())).setEventAction(action);
 994         if (writeOperTxn != null) {
 995             writeOperTxn.delete(id);
 996         } else {
 997             syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
 998         }
 999         LOG.info("createLearntVpnVipToPortEvent: ARP learn event created for fixedIp: {}, vpn {}, interface {},"
1000                 + " mac {} action {} eventId {}", srcIp, vpnName, portName, macAddress, action, eventId);
1001     }
1002
1003     private static InstanceIdentifier<LearntVpnVipToPortEvent> buildLearntVpnVipToPortEventIdentifier(String eventId) {
1004         InstanceIdentifier<LearntVpnVipToPortEvent> id = InstanceIdentifier.builder(LearntVpnVipToPortEventData.class)
1005                 .child(LearntVpnVipToPortEvent.class, new LearntVpnVipToPortEventKey(eventId)).build();
1006         return id;
1007     }
1008
1009     public void removeLearntVpnVipToPortEvent(String eventId,
1010             @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
1011         InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
1012         if (writeOperTxn != null) {
1013             writeOperTxn.delete(id);
1014         } else {
1015             MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1016         }
1017         LOG.info("removeLearntVpnVipToPortEvent: Deleted Event {}", eventId);
1018
1019     }
1020
1021     public void removeMipAdjAndLearntIp(String vpnName, String vpnInterface, String prefix) {
1022         synchronized ((vpnName + prefix).intern()) {
1023             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, prefix);
1024             MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1025             LOG.info("removeMipAdjAndLearntIp: Delete learned ARP for fixedIp: {}, vpn {} removed from"
1026                             + "VpnPortipToPort DS", prefix, vpnName);
1027             String ip = VpnUtil.getIpPrefix(prefix);
1028             InstanceIdentifier<VpnInterfaceOpDataEntry> vpnInterfaceOpId = VpnUtil
1029                     .getVpnInterfaceOpDataEntryIdentifier(vpnInterface, vpnName);
1030             InstanceIdentifier<AdjacenciesOp> path = vpnInterfaceOpId.augmentation(AdjacenciesOp.class);
1031             Optional<AdjacenciesOp> adjacenciesOp = read(LogicalDatastoreType.OPERATIONAL, path);
1032             if (adjacenciesOp.isPresent()) {
1033                 InstanceIdentifier<Adjacency> adjacencyIdentifier = InstanceIdentifier.builder(VpnInterfaces.class)
1034                         .child(VpnInterface.class, new VpnInterfaceKey(vpnInterface)).augmentation(Adjacencies.class)
1035                         .child(Adjacency.class, new AdjacencyKey(ip)).build();
1036                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1037                 LOG.info("removeMipAdjAndLearntIp: Successfully Deleted Adjacency {} from interface {} vpn {}", ip,
1038                         vpnInterface, vpnName);
1039             }
1040         }
1041     }
1042
1043     public void removeMipAdjacency(String vpnInterface, String ipAddress) {
1044         String prefix = VpnUtil.getIpPrefix(ipAddress);
1045         InstanceIdentifier<Adjacency> adjacencyIdentifier = getAdjacencyIdentifier(vpnInterface, prefix);
1046         try {
1047             SingleTransactionDataBroker.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1048         } catch (TransactionCommitFailedException e) {
1049             if (e.getCause() instanceof ModifiedNodeDoesNotExistException) {
1050                 LOG.debug("vpnInterface {} is already deleted. prefix={}", vpnInterface, prefix);
1051             } else {
1052                 LOG.error("Failed to delete adjacency for vpnInterface {}, prefix {}", vpnInterface, prefix, e);
1053             }
1054         }
1055     }
1056
1057     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1058         return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1059                 NetworkMapKey(networkId)).build();
1060     }
1061
1062     static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1063         return InstanceIdentifier.builder(SubnetOpData.class)
1064                 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1065     }
1066
1067     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1068         return InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1069                 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1070     }
1071
1072     @Nullable
1073     public VpnPortipToPort getNeutronPortFromVpnPortFixedIp(String vpnName, String fixedIp) {
1074         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1075         Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
1076         if (vpnPortipToPortData.isPresent()) {
1077             return vpnPortipToPortData.get();
1078         }
1079         return null;
1080     }
1081
1082     @Nullable
1083     public static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(TypedReadTransaction<Configuration> confTx,
1084             String vpnName, String fixedIp) {
1085         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1086         try {
1087             return confTx.read(id).get().orNull();
1088         } catch (InterruptedException | ExecutionException e) {
1089             throw new RuntimeException(e);
1090         }
1091     }
1092
1093     @Nullable
1094     public LearntVpnVipToPort getLearntVpnVipToPort(String vpnName, String fixedIp) {
1095         InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1096         Optional<LearntVpnVipToPort> learntVpnVipToPort = read(LogicalDatastoreType.OPERATIONAL, id);
1097         if (learntVpnVipToPort.isPresent()) {
1098             return learntVpnVipToPort.get();
1099         }
1100         return null;
1101     }
1102
1103     @Nonnull
1104     List<BigInteger> getDpnsOnVpn(String vpnInstanceName) {
1105         List<BigInteger> result = new ArrayList<>();
1106         String rd = getVpnRd(vpnInstanceName);
1107         if (rd == null) {
1108             LOG.debug("getDpnsOnVpn: Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1109             return result;
1110         }
1111         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1112         if (vpnInstanceOpData == null) {
1113             LOG.debug("getDpnsOnVpn: Could not find OpState for VpnName={}", vpnInstanceName);
1114             return result;
1115         }
1116         List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1117         if (vpnToDpnList == null) {
1118             LOG.debug("getDpnsOnVpn: Could not find DPN footprint for VpnName={}", vpnInstanceName);
1119             return result;
1120         }
1121         for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1122             result.add(vpnToDpn.getDpnId());
1123         }
1124         return result;
1125     }
1126
1127     @Nullable
1128     String getAssociatedExternalRouter(String extIp) {
1129         InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1130                 InstanceIdentifier.builder(ExtRouters.class).build();
1131         Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1132         if (!extRouterData.isPresent()) {
1133             return null;
1134         }
1135
1136         // We need to find the router associated with the src ip of this packet.
1137         // This case is either SNAT, in which case the src ip is the same as the
1138         // router's external ip, or FIP in which case the src ip is in the router's
1139         // external leg's subnet. We first check the SNAT case because it is much
1140         // cheaper to do so because it does not require (potentially, there is a
1141         // cache) an datastore read of the neutron subnet for each external IP.
1142
1143         String routerName = null;
1144
1145         for (Routers routerData : requireNonNullElse(extRouterData.get().getRouters(),
1146                 Collections.<Routers>emptyList())) {
1147             List<ExternalIps> externalIps = requireNonNullElse(routerData.getExternalIps(), emptyList());
1148             for (ExternalIps externalIp : externalIps) {
1149                 if (Objects.equals(externalIp.getIpAddress(), extIp)) {
1150                     routerName = routerData.getRouterName();
1151                     break;
1152                 }
1153             }
1154         }
1155
1156         if (routerName != null) {
1157             return routerName;
1158         }
1159
1160         for (Routers routerData : requireNonNullElse(extRouterData.get().getRouters(),
1161                 Collections.<Routers>emptyList())) {
1162             List<ExternalIps> externalIps = requireNonNullElse(routerData.getExternalIps(), emptyList());
1163             for (ExternalIps externalIp : externalIps) {
1164                 Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1165                 if (neutronSubnet == null) {
1166                     LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1167                             externalIp.getSubnetId(), routerData);
1168                     continue;
1169                 }
1170                 if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp), neutronSubnet.getCidr())) {
1171                     routerName = routerData.getRouterName();
1172                     break;
1173                 }
1174             }
1175         }
1176
1177         return routerName;
1178     }
1179
1180     @Nullable
1181     public String getAssociatedExternalSubnet(String extIp) {
1182         InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1183                 InstanceIdentifier.builder(ExtRouters.class).build();
1184         Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1185         if (!extRouterData.isPresent()) {
1186             return null;
1187         }
1188         for (Routers routerData : requireNonNullElse(extRouterData.get().getRouters(),
1189                 Collections.<Routers>emptyList())) {
1190             List<ExternalIps> externalIps = requireNonNullElse(routerData.getExternalIps(), emptyList());
1191             for (ExternalIps externalIp : externalIps) {
1192                 Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1193                 if (neutronSubnet == null) {
1194                     LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1195                             externalIp.getSubnetId(), routerData);
1196                     continue;
1197                 }
1198                 if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp), neutronSubnet.getCidr())) {
1199                     return neutronSubnet.getUuid().getValue();
1200                 }
1201             }
1202         }
1203         return null;
1204     }
1205
1206     static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1207         return InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1208     }
1209
1210     @Nullable
1211     Networks getExternalNetwork(Uuid networkId) {
1212         InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1213             .child(Networks.class, new NetworksKey(networkId)).build();
1214         Optional<Networks> optionalNets = read(LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1215         return optionalNets.isPresent() ? optionalNets.get() : null;
1216     }
1217
1218     @Nullable
1219     Uuid getExternalNetworkVpnId(Uuid networkId) {
1220         Networks extNetwork = getExternalNetwork(networkId);
1221         return extNetwork != null ? extNetwork.getVpnid() : null;
1222     }
1223
1224     @Nonnull
1225     public List<Uuid> getExternalNetworkRouterIds(Uuid networkId) {
1226         Networks extNetwork = getExternalNetwork(networkId);
1227         return extNetwork != null && extNetwork.getRouterIds() != null ? extNetwork.getRouterIds() : emptyList();
1228     }
1229
1230     @Nullable
1231     Routers getExternalRouter(String routerId) {
1232         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1233                 new RoutersKey(routerId)).build();
1234         Optional<Routers> routerData = read(LogicalDatastoreType.CONFIGURATION, id);
1235         return routerData.isPresent() ? routerData.get() : null;
1236     }
1237
1238     @Nullable
1239     Routers getExternalRouter(TypedReadTransaction<Configuration> tx, String routerId)
1240             throws ExecutionException, InterruptedException {
1241         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1242             new RoutersKey(routerId)).build();
1243         return tx.read(id).get().orNull();
1244     }
1245
1246     static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1247         return InstanceIdentifier.create(Subnetmaps.class);
1248     }
1249
1250     FlowEntity buildL3vpnGatewayFlow(BigInteger dpId, String gwMacAddress, long vpnId,
1251                                                    long subnetVpnId) {
1252         List<MatchInfo> mkMatches = new ArrayList<>();
1253         Subnetmap smap = null;
1254         mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
1255         mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1256         List<InstructionInfo> mkInstructions = new ArrayList<>();
1257         mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1258         if (subnetVpnId != VpnConstants.INVALID_ID) {
1259             String vpnName = getVpnName(subnetVpnId);
1260             if (vpnName != null) {
1261                 smap = getSubnetmapFromItsUuid(Uuid.getDefaultInstance(vpnName));
1262                 if (smap != null && smap.getSubnetIp() != null) {
1263                     IpVersionChoice ipVersionChoice = getIpVersionFromString(smap.getSubnetIp());
1264                     if (ipVersionChoice == IpVersionChoice.IPV4) {
1265                         mkMatches.add(MatchEthernetType.IPV4);
1266                     } else {
1267                         mkMatches.add(MatchEthernetType.IPV6);
1268                     }
1269                 }
1270             }
1271             BigInteger subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId);
1272             mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1273         }
1274         String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress, subnetVpnId);
1275         return MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1276                 flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE, mkMatches, mkInstructions);
1277     }
1278
1279     static String getL3VpnGatewayFlowRef(short l3GwMacTable, BigInteger dpId, long vpnId, String gwMacAddress,
1280                                          long subnetVpnId) {
1281         return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1282             + NwConstants.FLOWID_SEPARATOR + l3GwMacTable + NwConstants.FLOWID_SEPARATOR + subnetVpnId;
1283     }
1284
1285     void lockSubnet(String subnetId) {
1286         TryLockInput input =
1287             new TryLockInputBuilder().setLockName(subnetId).setTime(3000L).setTimeUnit(TimeUnits.Milliseconds).build();
1288         Future<RpcResult<TryLockOutput>> result = lockManager.tryLock(input);
1289         try {
1290             if (result != null && result.get().isSuccessful()) {
1291                 LOG.debug("lockSubnet: Acquired lock for {}", subnetId);
1292             } else {
1293                 LOG.error("Unable to get lock for subnet {}", subnetId);
1294                 throw new RuntimeException("Unable to get lock for subnet " + subnetId);
1295             }
1296         } catch (InterruptedException | ExecutionException e) {
1297             LOG.error("Unable to get lock for subnet {}", subnetId, e);
1298             throw new RuntimeException("Unable to get lock for subnet " + subnetId, e);
1299         }
1300     }
1301
1302     // We store the cause, which is what we really care about
1303     @SuppressWarnings("checkstyle:AvoidHidingCauseException")
1304     public void unlockSubnet(String subnetId) {
1305         UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1306         Future<RpcResult<UnlockOutput>> result = lockManager.unlock(input);
1307         try {
1308             if (result != null && result.get().isSuccessful()) {
1309                 LOG.debug("unlockSubnet: Unlocked {}", subnetId);
1310             } else {
1311                 LOG.debug("unlockSubnet: Unable to unlock subnet {}", subnetId);
1312             }
1313         } catch (InterruptedException | ExecutionException e) {
1314             LOG.error("unlockSubnet: Unable to unlock subnet {}", subnetId);
1315             throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1316         }
1317     }
1318
1319     public Optional<IpAddress> getGatewayIpAddressFromInterface(MacEntry macEntry) {
1320         Optional<IpAddress> gatewayIp = Optional.absent();
1321         String srcInterface = macEntry.getInterfaceName();
1322         InetAddress hiddenIp = macEntry.getIpAddress();
1323         if (neutronVpnService != null) {
1324             //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1325             Port port = neutronVpnService.getNeutronPort(srcInterface);
1326             if (port != null && port.getFixedIps() != null) {
1327                 for (FixedIps portIp : port.getFixedIps()) {
1328                     if (doesInterfaceAndHiddenIpAddressTypeMatch(hiddenIp, portIp)) {
1329                         gatewayIp =
1330                                 Optional.of(neutronVpnService.getNeutronSubnet(portIp.getSubnetId()).getGatewayIp());
1331                         break;
1332                     }
1333                 }
1334             }
1335         } else {
1336             LOG.error("getGatewayIpAddressFromInterface: neutron vpn service is not configured."
1337                     + " Failed for interface {}.", srcInterface);
1338         }
1339         return gatewayIp;
1340     }
1341
1342     private boolean doesInterfaceAndHiddenIpAddressTypeMatch(InetAddress hiddenIp, FixedIps portIp) {
1343         return hiddenIp instanceof Inet4Address && portIp.getIpAddress().getIpv4Address() != null
1344                 || hiddenIp instanceof Inet6Address && portIp.getIpAddress().getIpv6Address() != null;
1345     }
1346
1347     public Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp) {
1348         Optional<String> gatewayMac = Optional.absent();
1349         long vpnId = getVpnId(macEntry.getVpnName());
1350         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1351             .instance.VpnIds>
1352             vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1353         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1354             vpnIdsOptional = read(LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1355         if (!vpnIdsOptional.isPresent()) {
1356             LOG.error("getGWMacAddressFromInterface: VPN {} not configured", vpnId);
1357             return gatewayMac;
1358         }
1359         VpnPortipToPort vpnTargetIpToPort =
1360                 getNeutronPortFromVpnPortFixedIp(macEntry.getVpnName(), gatewayIp.stringValue());
1361         if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1362             gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1363         } else {
1364             org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
1365                     .vpn.id.to.vpn.instance.VpnIds vpnIds = vpnIdsOptional.get();
1366             if (vpnIds.isExternalVpn()) {
1367                 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1368             }
1369         }
1370         return gatewayMac;
1371     }
1372
1373     void setupGwMacIfExternalVpn(BigInteger dpnId, String interfaceName, long vpnId,
1374                                  TypedReadWriteTransaction<Configuration> writeInvTxn, int addOrRemove, String gwMac)
1375             throws ExecutionException, InterruptedException {
1376         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1377             .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1378         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1379             .VpnIds> vpnIdsOptional = writeInvTxn.read(vpnIdsInstanceIdentifier).get();
1380         if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1381             if (gwMac == null) {
1382                 LOG.error("setupGwMacIfExternalVpn: Failed to get gwMacAddress for interface {} on dpn {} vpn {}",
1383                         interfaceName, dpnId.toString(), vpnIdsOptional.get().getVpnInstanceName());
1384                 return;
1385             }
1386             FlowEntity flowEntity = buildL3vpnGatewayFlow(dpnId, gwMac, vpnId, VpnConstants.INVALID_ID);
1387             if (addOrRemove == NwConstants.ADD_FLOW) {
1388                 mdsalManager.addFlow(writeInvTxn, flowEntity);
1389             } else if (addOrRemove == NwConstants.DEL_FLOW) {
1390                 mdsalManager.removeFlow(writeInvTxn, flowEntity);
1391             }
1392         }
1393     }
1394
1395     public Optional<String> getVpnSubnetGatewayIp(final Uuid subnetUuid) {
1396         Optional<String> gwIpAddress = Optional.absent();
1397         final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1398         final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1399                 .child(Subnets.class)
1400                 .child(Subnet.class, subnetkey);
1401         final Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1402         if (subnet.isPresent()) {
1403             Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1404             if (IpVersionV4.class.equals(ipVersionBase)) {
1405                 Subnetmap subnetmap = getSubnetmapFromItsUuid(subnetUuid);
1406                 if (subnetmap != null && subnetmap.getRouterInterfaceFixedIp() != null) {
1407                     LOG.trace("getVpnSubnetGatewayIp: Obtained subnetMap {} for vpn interface",
1408                             subnetmap.getId().getValue());
1409                     gwIpAddress = Optional.of(subnetmap.getRouterInterfaceFixedIp());
1410                 } else {
1411                     //For direct L3VPN to network association (no router) continue to use subnet-gateway IP
1412                     IpAddress gwIp = subnet.get().getGatewayIp();
1413                     if (gwIp != null && gwIp.getIpv4Address() != null) {
1414                         gwIpAddress = Optional.of(gwIp.getIpv4Address().getValue());
1415                     }
1416                 }
1417                 LOG.trace("getVpnSubnetGatewayIp: Obtained subnet-gw ip {} for vpn interface",
1418                         gwIpAddress.get());
1419             }
1420         }
1421         return gwIpAddress;
1422     }
1423
1424     @Nullable
1425     RouterToNaptSwitch getRouterToNaptSwitch(String routerName) {
1426         InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1427                 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1428         Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(LogicalDatastoreType.CONFIGURATION, id);
1429         return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1430     }
1431
1432     static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1433         return InstanceIdentifier.builder(Subnetmaps.class)
1434         .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1435
1436     }
1437
1438     @Nullable
1439     BigInteger getPrimarySwitchForRouter(String routerName) {
1440         RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(routerName);
1441         return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1442     }
1443
1444     static boolean isL3VpnOverVxLan(Long l3Vni) {
1445         return l3Vni != null && l3Vni != 0;
1446     }
1447
1448     /**
1449      * Retrieves the primary rd of a vpn instance
1450      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1451      * If rd list is empty, primary rd will be vpn instance name
1452      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1453      *
1454      * @param vpnName Name of the VPN
1455      * @return the primary rd of the VPN
1456      */
1457     public String getPrimaryRd(String vpnName) {
1458         // Retrieves the VPN Route Distinguisher by its Vpn instance name
1459         String rd = getVpnRd(vpnName);
1460         if (rd != null) {
1461             return rd;
1462         }
1463         InstanceIdentifier<VpnInstance> id  = getVpnInstanceIdentifier(vpnName);
1464         Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1465         if (vpnInstance.isPresent()) {
1466             return getPrimaryRd(vpnInstance.get());
1467         }
1468         return vpnName;
1469     }
1470
1471     /**
1472      * Retrieves the primary rd of a vpn instance
1473      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1474      * If rd list is empty, primary rd will be vpn instance name
1475      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1476      *
1477      * @param vpnInstance Config Vpn Instance Object
1478      * @return the primary rd of the VPN
1479      */
1480     static String getPrimaryRd(VpnInstance vpnInstance) {
1481         List<String> rds = null;
1482         if (vpnInstance != null) {
1483             rds = getListOfRdsFromVpnInstance(vpnInstance);
1484         }
1485         return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1486     }
1487
1488     static boolean isBgpVpn(String vpnName, String primaryRd) {
1489         return !vpnName.equals(primaryRd);
1490     }
1491
1492     java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(long vpnId, @Nullable Long parentVpnId,
1493                                                                           String prefix, String vpnName,
1494                                                                           String nextHop, BigInteger dpnId) {
1495         //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1496         //This is particularly useful during reboot scenarios.
1497         java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1498                 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1499         if (allocatedRd.isPresent()) {
1500             return allocatedRd;
1501         }
1502
1503         //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1504         List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1505         for (String usedRd : usedRds) {
1506             Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1507                     vpnName, usedRd, prefix);
1508             if (vpnExtraRoutes.isPresent()) {
1509                 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1510                 // In case of VPN importing the routes, the interface is not present in the VPN
1511                 // and has to be fetched from the VPN from which it imports
1512                 Optional<Prefixes> prefixToInterface =
1513                         getPrefixToInterface(parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1514                 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1515                     syncUpdate(LogicalDatastoreType.CONFIGURATION,
1516                             VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1517                             getRdsBuilder(nextHop, usedRd).build());
1518                     return java.util.Optional.of(usedRd);
1519                 }
1520             }
1521         }
1522         List<String> availableRds = getVpnRdsFromVpnInstanceConfig(vpnName);
1523         String rd;
1524         if (availableRds.isEmpty()) {
1525             rd = dpnId.toString();
1526             LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1527         } else {
1528             LOG.trace("Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {}",
1529                     usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1530             availableRds.removeAll(usedRds);
1531             if (availableRds.isEmpty()) {
1532                 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1533                 return java.util.Optional.empty();
1534             }
1535             // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1536             rd = availableRds.get(0);
1537         }
1538         syncUpdate(LogicalDatastoreType.CONFIGURATION,
1539                 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop), getRdsBuilder(nextHop, rd).build());
1540         return java.util.Optional.ofNullable(rd);
1541     }
1542
1543     static String getVpnNamePrefixKey(String vpnName, String prefix) {
1544         return vpnName + VpnConstants.SEPARATOR + prefix;
1545     }
1546
1547     static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1548         return InstanceIdentifier.builder(VpnInterfaces.class)
1549                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1550                 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1551     }
1552
1553     static InstanceIdentifier<Adjacency> getVpnInterfaceOpDataEntryAdjacencyIdentifier(String intfName, String vpnName,
1554                 String ipAddress) {
1555         return InstanceIdentifier.builder(VpnInterfaceOpData.class)
1556                 .child(VpnInterfaceOpDataEntry.class, new VpnInterfaceOpDataEntryKey(intfName, vpnName))
1557                 .augmentation(AdjacenciesOp.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1558     }
1559
1560     public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1561         if (externalIps == null) {
1562             return emptyList();
1563         }
1564
1565         return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1566     }
1567
1568     void bindService(final String vpnInstanceName, final String interfaceName, boolean isTunnelInterface) {
1569         jobCoordinator.enqueueJob(interfaceName,
1570             () -> Collections.singletonList(txRunner.callWithNewReadWriteTransactionAndSubmit(
1571                                                                                 Datastore.CONFIGURATION, tx -> {
1572                     BoundServices serviceInfo = isTunnelInterface
1573                             ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1574                             : getBoundServicesForVpnInterface(vpnInstanceName, interfaceName);
1575                     tx.put(InterfaceUtils.buildServiceId(interfaceName,
1576                             ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1577                                     NwConstants.L3VPN_SERVICE_INDEX)),
1578                             serviceInfo, WriteTransaction.CREATE_MISSING_PARENTS);
1579                 })), SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1580     }
1581
1582     BoundServices getBoundServicesForVpnInterface(String vpnName, String interfaceName) {
1583         List<Instruction> instructions = new ArrayList<>();
1584         int instructionKey = 0;
1585         final long vpnId = getVpnId(vpnName);
1586         List<Action> actions = Collections.singletonList(
1587                 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId).buildAction());
1588         instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1589         instructions.add(
1590                 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId),
1591                         MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1592         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1593                 ++instructionKey));
1594         BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1595                 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1596                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1597                 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1598         return serviceInfo;
1599     }
1600
1601     static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1602         int instructionKey = 0;
1603         List<Instruction> instructions = new ArrayList<>();
1604         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1605                 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1606         BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1607                 vpnName, interfaceName),
1608                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1609                         NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1610                 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1611         return serviceInfo;
1612     }
1613
1614     void unbindService(final String vpnInterfaceName, boolean isInterfaceStateDown) {
1615         if (!isInterfaceStateDown) {
1616             jobCoordinator.enqueueJob(vpnInterfaceName,
1617                 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1618                         Datastore.CONFIGURATION, tx ->
1619                         tx.delete(InterfaceUtils.buildServiceId(vpnInterfaceName,
1620                                         ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1621                                                 NwConstants.L3VPN_SERVICE_INDEX))))),
1622                 SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1623         }
1624     }
1625
1626     static FlowEntity buildFlowEntity(BigInteger dpnId, short tableId, String flowId) {
1627         return new FlowEntityBuilder().setDpnId(dpnId).setTableId(tableId).setFlowId(flowId).build();
1628     }
1629
1630     static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1631         return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1632     }
1633
1634     @Nullable
1635     org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets
1636         getExternalSubnet(Uuid subnetId) {
1637         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1638             .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1639                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1640                         .Subnets.class, new SubnetsKey(subnetId)).build();
1641         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1642             optionalSubnets = read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1643         return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1644     }
1645
1646     @Nullable
1647     public Uuid getSubnetFromExternalRouterByIp(Uuid routerId, String ip) {
1648         Routers externalRouter = getExternalRouter(routerId.getValue());
1649         if (externalRouter != null && externalRouter.getExternalIps() != null) {
1650             for (ExternalIps externalIp : externalRouter.getExternalIps()) {
1651                 if (Objects.equals(externalIp.getIpAddress(), ip)) {
1652                     return externalIp.getSubnetId();
1653                 }
1654             }
1655         }
1656         return null;
1657     }
1658
1659     static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1660         return vpnName.equals(subnetId);
1661     }
1662
1663     static Boolean getIsExternal(Network network) {
1664         return network.augmentation(NetworkL3Extension.class) != null
1665                 && network.augmentation(NetworkL3Extension.class).isExternal();
1666     }
1667
1668     @SuppressWarnings("checkstyle:linelength")
1669     @Nullable
1670     Network getNeutronNetwork(Uuid networkId) {
1671         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1672         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1673                 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1674                 Network.class, new NetworkKey(networkId));
1675         return read(LogicalDatastoreType.CONFIGURATION, inst).orNull();
1676     }
1677
1678     public static boolean isEligibleForBgp(@Nullable String rd, @Nullable String vpnName, @Nullable BigInteger dpnId,
1679             @Nullable String networkName) {
1680         if (rd != null) {
1681             if (rd.equals(vpnName)) {
1682                 return false;
1683             }
1684             if (dpnId != null && rd.equals(dpnId.toString())) {
1685                 return false;
1686             }
1687             if (rd.equals(networkName)) {
1688                 return false;
1689             }
1690             return true;
1691         }
1692         return false;
1693     }
1694
1695     static String getFibFlowRef(BigInteger dpnId, short tableId, String vpnName, int priority) {
1696         return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
1697                 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
1698     }
1699
1700     void removeExternalTunnelDemuxFlows(String vpnName) {
1701         LOG.info("Removing external tunnel flows for vpn {}", vpnName);
1702         for (BigInteger dpnId: NWUtil.getOperativeDPNs(dataBroker)) {
1703             LOG.debug("Removing external tunnel flows for vpn {} from dpn {}", vpnName, dpnId);
1704             String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
1705                     vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
1706             FlowEntity flowEntity = VpnUtil.buildFlowEntity(dpnId,
1707                     NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef);
1708             mdsalManager.removeFlow(flowEntity);
1709         }
1710     }
1711
1712     public boolean isVpnPendingDelete(String rd) {
1713         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1714         boolean isVpnPendingDelete = false;
1715         if (vpnInstanceOpData == null
1716                 || vpnInstanceOpData.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete) {
1717             isVpnPendingDelete = true;
1718         }
1719         return isVpnPendingDelete;
1720     }
1721
1722     public List<VpnInstanceOpDataEntry> getVpnsImportingMyRoute(final String vpnName) {
1723         List<VpnInstanceOpDataEntry> vpnsToImportRoute = new ArrayList<>();
1724         final String vpnRd = getVpnRd(vpnName);
1725         if (vpnRd == null) {
1726             LOG.error("getVpnsImportingMyRoute: vpn {} not present in config DS.", vpnName);
1727             return vpnsToImportRoute;
1728         }
1729         final VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpData(vpnRd);
1730         if (vpnInstanceOpDataEntry == null) {
1731             LOG.error("getVpnsImportingMyRoute: Could not retrieve vpn instance op data for {}"
1732                     + " to check for vpns importing the routes", vpnName);
1733             return vpnsToImportRoute;
1734         }
1735         Predicate<VpnInstanceOpDataEntry> excludeVpn = input -> {
1736             if (input.getVpnInstanceName() == null) {
1737                 LOG.error("getVpnsImportingMyRoute.excludeVpn: Received vpn instance with rd {} without a name.",
1738                         input.getVrfId());
1739                 return false;
1740             }
1741             return !input.getVpnInstanceName().equals(vpnName);
1742         };
1743         Predicate<VpnInstanceOpDataEntry> matchRTs = input -> {
1744             Iterable<String> commonRTs =
1745                 intersection(getRts(vpnInstanceOpDataEntry, VpnTarget.VrfRTType.ExportExtcommunity),
1746                     getRts(input, VpnTarget.VrfRTType.ImportExtcommunity));
1747             return Iterators.size(commonRTs.iterator()) > 0;
1748         };
1749         vpnsToImportRoute = getAllVpnInstanceOpData().stream().filter(excludeVpn).filter(matchRTs)
1750                 .collect(Collectors.toList());
1751         return vpnsToImportRoute;
1752     }
1753
1754     static List<String> getRts(VpnInstanceOpDataEntry vpnInstance, VpnTarget.VrfRTType rtType) {
1755         String name = vpnInstance.getVpnInstanceName();
1756         List<String> rts = new ArrayList<>();
1757         VpnTargets targets = vpnInstance.getVpnTargets();
1758         if (targets == null) {
1759             LOG.debug("getRts: vpn targets not available for {}", name);
1760             return rts;
1761         }
1762         List<VpnTarget> vpnTargets = targets.getVpnTarget();
1763         if (vpnTargets == null) {
1764             LOG.debug("getRts: vpnTarget values not available for {}", name);
1765             return rts;
1766         }
1767         for (VpnTarget target : vpnTargets) {
1768             //TODO: Check for RT type is Both
1769             if (target.getVrfRTType().equals(rtType) || target.getVrfRTType().equals(VpnTarget.VrfRTType.Both)) {
1770                 String rtValue = target.getVrfRTValue();
1771                 rts.add(rtValue);
1772             }
1773         }
1774         return rts;
1775     }
1776
1777     static <T> Iterable<T> intersection(final Collection<T> collection1, final Collection<T> collection2) {
1778         Set<T> intersection = new HashSet<>(collection1);
1779         intersection.retainAll(collection2);
1780         return intersection;
1781     }
1782
1783     /** Get Subnetmap from its Uuid.
1784      * @param subnetUuid the subnet's Uuid
1785      * @return the Subnetmap of Uuid or null if it is not found
1786      */
1787     @Nullable
1788     public Subnetmap getSubnetmapFromItsUuid(Uuid subnetUuid) {
1789         InstanceIdentifier<Subnetmap> id = buildSubnetmapIdentifier(subnetUuid);
1790         return read(LogicalDatastoreType.CONFIGURATION, id).orNull();
1791     }
1792
1793     boolean isAdjacencyEligibleToVpnInternet(Adjacency adjacency) {
1794         // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1795         boolean adjacencyEligible = false;
1796         IpVersionChoice ipVerChoice = getIpVersionFromString(adjacency.getIpAddress());
1797         if (ipVerChoice.isIpVersionChosen(IpVersionChoice.IPV6)) {
1798             Subnetmap sn = getSubnetmapFromItsUuid(adjacency.getSubnetId());
1799             if (sn != null && sn.getInternetVpnId() != null) {
1800                 adjacencyEligible = true;
1801             }
1802         }
1803         return adjacencyEligible;
1804     }
1805
1806     boolean isAdjacencyEligibleToVpn(Adjacency adjacency, String vpnName) {
1807         // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1808         boolean adjacencyEligible = true;
1809         // if BGPVPN internet, return false if subnetmap has not internetVpnId() filled in
1810         if (isBgpVpnInternet(vpnName)) {
1811             return isAdjacencyEligibleToVpnInternet(adjacency);
1812         }
1813         return adjacencyEligible;
1814     }
1815
1816     @Nullable
1817     String getInternetVpnFromVpnInstanceList(List<VpnInstanceNames> vpnInstanceList) {
1818         for (VpnInstanceNames vpnInstance : vpnInstanceList) {
1819             String vpnName = vpnInstance.getVpnName();
1820             if (isBgpVpnInternet(vpnName)) {
1821                 return vpnName;
1822             }
1823         }
1824         return null;
1825     }
1826
1827     /** Get boolean true if vpn is bgpvpn internet, false otherwise.
1828      * @param vpnName name of the input VPN
1829      * @return true or false
1830      */
1831     boolean isBgpVpnInternet(String vpnName) {
1832         String primaryRd = getVpnRd(vpnName);
1833         if (primaryRd == null) {
1834             LOG.error("isBgpVpnInternet VPN {}."
1835                       + "Primary RD not found", vpnName);
1836             return false;
1837         }
1838         InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1839               .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1840
1841         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1842         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1843             LOG.error("isBgpVpnInternet VPN {}."
1844                      + "VpnInstanceOpDataEntry not found", vpnName);
1845             return false;
1846         }
1847         LOG.debug("isBgpVpnInternet VPN {}."
1848              + "Successfully VpnInstanceOpDataEntry.getBgpvpnType {}",
1849              vpnName, vpnInstanceOpDataEntryOptional.get().getBgpvpnType());
1850         if (vpnInstanceOpDataEntryOptional.get().getBgpvpnType() == VpnInstanceOpDataEntry
1851                .BgpvpnType.BGPVPNInternet) {
1852             return true;
1853         }
1854         return false;
1855     }
1856
1857     /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1858      * @param ipAddress String of an representation IP address V4 or V6
1859      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1860      */
1861     public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1862         int indexIpAddress = ipAddress.indexOf('/');
1863         if (indexIpAddress >= 0) {
1864             ipAddress = ipAddress.substring(0, indexIpAddress);
1865         }
1866         try {
1867             InetAddress address = InetAddress.getByName(ipAddress);
1868             if (address instanceof Inet4Address) {
1869                 return IpVersionChoice.IPV4;
1870             } else if (address instanceof Inet6Address) {
1871                 return IpVersionChoice.IPV6;
1872             }
1873         } catch (UnknownHostException | SecurityException e) {
1874             return IpVersionChoice.UNDEFINED;
1875         }
1876         return IpVersionChoice.UNDEFINED;
1877     }
1878
1879     ListenableFuture<Void> unsetScheduledToRemoveForVpnInterface(String interfaceName) {
1880         VpnInterfaceBuilder builder = new VpnInterfaceBuilder().withKey(new VpnInterfaceKey(interfaceName));
1881         return txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> tx.merge(
1882                 VpnUtil.getVpnInterfaceIdentifier(interfaceName), builder.build(),
1883                 WriteTransaction.CREATE_MISSING_PARENTS));
1884     }
1885
1886     /**
1887      * Adds router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1888      * This will create the vlan footprint in the DPN's which are member of the VPN.
1889      *
1890      * @param vpnName the vpnName
1891      * @param dpnId  the DPN id
1892      */
1893     void addRouterPortToElanForVlanInDpn(String vpnName, BigInteger dpnId) {
1894         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1895         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1896             addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1897         }
1898     }
1899
1900     /**
1901      * Removes router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1902      * This will remove the  vlan footprint in all the DPN's which are member of the VPN.
1903      *
1904      * @param vpnName the vpn name
1905      * @param dpnId  the DPN id
1906      */
1907     void removeRouterPortFromElanForVlanInDpn(String vpnName, BigInteger dpnId) {
1908         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1909         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1910             removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
1911                     vpnName, dpnId);
1912         }
1913     }
1914
1915     /**
1916      * Adds router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
1917      * This will create the vlan footprint in all the DPN's which are member of the VPN.
1918      *
1919      * @param vpnName the vpn name
1920      */
1921     void addRouterPortToElanDpnListForVlaninAllDpn(String vpnName) {
1922         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1923         Set<BigInteger> dpnList = getDpnInElan(elanInstanceRouterPortMap);
1924         for (BigInteger dpnId : dpnList) {
1925             for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1926                 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1927             }
1928         }
1929     }
1930
1931     /**Removes router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
1932      * This will remove the vlan footprint in all the DPN's which are member of the VPN.
1933      *
1934      * @param routerInterfacePortId this will add the current subnet router port id to the map for removal
1935      * @param elanInstanceName the current elanstance being removed this will be added to map for removal
1936      * @param vpnName the vpn name
1937      */
1938     void removeRouterPortFromElanDpnListForVlanInAllDpn(String elanInstanceName,
1939             String routerInterfacePortId, String vpnName) {
1940         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1941         elanInstanceRouterPortMap.put(elanInstanceName, routerInterfacePortId);
1942         Set<BigInteger> dpnList = getDpnInElan(elanInstanceRouterPortMap);
1943         for (BigInteger dpnId : dpnList) {
1944             for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1945                 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
1946                         vpnName, dpnId);
1947             }
1948         }
1949
1950     }
1951
1952     Set<BigInteger> getDpnInElan(Map<String,String> elanInstanceRouterPortMap) {
1953         Set<BigInteger> dpnIdSet = new HashSet<>();
1954         for (String elanInstanceName : elanInstanceRouterPortMap.keySet()) {
1955             InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationalDataPath(
1956                     elanInstanceName);
1957             Optional<ElanDpnInterfacesList> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL,
1958                     elanDpnInterfaceId);
1959             if (dpnInElanInterfaces.isPresent()) {
1960                 List<DpnInterfaces> dpnInterfaces =
1961                     requireNonNullElse(dpnInElanInterfaces.get().getDpnInterfaces(), emptyList());
1962                 for (DpnInterfaces dpnInterface : dpnInterfaces) {
1963                     dpnIdSet.add(dpnInterface.getDpId());
1964                 }
1965             }
1966         }
1967         return dpnIdSet;
1968     }
1969
1970     void addRouterPortToElanDpn(String elanInstanceName, String routerInterfacePortId, BigInteger dpnId) {
1971         InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
1972                 elanInstanceName,dpnId);
1973         synchronized (elanInstanceName.intern()) {
1974             Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
1975             List<String> elanInterfaceList;
1976             DpnInterfaces dpnInterface;
1977             if (!dpnInElanInterfaces.isPresent()) {
1978                 elanInterfaceList = new ArrayList<>();
1979             } else {
1980                 dpnInterface = dpnInElanInterfaces.get();
1981                 elanInterfaceList = dpnInterface.getInterfaces();
1982             }
1983             if (!elanInterfaceList.contains(routerInterfacePortId)) {
1984                 elanInterfaceList.add(routerInterfacePortId);
1985                 dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
1986                         .withKey(new DpnInterfacesKey(dpnId)).build();
1987                 syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
1988             }
1989         }
1990
1991     }
1992
1993     void removeRouterPortFromElanDpn(String elanInstanceName, String routerInterfacePortId,
1994             String vpnName, BigInteger dpnId) {
1995         InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
1996                 elanInstanceName,dpnId);
1997         synchronized (elanInstanceName.intern()) {
1998             Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
1999             List<String> elanInterfaceList;
2000             DpnInterfaces dpnInterface;
2001             if (!dpnInElanInterfaces.isPresent()) {
2002                 LOG.info("No interface in any dpn for {}", vpnName);
2003                 return;
2004             } else {
2005                 dpnInterface = dpnInElanInterfaces.get();
2006                 elanInterfaceList = dpnInterface.getInterfaces();
2007             }
2008             if (!elanInterfaceList.contains(routerInterfacePortId)) {
2009                 LOG.info("Router port not present in DPN {} for VPN {}", dpnId, vpnName);
2010                 return;
2011             }
2012             elanInterfaceList.remove(routerInterfacePortId);
2013             dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2014                     .withKey(new DpnInterfacesKey(dpnId)).build();
2015             syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
2016         }
2017
2018     }
2019
2020     @Nullable
2021     ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName) {
2022         InstanceIdentifier<ElanInterface> elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName);
2023         return read(LogicalDatastoreType.CONFIGURATION, elanInterfaceId).orNull();
2024     }
2025
2026     static InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName) {
2027         return InstanceIdentifier.builder(ElanInterfaces.class)
2028                 .child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build();
2029     }
2030
2031     @Nullable
2032     DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) {
2033         InstanceIdentifier<DpnInterfaces> elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName,
2034                 dpId);
2035         return read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId).orNull();
2036     }
2037
2038     @Nullable
2039     String getExternalElanInterface(String elanInstanceName, BigInteger dpnId) {
2040         DpnInterfaces dpnInterfaces = getElanInterfaceInfoByElanDpn(elanInstanceName, dpnId);
2041         if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null) {
2042             LOG.info("Elan {} does not have interfaces in DPN {}", elanInstanceName, dpnId);
2043             return null;
2044         }
2045
2046         for (String dpnInterface : dpnInterfaces.getInterfaces()) {
2047             if (interfaceManager.isExternalInterface(dpnInterface)) {
2048                 return dpnInterface;
2049             }
2050         }
2051         return null;
2052     }
2053
2054     static boolean isVlan(ElanInstance elanInstance) {
2055         return elanInstance != null && elanInstance.getSegmentType() != null
2056                 && elanInstance.getSegmentType().isAssignableFrom(SegmentTypeVlan.class)
2057                 && elanInstance.getSegmentationId() != null && elanInstance.getSegmentationId() != 0;
2058     }
2059
2060     boolean isVlan(String interfaceName) {
2061         ElanInterface elanInterface = getElanInterfaceByElanInterfaceName(interfaceName);
2062         if (elanInterface == null) {
2063             return false;
2064         }
2065         ElanInstance  elanInstance = getElanInstanceByName(elanInterface.getElanInstanceName());
2066         return isVlan(elanInstance);
2067     }
2068
2069     @Nullable
2070     ElanInstance getElanInstanceByName(String elanInstanceName) {
2071         InstanceIdentifier<ElanInstance> elanIdentifierId =
2072                 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName);
2073         return read(LogicalDatastoreType.CONFIGURATION, elanIdentifierId).orNull();
2074     }
2075
2076     @Nullable
2077     String getVpnNameFromElanIntanceName(String elanInstanceName) {
2078         Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2079         if (subnetMapsData.isPresent()) {
2080             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2081             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2082                 for (Subnetmap subnet : subnetMapList) {
2083                     if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2084                         if (subnet.getVpnId() != null) {
2085                             return subnet.getVpnId().getValue();
2086                         }
2087                     }
2088                 }
2089             }
2090         }
2091         return null;
2092     }
2093
2094     Map<String, String> getElanInstanceRouterPortMap(String vpnName) {
2095         Map<String, String> elanInstanceRouterPortMap = new HashMap<>();
2096         Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2097         if (subnetMapsData.isPresent()) {
2098             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2099             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2100                 for (Subnetmap subnet : subnetMapList) {
2101                     if (subnet.getVpnId() != null && subnet.getVpnId().getValue().equals(vpnName)
2102                             && NetworkType.VLAN.equals(subnet.getNetworkType())) {
2103                         if (subnet.getRouterInterfacePortId() == null || subnet.getNetworkId() == null) {
2104                             LOG.warn("The RouterInterfacePortId or NetworkId is null");
2105                             continue;
2106                         }
2107                         String routerInterfacePortUuid = subnet.getRouterInterfacePortId().getValue();
2108                         if (routerInterfacePortUuid != null && !routerInterfacePortUuid.isEmpty()) {
2109                             elanInstanceRouterPortMap.put(subnet.getNetworkId().getValue(),routerInterfacePortUuid);
2110                         }
2111                     }
2112                 }
2113             }
2114         }
2115         return elanInstanceRouterPortMap;
2116     }
2117
2118     @Nullable
2119     String getRouterPordIdFromElanInstance(String elanInstanceName) {
2120         Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2121         if (subnetMapsData.isPresent()) {
2122             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2123             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2124                 for (Subnetmap subnet : subnetMapList) {
2125                     if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2126                         if (subnet.getRouterInterfacePortId() != null) {
2127                             return subnet.getRouterInterfacePortId().getValue();
2128                         }
2129                     }
2130                 }
2131             }
2132         }
2133         return null;
2134     }
2135
2136     boolean shouldPopulateFibForVlan(String vpnName, @Nullable String elanInstanceName, BigInteger dpnId) {
2137         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
2138         boolean shouldPopulateFibForVlan = false;
2139         if (!elanInstanceRouterPortMap.isEmpty()) {
2140             shouldPopulateFibForVlan = true;
2141         }
2142         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap
2143                 .entrySet()) {
2144             String currentElanInstance = elanInstanceRouterEntry.getKey();
2145             if (elanInstanceName != null && elanInstanceName.equals(currentElanInstance)) {
2146                 continue;
2147             }
2148             String externalinterface = getExternalElanInterface(currentElanInstance ,dpnId);
2149             if (externalinterface == null) {
2150                 shouldPopulateFibForVlan = false;
2151                 break;
2152             }
2153         }
2154         return shouldPopulateFibForVlan;
2155     }
2156
2157     public static InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName,
2158             BigInteger dpId) {
2159         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2160                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2161                 .child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build();
2162     }
2163
2164     public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationalDataPath(String elanInstanceName) {
2165         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2166                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2167                 .build();
2168     }
2169
2170     public static boolean isMatchedPrefixToInterface(Prefixes prefix, VpnInterfaceOpDataEntry vpnInterface) {
2171         if (prefix != null && vpnInterface != null) {
2172             if (prefix.getDpnId() != null && vpnInterface.getDpnId() != null) {
2173                 if (prefix.getVpnInterfaceName() != null && vpnInterface.getName() != null) {
2174                     return prefix.getDpnId().equals(vpnInterface.getDpnId())
2175                             && prefix.getVpnInterfaceName().equalsIgnoreCase(vpnInterface.getName());
2176                 }
2177             }
2178         }
2179         return false;
2180     }
2181
2182     public static void sendNeighborSolicationToOfGroup(Ipv6NdUtilService ipv6NdUtilService, Ipv6Address srcIpv6Address,
2183             MacAddress srcMac, Ipv6Address dstIpv6Address, Long ofGroupId, BigInteger dpId) {
2184         SendNeighborSolicitationToOfGroupInput input = new SendNeighborSolicitationToOfGroupInputBuilder()
2185                 .setSourceIpv6(srcIpv6Address).setSourceLlAddress(srcMac).setTargetIpAddress(dstIpv6Address)
2186                 .setOfGroupId(ofGroupId).setDpId(dpId).build();
2187         try {
2188             Future<RpcResult<SendNeighborSolicitationToOfGroupOutput>> result = ipv6NdUtilService
2189                     .sendNeighborSolicitationToOfGroup(input);
2190             RpcResult<SendNeighborSolicitationToOfGroupOutput> rpcResult = result.get();
2191             if (!rpcResult.isSuccessful()) {
2192                 LOG.error("sendNeighborSolicitationToOfGroup: RPC Call failed for input={} and Errors={}", input,
2193                         rpcResult.getErrors());
2194             }
2195         } catch (InterruptedException | ExecutionException e) {
2196             LOG.error("Failed to send NS packet to ELAN group, input={}", input, e);
2197         }
2198     }
2199
2200     Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets.VpnTarget>
2201         getRtListForVpn(String vpnName) {
2202         Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets
2203                 .VpnTarget> rtList = new HashSet<>();
2204         InstanceIdentifier<VpnInstance> vpnInstanceId = InstanceIdentifier.builder(VpnInstances.class)
2205                 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
2206         Optional<VpnInstance> vpnInstanceOptional = read(LogicalDatastoreType.CONFIGURATION, vpnInstanceId);
2207         if (vpnInstanceOptional.isPresent()) {
2208             org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.VpnTargets
2209                     vpnTargets = vpnInstanceOptional.get().getIpv4Family().getVpnTargets();
2210             if (vpnTargets != null && vpnTargets.getVpnTarget() != null) {
2211                 rtList.addAll(vpnTargets.getVpnTarget());
2212             }
2213         }
2214         else {
2215             LOG.error("getRtListForVpn: Vpn Instance {} not present in config DS", vpnName);
2216         }
2217         return rtList;
2218     }
2219
2220     static InstanceIdentifier<AssociatedVpn> getAssociatedSubnetAndVpnIdentifier(String rt, RouteTarget.RtType rtType,
2221                                                                                  String cidr, String vpnName) {
2222         return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2223                 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr))
2224                 .child(AssociatedVpn.class, new AssociatedVpnKey(vpnName)).build();
2225     }
2226
2227     static InstanceIdentifier<AssociatedSubnet> getAssociatedSubnetIdentifier(String rt, RouteTarget.RtType rtType,
2228                                                                        String cidr) {
2229         return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2230                 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr)).build();
2231     }
2232
2233     static AssociatedVpn buildAssociatedSubnetAndVpn(String vpnName) {
2234         return new AssociatedVpnBuilder().setName(vpnName).build();
2235     }
2236
2237     static InstanceIdentifier<RouteTarget> getRouteTargetsIdentifier(String rt, RouteTarget.RtType rtType) {
2238         return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class)
2239                 .child(RouteTarget.class, new RouteTargetKey(rt, rtType)).build();
2240     }
2241
2242     Set<RouteTarget> getRouteTargetSet(Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815
2243             .vpn.af.config.vpntargets.VpnTarget> vpnTargets) {
2244         Set<RouteTarget> routeTargetSet = new HashSet<>();
2245         for (org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets
2246                 .VpnTarget rt : vpnTargets) {
2247             String rtValue = rt.getVrfRTValue();
2248             switch (rt.getVrfRTType()) {
2249                 case ImportExtcommunity: {
2250                     Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2251                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2252                     if (exportRouteTargetOptional.isPresent()) {
2253                         routeTargetSet.add(exportRouteTargetOptional.get());
2254                     }
2255                     break;
2256                 }
2257                 case ExportExtcommunity: {
2258                     Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2259                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2260                     if (importRouteTargetOptional.isPresent()) {
2261                         routeTargetSet.add(importRouteTargetOptional.get());
2262                     }
2263                     break;
2264                 }
2265                 case Both: {
2266                     Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2267                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2268                     if (exportRouteTargetOptional.isPresent()) {
2269                         routeTargetSet.add(exportRouteTargetOptional.get());
2270                     }
2271                     Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2272                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2273                     if (importRouteTargetOptional.isPresent()) {
2274                         routeTargetSet.add(importRouteTargetOptional.get());
2275                     }
2276                     break;
2277                 }
2278                 default:
2279                     LOG.error("getRouteTargetSet: Invalid rt-type {}", rt.getVrfRTType());
2280             }
2281         }
2282         return routeTargetSet;
2283     }
2284
2285     /*
2286     TODO: (vivek/kiran): Subnet overlap in a VPN detection logic should use subnet allocation pools if available
2287            rather than only CIDR.
2288            Also the Subnet overlap in a VPN detection logic to be addressed for router-based-l3vpns.
2289     */
2290     static boolean areSubnetsOverlapping(String cidr1, String cidr2) {
2291         final int slash1 = cidr1.indexOf('/');
2292         final int address1 = addressForCidr(cidr1, slash1);
2293         final int cidrPart1 = maskForCidr(cidr1, slash1);
2294
2295         final int slash2 = cidr2.indexOf('/');
2296         final int address2 = addressForCidr(cidr2, slash2);
2297         final int cidrPart2 = maskForCidr(cidr2, slash2);
2298
2299         final int comparedValue = cidrPart1 <= cidrPart2 ? compare(address1, cidrPart1, address2)
2300                 : compare(address2, cidrPart2, address1);
2301         return comparedValue == 0;
2302     }
2303
2304     private static int addressForCidr(String cidr, int slash) {
2305         return InetAddresses.coerceToInteger(InetAddresses.forString(cidr.substring(0, slash)));
2306     }
2307
2308     private static int maskForCidr(String cidr, int slash) {
2309         return Integer.parseInt(cidr.substring(slash + 1));
2310     }
2311
2312     private static int compare(int address, int cidrPart, int address2) {
2313         int prefix = address2 & computeNetmask(cidrPart);
2314         return address ^ prefix;
2315     }
2316
2317     private static int computeNetmask(int cidrPart) {
2318         int netmask = 0;
2319         for (int j = 0; j < cidrPart; ++j) {
2320             netmask |= 1 << 31 - j;
2321         }
2322         return netmask;
2323     }
2324
2325     public static String buildIpMonitorJobKey(String ip, String vpnName) {
2326         return VpnConstants.IP_MONITOR_JOB_PREFIX_KEY + "-" + vpnName + "-" + ip;
2327     }
2328
2329     public static List<String> getVpnListForVpnInterface(VpnInterface vpnInter) {
2330         return requireNonNullElse(vpnInter.getVpnInstanceNames(), Collections.<VpnInstanceNames>emptyList()).stream()
2331                 .map(VpnInstanceNames::getVpnName).collect(Collectors.toList());
2332     }
2333
2334     public void updateVpnInstanceWithRdList(String vpnName, List<String> updatedRdList) {
2335         String primaryRd = getVpnRd(vpnName);
2336         if (primaryRd == null) {
2337             LOG.warn("updateVpnInstanceWithRdList: Unable to retrieve primary RD for the VPN {}. Skip to process "
2338                     + "the updated RD list {} ", vpnName, updatedRdList);
2339             return;
2340         }
2341         jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
2342             VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd);
2343             builder.setRd(updatedRdList);
2344             return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
2345                     OPERATIONAL, tx -> {
2346                     InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
2347                             .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
2348                                     new VpnInstanceOpDataEntryKey(primaryRd)).build();
2349                     tx.merge(id, builder.build(), false);
2350                     LOG.debug("updateVpnInstanceWithRdList: Successfully updated the VPN {} with list of RDs {}",
2351                             vpnName, updatedRdList);
2352                 }));
2353         });
2354     }
2355
2356     // Use Objects.requireNonNullElse instead with JDK9+
2357     @Nonnull
2358     public static <T> T requireNonNullElse(@Nullable T obj, @Nonnull T defaultObj) {
2359         return obj != null ? obj : requireNonNull(defaultObj);
2360     }
2361
2362     public static boolean isDualRouterVpnUpdate(List<String> oldVpnListCopy, List<String> newVpnListCopy) {
2363         return oldVpnListCopy.size() == 2 && newVpnListCopy.size() == 3
2364                 || oldVpnListCopy.size() == 3 && newVpnListCopy.size() == 2;
2365     }
2366 }