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

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