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

   1 /*
   2  * Copyright (c) 2016 Intel 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.ReaderCustomizer;
  24 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  25 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  26 import java.net.InetAddress;
  27 import java.net.UnknownHostException;
  28 import java.util.Arrays;
  29 import java.util.concurrent.CompletionStage;
  30 import javax.annotation.Nonnull;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.GreTunnel;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VppInterfaceStateAugmentationBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.Gre;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.GreBuilder;
  40 import org.opendaylight.yangtools.concepts.Builder;
  41 import org.opendaylight.yangtools.yang.binding.DataObject;
  42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  43 import io.fd.vpp.jvpp.VppBaseCallException;
  44 import io.fd.vpp.jvpp.core.dto.GreTunnelDetails;
  45 import io.fd.vpp.jvpp.core.dto.GreTunnelDetailsReplyDump;
  46 import io.fd.vpp.jvpp.core.dto.GreTunnelDump;
  47 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 public class GreCustomizer extends FutureJVppCustomizer
  52         implements ReaderCustomizer<Gre, GreBuilder>, InterfaceDataTranslator {
  53
  54     private static final Logger LOG = LoggerFactory.getLogger(GreCustomizer.class);
  55     private NamingContext interfaceContext;
  56
  57     public GreCustomizer(@Nonnull final FutureJVppCore jvpp, @Nonnull final NamingContext interfaceContext) {
  58         super(jvpp);
  59         this.interfaceContext = interfaceContext;
  60     }
  61
  62     @Override
  63     public void merge(@Nonnull Builder<? extends DataObject> parentBuilder,
  64                       @Nonnull Gre readValue) {
  65         ((VppInterfaceStateAugmentationBuilder) parentBuilder).setGre(readValue);
  66     }
  67
  68     @Nonnull
  69     @Override
  70     public GreBuilder getBuilder(@Nonnull InstanceIdentifier<Gre> id) {
  71         return new GreBuilder();
  72     }
  73
  74     @Override
  75     public void readCurrentAttributes(@Nonnull final InstanceIdentifier<Gre> id,
  76                                       @Nonnull final GreBuilder builder,
  77                                       @Nonnull final ReadContext ctx) throws ReadFailedException {
  78         try {
  79             final InterfaceKey key = id.firstKeyOf(Interface.class);
  80             final int index = interfaceContext.getIndex(key.getName(), ctx.getMappingContext());
  81             if (!isInterfaceOfType(getFutureJVpp(), ctx.getModificationCache(), id, index, GreTunnel.class, LOG)) {
  82                 return;
  83             }
  84
  85             LOG.debug("Reading attributes for gre tunnel: {}", key.getName());
  86             // Dump just a single
  87             final GreTunnelDump request = new GreTunnelDump();
  88             request.swIfIndex = index;
  89
  90             final CompletionStage<GreTunnelDetailsReplyDump> swInterfaceGreDetailsReplyDumpCompletionStage =
  91                     getFutureJVpp().greTunnelDump(request);
  92             final GreTunnelDetailsReplyDump reply =
  93                     getReplyForRead(swInterfaceGreDetailsReplyDumpCompletionStage.toCompletableFuture(), id);
  94
  95             // VPP keeps gre tunnel interfaces even after they were deleted (optimization)
  96             // However there ar no longer any gre tunnel specific fields assigned to it and this call
  97             // returns nothing
  98             if (reply == null || reply.greTunnelDetails == null || reply.greTunnelDetails.isEmpty()) {
  99                 LOG.debug(
 100                         "Gre tunnel {}, id {} has no attributes assigned in VPP. Probably is a leftover interface placeholder" +
 101                                 "after delete", key.getName(), index);
 102                 return;
 103             }
 104
 105             checkState(reply.greTunnelDetails.size() == 1,
 106                     "Unexpected number of returned gre tunnels: {} for tunnel: {}", reply.greTunnelDetails,
 107                     key.getName());
 108             LOG.trace("Gre tunnel: {} attributes returned from VPP: {}", key.getName(), reply);
 109
 110             final GreTunnelDetails swInterfaceGreDetails = reply.greTunnelDetails.get(0);
 111             if (swInterfaceGreDetails.isIpv6 == 1) {
 112                 final Ipv6Address dstIpv6 =
 113                         new Ipv6Address(parseAddress(swInterfaceGreDetails.dstAddress).getHostAddress());
 114                 builder.setDst(new IpAddress(dstIpv6));
 115                 final Ipv6Address srcIpv6 =
 116                         new Ipv6Address(parseAddress(swInterfaceGreDetails.srcAddress).getHostAddress());
 117                 builder.setSrc(new IpAddress(srcIpv6));
 118             } else {
 119                 final byte[] dstBytes = Arrays.copyOfRange(swInterfaceGreDetails.dstAddress, 0, 4);
 120                 final Ipv4Address dstIpv4 = new Ipv4Address(parseAddress(dstBytes).getHostAddress());
 121                 builder.setDst(new IpAddress(dstIpv4));
 122                 final byte[] srcBytes = Arrays.copyOfRange(swInterfaceGreDetails.srcAddress, 0, 4);
 123                 final Ipv4Address srcIpv4 = new Ipv4Address(parseAddress(srcBytes).getHostAddress());
 124                 builder.setSrc(new IpAddress(srcIpv4));
 125             }
 126             builder.setOuterFibId((long) swInterfaceGreDetails.outerFibId);
 127             LOG.debug("Gre tunnel: {}, id: {} attributes read as: {}", key.getName(), index, builder);
 128         } catch (VppBaseCallException e) {
 129             LOG.warn("Failed to readCurrentAttributes for: {}", id, e);
 130             throw new ReadFailedException(id, e);
 131         }
 132     }
 133
 134     @Nonnull
 135     private static InetAddress parseAddress(@Nonnull final byte[] addr) {
 136         try {
 137             return InetAddress.getByAddress(addr);
 138         } catch (UnknownHostException e) {
 139             throw new IllegalArgumentException("Cannot create InetAddress from " + Arrays.toString(addr), e);
 140         }
 141     }
 142 }