v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/vppclassifier/ClassifyTableReader.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.vppclassifier;
  18
  19 import static com.google.common.base.Preconditions.checkArgument;
  20 import static com.google.common.base.Preconditions.checkNotNull;
  21
  22 import com.google.common.base.Optional;
  23 import com.google.common.primitives.UnsignedInts;
  24 import io.fd.honeycomb.translate.read.ReadContext;
  25 import io.fd.honeycomb.translate.read.ReadFailedException;
  26 import io.fd.honeycomb.translate.spi.read.Initialized;
  27 import io.fd.honeycomb.translate.spi.read.InitializingListReaderCustomizer;
  28 import io.fd.honeycomb.translate.v3po.interfacesstate.InterfaceDataTranslator;
  29 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  30 import io.fd.honeycomb.translate.vpp.util.JvppReplyConsumer;
  31 import io.fd.honeycomb.translate.vpp.util.MacTranslator;
  32 import io.fd.vpp.jvpp.core.dto.ClassifyTableIds;
  33 import io.fd.vpp.jvpp.core.dto.ClassifyTableIdsReply;
  34 import io.fd.vpp.jvpp.core.dto.ClassifyTableInfo;
  35 import io.fd.vpp.jvpp.core.dto.ClassifyTableInfoReply;
  36 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
  37 import java.util.Arrays;
  38 import java.util.Collections;
  39 import java.util.List;
  40 import java.util.stream.Collectors;
  41 import javax.annotation.Nonnull;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.VppClassifier;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.VppClassifierStateBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.VppNodeName;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.vpp.classifier.state.ClassifyTable;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.vpp.classifier.state.ClassifyTableBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.vpp.classifier.state.ClassifyTableKey;
  49 import org.opendaylight.yangtools.concepts.Builder;
  50 import org.opendaylight.yangtools.yang.binding.DataObject;
  51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 /**
  56  * Reader customizer responsible for classify table read.<br> to VPP.<br> Equivalent to invoking {@code vppctl show
  57  * class table} command.
  58  */
  59 public class ClassifyTableReader extends FutureJVppCustomizer
  60         implements InitializingListReaderCustomizer<ClassifyTable, ClassifyTableKey, ClassifyTableBuilder>, VppNodeReader,
  61         MacTranslator, InterfaceDataTranslator, JvppReplyConsumer {
  62
  63     private static final Logger LOG = LoggerFactory.getLogger(ClassifyTableReader.class);
  64     private final VppClassifierContextManager classifyTableContext;
  65
  66     public ClassifyTableReader(@Nonnull final FutureJVppCore futureJVppCore,
  67                                @Nonnull final VppClassifierContextManager classifyTableContext) {
  68         super(futureJVppCore);
  69         this.classifyTableContext = checkNotNull(classifyTableContext, "classifyTableContext should not be null");
  70     }
  71
  72
  73     @Override
  74     public void merge(@Nonnull final Builder<? extends DataObject> builder,
  75                       @Nonnull final List<ClassifyTable> readData) {
  76         ((VppClassifierStateBuilder) builder).setClassifyTable(readData);
  77     }
  78
  79     @Nonnull
  80     @Override
  81     public ClassifyTableBuilder getBuilder(@Nonnull final InstanceIdentifier<ClassifyTable> id) {
  82         return new ClassifyTableBuilder();
  83     }
  84
  85     @Override
  86     public void readCurrentAttributes(@Nonnull final InstanceIdentifier<ClassifyTable> id,
  87                                       @Nonnull final ClassifyTableBuilder builder, @Nonnull final ReadContext ctx)
  88             throws ReadFailedException {
  89         LOG.debug("Reading attributes for classify table: {}", id);
  90
  91         final ClassifyTableKey key = id.firstKeyOf(ClassifyTable.class);
  92         checkArgument(key != null, "could not find ClassifyTable key in {}", id);
  93         final ClassifyTableInfo request = new ClassifyTableInfo();
  94
  95         final String tableName = key.getName();
  96         if (!classifyTableContext.containsTable(tableName, ctx.getMappingContext())) {
  97             LOG.debug("Could not find classify table {} in the naming context", tableName);
  98             return;
  99         }
 100         request.tableId = classifyTableContext.getTableIndex(tableName, ctx.getMappingContext());
 101
 102
 103         final ClassifyTableInfoReply reply =
 104                 getReplyForRead(getFutureJVpp().classifyTableInfo(request).toCompletableFuture(), id);
 105
 106         // mandatory values:
 107         builder.setName(tableName);
 108         builder.setKey(key);
 109         builder.setNbuckets(UnsignedInts.toLong(reply.nbuckets));
 110         builder.setSkipNVectors(UnsignedInts.toLong(reply.skipNVectors));
 111
 112         // optional value read from context
 113         final Optional<String> tableBaseNode =
 114                 classifyTableContext.getTableBaseNode(tableName, ctx.getMappingContext());
 115         if (tableBaseNode.isPresent()) {
 116             builder.setClassifierNode(new VppNodeName(tableBaseNode.get()));
 117         }
 118
 119         builder.setMissNext(
 120                 readVppNode(reply.tableId, reply.missNextIndex, classifyTableContext, ctx.getMappingContext(), LOG)
 121                         .get());
 122         builder.setMask(new HexString(printHexBinary(reply.mask)));
 123         builder.setActiveSessions(UnsignedInts.toLong(reply.activeSessions));
 124
 125         if (reply.nextTableIndex != ~0) {
 126             // next table index is present:
 127             builder.setNextTable(classifyTableContext.getTableName(reply.nextTableIndex, ctx.getMappingContext()));
 128         }
 129
 130         if (LOG.isTraceEnabled()) {
 131             LOG.trace("Attributes for classify table {} successfully read: {}", id, builder.build());
 132         }
 133     }
 134
 135     @Nonnull
 136     @Override
 137     public List<ClassifyTableKey> getAllIds(@Nonnull final InstanceIdentifier<ClassifyTable> id,
 138                                             @Nonnull final ReadContext context) throws ReadFailedException {
 139         LOG.debug("Reading list of keys for classify tables: {}", id);
 140
 141         final ClassifyTableIdsReply classifyTableIdsReply =
 142                 getReplyForRead(getFutureJVpp().classifyTableIds(new ClassifyTableIds()).toCompletableFuture(),
 143                         id);
 144         if (classifyTableIdsReply.ids != null) {
 145             return Arrays.stream(classifyTableIdsReply.ids).mapToObj(i -> {
 146                 final String tableName = classifyTableContext.getTableName(i, context.getMappingContext());
 147                 LOG.trace("Classify table with name: {} and index: {} found in VPP", tableName, i);
 148                 return new ClassifyTableKey(tableName);
 149             }).collect(Collectors.toList());
 150         } else {
 151             return Collections.emptyList();
 152         }
 153     }
 154
 155     @Override
 156     public Initialized<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.vpp.classifier.ClassifyTable> init(
 157             @Nonnull final InstanceIdentifier<ClassifyTable> id, @Nonnull final ClassifyTable readValue,
 158             @Nonnull final ReadContext ctx) {
 159         return Initialized.create(getCfgId(id),
 160                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.vpp.classifier.ClassifyTableBuilder(readValue)
 161                         .setName(readValue.getName())
 162                         .build());
 163     }
 164
 165     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.vpp.classifier.ClassifyTable> getCfgId(
 166             final InstanceIdentifier<ClassifyTable> id) {
 167         return InstanceIdentifier.create(VppClassifier.class)
 168                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.vpp.classifier.ClassifyTable.class,
 169                         new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev161214.vpp.classifier.ClassifyTableKey(id.firstKeyOf(ClassifyTable.class).getName()));
 170     }
 171 }