vpnservice/neutronvpn/neutronvpn-api/src/main/java/org/opendaylight/netvirt/neutronvpn/api/utils/NeutronUtils.java

   1 /*
   2  * Copyright (c) 2016, 2017 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.api.utils;
  10
  11 import java.util.List;
  12 import java.util.Objects;
  13
  14 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  16 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  17 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.binding.rev150712.PortBindingExtension;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.neutron.networks.network.Segments;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 public class NeutronUtils {
  34     private static final Logger LOG = LoggerFactory.getLogger(NeutronUtils.class);
  35
  36     public static final String VNIC_TYPE_NORMAL = "normal";
  37     public static final String PORT_STATUS_ACTIVE = "ACTIVE";
  38     public static final String PORT_STATUS_BUILD = "BUILD";
  39     public static final String PORT_STATUS_DOWN = "DOWN";
  40     public static final String PORT_STATUS_ERROR = "ERROR";
  41     public static final String PORT_STATUS_NOTAPPLICABLE = "N/A";
  42
  43     /**
  44      * Create a Neutron Port status entry in the operational data store.
  45      * @param uuid The uuid of the Neutron port
  46      * @param portStatus value to set the status (see constants above)
  47      * @param dataBroker DataBroker instance
  48      * @return true if transaction submitted successfully
  49      */
  50     public static boolean createPortStatus(String uuid, String portStatus, DataBroker dataBroker) {
  51         return writePortStatus(uuid, portStatus, dataBroker, true);
  52     }
  53
  54     /**
  55      * Update a Neutron Port status entry in the operational data store.
  56      * @param uuid The uuid of the Neutron port
  57      * @param portStatus value to set the status (see constants above)
  58      * @param dataBroker DataBroker instance
  59      * @return true if transaction submitted successfully
  60      */
  61     public static boolean updatePortStatus(String uuid, String portStatus, DataBroker dataBroker) {
  62         return writePortStatus(uuid, portStatus, dataBroker, false);
  63     }
  64
  65     private static boolean writePortStatus(String uuid, String portStatus, DataBroker dataBroker, boolean create) {
  66         Uuid uuidObj = new Uuid(uuid);
  67         PortBuilder portBuilder = new PortBuilder();
  68         portBuilder.setUuid(uuidObj);
  69         portBuilder.setStatus(portStatus);
  70
  71         InstanceIdentifier iid = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(
  72                                                                             Port.class, new PortKey(uuidObj));
  73         SingleTransactionDataBroker tx = new SingleTransactionDataBroker(dataBroker);
  74         try {
  75             if (create) {
  76                 tx.syncWrite(LogicalDatastoreType.OPERATIONAL, iid, portBuilder.build());
  77             } else {
  78                 tx.syncUpdate(LogicalDatastoreType.OPERATIONAL, iid, portBuilder.build());
  79             }
  80         } catch (TransactionCommitFailedException e) {
  81             LOG.error("writePortStatus: failed neutron port status write. isCreate ? " + create, e);
  82             return false;
  83         }
  84
  85         return true;
  86     }
  87
  88     /**
  89     * Delete a Neutron Port status entry from the operational data store.
  90     * @param uuid The uuid of the Neutron port
  91     * @param dataBroker DataBroker instance
  92     * @return true if transaction submitted successfully
  93     */
  94     public static boolean deletePortStatus(String uuid, DataBroker dataBroker) {
  95         Uuid uuidObj = new Uuid(uuid);
  96
  97         InstanceIdentifier iid = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(
  98                 Port.class, new PortKey(uuidObj));
  99         SingleTransactionDataBroker tx = new SingleTransactionDataBroker(dataBroker);
 100         try {
 101             tx.syncDelete(LogicalDatastoreType.OPERATIONAL, iid);
 102         } catch (TransactionCommitFailedException e) {
 103             LOG.error("deletePortStatus: failed neutron port status delete", e);
 104             return false;
 105         }
 106
 107         return true;
 108     }
 109
 110     public static boolean isPortVnicTypeNormal(Port port) {
 111         PortBindingExtension portBinding = port.getAugmentation(PortBindingExtension.class);
 112         if (portBinding == null || portBinding.getVnicType() == null) {
 113             // By default, VNIC_TYPE is NORMAL
 114             return true;
 115         }
 116         String vnicType = portBinding.getVnicType().trim().toLowerCase();
 117         return vnicType.equals(VNIC_TYPE_NORMAL);
 118     }
 119
 120     public static <T extends NetworkTypeBase> String getSegmentationIdFromNeutronNetwork(Network network,
 121             Class<T> networkType) {
 122         String segmentationId = null;
 123         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 124         if (providerExtension != null) {
 125             segmentationId = providerExtension.getSegmentationId();
 126             if (segmentationId == null) {
 127                 List<Segments> providerSegments = providerExtension.getSegments();
 128                 if (providerSegments != null && providerSegments.size() > 0) {
 129                     for (Segments providerSegment: providerSegments) {
 130                         if (isNetworkSegmentType(providerSegment, networkType)) {
 131                             segmentationId = providerSegment.getSegmentationId();
 132                             break;
 133                         }
 134                     }
 135                 }
 136             }
 137         }
 138         return segmentationId;
 139     }
 140
 141     static <T extends NetworkTypeBase> boolean isNetworkSegmentType(Segments providerSegment,
 142             Class<T> expectedNetworkType) {
 143         Class<? extends NetworkTypeBase> networkType = providerSegment.getNetworkType();
 144         return (networkType != null && networkType.isAssignableFrom(expectedNetworkType));
 145     }
 146
 147     public static <T extends NetworkTypeBase> boolean isNetworkSegmentType(Network network, Long index,
 148                                                                            Class<T> expectedNetworkType) {
 149         Class<? extends NetworkTypeBase> segmentType = null;
 150         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 151         if (providerExtension != null) {
 152             List<Segments> providerSegments = providerExtension.getSegments();
 153             if (providerSegments != null && providerSegments.size() > 0) {
 154                 for (Segments providerSegment : providerSegments) {
 155                     if (Objects.equals(providerSegment.getSegmentationIndex(), index)) {
 156                         segmentType = providerSegment.getNetworkType();
 157                         break;
 158                     }
 159                 }
 160             }
 161         }
 162         return (segmentType != null && segmentType.isAssignableFrom(expectedNetworkType));
 163     }
 164
 165     public static Long getNumberSegmentsFromNeutronNetwork(Network network) {
 166         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 167         Integer numSegs = 0;
 168         if (providerExtension != null) {
 169             List<Segments> providerSegments = providerExtension.getSegments();
 170             if (providerSegments != null) {
 171                 numSegs = providerSegments.size();
 172             }
 173         }
 174         return Long.valueOf(numSegs);
 175     }
 176
 177     public static String getSegmentationIdFromNeutronNetworkSegment(Network network, Long index) {
 178         String segmentationId = null;
 179         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 180         if (providerExtension != null) {
 181             List<Segments> providerSegments = providerExtension.getSegments();
 182             if (providerSegments != null && providerSegments.size() > 0) {
 183                 for (Segments providerSegment : providerSegments) {
 184                     if (Objects.equals(providerSegment.getSegmentationIndex(), index)) {
 185                         segmentationId = providerSegment.getSegmentationId();
 186                         break;
 187                     }
 188                 }
 189             }
 190         }
 191         return segmentationId;
 192     }
 193
 194
 195 }