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

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