[GR-36894] Various DynamicObject improvements and cleanups

PullRequest: graal/22051

Author: eregon

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/truffle/test/HostInliningBytecodeInterpreterExampleTest.java

@@ -49,7 +49,7 @@
 import jdk.vm.ci.meta.ResolvedJavaMethod;
 
 /*
- * If you update the code here, please also update truffle/docs/HostOptimization.md.
+ * If you update the code here, please also update truffle/docs/HostCompilation.md.
  */
 public class HostInliningBytecodeInterpreterExampleTest extends TruffleCompilerImplTest {
 

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/truffle/host/HostInliningPhase.java

@@ -907,7 +907,7 @@ private static boolean isFastPathInvoke(CallTree call) {
 
     /**
      * Returns <code>true</code> if a call tree should get inlined, otherwise <code>false</code>.
-     * This method does not yet make determine wheter the call site is in budget. See
+     * This method does not yet determine whether the call site is in budget. See
      * {@link #isInBudget(CallTree, int, int)} for that.
      */
     private boolean shouldInline(InliningPhaseContext context, CallTree call) {
@@ -1013,7 +1013,7 @@ private boolean shouldInline(InliningPhaseContext context, CallTree call) {
          * or non-direct virtual calls.
          */
         if (call.subTreeFastPathInvokes >= context.maxSubtreeInvokes) {
-            call.reason = "call has too many fast-path invokes - too complex, please optimize, see truffle/docs/HostOptimization.md";
+            call.reason = "call has too many fast-path invokes - too complex, please optimize, see truffle/docs/HostCompilation.md";
             return false;
         }
 

truffle/docs/HostCompilation.md

@@ -38,7 +38,7 @@ This allows bytecode interpreter switches to be composed of multiple methods if
 Native image, during closed world analysis, computes all methods that are reachable for runtime compilation.
 Any potentially reachable method from `RootNode.execute(...)` is determined as runtime compilable.
 For native images, in addition to bytecode interpreter switches, all runtime compilable methods are optimized using Truffle host inlining.
-The maximum node cost of such an inlining pass can be configured with `-H:TruffleHostInliningBaseBudget=5000`. 
+The maximum node cost of such an inlining pass can be configured with `-H:TruffleHostInliningBaseBudget=5000`.
 On HotSpot the set of runtime compilable methods is unknown.
 Therefore, we can only rely on regular Java method inlining for methods not annotated as bytecode interpreter switch on HotSpot.
 
@@ -213,10 +213,10 @@ Additionally, to avoid the explosion of code size, host inlining has a built-in
 For example, the tracing may print the following:
 
 ```
-CUTOFF com.oracle.truffle.espresso.nodes.BytecodeNode.putPoolConstant(VirtualFrame, int, char, int)   [inlined   -1, explored    0, monomorphic false, deopt false, inInterpreter false, propDeopt false, graphSize 1132, subTreeCost 5136, invokes    1, subTreeInvokes   12, forced false, incomplete false,  reason call has too many fast-path invokes - too complex, please optimize, see truffle/docs/HostOptimization.md
+CUTOFF com.oracle.truffle.espresso.nodes.BytecodeNode.putPoolConstant(VirtualFrame, int, char, int)   [inlined   -1, explored    0, monomorphic false, deopt false, inInterpreter false, propDeopt false, graphSize 1132, subTreeCost 5136, invokes    1, subTreeInvokes   12, forced false, incomplete false,  reason call has too many fast-path invokes - too complex, please optimize, see truffle/docs/HostCompilation.md
 ```
 
-This indicates that there are too many fast-path invokes (by default 10) in the subtree, it also stops exploring after that number.
+This indicates that there are too many fast-path invokes (see limit in [HostInliningPhase](../../compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/truffle/host/HostInliningPhase.java)) in the subtree, it also stops exploring after that number.
 The `-Djdk.graal.TruffleHostInliningPrintExplored=true` flag may be provided to see the entire subtree for the decision.
 The following calls are considered fast-path invokes:
 
@@ -262,8 +262,8 @@ abstract class AddNode extends Node {
 ```
 
 In this example, the specializations `doInt` and `doDouble` are very simple, but there is also the `doGeneric` specialization, which calls into a complex lookup chain.
-Assuming that the `LookupAndCallNode.execute` is a very complex method with more than ten fast-path subtree calls, we could not expect the execute method to get inlined.
-Host inlining currently does not support automatic component analysis; though it can be specified manually using the `@InliningCutoff` annotation:
+Assuming that the `LookupAndCallNode.execute` is a very complex method with many fast-path subtree calls (see limit in [HostInliningPhase](../../compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/truffle/host/HostInliningPhase.java)), we could not expect the execute method to get inlined.
+Host inlining currently does not support automatic component analysis; though a cutoff can be specified manually using the `@InliningCutoff` annotation:
 
 ```
 abstract class AddNode extends Node {

truffle/mx.truffle/mx_truffle.py

@@ -478,7 +478,7 @@ def slnative(args):
     vm_args, sl_args = mx.extract_VM_args(args, useDoubleDash=True, defaultAllVMArgs=False)
     target_dir = parsed_args.target_folder if parsed_args.target_folder else tempfile.mkdtemp()
     jdk = mx.get_jdk(tag='graalvm')
-    image = _native_image_sl(jdk, vm_args, target_dir, use_optimized_runtime=True, force_cp=False, hosted_assertions=False)
+    image = _native_image_sl(jdk, vm_args, target_dir, use_optimized_runtime=True, force_cp=False, hosted_assertions=False, log_host_inlining=mx.env_var_to_bool("SL_NATIVE_HOST_INLINING"))
     mx.log("Image build completed. Running {}".format(" ".join([image] + sl_args)))
     result = mx.run([image] + sl_args)
     return result
@@ -491,7 +491,7 @@ def _native_image(jdk):
         mx.abort("No native-image installed in GraalVM {}. Switch to an environment that has an installed native-image command.".format(jdk.home))
     return native_image_path
 
-def _native_image_sl(jdk, vm_args, target_dir, use_optimized_runtime=True, use_enterprise=True, force_cp=False, hosted_assertions=True):
+def _native_image_sl(jdk, vm_args, target_dir, use_optimized_runtime=True, use_enterprise=True, force_cp=False, hosted_assertions=True, log_host_inlining=False):
     native_image_args = list(vm_args)
     native_image_path = _native_image(jdk)
     target_path = os.path.join(target_dir, mx.exe_suffix('sl'))
@@ -500,6 +500,16 @@ def _native_image_sl(jdk, vm_args, target_dir, use_optimized_runtime=True, use_e
     if hosted_assertions:
         native_image_args += ["-J-ea", "-J-esa"]
 
+    if log_host_inlining:
+        native_image_args += [
+            "-H:+UnlockExperimentalVMOptions",
+            "-H:Log=HostInliningPhase,~CanonicalizerPhase,~GraphBuilderPhase",
+            "-H:+TruffleHostInliningPrintExplored",
+            "-H:MethodFilter=com.oracle.truffle.sl.*.*",
+            "-H:-UnlockExperimentalVMOptions",
+            "-Dgraal.LogFile=host-inlining.txt",
+        ]
+
     # Even when Truffle is on the classpath, it is loaded as a named module due to
     # the ForceOnModulePath option in its native-image.properties
     # GR-58290: Fixed when ForceOnModulePath is removed

truffle/src/com.oracle.truffle.api.dsl/src/com/oracle/truffle/api/dsl/InlineSupport.java

@@ -169,7 +169,7 @@ private static String getEnclosingSimpleName(Class<?> c) {
 
     /**
      * Marks a field to be accessed with unsafe. This annotation is useful to communicate fields
-     * that must not e rewritten by code obfuscation tools like Proguard.
+     * that must not be rewritten by code obfuscation tools like Proguard.
      *
      * @since 23.0
      */

truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/object/basic/test/CachedFallbackTest.java renamed to truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/api/object/test/CachedFallbackTest.java

@@ -38,18 +38,18 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package com.oracle.truffle.object.basic.test;
+package com.oracle.truffle.api.object.test;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertSame;
 import static org.junit.Assert.assertTrue;
 
-import org.junit.Ignore;
-import org.junit.Test;
-
 import com.oracle.truffle.api.object.DynamicObject;
 import com.oracle.truffle.api.object.DynamicObjectLibrary;
 import com.oracle.truffle.api.object.Shape;
+import org.junit.Ignore;
+import org.junit.Test;
+
 import com.oracle.truffle.api.test.AbstractLibraryTest;
 
 public class CachedFallbackTest extends AbstractLibraryTest {

truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/object/basic/test/CachedGetNode.java renamed to truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/api/object/test/CachedGetNode.java

@@ -38,7 +38,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package com.oracle.truffle.object.basic.test;
+package com.oracle.truffle.api.object.test;
 
 import com.oracle.truffle.api.dsl.GenerateInline;
 import com.oracle.truffle.api.dsl.Specialization;

truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/object/basic/test/CachedPutNode.java renamed to truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/api/object/test/CachedPutNode.java

@@ -38,7 +38,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package com.oracle.truffle.object.basic.test;
+package com.oracle.truffle.api.object.test;
 
 import com.oracle.truffle.api.dsl.GenerateInline;
 import com.oracle.truffle.api.dsl.Specialization;

truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/object/basic/test/ConstantLocationTest.java renamed to truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/api/object/test/ConstantLocationTest.java

@@ -38,11 +38,15 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package com.oracle.truffle.object.basic.test;
+package com.oracle.truffle.api.object.test;
 
 import java.util.Arrays;
 import java.util.List;
 
+import com.oracle.truffle.api.object.DynamicObject;
+import com.oracle.truffle.api.object.DynamicObjectLibrary;
+import com.oracle.truffle.api.object.Property;
+import com.oracle.truffle.api.object.Shape;
 import org.hamcrest.CoreMatchers;
 import org.hamcrest.MatcherAssert;
 import org.junit.Assert;
@@ -51,10 +55,6 @@
 import org.junit.runners.Parameterized;
 import org.junit.runners.Parameterized.Parameters;
 
-import com.oracle.truffle.api.object.DynamicObject;
-import com.oracle.truffle.api.object.DynamicObjectLibrary;
-import com.oracle.truffle.api.object.Property;
-import com.oracle.truffle.api.object.Shape;
 import com.oracle.truffle.api.test.AbstractParametrizedLibraryTest;
 
 @SuppressWarnings("deprecation")

truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/object/ext/test/CustomLayoutTest.java renamed to truffle/src/com.oracle.truffle.api.object.test/src/com/oracle/truffle/api/object/test/CustomLayoutTest.java

@@ -38,16 +38,15 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package com.oracle.truffle.object.ext.test;
+package com.oracle.truffle.api.object.test;
 
 import static org.junit.Assert.assertNotNull;
 
 import java.lang.invoke.MethodHandles;
 
-import org.junit.Test;
-
 import com.oracle.truffle.api.object.DynamicObject;
 import com.oracle.truffle.api.object.Shape;
+import org.junit.Test;
 
 public class CustomLayoutTest {