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 com.google.common.base.Preconditions;
  12 import java.util.Collections;
  13 import java.util.List;
  14 import java.util.Locale;
  15 import java.util.Objects;
  16 import java.util.regex.Pattern;
  17 import java.util.stream.Collectors;
  18 import javax.annotation.Nonnull;
  19 import javax.annotation.Nullable;
  20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  22 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  23 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap.RouterIds;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.binding.rev150712.PortBindingExtension;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  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.PortBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.neutron.networks.network.Segments;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 public final class NeutronUtils {
  41     private static final Logger LOG = LoggerFactory.getLogger(NeutronUtils.class);
  42
  43     public static final String VNIC_TYPE_NORMAL = "normal";
  44     public static final String PORT_STATUS_ACTIVE = "ACTIVE";
  45     public static final String PORT_STATUS_BUILD = "BUILD";
  46     public static final String PORT_STATUS_DOWN = "DOWN";
  47     public static final String PORT_STATUS_ERROR = "ERROR";
  48     public static final String PORT_STATUS_NOTAPPLICABLE = "N/A";
  49     private static volatile Pattern uuidPattern;
  50
  51     private NeutronUtils() { }
  52
  53     /**
  54      * Create a Neutron Port status entry in the operational data store.
  55      * @param uuid The uuid of the Neutron port
  56      * @param portStatus value to set the status (see constants above)
  57      * @param dataBroker DataBroker instance
  58      * @return true if transaction submitted successfully
  59      */
  60     public static boolean createPortStatus(String uuid, String portStatus, DataBroker dataBroker) {
  61         return writePortStatus(uuid, portStatus, dataBroker, true);
  62     }
  63
  64     /**
  65      * Update a Neutron Port status entry in the operational data store.
  66      * @param uuid The uuid of the Neutron port
  67      * @param portStatus value to set the status (see constants above)
  68      * @param dataBroker DataBroker instance
  69      * @return true if transaction submitted successfully
  70      */
  71     public static boolean updatePortStatus(String uuid, String portStatus, DataBroker dataBroker) {
  72         return writePortStatus(uuid, portStatus, dataBroker, false);
  73     }
  74
  75     private static boolean writePortStatus(String uuid, String portStatus, DataBroker dataBroker, boolean create) {
  76         Uuid uuidObj = new Uuid(uuid);
  77         PortBuilder portBuilder = new PortBuilder();
  78         portBuilder.setUuid(uuidObj);
  79         portBuilder.setStatus(portStatus);
  80
  81         InstanceIdentifier iid = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(
  82                                                                             Port.class, new PortKey(uuidObj));
  83         SingleTransactionDataBroker tx = new SingleTransactionDataBroker(dataBroker);
  84         try {
  85             if (create) {
  86                 tx.syncWrite(LogicalDatastoreType.OPERATIONAL, iid, portBuilder.build());
  87             } else {
  88                 tx.syncUpdate(LogicalDatastoreType.OPERATIONAL, iid, portBuilder.build());
  89             }
  90         } catch (TransactionCommitFailedException e) {
  91             LOG.error("writePortStatus: failed neutron port status write. isCreate: {}", create, e);
  92             return false;
  93         }
  94
  95         LOG.debug("writePortStatus: operational port status for {} set to {}", uuid, portStatus);
  96
  97         return true;
  98     }
  99
 100     /**
 101     * Delete a Neutron Port status entry from the operational data store.
 102     * @param uuid The uuid of the Neutron port
 103     * @param dataBroker DataBroker instance
 104     * @return true if transaction submitted successfully
 105     */
 106     public static boolean deletePortStatus(String uuid, DataBroker dataBroker) {
 107         Uuid uuidObj = new Uuid(uuid);
 108
 109         InstanceIdentifier iid = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(
 110                 Port.class, new PortKey(uuidObj));
 111         SingleTransactionDataBroker tx = new SingleTransactionDataBroker(dataBroker);
 112         try {
 113             tx.syncDelete(LogicalDatastoreType.OPERATIONAL, iid);
 114         } catch (TransactionCommitFailedException e) {
 115             LOG.error("deletePortStatus: failed neutron port status delete", e);
 116             return false;
 117         }
 118
 119         return true;
 120     }
 121
 122     public static boolean isPortVnicTypeNormal(Port port) {
 123         PortBindingExtension portBinding = port.augmentation(PortBindingExtension.class);
 124         if (portBinding == null || portBinding.getVnicType() == null) {
 125             // By default, VNIC_TYPE is NORMAL
 126             return true;
 127         }
 128         String vnicType = portBinding.getVnicType().trim().toLowerCase(Locale.getDefault());
 129         return VNIC_TYPE_NORMAL.equals(vnicType);
 130     }
 131
 132     public static <T extends NetworkTypeBase> String getSegmentationIdFromNeutronNetwork(Network network,
 133             Class<T> networkType) {
 134         String segmentationId = null;
 135         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 136         if (providerExtension != null) {
 137             segmentationId = providerExtension.getSegmentationId();
 138             if (segmentationId == null) {
 139                 List<Segments> providerSegments = providerExtension.getSegments();
 140                 if (providerSegments != null && providerSegments.size() > 0) {
 141                     for (Segments providerSegment: providerSegments) {
 142                         if (isNetworkSegmentType(providerSegment, networkType)) {
 143                             segmentationId = providerSegment.getSegmentationId();
 144                             break;
 145                         }
 146                     }
 147                 }
 148             }
 149         }
 150         return segmentationId;
 151     }
 152
 153     static <T extends NetworkTypeBase> boolean isNetworkSegmentType(Segments providerSegment,
 154             Class<T> expectedNetworkType) {
 155         Class<? extends NetworkTypeBase> networkType = providerSegment.getNetworkType();
 156         return networkType != null && networkType.isAssignableFrom(expectedNetworkType);
 157     }
 158
 159     public static <T extends NetworkTypeBase> boolean isNetworkSegmentType(Network network, Long index,
 160                                                                            Class<T> expectedNetworkType) {
 161         Class<? extends NetworkTypeBase> segmentType = null;
 162         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 163         if (providerExtension != null) {
 164             List<Segments> providerSegments = providerExtension.getSegments();
 165             if (providerSegments != null && providerSegments.size() > 0) {
 166                 for (Segments providerSegment : providerSegments) {
 167                     if (Objects.equals(providerSegment.getSegmentationIndex(), index)) {
 168                         segmentType = providerSegment.getNetworkType();
 169                         break;
 170                     }
 171                 }
 172             }
 173         }
 174         return segmentType != null && segmentType.isAssignableFrom(expectedNetworkType);
 175     }
 176
 177     public static Long getNumberSegmentsFromNeutronNetwork(Network network) {
 178         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 179         Integer numSegs = 0;
 180         if (providerExtension != null) {
 181             List<Segments> providerSegments = providerExtension.getSegments();
 182             if (providerSegments != null) {
 183                 numSegs = providerSegments.size();
 184             }
 185         }
 186         return Long.valueOf(numSegs);
 187     }
 188
 189     public static String getSegmentationIdFromNeutronNetworkSegment(Network network, Long index) {
 190         String segmentationId = null;
 191         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 192         if (providerExtension != null) {
 193             List<Segments> providerSegments = providerExtension.getSegments();
 194             if (providerSegments != null && providerSegments.size() > 0) {
 195                 for (Segments providerSegment : providerSegments) {
 196                     if (Objects.equals(providerSegment.getSegmentationIndex(), index)) {
 197                         segmentationId = providerSegment.getSegmentationId();
 198                         break;
 199                     }
 200                 }
 201             }
 202         }
 203         return segmentationId;
 204     }
 205
 206     public static boolean isUuid(String possibleUuid) {
 207         Preconditions.checkNotNull(possibleUuid, "possibleUuid == null");
 208
 209         if (uuidPattern == null) {
 210             // Thread safe because it really doesn't matter even if we were to do this initialization more than once
 211             if (Uuid.PATTERN_CONSTANTS.size() != 1) {
 212                 throw new IllegalStateException("Uuid.PATTERN_CONSTANTS.size() != 1");
 213             }
 214             uuidPattern = Pattern.compile(Uuid.PATTERN_CONSTANTS.get(0));
 215         }
 216
 217         if (uuidPattern.matcher(possibleUuid).matches()) {
 218             return Boolean.TRUE;
 219         } else {
 220             return Boolean.FALSE;
 221         }
 222     }
 223
 224     @Nonnull
 225     public static List<Uuid> getVpnMapRouterIdsListUuid(@Nullable List<RouterIds> routerIds) {
 226         if (routerIds == null) {
 227             return Collections.emptyList();
 228         }
 229         return routerIds.stream().map(
 230             routerId -> routerId.getRouterId()).collect(Collectors.toList());
 231     }
 232 }