v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/vppstate/L2FibEntryCustomizer.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.vppstate;
  18
  19 import com.google.common.base.Preconditions;
  20 import com.google.common.primitives.Longs;
  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.InitializingListReaderCustomizer;
  25 import io.fd.honeycomb.translate.util.RWUtils;
  26 import io.fd.honeycomb.translate.v3po.interfacesstate.InterfaceDataTranslator;
  27 import io.fd.honeycomb.translate.vpp.util.ByteDataTranslator;
  28 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  29 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  30 import io.fd.vpp.jvpp.core.dto.L2FibTableDump;
  31 import io.fd.vpp.jvpp.core.dto.L2FibTableEntry;
  32 import io.fd.vpp.jvpp.core.dto.L2FibTableEntryReplyDump;
  33 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
  34 import java.util.Collections;
  35 import java.util.List;
  36 import java.util.concurrent.CompletableFuture;
  37 import java.util.stream.Collector;
  38 import java.util.stream.Collectors;
  39 import javax.annotation.Nonnull;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.L2FibFilter;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.L2FibForward;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.L2FibTable;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.L2FibTableBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.l2.fib.table.L2FibEntry;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.l2.fib.table.L2FibEntryBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.l2.fib.table.L2FibEntryKey;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.vpp.state.bridge.domains.BridgeDomain;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.vpp.state.bridge.domains.BridgeDomainKey;
  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 final class L2FibEntryCustomizer extends FutureJVppCustomizer
  57         implements InitializingListReaderCustomizer<L2FibEntry, L2FibEntryKey, L2FibEntryBuilder>, ByteDataTranslator,
  58         InterfaceDataTranslator {
  59
  60     private static final Logger LOG = LoggerFactory.getLogger(L2FibEntryCustomizer.class);
  61
  62     private static final Collector<L2FibTableEntry, ?, L2FibTableEntry> SINGLE_ITEM_COLLECTOR =
  63             RWUtils.singleItemCollector();
  64
  65     private final NamingContext bdContext;
  66     private final NamingContext interfaceContext;
  67
  68     public L2FibEntryCustomizer(@Nonnull final FutureJVppCore futureJVppCore, @Nonnull final NamingContext bdContext,
  69                                 @Nonnull final NamingContext interfaceContext) {
  70         super(futureJVppCore);
  71         this.bdContext = Preconditions.checkNotNull(bdContext, "bdContext should not be null");
  72         this.interfaceContext = Preconditions.checkNotNull(interfaceContext, "interfaceContext should not be null");
  73     }
  74
  75     @Override
  76     public void readCurrentAttributes(@Nonnull final InstanceIdentifier<L2FibEntry> id,
  77                                       @Nonnull final L2FibEntryBuilder builder, @Nonnull final ReadContext ctx)
  78             throws ReadFailedException {
  79
  80         final L2FibEntryKey key = id.firstKeyOf(id.getTargetType());
  81         final BridgeDomainKey bridgeDomainKey = id.firstKeyOf(BridgeDomain.class);
  82         final int bdId = bdContext.getIndex(bridgeDomainKey.getName(), ctx.getMappingContext());
  83         LOG.debug("Reading L2 FIB entry: key={}. bridgeDomainKey={}, bdId={}", key, bridgeDomainKey, bdId);
  84
  85         try {
  86             // TODO HONEYCOMB-186 use cached l2FibTable
  87             final L2FibTableEntry entry = dumpL2Fibs(id, bdId).stream().filter(e -> key.getPhysAddress()
  88                     .equals(new PhysAddress(vppPhysAddrToYang(Longs.toByteArray(e.mac), 2))))
  89                     .collect(SINGLE_ITEM_COLLECTOR);
  90
  91             builder.setAction(byteToBoolean(entry.filterMac)
  92                     ? L2FibFilter.class
  93                     : L2FibForward.class);
  94             builder.setBridgedVirtualInterface(byteToBoolean(entry.bviMac));
  95
  96             if (entry.swIfIndex != -1) {
  97                 builder.setOutgoingInterface(interfaceContext.getName(entry.swIfIndex, ctx.getMappingContext()));
  98             }
  99             builder.setStaticConfig(byteToBoolean(entry.staticMac));
 100             builder.setPhysAddress(key.getPhysAddress());
 101             builder.setKey(key);
 102         } catch (Exception e) {
 103             throw new ReadFailedException(id, e);
 104         }
 105     }
 106
 107     @Nonnull
 108     private List<L2FibTableEntry> dumpL2Fibs(final InstanceIdentifier<L2FibEntry> id, final int bdId)
 109             throws ReadFailedException {
 110         final L2FibTableDump l2FibRequest = new L2FibTableDump();
 111         l2FibRequest.bdId = bdId;
 112
 113         final CompletableFuture<L2FibTableEntryReplyDump> l2FibTableDumpCompletableFuture =
 114                 getFutureJVpp().l2FibTableDump(l2FibRequest).toCompletableFuture();
 115
 116         final L2FibTableEntryReplyDump dump = getReplyForRead(l2FibTableDumpCompletableFuture, id);
 117
 118         if (null == dump || null == dump.l2FibTableEntry) {
 119             return Collections.emptyList();
 120         } else {
 121             return dump.l2FibTableEntry;
 122         }
 123     }
 124
 125     @Nonnull
 126     @Override
 127     public List<L2FibEntryKey> getAllIds(@Nonnull final InstanceIdentifier<L2FibEntry> id,
 128                                          @Nonnull final ReadContext ctx) throws ReadFailedException {
 129         final BridgeDomainKey bridgeDomainKey = id.firstKeyOf(BridgeDomain.class);
 130         final int bdId = bdContext.getIndex(bridgeDomainKey.getName(), ctx.getMappingContext());
 131
 132         LOG.debug("Reading L2 FIB for bridge domain {} (bdId={})", bridgeDomainKey, bdId);
 133         return dumpL2Fibs(id, bdId).stream()
 134                 .map(entry -> new L2FibEntryKey(
 135                         new PhysAddress(vppPhysAddrToYang(Longs.toByteArray(entry.mac), 2))))
 136                 .collect(Collectors.toList());
 137     }
 138
 139     @Override
 140     public void merge(@Nonnull final Builder<? extends DataObject> builder, @Nonnull final List<L2FibEntry> readData) {
 141         ((L2FibTableBuilder) builder).setL2FibEntry(readData);
 142     }
 143
 144     @Nonnull
 145     @Override
 146     public L2FibEntryBuilder getBuilder(@Nonnull final InstanceIdentifier<L2FibEntry> id) {
 147         return new L2FibEntryBuilder();
 148     }
 149
 150     @Override
 151     public Initialized<L2FibEntry> init(
 152             @Nonnull final InstanceIdentifier<L2FibEntry> id,
 153             @Nonnull final L2FibEntry readValue,
 154             @Nonnull final ReadContext ctx) {
 155         return Initialized.create(getCfgId(id),
 156                 // Convert operational object to config. VPP does not support setting BVI (see v3po.yang)
 157                 new L2FibEntryBuilder(readValue).setBridgedVirtualInterface(null).build());
 158     }
 159
 160     static InstanceIdentifier<L2FibEntry> getCfgId(
 161             final @Nonnull InstanceIdentifier<L2FibEntry> id) {
 162         return BridgeDomainCustomizer.getCfgId(RWUtils.cutId(id, BridgeDomain.class)).child(
 163                 L2FibTable.class).child(L2FibEntry.class, new L2FibEntryKey(id.firstKeyOf(L2FibEntry.class)));
 164     }
 165 }