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