v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfacesstate/VxlanCustomizer.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.VxlanTunnelDetails;
  30 import io.fd.vpp.jvpp.core.dto.VxlanTunnelDetailsReplyDump;
  31 import io.fd.vpp.jvpp.core.dto.VxlanTunnelDump;
  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.VxlanTunnel;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VxlanVni;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Vxlan;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.VxlanBuilder;
  49 import org.opendaylight.yangtools.concepts.Builder;
  50 import org.opendaylight.yangtools.yang.binding.DataObject;
  51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 public class VxlanCustomizer extends FutureJVppCustomizer
  56         implements InitializingReaderCustomizer<Vxlan, VxlanBuilder>, InterfaceDataTranslator, JvppReplyConsumer {
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(VxlanCustomizer.class);
  59     private final NamingContext interfaceContext;
  60
  61     public VxlanCustomizer(@Nonnull final FutureJVppCore jvpp, @Nonnull final NamingContext interfaceContext) {
  62         super(jvpp);
  63         this.interfaceContext = interfaceContext;
  64     }
  65
  66     @Override
  67     public void merge(@Nonnull Builder<? extends DataObject> parentBuilder,
  68                       @Nonnull Vxlan readValue) {
  69         ((VppInterfaceStateAugmentationBuilder) parentBuilder).setVxlan(readValue);
  70     }
  71
  72     @Nonnull
  73     @Override
  74     public VxlanBuilder getBuilder(@Nonnull InstanceIdentifier<Vxlan> id) {
  75         return new VxlanBuilder();
  76     }
  77
  78     @Override
  79     public void readCurrentAttributes(@Nonnull final InstanceIdentifier<Vxlan> id,
  80                                       @Nonnull final VxlanBuilder builder,
  81                                       @Nonnull final ReadContext ctx) throws ReadFailedException {
  82
  83         final InterfaceKey key = id.firstKeyOf(Interface.class);
  84         final int index = interfaceContext.getIndex(key.getName(), ctx.getMappingContext());
  85         if (!isInterfaceOfType(getFutureJVpp(), ctx.getModificationCache(), id, index, VxlanTunnel.class, LOG)) {
  86             return;
  87         }
  88
  89         LOG.debug("Reading attributes for vxlan tunnel: {}", key.getName());
  90         // Dump just a single
  91         final VxlanTunnelDump request = new VxlanTunnelDump();
  92         request.swIfIndex = index;
  93
  94         final CompletionStage<VxlanTunnelDetailsReplyDump> swInterfaceVxlanDetailsReplyDumpCompletionStage =
  95                 getFutureJVpp().vxlanTunnelDump(request);
  96         final VxlanTunnelDetailsReplyDump reply =
  97                 getReplyForRead(swInterfaceVxlanDetailsReplyDumpCompletionStage.toCompletableFuture(), id);
  98
  99         // VPP keeps vxlan tunnel interfaces even after they were deleted (optimization)
 100         // However there ar no longer any vxlan tunnel specific fields assigned to it and this call
 101         // returns nothing
 102         if (reply == null || reply.vxlanTunnelDetails == null || reply.vxlanTunnelDetails.isEmpty()) {
 103             LOG.debug(
 104                     "Vxlan tunnel {}, id {} has no attributes assigned in VPP. Probably is a leftover interface placeholder" +
 105                             "after delete", key.getName(), index);
 106             return;
 107         }
 108
 109         checkState(reply.vxlanTunnelDetails.size() == 1,
 110                 "Unexpected number of returned vxlan tunnels: {} for tunnel: {}", reply.vxlanTunnelDetails,
 111                 key.getName());
 112         LOG.trace("Vxlan tunnel: {} attributes returned from VPP: {}", key.getName(), reply);
 113
 114         final VxlanTunnelDetails swInterfaceVxlanDetails = reply.vxlanTunnelDetails.get(0);
 115         if (swInterfaceVxlanDetails.isIpv6 == 1) {
 116             final Ipv6Address dstIpv6 =
 117                     new Ipv6Address(parseAddress(swInterfaceVxlanDetails.dstAddress).getHostAddress());
 118             builder.setDst(new IpAddress(dstIpv6));
 119             final Ipv6Address srcIpv6 =
 120                     new Ipv6Address(parseAddress(swInterfaceVxlanDetails.srcAddress).getHostAddress());
 121             builder.setSrc(new IpAddress(srcIpv6));
 122         } else {
 123             final byte[] dstBytes = Arrays.copyOfRange(swInterfaceVxlanDetails.dstAddress, 0, 4);
 124             final Ipv4Address dstIpv4 = new Ipv4Address(parseAddress(dstBytes).getHostAddress());
 125             builder.setDst(new IpAddress(dstIpv4));
 126             final byte[] srcBytes = Arrays.copyOfRange(swInterfaceVxlanDetails.srcAddress, 0, 4);
 127             final Ipv4Address srcIpv4 = new Ipv4Address(parseAddress(srcBytes).getHostAddress());
 128             builder.setSrc(new IpAddress(srcIpv4));
 129         }
 130         builder.setEncapVrfId((long) swInterfaceVxlanDetails.encapVrfId);
 131         builder.setVni(new VxlanVni((long) swInterfaceVxlanDetails.vni));
 132         LOG.debug("Vxlan tunnel: {}, id: {} attributes read as: {}", key.getName(), index, builder);
 133     }
 134
 135     @Nonnull
 136     private static InetAddress parseAddress(@Nonnull final byte[] addr) {
 137         try {
 138             return InetAddress.getByAddress(addr);
 139         } catch (UnknownHostException e) {
 140             throw new IllegalArgumentException("Cannot create InetAddress from " + Arrays.toString(addr), e);
 141         }
 142     }
 143
 144     @Override
 145     public Initialized<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Vxlan> init(
 146             @Nonnull final InstanceIdentifier<Vxlan> id, @Nonnull final Vxlan readValue, @Nonnull final ReadContext ctx) {
 147         return Initialized.create(getCfgId(id),
 148                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VxlanBuilder()
 149                         .setDst(readValue.getDst())
 150                         .setSrc(readValue.getSrc())
 151                         .setEncapVrfId(readValue.getEncapVrfId())
 152                         .setVni(new VxlanVni(readValue.getVni()))
 153                         .build());
 154     }
 155
 156     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Vxlan> getCfgId(
 157             final InstanceIdentifier<Vxlan> id) {
 158         return InterfaceCustomizer.getCfgId(RWUtils.cutId(id, Interface.class))
 159                 .augmentation(VppInterfaceAugmentation.class)
 160                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Vxlan.class);
 161     }
 162 }