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/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"
121#include "ruby_assert.h"
122#include "ruby_atomic.h"
127#include "vm_callinfo.h"
128#include "ractor_core.h"
135rb_gc_vm_lock(
const char *file,
int line)
137 unsigned int lev = 0;
138 rb_vm_lock_enter(&lev, file, line);
143rb_gc_vm_unlock(
unsigned int lev,
const char *file,
int line)
145 rb_vm_lock_leave(&lev, file, line);
149rb_gc_cr_lock(
const char *file,
int line)
152 rb_vm_lock_enter_cr(GET_RACTOR(), &lev, file, line);
157rb_gc_cr_unlock(
unsigned int lev,
const char *file,
int line)
159 rb_vm_lock_leave_cr(GET_RACTOR(), &lev, file, line);
163rb_gc_vm_lock_no_barrier(
const char *file,
int line)
165 unsigned int lev = 0;
166 rb_vm_lock_enter_nb(&lev, file, line);
171rb_gc_vm_unlock_no_barrier(
unsigned int lev,
const char *file,
int line)
173 rb_vm_lock_leave_nb(&lev, file, line);
177rb_gc_vm_barrier(
void)
184rb_gc_get_ractor_newobj_cache(
void)
186 return GET_RACTOR()->newobj_cache;
190rb_gc_initialize_vm_context(
struct rb_gc_vm_context *context)
193 context->ec = GET_EC();
197rb_gc_worker_thread_set_vm_context(
struct rb_gc_vm_context *context)
201 GC_ASSERT(rb_current_execution_context(
false) == NULL);
203#ifdef RB_THREAD_LOCAL_SPECIFIER
204 rb_current_ec_set(context->ec);
206 native_tls_set(ruby_current_ec_key, context->ec);
211rb_gc_worker_thread_unset_vm_context(
struct rb_gc_vm_context *context)
215 GC_ASSERT(rb_current_execution_context(
true) == context->ec);
217#ifdef RB_THREAD_LOCAL_SPECIFIER
218 rb_current_ec_set(NULL);
220 native_tls_set(ruby_current_ec_key, NULL);
228 return ruby_vm_event_flags & event;
234 if (LIKELY(!rb_gc_event_hook_required_p(event)))
return;
237 if (!ec->cfp)
return;
239 EXEC_EVENT_HOOK(ec, event, ec->cfp->self, 0, 0, 0, obj);
243rb_gc_get_objspace(
void)
245 return GET_VM()->gc.objspace;
250rb_gc_ractor_newobj_cache_foreach(
void (*func)(
void *cache,
void *data),
void *data)
253 if (RB_LIKELY(ruby_single_main_ractor)) {
255 ccan_list_empty(&GET_VM()->ractor.set) ||
256 (ccan_list_top(&GET_VM()->ractor.set,
rb_ractor_t, vmlr_node) == ruby_single_main_ractor &&
257 ccan_list_tail(&GET_VM()->ractor.set,
rb_ractor_t, vmlr_node) == ruby_single_main_ractor)
260 func(ruby_single_main_ractor->newobj_cache, data);
263 ccan_list_for_each(&GET_VM()->ractor.set, r, vmlr_node) {
264 func(r->newobj_cache, data);
270rb_gc_run_obj_finalizer(
VALUE objid,
long count,
VALUE (*callback)(
long i,
void *data),
void *data)
281#define RESTORE_FINALIZER() (\
282 ec->cfp = saved.cfp, \
283 ec->cfp->sp = saved.sp, \
284 ec->errinfo = saved.errinfo)
286 saved.errinfo = ec->errinfo;
288 saved.sp = ec->cfp->sp;
292 rb_ractor_ignore_belonging(
true);
294 enum ruby_tag_type state = EC_EXEC_TAG();
295 if (state != TAG_NONE) {
298 VALUE failed_final = saved.final;
301 rb_warn(
"Exception in finalizer %+"PRIsVALUE, failed_final);
302 rb_ec_error_print(ec, ec->errinfo);
306 for (
long i = saved.finished; RESTORE_FINALIZER(), i < count; saved.finished = ++i) {
307 saved.final = callback(i, data);
311 rb_ractor_ignore_belonging(
false);
312#undef RESTORE_FINALIZER
316rb_gc_set_pending_interrupt(
void)
319 ec->interrupt_mask |= PENDING_INTERRUPT_MASK;
323rb_gc_unset_pending_interrupt(
void)
326 ec->interrupt_mask &= ~PENDING_INTERRUPT_MASK;
330rb_gc_multi_ractor_p(
void)
332 return rb_multi_ractor_p();
335bool rb_obj_is_main_ractor(
VALUE gv);
338rb_gc_shutdown_call_finalizer_p(
VALUE obj)
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;
362 return ruby_free_at_exit_p();
367rb_gc_get_shape(
VALUE obj)
369 return (uint32_t)rb_obj_shape_id(obj);
373rb_gc_set_shape(
VALUE obj, uint32_t shape_id)
375 rb_obj_set_shape_id(obj, (uint32_t)shape_id);
379rb_gc_rebuild_shape(
VALUE obj,
size_t heap_id)
383 return (uint32_t)rb_shape_transition_heap(obj, heap_id);
386void rb_vm_update_references(
void *ptr);
388#define rb_setjmp(env) RUBY_SETJMP(env)
389#define rb_jmp_buf rb_jmpbuf_t
390#undef rb_data_object_wrap
392#if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
393#define MAP_ANONYMOUS MAP_ANON
396#define unless_objspace(objspace) \
398 rb_vm_t *unless_objspace_vm = GET_VM(); \
399 if (unless_objspace_vm) objspace = unless_objspace_vm->gc.objspace; \
402#define RMOVED(obj) ((struct RMoved *)(obj))
404#define TYPED_UPDATE_IF_MOVED(_objspace, _type, _thing) do { \
405 if (rb_gc_impl_object_moved_p((_objspace), (VALUE)(_thing))) { \
406 *(_type *)&(_thing) = (_type)gc_location_internal(_objspace, (VALUE)_thing); \
410#define UPDATE_IF_MOVED(_objspace, _thing) TYPED_UPDATE_IF_MOVED(_objspace, VALUE, _thing)
412#if RUBY_MARK_FREE_DEBUG
413int ruby_gc_debug_indent = 0;
416#ifndef RGENGC_OBJ_INFO
417# define RGENGC_OBJ_INFO RGENGC_CHECK_MODE
420#ifndef CALC_EXACT_MALLOC_SIZE
421# define CALC_EXACT_MALLOC_SIZE 0
426static size_t malloc_offset = 0;
427#if defined(HAVE_MALLOC_USABLE_SIZE)
429gc_compute_malloc_offset(
void)
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;
454gc_compute_malloc_offset(
void)
462rb_malloc_grow_capa(
size_t current,
size_t type_size)
464 size_t current_capacity = current;
465 if (current_capacity < 4) {
466 current_capacity = 4;
468 current_capacity *= type_size;
471 size_t new_capacity = (current_capacity * 2);
474 if (rb_popcount64(new_capacity) != 1) {
475 new_capacity = (size_t)(1 << (64 - nlz_int64(new_capacity)));
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);
487static inline struct rbimpl_size_mul_overflow_tag
488size_mul_add_overflow(size_t x, size_t y, size_t z)
490 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(x, y);
491 struct rbimpl_size_mul_overflow_tag u = rbimpl_size_add_overflow(t.right, z);
492 return (
struct rbimpl_size_mul_overflow_tag) { t.left || u.left, u.right };
495static inline struct rbimpl_size_mul_overflow_tag
496size_mul_add_mul_overflow(size_t x, size_t y, size_t z, size_t w)
498 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(x, y);
499 struct rbimpl_size_mul_overflow_tag u = rbimpl_size_mul_overflow(z, w);
500 struct rbimpl_size_mul_overflow_tag v = rbimpl_size_add_overflow(t.right, u.right);
501 return (
struct rbimpl_size_mul_overflow_tag) { t.left || u.left || v.left, v.right };
504PRINTF_ARGS(NORETURN(
static void gc_raise(
VALUE,
const char*, ...)), 2, 3);
507size_mul_or_raise(
size_t x,
size_t y,
VALUE exc)
509 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(x, y);
510 if (LIKELY(!t.left)) {
513 else if (rb_during_gc()) {
519 "integer overflow: %"PRIuSIZE
522 x, y, (
size_t)SIZE_MAX);
527rb_size_mul_or_raise(
size_t x,
size_t y,
VALUE exc)
529 return size_mul_or_raise(x, y, exc);
533size_mul_add_or_raise(
size_t x,
size_t y,
size_t z,
VALUE exc)
535 struct rbimpl_size_mul_overflow_tag t = size_mul_add_overflow(x, y, z);
536 if (LIKELY(!t.left)) {
539 else if (rb_during_gc()) {
545 "integer overflow: %"PRIuSIZE
549 x, y, z, (
size_t)SIZE_MAX);
554rb_size_mul_add_or_raise(
size_t x,
size_t y,
size_t z,
VALUE exc)
556 return size_mul_add_or_raise(x, y, z, exc);
560size_mul_add_mul_or_raise(
size_t x,
size_t y,
size_t z,
size_t w,
VALUE exc)
562 struct rbimpl_size_mul_overflow_tag t = size_mul_add_mul_overflow(x, y, z, w);
563 if (LIKELY(!t.left)) {
566 else if (rb_during_gc()) {
572 "integer overflow: %"PRIdSIZE
577 x, y, z, w, (
size_t)SIZE_MAX);
581#if defined(HAVE_RB_GC_GUARDED_PTR_VAL) && HAVE_RB_GC_GUARDED_PTR_VAL
583volatile VALUE rb_gc_guarded_val;
585rb_gc_guarded_ptr_val(
volatile VALUE *ptr,
VALUE val)
587 rb_gc_guarded_val = val;
593static const char *obj_type_name(
VALUE obj);
594#include "gc/default/default.c"
596#if USE_MODULAR_GC && !defined(HAVE_DLOPEN)
597# error "Modular GC requires dlopen"
601typedef struct gc_function_map {
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);
608 size_t *(*heap_sizes)(
void *objspace_ptr);
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);
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);
625 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);
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);
630 void *(*malloc)(
void *objspace_ptr,
size_t size);
631 void *(*calloc)(
void *objspace_ptr,
size_t size);
632 void *(*realloc)(
void *objspace_ptr,
void *ptr,
size_t new_size,
size_t old_size);
633 void (*free)(
void *objspace_ptr,
void *ptr,
size_t old_size);
634 void (*adjust_memory_usage)(
void *objspace_ptr, ssize_t diff);
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);
643 bool (*object_moved_p)(
void *objspace_ptr,
VALUE obj);
644 VALUE (*location)(
void *objspace_ptr,
VALUE value);
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);
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);
653 void (*make_zombie)(
void *objspace_ptr,
VALUE obj, void (*dfree)(
void *),
void *data);
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);
659 void (*before_fork)(
void *objspace_ptr);
660 void (*after_fork)(
void *objspace_ptr, rb_pid_t pid);
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);
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);
677 bool modular_gc_loaded_p;
678} rb_gc_function_map_t;
680static rb_gc_function_map_t rb_gc_functions;
682# define RUBY_GC_LIBRARY "RUBY_GC_LIBRARY"
683# define MODULAR_GC_DIR STRINGIZE(modular_gc_dir)
686ruby_modular_gc_init(
void)
691 const char *gc_so_file = getenv(RUBY_GC_LIBRARY);
693 rb_gc_function_map_t gc_functions = { 0 };
695 char *gc_so_path = NULL;
700 for (
size_t i = 0; i < strlen(gc_so_file); i++) {
701 char c = gc_so_file[i];
702 if (isalnum(c))
continue;
708 fprintf(stderr,
"Only alphanumeric, dash, and underscore is allowed in "RUBY_GC_LIBRARY
"\n");
713 size_t gc_so_path_size = strlen(MODULAR_GC_DIR
"librubygc." DLEXT) + strlen(gc_so_file) + 1;
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,
'/');
721# define end_with_p(lit) \
722 (prefix_len >= (tail = rb_strlen_lit(lit)) && \
723 memcmp(base - tail, lit, tail) == 0)
725 prefix_len = base - dli.dli_fname;
726 if (end_with_p(
"/bin") || end_with_p(
"/lib")) {
729 prefix_len += MODULAR_GC_DIR[0] !=
'/';
730 gc_so_path_size += prefix_len;
734 gc_so_path = alloca(gc_so_path_size);
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); \
741 if (prefix_len > 0) {
742 memcpy(gc_so_path, dli.dli_fname, prefix_len);
743 gc_so_path_idx = prefix_len;
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
753 handle = dlopen(gc_so_path, RTLD_LAZY | RTLD_GLOBAL);
755 fprintf(stderr,
"ruby_modular_gc_init: Shared library %s cannot be opened: %s\n", gc_so_path, dlerror());
759 gc_functions.modular_gc_loaded_p =
true;
762# define load_modular_gc_func(name) do { \
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); \
772 gc_functions.name = rb_gc_impl_##name; \
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);
784 load_modular_gc_func(shutdown_free_objects);
785 load_modular_gc_func(objspace_free);
786 load_modular_gc_func(ractor_cache_free);
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);
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);
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);
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);
817 load_modular_gc_func(object_moved_p);
818 load_modular_gc_func(location);
820 load_modular_gc_func(writebarrier);
821 load_modular_gc_func(writebarrier_unprotect);
822 load_modular_gc_func(writebarrier_remember);
824 load_modular_gc_func(each_objects);
825 load_modular_gc_func(each_object);
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);
833 load_modular_gc_func(before_fork);
834 load_modular_gc_func(after_fork);
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);
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);
851# undef load_modular_gc_func
853 rb_gc_functions = gc_functions;
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
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
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
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
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
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
897# define rb_gc_impl_object_moved_p rb_gc_functions.object_moved_p
898# define rb_gc_impl_location rb_gc_functions.location
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
904# define rb_gc_impl_each_objects rb_gc_functions.each_objects
905# define rb_gc_impl_each_object rb_gc_functions.each_object
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
913# define rb_gc_impl_before_fork rb_gc_functions.before_fork
914# define rb_gc_impl_after_fork rb_gc_functions.after_fork
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
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
932#ifdef RUBY_ASAN_ENABLED
934asan_death_callback(
void)
937 rb_bug_without_die(
"ASAN error");
945rb_objspace_alloc(
void)
948 ruby_modular_gc_init();
951 void *
objspace = rb_gc_impl_objspace_alloc();
952 ruby_current_vm_ptr->gc.objspace =
objspace;
954 rb_gc_impl_stress_set(
objspace, initial_stress);
956#ifdef RUBY_ASAN_ENABLED
957 __sanitizer_set_death_callback(asan_death_callback);
970rb_gc_obj_slot_size(
VALUE obj)
972 return rb_gc_impl_obj_slot_size(obj);
981 if (cfp && VM_FRAME_RUBYFRAME_P(cfp) && cfp->pc) {
982 RUBY_ASSERT(cfp->pc >= ISEQ_BODY(cfp->iseq)->iseq_encoded);
983 RUBY_ASSERT(cfp->pc <= ISEQ_BODY(cfp->iseq)->iseq_encoded + ISEQ_BODY(cfp->iseq)->iseq_size);
991 VALUE obj = rb_gc_impl_new_obj(rb_gc_get_objspace(), cr->newobj_cache, klass, flags, v1, v2, v3, wb_protected, size);
997 RB_VM_LOCK_ENTER_CR_LEV(cr, &lev);
999 memset((
char *)obj + RVALUE_SIZE, 0, rb_gc_obj_slot_size(obj) - RVALUE_SIZE);
1006 bool gc_disabled =
RTEST(rb_gc_disable_no_rest());
1010 if (!gc_disabled) rb_gc_enable();
1012 RB_VM_LOCK_LEAVE_CR_LEV(cr, &lev);
1019rb_wb_unprotected_newobj_of(
VALUE klass,
VALUE flags,
size_t size)
1022 return newobj_of(GET_RACTOR(), klass, flags, 0, 0, 0, FALSE, size);
1029 return newobj_of(rb_ec_ractor_ptr(ec), klass, flags, 0, 0, 0, TRUE, size);
1032#define UNEXPECTED_NODE(func) \
1033 rb_bug(#func"(): GC does not handle T_NODE 0x%x(%p) 0x%"PRIxVALUE, \
1034 BUILTIN_TYPE(obj), (void*)(obj), RBASIC(obj)->flags)
1037rb_data_object_check(
VALUE klass)
1039 if (klass != rb_cObject && (
rb_get_alloc_func(klass) == rb_class_allocate_instance)) {
1041 rb_warn(
"undefining the allocator of T_DATA class %"PRIsVALUE, klass);
1049 if (klass) rb_data_object_check(klass);
1056 VALUE obj = rb_data_object_wrap(klass, 0, dmark, dfree);
1064 RBIMPL_NONNULL_ARG(
type);
1065 if (klass) rb_data_object_check(klass);
1067 return newobj_of(GET_RACTOR(), klass,
T_DATA, 0, ((
VALUE)
type) | IS_TYPED_DATA | typed_flag, (
VALUE)datap, wb_protected, size);
1073 if (UNLIKELY(
type->flags & RUBY_TYPED_EMBEDDABLE)) {
1074 rb_raise(
rb_eTypeError,
"Cannot wrap an embeddable TypedData");
1077 return typed_data_alloc(klass, 0, datap,
type,
sizeof(
struct RTypedData));
1083 if (
type->flags & RUBY_TYPED_EMBEDDABLE) {
1084 if (!(
type->flags & RUBY_TYPED_FREE_IMMEDIATELY)) {
1085 rb_raise(
rb_eTypeError,
"Embeddable TypedData must be freed immediately");
1088 size_t embed_size = offsetof(
struct RTypedData, data) + size;
1089 if (rb_gc_size_allocatable_p(embed_size)) {
1090 VALUE obj = typed_data_alloc(klass, TYPED_DATA_EMBEDDED, 0,
type, embed_size);
1091 memset((
char *)obj + offsetof(
struct RTypedData, data), 0, size);
1102rb_objspace_data_type_memsize(
VALUE obj)
1107 const void *ptr = RTYPEDDATA_GET_DATA(obj);
1109 if (
RTYPEDDATA_TYPE(obj)->flags & RUBY_TYPED_EMBEDDABLE && !RTYPEDDATA_EMBEDDED_P(obj)) {
1110#ifdef HAVE_MALLOC_USABLE_SIZE
1111 size += malloc_usable_size((
void *)ptr);
1115 if (ptr &&
type->function.dsize) {
1116 size +=
type->function.dsize(ptr);
1124rb_objspace_data_type_name(
VALUE obj)
1134static enum rb_id_table_iterator_result
1135cvar_table_free_i(
VALUE value,
void *ctx)
1137 xfree((
void *)value);
1138 return ID_TABLE_CONTINUE;
1142io_fptr_finalize(
void *fptr)
1151 rb_gc_impl_make_zombie(
objspace, obj, io_fptr_finalize, fptr);
1159 int free_immediately =
false;
1160 void (*dfree)(
void *);
1167 dfree =
RDATA(obj)->dfree;
1172 if (!
RTYPEDDATA_P(obj) || !RTYPEDDATA_EMBEDDED_P(obj)) {
1174 RB_DEBUG_COUNTER_INC(obj_data_xfree);
1177 else if (free_immediately) {
1183 RB_DEBUG_COUNTER_INC(obj_data_imm_free);
1186 rb_gc_impl_make_zombie(
objspace, obj, dfree, data);
1187 RB_DEBUG_COUNTER_INC(obj_data_zombie);
1192 RB_DEBUG_COUNTER_INC(obj_data_empty);
1210 rb_id_table_free(RCLASSEXT_M_TBL(ext));
1212 if (!RCLASSEXT_SHARED_CONST_TBL(ext) && (tbl = RCLASSEXT_CONST_TBL(ext)) != NULL) {
1213 rb_free_const_table(tbl);
1215 if ((tbl = RCLASSEXT_CVC_TBL(ext)) != NULL) {
1216 rb_id_table_foreach_values(tbl, cvar_table_free_i, NULL);
1217 rb_id_table_free(tbl);
1219 rb_class_classext_free_subclasses(ext, args->klass);
1220 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
1222 xfree(RCLASSEXT_SUPERCLASSES(ext));
1234 if (RCLASSEXT_ICLASS_IS_ORIGIN(ext) && !RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext)) {
1236 rb_id_table_free(RCLASSEXT_M_TBL(ext));
1238 if (RCLASSEXT_CALLABLE_M_TBL(ext) != NULL) {
1239 rb_id_table_free(RCLASSEXT_CALLABLE_M_TBL(ext));
1242 rb_class_classext_free_subclasses(ext, args->klass);
1254 RB_DEBUG_COUNTER_INC(obj_free);
1261 rb_bug(
"obj_free() called for broken object");
1269 if (rb_shape_obj_too_complex_p(obj)) {
1270 RB_DEBUG_COUNTER_INC(obj_obj_too_complex);
1271 st_free_table(ROBJECT_FIELDS_HASH(obj));
1273 else if (
RBASIC(obj)->flags & ROBJECT_EMBED) {
1274 RB_DEBUG_COUNTER_INC(obj_obj_embed);
1278 RB_DEBUG_COUNTER_INC(obj_obj_ptr);
1284 rb_class_classext_foreach(obj, classext_free, (
void *)&args);
1285 if (RCLASS_CLASSEXT_TBL(obj)) {
1286 st_free_table(RCLASS_CLASSEXT_TBL(obj));
1298#if USE_DEBUG_COUNTER
1301 RB_DEBUG_COUNTER_INC(obj_hash_empty);
1304 RB_DEBUG_COUNTER_INC(obj_hash_1);
1307 RB_DEBUG_COUNTER_INC(obj_hash_2);
1310 RB_DEBUG_COUNTER_INC(obj_hash_3);
1313 RB_DEBUG_COUNTER_INC(obj_hash_4);
1319 RB_DEBUG_COUNTER_INC(obj_hash_5_8);
1323 RB_DEBUG_COUNTER_INC(obj_hash_g8);
1326 if (RHASH_AR_TABLE_P(obj)) {
1327 if (RHASH_AR_TABLE(obj) == NULL) {
1328 RB_DEBUG_COUNTER_INC(obj_hash_null);
1331 RB_DEBUG_COUNTER_INC(obj_hash_ar);
1335 RB_DEBUG_COUNTER_INC(obj_hash_st);
1344 RB_DEBUG_COUNTER_INC(obj_regexp_ptr);
1348 if (!rb_data_free(
objspace, obj))
return false;
1353#if USE_DEBUG_COUNTER
1354 if (rm->
regs.num_regs >= 8) {
1355 RB_DEBUG_COUNTER_INC(obj_match_ge8);
1357 else if (rm->
regs.num_regs >= 4) {
1358 RB_DEBUG_COUNTER_INC(obj_match_ge4);
1360 else if (rm->
regs.num_regs >= 1) {
1361 RB_DEBUG_COUNTER_INC(obj_match_under4);
1364 onig_region_free(&rm->
regs, 0);
1367 RB_DEBUG_COUNTER_INC(obj_match_ptr);
1371 if (
RFILE(obj)->fptr) {
1373 RB_DEBUG_COUNTER_INC(obj_file_ptr);
1378 RB_DEBUG_COUNTER_INC(obj_rational);
1381 RB_DEBUG_COUNTER_INC(obj_complex);
1388 rb_class_classext_foreach(obj, classext_iclass_free, (
void *)&args);
1389 if (RCLASS_CLASSEXT_TBL(obj)) {
1390 st_free_table(RCLASS_CLASSEXT_TBL(obj));
1393 RB_DEBUG_COUNTER_INC(obj_iclass_ptr);
1397 RB_DEBUG_COUNTER_INC(obj_float);
1401 if (!BIGNUM_EMBED_P(obj) && BIGNUM_DIGITS(obj)) {
1402 xfree(BIGNUM_DIGITS(obj));
1403 RB_DEBUG_COUNTER_INC(obj_bignum_ptr);
1406 RB_DEBUG_COUNTER_INC(obj_bignum_embed);
1411 UNEXPECTED_NODE(obj_free);
1415 if ((
RBASIC(obj)->flags & RSTRUCT_EMBED_LEN_MASK) ||
1416 RSTRUCT(obj)->as.heap.ptr == NULL) {
1417 RB_DEBUG_COUNTER_INC(obj_struct_embed);
1420 xfree((
void *)RSTRUCT(obj)->as.heap.ptr);
1421 RB_DEBUG_COUNTER_INC(obj_struct_ptr);
1426 RB_DEBUG_COUNTER_INC(obj_symbol);
1430 rb_imemo_free((
VALUE)obj);
1434 rb_bug(
"gc_sweep(): unknown data type 0x%x(%p) 0x%"PRIxVALUE,
1439 rb_gc_impl_make_zombie(
objspace, obj, 0, 0);
1450 rb_gc_impl_set_event_hook(rb_gc_get_objspace(), event);
1454internal_object_p(
VALUE obj)
1456 void *ptr = asan_unpoison_object_temporary(obj);
1458 if (
RBASIC(obj)->flags) {
1461 UNEXPECTED_NODE(internal_object_p);
1470 if (obj == rb_mRubyVMFrozenCore)
1474 if (RCLASS_SINGLETON_P(obj)) {
1475 return rb_singleton_class_internal_p(obj);
1479 if (!
RBASIC(obj)->klass)
break;
1483 if (ptr || !
RBASIC(obj)->flags) {
1484 rb_asan_poison_object(obj);
1490rb_objspace_internal_object_p(
VALUE obj)
1492 return internal_object_p(obj);
1501os_obj_of_i(
void *vstart,
void *vend,
size_t stride,
void *data)
1506 for (; v != (
VALUE)vend; v += stride) {
1507 if (!internal_object_p(v)) {
1527 rb_objspace_each_objects(os_obj_of_i, &oes);
1586 return os_obj_of(of);
1600 return rb_undefine_finalizer(obj);
1606 rb_check_frozen(obj);
1608 rb_gc_impl_undefine_finalizer(rb_gc_get_objspace(), obj);
1614should_be_callable(
VALUE block)
1617 rb_raise(rb_eArgError,
"wrong type argument %"PRIsVALUE
" (should be callable)",
1623should_be_finalizable(
VALUE obj)
1626 rb_raise(rb_eArgError,
"cannot define finalizer for %s",
1629 rb_check_frozen(obj);
1635 rb_gc_impl_copy_finalizer(rb_gc_get_objspace(), dest, obj);
1710 if (rb_callable_receiver(block) == obj) {
1711 rb_warn(
"finalizer references object to be finalized");
1714 return rb_define_finalizer(obj, block);
1720 should_be_finalizable(obj);
1721 should_be_callable(block);
1723 block = rb_gc_impl_define_finalizer(rb_gc_get_objspace(), obj, block);
1731rb_objspace_call_finalizer(
void)
1733 rb_gc_impl_shutdown_call_finalizer(rb_gc_get_objspace());
1737rb_objspace_free_objects(
void *
objspace)
1739 rb_gc_impl_shutdown_free_objects(
objspace);
1743rb_objspace_garbage_object_p(
VALUE obj)
1745 return !
SPECIAL_CONST_P(obj) && rb_gc_impl_garbage_object_p(rb_gc_get_objspace(), obj);
1749rb_gc_pointer_to_heap_p(
VALUE obj)
1751 return rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (
void *)obj);
1754#define OBJ_ID_INCREMENT (RUBY_IMMEDIATE_MASK + 1)
1755#define LAST_OBJECT_ID() (object_id_counter * OBJ_ID_INCREMENT)
1756static VALUE id2ref_value = 0;
1759#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
1760static size_t object_id_counter = 1;
1762static unsigned long long object_id_counter = 1;
1766generate_next_object_id(
void)
1768#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
1772 unsigned int lock_lev = RB_GC_VM_LOCK();
1773 VALUE id =
ULL2NUM(++object_id_counter * OBJ_ID_INCREMENT);
1774 RB_GC_VM_UNLOCK(lock_lev);
1780rb_gc_obj_id_moved(
VALUE obj)
1782 if (UNLIKELY(id2ref_tbl)) {
1783 st_insert(id2ref_tbl, (st_data_t)rb_obj_id(obj), (st_data_t)obj);
1788object_id_cmp(st_data_t x, st_data_t y)
1791 return !rb_big_eql(x, y);
1799object_id_hash(st_data_t n)
1804static const struct st_hash_type object_id_hash_type = {
1809static void gc_mark_tbl_no_pin(
st_table *table);
1812id2ref_tbl_mark(
void *data)
1824id2ref_tbl_memsize(
const void *data)
1826 return rb_st_memsize(data);
1830id2ref_tbl_free(
void *data)
1834 st_free_table(table);
1840 .dmark = id2ref_tbl_mark,
1841 .dfree = id2ref_tbl_free,
1842 .dsize = id2ref_tbl_memsize,
1846 .flags = RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_FREE_IMMEDIATELY
1850class_object_id(
VALUE klass)
1852 VALUE id = RUBY_ATOMIC_VALUE_LOAD(
RCLASS(klass)->object_id);
1854 unsigned int lock_lev = RB_GC_VM_LOCK();
1855 id = generate_next_object_id();
1860 else if (RB_UNLIKELY(id2ref_tbl)) {
1861 st_insert(id2ref_tbl,
id, klass);
1863 RB_GC_VM_UNLOCK(lock_lev);
1869object_id_get(
VALUE obj, shape_id_t shape_id)
1872 if (rb_shape_too_complex_p(shape_id)) {
1873 id = rb_obj_field_get(obj, ROOT_TOO_COMPLEX_WITH_OBJ_ID);
1876 id = rb_obj_field_get(obj, rb_shape_object_id(shape_id));
1882 rb_bug(
"Object's shape includes object_id, but it's missing %s", rb_obj_info(obj));
1890object_id0(
VALUE obj)
1893 shape_id_t shape_id = RBASIC_SHAPE_ID(obj);
1895 if (rb_shape_has_object_id(shape_id)) {
1896 return object_id_get(obj, shape_id);
1899 shape_id_t object_id_shape_id = rb_shape_transition_object_id(obj);
1901 id = generate_next_object_id();
1902 rb_obj_field_set(obj, object_id_shape_id, 0,
id);
1904 RUBY_ASSERT(RBASIC_SHAPE_ID(obj) == object_id_shape_id);
1907 if (RB_UNLIKELY(id2ref_tbl)) {
1908 st_insert(id2ref_tbl, (st_data_t)
id, (st_data_t)obj);
1922 return class_object_id(obj);
1931 unsigned int lock_lev = RB_GC_VM_LOCK();
1932 VALUE id = object_id0(obj);
1933 RB_GC_VM_UNLOCK(lock_lev);
1937 return object_id0(obj);
1941build_id2ref_i(
VALUE obj,
void *data)
1949 if (
RCLASS(obj)->object_id) {
1950 st_insert(id2ref_tbl,
RCLASS(obj)->object_id, obj);
1955 if (IMEMO_TYPE_P(obj, imemo_fields) && rb_shape_obj_has_id(obj)) {
1956 st_insert(id2ref_tbl, rb_obj_id(obj), rb_imemo_fields_owner(obj));
1961 if (rb_shape_obj_has_id(obj)) {
1962 st_insert(id2ref_tbl, rb_obj_id(obj), obj);
1972object_id_to_ref(
void *objspace_ptr,
VALUE object_id)
1976 unsigned int lev = RB_GC_VM_LOCK();
1984 st_table *tmp_id2ref_tbl = st_init_table(&object_id_hash_type);
1990 bool gc_disabled =
RTEST(rb_gc_disable());
1992 id2ref_tbl = tmp_id2ref_tbl;
1993 id2ref_value = tmp_id2ref_value;
1995 rb_gc_impl_each_object(
objspace, build_id2ref_i, (
void *)id2ref_tbl);
1997 if (!gc_disabled) rb_gc_enable();
2001 bool found = st_lookup(id2ref_tbl, object_id, &obj) && !rb_gc_impl_garbage_object_p(
objspace, obj);
2003 RB_GC_VM_UNLOCK(lev);
2018obj_free_object_id(
VALUE obj)
2021 if (RB_UNLIKELY(id2ref_tbl)) {
2025 obj_id =
RCLASS(obj)->object_id;
2028 if (!IMEMO_TYPE_P(obj, imemo_fields)) {
2034 shape_id_t shape_id = RBASIC_SHAPE_ID(obj);
2035 if (rb_shape_has_object_id(shape_id)) {
2036 obj_id = object_id_get(obj, shape_id);
2045 if (RB_UNLIKELY(obj_id)) {
2048 if (!st_delete(id2ref_tbl, (st_data_t *)&obj_id, NULL)) {
2052 rb_bug(
"Object ID seen, but not in _id2ref table: object_id=%llu object=%s",
NUM2ULL(obj_id), rb_obj_info(obj));
2060rb_gc_obj_free_vm_weak_references(
VALUE obj)
2062 obj_free_object_id(obj);
2064 if (rb_obj_exivar_p(obj)) {
2071 rb_gc_free_fstring(obj);
2075 rb_gc_free_dsymbol(obj);
2078 switch (imemo_type(obj)) {
2079 case imemo_callcache: {
2082 if (vm_cc_refinement_p(cc)) {
2083 rb_vm_delete_cc_refinement(cc);
2088 case imemo_callinfo:
2123#if SIZEOF_LONG == SIZEOF_VOIDP
2124#define NUM2PTR(x) NUM2ULONG(x)
2125#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
2126#define NUM2PTR(x) NUM2ULL(x)
2129 if (
FIXNUM_P(objid) || rb_big_size(objid) <= SIZEOF_VOIDP) {
2130 VALUE ptr = NUM2PTR(objid);
2140 if (rb_static_id_valid_p(
SYM2ID(ptr))) {
2144 rb_raise(
rb_eRangeError,
"%p is not a symbol id value", (
void *)ptr);
2148 rb_raise(
rb_eRangeError,
"%+"PRIsVALUE
" is not an id value", rb_int2str(objid, 10));
2152 VALUE obj = object_id_to_ref(rb_gc_get_objspace(), objid);
2157 rb_raise(
rb_eRangeError,
"%+"PRIsVALUE
" is the id of an unshareable object on multi-ractor", rb_int2str(objid, 10));
2166 return id2ref(objid);
2173#if SIZEOF_LONG == SIZEOF_VOIDP
2180 return get_heap_object_id(obj);
2184nonspecial_obj_id(
VALUE obj)
2186#if SIZEOF_LONG == SIZEOF_VOIDP
2188#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
2191# error not supported
2198 return rb_find_object_id(NULL, obj, nonspecial_obj_id);
2235 return rb_find_object_id(rb_gc_get_objspace(), obj, object_id);
2239rb_obj_id_p(
VALUE obj)
2251rb_gc_before_updating_jit_code(
void)
2254 rb_yjit_mark_all_writeable();
2264rb_gc_after_updating_jit_code(
void)
2267 rb_yjit_mark_all_executable();
2274 size_t *size = (
size_t *)arg;
2277 if (RCLASSEXT_M_TBL(ext)) {
2278 s += rb_id_table_memsize(RCLASSEXT_M_TBL(ext));
2280 if (RCLASSEXT_CVC_TBL(ext)) {
2281 s += rb_id_table_memsize(RCLASSEXT_CVC_TBL(ext));
2283 if (RCLASSEXT_CONST_TBL(ext)) {
2284 s += rb_id_table_memsize(RCLASSEXT_CONST_TBL(ext));
2286 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
2287 s += (RCLASSEXT_SUPERCLASS_DEPTH(ext) + 1) *
sizeof(
VALUE);
2296classext_superclasses_memsize(
rb_classext_t *ext,
bool prime,
VALUE namespace,
void *arg)
2298 size_t *size = (
size_t *)arg;
2300 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
2302 array_size = RCLASSEXT_SUPERCLASS_DEPTH(ext) + 1;
2303 *size += array_size *
sizeof(
VALUE);
2308rb_obj_memsize_of(
VALUE obj)
2318 if (rb_shape_obj_too_complex_p(obj)) {
2319 size += rb_st_memsize(ROBJECT_FIELDS_HASH(obj));
2321 else if (!(
RBASIC(obj)->flags & ROBJECT_EMBED)) {
2322 size += ROBJECT_FIELDS_CAPACITY(obj) *
sizeof(
VALUE);
2327 rb_class_classext_foreach(obj, classext_memsize, (
void *)&size);
2328 rb_class_classext_foreach(obj, classext_superclasses_memsize, (
void *)&size);
2331 if (RICLASS_OWNS_M_TBL_P(obj)) {
2332 if (RCLASS_M_TBL(obj)) {
2333 size += rb_id_table_memsize(RCLASS_M_TBL(obj));
2338 size += rb_str_memsize(obj);
2341 size += rb_ary_memsize(obj);
2344 if (RHASH_ST_TABLE_P(obj)) {
2345 VM_ASSERT(RHASH_ST_TABLE(obj) != NULL);
2347 size += st_memsize(RHASH_ST_TABLE(obj)) -
sizeof(
st_table);
2356 size += rb_objspace_data_type_memsize(obj);
2361 size += onig_region_memsize(&rm->
regs);
2366 if (
RFILE(obj)->fptr) {
2367 size += rb_io_memsize(
RFILE(obj)->fptr);
2374 size += rb_imemo_memsize(obj);
2382 if (!(
RBASIC(obj)->flags & BIGNUM_EMBED_FLAG) && BIGNUM_DIGITS(obj)) {
2383 size += BIGNUM_LEN(obj) *
sizeof(BDIGIT);
2388 UNEXPECTED_NODE(obj_memsize_of);
2392 if ((
RBASIC(obj)->flags & RSTRUCT_EMBED_LEN_MASK) == 0 &&
2393 RSTRUCT(obj)->as.heap.ptr) {
2394 size +=
sizeof(
VALUE) * RSTRUCT_LEN(obj);
2403 rb_bug(
"objspace/memsize_of(): unknown data type 0x%x(%p)",
2407 return size + rb_gc_obj_slot_size(obj);
2411set_zero(st_data_t key, st_data_t val, st_data_t arg)
2415 rb_hash_aset(hash, k,
INT2FIX(0));
2426count_objects_i(
VALUE obj,
void *d)
2430 if (
RBASIC(obj)->flags) {
2476count_objects(
int argc,
VALUE *argv,
VALUE os)
2488 for (
size_t i = 0; i <=
T_MASK; i++) {
2492 types[i] = type_sym(i);
2495 rb_gc_impl_each_object(rb_gc_get_objspace(), count_objects_i, &data);
2498 hash = rb_hash_new();
2501 rb_hash_stlike_foreach(hash, set_zero, hash);
2503 rb_hash_aset(hash,
ID2SYM(rb_intern(
"TOTAL")),
SIZET2NUM(data.total));
2506 for (
size_t i = 0; i <=
T_MASK; i++) {
2507 if (data.counts[i]) {
2508 rb_hash_aset(hash, types[i],
SIZET2NUM(data.counts[i]));
2515#define SET_STACK_END SET_MACHINE_STACK_END(&ec->machine.stack_end)
2517#define STACK_START (ec->machine.stack_start)
2518#define STACK_END (ec->machine.stack_end)
2519#define STACK_LEVEL_MAX (ec->machine.stack_maxsize/sizeof(VALUE))
2521#if STACK_GROW_DIRECTION < 0
2522# define STACK_LENGTH (size_t)(STACK_START - STACK_END)
2523#elif STACK_GROW_DIRECTION > 0
2524# define STACK_LENGTH (size_t)(STACK_END - STACK_START + 1)
2526# define STACK_LENGTH ((STACK_END < STACK_START) ? (size_t)(STACK_START - STACK_END) \
2527 : (size_t)(STACK_END - STACK_START + 1))
2529#if !STACK_GROW_DIRECTION
2530int ruby_stack_grow_direction;
2532ruby_get_stack_grow_direction(
volatile VALUE *addr)
2535 SET_MACHINE_STACK_END(&end);
2537 if (end > addr)
return ruby_stack_grow_direction = 1;
2538 return ruby_stack_grow_direction = -1;
2547 if (p) *p = STACK_UPPER(STACK_END, STACK_START, STACK_END);
2548 return STACK_LENGTH;
2551#define PREVENT_STACK_OVERFLOW 1
2552#ifndef PREVENT_STACK_OVERFLOW
2553#if !(defined(POSIX_SIGNAL) && defined(SIGSEGV) && defined(HAVE_SIGALTSTACK))
2554# define PREVENT_STACK_OVERFLOW 1
2556# define PREVENT_STACK_OVERFLOW 0
2559#if PREVENT_STACK_OVERFLOW && !defined(__EMSCRIPTEN__)
2565 size_t length = STACK_LENGTH;
2566 size_t maximum_length = STACK_LEVEL_MAX - water_mark;
2568 return length > maximum_length;
2571#define stack_check(ec, water_mark) FALSE
2574#define STACKFRAME_FOR_CALL_CFUNC 2048
2579 return stack_check(ec, STACKFRAME_FOR_CALL_CFUNC);
2585 return stack_check(GET_EC(), STACKFRAME_FOR_CALL_CFUNC);
2590#define RB_GC_MARK_OR_TRAVERSE(func, obj_or_ptr, obj, check_obj) do { \
2591 if (!RB_SPECIAL_CONST_P(obj)) { \
2592 rb_vm_t *vm = GET_VM(); \
2593 void *objspace = vm->gc.objspace; \
2594 if (LIKELY(vm->gc.mark_func_data == NULL)) { \
2595 GC_ASSERT(rb_gc_impl_during_gc_p(objspace)); \
2596 (func)(objspace, (obj_or_ptr)); \
2598 else if (check_obj ? \
2599 rb_gc_impl_pointer_to_heap_p(objspace, (const void *)obj) && \
2600 !rb_gc_impl_garbage_object_p(objspace, obj) : \
2602 GC_ASSERT(!rb_gc_impl_during_gc_p(objspace)); \
2603 struct gc_mark_func_data_struct *mark_func_data = vm->gc.mark_func_data; \
2604 vm->gc.mark_func_data = NULL; \
2605 mark_func_data->mark_func((obj), mark_func_data->data); \
2606 vm->gc.mark_func_data = mark_func_data; \
2612gc_mark_internal(
VALUE obj)
2614 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark, obj, obj,
false);
2620 gc_mark_internal(obj);
2624rb_gc_mark_and_move(
VALUE *ptr)
2626 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_and_move, ptr, *ptr,
false);
2630gc_mark_and_pin_internal(
VALUE obj)
2632 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_and_pin, obj, obj,
false);
2638 gc_mark_and_pin_internal(obj);
2642gc_mark_maybe_internal(
VALUE obj)
2644 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_maybe, obj, obj,
true);
2650 gc_mark_maybe_internal(obj);
2654rb_gc_mark_weak(
VALUE *ptr)
2660 if (LIKELY(vm->gc.mark_func_data == NULL)) {
2661 GC_ASSERT(rb_gc_impl_during_gc_p(
objspace));
2663 rb_gc_impl_mark_weak(
objspace, ptr);
2666 GC_ASSERT(!rb_gc_impl_during_gc_p(
objspace));
2671rb_gc_remove_weak(
VALUE parent_obj,
VALUE *ptr)
2673 rb_gc_impl_remove_weak(rb_gc_get_objspace(), parent_obj, ptr);
2676ATTRIBUTE_NO_ADDRESS_SAFETY_ANALYSIS(
static void each_location(
register const VALUE *x,
register long n,
void (*cb)(
VALUE,
void *),
void *data));
2678each_location(
register const VALUE *x,
register long n,
void (*cb)(
VALUE,
void *),
void *data)
2689each_location_ptr(
const VALUE *start,
const VALUE *end,
void (*cb)(
VALUE,
void *),
void *data)
2691 if (end <= start)
return;
2692 each_location(start, end - start, cb, data);
2696gc_mark_maybe_each_location(
VALUE obj,
void *data)
2698 gc_mark_maybe_internal(obj);
2704 each_location_ptr(start, end, gc_mark_maybe_each_location, NULL);
2708rb_gc_mark_values(
long n,
const VALUE *values)
2710 for (
long i = 0; i < n; i++) {
2711 gc_mark_internal(values[i]);
2716rb_gc_mark_vm_stack_values(
long n,
const VALUE *values)
2718 for (
long i = 0; i < n; i++) {
2719 gc_mark_and_pin_internal(values[i]);
2724mark_key(st_data_t key, st_data_t value, st_data_t data)
2726 gc_mark_and_pin_internal((
VALUE)key);
2736 st_foreach(tbl, mark_key, (st_data_t)rb_gc_get_objspace());
2740mark_keyvalue(st_data_t key, st_data_t value, st_data_t data)
2742 gc_mark_internal((
VALUE)key);
2743 gc_mark_internal((
VALUE)value);
2749pin_key_pin_value(st_data_t key, st_data_t value, st_data_t data)
2751 gc_mark_and_pin_internal((
VALUE)key);
2752 gc_mark_and_pin_internal((
VALUE)value);
2758pin_key_mark_value(st_data_t key, st_data_t value, st_data_t data)
2760 gc_mark_and_pin_internal((
VALUE)key);
2761 gc_mark_internal((
VALUE)value);
2767mark_hash(
VALUE hash)
2769 if (rb_hash_compare_by_id_p(hash)) {
2770 rb_hash_stlike_foreach(hash, pin_key_mark_value, 0);
2773 rb_hash_stlike_foreach(hash, mark_keyvalue, 0);
2776 gc_mark_internal(RHASH(hash)->ifnone);
2784 st_foreach(tbl, pin_key_pin_value, 0);
2787static enum rb_id_table_iterator_result
2790 gc_mark_internal(me);
2792 return ID_TABLE_CONTINUE;
2799 rb_id_table_foreach_values(tbl, mark_method_entry_i,
objspace);
2803static enum rb_id_table_iterator_result
2808 gc_mark_internal(ce->value);
2809 gc_mark_internal(ce->file);
2810 return ID_TABLE_CONTINUE;
2817 rb_id_table_foreach_values(tbl, mark_const_entry_i,
objspace);
2820static enum rb_id_table_iterator_result
2828 gc_mark_internal((
VALUE)entry->cref);
2830 return ID_TABLE_CONTINUE;
2837 rb_id_table_foreach_values(tbl, mark_cvc_tbl_i,
objspace);
2840#if STACK_GROW_DIRECTION < 0
2841#define GET_STACK_BOUNDS(start, end, appendix) ((start) = STACK_END, (end) = STACK_START)
2842#elif STACK_GROW_DIRECTION > 0
2843#define GET_STACK_BOUNDS(start, end, appendix) ((start) = STACK_START, (end) = STACK_END+(appendix))
2845#define GET_STACK_BOUNDS(start, end, appendix) \
2846 ((STACK_END < STACK_START) ? \
2847 ((start) = STACK_END, (end) = STACK_START) : ((start) = STACK_START, (end) = STACK_END+(appendix)))
2851gc_mark_machine_stack_location_maybe(
VALUE obj,
void *data)
2853 gc_mark_maybe_internal(obj);
2855#ifdef RUBY_ASAN_ENABLED
2857 void *fake_frame_start;
2858 void *fake_frame_end;
2859 bool is_fake_frame = asan_get_fake_stack_extents(
2860 ec->machine.asan_fake_stack_handle, obj,
2861 ec->machine.stack_start, ec->machine.stack_end,
2862 &fake_frame_start, &fake_frame_end
2864 if (is_fake_frame) {
2865 each_location_ptr(fake_frame_start, fake_frame_end, gc_mark_maybe_each_location, NULL);
2877 GC_ASSERT(rb_gc_impl_pointer_to_heap_p(
objspace, (
void *)value));
2879 return rb_gc_impl_location(
objspace, value);
2885 return gc_location_internal(rb_gc_get_objspace(), value);
2888#if defined(__wasm__)
2891static VALUE *rb_stack_range_tmp[2];
2894rb_mark_locations(
void *begin,
void *end)
2896 rb_stack_range_tmp[0] = begin;
2897 rb_stack_range_tmp[1] = end;
2901rb_gc_save_machine_context(
void)
2906# if defined(__EMSCRIPTEN__)
2911 emscripten_scan_stack(rb_mark_locations);
2912 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2914 emscripten_scan_registers(rb_mark_locations);
2915 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2922 VALUE *stack_start, *stack_end;
2924 GET_STACK_BOUNDS(stack_start, stack_end, 1);
2925 each_location_ptr(stack_start, stack_end, gc_mark_maybe_each_location, NULL);
2927 rb_wasm_scan_locals(rb_mark_locations);
2928 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2936rb_gc_save_machine_context(
void)
2940 RB_VM_SAVE_MACHINE_CONTEXT(thread);
2947 rb_gc_mark_machine_context(ec);
2954 VALUE *stack_start, *stack_end;
2956 GET_STACK_BOUNDS(stack_start, stack_end, 0);
2957 RUBY_DEBUG_LOG(
"ec->th:%u stack_start:%p stack_end:%p", rb_ec_thread_ptr(ec)->serial, stack_start, stack_end);
2960#ifdef RUBY_ASAN_ENABLED
2967 each_location_ptr(stack_start, stack_end, gc_mark_machine_stack_location_maybe, data);
2968 int num_regs =
sizeof(ec->machine.regs)/(
sizeof(
VALUE));
2969 each_location((
VALUE*)&ec->machine.regs, num_regs, gc_mark_machine_stack_location_maybe, data);
2973rb_mark_tbl_i(st_data_t key, st_data_t value, st_data_t data)
2975 gc_mark_and_pin_internal((
VALUE)value);
2983 if (!tbl || tbl->num_entries == 0)
return;
2985 st_foreach(tbl, rb_mark_tbl_i, 0);
2991 if (!tbl || tbl->num_entries == 0)
return;
2993 st_foreach(tbl, gc_mark_tbl_no_pin_i, 0);
2999 gc_mark_tbl_no_pin(tbl);
3005 return (
type->flags & RUBY_TYPED_DECL_MARKING) != 0;
3009rb_gc_mark_roots(
void *
objspace,
const char **categoryp)
3012 rb_vm_t *vm = rb_ec_vm_ptr(ec);
3014#define MARK_CHECKPOINT(category) do { \
3015 if (categoryp) *categoryp = category; \
3018 MARK_CHECKPOINT(
"vm");
3021 MARK_CHECKPOINT(
"end_proc");
3024 MARK_CHECKPOINT(
"global_tbl");
3025 rb_gc_mark_global_tbl();
3028 void rb_yjit_root_mark(
void);
3030 if (rb_yjit_enabled_p) {
3031 MARK_CHECKPOINT(
"YJIT");
3032 rb_yjit_root_mark();
3036 MARK_CHECKPOINT(
"machine_context");
3037 mark_current_machine_context(ec);
3039 MARK_CHECKPOINT(
"global_symbols");
3040 rb_sym_global_symbols_mark_and_move();
3042 MARK_CHECKPOINT(
"finish");
3044#undef MARK_CHECKPOINT
3058 if (RCLASSEXT_SUPER(ext)) {
3059 gc_mark_internal(RCLASSEXT_SUPER(ext));
3061 mark_m_tbl(
objspace, RCLASSEXT_M_TBL(ext));
3062 gc_mark_internal(RCLASSEXT_FIELDS_OBJ(ext));
3063 if (!RCLASSEXT_SHARED_CONST_TBL(ext) && RCLASSEXT_CONST_TBL(ext)) {
3064 mark_const_tbl(
objspace, RCLASSEXT_CONST_TBL(ext));
3066 mark_m_tbl(
objspace, RCLASSEXT_CALLABLE_M_TBL(ext));
3067 gc_mark_internal(RCLASSEXT_CC_TBL(ext));
3068 mark_cvc_tbl(
objspace, RCLASSEXT_CVC_TBL(ext));
3069 gc_mark_internal(RCLASSEXT_CLASSPATH(ext));
3078 if (RCLASSEXT_SUPER(ext)) {
3079 gc_mark_internal(RCLASSEXT_SUPER(ext));
3081 if (RCLASSEXT_ICLASS_IS_ORIGIN(ext) && !RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext)) {
3082 mark_m_tbl(
objspace, RCLASSEXT_M_TBL(ext));
3084 if (RCLASSEXT_INCLUDER(ext)) {
3085 gc_mark_internal(RCLASSEXT_INCLUDER(ext));
3087 mark_m_tbl(
objspace, RCLASSEXT_CALLABLE_M_TBL(ext));
3088 gc_mark_internal(RCLASSEXT_CC_TBL(ext));
3091#define TYPED_DATA_REFS_OFFSET_LIST(d) (size_t *)(uintptr_t)RTYPEDDATA_TYPE(d)->function.dmark
3098 if (rb_obj_exivar_p(obj)) {
3099 rb_mark_generic_ivar(obj);
3109 rb_bug(
"rb_gc_mark() called for broken object");
3113 UNEXPECTED_NODE(rb_gc_mark);
3117 rb_imemo_mark_and_move(obj,
false);
3124 gc_mark_internal(
RBASIC(obj)->klass);
3129 gc_mark_internal(RCLASS_ATTACHED_OBJECT(obj));
3134 foreach_args.obj = obj;
3135 rb_class_classext_foreach(obj, gc_mark_classext_module, (
void *)&foreach_args);
3140 foreach_args.obj = obj;
3141 rb_class_classext_foreach(obj, gc_mark_classext_iclass, (
void *)&foreach_args);
3145 if (ARY_SHARED_P(obj)) {
3146 VALUE root = ARY_SHARED_ROOT(obj);
3147 gc_mark_internal(root);
3152 for (
long i = 0; i <
len; i++) {
3153 gc_mark_internal(ptr[i]);
3163 gc_mark_internal(RSYMBOL(obj)->fstr);
3167 if (STR_SHARED_P(obj)) {
3168 if (STR_EMBED_P(
RSTRING(obj)->as.heap.aux.shared)) {
3173 gc_mark_and_pin_internal(
RSTRING(obj)->as.heap.aux.shared);
3176 gc_mark_internal(
RSTRING(obj)->as.heap.aux.shared);
3183 void *
const ptr = typed_data ? RTYPEDDATA_GET_DATA(obj) :
DATA_PTR(obj);
3186 gc_mark_internal(
RTYPEDDATA(obj)->fields_obj);
3191 size_t *offset_list = TYPED_DATA_REFS_OFFSET_LIST(obj);
3193 for (
size_t offset = *offset_list; offset != RUBY_REF_END; offset = *offset_list++) {
3194 gc_mark_internal(*(
VALUE *)((
char *)ptr + offset));
3201 if (mark_func) (*mark_func)(ptr);
3209 if (rb_shape_obj_too_complex_p(obj)) {
3210 gc_mark_tbl_no_pin(ROBJECT_FIELDS_HASH(obj));
3215 uint32_t
len = ROBJECT_FIELDS_COUNT(obj);
3216 for (uint32_t i = 0; i <
len; i++) {
3217 gc_mark_internal(ptr[i]);
3221 attr_index_t fields_count = ROBJECT_FIELDS_COUNT(obj);
3226 if (RCLASS_MAX_IV_COUNT(klass) < fields_count) {
3227 RCLASS_SET_MAX_IV_COUNT(klass, fields_count);
3235 if (
RFILE(obj)->fptr) {
3236 gc_mark_internal(
RFILE(obj)->fptr->self);
3237 gc_mark_internal(
RFILE(obj)->fptr->pathv);
3238 gc_mark_internal(
RFILE(obj)->fptr->tied_io_for_writing);
3239 gc_mark_internal(
RFILE(obj)->fptr->writeconv_asciicompat);
3240 gc_mark_internal(
RFILE(obj)->fptr->writeconv_pre_ecopts);
3241 gc_mark_internal(
RFILE(obj)->fptr->encs.ecopts);
3242 gc_mark_internal(
RFILE(obj)->fptr->write_lock);
3243 gc_mark_internal(
RFILE(obj)->fptr->timeout);
3244 gc_mark_internal(
RFILE(obj)->fptr->wakeup_mutex);
3249 gc_mark_internal(
RREGEXP(obj)->src);
3253 gc_mark_internal(
RMATCH(obj)->regexp);
3255 gc_mark_internal(
RMATCH(obj)->str);
3260 gc_mark_internal(RRATIONAL(obj)->num);
3261 gc_mark_internal(RRATIONAL(obj)->den);
3265 gc_mark_internal(RCOMPLEX(obj)->real);
3266 gc_mark_internal(RCOMPLEX(obj)->imag);
3270 const long len = RSTRUCT_LEN(obj);
3271 const VALUE *
const ptr = RSTRUCT_CONST_PTR(obj);
3273 for (
long i = 0; i <
len; i++) {
3274 gc_mark_internal(ptr[i]);
3278 gc_mark_internal(RSTRUCT_FIELDS_OBJ(obj));
3288 rb_bug(
"rb_gc_mark(): unknown data type 0x%x(%p) %s",
3290 rb_gc_impl_pointer_to_heap_p(
objspace, (
void *)obj) ?
"corrupted object" :
"non object");
3295rb_gc_obj_optimal_size(
VALUE obj)
3299 return rb_ary_size_as_embedded(obj);
3302 if (rb_shape_obj_too_complex_p(obj)) {
3303 return sizeof(
struct RObject);
3310 return rb_str_size_as_embedded(obj);
3313 return sizeof(
struct RHash) + (RHASH_ST_TABLE_P(obj) ? sizeof(
st_table) : sizeof(ar_table));
3321rb_gc_writebarrier(VALUE a, VALUE b)
3323 rb_gc_impl_writebarrier(rb_gc_get_objspace(), a, b);
3329 rb_gc_impl_writebarrier_unprotect(rb_gc_get_objspace(), obj);
3336rb_gc_writebarrier_remember(
VALUE obj)
3338 rb_gc_impl_writebarrier_remember(rb_gc_get_objspace(), obj);
3344 rb_gc_impl_copy_attributes(rb_gc_get_objspace(), dest, obj);
3348rb_gc_modular_gc_loaded_p(
void)
3351 return rb_gc_functions.modular_gc_loaded_p;
3358rb_gc_active_gc_name(
void)
3360 const char *gc_name = rb_gc_impl_active_gc_name();
3362 const size_t len = strlen(gc_name);
3363 if (
len > RB_GC_MAX_NAME_LEN) {
3364 rb_bug(
"GC should have a name no more than %d chars long. Currently: %zu (%s)",
3365 RB_GC_MAX_NAME_LEN,
len, gc_name);
3372rb_gc_object_metadata(
VALUE obj)
3374 return rb_gc_impl_object_metadata(rb_gc_get_objspace(), obj);
3382 return rb_gc_impl_ractor_cache_alloc(rb_gc_get_objspace(), ractor);
3386rb_gc_ractor_cache_free(
void *cache)
3388 rb_gc_impl_ractor_cache_free(rb_gc_get_objspace(), cache);
3394 if (!rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (
void *)obj))
3397 rb_vm_register_global_object(obj);
3408 tmp->next = vm->global_object_list;
3410 vm->global_object_list = tmp;
3418 rb_warn(
"Object is assigned to registering address already: %"PRIsVALUE,
3420 rb_print_backtrace(stderr);
3430 if (tmp->varptr == addr) {
3431 vm->global_object_list = tmp->next;
3436 if (tmp->next->varptr == addr) {
3439 tmp->next = tmp->next->next;
3450 rb_gc_register_address(var);
3456 rb_gc_impl_start(rb_gc_get_objspace(),
RTEST(full_mark),
RTEST(immediate_mark),
RTEST(immediate_sweep),
RTEST(compact));
3500rb_objspace_each_objects(
int (*callback)(
void *,
void *,
size_t,
void *),
void *data)
3502 rb_gc_impl_each_objects(rb_gc_get_objspace(), callback, data);
3508 if (ARY_SHARED_P(v)) {
3509 VALUE old_root =
RARRAY(v)->as.heap.aux.shared_root;
3513 VALUE new_root =
RARRAY(v)->as.heap.aux.shared_root;
3515 if (ARY_EMBED_P(new_root) && new_root != old_root) {
3516 size_t offset = (size_t)(
RARRAY(v)->as.heap.ptr -
RARRAY(old_root)->as.ary);
3517 GC_ASSERT(
RARRAY(v)->as.heap.ptr >=
RARRAY(old_root)->as.ary);
3518 RARRAY(v)->as.heap.ptr =
RARRAY(new_root)->as.ary + offset;
3526 for (
long i = 0; i <
len; i++) {
3531 if (rb_gc_obj_slot_size(v) >= rb_ary_size_as_embedded(v)) {
3532 if (rb_ary_embeddable_p(v)) {
3533 rb_ary_make_embedded(v);
3544 if (rb_shape_obj_too_complex_p(v)) {
3545 gc_ref_update_table_values_only(ROBJECT_FIELDS_HASH(v));
3549 size_t slot_size = rb_gc_obj_slot_size(v);
3551 if (slot_size >= embed_size && !
RB_FL_TEST_RAW(v, ROBJECT_EMBED)) {
3553 memcpy(
ROBJECT(v)->as.ary, ptr,
sizeof(
VALUE) * ROBJECT_FIELDS_COUNT(v));
3559 for (uint32_t i = 0; i < ROBJECT_FIELDS_COUNT(v); i++) {
3565rb_gc_ref_update_table_values_only(
st_table *tbl)
3567 gc_ref_update_table_values_only(tbl);
3574 gc_update_table_refs(ptr);
3580 rb_hash_stlike_foreach_with_replace(v, hash_foreach_replace, hash_replace_ref, (st_data_t)
objspace);
3586 for (
long i = 0; i < n; i++) {
3587 UPDATE_IF_MOVED(
objspace, values[i]);
3592rb_gc_update_values(
long n,
VALUE *values)
3594 gc_update_values(rb_gc_get_objspace(), n, values);
3597static enum rb_id_table_iterator_result
3598check_id_table_move(
VALUE value,
void *data)
3603 return ID_TABLE_REPLACE;
3606 return ID_TABLE_CONTINUE;
3610rb_gc_prepare_heap_process_object(
VALUE obj)
3624rb_gc_prepare_heap(
void)
3626 rb_gc_impl_prepare_heap(rb_gc_get_objspace());
3630rb_gc_heap_id_for_size(
size_t size)
3632 return rb_gc_impl_heap_id_for_size(rb_gc_get_objspace(), size);
3636rb_gc_size_allocatable_p(
size_t size)
3638 return rb_gc_impl_size_allocatable_p(size);
3641static enum rb_id_table_iterator_result
3642update_id_table(
VALUE *value,
void *data,
int existing)
3650 return ID_TABLE_CONTINUE;
3657 rb_id_table_foreach_values_with_replace(tbl, check_id_table_move, update_id_table,
objspace);
3661static enum rb_id_table_iterator_result
3672 entry->class_value = gc_location_internal(
objspace, entry->class_value);
3674 return ID_TABLE_CONTINUE;
3681 rb_id_table_foreach_values(tbl, update_cvc_tbl_i,
objspace);
3684static enum rb_id_table_iterator_result
3689 if (rb_gc_impl_object_moved_p(
objspace, ce->value)) {
3690 ce->value = gc_location_internal(
objspace, ce->value);
3693 if (rb_gc_impl_object_moved_p(
objspace, ce->file)) {
3694 ce->file = gc_location_internal(
objspace, ce->file);
3697 return ID_TABLE_CONTINUE;
3704 rb_id_table_foreach_values(tbl, update_const_tbl_i,
objspace);
3712 if (!anchor)
return;
3713 entry = anchor->head;
3716 UPDATE_IF_MOVED(
objspace, entry->klass);
3717 entry = entry->next;
3724 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
3725 size_t array_size = RCLASSEXT_SUPERCLASS_DEPTH(ext) + 1;
3726 for (
size_t i = 0; i < array_size; i++) {
3727 UPDATE_IF_MOVED(
objspace, RCLASSEXT_SUPERCLASSES(ext)[i]);
3735 UPDATE_IF_MOVED(
objspace, RCLASSEXT_ORIGIN(ext));
3736 UPDATE_IF_MOVED(
objspace, RCLASSEXT_REFINED_CLASS(ext));
3737 UPDATE_IF_MOVED(
objspace, RCLASSEXT_CLASSPATH(ext));
3739 UPDATE_IF_MOVED(
objspace, RCLASSEXT_INCLUDER(ext));
3749 if (RCLASSEXT_SUPER(ext)) {
3750 UPDATE_IF_MOVED(
objspace, RCLASSEXT_SUPER(ext));
3753 update_m_tbl(
objspace, RCLASSEXT_M_TBL(ext));
3755 UPDATE_IF_MOVED(
objspace, ext->fields_obj);
3756 if (!RCLASSEXT_SHARED_CONST_TBL(ext)) {
3757 update_const_tbl(
objspace, RCLASSEXT_CONST_TBL(ext));
3759 UPDATE_IF_MOVED(
objspace, RCLASSEXT_CC_TBL(ext));
3760 update_cvc_tbl(
objspace, RCLASSEXT_CVC_TBL(ext));
3761 update_superclasses(
objspace, ext);
3764 update_classext_values(
objspace, ext,
false);
3773 if (RCLASSEXT_SUPER(ext)) {
3774 UPDATE_IF_MOVED(
objspace, RCLASSEXT_SUPER(ext));
3776 update_m_tbl(
objspace, RCLASSEXT_M_TBL(ext));
3777 update_m_tbl(
objspace, RCLASSEXT_CALLABLE_M_TBL(ext));
3778 UPDATE_IF_MOVED(
objspace, RCLASSEXT_CC_TBL(ext));
3781 update_classext_values(
objspace, ext,
true);
3785 vm_table_foreach_callback_func callback;
3786 vm_table_update_callback_func update_callback;
3792vm_weak_table_foreach_weak_key(st_data_t key, st_data_t value, st_data_t data,
int error)
3796 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3798 if (!iter_data->weak_only) {
3799 if (ret != ST_CONTINUE)
return ret;
3801 ret = iter_data->callback((
VALUE)value, iter_data->data);
3808vm_weak_table_foreach_update_weak_key(st_data_t *key, st_data_t *value, st_data_t data,
int existing)
3812 int ret = iter_data->update_callback((
VALUE *)key, iter_data->data);
3814 if (!iter_data->weak_only) {
3815 if (ret != ST_CONTINUE)
return ret;
3817 ret = iter_data->update_callback((
VALUE *)value, iter_data->data);
3824vm_weak_table_cc_refinement_foreach(st_data_t key, st_data_t data,
int error)
3828 return iter_data->callback((
VALUE)key, iter_data->data);
3832vm_weak_table_cc_refinement_foreach_update_update(st_data_t *key, st_data_t data,
int existing)
3836 return iter_data->update_callback((
VALUE *)key, iter_data->data);
3841vm_weak_table_sym_set_foreach(
VALUE *sym_ptr,
void *data)
3843 VALUE sym = *sym_ptr;
3848 int ret = iter_data->callback(sym, iter_data->data);
3850 if (ret == ST_REPLACE) {
3851 ret = iter_data->update_callback(sym_ptr, iter_data->data);
3857struct st_table *rb_generic_fields_tbl_get(
void);
3860vm_weak_table_id2ref_foreach(st_data_t key, st_data_t value, st_data_t data,
int error)
3865 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3866 if (ret != ST_CONTINUE)
return ret;
3869 return iter_data->callback((
VALUE)value, iter_data->data);
3873vm_weak_table_id2ref_foreach_update(st_data_t *key, st_data_t *value, st_data_t data,
int existing)
3877 iter_data->update_callback((
VALUE *)value, iter_data->data);
3880 iter_data->update_callback((
VALUE *)key, iter_data->data);
3887vm_weak_table_gen_fields_foreach(st_data_t key, st_data_t value, st_data_t data)
3891 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3901 RBASIC_SET_SHAPE_ID((
VALUE)key, ROOT_SHAPE_ID);
3905 ret = iter_data->update_callback(&new_key, iter_data->data);
3906 if (key != new_key) {
3913 rb_bug(
"vm_weak_table_gen_fields_foreach: return value %d not supported", ret);
3916 if (!iter_data->weak_only) {
3917 int ivar_ret = iter_data->callback(new_value, iter_data->data);
3923 iter_data->update_callback(&new_value, iter_data->data);
3927 rb_bug(
"vm_weak_table_gen_fields_foreach: return value %d not supported", ivar_ret);
3931 if (key != new_key || value != new_value) {
3932 DURING_GC_COULD_MALLOC_REGION_START();
3934 st_insert(rb_generic_fields_tbl_get(), (st_data_t)new_key, new_value);
3936 DURING_GC_COULD_MALLOC_REGION_END();
3943vm_weak_table_frozen_strings_foreach(
VALUE *str,
void *data)
3947 int retval = iter_data->callback(*str, iter_data->data);
3949 if (retval == ST_REPLACE) {
3950 retval = iter_data->update_callback(str, iter_data->data);
3953 if (retval == ST_DELETE) {
3960void rb_fstring_foreach_with_replace(
int (*callback)(
VALUE *str,
void *data),
void *data);
3962rb_gc_vm_weak_table_foreach(vm_table_foreach_callback_func callback,
3963 vm_table_update_callback_func update_callback,
3966 enum rb_gc_vm_weak_tables table)
3971 .callback = callback,
3972 .update_callback = update_callback,
3974 .weak_only = weak_only,
3978 case RB_GC_VM_CI_TABLE: {
3980 st_foreach_with_replace(
3982 vm_weak_table_foreach_weak_key,
3983 vm_weak_table_foreach_update_weak_key,
3984 (st_data_t)&foreach_data
3989 case RB_GC_VM_OVERLOADED_CME_TABLE: {
3990 if (vm->overloaded_cme_table) {
3991 st_foreach_with_replace(
3992 vm->overloaded_cme_table,
3993 vm_weak_table_foreach_weak_key,
3994 vm_weak_table_foreach_update_weak_key,
3995 (st_data_t)&foreach_data
4000 case RB_GC_VM_GLOBAL_SYMBOLS_TABLE: {
4001 rb_sym_global_symbol_table_foreach_weak_reference(
4002 vm_weak_table_sym_set_foreach,
4007 case RB_GC_VM_ID2REF_TABLE: {
4009 st_foreach_with_replace(
4011 vm_weak_table_id2ref_foreach,
4012 vm_weak_table_id2ref_foreach_update,
4013 (st_data_t)&foreach_data
4018 case RB_GC_VM_GENERIC_FIELDS_TABLE: {
4019 st_table *generic_fields_tbl = rb_generic_fields_tbl_get();
4020 if (generic_fields_tbl) {
4023 vm_weak_table_gen_fields_foreach,
4024 (st_data_t)&foreach_data
4029 case RB_GC_VM_FROZEN_STRINGS_TABLE: {
4030 rb_fstring_foreach_with_replace(
4031 vm_weak_table_frozen_strings_foreach,
4036 case RB_GC_VM_CC_REFINEMENT_TABLE: {
4037 if (vm->cc_refinement_table) {
4038 set_foreach_with_replace(
4039 vm->cc_refinement_table,
4040 vm_weak_table_cc_refinement_foreach,
4041 vm_weak_table_cc_refinement_foreach_update_update,
4042 (st_data_t)&foreach_data
4047 case RB_GC_VM_WEAK_TABLE_COUNT:
4048 rb_bug(
"Unreachable");
4050 rb_bug(
"rb_gc_vm_weak_table_foreach: unknown table %d", table);
4055rb_gc_update_vm_references(
void *
objspace)
4058 rb_vm_t *vm = rb_ec_vm_ptr(ec);
4060 rb_vm_update_references(vm);
4061 rb_gc_update_global_tbl();
4062 rb_sym_global_symbols_mark_and_move();
4065 void rb_yjit_root_update_references(
void);
4067 if (rb_yjit_enabled_p) {
4068 rb_yjit_root_update_references();
4081 UPDATE_IF_MOVED(
objspace, RCLASS_ATTACHED_OBJECT(obj));
4087 rb_class_classext_foreach(obj, update_classext, (
void *)&args);
4092 rb_class_classext_foreach(obj, update_iclass_classext, (
void *)&args);
4096 rb_imemo_mark_and_move(obj,
true);
4108 gc_ref_update_array(
objspace, obj);
4113 UPDATE_IF_MOVED(
objspace, RHASH(obj)->ifnone);
4118 if (STR_SHARED_P(obj)) {
4124 if (rb_gc_obj_slot_size(obj) >= rb_str_size_as_embedded(obj)) {
4125 if (!STR_EMBED_P(obj) && rb_str_reembeddable_p(obj)) {
4126 rb_str_make_embedded(obj);
4136 void *
const ptr = typed_data ? RTYPEDDATA_GET_DATA(obj) :
DATA_PTR(obj);
4144 size_t *offset_list = TYPED_DATA_REFS_OFFSET_LIST(obj);
4146 for (
size_t offset = *offset_list; offset != RUBY_REF_END; offset = *offset_list++) {
4147 VALUE *ref = (
VALUE *)((
char *)ptr + offset);
4148 *ref = gc_location_internal(
objspace, *ref);
4151 else if (typed_data) {
4153 if (compact_func) (*compact_func)(ptr);
4160 gc_ref_update_object(
objspace, obj);
4164 if (
RFILE(obj)->fptr) {
4167 UPDATE_IF_MOVED(
objspace,
RFILE(obj)->fptr->tied_io_for_writing);
4168 UPDATE_IF_MOVED(
objspace,
RFILE(obj)->fptr->writeconv_asciicompat);
4169 UPDATE_IF_MOVED(
objspace,
RFILE(obj)->fptr->writeconv_pre_ecopts);
4181 UPDATE_IF_MOVED(
objspace, RSYMBOL(obj)->fstr);
4197 UPDATE_IF_MOVED(
objspace, RRATIONAL(obj)->num);
4198 UPDATE_IF_MOVED(
objspace, RRATIONAL(obj)->den);
4202 UPDATE_IF_MOVED(
objspace, RCOMPLEX(obj)->real);
4203 UPDATE_IF_MOVED(
objspace, RCOMPLEX(obj)->imag);
4209 long i,
len = RSTRUCT_LEN(obj);
4210 VALUE *ptr = (
VALUE *)RSTRUCT_CONST_PTR(obj);
4212 for (i = 0; i <
len; i++) {
4216 if (RSTRUCT_EMBED_LEN(obj)) {
4222 UPDATE_IF_MOVED(
objspace, RSTRUCT(obj)->as.heap.fields_obj);
4227 rb_bug(
"unreachable");
4244 unless_objspace(
objspace) {
return; }
4246 rb_gc_impl_start(
objspace,
true,
true,
true,
false);
4252 unless_objspace(
objspace) {
return FALSE; }
4254 return rb_gc_impl_during_gc_p(
objspace);
4260 return rb_gc_impl_gc_count(rb_gc_get_objspace());
4276 VALUE val = rb_gc_impl_latest_gc_info(rb_gc_get_objspace(), key);
4279 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(key));
4289 arg = rb_hash_new();
4295 VALUE ret = rb_gc_impl_stat(rb_gc_get_objspace(), arg);
4300 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(arg));
4313 VALUE ret = rb_gc_impl_stat(rb_gc_get_objspace(), arg);
4318 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(arg));
4333 arg = rb_hash_new();
4336 if (
NIL_P(heap_name)) {
4347 rb_raise(
rb_eTypeError,
"heap_name must be nil or an Integer");
4350 VALUE ret = rb_gc_impl_stat_heap(rb_gc_get_objspace(), heap_name, arg);
4355 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(arg));
4364 VALUE cfg_hash = rb_gc_impl_config_get(rb_gc_get_objspace());
4365 rb_hash_aset(cfg_hash, sym(
"implementation"), rb_fstring_cstr(rb_gc_impl_active_gc_name()));
4373 void *
objspace = rb_gc_get_objspace();
4375 rb_gc_impl_config_set(
objspace, hash);
4383 return rb_gc_impl_stress_get(rb_gc_get_objspace());
4389 rb_gc_impl_stress_set(rb_gc_get_objspace(), flag);
4395rb_gc_initial_stress_set(
VALUE flag)
4397 initial_stress = flag;
4401rb_gc_heap_sizes(
void)
4403 return rb_gc_impl_heap_sizes(rb_gc_get_objspace());
4409 return rb_objspace_gc_enable(rb_gc_get_objspace());
4413rb_objspace_gc_enable(
void *
objspace)
4415 bool disabled = !rb_gc_impl_gc_enabled_p(
objspace);
4417 return RBOOL(disabled);
4423 return rb_gc_enable();
4429 bool disabled = !rb_gc_impl_gc_enabled_p(
objspace);
4430 rb_gc_impl_gc_disable(
objspace,
false);
4431 return RBOOL(disabled);
4435rb_gc_disable_no_rest(
void)
4437 return gc_disable_no_rest(rb_gc_get_objspace());
4443 return rb_objspace_gc_disable(rb_gc_get_objspace());
4447rb_objspace_gc_disable(
void *
objspace)
4449 bool disabled = !rb_gc_impl_gc_enabled_p(
objspace);
4450 rb_gc_impl_gc_disable(
objspace,
true);
4451 return RBOOL(disabled);
4457 return rb_gc_disable();
4462ruby_gc_set_params(
void)
4464 rb_gc_impl_set_params(rb_gc_get_objspace());
4468rb_objspace_reachable_objects_from(
VALUE obj,
void (func)(
VALUE,
void *),
void *data)
4471 if (rb_gc_impl_during_gc_p(rb_gc_get_objspace())) rb_bug(
"rb_objspace_reachable_objects_from() is not supported while during GC");
4475 struct gc_mark_func_data_struct *prev_mfd = vm->gc.mark_func_data;
4476 struct gc_mark_func_data_struct mfd = {
4481 vm->gc.mark_func_data = &mfd;
4482 rb_gc_mark_children(rb_gc_get_objspace(), obj);
4483 vm->gc.mark_func_data = prev_mfd;
4489 const char *category;
4490 void (*func)(
const char *category,
VALUE,
void *);
4495root_objects_from(
VALUE obj,
void *ptr)
4498 (*data->func)(data->category, obj, data->data);
4502rb_objspace_reachable_objects_from_root(
void (func)(
const char *category,
VALUE,
void *),
void *passing_data)
4504 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");
4510 .data = passing_data,
4513 struct gc_mark_func_data_struct *prev_mfd = vm->gc.mark_func_data;
4514 struct gc_mark_func_data_struct mfd = {
4515 .mark_func = root_objects_from,
4519 vm->gc.mark_func_data = &mfd;
4520 rb_gc_save_machine_context();
4521 rb_gc_mark_roots(vm->gc.objspace, &data.category);
4522 vm->gc.mark_func_data = prev_mfd;
4533#define TYPE_NAME(t) case (t): return #t;
4560 if (obj && rb_objspace_data_type_name(obj)) {
4561 return rb_objspace_data_type_name(obj);
4570obj_type_name(
VALUE obj)
4572 return type_name(
TYPE(obj), obj);
4576rb_method_type_name(rb_method_type_t
type)
4579 case VM_METHOD_TYPE_ISEQ:
return "iseq";
4580 case VM_METHOD_TYPE_ATTRSET:
return "attrest";
4581 case VM_METHOD_TYPE_IVAR:
return "ivar";
4582 case VM_METHOD_TYPE_BMETHOD:
return "bmethod";
4583 case VM_METHOD_TYPE_ALIAS:
return "alias";
4584 case VM_METHOD_TYPE_REFINED:
return "refined";
4585 case VM_METHOD_TYPE_CFUNC:
return "cfunc";
4586 case VM_METHOD_TYPE_ZSUPER:
return "zsuper";
4587 case VM_METHOD_TYPE_MISSING:
return "missing";
4588 case VM_METHOD_TYPE_OPTIMIZED:
return "optimized";
4589 case VM_METHOD_TYPE_UNDEF:
return "undef";
4590 case VM_METHOD_TYPE_NOTIMPLEMENTED:
return "notimplemented";
4592 rb_bug(
"rb_method_type_name: unreachable (type: %d)",
type);
4596rb_raw_iseq_info(
char *
const buff,
const size_t buff_size,
const rb_iseq_t *iseq)
4598 if (buff_size > 0 && ISEQ_BODY(iseq) && ISEQ_BODY(iseq)->location.label && !
RB_TYPE_P(ISEQ_BODY(iseq)->location.pathobj,
T_MOVED)) {
4599 VALUE path = rb_iseq_path(iseq);
4600 int n = ISEQ_BODY(iseq)->location.first_lineno;
4601 snprintf(buff, buff_size,
" %s@%s:%d",
4602 RSTRING_PTR(ISEQ_BODY(iseq)->location.label),
4603 RSTRING_PTR(path), n);
4608str_len_no_raise(
VALUE str)
4610 long len = RSTRING_LEN(str);
4611 if (
len < 0)
return 0;
4612 if (
len > INT_MAX)
return INT_MAX;
4616#define BUFF_ARGS buff + pos, buff_size - pos
4617#define APPEND_F(...) if ((pos += snprintf(BUFF_ARGS, "" __VA_ARGS__)) >= buff_size) goto end
4618#define APPEND_S(s) do { \
4619 if ((pos + (int)rb_strlen_lit(s)) >= buff_size) { \
4623 memcpy(buff + pos, (s), rb_strlen_lit(s) + 1); \
4626#define C(c, s) ((c) != 0 ? (s) : " ")
4629rb_raw_obj_info_common(
char *
const buff,
const size_t buff_size,
const VALUE obj)
4634 APPEND_F(
"%s", obj_type_name(obj));
4640 APPEND_F(
" %s", rb_id2name(
SYM2ID(obj)));
4646 if (rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (
void *)obj)) {
4647 APPEND_F(
"%p %s/", (
void *)obj, obj_type_name(obj));
4666 if (internal_object_p(obj)) {
4669 else if (
RBASIC(obj)->klass == 0) {
4670 APPEND_S(
"(temporary internal)");
4674 if (!
NIL_P(class_path)) {
4675 APPEND_F(
"%s ", RSTRING_PTR(class_path));
4684const char *rb_raw_obj_info(
char *
const buff,
const size_t buff_size,
VALUE obj);
4687rb_raw_obj_info_buitin_type(
char *
const buff,
const size_t buff_size,
const VALUE obj,
size_t pos)
4694 UNEXPECTED_NODE(rb_raw_obj_info);
4697 if (ARY_SHARED_P(obj)) {
4698 APPEND_S(
"shared -> ");
4699 rb_raw_obj_info(BUFF_ARGS, ARY_SHARED_ROOT(obj));
4701 else if (ARY_EMBED_P(obj)) {
4702 APPEND_F(
"[%s%s] len: %ld (embed)",
4703 C(ARY_EMBED_P(obj),
"E"),
4704 C(ARY_SHARED_P(obj),
"S"),
4708 APPEND_F(
"[%s%s] len: %ld, capa:%ld ptr:%p",
4709 C(ARY_EMBED_P(obj),
"E"),
4710 C(ARY_SHARED_P(obj),
"S"),
4712 ARY_EMBED_P(obj) ? -1L :
RARRAY(obj)->as.heap.aux.
capa,
4717 if (STR_SHARED_P(obj)) {
4718 APPEND_F(
" [shared] len: %ld", RSTRING_LEN(obj));
4721 if (STR_EMBED_P(obj)) APPEND_S(
" [embed]");
4723 APPEND_F(
" len: %ld, capa: %" PRIdSIZE, RSTRING_LEN(obj),
rb_str_capacity(obj));
4725 APPEND_F(
" \"%.*s\"", str_len_no_raise(obj), RSTRING_PTR(obj));
4729 VALUE fstr = RSYMBOL(obj)->fstr;
4730 ID id = RSYMBOL(obj)->id;
4732 APPEND_F(
":%s id:%d", RSTRING_PTR(fstr), (
unsigned int)
id);
4735 APPEND_F(
"(%p) id:%d", (
void *)fstr, (
unsigned int)
id);
4740 APPEND_F(
"-> %p", (
void*)gc_location_internal(rb_gc_get_objspace(), obj));
4744 APPEND_F(
"[%c] %"PRIdSIZE,
4745 RHASH_AR_TABLE_P(obj) ?
'A' :
'S',
4753 if (!
NIL_P(class_path)) {
4754 APPEND_F(
"%s", RSTRING_PTR(class_path));
4764 if (!
NIL_P(class_path)) {
4765 APPEND_F(
"src:%s", RSTRING_PTR(class_path));
4771 if (rb_shape_obj_too_complex_p(obj)) {
4772 size_t hash_len = rb_st_table_size(ROBJECT_FIELDS_HASH(obj));
4773 APPEND_F(
"(too_complex) len:%zu", hash_len);
4776 uint32_t
len = ROBJECT_FIELDS_CAPACITY(obj);
4778 if (
RBASIC(obj)->flags & ROBJECT_EMBED) {
4779 APPEND_F(
"(embed) len:%d",
len);
4783 APPEND_F(
"len:%d ptr:%p",
len, (
void *)ptr);
4792 (block = vm_proc_block(obj)) != NULL &&
4793 (vm_block_type(block) == block_type_iseq) &&
4794 (iseq = vm_block_iseq(block)) != NULL) {
4795 rb_raw_iseq_info(BUFF_ARGS, iseq);
4797 else if (rb_ractor_p(obj)) {
4800 APPEND_F(
"r:%d", r->pub.id);
4804 const char *
const type_name = rb_objspace_data_type_name(obj);
4806 APPEND_F(
"%s", type_name);
4812 APPEND_F(
"<%s> ", rb_imemo_name(imemo_type(obj)));
4814 switch (imemo_type(obj)) {
4819 APPEND_F(
":%s (%s%s%s%s) type:%s aliased:%d owner:%p defined_class:%p",
4820 rb_id2name(me->called_id),
4821 METHOD_ENTRY_VISI(me) == METHOD_VISI_PUBLIC ?
"pub" :
4822 METHOD_ENTRY_VISI(me) == METHOD_VISI_PRIVATE ?
"pri" :
"pro",
4823 METHOD_ENTRY_COMPLEMENTED(me) ?
",cmp" :
"",
4824 METHOD_ENTRY_CACHED(me) ?
",cc" :
"",
4825 METHOD_ENTRY_INVALIDATED(me) ?
",inv" :
"",
4826 me->def ? rb_method_type_name(me->def->
type) :
"NULL",
4827 me->def ? me->def->aliased : -1,
4829 (void *)me->defined_class);
4832 switch (me->def->type) {
4833 case VM_METHOD_TYPE_ISEQ:
4834 APPEND_S(
" (iseq:");
4835 rb_raw_obj_info(BUFF_ARGS, (
VALUE)me->def->body.iseq.
iseqptr);
4847 rb_raw_iseq_info(BUFF_ARGS, iseq);
4850 case imemo_callinfo:
4853 APPEND_F(
"(mid:%s, flag:%x argc:%d, kwarg:%s)",
4854 rb_id2name(vm_ci_mid(ci)),
4857 vm_ci_kwarg(ci) ?
"available" :
"NULL");
4860 case imemo_callcache:
4866 APPEND_F(
"(klass:%s cme:%s%s (%p) call:%p",
4867 NIL_P(class_path) ? (vm_cc_valid(cc) ?
"??" :
"<NULL>") : RSTRING_PTR(class_path),
4868 cme ? rb_id2name(cme->called_id) :
"<NULL>",
4869 cme ? (METHOD_ENTRY_INVALIDATED(cme) ?
" [inv]" :
"") :
"",
4871 (void *)(uintptr_t)vm_cc_call(cc));
4889#ifdef RUBY_ASAN_ENABLED
4891rb_asan_poison_object(
VALUE obj)
4893 MAYBE_UNUSED(
struct RVALUE *) ptr = (
void *)obj;
4894 asan_poison_memory_region(ptr, rb_gc_obj_slot_size(obj));
4898rb_asan_unpoison_object(
VALUE obj,
bool newobj_p)
4900 MAYBE_UNUSED(
struct RVALUE *) ptr = (
void *)obj;
4901 asan_unpoison_memory_region(ptr, rb_gc_obj_slot_size(obj), newobj_p);
4905rb_asan_poisoned_object_p(
VALUE obj)
4907 MAYBE_UNUSED(
struct RVALUE *) ptr = (
void *)obj;
4908 return __asan_region_is_poisoned(ptr, rb_gc_obj_slot_size(obj));
4913raw_obj_info(
char *
const buff,
const size_t buff_size,
VALUE obj)
4915 size_t pos = rb_raw_obj_info_common(buff, buff_size, obj);
4916 pos = rb_raw_obj_info_buitin_type(buff, buff_size, obj, pos);
4917 if (pos >= buff_size) {}
4921rb_raw_obj_info(
char *
const buff,
const size_t buff_size,
VALUE obj)
4923 void *
objspace = rb_gc_get_objspace();
4926 raw_obj_info(buff, buff_size, obj);
4928 else if (!rb_gc_impl_pointer_to_heap_p(
objspace, (
const void *)obj)) {
4929 snprintf(buff, buff_size,
"out-of-heap:%p", (
void *)obj);
4932 else if (0 && rb_gc_impl_garbage_object_p(
objspace, obj)) {
4933 snprintf(buff, buff_size,
"garbage:%p", (
void *)obj);
4937 asan_unpoisoning_object(obj) {
4938 raw_obj_info(buff, buff_size, obj);
4949#define OBJ_INFO_BUFFERS_NUM 10
4950#define OBJ_INFO_BUFFERS_SIZE 0x100
4952static char obj_info_buffers[OBJ_INFO_BUFFERS_NUM][OBJ_INFO_BUFFERS_SIZE];
4960 if (RB_UNLIKELY(oldval >= maxval - 1)) {
4971 rb_atomic_t index = atomic_inc_wraparound(&obj_info_buffers_index, OBJ_INFO_BUFFERS_NUM);
4972 char *
const buff = obj_info_buffers[index];
4973 return rb_raw_obj_info(buff, OBJ_INFO_BUFFERS_SIZE, obj);
4979 return obj_type_name(obj);
4997 rb_vraise(argv->exc, argv->fmt, *argv->ap);
5002gc_raise(
VALUE exc,
const char *fmt, ...)
5010 if (ruby_thread_has_gvl_p()) {
5020 fprintf(stderr,
"%s",
"[FATAL] ");
5021 vfprintf(stderr, fmt, ap);
5028NORETURN(
static void negative_size_allocation_error(
const char *));
5030negative_size_allocation_error(
const char *msg)
5036ruby_memerror_body(
void *dummy)
5042NORETURN(
static void ruby_memerror(
void));
5047 if (ruby_thread_has_gvl_p()) {
5056 fprintf(stderr,
"[FATAL] failed to allocate memory\n");
5074 VALUE exc = GET_VM()->special_exceptions[ruby_error_nomemory];
5077 rb_ec_raised_p(ec, RAISED_NOMEMORY) ||
5078 rb_ec_vm_lock_rec(ec) != ec->tag->lock_rec) {
5079 fprintf(stderr,
"[FATAL] failed to allocate memory\n");
5082 if (rb_ec_raised_p(ec, RAISED_NOMEMORY)) {
5083 rb_ec_raised_clear(ec);
5086 rb_ec_raised_set(ec, RAISED_NOMEMORY);
5087 exc = ruby_vm_special_exception_copy(exc);
5090 EC_JUMP_TAG(ec, TAG_RAISE);
5094rb_memerror_reentered(
void)
5097 return (ec && rb_ec_raised_p(ec, RAISED_NOMEMORY));
5101handle_malloc_failure(
void *ptr)
5112static void *ruby_xmalloc_body(
size_t size);
5115ruby_xmalloc(
size_t size)
5117 return handle_malloc_failure(ruby_xmalloc_body(size));
5121ruby_xmalloc_body(
size_t size)
5123 if ((ssize_t)size < 0) {
5124 negative_size_allocation_error(
"too large allocation size");
5127 return rb_gc_impl_malloc(rb_gc_get_objspace(), size);
5131ruby_malloc_size_overflow(
size_t count,
size_t elsize)
5133 rb_raise(rb_eArgError,
5134 "malloc: possible integer overflow (%"PRIuSIZE
"*%"PRIuSIZE
")",
5139ruby_malloc_add_size_overflow(
size_t x,
size_t y)
5141 rb_raise(rb_eArgError,
5142 "malloc: possible integer overflow (%"PRIuSIZE
"+%"PRIuSIZE
")",
5146static void *ruby_xmalloc2_body(
size_t n,
size_t size);
5149ruby_xmalloc2(
size_t n,
size_t size)
5151 return handle_malloc_failure(ruby_xmalloc2_body(n, size));
5155ruby_xmalloc2_body(
size_t n,
size_t size)
5157 return rb_gc_impl_malloc(rb_gc_get_objspace(), xmalloc2_size(n, size));
5160static void *ruby_xcalloc_body(
size_t n,
size_t size);
5163ruby_xcalloc(
size_t n,
size_t size)
5165 return handle_malloc_failure(ruby_xcalloc_body(n, size));
5169ruby_xcalloc_body(
size_t n,
size_t size)
5171 return rb_gc_impl_calloc(rb_gc_get_objspace(), xmalloc2_size(n, size));
5174static void *ruby_sized_xrealloc_body(
void *ptr,
size_t new_size,
size_t old_size);
5176#ifdef ruby_sized_xrealloc
5177#undef ruby_sized_xrealloc
5180ruby_sized_xrealloc(
void *ptr,
size_t new_size,
size_t old_size)
5182 return handle_malloc_failure(ruby_sized_xrealloc_body(ptr, new_size, old_size));
5186ruby_sized_xrealloc_body(
void *ptr,
size_t new_size,
size_t old_size)
5188 if ((ssize_t)new_size < 0) {
5189 negative_size_allocation_error(
"too large allocation size");
5192 return rb_gc_impl_realloc(rb_gc_get_objspace(), ptr, new_size, old_size);
5196ruby_xrealloc(
void *ptr,
size_t new_size)
5198 return ruby_sized_xrealloc(ptr, new_size, 0);
5201static void *ruby_sized_xrealloc2_body(
void *ptr,
size_t n,
size_t size,
size_t old_n);
5203#ifdef ruby_sized_xrealloc2
5204#undef ruby_sized_xrealloc2
5207ruby_sized_xrealloc2(
void *ptr,
size_t n,
size_t size,
size_t old_n)
5209 return handle_malloc_failure(ruby_sized_xrealloc2_body(ptr, n, size, old_n));
5213ruby_sized_xrealloc2_body(
void *ptr,
size_t n,
size_t size,
size_t old_n)
5215 size_t len = xmalloc2_size(n, size);
5216 return rb_gc_impl_realloc(rb_gc_get_objspace(), ptr,
len, old_n * size);
5220ruby_xrealloc2(
void *ptr,
size_t n,
size_t size)
5222 return ruby_sized_xrealloc2(ptr, n, size, 0);
5225#ifdef ruby_sized_xfree
5226#undef ruby_sized_xfree
5229ruby_sized_xfree(
void *x,
size_t size)
5235 if (LIKELY(GET_VM())) {
5236 rb_gc_impl_free(rb_gc_get_objspace(), x, size);
5247 ruby_sized_xfree(x, 0);
5251rb_xmalloc_mul_add(
size_t x,
size_t y,
size_t z)
5253 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
5254 return ruby_xmalloc(w);
5258rb_xcalloc_mul_add(
size_t x,
size_t y,
size_t z)
5260 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
5261 return ruby_xcalloc(w, 1);
5265rb_xrealloc_mul_add(
const void *p,
size_t x,
size_t y,
size_t z)
5267 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
5268 return ruby_xrealloc((
void *)p, w);
5272rb_xmalloc_mul_add_mul(
size_t x,
size_t y,
size_t z,
size_t w)
5274 size_t u = size_mul_add_mul_or_raise(x, y, z, w, rb_eArgError);
5275 return ruby_xmalloc(u);
5279rb_xcalloc_mul_add_mul(
size_t x,
size_t y,
size_t z,
size_t w)
5281 size_t u = size_mul_add_mul_or_raise(x, y, z, w, rb_eArgError);
5282 return ruby_xcalloc(u, 1);
5289ruby_mimmalloc(
size_t size)
5292#if CALC_EXACT_MALLOC_SIZE
5296#if CALC_EXACT_MALLOC_SIZE
5312ruby_mimcalloc(
size_t num,
size_t size)
5315#if CALC_EXACT_MALLOC_SIZE
5316 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(num, size);
5317 if (UNLIKELY(t.left)) {
5321 mem = calloc1(size);
5333 mem = calloc(num, size);
5339ruby_mimfree(
void *ptr)
5341#if CALC_EXACT_MALLOC_SIZE
5349rb_gc_adjust_memory_usage(ssize_t diff)
5351 unless_objspace(
objspace) {
return; }
5353 rb_gc_impl_adjust_memory_usage(
objspace, diff);
5357rb_obj_info(
VALUE obj)
5359 return obj_info(obj);
5363rb_obj_info_dump(
VALUE obj)
5366 fprintf(stderr,
"rb_obj_info_dump: %s\n", rb_raw_obj_info(buff, 0x100, obj));
5370rb_obj_info_dump_loc(
VALUE obj,
const char *file,
int line,
const char *func)
5373 fprintf(stderr,
"<OBJ_INFO:%s@%s:%d> %s\n", func, file, line, rb_raw_obj_info(buff, 0x100, obj));
5377rb_gc_before_fork(
void)
5379 rb_gc_impl_before_fork(rb_gc_get_objspace());
5383rb_gc_after_fork(rb_pid_t pid)
5385 rb_gc_impl_after_fork(rb_gc_get_objspace(), pid);
5439 rb_gc_register_address(&id2ref_value);
5441 malloc_offset = gc_compute_malloc_offset();
5454 rb_vm_register_special_exception(ruby_error_nomemory,
rb_eNoMemError,
"failed to allocate memory");
5477ruby_annotate_mmap(
const void *addr,
unsigned long size,
const char *name)
5479#if defined(HAVE_SYS_PRCTL_H) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
5482 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_VALUE_CAS(var, oldval, newval)
Identical to RUBY_ATOMIC_CAS, except it expects its arguments are VALUE.
#define RUBY_ATOMIC_SIZE_FETCH_ADD(var, val)
Identical to RUBY_ATOMIC_FETCH_ADD, except it expects its arguments to be size_t.
#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 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 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 ULL2NUM
Old name of RB_ULL2NUM.
#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 NUM2ULL
Old name of RB_NUM2ULL.
#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 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.
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
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.
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
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.
size_t rb_obj_embedded_size(uint32_t fields_count)
Internal header for Object.
VALUE rb_to_int(VALUE val)
Identical to rb_check_to_int(), except it raises in case of conversion mismatch.
#define RB_POSFIXABLE(_)
Checks if the passed value is in range of fixnum, assuming it is a positive number.
int rb_enc_str_coderange(VALUE str)
Scans the passed string to collect its code range.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
Defines RBIMPL_HAS_BUILTIN.
void rb_ary_free(VALUE ary)
Destroys the given array for no reason.
#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(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_FIELDS(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 TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
#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.
void rb_p(VALUE obj)
Inspects an 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.
RUBY_DATA_FUNC dfree
This function is called when the object is no longer used.
RUBY_DATA_FUNC dcompact
This function is called when the object is relocated.
struct rb_data_type_struct::@54 function
Function pointers.
const char * wrap_struct_name
Name of structs of this kind.
RUBY_DATA_FUNC dmark
This function is called when the object is experiencing GC marks.
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
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.
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.