package org.opendaylight.mdsal.binding.dom.codec.impl;
import static com.google.common.base.Preconditions.checkArgument;
-import static com.google.common.base.Verify.verify;
-import static java.util.Objects.requireNonNull;
import com.google.common.annotations.Beta;
import com.google.common.base.Throwables;
+import com.google.common.base.VerifyException;
+import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableMap;
-import com.google.common.collect.ImmutableMap.Builder;
+import com.google.common.collect.ImmutableSet;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.MethodType;
+import java.lang.invoke.VarHandle;
import java.lang.reflect.Method;
import java.util.HashMap;
-import java.util.Iterator;
import java.util.List;
import java.util.Map;
-import java.util.Map.Entry;
-import java.util.Optional;
-import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
-import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
-import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
+import org.opendaylight.mdsal.binding.model.api.GeneratedType;
import org.opendaylight.mdsal.binding.model.api.Type;
-import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
-import org.opendaylight.yangtools.concepts.Immutable;
-import org.opendaylight.yangtools.util.ClassLoaderUtils;
+import org.opendaylight.mdsal.binding.runtime.api.AugmentRuntimeType;
+import org.opendaylight.mdsal.binding.runtime.api.AugmentableRuntimeType;
+import org.opendaylight.mdsal.binding.runtime.api.CompositeRuntimeType;
import org.opendaylight.yangtools.yang.binding.Augmentable;
import org.opendaylight.yangtools.yang.binding.Augmentation;
+import org.opendaylight.yangtools.yang.binding.BindingObject;
import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.Item;
-import org.opendaylight.yangtools.yang.binding.OpaqueObject;
+import org.opendaylight.yangtools.yang.binding.DataObjectStep;
import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
-import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
+import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
-import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
-import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
+import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
+import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
* This class is an implementation detail. It is public only due to technical reasons and may change at any time.
*/
@Beta
-public abstract class DataObjectCodecContext<D extends DataObject, T extends DataNodeContainer & WithStatus>
- extends DataContainerCodecContext<D, T> {
- private static final class Augmentations implements Immutable {
- final ImmutableMap<YangInstanceIdentifier.PathArgument, DataContainerCodecPrototype<?>> byYang;
- final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byStream;
-
- Augmentations(final ImmutableMap<YangInstanceIdentifier.PathArgument, DataContainerCodecPrototype<?>> byYang,
- final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byStream) {
- this.byYang = requireNonNull(byYang);
- this.byStream = requireNonNull(byStream);
- }
- }
-
+public abstract sealed class DataObjectCodecContext<D extends DataObject, T extends CompositeRuntimeType>
+ extends AbstractDataObjectCodecContext<D, T> implements BindingDataObjectCodecTreeNode<D>
+ permits CaseCodecContext, ContainerLikeCodecContext, ListCodecContext, NotificationCodecContext {
private static final Logger LOG = LoggerFactory.getLogger(DataObjectCodecContext.class);
+
private static final MethodType CONSTRUCTOR_TYPE = MethodType.methodType(void.class,
- DataObjectCodecContext.class, NormalizedNodeContainer.class);
+ AbstractDataObjectCodecContext.class, DataContainerNode.class);
private static final MethodType DATAOBJECT_TYPE = MethodType.methodType(DataObject.class,
- DataObjectCodecContext.class, NormalizedNodeContainer.class);
- private static final Augmentations EMPTY_AUGMENTATIONS = new Augmentations(ImmutableMap.of(), ImmutableMap.of());
-
- private final ImmutableMap<String, ValueNodeCodecContext> leafChild;
- private final ImmutableMap<YangInstanceIdentifier.PathArgument, NodeContextSupplier> byYang;
- private final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byStreamClass;
- private final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byBindingArgClass;
- private final ImmutableMap<AugmentationIdentifier, Type> possibleAugmentations;
- private final MethodHandle proxyConstructor;
+ DataObjectCodecContext.class, DataContainerNode.class);
+ private static final VarHandle MISMATCHED_AUGMENTED;
- // FIXME: the presence of these two volatile fields may be preventing us from being able to improve
- // DataContainerCodecPrototype.get() publication.
- @SuppressWarnings("rawtypes")
- private static final AtomicReferenceFieldUpdater<DataObjectCodecContext, Augmentations>
- AUGMENTATIONS_UPDATER = AtomicReferenceFieldUpdater.newUpdater(DataObjectCodecContext.class,
- Augmentations.class, "augmentations");
- private volatile Augmentations augmentations = EMPTY_AUGMENTATIONS;
-
- private volatile ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> mismatchedAugmented = ImmutableMap.of();
-
- DataObjectCodecContext(final DataContainerCodecPrototype<T> prototype) {
- this(prototype, null);
+ static {
+ try {
+ MISMATCHED_AUGMENTED = MethodHandles.lookup().findVarHandle(DataObjectCodecContext.class,
+ "mismatchedAugmented", ImmutableMap.class);
+ } catch (NoSuchFieldException | IllegalAccessException e) {
+ throw new ExceptionInInitializerError(e);
+ }
}
- DataObjectCodecContext(final DataContainerCodecPrototype<T> prototype, final Method keyMethod) {
- super(prototype);
+ private final ImmutableMap<Class<?>, AugmentationCodecPrototype> augmentToPrototype;
+ private final ImmutableMap<NodeIdentifier, Class<?>> yangToAugmentClass;
+ private final @NonNull Class<? extends CodecDataObject<?>> generatedClass;
+ private final MethodHandle proxyConstructor;
- final Class<D> bindingClass = getBindingClass();
+ // Note this the content of this field depends only of invariants expressed as this class's fields or
+ // BindingRuntimeContext. It is only accessed via MISMATCHED_AUGMENTED above.
+ @SuppressWarnings("unused")
+ @SuppressFBWarnings(value = "URF_UNREAD_FIELD", justification = "https://github.com/spotbugs/spotbugs/issues/2749")
+ private volatile ImmutableMap<Class<?>, CommonDataObjectCodecPrototype<?>> mismatchedAugmented = ImmutableMap.of();
- final ImmutableMap<Method, ValueNodeCodecContext> tmpLeaves = factory().getLeafNodes(bindingClass, getSchema());
- final Map<Class<?>, Method> clsToMethod = BindingReflections.getChildrenClassToMethod(bindingClass);
+ DataObjectCodecContext(final CommonDataObjectCodecPrototype<T> prototype) {
+ this(prototype, CodecItemFactory.of());
+ }
- final Map<YangInstanceIdentifier.PathArgument, NodeContextSupplier> byYangBuilder = new HashMap<>();
- final Map<Class<?>, DataContainerCodecPrototype<?>> byStreamClassBuilder = new HashMap<>();
- final Map<Class<?>, DataContainerCodecPrototype<?>> byBindingArgClassBuilder = new HashMap<>();
+ DataObjectCodecContext(final CommonDataObjectCodecPrototype<T> prototype, final CodecItemFactory itemFactory) {
+ this(prototype, new DataContainerAnalysis<>(prototype, itemFactory), null);
+ }
- // Adds leaves to mapping
- final Builder<String, ValueNodeCodecContext> leafChildBuilder =
- ImmutableMap.builderWithExpectedSize(tmpLeaves.size());
- for (final Entry<Method, ValueNodeCodecContext> entry : tmpLeaves.entrySet()) {
- final ValueNodeCodecContext leaf = entry.getValue();
- leafChildBuilder.put(leaf.getSchema().getQName().getLocalName(), leaf);
- byYangBuilder.put(leaf.getDomPathArgument(), leaf);
- }
- this.leafChild = leafChildBuilder.build();
+ DataObjectCodecContext(final CommonDataObjectCodecPrototype<T> prototype, final Method keyMethod) {
+ this(prototype, new DataContainerAnalysis<>(prototype, CodecItemFactory.of()), keyMethod);
+ }
- final Map<Method, Class<?>> tmpDataObjects = new HashMap<>();
- for (final Entry<Class<?>, Method> childDataObj : clsToMethod.entrySet()) {
- final Method method = childDataObj.getValue();
- verify(!method.isDefault(), "Unexpected default method %s in %s", method, bindingClass);
+ private DataObjectCodecContext(final CommonDataObjectCodecPrototype<T> prototype,
+ final DataContainerAnalysis<T> analysis, final Method keyMethod) {
+ super(prototype, analysis);
- final Class<?> retClass = childDataObj.getKey();
- if (OpaqueObject.class.isAssignableFrom(retClass)) {
- // Filter OpaqueObjects, they are not containers
- continue;
- }
+ final var bindingClass = getBindingClass();
- final DataContainerCodecPrototype<?> childProto = loadChildPrototype(retClass);
- tmpDataObjects.put(method, childProto.getBindingClass());
- byStreamClassBuilder.put(childProto.getBindingClass(), childProto);
- byYangBuilder.put(childProto.getYangArg(), childProto);
- if (childProto.isChoice()) {
- final ChoiceNodeCodecContext<?> choice = (ChoiceNodeCodecContext<?>) childProto.get();
- for (final Class<?> cazeChild : choice.getCaseChildrenClasses()) {
- byBindingArgClassBuilder.put(cazeChild, childProto);
- }
+ // Final bits: generate the appropriate class, As a side effect we identify what Augmentations are possible
+ final List<AugmentRuntimeType> possibleAugmentations;
+ final var loader = prototype().contextFactory().getLoader();
+ if (Augmentable.class.isAssignableFrom(bindingClass)) {
+ // Verify we have the appropriate backing runtimeType
+ final var runtimeType = prototype.runtimeType();
+ if (!(runtimeType instanceof AugmentableRuntimeType augmentableRuntimeType)) {
+ throw new VerifyException(
+ "Unexpected type %s backing augmenable %s".formatted(runtimeType, bindingClass));
}
- }
-
- this.byYang = ImmutableMap.copyOf(byYangBuilder);
- this.byStreamClass = ImmutableMap.copyOf(byStreamClassBuilder);
-
- // Slight footprint optimization: we do not want to copy byStreamClass, as that would force its entrySet view
- // to be instantiated. Furthermore the two maps can easily end up being equal -- hence we can reuse
- // byStreamClass for the purposes of both.
- byBindingArgClassBuilder.putAll(byStreamClassBuilder);
- this.byBindingArgClass = byStreamClassBuilder.equals(byBindingArgClassBuilder) ? this.byStreamClass
- : ImmutableMap.copyOf(byBindingArgClassBuilder);
- final Class<? extends CodecDataObject<?>> generatedClass;
- if (Augmentable.class.isAssignableFrom(bindingClass)) {
- this.possibleAugmentations = factory().getRuntimeContext().getAvailableAugmentationTypes(getSchema());
- generatedClass = CodecDataObjectGenerator.generateAugmentable(prototype.getFactory().getLoader(),
- bindingClass, tmpLeaves, tmpDataObjects, keyMethod);
+ possibleAugmentations = augmentableRuntimeType.augments();
+ generatedClass = CodecDataObjectGenerator.generateAugmentable(loader, bindingClass, analysis.leafContexts,
+ analysis.daoProperties, keyMethod);
} else {
- this.possibleAugmentations = ImmutableMap.of();
- generatedClass = CodecDataObjectGenerator.generate(prototype.getFactory().getLoader(), bindingClass,
- tmpLeaves, tmpDataObjects, keyMethod);
+ possibleAugmentations = List.of();
+ generatedClass = CodecDataObjectGenerator.generate(loader, bindingClass, analysis.leafContexts,
+ analysis.daoProperties, keyMethod);
}
- reloadAllAugmentations();
+ // All done: acquire the constructor: it is supposed to be public
final MethodHandle ctor;
try {
ctor = MethodHandles.publicLookup().findConstructor(generatedClass, CONSTRUCTOR_TYPE);
}
proxyConstructor = ctor.asType(DATAOBJECT_TYPE);
- }
- // This method could be synchronized, but that would mean that concurrent attempts to load an invalid augmentation
- // would end up being unnecessarily contended -- blocking real progress and not being able to run concurrently
- // while producing no effect. We therefore use optimistic read + CAS.
- private void reloadAllAugmentations() {
- // Load current values
- Augmentations oldAugmentations = augmentations;
-
- // FIXME: can we detect when we have both maps fully populated and skip all of this?
-
- // Scratch space for additions
- final Map<PathArgument, DataContainerCodecPrototype<?>> addByYang = new HashMap<>();
- final Map<Class<?>, DataContainerCodecPrototype<?>> addByStream = new HashMap<>();
-
- // Iterate over all possibilities, checking for modifications.
- for (final Type augment : possibleAugmentations.values()) {
- final DataContainerCodecPrototype<?> augProto = getAugmentationPrototype(augment);
+ // Deal with augmentations, which are not something we analysis provides
+ final var augPathToBinding = new HashMap<NodeIdentifier, Class<?>>();
+ final var augClassToProto = new HashMap<Class<?>, AugmentationCodecPrototype<?>>();
+ for (var augment : possibleAugmentations) {
+ final var augProto = loadAugmentPrototype(augment);
if (augProto != null) {
- final PathArgument yangArg = augProto.getYangArg();
- final Class<?> bindingClass = augProto.getBindingClass();
- if (!oldAugmentations.byYang.containsKey(yangArg)) {
- if (addByYang.putIfAbsent(yangArg, augProto) == null) {
- LOG.trace("Discovered new YANG mapping {} -> {} in {}", yangArg, augProto, this);
- }
- }
- if (!oldAugmentations.byStream.containsKey(bindingClass)) {
- if (addByStream.putIfAbsent(bindingClass, augProto) == null) {
- LOG.trace("Discovered new class mapping {} -> {} in {}", bindingClass, augProto, this);
- }
+ final var augBindingClass = augProto.javaClass();
+ for (var childPath : augProto.getChildArgs()) {
+ augPathToBinding.putIfAbsent(childPath, augBindingClass);
}
+ augClassToProto.putIfAbsent(augBindingClass, augProto);
}
}
-
- while (true) {
- if (addByYang.isEmpty() && addByStream.isEmpty()) {
- LOG.trace("No new augmentations discovered in {}", this);
- return;
- }
-
- // We have some additions, propagate them out
- final Augmentations newAugmentations = new Augmentations(concatMaps(oldAugmentations.byYang, addByYang),
- concatMaps(oldAugmentations.byStream, addByStream));
- if (AUGMENTATIONS_UPDATER.compareAndSet(this, oldAugmentations, newAugmentations)) {
- // Success, we are done
- return;
- }
-
- // We have raced installing new augmentations, read them again, remove everything present in the installed
- // once and try again. This may mean that we end up not doing anything, but that's fine.
- oldAugmentations = augmentations;
-
- // We could use Map.removeAll(oldAugmentations.byYang.keySet()), but that forces the augmentation's keyset
- // to be materialized, which we otherwise do not need. Hence we do this the other way around, instantiating
- // our temporary maps' keySets and iterating over them. That's fine as we'll be throwing those maps away.
- removeMapKeys(addByYang, oldAugmentations.byYang);
- removeMapKeys(addByStream, oldAugmentations.byStream);
- }
- }
-
- private static <K, V> ImmutableMap<K, V> concatMaps(final ImmutableMap<K, V> old, final Map<K, V> add) {
- if (add.isEmpty()) {
- return old;
- }
-
- final Builder<K, V> builder = ImmutableMap.builderWithExpectedSize(old.size() + add.size());
- builder.putAll(old);
- builder.putAll(add);
- return builder.build();
- }
-
- private static <K, V> void removeMapKeys(final Map<K, V> removeFrom, final ImmutableMap<K, V> map) {
- final Iterator<K> it = removeFrom.keySet().iterator();
- while (it.hasNext()) {
- if (map.containsKey(it.next())) {
- it.remove();
- }
- }
+ yangToAugmentClass = ImmutableMap.copyOf(augPathToBinding);
+ augmentToPrototype = ImmutableMap.copyOf(augClassToProto);
}
- @SuppressWarnings("unchecked")
@Override
- public <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(final Class<C> childClass) {
- final DataContainerCodecPrototype<?> childProto = streamChildPrototype(childClass);
- return (DataContainerCodecContext<C, ?>) childNonNull(childProto, childClass, " Child %s is not valid child.",
- childClass).get();
+ final DataContainerPrototype<?, ?> pathChildPrototype(final Class<? extends DataObject> argType) {
+ final var child = super.pathChildPrototype(argType);
+ return child != null ? child : augmentToPrototype.get(argType);
}
- private DataContainerCodecPrototype<?> streamChildPrototype(final Class<?> childClass) {
- final DataContainerCodecPrototype<?> childProto = byStreamClass.get(childClass);
- if (childProto != null) {
- return childProto;
- }
- if (Augmentation.class.isAssignableFrom(childClass)) {
- return augmentationByClass(childClass);
- }
- return null;
- }
-
- @SuppressWarnings("unchecked")
@Override
- public <C extends DataObject> Optional<DataContainerCodecContext<C, ?>> possibleStreamChild(
- final Class<C> childClass) {
- final DataContainerCodecPrototype<?> childProto = streamChildPrototype(childClass);
- if (childProto != null) {
- return Optional.of((DataContainerCodecContext<C, ?>) childProto.get());
+ final DataContainerPrototype<?, ?> streamChildPrototype(final Class<?> childClass) {
+ final var child = super.streamChildPrototype(childClass);
+ if (child == null && Augmentation.class.isAssignableFrom(childClass)) {
+ return getAugmentationProtoByClass(childClass);
}
- return Optional.empty();
+ return child;
}
@Override
- public DataContainerCodecContext<?,?> bindingPathArgumentChild(final InstanceIdentifier.PathArgument arg,
- final List<YangInstanceIdentifier.PathArgument> builder) {
-
- final Class<? extends DataObject> argType = arg.getType();
- DataContainerCodecPrototype<?> ctxProto = byBindingArgClass.get(argType);
- if (ctxProto == null && Augmentation.class.isAssignableFrom(argType)) {
- ctxProto = augmentationByClass(argType);
- }
- final DataContainerCodecContext<?, ?> context = childNonNull(ctxProto, argType,
- "Class %s is not valid child of %s", argType, getBindingClass()).get();
- if (context instanceof ChoiceNodeCodecContext) {
- final ChoiceNodeCodecContext<?> choice = (ChoiceNodeCodecContext<?>) context;
- choice.addYangPathArgument(arg, builder);
-
- final Optional<? extends Class<? extends DataObject>> caseType = arg.getCaseType();
- final Class<? extends DataObject> type = arg.getType();
- final DataContainerCodecContext<?, ?> caze;
- if (caseType.isPresent()) {
- // Non-ambiguous addressing this should not pose any problems
- caze = choice.streamChild(caseType.get());
- } else {
- caze = choice.getCaseByChildClass(type);
+ final CodecContextSupplier yangChildSupplier(final NodeIdentifier arg) {
+ final var child = super.yangChildSupplier(arg);
+ if (child == null) {
+ final var augClass = yangToAugmentClass.get(arg);
+ if (augClass != null) {
+ return augmentToPrototype.get(augClass);
}
-
- caze.addYangPathArgument(arg, builder);
- return caze.bindingPathArgumentChild(arg, builder);
}
- context.addYangPathArgument(arg, builder);
- return context;
+ return child;
}
- @Override
- public NodeCodecContext yangPathArgumentChild(final YangInstanceIdentifier.PathArgument arg) {
- final NodeContextSupplier childSupplier;
- if (arg instanceof NodeIdentifierWithPredicates) {
- childSupplier = byYang.get(new NodeIdentifier(arg.getNodeType()));
- } else if (arg instanceof AugmentationIdentifier) {
- childSupplier = yangAugmentationChild((AugmentationIdentifier) arg);
- } else {
- childSupplier = byYang.get(arg);
- }
-
- return childNonNull(childSupplier, arg, "Argument %s is not valid child of %s", arg, getSchema()).get();
+ private @Nullable AugmentationCodecPrototype getAugmentationProtoByClass(final @NonNull Class<?> augmClass) {
+ final var childProto = augmentToPrototype.get(augmClass);
+ return childProto != null ? childProto : mismatchedAugmentationByClass(augmClass);
}
- protected final ValueNodeCodecContext getLeafChild(final String name) {
- final ValueNodeCodecContext value = leafChild.get(name);
- return IncorrectNestingException.checkNonNull(value, "Leaf %s is not valid for %s", name, getBindingClass());
+ private @Nullable AugmentationCodecPrototype mismatchedAugmentationByClass(final @NonNull Class<?> childClass) {
+ /*
+ * It is potentially mismatched valid augmentation - we look up equivalent augmentation using reflection
+ * and walk all stream child and compare augmentations classes if they are equivalent. When we find a match
+ * we'll cache it so we do not need to perform reflection operations again.
+ */
+ final var local = (ImmutableMap<Class<?>, AugmentationCodecPrototype<?>>) MISMATCHED_AUGMENTED.getAcquire(this);
+ final var mismatched = local.get(childClass);
+ return mismatched != null ? mismatched : loadMismatchedAugmentation(local, childClass);
}
- private DataContainerCodecPrototype<?> loadChildPrototype(final Class<?> childClass) {
- final DataSchemaNode origDef = factory().getRuntimeContext().getSchemaDefinition(childClass);
- // Direct instantiation or use in same module in which grouping
- // was defined.
- DataSchemaNode sameName;
- try {
- sameName = getSchema().getDataChildByName(origDef.getQName());
- } catch (final IllegalArgumentException e) {
- sameName = null;
- }
- final DataSchemaNode childSchema;
- if (sameName != null) {
- // Exactly same schema node
- if (origDef.equals(sameName)) {
- childSchema = sameName;
- // We check if instantiated node was added via uses
- // statement and is instantiation of same grouping
- } else if (origDef.equals(SchemaNodeUtils.getRootOriginalIfPossible(sameName))) {
- childSchema = sameName;
- } else {
- // Node has same name, but clearly is different
- childSchema = null;
- }
- } else {
- // We are looking for instantiation via uses in other module
- final QName instantiedName = origDef.getQName().withModule(namespace());
- final DataSchemaNode potential = getSchema().getDataChildByName(instantiedName);
- // We check if it is really instantiated from same
- // definition as class was derived
- if (potential != null && origDef.equals(SchemaNodeUtils.getRootOriginalIfPossible(potential))) {
- childSchema = potential;
- } else {
- childSchema = null;
+ private @Nullable AugmentationCodecPrototype<?> loadMismatchedAugmentation(
+ final ImmutableMap<Class<?>, AugmentationCodecPrototype<?>> oldMismatched,
+ final @NonNull Class<?> childClass) {
+ @SuppressWarnings("rawtypes")
+ final Class<?> augTarget = findAugmentationTarget((Class) childClass);
+ // Do not bother with proposals which are not augmentations of our class, or do not match what the runtime
+ // context would load.
+ if (getBindingClass().equals(augTarget) && belongsToRuntimeContext(childClass)) {
+ for (var realChild : augmentToPrototype.values()) {
+ final var realClass = realChild.javaClass();
+ if (Augmentation.class.isAssignableFrom(realClass) && isSubstitutionFor(childClass, realClass)) {
+ return cacheMismatched(oldMismatched, childClass, realChild);
+ }
}
}
- final DataSchemaNode nonNullChild =
- childNonNull(childSchema, childClass, "Node %s does not have child named %s", getSchema(), childClass);
- return DataContainerCodecPrototype.from(createBindingArg(childClass, nonNullChild), nonNullChild, factory());
+ LOG.trace("Failed to resolve {} as a valid augmentation in {}", childClass, this);
+ return null;
}
- @SuppressWarnings("unchecked")
- Item<?> createBindingArg(final Class<?> childClass, final DataSchemaNode childSchema) {
- return Item.of((Class<? extends DataObject>) childClass);
- }
+ private @NonNull AugmentationCodecPrototype<?> cacheMismatched(
+ final @NonNull ImmutableMap<Class<?>, AugmentationCodecPrototype<?>> oldMismatched,
+ final @NonNull Class<?> childClass, final @NonNull AugmentationCodecPrototype<?> prototype) {
+ var expected = oldMismatched;
+ while (true) {
+ final var newMismatched =
+ ImmutableMap.<Class<?>, CommonDataObjectCodecPrototype<?>>builderWithExpectedSize(expected.size() + 1)
+ .putAll(expected)
+ .put(childClass, prototype)
+ .build();
+
+ final var witness = (ImmutableMap<Class<?>, AugmentationCodecPrototype<?>>)
+ MISMATCHED_AUGMENTED.compareAndExchangeRelease(this, expected, newMismatched);
+ if (witness == expected) {
+ LOG.trace("Cached mismatched augmentation {} -> {} in {}", childClass, prototype, this);
+ return prototype;
+ }
- private DataContainerCodecPrototype<?> yangAugmentationChild(final AugmentationIdentifier arg) {
- final DataContainerCodecPrototype<?> firstTry = augmentations.byYang.get(arg);
- if (firstTry != null) {
- return firstTry;
- }
- if (possibleAugmentations.containsKey(arg)) {
- // Try to load augmentations, which will potentially update knownAugmentations, hence we re-load that field
- // again.
- reloadAllAugmentations();
- return augmentations.byYang.get(arg);
+ expected = witness;
+ final var existing = expected.get(childClass);
+ if (existing != null) {
+ LOG.trace("Using raced mismatched augmentation {} -> {} in {}", childClass, existing, this);
+ return existing;
+ }
}
- return null;
}
- private @Nullable DataContainerCodecPrototype<?> augmentationByClass(final @NonNull Class<?> childClass) {
- DataContainerCodecPrototype<?> lookup = augmentationByClassOrEquivalentClass(childClass);
- if (lookup != null || !isPotentialAugmentation(childClass)) {
- return lookup;
+ private boolean belongsToRuntimeContext(final Class<?> cls) {
+ final var ctx = prototype().contextFactory().getRuntimeContext();
+ final Class<?> loaded;
+ try {
+ loaded = ctx.loadClass(Type.of(cls));
+ } catch (ClassNotFoundException e) {
+ LOG.debug("Proposed {} cannot be loaded in {}", cls, ctx, e);
+ return false;
}
+ return cls.equals(loaded);
+ }
- // Attempt to reload all augmentations using TCCL and lookup again
- reloadAllAugmentations();
- lookup = augmentationByClassOrEquivalentClass(childClass);
- if (lookup != null) {
- return lookup;
- }
+ private @Nullable AugmentationCodecPrototype<?> loadAugmentPrototype(final AugmentRuntimeType augment) {
+ // FIXME: in face of deviations this code should be looking at declared view, i.e. all possibilities at augment
+ // declaration site
+ final var childPaths = augment.statement()
+ .streamEffectiveSubstatements(SchemaTreeEffectiveStatement.class)
+ .map(stmt -> new NodeIdentifier((QName) stmt.argument()))
+ .collect(ImmutableSet.toImmutableSet());
- // Still no result, this can be caused by TCCL not being set up properly -- try the class's ClassLoader
- // if it is present
- final ClassLoader loader = childClass.getClassLoader();
- if (loader == null) {
+ if (childPaths.isEmpty()) {
return null;
}
- LOG.debug("Class {} not loaded via TCCL, attempting to recover", childClass);
- ClassLoaderUtils.runWithClassLoader(loader, this::reloadAllAugmentations);
- return augmentationByClassOrEquivalentClass(childClass);
- }
-
- private boolean isPotentialAugmentation(final Class<?> childClass) {
- final JavaTypeName name = JavaTypeName.create(childClass);
- for (Type type : possibleAugmentations.values()) {
- if (name.equals(type.getIdentifier())) {
- return true;
- }
+ final var factory = prototype().contextFactory();
+ final GeneratedType javaType = augment.javaType();
+ final Class<? extends Augmentation<?>> augClass;
+ try {
+ augClass = factory.getRuntimeContext().loadClass(javaType);
+ } catch (final ClassNotFoundException e) {
+ throw new IllegalStateException(
+ "RuntimeContext references type " + javaType + " but failed to load its class", e);
}
- return false;
+ return new AugmentationCodecPrototype<>(augClass, augment, factory, childPaths);
}
- private @Nullable DataContainerCodecPrototype<?> augmentationByClassOrEquivalentClass(
- final @NonNull Class<?> childClass) {
- // Perform a single load, so we can reuse it if we end up going to the reflection-based slow path
- final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> local = augmentations.byStream;
- final DataContainerCodecPrototype<?> childProto = local.get(childClass);
- if (childProto != null) {
- return childProto;
- }
-
- /*
- * It is potentially mismatched valid augmentation - we look up equivalent augmentation using reflection
- * and walk all stream child and compare augmentations classes if they are equivalent. When we find a match
- * we'll cache it so we do not need to perform reflection operations again.
+ @Override
+ @SuppressWarnings("unchecked")
+ Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentationsFrom(final DataContainerNode data) {
+ /**
+ * Due to augmentation fields are at same level as direct children the data of each augmentation needs to be
+ * aggregated into own container node, then only deserialized using associated prototype.
*/
- final DataContainerCodecPrototype<?> mismatched = mismatchedAugmented.get(childClass);
- if (mismatched != null) {
- return mismatched;
+ final var builders = new HashMap<Class<?>, DataContainerNodeBuilder>();
+ for (var childValue : data.body()) {
+ final var bindingClass = yangToAugmentClass.get(childValue.name());
+ if (bindingClass != null) {
+ builders.computeIfAbsent(bindingClass,
+ key -> Builders.containerBuilder()
+ .withNodeIdentifier(new NodeIdentifier(data.name().getNodeType())))
+ .addChild(childValue);
+ }
}
-
@SuppressWarnings("rawtypes")
- final Class<?> augTarget = BindingReflections.findAugmentationTarget((Class) childClass);
- if (getBindingClass().equals(augTarget)) {
- for (final DataContainerCodecPrototype<?> realChild : local.values()) {
- if (Augmentation.class.isAssignableFrom(realChild.getBindingClass())
- && BindingReflections.isSubstitutionFor(childClass, realChild.getBindingClass())) {
- return cacheMismatched(childClass, realChild);
+ final var map = new HashMap();
+ for (final var entry : builders.entrySet()) {
+ final var bindingClass = entry.getKey();
+ final var codecProto = augmentToPrototype.get(bindingClass);
+ if (codecProto != null) {
+ final var bindingObj = codecProto.getCodecContext().deserializeObject(entry.getValue().build());
+ if (bindingObj != null) {
+ map.put(bindingClass, bindingObj);
}
}
}
- LOG.trace("Failed to resolve {} as a valid augmentation in {}", childClass, this);
- return null;
+ return map;
}
- private synchronized DataContainerCodecPrototype<?> cacheMismatched(final Class<?> childClass,
- final DataContainerCodecPrototype<?> prototype) {
- // Original access was unsynchronized, we need to perform additional checking
- final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> local = mismatchedAugmented;
- final DataContainerCodecPrototype<?> existing = local.get(childClass);
- if (existing != null) {
- return existing;
- }
+ @Override
+ public DataObjectStep<?> deserializePathArgument(final PathArgument arg) {
+ checkArgument(getDomPathArgument().equals(arg));
+ return bindingArg();
+ }
- final Builder<Class<?>, DataContainerCodecPrototype<?>> builder = ImmutableMap.builderWithExpectedSize(
- local.size() + 1);
- builder.putAll(local);
- builder.put(childClass, prototype);
+ @Override
+ public PathArgument serializePathArgument(final DataObjectStep<?> step) {
+ checkArgument(bindingArg().equals(step));
+ return getDomPathArgument();
+ }
- mismatchedAugmented = builder.build();
- LOG.trace("Cached mismatched augmentation {} -> {} in {}", childClass, prototype, this);
- return prototype;
+ @Override
+ public NormalizedNode serialize(final D data) {
+ return serializeImpl(data);
}
- private DataContainerCodecPrototype<?> getAugmentationPrototype(final Type value) {
- final ClassLoadingStrategy loader = factory().getRuntimeContext().getStrategy();
- @SuppressWarnings("rawtypes")
- final Class augClass;
- try {
- augClass = loader.loadClass(value);
- } catch (final ClassNotFoundException e) {
- LOG.debug("Failed to load augmentation prototype for {}. Will be retried when needed.", value, e);
- return null;
- }
+ @Override
+ public final BindingNormalizedNodeCachingCodec<D> createCachingCodec(
+ final ImmutableCollection<Class<? extends BindingObject>> cacheSpecifier) {
+ return createCachingCodec(this, cacheSpecifier);
+ }
- @SuppressWarnings("unchecked")
- final Entry<AugmentationIdentifier, AugmentationSchemaNode> augSchema = factory().getRuntimeContext()
- .getResolvedAugmentationSchema(getSchema(), augClass);
- return DataContainerCodecPrototype.from(augClass, augSchema.getKey(), augSchema.getValue(), factory());
+ final @NonNull Class<? extends CodecDataObject<?>> generatedClass() {
+ return generatedClass;
}
@SuppressWarnings("checkstyle:illegalCatch")
- protected final D createBindingProxy(final NormalizedNodeContainer<?, ?, ?> node) {
+ final @NonNull D createBindingProxy(final DataContainerNode node) {
try {
return (D) proxyConstructor.invokeExact(this, node);
} catch (final Throwable e) {
throw new IllegalStateException(e);
}
}
-
- @SuppressWarnings("unchecked")
- Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentationsFrom(
- final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> data) {
-
- @SuppressWarnings("rawtypes")
- final Map map = new HashMap<>();
-
- for (final NormalizedNode<?, ?> childValue : data.getValue()) {
- if (childValue instanceof AugmentationNode) {
- final AugmentationNode augDomNode = (AugmentationNode) childValue;
- final DataContainerCodecPrototype<?> codecProto = yangAugmentationChild(augDomNode.getIdentifier());
- if (codecProto != null) {
- final DataContainerCodecContext<?, ?> codec = codecProto.get();
- map.put(codec.getBindingClass(), codec.deserializeObject(augDomNode));
- }
- }
- }
- for (final DataContainerCodecPrototype<?> value : augmentations.byStream.values()) {
- final Optional<NormalizedNode<?, ?>> augData = data.getChild(value.getYangArg());
- if (augData.isPresent()) {
- map.put(value.getBindingClass(), value.get().deserializeObject(augData.get()));
- }
- }
- return map;
- }
-
- @Override
- public InstanceIdentifier.PathArgument deserializePathArgument(final YangInstanceIdentifier.PathArgument arg) {
- checkArgument(getDomPathArgument().equals(arg));
- return bindingArg();
- }
-
- @Override
- public YangInstanceIdentifier.PathArgument serializePathArgument(final InstanceIdentifier.PathArgument arg) {
- checkArgument(bindingArg().equals(arg));
- return getDomPathArgument();
- }
}
Code Review / mdsal.git / blobdiff