binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/CodecDataObject.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.binding.dom.codec.impl;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import java.lang.invoke.MethodHandles;
  14 import java.lang.invoke.VarHandle;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.opendaylight.yangtools.yang.binding.DataObject;
  18 import org.opendaylight.yangtools.yang.data.api.schema.DistinctNodeContainer;
  19 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  21
  22 /**
  23  * A base class for {@link DataObject}s backed by {@link DataObjectCodecContext}. While this class is public, it not
  24  * part of API surface and is an implementation detail. The only reason for it being public is that it needs to be
  25  * accessible by code generated at runtime.
  26  *
  27  * @param <T> DataObject type
  28  */
  29 public abstract class CodecDataObject<T extends DataObject> implements DataObject {
  30     // An object representing a null value in a member field.
  31     private static final @NonNull Object NULL_VALUE = new Object();
  32
  33     private static final VarHandle CACHED_HASH_CODE;
  34
  35     static {
  36         try {
  37             CACHED_HASH_CODE = MethodHandles.lookup().findVarHandle(CodecDataObject.class, "cachedHashcode",
  38                 Integer.class);
  39         } catch (NoSuchFieldException | IllegalAccessException e) {
  40             throw new ExceptionInInitializerError(e);
  41         }
  42     }
  43
  44     private final @NonNull AbstractDataObjectCodecContext<T, ?> context;
  45     @SuppressWarnings("rawtypes")
  46     private final @NonNull DistinctNodeContainer data;
  47
  48     // Accessed via a VarHandle
  49     @SuppressWarnings("unused")
  50     // FIXME: consider using a primitive int-based cache (with 0 being uninit)
  51     private volatile Integer cachedHashcode;
  52
  53     protected CodecDataObject(final AbstractDataObjectCodecContext<T, ?> context,
  54             final DistinctNodeContainer<?, ?> data) {
  55         this.data = requireNonNull(data, "Data must not be null");
  56         this.context = requireNonNull(context, "Context must not be null");
  57     }
  58
  59     @Override
  60     public final int hashCode() {
  61         final Integer cached = (Integer) CACHED_HASH_CODE.getAcquire(this);
  62         return cached != null ? cached : loadHashCode();
  63     }
  64
  65     @Override
  66     public final boolean equals(final Object obj) {
  67         // Indirection to keep checkstyle happy
  68         return codecEquals(obj);
  69     }
  70
  71     @Override
  72     public abstract String toString();
  73
  74     protected final Object codecMember(final VarHandle handle, final String localName) {
  75         final Object cached = handle.getAcquire(this);
  76         return cached != null ? unmaskNull(cached) : loadMember(handle, context.getLeafChild(localName));
  77     }
  78
  79     protected final Object codecMember(final VarHandle handle, final Class<? extends DataObject> bindingClass) {
  80         final Object cached = handle.getAcquire(this);
  81         return cached != null ? unmaskNull(cached) : loadMember(handle, context.streamChild(bindingClass));
  82     }
  83
  84     protected final Object codecMember(final VarHandle handle, final NodeContextSupplier supplier) {
  85         final Object cached = handle.getAcquire(this);
  86         return cached != null ? unmaskNull(cached) : loadMember(handle, supplier.get());
  87     }
  88
  89     protected final @NonNull Object codecMemberOrEmpty(final @Nullable Object value,
  90             final @NonNull Class<? extends DataObject> bindingClass) {
  91         return value != null ? value : emptyObject(bindingClass);
  92     }
  93
  94     private @NonNull Object emptyObject(final @NonNull Class<? extends DataObject> bindingClass) {
  95         final var childContext = context.streamChild(bindingClass);
  96         verify(childContext instanceof NonPresenceContainerNodeCodecContext, "Unexpected context %s", childContext);
  97         return ((NonPresenceContainerNodeCodecContext<?>) childContext).emptyObject();
  98     }
  99
 100     protected final @NonNull Object codecKey(final VarHandle handle) {
 101         final Object cached = handle.getAcquire(this);
 102         return cached != null ? cached : loadKey(handle);
 103     }
 104
 105     protected abstract int codecHashCode();
 106
 107     protected abstract boolean codecEquals(Object obj);
 108
 109     final @NonNull AbstractDataObjectCodecContext<T, ?> codecContext() {
 110         return context;
 111     }
 112
 113     @SuppressWarnings("rawtypes")
 114     final @NonNull DistinctNodeContainer codecData() {
 115         return data;
 116     }
 117
 118     // Helper split out of codecMember to aid its inlining
 119     private Object loadMember(final VarHandle handle, final NodeCodecContext childCtx) {
 120         @SuppressWarnings("unchecked")
 121         final NormalizedNode child = data.childByArg(childCtx.getDomPathArgument());
 122
 123         // We do not want to use Optional.map() here because we do not want to invoke defaultObject() when we have
 124         // normal value because defaultObject() may end up throwing an exception intentionally.
 125         final Object obj = child != null ? childCtx.deserializeObject(child) : childCtx.defaultObject();
 126         final Object witness = handle.compareAndExchangeRelease(this, null, maskNull(obj));
 127         return witness == null ? obj : unmaskNull(witness);
 128     }
 129
 130     // Helper split out of codecKey to aid its inlining
 131     private @NonNull Object loadKey(final VarHandle handle) {
 132         verify(data instanceof MapEntryNode, "Unsupported value %s", data);
 133         verify(context instanceof KeyedListNodeCodecContext, "Unexpected context %s", context);
 134         final Object obj = ((KeyedListNodeCodecContext<?, ?>) context)
 135                 .deserialize(((MapEntryNode) data).getIdentifier());
 136         // key is known to be non-null, no need to mask it
 137         final Object witness = handle.compareAndExchangeRelease(this, null, obj);
 138         return witness == null ? obj : witness;
 139     }
 140
 141     // Helper split out of hashCode() to aid its inlining
 142     private int loadHashCode() {
 143         final int result = codecHashCode();
 144         final Object witness = CACHED_HASH_CODE.compareAndExchangeRelease(this, null, result);
 145         return witness == null ? result : (Integer) witness;
 146     }
 147
 148     private static @NonNull Object maskNull(final @Nullable Object unmasked) {
 149         return unmasked == null ? NULL_VALUE : unmasked;
 150     }
 151
 152     private static @Nullable Object unmaskNull(final Object masked) {
 153         return masked == NULL_VALUE ? null : masked;
 154     }
 155 }