v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfacesstate/InterconnectionReadUtils.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 import static java.util.Objects.requireNonNull;
  21
  22 import io.fd.honeycomb.translate.read.ReadContext;
  23 import io.fd.honeycomb.translate.read.ReadFailedException;
  24 import io.fd.honeycomb.translate.v3po.util.NamingContext;
  25 import io.fd.honeycomb.translate.v3po.util.TranslateUtils;
  26 import java.util.Optional;
  27 import java.util.concurrent.CompletableFuture;
  28 import javax.annotation.Nonnull;
  29 import javax.annotation.Nullable;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.base.attributes.Interconnection;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.base.attributes.interconnection.BridgeBasedBuilder;
  32 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  33 import org.openvpp.jvpp.VppBaseCallException;
  34 import org.openvpp.jvpp.core.dto.BridgeDomainDetails;
  35 import org.openvpp.jvpp.core.dto.BridgeDomainDetailsReplyDump;
  36 import org.openvpp.jvpp.core.dto.BridgeDomainDump;
  37 import org.openvpp.jvpp.core.dto.BridgeDomainSwIfDetails;
  38 import org.openvpp.jvpp.core.dto.SwInterfaceDetails;
  39 import org.openvpp.jvpp.core.future.FutureJVppCore;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 /**
  44  * Utility class providing Interconnection read support.
  45  */
  46 // FIXME this should be customizer, but it is not possible because Interconnection is not a DataObject
  47 final class InterconnectionReadUtils {
  48
  49     private static final Logger LOG = LoggerFactory.getLogger(InterconnectionReadUtils.class);
  50
  51     private final FutureJVppCore futureJVppCore;
  52     private final NamingContext interfaceContext;
  53     private final NamingContext bridgeDomainContext;
  54
  55     InterconnectionReadUtils(@Nonnull final FutureJVppCore futureJVppCore,
  56                              @Nonnull final NamingContext interfaceContext,
  57                              @Nonnull final NamingContext bridgeDomainContext) {
  58         this.futureJVppCore = requireNonNull(futureJVppCore, "futureJVppCore should not be null");
  59         this.interfaceContext = requireNonNull(interfaceContext, "interfaceContext should not be null");
  60         this.bridgeDomainContext = requireNonNull(bridgeDomainContext, "bridgeDomainContext should not be null");
  61     }
  62
  63     @Nullable
  64     Interconnection readInterconnection(@Nonnull final InstanceIdentifier<?> id, @Nonnull final String ifaceName,
  65                                         @Nonnull final ReadContext ctx)
  66         throws ReadFailedException {
  67         final int ifaceId = interfaceContext.getIndex(ifaceName, ctx.getMappingContext());
  68
  69         final SwInterfaceDetails iface = InterfaceUtils.getVppInterfaceDetails(futureJVppCore, id, ifaceName,
  70             ifaceId, ctx.getModificationCache());
  71         LOG.debug("Interface details for interface: {}, details: {}", ifaceName, iface);
  72
  73         final BridgeDomainDetailsReplyDump dumpReply = getDumpReply(id);
  74         final Optional<BridgeDomainSwIfDetails> bdForInterface = getBridgeDomainForInterface(ifaceId, dumpReply);
  75         if (bdForInterface.isPresent()) {
  76             final BridgeDomainSwIfDetails bdSwIfDetails = bdForInterface.get();
  77             final BridgeBasedBuilder bbBuilder = new BridgeBasedBuilder();
  78             bbBuilder.setBridgeDomain(bridgeDomainContext.getName(bdSwIfDetails.bdId, ctx.getMappingContext()));
  79
  80             // Set BVI if the bridgeDomainDetails.bviSwIfIndex == current sw if index
  81             final Optional<BridgeDomainDetails> bridgeDomainForInterface =
  82                 getBridgeDomainForInterface(dumpReply, bdForInterface.get().bdId);
  83             // Since we already found an interface assigned to a bridge domain, the details for BD must be present
  84             checkState(bridgeDomainForInterface.isPresent());
  85             if (bridgeDomainForInterface.get().bviSwIfIndex == ifaceId) {
  86                 bbBuilder.setBridgedVirtualInterface(true);
  87             } else {
  88                 bbBuilder.setBridgedVirtualInterface(false);
  89             }
  90
  91             if (bdSwIfDetails.shg != 0) {
  92                 bbBuilder.setSplitHorizonGroup((short) bdSwIfDetails.shg);
  93             }
  94             return bbBuilder.build();
  95         }
  96         // TODO is there a way to check if interconnection is XconnectBased?
  97
  98         return null;
  99     }
 100
 101     private Optional<BridgeDomainSwIfDetails> getBridgeDomainForInterface(final int ifaceId,
 102                                                                           final BridgeDomainDetailsReplyDump reply) {
 103         if (null == reply || null == reply.bridgeDomainSwIfDetails || reply.bridgeDomainSwIfDetails.isEmpty()) {
 104             return Optional.empty();
 105         }
 106         // interface can be added to only one BD only
 107         return reply.bridgeDomainSwIfDetails.stream().filter(a -> a.swIfIndex == ifaceId).findFirst();
 108     }
 109
 110     private Optional<BridgeDomainDetails> getBridgeDomainForInterface(final BridgeDomainDetailsReplyDump reply,
 111                                                                       int bdId) {
 112         return reply.bridgeDomainDetails.stream().filter(a -> a.bdId == bdId).findFirst();
 113     }
 114
 115     private BridgeDomainDetailsReplyDump getDumpReply(@Nonnull final InstanceIdentifier<?> id)
 116         throws ReadFailedException {
 117         try {
 118             // We need to perform full bd dump, because there is no way
 119             // to ask VPP for BD details given interface id/name (TODO add it to vpp.api?)
 120             // TODO cache dump result
 121             final BridgeDomainDump request = new BridgeDomainDump();
 122             request.bdId = -1;
 123
 124             final CompletableFuture<BridgeDomainDetailsReplyDump> bdCompletableFuture =
 125                 futureJVppCore.bridgeDomainSwIfDump(request).toCompletableFuture();
 126             return TranslateUtils.getReplyForRead(bdCompletableFuture, id);
 127         } catch (VppBaseCallException e) {
 128             throw new ReadFailedException(id, e);
 129         }
 130     }
 131 }