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