summaryrefslogtreecommitdiffstats
path: root/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/RewriteCustomizer.java
blob: ebaad456b5d5e2ee0b9c1a65490e6de0b50636d4 (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
/*
 * 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.interfaces;

import static io.fd.honeycomb.translate.v3po.util.TranslateUtils.booleanToByte;

import com.google.common.base.Preconditions;
import io.fd.honeycomb.translate.spi.write.WriterCustomizer;
import io.fd.honeycomb.translate.v3po.util.FutureJVppCustomizer;
import io.fd.honeycomb.translate.v3po.util.NamingContext;
import io.fd.honeycomb.translate.v3po.util.SubInterfaceUtils;
import io.fd.honeycomb.translate.v3po.util.TagRewriteOperation;
import io.fd.honeycomb.translate.v3po.util.TranslateUtils;
import io.fd.honeycomb.translate.v3po.util.WriteTimeoutException;
import io.fd.honeycomb.translate.write.WriteContext;
import io.fd.honeycomb.translate.write.WriteFailedException;
import java.util.List;
import java.util.concurrent.CompletionStage;
import javax.annotation.Nonnull;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527._802dot1q;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.interfaces._interface.sub.interfaces.SubInterface;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.base.attributes.l2.Rewrite;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.base.attributes.l2.RewriteBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.tag.rewrite.PushTags;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.openvpp.jvpp.VppBaseCallException;
import org.openvpp.jvpp.core.dto.L2InterfaceVlanTagRewrite;
import org.openvpp.jvpp.core.dto.L2InterfaceVlanTagRewriteReply;
import org.openvpp.jvpp.core.future.FutureJVppCore;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Writer Customizer responsible for vlan tag rewrite.<br> Sends {@code l2_interface_vlan_tag_rewrite} message to
 * VPP.<br> Equivalent of invoking {@code vppctl set interface l2 tag-rewrite} command.
 */
public class RewriteCustomizer extends FutureJVppCustomizer implements WriterCustomizer<Rewrite> {

    private static final Logger LOG = LoggerFactory.getLogger(RewriteCustomizer.class);
    private final NamingContext interfaceContext;

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

    @Override
    public void writeCurrentAttributes(final InstanceIdentifier<Rewrite> id, final Rewrite dataAfter,
                                       final WriteContext writeContext)
            throws WriteFailedException {
        final String subifName = getSubInterfaceName(id);
        try {
            setTagRewrite(id, subifName, dataAfter, writeContext);
        } catch (VppBaseCallException e) {
            LOG.warn("Failed to write interface {}(id=): {}", subifName, writeContext, dataAfter);
            throw new WriteFailedException.CreateFailedException(id, dataAfter, e);
        }
    }

    private static String getSubInterfaceName(final InstanceIdentifier<Rewrite> id) {
        return SubInterfaceUtils.getSubInterfaceName(id.firstKeyOf(Interface.class).getName(),
                Math.toIntExact(id.firstKeyOf(SubInterface.class).getIdentifier()));
    }

    private void setTagRewrite(final InstanceIdentifier<Rewrite> id, final String ifname, final Rewrite rewrite,
                               final WriteContext writeContext)
        throws VppBaseCallException, WriteTimeoutException {
        final int swIfIndex = interfaceContext.getIndex(ifname, writeContext.getMappingContext());
        LOG.debug("Setting tag rewrite for interface {}(id=): {}", ifname, swIfIndex, rewrite);

        final CompletionStage<L2InterfaceVlanTagRewriteReply> replyCompletionStage =
                getFutureJVpp().l2InterfaceVlanTagRewrite(getTagRewriteRequest(swIfIndex, rewrite));

        TranslateUtils.getReplyForWrite(replyCompletionStage.toCompletableFuture(), id);
        LOG.debug("Tag rewrite for interface {}(id=) set successfully: {}", ifname, swIfIndex, rewrite);
    }

    private L2InterfaceVlanTagRewrite getTagRewriteRequest(final int swIfIndex, final Rewrite rewrite) {
        final L2InterfaceVlanTagRewrite request = new L2InterfaceVlanTagRewrite();
        request.swIfIndex = swIfIndex;
        request.pushDot1Q = booleanToByte(_802dot1q.class == rewrite.getVlanType());

        final List<PushTags> pushTags = rewrite.getPushTags();
        final Short popTags = rewrite.getPopTags();

        final int numberOfTagsToPop = popTags == null
                ? 0
                : popTags.intValue();
        final int numberOfTagsToPush = pushTags == null
                ? 0
                : pushTags.size();

        request.vtrOp = TagRewriteOperation.get(numberOfTagsToPop, numberOfTagsToPush).ordinal();

        if (numberOfTagsToPush > 0) {
            for (final PushTags tag : pushTags) {
                if (tag.getIndex() == 0) {
                    request.tag1 = tag.getDot1qTag().getVlanId().getValue();
                } else {
                    request.tag2 = tag.getDot1qTag().getVlanId().getValue();
                }
            }
        }

        LOG.debug("Generated tag rewrite request: {}", request);
        return request;
    }

    @Override
    public void updateCurrentAttributes(@Nonnull final InstanceIdentifier<Rewrite> id,
                                        @Nonnull final Rewrite dataBefore,
                                        @Nonnull final Rewrite dataAfter, @Nonnull final WriteContext writeContext)
            throws WriteFailedException {
        final String subifName = getSubInterfaceName(id);
        try {
            setTagRewrite(id, subifName, dataAfter, writeContext);
        } catch (VppBaseCallException e) {
            LOG.warn("Failed to update interface {}(id=): {}", subifName, writeContext, dataAfter);
            throw new WriteFailedException.UpdateFailedException(id, dataBefore, dataAfter, e);
        }
    }

    @Override
    public void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<Rewrite> id,
                                        @Nonnull final Rewrite dataBefore, @Nonnull final WriteContext writeContext)
            throws WriteFailedException {
        final String subifName = getSubInterfaceName(id);
        try {
            LOG.debug("Disabling tag rewrite for interface {}", subifName);
            final Rewrite rewrite = new RewriteBuilder().build(); // rewrite without push and pops will cause delete
            setTagRewrite(id, subifName, rewrite, writeContext);
        } catch (VppBaseCallException e) {
            LOG.warn("Failed to delete interface {}(id=): {}", subifName, writeContext, dataBefore);
            throw new WriteFailedException.DeleteFailedException(id, e);
        }
    }
}