HONEYCOMB-48: vlan tag rewrite support

Change-Id: Id20aa699db1fd48b253b3abb1b4341e779a9b98f
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>

2 files changed, 231 insertions, 0 deletions

diff --git a/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/v3po/translate/v3po/interfaces/VlanTagRewriteCustomizer.java b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/v3po/translate/v3po/interfaces/VlanTagRewriteCustomizer.java
new file mode 100644
index 000000000..7e7e319eb
--- /dev/null
+++ b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/v3po/translate/v3po/interfaces/VlanTagRewriteCustomizer.java
@@ -0,0 +1,143 @@
+/*
+ * 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.v3po.translate.v3po.interfaces;
+
+import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
+import io.fd.honeycomb.v3po.translate.spi.write.ChildWriterCustomizer;
+import io.fd.honeycomb.v3po.translate.v3po.util.FutureJVppCustomizer;
+import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext;
+import io.fd.honeycomb.v3po.translate.v3po.util.VppApiInvocationException;
+import io.fd.honeycomb.v3po.translate.v3po.utils.V3poUtils;
+import io.fd.honeycomb.v3po.translate.write.WriteContext;
+import io.fd.honeycomb.v3po.translate.write.WriteFailedException;
+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.v3po.rev150105.TagRewriteOperation;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VlanTag;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VlanType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.L2;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.l2.VlanTagRewrite;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.l2.VlanTagRewriteBuilder;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.openvpp.jvpp.dto.L2InterfaceVlanTagRewrite;
+import org.openvpp.jvpp.dto.L2InterfaceVlanTagRewriteReply;
+import org.openvpp.jvpp.future.FutureJVpp;
+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 VlanTagRewriteCustomizer extends FutureJVppCustomizer implements ChildWriterCustomizer<VlanTagRewrite> {
+
+    private static final Logger LOG = LoggerFactory.getLogger(VlanTagRewriteCustomizer.class);
+    private final NamingContext interfaceContext;
+
+    public VlanTagRewriteCustomizer(@Nonnull final FutureJVpp futureJvpp,
+                                    @Nonnull final NamingContext interfaceContext) {
+        super(futureJvpp);
+        this.interfaceContext = Preconditions.checkNotNull(interfaceContext, "interfaceContext should not be null");
+    }
+
+    @Nonnull
+    @Override
+    public Optional<VlanTagRewrite> extract(@Nonnull final InstanceIdentifier<VlanTagRewrite> currentId,
+                                            @Nonnull final DataObject parentData) {
+        return Optional.fromNullable(((L2) parentData).getVlanTagRewrite());
+    }
+
+    @Override
+    public void writeCurrentAttributes(@Nonnull final InstanceIdentifier<VlanTagRewrite> id,
+                                       @Nonnull final VlanTagRewrite dataAfter, @Nonnull final WriteContext writeContext)
+            throws WriteFailedException.CreateFailedException {
+        try {
+            setTagRewrite(id.firstKeyOf(Interface.class).getName(), dataAfter);
+        } catch (VppApiInvocationException e) {
+            throw new WriteFailedException.CreateFailedException(id, dataAfter, e);
+        }
+    }
+
+    private void setTagRewrite(final String ifname, final VlanTagRewrite cfg) throws VppApiInvocationException {
+        final int swIfIndex = interfaceContext.getIndex(ifname);
+        LOG.debug("Setting tag rewrite for interface {}(id=): {}", ifname, swIfIndex, cfg);
+
+        final CompletionStage<L2InterfaceVlanTagRewriteReply> replyCompletionStage =
+                getFutureJVpp().l2InterfaceVlanTagRewrite(getTagRewriteRequest(swIfIndex, cfg));
+
+        final L2InterfaceVlanTagRewriteReply reply = V3poUtils.getReply(replyCompletionStage.toCompletableFuture());
+        if (reply.retval < 0) {
+            LOG.debug("Failed to set tag rewrite for interface {}(id=): {}", ifname, swIfIndex, cfg);
+            throw new VppApiInvocationException("l2InterfaceVlanTagRewrite", reply.context, reply.retval);
+        } else {
+            LOG.debug("Tag rewrite for interface {}(id=) set successfully: {}", ifname, swIfIndex, cfg);
+        }
+    }
+
+    private L2InterfaceVlanTagRewrite getTagRewriteRequest(final int swIfIndex, final VlanTagRewrite cfg) {
+        final L2InterfaceVlanTagRewrite request = new L2InterfaceVlanTagRewrite();
+        request.swIfIndex = swIfIndex;
+
+        request.vtrOp = cfg.getRewriteOperation().getIntValue(); // TODO make mandatory
+        request.pushDot1Q = (byte) (VlanType._802dot1q.equals(cfg.getFirstPushed())
+                ? 1
+                : 0);
+        final VlanTag tag1 = cfg.getTag1();
+        if (tag1 != null) {
+            request.tag1 = tag1.getValue();
+        }
+        final VlanTag tag2 = cfg.getTag2();
+        if (tag2 != null) {
+            request.tag2 = tag2.getValue();
+        }
+        return request;
+    }
+
+    @Override
+    public void updateCurrentAttributes(@Nonnull final InstanceIdentifier<VlanTagRewrite> id,
+                                        @Nonnull final VlanTagRewrite dataBefore,
+                                        @Nonnull final VlanTagRewrite dataAfter, @Nonnull final WriteContext writeContext)
+            throws WriteFailedException {
+        if (dataBefore.equals(dataAfter)) {
+            LOG.debug("dataBefore equals dataAfter, update will not be performed");
+            return;
+        }
+        try {
+            setTagRewrite(id.firstKeyOf(Interface.class).getName(), dataAfter);
+        } catch (VppApiInvocationException e) {
+            throw new WriteFailedException.UpdateFailedException(id, dataBefore, dataAfter, e);
+        }
+    }
+
+    @Override
+    public void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<VlanTagRewrite> id,
+                                        @Nonnull final VlanTagRewrite dataBefore, @Nonnull final WriteContext writeContext)
+            throws WriteFailedException.DeleteFailedException {
+        try {
+            // disable tag rewrite
+            final VlanTagRewriteBuilder builder = new VlanTagRewriteBuilder();
+            builder.setRewriteOperation(TagRewriteOperation.Disabled);
+            setTagRewrite(id.firstKeyOf(Interface.class).getName(), builder.build());
+        } catch (VppApiInvocationException e) {
+            throw new WriteFailedException.DeleteFailedException(id, e);
+        }
+    }
+}
diff --git a/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/v3po/translate/v3po/interfacesstate/VlanTagRewriteCustomizer.java b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/v3po/translate/v3po/interfacesstate/VlanTagRewriteCustomizer.java
new file mode 100644
index 000000000..d7404e6d5
--- /dev/null
+++ b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/v3po/translate/v3po/interfacesstate/VlanTagRewriteCustomizer.java
@@ -0,0 +1,88 @@
+/*
+ * 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.v3po.translate.v3po.interfacesstate;
+
+import com.google.common.base.Preconditions;
+import io.fd.honeycomb.v3po.translate.Context;
+import io.fd.honeycomb.v3po.translate.read.ReadFailedException;
+import io.fd.honeycomb.v3po.translate.spi.read.ChildReaderCustomizer;
+import io.fd.honeycomb.v3po.translate.v3po.util.FutureJVppCustomizer;
+import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.TagRewriteOperation;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VlanTag;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VlanType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.L2Builder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.l2.VlanTagRewrite;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.l2.VlanTagRewriteBuilder;
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.openvpp.jvpp.dto.SwInterfaceDetails;
+import org.openvpp.jvpp.future.FutureJVpp;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Customizer for reading vlan tag-rewrite configuration state form the VPP.
+ */
+public class VlanTagRewriteCustomizer extends FutureJVppCustomizer
+        implements ChildReaderCustomizer<VlanTagRewrite, VlanTagRewriteBuilder> {
+
+    private static final Logger LOG = LoggerFactory.getLogger(SubInterfaceCustomizer.class);
+    private final NamingContext interfaceContext;
+
+    public VlanTagRewriteCustomizer(@Nonnull final FutureJVpp futureJvpp,
+                                    @Nonnull final NamingContext interfaceContext) {
+        super(futureJvpp);
+        this.interfaceContext = Preconditions.checkNotNull(interfaceContext, "interfaceContext should not be null");
+    }
+
+    @Override
+    public void merge(@Nonnull final Builder<? extends DataObject> parentBuilder,
+                      @Nonnull final VlanTagRewrite readValue) {
+        ((L2Builder) parentBuilder).setVlanTagRewrite(readValue);
+    }
+
+    @Nonnull
+    @Override
+    public VlanTagRewriteBuilder getBuilder(@Nonnull final InstanceIdentifier<VlanTagRewrite> id) {
+        return new VlanTagRewriteBuilder();
+    }
+
+    @Override
+    public void readCurrentAttributes(@Nonnull final InstanceIdentifier<VlanTagRewrite> id,
+                                      @Nonnull final VlanTagRewriteBuilder builder, @Nonnull final Context ctx)
+            throws ReadFailedException {
+        LOG.debug("Reading attributes for sub interface: {}", id);
+        final InterfaceKey key = id.firstKeyOf(Interface.class);
+
+        final SwInterfaceDetails iface = InterfaceUtils.getVppInterfaceDetails(getFutureJVpp(), key,
+                interfaceContext.getIndex(key.getName()), ctx);
+
+        builder.setFirstPushed(iface.subDot1Ad == 1 ? VlanType._802dot1q : VlanType._802dot1ad);
+        builder.setRewriteOperation(TagRewriteOperation.forValue(iface.vtrOp));
+        if (iface.vtrTag1 != 0) {
+            builder.setTag1(new VlanTag(iface.vtrTag1));
+        }
+        if (iface.vtrTag2 != 0) {
+            builder.setTag2(new VlanTag(iface.vtrTag2));
+        }
+    }
+}