Merge pull request #53 from retronym/topic/profile

Add SBT command to collect profiles

Author: retronym

build.sbt

@@ -1,3 +1,6 @@
+import sbt.complete.DefaultParsers.OptSpace
+import sbt.complete.Parser
+
 name := "compiler-benchmark"
 
 version := "1.0-SNAPSHOT"
@@ -93,6 +96,41 @@ addCommandAlias("hot", "compilation/jmh:run HotScalacBenchmark -foe true")
 
 addCommandAlias("cold", "compilation/jmh:run ColdScalacBenchmark -foe true")
 
+
+def profParser(s: State): Parser[String] = {
+  import Parser._
+  token("prof" ~> OptSpace) flatMap { _ => matched(s.combinedParser)} map (_.trim)
+}
+
+commands += Command.custom((s: State) => Command.applyEffect(profParser(s))((line: String) => {
+  val flameGraphOpts = s"--minwidth,1,--colors,java,--cp,--width,1800"
+  abstract class Profiler(val name: String) {
+    def command(outDir: File): String
+  }
+
+  object basic extends Profiler("basic") {
+    def command(outDir: File): String = "-jvmArgs -Xprof -prof hs_comp -prof hs_gc -prof stack -prof hs_rt"
+  }
+  object jfr extends Profiler("jfr") {
+    def command(outDir: File): String = s"-prof jmh.extras.JFR:dir=${outDir.getAbsolutePath};flameGraphOpts=$flameGraphOpts;verbose=true'"
+  }
+  object async extends Profiler("async") {
+    def command(outDir: File): String = s"-prof jmh.extras.Async:dir=${outDir.getAbsolutePath};flameGraphOpts=$flameGraphOpts;verbose=true;event=cpu" // + ";simpleName=true" TODO add this after upgrading next sbt-jmh release
+  }
+  object perfNorm extends Profiler("perfNorm") {
+    def command(outDir: File): String = "-prof perfnorm"
+  }
+
+  val profs = List(perfNorm, basic, async, jfr)
+  val commands: List[String] = profs.flatMap { (prof: Profiler) =>
+    val outDir = file(s"target/profile-${prof.name}")
+    IO.createDirectory(outDir)
+    List(line + " -jvmArgs -Dsun.reflect.inflationThreshold=0 " + prof.command(outDir) + s" -o ${(outDir / "jmh.log").getAbsolutePath} -rf json -rff ${(outDir / "result.json").getAbsolutePath}", BasicCommandStrings.FailureWall)
+  }
+  s.copy(remainingCommands = BasicCommandStrings.ClearOnFailure :: commands ++ s.remainingCommands)
+}))
+
+
 def addJmh(project: Project): Project = {
   // IntelliJ SBT project import doesn't like sbt-jmh's default setup, which results the prod and test
   // output paths overlapping. This is because sbt-jmh declares the `jmh` config as extending `test`, but

infrastructure/src/main/java/scala/bench/ScalacBenchmarkRunner.java

@@ -67,9 +67,9 @@ else return new OptionsBuilder()
 
     public static void main(String[] args) throws Exception {
         CommandLineOptions opts = new CommandLineOptions(args);
-        // Support `-h`, copied from org.openjdk.jmh.Main. Could also add -l/lp/lprof/lrf.
-        if (opts.shouldHelp()) {
-            opts.showHelp();
+        // Support `-h/-l/lp/lprof/lrf`.
+        if (opts.shouldHelp() || opts.shouldList() || opts.shouldListProfilers() || opts.shouldListResultFormats() || opts.shouldListWithParams()) {
+            org.openjdk.jmh.Main.main(args);
             return;
         }
         new Runner(setCorpusVersion(opts)).run();

infrastructure/src/main/java/scala/bench/UploadingRunner.java

@@ -16,7 +16,11 @@
 public class UploadingRunner {
     public static void main(String[] args) throws Exception {
         Options opts = ScalacBenchmarkRunner.setCorpusVersion(new CommandLineOptions(args));
-        Runner runner = new Runner(opts, new UploadingOutputFormat(createOutputFormat(opts)));
+        OutputFormat outputFormat = createOutputFormat(opts);
+        if (opts.getProfilers().size() == 0) {
+            outputFormat = new UploadingOutputFormat(outputFormat);
+        }
+        Runner runner = new Runner(opts, outputFormat);
         runner.run();
     }
 

project/plugins.sbt

@@ -2,7 +2,7 @@
 logLevel := Level.Warn
 
 // sbt-jmh plugin - pulls in JMH dependencies too
-addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.2.25")
+addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.3.0")
 
 // sbt-dotty plugin - to support `scalaVersion := "0.x"`
 addSbtPlugin("ch.epfl.lamp" % "sbt-dotty" % "0.1.2")