enso/docs/infrastructure/upgrading-graalvm.md
Jaroslav Tulach 402ebb2f8e
Upgrade to GraalVM 22.3.0 (#3663)
Upgrading to GraalVM 22.3.0.

# Important Notes
- Removed all deprecated `FrameSlot`, and replaced them with frame indexes - integers.
- Add more information to `AliasAnalysis` so that it also gathers these indexes.
- Add quick build mode option to `native-image` as default for non-release builds
- `graaljs` and `native-image` should now be downloaded via `gu` automatically, as dependencies.
- Remove `engine-runner-native` project - native image is now build straight from `engine-runner`.
- We used to have `engine-runner-native` without `sqldf` in classpath as a workaround for an internal native image bug.
- Fixed chrome inspector integration, such that it shows values of local variables both for current stack frame and caller stack frames.
- There are still many issues with the debugging in general, for example, when there is a polyglot value among local variables, a `NullPointerException` is thrown and no values are displayed.
- Removed some deprecated `native-image` options
- Remove some deprecated Truffle API method calls.
2022-11-23 14:30:48 +00:00

1.9 KiB

layout title category tags order
developer-doc Upgrading GraalVM infrastructure
infrastructure
build
graalvm
graal
jvm
5

Upgrading GraalVM

After upgrading the project to a newer version of GraalVM, all developers must take the following actions to be able to continue development after the upgrade:

  1. Download the new JVM version and set it as the default for the project. If you use IntelliJ, you will also need to update the JVM used for the project in the project settings.
  2. Re-run sbt bootstrap to get the updated Truffle JAR (if there are issues updating, removing engine/runtime/build-cache directory may help).
  3. Do a full clean (it may not always be required, but not doing it often leads to problems so it is much safer to do it) by running enso/clean.
  4. To be able to build or run tests for the launcher project, Native Image for the new GraalVM version has to be installed, as it is not included by default. This can be done with <path-to-graal-home>/bin/gu install native-image.
    • If there are problems building the Native Image, removing engine/launcher/build-cache (which contains the downloaded musl package) may help.

Upgrading the Build

If you are upgrading the build to a new GraalVM version, you additionally need to perform the following tasks:

  • Change the expected GraalVM version in the build.sbt configuration. This is both a version number and (if it is changed), the associated version of Java.
  • Change the expected GraalVM version in the release-publish-edition workflow.
  • Change the base image in the Dockerfile to contain the correct GraalVM version.
  • Just to be sure, search for the version regex in all the files in the repo.
  • Ensure that all deprecations have been handled.