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.interfaces;
  18
  19 import static com.google.common.base.Preconditions.checkState;
  20 import static io.fd.honeycomb.v3po.translate.v3po.util.SubInterfaceUtils.getSubInterfaceName;
  21 import static io.fd.honeycomb.v3po.translate.v3po.util.TranslateUtils.booleanToByte;
  22
  23 import com.google.common.base.Optional;
  24 import com.google.common.base.Preconditions;
  25 import io.fd.honeycomb.v3po.translate.spi.write.ListWriterCustomizer;
  26 import io.fd.honeycomb.v3po.translate.v3po.util.FutureJVppCustomizer;
  27 import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext;
  28 import io.fd.honeycomb.v3po.translate.v3po.util.TranslateUtils;
  29 import io.fd.honeycomb.v3po.translate.v3po.util.WriteTimeoutException;
  30 import io.fd.honeycomb.v3po.translate.write.WriteContext;
  31 import io.fd.honeycomb.v3po.translate.write.WriteFailedException;
  32 import java.util.List;
  33 import java.util.Objects;
  34 import java.util.concurrent.CompletionStage;
  35 import javax.annotation.Nonnull;
  36 import javax.annotation.Nullable;
  37 import org.opendaylight.yang.gen.v1.urn.ieee.params.xml.ns.yang.dot1q.types.rev150626.CVlan;
  38 import org.opendaylight.yang.gen.v1.urn.ieee.params.xml.ns.yang.dot1q.types.rev150626.Dot1qVlanId;
  39 import org.opendaylight.yang.gen.v1.urn.ieee.params.xml.ns.yang.dot1q.types.rev150626.SVlan;
  40 import org.opendaylight.yang.gen.v1.urn.ieee.params.xml.ns.yang.dot1q.types.rev150626.dot1q.tag.or.any.Dot1qTag;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527._802dot1ad;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.interfaces._interface.SubInterfaces;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.interfaces._interface.sub.interfaces.SubInterface;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.interfaces._interface.sub.interfaces.SubInterfaceKey;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.match.attributes.MatchType;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.match.attributes.match.type.Default;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.match.attributes.match.type.vlan.tagged.VlanTagged;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.base.attributes.Tags;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.base.attributes.tags.Tag;
  51 import org.opendaylight.yangtools.yang.binding.DataObject;
  52 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  53 import org.openvpp.jvpp.VppBaseCallException;
  54 import org.openvpp.jvpp.dto.CreateSubif;
  55 import org.openvpp.jvpp.dto.CreateSubifReply;
  56 import org.openvpp.jvpp.dto.SwInterfaceSetFlags;
  57 import org.openvpp.jvpp.dto.SwInterfaceSetFlagsReply;
  58 import org.openvpp.jvpp.future.FutureJVpp;
  59 import org.slf4j.Logger;
  60 import org.slf4j.LoggerFactory;
  61
  62 /**
  63  * Writer Customizer responsible for sub interface creation.<br> Sends {@code create_subif} message to VPP.<br>
  64  * Equivalent of invoking {@code vppclt create subif} command.
  65  */
  66 public class SubInterfaceCustomizer extends FutureJVppCustomizer
  67     implements ListWriterCustomizer<SubInterface, SubInterfaceKey> {
  68
  69     private static final Logger LOG = LoggerFactory.getLogger(SubInterfaceCustomizer.class);
  70     private final NamingContext interfaceContext;
  71
  72     public SubInterfaceCustomizer(@Nonnull final FutureJVpp futureJvpp, @Nonnull final NamingContext interfaceContext) {
  73         super(futureJvpp);
  74         this.interfaceContext = Preconditions.checkNotNull(interfaceContext, "interfaceContext should not be null");
  75     }
  76
  77     @Nonnull
  78     @Override
  79     public Optional<List<SubInterface>> extract(@Nonnull final InstanceIdentifier<SubInterface> currentId,
  80                                                 @Nonnull final DataObject parentData) {
  81         return Optional.fromNullable(((SubInterfaces) parentData).getSubInterface());
  82     }
  83
  84
  85     @Override
  86     public void writeCurrentAttributes(@Nonnull final InstanceIdentifier<SubInterface> id,
  87                                        @Nonnull final SubInterface dataAfter, @Nonnull final WriteContext writeContext)
  88         throws WriteFailedException {
  89         final String superIfName = id.firstKeyOf(Interface.class).getName();
  90         try {
  91             createSubInterface(id, superIfName, dataAfter, writeContext);
  92         } catch (VppBaseCallException e) {
  93             LOG.warn("Failed to create sub interface for: {}, subInterface: {}", superIfName, dataAfter);
  94             throw new WriteFailedException.CreateFailedException(id, dataAfter, e);
  95         }
  96     }
  97
  98     private void createSubInterface(final InstanceIdentifier<SubInterface> id, @Nonnull final String superIfName,
  99                                     @Nonnull final SubInterface subInterface,
 100                                     final WriteContext writeContext) throws VppBaseCallException,
 101         WriteTimeoutException {
 102         final int superIfIndex = interfaceContext.getIndex(superIfName, writeContext.getMappingContext());
 103         final CompletionStage<CreateSubifReply> createSubifReplyCompletionStage =
 104             getFutureJVpp().createSubif(getCreateSubifRequest(subInterface, superIfIndex));
 105
 106         final CreateSubifReply reply =
 107             TranslateUtils.getReplyForWrite(createSubifReplyCompletionStage.toCompletableFuture(), id);
 108
 109         setInterfaceState(id, reply.swIfIndex, booleanToByte(subInterface.isEnabled()));
 110         interfaceContext.addName(reply.swIfIndex,
 111             getSubInterfaceName(superIfName, Math.toIntExact(subInterface.getIdentifier())),
 112             writeContext.getMappingContext());
 113         LOG.debug("Sub interface created successfully for: {}, subInterface: {}", superIfName, subInterface);
 114     }
 115
 116     private CreateSubif getCreateSubifRequest(@Nonnull final SubInterface subInterface, final int swIfIndex) {
 117         // TODO add validation
 118         CreateSubif request = new CreateSubif();
 119         request.subId = Math.toIntExact(subInterface.getIdentifier().intValue());
 120         request.swIfIndex = swIfIndex;
 121
 122         final int numberOfTags = getNumberOfTags(subInterface);
 123         switch (numberOfTags) {
 124             case 0:
 125                 request.noTags = 1;
 126                 break;
 127             case 1:
 128                 request.oneTag = 1;
 129                 break;
 130             case 2:
 131                 request.twoTags = 1;
 132                 break;
 133         }
 134         request.dot1Ad = booleanToByte(_802dot1ad.class == subInterface.getVlanType());
 135
 136         final MatchType matchType = subInterface.getMatch().getMatchType(); // todo match should be mandatory
 137         request.exactMatch =
 138             booleanToByte(matchType instanceof VlanTagged && ((VlanTagged) matchType).isMatchExactTags());
 139         request.defaultSub = booleanToByte(matchType instanceof Default);
 140
 141         if (numberOfTags > 0) {
 142             for (final Tag tag : subInterface.getTags().getTag()) {
 143                 if (tag.getIndex() == 0) {
 144                     setOuterTag(request, tag);
 145                 } else if (tag.getIndex() == 1) {
 146                     setInnerTag(request, tag);
 147                 }
 148             }
 149         }
 150         return request;
 151     }
 152
 153     private void setOuterTag(final CreateSubif request, final Tag outerTag) {
 154         checkState(SVlan.class == outerTag.getDot1qTag().getTagType(), "Service Tag expected at index 0");
 155         final Dot1qTag.VlanId vlanId = outerTag.getDot1qTag().getVlanId();
 156
 157         request.outerVlanId = dot1qVlanIdToShort(vlanId.getDot1qVlanId());
 158         request.outerVlanIdAny = booleanToByte(Dot1qTag.VlanId.Enumeration.Any.equals(vlanId.getEnumeration()));
 159     }
 160
 161     private void setInnerTag(final CreateSubif request, final Tag innerTag) {
 162         checkState(CVlan.class == innerTag.getDot1qTag().getTagType(), "Customer Tag expected at index 1");
 163         final Dot1qTag.VlanId vlanId = innerTag.getDot1qTag().getVlanId();
 164
 165         request.innerVlanId = dot1qVlanIdToShort(vlanId.getDot1qVlanId());
 166         request.innerVlanIdAny = booleanToByte(Dot1qTag.VlanId.Enumeration.Any.equals(vlanId.getEnumeration()));
 167     }
 168
 169     private static int getNumberOfTags(@Nonnull final SubInterface subInterface) {
 170         final Tags tags = subInterface.getTags();
 171         if (tags == null) {
 172             return 0;
 173         }
 174         final List<Tag> tagList = tags.getTag();
 175         if (tagList == null) {
 176             return 0;
 177         }
 178         return tagList.size();
 179     }
 180
 181     private static short dot1qVlanIdToShort(@Nullable Dot1qVlanId dot1qVlanId) {
 182         if (dot1qVlanId == null) {
 183             return 0; // tell VPP that optional argument is missing
 184         } else {
 185             return dot1qVlanId.getValue().shortValue();
 186         }
 187     }
 188
 189     @Override
 190     public void updateCurrentAttributes(@Nonnull final InstanceIdentifier<SubInterface> id,
 191                                         @Nonnull final SubInterface dataBefore, @Nonnull final SubInterface dataAfter,
 192                                         @Nonnull final WriteContext writeContext)
 193         throws WriteFailedException {
 194         if (Objects.equals(dataBefore.isEnabled(), dataAfter.isEnabled())) {
 195             LOG.debug("No state update will be performed. Ignoring config");
 196             return; // TODO shouldn't we throw exception here (if there will be dedicated L2 customizer)?
 197         }
 198         final String subIfaceName = getSubInterfaceName(id.firstKeyOf(Interface.class).getName(),
 199             Math.toIntExact(dataAfter.getIdentifier()));
 200         try {
 201             setInterfaceState(id, interfaceContext.getIndex(subIfaceName, writeContext.getMappingContext()),
 202                 booleanToByte(dataAfter.isEnabled()));
 203         } catch (VppBaseCallException e) {
 204             LOG.warn("Failed to update interface state for: interface if={}, enabled: {}",
 205                 subIfaceName, booleanToByte(dataAfter.isEnabled()));
 206             throw new WriteFailedException.UpdateFailedException(id, dataBefore, dataAfter, e);
 207         }
 208     }
 209
 210     private void setInterfaceState(final InstanceIdentifier<SubInterface> id, final int swIfIndex, final byte enabled)
 211         throws VppBaseCallException, WriteTimeoutException {
 212         final SwInterfaceSetFlags swInterfaceSetFlags = new SwInterfaceSetFlags();
 213         swInterfaceSetFlags.swIfIndex = swIfIndex;
 214         swInterfaceSetFlags.adminUpDown = enabled;
 215
 216         final CompletionStage<SwInterfaceSetFlagsReply> swInterfaceSetFlagsReplyFuture =
 217             getFutureJVpp().swInterfaceSetFlags(swInterfaceSetFlags);
 218
 219         LOG.debug("Updating interface state for interface if={}, enabled: {}", swIfIndex, enabled);
 220
 221         SwInterfaceSetFlagsReply reply =
 222             TranslateUtils.getReplyForWrite(swInterfaceSetFlagsReplyFuture.toCompletableFuture(), id);
 223         LOG.debug("Interface state updated successfully for interface index: {}, enabled: {}, ctxId: {}",
 224             swIfIndex, enabled, reply.context);
 225     }
 226
 227     @Override
 228     public void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<SubInterface> id,
 229                                         @Nonnull final SubInterface dataBefore,
 230                                         @Nonnull final WriteContext writeContext)
 231         throws WriteFailedException.DeleteFailedException {
 232         throw new UnsupportedOperationException("Sub interface delete is not supported");
 233     }
 234 }