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