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