development fork of ruby/ruby
Перейти к файлу
卜部昌平 13064fe5db avoid undefined behaviour when n==0
ISO/IEC 9899:1999 section 6.5.7 states that "If the value of the right
operand is negative or is greater than or equal to the width of the
promoted left operand, the behavior is undefined".  So we have to take
care of such situations.

This has not been a problem because contemporary C compilers are
extraordinary smart to compile the series of shifts into a single
ROTLQ/ROTRQ machine instruction.  In contrast to what C says those
instructions have fully defined behaviour for all possible inputs.
Hence it has been quite difficult to observe the undefined-ness of such
situations.  But undefined is undefined.  We should not rely on such
target-specific assumptions.

We are fixing the situation by carefully avoiding shifts with out-of-
range values.  At least GCC since 4.6.3 and Clang since 8.0 can issue
the exact same instructions like before the changeset.

Also in case of Intel processors, there supposedly be intrinsics named
_rotr/_rotl that do exactly what we need.  They, in practice, are absent
on Clang before 9.x so we cannot blindly use.  But we can at least save
MSVC.

See also:
https://gcc.gnu.org/bugzilla/show_bug.cgi?id=57157
https://bugs.llvm.org/show_bug.cgi?id=17332
2020-01-10 21:17:15 +09:00
.github Slightly change the job wording [ci skip] 2020-01-06 01:52:20 -08:00
basictest Fixed misspellings 2019-12-20 09:32:42 +09:00
benchmark Speeds up fallback to Hash#default_proc in rb_hash_aref by removing a method call 2020-01-08 18:09:52 +09:00
bin Removed the old executables of racc 2020-01-01 07:42:42 +09:00
bootstraptest Show the failed message too 2019-12-12 23:26:35 +09:00
ccan Fix typos [ci skip] 2019-10-14 17:30:04 +09:00
coroutine Remove "All Rights Reserved." from Copyright statement. 2019-12-28 12:45:37 +13:00
coverage Fix typo 2019-05-21 14:23:42 +09:00
cygwin MFLAGS for nmake 2017-02-10 06:12:22 +00:00
defs config.status should be newer than config.cache if exists 2020-01-08 18:35:21 +09:00
doc Redmine /projects/ruby-trunk is now redirected 2019-12-31 22:06:19 -08:00
enc update dependencies 2019-12-26 20:45:12 +09:00
ext [flori/json] Add :nodoc: for GeneratorMethods 2020-01-06 15:13:50 +09:00
gems Promote did_you_mean to default gem 2019-11-30 21:08:19 -05:00
include Moved the definition of `rb_define_method_if_constexpr` 2020-01-09 21:32:26 +09:00
internal avoid undefined behaviour when n==0 2020-01-10 21:17:15 +09:00
lib Fix warnings for URI.encode and URI.decode 2020-01-09 13:09:06 -08:00
libexec Removed the old executables of racc 2020-01-01 07:42:42 +09:00
man Merge bundler-2.1.4 2020-01-08 18:00:32 +09:00
misc Fixed misspellings 2019-12-20 09:32:42 +09:00
missing internal/stdbool.h rework 2019-12-26 20:45:12 +09:00
sample Fixed misspellings 2019-12-20 09:32:42 +09:00
spec Include the standard `id` command output 2020-01-09 15:58:46 +09:00
template decouple internal.h headers 2019-12-26 20:45:12 +09:00
test Fixed up 0eeed5bcc5 2020-01-09 10:13:08 +09:00
tool vcs.rb: Get rid of Kernel#open 2020-01-09 10:04:22 +09:00
win32 decouple internal.h headers 2019-12-26 20:45:12 +09:00
.dir-locals.el add .dir-locals.el [ci skip] 2018-12-27 06:11:09 +00:00
.document Added warning.rb to .document 2019-12-24 13:12:28 +09:00
.editorconfig Remove duplicated and change order 2019-03-21 03:24:59 +00:00
.gdbinit Redmine /projects/ruby-trunk is now redirected 2019-12-31 22:06:19 -08:00
.gitattributes Add tool/leaked-globals to .gitattributes [ci skip] 2019-07-15 13:45:14 +09:00
.gitignore Check -1 arity for C++ 2019-11-22 18:42:49 +09:00
.rspec_parallel Introduce test-bundler-parallel task. 2019-08-22 08:02:48 +10:00
.travis.yml Disable IPv6 on Travis s390x case. (#2819) 2020-01-07 12:23:04 +09:00
BSDL
CONTRIBUTING.md
COPYING COPYING: reformat as RDoc 2019-02-02 06:38:10 +00:00
COPYING.ja COPYING: reformat as RDoc 2019-02-02 06:38:10 +00:00
GPL
KNOWNBUGS.rb compile.c: fix positions encode 2018-04-05 13:13:00 +00:00
LEGAL Split procstat_vm.c 2019-02-07 08:53:13 +00:00
NEWS Update NEWS for Ruby 2.8.0 (tentative; to be 3.0.0) 2019-12-31 18:18:21 +09:00
README.EXT
README.EXT.ja README.EXT.ja: add redirect [ruby-core:68631] 2015-03-30 13:08:16 +00:00
README.ja.md Update GitHub Actions Badges 2020-01-01 00:02:01 +09:00
README.md Update GitHub Actions Badges 2020-01-01 00:02:01 +09:00
aclocal.m4 configure.ac: check finite,isinf,isnan as macros first 2019-02-08 07:22:55 +00:00
addr2line.c internal/stdbool.h rework 2019-12-26 20:45:12 +09:00
addr2line.h Support Mach-O on backtrace with DWARF 2018-10-20 06:35:25 +00:00
appveyor.yml Remove code to prevent double build on trunk 2019-12-31 22:03:21 -08:00
array.c Optimize Array#rotate!(n) for n = 1 and n = -1 2019-12-29 13:12:42 +09:00
ast.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
ast.rb Fix variable name and add more example [ci skip] 2020-01-03 01:27:25 +09:00
bignum.c bignum.c: extract bdigits_to_mpz and bdigits_from_mpz (#2805) 2020-01-01 22:55:12 +09:00
builtin.c take care of USE_LAZY_LOAD=1. 2019-12-25 14:12:33 +09:00
builtin.h readable function names for inline functions. 2019-12-13 17:55:45 +09:00
class.c Remove unused tmp_buffer in class.c 2020-01-05 12:26:48 +09:00
common.mk Update dependencies for c6b26f5ccf 2020-01-10 09:09:51 +09:00
compar.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
compile.c move internal/debug.h definitions to internal.h 2020-01-03 04:46:51 +09:00
complex.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
configure.ac avoid undefined behaviour when n==0 2020-01-10 21:17:15 +09:00
constant.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
cont.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
debug.c move internal/debug.h definitions to internal.h 2020-01-03 04:46:51 +09:00
debug_counter.c add debug_counter access functions. 2019-12-25 01:34:41 +09:00
debug_counter.h debug_counter.h must be self-contained 2019-12-26 20:45:12 +09:00
dir.c Fix documentation of Dir#each_child 2019-12-29 12:59:23 +09:00
dln.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
dln.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
dln_find.c dln_find.c: MAXPATHLEN is not used already 2016-06-02 16:52:15 +00:00
dmydln.c UNREACHABLE_RETURN 2018-07-24 05:38:07 +00:00
dmyenc.c
dmyext.c
encindex.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
encoding.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
enum.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
enumerator.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
error.c support RUBY_ON_BUG envval on assert failure. 2020-01-06 15:06:03 +09:00
eval.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
eval_error.c Renamed ruby_finalize_{0,1} 2019-08-13 09:47:08 +09:00
eval_intern.h Create backtrace location array directly 2019-12-13 20:47:07 +09:00
eval_jump.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
file.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
gc.c Introduce BIGNUM_EMBED_P to check BIGNUM_EMBED_FLAG (#2802) 2019-12-31 22:48:23 +09:00
gc.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
gc.rb fix line break code (fix to LF) 2019-11-08 15:32:01 +09:00
gem_prelude.rb Do not call 'gem "did_you_mean"' for now 2019-11-30 21:08:19 -05:00
golf_prelude.rb golf_prelude.rb: suppress the redefining warning 2019-06-22 23:38:07 +09:00
goruby.c goruby.c: FD leak [ci skip] 2017-03-09 03:38:06 +00:00
hash.c Hoisted out call_default_proc 2020-01-08 18:14:04 +09:00
hrtime.h hrtime.h: fix typo in non-builtin overflow check 2018-08-30 03:24:55 +00:00
id_table.c Revert https://github.com/ruby/ruby/pull/2486 2019-10-03 12:45:24 +09:00
id_table.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
inits.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
insns.def Introduce an "Inline IVAR cache" struct 2019-12-05 13:37:02 -08:00
internal.h move internal/debug.h definitions to internal.h 2020-01-03 04:46:51 +09:00
io.c io.c, ruby.c: include internal/variable.h for rb_gvar_readonly_setter 2020-01-09 23:57:46 +09:00
io.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
iseq.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
iseq.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
lex.c.blt keywords: shrink struct kwtable 2018-01-21 09:59:45 +00:00
load.c decouple internal.h headers 2019-12-26 20:45:12 +09: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 main.c: Add doxygen mainpage 2019-08-08 17:36:12 +09:00
marshal.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
math.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
method.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
mini_builtin.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
miniinit.c support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
mjit.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
mjit.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
mjit_compile.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
mjit_worker.c Allow specifying arbitrary MJIT flags by --jit-debug 2019-12-01 00:58:47 -08:00
node.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
node.h Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
numeric.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
object.c Call initialize_clone with freeze: false if clone called with freeze: false 2020-01-03 20:13:09 -08:00
pack.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
pack.rb Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
parse.y parse.y: fix a wrong sizeof argument for ruby_sized_xfree 2020-01-05 11:39:35 +09:00
prelude.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
probes.d change lingering dtrace probe documentation from function- to method- 2015-05-30 02:04:26 +00:00
probes_helper.h internal/vm.h rework 2019-12-26 20:45:12 +09:00
proc.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
process.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
random.c Ensure seed data to be cleared 2020-01-10 10:28:49 +09:00
range.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
rational.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
re.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
regcomp.c Fix issues detected by code analysis tool (mainly Coverity). 2018-09-15 09:59:14 +00:00
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 Escape control codes in regexp warning message 2019-06-29 19:07:25 +09:00
regexec.c Only define history_root member of the Oniguruma re_registers struct if USE_CAPTURE_HISTORY is enabled 2019-04-24 00:40:17 +09:00
regint.h Merge Onigmo 6.1.1 2017-02-11 15:08:33 +00:00
regparse.c Fixed misspellings 2019-12-20 09:32:42 +09:00
regparse.h Fix typos. 2018-01-18 11:44:10 +00:00
regsyntax.c Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
ruby-runner.c Fix warnings 2019-08-28 16:51:48 +09:00
ruby.c io.c, ruby.c: include internal/variable.h for rb_gvar_readonly_setter 2020-01-09 23:57:46 +09:00
ruby_assert.h respect NDEBUG. 2019-07-19 12:04:32 +09:00
ruby_atomic.h add several __has_something macro 2019-12-26 20:45:12 +09:00
rubystub.c rubystub.c: sys/param.h for MAXPATHLEN 2016-08-20 05:58:58 +00:00
safe.c Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
signal.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
siphash.c switch SipHash from SipHash24 to SipHash13 variant 2017-01-20 06:01:23 +00:00
siphash.h blacklist UBSAN's unsigned integer overflow 2018-11-07 04:09:05 +00:00
sparc.c configure.ac 2017-09-29 13:21:17 +00:00
sprintf.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
st.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
strftime.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
string.c [DOC] Improve docs for String#match 2020-01-08 20:53:31 +01:00
struct.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
symbol.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
symbol.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
thread.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
thread_pthread.c rb_thread_create now free from ANYARGS 2019-08-27 15:52:26 +09:00
thread_pthread.h thread_pthread.h: rename `gvl.acquired' to `gvl.owner' and document 2018-08-28 00:24:08 +00:00
thread_sync.c add assertion for mutex_lock. 2019-10-28 12:19:18 +09:00
thread_win32.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
thread_win32.h
time.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
timev.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
trace_point.rb Fix output of example [ci skip] 2020-01-05 00:52:43 +09:00
transcode.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
transcode_data.h transcode_data.h: missing cast 2015-08-08 00:33:11 +00:00
transient_heap.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
transient_heap.h Add `GC.compact` again. 2019-04-20 01:19:47 +00:00
util.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
variable.c always expand ivar arrays to max width 2020-01-06 12:41:33 -08:00
variable.h fastpath for ivar read of FL_EXIVAR objects. 2019-11-29 03:11:04 +09:00
version.c Provides ruby2_keywords 2019-10-23 00:19:25 +09:00
version.h * 2020-01-10 [ci skip] 2020-01-10 06:11:12 +09:00
vm.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
vm_args.c Fix unused warnings 2020-01-03 14:53:25 +09:00
vm_backtrace.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
vm_core.h Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
vm_debug.h add rp() and bp() in internal.h. 2019-08-09 14:01:15 +09:00
vm_dump.c support RUBY_ON_BUG envval on assert failure. 2020-01-06 15:06:03 +09:00
vm_eval.c script_compiled event on compile error. 2020-01-06 11:36:51 +09:00
vm_exec.c Add VM insns counter like debug_counter (#2789) 2019-12-28 00:44:09 -08:00
vm_exec.h Add VM insns counter like debug_counter (#2789) 2019-12-28 00:44:09 -08:00
vm_insnhelper.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
vm_insnhelper.h per-method serial number 2019-12-18 12:52:28 +09:00
vm_method.c Check Module#ruby2_keywords arity 2020-01-02 10:41:24 +09:00
vm_opts.h Use cppflags to pass preprocessor options 2019-10-23 02:53:36 +09:00
vm_trace.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
vsnprintf.c Use array indexing with considering clang's feeling 2019-08-27 14:25:58 +09:00
warning.rb Fix a typo [ci skip] 2020-01-02 12:12:05 +09:00

README.md

Build Status Build status Actions 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 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).

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