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

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.netvirt.neutronvpn;
  10
  11 import com.google.common.base.Optional;
  12 import java.util.Iterator;
  13 import java.math.BigInteger;
  14 import java.util.ArrayList;
  15 import java.util.Collection;
  16 import java.util.Collections;
  17 import java.util.HashMap;
  18 import java.util.HashSet;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Set;
  22 import java.util.concurrent.ConcurrentHashMap;
  23 import java.util.concurrent.ExecutionException;
  24 import java.util.concurrent.Future;
  25 import java.util.concurrent.TimeUnit;
  26 import java.util.concurrent.atomic.AtomicInteger;
  27 import java.util.concurrent.locks.ReadWriteLock;
  28 import java.util.concurrent.locks.ReentrantReadWriteLock;
  29
  30 import org.apache.commons.lang3.StringUtils;
  31 import org.apache.commons.lang3.tuple.ImmutablePair;
  32 import com.google.common.collect.ImmutableBiMap;
  33 import com.google.common.collect.Sets;
  34
  35 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  36 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  37 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  38 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  39 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  40 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  41 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
  44 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronConstants;
  45 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  46 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  47 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.binding.rev150712.PortBindingExtension;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.QosPolicy;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnMaps;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMap;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapKey;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
 117 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
 122 import org.opendaylight.yangtools.yang.binding.DataObject;
 123 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 124 import org.opendaylight.yangtools.yang.common.RpcResult;
 125 import org.slf4j.Logger;
 126 import org.slf4j.LoggerFactory;
 127
 128 public class NeutronvpnUtils {
 129
 130     private static final Logger logger = LoggerFactory.getLogger(NeutronvpnUtils.class);
 131     private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>> NETWORK_MAP =
 132             new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
 133             .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
 134             .put(NetworkTypeGre.class, SegmentTypeGre.class)
 135             .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
 136             .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
 137             .build();
 138
 139     public static ConcurrentHashMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
 140     public static ConcurrentHashMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
 141     public static ConcurrentHashMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
 142     public static ConcurrentHashMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
 143     public static Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
 144     public static ConcurrentHashMap<Uuid, QosPolicy> qosPolicyMap = new ConcurrentHashMap<>();
 145     public static ConcurrentHashMap<Uuid, HashMap<Uuid, Port>> qosPortsMap = new ConcurrentHashMap<>();
 146     public static ConcurrentHashMap<Uuid, HashMap<Uuid, Network>> qosNetworksMap = new ConcurrentHashMap<>();
 147     private static final Set<Class<? extends NetworkTypeBase>> supportedNetworkTypes = Sets.newConcurrentHashSet();
 148
 149     private static long LOCK_WAIT_TIME = 10L;
 150     private static TimeUnit secUnit = TimeUnit.SECONDS;
 151
 152     static {
 153         registerSuppoprtedNetworkType(NetworkTypeFlat.class);
 154         registerSuppoprtedNetworkType(NetworkTypeVlan.class);
 155         registerSuppoprtedNetworkType(NetworkTypeVxlan.class);
 156         registerSuppoprtedNetworkType(NetworkTypeGre.class);
 157     }
 158
 159     private NeutronvpnUtils() {
 160         throw new UnsupportedOperationException("Utility class should not be instantiated");
 161     }
 162
 163     static ConcurrentHashMap<String, ImmutablePair<ReadWriteLock,AtomicInteger>> locks = new ConcurrentHashMap<>();
 164
 165     public static void registerSuppoprtedNetworkType(Class<? extends NetworkTypeBase> netType) {
 166         supportedNetworkTypes.add(netType);
 167     }
 168
 169     public static void unregisterSuppoprtedNetworkType(Class<? extends NetworkTypeBase> netType) {
 170         supportedNetworkTypes.remove(netType);
 171     }
 172
 173     protected static Subnetmap getSubnetmap(DataBroker broker, Uuid subnetId) {
 174         InstanceIdentifier id = buildSubnetMapIdentifier(subnetId);
 175         Optional<Subnetmap> sn = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 176
 177         if (sn.isPresent()) {
 178             return sn.get();
 179         }
 180         return null;
 181     }
 182
 183     protected static VpnMap getVpnMap(DataBroker broker, Uuid id) {
 184         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 185                 new VpnMapKey(id)).build();
 186         Optional<VpnMap> optionalVpnMap = read(broker, LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 187         if (optionalVpnMap.isPresent()) {
 188             return optionalVpnMap.get();
 189         }
 190         logger.error("getVpnMap failed, VPN {} not present", id.getValue());
 191         return null;
 192     }
 193
 194     protected static Uuid getVpnForNetwork(DataBroker broker, Uuid network) {
 195         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 196         Optional<VpnMaps> optionalVpnMaps = read(broker, LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 197         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 198             List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
 199             for (VpnMap vpnMap : allMaps) {
 200                 List<Uuid> netIds = vpnMap.getNetworkIds();
 201                 if (netIds != null && netIds.contains(network)) {
 202                     return vpnMap.getVpnId();
 203                 }
 204             }
 205         }
 206         return null;
 207     }
 208
 209     protected static Uuid getVpnForSubnet(DataBroker broker, Uuid subnetId) {
 210         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 211         Optional<Subnetmap> optionalSubnetMap = read(broker, LogicalDatastoreType.CONFIGURATION, subnetmapIdentifier);
 212         if (optionalSubnetMap.isPresent()) {
 213             return optionalSubnetMap.get().getVpnId();
 214         }
 215         return null;
 216     }
 217
 218     // @param external vpn - true if external vpn being fetched, false for internal vpn
 219     protected static Uuid getVpnForRouter(DataBroker broker, Uuid routerId, Boolean externalVpn) {
 220         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 221         Optional<VpnMaps> optionalVpnMaps = read(broker, LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 222         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 223             List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
 224             if (routerId != null) {
 225                 for (VpnMap vpnMap : allMaps) {
 226                     if (routerId.equals(vpnMap.getRouterId())) {
 227                         if (externalVpn) {
 228                             if (!routerId.equals(vpnMap.getVpnId())) {
 229                                 return vpnMap.getVpnId();
 230                             }
 231                         } else {
 232                             if (routerId.equals(vpnMap.getVpnId())) {
 233                                 return vpnMap.getVpnId();
 234                             }
 235                         }
 236                     }
 237                 }
 238             }
 239         }
 240         return null;
 241     }
 242
 243     protected static Uuid getRouterforVpn(DataBroker broker, Uuid vpnId) {
 244         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 245                 new VpnMapKey(vpnId)).build();
 246         Optional<VpnMap> optionalVpnMap = read(broker, LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 247         if (optionalVpnMap.isPresent()) {
 248             VpnMap vpnMap = optionalVpnMap.get();
 249             return vpnMap.getRouterId();
 250         }
 251         return null;
 252     }
 253
 254     protected static String getNeutronPortNameFromVpnPortFixedIp(DataBroker broker, String vpnName, String fixedIp) {
 255         InstanceIdentifier id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 256         Optional<VpnPortipToPort> vpnPortipToPortData = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 257         if (vpnPortipToPortData.isPresent()) {
 258             return vpnPortipToPortData.get().getPortName();
 259         }
 260         return null;
 261     }
 262
 263     protected static List<Uuid> getSubnetIdsFromNetworkId(DataBroker broker, Uuid networkId) {
 264         InstanceIdentifier id = buildNetworkMapIdentifier(networkId);
 265         Optional<NetworkMap> optionalNetworkMap = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 266         if (optionalNetworkMap.isPresent()) {
 267             return optionalNetworkMap.get().getSubnetIdList();
 268         }
 269         return null;
 270     }
 271
 272     protected static List<Uuid> getPortIdsFromSubnetId(DataBroker broker, Uuid subnetId) {
 273         InstanceIdentifier id = buildSubnetMapIdentifier(subnetId);
 274         Optional<Subnetmap> optionalSubnetmap = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 275         if (optionalSubnetmap.isPresent()) {
 276             return optionalSubnetmap.get().getPortList();
 277         }
 278         return null;
 279     }
 280
 281     protected static Router getNeutronRouter(DataBroker broker, Uuid routerId) {
 282         Router router = null;
 283         router = routerMap.get(routerId);
 284         if (router != null) {
 285             return router;
 286         }
 287         InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
 288                 .class, new RouterKey(routerId));
 289         Optional<Router> rtr = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 290         if (rtr.isPresent()) {
 291             router = rtr.get();
 292         }
 293         return router;
 294     }
 295
 296     protected static Network getNeutronNetwork(DataBroker broker, Uuid networkId) {
 297         Network network = null;
 298         network = networkMap.get(networkId);
 299         if (network != null) {
 300             return network;
 301         }
 302         logger.debug("getNeutronNetwork for {}", networkId.getValue());
 303         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(Networks.class).child
 304                 (Network.class, new NetworkKey(networkId));
 305         Optional<Network> net = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 306         if (net.isPresent()) {
 307             network = net.get();
 308         }
 309         return network;
 310     }
 311
 312     protected static Port getNeutronPort(DataBroker broker, Uuid portId) {
 313         Port prt = null;
 314         prt = portMap.get(portId);
 315         if (prt != null) {
 316             return prt;
 317         }
 318         logger.debug("getNeutronPort for {}", portId.getValue());
 319         InstanceIdentifier<Port> inst = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(Port.class,
 320                 new PortKey(portId));
 321         Optional<Port> port = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 322         if (port.isPresent()) {
 323             prt = port.get();
 324         }
 325         return prt;
 326     }
 327
 328     /**
 329      * Returns port_security_enabled status with the port.
 330      *
 331      * @param port the port
 332      * @return port_security_enabled status
 333      */
 334     protected static Boolean getPortSecurityEnabled(Port port) {
 335         String deviceOwner = port.getDeviceOwner();
 336         if (deviceOwner != null && deviceOwner.startsWith("network:")) {
 337             // port with device owner of network:xxx is created by
 338             // neutorn for its internal use. So security group doesn't apply.
 339             // router interface, dhcp port and floating ip.
 340             return false;
 341         }
 342         PortSecurityExtension portSecurity = port.getAugmentation(PortSecurityExtension.class);
 343         if (portSecurity != null) {
 344             return portSecurity.isPortSecurityEnabled();
 345         }
 346         return false;
 347     }
 348
 349     /**
 350      * Gets security group UUIDs delta   .
 351      *
 352      * @param port1SecurityGroups the port 1 security groups
 353      * @param port2SecurityGroups the port 2 security groups
 354      * @return the security groups delta
 355      */
 356     protected static List<Uuid> getSecurityGroupsDelta(List<Uuid> port1SecurityGroups,
 357             List<Uuid> port2SecurityGroups) {
 358         if (port1SecurityGroups == null) {
 359             return null;
 360         }
 361
 362         if (port2SecurityGroups == null) {
 363             return port1SecurityGroups;
 364         }
 365
 366         List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
 367         List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
 368         for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
 369             Uuid securityGroup1 = iterator.next();
 370             for (Uuid securityGroup2 : list2) {
 371                 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
 372                     iterator.remove();
 373                     break;
 374                 }
 375             }
 376         }
 377         return list1;
 378     }
 379
 380     /**
 381      * Gets the fixed ips delta.
 382      *
 383      * @param port1FixedIps the port 1 fixed ips
 384      * @param port2FixedIps the port 2 fixed ips
 385      * @return the fixed ips delta
 386      */
 387     protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
 388         if (port1FixedIps == null) {
 389             return null;
 390         }
 391
 392         if (port2FixedIps == null) {
 393             return port1FixedIps;
 394         }
 395
 396         List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
 397         List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
 398         for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
 399             FixedIps fixedIps1 = iterator.next();
 400             for (FixedIps fixedIps2 : list2) {
 401                 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
 402                     iterator.remove();
 403                     break;
 404                 }
 405             }
 406         }
 407         return list1;
 408     }
 409
 410     /**
 411      * Gets the allowed address pairs delta.
 412      *
 413      * @param port1AllowedAddressPairs the port 1 allowed address pairs
 414      * @param port2AllowedAddressPairs the port 2 allowed address pairs
 415      * @return the allowed address pairs delta
 416      */
 417     protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
 418             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs> port1AllowedAddressPairs,
 419             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs> port2AllowedAddressPairs) {
 420         if (port1AllowedAddressPairs == null) {
 421             return null;
 422         }
 423
 424         if (port2AllowedAddressPairs == null) {
 425             return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
 426         }
 427
 428         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs> list1 =
 429                 new ArrayList<>(port1AllowedAddressPairs);
 430         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs> list2 =
 431                 new ArrayList<>(port2AllowedAddressPairs);
 432         for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs> iterator =
 433              list1.iterator(); iterator.hasNext();) {
 434             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs allowedAddressPair1 =
 435                     iterator.next();
 436             for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs allowedAddressPair2 : list2) {
 437                 if (allowedAddressPair1.getKey().equals(allowedAddressPair2.getKey())) {
 438                     iterator.remove();
 439                     break;
 440                 }
 441             }
 442         }
 443         return getAllowedAddressPairsForAclService(list1);
 444     }
 445
 446     /**
 447      * Gets the acl allowed address pairs.
 448      *
 449      * @param macAddress the mac address
 450      * @param ipAddress the ip address
 451      * @return the acl allowed address pairs
 452      */
 453     protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
 454             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
 455         AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
 456         aclAllowedAdressPairBuilder.setMacAddress(macAddress);
 457         if (ipAddress != null && ipAddress.getValue() != null) {
 458             if (ipAddress.getIpPrefix() != null) {
 459                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
 460             } else {
 461                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
 462             }
 463         }
 464         return aclAllowedAdressPairBuilder.build();
 465     }
 466
 467     /**
 468      * Gets the allowed address pairs for acl service.
 469      *
 470      * @param macAddress the mac address
 471      * @param fixedIps the fixed ips
 472      * @return the allowed address pairs for acl service
 473      */
 474     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
 475             List<FixedIps> fixedIps) {
 476         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 477         for (FixedIps fixedIp : fixedIps) {
 478             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
 479                     new org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress(
 480                             fixedIp.getIpAddress().getValue())));
 481         }
 482         return aclAllowedAddressPairs;
 483     }
 484
 485     /**
 486      * Gets the IPv6 Link Local Address corresponding to the MAC Address.
 487      *
 488      * @param macAddress the mac address
 489      * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
 490      */
 491     protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
 492         IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
 493         return getAclAllowedAddressPairs(macAddress,
 494                 new org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress(
 495                         ipv6LinkLocalAddress.getValue()));
 496     }
 497
 498     /**
 499      * Gets the allowed address pairs for acl service.
 500      *
 501      * @param portAllowedAddressPairs the port allowed address pairs
 502      * @return the allowed address pairs for acl service
 503      */
 504     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
 505             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 506                 .AllowedAddressPairs> portAllowedAddressPairs) {
 507         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 508         for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
 509                 portAllowedAddressPair : portAllowedAddressPairs) {
 510             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
 511                     portAllowedAddressPair.getIpAddress()));
 512         }
 513         return aclAllowedAddressPairs;
 514     }
 515
 516     /**
 517      * Gets the updated security groups.
 518      *
 519      * @param aclInterfaceSecurityGroups the acl interface security groups
 520      * @param origSecurityGroups the orig security groups
 521      * @param newSecurityGroups the new security groups
 522      * @return the updated security groups
 523      */
 524     protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
 525             List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
 526         List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
 527         List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
 528         List<Uuid> updatedSecurityGroups =
 529                 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
 530         if (addedGroups != null) {
 531             updatedSecurityGroups.addAll(addedGroups);
 532         }
 533         if (deletedGroups != null) {
 534             updatedSecurityGroups.removeAll(deletedGroups);
 535         }
 536         return updatedSecurityGroups;
 537     }
 538
 539     /**
 540      * Gets the allowed address pairs for fixed ips.
 541      *
 542      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 543      * @param portMacAddress the port mac address
 544      * @param origFixedIps the orig fixed ips
 545      * @param newFixedIps the new fixed ips
 546      * @return the allowed address pairs for fixed ips
 547      */
 548     protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
 549             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
 550             List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
 551         List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
 552         List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
 553         List<AllowedAddressPairs> updatedAllowedAddressPairs = aclInterfaceAllowedAddressPairs != null ?
 554                 new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 555         if (deletedFixedIps != null) {
 556             updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
 557         }
 558         if (addedFixedIps != null) {
 559             updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
 560         }
 561         return updatedAllowedAddressPairs;
 562     }
 563
 564     /**
 565      * Gets the updated allowed address pairs.
 566      *
 567      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 568      * @param origAllowedAddressPairs the orig allowed address pairs
 569      * @param newAllowedAddressPairs the new allowed address pairs
 570      * @return the updated allowed address pairs
 571      */
 572     protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
 573             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
 574             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs> origAllowedAddressPairs,
 575             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs> newAllowedAddressPairs) {
 576         List<AllowedAddressPairs> addedAllowedAddressPairs = getAllowedAddressPairsDelta(newAllowedAddressPairs,
 577                 origAllowedAddressPairs);
 578         List<AllowedAddressPairs> deletedAllowedAddressPairs = getAllowedAddressPairsDelta(origAllowedAddressPairs,
 579                 newAllowedAddressPairs);
 580         List<AllowedAddressPairs> updatedAllowedAddressPairs = aclInterfaceAllowedAddressPairs != null ?
 581                 new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 582         if (addedAllowedAddressPairs != null) {
 583             updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
 584         }
 585         if (deletedAllowedAddressPairs != null) {
 586             updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
 587         }
 588         return updatedAllowedAddressPairs;
 589     }
 590
 591     /**
 592      * Populate interface acl builder.
 593      *
 594      * @param interfaceAclBuilder the interface acl builder
 595      * @param port the port
 596      */
 597     protected static void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
 598         // Handle security group enabled
 599         List<Uuid> securityGroups = port.getSecurityGroups();
 600         if (securityGroups != null) {
 601                 interfaceAclBuilder.setSecurityGroups(securityGroups);
 602         }
 603         List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
 604                 port.getMacAddress(), port.getFixedIps());
 605         // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
 606         aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
 607         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
 608             portAllowedAddressPairs = port.getAllowedAddressPairs();
 609         if (portAllowedAddressPairs != null) {
 610             aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
 611         }
 612         interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
 613     }
 614
 615     protected static Subnet getNeutronSubnet(DataBroker broker, Uuid subnetId) {
 616         Subnet subnet = null;
 617         subnet = subnetMap.get(subnetId);
 618         if (subnet != null) {
 619             return subnet;
 620         }
 621         InstanceIdentifier<Subnet> inst = InstanceIdentifier.create(Neutron.class).child(Subnets.class).child(Subnet
 622                 .class, new SubnetKey(subnetId));
 623         Optional<Subnet> sn = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 624
 625         if (sn.isPresent()) {
 626             subnet = sn.get();
 627         }
 628         return subnet;
 629     }
 630
 631     protected static List<Uuid> getNeutronRouterSubnetIds(DataBroker broker, Uuid routerId) {
 632         logger.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
 633         List<Uuid> subnetIdList = new ArrayList<>();
 634         Optional<Subnetmaps> subnetMaps = read(broker, LogicalDatastoreType.CONFIGURATION, InstanceIdentifier.builder
 635                 (Subnetmaps.class).build());
 636         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
 637             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
 638                 if (routerId.equals(subnetmap.getRouterId())) {
 639                     subnetIdList.add(subnetmap.getId());
 640                 }
 641             }
 642         }
 643         logger.debug("returning from getNeutronRouterSubnetIds for {}", routerId.getValue());
 644         return subnetIdList;
 645     }
 646
 647     protected static String getVifPortName(Port port) {
 648         if (port == null || port.getUuid() == null) {
 649             logger.warn("Invalid Neutron port {}", port);
 650             return null;
 651         }
 652         String tapId = port.getUuid().getValue().substring(0, 11);
 653         String portNamePrefix = getPortNamePrefix(port);
 654         if (portNamePrefix != null) {
 655             return new StringBuilder().append(portNamePrefix).append(tapId).toString();
 656         }
 657         logger.debug("Failed to get prefix for port {}", port.getUuid());
 658         return null;
 659     }
 660
 661     protected static String getPortNamePrefix(Port port) {
 662         PortBindingExtension portBinding = port.getAugmentation(PortBindingExtension.class);
 663         if (portBinding == null || portBinding.getVifType() == null) {
 664             return null;
 665         }
 666         switch (portBinding.getVifType()) {
 667             case NeutronConstants.VIF_TYPE_VHOSTUSER:
 668                 return NeutronConstants.PREFIX_VHOSTUSER;
 669             case NeutronConstants.VIF_TYPE_OVS:
 670             case NeutronConstants.VIF_TYPE_DISTRIBUTED:
 671             case NeutronConstants.VIF_TYPE_BRIDGE:
 672             case NeutronConstants.VIF_TYPE_OTHER:
 673             case NeutronConstants.VIF_TYPE_MACVTAP:
 674                 return NeutronConstants.PREFIX_TAP;
 675             case NeutronConstants.VIF_TYPE_UNBOUND:
 676             case NeutronConstants.VIF_TYPE_BINDING_FAILED:
 677             default:
 678                 return null;
 679         }
 680     }
 681
 682     protected static boolean isPortVifTypeUpdated(Port original, Port updated) {
 683         return getPortNamePrefix(original) == null && getPortNamePrefix(updated) != null;
 684     }
 685
 686     protected static boolean lock(String lockName) {
 687         if (locks.get(lockName) != null) {
 688             synchronized (locks) {
 689                 if (locks.get(lockName) == null) {
 690                     locks.putIfAbsent(lockName, new ImmutablePair<ReadWriteLock, AtomicInteger>(new
 691                             ReentrantReadWriteLock(), new AtomicInteger(0)));
 692                 }
 693                 locks.get(lockName).getRight().incrementAndGet();
 694             }
 695             try {
 696                 if (locks.get(lockName) != null) {
 697                     locks.get(lockName).getLeft().writeLock().tryLock(LOCK_WAIT_TIME, secUnit);
 698                 }
 699             } catch (InterruptedException e) {
 700                 locks.get(lockName).getRight().decrementAndGet();
 701                 logger.error("Unable to acquire lock for  {}", lockName);
 702                 throw new RuntimeException(String.format("Unable to acquire lock for %s", lockName), e.getCause());
 703             }
 704         } else {
 705             locks.putIfAbsent(lockName, new ImmutablePair<ReadWriteLock, AtomicInteger>(new ReentrantReadWriteLock(),
 706                     new AtomicInteger(0)));
 707             locks.get(lockName).getRight().incrementAndGet();
 708             try {
 709                 locks.get(lockName).getLeft().writeLock().tryLock(LOCK_WAIT_TIME, secUnit);
 710             } catch (Exception e) {
 711                 locks.get(lockName).getRight().decrementAndGet();
 712                 logger.error("Unable to acquire lock for  {}", lockName);
 713                 throw new RuntimeException(String.format("Unable to acquire lock for %s", lockName), e.getCause());
 714             }
 715         }
 716         return true;
 717     }
 718
 719     protected static boolean unlock(String lockName) {
 720         if (locks.get(lockName) != null) {
 721             try {
 722                 locks.get(lockName).getLeft().writeLock().unlock();
 723             } catch (Exception e) {
 724                 logger.error("Unable to un-lock for " + lockName, e);
 725                 return false;
 726             }
 727             if (0 == locks.get(lockName).getRight().decrementAndGet()) {
 728                 synchronized (locks) {
 729                     if (locks.get(lockName).getRight().get() == 0) {
 730                         locks.remove(lockName);
 731                     }
 732                 }
 733             }
 734         }
 735         return true;
 736     }
 737
 738     protected static Short getIPPrefixFromPort(DataBroker broker, Port port) {
 739         Short prefix = new Short((short) 0);
 740         String cidr = "";
 741         try {
 742             Uuid subnetUUID = port.getFixedIps().get(0).getSubnetId();
 743             SubnetKey subnetkey = new SubnetKey(subnetUUID);
 744             InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class).child(Subnets
 745                     .class).child(Subnet.class, subnetkey);
 746             Optional<Subnet> subnet = read(broker, LogicalDatastoreType.CONFIGURATION, subnetidentifier);
 747             if (subnet.isPresent()) {
 748                 cidr = String.valueOf(subnet.get().getCidr().getValue());
 749                 // Extract the prefix length from cidr
 750                 String[] parts = cidr.split("/");
 751                 if (parts.length == 2) {
 752                     prefix = Short.valueOf(parts[1]);
 753                     return prefix;
 754                 } else {
 755                     logger.trace("Could not retrieve prefix from subnet CIDR");
 756                     System.out.println("Could not retrieve prefix from subnet CIDR");
 757                 }
 758             } else {
 759                 logger.trace("Unable to read on subnet datastore");
 760             }
 761         } catch (Exception e) {
 762             logger.error("Failed to retrieve IP prefix from port : ", e);
 763             System.out.println("Failed to retrieve IP prefix from port : " + e.getMessage());
 764         }
 765         return null;
 766     }
 767
 768     protected static void createVpnPortFixedIpToPort(DataBroker broker,String vpnName, String fixedIp,
 769                                                      String portName, String macAddress, boolean isSubnetIp,
 770                                                      WriteTransaction writeConfigTxn) {
 771         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 772         VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder().setKey(new VpnPortipToPortKey(fixedIp, vpnName)
 773         ).setVpnName(vpnName).setPortFixedip(fixedIp).setPortName(portName).setMacAddress(macAddress).setSubnetIp
 774                 (isSubnetIp);
 775         try {
 776             if (writeConfigTxn != null) {
 777                 writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION, id, builder.build());
 778             } else {
 779                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
 780             }
 781             logger.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to " +
 782                     "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
 783         } catch (Exception e) {
 784             logger.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 785                     e);
 786         }
 787     }
 788
 789     protected static void removeVpnPortFixedIpToPort(DataBroker broker, String vpnName,
 790                                                      String fixedIp, WriteTransaction writeConfigTxn) {
 791         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 792         try {
 793             if (writeConfigTxn != null) {
 794                 writeConfigTxn.delete(LogicalDatastoreType.CONFIGURATION, id);
 795             } else {
 796                 MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, id);
 797             }
 798             logger.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 799                     vpnName);
 800         } catch (Exception e) {
 801             logger.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 802                     e);
 803         }
 804     }
 805
 806     protected static void removeLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
 807         InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 808         try {
 809             synchronized ((vpnName + fixedIp).intern()) {
 810                 MDSALUtil.syncDelete(broker, LogicalDatastoreType.OPERATIONAL, id);
 811             }
 812             logger.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 813                     vpnName);
 814         } catch (Exception e) {
 815             logger.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 816                     e);
 817         }
 818     }
 819
 820     public static void addToNetworkCache(Network network) {
 821         networkMap.put(network.getUuid(), network);
 822     }
 823
 824     public static void removeFromNetworkCache(Network network) {
 825         networkMap.remove(network.getUuid());
 826     }
 827
 828     public static void addToRouterCache(Router router) {
 829         routerMap.put(router.getUuid(), router);
 830     }
 831
 832     public static void removeFromRouterCache(Router router) {
 833         routerMap.remove(router.getUuid());
 834     }
 835
 836     public static void addToPortCache(Port port) {
 837         portMap.put(port.getUuid(), port);
 838     }
 839
 840     public static void removeFromPortCache(Port port) {
 841         portMap.remove(port.getUuid());
 842     }
 843
 844     public static void addToSubnetCache(Subnet subnet) {
 845         subnetMap.put(subnet.getUuid(), subnet);
 846         IpAddress gatewayIp = subnet.getGatewayIp();
 847         if (gatewayIp != null) {
 848             Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
 849             if (gwIps == null) {
 850                 gwIps = Sets.newConcurrentHashSet();
 851                 subnetGwIpMap.put(gatewayIp, gwIps);
 852             }
 853             gwIps.add(subnet.getUuid());
 854         }
 855     }
 856
 857     public static void removeFromSubnetCache(Subnet subnet) {
 858         subnetMap.remove(subnet.getUuid());
 859         IpAddress gatewayIp = subnet.getGatewayIp();
 860         if (gatewayIp != null) {
 861             Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
 862             if (gwIps != null) {
 863                 gwIps.remove(subnet.getUuid());
 864             }
 865         }
 866     }
 867
 868
 869     public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
 870         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 871         return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
 872     }
 873
 874     public static String getPhysicalNetworkName(Network network) {
 875         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 876         return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
 877     }
 878
 879     public static Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
 880         return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
 881     }
 882
 883     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
 884         InstanceIdentifier<VpnPortipToPort> id = InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child
 885                 (VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
 886         return id;
 887     }
 888
 889     static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
 890         InstanceIdentifier<LearntVpnVipToPort> id = InstanceIdentifier.builder(LearntVpnVipToPortData.class).child
 891                 (LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
 892         return id;
 893     }
 894
 895     static Boolean getIsExternal(Network network) {
 896         return network.getAugmentation(NetworkL3Extension.class) != null
 897                 && network.getAugmentation(NetworkL3Extension.class).isExternal();
 898     }
 899
 900     public static void addToQosPolicyCache(QosPolicy qosPolicy) {
 901         qosPolicyMap.put(qosPolicy.getUuid(),qosPolicy);
 902     }
 903
 904     public static void removeFromQosPolicyCache(QosPolicy qosPolicy) {
 905         qosPolicyMap.remove(qosPolicy.getUuid());
 906     }
 907
 908     public static void addToQosPortsCache(Uuid qosUuid, Port port) {
 909         if (qosPortsMap.containsKey(qosUuid)) {
 910             if (!qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
 911                 qosPortsMap.get(qosUuid).put(port.getUuid(), port);
 912             }
 913         } else {
 914             HashMap<Uuid, Port> portMap = new HashMap<>();
 915             portMap.put(port.getUuid(), port);
 916             qosPortsMap.put(qosUuid, portMap);
 917         }
 918     }
 919
 920     public static void removeFromQosPortsCache(Uuid qosUuid, Port port) {
 921         if (qosPortsMap.containsKey(qosUuid) && qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
 922             qosPortsMap.get(qosUuid).remove(port.getUuid(), port);
 923         }
 924     }
 925
 926     public static void addToQosNetworksCache(Uuid qosUuid, Network network) {
 927         if (qosNetworksMap.containsKey(qosUuid)) {
 928             if (!qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
 929                 qosNetworksMap.get(qosUuid).put(network.getUuid(), network);
 930             }
 931         } else {
 932             HashMap<Uuid, Network> networkMap = new HashMap<>();
 933             networkMap.put(network.getUuid(), network);
 934             qosNetworksMap.put(qosUuid, networkMap);
 935         }
 936     }
 937
 938     public static void removeFromQosNetworksCache(Uuid qosUuid, Network network) {
 939         if (qosNetworksMap.containsKey(qosUuid) && qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
 940             qosNetworksMap.get(qosUuid).remove(network.getUuid(), network);
 941         }
 942     }
 943
 944     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
 945         InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
 946                 NetworkMapKey(networkId)).build();
 947         return id;
 948     }
 949
 950     static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
 951         InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
 952                 .class, new VpnInterfaceKey(ifName)).build();
 953         return id;
 954     }
 955
 956     static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
 957         InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).child(Subnetmap.class, new
 958                 SubnetmapKey(subnetId)).build();
 959         return id;
 960     }
 961
 962     static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
 963         InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
 964                 InterfaceKey(interfaceName)).build();
 965         return id;
 966     }
 967
 968     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
 969             .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
 970         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
 971                 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
 972                 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
 973                 .getValue())).build();
 974         return id;
 975     }
 976
 977     static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier (Uuid floatingIpId) {
 978         return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
 979                 FloatingIpIdToPortMappingKey(floatingIpId)).build();
 980     }
 981
 982     static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 983                                                    InstanceIdentifier<T> path) {
 984         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 985         Optional<T> result = Optional.absent();
 986         try {
 987             result = tx.read(datastoreType, path).get();
 988         } catch (Exception e) {
 989             throw new RuntimeException(e);
 990         }
 991         return result;
 992     }
 993
 994     static boolean isNetworkTypeSupported(Network network) {
 995         NetworkProviderExtension npe = network.getAugmentation(NetworkProviderExtension.class);
 996         return npe != null && npe.getNetworkType() != null && supportedNetworkTypes.contains(npe.getNetworkType());
 997     }
 998
 999     static ProviderTypes getProviderNetworkType(Network network) {
1000         if (network == null) {
1001             logger.error("Error in getting provider network type since network is null");
1002             return null;
1003         }
1004         NetworkProviderExtension npe = network.getAugmentation(NetworkProviderExtension.class);
1005         if (npe != null) {
1006             Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1007             if (networkTypeBase != null) {
1008                if(networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1009                    return ProviderTypes.FLAT;
1010                } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1011                    return ProviderTypes.VLAN;
1012                } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1013                    return ProviderTypes.VXLAN;
1014                } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1015                    return ProviderTypes.GRE;
1016                }
1017             }
1018         }
1019         return null;
1020     }
1021
1022     static boolean isNetworkOfType(Network network, Class<? extends NetworkTypeBase> type) {
1023         NetworkProviderExtension npe = network.getAugmentation(NetworkProviderExtension.class);
1024         return npe != null && npe.getNetworkType() != null && type.isAssignableFrom(npe.getNetworkType());
1025     }
1026
1027     static boolean isVxlanNetwork(Network network) {
1028         return network != null && isNetworkOfType(network, NetworkTypeVxlan.class);
1029     }
1030
1031     static boolean isGreNetwork(Network network) {
1032         return network != null && isNetworkOfType(network, NetworkTypeGre.class);
1033     }
1034
1035     static boolean isFlatOrVlanNetwork(Network network) {
1036         return network != null
1037                 && (isNetworkOfType(network, NetworkTypeVlan.class) || isNetworkOfType(network, NetworkTypeFlat.class));
1038     }
1039
1040     /**
1041      * Get inter-VPN link state
1042      *
1043      * @param broker data broker
1044      * @param vpnLinkName VPN link name
1045      * @return Optional of InterVpnLinkState
1046      */
1047     public static Optional<InterVpnLinkState> getInterVpnLinkState(DataBroker broker, String vpnLinkName) {
1048         InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1049                 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1050         return read(broker, LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1051     }
1052
1053     /**
1054      * Returns an InterVpnLink by searching by one of its endpoint's IP.
1055      *
1056      * @param broker
1057      * @param endpointIp IP to search for
1058      * @return
1059      */
1060     public static Optional<InterVpnLink> getInterVpnLinkByEndpointIp(DataBroker broker, String endpointIp) {
1061         InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1062         Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION,
1063                 interVpnLinksIid);
1064         if (interVpnLinksOpData.isPresent()) {
1065             List<InterVpnLink> allInterVpnLinks = interVpnLinksOpData.get().getInterVpnLink();
1066             for (InterVpnLink interVpnLink : allInterVpnLinks) {
1067                 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1068                         || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1069                     return Optional.of(interVpnLink);
1070                 }
1071             }
1072         }
1073         return Optional.absent();
1074     }
1075
1076
1077     public static Set<RouterDpnList> getAllRouterDpnList(DataBroker broker, BigInteger dpid) {
1078         Set<RouterDpnList> ret = new HashSet<>();
1079         InstanceIdentifier<NeutronRouterDpns> routerDpnId =
1080                 InstanceIdentifier.create(NeutronRouterDpns.class);
1081         Optional<NeutronRouterDpns> neutronRouterDpnsOpt = MDSALUtil.read(broker, LogicalDatastoreType.OPERATIONAL, routerDpnId);
1082         if (neutronRouterDpnsOpt.isPresent()) {
1083             NeutronRouterDpns neutronRouterDpns = neutronRouterDpnsOpt.get();
1084             List<RouterDpnList> routerDpnLists = neutronRouterDpns.getRouterDpnList();
1085             for (RouterDpnList routerDpnList : routerDpnLists) {
1086                 if (routerDpnList.getDpnVpninterfacesList() != null) {
1087                     for (DpnVpninterfacesList dpnInterfaceList : routerDpnList.getDpnVpninterfacesList()) {
1088                         if (dpnInterfaceList.getDpnId().equals(dpid)) {
1089                             ret.add(routerDpnList);
1090                         }
1091                     }
1092                 }
1093             }
1094         }
1095         return ret;
1096     }
1097
1098     protected static Integer getUniqueRDId(IdManagerService idManager, String poolName, String idKey) {
1099         AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1100         try {
1101             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
1102             RpcResult<AllocateIdOutput> rpcResult = result.get();
1103             if (rpcResult.isSuccessful()) {
1104                 return rpcResult.getResult().getIdValue().intValue();
1105             } else {
1106                 logger.debug("RPC Call to Get Unique Id returned with Errors", rpcResult.getErrors());
1107             }
1108         } catch (InterruptedException | ExecutionException e) {
1109             logger.debug("Exception when getting Unique Id", e);
1110         }
1111         return null;
1112     }
1113
1114     protected static void releaseRDId(IdManagerService idManager, String poolName, String idKey) {
1115         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1116         try {
1117             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
1118             RpcResult<Void> rpcResult = result.get();
1119             if (!rpcResult.isSuccessful()) {
1120                 logger.debug("RPC Call to Get Unique Id returned with Errors", rpcResult.getErrors());
1121             } else {
1122                 logger.info("ID for RD " + idKey + " released successfully");
1123             }
1124         } catch (InterruptedException | ExecutionException e) {
1125             logger.debug("Exception when trying to release ID into the pool", idKey, e);
1126         }
1127     }
1128
1129     protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1130         byte[] octets = bytesFromHexString(mac.getValue());
1131
1132         /* As per the RFC2373, steps involved to generate a LLA include
1133            1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1134               between OUI and NIC Specific part.
1135            2. Invert the Universal/Local flag in the OUI portion of the address.
1136            3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1137               identifier to generate the IPv6 LLA. */
1138
1139         StringBuffer interfaceID = new StringBuffer();
1140         short u8byte = (short) (octets[0] & 0xff);
1141         u8byte ^= 1 << 1;
1142         interfaceID.append(Integer.toHexString(0xFF & u8byte));
1143         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1144         interfaceID.append(":");
1145         interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1146         interfaceID.append("ff:fe");
1147         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1148         interfaceID.append(":");
1149         interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1150         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1151
1152         Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1153         IpAddress ipAddress = new IpAddress(ipv6LLA.getValue().toCharArray());
1154         return ipAddress;
1155     }
1156
1157     protected static byte[] bytesFromHexString(String values) {
1158         String target = "";
1159         if (values != null) {
1160             target = values;
1161         }
1162         String[] octets = target.split(":");
1163
1164         byte[] ret = new byte[octets.length];
1165         for (int i = 0; i < octets.length; i++) {
1166             ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1167         }
1168         return ret;
1169     }
1170
1171     static List<String> getExistingRDs(DataBroker broker) {
1172         List<String> existingRDs = new ArrayList<>();
1173         InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1174         Optional<VpnInstances> vpnInstancesOptional = NeutronvpnUtils.read(broker, LogicalDatastoreType.CONFIGURATION, path);
1175         if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1176             for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance()) {
1177                 existingRDs.add(vpnInstance.getIpv4Family().getRouteDistinguisher());
1178             }
1179         }
1180         return existingRDs;
1181     }
1182
1183 }