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