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