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