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

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