Using TruffleRuby with GraalVM

GraalVM is the platform on which TruffleRuby runs.

Installing GraalVM enables to run TruffleRuby both in the --native and --jvm runtime configurations.

Dependencies #

TruffleRuby’s dependencies need to be installed for TruffleRuby to run correctly.

Community Edition and Enterprise Edition #

GraalVM is available in a Community Edition, which is open-source, and an Enterprise Edition which has better performance and scalability. See the website for a comparison.

Installing the Base Image #

GraalVM starts with a base image which provides the platform for high-performance language runtimes.

The Community Edition base image can be installed from GitHub, under an open source licence. The Enterprise Edition base image can be installed from the Oracle Technology Network using the OTN licence.

See the GraalVM Downloads page for download links.

Nightly builds of the GraalVM Community Edition are also available.

Whichever edition you get you will get a tarball which you can extract. There will be a bin directory (Contents/Home/bin on macOS) which you can add to your $PATH if you want to.

Installing with asdf #

Using asdf and asdf-java installation is as easy as asdf install java graalvm-20.1.0+java11 (look up versions via asdf list-all java | grep graalvm)

Installing Ruby and Other Languages #

After installing GraalVM you then need to install the Ruby language into it. This is done using the gu command. The Ruby package is the same for both editions of GraalVM and comes from GitHub.

gu install ruby

This command will show a message mentioning to run a post-install script. This is necessary to make the Ruby openssl C extension work with your system libssl. Please run that script now. The path of the script will be:

# Java 8
jre/languages/ruby/lib/truffle/post_install_hook.sh
# Java 11+
languages/ruby/lib/truffle/post_install_hook.sh
# Generic
$(path/to/graalvm/bin/ruby -e 'print RbConfig::CONFIG["prefix"]')/lib/truffle/post_install_hook.sh

You can also download the Ruby component (ruby-installable-...) manually from https://github.com/oracle/truffleruby/releases/latest. Then install it with gu install --file path/to/ruby-installable-....

If you are installing Ruby into GraalVM Enterprise, then you need to download the Ruby Enterprise installable from OTN and install using --file in the same way.

After installing Ruby you may want to rebuild other images so that they can use the new language. Rebuilding the executable images can take a few minutes and you should have about 10 GB of RAM available.

gu rebuild-images polyglot libpolyglot

To be able to do so, you may need to install the native-image component if you have not done so already:

gu install native-image

Using a Ruby Manager #

Inside the GraalVM is a jre/languages/ruby or languages/ruby directory which has the usual structure of a Ruby implementation. It is recommended to add this directory to a Ruby manager, see configuring Ruby managers for more information.