Add vm barrier to ObjectSpace.{dump,dump_all}

Author: luke-gruber

ext/objspace/objspace_dump.c

@@ -30,6 +30,7 @@
 #include "ruby/io.h"
 #include "vm_callinfo.h"
 #include "vm_core.h"
+#include "vm_sync.h"
 
 RUBY_EXTERN const char ruby_hexdigits[];
 
@@ -776,15 +777,23 @@ static VALUE
 objspace_dump(VALUE os, VALUE obj, VALUE output)
 {
     struct dump_config dc = {0,};
-    if (!RB_SPECIAL_CONST_P(obj)) {
-        dc.cur_page_slot_size = rb_gc_obj_slot_size(obj);
-    }
+    VALUE result = Qnil;
+    RB_VM_LOCK_LOCK();
+    {
+        rb_vm_barrier();
+
+        if (!RB_SPECIAL_CONST_P(obj)) {
+            dc.cur_page_slot_size = rb_gc_obj_slot_size(obj);
+        }
 
-    dump_output(&dc, output, Qnil, Qnil, Qnil);
+        dump_output(&dc, output, Qnil, Qnil, Qnil);
 
-    dump_object(obj, &dc);
+        dump_object(obj, &dc);
 
-    return dump_result(&dc);
+        result = dump_result(&dc);
+    }
+    RB_VM_LOCK_UNLOCK();
+    return result;
 }
 
 static void
@@ -840,22 +849,30 @@ static VALUE
 objspace_dump_all(VALUE os, VALUE output, VALUE full, VALUE since, VALUE shapes)
 {
     struct dump_config dc = {0,};
-    dump_output(&dc, output, full, since, shapes);
+    VALUE result = Qnil;
+    RB_VM_LOCK_LOCK();
+    {
+        rb_vm_barrier();
 
-    if (!dc.partial_dump || dc.since == 0) {
-        /* dump roots */
-        rb_objspace_reachable_objects_from_root(root_obj_i, &dc);
-        if (dc.roots) dump_append(&dc, "]}\n");
-    }
+        dump_output(&dc, output, full, since, shapes);
 
-    if (RTEST(shapes)) {
-        rb_shape_each_shape_id(shape_id_i, &dc);
-    }
+        if (!dc.partial_dump || dc.since == 0) {
+            /* dump roots */
+            rb_objspace_reachable_objects_from_root(root_obj_i, &dc);
+            if (dc.roots) dump_append(&dc, "]}\n");
+        }
 
-    /* dump all objects */
-    rb_objspace_each_objects(heap_i, &dc);
+        if (RTEST(shapes)) {
+            rb_shape_each_shape_id(shape_id_i, &dc);
+        }
 
-    return dump_result(&dc);
+        /* dump all objects */
+        rb_objspace_each_objects(heap_i, &dc);
+
+        result = dump_result(&dc);
+    }
+    RB_VM_LOCK_UNLOCK();
+    return result;
 }
 
 /* :nodoc: */
@@ -866,14 +883,17 @@ objspace_dump_shapes(VALUE os, VALUE output, VALUE shapes)
     dump_output(&dc, output, Qfalse, Qnil, shapes);
 
     if (RTEST(shapes)) {
-        rb_shape_each_shape_id(shape_id_i, &dc);
+        rb_shape_each_shape_id(shape_id_i, &dc); // takes a barrier
     }
     return dump_result(&dc);
 }
 
 void
 Init_objspace_dump(VALUE rb_mObjSpace)
 {
+#ifdef HAVE_RB_EXT_RACTOR_SAFE
+    rb_ext_ractor_safe(true);
+#endif
 #undef rb_intern
 #if 0
     rb_mObjSpace = rb_define_module("ObjectSpace"); /* let rdoc know */

vm_sync.c

@@ -291,3 +291,17 @@ rb_ec_vm_lock_rec_release(const rb_execution_context_t *ec,
 
     VM_ASSERT(recorded_lock_rec == rb_ec_vm_lock_rec(ec));
 }
+
+// For extensions, to be used like: RB_VM_LOCK_LOCK()
+void
+rb_vm_lock_lock(const char *file, int line)
+{
+    rb_vm_lock(file, line);
+}
+
+
+// for extensions, to be used like: RB_VM_LOCK_UNLOCK()
+void rb_vm_lock_unlock(const char *file, int line)
+{
+    rb_vm_unlock(file, line);
+}

vm_sync.h

@@ -26,7 +26,15 @@ NOINLINE(void rb_vm_lock_enter_body_nb(unsigned int *lev APPEND_LOCATION_ARGS));
 NOINLINE(void rb_vm_lock_enter_body(unsigned int *lev APPEND_LOCATION_ARGS));
 void rb_vm_lock_leave_body_nb(unsigned int *lev APPEND_LOCATION_ARGS);
 void rb_vm_lock_leave_body(unsigned int *lev APPEND_LOCATION_ARGS);
-void rb_vm_barrier(void);
+
+// `objspace_dump.c` extension needs these
+RUBY_SYMBOL_EXPORT_BEGIN
+NOINLINE(void rb_vm_barrier(void));
+NOINLINE(void rb_vm_lock_lock(const char *file, int line));
+NOINLINE(void rb_vm_lock_unlock(const char *file, int line));
+RUBY_SYMBOL_EXPORT_END
+#define RB_VM_LOCK_LOCK() rb_vm_lock_lock(__FILE__, __LINE__)
+#define RB_VM_LOCK_UNLOCK() rb_vm_lock_unlock(__FILE__, __LINE__)
 
 #if RUBY_DEBUG
 // GET_VM()