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