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