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 com.google.common.base.Preconditions;
  23 import io.fd.honeycomb.translate.read.ReadContext;
  24 import io.fd.honeycomb.translate.read.ReadFailedException;
  25 import io.fd.honeycomb.translate.spi.read.Initialized;
  26 import io.fd.honeycomb.translate.spi.read.InitializingListReaderCustomizer;
  27 import io.fd.honeycomb.translate.util.RWUtils;
  28 import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
  29 import io.fd.honeycomb.translate.v3po.interfacesstate.InterfaceCustomizer;
  30 import io.fd.honeycomb.translate.v3po.interfacesstate.ip.dump.params.AddressDumpParams;
  31 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  32 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  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.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv4;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.address.Subnet;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.Ipv4Builder;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.Address;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.AddressBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.AddressKey;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLengthBuilder;
  47 import org.opendaylight.yangtools.concepts.Builder;
  48 import org.opendaylight.yangtools.yang.binding.DataObject;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 /**
  54  * Read customizer for interface Ipv4 addresses.
  55  */
  56 public class Ipv4AddressCustomizer extends FutureJVppCustomizer
  57         implements InitializingListReaderCustomizer<Address, AddressKey, AddressBuilder>, Ipv4Reader {
  58
  59     private static final Logger LOG = LoggerFactory.getLogger(Ipv4AddressCustomizer.class);
  60     private static final String CACHE_KEY = Ipv4AddressCustomizer.class.getName();
  61
  62     private final NamingContext interfaceContext;
  63     private final DumpCacheManager<IpAddressDetailsReplyDump, AddressDumpParams> dumpManager;
  64
  65     public Ipv4AddressCustomizer(@Nonnull final FutureJVppCore futureJVppCore,
  66                                  @Nonnull final NamingContext interfaceContext) {
  67         super(futureJVppCore);
  68         this.interfaceContext = checkNotNull(interfaceContext, "interfaceContext should not be null");
  69         this.dumpManager = new DumpCacheManager.DumpCacheManagerBuilder<IpAddressDetailsReplyDump, AddressDumpParams>()
  70                 .withExecutor(createExecutor(futureJVppCore))
  71                 .build();
  72     }
  73
  74     @Override
  75     @Nonnull
  76     public AddressBuilder getBuilder(@Nonnull InstanceIdentifier<Address> id) {
  77         return new AddressBuilder();
  78     }
  79
  80     @Override
  81     public void readCurrentAttributes(@Nonnull InstanceIdentifier<Address> id, @Nonnull AddressBuilder builder,
  82                                       @Nonnull ReadContext ctx)
  83             throws ReadFailedException {
  84         LOG.debug("Reading attributes for interface address: {}", id);
  85
  86         final String interfaceName = id.firstKeyOf(Interface.class).getName();
  87         final int interfaceIndex = interfaceContext.getIndex(interfaceName, ctx.getMappingContext());
  88         // Key needs to contain interface ID to distinguish dumps between interfaces
  89         final String cacheKey = CACHE_KEY + interfaceName;
  90         final Optional<IpAddressDetailsReplyDump> dumpOptional = dumpManager
  91                 .getDump(id, cacheKey, ctx.getModificationCache(), new AddressDumpParams(interfaceIndex, false));
  92
  93         if (!dumpOptional.isPresent() || dumpOptional.get().ipAddressDetails.isEmpty()) {
  94             return;
  95         }
  96         final Optional<IpAddressDetails> ipAddressDetails =
  97                 findIpAddressDetailsByIp(dumpOptional, id.firstKeyOf(Address.class).getIp());
  98
  99         if (ipAddressDetails.isPresent()) {
 100             final IpAddressDetails detail = ipAddressDetails.get();
 101             builder.setIp(arrayToIpv4AddressNoZone(detail.ip))
 102                     .setSubnet(
 103                             new PrefixLengthBuilder().setPrefixLength(Short.valueOf(detail.prefixLength)).build());
 104
 105             if (LOG.isDebugEnabled()) {
 106                 LOG.debug("Attributes for {} interface (id={}) address {} successfully read: {}",
 107                         interfaceName, interfaceIndex, id, builder.build());
 108             }
 109         }
 110     }
 111
 112     @Override
 113     public List<AddressKey> getAllIds(@Nonnull InstanceIdentifier<Address> id, @Nonnull ReadContext ctx)
 114             throws ReadFailedException {
 115         LOG.debug("Reading list of keys for interface addresses: {}", id);
 116
 117         final String interfaceName = id.firstKeyOf(Interface.class).getName();
 118         final int interfaceIndex = interfaceContext.getIndex(interfaceName, ctx.getMappingContext());
 119         // Key needs to contain interface ID to distinguish dumps between interfaces
 120         final String cacheKey = CACHE_KEY + interfaceName;
 121         final Optional<IpAddressDetailsReplyDump> dumpOptional = dumpManager
 122                 .getDump(id, cacheKey, ctx.getModificationCache(), new AddressDumpParams(interfaceIndex, false));
 123
 124         return getAllIpv4AddressIds(dumpOptional, AddressKey::new);
 125     }
 126
 127     @Override
 128     public void merge(@Nonnull Builder<? extends DataObject> builder, @Nonnull List<Address> readData) {
 129         ((Ipv4Builder) builder).setAddress(readData);
 130     }
 131
 132     @Override
 133     public Initialized<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address> init(
 134             @Nonnull final InstanceIdentifier<Address> id, @Nonnull final Address readValue,
 135             @Nonnull final ReadContext ctx) {
 136         return Initialized.create(getCfgId(id),
 137                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.AddressBuilder()
 138                         .setIp(readValue.getIp())
 139                         .setSubnet(getSubnet(readValue))
 140                         .build());
 141     }
 142
 143     private static Subnet getSubnet(final Address address) {
 144         final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.Subnet
 145                 subnet = address.getSubnet();
 146
 147         // Only prefix length supported
 148         Preconditions.checkArgument(
 149                 subnet instanceof org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLength);
 150
 151         return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.address.subnet.PrefixLengthBuilder()
 152                 .setPrefixLength(
 153                 ((org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLength) subnet)
 154                         .getPrefixLength()).build();
 155     }
 156
 157     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address> getCfgId(
 158             final InstanceIdentifier<Address> id) {
 159         return InterfaceCustomizer.getCfgId(RWUtils.cutId(id, Interface.class))
 160                 .augmentation(Interface1.class)
 161                 .child(Ipv4.class)
 162                 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address.class,
 163                         new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.AddressKey(id.firstKeyOf(Address.class).getIp()));
 164     }
 165 }