neutronvpn/impl/src/main/java/org/opendaylight/netvirt/neutronvpn/NeutronvpnUtils.java

   1 /*
   2  * Copyright (c) 2016, 2018 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 package org.opendaylight.netvirt.neutronvpn;
   9
  10 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
  11
  12 import com.google.common.base.Function;
  13 import com.google.common.base.Optional;
  14 import com.google.common.collect.ImmutableBiMap;
  15 import com.google.common.collect.ImmutableSet;
  16 import com.google.common.collect.Sets;
  17 import com.google.common.util.concurrent.FutureCallback;
  18 import com.google.common.util.concurrent.Futures;
  19 import com.google.common.util.concurrent.MoreExecutors;
  20 import com.google.common.util.concurrent.SettableFuture;
  21 import java.net.Inet4Address;
  22 import java.net.Inet6Address;
  23 import java.net.InetAddress;
  24 import java.net.UnknownHostException;
  25 import java.util.ArrayList;
  26 import java.util.Collection;
  27 import java.util.Collections;
  28 import java.util.Iterator;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Set;
  32 import java.util.concurrent.ConcurrentHashMap;
  33 import java.util.concurrent.ConcurrentMap;
  34 import java.util.concurrent.ExecutionException;
  35 import java.util.concurrent.locks.ReentrantLock;
  36 import javax.inject.Inject;
  37 import javax.inject.Singleton;
  38 import org.apache.commons.lang3.StringUtils;
  39 import org.eclipse.jdt.annotation.NonNull;
  40 import org.eclipse.jdt.annotation.Nullable;
  41 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  42 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  43 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  44 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  45 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  46 import org.opendaylight.genius.infra.Datastore;
  47 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  48 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  49 import org.opendaylight.genius.infra.TypedWriteTransaction;
  50 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  51 import org.opendaylight.genius.utils.JvmGlobalLocks;
  52 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  53 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
  54 import org.opendaylight.infrautils.utils.concurrent.LoggingFutures;
  55 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
  56 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
  57 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  58 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  59 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  60 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  61 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  62 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAcl;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfo;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoBuilder;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoKey;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortIdSubportData;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnMaps;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.port.id.subport.data.PortIdToSubport;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.port.id.subport.data.PortIdToSubportKey;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIds;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIdsBuilder;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMap;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapKey;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
 142 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 143 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
 144 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
 145 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 146 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
 147 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
 148 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
 149 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 150 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 151 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 152 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 153 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
 154 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
 155 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
 156 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
 157 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
 158 import org.opendaylight.yangtools.yang.binding.DataObject;
 159 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 160 import org.opendaylight.yangtools.yang.common.RpcResult;
 161 import org.opendaylight.yangtools.yang.common.Uint64;
 162 import org.slf4j.Logger;
 163 import org.slf4j.LoggerFactory;
 164
 165 @Singleton
 166 public class NeutronvpnUtils {
 167
 168     private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
 169     private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
 170         NETWORK_MAP =
 171         new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
 172             .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
 173             .put(NetworkTypeGre.class, SegmentTypeGre.class)
 174             .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
 175             .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
 176             .build();
 177
 178     private static final ImmutableSet<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = ImmutableSet.of(
 179         NetworkTypeFlat.class,
 180         NetworkTypeVlan.class,
 181         NetworkTypeVxlan.class,
 182         NetworkTypeGre.class);
 183
 184
 185     private static final InstanceIdentifier<VpnInstanceOpData> VPN_INSTANCE_OP_DATA_IID =
 186             InstanceIdentifier.create(VpnInstanceOpData.class);
 187     private static final InstanceIdentifier<VpnMaps> VPN_MAPS_IID = InstanceIdentifier.create(VpnMaps.class);
 188     private static final InstanceIdentifier<Subnetmaps> SUBNETMAPS_IID = InstanceIdentifier.create(Subnetmaps.class);
 189     private static final InstanceIdentifier<Networks> NEUTRON_NETWORKS_IID = InstanceIdentifier.builder(Neutron.class)
 190             .child(Networks.class).build();
 191     private static final InstanceIdentifier<Ports> NEUTRON_PORTS_IID = InstanceIdentifier.builder(Neutron.class)
 192             .child(Ports.class).build();
 193     private static final InstanceIdentifier<Routers> NEUTRON_ROUTERS_IID = InstanceIdentifier.builder(Neutron.class)
 194             .child(Routers.class).build();
 195     private static final InstanceIdentifier<Subnets> NEUTRON_SUBNETS_IID = InstanceIdentifier.builder(Neutron.class)
 196             .child(Subnets.class).build();
 197
 198     private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
 199     private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
 200     private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
 201     private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
 202     private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
 203
 204     private final DataBroker dataBroker;
 205     private final ManagedNewTransactionRunner txRunner;
 206     private final IdManagerService idManager;
 207     private final JobCoordinator jobCoordinator;
 208     private final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
 209     private static final int JOB_MAX_RETRIES = 3;
 210
 211     @Inject
 212     public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
 213             final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
 214         this.dataBroker = dataBroker;
 215         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
 216         this.idManager = idManager;
 217         this.jobCoordinator = jobCoordinator;
 218         this.ipV6InternetDefRt = ipV6InternetDefRt;
 219     }
 220
 221     @Nullable
 222     protected Subnetmap getSubnetmap(Uuid subnetId) {
 223         InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
 224         Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
 225
 226         if (sn.isPresent()) {
 227             return sn.get();
 228         }
 229         LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
 230         return null;
 231     }
 232
 233     @Nullable
 234     public VpnMap getVpnMap(Uuid id) {
 235         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(id));
 236         if (optionalVpnMap.isPresent()) {
 237             return optionalVpnMap.get();
 238         }
 239         LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
 240         return null;
 241     }
 242
 243     @Nullable
 244     protected Uuid getVpnForNetwork(Uuid network) {
 245         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, VPN_MAPS_IID);
 246         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().nonnullVpnMap() != null) {
 247             for (VpnMap vpnMap : new ArrayList<>(optionalVpnMaps.get().nonnullVpnMap())) {
 248                 List<Uuid> netIds = vpnMap.getNetworkIds();
 249                 if (netIds != null && netIds.contains(network)) {
 250                     return vpnMap.getVpnId();
 251                 }
 252             }
 253         }
 254         LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
 255         return null;
 256     }
 257
 258     @Nullable
 259     protected Uuid getVpnForSubnet(Uuid subnetId) {
 260         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 261         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 262                 subnetmapIdentifier);
 263         if (optionalSubnetMap.isPresent()) {
 264             return optionalSubnetMap.get().getVpnId();
 265         }
 266         LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 267         return null;
 268     }
 269
 270     @Nullable
 271     protected Uuid getNetworkForSubnet(Uuid subnetId) {
 272         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 273         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 274                 subnetmapIdentifier);
 275         if (optionalSubnetMap.isPresent()) {
 276             return optionalSubnetMap.get().getNetworkId();
 277         }
 278         LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 279         return null;
 280     }
 281
 282     // @param external vpn - true if external vpn being fetched, false for internal vpn
 283     @Nullable
 284     protected Uuid getVpnForRouter(@Nullable Uuid routerId, boolean externalVpn) {
 285         if (routerId == null) {
 286             return null;
 287         }
 288
 289         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, VPN_MAPS_IID);
 290         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().nonnullVpnMap() != null) {
 291             for (VpnMap vpnMap : new ArrayList<>(optionalVpnMaps.get().nonnullVpnMap())) {
 292                 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap
 293                     .RouterIds> routerIdsList = vpnMap.getRouterIds();
 294                 if (routerIdsList == null || routerIdsList.isEmpty()) {
 295                     continue;
 296                 }
 297                 // Skip router vpnId fetching from internet BGP-VPN
 298                 if (vpnMap.getNetworkIds() != null && !vpnMap.getNetworkIds().isEmpty()) {
 299                     // We only need to check the first network; if it’s not an external network there’s no
 300                     // need to check the rest of the VPN’s network list
 301                     if (getIsExternal(getNeutronNetwork(vpnMap.getNetworkIds().iterator().next()))) {
 302                         continue;
 303                     }
 304                 }
 305                 // FIXME: NETVIRT-1503: this check can be replaced by a ReadOnlyTransaction.exists()
 306                 if (routerIdsList.stream().anyMatch(routerIds -> routerId.equals(routerIds.getRouterId()))) {
 307                     if (externalVpn) {
 308                         if (!routerId.equals(vpnMap.getVpnId())) {
 309                             return vpnMap.getVpnId();
 310                         }
 311                     } else {
 312                         if (routerId.equals(vpnMap.getVpnId())) {
 313                             return vpnMap.getVpnId();
 314                         }
 315                     }
 316                 }
 317             }
 318         }
 319         LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
 320         return null;
 321     }
 322
 323     @Nullable
 324     protected List<Uuid> getRouterIdListforVpn(Uuid vpnId) {
 325         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId));
 326         if (optionalVpnMap.isPresent()) {
 327             VpnMap vpnMap = optionalVpnMap.get();
 328             return NeutronUtils.getVpnMapRouterIdsListUuid(vpnMap.getRouterIds());
 329         }
 330         LOG.error("getRouterIdListforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 331         return null;
 332     }
 333
 334     @Nullable
 335     protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
 336         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId));
 337         if (optionalVpnMap.isPresent()) {
 338             VpnMap vpnMap = optionalVpnMap.get();
 339             if (vpnMap.getNetworkIds() != null && !vpnMap.getNetworkIds().isEmpty()) {
 340                 return new ArrayList<>(vpnMap.getNetworkIds());
 341             } else {
 342                 return null;
 343             }
 344         }
 345         LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 346         return null;
 347     }
 348
 349     protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
 350         List<Uuid> subnets = new ArrayList<>();
 351         // read subnetmaps
 352         Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
 353         if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
 354             List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
 355             for (Subnetmap candidateSubnetMap : subnetMapList) {
 356                 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
 357                     subnets.add(candidateSubnetMap.getId());
 358                 }
 359             }
 360         }
 361         return subnets;
 362     }
 363
 364     @Nullable
 365     protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
 366         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 367         Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
 368         if (vpnPortipToPortData.isPresent()) {
 369             return vpnPortipToPortData.get().getPortName();
 370         }
 371         LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
 372                 + " fixed IP {}", vpnName, fixedIp);
 373         return null;
 374     }
 375
 376     @Nullable
 377     protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
 378         InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
 379         Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
 380         if (optionalNetworkMap.isPresent()) {
 381             return optionalNetworkMap.get().getSubnetIdList();
 382         }
 383         LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
 384         return null;
 385     }
 386
 387     protected Router getNeutronRouter(Uuid routerId) {
 388         Router router = routerMap.get(routerId);
 389         if (router != null) {
 390             return router;
 391         }
 392         Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, getNeutronRouterIid(routerId));
 393         if (rtr.isPresent()) {
 394             router = rtr.get();
 395         }
 396         return router;
 397     }
 398
 399     public InstanceIdentifier<Router> getNeutronRouterIid(Uuid routerId) {
 400         return NEUTRON_ROUTERS_IID.child(Router.class, new RouterKey(routerId));
 401     }
 402
 403     protected Network getNeutronNetwork(Uuid networkId) {
 404         Network network = null;
 405         network = networkMap.get(networkId);
 406         if (network != null) {
 407             return network;
 408         }
 409         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
 410         InstanceIdentifier<Network> inst = NEUTRON_NETWORKS_IID.child(Network.class, new NetworkKey(networkId));
 411         Optional<Network> net = read(LogicalDatastoreType.CONFIGURATION, inst);
 412         if (net.isPresent()) {
 413             network = net.get();
 414         }
 415         return network;
 416     }
 417
 418     protected Port getNeutronPort(Uuid portId) {
 419         Port prt = portMap.get(portId);
 420         if (prt != null) {
 421             return prt;
 422         }
 423         LOG.debug("getNeutronPort for {}", portId.getValue());
 424         InstanceIdentifier<Port> inst = NEUTRON_PORTS_IID.child(Port.class, new PortKey(portId));
 425         Optional<Port> port = read(LogicalDatastoreType.CONFIGURATION, inst);
 426         if (port.isPresent()) {
 427             prt = port.get();
 428         }
 429         return prt;
 430     }
 431
 432     public PortIdToSubport getPortIdToSubport(Uuid portId) {
 433         InstanceIdentifier<PortIdToSubport> portIdToSubportIdentifier = buildPortIdSubportMappingIdentifier(portId);
 434         Optional<PortIdToSubport> optionalPortIdToSubport = read(LogicalDatastoreType.CONFIGURATION,
 435                 portIdToSubportIdentifier);
 436         if (optionalPortIdToSubport.isPresent()) {
 437             return optionalPortIdToSubport.get();
 438         }
 439         LOG.error("getPortIdToSubport failed, PortIdToSubport {} not present", portId.getValue());
 440         return null;
 441     }
 442
 443     protected static boolean isDhcpServerPort(Port port) {
 444         return port.getDeviceOwner().equals("network:dhcp");
 445     }
 446
 447     protected InterfaceAcl getDhcpInterfaceAcl(Port port) {
 448         InterfaceAclBuilder interfaceAclBuilder = new InterfaceAclBuilder();
 449         interfaceAclBuilder.setPortSecurityEnabled(false);
 450         interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.DhcpService);
 451         List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
 452                 port.getMacAddress(), port.getFixedIps());
 453         interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
 454         return interfaceAclBuilder.build();
 455     }
 456
 457     /**
 458      * Returns port_security_enabled status with the port.
 459      *
 460      * @param port the port
 461      * @return port_security_enabled status
 462      */
 463     protected static boolean getPortSecurityEnabled(Port port) {
 464         String deviceOwner = port.getDeviceOwner();
 465         if (deviceOwner != null && deviceOwner.startsWith("network:")) {
 466             // port with device owner of network:xxx is created by
 467             // neutorn for its internal use. So security group doesn't apply.
 468             // router interface, dhcp port and floating ip.
 469             return false;
 470         }
 471         PortSecurityExtension portSecurity = port.augmentation(PortSecurityExtension.class);
 472         if (portSecurity != null) {
 473             return portSecurity.isPortSecurityEnabled();
 474         }
 475         return false;
 476     }
 477
 478     /**
 479      * Gets security group UUIDs delta   .
 480      *
 481      * @param port1SecurityGroups the port 1 security groups
 482      * @param port2SecurityGroups the port 2 security groups
 483      * @return the security groups delta
 484      */
 485     @Nullable
 486     protected static List<Uuid> getSecurityGroupsDelta(@Nullable List<Uuid> port1SecurityGroups,
 487             @Nullable List<Uuid> port2SecurityGroups) {
 488         if (port1SecurityGroups == null) {
 489             return null;
 490         }
 491
 492         if (port2SecurityGroups == null) {
 493             return port1SecurityGroups;
 494         }
 495
 496         List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
 497         List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
 498         for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
 499             Uuid securityGroup1 = iterator.next();
 500             for (Uuid securityGroup2 : list2) {
 501                 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
 502                     iterator.remove();
 503                     break;
 504                 }
 505             }
 506         }
 507         return list1;
 508     }
 509
 510     /**
 511      * Gets the fixed ips delta.
 512      *
 513      * @param port1FixedIps the port 1 fixed ips
 514      * @param port2FixedIps the port 2 fixed ips
 515      * @return the fixed ips delta
 516      */
 517     protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
 518         if (port1FixedIps == null) {
 519             return null;
 520         }
 521
 522         if (port2FixedIps == null) {
 523             return port1FixedIps;
 524         }
 525
 526         List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
 527         List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
 528         for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
 529             FixedIps fixedIps1 = iterator.next();
 530             for (FixedIps fixedIps2 : list2) {
 531                 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
 532                     iterator.remove();
 533                     break;
 534                 }
 535             }
 536         }
 537         return list1;
 538     }
 539
 540     /**
 541      * Gets the allowed address pairs delta.
 542      *
 543      * @param port1AllowedAddressPairs the port 1 allowed address pairs
 544      * @param port2AllowedAddressPairs the port 2 allowed address pairs
 545      * @return the allowed address pairs delta
 546      */
 547     @Nullable
 548     protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
 549         @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 550             .AllowedAddressPairs> port1AllowedAddressPairs,
 551         @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 552             .AllowedAddressPairs> port2AllowedAddressPairs) {
 553         if (port1AllowedAddressPairs == null) {
 554             return null;
 555         }
 556
 557         if (port2AllowedAddressPairs == null) {
 558             return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
 559         }
 560
 561         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 562             .AllowedAddressPairs> list1 =
 563                 new ArrayList<>(port1AllowedAddressPairs);
 564         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 565             .AllowedAddressPairs> list2 =
 566                 new ArrayList<>(port2AllowedAddressPairs);
 567         for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 568             .AllowedAddressPairs> iterator =
 569              list1.iterator(); iterator.hasNext();) {
 570             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 571                 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
 572             for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 573                      .AllowedAddressPairs allowedAddressPair2 : list2) {
 574                 if (allowedAddressPair1.key().equals(allowedAddressPair2.key())) {
 575                     iterator.remove();
 576                     break;
 577                 }
 578             }
 579         }
 580         return getAllowedAddressPairsForAclService(list1);
 581     }
 582
 583     /**
 584      * Gets the acl allowed address pairs.
 585      *
 586      * @param macAddress the mac address
 587      * @param ipAddress the ip address
 588      * @return the acl allowed address pairs
 589      */
 590     protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
 591             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
 592         AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
 593         aclAllowedAdressPairBuilder.setMacAddress(macAddress);
 594         if (ipAddress != null && ipAddress.stringValue() != null) {
 595             if (ipAddress.getIpPrefix() != null) {
 596                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
 597             } else {
 598                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
 599             }
 600         }
 601         return aclAllowedAdressPairBuilder.build();
 602     }
 603
 604     /**
 605      * Gets the allowed address pairs for acl service.
 606      *
 607      * @param macAddress the mac address
 608      * @param fixedIps the fixed ips
 609      * @return the allowed address pairs for acl service
 610      */
 611     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
 612             List<FixedIps> fixedIps) {
 613         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 614         for (FixedIps fixedIp : fixedIps) {
 615             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
 616                     org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
 617                     .getDefaultInstance(fixedIp.getIpAddress().stringValue())));
 618         }
 619         return aclAllowedAddressPairs;
 620     }
 621
 622     /**
 623      * Gets the allowed address pairs for acl service.
 624      *
 625      * @param portAllowedAddressPairs the port allowed address pairs
 626      * @return the allowed address pairs for acl service
 627      */
 628     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
 629         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 630             .AllowedAddressPairs> portAllowedAddressPairs) {
 631         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 632         for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
 633                  portAllowedAddressPair : portAllowedAddressPairs) {
 634             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
 635                 portAllowedAddressPair.getIpAddress()));
 636         }
 637         return aclAllowedAddressPairs;
 638     }
 639
 640     /**
 641      * Gets the IPv6 Link Local Address corresponding to the MAC Address.
 642      *
 643      * @param macAddress the mac address
 644      * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
 645      */
 646     protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
 647         IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
 648         return getAclAllowedAddressPairs(macAddress,
 649                 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
 650                 .getDefaultInstance(
 651                         ipv6LinkLocalAddress.stringValue()));
 652     }
 653
 654     /**
 655      * Gets the updated security groups.
 656      *
 657      * @param aclInterfaceSecurityGroups the acl interface security groups
 658      * @param origSecurityGroups the orig security groups
 659      * @param newSecurityGroups the new security groups
 660      * @return the updated security groups
 661      */
 662     protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
 663             List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
 664         List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
 665         List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
 666         List<Uuid> updatedSecurityGroups =
 667                 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
 668         if (addedGroups != null) {
 669             updatedSecurityGroups.addAll(addedGroups);
 670         }
 671         if (deletedGroups != null) {
 672             updatedSecurityGroups.removeAll(deletedGroups);
 673         }
 674         return updatedSecurityGroups;
 675     }
 676
 677     /**
 678      * Gets the allowed address pairs for fixed ips.
 679      *
 680      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 681      * @param portMacAddress the port mac address
 682      * @param origFixedIps the orig fixed ips
 683      * @param newFixedIps the new fixed ips
 684      * @return the allowed address pairs for fixed ips
 685      */
 686     protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
 687             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
 688             List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
 689         List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
 690         List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
 691         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 692             aclInterfaceAllowedAddressPairs != null
 693                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 694         if (deletedFixedIps != null) {
 695             updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
 696         }
 697         if (addedFixedIps != null) {
 698             updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
 699         }
 700         return updatedAllowedAddressPairs;
 701     }
 702
 703     /**
 704      * Gets the updated allowed address pairs.
 705      *
 706      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 707      * @param origAllowedAddressPairs the orig allowed address pairs
 708      * @param newAllowedAddressPairs the new allowed address pairs
 709      * @return the updated allowed address pairs
 710      */
 711     protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
 712             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
 713             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 714                 .AllowedAddressPairs> origAllowedAddressPairs,
 715             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 716                 .AllowedAddressPairs> newAllowedAddressPairs) {
 717         List<AllowedAddressPairs> addedAllowedAddressPairs =
 718             getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
 719         List<AllowedAddressPairs> deletedAllowedAddressPairs =
 720             getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
 721         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 722             aclInterfaceAllowedAddressPairs != null
 723                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 724         if (addedAllowedAddressPairs != null) {
 725             updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
 726         }
 727         if (deletedAllowedAddressPairs != null) {
 728             updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
 729         }
 730         return updatedAllowedAddressPairs;
 731     }
 732
 733     /**
 734      * Populate interface acl builder.
 735      *
 736      * @param interfaceAclBuilder the interface acl builder
 737      * @param port the port
 738      */
 739     protected void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
 740         // Handle security group enabled
 741         List<Uuid> securityGroups = port.getSecurityGroups();
 742         if (securityGroups != null) {
 743             interfaceAclBuilder.setSecurityGroups(securityGroups);
 744         }
 745         List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
 746                 port.getMacAddress(), port.getFixedIps());
 747         // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
 748         aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
 749         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
 750             portAllowedAddressPairs = port.getAllowedAddressPairs();
 751         if (portAllowedAddressPairs != null) {
 752             aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
 753         }
 754         interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
 755         interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.AccessPort);
 756         populateSubnetInfo(interfaceAclBuilder, port);
 757     }
 758
 759     protected void populateSubnetInfo(InterfaceAclBuilder interfaceAclBuilder, Port port) {
 760         List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
 761         if (portSubnetInfo != null) {
 762             interfaceAclBuilder.setSubnetInfo(portSubnetInfo);
 763         }
 764     }
 765
 766     @Nullable
 767     protected List<SubnetInfo> getSubnetInfo(Port port) {
 768         List<FixedIps> portFixedIps = port.getFixedIps();
 769         if (portFixedIps == null) {
 770             LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
 771             return null;
 772         }
 773         List<SubnetInfo> subnetInfoList = new ArrayList<>();
 774         for (FixedIps portFixedIp : portFixedIps) {
 775             Uuid subnetId = portFixedIp.getSubnetId();
 776             Subnet subnet = getNeutronSubnet(subnetId);
 777             if (subnet != null) {
 778                 Class<? extends IpVersionBase> ipVersion =
 779                         NeutronSecurityRuleConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
 780                 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
 781                         : NeutronSecurityRuleConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
 782                 SubnetInfo subnetInfo = new SubnetInfoBuilder().withKey(new SubnetInfoKey(subnetId))
 783                         .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
 784                         .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
 785                 subnetInfoList.add(subnetInfo);
 786             }
 787         }
 788         return subnetInfoList;
 789     }
 790
 791     protected Subnet getNeutronSubnet(Uuid subnetId) {
 792         Subnet subnet = subnetMap.get(subnetId);
 793         if (subnet != null) {
 794             return subnet;
 795         }
 796         InstanceIdentifier<Subnet> inst = NEUTRON_SUBNETS_IID.child(Subnet.class, new SubnetKey(subnetId));
 797         Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
 798
 799         if (sn.isPresent()) {
 800             subnet = sn.get();
 801             addToSubnetCache(subnet);
 802         }
 803         return subnet;
 804     }
 805
 806     protected List<Subnetmap> getNeutronRouterSubnetMapList(Uuid routerId) {
 807         List<Subnetmap> subnetMapList = new ArrayList<>();
 808         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
 809         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
 810             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
 811                 if (routerId.equals(subnetmap.getRouterId())) {
 812                     subnetMapList.add(subnetmap);
 813                 }
 814             }
 815         }
 816         LOG.debug("getNeutronRouterSubnetMapList returns {}", subnetMapList);
 817         return subnetMapList;
 818     }
 819
 820     @NonNull
 821     protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
 822         LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
 823         List<Uuid> subnetIdList = new ArrayList<>();
 824         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
 825         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
 826             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
 827                 if (routerId.equals(subnetmap.getRouterId())) {
 828                     subnetIdList.add(subnetmap.getId());
 829                 }
 830             }
 831         }
 832         LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
 833         return subnetIdList;
 834     }
 835
 836     // TODO Clean up the exception handling and the console output
 837     @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
 838     @Nullable
 839     protected Short getIPPrefixFromPort(Port port) {
 840         try {
 841             // FIXME: why are we not using getNeutronSubnet() here? it does caching for us...
 842             Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION,
 843                 NEUTRON_SUBNETS_IID.child(Subnet.class, new SubnetKey(port.getFixedIps().get(0).getSubnetId())));
 844             if (subnet.isPresent()) {
 845                 String cidr = subnet.get().getCidr().stringValue();
 846                 // Extract the prefix length from cidr
 847                 String[] parts = cidr.split("/");
 848                 if (parts.length == 2) {
 849                     return Short.valueOf(parts[1]);
 850                 } else {
 851                     LOG.trace("Could not retrieve prefix from subnet CIDR");
 852                 }
 853             } else {
 854                 LOG.trace("Unable to read on subnet datastore");
 855             }
 856         } catch (Exception e) {
 857             LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
 858         }
 859         LOG.error("Failed for port {}", port.getUuid().getValue());
 860         return null;
 861     }
 862
 863     // TODO Clean up the exception handling
 864     @SuppressWarnings("checkstyle:IllegalCatch")
 865     protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
 866             boolean isSubnetIp, TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
 867         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 868         VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
 869             .withKey(new VpnPortipToPortKey(fixedIp, vpnName))
 870             .setVpnName(vpnName).setPortFixedip(fixedIp)
 871             .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
 872         try {
 873             if (writeConfigTxn != null) {
 874                 writeConfigTxn.put(id, builder.build());
 875             } else {
 876                 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
 877             }
 878             LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
 879                 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
 880         } catch (Exception e) {
 881             LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 882                     e);
 883         }
 884     }
 885
 886     // TODO Clean up the exception handling
 887     @SuppressWarnings("checkstyle:IllegalCatch")
 888     protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp,
 889                                               TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
 890         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 891         try {
 892             if (writeConfigTxn != null) {
 893                 writeConfigTxn.delete(id);
 894             } else {
 895                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
 896             }
 897             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from VpnPortipToPort DS", fixedIp,
 898                     vpnName);
 899         } catch (Exception e) {
 900             LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 901                     e);
 902         }
 903     }
 904
 905     // TODO Clean up the exception handling
 906     @SuppressWarnings("checkstyle:IllegalCatch")
 907     protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
 908         InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 909         // FIXME: can we use 'id' as the lock name?
 910         final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnName + fixedIp);
 911         lock.lock();
 912         try {
 913             MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
 914             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 915                     vpnName);
 916         } catch (Exception e) {
 917             LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
 918                 vpnName, fixedIp, e);
 919         } finally {
 920             lock.unlock();
 921         }
 922     }
 923
 924     public void addToNetworkCache(Network network) {
 925         networkMap.put(network.getUuid(), network);
 926     }
 927
 928     public void removeFromNetworkCache(Network network) {
 929         networkMap.remove(network.getUuid());
 930     }
 931
 932     public void addToRouterCache(Router router) {
 933         routerMap.put(router.getUuid(), router);
 934     }
 935
 936     public void removeFromRouterCache(Router router) {
 937         routerMap.remove(router.getUuid());
 938     }
 939
 940     public Collection<Router> getAllRouters() {
 941         return routerMap.values();
 942     }
 943
 944     public void addToPortCache(Port port) {
 945         portMap.put(port.getUuid(), port);
 946     }
 947
 948     public void removeFromPortCache(Port port) {
 949         portMap.remove(port.getUuid());
 950     }
 951
 952     public void addToSubnetCache(Subnet subnet) {
 953         subnetMap.put(subnet.getUuid(), subnet);
 954         IpAddress gatewayIp = subnet.getGatewayIp();
 955         if (gatewayIp != null) {
 956             subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
 957         }
 958     }
 959
 960     public void removeFromSubnetCache(Subnet subnet) {
 961         subnetMap.remove(subnet.getUuid());
 962         IpAddress gatewayIp = subnet.getGatewayIp();
 963         if (gatewayIp != null) {
 964             Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
 965             if (gwIps != null) {
 966                 gwIps.remove(subnet.getUuid());
 967             }
 968         }
 969     }
 970
 971     public static String getSegmentationIdFromNeutronNetwork(Network network) {
 972         String segmentationId = null;
 973         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 974         if (providerExtension != null) {
 975             Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
 976             segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
 977         }
 978
 979         return segmentationId;
 980     }
 981
 982     public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
 983         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 984         return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
 985     }
 986
 987     public static String getPhysicalNetworkName(Network network) {
 988         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 989         return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
 990     }
 991
 992     public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
 993         return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
 994     }
 995
 996     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
 997         InstanceIdentifier<VpnPortipToPort> id =
 998             InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
 999                 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
1000         return id;
1001     }
1002
1003     static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
1004         InstanceIdentifier<LearntVpnVipToPort> id =
1005             InstanceIdentifier.builder(LearntVpnVipToPortData.class)
1006                 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1007         return id;
1008     }
1009
1010     static Boolean getIsExternal(Network network) {
1011         NetworkL3Extension ext = network.augmentation(NetworkL3Extension.class);
1012         return ext != null && ext.isExternal();
1013     }
1014
1015     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1016         InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1017                 NetworkMapKey(networkId)).build();
1018         return id;
1019     }
1020
1021     static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
1022         InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1023                 .class, new VpnInterfaceKey(ifName)).build();
1024         return id;
1025     }
1026
1027     static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1028         return SUBNETMAPS_IID.child(Subnetmap.class, new SubnetmapKey(subnetId));
1029     }
1030
1031     static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1032         InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1033                 InterfaceKey(interfaceName)).build();
1034         return id;
1035     }
1036
1037     static InstanceIdentifier<PortIdToSubport> buildPortIdSubportMappingIdentifier(Uuid interfaceName) {
1038         InstanceIdentifier<PortIdToSubport> id = InstanceIdentifier.builder(NeutronVpnPortIdSubportData.class)
1039                 .child(PortIdToSubport.class, new PortIdToSubportKey(interfaceName)).build();
1040         return id;
1041     }
1042
1043     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1044             .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1045         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1046                 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1047                 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1048                 .getValue())).build();
1049         return id;
1050     }
1051
1052     static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1053         return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1054                 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1055     }
1056
1057     // TODO Remove this method entirely
1058     @SuppressWarnings("checkstyle:IllegalCatch")
1059     private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1060         try {
1061             return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1062         } catch (ReadFailedException e) {
1063             throw new RuntimeException(e);
1064         }
1065     }
1066
1067     @Nullable
1068     static ProviderTypes getProviderNetworkType(Network network) {
1069         if (network == null) {
1070             LOG.error("Error in getting provider network type since network is null");
1071             return null;
1072         }
1073         NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1074         if (npe != null) {
1075             Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1076             if (networkTypeBase != null) {
1077                 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1078                     return ProviderTypes.FLAT;
1079                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1080                     return ProviderTypes.VLAN;
1081                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1082                     return ProviderTypes.VXLAN;
1083                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1084                     return ProviderTypes.GRE;
1085                 }
1086             }
1087         }
1088         LOG.error("Error in getting provider network type since network provider extension is null for network "
1089                 + "{}", network.getUuid().getValue());
1090         return null;
1091     }
1092
1093     static boolean isNetworkTypeSupported(Network network) {
1094         NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1095         return npe != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1096     }
1097
1098     static boolean isFlatOrVlanNetwork(Network network) {
1099         if (network != null) {
1100             NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1101             if (npe != null) {
1102                 Class<? extends NetworkTypeBase> npeType = npe.getNetworkType();
1103                 if (npeType != null) {
1104                     return NetworkTypeVlan.class.isAssignableFrom(npeType)
1105                             || NetworkTypeFlat.class.isAssignableFrom(npeType);
1106                 }
1107             }
1108         }
1109         return false;
1110     }
1111
1112     static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1113         return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1114     }
1115
1116     /**
1117      * Get inter-VPN link state.
1118      *
1119      * @param vpnLinkName VPN link name
1120      * @return Optional of InterVpnLinkState
1121      */
1122     public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1123         InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1124                 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1125         return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1126     }
1127
1128     /**
1129      * Returns an InterVpnLink by searching by one of its endpoint's IP.
1130      *
1131      * @param endpointIp IP to search for
1132      * @return a InterVpnLink
1133      */
1134     public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1135         InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1136         Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1137                 interVpnLinksIid);
1138         if (interVpnLinksOpData.isPresent()) {
1139             for (InterVpnLink interVpnLink : interVpnLinksOpData.get().nonnullInterVpnLink()) {
1140                 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1141                         || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1142                     return Optional.of(interVpnLink);
1143                 }
1144             }
1145         }
1146         return Optional.absent();
1147     }
1148
1149     protected void releaseRDId(String poolName, String idKey) {
1150         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1151         try {
1152             RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
1153             if (!rpcResult.isSuccessful()) {
1154                 LOG.error("RPC Call to Get Unique Id returned with errors for poolname {} and ID Key {}: {}",
1155                         poolName, idKey, rpcResult.getErrors());
1156             } else {
1157                 LOG.info("ID {} for RD released successfully", idKey);
1158             }
1159         } catch (InterruptedException | ExecutionException e) {
1160             LOG.error("Exception when trying to release ID for poolname {} and ID Key {}", poolName, idKey, e);
1161         }
1162     }
1163
1164     protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1165         byte[] octets = bytesFromHexString(mac.getValue());
1166
1167         /* As per the RFC2373, steps involved to generate a LLA include
1168            1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1169               between OUI and NIC Specific part.
1170            2. Invert the Universal/Local flag in the OUI portion of the address.
1171            3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1172               identifier to generate the IPv6 LLA. */
1173
1174         StringBuilder interfaceID = new StringBuilder();
1175         short u8byte = (short) (octets[0] & 0xff);
1176         u8byte ^= 1 << 1;
1177         interfaceID.append(Integer.toHexString(0xFF & u8byte));
1178         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1179         interfaceID.append(":");
1180         interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1181         interfaceID.append("ff:fe");
1182         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1183         interfaceID.append(":");
1184         interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1185         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1186
1187         Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1188         IpAddress ipAddress = new IpAddress(ipv6LLA);
1189         return ipAddress;
1190     }
1191
1192     protected static byte[] bytesFromHexString(String values) {
1193         String target = "";
1194         if (values != null) {
1195             target = values;
1196         }
1197         String[] octets = target.split(":");
1198
1199         byte[] ret = new byte[octets.length];
1200         for (int i = 0; i < octets.length; i++) {
1201             ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1202         }
1203         return ret;
1204     }
1205
1206     public List<String> getExistingRDs() {
1207         List<String> existingRDs = new ArrayList<>();
1208         InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1209         Optional<VpnInstances> vpnInstancesOptional = read(LogicalDatastoreType.CONFIGURATION, path);
1210         if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1211             for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance()) {
1212                 if (vpnInstance.getIpv4Family() == null) {
1213                     continue;
1214                 }
1215                 List<String> rds = vpnInstance.getIpv4Family().getRouteDistinguisher();
1216                 if (rds != null) {
1217                     existingRDs.addAll(rds);
1218                 }
1219             }
1220         }
1221         return existingRDs;
1222     }
1223
1224     protected boolean doesVpnExist(Uuid vpnId) {
1225         return read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId)).isPresent();
1226     }
1227
1228     protected Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external
1229         .subnets.Subnets> getOptionalExternalSubnets(Uuid subnetId) {
1230         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1231             .rev160111.external.subnets.Subnets> subnetsIdentifier =
1232                 InstanceIdentifier.builder(ExternalSubnets.class)
1233                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1234                         .rev160111.external.subnets.Subnets.class, new SubnetsKey(subnetId)).build();
1235         return read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1236     }
1237
1238     public static List<StaticMacEntries> buildStaticMacEntry(Port port) {
1239         PhysAddress physAddress = new PhysAddress(port.getMacAddress().getValue());
1240         List<FixedIps> fixedIps = port.getFixedIps();
1241         IpAddress ipAddress = null;
1242         if (isNotEmpty(fixedIps)) {
1243             ipAddress = port.getFixedIps().get(0).getIpAddress();
1244         }
1245         StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
1246         List<StaticMacEntries> staticMacEntries = new ArrayList<>();
1247         if (ipAddress != null) {
1248             staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).setIpPrefix(ipAddress).build());
1249         } else {
1250             staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).build());
1251         }
1252         return staticMacEntries;
1253     }
1254
1255     public static boolean isEmpty(Collection<?> collection) {
1256         return collection == null || collection.isEmpty();
1257     }
1258
1259     public static boolean isNotEmpty(Collection<?> collection) {
1260         return !isEmpty(collection);
1261     }
1262
1263     /**
1264      * Method to get an ipVersionChosen as IPV4 and/or IPV6 or undefined from the subnetmaps of the router.
1265      * @param routerUuid the Uuid for which find out the IP version associated
1266      * @return an IpVersionChoice used by the router from its attached subnetmaps. IpVersionChoice.UNDEFINED if any
1267      */
1268     public IpVersionChoice getIpVersionChoicesFromRouterUuid(Uuid routerUuid) {
1269         IpVersionChoice rep = IpVersionChoice.UNDEFINED;
1270         if (routerUuid == null) {
1271             return rep;
1272         }
1273         List<Subnetmap> subnetmapList = getNeutronRouterSubnetMaps(routerUuid);
1274         if (subnetmapList.isEmpty()) {
1275             return rep;
1276         }
1277         for (Subnetmap sn : subnetmapList) {
1278             if (sn.getSubnetIp() != null) {
1279                 IpVersionChoice ipVers = getIpVersionFromString(sn.getSubnetIp());
1280                 if (rep.choice != ipVers.choice) {
1281                     rep = rep.addVersion(ipVers);
1282                 }
1283                 if (rep.choice == IpVersionChoice.IPV4AND6.choice) {
1284                     return rep;
1285                 }
1286             }
1287         }
1288         return rep;
1289     }
1290
1291     /**This method return the list of Subnetmap associated to the router or a empty list if any.
1292      * @param routerId the Uuid of router for which subnetmap is find out
1293      * @return a list of Subnetmap associated to the router. it could be empty if any
1294      */
1295     protected List<Subnetmap> getNeutronRouterSubnetMaps(Uuid routerId) {
1296         List<Subnetmap> subnetIdList = new ArrayList<>();
1297         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
1298         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
1299             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
1300                 if (routerId.equals(subnetmap.getRouterId())) {
1301                     subnetIdList.add(subnetmap);
1302                 }
1303             }
1304         }
1305         return subnetIdList;
1306     }
1307
1308     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1309         .instance.to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
1310         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
1311             .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1312                     .instance.to.vpn.id.VpnInstance.class,
1313                 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1314                     .instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
1315     }
1316
1317     /**
1318      * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
1319      * @param vpnName Name of the VPN
1320      *
1321      * @return the route-distinguisher of the VPN
1322      */
1323     @Nullable
1324     public String getVpnRd(String vpnName) {
1325         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1326             .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1327         return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1328                 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1329                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1330                         .VpnInstance::getVrfId).orElse(null);
1331     }
1332
1333     /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1334      * @param ipAddress String of an representation IP address V4 or V6
1335      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1336      */
1337     public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1338         IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
1339         if (ipAddress.contains("/")) {
1340             ipAddress = ipAddress.substring(0, ipAddress.indexOf("/"));
1341         }
1342         try {
1343             InetAddress address = InetAddress.getByName(ipAddress);
1344             if (address instanceof Inet4Address) {
1345                 return IpVersionChoice.IPV4;
1346             } else if (address instanceof Inet6Address) {
1347                 return IpVersionChoice.IPV6;
1348             }
1349         } catch (UnknownHostException | SecurityException e) {
1350             LOG.error("getIpVersionFromString: could not  find version for {}", ipAddress);
1351         }
1352         return ipchoice;
1353     }
1354
1355     /**Get IpVersionChoice from Uuid Subnet.
1356      * @param sm Subnetmap structure
1357      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1358      */
1359     public static IpVersionChoice getIpVersionFromSubnet(Subnetmap sm) {
1360         if (sm != null && sm.getSubnetIp() != null) {
1361             return getIpVersionFromString(sm.getSubnetIp());
1362         }
1363         return IpVersionChoice.UNDEFINED;
1364     }
1365
1366     @Nullable
1367     public VpnInstanceOpDataEntry getVpnInstanceOpDataEntryFromVpnId(String vpnName) {
1368         String primaryRd = getVpnRd(vpnName);
1369         if (primaryRd == null) {
1370             LOG.error("getVpnInstanceOpDataEntryFromVpnId: Vpn Instance {} "
1371                      + "Primary RD not found", vpnName);
1372             return null;
1373         }
1374         InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1375         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1376         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1377             LOG.error("getVpnInstanceOpDataEntryFromVpnId: VpnInstance {} not found", primaryRd);
1378             return null;
1379         }
1380         return vpnInstanceOpDataEntryOptional.get();
1381     }
1382
1383     protected InstanceIdentifier<VpnInstanceOpDataEntry> getVpnOpDataIdentifier(String primaryRd) {
1384         return VPN_INSTANCE_OP_DATA_IID.child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd));
1385     }
1386
1387     public boolean shouldVpnHandleIpVersionChoiceChange(IpVersionChoice ipVersion, Uuid routerId, boolean add) {
1388         int subnetCount = -1;
1389         if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1390             subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1391         } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1392             subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1393         } else {
1394             //Possible value of ipversion choice is either V4 or V6 only. Not accepted V4andV6 and Undefined
1395             return false;
1396         }
1397         /* ADD: Update vpnInstanceOpDataEntry with address family only on first IPv4/IPv6 subnet
1398          * for the VPN Instance.
1399          *
1400          * REMOVE: Update vpnInstanceOpDataEntry with address family only on last IPv4/IPv6 subnet
1401          * for the VPN Instance.
1402          */
1403         if (add && subnetCount == 1) {
1404             return true;
1405         } else if (!add && subnetCount == 0) {
1406             return true;
1407         } else {
1408             return false;
1409         }
1410     }
1411
1412     public boolean shouldVpnHandleIpVersionChangeToRemove(Subnetmap sm, Uuid vpnId) {
1413         if (sm == null) {
1414             return false;
1415         }
1416         Optional<Subnetmaps> allSubnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
1417         // calculate and store in list IpVersion for each subnetMap, belonging to current VpnInstance
1418         List<IpVersionChoice> snIpVersions = new ArrayList<>();
1419         for (Subnetmap snMap : allSubnetMaps.get().nonnullSubnetmap()) {
1420             if (snMap.getId().equals(sm.getId())) {
1421                 continue;
1422             }
1423             if (snMap.getVpnId() != null && snMap.getVpnId().equals(vpnId)) {
1424                 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1425             }
1426             if (snMap.getInternetVpnId() != null && snMap.getInternetVpnId().equals(vpnId)) {
1427                 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1428             }
1429         }
1430         IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1431         if (!snIpVersions.contains(ipVersion)) {
1432             return true;
1433         }
1434         return false;
1435     }
1436
1437     public int getSubnetCountFromRouter(Uuid routerId, IpVersionChoice ipVer) {
1438         List<Subnetmap> subnetMapList = getNeutronRouterSubnetMapList(routerId);
1439         int subnetCount = 0;
1440         for (Subnetmap subMap : subnetMapList) {
1441             IpVersionChoice ipVersion = getIpVersionFromString(subMap.getSubnetIp());
1442             if (ipVersion.isIpVersionChosen(ipVer)) {
1443                 subnetCount++;
1444             }
1445             if (subnetCount > 1) {
1446                 break;
1447             }
1448         }
1449         return subnetCount;
1450     }
1451
1452     public void updateVpnInstanceWithIpFamily(String vpnName, IpVersionChoice ipVersion, boolean add) {
1453         jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
1454             VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName);
1455             if (vpnInstanceOpDataEntry == null) {
1456                 return Collections.emptyList();
1457             }
1458             if (vpnInstanceOpDataEntry.getType() == VpnInstanceOpDataEntry.Type.L2) {
1459                 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with ipFamily {}."
1460                         + "VpnInstanceOpDataEntry is L2 instance. Do nothing.", vpnName, ipVersion);
1461                 return Collections.emptyList();
1462             }
1463             if (ipVersion == IpVersionChoice.UNDEFINED) {
1464                 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with Undefined address family"
1465                         + "is not allowed. Do nothing", vpnName);
1466                 return Collections.emptyList();
1467             }
1468             VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1469             boolean ipConfigured = add;
1470             if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4AND6)) {
1471                 builder.setIpv4Configured(ipConfigured);
1472                 builder.setIpv6Configured(ipConfigured);
1473             } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1474                 builder.setIpv4Configured(ipConfigured);
1475             } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1476                 builder.setIpv6Configured(ipConfigured);
1477             }
1478             return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1479                     OPERATIONAL, tx -> {
1480                     tx.merge(getVpnOpDataIdentifier(vpnInstanceOpDataEntry.getVrfId()), builder.build(), false);
1481                     LOG.info("updateVpnInstanceWithIpFamily: Successfully {} {} to Vpn {}",
1482                             add == true ? "added" : "removed", ipVersion, vpnName);
1483                 }));
1484         });
1485     }
1486
1487     /**
1488      * Get the vpnInstance from its Uuid.
1489      *
1490      * @param broker to get informations from ds
1491      * @param vpnId the Uuid of the VPN
1492      * @return the VpnInstance or null if unfindable
1493      */
1494     @Nullable
1495     public VpnInstance getVpnInstance(DataBroker broker, Uuid vpnId) {
1496         if (broker == null || vpnId == null) {
1497             return null;
1498         }
1499         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
1500                 new VpnInstanceKey(vpnId.getValue())).build();
1501         Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1502         return vpnInstance.isPresent() ? vpnInstance.get() : null;
1503     }
1504
1505     /**
1506      *Get the Uuid of external network of the router (remember you that one router have only one external network).
1507      * @param routerId the Uuid of the router which you try to reach the external network
1508      * @return Uuid of externalNetwork or null if is not exist
1509      */
1510     protected Uuid getExternalNetworkUuidAttachedFromRouterUuid(@NonNull Uuid routerId) {
1511         LOG.debug("getExternalNetworkUuidAttachedFromRouterUuid for {}", routerId.getValue());
1512         Uuid externalNetworkUuid = null;
1513         Router router = getNeutronRouter(routerId);
1514         if (router != null && router.getExternalGatewayInfo() != null) {
1515             externalNetworkUuid = router.getExternalGatewayInfo().getExternalNetworkId();
1516         }
1517         return externalNetworkUuid;
1518     }
1519
1520     public Uuid getInternetvpnUuidBoundToRouterId(@NonNull Uuid routerId) {
1521         Uuid netId = getExternalNetworkUuidAttachedFromRouterUuid(routerId);
1522         if (netId == null) {
1523             return netId;
1524         }
1525         return getVpnForNetwork(netId);
1526     }
1527
1528     /**
1529      * This method get Uuid of internet vpn if existing one bound to the same router of the subnetUuid arg.
1530      * Explanation: If the subnet (of arg subnetUuid) have a router bound and this router have an
1531      * externalVpn (vpn on externalProvider network) then <b>its Uuid</b> will be returned.
1532      * @param subnetUuid Uuid of subnet where you are finding a link to an external network
1533      * @return Uuid of externalVpn or null if it is not found
1534      */
1535     @Nullable
1536     public Uuid getInternetvpnUuidBoundToSubnetRouter(@NonNull Uuid subnetUuid) {
1537         Subnetmap subnetmap = getSubnetmap(subnetUuid);
1538         Uuid routerUuid = subnetmap.getRouterId();
1539         LOG.debug("getInternetvpnUuidBoundToSubnetRouter for subnetUuid {}", subnetUuid.getValue());
1540         if (routerUuid == null) {
1541             return null;
1542         }
1543         Uuid externalNetworkUuid = getExternalNetworkUuidAttachedFromRouterUuid(routerUuid);
1544         return externalNetworkUuid != null ? getVpnForNetwork(externalNetworkUuid) : null;
1545     }
1546
1547     /**
1548      * Get a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1549      * @param extNet Provider Network, which has a port attached as external network gateway to router
1550      * @return a list of Private Subnetmap Ids of the router with external network gateway
1551      */
1552     public @NonNull List<Uuid> getPrivateSubnetsToExport(@NonNull Network extNet, Uuid internetVpnId) {
1553         List<Uuid> subList = new ArrayList<>();
1554         List<Uuid> rtrList = new ArrayList<>();
1555         if (internetVpnId != null) {
1556             rtrList.addAll(getRouterIdListforVpn(internetVpnId));
1557         } else {
1558             Uuid extNwVpnId = getVpnForNetwork(extNet.getUuid());
1559             rtrList.addAll(getRouterIdListforVpn(extNwVpnId));
1560         }
1561         if (rtrList.isEmpty()) {
1562             return subList;
1563         }
1564         for (Uuid rtrId: rtrList) {
1565             Router router = getNeutronRouter(rtrId);
1566             ExternalGatewayInfo info = router.getExternalGatewayInfo();
1567             if (info == null) {
1568                 LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1569                           router.getUuid().getValue());
1570                 continue;
1571             }
1572             // check that router really has given provider network as its external gateway port
1573             if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1574                 LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1575                           router.getUuid().getValue(), extNet.getUuid().getValue());
1576                 continue;
1577             }
1578             subList.addAll(getNeutronRouterSubnetIds(rtrId));
1579         }
1580         return subList;
1581     }
1582
1583     public void updateVpnInstanceWithFallback(Uuid routerId, Uuid vpnName, boolean add) {
1584         VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName.getValue());
1585         if (vpnInstanceOpDataEntry == null) {
1586             LOG.error("updateVpnInstanceWithFallback: vpnInstanceOpDataEntry not found for vpn {}", vpnName);
1587             return;
1588         }
1589         Long internetBgpVpnId = vpnInstanceOpDataEntry.getVpnId().toJava();
1590         List<Uuid> routerIds = new ArrayList<>();
1591         //Handle router specific V6 internet fallback flow else handle all V6 external routers
1592         if (routerId != null) {
1593             routerIds.add(routerId);
1594         } else {
1595             //This block will execute for ext-nw to Internet VPN association/disassociation event.
1596             routerIds = getRouterIdListforVpn(vpnName);
1597         }
1598         if (routerIds == null || routerIds.isEmpty()) {
1599             LOG.error("updateVpnInstanceWithFallback: router not found for vpn {}", vpnName);
1600             return;
1601         }
1602         for (Uuid rtrId: routerIds) {
1603             if (rtrId == null) {
1604                 continue;
1605             }
1606             List<Uint64> dpnIds = getDpnsForRouter(rtrId.getValue());
1607             if (dpnIds.isEmpty()) {
1608                 continue;
1609             }
1610             VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(rtrId.getValue());
1611             Long routerIdAsLong = vpnOpDataEntry.getVpnId().toJava();
1612             long vpnId;
1613             Uuid rtrVpnId = getVpnForRouter(rtrId, true);
1614             if (rtrVpnId == null) {
1615                 //If external BGP-VPN is not associated with router then routerId is same as routerVpnId
1616                 vpnId = routerIdAsLong;
1617             } else {
1618                 vpnId = getVpnId(rtrVpnId.getValue());
1619             }
1620             for (Uint64 dpnId : dpnIds) {
1621                 if (add) {
1622                     LoggingFutures.addErrorLogging(
1623                         txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
1624                             tx -> ipV6InternetDefRt.installDefaultRoute(tx, dpnId, rtrId.getValue(),
1625                                 internetBgpVpnId, vpnId)), LOG, "Error adding default route");
1626                 } else {
1627                     LoggingFutures.addErrorLogging(
1628                         txRunner.callWithNewReadWriteTransactionAndSubmit(Datastore.CONFIGURATION,
1629                             tx -> ipV6InternetDefRt.removeDefaultRoute(tx, dpnId, rtrId.getValue(),
1630                                 internetBgpVpnId, vpnId)), LOG,
1631                         "Error removing default route");
1632                 }
1633             }
1634         }
1635     }
1636
1637     public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @NonNull Uuid vpn) {
1638         String primaryRd = getVpnRd(vpn.getValue());
1639         if (primaryRd == null) {
1640             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1641                     + "Primary RD not found", choice, vpn.getValue());
1642             return;
1643         }
1644         InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1645
1646         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1647             read(LogicalDatastoreType.OPERATIONAL, id);
1648         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1649             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1650                     + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1651             return;
1652         }
1653         VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1654         if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1655             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1656                     + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1657             return;
1658         }
1659         VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1660         builder.setBgpvpnType(choice);
1661         ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
1662             tx.merge(id, builder.build(), false);
1663             LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1664         }), LOG, "Error updating VPN instance op {} with type {}", vpn, choice);
1665     }
1666
1667     public static RouterIds getvpnInstanceRouterIds(Uuid routerId) {
1668         return new RouterIdsBuilder().setRouterId(routerId).build();
1669     }
1670
1671     public static List<RouterIds> getVpnInstanceRouterIdsList(List<Uuid> routerIds) {
1672         List<RouterIds> listRouterIds = new ArrayList<>();
1673         for (Uuid routerId : routerIds) {
1674             final RouterIds routerIdInstance = getvpnInstanceRouterIds(routerId);
1675             listRouterIds.add(routerIdInstance);
1676         }
1677         return listRouterIds;
1678     }
1679
1680     @NonNull
1681     public List<Uint64> getDpnsForRouter(String routerUuid) {
1682         InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1683             .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1684         Optional<RouterDpnList> routerDpnListData =
1685                 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1686                         LogicalDatastoreType.OPERATIONAL, id);
1687         List<Uint64> dpns = new ArrayList<>();
1688         if (routerDpnListData.isPresent()) {
1689             for (DpnVpninterfacesList dpnVpnInterface : routerDpnListData.get().nonnullDpnVpninterfacesList()) {
1690                 dpns.add(dpnVpnInterface.getDpnId());
1691             }
1692         }
1693         return dpns;
1694     }
1695
1696     @Nullable
1697     List<Subnetmap> getSubnetmapListFromNetworkId(Uuid networkId) {
1698         List<Uuid> subnetIdList = getSubnetIdsFromNetworkId(networkId);
1699         if (subnetIdList != null) {
1700             List<Subnetmap> subnetmapList = new ArrayList<>();
1701             for (Uuid subnetId : subnetIdList) {
1702                 Subnetmap subnetmap = getSubnetmap(subnetId);
1703                 if (subnetmap != null) {
1704                     subnetmapList.add(subnetmap);
1705                 } else {
1706                     LOG.error("getSubnetmapListFromNetworkId: subnetmap is null for subnet {} belonging to network {}",
1707                             subnetId.getValue(), networkId.getValue());
1708                 }
1709             }
1710             return subnetmapList;
1711         }
1712         LOG.error("getSubnetmapListFromNetworkId: Failed as subnetIdList is null for network {}",
1713                 networkId.getValue());
1714         return null;
1715     }
1716
1717     @Nullable
1718     public long getVpnId(String vpnName) {
1719         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1720                 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1721         return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1722                 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1723                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1724                         .VpnInstance::getVpnId).orElse(null).toJava();
1725     }
1726
1727     protected boolean isV6SubnetPartOfRouter(Uuid routerId) {
1728         List<Subnetmap> subnetList = getNeutronRouterSubnetMapList(routerId);
1729         for (Subnetmap sm : subnetList) {
1730             if (sm == null) {
1731                 continue;
1732             }
1733             IpVersionChoice ipVers = getIpVersionFromString(sm.getSubnetIp());
1734             //skip further subnet processing once found first V6 subnet for the router
1735             if (ipVers.isIpVersionChosen(IpVersionChoice.IPV6)) {
1736                 return true;
1737             }
1738         }
1739         return false;
1740     }
1741
1742     @SuppressWarnings({ "unchecked", "rawtypes" })
1743     public <T extends DataObject> void asyncReadAndExecute(final LogicalDatastoreType datastoreType,
1744                                                            final InstanceIdentifier<T> iid, final String jobKey,
1745                                                            final Function<Optional<T>, Void> function) {
1746         jobCoordinator.enqueueJob(jobKey, () -> {
1747             SettableFuture<Optional<T>> settableFuture = SettableFuture.create();
1748             List futures = Collections.singletonList(settableFuture);
1749             try (ReadOnlyTransaction tx = dataBroker.newReadOnlyTransaction()) {
1750                 Futures.addCallback(tx.read(datastoreType, iid),
1751                         new SettableFutureCallback<Optional<T>>(settableFuture) {
1752                             @Override
1753                             public void onSuccess(Optional<T> data) {
1754                                 function.apply(data);
1755                                 super.onSuccess(data);
1756                             }
1757                         }, MoreExecutors.directExecutor());
1758
1759                 return futures;
1760             }
1761         }, JOB_MAX_RETRIES);
1762     }
1763
1764     private static InstanceIdentifier<VpnMap> vpnMapIdentifier(Uuid uuid) {
1765         return VPN_MAPS_IID.child(VpnMap.class, new VpnMapKey(uuid));
1766     }
1767
1768     private class SettableFutureCallback<T> implements FutureCallback<T> {
1769
1770         private final SettableFuture<T> settableFuture;
1771
1772         SettableFutureCallback(SettableFuture<T> settableFuture) {
1773             this.settableFuture = settableFuture;
1774         }
1775
1776         @Override
1777         public void onSuccess(T objT) {
1778             settableFuture.set(objT);
1779         }
1780
1781         @Override
1782         public void onFailure(Throwable throwable) {
1783             settableFuture.setException(throwable);
1784         }
1785     }
1786 }
1787