nsh/impl/src/main/java/io/fd/honeycomb/vppnsh/impl/oper/NshEntryReaderCustomizer.java

   1 /*
   2  * Copyright (c) 2016 Intel 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.vppnsh.impl.oper;
  18
  19 import static com.google.common.base.Preconditions.checkArgument;
  20 import static com.google.common.base.Preconditions.checkNotNull;
  21
  22 import io.fd.honeycomb.translate.read.ReadContext;
  23 import io.fd.honeycomb.translate.read.ReadFailedException;
  24 import io.fd.honeycomb.translate.spi.read.Initialized;
  25 import io.fd.honeycomb.translate.spi.read.InitializingListReaderCustomizer;
  26 import io.fd.honeycomb.translate.vpp.util.JvppReplyConsumer;
  27 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  28 import io.fd.honeycomb.vppnsh.impl.util.FutureJVppNshCustomizer;
  29 import io.fd.vpp.jvpp.nsh.dto.NshEntryDetails;
  30 import io.fd.vpp.jvpp.nsh.dto.NshEntryDetailsReplyDump;
  31 import io.fd.vpp.jvpp.nsh.dto.NshEntryDump;
  32 import io.fd.vpp.jvpp.nsh.future.FutureJVppNsh;
  33 import java.util.ArrayList;
  34 import java.util.Collections;
  35 import java.util.List;
  36 import java.util.concurrent.CompletionStage;
  37 import javax.annotation.Nonnull;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.Ethernet;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.Ipv4;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.Ipv6;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.MdType1;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.NshMdType1StateAugment;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.NshMdType1StateAugmentBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.VppNsh;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshEntriesBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.entries.NshEntry;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.entries.NshEntryBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.entries.NshEntryKey;
  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 nsh entry read.<br> to VPP.
  57  */
  58 public class NshEntryReaderCustomizer extends FutureJVppNshCustomizer
  59         implements InitializingListReaderCustomizer<NshEntry, NshEntryKey, NshEntryBuilder>, JvppReplyConsumer {
  60
  61     private static final Logger LOG = LoggerFactory.getLogger(NshEntryReaderCustomizer.class);
  62     private final NamingContext nshEntryContext;
  63
  64     public NshEntryReaderCustomizer(@Nonnull final FutureJVppNsh futureJVppNsh,
  65                                     @Nonnull final NamingContext nshEntryContext) {
  66         super(futureJVppNsh);
  67         this.nshEntryContext = checkNotNull(nshEntryContext, "nshEntryContext should not be null");
  68     }
  69
  70     @Override
  71     public void merge(@Nonnull final Builder<? extends DataObject> builder,
  72                       @Nonnull final List<NshEntry> readData) {
  73         ((NshEntriesBuilder) builder).setNshEntry(readData);
  74     }
  75
  76     @Nonnull
  77     @Override
  78     public NshEntryBuilder getBuilder(@Nonnull final InstanceIdentifier<NshEntry> id) {
  79         return new NshEntryBuilder();
  80     }
  81
  82     private void setNshEntryMdType1Augment(@Nonnull final NshEntryBuilder builder,
  83                                            @Nonnull NshEntryDetails nshEntryDetails) {
  84         final NshMdType1StateAugmentBuilder augmentBuilder = new NshMdType1StateAugmentBuilder();
  85         augmentBuilder.setC1((long) nshEntryDetails.c1);
  86         augmentBuilder.setC2((long) nshEntryDetails.c2);
  87         augmentBuilder.setC3((long) nshEntryDetails.c3);
  88         augmentBuilder.setC4((long) nshEntryDetails.c4);
  89
  90         builder.addAugmentation(NshMdType1StateAugment.class, augmentBuilder.build());
  91     }
  92
  93     @Override
  94     public void readCurrentAttributes(@Nonnull final InstanceIdentifier<NshEntry> id,
  95                                       @Nonnull final NshEntryBuilder builder, @Nonnull final ReadContext ctx)
  96             throws ReadFailedException {
  97         LOG.debug("Reading attributes for nsh entry: {}", id);
  98         final NshEntryKey key = id.firstKeyOf(NshEntry.class);
  99         checkArgument(key != null, "could not find NshEntry key in {}", id);
 100         final NshEntryDump request = new NshEntryDump();
 101
 102         final String entryName = key.getName();
 103         if (!nshEntryContext.containsIndex(entryName, ctx.getMappingContext())) {
 104             LOG.debug("Could not find nsh entry {} in the naming context", entryName);
 105             return;
 106         }
 107         request.entryIndex = nshEntryContext.getIndex(entryName, ctx.getMappingContext());
 108
 109         final CompletionStage<NshEntryDetailsReplyDump> nshEntryDetailsReplyDumpCompletionStage =
 110                 getFutureJVppNsh().nshEntryDump(request);
 111         final NshEntryDetailsReplyDump reply =
 112                 getReplyForRead(nshEntryDetailsReplyDumpCompletionStage.toCompletableFuture(), id);
 113
 114         if (reply == null || reply.nshEntryDetails == null || reply.nshEntryDetails.isEmpty()) {
 115             LOG.debug("Has no Nsh Entry {} in VPP. ", key.getName());
 116             return;
 117         }
 118
 119         LOG.trace("Nsh Entry : {} attributes returned from VPP: {}", key.getName(), reply);
 120
 121         final NshEntryDetails nshEntryDetails = reply.nshEntryDetails.get(0);
 122         builder.setName(entryName);
 123         builder.setKey(key);
 124         builder.setVersion((short) nshEntryDetails.verOC);
 125         builder.setLength((short) nshEntryDetails.length);
 126
 127         switch (nshEntryDetails.nextProtocol) {
 128             case 1:
 129                 builder.setNextProtocol(Ipv4.class);
 130                 break;
 131             case 2:
 132                 builder.setNextProtocol(Ipv6.class);
 133                 break;
 134             case 3:
 135                 builder.setNextProtocol(Ethernet.class);
 136                 break;
 137             default:
 138                 LOG.trace("Unsupported next protocol for nsh entry: {}", nshEntryDetails.nextProtocol);
 139                 return;
 140         }
 141
 142         switch (nshEntryDetails.mdType) {
 143             case 1: {
 144                 builder.setMdType(MdType1.class);
 145                 setNshEntryMdType1Augment(builder, nshEntryDetails);
 146                 break;
 147             }
 148             case 2: {
 149                 builder.setMdType(MdType1.class);
 150                 break;
 151             }
 152             default:
 153                 LOG.trace("Unsupported Mdtype for nsh entry: {}", nshEntryDetails.mdType);
 154                 return;
 155         }
 156
 157         builder.setNsp((long) ((nshEntryDetails.nspNsi >> 8) & 0xFFFFFF));
 158         builder.setNsi((short) (nshEntryDetails.nspNsi & 0xFF));
 159
 160         if (LOG.isTraceEnabled()) {
 161             LOG.trace("Attributes for nsh entry {} successfully read: {}", id, builder.build());
 162         }
 163     }
 164
 165     @Nonnull
 166     @Override
 167     public List<NshEntryKey> getAllIds(@Nonnull final InstanceIdentifier<NshEntry> id,
 168                                        @Nonnull final ReadContext context) throws ReadFailedException {
 169         LOG.debug("Reading list of keys for nsh entry: {}", id);
 170
 171         final NshEntryDump request = new NshEntryDump();
 172         request.entryIndex = -1; // dump call
 173
 174         NshEntryDetailsReplyDump reply;
 175         try {
 176             reply = getFutureJVppNsh().nshEntryDump(request).toCompletableFuture().get();
 177         } catch (Exception e) {
 178             throw new IllegalStateException("Nsh Entry dump failed", e);
 179         }
 180
 181         if (reply == null || reply.nshEntryDetails == null) {
 182             return Collections.emptyList();
 183         }
 184
 185         final int nIdsLength = reply.nshEntryDetails.size();
 186         LOG.debug("vppstate.NshEntryCustomizer.getAllIds: nIds.length={}", nIdsLength);
 187         if (nIdsLength == 0) {
 188             return Collections.emptyList();
 189         }
 190
 191         final List<NshEntryKey> allIds = new ArrayList<>(nIdsLength);
 192         for (NshEntryDetails detail : reply.nshEntryDetails) {
 193             final String nshName = nshEntryContext.getName(detail.entryIndex, context.getMappingContext());
 194             LOG.debug("vppstate.NshEntryCustomizer.getAllIds: nName={}", nshName);
 195             allIds.add(new NshEntryKey(nshName));
 196         }
 197
 198         return allIds;
 199     }
 200
 201     @Override
 202     public Initialized<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.nsh.entries.NshEntry> init(
 203             @Nonnull final InstanceIdentifier<NshEntry> id, @Nonnull final NshEntry readValue,
 204             @Nonnull final ReadContext ctx) {
 205         return Initialized.create(
 206                 InstanceIdentifier.create(VppNsh.class).child(
 207                         org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.NshEntries.class).child(
 208                         org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.nsh.entries.NshEntry.class,
 209                         new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.nsh.entries.NshEntryKey(id.firstKeyOf(NshEntry.class).getName())),
 210                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.nsh.entries.NshEntryBuilder(readValue)
 211                         .setName(readValue.getName())
 212                         .build());
 213     }
 214 }