Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CMP-5906 Add option to enable Class data sharing (CDS) #2080

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ abstract class JvmApplicationDistributions : AbstractDistributions() {
}
var includeAllModules: Boolean = false

var cds: Boolean = false

val linux: LinuxPlatformSettings = objects.newInstance(LinuxPlatformSettings::class.java)
open fun linux(fn: Action<LinuxPlatformSettings>) {
fn.execute(linux)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ private fun JvmApplicationContext.configureCommonJvmDesktopTasks(): CommonJvmDes
modules.set(provider { app.nativeDistributions.modules })
includeAllModules.set(provider { app.nativeDistributions.includeAllModules })
javaRuntimePropertiesFile.set(checkRuntime.flatMap { it.javaRuntimePropertiesFile })
cds.set(provider { app.nativeDistributions.cds })
destinationDir.set(appTmpDir.dir("runtime"))
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.Optional
import org.jetbrains.compose.desktop.application.internal.RuntimeCompressionLevel
import org.gradle.process.ExecResult
import org.jetbrains.compose.desktop.application.internal.JvmRuntimeProperties
import org.jetbrains.compose.desktop.application.internal.RuntimeCompressionLevel
import org.jetbrains.compose.desktop.application.internal.cliArg
import org.jetbrains.compose.internal.utils.ioFile
import org.jetbrains.compose.internal.utils.notNullProperty
Expand All @@ -31,6 +32,9 @@ abstract class AbstractJLinkTask : AbstractJvmToolOperationTask("jlink") {
@get:InputFile
val javaRuntimePropertiesFile: RegularFileProperty = objects.fileProperty()

@get:Input
val cds: Property<Boolean> = objects.notNullProperty(false)

@get:Input
internal val stripDebug: Property<Boolean> = objects.notNullProperty(true)

Expand All @@ -56,12 +60,33 @@ abstract class AbstractJLinkTask : AbstractJvmToolOperationTask("jlink") {
cliArg("--add-modules", m)
}

val cds = cds.get()

if (cds) {
cliArg("--generate-cds-archive", true)
}
cliArg("--strip-debug", stripDebug)
cliArg("--no-header-files", noHeaderFiles)
cliArg("--no-man-pages", noManPages)
cliArg("--strip-native-commands", stripNativeCommands)
// Native commands cannot be stripped if CDS is enabled, because bin/java is used by the
// CDS option. The files will be stripped later.
if (!cds) {
cliArg("--strip-native-commands", stripNativeCommands)
}
cliArg("--compress", compressionLevel.orNull?.id)

cliArg("--output", destinationDir)
}

override fun checkResult(result: ExecResult) {
super.checkResult(result)
if (stripNativeCommands.get() && cds.get()) {
// Native files were not removed yet, so do it here.
destinationDir.get().dir("bin").asFile
.walkBottomUp()
// Windows JVM has its .ddl files in bin/
.filter { it.isFile && it.extension != "dll" }
.forEach { it.delete() }
}
}
}
15 changes: 15 additions & 0 deletions tutorials/Native_distributions_and_local_execution/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,21 @@ compose.desktop {
}
```

## Enabling Class data sharing (CDS)

This option requires JDK 18. Class data sharing (CDS) can be enabled which helps reduce the startup
time and memory footprint.

``` kotlin
compose.desktop {
application {
nativeDistributions {
cds = true
}
}
}
```

## Packaging resources

There are multiple ways to package and load resources with Compose for Desktop.
Expand Down
Loading