1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
Find a file
Alan Wu 9f09397bfe
YJIT: On-demand executable memory allocation; faster boot (#5944)
This commit makes YJIT allocate memory for generated code gradually as
needed. Previously, YJIT allocates all the memory it needs on boot in
one go, leading to higher than necessary resident set size (RSS) and
time spent on boot initializing the memory with a large memset().

Users should no longer need to search for a magic number to pass to
`--yjit-exec-mem` since physical memory consumption should now more
accurately reflect the requirement of the workload.

YJIT now reserves a range of addresses on boot. This region start out
with no access permission at all so buggy attempts to jump to the region
crashes like before this change. To get this hardening at finer
granularity than the page size, we fill each page with trapping
instructions when we first allocate physical memory for the page.

Most of the time applications don't need 256 MiB of executable code, so
allocating on-demand ends up doing less total work than before. Case in
point, a simple `ruby --yjit-call-threshold=1 -eitself` takes about
half as long after this change. In terms of memory consumption, here is
a table to give a rough summary of the impact:

    | Peak RSS in MiB | -eitself example | railsbench once |
    | :-------------: | ---------------: | --------------: |
    |     before      |              265 |             377 |
    |      after      |               11 |             143 |
    |     no YJIT     |               10 |             101 |

A new module is introduced to handle allocation bookkeeping.
`CodePtr` is moved into the module since it has a close relationship
with the new `VirtualMemory` struct. This new interface has a slightly
smaller surface than before in that marking a region as writable is no
longer a public operation.
2022-06-14 10:23:13 -04:00
.github .github/workflows/compilers.yml: annocheck: Fix a linker flag to pass MJIT tests. 2022-06-07 00:25:19 +02:00
basictest [wasm] bootstraptest, basictest: disable backquote literal tests 2022-01-19 11:19:06 +09:00
benchmark Update the help message on /benchmark 2022-06-07 21:30:28 -07:00
bin
bootstraptest Add tests for a variety of string-subclass operations (#5999) 2022-06-10 13:52:43 -04:00
ccan Prefix ccan headers (#4568) 2022-03-30 20:36:31 +13:00
coroutine Add support for address sanitizer for amd64 and arm64. 2022-05-25 15:24:24 +12:00
coverage
cygwin
defs Split YJIT rules for CODEOWNERS 2022-06-02 10:12:34 +09:00
doc [DOC] Fix markup for String (#5984) 2022-06-09 13:40:21 -05:00
enc Remove Unicode 13.0.0 related files 2022-03-16 08:30:04 +09:00
ext Make method id explicit in rb_exec_recursive_outer 2022-06-10 14:48:21 -07:00
gems Update bundled gems list at 2022-05-21 2022-05-21 07:07:14 +00:00
include Move String RVALUES between pools 2022-06-13 10:11:27 -07:00
internal Move String RVALUES between pools 2022-06-13 10:11:27 -07:00
lib [ruby/fileutils] [DOC] More on paths and lists (https://github.com/ruby/fileutils/pull/86) 2022-06-14 22:52:22 +09:00
libexec Merge rubygems master 1e4eda741d732ca1bd7031aef0a16c7348adf7a5 2022-04-28 19:08:49 +09:00
man
misc Add more information to lldb dump_page helper 2022-05-27 13:45:33 -07:00
missing Fix dtoa buffer overrun 2022-04-12 21:30:49 +09:00
sample Fix typo in README (#5925) 2022-05-20 14:45:46 -07:00
spec [rubygems/rubygems] Don't on gemspecs with invalid require_paths, just warn 2022-06-12 02:02:20 +09:00
template Add yjit.o to DTRACE_DEPENDENT_OBJS 2022-05-30 18:30:57 -04:00
test ripper: Check if anonymous parameters defined [Bug #18828] 2022-06-14 20:41:41 +09:00
tool Hack to avoid leak checker 2022-05-25 18:48:01 +09:00
wasm wasm/README.md: add manual config.guess download and autoconf steps 2022-03-15 10:25:12 +09:00
win32 [Win32] allow pipe in flock 2022-04-21 15:14:08 +09:00
yjit YJIT: On-demand executable memory allocation; faster boot (#5944) 2022-06-14 10:23:13 -04:00
.appveyor.yml Update zlib version to 1.2.12 2022-03-28 17:28:01 +09:00
.cirrus.yml [DOC] Fix ghcr link 2022-03-31 08:35:39 +09:00
.dir-locals.el
.document Improve documentation on contributing to Ruby 2022-05-11 10:59:24 -04:00
.editorconfig
.gdbinit
.gitattributes
.gitignore Ignore rubyspec_temp fot Git 2022-05-09 07:29:37 +09:00
.rdoc_options [DOC] Set the documentation title and main page 2022-02-21 13:08:06 +09:00
.rspec_parallel
.travis.yml Remove gdbm related code from Travis CI 2022-03-04 18:09:34 +09:00
aclocal.m4
addr2line.c Skip NULL values from dladdr(3) 2022-06-09 20:43:41 +09:00
addr2line.h
array.c Add missing write barriers to Array#replace 2022-04-28 11:31:22 -04:00
array.rb Use Primitive.mandatory_only? for Array#sample 2021-11-15 15:58:56 +09:00
ast.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
ast.rb
autogen.sh autogen.sh: Copy auxiliary files instead of symlinks with -i 2021-12-06 17:53:37 +09:00
bignum.c Fix the condition when a new buffer is needed without GMP 2022-06-02 10:29:53 +09:00
BSDL
builtin.c
builtin.h Typedef built-in function types 2022-06-02 16:05:35 +09:00
class.c Add Module#undefined_instance_methods 2022-06-06 09:57:32 -07:00
common.mk Enable "make annocheck" on platforms other than Linux. 2022-06-13 12:12:18 +02:00
compar.c [DOC] Use simple references to operator methods 2022-03-30 10:54:52 +09:00
compile.c compile.c (add_adjust_info): Remove insns_info_index > 0 2022-06-13 15:22:32 +09:00
complex.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
configure.ac Drop MinGW support of MJIT (#6012) 2022-06-13 09:28:28 -07:00
constant.h
cont.c cont.c: prevent a warning of GCC 12.1 2022-06-13 15:18:28 +09:00
CONTRIBUTING.md Improve documentation on contributing to Ruby 2022-05-11 10:59:24 -04:00
COPYING
COPYING.ja
darray.h Remove _with_gc functions in darray 2022-05-03 09:07:39 -04:00
debug.c small fix on setup_debug_log() 2022-06-10 23:56:49 +09:00
debug_counter.c
debug_counter.h optimize Struct getter/setter 2021-11-19 08:32:39 +09:00
dir.c dir.c: refresh pathtype when emulating IFTODT in glob_helper 2022-04-03 01:13:16 +09:00
dir.rb fix typo in dir documentation (#6002) 2022-06-10 22:22:16 -07:00
dln.c Only define RUBY_DLN_CHECK_ABI when supported 2022-03-01 09:44:39 -05:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c [DOC] Main doc for encodings moved from encoding.c to doc/encodings.rdoc (#5748) 2022-04-01 20:41:04 -05:00
enum.c Revert flawed doc for slice_after, slice_when, and chunk_while (#5952) 2022-05-28 14:20:00 -05:00
enumerator.c
error.c [DOC] RDoc now accepts other than magic numbers at rb_attr 2022-06-08 11:55:21 +09:00
eval.c Remove unnecessary module flag, add module assertions to other module flags 2022-05-23 11:04:34 -07:00
eval_error.c Remove unneeded newline from detailed_message 2022-02-22 11:55:40 +09:00
eval_intern.h rb_fiber_terminate must not return [Bug #18497] 2022-01-19 19:57:16 +09:00
eval_jump.c
file.c Fix missing paren [ci skip] 2022-05-06 18:13:22 +09:00
gc.c Move String RVALUES between pools 2022-06-13 10:11:27 -07:00
gc.h Add the size pool slot size to the output of ObjectSpace.dump/dump_all 2022-02-03 15:07:35 -05:00
gc.rb Move GC.verify_compaction_references [Bug #18779] 2022-06-02 15:32:00 +09:00
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c Make method id explicit in rb_exec_recursive_outer 2022-06-10 14:48:21 -07:00
hrtime.h thread.c: Move double2hrtime and hrtime2double to hrtime.h 2022-03-30 16:50:46 +09:00
id_table.c Support ID_TABLE_STOP for replace function 2022-01-25 16:51:16 -05:00
id_table.h Rename rb_id_table_foreach_with_replace 2022-01-25 16:51:16 -05:00
inits.c IO::Buffer for scheduler interface. 2021-11-10 19:21:05 +13:00
insns.def RubyVM.stat constant cache metrics (#5766) 2022-04-05 16:37:00 -04:00
internal.h
io.c Handle case where write result is zero. 2022-06-13 16:12:18 +12:00
io.rb
io_buffer.c Add basic binary operators (and, or, xor, not) to IO::Buffer. (#5893) 2022-05-09 17:19:01 +12:00
iseq.c Rust YJIT 2022-04-27 11:00:22 -04:00
iseq.h Finer-grained constant cache invalidation (take 2) 2022-04-01 14:48:22 -04:00
kernel.rb Improve performance Kernel#Float with using Primitive.mandatory_only? method [Feature #18344] (#5133) 2021-11-17 20:26:40 -08:00
KNOWNBUGS.rb
LEGAL LEGAL: mention error_highlight 2021-12-13 14:21:29 +09:00
lex.c.blt
load.c [DOC] Mention the case to autoload already defined constant 2022-06-03 14:10:30 +09:00
loadpath.c
localeinit.c
main.c [WASM] System initialization has no stack rewinding code to Asyncify 2022-05-24 12:17:19 +09:00
marshal.c Fix typos [ci skip] 2021-12-25 10:33:49 +09:00
marshal.rb [DOC] Document Marshal#load parameter freeze: (#5332) 2021-12-24 09:55:09 +01:00
math.c [DOC] Enhanced RDoc for Math module (#5837) 2022-04-25 10:07:21 -05:00
memory_view.c Only check class ancestors for ivar in memory_view 2022-05-27 13:38:40 -07:00
method.h Fix memory leak at the same named alias [Bug #18516] 2022-01-27 15:46:08 +09:00
mini_builtin.c
miniinit.c
mjit.c Drop MinGW support of MJIT (#6012) 2022-06-13 09:28:28 -07:00
mjit.h Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
mjit_compile.c Fix MJIT's ISEQ_BODY macro usage at 5f10bd634f 2022-06-08 22:39:18 -07:00
mjit_worker.c Drop MinGW support of MJIT (#6012) 2022-06-13 09:28:28 -07:00
NEWS.md Add Module#undefined_instance_methods 2022-06-06 09:57:32 -07:00
nilclass.rb
node.c Remove NODE_DASGN_CURR [Feature #18406] 2021-12-13 12:53:03 +09:00
node.h Remove NODE_DASGN_CURR [Feature #18406] 2021-12-13 12:53:03 +09:00
numeric.c [DOC] Fix documentation of Numeric#div: Complex does not have #div 2022-06-03 14:35:47 +09:00
numeric.rb Add examples for Integer.try_convert [ci skip] 2021-12-15 02:12:37 +09:00
object.c Add assertion for embedded to embedded ivar copy 2022-06-10 13:47:42 -07:00
pack.c
pack.rb [DOC] Repair format and links in What's Here sections (#5711) 2022-03-25 10:52:06 -05:00
parse.y ripper: Check if anonymous parameters defined [Bug #18828] 2022-06-14 20:41:41 +09:00
prelude.rb Make Set a builtin feature [Feature #16989] 2022-02-18 11:56:24 +09:00
probes.d
probes_helper.h
proc.c Reuse rb_proc_arity 2022-04-24 14:06:45 -07:00
process.c [ci skip] Fix docs 2022-04-13 10:43:23 -04:00
ractor.c rename thread internal naming 2022-04-22 07:54:09 +09:00
ractor.rb
ractor_core.h cleanup by RUBY_DEBUG_LOG2 and VM_ASSERT 2022-05-24 02:22:41 +09:00
random.c [DOC] Mark up the code for Kernel#rand as the same as Random#rand 2022-01-13 11:34:09 +09:00
range.c Fix Range#cover? returning true for beginless ranges of different types 2022-06-06 09:59:22 -07:00
rational.c Disable GMP by -DUSE_GMP=0 2022-05-20 19:05:35 +09:00
re.c Ignore invalid escapes in regexp comments 2022-06-06 13:50:03 -07:00
README.EXT
README.EXT.ja
README.ja.md Update badges from README.md [ci skip] 2021-12-24 09:05:12 +09:00
README.md Update "Reporting Issues" link in the README 2022-06-08 17:49:56 +09:00
regcomp.c Just free compiled pattern if no space is used 2022-04-12 20:24:14 +09:00
regenc.c
regenc.h Move ruby.h in #ifdef RUBY block 2022-03-11 15:08:23 +09:00
regerror.c
regexec.c re.c: Add Regexp.timeout= and Regexp.timeout 2022-03-30 16:50:46 +09:00
regint.h re.c: Add Regexp.timeout= and Regexp.timeout 2022-03-30 16:50:46 +09:00
regparse.c
regparse.h
regsyntax.c
ruby-runner.c
ruby.c Rust YJIT 2022-04-27 11:00:22 -04:00
ruby_assert.h
ruby_atomic.h
rubystub.c
scheduler.c Add fiber scheduler hooks for pread/pwrite, and add support to IO::Buffer. 2021-12-23 12:20:09 +13:00
signal.c
siphash.c
siphash.h
sparc.c [DOC]Some link prefix replace 2022-04-09 17:43:46 +09:00
sprintf.c
st.c st.c: Fix a typo in a comment 2022-02-28 11:40:25 +09:00
strftime.c
string.c Add placeholder to let braces match 2022-06-14 10:21:55 +09:00
string.rb [DOC] Fix markup for String (#5984) 2022-06-09 13:40:21 -05:00
struct.c Don't attempt to read ivars on T_ICLASS in struct (#5664) 2022-05-26 11:54:15 -07:00
symbol.c [DOC] Move the documentations of moved Symbol methods 2022-04-14 11:17:37 +09:00
symbol.h
thread.c Make method id explicit in rb_exec_recursive_outer 2022-06-10 14:48:21 -07:00
thread_none.c remove DEBUG_OUT() macro 2022-05-24 16:28:07 +09:00
thread_none.h introduce struct rb_native_thread 2022-04-23 03:08:27 +09:00
thread_pthread.c thread_pthread.c: trigger THREAD_EVENT_READY when going throuhg the fast path. 2022-06-07 18:15:55 +02:00
thread_pthread.h altstack is native thread's attr 2022-05-24 17:50:49 +09:00
thread_sync.c Prefix ccan headers (#4568) 2022-03-30 20:36:31 +13:00
thread_win32.c [Feature #18339] GVL Instrumentation API 2022-06-03 15:13:33 +02:00
thread_win32.h native_tls_get()' should not check results 2022-05-24 10:06:51 +09:00
time.c Using TZMODE_SET_LOCALTIME macro 2022-05-26 19:55:05 +09:00
timev.h
timev.rb [DOC] prefer rdoc references over generated URLs 2022-02-19 15:14:01 +09:00
trace_point.rb Fix comment 2022-03-29 18:14:33 -07:00
transcode.c [DOC] Place a non-US-ASCII document in a document-specific script 2022-02-26 16:23:04 +09:00
transcode_data.h
transient_heap.c USE_RUBY_DEBUG_LOG doesn't check RUBY_DEVEL 2021-12-29 00:22:02 +09:00
transient_heap.h
util.c
variable.c Fix Module#const_source_location for autoload constants with direct requires 2022-06-06 11:12:55 -07:00
variable.h
version.c Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08:00
version.h * 2022-06-14 [ci skip] 2022-06-14 00:39:59 +09:00
vm.c remove NON_SCALAR_THREAD_ID support 2022-05-24 10:06:51 +09:00
vm_args.c Unflag a splatted flagged hash if the method doesn't use ruby2_keywords 2022-04-05 11:42:02 +02:00
vm_backtrace.c Write Thread instead of Threade 2022-05-12 07:53:17 +09:00
vm_callinfo.h Remove a typo hash [ci skip] 2022-01-29 15:33:13 +09:00
vm_core.h altstack is native thread's attr 2022-05-24 17:50:49 +09:00
vm_debug.h Fix compile error 2022-06-09 09:35:08 +09:00
vm_dump.c Prevent printing crash report in a loop 2022-06-03 13:50:32 -04:00
vm_eval.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
vm_exec.c
vm_exec.h Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
vm_insnhelper.c Fix use-after-free with interacting TracePoints 2022-05-30 13:54:22 -04:00
vm_insnhelper.h RubyVM.stat constant cache metrics (#5766) 2022-04-05 16:37:00 -04:00
vm_method.c Fix nested bmethod TracePoint and memory leak 2022-06-10 10:10:27 +09:00
vm_opts.h
vm_sync.c Prefix ccan headers (#4568) 2022-03-30 20:36:31 +13:00
vm_sync.h USE_RUBY_DEBUG_LOG doesn't check RUBY_DEVEL 2021-12-29 00:22:02 +09:00
vm_trace.c Fix nested bmethod TracePoint and memory leak 2022-06-10 10:10:27 +09:00
vsnprintf.c [Feature #18491] Drop support for HP-UX 2022-01-18 09:52:15 -05:00
warning.rb
yjit.c YJIT: On-demand executable memory allocation; faster boot (#5944) 2022-06-14 10:23:13 -04:00
yjit.h Rust YJIT 2022-04-27 11:00:22 -04:00
yjit.rb Add ability to trace exit locations in yjit (#5970) 2022-06-09 12:59:39 -04:00

Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis Status Cirrus Status

What is Ruby?

Ruby is an interpreted object-oriented programming language often used for web development. It also offers many scripting features to process plain text and serialized files, or manage system tasks. It is simple, straightforward, and extensible.

Features of Ruby

  • Simple Syntax
  • Normal Object-oriented Features (e.g. class, method calls)
  • Advanced Object-oriented Features (e.g. mix-in, singleton-method)
  • Operator Overloading
  • Exception Handling
  • Iterators and Closures
  • Garbage Collection
  • Dynamic Loading of Object Files (on some architectures)
  • Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, macOS, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/maintainers.rdoc#label-Platform+Maintainers

How to get Ruby with Git

For a complete list of ways to install Ruby, including using third-party tools like rvm, see:

https://www.ruby-lang.org/en/downloads/

The mirror of the Ruby source tree can be checked out with the following command:

$ git clone https://github.com/ruby/ruby.git

There are some other branches under development. Try the following command to see the list of branches:

$ git ls-remote https://github.com/ruby/ruby.git

You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source) if you are a committer.

Ruby home page

https://www.ruby-lang.org/

Documentation

Mailing list

There is a mailing list to discuss Ruby. To subscribe to this list, please send the following phrase:

subscribe

in the mail body (not subject) to the address ruby-talk-request@ruby-lang.org.

Copying

See the file COPYING.

Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list or on websites like https://stackoverflow.com.

Bugs should be reported at https://bugs.ruby-lang.org. Read "Reporting Issues" for more information.

Contributing

See "Contributing to Ruby", which includes setup and build instructions.

The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

matz@ruby-lang.org