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