14#define rb_data_object_alloc rb_data_object_alloc
15#define rb_data_typed_object_alloc rb_data_typed_object_alloc
17#include "ruby/internal/config.h"
22#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
23# include "wasm/setjmp.h"
24# include "wasm/machine.h"
32#ifndef HAVE_MALLOC_USABLE_SIZE
34# define HAVE_MALLOC_USABLE_SIZE
35# define malloc_usable_size(a) _msize(a)
36# elif defined HAVE_MALLOC_SIZE
37# define HAVE_MALLOC_USABLE_SIZE
38# define malloc_usable_size(a) malloc_size(a)
42#ifdef HAVE_MALLOC_USABLE_SIZE
43# ifdef RUBY_ALTERNATIVE_MALLOC_HEADER
45# elif defined(HAVE_MALLOC_H)
47# elif defined(HAVE_MALLOC_NP_H)
48# include <malloc_np.h>
49# elif defined(HAVE_MALLOC_MALLOC_H)
50# include <malloc/malloc.h>
60#ifdef HAVE_SYS_RESOURCE_H
61# include <sys/resource.h>
64#if defined _WIN32 || defined __CYGWIN__
66#elif defined(HAVE_POSIX_MEMALIGN)
67#elif defined(HAVE_MEMALIGN)
74#include <emscripten.h>
78#ifdef HAVE_SYS_PRCTL_H
86#include "debug_counter.h"
87#include "eval_intern.h"
91#include "internal/class.h"
92#include "internal/compile.h"
93#include "internal/complex.h"
94#include "internal/cont.h"
95#include "internal/error.h"
96#include "internal/eval.h"
97#include "internal/gc.h"
98#include "internal/hash.h"
99#include "internal/imemo.h"
100#include "internal/io.h"
101#include "internal/numeric.h"
102#include "internal/object.h"
103#include "internal/proc.h"
104#include "internal/rational.h"
105#include "internal/sanitizers.h"
106#include "internal/struct.h"
107#include "internal/symbol.h"
108#include "internal/thread.h"
109#include "internal/variable.h"
110#include "internal/warnings.h"
120#include "ruby_assert.h"
121#include "ruby_atomic.h"
126#include "vm_callinfo.h"
127#include "ractor_core.h"
134rb_gc_vm_lock(
const char *file,
int line)
136 unsigned int lev = 0;
137 rb_vm_lock_enter(&lev, file, line);
142rb_gc_vm_unlock(
unsigned int lev,
const char *file,
int line)
144 rb_vm_lock_leave(&lev, file, line);
148rb_gc_cr_lock(
const char *file,
int line)
151 rb_vm_lock_enter_cr(GET_RACTOR(), &lev, file, line);
156rb_gc_cr_unlock(
unsigned int lev,
const char *file,
int line)
158 rb_vm_lock_leave_cr(GET_RACTOR(), &lev, file, line);
162rb_gc_vm_lock_no_barrier(
const char *file,
int line)
164 unsigned int lev = 0;
165 rb_vm_lock_enter_nb(&lev, file, line);
170rb_gc_vm_unlock_no_barrier(
unsigned int lev,
const char *file,
int line)
172 rb_vm_lock_leave_nb(&lev, file, line);
176rb_gc_vm_barrier(
void)
183rb_gc_get_ractor_newobj_cache(
void)
185 return GET_RACTOR()->newobj_cache;
189rb_gc_initialize_vm_context(
struct rb_gc_vm_context *context)
192 context->ec = GET_EC();
196rb_gc_worker_thread_set_vm_context(
struct rb_gc_vm_context *context)
200 GC_ASSERT(rb_current_execution_context(
false) == NULL);
202#ifdef RB_THREAD_LOCAL_SPECIFIER
203 rb_current_ec_set(context->ec);
205 native_tls_set(ruby_current_ec_key, context->ec);
210rb_gc_worker_thread_unset_vm_context(
struct rb_gc_vm_context *context)
214 GC_ASSERT(rb_current_execution_context(
true) == context->ec);
216#ifdef RB_THREAD_LOCAL_SPECIFIER
217 rb_current_ec_set(NULL);
219 native_tls_set(ruby_current_ec_key, NULL);
227 return ruby_vm_event_flags & event;
233 if (LIKELY(!rb_gc_event_hook_required_p(event)))
return;
236 if (!ec->cfp)
return;
238 EXEC_EVENT_HOOK(ec, event, ec->cfp->self, 0, 0, 0, obj);
242rb_gc_get_objspace(
void)
244 return GET_VM()->gc.objspace;
249rb_gc_ractor_newobj_cache_foreach(
void (*func)(
void *cache,
void *data),
void *data)
252 if (RB_LIKELY(ruby_single_main_ractor)) {
254 ccan_list_empty(&GET_VM()->ractor.set) ||
255 (ccan_list_top(&GET_VM()->ractor.set,
rb_ractor_t, vmlr_node) == ruby_single_main_ractor &&
256 ccan_list_tail(&GET_VM()->ractor.set,
rb_ractor_t, vmlr_node) == ruby_single_main_ractor)
259 func(ruby_single_main_ractor->newobj_cache, data);
262 ccan_list_for_each(&GET_VM()->ractor.set, r, vmlr_node) {
263 func(r->newobj_cache, data);
269rb_gc_run_obj_finalizer(
VALUE objid,
long count,
VALUE (*callback)(
long i,
void *data),
void *data)
280#define RESTORE_FINALIZER() (\
281 ec->cfp = saved.cfp, \
282 ec->cfp->sp = saved.sp, \
283 ec->errinfo = saved.errinfo)
285 saved.errinfo = ec->errinfo;
287 saved.sp = ec->cfp->sp;
291 rb_ractor_ignore_belonging(
true);
293 enum ruby_tag_type state = EC_EXEC_TAG();
294 if (state != TAG_NONE) {
297 VALUE failed_final = saved.final;
300 rb_warn(
"Exception in finalizer %+"PRIsVALUE, failed_final);
301 rb_ec_error_print(ec, ec->errinfo);
305 for (
long i = saved.finished; RESTORE_FINALIZER(), i < count; saved.finished = ++i) {
306 saved.final = callback(i, data);
310 rb_ractor_ignore_belonging(
false);
311#undef RESTORE_FINALIZER
315rb_gc_set_pending_interrupt(
void)
318 ec->interrupt_mask |= PENDING_INTERRUPT_MASK;
322rb_gc_unset_pending_interrupt(
void)
325 ec->interrupt_mask &= ~PENDING_INTERRUPT_MASK;
329rb_gc_multi_ractor_p(
void)
331 return rb_multi_ractor_p();
334bool rb_obj_is_main_ractor(
VALUE gv);
337rb_gc_shutdown_call_finalizer_p(
VALUE obj)
341 if (!ruby_free_at_exit_p() && (!
DATA_PTR(obj) || !
RDATA(obj)->dfree))
return false;
342 if (rb_obj_is_thread(obj))
return false;
343 if (rb_obj_is_mutex(obj))
return false;
344 if (rb_obj_is_fiber(obj))
return false;
345 if (rb_obj_is_main_ractor(obj))
return false;
346 if (rb_obj_is_fstring_table(obj))
return false;
354 if (RSYMBOL(obj)->fstr &&
357 RSYMBOL(obj)->fstr = 0;
365 return ruby_free_at_exit_p();
370rb_gc_get_shape(
VALUE obj)
372 return (uint32_t)rb_obj_shape_id(obj);
376rb_gc_set_shape(
VALUE obj, uint32_t shape_id)
378 rb_obj_set_shape_id(obj, (uint32_t)shape_id);
382rb_gc_rebuild_shape(
VALUE obj,
size_t heap_id)
386 return (uint32_t)rb_shape_transition_heap(obj, heap_id);
389void rb_vm_update_references(
void *ptr);
391#define rb_setjmp(env) RUBY_SETJMP(env)
392#define rb_jmp_buf rb_jmpbuf_t
393#undef rb_data_object_wrap
395#if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
396#define MAP_ANONYMOUS MAP_ANON
399#define unless_objspace(objspace) \
401 rb_vm_t *unless_objspace_vm = GET_VM(); \
402 if (unless_objspace_vm) objspace = unless_objspace_vm->gc.objspace; \
405#define RMOVED(obj) ((struct RMoved *)(obj))
407#define TYPED_UPDATE_IF_MOVED(_objspace, _type, _thing) do { \
408 if (rb_gc_impl_object_moved_p((_objspace), (VALUE)(_thing))) { \
409 *(_type *)&(_thing) = (_type)gc_location_internal(_objspace, (VALUE)_thing); \
413#define UPDATE_IF_MOVED(_objspace, _thing) TYPED_UPDATE_IF_MOVED(_objspace, VALUE, _thing)
415#if RUBY_MARK_FREE_DEBUG
416int ruby_gc_debug_indent = 0;
419#ifndef RGENGC_OBJ_INFO
420# define RGENGC_OBJ_INFO RGENGC_CHECK_MODE
423#ifndef CALC_EXACT_MALLOC_SIZE
424# define CALC_EXACT_MALLOC_SIZE 0
429static size_t malloc_offset = 0;
430#if defined(HAVE_MALLOC_USABLE_SIZE)
432gc_compute_malloc_offset(
void)
443 for (offset = 0; offset <= 16; offset += 8) {
444 size_t allocated = (64 - offset);
445 void *test_ptr = malloc(allocated);
446 size_t wasted = malloc_usable_size(test_ptr) - allocated;
457gc_compute_malloc_offset(
void)
465rb_malloc_grow_capa(
size_t current,
size_t type_size)
467 size_t current_capacity = current;
468 if (current_capacity < 4) {
469 current_capacity = 4;
471 current_capacity *= type_size;
474 size_t new_capacity = (current_capacity * 2);
477 if (rb_popcount64(new_capacity) != 1) {
478 new_capacity = (size_t)(1 << (64 - nlz_int64(new_capacity)));
481 new_capacity -= malloc_offset;
482 new_capacity /= type_size;
483 if (current > new_capacity) {
484 rb_bug(
"rb_malloc_grow_capa: current_capacity=%zu, new_capacity=%zu, malloc_offset=%zu", current, new_capacity, malloc_offset);
490static inline struct rbimpl_size_mul_overflow_tag
491size_mul_add_overflow(size_t x, size_t y, size_t z)
493 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(x, y);
494 struct rbimpl_size_mul_overflow_tag u = rbimpl_size_add_overflow(t.right, z);
495 return (
struct rbimpl_size_mul_overflow_tag) { t.left || u.left, u.right };
498static inline struct rbimpl_size_mul_overflow_tag
499size_mul_add_mul_overflow(size_t x, size_t y, size_t z, size_t w)
501 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(x, y);
502 struct rbimpl_size_mul_overflow_tag u = rbimpl_size_mul_overflow(z, w);
503 struct rbimpl_size_mul_overflow_tag v = rbimpl_size_add_overflow(t.right, u.right);
504 return (
struct rbimpl_size_mul_overflow_tag) { t.left || u.left || v.left, v.right };
507PRINTF_ARGS(NORETURN(
static void gc_raise(
VALUE,
const char*, ...)), 2, 3);
510size_mul_or_raise(
size_t x,
size_t y,
VALUE exc)
512 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(x, y);
513 if (LIKELY(!t.left)) {
516 else if (rb_during_gc()) {
522 "integer overflow: %"PRIuSIZE
525 x, y, (
size_t)SIZE_MAX);
530rb_size_mul_or_raise(
size_t x,
size_t y,
VALUE exc)
532 return size_mul_or_raise(x, y, exc);
536size_mul_add_or_raise(
size_t x,
size_t y,
size_t z,
VALUE exc)
538 struct rbimpl_size_mul_overflow_tag t = size_mul_add_overflow(x, y, z);
539 if (LIKELY(!t.left)) {
542 else if (rb_during_gc()) {
548 "integer overflow: %"PRIuSIZE
552 x, y, z, (
size_t)SIZE_MAX);
557rb_size_mul_add_or_raise(
size_t x,
size_t y,
size_t z,
VALUE exc)
559 return size_mul_add_or_raise(x, y, z, exc);
563size_mul_add_mul_or_raise(
size_t x,
size_t y,
size_t z,
size_t w,
VALUE exc)
565 struct rbimpl_size_mul_overflow_tag t = size_mul_add_mul_overflow(x, y, z, w);
566 if (LIKELY(!t.left)) {
569 else if (rb_during_gc()) {
575 "integer overflow: %"PRIdSIZE
580 x, y, z, w, (
size_t)SIZE_MAX);
584#if defined(HAVE_RB_GC_GUARDED_PTR_VAL) && HAVE_RB_GC_GUARDED_PTR_VAL
586volatile VALUE rb_gc_guarded_val;
588rb_gc_guarded_ptr_val(
volatile VALUE *ptr,
VALUE val)
590 rb_gc_guarded_val = val;
596static const char *obj_type_name(
VALUE obj);
597#include "gc/default/default.c"
599#if USE_MODULAR_GC && !defined(HAVE_DLOPEN)
600# error "Modular GC requires dlopen"
604typedef struct gc_function_map {
606 void *(*objspace_alloc)(void);
607 void (*objspace_init)(
void *objspace_ptr);
608 void *(*ractor_cache_alloc)(
void *objspace_ptr,
void *ractor);
609 void (*set_params)(
void *objspace_ptr);
611 size_t *(*heap_sizes)(
void *objspace_ptr);
613 void (*shutdown_free_objects)(
void *objspace_ptr);
614 void (*objspace_free)(
void *objspace_ptr);
615 void (*ractor_cache_free)(
void *objspace_ptr,
void *cache);
617 void (*start)(
void *objspace_ptr,
bool full_mark,
bool immediate_mark,
bool immediate_sweep,
bool compact);
618 bool (*during_gc_p)(
void *objspace_ptr);
619 void (*prepare_heap)(
void *objspace_ptr);
620 void (*gc_enable)(
void *objspace_ptr);
621 void (*gc_disable)(
void *objspace_ptr,
bool finish_current_gc);
622 bool (*gc_enabled_p)(
void *objspace_ptr);
623 VALUE (*config_get)(
void *objpace_ptr);
624 void (*config_set)(
void *objspace_ptr,
VALUE hash);
625 void (*stress_set)(
void *objspace_ptr,
VALUE flag);
626 VALUE (*stress_get)(
void *objspace_ptr);
628 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);
629 size_t (*obj_slot_size)(
VALUE obj);
630 size_t (*heap_id_for_size)(
void *objspace_ptr,
size_t size);
631 bool (*size_allocatable_p)(
size_t size);
633 void *(*malloc)(
void *objspace_ptr,
size_t size);
634 void *(*calloc)(
void *objspace_ptr,
size_t size);
635 void *(*realloc)(
void *objspace_ptr,
void *ptr,
size_t new_size,
size_t old_size);
636 void (*free)(
void *objspace_ptr,
void *ptr,
size_t old_size);
637 void (*adjust_memory_usage)(
void *objspace_ptr, ssize_t diff);
639 void (*mark)(
void *objspace_ptr,
VALUE obj);
640 void (*mark_and_move)(
void *objspace_ptr,
VALUE *ptr);
641 void (*mark_and_pin)(
void *objspace_ptr,
VALUE obj);
642 void (*mark_maybe)(
void *objspace_ptr,
VALUE obj);
643 void (*mark_weak)(
void *objspace_ptr,
VALUE *ptr);
644 void (*remove_weak)(
void *objspace_ptr,
VALUE parent_obj,
VALUE *ptr);
646 bool (*object_moved_p)(
void *objspace_ptr,
VALUE obj);
647 VALUE (*location)(
void *objspace_ptr,
VALUE value);
649 void (*writebarrier)(
void *objspace_ptr,
VALUE a,
VALUE b);
650 void (*writebarrier_unprotect)(
void *objspace_ptr,
VALUE obj);
651 void (*writebarrier_remember)(
void *objspace_ptr,
VALUE obj);
653 void (*each_objects)(
void *objspace_ptr, int (*callback)(
void *,
void *, size_t,
void *),
void *data);
654 void (*each_object)(
void *objspace_ptr, void (*func)(
VALUE obj,
void *data),
void *data);
656 void (*make_zombie)(
void *objspace_ptr,
VALUE obj, void (*dfree)(
void *),
void *data);
658 void (*undefine_finalizer)(
void *objspace_ptr,
VALUE obj);
659 void (*copy_finalizer)(
void *objspace_ptr,
VALUE dest,
VALUE obj);
660 void (*shutdown_call_finalizer)(
void *objspace_ptr);
662 void (*before_fork)(
void *objspace_ptr);
663 void (*after_fork)(
void *objspace_ptr, rb_pid_t pid);
665 void (*set_measure_total_time)(
void *objspace_ptr,
VALUE flag);
666 bool (*get_measure_total_time)(
void *objspace_ptr);
667 unsigned long long (*get_total_time)(
void *objspace_ptr);
668 size_t (*gc_count)(
void *objspace_ptr);
669 VALUE (*latest_gc_info)(
void *objspace_ptr,
VALUE key);
670 VALUE (*stat)(
void *objspace_ptr,
VALUE hash_or_sym);
671 VALUE (*stat_heap)(
void *objspace_ptr,
VALUE heap_name,
VALUE hash_or_sym);
672 const char *(*active_gc_name)(void);
675 bool (*pointer_to_heap_p)(
void *objspace_ptr,
const void *ptr);
676 bool (*garbage_object_p)(
void *objspace_ptr,
VALUE obj);
677 void (*set_event_hook)(
void *objspace_ptr,
const rb_event_flag_t event);
678 void (*copy_attributes)(
void *objspace_ptr,
VALUE dest,
VALUE obj);
680 bool modular_gc_loaded_p;
681} rb_gc_function_map_t;
683static rb_gc_function_map_t rb_gc_functions;
685# define RUBY_GC_LIBRARY "RUBY_GC_LIBRARY"
686# define MODULAR_GC_DIR STRINGIZE(modular_gc_dir)
689ruby_modular_gc_init(
void)
694 const char *gc_so_file = getenv(RUBY_GC_LIBRARY);
696 rb_gc_function_map_t gc_functions = { 0 };
698 char *gc_so_path = NULL;
703 for (
size_t i = 0; i < strlen(gc_so_file); i++) {
704 char c = gc_so_file[i];
705 if (isalnum(c))
continue;
711 fprintf(stderr,
"Only alphanumeric, dash, and underscore is allowed in "RUBY_GC_LIBRARY
"\n");
716 size_t gc_so_path_size = strlen(MODULAR_GC_DIR
"librubygc." DLEXT) + strlen(gc_so_file) + 1;
719 size_t prefix_len = 0;
720 if (dladdr((
void *)(uintptr_t)ruby_modular_gc_init, &dli)) {
721 const char *base = strrchr(dli.dli_fname,
'/');
724# define end_with_p(lit) \
725 (prefix_len >= (tail = rb_strlen_lit(lit)) && \
726 memcmp(base - tail, lit, tail) == 0)
728 prefix_len = base - dli.dli_fname;
729 if (end_with_p(
"/bin") || end_with_p(
"/lib")) {
732 prefix_len += MODULAR_GC_DIR[0] !=
'/';
733 gc_so_path_size += prefix_len;
737 gc_so_path = alloca(gc_so_path_size);
739 size_t gc_so_path_idx = 0;
740#define GC_SO_PATH_APPEND(str) do { \
741 gc_so_path_idx += strlcpy(gc_so_path + gc_so_path_idx, str, gc_so_path_size - gc_so_path_idx); \
744 if (prefix_len > 0) {
745 memcpy(gc_so_path, dli.dli_fname, prefix_len);
746 gc_so_path_idx = prefix_len;
749 GC_SO_PATH_APPEND(MODULAR_GC_DIR
"librubygc.");
750 GC_SO_PATH_APPEND(gc_so_file);
751 GC_SO_PATH_APPEND(DLEXT);
752 GC_ASSERT(gc_so_path_idx == gc_so_path_size - 1);
753#undef GC_SO_PATH_APPEND
756 handle = dlopen(gc_so_path, RTLD_LAZY | RTLD_GLOBAL);
758 fprintf(stderr,
"ruby_modular_gc_init: Shared library %s cannot be opened: %s\n", gc_so_path, dlerror());
762 gc_functions.modular_gc_loaded_p =
true;
765# define load_modular_gc_func(name) do { \
767 const char *func_name = "rb_gc_impl_" #name; \
768 gc_functions.name = dlsym(handle, func_name); \
769 if (!gc_functions.name) { \
770 fprintf(stderr, "ruby_modular_gc_init: %s function not exported by library %s\n", func_name, gc_so_path); \
775 gc_functions.name = rb_gc_impl_##name; \
780 load_modular_gc_func(objspace_alloc);
781 load_modular_gc_func(objspace_init);
782 load_modular_gc_func(ractor_cache_alloc);
783 load_modular_gc_func(set_params);
784 load_modular_gc_func(init);
785 load_modular_gc_func(heap_sizes);
787 load_modular_gc_func(shutdown_free_objects);
788 load_modular_gc_func(objspace_free);
789 load_modular_gc_func(ractor_cache_free);
791 load_modular_gc_func(start);
792 load_modular_gc_func(during_gc_p);
793 load_modular_gc_func(prepare_heap);
794 load_modular_gc_func(gc_enable);
795 load_modular_gc_func(gc_disable);
796 load_modular_gc_func(gc_enabled_p);
797 load_modular_gc_func(config_set);
798 load_modular_gc_func(config_get);
799 load_modular_gc_func(stress_set);
800 load_modular_gc_func(stress_get);
802 load_modular_gc_func(new_obj);
803 load_modular_gc_func(obj_slot_size);
804 load_modular_gc_func(heap_id_for_size);
805 load_modular_gc_func(size_allocatable_p);
807 load_modular_gc_func(malloc);
808 load_modular_gc_func(calloc);
809 load_modular_gc_func(realloc);
810 load_modular_gc_func(free);
811 load_modular_gc_func(adjust_memory_usage);
813 load_modular_gc_func(mark);
814 load_modular_gc_func(mark_and_move);
815 load_modular_gc_func(mark_and_pin);
816 load_modular_gc_func(mark_maybe);
817 load_modular_gc_func(mark_weak);
818 load_modular_gc_func(remove_weak);
820 load_modular_gc_func(object_moved_p);
821 load_modular_gc_func(location);
823 load_modular_gc_func(writebarrier);
824 load_modular_gc_func(writebarrier_unprotect);
825 load_modular_gc_func(writebarrier_remember);
827 load_modular_gc_func(each_objects);
828 load_modular_gc_func(each_object);
830 load_modular_gc_func(make_zombie);
831 load_modular_gc_func(define_finalizer);
832 load_modular_gc_func(undefine_finalizer);
833 load_modular_gc_func(copy_finalizer);
834 load_modular_gc_func(shutdown_call_finalizer);
836 load_modular_gc_func(before_fork);
837 load_modular_gc_func(after_fork);
839 load_modular_gc_func(set_measure_total_time);
840 load_modular_gc_func(get_measure_total_time);
841 load_modular_gc_func(get_total_time);
842 load_modular_gc_func(gc_count);
843 load_modular_gc_func(latest_gc_info);
844 load_modular_gc_func(stat);
845 load_modular_gc_func(stat_heap);
846 load_modular_gc_func(active_gc_name);
848 load_modular_gc_func(object_metadata);
849 load_modular_gc_func(pointer_to_heap_p);
850 load_modular_gc_func(garbage_object_p);
851 load_modular_gc_func(set_event_hook);
852 load_modular_gc_func(copy_attributes);
854# undef load_modular_gc_func
856 rb_gc_functions = gc_functions;
860# define rb_gc_impl_objspace_alloc rb_gc_functions.objspace_alloc
861# define rb_gc_impl_objspace_init rb_gc_functions.objspace_init
862# define rb_gc_impl_ractor_cache_alloc rb_gc_functions.ractor_cache_alloc
863# define rb_gc_impl_set_params rb_gc_functions.set_params
864# define rb_gc_impl_init rb_gc_functions.init
865# define rb_gc_impl_heap_sizes rb_gc_functions.heap_sizes
867# define rb_gc_impl_shutdown_free_objects rb_gc_functions.shutdown_free_objects
868# define rb_gc_impl_objspace_free rb_gc_functions.objspace_free
869# define rb_gc_impl_ractor_cache_free rb_gc_functions.ractor_cache_free
871# define rb_gc_impl_start rb_gc_functions.start
872# define rb_gc_impl_during_gc_p rb_gc_functions.during_gc_p
873# define rb_gc_impl_prepare_heap rb_gc_functions.prepare_heap
874# define rb_gc_impl_gc_enable rb_gc_functions.gc_enable
875# define rb_gc_impl_gc_disable rb_gc_functions.gc_disable
876# define rb_gc_impl_gc_enabled_p rb_gc_functions.gc_enabled_p
877# define rb_gc_impl_config_get rb_gc_functions.config_get
878# define rb_gc_impl_config_set rb_gc_functions.config_set
879# define rb_gc_impl_stress_set rb_gc_functions.stress_set
880# define rb_gc_impl_stress_get rb_gc_functions.stress_get
882# define rb_gc_impl_new_obj rb_gc_functions.new_obj
883# define rb_gc_impl_obj_slot_size rb_gc_functions.obj_slot_size
884# define rb_gc_impl_heap_id_for_size rb_gc_functions.heap_id_for_size
885# define rb_gc_impl_size_allocatable_p rb_gc_functions.size_allocatable_p
887# define rb_gc_impl_malloc rb_gc_functions.malloc
888# define rb_gc_impl_calloc rb_gc_functions.calloc
889# define rb_gc_impl_realloc rb_gc_functions.realloc
890# define rb_gc_impl_free rb_gc_functions.free
891# define rb_gc_impl_adjust_memory_usage rb_gc_functions.adjust_memory_usage
893# define rb_gc_impl_mark rb_gc_functions.mark
894# define rb_gc_impl_mark_and_move rb_gc_functions.mark_and_move
895# define rb_gc_impl_mark_and_pin rb_gc_functions.mark_and_pin
896# define rb_gc_impl_mark_maybe rb_gc_functions.mark_maybe
897# define rb_gc_impl_mark_weak rb_gc_functions.mark_weak
898# define rb_gc_impl_remove_weak rb_gc_functions.remove_weak
900# define rb_gc_impl_object_moved_p rb_gc_functions.object_moved_p
901# define rb_gc_impl_location rb_gc_functions.location
903# define rb_gc_impl_writebarrier rb_gc_functions.writebarrier
904# define rb_gc_impl_writebarrier_unprotect rb_gc_functions.writebarrier_unprotect
905# define rb_gc_impl_writebarrier_remember rb_gc_functions.writebarrier_remember
907# define rb_gc_impl_each_objects rb_gc_functions.each_objects
908# define rb_gc_impl_each_object rb_gc_functions.each_object
910# define rb_gc_impl_make_zombie rb_gc_functions.make_zombie
911# define rb_gc_impl_define_finalizer rb_gc_functions.define_finalizer
912# define rb_gc_impl_undefine_finalizer rb_gc_functions.undefine_finalizer
913# define rb_gc_impl_copy_finalizer rb_gc_functions.copy_finalizer
914# define rb_gc_impl_shutdown_call_finalizer rb_gc_functions.shutdown_call_finalizer
916# define rb_gc_impl_before_fork rb_gc_functions.before_fork
917# define rb_gc_impl_after_fork rb_gc_functions.after_fork
919# define rb_gc_impl_set_measure_total_time rb_gc_functions.set_measure_total_time
920# define rb_gc_impl_get_measure_total_time rb_gc_functions.get_measure_total_time
921# define rb_gc_impl_get_total_time rb_gc_functions.get_total_time
922# define rb_gc_impl_gc_count rb_gc_functions.gc_count
923# define rb_gc_impl_latest_gc_info rb_gc_functions.latest_gc_info
924# define rb_gc_impl_stat rb_gc_functions.stat
925# define rb_gc_impl_stat_heap rb_gc_functions.stat_heap
926# define rb_gc_impl_active_gc_name rb_gc_functions.active_gc_name
928# define rb_gc_impl_object_metadata rb_gc_functions.object_metadata
929# define rb_gc_impl_pointer_to_heap_p rb_gc_functions.pointer_to_heap_p
930# define rb_gc_impl_garbage_object_p rb_gc_functions.garbage_object_p
931# define rb_gc_impl_set_event_hook rb_gc_functions.set_event_hook
932# define rb_gc_impl_copy_attributes rb_gc_functions.copy_attributes
935#ifdef RUBY_ASAN_ENABLED
937asan_death_callback(
void)
940 rb_bug_without_die(
"ASAN error");
948rb_objspace_alloc(
void)
951 ruby_modular_gc_init();
954 void *
objspace = rb_gc_impl_objspace_alloc();
955 ruby_current_vm_ptr->gc.objspace =
objspace;
957 rb_gc_impl_stress_set(
objspace, initial_stress);
959#ifdef RUBY_ASAN_ENABLED
960 __sanitizer_set_death_callback(asan_death_callback);
973rb_gc_obj_slot_size(
VALUE obj)
975 return rb_gc_impl_obj_slot_size(obj);
984 if (cfp && VM_FRAME_RUBYFRAME_P(cfp) && cfp->pc) {
985 RUBY_ASSERT(cfp->pc >= ISEQ_BODY(cfp->iseq)->iseq_encoded);
986 RUBY_ASSERT(cfp->pc <= ISEQ_BODY(cfp->iseq)->iseq_encoded + ISEQ_BODY(cfp->iseq)->iseq_size);
994 VALUE obj = rb_gc_impl_new_obj(rb_gc_get_objspace(), cr->newobj_cache, klass, flags, v1, v2, v3, wb_protected, size);
1000 RB_VM_LOCK_ENTER_CR_LEV(cr, &lev);
1002 memset((
char *)obj + RVALUE_SIZE, 0, rb_gc_obj_slot_size(obj) - RVALUE_SIZE);
1009 bool gc_disabled =
RTEST(rb_gc_disable_no_rest());
1013 if (!gc_disabled) rb_gc_enable();
1015 RB_VM_LOCK_LEAVE_CR_LEV(cr, &lev);
1022rb_wb_unprotected_newobj_of(
VALUE klass,
VALUE flags,
size_t size)
1025 return newobj_of(GET_RACTOR(), klass, flags, 0, 0, 0, FALSE, size);
1032 return newobj_of(rb_ec_ractor_ptr(ec), klass, flags, 0, 0, 0, TRUE, size);
1035#define UNEXPECTED_NODE(func) \
1036 rb_bug(#func"(): GC does not handle T_NODE 0x%x(%p) 0x%"PRIxVALUE, \
1037 BUILTIN_TYPE(obj), (void*)(obj), RBASIC(obj)->flags)
1040rb_data_object_check(
VALUE klass)
1042 if (klass != rb_cObject && (
rb_get_alloc_func(klass) == rb_class_allocate_instance)) {
1044 rb_warn(
"undefining the allocator of T_DATA class %"PRIsVALUE, klass);
1052 if (klass) rb_data_object_check(klass);
1059 VALUE obj = rb_data_object_wrap(klass, 0, dmark, dfree);
1067 RBIMPL_NONNULL_ARG(
type);
1068 if (klass) rb_data_object_check(klass);
1070 return newobj_of(GET_RACTOR(), klass,
T_DATA, ((
VALUE)
type) | IS_TYPED_DATA | typed_flag, (
VALUE)datap, 0, wb_protected, size);
1076 if (UNLIKELY(
type->flags & RUBY_TYPED_EMBEDDABLE)) {
1077 rb_raise(
rb_eTypeError,
"Cannot wrap an embeddable TypedData");
1080 return typed_data_alloc(klass, 0, datap,
type,
sizeof(
struct RTypedData));
1086 if (
type->flags & RUBY_TYPED_EMBEDDABLE) {
1087 if (!(
type->flags & RUBY_TYPED_FREE_IMMEDIATELY)) {
1088 rb_raise(
rb_eTypeError,
"Embeddable TypedData must be freed immediately");
1091 size_t embed_size = offsetof(
struct RTypedData, data) + size;
1092 if (rb_gc_size_allocatable_p(embed_size)) {
1093 VALUE obj = typed_data_alloc(klass, TYPED_DATA_EMBEDDED, 0,
type, embed_size);
1094 memset((
char *)obj + offsetof(
struct RTypedData, data), 0, size);
1105rb_objspace_data_type_memsize(
VALUE obj)
1110 const void *ptr = RTYPEDDATA_GET_DATA(obj);
1112 if (
RTYPEDDATA_TYPE(obj)->flags & RUBY_TYPED_EMBEDDABLE && !RTYPEDDATA_EMBEDDED_P(obj)) {
1113#ifdef HAVE_MALLOC_USABLE_SIZE
1114 size += malloc_usable_size((
void *)ptr);
1118 if (ptr &&
type->function.dsize) {
1119 size +=
type->function.dsize(ptr);
1127rb_objspace_data_type_name(
VALUE obj)
1137static enum rb_id_table_iterator_result
1138cvar_table_free_i(
VALUE value,
void *ctx)
1140 xfree((
void *)value);
1141 return ID_TABLE_CONTINUE;
1145io_fptr_finalize(
void *fptr)
1154 rb_gc_impl_make_zombie(
objspace, obj, io_fptr_finalize, fptr);
1162 int free_immediately =
false;
1163 void (*dfree)(
void *);
1170 dfree =
RDATA(obj)->dfree;
1175 if (!
RTYPEDDATA_P(obj) || !RTYPEDDATA_EMBEDDED_P(obj)) {
1177 RB_DEBUG_COUNTER_INC(obj_data_xfree);
1180 else if (free_immediately) {
1186 RB_DEBUG_COUNTER_INC(obj_data_imm_free);
1189 rb_gc_impl_make_zombie(
objspace, obj, dfree, data);
1190 RB_DEBUG_COUNTER_INC(obj_data_zombie);
1195 RB_DEBUG_COUNTER_INC(obj_data_empty);
1213 rb_id_table_free(RCLASSEXT_M_TBL(ext));
1214 rb_cc_tbl_free(RCLASSEXT_CC_TBL(ext), args->klass);
1215 if (!RCLASSEXT_SHARED_CONST_TBL(ext) && (tbl = RCLASSEXT_CONST_TBL(ext)) != NULL) {
1216 rb_free_const_table(tbl);
1218 if ((tbl = RCLASSEXT_CVC_TBL(ext)) != NULL) {
1219 rb_id_table_foreach_values(tbl, cvar_table_free_i, NULL);
1220 rb_id_table_free(tbl);
1222 rb_class_classext_free_subclasses(ext, args->klass);
1223 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
1225 xfree(RCLASSEXT_SUPERCLASSES(ext));
1237 if (RCLASSEXT_ICLASS_IS_ORIGIN(ext) && !RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext)) {
1239 rb_id_table_free(RCLASSEXT_M_TBL(ext));
1241 if (RCLASSEXT_CALLABLE_M_TBL(ext) != NULL) {
1242 rb_id_table_free(RCLASSEXT_CALLABLE_M_TBL(ext));
1244 rb_cc_tbl_free(RCLASSEXT_CC_TBL(ext), args->klass);
1246 rb_class_classext_free_subclasses(ext, args->klass);
1258 RB_DEBUG_COUNTER_INC(obj_free);
1265 rb_bug(
"obj_free() called for broken object");
1273 if (rb_shape_obj_too_complex_p(obj)) {
1274 RB_DEBUG_COUNTER_INC(obj_obj_too_complex);
1275 st_free_table(ROBJECT_FIELDS_HASH(obj));
1277 else if (
RBASIC(obj)->flags & ROBJECT_EMBED) {
1278 RB_DEBUG_COUNTER_INC(obj_obj_embed);
1282 RB_DEBUG_COUNTER_INC(obj_obj_ptr);
1288 rb_class_classext_foreach(obj, classext_free, (
void *)&args);
1289 if (RCLASS_CLASSEXT_TBL(obj)) {
1290 st_free_table(RCLASS_CLASSEXT_TBL(obj));
1302#if USE_DEBUG_COUNTER
1305 RB_DEBUG_COUNTER_INC(obj_hash_empty);
1308 RB_DEBUG_COUNTER_INC(obj_hash_1);
1311 RB_DEBUG_COUNTER_INC(obj_hash_2);
1314 RB_DEBUG_COUNTER_INC(obj_hash_3);
1317 RB_DEBUG_COUNTER_INC(obj_hash_4);
1323 RB_DEBUG_COUNTER_INC(obj_hash_5_8);
1327 RB_DEBUG_COUNTER_INC(obj_hash_g8);
1330 if (RHASH_AR_TABLE_P(obj)) {
1331 if (RHASH_AR_TABLE(obj) == NULL) {
1332 RB_DEBUG_COUNTER_INC(obj_hash_null);
1335 RB_DEBUG_COUNTER_INC(obj_hash_ar);
1339 RB_DEBUG_COUNTER_INC(obj_hash_st);
1348 RB_DEBUG_COUNTER_INC(obj_regexp_ptr);
1352 if (!rb_data_free(
objspace, obj))
return false;
1357#if USE_DEBUG_COUNTER
1358 if (rm->
regs.num_regs >= 8) {
1359 RB_DEBUG_COUNTER_INC(obj_match_ge8);
1361 else if (rm->
regs.num_regs >= 4) {
1362 RB_DEBUG_COUNTER_INC(obj_match_ge4);
1364 else if (rm->
regs.num_regs >= 1) {
1365 RB_DEBUG_COUNTER_INC(obj_match_under4);
1368 onig_region_free(&rm->
regs, 0);
1371 RB_DEBUG_COUNTER_INC(obj_match_ptr);
1375 if (
RFILE(obj)->fptr) {
1377 RB_DEBUG_COUNTER_INC(obj_file_ptr);
1382 RB_DEBUG_COUNTER_INC(obj_rational);
1385 RB_DEBUG_COUNTER_INC(obj_complex);
1392 rb_class_classext_foreach(obj, classext_iclass_free, (
void *)&args);
1393 if (RCLASS_CLASSEXT_TBL(obj)) {
1394 st_free_table(RCLASS_CLASSEXT_TBL(obj));
1397 RB_DEBUG_COUNTER_INC(obj_iclass_ptr);
1401 RB_DEBUG_COUNTER_INC(obj_float);
1405 if (!BIGNUM_EMBED_P(obj) && BIGNUM_DIGITS(obj)) {
1406 xfree(BIGNUM_DIGITS(obj));
1407 RB_DEBUG_COUNTER_INC(obj_bignum_ptr);
1410 RB_DEBUG_COUNTER_INC(obj_bignum_embed);
1415 UNEXPECTED_NODE(obj_free);
1419 if ((
RBASIC(obj)->flags & RSTRUCT_EMBED_LEN_MASK) ||
1420 RSTRUCT(obj)->as.heap.ptr == NULL) {
1421 RB_DEBUG_COUNTER_INC(obj_struct_embed);
1424 xfree((
void *)RSTRUCT(obj)->as.heap.ptr);
1425 RB_DEBUG_COUNTER_INC(obj_struct_ptr);
1430 RB_DEBUG_COUNTER_INC(obj_symbol);
1434 rb_imemo_free((
VALUE)obj);
1438 rb_bug(
"gc_sweep(): unknown data type 0x%x(%p) 0x%"PRIxVALUE,
1443 rb_gc_impl_make_zombie(
objspace, obj, 0, 0);
1454 rb_gc_impl_set_event_hook(rb_gc_get_objspace(), event);
1458internal_object_p(
VALUE obj)
1460 void *ptr = asan_unpoison_object_temporary(obj);
1462 if (
RBASIC(obj)->flags) {
1465 UNEXPECTED_NODE(internal_object_p);
1474 if (obj == rb_mRubyVMFrozenCore)
1478 if (RCLASS_SINGLETON_P(obj)) {
1479 return rb_singleton_class_internal_p(obj);
1483 if (!
RBASIC(obj)->klass)
break;
1487 if (ptr || !
RBASIC(obj)->flags) {
1488 rb_asan_poison_object(obj);
1494rb_objspace_internal_object_p(
VALUE obj)
1496 return internal_object_p(obj);
1505os_obj_of_i(
void *vstart,
void *vend,
size_t stride,
void *data)
1510 for (; v != (
VALUE)vend; v += stride) {
1511 if (!internal_object_p(v)) {
1531 rb_objspace_each_objects(os_obj_of_i, &oes);
1590 return os_obj_of(of);
1604 return rb_undefine_finalizer(obj);
1610 rb_check_frozen(obj);
1612 rb_gc_impl_undefine_finalizer(rb_gc_get_objspace(), obj);
1618should_be_callable(
VALUE block)
1621 rb_raise(rb_eArgError,
"wrong type argument %"PRIsVALUE
" (should be callable)",
1627should_be_finalizable(
VALUE obj)
1630 rb_raise(rb_eArgError,
"cannot define finalizer for %s",
1633 rb_check_frozen(obj);
1639 rb_gc_impl_copy_finalizer(rb_gc_get_objspace(), dest, obj);
1714 if (rb_callable_receiver(block) == obj) {
1715 rb_warn(
"finalizer references object to be finalized");
1718 return rb_define_finalizer(obj, block);
1724 should_be_finalizable(obj);
1725 should_be_callable(block);
1727 block = rb_gc_impl_define_finalizer(rb_gc_get_objspace(), obj, block);
1735rb_objspace_call_finalizer(
void)
1737 rb_gc_impl_shutdown_call_finalizer(rb_gc_get_objspace());
1741rb_objspace_free_objects(
void *
objspace)
1743 rb_gc_impl_shutdown_free_objects(
objspace);
1747rb_objspace_garbage_object_p(
VALUE obj)
1749 return rb_gc_impl_garbage_object_p(rb_gc_get_objspace(), obj);
1753rb_gc_pointer_to_heap_p(
VALUE obj)
1755 return rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (
void *)obj);
1758#define OBJ_ID_INCREMENT (RUBY_IMMEDIATE_MASK + 1)
1759#define LAST_OBJECT_ID() (object_id_counter * OBJ_ID_INCREMENT)
1760static VALUE id2ref_value = 0;
1762static bool id2ref_tbl_built =
false;
1764#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
1765static size_t object_id_counter = 1;
1767static unsigned long long object_id_counter = 1;
1771generate_next_object_id(
void)
1773#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
1777 unsigned int lock_lev = RB_GC_VM_LOCK();
1778 VALUE id =
ULL2NUM(++object_id_counter * OBJ_ID_INCREMENT);
1779 RB_GC_VM_UNLOCK(lock_lev);
1785rb_gc_obj_id_moved(
VALUE obj)
1787 if (UNLIKELY(id2ref_tbl)) {
1788 st_insert(id2ref_tbl, (st_data_t)rb_obj_id(obj), (st_data_t)obj);
1793object_id_cmp(st_data_t x, st_data_t y)
1796 return !rb_big_eql(x, y);
1804object_id_hash(st_data_t n)
1809static const struct st_hash_type object_id_hash_type = {
1814static void gc_mark_tbl_no_pin(
st_table *table);
1817id2ref_tbl_mark(
void *data)
1829id2ref_tbl_memsize(
const void *data)
1831 return rb_st_memsize(data);
1835id2ref_tbl_free(
void *data)
1839 st_free_table(table);
1845 .dmark = id2ref_tbl_mark,
1846 .dfree = id2ref_tbl_free,
1847 .dsize = id2ref_tbl_memsize,
1851 .flags = RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_FREE_IMMEDIATELY
1855class_object_id(
VALUE klass)
1857 VALUE id = RUBY_ATOMIC_VALUE_LOAD(
RCLASS(klass)->object_id);
1859 unsigned int lock_lev = RB_GC_VM_LOCK();
1860 id = generate_next_object_id();
1865 else if (RB_UNLIKELY(id2ref_tbl)) {
1866 st_insert(id2ref_tbl,
id, klass);
1868 RB_GC_VM_UNLOCK(lock_lev);
1874object_id_get(
VALUE obj, shape_id_t shape_id)
1877 if (rb_shape_too_complex_p(shape_id)) {
1878 id = rb_obj_field_get(obj, ROOT_TOO_COMPLEX_WITH_OBJ_ID);
1881 id = rb_obj_field_get(obj, rb_shape_object_id(shape_id));
1887 rb_bug(
"Object's shape includes object_id, but it's missing %s", rb_obj_info(obj));
1895object_id0(
VALUE obj)
1898 shape_id_t shape_id = RBASIC_SHAPE_ID(obj);
1900 if (rb_shape_has_object_id(shape_id)) {
1901 return object_id_get(obj, shape_id);
1906 shape_id_t object_id_shape_id = rb_shape_transition_object_id(obj);
1908 id = generate_next_object_id();
1909 rb_obj_field_set(obj, object_id_shape_id,
id);
1911 RUBY_ASSERT(RBASIC_SHAPE_ID(obj) == object_id_shape_id);
1914 if (RB_UNLIKELY(id2ref_tbl)) {
1915 st_insert(id2ref_tbl, (st_data_t)
id, (st_data_t)obj);
1929 return class_object_id(obj);
1931 rb_bug(
"T_IMEMO can't have an object_id");
1938 unsigned int lock_lev = RB_GC_VM_LOCK();
1939 VALUE id = object_id0(obj);
1940 RB_GC_VM_UNLOCK(lock_lev);
1944 return object_id0(obj);
1948build_id2ref_i(
VALUE obj,
void *data)
1955 if (
RCLASS(obj)->object_id) {
1956 st_insert(id2ref_tbl,
RCLASS(obj)->object_id, obj);
1963 if (rb_shape_obj_has_id(obj)) {
1964 st_insert(id2ref_tbl, rb_obj_id(obj), obj);
1971object_id_to_ref(
void *objspace_ptr,
VALUE object_id)
1975 unsigned int lev = RB_GC_VM_LOCK();
1983 id2ref_tbl = st_init_table(&object_id_hash_type);
1988 bool gc_disabled =
RTEST(rb_gc_disable_no_rest());
1990 rb_gc_impl_each_object(
objspace, build_id2ref_i, (
void *)id2ref_tbl);
1992 if (!gc_disabled) rb_gc_enable();
1993 id2ref_tbl_built =
true;
1997 bool found = st_lookup(id2ref_tbl, object_id, &obj) && !rb_gc_impl_garbage_object_p(
objspace, obj);
1999 RB_GC_VM_UNLOCK(lev);
2014obj_free_object_id(
VALUE obj)
2017 if (RB_UNLIKELY(id2ref_tbl)) {
2021 obj_id =
RCLASS(obj)->object_id;
2024 if (!IMEMO_TYPE_P(obj, imemo_fields)) {
2030 shape_id_t shape_id = RBASIC_SHAPE_ID(obj);
2031 if (rb_shape_has_object_id(shape_id)) {
2032 obj_id = object_id_get(obj, shape_id);
2041 if (RB_UNLIKELY(obj_id)) {
2044 if (!st_delete(id2ref_tbl, (st_data_t *)&obj_id, NULL)) {
2049 rb_bug(
"Object ID seen, but not in _id2ref table: object_id=%llu object=%s",
NUM2ULL(obj_id), rb_obj_info(obj));
2057rb_gc_obj_free_vm_weak_references(
VALUE obj)
2059 obj_free_object_id(obj);
2061 if (rb_obj_exivar_p(obj)) {
2068 rb_gc_free_fstring(obj);
2072 rb_gc_free_dsymbol(obj);
2075 switch (imemo_type(obj)) {
2076 case imemo_callcache: {
2079 if (vm_cc_refinement_p(cc)) {
2080 rb_vm_delete_cc_refinement(cc);
2085 case imemo_callinfo:
2120#if SIZEOF_LONG == SIZEOF_VOIDP
2121#define NUM2PTR(x) NUM2ULONG(x)
2122#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
2123#define NUM2PTR(x) NUM2ULL(x)
2126 if (
FIXNUM_P(objid) || rb_big_size(objid) <= SIZEOF_VOIDP) {
2127 VALUE ptr = NUM2PTR(objid);
2137 if (rb_static_id_valid_p(
SYM2ID(ptr))) {
2141 rb_raise(
rb_eRangeError,
"%p is not a symbol id value", (
void *)ptr);
2145 rb_raise(
rb_eRangeError,
"%+"PRIsVALUE
" is not an id value", rb_int2str(objid, 10));
2149 VALUE obj = object_id_to_ref(rb_gc_get_objspace(), objid);
2154 rb_raise(
rb_eRangeError,
"%+"PRIsVALUE
" is the id of an unshareable object on multi-ractor", rb_int2str(objid, 10));
2163 return id2ref(objid);
2170#if SIZEOF_LONG == SIZEOF_VOIDP
2177 return get_heap_object_id(obj);
2181nonspecial_obj_id(
VALUE obj)
2183#if SIZEOF_LONG == SIZEOF_VOIDP
2185#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
2188# error not supported
2195 return rb_find_object_id(NULL, obj, nonspecial_obj_id);
2232 return rb_find_object_id(rb_gc_get_objspace(), obj, object_id);
2236rb_obj_id_p(
VALUE obj)
2241static enum rb_id_table_iterator_result
2242cc_table_memsize_i(
VALUE ccs_ptr,
void *data_ptr)
2244 size_t *total_size = data_ptr;
2246 *total_size +=
sizeof(*ccs);
2247 *total_size +=
sizeof(ccs->entries[0]) * ccs->capa;
2248 return ID_TABLE_CONTINUE;
2254 size_t total = rb_id_table_memsize(cc_table);
2255 rb_id_table_foreach_values(cc_table, cc_table_memsize_i, &total);
2262 size_t *size = (
size_t *)arg;
2265 if (RCLASSEXT_M_TBL(ext)) {
2266 s += rb_id_table_memsize(RCLASSEXT_M_TBL(ext));
2268 if (RCLASSEXT_CVC_TBL(ext)) {
2269 s += rb_id_table_memsize(RCLASSEXT_CVC_TBL(ext));
2271 if (RCLASSEXT_CONST_TBL(ext)) {
2272 s += rb_id_table_memsize(RCLASSEXT_CONST_TBL(ext));
2274 if (RCLASSEXT_CC_TBL(ext)) {
2275 s += cc_table_memsize(RCLASSEXT_CC_TBL(ext));
2277 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
2278 s += (RCLASSEXT_SUPERCLASS_DEPTH(ext) + 1) *
sizeof(
VALUE);
2287classext_superclasses_memsize(
rb_classext_t *ext,
bool prime,
VALUE namespace,
void *arg)
2289 size_t *size = (
size_t *)arg;
2291 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
2293 array_size = RCLASSEXT_SUPERCLASS_DEPTH(ext) + 1;
2294 *size += array_size *
sizeof(
VALUE);
2299rb_obj_memsize_of(
VALUE obj)
2309 if (rb_shape_obj_too_complex_p(obj)) {
2310 size += rb_st_memsize(ROBJECT_FIELDS_HASH(obj));
2312 else if (!(
RBASIC(obj)->flags & ROBJECT_EMBED)) {
2313 size += ROBJECT_FIELDS_CAPACITY(obj) *
sizeof(
VALUE);
2318 rb_class_classext_foreach(obj, classext_memsize, (
void *)&size);
2319 rb_class_classext_foreach(obj, classext_superclasses_memsize, (
void *)&size);
2322 if (RICLASS_OWNS_M_TBL_P(obj)) {
2323 if (RCLASS_M_TBL(obj)) {
2324 size += rb_id_table_memsize(RCLASS_M_TBL(obj));
2327 if (RCLASS_WRITABLE_CC_TBL(obj)) {
2328 size += cc_table_memsize(RCLASS_WRITABLE_CC_TBL(obj));
2332 size += rb_str_memsize(obj);
2335 size += rb_ary_memsize(obj);
2338 if (RHASH_ST_TABLE_P(obj)) {
2339 VM_ASSERT(RHASH_ST_TABLE(obj) != NULL);
2341 size += st_memsize(RHASH_ST_TABLE(obj)) -
sizeof(
st_table);
2350 size += rb_objspace_data_type_memsize(obj);
2355 size += onig_region_memsize(&rm->
regs);
2360 if (
RFILE(obj)->fptr) {
2361 size += rb_io_memsize(
RFILE(obj)->fptr);
2368 size += rb_imemo_memsize(obj);
2376 if (!(
RBASIC(obj)->flags & BIGNUM_EMBED_FLAG) && BIGNUM_DIGITS(obj)) {
2377 size += BIGNUM_LEN(obj) *
sizeof(BDIGIT);
2382 UNEXPECTED_NODE(obj_memsize_of);
2386 if ((
RBASIC(obj)->flags & RSTRUCT_EMBED_LEN_MASK) == 0 &&
2387 RSTRUCT(obj)->as.heap.ptr) {
2388 size +=
sizeof(
VALUE) * RSTRUCT_LEN(obj);
2397 rb_bug(
"objspace/memsize_of(): unknown data type 0x%x(%p)",
2401 return size + rb_gc_obj_slot_size(obj);
2405set_zero(st_data_t key, st_data_t val, st_data_t arg)
2409 rb_hash_aset(hash, k,
INT2FIX(0));
2420count_objects_i(
VALUE obj,
void *d)
2424 if (
RBASIC(obj)->flags) {
2470count_objects(
int argc,
VALUE *argv,
VALUE os)
2481 rb_gc_impl_each_object(rb_gc_get_objspace(), count_objects_i, &data);
2484 hash = rb_hash_new();
2487 rb_hash_stlike_foreach(hash, set_zero, hash);
2489 rb_hash_aset(hash,
ID2SYM(rb_intern(
"TOTAL")),
SIZET2NUM(data.total));
2492 for (
size_t i = 0; i <=
T_MASK; i++) {
2501#define SET_STACK_END SET_MACHINE_STACK_END(&ec->machine.stack_end)
2503#define STACK_START (ec->machine.stack_start)
2504#define STACK_END (ec->machine.stack_end)
2505#define STACK_LEVEL_MAX (ec->machine.stack_maxsize/sizeof(VALUE))
2507#if STACK_GROW_DIRECTION < 0
2508# define STACK_LENGTH (size_t)(STACK_START - STACK_END)
2509#elif STACK_GROW_DIRECTION > 0
2510# define STACK_LENGTH (size_t)(STACK_END - STACK_START + 1)
2512# define STACK_LENGTH ((STACK_END < STACK_START) ? (size_t)(STACK_START - STACK_END) \
2513 : (size_t)(STACK_END - STACK_START + 1))
2515#if !STACK_GROW_DIRECTION
2516int ruby_stack_grow_direction;
2518ruby_get_stack_grow_direction(
volatile VALUE *addr)
2521 SET_MACHINE_STACK_END(&end);
2523 if (end > addr)
return ruby_stack_grow_direction = 1;
2524 return ruby_stack_grow_direction = -1;
2533 if (p) *p = STACK_UPPER(STACK_END, STACK_START, STACK_END);
2534 return STACK_LENGTH;
2537#define PREVENT_STACK_OVERFLOW 1
2538#ifndef PREVENT_STACK_OVERFLOW
2539#if !(defined(POSIX_SIGNAL) && defined(SIGSEGV) && defined(HAVE_SIGALTSTACK))
2540# define PREVENT_STACK_OVERFLOW 1
2542# define PREVENT_STACK_OVERFLOW 0
2545#if PREVENT_STACK_OVERFLOW && !defined(__EMSCRIPTEN__)
2551 size_t length = STACK_LENGTH;
2552 size_t maximum_length = STACK_LEVEL_MAX - water_mark;
2554 return length > maximum_length;
2557#define stack_check(ec, water_mark) FALSE
2560#define STACKFRAME_FOR_CALL_CFUNC 2048
2565 return stack_check(ec, STACKFRAME_FOR_CALL_CFUNC);
2571 return stack_check(GET_EC(), STACKFRAME_FOR_CALL_CFUNC);
2576#define RB_GC_MARK_OR_TRAVERSE(func, obj_or_ptr, obj, check_obj) do { \
2577 if (!RB_SPECIAL_CONST_P(obj)) { \
2578 rb_vm_t *vm = GET_VM(); \
2579 void *objspace = vm->gc.objspace; \
2580 if (LIKELY(vm->gc.mark_func_data == NULL)) { \
2581 GC_ASSERT(rb_gc_impl_during_gc_p(objspace)); \
2582 (func)(objspace, (obj_or_ptr)); \
2584 else if (check_obj ? \
2585 rb_gc_impl_pointer_to_heap_p(objspace, (const void *)obj) && \
2586 !rb_gc_impl_garbage_object_p(objspace, obj) : \
2588 GC_ASSERT(!rb_gc_impl_during_gc_p(objspace)); \
2589 struct gc_mark_func_data_struct *mark_func_data = vm->gc.mark_func_data; \
2590 vm->gc.mark_func_data = NULL; \
2591 mark_func_data->mark_func((obj), mark_func_data->data); \
2592 vm->gc.mark_func_data = mark_func_data; \
2598gc_mark_internal(
VALUE obj)
2600 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark, obj, obj,
false);
2606 gc_mark_internal(obj);
2610rb_gc_mark_and_move(
VALUE *ptr)
2612 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_and_move, ptr, *ptr,
false);
2616gc_mark_and_pin_internal(
VALUE obj)
2618 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_and_pin, obj, obj,
false);
2624 gc_mark_and_pin_internal(obj);
2628gc_mark_maybe_internal(
VALUE obj)
2630 RB_GC_MARK_OR_TRAVERSE(rb_gc_impl_mark_maybe, obj, obj,
true);
2636 gc_mark_maybe_internal(obj);
2640rb_gc_mark_weak(
VALUE *ptr)
2646 if (LIKELY(vm->gc.mark_func_data == NULL)) {
2647 GC_ASSERT(rb_gc_impl_during_gc_p(
objspace));
2649 rb_gc_impl_mark_weak(
objspace, ptr);
2652 GC_ASSERT(!rb_gc_impl_during_gc_p(
objspace));
2657rb_gc_remove_weak(
VALUE parent_obj,
VALUE *ptr)
2659 rb_gc_impl_remove_weak(rb_gc_get_objspace(), parent_obj, ptr);
2662ATTRIBUTE_NO_ADDRESS_SAFETY_ANALYSIS(
static void each_location(
register const VALUE *x,
register long n,
void (*cb)(
VALUE,
void *),
void *data));
2664each_location(
register const VALUE *x,
register long n,
void (*cb)(
VALUE,
void *),
void *data)
2675each_location_ptr(
const VALUE *start,
const VALUE *end,
void (*cb)(
VALUE,
void *),
void *data)
2677 if (end <= start)
return;
2678 each_location(start, end - start, cb, data);
2682gc_mark_maybe_each_location(
VALUE obj,
void *data)
2684 gc_mark_maybe_internal(obj);
2690 each_location_ptr(start, end, gc_mark_maybe_each_location, NULL);
2694rb_gc_mark_values(
long n,
const VALUE *values)
2696 for (
long i = 0; i < n; i++) {
2697 gc_mark_internal(values[i]);
2702rb_gc_mark_vm_stack_values(
long n,
const VALUE *values)
2704 for (
long i = 0; i < n; i++) {
2705 gc_mark_and_pin_internal(values[i]);
2710mark_key(st_data_t key, st_data_t value, st_data_t data)
2712 gc_mark_and_pin_internal((
VALUE)key);
2722 st_foreach(tbl, mark_key, (st_data_t)rb_gc_get_objspace());
2726mark_keyvalue(st_data_t key, st_data_t value, st_data_t data)
2728 gc_mark_internal((
VALUE)key);
2729 gc_mark_internal((
VALUE)value);
2735pin_key_pin_value(st_data_t key, st_data_t value, st_data_t data)
2737 gc_mark_and_pin_internal((
VALUE)key);
2738 gc_mark_and_pin_internal((
VALUE)value);
2744pin_key_mark_value(st_data_t key, st_data_t value, st_data_t data)
2746 gc_mark_and_pin_internal((
VALUE)key);
2747 gc_mark_internal((
VALUE)value);
2753mark_hash(
VALUE hash)
2755 if (rb_hash_compare_by_id_p(hash)) {
2756 rb_hash_stlike_foreach(hash, pin_key_mark_value, 0);
2759 rb_hash_stlike_foreach(hash, mark_keyvalue, 0);
2762 gc_mark_internal(RHASH(hash)->ifnone);
2770 st_foreach(tbl, pin_key_pin_value, 0);
2773static enum rb_id_table_iterator_result
2776 gc_mark_internal(me);
2778 return ID_TABLE_CONTINUE;
2785 rb_id_table_foreach_values(tbl, mark_method_entry_i,
objspace);
2789static enum rb_id_table_iterator_result
2794 gc_mark_internal(ce->value);
2795 gc_mark_internal(ce->file);
2796 return ID_TABLE_CONTINUE;
2803 rb_id_table_foreach_values(tbl, mark_const_entry_i,
objspace);
2811static enum rb_id_table_iterator_result
2812mark_cc_entry_i(
VALUE ccs_ptr,
void *data)
2816 VM_ASSERT(vm_ccs_p(ccs));
2818 if (METHOD_ENTRY_INVALIDATED(ccs->cme)) {
2819 rb_vm_ccs_free(ccs);
2820 return ID_TABLE_DELETE;
2823 gc_mark_internal((
VALUE)ccs->cme);
2825 for (
int i=0; i<ccs->len; i++) {
2827 VM_ASSERT(vm_cc_check_cme(ccs->entries[i].cc, ccs->cme));
2829 gc_mark_internal((
VALUE)ccs->entries[i].cc);
2831 return ID_TABLE_CONTINUE;
2844 rb_id_table_foreach_values(tbl, mark_cc_entry_i, (
void *)&args);
2847static enum rb_id_table_iterator_result
2855 gc_mark_internal((
VALUE)entry->cref);
2857 return ID_TABLE_CONTINUE;
2864 rb_id_table_foreach_values(tbl, mark_cvc_tbl_i,
objspace);
2867#if STACK_GROW_DIRECTION < 0
2868#define GET_STACK_BOUNDS(start, end, appendix) ((start) = STACK_END, (end) = STACK_START)
2869#elif STACK_GROW_DIRECTION > 0
2870#define GET_STACK_BOUNDS(start, end, appendix) ((start) = STACK_START, (end) = STACK_END+(appendix))
2872#define GET_STACK_BOUNDS(start, end, appendix) \
2873 ((STACK_END < STACK_START) ? \
2874 ((start) = STACK_END, (end) = STACK_START) : ((start) = STACK_START, (end) = STACK_END+(appendix)))
2878gc_mark_machine_stack_location_maybe(
VALUE obj,
void *data)
2880 gc_mark_maybe_internal(obj);
2882#ifdef RUBY_ASAN_ENABLED
2884 void *fake_frame_start;
2885 void *fake_frame_end;
2886 bool is_fake_frame = asan_get_fake_stack_extents(
2887 ec->machine.asan_fake_stack_handle, obj,
2888 ec->machine.stack_start, ec->machine.stack_end,
2889 &fake_frame_start, &fake_frame_end
2891 if (is_fake_frame) {
2892 each_location_ptr(fake_frame_start, fake_frame_end, gc_mark_maybe_each_location, NULL);
2904 GC_ASSERT(rb_gc_impl_pointer_to_heap_p(
objspace, (
void *)value));
2906 return rb_gc_impl_location(
objspace, value);
2912 return gc_location_internal(rb_gc_get_objspace(), value);
2915#if defined(__wasm__)
2918static VALUE *rb_stack_range_tmp[2];
2921rb_mark_locations(
void *begin,
void *end)
2923 rb_stack_range_tmp[0] = begin;
2924 rb_stack_range_tmp[1] = end;
2928rb_gc_save_machine_context(
void)
2933# if defined(__EMSCRIPTEN__)
2938 emscripten_scan_stack(rb_mark_locations);
2939 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2941 emscripten_scan_registers(rb_mark_locations);
2942 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2949 VALUE *stack_start, *stack_end;
2951 GET_STACK_BOUNDS(stack_start, stack_end, 1);
2952 each_location_ptr(stack_start, stack_end, gc_mark_maybe_each_location, NULL);
2954 rb_wasm_scan_locals(rb_mark_locations);
2955 each_location_ptr(rb_stack_range_tmp[0], rb_stack_range_tmp[1], gc_mark_maybe_each_location, NULL);
2963rb_gc_save_machine_context(
void)
2967 RB_VM_SAVE_MACHINE_CONTEXT(thread);
2974 rb_gc_mark_machine_context(ec);
2981 VALUE *stack_start, *stack_end;
2983 GET_STACK_BOUNDS(stack_start, stack_end, 0);
2984 RUBY_DEBUG_LOG(
"ec->th:%u stack_start:%p stack_end:%p", rb_ec_thread_ptr(ec)->serial, stack_start, stack_end);
2987#ifdef RUBY_ASAN_ENABLED
2994 each_location_ptr(stack_start, stack_end, gc_mark_machine_stack_location_maybe, data);
2995 int num_regs =
sizeof(ec->machine.regs)/(
sizeof(
VALUE));
2996 each_location((
VALUE*)&ec->machine.regs, num_regs, gc_mark_machine_stack_location_maybe, data);
3000rb_mark_tbl_i(st_data_t key, st_data_t value, st_data_t data)
3002 gc_mark_and_pin_internal((
VALUE)value);
3010 if (!tbl || tbl->num_entries == 0)
return;
3012 st_foreach(tbl, rb_mark_tbl_i, 0);
3018 if (!tbl || tbl->num_entries == 0)
return;
3020 st_foreach(tbl, gc_mark_tbl_no_pin_i, 0);
3026 gc_mark_tbl_no_pin(tbl);
3032 return (
type->flags & RUBY_TYPED_DECL_MARKING) != 0;
3036rb_gc_mark_roots(
void *
objspace,
const char **categoryp)
3039 rb_vm_t *vm = rb_ec_vm_ptr(ec);
3041#define MARK_CHECKPOINT(category) do { \
3042 if (categoryp) *categoryp = category; \
3045 MARK_CHECKPOINT(
"vm");
3048 MARK_CHECKPOINT(
"end_proc");
3051 MARK_CHECKPOINT(
"global_tbl");
3052 rb_gc_mark_global_tbl();
3055 void rb_yjit_root_mark(
void);
3057 if (rb_yjit_enabled_p) {
3058 MARK_CHECKPOINT(
"YJIT");
3059 rb_yjit_root_mark();
3063 MARK_CHECKPOINT(
"machine_context");
3064 mark_current_machine_context(ec);
3066 MARK_CHECKPOINT(
"global_symbols");
3067 rb_sym_global_symbols_mark();
3069 MARK_CHECKPOINT(
"finish");
3071#undef MARK_CHECKPOINT
3086 if (RCLASSEXT_SUPER(ext)) {
3087 gc_mark_internal(RCLASSEXT_SUPER(ext));
3089 mark_m_tbl(
objspace, RCLASSEXT_M_TBL(ext));
3090 gc_mark_internal(RCLASSEXT_FIELDS_OBJ(ext));
3091 if (!RCLASSEXT_SHARED_CONST_TBL(ext) && RCLASSEXT_CONST_TBL(ext)) {
3092 mark_const_tbl(
objspace, RCLASSEXT_CONST_TBL(ext));
3094 mark_m_tbl(
objspace, RCLASSEXT_CALLABLE_M_TBL(ext));
3095 mark_cc_tbl(
objspace, RCLASSEXT_CC_TBL(ext), obj);
3096 mark_cvc_tbl(
objspace, RCLASSEXT_CVC_TBL(ext));
3097 gc_mark_internal(RCLASSEXT_CLASSPATH(ext));
3107 if (RCLASSEXT_SUPER(ext)) {
3108 gc_mark_internal(RCLASSEXT_SUPER(ext));
3110 if (RCLASSEXT_ICLASS_IS_ORIGIN(ext) && !RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext)) {
3111 mark_m_tbl(
objspace, RCLASSEXT_M_TBL(ext));
3113 if (RCLASSEXT_INCLUDER(ext)) {
3114 gc_mark_internal(RCLASSEXT_INCLUDER(ext));
3116 mark_m_tbl(
objspace, RCLASSEXT_CALLABLE_M_TBL(ext));
3117 mark_cc_tbl(
objspace, RCLASSEXT_CC_TBL(ext), iclass);
3120#define TYPED_DATA_REFS_OFFSET_LIST(d) (size_t *)(uintptr_t)RTYPEDDATA_TYPE(d)->function.dmark
3127 if (rb_obj_exivar_p(obj)) {
3128 rb_mark_generic_ivar(obj);
3143 rb_bug(
"rb_gc_mark() called for broken object");
3147 UNEXPECTED_NODE(rb_gc_mark);
3151 rb_imemo_mark_and_move(obj,
false);
3158 gc_mark_internal(
RBASIC(obj)->klass);
3163 gc_mark_internal(RCLASS_ATTACHED_OBJECT(obj));
3168 foreach_args.obj = obj;
3169 rb_class_classext_foreach(obj, gc_mark_classext_module, (
void *)&foreach_args);
3174 foreach_args.obj = obj;
3175 rb_class_classext_foreach(obj, gc_mark_classext_iclass, (
void *)&foreach_args);
3179 if (ARY_SHARED_P(obj)) {
3180 VALUE root = ARY_SHARED_ROOT(obj);
3181 gc_mark_internal(root);
3186 for (
long i = 0; i <
len; i++) {
3187 gc_mark_internal(ptr[i]);
3197 if (STR_SHARED_P(obj)) {
3198 if (STR_EMBED_P(
RSTRING(obj)->as.heap.aux.shared)) {
3203 gc_mark_and_pin_internal(
RSTRING(obj)->as.heap.aux.shared);
3206 gc_mark_internal(
RSTRING(obj)->as.heap.aux.shared);
3216 size_t *offset_list = TYPED_DATA_REFS_OFFSET_LIST(obj);
3218 for (
size_t offset = *offset_list; offset != RUBY_REF_END; offset = *offset_list++) {
3219 gc_mark_internal(*(
VALUE *)((
char *)ptr + offset));
3226 if (mark_func) (*mark_func)(ptr);
3234 if (rb_shape_obj_too_complex_p(obj)) {
3235 gc_mark_tbl_no_pin(ROBJECT_FIELDS_HASH(obj));
3240 uint32_t
len = ROBJECT_FIELDS_COUNT(obj);
3241 for (uint32_t i = 0; i <
len; i++) {
3242 gc_mark_internal(ptr[i]);
3246 attr_index_t fields_count = ROBJECT_FIELDS_COUNT(obj);
3251 if (RCLASS_MAX_IV_COUNT(klass) < fields_count) {
3252 RCLASS_SET_MAX_IV_COUNT(klass, fields_count);
3260 if (
RFILE(obj)->fptr) {
3261 gc_mark_internal(
RFILE(obj)->fptr->self);
3262 gc_mark_internal(
RFILE(obj)->fptr->pathv);
3263 gc_mark_internal(
RFILE(obj)->fptr->tied_io_for_writing);
3264 gc_mark_internal(
RFILE(obj)->fptr->writeconv_asciicompat);
3265 gc_mark_internal(
RFILE(obj)->fptr->writeconv_pre_ecopts);
3266 gc_mark_internal(
RFILE(obj)->fptr->encs.ecopts);
3267 gc_mark_internal(
RFILE(obj)->fptr->write_lock);
3268 gc_mark_internal(
RFILE(obj)->fptr->timeout);
3269 gc_mark_internal(
RFILE(obj)->fptr->wakeup_mutex);
3274 gc_mark_internal(
RREGEXP(obj)->src);
3278 gc_mark_internal(
RMATCH(obj)->regexp);
3280 gc_mark_internal(
RMATCH(obj)->str);
3285 gc_mark_internal(RRATIONAL(obj)->num);
3286 gc_mark_internal(RRATIONAL(obj)->den);
3290 gc_mark_internal(RCOMPLEX(obj)->real);
3291 gc_mark_internal(RCOMPLEX(obj)->imag);
3295 const long len = RSTRUCT_LEN(obj);
3296 const VALUE *
const ptr = RSTRUCT_CONST_PTR(obj);
3298 for (
long i = 0; i <
len; i++) {
3299 gc_mark_internal(ptr[i]);
3309 rb_bug(
"rb_gc_mark(): unknown data type 0x%x(%p) %s",
3311 rb_gc_impl_pointer_to_heap_p(
objspace, (
void *)obj) ?
"corrupted object" :
"non object");
3316rb_gc_obj_optimal_size(
VALUE obj)
3320 return rb_ary_size_as_embedded(obj);
3323 if (rb_shape_obj_too_complex_p(obj)) {
3324 return sizeof(
struct RObject);
3331 return rb_str_size_as_embedded(obj);
3334 return sizeof(
struct RHash) + (RHASH_ST_TABLE_P(obj) ? sizeof(
st_table) : sizeof(ar_table));
3342rb_gc_writebarrier(VALUE a, VALUE b)
3344 rb_gc_impl_writebarrier(rb_gc_get_objspace(), a, b);
3350 rb_gc_impl_writebarrier_unprotect(rb_gc_get_objspace(), obj);
3357rb_gc_writebarrier_remember(
VALUE obj)
3359 rb_gc_impl_writebarrier_remember(rb_gc_get_objspace(), obj);
3365 rb_gc_impl_copy_attributes(rb_gc_get_objspace(), dest, obj);
3369rb_gc_modular_gc_loaded_p(
void)
3372 return rb_gc_functions.modular_gc_loaded_p;
3379rb_gc_active_gc_name(
void)
3381 const char *gc_name = rb_gc_impl_active_gc_name();
3383 const size_t len = strlen(gc_name);
3384 if (
len > RB_GC_MAX_NAME_LEN) {
3385 rb_bug(
"GC should have a name no more than %d chars long. Currently: %zu (%s)",
3386 RB_GC_MAX_NAME_LEN,
len, gc_name);
3393rb_gc_object_metadata(
VALUE obj)
3395 return rb_gc_impl_object_metadata(rb_gc_get_objspace(), obj);
3403 return rb_gc_impl_ractor_cache_alloc(rb_gc_get_objspace(), ractor);
3407rb_gc_ractor_cache_free(
void *cache)
3409 rb_gc_impl_ractor_cache_free(rb_gc_get_objspace(), cache);
3415 if (!rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (
void *)obj))
3418 rb_vm_register_global_object(obj);
3429 tmp->next = vm->global_object_list;
3431 vm->global_object_list = tmp;
3439 rb_warn(
"Object is assigned to registering address already: %"PRIsVALUE,
3441 rb_print_backtrace(stderr);
3451 if (tmp->varptr == addr) {
3452 vm->global_object_list = tmp->next;
3457 if (tmp->next->varptr == addr) {
3460 tmp->next = tmp->next->next;
3471 rb_gc_register_address(var);
3477 rb_gc_impl_start(rb_gc_get_objspace(),
RTEST(full_mark),
RTEST(immediate_mark),
RTEST(immediate_sweep),
RTEST(compact));
3521rb_objspace_each_objects(
int (*callback)(
void *,
void *,
size_t,
void *),
void *data)
3523 rb_gc_impl_each_objects(rb_gc_get_objspace(), callback, data);
3529 if (ARY_SHARED_P(v)) {
3530 VALUE old_root =
RARRAY(v)->as.heap.aux.shared_root;
3534 VALUE new_root =
RARRAY(v)->as.heap.aux.shared_root;
3536 if (ARY_EMBED_P(new_root) && new_root != old_root) {
3537 size_t offset = (size_t)(
RARRAY(v)->as.heap.ptr -
RARRAY(old_root)->as.ary);
3538 GC_ASSERT(
RARRAY(v)->as.heap.ptr >=
RARRAY(old_root)->as.ary);
3539 RARRAY(v)->as.heap.ptr =
RARRAY(new_root)->as.ary + offset;
3547 for (
long i = 0; i <
len; i++) {
3552 if (rb_gc_obj_slot_size(v) >= rb_ary_size_as_embedded(v)) {
3553 if (rb_ary_embeddable_p(v)) {
3554 rb_ary_make_embedded(v);
3565 if (rb_shape_obj_too_complex_p(v)) {
3566 gc_ref_update_table_values_only(ROBJECT_FIELDS_HASH(v));
3570 size_t slot_size = rb_gc_obj_slot_size(v);
3572 if (slot_size >= embed_size && !
RB_FL_TEST_RAW(v, ROBJECT_EMBED)) {
3574 memcpy(
ROBJECT(v)->as.ary, ptr,
sizeof(
VALUE) * ROBJECT_FIELDS_COUNT(v));
3580 for (uint32_t i = 0; i < ROBJECT_FIELDS_COUNT(v); i++) {
3586rb_gc_ref_update_table_values_only(
st_table *tbl)
3588 gc_ref_update_table_values_only(tbl);
3595 gc_update_table_refs(ptr);
3601 rb_hash_stlike_foreach_with_replace(v, hash_foreach_replace, hash_replace_ref, (st_data_t)
objspace);
3607 for (
long i = 0; i < n; i++) {
3608 UPDATE_IF_MOVED(
objspace, values[i]);
3613rb_gc_update_values(
long n,
VALUE *values)
3615 gc_update_values(rb_gc_get_objspace(), n, values);
3618static enum rb_id_table_iterator_result
3619check_id_table_move(
VALUE value,
void *data)
3624 return ID_TABLE_REPLACE;
3627 return ID_TABLE_CONTINUE;
3631rb_gc_prepare_heap_process_object(
VALUE obj)
3645rb_gc_prepare_heap(
void)
3647 rb_gc_impl_prepare_heap(rb_gc_get_objspace());
3651rb_gc_heap_id_for_size(
size_t size)
3653 return rb_gc_impl_heap_id_for_size(rb_gc_get_objspace(), size);
3657rb_gc_size_allocatable_p(
size_t size)
3659 return rb_gc_impl_size_allocatable_p(size);
3662static enum rb_id_table_iterator_result
3663update_id_table(
VALUE *value,
void *data,
int existing)
3671 return ID_TABLE_CONTINUE;
3678 rb_id_table_foreach_values_with_replace(tbl, check_id_table_move, update_id_table,
objspace);
3682static enum rb_id_table_iterator_result
3686 VM_ASSERT(vm_ccs_p(ccs));
3692 for (
int i=0; i<ccs->len; i++) {
3693 if (rb_gc_impl_object_moved_p(
objspace, (
VALUE)ccs->entries[i].cc)) {
3699 return ID_TABLE_CONTINUE;
3706 rb_id_table_foreach_values(tbl, update_cc_tbl_i,
objspace);
3709static enum rb_id_table_iterator_result
3720 entry->class_value = gc_location_internal(
objspace, entry->class_value);
3722 return ID_TABLE_CONTINUE;
3729 rb_id_table_foreach_values(tbl, update_cvc_tbl_i,
objspace);
3732static enum rb_id_table_iterator_result
3737 if (rb_gc_impl_object_moved_p(
objspace, ce->value)) {
3738 ce->value = gc_location_internal(
objspace, ce->value);
3741 if (rb_gc_impl_object_moved_p(
objspace, ce->file)) {
3742 ce->file = gc_location_internal(
objspace, ce->file);
3745 return ID_TABLE_CONTINUE;
3752 rb_id_table_foreach_values(tbl, update_const_tbl_i,
objspace);
3760 if (!anchor)
return;
3761 entry = anchor->head;
3764 UPDATE_IF_MOVED(
objspace, entry->klass);
3765 entry = entry->next;
3772 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
3773 size_t array_size = RCLASSEXT_SUPERCLASS_DEPTH(ext) + 1;
3774 for (
size_t i = 0; i < array_size; i++) {
3775 UPDATE_IF_MOVED(
objspace, RCLASSEXT_SUPERCLASSES(ext)[i]);
3783 UPDATE_IF_MOVED(
objspace, RCLASSEXT_ORIGIN(ext));
3784 UPDATE_IF_MOVED(
objspace, RCLASSEXT_REFINED_CLASS(ext));
3785 UPDATE_IF_MOVED(
objspace, RCLASSEXT_CLASSPATH(ext));
3787 UPDATE_IF_MOVED(
objspace, RCLASSEXT_INCLUDER(ext));
3797 if (RCLASSEXT_SUPER(ext)) {
3798 UPDATE_IF_MOVED(
objspace, RCLASSEXT_SUPER(ext));
3801 update_m_tbl(
objspace, RCLASSEXT_M_TBL(ext));
3803 UPDATE_IF_MOVED(
objspace, ext->fields_obj);
3804 if (!RCLASSEXT_SHARED_CONST_TBL(ext)) {
3805 update_const_tbl(
objspace, RCLASSEXT_CONST_TBL(ext));
3807 update_cc_tbl(
objspace, RCLASSEXT_CC_TBL(ext));
3808 update_cvc_tbl(
objspace, RCLASSEXT_CVC_TBL(ext));
3809 update_superclasses(
objspace, ext);
3812 update_classext_values(
objspace, ext,
false);
3821 if (RCLASSEXT_SUPER(ext)) {
3822 UPDATE_IF_MOVED(
objspace, RCLASSEXT_SUPER(ext));
3824 update_m_tbl(
objspace, RCLASSEXT_M_TBL(ext));
3825 update_m_tbl(
objspace, RCLASSEXT_CALLABLE_M_TBL(ext));
3826 update_cc_tbl(
objspace, RCLASSEXT_CC_TBL(ext));
3829 update_classext_values(
objspace, ext,
true);
3833#define global_symbols ruby_global_symbols
3836 vm_table_foreach_callback_func callback;
3837 vm_table_update_callback_func update_callback;
3843vm_weak_table_foreach_weak_key(st_data_t key, st_data_t value, st_data_t data,
int error)
3847 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3849 if (!iter_data->weak_only) {
3850 if (ret != ST_CONTINUE)
return ret;
3852 ret = iter_data->callback((
VALUE)value, iter_data->data);
3859vm_weak_table_foreach_update_weak_key(st_data_t *key, st_data_t *value, st_data_t data,
int existing)
3863 int ret = iter_data->update_callback((
VALUE *)key, iter_data->data);
3865 if (!iter_data->weak_only) {
3866 if (ret != ST_CONTINUE)
return ret;
3868 ret = iter_data->update_callback((
VALUE *)value, iter_data->data);
3875vm_weak_table_cc_refinement_foreach(st_data_t key, st_data_t data,
int error)
3879 return iter_data->callback((
VALUE)key, iter_data->data);
3883vm_weak_table_cc_refinement_foreach_update_update(st_data_t *key, st_data_t data,
int existing)
3887 return iter_data->update_callback((
VALUE *)key, iter_data->data);
3892vm_weak_table_str_sym_foreach(st_data_t key, st_data_t value, st_data_t data,
int error)
3896 if (!iter_data->weak_only) {
3897 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3898 if (ret != ST_CONTINUE)
return ret;
3905 return iter_data->callback((
VALUE)value, iter_data->data);
3910vm_weak_table_foreach_update_weak_value(st_data_t *key, st_data_t *value, st_data_t data,
int existing)
3914 if (!iter_data->weak_only) {
3915 int ret = iter_data->update_callback((
VALUE *)key, iter_data->data);
3916 if (ret != ST_CONTINUE)
return ret;
3919 return iter_data->update_callback((
VALUE *)value, iter_data->data);
3922struct st_table *rb_generic_fields_tbl_get(
void);
3925vm_weak_table_id2ref_foreach(st_data_t key, st_data_t value, st_data_t data,
int error)
3930 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3931 if (ret != ST_CONTINUE)
return ret;
3934 return iter_data->callback((
VALUE)value, iter_data->data);
3938vm_weak_table_id2ref_foreach_update(st_data_t *key, st_data_t *value, st_data_t data,
int existing)
3942 iter_data->update_callback((
VALUE *)value, iter_data->data);
3945 iter_data->update_callback((
VALUE *)key, iter_data->data);
3952vm_weak_table_gen_fields_foreach(st_data_t key, st_data_t value, st_data_t data)
3956 int ret = iter_data->callback((
VALUE)key, iter_data->data);
3966 RBASIC_SET_SHAPE_ID((
VALUE)key, ROOT_SHAPE_ID);
3970 ret = iter_data->update_callback(&new_key, iter_data->data);
3971 if (key != new_key) {
3978 rb_bug(
"vm_weak_table_gen_fields_foreach: return value %d not supported", ret);
3981 if (!iter_data->weak_only) {
3982 int ivar_ret = iter_data->callback(new_value, iter_data->data);
3988 iter_data->update_callback(&new_value, iter_data->data);
3992 rb_bug(
"vm_weak_table_gen_fields_foreach: return value %d not supported", ivar_ret);
3996 if (key != new_key || value != new_value) {
3997 DURING_GC_COULD_MALLOC_REGION_START();
3999 st_insert(rb_generic_fields_tbl_get(), (st_data_t)new_key, new_value);
4001 DURING_GC_COULD_MALLOC_REGION_END();
4008vm_weak_table_frozen_strings_foreach(st_data_t key, st_data_t value, st_data_t data,
int error)
4010 int retval = vm_weak_table_foreach_weak_key(key, value, data, error);
4011 if (retval == ST_DELETE) {
4017void rb_fstring_foreach_with_replace(st_foreach_check_callback_func *func, st_update_callback_func *replace, st_data_t arg);
4019rb_gc_vm_weak_table_foreach(vm_table_foreach_callback_func callback,
4020 vm_table_update_callback_func update_callback,
4023 enum rb_gc_vm_weak_tables table)
4028 .callback = callback,
4029 .update_callback = update_callback,
4031 .weak_only = weak_only,
4035 case RB_GC_VM_CI_TABLE: {
4037 st_foreach_with_replace(
4039 vm_weak_table_foreach_weak_key,
4040 vm_weak_table_foreach_update_weak_key,
4041 (st_data_t)&foreach_data
4046 case RB_GC_VM_OVERLOADED_CME_TABLE: {
4047 if (vm->overloaded_cme_table) {
4048 st_foreach_with_replace(
4049 vm->overloaded_cme_table,
4050 vm_weak_table_foreach_weak_key,
4051 vm_weak_table_foreach_update_weak_key,
4052 (st_data_t)&foreach_data
4057 case RB_GC_VM_GLOBAL_SYMBOLS_TABLE: {
4058 if (global_symbols.str_sym) {
4059 st_foreach_with_replace(
4060 global_symbols.str_sym,
4061 vm_weak_table_str_sym_foreach,
4062 vm_weak_table_foreach_update_weak_value,
4063 (st_data_t)&foreach_data
4068 case RB_GC_VM_ID2REF_TABLE: {
4070 st_foreach_with_replace(
4072 vm_weak_table_id2ref_foreach,
4073 vm_weak_table_id2ref_foreach_update,
4074 (st_data_t)&foreach_data
4079 case RB_GC_VM_GENERIC_FIELDS_TABLE: {
4080 st_table *generic_fields_tbl = rb_generic_fields_tbl_get();
4081 if (generic_fields_tbl) {
4084 vm_weak_table_gen_fields_foreach,
4085 (st_data_t)&foreach_data
4090 case RB_GC_VM_FROZEN_STRINGS_TABLE: {
4091 rb_fstring_foreach_with_replace(
4092 vm_weak_table_frozen_strings_foreach,
4093 vm_weak_table_foreach_update_weak_key,
4094 (st_data_t)&foreach_data
4098 case RB_GC_VM_CC_REFINEMENT_TABLE: {
4099 if (vm->cc_refinement_table) {
4100 set_foreach_with_replace(
4101 vm->cc_refinement_table,
4102 vm_weak_table_cc_refinement_foreach,
4103 vm_weak_table_cc_refinement_foreach_update_update,
4104 (st_data_t)&foreach_data
4109 case RB_GC_VM_WEAK_TABLE_COUNT:
4110 rb_bug(
"Unreachable");
4112 rb_bug(
"rb_gc_vm_weak_table_foreach: unknown table %d", table);
4117rb_gc_update_vm_references(
void *
objspace)
4120 rb_vm_t *vm = rb_ec_vm_ptr(ec);
4122 rb_vm_update_references(vm);
4123 rb_gc_update_global_tbl();
4124 rb_sym_global_symbols_update_references();
4127 void rb_yjit_root_update_references(
void);
4129 if (rb_yjit_enabled_p) {
4130 rb_yjit_root_update_references();
4143 UPDATE_IF_MOVED(
objspace, RCLASS_ATTACHED_OBJECT(obj));
4149 rb_class_classext_foreach(obj, update_classext, (
void *)&args);
4154 rb_class_classext_foreach(obj, update_iclass_classext, (
void *)&args);
4158 rb_imemo_mark_and_move(obj,
true);
4170 gc_ref_update_array(
objspace, obj);
4175 UPDATE_IF_MOVED(
objspace, RHASH(obj)->ifnone);
4180 if (STR_SHARED_P(obj)) {
4186 if (rb_gc_obj_slot_size(obj) >= rb_str_size_as_embedded(obj)) {
4187 if (!STR_EMBED_P(obj) && rb_str_reembeddable_p(obj)) {
4188 rb_str_make_embedded(obj);
4200 size_t *offset_list = TYPED_DATA_REFS_OFFSET_LIST(obj);
4202 for (
size_t offset = *offset_list; offset != RUBY_REF_END; offset = *offset_list++) {
4203 VALUE *ref = (
VALUE *)((
char *)ptr + offset);
4204 *ref = gc_location_internal(
objspace, *ref);
4209 if (compact_func) (*compact_func)(ptr);
4216 gc_ref_update_object(
objspace, obj);
4220 if (
RFILE(obj)->fptr) {
4223 UPDATE_IF_MOVED(
objspace,
RFILE(obj)->fptr->tied_io_for_writing);
4224 UPDATE_IF_MOVED(
objspace,
RFILE(obj)->fptr->writeconv_asciicompat);
4225 UPDATE_IF_MOVED(
objspace,
RFILE(obj)->fptr->writeconv_pre_ecopts);
4237 UPDATE_IF_MOVED(
objspace, RSYMBOL(obj)->fstr);
4253 UPDATE_IF_MOVED(
objspace, RRATIONAL(obj)->num);
4254 UPDATE_IF_MOVED(
objspace, RRATIONAL(obj)->den);
4258 UPDATE_IF_MOVED(
objspace, RCOMPLEX(obj)->real);
4259 UPDATE_IF_MOVED(
objspace, RCOMPLEX(obj)->imag);
4265 long i,
len = RSTRUCT_LEN(obj);
4266 VALUE *ptr = (
VALUE *)RSTRUCT_CONST_PTR(obj);
4268 for (i = 0; i <
len; i++) {
4274 rb_bug(
"unreachable");
4291 unless_objspace(
objspace) {
return; }
4293 rb_gc_impl_start(
objspace,
true,
true,
true,
false);
4299 unless_objspace(
objspace) {
return FALSE; }
4301 return rb_gc_impl_during_gc_p(
objspace);
4307 return rb_gc_impl_gc_count(rb_gc_get_objspace());
4323 VALUE val = rb_gc_impl_latest_gc_info(rb_gc_get_objspace(), key);
4326 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(key));
4336 arg = rb_hash_new();
4342 VALUE ret = rb_gc_impl_stat(rb_gc_get_objspace(), arg);
4347 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(arg));
4360 VALUE ret = rb_gc_impl_stat(rb_gc_get_objspace(), arg);
4365 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(arg));
4380 arg = rb_hash_new();
4383 if (
NIL_P(heap_name)) {
4394 rb_raise(
rb_eTypeError,
"heap_name must be nil or an Integer");
4397 VALUE ret = rb_gc_impl_stat_heap(rb_gc_get_objspace(), heap_name, arg);
4402 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(arg));
4411 VALUE cfg_hash = rb_gc_impl_config_get(rb_gc_get_objspace());
4412 rb_hash_aset(cfg_hash, sym(
"implementation"), rb_fstring_cstr(rb_gc_impl_active_gc_name()));
4420 void *
objspace = rb_gc_get_objspace();
4422 rb_gc_impl_config_set(
objspace, hash);
4424 return rb_gc_impl_config_get(
objspace);
4430 return rb_gc_impl_stress_get(rb_gc_get_objspace());
4436 rb_gc_impl_stress_set(rb_gc_get_objspace(), flag);
4442rb_gc_initial_stress_set(
VALUE flag)
4444 initial_stress = flag;
4448rb_gc_heap_sizes(
void)
4450 return rb_gc_impl_heap_sizes(rb_gc_get_objspace());
4456 return rb_objspace_gc_enable(rb_gc_get_objspace());
4460rb_objspace_gc_enable(
void *
objspace)
4462 bool disabled = !rb_gc_impl_gc_enabled_p(
objspace);
4464 return RBOOL(disabled);
4470 return rb_gc_enable();
4476 bool disabled = !rb_gc_impl_gc_enabled_p(
objspace);
4477 rb_gc_impl_gc_disable(
objspace,
false);
4478 return RBOOL(disabled);
4482rb_gc_disable_no_rest(
void)
4484 return gc_disable_no_rest(rb_gc_get_objspace());
4490 return rb_objspace_gc_disable(rb_gc_get_objspace());
4494rb_objspace_gc_disable(
void *
objspace)
4496 bool disabled = !rb_gc_impl_gc_enabled_p(
objspace);
4497 rb_gc_impl_gc_disable(
objspace,
true);
4498 return RBOOL(disabled);
4504 return rb_gc_disable();
4509ruby_gc_set_params(
void)
4511 rb_gc_impl_set_params(rb_gc_get_objspace());
4515rb_objspace_reachable_objects_from(
VALUE obj,
void (func)(
VALUE,
void *),
void *data)
4518 if (rb_gc_impl_during_gc_p(rb_gc_get_objspace())) rb_bug(
"rb_objspace_reachable_objects_from() is not supported while during GC");
4522 struct gc_mark_func_data_struct *prev_mfd = vm->gc.mark_func_data;
4523 struct gc_mark_func_data_struct mfd = {
4528 vm->gc.mark_func_data = &mfd;
4529 rb_gc_mark_children(rb_gc_get_objspace(), obj);
4530 vm->gc.mark_func_data = prev_mfd;
4536 const char *category;
4537 void (*func)(
const char *category,
VALUE,
void *);
4542root_objects_from(
VALUE obj,
void *ptr)
4545 (*data->func)(data->category, obj, data->data);
4549rb_objspace_reachable_objects_from_root(
void (func)(
const char *category,
VALUE,
void *),
void *passing_data)
4551 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");
4557 .data = passing_data,
4560 struct gc_mark_func_data_struct *prev_mfd = vm->gc.mark_func_data;
4561 struct gc_mark_func_data_struct mfd = {
4562 .mark_func = root_objects_from,
4566 vm->gc.mark_func_data = &mfd;
4567 rb_gc_save_machine_context();
4568 rb_gc_mark_roots(vm->gc.objspace, &data.category);
4569 vm->gc.mark_func_data = prev_mfd;
4580#define TYPE_NAME(t) case (t): return #t;
4607 if (obj && rb_objspace_data_type_name(obj)) {
4608 return rb_objspace_data_type_name(obj);
4617obj_type_name(
VALUE obj)
4619 return type_name(
TYPE(obj), obj);
4623rb_method_type_name(rb_method_type_t
type)
4626 case VM_METHOD_TYPE_ISEQ:
return "iseq";
4627 case VM_METHOD_TYPE_ATTRSET:
return "attrest";
4628 case VM_METHOD_TYPE_IVAR:
return "ivar";
4629 case VM_METHOD_TYPE_BMETHOD:
return "bmethod";
4630 case VM_METHOD_TYPE_ALIAS:
return "alias";
4631 case VM_METHOD_TYPE_REFINED:
return "refined";
4632 case VM_METHOD_TYPE_CFUNC:
return "cfunc";
4633 case VM_METHOD_TYPE_ZSUPER:
return "zsuper";
4634 case VM_METHOD_TYPE_MISSING:
return "missing";
4635 case VM_METHOD_TYPE_OPTIMIZED:
return "optimized";
4636 case VM_METHOD_TYPE_UNDEF:
return "undef";
4637 case VM_METHOD_TYPE_NOTIMPLEMENTED:
return "notimplemented";
4639 rb_bug(
"rb_method_type_name: unreachable (type: %d)",
type);
4643rb_raw_iseq_info(
char *
const buff,
const size_t buff_size,
const rb_iseq_t *iseq)
4645 if (buff_size > 0 && ISEQ_BODY(iseq) && ISEQ_BODY(iseq)->location.label && !
RB_TYPE_P(ISEQ_BODY(iseq)->location.pathobj,
T_MOVED)) {
4646 VALUE path = rb_iseq_path(iseq);
4647 int n = ISEQ_BODY(iseq)->location.first_lineno;
4648 snprintf(buff, buff_size,
" %s@%s:%d",
4649 RSTRING_PTR(ISEQ_BODY(iseq)->location.label),
4650 RSTRING_PTR(path), n);
4655str_len_no_raise(
VALUE str)
4657 long len = RSTRING_LEN(str);
4658 if (
len < 0)
return 0;
4659 if (
len > INT_MAX)
return INT_MAX;
4663#define BUFF_ARGS buff + pos, buff_size - pos
4664#define APPEND_F(...) if ((pos += snprintf(BUFF_ARGS, "" __VA_ARGS__)) >= buff_size) goto end
4665#define APPEND_S(s) do { \
4666 if ((pos + (int)rb_strlen_lit(s)) >= buff_size) { \
4670 memcpy(buff + pos, (s), rb_strlen_lit(s) + 1); \
4673#define C(c, s) ((c) != 0 ? (s) : " ")
4676rb_raw_obj_info_common(
char *
const buff,
const size_t buff_size,
const VALUE obj)
4681 APPEND_F(
"%s", obj_type_name(obj));
4687 APPEND_F(
" %s", rb_id2name(
SYM2ID(obj)));
4693 if (rb_gc_impl_pointer_to_heap_p(rb_gc_get_objspace(), (
void *)obj)) {
4694 APPEND_F(
"%p %s/", (
void *)obj, obj_type_name(obj));
4713 if (internal_object_p(obj)) {
4716 else if (
RBASIC(obj)->klass == 0) {
4717 APPEND_S(
"(temporary internal)");
4721 if (!
NIL_P(class_path)) {
4722 APPEND_F(
"%s ", RSTRING_PTR(class_path));
4731const char *rb_raw_obj_info(
char *
const buff,
const size_t buff_size,
VALUE obj);
4734rb_raw_obj_info_buitin_type(
char *
const buff,
const size_t buff_size,
const VALUE obj,
size_t pos)
4741 UNEXPECTED_NODE(rb_raw_obj_info);
4744 if (ARY_SHARED_P(obj)) {
4745 APPEND_S(
"shared -> ");
4746 rb_raw_obj_info(BUFF_ARGS, ARY_SHARED_ROOT(obj));
4748 else if (ARY_EMBED_P(obj)) {
4749 APPEND_F(
"[%s%s] len: %ld (embed)",
4750 C(ARY_EMBED_P(obj),
"E"),
4751 C(ARY_SHARED_P(obj),
"S"),
4755 APPEND_F(
"[%s%s] len: %ld, capa:%ld ptr:%p",
4756 C(ARY_EMBED_P(obj),
"E"),
4757 C(ARY_SHARED_P(obj),
"S"),
4759 ARY_EMBED_P(obj) ? -1L :
RARRAY(obj)->as.heap.aux.
capa,
4764 if (STR_SHARED_P(obj)) {
4765 APPEND_F(
" [shared] len: %ld", RSTRING_LEN(obj));
4768 if (STR_EMBED_P(obj)) APPEND_S(
" [embed]");
4770 APPEND_F(
" len: %ld, capa: %" PRIdSIZE, RSTRING_LEN(obj),
rb_str_capacity(obj));
4772 APPEND_F(
" \"%.*s\"", str_len_no_raise(obj), RSTRING_PTR(obj));
4776 VALUE fstr = RSYMBOL(obj)->fstr;
4777 ID id = RSYMBOL(obj)->id;
4779 APPEND_F(
":%s id:%d", RSTRING_PTR(fstr), (
unsigned int)
id);
4782 APPEND_F(
"(%p) id:%d", (
void *)fstr, (
unsigned int)
id);
4787 APPEND_F(
"-> %p", (
void*)gc_location_internal(rb_gc_get_objspace(), obj));
4791 APPEND_F(
"[%c] %"PRIdSIZE,
4792 RHASH_AR_TABLE_P(obj) ?
'A' :
'S',
4800 if (!
NIL_P(class_path)) {
4801 APPEND_F(
"%s", RSTRING_PTR(class_path));
4811 if (!
NIL_P(class_path)) {
4812 APPEND_F(
"src:%s", RSTRING_PTR(class_path));
4818 if (rb_shape_obj_too_complex_p(obj)) {
4819 size_t hash_len = rb_st_table_size(ROBJECT_FIELDS_HASH(obj));
4820 APPEND_F(
"(too_complex) len:%zu", hash_len);
4823 uint32_t
len = ROBJECT_FIELDS_CAPACITY(obj);
4825 if (
RBASIC(obj)->flags & ROBJECT_EMBED) {
4826 APPEND_F(
"(embed) len:%d",
len);
4830 APPEND_F(
"len:%d ptr:%p",
len, (
void *)ptr);
4839 (block = vm_proc_block(obj)) != NULL &&
4840 (vm_block_type(block) == block_type_iseq) &&
4841 (iseq = vm_block_iseq(block)) != NULL) {
4842 rb_raw_iseq_info(BUFF_ARGS, iseq);
4844 else if (rb_ractor_p(obj)) {
4847 APPEND_F(
"r:%d", r->pub.id);
4851 const char *
const type_name = rb_objspace_data_type_name(obj);
4853 APPEND_F(
"%s", type_name);
4859 APPEND_F(
"<%s> ", rb_imemo_name(imemo_type(obj)));
4861 switch (imemo_type(obj)) {
4866 APPEND_F(
":%s (%s%s%s%s) type:%s aliased:%d owner:%p defined_class:%p",
4867 rb_id2name(me->called_id),
4868 METHOD_ENTRY_VISI(me) == METHOD_VISI_PUBLIC ?
"pub" :
4869 METHOD_ENTRY_VISI(me) == METHOD_VISI_PRIVATE ?
"pri" :
"pro",
4870 METHOD_ENTRY_COMPLEMENTED(me) ?
",cmp" :
"",
4871 METHOD_ENTRY_CACHED(me) ?
",cc" :
"",
4872 METHOD_ENTRY_INVALIDATED(me) ?
",inv" :
"",
4873 me->def ? rb_method_type_name(me->def->
type) :
"NULL",
4874 me->def ? me->def->aliased : -1,
4876 (void *)me->defined_class);
4879 switch (me->def->type) {
4880 case VM_METHOD_TYPE_ISEQ:
4881 APPEND_S(
" (iseq:");
4882 rb_raw_obj_info(BUFF_ARGS, (
VALUE)me->def->body.iseq.
iseqptr);
4894 rb_raw_iseq_info(BUFF_ARGS, iseq);
4897 case imemo_callinfo:
4900 APPEND_F(
"(mid:%s, flag:%x argc:%d, kwarg:%s)",
4901 rb_id2name(vm_ci_mid(ci)),
4904 vm_ci_kwarg(ci) ?
"available" :
"NULL");
4907 case imemo_callcache:
4913 APPEND_F(
"(klass:%s cme:%s%s (%p) call:%p",
4914 NIL_P(class_path) ? (cc->klass ?
"??" :
"<NULL>") : RSTRING_PTR(class_path),
4915 cme ? rb_id2name(cme->called_id) :
"<NULL>",
4916 cme ? (METHOD_ENTRY_INVALIDATED(cme) ?
" [inv]" :
"") :
"",
4918 (void *)(uintptr_t)vm_cc_call(cc));
4937rb_asan_poison_object(
VALUE obj)
4939 MAYBE_UNUSED(
struct RVALUE *) ptr = (
void *)obj;
4940 asan_poison_memory_region(ptr, rb_gc_obj_slot_size(obj));
4944rb_asan_unpoison_object(
VALUE obj,
bool newobj_p)
4946 MAYBE_UNUSED(
struct RVALUE *) ptr = (
void *)obj;
4947 asan_unpoison_memory_region(ptr, rb_gc_obj_slot_size(obj), newobj_p);
4951rb_asan_poisoned_object_p(
VALUE obj)
4953 MAYBE_UNUSED(
struct RVALUE *) ptr = (
void *)obj;
4954 return __asan_region_is_poisoned(ptr, rb_gc_obj_slot_size(obj));
4958raw_obj_info(
char *
const buff,
const size_t buff_size,
VALUE obj)
4960 size_t pos = rb_raw_obj_info_common(buff, buff_size, obj);
4961 pos = rb_raw_obj_info_buitin_type(buff, buff_size, obj, pos);
4962 if (pos >= buff_size) {}
4966rb_raw_obj_info(
char *
const buff,
const size_t buff_size,
VALUE obj)
4968 void *
objspace = rb_gc_get_objspace();
4971 raw_obj_info(buff, buff_size, obj);
4973 else if (!rb_gc_impl_pointer_to_heap_p(
objspace, (
const void *)obj)) {
4974 snprintf(buff, buff_size,
"out-of-heap:%p", (
void *)obj);
4977 else if (0 && rb_gc_impl_garbage_object_p(
objspace, obj)) {
4978 snprintf(buff, buff_size,
"garbage:%p", (
void *)obj);
4982 asan_unpoisoning_object(obj) {
4983 raw_obj_info(buff, buff_size, obj);
4994#define OBJ_INFO_BUFFERS_NUM 10
4995#define OBJ_INFO_BUFFERS_SIZE 0x100
4997static char obj_info_buffers[OBJ_INFO_BUFFERS_NUM][OBJ_INFO_BUFFERS_SIZE];
5005 if (RB_UNLIKELY(oldval >= maxval - 1)) {
5016 rb_atomic_t index = atomic_inc_wraparound(&obj_info_buffers_index, OBJ_INFO_BUFFERS_NUM);
5017 char *
const buff = obj_info_buffers[index];
5018 return rb_raw_obj_info(buff, OBJ_INFO_BUFFERS_SIZE, obj);
5024 return obj_type_name(obj);
5042 rb_vraise(argv->exc, argv->fmt, *argv->ap);
5047gc_raise(
VALUE exc,
const char *fmt, ...)
5055 if (ruby_thread_has_gvl_p()) {
5065 fprintf(stderr,
"%s",
"[FATAL] ");
5066 vfprintf(stderr, fmt, ap);
5073NORETURN(
static void negative_size_allocation_error(
const char *));
5075negative_size_allocation_error(
const char *msg)
5081ruby_memerror_body(
void *dummy)
5087NORETURN(
static void ruby_memerror(
void));
5092 if (ruby_thread_has_gvl_p()) {
5101 fprintf(stderr,
"[FATAL] failed to allocate memory\n");
5119 VALUE exc = GET_VM()->special_exceptions[ruby_error_nomemory];
5122 rb_ec_raised_p(ec, RAISED_NOMEMORY) ||
5123 rb_ec_vm_lock_rec(ec) != ec->tag->lock_rec) {
5124 fprintf(stderr,
"[FATAL] failed to allocate memory\n");
5127 if (rb_ec_raised_p(ec, RAISED_NOMEMORY)) {
5128 rb_ec_raised_clear(ec);
5131 rb_ec_raised_set(ec, RAISED_NOMEMORY);
5132 exc = ruby_vm_special_exception_copy(exc);
5135 EC_JUMP_TAG(ec, TAG_RAISE);
5139rb_memerror_reentered(
void)
5142 return (ec && rb_ec_raised_p(ec, RAISED_NOMEMORY));
5146handle_malloc_failure(
void *ptr)
5157static void *ruby_xmalloc_body(
size_t size);
5160ruby_xmalloc(
size_t size)
5162 return handle_malloc_failure(ruby_xmalloc_body(size));
5166ruby_xmalloc_body(
size_t size)
5168 if ((ssize_t)size < 0) {
5169 negative_size_allocation_error(
"too large allocation size");
5172 return rb_gc_impl_malloc(rb_gc_get_objspace(), size);
5176ruby_malloc_size_overflow(
size_t count,
size_t elsize)
5178 rb_raise(rb_eArgError,
5179 "malloc: possible integer overflow (%"PRIuSIZE
"*%"PRIuSIZE
")",
5184ruby_malloc_add_size_overflow(
size_t x,
size_t y)
5186 rb_raise(rb_eArgError,
5187 "malloc: possible integer overflow (%"PRIuSIZE
"+%"PRIuSIZE
")",
5191static void *ruby_xmalloc2_body(
size_t n,
size_t size);
5194ruby_xmalloc2(
size_t n,
size_t size)
5196 return handle_malloc_failure(ruby_xmalloc2_body(n, size));
5200ruby_xmalloc2_body(
size_t n,
size_t size)
5202 return rb_gc_impl_malloc(rb_gc_get_objspace(), xmalloc2_size(n, size));
5205static void *ruby_xcalloc_body(
size_t n,
size_t size);
5208ruby_xcalloc(
size_t n,
size_t size)
5210 return handle_malloc_failure(ruby_xcalloc_body(n, size));
5214ruby_xcalloc_body(
size_t n,
size_t size)
5216 return rb_gc_impl_calloc(rb_gc_get_objspace(), xmalloc2_size(n, size));
5219static void *ruby_sized_xrealloc_body(
void *ptr,
size_t new_size,
size_t old_size);
5221#ifdef ruby_sized_xrealloc
5222#undef ruby_sized_xrealloc
5225ruby_sized_xrealloc(
void *ptr,
size_t new_size,
size_t old_size)
5227 return handle_malloc_failure(ruby_sized_xrealloc_body(ptr, new_size, old_size));
5231ruby_sized_xrealloc_body(
void *ptr,
size_t new_size,
size_t old_size)
5233 if ((ssize_t)new_size < 0) {
5234 negative_size_allocation_error(
"too large allocation size");
5237 return rb_gc_impl_realloc(rb_gc_get_objspace(), ptr, new_size, old_size);
5241ruby_xrealloc(
void *ptr,
size_t new_size)
5243 return ruby_sized_xrealloc(ptr, new_size, 0);
5246static void *ruby_sized_xrealloc2_body(
void *ptr,
size_t n,
size_t size,
size_t old_n);
5248#ifdef ruby_sized_xrealloc2
5249#undef ruby_sized_xrealloc2
5252ruby_sized_xrealloc2(
void *ptr,
size_t n,
size_t size,
size_t old_n)
5254 return handle_malloc_failure(ruby_sized_xrealloc2_body(ptr, n, size, old_n));
5258ruby_sized_xrealloc2_body(
void *ptr,
size_t n,
size_t size,
size_t old_n)
5260 size_t len = xmalloc2_size(n, size);
5261 return rb_gc_impl_realloc(rb_gc_get_objspace(), ptr,
len, old_n * size);
5265ruby_xrealloc2(
void *ptr,
size_t n,
size_t size)
5267 return ruby_sized_xrealloc2(ptr, n, size, 0);
5270#ifdef ruby_sized_xfree
5271#undef ruby_sized_xfree
5274ruby_sized_xfree(
void *x,
size_t size)
5280 if (LIKELY(GET_VM())) {
5281 rb_gc_impl_free(rb_gc_get_objspace(), x, size);
5292 ruby_sized_xfree(x, 0);
5296rb_xmalloc_mul_add(
size_t x,
size_t y,
size_t z)
5298 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
5299 return ruby_xmalloc(w);
5303rb_xcalloc_mul_add(
size_t x,
size_t y,
size_t z)
5305 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
5306 return ruby_xcalloc(w, 1);
5310rb_xrealloc_mul_add(
const void *p,
size_t x,
size_t y,
size_t z)
5312 size_t w = size_mul_add_or_raise(x, y, z, rb_eArgError);
5313 return ruby_xrealloc((
void *)p, w);
5317rb_xmalloc_mul_add_mul(
size_t x,
size_t y,
size_t z,
size_t w)
5319 size_t u = size_mul_add_mul_or_raise(x, y, z, w, rb_eArgError);
5320 return ruby_xmalloc(u);
5324rb_xcalloc_mul_add_mul(
size_t x,
size_t y,
size_t z,
size_t w)
5326 size_t u = size_mul_add_mul_or_raise(x, y, z, w, rb_eArgError);
5327 return ruby_xcalloc(u, 1);
5334ruby_mimmalloc(
size_t size)
5337#if CALC_EXACT_MALLOC_SIZE
5341#if CALC_EXACT_MALLOC_SIZE
5357ruby_mimcalloc(
size_t num,
size_t size)
5360#if CALC_EXACT_MALLOC_SIZE
5361 struct rbimpl_size_mul_overflow_tag t = rbimpl_size_mul_overflow(num, size);
5362 if (UNLIKELY(t.left)) {
5366 mem = calloc1(size);
5378 mem = calloc(num, size);
5384ruby_mimfree(
void *ptr)
5386#if CALC_EXACT_MALLOC_SIZE
5394rb_gc_adjust_memory_usage(ssize_t diff)
5396 unless_objspace(
objspace) {
return; }
5398 rb_gc_impl_adjust_memory_usage(
objspace, diff);
5402rb_obj_info(
VALUE obj)
5404 return obj_info(obj);
5408rb_obj_info_dump(
VALUE obj)
5411 fprintf(stderr,
"rb_obj_info_dump: %s\n", rb_raw_obj_info(buff, 0x100, obj));
5415rb_obj_info_dump_loc(
VALUE obj,
const char *file,
int line,
const char *func)
5418 fprintf(stderr,
"<OBJ_INFO:%s@%s:%d> %s\n", func, file, line, rb_raw_obj_info(buff, 0x100, obj));
5422rb_gc_before_fork(
void)
5424 rb_gc_impl_before_fork(rb_gc_get_objspace());
5428rb_gc_after_fork(rb_pid_t pid)
5430 rb_gc_impl_after_fork(rb_gc_get_objspace(), pid);
5484 rb_gc_register_address(&id2ref_value);
5486 malloc_offset = gc_compute_malloc_offset();
5499 rb_vm_register_special_exception(ruby_error_nomemory,
rb_eNoMemError,
"failed to allocate memory");
5522ruby_annotate_mmap(
const void *addr,
unsigned long size,
const char *name)
5524#if defined(HAVE_SYS_PRCTL_H) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
5527 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 STATIC_SYM_P
Old name of RB_STATIC_SYM_P.
#define T_TRUE
Old name of RUBY_T_TRUE.
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define T_HASH
Old name of RUBY_T_HASH.
#define FL_ABLE
Old name of RB_FL_ABLE.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define rb_ary_new3
Old name of rb_ary_new_from_args.
#define LONG2NUM
Old name of RB_LONG2NUM.
#define T_FALSE
Old name of RUBY_T_FALSE.
#define 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.
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.
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.
struct rb_data_type_struct::@55 function
Function pointers.
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.