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