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

   1 /*
   2  * Copyright (c) 2015 - 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.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.LockManagerService;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.TimeUnits;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.TryLockInput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.TryLockInputBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.UnlockInput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.lockmanager.rev150819.UnlockInputBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.NeutronPortData;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.Subnetmaps;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.VpnMaps;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data
  38         .PortFixedipToPortName;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data
  40         .PortFixedipToPortNameKey;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data
  42         .PortNameToPortUuid;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data
  44         .PortNameToPortUuidKey;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.subnetmaps.Subnetmap;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.vpnmaps.VpnMap;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.vpnmaps.VpnMapKey;
  49 import org.opendaylight.yangtools.yang.binding.DataObject;
  50 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.common.RpcResult;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 import java.util.ArrayList;
  56 import java.util.List;
  57 import java.util.concurrent.ExecutionException;
  58 import java.util.concurrent.Future;
  59
  60 //import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.port.ext.rev151125.TrunkportExt;
  61 //import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.port.ext.rev151125.TrunkportTypeBase;
  62 //import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.port.ext.rev151125.TrunkportTypeSubport;
  63
  64 public class NeutronvpnUtils {
  65
  66     private static final Logger logger = LoggerFactory.getLogger(NeutronvpnUtils.class);
  67
  68     protected static Subnetmap getSubnetmap(DataBroker broker, Uuid subnetId) {
  69         InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).
  70                 child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
  71         Optional<Subnetmap> sn = read(broker, LogicalDatastoreType.CONFIGURATION, id);
  72
  73         if (sn.isPresent()) {
  74             return sn.get();
  75         }
  76         return null;
  77     }
  78
  79     protected static VpnMap getVpnMap(DataBroker broker, Uuid id) {
  80         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class)
  81                 .child(VpnMap.class, new VpnMapKey(id)).build();
  82         Optional<VpnMap> optionalVpnMap = read(broker, LogicalDatastoreType.CONFIGURATION,
  83                 vpnMapIdentifier);
  84         if (optionalVpnMap.isPresent()) {
  85             return optionalVpnMap.get();
  86         }
  87         logger.error("getVpnMap failed, VPN {} not present", id.getValue());
  88         return null;
  89     }
  90
  91     protected static Uuid getVpnForNetwork(DataBroker broker, Uuid network) {
  92         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
  93         Optional<VpnMaps> optionalVpnMaps = read(broker, LogicalDatastoreType.CONFIGURATION,
  94                 vpnMapsIdentifier);
  95         if (optionalVpnMaps.isPresent()) {
  96             VpnMaps vpnMaps = optionalVpnMaps.get();
  97             List<VpnMap> allMaps = vpnMaps.getVpnMap();
  98             for (VpnMap vpnMap : allMaps) {
  99                 if (vpnMap.getNetworkIds().contains(network)) {
 100                     return vpnMap.getVpnId();
 101                 }
 102             }
 103         }
 104         return null;
 105     }
 106
 107     protected static Uuid getVpnForRouter(DataBroker broker, Uuid router) {
 108         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 109         Optional<VpnMaps> optionalVpnMaps = read(broker, LogicalDatastoreType.CONFIGURATION,
 110                 vpnMapsIdentifier);
 111         if (optionalVpnMaps.isPresent()) {
 112             VpnMaps vpnNets = optionalVpnMaps.get();
 113             List<VpnMap> allMaps = vpnNets.getVpnMap();
 114             if (router != null) {
 115                 for (VpnMap vpnMap : allMaps) {
 116                     if (router.equals(vpnMap.getRouterId())) {
 117                         return vpnMap.getVpnId();
 118                     }
 119                 }
 120             }
 121         }
 122         return null;
 123     }
 124
 125     protected static Uuid getRouterforVpn(DataBroker broker, Uuid vpnId) {
 126         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class)
 127                 .child(VpnMap.class, new VpnMapKey(vpnId)).build();
 128         Optional<VpnMap> optionalVpnMap = read(broker, LogicalDatastoreType.CONFIGURATION,
 129                 vpnMapIdentifier);
 130         if (optionalVpnMap.isPresent()) {
 131             VpnMap vpnMap = optionalVpnMap.get();
 132             return vpnMap.getRouterId();
 133         }
 134         return null;
 135     }
 136
 137     protected static Uuid getNeutronPortIdfromPortName(DataBroker broker, String portname) {
 138         InstanceIdentifier id = buildPortNameToPortUuidIdentifier(portname);
 139         Optional<PortNameToPortUuid> portNameToPortUuidData = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 140         if (portNameToPortUuidData.isPresent()) {
 141             return portNameToPortUuidData.get().getPortId();
 142         }
 143         return null;
 144     }
 145
 146     protected static String getNeutronPortNamefromPortFixedIp(DataBroker broker, String fixedIp) {
 147         InstanceIdentifier id = buildFixedIpToPortNameIdentifier(fixedIp);
 148         Optional<PortFixedipToPortName> portFixedipToPortNameData = read(broker, LogicalDatastoreType.CONFIGURATION,
 149                 id);
 150         if (portFixedipToPortNameData.isPresent()) {
 151             return portFixedipToPortNameData.get().getPortName();
 152         }
 153         return null;
 154     }
 155
 156     //TODO
 157     //Will be done once integrated with TrunkPort Extensions
 158     protected static int getVlanFromNeutronPort(Port port) {
 159         int vlanId = 0;
 160         /*
 161         TrunkportExt trunkportExt = port.getAugmentation(TrunkportExt.class);
 162         if (trunkportExt != null) {
 163             Class<? extends TrunkportTypeBase> trunkportType = trunkportExt.getType();
 164             if (trunkportType != null && trunkportType.isAssignableFrom(TrunkportTypeSubport.class)) {
 165                 vlanId = trunkportExt.getVid();
 166             }
 167         }
 168         */
 169         return vlanId;
 170     }
 171
 172     protected static Router getNeutronRouter(DataBroker broker, Uuid routerId) {
 173
 174         InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).
 175                 child(Routers.class).child(Router.class, new RouterKey(routerId));
 176
 177         Optional<Router> rtr = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 178         if (rtr.isPresent()) {
 179             return rtr.get();
 180         }
 181         return null;
 182     }
 183
 184     protected static Network getNeutronNetwork(DataBroker broker, Uuid networkId) {
 185         logger.debug("getNeutronNetwork for {}", networkId.getValue());
 186         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).
 187                 child(Networks.class).child(Network.class, new NetworkKey(networkId));
 188
 189         Optional<Network> net = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 190         if (net.isPresent()) {
 191             return net.get();
 192         }
 193         return null;
 194     }
 195
 196     protected static List<Uuid> getNeutronNetworkSubnetIds(DataBroker broker, Uuid networkId) {
 197
 198         logger.debug("getNeutronNetworkSubnetIds for {}", networkId.getValue());
 199         Network network = getNeutronNetwork(broker, networkId);
 200         if (network != null) {
 201             //TODO
 202             //return network.getSubnets();
 203         }
 204         logger.debug("returning from getNeutronNetworkSubnetIds for {}", networkId.getValue());
 205
 206         return null;
 207     }
 208
 209     protected static List<Uuid> getNeutronRouterSubnetIds(DataBroker broker, Uuid routerId) {
 210         logger.info("getNeutronRouterSubnetIds for {}", routerId.getValue());
 211
 212         List<Uuid> subnetNames = new ArrayList<Uuid>();
 213         Router router = getNeutronRouter(broker, routerId);
 214         if (router != null) {
 215             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router
 216                     .Interfaces> ifs = router.getInterfaces();
 217             if (!ifs.isEmpty()) {
 218                 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers
 219                         .router.Interfaces iff : ifs) {
 220                     subnetNames.add(iff.getSubnetId());
 221                 }
 222             }
 223         }
 224         logger.info("returning from getNeutronRouterSubnetIds for {}", routerId.getValue());
 225         return subnetNames;
 226     }
 227
 228     protected static String uuidToTapPortName(Uuid id) {
 229         String tapId = id.getValue().substring(0, 11);
 230         return new StringBuilder().append("tap").append(tapId).toString();
 231     }
 232
 233     protected static void lockVpnInterface(LockManagerService lockManager, String vpnInterfaceName) {
 234         TryLockInput input = new TryLockInputBuilder().setLockName(vpnInterfaceName).setTime(5L).setTimeUnit
 235                 (TimeUnits.Milliseconds).build();
 236         Future<RpcResult<Void>> result = lockManager.tryLock(input);
 237         try {
 238             if ((result != null) && (result.get().isSuccessful())) {
 239                 logger.debug("Acquired lock for vpninterface {}", vpnInterfaceName);
 240             } else {
 241                 throw new RuntimeException(String.format("Unable to getLock for vpninterface %s", vpnInterfaceName));
 242             }
 243         } catch (InterruptedException | ExecutionException e) {
 244             logger.error("Unable to getLock for vpninterface {}", vpnInterfaceName);
 245             throw new RuntimeException(String.format("Unable to getLock for vpninterface %s", vpnInterfaceName), e
 246                     .getCause());
 247         }
 248     }
 249
 250     protected static void unlockVpnInterface(LockManagerService lockManager, String vpnInterfaceName) {
 251         UnlockInput input = new UnlockInputBuilder().setLockName(vpnInterfaceName).build();
 252         Future<RpcResult<Void>> result = lockManager.unlock(input);
 253         try {
 254             if ((result != null) && (result.get().isSuccessful())) {
 255                 logger.debug("Unlocked vpninterface{}", vpnInterfaceName);
 256             } else {
 257                 logger.debug("Unable to unlock vpninterface {}", vpnInterfaceName);
 258             }
 259         } catch (InterruptedException | ExecutionException e) {
 260             logger.error("Unable to unlock vpninterface {}", vpnInterfaceName);
 261             throw new RuntimeException(String.format("Unable to unlock vpninterface %s", vpnInterfaceName), e
 262                     .getCause());
 263         }
 264     }
 265
 266     static InstanceIdentifier<PortNameToPortUuid> buildPortNameToPortUuidIdentifier(String portname) {
 267         InstanceIdentifier<PortNameToPortUuid> id =
 268                 InstanceIdentifier.builder(NeutronPortData.class).child(PortNameToPortUuid.class, new
 269                         PortNameToPortUuidKey(portname)).build();
 270         return id;
 271     }
 272
 273     static InstanceIdentifier<PortFixedipToPortName> buildFixedIpToPortNameIdentifier(String fixedIp) {
 274         InstanceIdentifier<PortFixedipToPortName> id =
 275                 InstanceIdentifier.builder(NeutronPortData.class).child(PortFixedipToPortName.class, new
 276                         PortFixedipToPortNameKey(fixedIp)).build();
 277         return id;
 278     }
 279
 280     static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
 281         InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
 282                 InterfaceKey(interfaceName)).build();
 283         return id;
 284     }
 285
 286     static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 287                                                    InstanceIdentifier<T> path) {
 288
 289         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 290
 291         Optional<T> result = Optional.absent();
 292         try {
 293             result = tx.read(datastoreType, path).get();
 294         } catch (Exception e) {
 295             throw new RuntimeException(e);
 296         }
 297
 298         return result;
 299     }
 300
 301 }