v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfacesstate/VxlanGpeCustomizer.java

   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.translate.v3po.interfacesstate;
  18
  19 import static com.google.common.base.Preconditions.checkState;
  20
  21 import io.fd.honeycomb.translate.read.ReadContext;
  22 import io.fd.honeycomb.translate.read.ReadFailedException;
  23 import io.fd.honeycomb.translate.spi.read.Initialized;
  24 import io.fd.honeycomb.translate.spi.read.InitializingReaderCustomizer;
  25 import io.fd.honeycomb.translate.util.RWUtils;
  26 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  27 import io.fd.honeycomb.translate.vpp.util.JvppReplyConsumer;
  28 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  29 import io.fd.vpp.jvpp.core.dto.VxlanGpeTunnelDetails;
  30 import io.fd.vpp.jvpp.core.dto.VxlanGpeTunnelDetailsReplyDump;
  31 import io.fd.vpp.jvpp.core.dto.VxlanGpeTunnelDump;
  32 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
  33 import java.net.InetAddress;
  34 import java.net.UnknownHostException;
  35 import java.util.Arrays;
  36 import java.util.concurrent.CompletionStage;
  37 import javax.annotation.Nonnull;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceAugmentation;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceStateAugmentationBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VxlanGpeNextProtocol;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VxlanGpeTunnel;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VxlanGpeVni;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.VxlanGpe;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.VxlanGpeBuilder;
  50 import org.opendaylight.yangtools.concepts.Builder;
  51 import org.opendaylight.yangtools.yang.binding.DataObject;
  52 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 public class VxlanGpeCustomizer extends FutureJVppCustomizer
  57         implements InitializingReaderCustomizer<VxlanGpe, VxlanGpeBuilder>, InterfaceDataTranslator, JvppReplyConsumer {
  58
  59     private static final Logger LOG = LoggerFactory.getLogger(VxlanGpeCustomizer.class);
  60     private NamingContext interfaceContext;
  61
  62     public VxlanGpeCustomizer(@Nonnull final FutureJVppCore jvpp, @Nonnull final NamingContext interfaceContext) {
  63         super(jvpp);
  64         this.interfaceContext = interfaceContext;
  65     }
  66
  67     @Override
  68     public void merge(@Nonnull Builder<? extends DataObject> parentBuilder,
  69                       @Nonnull VxlanGpe readValue) {
  70         ((VppInterfaceStateAugmentationBuilder) parentBuilder).setVxlanGpe(readValue);
  71     }
  72
  73     @Nonnull
  74     @Override
  75     public VxlanGpeBuilder getBuilder(@Nonnull InstanceIdentifier<VxlanGpe> id) {
  76         return new VxlanGpeBuilder();
  77     }
  78
  79     @Override
  80     public void readCurrentAttributes(@Nonnull final InstanceIdentifier<VxlanGpe> id,
  81                                       @Nonnull final VxlanGpeBuilder builder,
  82                                       @Nonnull final ReadContext ctx) throws ReadFailedException {
  83
  84         final InterfaceKey key = id.firstKeyOf(Interface.class);
  85         final int index = interfaceContext.getIndex(key.getName(), ctx.getMappingContext());
  86         if (!isInterfaceOfType(getFutureJVpp(), ctx.getModificationCache(), id, index, VxlanGpeTunnel.class, LOG)) {
  87             return;
  88         }
  89
  90         LOG.debug("Reading attributes for VxlanGpe tunnel: {}", key.getName());
  91         // Dump just a single
  92         final VxlanGpeTunnelDump request = new VxlanGpeTunnelDump();
  93         request.swIfIndex = index;
  94
  95         final CompletionStage<VxlanGpeTunnelDetailsReplyDump> swInterfaceVxlanGpeDetailsReplyDumpCompletionStage =
  96                 getFutureJVpp().vxlanGpeTunnelDump(request);
  97         final VxlanGpeTunnelDetailsReplyDump reply =
  98                 getReplyForRead(swInterfaceVxlanGpeDetailsReplyDumpCompletionStage.toCompletableFuture(),
  99                         id);
 100
 101         // VPP keeps VxlanGpe tunnel interfaces even after they were deleted (optimization)
 102         // However there are no longer any VxlanGpe tunnel specific fields assigned to it and this call
 103         // returns nothing
 104         if (reply == null || reply.vxlanGpeTunnelDetails == null || reply.vxlanGpeTunnelDetails.isEmpty()) {
 105             LOG.debug(
 106                     "VxlanGpe tunnel {}, id {} has no attributes assigned in VPP. Probably is a leftover interface placeholder" +
 107                             "after delete", key.getName(), index);
 108             return;
 109         }
 110
 111         checkState(reply.vxlanGpeTunnelDetails.size() == 1,
 112                 "Unexpected number of returned VxlanGpe tunnels: {} for tunnel: {}", reply.vxlanGpeTunnelDetails,
 113                 key.getName());
 114         LOG.trace("VxlanGpe tunnel: {} attributes returned from VPP: {}", key.getName(), reply);
 115
 116         final VxlanGpeTunnelDetails swInterfaceVxlanGpeDetails = reply.vxlanGpeTunnelDetails.get(0);
 117         if (swInterfaceVxlanGpeDetails.isIpv6 == 1) {
 118             final Ipv6Address remote6 =
 119                     new Ipv6Address(parseAddress(swInterfaceVxlanGpeDetails.remote).getHostAddress());
 120             builder.setRemote(new IpAddress(remote6));
 121             final Ipv6Address local6 =
 122                     new Ipv6Address(parseAddress(swInterfaceVxlanGpeDetails.local).getHostAddress());
 123             builder.setLocal(new IpAddress(local6));
 124         } else {
 125             final byte[] dstBytes = Arrays.copyOfRange(swInterfaceVxlanGpeDetails.remote, 0, 4);
 126             final Ipv4Address remote4 = new Ipv4Address(parseAddress(dstBytes).getHostAddress());
 127             builder.setRemote(new IpAddress(remote4));
 128             final byte[] srcBytes = Arrays.copyOfRange(swInterfaceVxlanGpeDetails.local, 0, 4);
 129             final Ipv4Address local4 = new Ipv4Address(parseAddress(srcBytes).getHostAddress());
 130             builder.setLocal(new IpAddress(local4));
 131         }
 132         builder.setVni(new VxlanGpeVni((long) swInterfaceVxlanGpeDetails.vni));
 133         builder.setNextProtocol(VxlanGpeNextProtocol.forValue(swInterfaceVxlanGpeDetails.protocol));
 134         builder.setEncapVrfId((long) swInterfaceVxlanGpeDetails.encapVrfId);
 135         builder.setDecapVrfId((long) swInterfaceVxlanGpeDetails.decapVrfId);
 136         LOG.debug("VxlanGpe tunnel: {}, id: {} attributes read as: {}", key.getName(), index, builder);
 137     }
 138
 139     @Nonnull
 140     private static InetAddress parseAddress(@Nonnull final byte[] addr) {
 141         try {
 142             return InetAddress.getByAddress(addr);
 143         } catch (UnknownHostException e) {
 144             throw new IllegalArgumentException("Cannot create InetAddress from " + Arrays.toString(addr), e);
 145         }
 146     }
 147
 148     @Override
 149     public Initialized<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VxlanGpe> init(
 150             @Nonnull final InstanceIdentifier<VxlanGpe> id, @Nonnull final VxlanGpe readValue, @Nonnull final ReadContext ctx) {
 151         return Initialized.create(getCfgId(id),
 152                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VxlanGpeBuilder()
 153                         .setLocal(readValue.getLocal())
 154                         .setRemote(readValue.getRemote())
 155                         .setVni(new VxlanGpeVni(readValue.getVni()))
 156                         .setNextProtocol(readValue.getNextProtocol())
 157                         .setEncapVrfId(readValue.getEncapVrfId())
 158                         .setDecapVrfId(readValue.getDecapVrfId())
 159                         .build());
 160     }
 161
 162     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VxlanGpe> getCfgId(
 163             final InstanceIdentifier<VxlanGpe> id) {
 164         return InterfaceCustomizer.getCfgId(RWUtils.cutId(id, Interface.class))
 165                 .augmentation(VppInterfaceAugmentation.class)
 166                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VxlanGpe.class);
 167     }
 168 }