add ReportHotMetricsAfterPhases to report hot parts in the IR with a set

of initial performance warnings based on static IR data

Author: davleopo

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

@@ -0,0 +1,73 @@
+/*
+ * 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 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;
+    }
+
+    @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.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/src/jdk/graal/compiler/phases/BasePhase.java

@@ -62,6 +62,7 @@
 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;
@@ -203,6 +204,8 @@ 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 PhaseFilterKey ReportHotMetricsAfterPhases = new PhaseFilterKey(null, null);        
         // @formatter:on
     }
 
@@ -495,6 +498,12 @@ public final void apply(final StructuredGraph graph, final C context, final bool
                 }
             }
 
+            if (PhaseOptions.ReportHotMetricsAfterPhases.matches(options, this, graph)) {
+                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);
         }