change option layout for report hot metrics phase

Author: davleopo

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/phases/BasePhase.java

@@ -37,6 +37,7 @@
 import org.graalvm.collections.EconomicMap;
 
 import jdk.graal.compiler.core.GraalCompilerOptions;
+import jdk.graal.compiler.core.common.CompilationIdentifier;
 import jdk.graal.compiler.core.common.util.CompilationAlarm;
 import jdk.graal.compiler.debug.CounterKey;
 import jdk.graal.compiler.debug.DebugCloseable;
@@ -66,6 +67,7 @@
 import jdk.graal.compiler.phases.contract.NodeCostUtil;
 import jdk.graal.compiler.phases.contract.PhaseSizeContract;
 import jdk.graal.compiler.serviceprovider.GraalServices;
+import jdk.vm.ci.meta.JavaMethod;
 import jdk.vm.ci.meta.SpeculationLog;
 
 /**
@@ -205,11 +207,11 @@ public static class PhaseOptions {
         @Option(help = "Exclude certain phases from compilation based on the given phase filter(s)." + PhaseFilterKey.HELP, type = OptionType.Debug)
         public static final PhaseFilterKey CompilationExcludePhases = new PhaseFilterKey(null, null);
         @Option(help = "Report hot metrics after each phase matching the given phase filter(s).", type = OptionType.Debug)
-        public static final PhaseFilterKey ReportHotMetricsAfterPhases = new PhaseFilterKey(null, null);
+        public static final OptionKey<String> ReportHotMetricsAfterPhases = new OptionKey<>(null);;
         @Option(help = "Report hot metrics before each phase matching the given phase filter(s).", type = OptionType.Debug)
-        public static final PhaseFilterKey ReportHotMetricsBeforePhases = new PhaseFilterKey("HighTierLoweringPhase=*", null);
+        public static final OptionKey<String> ReportHotMetricsBeforePhases =  new OptionKey<String>("HighTierLoweringPhase");
         @Option(help = "Report hot metrics extracted from compiler IR.", type = OptionType.Debug)
-        public static final OptionKey<Boolean> ReportHotMetrics = new OptionKey<>(false);
+        public static final OptionKey<String> ReportHotMetrics = new OptionKey<>(null);
         // @formatter:on
     }
 
@@ -456,12 +458,23 @@ public final void apply(final StructuredGraph graph, final C context, final bool
                 dumpedBefore = dumpBefore(graph, context, isTopLevel, true);
             }
 
-            if (PhaseOptions.ReportHotMetrics.getValue(options) && PhaseOptions.ReportHotMetricsBeforePhases.matches(options, this, graph)) {
-                // if there is a method filter set we must also match that one
-                if (graph.getDebug().methodFilterMatchesCurrentMethod()) {
-                    String label = graph.name != null ? graph.name : graph.method().format("%H.%n(%p)");
-                    TTY.println("Reporting hot metrics before " + getName() + " during compilation of " + label);
-                    new ReportHotCodePhase().apply(graph, context);
+            String reportHotMetricsMethodFilter = PhaseOptions.ReportHotMetrics.getValue(options);
+            boolean logHotMetricsForGraph = false;
+            if (reportHotMetricsMethodFilter != null) {
+                jdk.graal.compiler.debug.MethodFilter hotMetricsMethodFilter = null;
+                hotMetricsMethodFilter = jdk.graal.compiler.debug.MethodFilter.parse(reportHotMetricsMethodFilter);
+                logHotMetricsForGraph = graph.method() != null && hotMetricsMethodFilter.matches(graph.method());
+                if (!logHotMetricsForGraph) {
+                    CompilationIdentifier id = graph.compilationId();
+                    JavaMethod idMethod = id.asJavaMethod();
+                    logHotMetricsForGraph = idMethod != null && hotMetricsMethodFilter.matches(idMethod);
+                }
+                if (logHotMetricsForGraph) {
+                    if (PhaseOptions.ReportHotMetricsBeforePhases.getValue(graph.getOptions()).equals(getClass().getSimpleName())) {
+                        String label = graph.name != null ? graph.name : graph.method().format("%H.%n(%p)");
+                        TTY.println("Reporting hot metrics before " + getName() + " during compilation of " + label);
+                        new ReportHotCodePhase().apply(graph, context);
+                    }
                 }
             }
 
@@ -511,9 +524,9 @@ public final void apply(final StructuredGraph graph, final C context, final bool
                 }
             }
 
-            if (PhaseOptions.ReportHotMetrics.getValue(options) && PhaseOptions.ReportHotMetricsAfterPhases.matches(options, this, graph)) {
-                // if there is a method filter set we must also match that one
-                if (graph.getDebug().methodFilterMatchesCurrentMethod()) {
+            if (logHotMetricsForGraph) {
+                String reportAfterPhase = PhaseOptions.ReportHotMetricsAfterPhases.getValue(graph.getOptions());
+                if (reportAfterPhase != null && reportAfterPhase.equals(getClass().getSimpleName())) {
                     String label = graph.name != null ? graph.name : graph.method().format("%H.%n(%p)");
                     TTY.println("Reporting hot metrics after " + getName() + " during compilation of " + label);
                     new ReportHotCodePhase().apply(graph, context);

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/phases/common/ReportHotCodePhase.java

@@ -31,6 +31,7 @@
 
 import jdk.graal.compiler.debug.TTY;
 import jdk.graal.compiler.graph.Node;
+import jdk.graal.compiler.graph.NodeSourcePosition;
 import jdk.graal.compiler.nodes.FixedGuardNode;
 import jdk.graal.compiler.nodes.FixedNode;
 import jdk.graal.compiler.nodes.GraphState;
@@ -280,9 +281,15 @@ protected void run(StructuredGraph graph, C c) {
     private static void reportUnknownProfile(Loop l, Node inside, ControlFlowGraph cfg) {
         if (inside instanceof IfNode ifNode) {
             if (ifNode.profileSource().isUnknown()) {
-                warn("Unknown profile for %s with f=%s in hot loop %s, nsp is %n%s%n\tPotential Action Item: Add profile to the top-of-stack source location.%n", ifNode,
-                                cfg.blockFor(inside).getRelativeFrequency(), l,
-                                ifNode.getNodeSourcePosition().toString("\t"));
+                NodeSourcePosition nsp = ifNode.getNodeSourcePosition();
+                if (nsp == null) {
+                    warn("Unknown profile for %s with f=%s in hot loop %s, NO NODE SOURCE POSITION%n\tPotential Action Item: Determine lack of node source position and profile.%n", ifNode,
+                                    cfg.blockFor(inside).getRelativeFrequency(), l);
+                } else {
+                    warn("Unknown profile for %s with f=%s in hot loop %s, nsp is %n%s%n\tPotential Action Item: Add profile to the top-of-stack source location.%n", ifNode,
+                                    cfg.blockFor(inside).getRelativeFrequency(), l,
+                                    ifNode.getNodeSourcePosition().toString("\t"));
+                }
             }
         }
     }

truffle/docs/Optimizing.md

@@ -822,19 +822,15 @@ These are similar to Truffle performance warnings but may surface later in the p
 ### Enabling Compiler-Level Metrics
 To enable reporting of these metrics, launch your application with:
 ```
---vm.Djdk.graal.ReportHotMetrics=true
+--vm.Djdk.graal.ReportHotMetrics=<method filter>
 ```
 This prints warnings and hot spots to `stdout` for all compilation units.
 
-To narrow output to specific methods or functions, combine with:
+To narrow output to specific methods or functions use known method names like:
 ```
---vm.Djdk.graal.MethodFilter='<filter>'
+--vm.Djdk.graal.ReportHotMetrics='*wasm-function:5311*'
 ```
-For example:
-```
---vm.Djdk.graal.MethodFilter='*wasm-function:3708*'
-```
-
+To improve the quality of the generated data run with node source position tracking `--vm.Djdk.graal.TrackNodeSourcePosition=true`.
 
 ### Example Output
 ```