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
normal 708bfd2115 thread_pthread: remove timer-thread by restructuring GVL
To reduce resource use and reduce CI failure; remove
timer-thread.  Single-threaded Ruby processes (including forked
children) will never see extra thread overhead.  This prevents
glibc and jemalloc from going into multi-threaded mode and
initializing locks or causing fragmentation via arena explosion.

The GVL is implements its own wait-queue as a ccan/list to
permit controlling wakeup order.  Timeslice under contention is
handled by a designated timer thread (similar to choosing a
"patrol_thread" for current deadlock checking).

There is only one self-pipe, now, as wakeups for timeslice are
done independently using condition variables.  This reduces FD
pressure slightly.

Signal handling is handled directly by a Ruby Thread (instead
of timer-thread) by exposing signal self-pipe to callers of
rb_thread_fd_select, native_sleep, rb_wait_for_single_fd, etc...
Acquiring, using, and releasing the self-pipe is exposed via 4
new internal functions:

1) rb_sigwait_fd_get - exclusively acquire timer_thread_pipe.normal[0]

2) rb_sigwait_fd_sleep - sleep and wait for signal (and no other FDs)

3) rb_sigwait_fd_put - release acquired result from rb_sigwait_fd_get

4) rb_sigwait_fd_migrate - migrate signal handling to another thread
                           after calling rb_sigwait_fd_put.

rb_sigwait_fd_migrate is necessary for waitpid callers because
only one thread can wait on self-pipe at a time, otherwise a
deadlock will occur if threads fight over the self-pipe.

TRAP_INTERRUPT_MASK is now set for the main thread directly in
signal handler via rb_thread_wakeup_timer_thread.

Originally, I wanted to use POSIX timers
(timer_create/timer_settime) for this.  Unfortunately, this
proved unfeasible as Mutex#sleep resumes on spurious wakeups and
test/thread/test_cv.rb::test_condvar_timed_wait failed.  Using
pthread_sigmask to mask out SIGVTALRM fixed that test,  but
test/fiddle/test_function.rb::test_nogvl_poll proved there'd be
some unavoidable (and frequent) incompatibilities from that
approach.

Finally, this allows us to drop thread_destruct_lock and
interrupt current ec directly.

We don't need to rely on vm->thread_destruct_lock or a coherent
vm->running_thread on any platform.  Separate timer-thread for
time slice and signal handling is relegated to thread_win32.c,
now.

[ruby-core:88088] [Misc #14937]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@64107 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-07-29 20:47:33 +00:00
basictest
benchmark benchmark/README.md: skip showing --timeout option [ci skip] 2018-07-11 22:49:48 +00:00
bin erb.rb: deprecate safe_level of ERB.new 2018-02-22 13:28:25 +00:00
bootstraptest Fix a bug of peephole optimization 2018-07-06 04:52:33 +00:00
ccan ccan/list: sync with upstream 2018-02-01 08:59:27 +00:00
coverage
cygwin
defs gmake.mk: update in the source directory properly 2018-06-02 12:17:16 +00:00
doc use https:// instead of git:// when possible 2018-07-28 03:34:30 +00:00
enc ruby tool/update-deps --fix 2018-07-05 12:48:45 +00:00
ext reduce LibreSSL warnings 2018-07-29 08:13:05 +00:00
gems Update latest versions of bundled gems. 2018-07-25 11:34:35 +00:00
include use https:// instead of http:// 2018-07-28 10:00:27 +00:00
lib Fix filename in comment [ci skip] 2018-07-28 10:00:29 +00:00
man man/ruby.1: [DOC] fix grammar 2018-04-14 16:48:40 +00:00
misc misc/ruby-style.el: use spaces for indentation 2018-03-17 02:37:51 +00:00
missing [ci skip] tabify 2018-01-20 04:18:09 +00:00
sample Fix a typo [ci skip] 2018-07-23 09:49:45 +00:00
spec spec/ruby/security/cve_2018_6914_spec.rb: get rid of leftover files 2018-07-11 08:33:32 +00:00
template fake.rb.in: duplicated RUBYOPT 2018-07-03 04:43:27 +00:00
test thread_pthread: remove timer-thread by restructuring GVL 2018-07-29 20:47:33 +00:00
tool make-snapshot: fetch from the official git site 2018-07-28 12:47:36 +00:00
win32 mkexports.rb: flip-flop 2018-07-29 00:09:08 +00:00
.document [DOC] Add win32/README.win32 to .document 2018-04-12 14:24:06 +00:00
.editorconfig .editorconfig: Use spaces instead of tab except Makefiles 2018-01-25 00:11:52 +00:00
.gdbinit .gdbinit: expand RBASIC macro for old gdb on mac 2018-06-14 03:18:10 +00:00
.gitattributes
.gitignore benchmark: introduce benchmark_driver.gem 2018-07-08 14:38:05 +00:00
.indent.pro
.travis.yml .travis.yml: resurrect notification to #commits 2018-02-11 06:33:45 +00:00
aclocal.m4 aclocal.m4: remove ruby_check_va_copy.m4 2018-02-18 05:12:26 +00:00
addr2line.c addr2line.c (kprintf): static 2018-07-09 03:07:59 +00:00
addr2line.h
appveyor.yml appveyor.yml: refactor r62402 2018-02-14 14:09:32 +00:00
array.c fix sum on infinity 2018-07-22 10:47:33 +00:00
ast.c Add docs to RubyVM::AST 2018-07-25 18:00:09 +00:00
bignum.c UNREACHABLE_RETURN 2018-07-24 05:38:07 +00:00
BSDL
class.c eval.c: rename "rb_frozen_class_p" to "rb_class_modify_check" 2018-07-27 13:57:14 +00:00
common.mk common.mk: install for test-all iff load-relative is disabled 2018-07-29 11:00:02 +00:00
compar.c
compile.c Remove redundant code in the compiler. 2018-07-09 20:01:54 +00:00
complex.c share Float 0 2018-06-17 02:41:26 +00:00
configure.ac unrevert r63852 but keep SIGCHLD path disabled for win32 2018-07-05 03:02:33 +00:00
constant.h vm_insnhelper.c: rb_autoloading_value flag 2018-02-13 09:34:43 +00:00
cont.c cont.c (ec_switch): prevent delayed/missed trap interrupt race 2018-07-26 08:30:10 +00:00
CONTRIBUTING.md
COPYING
COPYING.ja
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 dir.c: fix glob with base when no DT_UNKNOWN 2018-07-26 12:48:02 +00:00
dln.c constified 2018-01-09 00:06:00 +00:00
dln.h
dln_find.c
dmydln.c UNREACHABLE_RETURN 2018-07-24 05:38:07 +00:00
dmyenc.c
dmyext.c
encindex.h encoding.c: rb_enc_find_index2 2017-12-22 01:03:17 +00:00
encoding.c check enc_capable. 2018-06-28 08:35:48 +00:00
enum.c UNREACHABLE_RETURN 2018-07-24 05:38:07 +00:00
enumerator.c enumerator.c: pretty kwags 2018-03-15 06:29:04 +00:00
error.c Fix message when order was an invalid value 2018-07-17 01:22:32 +00:00
eval.c eval.c: rename "rb_frozen_class_p" to "rb_class_modify_check" 2018-07-27 13:57:14 +00:00
eval_error.c eval_error.c: fix loop on exception in message 2018-04-11 08:03:43 +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: chardev is loadable 2018-04-13 06:26:30 +00:00
gc.c Include the alternative malloc header instead of malloc.h 2018-07-17 22:27:52 +00:00
gc.h remove rb_threadptr_during_gc(). 2017-10-29 13:51:37 +00:00
gem_prelude.rb
golf_prelude.rb added f for 1 byte FizzBuzz because Hexagony has such feature 2018-05-21 06:20:24 +00:00
goruby.c
GPL
hash.c Include Hash#size in the examples 2018-07-27 17:28:41 +00:00
ia64.s
id_table.c
id_table.h
inits.c Define AST module under RubyVM [experimental] 2018-05-31 06:13:06 +00:00
insns.def insns.def: remove old wrong explanation for get/setconstant 2018-07-27 06:28:14 +00:00
internal.h thread_pthread: remove timer-thread by restructuring GVL 2018-07-29 20:47:33 +00:00
io.c io.c: fix compilation when IOV_MAX is not defined 2018-06-05 20:46:56 +00:00
iseq.c mjit.c: disable calling JIT-ed code 2018-06-23 14:11:19 +00:00
iseq.h repack structs 2018-07-29 01:32:37 +00:00
KNOWNBUGS.rb compile.c: fix positions encode 2018-04-05 13:13:00 +00:00
LEGAL Update url with 404 status on LEGAL file. 2018-02-21 07:12:17 +00:00
lex.c.blt keywords: shrink struct kwtable 2018-01-21 09:59:45 +00:00
load.c load.c: use ruby_sized_xfree for calloc-ed RArray VALUE 2018-05-21 21:40:54 +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
Makefile.in benchmark: introduce benchmark_driver.gem 2018-07-08 14:38:05 +00:00
marshal.c check enc_capable. 2018-06-28 08:35:48 +00:00
math.c math.c: adjust cbrt 2018-06-06 14:01:43 +00:00
method.h Add TracePoint#parameters 2018-06-03 05:10:41 +00:00
miniinit.c
mjit.c mjit.c: keep unit->o_file on --jit-save-temps 2018-07-29 08:04:45 +00:00
mjit.h mjit.c: use NOT_COMPILED_JIT_ISEQ_FUNC for unloaded 2018-07-27 08:51:56 +00:00
mjit_compile.c mjit.c: handle memory allocation failure 2018-07-24 15:40:05 +00:00
NEWS NEWS: add NEWS entry about Kernel#then [Feature #14594] 2018-07-01 08:12:14 +00:00
node.c Use nd_X shorthand for annotation 2018-06-28 13:22:13 +00:00
node.h node.h: remove unused macro nd_compile_option 2018-07-15 11:45:59 +00:00
numeric.c UNREACHABLE_RETURN 2018-07-24 05:38:07 +00:00
object.c object.c: prefer base optarg 2018-07-22 16:03:58 +00:00
pack.c UNREACHABLE_RETURN 2018-07-24 05:38:07 +00:00
parse.y parse.y (heredoc_identifier): Update comment for term_len 2018-07-16 02:07:44 +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 Remove obsolete comment from Module#define_method documentation 2018-07-25 18:06:29 +00:00
process.c thread_pthread: remove timer-thread by restructuring GVL 2018-07-29 20:47:33 +00:00
random.c prefer clock_gettime 2018-06-14 13:10:25 +00:00
range.c range.c: [DOC] small improvement 2018-07-08 19:30:19 +00:00
rational.c Add exception: keyword in Kernel#Rational() 2018-03-15 07:19:46 +00:00
re.c re.c: do not escape terminator in Regexp.union 2018-03-16 13:37:44 +00:00
README.EXT
README.EXT.ja
README.ja.md [DOC] Use https: instead of git: [ci skip] 2018-07-03 11:01:06 +00:00
README.md use https:// instead of git:// when possible 2018-07-28 03:34:30 +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-runner.c: show the failed path 2018-07-17 01:00:05 +00:00
ruby.c ruby.c: taint ARGV on Windows 2018-07-27 05:42:56 +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 thread_pthread: remove timer-thread by restructuring GVL 2018-07-29 20:47:33 +00:00
siphash.c
siphash.h
sparc.c
sprintf.c sprintf.c: fix typo 2018-04-22 19:41:06 +00:00
st.c st.c: remove redundant export declaration 2018-05-27 05:52:43 +00:00
strftime.c
string.c move function declarations from insns.def to internal.h 2018-06-27 00:57:16 +00:00
struct.c UNREACHABLE_RETURN 2018-07-24 05:38:07 +00:00
symbol.c symbol.c: dsymbol initial encoding 2018-06-28 07:34:36 +00:00
symbol.h symbol.h: remove stale symbol deleted at r47913 2018-04-06 13:25:11 +00:00
thread.c thread_pthread: remove timer-thread by restructuring GVL 2018-07-29 20:47:33 +00:00
thread_pthread.c thread_pthread: remove timer-thread by restructuring GVL 2018-07-29 20:47:33 +00:00
thread_pthread.h thread_pthread: remove timer-thread by restructuring GVL 2018-07-29 20:47:33 +00:00
thread_sync.c [Doc] Recover example about Queue 2018-07-25 18:09:02 +00:00
thread_win32.c thread_pthread: remove timer-thread by restructuring GVL 2018-07-29 20:47:33 +00:00
thread_win32.h
time.c renamed ruby_tz_update as ruby_tz_uptodate_p 2018-07-19 11:22:03 +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 eval.c: rename "rb_frozen_class_p" to "rb_class_modify_check" 2018-07-27 13:57:14 +00:00
version.c version.h: get rid of duplication 2018-02-24 02:55:03 +00:00
version.h * 2018-07-30 2018-07-29 20:28:57 +00:00
vm.c vm.c: simplify the implementation of r64031 2018-07-24 15:17:08 +00:00
vm_args.c repack structs 2018-07-29 01:32:37 +00:00
vm_backtrace.c Revert "Fix use of rb_profile_frames start parameter" 2018-04-27 00:13:51 +00:00
vm_core.h thread_pthread: remove timer-thread by restructuring GVL 2018-07-29 20:47:33 +00:00
vm_debug.h
vm_dump.c vm_core.h, vm_dump.c: fix cast 2018-07-15 11:42:15 +00:00
vm_eval.c vm.c: simplify the implementation of r64031 2018-07-24 15:17:08 +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 vm.c: simplify the implementation of r64031 2018-07-24 15:17:08 +00:00
vm_insnhelper.h mjit_compile.c: reduce sp motion on JIT 2018-07-19 13:25:22 +00:00
vm_method.c eval.c: rename "rb_frozen_class_p" to "rb_class_modify_check" 2018-07-27 13:57:14 +00:00
vm_opts.h Remove "trace_instruction" compile option. 2017-12-24 17:07:53 +00:00
vm_trace.c mjit.c: disable calling JIT-ed code 2018-06-23 14:11:19 +00:00
vsnprintf.c

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://github.com/ruby/ruby/blob/trunk/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/

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 https://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 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.

matz@ruby-lang.org