Rusty V8 Binding
V8 Version: 10.3.174.3
Provide high quality Rust bindings to V8's C++ API. The API should match the original API as closely as possible.
Do not introduce additional call overhead. (For example, previous attempts at Rust V8 bindings forced the use of Persistent handles.)
Do not rely on a binary
libv8.abuilt outside of cargo. V8 is a very large project (over 600,000 lines of C++) which often takes 30 minutes to compile. Furthermore, V8 relies on Chromium's bespoke build system (gn + ninja) which is not easy to use outside of Chromium. For this reason many attempts to bind to V8 rely on pre-built binaries that are built separately from the binding itself. While this is simple, it makes upgrading V8 difficult, it makes CI difficult, it makes producing builds with different configurations difficult, and it is a security concern since binary blobs can hide malicious code. For this reason we believe it is imperative to build V8 from source code during "cargo build".
Publish the crate on crates.io and allow docs.rs to generate documentation. Due to the complexity and size of V8's build, this is nontrivial. For example the crate size must be kept under 10 MiB in order to publish.
V8 is very large and takes a long time to compile. Many users will prefer to use a prebuilt version of V8. We publish static libs for every version of rusty v8 on Github.
Binaries builds are turned on by default:
cargo build will initiate a download
from github to get the static lib. To disable this build using the
V8_FROM_SOURCE environmental variable.
When making changes to rusty_v8 itself, it should be tested by build from source. The CI always builds from source.
V8_FORCE_DEBUG environment variable
rusty_v8 will link against release builds of
v8, if you want to
use a debug build of
We default to release builds of
v8 due to performance & CI reasons in
RUSTY_V8_MIRROR environment variable
Tells the build script where to get binary builds from. Understands
https:// URLs, and file paths. The default is
File-based mirrors are good for using cached downloads. First, point the environment variable to a suitable location:
# you might want to add this to your .bashrc $ export RUSTY_V8_MIRROR=$HOME/.cache/rusty_v8
Then populate the cache:
#!/bin/bash # see https://github.com/denoland/rusty_v8/releases for REL in v0.13.0 v0.12.0; do mkdir -p $RUSTY_V8_MIRROR/$REL for FILE in \ librusty_v8_debug_x86_64-unknown-linux-gnu.a \ librusty_v8_release_x86_64-unknown-linux-gnu.a \ ; do if [ ! -f $RUSTY_V8_MIRROR/$REL/$FILE ]; then wget -O $RUSTY_V8_MIRROR/$REL/$FILE \ https://github.com/denoland/rusty_v8/releases/download/$REL/$FILE fi done done
RUSTY_V8_ARCHIVE environment variable
Tell the build script to use a specific v8 library. This can be an URL or a path. This is useful when you have a prebuilt archive somewhere:
export RUSTY_V8_ARCHIVE=/path/to/custom_archive.a cargo build
Build V8 from Source
V8_FROM_SOURCE=1 cargo build -vv to build the crate completely from
The build scripts require Python 3 to be available as
python in your
For linux builds: glib-2.0 development files need to be installed such that
pkg-config can find them. On Ubuntu, run
sudo apt install libglib2.0-dev to
For Windows builds: the 64-bit toolchain needs to be used. 32-bit targets are not supported.
The build depends on several binary tools:
tools will automatically be downloaded, if they are not detected in the environment.
$NINJA environmental variables can be used to skip
the download of gn and ninja. The clang download can be skipped by setting
$CLANG_BASE_PATH to the directory containing a
V8 is known to rely on bleeding edge features, so LLVM v8.0+ or Apple clang 11.0+
Arguments can be passed to
gn by setting the
$GN_ARGS environmental variable.
Env vars used in when building from source:
C++ IDE integration
rusty_v8 supports IDE integration for the C++ bindings through the use of the
clangd language server, bringing features such as diagnostics, code completion
and code navigations to your editor. See the instructions for how to set it up
with your favorite editor.
Before you can use
rusty_v8, you must first generate the
V8_FROM_SOURCE=1 GENERATE_COMPDB= cargo build
This will write the
clang compilation database as the
file at the root of the project repository. You can pass a path to the
GENERATE_COMPDB environment variable to change the location where the
compilation database will be written.
You must pass the
GENERATE_COMPDB environment variable to regenerate the
compilation database, it will not be regenerated automatically.
Building V8 takes over 30 minutes, this is too slow for me to use this crate. What should I do?
What are all these random directories for like
these really necessary?
In order to build V8 from source code, we must provide a certain directory structure with some git submodules from Chromium. We welcome any simplifications to the code base, but this is a structure we have found after many failed attempts that carefully balances the requirements of cargo crates and GN/Ninja.
V8 has a very large API with hundreds of methods. Why don't you automate the generation of this binding code?
In the limit we would like to auto-generate bindings. We have actually started down this route several times, however due to many eccentric features of the V8 API, this has not proven successful. Therefore we are proceeding in a brute-force fashion for now, focusing on solving our stated goals first. We hope to auto-generate bindings in the future.
Why are you building this?
This is to support the Deno project. We previously have gotten away with a simpler high-level Rust binding to V8 called libdeno. But as Deno has matured we've found ourselves continually needing access to an increasing amount of V8's API in Rust.
When building I get unknown argument: '-gno-inline-line-tables'
export GN_ARGS="no_inline_line_tables=false" during build.