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