mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
a6dd859aff
In order to reliably test compaction we need to be able to move objects
between size pools.
In order for this to happen there must be pages in a size pool into
which we can allocate.
The existing implementation of `double_heap` only doubled the existing
number of pages in the heap, so if a size pool had a low number of pages
(or 0) it's not guaranteed that enough space will be created to move
objects into that size pool.
This commit deprecates the `double_heap` option and replaces it with
`expand_heap` instead.
expand heap will expand each heap by enough pages to hold a number of
slots defined by `GC_HEAP_INIT_SLOTS` or by `heap->total_pags` whichever
is larger.
If both `double_heap` and `expand_heap` are present, a deprecation
warning will be shown for `double_heap` and the `expand_heap` behaviour
will take precedence
Given that this is an API intended for debugging and testing GC
compaction I'm not concerned about the extra memory usage or time taken
to create the pages. However, for completeness:
Running the following `test.rb` and using `time` on my Macbook Pro shows
the following memory usage and time impact:
pp "RSS (kb): #{`ps -o rss #{Process.pid}`.lines.last.to_i}"
GC.verify_compaction_references(double_heap: true, toward: :empty)
pp "RSS (kb): #{`ps -o rss #{Process.pid}`.lines.last.to_i}"
❯ time make run
./miniruby -I./lib -I. -I.ext/common -r./arm64-darwin21-fake ./test.rb
"RSS (kb): 24000"
<internal:gc>:251: warning: double_heap is deprecated and will be removed
"RSS (kb): 25232"
________________________________________________________
Executed in 124.37 millis fish external
usr time 82.22 millis 0.09 millis 82.12 millis
sys time 28.76 millis 2.61 millis 26.15 millis
❯ time make run
./miniruby -I./lib -I. -I.ext/common -r./arm64-darwin21-fake ./test.rb
"RSS (kb): 24000"
"RSS (kb): 49040"
________________________________________________________
Executed in 150.13 millis fish external
usr time 103.32 millis 0.10 millis 103.22 millis
sys time 35.73 millis 2.59 millis 33.14 millis
|
||
|---|---|---|
| .github | ||
| basictest | ||
| benchmark | ||
| bin | ||
| bootstraptest | ||
| ccan | ||
| coroutine | ||
| coverage | ||
| cygwin | ||
| defs | ||
| doc | ||
| enc | ||
| ext | ||
| gems | ||
| include | ||
| internal | ||
| lib | ||
| libexec | ||
| man | ||
| misc | ||
| missing | ||
| sample | ||
| spec | ||
| template | ||
| test | ||
| tool | ||
| wasm | ||
| win32 | ||
| yjit | ||
| .appveyor.yml | ||
| .cirrus.yml | ||
| .dir-locals.el | ||
| .document | ||
| .editorconfig | ||
| .gdbinit | ||
| .gitattributes | ||
| .gitignore | ||
| .rdoc_options | ||
| .rspec_parallel | ||
| .travis.yml | ||
| aclocal.m4 | ||
| addr2line.c | ||
| addr2line.h | ||
| array.c | ||
| array.rb | ||
| ast.c | ||
| ast.rb | ||
| autogen.sh | ||
| bignum.c | ||
| BSDL | ||
| builtin.c | ||
| builtin.h | ||
| class.c | ||
| common.mk | ||
| compar.c | ||
| compile.c | ||
| complex.c | ||
| configure.ac | ||
| constant.h | ||
| cont.c | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| COPYING.ja | ||
| darray.h | ||
| debug.c | ||
| debug_counter.c | ||
| debug_counter.h | ||
| dir.c | ||
| dir.rb | ||
| dln.c | ||
| dln.h | ||
| dln_find.c | ||
| dmydln.c | ||
| dmyenc.c | ||
| dmyext.c | ||
| encindex.h | ||
| encoding.c | ||
| enum.c | ||
| enumerator.c | ||
| error.c | ||
| eval.c | ||
| eval_error.c | ||
| eval_intern.h | ||
| eval_jump.c | ||
| file.c | ||
| gc.c | ||
| gc.h | ||
| gc.rb | ||
| gem_prelude.rb | ||
| golf_prelude.rb | ||
| goruby.c | ||
| GPL | ||
| hash.c | ||
| hrtime.h | ||
| id_table.c | ||
| id_table.h | ||
| inits.c | ||
| insns.def | ||
| internal.h | ||
| io.c | ||
| io.rb | ||
| io_buffer.c | ||
| iseq.c | ||
| iseq.h | ||
| kernel.rb | ||
| KNOWNBUGS.rb | ||
| LEGAL | ||
| lex.c.blt | ||
| load.c | ||
| loadpath.c | ||
| localeinit.c | ||
| main.c | ||
| marshal.c | ||
| marshal.rb | ||
| math.c | ||
| memory_view.c | ||
| method.h | ||
| mini_builtin.c | ||
| miniinit.c | ||
| mjit.c | ||
| mjit.h | ||
| mjit.rb | ||
| mjit_compile.c | ||
| mjit_worker.c | ||
| NEWS.md | ||
| nilclass.rb | ||
| node.c | ||
| node.h | ||
| numeric.c | ||
| numeric.rb | ||
| object.c | ||
| pack.c | ||
| pack.rb | ||
| parse.y | ||
| prelude.rb | ||
| probes.d | ||
| probes_helper.h | ||
| proc.c | ||
| process.c | ||
| ractor.c | ||
| ractor.rb | ||
| ractor_core.h | ||
| random.c | ||
| range.c | ||
| rational.c | ||
| re.c | ||
| README.EXT | ||
| README.EXT.ja | ||
| README.ja.md | ||
| README.md | ||
| regcomp.c | ||
| regenc.c | ||
| regenc.h | ||
| regerror.c | ||
| regexec.c | ||
| regint.h | ||
| regparse.c | ||
| regparse.h | ||
| regsyntax.c | ||
| ruby-runner.c | ||
| ruby.c | ||
| ruby_assert.h | ||
| ruby_atomic.h | ||
| rubystub.c | ||
| scheduler.c | ||
| signal.c | ||
| siphash.c | ||
| siphash.h | ||
| sparc.c | ||
| sprintf.c | ||
| st.c | ||
| strftime.c | ||
| string.c | ||
| string.rb | ||
| struct.c | ||
| symbol.c | ||
| symbol.h | ||
| thread.c | ||
| thread_none.c | ||
| thread_none.h | ||
| thread_pthread.c | ||
| thread_pthread.h | ||
| thread_sync.c | ||
| thread_win32.c | ||
| thread_win32.h | ||
| time.c | ||
| timev.h | ||
| timev.rb | ||
| trace_point.rb | ||
| transcode.c | ||
| transcode_data.h | ||
| transient_heap.c | ||
| transient_heap.h | ||
| util.c | ||
| variable.c | ||
| variable.h | ||
| version.c | ||
| version.h | ||
| vm.c | ||
| vm_args.c | ||
| vm_backtrace.c | ||
| vm_callinfo.h | ||
| vm_core.h | ||
| vm_debug.h | ||
| vm_dump.c | ||
| vm_eval.c | ||
| vm_exec.c | ||
| vm_exec.h | ||
| vm_insnhelper.c | ||
| vm_insnhelper.h | ||
| vm_method.c | ||
| vm_opts.h | ||
| vm_sync.c | ||
| vm_sync.h | ||
| vm_trace.c | ||
| vsnprintf.c | ||
| warning.rb | ||
| yjit.c | ||
| yjit.h | ||
| yjit.rb | ||
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
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.