rules_graalvm

GraalVM Rules for Bazel

Latest release: 0.11.2

Important Currently in beta. Feedback welcome but will probably break your build.

Use GraalVM from Bazel, with support for:

Building native image binaries
Installing components with gu
Using GraalVM as a Bazel Java toolchain
Support for Bazel 6, Bazel 7, and Bzlmod
Support for Bazel 4 and Bazel 5, drop-in replacement for rules_graal
Run GraalVM binaries directly
Build native shared libraries from Java or polyglot code
Example projects for each Bazel version
Hermetic compilation on all platforms
Respects conventional Bazel build settings
Easily use GraalVM Maven artifacts
Support for macOS, Linux, Windows (including Native Image!) (support matrix)
Support for the latest modern GraalVM releases (Community Edition and Oracle GraalVM)

Installation

API docs for graalvm_repository

Via WORKSPACE.bazel:

Artifact	SHA256
`rules_graalvm-0.11.2.zip`	`3ef2f1583a4849d03209a43b0b507f172299c3045e585b6ffa7144a2bc12ae18`
`rules_graalvm-0.11.2.tgz`	`49bfa3851b6a1f76e5c18727adf6b0bb61af24ba2566bf75a724ddbca0c2c183`

http_archive(
    name = "rules_graalvm",
    sha256 = "3ef2f1583a4849d03209a43b0b507f172299c3045e585b6ffa7144a2bc12ae18",
    strip_prefix = "rules_graalvm-0.11.2",
    urls = [
        "https://github.com/sgammon/rules_graalvm/releases/download/v0.11.2/rules_graalvm-0.11.2.zip",
    ],
)

load("@rules_graalvm//graalvm:workspace.bzl", "register_graalvm_toolchains", "rules_graalvm_repositories")

rules_graalvm_repositories()

register_graalvm_toolchains()

load("@rules_graalvm//graalvm:repositories.bzl", "graalvm_repository")

graalvm_repository(
    name = "graalvm",
    distribution = "ce",  # `oracle`, `ce`, or `community`
    java_version = "21",  # `17`, `20`, or `21`, as supported by the version provided
    version = "21.0.2",  # earlier version format like `22.x` also supported
)

Or, via MODULE.bazel:

Artifact	Integrity value
`rules_graalvm-0.11.2.zip`	`sha256-PvLxWDpISdAyCaQ7C1B/FyKZwwReWFtv+nFEorwSrhg=`
`rules_graalvm-0.11.2.tgz`	`sha256-Sb+jhRtqH3blwYcnrfawu2GvJLolZr91pyTdvKDCwYM=`

bazel_dep(name = "rules_graalvm", version = "0.11.2")

gvm = use_extension("@rules_graalvm//:extensions.bzl", "graalvm")

gvm.graalvm(
    name = "graalvm",
    version = "21.0.2",  # earlier version format like `22.x` also supported
    distribution = "ce",  # `oracle`, `ce`, or `community`
    java_version = "21",  # `17`, `20`, or `21`, as supported by the version provided
)
use_repo(gvm, "graalvm")
register_toolchains("@graalvm//:jvm")
register_toolchains("@graalvm//:sdk")

Usage

These rules are documented; you can find important docs at these links:

graalvm_repository: Declaring and consuming a GraalVM installation
native_image: Building a GraalVM native-image from Java code

Java Toolchains

You can use the graalvm_repository as a Java toolchain, by registering it like below:

From WORKSPACE.bazel:

# graalvm_repository(...)

load("@rules_graalvm//graalvm:workspace.bzl", "register_graalvm_toolchains", "rules_graalvm_repositories")

rules_graalvm_repositories()

register_graalvm_toolchains()

To use the toolchain, add this to your .bazelrc:

build --extra_toolchains=@graalvm//:toolchain
build --java_runtime_version=graalvm_20

Build a native binary on Bazel 6+

API docs for native_image

In a BUILD.bazel file:

load("@rules_java//java:defs.bzl", "java_library")
load("@rules_graalvm//graalvm:defs.bzl", "native_image")

java_library(
    name = "main",
    srcs = glob(["Main.java"]),
)

native_image(
    name = "main-native",
    deps = [":main"],
    main_class = "Main",
    native_image_tool = "@graalvm//:native-image",
)

Native image toolchains

It is supported to specify the native-image tool as above, using the native_image_tool attribute on your target. In fact, you must do this unless you register the GraalVM toolchains as shown in the installation instructions.

When using toolchains, the native_image_tool attribute can be omitted, which delegates to Bazel’s toolchain system to resolve the tool:

Resolve via toolchains:

native_image(
    name = "main-native",
    deps = [":main"],
    main_class = "Main",
)

Or point to a specific native-image tool:

native_image(
    name = "main-native",
    deps = [":main"],
    main_class = "Main",
    native_image_tool = "@graalvm//:native-image",
)

Build a native binary on Bazel 4 and Bazel 5

API docs for legacy native_image rule

In a BUILD.bazel file:

load("@rules_java//java:defs.bzl", "java_library")
load("@rules_graalvm//graal:graal.bzl", "native_image")

java_library(
    name = "main",
    srcs = glob(["Main.java"]),
)

native_image(
    name = "main-native",
    deps = [":main"],
    main_class = "Main",
)

Note: In the legacy rules, you don’t have to specify native_image_tool, but on the other hand, the default target @graalvm//:native-image is hard-coded in. If you use a different repository name make sure to add the native_image_tool attribute to point to @yourrepo//:native-image.

Examples

See the list of examples, which are used as continuous integration tests. Examples are available for Bazel 4-7.

Hermeticity / strictness

These rules attempt to strike as optimal a balance as possible between older Bazel support (starting at Bazel 4) and the maximum possible strictness/hermeticity for action execution.

Bazel Toolchains are used to resolve the C++ compiler which is provided to native-image. Toolchains are additionally used within the rules to provide and resolve tools from GraalVM itself.

For information about strictness tuning on each operating system, see the hermeticity guide.

GraalVM toolchain type

The GraalVM-specific toolchain type is available at:

@rules_graalvm//graalvm/toolchain:toolchain_type

If you install GraalVM at a repository named @graalvm, the toolchain targets are:

Java toolchain:

@graalvm//:jvm

GraalVM toolchain:

@graalvm//:sdk

The default WORKSPACE and Bzlmod installation instructions register both types of toolchains. The GraalVM toolchain is required to perform builds with native-image (or you must provide a native_image_tool target).

Acknowledgements

Built on top of @andyscott’s fantastic work with rules_graal.

This site is open source. Improve this page.