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
Jeremy Evans 2d98593bf5 Support tracing of attr_reader and attr_writer
In vm_call_method_each_type, check for c_call and c_return events before
dispatching to vm_call_ivar and vm_call_attrset.  With this approach, the
call cache will still dispatch directly to those functions, so this
change will only decrease performance for the first (uncached) call, and
even then, the performance decrease is very minimal.

This approach requires that we clear the call caches when tracing is
enabled or disabled.  The approach currently switches all vm_call_ivar
and vm_call_attrset call caches to vm_call_general any time tracing is
enabled or disabled. So it could theoretically result in a slowdown for
code that constantly enables or disables tracing.

This approach does not handle targeted tracepoints, but from my testing,
c_call and c_return events are not supported for targeted tracepoints,
so that shouldn't matter.

This includes a benchmark showing the performance decrease is minimal
if detectable at all.

Fixes [Bug #16383]
Fixes [Bug #10470]

Co-authored-by: Takashi Kokubun <takashikkbn@gmail.com>
2021-08-29 07:23:39 -07:00
.github [Windows CI] Stop VS-2022 2021-08-28 18:21:47 +09:00
basictest
benchmark Support tracing of attr_reader and attr_writer 2021-08-29 07:23:39 -07:00
bin Remove probably unintented symlinks 2021-07-27 18:49:28 +09:00
bootstraptest [Bug #18117] Fix Ractor race condition with GC 2021-08-24 09:47:42 -04:00
ccan [Doc] Fix a typo s/oher/other/ 2021-04-25 19:46:00 +12:00
coroutine Ignore dead threads in coroutine_join. 2021-07-02 12:36:14 +12:00
coverage Fix Typo 2021-06-07 10:22:55 +09:00
cygwin Share variables defined in common GNUmakefile also in cygwin/mingw 2021-03-21 17:57:44 +09:00
defs Use empty instead of NOOP in mk file to make it safer 2021-08-25 18:47:44 +09:00
doc [DOC] prefer RUBY_DEFAULT_FREE to a magic number [ci skip] 2021-08-21 16:50:51 +09:00
enc Remove no longer needed include files (Unicode Version 12.1.0) 2021-07-09 16:22:38 +09:00
ext [Feature #18045] Remove T_PAYLOAD 2021-08-25 09:28:21 -04:00
gems Update power_assert to 2.0.1 2021-08-29 11:38:45 +09:00
include Use C99-defined signbit macro 2021-08-27 12:42:23 +09:00
internal [Feature #18045] Implement size classes for GC 2021-08-25 09:28:21 -04:00
lib [ruby/irb] Version 1.3.8.pre.1 2021-08-29 20:33:21 +09:00
libexec
man Man page: correct defaults for RUBY_THREAD_VM_STACK_SIZE 2021-04-20 19:26:15 -04:00
misc [Feature #18045] Implement size classes for GC 2021-08-25 09:28:21 -04:00
missing Use C99-defined signbit macro 2021-08-27 12:42:23 +09:00
sample Clean up lambda output from exyacc.rb 2021-08-25 18:23:56 -07:00
spec Fix failures on non-UTF-8 environment [Bug #18077] 2021-08-22 12:11:45 +09:00
template Make ruby.pc from make 2021-08-29 14:08:53 +09:00
test Support tracing of attr_reader and attr_writer 2021-08-29 07:23:39 -07:00
tool Handle non-succeeding reports mingled with dots 2021-08-29 16:32:55 +09:00
win32 Add missing empty macro [ci skip] 2021-08-25 18:28:27 +09:00
.dir-locals.el
.document Add nilclass.rb to .document 2021-06-23 10:23:10 +09:00
.editorconfig
.gdbinit .gdbinit: Fix indentation in print_id [ci skip] 2021-02-06 13:03:40 -05:00
.gitattributes
.gitignore Ignore static-ruby [ci skip] 2020-11-24 08:38:06 +09:00
.rspec_parallel
.travis.yml Reduce the amount of false positive notifications 2021-08-13 10:26:12 -07:00
aclocal.m4 get rid of aclocal (#4280) 2021-03-17 18:52:53 +09:00
addr2line.c Ignore DW_FORM_ref_addr [Bug #17052] 2021-08-14 23:57:52 +09:00
addr2line.h
appveyor.yml [Win32] Skip over source update just after clone on AppVeyor 2021-08-14 22:09:50 +09:00
array.c Fix length calculation for Array#slice! 2021-08-29 09:41:22 +09:00
array.rb
ast.c ast.c: Rename "save_script_lines" to "keep_script_lines" 2021-08-20 16:18:36 +09:00
ast.rb ast.c: Rename "save_script_lines" to "keep_script_lines" 2021-08-20 16:18:36 +09:00
autogen.sh autogen.sh: Make it work with sh (not bash) 2021-03-17 23:13:22 +09:00
bignum.c Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
BSDL
builtin.c Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
builtin.h Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
class.c [Feature #18045] Implement size classes for GC 2021-08-25 09:28:21 -04:00
common.mk Update the list of replacing objects under missing 2021-08-27 12:43:45 +09:00
compar.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
compile.c Allow tracing of optimized methods 2021-08-21 10:15:01 -07:00
complex.c Use C99-defined signbit macro 2021-08-27 12:42:23 +09:00
configure.ac Make ruby.pc from make 2021-08-29 14:08:53 +09:00
constant.h
cont.c Remove root_jmpbuf in rb_thread_struct 2021-08-10 19:08:38 +09:00
CONTRIBUTING.md [Doc] Link to doc/contributing.rdoc from CONTRIBUTING.md (#4266) 2021-04-03 14:45:18 +09:00
COPYING
COPYING.ja
debug.c Moved exported symbols in internal/util.h to ruby/util.h 2021-08-24 10:37:41 +09:00
debug_counter.c make RB_DEBUG_COUNTER_INC()_thread-safe 2020-12-17 03:43:59 +09:00
debug_counter.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
dir.c Actually ignore FNM_CASEFOLD flag in Dir.glob 2021-06-24 12:22:09 -07:00
dir.rb [DOC] Fix a typo in Dir.fnmatch 2021-08-27 09:16:25 +09:00
dln.c Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
dln.h Removed dln_a_out 2021-03-24 20:13:55 +09:00
dln_find.c Removed an unused declaration 2021-03-12 19:28:17 +09:00
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c Add rb_encoding_check function 2021-08-22 10:39:14 +09:00
enum.c Extracted repeatedly defined IDs 2021-07-27 15:40:27 +09:00
enumerator.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
error.c Show verbose error messages when single pattern match fails 2021-08-15 09:38:24 +09:00
eval.c Remove root_jmpbuf in rb_thread_struct 2021-08-10 19:08:38 +09:00
eval_error.c Limit bactrace length from Exception#full_message 2020-12-27 20:50:15 +09:00
eval_intern.h Remove root_jmpbuf in rb_thread_struct 2021-08-10 19:08:38 +09:00
eval_jump.c Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
file.c Add stat_time function 2021-08-24 09:23:07 +09:00
gc.c Fix memory leak in Variable Width Allocation 2021-08-27 10:13:32 -04:00
gc.h
gc.rb Add documentation about GC.compact 2020-12-17 13:26:53 -08:00
gem_prelude.rb Silence LoadError only if it is for rubygems itself 2021-08-18 21:37:31 +09:00
golf_prelude.rb
goruby.c goruby.c: include golf_prelude.c to get rid of overwriting EXTOBJS 2021-07-03 22:39:14 +09:00
GPL
hash.c Free previously used tables [Bug #18134] 2021-08-29 17:18:58 +09:00
hrtime.h
id_table.c Add a cache for class variables 2021-06-18 10:02:44 -07:00
id_table.h
inits.c Implemented some NilClass method in Ruby code is faster [Feature #17054] (#3366) 2021-06-02 20:04:56 -07:00
insns.def Add a cache for class variables 2021-06-18 10:02:44 -07:00
internal.h Using RBOOL macro 2021-08-02 12:06:44 +09:00
io.c Fix Marshal.dump(closed_io) to raise TypeError and allow encoding on closed IO 2021-08-22 10:33:22 +09:00
io.rb
iseq.c Support tracing of attr_reader and attr_writer 2021-08-29 07:23:39 -07:00
iseq.h Allow tracing of optimized methods 2021-08-21 10:15:01 -07:00
kernel.rb [DOC] Use URI#read instead of URI.open for better compatibility 2021-01-12 22:12:02 +09:00
KNOWNBUGS.rb
LEGAL Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
lex.c.blt
load.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
loadpath.c
localeinit.c win32: Use UTF-8 as filesystem encoding [Feature #12654] 2020-12-20 18:34:04 +09:00
main.c stdlib.h is always included in include/ruby/defines.h 2021-01-05 01:06:33 +09:00
marshal.c Remove unneeded declarations 2021-03-20 21:00:29 +09:00
math.c Use C99-defined signbit macro 2021-08-27 12:42:23 +09:00
memory_view.c Moved exported symbols in internal/util.h to ruby/util.h 2021-08-24 10:37:41 +09:00
method.h
mini_builtin.c * expand tabs. [ci skip] 2021-06-17 06:09:26 +09:00
miniinit.c
mjit.c Revert "Pause an MJIT worker when JIT is cancelled" 2021-08-13 09:13:09 -07:00
mjit.h Print JIT cancel when all JIT-ed code is cancelled 2021-08-12 23:11:38 -07:00
mjit_compile.c Improve perfomance for Integer#size method [Feature #17135] (#3476) 2021-06-04 21:57:21 -07:00
mjit_worker.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
NEWS.md Fix links [ci skip] 2021-08-22 22:27:29 +09:00
nilclass.rb Implemented some NilClass method in Ruby code is faster [Feature #17054] (#3366) 2021-06-02 20:04:56 -07:00
node.c Show node IDs in dump 2021-07-12 12:10:16 +09:00
node.h node.h: Reduce struct size to fit with Ruby object size (five VALUEs) 2021-06-18 02:34:27 +09:00
numeric.c Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
numeric.rb Improve perfomance for Integer#size method [Feature #17135] (#3476) 2021-06-04 21:57:21 -07:00
object.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
pack.c Moved exported symbols in internal/util.h to ruby/util.h 2021-08-24 10:37:41 +09:00
pack.rb [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
parse.y Moved exported symbols in internal/util.h to ruby/util.h 2021-08-24 10:37:41 +09:00
prelude.rb
probes.d remove method__cache__clear 2020-12-24 01:59:36 +09:00
probes_helper.h
proc.c Add keyrest to ruby2_keywords parameters [Bug #18011] 2021-08-03 10:56:50 +09:00
process.c Add Windows as a supported OS for Process.clock_gettime [ci skip] 2021-08-28 18:26:19 +09:00
ractor.c [Bug #18117] Fix Ractor race condition with GC 2021-08-24 09:47:42 -04:00
ractor.rb Fix some typos by spell checker 2021-04-26 10:07:41 +09:00
ractor_core.h [Bug #18014] Fix memory leak in GC when using Ractors 2021-07-15 11:48:52 -04:00
random.c Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
range.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
rational.c Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
re.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
README.EXT
README.EXT.ja
README.ja.md [DOC] Move mailing-list URLs to footnotes [ci skip] 2021-07-11 20:12:45 +09:00
README.md [DOC] Move mailing-list URLs to footnotes [ci skip] 2021-07-11 20:12:45 +09:00
regcomp.c Fixed shorten-64-to-32 errors when USE_COMBINATION_EXPLOSION_CHECK 2021-05-07 20:15:05 +09:00
regenc.c
regenc.h
regerror.c
regexec.c Fixed shorten-64-to-32 errors when USE_COMBINATION_EXPLOSION_CHECK 2021-05-07 20:15:05 +09:00
regint.h
regparse.c Do not reduce quantifiers if it affects which text will be matched 2020-12-02 18:42:02 +01:00
regparse.h
regsyntax.c
ruby-runner.c
ruby.c Suppress unused-but-set-variable warning 2021-07-06 00:09:27 +09:00
ruby_assert.h
ruby_atomic.h Expose atomic operation macros with RUBY prefix 2020-12-24 11:43:21 +09:00
rubystub.c
scheduler.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
signal.c SIGILL can raise at stack overflow on Linux too [Bug #18084] 2021-08-18 17:23:27 +09:00
siphash.c Fix compilation error in mingw 2021-05-04 20:38:03 -04:00
siphash.h
sparc.c
sprintf.c Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
st.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
strftime.c Moved exported symbols in internal/util.h to ruby/util.h 2021-08-24 10:37:41 +09:00
string.c Treat NULL fake string as an empty string 2021-08-17 18:45:36 +09:00
struct.c Make Struct#keyword_init? return nil by default [Feature #18008] 2021-07-15 22:24:02 +09:00
symbol.c rb_enc_symname_type: indent 2021-03-05 16:33:29 +09:00
symbol.h
thread.c Fix potential hang when joining threads. 2021-08-03 22:23:48 +12:00
thread_pthread.c Suppress unused-variable warnings 2021-08-16 16:02:49 +09:00
thread_pthread.h Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
thread_sync.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
thread_win32.c Replace copy coroutine with pthread implementation. 2021-07-01 11:23:03 +12:00
thread_win32.h
time.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
timev.h
timev.rb [DOC] Match each Time.now for comparison [ci skip] 2021-08-23 14:12:21 +09:00
trace_point.rb Tweak description of TracePoint :line event 2021-06-19 13:55:28 +12:00
transcode.c Extracted repeatedly defined IDs 2021-07-27 15:40:27 +09:00
transcode_data.h
transient_heap.c cancel theap on multi-ractors 2020-12-07 08:28:36 +09:00
transient_heap.h cancel theap on multi-ractors 2020-12-07 08:28:36 +09:00
util.c Cast to size_t instead of int 2021-07-22 09:52:29 +09:00
variable.c Use Module#ancestors order in recursive constant lookup 2021-06-30 10:49:27 +09:00
variable.h fix ivar with shareable objects issue 2020-12-12 06:19:18 +09:00
version.c
version.h * 2021-08-29 [ci skip] 2021-08-29 09:41:46 +09:00
vm.c Show verbose error messages when single pattern match fails 2021-08-15 09:38:24 +09:00
vm_args.c remove unused decl 2021-01-08 14:39:05 +09:00
vm_backtrace.c Make backtrace generation work outward from current frame 2021-08-06 10:15:01 -07:00
vm_callinfo.h global call-cache cache table for rb_funcall* 2021-01-29 16:22:12 +09:00
vm_core.h Remove root_jmpbuf in rb_thread_struct 2021-08-10 19:08:38 +09:00
vm_debug.h
vm_dump.c Crash more nicely when the VM isn't fully set up 2021-06-10 16:31:29 -07:00
vm_eval.c Support tracing of attr_reader and attr_writer 2021-08-29 07:23:39 -07:00
vm_exec.c Suppress unused-function warning when OPT_THREADED_CODE != 1 2021-08-09 11:21:56 +09:00
vm_exec.h Suppress unused-label warnings 2021-08-22 20:16:44 +09:00
vm_insnhelper.c Support tracing of attr_reader and attr_writer 2021-08-29 07:23:39 -07:00
vm_insnhelper.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
vm_method.c Get rid of type-punning pointer casts [Bug #18062] 2021-08-11 12:07:44 +09:00
vm_opts.h
vm_sync.c Fixed leaked global symbols 2020-12-26 09:39:53 +09:00
vm_sync.h Adjusted indent [ci skip] 2021-02-09 08:41:06 +09:00
vm_trace.c Support tracing of attr_reader and attr_writer 2021-08-29 07:23:39 -07:00
vsnprintf.c Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
warning.rb Use category: :deprecated in warnings that are related to deprecation 2020-12-18 09:54:11 -08:00

Actions Status: macOS Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis 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, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/contributing.rdoc#label-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 also 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.

Requirements to build from repository

  1. GNU or BSD make
  2. C99 compiler
  3. autoconf 2.67 or higher
  4. automake 1.15 or higher
  5. bison 2.3 or higher
  6. Ruby 2.2 or higher

When building from a released version, only a C99 compiler and GNU or BSD make is required.

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. Run ./autogen.sh to generate configure, when you build the source checked out from the Git repository.

  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. Optional: Remove comment mark(#) before the module names from ext/Setup.

    This step is only necessary if you want to link modules statically.

    If you don't want to compile dynamic extensions (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 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