summaryrefslogtreecommitdiffstats
path: root/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/vppclassifier/ClassifySessionWriter.java
blob: 8967dcf1e94edfd9bcb2510d3e5679ede60ce0a2 (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
/*
 * 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.honeycomb.translate.v3po.vppclassifier;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static io.fd.honeycomb.translate.v3po.util.TranslateUtils.booleanToByte;

import io.fd.honeycomb.translate.v3po.util.WriteTimeoutException;
import io.fd.honeycomb.translate.write.WriteContext;
import io.fd.honeycomb.translate.spi.write.ListWriterCustomizer;
import io.fd.honeycomb.translate.v3po.util.FutureJVppCustomizer;
import io.fd.honeycomb.translate.v3po.util.NamingContext;
import io.fd.honeycomb.translate.v3po.util.TranslateUtils;
import io.fd.honeycomb.translate.write.WriteFailedException;
import java.util.concurrent.CompletionStage;
import javax.annotation.Nonnull;
import javax.xml.bind.DatatypeConverter;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.OpaqueIndex;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.classify.table.base.attributes.ClassifySession;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.classify.table.base.attributes.ClassifySessionKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.vpp.classifier.ClassifyTable;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.vpp.classifier.ClassifyTableKey;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.openvpp.jvpp.VppBaseCallException;
import org.openvpp.jvpp.core.dto.ClassifyAddDelSession;
import org.openvpp.jvpp.core.dto.ClassifyAddDelSessionReply;
import org.openvpp.jvpp.core.future.FutureJVppCore;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Writer customizer responsible for classify session create/delete.<br> Sends {@code classify_add_del_session} message
 * to VPP.<br> Equivalent to invoking {@code vppctl classify table} command.
 */
public class ClassifySessionWriter extends FutureJVppCustomizer
    implements ListWriterCustomizer<ClassifySession, ClassifySessionKey> {

    private static final Logger LOG = LoggerFactory.getLogger(ClassifySessionWriter.class);
    private final NamingContext classifyTableContext;

    public ClassifySessionWriter(@Nonnull final FutureJVppCore futureJVppCore,
                                 @Nonnull final NamingContext classifyTableContext) {
        super(futureJVppCore);
        this.classifyTableContext = checkNotNull(classifyTableContext, "classifyTableContext should not be null");
    }

    @Override
    public void writeCurrentAttributes(@Nonnull final InstanceIdentifier<ClassifySession> id,
                                       @Nonnull final ClassifySession dataAfter,
                                       @Nonnull final WriteContext writeContext) throws WriteFailedException {
        LOG.debug("Creating classify session: iid={} dataAfter={}", id, dataAfter);
        try {
            classifyAddDelSession(true, id, dataAfter, writeContext);
            LOG.debug("Successfully created classify session: iid={} dataAfter={}", id, dataAfter);
        } catch (VppBaseCallException e) {
            throw new WriteFailedException.CreateFailedException(id, dataAfter, e);
        }
    }

    @Override
    public void updateCurrentAttributes(@Nonnull final InstanceIdentifier<ClassifySession> id,
                                        @Nonnull final ClassifySession dataBefore,
                                        @Nonnull final ClassifySession dataAfter,
                                        @Nonnull final WriteContext writeContext) throws WriteFailedException {
        throw new UnsupportedOperationException("Classify session update is not supported");
    }

    @Override
    public void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<ClassifySession> id,
                                        @Nonnull final ClassifySession dataBefore,
                                        @Nonnull final WriteContext writeContext) throws WriteFailedException {
        LOG.debug("Removing classify session: iid={} dataBefore={}", id, dataBefore);
        try {
            classifyAddDelSession(false, id, dataBefore, writeContext);
            LOG.debug("Successfully removed classify session: iid={} dataBefore={}", id, dataBefore);
        } catch (VppBaseCallException e) {
            throw new WriteFailedException.DeleteFailedException(id, e);
        }
    }

    private void classifyAddDelSession(final boolean isAdd, @Nonnull final InstanceIdentifier<ClassifySession> id,
                                       @Nonnull final ClassifySession classifySession,
                                       @Nonnull final WriteContext writeContext)
        throws VppBaseCallException, WriteTimeoutException {
        final ClassifyTableKey tableKey = id.firstKeyOf(ClassifyTable.class);
        checkArgument(tableKey != null, "could not find classify table key in {}", id);

        final String tableName = tableKey.getName();
        checkState(classifyTableContext.containsIndex(tableName, writeContext.getMappingContext()),
            "Could not find classify table index for {} in the classify table context", tableName);
        final int tableIndex = classifyTableContext.getIndex(tableName, writeContext.getMappingContext());

        final CompletionStage<ClassifyAddDelSessionReply> createClassifyTableReplyCompletionStage = getFutureJVpp()
            .classifyAddDelSession(
                getClassifyAddDelSessionRequest(isAdd, tableIndex, classifySession));

        TranslateUtils.getReplyForWrite(createClassifyTableReplyCompletionStage.toCompletableFuture(), id);
    }

    private static ClassifyAddDelSession getClassifyAddDelSessionRequest(final boolean isAdd, final int tableIndex,
                                                                         @Nonnull final ClassifySession classifySession) {
        ClassifyAddDelSession request = new ClassifyAddDelSession();
        request.isAdd = booleanToByte(isAdd);
        request.tableIndex = tableIndex;

        // mandatory:
        // TODO implement node name to index conversion after https://jira.fd.io/browse/VPP-203 is fixed
        request.hitNextIndex = classifySession.getHitNext().getPacketHandlingAction().getIntValue();

        if (classifySession.getOpaqueIndex() != null) {
            request.opaqueIndex = getOpaqueIndexValue(classifySession.getOpaqueIndex());
        } else {
            request.opaqueIndex = ~0; // value not specified
        }

        // default 0:
        request.advance = classifySession.getAdvance();

        request.match = DatatypeConverter.parseHexBinary(classifySession.getMatch().getValue().replace(":", ""));
        return request;
    }

    private static int getOpaqueIndexValue(@Nonnull final OpaqueIndex opaqueIndex) {
        if (opaqueIndex.getUint32() != null) {
            return opaqueIndex.getUint32().intValue();
        } else {
            // TODO: implement node name to index conversion after https://jira.fd.io/browse/VPP-203 is fixed
            return opaqueIndex.getVppNode().getPacketHandlingAction().getIntValue();
        }
    }
}