cds+ij - add an action to IntelliJ to generate the CDS archive directly from IntelliJ process

We start background JVM to with -Xshare=dump to generate the archive after injecting an agent Partially work in progress (hardcoded paths will be removed soon) GitOrigin-RevId: 4c8ed278d0beaca3d897d3b3cc66d793da086e49
2026-10-06 06:21:16 +07:00 · 2019-10-13 07:39:55 +00:00
parent 976093a73e
commit 289481af10
2 changed files with 103 additions and 0 deletions
@@ -0,0 +1,101 @@
+// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
+package com.intellij.ide.cds
+
+import com.intellij.execution.process.OSProcessUtil
+import com.intellij.openapi.actionSystem.AnAction
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.application.ApplicationInfo
+import com.intellij.openapi.application.PathManager
+import com.intellij.openapi.diagnostic.Logger
+import com.intellij.openapi.util.SystemInfo
+import com.intellij.openapi.util.text.StringUtil
+import com.intellij.util.concurrency.AppExecutorUtil
+import com.sun.tools.attach.VirtualMachine
+import java.io.File
+import java.util.concurrent.TimeUnit
+import kotlin.system.measureTimeMillis
+
+object CDSArchiveManager {
+  private val LOG = Logger.getInstance(javaClass)
+
+  fun injectCDSAgent() {
+    // The AppCDS (JEP 350) is only added in JDK10,
+    // The closest JRE we ship/support is 11
+    if (!SystemInfo.isJavaVersionAtLeast(11)) return
+
+    //We use AppCDS feature that require
+    // patches to work in Windows and macOS
+    if (!SystemInfo.isJetBrainsJvm) return
+
+    val info = ApplicationInfo.getInstance()
+    val prefix = "classes-${info.build.asString()}-${System.currentTimeMillis()}"
+
+    val cwd = File(".").canonicalFile
+    val agentPath = System.getProperty("intellij.cds.agentlib", "E:\\Work\\intellij\\out\\classes\\artifacts\\classesLogAgent_jar\\classesLogAgent.jar")
+
+    val baseDir = File(PathManager.getSystemPath(), "cds")
+    baseDir.mkdirs()
+
+    //TODO: cleanup stale files
+    val classesListFile = File(baseDir, "$prefix.txt")
+    val classesPathFile = File(baseDir, "$prefix.classpath")
+    val classesArchiveFile = File(baseDir, "$prefix.jsa")
+
+    LOG.info("Starting generation of CDS archive to the $classesListFile and $classesPathFile files")
+
+    val durationList = measureTimeMillis {
+      try {
+        val vm = VirtualMachine.attach(OSProcessUtil.getApplicationPid())
+        try {
+          vm.loadAgent(agentPath, "$classesListFile,$classesPathFile")
+        }
+        finally {
+          vm.detach()
+        }
+      }
+      catch (t: Throwable) {
+        LOG.warn("Failed to attach CDS Java Agent to the running IDE instance. ${t.message}", t)
+      }
+    }
+
+    LOG.info("CDS classes file is generated in ${StringUtil.formatDuration(durationList)}")
+    LOG.info("Running JVM to dump classes...")
+
+    val durationLink = measureTimeMillis {
+      val ext = if (SystemInfo.isWindows) ".exe" else ""
+      val javaExe = File(System.getProperty("java.home")!!) / "bin" / "java$ext"
+      val args = listOf(
+        javaExe.path,
+        "-Xshare:dump",
+        "-XX:+UnlockDiagnosticVMOptions",
+        "-XX:SharedClassListFile=$classesListFile",
+        "-XX:SharedArchiveFile=$classesArchiveFile",
+        "-cp",
+        "@$classesPathFile"
+      )
+
+      LOG.info("Running CDS generation process: $args in $cwd")
+
+      val process = ProcessBuilder().command(args).inheritIO().directory(cwd).start()
+      if (!process.waitFor(10, TimeUnit.MINUTES)) {
+        LOG.warn("Failed to generate CDS archive, the process took too long and will be killed")
+        process.destroyForcibly()
+        return
+      }
+    }
+
+    LOG.info("Generated CDS archive to $classesArchiveFile, size = ${StringUtil.formatFileSize(classesArchiveFile.length())} in ${StringUtil.formatDuration(durationLink)}")
+
+    //TODO: update VMOptions
+  }
+}
+
+
+class InstallCDSArchiveAction : AnAction("Install CDS Archive") {
+  override fun actionPerformed(e: AnActionEvent) {
+    AppExecutorUtil.getAppExecutorService().execute { CDSArchiveManager.injectCDSAgent() }
+  }
+}
+
+private operator fun File.div(s: String) = File(this, s)
+
@@ -827,6 +827,8 @@
        <separator/>
        <action id="CheckForUpdate" class="com.intellij.openapi.updateSettings.impl.CheckForUpdateAction"/>
        <action id="About" class="com.intellij.ide.actions.AboutAction"/>
+        <separator/>
+        <action id="installCDS" class="com.intellij.ide.cds.InstallCDSArchiveAction"/>
      </group>

      <group id="OtherMenu" class="com.intellij.ide.actions.NonEmptyActionGroup"/>