Add a CPU profiler (#1823)

This introduces a way to run CPU profiling.

The profiler produces output in pprof format.

CLI users can enable CPU profiling via command line flags.
Profiling is otherwise not offered as an API.

Co-authored-by: Jen Basch <jbasch94@gmail.com>
Co-authored-by: Islon Scherer <islonscherer@gmail.com>

Author: 3 people

THIRD-PARTY-NOTICES.txt

@@ -408,3 +408,56 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+28) protobuf-java
+License URL: https://github.com/protocolbuffers/protobuf/blob/main/LICENSE
+
+Copyright 2008 Google Inc.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+    * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Code generated by the Protocol Buffer compiler is owned by the owner
+of the input file used when generating it.  This code is not
+standalone and requires a support library to be linked with it.  This
+support library is itself covered by the above license.
+
+29) pprof
+License URL: https://github.com/google/pprof/blob/main/LICENSE
+
+Copyright 2016 Google Inc. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

build-logic/src/main/kotlin/NativeImageBuild.kt

@@ -227,6 +227,8 @@ abstract class NativeImageBuild : DefaultTask() {
         add("--initialize-at-run-time=org.pkl.core.util.DebugLogger")
         // needed for jline-terminal-jni
         add("--initialize-at-run-time=org.jline.nativ,org.jline.terminal.impl.jni")
+        // needed for protobuf-java
+        add("--initialize-at-run-time=com.google.protobuf.UnsafeUtil")
         add("--no-fallback")
         add("-H:IncludeResources=org/pkl/core/stdlib/.*\\.pkl")
         add("-H:IncludeResources=org/jline/utils/.*")

build-logic/src/main/kotlin/pklFatJar.gradle.kts

@@ -66,6 +66,11 @@ val relocations =
 
     // pkl-codegen-kotlin dependencies
     "com.squareup.kotlinpoet." to "org.pkl.thirdparty.kotlinpoet.",
+
+    // pkl-profiler dependencies
+    "com.google.protobuf." to "org.pkl.thirdparty.com.google.protobuf.",
+    "com.google.perftools." to "org.pkl.thirdparty.com.google.perftools.",
+    "google.protobuf." to "org.pkl.thirdparty.google.protobuf.",
   )
 
 for ((key, value) in relocations) {

docs/modules/pkl-cli/pages/index.adoc

@@ -450,6 +450,24 @@ When enabled, type constraint failures will show intermediate values in the asse
 Use `--no-power-assertions` to disable this feature if you prefer simpler output or better performance.
 ====
 
+[[profile-cpu-output]]
+.--profile-cpu-output
+[%collapsible]
+====
+Default: (none) +
+The file to write profiler output to. Omitting this option disables CPU profiling entirely. +
+
+The CPU profiler writes output in https://github.com/google/pprof[pprof] format.
+====
+
+[[profile-cpu-sample-period]]
+.--profile-cpu-sample-period
+[%collapsible]
+====
+Default: 10 +
+The sampling duration for the CPU sampler, in milliseconds.
+====
+
 This command also takes <<common-options, common options>>.
 
 [[command-server]]

gradle/libs.versions.toml

@@ -62,6 +62,8 @@ nullaway = "0.13.7"
 nullawayPlugin = "3.0.0"
 nuValidator = "26.7.3"
 paguro = "3.10.3"
+protobufPlugin = "0.10.0"
+protobuf = "4.35.1"
 shadowPlugin = "9.5.1"
 slf4j = "2.0.20"
 snakeYaml = "3.0.1"
@@ -117,6 +119,8 @@ nullaway = { group = "com.uber.nullaway", name = "nullaway", version.ref = "null
 nullawayPlugin = { group = "net.ltgt.gradle", name = "gradle-nullaway-plugin", version.ref = "nullawayPlugin" }
 # to be replaced with https://github.com/usethesource/capsule or https://github.com/lacuna/bifurcan
 paguro = { group = "org.organicdesign", name = "Paguro", version.ref = "paguro" }
+protobuf = { group = "com.google.protobuf", name = "protobuf-java", version.ref = "protobuf" }
+protoc = { group = "com.google.protobuf", name = "protoc", version.ref = "protobuf" }
 pklConfigJavaAll025 = { group = "org.pkl-lang", name = "pkl-config-java-all", version = "0.25.0" }
 shadowPlugin = { group = "com.gradleup.shadow", name = "com.gradleup.shadow.gradle.plugin", version.ref = "shadowPlugin" }
 slf4jApi = { group = "org.slf4j", name = "slf4j-api", version.ref = "slf4j" }
@@ -125,6 +129,7 @@ snakeYaml = { group = "org.snakeyaml", name = "snakeyaml-engine", version.ref =
 spotlessPlugin = { group = "com.diffplug.spotless", name = "spotless-plugin-gradle", version.ref = "spotlessPlugin"}
 svm = { group = "org.graalvm.nativeimage", name = "svm", version.ref = "graalVmJdkVersion" }
 truffleApi = { group = "org.graalvm.truffle", name = "truffle-api", version.ref = "graalVm" }
+truffleProfiler = { group = "org.graalvm.tools", name = "profiler-tool", version.ref = "graalVm" }
 truffleDslProcessor = { group = "org.graalvm.truffle", name = "truffle-dsl-processor", version.ref = "graalVm" }
 truffleSvm = { group = "org.graalvm.nativeimage", name = "truffle-runtime-svm", version.ref = "graalVmJdkVersion" }
 truffleRuntime = { group = "org.graalvm.truffle", name = "truffle-runtime", version.ref = "graalVm" }
@@ -135,10 +140,11 @@ checksum = { id = "org.gradle.crypto.checksum", version.ref = "checksumPlugin" }
 #noinspection UnusedVersionCatalogEntry
 errorProne = { id = "net.ltgt.errorprone", version.ref = "errorPronePlugin" }
 ideaExt = { id = "org.jetbrains.gradle.plugin.idea-ext", version.ref = "ideaExtPlugin" }
+jextract = { id = "de.infolektuell.jextract", version.ref = "jextractPlugin" }
 jmh = { id = "me.champeau.jmh", version.ref = "jmhPlugin" }
 kotlinxSerialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlinToolchain" }
 nexusPublish = { id = "io.github.gradle-nexus.publish-plugin", version.ref = "nexusPublishPlugin" }
 #noinspection UnusedVersionCatalogEntry
 nullaway = { id = "net.ltgt.nullaway", version.ref = "nullawayPlugin" }
 shadow = { id = "com.gradleup.shadow", version.ref = "shadowPlugin" }
-jextract = { id = "de.infolektuell.jextract", version.ref = "jextractPlugin" }
+protobuf = { id = "com.google.protobuf", version.ref = "protobufPlugin" }

pkl-cli/pkl-cli.gradle.kts

@@ -61,10 +61,13 @@ dependencies {
   implementation(libs.jlineTerminalJni)
   implementation(projects.pklServer)
   implementation(projects.pklFormatter)
+  implementation(projects.pklProfiler)
+  implementation(libs.truffleProfiler)
   implementation(libs.clikt)
 
   testImplementation(projects.pklCommonsTest)
   testImplementation(libs.wiremock)
+  testImplementation(libs.protobuf)
 
   // used by `pklJavaExecutable` plugin (ideally this would be inferred automatically)
   firstPartySourcesJars(project(":pkl-cli", "sourcesJar"))
@@ -74,6 +77,7 @@ dependencies {
   firstPartySourcesJars(project(":pkl-formatter", "sourcesJar"))
   firstPartySourcesJars(project(":pkl-parser", "sourcesJar"))
   firstPartySourcesJars(project(":pkl-server", "sourcesJar"))
+  firstPartySourcesJars(project(":pkl-profiler", "sourcesJar"))
 }
 
 tasks.jar {
@@ -83,6 +87,9 @@ tasks.jar {
 
 tasks.javadoc { enabled = false }
 
+// has its own dedicated task; see `testProfilerOutput` and `testNativeProfilerOutput` below
+tasks.test { exclude("**/SubprocessProfilerOutputTest.class") }
+
 tasks.shadowJar {
   archiveFileName.set("jpkl")
 
@@ -105,6 +112,8 @@ val testJavaExecutable =
         // executable;
         // to verify that, we don't want to include them here)
         (configurations.testRuntimeClasspath.get() - configurations.runtimeClasspath.get())
+    // has its own dedicated task; see `testProfilerOutput` and `testNativeProfilerOutput` below
+    exclude("**/SubprocessProfilerOutputTest.class")
   }
 
 // Setup `testJavaExecutable` tasks for multi-JDK testing.
@@ -162,18 +171,97 @@ val testEvalJavaExecutableOnOtherJdks =
     }
   }
 
+val generateReachabilityMetadata =
+  tasks.register<JavaExec>("generateReachabilityMetadata") {
+    dependsOn(tasks.javaExecutable)
+
+    // The native-image-agent requires GraalVM's java, not a regular JDK.
+    val graalVm =
+      if (buildInfo.arch == Target.Arch.AMD64) buildInfo.graalVmAmd64 else buildInfo.graalVmAarch64
+    dependsOn(
+      if (buildInfo.arch == Target.Arch.AMD64) ":installGraalVmAmd64" else ":installGraalVmAarch64"
+    )
+
+    executable(
+      File(graalVm.baseDir)
+        .resolve("bin")
+        .resolve(if (buildInfo.os.isWindows) "java.exe" else "java")
+        .absolutePath
+    )
+
+    val outputDir = layout.buildDirectory.dir("generated-reachability-metadata")
+    val outputFile = outputDir.map {
+      it.asFile.resolve("META-INF/native-image/org.pkl-lang/pkl-cli/reachability-metadata.json")
+    }
+    val profilerOutput = layout.buildDirectory.file("tmp/profile.pb.gz")
+    outputs.file(outputFile)
+
+    classpath = tasks.javaExecutable.get().outputs.files
+
+    // invoke the profiler to include metadata for protobuf serdes
+    args("eval", "--profile-cpu-output", profilerOutput.get().asFile.absolutePath, "pkl:settings")
+    setStandardOutput(OutputStream.nullOutputStream())
+
+    jvmArgumentProviders.add(
+      CommandLineArgumentProvider {
+        buildList {
+          add("-agentlib:native-image-agent=config-output-dir=${outputFile.get().parent}")
+        }
+      }
+    )
+
+    doLast {
+      if (!outputFile.get().exists()) {
+        throw GradleException("Did not create expected file: ${outputFile.get()}")
+      }
+    }
+  }
+
+val testProfilerOutput =
+  tasks.register<Test>("testProfilerOutput") {
+    group = "verification"
+    dependsOn(tasks.javaExecutable)
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+    include("**/SubprocessProfilerOutputTest.class")
+    systemProperty(
+      "org.pkl.cli.testJar",
+      tasks.javaExecutable.get().outputs.files.singleFile.absolutePath,
+    )
+  }
+
+val testNativeProfilerOutput =
+  tasks.register<Test>("testNativeProfilerOutput") {
+    group = "verification"
+    dependsOn(tasks.assembleNative)
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+    include("**/SubprocessProfilerOutputTest.class")
+    systemProperty(
+      "org.pkl.cli.testExecutable",
+      tasks.assembleNative.get().outputs.files.singleFile.absolutePath,
+    )
+  }
+
+tasks.withType<NativeImageBuild>().configureEach {
+  dependsOn(generateReachabilityMetadata)
+  classpath.from(layout.buildDirectory.dir("generated-reachability-metadata"))
+}
+
 tasks.check {
   dependsOn(
     testJavaExecutable,
     testJavaExecutableOnOtherJdks,
     testEvalJavaExecutable,
     testEvalJavaExecutableOnOtherJdks,
+    testProfilerOutput,
   )
 }
 
 tasks.checkNative {
   dependsOn(":pkl-core:checkNative")
   dependsOn(":pkl-server:checkNative")
+  dependsOn(testNativeProfilerOutput)
 }
 
 executable {

pkl-cli/src/main/kotlin/org/pkl/cli/CliCommandRunner.kt

@@ -21,6 +21,7 @@ import com.github.ajalt.clikt.core.*
 import com.github.ajalt.clikt.parameters.arguments.*
 import com.github.ajalt.clikt.parameters.options.*
 import com.github.ajalt.clikt.parameters.types.int
+import com.oracle.truffle.api.TruffleOptions
 import java.io.OutputStream
 import java.net.URI
 import java.nio.file.Path
@@ -40,6 +41,8 @@ import org.pkl.core.FileOutput
 import org.pkl.core.ModuleSource.uri
 import org.pkl.core.PklBugException
 import org.pkl.core.PklException
+import org.pkl.core.ProfilerOptions
+import org.pkl.core.runtime.VmUtils
 import org.pkl.core.util.IoUtils
 
 class CliCommandRunner
@@ -51,15 +54,18 @@ constructor(
   private val args: List<String>,
   private val outputStream: OutputStream = System.out,
   private val errStream: OutputStream = System.err,
+  private val profilerOptions: ProfilerOptions = ProfilerOptions.DEFAULT,
 ) : CliCommand(options) {
-
   override fun doRun() {
     val builder = evaluatorBuilder()
     try {
-      evalCmd(builder)
+      withCpuProfiler(profilerOptions) { evalCmd(builder) }
     } finally {
       Closeables.closeQuietly(builder.moduleKeyFactories)
       Closeables.closeQuietly(builder.resourceReaders)
+      if (TruffleOptions.AOT) {
+        VmUtils.closeEngine()
+      }
     }
   }
 

pkl-cli/src/main/kotlin/org/pkl/cli/CliEvaluator.kt

@@ -15,6 +15,7 @@
  */
 package org.pkl.cli
 
+import com.oracle.truffle.api.TruffleOptions
 import java.io.File
 import java.io.InputStream
 import java.io.OutputStream
@@ -99,14 +100,19 @@ constructor(
   override fun doRun() {
     val builder = evaluatorBuilder()
     try {
-      if (options.multipleFileOutputPath != null) {
-        writeMultipleFileOutput(builder)
-      } else {
-        writeOutput(builder)
+      withCpuProfiler(options.profilerOptions) {
+        if (options.multipleFileOutputPath != null) {
+          writeMultipleFileOutput(builder)
+        } else {
+          writeOutput(builder)
+        }
       }
     } finally {
       Closeables.closeQuietly(builder.moduleKeyFactories)
       Closeables.closeQuietly(builder.resourceReaders)
+      if (TruffleOptions.AOT) {
+        VmUtils.closeEngine()
+      }
     }
   }
 

pkl-cli/src/main/kotlin/org/pkl/cli/CliEvaluatorOptions.kt

@@ -16,6 +16,7 @@
 package org.pkl.cli
 
 import org.pkl.commons.cli.CliBaseOptions
+import org.pkl.core.ProfilerOptions
 
 /** Configuration options for [CliEvaluator]. */
 data class CliEvaluatorOptions(
@@ -77,6 +78,13 @@ data class CliEvaluatorOptions(
    * If unset, the module's `output.bytes` property is evaluated.
    */
   val expression: String? = null,
+
+  /**
+   * CPU/Memory profiling options.
+   *
+   * WARN: This is an internal option only. Profiling is currently only supported via CLI flags.
+   */
+  val profilerOptions: ProfilerOptions = ProfilerOptions.DEFAULT,
 ) {
 
   companion object {