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     public 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     public 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 vpnName, String vpnInterface, String prefix,
1075                                    TypedWriteTransaction<Configuration> writeConfigTxn) {
1076         String ip = VpnUtil.getIpPrefix(prefix);
1077         LOG.trace("Removing {} adjacency from Old VPN Interface {} ", ip, vpnInterface);
1078         InstanceIdentifier<VpnInterface> vpnIfId = VpnUtil.getVpnInterfaceIdentifier(vpnInterface);
1079         InstanceIdentifier<Adjacencies> path = vpnIfId.augmentation(Adjacencies.class);
1080         //TODO: Remove synchronized?
1081
1082         Optional<Adjacencies> adjacencies = read(LogicalDatastoreType.OPERATIONAL, path);
1083         if (adjacencies.isPresent()) {
1084             InstanceIdentifier<Adjacency> adjacencyIdentifier = getAdjacencyIdentifier(vpnInterface, prefix);
1085             writeConfigTxn.delete(adjacencyIdentifier);
1086             LOG.error("removeMipAdjacency: Successfully Deleted Adjacency {} from interface {} vpn {}", ip,
1087                     vpnInterface, vpnName);
1088         }
1089     }
1090
1091     public void removeMipAdjacency(String vpnInterface, String ipAddress) {
1092         String prefix = VpnUtil.getIpPrefix(ipAddress);
1093         InstanceIdentifier<Adjacency> adjacencyIdentifier = getAdjacencyIdentifier(vpnInterface, prefix);
1094         try {
1095             SingleTransactionDataBroker.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION,
1096                     adjacencyIdentifier);
1097         } catch (TransactionCommitFailedException e) {
1098             if (e.getCause() instanceof ModifiedNodeDoesNotExistException) {
1099                 LOG.debug("vpnInterface {} is already deleted. prefix={}", vpnInterface, prefix);
1100             } else {
1101                 LOG.error("Failed to delete adjacency for vpnInterface {}, prefix {}", vpnInterface, prefix, e);
1102             }
1103         }
1104     }
1105
1106     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1107         return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1108                 NetworkMapKey(networkId)).build();
1109     }
1110
1111     static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1112         return InstanceIdentifier.builder(SubnetOpData.class)
1113                 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1114     }
1115
1116     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1117         return InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1118                 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1119     }
1120
1121     @Nullable
1122     public VpnPortipToPort getNeutronPortFromVpnPortFixedIp(String vpnName, String fixedIp) {
1123         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1124         Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
1125         if (vpnPortipToPortData.isPresent()) {
1126             return vpnPortipToPortData.get();
1127         }
1128         return null;
1129     }
1130
1131     @Nullable
1132     public static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(TypedReadTransaction<Configuration> confTx,
1133             String vpnName, String fixedIp) {
1134         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1135         try {
1136             return confTx.read(id).get().orNull();
1137         } catch (InterruptedException | ExecutionException e) {
1138             throw new RuntimeException(e);
1139         }
1140     }
1141
1142     @Nullable
1143     public LearntVpnVipToPort getLearntVpnVipToPort(String vpnName, String fixedIp) {
1144         InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1145         Optional<LearntVpnVipToPort> learntVpnVipToPort = read(LogicalDatastoreType.OPERATIONAL, id);
1146         if (learntVpnVipToPort.isPresent()) {
1147             return learntVpnVipToPort.get();
1148         }
1149         return null;
1150     }
1151
1152     @NonNull
1153     List<Uint64> getDpnsOnVpn(String vpnInstanceName) {
1154         List<Uint64> result = new ArrayList<>();
1155         String rd = getVpnRd(vpnInstanceName);
1156         if (rd == null) {
1157             LOG.debug("getDpnsOnVpn: Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1158             return result;
1159         }
1160         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1161         if (vpnInstanceOpData == null) {
1162             LOG.debug("getDpnsOnVpn: Could not find OpState for VpnName={}", vpnInstanceName);
1163             return result;
1164         }
1165         List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1166         if (vpnToDpnList == null) {
1167             LOG.debug("getDpnsOnVpn: Could not find DPN footprint for VpnName={}", vpnInstanceName);
1168             return result;
1169         }
1170         for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1171             result.add(vpnToDpn.getDpnId());
1172         }
1173         return result;
1174     }
1175
1176     @Nullable
1177     String getAssociatedExternalRouter(String extIp) {
1178         InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1179                 InstanceIdentifier.builder(ExtRouters.class).build();
1180         Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1181         if (!extRouterData.isPresent()) {
1182             return null;
1183         }
1184
1185         // We need to find the router associated with the src ip of this packet.
1186         // This case is either SNAT, in which case the src ip is the same as the
1187         // router's external ip, or FIP in which case the src ip is in the router's
1188         // external leg's subnet. We first check the SNAT case because it is much
1189         // cheaper to do so because it does not require (potentially, there is a
1190         // cache) an datastore read of the neutron subnet for each external IP.
1191
1192         String routerName = null;
1193
1194         for (Routers routerData : extRouterData.get().nonnullRouters()) {
1195             List<ExternalIps> externalIps = routerData.nonnullExternalIps();
1196             for (ExternalIps externalIp : externalIps) {
1197                 if (Objects.equals(externalIp.getIpAddress(), extIp)) {
1198                     routerName = routerData.getRouterName();
1199                     break;
1200                 }
1201             }
1202         }
1203
1204         if (routerName != null) {
1205             return routerName;
1206         }
1207
1208         for (Routers routerData : extRouterData.get().nonnullRouters()) {
1209             List<ExternalIps> externalIps = routerData.nonnullExternalIps();
1210             for (ExternalIps externalIp : externalIps) {
1211                 Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1212                 if (neutronSubnet == null) {
1213                     LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1214                             externalIp.getSubnetId(), routerData);
1215                     continue;
1216                 }
1217                 if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp), neutronSubnet.getCidr())) {
1218                     routerName = routerData.getRouterName();
1219                     break;
1220                 }
1221             }
1222         }
1223
1224         return routerName;
1225     }
1226
1227     @Nullable
1228     public String getAssociatedExternalSubnet(String extIp) {
1229         InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1230                 InstanceIdentifier.builder(ExtRouters.class).build();
1231         Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1232         if (!extRouterData.isPresent() || extRouterData.get().getRouters() == null) {
1233             return null;
1234         }
1235         for (Routers routerData : extRouterData.get().getRouters()) {
1236             List<ExternalIps> externalIps = routerData.getExternalIps();
1237             if (externalIps != null) {
1238                 for (ExternalIps externalIp : externalIps) {
1239                     Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1240                     if (neutronSubnet == null) {
1241                         LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1242                             externalIp.getSubnetId(), routerData);
1243                         continue;
1244                     }
1245                     if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp),
1246                             neutronSubnet.getCidr())) {
1247                         return neutronSubnet.getUuid().getValue();
1248                     }
1249                 }
1250             }
1251         }
1252         return null;
1253     }
1254
1255     static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1256         return InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1257     }
1258
1259     @Nullable
1260     Networks getExternalNetwork(Uuid networkId) {
1261         InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1262             .child(Networks.class, new NetworksKey(networkId)).build();
1263         Optional<Networks> optionalNets = read(LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1264         return optionalNets.isPresent() ? optionalNets.get() : null;
1265     }
1266
1267     @Nullable
1268     Uuid getExternalNetworkVpnId(Uuid networkId) {
1269         Networks extNetwork = getExternalNetwork(networkId);
1270         return extNetwork != null ? extNetwork.getVpnid() : null;
1271     }
1272
1273     @NonNull
1274     public List<Uuid> getExternalNetworkRouterIds(Uuid networkId) {
1275         Networks extNetwork = getExternalNetwork(networkId);
1276         return extNetwork != null && extNetwork.getRouterIds() != null ? extNetwork.getRouterIds() : emptyList();
1277     }
1278
1279     @Nullable
1280     Routers getExternalRouter(String routerId) {
1281         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1282                 new RoutersKey(routerId)).build();
1283         Optional<Routers> routerData = read(LogicalDatastoreType.CONFIGURATION, id);
1284         return routerData.isPresent() ? routerData.get() : null;
1285     }
1286
1287     @Nullable
1288     Routers getExternalRouter(TypedReadTransaction<Configuration> tx, String routerId)
1289             throws ExecutionException, InterruptedException {
1290         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1291             new RoutersKey(routerId)).build();
1292         return tx.read(id).get().orNull();
1293     }
1294
1295     static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1296         return InstanceIdentifier.create(Subnetmaps.class);
1297     }
1298
1299     FlowEntity buildL3vpnGatewayFlow(Uint64 dpId, String gwMacAddress, Uint32 vpnId,
1300                                                Uint32 subnetVpnId) {
1301         List<MatchInfo> mkMatches = new ArrayList<>();
1302         Subnetmap smap = null;
1303         mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId.longValue()),
1304             MetaDataUtil.METADATA_MASK_VRFID));
1305         mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1306         List<InstructionInfo> mkInstructions = new ArrayList<>();
1307         mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1308         if (!VpnConstants.INVALID_ID.equals(subnetVpnId)) {
1309             String vpnName = getVpnName(subnetVpnId);
1310             if (vpnName != null) {
1311                 smap = getSubnetmapFromItsUuid(Uuid.getDefaultInstance(vpnName));
1312                 if (smap != null && smap.getSubnetIp() != null) {
1313                     IpVersionChoice ipVersionChoice = getIpVersionFromString(smap.getSubnetIp());
1314                     if (ipVersionChoice == IpVersionChoice.IPV4) {
1315                         mkMatches.add(MatchEthernetType.IPV4);
1316                     } else {
1317                         mkMatches.add(MatchEthernetType.IPV6);
1318                     }
1319                 }
1320             }
1321             Uint64 subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId.longValue());
1322             mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1323         }
1324         String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress, subnetVpnId);
1325         return MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1326                 flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE,
1327                 mkMatches, mkInstructions);
1328     }
1329
1330     static String getL3VpnGatewayFlowRef(short l3GwMacTable, Uint64 dpId, Uint32 vpnId, String gwMacAddress,
1331                                          Uint32 subnetVpnId) {
1332         return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1333             + NwConstants.FLOWID_SEPARATOR + l3GwMacTable + NwConstants.FLOWID_SEPARATOR + subnetVpnId;
1334     }
1335
1336     void lockSubnet(String subnetId) {
1337         //  We set the total wait time for lock to be obtained at 9 seconds since GC pauses can be upto 8 seconds
1338         //in scale setups.
1339         TryLockInput input =
1340             new TryLockInputBuilder().setLockName(subnetId).setTime(9000L).setTimeUnit(TimeUnits.Milliseconds).build();
1341         Future<RpcResult<TryLockOutput>> result = lockManager.tryLock(input);
1342         try {
1343             if (result != null && result.get().isSuccessful()) {
1344                 LOG.debug("lockSubnet: Acquired lock for {}", subnetId);
1345             } else {
1346                 LOG.error("Unable to get lock for subnet {}", subnetId);
1347                 throw new RuntimeException("Unable to get lock for subnet " + subnetId);
1348             }
1349         } catch (InterruptedException | ExecutionException e) {
1350             LOG.error("Unable to get lock for subnet {}", subnetId, e);
1351             throw new RuntimeException("Unable to get lock for subnet " + subnetId, e);
1352         }
1353     }
1354
1355     // We store the cause, which is what we really care about
1356     @SuppressWarnings("checkstyle:AvoidHidingCauseException")
1357     public void unlockSubnet(String subnetId) {
1358         UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1359         Future<RpcResult<UnlockOutput>> result = lockManager.unlock(input);
1360         try {
1361             if (result != null && result.get().isSuccessful()) {
1362                 LOG.debug("unlockSubnet: Unlocked {}", subnetId);
1363             } else {
1364                 LOG.debug("unlockSubnet: Unable to unlock subnet {}", subnetId);
1365             }
1366         } catch (InterruptedException | ExecutionException e) {
1367             LOG.error("unlockSubnet: Unable to unlock subnet {}", subnetId);
1368             throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1369         }
1370     }
1371
1372     public Optional<IpAddress> getGatewayIpAddressFromInterface(MacEntry macEntry) {
1373         Optional<IpAddress> gatewayIp = Optional.absent();
1374         String srcInterface = macEntry.getInterfaceName();
1375         InetAddress hiddenIp = macEntry.getIpAddress();
1376         if (neutronVpnService != null) {
1377             //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1378             Port port = neutronVpnService.getNeutronPort(srcInterface);
1379             if (port != null && port.getFixedIps() != null) {
1380                 for (FixedIps portIp : port.getFixedIps()) {
1381                     if (doesInterfaceAndHiddenIpAddressTypeMatch(hiddenIp, portIp)) {
1382                         gatewayIp =
1383                                 Optional.of(neutronVpnService.getNeutronSubnet(portIp.getSubnetId()).getGatewayIp());
1384                         break;
1385                     }
1386                 }
1387             }
1388         } else {
1389             LOG.error("getGatewayIpAddressFromInterface: neutron vpn service is not configured."
1390                     + " Failed for interface {}.", srcInterface);
1391         }
1392         return gatewayIp;
1393     }
1394
1395     private boolean doesInterfaceAndHiddenIpAddressTypeMatch(InetAddress hiddenIp, FixedIps portIp) {
1396         return hiddenIp instanceof Inet4Address && portIp.getIpAddress().getIpv4Address() != null
1397                 || hiddenIp instanceof Inet6Address && portIp.getIpAddress().getIpv6Address() != null;
1398     }
1399
1400     public Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp) {
1401         Optional<String> gatewayMac = Optional.absent();
1402         Uint32 vpnId = getVpnId(macEntry.getVpnName());
1403         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1404             .instance.VpnIds>
1405             vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1406         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1407             vpnIdsOptional = read(LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1408         if (!vpnIdsOptional.isPresent()) {
1409             LOG.error("getGWMacAddressFromInterface: VPN {} not configured", vpnId);
1410             return gatewayMac;
1411         }
1412         VpnPortipToPort vpnTargetIpToPort =
1413                 getNeutronPortFromVpnPortFixedIp(macEntry.getVpnName(), gatewayIp.stringValue());
1414         if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1415             gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1416         } else {
1417             org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
1418                     .vpn.id.to.vpn.instance.VpnIds vpnIds = vpnIdsOptional.get();
1419             if (vpnIds.isExternalVpn()) {
1420                 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1421             }
1422         }
1423         return gatewayMac;
1424     }
1425
1426     void setupGwMacIfExternalVpn(Uint64 dpnId, String interfaceName, Uint32 vpnId,
1427                                  TypedReadWriteTransaction<Configuration> writeInvTxn, int addOrRemove, String gwMac)
1428             throws ExecutionException, InterruptedException {
1429         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1430             .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1431         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1432             .VpnIds> vpnIdsOptional = writeInvTxn.read(vpnIdsInstanceIdentifier).get();
1433         if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1434             if (gwMac == null) {
1435                 LOG.error("setupGwMacIfExternalVpn: Failed to get gwMacAddress for interface {} on dpn {} vpn {}",
1436                         interfaceName, dpnId.toString(), vpnIdsOptional.get().getVpnInstanceName());
1437                 return;
1438             }
1439             FlowEntity flowEntity = buildL3vpnGatewayFlow(dpnId, gwMac, vpnId,VpnConstants.INVALID_ID);
1440             if (addOrRemove == NwConstants.ADD_FLOW) {
1441                 mdsalManager.addFlow(writeInvTxn, flowEntity);
1442             } else if (addOrRemove == NwConstants.DEL_FLOW) {
1443                 mdsalManager.removeFlow(writeInvTxn, flowEntity);
1444             }
1445         }
1446     }
1447
1448     public Optional<String> getVpnSubnetGatewayIp(final Uuid subnetUuid) {
1449         Optional<String> gwIpAddress = Optional.absent();
1450         final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1451         final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1452                 .child(Subnets.class)
1453                 .child(Subnet.class, subnetkey);
1454         final Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1455         if (subnet.isPresent()) {
1456             Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1457             if (IpVersionV4.class.equals(ipVersionBase)) {
1458                 Subnetmap subnetmap = getSubnetmapFromItsUuid(subnetUuid);
1459                 if (subnetmap != null && subnetmap.getRouterInterfaceFixedIp() != null) {
1460                     LOG.trace("getVpnSubnetGatewayIp: Obtained subnetMap {} for vpn interface",
1461                             subnetmap.getId().getValue());
1462                     gwIpAddress = Optional.of(subnetmap.getRouterInterfaceFixedIp());
1463                 } else {
1464                     //For direct L3VPN to network association (no router) continue to use subnet-gateway IP
1465                     IpAddress gwIp = subnet.get().getGatewayIp();
1466                     if (gwIp != null && gwIp.getIpv4Address() != null) {
1467                         gwIpAddress = Optional.of(gwIp.getIpv4Address().getValue());
1468                     }
1469                 }
1470                 LOG.trace("getVpnSubnetGatewayIp: Obtained subnet-gw ip {} for vpn interface",
1471                         gwIpAddress.get());
1472             }
1473         }
1474         return gwIpAddress;
1475     }
1476
1477     @Nullable
1478     RouterToNaptSwitch getRouterToNaptSwitch(String routerName) {
1479         InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1480                 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1481         Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(LogicalDatastoreType.CONFIGURATION, id);
1482         return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1483     }
1484
1485     static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1486         return InstanceIdentifier.builder(Subnetmaps.class)
1487         .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1488
1489     }
1490
1491     @Nullable
1492     Uint64 getPrimarySwitchForRouter(String routerName) {
1493         RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(routerName);
1494         return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1495     }
1496
1497     static boolean isL3VpnOverVxLan(Uint32 l3Vni) {
1498         return l3Vni != null && l3Vni.longValue() != 0;
1499     }
1500
1501     /**
1502      * Retrieves the primary rd of a vpn instance
1503      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1504      * If rd list is empty, primary rd will be vpn instance name
1505      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1506      *
1507      * @param vpnName Name of the VPN
1508      * @return the primary rd of the VPN
1509      */
1510     public String getPrimaryRd(String vpnName) {
1511         // Retrieves the VPN Route Distinguisher by its Vpn instance name
1512         String rd = getVpnRd(vpnName);
1513         if (rd != null) {
1514             return rd;
1515         }
1516         InstanceIdentifier<VpnInstance> id  = getVpnInstanceIdentifier(vpnName);
1517         Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1518         if (vpnInstance.isPresent()) {
1519             return getPrimaryRd(vpnInstance.get());
1520         }
1521         return vpnName;
1522     }
1523
1524     /**
1525      * Retrieves the primary rd of a vpn instance
1526      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1527      * If rd list is empty, primary rd will be vpn instance name
1528      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1529      *
1530      * @param vpnInstance Config Vpn Instance Object
1531      * @return the primary rd of the VPN
1532      */
1533     static String getPrimaryRd(VpnInstance vpnInstance) {
1534         List<String> rds = null;
1535         if (vpnInstance != null) {
1536             rds = getListOfRdsFromVpnInstance(vpnInstance);
1537         }
1538         return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1539     }
1540
1541     static boolean isBgpVpn(String vpnName, String primaryRd) {
1542         return !vpnName.equals(primaryRd);
1543     }
1544
1545     java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(Uint32 vpnId, @Nullable Uint32 parentVpnId,
1546                                                                           String prefix, String vpnName,
1547                                                                           String nextHop, Uint64 dpnId) {
1548         //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1549         //This is particularly useful during reboot scenarios.
1550         java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1551                 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1552         if (allocatedRd.isPresent()) {
1553             return allocatedRd;
1554         }
1555
1556         //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1557         List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1558         for (String usedRd : usedRds) {
1559             Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1560                     vpnName, usedRd, prefix);
1561             if (vpnExtraRoutes.isPresent()) {
1562                 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1563                 // In case of VPN importing the routes, the interface is not present in the VPN
1564                 // and has to be fetched from the VPN from which it imports
1565                 Optional<Prefixes> prefixToInterface =
1566                         getPrefixToInterface(parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1567                 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1568                     syncUpdate(LogicalDatastoreType.CONFIGURATION,
1569                             VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1570                             getRdsBuilder(nextHop, usedRd).build());
1571                     return java.util.Optional.of(usedRd);
1572                 }
1573             }
1574         }
1575         List<String> availableRds = getVpnRdsFromVpnInstanceConfig(vpnName);
1576         String rd;
1577         if (availableRds.isEmpty()) {
1578             rd = dpnId.toString();
1579             LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1580         } else {
1581             LOG.trace("Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {}",
1582                     usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1583             if (!usedRds.isEmpty()) {
1584                 availableRds.removeAll(usedRds);
1585             }
1586             if (availableRds.isEmpty()) {
1587                 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1588                 return java.util.Optional.empty();
1589             }
1590             // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1591             rd = availableRds.get(0);
1592         }
1593         syncUpdate(LogicalDatastoreType.CONFIGURATION,
1594                 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop), getRdsBuilder(nextHop, rd).build());
1595         return java.util.Optional.ofNullable(rd);
1596     }
1597
1598     static String getVpnNamePrefixKey(String vpnName, String prefix) {
1599         return vpnName + VpnConstants.SEPARATOR + prefix;
1600     }
1601
1602     static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1603         return InstanceIdentifier.builder(VpnInterfaces.class)
1604                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1605                 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1606     }
1607
1608     static InstanceIdentifier<Adjacency> getVpnInterfaceOpDataEntryAdjacencyIdentifier(String intfName,
1609                                                                                        String vpnName,
1610                                                                                        String ipAddress) {
1611         LOG.debug("getVpnInterfaceOpDataEntryAdjacencyIdentifier intfName {}, vpnName {}, ipAddress {}",
1612                 intfName, vpnName, ipAddress);
1613         return InstanceIdentifier.builder(VpnInterfaceOpData.class)
1614                     .child(VpnInterfaceOpDataEntry.class, new VpnInterfaceOpDataEntryKey(intfName, vpnName))
1615                     .augmentation(AdjacenciesOp.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1616     }
1617
1618     public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1619         if (externalIps == null) {
1620             return emptyList();
1621         }
1622
1623         return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1624     }
1625
1626     void bindService(final String vpnInstanceName, final String interfaceName, boolean isTunnelInterface) {
1627         jobCoordinator.enqueueJob(interfaceName,
1628             () -> Collections.singletonList(txRunner.callWithNewReadWriteTransactionAndSubmit(
1629                                                                                 Datastore.CONFIGURATION, tx -> {
1630                     BoundServices serviceInfo = isTunnelInterface
1631                             ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1632                             : getBoundServicesForVpnInterface(vpnInstanceName, interfaceName);
1633                     tx.put(InterfaceUtils.buildServiceId(interfaceName,
1634                             ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1635                                     NwConstants.L3VPN_SERVICE_INDEX)),
1636                             serviceInfo, WriteTransaction.CREATE_MISSING_PARENTS);
1637                 })), SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1638     }
1639
1640     BoundServices getBoundServicesForVpnInterface(String vpnName, String interfaceName) {
1641         List<Instruction> instructions = new ArrayList<>();
1642         int instructionKey = 0;
1643         final Uint32 vpnId = getVpnId(vpnName);
1644         List<Action> actions = Collections.singletonList(
1645                 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId.longValue())
1646                 .buildAction());
1647         instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1648         instructions.add(
1649                 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId.longValue()),
1650                         MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1651         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1652                 ++instructionKey));
1653         BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1654                 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1655                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1656                 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1657         return serviceInfo;
1658     }
1659
1660     static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1661         int instructionKey = 0;
1662         List<Instruction> instructions = new ArrayList<>();
1663         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1664                 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1665         BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1666                 vpnName, interfaceName),
1667                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1668                         NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1669                 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1670         return serviceInfo;
1671     }
1672
1673     void unbindService(final String vpnInterfaceName, boolean isInterfaceStateDown) {
1674         if (!isInterfaceStateDown) {
1675             jobCoordinator.enqueueJob(vpnInterfaceName,
1676                 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1677                         Datastore.CONFIGURATION, tx ->
1678                         tx.delete(InterfaceUtils.buildServiceId(vpnInterfaceName,
1679                                         ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1680                                                 NwConstants.L3VPN_SERVICE_INDEX))))),
1681                 SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1682         }
1683     }
1684
1685     static FlowEntity buildFlowEntity(Uint64 dpnId, short tableId, String flowId) {
1686         return new FlowEntityBuilder().setDpnId(dpnId).setTableId(tableId).setFlowId(flowId).build();
1687     }
1688
1689     static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1690         return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1691     }
1692
1693     org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.@Nullable Subnets
1694         getExternalSubnet(Uuid subnetId) {
1695         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1696             .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1697                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1698                         .Subnets.class, new SubnetsKey(subnetId)).build();
1699         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1700             optionalSubnets = read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1701         return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1702     }
1703
1704     @Nullable
1705     public Uuid getSubnetFromExternalRouterByIp(Uuid routerId, String ip) {
1706         Routers externalRouter = getExternalRouter(routerId.getValue());
1707         if (externalRouter != null && externalRouter.getExternalIps() != null) {
1708             for (ExternalIps externalIp : externalRouter.getExternalIps()) {
1709                 if (Objects.equals(externalIp.getIpAddress(), ip)) {
1710                     return externalIp.getSubnetId();
1711                 }
1712             }
1713         }
1714         return null;
1715     }
1716
1717     static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1718         return vpnName.equals(subnetId);
1719     }
1720
1721     static Boolean getIsExternal(Network network) {
1722         return network.augmentation(NetworkL3Extension.class) != null
1723                 && network.augmentation(NetworkL3Extension.class).isExternal();
1724     }
1725
1726     @SuppressWarnings("checkstyle:linelength")
1727     @Nullable
1728     Network getNeutronNetwork(Uuid networkId) {
1729         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1730         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1731                 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1732                 Network.class, new NetworkKey(networkId));
1733         return read(LogicalDatastoreType.CONFIGURATION, inst).orNull();
1734     }
1735
1736     public static boolean isEligibleForBgp(@Nullable String rd, @Nullable String vpnName, @Nullable Uint64 dpnId,
1737             @Nullable String networkName) {
1738         if (rd != null) {
1739             if (rd.equals(vpnName)) {
1740                 return false;
1741             }
1742             if (dpnId != null && rd.equals(dpnId.toString())) {
1743                 return false;
1744             }
1745             if (rd.equals(networkName)) {
1746                 return false;
1747             }
1748             return true;
1749         }
1750         return false;
1751     }
1752
1753     static String getFibFlowRef(Uint64 dpnId, short tableId, String vpnName, int priority) {
1754         return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
1755                 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
1756     }
1757
1758     void removeExternalTunnelDemuxFlows(String vpnName) {
1759         LOG.info("Removing external tunnel flows for vpn {}", vpnName);
1760         for (Uint64 dpnId: NWUtil.getOperativeDPNs(dataBroker)) {
1761             LOG.debug("Removing external tunnel flows for vpn {} from dpn {}", vpnName, dpnId);
1762             String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
1763                     vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
1764             FlowEntity flowEntity = VpnUtil.buildFlowEntity(dpnId,
1765                     NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef);
1766             mdsalManager.removeFlow(flowEntity);
1767         }
1768     }
1769
1770     public boolean isVpnPendingDelete(String rd) {
1771         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1772         boolean isVpnPendingDelete = false;
1773         if (vpnInstanceOpData == null) {
1774             LOG.error("isVpnPendingDelete: unable to read vpn instance op data for vpn with rd {}", rd);
1775             isVpnPendingDelete = true;
1776         }
1777         else if (vpnInstanceOpData.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete) {
1778             isVpnPendingDelete = true;
1779         }
1780         return isVpnPendingDelete;
1781     }
1782
1783     @SuppressWarnings("checkstyle:IllegalCatch")
1784     public List<VpnInstanceOpDataEntry> getVpnsImportingMyRoute(final String vpnName) {
1785         List<VpnInstanceOpDataEntry> vpnsToImportRoute = new ArrayList<>();
1786         final VpnInstanceOpDataEntry vpnInstanceOpDataEntry;
1787         final String vpnRd = getVpnRd(vpnName);
1788         if (vpnRd == null) {
1789             LOG.error("getVpnsImportingMyRoute: vpn {} not present in config DS.", vpnName);
1790             return vpnsToImportRoute;
1791         }
1792         if (vpnRd.equals(vpnName)) {
1793             LOG.error("getVpnsImportingMyRoute: Internal vpn {} do not export/import routes", vpnName);
1794             return vpnsToImportRoute;
1795         }
1796         try {
1797             final VpnInstanceOpDataEntry opDataEntry = getVpnInstanceOpData(vpnRd);
1798             if (opDataEntry == null) {
1799                 LOG.error("getVpnsImportingMyRoute: Could not retrieve vpn instance op data for vpn {} rd {}"
1800                         + " to check for vpns importing the routes", vpnName, vpnRd);
1801                 return vpnsToImportRoute;
1802             }
1803             vpnInstanceOpDataEntry = opDataEntry;
1804         } catch (Exception e) {
1805             LOG.error("getVpnsImportingMyRoute: DSException when retrieving vpn instance op data for vpn {} rd {}"
1806                     + " to check for vpns importing the routes", vpnName, vpnRd);
1807             return vpnsToImportRoute;
1808         }
1809         Predicate<VpnInstanceOpDataEntry> excludeVpn = input -> {
1810             if (input.getVpnInstanceName() == null) {
1811                 LOG.error("getVpnsImportingMyRoute.excludeVpn: Received vpn instance with rd {} without a name.",
1812                         input.getVrfId());
1813                 return false;
1814             }
1815             return !input.getVpnInstanceName().equals(vpnName);
1816         };
1817         Predicate<VpnInstanceOpDataEntry> matchRTs = input -> {
1818             Iterable<String> commonRTs =
1819                 intersection(getRts(vpnInstanceOpDataEntry, VpnTarget.VrfRTType.ExportExtcommunity),
1820                     getRts(input, VpnTarget.VrfRTType.ImportExtcommunity));
1821             return Iterators.size(commonRTs.iterator()) > 0;
1822         };
1823         vpnsToImportRoute = getAllVpnInstanceOpData().stream().filter(excludeVpn).filter(matchRTs)
1824                 .collect(Collectors.toList());
1825         return vpnsToImportRoute;
1826     }
1827
1828     static List<String> getRts(VpnInstanceOpDataEntry vpnInstance, VpnTarget.VrfRTType rtType) {
1829         String name = vpnInstance.getVpnInstanceName();
1830         List<String> rts = new ArrayList<>();
1831         VpnTargets targets = vpnInstance.getVpnTargets();
1832         if (targets == null) {
1833             LOG.debug("getRts: vpn targets not available for {}", name);
1834             return rts;
1835         }
1836         List<VpnTarget> vpnTargets = targets.getVpnTarget();
1837         if (vpnTargets == null) {
1838             LOG.debug("getRts: vpnTarget values not available for {}", name);
1839             return rts;
1840         }
1841         for (VpnTarget target : vpnTargets) {
1842             //TODO: Check for RT type is Both
1843             if (target.getVrfRTType().equals(rtType) || target.getVrfRTType().equals(VpnTarget.VrfRTType.Both)) {
1844                 String rtValue = target.getVrfRTValue();
1845                 rts.add(rtValue);
1846             }
1847         }
1848         return rts;
1849     }
1850
1851     static <T> Iterable<T> intersection(final Collection<T> collection1, final Collection<T> collection2) {
1852         Set<T> intersection = new HashSet<>(collection1);
1853         intersection.retainAll(collection2);
1854         return intersection;
1855     }
1856
1857     /** Get Subnetmap from its Uuid.
1858      * @param subnetUuid the subnet's Uuid
1859      * @return the Subnetmap of Uuid or null if it is not found
1860      */
1861     @Nullable
1862     public Subnetmap getSubnetmapFromItsUuid(Uuid subnetUuid) {
1863         InstanceIdentifier<Subnetmap> id = buildSubnetmapIdentifier(subnetUuid);
1864         return read(LogicalDatastoreType.CONFIGURATION, id).orNull();
1865     }
1866
1867     boolean isAdjacencyEligibleToVpnInternet(Adjacency adjacency) {
1868         // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1869         boolean adjacencyEligible = false;
1870         IpVersionChoice ipVerChoice = getIpVersionFromString(adjacency.getIpAddress());
1871         if (ipVerChoice.isIpVersionChosen(IpVersionChoice.IPV6)) {
1872             Subnetmap sn = getSubnetmapFromItsUuid(adjacency.getSubnetId());
1873             if (sn != null && sn.getInternetVpnId() != null) {
1874                 adjacencyEligible = true;
1875             }
1876         }
1877         return adjacencyEligible;
1878     }
1879
1880     boolean isAdjacencyEligibleToVpn(Adjacency adjacency, String vpnName) {
1881         // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1882         boolean adjacencyEligible = true;
1883         // if BGPVPN internet, return false if subnetmap has not internetVpnId() filled in
1884         if (isBgpVpnInternet(vpnName)) {
1885             return isAdjacencyEligibleToVpnInternet(adjacency);
1886         }
1887         return adjacencyEligible;
1888     }
1889
1890     @Nullable
1891     String getInternetVpnFromVpnInstanceList(List<VpnInstanceNames> vpnInstanceList) {
1892         for (VpnInstanceNames vpnInstance : vpnInstanceList) {
1893             String vpnName = vpnInstance.getVpnName();
1894             if (isBgpVpnInternet(vpnName)) {
1895                 return vpnName;
1896             }
1897         }
1898         return null;
1899     }
1900
1901     /** Get boolean true if vpn is bgpvpn internet, false otherwise.
1902      * @param vpnName name of the input VPN
1903      * @return true or false
1904      */
1905     boolean isBgpVpnInternet(String vpnName) {
1906         String primaryRd = getVpnRd(vpnName);
1907         if (primaryRd == null) {
1908             LOG.error("isBgpVpnInternet VPN {}."
1909                       + "Primary RD not found", vpnName);
1910             return false;
1911         }
1912         InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1913               .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1914
1915         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1916         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1917             LOG.error("isBgpVpnInternet VPN {}."
1918                      + "VpnInstanceOpDataEntry not found", vpnName);
1919             return false;
1920         }
1921         LOG.debug("isBgpVpnInternet VPN {}."
1922              + "Successfully VpnInstanceOpDataEntry.getBgpvpnType {}",
1923              vpnName, vpnInstanceOpDataEntryOptional.get().getBgpvpnType());
1924         if (vpnInstanceOpDataEntryOptional.get().getBgpvpnType() == VpnInstanceOpDataEntry
1925                .BgpvpnType.BGPVPNInternet) {
1926             return true;
1927         }
1928         return false;
1929     }
1930
1931     /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1932      * @param ipAddress String of an representation IP address V4 or V6
1933      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1934      */
1935     public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1936         int indexIpAddress = ipAddress.indexOf('/');
1937         if (indexIpAddress >= 0) {
1938             ipAddress = ipAddress.substring(0, indexIpAddress);
1939         }
1940         try {
1941             InetAddress address = InetAddress.getByName(ipAddress);
1942             if (address instanceof Inet4Address) {
1943                 return IpVersionChoice.IPV4;
1944             } else if (address instanceof Inet6Address) {
1945                 return IpVersionChoice.IPV6;
1946             }
1947         } catch (UnknownHostException | SecurityException e) {
1948             return IpVersionChoice.UNDEFINED;
1949         }
1950         return IpVersionChoice.UNDEFINED;
1951     }
1952
1953     ListenableFuture<Void> unsetScheduledToRemoveForVpnInterface(String interfaceName) {
1954         VpnInterfaceBuilder builder = new VpnInterfaceBuilder().withKey(new VpnInterfaceKey(interfaceName));
1955         return txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> tx.merge(
1956                 VpnUtil.getVpnInterfaceIdentifier(interfaceName), builder.build(),
1957                 WriteTransaction.CREATE_MISSING_PARENTS));
1958     }
1959
1960     /**
1961      * Adds router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1962      * This will create the vlan footprint in the DPN's which are member of the VPN.
1963      *
1964      * @param vpnName the vpnName
1965      * @param dpnId  the DPN id
1966      */
1967     void addRouterPortToElanForVlanInDpn(String vpnName, Uint64 dpnId) {
1968         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1969         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1970             addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1971         }
1972     }
1973
1974     /**
1975      * Removes router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1976      * This will remove the  vlan footprint in all the DPN's which are member of the VPN.
1977      *
1978      * @param vpnName the vpn name
1979      * @param dpnId  the DPN id
1980      */
1981     void removeRouterPortFromElanForVlanInDpn(String vpnName, Uint64 dpnId) {
1982         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1983         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1984             removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
1985                     vpnName, dpnId);
1986         }
1987     }
1988
1989     /**
1990      * Adds router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
1991      * This will create the vlan footprint in all the DPN's which are member of the VPN.
1992      *
1993      * @param vpnName the vpn name
1994      */
1995     void addRouterPortToElanDpnListForVlaninAllDpn(String vpnName) {
1996         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1997         Set<Uint64> dpnList = getDpnInElan(elanInstanceRouterPortMap);
1998         for (Uint64 dpnId : dpnList) {
1999             for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
2000                 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
2001             }
2002         }
2003     }
2004
2005     /**Removes router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
2006      * This will remove the vlan footprint in all the DPN's which are member of the VPN.
2007      *
2008      * @param routerInterfacePortId this will add the current subnet router port id to the map for removal
2009      * @param elanInstanceName the current elanstance being removed this will be added to map for removal
2010      * @param vpnName the vpn name
2011      */
2012     void removeRouterPortFromElanDpnListForVlanInAllDpn(String elanInstanceName,
2013             String routerInterfacePortId, String vpnName) {
2014         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
2015         elanInstanceRouterPortMap.put(elanInstanceName, routerInterfacePortId);
2016         Set<Uint64> dpnList = getDpnInElan(elanInstanceRouterPortMap);
2017         for (Uint64 dpnId : dpnList) {
2018             for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
2019                 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
2020                         vpnName, dpnId);
2021             }
2022         }
2023
2024     }
2025
2026     Set<Uint64> getDpnInElan(Map<String,String> elanInstanceRouterPortMap) {
2027         Set<Uint64> dpnIdSet = new HashSet<>();
2028         for (String elanInstanceName : elanInstanceRouterPortMap.keySet()) {
2029             InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationalDataPath(
2030                     elanInstanceName);
2031             Optional<ElanDpnInterfacesList> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL,
2032                     elanDpnInterfaceId);
2033             if (dpnInElanInterfaces.isPresent()) {
2034                 List<DpnInterfaces> dpnInterfaces = dpnInElanInterfaces.get().nonnullDpnInterfaces();
2035                 for (DpnInterfaces dpnInterface : dpnInterfaces) {
2036                     dpnIdSet.add(dpnInterface.getDpId());
2037                 }
2038             }
2039         }
2040         return dpnIdSet;
2041     }
2042
2043     void addRouterPortToElanDpn(String elanInstanceName, String routerInterfacePortId, Uint64 dpnId) {
2044         InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
2045                 elanInstanceName,dpnId);
2046         final ReentrantLock lock = JvmGlobalLocks.getLockForString(elanInstanceName);
2047         lock.lock();
2048         try {
2049             Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
2050             List<String> elanInterfaceList = new ArrayList<>();
2051             DpnInterfaces dpnInterface;
2052             if (!dpnInElanInterfaces.isPresent()) {
2053                 elanInterfaceList = new ArrayList<>();
2054             } else {
2055                 dpnInterface = dpnInElanInterfaces.get();
2056                 elanInterfaceList = (dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty())
2057                         ? new ArrayList<>(dpnInterface.getInterfaces()) : elanInterfaceList;
2058             }
2059             if (!elanInterfaceList.contains(routerInterfacePortId)) {
2060                 elanInterfaceList.add(routerInterfacePortId);
2061                 dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2062                         .withKey(new DpnInterfacesKey(dpnId)).build();
2063                 syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
2064             }
2065         } finally {
2066             lock.unlock();
2067         }
2068     }
2069
2070     void removeRouterPortFromElanDpn(String elanInstanceName, String routerInterfacePortId,
2071             String vpnName, Uint64 dpnId) {
2072         InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
2073                 elanInstanceName,dpnId);
2074         final ReentrantLock lock = JvmGlobalLocks.getLockForString(elanInstanceName);
2075         lock.lock();
2076         try {
2077             Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
2078             List<String> elanInterfaceList = new ArrayList<>();
2079             DpnInterfaces dpnInterface;
2080             if (!dpnInElanInterfaces.isPresent()) {
2081                 LOG.info("No interface in any dpn for {}", vpnName);
2082                 return;
2083             } else {
2084                 dpnInterface = dpnInElanInterfaces.get();
2085                 elanInterfaceList = (dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty())
2086                         ? new ArrayList<>(dpnInterface.getInterfaces()) : elanInterfaceList;
2087             }
2088             if (!elanInterfaceList.contains(routerInterfacePortId)) {
2089                 LOG.info("Router port not present in DPN {} for VPN {}", dpnId, vpnName);
2090                 return;
2091             }
2092             elanInterfaceList.remove(routerInterfacePortId);
2093             dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2094                     .withKey(new DpnInterfacesKey(dpnId)).build();
2095             syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
2096         } finally {
2097             lock.unlock();
2098         }
2099
2100     }
2101
2102     @Nullable
2103     ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName) {
2104         InstanceIdentifier<ElanInterface> elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName);
2105         return read(LogicalDatastoreType.CONFIGURATION, elanInterfaceId).orNull();
2106     }
2107
2108     static InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName) {
2109         return InstanceIdentifier.builder(ElanInterfaces.class)
2110                 .child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build();
2111     }
2112
2113     @Nullable
2114     DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, Uint64 dpId) {
2115         InstanceIdentifier<DpnInterfaces> elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName,
2116                 dpId);
2117         return read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId).orNull();
2118     }
2119
2120     @Nullable
2121     String getExternalElanInterface(String elanInstanceName, Uint64 dpnId) {
2122         DpnInterfaces dpnInterfaces = getElanInterfaceInfoByElanDpn(elanInstanceName, dpnId);
2123         if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null) {
2124             LOG.info("Elan {} does not have interfaces in DPN {}", elanInstanceName, dpnId);
2125             return null;
2126         }
2127
2128         for (String dpnInterface : dpnInterfaces.getInterfaces()) {
2129             if (interfaceManager.isExternalInterface(dpnInterface)) {
2130                 return dpnInterface;
2131             }
2132         }
2133         return null;
2134     }
2135
2136     static boolean isVlan(ElanInstance elanInstance) {
2137         return elanInstance != null && elanInstance.getSegmentType() != null
2138                 && elanInstance.getSegmentType().isAssignableFrom(SegmentTypeVlan.class)
2139                 && elanInstance.getSegmentationId() != null && elanInstance.getSegmentationId().toJava() != 0;
2140     }
2141
2142     boolean isVlan(String interfaceName) {
2143         ElanInterface elanInterface = getElanInterfaceByElanInterfaceName(interfaceName);
2144         if (elanInterface == null) {
2145             return false;
2146         }
2147         ElanInstance  elanInstance = getElanInstanceByName(elanInterface.getElanInstanceName());
2148         return isVlan(elanInstance);
2149     }
2150
2151     @Nullable
2152     ElanInstance getElanInstanceByName(String elanInstanceName) {
2153         InstanceIdentifier<ElanInstance> elanIdentifierId =
2154                 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName);
2155         return read(LogicalDatastoreType.CONFIGURATION, elanIdentifierId).orNull();
2156     }
2157
2158     @Nullable
2159     String getVpnNameFromElanIntanceName(String elanInstanceName) {
2160         Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2161         if (subnetMapsData.isPresent()) {
2162             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2163             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2164                 for (Subnetmap subnet : subnetMapList) {
2165                     if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2166                         if (subnet.getVpnId() != null) {
2167                             return subnet.getVpnId().getValue();
2168                         }
2169                     }
2170                 }
2171             }
2172         }
2173         return null;
2174     }
2175
2176     Map<String, String> getElanInstanceRouterPortMap(String vpnName) {
2177         Map<String, String> elanInstanceRouterPortMap = new HashMap<>();
2178         Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2179         if (subnetMapsData.isPresent()) {
2180             List<Subnetmap> subnetMapList = new ArrayList<>();
2181             Subnetmaps subnetMaps = subnetMapsData.get();
2182             subnetMapList = (subnetMaps.getSubnetmap() != null && !subnetMaps.getSubnetmap().isEmpty())
2183                     ? new ArrayList<>(subnetMaps.getSubnetmap()) : subnetMapList;
2184
2185             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2186                 for (Subnetmap subnet : subnetMapList) {
2187                     if (subnet.getVpnId() != null && subnet.getVpnId().getValue().equals(vpnName)
2188                             && NetworkType.VLAN.equals(subnet.getNetworkType())) {
2189                         if (subnet.getRouterInterfacePortId() == null || subnet.getNetworkId() == null) {
2190                             LOG.warn("The RouterInterfacePortId or NetworkId is null");
2191                             continue;
2192                         }
2193                         String routerInterfacePortUuid = subnet.getRouterInterfacePortId().getValue();
2194                         if (routerInterfacePortUuid != null && !routerInterfacePortUuid.isEmpty()) {
2195                             elanInstanceRouterPortMap.put(subnet.getNetworkId().getValue(),routerInterfacePortUuid);
2196                         }
2197                     }
2198                 }
2199             }
2200         }
2201         return elanInstanceRouterPortMap;
2202     }
2203
2204     @Nullable
2205     String getRouterPordIdFromElanInstance(String elanInstanceName) {
2206         Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2207         if (subnetMapsData.isPresent()) {
2208             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2209             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2210                 for (Subnetmap subnet : subnetMapList) {
2211                     if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2212                         if (subnet.getRouterInterfacePortId() != null) {
2213                             return subnet.getRouterInterfacePortId().getValue();
2214                         }
2215                     }
2216                 }
2217             }
2218         }
2219         return null;
2220     }
2221
2222     boolean shouldPopulateFibForVlan(String vpnName, @Nullable String elanInstanceName, Uint64 dpnId) {
2223         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
2224         boolean shouldPopulateFibForVlan = false;
2225         if (!elanInstanceRouterPortMap.isEmpty()) {
2226             shouldPopulateFibForVlan = true;
2227         }
2228         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap
2229                 .entrySet()) {
2230             String currentElanInstance = elanInstanceRouterEntry.getKey();
2231             if (elanInstanceName != null && elanInstanceName.equals(currentElanInstance)) {
2232                 continue;
2233             }
2234             String externalinterface = getExternalElanInterface(currentElanInstance ,dpnId);
2235             if (externalinterface == null) {
2236                 shouldPopulateFibForVlan = false;
2237                 break;
2238             }
2239         }
2240         return shouldPopulateFibForVlan;
2241     }
2242
2243     public static InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName,
2244             Uint64 dpId) {
2245         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2246                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2247                 .child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build();
2248     }
2249
2250     public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationalDataPath(String elanInstanceName) {
2251         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2252                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2253                 .build();
2254     }
2255
2256     public static boolean isMatchedPrefixToInterface(Prefixes prefix, VpnInterfaceOpDataEntry vpnInterface) {
2257         if (prefix != null && vpnInterface != null) {
2258             if (prefix.getDpnId() != null && vpnInterface.getDpnId() != null) {
2259                 if (prefix.getVpnInterfaceName() != null && vpnInterface.getName() != null) {
2260                     return prefix.getDpnId().equals(vpnInterface.getDpnId())
2261                             && prefix.getVpnInterfaceName().equalsIgnoreCase(vpnInterface.getName());
2262                 }
2263             }
2264         }
2265         return false;
2266     }
2267
2268     public static void sendNeighborSolicationToOfGroup(Ipv6NdUtilService ipv6NdUtilService, Ipv6Address srcIpv6Address,
2269             MacAddress srcMac, Ipv6Address dstIpv6Address, Long ofGroupId, Uint64 dpId) {
2270         SendNeighborSolicitationToOfGroupInput input = new SendNeighborSolicitationToOfGroupInputBuilder()
2271                 .setSourceIpv6(srcIpv6Address).setSourceLlAddress(srcMac).setTargetIpAddress(dstIpv6Address)
2272                 .setOfGroupId(ofGroupId).setDpId(dpId).build();
2273         try {
2274             Future<RpcResult<SendNeighborSolicitationToOfGroupOutput>> result = ipv6NdUtilService
2275                     .sendNeighborSolicitationToOfGroup(input);
2276             RpcResult<SendNeighborSolicitationToOfGroupOutput> rpcResult = result.get();
2277             if (!rpcResult.isSuccessful()) {
2278                 LOG.error("sendNeighborSolicitationToOfGroup: RPC Call failed for input={} and Errors={}", input,
2279                         rpcResult.getErrors());
2280             }
2281         } catch (InterruptedException | ExecutionException e) {
2282             LOG.error("Failed to send NS packet to ELAN group, input={}", input, e);
2283         }
2284     }
2285
2286     static Set<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn
2287             .instance.vpntargets.VpnTarget> getRtListForVpn(DataBroker dataBroker, String vpnName) {
2288         Set<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn
2289                 .instance.vpntargets.VpnTarget> rtList = new HashSet<>();
2290         try {
2291             InstanceIdentifier<VpnInstance> vpnInstanceId = InstanceIdentifier.builder(VpnInstances.class)
2292                     .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
2293             Optional<VpnInstance> vpnInstanceOptional = SingleTransactionDataBroker.syncReadOptional(dataBroker,
2294                     LogicalDatastoreType.CONFIGURATION, vpnInstanceId);
2295             if (vpnInstanceOptional.isPresent()) {
2296                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances
2297                         .vpn.instance.VpnTargets vpnTargets = vpnInstanceOptional.get().getVpnTargets();
2298                 if (vpnTargets != null && vpnTargets.getVpnTarget() != null) {
2299                     rtList.addAll(vpnTargets.getVpnTarget());
2300                 }
2301             } else {
2302                 LOG.error("getRtListForVpn: Vpn Instance {} not present in config DS", vpnName);
2303             }
2304         } catch (ReadFailedException e) {
2305             LOG.error("getRtListForVpn: Read failed for Vpn Instance {}", vpnName);
2306         }
2307         return rtList;
2308     }
2309
2310     /*
2311     if (update == 0) {
2312     removedFamily = original
2313     4 removed = 4
2314     6 removed = 6
2315     10 removed
2316     } else if (update < original) {
2317     removedFamily = original - update
2318     10 was there 4 removed = 6
2319     10 was there 6 removed  = 4
2320     } else {
2321    return;
2322     }
2323     */
2324     public static int getIpFamilyValueToRemove(VpnInstanceOpDataEntry original, VpnInstanceOpDataEntry update) {
2325         int originalValue = original.getIpAddressFamilyConfigured().getIntValue();
2326         int updatedValue = update.getIpAddressFamilyConfigured().getIntValue();
2327
2328         if (originalValue == updatedValue) {
2329             return 0;
2330         }
2331         int removedFamily;
2332         if (updatedValue == 0) {
2333             removedFamily = originalValue;
2334         } else if (updatedValue < originalValue) {
2335             removedFamily = originalValue - updatedValue;
2336         } else {
2337             return 0;
2338         }
2339         return removedFamily;
2340     }
2341
2342     public static int getIpFamilyValueToAdd(VpnInstanceOpDataEntry original, VpnInstanceOpDataEntry update) {
2343         int originalValue = original.getIpAddressFamilyConfigured().getIntValue();
2344         int updatedValue = update.getIpAddressFamilyConfigured().getIntValue();
2345
2346         if (originalValue != updatedValue) {
2347             return updatedValue;
2348         } else {
2349             return originalValue;
2350         }
2351     }
2352
2353     static InstanceIdentifier<AssociatedVpn> getAssociatedSubnetAndVpnIdentifier(String rt, RouteTarget.RtType rtType,
2354                                                                                  String cidr, String vpnName) {
2355         return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2356                 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr))
2357                 .child(AssociatedVpn.class, new AssociatedVpnKey(vpnName)).build();
2358     }
2359
2360     static InstanceIdentifier<AssociatedSubnet> getAssociatedSubnetIdentifier(String rt, RouteTarget.RtType rtType,
2361                                                                        String cidr) {
2362         return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2363                 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr)).build();
2364     }
2365
2366     static AssociatedVpn buildAssociatedSubnetAndVpn(String vpnName) {
2367         return new AssociatedVpnBuilder().setName(vpnName).build();
2368     }
2369
2370     static InstanceIdentifier<RouteTarget> getRouteTargetsIdentifier(String rt, RouteTarget.RtType rtType) {
2371         return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class)
2372                 .child(RouteTarget.class, new RouteTargetKey(rt, rtType)).build();
2373     }
2374
2375     Set<RouteTarget> getRouteTargetSet(Set<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn
2376             .rev200204.vpn.instances.vpn.instance.vpntargets.VpnTarget> vpnTargets) {
2377         Set<RouteTarget> routeTargetSet = new HashSet<>();
2378         for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn
2379                 .instance.vpntargets.VpnTarget rt : vpnTargets) {
2380             String rtValue = rt.getVrfRTValue();
2381             switch (rt.getVrfRTType()) {
2382                 case ImportExtcommunity: {
2383                     Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2384                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2385                     if (exportRouteTargetOptional.isPresent()) {
2386                         routeTargetSet.add(exportRouteTargetOptional.get());
2387                     }
2388                     break;
2389                 }
2390                 case ExportExtcommunity: {
2391                     Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2392                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2393                     if (importRouteTargetOptional.isPresent()) {
2394                         routeTargetSet.add(importRouteTargetOptional.get());
2395                     }
2396                     break;
2397                 }
2398                 case Both: {
2399                     Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2400                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2401                     if (exportRouteTargetOptional.isPresent()) {
2402                         routeTargetSet.add(exportRouteTargetOptional.get());
2403                     }
2404                     Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2405                             getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2406                     if (importRouteTargetOptional.isPresent()) {
2407                         routeTargetSet.add(importRouteTargetOptional.get());
2408                     }
2409                     break;
2410                 }
2411                 default:
2412                     LOG.error("getRouteTargetSet: Invalid rt-type {}", rt.getVrfRTType());
2413             }
2414         }
2415         return routeTargetSet;
2416     }
2417
2418     /*
2419     TODO: (vivek/kiran): Subnet overlap in a VPN detection logic should use subnet allocation pools if available
2420            rather than only CIDR.
2421            Also the Subnet overlap in a VPN detection logic to be addressed for router-based-l3vpns.
2422     */
2423     static boolean areSubnetsOverlapping(String cidr1, String cidr2) {
2424         final int slash1 = cidr1.indexOf('/');
2425         final int address1 = addressForCidr(cidr1, slash1);
2426         final int cidrPart1 = maskForCidr(cidr1, slash1);
2427
2428         final int slash2 = cidr2.indexOf('/');
2429         final int address2 = addressForCidr(cidr2, slash2);
2430         final int cidrPart2 = maskForCidr(cidr2, slash2);
2431
2432         final int comparedValue = cidrPart1 <= cidrPart2 ? compare(address1, cidrPart1, address2)
2433                 : compare(address2, cidrPart2, address1);
2434         return comparedValue == 0;
2435     }
2436
2437     private static int addressForCidr(String cidr, int slash) {
2438         return InetAddresses.coerceToInteger(InetAddresses.forString(cidr.substring(0, slash)));
2439     }
2440
2441     private static int maskForCidr(String cidr, int slash) {
2442         return Integer.parseInt(cidr.substring(slash + 1));
2443     }
2444
2445     private static int compare(int address, int cidrPart, int address2) {
2446         int prefix = address2 & computeNetmask(cidrPart);
2447         return address ^ prefix;
2448     }
2449
2450     private static int computeNetmask(int cidrPart) {
2451         int netmask = 0;
2452         for (int j = 0; j < cidrPart; ++j) {
2453             netmask |= 1 << 31 - j;
2454         }
2455         return netmask;
2456     }
2457
2458     public static String buildIpMonitorJobKey(String ip, String vpnName) {
2459         return VpnConstants.IP_MONITOR_JOB_PREFIX_KEY + "-" + vpnName + "-" + ip;
2460     }
2461
2462     public static List<String> getVpnListForVpnInterface(VpnInterface vpnInter) {
2463         return vpnInter.nonnullVpnInstanceNames().stream()
2464                 .map(VpnInstanceNames::getVpnName).collect(Collectors.toList());
2465     }
2466
2467     public void updateVpnInstanceWithRdList(String vpnName, List<String> updatedRdList) {
2468         String primaryRd = getVpnRd(vpnName);
2469         if (primaryRd == null) {
2470             LOG.warn("updateVpnInstanceWithRdList: Unable to retrieve primary RD for the VPN {}. Skip to process "
2471                     + "the updated RD list {} ", vpnName, updatedRdList);
2472             return;
2473         }
2474         jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
2475             VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd);
2476             builder.setRd(updatedRdList);
2477             return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
2478                     OPERATIONAL, tx -> {
2479                     InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
2480                             .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
2481                                     new VpnInstanceOpDataEntryKey(primaryRd)).build();
2482                     tx.merge(id, builder.build(), false);
2483                     LOG.debug("updateVpnInstanceWithRdList: Successfully updated the VPN {} with list of RDs {}",
2484                             vpnName, updatedRdList);
2485                 }));
2486         });
2487     }
2488
2489     public static RouteOrigin getRouteOrigin(AdjacencyType adjacencyType) {
2490         RouteOrigin origin = RouteOrigin.LOCAL;
2491         switch (adjacencyType) {
2492             case PrimaryAdjacency:
2493                 origin = RouteOrigin.LOCAL;
2494                 break;
2495             case ExtraRoute:
2496                 origin = RouteOrigin.STATIC;
2497                 break;
2498             case LearntIp:
2499                 origin = RouteOrigin.DYNAMIC;
2500                 break;
2501             default:
2502                 LOG.warn("Unknown adjacencyType={}", adjacencyType);
2503         }
2504         return origin;
2505     }
2506
2507     public static boolean isDualRouterVpnUpdate(List<String> oldVpnListCopy, List<String> newVpnListCopy) {
2508         return oldVpnListCopy.size() == 2 && newVpnListCopy.size() == 3
2509                 || oldVpnListCopy.size() == 3 && newVpnListCopy.size() == 2;
2510     }
2511
2512     // TODO Clean up the exception handling
2513     @SuppressWarnings("checkstyle:IllegalCatch")
2514     public void createVpnPortFixedIpToPort(String vpnName, String fixedIp,
2515                                                      String portName, boolean isLearntIp, String macAddress,
2516                                                      WriteTransaction writeConfigTxn) {
2517         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
2518         VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder().withKey(new VpnPortipToPortKey(fixedIp, vpnName))
2519                 .setVpnName(vpnName).setPortFixedip(fixedIp).setPortName(portName)
2520                 .setLearntIp(isLearntIp).setSubnetIp(false).setMacAddress(macAddress.toLowerCase(Locale.getDefault()));
2521         try {
2522             if (writeConfigTxn != null) {
2523                 writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION, id, builder.build());
2524             } else {
2525                 syncWrite(LogicalDatastoreType.CONFIGURATION, id, builder.build());
2526             }
2527             LOG.trace("Port with Ip: {}, vpn {}, interface {}, learntIp {} added to VpnPortipToPort DS",
2528                     fixedIp, vpnName, portName, isLearntIp);
2529         } catch (Exception e) {
2530             LOG.error("Failure while creating VpnPortIpToPort map for vpn {} learnIp{}", vpnName, fixedIp, e);
2531         }
2532     }
2533
2534     protected VpnPortipToPort getVpnPortipToPort(String vpnName, String fixedIp) {
2535         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
2536         Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
2537         if (vpnPortipToPortData.isPresent()) {
2538             return vpnPortipToPortData.get();
2539         }
2540         LOG.error("getVpnPortipToPort: Failed as vpnPortipToPortData DS is absent for VPN {} and fixed IP {}",
2541                 vpnName, fixedIp);
2542         return null;
2543     }
2544
2545     public static void enableArpLearning(Boolean isArpLearningEnabled) {
2546         arpLearningEnabled = isArpLearningEnabled;
2547     }
2548
2549     public static Boolean isArpLearningEnabled() {
2550         return arpLearningEnabled;
2551     }
2552
2553     private static ReentrantLock lockFor(String vpnName, String fixedIp) {
2554         // FIXME: is there some identifier we can use? LearntVpnVipToPortKey perhaps?
2555         return JvmGlobalLocks.getLockForString(vpnName + fixedIp);
2556     }
2557 }