vpnservice/vpnmanager/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 com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16
  17 import java.math.BigInteger;
  18 import java.text.SimpleDateFormat;
  19 import java.util.ArrayList;
  20 import java.util.Collections;
  21 import java.util.Date;
  22 import java.util.List;
  23 import java.util.concurrent.ExecutionException;
  24 import java.util.concurrent.Future;
  25 import java.util.stream.Collectors;
  26
  27 import javax.annotation.Nullable;
  28 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  29 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  30 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  31 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  32 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  33 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  34 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
  35 import org.opendaylight.genius.mdsalutil.FlowEntity;
  36 import org.opendaylight.genius.mdsalutil.FlowEntityBuilder;
  37 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  38 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  39 import org.opendaylight.genius.mdsalutil.MatchInfo;
  40 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  41 import org.opendaylight.genius.mdsalutil.NwConstants;
  42 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
  43 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
  44 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
  45 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  46 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
  47 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
  48 import org.opendaylight.genius.utils.ServiceIndex;
  49 import org.opendaylight.genius.utils.cache.DataStoreCache;
  50 import org.opendaylight.genius.utils.clustering.ClusteringUtils;
  51 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
  52 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
  53 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
  54 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
  55 import org.opendaylight.netvirt.vpnmanager.utilities.InterfaceUtils;
  56 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
  57 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  58 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  59 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  60 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  61 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  62 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.IfIndexesInterfaceMap;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInput;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInputBuilder;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexOutput;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.LockManagerService;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TimeUnits;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInput;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInput;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInputBuilder;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanTagNameMap;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsBuilder;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsKey;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.Adjacencies;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesBuilder;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.PrefixToInterface;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.RouterInterfaces;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetOpData;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnIdToVpnInstance;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnToExtraroutes;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.AdjacencyKey;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortBuilder;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsBuilder;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterface;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceBuilder;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceKey;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntry;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntryKey;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnKey;
 142 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
 143 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder;
 144 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
 145 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalNetworks;
 146 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
 147 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.NaptSwitches;
 148 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
 149 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
 150 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIps;
 151 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.Networks;
 152 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.NetworksKey;
 153 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
 154 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitch;
 155 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitchKey;
 156 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
 157 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
 158 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.RouterInterfacesMap;
 159 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 160 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
 161 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
 162 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
 163 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
 164 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 165 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
 166 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
 167 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
 168 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
 169 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
 170 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 171 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 172 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 173 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 174 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 175 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 176 import org.opendaylight.yangtools.yang.binding.DataObject;
 177 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 178 import org.opendaylight.yangtools.yang.common.RpcResult;
 179 import org.opendaylight.yangtools.yang.data.impl.schema.tree.SchemaValidationFailedException;
 180 import org.slf4j.Logger;
 181 import org.slf4j.LoggerFactory;
 182
 183 public class VpnUtil {
 184     private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
 185     private static final int DEFAULT_PREFIX_LENGTH = 32;
 186     private static final String PREFIX_SEPARATOR = "/";
 187
 188     static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
 189         return InstanceIdentifier.builder(VpnInterfaces.class)
 190             .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
 191     }
 192
 193     static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
 194         return InstanceIdentifier.builder(VpnInstances.class)
 195             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 196     }
 197
 198     static VpnInterface getVpnInterface(DataBroker broker, String vpnInterfaceName) {
 199         InstanceIdentifier<VpnInterface> id = getVpnInterfaceIdentifier(vpnInterfaceName);
 200         Optional<VpnInterface> vpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 201         return vpnInterface.isPresent() ? vpnInterface.get() : null;
 202     }
 203
 204     static VpnInterface getVpnInterface(String intfName, String vpnName, Adjacencies aug, BigInteger dpnId,
 205         Boolean isSheduledForRemove) {
 206         return new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(intfName)).setVpnInstanceName(vpnName).setDpnId(
 207             dpnId)
 208             .setScheduledForRemove(isSheduledForRemove).addAugmentation(Adjacencies.class, aug)
 209             .build();
 210     }
 211
 212     static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
 213         return InstanceIdentifier.builder(PrefixToInterface.class)
 214             .child(VpnIds.class, new VpnIdsKey(vpnId)).child(Prefixes.class,
 215                 new PrefixesKey(ipPrefix)).build();
 216     }
 217
 218     static InstanceIdentifier<VpnIds> getPrefixToInterfaceIdentifier(long vpnId) {
 219         return InstanceIdentifier.builder(PrefixToInterface.class)
 220             .child(VpnIds.class, new VpnIdsKey(vpnId)).build();
 221     }
 222
 223     static VpnIds getPrefixToInterface(long vpnId) {
 224         return new VpnIdsBuilder().setKey(new VpnIdsKey(vpnId)).setVpnId(vpnId).build();
 225     }
 226
 227     static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix, Uuid subnetId,
 228             boolean isNatPrefix) {
 229         return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
 230             vpnInterfaceName).setIpAddress(ipPrefix).setSubnetId(subnetId).setNatPrefix(isNatPrefix).build();
 231     }
 232
 233     static Optional<Prefixes> getPrefixToInterface(DataBroker broker, long vpnId, String ipPrefix) {
 234         return read(broker, LogicalDatastoreType.OPERATIONAL,
 235                 getPrefixToInterfaceIdentifier(vpnId, getIpPrefix(ipPrefix)));
 236     }
 237
 238     /**
 239      * Get VRF table given a Route Distinguisher.
 240      *
 241      * @param broker dataBroker service reference
 242      * @param rd Route-Distinguisher
 243      * @return VrfTables that holds the list of VrfEntries of the specified rd
 244      */
 245     public static VrfTables getVrfTable(DataBroker broker, String rd) {
 246         InstanceIdentifier<VrfTables> id =
 247             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 248         Optional<VrfTables> vrfTable = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 249         return vrfTable.isPresent() ? vrfTable.get() : null;
 250     }
 251
 252     /**
 253      * Retrieves the VrfEntries that belong to a given VPN filtered out by
 254      * Origin, searching by its Route-Distinguisher.
 255      *
 256      * @param broker dataBroker service reference
 257      * @param rd Route-distinguisher of the VPN
 258      * @param originsToConsider Only entries whose origin is included in this list will be considered
 259      * @return the list of VrfEntries
 260      */
 261     public static List<VrfEntry> getVrfEntriesByOrigin(DataBroker broker, String rd,
 262         List<RouteOrigin> originsToConsider) {
 263         List<VrfEntry> result = new ArrayList<>();
 264         List<VrfEntry> allVpnVrfEntries = getAllVrfEntries(broker, rd);
 265         for (VrfEntry vrfEntry : allVpnVrfEntries) {
 266             if (originsToConsider.contains(RouteOrigin.value(vrfEntry.getOrigin()))) {
 267                 result.add(vrfEntry);
 268             }
 269         }
 270         return result;
 271     }
 272
 273     static List<Prefixes> getAllPrefixesToInterface(DataBroker broker, long vpnId) {
 274         Optional<VpnIds> vpnIds = read(broker, LogicalDatastoreType.OPERATIONAL, getPrefixToInterfaceIdentifier(vpnId));
 275         if (vpnIds.isPresent()) {
 276             return vpnIds.get().getPrefixes();
 277         }
 278         return new ArrayList<>();
 279     }
 280
 281     /**
 282      * Retrieves all the VrfEntries that belong to a given VPN searching by its
 283      * Route-Distinguisher.
 284      *
 285      * @param broker dataBroker service reference
 286      * @param rd Route-distinguisher of the VPN
 287      * @return the list of VrfEntries
 288      */
 289     public static List<VrfEntry> getAllVrfEntries(DataBroker broker, String rd) {
 290         VrfTables vrfTables = VpnUtil.getVrfTable(broker, rd);
 291         return vrfTables != null ? vrfTables.getVrfEntry() : new ArrayList<>();
 292     }
 293
 294     //FIXME: Implement caches for DS reads
 295     public static VpnInstance getVpnInstance(DataBroker broker, String vpnInstanceName) {
 296         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
 297             new VpnInstanceKey(vpnInstanceName)).build();
 298         Optional<VpnInstance> vpnInstance = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 299         return vpnInstance.isPresent() ? vpnInstance.get() : null;
 300     }
 301
 302     static List<VpnInstanceOpDataEntry> getAllVpnInstanceOpData(DataBroker broker) {
 303         InstanceIdentifier<VpnInstanceOpData> id = InstanceIdentifier.builder(VpnInstanceOpData.class).build();
 304         Optional<VpnInstanceOpData> vpnInstanceOpDataOptional =
 305             VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, id);
 306         if (vpnInstanceOpDataOptional.isPresent()) {
 307             return vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry();
 308         } else {
 309             return new ArrayList<>();
 310         }
 311     }
 312
 313     public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn
 314         .instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces> getDpnVpnInterfaces(DataBroker broker,
 315         VpnInstance vpnInstance, BigInteger dpnId) {
 316         String primaryRd = getPrimaryRd(vpnInstance);
 317         InstanceIdentifier<VpnToDpnList> dpnToVpnId = getVpnToDpnListIdentifier(primaryRd, dpnId);
 318         Optional<VpnToDpnList> dpnInVpn = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, dpnToVpnId);
 319         return dpnInVpn.isPresent() ? dpnInVpn.get().getVpnInterfaces() : Collections.emptyList();
 320     }
 321
 322     public static List<String> getListOfRdsFromVpnInstance(VpnInstance vpnInstance) {
 323         VpnAfConfig vpnConfig = vpnInstance.getIpv4Family();
 324         LOG.trace("vpnConfig {}", vpnConfig);
 325         return vpnConfig.getRouteDistinguisher() != null ? new ArrayList<>(
 326                 vpnConfig.getRouteDistinguisher()) : new ArrayList<>();
 327     }
 328
 329     static VrfEntry getVrfEntry(DataBroker broker, String rd, String ipPrefix) {
 330
 331         VrfTables vrfTable = getVrfTable(broker, rd);
 332         // TODO: why check VrfTables if we later go for the specific VrfEntry?
 333         if (vrfTable != null) {
 334             InstanceIdentifier<VrfEntry> vrfEntryId =
 335                 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).child(
 336                     VrfEntry.class, new VrfEntryKey(ipPrefix)).build();
 337             Optional<VrfEntry> vrfEntry = read(broker, LogicalDatastoreType.CONFIGURATION, vrfEntryId);
 338             if (vrfEntry.isPresent()) {
 339                 return vrfEntry.get();
 340             }
 341         }
 342         return null;
 343     }
 344
 345     static List<Adjacency> getAdjacenciesForVpnInterfaceFromConfig(DataBroker broker, String intfName) {
 346         final InstanceIdentifier<VpnInterface> identifier = getVpnInterfaceIdentifier(intfName);
 347         InstanceIdentifier<Adjacencies> path = identifier.augmentation(Adjacencies.class);
 348         Optional<Adjacencies> adjacencies = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, path);
 349
 350         if (adjacencies.isPresent()) {
 351             List<Adjacency> nextHops = adjacencies.get().getAdjacency();
 352             return nextHops;
 353         }
 354         return null;
 355     }
 356
 357     static  Routes getVpnToExtraroute(String ipPrefix, List<String> nextHopList) {
 358         return new RoutesBuilder().setPrefix(ipPrefix).setNexthopIpList(nextHopList).build();
 359     }
 360
 361     static String getVpnInterfaceName(OdlInterfaceRpcService odlInterfaceRpcService, BigInteger metadata)
 362             throws InterruptedException, ExecutionException {
 363         GetInterfaceFromIfIndexInputBuilder ifIndexInputBuilder = new GetInterfaceFromIfIndexInputBuilder();
 364         BigInteger lportTag = MetaDataUtil.getLportFromMetadata(metadata);
 365         ifIndexInputBuilder.setIfIndex(lportTag.intValue());
 366         GetInterfaceFromIfIndexInput input = ifIndexInputBuilder.build();
 367         Future<RpcResult<GetInterfaceFromIfIndexOutput>> interfaceFromIfIndex =
 368                 odlInterfaceRpcService.getInterfaceFromIfIndex(input);
 369         GetInterfaceFromIfIndexOutput interfaceFromIfIndexOutput;
 370         RpcResult<GetInterfaceFromIfIndexOutput> rpcResult = interfaceFromIfIndex.get();
 371         if (rpcResult == null) {
 372             return null;
 373         }
 374
 375         interfaceFromIfIndexOutput = rpcResult.getResult();
 376         String interfaceName = interfaceFromIfIndexOutput.getInterfaceName();
 377         return interfaceName;
 378     }
 379
 380     static AllocatedRdsBuilder getRdsBuilder(String nexthop, String rd) {
 381         return new AllocatedRdsBuilder().setKey(new AllocatedRdsKey(nexthop)).setNexthop(nexthop).setRd(rd);
 382     }
 383
 384     static Adjacencies getVpnInterfaceAugmentation(List<Adjacency> nextHopList) {
 385         return new AdjacenciesBuilder().setAdjacency(nextHopList).build();
 386     }
 387
 388     public static InstanceIdentifier<IdPool> getPoolId(String poolName) {
 389         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
 390             InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
 391         InstanceIdentifier<IdPool> id = idBuilder.build();
 392         return id;
 393     }
 394
 395     static InstanceIdentifier<VpnInterfaces> getVpnInterfacesIdentifier() {
 396         return InstanceIdentifier.builder(VpnInterfaces.class).build();
 397     }
 398
 399     static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
 400         return InstanceIdentifier.builder(Interfaces.class)
 401             .child(Interface.class, new InterfaceKey(interfaceName)).build();
 402     }
 403
 404     static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) {
 405         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 406             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd))
 407             .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build();
 408     }
 409
 410     public static BigInteger getCookieArpFlow(int interfaceTag) {
 411         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0110000", 16)).add(
 412             BigInteger.valueOf(interfaceTag));
 413     }
 414
 415     public static BigInteger getCookieL3(int vpnId) {
 416         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0610000", 16)).add(BigInteger.valueOf(vpnId));
 417     }
 418
 419     public static String getFlowRef(BigInteger dpnId, short tableId, int ethType, int lportTag, int arpType) {
 420         return new StringBuffer().append(VpnConstants.FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
 421             .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(ethType).append(lportTag)
 422             .append(NwConstants.FLOWID_SEPARATOR).append(arpType).toString();
 423     }
 424
 425     public static int getUniqueId(IdManagerService idManager, String poolName, String idKey) {
 426         AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 427
 428         try {
 429             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 430             RpcResult<AllocateIdOutput> rpcResult = result.get();
 431             if (rpcResult.isSuccessful()) {
 432                 return rpcResult.getResult().getIdValue().intValue();
 433             } else {
 434                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 435             }
 436         } catch (InterruptedException | ExecutionException e) {
 437             LOG.warn("Exception when getting Unique Id", e);
 438         }
 439         return 0;
 440     }
 441
 442     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
 443         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 444         try {
 445             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 446             RpcResult<Void> rpcResult = result.get();
 447             if (!rpcResult.isSuccessful()) {
 448                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 449             }
 450         } catch (InterruptedException | ExecutionException e) {
 451             LOG.warn("Exception when getting Unique Id for key {}", idKey, e);
 452         }
 453     }
 454
 455     public static String getNextHopLabelKey(String rd, String prefix) {
 456         return rd + VpnConstants.SEPARATOR + prefix;
 457     }
 458
 459     /**
 460      * Retrieves the VpnInstance name (typically the VPN Uuid) out from the
 461      * route-distinguisher.
 462      *
 463      * @param broker dataBroker service reference
 464      * @param rd Route-Distinguisher
 465      * @return the VpnInstance name
 466      */
 467     public static String getVpnNameFromRd(DataBroker broker, String rd) {
 468         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(broker, rd);
 469         return vpnInstanceOpData != null ? vpnInstanceOpData.getVpnInstanceName() : null;
 470     }
 471
 472     /**
 473      * Retrieves the dataplane identifier of a specific VPN, searching by its
 474      * VpnInstance name.
 475      *
 476      * @param broker dataBroker service reference
 477      * @param vpnName Name of the VPN
 478      * @return the dataplane identifier of the VPN, the VrfTag.
 479      */
 480     public static long getVpnId(DataBroker broker, String vpnName) {
 481
 482         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 483                     .VpnInstance> vpnInstance =
 484             read(broker, LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 485
 486         long vpnId = VpnConstants.INVALID_ID;
 487         if (vpnInstance.isPresent()) {
 488             vpnId = vpnInstance.get().getVpnId();
 489         }
 490         return vpnId;
 491     }
 492
 493     /**
 494      * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
 495      *
 496      * @param broker dataBroker service reference
 497      * @param vpnName Name of the VPN
 498      * @return the route-distinguisher of the VPN
 499      */
 500     public static String getVpnRd(DataBroker broker, String vpnName) {
 501         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 502             .VpnInstance>
 503             vpnInstance
 504             = read(broker, LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 505
 506         String rd = null;
 507         if (vpnInstance.isPresent()) {
 508             rd = vpnInstance.get().getVrfId();
 509         }
 510         return rd;
 511     }
 512
 513     private static List<String> getVpnRdsFromVpnInstanceConfig(DataBroker broker, String vpnName) {
 514         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
 515             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 516         Optional<VpnInstance> vpnInstance = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 517         return vpnInstance.isPresent() ? getListOfRdsFromVpnInstance(vpnInstance.get()) : new ArrayList<>();
 518     }
 519
 520     /**
 521      * Remove from MDSAL all those VrfEntries in a VPN that have an specific RouteOrigin.
 522      *
 523      * @param broker dataBroker service reference
 524      * @param rd Route Distinguisher
 525      * @param origin Origin of the Routes to be removed (see {@link RouteOrigin})
 526      */
 527     public static void removeVrfEntriesByOrigin(DataBroker broker, String rd, RouteOrigin origin) {
 528         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 529             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 530         Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 531         if (vrfTablesOpc.isPresent()) {
 532             VrfTables vrfTables = vrfTablesOpc.get();
 533             WriteTransaction tx = broker.newWriteOnlyTransaction();
 534             for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
 535                 if (origin == RouteOrigin.value(vrfEntry.getOrigin())) {
 536                     tx.delete(LogicalDatastoreType.CONFIGURATION,
 537                             vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
 538                 }
 539             }
 540             tx.submit();
 541         }
 542     }
 543
 544     public static List<VrfEntry> findVrfEntriesByNexthop(DataBroker broker, String rd, String nexthop) {
 545         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 546             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 547         Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 548         List<VrfEntry> matches = new ArrayList<>();
 549
 550         if (vrfTablesOpc.isPresent()) {
 551             VrfTables vrfTables = vrfTablesOpc.get();
 552             for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
 553                 vrfEntry.getRoutePaths().stream()
 554                         .filter(routePath -> routePath.getNexthopAddress() != null
 555                                 && routePath.getNexthopAddress().equals(nexthop))
 556                         .findFirst().ifPresent(routePath -> matches.add(vrfEntry));
 557             }
 558         }
 559         return matches;
 560     }
 561
 562     public static void removeVrfEntries(DataBroker broker, String rd, List<VrfEntry> vrfEntries) {
 563         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 564             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 565         WriteTransaction tx = broker.newWriteOnlyTransaction();
 566         for (VrfEntry vrfEntry : vrfEntries) {
 567             tx.delete(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
 568         }
 569         tx.submit();
 570     }
 571
 572     // TODO Clean up the exception handling
 573     @SuppressWarnings("checkstyle:IllegalCatch")
 574     public static void withdrawRoutes(IBgpManager bgpManager, String rd, List<VrfEntry> vrfEntries) {
 575         vrfEntries.forEach(vrfEntry -> {
 576             try {
 577                 bgpManager.withdrawPrefix(rd, vrfEntry.getDestPrefix());
 578             } catch (Exception e) {
 579                 LOG.error("Could not withdraw route to {} with route-paths {} in VpnRd {}",
 580                           vrfEntry.getDestPrefix(), vrfEntry.getRoutePaths(), rd);
 581             }
 582         });
 583     }
 584
 585     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
 586         getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
 587         return new VpnInstanceBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
 588
 589     }
 590
 591     static RouterInterface getConfiguredRouterInterface(DataBroker broker, String interfaceName) {
 592         Optional<RouterInterface> optRouterInterface =
 593             read(broker, LogicalDatastoreType.CONFIGURATION, VpnUtil.getRouterInterfaceId(interfaceName));
 594         if (optRouterInterface.isPresent()) {
 595             return optRouterInterface.get();
 596         }
 597         return null;
 598     }
 599
 600     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
 601         getVpnIdToVpnInstance(long vpnId, String vpnName, String rd, boolean isExternalVpn) {
 602         return new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 603             .VpnIdsBuilder()
 604             .setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).setExternalVpn(isExternalVpn).build();
 605
 606     }
 607
 608     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to
 609         .vpn.instance.VpnIds>
 610         getVpnIdToVpnInstanceIdentifier(long vpnId) {
 611         return InstanceIdentifier.builder(VpnIdToVpnInstance.class)
 612             .child(
 613                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
 614                     .class,
 615                 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 616                     .VpnIdsKey(vpnId)).build();
 617     }
 618
 619     /**
 620      * Retrieves the Vpn Name searching by its VPN Tag.
 621      *
 622      * @param broker dataBroker service reference
 623      * @param vpnId Dataplane identifier of the VPN
 624      * @return the Vpn instance name
 625      */
 626     public static String getVpnName(DataBroker broker, long vpnId) {
 627
 628         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
 629             .instance.VpnIds>
 630             id
 631             = getVpnIdToVpnInstanceIdentifier(vpnId);
 632         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
 633             vpnInstance
 634             = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 635
 636         String vpnName = null;
 637         if (vpnInstance.isPresent()) {
 638             vpnName = vpnInstance.get().getVpnInstanceName();
 639         }
 640         return vpnName;
 641     }
 642
 643     public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
 644         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 645             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
 646     }
 647
 648     static InstanceIdentifier<RouterInterface> getRouterInterfaceId(String interfaceName) {
 649         return InstanceIdentifier.builder(RouterInterfaces.class)
 650             .child(RouterInterface.class, new RouterInterfaceKey(interfaceName)).build();
 651     }
 652
 653     static RouterInterface getRouterInterface(String interfaceName, String routerName) {
 654         return new RouterInterfaceBuilder().setKey(new RouterInterfaceKey(interfaceName))
 655             .setInterfaceName(interfaceName).setRouterName(routerName).build();
 656     }
 657
 658     public static VpnInstanceOpDataEntry getVpnInstanceOpData(DataBroker broker, String rd) {
 659         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
 660         return read(broker, LogicalDatastoreType.OPERATIONAL, id).orNull();
 661     }
 662
 663     static VpnInstanceOpDataEntry getVpnInstanceOpDataFromCache(DataBroker broker, String rd) {
 664         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
 665         return (VpnInstanceOpDataEntry) DataStoreCache.get(VpnConstants.VPN_OP_INSTANCE_CACHE_NAME, id, rd, broker,
 666             false);
 667     }
 668
 669     static VpnInterface getConfiguredVpnInterface(DataBroker broker, String interfaceName) {
 670         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 671         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 672
 673         if (configuredVpnInterface.isPresent()) {
 674             return configuredVpnInterface.get();
 675         }
 676         return null;
 677     }
 678
 679     static String getNeutronRouterFromInterface(DataBroker broker, String interfaceName) {
 680         InstanceIdentifier.InstanceIdentifierBuilder<RouterInterfacesMap> idBuilder =
 681             InstanceIdentifier.builder(RouterInterfacesMap.class);
 682         InstanceIdentifier<RouterInterfacesMap> id = idBuilder.build();
 683         Optional<RouterInterfacesMap> routerInterfacesMap =
 684             MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 685         if (routerInterfacesMap.isPresent()) {
 686             List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 687                 .RouterInterfaces>
 688                 rtrInterfaces = routerInterfacesMap.get().getRouterInterfaces();
 689             for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 690                      .RouterInterfaces rtrInterface : rtrInterfaces) {
 691                 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 692                     .router.interfaces.Interfaces>
 693                     rtrIfc = rtrInterface.getInterfaces();
 694                 for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 695                          .router.interfaces.Interfaces ifc : rtrIfc) {
 696                     if (ifc.getInterfaceId().equals(interfaceName)) {
 697                         return rtrInterface.getRouterId().getValue();
 698                     }
 699                 }
 700             }
 701         }
 702         return null;
 703     }
 704
 705     static VpnInterface getOperationalVpnInterface(DataBroker broker, String interfaceName) {
 706         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 707         Optional<VpnInterface> operationalVpnInterface = read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 708
 709         if (operationalVpnInterface.isPresent()) {
 710             return operationalVpnInterface.get();
 711         }
 712         return null;
 713     }
 714
 715     static boolean isVpnInterfaceConfigured(DataBroker broker, String interfaceName) {
 716         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 717         return read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId).isPresent();
 718     }
 719
 720     static boolean isInterfaceAssociatedWithVpn(DataBroker broker, String vpnName, String interfaceName) {
 721         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 722         Optional<VpnInterface> optConfiguredVpnInterface =
 723             read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 724
 725         if (optConfiguredVpnInterface.isPresent()) {
 726             String configuredVpnName = optConfiguredVpnInterface.get().getVpnInstanceName();
 727             if (configuredVpnName != null && configuredVpnName.equalsIgnoreCase(vpnName)) {
 728                 return true;
 729             }
 730         }
 731         return false;
 732     }
 733
 734     public static String getIpPrefix(String prefix) {
 735         String[] prefixValues = prefix.split("/");
 736         if (prefixValues.length == 1) {
 737             prefix = prefix + PREFIX_SEPARATOR + DEFAULT_PREFIX_LENGTH;
 738         }
 739         return prefix;
 740     }
 741
 742     static final FutureCallback<Void> DEFAULT_CALLBACK =
 743         new FutureCallback<Void>() {
 744             @Override
 745             public void onSuccess(Void result) {
 746                 LOG.debug("Success in Datastore operation");
 747             }
 748
 749             @Override
 750             public void onFailure(Throwable error) {
 751                 LOG.error("Error in Datastore operation", error);
 752             }
 753
 754         };
 755
 756     public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 757                                                           InstanceIdentifier<T> path) {
 758         try (ReadOnlyTransaction tx = broker.newReadOnlyTransaction()) {
 759             return tx.read(datastoreType, path).get();
 760         } catch (InterruptedException | ExecutionException e) {
 761             throw new RuntimeException(e);
 762         }
 763     }
 764
 765     public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 766         InstanceIdentifier<T> path, T data) {
 767         asyncUpdate(broker, datastoreType, path, data, DEFAULT_CALLBACK);
 768     }
 769
 770     public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 771         InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 772         WriteTransaction tx = broker.newWriteOnlyTransaction();
 773         tx.merge(datastoreType, path, data, true);
 774         Futures.addCallback(tx.submit(), callback);
 775     }
 776
 777     public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 778         InstanceIdentifier<T> path, T data) {
 779         asyncWrite(broker, datastoreType, path, data, DEFAULT_CALLBACK);
 780     }
 781
 782     public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 783         InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 784         WriteTransaction tx = broker.newWriteOnlyTransaction();
 785         tx.put(datastoreType, path, data, WriteTransaction.CREATE_MISSING_PARENTS);
 786         Futures.addCallback(tx.submit(), callback);
 787     }
 788
 789     // TODO Clean up the exception handling
 790     @SuppressWarnings("checkstyle:IllegalCatch")
 791     public static <T extends DataObject> void tryDelete(DataBroker broker, LogicalDatastoreType datastoreType,
 792         InstanceIdentifier<T> path) {
 793         try {
 794             delete(broker, datastoreType, path, DEFAULT_CALLBACK);
 795         } catch (SchemaValidationFailedException sve) {
 796             LOG.info("Could not delete {}. SchemaValidationFailedException: {}", path, sve.getMessage());
 797         } catch (Exception e) {
 798             LOG.info("Could not delete {}. Unhandled error: {}", path, e.getMessage());
 799         }
 800     }
 801
 802     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 803         InstanceIdentifier<T> path) {
 804         delete(broker, datastoreType, path, DEFAULT_CALLBACK);
 805     }
 806
 807
 808     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 809         InstanceIdentifier<T> path, FutureCallback<Void> callback) {
 810         WriteTransaction tx = broker.newWriteOnlyTransaction();
 811         tx.delete(datastoreType, path);
 812         Futures.addCallback(tx.submit(), callback);
 813     }
 814
 815     public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 816         InstanceIdentifier<T> path, T data) {
 817         WriteTransaction tx = broker.newWriteOnlyTransaction();
 818         tx.put(datastoreType, path, data, WriteTransaction.CREATE_MISSING_PARENTS);
 819         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 820         try {
 821             futures.get();
 822         } catch (InterruptedException | ExecutionException e) {
 823             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 824             throw new RuntimeException(e.getMessage());
 825         }
 826     }
 827
 828     public static <T extends DataObject> void syncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 829         InstanceIdentifier<T> path, T data) {
 830         WriteTransaction tx = broker.newWriteOnlyTransaction();
 831         tx.merge(datastoreType, path, data, true);
 832         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 833         try {
 834             futures.get();
 835         } catch (InterruptedException | ExecutionException e) {
 836             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 837             throw new RuntimeException(e.getMessage());
 838         }
 839     }
 840
 841     public static long getRemoteBCGroup(long elanTag) {
 842         return VpnConstants.ELAN_GID_MIN + elanTag % VpnConstants.ELAN_GID_MIN * 2;
 843     }
 844
 845     // interface-index-tag operational container
 846     public static IfIndexInterface getInterfaceInfoByInterfaceTag(DataBroker broker, long interfaceTag) {
 847         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
 848         Optional<IfIndexInterface> existingInterfaceInfo =
 849             VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 850         if (existingInterfaceInfo.isPresent()) {
 851             return existingInterfaceInfo.get();
 852         }
 853         return null;
 854     }
 855
 856     private static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
 857         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
 858             new IfIndexInterfaceKey((int) interfaceTag)).build();
 859     }
 860
 861     public static ElanTagName getElanInfoByElanTag(DataBroker broker, long elanTag) {
 862         InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
 863         Optional<ElanTagName> existingElanInfo = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, elanId);
 864         if (existingElanInfo.isPresent()) {
 865             return existingElanInfo.get();
 866         }
 867         return null;
 868     }
 869
 870     private static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
 871         return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
 872             new ElanTagNameKey(elanTag)).build();
 873     }
 874
 875     /**
 876      * Returns the Path identifier to reach a specific interface in a specific DPN in a given VpnInstance.
 877      *
 878      * @param vpnRd Route-Distinguisher of the VpnInstance
 879      * @param dpnId Id of the DPN where the interface is
 880      * @param ifaceName Interface name
 881      * @return the Instance Identifier
 882      */
 883     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 884         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces>
 885         getVpnToDpnInterfacePath(String vpnRd, BigInteger dpnId, String ifaceName) {
 886
 887         return
 888             InstanceIdentifier.builder(VpnInstanceOpData.class)
 889                 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(vpnRd))
 890                 .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId))
 891                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 892                         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces.class,
 893                     new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 894                         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfacesKey(ifaceName))
 895                 .build();
 896     }
 897
 898     // TODO Clean up the exception handling
 899     @SuppressWarnings("checkstyle:IllegalCatch")
 900     public static void removePrefixToInterfaceForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
 901         try {
 902             // Clean up PrefixToInterface Operational DS
 903             if (writeTxn != null) {
 904                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
 905                     InstanceIdentifier.builder(PrefixToInterface.class).child(
 906                         VpnIds.class, new VpnIdsKey(vpnId)).build());
 907             } else {
 908                 delete(broker, LogicalDatastoreType.OPERATIONAL,
 909                     InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class,
 910                         new VpnIdsKey(vpnId)).build(),
 911                     DEFAULT_CALLBACK);
 912             }
 913         } catch (Exception e) {
 914             LOG.error("Exception during cleanup of PrefixToInterface for VPN ID {}", vpnId, e);
 915         }
 916     }
 917
 918     // TODO Clean up the exception handling
 919     @SuppressWarnings("checkstyle:IllegalCatch")
 920     public static void removeVpnExtraRouteForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 921         try {
 922             // Clean up VPNExtraRoutes Operational DS
 923             if (writeTxn != null) {
 924                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
 925                         InstanceIdentifier.builder(VpnToExtraroutes.class)
 926                                 .child(Vpn.class, new VpnKey(vpnName)).build());
 927             } else {
 928                 delete(broker, LogicalDatastoreType.OPERATIONAL,
 929                         InstanceIdentifier.builder(VpnToExtraroutes.class)
 930                                 .child(Vpn.class, new VpnKey(vpnName)).build(),
 931                         DEFAULT_CALLBACK);
 932             }
 933         } catch (Exception e) {
 934             LOG.error("Exception during cleanup of VPNToExtraRoute for VPN {}", vpnName, e);
 935         }
 936     }
 937
 938     // TODO Clean up the exception handling
 939     @SuppressWarnings("checkstyle:IllegalCatch")
 940     public static void removeVpnOpInstance(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 941         try {
 942             // Clean up VPNInstanceOpDataEntry
 943             if (writeTxn != null) {
 944                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName));
 945             } else {
 946                 delete(broker, LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName),
 947                     DEFAULT_CALLBACK);
 948             }
 949         } catch (Exception e) {
 950             LOG.error("Exception during cleanup of VPNInstanceOpDataEntry for VPN {}", vpnName, e);
 951         }
 952     }
 953
 954     // TODO Clean up the exception handling
 955     @SuppressWarnings("checkstyle:IllegalCatch")
 956     public static void removeVpnInstanceToVpnId(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 957         try {
 958             if (writeTxn != null) {
 959                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
 960                                 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 961             } else {
 962                 delete(broker, LogicalDatastoreType.CONFIGURATION,
 963                        VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName),
 964                     DEFAULT_CALLBACK);
 965             }
 966         } catch (Exception e) {
 967             LOG.error("Exception during clean up of VpnInstanceToVpnId for VPN {}", vpnName, e);
 968         }
 969     }
 970
 971     // TODO Clean up the exception handling
 972     @SuppressWarnings("checkstyle:IllegalCatch")
 973     public static void removeVpnIdToVpnInstance(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
 974         try {
 975             if (writeTxn != null) {
 976                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId));
 977             } else {
 978                 delete(broker, LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId),
 979                     DEFAULT_CALLBACK);
 980             }
 981         } catch (Exception e) {
 982             LOG.error("Exception during clean up of VpnIdToVpnInstance for VPNID {}", vpnId, e);
 983         }
 984     }
 985
 986     // TODO Clean up the exception handling
 987     @SuppressWarnings("checkstyle:IllegalCatch")
 988     public static void removeVrfTableForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 989         // Clean up FIB Entries Config DS
 990         try {
 991             if (writeTxn != null) {
 992                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
 993                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
 994                         new VrfTablesKey(vpnName)).build());
 995             } else {
 996                 delete(broker, LogicalDatastoreType.CONFIGURATION,
 997                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
 998                         new VrfTablesKey(vpnName)).build(),
 999                     DEFAULT_CALLBACK);
1000             }
1001         } catch (Exception e) {
1002             LOG.error("Exception during clean up of VrfTable from FIB for VPN {}", vpnName, e);
1003         }
1004     }
1005
1006     // TODO Clean up the exception handling
1007     @SuppressWarnings("checkstyle:IllegalCatch")
1008     public static void removeL3nexthopForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
1009         try {
1010             // Clean up L3NextHop Operational DS
1011             if (writeTxn != null) {
1012                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
1013                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1014                         new VpnNexthopsKey(vpnId)).build());
1015             } else {
1016                 delete(broker, LogicalDatastoreType.OPERATIONAL,
1017                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1018                         new VpnNexthopsKey(vpnId)).build(),
1019                     DEFAULT_CALLBACK);
1020             }
1021         } catch (Exception e) {
1022             LOG.error("Exception during cleanup of L3NextHop for VPN ID {}", vpnId, e);
1023         }
1024     }
1025
1026     public static void scheduleVpnInterfaceForRemoval(DataBroker broker,String interfaceName, BigInteger dpnId,
1027                                                       String vpnInstanceName, Boolean isScheduledToRemove,
1028                                                       WriteTransaction writeOperTxn) {
1029         InstanceIdentifier<VpnInterface> interfaceId = VpnUtil.getVpnInterfaceIdentifier(interfaceName);
1030         VpnInterface interfaceToUpdate =
1031             new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(interfaceName)).setName(interfaceName)
1032                 .setDpnId(dpnId).setVpnInstanceName(vpnInstanceName).setScheduledForRemove(isScheduledToRemove).build();
1033         if (writeOperTxn != null) {
1034             writeOperTxn.merge(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate, true);
1035         } else {
1036             VpnUtil.syncUpdate(broker, LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
1037         }
1038     }
1039
1040     protected static void createLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp, String
1041             portName, String macAddress) {
1042         synchronized ((vpnName + fixedIp).intern()) {
1043             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1044             LearntVpnVipToPortBuilder builder =
1045                     new LearntVpnVipToPortBuilder().setKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
1046                             vpnName).setPortFixedip(fixedIp).setPortName(portName)
1047                             .setMacAddress(macAddress.toLowerCase())
1048                             .setCreationTime(new SimpleDateFormat("MM/dd/yyyy h:mm:ss a").format(new Date()));
1049             MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, id, builder.build());
1050             LOG.debug("ARP learned for fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
1051                     + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress);
1052         }
1053     }
1054
1055     private static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
1056             String fixedIp) {
1057         InstanceIdentifier<LearntVpnVipToPort> id =
1058                 InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
1059                         new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1060         return id;
1061     }
1062
1063     protected static void removeLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
1064         synchronized ((vpnName + fixedIp).intern()) {
1065             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1066             MDSALUtil.syncDelete(broker, LogicalDatastoreType.OPERATIONAL, id);
1067             LOG.debug("Delete learned ARP for fixedIp: {}, vpn {} removed from VpnPortipToPort DS", fixedIp, vpnName);
1068         }
1069     }
1070
1071     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1072         InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1073                 NetworkMapKey(networkId)).build();
1074         return id;
1075     }
1076
1077     static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1078         InstanceIdentifier<SubnetOpDataEntry> subOpIdentifier = InstanceIdentifier.builder(SubnetOpData.class)
1079                 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1080         return subOpIdentifier;
1081     }
1082
1083     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1084         InstanceIdentifier<VpnPortipToPort> id =
1085             InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1086                 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1087         return id;
1088     }
1089
1090     static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(DataBroker broker, String vpnName, String fixedIp) {
1091         InstanceIdentifier id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1092         Optional<VpnPortipToPort> vpnPortipToPortData = read(broker, LogicalDatastoreType.CONFIGURATION, id);
1093         if (vpnPortipToPortData.isPresent()) {
1094             return vpnPortipToPortData.get();
1095         }
1096         return null;
1097     }
1098
1099     static LearntVpnVipToPort getLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
1100         InstanceIdentifier id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1101         Optional<LearntVpnVipToPort> learntVpnVipToPort = read(broker, LogicalDatastoreType.OPERATIONAL, id);
1102         if (learntVpnVipToPort.isPresent()) {
1103             return learntVpnVipToPort.get();
1104         }
1105         return null;
1106     }
1107
1108     public static List<BigInteger> getDpnsOnVpn(DataBroker dataBroker, String vpnInstanceName) {
1109         List<BigInteger> result = new ArrayList<>();
1110         String rd = getVpnRd(dataBroker, vpnInstanceName);
1111         if (rd == null) {
1112             LOG.debug("Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1113             return result;
1114         }
1115
1116         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(dataBroker, rd);
1117         if (vpnInstanceOpData == null) {
1118             LOG.debug("Could not find OpState for VpnName={}", vpnInstanceName);
1119             return result;
1120         }
1121
1122         List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1123         if (vpnToDpnList == null) {
1124             LOG.debug("Could not find DPN footprint for VpnName={}", vpnInstanceName);
1125             return result;
1126         }
1127         for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1128             result.add(vpnToDpn.getDpnId());
1129         }
1130         return result;
1131     }
1132
1133     static String getAssociatedExternalNetwork(DataBroker dataBroker, String routerId) {
1134         InstanceIdentifier<Routers> id = buildRouterIdentifier(routerId);
1135         Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1136         if (routerData.isPresent()) {
1137             Uuid networkId = routerData.get().getNetworkId();
1138             if (networkId != null) {
1139                 return networkId.getValue();
1140             }
1141         }
1142         return null;
1143     }
1144
1145     static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1146         InstanceIdentifier<Routers> routerInstanceIndentifier =
1147             InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1148         return routerInstanceIndentifier;
1149     }
1150
1151     static Networks getExternalNetwork(DataBroker dataBroker, Uuid networkId) {
1152         InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1153             .child(Networks.class, new NetworksKey(networkId)).build();
1154         Optional<Networks> optionalNets = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1155         return optionalNets.isPresent() ? optionalNets.get() : null;
1156     }
1157
1158     static Uuid getExternalNetworkVpnId(DataBroker dataBroker, Uuid networkId) {
1159         Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1160         return extNetwork != null ? extNetwork.getVpnid() : null;
1161     }
1162
1163     static List<Uuid> getExternalNetworkRouterIds(DataBroker dataBroker, Uuid networkId) {
1164         Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1165         return extNetwork != null ? extNetwork.getRouterIds() : Collections.emptyList();
1166     }
1167
1168     static Routers getExternalRouter(DataBroker dataBroker, String routerId) {
1169         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class)
1170                 .child(Routers.class, new RoutersKey(routerId)).build();
1171         Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1172         return routerData.isPresent() ? routerData.get() : null;
1173     }
1174
1175     static List<String> getAllSubnetGatewayMacAddressesforVpn(DataBroker broker, String vpnName) {
1176         List<String> macAddresses = new ArrayList<>();
1177         Optional<Subnetmaps> subnetMapsData =
1178             read(broker, LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
1179         if (subnetMapsData.isPresent()) {
1180             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
1181             if (subnetMapList != null && !subnetMapList.isEmpty()) {
1182                 for (Subnetmap subnet : subnetMapList) {
1183                     if (subnet.getVpnId() != null && subnet.getVpnId().equals(Uuid.getDefaultInstance(vpnName))) {
1184                         String routerIntfMacAddress = subnet.getRouterIntfMacAddress();
1185                         if (routerIntfMacAddress != null && !routerIntfMacAddress.isEmpty()) {
1186                             macAddresses.add(subnet.getRouterIntfMacAddress());
1187                         }
1188                     }
1189                 }
1190             }
1191         }
1192         return macAddresses;
1193     }
1194
1195     static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1196         return InstanceIdentifier.create(Subnetmaps.class);
1197     }
1198
1199     static void setupSubnetMacIntoVpnInstance(DataBroker dataBroker, IMdsalApiManager mdsalManager, String vpnName,
1200             String subnetVpnName, String srcMacAddress, BigInteger dpnId, WriteTransaction writeTx, int addOrRemove) {
1201         long vpnId = getVpnId(dataBroker, vpnName);
1202         long subnetVpnId = VpnConstants.INVALID_ID;
1203         if (subnetVpnName != null) {
1204             subnetVpnId = getVpnId(dataBroker,subnetVpnName);
1205         }
1206
1207         if (dpnId.equals(BigInteger.ZERO)) {
1208             /* Apply the MAC on all DPNs in a VPN */
1209             List<BigInteger> dpIds = getDpnsOnVpn(dataBroker, vpnName);
1210             if (dpIds == null || dpIds.isEmpty()) {
1211                 return;
1212             }
1213             for (BigInteger dpId : dpIds) {
1214                 addGwMacIntoTx(mdsalManager, srcMacAddress, writeTx, addOrRemove, vpnId, dpId, subnetVpnId);
1215             }
1216         } else {
1217             addGwMacIntoTx(mdsalManager, srcMacAddress, writeTx, addOrRemove, vpnId, dpnId, subnetVpnId);
1218         }
1219     }
1220
1221     static void addGwMacIntoTx(IMdsalApiManager mdsalManager, String srcMacAddress, WriteTransaction writeTx,
1222         int addOrRemove, long vpnId, BigInteger dpId, long subnetVpnId) {
1223         FlowEntity flowEntity = buildL3vpnGatewayFlow(dpId, srcMacAddress, vpnId, subnetVpnId);
1224         if (addOrRemove == NwConstants.ADD_FLOW) {
1225             mdsalManager.addFlowToTx(flowEntity, writeTx);
1226         } else {
1227             mdsalManager.removeFlowToTx(flowEntity, writeTx);
1228         }
1229     }
1230
1231     public static FlowEntity buildL3vpnGatewayFlow(BigInteger dpId, String gwMacAddress, long vpnId,
1232             long subnetVpnId) {
1233         List<MatchInfo> mkMatches = new ArrayList<>();
1234         mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
1235         mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1236         List<InstructionInfo> mkInstructions = new ArrayList<>();
1237         mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1238         if (subnetVpnId != VpnConstants.INVALID_ID) {
1239             BigInteger subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId);
1240             mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1241         }
1242
1243         String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress);
1244         FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1245             flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE, mkMatches, mkInstructions);
1246         return flowEntity;
1247     }
1248
1249     private static String getL3VpnGatewayFlowRef(short l3GwMacTable, BigInteger dpId, long vpnId, String gwMacAddress) {
1250         return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1251             + NwConstants.FLOWID_SEPARATOR + l3GwMacTable;
1252     }
1253
1254     public static void lockSubnet(LockManagerService lockManager, String subnetId) {
1255         TryLockInput input =
1256             new TryLockInputBuilder().setLockName(subnetId).setTime(3000L).setTimeUnit(TimeUnits.Milliseconds).build();
1257         Future<RpcResult<Void>> result = lockManager.tryLock(input);
1258         String errMsg = "Unable to getLock for subnet " + subnetId;
1259         try {
1260             if (result != null && result.get().isSuccessful()) {
1261                 LOG.debug("Acquired lock for {}", subnetId);
1262             } else {
1263                 throw new RuntimeException(errMsg);
1264             }
1265         } catch (InterruptedException | ExecutionException e) {
1266             LOG.error(errMsg);
1267             throw new RuntimeException(errMsg, e.getCause());
1268         }
1269     }
1270
1271     public static void unlockSubnet(LockManagerService lockManager, String subnetId) {
1272         UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1273         Future<RpcResult<Void>> result = lockManager.unlock(input);
1274         try {
1275             if (result != null && result.get().isSuccessful()) {
1276                 LOG.debug("Unlocked {}", subnetId);
1277             } else {
1278                 LOG.debug("Unable to unlock subnet {}", subnetId);
1279             }
1280         } catch (InterruptedException | ExecutionException e) {
1281             LOG.error("Unable to unlock subnet {}", subnetId);
1282             throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1283         }
1284     }
1285
1286     static Optional<IpAddress> getGatewayIpAddressFromInterface(String srcInterface,
1287             INeutronVpnManager neutronVpnService, DataBroker dataBroker) {
1288         Optional<IpAddress> gatewayIp = Optional.absent();
1289         if (neutronVpnService != null) {
1290             //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1291             Port port = neutronVpnService.getNeutronPort(srcInterface);
1292             if (port != null && port.getFixedIps() != null && port.getFixedIps().get(0) != null
1293                 && port.getFixedIps().get(0).getSubnetId() != null) {
1294                 gatewayIp = Optional.of(
1295                     neutronVpnService.getNeutronSubnet(port.getFixedIps().get(0).getSubnetId()).getGatewayIp());
1296             }
1297         } else {
1298             LOG.debug("neutron vpn service is not configured");
1299         }
1300         return gatewayIp;
1301     }
1302
1303     static Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp,
1304         DataBroker dataBroker, OdlInterfaceRpcService interfaceRpc) {
1305         Optional<String> gatewayMac = Optional.absent();
1306         long vpnId = getVpnId(dataBroker, macEntry.getVpnName());
1307         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1308             .instance.VpnIds>
1309             vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1310         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1311             vpnIdsOptional
1312             = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1313         if (!vpnIdsOptional.isPresent()) {
1314             LOG.trace("VPN {} not configured", vpnId);
1315             return gatewayMac;
1316         }
1317         VpnPortipToPort vpnTargetIpToPort = VpnUtil.getNeutronPortFromVpnPortFixedIp(dataBroker,
1318             macEntry.getVpnName(), gatewayIp.getIpv4Address().getValue());
1319         if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1320             gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1321         } else {
1322             org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds vpnIds =
1323                 vpnIdsOptional.get();
1324             if (vpnIds.isExternalVpn()) {
1325                 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1326             }
1327         }
1328         return gatewayMac;
1329     }
1330
1331     public static void runOnlyInLeaderNode(EntityOwnershipService entityOwnershipService, Runnable job) {
1332         runOnlyInLeaderNode(entityOwnershipService, job, "");
1333     }
1334
1335     public static void runOnlyInLeaderNode(EntityOwnershipService entityOwnershipService, final Runnable job,
1336             final String jobDescription) {
1337         ListenableFuture<Boolean> checkEntityOwnerFuture = ClusteringUtils.checkNodeEntityOwner(
1338                 entityOwnershipService, VpnConstants.ARP_MONITORING_ENTITY,
1339                 VpnConstants.ARP_MONITORING_ENTITY);
1340         Futures.addCallback(checkEntityOwnerFuture, new FutureCallback<Boolean>() {
1341             @Override
1342             public void onSuccess(Boolean isOwner) {
1343                 if (isOwner) {
1344                     job.run();
1345                 } else {
1346                     LOG.trace("job is not run as i m not cluster owner desc :{} ", jobDescription);
1347                 }
1348             }
1349
1350             @Override
1351             public void onFailure(Throwable error) {
1352                 LOG.error("Failed to identity cluster owner ", error);
1353             }
1354         });
1355     }
1356
1357     public static boolean isVpnIntfPresentInVpnToDpnList(DataBroker broker, VpnInterface vpnInterface) {
1358         BigInteger dpnId = vpnInterface.getDpnId();
1359         String rd = VpnUtil.getVpnRd(broker, vpnInterface.getVpnInstanceName());
1360         LOG.trace("GOT rd {} for VpnInterface {}  VpnInstance {} ", rd ,
1361                 vpnInterface.getName(), vpnInterface.getVpnInstanceName());
1362         VpnInstanceOpDataEntry vpnInstanceOpData = VpnUtil.getVpnInstanceOpDataFromCache(broker, rd);
1363         if (vpnInstanceOpData != null) {
1364             LOG.trace("GOT VpnInstanceOp {} for rd {} ", vpnInstanceOpData, rd);
1365             List<VpnToDpnList> dpnToVpns = vpnInstanceOpData.getVpnToDpnList();
1366             if (dpnToVpns != null) {
1367                 for (VpnToDpnList dpn : dpnToVpns) {
1368                     if (dpn.getDpnId().equals(dpnId)) {
1369                         return dpn.getVpnInterfaces().contains(vpnInterface.getName());
1370                     }
1371                     LOG.trace("VpnInterface {} not present in DpnId {} ", vpnInterface.getName(), dpn.getDpnId());
1372                 }
1373             }
1374         }
1375         return false;
1376     }
1377
1378     public static void setupGwMacIfExternalVpn(DataBroker dataBroker, IMdsalApiManager mdsalManager, BigInteger dpnId,
1379             String interfaceName, long vpnId, WriteTransaction writeInvTxn, int addOrRemove, org.opendaylight.yang.gen
1380             .v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface interfaceState) {
1381         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1382             .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1383         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1384             .VpnIds> vpnIdsOptional = read(
1385                 dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1386         if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1387             PhysAddress gwMacAddress = interfaceState.getPhysAddress();
1388             if (gwMacAddress == null) {
1389                 LOG.error("Failed to get gwMacAddress for interface {}", interfaceName);
1390                 return;
1391             }
1392
1393             String gwMac = gwMacAddress.getValue();
1394             FlowEntity flowEntity = VpnUtil.buildL3vpnGatewayFlow(dpnId, gwMac, vpnId, VpnConstants.INVALID_ID);
1395             if (addOrRemove == NwConstants.ADD_FLOW) {
1396                 mdsalManager.addFlowToTx(flowEntity, writeInvTxn);
1397             } else if (addOrRemove == NwConstants.DEL_FLOW) {
1398                 mdsalManager.removeFlowToTx(flowEntity, writeInvTxn);
1399             }
1400         }
1401     }
1402
1403     public static Optional<VpnPortipToPort> getRouterInterfaceForVpnInterface(DataBroker dataBroker,
1404                                                                               String interfaceName,
1405                                                                               String vpnName,
1406                                                                               Uuid subnetUuid) {
1407         Optional<VpnPortipToPort> gwPortOptional = Optional.absent();
1408         if (subnetUuid != null) {
1409             final Optional<String> gatewayIp = getVpnSubnetGatewayIp(dataBroker, subnetUuid);
1410             if (gatewayIp.isPresent()) {
1411                 String gwIp = gatewayIp.get();
1412                 gwPortOptional = Optional.fromNullable(getNeutronPortFromVpnPortFixedIp(dataBroker, vpnName, gwIp));
1413             }
1414         }
1415         return gwPortOptional;
1416     }
1417
1418     public static Optional<String> getVpnSubnetGatewayIp(DataBroker dataBroker, final Uuid subnetUuid) {
1419         Optional<String> gwIpAddress = Optional.absent();
1420         final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1421         final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1422                 .child(Subnets.class)
1423                 .child(Subnet.class, subnetkey);
1424         final Optional<Subnet> subnet = read(dataBroker, LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1425         if (subnet.isPresent()) {
1426             Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1427             if (ipVersionBase.equals(IpVersionV4.class)) {
1428                 LOG.trace("Obtained subnet {} for vpn interface", subnet.get().getUuid().getValue());
1429                 gwIpAddress = Optional.of(subnet.get().getGatewayIp().getIpv4Address().getValue());
1430                 return gwIpAddress;
1431             }
1432         }
1433         return gwIpAddress;
1434     }
1435
1436     public static RouterToNaptSwitch getRouterToNaptSwitch(DataBroker dataBroker, String routerName) {
1437         InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1438                 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1439         Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1440         return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1441     }
1442
1443     static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1444         return InstanceIdentifier.builder(Subnetmaps.class)
1445         .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1446
1447     }
1448
1449     public static BigInteger getPrimarySwitchForRouter(DataBroker dataBroker, String routerName) {
1450         RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(dataBroker, routerName);
1451         return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1452     }
1453
1454     static boolean isL3VpnOverVxLan(Long l3Vni) {
1455         return l3Vni != null && l3Vni != 0;
1456     }
1457
1458     static boolean isEvpnOverVxLan(Long l2Vni) { //To be used by RT2
1459         return l2Vni != null && l2Vni != 0;
1460     }
1461
1462     /**
1463      * Retrieves the primary rd of a vpn instance
1464      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1465      * If rd list is empty, primary rd will be vpn instance name
1466      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1467      *
1468      * @param dataBroker dataBroker service reference
1469      * @param vpnName Name of the VPN
1470      * @return the primary rd of the VPN
1471      */
1472     public static String getPrimaryRd(DataBroker dataBroker, String vpnName) {
1473         // Retrieves the VPN Route Distinguisher by its Vpn instance name
1474         String rd = getVpnRd(dataBroker, vpnName);
1475         if (rd != null) {
1476             return rd;
1477         }
1478         InstanceIdentifier<VpnInstance> id  = getVpnInstanceIdentifier(vpnName);
1479         Optional<VpnInstance> vpnInstance = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1480         if (vpnInstance.isPresent()) {
1481             return getPrimaryRd(vpnInstance.get());
1482         }
1483         return vpnName;
1484     }
1485
1486     /**
1487      * Retrieves the primary rd of a vpn instance
1488      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1489      * If rd list is empty, primary rd will be vpn instance name
1490      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1491      *
1492      * @param vpnInstance Config Vpn Instance Object
1493      * @return the primary rd of the VPN
1494      */
1495     public static String getPrimaryRd(VpnInstance vpnInstance) {
1496         List<String> rds = null;
1497         if (vpnInstance != null) {
1498             rds = getListOfRdsFromVpnInstance(vpnInstance);
1499         }
1500         return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1501     }
1502
1503     public static boolean isBgpVpn(String vpnName, String primaryRd) {
1504         return !vpnName.equals(primaryRd);
1505     }
1506
1507     static java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(
1508             DataBroker dataBroker, long vpnId, @Nullable Long parentVpnId, String prefix, String vpnName,
1509             String nextHop, BigInteger dpnId, WriteTransaction writeOperTxn) {
1510         //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1511         //This is particularly useful during reboot scenarios.
1512         java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1513                 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1514         if (allocatedRd.isPresent()) {
1515             return java.util.Optional.of(allocatedRd.get());
1516         }
1517
1518         //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1519         List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1520         for (String usedRd : usedRds) {
1521             Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1522                     vpnName, usedRd, prefix);
1523             if (vpnExtraRoutes.isPresent()) {
1524                 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1525                 // In case of VPN importing the routes, the interface is not present in the VPN
1526                 // and has to be fetched from the VPN from which it imports
1527                 Optional<Prefixes> prefixToInterface =
1528                         getPrefixToInterface(dataBroker, parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1529                 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1530                     syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
1531                             VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1532                             getRdsBuilder(nextHop, usedRd).build());
1533                     return java.util.Optional.of(usedRd);
1534                 }
1535             }
1536         }
1537         List<String> availableRds = getVpnRdsFromVpnInstanceConfig(dataBroker, vpnName);
1538         String rd;
1539         if (availableRds.isEmpty()) {
1540             rd = dpnId.toString();
1541             LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1542         } else {
1543             LOG.trace(
1544                     "Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {},"
1545                     + " adj - {}", usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1546             availableRds.removeAll(usedRds);
1547             if (availableRds.isEmpty()) {
1548                 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1549                 return java.util.Optional.empty();
1550             }
1551             // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1552             rd = availableRds.get(0);
1553         }
1554         syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
1555                 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1556                 getRdsBuilder(nextHop, rd).build());
1557         return java.util.Optional.ofNullable(rd);
1558     }
1559
1560     static String getVpnNamePrefixKey(String vpnName, String prefix) {
1561         return vpnName + VpnConstants.SEPARATOR + prefix;
1562     }
1563
1564     static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1565         return InstanceIdentifier.builder(VpnInterfaces.class)
1566                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1567                 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1568     }
1569
1570     public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1571         if (externalIps == null) {
1572             return Collections.emptyList();
1573         }
1574
1575         return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1576     }
1577
1578     static void bindService(final String vpnInstanceName, final String interfaceName, DataBroker dataBroker,
1579                             boolean isTunnelInterface) {
1580         DataStoreJobCoordinator dataStoreCoordinator = DataStoreJobCoordinator.getInstance();
1581         dataStoreCoordinator.enqueueJob(interfaceName,
1582             () -> {
1583                 WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
1584                 BoundServices serviceInfo = isTunnelInterface
1585                         ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1586                         : getBoundServicesForVpnInterface(dataBroker, vpnInstanceName, interfaceName);
1587                 writeTxn.put(LogicalDatastoreType.CONFIGURATION, InterfaceUtils.buildServiceId(interfaceName,
1588                         ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX)),
1589                         serviceInfo, WriteTransaction.CREATE_MISSING_PARENTS);
1590                 return Collections.singletonList(writeTxn.submit());
1591             });
1592     }
1593
1594     static BoundServices getBoundServicesForVpnInterface(DataBroker broker, String vpnName, String interfaceName) {
1595         List<Instruction> instructions = new ArrayList<>();
1596         int instructionKey = 0;
1597         final long vpnId = VpnUtil.getVpnId(broker, vpnName);
1598         List<Action> actions = Collections.singletonList(
1599                 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId).buildAction());
1600         instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1601         instructions.add(
1602                 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId),
1603                         MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1604         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1605                 ++instructionKey));
1606         BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1607                 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1608                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1609                 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1610         return serviceInfo;
1611     }
1612
1613     static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1614         int instructionKey = 0;
1615         List<Instruction> instructions = new ArrayList<>();
1616         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1617                 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1618         BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1619                 vpnName, interfaceName),
1620                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1621                         NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1622                 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1623         return serviceInfo;
1624     }
1625
1626     static void unbindService(DataBroker dataBroker, final String vpnInterfaceName, boolean isInterfaceStateDown) {
1627         if (!isInterfaceStateDown) {
1628             DataStoreJobCoordinator dataStoreCoordinator = DataStoreJobCoordinator.getInstance();
1629             dataStoreCoordinator.enqueueJob(vpnInterfaceName,
1630                 () -> {
1631                     WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
1632                     writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1633                             InterfaceUtils.buildServiceId(vpnInterfaceName,
1634                                     ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1635                                             NwConstants.L3VPN_SERVICE_INDEX)));
1636
1637                     List<ListenableFuture<Void>> futures = new ArrayList<>();
1638                     futures.add(writeTxn.submit());
1639                     return futures;
1640                 });
1641         }
1642     }
1643
1644     static FlowEntity buildFlowEntity(BigInteger dpnId, short tableId, String flowId) {
1645         return new FlowEntityBuilder()
1646             .setDpnId(dpnId)
1647             .setTableId(tableId)
1648             .setFlowId(flowId)
1649             .build();
1650     }
1651
1652     static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1653         return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1654     }
1655
1656     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1657         .Subnets getExternalSubnet(DataBroker dataBroker, Uuid subnetId) {
1658         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1659             .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1660                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1661                         .Subnets.class, new SubnetsKey(subnetId)).build();
1662         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1663             optionalSubnets = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1664         return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1665     }
1666
1667     static Uuid getSubnetFromExternalRouterByIp(DataBroker dataBroker, Uuid routerId, String ip) {
1668         Routers externalRouter = VpnUtil.getExternalRouter(dataBroker, routerId.getValue());
1669         if (externalRouter != null && externalRouter.getExternalIps() != null) {
1670             for (ExternalIps externalIp : externalRouter.getExternalIps()) {
1671                 if (externalIp.getIpAddress().equals(ip)) {
1672                     return externalIp.getSubnetId();
1673                 }
1674             }
1675         }
1676         return null;
1677     }
1678
1679     static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1680         return vpnName.equals(subnetId);
1681     }
1682
1683     static Boolean getIsExternal(Network network) {
1684         return network.getAugmentation(NetworkL3Extension.class) != null
1685                 && network.getAugmentation(NetworkL3Extension.class).isExternal();
1686     }
1687
1688     @SuppressWarnings("checkstyle:linelength")
1689     static Network getNeutronNetwork(DataBroker broker, Uuid networkId) {
1690         Network network = null;
1691         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1692         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1693                 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1694                 Network.class, new NetworkKey(networkId));
1695         Optional<Network> net = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
1696         if (net.isPresent()) {
1697             network = net.get();
1698         }
1699         return network;
1700     }
1701
1702     public static boolean isEligibleForBgp(String rd, String vpnName, BigInteger dpnId, String networkName) {
1703         if (rd != null) {
1704             if ((vpnName != null) && (rd.equals(vpnName))) {
1705                 return false;
1706             }
1707             if ((dpnId != null) && (rd.equals(dpnId.toString()))) {
1708                 return false;
1709             }
1710             if ((networkName != null) && (rd.equals(networkName))) {
1711                 return false;
1712             }
1713             return true;
1714         }
1715         return false;
1716     }
1717 }