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