2 * Copyright (c) 2017 Cisco and/or its affiliates.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 package io.fd.hc2vpp.v3po.interfacesstate.ip.v6.subinterface;
20 import static com.google.common.base.Preconditions.checkNotNull;
22 import com.google.common.base.Optional;
23 import com.google.common.collect.ImmutableSet;
24 import io.fd.hc2vpp.common.translate.util.FutureJVppCustomizer;
25 import io.fd.hc2vpp.common.translate.util.NamingContext;
26 import io.fd.hc2vpp.v3po.interfacesstate.SubInterfaceCustomizer;
27 import io.fd.hc2vpp.v3po.interfacesstate.ip.IpReader;
28 import io.fd.hc2vpp.v3po.interfacesstate.ip.dump.params.IfaceDumpFilter;
29 import io.fd.hc2vpp.v3po.util.SubInterfaceUtils;
30 import io.fd.honeycomb.translate.read.ReadContext;
31 import io.fd.honeycomb.translate.read.ReadFailedException;
32 import io.fd.honeycomb.translate.spi.read.Initialized;
33 import io.fd.honeycomb.translate.spi.read.InitializingListReaderCustomizer;
34 import io.fd.honeycomb.translate.util.RWUtils;
35 import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
36 import io.fd.honeycomb.translate.util.read.cache.TypeAwareIdentifierCacheKeyFactory;
37 import io.fd.vpp.jvpp.core.dto.IpAddressDetails;
38 import io.fd.vpp.jvpp.core.dto.IpAddressDetailsReplyDump;
39 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
40 import java.util.List;
41 import javax.annotation.Nonnull;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.interfaces.state._interface.sub.interfaces.SubInterface;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip6.attributes.Ipv6;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip6.attributes.Ipv6Builder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip6.attributes.ipv6.Address;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip6.attributes.ipv6.AddressBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip6.attributes.ipv6.AddressKey;
49 import org.opendaylight.yangtools.concepts.Builder;
50 import org.opendaylight.yangtools.yang.binding.DataObject;
51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
55 public class SubInterfaceIpv6AddressCustomizer extends FutureJVppCustomizer
56 implements InitializingListReaderCustomizer<Address, AddressKey, AddressBuilder>, IpReader {
58 private static final Logger LOG = LoggerFactory.getLogger(SubInterfaceIpv6AddressCustomizer.class);
60 private final NamingContext interfaceContext;
61 private final DumpCacheManager<IpAddressDetailsReplyDump, IfaceDumpFilter> dumpManager;
63 public SubInterfaceIpv6AddressCustomizer(@Nonnull final FutureJVppCore futureJVppCore,
64 @Nonnull final NamingContext interfaceContext) {
65 super(futureJVppCore);
66 this.interfaceContext = checkNotNull(interfaceContext, "interfaceContext should not be null");
67 this.dumpManager = new DumpCacheManager.DumpCacheManagerBuilder<IpAddressDetailsReplyDump, IfaceDumpFilter>()
68 .withExecutor(createAddressDumpExecutor(futureJVppCore))
69 .withCacheKeyFactory(new TypeAwareIdentifierCacheKeyFactory(IpAddressDetailsReplyDump.class,
70 ImmutableSet.of(SubInterface.class)))
74 private static String getSubInterfaceName(@Nonnull final InstanceIdentifier<Address> id) {
75 return SubInterfaceUtils.getSubInterfaceName(id.firstKeyOf(Interface.class).getName(),
76 Math.toIntExact(id.firstKeyOf(SubInterface.class).getIdentifier()));
81 public AddressBuilder getBuilder(@Nonnull InstanceIdentifier<Address> id) {
82 return new AddressBuilder();
86 public void readCurrentAttributes(@Nonnull InstanceIdentifier<Address> id, @Nonnull AddressBuilder builder,
87 @Nonnull ReadContext ctx)
88 throws ReadFailedException {
89 LOG.debug("Reading attributes for sub-interface address: {}", id);
91 final String subInterfaceName = getSubInterfaceName(id);
92 final int subInterfaceIndex = interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext());
93 final Optional<IpAddressDetailsReplyDump> dumpOptional = dumpManager
94 .getDump(id, ctx.getModificationCache(), new IfaceDumpFilter(subInterfaceIndex, false));
96 final Optional<IpAddressDetails> ipAddressDetails =
97 findIpv6AddressDetailsByIp(dumpOptional, id.firstKeyOf(Address.class).getIp());
99 if (ipAddressDetails.isPresent()) {
100 final IpAddressDetails detail = ipAddressDetails.get();
101 builder.setIp(arrayToIpv6AddressNoZone(detail.ip));
102 builder.setPrefixLength((short) detail.prefixLength);
104 if (LOG.isDebugEnabled()) {
105 LOG.debug("Attributes for {} sub-interface (id={}) address {} successfully read: {}",
106 subInterfaceName, subInterfaceIndex, id, builder.build());
113 public List<AddressKey> getAllIds(@Nonnull InstanceIdentifier<Address> id, @Nonnull ReadContext ctx)
114 throws ReadFailedException {
115 LOG.debug("Reading list of keys for sub-interface addresses: {}", id);
117 final String subInterfaceName = getSubInterfaceName(id);
118 final int subInterfaceIndex = interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext());
119 final Optional<IpAddressDetailsReplyDump> dumpOptional = dumpManager
120 .getDump(id, ctx.getModificationCache(), new IfaceDumpFilter(subInterfaceIndex, false));
122 return getAllIpv6AddressIds(dumpOptional, AddressKey::new);
126 public void merge(@Nonnull Builder<? extends DataObject> builder, @Nonnull List<Address> readData) {
127 ((Ipv6Builder) builder).setAddress(readData);
132 public Initialized<Address> init(
133 @Nonnull final InstanceIdentifier<Address> id, @Nonnull final Address readValue,
134 @Nonnull final ReadContext ctx) {
135 return Initialized.create(getCfgId(id), readValue);
138 private InstanceIdentifier<Address> getCfgId(final InstanceIdentifier<Address> id) {
139 return SubInterfaceCustomizer.getCfgId(RWUtils.cutId(id, SubInterface.class))
141 .child(Address.class, new AddressKey(id.firstKeyOf(Address.class)));