gerrit.fd Code Review - hc2vpp.git/blob

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 package io.fd.honeycomb.v3po.translate.v3po.interfacesstate;
  18
  19 import static com.google.common.base.Preconditions.checkState;
  20
  21 import com.google.common.base.Preconditions;
  22 import io.fd.honeycomb.v3po.translate.read.ReadContext;
  23 import io.fd.honeycomb.v3po.translate.read.ReadFailedException;
  24 import io.fd.honeycomb.v3po.translate.spi.read.ReaderCustomizer;
  25 import io.fd.honeycomb.v3po.translate.v3po.util.FutureJVppCustomizer;
  26 import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext;
  27 import io.fd.honeycomb.v3po.translate.v3po.util.SubInterfaceUtils;
  28 import io.fd.honeycomb.v3po.translate.v3po.util.TagRewriteOperation;
  29 import java.util.ArrayList;
  30 import java.util.List;
  31 import javax.annotation.Nonnull;
  32 import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.ieee.params.xml.ns.yang.dot1q.types.rev150626.CVlan;
  34 import org.opendaylight.yang.gen.v1.urn.ieee.params.xml.ns.yang.dot1q.types.rev150626.Dot1qTagVlanType;
  35 import org.opendaylight.yang.gen.v1.urn.ieee.params.xml.ns.yang.dot1q.types.rev150626.Dot1qVlanId;
  36 import org.opendaylight.yang.gen.v1.urn.ieee.params.xml.ns.yang.dot1q.types.rev150626.SVlan;
  37 import org.opendaylight.yang.gen.v1.urn.ieee.params.xml.ns.yang.dot1q.types.rev150626.dot1q.tag.Dot1qTagBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527._802dot1ad;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527._802dot1q;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.interfaces.state._interface.sub.interfaces.SubInterface;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.base.attributes.L2Builder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.base.attributes.l2.Rewrite;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.base.attributes.l2.RewriteBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.tag.rewrite.PushTags;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.tag.rewrite.PushTagsBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.tag.rewrite.PushTagsKey;
  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.openvpp.jvpp.dto.SwInterfaceDetails;
  52 import org.openvpp.jvpp.future.FutureJVpp;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 /**
  57  * Customizer for reading vlan tag-rewrite configuration state form the VPP.
  58  */
  59 public class RewriteCustomizer extends FutureJVppCustomizer
  60         implements ReaderCustomizer<Rewrite, RewriteBuilder> {
  61
  62     private static final Logger LOG = LoggerFactory.getLogger(RewriteCustomizer.class);
  63     private final NamingContext interfaceContext;
  64
  65     public RewriteCustomizer(@Nonnull final FutureJVpp futureJvpp,
  66                              @Nonnull final NamingContext interfaceContext) {
  67         super(futureJvpp);
  68         this.interfaceContext = Preconditions.checkNotNull(interfaceContext, "interfaceContext should not be null");
  69     }
  70
  71     @Override
  72     public void merge(@Nonnull final Builder<? extends DataObject> parentBuilder,
  73                       @Nonnull final Rewrite readValue) {
  74         ((L2Builder) parentBuilder).setRewrite(readValue);
  75     }
  76
  77     @Nonnull
  78     @Override
  79     public RewriteBuilder getBuilder(@Nonnull final InstanceIdentifier<Rewrite> id) {
  80         return new RewriteBuilder();
  81     }
  82
  83     @Override
  84     public void readCurrentAttributes(@Nonnull final InstanceIdentifier<Rewrite> id,
  85                                       @Nonnull final RewriteBuilder builder, @Nonnull final ReadContext ctx)
  86             throws ReadFailedException {
  87         final String subInterfaceName = getSubInterfaceName(id);
  88         LOG.debug("Reading attributes for sub interface: {}", subInterfaceName);
  89
  90         final SwInterfaceDetails iface = InterfaceUtils.getVppInterfaceDetails(getFutureJVpp(), id, subInterfaceName,
  91                 interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext()), ctx.getModificationCache());
  92         LOG.debug("VPP sub-interface details: {}", ReflectionToStringBuilder.toString(iface));
  93
  94         checkState(iface.subId != 0, "Interface returned by the VPP is not a sub-interface");
  95
  96         final TagRewriteOperation operation = TagRewriteOperation.get(iface.vtrOp);
  97         if (TagRewriteOperation.disabled == operation) {
  98             LOG.debug("Tag rewrite operation is disabled for ");
  99             return;
 100         }
 101
 102         builder.setVlanType(iface.vtrPushDot1Q == 1
 103                 ? _802dot1q.class
 104                 : _802dot1ad.class);
 105
 106         setPushTags(builder, iface);
 107         setPopTags(builder, operation);
 108     }
 109
 110     private static String getSubInterfaceName(final InstanceIdentifier<Rewrite> id) {
 111         return SubInterfaceUtils.getSubInterfaceName(id.firstKeyOf(Interface.class).getName(),
 112                 Math.toIntExact(id.firstKeyOf(SubInterface.class).getIdentifier()));
 113     }
 114
 115     private void setPopTags(final RewriteBuilder builder, final TagRewriteOperation operation) {
 116         final byte numberOfTagsToPop = operation.getPopTags();
 117         if (numberOfTagsToPop != 0) {
 118             builder.setPopTags(Short.valueOf(numberOfTagsToPop));
 119         }
 120     }
 121
 122     private void setPushTags(final RewriteBuilder builder, final SwInterfaceDetails iface) {
 123         final List<PushTags> tags = new ArrayList<>();
 124         if (iface.vtrTag1 != 0) {
 125             tags.add(buildTag((short) 0, SVlan.class, iface.vtrTag1));
 126         }
 127         if (iface.vtrTag2 != 0) {
 128             tags.add(buildTag((short) 1, CVlan.class, iface.vtrTag2));
 129         }
 130         if (tags.size() > 0) {
 131             builder.setPushTags(tags);
 132         }
 133     }
 134
 135     private PushTags buildTag(final short index, final Class<? extends Dot1qTagVlanType> tagType, final int vlanId) {
 136         final PushTagsBuilder tag = new PushTagsBuilder();
 137         tag.setIndex(index);
 138         tag.setKey(new PushTagsKey(index));
 139         final Dot1qTagBuilder dtag = new Dot1qTagBuilder();
 140         dtag.setTagType(tagType);
 141         dtag.setVlanId(new Dot1qVlanId(vlanId));
 142         tag.setDot1qTag(dtag.build());
 143         return tag.build();
 144     }
 145 }