2 * Copyright (c) 2016 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.honeycomb.lisp.translate.read;
19 import static com.google.common.base.Preconditions.checkNotNull;
20 import static com.google.common.base.Preconditions.checkState;
21 import static io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams.EidType.valueOf;
22 import static io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams.FilterType;
23 import static io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams.MappingsDumpParamsBuilder;
24 import static org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.MapReplyAction.NoAction;
26 import com.google.common.base.Optional;
27 import io.fd.honeycomb.lisp.context.util.EidMappingContext;
28 import io.fd.honeycomb.lisp.translate.read.dump.executor.LocatorDumpExecutor;
29 import io.fd.honeycomb.lisp.translate.read.dump.executor.MappingsDumpExecutor;
30 import io.fd.honeycomb.lisp.translate.read.dump.executor.params.LocatorDumpParams;
31 import io.fd.honeycomb.lisp.translate.read.dump.executor.params.LocatorDumpParams.LocatorDumpParamsBuilder;
32 import io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams;
33 import io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams.QuantityType;
34 import io.fd.honeycomb.lisp.translate.read.trait.MappingFilterProvider;
35 import io.fd.honeycomb.lisp.translate.util.EidTranslator;
36 import io.fd.honeycomb.translate.ModificationCache;
37 import io.fd.honeycomb.translate.read.ReadContext;
38 import io.fd.honeycomb.translate.read.ReadFailedException;
39 import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
40 import io.fd.honeycomb.translate.util.RWUtils;
41 import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
42 import io.fd.honeycomb.translate.vpp.util.AddressTranslator;
43 import io.fd.honeycomb.translate.vpp.util.ByteDataTranslator;
44 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
45 import io.fd.vpp.jvpp.core.dto.LispEidTableDetails;
46 import io.fd.vpp.jvpp.core.dto.LispEidTableDetailsReplyDump;
47 import io.fd.vpp.jvpp.core.dto.LispLocatorDetails;
48 import io.fd.vpp.jvpp.core.dto.LispLocatorDetailsReplyDump;
49 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
50 import java.util.Collections;
51 import java.util.List;
52 import java.util.stream.Collectors;
53 import javax.annotation.Nonnull;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.MapReplyAction;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.MappingId;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.RemoteMappingsBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.RemoteMapping;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.RemoteMappingBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.RemoteMappingKey;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.Eid;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.EidBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.NegativeMappingBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.PositiveMappingBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.negative.mapping.MapReplyBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.positive.mapping.RlocsBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.positive.mapping.rlocs.Locator;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.positive.mapping.rlocs.LocatorBuilder;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.positive.mapping.rlocs.LocatorKey;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.eid.table.grouping.eid.table.VniTable;
71 import org.opendaylight.yangtools.concepts.Builder;
72 import org.opendaylight.yangtools.yang.binding.DataObject;
73 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
74 import org.slf4j.Logger;
75 import org.slf4j.LoggerFactory;
78 * Customizer for reading {@code RemoteMapping}<br>
80 public class RemoteMappingCustomizer extends FutureJVppCustomizer
81 implements ListReaderCustomizer<RemoteMapping, RemoteMappingKey, RemoteMappingBuilder>,
82 EidTranslator, AddressTranslator, ByteDataTranslator, MappingFilterProvider {
84 private static final Logger LOG = LoggerFactory.getLogger(RemoteMappingCustomizer.class);
85 private static final String KEY = RemoteMappingCustomizer.class.getName();
87 private final DumpCacheManager<LispEidTableDetailsReplyDump, MappingsDumpParams> dumpManager;
88 private final DumpCacheManager<LispLocatorDetailsReplyDump, LocatorDumpParams> locatorsDumpManager;
89 private final EidMappingContext remoteMappingContext;
91 public RemoteMappingCustomizer(@Nonnull FutureJVppCore futureJvpp,
92 @Nonnull EidMappingContext remoteMappingContext) {
94 this.remoteMappingContext = checkNotNull(remoteMappingContext, "Remote mappings not present");
96 new DumpCacheManager.DumpCacheManagerBuilder<LispEidTableDetailsReplyDump, MappingsDumpParams>()
97 .withExecutor(new MappingsDumpExecutor(futureJvpp))
99 this.locatorsDumpManager =
100 new DumpCacheManager.DumpCacheManagerBuilder<LispLocatorDetailsReplyDump, LocatorDumpParams>()
101 .withExecutor(new LocatorDumpExecutor(futureJvpp))
107 public RemoteMappingBuilder getBuilder(InstanceIdentifier<RemoteMapping> id) {
108 return new RemoteMappingBuilder();
112 org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.eid.mapping.context.mappings.mapping.Eid eid) {
113 return new EidBuilder().setAddress(eid.getAddress()).setAddressType(eid.getAddressType())
114 .setVirtualNetworkId(eid.getVirtualNetworkId()).build();
118 public void readCurrentAttributes(InstanceIdentifier<RemoteMapping> id, RemoteMappingBuilder builder,
120 throws ReadFailedException {
121 checkState(id.firstKeyOf(RemoteMapping.class) != null, "No key present for id({})", id);
122 checkState(id.firstKeyOf(VniTable.class) != null, "Parent VNI table not specified");
124 final MappingId mappingId = id.firstKeyOf(RemoteMapping.class).getId();
125 checkState(remoteMappingContext.containsEid(mappingId, ctx.getMappingContext()),
126 "No mapping stored for id %s", mappingId);
128 final long vni = id.firstKeyOf(VniTable.class).getVirtualNetworkIdentifier();
129 final String remoteMappingId = id.firstKeyOf(RemoteMapping.class).getId().getValue();
130 final Eid eid = copyEid(remoteMappingContext.getEid(mappingId, ctx.getMappingContext()));
131 final MappingsDumpParams dumpParams = new MappingsDumpParamsBuilder()
132 .setVni(Long.valueOf(vni).intValue())
133 .setEidSet(QuantityType.SPECIFIC)
134 .setEidType(getEidType(eid))
135 .setEid(getEidAsByteArray(eid))
136 .setPrefixLength(getPrefixLength(eid))
137 .setFilter(FilterType.REMOTE)
140 LOG.debug("Dumping data for LocalMappings(id={})", id);
141 final Optional<LispEidTableDetailsReplyDump> replyOptional =
142 dumpManager.getDump(id, bindKey("SPECIFIC_" + remoteMappingId), ctx.getModificationCache(), dumpParams);
144 if (!replyOptional.isPresent() || replyOptional.get().lispEidTableDetails.isEmpty()) {
148 LOG.debug("Valid dump loaded");
150 LispEidTableDetails details = replyOptional.get().lispEidTableDetails.stream()
151 .filter(subtableFilterForRemoteMappings(id))
152 .filter(a -> compareAddresses(eid.getAddress(),
153 getArrayAsEidLocal(valueOf(a.eidType), a.eid, a.vni).getAddress()))
155 RWUtils.singleItemCollector());
157 builder.setEid(getArrayAsEidRemote(valueOf(details.eidType), details.eid, details.vni));
158 builder.setKey(new RemoteMappingKey(new MappingId(id.firstKeyOf(RemoteMapping.class).getId())));
159 builder.setTtl(resolveTtl(details.ttl));
160 builder.setAuthoritative(
161 new RemoteMapping.Authoritative(byteToBoolean(details.authoritative)));
162 resolverMappings(id, builder, details, ctx.getModificationCache());
165 //compensate ~0 as default value of ttl
166 private static long resolveTtl(final int ttlValue) {
167 return ttlValue == -1
173 public List<RemoteMappingKey> getAllIds(InstanceIdentifier<RemoteMapping> id, ReadContext context)
174 throws ReadFailedException {
176 checkState(id.firstKeyOf(VniTable.class) != null, "Parent VNI table not specified");
177 final int vni = id.firstKeyOf(VniTable.class).getVirtualNetworkIdentifier().intValue();
180 // ignoring default vni mapping
181 // it's not relevant for us and we also don't store mapping for such eid's
182 // such mapping is used to create helper local mappings to process remote ones
183 return Collections.emptyList();
186 //requesting all remote with specific vni
187 final MappingsDumpParams dumpParams = new MappingsDumpParamsBuilder()
188 .setEidSet(QuantityType.ALL)
189 .setFilter(FilterType.REMOTE)
192 LOG.debug("Dumping data for LocalMappings(id={})", id);
193 final Optional<LispEidTableDetailsReplyDump> replyOptional =
194 dumpManager.getDump(id, bindKey("ALL_REMOTE"), context.getModificationCache(), dumpParams);
196 if (!replyOptional.isPresent() || replyOptional.get().lispEidTableDetails.isEmpty()) {
197 return Collections.emptyList();
200 return replyOptional.get()
203 .filter(a -> a.vni == vni)
204 .filter(subtableFilterForRemoteMappings(id))
205 .map(detail -> getArrayAsEidRemote(valueOf(detail.eidType), detail.eid, detail.vni))
206 .map(remoteEid -> remoteMappingContext.getId(remoteEid, context.getMappingContext()))
208 .map(RemoteMappingKey::new)
209 .collect(Collectors.toList());
213 public void merge(Builder<? extends DataObject> builder, List<RemoteMapping> readData) {
214 ((RemoteMappingsBuilder) builder).setRemoteMapping(readData);
217 private String bindKey(String prefix) {
218 return prefix + "_" + KEY;
221 private void resolverMappings(final InstanceIdentifier id, final RemoteMappingBuilder builder,
222 final LispEidTableDetails details,
223 final ModificationCache cache) throws ReadFailedException {
225 if (details.action != 0) {
226 // in this case ,negative action was defined
227 bindNegativeMapping(builder, MapReplyAction.forValue(details.action));
229 // in this case, there is no clear determination whether negative action with NO_ACTION(value == 0) was defined,
230 // or if its default value and remote locators, are defined, so only chance to determine so, is to dump locators for this mapping
232 // cache key needs to have locator set scope to not mix with cached data
233 final Optional<LispLocatorDetailsReplyDump> reply;
235 reply = locatorsDumpManager.getDump(id, KEY + "_locator_set_" + details.locatorSetIndex, cache,
236 new LocatorDumpParamsBuilder().setLocatorSetIndex(details.locatorSetIndex).build());
237 } catch (ReadFailedException e) {
238 throw new ReadFailedException(id,
239 new IllegalStateException("Unable to resolve Positive/Negative mapping for RemoteMapping",
243 if (!reply.isPresent() || reply.get().lispLocatorDetails.isEmpty()) {
244 // no remote locators exist, therefore there was NO_ACTION defined
245 bindNegativeMapping(builder, NoAction);
247 // bind remote locators
248 bindPositiveMapping(builder, reply.get());
253 private void bindNegativeMapping(final RemoteMappingBuilder builder,
254 final MapReplyAction action) {
255 builder.setLocatorList(
256 new NegativeMappingBuilder().setMapReply(new MapReplyBuilder().setMapReplyAction(action).build())
260 private void bindPositiveMapping(final RemoteMappingBuilder builder, final LispLocatorDetailsReplyDump reply) {
261 builder.setLocatorList(
262 new PositiveMappingBuilder()
268 .map(this::detailsToLocator)
269 .collect(Collectors.toList()))
276 private Locator detailsToLocator(final LispLocatorDetails details) {
277 final IpAddress address = arrayToIpAddressReversed(byteToBoolean(details.isIpv6), details.ipAddress);
278 return new LocatorBuilder()
280 .setKey(new LocatorKey(address))
281 .setPriority((short) details.priority)
282 .setWeight((short) details.weight)