2 * Copyright (c) 2016 Intel and/or its affiliates.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 package io.fd.honeycomb.vppnsh.impl.oper;
19 import static com.google.common.base.Preconditions.checkArgument;
20 import static com.google.common.base.Preconditions.checkNotNull;
21 import static com.google.common.base.Preconditions.checkState;
23 import io.fd.honeycomb.translate.read.ReadContext;
24 import io.fd.honeycomb.translate.read.ReadFailedException;
25 import io.fd.honeycomb.translate.spi.read.Initialized;
26 import io.fd.honeycomb.translate.spi.read.InitializingListReaderCustomizer;
27 import io.fd.honeycomb.translate.vpp.util.JvppReplyConsumer;
28 import io.fd.honeycomb.translate.vpp.util.NamingContext;
29 import io.fd.honeycomb.vppnsh.impl.util.FutureJVppNshCustomizer;
30 import io.fd.vpp.jvpp.nsh.dto.NshMapDetails;
31 import io.fd.vpp.jvpp.nsh.dto.NshMapDetailsReplyDump;
32 import io.fd.vpp.jvpp.nsh.dto.NshMapDump;
33 import io.fd.vpp.jvpp.nsh.future.FutureJVppNsh;
34 import java.util.ArrayList;
35 import java.util.Collections;
36 import java.util.List;
37 import java.util.concurrent.CompletionStage;
38 import javax.annotation.Nonnull;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.Pop;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.Push;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.Swap;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.VppNsh;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.VxlanGpe;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshMapsBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.maps.NshMap;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.maps.NshMapBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.maps.NshMapKey;
48 import org.opendaylight.yangtools.concepts.Builder;
49 import org.opendaylight.yangtools.yang.binding.DataObject;
50 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
51 import org.slf4j.Logger;
52 import org.slf4j.LoggerFactory;
55 * Reader customizer responsible for nsh map read.<br> to VPP.
57 public class NshMapReaderCustomizer extends FutureJVppNshCustomizer
58 implements InitializingListReaderCustomizer<NshMap, NshMapKey, NshMapBuilder>, JvppReplyConsumer {
60 private static final Logger LOG = LoggerFactory.getLogger(NshMapReaderCustomizer.class);
61 private final NamingContext nshMapContext;
62 private final NamingContext interfaceContext;
64 public NshMapReaderCustomizer(@Nonnull final FutureJVppNsh futureJVppNsh,
65 @Nonnull final NamingContext nshMapContext,
66 @Nonnull final NamingContext interfaceContext) {
68 this.nshMapContext = checkNotNull(nshMapContext, "nshMapContext should not be null");
69 this.interfaceContext = checkNotNull(interfaceContext, "interfaceContext should not be null");
74 public void merge(@Nonnull final Builder<? extends DataObject> builder,
75 @Nonnull final List<NshMap> readData) {
76 ((NshMapsBuilder) builder).setNshMap(readData);
81 public NshMapBuilder getBuilder(@Nonnull final InstanceIdentifier<NshMap> id) {
82 return new NshMapBuilder();
86 public void readCurrentAttributes(@Nonnull final InstanceIdentifier<NshMap> id,
87 @Nonnull final NshMapBuilder builder, @Nonnull final ReadContext ctx)
88 throws ReadFailedException {
89 LOG.debug("Reading attributes for nsh map: {}", id);
90 final NshMapKey key = id.firstKeyOf(NshMap.class);
91 checkArgument(key != null, "could not find NshMap key in {}", id);
92 final NshMapDump request = new NshMapDump();
94 final String mapName = key.getName();
95 if (!nshMapContext.containsIndex(mapName, ctx.getMappingContext())) {
96 LOG.debug("Could not find nsh map {} in the naming context", mapName);
99 request.mapIndex = nshMapContext.getIndex(mapName, ctx.getMappingContext());
101 final CompletionStage<NshMapDetailsReplyDump> nshMapDetailsReplyDumpCompletionStage =
102 getFutureJVppNsh().nshMapDump(request);
103 final NshMapDetailsReplyDump reply =
104 getReplyForRead(nshMapDetailsReplyDumpCompletionStage.toCompletableFuture(), id);
106 if (reply == null || reply.nshMapDetails == null || reply.nshMapDetails.isEmpty()) {
107 LOG.debug("Has no Nsh Map {} in VPP. ", key.getName());
111 LOG.trace("Nsh Map : {} attributes returned from VPP: {}", key.getName(), reply);
113 final NshMapDetails nshMapDetails = reply.nshMapDetails.get(0);
114 builder.setName(mapName);
117 builder.setNsp((long) ((nshMapDetails.nspNsi >> 8) & 0xFFFFFF));
118 builder.setNsi((short) (nshMapDetails.nspNsi & 0xFF));
120 builder.setMappedNsp((long) ((nshMapDetails.mappedNspNsi >> 8) & 0xFFFFFF));
121 builder.setMappedNsi((short) (nshMapDetails.mappedNspNsi & 0xFF));
123 switch (nshMapDetails.nshAction) {
125 builder.setNshAction(Swap.class);
128 builder.setNshAction(Push.class);
131 builder.setNshAction(Pop.class);
134 LOG.trace("Unsupported nsh_action for nsh map: {}", nshMapDetails.nshAction);
138 switch (nshMapDetails.nextNode) {
140 builder.setEncapType(VxlanGpe.class);
143 LOG.trace("Unsupported encap type for nsh map: {}", nshMapDetails.nextNode);
147 checkState(interfaceContext.containsName(nshMapDetails.swIfIndex, ctx.getMappingContext()),
148 "Mapping does not contains mapping for provider interface Index ");
149 final String interfaceName = interfaceContext.getName(nshMapDetails.swIfIndex, ctx.getMappingContext());
150 builder.setEncapIfName(interfaceName);
152 if (LOG.isTraceEnabled()) {
153 LOG.trace("Attributes for nsh map {} successfully read: {}", id, builder.build());
159 public List<NshMapKey> getAllIds(@Nonnull final InstanceIdentifier<NshMap> id,
160 @Nonnull final ReadContext context) throws ReadFailedException {
161 LOG.debug("Reading list of keys for nsh map: {}", id);
163 final NshMapDump request = new NshMapDump();
164 request.mapIndex = -1; // dump call
166 NshMapDetailsReplyDump reply;
168 reply = getFutureJVppNsh().nshMapDump(request).toCompletableFuture().get();
169 } catch (Exception e) {
170 throw new IllegalStateException("Nsh Map dump failed", e);
173 if (reply == null || reply.nshMapDetails == null) {
174 return Collections.emptyList();
177 final int nIdsLength = reply.nshMapDetails.size();
178 LOG.debug("vppstate.NshMapCustomizer.getAllIds: nIds.length={}", nIdsLength);
179 if (nIdsLength == 0) {
180 return Collections.emptyList();
183 final List<NshMapKey> allIds = new ArrayList<>(nIdsLength);
184 for (NshMapDetails detail : reply.nshMapDetails) {
185 final String nshName = nshMapContext.getName(detail.mapIndex, context.getMappingContext());
186 LOG.debug("vppstate.NshMapCustomizer.getAllIds: nName={}", nshName);
187 allIds.add(new NshMapKey(nshName));
194 public Initialized<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.nsh.maps.NshMap> init(
195 @Nonnull final InstanceIdentifier<NshMap> id,
196 @Nonnull final NshMap readValue,
197 @Nonnull final ReadContext ctx) {
198 return Initialized.create(
199 InstanceIdentifier.create(VppNsh.class).child(
200 org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.NshMaps.class).child(
201 org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.nsh.maps.NshMap.class,
202 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.nsh.maps.NshMapKey(id.firstKeyOf(NshMap.class).getName())),
203 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.nsh.maps.NshMapBuilder(readValue).setName(readValue.getName()).build());