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

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