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

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