14#define rb_data_object_alloc rb_data_object_alloc
15#define rb_data_typed_object_alloc rb_data_typed_object_alloc
17#include "ruby/internal/config.h"
22#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
23# include "wasm/setjmp.h"
24# include "wasm/machine.h"
32#ifndef HAVE_MALLOC_USABLE_SIZE
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)
42#ifdef HAVE_MALLOC_USABLE_SIZE
43# ifdef RUBY_ALTERNATIVE_MALLOC_HEADER
45# elif defined(HAVE_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>
60#ifdef HAVE_SYS_RESOURCE_H
61# include <sys/resource.h>
64#if defined _WIN32 || defined __CYGWIN__
66#elif defined(HAVE_POSIX_MEMALIGN)
67#elif defined(HAVE_MEMALIGN)
74#include <emscripten.h>
78#ifdef HAVE_SYS_PRCTL_H
86#include "debug_counter.h"
87#include "eval_intern.h"
91#include "internal/class.h"
92#include "internal/compile.h"
93#include "internal/complex.h"
94#include "internal/cont.h"
95#include "internal/error.h"
96#include "internal/eval.h"
97#include "internal/gc.h"
98#include "internal/hash.h"
99#include "internal/imemo.h"
100#include "internal/io.h"
101#include "internal/numeric.h"
102#include "internal/object.h"
103#include "internal/proc.h"
104#include "internal/rational.h"
105#include "internal/sanitizers.h"
106#include "internal/struct.h"
107#include "internal/symbol.h"
108#include "internal/thread.h"
109#include "internal/variable.h"
110#include "internal/warnings.h"
120#include "ruby_assert.h"
121#include "ruby_atomic.h"
126#include "vm_callinfo.h"
127#include "ractor_core.h"
137 RB_VM_LOCK_ENTER_LEV(&lev);
142rb_gc_vm_unlock(
unsigned int lev)
144 RB_VM_LOCK_LEAVE_LEV(&lev);
151 RB_VM_LOCK_ENTER_CR_LEV(GET_RACTOR(), &lev);
156rb_gc_cr_unlock(
unsigned int lev)
158 RB_VM_LOCK_LEAVE_CR_LEV(GET_RACTOR(), &lev);
162rb_gc_vm_lock_no_barrier(
void)
164 unsigned int lev = 0;
165 RB_VM_LOCK_ENTER_LEV_NB(&lev);
170rb_gc_vm_unlock_no_barrier(
unsigned int lev)
172 RB_VM_LOCK_LEAVE_LEV(&lev);
176rb_gc_vm_barrier(
void)
183rb_gc_get_ractor_newobj_cache(
void)
185 return GET_RACTOR()->newobj_cache;
189rb_gc_initialize_vm_context(
struct rb_gc_vm_context *context)
192 context->ec = GET_EC();
196rb_gc_worker_thread_set_vm_context(
struct rb_gc_vm_context *context)
200 GC_ASSERT(rb_current_execution_context(
false) == NULL);
202#ifdef RB_THREAD_LOCAL_SPECIFIER
203 rb_current_ec_set(context->ec);
205 native_tls_set(ruby_current_ec_key, context->ec);
210rb_gc_worker_thread_unset_vm_context(
struct rb_gc_vm_context *context)
214 GC_ASSERT(rb_current_execution_context(
true) == context->ec);
216#ifdef RB_THREAD_LOCAL_SPECIFIER
217 rb_current_ec_set(NULL);
219 native_tls_set(ruby_current_ec_key, NULL);
227 return ruby_vm_event_flags & event;
233 if (LIKELY(!rb_gc_event_hook_required_p(event)))
return;
236 if (!ec->cfp)
return;
238 EXEC_EVENT_HOOK(ec, event, ec->cfp->self, 0, 0, 0, obj);
242rb_gc_get_objspace(
void)
244 return GET_VM()->gc.objspace;
249rb_gc_ractor_newobj_cache_foreach(
void (*func)(
void *cache,
void *data),
void *data)
252 if (RB_LIKELY(ruby_single_main_ractor)) {
254 ccan_list_empty(&GET_VM()->ractor.set) ||
255 (ccan_list_top(&GET_VM()->ractor.set,
rb_ractor_t, vmlr_node) == ruby_single_main_ractor &&
256 ccan_list_tail(&GET_VM()->ractor.set,
rb_ractor_t, vmlr_node) == ruby_single_main_ractor)
259 func(ruby_single_main_ractor->newobj_cache, data);
262 ccan_list_for_each(&GET_VM()->ractor.set, r, vmlr_node) {
263 func(r->newobj_cache, data);
269rb_gc_run_obj_finalizer(
VALUE objid,
long count,
VALUE (*callback)(
long i,
void *data),
void *data)
280#define RESTORE_FINALIZER() (\
281 ec->cfp = saved.cfp, \
282 ec->cfp->sp = saved.sp, \
283 ec->errinfo = saved.errinfo)
285 saved.errinfo = ec->errinfo;
287 saved.sp = ec->cfp->sp;
292 enum ruby_tag_type state = EC_EXEC_TAG();
293 if (state != TAG_NONE) {
296 VALUE failed_final = saved.final;
299 rb_warn(
"Exception in finalizer %+"PRIsVALUE, failed_final);
300 rb_ec_error_print(ec, ec->errinfo);
304 for (
long i = saved.finished; RESTORE_FINALIZER(), i < count; saved.finished = ++i) {
305 saved.final = callback(i, data);
309#undef RESTORE_FINALIZER
313rb_gc_set_pending_interrupt(
void)
316 ec->interrupt_mask |= PENDING_INTERRUPT_MASK;
320rb_gc_unset_pending_interrupt(
void)
323 ec->interrupt_mask &= ~PENDING_INTERRUPT_MASK;
327rb_gc_multi_ractor_p(
void)
329 return rb_multi_ractor_p();
332bool rb_obj_is_main_ractor(
VALUE gv);
335rb_gc_shutdown_call_finalizer_p(
VALUE obj)
339 if (!ruby_free_at_exit_p() && (!
DATA_PTR(obj) || !
RDATA(obj)->dfree))
return false;
340 if (rb_obj_is_thread(obj))
return false;
341 if (rb_obj_is_mutex(obj))
return false;
342 if (rb_obj_is_fiber(obj))
return false;
343 if (rb_obj_is_main_ractor(obj))
return false;
344 if (rb_obj_is_fstring_table(obj))
return false;
352 if (RSYMBOL(obj)->fstr &&
355 RSYMBOL(obj)->fstr = 0;
363 return ruby_free_at_exit_p();
368rb_gc_get_shape(
VALUE obj)
370 return (uint32_t)rb_shape_get_shape_id(obj);
374rb_gc_set_shape(
VALUE obj, uint32_t shape_id)
376 rb_shape_set_shape_id(obj, (uint32_t)shape_id);
380rb_gc_rebuild_shape(
VALUE obj,
size_t heap_id)
382 rb_shape_t *orig_shape = rb_shape_get_shape(obj);
384 if (rb_shape_obj_too_complex(obj))
return (uint32_t)OBJ_TOO_COMPLEX_SHAPE_ID;
386 rb_shape_t *initial_shape = rb_shape_get_shape_by_id((shape_id_t)(heap_id + FIRST_T_OBJECT_SHAPE_ID));
387 rb_shape_t *new_shape = rb_shape_traverse_from_new_root(initial_shape, orig_shape);
389 if (!new_shape)
return 0;
391 return (uint32_t)rb_shape_id(new_shape);
394void rb_vm_update_references(
void *ptr);
396#define rb_setjmp(env) RUBY_SETJMP(env)
397#define rb_jmp_buf rb_jmpbuf_t
398#undef rb_data_object_wrap
400#if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
401#define MAP_ANONYMOUS MAP_ANON
404#define unless_objspace(objspace) \
406 rb_vm_t *unless_objspace_vm = GET_VM(); \
407 if (unless_objspace_vm) objspace = unless_objspace_vm->gc.objspace; \
410#define RMOVED(obj) ((struct RMoved *)(obj))
412#define TYPED_UPDATE_IF_MOVED(_objspace, _type, _thing) do { \
413 if (rb_gc_impl_object_moved_p((_objspace), (VALUE)(_thing))) { \
414 *(_type *)&(_thing) = (_type)gc_location_internal(_objspace, (VALUE)_thing); \
418#define UPDATE_IF_MOVED(_objspace, _thing) TYPED_UPDATE_IF_MOVED(_objspace, VALUE, _thing)
420#if RUBY_MARK_FREE_DEBUG
421int ruby_gc_debug_indent = 0;
424#ifndef RGENGC_OBJ_INFO
425# define RGENGC_OBJ_INFO RGENGC_CHECK_MODE
428#ifndef CALC_EXACT_MALLOC_SIZE
429# define CALC_EXACT_MALLOC_SIZE 0
434static size_t malloc_offset = 0;
435#if defined(HAVE_MALLOC_USABLE_SIZE)
437gc_compute_malloc_offset(
void)
448 for (offset = 0; offset <= 16; offset += 8) {
449 size_t allocated = (64 - offset);
450 void *test_ptr = malloc(allocated);
451 size_t wasted = malloc_usable_size(test_ptr) - allocated;
462gc_compute_malloc_offset(
void)
470rb_malloc_grow_capa(
size_t current,
size_t type_size)
472 size_t current_capacity = current;
473 if (current_capacity < 4) {
474 current_capacity = 4;
476 current_capacity *= type_size;
479 size_t new_capacity = (current_capacity * 2);
482 if (rb_popcount64(new_capacity) != 1) {
483 new_capacity = (size_t)(1 << (64 - nlz_int64(new_capacity)));
486 new_capacity -= malloc_offset;
487 new_capacity /= type_size;
488 if (current > new_capacity) {
489 rb_bug(
"rb_malloc_grow_capa: current_capacity=%zu, new_capacity=%zu, malloc_offset=%zu", current, new_capacity, malloc_offset);
495static inline struct rbimpl_size_mul_overflow_tag
496size_mul_add_overflow(size_t x, size_t y, size_t z)
498 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(x, y);
499 struct rbimpl_size_mul_overflow_tag u = rbimpl_size_add_overflow(t.right, z);
500 return (
struct rbimpl_size_mul_overflow_tag) { t.left || u.left, u.right };
503static inline struct rbimpl_size_mul_overflow_tag
504size_mul_add_mul_overflow(size_t x, size_t y, size_t z, size_t w)
506 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(x, y);
507 struct rbimpl_size_mul_overflow_tag u = rbimpl_size_mul_overflow(z, w);
508 struct rbimpl_size_mul_overflow_tag v = rbimpl_size_add_overflow(t.right, u.right);
509 return (
struct rbimpl_size_mul_overflow_tag) { t.left || u.left || v.left, v.right };
512PRINTF_ARGS(NORETURN(
static void gc_raise(
VALUE,
const char*, ...)), 2, 3);
515size_mul_or_raise(
size_t x,
size_t y,
VALUE exc)
517 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(x, y);
518 if (LIKELY(!t.left)) {
521 else if (rb_during_gc()) {
527 "integer overflow: %"PRIuSIZE
530 x, y, (
size_t)SIZE_MAX);
535rb_size_mul_or_raise(
size_t x,
size_t y,
VALUE exc)
537 return size_mul_or_raise(x, y, exc);
541size_mul_add_or_raise(
size_t x,
size_t y,
size_t z,
VALUE exc)
543 struct rbimpl_size_mul_overflow_tag t = size_mul_add_overflow(x, y, z);
544 if (LIKELY(!t.left)) {
547 else if (rb_during_gc()) {
553 "integer overflow: %"PRIuSIZE
557 x, y, z, (
size_t)SIZE_MAX);
562rb_size_mul_add_or_raise(
size_t x,
size_t y,
size_t z,
VALUE exc)
564 return size_mul_add_or_raise(x, y, z, exc);
568size_mul_add_mul_or_raise(
size_t x,
size_t y,
size_t z,
size_t w,
VALUE exc)
570 struct rbimpl_size_mul_overflow_tag t = size_mul_add_mul_overflow(x, y, z, w);
571 if (LIKELY(!t.left)) {
574 else if (rb_during_gc()) {
580 "integer overflow: %"PRIdSIZE
585 x, y, z, w, (
size_t)SIZE_MAX);
589#if defined(HAVE_RB_GC_GUARDED_PTR_VAL) && HAVE_RB_GC_GUARDED_PTR_VAL
591volatile VALUE rb_gc_guarded_val;
593rb_gc_guarded_ptr_val(
volatile VALUE *ptr,
VALUE val)
595 rb_gc_guarded_val = val;
601static const char *obj_type_name(
VALUE obj);
602#include "gc/default/default.c"
604#if USE_MODULAR_GC && !defined(HAVE_DLOPEN)
605# error "Modular GC requires dlopen"
609typedef struct gc_function_map {
611 void *(*objspace_alloc)(void);
612 void (*objspace_init)(
void *objspace_ptr);
613 void *(*ractor_cache_alloc)(
void *objspace_ptr,
void *ractor);
614 void (*set_params)(
void *objspace_ptr);
616 size_t *(*heap_sizes)(
void *objspace_ptr);
618 void (*shutdown_free_objects)(
void *objspace_ptr);
619 void (*objspace_free)(
void *objspace_ptr);
620 void (*ractor_cache_free)(
void *objspace_ptr,
void *cache);
622 void (*start)(
void *objspace_ptr,
bool full_mark,
bool immediate_mark,
bool immediate_sweep,
bool compact);
623 bool (*during_gc_p)(
void *objspace_ptr);
624 void (*prepare_heap)(
void *objspace_ptr);
625 void (*gc_enable)(
void *objspace_ptr);
626 void (*gc_disable)(
void *objspace_ptr,
bool finish_current_gc);
627 bool (*gc_enabled_p)(
void *objspace_ptr);
628 VALUE (*config_get)(
void *objpace_ptr);
629 void (*config_set)(
void *objspace_ptr,
VALUE hash);
630 void (*stress_set)(
void *objspace_ptr,
VALUE flag);
631 VALUE (*stress_get)(
void *objspace_ptr);
633 VALUE (*new_obj)(
void *objspace_ptr,
void *cache_ptr,
VALUE klass,
VALUE flags,
VALUE v1,
VALUE v2,
VALUE v3,
bool wb_protected,
size_t alloc_size);
634 size_t (*obj_slot_size)(
VALUE obj);
635 size_t (*heap_id_for_size)(
void *objspace_ptr,
size_t size);
636 bool (*size_allocatable_p)(
size_t size);
638 void *(*malloc)(
void *objspace_ptr,
size_t size);
639 void *(*calloc)(
void *objspace_ptr,
size_t size);
640 void *(*realloc)(
void *objspace_ptr,
void *ptr,
size_t new_size,
size_t old_size);
641 void (*free)(
void *objspace_ptr,
void *ptr,
size_t old_size);
642 void (*adjust_memory_usage)(
void *objspace_ptr, ssize_t diff);
644 void (*mark)(
void *objspace_ptr,
VALUE obj);
645 void (*mark_and_move)(
void *objspace_ptr,
VALUE *ptr);
646 void (*mark_and_pin)(
void *objspace_ptr,
VALUE obj);
647 void (*mark_maybe)(
void *objspace_ptr,
VALUE obj);
648 void (*mark_weak)(
void *objspace_ptr,
VALUE *ptr);
649 void (*remove_weak)(
void *objspace_ptr,
VALUE parent_obj,
VALUE *ptr);
651 bool (*object_moved_p)(
void *objspace_ptr,
VALUE obj);
652 VALUE (*location)(
void *objspace_ptr,
VALUE value);
654 void (*writebarrier)(
void *objspace_ptr,
VALUE a,
VALUE b);
655 void (*writebarrier_unprotect)(
void *objspace_ptr,
VALUE obj);
656 void (*writebarrier_remember)(
void *objspace_ptr,
VALUE obj);
658 void (*each_objects)(
void *objspace_ptr, int (*callback)(
void *,
void *, size_t,
void *),
void *data);
659 void (*each_object)(
void *objspace_ptr, void (*func)(
VALUE obj,
void *data),
void *data);
661 void (*make_zombie)(
void *objspace_ptr,
VALUE obj, void (*dfree)(
void *),
void *data);
663 void (*undefine_finalizer)(
void *objspace_ptr,
VALUE obj);
664 void (*copy_finalizer)(
void *objspace_ptr,
VALUE dest,
VALUE obj);
665 void (*shutdown_call_finalizer)(
void *objspace_ptr);
667 VALUE (*object_id)(
void *objspace_ptr,
VALUE obj);
668 VALUE (*object_id_to_ref)(
void *objspace_ptr,
VALUE object_id);
670 void (*before_fork)(
void *objspace_ptr);
671 void (*after_fork)(
void *objspace_ptr, rb_pid_t pid);
673 void (*set_measure_total_time)(
void *objspace_ptr,
VALUE flag);
674 bool (*get_measure_total_time)(
void *objspace_ptr);
675 unsigned long long (*get_total_time)(
void *objspace_ptr);
676 size_t (*gc_count)(
void *objspace_ptr);
677 VALUE (*latest_gc_info)(
void *objspace_ptr,
VALUE key);
678 VALUE (*stat)(
void *objspace_ptr,
VALUE hash_or_sym);
679 VALUE (*stat_heap)(
void *objspace_ptr,
VALUE heap_name,
VALUE hash_or_sym);
680 const char *(*active_gc_name)(void);
683 bool (*pointer_to_heap_p)(
void *objspace_ptr,
const void *ptr);
684 bool (*garbage_object_p)(
void *objspace_ptr,
VALUE obj);
685 void (*set_event_hook)(
void *objspace_ptr,
const rb_event_flag_t event);
686 void (*copy_attributes)(
void *objspace_ptr,
VALUE dest,
VALUE obj);
688 bool modular_gc_loaded_p;
689} rb_gc_function_map_t;
691static rb_gc_function_map_t rb_gc_functions;
693# define RUBY_GC_LIBRARY "RUBY_GC_LIBRARY"
694# define MODULAR_GC_DIR STRINGIZE(modular_gc_dir)
697ruby_modular_gc_init(
void)
702 const char *gc_so_file = getenv(RUBY_GC_LIBRARY);
704 rb_gc_function_map_t gc_functions = { 0 };
706 char *gc_so_path = NULL;
711 for (
size_t i = 0; i < strlen(gc_so_file); i++) {
712 char c = gc_so_file[i];
713 if (isalnum(c))
continue;
719 fprintf(stderr,
"Only alphanumeric, dash, and underscore is allowed in "RUBY_GC_LIBRARY
"\n");
724 size_t gc_so_path_size = strlen(MODULAR_GC_DIR
"librubygc." DLEXT) + strlen(gc_so_file) + 1;
727 size_t prefix_len = 0;
728 if (dladdr((
void *)(uintptr_t)ruby_modular_gc_init, &dli)) {
729 const char *base = strrchr(dli.dli_fname,
'/');
732# define end_with_p(lit) \
733 (prefix_len >= (tail = rb_strlen_lit(lit)) && \
734 memcmp(base - tail, lit, tail) == 0)
736 prefix_len = base - dli.dli_fname;
737 if (end_with_p(
"/bin") || end_with_p(
"/lib")) {
740 prefix_len += MODULAR_GC_DIR[0] !=
'/';
741 gc_so_path_size += prefix_len;
745 gc_so_path = alloca(gc_so_path_size);
747 size_t gc_so_path_idx = 0;
748#define GC_SO_PATH_APPEND(str) do { \
749 gc_so_path_idx += strlcpy(gc_so_path + gc_so_path_idx, str, gc_so_path_size - gc_so_path_idx); \
752 if (prefix_len > 0) {
753 memcpy(gc_so_path, dli.dli_fname, prefix_len);
754 gc_so_path_idx = prefix_len;
757 GC_SO_PATH_APPEND(MODULAR_GC_DIR
"librubygc.");
758 GC_SO_PATH_APPEND(gc_so_file);
759 GC_SO_PATH_APPEND(DLEXT);
760 GC_ASSERT(gc_so_path_idx == gc_so_path_size - 1);
761#undef GC_SO_PATH_APPEND
764 handle = dlopen(gc_so_path, RTLD_LAZY | RTLD_GLOBAL);
766 fprintf(stderr,
"ruby_modular_gc_init: Shared library %s cannot be opened: %s\n", gc_so_path, dlerror());
770 gc_functions.modular_gc_loaded_p =
true;
773# define load_modular_gc_func(name) do { \
775 const char *func_name = "rb_gc_impl_" #name; \
776 gc_functions.name = dlsym(handle, func_name); \
777 if (!gc_functions.name) { \
778 fprintf(stderr, "ruby_modular_gc_init: %s function not exported by library %s\n", func_name, gc_so_path); \
783 gc_functions.name = rb_gc_impl_##name; \
788 load_modular_gc_func(objspace_alloc);
789 load_modular_gc_func(objspace_init);
790 load_modular_gc_func(ractor_cache_alloc);
791 load_modular_gc_func(set_params);
792 load_modular_gc_func(init);
793 load_modular_gc_func(heap_sizes);
795 load_modular_gc_func(shutdown_free_objects);
796 load_modular_gc_func(objspace_free);
797 load_modular_gc_func(ractor_cache_free);
799 load_modular_gc_func(start);
800 load_modular_gc_func(during_gc_p);
801 load_modular_gc_func(prepare_heap);
802 load_modular_gc_func(gc_enable);
803 load_modular_gc_func(gc_disable);
804 load_modular_gc_func(gc_enabled_p);
805 load_modular_gc_func(config_set);
806 load_modular_gc_func(config_get);
807 load_modular_gc_func(stress_set);
808 load_modular_gc_func(stress_get);
810 load_modular_gc_func(new_obj);
811 load_modular_gc_func(obj_slot_size);
812 load_modular_gc_func(heap_id_for_size);
813 load_modular_gc_func(size_allocatable_p);
815 load_modular_gc_func(malloc);
816 load_modular_gc_func(calloc);
817 load_modular_gc_func(realloc);
818 load_modular_gc_func(free);
819 load_modular_gc_func(adjust_memory_usage);
821 load_modular_gc_func(mark);
822 load_modular_gc_func(mark_and_move);
823 load_modular_gc_func(mark_and_pin);
824 load_modular_gc_func(mark_maybe);
825 load_modular_gc_func(mark_weak);
826 load_modular_gc_func(remove_weak);
828 load_modular_gc_func(object_moved_p);
829 load_modular_gc_func(location);
831 load_modular_gc_func(writebarrier);
832 load_modular_gc_func(writebarrier_unprotect);
833 load_modular_gc_func(writebarrier_remember);
835 load_modular_gc_func(each_objects);
836 load_modular_gc_func(each_object);
838 load_modular_gc_func(make_zombie);
839 load_modular_gc_func(define_finalizer);
840 load_modular_gc_func(undefine_finalizer);
841 load_modular_gc_func(copy_finalizer);
842 load_modular_gc_func(shutdown_call_finalizer);
844 load_modular_gc_func(object_id);
845 load_modular_gc_func(object_id_to_ref);
847 load_modular_gc_func(before_fork);
848 load_modular_gc_func(after_fork);
850 load_modular_gc_func(set_measure_total_time);
851 load_modular_gc_func(get_measure_total_time);
852 load_modular_gc_func(get_total_time);
853 load_modular_gc_func(gc_count);
854 load_modular_gc_func(latest_gc_info);
855 load_modular_gc_func(stat);
856 load_modular_gc_func(stat_heap);
857 load_modular_gc_func(active_gc_name);
859 load_modular_gc_func(object_metadata);
860 load_modular_gc_func(pointer_to_heap_p);
861 load_modular_gc_func(garbage_object_p);
862 load_modular_gc_func(set_event_hook);
863 load_modular_gc_func(copy_attributes);
865# undef load_modular_gc_func
867 rb_gc_functions = gc_functions;
871# define rb_gc_impl_objspace_alloc rb_gc_functions.objspace_alloc
872# define rb_gc_impl_objspace_init rb_gc_functions.objspace_init
873# define rb_gc_impl_ractor_cache_alloc rb_gc_functions.ractor_cache_alloc
874# define rb_gc_impl_set_params rb_gc_functions.set_params
875# define rb_gc_impl_init rb_gc_functions.init
876# define rb_gc_impl_heap_sizes rb_gc_functions.heap_sizes
878# define rb_gc_impl_shutdown_free_objects rb_gc_functions.shutdown_free_objects
879# define rb_gc_impl_objspace_free rb_gc_functions.objspace_free
880# define rb_gc_impl_ractor_cache_free rb_gc_functions.ractor_cache_free
882# define rb_gc_impl_start rb_gc_functions.start
883# define rb_gc_impl_during_gc_p rb_gc_functions.during_gc_p
884# define rb_gc_impl_prepare_heap rb_gc_functions.prepare_heap
885# define rb_gc_impl_gc_enable rb_gc_functions.gc_enable
886# define rb_gc_impl_gc_disable rb_gc_functions.gc_disable
887# define rb_gc_impl_gc_enabled_p rb_gc_functions.gc_enabled_p
888# define rb_gc_impl_config_get rb_gc_functions.config_get
889# define rb_gc_impl_config_set rb_gc_functions.config_set
890# define rb_gc_impl_stress_set rb_gc_functions.stress_set
891# define rb_gc_impl_stress_get rb_gc_functions.stress_get
893# define rb_gc_impl_new_obj rb_gc_functions.new_obj
894# define rb_gc_impl_obj_slot_size rb_gc_functions.obj_slot_size
895# define rb_gc_impl_heap_id_for_size rb_gc_functions.heap_id_for_size
896# define rb_gc_impl_size_allocatable_p rb_gc_functions.size_allocatable_p
898# define rb_gc_impl_malloc rb_gc_functions.malloc
899# define rb_gc_impl_calloc rb_gc_functions.calloc
900# define rb_gc_impl_realloc rb_gc_functions.realloc
901# define rb_gc_impl_free rb_gc_functions.free
902# define rb_gc_impl_adjust_memory_usage rb_gc_functions.adjust_memory_usage
904# define rb_gc_impl_mark rb_gc_functions.mark
905# define rb_gc_impl_mark_and_move rb_gc_functions.mark_and_move
906# define rb_gc_impl_mark_and_pin rb_gc_functions.mark_and_pin
907# define rb_gc_impl_mark_maybe rb_gc_functions.mark_maybe
908# define rb_gc_impl_mark_weak rb_gc_functions.mark_weak
909# define rb_gc_impl_remove_weak rb_gc_functions.remove_weak
911# define rb_gc_impl_object_moved_p rb_gc_functions.object_moved_p
912# define rb_gc_impl_location rb_gc_functions.location
914# define rb_gc_impl_writebarrier rb_gc_functions.writebarrier
915# define rb_gc_impl_writebarrier_unprotect rb_gc_functions.writebarrier_unprotect
916# define rb_gc_impl_writebarrier_remember rb_gc_functions.writebarrier_remember
918# define rb_gc_impl_each_objects rb_gc_functions.each_objects
919# define rb_gc_impl_each_object rb_gc_functions.each_object
921# define rb_gc_impl_make_zombie rb_gc_functions.make_zombie
922# define rb_gc_impl_define_finalizer rb_gc_functions.define_finalizer
923# define rb_gc_impl_undefine_finalizer rb_gc_functions.undefine_finalizer
924# define rb_gc_impl_copy_finalizer rb_gc_functions.copy_finalizer
925# define rb_gc_impl_shutdown_call_finalizer rb_gc_functions.shutdown_call_finalizer
927# define rb_gc_impl_object_id rb_gc_functions.object_id
928# define rb_gc_impl_object_id_to_ref rb_gc_functions.object_id_to_ref
930# define rb_gc_impl_before_fork rb_gc_functions.before_fork
931# define rb_gc_impl_after_fork rb_gc_functions.after_fork
933# define rb_gc_impl_set_measure_total_time rb_gc_functions.set_measure_total_time
934# define rb_gc_impl_get_measure_total_time rb_gc_functions.get_measure_total_time
935# define rb_gc_impl_get_total_time rb_gc_functions.get_total_time
936# define rb_gc_impl_gc_count rb_gc_functions.gc_count
937# define rb_gc_impl_latest_gc_info rb_gc_functions.latest_gc_info
938# define rb_gc_impl_stat rb_gc_functions.stat
939# define rb_gc_impl_stat_heap rb_gc_functions.stat_heap
940# define rb_gc_impl_active_gc_name rb_gc_functions.active_gc_name
942# define rb_gc_impl_object_metadata rb_gc_functions.object_metadata
943# define rb_gc_impl_pointer_to_heap_p rb_gc_functions.pointer_to_heap_p
944# define rb_gc_impl_garbage_object_p rb_gc_functions.garbage_object_p
945# define rb_gc_impl_set_event_hook rb_gc_functions.set_event_hook
946# define rb_gc_impl_copy_attributes rb_gc_functions.copy_attributes
949#ifdef RUBY_ASAN_ENABLED
951asan_death_callback(
void)
954 rb_bug_without_die(
"ASAN error");
962rb_objspace_alloc(
void)
965 ruby_modular_gc_init();
968 void *
objspace = rb_gc_impl_objspace_alloc();
969 ruby_current_vm_ptr->gc.objspace =
objspace;
971 rb_gc_impl_stress_set(
objspace, initial_stress);
973#ifdef RUBY_ASAN_ENABLED
974 __sanitizer_set_death_callback(asan_death_callback);
987rb_gc_obj_slot_size(
VALUE obj)
989 return rb_gc_impl_obj_slot_size(obj);
998 if (cfp && VM_FRAME_RUBYFRAME_P(cfp) && cfp->pc) {
999 RUBY_ASSERT(cfp->pc >= ISEQ_BODY(cfp->iseq)->iseq_encoded);
1000 RUBY_ASSERT(cfp->pc <= ISEQ_BODY(cfp->iseq)->iseq_encoded + ISEQ_BODY(cfp->iseq)->iseq_size);
1008 VALUE obj = rb_gc_impl_new_obj(rb_gc_get_objspace(), cr->newobj_cache, klass, flags, v1, v2, v3, wb_protected, size);
1014 RB_VM_LOCK_ENTER_CR_LEV(cr, &lev);
1016 memset((
char *)obj + RVALUE_SIZE, 0, rb_gc_obj_slot_size(obj) - RVALUE_SIZE);
1023 bool gc_disabled =
RTEST(rb_gc_disable_no_rest());
1027 if (!gc_disabled) rb_gc_enable();
1029 RB_VM_LOCK_LEAVE_CR_LEV(cr, &lev);
1036rb_wb_unprotected_newobj_of(
VALUE klass,
VALUE flags,
size_t size)
1039 return newobj_of(GET_RACTOR(), klass, flags, 0, 0, 0, FALSE, size);
1046 return newobj_of(rb_ec_ractor_ptr(ec), klass, flags, 0, 0, 0, TRUE, size);
1049#define UNEXPECTED_NODE(func) \
1050 rb_bug(#func"(): GC does not handle T_NODE 0x%x(%p) 0x%"PRIxVALUE, \
1051 BUILTIN_TYPE(obj), (void*)(obj), RBASIC(obj)->flags)
1054rb_data_object_check(
VALUE klass)
1056 if (klass != rb_cObject && (
rb_get_alloc_func(klass) == rb_class_allocate_instance)) {
1058 rb_warn(
"undefining the allocator of T_DATA class %"PRIsVALUE, klass);
1066 if (klass) rb_data_object_check(klass);
1073 VALUE obj = rb_data_object_wrap(klass, 0, dmark, dfree);
1081 RBIMPL_NONNULL_ARG(
type);
1082 if (klass) rb_data_object_check(klass);
1084 return newobj_of(GET_RACTOR(), klass,
T_DATA, (
VALUE)
type, 1 | typed_flag, (
VALUE)datap, wb_protected, size);
1090 if (UNLIKELY(
type->flags & RUBY_TYPED_EMBEDDABLE)) {
1091 rb_raise(
rb_eTypeError,
"Cannot wrap an embeddable TypedData");
1094 return typed_data_alloc(klass, 0, datap,
type,
sizeof(
struct RTypedData));
1100 if (
type->flags & RUBY_TYPED_EMBEDDABLE) {
1101 if (!(
type->flags & RUBY_TYPED_FREE_IMMEDIATELY)) {
1102 rb_raise(
rb_eTypeError,
"Embeddable TypedData must be freed immediately");
1105 size_t embed_size = offsetof(
struct RTypedData, data) + size;
1106 if (rb_gc_size_allocatable_p(embed_size)) {
1107 VALUE obj = typed_data_alloc(klass, TYPED_DATA_EMBEDDED, 0,
type, embed_size);
1108 memset((
char *)obj + offsetof(
struct RTypedData, data), 0, size);
1119rb_objspace_data_type_memsize(
VALUE obj)
1124 const void *ptr = RTYPEDDATA_GET_DATA(obj);
1126 if (
RTYPEDDATA_TYPE(obj)->flags & RUBY_TYPED_EMBEDDABLE && !RTYPEDDATA_EMBEDDED_P(obj)) {
1127#ifdef HAVE_MALLOC_USABLE_SIZE
1128 size += malloc_usable_size((
void *)ptr);
1132 if (ptr &&
type->function.dsize) {
1133 size +=
type->function.dsize(ptr);
1141rb_objspace_data_type_name(
VALUE obj)
1151static enum rb_id_table_iterator_result
1152cvar_table_free_i(
VALUE value,
void *ctx)
1154 xfree((
void *)value);
1155 return ID_TABLE_CONTINUE;
1159io_fptr_finalize(
void *fptr)
1168 rb_gc_impl_make_zombie(
objspace, obj, io_fptr_finalize, fptr);
1176 int free_immediately =
false;
1177 void (*dfree)(
void *);
1180 free_immediately = (
RTYPEDDATA(obj)->type->flags & RUBY_TYPED_FREE_IMMEDIATELY) != 0;
1181 dfree =
RTYPEDDATA(obj)->type->function.dfree;
1184 dfree =
RDATA(obj)->dfree;
1189 if (!
RTYPEDDATA_P(obj) || !RTYPEDDATA_EMBEDDED_P(obj)) {
1191 RB_DEBUG_COUNTER_INC(obj_data_xfree);
1194 else if (free_immediately) {
1200 RB_DEBUG_COUNTER_INC(obj_data_imm_free);
1203 rb_gc_impl_make_zombie(
objspace, obj, dfree, data);
1204 RB_DEBUG_COUNTER_INC(obj_data_zombie);
1209 RB_DEBUG_COUNTER_INC(obj_data_empty);
1217rb_gc_obj_free_vm_weak_references(
VALUE obj)
1226 if (
FL_TEST(obj, RSTRING_FSTR)) {
1227 rb_gc_free_fstring(obj);
1231 rb_gc_free_dsymbol(obj);
1234 switch (imemo_type(obj)) {
1235 case imemo_callinfo:
1253 RB_DEBUG_COUNTER_INC(obj_free);
1260 rb_bug(
"obj_free() called for broken object");
1268 if (rb_shape_obj_too_complex(obj)) {
1269 RB_DEBUG_COUNTER_INC(obj_obj_too_complex);
1270 st_free_table(ROBJECT_IV_HASH(obj));
1272 else if (
RBASIC(obj)->flags & ROBJECT_EMBED) {
1273 RB_DEBUG_COUNTER_INC(obj_obj_embed);
1277 RB_DEBUG_COUNTER_INC(obj_obj_ptr);
1282 rb_id_table_free(RCLASS_M_TBL(obj));
1283 rb_cc_table_free(obj);
1284 if (rb_shape_obj_too_complex(obj)) {
1285 st_free_table((
st_table *)RCLASS_IVPTR(obj));
1288 xfree(RCLASS_IVPTR(obj));
1291 if (RCLASS_CONST_TBL(obj)) {
1292 rb_free_const_table(RCLASS_CONST_TBL(obj));
1294 if (RCLASS_CVC_TBL(obj)) {
1295 rb_id_table_foreach_values(RCLASS_CVC_TBL(obj), cvar_table_free_i, NULL);
1296 rb_id_table_free(RCLASS_CVC_TBL(obj));
1298 rb_class_remove_subclass_head(obj);
1299 rb_class_remove_from_module_subclasses(obj);
1300 rb_class_remove_from_super_subclasses(obj);
1301 if (
FL_TEST_RAW(obj, RCLASS_SUPERCLASSES_INCLUDE_SELF)) {
1302 xfree(RCLASS_SUPERCLASSES(obj));
1315#if USE_DEBUG_COUNTER
1318 RB_DEBUG_COUNTER_INC(obj_hash_empty);
1321 RB_DEBUG_COUNTER_INC(obj_hash_1);
1324 RB_DEBUG_COUNTER_INC(obj_hash_2);
1327 RB_DEBUG_COUNTER_INC(obj_hash_3);
1330 RB_DEBUG_COUNTER_INC(obj_hash_4);
1336 RB_DEBUG_COUNTER_INC(obj_hash_5_8);
1340 RB_DEBUG_COUNTER_INC(obj_hash_g8);
1343 if (RHASH_AR_TABLE_P(obj)) {
1344 if (RHASH_AR_TABLE(obj) == NULL) {
1345 RB_DEBUG_COUNTER_INC(obj_hash_null);
1348 RB_DEBUG_COUNTER_INC(obj_hash_ar);
1352 RB_DEBUG_COUNTER_INC(obj_hash_st);
1361 RB_DEBUG_COUNTER_INC(obj_regexp_ptr);
1365 if (!rb_data_free(
objspace, obj))
return false;
1370#if USE_DEBUG_COUNTER
1371 if (rm->
regs.num_regs >= 8) {
1372 RB_DEBUG_COUNTER_INC(obj_match_ge8);
1374 else if (rm->
regs.num_regs >= 4) {
1375 RB_DEBUG_COUNTER_INC(obj_match_ge4);
1377 else if (rm->
regs.num_regs >= 1) {
1378 RB_DEBUG_COUNTER_INC(obj_match_under4);
1381 onig_region_free(&rm->
regs, 0);
1384 RB_DEBUG_COUNTER_INC(obj_match_ptr);
1388 if (
RFILE(obj)->fptr) {
1390 RB_DEBUG_COUNTER_INC(obj_file_ptr);
1395 RB_DEBUG_COUNTER_INC(obj_rational);
1398 RB_DEBUG_COUNTER_INC(obj_complex);
1404 if (RICLASS_OWNS_M_TBL_P(obj)) {
1406 rb_id_table_free(RCLASS_M_TBL(obj));
1408 if (RCLASS_CALLABLE_M_TBL(obj) != NULL) {
1409 rb_id_table_free(RCLASS_CALLABLE_M_TBL(obj));
1411 rb_class_remove_subclass_head(obj);
1412 rb_cc_table_free(obj);
1413 rb_class_remove_from_module_subclasses(obj);
1414 rb_class_remove_from_super_subclasses(obj);
1416 RB_DEBUG_COUNTER_INC(obj_iclass_ptr);
1420 RB_DEBUG_COUNTER_INC(obj_float);
1424 if (!BIGNUM_EMBED_P(obj) && BIGNUM_DIGITS(obj)) {
1425 xfree(BIGNUM_DIGITS(obj));
1426 RB_DEBUG_COUNTER_INC(obj_bignum_ptr);
1429 RB_DEBUG_COUNTER_INC(obj_bignum_embed);
1434 UNEXPECTED_NODE(obj_free);
1438 if ((
RBASIC(obj)->flags & RSTRUCT_EMBED_LEN_MASK) ||
1439 RSTRUCT(obj)->as.heap.ptr == NULL) {
1440 RB_DEBUG_COUNTER_INC(obj_struct_embed);
1443 xfree((
void *)RSTRUCT(obj)->as.heap.ptr);
1444 RB_DEBUG_COUNTER_INC(obj_struct_ptr);
1449 RB_DEBUG_COUNTER_INC(obj_symbol);
1453 rb_imemo_free((
VALUE)obj);
1457 rb_bug(
"gc_sweep(): unknown data type 0x%x(%p) 0x%"PRIxVALUE,
1462 rb_gc_impl_make_zombie(
objspace, obj, 0, 0);
1473 rb_gc_impl_set_event_hook(rb_gc_get_objspace(), event);
1477internal_object_p(
VALUE obj)
1479 void *ptr = asan_unpoison_object_temporary(obj);
1481 if (
RBASIC(obj)->flags) {
1484 UNEXPECTED_NODE(internal_object_p);
1493 if (!
RBASIC(obj)->klass)
break;
1494 if (RCLASS_SINGLETON_P(obj)) {
1495 return rb_singleton_class_internal_p(obj);
1499 if (!
RBASIC(obj)->klass)
break;
1503 if (ptr || !
RBASIC(obj)->flags) {
1504 rb_asan_poison_object(obj);
1510rb_objspace_internal_object_p(
VALUE obj)
1512 return internal_object_p(obj);
1521os_obj_of_i(
void *vstart,
void *vend,
size_t stride,
void *data)
1526 for (; v != (
VALUE)vend; v += stride) {
1527 if (!internal_object_p(v)) {
1547 rb_objspace_each_objects(os_obj_of_i, &oes);
1594 return os_obj_of(of);
1608 return rb_undefine_finalizer(obj);
1614 rb_check_frozen(obj);
1616 rb_gc_impl_undefine_finalizer(rb_gc_get_objspace(), obj);
1622should_be_callable(
VALUE block)
1625 rb_raise(rb_eArgError,
"wrong type argument %"PRIsVALUE
" (should be callable)",
1631should_be_finalizable(
VALUE obj)
1634 rb_raise(rb_eArgError,
"cannot define finalizer for %s",
1637 rb_check_frozen(obj);
1643 rb_gc_impl_copy_finalizer(rb_gc_get_objspace(), dest, obj);
1718 if (rb_callable_receiver(block) == obj) {
1719 rb_warn(
"finalizer references object to be finalized");
1722 return rb_define_finalizer(obj, block);
1728 should_be_finalizable(obj);
1729 should_be_callable(block);
1731 block = rb_gc_impl_define_finalizer(rb_gc_get_objspace(), obj, block);
1739rb_objspace_call_finalizer(
void)
1741 rb_gc_impl_shutdown_call_finalizer(rb_gc_get_objspace());
1745rb_objspace_free_objects(
void *
objspace)
1747 rb_gc_impl_shutdown_free_objects(
objspace);
1751rb_objspace_garbage_object_p(
VALUE obj)
1753 return rb_gc_impl_garbage_object_p(rb_gc_get_objspace(), obj);
1757rb_gc_pointer_to_heap_p(
VALUE obj)
1759 return rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (
void *)obj);
1780#if SIZEOF_LONG == SIZEOF_VOIDP
1781#define NUM2PTR(x) NUM2ULONG(x)
1782#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
1783#define NUM2PTR(x) NUM2ULL(x)
1786 if (
FIXNUM_P(objid) || rb_big_size(objid) <= SIZEOF_VOIDP) {
1787 VALUE ptr = NUM2PTR(objid);
1797 if (rb_static_id_valid_p(
SYM2ID(ptr))) {
1801 rb_raise(
rb_eRangeError,
"%p is not a symbol id value", (
void *)ptr);
1805 rb_raise(
rb_eRangeError,
"%+"PRIsVALUE
" is not an id value", rb_int2str(objid, 10));
1809 VALUE obj = rb_gc_impl_object_id_to_ref(rb_gc_get_objspace(), objid);
1814 rb_raise(
rb_eRangeError,
"%+"PRIsVALUE
" is the id of an unshareable object on multi-ractor", rb_int2str(objid, 10));
1822 return id2ref(objid);
1829#if SIZEOF_LONG == SIZEOF_VOIDP
1836 return get_heap_object_id(
objspace, obj);
1840nonspecial_obj_id(
void *_objspace,
VALUE obj)
1842#if SIZEOF_LONG == SIZEOF_VOIDP
1844#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
1847# error not supported
1854 return rb_find_object_id(NULL, obj, nonspecial_obj_id);
1891 return rb_find_object_id(rb_gc_get_objspace(), obj, rb_gc_impl_object_id);
1894static enum rb_id_table_iterator_result
1895cc_table_memsize_i(
VALUE ccs_ptr,
void *data_ptr)
1897 size_t *total_size = data_ptr;
1899 *total_size +=
sizeof(*ccs);
1900 *total_size +=
sizeof(ccs->entries[0]) * ccs->capa;
1901 return ID_TABLE_CONTINUE;
1907 size_t total = rb_id_table_memsize(cc_table);
1908 rb_id_table_foreach_values(cc_table, cc_table_memsize_i, &total);
1913rb_obj_memsize_of(
VALUE obj)
1922 size += rb_generic_ivar_memsize(obj);
1927 if (rb_shape_obj_too_complex(obj)) {
1928 size += rb_st_memsize(ROBJECT_IV_HASH(obj));
1930 else if (!(
RBASIC(obj)->flags & ROBJECT_EMBED)) {
1931 size += ROBJECT_IV_CAPACITY(obj) *
sizeof(
VALUE);
1936 if (RCLASS_M_TBL(obj)) {
1937 size += rb_id_table_memsize(RCLASS_M_TBL(obj));
1940 size +=
SIZEOF_VALUE << bit_length(RCLASS_IV_COUNT(obj));
1941 if (RCLASS_CVC_TBL(obj)) {
1942 size += rb_id_table_memsize(RCLASS_CVC_TBL(obj));
1944 if (RCLASS_EXT(obj)->const_tbl) {
1945 size += rb_id_table_memsize(RCLASS_EXT(obj)->const_tbl);
1947 if (RCLASS_CC_TBL(obj)) {
1948 size += cc_table_memsize(RCLASS_CC_TBL(obj));
1950 if (
FL_TEST_RAW(obj, RCLASS_SUPERCLASSES_INCLUDE_SELF)) {
1951 size += (RCLASS_SUPERCLASS_DEPTH(obj) + 1) *
sizeof(
VALUE);
1955 if (RICLASS_OWNS_M_TBL_P(obj)) {
1956 if (RCLASS_M_TBL(obj)) {
1957 size += rb_id_table_memsize(RCLASS_M_TBL(obj));
1960 if (RCLASS_CC_TBL(obj)) {
1961 size += cc_table_memsize(RCLASS_CC_TBL(obj));
1965 size += rb_str_memsize(obj);
1968 size += rb_ary_memsize(obj);
1971 if (RHASH_ST_TABLE_P(obj)) {
1972 VM_ASSERT(RHASH_ST_TABLE(obj) != NULL);
1974 size += st_memsize(RHASH_ST_TABLE(obj)) -
sizeof(
st_table);
1983 size += rb_objspace_data_type_memsize(obj);
1988 size += onig_region_memsize(&rm->
regs);
1993 if (
RFILE(obj)->fptr) {
1994 size += rb_io_memsize(
RFILE(obj)->fptr);
2001 size += rb_imemo_memsize(obj);
2009 if (!(
RBASIC(obj)->flags & BIGNUM_EMBED_FLAG) && BIGNUM_DIGITS(obj)) {
2010 size += BIGNUM_LEN(obj) *
sizeof(BDIGIT);
2015 UNEXPECTED_NODE(obj_memsize_of);
2019 if ((
RBASIC(obj)->flags & RSTRUCT_EMBED_LEN_MASK) == 0 &&
2020 RSTRUCT(obj)->as.heap.ptr) {
2021 size +=
sizeof(
VALUE) * RSTRUCT_LEN(obj);
2030 rb_bug(
"objspace/memsize_of(): unknown data type 0x%x(%p)",
2034 return size + rb_gc_obj_slot_size(obj);
2038set_zero(st_data_t key, st_data_t val, st_data_t arg)
2042 rb_hash_aset(hash, k,
INT2FIX(0));
2053count_objects_i(
VALUE obj,
void *d)
2057 if (
RBASIC(obj)->flags) {
2103count_objects(
int argc,
VALUE *argv,
VALUE os)
2114 rb_gc_impl_each_object(rb_gc_get_objspace(), count_objects_i, &data);
2117 hash = rb_hash_new();
2120 rb_hash_stlike_foreach(hash, set_zero, hash);
2122 rb_hash_aset(hash,
ID2SYM(rb_intern(
"TOTAL")),
SIZET2NUM(data.total));
2125 for (
size_t i = 0; i <=
T_MASK; i++) {
2134#define SET_STACK_END SET_MACHINE_STACK_END(&ec->machine.stack_end)
2136#define STACK_START (ec->machine.stack_start)
2137#define STACK_END (ec->machine.stack_end)
2138#define STACK_LEVEL_MAX (ec->machine.stack_maxsize/sizeof(VALUE))
2140#if STACK_GROW_DIRECTION < 0
2141# define STACK_LENGTH (size_t)(STACK_START - STACK_END)
2142#elif STACK_GROW_DIRECTION > 0
2143# define STACK_LENGTH (size_t)(STACK_END - STACK_START + 1)
2145# define STACK_LENGTH ((STACK_END < STACK_START) ? (size_t)(STACK_START - STACK_END) \
2146 : (size_t)(STACK_END - STACK_START + 1))
2148#if !STACK_GROW_DIRECTION
2149int ruby_stack_grow_direction;
2151ruby_get_stack_grow_direction(
volatile VALUE *addr)
2154 SET_MACHINE_STACK_END(&end);
2156 if (end > addr)
return ruby_stack_grow_direction = 1;
2157 return ruby_stack_grow_direction = -1;
2166 if (p) *p = STACK_UPPER(STACK_END, STACK_START, STACK_END);
2167 return STACK_LENGTH;
2170#define PREVENT_STACK_OVERFLOW 1
2171#ifndef PREVENT_STACK_OVERFLOW
2172#if !(defined(POSIX_SIGNAL) && defined(SIGSEGV) && defined(HAVE_SIGALTSTACK))
2173# define PREVENT_STACK_OVERFLOW 1
2175# define PREVENT_STACK_OVERFLOW 0
2178#if PREVENT_STACK_OVERFLOW && !defined(__EMSCRIPTEN__)
2184 size_t length = STACK_LENGTH;
2185 size_t maximum_length = STACK_LEVEL_MAX - water_mark;
2187 return length > maximum_length;
2190#define stack_check(ec, water_mark) FALSE
2193#define STACKFRAME_FOR_CALL_CFUNC 2048
2198 return stack_check(ec, STACKFRAME_FOR_CALL_CFUNC);
2204 return stack_check(GET_EC(), STACKFRAME_FOR_CALL_CFUNC);
2209#define RB_GC_MARK_OR_TRAVERSE(func, obj_or_ptr, obj, check_obj) do { \
2210 if (!RB_SPECIAL_CONST_P(obj)) { \
2211 rb_vm_t *vm = GET_VM(); \
2212 void *objspace = vm->gc.objspace; \
2213 if (LIKELY(vm->gc.mark_func_data == NULL)) { \
2214 GC_ASSERT(rb_gc_impl_during_gc_p(objspace)); \
2215 (func)(objspace, (obj_or_ptr)); \
2217 else if (check_obj ? \
2218 rb_gc_impl_pointer_to_heap_p(objspace, (const void *)obj) && \
2219 !rb_gc_impl_garbage_object_p(objspace, obj) : \
2221 GC_ASSERT(!rb_gc_impl_during_gc_p(objspace)); \
2222 struct gc_mark_func_data_struct *mark_func_data = vm->gc.mark_func_data; \
2223 vm->gc.mark_func_data = NULL; \
2224 mark_func_data->mark_func((obj), mark_func_data->data); \
2225 vm->gc.mark_func_data = mark_func_data; \
2231gc_mark_internal(
VALUE obj)
2233 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark, obj, obj,
false);
2239 gc_mark_internal(obj);
2243rb_gc_mark_and_move(
VALUE *ptr)
2245 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_and_move, ptr, *ptr,
false);
2249gc_mark_and_pin_internal(
VALUE obj)
2251 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_and_pin, obj, obj,
false);
2257 gc_mark_and_pin_internal(obj);
2261gc_mark_maybe_internal(
VALUE obj)
2263 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_maybe, obj, obj,
true);
2269 gc_mark_maybe_internal(obj);
2273rb_gc_mark_weak(
VALUE *ptr)
2279 if (LIKELY(vm->gc.mark_func_data == NULL)) {
2280 GC_ASSERT(rb_gc_impl_during_gc_p(
objspace));
2282 rb_gc_impl_mark_weak(
objspace, ptr);
2285 GC_ASSERT(!rb_gc_impl_during_gc_p(
objspace));
2290rb_gc_remove_weak(
VALUE parent_obj,
VALUE *ptr)
2292 rb_gc_impl_remove_weak(rb_gc_get_objspace(), parent_obj, ptr);
2295ATTRIBUTE_NO_ADDRESS_SAFETY_ANALYSIS(
static void each_location(
register const VALUE *x,
register long n,
void (*cb)(
VALUE,
void *),
void *data));
2297each_location(
register const VALUE *x,
register long n,
void (*cb)(
VALUE,
void *),
void *data)
2308each_location_ptr(
const VALUE *start,
const VALUE *end,
void (*cb)(
VALUE,
void *),
void *data)
2310 if (end <= start)
return;
2311 each_location(start, end - start, cb, data);
2315gc_mark_maybe_each_location(
VALUE obj,
void *data)
2317 gc_mark_maybe_internal(obj);
2323 each_location_ptr(start, end, gc_mark_maybe_each_location, NULL);
2327rb_gc_mark_values(
long n,
const VALUE *values)
2329 for (
long i = 0; i < n; i++) {
2330 gc_mark_internal(values[i]);
2335rb_gc_mark_vm_stack_values(
long n,
const VALUE *values)
2337 for (
long i = 0; i < n; i++) {
2338 gc_mark_and_pin_internal(values[i]);
2343mark_key(st_data_t key, st_data_t value, st_data_t data)
2345 gc_mark_and_pin_internal((
VALUE)key);
2355 st_foreach(tbl, mark_key, (st_data_t)rb_gc_get_objspace());
2359mark_keyvalue(st_data_t key, st_data_t value, st_data_t data)
2361 gc_mark_internal((
VALUE)key);
2362 gc_mark_internal((
VALUE)value);
2368pin_key_pin_value(st_data_t key, st_data_t value, st_data_t data)
2370 gc_mark_and_pin_internal((
VALUE)key);
2371 gc_mark_and_pin_internal((
VALUE)value);
2377pin_key_mark_value(st_data_t key, st_data_t value, st_data_t data)
2379 gc_mark_and_pin_internal((
VALUE)key);
2380 gc_mark_internal((
VALUE)value);
2386mark_hash(
VALUE hash)
2388 if (rb_hash_compare_by_id_p(hash)) {
2389 rb_hash_stlike_foreach(hash, pin_key_mark_value, 0);
2392 rb_hash_stlike_foreach(hash, mark_keyvalue, 0);
2395 gc_mark_internal(RHASH(hash)->ifnone);
2403 st_foreach(tbl, pin_key_pin_value, 0);
2406static enum rb_id_table_iterator_result
2409 gc_mark_internal(me);
2411 return ID_TABLE_CONTINUE;
2418 rb_id_table_foreach_values(tbl, mark_method_entry_i,
objspace);
2422#if STACK_GROW_DIRECTION < 0
2423#define GET_STACK_BOUNDS(start, end, appendix) ((start) = STACK_END, (end) = STACK_START)
2424#elif STACK_GROW_DIRECTION > 0
2425#define GET_STACK_BOUNDS(start, end, appendix) ((start) = STACK_START, (end) = STACK_END+(appendix))
2427#define GET_STACK_BOUNDS(start, end, appendix) \
2428 ((STACK_END < STACK_START) ? \
2429 ((start) = STACK_END, (end) = STACK_START) : ((start) = STACK_START, (end) = STACK_END+(appendix)))
2433gc_mark_machine_stack_location_maybe(
VALUE obj,
void *data)
2435 gc_mark_maybe_internal(obj);
2437#ifdef RUBY_ASAN_ENABLED
2439 void *fake_frame_start;
2440 void *fake_frame_end;
2441 bool is_fake_frame = asan_get_fake_stack_extents(
2442 ec->machine.asan_fake_stack_handle, obj,
2443 ec->machine.stack_start, ec->machine.stack_end,
2444 &fake_frame_start, &fake_frame_end
2446 if (is_fake_frame) {
2447 each_location_ptr(fake_frame_start, fake_frame_end, gc_mark_maybe_each_location, NULL);
2459 GC_ASSERT(rb_gc_impl_pointer_to_heap_p(
objspace, (
void *)value));
2461 return rb_gc_impl_location(
objspace, value);
2467 return gc_location_internal(rb_gc_get_objspace(), value);
2470#if defined(__wasm__)
2473static VALUE *rb_stack_range_tmp[2];
2476rb_mark_locations(
void *begin,
void *end)
2478 rb_stack_range_tmp[0] = begin;
2479 rb_stack_range_tmp[1] = end;
2483rb_gc_save_machine_context(
void)
2488# if defined(__EMSCRIPTEN__)
2493 emscripten_scan_stack(rb_mark_locations);
2494 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2496 emscripten_scan_registers(rb_mark_locations);
2497 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2504 VALUE *stack_start, *stack_end;
2506 GET_STACK_BOUNDS(stack_start, stack_end, 1);
2507 each_location_ptr(stack_start, stack_end, gc_mark_maybe_each_location, NULL);
2509 rb_wasm_scan_locals(rb_mark_locations);
2510 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2518rb_gc_save_machine_context(
void)
2522 RB_VM_SAVE_MACHINE_CONTEXT(thread);
2529 rb_gc_mark_machine_context(ec);
2536 VALUE *stack_start, *stack_end;
2538 GET_STACK_BOUNDS(stack_start, stack_end, 0);
2539 RUBY_DEBUG_LOG(
"ec->th:%u stack_start:%p stack_end:%p", rb_ec_thread_ptr(ec)->serial, stack_start, stack_end);
2542#ifdef RUBY_ASAN_ENABLED
2549 each_location_ptr(stack_start, stack_end, gc_mark_machine_stack_location_maybe, data);
2550 int num_regs =
sizeof(ec->machine.regs)/(
sizeof(
VALUE));
2551 each_location((
VALUE*)&ec->machine.regs, num_regs, gc_mark_machine_stack_location_maybe, data);
2555rb_mark_tbl_i(st_data_t key, st_data_t value, st_data_t data)
2557 gc_mark_and_pin_internal((
VALUE)value);
2565 if (!tbl || tbl->num_entries == 0)
return;
2567 st_foreach(tbl, rb_mark_tbl_i, 0);
2573 if (!tbl || tbl->num_entries == 0)
return;
2575 st_foreach(tbl, gc_mark_tbl_no_pin_i, 0);
2581 gc_mark_tbl_no_pin(tbl);
2584static enum rb_id_table_iterator_result
2592 gc_mark_internal((
VALUE)entry->cref);
2594 return ID_TABLE_CONTINUE;
2602 rb_id_table_foreach_values(tbl, mark_cvc_tbl_i,
objspace);
2609 return (
type->flags & RUBY_TYPED_DECL_MARKING) != 0;
2612static enum rb_id_table_iterator_result
2617 gc_mark_internal(ce->value);
2618 gc_mark_internal(ce->file);
2620 return ID_TABLE_CONTINUE;
2624rb_gc_mark_roots(
void *
objspace,
const char **categoryp)
2627 rb_vm_t *vm = rb_ec_vm_ptr(ec);
2629#define MARK_CHECKPOINT(category) do { \
2630 if (categoryp) *categoryp = category; \
2633 MARK_CHECKPOINT(
"vm");
2635 if (vm->self) gc_mark_internal(vm->self);
2637 MARK_CHECKPOINT(
"end_proc");
2640 MARK_CHECKPOINT(
"global_tbl");
2641 rb_gc_mark_global_tbl();
2644 void rb_yjit_root_mark(
void);
2646 if (rb_yjit_enabled_p) {
2647 MARK_CHECKPOINT(
"YJIT");
2648 rb_yjit_root_mark();
2652 MARK_CHECKPOINT(
"machine_context");
2653 mark_current_machine_context(ec);
2655 MARK_CHECKPOINT(
"global_symbols");
2656 rb_sym_global_symbols_mark();
2658 MARK_CHECKPOINT(
"finish");
2660#undef MARK_CHECKPOINT
2663#define TYPED_DATA_REFS_OFFSET_LIST(d) (size_t *)(uintptr_t)RTYPEDDATA(d)->type->function.dmark
2669 rb_mark_generic_ivar(obj);
2684 rb_bug(
"rb_gc_mark() called for broken object");
2688 UNEXPECTED_NODE(rb_gc_mark);
2692 rb_imemo_mark_and_move(obj,
false);
2699 gc_mark_internal(
RBASIC(obj)->klass);
2704 gc_mark_internal(RCLASS_ATTACHED_OBJECT(obj));
2712 mark_m_tbl(
objspace, RCLASS_M_TBL(obj));
2714 rb_cc_table_mark(obj);
2715 if (rb_shape_obj_too_complex(obj)) {
2716 gc_mark_tbl_no_pin((
st_table *)RCLASS_IVPTR(obj));
2719 for (attr_index_t i = 0; i < RCLASS_IV_COUNT(obj); i++) {
2720 gc_mark_internal(RCLASS_IVPTR(obj)[i]);
2724 if (RCLASS_CONST_TBL(obj)) {
2725 rb_id_table_foreach_values(RCLASS_CONST_TBL(obj), mark_const_table_i,
objspace);
2728 gc_mark_internal(RCLASS_EXT(obj)->classpath);
2732 if (RICLASS_OWNS_M_TBL_P(obj)) {
2733 mark_m_tbl(
objspace, RCLASS_M_TBL(obj));
2739 if (RCLASS_INCLUDER(obj)) {
2740 gc_mark_internal(RCLASS_INCLUDER(obj));
2742 mark_m_tbl(
objspace, RCLASS_CALLABLE_M_TBL(obj));
2743 rb_cc_table_mark(obj);
2747 if (ARY_SHARED_P(obj)) {
2748 VALUE root = ARY_SHARED_ROOT(obj);
2749 gc_mark_internal(root);
2754 for (
long i = 0; i <
len; i++) {
2755 gc_mark_internal(ptr[i]);
2765 if (STR_SHARED_P(obj)) {
2766 if (STR_EMBED_P(
RSTRING(obj)->as.heap.aux.shared)) {
2771 gc_mark_and_pin_internal(
RSTRING(obj)->as.heap.aux.shared);
2774 gc_mark_internal(
RSTRING(obj)->as.heap.aux.shared);
2784 size_t *offset_list = TYPED_DATA_REFS_OFFSET_LIST(obj);
2786 for (
size_t offset = *offset_list; offset != RUBY_REF_END; offset = *offset_list++) {
2787 gc_mark_internal(*(
VALUE *)((
char *)ptr + offset));
2794 if (mark_func) (*mark_func)(ptr);
2802 rb_shape_t *shape = rb_shape_get_shape_by_id(ROBJECT_SHAPE_ID(obj));
2804 if (rb_shape_obj_too_complex(obj)) {
2805 gc_mark_tbl_no_pin(ROBJECT_IV_HASH(obj));
2810 uint32_t
len = ROBJECT_IV_COUNT(obj);
2811 for (uint32_t i = 0; i <
len; i++) {
2812 gc_mark_internal(ptr[i]);
2820 attr_index_t num_of_ivs = shape->next_iv_index;
2821 if (RCLASS_EXT(klass)->max_iv_count < num_of_ivs) {
2822 RCLASS_EXT(klass)->max_iv_count = num_of_ivs;
2830 if (
RFILE(obj)->fptr) {
2831 gc_mark_internal(
RFILE(obj)->fptr->self);
2832 gc_mark_internal(
RFILE(obj)->fptr->pathv);
2833 gc_mark_internal(
RFILE(obj)->fptr->tied_io_for_writing);
2834 gc_mark_internal(
RFILE(obj)->fptr->writeconv_asciicompat);
2835 gc_mark_internal(
RFILE(obj)->fptr->writeconv_pre_ecopts);
2836 gc_mark_internal(
RFILE(obj)->fptr->encs.ecopts);
2837 gc_mark_internal(
RFILE(obj)->fptr->write_lock);
2838 gc_mark_internal(
RFILE(obj)->fptr->timeout);
2843 gc_mark_internal(
RREGEXP(obj)->src);
2847 gc_mark_internal(
RMATCH(obj)->regexp);
2849 gc_mark_internal(
RMATCH(obj)->str);
2854 gc_mark_internal(RRATIONAL(obj)->num);
2855 gc_mark_internal(RRATIONAL(obj)->den);
2859 gc_mark_internal(RCOMPLEX(obj)->real);
2860 gc_mark_internal(RCOMPLEX(obj)->imag);
2864 const long len = RSTRUCT_LEN(obj);
2865 const VALUE *
const ptr = RSTRUCT_CONST_PTR(obj);
2867 for (
long i = 0; i <
len; i++) {
2868 gc_mark_internal(ptr[i]);
2878 rb_bug(
"rb_gc_mark(): unknown data type 0x%x(%p) %s",
2880 rb_gc_impl_pointer_to_heap_p(
objspace, (
void *)obj) ?
"corrupted object" :
"non object");
2885rb_gc_obj_optimal_size(
VALUE obj)
2889 return rb_ary_size_as_embedded(obj);
2892 if (rb_shape_obj_too_complex(obj)) {
2893 return sizeof(
struct RObject);
2900 return rb_str_size_as_embedded(obj);
2903 return sizeof(
struct RHash) + (RHASH_ST_TABLE_P(obj) ? sizeof(
st_table) : sizeof(ar_table));
2911rb_gc_writebarrier(VALUE a, VALUE b)
2913 rb_gc_impl_writebarrier(rb_gc_get_objspace(), a, b);
2919 rb_gc_impl_writebarrier_unprotect(rb_gc_get_objspace(), obj);
2926rb_gc_writebarrier_remember(
VALUE obj)
2928 rb_gc_impl_writebarrier_remember(rb_gc_get_objspace(), obj);
2934 rb_gc_impl_copy_attributes(rb_gc_get_objspace(), dest, obj);
2938rb_gc_modular_gc_loaded_p(
void)
2941 return rb_gc_functions.modular_gc_loaded_p;
2948rb_gc_active_gc_name(
void)
2950 const char *gc_name = rb_gc_impl_active_gc_name();
2952 const size_t len = strlen(gc_name);
2953 if (
len > RB_GC_MAX_NAME_LEN) {
2954 rb_bug(
"GC should have a name no more than %d chars long. Currently: %zu (%s)",
2955 RB_GC_MAX_NAME_LEN,
len, gc_name);
2962rb_gc_object_metadata(
VALUE obj)
2964 return rb_gc_impl_object_metadata(rb_gc_get_objspace(), obj);
2972 return rb_gc_impl_ractor_cache_alloc(rb_gc_get_objspace(), ractor);
2976rb_gc_ractor_cache_free(
void *cache)
2978 rb_gc_impl_ractor_cache_free(rb_gc_get_objspace(), cache);
2984 if (!rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (
void *)obj))
2987 rb_vm_register_global_object(obj);
2998 tmp->next = vm->global_object_list;
3000 vm->global_object_list = tmp;
3008 rb_warn(
"Object is assigned to registering address already: %"PRIsVALUE,
3010 rb_print_backtrace(stderr);
3020 if (tmp->varptr == addr) {
3021 vm->global_object_list = tmp->next;
3026 if (tmp->next->varptr == addr) {
3029 tmp->next = tmp->next->next;
3040 rb_gc_register_address(var);
3046 rb_gc_impl_start(rb_gc_get_objspace(),
RTEST(full_mark),
RTEST(immediate_mark),
RTEST(immediate_sweep),
RTEST(compact));
3090rb_objspace_each_objects(
int (*callback)(
void *,
void *,
size_t,
void *),
void *data)
3092 rb_gc_impl_each_objects(rb_gc_get_objspace(), callback, data);
3098 if (ARY_SHARED_P(v)) {
3099 VALUE old_root =
RARRAY(v)->as.heap.aux.shared_root;
3103 VALUE new_root =
RARRAY(v)->as.heap.aux.shared_root;
3105 if (ARY_EMBED_P(new_root) && new_root != old_root) {
3106 size_t offset = (size_t)(
RARRAY(v)->as.heap.ptr -
RARRAY(old_root)->as.ary);
3107 GC_ASSERT(
RARRAY(v)->as.heap.ptr >=
RARRAY(old_root)->as.ary);
3108 RARRAY(v)->as.heap.ptr =
RARRAY(new_root)->as.ary + offset;
3116 for (
long i = 0; i <
len; i++) {
3121 if (rb_gc_obj_slot_size(v) >= rb_ary_size_as_embedded(v)) {
3122 if (rb_ary_embeddable_p(v)) {
3123 rb_ary_make_embedded(v);
3134 if (rb_shape_obj_too_complex(v)) {
3135 gc_ref_update_table_values_only(ROBJECT_IV_HASH(v));
3139 size_t slot_size = rb_gc_obj_slot_size(v);
3141 if (slot_size >= embed_size && !
RB_FL_TEST_RAW(v, ROBJECT_EMBED)) {
3143 memcpy(
ROBJECT(v)->as.ary, ptr,
sizeof(
VALUE) * ROBJECT_IV_COUNT(v));
3149 for (uint32_t i = 0; i < ROBJECT_IV_COUNT(v); i++) {
3155rb_gc_ref_update_table_values_only(
st_table *tbl)
3157 gc_ref_update_table_values_only(tbl);
3164 gc_update_table_refs(ptr);
3170 rb_hash_stlike_foreach_with_replace(v, hash_foreach_replace, hash_replace_ref, (st_data_t)
objspace);
3176 for (
long i = 0; i < n; i++) {
3177 UPDATE_IF_MOVED(
objspace, values[i]);
3182rb_gc_update_values(
long n,
VALUE *values)
3184 gc_update_values(rb_gc_get_objspace(), n, values);
3187static enum rb_id_table_iterator_result
3188check_id_table_move(
VALUE value,
void *data)
3193 return ID_TABLE_REPLACE;
3196 return ID_TABLE_CONTINUE;
3200rb_gc_prepare_heap_process_object(
VALUE obj)
3214rb_gc_prepare_heap(
void)
3216 rb_gc_impl_prepare_heap(rb_gc_get_objspace());
3220rb_gc_heap_id_for_size(
size_t size)
3222 return rb_gc_impl_heap_id_for_size(rb_gc_get_objspace(), size);
3226rb_gc_size_allocatable_p(
size_t size)
3228 return rb_gc_impl_size_allocatable_p(size);
3231static enum rb_id_table_iterator_result
3232update_id_table(
VALUE *value,
void *data,
int existing)
3240 return ID_TABLE_CONTINUE;
3247 rb_id_table_foreach_values_with_replace(tbl, check_id_table_move, update_id_table,
objspace);
3251static enum rb_id_table_iterator_result
3255 VM_ASSERT(vm_ccs_p(ccs));
3261 for (
int i=0; i<ccs->len; i++) {
3262 if (rb_gc_impl_object_moved_p(
objspace, (
VALUE)ccs->entries[i].cc)) {
3268 return ID_TABLE_CONTINUE;
3276 rb_id_table_foreach_values(tbl, update_cc_tbl_i,
objspace);
3280static enum rb_id_table_iterator_result
3291 entry->class_value = gc_location_internal(
objspace, entry->class_value);
3293 return ID_TABLE_CONTINUE;
3301 rb_id_table_foreach_values(tbl, update_cvc_tbl_i,
objspace);
3305static enum rb_id_table_iterator_result
3310 if (rb_gc_impl_object_moved_p(
objspace, ce->value)) {
3311 ce->value = gc_location_internal(
objspace, ce->value);
3314 if (rb_gc_impl_object_moved_p(
objspace, ce->file)) {
3315 ce->file = gc_location_internal(
objspace, ce->file);
3318 return ID_TABLE_CONTINUE;
3325 rb_id_table_foreach_values(tbl, update_const_table,
objspace);
3332 UPDATE_IF_MOVED(
objspace, entry->klass);
3333 entry = entry->next;
3340 UPDATE_IF_MOVED(
objspace, ext->origin_);
3341 UPDATE_IF_MOVED(
objspace, ext->includer);
3342 UPDATE_IF_MOVED(
objspace, ext->refined_class);
3343 update_subclass_entries(
objspace, ext->subclasses);
3349 if (
FL_TEST_RAW(obj, RCLASS_SUPERCLASSES_INCLUDE_SELF)) {
3350 for (
size_t i = 0; i < RCLASS_SUPERCLASS_DEPTH(obj) + 1; i++) {
3351 UPDATE_IF_MOVED(
objspace, RCLASS_SUPERCLASSES(obj)[i]);
3357#define global_symbols ruby_global_symbols
3360 vm_table_foreach_callback_func callback;
3361 vm_table_update_callback_func update_callback;
3367vm_weak_table_foreach_weak_key(st_data_t key, st_data_t value, st_data_t data,
int error)
3371 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3373 if (!iter_data->weak_only) {
3374 if (ret != ST_CONTINUE)
return ret;
3376 ret = iter_data->callback((
VALUE)value, iter_data->data);
3383vm_weak_table_foreach_update_weak_key(st_data_t *key, st_data_t *value, st_data_t data,
int existing)
3387 int ret = iter_data->update_callback((
VALUE *)key, iter_data->data);
3389 if (!iter_data->weak_only) {
3390 if (ret != ST_CONTINUE)
return ret;
3392 ret = iter_data->update_callback((
VALUE *)value, iter_data->data);
3399vm_weak_table_str_sym_foreach(st_data_t key, st_data_t value, st_data_t data,
int error)
3403 if (!iter_data->weak_only) {
3404 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3405 if (ret != ST_CONTINUE)
return ret;
3412 return iter_data->callback((
VALUE)value, iter_data->data);
3417vm_weak_table_foreach_update_weak_value(st_data_t *key, st_data_t *value, st_data_t data,
int existing)
3421 if (!iter_data->weak_only) {
3422 int ret = iter_data->update_callback((
VALUE *)key, iter_data->data);
3423 if (ret != ST_CONTINUE)
return ret;
3426 return iter_data->update_callback((
VALUE *)value, iter_data->data);
3432 if (UNLIKELY(rb_shape_obj_too_complex(obj))) {
3433 st_free_table(ivtbl->as.complex.table);
3440vm_weak_table_gen_ivar_foreach_too_complex_i(st_data_t _key, st_data_t value, st_data_t data,
int error)
3444 GC_ASSERT(!iter_data->weak_only);
3448 return iter_data->callback((
VALUE)value, iter_data->data);
3452vm_weak_table_gen_ivar_foreach_too_complex_replace_i(st_data_t *_key, st_data_t *value, st_data_t data,
int existing)
3456 GC_ASSERT(!iter_data->weak_only);
3458 return iter_data->update_callback((
VALUE *)value, iter_data->data);
3461struct st_table *rb_generic_ivtbl_get(
void);
3464vm_weak_table_gen_ivar_foreach(st_data_t key, st_data_t value, st_data_t data)
3468 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3482 ret = iter_data->update_callback(&new_key, iter_data->data);
3483 if (key != new_key) ret = ST_DELETE;
3484 DURING_GC_COULD_MALLOC_REGION_START();
3486 st_insert(rb_generic_ivtbl_get(), (st_data_t)new_key, value);
3488 DURING_GC_COULD_MALLOC_REGION_END();
3489 key = (st_data_t)new_key;
3497 if (!iter_data->weak_only) {
3500 if (rb_shape_obj_too_complex((
VALUE)key)) {
3501 st_foreach_with_replace(
3502 ivtbl->as.complex.table,
3503 vm_weak_table_gen_ivar_foreach_too_complex_i,
3504 vm_weak_table_gen_ivar_foreach_too_complex_replace_i,
3509 for (uint32_t i = 0; i < ivtbl->as.shape.numiv; i++) {
3512 int ivar_ret = iter_data->callback(ivtbl->as.shape.ivptr[i], iter_data->data);
3517 iter_data->update_callback(&ivtbl->as.shape.ivptr[i], iter_data->data);
3520 rb_bug(
"vm_weak_table_gen_ivar_foreach: return value %d not supported", ivar_ret);
3530vm_weak_table_frozen_strings_foreach(st_data_t key, st_data_t value, st_data_t data,
int error)
3532 int retval = vm_weak_table_foreach_weak_key(key, value, data, error);
3533 if (retval == ST_DELETE) {
3539void rb_fstring_foreach_with_replace(st_foreach_check_callback_func *func, st_update_callback_func *replace, st_data_t arg);
3541rb_gc_vm_weak_table_foreach(vm_table_foreach_callback_func callback,
3542 vm_table_update_callback_func update_callback,
3545 enum rb_gc_vm_weak_tables table)
3550 .callback = callback,
3551 .update_callback = update_callback,
3553 .weak_only = weak_only,
3557 case RB_GC_VM_CI_TABLE: {
3559 st_foreach_with_replace(
3561 vm_weak_table_foreach_weak_key,
3562 vm_weak_table_foreach_update_weak_key,
3563 (st_data_t)&foreach_data
3568 case RB_GC_VM_OVERLOADED_CME_TABLE: {
3569 if (vm->overloaded_cme_table) {
3570 st_foreach_with_replace(
3571 vm->overloaded_cme_table,
3572 vm_weak_table_foreach_weak_key,
3573 vm_weak_table_foreach_update_weak_key,
3574 (st_data_t)&foreach_data
3579 case RB_GC_VM_GLOBAL_SYMBOLS_TABLE: {
3580 if (global_symbols.str_sym) {
3581 st_foreach_with_replace(
3582 global_symbols.str_sym,
3583 vm_weak_table_str_sym_foreach,
3584 vm_weak_table_foreach_update_weak_value,
3585 (st_data_t)&foreach_data
3590 case RB_GC_VM_GENERIC_IV_TABLE: {
3591 st_table *generic_iv_tbl = rb_generic_ivtbl_get();
3592 if (generic_iv_tbl) {
3595 vm_weak_table_gen_ivar_foreach,
3596 (st_data_t)&foreach_data
3601 case RB_GC_VM_FROZEN_STRINGS_TABLE: {
3602 rb_fstring_foreach_with_replace(
3603 vm_weak_table_frozen_strings_foreach,
3604 vm_weak_table_foreach_update_weak_key,
3605 (st_data_t)&foreach_data
3610 rb_bug(
"rb_gc_vm_weak_table_foreach: unknown table %d", table);
3615rb_gc_update_vm_references(
void *
objspace)
3618 rb_vm_t *vm = rb_ec_vm_ptr(ec);
3620 rb_vm_update_references(vm);
3621 rb_gc_update_global_tbl();
3622 rb_sym_global_symbols_update_references();
3625 void rb_yjit_root_update_references(
void);
3627 if (rb_yjit_enabled_p) {
3628 rb_yjit_root_update_references();
3639 UPDATE_IF_MOVED(
objspace, RCLASS_ATTACHED_OBJECT(obj));
3646 update_m_tbl(
objspace, RCLASS_M_TBL(obj));
3649 update_superclasses(
objspace, obj);
3651 if (rb_shape_obj_too_complex(obj)) {
3652 gc_ref_update_table_values_only(RCLASS_IV_HASH(obj));
3655 for (attr_index_t i = 0; i < RCLASS_IV_COUNT(obj); i++) {
3656 UPDATE_IF_MOVED(
objspace, RCLASS_IVPTR(obj)[i]);
3660 update_class_ext(
objspace, RCLASS_EXT(obj));
3661 update_const_tbl(
objspace, RCLASS_CONST_TBL(obj));
3663 UPDATE_IF_MOVED(
objspace, RCLASS_EXT(obj)->classpath);
3667 if (RICLASS_OWNS_M_TBL_P(obj)) {
3668 update_m_tbl(
objspace, RCLASS_M_TBL(obj));
3673 update_class_ext(
objspace, RCLASS_EXT(obj));
3674 update_m_tbl(
objspace, RCLASS_CALLABLE_M_TBL(obj));
3679 rb_imemo_mark_and_move(obj,
true);
3691 gc_ref_update_array(
objspace, obj);
3696 UPDATE_IF_MOVED(
objspace, RHASH(obj)->ifnone);
3701 if (STR_SHARED_P(obj)) {
3707 if (rb_gc_obj_slot_size(obj) >= rb_str_size_as_embedded(obj)) {
3708 if (!STR_EMBED_P(obj) && rb_str_reembeddable_p(obj)) {
3709 rb_str_make_embedded(obj);
3721 size_t *offset_list = TYPED_DATA_REFS_OFFSET_LIST(obj);
3723 for (
size_t offset = *offset_list; offset != RUBY_REF_END; offset = *offset_list++) {
3724 VALUE *ref = (
VALUE *)((
char *)ptr + offset);
3725 *ref = gc_location_internal(
objspace, *ref);
3730 if (compact_func) (*compact_func)(ptr);
3737 gc_ref_update_object(
objspace, obj);
3741 if (
RFILE(obj)->fptr) {
3744 UPDATE_IF_MOVED(
objspace,
RFILE(obj)->fptr->tied_io_for_writing);
3745 UPDATE_IF_MOVED(
objspace,
RFILE(obj)->fptr->writeconv_asciicompat);
3746 UPDATE_IF_MOVED(
objspace,
RFILE(obj)->fptr->writeconv_pre_ecopts);
3756 UPDATE_IF_MOVED(
objspace, RSYMBOL(obj)->fstr);
3772 UPDATE_IF_MOVED(
objspace, RRATIONAL(obj)->num);
3773 UPDATE_IF_MOVED(
objspace, RRATIONAL(obj)->den);
3777 UPDATE_IF_MOVED(
objspace, RCOMPLEX(obj)->real);
3778 UPDATE_IF_MOVED(
objspace, RCOMPLEX(obj)->imag);
3784 long i,
len = RSTRUCT_LEN(obj);
3785 VALUE *ptr = (
VALUE *)RSTRUCT_CONST_PTR(obj);
3787 for (i = 0; i <
len; i++) {
3793 rb_bug(
"unreachable");
3810 unless_objspace(
objspace) {
return; }
3812 rb_gc_impl_start(
objspace,
true,
true,
true,
false);
3818 unless_objspace(
objspace) {
return FALSE; }
3820 return rb_gc_impl_during_gc_p(
objspace);
3826 return rb_gc_impl_gc_count(rb_gc_get_objspace());
3842 VALUE val = rb_gc_impl_latest_gc_info(rb_gc_get_objspace(), key);
3845 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(key));
3855 arg = rb_hash_new();
3861 VALUE ret = rb_gc_impl_stat(rb_gc_get_objspace(), arg);
3866 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(arg));
3879 VALUE ret = rb_gc_impl_stat(rb_gc_get_objspace(), arg);
3884 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(arg));
3899 arg = rb_hash_new();
3902 if (
NIL_P(heap_name)) {
3913 rb_raise(
rb_eTypeError,
"heap_name must be nil or an Integer");
3916 VALUE ret = rb_gc_impl_stat_heap(rb_gc_get_objspace(), heap_name, arg);
3921 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(arg));
3930 VALUE cfg_hash = rb_gc_impl_config_get(rb_gc_get_objspace());
3931 rb_hash_aset(cfg_hash, sym(
"implementation"), rb_fstring_cstr(rb_gc_impl_active_gc_name()));
3939 void *
objspace = rb_gc_get_objspace();
3941 rb_gc_impl_config_set(
objspace, hash);
3943 return rb_gc_impl_config_get(
objspace);
3949 return rb_gc_impl_stress_get(rb_gc_get_objspace());
3955 rb_gc_impl_stress_set(rb_gc_get_objspace(), flag);
3961rb_gc_initial_stress_set(
VALUE flag)
3963 initial_stress = flag;
3967rb_gc_heap_sizes(
void)
3969 return rb_gc_impl_heap_sizes(rb_gc_get_objspace());
3975 return rb_objspace_gc_enable(rb_gc_get_objspace());
3979rb_objspace_gc_enable(
void *
objspace)
3981 bool disabled = !rb_gc_impl_gc_enabled_p(
objspace);
3983 return RBOOL(disabled);
3989 return rb_gc_enable();
3995 bool disabled = !rb_gc_impl_gc_enabled_p(
objspace);
3996 rb_gc_impl_gc_disable(
objspace,
false);
3997 return RBOOL(disabled);
4001rb_gc_disable_no_rest(
void)
4003 return gc_disable_no_rest(rb_gc_get_objspace());
4009 return rb_objspace_gc_disable(rb_gc_get_objspace());
4013rb_objspace_gc_disable(
void *
objspace)
4015 bool disabled = !rb_gc_impl_gc_enabled_p(
objspace);
4016 rb_gc_impl_gc_disable(
objspace,
true);
4017 return RBOOL(disabled);
4023 return rb_gc_disable();
4028ruby_gc_set_params(
void)
4030 rb_gc_impl_set_params(rb_gc_get_objspace());
4034rb_objspace_reachable_objects_from(
VALUE obj,
void (func)(
VALUE,
void *),
void *data)
4038 if (rb_gc_impl_during_gc_p(rb_gc_get_objspace())) rb_bug(
"rb_objspace_reachable_objects_from() is not supported while during GC");
4042 struct gc_mark_func_data_struct *prev_mfd = vm->gc.mark_func_data;
4043 struct gc_mark_func_data_struct mfd = {
4048 vm->gc.mark_func_data = &mfd;
4049 rb_gc_mark_children(rb_gc_get_objspace(), obj);
4050 vm->gc.mark_func_data = prev_mfd;
4057 const char *category;
4058 void (*func)(
const char *category,
VALUE,
void *);
4063root_objects_from(
VALUE obj,
void *ptr)
4066 (*data->func)(data->category, obj, data->data);
4070rb_objspace_reachable_objects_from_root(
void (func)(
const char *category,
VALUE,
void *),
void *passing_data)
4072 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");
4078 .data = passing_data,
4081 struct gc_mark_func_data_struct *prev_mfd = vm->gc.mark_func_data;
4082 struct gc_mark_func_data_struct mfd = {
4083 .mark_func = root_objects_from,
4087 vm->gc.mark_func_data = &mfd;
4088 rb_gc_save_machine_context();
4089 rb_gc_mark_roots(vm->gc.objspace, &data.category);
4090 vm->gc.mark_func_data = prev_mfd;
4101#define TYPE_NAME(t) case (t): return #t;
4128 if (obj && rb_objspace_data_type_name(obj)) {
4129 return rb_objspace_data_type_name(obj);
4138obj_type_name(
VALUE obj)
4140 return type_name(
TYPE(obj), obj);
4144rb_method_type_name(rb_method_type_t
type)
4147 case VM_METHOD_TYPE_ISEQ:
return "iseq";
4148 case VM_METHOD_TYPE_ATTRSET:
return "attrest";
4149 case VM_METHOD_TYPE_IVAR:
return "ivar";
4150 case VM_METHOD_TYPE_BMETHOD:
return "bmethod";
4151 case VM_METHOD_TYPE_ALIAS:
return "alias";
4152 case VM_METHOD_TYPE_REFINED:
return "refined";
4153 case VM_METHOD_TYPE_CFUNC:
return "cfunc";
4154 case VM_METHOD_TYPE_ZSUPER:
return "zsuper";
4155 case VM_METHOD_TYPE_MISSING:
return "missing";
4156 case VM_METHOD_TYPE_OPTIMIZED:
return "optimized";
4157 case VM_METHOD_TYPE_UNDEF:
return "undef";
4158 case VM_METHOD_TYPE_NOTIMPLEMENTED:
return "notimplemented";
4160 rb_bug(
"rb_method_type_name: unreachable (type: %d)",
type);
4164rb_raw_iseq_info(
char *
const buff,
const size_t buff_size,
const rb_iseq_t *iseq)
4166 if (buff_size > 0 && ISEQ_BODY(iseq) && ISEQ_BODY(iseq)->location.label && !
RB_TYPE_P(ISEQ_BODY(iseq)->location.pathobj,
T_MOVED)) {
4167 VALUE path = rb_iseq_path(iseq);
4168 int n = ISEQ_BODY(iseq)->location.first_lineno;
4169 snprintf(buff, buff_size,
" %s@%s:%d",
4170 RSTRING_PTR(ISEQ_BODY(iseq)->location.label),
4171 RSTRING_PTR(path), n);
4176str_len_no_raise(
VALUE str)
4178 long len = RSTRING_LEN(str);
4179 if (
len < 0)
return 0;
4180 if (
len > INT_MAX)
return INT_MAX;
4184#define BUFF_ARGS buff + pos, buff_size - pos
4185#define APPEND_F(...) if ((pos += snprintf(BUFF_ARGS, "" __VA_ARGS__)) >= buff_size) goto end
4186#define APPEND_S(s) do { \
4187 if ((pos + (int)rb_strlen_lit(s)) >= buff_size) { \
4191 memcpy(buff + pos, (s), rb_strlen_lit(s) + 1); \
4194#define C(c, s) ((c) != 0 ? (s) : " ")
4197rb_raw_obj_info_common(
char *
const buff,
const size_t buff_size,
const VALUE obj)
4202 APPEND_F(
"%s", obj_type_name(obj));
4208 APPEND_F(
" %s", rb_id2name(
SYM2ID(obj)));
4214 if (rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (
void *)obj)) {
4233 if (internal_object_p(obj)) {
4236 else if (
RBASIC(obj)->klass == 0) {
4237 APPEND_S(
"(temporary internal)");
4241 if (!
NIL_P(class_path)) {
4242 APPEND_F(
"(%s)", RSTRING_PTR(class_path));
4251const char *rb_raw_obj_info(
char *
const buff,
const size_t buff_size,
VALUE obj);
4254rb_raw_obj_info_buitin_type(
char *
const buff,
const size_t buff_size,
const VALUE obj,
size_t pos)
4261 UNEXPECTED_NODE(rb_raw_obj_info);
4264 if (ARY_SHARED_P(obj)) {
4265 APPEND_S(
"shared -> ");
4266 rb_raw_obj_info(BUFF_ARGS, ARY_SHARED_ROOT(obj));
4268 else if (ARY_EMBED_P(obj)) {
4269 APPEND_F(
"[%s%s] len: %ld (embed)",
4270 C(ARY_EMBED_P(obj),
"E"),
4271 C(ARY_SHARED_P(obj),
"S"),
4275 APPEND_F(
"[%s%s] len: %ld, capa:%ld ptr:%p",
4276 C(ARY_EMBED_P(obj),
"E"),
4277 C(ARY_SHARED_P(obj),
"S"),
4279 ARY_EMBED_P(obj) ? -1L :
RARRAY(obj)->as.heap.aux.
capa,
4284 if (STR_SHARED_P(obj)) {
4285 APPEND_F(
" [shared] len: %ld", RSTRING_LEN(obj));
4288 if (STR_EMBED_P(obj)) APPEND_S(
" [embed]");
4290 APPEND_F(
" len: %ld, capa: %" PRIdSIZE, RSTRING_LEN(obj),
rb_str_capacity(obj));
4292 APPEND_F(
" \"%.*s\"", str_len_no_raise(obj), RSTRING_PTR(obj));
4296 VALUE fstr = RSYMBOL(obj)->fstr;
4297 ID id = RSYMBOL(obj)->id;
4299 APPEND_F(
":%s id:%d", RSTRING_PTR(fstr), (
unsigned int)
id);
4302 APPEND_F(
"(%p) id:%d", (
void *)fstr, (
unsigned int)
id);
4307 APPEND_F(
"-> %p", (
void*)gc_location_internal(rb_gc_get_objspace(), obj));
4311 APPEND_F(
"[%c] %"PRIdSIZE,
4312 RHASH_AR_TABLE_P(obj) ?
'A' :
'S',
4320 if (!
NIL_P(class_path)) {
4321 APPEND_F(
"%s", RSTRING_PTR(class_path));
4331 if (!
NIL_P(class_path)) {
4332 APPEND_F(
"src:%s", RSTRING_PTR(class_path));
4338 if (rb_shape_obj_too_complex(obj)) {
4339 size_t hash_len = rb_st_table_size(ROBJECT_IV_HASH(obj));
4340 APPEND_F(
"(too_complex) len:%zu", hash_len);
4343 uint32_t
len = ROBJECT_IV_CAPACITY(obj);
4345 if (
RBASIC(obj)->flags & ROBJECT_EMBED) {
4346 APPEND_F(
"(embed) len:%d",
len);
4350 APPEND_F(
"len:%d ptr:%p",
len, (
void *)ptr);
4359 (block = vm_proc_block(obj)) != NULL &&
4360 (vm_block_type(block) == block_type_iseq) &&
4361 (iseq = vm_block_iseq(block)) != NULL) {
4362 rb_raw_iseq_info(BUFF_ARGS, iseq);
4364 else if (rb_ractor_p(obj)) {
4367 APPEND_F(
"r:%d", r->pub.id);
4371 const char *
const type_name = rb_objspace_data_type_name(obj);
4373 APPEND_F(
"%s", type_name);
4379 APPEND_F(
"<%s> ", rb_imemo_name(imemo_type(obj)));
4381 switch (imemo_type(obj)) {
4386 APPEND_F(
":%s (%s%s%s%s) type:%s aliased:%d owner:%p defined_class:%p",
4387 rb_id2name(me->called_id),
4388 METHOD_ENTRY_VISI(me) == METHOD_VISI_PUBLIC ?
"pub" :
4389 METHOD_ENTRY_VISI(me) == METHOD_VISI_PRIVATE ?
"pri" :
"pro",
4390 METHOD_ENTRY_COMPLEMENTED(me) ?
",cmp" :
"",
4391 METHOD_ENTRY_CACHED(me) ?
",cc" :
"",
4392 METHOD_ENTRY_INVALIDATED(me) ?
",inv" :
"",
4393 me->def ? rb_method_type_name(me->def->
type) :
"NULL",
4394 me->def ? me->def->aliased : -1,
4396 (void *)me->defined_class);
4399 switch (me->def->type) {
4400 case VM_METHOD_TYPE_ISEQ:
4401 APPEND_S(
" (iseq:");
4402 rb_raw_obj_info(BUFF_ARGS, (
VALUE)me->def->body.iseq.
iseqptr);
4414 rb_raw_iseq_info(BUFF_ARGS, iseq);
4417 case imemo_callinfo:
4420 APPEND_F(
"(mid:%s, flag:%x argc:%d, kwarg:%s)",
4421 rb_id2name(vm_ci_mid(ci)),
4424 vm_ci_kwarg(ci) ?
"available" :
"NULL");
4427 case imemo_callcache:
4433 APPEND_F(
"(klass:%s cme:%s%s (%p) call:%p",
4434 NIL_P(class_path) ? (cc->klass ?
"??" :
"<NULL>") : RSTRING_PTR(class_path),
4435 cme ? rb_id2name(cme->called_id) :
"<NULL>",
4436 cme ? (METHOD_ENTRY_INVALIDATED(cme) ?
" [inv]" :
"") :
"",
4438 (void *)(uintptr_t)vm_cc_call(cc));
4457rb_asan_poison_object(
VALUE obj)
4459 MAYBE_UNUSED(
struct RVALUE *) ptr = (
void *)obj;
4460 asan_poison_memory_region(ptr, rb_gc_obj_slot_size(obj));
4464rb_asan_unpoison_object(
VALUE obj,
bool newobj_p)
4466 MAYBE_UNUSED(
struct RVALUE *) ptr = (
void *)obj;
4467 asan_unpoison_memory_region(ptr, rb_gc_obj_slot_size(obj), newobj_p);
4471rb_asan_poisoned_object_p(
VALUE obj)
4473 MAYBE_UNUSED(
struct RVALUE *) ptr = (
void *)obj;
4474 return __asan_region_is_poisoned(ptr, rb_gc_obj_slot_size(obj));
4477#define asan_unpoisoning_object(obj) \
4478 for (void *poisoned = asan_unpoison_object_temporary(obj), \
4479 *unpoisoning = &poisoned; \
4481 unpoisoning = asan_poison_object_restore(obj, poisoned))
4484rb_raw_obj_info(
char *
const buff,
const size_t buff_size,
VALUE obj)
4486 asan_unpoisoning_object(obj) {
4487 size_t pos = rb_raw_obj_info_common(buff, buff_size, obj);
4488 pos = rb_raw_obj_info_buitin_type(buff, buff_size, obj, pos);
4489 if (pos >= buff_size) {}
4500#define OBJ_INFO_BUFFERS_NUM 10
4501#define OBJ_INFO_BUFFERS_SIZE 0x100
4503static char obj_info_buffers[OBJ_INFO_BUFFERS_NUM][OBJ_INFO_BUFFERS_SIZE];
4511 if (RB_UNLIKELY(oldval >= maxval - 1)) {
4522 rb_atomic_t index = atomic_inc_wraparound(&obj_info_buffers_index, OBJ_INFO_BUFFERS_NUM);
4523 char *
const buff = obj_info_buffers[index];
4524 return rb_raw_obj_info(buff, OBJ_INFO_BUFFERS_SIZE, obj);
4530 return obj_type_name(obj);
4548 rb_vraise(argv->exc, argv->fmt, *argv->ap);
4553gc_raise(
VALUE exc,
const char *fmt, ...)
4561 if (ruby_thread_has_gvl_p()) {
4571 fprintf(stderr,
"%s",
"[FATAL] ");
4572 vfprintf(stderr, fmt, ap);
4579NORETURN(
static void negative_size_allocation_error(
const char *));
4581negative_size_allocation_error(
const char *msg)
4587ruby_memerror_body(
void *dummy)
4593NORETURN(
static void ruby_memerror(
void));
4598 if (ruby_thread_has_gvl_p()) {
4607 fprintf(stderr,
"[FATAL] failed to allocate memory\n");
4625 VALUE exc = GET_VM()->special_exceptions[ruby_error_nomemory];
4628 rb_ec_raised_p(ec, RAISED_NOMEMORY) ||
4629 rb_ec_vm_lock_rec(ec) != ec->tag->lock_rec) {
4630 fprintf(stderr,
"[FATAL] failed to allocate memory\n");
4633 if (rb_ec_raised_p(ec, RAISED_NOMEMORY)) {
4634 rb_ec_raised_clear(ec);
4637 rb_ec_raised_set(ec, RAISED_NOMEMORY);
4638 exc = ruby_vm_special_exception_copy(exc);
4641 EC_JUMP_TAG(ec, TAG_RAISE);
4645rb_memerror_reentered(
void)
4648 return (ec && rb_ec_raised_p(ec, RAISED_NOMEMORY));
4652rb_malloc_info_show_results(
void)
4657handle_malloc_failure(
void *ptr)
4668static void *ruby_xmalloc_body(
size_t size);
4671ruby_xmalloc(
size_t size)
4673 return handle_malloc_failure(ruby_xmalloc_body(size));
4677ruby_xmalloc_body(
size_t size)
4679 if ((ssize_t)size < 0) {
4680 negative_size_allocation_error(
"too large allocation size");
4683 return rb_gc_impl_malloc(rb_gc_get_objspace(), size);
4687ruby_malloc_size_overflow(
size_t count,
size_t elsize)
4689 rb_raise(rb_eArgError,
4690 "malloc: possible integer overflow (%"PRIuSIZE
"*%"PRIuSIZE
")",
4695ruby_malloc_add_size_overflow(
size_t x,
size_t y)
4697 rb_raise(rb_eArgError,
4698 "malloc: possible integer overflow (%"PRIuSIZE
"+%"PRIuSIZE
")",
4702static void *ruby_xmalloc2_body(
size_t n,
size_t size);
4705ruby_xmalloc2(
size_t n,
size_t size)
4707 return handle_malloc_failure(ruby_xmalloc2_body(n, size));
4711ruby_xmalloc2_body(
size_t n,
size_t size)
4713 return rb_gc_impl_malloc(rb_gc_get_objspace(), xmalloc2_size(n, size));
4716static void *ruby_xcalloc_body(
size_t n,
size_t size);
4719ruby_xcalloc(
size_t n,
size_t size)
4721 return handle_malloc_failure(ruby_xcalloc_body(n, size));
4725ruby_xcalloc_body(
size_t n,
size_t size)
4727 return rb_gc_impl_calloc(rb_gc_get_objspace(), xmalloc2_size(n, size));
4730static void *ruby_sized_xrealloc_body(
void *ptr,
size_t new_size,
size_t old_size);
4732#ifdef ruby_sized_xrealloc
4733#undef ruby_sized_xrealloc
4736ruby_sized_xrealloc(
void *ptr,
size_t new_size,
size_t old_size)
4738 return handle_malloc_failure(ruby_sized_xrealloc_body(ptr, new_size, old_size));
4742ruby_sized_xrealloc_body(
void *ptr,
size_t new_size,
size_t old_size)
4744 if ((ssize_t)new_size < 0) {
4745 negative_size_allocation_error(
"too large allocation size");
4748 return rb_gc_impl_realloc(rb_gc_get_objspace(), ptr, new_size, old_size);
4752ruby_xrealloc(
void *ptr,
size_t new_size)
4754 return ruby_sized_xrealloc(ptr, new_size, 0);
4757static void *ruby_sized_xrealloc2_body(
void *ptr,
size_t n,
size_t size,
size_t old_n);
4759#ifdef ruby_sized_xrealloc2
4760#undef ruby_sized_xrealloc2
4763ruby_sized_xrealloc2(
void *ptr,
size_t n,
size_t size,
size_t old_n)
4765 return handle_malloc_failure(ruby_sized_xrealloc2_body(ptr, n, size, old_n));
4769ruby_sized_xrealloc2_body(
void *ptr,
size_t n,
size_t size,
size_t old_n)
4771 size_t len = xmalloc2_size(n, size);
4772 return rb_gc_impl_realloc(rb_gc_get_objspace(), ptr,
len, old_n * size);
4776ruby_xrealloc2(
void *ptr,
size_t n,
size_t size)
4778 return ruby_sized_xrealloc2(ptr, n, size, 0);
4781#ifdef ruby_sized_xfree
4782#undef ruby_sized_xfree
4785ruby_sized_xfree(
void *x,
size_t size)
4791 if (LIKELY(GET_VM())) {
4792 rb_gc_impl_free(rb_gc_get_objspace(), x, size);
4803 ruby_sized_xfree(x, 0);
4807rb_xmalloc_mul_add(
size_t x,
size_t y,
size_t z)
4809 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
4810 return ruby_xmalloc(w);
4814rb_xcalloc_mul_add(
size_t x,
size_t y,
size_t z)
4816 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
4817 return ruby_xcalloc(w, 1);
4821rb_xrealloc_mul_add(
const void *p,
size_t x,
size_t y,
size_t z)
4823 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
4824 return ruby_xrealloc((
void *)p, w);
4828rb_xmalloc_mul_add_mul(
size_t x,
size_t y,
size_t z,
size_t w)
4830 size_t u = size_mul_add_mul_or_raise(x, y, z, w, rb_eArgError);
4831 return ruby_xmalloc(u);
4835rb_xcalloc_mul_add_mul(
size_t x,
size_t y,
size_t z,
size_t w)
4837 size_t u = size_mul_add_mul_or_raise(x, y, z, w, rb_eArgError);
4838 return ruby_xcalloc(u, 1);
4845ruby_mimmalloc(
size_t size)
4848#if CALC_EXACT_MALLOC_SIZE
4852#if CALC_EXACT_MALLOC_SIZE
4868ruby_mimcalloc(
size_t num,
size_t size)
4871#if CALC_EXACT_MALLOC_SIZE
4872 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(num, size);
4873 if (UNLIKELY(t.left)) {
4877 mem = calloc1(size);
4889 mem = calloc(num, size);
4895ruby_mimfree(
void *ptr)
4897#if CALC_EXACT_MALLOC_SIZE
4905rb_gc_adjust_memory_usage(ssize_t diff)
4907 unless_objspace(
objspace) {
return; }
4909 rb_gc_impl_adjust_memory_usage(
objspace, diff);
4913rb_obj_info(
VALUE obj)
4915 return obj_info(obj);
4919rb_obj_info_dump(
VALUE obj)
4922 fprintf(stderr,
"rb_obj_info_dump: %s\n", rb_raw_obj_info(buff, 0x100, obj));
4926rb_obj_info_dump_loc(
VALUE obj,
const char *file,
int line,
const char *func)
4929 fprintf(stderr,
"<OBJ_INFO:%s@%s:%d> %s\n", func, file, line, rb_raw_obj_info(buff, 0x100, obj));
4933rb_gc_before_fork(
void)
4935 rb_gc_impl_before_fork(rb_gc_get_objspace());
4939rb_gc_after_fork(rb_pid_t pid)
4941 rb_gc_impl_after_fork(rb_gc_get_objspace(), pid);
4995 malloc_offset = gc_compute_malloc_offset();
5008 rb_vm_register_special_exception(ruby_error_nomemory,
rb_eNoMemError,
"failed to allocate memory");
5031ruby_annotate_mmap(
const void *addr,
unsigned long size,
const char *name)
5033#if defined(HAVE_SYS_PRCTL_H) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
5036 prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME, (
unsigned long)addr, size, name);
#define RUBY_ASSERT_ALWAYS(expr,...)
A variant of RUBY_ASSERT that does not interface with RUBY_DEBUG.
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define RUBY_ATOMIC_CAS(var, oldval, newval)
Atomic compare-and-swap.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#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...
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_module_function(klass, mid, func, arity)
Defines klass#mid and makes it a module function.
uint32_t rb_event_flag_t
Represents event(s).
#define RUBY_INTERNAL_EVENT_NEWOBJ
Object allocated.
static VALUE RB_FL_TEST_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_TEST().
static void RB_FL_SET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_SET().
VALUE rb_define_module(const char *name)
Defines a top-level module.
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.
#define T_COMPLEX
Old name of RUBY_T_COMPLEX.
#define TYPE(_)
Old name of rb_type.
#define FL_SINGLETON
Old name of RUBY_FL_SINGLETON.
#define T_FILE
Old name of RUBY_T_FILE.
#define FL_EXIVAR
Old name of RUBY_FL_EXIVAR.
#define ALLOC
Old name of RB_ALLOC.
#define T_STRING
Old name of RUBY_T_STRING.
#define xfree
Old name of ruby_xfree.
#define T_MASK
Old name of RUBY_T_MASK.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define T_NIL
Old name of RUBY_T_NIL.
#define UNREACHABLE
Old name of RBIMPL_UNREACHABLE.
#define T_FLOAT
Old name of RUBY_T_FLOAT.
#define T_IMEMO
Old name of RUBY_T_IMEMO.
#define ID2SYM
Old name of RB_ID2SYM.
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define T_STRUCT
Old name of RUBY_T_STRUCT.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define T_FIXNUM
Old name of RUBY_T_FIXNUM.
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
#define SYM2ID
Old name of RB_SYM2ID.
#define T_DATA
Old name of RUBY_T_DATA.
#define FIXNUM_FLAG
Old name of RUBY_FIXNUM_FLAG.
#define LL2NUM
Old name of RB_LL2NUM.
#define T_NONE
Old name of RUBY_T_NONE.
#define T_NODE
Old name of RUBY_T_NODE.
#define SIZET2NUM
Old name of RB_SIZE2NUM.
#define FL_FINALIZE
Old name of RUBY_FL_FINALIZE.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define STATIC_SYM_P
Old name of RB_STATIC_SYM_P.
#define T_TRUE
Old name of RUBY_T_TRUE.
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define T_HASH
Old name of RUBY_T_HASH.
#define FL_ABLE
Old name of RB_FL_ABLE.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define rb_ary_new3
Old name of rb_ary_new_from_args.
#define LONG2NUM
Old name of RB_LONG2NUM.
#define T_FALSE
Old name of RUBY_T_FALSE.
#define T_UNDEF
Old name of RUBY_T_UNDEF.
#define FLONUM_P
Old name of RB_FLONUM_P.
#define Qtrue
Old name of RUBY_Qtrue.
#define T_ZOMBIE
Old name of RUBY_T_ZOMBIE.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define FIX2LONG
Old name of RB_FIX2LONG.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
#define T_OBJECT
Old name of RUBY_T_OBJECT.
#define NIL_P
Old name of RB_NIL_P.
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
#define T_MATCH
Old name of RUBY_T_MATCH.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define T_MOVED
Old name of RUBY_T_MOVED.
#define FL_TEST
Old name of RB_FL_TEST.
#define xcalloc
Old name of ruby_xcalloc.
#define FL_UNSET
Old name of RB_FL_UNSET.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define NUM2SIZET
Old name of RB_NUM2SIZE.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
#define T_REGEXP
Old name of RUBY_T_REGEXP.
size_t ruby_stack_length(VALUE **p)
Queries what Ruby thinks is the machine stack.
int ruby_stack_check(void)
Checks for stack overflow.
VALUE rb_eNoMemError
NoMemoryError exception.
VALUE rb_eRangeError
RangeError exception.
#define ruby_verbose
This variable controls whether the interpreter is in debug mode.
VALUE rb_eTypeError
TypeError exception.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
size_t rb_obj_embedded_size(uint32_t numiv)
Internal header for Object.
VALUE rb_mKernel
Kernel module.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_cBasicObject
BasicObject class.
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.
VALUE rb_to_int(VALUE val)
Identical to rb_check_to_int(), except it raises in case of conversion mismatch.
int rb_enc_str_coderange(VALUE str)
Scans the passed string to collect its code range.
Defines RBIMPL_HAS_BUILTIN.
#define RETURN_ENUMERATOR(obj, argc, argv)
Identical to RETURN_SIZED_ENUMERATOR(), except its size is unknown.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
VALUE rb_block_proc(void)
Constructs a Proc object from implicitly passed components.
VALUE rb_obj_is_proc(VALUE recv)
Queries if the given object is a proc.
void rb_str_free(VALUE str)
Destroys the given string for no reason.
size_t rb_str_capacity(VALUE str)
Queries the capacity of the given string.
VALUE rb_class_path_cached(VALUE mod)
Just another name of rb_mod_name.
void rb_free_generic_ivar(VALUE obj)
Frees the list of instance variables.
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
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.
rb_alloc_func_t rb_get_alloc_func(VALUE klass)
Queries the allocator function of a class.
int rb_obj_respond_to(VALUE obj, ID mid, int private_p)
Identical to rb_respond_to(), except it additionally takes the visibility parameter.
VALUE rb_sym2str(VALUE symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
int capa
Designed capacity of the buffer.
int rb_io_fptr_finalize(rb_io_t *fptr)
Destroys the given IO.
int len
Length of the buffer.
static bool rb_ractor_shareable_p(VALUE obj)
Queries if multiple Ractors can share the passed object or not.
void * rb_thread_call_with_gvl(void *(*func)(void *), void *data1)
(Re-)acquires the GVL.
VALUE rb_yield(VALUE val)
Yields the block.
#define RBIMPL_ATTR_MAYBE_UNUSED()
Wraps (or simulates) [[maybe_unused]]
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
VALUE type(ANYARGS)
ANYARGS-ed function type.
#define RARRAY_LEN
Just another name of rb_array_len.
#define RARRAY(obj)
Convenient casting macro.
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define RBASIC(obj)
Convenient casting macro.
#define RCLASS_SUPER
Just another name of rb_class_get_superclass.
#define RCLASS(obj)
Convenient casting macro.
#define DATA_PTR(obj)
Convenient getter macro.
#define RDATA(obj)
Convenient casting macro.
#define RUBY_DEFAULT_FREE
This is a value you can set to RData::dfree.
void(* RUBY_DATA_FUNC)(void *)
This is the type of callbacks registered to RData.
#define RFILE(obj)
Convenient casting macro.
#define RHASH_SIZE(h)
Queries the size of the hash.
#define RHASH_EMPTY_P(h)
Checks if the hash is empty.
#define RMATCH(obj)
Convenient casting macro.
#define ROBJECT(obj)
Convenient casting macro.
static VALUE * ROBJECT_IVPTR(VALUE obj)
Queries the instance variables.
#define RREGEXP(obj)
Convenient casting macro.
#define RREGEXP_PTR(obj)
Convenient accessor macro.
#define RSTRING(obj)
Convenient casting macro.
static bool RTYPEDDATA_P(VALUE obj)
Checks whether the passed object is RTypedData or RData.
#define RTYPEDDATA(obj)
Convenient casting macro.
static const struct rb_data_type_struct * RTYPEDDATA_TYPE(VALUE obj)
Queries for the type of given object.
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
#define errno
Ractor-aware version of errno.
int ruby_native_thread_p(void)
Queries if the thread which calls this function is a ruby's thread.
static bool RB_SPECIAL_CONST_P(VALUE obj)
Checks if the given object is of enum ruby_special_consts.
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
This is the struct that holds necessary info for a struct.
const char * wrap_struct_name
Name of structs of this kind.
VALUE flags
Type-specific behavioural characteristics.
Ruby's IO, metadata and buffers.
struct rmatch_offset * char_offset
Capture group offsets, in C array.
int char_offset_num_allocated
Number of rmatch_offset that ::rmatch::char_offset holds.
struct re_registers regs
"Registers" of a match.
const rb_iseq_t * iseqptr
iseq pointer, should be separated from iseqval
Internal header for Class.
Represents the region of a capture group.
void rb_native_mutex_lock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_lock.
void rb_native_mutex_initialize(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_initialize.
void rb_native_mutex_unlock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_unlock.
intptr_t SIGNED_VALUE
A signed integer type that has the same width with VALUE.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
#define SIZEOF_VALUE
Identical to sizeof(VALUE), except it is a macro that can also be used inside of preprocessor directi...
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
ruby_value_type
C-level type of an object.