summaryrefslogtreecommitdiff
path: root/doc/yjit
AgeCommit message (Collapse)Author
2022-05-02[DOC] Some YJIT dependencies are no longer requiredAlan Wu
The `capstone` crate on crates.io does not need `libcapstone` on the system because it builds from [source]. `gdbm` is now a separate gem (thanks for extracting it!). [source]: https://github.com/capstone-rust/capstone-rs/blob/c31409905a9fc4581133de248fcd0a66b2c37e36/capstone-sys/build.rs#L143
2022-04-27Update yjit.mdMaxime Chevalier-Boisvert
Fix configure line in YJIT build instructions
2022-04-27Rust YJITAlan Wu
In December 2021, we opened an [issue] to solicit feedback regarding the porting of the YJIT codebase from C99 to Rust. There were some reservations, but this project was given the go ahead by Ruby core developers and Matz. Since then, we have successfully completed the port of YJIT to Rust. The new Rust version of YJIT has reached parity with the C version, in that it passes all the CRuby tests, is able to run all of the YJIT benchmarks, and performs similarly to the C version (because it works the same way and largely generates the same machine code). We've even incorporated some design improvements, such as a more fine-grained constant invalidation mechanism which we expect will make a big difference in Ruby on Rails applications. Because we want to be careful, YJIT is guarded behind a configure option: ```shell ./configure --enable-yjit # Build YJIT in release mode ./configure --enable-yjit=dev # Build YJIT in dev/debug mode ``` By default, YJIT does not get compiled and cargo/rustc is not required. If YJIT is built in dev mode, then `cargo` is used to fetch development dependencies, but when building in release, `cargo` is not required, only `rustc`. At the moment YJIT requires Rust 1.60.0 or newer. The YJIT command-line options remain mostly unchanged, and more details about the build process are documented in `doc/yjit/yjit.md`. The CI tests have been updated and do not take any more resources than before. The development history of the Rust port is available at the following commit for interested parties: https://github.com/Shopify/ruby/commit/1fd9573d8b4b65219f1c2407f30a0a60e537f8be Our hope is that Rust YJIT will be compiled and included as a part of system packages and compiled binaries of the Ruby 3.2 release. We do not anticipate any major problems as Rust is well supported on every platform which YJIT supports, but to make sure that this process works smoothly, we would like to reach out to those who take care of building systems packages before the 3.2 release is shipped and resolve any issues that may come up. [issue]: https://bugs.ruby-lang.org/issues/18481 Co-authored-by: Maxime Chevalier-Boisvert <maximechevalierb@gmail.com> Co-authored-by: Noah Gibbs <the.codefolio.guy@gmail.com> Co-authored-by: Kevin Newton <kddnewton@gmail.com> Notes: Merged: https://github.com/ruby/ruby/pull/5826
2022-02-24Fix yjit readme link pointing to old shopify readme (#5596)Adrien S
Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2022-02-02Fix a typo [ci skip]Kazuhiro NISHIYAMA
2022-01-11YJIT stats documentation additions and updates (#5427)Noah Gibbs
* YJIT documentation additions and updates * Update yjit.md Co-authored-by: Maxime Chevalier-Boisvert <maximechevalierb@gmail.com> Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2021-11-24update YJIT docs to reference RubyVM::YJIT instead of just YJITAdam Hess
[ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/5171 Merged-By: XrXr
2021-11-18Add --yjit-no-type-prop so we can test YJIT without type propagation (#5135)Maxime Chevalier-Boisvert
* Add --yjit-no-type-prop so we can test YJIT without type propagation * Fix typo in command line option * Leave just two test workflows enable for YJIT Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2021-10-21Move the test fileNobuyoshi Nakada
2021-10-20Update yjit.mdMaxime Chevalier-Boisvert
2021-10-20Doc: remove outdated note about hooking into the interpreterAlan Wu
DAE remember MicroJIT?
2021-10-20Move test_yjit_asm.sh into miscAlan Wu
Since conventionally scripts don't live at the top level of the repo.
2021-10-20Update yjit.mdMaxime Chevalier-Boisvert
2021-10-20Move YJIT's README into doc/yjit/yjit.mdNoah Gibbs
2021-10-20Incorporate feedback from the PR into yjit_hacking.mdNoah Gibbs
2021-10-20Add a YJIT hacking doc with some internals; change the README text a bit to ↵Noah Gibbs
reflect its current condition