2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.binding.dom.codec.impl;
10 import static com.google.common.base.Preconditions.checkArgument;
12 import com.google.common.collect.ImmutableCollection;
13 import com.google.common.collect.ImmutableListMultimap;
14 import com.google.common.collect.ImmutableMap;
15 import com.google.common.collect.ImmutableSet;
16 import com.google.common.collect.Iterables;
17 import com.google.common.collect.Lists;
18 import com.google.common.collect.MultimapBuilder.SetMultimapBuilder;
19 import com.google.common.collect.Multimaps;
20 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
21 import java.util.ArrayList;
22 import java.util.Comparator;
23 import java.util.HashMap;
24 import java.util.HashSet;
25 import java.util.LinkedList;
26 import java.util.Optional;
28 import java.util.concurrent.ConcurrentHashMap;
29 import org.eclipse.jdt.annotation.NonNull;
30 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
31 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
32 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
33 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
34 import org.opendaylight.mdsal.binding.runtime.api.CaseRuntimeType;
35 import org.opendaylight.mdsal.binding.runtime.api.ChoiceRuntimeType;
36 import org.opendaylight.yangtools.yang.binding.BindingObject;
37 import org.opendaylight.yangtools.yang.binding.DataContainer;
38 import org.opendaylight.yangtools.yang.binding.DataObject;
39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
40 import org.opendaylight.yangtools.yang.binding.contract.Naming;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
44 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
45 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
46 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
52 * This is a bit tricky. DataObject addressing does not take into account choice/case statements, and hence given:
63 * we will see {@code Baz extends ChildOf<Foo>}, which is how the users would address it in InstanceIdentifier terms.
64 * The implicit assumption being made is that {@code Baz} identifies a particular instantiation and hence provides
65 * unambiguous reference to an effective schema statement.
68 * Unfortunately this does not quite work with groupings, as their generation has changed: we do not have interfaces
69 * that would capture grouping instantiations, hence we do not have a proper addressing point and users need to specify
70 * the interfaces generated in the grouping's definition. These can be very much ambiguous, as a {@code grouping} can be
71 * used in multiple modules independently within an {@code augment} targeting {@code choice}, as each instantiation is
72 * guaranteed to have a unique namespace -- but we do not have the appropriate instantiations of those nodes.
75 * To address this issue we have a two-class lookup mechanism, which relies on the interface generated for the
76 * {@code case} statement to act as the namespace anchor bridging the nodes inside the grouping to the namespace in
77 * which they are instantiated.
80 * Furthermore downstream code relies on historical mechanics, which would guess what the instantiation is, silently
81 * assuming the ambiguity is theoretical and does not occur in practice.
84 * This leads to three classes of addressing, in order descending performance requirements.
86 * <li>Direct DataObject, where we name an exact child</li>
87 * <li>Case DataObject + Grouping DataObject</li>
88 * <li>Grouping DataObject, which is ambiguous</li>
91 * {@link #byCaseChildClass} supports direct DataObject mapping and contains only unambiguous children, while
92 * {@link #byClass} supports indirect mapping and contains {@code case} sub-statements.
94 * {@link #ambiguousByCaseChildClass} contains ambiguous mappings, for which we end up issuing warnings. We track each
95 * ambiguous reference and issue warn once when they are encountered -- tracking warning information in
96 * {@link #ambiguousByCaseChildWarnings}.
98 final class ChoiceCodecContext<D extends DataObject> extends DataContainerCodecContext<D, ChoiceRuntimeType>
99 implements BindingDataObjectCodecTreeNode<D> {
100 private static final Logger LOG = LoggerFactory.getLogger(ChoiceCodecContext.class);
102 private final ImmutableMap<NodeIdentifier, DataContainerCodecPrototype<?>> byYangCaseChild;
103 private final ImmutableListMultimap<Class<?>, DataContainerCodecPrototype<?>> ambiguousByCaseChildClass;
104 private final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byCaseChildClass;
105 private final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byClass;
106 private final Set<Class<?>> ambiguousByCaseChildWarnings;
108 ChoiceCodecContext(final DataContainerCodecPrototype<ChoiceRuntimeType> prototype) {
110 final var byYangCaseChildBuilder = new HashMap<NodeIdentifier, DataContainerCodecPrototype<?>>();
111 final var byClassBuilder = new HashMap<Class<?>, DataContainerCodecPrototype<?>>();
112 final var childToCase = SetMultimapBuilder.hashKeys().hashSetValues()
113 .<Class<?>, DataContainerCodecPrototype<?>>build();
115 // Load case statements valid in this choice and keep track of their names
116 final var choiceType = prototype.getType();
117 final var factory = prototype.getFactory();
118 final var localCases = new HashSet<JavaTypeName>();
119 for (var caseType : choiceType.validCaseChildren()) {
120 @SuppressWarnings("unchecked")
121 final var caseClass = (Class<? extends DataObject>) loadCase(factory.getRuntimeContext(), caseType);
122 final var caseProto = new CaseCodecPrototype(caseClass, caseType, factory);
124 localCases.add(caseType.getIdentifier());
125 byClassBuilder.put(caseClass, caseProto);
127 // Updates collection of case children
128 for (var cazeChild : getChildrenClasses(caseClass)) {
129 childToCase.put(cazeChild, caseProto);
131 // Updates collection of YANG instance identifier to case
132 for (var stmt : caseType.statement().effectiveSubstatements()) {
133 if (stmt instanceof DataSchemaNode cazeChild) {
134 byYangCaseChildBuilder.put(NodeIdentifier.create(cazeChild.getQName()), caseProto);
138 byYangCaseChild = ImmutableMap.copyOf(byYangCaseChildBuilder);
140 // Move unambiguous child->case mappings to byCaseChildClass, removing them from childToCase
141 final var ambiguousByCaseBuilder = ImmutableListMultimap.<Class<?>, DataContainerCodecPrototype<?>>builder();
142 final var unambiguousByCaseBuilder = ImmutableMap.<Class<?>, DataContainerCodecPrototype<?>>builder();
143 for (var entry : Multimaps.asMap(childToCase).entrySet()) {
144 final var cases = entry.getValue();
145 if (cases.size() != 1) {
146 // Sort all possibilities by their FQCN to retain semi-predictable results
147 final var list = new ArrayList<>(entry.getValue());
148 list.sort(Comparator.comparing(proto -> proto.getBindingClass().getCanonicalName()));
149 ambiguousByCaseBuilder.putAll(entry.getKey(), list);
151 unambiguousByCaseBuilder.put(entry.getKey(), cases.iterator().next());
154 byCaseChildClass = unambiguousByCaseBuilder.build();
156 // Setup ambiguous tracking, if needed
157 ambiguousByCaseChildClass = ambiguousByCaseBuilder.build();
158 ambiguousByCaseChildWarnings = ambiguousByCaseChildClass.isEmpty() ? ImmutableSet.of()
159 : ConcurrentHashMap.newKeySet();
162 * Choice/Case mapping across groupings is compile-time unsafe and we therefore need to also track any
163 * CaseRuntimeTypes added to the choice in other contexts. This is necessary to discover when a case represents
164 * equivalent data in a different instantiation context.
166 * This is required due property of binding specification, that if choice is in grouping schema path location is
167 * lost, and users may use incorrect case class using copy builders.
169 final var bySubstitutionBuilder = new HashMap<Class<?>, DataContainerCodecPrototype<?>>();
170 final var context = factory.getRuntimeContext();
171 for (var caseType : context.getTypes().allCaseChildren(choiceType)) {
172 final var caseName = caseType.getIdentifier();
173 if (!localCases.contains(caseName)) {
174 // FIXME: do not rely on class loading here, the check we are performing should be possible on
175 // GeneratedType only -- or it can be provided by BindingRuntimeTypes -- i.e. rather than
176 // 'allCaseChildren()' it would calculate additional mappings we can use off-the-bat.
177 final var substitution = loadCase(context, caseType);
179 search: for (var real : byClassBuilder.entrySet()) {
180 if (isSubstitutionFor(substitution, real.getKey())) {
181 bySubstitutionBuilder.put(substitution, real.getValue());
188 byClassBuilder.putAll(bySubstitutionBuilder);
189 byClass = ImmutableMap.copyOf(byClassBuilder);
192 private static Class<?> loadCase(final BindingRuntimeContext context, final CaseRuntimeType caseType) {
193 final var className = caseType.getIdentifier();
195 return context.loadClass(className);
196 } catch (ClassNotFoundException e) {
197 throw new LinkageError("Failed to load class for " + className, e);
202 public WithStatus getSchema() {
203 // FIXME: Bad cast, we should be returning an EffectiveStatement perhaps?
204 return (WithStatus) getType().statement();
207 @SuppressWarnings("unchecked")
209 public <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(final Class<C> childClass) {
210 final var child = byClass.get(childClass);
211 return (DataContainerCodecContext<C, ?>) childNonNull(child, childClass,
212 "Supplied class %s is not valid case in %s", childClass, bindingArg()).get();
215 @SuppressWarnings("unchecked")
217 public <C extends DataObject> Optional<DataContainerCodecContext<C, ?>> possibleStreamChild(
218 final Class<C> childClass) {
219 final var child = byClass.get(childClass);
221 return Optional.of((DataContainerCodecContext<C, ?>) child.get());
223 return Optional.empty();
226 Iterable<Class<?>> getCaseChildrenClasses() {
227 return Iterables.concat(byCaseChildClass.keySet(), ambiguousByCaseChildClass.keySet());
231 public CodecContext yangPathArgumentChild(final YangInstanceIdentifier.PathArgument arg) {
232 final DataContainerCodecPrototype<?> cazeProto;
233 if (arg instanceof NodeIdentifierWithPredicates) {
234 cazeProto = byYangCaseChild.get(new NodeIdentifier(arg.getNodeType()));
236 cazeProto = byYangCaseChild.get(arg);
239 return childNonNull(cazeProto, arg, "Argument %s is not valid child of %s", arg, getSchema()).get()
240 .yangPathArgumentChild(arg);
244 @SuppressWarnings("unchecked")
245 @SuppressFBWarnings(value = "NP_NONNULL_RETURN_VIOLATION", justification = "See FIXME below")
246 public D deserialize(final NormalizedNode data) {
247 final var casted = checkDataArgument(ChoiceNode.class, data);
248 final var first = Iterables.getFirst(casted.body(), null);
251 // FIXME: this needs to be sorted out
254 final var caze = byYangCaseChild.get(first.name());
255 return (D) caze.getDataObject().deserialize(data);
259 public NormalizedNode serialize(final D data) {
260 return serializeImpl(data);
264 protected Object deserializeObject(final NormalizedNode normalizedNode) {
265 return deserialize(normalizedNode);
269 public PathArgument deserializePathArgument(final YangInstanceIdentifier.PathArgument arg) {
270 checkArgument(getDomPathArgument().equals(arg));
275 public YangInstanceIdentifier.PathArgument serializePathArgument(final PathArgument arg) {
276 // FIXME: check for null, since binding container is null.
277 return getDomPathArgument();
281 public BindingNormalizedNodeCachingCodec<D> createCachingCodec(
282 final ImmutableCollection<Class<? extends BindingObject>> cacheSpecifier) {
283 return createCachingCodec(this, cacheSpecifier);
286 DataContainerCodecContext<?, ?> getCaseByChildClass(final @NonNull Class<? extends DataObject> type) {
287 var result = byCaseChildClass.get(type);
288 if (result == null) {
289 // We have not found an unambiguous result, try ambiguous ones
290 final var inexact = ambiguousByCaseChildClass.get(type);
291 if (!inexact.isEmpty()) {
292 result = inexact.get(0);
293 // Issue a warning, but only once so as not to flood the logs
294 if (ambiguousByCaseChildWarnings.add(type)) {
296 Ambiguous reference {} to child of {} resolved to {}, the first case in {} This mapping is \
297 not guaranteed to be stable and is subject to variations based on runtime circumstances. \
298 Please see the stack trace for hints about the source of ambiguity.""",
299 type, bindingArg(), result.getBindingClass(),
300 Lists.transform(inexact, DataContainerCodecPrototype::getBindingClass), new Throwable());
305 return childNonNull(result, type, "Class %s is not child of any cases for %s", type, bindingArg()).get();
309 * Scans supplied class and returns an iterable of all data children classes.
312 * YANG Modeled Entity derived from DataContainer
313 * @return Iterable of all data children, which have YANG modeled entity
315 // FIXME: MDSAL-780: replace use of this method
316 @SuppressWarnings("unchecked")
317 private static Iterable<Class<? extends DataObject>> getChildrenClasses(final Class<? extends DataContainer> type) {
318 checkArgument(type != null, "Target type must not be null");
319 checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type must be derived from DataContainer");
320 final var ret = new LinkedList<Class<? extends DataObject>>();
321 for (var method : type.getMethods()) {
322 final var entity = getYangModeledReturnType(method, Naming.GETTER_PREFIX);
323 if (entity.isPresent()) {
324 ret.add((Class<? extends DataObject>) entity.orElseThrow());