v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfacesstate/InterfaceUtils.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.translate.v3po.interfacesstate;
  18
  19 import static com.google.common.base.Preconditions.checkArgument;
  20 import static java.util.Objects.requireNonNull;
  21
  22 import io.fd.honeycomb.translate.ModificationCache;
  23 import io.fd.honeycomb.translate.read.ReadFailedException;
  24 import io.fd.honeycomb.translate.util.RWUtils;
  25 import io.fd.honeycomb.translate.v3po.util.TranslateUtils;
  26 import java.math.BigInteger;
  27 import java.util.Map;
  28 import java.util.Objects;
  29 import java.util.concurrent.CompletionStage;
  30 import java.util.stream.Collector;
  31 import java.util.stream.Collectors;
  32 import javax.annotation.Nonnull;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.EthernetCsmacd;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.Tap;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VhostUser;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VxlanGpeTunnel;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VxlanTunnel;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.openvpp.jvpp.VppBaseCallException;
  43 import org.openvpp.jvpp.dto.SwInterfaceDetails;
  44 import org.openvpp.jvpp.dto.SwInterfaceDetailsReplyDump;
  45 import org.openvpp.jvpp.dto.SwInterfaceDump;
  46 import org.openvpp.jvpp.future.FutureJVpp;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 public final class InterfaceUtils {
  51     private static final Logger LOG = LoggerFactory.getLogger(InterfaceUtils.class);
  52
  53     private static final Gauge64 vppLinkSpeed0 = new Gauge64(BigInteger.ZERO);
  54     private static final Gauge64 vppLinkSpeed1 = new Gauge64(BigInteger.valueOf(10L * 1000000));
  55     private static final Gauge64 vppLinkSpeed2 = new Gauge64(BigInteger.valueOf(100L * 1000000));
  56     private static final Gauge64 vppLinkSpeed4 = new Gauge64(BigInteger.valueOf(1000L * 1000000));
  57     private static final Gauge64 vppLinkSpeed8 = new Gauge64(BigInteger.valueOf(10000L * 1000000));
  58     private static final Gauge64 vppLinkSpeed16 = new Gauge64(BigInteger.valueOf(40000L * 1000000));
  59     private static final Gauge64 vppLinkSpeed32 = new Gauge64(BigInteger.valueOf(100000L * 1000000));
  60
  61     private static final char[] HEX_CHARS = "0123456789abcdef".toCharArray();
  62
  63     private static final int PHYSICAL_ADDRESS_LENGTH = 6;
  64
  65     private static final Collector<SwInterfaceDetails, ?, SwInterfaceDetails> SINGLE_ITEM_COLLECTOR =
  66         RWUtils.singleItemCollector();
  67
  68     private InterfaceUtils() {
  69         throw new UnsupportedOperationException("This utility class cannot be instantiated");
  70     }
  71
  72     /**
  73      * Convert VPP's link speed bitmask to Yang type. 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
  74      *
  75      * @param vppLinkSpeed Link speed in bitmask format from VPP.
  76      * @return Converted value from VPP link speed
  77      */
  78     public static Gauge64 vppInterfaceSpeedToYang(byte vppLinkSpeed) {
  79         switch (vppLinkSpeed) {
  80             case 1:
  81                 return vppLinkSpeed1;
  82             case 2:
  83                 return vppLinkSpeed2;
  84             case 4:
  85                 return vppLinkSpeed4;
  86             case 8:
  87                 return vppLinkSpeed8;
  88             case 16:
  89                 return vppLinkSpeed16;
  90             case 32:
  91                 return vppLinkSpeed32;
  92             default:
  93                 return vppLinkSpeed0;
  94         }
  95     }
  96
  97     private static final void appendHexByte(final StringBuilder sb, final byte b) {
  98         final int v = b & 0xFF;
  99         sb.append(HEX_CHARS[v >>> 4]);
 100         sb.append(HEX_CHARS[v & 15]);
 101     }
 102
 103     // TODO rename and move to V3poUtils
 104
 105     /**
 106      * Reads first 6 bytes of supplied byte array and converts to string as Yang dictates <p> Replace later with
 107      * https://git.opendaylight.org/gerrit/#/c/34869/10/model/ietf/ietf-type- util/src/main/
 108      * java/org/opendaylight/mdsal/model/ietf/util/AbstractIetfYangUtil.java
 109      *
 110      * @param vppPhysAddress byte array of bytes in big endian order, constructing the network IF physical address.
 111      * @return String like "aa:bb:cc:dd:ee:ff"
 112      * @throws NullPointerException     if vppPhysAddress is null
 113      * @throws IllegalArgumentException if vppPhysAddress.length < 6
 114      */
 115     public static String vppPhysAddrToYang(@Nonnull final byte[] vppPhysAddress) {
 116         return vppPhysAddrToYang(vppPhysAddress, 0);
 117     }
 118
 119     public static String vppPhysAddrToYang(@Nonnull final byte[] vppPhysAddress, final int startIndex) {
 120         Objects.requireNonNull(vppPhysAddress, "Empty physical address bytes");
 121         final int endIndex = startIndex + PHYSICAL_ADDRESS_LENGTH;
 122         checkArgument(endIndex <= vppPhysAddress.length,
 123             "Invalid physical address size (%s) for given startIndex (%s), expected >= %s", vppPhysAddress.length,
 124             startIndex, endIndex);
 125         return printHexBinary(vppPhysAddress, startIndex, endIndex);
 126     }
 127
 128     public static String printHexBinary(@Nonnull final byte[] bytes) {
 129         Objects.requireNonNull(bytes, "bytes array should not be null");
 130         return printHexBinary(bytes, 0, bytes.length);
 131     }
 132
 133     private static String printHexBinary(@Nonnull final byte[] bytes, final int startIndex, final int endIndex) {
 134         StringBuilder str = new StringBuilder();
 135
 136         appendHexByte(str, bytes[startIndex]);
 137         for (int i = startIndex + 1; i < endIndex; i++) {
 138             str.append(":");
 139             appendHexByte(str, bytes[i]);
 140         }
 141
 142         return str.toString();
 143     }
 144
 145     /**
 146      * VPP's interface index is counted from 0, whereas ietf-interface's if-index is from 1. This function converts from
 147      * VPP's interface index to YANG's interface index.
 148      *
 149      * @param vppIfIndex the sw interface index VPP reported.
 150      * @return VPP's interface index incremented by one
 151      */
 152     public static int vppIfIndexToYang(int vppIfIndex) {
 153         return vppIfIndex + 1;
 154     }
 155
 156     /**
 157      * This function does the opposite of what {@link #vppIfIndexToYang(int)} does.
 158      *
 159      * @param yangIfIndex if-index from ietf-interfaces.
 160      * @return VPP's representation of the if-index
 161      */
 162     public static int yangIfIndexToVpp(int yangIfIndex) {
 163         checkArgument(yangIfIndex >= 1, "YANG if-index has invalid value %s", yangIfIndex);
 164         return yangIfIndex - 1;
 165     }
 166
 167
 168     /**
 169      * Queries VPP for interface description given interface key.
 170      *
 171      * @param futureJvpp VPP Java Future API
 172      * @param id         InstanceIdentifier, which is passed in ReadFailedException
 173      * @param name       interface name
 174      * @param index      VPP index of the interface
 175      * @param ctx        per-tx scope context containing cached dump with all the interfaces. If the cache is not
 176      *                   available or outdated, another dump will be performed.
 177      * @return SwInterfaceDetails DTO or null if interface was not found
 178      * @throws IllegalArgumentException If interface cannot be found
 179      * @throws ReadFailedException      If read operation had failed
 180      */
 181     @Nonnull
 182     public static SwInterfaceDetails getVppInterfaceDetails(@Nonnull final FutureJVpp futureJvpp,
 183                                                             @Nonnull final InstanceIdentifier<?> id,
 184                                                             @Nonnull final String name, final int index,
 185                                                             @Nonnull final ModificationCache ctx)
 186         throws ReadFailedException {
 187         requireNonNull(futureJvpp, "futureJvpp should not be null");
 188         requireNonNull(name, "name should not be null");
 189         requireNonNull(ctx, "ctx should not be null");
 190
 191         final SwInterfaceDump request = new SwInterfaceDump();
 192         request.nameFilter = name.getBytes();
 193         request.nameFilterValid = 1;
 194
 195         final Map<Integer, SwInterfaceDetails> allInterfaces = InterfaceCustomizer.getCachedInterfaceDump(ctx);
 196
 197         // Returned cached if available
 198         if (allInterfaces.containsKey(index)) {
 199             return allInterfaces.get(index);
 200         }
 201
 202         SwInterfaceDetailsReplyDump ifaces;
 203         try {
 204             CompletionStage<SwInterfaceDetailsReplyDump> requestFuture = futureJvpp.swInterfaceDump(request);
 205             ifaces = TranslateUtils.getReplyForRead(requestFuture.toCompletableFuture(), id);
 206             if (null == ifaces || null == ifaces.swInterfaceDetails || ifaces.swInterfaceDetails.isEmpty()) {
 207                 request.nameFilterValid = 0;
 208
 209                 LOG.warn("VPP returned null instead of interface by key {} and its not cached", name);
 210                 LOG.warn("Iterating through all the interfaces to find interface: {}", name);
 211
 212                 // Or else just perform full dump and do inefficient filtering
 213                 requestFuture = futureJvpp.swInterfaceDump(request);
 214                 ifaces = TranslateUtils.getReplyForRead(requestFuture.toCompletableFuture(), id);
 215
 216                 // Update the cache
 217                 allInterfaces.clear();
 218                 allInterfaces
 219                     .putAll(ifaces.swInterfaceDetails.stream().collect(Collectors.toMap(d -> d.swIfIndex, d -> d)));
 220
 221                 if (allInterfaces.containsKey(index)) {
 222                     return allInterfaces.get(index);
 223                 }
 224                 throw new IllegalArgumentException("Unable to find interface " + name);
 225             }
 226         } catch (VppBaseCallException e) {
 227             LOG.warn("getVppInterfaceDetails for id :{} and name :{} failed with exception :", id, name, e);
 228             throw new ReadFailedException(id, e);
 229         }
 230
 231         // SwInterfaceDump's name filter does prefix match, so we need additional filtering:
 232         final SwInterfaceDetails iface =
 233             ifaces.swInterfaceDetails.stream().filter(d -> d.swIfIndex == index).collect(SINGLE_ITEM_COLLECTOR);
 234         allInterfaces.put(index, iface); // update the cache
 235         return iface;
 236     }
 237
 238     /**
 239      * Determine interface type based on its VPP name (relying on VPP's interface naming conventions)
 240      *
 241      * @param interfaceName VPP generated interface name
 242      * @return Interface type
 243      */
 244     @Nonnull
 245     public static Class<? extends InterfaceType> getInterfaceType(@Nonnull final String interfaceName) {
 246         if (interfaceName.startsWith("tap")) {
 247             return Tap.class;
 248         }
 249
 250         if (interfaceName.startsWith("vxlan_gpe")) {
 251             return VxlanGpeTunnel.class;
 252         }
 253
 254         if (interfaceName.startsWith("vxlan")) {
 255             return VxlanTunnel.class;
 256         }
 257
 258         if (interfaceName.startsWith("VirtualEthernet")) {
 259             return VhostUser.class;
 260         }
 261
 262         return EthernetCsmacd.class;
 263     }
 264
 265     /**
 266      * Check interface type. Uses interface details from VPP to determine. Uses {@link
 267      * #getVppInterfaceDetails(FutureJVpp, InstanceIdentifier, String, int, ModificationCache)} internally so tries to
 268      * utilize cache before asking VPP.
 269      */
 270     static boolean isInterfaceOfType(@Nonnull final FutureJVpp jvpp,
 271                                      @Nonnull final ModificationCache cache,
 272                                      @Nonnull final InstanceIdentifier<?> id,
 273                                      final int index,
 274                                      @Nonnull final Class<? extends InterfaceType> ifcType) throws ReadFailedException {
 275         final String name = id.firstKeyOf(Interface.class).getName();
 276         final SwInterfaceDetails vppInterfaceDetails =
 277             getVppInterfaceDetails(jvpp, id, name, index, cache);
 278
 279         return isInterfaceOfType(ifcType, vppInterfaceDetails);
 280     }
 281
 282     static boolean isInterfaceOfType(final Class<? extends InterfaceType> ifcType,
 283                                      final SwInterfaceDetails cachedDetails) {
 284         return ifcType.equals(getInterfaceType(TranslateUtils.toString(cachedDetails.interfaceName)));
 285     }
 286 }