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 a55abcc0ca zlib: reduce garbage on gzip writes (deflate)
Zlib::GzipWriter generated large amounts of garbage from
(struct zstream).input.  Reuse the .input field when it is
hidden, and recycle it when its lifetime is over.  This change
alone reduced memory usage of the writer from 90MB to 4.5MB.

For the detached buffer of compressed data used by
gzfile_write_raw, we can only clear the string (not recycle it)
since user code may hold references to it (but the data would be
clobbered, anyways).  This reduced memory usage slightly by
around 0.5MB (because it's smaller compressed data).

Combined, these changes reduce the anonymous RSS memory of a
dedicated writer process from over 90MB to under 4MB.

before:

    #      user     system      total        real

    writer   7.823332   0.053333   7.876665 (  7.881464)
    writer RssAnon:    92944 kB
    reader   6.969999   0.076666   7.046665 (  7.906377)
    reader RssAnon:   109820 kB

after:

    writer   7.359999   0.000000   7.359999 (  7.360639)
    writer RssAnon:     4040 kB
    reader   6.346667   0.070000   6.416667 (  7.387654)
    reader RssAnon:    98272 kB

Script used:
-------
require 'zlib'
require 'benchmark'
nr = 16384 * 2

def stats(pfx, bm)
  str = "#{bm}#{File.readlines("/proc/#$$/status").grep(/^RssAnon:/)[0]}"
  puts str.gsub!(/^/m, pfx)
end

rd, wr = IO.pipe
pid = fork do
  buf = ((0..255).map(&:chr).join * 128).freeze
  rd.close
  gzip = Zlib::GzipWriter.new(wr)
  bm = Benchmark.measure do
    nr.times { gzip.write(buf) }
    gzip.close
    wr.close
  end
  stats('writer ', bm)
end

wr.close
buf = ''
gunzip = Zlib::GzipReader.new(rd)
n = 0
bm = Benchmark.measure do
  begin
    gunzip.readpartial(16384, buf)
    n += buf.size
  rescue EOFError
    break
  end while true
end
stats('reader ', bm)
Process.waitall
-------
* ext/zlib/zlib.c (zstream_discard_input): reuse or recycle hidden input
  (zstream_reset_input): clear hidden input
  (zstream_run): detach input and recycle after use
  (gzfile_write_raw): clear buffer after write
  [ruby-core:84638] [Feature #14315]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@61631 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-01-05 20:48:55 +00:00
basictest
benchmark Lazy Proc allocation for block parameters 2017-10-24 11:13:49 +00:00
bin Postponing the Bundler merge. 2017-12-22 23:08:05 +00:00
bootstraptest $SAFE as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
ccan
coverage
cygwin
defs Postponing the Bundler merge. 2017-12-22 23:08:05 +00:00
doc [DOC] doc/NEWS-2.5.0: remove trailing comma [ci skip] 2018-01-01 00:13:54 +00:00
enc gperf.sed: static declarations 2017-12-15 14:42:43 +00:00
ext zlib: reduce garbage on gzip writes (deflate) 2018-01-05 20:48:55 +00:00
gems * gems/bundled_gems: Upgrade the did_you_mean gem to 1.2.0 2017-12-14 02:29:01 +00:00
include statement experssion is a GCCism 2018-01-02 06:41:53 +00:00
lib net/protocol: optimize large read case 2018-01-05 02:22:23 +00:00
man erb.1: add missing option in detailed description 2017-10-21 16:01:48 +00:00
misc ruby-additional.el: shorten here-doc markers 2017-10-02 04:06:55 +00:00
missing Support C89 if possible 2017-12-18 16:17:17 +00:00
sample Remove unnecessary require 'thread' 2017-10-08 07:00:01 +00:00
spec $SAFE as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
template make rb_iseq_new* accept rb_ast_body_t instead of NODE* 2018-01-05 08:59:22 +00:00
test Extend timeout of test_clear_unreachable_keyword_args 2018-01-05 20:38:02 +00:00
tool tool/rbinstall.rb: allow owner to have write permissions 2018-01-05 09:41:21 +00:00
win32 set ino at File.lstat on Windows 2017-12-12 15:02:51 +00:00
.document Exclude Changelog files from documentation. 2017-09-01 03:34:18 +00:00
.editorconfig Add *.gemspec to .editorconfig [ci skip] 2017-09-12 11:15:27 +00:00
.gdbinit .gdbinit: fix print_pathobj 2017-11-18 06:24:52 +00:00
.gitattributes rename ruby-runner as bin/ruby 2017-09-15 17:42:00 +00:00
.gitignore .gitignore: ignore dlntest.dll 2017-11-12 15:25:56 +00:00
.indent.pro
.travis.yml Try to fix Travis CI configuration. 2018-01-05 06:18:57 +00:00
acinclude.m4
aclocal.m4 configure.ac 2017-09-29 13:21:17 +00:00
addr2line.c Support C89 if possible 2017-12-18 16:17:17 +00:00
addr2line.h
appveyor.yml Remove DevKit path, change zlib link 2017-09-27 21:55:32 +00:00
array.c fix memory leak (FOUND BY A COMPILER WARNING) 2018-01-02 06:41:57 +00:00
bignum.c numeric.c: Fix Integer#pow with a large Fixnum modulo 2017-12-30 14:50:15 +00:00
BSDL
class.c non-keywords hash 2017-08-20 06:08:25 +00:00
common.mk Postponing the Bundler merge. 2017-12-22 23:08:05 +00:00
compar.c
compile.c compile.c: fix stack consistency error 2018-01-05 14:23:23 +00:00
complex.c complex.c: doc fix 2017-10-29 20:50:55 +00:00
configure.ac fix fd mask detection on os x 2017-12-27 14:07:49 +00:00
constant.h
cont.c explicit cast to void* required for %p 2018-01-02 06:41:40 +00:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c debug.c: include RIMemo in ruby_dummy_gdb_enums 2017-11-23 03:14:12 +00:00
debug_counter.c
debug_counter.h
dir.c support 128bit ino on Windows (if available) 2017-12-10 17:26:58 +00:00
dln.c dln.c: dln_incompatible_library_p 2018-01-03 09:19:11 +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 encoding.c: rb_enc_find_index2 2017-12-22 01:03:17 +00:00
enum.c enum.c: improve docs for Enumerable#{any?,all?,none?,one?} 2017-12-14 10:21:56 +00:00
enumerator.c Get rid of shadowing local variables 2017-10-18 04:35:25 +00:00
error.c error.c: limit depth 2017-12-31 13:15:52 +00:00
eval.c $SAFE as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
eval_error.c fix uninitialized variable 2018-01-02 06:42:03 +00:00
eval_intern.h eval_intern.h: fix a typo 2017-12-06 22:43:54 +00:00
eval_jump.c $SAFE as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
file.c [DOC] Fix indent [ci skip] 2017-12-22 03:35:52 +00:00
gc.c check an existence of block. 2018-01-02 15:29:58 +00:00
gc.h remove rb_threadptr_during_gc(). 2017-10-29 13:51:37 +00:00
gem_prelude.rb
golf_prelude.rb Use %i-literal instead of array of symbols 2017-09-07 12:31:50 +00:00
goruby.c
GPL
hash.c hash literal deduplicates like Hash#[]= 2017-12-30 00:00:23 +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 Speedup Proc#call [Feature #14318] 2018-01-05 17:51:10 +00:00
internal.h marshal.c: allow marshalling keyword_init struct 2018-01-05 11:44:31 +00:00
io.c [DOC] Improve example of IO#pread [ci skip] 2017-12-24 02:41:00 +00:00
iseq.c node.h: remove NODE_PRELUDE 2018-01-05 08:59:23 +00:00
iseq.h iseq.c: Refactor out rb_iseq_new_ifunc from rb_iseq_new_with_opt 2018-01-04 07:07:49 +00:00
KNOWNBUGS.rb gc.c: expand sorted pages 2017-06-22 00:59:54 +00:00
LEGAL Postponing the Bundler merge. 2017-12-22 23:08:05 +00:00
lex.c.blt gperf.sed: static declarations 2017-12-15 14:42:43 +00:00
load.c make rb_iseq_new* accept rb_ast_body_t instead of NODE* 2018-01-05 08:59:22 +00:00
loadpath.c suppress warnings for long string literals 2018-01-04 07:51:19 +00:00
localeinit.c debug.c: parse locale and filesystem codepages 2017-06-06 03:45:02 +00:00
main.c main.c: RUBY_DEBUG_ENV in devel 2017-06-30 04:19:12 +00:00
Makefile.in support gperf 3.1 2017-12-08 05:51:19 +00:00
marshal.c marshal.c: allow marshalling keyword_init struct 2018-01-05 11:44:31 +00:00
math.c
method.h bit-fields other than int is a C99ism 2018-01-02 06:41:50 +00:00
miniinit.c
NEWS $SAFE as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
node.c node.c: factor out the part of operator output into F_OPERATOR 2018-01-05 11:39:27 +00:00
node.h node_h (NEW_DEFN): remove unused argument 2018-01-05 15:16:42 +00:00
numeric.c Integer#{any|all|no}_bits: Fix coercion. Add specs [#12753] 2017-12-17 18:19:41 +00:00
object.c Add FrozenError as a subclass of RuntimeError 2017-12-12 00:46:34 +00:00
pack.c Workaround for optimization bug of Oracle Developer Studio 12.4-12.6 2017-12-19 16:55:08 +00:00
parse.y parse.y: Use nd_set_loc instead of direct modification to nd_loc 2018-01-05 16:04:02 +00:00
prelude.rb prelude.rb: block passing 2017-12-25 03:25:45 +00:00
probes.d
probes_helper.h th->ec: dtrace 2017-11-07 08:19:25 +00:00
proc.c explicit cast to void* required for %p 2018-01-02 06:41:40 +00:00
process.c process.c: [DOC] fix grammar and double negative 2017-12-14 10:24:38 +00:00
random.c random.c: make sure that Random.urandom returns required-length buffer 2017-12-16 00:39:34 +00:00
range.c range.c: use rb_check_funcall 2017-10-25 05:23:54 +00:00
rational.c freeze Complex and Rational 2017-10-19 10:58:08 +00:00
re.c ULL suffix is a C99ism 2018-01-04 07:51:16 +00:00
README.EXT
README.EXT.ja
README.ja.md configure.ac 2017-09-29 13:21:17 +00:00
README.md Modify git clone command 2017-12-13 02:43:38 +00:00
regcomp.c
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 Update to Onigmo 6.1.3-669ac9997619954c298da971fcfacccf36909d05. 2017-12-01 13:50:13 +00:00
regparse.h
regsyntax.c
ruby-runner.c ruby-runner.c: RUBYLIB 2017-09-24 01:48:25 +00:00
ruby.c make rb_iseq_new* accept rb_ast_body_t instead of NODE* 2018-01-05 08:59:22 +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 remove PUSH_TAG/EXEC_AG/POP_TAG/JUMO_TAG. 2017-12-06 03:16:08 +00:00
siphash.c
siphash.h
sparc.c configure.ac 2017-09-29 13:21:17 +00:00
sprintf.c error.c: KeyError#receiver and KeyError#key 2017-09-18 08:05:53 +00:00
st.c hash literal deduplicates like Hash#[]= 2017-12-30 00:00:23 +00:00
strftime.c
string.c ULL suffix is a C99ism 2018-01-04 07:51:17 +00:00
struct.c marshal.c: allow marshalling keyword_init struct 2018-01-05 11:44:31 +00:00
symbol.c common conversion functions 2017-10-26 07:23:23 +00:00
symbol.h
thread.c explicit cast to void* required for %p 2018-01-02 06:41:40 +00:00
thread_pthread.c thread_pthread.c: use container_of 2018-01-02 21:23:47 +00:00
thread_pthread.h
thread_sync.c thread_sync.c: fix rdoc 2017-12-19 10:46:51 +00:00
thread_win32.c thread_win32.c: stop returning unused value 2017-11-16 10:02:03 +00:00
thread_win32.h
time.c bit-fields other than int is a C99ism 2018-01-02 06:41:50 +00:00
timev.h bit-fields other than int is a C99ism 2018-01-02 06:41:50 +00:00
transcode.c $SAFE as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
transcode_data.h
util.c define NO_LONG_LONG appropriately 2018-01-04 07:51:18 +00:00
variable.c variable.c: fix autoload stack space regression 2018-01-02 21:51:59 +00:00
version.c
version.h * 2018-01-06 2018-01-05 15:16:43 +00:00
vm.c node.h: remove NODE_PRELUDE 2018-01-05 08:59:23 +00:00
vm_args.c vm_args.c: ec arg of args_setup_kw_parameters 2017-11-21 11:15:51 +00:00
vm_backtrace.c remove PUSH_TAG/EXEC_AG/POP_TAG/JUMO_TAG. 2017-12-06 03:16:08 +00:00
vm_core.h make rb_iseq_new* accept rb_ast_body_t instead of NODE* 2018-01-05 08:59:22 +00:00
vm_debug.h
vm_dump.c delete extra #undef [ci skip] 2018-01-03 01:43:17 +00:00
vm_eval.c make rb_iseq_new* accept rb_ast_body_t instead of NODE* 2018-01-05 08:59:22 +00:00
vm_exec.c catch up recent changes for call threaded code VM. 2017-10-27 19:16:51 +00:00
vm_exec.h label as lvalue is a GCCism 2018-01-02 06:41:54 +00:00
vm_insnhelper.c Speedup Proc#call [Feature #14318] 2018-01-05 17:51:10 +00:00
vm_insnhelper.h comma at the end of enum is a C99ism 2018-01-02 06:41:46 +00:00
vm_method.c explicit cast to void* required for %p 2018-01-02 06:41:40 +00:00
vm_opts.h Remove "trace_instruction" compile option. 2017-12-24 17:07:53 +00:00
vm_trace.c do not disable trace_ prefix insns. 2017-12-11 19:17:25 +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://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