[GR-65900] Add ReportHotCodePhase to report hot parts in the IR.

PullRequest: graal/21272

Author: davleopo

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/core/test/ReportHotMetricsTest.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2021, 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package jdk.graal.compiler.core.test;
+
+import java.io.ByteArrayOutputStream;
+
+import org.junit.Test;
+
+import jdk.graal.compiler.api.directives.GraalDirectives;
+import jdk.graal.compiler.debug.LogStream;
+import jdk.graal.compiler.debug.TTY;
+import jdk.graal.compiler.options.OptionValues;
+import jdk.graal.compiler.phases.BasePhase;
+
+public class ReportHotMetricsTest extends GraalCompilerTest {
+
+    public static final boolean PRINT_STDOUT = false;
+
+    static int sideEffect;
+
+    public static int snippet01(int limit1) {
+        int result = 0;
+        for (int i = 0; GraalDirectives.injectIterationCount(100000, i < limit1); i++) {
+            // this if is missing a profile and should be reported
+            if (i > sideEffect) {
+                // this kill should be reported
+                GraalDirectives.sideEffect(123);
+            } else {
+                result += i;
+            }
+        }
+        return result;
+    }
+
+    @SuppressWarnings("try")
+    @Test
+    public void testAbsNegate() {
+        ByteArrayOutputStream bos = new ByteArrayOutputStream();
+        try (TTY.Filter ttyFilter = new TTY.Filter(new LogStream(bos))) {
+            OptionValues opt = new OptionValues(getInitialOptions(), BasePhase.PhaseOptions.ReportHotMetrics, "*.snippet01", BasePhase.PhaseOptions.ReportHotMetricsAfterPhases,
+                            "BoxNodeIdentity=*.snippet01");
+            test(opt, "snippet01", 100);
+        }
+        // the missing profile
+        assertTrue(bos.toString().contains("[Hot Code Warning] Unknown profile for"));
+        // the killing of any
+        assertTrue(bos.toString().contains(" kills any and has relative"));
+
+        if (PRINT_STDOUT) {
+            TTY.println("%s%n", bos.toString());
+        }
+    }
+}

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/core/test/VerifyDebugUsage.java

@@ -29,6 +29,8 @@
 import java.util.List;
 import java.util.Set;
 
+import org.graalvm.collections.EconomicSet;
+
 import jdk.graal.compiler.core.GraalCompiler;
 import jdk.graal.compiler.core.common.type.ObjectStamp;
 import jdk.graal.compiler.debug.DebugContext;
@@ -44,6 +46,7 @@
 import jdk.graal.compiler.nodes.spi.CoreProviders;
 import jdk.graal.compiler.phases.BasePhase;
 import jdk.graal.compiler.phases.VerifyPhase;
+import jdk.graal.compiler.phases.common.ReportHotCodePhase;
 import jdk.graal.compiler.replacements.ReplacementsImpl;
 import jdk.graal.compiler.replacements.SnippetTemplate;
 import jdk.graal.compiler.test.GraalTest.MethodSource;
@@ -167,9 +170,11 @@ protected void verifyParameters(MetaAccessProvider metaAccess1, MethodCallTarget
              * The optimization log dumps at a parametrized level, but it must be at least
              * OptimizationLog.MINIMUM_LOG_LEVEL.
              */
-            String optimizationEntryClassName = OptimizationLogImpl.OptimizationEntryImpl.class.getName();
+            EconomicSet<String> allowedClasses = EconomicSet.create();
+            allowedClasses.add(OptimizationLogImpl.OptimizationEntryImpl.class.getName());
+            allowedClasses.add(ReportHotCodePhase.class.getName());
             String callerClassName = debugCallTarget.graph().method().format("%H");
-            if (!optimizationEntryClassName.equals(callerClassName)) {
+            if (!allowedClasses.contains(callerClassName)) {
                 int dumpLevel = verifyDumpLevelParameter(debugCallTarget, verifiedCallee, args.get(1));
                 verifyDumpObjectParameter(debugCallTarget, args.get(2), verifiedCallee, dumpLevel);
             }

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/core/common/CompilationIdentifier.java

@@ -25,6 +25,7 @@
 package jdk.graal.compiler.core.common;
 
 import jdk.vm.ci.code.CompilationRequest;
+import jdk.vm.ci.meta.JavaMethod;
 
 /**
  * A unique identifier for a compilation. Compiled code can be mapped to a single compilation id.
@@ -77,4 +78,12 @@ public CompilationRequest getRequest() {
      * {@link Verbosity}.
      */
     String toString(Verbosity verbosity);
+
+    /**
+     * Get a JavaMethod representation of the current compilation.
+     */
+    default JavaMethod asJavaMethod() {
+        return null;
+    }
+
 }

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/graph/NodeSourcePosition.java

@@ -34,7 +34,6 @@
 import jdk.graal.compiler.bytecode.BytecodeDisassembler;
 import jdk.graal.compiler.bytecode.Bytecodes;
 import jdk.graal.compiler.debug.Assertions;
-
 import jdk.graal.compiler.serviceprovider.GraalServices;
 import jdk.vm.ci.code.BytecodeFrame;
 import jdk.vm.ci.code.BytecodePosition;
@@ -219,9 +218,14 @@ public NodeSourcePosition addCaller(SourceLanguagePosition newSourceLanguagePosi
 
     @Override
     public String toString() {
+        return toString("");
+    }
+
+    public String toString(String indent) {
         StringBuilder sb = new StringBuilder(100);
         NodeSourcePosition pos = this;
         while (pos != null) {
+            sb.append(indent);
             format(sb, pos);
             if (pos.sourceLanguagePosition != null) {
                 sb.append(" source=" + pos.sourceLanguagePosition.toShortString());

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/hotspot/HotSpotCompilationIdentifier.java

@@ -27,8 +27,8 @@
 import jdk.graal.compiler.core.common.CompilationIdentifier;
 import jdk.graal.compiler.core.common.CompilationRequestIdentifier;
 import jdk.graal.compiler.debug.GraalError;
-
 import jdk.vm.ci.hotspot.HotSpotCompilationRequest;
+import jdk.vm.ci.meta.JavaMethod;
 import jdk.vm.ci.runtime.JVMCICompiler;
 
 /**
@@ -98,4 +98,8 @@ public HotSpotCompilationRequest getRequest() {
         return request;
     }
 
+    @Override
+    public JavaMethod asJavaMethod() {
+        return getRequest().getMethod();
+    }
 }

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;
@@ -46,6 +47,7 @@
 import jdk.graal.compiler.debug.GraalError;
 import jdk.graal.compiler.debug.GraphFilter;
 import jdk.graal.compiler.debug.MemUseTrackerKey;
+import jdk.graal.compiler.debug.MethodFilter;
 import jdk.graal.compiler.debug.TTY;
 import jdk.graal.compiler.debug.TimerKey;
 import jdk.graal.compiler.graph.Graph;
@@ -62,9 +64,11 @@
 import jdk.graal.compiler.options.OptionKey;
 import jdk.graal.compiler.options.OptionType;
 import jdk.graal.compiler.options.OptionValues;
+import jdk.graal.compiler.phases.common.ReportHotCodePhase;
 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;
 
 /**
@@ -203,6 +207,12 @@ public static class PhaseOptions {
         public static final OptionKey<Integer> MinimalGraphNodeSizeCheckSize = new OptionKey<>(1000);
         @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 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 OptionKey<String> ReportHotMetricsBeforePhases =  new OptionKey<>("HighTierLoweringPhase");
+        @Option(help = "Report hot metrics extracted from compiler IR.", type = OptionType.Debug)
+        public static final OptionKey<String> ReportHotMetrics = new OptionKey<>(null);
         // @formatter:on
     }
 
@@ -389,7 +399,7 @@ protected ApplyScope applyScope(StructuredGraph graph, C context) {
         return null;
     }
 
-    @SuppressWarnings("try")
+    @SuppressWarnings({"try", "unchecked", "rawtypes"})
     public final void apply(final StructuredGraph graph, final C context, final boolean dumpGraph) {
         DebugContext debug = graph.getDebug();
         OptionValues options = graph.getOptions();
@@ -449,6 +459,26 @@ public final void apply(final StructuredGraph graph, final C context, final bool
                 dumpedBefore = dumpBefore(graph, context, isTopLevel, true);
             }
 
+            String reportHotMetricsMethodFilter = PhaseOptions.ReportHotMetrics.getValue(options);
+            boolean logHotMetricsForGraph = false;
+            if (reportHotMetricsMethodFilter != null) {
+                MethodFilter hotMetricsMethodFilter = null;
+                hotMetricsMethodFilter = 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);
+                    }
+                }
+            }
+
             // This is a manual version of a try/resource pattern since the close operation might
             // want to know whether the run call completed with an exception or not.
             ApplyScope applyScope = applyScope(graph, context);
@@ -495,6 +525,15 @@ public final void apply(final StructuredGraph graph, final C context, final bool
                 }
             }
 
+            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);
+                }
+            }
+
         } catch (Throwable t) {
             throw debug.handle(t);
         }