summaryrefslogtreecommitdiffstats
path: root/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/read/VhostUserCustomizer.java
blob: fb348ce4e622437c767b027d649effa2500868fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.fd.hc2vpp.v3po.read;

import static java.lang.String.format;

import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
import io.fd.hc2vpp.common.translate.util.NamingContext;
import io.fd.hc2vpp.v3po.read.cache.InterfaceCacheDumpManager;
import io.fd.honeycomb.translate.read.ReadContext;
import io.fd.honeycomb.translate.read.ReadFailedException;
import io.fd.honeycomb.translate.spi.read.Initialized;
import io.fd.honeycomb.translate.spi.read.InitializingReaderCustomizer;
import io.fd.honeycomb.translate.util.RWUtils;
import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
import io.fd.honeycomb.translate.util.read.cache.StaticCacheKeyFactory;
import io.fd.jvpp.core.dto.SwInterfaceDetails;
import io.fd.jvpp.core.dto.SwInterfaceVhostUserDetails;
import io.fd.jvpp.core.dto.SwInterfaceVhostUserDetailsReplyDump;
import io.fd.jvpp.core.dto.SwInterfaceVhostUserDump;
import io.fd.jvpp.core.future.FutureJVppCore;
import java.math.BigInteger;
import java.util.concurrent.CompletionStage;
import javax.annotation.Nonnull;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.v3po.rev190527.VhostUserRole;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.v3po.rev190527.VppInterfaceAugmentation;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.v3po.rev190527.VppInterfaceAugmentationBuilder;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.v3po.rev190527.interfaces._interface.VhostUser;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.v3po.rev190527.interfaces._interface.VhostUserBuilder;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.interfaces.Interface;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.interfaces.InterfaceKey;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class VhostUserCustomizer implements InitializingReaderCustomizer<VhostUser, VhostUserBuilder>,
        InterfaceDataTranslator, JvppReplyConsumer {

    private static final Logger LOG = LoggerFactory.getLogger(VhostUserCustomizer.class);
    private NamingContext interfaceContext;
    private final InterfaceCacheDumpManager dumpManager;
    private final DumpCacheManager<SwInterfaceVhostUserDetailsReplyDump, Void> vhostDumpManager;

    public VhostUserCustomizer(@Nonnull final FutureJVppCore jvpp,
                               @Nonnull final NamingContext interfaceContext,
                               @Nonnull final InterfaceCacheDumpManager dumpManager) {
        this.interfaceContext = interfaceContext;
        this.dumpManager = dumpManager;
        this.vhostDumpManager =
                new DumpCacheManager.DumpCacheManagerBuilder<SwInterfaceVhostUserDetailsReplyDump, Void>()
                        .withCacheKeyFactory(new StaticCacheKeyFactory(VhostUserCustomizer.class.getName() + "_dump",
                                SwInterfaceVhostUserDetailsReplyDump.class))
                        .withExecutor((identifier, params) -> {
                            final CompletionStage<SwInterfaceVhostUserDetailsReplyDump>
                                    swInterfaceVhostUserDetailsReplyDumpCompletionStage =
                                    jvpp.swInterfaceVhostUserDump(new SwInterfaceVhostUserDump());
                            return getReplyForRead(
                                    swInterfaceVhostUserDetailsReplyDumpCompletionStage.toCompletableFuture(),
                                    identifier);
                        }).build();
    }

    @Override
    public void merge(@Nonnull Builder<? extends DataObject> parentBuilder, @Nonnull VhostUser readValue) {
        ((VppInterfaceAugmentationBuilder) parentBuilder).setVhostUser(readValue);
    }

    @Nonnull
    @Override
    public VhostUserBuilder getBuilder(@Nonnull InstanceIdentifier<VhostUser> id) {
        return new VhostUserBuilder();
    }

    @Override
    public void readCurrentAttributes(@Nonnull final InstanceIdentifier<VhostUser> id,
                                      @Nonnull final VhostUserBuilder builder,
                                      @Nonnull final ReadContext ctx) throws ReadFailedException {

        final InterfaceKey key = id.firstKeyOf(Interface.class);
        final int index = interfaceContext.getIndex(key.getName(), ctx.getMappingContext());
        final SwInterfaceDetails ifcDetails = dumpManager.getInterfaceDetail(id, ctx, key.getName());


        if (!isInterfaceOfType(
                org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.v3po.rev190527.VhostUser.class,
                ifcDetails)) {
            return;
        }

        LOG.debug("Reading attributes for vhpost user interface: {}", key.getName());


        final SwInterfaceVhostUserDetailsReplyDump dump =
                vhostDumpManager.getDump(id, ctx.getModificationCache())
                        .orElse(new SwInterfaceVhostUserDetailsReplyDump());

        // Relying here that parent InterfaceCustomizer was invoked first to fill in the context with initial ifc mapping
        final SwInterfaceVhostUserDetails swInterfaceVhostUserDetails = dump.swInterfaceVhostUserDetails.stream()
                .filter(detail -> detail.swIfIndex == index)
                .findFirst()
                .orElseThrow(() -> new IllegalArgumentException(
                        format("Vhost user for interface %s not found", key.getName())));
        LOG.trace("Vhost user interface: {} attributes returned from VPP: {}", key.getName(),
                swInterfaceVhostUserDetails);

        builder.setRole(swInterfaceVhostUserDetails.isServer == 1
                ? VhostUserRole.Server
                : VhostUserRole.Client);
        builder.setFeatures(BigInteger.valueOf(swInterfaceVhostUserDetails.features));
        builder.setNumMemoryRegions((long) swInterfaceVhostUserDetails.numRegions);
        builder.setSocket(toString(swInterfaceVhostUserDetails.sockFilename));
        builder.setVirtioNetHdrSize((long) swInterfaceVhostUserDetails.virtioNetHdrSz);
        // TODO: map error code to meaningful message after VPP-436 is done
        builder.setConnectError(Integer.toString(swInterfaceVhostUserDetails.sockErrno));
        if (ifcDetails.tag[0] != 0) { // tag supplied
            builder.setTag(toString(ifcDetails.tag));
        }

        LOG.debug("Vhost user interface: {}, id: {} attributes read as: {}", key.getName(), index, builder);
    }

    @Override
    public Initialized<VhostUser> init(@Nonnull final InstanceIdentifier<VhostUser> id,
                                       @Nonnull final VhostUser readValue, @Nonnull final ReadContext ctx) {
        // The tag is set from interface details, those details are retrieved from cache
        final InterfaceKey key = id.firstKeyOf(Interface.class);
        final SwInterfaceDetails ifcDetails;
        try {
            ifcDetails = dumpManager.getInterfaceDetail(id, ctx, key.getName());
        } catch (ReadFailedException e) {
            throw new IllegalStateException(format("Unable to find VHost interface %s", key.getName()), e);
        }
        return Initialized.create(getCfgId(id),
                new VhostUserBuilder()
                        .setRole(readValue.getRole())
                        .setSocket(readValue.getSocket())
                        .setTag(ifcDetails.tag[0] == 0
                                ? null
                                : toString(ifcDetails.tag))
                        .build());
    }

    private InstanceIdentifier<VhostUser> getCfgId(final InstanceIdentifier<VhostUser> id) {
        return InterfaceCustomizer.getCfgId(RWUtils.cutId(id, Interface.class))
                .augmentation(VppInterfaceAugmentation.class)
                .child(VhostUser.class);
    }
}