neutronvpn/neutronvpn-impl/src/main/java/org/opendaylight/vpnservice/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.vpnservice.neutronvpn;
  10
  11 import com.google.common.base.Optional;
  12
  13 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  14 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  16 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  17 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  18 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.LockManagerService;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.TimeUnits;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.TryLockInput;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.TryLockInputBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.UnlockInput;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.UnlockInputBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.NetworkMaps;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.NeutronPortData;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.Subnetmaps;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.VpnMaps;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.networkmaps.NetworkMap;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.networkmaps.NetworkMapKey;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data
  49         .PortFixedipToPortName;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data
  51         .PortFixedipToPortNameKey;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.subnetmaps.Subnetmap;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.vpnmaps.VpnMap;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.vpnmaps.VpnMapKey;
  56 import org.opendaylight.yangtools.yang.binding.DataObject;
  57 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  58 import org.opendaylight.yangtools.yang.common.RpcResult;
  59 import org.slf4j.Logger;
  60 import org.slf4j.LoggerFactory;
  61
  62 import java.util.ArrayList;
  63 import java.util.List;
  64 import java.util.concurrent.ExecutionException;
  65 import java.util.concurrent.Future;
  66
  67 public class NeutronvpnUtils {
  68
  69     private static final Logger logger = LoggerFactory.getLogger(NeutronvpnUtils.class);
  70
  71     protected static Subnetmap getSubnetmap(DataBroker broker, Uuid subnetId) {
  72         InstanceIdentifier id = buildSubnetMapIdentifier(subnetId);
  73         Optional<Subnetmap> sn = read(broker, LogicalDatastoreType.CONFIGURATION, id);
  74
  75         if (sn.isPresent()) {
  76             return sn.get();
  77         }
  78         return null;
  79     }
  80
  81     protected static VpnMap getVpnMap(DataBroker broker, Uuid id) {
  82         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
  83                 new VpnMapKey(id)).build();
  84         Optional<VpnMap> optionalVpnMap = read(broker, LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
  85         if (optionalVpnMap.isPresent()) {
  86             return optionalVpnMap.get();
  87         }
  88         logger.error("getVpnMap failed, VPN {} not present", id.getValue());
  89         return null;
  90     }
  91
  92     protected static Uuid getVpnForNetwork(DataBroker broker, Uuid network) {
  93         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
  94         Optional<VpnMaps> optionalVpnMaps = read(broker, LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
  95         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
  96             List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
  97             for (VpnMap vpnMap : allMaps) {
  98                 List<Uuid> netIds = vpnMap.getNetworkIds();
  99                 if ((netIds != null) && (netIds.contains(network))) {
 100                     return vpnMap.getVpnId();
 101                 }
 102             }
 103         }
 104         return null;
 105     }
 106
 107     // true for external vpn, false for internal vpn
 108     protected static Uuid getVpnForRouter(DataBroker broker, Uuid routerId, Boolean externalVpn) {
 109         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 110         Optional<VpnMaps> optionalVpnMaps = read(broker, LogicalDatastoreType.CONFIGURATION,
 111                 vpnMapsIdentifier);
 112         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 113             List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
 114             if (routerId != null) {
 115                 for (VpnMap vpnMap : allMaps) {
 116                     if (routerId.equals(vpnMap.getRouterId())) {
 117                         if (externalVpn == true) {
 118                             if (!routerId.equals(vpnMap.getVpnId())) {
 119                                 return vpnMap.getVpnId();
 120                             }
 121                         } else {
 122                             if (routerId.equals(vpnMap.getVpnId())) {
 123                                 return vpnMap.getVpnId();
 124                             }
 125                         }
 126                     }
 127                 }
 128             }
 129         }
 130         return null;
 131     }
 132
 133     protected static Uuid getRouterforVpn(DataBroker broker, Uuid vpnId) {
 134         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class)
 135                 .child(VpnMap.class, new VpnMapKey(vpnId)).build();
 136         Optional<VpnMap> optionalVpnMap = read(broker, LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 137         if (optionalVpnMap.isPresent()) {
 138             VpnMap vpnMap = optionalVpnMap.get();
 139             return vpnMap.getRouterId();
 140         }
 141         return null;
 142     }
 143
 144     protected static String getNeutronPortNamefromPortFixedIp(DataBroker broker, String fixedIp) {
 145         InstanceIdentifier id = buildFixedIpToPortNameIdentifier(fixedIp);
 146         Optional<PortFixedipToPortName> portFixedipToPortNameData = read(broker, LogicalDatastoreType.CONFIGURATION,
 147                 id);
 148         if (portFixedipToPortNameData.isPresent()) {
 149             return portFixedipToPortNameData.get().getPortName();
 150         }
 151         return null;
 152     }
 153
 154     protected static List<Uuid> getSubnetIdsFromNetworkId(DataBroker broker, Uuid networkId) {
 155         InstanceIdentifier id = buildNetworkMapIdentifier(networkId);
 156         Optional<NetworkMap> optionalNetworkMap = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 157         if (optionalNetworkMap.isPresent()) {
 158             return optionalNetworkMap.get().getSubnetIdList();
 159         }
 160         return null;
 161     }
 162
 163     protected static Router getNeutronRouter(DataBroker broker, Uuid routerId) {
 164
 165         InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
 166                 .class, new RouterKey(routerId));
 167         Optional<Router> rtr = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 168         if (rtr.isPresent()) {
 169             return rtr.get();
 170         }
 171         return null;
 172     }
 173
 174     protected static Network getNeutronNetwork(DataBroker broker, Uuid networkId) {
 175         logger.debug("getNeutronNetwork for {}", networkId.getValue());
 176         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(Networks.class).child
 177                 (Network.class, new NetworkKey(networkId));
 178         Optional<Network> net = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 179         if (net.isPresent()) {
 180             return net.get();
 181         }
 182         return null;
 183     }
 184
 185     protected static List<Uuid> getNeutronRouterSubnetIds(DataBroker broker, Uuid routerId) {
 186         logger.info("getNeutronRouterSubnetIds for {}", routerId.getValue());
 187
 188         List<Uuid> subnetIdList = new ArrayList<Uuid>();
 189         Router router = getNeutronRouter(broker, routerId);
 190         if (router != null) {
 191             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router
 192                     .Interfaces> interfacesList = router.getInterfaces();
 193             if (interfacesList != null) {
 194                 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers
 195                         .router.Interfaces interfaces : interfacesList) {
 196                     subnetIdList.add(interfaces.getSubnetId());
 197                 }
 198             }
 199         }
 200         logger.info("returning from getNeutronRouterSubnetIds for {}", routerId.getValue());
 201         return subnetIdList;
 202     }
 203
 204     protected static Port getNeutronPort(DataBroker broker, Uuid portId) {
 205         logger.debug("getNeutronPort for {}", portId.getValue());
 206         InstanceIdentifier<Port> inst = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(Port.class,
 207                 new PortKey(portId));
 208         Optional<Port> port = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 209         if (port.isPresent()) {
 210             return port.get();
 211         }
 212         return null;
 213     }
 214
 215     protected static String uuidToTapPortName(Uuid id) {
 216         String tapId = id.getValue().substring(0, 11);
 217         return new StringBuilder().append("tap").append(tapId).toString();
 218     }
 219
 220     protected static boolean lock(LockManagerService lockManager, String lockName) {
 221         TryLockInput input = new TryLockInputBuilder().setLockName(lockName).setTime(5L).setTimeUnit
 222                 (TimeUnits.Milliseconds).build();
 223         boolean islockAcquired = false;
 224         try {
 225             Future<RpcResult<Void>> result = lockManager.tryLock(input);
 226             if ((result != null) && (result.get().isSuccessful())) {
 227                 logger.debug("Acquired lock for {}", lockName);
 228                 islockAcquired = true;
 229             } else {
 230                 logger.error("Unable to acquire lock for  {}", lockName);
 231             }
 232         } catch (InterruptedException | ExecutionException e) {
 233             logger.error("Unable to acquire lock for  {}", lockName);
 234             throw new RuntimeException(String.format("Unable to acquire lock for %s", lockName), e.getCause());
 235         }
 236         return islockAcquired;
 237     }
 238
 239     protected static boolean unlock(LockManagerService lockManager, String lockName) {
 240         UnlockInput input = new UnlockInputBuilder().setLockName(lockName).build();
 241         boolean islockAcquired = false;
 242         try {
 243             Future<RpcResult<Void>> result = lockManager.unlock(input);
 244             if ((result != null) && (result.get().isSuccessful())) {
 245                 logger.debug("Unlocked {}", lockName);
 246                 islockAcquired = true;
 247             } else {
 248                 logger.error("Unable to unlock {}", lockName);
 249             }
 250         } catch (InterruptedException | ExecutionException e) {
 251             logger.error("Unable to unlock {}", lockName);
 252             throw new RuntimeException(String.format("Unable to unlock %s", lockName), e.getCause());
 253         }
 254         return islockAcquired;
 255     }
 256
 257     protected static Short getIPPrefixFromPort(DataBroker broker, Port port) {
 258         Short prefix = new Short((short) 0);
 259         String cidr = "";
 260         try {
 261             Uuid subnetUUID = port.getFixedIps().get(0).getSubnetId();
 262
 263             SubnetKey subnetkey = new SubnetKey(subnetUUID);
 264             InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class).child(Subnets
 265                     .class).child(Subnet.class, subnetkey);
 266             Optional<Subnet> subnet = read(broker, LogicalDatastoreType.CONFIGURATION,subnetidentifier);
 267             if (subnet.isPresent()) {
 268                 cidr = subnet.get().getCidr();
 269                 // Extract the prefix length from cidr
 270                 String[] parts = cidr.split("/");
 271                 if ((parts.length == 2)) {
 272                     prefix = Short.valueOf(parts[1]);
 273                     return prefix;
 274                 } else {
 275                     logger.trace("Could not retrieve prefix from subnet CIDR");
 276                     System.out.println("Could not retrieve prefix from subnet CIDR");
 277                 }
 278             } else {
 279                 logger.trace("Unable to read on subnet datastore");
 280             }
 281         } catch (Exception e) {
 282             logger.error("Failed to retrieve IP prefix from port : ", e);
 283             System.out.println("Failed to retrieve IP prefix from port : " + e.getMessage());
 284         }
 285         return null;
 286     }
 287
 288     static InstanceIdentifier<PortFixedipToPortName> buildFixedIpToPortNameIdentifier(String fixedIp) {
 289         InstanceIdentifier<PortFixedipToPortName> id = InstanceIdentifier.builder(NeutronPortData.class).child
 290                 (PortFixedipToPortName.class, new PortFixedipToPortNameKey(fixedIp)).build();
 291         return id;
 292     }
 293
 294     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
 295         InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
 296                 NetworkMapKey(networkId)).build();
 297         return id;
 298     }
 299
 300     static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
 301         InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).
 302                 child(VpnInterface.class, new VpnInterfaceKey(ifName)).build();
 303         return id;
 304     }
 305
 306     static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
 307         InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).child(Subnetmap.class, new
 308                 SubnetmapKey(subnetId)).build();
 309         return id;
 310     }
 311
 312     static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
 313         InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
 314                 InterfaceKey(interfaceName)).build();
 315         return id;
 316     }
 317
 318     static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 319                                                    InstanceIdentifier<T> path) {
 320
 321         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 322
 323         Optional<T> result = Optional.absent();
 324         try {
 325             result = tx.read(datastoreType, path).get();
 326         } catch (Exception e) {
 327             throw new RuntimeException(e);
 328         }
 329
 330         return result;
 331     }
 332
 333 }