Change heap init environment variable names

peterzhu2118 · jhawthorn · commit 6bcec0279c90 · 2023-10-30T14:24:43.000-07:00
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`).
diff --git a/gc.c b/gc.c
@@ -11773,8 +11773,8 @@ gc_set_initial_pages(rb_objspace_t *objspace)
 
     for (int i = 0; i < SIZE_POOL_COUNT; 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)];
-        snprintf(env_key, sizeof(env_key), "RUBY_GC_HEAP_INIT_SIZE_%d_SLOTS", size_pool->slot_size);
+        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_%d_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)) {
diff --git a/man/ruby.1 b/man/ruby.1
@@ -552,9 +552,9 @@ the following 11 environment variables:
 .It Ev RUBY_GC_HEAP_INIT_SLOTS
 Initial allocation slots. Applies to all slot sizes.  Introduced in Ruby 2.1, default: 10000.
 .Pp
-.It Ev RUBY_GC_HEAP_INIT_SIZE_%d_SLOTS
-Initial allocation of slots in a specific size pool.
-The available size pools can be found in `GC.stat_heap`.
+.It Ev RUBY_GC_HEAP_%d_INIT_SLOTS
+Initial allocation of slots in a specific heap.
+The available heaps can be found in the keys of `GC.stat_heap`.
 Introduced in Ruby 3.3.
 .Pp
 .It Ev RUBY_GC_HEAP_FREE_SLOTS
diff --git a/test/ruby/test_gc.rb b/test/ruby/test_gc.rb
@@ -316,17 +316,17 @@ def test_gc_parameter
     assert_normal_exit("exit", "[ruby-core:39777]", :child_env => env)
 
     env = {}
-    GC.stat_heap.each do |_, s|
-      env["RUBY_GC_HEAP_INIT_SIZE_#{s[:slot_size]}_SLOTS"] = "200000"
+    GC.stat_heap.keys.each do |heap|
+      env["RUBY_GC_HEAP_#{heap}_INIT_SLOTS"] = "200000"
     end
     assert_normal_exit("exit", "", :child_env => env)
 
     env["RUBY_GC_HEAP_INIT_SLOTS"] = "100000"
     assert_normal_exit("exit", "", :child_env => env)
 
     env = {}
-    GC.stat_heap.each do |_, s|
-      env["RUBY_GC_HEAP_INIT_SIZE_#{s[:slot_size]}_SLOTS"] = "0"
+    GC.stat_heap.keys.each do |heap|
+      env["RUBY_GC_HEAP_#{heap}_INIT_SLOTS"] = "0"
     end
     assert_normal_exit("exit", "", :child_env => env)
 
@@ -398,8 +398,8 @@ def test_gc_parameter_init_slots
     env = {}
     # 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 }
-    GC.stat_heap.each do |i, s|
-      env["RUBY_GC_HEAP_INIT_SIZE_#{s[:slot_size]}_SLOTS"] = sizes[i].to_s
+    GC.stat_heap.keys.each do |heap|
+      env["RUBY_GC_HEAP_#{heap}_INIT_SLOTS"] = sizes[heap].to_s
     end
     assert_separately([env, "-W0", "--disable-gems"], __FILE__, __LINE__, <<~RUBY)
       SIZES = #{sizes}
