From d5b7c8a9727ebca2e7d29dd44c44f8724c2667cb Mon Sep 17 00:00:00 2001 From: Takashi Kokubun Date: Fri, 10 Mar 2023 11:27:04 -0800 Subject: RJIT: Always enable --rjit-dump-disasm --- doc/rjit/rjit.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) (limited to 'doc') diff --git a/doc/rjit/rjit.md b/doc/rjit/rjit.md index 273fdbeb9d..77be56bfb5 100644 --- a/doc/rjit/rjit.md +++ b/doc/rjit/rjit.md @@ -14,23 +14,32 @@ The following platforms are assumed to work. `linux-x86_64` is tested on CI. * OS: Linux, macOS, BSD * Arch: x86\_64 -## Developing RJIT +## configure +### --enable-rjit + +On supported platforms, `--enable-rjit` is set by default. You usually don't need to specify this. +You may still manually pass `--enable-rjit` to try RJIT on unsupported platforms. + +### --enable-rjit=dev -### Bindgen +`--enable-rjit=dev` makes the interpreter slower, but enables `ruby --rjit-stats` to work. + +## make +### rjit-bindgen If you see an "RJIT bindgen" GitHub Actions failure, please commit the `git diff` shown on the failed job. For doing the same thing locally, run `make rjit-bindgen` after installing libclang. macOS seems to have libclang by default. On Ubuntu, you can install it with `apt install libclang1`. -### --enable-rjit +## ruby +### --rjit-stats -On supported platforms, `--enable-rjit` is set by default. You usually don't need to specify this. -You may still manually pass `--enable-rjit` to try RJIT on unsupported platforms. +This prints RJIT stats at exit. Available with `--enable-rjit=dev` on configure. -### --enable-rjit=dev +### --rjit-dump-disasm -`--enable-rjit=dev` makes the interpreter slower, but enables the following two features: +This dumps all JIT code. You need to install libcapstone before configure. -* `--rjit-dump-disasm`: Dump all JIT code. -* `--rjit-stats`: Print RJIT stats. +* Ubuntu: `sudo apt-get install -y libcapstone-dev` +* macOS: `brew install capstone` -- cgit v1.2.1