1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Change heap init environment variable names

Browse Source 
This commit changes RUBY_GC_HEAP_INIT_SIZE_{40,80,160,320,640}_SLOTS to
RUBY_GC_HEAP_{0,1,2,3,4}_INIT_SLOTS. This is easier to use because the
user does not need to determine the slot sizes (which can vary between
32 and 64 bit systems). They now just use the heap names
(`GC.stat_heap.keys`).
This commit is contained in:
Peter Zhu 2023-08-30 16:49:32 -04:00
parent 4aa98b2760
commit 0aa404b957
Notes: git 2023-08-30 23:37:31 +00:00 
Merged: https://github.com/ruby/ruby/pull/8335
5 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
NEWS.md
View File

@ -13,7 +13,7 @@ Note that each entry is kept to a minimum, see links for details.
They are not displayed by default even in verbose mode. They are not displayed by default even in verbose mode.
Turn them on with `-W:performance` or `Warning[:performance] = true`. [[Feature #19538]] Turn them on with `-W:performance` or `Warning[:performance] = true`. [[Feature #19538]]
* The `RUBY_GC_HEAP_INIT_SLOTS` environment variable has been deprecated and * The `RUBY_GC_HEAP_INIT_SLOTS` environment variable has been deprecated and
removed. Environment variables `RUBY_GC_HEAP_INIT_SIZE_%d_SLOTS` should be removed. Environment variables `RUBY_GC_HEAP_%d_INIT_SLOTS` should be
used instead. [[Feature #19785]] used instead. [[Feature #19785]]
## Core classes updates ## Core classes updates

4
gc.c
View File

@ -11633,8 +11633,8 @@ gc_set_initial_pages(rb_objspace_t *objspace)
for (int i = 0; i < SIZE_POOL_COUNT; i++) { for (int i = 0; i < SIZE_POOL_COUNT; i++) {
rb_size_pool_t *size_pool = &size_pools[i]; rb_size_pool_t *size_pool = &size_pools[i];
char env_key[sizeof("RUBY_GC_HEAP_INIT_SIZE_" "_SLOTS") + DECIMAL_SIZE_OF_BITS(sizeof(size_pool->slot_size) * CHAR_BIT)]; char env_key[sizeof("RUBY_GC_HEAP_" "_INIT_SLOTS") + DECIMAL_SIZE_OF_BITS(sizeof(int) * CHAR_BIT)];
snprintf(env_key, sizeof(env_key), "RUBY_GC_HEAP_INIT_SIZE_%d_SLOTS", size_pool->slot_size); snprintf(env_key, sizeof(env_key), "RUBY_GC_HEAP_%d_INIT_SLOTS", i);
size_t size_pool_init_slots = gc_params.size_pool_init_slots[i]; size_t size_pool_init_slots = gc_params.size_pool_init_slots[i];
if (get_envparam_size(env_key, &size_pool_init_slots, 0)) { if (get_envparam_size(env_key, &size_pool_init_slots, 0)) {

6
man/ruby.1
View File

@ -557,9 +557,9 @@ the following 11 environment variables:
.It Ev RUBY_GC_HEAP_INIT_SLOTS .It Ev RUBY_GC_HEAP_INIT_SLOTS
Initial allocation slots. Applies to all slot sizes. Introduced in Ruby 2.1, default: 10000. Initial allocation slots. Applies to all slot sizes. Introduced in Ruby 2.1, default: 10000.
.Pp .Pp
.It Ev RUBY_GC_HEAP_INIT_SIZE_%d_SLOTS .It Ev RUBY_GC_HEAP_%d_INIT_SLOTS
Initial allocation of slots in a specific size pool. Initial allocation of slots in a specific heap.
The available size pools can be found in `GC.stat_heap`. The available heaps can be found in the keys of `GC.stat_heap`.
Introduced in Ruby 3.3. Introduced in Ruby 3.3.
.Pp .Pp
.It Ev RUBY_GC_HEAP_FREE_SLOTS .It Ev RUBY_GC_HEAP_FREE_SLOTS

2
ruby.c
View File

@ -1742,7 +1742,7 @@ ruby_opt_init(ruby_cmdline_options_t *opt)
* Remove this in Ruby 3.4. */ * Remove this in Ruby 3.4. */
if (getenv("RUBY_GC_HEAP_INIT_SLOTS")) { if (getenv("RUBY_GC_HEAP_INIT_SLOTS")) {
rb_warn_deprecated("The environment variable RUBY_GC_HEAP_INIT_SLOTS", rb_warn_deprecated("The environment variable RUBY_GC_HEAP_INIT_SLOTS",
"environment variables RUBY_GC_HEAP_INIT_SIZE_%d_SLOTS"); "environment variables RUBY_GC_HEAP_%d_INIT_SLOTS");
} }
#if USE_RJIT #if USE_RJIT

14
test/ruby/test_gc.rb
View File

@ -377,17 +377,17 @@ class TestGc < Test::Unit::TestCase
} }
assert_in_out_err([env, "-W0", "-e", "exit"], "", [], []) assert_in_out_err([env, "-W0", "-e", "exit"], "", [], [])
assert_in_out_err([env, "-W:deprecated", "-e", "exit"], "", [], assert_in_out_err([env, "-W:deprecated", "-e", "exit"], "", [],
/The environment variable RUBY_GC_HEAP_INIT_SLOTS is deprecated; use environment variables RUBY_GC_HEAP_INIT_SIZE_%d_SLOTS instead/) /The environment variable RUBY_GC_HEAP_INIT_SLOTS is deprecated; use environment variables RUBY_GC_HEAP_%d_INIT_SLOTS instead/)
env = {} env = {}
GC.stat_heap.each do |_, s| GC.stat_heap.keys.each do |heap|
env["RUBY_GC_HEAP_INIT_SIZE_#{s[:slot_size]}_SLOTS"] = "200000" env["RUBY_GC_HEAP_#{heap}_INIT_SLOTS"] = "200000"
end end
assert_normal_exit("exit", "", :child_env => env) assert_normal_exit("exit", "", :child_env => env)
env = {} env = {}
GC.stat_heap.each do |_, s| GC.stat_heap.keys.each do |heap|
env["RUBY_GC_HEAP_INIT_SIZE_#{s[:slot_size]}_SLOTS"] = "0" env["RUBY_GC_HEAP_#{heap}_INIT_SLOTS"] = "0"
end end
assert_normal_exit("exit", "", :child_env => env) assert_normal_exit("exit", "", :child_env => env)
@ -456,8 +456,8 @@ class TestGc < Test::Unit::TestCase
env = {} env = {}
# Make the heap big enough to ensure the heap never needs to grow. # Make the heap big enough to ensure the heap never needs to grow.
sizes = GC.stat_heap.keys.reverse.map { |i| (i + 1) * 100_000 } sizes = GC.stat_heap.keys.reverse.map { |i| (i + 1) * 100_000 }
GC.stat_heap.each do |i, s| GC.stat_heap.keys.each do |heap|
env["RUBY_GC_HEAP_INIT_SIZE_#{s[:slot_size]}_SLOTS"] = sizes[i].to_s env["RUBY_GC_HEAP_#{heap}_INIT_SLOTS"] = sizes[heap].to_s
end end
assert_separately([env, "-W0"], __FILE__, __LINE__, <<~RUBY) assert_separately([env, "-W0"], __FILE__, __LINE__, <<~RUBY)
SIZES = #{sizes} SIZES = #{sizes}