The Ruby Programming Language [mirror]
Go to file
k0kubun 8a15857a7f mjit_compile.c: use local variables for stack
if catch_except_p is FALSE. If catch_except_p is TRUE, stack values
should be on VM's stack when exception is thrown and the JIT-ed frame
is re-executed by VM's exception handler. If it's FALSE, the JIT-ed
frame won't be re-executed and don't need to keep values on VM's stack.

Using local variables allows us to reduce cfp->sp motion. Moving cfp->sp
is needed only for insns whose handles_frame? is false. So it improves
performance.

_mjit_compile_insn.erb: Prepare `stack_size` variable for GET_SP,
STACK_ADDR_FROM_TOP, TOPN macros. Share pc and sp motion partial view.
Use cancel handler created in mjit_compile.c.

_mjit_compile_send.erb: ditto. Also, when iseq->body->catch_except_p is
TRUE, this stops to call mjit_exec directly. I described the reason in
vm_insnhelper.h's comment for EXEC_EC_CFP.

_mjit_compile_pc_and_sp.erb: Shared logic for moving sp and pc. As you
can see from thsi file, when status->local_stack_p is TRUE and
insn.handles_frame? is false, moving sp is skipped. But if
insn.handles_frame? is true, values should be rolled back to VM's stack.
common.mk: add dependency for the file

_mjit_compile_insn_body.erb: Set sp value before canceling JIT on
DISPATCH_ORIGINAL_INSN. Replace GET_SP, STACK_ADDR_FROM_TOP, TOPN macros
for the case ocal_stack_p is TRUE and insn.handles_frame? is false.
In that case, values are not available on VM's stack and those macros
should be replaced.

mjit_compile.inc.erb: updated comments of macros which are supported by
JIT compiler. All references to `cfp->sp` should be replaced and thus
INC_SP, SET_SV, PUSH are no longer supported for now, because they are
not used now.

vm_exec.h: moved EXEC_EC_CFP definition to vm_insnhelper.h because it's
tighly coupled to CALL_METHOD.

vm_insnhelper.h: Have revised EXEC_EC_CFP definition moved from vm_exec.h.
Now it triggers mjit_exec for VM, and has the guard for catch_except_p
on JIT-ed code. See comments for details. CALL_METHOD delegates
triggering mjit_exec to EXEC_EC_CFP.

insns.def: Stopped using EXEC_EC_CFP for the case we don't want to
trigger mjit_exec. Those insns (defineclass, opt_call_c_function) are
not supported by JIT and it's safe to use RESTORE_REGS(), NEXT_INSN().
expandarray is changed to pass GET_SP() to replace the macro in
_mjit_compile_insn_body.erb.

vm_insnhelper.c: change to take sp for the above reason.

[close https://github.com/ruby/ruby/pull/1828]

This patch resurrects the performance which was attached in
[Feature #14235].

* Benchmark

Optcarrot (with configuration for benchmark_driver.gem)
https://github.com/benchmark-driver/optcarrot

$ benchmark-driver benchmark.yml --verbose 1 --rbenv 'before;before+JIT::before,--jit;after;after+JIT::after,--jit' --repeat-count 10
before: ruby 2.6.0dev (2018-03-04 trunk 62652) [x86_64-linux]
before+JIT: ruby 2.6.0dev (2018-03-04 trunk 62652) +JIT [x86_64-linux]
after: ruby 2.6.0dev (2018-03-04 local-variable.. 62652) [x86_64-linux]
last_commit=mjit_compile.c: use local variables for stack
after+JIT: ruby 2.6.0dev (2018-03-04 local-variable.. 62652) +JIT [x86_64-linux]
last_commit=mjit_compile.c: use local variables for stack
Calculating -------------------------------------
                         before  before+JIT       after   after+JIT
           optcarrot     53.552      59.680      53.697      63.358 fps

Comparison:
                        optcarrot
           after+JIT:        63.4 fps
          before+JIT:        59.7 fps - 1.06x  slower
               after:        53.7 fps - 1.18x  slower
              before:        53.6 fps - 1.18x  slower

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@62655 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-03-04 07:04:40 +00:00
basictest
benchmark use `--version`. 2018-02-21 08:51:49 +00:00
bin erb.rb: deprecate safe_level of ERB.new 2018-02-22 13:28:25 +00:00
bootstraptest error.c: bypass Exception.new 2018-02-20 10:08:27 +00:00
ccan ccan/list: sync with upstream 2018-02-01 08:59:27 +00:00
coverage
cygwin
defs defs/id.def: predefine to_f ID 2018-02-27 08:15:27 +00:00
doc Update maintainers of unmaintained libraries. 2018-02-21 06:31:39 +00:00
enc Refactor ERB version checking for keyword arguments 2018-02-27 11:12:23 +00:00
ext openssl: search winsock 2018-03-02 14:45:28 +00:00
gems Update minitest-5.11.3 on bundled gems. 2018-02-23 05:09:11 +00:00
include Signature of rb_uint2inum and rb_int2inum 2018-02-20 09:38:55 +00:00
lib Clarify the documentation of the YAML module [Misc #14567] 2018-03-02 12:56:37 +00:00
man
misc
missing [ci skip] tabify 2018-01-20 04:18:09 +00:00
sample erb.rb: deprecate safe_level of ERB.new 2018-02-22 13:28:25 +00:00
spec Update to ruby/spec@51f301d 2018-02-27 20:45:59 +00:00
template configure.ac: library options to MAINLIBS 2018-03-02 01:37:53 +00:00
test mjit_compile.c: use local variables for stack 2018-03-04 07:04:40 +00:00
tool mjit_compile.c: use local variables for stack 2018-03-04 07:04:40 +00:00
win32 mjit_config.h: MJIT_LDSHARED 2018-03-03 05:09:32 +00:00
.document
.editorconfig .editorconfig: Use spaces instead of tab except Makefiles 2018-01-25 00:11:52 +00:00
.gdbinit .gdbinit (print_lineno): support a succinct bitvector implementation [ci skip] 2018-02-10 06:02:37 +00:00
.gitattributes
.gitignore Ignore rb_mjit_min_header- instead of rb_mjit_header- 2018-02-22 07:34:43 +00:00
.indent.pro
.travis.yml .travis.yml: resurrect notification to #commits 2018-02-11 06:33:45 +00:00
BSDL
CONTRIBUTING.md
COPYING
COPYING.ja
GPL
KNOWNBUGS.rb
LEGAL Update url with 404 status on LEGAL file. 2018-02-21 07:12:17 +00:00
Makefile.in mjit_config.h: MJIT_LDSHARED 2018-03-03 05:09:32 +00:00
NEWS NEWS: resurrect ticket number [ci skip] 2018-02-28 14:31:17 +00:00
README.EXT
README.EXT.ja
README.ja.md README.ja.md: Mac OS X -> macOS [ci skip] 2018-02-18 08:11:50 +00:00
README.md
aclocal.m4 aclocal.m4: remove ruby_check_va_copy.m4 2018-02-18 05:12:26 +00:00
addr2line.c
addr2line.h
appveyor.yml appveyor.yml: refactor r62402 2018-02-14 14:09:32 +00:00
array.c Add a new #filter alias for #select 2018-02-25 13:52:07 +00:00
bignum.c rb_int_powm: call rb_int_pow directly 2018-02-24 15:36:09 +00:00
class.c mjit_compile.c: merge initial JIT compiler 2018-02-04 11:22:28 +00:00
common.mk mjit_compile.c: use local variables for stack 2018-03-04 07:04:40 +00:00
compar.c
compile.c compile.c: set catch_except_p flag 2018-03-04 07:04:28 +00:00
complex.c defs/id.def: predefine to_f ID 2018-02-27 08:15:27 +00:00
configure.ac mjit_config.h: MJIT_LDSHARED 2018-03-03 05:09:32 +00:00
constant.h vm_insnhelper.c: rb_autoloading_value flag 2018-02-13 09:34:43 +00:00
cont.c mjit.c: merge MJIT infrastructure 2018-02-04 06:58:09 +00:00
debug.c internal.h: remove dependecy on ruby/io.h 2018-01-09 06:24:10 +00:00
debug_counter.c
debug_counter.h debug_counter.h: include __FILE__ to recurse 2018-02-09 03:15:21 +00:00
dir.c [DOC] missing docs at toplevel 2018-02-23 02:18:52 +00:00
dln.c constified 2018-01-09 00:06:00 +00:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h encoding.c: rb_enc_find_index2 2017-12-22 01:03:17 +00:00
encoding.c load.c: use fstring instead of OBJ_FREEZE 2018-01-24 22:39:56 +00:00
enum.c Add a new #filter alias for #select 2018-02-25 13:52:07 +00:00
enumerator.c Add a new #filter alias for #select 2018-02-25 13:52:07 +00:00
error.c eval_error.c: rb_error_write flags 2018-02-23 08:39:03 +00:00
eval.c vm.c: disable dtrace in jit source 2018-02-20 03:15:33 +00:00
eval_error.c eval_error.c: rb_error_write flags 2018-02-23 08:39:03 +00:00
eval_intern.h eval_intern.h: duplicate check 2018-01-18 07:53:26 +00:00
eval_jump.c `$SAFE` as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
file.c file.c: realpath on special symlink 2018-02-28 05:43:53 +00:00
gc.c [DOC] missing docs at toplevel 2018-02-23 02:18:52 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
hash.c Add a new #filter alias for #select 2018-02-25 13:52:07 +00:00
ia64.s
id_table.c
id_table.h
inits.c Revert "Improve performance of creating Hash object" 2017-12-19 14:26:30 +00:00
insns.def mjit_compile.c: use local variables for stack 2018-03-04 07:04:40 +00:00
internal.h mjit.c: no va_copy 2018-02-18 05:10:52 +00:00
io.c [DOC] missing docs at toplevel 2018-02-23 02:18:52 +00:00
iseq.c compile.c: set catch_except_p flag 2018-03-04 07:04:28 +00:00
iseq.h there is no such thing like 0 in enum defined_type 2018-01-19 05:18:18 +00:00
lex.c.blt keywords: shrink struct kwtable 2018-01-21 09:59:45 +00:00
load.c load.c: reduce memory usage of loaded_features_index 2018-02-14 18:38:33 +00:00
loadpath.c -Wno-overlength-strings 2018-01-16 08:35:33 +00:00
localeinit.c internal.h: remove dependecy on ruby/encoding.h 2018-01-09 06:24:11 +00:00
main.c
marshal.c add missing/nan.c 2018-01-20 03:16:59 +00:00
math.c INFINITY is float. That of double is HUGE_VAL. 2018-01-19 01:45:36 +00:00
method.h method.h: VM_METHOD_TYPE_MINIMUM_BITS 2018-01-28 14:16:48 +00:00
miniinit.c
mjit.c mjit.c: fix deadlock on marking MJIT's ISeq 2018-02-24 00:40:36 +00:00
mjit.h mjit.h: compare as pointer 2018-02-14 05:11:02 +00:00
mjit_compile.c mjit_compile.c: use local variables for stack 2018-03-04 07:04:40 +00:00
node.c Fix typos. 2018-01-17 13:15:13 +00:00
node.h node.c: Stop double meaning of NODE_FOR by introducing NODE_FOR_MASGN 2018-01-16 07:24:53 +00:00
numeric.c [DOC] obsolete classes 2018-02-23 02:16:43 +00:00
object.c defs/id.def: predefine to_f ID 2018-02-27 08:15:27 +00:00
pack.c internal.h: remove dependecy on ruby/encoding.h 2018-01-09 06:24:11 +00:00
parse.y parse.y: refine assign_in_cond warning 2018-03-01 04:10:25 +00:00
prelude.rb prelude.rb: eliminate a private constant 2018-01-07 03:10:00 +00:00
probes.d
probes_helper.h vm.c: disable dtrace in jit source 2018-02-20 03:15:33 +00:00
proc.c no ID cache in Init functions 2018-02-16 08:39:48 +00:00
process.c guard before noreturn function 2018-02-25 03:08:40 +00:00
random.c random.c: Random.extend Formatter 2018-02-27 13:28:31 +00:00
range.c Use RB_INTEGER_TYPE_P instead of rb_obj_is_kind_of 2018-02-26 07:57:15 +00:00
rational.c Support two `to_r`-responding args in Rational() 2018-02-27 16:45:09 +00:00
re.c mjit_compile.c: merge initial JIT compiler 2018-02-04 11:22:28 +00:00
regcomp.c Fix typos. 2018-01-18 11:44:10 +00:00
regenc.c
regenc.h initializer paren-string `{("str")}` is a C99ism 2018-01-02 06:41:49 +00:00
regerror.c
regexec.c label as lvalue is a GCCism 2018-01-02 06:41:54 +00:00
regint.h
regparse.c Fix typos. 2018-01-18 11:44:10 +00:00
regparse.h Fix typos. 2018-01-18 11:44:10 +00:00
regsyntax.c
ruby-runner.c
ruby.c ruby.c: fix typo in r62530 2018-02-22 15:29:33 +00:00
ruby_assert.h string literal longer than 509 characters is a C99ism 2018-01-02 06:41:43 +00:00
ruby_atomic.h statement experssion is a GCCism 2018-01-02 06:41:53 +00:00
rubystub.c
safe.c `$SAFE` as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
signal.c sigill marked as NORETURN 2018-01-18 09:44:45 +00:00
siphash.c
siphash.h
sparc.c
sprintf.c sprintf.c: overflow check 2018-02-09 03:15:20 +00:00
st.c st.c: retry operations if rebuilt 2018-02-13 10:02:07 +00:00
strftime.c
string.c Export some missing symbols for MJIT 2018-02-08 13:54:37 +00:00
struct.c marshal.c: allow marshalling keyword_init struct 2018-01-05 11:44:31 +00:00
symbol.c internal.h: remove dependecy on ruby/encoding.h 2018-01-09 06:24:11 +00:00
symbol.h
thread.c [DOC] missing docs at toplevel 2018-02-23 02:18:52 +00:00
thread_pthread.c thread_pthread.c: spelling ("cancellation") 2018-02-19 09:28:56 +00:00
thread_pthread.h
thread_sync.c [DOC] missing docs at toplevel 2018-02-23 02:18:52 +00:00
thread_win32.c thread.c: favor timespec internally 2018-02-07 01:57:14 +00:00
thread_win32.h
time.c time.c (num_exact): use predefined IDs 2018-01-22 03:04:26 +00:00
timev.h timev.h: just use "unsigned int" for bitfields 2018-01-16 06:36:05 +00:00
transcode.c [DOC] missing docs at toplevel 2018-02-23 02:18:52 +00:00
transcode_data.h
util.c define NO_LONG_LONG appropriately 2018-01-04 07:51:18 +00:00
variable.c variable.c: flags at autoloading 2018-02-13 09:36:35 +00:00
version.c version.h: get rid of duplication 2018-02-24 02:55:03 +00:00
version.h * 2018-03-04 2018-03-04 01:52:20 +00:00
vm.c vm.c: trivial optimization 2018-03-04 06:24:38 +00:00
vm_args.c mjit_compile.c: share the definition of macros 2018-02-06 14:07:57 +00:00
vm_backtrace.c mjit_compile.c: merge initial JIT compiler 2018-02-04 11:22:28 +00:00
vm_core.h compile.c: set catch_except_p flag 2018-03-04 07:04:28 +00:00
vm_debug.h
vm_dump.c delete extra #undef [ci skip] 2018-01-03 01:43:17 +00:00
vm_eval.c vm.c: add mjit_enable_p flag 2018-03-03 04:07:02 +00:00
vm_exec.c vm_exec.c: reduced repeated same calls 2018-03-04 01:52:19 +00:00
vm_exec.h mjit_compile.c: use local variables for stack 2018-03-04 07:04:40 +00:00
vm_insnhelper.c mjit_compile.c: use local variables for stack 2018-03-04 07:04:40 +00:00
vm_insnhelper.h mjit_compile.c: use local variables for stack 2018-03-04 07:04:40 +00:00
vm_method.c prefixed functions exported for mjit 2018-02-17 01:30:05 +00:00
vm_opts.h Remove "trace_instruction" compile option. 2017-12-24 17:07:53 +00:00
vm_trace.c mjit_compile.c: merge initial JIT compiler 2018-02-04 11:22:28 +00:00
vsnprintf.c

README.md

Build Status Build status

What's Ruby

Ruby is the interpreted scripting language for quick and easy object-oriented programming. It has many features to process text files and to do system management tasks (as in Perl). It is simple, straight-forward, 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://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms

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/

The Ruby distribution files can be found on the following FTP site:

ftp://ftp.ruby-lang.org/pub/ruby/

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

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

Or if you are using git then use 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:

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

Or if you are using git then use the following command:

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

Ruby home page

The URL of the Ruby home page is:

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

Mailing list

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

subscribe

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

How to compile and install

This is what you need to do to compile and install Ruby:

  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 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. Optionally, run make update-gems and make extract-gems.

    If you want to install bundled gems, run make update-gems and make extract-gems before running make install.

  9. 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).

Bug reports should be filed 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.

mailto:matz@ruby-lang.org