class.c: descendants must not cause GC until the result array is created

Follow up of 428227472f. The previous fix
uses `rb_ary_new_from_values` to create the result array, but it may
trigger the GC.

This second try is to create the result array by `rb_ary_new_capa`
before the second iteration, and assume that `rb_ary_push` does not
trigger GC. This assumption is very fragile, so should be improved in
future.

[Bug #18282] [Feature #14394]
This commit is contained in:
Yusuke Endoh 2021-11-09 17:06:01 +09:00
Родитель 0d3898ec7b
Коммит 5c892da7d7
2 изменённых файлов: 21 добавлений и 9 удалений

22
class.c
Просмотреть файл

@ -29,6 +29,7 @@
#include "internal/variable.h" #include "internal/variable.h"
#include "ruby/st.h" #include "ruby/st.h"
#include "vm_core.h" #include "vm_core.h"
#include "gc.h"
#define id_attached id__attached__ #define id_attached id__attached__
@ -1338,7 +1339,7 @@ rb_mod_ancestors(VALUE mod)
struct subclass_traverse_data struct subclass_traverse_data
{ {
VALUE *buffer; VALUE buffer;
long count; long count;
long maxcount; long maxcount;
}; };
@ -1349,8 +1350,9 @@ class_descendants_recursive(VALUE klass, VALUE v)
struct subclass_traverse_data *data = (struct subclass_traverse_data *) v; struct subclass_traverse_data *data = (struct subclass_traverse_data *) v;
if (BUILTIN_TYPE(klass) == T_CLASS && !FL_TEST(klass, FL_SINGLETON)) { if (BUILTIN_TYPE(klass) == T_CLASS && !FL_TEST(klass, FL_SINGLETON)) {
if (data->buffer && data->count < data->maxcount) { if (data->buffer && data->count < data->maxcount && !rb_objspace_garbage_object_p(klass)) {
data->buffer[data->count] = klass; // assumes that this does not cause GC as long as the length does not exceed the capacity
rb_ary_push(data->buffer, klass);
} }
data->count++; data->count++;
} }
@ -1378,24 +1380,26 @@ class_descendants_recursive(VALUE klass, VALUE v)
VALUE VALUE
rb_class_descendants(VALUE klass) rb_class_descendants(VALUE klass)
{ {
struct subclass_traverse_data data = { NULL, 0, -1 }; struct subclass_traverse_data data = { Qfalse, 0, -1 };
// estimate the count of subclasses // estimate the count of subclasses
rb_class_foreach_subclass(klass, class_descendants_recursive, (VALUE) &data); rb_class_foreach_subclass(klass, class_descendants_recursive, (VALUE) &data);
// the following allocation may cause GC which may change the number of subclasses // the following allocation may cause GC which may change the number of subclasses
data.buffer = ALLOC_N(VALUE, data.count); data.buffer = rb_ary_new_capa(data.count);
data.maxcount = data.count; data.maxcount = data.count;
data.count = 0; data.count = 0;
size_t gc_count = rb_gc_count();
// enumerate subclasses // enumerate subclasses
rb_class_foreach_subclass(klass, class_descendants_recursive, (VALUE) &data); rb_class_foreach_subclass(klass, class_descendants_recursive, (VALUE) &data);
VALUE ary = rb_ary_new_from_values(data.count, data.buffer); if (gc_count != rb_gc_count()) {
rb_bug("GC must not occur during the subclass iteration of Class#descendants");
}
free(data.buffer); return data.buffer;
return ary;
} }
static void static void

Просмотреть файл

@ -761,4 +761,12 @@ class TestClass < Test::Unit::TestCase
100000.times { Class.new(c) } 100000.times { Class.new(c) }
assert(c.descendants.size <= 100000) assert(c.descendants.size <= 100000)
end end
def test_descendants_gc_stress
10000.times do
c = Class.new
100.times { Class.new(c) }
assert(c.descendants.size <= 100)
end
end
end end