binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/CodecDataObjectGenerator.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 com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13 import static org.opendaylight.mdsal.binding.dom.codec.impl.ByteBuddyUtils.THIS;
  14 import static org.opendaylight.mdsal.binding.dom.codec.impl.ByteBuddyUtils.getField;
  15 import static org.opendaylight.mdsal.binding.dom.codec.impl.ByteBuddyUtils.invokeMethod;
  16 import static org.opendaylight.mdsal.binding.dom.codec.impl.ByteBuddyUtils.putField;
  17
  18 import com.google.common.base.MoreObjects.ToStringHelper;
  19 import com.google.common.collect.ImmutableMap;
  20 import com.google.common.collect.Maps;
  21 import java.lang.invoke.MethodHandles;
  22 import java.lang.invoke.MethodHandles.Lookup;
  23 import java.lang.invoke.VarHandle;
  24 import java.lang.reflect.Method;
  25 import java.util.ArrayList;
  26 import java.util.Arrays;
  27 import java.util.Comparator;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Map.Entry;
  31 import java.util.Objects;
  32 import java.util.Optional;
  33 import net.bytebuddy.ByteBuddy;
  34 import net.bytebuddy.description.field.FieldDescription;
  35 import net.bytebuddy.description.method.MethodDescription;
  36 import net.bytebuddy.description.type.TypeDefinition;
  37 import net.bytebuddy.description.type.TypeDescription;
  38 import net.bytebuddy.description.type.TypeDescription.Generic;
  39 import net.bytebuddy.dynamic.DynamicType.Builder;
  40 import net.bytebuddy.dynamic.scaffold.InstrumentedType;
  41 import net.bytebuddy.implementation.Implementation;
  42 import net.bytebuddy.implementation.Implementation.Context;
  43 import net.bytebuddy.implementation.bytecode.Addition;
  44 import net.bytebuddy.implementation.bytecode.ByteCodeAppender;
  45 import net.bytebuddy.implementation.bytecode.Multiplication;
  46 import net.bytebuddy.implementation.bytecode.StackManipulation;
  47 import net.bytebuddy.implementation.bytecode.assign.TypeCasting;
  48 import net.bytebuddy.implementation.bytecode.constant.ClassConstant;
  49 import net.bytebuddy.implementation.bytecode.constant.IntegerConstant;
  50 import net.bytebuddy.implementation.bytecode.constant.TextConstant;
  51 import net.bytebuddy.implementation.bytecode.member.MethodReturn;
  52 import net.bytebuddy.implementation.bytecode.member.MethodVariableAccess;
  53 import net.bytebuddy.jar.asm.Label;
  54 import net.bytebuddy.jar.asm.MethodVisitor;
  55 import net.bytebuddy.jar.asm.Opcodes;
  56 import org.eclipse.jdt.annotation.Nullable;
  57 import org.opendaylight.mdsal.binding.dom.codec.impl.ClassGeneratorBridge.LocalNameProvider;
  58 import org.opendaylight.mdsal.binding.dom.codec.impl.ClassGeneratorBridge.NodeContextSupplierProvider;
  59 import org.opendaylight.mdsal.binding.dom.codec.loader.CodecClassLoader;
  60 import org.opendaylight.mdsal.binding.dom.codec.loader.CodecClassLoader.ClassGenerator;
  61 import org.opendaylight.mdsal.binding.dom.codec.loader.CodecClassLoader.GeneratorResult;
  62 import org.opendaylight.yangtools.yang.binding.DataObject;
  63 import org.slf4j.Logger;
  64 import org.slf4j.LoggerFactory;
  65
  66 /**
  67  * Private support for generating {@link CodecDataObject} and {@link AugmentableCodecDataObject} specializations.
  68  *
  69  * <p>
  70  * Code generation here is probably more involved than usual mainly due to the fact we *really* want to express the
  71  * strong connection between a generated class to the extent possible. In most cases (grouping-generated types) this
  72  * involves one level of indirection, which is a safe approach. If we are dealing with a type generated outside of a
  73  * grouping statement, though, we are guaranteed instantiation-invariance and hence can hard-wire to a runtime-constant
  74  * {@link NodeContextSupplier} -- which  provides significant boost to JITs ability to optimize code -- especially with
  75  * inlining and constant propagation.
  76  *
  77  * <p>
  78  * The accessor mapping performance is critical due to users typically not taking care of storing the results acquired
  79  * by an invocation, assuming the accessors are backed by a normal field -- which of course is not true, as the results
  80  * are lazily computed.
  81  *
  82  * <p>
  83  * The design is such that for a particular structure like:
  84  * <pre>
  85  *     container foo {
  86  *         leaf bar {
  87  *             type string;
  88  *         }
  89  *     }
  90  * </pre>
  91  * we end up generating a class with the following layout:
  92  * <pre>
  93  *     public final class Foo$$$codecImpl extends CodecDataObject implements Foo {
  94  *         private static final VarHandle getBar$$$V;
  95  *         private volatile Object getBar;
  96  *
  97  *         public Foo$$$codecImpl(NormalizedNodeContainer data) {
  98  *             super(data);
  99  *         }
 100  *
 101  *         public Bar getBar() {
 102  *             return (Bar) codecMember(getBar$$$V, "bar");
 103  *         }
 104  *     }
 105  * </pre>
 106  *
 107  * <p>
 108  * This strategy minimizes the bytecode footprint and follows the generally good idea of keeping common logic in a
 109  * single place in a maintainable form. The glue code is extremely light (~6 instructions), which is beneficial on both
 110  * sides of invocation:
 111  * - generated method can readily be inlined into the caller
 112  * - it forms a call site into which codeMember() can be inlined with VarHandle being constant
 113  *
 114  * <p>
 115  * The second point is important here, as it allows the invocation logic around VarHandle to completely disappear,
 116  * becoming synonymous with operations on a field. Even though the field itself is declared as volatile, it is only ever
 117  * accessed through helper method using VarHandles -- and those helpers are using relaxed field ordering
 118  * of {@code getAcquire()}/{@code setRelease()} memory semantics.
 119  *
 120  * <p>
 121  * Furthermore there are distinct {@code codecMember} methods, each of which supports a different invocation style:
 122  * <ul>
 123  *   <li>with {@code String}, which ends up looking up a {@link ValueNodeCodecContext}</li>
 124  *   <li>with {@code Class}, which ends up looking up a {@link DataContainerCodecContext}</li>
 125  *   <li>with {@code NodeContextSupplier}, which performs a direct load</li>
 126  * </ul>
 127  * The third mode of operation requires that the object being implemented is not defined in a {@code grouping}, because
 128  * it welds the object to a particular namespace -- hence it trades namespace mobility for access speed.
 129  *
 130  * <p>
 131  * The sticky point here is the NodeContextSupplier, as it is a heap object which cannot normally be looked up from the
 132  * static context in which the static class initializer operates -- so we need perform some sort of a trick here.
 133  * Eventhough ByteBuddy provides facilities for bridging references to type fields, those facilities operate on volatile
 134  * fields -- hence they do not quite work for us.
 135  *
 136  * <p>
 137  * Another alternative, which we used in Javassist-generated DataObjectSerializers, is to muck with the static field
 138  * using reflection -- which works, but requires redefinition of Field.modifiers, which is something Java 9 complains
 139  * about quite noisily.
 140  *
 141  * <p>
 142  * We take a different approach here, which takes advantage of the fact we are in control of both code generation (here)
 143  * and class loading (in {@link CodecClassLoader}). The process is performed in four steps:
 144  * <ul>
 145  * <li>During code generation, the context fields are pointed towards
 146  *     {@link ClassGeneratorBridge#resolveNodeContextSupplier(String)} and
 147  *     {@link ClassGeneratorBridge#resolveKey(String)} methods, which are public and static, hence perfectly usable
 148  *     in the context of a class initializer.</li>
 149  * <li>During class loading of generated byte code, the original instance of the generator is called to wrap the actual
 150  *     class loading operation. At this point the generator installs itself as the current generator for this thread via
 151  *     {@link ClassGeneratorBridge#setup(CodecDataObjectGenerator)} and allows the class to be loaded.
 152  * <li>After the class has been loaded, but before the call returns, we will force the class to initialize, at which
 153  *     point the static invocations will be redirect to {@link #resolveNodeContextSupplier(String)} and
 154  *     {@link #resolveKey(String)} methods, thus initializing the fields to the intended constants.</li>
 155  * <li>Before returning from the class loading call, the generator will detach itself via
 156  *     {@link ClassGeneratorBridge#tearDown(CodecDataObjectGenerator)}.</li>
 157  * </ul>
 158  *
 159  * <p>
 160  * This strategy works due to close cooperation with the target ClassLoader, as the entire code generation and loading
 161  * block runs with the class loading lock for this FQCN and the reference is not leaked until the process completes.
 162  */
 163 abstract class CodecDataObjectGenerator<T extends CodecDataObject<?>> implements ClassGenerator<T> {
 164     // Not reusable definition: we can inline NodeContextSuppliers without a problem
 165     // FIXME: 6.0.0: wire this implementation, which requires that BindingRuntimeTypes provides information about types
 166     //               being genenerated from within a grouping
 167     private static final class Fixed<T extends CodecDataObject<?>> extends CodecDataObjectGenerator<T>
 168             implements NodeContextSupplierProvider<T> {
 169         private final ImmutableMap<Method, NodeContextSupplier> properties;
 170
 171         Fixed(final Builder<?> template, final ImmutableMap<Method, NodeContextSupplier> properties,
 172                 final @Nullable Method keyMethod) {
 173             super(template, keyMethod);
 174             this.properties = requireNonNull(properties);
 175         }
 176
 177         @Override
 178         Builder<T> generateGetters(final Builder<T> builder) {
 179             Builder<T> tmp = builder;
 180             for (Method method : properties.keySet()) {
 181                 LOG.trace("Generating for fixed method {}", method);
 182                 final String methodName = method.getName();
 183                 final TypeDescription retType = TypeDescription.ForLoadedType.of(method.getReturnType());
 184                 tmp = tmp.defineMethod(methodName, retType, PUB_FINAL).intercept(
 185                     new SupplierGetterMethodImplementation(methodName, retType));
 186             }
 187             return tmp;
 188         }
 189
 190         @Override
 191         ArrayList<Method> getterMethods() {
 192             return new ArrayList<>(properties.keySet());
 193         }
 194
 195         @Override
 196         public NodeContextSupplier resolveNodeContextSupplier(final String methodName) {
 197             final Optional<Entry<Method, NodeContextSupplier>> found = properties.entrySet().stream()
 198                     .filter(entry -> methodName.equals(entry.getKey().getName())).findAny();
 199             verify(found.isPresent(), "Failed to find property for %s in %s", methodName, this);
 200             return verifyNotNull(found.get().getValue());
 201         }
 202     }
 203
 204     // Reusable definition: we have to rely on context lookups
 205     private static final class Reusable<T extends CodecDataObject<?>> extends CodecDataObjectGenerator<T>
 206             implements LocalNameProvider<T> {
 207         private final ImmutableMap<Method, ValueNodeCodecContext> simpleProperties;
 208         private final Map<Method, Class<?>> daoProperties;
 209
 210         Reusable(final Builder<?> template, final ImmutableMap<Method, ValueNodeCodecContext> simpleProperties,
 211                 final Map<Method, Class<?>> daoProperties, final @Nullable Method keyMethod) {
 212             super(template, keyMethod);
 213             this.simpleProperties = requireNonNull(simpleProperties);
 214             this.daoProperties = requireNonNull(daoProperties);
 215         }
 216
 217         @Override
 218         Builder<T> generateGetters(final Builder<T> builder) {
 219             Builder<T> tmp = builder;
 220             for (Method method : simpleProperties.keySet()) {
 221                 LOG.trace("Generating for simple method {}", method);
 222                 final String methodName = method.getName();
 223                 final TypeDescription retType = TypeDescription.ForLoadedType.of(method.getReturnType());
 224                 tmp = tmp.defineMethod(methodName, retType, PUB_FINAL).intercept(
 225                     new SimpleGetterMethodImplementation(methodName, retType));
 226             }
 227             for (Entry<Method, Class<?>> entry : daoProperties.entrySet()) {
 228                 final Method method = entry.getKey();
 229                 LOG.trace("Generating for structured method {}", method);
 230                 final String methodName = method.getName();
 231                 final TypeDescription retType = TypeDescription.ForLoadedType.of(method.getReturnType());
 232                 tmp = tmp.defineMethod(methodName, retType, PUB_FINAL).intercept(
 233                     new StructuredGetterMethodImplementation(methodName, retType, entry.getValue()));
 234             }
 235
 236             return tmp;
 237         }
 238
 239         @Override
 240         ArrayList<Method> getterMethods() {
 241             final ArrayList<Method> ret = new ArrayList<>(simpleProperties.size() + daoProperties.size());
 242             ret.addAll(simpleProperties.keySet());
 243             ret.addAll(daoProperties.keySet());
 244             return ret;
 245         }
 246
 247         @Override
 248         public String resolveLocalName(final String methodName) {
 249             final Optional<Entry<Method, ValueNodeCodecContext>> found = simpleProperties.entrySet().stream()
 250                     .filter(entry -> methodName.equals(entry.getKey().getName())).findAny();
 251             verify(found.isPresent(), "Failed to find property for %s in %s", methodName, this);
 252             return found.get().getValue().getSchema().getQName().getLocalName();
 253         }
 254     }
 255
 256     private static final Logger LOG = LoggerFactory.getLogger(CodecDataObjectGenerator.class);
 257     private static final Generic BB_BOOLEAN = TypeDefinition.Sort.describe(boolean.class);
 258     private static final Generic BB_DATAOBJECT = TypeDefinition.Sort.describe(DataObject.class);
 259     private static final Generic BB_HELPER = TypeDefinition.Sort.describe(ToStringHelper.class);
 260     private static final Generic BB_INT = TypeDefinition.Sort.describe(int.class);
 261     private static final Comparator<Method> METHOD_BY_ALPHABET = Comparator.comparing(Method::getName);
 262
 263     private static final StackManipulation ARRAYS_EQUALS = invokeMethod(Arrays.class, "equals",
 264         byte[].class, byte[].class);
 265     private static final StackManipulation OBJECTS_EQUALS = invokeMethod(Objects.class, "equals",
 266         Object.class, Object.class);
 267     private static final StackManipulation HELPER_ADD = invokeMethod(ToStringHelper.class, "add",
 268         String.class, Object.class);
 269
 270     private static final StackManipulation FIRST_ARG_REF = MethodVariableAccess.REFERENCE.loadFrom(1);
 271
 272     private static final int PROT_FINAL = Opcodes.ACC_PROTECTED | Opcodes.ACC_FINAL | Opcodes.ACC_SYNTHETIC;
 273     private static final int PUB_FINAL = Opcodes.ACC_PUBLIC | Opcodes.ACC_FINAL | Opcodes.ACC_SYNTHETIC;
 274
 275     private static final Builder<?> CDO;
 276     private static final Builder<?> ACDO;
 277
 278     static {
 279         final ByteBuddy bb = new ByteBuddy();
 280         CDO = bb.subclass(CodecDataObject.class).visit(ByteBuddyUtils.computeFrames());
 281         ACDO = bb.subclass(AugmentableCodecDataObject.class).visit(ByteBuddyUtils.computeFrames());
 282     }
 283
 284     private final Builder<?> template;
 285     private final Method keyMethod;
 286
 287     CodecDataObjectGenerator(final Builder<?> template, final @Nullable Method keyMethod) {
 288         this.template = requireNonNull(template);
 289         this.keyMethod = keyMethod;
 290     }
 291
 292     static <D extends DataObject, T extends CodecDataObject<T>> Class<T> generate(final CodecClassLoader loader,
 293             final Class<D> bindingInterface, final ImmutableMap<Method, ValueNodeCodecContext> simpleProperties,
 294             final Map<Method, Class<?>> daoProperties, final Method keyMethod) {
 295         return loader.generateClass(bindingInterface, "codecImpl",
 296             new Reusable<>(CDO, simpleProperties, daoProperties, keyMethod));
 297     }
 298
 299     static <D extends DataObject, T extends CodecDataObject<T>> Class<T> generateAugmentable(
 300             final CodecClassLoader loader, final Class<D> bindingInterface,
 301             final ImmutableMap<Method, ValueNodeCodecContext> simpleProperties,
 302             final Map<Method, Class<?>> daoProperties, final Method keyMethod) {
 303         return loader.generateClass(bindingInterface, "codecImpl",
 304             new Reusable<>(ACDO, simpleProperties, daoProperties, keyMethod));
 305     }
 306
 307     @Override
 308     public final GeneratorResult<T> generateClass(final CodecClassLoader loeader, final String fqcn,
 309             final Class<?> bindingInterface) {
 310         LOG.trace("Generating class {}", fqcn);
 311
 312         @SuppressWarnings("unchecked")
 313         Builder<T> builder = (Builder<T>) template.name(fqcn).implement(bindingInterface);
 314
 315         builder = generateGetters(builder);
 316
 317         if (keyMethod != null) {
 318             LOG.trace("Generating for key {}", keyMethod);
 319             final String methodName = keyMethod.getName();
 320             final TypeDescription retType = TypeDescription.ForLoadedType.of(keyMethod.getReturnType());
 321             builder = builder.defineMethod(methodName, retType, PUB_FINAL).intercept(
 322                 new KeyMethodImplementation(methodName, retType));
 323         }
 324
 325         // Index all property methods, turning them into "getFoo()" invocations, retaining order. We will be using
 326         // those invocations in each of the three methods. Note that we do not glue the invocations to 'this', as we
 327         // will be invoking them on 'other' in codecEquals()
 328         final ArrayList<Method> properties = getterMethods();
 329         // Make sure properties are alpha-sorted
 330         properties.sort(METHOD_BY_ALPHABET);
 331         final ImmutableMap<StackManipulation, Method> methods = Maps.uniqueIndex(properties,
 332             ByteBuddyUtils::invokeMethod);
 333
 334         // Final bits:
 335         return GeneratorResult.of(builder
 336                 // codecHashCode() ...
 337                 .defineMethod("codecHashCode", BB_INT, PROT_FINAL)
 338                 .intercept(new Implementation.Simple(new CodecHashCode(methods)))
 339                 // ... codecEquals() ...
 340                 .defineMethod("codecEquals", BB_BOOLEAN, PROT_FINAL).withParameter(BB_DATAOBJECT)
 341                 .intercept(codecEquals(methods))
 342                 // ... and codecFillToString() ...
 343                 .defineMethod("codecFillToString", BB_HELPER, PROT_FINAL).withParameter(BB_HELPER)
 344                 .intercept(codecFillToString(methods))
 345                 // ... and build it
 346                 .make());
 347     }
 348
 349     abstract Builder<T> generateGetters(Builder<T> builder);
 350
 351     abstract ArrayList<Method> getterMethods();
 352
 353     private static Implementation codecEquals(final ImmutableMap<StackManipulation, Method> properties) {
 354         // Label for 'return false;'
 355         final Label falseLabel = new Label();
 356         // Condition for 'if (!...)'
 357         final StackManipulation ifFalse = ByteBuddyUtils.ifEq(falseLabel);
 358
 359         final List<StackManipulation> manipulations = new ArrayList<>(properties.size() * 6 + 5);
 360         for (Entry<StackManipulation, Method> entry : properties.entrySet()) {
 361             // if (!java.util.(Objects|Arrays).equals(getFoo(), other.getFoo())) {
 362             //     return false;
 363             // }
 364             manipulations.add(THIS);
 365             manipulations.add(entry.getKey());
 366             manipulations.add(FIRST_ARG_REF);
 367             manipulations.add(entry.getKey());
 368             manipulations.add(entry.getValue().getReturnType().isArray() ? ARRAYS_EQUALS : OBJECTS_EQUALS);
 369             manipulations.add(ifFalse);
 370         }
 371
 372         // return true;
 373         manipulations.add(IntegerConstant.ONE);
 374         manipulations.add(MethodReturn.INTEGER);
 375         // L0: return false;
 376         manipulations.add(ByteBuddyUtils.markLabel(falseLabel));
 377         manipulations.add(IntegerConstant.ZERO);
 378         manipulations.add(MethodReturn.INTEGER);
 379
 380         return new Implementation.Simple(manipulations.toArray(new StackManipulation[0]));
 381     }
 382
 383     private static Implementation codecFillToString(final ImmutableMap<StackManipulation, Method> properties) {
 384         final List<StackManipulation> manipulations = new ArrayList<>(properties.size() * 4 + 2);
 385         // push 'return helper' to stack...
 386         manipulations.add(FIRST_ARG_REF);
 387         for (Entry<StackManipulation, Method> entry : properties.entrySet()) {
 388             // .add("getFoo", getFoo())
 389             manipulations.add(new TextConstant(entry.getValue().getName()));
 390             manipulations.add(THIS);
 391             manipulations.add(entry.getKey());
 392             manipulations.add(HELPER_ADD);
 393         }
 394         // ... execute 'return helper'
 395         manipulations.add(MethodReturn.REFERENCE);
 396
 397         return new Implementation.Simple(manipulations.toArray(new StackManipulation[0]));
 398     }
 399
 400     private abstract static class AbstractMethodImplementation implements Implementation {
 401         private static final Generic BB_HANDLE = TypeDefinition.Sort.describe(VarHandle.class);
 402         private static final Generic BB_OBJECT = TypeDefinition.Sort.describe(Object.class);
 403         private static final StackManipulation OBJECT_CLASS = ClassConstant.of(TypeDescription.OBJECT);
 404         private static final StackManipulation LOOKUP = invokeMethod(MethodHandles.class, "lookup");
 405         private static final StackManipulation FIND_VAR_HANDLE = invokeMethod(Lookup.class,
 406             "findVarHandle", Class.class, String.class, Class.class);
 407
 408         static final int PRIV_CONST = Opcodes.ACC_PRIVATE | Opcodes.ACC_STATIC | Opcodes.ACC_FINAL
 409                 | Opcodes.ACC_SYNTHETIC;
 410         private static final int PRIV_VOLATILE = Opcodes.ACC_PRIVATE | Opcodes.ACC_VOLATILE | Opcodes.ACC_SYNTHETIC;
 411
 412         final TypeDescription retType;
 413         // getFoo
 414         final String methodName;
 415         // getFoo$$$V
 416         final String handleName;
 417
 418         AbstractMethodImplementation(final String methodName, final TypeDescription retType) {
 419             this.methodName = requireNonNull(methodName);
 420             this.retType = requireNonNull(retType);
 421             this.handleName = methodName + "$$$V";
 422         }
 423
 424         @Override
 425         public InstrumentedType prepare(final InstrumentedType instrumentedType) {
 426             final InstrumentedType tmp = instrumentedType
 427                     // private static final VarHandle getFoo$$$V;
 428                     .withField(new FieldDescription.Token(handleName, PRIV_CONST, BB_HANDLE))
 429                     // private volatile Object getFoo;
 430                     .withField(new FieldDescription.Token(methodName, PRIV_VOLATILE, BB_OBJECT));
 431
 432             return tmp.withInitializer(new ByteCodeAppender.Simple(
 433                 // TODO: acquiring lookup is expensive, we should share it across all initialization
 434                 // getFoo$$$V = MethodHandles.lookup().findVarHandle(This.class, "getFoo", Object.class);
 435                 LOOKUP,
 436                 ClassConstant.of(tmp),
 437                 new TextConstant(methodName),
 438                 OBJECT_CLASS,
 439                 FIND_VAR_HANDLE,
 440                 putField(tmp, handleName)));
 441         }
 442     }
 443
 444     private static final class KeyMethodImplementation extends AbstractMethodImplementation {
 445         private static final StackManipulation CODEC_KEY = invokeMethod(CodecDataObject.class,
 446             "codecKey", VarHandle.class);
 447
 448         KeyMethodImplementation(final String methodName, final TypeDescription retType) {
 449             super(methodName, retType);
 450         }
 451
 452         @Override
 453         public ByteCodeAppender appender(final Target implementationTarget) {
 454             final TypeDescription instrumentedType = implementationTarget.getInstrumentedType();
 455             return new ByteCodeAppender.Simple(
 456                 // return (FooType) codecKey(getFoo$$$V);
 457                 THIS,
 458                 getField(instrumentedType, handleName),
 459                 CODEC_KEY,
 460                 TypeCasting.to(retType),
 461                 MethodReturn.REFERENCE);
 462         }
 463     }
 464
 465     /*
 466      * A simple leaf method, which looks up child by a String constant. This is slightly more complicated because we
 467      * want to make sure we are using the same String instance as the one stored in associated DataObjectCodecContext,
 468      * so that during lookup we perform an identity check instead of comparing content -- speeding things up as well
 469      * as minimizing footprint. Since that string is not guaranteed to be interned in the String Pool, we cannot rely
 470      * on the constant pool entry to resolve to the same object.
 471      */
 472     private static final class SimpleGetterMethodImplementation extends AbstractMethodImplementation {
 473         private static final StackManipulation CODEC_MEMBER = invokeMethod(CodecDataObject.class,
 474             "codecMember", VarHandle.class, String.class);
 475         private static final StackManipulation BRIDGE_RESOLVE = invokeMethod(ClassGeneratorBridge.class,
 476             "resolveLocalName", String.class);
 477         private static final Generic BB_STRING = TypeDefinition.Sort.describe(String.class);
 478
 479         // getFoo$$$S
 480         private final String stringName;
 481
 482         SimpleGetterMethodImplementation(final String methodName, final TypeDescription retType) {
 483             super(methodName, retType);
 484             this.stringName = methodName + "$$$S";
 485         }
 486
 487         @Override
 488         public InstrumentedType prepare(final InstrumentedType instrumentedType) {
 489             final InstrumentedType tmp = super.prepare(instrumentedType)
 490                     // private static final String getFoo$$$S;
 491                     .withField(new FieldDescription.Token(stringName, PRIV_CONST, BB_STRING));
 492
 493             return tmp.withInitializer(new ByteCodeAppender.Simple(
 494                 // getFoo$$$S = CodecDataObjectBridge.resolveString("getFoo");
 495                 new TextConstant(methodName),
 496                 BRIDGE_RESOLVE,
 497                 putField(tmp, stringName)));
 498         }
 499
 500         @Override
 501         public ByteCodeAppender appender(final Target implementationTarget) {
 502             final TypeDescription instrumentedType = implementationTarget.getInstrumentedType();
 503             return new ByteCodeAppender.Simple(
 504                 // return (FooType) codecMember(getFoo$$$V, getFoo$$$S);
 505                 THIS,
 506                 getField(instrumentedType, handleName),
 507                 getField(instrumentedType, stringName),
 508                 CODEC_MEMBER,
 509                 TypeCasting.to(retType),
 510                 MethodReturn.REFERENCE);
 511         }
 512     }
 513
 514     private static final class StructuredGetterMethodImplementation extends AbstractMethodImplementation {
 515         private static final StackManipulation CODEC_MEMBER = invokeMethod(CodecDataObject.class,
 516             "codecMember", VarHandle.class, Class.class);
 517
 518         private final Class<?> bindingClass;
 519
 520         StructuredGetterMethodImplementation(final String methodName, final TypeDescription retType,
 521                 final Class<?> bindingClass) {
 522             super(methodName, retType);
 523             this.bindingClass = requireNonNull(bindingClass);
 524         }
 525
 526         @Override
 527         public ByteCodeAppender appender(final Target implementationTarget) {
 528             final TypeDescription instrumentedType = implementationTarget.getInstrumentedType();
 529             return new ByteCodeAppender.Simple(
 530                 // return (FooType) codecMember(getFoo$$$V, FooType.class);
 531                 THIS,
 532                 getField(instrumentedType, handleName),
 533                 ClassConstant.of(TypeDefinition.Sort.describe(bindingClass).asErasure()),
 534                 CODEC_MEMBER,
 535                 TypeCasting.to(retType),
 536                 MethodReturn.REFERENCE);
 537         }
 538     }
 539
 540     private static final class SupplierGetterMethodImplementation extends AbstractMethodImplementation {
 541         private static final StackManipulation CODEC_MEMBER = invokeMethod(CodecDataObject.class,
 542             "codecMember", VarHandle.class, NodeContextSupplier.class);
 543         private static final StackManipulation BRIDGE_RESOLVE = invokeMethod(ClassGeneratorBridge.class,
 544             "resolveNodeContextSupplier", String.class);
 545         private static final Generic BB_NCS = TypeDefinition.Sort.describe(NodeContextSupplier.class);
 546
 547         // getFoo$$$C
 548         private final String contextName;
 549
 550         SupplierGetterMethodImplementation(final String methodName, final TypeDescription retType) {
 551             super(methodName, retType);
 552             contextName = methodName + "$$$C";
 553         }
 554
 555         @Override
 556         public InstrumentedType prepare(final InstrumentedType instrumentedType) {
 557             final InstrumentedType tmp = super.prepare(instrumentedType)
 558                     // private static final NodeContextSupplier getFoo$$$C;
 559                     .withField(new FieldDescription.Token(contextName, PRIV_CONST, BB_NCS));
 560
 561             return tmp.withInitializer(new ByteCodeAppender.Simple(
 562                 // getFoo$$$C = CodecDataObjectBridge.resolve("getFoo");
 563                 new TextConstant(methodName),
 564                 BRIDGE_RESOLVE,
 565                 putField(tmp, contextName)));
 566         }
 567
 568         @Override
 569         public ByteCodeAppender appender(final Target implementationTarget) {
 570             final TypeDescription instrumentedType = implementationTarget.getInstrumentedType();
 571             return new ByteCodeAppender.Simple(
 572                 // return (FooType) codecMember(getFoo$$$V, getFoo$$$C);
 573                 THIS,
 574                 getField(instrumentedType, handleName),
 575                 getField(instrumentedType, contextName),
 576                 CODEC_MEMBER,
 577                 TypeCasting.to(retType),
 578                 MethodReturn.REFERENCE);
 579         }
 580     }
 581
 582     private static final class CodecHashCode implements ByteCodeAppender {
 583         private static final StackManipulation THIRTY_ONE = IntegerConstant.forValue(31);
 584         private static final StackManipulation LOAD_RESULT = MethodVariableAccess.INTEGER.loadFrom(1);
 585         private static final StackManipulation STORE_RESULT = MethodVariableAccess.INTEGER.storeAt(1);
 586         private static final StackManipulation ARRAYS_HASHCODE = invokeMethod(Arrays.class, "hashCode", byte[].class);
 587         private static final StackManipulation OBJECTS_HASHCODE = invokeMethod(Objects.class, "hashCode", Object.class);
 588
 589         private final ImmutableMap<StackManipulation, Method> properties;
 590
 591         CodecHashCode(final ImmutableMap<StackManipulation, Method> properties) {
 592             this.properties = requireNonNull(properties);
 593         }
 594
 595         @Override
 596         public Size apply(final MethodVisitor methodVisitor, final Context implementationContext,
 597                 final MethodDescription instrumentedMethod) {
 598             final List<StackManipulation> manipulations = new ArrayList<>(properties.size() * 8 + 4);
 599             // int result = 1;
 600             manipulations.add(IntegerConstant.ONE);
 601             manipulations.add(STORE_RESULT);
 602
 603             for (Entry<StackManipulation, Method> entry : properties.entrySet()) {
 604                 // result = 31 * result + java.util.(Objects,Arrays).hashCode(getFoo());
 605                 manipulations.add(THIRTY_ONE);
 606                 manipulations.add(LOAD_RESULT);
 607                 manipulations.add(Multiplication.INTEGER);
 608                 manipulations.add(THIS);
 609                 manipulations.add(entry.getKey());
 610                 manipulations.add(entry.getValue().getReturnType().isArray() ? ARRAYS_HASHCODE : OBJECTS_HASHCODE);
 611                 manipulations.add(Addition.INTEGER);
 612                 manipulations.add(STORE_RESULT);
 613             }
 614             // return result;
 615             manipulations.add(LOAD_RESULT);
 616             manipulations.add(MethodReturn.INTEGER);
 617
 618             StackManipulation.Size operandStackSize = new StackManipulation.Compound(manipulations)
 619                     .apply(methodVisitor, implementationContext);
 620             return new Size(operandStackSize.getMaximalSize(), instrumentedMethod.getStackSize() + 1);
 621         }
 622     }
 623 }