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