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