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
John Hawthorn 40b7358e93 Skip defined check in NODE_OP_ASGN_OR with ivar
Previously we would add code to check if an ivar was defined when using
`@foo ||= 123`, which was slower than `@foo || (@foo = 123)` when `@foo`
was already defined.

Recently 01b7d5acc7 made it so that
accessing an undefined variable no longer generates a warning, making
the defined check unnecessary and both statements exactly equal.

This commit avoids emitting the defined instruction when compiling
NODE_OP_ASGN_OR with a NODE_IVAR.

Before:

    $ ruby --dump=insn -e '@foo ||= 123'
    == disasm: #<ISeq:<main>@-e:1 (1,0)-(1,12)> (catch: FALSE)
    0000 putnil                                                           (   1)[Li]
    0001 defined                      instance-variable, :@foo, false
    0005 branchunless                 14
    0007 getinstancevariable          :@foo, <is:0>
    0010 dup
    0011 branchif                     20
    0013 pop
    0014 putobject                    123
    0016 dup
    0017 setinstancevariable          :@foo, <is:0>
    0020 leave

After:

    $ ./ruby --dump=insn -e '@foo ||= 123'
    == disasm: #<ISeq:<main>@-e:1 (1,0)-(1,12)> (catch: FALSE)
    0000 getinstancevariable                    :@foo, <is:0>             (   1)[Li]
    0003 dup
    0004 branchif                               13
    0006 pop
    0007 putobject                              123
    0009 dup
    0010 setinstancevariable                    :@foo, <is:0>
    0013 leave

This seems to be about 50% faster in this benchmark:

    require "benchmark/ips"

    class Foo
      def initialize
        @foo = nil
      end

      def test1
        @foo ||= 123
      end

      def test2
        @foo || (@foo = 123)
      end
    end

    FOO = Foo.new

    Benchmark.ips do |x|
      x.report("test1", "FOO.test1")
      x.report("test2", "FOO.test2")
    end

Before:

    $ ruby benchmark_ivar.rb
    Warming up --------------------------------------
                   test1     1.957M i/100ms
                   test2     3.125M i/100ms
    Calculating -------------------------------------
                   test1     20.030M (± 1.7%) i/s -    101.780M in   5.083040s
                   test2     31.227M (± 4.5%) i/s -    156.262M in   5.015936s

After:

    $ ./ruby benchmark_ivar.rb
    Warming up --------------------------------------
                   test1     3.205M i/100ms
                   test2     3.197M i/100ms
    Calculating -------------------------------------
                   test1     32.066M (± 1.1%) i/s -    163.440M in   5.097581s
                   test2     31.438M (± 4.9%) i/s -    159.860M in   5.098961s
2020-12-14 19:38:59 -08:00
.github ulimit does not affect another shell 2020-12-13 20:26:22 +09:00
basictest
benchmark Guard all accesses to RubyVM::MJIT with defined?(RubyVM::MJIT) && 2020-12-04 16:45:54 +01:00
bin
bootstraptest Debug the command used for gdb dump 2020-12-13 23:35:29 -08:00
ccan
coroutine Fix "Ruby is not properly fortified on armv7hl". 2020-12-08 23:37:42 +13:00
coverage
cygwin
defs gmake.mk: renamed BUNDLED_GEMS as bundled-gems 2020-12-02 17:04:33 +09:00
doc Fix a typo [ci skip] 2020-12-14 10:26:04 +09:00
enc Add string encoding IBM720 alias CP720 (#3803) 2020-11-22 22:23:40 +09:00
ext ripper: return pushed new token instead of the token list 2020-12-15 10:26:50 +09:00
gems Completely removed webrick 2020-12-10 18:06:25 +09:00
include Signal handler type should be void 2020-12-12 17:02:42 +09:00
internal Narrowed down unaligned member access region in RB_OBJ_WRITE 2020-12-13 11:57:05 +09:00
lib Prepare to release rubygems-3.2.1 and bundler-2.2.1 2020-12-15 10:54:09 +09:00
libexec Removed unused option on racc 2020-09-28 18:53:25 +09:00
man Merge prepare version of Bundler 2.2.0 2020-12-08 17:30:02 +09:00
misc Promote webrick to bundled gems 2020-12-10 18:06:25 +09:00
missing Removed obsolete autoconf checks 2020-12-12 17:23:44 +09:00
sample webrick was removed from ruby repo 2020-12-10 18:06:25 +09:00
spec Prepare to release rubygems-3.2.1 and bundler-2.2.1 2020-12-15 10:54:09 +09:00
template Revert "Set VM_FRAME_FLAG_FINISH at once on MJIT" 2020-11-26 22:41:15 -08:00
test Prepare to release rubygems-3.2.1 and bundler-2.2.1 2020-12-15 10:54:09 +09:00
tool Fixed dst name for digest gem 2020-12-14 19:39:32 +09:00
util
win32 Removed obsolete autoconf checks 2020-12-12 17:23:44 +09:00
.dir-locals.el
.document
.editorconfig
.gdbinit Add T_MOVED to rp command of GDB 2020-12-04 08:43:32 -08:00
.gitattributes
.gitignore Ignore static-ruby [ci skip] 2020-11-24 08:38:06 +09:00
.rspec_parallel
.travis.yml .travis.yml: delete x86_64 2020-11-04 12:11:13 +09:00
aclocal.m4
addr2line.c addr2line.c: support debuglink by build_id 2020-12-11 14:08:33 +09:00
addr2line.h
appveyor.yml Keep patched zlib files 2020-11-26 09:37:38 +09:00
array.c tuning trial: newobj with current ec 2020-12-07 08:28:36 +09:00
array.rb array.rb: Remove unnecessary phrase from rdoc 2020-11-12 16:59:59 +09:00
ast.c Unfreeze string-literal-only interpolated string-literal 2020-09-30 22:15:28 +09:00
ast.rb
bignum.c bignum.c (bary_sparse_p): do not comsume Random::DEFAULT 2020-10-12 13:45:32 +09:00
BSDL
builtin.c
builtin.h
class.c Prefer rb_module_new() over rb_define_module_id() 2020-11-25 17:05:06 -05:00
common.mk Update dependencies 2020-12-14 17:56:42 -05:00
compar.c Don't redefine #rb_intern over and over again 2020-10-21 12:45:18 +09:00
compile.c Skip defined check in NODE_OP_ASGN_OR with ivar 2020-12-14 19:38:59 -08:00
complex.c Removed canonicalization for mathn 2020-11-10 11:14:15 +09:00
configure.ac Removed obsolete autoconf checks 2020-12-12 17:23:44 +09:00
constant.h
cont.c Let Fiber#raise work with transferring fibers 2020-12-12 10:18:19 +13:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c show ractor info on non-single ractor mode 2020-12-07 08:28:36 +09:00
debug_counter.c
debug_counter.h fix condition and add another debug counter 2020-12-14 18:38:40 +09:00
dir.c Revert "Removed deprecated Dir.exists? and File.exists?" 2020-12-02 19:11:01 +09:00
dir.rb [DOC] more precise description of "**" in Dir.glob pattern [ci skip] 2020-10-27 08:55:10 +09:00
dln.c
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c Set default for Encoding.default_external to UTF-8 on Windows (#2877) 2020-12-08 01:48:37 +09:00
enum.c Removed canonicalization for mathn 2020-11-10 11:14:15 +09:00
enumerator.c Fix ArithmeticSequence#last and ArithmeticSequence#each for non-integer sequences (#3870) 2020-12-09 18:48:59 +09:00
error.c Help RDoc find Exception [ci skip] 2020-12-14 20:01:01 -05:00
eval.c Remove obsoleted internal/mjit.h inclusion 2020-11-22 20:28:34 -08:00
eval_error.c
eval_intern.h Threads in a ractor will be killed with the ractor 2020-11-11 15:49:02 +09:00
eval_jump.c
file.c Revert "Removed deprecated Dir.exists? and File.exists?" 2020-12-02 19:11:01 +09:00
gc.c revert da3bca513f 2020-12-11 09:54:34 +09:00
gc.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
gc.rb Disable auto compaction on platforms that can't support it 2020-11-25 11:29:14 -08:00
gem_prelude.rb Removed needless .rb 2020-12-02 13:32:43 +09:00
golf_prelude.rb
goruby.c
GPL
hash.c Windows: Read ENV names and values as UTF-8 encoded Strings (#3818) 2020-12-08 02:00:39 +09:00
hrtime.h
id_table.c
id_table.h
inits.c Buffer protocol proposal (#3261) 2020-09-25 20:32:02 +09:00
insns.def Unfortunately getinstancevariable was still not leaf 2020-12-10 14:40:29 -08:00
integer.rb Move docs for Integer#bit_length [ci skip] 2020-12-14 20:01:55 -05:00
internal.h
io.c Tweaked Process::Status.wait 2020-12-09 11:51:57 +09:00
io.rb
iseq.c Make RubyVM::InstructionSequence.compile_file use same encoding as load 2020-11-19 07:12:50 +09:00
iseq.h check isolated Proc more strictly 2020-10-29 23:42:55 +09:00
kernel.rb
KNOWNBUGS.rb Remove known use-after-poison bug 2020-10-03 00:45:06 +09:00
LEGAL
lex.c.blt
load.c Suppress a "clobbered" warning by gcc on macOS 2020-12-11 01:17:15 +09:00
loadpath.c
localeinit.c
main.c
marshal.c Don't redefine #rb_intern over and over again 2020-10-21 12:45:18 +09:00
math.c
memory_view.c memory_view.c: Add rb_memory_view_get_item and rb_memory_view_prepare_item_desc (#3871) 2020-12-10 00:24:36 +09:00
method.h prohibi method call by defined_method in other racotrs 2020-09-25 20:37:38 +09:00
mini_builtin.c
miniinit.c
mjit.c Assert unit->iseq null out happens under the JIT/GC guard 2020-12-03 00:01:11 -08:00
mjit.h ruby/internal/config.h needs to be included first 2020-11-22 21:02:01 -08:00
mjit_compile.c Cache access to reg_cfp->self on JIT 2020-11-27 00:42:42 -08:00
mjit_worker.c Lock GC while searching the best iseq 2020-12-11 19:58:59 -08:00
NEWS.md NEWS: make links to label [ci skip] 2020-12-15 08:41:21 +09:00
node.c Change NODE layout for pattern matching 2020-11-01 16:19:07 +09:00
node.h Change NODE layout for pattern matching 2020-11-01 16:19:07 +09:00
numeric.c Move docs for Integer#bit_length [ci skip] 2020-12-14 20:01:55 -05:00
object.c Protoized old pre-ANSI K&R style definitions 2020-12-05 14:57:31 +09:00
pack.c
pack.rb [DOC] Fixed a typo [ci skip] 2020-11-16 22:14:59 +09:00
parse.y Support shareable_constant_value: literal 2020-12-14 19:19:16 +09:00
prelude.rb Thread.exclusive: delete 2020-08-31 18:08:57 +09:00
probes.d
probes_helper.h
proc.c fix lambda's warning and tests 2020-12-12 06:29:11 +09:00
process.c [DOC] Process::Status.wait return nil if no child processes [ci skip] 2020-12-12 11:44:25 +09:00
ractor.c Fixed a suspicious comparison 2020-12-13 13:12:18 +09:00
ractor.rb Call FrozenCore.make_shareable 2020-12-14 19:19:16 +09:00
ractor_core.h revert da3bca513f 2020-12-11 09:54:34 +09:00
random.c Deprecate Random::DEFAULT 2020-12-14 20:29:50 +01:00
range.c Use public allocators for creating new T_OBJECT objects 2020-10-28 18:35:22 -07:00
rational.c Fix ArithmeticSequence#last and ArithmeticSequence#each for non-integer sequences (#3870) 2020-12-09 18:48:59 +09:00
re.c [Feature #17136] Remove special behavior from $KCODE 2020-11-28 18:51:36 +09:00
README.EXT
README.EXT.ja
README.ja.md
README.md
regcomp.c Right size literal regular expression buffers on compile 2020-12-10 18:15:26 +09:00
regenc.c
regenc.h
regerror.c
regexec.c
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 Make ruby -We the same as ruby -W -e 2020-12-10 10:16:40 -08:00
ruby_assert.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
ruby_atomic.h fix typo [Bug #17194] 2020-09-26 18:24:28 +09:00
rubystub.c
scheduler.c Add support for non-blocking Process.wait. 2020-12-09 08:55:35 +13:00
signal.c Signal handler type should be void 2020-12-12 17:02:42 +09:00
siphash.c
siphash.h
sparc.c
sprintf.c sprintf.c: Removed conflicting definition 2020-09-28 12:51:53 +09:00
st.c [DOC] Fixed st_udpate comment [ci skip] 2020-11-30 12:18:21 +09:00
strftime.c
string.c tuning trial: newobj with current ec 2020-12-07 08:28:36 +09:00
struct.c
symbol.c sync ruby_global_symbols 2020-09-18 14:17:49 +09:00
symbol.h include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
thread.c Introduce negative method cache 2020-12-14 11:57:46 +09:00
thread_pthread.c introduce USE_VM_CLOCK for windows. 2020-11-11 15:49:02 +09:00
thread_pthread.h fix public interface 2020-11-18 03:52:41 +09:00
thread_sync.c Proposed method for dealing with stack locals which have non-local lifetime. 2020-12-05 11:38:56 +13:00
thread_win32.c fix public interface 2020-11-18 03:52:41 +09:00
thread_win32.h fix public interface 2020-11-18 03:52:41 +09:00
time.c Removed deprecated Time#succ 2020-12-07 18:38:59 +09:00
timev.h
trace_point.rb
transcode.c Update documentation for String#encode{,!} [ci skip] 2020-12-03 12:47:34 -08: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
variable.c fix ivar with shareable objects issue 2020-12-12 06:19:18 +09:00
variable.h fix ivar with shareable objects issue 2020-12-12 06:19:18 +09:00
version.c
version.h * 2020-12-15 [ci skip] 2020-12-15 00:05:38 +09:00
vm.c Support shareable_constant_value: literal 2020-12-14 19:19:16 +09:00
vm_args.c
vm_backtrace.c Ignore <internal: entries from core library methods for Kernel#warn(message, uplevel: n) 2020-10-26 08:47:33 +01:00
vm_callinfo.h mutete -> mutate 2020-10-22 18:20:35 -04:00
vm_core.h Introduce negative method cache 2020-12-14 11:57:46 +09:00
vm_debug.h
vm_dump.c Allow an MJIT worker to show a backtrace on SEGV 2020-12-10 21:56:49 -08:00
vm_eval.c use method cache on Object#respond_to? 2020-12-14 15:28:09 +09:00
vm_exec.c
vm_exec.h
vm_insnhelper.c fix condition and add another debug counter 2020-12-14 18:38:40 +09:00
vm_insnhelper.h Functions defined in headers should be static inline 2020-11-15 09:59:29 +09:00
vm_method.c add ccs_not_found debug counter 2020-12-14 18:17:35 +09:00
vm_opts.h
vm_sync.c re-layout rb_ractor_t 2020-12-09 01:40:38 +09:00
vm_sync.h RB_VM_LOCK_ENTER_NO_BARRIER 2020-12-07 11:27:25 +09:00
vm_trace.c Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
vsnprintf.c
warning.rb [DOC] mentioned category option 2020-12-08 22:13:04 +09:00

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