JEP 282: jlink: The Java Linker

AuthorJean-Francois Denise
OwnerJim Laskey
TypeFeature
ScopeJDK
StatusClosed / Delivered
Release9
Componenttools / jlink
Discussionjigsaw dash dev at openjdk dot java dot net
EffortL
DurationL
DependsJEP 261: Module System
Relates toJEP 220: Modular Run-Time Images
JEP 275: Modular Java Application Packaging
Reviewed byAlan Bateman, Alex Buckley, Iris Clark, Jim Laskey, Mandy Chung, Mark Reinhold
Endorsed byBrian Goetz
Created2015/07/16 12:55
Updated2017/05/19 02:01
Issue8131679

Summary

Create a tool that can assemble and optimize a set of modules and their dependencies into a custom run-time image as defined in JEP 220.

Non Goals

This JEP does not commit the resulting tool to generate anything other than a modular run-time image.

It is not a goal of this JEP to define a standard or supported API for plugins. Instead, the plugin API will be strictly experimental. A future JEP may re-visit this topic once experience has been obtained using the plugin API defined by this JEP.

Motivation

JEP 261 defines link time as an optional phase between the phases of compile time (the javac command) and run-time (the java run-time launcher). Link time requires a linking tool that will assemble and optimize a set of modules and their transitive dependencies to create a run-time image or executable.

Link time is an opportunity to do whole-world optimizations that are otherwise difficult at compile time or costly at run-time. An example would be to optimize a computation when all its inputs become constant (i.e., not unknown). A follow-up optimization would be to remove code that is no longer reachable.

Description

A basic invocation of the linker tool, jlink, is:

$ jlink --module-path <modulepath> --add-modules <modules> --limit-modules <modules> --output <path>

where:

The --module-path, --add-modules, and --limit-modules options are described in further detail in JEP 261.

Other options that jlink will support include:

Alternatives

The alternative to a linking tool is to use platform-specific JDK and JRE image-build scripts. This approach would make it difficult to create custom run-time images.

Testing

Beyond the expected set of unit tests to exercise the tool I, the JDK build will regularly exercise jlink by creating the JDK and JRE run-time images.

Risks and Assumptions

The set of requirements for the tool is not complete at this time. The tool's extensibility is expected to evolve.

Dependences