Ruby: gc.c Source File

Ruby 4.0.6p0 (2026-07-14 revision 03b6d3f8898a28604fe6cb00eae3226b821168f4)

gc.c
1/**********************************************************************
2
3 gc.c -
4
5 $Author$
6 created at: Tue Oct 5 09:44:46 JST 1993
7
8 Copyright (C) 1993-2007 Yukihiro Matsumoto
9 Copyright (C) 2000 Network Applied Communication Laboratory, Inc.
10 Copyright (C) 2000 Information-technology Promotion Agency, Japan
11
12**********************************************************************/
13
14#define rb_data_object_alloc rb_data_object_alloc
15#define rb_data_typed_object_alloc rb_data_typed_object_alloc
16
17#include "ruby/internal/config.h"
18#ifdef _WIN32
19# include "ruby/ruby.h"
20#endif
21
22#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
23# include "wasm/setjmp.h"
24# include "wasm/machine.h"
25#else
26# include <setjmp.h>
27#endif
28#include <stdarg.h>
29#include <stdio.h>
30
31/* MALLOC_HEADERS_BEGIN */
32#ifndef HAVE_MALLOC_USABLE_SIZE
33# ifdef _WIN32
34# define HAVE_MALLOC_USABLE_SIZE
35# define malloc_usable_size(a) _msize(a)
36# elif defined HAVE_MALLOC_SIZE
37# define HAVE_MALLOC_USABLE_SIZE
38# define malloc_usable_size(a) malloc_size(a)
39# endif
40#endif
41
42#ifdef HAVE_MALLOC_USABLE_SIZE
43# ifdef RUBY_ALTERNATIVE_MALLOC_HEADER
44/* Alternative malloc header is included in ruby/missing.h */
45# elif defined(HAVE_MALLOC_H)
46# include <malloc.h>
47# elif defined(HAVE_MALLOC_NP_H)
48# include <malloc_np.h>
49# elif defined(HAVE_MALLOC_MALLOC_H)
50# include <malloc/malloc.h>
51# endif
52#endif
53
54/* MALLOC_HEADERS_END */
55
56#ifdef HAVE_SYS_TIME_H
57# include <sys/time.h>
58#endif
59
60#ifdef HAVE_SYS_RESOURCE_H
61# include <sys/resource.h>
62#endif
63
64#if defined _WIN32 || defined __CYGWIN__
65# include <windows.h>
66#elif defined(HAVE_POSIX_MEMALIGN)
67#elif defined(HAVE_MEMALIGN)
68# include <malloc.h>
69#endif
70
71#include <sys/types.h>
72
73#ifdef __EMSCRIPTEN__
74#include <emscripten.h>
75#endif
76
77/* For ruby_annotate_mmap */
78#ifdef HAVE_SYS_PRCTL_H
79#include <sys/prctl.h>
80#endif
81
82#undef LIST_HEAD /* ccan/list conflicts with BSD-origin sys/queue.h. */
83
84#include "constant.h"
85#include "darray.h"
86#include "debug_counter.h"
87#include "eval_intern.h"
88#include "gc/gc.h"
89#include "id_table.h"
90#include "internal.h"
91#include "internal/class.h"
92#include "internal/compile.h"
93#include "internal/complex.h"
94#include "internal/concurrent_set.h"
95#include "internal/cont.h"
96#include "internal/error.h"
97#include "internal/eval.h"
98#include "internal/gc.h"
99#include "internal/hash.h"
100#include "internal/imemo.h"
101#include "internal/io.h"
102#include "internal/numeric.h"
103#include "internal/object.h"
104#include "internal/proc.h"
105#include "internal/rational.h"
106#include "internal/sanitizers.h"
107#include "internal/struct.h"
108#include "internal/symbol.h"
109#include "internal/thread.h"
110#include "internal/variable.h"
111#include "internal/warnings.h"
112#include "probes.h"
113#include "regint.h"
114#include "ruby/debug.h"
115#include "ruby/io.h"
116#include "ruby/re.h"
117#include "ruby/st.h"
118#include "ruby/thread.h"
119#include "ruby/util.h"
120#include "ruby/vm.h"
121#include "ruby_assert.h"
122#include "ruby_atomic.h"
123#include "symbol.h"
124#include "variable.h"
125#include "vm_core.h"
126#include "vm_sync.h"
127#include "vm_callinfo.h"
128#include "ractor_core.h"
129#include "yjit.h"
130#include "zjit.h"
131
132#include "builtin.h"
133#include "shape.h"
134
135unsigned int
136rb_gc_vm_lock(const char *file, int line)
137{
138 unsigned int lev = 0;
139 rb_vm_lock_enter(&lev, file, line);
140 return lev;
141}
142
143void
144rb_gc_vm_unlock(unsigned int lev, const char *file, int line)
145{
146 rb_vm_lock_leave(&lev, file, line);
147}
148
149unsigned int
150rb_gc_cr_lock(const char *file, int line)
151{
152 unsigned int lev;
153 rb_vm_lock_enter_cr(GET_RACTOR(), &lev, file, line);
154 return lev;
155}
156
157void
158rb_gc_cr_unlock(unsigned int lev, const char *file, int line)
159{
160 rb_vm_lock_leave_cr(GET_RACTOR(), &lev, file, line);
161}
162
163unsigned int
164rb_gc_vm_lock_no_barrier(const char *file, int line)
165{
166 unsigned int lev = 0;
167 rb_vm_lock_enter_nb(&lev, file, line);
168 return lev;
169}
170
171void
172rb_gc_vm_unlock_no_barrier(unsigned int lev, const char *file, int line)
173{
174 rb_vm_lock_leave_nb(&lev, file, line);
175}
176
177void
178rb_gc_vm_barrier(void)
179{
180 rb_vm_barrier();
181}
182
183void *
184rb_gc_get_ractor_newobj_cache(void)
185{
186 return GET_RACTOR()->newobj_cache;
187}
188
189#if USE_MODULAR_GC
190void
191rb_gc_initialize_vm_context(struct rb_gc_vm_context *context)
192{
193 rb_native_mutex_initialize(&context->lock);
194 context->ec = GET_EC();
195}
196
197void
198rb_gc_worker_thread_set_vm_context(struct rb_gc_vm_context *context)
199{
200 rb_native_mutex_lock(&context->lock);
201
202 GC_ASSERT(rb_current_execution_context(false) == NULL);
203
204#ifdef RB_THREAD_LOCAL_SPECIFIER
205 rb_current_ec_set(context->ec);
206#else
207 native_tls_set(ruby_current_ec_key, context->ec);
208#endif
209}
210
211void
212rb_gc_worker_thread_unset_vm_context(struct rb_gc_vm_context *context)
213{
214 rb_native_mutex_unlock(&context->lock);
215
216 GC_ASSERT(rb_current_execution_context(true) == context->ec);
217
218#ifdef RB_THREAD_LOCAL_SPECIFIER
219 rb_current_ec_set(NULL);
220#else
221 native_tls_set(ruby_current_ec_key, NULL);
222#endif
223}
224#endif
225
226bool
227rb_gc_event_hook_required_p(rb_event_flag_t event)
228{
229 return ruby_vm_event_flags & event;
230}
231
232void
233rb_gc_event_hook(VALUE obj, rb_event_flag_t event)
234{
235 if (LIKELY(!rb_gc_event_hook_required_p(event))) return;
236
237 rb_execution_context_t *ec = GET_EC();
238 if (!ec->cfp) return;
239
240 EXEC_EVENT_HOOK(ec, event, ec->cfp->self, 0, 0, 0, obj);
241}
242
243void *
244rb_gc_get_objspace(void)
245{
246 return GET_VM()->gc.objspace;
247}
248
249
250void
251rb_gc_ractor_newobj_cache_foreach(void (*func)(void *cache, void *data), void *data)
252{
253 rb_ractor_t *r = NULL;
254 if (RB_LIKELY(ruby_single_main_ractor)) {
255 GC_ASSERT(
256 ccan_list_empty(&GET_VM()->ractor.set) ||
257 (ccan_list_top(&GET_VM()->ractor.set, rb_ractor_t, vmlr_node) == ruby_single_main_ractor &&
258 ccan_list_tail(&GET_VM()->ractor.set, rb_ractor_t, vmlr_node) == ruby_single_main_ractor)
259 );
260
261 func(ruby_single_main_ractor->newobj_cache, data);
262 }
263 else {
264 ccan_list_for_each(&GET_VM()->ractor.set, r, vmlr_node) {
265 func(r->newobj_cache, data);
266 }
267 }
268}
269
270void
271rb_gc_run_obj_finalizer(VALUE objid, long count, VALUE (*callback)(long i, void *data), void *data)
272{
273 volatile struct {
274 VALUE errinfo;
275 VALUE final;
276 rb_control_frame_t *cfp;
277 VALUE *sp;
278 long finished;
279 } saved;
280
281 rb_execution_context_t * volatile ec = GET_EC();
282#define RESTORE_FINALIZER() (\
283 ec->cfp = saved.cfp, \
284 ec->cfp->sp = saved.sp, \
285 ec->errinfo = saved.errinfo)
286
287 saved.errinfo = ec->errinfo;
288 saved.cfp = ec->cfp;
289 saved.sp = ec->cfp->sp;
290 saved.finished = 0;
291 saved.final = Qundef;
292
293 ASSERT_vm_unlocking();
294 rb_ractor_ignore_belonging(true);
295 EC_PUSH_TAG(ec);
296 enum ruby_tag_type state = EC_EXEC_TAG();
297 if (state != TAG_NONE) {
298 ++saved.finished; /* skip failed finalizer */
299
300 VALUE failed_final = saved.final;
301 saved.final = Qundef;
302 if (!UNDEF_P(failed_final) && !NIL_P(ruby_verbose)) {
303 rb_warn("Exception in finalizer %+"PRIsVALUE, failed_final);
304 rb_ec_error_print(ec, ec->errinfo);
305 }
306 }
307
308 for (long i = saved.finished; RESTORE_FINALIZER(), i < count; saved.finished = ++i) {
309 saved.final = callback(i, data);
310 rb_check_funcall(saved.final, idCall, 1, &objid);
311 }
312 EC_POP_TAG();
313 rb_ractor_ignore_belonging(false);
314#undef RESTORE_FINALIZER
315}
316
317void
318rb_gc_set_pending_interrupt(void)
319{
320 rb_execution_context_t *ec = GET_EC();
321 ec->interrupt_mask |= PENDING_INTERRUPT_MASK;
322}
323
324void
325rb_gc_unset_pending_interrupt(void)
326{
327 rb_execution_context_t *ec = GET_EC();
328 ec->interrupt_mask &= ~PENDING_INTERRUPT_MASK;
329}
330
331bool
332rb_gc_multi_ractor_p(void)
333{
334 return rb_multi_ractor_p();
335}
336
337bool
338rb_gc_shutdown_call_finalizer_p(VALUE obj)
339{
340 switch (BUILTIN_TYPE(obj)) {
341 case T_DATA:
342 if (!ruby_free_at_exit_p() && (!DATA_PTR(obj) || !RDATA(obj)->dfree)) return false;
343 if (rb_obj_is_thread(obj)) return false;
344 if (rb_obj_is_mutex(obj)) return false;
345 if (rb_obj_is_fiber(obj)) return false;
346 if (rb_ractor_p(obj)) return false;
347 if (rb_obj_is_fstring_table(obj)) return false;
348 if (rb_obj_is_symbol_table(obj)) return false;
349
350 return true;
351
352 case T_FILE:
353 return true;
354
355 case T_SYMBOL:
356 return true;
357
358 case T_NONE:
359 return false;
360
361 default:
362 return ruby_free_at_exit_p();
363 }
364}
365
366uint32_t
367rb_gc_get_shape(VALUE obj)
368{
369 return (uint32_t)rb_obj_shape_id(obj);
370}
371
372void
373rb_gc_set_shape(VALUE obj, uint32_t shape_id)
374{
375 RBASIC_SET_SHAPE_ID(obj, (uint32_t)shape_id);
376}
377
378uint32_t
379rb_gc_rebuild_shape(VALUE obj, size_t heap_id)
380{
381 RUBY_ASSERT(RB_TYPE_P(obj, T_OBJECT));
382
383 return (uint32_t)rb_shape_transition_heap(obj, heap_id);
384}
385
386void rb_vm_update_references(void *ptr);
387
388#define rb_setjmp(env) RUBY_SETJMP(env)
389#define rb_jmp_buf rb_jmpbuf_t
390#undef rb_data_object_wrap
391
392#if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
393#define MAP_ANONYMOUS MAP_ANON
394#endif
395
396#define unless_objspace(objspace) \
397 void *objspace; \
398 rb_vm_t *unless_objspace_vm = GET_VM(); \
399 if (unless_objspace_vm) objspace = unless_objspace_vm->gc.objspace; \
400 else /* return; or objspace will be warned uninitialized */
401
402#define RMOVED(obj) ((struct RMoved *)(obj))
403
404#define TYPED_UPDATE_IF_MOVED(_objspace, _type, _thing) do { \
405 if (gc_object_moved_p_internal((_objspace), (VALUE)(_thing))) { \
406 *(_type *)&(_thing) = (_type)gc_location_internal(_objspace, (VALUE)_thing); \
407 } \
408} while (0)
409
410#define UPDATE_IF_MOVED(_objspace, _thing) TYPED_UPDATE_IF_MOVED(_objspace, VALUE, _thing)
411
412#if RUBY_MARK_FREE_DEBUG
413int ruby_gc_debug_indent = 0;
414#endif
415
416#ifndef RGENGC_OBJ_INFO
417# define RGENGC_OBJ_INFO RGENGC_CHECK_MODE
418#endif
419
420#ifndef CALC_EXACT_MALLOC_SIZE
421# define CALC_EXACT_MALLOC_SIZE 0
422#endif
423
424 VALUE rb_mGC;
425
426static size_t malloc_offset = 0;
427#if defined(HAVE_MALLOC_USABLE_SIZE)
428static size_t
429gc_compute_malloc_offset(void)
430{
431 // Different allocators use different metadata storage strategies which result in different
432 // ideal sizes.
433 // For instance malloc(64) will waste 8B with glibc, but waste 0B with jemalloc.
434 // But malloc(56) will waste 0B with glibc, but waste 8B with jemalloc.
435 // So we try allocating 64, 56 and 48 bytes and select the first offset that doesn't
436 // waste memory.
437 // This was tested on Linux with glibc 2.35 and jemalloc 5, and for both it result in
438 // no wasted memory.
439 size_t offset = 0;
440 for (offset = 0; offset <= 16; offset += 8) {
441 size_t allocated = (64 - offset);
442 void *test_ptr = malloc(allocated);
443 size_t wasted = malloc_usable_size(test_ptr) - allocated;
444 free(test_ptr);
445
446 if (wasted == 0) {
447 return offset;
448 }
449 }
450 return 0;
451}
452#else
453static size_t
454gc_compute_malloc_offset(void)
455{
456 // If we don't have malloc_usable_size, we use powers of 2.
457 return 0;
458}
459#endif
460
461size_t
462rb_malloc_grow_capa(size_t current, size_t type_size)
463{
464 size_t current_capacity = current;
465 if (current_capacity < 4) {
466 current_capacity = 4;
467 }
468 current_capacity *= type_size;
469
470 // We double the current capacity.
471 size_t new_capacity = (current_capacity * 2);
472
473 // And round up to the next power of 2 if it's not already one.
474 if (rb_popcount64(new_capacity) != 1) {
475 new_capacity = (size_t)(1 << (64 - nlz_int64(new_capacity)));
476 }
477
478 new_capacity -= malloc_offset;
479 new_capacity /= type_size;
480 if (current > new_capacity) {
481 rb_bug("rb_malloc_grow_capa: current_capacity=%zu, new_capacity=%zu, malloc_offset=%zu", current, new_capacity, malloc_offset);
482 }
483 RUBY_ASSERT(new_capacity > current);
484 return new_capacity;
485}
486
487static inline struct rbimpl_size_overflow_tag
488size_mul_add_overflow(size_t x, size_t y, size_t z) /* x * y + z */
489{
490 struct rbimpl_size_overflow_tag t = rbimpl_size_mul_overflow(x, y);
491 struct rbimpl_size_overflow_tag u = rbimpl_size_add_overflow(t.result, z);
492 return (struct rbimpl_size_overflow_tag) { t.overflowed || u.overflowed, u.result };
493}
494
495static inline struct rbimpl_size_overflow_tag
496size_mul_add_mul_overflow(size_t x, size_t y, size_t z, size_t w) /* x * y + z * w */
497{
498 struct rbimpl_size_overflow_tag t = rbimpl_size_mul_overflow(x, y);
499 struct rbimpl_size_overflow_tag u = rbimpl_size_mul_overflow(z, w);
500 struct rbimpl_size_overflow_tag v = rbimpl_size_add_overflow(t.result, u.result);
501 return (struct rbimpl_size_overflow_tag) { t.overflowed || u.overflowed || v.overflowed, v.result };
502}
503
504PRINTF_ARGS(NORETURN(static void gc_raise(VALUE, const char*, ...)), 2, 3);
505
506static inline size_t
507size_mul_or_raise(size_t x, size_t y, VALUE exc)
508{
509 struct rbimpl_size_overflow_tag t = rbimpl_size_mul_overflow(x, y);
510 if (LIKELY(!t.overflowed)) {
511 return t.result;
512 }
513 else if (rb_during_gc()) {
514 rb_memerror(); /* or...? */
515 }
516 else {
517 gc_raise(
518 exc,
519 "integer overflow: %"PRIuSIZE
520 " * %"PRIuSIZE
521 " > %"PRIuSIZE,
522 x, y, (size_t)SIZE_MAX);
523 }
524}
525
526size_t
527rb_size_mul_or_raise(size_t x, size_t y, VALUE exc)
528{
529 return size_mul_or_raise(x, y, exc);
530}
531
532static inline size_t
533size_mul_add_or_raise(size_t x, size_t y, size_t z, VALUE exc)
534{
535 struct rbimpl_size_overflow_tag t = size_mul_add_overflow(x, y, z);
536 if (LIKELY(!t.overflowed)) {
537 return t.result;
538 }
539 else if (rb_during_gc()) {
540 rb_memerror(); /* or...? */
541 }
542 else {
543 gc_raise(
544 exc,
545 "integer overflow: %"PRIuSIZE
546 " * %"PRIuSIZE
547 " + %"PRIuSIZE
548 " > %"PRIuSIZE,
549 x, y, z, (size_t)SIZE_MAX);
550 }
551}
552
553size_t
554rb_size_mul_add_or_raise(size_t x, size_t y, size_t z, VALUE exc)
555{
556 return size_mul_add_or_raise(x, y, z, exc);
557}
558
559static inline size_t
560size_mul_add_mul_or_raise(size_t x, size_t y, size_t z, size_t w, VALUE exc)
561{
562 struct rbimpl_size_overflow_tag t = size_mul_add_mul_overflow(x, y, z, w);
563 if (LIKELY(!t.overflowed)) {
564 return t.result;
565 }
566 else if (rb_during_gc()) {
567 rb_memerror(); /* or...? */
568 }
569 else {
570 gc_raise(
571 exc,
572 "integer overflow: %"PRIdSIZE
573 " * %"PRIdSIZE
574 " + %"PRIdSIZE
575 " * %"PRIdSIZE
576 " > %"PRIdSIZE,
577 x, y, z, w, (size_t)SIZE_MAX);
578 }
579}
580
581#if defined(HAVE_RB_GC_GUARDED_PTR_VAL) && HAVE_RB_GC_GUARDED_PTR_VAL
582/* trick the compiler into thinking a external signal handler uses this */
583volatile VALUE rb_gc_guarded_val;
584volatile VALUE *
585rb_gc_guarded_ptr_val(volatile VALUE *ptr, VALUE val)
586{
587 rb_gc_guarded_val = val;
588
589 return ptr;
590}
591#endif
592
593static const char *obj_type_name(VALUE obj);
594#include "gc/default/default.c"
595
596#if USE_MODULAR_GC && !defined(HAVE_DLOPEN)
597# error "Modular GC requires dlopen"
598#elif USE_MODULAR_GC
599#include <dlfcn.h>
600
601typedef struct gc_function_map {
602 // Bootup
603 void *(*objspace_alloc)(void);
604 void (*objspace_init)(void *objspace_ptr);
605 void *(*ractor_cache_alloc)(void *objspace_ptr, void *ractor);
606 void (*set_params)(void *objspace_ptr);
607 void (*init)(void);
608 size_t *(*heap_sizes)(void *objspace_ptr);
609 // Shutdown
610 void (*shutdown_free_objects)(void *objspace_ptr);
611 void (*objspace_free)(void *objspace_ptr);
612 void (*ractor_cache_free)(void *objspace_ptr, void *cache);
613 // GC
614 void (*start)(void *objspace_ptr, bool full_mark, bool immediate_mark, bool immediate_sweep, bool compact);
615 bool (*during_gc_p)(void *objspace_ptr);
616 void (*prepare_heap)(void *objspace_ptr);
617 void (*gc_enable)(void *objspace_ptr);
618 void (*gc_disable)(void *objspace_ptr, bool finish_current_gc);
619 bool (*gc_enabled_p)(void *objspace_ptr);
620 VALUE (*config_get)(void *objpace_ptr);
621 void (*config_set)(void *objspace_ptr, VALUE hash);
622 void (*stress_set)(void *objspace_ptr, VALUE flag);
623 VALUE (*stress_get)(void *objspace_ptr);
624 // Object allocation
625 VALUE (*new_obj)(void *objspace_ptr, void *cache_ptr, VALUE klass, VALUE flags, bool wb_protected, size_t alloc_size);
626 size_t (*obj_slot_size)(VALUE obj);
627 size_t (*heap_id_for_size)(void *objspace_ptr, size_t size);
628 bool (*size_allocatable_p)(size_t size);
629 // Malloc
630 void *(*malloc)(void *objspace_ptr, size_t size, bool gc_allowed);
631 void *(*calloc)(void *objspace_ptr, size_t size, bool gc_allowed);
632 void *(*realloc)(void *objspace_ptr, void *ptr, size_t new_size, size_t old_size, bool gc_allowed);
633 void (*free)(void *objspace_ptr, void *ptr, size_t old_size);
634 void (*adjust_memory_usage)(void *objspace_ptr, ssize_t diff);
635 // Marking
636 void (*mark)(void *objspace_ptr, VALUE obj);
637 void (*mark_and_move)(void *objspace_ptr, VALUE *ptr);
638 void (*mark_and_pin)(void *objspace_ptr, VALUE obj);
639 void (*mark_maybe)(void *objspace_ptr, VALUE obj);
640 void (*mark_weak)(void *objspace_ptr, VALUE *ptr);
641 void (*remove_weak)(void *objspace_ptr, VALUE parent_obj, VALUE *ptr);
642 // Compaction
643 bool (*object_moved_p)(void *objspace_ptr, VALUE obj);
644 VALUE (*location)(void *objspace_ptr, VALUE value);
645 // Write barriers
646 void (*writebarrier)(void *objspace_ptr, VALUE a, VALUE b);
647 void (*writebarrier_unprotect)(void *objspace_ptr, VALUE obj);
648 void (*writebarrier_remember)(void *objspace_ptr, VALUE obj);
649 // Heap walking
650 void (*each_objects)(void *objspace_ptr, int (*callback)(void *, void *, size_t, void *), void *data);
651 void (*each_object)(void *objspace_ptr, void (*func)(VALUE obj, void *data), void *data);
652 // Finalizers
653 void (*make_zombie)(void *objspace_ptr, VALUE obj, void (*dfree)(void *), void *data);
654 VALUE (*define_finalizer)(void *objspace_ptr, VALUE obj, VALUE block);
655 void (*undefine_finalizer)(void *objspace_ptr, VALUE obj);
656 void (*copy_finalizer)(void *objspace_ptr, VALUE dest, VALUE obj);
657 void (*shutdown_call_finalizer)(void *objspace_ptr);
658 // Forking
659 void (*before_fork)(void *objspace_ptr);
660 void (*after_fork)(void *objspace_ptr, rb_pid_t pid);
661 // Statistics
662 void (*set_measure_total_time)(void *objspace_ptr, VALUE flag);
663 bool (*get_measure_total_time)(void *objspace_ptr);
664 unsigned long long (*get_total_time)(void *objspace_ptr);
665 size_t (*gc_count)(void *objspace_ptr);
666 VALUE (*latest_gc_info)(void *objspace_ptr, VALUE key);
667 VALUE (*stat)(void *objspace_ptr, VALUE hash_or_sym);
668 VALUE (*stat_heap)(void *objspace_ptr, VALUE heap_name, VALUE hash_or_sym);
669 const char *(*active_gc_name)(void);
670 // Miscellaneous
671 struct rb_gc_object_metadata_entry *(*object_metadata)(void *objspace_ptr, VALUE obj);
672 bool (*pointer_to_heap_p)(void *objspace_ptr, const void *ptr);
673 bool (*garbage_object_p)(void *objspace_ptr, VALUE obj);
674 void (*set_event_hook)(void *objspace_ptr, const rb_event_flag_t event);
675 void (*copy_attributes)(void *objspace_ptr, VALUE dest, VALUE obj);
676
677 bool modular_gc_loaded_p;
678} rb_gc_function_map_t;
679
680static rb_gc_function_map_t rb_gc_functions;
681
682# define RUBY_GC_LIBRARY "RUBY_GC_LIBRARY"
683# define MODULAR_GC_DIR STRINGIZE(modular_gc_dir)
684
685static void
686ruby_modular_gc_init(void)
687{
688 // Assert that the directory path ends with a /
689 RUBY_ASSERT_ALWAYS(MODULAR_GC_DIR[sizeof(MODULAR_GC_DIR) - 2] == '/');
690
691 const char *gc_so_file = getenv(RUBY_GC_LIBRARY);
692
693 rb_gc_function_map_t gc_functions = { 0 };
694
695 char *gc_so_path = NULL;
696 void *handle = NULL;
697 if (gc_so_file) {
698 /* Check to make sure that gc_so_file matches /[\w-_]+/ so that it does
699 * not load a shared object outside of the directory. */
700 for (size_t i = 0; i < strlen(gc_so_file); i++) {
701 char c = gc_so_file[i];
702 if (isalnum(c)) continue;
703 switch (c) {
704 case '-':
705 case '_':
706 break;
707 default:
708 fprintf(stderr, "Only alphanumeric, dash, and underscore is allowed in "RUBY_GC_LIBRARY"\n");
709 exit(1);
710 }
711 }
712
713 size_t gc_so_path_size = strlen(MODULAR_GC_DIR "librubygc." DLEXT) + strlen(gc_so_file) + 1;
714#ifdef LOAD_RELATIVE
715 Dl_info dli;
716 size_t prefix_len = 0;
717 if (dladdr((void *)(uintptr_t)ruby_modular_gc_init, &dli)) {
718 const char *base = strrchr(dli.dli_fname, '/');
719 if (base) {
720 size_t tail = 0;
721# define end_with_p(lit) \
722 (prefix_len >= (tail = rb_strlen_lit(lit)) && \
723 memcmp(base - tail, lit, tail) == 0)
724
725 prefix_len = base - dli.dli_fname;
726 if (end_with_p("/bin") || end_with_p("/lib")) {
727 prefix_len -= tail;
728 }
729 prefix_len += MODULAR_GC_DIR[0] != '/';
730 gc_so_path_size += prefix_len;
731 }
732 }
733#endif
734 gc_so_path = alloca(gc_so_path_size);
735 {
736 size_t gc_so_path_idx = 0;
737#define GC_SO_PATH_APPEND(str) do { \
738 gc_so_path_idx += strlcpy(gc_so_path + gc_so_path_idx, str, gc_so_path_size - gc_so_path_idx); \
739} while (0)
740#ifdef LOAD_RELATIVE
741 if (prefix_len > 0) {
742 memcpy(gc_so_path, dli.dli_fname, prefix_len);
743 gc_so_path_idx = prefix_len;
744 }
745#endif
746 GC_SO_PATH_APPEND(MODULAR_GC_DIR "librubygc.");
747 GC_SO_PATH_APPEND(gc_so_file);
748 GC_SO_PATH_APPEND(DLEXT);
749 GC_ASSERT(gc_so_path_idx == gc_so_path_size - 1);
750#undef GC_SO_PATH_APPEND
751 }
752
753 handle = dlopen(gc_so_path, RTLD_LAZY | RTLD_GLOBAL);
754 if (!handle) {
755 fprintf(stderr, "ruby_modular_gc_init: Shared library %s cannot be opened: %s\n", gc_so_path, dlerror());
756 exit(1);
757 }
758
759 gc_functions.modular_gc_loaded_p = true;
760 }
761
762# define load_modular_gc_func(name) do { \
763 if (handle) { \
764 const char *func_name = "rb_gc_impl_" #name; \
765 gc_functions.name = dlsym(handle, func_name); \
766 if (!gc_functions.name) { \
767 fprintf(stderr, "ruby_modular_gc_init: %s function not exported by library %s\n", func_name, gc_so_path); \
768 exit(1); \
769 } \
770 } \
771 else { \
772 gc_functions.name = rb_gc_impl_##name; \
773 } \
774} while (0)
775
776 // Bootup
777 load_modular_gc_func(objspace_alloc);
778 load_modular_gc_func(objspace_init);
779 load_modular_gc_func(ractor_cache_alloc);
780 load_modular_gc_func(set_params);
781 load_modular_gc_func(init);
782 load_modular_gc_func(heap_sizes);
783 // Shutdown
784 load_modular_gc_func(shutdown_free_objects);
785 load_modular_gc_func(objspace_free);
786 load_modular_gc_func(ractor_cache_free);
787 // GC
788 load_modular_gc_func(start);
789 load_modular_gc_func(during_gc_p);
790 load_modular_gc_func(prepare_heap);
791 load_modular_gc_func(gc_enable);
792 load_modular_gc_func(gc_disable);
793 load_modular_gc_func(gc_enabled_p);
794 load_modular_gc_func(config_set);
795 load_modular_gc_func(config_get);
796 load_modular_gc_func(stress_set);
797 load_modular_gc_func(stress_get);
798 // Object allocation
799 load_modular_gc_func(new_obj);
800 load_modular_gc_func(obj_slot_size);
801 load_modular_gc_func(heap_id_for_size);
802 load_modular_gc_func(size_allocatable_p);
803 // Malloc
804 load_modular_gc_func(malloc);
805 load_modular_gc_func(calloc);
806 load_modular_gc_func(realloc);
807 load_modular_gc_func(free);
808 load_modular_gc_func(adjust_memory_usage);
809 // Marking
810 load_modular_gc_func(mark);
811 load_modular_gc_func(mark_and_move);
812 load_modular_gc_func(mark_and_pin);
813 load_modular_gc_func(mark_maybe);
814 load_modular_gc_func(mark_weak);
815 load_modular_gc_func(remove_weak);
816 // Compaction
817 load_modular_gc_func(object_moved_p);
818 load_modular_gc_func(location);
819 // Write barriers
820 load_modular_gc_func(writebarrier);
821 load_modular_gc_func(writebarrier_unprotect);
822 load_modular_gc_func(writebarrier_remember);
823 // Heap walking
824 load_modular_gc_func(each_objects);
825 load_modular_gc_func(each_object);
826 // Finalizers
827 load_modular_gc_func(make_zombie);
828 load_modular_gc_func(define_finalizer);
829 load_modular_gc_func(undefine_finalizer);
830 load_modular_gc_func(copy_finalizer);
831 load_modular_gc_func(shutdown_call_finalizer);
832 // Forking
833 load_modular_gc_func(before_fork);
834 load_modular_gc_func(after_fork);
835 // Statistics
836 load_modular_gc_func(set_measure_total_time);
837 load_modular_gc_func(get_measure_total_time);
838 load_modular_gc_func(get_total_time);
839 load_modular_gc_func(gc_count);
840 load_modular_gc_func(latest_gc_info);
841 load_modular_gc_func(stat);
842 load_modular_gc_func(stat_heap);
843 load_modular_gc_func(active_gc_name);
844 // Miscellaneous
845 load_modular_gc_func(object_metadata);
846 load_modular_gc_func(pointer_to_heap_p);
847 load_modular_gc_func(garbage_object_p);
848 load_modular_gc_func(set_event_hook);
849 load_modular_gc_func(copy_attributes);
850
851# undef load_modular_gc_func
852
853 rb_gc_functions = gc_functions;
854}
855
856// Bootup
857# define rb_gc_impl_objspace_alloc rb_gc_functions.objspace_alloc
858# define rb_gc_impl_objspace_init rb_gc_functions.objspace_init
859# define rb_gc_impl_ractor_cache_alloc rb_gc_functions.ractor_cache_alloc
860# define rb_gc_impl_set_params rb_gc_functions.set_params
861# define rb_gc_impl_init rb_gc_functions.init
862# define rb_gc_impl_heap_sizes rb_gc_functions.heap_sizes
863// Shutdown
864# define rb_gc_impl_shutdown_free_objects rb_gc_functions.shutdown_free_objects
865# define rb_gc_impl_objspace_free rb_gc_functions.objspace_free
866# define rb_gc_impl_ractor_cache_free rb_gc_functions.ractor_cache_free
867// GC
868# define rb_gc_impl_start rb_gc_functions.start
869# define rb_gc_impl_during_gc_p rb_gc_functions.during_gc_p
870# define rb_gc_impl_prepare_heap rb_gc_functions.prepare_heap
871# define rb_gc_impl_gc_enable rb_gc_functions.gc_enable
872# define rb_gc_impl_gc_disable rb_gc_functions.gc_disable
873# define rb_gc_impl_gc_enabled_p rb_gc_functions.gc_enabled_p
874# define rb_gc_impl_config_get rb_gc_functions.config_get
875# define rb_gc_impl_config_set rb_gc_functions.config_set
876# define rb_gc_impl_stress_set rb_gc_functions.stress_set
877# define rb_gc_impl_stress_get rb_gc_functions.stress_get
878// Object allocation
879# define rb_gc_impl_new_obj rb_gc_functions.new_obj
880# define rb_gc_impl_obj_slot_size rb_gc_functions.obj_slot_size
881# define rb_gc_impl_heap_id_for_size rb_gc_functions.heap_id_for_size
882# define rb_gc_impl_size_allocatable_p rb_gc_functions.size_allocatable_p
883// Malloc
884# define rb_gc_impl_malloc rb_gc_functions.malloc
885# define rb_gc_impl_calloc rb_gc_functions.calloc
886# define rb_gc_impl_realloc rb_gc_functions.realloc
887# define rb_gc_impl_free rb_gc_functions.free
888# define rb_gc_impl_adjust_memory_usage rb_gc_functions.adjust_memory_usage
889// Marking
890# define rb_gc_impl_mark rb_gc_functions.mark
891# define rb_gc_impl_mark_and_move rb_gc_functions.mark_and_move
892# define rb_gc_impl_mark_and_pin rb_gc_functions.mark_and_pin
893# define rb_gc_impl_mark_maybe rb_gc_functions.mark_maybe
894# define rb_gc_impl_mark_weak rb_gc_functions.mark_weak
895# define rb_gc_impl_remove_weak rb_gc_functions.remove_weak
896// Compaction
897# define rb_gc_impl_object_moved_p rb_gc_functions.object_moved_p
898# define rb_gc_impl_location rb_gc_functions.location
899// Write barriers
900# define rb_gc_impl_writebarrier rb_gc_functions.writebarrier
901# define rb_gc_impl_writebarrier_unprotect rb_gc_functions.writebarrier_unprotect
902# define rb_gc_impl_writebarrier_remember rb_gc_functions.writebarrier_remember
903// Heap walking
904# define rb_gc_impl_each_objects rb_gc_functions.each_objects
905# define rb_gc_impl_each_object rb_gc_functions.each_object
906// Finalizers
907# define rb_gc_impl_make_zombie rb_gc_functions.make_zombie
908# define rb_gc_impl_define_finalizer rb_gc_functions.define_finalizer
909# define rb_gc_impl_undefine_finalizer rb_gc_functions.undefine_finalizer
910# define rb_gc_impl_copy_finalizer rb_gc_functions.copy_finalizer
911# define rb_gc_impl_shutdown_call_finalizer rb_gc_functions.shutdown_call_finalizer
912// Forking
913# define rb_gc_impl_before_fork rb_gc_functions.before_fork
914# define rb_gc_impl_after_fork rb_gc_functions.after_fork
915// Statistics
916# define rb_gc_impl_set_measure_total_time rb_gc_functions.set_measure_total_time
917# define rb_gc_impl_get_measure_total_time rb_gc_functions.get_measure_total_time
918# define rb_gc_impl_get_total_time rb_gc_functions.get_total_time
919# define rb_gc_impl_gc_count rb_gc_functions.gc_count
920# define rb_gc_impl_latest_gc_info rb_gc_functions.latest_gc_info
921# define rb_gc_impl_stat rb_gc_functions.stat
922# define rb_gc_impl_stat_heap rb_gc_functions.stat_heap
923# define rb_gc_impl_active_gc_name rb_gc_functions.active_gc_name
924// Miscellaneous
925# define rb_gc_impl_object_metadata rb_gc_functions.object_metadata
926# define rb_gc_impl_pointer_to_heap_p rb_gc_functions.pointer_to_heap_p
927# define rb_gc_impl_garbage_object_p rb_gc_functions.garbage_object_p
928# define rb_gc_impl_set_event_hook rb_gc_functions.set_event_hook
929# define rb_gc_impl_copy_attributes rb_gc_functions.copy_attributes
930#endif
931
932#ifdef RUBY_ASAN_ENABLED
933static void
934asan_death_callback(void)
935{
936 if (GET_VM()) {
937 rb_bug_without_die("ASAN error");
938 }
939}
940#endif
941
942static VALUE initial_stress = Qfalse;
943
944void *
945rb_objspace_alloc(void)
946{
947#if USE_MODULAR_GC
948 ruby_modular_gc_init();
949#endif
950
951 void *objspace = rb_gc_impl_objspace_alloc();
952 ruby_current_vm_ptr->gc.objspace = objspace;
953 rb_gc_impl_objspace_init(objspace);
954 rb_gc_impl_stress_set(objspace, initial_stress);
955
956#ifdef RUBY_ASAN_ENABLED
957 __sanitizer_set_death_callback(asan_death_callback);
958#endif
959
960 return objspace;
961}
962
963void
964rb_objspace_free(void *objspace)
965{
966 rb_gc_impl_objspace_free(objspace);
967}
968
969size_t
970rb_gc_obj_slot_size(VALUE obj)
971{
972 return rb_gc_impl_obj_slot_size(obj);
973}
974
975static inline void
976gc_validate_pc(VALUE obj)
977{
978#if RUBY_DEBUG
979 // IMEMOs and objects without a class (e.g managed id table) are not traceable
980 if (RB_TYPE_P(obj, T_IMEMO) || !CLASS_OF(obj)) return;
981
982 rb_execution_context_t *ec = GET_EC();
983 const rb_control_frame_t *cfp = ec->cfp;
984 if (cfp && VM_FRAME_RUBYFRAME_P(cfp) && cfp->pc) {
985 const VALUE *iseq_encoded = ISEQ_BODY(cfp->iseq)->iseq_encoded;
986 const VALUE *iseq_encoded_end = iseq_encoded + ISEQ_BODY(cfp->iseq)->iseq_size;
987 RUBY_ASSERT(cfp->pc >= iseq_encoded, "PC not set when allocating, breaking tracing");
988 RUBY_ASSERT(cfp->pc <= iseq_encoded_end, "PC not set when allocating, breaking tracing");
989 }
990#endif
991}
992
993static inline VALUE
994newobj_of(rb_ractor_t *cr, VALUE klass, VALUE flags, shape_id_t shape_id, bool wb_protected, size_t size)
995{
996 VALUE obj = rb_gc_impl_new_obj(rb_gc_get_objspace(), cr->newobj_cache, klass, flags, wb_protected, size);
997 RBASIC_SET_SHAPE_ID_NO_CHECKS(obj, shape_id);
998
999 gc_validate_pc(obj);
1000
1001 if (UNLIKELY(rb_gc_event_hook_required_p(RUBY_INTERNAL_EVENT_NEWOBJ))) {
1002 int lev = RB_GC_VM_LOCK_NO_BARRIER();
1003 {
1004 size_t slot_size = rb_gc_obj_slot_size(obj);
1005 if (slot_size > RVALUE_SIZE) {
1006 memset((char *)obj + RVALUE_SIZE, 0, slot_size - RVALUE_SIZE);
1007 }
1008
1009 /* We must disable GC here because the callback could call xmalloc
1010 * which could potentially trigger a GC, and a lot of code is unsafe
1011 * to trigger a GC right after an object has been allocated because
1012 * they perform initialization for the object and assume that the
1013 * GC does not trigger before then. */
1014 bool gc_disabled = RTEST(rb_gc_disable_no_rest());
1015 {
1016 rb_gc_event_hook(obj, RUBY_INTERNAL_EVENT_NEWOBJ);
1017 }
1018 if (!gc_disabled) rb_gc_enable();
1019 }
1020 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
1021 }
1022
1023#if RGENGC_CHECK_MODE
1024# ifndef GC_DEBUG_SLOT_FILL_SPECIAL_VALUE
1025# define GC_DEBUG_SLOT_FILL_SPECIAL_VALUE 255
1026# endif
1027
1028 memset(
1029 (void *)(obj + sizeof(struct RBasic)),
1030 GC_DEBUG_SLOT_FILL_SPECIAL_VALUE,
1031 rb_gc_obj_slot_size(obj) - sizeof(struct RBasic)
1032 );
1033#endif
1034
1035 return obj;
1036}
1037
1038 VALUE
1039rb_wb_unprotected_newobj_of(VALUE klass, VALUE flags, shape_id_t shape_id, size_t size)
1040{
1041 GC_ASSERT((flags & FL_WB_PROTECTED) == 0);
1042 return newobj_of(GET_RACTOR(), klass, flags, shape_id, FALSE, size);
1043}
1044
1045 VALUE
1046rb_wb_protected_newobj_of(rb_execution_context_t *ec, VALUE klass, VALUE flags, shape_id_t shape_id, size_t size)
1047{
1048 GC_ASSERT((flags & FL_WB_PROTECTED) == 0);
1049 return newobj_of(rb_ec_ractor_ptr(ec), klass, flags, shape_id, TRUE, size);
1050}
1051
1052#define UNEXPECTED_NODE(func) \
1053 rb_bug(#func"(): GC does not handle T_NODE 0x%x(%p) 0x%"PRIxVALUE, \
1054 BUILTIN_TYPE(obj), (void*)(obj), RBASIC(obj)->flags)
1055
1056static inline void
1057rb_data_object_check(VALUE klass)
1058{
1059 if (klass != rb_cObject && (rb_get_alloc_func(klass) == rb_class_allocate_instance)) {
1060 rb_undef_alloc_func(klass);
1061 rb_warn("undefining the allocator of T_DATA class %"PRIsVALUE, klass);
1062 }
1063}
1064
1065 VALUE
1066rb_data_object_wrap(VALUE klass, void *datap, RUBY_DATA_FUNC dmark, RUBY_DATA_FUNC dfree)
1067{
1068 RUBY_ASSERT_ALWAYS(dfree != (RUBY_DATA_FUNC)1);
1069 if (klass) rb_data_object_check(klass);
1070 VALUE obj = newobj_of(GET_RACTOR(), klass, T_DATA, ROOT_SHAPE_ID, !dmark, sizeof(struct RTypedData));
1071
1072 struct RData *data = (struct RData *)obj;
1073 data->dmark = dmark;
1074 data->dfree = dfree;
1075 data->data = datap;
1076
1077 return obj;
1078}
1079
1080 VALUE
1081rb_data_object_zalloc(VALUE klass, size_t size, RUBY_DATA_FUNC dmark, RUBY_DATA_FUNC dfree)
1082{
1083 VALUE obj = rb_data_object_wrap(klass, 0, dmark, dfree);
1084 DATA_PTR(obj) = xcalloc(1, size);
1085 return obj;
1086}
1087
1088static VALUE
1089typed_data_alloc(VALUE klass, VALUE typed_flag, void *datap, const rb_data_type_t *type, size_t size)
1090{
1091 RBIMPL_NONNULL_ARG(type);
1092 if (klass) rb_data_object_check(klass);
1093 bool wb_protected = (type->flags & RUBY_FL_WB_PROTECTED) || !type->function.dmark;
1094 VALUE obj = newobj_of(GET_RACTOR(), klass, T_DATA | RUBY_TYPED_FL_IS_TYPED_DATA, ROOT_SHAPE_ID, wb_protected, size);
1095
1096 struct RTypedData *data = (struct RTypedData *)obj;
1097 data->fields_obj = 0;
1098 *(VALUE *)&data->type = ((VALUE)type) | typed_flag;
1099 data->data = datap;
1100
1101 return obj;
1102}
1103
1104 VALUE
1105rb_data_typed_object_wrap(VALUE klass, void *datap, const rb_data_type_t *type)
1106{
1107 if (UNLIKELY(type->flags & RUBY_TYPED_EMBEDDABLE)) {
1108 rb_raise(rb_eTypeError, "Cannot wrap an embeddable TypedData");
1109 }
1110
1111 return typed_data_alloc(klass, 0, datap, type, sizeof(struct RTypedData));
1112}
1113
1114 VALUE
1115rb_data_typed_object_zalloc(VALUE klass, size_t size, const rb_data_type_t *type)
1116{
1117 if (type->flags & RUBY_TYPED_EMBEDDABLE) {
1118 if (!(type->flags & RUBY_TYPED_FREE_IMMEDIATELY)) {
1119 rb_raise(rb_eTypeError, "Embeddable TypedData must be freed immediately");
1120 }
1121
1122 size_t embed_size = offsetof(struct RTypedData, data) + size;
1123 if (rb_gc_size_allocatable_p(embed_size)) {
1124 VALUE obj = typed_data_alloc(klass, TYPED_DATA_EMBEDDED, 0, type, embed_size);
1125 memset((char *)obj + offsetof(struct RTypedData, data), 0, size);
1126 return obj;
1127 }
1128 }
1129
1130 VALUE obj = typed_data_alloc(klass, 0, NULL, type, sizeof(struct RTypedData));
1131 DATA_PTR(obj) = xcalloc(1, size);
1132 return obj;
1133}
1134
1135static size_t
1136rb_objspace_data_type_memsize(VALUE obj)
1137{
1138 size_t size = 0;
1139 if (RTYPEDDATA_P(obj)) {
1140 const rb_data_type_t *type = RTYPEDDATA_TYPE(obj);
1141 const void *ptr = RTYPEDDATA_GET_DATA(obj);
1142
1143 if (RTYPEDDATA_TYPE(obj)->flags & RUBY_TYPED_EMBEDDABLE && !RTYPEDDATA_EMBEDDED_P(obj)) {
1144#ifdef HAVE_MALLOC_USABLE_SIZE
1145 size += malloc_usable_size((void *)ptr);
1146#endif
1147 }
1148
1149 if (ptr && type->function.dsize) {
1150 size += type->function.dsize(ptr);
1151 }
1152 }
1153
1154 return size;
1155}
1156
1157const char *
1158rb_objspace_data_type_name(VALUE obj)
1159{
1160 if (RTYPEDDATA_P(obj)) {
1161 return RTYPEDDATA_TYPE(obj)->wrap_struct_name;
1162 }
1163 else {
1164 return 0;
1165 }
1166}
1167
1168static void
1169io_fptr_finalize(void *fptr)
1170{
1171 rb_io_fptr_finalize((struct rb_io *)fptr);
1172}
1173
1174static inline void
1175make_io_zombie(void *objspace, VALUE obj)
1176{
1177 rb_io_t *fptr = RFILE(obj)->fptr;
1178 rb_gc_impl_make_zombie(objspace, obj, io_fptr_finalize, fptr);
1179}
1180
1181static bool
1182rb_data_free(void *objspace, VALUE obj)
1183{
1184 bool typed = RTYPEDDATA_P(obj);
1185 void *data = typed ? RTYPEDDATA_GET_DATA(obj) : DATA_PTR(obj);
1186 if (data) {
1187 int free_immediately = false;
1188 bool embedded = false;
1189 bool free_embeddable_data = false;
1190 void (*dfree)(void *);
1191
1192 if (typed) {
1193 const rb_data_type_t *type = RTYPEDDATA_TYPE(obj);
1194 dfree = type->function.dfree;
1195 if (dfree) {
1196 embedded = RTYPEDDATA_EMBEDDED_P(obj);
1197 free_immediately = (type->flags & RUBY_TYPED_FREE_IMMEDIATELY) != 0;
1198 free_embeddable_data = (type->flags & RUBY_TYPED_EMBEDDABLE) && !embedded;
1199 }
1200 }
1201 else {
1202 dfree = RDATA(obj)->dfree;
1203 }
1204
1205 if (dfree) {
1206 if (dfree == RUBY_DEFAULT_FREE) {
1207 if (!typed || !embedded) {
1208 xfree(data);
1209 RB_DEBUG_COUNTER_INC(obj_data_xfree);
1210 }
1211 }
1212 else if (free_immediately) {
1213 (*dfree)(data);
1214 if (free_embeddable_data) {
1215 xfree(data);
1216 }
1217
1218 RB_DEBUG_COUNTER_INC(obj_data_imm_free);
1219 }
1220 else {
1221 rb_gc_impl_make_zombie(objspace, obj, dfree, data);
1222 RB_DEBUG_COUNTER_INC(obj_data_zombie);
1223 return FALSE;
1224 }
1225 }
1226 else {
1227 RB_DEBUG_COUNTER_INC(obj_data_empty);
1228 }
1229 }
1230
1231 return true;
1232}
1233
1234 struct classext_foreach_args {
1235 VALUE klass;
1236 rb_objspace_t *objspace; // used for update_*
1237};
1238
1239static void
1240classext_free(rb_classext_t *ext, bool is_prime, VALUE box_value, void *arg)
1241{
1242 struct classext_foreach_args *args = (struct classext_foreach_args *)arg;
1243
1244 rb_class_classext_free(args->klass, ext, is_prime);
1245}
1246
1247static void
1248classext_iclass_free(rb_classext_t *ext, bool is_prime, VALUE box_value, void *arg)
1249{
1250 struct classext_foreach_args *args = (struct classext_foreach_args *)arg;
1251
1252 rb_iclass_classext_free(args->klass, ext, is_prime);
1253}
1254
1255bool
1256rb_gc_obj_free(void *objspace, VALUE obj)
1257{
1258 struct classext_foreach_args args;
1259
1260 RB_DEBUG_COUNTER_INC(obj_free);
1261
1262 switch (BUILTIN_TYPE(obj)) {
1263 case T_NIL:
1264 case T_FIXNUM:
1265 case T_TRUE:
1266 case T_FALSE:
1267 rb_bug("obj_free() called for broken object");
1268 break;
1269 default:
1270 break;
1271 }
1272
1273 switch (BUILTIN_TYPE(obj)) {
1274 case T_OBJECT:
1275 if (FL_TEST_RAW(obj, ROBJECT_HEAP)) {
1276 if (rb_shape_obj_too_complex_p(obj)) {
1277 RB_DEBUG_COUNTER_INC(obj_obj_too_complex);
1278 st_free_table(ROBJECT_FIELDS_HASH(obj));
1279 }
1280 else {
1281 xfree(ROBJECT(obj)->as.heap.fields);
1282 RB_DEBUG_COUNTER_INC(obj_obj_ptr);
1283 }
1284 }
1285 else {
1286 RB_DEBUG_COUNTER_INC(obj_obj_embed);
1287 }
1288 break;
1289 case T_MODULE:
1290 case T_CLASS:
1291#if USE_ZJIT
1292 rb_zjit_klass_free(obj);
1293#endif
1294 args.klass = obj;
1295 rb_class_classext_foreach(obj, classext_free, (void *)&args);
1296 if (RCLASS_CLASSEXT_TBL(obj)) {
1297 st_free_table(RCLASS_CLASSEXT_TBL(obj));
1298 }
1299 (void)RB_DEBUG_COUNTER_INC_IF(obj_module_ptr, BUILTIN_TYPE(obj) == T_MODULE);
1300 (void)RB_DEBUG_COUNTER_INC_IF(obj_class_ptr, BUILTIN_TYPE(obj) == T_CLASS);
1301 break;
1302 case T_STRING:
1303 rb_str_free(obj);
1304 break;
1305 case T_ARRAY:
1306 rb_ary_free(obj);
1307 break;
1308 case T_HASH:
1309#if USE_DEBUG_COUNTER
1310 switch (RHASH_SIZE(obj)) {
1311 case 0:
1312 RB_DEBUG_COUNTER_INC(obj_hash_empty);
1313 break;
1314 case 1:
1315 RB_DEBUG_COUNTER_INC(obj_hash_1);
1316 break;
1317 case 2:
1318 RB_DEBUG_COUNTER_INC(obj_hash_2);
1319 break;
1320 case 3:
1321 RB_DEBUG_COUNTER_INC(obj_hash_3);
1322 break;
1323 case 4:
1324 RB_DEBUG_COUNTER_INC(obj_hash_4);
1325 break;
1326 case 5:
1327 case 6:
1328 case 7:
1329 case 8:
1330 RB_DEBUG_COUNTER_INC(obj_hash_5_8);
1331 break;
1332 default:
1333 GC_ASSERT(RHASH_SIZE(obj) > 8);
1334 RB_DEBUG_COUNTER_INC(obj_hash_g8);
1335 }
1336
1337 if (RHASH_AR_TABLE_P(obj)) {
1338 if (RHASH_AR_TABLE(obj) == NULL) {
1339 RB_DEBUG_COUNTER_INC(obj_hash_null);
1340 }
1341 else {
1342 RB_DEBUG_COUNTER_INC(obj_hash_ar);
1343 }
1344 }
1345 else {
1346 RB_DEBUG_COUNTER_INC(obj_hash_st);
1347 }
1348#endif
1349
1350 rb_hash_free(obj);
1351 break;
1352 case T_REGEXP:
1353 if (RREGEXP(obj)->ptr) {
1354 onig_free(RREGEXP(obj)->ptr);
1355 RB_DEBUG_COUNTER_INC(obj_regexp_ptr);
1356 }
1357 break;
1358 case T_DATA:
1359 if (!rb_data_free(objspace, obj)) return false;
1360 break;
1361 case T_MATCH:
1362 {
1363 rb_matchext_t *rm = RMATCH_EXT(obj);
1364#if USE_DEBUG_COUNTER
1365 if (rm->regs.num_regs >= 8) {
1366 RB_DEBUG_COUNTER_INC(obj_match_ge8);
1367 }
1368 else if (rm->regs.num_regs >= 4) {
1369 RB_DEBUG_COUNTER_INC(obj_match_ge4);
1370 }
1371 else if (rm->regs.num_regs >= 1) {
1372 RB_DEBUG_COUNTER_INC(obj_match_under4);
1373 }
1374#endif
1375 onig_region_free(&rm->regs, 0);
1376 xfree(rm->char_offset);
1377
1378 RB_DEBUG_COUNTER_INC(obj_match_ptr);
1379 }
1380 break;
1381 case T_FILE:
1382 if (RFILE(obj)->fptr) {
1383 make_io_zombie(objspace, obj);
1384 RB_DEBUG_COUNTER_INC(obj_file_ptr);
1385 return FALSE;
1386 }
1387 break;
1388 case T_RATIONAL:
1389 RB_DEBUG_COUNTER_INC(obj_rational);
1390 break;
1391 case T_COMPLEX:
1392 RB_DEBUG_COUNTER_INC(obj_complex);
1393 break;
1394 case T_MOVED:
1395 break;
1396 case T_ICLASS:
1397 args.klass = obj;
1398
1399 rb_class_classext_foreach(obj, classext_iclass_free, (void *)&args);
1400 if (RCLASS_CLASSEXT_TBL(obj)) {
1401 st_free_table(RCLASS_CLASSEXT_TBL(obj));
1402 }
1403
1404 RB_DEBUG_COUNTER_INC(obj_iclass_ptr);
1405 break;
1406
1407 case T_FLOAT:
1408 RB_DEBUG_COUNTER_INC(obj_float);
1409 break;
1410
1411 case T_BIGNUM:
1412 if (!BIGNUM_EMBED_P(obj) && BIGNUM_DIGITS(obj)) {
1413 xfree(BIGNUM_DIGITS(obj));
1414 RB_DEBUG_COUNTER_INC(obj_bignum_ptr);
1415 }
1416 else {
1417 RB_DEBUG_COUNTER_INC(obj_bignum_embed);
1418 }
1419 break;
1420
1421 case T_NODE:
1422 UNEXPECTED_NODE(obj_free);
1423 break;
1424
1425 case T_STRUCT:
1426 if ((RBASIC(obj)->flags & RSTRUCT_EMBED_LEN_MASK) ||
1427 RSTRUCT(obj)->as.heap.ptr == NULL) {
1428 RB_DEBUG_COUNTER_INC(obj_struct_embed);
1429 }
1430 else {
1431 xfree((void *)RSTRUCT(obj)->as.heap.ptr);
1432 RB_DEBUG_COUNTER_INC(obj_struct_ptr);
1433 }
1434 break;
1435
1436 case T_SYMBOL:
1437 RB_DEBUG_COUNTER_INC(obj_symbol);
1438 break;
1439
1440 case T_IMEMO:
1441 rb_imemo_free((VALUE)obj);
1442 break;
1443
1444 default:
1445 rb_bug("gc_sweep(): unknown data type 0x%x(%p) 0x%"PRIxVALUE,
1446 BUILTIN_TYPE(obj), (void*)obj, RBASIC(obj)->flags);
1447 }
1448
1449 if (FL_TEST_RAW(obj, FL_FINALIZE)) {
1450 rb_gc_impl_make_zombie(objspace, obj, 0, 0);
1451 return FALSE;
1452 }
1453 else {
1454 return TRUE;
1455 }
1456}
1457
1458void
1459rb_objspace_set_event_hook(const rb_event_flag_t event)
1460{
1461 rb_gc_impl_set_event_hook(rb_gc_get_objspace(), event);
1462}
1463
1464static int
1465internal_object_p(VALUE obj)
1466{
1467 void *ptr = asan_unpoison_object_temporary(obj);
1468
1469 if (RBASIC(obj)->flags) {
1470 switch (BUILTIN_TYPE(obj)) {
1471 case T_NODE:
1472 UNEXPECTED_NODE(internal_object_p);
1473 break;
1474 case T_NONE:
1475 case T_MOVED:
1476 case T_IMEMO:
1477 case T_ICLASS:
1478 case T_ZOMBIE:
1479 break;
1480 case T_CLASS:
1481 if (obj == rb_mRubyVMFrozenCore)
1482 return 1;
1483
1484 if (!RBASIC_CLASS(obj)) break;
1485 if (RCLASS_SINGLETON_P(obj)) {
1486 return rb_singleton_class_internal_p(obj);
1487 }
1488 return 0;
1489 default:
1490 if (!RBASIC(obj)->klass) break;
1491 return 0;
1492 }
1493 }
1494 if (ptr || !RBASIC(obj)->flags) {
1495 rb_asan_poison_object(obj);
1496 }
1497 return 1;
1498}
1499
1500int
1501rb_objspace_internal_object_p(VALUE obj)
1502{
1503 return internal_object_p(obj);
1504}
1505
1506 struct os_each_struct {
1507 size_t num;
1508 VALUE of;
1509};
1510
1511static int
1512os_obj_of_i(void *vstart, void *vend, size_t stride, void *data)
1513{
1514 struct os_each_struct *oes = (struct os_each_struct *)data;
1515
1516 VALUE v = (VALUE)vstart;
1517 for (; v != (VALUE)vend; v += stride) {
1518 if (!internal_object_p(v)) {
1519 if (!oes->of || rb_obj_is_kind_of(v, oes->of)) {
1520 if (!rb_multi_ractor_p() || rb_ractor_shareable_p(v)) {
1521 rb_yield(v);
1522 oes->num++;
1523 }
1524 }
1525 }
1526 }
1527
1528 return 0;
1529}
1530
1531static VALUE
1532os_obj_of(VALUE of)
1533{
1534 struct os_each_struct oes;
1535
1536 oes.num = 0;
1537 oes.of = of;
1538 rb_objspace_each_objects(os_obj_of_i, &oes);
1539 return SIZET2NUM(oes.num);
1540}
1541
1542/*
1543 * call-seq:
1544 * ObjectSpace.each_object([module]) {|obj| ... } -> integer
1545 * ObjectSpace.each_object([module]) -> an_enumerator
1546 *
1547 * Calls the block once for each living, nonimmediate object in this
1548 * Ruby process. If <i>module</i> is specified, calls the block
1549 * for only those classes or modules that match (or are a subclass of)
1550 * <i>module</i>. Returns the number of objects found. Immediate
1551 * objects (such as <code>Fixnum</code>s, static <code>Symbol</code>s
1552 * <code>true</code>, <code>false</code> and <code>nil</code>) are
1553 * never returned.
1554 *
1555 * If no block is given, an enumerator is returned instead.
1556 *
1557 * Job = Class.new
1558 * jobs = [Job.new, Job.new]
1559 * count = ObjectSpace.each_object(Job) {|x| p x }
1560 * puts "Total count: #{count}"
1561 *
1562 * <em>produces:</em>
1563 *
1564 * #<Job:0x000000011d6cbbf0>
1565 * #<Job:0x000000011d6cbc68>
1566 * Total count: 2
1567 *
1568 * Due to a current Ractor implementation issue, this method does not yield
1569 * Ractor-unshareable objects when the process is in multi-Ractor mode. Multi-ractor
1570 * mode is enabled when <code>Ractor.new</code> has been called for the first time.
1571 * See https://bugs.ruby-lang.org/issues/19387 for more information.
1572 *
1573 * a = 12345678987654321 # shareable
1574 * b = [].freeze # shareable
1575 * c = {} # not shareable
1576 * ObjectSpace.each_object {|x| x } # yields a, b, and c
1577 * Ractor.new {} # enter multi-Ractor mode
1578 * ObjectSpace.each_object {|x| x } # does not yield c
1579 *
1580 */
1581
1582static VALUE
1583os_each_obj(int argc, VALUE *argv, VALUE os)
1584{
1585 VALUE of;
1586
1587 of = (!rb_check_arity(argc, 0, 1) ? 0 : argv[0]);
1588 RETURN_ENUMERATOR(os, 1, &of);
1589 return os_obj_of(of);
1590}
1591
1592/*
1593 * call-seq:
1594 * ObjectSpace.undefine_finalizer(obj)
1595 *
1596 * Removes all finalizers for <i>obj</i>.
1597 *
1598 */
1599
1600static VALUE
1601undefine_final(VALUE os, VALUE obj)
1602{
1603 return rb_undefine_finalizer(obj);
1604}
1605
1606 VALUE
1607rb_undefine_finalizer(VALUE obj)
1608{
1609 rb_check_frozen(obj);
1610
1611 rb_gc_impl_undefine_finalizer(rb_gc_get_objspace(), obj);
1612
1613 return obj;
1614}
1615
1616static void
1617should_be_callable(VALUE block)
1618{
1619 if (!rb_obj_respond_to(block, idCall, TRUE)) {
1620 rb_raise(rb_eArgError, "wrong type argument %"PRIsVALUE" (should be callable)",
1621 rb_obj_class(block));
1622 }
1623}
1624
1625static void
1626should_be_finalizable(VALUE obj)
1627{
1628 if (!FL_ABLE(obj)) {
1629 rb_raise(rb_eArgError, "cannot define finalizer for %s",
1630 rb_obj_classname(obj));
1631 }
1632 rb_check_frozen(obj);
1633}
1634
1635void
1636rb_gc_copy_finalizer(VALUE dest, VALUE obj)
1637{
1638 rb_gc_impl_copy_finalizer(rb_gc_get_objspace(), dest, obj);
1639}
1640
1641/*
1642 * call-seq:
1643 * ObjectSpace.define_finalizer(obj, aProc=proc())
1644 *
1645 * Adds <i>aProc</i> as a finalizer, to be called after <i>obj</i>
1646 * was destroyed. The object ID of the <i>obj</i> will be passed
1647 * as an argument to <i>aProc</i>. If <i>aProc</i> is a lambda or
1648 * method, make sure it can be called with a single argument.
1649 *
1650 * The return value is an array <code>[0, aProc]</code>.
1651 *
1652 * The two recommended patterns are to either create the finaliser proc
1653 * in a non-instance method where it can safely capture the needed state,
1654 * or to use a custom callable object that stores the needed state
1655 * explicitly as instance variables.
1656 *
1657 * class Foo
1658 * def initialize(data_needed_for_finalization)
1659 * ObjectSpace.define_finalizer(self, self.class.create_finalizer(data_needed_for_finalization))
1660 * end
1661 *
1662 * def self.create_finalizer(data_needed_for_finalization)
1663 * proc {
1664 * puts "finalizing #{data_needed_for_finalization}"
1665 * }
1666 * end
1667 * end
1668 *
1669 * class Bar
1670 * class Remover
1671 * def initialize(data_needed_for_finalization)
1672 * @data_needed_for_finalization = data_needed_for_finalization
1673 * end
1674 *
1675 * def call(id)
1676 * puts "finalizing #{@data_needed_for_finalization}"
1677 * end
1678 * end
1679 *
1680 * def initialize(data_needed_for_finalization)
1681 * ObjectSpace.define_finalizer(self, Remover.new(data_needed_for_finalization))
1682 * end
1683 * end
1684 *
1685 * Note that if your finalizer references the object to be
1686 * finalized it will never be run on GC, although it will still be
1687 * run at exit. You will get a warning if you capture the object
1688 * to be finalized as the receiver of the finalizer.
1689 *
1690 * class CapturesSelf
1691 * def initialize(name)
1692 * ObjectSpace.define_finalizer(self, proc {
1693 * # this finalizer will only be run on exit
1694 * puts "finalizing #{name}"
1695 * })
1696 * end
1697 * end
1698 *
1699 * Also note that finalization can be unpredictable and is never guaranteed
1700 * to be run except on exit.
1701 */
1702
1703static VALUE
1704define_final(int argc, VALUE *argv, VALUE os)
1705{
1706 VALUE obj, block;
1707
1708 rb_scan_args(argc, argv, "11", &obj, &block);
1709 if (argc == 1) {
1710 block = rb_block_proc();
1711 }
1712
1713 if (rb_callable_receiver(block) == obj) {
1714 rb_warn("finalizer references object to be finalized");
1715 }
1716
1717 return rb_define_finalizer(obj, block);
1718}
1719
1720 VALUE
1721rb_define_finalizer(VALUE obj, VALUE block)
1722{
1723 should_be_finalizable(obj);
1724 should_be_callable(block);
1725
1726 block = rb_gc_impl_define_finalizer(rb_gc_get_objspace(), obj, block);
1727
1728 block = rb_ary_new3(2, INT2FIX(0), block);
1729 OBJ_FREEZE(block);
1730 return block;
1731}
1732
1733void
1734rb_objspace_call_finalizer(void)
1735{
1736 rb_gc_impl_shutdown_call_finalizer(rb_gc_get_objspace());
1737}
1738
1739void
1740rb_objspace_free_objects(void *objspace)
1741{
1742 rb_gc_impl_shutdown_free_objects(objspace);
1743}
1744
1745int
1746rb_objspace_garbage_object_p(VALUE obj)
1747{
1748 return !SPECIAL_CONST_P(obj) && rb_gc_impl_garbage_object_p(rb_gc_get_objspace(), obj);
1749}
1750
1751bool
1752rb_gc_pointer_to_heap_p(VALUE obj)
1753{
1754 return rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (void *)obj);
1755}
1756
1757#define OBJ_ID_INCREMENT (RUBY_IMMEDIATE_MASK + 1)
1758#define LAST_OBJECT_ID() (object_id_counter * OBJ_ID_INCREMENT)
1759static VALUE id2ref_value = 0;
1760static st_table *id2ref_tbl = NULL;
1761
1762#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
1763static size_t object_id_counter = 1;
1764#else
1765static unsigned long long object_id_counter = 1;
1766#endif
1767
1768static inline VALUE
1769generate_next_object_id(void)
1770{
1771#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
1772 // 64bit atomics are available
1773 return SIZET2NUM(RUBY_ATOMIC_SIZE_FETCH_ADD(object_id_counter, 1) * OBJ_ID_INCREMENT);
1774#else
1775 unsigned int lock_lev = RB_GC_VM_LOCK();
1776 VALUE id = ULL2NUM(++object_id_counter * OBJ_ID_INCREMENT);
1777 RB_GC_VM_UNLOCK(lock_lev);
1778 return id;
1779#endif
1780}
1781
1782void
1783rb_gc_obj_id_moved(VALUE obj)
1784{
1785 if (UNLIKELY(id2ref_tbl)) {
1786 st_insert(id2ref_tbl, (st_data_t)rb_obj_id(obj), (st_data_t)obj);
1787 }
1788}
1789
1790static int
1791object_id_cmp(st_data_t x, st_data_t y)
1792{
1793 if (RB_TYPE_P(x, T_BIGNUM)) {
1794 return !rb_big_eql(x, y);
1795 }
1796 else {
1797 return x != y;
1798 }
1799}
1800
1801static st_index_t
1802object_id_hash(st_data_t n)
1803{
1804 return FIX2LONG(rb_hash((VALUE)n));
1805}
1806
1807static const struct st_hash_type object_id_hash_type = {
1808 object_id_cmp,
1809 object_id_hash,
1810};
1811
1812static void gc_mark_tbl_no_pin(st_table *table);
1813
1814static void
1815id2ref_tbl_mark(void *data)
1816{
1817 st_table *table = (st_table *)data;
1818 if (UNLIKELY(!RB_POSFIXABLE(LAST_OBJECT_ID()))) {
1819 // It's very unlikely, but if enough object ids were generated, keys may be T_BIGNUM
1820 rb_mark_set(table);
1821 }
1822 // We purposely don't mark values, as they are weak references.
1823 // rb_gc_obj_free_vm_weak_references takes care of cleaning them up.
1824}
1825
1826static size_t
1827id2ref_tbl_memsize(const void *data)
1828{
1829 return rb_st_memsize(data);
1830}
1831
1832static void
1833id2ref_tbl_free(void *data)
1834{
1835 id2ref_tbl = NULL; // clear global ref
1836 st_table *table = (st_table *)data;
1837 st_free_table(table);
1838}
1839
1840static const rb_data_type_t id2ref_tbl_type = {
1841 .wrap_struct_name = "VM/_id2ref_table",
1842 .function = {
1843 .dmark = id2ref_tbl_mark,
1844 .dfree = id2ref_tbl_free,
1845 .dsize = id2ref_tbl_memsize,
1846 // dcompact function not required because the table is reference updated
1847 // in rb_gc_vm_weak_table_foreach
1848 },
1849 .flags = RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_FREE_IMMEDIATELY
1850};
1851
1852static VALUE
1853class_object_id(VALUE klass)
1854{
1855 VALUE id = RUBY_ATOMIC_VALUE_LOAD(RCLASS(klass)->object_id);
1856 if (!id) {
1857 unsigned int lock_lev = RB_GC_VM_LOCK();
1858 id = generate_next_object_id();
1859 VALUE existing_id = RUBY_ATOMIC_VALUE_CAS(RCLASS(klass)->object_id, 0, id);
1860 if (existing_id) {
1861 id = existing_id;
1862 }
1863 else if (RB_UNLIKELY(id2ref_tbl)) {
1864 st_insert(id2ref_tbl, id, klass);
1865 }
1866 RB_GC_VM_UNLOCK(lock_lev);
1867 }
1868 return id;
1869}
1870
1871static inline VALUE
1872object_id_get(VALUE obj, shape_id_t shape_id)
1873{
1874 VALUE id;
1875 if (rb_shape_too_complex_p(shape_id)) {
1876 id = rb_obj_field_get(obj, ROOT_TOO_COMPLEX_WITH_OBJ_ID);
1877 }
1878 else {
1879 id = rb_obj_field_get(obj, rb_shape_object_id(shape_id));
1880 }
1881
1882#if RUBY_DEBUG
1883 if (!(FIXNUM_P(id) || RB_TYPE_P(id, T_BIGNUM))) {
1884 rb_p(obj);
1885 rb_bug("Object's shape includes object_id, but it's missing %s", rb_obj_info(obj));
1886 }
1887#endif
1888
1889 return id;
1890}
1891
1892static VALUE
1893object_id0(VALUE obj)
1894{
1895 VALUE id = Qfalse;
1896 shape_id_t shape_id = RBASIC_SHAPE_ID(obj);
1897
1898 if (rb_shape_has_object_id(shape_id)) {
1899 return object_id_get(obj, shape_id);
1900 }
1901
1902 shape_id_t object_id_shape_id = rb_shape_transition_object_id(obj);
1903
1904 id = generate_next_object_id();
1905 rb_obj_field_set(obj, object_id_shape_id, 0, id);
1906
1907 RUBY_ASSERT(RBASIC_SHAPE_ID(obj) == object_id_shape_id);
1908 RUBY_ASSERT(rb_shape_obj_has_id(obj));
1909
1910 if (RB_UNLIKELY(id2ref_tbl)) {
1911 RB_VM_LOCKING() {
1912 st_insert(id2ref_tbl, (st_data_t)id, (st_data_t)obj);
1913 }
1914 }
1915 return id;
1916}
1917
1918static VALUE
1919object_id(VALUE obj)
1920{
1921 switch (BUILTIN_TYPE(obj)) {
1922 case T_CLASS:
1923 case T_MODULE:
1924 // With Ruby Box, classes and modules have different fields
1925 // in different boxes, so we cannot store the object id
1926 // in fields.
1927 return class_object_id(obj);
1928 case T_IMEMO:
1929 RUBY_ASSERT(IMEMO_TYPE_P(obj, imemo_fields));
1930 break;
1931 default:
1932 break;
1933 }
1934
1935 if (UNLIKELY(rb_gc_multi_ractor_p() && rb_ractor_shareable_p(obj))) {
1936 unsigned int lock_lev = RB_GC_VM_LOCK();
1937 VALUE id = object_id0(obj);
1938 RB_GC_VM_UNLOCK(lock_lev);
1939 return id;
1940 }
1941
1942 return object_id0(obj);
1943}
1944
1945static void
1946build_id2ref_i(VALUE obj, void *data)
1947{
1948 st_table *id2ref_tbl = (st_table *)data;
1949
1950 switch (BUILTIN_TYPE(obj)) {
1951 case T_CLASS:
1952 case T_MODULE:
1953 RUBY_ASSERT(!rb_objspace_garbage_object_p(obj));
1954 if (RCLASS(obj)->object_id) {
1955 st_insert(id2ref_tbl, RCLASS(obj)->object_id, obj);
1956 }
1957 break;
1958 case T_IMEMO:
1959 RUBY_ASSERT(!rb_objspace_garbage_object_p(obj));
1960 if (IMEMO_TYPE_P(obj, imemo_fields) && rb_shape_obj_has_id(obj)) {
1961 st_insert(id2ref_tbl, rb_obj_id(obj), rb_imemo_fields_owner(obj));
1962 }
1963 break;
1964 case T_OBJECT:
1965 RUBY_ASSERT(!rb_objspace_garbage_object_p(obj));
1966 if (rb_shape_obj_has_id(obj)) {
1967 st_insert(id2ref_tbl, rb_obj_id(obj), obj);
1968 }
1969 break;
1970 default:
1971 // For generic_fields, the T_IMEMO/fields is responsible for populating the entry.
1972 break;
1973 }
1974}
1975
1976static VALUE
1977object_id_to_ref(void *objspace_ptr, VALUE object_id)
1978{
1979 rb_objspace_t *objspace = objspace_ptr;
1980
1981 unsigned int lev = RB_GC_VM_LOCK();
1982
1983 if (!id2ref_tbl) {
1984 rb_gc_vm_barrier(); // stop other ractors
1985
1986 // GC Must not trigger while we build the table, otherwise if we end
1987 // up freeing an object that had an ID, we might try to delete it from
1988 // the table even though it wasn't inserted yet.
1989 st_table *tmp_id2ref_tbl = st_init_table(&object_id_hash_type);
1990 VALUE tmp_id2ref_value = TypedData_Wrap_Struct(0, &id2ref_tbl_type, tmp_id2ref_tbl);
1991
1992 // build_id2ref_i will most certainly malloc, which could trigger GC and sweep
1993 // objects we just added to the table.
1994 // By calling rb_gc_disable() we also save having to handle potentially garbage objects.
1995 bool gc_disabled = RTEST(rb_gc_disable());
1996 {
1997 id2ref_tbl = tmp_id2ref_tbl;
1998 id2ref_value = tmp_id2ref_value;
1999
2000 rb_gc_impl_each_object(objspace, build_id2ref_i, (void *)id2ref_tbl);
2001 }
2002 if (!gc_disabled) rb_gc_enable();
2003 }
2004
2005 VALUE obj;
2006 bool found = st_lookup(id2ref_tbl, object_id, &obj) && !rb_gc_impl_garbage_object_p(objspace, obj);
2007
2008 RB_GC_VM_UNLOCK(lev);
2009
2010 if (found) {
2011 return obj;
2012 }
2013
2014 if (rb_funcall(object_id, rb_intern(">="), 1, ULL2NUM(LAST_OBJECT_ID()))) {
2015 rb_raise(rb_eRangeError, "%+"PRIsVALUE" is not an id value", rb_funcall(object_id, rb_intern("to_s"), 1, INT2FIX(10)));
2016 }
2017 else {
2018 rb_raise(rb_eRangeError, "%+"PRIsVALUE" is a recycled object", rb_funcall(object_id, rb_intern("to_s"), 1, INT2FIX(10)));
2019 }
2020}
2021
2022static inline void
2023obj_free_object_id(VALUE obj)
2024{
2025 VALUE obj_id = 0;
2026 if (RB_UNLIKELY(id2ref_tbl)) {
2027 switch (BUILTIN_TYPE(obj)) {
2028 case T_CLASS:
2029 case T_MODULE:
2030 obj_id = RCLASS(obj)->object_id;
2031 break;
2032 case T_IMEMO:
2033 if (!IMEMO_TYPE_P(obj, imemo_fields)) {
2034 return;
2035 }
2036 // fallthrough
2037 case T_OBJECT:
2038 {
2039 shape_id_t shape_id = RBASIC_SHAPE_ID(obj);
2040 if (rb_shape_has_object_id(shape_id)) {
2041 obj_id = object_id_get(obj, shape_id);
2042 }
2043 break;
2044 }
2045 default:
2046 // For generic_fields, the T_IMEMO/fields is responsible for freeing the id.
2047 return;
2048 }
2049
2050 if (RB_UNLIKELY(obj_id)) {
2051 RUBY_ASSERT(FIXNUM_P(obj_id) || RB_TYPE_P(obj_id, T_BIGNUM));
2052
2053 if (!st_delete(id2ref_tbl, (st_data_t *)&obj_id, NULL)) {
2054 // The the object is a T_IMEMO/fields, then it's possible the actual object
2055 // has been garbage collected already.
2056 if (!RB_TYPE_P(obj, T_IMEMO)) {
2057 rb_bug("Object ID seen, but not in _id2ref table: object_id=%llu object=%s", NUM2ULL(obj_id), rb_obj_info(obj));
2058 }
2059 }
2060 }
2061 }
2062}
2063
2064void
2065rb_gc_obj_free_vm_weak_references(VALUE obj)
2066{
2067 ASSUME(!RB_SPECIAL_CONST_P(obj));
2068 obj_free_object_id(obj);
2069
2070 if (rb_obj_gen_fields_p(obj)) {
2071 rb_free_generic_ivar(obj);
2072 }
2073
2074 switch (BUILTIN_TYPE(obj)) {
2075 case T_STRING:
2076 if (FL_TEST_RAW(obj, RSTRING_FSTR)) {
2077 rb_gc_free_fstring(obj);
2078 }
2079 break;
2080 case T_SYMBOL:
2081 rb_gc_free_dsymbol(obj);
2082 break;
2083 case T_IMEMO:
2084 switch (imemo_type(obj)) {
2085 case imemo_callcache: {
2086 const struct rb_callcache *cc = (const struct rb_callcache *)obj;
2087
2088 if (vm_cc_refinement_p(cc)) {
2089 rb_vm_delete_cc_refinement(cc);
2090 }
2091
2092 break;
2093 }
2094 case imemo_callinfo:
2095 rb_vm_ci_free((const struct rb_callinfo *)obj);
2096 break;
2097 case imemo_ment:
2098 rb_free_method_entry_vm_weak_references((const rb_method_entry_t *)obj);
2099 break;
2100 default:
2101 break;
2102 }
2103 break;
2104 default:
2105 break;
2106 }
2107}
2108
2109/*
2110 * call-seq:
2111 * ObjectSpace._id2ref(object_id) -> an_object
2112 *
2113 * Converts an object id to a reference to the object. May not be
2114 * called on an object id passed as a parameter to a finalizer.
2115 *
2116 * s = "I am a string" #=> "I am a string"
2117 * r = ObjectSpace._id2ref(s.object_id) #=> "I am a string"
2118 * r == s #=> true
2119 *
2120 * On multi-ractor mode, if the object is not shareable, it raises
2121 * RangeError.
2122 *
2123 * This method is deprecated and should no longer be used.
2124 */
2125
2126static VALUE
2127id2ref(VALUE objid)
2128{
2129 objid = rb_to_int(objid);
2130 if (FIXNUM_P(objid) || rb_big_size(objid) <= SIZEOF_VOIDP) {
2131 VALUE ptr = (VALUE)NUM2PTR(objid);
2132 if (SPECIAL_CONST_P(ptr)) {
2133 if (ptr == Qtrue) return Qtrue;
2134 if (ptr == Qfalse) return Qfalse;
2135 if (NIL_P(ptr)) return Qnil;
2136 if (FIXNUM_P(ptr)) return ptr;
2137 if (FLONUM_P(ptr)) return ptr;
2138
2139 if (SYMBOL_P(ptr)) {
2140 // Check that the symbol is valid
2141 if (rb_static_id_valid_p(SYM2ID(ptr))) {
2142 return ptr;
2143 }
2144 else {
2145 rb_raise(rb_eRangeError, "%p is not a symbol id value", (void *)ptr);
2146 }
2147 }
2148
2149 rb_raise(rb_eRangeError, "%+"PRIsVALUE" is not an id value", rb_int2str(objid, 10));
2150 }
2151 }
2152
2153 VALUE obj = object_id_to_ref(rb_gc_get_objspace(), objid);
2154 if (!rb_multi_ractor_p() || rb_ractor_shareable_p(obj)) {
2155 return obj;
2156 }
2157 else {
2158 rb_raise(rb_eRangeError, "%+"PRIsVALUE" is the id of an unshareable object on multi-ractor", rb_int2str(objid, 10));
2159 }
2160}
2161
2162/* :nodoc: */
2163static VALUE
2164os_id2ref(VALUE os, VALUE objid)
2165{
2166 rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "ObjectSpace._id2ref is deprecated");
2167 return id2ref(objid);
2168}
2169
2170static VALUE
2171rb_find_object_id(void *objspace, VALUE obj, VALUE (*get_heap_object_id)(VALUE))
2172{
2173 if (SPECIAL_CONST_P(obj)) {
2174#if SIZEOF_LONG == SIZEOF_VOIDP
2175 return LONG2NUM((SIGNED_VALUE)obj);
2176#else
2177 return LL2NUM((SIGNED_VALUE)obj);
2178#endif
2179 }
2180
2181 return get_heap_object_id(obj);
2182}
2183
2184static VALUE
2185nonspecial_obj_id(VALUE obj)
2186{
2187#if SIZEOF_LONG == SIZEOF_VOIDP
2188 return (VALUE)((SIGNED_VALUE)(obj)|FIXNUM_FLAG);
2189#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
2190 return LL2NUM((SIGNED_VALUE)(obj) / 2);
2191#else
2192# error not supported
2193#endif
2194}
2195
2196 VALUE
2197rb_memory_id(VALUE obj)
2198{
2199 return rb_find_object_id(NULL, obj, nonspecial_obj_id);
2200}
2201
2202/*
2203 * Document-method: __id__
2204 * Document-method: object_id
2205 *
2206 * call-seq:
2207 * obj.__id__ -> integer
2208 * obj.object_id -> integer
2209 *
2210 * Returns an integer identifier for +obj+.
2211 *
2212 * The same number will be returned on all calls to +object_id+ for a given
2213 * object, and no two active objects will share an id.
2214 *
2215 * Note: that some objects of builtin classes are reused for optimization.
2216 * This is the case for immediate values and frozen string literals.
2217 *
2218 * BasicObject implements +__id__+, Kernel implements +object_id+.
2219 *
2220 * Immediate values are not passed by reference but are passed by value:
2221 * +nil+, +true+, +false+, Fixnums, Symbols, and some Floats.
2222 *
2223 * Object.new.object_id == Object.new.object_id # => false
2224 * (21 * 2).object_id == (21 * 2).object_id # => true
2225 * "hello".object_id == "hello".object_id # => false
2226 * "hi".freeze.object_id == "hi".freeze.object_id # => true
2227 */
2228
2229 VALUE
2230rb_obj_id(VALUE obj)
2231{
2232 /* If obj is an immediate, the object ID is obj directly converted to a Numeric.
2233 * Otherwise, the object ID is a Numeric that is a non-zero multiple of
2234 * (RUBY_IMMEDIATE_MASK + 1) which guarantees that it does not collide with
2235 * any immediates. */
2236 return rb_find_object_id(rb_gc_get_objspace(), obj, object_id);
2237}
2238
2239bool
2240rb_obj_id_p(VALUE obj)
2241{
2242 return !RB_TYPE_P(obj, T_IMEMO) && rb_shape_obj_has_id(obj);
2243}
2244
2245/*
2246 * GC implementations should call this function before the GC phase that updates references
2247 * embedded in the machine code generated by JIT compilers. JIT compilers usually enforce the
2248 * "W^X" policy and protect the code memory from being modified during execution. This function
2249 * makes the code memory writeable.
2250 */
2251void
2252rb_gc_before_updating_jit_code(void)
2253{
2254#if USE_YJIT
2255 rb_yjit_mark_all_writeable();
2256#endif
2257}
2258
2259/*
2260 * GC implementations should call this function before the GC phase that updates references
2261 * embedded in the machine code generated by JIT compilers. This function makes the code memory
2262 * executable again.
2263 */
2264void
2265rb_gc_after_updating_jit_code(void)
2266{
2267#if USE_YJIT
2268 rb_yjit_mark_all_executable();
2269#endif
2270}
2271
2272static void
2273classext_memsize(rb_classext_t *ext, bool prime, VALUE box_value, void *arg)
2274{
2275 size_t *size = (size_t *)arg;
2276 size_t s = 0;
2277
2278 if (RCLASSEXT_M_TBL(ext)) {
2279 s += rb_id_table_memsize(RCLASSEXT_M_TBL(ext));
2280 }
2281 if (RCLASSEXT_CONST_TBL(ext)) {
2282 s += rb_id_table_memsize(RCLASSEXT_CONST_TBL(ext));
2283 }
2284 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
2285 s += (RCLASSEXT_SUPERCLASS_DEPTH(ext) + 1) * sizeof(VALUE);
2286 }
2287 if (!prime) {
2288 s += sizeof(rb_classext_t);
2289 }
2290 *size += s;
2291}
2292
2293static void
2294classext_superclasses_memsize(rb_classext_t *ext, bool prime, VALUE box_value, void *arg)
2295{
2296 size_t *size = (size_t *)arg;
2297 size_t array_size;
2298 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
2299 RUBY_ASSERT(prime);
2300 array_size = RCLASSEXT_SUPERCLASS_DEPTH(ext) + 1;
2301 *size += array_size * sizeof(VALUE);
2302 }
2303}
2304
2305size_t
2306rb_obj_memsize_of(VALUE obj)
2307{
2308 size_t size = 0;
2309
2310 if (SPECIAL_CONST_P(obj)) {
2311 return 0;
2312 }
2313
2314 switch (BUILTIN_TYPE(obj)) {
2315 case T_OBJECT:
2316 if (FL_TEST_RAW(obj, ROBJECT_HEAP)) {
2317 if (rb_shape_obj_too_complex_p(obj)) {
2318 size += rb_st_memsize(ROBJECT_FIELDS_HASH(obj));
2319 }
2320 else {
2321 size += ROBJECT_FIELDS_CAPACITY(obj) * sizeof(VALUE);
2322 }
2323 }
2324 break;
2325 case T_MODULE:
2326 case T_CLASS:
2327 rb_class_classext_foreach(obj, classext_memsize, (void *)&size);
2328 rb_class_classext_foreach(obj, classext_superclasses_memsize, (void *)&size);
2329 break;
2330 case T_ICLASS:
2331 if (RICLASS_OWNS_M_TBL_P(obj)) {
2332 if (RCLASS_M_TBL(obj)) {
2333 size += rb_id_table_memsize(RCLASS_M_TBL(obj));
2334 }
2335 }
2336 break;
2337 case T_STRING:
2338 size += rb_str_memsize(obj);
2339 break;
2340 case T_ARRAY:
2341 size += rb_ary_memsize(obj);
2342 break;
2343 case T_HASH:
2344 if (RHASH_ST_TABLE_P(obj)) {
2345 VM_ASSERT(RHASH_ST_TABLE(obj) != NULL);
2346 /* st_table is in the slot */
2347 size += st_memsize(RHASH_ST_TABLE(obj)) - sizeof(st_table);
2348 }
2349 break;
2350 case T_REGEXP:
2351 if (RREGEXP_PTR(obj)) {
2352 size += onig_memsize(RREGEXP_PTR(obj));
2353 }
2354 break;
2355 case T_DATA:
2356 size += rb_objspace_data_type_memsize(obj);
2357 break;
2358 case T_MATCH:
2359 {
2360 rb_matchext_t *rm = RMATCH_EXT(obj);
2361 size += onig_region_memsize(&rm->regs);
2362 size += sizeof(struct rmatch_offset) * rm->char_offset_num_allocated;
2363 }
2364 break;
2365 case T_FILE:
2366 if (RFILE(obj)->fptr) {
2367 size += rb_io_memsize(RFILE(obj)->fptr);
2368 }
2369 break;
2370 case T_RATIONAL:
2371 case T_COMPLEX:
2372 break;
2373 case T_IMEMO:
2374 size += rb_imemo_memsize(obj);
2375 break;
2376
2377 case T_FLOAT:
2378 case T_SYMBOL:
2379 break;
2380
2381 case T_BIGNUM:
2382 if (!(RBASIC(obj)->flags & BIGNUM_EMBED_FLAG) && BIGNUM_DIGITS(obj)) {
2383 size += BIGNUM_LEN(obj) * sizeof(BDIGIT);
2384 }
2385 break;
2386
2387 case T_NODE:
2388 UNEXPECTED_NODE(obj_memsize_of);
2389 break;
2390
2391 case T_STRUCT:
2392 if ((RBASIC(obj)->flags & RSTRUCT_EMBED_LEN_MASK) == 0 &&
2393 RSTRUCT(obj)->as.heap.ptr) {
2394 size += sizeof(VALUE) * RSTRUCT_LEN(obj);
2395 }
2396 break;
2397
2398 case T_ZOMBIE:
2399 case T_MOVED:
2400 break;
2401
2402 default:
2403 rb_bug("objspace/memsize_of(): unknown data type 0x%x(%p)",
2404 BUILTIN_TYPE(obj), (void*)obj);
2405 }
2406
2407 return size + rb_gc_obj_slot_size(obj);
2408}
2409
2410static int
2411set_zero(st_data_t key, st_data_t val, st_data_t arg)
2412{
2413 VALUE k = (VALUE)key;
2414 VALUE hash = (VALUE)arg;
2415 rb_hash_aset(hash, k, INT2FIX(0));
2416 return ST_CONTINUE;
2417}
2418
2419 struct count_objects_data {
2420 size_t counts[T_MASK+1];
2421 size_t freed;
2422 size_t total;
2423};
2424
2425static void
2426count_objects_i(VALUE obj, void *d)
2427{
2428 struct count_objects_data *data = (struct count_objects_data *)d;
2429
2430 if (RBASIC(obj)->flags) {
2431 data->counts[BUILTIN_TYPE(obj)]++;
2432 }
2433 else {
2434 data->freed++;
2435 }
2436
2437 data->total++;
2438}
2439
2440/*
2441 * call-seq:
2442 * ObjectSpace.count_objects([result_hash]) -> hash
2443 *
2444 * Counts all objects grouped by type.
2445 *
2446 * It returns a hash, such as:
2447 * {
2448 * :TOTAL=>10000,
2449 * :FREE=>3011,
2450 * :T_OBJECT=>6,
2451 * :T_CLASS=>404,
2452 * # ...
2453 * }
2454 *
2455 * The contents of the returned hash are implementation specific.
2456 * It may be changed in future.
2457 *
2458 * The keys starting with +:T_+ means live objects.
2459 * For example, +:T_ARRAY+ is the number of arrays.
2460 * +:FREE+ means object slots which is not used now.
2461 * +:TOTAL+ means sum of above.
2462 *
2463 * If the optional argument +result_hash+ is given,
2464 * it is overwritten and returned. This is intended to avoid probe effect.
2465 *
2466 * h = {}
2467 * ObjectSpace.count_objects(h)
2468 * puts h
2469 * # => { :TOTAL=>10000, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249 }
2470 *
2471 * This method is only expected to work on C Ruby.
2472 *
2473 */
2474
2475static VALUE
2476count_objects(int argc, VALUE *argv, VALUE os)
2477{
2478 struct count_objects_data data = { 0 };
2479 VALUE hash = Qnil;
2480 VALUE types[T_MASK + 1];
2481
2482 if (rb_check_arity(argc, 0, 1) == 1) {
2483 hash = argv[0];
2484 if (!RB_TYPE_P(hash, T_HASH))
2485 rb_raise(rb_eTypeError, "non-hash given");
2486 }
2487
2488 for (size_t i = 0; i <= T_MASK; i++) {
2489 // type_sym can allocate an object,
2490 // so we need to create all key symbols in advance
2491 // not to disturb the result
2492 types[i] = type_sym(i);
2493 }
2494
2495 // Same as type_sym, we need to create all key symbols in advance
2496 VALUE total = ID2SYM(rb_intern("TOTAL"));
2497 VALUE free = ID2SYM(rb_intern("FREE"));
2498
2499 rb_gc_impl_each_object(rb_gc_get_objspace(), count_objects_i, &data);
2500
2501 if (NIL_P(hash)) {
2502 hash = rb_hash_new();
2503 }
2504 else if (!RHASH_EMPTY_P(hash)) {
2505 rb_hash_stlike_foreach(hash, set_zero, hash);
2506 }
2507 rb_hash_aset(hash, total, SIZET2NUM(data.total));
2508 rb_hash_aset(hash, free, SIZET2NUM(data.freed));
2509
2510 for (size_t i = 0; i <= T_MASK; i++) {
2511 if (data.counts[i]) {
2512 rb_hash_aset(hash, types[i], SIZET2NUM(data.counts[i]));
2513 }
2514 }
2515
2516 return hash;
2517}
2518
2519#define SET_STACK_END SET_MACHINE_STACK_END(&ec->machine.stack_end)
2520
2521#define STACK_START (ec->machine.stack_start)
2522#define STACK_END (ec->machine.stack_end)
2523#define STACK_LEVEL_MAX (ec->machine.stack_maxsize/sizeof(VALUE))
2524
2525#if STACK_GROW_DIRECTION < 0
2526# define STACK_LENGTH (size_t)(STACK_START - STACK_END)
2527#elif STACK_GROW_DIRECTION > 0
2528# define STACK_LENGTH (size_t)(STACK_END - STACK_START + 1)
2529#else
2530# define STACK_LENGTH ((STACK_END < STACK_START) ? (size_t)(STACK_START - STACK_END) \
2531 : (size_t)(STACK_END - STACK_START + 1))
2532#endif
2533#if !STACK_GROW_DIRECTION
2534int ruby_stack_grow_direction;
2535int
2536ruby_get_stack_grow_direction(volatile VALUE *addr)
2537{
2538 VALUE *end;
2539 SET_MACHINE_STACK_END(&end);
2540
2541 if (end > addr) return ruby_stack_grow_direction = 1;
2542 return ruby_stack_grow_direction = -1;
2543}
2544#endif
2545
2546size_t
2547ruby_stack_length(VALUE **p)
2548{
2549 rb_execution_context_t *ec = GET_EC();
2550 SET_STACK_END;
2551 if (p) *p = STACK_UPPER(STACK_END, STACK_START, STACK_END);
2552 return STACK_LENGTH;
2553}
2554
2555#define PREVENT_STACK_OVERFLOW 1
2556#ifndef PREVENT_STACK_OVERFLOW
2557#if !(defined(POSIX_SIGNAL) && defined(SIGSEGV) && defined(HAVE_SIGALTSTACK))
2558# define PREVENT_STACK_OVERFLOW 1
2559#else
2560# define PREVENT_STACK_OVERFLOW 0
2561#endif
2562#endif
2563#if PREVENT_STACK_OVERFLOW && !defined(__EMSCRIPTEN__)
2564static int
2565stack_check(rb_execution_context_t *ec, int water_mark)
2566{
2567 SET_STACK_END;
2568
2569 size_t length = STACK_LENGTH;
2570 size_t maximum_length = STACK_LEVEL_MAX - water_mark;
2571
2572 return length > maximum_length;
2573}
2574#else
2575#define stack_check(ec, water_mark) FALSE
2576#endif
2577
2578#define STACKFRAME_FOR_CALL_CFUNC 2048
2579
2580int
2581rb_ec_stack_check(rb_execution_context_t *ec)
2582{
2583 return stack_check(ec, STACKFRAME_FOR_CALL_CFUNC);
2584}
2585
2586int
2587ruby_stack_check(void)
2588{
2589 return stack_check(GET_EC(), STACKFRAME_FOR_CALL_CFUNC);
2590}
2591
2592/* ==================== Marking ==================== */
2593
2594#define RB_GC_MARK_OR_TRAVERSE(func, obj_or_ptr, obj, check_obj) do { \
2595 if (!RB_SPECIAL_CONST_P(obj)) { \
2596 rb_vm_t *vm = GET_VM(); \
2597 void *objspace = vm->gc.objspace; \
2598 if (LIKELY(vm->gc.mark_func_data == NULL)) { \
2599 GC_ASSERT(rb_gc_impl_during_gc_p(objspace)); \
2600 (func)(objspace, (obj_or_ptr)); \
2601 } \
2602 else if (check_obj ? \
2603 rb_gc_impl_pointer_to_heap_p(objspace, (const void *)obj) && \
2604 !rb_gc_impl_garbage_object_p(objspace, obj) : \
2605 true) { \
2606 GC_ASSERT(!rb_gc_impl_during_gc_p(objspace)); \
2607 struct gc_mark_func_data_struct *mark_func_data = vm->gc.mark_func_data; \
2608 vm->gc.mark_func_data = NULL; \
2609 mark_func_data->mark_func((obj), mark_func_data->data); \
2610 vm->gc.mark_func_data = mark_func_data; \
2611 } \
2612 } \
2613} while (0)
2614
2615static inline void
2616gc_mark_internal(VALUE obj)
2617{
2618 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark, obj, obj, false);
2619}
2620
2621void
2622rb_gc_mark_movable(VALUE obj)
2623{
2624 gc_mark_internal(obj);
2625}
2626
2627void
2628rb_gc_mark_and_move(VALUE *ptr)
2629{
2630 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_and_move, ptr, *ptr, false);
2631}
2632
2633static inline void
2634gc_mark_and_pin_internal(VALUE obj)
2635{
2636 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_and_pin, obj, obj, false);
2637}
2638
2639void
2640rb_gc_mark(VALUE obj)
2641{
2642 gc_mark_and_pin_internal(obj);
2643}
2644
2645static inline void
2646gc_mark_maybe_internal(VALUE obj)
2647{
2648 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_maybe, obj, obj, true);
2649}
2650
2651void
2652rb_gc_mark_maybe(VALUE obj)
2653{
2654 gc_mark_maybe_internal(obj);
2655}
2656
2657void
2658rb_gc_mark_weak(VALUE *ptr)
2659{
2660 if (RB_SPECIAL_CONST_P(*ptr)) return;
2661
2662 rb_vm_t *vm = GET_VM();
2663 void *objspace = vm->gc.objspace;
2664 if (LIKELY(vm->gc.mark_func_data == NULL)) {
2665 GC_ASSERT(rb_gc_impl_during_gc_p(objspace));
2666
2667 rb_gc_impl_mark_weak(objspace, ptr);
2668 }
2669 else {
2670 GC_ASSERT(!rb_gc_impl_during_gc_p(objspace));
2671 }
2672}
2673
2674void
2675rb_gc_remove_weak(VALUE parent_obj, VALUE *ptr)
2676{
2677 rb_gc_impl_remove_weak(rb_gc_get_objspace(), parent_obj, ptr);
2678}
2679
2680ATTRIBUTE_NO_ADDRESS_SAFETY_ANALYSIS(static void each_location(register const VALUE *x, register long n, void (*cb)(VALUE, void *), void *data));
2681static void
2682each_location(register const VALUE *x, register long n, void (*cb)(VALUE, void *), void *data)
2683{
2684 VALUE v;
2685 while (n--) {
2686 v = *x;
2687 cb(v, data);
2688 x++;
2689 }
2690}
2691
2692static void
2693each_location_ptr(const VALUE *start, const VALUE *end, void (*cb)(VALUE, void *), void *data)
2694{
2695 if (end <= start) return;
2696 each_location(start, end - start, cb, data);
2697}
2698
2699static void
2700gc_mark_maybe_each_location(VALUE obj, void *data)
2701{
2702 gc_mark_maybe_internal(obj);
2703}
2704
2705void
2706rb_gc_mark_locations(const VALUE *start, const VALUE *end)
2707{
2708 each_location_ptr(start, end, gc_mark_maybe_each_location, NULL);
2709}
2710
2711void
2712rb_gc_mark_values(long n, const VALUE *values)
2713{
2714 for (long i = 0; i < n; i++) {
2715 gc_mark_internal(values[i]);
2716 }
2717}
2718
2719void
2720rb_gc_mark_vm_stack_values(long n, const VALUE *values)
2721{
2722 for (long i = 0; i < n; i++) {
2723 gc_mark_and_pin_internal(values[i]);
2724 }
2725}
2726
2727static int
2728mark_key(st_data_t key, st_data_t value, st_data_t data)
2729{
2730 gc_mark_and_pin_internal((VALUE)key);
2731
2732 return ST_CONTINUE;
2733}
2734
2735void
2736rb_mark_set(st_table *tbl)
2737{
2738 if (!tbl) return;
2739
2740 st_foreach(tbl, mark_key, (st_data_t)rb_gc_get_objspace());
2741}
2742
2743static int
2744mark_keyvalue(st_data_t key, st_data_t value, st_data_t data)
2745{
2746 gc_mark_internal((VALUE)key);
2747 gc_mark_internal((VALUE)value);
2748
2749 return ST_CONTINUE;
2750}
2751
2752static int
2753pin_key_pin_value(st_data_t key, st_data_t value, st_data_t data)
2754{
2755 gc_mark_and_pin_internal((VALUE)key);
2756 gc_mark_and_pin_internal((VALUE)value);
2757
2758 return ST_CONTINUE;
2759}
2760
2761static int
2762pin_key_mark_value(st_data_t key, st_data_t value, st_data_t data)
2763{
2764 gc_mark_and_pin_internal((VALUE)key);
2765 gc_mark_internal((VALUE)value);
2766
2767 return ST_CONTINUE;
2768}
2769
2770static void
2771mark_hash(VALUE hash)
2772{
2773 if (rb_hash_compare_by_id_p(hash)) {
2774 rb_hash_stlike_foreach(hash, pin_key_mark_value, 0);
2775 }
2776 else {
2777 rb_hash_stlike_foreach(hash, mark_keyvalue, 0);
2778 }
2779
2780 gc_mark_internal(RHASH(hash)->ifnone);
2781}
2782
2783void
2784rb_mark_hash(st_table *tbl)
2785{
2786 if (!tbl) return;
2787
2788 st_foreach(tbl, pin_key_pin_value, 0);
2789}
2790
2791static enum rb_id_table_iterator_result
2792mark_method_entry_i(VALUE me, void *objspace)
2793{
2794 gc_mark_internal(me);
2795
2796 return ID_TABLE_CONTINUE;
2797}
2798
2799static void
2800mark_m_tbl(void *objspace, struct rb_id_table *tbl)
2801{
2802 if (tbl) {
2803 rb_id_table_foreach_values(tbl, mark_method_entry_i, objspace);
2804 }
2805}
2806
2807static enum rb_id_table_iterator_result
2808mark_const_entry_i(VALUE value, void *objspace)
2809{
2810 const rb_const_entry_t *ce = (const rb_const_entry_t *)value;
2811
2812 if (!rb_gc_checking_shareable()) {
2813 gc_mark_internal(ce->value);
2814 gc_mark_internal(ce->file); // TODO: ce->file should be shareable?
2815 }
2816 return ID_TABLE_CONTINUE;
2817}
2818
2819static void
2820mark_const_tbl(rb_objspace_t *objspace, struct rb_id_table *tbl)
2821{
2822 if (!tbl) return;
2823 rb_id_table_foreach_values(tbl, mark_const_entry_i, objspace);
2824}
2825
2826#if STACK_GROW_DIRECTION < 0
2827#define GET_STACK_BOUNDS(start, end, appendix) ((start) = STACK_END, (end) = STACK_START)
2828#elif STACK_GROW_DIRECTION > 0
2829#define GET_STACK_BOUNDS(start, end, appendix) ((start) = STACK_START, (end) = STACK_END+(appendix))
2830#else
2831#define GET_STACK_BOUNDS(start, end, appendix) \
2832 ((STACK_END < STACK_START) ? \
2833 ((start) = STACK_END, (end) = STACK_START) : ((start) = STACK_START, (end) = STACK_END+(appendix)))
2834#endif
2835
2836static void
2837gc_mark_machine_stack_location_maybe(VALUE obj, void *data)
2838{
2839 gc_mark_maybe_internal(obj);
2840
2841#ifdef RUBY_ASAN_ENABLED
2842 const rb_execution_context_t *ec = (const rb_execution_context_t *)data;
2843 void *fake_frame_start;
2844 void *fake_frame_end;
2845 bool is_fake_frame = asan_get_fake_stack_extents(
2846 ec->machine.asan_fake_stack_handle, obj,
2847 ec->machine.stack_start, ec->machine.stack_end,
2848 &fake_frame_start, &fake_frame_end
2849 );
2850 if (is_fake_frame) {
2851 each_location_ptr(fake_frame_start, fake_frame_end, gc_mark_maybe_each_location, NULL);
2852 }
2853#endif
2854}
2855
2856static bool
2857gc_object_moved_p_internal(void *objspace, VALUE obj)
2858{
2859 if (SPECIAL_CONST_P(obj)) {
2860 return false;
2861 }
2862
2863 return rb_gc_impl_object_moved_p(objspace, obj);
2864}
2865
2866static VALUE
2867gc_location_internal(void *objspace, VALUE value)
2868{
2869 if (SPECIAL_CONST_P(value)) {
2870 return value;
2871 }
2872
2873 GC_ASSERT(rb_gc_impl_pointer_to_heap_p(objspace, (void *)value));
2874
2875 return rb_gc_impl_location(objspace, value);
2876}
2877
2878 VALUE
2879rb_gc_location(VALUE value)
2880{
2881 return gc_location_internal(rb_gc_get_objspace(), value);
2882}
2883
2884#if defined(__wasm__)
2885
2886
2887static VALUE *rb_stack_range_tmp[2];
2888
2889static void
2890rb_mark_locations(void *begin, void *end)
2891{
2892 rb_stack_range_tmp[0] = begin;
2893 rb_stack_range_tmp[1] = end;
2894}
2895
2896void
2897rb_gc_save_machine_context(void)
2898{
2899 // no-op
2900}
2901
2902# if defined(__EMSCRIPTEN__)
2903
2904static void
2905mark_current_machine_context(const rb_execution_context_t *ec)
2906{
2907 emscripten_scan_stack(rb_mark_locations);
2908 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2909
2910 emscripten_scan_registers(rb_mark_locations);
2911 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2912}
2913# else // use Asyncify version
2914
2915static void
2916mark_current_machine_context(rb_execution_context_t *ec)
2917{
2918 VALUE *stack_start, *stack_end;
2919 SET_STACK_END;
2920 GET_STACK_BOUNDS(stack_start, stack_end, 1);
2921 each_location_ptr(stack_start, stack_end, gc_mark_maybe_each_location, NULL);
2922
2923 rb_wasm_scan_locals(rb_mark_locations);
2924 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2925}
2926
2927# endif
2928
2929#else // !defined(__wasm__)
2930
2931void
2932rb_gc_save_machine_context(void)
2933{
2934 rb_thread_t *thread = GET_THREAD();
2935
2936 RB_VM_SAVE_MACHINE_CONTEXT(thread);
2937}
2938
2939
2940static void
2941mark_current_machine_context(const rb_execution_context_t *ec)
2942{
2943 rb_gc_mark_machine_context(ec);
2944}
2945#endif
2946
2947void
2948rb_gc_mark_machine_context(const rb_execution_context_t *ec)
2949{
2950 VALUE *stack_start, *stack_end;
2951
2952 GET_STACK_BOUNDS(stack_start, stack_end, 0);
2953 RUBY_DEBUG_LOG("ec->th:%u stack_start:%p stack_end:%p", rb_ec_thread_ptr(ec)->serial, stack_start, stack_end);
2954
2955 void *data =
2956#ifdef RUBY_ASAN_ENABLED
2957 /* gc_mark_machine_stack_location_maybe() uses data as const */
2958 (rb_execution_context_t *)ec;
2959#else
2960 NULL;
2961#endif
2962
2963 each_location_ptr(stack_start, stack_end, gc_mark_machine_stack_location_maybe, data);
2964 int num_regs = sizeof(ec->machine.regs)/(sizeof(VALUE));
2965 each_location((VALUE*)&ec->machine.regs, num_regs, gc_mark_machine_stack_location_maybe, data);
2966}
2967
2968static int
2969rb_mark_tbl_i(st_data_t key, st_data_t value, st_data_t data)
2970{
2971 gc_mark_and_pin_internal((VALUE)value);
2972
2973 return ST_CONTINUE;
2974}
2975
2976void
2977rb_mark_tbl(st_table *tbl)
2978{
2979 if (!tbl || tbl->num_entries == 0) return;
2980
2981 st_foreach(tbl, rb_mark_tbl_i, 0);
2982}
2983
2984static void
2985gc_mark_tbl_no_pin(st_table *tbl)
2986{
2987 if (!tbl || tbl->num_entries == 0) return;
2988
2989 st_foreach(tbl, gc_mark_tbl_no_pin_i, 0);
2990}
2991
2992void
2993rb_mark_tbl_no_pin(st_table *tbl)
2994{
2995 gc_mark_tbl_no_pin(tbl);
2996}
2997
2998static bool
2999gc_declarative_marking_p(const rb_data_type_t *type)
3000{
3001 return (type->flags & RUBY_TYPED_DECL_MARKING) != 0;
3002}
3003
3004void
3005rb_gc_mark_roots(void *objspace, const char **categoryp)
3006{
3007 rb_execution_context_t *ec = GET_EC();
3008 rb_vm_t *vm = rb_ec_vm_ptr(ec);
3009
3010#define MARK_CHECKPOINT(category) do { \
3011 if (categoryp) *categoryp = category; \
3012} while (0)
3013
3014 MARK_CHECKPOINT("vm");
3015 rb_vm_mark(vm);
3016
3017 MARK_CHECKPOINT("end_proc");
3018 rb_mark_end_proc();
3019
3020 MARK_CHECKPOINT("global_tbl");
3021 rb_gc_mark_global_tbl();
3022
3023#if USE_YJIT
3024 void rb_yjit_root_mark(void); // in Rust
3025
3026 if (rb_yjit_enabled_p) {
3027 MARK_CHECKPOINT("YJIT");
3028 rb_yjit_root_mark();
3029 }
3030#endif
3031
3032#if USE_ZJIT
3033 void rb_zjit_root_mark(void);
3034 if (rb_zjit_enabled_p) {
3035 MARK_CHECKPOINT("ZJIT");
3036 rb_zjit_root_mark();
3037 }
3038#endif
3039
3040 MARK_CHECKPOINT("machine_context");
3041 mark_current_machine_context(ec);
3042
3043 MARK_CHECKPOINT("global_symbols");
3044 rb_sym_global_symbols_mark_and_move();
3045
3046 MARK_CHECKPOINT("finish");
3047
3048#undef MARK_CHECKPOINT
3049}
3050
3051 struct gc_mark_classext_foreach_arg {
3052 rb_objspace_t *objspace;
3053 VALUE obj;
3054};
3055
3056static void
3057gc_mark_classext_module(rb_classext_t *ext, bool prime, VALUE box_value, void *arg)
3058{
3059 struct gc_mark_classext_foreach_arg *foreach_arg = (struct gc_mark_classext_foreach_arg *)arg;
3060 rb_objspace_t *objspace = foreach_arg->objspace;
3061
3062 if (RCLASSEXT_SUPER(ext)) {
3063 gc_mark_internal(RCLASSEXT_SUPER(ext));
3064 }
3065 mark_m_tbl(objspace, RCLASSEXT_M_TBL(ext));
3066
3067 if (!rb_gc_checking_shareable()) {
3068 // unshareable
3069 gc_mark_internal(RCLASSEXT_FIELDS_OBJ(ext));
3070 gc_mark_internal(RCLASSEXT_CVC_TBL(ext));
3071 }
3072
3073 if (!RCLASSEXT_SHARED_CONST_TBL(ext) && RCLASSEXT_CONST_TBL(ext)) {
3074 mark_const_tbl(objspace, RCLASSEXT_CONST_TBL(ext));
3075 }
3076 mark_m_tbl(objspace, RCLASSEXT_CALLABLE_M_TBL(ext));
3077 gc_mark_internal(RCLASSEXT_CC_TBL(ext));
3078 gc_mark_internal(RCLASSEXT_CLASSPATH(ext));
3079}
3080
3081static void
3082gc_mark_classext_iclass(rb_classext_t *ext, bool prime, VALUE box_value, void *arg)
3083{
3084 struct gc_mark_classext_foreach_arg *foreach_arg = (struct gc_mark_classext_foreach_arg *)arg;
3085 rb_objspace_t *objspace = foreach_arg->objspace;
3086
3087 if (RCLASSEXT_SUPER(ext)) {
3088 gc_mark_internal(RCLASSEXT_SUPER(ext));
3089 }
3090 if (RCLASSEXT_ICLASS_IS_ORIGIN(ext) && !RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext)) {
3091 mark_m_tbl(objspace, RCLASSEXT_M_TBL(ext));
3092 }
3093 if (RCLASSEXT_INCLUDER(ext)) {
3094 gc_mark_internal(RCLASSEXT_INCLUDER(ext));
3095 }
3096 mark_m_tbl(objspace, RCLASSEXT_CALLABLE_M_TBL(ext));
3097 gc_mark_internal(RCLASSEXT_CC_TBL(ext));
3098}
3099
3100#define TYPED_DATA_REFS_OFFSET_LIST(d) (size_t *)(uintptr_t)RTYPEDDATA_TYPE(d)->function.dmark
3101
3102void
3103rb_gc_mark_children(void *objspace, VALUE obj)
3104{
3105 struct gc_mark_classext_foreach_arg foreach_args;
3106
3107 if (rb_obj_gen_fields_p(obj)) {
3108 rb_mark_generic_ivar(obj);
3109 }
3110
3111 switch (BUILTIN_TYPE(obj)) {
3112 case T_FLOAT:
3113 case T_BIGNUM:
3114 return;
3115
3116 case T_NIL:
3117 case T_FIXNUM:
3118 rb_bug("rb_gc_mark() called for broken object");
3119 break;
3120
3121 case T_NODE:
3122 UNEXPECTED_NODE(rb_gc_mark);
3123 break;
3124
3125 case T_IMEMO:
3126 rb_imemo_mark_and_move(obj, false);
3127 return;
3128
3129 default:
3130 break;
3131 }
3132
3133 gc_mark_internal(RBASIC(obj)->klass);
3134
3135 switch (BUILTIN_TYPE(obj)) {
3136 case T_CLASS:
3137 if (FL_TEST_RAW(obj, FL_SINGLETON) &&
3138 !rb_gc_checking_shareable()) {
3139 gc_mark_internal(RCLASS_ATTACHED_OBJECT(obj));
3140 }
3141 // Continue to the shared T_CLASS/T_MODULE
3142 case T_MODULE:
3143 foreach_args.objspace = objspace;
3144 foreach_args.obj = obj;
3145 rb_class_classext_foreach(obj, gc_mark_classext_module, (void *)&foreach_args);
3146 if (BOX_USER_P(RCLASS_PRIME_BOX(obj))) {
3147 gc_mark_internal(RCLASS_PRIME_BOX(obj)->box_object);
3148 }
3149 break;
3150
3151 case T_ICLASS:
3152 foreach_args.objspace = objspace;
3153 foreach_args.obj = obj;
3154 rb_class_classext_foreach(obj, gc_mark_classext_iclass, (void *)&foreach_args);
3155 if (BOX_USER_P(RCLASS_PRIME_BOX(obj))) {
3156 gc_mark_internal(RCLASS_PRIME_BOX(obj)->box_object);
3157 }
3158 break;
3159
3160 case T_ARRAY:
3161 if (ARY_SHARED_P(obj)) {
3162 VALUE root = ARY_SHARED_ROOT(obj);
3163 gc_mark_internal(root);
3164 }
3165 else {
3166 long len = RARRAY_LEN(obj);
3167 const VALUE *ptr = RARRAY_CONST_PTR(obj);
3168 for (long i = 0; i < len; i++) {
3169 gc_mark_internal(ptr[i]);
3170 }
3171 }
3172 break;
3173
3174 case T_HASH:
3175 mark_hash(obj);
3176 break;
3177
3178 case T_SYMBOL:
3179 gc_mark_internal(RSYMBOL(obj)->fstr);
3180 break;
3181
3182 case T_STRING:
3183 if (STR_SHARED_P(obj)) {
3184 if (STR_EMBED_P(RSTRING(obj)->as.heap.aux.shared)) {
3185 /* Embedded shared strings cannot be moved because this string
3186 * points into the slot of the shared string. There may be code
3187 * using the RSTRING_PTR on the stack, which would pin this
3188 * string but not pin the shared string, causing it to move. */
3189 gc_mark_and_pin_internal(RSTRING(obj)->as.heap.aux.shared);
3190 }
3191 else {
3192 gc_mark_internal(RSTRING(obj)->as.heap.aux.shared);
3193 }
3194 }
3195 break;
3196
3197 case T_DATA: {
3198 bool typed_data = RTYPEDDATA_P(obj);
3199 void *const ptr = typed_data ? RTYPEDDATA_GET_DATA(obj) : DATA_PTR(obj);
3200
3201 if (typed_data) {
3202 gc_mark_internal(RTYPEDDATA(obj)->fields_obj);
3203 }
3204
3205 if (ptr) {
3206 if (typed_data && gc_declarative_marking_p(RTYPEDDATA_TYPE(obj))) {
3207 size_t *offset_list = TYPED_DATA_REFS_OFFSET_LIST(obj);
3208
3209 for (size_t offset = *offset_list; offset != RUBY_REF_END; offset = *offset_list++) {
3210 gc_mark_internal(*(VALUE *)((char *)ptr + offset));
3211 }
3212 }
3213 else {
3214 RUBY_DATA_FUNC mark_func = typed_data ?
3215 RTYPEDDATA_TYPE(obj)->function.dmark :
3216 RDATA(obj)->dmark;
3217 if (mark_func) (*mark_func)(ptr);
3218 }
3219 }
3220
3221 break;
3222 }
3223
3224 case T_OBJECT: {
3225 uint32_t len;
3226 if (rb_shape_obj_too_complex_p(obj)) {
3227 gc_mark_tbl_no_pin(ROBJECT_FIELDS_HASH(obj));
3228 len = ROBJECT_FIELDS_COUNT_COMPLEX(obj);
3229 }
3230 else {
3231 const VALUE * const ptr = ROBJECT_FIELDS(obj);
3232
3233 len = ROBJECT_FIELDS_COUNT_NOT_COMPLEX(obj);
3234 for (uint32_t i = 0; i < len; i++) {
3235 gc_mark_internal(ptr[i]);
3236 }
3237 }
3238
3239 attr_index_t fields_count = (attr_index_t)len;
3240 if (fields_count) {
3241 VALUE klass = RBASIC_CLASS(obj);
3242
3243 // Increment max_iv_count if applicable, used to determine size pool allocation
3244 if (RCLASS_MAX_IV_COUNT(klass) < fields_count) {
3245 RCLASS_SET_MAX_IV_COUNT(klass, fields_count);
3246 }
3247 }
3248
3249 break;
3250 }
3251
3252 case T_FILE:
3253 if (RFILE(obj)->fptr) {
3254 gc_mark_internal(RFILE(obj)->fptr->self);
3255 gc_mark_internal(RFILE(obj)->fptr->pathv);
3256 gc_mark_internal(RFILE(obj)->fptr->tied_io_for_writing);
3257 gc_mark_internal(RFILE(obj)->fptr->writeconv_asciicompat);
3258 gc_mark_internal(RFILE(obj)->fptr->writeconv_pre_ecopts);
3259 gc_mark_internal(RFILE(obj)->fptr->encs.ecopts);
3260 gc_mark_internal(RFILE(obj)->fptr->write_lock);
3261 gc_mark_internal(RFILE(obj)->fptr->timeout);
3262 gc_mark_internal(RFILE(obj)->fptr->wakeup_mutex);
3263 }
3264 break;
3265
3266 case T_REGEXP:
3267 gc_mark_internal(RREGEXP(obj)->src);
3268 break;
3269
3270 case T_MATCH:
3271 gc_mark_internal(RMATCH(obj)->regexp);
3272 if (RMATCH(obj)->str) {
3273 gc_mark_internal(RMATCH(obj)->str);
3274 }
3275 break;
3276
3277 case T_RATIONAL:
3278 gc_mark_internal(RRATIONAL(obj)->num);
3279 gc_mark_internal(RRATIONAL(obj)->den);
3280 break;
3281
3282 case T_COMPLEX:
3283 gc_mark_internal(RCOMPLEX(obj)->real);
3284 gc_mark_internal(RCOMPLEX(obj)->imag);
3285 break;
3286
3287 case T_STRUCT: {
3288 const long len = RSTRUCT_LEN(obj);
3289 const VALUE * const ptr = RSTRUCT_CONST_PTR(obj);
3290
3291 for (long i = 0; i < len; i++) {
3292 gc_mark_internal(ptr[i]);
3293 }
3294
3295 if (rb_shape_obj_has_fields(obj) && !FL_TEST_RAW(obj, RSTRUCT_GEN_FIELDS)) {
3296 gc_mark_internal(RSTRUCT_FIELDS_OBJ(obj));
3297 }
3298
3299 break;
3300 }
3301
3302 default:
3303 if (BUILTIN_TYPE(obj) == T_MOVED) rb_bug("rb_gc_mark(): %p is T_MOVED", (void *)obj);
3304 if (BUILTIN_TYPE(obj) == T_NONE) rb_bug("rb_gc_mark(): %p is T_NONE", (void *)obj);
3305 if (BUILTIN_TYPE(obj) == T_ZOMBIE) rb_bug("rb_gc_mark(): %p is T_ZOMBIE", (void *)obj);
3306 rb_bug("rb_gc_mark(): unknown data type 0x%x(%p) %s",
3307 BUILTIN_TYPE(obj), (void *)obj,
3308 rb_gc_impl_pointer_to_heap_p(objspace, (void *)obj) ? "corrupted object" : "non object");
3309 }
3310}
3311
3312size_t
3313rb_gc_obj_optimal_size(VALUE obj)
3314{
3315 switch (BUILTIN_TYPE(obj)) {
3316 case T_ARRAY:
3317 {
3318 size_t size = rb_ary_size_as_embedded(obj);
3319 if (rb_gc_size_allocatable_p(size)) {
3320 return size;
3321 }
3322 else {
3323 return sizeof(struct RArray);
3324 }
3325 }
3326
3327 case T_OBJECT:
3328 if (rb_shape_obj_too_complex_p(obj)) {
3329 return sizeof(struct RObject);
3330 }
3331 else {
3332 size_t size = rb_obj_embedded_size(ROBJECT_FIELDS_CAPACITY(obj));
3333 if (rb_gc_size_allocatable_p(size)) {
3334 return size;
3335 }
3336 else {
3337 return sizeof(struct RObject);
3338 }
3339 }
3340
3341 case T_STRING:
3342 {
3343 size_t size = rb_str_size_as_embedded(obj);
3344 if (rb_gc_size_allocatable_p(size)) {
3345 return size;
3346 }
3347 else {
3348 return sizeof(struct RString);
3349 }
3350 }
3351
3352 case T_HASH:
3353 return sizeof(struct RHash) + (RHASH_ST_TABLE_P(obj) ? sizeof(st_table) : sizeof(ar_table));
3354
3355 default:
3356 return 0;
3357 }
3358}
3359
3360void
3361rb_gc_writebarrier(VALUE a, VALUE b)
3362{
3363 rb_gc_impl_writebarrier(rb_gc_get_objspace(), a, b);
3364}
3365
3366void
3367rb_gc_writebarrier_unprotect(VALUE obj)
3368{
3369 rb_gc_impl_writebarrier_unprotect(rb_gc_get_objspace(), obj);
3370}
3371
3372/*
3373 * remember `obj' if needed.
3374 */
3375void
3376rb_gc_writebarrier_remember(VALUE obj)
3377{
3378 rb_gc_impl_writebarrier_remember(rb_gc_get_objspace(), obj);
3379}
3380
3381void
3382rb_gc_copy_attributes(VALUE dest, VALUE obj)
3383{
3384 rb_gc_impl_copy_attributes(rb_gc_get_objspace(), dest, obj);
3385}
3386
3387int
3388rb_gc_modular_gc_loaded_p(void)
3389{
3390#if USE_MODULAR_GC
3391 return rb_gc_functions.modular_gc_loaded_p;
3392#else
3393 return false;
3394#endif
3395}
3396
3397const char *
3398rb_gc_active_gc_name(void)
3399{
3400 const char *gc_name = rb_gc_impl_active_gc_name();
3401
3402 const size_t len = strlen(gc_name);
3403 if (len > RB_GC_MAX_NAME_LEN) {
3404 rb_bug("GC should have a name no more than %d chars long. Currently: %zu (%s)",
3405 RB_GC_MAX_NAME_LEN, len, gc_name);
3406 }
3407
3408 return gc_name;
3409}
3410
3411struct rb_gc_object_metadata_entry *
3412rb_gc_object_metadata(VALUE obj)
3413{
3414 return rb_gc_impl_object_metadata(rb_gc_get_objspace(), obj);
3415}
3416
3417/* GC */
3418
3419void *
3420rb_gc_ractor_cache_alloc(rb_ractor_t *ractor)
3421{
3422 return rb_gc_impl_ractor_cache_alloc(rb_gc_get_objspace(), ractor);
3423}
3424
3425void
3426rb_gc_ractor_cache_free(void *cache)
3427{
3428 rb_gc_impl_ractor_cache_free(rb_gc_get_objspace(), cache);
3429}
3430
3431void
3432rb_gc_register_mark_object(VALUE obj)
3433{
3434 if (!rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (void *)obj))
3435 return;
3436
3437 rb_vm_register_global_object(obj);
3438}
3439
3440void
3441rb_gc_register_address(VALUE *addr)
3442{
3443 rb_vm_t *vm = GET_VM();
3444
3445 VALUE obj = *addr;
3446
3447 struct global_object_list *tmp = ALLOC(struct global_object_list);
3448 tmp->next = vm->global_object_list;
3449 tmp->varptr = addr;
3450 vm->global_object_list = tmp;
3451
3452 /*
3453 * Because some C extensions have assignment-then-register bugs,
3454 * we guard `obj` here so that it would not get swept defensively.
3455 */
3456 RB_GC_GUARD(obj);
3457 if (0 && !SPECIAL_CONST_P(obj)) {
3458 rb_warn("Object is assigned to registering address already: %"PRIsVALUE,
3459 rb_obj_class(obj));
3460 rb_print_backtrace(stderr);
3461 }
3462}
3463
3464void
3465rb_gc_unregister_address(VALUE *addr)
3466{
3467 rb_vm_t *vm = GET_VM();
3468 struct global_object_list *tmp = vm->global_object_list;
3469
3470 if (tmp->varptr == addr) {
3471 vm->global_object_list = tmp->next;
3472 xfree(tmp);
3473 return;
3474 }
3475 while (tmp->next) {
3476 if (tmp->next->varptr == addr) {
3477 struct global_object_list *t = tmp->next;
3478
3479 tmp->next = tmp->next->next;
3480 xfree(t);
3481 break;
3482 }
3483 tmp = tmp->next;
3484 }
3485}
3486
3487void
3488 rb_global_variable(VALUE *var)
3489{
3490 rb_gc_register_address(var);
3491}
3492
3493static VALUE
3494gc_start_internal(rb_execution_context_t *ec, VALUE self, VALUE full_mark, VALUE immediate_mark, VALUE immediate_sweep, VALUE compact)
3495{
3496 rb_gc_impl_start(rb_gc_get_objspace(), RTEST(full_mark), RTEST(immediate_mark), RTEST(immediate_sweep), RTEST(compact));
3497
3498 return Qnil;
3499}
3500
3501/*
3502 * rb_objspace_each_objects() is special C API to walk through
3503 * Ruby object space. This C API is too difficult to use it.
3504 * To be frank, you should not use it. Or you need to read the
3505 * source code of this function and understand what this function does.
3506 *
3507 * 'callback' will be called several times (the number of heap page,
3508 * at current implementation) with:
3509 * vstart: a pointer to the first living object of the heap_page.
3510 * vend: a pointer to next to the valid heap_page area.
3511 * stride: a distance to next VALUE.
3512 *
3513 * If callback() returns non-zero, the iteration will be stopped.
3514 *
3515 * This is a sample callback code to iterate liveness objects:
3516 *
3517 * static int
3518 * sample_callback(void *vstart, void *vend, int stride, void *data)
3519 * {
3520 * VALUE v = (VALUE)vstart;
3521 * for (; v != (VALUE)vend; v += stride) {
3522 * if (!rb_objspace_internal_object_p(v)) { // liveness check
3523 * // do something with live object 'v'
3524 * }
3525 * }
3526 * return 0; // continue to iteration
3527 * }
3528 *
3529 * Note: 'vstart' is not a top of heap_page. This point the first
3530 * living object to grasp at least one object to avoid GC issue.
3531 * This means that you can not walk through all Ruby object page
3532 * including freed object page.
3533 *
3534 * Note: On this implementation, 'stride' is the same as sizeof(RVALUE).
3535 * However, there are possibilities to pass variable values with
3536 * 'stride' with some reasons. You must use stride instead of
3537 * use some constant value in the iteration.
3538 */
3539void
3540rb_objspace_each_objects(int (*callback)(void *, void *, size_t, void *), void *data)
3541{
3542 rb_gc_impl_each_objects(rb_gc_get_objspace(), callback, data);
3543}
3544
3545static void
3546gc_ref_update_array(void *objspace, VALUE v)
3547{
3548 if (ARY_SHARED_P(v)) {
3549 VALUE old_root = RARRAY(v)->as.heap.aux.shared_root;
3550
3551 UPDATE_IF_MOVED(objspace, RARRAY(v)->as.heap.aux.shared_root);
3552
3553 VALUE new_root = RARRAY(v)->as.heap.aux.shared_root;
3554 // If the root is embedded and its location has changed
3555 if (ARY_EMBED_P(new_root) && new_root != old_root) {
3556 size_t offset = (size_t)(RARRAY(v)->as.heap.ptr - RARRAY(old_root)->as.ary);
3557 GC_ASSERT(RARRAY(v)->as.heap.ptr >= RARRAY(old_root)->as.ary);
3558 RARRAY(v)->as.heap.ptr = RARRAY(new_root)->as.ary + offset;
3559 }
3560 }
3561 else {
3562 long len = RARRAY_LEN(v);
3563
3564 if (len > 0) {
3565 VALUE *ptr = (VALUE *)RARRAY_CONST_PTR(v);
3566 for (long i = 0; i < len; i++) {
3567 UPDATE_IF_MOVED(objspace, ptr[i]);
3568 }
3569 }
3570
3571 if (rb_gc_obj_slot_size(v) >= rb_ary_size_as_embedded(v)) {
3572 if (rb_ary_embeddable_p(v)) {
3573 rb_ary_make_embedded(v);
3574 }
3575 }
3576 }
3577}
3578
3579static void
3580gc_ref_update_object(void *objspace, VALUE v)
3581{
3582 VALUE *ptr = ROBJECT_FIELDS(v);
3583
3584 if (FL_TEST_RAW(v, ROBJECT_HEAP)) {
3585 if (rb_shape_obj_too_complex_p(v)) {
3586 gc_ref_update_table_values_only(ROBJECT_FIELDS_HASH(v));
3587 return;
3588 }
3589
3590 size_t slot_size = rb_gc_obj_slot_size(v);
3591 size_t embed_size = rb_obj_embedded_size(ROBJECT_FIELDS_CAPACITY(v));
3592 if (slot_size >= embed_size) {
3593 // Object can be re-embedded
3594 memcpy(ROBJECT(v)->as.ary, ptr, sizeof(VALUE) * ROBJECT_FIELDS_COUNT(v));
3595 FL_UNSET_RAW(v, ROBJECT_HEAP);
3596 xfree(ptr);
3597 ptr = ROBJECT(v)->as.ary;
3598 }
3599 }
3600
3601 for (uint32_t i = 0; i < ROBJECT_FIELDS_COUNT(v); i++) {
3602 UPDATE_IF_MOVED(objspace, ptr[i]);
3603 }
3604}
3605
3606void
3607rb_gc_ref_update_table_values_only(st_table *tbl)
3608{
3609 gc_ref_update_table_values_only(tbl);
3610}
3611
3612/* Update MOVED references in a VALUE=>VALUE st_table */
3613void
3614rb_gc_update_tbl_refs(st_table *ptr)
3615{
3616 gc_update_table_refs(ptr);
3617}
3618
3619static void
3620gc_ref_update_hash(void *objspace, VALUE v)
3621{
3622 rb_hash_stlike_foreach_with_replace(v, hash_foreach_replace, hash_replace_ref, (st_data_t)objspace);
3623}
3624
3625static void
3626gc_update_values(void *objspace, long n, VALUE *values)
3627{
3628 for (long i = 0; i < n; i++) {
3629 UPDATE_IF_MOVED(objspace, values[i]);
3630 }
3631}
3632
3633void
3634rb_gc_update_values(long n, VALUE *values)
3635{
3636 gc_update_values(rb_gc_get_objspace(), n, values);
3637}
3638
3639static enum rb_id_table_iterator_result
3640check_id_table_move(VALUE value, void *data)
3641{
3642 void *objspace = (void *)data;
3643
3644 if (gc_object_moved_p_internal(objspace, (VALUE)value)) {
3645 return ID_TABLE_REPLACE;
3646 }
3647
3648 return ID_TABLE_CONTINUE;
3649}
3650
3651void
3652rb_gc_prepare_heap_process_object(VALUE obj)
3653{
3654 switch (BUILTIN_TYPE(obj)) {
3655 case T_STRING:
3656 // Precompute the string coderange. This both save time for when it will be
3657 // eventually needed, and avoid mutating heap pages after a potential fork.
3658 rb_enc_str_coderange(obj);
3659 break;
3660 default:
3661 break;
3662 }
3663}
3664
3665void
3666rb_gc_prepare_heap(void)
3667{
3668 rb_gc_impl_prepare_heap(rb_gc_get_objspace());
3669}
3670
3671size_t
3672rb_gc_heap_id_for_size(size_t size)
3673{
3674 return rb_gc_impl_heap_id_for_size(rb_gc_get_objspace(), size);
3675}
3676
3677bool
3678rb_gc_size_allocatable_p(size_t size)
3679{
3680 return rb_gc_impl_size_allocatable_p(size);
3681}
3682
3683static enum rb_id_table_iterator_result
3684update_id_table(VALUE *value, void *data, int existing)
3685{
3686 void *objspace = (void *)data;
3687
3688 if (gc_object_moved_p_internal(objspace, (VALUE)*value)) {
3689 *value = gc_location_internal(objspace, (VALUE)*value);
3690 }
3691
3692 return ID_TABLE_CONTINUE;
3693}
3694
3695static void
3696update_m_tbl(void *objspace, struct rb_id_table *tbl)
3697{
3698 if (tbl) {
3699 rb_id_table_foreach_values_with_replace(tbl, check_id_table_move, update_id_table, objspace);
3700 }
3701}
3702
3703static enum rb_id_table_iterator_result
3704update_const_tbl_i(VALUE value, void *objspace)
3705{
3706 rb_const_entry_t *ce = (rb_const_entry_t *)value;
3707
3708 if (gc_object_moved_p_internal(objspace, ce->value)) {
3709 ce->value = gc_location_internal(objspace, ce->value);
3710 }
3711
3712 if (gc_object_moved_p_internal(objspace, ce->file)) {
3713 ce->file = gc_location_internal(objspace, ce->file);
3714 }
3715
3716 return ID_TABLE_CONTINUE;
3717}
3718
3719static void
3720update_const_tbl(void *objspace, struct rb_id_table *tbl)
3721{
3722 if (!tbl) return;
3723 rb_id_table_foreach_values(tbl, update_const_tbl_i, objspace);
3724}
3725
3726static void
3727update_subclasses(void *objspace, rb_classext_t *ext)
3728{
3729 rb_subclass_entry_t *entry = RCLASSEXT_SUBCLASSES(ext);
3730 if (!entry) return;
3731 while (entry) {
3732 if (entry->klass)
3733 UPDATE_IF_MOVED(objspace, entry->klass);
3734 entry = entry->next;
3735 }
3736}
3737
3738static void
3739update_superclasses(rb_objspace_t *objspace, rb_classext_t *ext)
3740{
3741 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
3742 size_t array_size = RCLASSEXT_SUPERCLASS_DEPTH(ext) + 1;
3743 for (size_t i = 0; i < array_size; i++) {
3744 UPDATE_IF_MOVED(objspace, RCLASSEXT_SUPERCLASSES(ext)[i]);
3745 }
3746 }
3747}
3748
3749static void
3750update_classext_values(rb_objspace_t *objspace, rb_classext_t *ext, bool is_iclass)
3751{
3752 UPDATE_IF_MOVED(objspace, RCLASSEXT_ORIGIN(ext));
3753 UPDATE_IF_MOVED(objspace, RCLASSEXT_REFINED_CLASS(ext));
3754 UPDATE_IF_MOVED(objspace, RCLASSEXT_CLASSPATH(ext));
3755 if (is_iclass) {
3756 UPDATE_IF_MOVED(objspace, RCLASSEXT_INCLUDER(ext));
3757 }
3758}
3759
3760static void
3761update_classext(rb_classext_t *ext, bool is_prime, VALUE box_value, void *arg)
3762{
3763 struct classext_foreach_args *args = (struct classext_foreach_args *)arg;
3764 rb_objspace_t *objspace = args->objspace;
3765
3766 if (RCLASSEXT_SUPER(ext)) {
3767 UPDATE_IF_MOVED(objspace, RCLASSEXT_SUPER(ext));
3768 }
3769
3770 update_m_tbl(objspace, RCLASSEXT_M_TBL(ext));
3771
3772 UPDATE_IF_MOVED(objspace, ext->fields_obj);
3773 if (!RCLASSEXT_SHARED_CONST_TBL(ext)) {
3774 update_const_tbl(objspace, RCLASSEXT_CONST_TBL(ext));
3775 }
3776 UPDATE_IF_MOVED(objspace, RCLASSEXT_CC_TBL(ext));
3777 UPDATE_IF_MOVED(objspace, RCLASSEXT_CVC_TBL(ext));
3778 update_superclasses(objspace, ext);
3779 update_subclasses(objspace, ext);
3780
3781 update_classext_values(objspace, ext, false);
3782}
3783
3784static void
3785update_iclass_classext(rb_classext_t *ext, bool is_prime, VALUE box_value, void *arg)
3786{
3787 struct classext_foreach_args *args = (struct classext_foreach_args *)arg;
3788 rb_objspace_t *objspace = args->objspace;
3789
3790 if (RCLASSEXT_SUPER(ext)) {
3791 UPDATE_IF_MOVED(objspace, RCLASSEXT_SUPER(ext));
3792 }
3793 update_m_tbl(objspace, RCLASSEXT_M_TBL(ext));
3794 update_m_tbl(objspace, RCLASSEXT_CALLABLE_M_TBL(ext));
3795 UPDATE_IF_MOVED(objspace, RCLASSEXT_CC_TBL(ext));
3796 UPDATE_IF_MOVED(objspace, RCLASSEXT_CVC_TBL(ext));
3797 update_subclasses(objspace, ext);
3798
3799 update_classext_values(objspace, ext, true);
3800}
3801
3802 struct global_vm_table_foreach_data {
3803 vm_table_foreach_callback_func callback;
3804 vm_table_update_callback_func update_callback;
3805 void *data;
3806 bool weak_only;
3807};
3808
3809static int
3810vm_weak_table_foreach_weak_key(st_data_t key, st_data_t value, st_data_t data, int error)
3811{
3812 struct global_vm_table_foreach_data *iter_data = (struct global_vm_table_foreach_data *)data;
3813
3814 int ret = iter_data->callback((VALUE)key, iter_data->data);
3815
3816 if (!iter_data->weak_only) {
3817 if (ret != ST_CONTINUE) return ret;
3818
3819 ret = iter_data->callback((VALUE)value, iter_data->data);
3820 }
3821
3822 return ret;
3823}
3824
3825static int
3826vm_weak_table_foreach_update_weak_key(st_data_t *key, st_data_t *value, st_data_t data, int existing)
3827{
3828 struct global_vm_table_foreach_data *iter_data = (struct global_vm_table_foreach_data *)data;
3829
3830 int ret = iter_data->update_callback((VALUE *)key, iter_data->data);
3831
3832 if (!iter_data->weak_only) {
3833 if (ret != ST_CONTINUE) return ret;
3834
3835 ret = iter_data->update_callback((VALUE *)value, iter_data->data);
3836 }
3837
3838 return ret;
3839}
3840
3841static int
3842vm_weak_table_cc_refinement_foreach(st_data_t key, st_data_t data, int error)
3843{
3844 struct global_vm_table_foreach_data *iter_data = (struct global_vm_table_foreach_data *)data;
3845
3846 return iter_data->callback((VALUE)key, iter_data->data);
3847}
3848
3849static int
3850vm_weak_table_cc_refinement_foreach_update_update(st_data_t *key, st_data_t data, int existing)
3851{
3852 struct global_vm_table_foreach_data *iter_data = (struct global_vm_table_foreach_data *)data;
3853
3854 return iter_data->update_callback((VALUE *)key, iter_data->data);
3855}
3856
3857
3858static int
3859vm_weak_table_sym_set_foreach(VALUE *sym_ptr, void *data)
3860{
3861 VALUE sym = *sym_ptr;
3862 struct global_vm_table_foreach_data *iter_data = (struct global_vm_table_foreach_data *)data;
3863
3864 if (RB_SPECIAL_CONST_P(sym)) return ST_CONTINUE;
3865
3866 int ret = iter_data->callback(sym, iter_data->data);
3867
3868 if (ret == ST_REPLACE) {
3869 ret = iter_data->update_callback(sym_ptr, iter_data->data);
3870 }
3871
3872 return ret;
3873}
3874
3875struct st_table *rb_generic_fields_tbl_get(void);
3876
3877static int
3878vm_weak_table_id2ref_foreach(st_data_t key, st_data_t value, st_data_t data, int error)
3879{
3880 struct global_vm_table_foreach_data *iter_data = (struct global_vm_table_foreach_data *)data;
3881
3882 if (!iter_data->weak_only && !FIXNUM_P((VALUE)key)) {
3883 int ret = iter_data->callback((VALUE)key, iter_data->data);
3884 if (ret != ST_CONTINUE) return ret;
3885 }
3886
3887 return iter_data->callback((VALUE)value, iter_data->data);
3888}
3889
3890static int
3891vm_weak_table_id2ref_foreach_update(st_data_t *key, st_data_t *value, st_data_t data, int existing)
3892{
3893 struct global_vm_table_foreach_data *iter_data = (struct global_vm_table_foreach_data *)data;
3894
3895 iter_data->update_callback((VALUE *)value, iter_data->data);
3896
3897 if (!iter_data->weak_only && !FIXNUM_P((VALUE)*key)) {
3898 iter_data->update_callback((VALUE *)key, iter_data->data);
3899 }
3900
3901 return ST_CONTINUE;
3902}
3903
3904static int
3905vm_weak_table_gen_fields_foreach(st_data_t key, st_data_t value, st_data_t data)
3906{
3907 struct global_vm_table_foreach_data *iter_data = (struct global_vm_table_foreach_data *)data;
3908
3909 int ret = iter_data->callback((VALUE)key, iter_data->data);
3910
3911 VALUE new_value = (VALUE)value;
3912 VALUE new_key = (VALUE)key;
3913
3914 switch (ret) {
3915 case ST_CONTINUE:
3916 break;
3917
3918 case ST_DELETE:
3919 RBASIC_SET_SHAPE_ID((VALUE)key, ROOT_SHAPE_ID);
3920 return ST_DELETE;
3921
3922 case ST_REPLACE: {
3923 ret = iter_data->update_callback(&new_key, iter_data->data);
3924 if (key != new_key) {
3925 ret = ST_DELETE;
3926 }
3927 break;
3928 }
3929
3930 default:
3931 rb_bug("vm_weak_table_gen_fields_foreach: return value %d not supported", ret);
3932 }
3933
3934 if (!iter_data->weak_only) {
3935 int ivar_ret = iter_data->callback(new_value, iter_data->data);
3936 switch (ivar_ret) {
3937 case ST_CONTINUE:
3938 break;
3939
3940 case ST_REPLACE:
3941 iter_data->update_callback(&new_value, iter_data->data);
3942 break;
3943
3944 default:
3945 rb_bug("vm_weak_table_gen_fields_foreach: return value %d not supported", ivar_ret);
3946 }
3947 }
3948
3949 if (key != new_key || value != new_value) {
3950 DURING_GC_COULD_MALLOC_REGION_START();
3951 {
3952 st_insert(rb_generic_fields_tbl_get(), (st_data_t)new_key, new_value);
3953 }
3954 DURING_GC_COULD_MALLOC_REGION_END();
3955 }
3956
3957 return ret;
3958}
3959
3960static int
3961vm_weak_table_frozen_strings_foreach(VALUE *str, void *data)
3962{
3963 // int retval = vm_weak_table_foreach_weak_key(key, value, data, error);
3964 struct global_vm_table_foreach_data *iter_data = (struct global_vm_table_foreach_data *)data;
3965 int retval = iter_data->callback(*str, iter_data->data);
3966
3967 if (retval == ST_REPLACE) {
3968 retval = iter_data->update_callback(str, iter_data->data);
3969 }
3970
3971 if (retval == ST_DELETE) {
3972 FL_UNSET(*str, RSTRING_FSTR);
3973 }
3974
3975 return retval;
3976}
3977
3978void rb_fstring_foreach_with_replace(int (*callback)(VALUE *str, void *data), void *data);
3979void
3980rb_gc_vm_weak_table_foreach(vm_table_foreach_callback_func callback,
3981 vm_table_update_callback_func update_callback,
3982 void *data,
3983 bool weak_only,
3984 enum rb_gc_vm_weak_tables table)
3985{
3986 rb_vm_t *vm = GET_VM();
3987
3988 struct global_vm_table_foreach_data foreach_data = {
3989 .callback = callback,
3990 .update_callback = update_callback,
3991 .data = data,
3992 .weak_only = weak_only,
3993 };
3994
3995 switch (table) {
3996 case RB_GC_VM_CI_TABLE: {
3997 if (vm->ci_table) {
3998 st_foreach_with_replace(
3999 vm->ci_table,
4000 vm_weak_table_foreach_weak_key,
4001 vm_weak_table_foreach_update_weak_key,
4002 (st_data_t)&foreach_data
4003 );
4004 }
4005 break;
4006 }
4007 case RB_GC_VM_OVERLOADED_CME_TABLE: {
4008 if (vm->overloaded_cme_table) {
4009 st_foreach_with_replace(
4010 vm->overloaded_cme_table,
4011 vm_weak_table_foreach_weak_key,
4012 vm_weak_table_foreach_update_weak_key,
4013 (st_data_t)&foreach_data
4014 );
4015 }
4016 break;
4017 }
4018 case RB_GC_VM_GLOBAL_SYMBOLS_TABLE: {
4019 rb_sym_global_symbol_table_foreach_weak_reference(
4020 vm_weak_table_sym_set_foreach,
4021 &foreach_data
4022 );
4023 break;
4024 }
4025 case RB_GC_VM_ID2REF_TABLE: {
4026 if (id2ref_tbl) {
4027 st_foreach_with_replace(
4028 id2ref_tbl,
4029 vm_weak_table_id2ref_foreach,
4030 vm_weak_table_id2ref_foreach_update,
4031 (st_data_t)&foreach_data
4032 );
4033 }
4034 break;
4035 }
4036 case RB_GC_VM_GENERIC_FIELDS_TABLE: {
4037 st_table *generic_fields_tbl = rb_generic_fields_tbl_get();
4038 if (generic_fields_tbl) {
4039 st_foreach(
4040 generic_fields_tbl,
4041 vm_weak_table_gen_fields_foreach,
4042 (st_data_t)&foreach_data
4043 );
4044 }
4045 break;
4046 }
4047 case RB_GC_VM_FROZEN_STRINGS_TABLE: {
4048 rb_fstring_foreach_with_replace(
4049 vm_weak_table_frozen_strings_foreach,
4050 &foreach_data
4051 );
4052 break;
4053 }
4054 case RB_GC_VM_CC_REFINEMENT_TABLE: {
4055 if (vm->cc_refinement_table) {
4056 set_foreach_with_replace(
4057 vm->cc_refinement_table,
4058 vm_weak_table_cc_refinement_foreach,
4059 vm_weak_table_cc_refinement_foreach_update_update,
4060 (st_data_t)&foreach_data
4061 );
4062 }
4063 break;
4064 }
4065 case RB_GC_VM_WEAK_TABLE_COUNT:
4066 rb_bug("Unreachable");
4067 default:
4068 rb_bug("rb_gc_vm_weak_table_foreach: unknown table %d", table);
4069 }
4070}
4071
4072void
4073rb_gc_update_vm_references(void *objspace)
4074{
4075 rb_execution_context_t *ec = GET_EC();
4076 rb_vm_t *vm = rb_ec_vm_ptr(ec);
4077
4078 rb_vm_update_references(vm);
4079 rb_gc_update_global_tbl();
4080 rb_sym_global_symbols_mark_and_move();
4081
4082#if USE_YJIT
4083 void rb_yjit_root_update_references(void); // in Rust
4084
4085 if (rb_yjit_enabled_p) {
4086 rb_yjit_root_update_references();
4087 }
4088#endif
4089
4090#if USE_ZJIT
4091 void rb_zjit_root_update_references(void); // in Rust
4092
4093 if (rb_zjit_enabled_p) {
4094 rb_zjit_root_update_references();
4095 }
4096#endif
4097}
4098
4099void
4100rb_gc_update_object_references(void *objspace, VALUE obj)
4101{
4102 struct classext_foreach_args args;
4103
4104 switch (BUILTIN_TYPE(obj)) {
4105 case T_CLASS:
4106 if (FL_TEST_RAW(obj, FL_SINGLETON)) {
4107 UPDATE_IF_MOVED(objspace, RCLASS_ATTACHED_OBJECT(obj));
4108 }
4109 // Continue to the shared T_CLASS/T_MODULE
4110 case T_MODULE:
4111 args.klass = obj;
4112 args.objspace = objspace;
4113 rb_class_classext_foreach(obj, update_classext, (void *)&args);
4114 break;
4115
4116 case T_ICLASS:
4117 args.objspace = objspace;
4118 rb_class_classext_foreach(obj, update_iclass_classext, (void *)&args);
4119 break;
4120
4121 case T_IMEMO:
4122 rb_imemo_mark_and_move(obj, true);
4123 return;
4124
4125 case T_NIL:
4126 case T_FIXNUM:
4127 case T_NODE:
4128 case T_MOVED:
4129 case T_NONE:
4130 /* These can't move */
4131 return;
4132
4133 case T_ARRAY:
4134 gc_ref_update_array(objspace, obj);
4135 break;
4136
4137 case T_HASH:
4138 gc_ref_update_hash(objspace, obj);
4139 UPDATE_IF_MOVED(objspace, RHASH(obj)->ifnone);
4140 break;
4141
4142 case T_STRING:
4143 {
4144 if (STR_SHARED_P(obj)) {
4145 UPDATE_IF_MOVED(objspace, RSTRING(obj)->as.heap.aux.shared);
4146 }
4147
4148 /* If, after move the string is not embedded, and can fit in the
4149 * slot it's been placed in, then re-embed it. */
4150 if (rb_gc_obj_slot_size(obj) >= rb_str_size_as_embedded(obj)) {
4151 if (!STR_EMBED_P(obj) && rb_str_reembeddable_p(obj)) {
4152 rb_str_make_embedded(obj);
4153 }
4154 }
4155
4156 break;
4157 }
4158 case T_DATA:
4159 /* Call the compaction callback, if it exists */
4160 {
4161 bool typed_data = RTYPEDDATA_P(obj);
4162 void *const ptr = typed_data ? RTYPEDDATA_GET_DATA(obj) : DATA_PTR(obj);
4163
4164 if (typed_data) {
4165 UPDATE_IF_MOVED(objspace, RTYPEDDATA(obj)->fields_obj);
4166 }
4167
4168 if (ptr) {
4169 if (typed_data && gc_declarative_marking_p(RTYPEDDATA_TYPE(obj))) {
4170 size_t *offset_list = TYPED_DATA_REFS_OFFSET_LIST(obj);
4171
4172 for (size_t offset = *offset_list; offset != RUBY_REF_END; offset = *offset_list++) {
4173 VALUE *ref = (VALUE *)((char *)ptr + offset);
4174 *ref = gc_location_internal(objspace, *ref);
4175 }
4176 }
4177 else if (typed_data) {
4178 RUBY_DATA_FUNC compact_func = RTYPEDDATA_TYPE(obj)->function.dcompact;
4179 if (compact_func) (*compact_func)(ptr);
4180 }
4181 }
4182 }
4183 break;
4184
4185 case T_OBJECT:
4186 gc_ref_update_object(objspace, obj);
4187 break;
4188
4189 case T_FILE:
4190 if (RFILE(obj)->fptr) {
4191 UPDATE_IF_MOVED(objspace, RFILE(obj)->fptr->self);
4192 UPDATE_IF_MOVED(objspace, RFILE(obj)->fptr->pathv);
4193 UPDATE_IF_MOVED(objspace, RFILE(obj)->fptr->tied_io_for_writing);
4194 UPDATE_IF_MOVED(objspace, RFILE(obj)->fptr->writeconv_asciicompat);
4195 UPDATE_IF_MOVED(objspace, RFILE(obj)->fptr->writeconv_pre_ecopts);
4196 UPDATE_IF_MOVED(objspace, RFILE(obj)->fptr->encs.ecopts);
4197 UPDATE_IF_MOVED(objspace, RFILE(obj)->fptr->write_lock);
4198 UPDATE_IF_MOVED(objspace, RFILE(obj)->fptr->timeout);
4199 UPDATE_IF_MOVED(objspace, RFILE(obj)->fptr->wakeup_mutex);
4200 }
4201 break;
4202 case T_REGEXP:
4203 UPDATE_IF_MOVED(objspace, RREGEXP(obj)->src);
4204 break;
4205
4206 case T_SYMBOL:
4207 UPDATE_IF_MOVED(objspace, RSYMBOL(obj)->fstr);
4208 break;
4209
4210 case T_FLOAT:
4211 case T_BIGNUM:
4212 break;
4213
4214 case T_MATCH:
4215 UPDATE_IF_MOVED(objspace, RMATCH(obj)->regexp);
4216
4217 if (RMATCH(obj)->str) {
4218 UPDATE_IF_MOVED(objspace, RMATCH(obj)->str);
4219 }
4220 break;
4221
4222 case T_RATIONAL:
4223 UPDATE_IF_MOVED(objspace, RRATIONAL(obj)->num);
4224 UPDATE_IF_MOVED(objspace, RRATIONAL(obj)->den);
4225 break;
4226
4227 case T_COMPLEX:
4228 UPDATE_IF_MOVED(objspace, RCOMPLEX(obj)->real);
4229 UPDATE_IF_MOVED(objspace, RCOMPLEX(obj)->imag);
4230
4231 break;
4232
4233 case T_STRUCT:
4234 {
4235 long i, len = RSTRUCT_LEN(obj);
4236 VALUE *ptr = (VALUE *)RSTRUCT_CONST_PTR(obj);
4237
4238 for (i = 0; i < len; i++) {
4239 UPDATE_IF_MOVED(objspace, ptr[i]);
4240 }
4241
4242 if (RSTRUCT_EMBED_LEN(obj)) {
4243 if (!FL_TEST_RAW(obj, RSTRUCT_GEN_FIELDS)) {
4244 UPDATE_IF_MOVED(objspace, ptr[len]);
4245 }
4246 }
4247 else {
4248 UPDATE_IF_MOVED(objspace, RSTRUCT(obj)->as.heap.fields_obj);
4249 }
4250 }
4251 break;
4252 default:
4253 rb_bug("unreachable");
4254 break;
4255 }
4256
4257 UPDATE_IF_MOVED(objspace, RBASIC(obj)->klass);
4258}
4259
4260 VALUE
4261rb_gc_start(void)
4262{
4263 rb_gc();
4264 return Qnil;
4265}
4266
4267void
4268rb_gc(void)
4269{
4270 unless_objspace(objspace) { return; }
4271
4272 rb_gc_impl_start(objspace, true, true, true, false);
4273}
4274
4275int
4276rb_during_gc(void)
4277{
4278 unless_objspace(objspace) { return FALSE; }
4279
4280 return rb_gc_impl_during_gc_p(objspace);
4281}
4282
4283size_t
4284rb_gc_count(void)
4285{
4286 return rb_gc_impl_gc_count(rb_gc_get_objspace());
4287}
4288
4289static VALUE
4290gc_count(rb_execution_context_t *ec, VALUE self)
4291{
4292 return SIZET2NUM(rb_gc_count());
4293}
4294
4295 VALUE
4296rb_gc_latest_gc_info(VALUE key)
4297{
4298 if (!SYMBOL_P(key) && !RB_TYPE_P(key, T_HASH)) {
4299 rb_raise(rb_eTypeError, "non-hash or symbol given");
4300 }
4301
4302 VALUE val = rb_gc_impl_latest_gc_info(rb_gc_get_objspace(), key);
4303
4304 if (val == Qundef) {
4305 rb_raise(rb_eArgError, "unknown key: %"PRIsVALUE, rb_sym2str(key));
4306 }
4307
4308 return val;
4309}
4310
4311static VALUE
4312gc_stat(rb_execution_context_t *ec, VALUE self, VALUE arg) // arg is (nil || hash || symbol)
4313{
4314 if (NIL_P(arg)) {
4315 arg = rb_hash_new();
4316 }
4317 else if (!RB_TYPE_P(arg, T_HASH) && !SYMBOL_P(arg)) {
4318 rb_raise(rb_eTypeError, "non-hash or symbol given");
4319 }
4320
4321 VALUE ret = rb_gc_impl_stat(rb_gc_get_objspace(), arg);
4322
4323 if (ret == Qundef) {
4324 GC_ASSERT(SYMBOL_P(arg));
4325
4326 rb_raise(rb_eArgError, "unknown key: %"PRIsVALUE, rb_sym2str(arg));
4327 }
4328
4329 return ret;
4330}
4331
4332size_t
4333rb_gc_stat(VALUE arg)
4334{
4335 if (!RB_TYPE_P(arg, T_HASH) && !SYMBOL_P(arg)) {
4336 rb_raise(rb_eTypeError, "non-hash or symbol given");
4337 }
4338
4339 VALUE ret = rb_gc_impl_stat(rb_gc_get_objspace(), arg);
4340
4341 if (ret == Qundef) {
4342 GC_ASSERT(SYMBOL_P(arg));
4343
4344 rb_raise(rb_eArgError, "unknown key: %"PRIsVALUE, rb_sym2str(arg));
4345 }
4346
4347 if (SYMBOL_P(arg)) {
4348 return NUM2SIZET(ret);
4349 }
4350 else {
4351 return 0;
4352 }
4353}
4354
4355static VALUE
4356gc_stat_heap(rb_execution_context_t *ec, VALUE self, VALUE heap_name, VALUE arg)
4357{
4358 if (NIL_P(arg)) {
4359 arg = rb_hash_new();
4360 }
4361
4362 if (NIL_P(heap_name)) {
4363 if (!RB_TYPE_P(arg, T_HASH)) {
4364 rb_raise(rb_eTypeError, "non-hash given");
4365 }
4366 }
4367 else if (FIXNUM_P(heap_name)) {
4368 if (!SYMBOL_P(arg) && !RB_TYPE_P(arg, T_HASH)) {
4369 rb_raise(rb_eTypeError, "non-hash or symbol given");
4370 }
4371 }
4372 else {
4373 rb_raise(rb_eTypeError, "heap_name must be nil or an Integer");
4374 }
4375
4376 VALUE ret = rb_gc_impl_stat_heap(rb_gc_get_objspace(), heap_name, arg);
4377
4378 if (ret == Qundef) {
4379 GC_ASSERT(SYMBOL_P(arg));
4380
4381 rb_raise(rb_eArgError, "unknown key: %"PRIsVALUE, rb_sym2str(arg));
4382 }
4383
4384 return ret;
4385}
4386
4387static VALUE
4388gc_config_get(rb_execution_context_t *ec, VALUE self)
4389{
4390 VALUE cfg_hash = rb_gc_impl_config_get(rb_gc_get_objspace());
4391 rb_hash_aset(cfg_hash, sym("implementation"), rb_fstring_cstr(rb_gc_impl_active_gc_name()));
4392
4393 return cfg_hash;
4394}
4395
4396static VALUE
4397gc_config_set(rb_execution_context_t *ec, VALUE self, VALUE hash)
4398{
4399 void *objspace = rb_gc_get_objspace();
4400
4401 rb_gc_impl_config_set(objspace, hash);
4402
4403 return Qnil;
4404}
4405
4406static VALUE
4407gc_stress_get(rb_execution_context_t *ec, VALUE self)
4408{
4409 return rb_gc_impl_stress_get(rb_gc_get_objspace());
4410}
4411
4412static VALUE
4413gc_stress_set_m(rb_execution_context_t *ec, VALUE self, VALUE flag)
4414{
4415 rb_gc_impl_stress_set(rb_gc_get_objspace(), flag);
4416
4417 return flag;
4418}
4419
4420void
4421rb_gc_initial_stress_set(VALUE flag)
4422{
4423 initial_stress = flag;
4424}
4425
4426size_t *
4427rb_gc_heap_sizes(void)
4428{
4429 return rb_gc_impl_heap_sizes(rb_gc_get_objspace());
4430}
4431
4432 VALUE
4433rb_gc_enable(void)
4434{
4435 return rb_objspace_gc_enable(rb_gc_get_objspace());
4436}
4437
4438 VALUE
4439rb_objspace_gc_enable(void *objspace)
4440{
4441 bool disabled = !rb_gc_impl_gc_enabled_p(objspace);
4442 rb_gc_impl_gc_enable(objspace);
4443 return RBOOL(disabled);
4444}
4445
4446static VALUE
4447gc_enable(rb_execution_context_t *ec, VALUE _)
4448{
4449 return rb_gc_enable();
4450}
4451
4452static VALUE
4453gc_disable_no_rest(void *objspace)
4454{
4455 bool disabled = !rb_gc_impl_gc_enabled_p(objspace);
4456 rb_gc_impl_gc_disable(objspace, false);
4457 return RBOOL(disabled);
4458}
4459
4460 VALUE
4461rb_gc_disable_no_rest(void)
4462{
4463 return gc_disable_no_rest(rb_gc_get_objspace());
4464}
4465
4466 VALUE
4467rb_gc_disable(void)
4468{
4469 return rb_objspace_gc_disable(rb_gc_get_objspace());
4470}
4471
4472 VALUE
4473rb_objspace_gc_disable(void *objspace)
4474{
4475 bool disabled = !rb_gc_impl_gc_enabled_p(objspace);
4476 rb_gc_impl_gc_disable(objspace, true);
4477 return RBOOL(disabled);
4478}
4479
4480static VALUE
4481gc_disable(rb_execution_context_t *ec, VALUE _)
4482{
4483 return rb_gc_disable();
4484}
4485
4486// TODO: think about moving ruby_gc_set_params into Init_heap or Init_gc
4487void
4488ruby_gc_set_params(void)
4489{
4490 rb_gc_impl_set_params(rb_gc_get_objspace());
4491}
4492
4493void
4494rb_objspace_reachable_objects_from(VALUE obj, void (func)(VALUE, void *), void *data)
4495{
4496 RB_VM_LOCKING() {
4497 if (rb_gc_impl_during_gc_p(rb_gc_get_objspace())) rb_bug("rb_objspace_reachable_objects_from() is not supported while during GC");
4498
4499 if (!RB_SPECIAL_CONST_P(obj)) {
4500 rb_vm_t *vm = GET_VM();
4501 struct gc_mark_func_data_struct *prev_mfd = vm->gc.mark_func_data;
4502 struct gc_mark_func_data_struct mfd = {
4503 .mark_func = func,
4504 .data = data,
4505 };
4506
4507 vm->gc.mark_func_data = &mfd;
4508 rb_gc_mark_children(rb_gc_get_objspace(), obj);
4509 vm->gc.mark_func_data = prev_mfd;
4510 }
4511 }
4512}
4513
4514 struct root_objects_data {
4515 const char *category;
4516 void (*func)(const char *category, VALUE, void *);
4517 void *data;
4518};
4519
4520static void
4521root_objects_from(VALUE obj, void *ptr)
4522{
4523 const struct root_objects_data *data = (struct root_objects_data *)ptr;
4524 (*data->func)(data->category, obj, data->data);
4525}
4526
4527void
4528rb_objspace_reachable_objects_from_root(void (func)(const char *category, VALUE, void *), void *passing_data)
4529{
4530 if (rb_gc_impl_during_gc_p(rb_gc_get_objspace())) rb_bug("rb_gc_impl_objspace_reachable_objects_from_root() is not supported while during GC");
4531
4532 rb_vm_t *vm = GET_VM();
4533
4534 struct root_objects_data data = {
4535 .func = func,
4536 .data = passing_data,
4537 };
4538
4539 struct gc_mark_func_data_struct *prev_mfd = vm->gc.mark_func_data;
4540 struct gc_mark_func_data_struct mfd = {
4541 .mark_func = root_objects_from,
4542 .data = &data,
4543 };
4544
4545 vm->gc.mark_func_data = &mfd;
4546 rb_gc_save_machine_context();
4547 rb_gc_mark_roots(vm->gc.objspace, &data.category);
4548 vm->gc.mark_func_data = prev_mfd;
4549}
4550
4551/*
4552 ------------------------------ DEBUG ------------------------------
4553*/
4554
4555static const char *
4556type_name(int type, VALUE obj)
4557{
4558 switch (type) {
4559#define TYPE_NAME(t) case (t): return #t;
4560 TYPE_NAME(T_NONE);
4561 TYPE_NAME(T_OBJECT);
4562 TYPE_NAME(T_CLASS);
4563 TYPE_NAME(T_MODULE);
4564 TYPE_NAME(T_FLOAT);
4565 TYPE_NAME(T_STRING);
4566 TYPE_NAME(T_REGEXP);
4567 TYPE_NAME(T_ARRAY);
4568 TYPE_NAME(T_HASH);
4569 TYPE_NAME(T_STRUCT);
4570 TYPE_NAME(T_BIGNUM);
4571 TYPE_NAME(T_FILE);
4572 TYPE_NAME(T_MATCH);
4573 TYPE_NAME(T_COMPLEX);
4574 TYPE_NAME(T_RATIONAL);
4575 TYPE_NAME(T_NIL);
4576 TYPE_NAME(T_TRUE);
4577 TYPE_NAME(T_FALSE);
4578 TYPE_NAME(T_SYMBOL);
4579 TYPE_NAME(T_FIXNUM);
4580 TYPE_NAME(T_UNDEF);
4581 TYPE_NAME(T_IMEMO);
4582 TYPE_NAME(T_ICLASS);
4583 TYPE_NAME(T_MOVED);
4584 TYPE_NAME(T_ZOMBIE);
4585 case T_DATA:
4586 if (obj && rb_objspace_data_type_name(obj)) {
4587 return rb_objspace_data_type_name(obj);
4588 }
4589 return "T_DATA";
4590#undef TYPE_NAME
4591 }
4592 return "unknown";
4593}
4594
4595static const char *
4596obj_type_name(VALUE obj)
4597{
4598 return type_name(TYPE(obj), obj);
4599}
4600
4601const char *
4602rb_method_type_name(rb_method_type_t type)
4603{
4604 switch (type) {
4605 case VM_METHOD_TYPE_ISEQ: return "iseq";
4606 case VM_METHOD_TYPE_ATTRSET: return "attrest";
4607 case VM_METHOD_TYPE_IVAR: return "ivar";
4608 case VM_METHOD_TYPE_BMETHOD: return "bmethod";
4609 case VM_METHOD_TYPE_ALIAS: return "alias";
4610 case VM_METHOD_TYPE_REFINED: return "refined";
4611 case VM_METHOD_TYPE_CFUNC: return "cfunc";
4612 case VM_METHOD_TYPE_ZSUPER: return "zsuper";
4613 case VM_METHOD_TYPE_MISSING: return "missing";
4614 case VM_METHOD_TYPE_OPTIMIZED: return "optimized";
4615 case VM_METHOD_TYPE_UNDEF: return "undef";
4616 case VM_METHOD_TYPE_NOTIMPLEMENTED: return "notimplemented";
4617 }
4618 rb_bug("rb_method_type_name: unreachable (type: %d)", type);
4619}
4620
4621static void
4622rb_raw_iseq_info(char *const buff, const size_t buff_size, const rb_iseq_t *iseq)
4623{
4624 if (buff_size > 0 && ISEQ_BODY(iseq) && ISEQ_BODY(iseq)->location.label && !RB_TYPE_P(ISEQ_BODY(iseq)->location.pathobj, T_MOVED)) {
4625 VALUE path = rb_iseq_path(iseq);
4626 int n = ISEQ_BODY(iseq)->location.first_lineno;
4627 snprintf(buff, buff_size, " %s@%s:%d",
4628 RSTRING_PTR(ISEQ_BODY(iseq)->location.label),
4629 RSTRING_PTR(path), n);
4630 }
4631}
4632
4633static int
4634str_len_no_raise(VALUE str)
4635{
4636 long len = RSTRING_LEN(str);
4637 if (len < 0) return 0;
4638 if (len > INT_MAX) return INT_MAX;
4639 return (int)len;
4640}
4641
4642#define BUFF_ARGS buff + pos, buff_size - pos
4643#define APPEND_F(...) if ((pos += snprintf(BUFF_ARGS, "" __VA_ARGS__)) >= buff_size) goto end
4644#define APPEND_S(s) do { \
4645 if ((pos + (int)rb_strlen_lit(s)) >= buff_size) { \
4646 goto end; \
4647 } \
4648 else { \
4649 memcpy(buff + pos, (s), rb_strlen_lit(s) + 1); \
4650 } \
4651 } while (0)
4652#define C(c, s) ((c) != 0 ? (s) : " ")
4653
4654static size_t
4655rb_raw_obj_info_common(char *const buff, const size_t buff_size, const VALUE obj)
4656{
4657 size_t pos = 0;
4658
4659 if (SPECIAL_CONST_P(obj)) {
4660 APPEND_F("%s", obj_type_name(obj));
4661
4662 if (FIXNUM_P(obj)) {
4663 APPEND_F(" %ld", FIX2LONG(obj));
4664 }
4665 else if (SYMBOL_P(obj)) {
4666 APPEND_F(" %s", rb_id2name(SYM2ID(obj)));
4667 }
4668 }
4669 else {
4670 // const int age = RVALUE_AGE_GET(obj);
4671
4672 if (rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (void *)obj)) {
4673 APPEND_F("%p %s/", (void *)obj, obj_type_name(obj));
4674 // TODO: fixme
4675 // APPEND_F("%p [%d%s%s%s%s%s%s] %s ",
4676 // (void *)obj, age,
4677 // C(RVALUE_UNCOLLECTIBLE_BITMAP(obj), "L"),
4678 // C(RVALUE_MARK_BITMAP(obj), "M"),
4679 // C(RVALUE_PIN_BITMAP(obj), "P"),
4680 // C(RVALUE_MARKING_BITMAP(obj), "R"),
4681 // C(RVALUE_WB_UNPROTECTED_BITMAP(obj), "U"),
4682 // C(rb_objspace_garbage_object_p(obj), "G"),
4683 // obj_type_name(obj));
4684 }
4685 else {
4686 /* fake */
4687 // APPEND_F("%p [%dXXXX] %s",
4688 // (void *)obj, age,
4689 // obj_type_name(obj));
4690 }
4691
4692 if (internal_object_p(obj)) {
4693 /* ignore */
4694 }
4695 else if (RBASIC(obj)->klass == 0) {
4696 APPEND_S("(temporary internal)");
4697 }
4698 else if (RTEST(RBASIC(obj)->klass)) {
4699 VALUE class_path = rb_class_path_cached(RBASIC(obj)->klass);
4700 if (!NIL_P(class_path)) {
4701 APPEND_F("%s ", RSTRING_PTR(class_path));
4702 }
4703 }
4704 }
4705 end:
4706
4707 return pos;
4708}
4709
4710const char *rb_raw_obj_info(char *const buff, const size_t buff_size, VALUE obj);
4711
4712static size_t
4713rb_raw_obj_info_buitin_type(char *const buff, const size_t buff_size, const VALUE obj, size_t pos)
4714{
4715 if (LIKELY(pos < buff_size) && !SPECIAL_CONST_P(obj)) {
4716 const enum ruby_value_type type = BUILTIN_TYPE(obj);
4717
4718 switch (type) {
4719 case T_NODE:
4720 UNEXPECTED_NODE(rb_raw_obj_info);
4721 break;
4722 case T_ARRAY:
4723 if (ARY_SHARED_P(obj)) {
4724 APPEND_S("shared -> ");
4725 rb_raw_obj_info(BUFF_ARGS, ARY_SHARED_ROOT(obj));
4726 }
4727 else {
4728 APPEND_F("[%s%s%s] ",
4729 C(ARY_EMBED_P(obj), "E"),
4730 C(ARY_SHARED_P(obj), "S"),
4731 C(ARY_SHARED_ROOT_P(obj), "R"));
4732
4733 if (ARY_EMBED_P(obj)) {
4734 APPEND_F("len: %ld (embed)",
4735 RARRAY_LEN(obj));
4736 }
4737 else {
4738 APPEND_F("len: %ld, capa:%ld ptr:%p",
4739 RARRAY_LEN(obj),
4740 RARRAY(obj)->as.heap.aux.capa,
4741 (void *)RARRAY_CONST_PTR(obj));
4742 }
4743 }
4744 break;
4745 case T_STRING: {
4746 if (STR_SHARED_P(obj)) {
4747 APPEND_F(" [shared] len: %ld", RSTRING_LEN(obj));
4748 }
4749 else {
4750 if (STR_EMBED_P(obj)) APPEND_S(" [embed]");
4751
4752 APPEND_F(" len: %ld, capa: %" PRIdSIZE, RSTRING_LEN(obj), rb_str_capacity(obj));
4753 }
4754 APPEND_F(" \"%.*s\"", str_len_no_raise(obj), RSTRING_PTR(obj));
4755 break;
4756 }
4757 case T_SYMBOL: {
4758 VALUE fstr = RSYMBOL(obj)->fstr;
4759 ID id = RSYMBOL(obj)->id;
4760 if (RB_TYPE_P(fstr, T_STRING)) {
4761 APPEND_F(":%s id:%d", RSTRING_PTR(fstr), (unsigned int)id);
4762 }
4763 else {
4764 APPEND_F("(%p) id:%d", (void *)fstr, (unsigned int)id);
4765 }
4766 break;
4767 }
4768 case T_MOVED: {
4769 APPEND_F("-> %p", (void*)gc_location_internal(rb_gc_get_objspace(), obj));
4770 break;
4771 }
4772 case T_HASH: {
4773 APPEND_F("[%c] %"PRIdSIZE,
4774 RHASH_AR_TABLE_P(obj) ? 'A' : 'S',
4775 RHASH_SIZE(obj));
4776 break;
4777 }
4778 case T_CLASS:
4779 case T_MODULE:
4780 {
4781 VALUE class_path = rb_class_path_cached(obj);
4782 if (!NIL_P(class_path)) {
4783 APPEND_F("%s", RSTRING_PTR(class_path));
4784 }
4785 else {
4786 APPEND_S("(anon)");
4787 }
4788 break;
4789 }
4790 case T_ICLASS:
4791 {
4792 VALUE class_path = rb_class_path_cached(RBASIC_CLASS(obj));
4793 if (!NIL_P(class_path)) {
4794 APPEND_F("src:%s", RSTRING_PTR(class_path));
4795 }
4796 break;
4797 }
4798 case T_OBJECT:
4799 {
4800 if (FL_TEST_RAW(obj, ROBJECT_HEAP)) {
4801 if (rb_shape_obj_too_complex_p(obj)) {
4802 size_t hash_len = rb_st_table_size(ROBJECT_FIELDS_HASH(obj));
4803 APPEND_F("(too_complex) len:%zu", hash_len);
4804 }
4805 else {
4806 APPEND_F("(embed) len:%d capa:%d", RSHAPE_LEN(RBASIC_SHAPE_ID(obj)), ROBJECT_FIELDS_CAPACITY(obj));
4807 }
4808 }
4809 else {
4810 APPEND_F("len:%d capa:%d ptr:%p", RSHAPE_LEN(RBASIC_SHAPE_ID(obj)), ROBJECT_FIELDS_CAPACITY(obj), (void *)ROBJECT_FIELDS(obj));
4811 }
4812 }
4813 break;
4814 case T_DATA: {
4815 const struct rb_block *block;
4816 const rb_iseq_t *iseq;
4817 if (rb_obj_is_proc(obj) &&
4818 (block = vm_proc_block(obj)) != NULL &&
4819 (vm_block_type(block) == block_type_iseq) &&
4820 (iseq = vm_block_iseq(block)) != NULL) {
4821 rb_raw_iseq_info(BUFF_ARGS, iseq);
4822 }
4823 else if (rb_ractor_p(obj)) {
4824 rb_ractor_t *r = (void *)DATA_PTR(obj);
4825 if (r) {
4826 APPEND_F("r:%d", r->pub.id);
4827 }
4828 }
4829 else {
4830 const char * const type_name = rb_objspace_data_type_name(obj);
4831 if (type_name) {
4832 APPEND_F("%s", type_name);
4833 }
4834 }
4835 break;
4836 }
4837 case T_IMEMO: {
4838 APPEND_F("<%s> ", rb_imemo_name(imemo_type(obj)));
4839
4840 switch (imemo_type(obj)) {
4841 case imemo_ment:
4842 {
4843 const rb_method_entry_t *me = (const rb_method_entry_t *)obj;
4844
4845 APPEND_F(":%s (%s%s%s%s) type:%s aliased:%d owner:%p defined_class:%p",
4846 rb_id2name(me->called_id),
4847 METHOD_ENTRY_VISI(me) == METHOD_VISI_PUBLIC ? "pub" :
4848 METHOD_ENTRY_VISI(me) == METHOD_VISI_PRIVATE ? "pri" : "pro",
4849 METHOD_ENTRY_COMPLEMENTED(me) ? ",cmp" : "",
4850 METHOD_ENTRY_CACHED(me) ? ",cc" : "",
4851 METHOD_ENTRY_INVALIDATED(me) ? ",inv" : "",
4852 me->def ? rb_method_type_name(me->def->type) : "NULL",
4853 me->def ? me->def->aliased : -1,
4854 (void *)me->owner, // obj_info(me->owner),
4855 (void *)me->defined_class); //obj_info(me->defined_class)));
4856
4857 if (me->def) {
4858 switch (me->def->type) {
4859 case VM_METHOD_TYPE_ISEQ:
4860 APPEND_S(" (iseq:");
4861 rb_raw_obj_info(BUFF_ARGS, (VALUE)me->def->body.iseq.iseqptr);
4862 APPEND_S(")");
4863 break;
4864 default:
4865 break;
4866 }
4867 }
4868
4869 break;
4870 }
4871 case imemo_iseq: {
4872 const rb_iseq_t *iseq = (const rb_iseq_t *)obj;
4873 rb_raw_iseq_info(BUFF_ARGS, iseq);
4874 break;
4875 }
4876 case imemo_callinfo:
4877 {
4878 const struct rb_callinfo *ci = (const struct rb_callinfo *)obj;
4879 APPEND_F("(mid:%s, flag:%x argc:%d, kwarg:%s)",
4880 rb_id2name(vm_ci_mid(ci)),
4881 vm_ci_flag(ci),
4882 vm_ci_argc(ci),
4883 vm_ci_kwarg(ci) ? "available" : "NULL");
4884 break;
4885 }
4886 case imemo_callcache:
4887 {
4888 const struct rb_callcache *cc = (const struct rb_callcache *)obj;
4889 VALUE class_path = vm_cc_valid(cc) ? rb_class_path_cached(cc->klass) : Qnil;
4890 const rb_callable_method_entry_t *cme = vm_cc_cme(cc);
4891
4892 APPEND_F("(klass:%s cme:%s%s (%p) call:%p",
4893 NIL_P(class_path) ? (vm_cc_valid(cc) ? "??" : "<NULL>") : RSTRING_PTR(class_path),
4894 cme ? rb_id2name(cme->called_id) : "<NULL>",
4895 cme ? (METHOD_ENTRY_INVALIDATED(cme) ? " [inv]" : "") : "",
4896 (void *)cme,
4897 (void *)(uintptr_t)vm_cc_call(cc));
4898 break;
4899 }
4900 default:
4901 break;
4902 }
4903 }
4904 default:
4905 break;
4906 }
4907 }
4908 end:
4909
4910 return pos;
4911}
4912
4913#undef C
4914
4915#ifdef RUBY_ASAN_ENABLED
4916void
4917rb_asan_poison_object(VALUE obj)
4918{
4919 MAYBE_UNUSED(struct RVALUE *) ptr = (void *)obj;
4920 asan_poison_memory_region(ptr, rb_gc_obj_slot_size(obj));
4921}
4922
4923void
4924rb_asan_unpoison_object(VALUE obj, bool newobj_p)
4925{
4926 MAYBE_UNUSED(struct RVALUE *) ptr = (void *)obj;
4927 asan_unpoison_memory_region(ptr, rb_gc_obj_slot_size(obj), newobj_p);
4928}
4929
4930void *
4931rb_asan_poisoned_object_p(VALUE obj)
4932{
4933 MAYBE_UNUSED(struct RVALUE *) ptr = (void *)obj;
4934 return __asan_region_is_poisoned(ptr, rb_gc_obj_slot_size(obj));
4935}
4936#endif
4937
4938static void
4939raw_obj_info(char *const buff, const size_t buff_size, VALUE obj)
4940{
4941 size_t pos = rb_raw_obj_info_common(buff, buff_size, obj);
4942 pos = rb_raw_obj_info_buitin_type(buff, buff_size, obj, pos);
4943 if (pos >= buff_size) {} // truncated
4944}
4945
4946const char *
4947rb_raw_obj_info(char *const buff, const size_t buff_size, VALUE obj)
4948{
4949 void *objspace = rb_gc_get_objspace();
4950
4951 if (SPECIAL_CONST_P(obj)) {
4952 raw_obj_info(buff, buff_size, obj);
4953 }
4954 else if (!rb_gc_impl_pointer_to_heap_p(objspace, (const void *)obj)) {
4955 snprintf(buff, buff_size, "out-of-heap:%p", (void *)obj);
4956 }
4957#if 0 // maybe no need to check it?
4958 else if (0 && rb_gc_impl_garbage_object_p(objspace, obj)) {
4959 snprintf(buff, buff_size, "garbage:%p", (void *)obj);
4960 }
4961#endif
4962 else {
4963 asan_unpoisoning_object(obj) {
4964 raw_obj_info(buff, buff_size, obj);
4965 }
4966 }
4967 return buff;
4968}
4969
4970#undef APPEND_S
4971#undef APPEND_F
4972#undef BUFF_ARGS
4973
4974/* Increments *var atomically and resets *var to 0 when maxval is
4975 * reached. Returns the wraparound old *var value (0...maxval). */
4976static rb_atomic_t
4977atomic_inc_wraparound(rb_atomic_t *var, const rb_atomic_t maxval)
4978{
4979 rb_atomic_t oldval = RUBY_ATOMIC_FETCH_ADD(*var, 1);
4980 if (RB_UNLIKELY(oldval >= maxval - 1)) { // wraparound *var
4981 const rb_atomic_t newval = oldval + 1;
4982 RUBY_ATOMIC_CAS(*var, newval, newval % maxval);
4983 oldval %= maxval;
4984 }
4985 return oldval;
4986}
4987
4988static const char *
4989obj_info(VALUE obj)
4990{
4991 if (RGENGC_OBJ_INFO) {
4992 static struct {
4993 rb_atomic_t index;
4994 char buffers[10][0x100];
4995 } info = {0};
4996
4997 rb_atomic_t index = atomic_inc_wraparound(&info.index, numberof(info.buffers));
4998 char *const buff = info.buffers[index];
4999 return rb_raw_obj_info(buff, sizeof(info.buffers[0]), obj);
5000 }
5001 return obj_type_name(obj);
5002}
5003
5004/*
5005 ------------------------ Extended allocator ------------------------
5006*/
5007
5008 struct gc_raise_tag {
5009 VALUE exc;
5010 const char *fmt;
5011 va_list *ap;
5012};
5013
5014static void *
5015gc_vraise(void *ptr)
5016{
5017 struct gc_raise_tag *argv = ptr;
5018 rb_vraise(argv->exc, argv->fmt, *argv->ap);
5019 UNREACHABLE_RETURN(NULL);
5020}
5021
5022static void
5023gc_raise(VALUE exc, const char *fmt, ...)
5024{
5025 va_list ap;
5026 va_start(ap, fmt);
5027 struct gc_raise_tag argv = {
5028 exc, fmt, &ap,
5029 };
5030
5031 if (ruby_native_thread_p()) {
5032 rb_thread_call_with_gvl(gc_vraise, &argv);
5033 UNREACHABLE;
5034 }
5035 else {
5036 /* Not in a ruby thread */
5037 fprintf(stderr, "%s", "[FATAL] ");
5038 vfprintf(stderr, fmt, ap);
5039 }
5040
5041 va_end(ap);
5042 abort();
5043}
5044
5045NORETURN(static void negative_size_allocation_error(const char *));
5046static void
5047negative_size_allocation_error(const char *msg)
5048{
5049 gc_raise(rb_eNoMemError, "%s", msg);
5050}
5051
5052static void *
5053ruby_memerror_body(void *dummy)
5054{
5055 rb_memerror();
5056 return 0;
5057}
5058
5059NORETURN(static void ruby_memerror(void));
5060 RBIMPL_ATTR_MAYBE_UNUSED()
5061static void
5062ruby_memerror(void)
5063{
5064 if (ruby_thread_has_gvl_p()) {
5065 rb_memerror();
5066 }
5067 else {
5068 if (ruby_native_thread_p()) {
5069 rb_thread_call_with_gvl(ruby_memerror_body, 0);
5070 }
5071 else {
5072 /* no ruby thread */
5073 fprintf(stderr, "[FATAL] failed to allocate memory\n");
5074 }
5075 }
5076
5077 /* We have discussions whether we should die here; */
5078 /* We might rethink about it later. */
5079 exit(EXIT_FAILURE);
5080}
5081
5082void
5083rb_memerror(void)
5084{
5085 /* the `GET_VM()->special_exceptions` below assumes that
5086 * the VM is reachable from the current thread. We should
5087 * definitely make sure of that. */
5088 RUBY_ASSERT_ALWAYS(ruby_thread_has_gvl_p());
5089
5090 rb_execution_context_t *ec = GET_EC();
5091 VALUE exc = GET_VM()->special_exceptions[ruby_error_nomemory];
5092
5093 if (!exc ||
5094 rb_ec_raised_p(ec, RAISED_NOMEMORY) ||
5095 rb_ec_vm_lock_rec(ec) != ec->tag->lock_rec) {
5096 fprintf(stderr, "[FATAL] failed to allocate memory\n");
5097 exit(EXIT_FAILURE);
5098 }
5099 if (rb_ec_raised_p(ec, RAISED_NOMEMORY)) {
5100 rb_ec_raised_clear(ec);
5101 }
5102 else {
5103 rb_ec_raised_set(ec, RAISED_NOMEMORY);
5104 exc = ruby_vm_special_exception_copy(exc);
5105 }
5106 ec->errinfo = exc;
5107 EC_JUMP_TAG(ec, TAG_RAISE);
5108}
5109
5110bool
5111rb_memerror_reentered(void)
5112{
5113 rb_execution_context_t *ec = GET_EC();
5114 return (ec && rb_ec_raised_p(ec, RAISED_NOMEMORY));
5115}
5116
5117static void *
5118handle_malloc_failure(void *ptr)
5119{
5120 if (LIKELY(ptr)) {
5121 return ptr;
5122 }
5123 else {
5124 ruby_memerror();
5125 UNREACHABLE_RETURN(ptr);
5126 }
5127}
5128
5129static void *ruby_xmalloc_body(size_t size);
5130
5131void *
5132ruby_xmalloc(size_t size)
5133{
5134 return handle_malloc_failure(ruby_xmalloc_body(size));
5135}
5136
5137static bool
5138malloc_gc_allowed(void)
5139{
5140 rb_ractor_t *r = rb_current_ractor_raw(false);
5141
5142 return r == NULL || !r->malloc_gc_disabled;
5143}
5144
5145static void *
5146ruby_xmalloc_body(size_t size)
5147{
5148 if ((ssize_t)size < 0) {
5149 negative_size_allocation_error("too large allocation size");
5150 }
5151
5152 return rb_gc_impl_malloc(rb_gc_get_objspace(), size, malloc_gc_allowed());
5153}
5154
5155void
5156ruby_malloc_size_overflow(size_t count, size_t elsize)
5157{
5158 rb_raise(rb_eArgError,
5159 "malloc: possible integer overflow (%"PRIuSIZE"*%"PRIuSIZE")",
5160 count, elsize);
5161}
5162
5163void
5164ruby_malloc_add_size_overflow(size_t x, size_t y)
5165{
5166 rb_raise(rb_eArgError,
5167 "malloc: possible integer overflow (%"PRIuSIZE"+%"PRIuSIZE")",
5168 x, y);
5169}
5170
5171static void *ruby_xmalloc2_body(size_t n, size_t size);
5172
5173void *
5174ruby_xmalloc2(size_t n, size_t size)
5175{
5176 return handle_malloc_failure(ruby_xmalloc2_body(n, size));
5177}
5178
5179static void *
5180ruby_xmalloc2_body(size_t n, size_t size)
5181{
5182 return rb_gc_impl_malloc(rb_gc_get_objspace(), xmalloc2_size(n, size), malloc_gc_allowed());
5183}
5184
5185static void *ruby_xcalloc_body(size_t n, size_t size);
5186
5187void *
5188ruby_xcalloc(size_t n, size_t size)
5189{
5190 return handle_malloc_failure(ruby_xcalloc_body(n, size));
5191}
5192
5193static void *
5194ruby_xcalloc_body(size_t n, size_t size)
5195{
5196 return rb_gc_impl_calloc(rb_gc_get_objspace(), xmalloc2_size(n, size), malloc_gc_allowed());
5197}
5198
5199static void *ruby_sized_xrealloc_body(void *ptr, size_t new_size, size_t old_size);
5200
5201#ifdef ruby_sized_xrealloc
5202#undef ruby_sized_xrealloc
5203#endif
5204void *
5205ruby_sized_xrealloc(void *ptr, size_t new_size, size_t old_size)
5206{
5207 return handle_malloc_failure(ruby_sized_xrealloc_body(ptr, new_size, old_size));
5208}
5209
5210static void *
5211ruby_sized_xrealloc_body(void *ptr, size_t new_size, size_t old_size)
5212{
5213 if ((ssize_t)new_size < 0) {
5214 negative_size_allocation_error("too large allocation size");
5215 }
5216
5217 return rb_gc_impl_realloc(rb_gc_get_objspace(), ptr, new_size, old_size, malloc_gc_allowed());
5218}
5219
5220void *
5221ruby_xrealloc(void *ptr, size_t new_size)
5222{
5223 return ruby_sized_xrealloc(ptr, new_size, 0);
5224}
5225
5226static void *ruby_sized_xrealloc2_body(void *ptr, size_t n, size_t size, size_t old_n);
5227
5228#ifdef ruby_sized_xrealloc2
5229#undef ruby_sized_xrealloc2
5230#endif
5231void *
5232ruby_sized_xrealloc2(void *ptr, size_t n, size_t size, size_t old_n)
5233{
5234 return handle_malloc_failure(ruby_sized_xrealloc2_body(ptr, n, size, old_n));
5235}
5236
5237static void *
5238ruby_sized_xrealloc2_body(void *ptr, size_t n, size_t size, size_t old_n)
5239{
5240 size_t len = xmalloc2_size(n, size);
5241 return rb_gc_impl_realloc(rb_gc_get_objspace(), ptr, len, old_n * size, malloc_gc_allowed());
5242}
5243
5244void *
5245ruby_xrealloc2(void *ptr, size_t n, size_t size)
5246{
5247 return ruby_sized_xrealloc2(ptr, n, size, 0);
5248}
5249
5250#ifdef ruby_sized_xfree
5251#undef ruby_sized_xfree
5252#endif
5253void
5254ruby_sized_xfree(void *x, size_t size)
5255{
5256 if (LIKELY(x)) {
5257 /* It's possible for a C extension's pthread destructor function set by pthread_key_create
5258 * to be called after ruby_vm_destruct and attempt to free memory. Fall back to mimfree in
5259 * that case. */
5260 if (LIKELY(GET_VM())) {
5261 rb_gc_impl_free(rb_gc_get_objspace(), x, size);
5262 }
5263 else {
5264 ruby_mimfree(x);
5265 }
5266 }
5267}
5268
5269void
5270ruby_xfree(void *x)
5271{
5272 ruby_sized_xfree(x, 0);
5273}
5274
5275void *
5276rb_xmalloc_mul_add(size_t x, size_t y, size_t z) /* x * y + z */
5277{
5278 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
5279 return ruby_xmalloc(w);
5280}
5281
5282void *
5283rb_xcalloc_mul_add(size_t x, size_t y, size_t z) /* x * y + z */
5284{
5285 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
5286 return ruby_xcalloc(w, 1);
5287}
5288
5289void *
5290rb_xrealloc_mul_add(const void *p, size_t x, size_t y, size_t z) /* x * y + z */
5291{
5292 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
5293 return ruby_xrealloc((void *)p, w);
5294}
5295
5296void *
5297rb_xmalloc_mul_add_mul(size_t x, size_t y, size_t z, size_t w) /* x * y + z * w */
5298{
5299 size_t u = size_mul_add_mul_or_raise(x, y, z, w, rb_eArgError);
5300 return ruby_xmalloc(u);
5301}
5302
5303void *
5304rb_xcalloc_mul_add_mul(size_t x, size_t y, size_t z, size_t w) /* x * y + z * w */
5305{
5306 size_t u = size_mul_add_mul_or_raise(x, y, z, w, rb_eArgError);
5307 return ruby_xcalloc(u, 1);
5308}
5309
5310/* Mimic ruby_xmalloc, but need not rb_objspace.
5311 * should return pointer suitable for ruby_xfree
5312 */
5313void *
5314ruby_mimmalloc(size_t size)
5315{
5316 void *mem;
5317#if CALC_EXACT_MALLOC_SIZE
5318 size += sizeof(struct malloc_obj_info);
5319#endif
5320 mem = malloc(size);
5321#if CALC_EXACT_MALLOC_SIZE
5322 if (!mem) {
5323 return NULL;
5324 }
5325 else
5326 /* set 0 for consistency of allocated_size/allocations */
5327 {
5328 struct malloc_obj_info *info = mem;
5329 info->size = 0;
5330 mem = info + 1;
5331 }
5332#endif
5333 return mem;
5334}
5335
5336void *
5337ruby_mimcalloc(size_t num, size_t size)
5338{
5339 void *mem;
5340#if CALC_EXACT_MALLOC_SIZE
5341 struct rbimpl_size_overflow_tag t = rbimpl_size_mul_overflow(num, size);
5342 if (UNLIKELY(t.overflowed)) {
5343 return NULL;
5344 }
5345 size = t.result + sizeof(struct malloc_obj_info);
5346 mem = calloc1(size);
5347 if (!mem) {
5348 return NULL;
5349 }
5350 else
5351 /* set 0 for consistency of allocated_size/allocations */
5352 {
5353 struct malloc_obj_info *info = mem;
5354 info->size = 0;
5355 mem = info + 1;
5356 }
5357#else
5358 mem = calloc(num, size);
5359#endif
5360 return mem;
5361}
5362
5363void
5364ruby_mimfree(void *ptr)
5365{
5366#if CALC_EXACT_MALLOC_SIZE
5367 struct malloc_obj_info *info = (struct malloc_obj_info *)ptr - 1;
5368 ptr = info;
5369#endif
5370 free(ptr);
5371}
5372
5373void
5374rb_gc_adjust_memory_usage(ssize_t diff)
5375{
5376 unless_objspace(objspace) { return; }
5377
5378 rb_gc_impl_adjust_memory_usage(objspace, diff);
5379}
5380
5381const char *
5382rb_obj_info(VALUE obj)
5383{
5384 return obj_info(obj);
5385}
5386
5387void
5388rb_obj_info_dump(VALUE obj)
5389{
5390 char buff[0x100];
5391 fprintf(stderr, "rb_obj_info_dump: %s\n", rb_raw_obj_info(buff, 0x100, obj));
5392}
5393
5394void
5395rb_obj_info_dump_loc(VALUE obj, const char *file, int line, const char *func)
5396{
5397 char buff[0x100];
5398 fprintf(stderr, "<OBJ_INFO:%s@%s:%d> %s\n", func, file, line, rb_raw_obj_info(buff, 0x100, obj));
5399}
5400
5401void
5402rb_gc_before_fork(void)
5403{
5404 rb_gc_impl_before_fork(rb_gc_get_objspace());
5405}
5406
5407void
5408rb_gc_after_fork(rb_pid_t pid)
5409{
5410 rb_gc_impl_after_fork(rb_gc_get_objspace(), pid);
5411}
5412
5413bool
5414rb_gc_obj_shareable_p(VALUE obj)
5415{
5416 return RB_OBJ_SHAREABLE_P(obj);
5417}
5418
5419void
5420rb_gc_rp(VALUE obj)
5421{
5422 rp(obj);
5423}
5424
5425 struct check_shareable_data {
5426 VALUE parent;
5427 long err_count;
5428};
5429
5430static void
5431check_shareable_i(const VALUE child, void *ptr)
5432{
5433 struct check_shareable_data *data = (struct check_shareable_data *)ptr;
5434
5435 if (!rb_gc_obj_shareable_p(child)) {
5436 fprintf(stderr, "(a) ");
5437 rb_gc_rp(data->parent);
5438 fprintf(stderr, "(b) ");
5439 rb_gc_rp(child);
5440 fprintf(stderr, "check_shareable_i: shareable (a) -> unshareable (b)\n");
5441
5442 data->err_count++;
5443 rb_bug("!! violate shareable constraint !!");
5444 }
5445}
5446
5447static bool gc_checking_shareable = false;
5448
5449static void
5450gc_verify_shareable(void *objspace, VALUE obj, void *data)
5451{
5452 // while gc_checking_shareable is true,
5453 // other Ractors should not run the GC, until the flag is not local.
5454 // TODO: remove VM locking if the flag is Ractor local
5455
5456 unsigned int lev = RB_GC_VM_LOCK();
5457 {
5458 gc_checking_shareable = true;
5459 rb_objspace_reachable_objects_from(obj, check_shareable_i, (void *)data);
5460 gc_checking_shareable = false;
5461 }
5462 RB_GC_VM_UNLOCK(lev);
5463}
5464
5465// TODO: only one level (non-recursive)
5466void
5467rb_gc_verify_shareable(VALUE obj)
5468{
5469 rb_objspace_t *objspace = rb_gc_get_objspace();
5470 struct check_shareable_data data = {
5471 .parent = obj,
5472 .err_count = 0,
5473 };
5474 gc_verify_shareable(objspace, obj, &data);
5475
5476 if (data.err_count > 0) {
5477 rb_bug("rb_gc_verify_shareable");
5478 }
5479}
5480
5481bool
5482rb_gc_checking_shareable(void)
5483{
5484 return gc_checking_shareable;
5485}
5486
5487/*
5488 * Document-module: ObjectSpace
5489 *
5490 * The ObjectSpace module contains a number of routines
5491 * that interact with the garbage collection facility and allow you to
5492 * traverse all living objects with an iterator.
5493 *
5494 * ObjectSpace also provides support for object finalizers, procs that will be
5495 * called after a specific object was destroyed by garbage collection. See
5496 * the documentation for +ObjectSpace.define_finalizer+ for important
5497 * information on how to use this method correctly.
5498 *
5499 * a = "A"
5500 * b = "B"
5501 *
5502 * ObjectSpace.define_finalizer(a, proc {|id| puts "Finalizer one on #{id}" })
5503 * ObjectSpace.define_finalizer(b, proc {|id| puts "Finalizer two on #{id}" })
5504 *
5505 * a = nil
5506 * b = nil
5507 *
5508 * _produces:_
5509 *
5510 * Finalizer two on 537763470
5511 * Finalizer one on 537763480
5512 */
5513
5514/* Document-class: GC::Profiler
5515 *
5516 * The GC profiler provides access to information on GC runs including time,
5517 * length and object space size.
5518 *
5519 * Example:
5520 *
5521 * GC::Profiler.enable
5522 *
5523 * require 'rdoc/rdoc'
5524 *
5525 * GC::Profiler.report
5526 *
5527 * GC::Profiler.disable
5528 *
5529 * See also GC.count, GC.malloc_allocated_size and GC.malloc_allocations
5530 */
5531
5532#include "gc.rbinc"
5533
5534void
5535Init_GC(void)
5536{
5537#undef rb_intern
5538 rb_gc_register_address(&id2ref_value);
5539
5540 malloc_offset = gc_compute_malloc_offset();
5541
5542 rb_mGC = rb_define_module("GC");
5543
5544 VALUE rb_mObjSpace = rb_define_module("ObjectSpace");
5545
5546 rb_define_module_function(rb_mObjSpace, "each_object", os_each_obj, -1);
5547
5548 rb_define_module_function(rb_mObjSpace, "define_finalizer", define_final, -1);
5549 rb_define_module_function(rb_mObjSpace, "undefine_finalizer", undefine_final, 1);
5550
5551 rb_define_module_function(rb_mObjSpace, "_id2ref", os_id2ref, 1);
5552
5553 rb_vm_register_special_exception(ruby_error_nomemory, rb_eNoMemError, "failed to allocate memory");
5554
5555 rb_define_method(rb_cBasicObject, "__id__", rb_obj_id, 0);
5556 rb_define_method(rb_mKernel, "object_id", rb_obj_id, 0);
5557
5558 rb_define_module_function(rb_mObjSpace, "count_objects", count_objects, -1);
5559
5560 rb_gc_impl_init();
5561}
5562
5563// Set a name for the anonymous virtual memory area. `addr` is the starting
5564// address of the area and `size` is its length in bytes. `name` is a
5565// NUL-terminated human-readable string.
5566//
5567// This function is usually called after calling `mmap()`. The human-readable
5568// annotation helps developers identify the call site of `mmap()` that created
5569// the memory mapping.
5570//
5571// This function currently only works on Linux 5.17 or higher. After calling
5572// this function, we can see annotations in the form of "[anon:...]" in
5573// `/proc/self/maps`, where `...` is the content of `name`. This function has
5574// no effect when called on other platforms.
5575void
5576ruby_annotate_mmap(const void *addr, unsigned long size, const char *name)
5577{
5578#if defined(HAVE_SYS_PRCTL_H) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
5579 // The name length cannot exceed 80 (including the '\0').
5580 RUBY_ASSERT(strlen(name) < 80);
5581 prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME, (unsigned long)addr, size, name);
5582 // We ignore errors in prctl. prctl may set errno to EINVAL for several
5583 // reasons.
5584 // 1. The attr (PR_SET_VMA_ANON_NAME) is not a valid attribute.
5585 // 2. addr is an invalid address.
5586 // 3. The string pointed by name is too long.
5587 // The first error indicates PR_SET_VMA_ANON_NAME is not available, and may
5588 // happen if we run the compiled binary on an old kernel. In theory, all
5589 // other errors should result in a failure. But since EINVAL cannot tell
5590 // the first error from others, and this function is mainly used for
5591 // debugging, we silently ignore the error.
5592 errno = 0;
5593#endif
5594}
RUBY_ASSERT_ALWAYS
#define RUBY_ASSERT_ALWAYS(expr,...)
A variant of RUBY_ASSERT that does not interface with RUBY_DEBUG.
Definition assert.h:199
RUBY_ASSERT
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
RUBY_ATOMIC_VALUE_CAS
#define RUBY_ATOMIC_VALUE_CAS(var, oldval, newval)
Identical to RUBY_ATOMIC_CAS, except it expects its arguments are VALUE.
Definition atomic.h:406
RUBY_ATOMIC_SIZE_FETCH_ADD
#define RUBY_ATOMIC_SIZE_FETCH_ADD(var, val)
Identical to RUBY_ATOMIC_FETCH_ADD, except it expects its arguments to be size_t.
Definition atomic.h:235
RUBY_ATOMIC_CAS
#define RUBY_ATOMIC_CAS(var, oldval, newval)
Atomic compare-and-swap.
Definition atomic.h:165
rb_atomic_t
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
Definition atomic.h:69
RUBY_ATOMIC_FETCH_ADD
#define RUBY_ATOMIC_FETCH_ADD(var, val)
Atomically replaces the value pointed by var with the result of addition of val to the old value of v...
Definition atomic.h:118
rb_define_method
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
Definition cxxanyargs.hpp:670
rb_define_module_function
#define rb_define_module_function(klass, mid, func, arity)
Defines klass#mid and makes it a module function.
Definition cxxanyargs.hpp:689
debug.h
rb_event_flag_t
uint32_t rb_event_flag_t
Represents event(s).
Definition event.h:108
RUBY_INTERNAL_EVENT_NEWOBJ
#define RUBY_INTERNAL_EVENT_NEWOBJ
Object allocated.
Definition event.h:93
RUBY_FL_WB_PROTECTED
@ RUBY_FL_WB_PROTECTED
Definition fl_type.h:198
rb_define_module
VALUE rb_define_module(const char *name)
Defines a top-level module.
Definition class.c:1590
rb_scan_args
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
Definition class.c:3132
T_COMPLEX
#define T_COMPLEX
Old name of RUBY_T_COMPLEX.
Definition value_type.h:59
TYPE
#define TYPE(_)
Old name of rb_type.
Definition value_type.h:108
FL_SINGLETON
#define FL_SINGLETON
Old name of RUBY_FL_SINGLETON.
Definition fl_type.h:58
T_FILE
#define T_FILE
Old name of RUBY_T_FILE.
Definition value_type.h:62
FL_UNSET_RAW
#define FL_UNSET_RAW
Old name of RB_FL_UNSET_RAW.
Definition fl_type.h:133
ALLOC
#define ALLOC
Old name of RB_ALLOC.
Definition memory.h:400
T_STRING
#define T_STRING
Old name of RUBY_T_STRING.
Definition value_type.h:78
xfree
#define xfree
Old name of ruby_xfree.
Definition xmalloc.h:58
T_MASK
#define T_MASK
Old name of RUBY_T_MASK.
Definition value_type.h:68
Qundef
#define Qundef
Old name of RUBY_Qundef.
Definition special_consts.h:62
INT2FIX
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
T_NIL
#define T_NIL
Old name of RUBY_T_NIL.
Definition value_type.h:72
UNREACHABLE
#define UNREACHABLE
Old name of RBIMPL_UNREACHABLE.
Definition assume.h:28
T_FLOAT
#define T_FLOAT
Old name of RUBY_T_FLOAT.
Definition value_type.h:64
T_IMEMO
#define T_IMEMO
Old name of RUBY_T_IMEMO.
Definition value_type.h:67
ID2SYM
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
T_BIGNUM
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
Definition value_type.h:57
SPECIAL_CONST_P
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
Definition special_consts.h:56
T_STRUCT
#define T_STRUCT
Old name of RUBY_T_STRUCT.
Definition value_type.h:79
OBJ_FREEZE
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
Definition fl_type.h:134
T_FIXNUM
#define T_FIXNUM
Old name of RUBY_T_FIXNUM.
Definition value_type.h:63
UNREACHABLE_RETURN
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
Definition assume.h:29
SYM2ID
#define SYM2ID
Old name of RB_SYM2ID.
Definition symbol.h:45
T_DATA
#define T_DATA
Old name of RUBY_T_DATA.
Definition value_type.h:60
FIXNUM_FLAG
#define FIXNUM_FLAG
Old name of RUBY_FIXNUM_FLAG.
Definition special_consts.h:64
LL2NUM
#define LL2NUM
Old name of RB_LL2NUM.
Definition long_long.h:30
CLASS_OF
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:205
T_NONE
#define T_NONE
Old name of RUBY_T_NONE.
Definition value_type.h:74
T_NODE
#define T_NODE
Old name of RUBY_T_NODE.
Definition value_type.h:73
SIZET2NUM
#define SIZET2NUM
Old name of RB_SIZE2NUM.
Definition size_t.h:62
FL_FINALIZE
#define FL_FINALIZE
Old name of RUBY_FL_FINALIZE.
Definition fl_type.h:61
T_MODULE
#define T_MODULE
Old name of RUBY_T_MODULE.
Definition value_type.h:70
ASSUME
#define ASSUME
Old name of RBIMPL_ASSUME.
Definition assume.h:27
T_TRUE
#define T_TRUE
Old name of RUBY_T_TRUE.
Definition value_type.h:81
T_RATIONAL
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
Definition value_type.h:76
T_ICLASS
#define T_ICLASS
Old name of RUBY_T_ICLASS.
Definition value_type.h:66
T_HASH
#define T_HASH
Old name of RUBY_T_HASH.
Definition value_type.h:65
FL_ABLE
#define FL_ABLE
Old name of RB_FL_ABLE.
Definition fl_type.h:121
FL_TEST_RAW
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition fl_type.h:131
rb_ary_new3
#define rb_ary_new3
Old name of rb_ary_new_from_args.
Definition array.h:658
LONG2NUM
#define LONG2NUM
Old name of RB_LONG2NUM.
Definition long.h:50
T_FALSE
#define T_FALSE
Old name of RUBY_T_FALSE.
Definition value_type.h:61
ULL2NUM
#define ULL2NUM
Old name of RB_ULL2NUM.
Definition long_long.h:31
T_UNDEF
#define T_UNDEF
Old name of RUBY_T_UNDEF.
Definition value_type.h:82
FLONUM_P
#define FLONUM_P
Old name of RB_FLONUM_P.
Definition special_consts.h:67
Qtrue
#define Qtrue
Old name of RUBY_Qtrue.
Definition special_consts.h:61
T_ZOMBIE
#define T_ZOMBIE
Old name of RUBY_T_ZOMBIE.
Definition value_type.h:83
Qnil
#define Qnil
Old name of RUBY_Qnil.
Definition special_consts.h:60
Qfalse
#define Qfalse
Old name of RUBY_Qfalse.
Definition special_consts.h:59
FIX2LONG
#define FIX2LONG
Old name of RB_FIX2LONG.
Definition long.h:46
T_ARRAY
#define T_ARRAY
Old name of RUBY_T_ARRAY.
Definition value_type.h:56
T_OBJECT
#define T_OBJECT
Old name of RUBY_T_OBJECT.
Definition value_type.h:75
NIL_P
#define NIL_P
Old name of RB_NIL_P.
Definition special_consts.h:55
NUM2ULL
#define NUM2ULL
Old name of RB_NUM2ULL.
Definition long_long.h:35
FL_WB_PROTECTED
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
Definition fl_type.h:59
T_SYMBOL
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
Definition value_type.h:80
T_MATCH
#define T_MATCH
Old name of RUBY_T_MATCH.
Definition value_type.h:69
T_CLASS
#define T_CLASS
Old name of RUBY_T_CLASS.
Definition value_type.h:58
BUILTIN_TYPE
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition value_type.h:85
T_MOVED
#define T_MOVED
Old name of RUBY_T_MOVED.
Definition value_type.h:71
xcalloc
#define xcalloc
Old name of ruby_xcalloc.
Definition xmalloc.h:55
FL_UNSET
#define FL_UNSET
Old name of RB_FL_UNSET.
Definition fl_type.h:132
FIXNUM_P
#define FIXNUM_P
Old name of RB_FIXNUM_P.
Definition special_consts.h:53
NUM2SIZET
#define NUM2SIZET
Old name of RB_NUM2SIZE.
Definition size_t.h:61
SYMBOL_P
#define SYMBOL_P
Old name of RB_SYMBOL_P.
Definition value_type.h:88
T_REGEXP
#define T_REGEXP
Old name of RUBY_T_REGEXP.
Definition value_type.h:77
ruby_stack_length
size_t ruby_stack_length(VALUE **p)
Queries what Ruby thinks is the machine stack.
Definition gc.c:2547
ruby_stack_check
int ruby_stack_check(void)
Checks for stack overflow.
Definition gc.c:2587
rb_category_warn
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:476
rb_eNoMemError
VALUE rb_eNoMemError
NoMemoryError exception.
Definition error.c:1442
rb_eRangeError
VALUE rb_eRangeError
RangeError exception.
Definition error.c:1435
ruby_verbose
#define ruby_verbose
This variable controls whether the interpreter is in debug mode.
Definition error.h:475
rb_eTypeError
VALUE rb_eTypeError
TypeError exception.
Definition error.c:1431
rb_warn
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:466
RB_WARN_CATEGORY_DEPRECATED
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
Definition error.h:48
rb_mKernel
VALUE rb_mKernel
Kernel module.
Definition object.c:60
rb_mGC
VALUE rb_mGC
GC module.
Definition gc.c:424
rb_obj_class
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:264
rb_cBasicObject
VALUE rb_cBasicObject
BasicObject class.
Definition object.c:59
rb_obj_is_kind_of
VALUE rb_obj_is_kind_of(VALUE obj, VALUE klass)
Queries if the given object is an instance (of possibly descendants) of the given class.
Definition object.c:923
rb_obj_embedded_size
size_t rb_obj_embedded_size(uint32_t fields_count)
Internal header for Object.
Definition object.c:94
rb_to_int
VALUE rb_to_int(VALUE val)
Identical to rb_check_to_int(), except it raises in case of conversion mismatch.
Definition object.c:3306
RB_POSFIXABLE
#define RB_POSFIXABLE(_)
Checks if the passed value is in range of fixnum, assuming it is a positive number.
Definition fixnum.h:43
rb_enc_str_coderange
int rb_enc_str_coderange(VALUE str)
Scans the passed string to collect its code range.
Definition string.c:947
rb_funcall
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
Definition vm_eval.c:1117
rb_memerror
void rb_memerror(void)
Triggers out-of-memory error.
Definition gc.c:5083
rb_gc_disable
VALUE rb_gc_disable(void)
Disables GC.
Definition gc.c:4467
rb_gc_start
VALUE rb_gc_start(void)
Identical to rb_gc(), except the return value.
Definition gc.c:4261
rb_gc_enable
VALUE rb_gc_enable(void)
(Re-) enables GC.
Definition gc.c:4433
rb_during_gc
int rb_during_gc(void)
Queries if the GC is busy.
Definition gc.c:4276
rb_gc
void rb_gc(void)
Triggers a GC process.
Definition gc.c:4268
rb_gc_count
size_t rb_gc_count(void)
Identical to rb_gc_stat(), with "count" parameter.
Definition gc.c:4284
rb_ary_free
void rb_ary_free(VALUE ary)
Destroys the given array for no reason.
RETURN_ENUMERATOR
#define RETURN_ENUMERATOR(obj, argc, argv)
Identical to RETURN_SIZED_ENUMERATOR(), except its size is unknown.
Definition enumerator.h:242
rb_check_arity
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
Definition error.h:284
rb_hash_new
VALUE rb_hash_new(void)
Creates a new, empty hash object.
Definition hash.c:1484
rb_block_proc
VALUE rb_block_proc(void)
Constructs a Proc object from implicitly passed components.
Definition proc.c:983
rb_obj_is_proc
VALUE rb_obj_is_proc(VALUE recv)
Queries if the given object is a proc.
Definition proc.c:120
rb_str_free
void rb_str_free(VALUE str)
Destroys the given string for no reason.
Definition string.c:1752
rb_str_capacity
size_t rb_str_capacity(VALUE str)
Queries the capacity of the given string.
Definition string.c:1001
rb_class_path_cached
VALUE rb_class_path_cached(VALUE mod)
Just another name of rb_mod_name.
Definition variable.c:389
rb_free_generic_ivar
void rb_free_generic_ivar(VALUE obj)
Frees the list of instance variables.
Definition variable.c:1308
rb_undef_alloc_func
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
Definition vm_method.c:1711
rb_check_funcall
VALUE rb_check_funcall(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv(), except it returns RUBY_Qundef instead of raising rb_eNoMethodError.
Definition vm_eval.c:686
rb_get_alloc_func
rb_alloc_func_t rb_get_alloc_func(VALUE klass)
Queries the allocator function of a class.
Definition vm_method.c:1717
rb_obj_respond_to
int rb_obj_respond_to(VALUE obj, ID mid, int private_p)
Identical to rb_respond_to(), except it additionally takes the visibility parameter.
Definition vm_method.c:3447
rb_sym2str
VALUE rb_sym2str(VALUE symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
Definition symbol.c:993
io.h
ptr
char * ptr
Pointer to the underlying memory region, of at least capa bytes.
Definition io.h:2
rb_io_fptr_finalize
int rb_io_fptr_finalize(rb_io_t *fptr)
Destroys the given IO.
Definition io.c:5693
len
int len
Length of the buffer.
Definition io.h:8
rb_ractor_shareable_p
static bool rb_ractor_shareable_p(VALUE obj)
Queries if multiple Ractors can share the passed object or not.
Definition ractor.h:249
RB_OBJ_SHAREABLE_P
#define RB_OBJ_SHAREABLE_P(obj)
Queries if the passed object has previously classified as shareable or not.
Definition ractor.h:235
re.h
thread.h
ruby_thread_has_gvl_p
int ruby_thread_has_gvl_p(void)
Whether the current thread is holding the GVL.
Definition thread.c:2103
rb_thread_call_with_gvl
void * rb_thread_call_with_gvl(void *(*func)(void *), void *data1)
(Re-)acquires the GVL.
Definition thread.c:2062
util.h
vm.h
ruby_free_at_exit_p
bool ruby_free_at_exit_p(void)
Returns whether the Ruby VM will free all memory at shutdown.
Definition vm.c:4807
rb_yield
VALUE rb_yield(VALUE val)
Yields the block.
Definition vm_eval.c:1372
RBIMPL_ATTR_MAYBE_UNUSED
#define RBIMPL_ATTR_MAYBE_UNUSED()
Wraps (or simulates) [[maybe_unused]].
Definition maybe_unused.h:35
RB_GC_GUARD
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
ruby::backward::cxxanyargs::type
VALUE type(ANYARGS)
ANYARGS-ed function type.
Definition cxxanyargs.hpp:56
ruby::backward::cxxanyargs::st_foreach
int st_foreach(st_table *q, int_type *w, st_data_t e)
Iteration over the given table.
Definition cxxanyargs.hpp:432
RARRAY_LEN
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
RARRAY
#define RARRAY(obj)
Convenient casting macro.
Definition rarray.h:44
RARRAY_CONST_PTR
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
Definition rarray.h:52
RBASIC_CLASS
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
Definition rbasic.h:166
RBASIC
#define RBASIC(obj)
Convenient casting macro.
Definition rbasic.h:40
RCLASS
#define RCLASS(obj)
Convenient casting macro.
Definition rclass.h:38
rb_data_object_wrap
VALUE rb_data_object_wrap(VALUE klass, void *datap, RUBY_DATA_FUNC dmark, RUBY_DATA_FUNC dfree)
This is the primitive way to wrap an existing C struct into RData.
Definition gc.c:1066
DATA_PTR
#define DATA_PTR(obj)
Convenient getter macro.
Definition rdata.h:67
rb_data_object_zalloc
VALUE rb_data_object_zalloc(VALUE klass, size_t size, RUBY_DATA_FUNC dmark, RUBY_DATA_FUNC dfree)
Identical to rb_data_object_wrap(), except it allocates a new data region internally instead of takin...
Definition gc.c:1081
RDATA
#define RDATA(obj)
Convenient casting macro.
Definition rdata.h:59
RUBY_DEFAULT_FREE
#define RUBY_DEFAULT_FREE
This is a value you can set to RData::dfree.
Definition rdata.h:78
RUBY_DATA_FUNC
void(* RUBY_DATA_FUNC)(void *)
This is the type of callbacks registered to RData.
Definition rdata.h:104
RFILE
#define RFILE(obj)
Convenient casting macro.
Definition rfile.h:50
RHASH_SIZE
#define RHASH_SIZE(h)
Queries the size of the hash.
Definition rhash.h:69
RHASH_EMPTY_P
#define RHASH_EMPTY_P(h)
Checks if the hash is empty.
Definition rhash.h:79
RMATCH
#define RMATCH(obj)
Convenient casting macro.
Definition rmatch.h:37
ROBJECT
#define ROBJECT(obj)
Convenient casting macro.
Definition robject.h:43
ROBJECT_FIELDS
static VALUE * ROBJECT_FIELDS(VALUE obj)
Queries the instance variables.
Definition robject.h:128
RREGEXP
#define RREGEXP(obj)
Convenient casting macro.
Definition rregexp.h:37
RREGEXP_PTR
#define RREGEXP_PTR(obj)
Convenient accessor macro.
Definition rregexp.h:45
RSTRING
#define RSTRING(obj)
Convenient casting macro.
Definition rstring.h:41
RTYPEDDATA_P
static bool RTYPEDDATA_P(VALUE obj)
Checks whether the passed object is RTypedData or RData.
Definition rtypeddata.h:575
rb_data_typed_object_wrap
VALUE rb_data_typed_object_wrap(VALUE klass, void *datap, const rb_data_type_t *type)
This is the primitive way to wrap an existing C struct into RTypedData.
Definition gc.c:1105
rb_data_typed_object_zalloc
VALUE rb_data_typed_object_zalloc(VALUE klass, size_t size, const rb_data_type_t *type)
Identical to rb_data_typed_object_wrap(), except it allocates a new data region internally instead of...
Definition gc.c:1115
TypedData_Wrap_Struct
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
Definition rtypeddata.h:461
rb_data_type_t
struct rb_data_type_struct rb_data_type_t
This is the struct that holds necessary info for a struct.
Definition rtypeddata.h:205
RTYPEDDATA
#define RTYPEDDATA(obj)
Convenient casting macro.
Definition rtypeddata.h:95
RTYPEDDATA_TYPE
static const struct rb_data_type_struct * RTYPEDDATA_TYPE(VALUE obj)
Queries for the type of given object.
Definition rtypeddata.h:598
ruby.h
rb_obj_classname
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
Definition variable.c:515
rb_p
void rb_p(VALUE obj)
Inspects an object.
Definition io.c:9056
errno
#define errno
Ractor-aware version of errno.
Definition ruby.h:388
ruby_native_thread_p
int ruby_native_thread_p(void)
Queries if the thread which calls this function is a ruby's thread.
Definition thread.c:5829
RB_SPECIAL_CONST_P
static bool RB_SPECIAL_CONST_P(VALUE obj)
Checks if the given object is of enum ruby_special_consts.
Definition special_consts.h:327
RTEST
#define RTEST
This is an old name of RB_TEST.
Definition special_consts.h:51
stdarg.h
Defines old _.
_
#define _(args)
This was a transition path from K&R to ANSI.
Definition stdarg.h:35
RArray
Ruby's array.
Definition rarray.h:128
RBasic
Ruby object's base components.
Definition rbasic.h:69
RData
Definition rdata.h:120
RData::dfree
RUBY_DATA_FUNC dfree
This function is called when the object is no longer used.
Definition rdata.h:143
RData::dmark
RUBY_DATA_FUNC dmark
This function is called when the object is experiencing GC marks.
Definition rdata.h:134
RData::data
void * data
Pointer to the actual C level struct that you want to wrap.
Definition rdata.h:149
RHash
Definition hash.h:53
RObject
Ruby's ordinal objects.
Definition robject.h:85
RString
Ruby's String.
Definition rstring.h:196
RTypedData
"Typed" user data.
Definition rtypeddata.h:358
RTypedData::data
void * data
Pointer to the actual C level struct that you want to wrap.
Definition rtypeddata.h:378
RTypedData::fields_obj
VALUE fields_obj
Direct reference to the slots that holds instance variables, if any.
Definition rtypeddata.h:364
check_shareable_data
Definition gc.c:5425
classext_foreach_args
Definition gc.c:1234
count_objects_data
Definition gc.c:2419
foreach_arg
Definition io.c:11996
gc_mark_classext_foreach_arg
Definition gc.c:3051
gc_raise_tag
Definition gc.c:5008
global_object_list
Definition vm_core.h:671
global_vm_table_foreach_data
Definition gc.c:3802
malloc_obj_info
Definition default.c:8170
objspace
Definition mmtk.c:19
os_each_struct
Definition gc.c:1506
rb_block
Definition vm_core.h:903
rb_callcache
Definition vm_callinfo.h:292
rb_callinfo
Definition vm_callinfo.h:79
rb_data_type_struct::function
struct rb_data_type_struct::@006053276242002167166045007236206132153037024024 function
Function pointers.
rb_data_type_struct::dcompact
RUBY_DATA_FUNC dcompact
This function is called when the object is relocated.
Definition rtypeddata.h:259
rb_data_type_struct::wrap_struct_name
const char * wrap_struct_name
Name of structs of this kind.
Definition rtypeddata.h:215
rb_data_type_struct::dmark
RUBY_DATA_FUNC dmark
This function is called when the object is experiencing GC marks.
Definition rtypeddata.h:229
rb_gc_object_metadata_entry
Definition gc_impl.h:15
rb_global_variable
Definition variable.c:527
rb_id_table
Definition id_table.c:41
rb_io
Ruby's IO, metadata and buffers.
Definition io.h:295
rb_matchext_struct::char_offset
struct rmatch_offset * char_offset
Capture group offsets, in C array.
Definition rmatch.h:79
rb_matchext_struct::char_offset_num_allocated
int char_offset_num_allocated
Number of rmatch_offset that rmatch::char_offset holds.
Definition rmatch.h:82
rb_matchext_struct::regs
struct re_registers regs
"Registers" of a match.
Definition rmatch.h:76
rb_method_iseq_struct::iseqptr
const rb_iseq_t * iseqptr
iseq pointer, should be separated from iseqval
Definition method.h:143
rmatch_offset
Represents the region of a capture group.
Definition rmatch.h:65
root_objects_data
Definition gc.c:4514
rb_native_mutex_lock
void rb_native_mutex_lock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_lock.
rb_native_mutex_initialize
void rb_native_mutex_initialize(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_initialize.
rb_native_mutex_unlock
void rb_native_mutex_unlock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_unlock.
SIGNED_VALUE
intptr_t SIGNED_VALUE
A signed integer type that has the same width with VALUE.
Definition value.h:63
ID
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
RB_TYPE_P
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376
ruby_value_type
ruby_value_type
C-level type of an object.
Definition value_type.h:113