Add MethodHandles.Lookup parameter to Shape.Builder.layout().

Deprecate Shape.Builder.layout(Class).

Author: woess

substratevm/src/com.oracle.svm.truffle/src/com/oracle/svm/truffle/TruffleBaseFeature.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -32,6 +32,7 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.lang.annotation.Annotation;
+import java.lang.invoke.MethodHandles;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
@@ -857,7 +858,14 @@ private void initializeDynamicObjectLayouts(AnalysisType type) {
 
     private static void initializeDynamicObjectLayoutImpl(Class<?> javaClass) {
         // Initialize DynamicObject layout info for every instantiated DynamicObject subclass.
-        invokeStaticMethod("com.oracle.truffle.object.LayoutImpl", "initializeDynamicObjectLayout", Collections.singleton(Class.class), javaClass);
+        MethodHandles.Lookup trustedLookup = (MethodHandles.Lookup) ReflectionUtil.readStaticField(MethodHandles.Lookup.class, "IMPL_LOOKUP");
+        MethodHandles.Lookup privateLookup;
+        try {
+            privateLookup = MethodHandles.privateLookupIn(javaClass, trustedLookup);
+        } catch (IllegalAccessException e) {
+            throw VMError.shouldNotReachHere(e);
+        }
+        invokeStaticMethod("com.oracle.truffle.object.LayoutImpl", "initializeDynamicObjectLayout", List.of(Class.class, MethodHandles.Lookup.class), javaClass, privateLookup);
     }
 
     private static void registerDynamicObjectFields(BeforeAnalysisAccessImpl config) {

truffle/CHANGELOG.md

@@ -18,6 +18,7 @@ This changelog summarizes major changes between Truffle versions relevant to lan
     * Added `ThreadLocalAction#notifyBlocked(Access)` and `ThreadLocalAction#notifyUnblocked(Access)` to notify thread local actions that their processing has been blocked/unblocked due to a blocked call (see `ThreadLocalAction` documentation).
     * `TruffleSafepoint#poll(Node)` does not require a non-null location anymore. However, it is still recommended to always pass a location node, if available.  
 * GR-59565 Added `RootNode.prepareForCompilation` which allows root nodes to offload expensive computation to the compiler thread and to delay compilation if they are not yet fully profiled.
+* GR-40323 Deprecated `Shape.Builder.layout(Class)` for removal and added replacement API [`Shape.Builder.layout(Class, MethodHandles.Lookup)`](https://www.graalvm.org/truffle/javadoc/com/oracle/truffle/api/object/Shape.Builder.html#layout(java.lang.Class,java.lang.MethodHandles.Lookup)). Replace usages with the new method, additionally providing a `Lookup` that has full privilege access to the layout class or the module in which it is declared, as obtained by `MethodHandles.lookup()`. See javadoc for the updated usage.
 
 
 * GR-54760 `RootNode.translateStackTraceElement()` is now always consulted for polyglot and debugger stack traces. Stack traces now use the source section, the executable name, and the name of the declared meta-object to build `StackTraceElement` instances.

truffle/src/com.oracle.truffle.api.object/snapshot.sigtest

@@ -107,7 +107,7 @@ intf com.oracle.truffle.api.interop.TruffleObject
 meth protected java.lang.Object clone() throws java.lang.CloneNotSupportedException
 meth public final com.oracle.truffle.api.object.Shape getShape()
 supr java.lang.Object
-hfds SHAPE_OFFSET,UNSAFE,extRef,extVal,shape
+hfds LOOKUP,SHAPE_OFFSET,UNSAFE,extRef,extVal,shape
 
 CLSS protected abstract interface static !annotation com.oracle.truffle.api.object.DynamicObject$DynamicField
  outer com.oracle.truffle.api.object.DynamicObject
@@ -298,6 +298,7 @@ cons protected init()
 innr public final static Builder
 innr public final static DerivedBuilder
 meth protected abstract com.oracle.truffle.api.object.Layout getLayout()
+ anno 0 java.lang.Deprecated(boolean forRemoval=false, java.lang.String since="24.2")
 meth protected abstract com.oracle.truffle.api.object.Shape addProperty(com.oracle.truffle.api.object.Property)
 meth protected abstract com.oracle.truffle.api.object.Shape defineProperty(java.lang.Object,java.lang.Object,int,int)
 meth protected abstract com.oracle.truffle.api.object.Shape removeProperty(com.oracle.truffle.api.object.Property)
@@ -346,13 +347,15 @@ meth public com.oracle.truffle.api.object.Shape$Builder allowImplicitCastIntToDo
 meth public com.oracle.truffle.api.object.Shape$Builder allowImplicitCastIntToLong(boolean)
 meth public com.oracle.truffle.api.object.Shape$Builder dynamicType(java.lang.Object)
 meth public com.oracle.truffle.api.object.Shape$Builder layout(java.lang.Class<? extends com.oracle.truffle.api.object.DynamicObject>)
+ anno 0 java.lang.Deprecated(boolean forRemoval=false, java.lang.String since="24.2")
+meth public com.oracle.truffle.api.object.Shape$Builder layout(java.lang.Class<? extends com.oracle.truffle.api.object.DynamicObject>,java.lang.invoke.MethodHandles$Lookup)
 meth public com.oracle.truffle.api.object.Shape$Builder propertyAssumptions(boolean)
 meth public com.oracle.truffle.api.object.Shape$Builder shapeFlags(int)
 meth public com.oracle.truffle.api.object.Shape$Builder shared(boolean)
 meth public com.oracle.truffle.api.object.Shape$Builder sharedData(java.lang.Object)
 meth public com.oracle.truffle.api.object.Shape$Builder singleContextAssumption(com.oracle.truffle.api.Assumption)
 supr java.lang.Object<com.oracle.truffle.api.object.Shape$Builder>
-hfds allowImplicitCastIntToDouble,allowImplicitCastIntToLong,dynamicType,layoutClass,properties,propertyAssumptions,shapeFlags,shared,sharedData,singleContextAssumption
+hfds allowImplicitCastIntToDouble,allowImplicitCastIntToLong,dynamicType,layoutClass,layoutLookup,properties,propertyAssumptions,shapeFlags,shared,sharedData,singleContextAssumption
 
 CLSS public final static com.oracle.truffle.api.object.Shape$DerivedBuilder
  outer com.oracle.truffle.api.object.Shape

truffle/src/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/DynamicObject.java

@@ -45,6 +45,8 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.lang.invoke.MethodHandles;
+import java.lang.invoke.MethodHandles.Lookup;
 import java.lang.reflect.Field;
 
 import com.oracle.truffle.api.CompilerDirectives;
@@ -65,7 +67,7 @@
  * shape caches to be shared across contexts.
  *
  * Subclasses can provide in-object dynamic field slots using the {@link DynamicField} annotation
- * and {@link Shape.Builder#layout(Class) Shape.Builder.layout}.
+ * and {@link Shape.Builder#layout(Class, Lookup) Shape.Builder.layout}.
  *
  * <p>
  * Example:
@@ -92,12 +94,14 @@
  */
 public abstract class DynamicObject implements TruffleObject {
 
+    private static final MethodHandles.Lookup LOOKUP = internalLookup();
+
     /**
      * Using this annotation, subclasses can define additional dynamic fields to be used by the
      * object layout. Annotated field must be of type {@code Object} or {@code long}, must not be
      * final, and must not have any direct usages.
      *
-     * @see Shape.Builder#layout(Class)
+     * @see Shape.Builder#layout(Class, Lookup)
      * @since 20.2.0
      */
     @Retention(RetentionPolicy.RUNTIME)
@@ -115,10 +119,10 @@ public abstract class DynamicObject implements TruffleObject {
 
     /**
      * Constructor for {@link DynamicObject} subclasses. Initializes the object with the provided
-     * shape. The shape must have been constructed with a {@linkplain Shape.Builder#layout(Class)
-     * layout class} assignable from this class (i.e., the concrete subclass, a superclass thereof,
-     * including {@link DynamicObject}) and must not have any instance properties (but may have
-     * constant properties).
+     * shape. The shape must have been constructed with a
+     * {@linkplain Shape.Builder#layout(Class, Lookup) layout class} assignable from this class
+     * (i.e., the concrete subclass, a superclass thereof, including {@link DynamicObject}) and must
+     * not have any instance properties (but may have constant properties).
      *
      * <p>
      * Examples:
@@ -129,7 +133,7 @@ public abstract class DynamicObject implements TruffleObject {
      * </pre>
      *
      * <pre>
-     * Shape shape = {@link Shape#newBuilder()}.{@link Shape.Builder#layout(Class) layout}(MyObject.class).{@link Shape.Builder#build() build}();
+     * Shape shape = {@link Shape#newBuilder()}.{@link Shape.Builder#layout(Class, Lookup) layout}(MyObject.class, MethodHandles.lookup()).{@link Shape.Builder#build() build}();
      * DynamicObject myObject = new MyObject(shape);
      * </pre>
      *
@@ -253,6 +257,10 @@ static Class<? extends Annotation> getDynamicFieldAnnotation() {
         return DynamicField.class;
     }
 
+    static Lookup internalLookup() {
+        return LOOKUP;
+    }
+
     private static final Unsafe UNSAFE;
     private static final long SHAPE_OFFSET;
     static {

truffle/src/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Shape.java

@@ -40,6 +40,8 @@
  */
 package com.oracle.truffle.api.object;
 
+import java.lang.invoke.MethodHandles;
+import java.lang.invoke.MethodHandles.Lookup;
 import java.util.List;
 import java.util.Objects;
 import java.util.function.Predicate;
@@ -168,6 +170,7 @@ static int checkShapeFlags(int flags) {
     public static final class Builder extends AbstractBuilder<Builder> {
 
         private Class<? extends DynamicObject> layoutClass = DynamicObject.class;
+        private MethodHandles.Lookup layoutLookup = DynamicObject.internalLookup();
         private Object dynamicType = ObjectType.DEFAULT;
         private int shapeFlags;
         private boolean allowImplicitCastIntToDouble;
@@ -212,14 +215,95 @@ public static final class Builder extends AbstractBuilder<Builder> {
          *
          * @param layoutClass custom object layout class
          * @since 20.2.0
+         * @deprecated Use {@link #layout(Class, MethodHandles.Lookup)} instead.
          */
+        @Deprecated(since = "24.2")
         public Builder layout(Class<? extends DynamicObject> layoutClass) {
             CompilerAsserts.neverPartOfCompilation();
             if (!DynamicObject.class.isAssignableFrom(layoutClass)) {
                 throw new IllegalArgumentException(String.format("Expected a subclass of %s but got: %s",
                                 DynamicObject.class.getName(), layoutClass.getTypeName()));
             }
             this.layoutClass = layoutClass;
+            this.layoutLookup = null;
+            return this;
+        }
+
+        /**
+         * Sets a custom object layout class (default: <code>{@link DynamicObject}.class</code>) and
+         * a corresponding {@link MethodHandles.Lookup} created by the layout class, or a class in
+         * the same module, that has full privilege access in order to provide access to its fields.
+         * <p>
+         * Enables the allocation of any additional {@code DynamicField}-annotated fields declared
+         * in the {@link DynamicObject} layout subclass as storage locations. By default, only
+         * extension array based storage locations in the {@link DynamicObject} base class are used.
+         * <p>
+         * Also restricts the shape to a specific {@link DynamicObject} subclass and subclasses
+         * thereof, i.e. shapes created for a {@link DynamicObject} layout subclass, and any derived
+         * shapes, can only be used to instantiate, and be assigned to, instances of that class
+         * (regardless of whether the class actually contains any dynamic fields).
+         *
+         * <p>
+         * Example:
+         *
+         * <pre>
+         * <code>
+         * public class MyObject extends DynamicObject implements TruffleObject {
+         *
+         *     &#64;DynamicField private Object _obj1;
+         *     &#64;DynamicField private Object _obj2;
+         *     &#64;DynamicField private long _long1;
+         *     &#64;DynamicField private long _long2;
+         *
+         *     public MyObject(Shape shape) {
+         *         super(shape);
+         *     }
+         *
+         *     static MethodHandles.Lookup lookup() {
+         *         return MethodHandles.lookup();
+         *     }
+         * }
+         *
+         *
+         * Shape myObjShape = Shape.newBuilder().layout(MyObject.class, MyObject.lookup()).build();
+         * MyObject obj = new MyObject(myObjShape);
+         * </code>
+         * </pre>
+         *
+         * @param layoutClass a {@link DynamicObject} layout subclass or the default
+         *            <code>{@link DynamicObject}.class</code>.
+         * @param layoutClassLookup a {@link Lookup} that has full privilege access, created using
+         *            {@link MethodHandles#lookup()}, either by the layout class itself, or a class
+         *            in the same module. If <code>layoutClass == DynamicObject.class</code>, and
+         *            only then, this parameter is ignored and may be <code>null</code>.
+         * @throws IllegalArgumentException if <code>layoutClass != DynamicObject.class</code> and
+         *             the lookup does not have {@link MethodHandles.Lookup#hasFullPrivilegeAccess()
+         *             full privilege access} or is not from the layout class or a class within the
+         *             same module as the layout class.
+         * @throws NullPointerException if <code>layoutClass == null</code>, or
+         *             <code>lookup == null</code> and
+         *             <code>layoutClass != {@link DynamicObject}.class</code>.
+         * @since 24.2.0
+         */
+        public Builder layout(Class<? extends DynamicObject> layoutClass, Lookup layoutClassLookup) {
+            CompilerAsserts.neverPartOfCompilation();
+            if (!DynamicObject.class.isAssignableFrom(layoutClass)) {
+                throw new IllegalArgumentException(String.format("Expected a subclass of %s but got: %s",
+                                DynamicObject.class.getName(), layoutClass.getTypeName()));
+            }
+            if (layoutClass == DynamicObject.class) {
+                this.layoutClass = DynamicObject.class;
+                this.layoutLookup = DynamicObject.internalLookup();
+                return this;
+            }
+            if (!layoutClassLookup.hasFullPrivilegeAccess()) {
+                throw new IllegalArgumentException("Lookup must have full privilege access");
+            }
+            if (layoutClassLookup.lookupClass().getModule() != layoutClass.getModule()) {
+                throw new IllegalArgumentException("Lookup must be from the same module as the layout class");
+            }
+            this.layoutClass = layoutClass;
+            this.layoutLookup = layoutClassLookup;
             return this;
         }
 
@@ -343,7 +427,6 @@ public Builder addConstantProperty(Object key, Object value, int flags) {
          * Allows values to be implicitly cast from int to long in this shape and any derived
          * shapes.
          *
-         * @see #layout(Class)
          * @since 20.2.0
          */
         public Builder allowImplicitCastIntToLong(boolean allow) {
@@ -355,7 +438,6 @@ public Builder allowImplicitCastIntToLong(boolean allow) {
          * Allows values to be implicitly cast from int to double in this shape and any derived
          * shapes.
          *
-         * @see #layout(Class)
          * @since 20.2.0
          */
         public Builder allowImplicitCastIntToDouble(boolean allow) {
@@ -379,7 +461,15 @@ public Shape build() {
             }
 
             int implicitCastFlags = (allowImplicitCastIntToDouble ? Layout.INT_TO_DOUBLE_FLAG : 0) | (allowImplicitCastIntToLong ? Layout.INT_TO_LONG_FLAG : 0);
-            Shape shape = Layout.getFactory().createShape(new Object[]{layoutClass, implicitCastFlags, dynamicType, sharedData, flags, properties, singleContextAssumption});
+            Shape shape = Layout.getFactory().createShape(new Object[]{
+                            layoutClass,
+                            implicitCastFlags,
+                            dynamicType,
+                            sharedData,
+                            flags,
+                            properties,
+                            singleContextAssumption,
+                            layoutLookup});
 
             assert shape.isShared() == shared && shape.getFlags() == shapeFlags && shape.getDynamicType() == dynamicType;
             return shape;
@@ -745,16 +835,17 @@ protected Shape setDynamicType(Object dynamicType) {
     /**
      * Get the shape's layout.
      *
-     * @see Shape.Builder#layout(Class)
      * @since 0.8 or earlier
+     * @deprecated No replacement. Use {@link #getLayoutClass()} to get the layout class.
      */
+    @Deprecated(since = "24.2")
     @SuppressWarnings("deprecation")
     protected abstract Layout getLayout();
 
     /**
      * Get the shape's layout class.
      *
-     * @see Shape.Builder#layout(Class)
+     * @see Shape.Builder#layout(Class, Lookup)
      * @since 21.1
      */
     @SuppressWarnings("deprecation")

truffle/src/com.oracle.truffle.object/src/com/oracle/truffle/object/CoreLayoutFactory.java

@@ -40,6 +40,9 @@
  */
 package com.oracle.truffle.object;
 
+import java.lang.invoke.MethodHandles;
+import java.lang.invoke.MethodHandles.Lookup;
+
 import org.graalvm.collections.Pair;
 import org.graalvm.collections.UnmodifiableEconomicMap;
 
@@ -64,26 +67,28 @@ protected void resetNativeImageState() {
         DefaultLayout.resetNativeImageState();
     }
 
-    protected void registerLayoutClass(Class<? extends DynamicObject> subclass) {
-        DefaultLayout.registerLayoutClass(subclass);
+    protected void registerLayoutClass(Class<? extends DynamicObject> subclass, Lookup layoutLookup) {
+        DefaultLayout.registerLayoutClass(subclass, layoutLookup);
     }
 
-    public LayoutImpl createLayout(Class<? extends DynamicObject> layoutClass, int implicitCastFlags) {
-        return DefaultLayout.createCoreLayout(layoutClass, implicitCastFlags);
+    public LayoutImpl createLayout(Class<? extends DynamicObject> layoutClass, Lookup layoutLookup, int implicitCastFlags) {
+        return DefaultLayout.createCoreLayout(layoutClass, layoutLookup, implicitCastFlags);
     }
 
+    @Override
     @SuppressWarnings("unchecked")
-    public Shape createShape(Object builderArgs) {
+    public final Shape createShape(Object builderArgs) {
         Object[] args = (Object[]) builderArgs;
         Class<? extends DynamicObject> layoutClass = (Class<? extends DynamicObject>) args[0];
         int implicitCastFlags = (int) args[1];
-        LayoutImpl impl = createLayout(layoutClass, implicitCastFlags);
         Object dynamicType = args[2];
         Object sharedData = args[3];
         int shapeFlags = (int) args[4];
         var constantProperties = (UnmodifiableEconomicMap<Object, Pair<Object, Integer>>) args[5];
         var singleContextAssumption = (Assumption) args[6];
+        var layoutLookup = (MethodHandles.Lookup) args[7];
 
+        LayoutImpl impl = createLayout(layoutClass, layoutLookup, implicitCastFlags);
         ShapeImpl shape = impl.newShape(dynamicType, sharedData, shapeFlags, singleContextAssumption);
 
         if (constantProperties != null) {