gerrit.fd Code Review - hc2vpp.git/blob

   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.ip;
  18
  19 import static com.google.common.base.Preconditions.checkNotNull;
  20
  21 import com.google.common.base.Optional;
  22 import io.fd.honeycomb.translate.read.ReadContext;
  23 import io.fd.honeycomb.translate.read.ReadFailedException;
  24 import io.fd.honeycomb.translate.spi.read.Initialized;
  25 import io.fd.honeycomb.translate.spi.read.InitializingListReaderCustomizer;
  26 import io.fd.honeycomb.translate.util.RWUtils;
  27 import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
  28 import io.fd.honeycomb.translate.v3po.interfacesstate.SubInterfaceCustomizer;
  29 import io.fd.honeycomb.translate.v3po.interfacesstate.ip.dump.params.AddressDumpParams;
  30 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  31 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  32 import io.fd.honeycomb.translate.vpp.util.SubInterfaceUtils;
  33 import io.fd.vpp.jvpp.core.dto.IpAddressDetails;
  34 import io.fd.vpp.jvpp.core.dto.IpAddressDetailsReplyDump;
  35 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
  36 import java.util.List;
  37 import javax.annotation.Nonnull;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.interfaces.state._interface.sub.interfaces.SubInterface;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.Ipv4;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.Ipv4Builder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.Address;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.AddressBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.AddressKey;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.address.subnet.PrefixLengthBuilder;
  46 import org.opendaylight.yangtools.concepts.Builder;
  47 import org.opendaylight.yangtools.yang.binding.DataObject;
  48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 /**
  53  * Read customizer for sub-interface Ipv4 addresses.
  54  */
  55 public class SubInterfaceIpv4AddressCustomizer extends FutureJVppCustomizer
  56         implements InitializingListReaderCustomizer<Address, AddressKey, AddressBuilder>, Ipv4Reader {
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(SubInterfaceIpv4AddressCustomizer.class);
  59     private static final String CACHE_KEY = SubInterfaceIpv4AddressCustomizer.class.getName();
  60
  61     private final NamingContext interfaceContext;
  62     private final DumpCacheManager<IpAddressDetailsReplyDump, AddressDumpParams> dumpManager;
  63
  64     public SubInterfaceIpv4AddressCustomizer(@Nonnull final FutureJVppCore futureJVppCore,
  65                                              @Nonnull final NamingContext interfaceContext) {
  66         super(futureJVppCore);
  67         this.interfaceContext = checkNotNull(interfaceContext, "interfaceContext should not be null");
  68         this.dumpManager = new DumpCacheManager.DumpCacheManagerBuilder<IpAddressDetailsReplyDump, AddressDumpParams>()
  69                 .withExecutor(createExecutor(futureJVppCore))
  70                 .build();
  71     }
  72
  73     @Override
  74     @Nonnull
  75     public AddressBuilder getBuilder(@Nonnull InstanceIdentifier<Address> id) {
  76         return new AddressBuilder();
  77     }
  78
  79     @Override
  80     public void readCurrentAttributes(@Nonnull InstanceIdentifier<Address> id, @Nonnull AddressBuilder builder,
  81                                       @Nonnull ReadContext ctx)
  82             throws ReadFailedException {
  83         LOG.debug("Reading attributes for sub-interface address: {}", id);
  84
  85         final String subInterfaceName = getSubInterfaceName(id);
  86         final int subInterfaceIndex = interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext());
  87         final Optional<IpAddressDetailsReplyDump> dumpOptional = dumpManager
  88                 .getDump(id, CACHE_KEY, ctx.getModificationCache(), new AddressDumpParams(subInterfaceIndex, false));
  89
  90         final Optional<IpAddressDetails> ipAddressDetails =
  91                 findIpAddressDetailsByIp(dumpOptional, id.firstKeyOf(Address.class).getIp());
  92
  93         if (ipAddressDetails.isPresent()) {
  94             final IpAddressDetails detail = ipAddressDetails.get();
  95             builder.setIp(arrayToIpv4AddressNoZone(detail.ip));
  96             builder.setSubnet(new PrefixLengthBuilder().setPrefixLength(Short.valueOf(detail.prefixLength)).build());
  97
  98             if (LOG.isDebugEnabled()) {
  99                 LOG.debug("Attributes for {} sub-interface (id={}) address {} successfully read: {}",
 100                         subInterfaceName, subInterfaceIndex, id, builder.build());
 101             }
 102         }
 103     }
 104
 105     @Override
 106     public List<AddressKey> getAllIds(@Nonnull InstanceIdentifier<Address> id, @Nonnull ReadContext ctx)
 107             throws ReadFailedException {
 108         LOG.debug("Reading list of keys for sub-interface addresses: {}", id);
 109
 110         final String subInterfaceName = getSubInterfaceName(id);
 111         final int subInterfaceIndex = interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext());
 112         final Optional<IpAddressDetailsReplyDump> dumpOptional = dumpManager
 113                 .getDump(id, CACHE_KEY, ctx.getModificationCache(), new AddressDumpParams(subInterfaceIndex, false));
 114
 115         return getAllIpv4AddressIds(dumpOptional, AddressKey::new);
 116     }
 117
 118     @Override
 119     public void merge(@Nonnull Builder<? extends DataObject> builder, @Nonnull List<Address> readData) {
 120         ((Ipv4Builder) builder).setAddress(readData);
 121     }
 122
 123     private static String getSubInterfaceName(@Nonnull final InstanceIdentifier<Address> id) {
 124         return SubInterfaceUtils.getSubInterfaceName(id.firstKeyOf(Interface.class).getName(),
 125                 Math.toIntExact(id.firstKeyOf(SubInterface.class).getIdentifier()));
 126     }
 127
 128     @Override
 129     public Initialized<Address> init(
 130             @Nonnull final InstanceIdentifier<Address> id, @Nonnull final Address readValue,
 131             @Nonnull final ReadContext ctx) {
 132         return Initialized.create(getCfgId(id), readValue);
 133     }
 134
 135     private InstanceIdentifier<Address> getCfgId(final InstanceIdentifier<Address> id) {
 136         return SubInterfaceCustomizer.getCfgId(RWUtils.cutId(id, SubInterface.class))
 137                 .child(Ipv4.class)
 138                 .child(Address.class, new AddressKey(id.firstKeyOf(Address.class)));
 139     }
 140 }