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
Takashi Kokubun b9d3ceee8f
Unwrap vm_call_cfunc indirection on JIT
for VM_METHOD_TYPE_CFUNC.

This has been known to decrease optcarrot fps:

```
$ benchmark-driver -v --rbenv 'before --jit;after --jit' benchmark.yml --repeat-count=24 --output=all
before --jit: ruby 2.8.0dev (2020-04-13T16:25:13Z master fb40495cd9) +JIT [x86_64-linux]
after --jit: ruby 2.8.0dev (2020-04-13T23:23:11Z mjit-inline-c bdcd06d159) +JIT [x86_64-linux]
Calculating -------------------------------------
                                 before --jit           after --jit
Optcarrot Lan_Master.nes    66.38132676191719     67.41369177299630 fps
                            69.42728743772243     68.90327567263054
                            72.16028300263211     69.62605130880686
                            72.46631319102777     70.48818243767207
                            73.37078877002490     70.79522887347566
                            73.69422431217367     70.99021920193194
                            74.01471487018695     74.69931965402584
                            75.48685183295630     74.86714575949016
                            75.54445264507932     75.97864419721677
                            77.28089738169756     76.48908637569581
                            78.04183397891302     76.54320932488021
                            78.36807984096562     76.59407262898067
                            78.92898762543574     77.31316743361343
                            78.93576483233765     77.97153484180480
                            79.13754917503078     77.98478782102325
                            79.62648945850653     78.02263322726446
                            79.86334213878064     78.26333724045934
                            80.05100635898518     78.60056756355614
                            80.26186843769584     78.91082645644468
                            80.34205717020330     79.01226659142263
                            80.62286066044338     79.32733939423721
                            80.95883033058557     79.63793060542024
                            80.97376819251613     79.73108936622778
                            81.23050939202896     80.18280109433088
```

and I deleted this capability in an early stage of YARV-MJIT development:
0ab130feee

I suspect either of the following things could be the cause:

* Directly calling vm_call_cfunc requires more optimization effort in GCC,
  resulting in 30ms-ish compilation time increase for such methods and
  decreasing the number of methods compiled in a benchmarked period.

* Code size increase => icache miss hit

These hypotheses could be verified by some methodologies. However, I'd
like to introduce this regardless of the result because this blocks
inlining C method's definition.

I may revert this commit when I give up to implement inlining C method
definition, which requires this change.

Microbenchmark-wise, this gives slight performance improvement:

```
$ benchmark-driver -v --rbenv 'before --jit;after --jit' benchmark/mjit_send_cfunc.yml --repeat-count=4
before --jit: ruby 2.8.0dev (2020-04-13T16:25:13Z master fb40495cd9) +JIT [x86_64-linux]
after --jit: ruby 2.8.0dev (2020-04-13T23:23:11Z mjit-inline-c bdcd06d159) +JIT [x86_64-linux]
Calculating -------------------------------------
                     before --jit  after --jit
     mjit_send_cfunc      41.961M      56.489M i/s -    100.000M times in 2.383143s 1.770244s

Comparison:
                  mjit_send_cfunc
         after --jit:  56489372.5 i/s
        before --jit:  41961388.1 i/s - 1.35x  slower
```
2020-04-13 16:45:05 -07:00
.github
basictest
benchmark Unwrap vm_call_cfunc indirection on JIT 2020-04-13 16:45:05 -07:00
bin
bootstraptest
ccan
coroutine
coverage
cygwin
defs
doc
enc
ext
gems
include
internal
lib
libexec
man
misc
missing
sample
spec Endless method definition [Feature #16746] 2020-04-10 18:02:15 +09:00
template
test
tool Unwrap vm_call_cfunc indirection on JIT 2020-04-13 16:45:05 -07:00
win32
.dir-locals.el
.document Moved Dir.open and Dir#initialize to dir.rb 2020-04-06 22:22:25 +09:00
.editorconfig
.gdbinit
.gitattributes
.gitignore
.rspec_parallel
.travis.yml
aclocal.m4
addr2line.c
addr2line.h
appveyor.yml
array.c
array.rb Removed useless shebang and executable bit [ci skip] 2020-02-01 23:25:46 +09:00
ast.c
ast.rb
bignum.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
BSDL [ruby/irb] Reformat LICENSE.txt [ci skip] 2020-02-02 03:22:51 +09:00
builtin.c
builtin.h
class.c
common.mk
compar.c
compile.c
complex.c
configure.ac
constant.h
cont.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
CONTRIBUTING.md
COPYING COPYING: reformat as RDoc 2019-02-02 06:38:10 +00:00
COPYING.ja
debug.c
debug_counter.c
debug_counter.h
dir.c
dir.rb Moved Dir.[] to dir.rb 2020-04-06 22:22:25 +09:00
dln.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
dln.h
dln_find.c
dmydln.c
dmyenc.c load.c: tweak the return value 2014-12-03 06:13:58 +00:00
dmyext.c
encindex.h
encoding.c
enum.c
enumerator.c
error.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
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 goruby.c: FD leak [ci skip] 2017-03-09 03:38:06 +00:00
GPL
hash.c Improve Hash documentation. 2020-04-14 01:57:10 +12:00
hrtime.h hrtime.h: fix typo in non-builtin overflow check 2018-08-30 03:24:55 +00:00
id_table.c Introduce disposable call-cache. 2020-02-22 09:58:59 +09:00
id_table.h
inits.c
insns.def
internal.h
io.c
io.rb
iseq.c
iseq.h
kernel.rb
KNOWNBUGS.rb compile.c: fix positions encode 2018-04-05 13:13:00 +00:00
LEGAL
lex.c.blt
load.c
loadpath.c
localeinit.c
main.c
marshal.c
math.c
method.h add #include guard hack 2020-04-13 16:06:00 +09:00
mini_builtin.c
miniinit.c
mjit.c
mjit.h
mjit_compile.c
mjit_worker.c
NEWS.md
node.c
node.h
numeric.c
object.c
pack.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
pack.rb Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
parse.y
prelude.rb
probes.d
probes_helper.h
proc.c
process.c Add a a list of cases for which clock_getres() has been observed to be inaccurate 2020-04-13 18:23:39 +02:00
random.c
range.c
rational.c
re.c
README.EXT
README.EXT.ja
README.ja.md
README.md
regcomp.c
regenc.c Merge Onigmo 6.1.1 2017-02-11 15:08:33 +00:00
regenc.h initializer paren-string {("str")} is a C99ism 2018-01-02 06:41:49 +00:00
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby-runner.c
ruby.c
ruby_assert.h add #include guard hack 2020-04-13 16:06:00 +09:00
ruby_atomic.h
rubystub.c
signal.c
siphash.c switch SipHash from SipHash24 to SipHash13 variant 2017-01-20 06:01:23 +00:00
siphash.h
sparc.c
sprintf.c
st.c
strftime.c
string.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
struct.c
symbol.c
symbol.h
thread.c
thread_pthread.c
thread_pthread.h
thread_sync.c
thread_win32.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
thread_win32.h
time.c
timev.h
trace_point.rb
transcode.c
transcode_data.h
transient_heap.c
transient_heap.h
util.c
variable.c
variable.h
version.c
version.h * 2020-04-14 [ci skip] 2020-04-14 01:25:13 +09:00
vm.c
vm_args.c
vm_backtrace.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
vm_callinfo.h
vm_core.h
vm_debug.h
vm_dump.c
vm_eval.c Introduce disposable call-cache. 2020-02-22 09:58:59 +09:00
vm_exec.c
vm_exec.h
vm_insnhelper.c
vm_insnhelper.h add #include guard hack 2020-04-13 16:06:00 +09:00
vm_method.c
vm_opts.h
vm_trace.c Clear all trace events during teardown 2020-03-29 23:41:19 -04:00
vsnprintf.c
warning.rb

Build Status Build status Actions Status Actions Status Actions Status Actions Status Actions Status

What's 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, Haiku, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/contributing.rdoc#platform-maintainers

How to get Ruby

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

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

Git

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.

Subversion

Stable branches for older Ruby versions can be checked out with the following command:

$ svn co https://svn.ruby-lang.org/repos/ruby/branches/ruby_2_6/ ruby

Try the following command to see the list of branches:

$ svn ls https://svn.ruby-lang.org/repos/ruby/branches/

Ruby home page

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

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.

How to compile and install

  1. If you want to use Microsoft Visual C++ to compile Ruby, read win32/README.win32 instead of this document.

  2. If ./configure does not exist or is older than configure.ac, run autoconf to (re)generate configure.

  3. Run ./configure, which will generate config.h and Makefile.

    Some C compiler flags may be added by default depending on your environment. Specify optflags=.. and warnflags=.. as necessary to override them.

  4. Edit include/ruby/defines.h if you need. Usually this step will not be needed.

  5. Remove comment mark(#) before the module names from ext/Setup (or add module names if not present), if you want to link modules statically.

    If you don't want to compile non static extension modules (probably on architectures which do not allow dynamic loading), remove comment mark from the line "#option nodynamic" in ext/Setup.

    Usually this step will not be needed.

  6. Run make.

    • On Mac, set RUBY_CODESIGN environment variable with a signing identity. It uses the identity to sign ruby binary. See also codesign(1).
  7. Optionally, run 'make check' to check whether the compiled Ruby interpreter works well. If you see the message "check succeeded", your Ruby works as it should (hopefully).

  8. Run 'make install'.

    This command will create the following directories and install files into them.

    • ${DESTDIR}${prefix}/bin
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib
    • ${DESTDIR}${prefix}/lib/ruby
    • ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/share/man/man1
    • ${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system

    If Ruby's API version is 'x.y.z', the ${MAJOR} is 'x', the ${MINOR} is 'y', and the ${TEENY} is 'z'.

    NOTE: teeny of the API version may be different from one of Ruby's program version

    You may have to be a super user to install Ruby.

If you fail to compile Ruby, please send the detailed error report with the error log and machine/OS type, to help others.

Some extension libraries may not get compiled because of lack of necessary external libraries and/or headers, then you will need to run 'make distclean-ext' to remove old configuration after installing them in such case.

Copying

See the file COPYING.

Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list (https://www.ruby-lang.org/en/community/mailing-lists) or on websites like (https://stackoverflow.com).

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

Contributing

See the file CONTRIBUTING.md

The Author

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

matz@ruby-lang.org