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