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