gecko-dev/js/rust
Jon Coppeard 4c9a0dab80 Bug 1634459 - Simplify the wrapper used for rooting non-GC thing types r=jandem
Previously this stored a function pointer to do the tracing along with the rooted thing. The patch changes this to use a virtual method for the tracing. Calling the method on the base class means we don't need to do address arithmetic to find wher the trace function is stored and we don't need the alignment restrictions, because the virtual trace method knows the layout of its class.

I had to add a traits class, mainly to get the address of the rooted thing inside the wrapper since we need to be able to get the address of the wrapper itself now for tracing.

The wrapper class is renamed from DispatchWrapper to RootedTraceable.

Differential Revision: https://phabricator.services.mozilla.com/D73421
2020-05-04 16:53:56 +00:00
..
etc Bug 1634459 - Simplify the wrapper used for rooting non-GC thing types r=jandem 2020-05-04 16:53:56 +00:00
src Bug 1633145 - Bustage fix for jsglue.cpp 2020-04-30 20:03:58 +00:00
tests Bug 1617369 - Reformat js/ using rustfmt r=arai,bbouvier 2020-02-27 10:29:46 +00:00
.gitignore
build.rs Bug 1634459 - Simplify the wrapper used for rooting non-GC thing types r=jandem 2020-05-04 16:53:56 +00:00
Cargo.toml Bug 1621044 - Tentative fix for the SM-rust build bustage. 2020-03-11 00:06:44 +00:00
CMakeLists.txt Bug 1613176 - Enable -Wreturn-type-c-linkage. r=froydnj 2020-02-05 11:21:04 +00:00
README.md

The js Crate: Rust Bindings to SpiderMonkey

User Documentation

Building

To build a release version of SpiderMonkey and the Rust code with optimizations enabled:

$ cargo build --release

To build with SpiderMonkey's DEBUG checks and assertions:

$ cargo build --features debugmozjs

Raw FFI bindings to JSAPI are machine generated with rust-lang-nursery/rust-bindgen, and requires libclang >= 3.9. See ./build.rs for details.

Cargo Features

  • debugmozjs: Create a DEBUG build of SpiderMonkey with many extra assertions enabled. This is decoupled from whether the crate and its Rust code is built in debug or release mode.

  • promises: Enable SpiderMonkey native promises.

  • nonzero: Leverage the unstable NonZero type. Requires nightly Rust.

Testing

Make sure to test both with and without the debugmozjs feature because various structures have different sizes and get passed through functions differently at the ABI level! At minimum, you should test with debugmozjs to get extra assertions and checking.

$ cargo test
$ cargo test --features debugmozjs