1#include "ruby/internal/config.h"
8# ifdef HAVE_SYS_PRCTL_H
13#if !defined(PAGE_SIZE) && defined(HAVE_SYS_USER_H)
18#ifdef BUILDING_MODULAR_GC
19# define nlz_int64(x) (x == 0 ? 64 : (unsigned int)__builtin_clzll((unsigned long long)x))
21# include "internal/bits.h"
31#include "ccan/list/list.h"
34#include "gc/gc_impl.h"
36#ifndef BUILDING_MODULAR_GC
40#ifdef BUILDING_MODULAR_GC
41# define RB_DEBUG_COUNTER_INC(_name) ((void)0)
42# define RB_DEBUG_COUNTER_INC_IF(_name, cond) (!!(cond))
44# include "debug_counter.h"
47#ifdef BUILDING_MODULAR_GC
48# define rb_asan_poison_object(obj) ((void)(obj))
49# define rb_asan_unpoison_object(obj, newobj_p) ((void)(obj), (void)(newobj_p))
50# define asan_unpoisoning_object(obj) if ((obj) || true)
51# define asan_poison_memory_region(ptr, size) ((void)(ptr), (void)(size))
52# define asan_unpoison_memory_region(ptr, size, malloc_p) ((void)(ptr), (size), (malloc_p))
53# define asan_unpoisoning_memory_region(ptr, size) if ((ptr) || (size) || true)
55# define VALGRIND_MAKE_MEM_DEFINED(ptr, size) ((void)(ptr), (void)(size))
56# define VALGRIND_MAKE_MEM_UNDEFINED(ptr, size) ((void)(ptr), (void)(size))
58# include "internal/sanitizers.h"
62#ifndef HAVE_MALLOC_USABLE_SIZE
64# define HAVE_MALLOC_USABLE_SIZE
65# define malloc_usable_size(a) _msize(a)
66# elif defined HAVE_MALLOC_SIZE
67# define HAVE_MALLOC_USABLE_SIZE
68# define malloc_usable_size(a) malloc_size(a)
72#ifdef HAVE_MALLOC_USABLE_SIZE
73# ifdef RUBY_ALTERNATIVE_MALLOC_HEADER
75# elif defined(HAVE_MALLOC_H)
77# elif defined(HAVE_MALLOC_NP_H)
78# include <malloc_np.h>
79# elif defined(HAVE_MALLOC_MALLOC_H)
80# include <malloc/malloc.h>
84#ifdef HAVE_MALLOC_TRIM
89# include <emscripten/emmalloc.h>
93#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
94# include <mach/task.h>
95# include <mach/mach_init.h>
96# include <mach/mach_port.h>
100# define VM_CHECK_MODE RUBY_DEBUG
104#ifndef RACTOR_CHECK_MODE
105# define RACTOR_CHECK_MODE (VM_CHECK_MODE || RUBY_DEBUG) && (SIZEOF_UINT64_T == SIZEOF_VALUE)
108#ifndef RUBY_DEBUG_LOG
109# define RUBY_DEBUG_LOG(...)
112#ifndef GC_HEAP_INIT_SLOTS
113#define GC_HEAP_INIT_SLOTS 10000
115#ifndef GC_HEAP_FREE_SLOTS
116#define GC_HEAP_FREE_SLOTS 4096
118#ifndef GC_HEAP_GROWTH_FACTOR
119#define GC_HEAP_GROWTH_FACTOR 1.8
121#ifndef GC_HEAP_GROWTH_MAX_SLOTS
122#define GC_HEAP_GROWTH_MAX_SLOTS 0
124#ifndef GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO
125# define GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO 0.01
127#ifndef GC_HEAP_OLDOBJECT_LIMIT_FACTOR
128#define GC_HEAP_OLDOBJECT_LIMIT_FACTOR 2.0
131#ifndef GC_HEAP_FREE_SLOTS_MIN_RATIO
132#define GC_HEAP_FREE_SLOTS_MIN_RATIO 0.20
134#ifndef GC_HEAP_FREE_SLOTS_GOAL_RATIO
135#define GC_HEAP_FREE_SLOTS_GOAL_RATIO 0.40
137#ifndef GC_HEAP_FREE_SLOTS_MAX_RATIO
138#define GC_HEAP_FREE_SLOTS_MAX_RATIO 0.65
141#ifndef GC_MALLOC_LIMIT_MIN
142#define GC_MALLOC_LIMIT_MIN (16 * 1024 * 1024 )
144#ifndef GC_MALLOC_LIMIT_MAX
145#define GC_MALLOC_LIMIT_MAX (32 * 1024 * 1024 )
147#ifndef GC_MALLOC_LIMIT_GROWTH_FACTOR
148#define GC_MALLOC_LIMIT_GROWTH_FACTOR 1.4
151#ifndef GC_OLDMALLOC_LIMIT_MIN
152#define GC_OLDMALLOC_LIMIT_MIN (16 * 1024 * 1024 )
154#ifndef GC_OLDMALLOC_LIMIT_GROWTH_FACTOR
155#define GC_OLDMALLOC_LIMIT_GROWTH_FACTOR 1.2
157#ifndef GC_OLDMALLOC_LIMIT_MAX
158#define GC_OLDMALLOC_LIMIT_MAX (128 * 1024 * 1024 )
161#ifndef GC_CAN_COMPILE_COMPACTION
163# define GC_CAN_COMPILE_COMPACTION 0
165# define GC_CAN_COMPILE_COMPACTION 1
169#ifndef PRINT_ENTER_EXIT_TICK
170# define PRINT_ENTER_EXIT_TICK 0
172#ifndef PRINT_ROOT_TICKS
173#define PRINT_ROOT_TICKS 0
176#define USE_TICK_T (PRINT_ENTER_EXIT_TICK || PRINT_ROOT_TICKS)
185 size_t allocated_objects_count;
189 size_t incremental_mark_step_allocated_slots;
194 size_t heap_init_slots[HEAP_COUNT];
195 size_t heap_free_slots;
196 double growth_factor;
197 size_t growth_max_slots;
199 double heap_free_slots_min_ratio;
200 double heap_free_slots_goal_ratio;
201 double heap_free_slots_max_ratio;
202 double uncollectible_wb_unprotected_objects_limit_ratio;
203 double oldobject_limit_factor;
205 size_t malloc_limit_min;
206 size_t malloc_limit_max;
207 double malloc_limit_growth_factor;
209 size_t oldmalloc_limit_min;
210 size_t oldmalloc_limit_max;
211 double oldmalloc_limit_growth_factor;
215 { GC_HEAP_INIT_SLOTS },
217 GC_HEAP_GROWTH_FACTOR,
218 GC_HEAP_GROWTH_MAX_SLOTS,
220 GC_HEAP_FREE_SLOTS_MIN_RATIO,
221 GC_HEAP_FREE_SLOTS_GOAL_RATIO,
222 GC_HEAP_FREE_SLOTS_MAX_RATIO,
223 GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO,
224 GC_HEAP_OLDOBJECT_LIMIT_FACTOR,
228 GC_MALLOC_LIMIT_GROWTH_FACTOR,
230 GC_OLDMALLOC_LIMIT_MIN,
231 GC_OLDMALLOC_LIMIT_MAX,
232 GC_OLDMALLOC_LIMIT_GROWTH_FACTOR,
251#define RGENGC_DEBUG -1
253#define RGENGC_DEBUG 0
256#if RGENGC_DEBUG < 0 && !defined(_MSC_VER)
257# define RGENGC_DEBUG_ENABLED(level) (-(RGENGC_DEBUG) >= (level) && ruby_rgengc_debug >= (level))
258#elif defined(HAVE_VA_ARGS_MACRO)
259# define RGENGC_DEBUG_ENABLED(level) ((RGENGC_DEBUG) >= (level))
261# define RGENGC_DEBUG_ENABLED(level) 0
263int ruby_rgengc_debug;
270#ifndef RGENGC_PROFILE
271# define RGENGC_PROFILE 0
280#ifndef RGENGC_ESTIMATE_OLDMALLOC
281# define RGENGC_ESTIMATE_OLDMALLOC 1
284#ifndef GC_PROFILE_MORE_DETAIL
285# define GC_PROFILE_MORE_DETAIL 0
287#ifndef GC_PROFILE_DETAIL_MEMORY
288# define GC_PROFILE_DETAIL_MEMORY 0
290#ifndef GC_ENABLE_LAZY_SWEEP
291# define GC_ENABLE_LAZY_SWEEP 1
293#ifndef CALC_EXACT_MALLOC_SIZE
294# define CALC_EXACT_MALLOC_SIZE 0
296#if defined(HAVE_MALLOC_USABLE_SIZE) || CALC_EXACT_MALLOC_SIZE > 0
297# ifndef MALLOC_ALLOCATED_SIZE
298# define MALLOC_ALLOCATED_SIZE 0
301# define MALLOC_ALLOCATED_SIZE 0
303#ifndef MALLOC_ALLOCATED_SIZE_CHECK
304# define MALLOC_ALLOCATED_SIZE_CHECK 0
307#ifndef GC_DEBUG_STRESS_TO_CLASS
308# define GC_DEBUG_STRESS_TO_CLASS 1
312 GPR_FLAG_NONE = 0x000,
314 GPR_FLAG_MAJOR_BY_NOFREE = 0x001,
315 GPR_FLAG_MAJOR_BY_OLDGEN = 0x002,
316 GPR_FLAG_MAJOR_BY_SHADY = 0x004,
317 GPR_FLAG_MAJOR_BY_FORCE = 0x008,
318#if RGENGC_ESTIMATE_OLDMALLOC
319 GPR_FLAG_MAJOR_BY_OLDMALLOC = 0x020,
321 GPR_FLAG_MAJOR_MASK = 0x0ff,
324 GPR_FLAG_NEWOBJ = 0x100,
325 GPR_FLAG_MALLOC = 0x200,
326 GPR_FLAG_METHOD = 0x400,
327 GPR_FLAG_CAPI = 0x800,
328 GPR_FLAG_STRESS = 0x1000,
331 GPR_FLAG_IMMEDIATE_SWEEP = 0x2000,
332 GPR_FLAG_HAVE_FINALIZE = 0x4000,
333 GPR_FLAG_IMMEDIATE_MARK = 0x8000,
334 GPR_FLAG_FULL_MARK = 0x10000,
335 GPR_FLAG_COMPACT = 0x20000,
338 (GPR_FLAG_FULL_MARK | GPR_FLAG_IMMEDIATE_MARK |
339 GPR_FLAG_IMMEDIATE_SWEEP | GPR_FLAG_CAPI),
340} gc_profile_record_flag;
346 double gc_invoke_time;
348 size_t heap_total_objects;
349 size_t heap_use_size;
350 size_t heap_total_size;
351 size_t moved_objects;
353#if GC_PROFILE_MORE_DETAIL
355 double gc_sweep_time;
357 size_t heap_use_pages;
358 size_t heap_live_objects;
359 size_t heap_free_objects;
361 size_t allocate_increase;
362 size_t allocate_limit;
365 size_t removing_objects;
366 size_t empty_objects;
367#if GC_PROFILE_DETAIL_MEMORY
373#if MALLOC_ALLOCATED_SIZE
374 size_t allocated_size;
377#if RGENGC_PROFILE > 0
379 size_t remembered_normal_objects;
380 size_t remembered_shady_objects;
388 uint32_t original_shape_id;
391#define RMOVED(obj) ((struct RMoved *)(obj))
393typedef uintptr_t bits_t;
395 BITS_SIZE =
sizeof(bits_t),
396 BITS_BITLENGTH = ( BITS_SIZE * CHAR_BIT )
409#define STACK_CHUNK_SIZE 500
412 VALUE data[STACK_CHUNK_SIZE];
422 size_t unused_cache_size;
425typedef int (*gc_compact_compare_func)(
const void *l,
const void *r,
void *d);
431 size_t total_allocated_pages;
432 size_t force_major_gc_count;
433 size_t force_incremental_marking_finish_count;
434 size_t total_allocated_objects;
435 size_t total_freed_objects;
436 size_t final_slots_count;
443 struct ccan_list_head pages;
446 uintptr_t compact_cursor_index;
455 gc_stress_no_immediate_sweep,
456 gc_stress_full_mark_after_malloc,
471#if MALLOC_ALLOCATED_SIZE
472 size_t allocated_size;
482 unsigned int mode : 2;
483 unsigned int immediate_sweep : 1;
484 unsigned int dont_gc : 1;
485 unsigned int dont_incremental : 1;
486 unsigned int during_gc : 1;
487 unsigned int during_compacting : 1;
488 unsigned int during_reference_updating : 1;
489 unsigned int gc_stressful: 1;
490 unsigned int has_newobj_hook: 1;
491 unsigned int during_minor_gc : 1;
492 unsigned int during_incremental_marking : 1;
493 unsigned int measure_gc : 1;
494 unsigned int check_shareable : 1;
500 size_t empty_pages_count;
513 size_t allocated_pages;
516 size_t freeable_pages;
518 size_t allocatable_slots;
521 VALUE deferred_final;
528 unsigned int latest_gc_info;
534#if GC_PROFILE_MORE_DETAIL
539 size_t minor_gc_count;
540 size_t major_gc_count;
541 size_t compact_count;
542 size_t read_barrier_faults;
543#if RGENGC_PROFILE > 0
544 size_t total_generated_normal_object_count;
545 size_t total_generated_shady_object_count;
546 size_t total_shade_operation_count;
547 size_t total_promoted_count;
548 size_t total_remembered_normal_object_count;
549 size_t total_remembered_shady_object_count;
551#if RGENGC_PROFILE >= 2
552 size_t generated_normal_object_count_types[
RUBY_T_MASK];
553 size_t generated_shady_object_count_types[
RUBY_T_MASK];
556 size_t remembered_normal_object_count_types[
RUBY_T_MASK];
557 size_t remembered_shady_object_count_types[
RUBY_T_MASK];
562 double gc_sweep_start_time;
563 size_t total_allocated_objects_at_gc_start;
564 size_t heap_used_at_gc_start;
568 unsigned long long marking_time_ns;
570 unsigned long long sweeping_time_ns;
571 struct timespec sweeping_start_time;
574 size_t weak_references_count;
575 size_t retained_weak_references_count;
578 VALUE gc_stress_mode;
581 bool parent_object_old_p;
585 size_t last_major_gc;
586 size_t uncollectible_wb_unprotected_objects;
587 size_t uncollectible_wb_unprotected_objects_limit;
589 size_t old_objects_limit;
591#if RGENGC_ESTIMATE_OLDMALLOC
592 size_t oldmalloc_increase;
593 size_t oldmalloc_increase_limit;
596#if RGENGC_CHECK_MODE >= 2
603 size_t considered_count_table[
T_MASK];
604 size_t moved_count_table[
T_MASK];
605 size_t moved_up_count_table[
T_MASK];
606 size_t moved_down_count_table[
T_MASK];
610 gc_compact_compare_func compare_func;
618#if GC_DEBUG_STRESS_TO_CLASS
619 VALUE stress_to_class;
622 rb_darray(
VALUE *) weak_references;
625 unsigned long live_ractor_cache_count;
628#ifndef HEAP_PAGE_ALIGN_LOG
630#define HEAP_PAGE_ALIGN_LOG 16
633#if RACTOR_CHECK_MODE || GC_DEBUG
634struct rvalue_overhead {
635# if RACTOR_CHECK_MODE
636 uint32_t _ractor_belonging_id;
645# define RVALUE_OVERHEAD (sizeof(struct { \
647 struct rvalue_overhead overhead; \
651size_t rb_gc_impl_obj_slot_size(
VALUE obj);
652# define GET_RVALUE_OVERHEAD(obj) ((struct rvalue_overhead *)((uintptr_t)obj + rb_gc_impl_obj_slot_size(obj)))
654# ifndef RVALUE_OVERHEAD
655# define RVALUE_OVERHEAD 0
659#define BASE_SLOT_SIZE (sizeof(struct RBasic) + sizeof(VALUE[RBIMPL_RVALUE_EMBED_LEN_MAX]) + RVALUE_OVERHEAD)
662# define MAX(a, b) (((a) > (b)) ? (a) : (b))
665# define MIN(a, b) (((a) < (b)) ? (a) : (b))
667#define roomof(x, y) (((x) + (y) - 1) / (y))
668#define CEILDIV(i, mod) roomof(i, mod)
670 HEAP_PAGE_ALIGN = (1UL << HEAP_PAGE_ALIGN_LOG),
671 HEAP_PAGE_ALIGN_MASK = (~(~0UL << HEAP_PAGE_ALIGN_LOG)),
672 HEAP_PAGE_SIZE = HEAP_PAGE_ALIGN,
673 HEAP_PAGE_OBJ_LIMIT = (
unsigned int)((HEAP_PAGE_SIZE -
sizeof(
struct heap_page_header)) / BASE_SLOT_SIZE),
674 HEAP_PAGE_BITMAP_LIMIT = CEILDIV(CEILDIV(HEAP_PAGE_SIZE, BASE_SLOT_SIZE), BITS_BITLENGTH),
675 HEAP_PAGE_BITMAP_SIZE = (BITS_SIZE * HEAP_PAGE_BITMAP_LIMIT),
677#define HEAP_PAGE_ALIGN (1 << HEAP_PAGE_ALIGN_LOG)
678#define HEAP_PAGE_SIZE HEAP_PAGE_ALIGN
680#if !defined(INCREMENTAL_MARK_STEP_ALLOCATIONS)
681# define INCREMENTAL_MARK_STEP_ALLOCATIONS 500
684#undef INIT_HEAP_PAGE_ALLOC_USE_MMAP
690static const bool HEAP_PAGE_ALLOC_USE_MMAP =
false;
692#elif defined(__wasm__)
696static const bool HEAP_PAGE_ALLOC_USE_MMAP =
false;
698#elif HAVE_CONST_PAGE_SIZE
700static const bool HEAP_PAGE_ALLOC_USE_MMAP = (PAGE_SIZE <= HEAP_PAGE_SIZE);
702#elif defined(PAGE_MAX_SIZE) && (PAGE_MAX_SIZE <= HEAP_PAGE_SIZE)
704static const bool HEAP_PAGE_ALLOC_USE_MMAP =
true;
706#elif defined(PAGE_SIZE)
708# define INIT_HEAP_PAGE_ALLOC_USE_MMAP (PAGE_SIZE <= HEAP_PAGE_SIZE)
710#elif defined(HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
712# define INIT_HEAP_PAGE_ALLOC_USE_MMAP (sysconf(_SC_PAGE_SIZE) <= HEAP_PAGE_SIZE)
716static const bool HEAP_PAGE_ALLOC_USE_MMAP =
false;
719#ifdef INIT_HEAP_PAGE_ALLOC_USE_MMAP
721# define HEAP_PAGE_ALLOC_USE_MMAP (heap_page_alloc_use_mmap != false)
723static bool heap_page_alloc_use_mmap;
726#define RVALUE_AGE_BIT_COUNT 2
727#define RVALUE_AGE_BIT_MASK (((bits_t)1 << RVALUE_AGE_BIT_COUNT) - 1)
728#define RVALUE_OLD_AGE 3
736 unsigned short slot_size;
737 unsigned short total_slots;
738 unsigned short free_slots;
739 unsigned short final_slots;
740 unsigned short pinned_slots;
742 unsigned int before_sweep : 1;
743 unsigned int has_remembered_objects : 1;
744 unsigned int has_uncollectible_wb_unprotected_objects : 1;
753 struct ccan_list_node page_node;
755 bits_t wb_unprotected_bits[HEAP_PAGE_BITMAP_LIMIT];
757 bits_t mark_bits[HEAP_PAGE_BITMAP_LIMIT];
758 bits_t uncollectible_bits[HEAP_PAGE_BITMAP_LIMIT];
759 bits_t marking_bits[HEAP_PAGE_BITMAP_LIMIT];
761 bits_t remembered_bits[HEAP_PAGE_BITMAP_LIMIT];
764 bits_t pinned_bits[HEAP_PAGE_BITMAP_LIMIT];
765 bits_t age_bits[HEAP_PAGE_BITMAP_LIMIT * RVALUE_AGE_BIT_COUNT];
772asan_lock_freelist(
struct heap_page *page)
774 asan_poison_memory_region(&page->freelist,
sizeof(
struct free_list *));
781asan_unlock_freelist(
struct heap_page *page)
783 asan_unpoison_memory_region(&page->freelist,
sizeof(
struct free_list *),
false);
789 if (page->total_slots == 0) {
790 GC_ASSERT(page->start == 0);
791 GC_ASSERT(page->slot_size == 0);
792 GC_ASSERT(page->heap == NULL);
793 GC_ASSERT(page->free_slots == 0);
794 asan_unpoisoning_memory_region(&page->freelist,
sizeof(&page->freelist)) {
795 GC_ASSERT(page->freelist == NULL);
801 GC_ASSERT(page->start != 0);
802 GC_ASSERT(page->slot_size != 0);
803 GC_ASSERT(page->heap != NULL);
809#define GET_PAGE_BODY(x) ((struct heap_page_body *)((bits_t)(x) & ~(HEAP_PAGE_ALIGN_MASK)))
810#define GET_PAGE_HEADER(x) (&GET_PAGE_BODY(x)->header)
811#define GET_HEAP_PAGE(x) (GET_PAGE_HEADER(x)->page)
813#define NUM_IN_PAGE(p) (((bits_t)(p) & HEAP_PAGE_ALIGN_MASK) / BASE_SLOT_SIZE)
814#define BITMAP_INDEX(p) (NUM_IN_PAGE(p) / BITS_BITLENGTH )
815#define BITMAP_OFFSET(p) (NUM_IN_PAGE(p) & (BITS_BITLENGTH-1))
816#define BITMAP_BIT(p) ((bits_t)1 << BITMAP_OFFSET(p))
819#define MARKED_IN_BITMAP(bits, p) ((bits)[BITMAP_INDEX(p)] & BITMAP_BIT(p))
820#define MARK_IN_BITMAP(bits, p) ((bits)[BITMAP_INDEX(p)] = (bits)[BITMAP_INDEX(p)] | BITMAP_BIT(p))
821#define CLEAR_IN_BITMAP(bits, p) ((bits)[BITMAP_INDEX(p)] = (bits)[BITMAP_INDEX(p)] & ~BITMAP_BIT(p))
824#define GET_HEAP_MARK_BITS(x) (&GET_HEAP_PAGE(x)->mark_bits[0])
825#define GET_HEAP_PINNED_BITS(x) (&GET_HEAP_PAGE(x)->pinned_bits[0])
826#define GET_HEAP_UNCOLLECTIBLE_BITS(x) (&GET_HEAP_PAGE(x)->uncollectible_bits[0])
827#define GET_HEAP_WB_UNPROTECTED_BITS(x) (&GET_HEAP_PAGE(x)->wb_unprotected_bits[0])
828#define GET_HEAP_MARKING_BITS(x) (&GET_HEAP_PAGE(x)->marking_bits[0])
830#define RVALUE_AGE_BITMAP_INDEX(n) (NUM_IN_PAGE(n) / (BITS_BITLENGTH / RVALUE_AGE_BIT_COUNT))
831#define RVALUE_AGE_BITMAP_OFFSET(n) ((NUM_IN_PAGE(n) % (BITS_BITLENGTH / RVALUE_AGE_BIT_COUNT)) * RVALUE_AGE_BIT_COUNT)
834RVALUE_AGE_GET(
VALUE obj)
836 bits_t *age_bits = GET_HEAP_PAGE(obj)->age_bits;
837 return (
int)(age_bits[RVALUE_AGE_BITMAP_INDEX(obj)] >> RVALUE_AGE_BITMAP_OFFSET(obj)) & RVALUE_AGE_BIT_MASK;
841RVALUE_AGE_SET(
VALUE obj,
int age)
844 bits_t *age_bits = GET_HEAP_PAGE(obj)->age_bits;
846 age_bits[RVALUE_AGE_BITMAP_INDEX(obj)] &= ~(RVALUE_AGE_BIT_MASK << (RVALUE_AGE_BITMAP_OFFSET(obj)));
848 age_bits[RVALUE_AGE_BITMAP_INDEX(obj)] |= ((bits_t)age << RVALUE_AGE_BITMAP_OFFSET(obj));
849 if (age == RVALUE_OLD_AGE) {
857#define malloc_limit objspace->malloc_params.limit
858#define malloc_increase objspace->malloc_params.increase
859#define malloc_allocated_size objspace->malloc_params.allocated_size
860#define heap_pages_lomem objspace->heap_pages.range[0]
861#define heap_pages_himem objspace->heap_pages.range[1]
862#define heap_pages_freeable_pages objspace->heap_pages.freeable_pages
863#define heap_pages_deferred_final objspace->heap_pages.deferred_final
864#define heaps objspace->heaps
865#define during_gc objspace->flags.during_gc
866#define finalizing objspace->atomic_flags.finalizing
867#define finalizer_table objspace->finalizer_table
868#define ruby_gc_stressful objspace->flags.gc_stressful
869#define ruby_gc_stress_mode objspace->gc_stress_mode
870#if GC_DEBUG_STRESS_TO_CLASS
871#define stress_to_class objspace->stress_to_class
872#define set_stress_to_class(c) (stress_to_class = (c))
874#define stress_to_class ((void)objspace, 0)
875#define set_stress_to_class(c) ((void)objspace, (c))
879#define dont_gc_on() (fprintf(stderr, "dont_gc_on@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = 1)
880#define dont_gc_off() (fprintf(stderr, "dont_gc_off@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = 0)
881#define dont_gc_set(b) (fprintf(stderr, "dont_gc_set(%d)@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = (int)(b))
882#define dont_gc_val() (objspace->flags.dont_gc)
884#define dont_gc_on() (objspace->flags.dont_gc = 1)
885#define dont_gc_off() (objspace->flags.dont_gc = 0)
886#define dont_gc_set(b) (objspace->flags.dont_gc = (int)(b))
887#define dont_gc_val() (objspace->flags.dont_gc)
890#define gc_config_full_mark_set(b) (objspace->gc_config.full_mark = (int)(b))
891#define gc_config_full_mark_val (objspace->gc_config.full_mark)
893#ifndef DURING_GC_COULD_MALLOC_REGION_START
894# define DURING_GC_COULD_MALLOC_REGION_START() \
895 assert(rb_during_gc()); \
896 bool _prev_enabled = rb_gc_impl_gc_enabled_p(objspace); \
897 rb_gc_impl_gc_disable(objspace, false)
900#ifndef DURING_GC_COULD_MALLOC_REGION_END
901# define DURING_GC_COULD_MALLOC_REGION_END() \
902 if (_prev_enabled) rb_gc_impl_gc_enable(objspace)
905static inline enum gc_mode
906gc_mode_verify(
enum gc_mode mode)
908#if RGENGC_CHECK_MODE > 0
911 case gc_mode_marking:
912 case gc_mode_sweeping:
913 case gc_mode_compacting:
916 rb_bug(
"gc_mode_verify: unreachable (%d)", (
int)mode);
925 for (
int i = 0; i < HEAP_COUNT; i++) {
926 if ((&heaps[i])->sweeping_page) {
937 for (
int i = 0; i < HEAP_COUNT; i++) {
938 count += (&heaps[i])->total_pages;
947 for (
int i = 0; i < HEAP_COUNT; i++) {
949 count += heap->total_allocated_objects;
958 for (
int i = 0; i < HEAP_COUNT; i++) {
960 count += heap->total_freed_objects;
969 for (
int i = 0; i < HEAP_COUNT; i++) {
971 count += heap->final_slots_count;
976#define gc_mode(objspace) gc_mode_verify((enum gc_mode)(objspace)->flags.mode)
977#define gc_mode_set(objspace, m) ((objspace)->flags.mode = (unsigned int)gc_mode_verify(m))
978#define gc_needs_major_flags objspace->rgengc.need_major_gc
980#define is_marking(objspace) (gc_mode(objspace) == gc_mode_marking)
981#define is_sweeping(objspace) (gc_mode(objspace) == gc_mode_sweeping)
982#define is_full_marking(objspace) ((objspace)->flags.during_minor_gc == FALSE)
983#define is_incremental_marking(objspace) ((objspace)->flags.during_incremental_marking != FALSE)
984#define will_be_incremental_marking(objspace) ((objspace)->rgengc.need_major_gc != GPR_FLAG_NONE)
985#define GC_INCREMENTAL_SWEEP_SLOT_COUNT 2048
986#define GC_INCREMENTAL_SWEEP_POOL_SLOT_COUNT 1024
987#define is_lazy_sweeping(objspace) (GC_ENABLE_LAZY_SWEEP && has_sweeping_pages(objspace))
989#if SIZEOF_LONG == SIZEOF_VOIDP
990# define obj_id_to_ref(objid) ((objid) ^ FIXNUM_FLAG)
991#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
992# define obj_id_to_ref(objid) (FIXNUM_P(objid) ? \
993 ((objid) ^ FIXNUM_FLAG) : (NUM2PTR(objid) << 1))
1001 void (*dfree)(
void *);
1005#define RZOMBIE(o) ((struct RZombie *)(o))
1007static bool ruby_enable_autocompact =
false;
1008#if RGENGC_CHECK_MODE
1009static gc_compact_compare_func ruby_autocompact_compare_func;
1013static int garbage_collect(
rb_objspace_t *,
unsigned int reason);
1018enum gc_enter_event {
1019 gc_enter_event_start,
1020 gc_enter_event_continue,
1021 gc_enter_event_rest,
1022 gc_enter_event_finalizer,
1025static inline void gc_enter(
rb_objspace_t *
objspace,
enum gc_enter_event event,
unsigned int *lock_lev);
1026static inline void gc_exit(
rb_objspace_t *
objspace,
enum gc_enter_event event,
unsigned int *lock_lev);
1041static int gc_mark_stacked_objects_incremental(
rb_objspace_t *,
size_t count);
1042NO_SANITIZE(
"memory",
static inline bool is_pointer_to_heap(
rb_objspace_t *
objspace,
const void *ptr));
1044static void gc_verify_internal_consistency(
void *objspace_ptr);
1046static double getrusage_time(
void);
1050static inline void gc_prof_mark_timer_start(
rb_objspace_t *);
1052static inline void gc_prof_sweep_timer_start(
rb_objspace_t *);
1053static inline void gc_prof_sweep_timer_stop(
rb_objspace_t *);
1057#define gc_prof_record(objspace) (objspace)->profile.current_record
1058#define gc_prof_enabled(objspace) ((objspace)->profile.run && (objspace)->profile.current_record)
1060#ifdef HAVE_VA_ARGS_MACRO
1061# define gc_report(level, objspace, ...) \
1062 if (!RGENGC_DEBUG_ENABLED(level)) {} else gc_report_body(level, objspace, __VA_ARGS__)
1064# define gc_report if (!RGENGC_DEBUG_ENABLED(0)) {} else gc_report_body
1066PRINTF_ARGS(
static void gc_report_body(
int level,
rb_objspace_t *
objspace,
const char *fmt, ...), 3, 4);
1068static void gc_finalize_deferred(
void *dmy);
1079#if defined(__GNUC__) && defined(__i386__)
1080typedef unsigned long long tick_t;
1081#define PRItick "llu"
1085 unsigned long long int x;
1086 __asm__ __volatile__ (
"rdtsc" :
"=A" (x));
1090#elif defined(__GNUC__) && defined(__x86_64__)
1091typedef unsigned long long tick_t;
1092#define PRItick "llu"
1094static __inline__ tick_t
1097 unsigned long hi, lo;
1098 __asm__ __volatile__ (
"rdtsc" :
"=a"(lo),
"=d"(hi));
1099 return ((
unsigned long long)lo)|( ((
unsigned long long)hi)<<32);
1102#elif defined(__powerpc64__) && (GCC_VERSION_SINCE(4,8,0) || defined(__clang__))
1103typedef unsigned long long tick_t;
1104#define PRItick "llu"
1106static __inline__ tick_t
1109 unsigned long long val = __builtin_ppc_get_timebase();
1113#elif defined(__POWERPC__) && defined(__APPLE__)
1117typedef unsigned long long tick_t;
1118#define PRItick "llu"
1120static __inline__ tick_t
1123 unsigned long int upper, lower, tmp;
1124 # define mftbu(r) __asm__ volatile("mftbu %0" : "=r"(r))
1125 # define mftb(r) __asm__ volatile("mftb %0" : "=r"(r))
1130 }
while (tmp != upper);
1131 return ((tick_t)upper << 32) | lower;
1134#elif defined(__aarch64__) && defined(__GNUC__)
1135typedef unsigned long tick_t;
1138static __inline__ tick_t
1142 __asm__ __volatile__ (
"mrs %0, cntvct_el0" :
"=r" (val));
1147#elif defined(_WIN32) && defined(_MSC_VER)
1149typedef unsigned __int64 tick_t;
1150#define PRItick "llu"
1159typedef clock_t tick_t;
1160#define PRItick "llu"
1169#define MEASURE_LINE(expr) expr
1174#define RVALUE_MARKED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_MARK_BITS(obj), (obj))
1175#define RVALUE_WB_UNPROTECTED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), (obj))
1176#define RVALUE_MARKING_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), (obj))
1177#define RVALUE_UNCOLLECTIBLE_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(obj), (obj))
1178#define RVALUE_PINNED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_PINNED_BITS(obj), (obj))
1183 check_rvalue_consistency(
objspace, obj);
1184 return RVALUE_MARKED_BITMAP(obj) != 0;
1190 check_rvalue_consistency(
objspace, obj);
1191 return RVALUE_PINNED_BITMAP(obj) != 0;
1197 check_rvalue_consistency(
objspace, obj);
1198 return RVALUE_WB_UNPROTECTED_BITMAP(obj) != 0;
1204 check_rvalue_consistency(
objspace, obj);
1205 return RVALUE_MARKING_BITMAP(obj) != 0;
1211 check_rvalue_consistency(
objspace, obj);
1212 return MARKED_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj) != 0;
1218 check_rvalue_consistency(
objspace, obj);
1219 return RVALUE_UNCOLLECTIBLE_BITMAP(obj) != 0;
1222#define RVALUE_PAGE_WB_UNPROTECTED(page, obj) MARKED_IN_BITMAP((page)->wb_unprotected_bits, (obj))
1223#define RVALUE_PAGE_UNCOLLECTIBLE(page, obj) MARKED_IN_BITMAP((page)->uncollectible_bits, (obj))
1224#define RVALUE_PAGE_MARKING(page, obj) MARKED_IN_BITMAP((page)->marking_bits, (obj))
1235 int lev = RB_GC_VM_LOCK_NO_BARRIER();
1238 fprintf(stderr,
"check_rvalue_consistency: %p is a special const.\n", (
void *)obj);
1241 else if (!is_pointer_to_heap(
objspace, (
void *)obj)) {
1243 while (empty_page) {
1244 if ((uintptr_t)empty_page->body <= (uintptr_t)obj &&
1245 (uintptr_t)obj < (uintptr_t)empty_page->body + HEAP_PAGE_SIZE) {
1246 GC_ASSERT(heap_page_in_global_empty_pages_pool(
objspace, empty_page));
1247 fprintf(stderr,
"check_rvalue_consistency: %p is in an empty page (%p).\n",
1248 (
void *)obj, (
void *)empty_page);
1253 fprintf(stderr,
"check_rvalue_consistency: %p is not a Ruby object.\n", (
void *)obj);
1259 const int wb_unprotected_bit = RVALUE_WB_UNPROTECTED_BITMAP(obj) != 0;
1260 const int uncollectible_bit = RVALUE_UNCOLLECTIBLE_BITMAP(obj) != 0;
1261 const int mark_bit = RVALUE_MARKED_BITMAP(obj) != 0;
1262 const int marking_bit = RVALUE_MARKING_BITMAP(obj) != 0;
1263 const int remembered_bit = MARKED_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj) != 0;
1264 const int age = RVALUE_AGE_GET((
VALUE)obj);
1266 if (heap_page_in_global_empty_pages_pool(
objspace, GET_HEAP_PAGE(obj))) {
1267 fprintf(stderr,
"check_rvalue_consistency: %s is in tomb page.\n", rb_obj_info(obj));
1271 fprintf(stderr,
"check_rvalue_consistency: %s is T_NONE.\n", rb_obj_info(obj));
1275 fprintf(stderr,
"check_rvalue_consistency: %s is T_ZOMBIE.\n", rb_obj_info(obj));
1280 rb_obj_memsize_of((
VALUE)obj);
1287 if (age > 0 && wb_unprotected_bit) {
1288 fprintf(stderr,
"check_rvalue_consistency: %s is not WB protected, but age is %d > 0.\n", rb_obj_info(obj), age);
1292 if (!is_marking(
objspace) && uncollectible_bit && !mark_bit) {
1293 fprintf(stderr,
"check_rvalue_consistency: %s is uncollectible, but is not marked while !gc.\n", rb_obj_info(obj));
1298 if (uncollectible_bit && age != RVALUE_OLD_AGE && !wb_unprotected_bit) {
1299 fprintf(stderr,
"check_rvalue_consistency: %s is uncollectible, but not old (age: %d) and not WB unprotected.\n",
1300 rb_obj_info(obj), age);
1303 if (remembered_bit && age != RVALUE_OLD_AGE) {
1304 fprintf(stderr,
"check_rvalue_consistency: %s is remembered, but not old (age: %d).\n",
1305 rb_obj_info(obj), age);
1317 if (is_incremental_marking(
objspace) && marking_bit) {
1318 if (!is_marking(
objspace) && !mark_bit) {
1319 fprintf(stderr,
"check_rvalue_consistency: %s is marking, but not marked.\n", rb_obj_info(obj));
1325 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
1327 if (err > 0 && terminate) {
1328 rb_bug(
"check_rvalue_consistency_force: there is %d errors.", err);
1333#if RGENGC_CHECK_MODE == 0
1343 check_rvalue_consistency_force(
objspace, obj, TRUE);
1356 asan_unpoisoning_object(obj) {
1367 check_rvalue_consistency(
objspace, obj);
1376 MARK_IN_BITMAP(&page->uncollectible_bits[0], obj);
1379#if RGENGC_PROFILE >= 2
1380 objspace->profile.total_promoted_count++;
1388 RB_DEBUG_COUNTER_INC(obj_promote);
1389 RVALUE_PAGE_OLD_UNCOLLECTIBLE_SET(
objspace, GET_HEAP_PAGE(obj), obj);
1396 int age = RVALUE_AGE_GET((
VALUE)obj);
1398 if (RGENGC_CHECK_MODE && age == RVALUE_OLD_AGE) {
1399 rb_bug(
"RVALUE_AGE_INC: can not increment age of OLD object %s.", rb_obj_info(obj));
1403 RVALUE_AGE_SET(obj, age);
1405 if (age == RVALUE_OLD_AGE) {
1406 RVALUE_OLD_UNCOLLECTIBLE_SET(
objspace, obj);
1409 check_rvalue_consistency(
objspace, obj);
1415 check_rvalue_consistency(
objspace, obj);
1416 GC_ASSERT(!RVALUE_OLD_P(
objspace, obj));
1417 RVALUE_AGE_SET(obj, RVALUE_OLD_AGE - 1);
1418 check_rvalue_consistency(
objspace, obj);
1422RVALUE_AGE_RESET(
VALUE obj)
1424 RVALUE_AGE_SET(obj, 0);
1430 check_rvalue_consistency(
objspace, obj);
1431 GC_ASSERT(RVALUE_OLD_P(
objspace, obj));
1433 if (!is_incremental_marking(
objspace) && RVALUE_REMEMBERED(
objspace, obj)) {
1434 CLEAR_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj);
1437 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(obj), obj);
1438 RVALUE_AGE_RESET(obj);
1440 if (RVALUE_MARKED(
objspace, obj)) {
1444 check_rvalue_consistency(
objspace, obj);
1456 return !RVALUE_MARKED(
objspace, obj);
1460rb_gc_impl_checking_shareable(
void *objspace_ptr)
1463 return objspace->flags.check_shareable;
1467rb_gc_impl_gc_enabled_p(
void *objspace_ptr)
1470 return !dont_gc_val();
1474rb_gc_impl_gc_enable(
void *objspace_ptr)
1482rb_gc_impl_gc_disable(
void *objspace_ptr,
bool finish_current_gc)
1486 if (finish_current_gc) {
1500 return calloc(1, n);
1504rb_gc_impl_set_event_hook(
void *objspace_ptr,
const rb_event_flag_t event)
1512rb_gc_impl_get_total_time(
void *objspace_ptr)
1516 unsigned long long marking_time =
objspace->profile.marking_time_ns;
1517 unsigned long long sweeping_time =
objspace->profile.sweeping_time_ns;
1519 return marking_time + sweeping_time;
1523rb_gc_impl_set_measure_total_time(
void *objspace_ptr,
VALUE flag)
1531rb_gc_impl_get_measure_total_time(
void *objspace_ptr)
1541 size_t heap_idx = heap - heaps;
1542 return gc_params.heap_init_slots[heap_idx];
1547rb_gc_impl_garbage_object_p(
void *objspace_ptr,
VALUE ptr)
1553 asan_unpoisoning_object(ptr) {
1565 if (dead)
return true;
1566 return is_lazy_sweeping(
objspace) && GET_HEAP_PAGE(ptr)->flags.before_sweep &&
1577 rb_asan_unpoison_object(obj,
false);
1579 asan_unlock_freelist(page);
1583 slot->next = page->freelist;
1584 page->freelist = slot;
1585 asan_lock_freelist(page);
1587 RVALUE_AGE_RESET(obj);
1589 if (RGENGC_CHECK_MODE &&
1591 !(page->start <= (uintptr_t)obj &&
1592 (uintptr_t)obj < ((uintptr_t)page->start + (page->total_slots * page->slot_size)) &&
1593 obj % BASE_SLOT_SIZE == 0)) {
1594 rb_bug(
"heap_page_add_freeobj: %p is not rvalue.", (
void *)obj);
1597 rb_asan_poison_object(obj);
1598 gc_report(3,
objspace,
"heap_page_add_freeobj: add %p to freelist\n", (
void *)obj);
1603 rb_heap_t *heap,
size_t free_slots,
size_t total_slots)
1605 double goal_ratio = gc_params.heap_free_slots_goal_ratio;
1606 size_t target_total_slots;
1608 if (goal_ratio == 0.0) {
1609 target_total_slots = (size_t)(total_slots * gc_params.growth_factor);
1611 else if (total_slots == 0) {
1612 target_total_slots = minimum_slots_for_heap(
objspace, heap);
1618 double f = (double)(total_slots - free_slots) / ((1 - goal_ratio) * total_slots);
1620 if (f > gc_params.growth_factor) f = gc_params.growth_factor;
1621 if (f < 1.0) f = 1.1;
1623 target_total_slots = (size_t)(f * total_slots);
1627 "free_slots(%8"PRIuSIZE
")/total_slots(%8"PRIuSIZE
")=%1.2f,"
1628 " G(%1.2f), f(%1.2f),"
1629 " total_slots(%8"PRIuSIZE
") => target_total_slots(%8"PRIuSIZE
")\n",
1630 free_slots, total_slots, free_slots/(
double)total_slots,
1631 goal_ratio, f, total_slots, target_total_slots);
1635 if (gc_params.growth_max_slots > 0) {
1636 size_t max_total_slots = (size_t)(total_slots + gc_params.growth_max_slots);
1637 if (target_total_slots > max_total_slots) target_total_slots = max_total_slots;
1640 size_t extend_slot_count = target_total_slots - total_slots;
1642 if (extend_slot_count == 0) extend_slot_count = 1;
1644 objspace->heap_pages.allocatable_slots += extend_slot_count;
1650 asan_unlock_freelist(page);
1651 GC_ASSERT(page->free_slots != 0);
1652 GC_ASSERT(page->freelist != NULL);
1654 page->free_next = heap->free_pages;
1655 heap->free_pages = page;
1657 RUBY_DEBUG_LOG(
"page:%p freelist:%p", (
void *)page, (
void *)page->freelist);
1659 asan_lock_freelist(page);
1665 asan_unlock_freelist(page);
1666 GC_ASSERT(page->free_slots != 0);
1667 GC_ASSERT(page->freelist != NULL);
1669 page->free_next = heap->pooled_pages;
1670 heap->pooled_pages = page;
1671 objspace->rincgc.pooled_slots += page->free_slots;
1673 asan_lock_freelist(page);
1679 ccan_list_del(&page->page_node);
1680 heap->total_pages--;
1681 heap->total_slots -= page->total_slots;
1685gc_aligned_free(
void *ptr,
size_t size)
1687#if defined __MINGW32__
1688 __mingw_aligned_free(ptr);
1691#elif defined(HAVE_POSIX_MEMALIGN) || defined(HAVE_MEMALIGN)
1694 free(((
void**)ptr)[-1]);
1701 GC_ASSERT((uintptr_t)page_body % HEAP_PAGE_ALIGN == 0);
1703 if (HEAP_PAGE_ALLOC_USE_MMAP) {
1705 GC_ASSERT(HEAP_PAGE_SIZE % sysconf(_SC_PAGE_SIZE) == 0);
1706 if (munmap(page_body, HEAP_PAGE_SIZE)) {
1707 rb_bug(
"heap_page_body_free: munmap failed");
1712 gc_aligned_free(page_body, HEAP_PAGE_SIZE);
1719 objspace->heap_pages.freed_pages++;
1720 heap_page_body_free(page->body);
1727 if (
objspace->empty_pages != NULL && heap_pages_freeable_pages > 0) {
1728 GC_ASSERT(
objspace->empty_pages_count > 0);
1733 for (i = j = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
1736 if (heap_page_in_global_empty_pages_pool(
objspace, page) && heap_pages_freeable_pages > 0) {
1738 heap_pages_freeable_pages--;
1741 if (heap_page_in_global_empty_pages_pool(
objspace, page)) {
1742 page->free_next =
objspace->empty_pages;
1748 rb_darray_set(
objspace->heap_pages.sorted, j, page);
1754 rb_darray_pop(
objspace->heap_pages.sorted, i - j);
1755 GC_ASSERT(rb_darray_size(
objspace->heap_pages.sorted) == j);
1758 uintptr_t himem = (uintptr_t)hipage->body + HEAP_PAGE_SIZE;
1759 GC_ASSERT(himem <= heap_pages_himem);
1760 heap_pages_himem = himem;
1763 uintptr_t lomem = (uintptr_t)lopage->body +
sizeof(
struct heap_page_header);
1764 GC_ASSERT(lomem >= heap_pages_lomem);
1765 heap_pages_lomem = lomem;
1770gc_aligned_malloc(
size_t alignment,
size_t size)
1773 GC_ASSERT(((alignment - 1) & alignment) == 0);
1774 GC_ASSERT(alignment %
sizeof(
void*) == 0);
1778#if defined __MINGW32__
1779 res = __mingw_aligned_malloc(size, alignment);
1781 void *_aligned_malloc(
size_t,
size_t);
1782 res = _aligned_malloc(size, alignment);
1783#elif defined(HAVE_POSIX_MEMALIGN)
1784 if (posix_memalign(&res, alignment, size) != 0) {
1787#elif defined(HAVE_MEMALIGN)
1788 res = memalign(alignment, size);
1791 res = malloc(alignment + size +
sizeof(
void*));
1792 aligned = (
char*)res + alignment +
sizeof(
void*);
1793 aligned -= ((
VALUE)aligned & (alignment - 1));
1794 ((
void**)aligned)[-1] = res;
1795 res = (
void*)aligned;
1798 GC_ASSERT((uintptr_t)res % alignment == 0);
1804heap_page_body_allocate(
void)
1808 if (HEAP_PAGE_ALLOC_USE_MMAP) {
1810 GC_ASSERT(HEAP_PAGE_ALIGN % sysconf(_SC_PAGE_SIZE) == 0);
1812 size_t mmap_size = HEAP_PAGE_ALIGN + HEAP_PAGE_SIZE;
1813 char *ptr = mmap(NULL, mmap_size,
1814 PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
1815 if (ptr == MAP_FAILED) {
1824#if defined(HAVE_SYS_PRCTL_H) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
1825 prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME, ptr, mmap_size,
"Ruby:GC:default:heap_page_body_allocate");
1829 char *aligned = ptr + HEAP_PAGE_ALIGN;
1830 aligned -= ((
VALUE)aligned & (HEAP_PAGE_ALIGN - 1));
1831 GC_ASSERT(aligned > ptr);
1832 GC_ASSERT(aligned <= ptr + HEAP_PAGE_ALIGN);
1834 size_t start_out_of_range_size = aligned - ptr;
1835 GC_ASSERT(start_out_of_range_size % sysconf(_SC_PAGE_SIZE) == 0);
1836 if (start_out_of_range_size > 0) {
1837 if (munmap(ptr, start_out_of_range_size)) {
1838 rb_bug(
"heap_page_body_allocate: munmap failed for start");
1842 size_t end_out_of_range_size = HEAP_PAGE_ALIGN - start_out_of_range_size;
1843 GC_ASSERT(end_out_of_range_size % sysconf(_SC_PAGE_SIZE) == 0);
1844 if (end_out_of_range_size > 0) {
1845 if (munmap(aligned + HEAP_PAGE_SIZE, end_out_of_range_size)) {
1846 rb_bug(
"heap_page_body_allocate: munmap failed for end");
1854 page_body = gc_aligned_malloc(HEAP_PAGE_ALIGN, HEAP_PAGE_SIZE);
1857 GC_ASSERT((uintptr_t)page_body % HEAP_PAGE_ALIGN == 0);
1866 if (
objspace->empty_pages == NULL) {
1867 GC_ASSERT(
objspace->empty_pages_count == 0);
1870 GC_ASSERT(
objspace->empty_pages_count > 0);
1873 objspace->empty_pages = page->free_next;
1883 if (page_body == 0) {
1889 heap_page_body_free(page_body);
1894 uintptr_t end = (uintptr_t)page_body + HEAP_PAGE_SIZE;
1897 size_t hi = rb_darray_size(
objspace->heap_pages.sorted);
1901 size_t mid = (lo + hi) / 2;
1902 mid_page = rb_darray_get(
objspace->heap_pages.sorted, mid);
1903 if ((uintptr_t)mid_page->start < start) {
1906 else if ((uintptr_t)mid_page->start > start) {
1910 rb_bug(
"same heap page is allocated: %p at %"PRIuVALUE, (
void *)page_body, (
VALUE)mid);
1914 rb_darray_insert_without_gc(&
objspace->heap_pages.sorted, hi, page);
1916 if (heap_pages_lomem == 0 || heap_pages_lomem > start) heap_pages_lomem = start;
1917 if (heap_pages_himem < end) heap_pages_himem = end;
1919 page->body = page_body;
1920 page_body->header.page = page;
1922 objspace->heap_pages.allocated_pages++;
1931 GC_ASSERT(!heap->sweeping_page);
1932 GC_ASSERT(heap_page_in_global_empty_pages_pool(
objspace, page));
1936 if (start % BASE_SLOT_SIZE != 0) {
1937 int delta = BASE_SLOT_SIZE - (start % BASE_SLOT_SIZE);
1938 start = start + delta;
1939 GC_ASSERT(NUM_IN_PAGE(start) == 0 || NUM_IN_PAGE(start) == 1);
1945 if (NUM_IN_PAGE(start) == 1) {
1946 start += heap->slot_size - BASE_SLOT_SIZE;
1949 GC_ASSERT(NUM_IN_PAGE(start) * BASE_SLOT_SIZE % heap->slot_size == 0);
1952 int slot_count = (int)((HEAP_PAGE_SIZE - (start - (uintptr_t)page->body))/heap->slot_size);
1954 page->start = start;
1955 page->total_slots = slot_count;
1956 page->slot_size = heap->slot_size;
1959 asan_unlock_freelist(page);
1960 page->freelist = NULL;
1961 asan_unpoison_memory_region(page->body, HEAP_PAGE_SIZE,
false);
1962 for (
VALUE p = (
VALUE)start; p < start + (slot_count * heap->slot_size); p += heap->slot_size) {
1963 heap_page_add_freeobj(
objspace, page, p);
1965 asan_lock_freelist(page);
1967 page->free_slots = slot_count;
1969 heap->total_allocated_pages++;
1971 ccan_list_add_tail(&heap->pages, &page->page_node);
1972 heap->total_pages++;
1973 heap->total_slots += page->total_slots;
1979 gc_report(1,
objspace,
"heap_page_allocate_and_initialize: rb_darray_size(objspace->heap_pages.sorted): %"PRIdSIZE
", "
1980 "allocatable_slots: %"PRIdSIZE
", heap->total_pages: %"PRIdSIZE
"\n",
1981 rb_darray_size(
objspace->heap_pages.sorted),
objspace->heap_pages.allocatable_slots, heap->total_pages);
1983 bool allocated =
false;
1986 if (page == NULL &&
objspace->heap_pages.allocatable_slots > 0) {
1987 page = heap_page_allocate(
objspace);
1990 GC_ASSERT(page != NULL);
1994 heap_add_page(
objspace, heap, page);
1995 heap_add_freepage(heap, page);
1998 if (
objspace->heap_pages.allocatable_slots > (
size_t)page->total_slots) {
1999 objspace->heap_pages.allocatable_slots -= page->total_slots;
2002 objspace->heap_pages.allocatable_slots = 0;
2007 return page != NULL;
2013 size_t prev_allocatable_slots =
objspace->heap_pages.allocatable_slots;
2015 objspace->heap_pages.allocatable_slots = 1;
2016 heap_page_allocate_and_initialize(
objspace, heap);
2017 GC_ASSERT(heap->free_pages != NULL);
2018 objspace->heap_pages.allocatable_slots = prev_allocatable_slots;
2024 unsigned int lock_lev;
2025 gc_enter(
objspace, gc_enter_event_continue, &lock_lev);
2028 if (is_incremental_marking(
objspace)) {
2029 if (gc_marks_continue(
objspace, heap)) {
2036 if (heap->free_pages == NULL && is_lazy_sweeping(
objspace)) {
2040 gc_exit(
objspace, gc_enter_event_continue, &lock_lev);
2046 GC_ASSERT(heap->free_pages == NULL);
2048 if (heap->total_slots < gc_params.heap_init_slots[heap - heaps] &&
2049 heap->sweeping_page == NULL) {
2050 heap_page_allocate_and_initialize_force(
objspace, heap);
2051 GC_ASSERT(heap->free_pages != NULL);
2058 if (heap->free_pages == NULL) {
2059 heap_page_allocate_and_initialize(
objspace, heap);
2064 if (heap->free_pages == NULL) {
2065 GC_ASSERT(
objspace->empty_pages_count == 0);
2066 GC_ASSERT(
objspace->heap_pages.allocatable_slots == 0);
2068 if (gc_start(
objspace, GPR_FLAG_NEWOBJ) == FALSE) {
2072 if (
objspace->heap_pages.allocatable_slots == 0 && !gc_config_full_mark_val) {
2073 heap_allocatable_slots_expand(
objspace, heap,
2074 heap->freed_slots + heap->empty_slots,
2076 GC_ASSERT(
objspace->heap_pages.allocatable_slots > 0);
2084 if (heap->free_pages == NULL && !heap_page_allocate_and_initialize(
objspace, heap)) {
2085 if (gc_needs_major_flags == GPR_FLAG_NONE) {
2086 rb_bug(
"cannot create a new page after GC");
2089 if (gc_start(
objspace, GPR_FLAG_NEWOBJ) == FALSE) {
2096 if (heap->free_pages == NULL &&
2097 !heap_page_allocate_and_initialize(
objspace, heap)) {
2098 rb_bug(
"cannot create a new page after major GC");
2106 GC_ASSERT(heap->free_pages != NULL);
2110static inline const char*
2111rb_gc_impl_source_location_cstr(
int *ptr)
2132 RBASIC(obj)->flags = flags;
2134#if RBASIC_SHAPE_ID_FIELD
2135 RBASIC(obj)->shape_id = 0;
2140 RVALUE_AGE_SET_CANDIDATE(
objspace, obj);
2143#if RACTOR_CHECK_MODE
2144 void rb_ractor_setup_belonging(
VALUE obj);
2145 rb_ractor_setup_belonging(obj);
2148#if RGENGC_CHECK_MODE
2149 int lev = RB_GC_VM_LOCK_NO_BARRIER();
2151 check_rvalue_consistency(
objspace, obj);
2153 GC_ASSERT(RVALUE_MARKED(
objspace, obj) == FALSE);
2154 GC_ASSERT(RVALUE_MARKING(
objspace, obj) == FALSE);
2155 GC_ASSERT(RVALUE_OLD_P(
objspace, obj) == FALSE);
2156 GC_ASSERT(RVALUE_WB_UNPROTECTED(
objspace, obj) == FALSE);
2158 if (RVALUE_REMEMBERED(
objspace, obj)) rb_bug(
"newobj: %s is remembered.", rb_obj_info(obj));
2160 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
2163 if (RB_UNLIKELY(wb_protected == FALSE)) {
2164 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), obj);
2169 objspace->profile.total_generated_normal_object_count++;
2170#if RGENGC_PROFILE >= 2
2175 objspace->profile.total_generated_shady_object_count++;
2176#if RGENGC_PROFILE >= 2
2183 GET_RVALUE_OVERHEAD(obj)->file = rb_gc_impl_source_location_cstr(&GET_RVALUE_OVERHEAD(obj)->line);
2187 gc_report(5,
objspace,
"newobj: %s\n", rb_obj_info(obj));
2194rb_gc_impl_obj_slot_size(
VALUE obj)
2196 return GET_HEAP_PAGE(obj)->slot_size - RVALUE_OVERHEAD;
2200heap_slot_size(
unsigned char pool_id)
2202 GC_ASSERT(pool_id < HEAP_COUNT);
2204 size_t slot_size = (1 << pool_id) * BASE_SLOT_SIZE;
2206#if RGENGC_CHECK_MODE
2208 GC_ASSERT(heaps[pool_id].slot_size == (
short)slot_size);
2211 slot_size -= RVALUE_OVERHEAD;
2217rb_gc_impl_size_allocatable_p(
size_t size)
2219 return size <= heap_slot_size(HEAP_COUNT - 1);
2222static const size_t ALLOCATED_COUNT_STEP = 1024;
2229 struct free_slot *p = heap_cache->freelist;
2231 if (RB_UNLIKELY(is_incremental_marking(
objspace))) {
2233 if (cache->incremental_mark_step_allocated_slots >= INCREMENTAL_MARK_STEP_ALLOCATIONS) {
2238 cache->incremental_mark_step_allocated_slots++;
2244 rb_asan_unpoison_object(obj,
true);
2245 heap_cache->freelist = p->next;
2247 if (rb_gc_multi_ractor_p()) {
2248 heap_cache->allocated_objects_count++;
2250 if (heap_cache->allocated_objects_count >= ALLOCATED_COUNT_STEP) {
2252 heap_cache->allocated_objects_count = 0;
2257 heap->total_allocated_objects++;
2258 GC_ASSERT(heap->total_slots >=
2259 (heap->total_allocated_objects - heap->total_freed_objects - heap->final_slots_count));
2262#if RGENGC_CHECK_MODE
2263 GC_ASSERT(rb_gc_impl_obj_slot_size(obj) == heap_slot_size(heap_idx));
2265 MEMZERO((
char *)obj,
char, heap_slot_size(heap_idx));
2279 if (heap->free_pages == NULL) {
2283 page = heap->free_pages;
2284 heap->free_pages = page->free_next;
2286 GC_ASSERT(page->free_slots != 0);
2288 asan_unlock_freelist(page);
2297 gc_report(3,
objspace,
"ractor_set_cache: Using page %p\n", (
void *)page->body);
2301 GC_ASSERT(heap_cache->freelist == NULL);
2302 GC_ASSERT(page->free_slots != 0);
2303 GC_ASSERT(page->freelist != NULL);
2305 heap_cache->using_page = page;
2306 heap_cache->freelist = page->freelist;
2307 page->free_slots = 0;
2308 page->freelist = NULL;
2310 rb_asan_unpoison_object((
VALUE)heap_cache->freelist,
false);
2312 rb_asan_poison_object((
VALUE)heap_cache->freelist);
2316heap_idx_for_size(
size_t size)
2318 size += RVALUE_OVERHEAD;
2320 size_t slot_count = CEILDIV(size, BASE_SLOT_SIZE);
2323 size_t heap_idx = 64 - nlz_int64(slot_count - 1);
2325 if (heap_idx >= HEAP_COUNT) {
2326 rb_bug(
"heap_idx_for_size: allocation size too large "
2327 "(size=%"PRIuSIZE
"u, heap_idx=%"PRIuSIZE
"u)", size, heap_idx);
2330#if RGENGC_CHECK_MODE
2332 GC_ASSERT(size <= (
size_t)heaps[heap_idx].slot_size);
2333 if (heap_idx > 0) GC_ASSERT(size > (
size_t)heaps[heap_idx - 1].slot_size);
2340rb_gc_impl_heap_id_for_size(
void *objspace_ptr,
size_t size)
2342 return heap_idx_for_size(size);
2346static size_t heap_sizes[HEAP_COUNT + 1] = { 0 };
2349rb_gc_impl_heap_sizes(
void *objspace_ptr)
2351 if (heap_sizes[0] == 0) {
2352 for (
unsigned char i = 0; i < HEAP_COUNT; i++) {
2353 heap_sizes[i] = heap_slot_size(i);
2368 unsigned int lev = 0;
2369 bool unlock_vm =
false;
2372 lev = RB_GC_CR_LOCK();
2377 if (is_incremental_marking(
objspace)) {
2379 cache->incremental_mark_step_allocated_slots = 0;
2382 obj = ractor_cache_allocate_slot(
objspace, cache, heap_idx);
2388 ractor_cache_set_page(
objspace, cache, heap_idx, page);
2391 obj = ractor_cache_allocate_slot(
objspace, cache, heap_idx);
2396 RB_GC_CR_UNLOCK(lev);
2399 if (RB_UNLIKELY(obj ==
Qfalse)) {
2408 VALUE obj = ractor_cache_allocate_slot(
objspace, cache, heap_idx);
2410 if (RB_UNLIKELY(obj ==
Qfalse)) {
2411 obj = newobj_cache_miss(
objspace, cache, heap_idx, vm_locked);
2425 lev = RB_GC_CR_LOCK();
2427 if (RB_UNLIKELY(during_gc || ruby_gc_stressful)) {
2431 if (rb_memerror_reentered()) {
2434 rb_bug(
"object allocation during garbage collection phase");
2437 if (ruby_gc_stressful) {
2438 if (!garbage_collect(
objspace, GPR_FLAG_NEWOBJ)) {
2444 obj = newobj_alloc(
objspace, cache, heap_idx,
true);
2445 newobj_init(klass, flags, wb_protected,
objspace, obj);
2447 RB_GC_CR_UNLOCK(lev);
2452NOINLINE(
static VALUE newobj_slowpath_wb_protected(
VALUE klass,
VALUE flags,
2454NOINLINE(
static VALUE newobj_slowpath_wb_unprotected(
VALUE klass,
VALUE flags,
2460 return newobj_slowpath(klass, flags,
objspace, cache, TRUE, heap_idx);
2466 return newobj_slowpath(klass, flags,
objspace, cache, FALSE, heap_idx);
2470rb_gc_impl_new_obj(
void *objspace_ptr,
void *cache_ptr,
VALUE klass,
VALUE flags,
bool wb_protected,
size_t alloc_size)
2475 RB_DEBUG_COUNTER_INC(obj_newobj);
2476 (void)RB_DEBUG_COUNTER_INC_IF(obj_newobj_wb_unprotected, !wb_protected);
2478 if (RB_UNLIKELY(stress_to_class)) {
2479 if (rb_hash_lookup2(stress_to_class, klass,
Qundef) !=
Qundef) {
2484 size_t heap_idx = heap_idx_for_size(alloc_size);
2488 if (!RB_UNLIKELY(during_gc || ruby_gc_stressful) &&
2490 obj = newobj_alloc(
objspace, cache, heap_idx,
false);
2491 newobj_init(klass, flags, wb_protected,
objspace, obj);
2494 RB_DEBUG_COUNTER_INC(obj_newobj_slowpath);
2496 obj = wb_protected ?
2497 newobj_slowpath_wb_protected(klass, flags,
objspace, cache, heap_idx) :
2498 newobj_slowpath_wb_unprotected(klass, flags,
objspace, cache, heap_idx);
2505ptr_in_page_body_p(
const void *ptr,
const void *memb)
2508 uintptr_t p_body = (uintptr_t)page->body;
2510 if ((uintptr_t)ptr >= p_body) {
2511 return (uintptr_t)ptr < (p_body + HEAP_PAGE_SIZE) ? 0 : 1;
2524 if (ptr < (uintptr_t)heap_pages_lomem ||
2525 ptr > (uintptr_t)heap_pages_himem) {
2529 res = bsearch((
void *)ptr, rb_darray_ref(
objspace->heap_pages.sorted, 0),
2531 ptr_in_page_body_p);
2545 register uintptr_t p = (uintptr_t)ptr;
2548 RB_DEBUG_COUNTER_INC(gc_isptr_trial);
2550 if (p < heap_pages_lomem || p > heap_pages_himem)
return FALSE;
2551 RB_DEBUG_COUNTER_INC(gc_isptr_range);
2553 if (p % BASE_SLOT_SIZE != 0)
return FALSE;
2554 RB_DEBUG_COUNTER_INC(gc_isptr_align);
2556 page = heap_page_for_ptr(
objspace, (uintptr_t)ptr);
2558 RB_DEBUG_COUNTER_INC(gc_isptr_maybe);
2559 if (heap_page_in_global_empty_pages_pool(
objspace, page)) {
2563 if (p < page->start)
return FALSE;
2564 if (p >= page->start + (page->total_slots * page->slot_size))
return FALSE;
2565 if ((NUM_IN_PAGE(p) * BASE_SLOT_SIZE) % page->slot_size != 0)
return FALSE;
2574rb_gc_impl_pointer_to_heap_p(
void *objspace_ptr,
const void *ptr)
2576 return is_pointer_to_heap(objspace_ptr, ptr);
2579#define ZOMBIE_OBJ_KEPT_FLAGS (FL_FINALIZE)
2582rb_gc_impl_make_zombie(
void *objspace_ptr,
VALUE obj,
void (*dfree)(
void *),
void *data)
2586 struct RZombie *zombie = RZOMBIE(obj);
2587 zombie->flags =
T_ZOMBIE | (zombie->flags & ZOMBIE_OBJ_KEPT_FLAGS);
2588 zombie->dfree = dfree;
2589 zombie->data = data;
2590 VALUE prev, next = heap_pages_deferred_final;
2592 zombie->next = prev = next;
2594 }
while (next != prev);
2596 struct heap_page *page = GET_HEAP_PAGE(obj);
2597 page->final_slots++;
2598 page->heap->final_slots_count++;
2601typedef int each_obj_callback(
void *,
void *,
size_t,
void *);
2602typedef int each_page_callback(
struct heap_page *,
void *);
2606 bool reenable_incremental;
2608 each_obj_callback *each_obj_callback;
2609 each_page_callback *each_page_callback;
2613 size_t pages_counts[HEAP_COUNT];
2617objspace_each_objects_ensure(
VALUE arg)
2623 if (data->reenable_incremental) {
2624 objspace->flags.dont_incremental = FALSE;
2627 for (
int i = 0; i < HEAP_COUNT; i++) {
2628 struct heap_page **pages = data->pages[i];
2636objspace_each_objects_try(
VALUE arg)
2642 for (
int i = 0; i < HEAP_COUNT; i++) {
2644 size_t size = heap->total_pages *
sizeof(
struct heap_page *);
2646 struct heap_page **pages = malloc(size);
2647 if (!pages) rb_memerror();
2655 size_t pages_count = 0;
2656 ccan_list_for_each(&heap->pages, page, page_node) {
2657 pages[pages_count] = page;
2660 data->pages[i] = pages;
2661 data->pages_counts[i] = pages_count;
2662 GC_ASSERT(pages_count == heap->total_pages);
2665 for (
int i = 0; i < HEAP_COUNT; i++) {
2667 size_t pages_count = data->pages_counts[i];
2668 struct heap_page **pages = data->pages[i];
2671 for (
size_t i = 0; i < pages_count; i++) {
2674 if (page == NULL)
break;
2678 if (pages[i] != page)
continue;
2680 uintptr_t pstart = (uintptr_t)page->start;
2681 uintptr_t pend = pstart + (page->total_slots * heap->slot_size);
2683 if (data->each_obj_callback &&
2684 (*data->each_obj_callback)((
void *)pstart, (
void *)pend, heap->slot_size, data->data)) {
2687 if (data->each_page_callback &&
2688 (*data->each_page_callback)(page, data->data)) {
2692 page = ccan_list_next(&heap->pages, page, page_node);
2704 bool reenable_incremental = FALSE;
2706 reenable_incremental = !
objspace->flags.dont_incremental;
2709 objspace->flags.dont_incremental = TRUE;
2720objspace_each_objects(
rb_objspace_t *
objspace, each_obj_callback *callback,
void *data,
bool protected)
2724 .each_obj_callback = callback,
2725 .each_page_callback = NULL,
2732rb_gc_impl_each_objects(
void *objspace_ptr, each_obj_callback *callback,
void *data)
2734 objspace_each_objects(objspace_ptr, callback, data, TRUE);
2737#if GC_CAN_COMPILE_COMPACTION
2739objspace_each_pages(
rb_objspace_t *
objspace, each_page_callback *callback,
void *data,
bool protected)
2743 .each_obj_callback = NULL,
2744 .each_page_callback = callback,
2752rb_gc_impl_define_finalizer(
void *objspace_ptr,
VALUE obj,
VALUE block)
2762 int lev = RB_GC_VM_LOCK();
2764 if (st_lookup(finalizer_table, obj, &data)) {
2765 table = (
VALUE)data;
2772 for (i = 0; i <
len; i++) {
2775 RB_GC_VM_UNLOCK(lev);
2786 st_add_direct(finalizer_table, obj, table);
2789 RB_GC_VM_UNLOCK(lev);
2795rb_gc_impl_undefine_finalizer(
void *objspace_ptr,
VALUE obj)
2801 st_data_t data = obj;
2803 int lev = RB_GC_VM_LOCK();
2804 st_delete(finalizer_table, &data, 0);
2805 RB_GC_VM_UNLOCK(lev);
2811rb_gc_impl_copy_finalizer(
void *objspace_ptr,
VALUE dest,
VALUE obj)
2819 int lev = RB_GC_VM_LOCK();
2820 if (RB_LIKELY(st_lookup(finalizer_table, obj, &data))) {
2823 st_insert(finalizer_table, dest, table);
2827 rb_bug(
"rb_gc_copy_finalizer: FL_FINALIZE set but not found in finalizer_table: %s", rb_obj_info(obj));
2829 RB_GC_VM_UNLOCK(lev);
2833get_final(
long i,
void *data)
2843 if (RZOMBIE(zombie)->dfree) {
2844 RZOMBIE(zombie)->dfree(RZOMBIE(zombie)->data);
2847 st_data_t key = (st_data_t)zombie;
2851 if (st_delete(finalizer_table, &key, &table)) {
2855 rb_bug(
"FL_FINALIZE flag is set, but finalizers are not found");
2859 GC_ASSERT(!st_lookup(finalizer_table, key, NULL));
2869 rb_asan_unpoison_object(zombie,
false);
2870 next_zombie = RZOMBIE(zombie)->next;
2871 page = GET_HEAP_PAGE(zombie);
2873 int lev = RB_GC_VM_LOCK();
2878 GC_ASSERT(page->heap->final_slots_count > 0);
2879 GC_ASSERT(page->final_slots > 0);
2881 page->heap->final_slots_count--;
2882 page->final_slots--;
2884 heap_page_add_freeobj(
objspace, page, zombie);
2885 page->heap->total_freed_objects++;
2887 RB_GC_VM_UNLOCK(lev);
2889 zombie = next_zombie;
2905 rb_gc_set_pending_interrupt();
2906 finalize_deferred_heap_pages(
objspace);
2907 rb_gc_unset_pending_interrupt();
2911gc_finalize_deferred(
void *dmy)
2930gc_abort(
void *objspace_ptr)
2934 if (is_incremental_marking(
objspace)) {
2937 while (pop_mark_stack(&
objspace->mark_stack, &obj));
2939 objspace->flags.during_incremental_marking = FALSE;
2943 for (
int i = 0; i < HEAP_COUNT; i++) {
2946 heap->sweeping_page = NULL;
2949 ccan_list_for_each(&heap->pages, page, page_node) {
2950 page->flags.before_sweep =
false;
2955 for (
int i = 0; i < HEAP_COUNT; i++) {
2957 rgengc_mark_and_rememberset_clear(
objspace, heap);
2960 gc_mode_set(
objspace, gc_mode_none);
2964rb_gc_impl_shutdown_free_objects(
void *objspace_ptr)
2968 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
2970 short stride = page->slot_size;
2972 uintptr_t p = (uintptr_t)page->start;
2973 uintptr_t pend = p + page->total_slots * stride;
2974 for (; p < pend; p += stride) {
2976 asan_unpoisoning_object(vp) {
2978 rb_gc_obj_free_vm_weak_references(vp);
2979 if (rb_gc_obj_free(
objspace, vp)) {
2989rb_gc_impl_shutdown_call_finalizer_i(st_data_t key, st_data_t val, st_data_t _data)
3005rb_gc_impl_shutdown_call_finalizer(
void *objspace_ptr)
3009#if RGENGC_CHECK_MODE >= 2
3010 gc_verify_internal_consistency(
objspace);
3014 objspace->flags.dont_incremental = 1;
3023 while (finalizer_table->num_entries) {
3024 st_foreach(finalizer_table, rb_gc_impl_shutdown_call_finalizer_i, 0);
3029 GC_ASSERT(heap_pages_deferred_final == 0);
3038 unsigned int lock_lev;
3039 gc_enter(
objspace, gc_enter_event_finalizer, &lock_lev);
3042 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
3044 short stride = page->slot_size;
3046 uintptr_t p = (uintptr_t)page->start;
3047 uintptr_t pend = p + page->total_slots * stride;
3048 for (; p < pend; p += stride) {
3050 asan_unpoisoning_object(vp) {
3051 if (rb_gc_shutdown_call_finalizer_p(vp)) {
3052 rb_gc_obj_free_vm_weak_references(vp);
3053 if (rb_gc_obj_free(
objspace, vp)) {
3061 gc_exit(
objspace, gc_enter_event_finalizer, &lock_lev);
3063 finalize_deferred_heap_pages(
objspace);
3065 st_free_table(finalizer_table);
3066 finalizer_table = 0;
3071rb_gc_impl_each_object(
void *objspace_ptr,
void (*func)(
VALUE obj,
void *data),
void *data)
3075 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
3077 short stride = page->slot_size;
3079 uintptr_t p = (uintptr_t)page->start;
3080 uintptr_t pend = p + page->total_slots * stride;
3081 for (; p < pend; p += stride) {
3084 asan_unpoisoning_object(obj) {
3100 size_t total_slots = 0;
3101 for (
int i = 0; i < HEAP_COUNT; i++) {
3103 total_slots += heap->total_slots;
3121gc_setup_mark_bits(
struct heap_page *page)
3124 memcpy(&page->mark_bits[0], &page->uncollectible_bits[0], HEAP_PAGE_BITMAP_SIZE);
3131enum {HEAP_PAGE_LOCK = PAGE_NOACCESS, HEAP_PAGE_UNLOCK = PAGE_READWRITE};
3137 return VirtualProtect(body, HEAP_PAGE_SIZE, protect, &old_protect) != 0;
3139#elif defined(__wasi__)
3141enum {HEAP_PAGE_LOCK, HEAP_PAGE_UNLOCK};
3142#define protect_page_body(body, protect) 1
3144enum {HEAP_PAGE_LOCK = PROT_NONE, HEAP_PAGE_UNLOCK = PROT_READ | PROT_WRITE};
3145#define protect_page_body(body, protect) !mprotect((body), HEAP_PAGE_SIZE, (protect))
3151 if (!protect_page_body(body, HEAP_PAGE_LOCK)) {
3152 rb_bug(
"Couldn't protect page %p, errno: %s", (
void *)body, strerror(
errno));
3155 gc_report(5,
objspace,
"Protecting page in move %p\n", (
void *)body);
3162 if (!protect_page_body(body, HEAP_PAGE_UNLOCK)) {
3163 rb_bug(
"Couldn't unprotect page %p, errno: %s", (
void *)body, strerror(
errno));
3166 gc_report(5,
objspace,
"Unprotecting page in move %p\n", (
void *)body);
3173 GC_ASSERT(gc_is_moveable_obj(
objspace, src));
3175 struct heap_page *src_page = GET_HEAP_PAGE(src);
3183 GC_ASSERT(RVALUE_MARKED(
objspace, src));
3185 asan_unlock_freelist(free_page);
3187 asan_lock_freelist(free_page);
3189 rb_asan_unpoison_object(dest,
false);
3196 asan_unlock_freelist(free_page);
3197 free_page->freelist = ((
struct free_slot *)dest)->next;
3198 asan_lock_freelist(free_page);
3202 if (src_page->slot_size > free_page->slot_size) {
3205 else if (free_page->slot_size > src_page->slot_size) {
3209 objspace->rcompactor.total_moved++;
3211 gc_move(
objspace, src, dest, src_page->slot_size, free_page->slot_size);
3213 free_page->free_slots--;
3221 struct heap_page *cursor = heap->compact_cursor;
3224 unlock_page_body(
objspace, cursor->body);
3225 cursor = ccan_list_next(&heap->pages, cursor, page_node);
3230#if GC_CAN_COMPILE_COMPACTION
3234#if defined(__MINGW32__) || defined(_WIN32)
3235# define GC_COMPACTION_SUPPORTED 1
3239# define GC_COMPACTION_SUPPORTED (GC_CAN_COMPILE_COMPACTION && HEAP_PAGE_ALLOC_USE_MMAP)
3242#if GC_CAN_COMPILE_COMPACTION
3244read_barrier_handler(uintptr_t address)
3252 if (page_body == NULL) {
3253 rb_bug(
"read_barrier_handler: segmentation fault at %p", (
void *)address);
3256 int lev = RB_GC_VM_LOCK();
3258 unlock_page_body(
objspace, page_body);
3260 objspace->profile.read_barrier_faults++;
3262 invalidate_moved_page(
objspace, GET_HEAP_PAGE(address));
3264 RB_GC_VM_UNLOCK(lev);
3268#if !GC_CAN_COMPILE_COMPACTION
3270uninstall_handlers(
void)
3276install_handlers(
void)
3280#elif defined(_WIN32)
3281static LPTOP_LEVEL_EXCEPTION_FILTER old_handler;
3282typedef void (*signal_handler)(int);
3283static signal_handler old_sigsegv_handler;
3286read_barrier_signal(EXCEPTION_POINTERS *info)
3289 if (info->ExceptionRecord->ExceptionCode == EXCEPTION_ACCESS_VIOLATION) {
3294 read_barrier_handler((uintptr_t)info->ExceptionRecord->ExceptionInformation[1]);
3295 return EXCEPTION_CONTINUE_EXECUTION;
3298 return EXCEPTION_CONTINUE_SEARCH;
3303uninstall_handlers(
void)
3305 signal(SIGSEGV, old_sigsegv_handler);
3306 SetUnhandledExceptionFilter(old_handler);
3310install_handlers(
void)
3313 old_sigsegv_handler = signal(SIGSEGV, NULL);
3316 old_handler = SetUnhandledExceptionFilter(read_barrier_signal);
3319static struct sigaction old_sigbus_handler;
3320static struct sigaction old_sigsegv_handler;
3322#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3323static exception_mask_t old_exception_masks[32];
3324static mach_port_t old_exception_ports[32];
3325static exception_behavior_t old_exception_behaviors[32];
3326static thread_state_flavor_t old_exception_flavors[32];
3327static mach_msg_type_number_t old_exception_count;
3330disable_mach_bad_access_exc(
void)
3332 old_exception_count =
sizeof(old_exception_masks) /
sizeof(old_exception_masks[0]);
3333 task_swap_exception_ports(
3334 mach_task_self(), EXC_MASK_BAD_ACCESS,
3335 MACH_PORT_NULL, EXCEPTION_DEFAULT, 0,
3336 old_exception_masks, &old_exception_count,
3337 old_exception_ports, old_exception_behaviors, old_exception_flavors
3342restore_mach_bad_access_exc(
void)
3344 for (mach_msg_type_number_t i = 0; i < old_exception_count; i++) {
3345 task_set_exception_ports(
3347 old_exception_masks[i], old_exception_ports[i],
3348 old_exception_behaviors[i], old_exception_flavors[i]
3355read_barrier_signal(
int sig, siginfo_t *info,
void *data)
3358 struct sigaction prev_sigbus, prev_sigsegv;
3359 sigaction(SIGBUS, &old_sigbus_handler, &prev_sigbus);
3360 sigaction(SIGSEGV, &old_sigsegv_handler, &prev_sigsegv);
3363 sigset_t set, prev_set;
3365 sigaddset(&set, SIGBUS);
3366 sigaddset(&set, SIGSEGV);
3367 sigprocmask(SIG_UNBLOCK, &set, &prev_set);
3368#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3369 disable_mach_bad_access_exc();
3372 read_barrier_handler((uintptr_t)info->si_addr);
3375#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3376 restore_mach_bad_access_exc();
3378 sigaction(SIGBUS, &prev_sigbus, NULL);
3379 sigaction(SIGSEGV, &prev_sigsegv, NULL);
3380 sigprocmask(SIG_SETMASK, &prev_set, NULL);
3384uninstall_handlers(
void)
3386#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3387 restore_mach_bad_access_exc();
3389 sigaction(SIGBUS, &old_sigbus_handler, NULL);
3390 sigaction(SIGSEGV, &old_sigsegv_handler, NULL);
3394install_handlers(
void)
3396 struct sigaction action;
3397 memset(&action, 0,
sizeof(
struct sigaction));
3398 sigemptyset(&action.sa_mask);
3399 action.sa_sigaction = read_barrier_signal;
3400 action.sa_flags = SA_SIGINFO | SA_ONSTACK;
3402 sigaction(SIGBUS, &action, &old_sigbus_handler);
3403 sigaction(SIGSEGV, &action, &old_sigsegv_handler);
3404#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3405 disable_mach_bad_access_exc();
3413 for (
int i = 0; i < HEAP_COUNT; i++) {
3415 gc_unprotect_pages(
objspace, heap);
3418 uninstall_handlers();
3423 for (
int i = 0; i < HEAP_COUNT; i++) {
3425 heap->compact_cursor = NULL;
3426 heap->free_pages = NULL;
3427 heap->compact_cursor_index = 0;
3432 record->moved_objects =
objspace->rcompactor.total_moved - record->moved_objects;
3434 objspace->flags.during_compacting = FALSE;
3447 struct heap_page *sweep_page = ctx->page;
3448 short slot_size = sweep_page->slot_size;
3449 short slot_bits = slot_size / BASE_SLOT_SIZE;
3450 GC_ASSERT(slot_bits > 0);
3454 GC_ASSERT(vp % BASE_SLOT_SIZE == 0);
3456 rb_asan_unpoison_object(vp,
false);
3460 gc_report(2,
objspace,
"page_sweep: free %p\n", (
void *)p);
3461#if RGENGC_CHECK_MODE
3463 if (RVALUE_OLD_P(
objspace, vp)) rb_bug(
"page_sweep: %p - old while minor GC.", (
void *)p);
3464 if (RVALUE_REMEMBERED(
objspace, vp)) rb_bug(
"page_sweep: %p - remembered.", (
void *)p);
3468 if (RVALUE_WB_UNPROTECTED(
objspace, vp)) CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(vp), vp);
3470#if RGENGC_CHECK_MODE
3471#define CHECK(x) if (x(objspace, vp) != FALSE) rb_bug("obj_free: " #x "(%s) != FALSE", rb_obj_info(vp))
3472 CHECK(RVALUE_WB_UNPROTECTED);
3473 CHECK(RVALUE_MARKED);
3474 CHECK(RVALUE_MARKING);
3475 CHECK(RVALUE_UNCOLLECTIBLE);
3481 rb_gc_obj_free_vm_weak_references(vp);
3482 if (rb_gc_obj_free(
objspace, vp)) {
3485 (void)VALGRIND_MAKE_MEM_UNDEFINED((
void*)p, BASE_SLOT_SIZE);
3486 heap_page_add_freeobj(
objspace, sweep_page, vp);
3487 gc_report(3,
objspace,
"page_sweep: %s is added to freelist\n", rb_obj_info(vp));
3496 if (
objspace->flags.during_compacting) {
3502 rb_bug(
"T_MOVED shouldn't be seen until compaction is finished");
3504 gc_report(3,
objspace,
"page_sweep: %s is added to freelist\n", rb_obj_info(vp));
3506 heap_page_add_freeobj(
objspace, sweep_page, vp);
3517 bitset >>= slot_bits;
3524 struct heap_page *sweep_page = ctx->page;
3525 GC_ASSERT(sweep_page->heap == heap);
3528 bits_t *bits, bitset;
3530 gc_report(2,
objspace,
"page_sweep: start.\n");
3532#if RGENGC_CHECK_MODE
3533 if (!
objspace->flags.immediate_sweep) {
3534 GC_ASSERT(sweep_page->flags.before_sweep == TRUE);
3537 sweep_page->flags.before_sweep = FALSE;
3538 sweep_page->free_slots = 0;
3540 p = (uintptr_t)sweep_page->start;
3541 bits = sweep_page->mark_bits;
3543 int page_rvalue_count = sweep_page->total_slots * (sweep_page->slot_size / BASE_SLOT_SIZE);
3544 int out_of_range_bits = (NUM_IN_PAGE(p) + page_rvalue_count) % BITS_BITLENGTH;
3545 if (out_of_range_bits != 0) {
3546 bits[BITMAP_INDEX(p) + page_rvalue_count / BITS_BITLENGTH] |= ~(((bits_t)1 << out_of_range_bits) - 1);
3552 int bitmap_plane_count = CEILDIV(NUM_IN_PAGE(p) + page_rvalue_count, BITS_BITLENGTH);
3553 GC_ASSERT(bitmap_plane_count == HEAP_PAGE_BITMAP_LIMIT - 1 ||
3554 bitmap_plane_count == HEAP_PAGE_BITMAP_LIMIT);
3558 bitset >>= NUM_IN_PAGE(p);
3560 gc_sweep_plane(
objspace, heap, p, bitset, ctx);
3562 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
3564 for (
int i = 1; i < bitmap_plane_count; i++) {
3567 gc_sweep_plane(
objspace, heap, p, bitset, ctx);
3569 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
3572 if (!heap->compact_cursor) {
3573 gc_setup_mark_bits(sweep_page);
3576#if GC_PROFILE_MORE_DETAIL
3579 record->removing_objects += ctx->final_slots + ctx->freed_slots;
3580 record->empty_objects += ctx->empty_slots;
3583 if (0) fprintf(stderr,
"gc_sweep_page(%"PRIdSIZE
"): total_slots: %d, freed_slots: %d, empty_slots: %d, final_slots: %d\n",
3585 sweep_page->total_slots,
3586 ctx->freed_slots, ctx->empty_slots, ctx->final_slots);
3588 sweep_page->free_slots += ctx->freed_slots + ctx->empty_slots;
3589 sweep_page->heap->total_freed_objects += ctx->freed_slots;
3591 if (heap_pages_deferred_final && !finalizing) {
3592 gc_finalize_deferred_register(
objspace);
3595#if RGENGC_CHECK_MODE
3596 short freelist_len = 0;
3597 asan_unlock_freelist(sweep_page);
3598 struct free_slot *ptr = sweep_page->freelist;
3601 rb_asan_unpoison_object((
VALUE)ptr,
false);
3603 rb_asan_poison_object((
VALUE)ptr);
3606 asan_lock_freelist(sweep_page);
3607 if (freelist_len != sweep_page->free_slots) {
3608 rb_bug(
"inconsistent freelist length: expected %d but was %d", sweep_page->free_slots, freelist_len);
3612 gc_report(2,
objspace,
"page_sweep: end.\n");
3616gc_mode_name(
enum gc_mode mode)
3619 case gc_mode_none:
return "none";
3620 case gc_mode_marking:
return "marking";
3621 case gc_mode_sweeping:
return "sweeping";
3622 case gc_mode_compacting:
return "compacting";
3623 default: rb_bug(
"gc_mode_name: unknown mode: %d", (
int)mode);
3630#if RGENGC_CHECK_MODE
3631 enum gc_mode prev_mode = gc_mode(
objspace);
3632 switch (prev_mode) {
3633 case gc_mode_none: GC_ASSERT(mode == gc_mode_marking);
break;
3634 case gc_mode_marking: GC_ASSERT(mode == gc_mode_sweeping);
break;
3635 case gc_mode_sweeping: GC_ASSERT(mode == gc_mode_none || mode == gc_mode_compacting);
break;
3636 case gc_mode_compacting: GC_ASSERT(mode == gc_mode_none);
break;
3639 if (0) fprintf(stderr,
"gc_mode_transition: %s->%s\n", gc_mode_name(gc_mode(
objspace)), gc_mode_name(mode));
3647 asan_unlock_freelist(page);
3648 if (page->freelist) {
3650 rb_asan_unpoison_object((
VALUE)p,
false);
3654 rb_asan_poison_object((
VALUE)prev);
3655 rb_asan_unpoison_object((
VALUE)p,
false);
3658 rb_asan_poison_object((
VALUE)p);
3661 page->freelist = freelist;
3663 asan_lock_freelist(page);
3670 heap->sweeping_page = ccan_list_top(&heap->pages,
struct heap_page, page_node);
3671 heap->free_pages = NULL;
3672 heap->pooled_pages = NULL;
3673 if (!
objspace->flags.immediate_sweep) {
3676 ccan_list_for_each(&heap->pages, page, page_node) {
3677 page->flags.before_sweep = TRUE;
3682#if defined(__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ == 4
3686#if GC_CAN_COMPILE_COMPACTION
3687static void gc_sort_heap_by_compare_func(
rb_objspace_t *
objspace, gc_compact_compare_func compare_func);
3688static int compare_pinned_slots(
const void *left,
const void *right,
void *d);
3692gc_ractor_newobj_cache_clear(
void *c,
void *data)
3697 newobj_cache->incremental_mark_step_allocated_slots = 0;
3699 for (
size_t heap_idx = 0; heap_idx < HEAP_COUNT; heap_idx++) {
3705 cache->allocated_objects_count = 0;
3707 struct heap_page *page = cache->using_page;
3708 struct free_slot *freelist = cache->freelist;
3709 RUBY_DEBUG_LOG(
"ractor using_page:%p freelist:%p", (
void *)page, (
void *)freelist);
3711 heap_page_freelist_append(page, freelist);
3713 cache->using_page = NULL;
3714 cache->freelist = NULL;
3721 gc_mode_transition(
objspace, gc_mode_sweeping);
3724#if GC_CAN_COMPILE_COMPACTION
3725 if (
objspace->flags.during_compacting) {
3726 gc_sort_heap_by_compare_func(
3728 objspace->rcompactor.compare_func ?
objspace->rcompactor.compare_func : compare_pinned_slots
3733 for (
int i = 0; i < HEAP_COUNT; i++) {
3735 gc_sweep_start_heap(
objspace, heap);
3738 if (heap->sweeping_page == NULL) {
3739 GC_ASSERT(heap->total_pages == 0);
3740 GC_ASSERT(heap->total_slots == 0);
3741 gc_sweep_finish_heap(
objspace, heap);
3745 rb_gc_ractor_newobj_cache_foreach(gc_ractor_newobj_cache_clear, NULL);
3751 size_t total_slots = heap->total_slots;
3752 size_t swept_slots = heap->freed_slots + heap->empty_slots;
3754 size_t init_slots = gc_params.heap_init_slots[heap - heaps];
3755 size_t min_free_slots = (size_t)(MAX(total_slots, init_slots) * gc_params.heap_free_slots_min_ratio);
3757 if (swept_slots < min_free_slots &&
3759 ((heap->empty_slots == 0 && total_slots > 0) || heap->freed_slots > heap->empty_slots)) {
3765 while (swept_slots < min_free_slots &&
3766 (resurrected_page = heap_page_resurrect(
objspace))) {
3767 heap_add_page(
objspace, heap, resurrected_page);
3768 heap_add_freepage(heap, resurrected_page);
3770 swept_slots += resurrected_page->free_slots;
3773 if (swept_slots < min_free_slots) {
3777 objspace->profile.count -
objspace->rgengc.last_major_gc < RVALUE_OLD_AGE) {
3778 if (
objspace->heap_pages.allocatable_slots < min_free_slots) {
3779 heap_allocatable_slots_expand(
objspace, heap, swept_slots, heap->total_slots);
3783 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_NOFREE;
3784 heap->force_major_gc_count++;
3793 gc_report(1,
objspace,
"gc_sweep_finish\n");
3796 heap_pages_free_unused_pages(
objspace);
3798 for (
int i = 0; i < HEAP_COUNT; i++) {
3801 heap->freed_slots = 0;
3802 heap->empty_slots = 0;
3804 if (!will_be_incremental_marking(
objspace)) {
3805 struct heap_page *end_page = heap->free_pages;
3807 while (end_page->free_next) end_page = end_page->free_next;
3808 end_page->free_next = heap->pooled_pages;
3811 heap->free_pages = heap->pooled_pages;
3813 heap->pooled_pages = NULL;
3819 gc_mode_transition(
objspace, gc_mode_none);
3821#if RGENGC_CHECK_MODE >= 2
3822 gc_verify_internal_consistency(
objspace);
3829 struct heap_page *sweep_page = heap->sweeping_page;
3830 int swept_slots = 0;
3831 int pooled_slots = 0;
3833 if (sweep_page == NULL)
return FALSE;
3835#if GC_ENABLE_LAZY_SWEEP
3836 gc_prof_sweep_timer_start(
objspace);
3840 RUBY_DEBUG_LOG(
"sweep_page:%p", (
void *)sweep_page);
3848 gc_sweep_page(
objspace, heap, &ctx);
3849 int free_slots = ctx.freed_slots + ctx.empty_slots;
3851 heap->sweeping_page = ccan_list_next(&heap->pages, sweep_page, page_node);
3853 if (free_slots == sweep_page->total_slots) {
3855 heap_unlink_page(
objspace, heap, sweep_page);
3857 sweep_page->start = 0;
3858 sweep_page->total_slots = 0;
3859 sweep_page->slot_size = 0;
3860 sweep_page->heap = NULL;
3861 sweep_page->free_slots = 0;
3863 asan_unlock_freelist(sweep_page);
3864 sweep_page->freelist = NULL;
3865 asan_lock_freelist(sweep_page);
3867 asan_poison_memory_region(sweep_page->body, HEAP_PAGE_SIZE);
3870 sweep_page->free_next =
objspace->empty_pages;
3871 objspace->empty_pages = sweep_page;
3873 else if (free_slots > 0) {
3874 heap->freed_slots += ctx.freed_slots;
3875 heap->empty_slots += ctx.empty_slots;
3877 if (pooled_slots < GC_INCREMENTAL_SWEEP_POOL_SLOT_COUNT) {
3878 heap_add_poolpage(
objspace, heap, sweep_page);
3879 pooled_slots += free_slots;
3882 heap_add_freepage(heap, sweep_page);
3883 swept_slots += free_slots;
3884 if (swept_slots > GC_INCREMENTAL_SWEEP_SLOT_COUNT) {
3890 sweep_page->free_next = NULL;
3892 }
while ((sweep_page = heap->sweeping_page));
3894 if (!heap->sweeping_page) {
3895 gc_sweep_finish_heap(
objspace, heap);
3897 if (!has_sweeping_pages(
objspace)) {
3902#if GC_ENABLE_LAZY_SWEEP
3903 gc_prof_sweep_timer_stop(
objspace);
3906 return heap->free_pages != NULL;
3912 for (
int i = 0; i < HEAP_COUNT; i++) {
3915 while (heap->sweeping_page) {
3924 GC_ASSERT(dont_gc_val() == FALSE ||
objspace->profile.latest_gc_info & GPR_FLAG_METHOD);
3925 if (!GC_ENABLE_LAZY_SWEEP)
return;
3929 for (
int i = 0; i < HEAP_COUNT; i++) {
3931 if (gc_sweep_step(
objspace, heap)) {
3932 GC_ASSERT(heap->free_pages != NULL);
3934 else if (heap == sweep_heap) {
3935 if (
objspace->empty_pages_count > 0 ||
objspace->heap_pages.allocatable_slots > 0) {
3946 heap_page_allocate_and_initialize(
objspace, heap);
3948 GC_ASSERT(heap->free_pages != NULL);
3953 GC_ASSERT(gc_mode(
objspace) == gc_mode_none);
3963rb_gc_impl_location(
void *objspace_ptr,
VALUE value)
3967 asan_unpoisoning_object(value) {
3969 destination = (
VALUE)RMOVED(value)->destination;
3973 destination = value;
3980#if GC_CAN_COMPILE_COMPACTION
3991 GC_ASSERT(RVALUE_PINNED(
objspace, forwarding_object));
3992 GC_ASSERT(!RVALUE_MARKED(
objspace, forwarding_object));
3994 CLEAR_IN_BITMAP(GET_HEAP_PINNED_BITS(forwarding_object), forwarding_object);
3996 object = rb_gc_impl_location(
objspace, forwarding_object);
3998 uint32_t original_shape_id = 0;
4000 original_shape_id = RMOVED(forwarding_object)->original_shape_id;
4003 gc_move(
objspace,
object, forwarding_object, GET_HEAP_PAGE(
object)->slot_size, page->slot_size);
4007 if (original_shape_id) {
4008 rb_gc_set_shape(forwarding_object, original_shape_id);
4011 struct heap_page *orig_page = GET_HEAP_PAGE(
object);
4012 orig_page->free_slots++;
4013 heap_page_add_freeobj(
objspace, orig_page,
object);
4015 GC_ASSERT(RVALUE_MARKED(
objspace, forwarding_object));
4020 p += BASE_SLOT_SIZE;
4030 bits_t *mark_bits, *pin_bits;
4033 mark_bits = page->mark_bits;
4034 pin_bits = page->pinned_bits;
4036 uintptr_t p = page->start;
4039 bitset = pin_bits[0] & ~mark_bits[0];
4040 bitset >>= NUM_IN_PAGE(p);
4041 invalidate_moved_plane(
objspace, page, p, bitset);
4042 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
4044 for (i=1; i < HEAP_PAGE_BITMAP_LIMIT; i++) {
4047 bitset = pin_bits[i] & ~mark_bits[i];
4049 invalidate_moved_plane(
objspace, page, p, bitset);
4050 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
4059 gc_mode_transition(
objspace, gc_mode_compacting);
4061 for (
int i = 0; i < HEAP_COUNT; i++) {
4063 ccan_list_for_each(&heap->pages, page, page_node) {
4064 page->flags.before_sweep = TRUE;
4067 heap->compact_cursor = ccan_list_tail(&heap->pages,
struct heap_page, page_node);
4068 heap->compact_cursor_index = 0;
4073 record->moved_objects =
objspace->rcompactor.total_moved;
4076 memset(
objspace->rcompactor.considered_count_table, 0,
T_MASK *
sizeof(
size_t));
4077 memset(
objspace->rcompactor.moved_count_table, 0,
T_MASK *
sizeof(
size_t));
4078 memset(
objspace->rcompactor.moved_up_count_table, 0,
T_MASK *
sizeof(
size_t));
4079 memset(
objspace->rcompactor.moved_down_count_table, 0,
T_MASK *
sizeof(
size_t));
4092 const unsigned int immediate_sweep =
objspace->flags.immediate_sweep;
4094 gc_report(1,
objspace,
"gc_sweep: immediate: %d\n", immediate_sweep);
4097 if (
objspace->flags.during_compacting) {
4101 if (immediate_sweep) {
4102#if !GC_ENABLE_LAZY_SWEEP
4103 gc_prof_sweep_timer_start(
objspace);
4106#if !GC_ENABLE_LAZY_SWEEP
4107 gc_prof_sweep_timer_stop(
objspace);
4113 for (
int i = 0; i < HEAP_COUNT; i++) {
4125stack_chunk_alloc(
void)
4139 return stack->chunk == NULL;
4145 size_t size = stack->index;
4146 stack_chunk_t *chunk = stack->chunk ? stack->chunk->next : NULL;
4149 size += stack->limit;
4150 chunk = chunk->next;
4158 chunk->next = stack->cache;
4159 stack->cache = chunk;
4160 stack->cache_size++;
4168 if (stack->unused_cache_size > (stack->cache_size/2)) {
4169 chunk = stack->cache;
4170 stack->cache = stack->cache->next;
4171 stack->cache_size--;
4174 stack->unused_cache_size = stack->cache_size;
4182 GC_ASSERT(stack->index == stack->limit);
4184 if (stack->cache_size > 0) {
4185 next = stack->cache;
4186 stack->cache = stack->cache->next;
4187 stack->cache_size--;
4188 if (stack->unused_cache_size > stack->cache_size)
4189 stack->unused_cache_size = stack->cache_size;
4192 next = stack_chunk_alloc();
4194 next->next = stack->chunk;
4195 stack->chunk = next;
4204 prev = stack->chunk->next;
4205 GC_ASSERT(stack->index == 0);
4206 add_stack_chunk_cache(stack, stack->chunk);
4207 stack->chunk = prev;
4208 stack->index = stack->limit;
4216 while (chunk != NULL) {
4226 mark_stack_chunk_list_free(stack->chunk);
4232 mark_stack_chunk_list_free(stack->cache);
4233 stack->cache_size = 0;
4234 stack->unused_cache_size = 0;
4261 if (stack->index == stack->limit) {
4262 push_mark_stack_chunk(stack);
4264 stack->chunk->data[stack->index++] = obj;
4274 rb_bug(
"push_mark_stack() called for broken object");
4278 rb_bug(
"push_mark_stack: unexpected T_NODE object");
4282 rb_bug(
"rb_gc_mark(): unknown data type 0x%x(%p) %s",
4284 is_pointer_to_heap((
rb_objspace_t *)rb_gc_get_objspace(), (
void *)obj) ?
"corrupted object" :
"non object");
4290 if (is_mark_stack_empty(stack)) {
4293 if (stack->index == 1) {
4294 *data = stack->chunk->data[--stack->index];
4295 pop_mark_stack_chunk(stack);
4298 *data = stack->chunk->data[--stack->index];
4309 stack->index = stack->limit = STACK_CHUNK_SIZE;
4311 for (i=0; i < 4; i++) {
4312 add_stack_chunk_cache(stack, stack_chunk_alloc());
4314 stack->unused_cache_size = stack->cache_size;
4322 if (
objspace->rgengc.parent_object_old_p) {
4323 if (RVALUE_WB_UNPROTECTED(
objspace, obj) || !RVALUE_OLD_P(
objspace, obj)) {
4332 if (RVALUE_MARKED(
objspace, obj))
return 0;
4333 MARK_IN_BITMAP(GET_HEAP_MARK_BITS(obj), obj);
4347 if(!gc_config_full_mark_val)
4350 struct heap_page *page = GET_HEAP_PAGE(obj);
4352 GC_ASSERT(RVALUE_MARKING(
objspace, obj) == FALSE);
4353 check_rvalue_consistency(
objspace, obj);
4355 if (!RVALUE_PAGE_WB_UNPROTECTED(page, obj)) {
4356 if (!RVALUE_OLD_P(
objspace, obj)) {
4357 gc_report(3,
objspace,
"gc_aging: YOUNG: %s\n", rb_obj_info(obj));
4360 else if (is_full_marking(
objspace)) {
4361 GC_ASSERT(RVALUE_PAGE_UNCOLLECTIBLE(page, obj) == FALSE);
4362 RVALUE_PAGE_OLD_UNCOLLECTIBLE_SET(
objspace, page, obj);
4365 check_rvalue_consistency(
objspace, obj);
4373#if RGENGC_CHECK_MODE
4374 if (RVALUE_MARKED(
objspace, obj) == FALSE) rb_bug(
"gc_grey: %s is not marked.", rb_obj_info(obj));
4375 if (RVALUE_MARKING(
objspace, obj) == TRUE) rb_bug(
"gc_grey: %s is marking/remembered.", rb_obj_info(obj));
4378 if (is_incremental_marking(
objspace)) {
4379 MARK_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), obj);
4382 push_mark_stack(&
objspace->mark_stack, obj);
4389 enum {info_size = 256};
4390 char obj_info_buf[info_size];
4391 rb_raw_obj_info(obj_info_buf, info_size, obj);
4393 char parent_obj_info_buf[info_size];
4394 rb_raw_obj_info(parent_obj_info_buf, info_size,
objspace->rgengc.parent_object);
4396 rb_bug(
"try to mark T_NONE object (obj: %s, parent: %s)", obj_info_buf, parent_obj_info_buf);
4403 GC_ASSERT(during_gc);
4404 GC_ASSERT(!
objspace->flags.during_reference_updating);
4406 rgengc_check_relation(
objspace, obj);
4407 if (!gc_mark_set(
objspace, obj))
return;
4410 RUBY_DEBUG_LOG(
"%p (%s) parent:%p (%s)",
4411 (
void *)obj, obj_type_name(obj),
4412 (
void *)
objspace->rgengc.parent_object, obj_type_name(
objspace->rgengc.parent_object));
4415 gc_mark_check_t_none(
objspace, obj);
4425 if (RB_UNLIKELY(
objspace->flags.during_compacting)) {
4426 if (RB_LIKELY(during_gc)) {
4427 if (!RVALUE_PINNED(
objspace, obj)) {
4428 GC_ASSERT(GET_HEAP_PAGE(obj)->pinned_slots <= GET_HEAP_PAGE(obj)->total_slots);
4429 GET_HEAP_PAGE(obj)->pinned_slots++;
4430 MARK_IN_BITMAP(GET_HEAP_PINNED_BITS(obj), obj);
4444rb_gc_impl_mark_and_move(
void *objspace_ptr,
VALUE *ptr)
4448 if (RB_UNLIKELY(
objspace->flags.during_reference_updating)) {
4449 GC_ASSERT(
objspace->flags.during_compacting);
4450 GC_ASSERT(during_gc);
4453 if (destination != *ptr) {
4463rb_gc_impl_mark(
void *objspace_ptr,
VALUE obj)
4471rb_gc_impl_mark_and_pin(
void *objspace_ptr,
VALUE obj)
4479rb_gc_impl_mark_maybe(
void *objspace_ptr,
VALUE obj)
4483 (void)VALGRIND_MAKE_MEM_DEFINED(&obj,
sizeof(obj));
4485 if (is_pointer_to_heap(
objspace, (
void *)obj)) {
4486 asan_unpoisoning_object(obj) {
4501rb_gc_impl_mark_weak(
void *objspace_ptr,
VALUE *ptr)
4507 gc_mark_check_t_none(
objspace, obj);
4513 GC_ASSERT(RVALUE_MARKED(
objspace, obj));
4514 GC_ASSERT(!
objspace->flags.during_compacting);
4519 rgengc_check_relation(
objspace, obj);
4521 rb_darray_append_without_gc(&
objspace->weak_references, ptr);
4523 objspace->profile.weak_references_count++;
4527rb_gc_impl_remove_weak(
void *objspace_ptr,
VALUE parent_obj,
VALUE *ptr)
4533 if (!is_incremental_marking(
objspace))
return;
4536 if (!RVALUE_MARKED(
objspace, parent_obj))
return;
4539 rb_darray_foreach(
objspace->weak_references, i, ptr_ptr) {
4540 if (*ptr_ptr == ptr) {
4548pin_value(st_data_t key, st_data_t value, st_data_t data)
4550 rb_gc_impl_mark_and_pin((
void *)data, (
VALUE)value);
4558 asan_unpoison_memory_region(&
objspace->rgengc.parent_object,
sizeof(
objspace->rgengc.parent_object),
false);
4559 asan_unpoison_memory_region(&
objspace->rgengc.parent_object_old_p,
sizeof(
objspace->rgengc.parent_object_old_p),
false);
4560 objspace->rgengc.parent_object = obj;
4561 objspace->rgengc.parent_object_old_p = old_p;
4573 asan_poison_memory_region(&
objspace->rgengc.parent_object,
sizeof(
objspace->rgengc.parent_object));
4574 asan_poison_memory_region(&
objspace->rgengc.parent_object_old_p,
sizeof(
objspace->rgengc.parent_object_old_p));
4580#define MARK_CHECKPOINT(category) do { \
4581 if (categoryp) *categoryp = category; \
4584 MARK_CHECKPOINT(
"objspace");
4587 if (finalizer_table != NULL) {
4588 st_foreach(finalizer_table, pin_value, (st_data_t)
objspace);
4591 if (stress_to_class) rb_gc_mark(stress_to_class);
4593 rb_gc_save_machine_context();
4594 rb_gc_mark_roots(
objspace, categoryp);
4595 gc_mark_set_parent_invalid(
objspace);
4602 rb_gc_mark_children(
objspace, obj);
4603 gc_mark_set_parent_invalid(
objspace);
4615 size_t marked_slots_at_the_beginning =
objspace->marked_slots;
4616 size_t popped_count = 0;
4618 while (pop_mark_stack(mstack, &obj)) {
4619 if (obj ==
Qundef)
continue;
4621 if (RGENGC_CHECK_MODE && !RVALUE_MARKED(
objspace, obj)) {
4622 rb_bug(
"gc_mark_stacked_objects: %s is not marked.", rb_obj_info(obj));
4627 if (RGENGC_CHECK_MODE && !RVALUE_MARKING(
objspace, obj)) {
4628 rb_bug(
"gc_mark_stacked_objects: incremental, but marking bit is 0");
4630 CLEAR_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), obj);
4633 if (popped_count + (
objspace->marked_slots - marked_slots_at_the_beginning) > count) {
4642 if (RGENGC_CHECK_MODE >= 3) gc_verify_internal_consistency(
objspace);
4644 if (is_mark_stack_empty(mstack)) {
4645 shrink_stack_chunk_cache(mstack);
4656 return gc_mark_stacked_objects(
objspace, TRUE, count);
4662 return gc_mark_stacked_objects(
objspace, FALSE, 0);
4665#if RGENGC_CHECK_MODE >= 4
4667#define MAKE_ROOTSIG(obj) (((VALUE)(obj) << 1) | 0x01)
4668#define IS_ROOTSIG(obj) ((VALUE)(obj) & 0x01)
4669#define GET_ROOTSIG(obj) ((const char *)((VALUE)(obj) >> 1))
4677static struct reflist *
4678reflist_create(
VALUE obj)
4680 struct reflist *refs =
xmalloc(
sizeof(
struct reflist));
4683 refs->list[0] = obj;
4689reflist_destruct(
struct reflist *refs)
4696reflist_add(
struct reflist *refs,
VALUE obj)
4698 if (refs->pos == refs->size) {
4700 SIZED_REALLOC_N(refs->list,
VALUE, refs->size, refs->size/2);
4703 refs->list[refs->pos++] = obj;
4707reflist_dump(
struct reflist *refs)
4710 for (i=0; i<refs->pos; i++) {
4711 VALUE obj = refs->list[i];
4712 if (IS_ROOTSIG(obj)) {
4713 fprintf(stderr,
"<root@%s>", GET_ROOTSIG(obj));
4716 fprintf(stderr,
"<%s>", rb_obj_info(obj));
4718 if (i+1 < refs->pos) fprintf(stderr,
", ");
4723reflist_referred_from_machine_context(
struct reflist *refs)
4726 for (i=0; i<refs->pos; i++) {
4727 VALUE obj = refs->list[i];
4728 if (IS_ROOTSIG(obj) && strcmp(GET_ROOTSIG(obj),
"machine_context") == 0)
return 1;
4743 const char *category;
4749allrefs_add(
struct allrefs *data,
VALUE obj)
4751 struct reflist *refs;
4754 if (st_lookup(data->references, obj, &r)) {
4755 refs = (
struct reflist *)r;
4756 reflist_add(refs, data->root_obj);
4760 refs = reflist_create(data->root_obj);
4761 st_insert(data->references, obj, (st_data_t)refs);
4767allrefs_i(
VALUE obj,
void *ptr)
4769 struct allrefs *data = (
struct allrefs *)ptr;
4771 if (allrefs_add(data, obj)) {
4772 push_mark_stack(&data->mark_stack, obj);
4777allrefs_roots_i(
VALUE obj,
void *ptr)
4779 struct allrefs *data = (
struct allrefs *)ptr;
4780 if (strlen(data->category) == 0) rb_bug(
"!!!");
4781 data->root_obj = MAKE_ROOTSIG(data->category);
4783 if (allrefs_add(data, obj)) {
4784 push_mark_stack(&data->mark_stack, obj);
4787#define PUSH_MARK_FUNC_DATA(v) do { \
4788 struct gc_mark_func_data_struct *prev_mark_func_data = GET_VM()->gc.mark_func_data; \
4789 GET_VM()->gc.mark_func_data = (v);
4791#define POP_MARK_FUNC_DATA() GET_VM()->gc.mark_func_data = prev_mark_func_data;} while (0)
4796 struct allrefs data;
4797 struct gc_mark_func_data_struct mfd;
4799 int prev_dont_gc = dont_gc_val();
4803 data.references = st_init_numtable();
4804 init_mark_stack(&data.mark_stack);
4806 mfd.mark_func = allrefs_roots_i;
4810 PUSH_MARK_FUNC_DATA(&mfd);
4811 GET_VM()->gc.mark_func_data = &mfd;
4812 mark_roots(
objspace, &data.category);
4813 POP_MARK_FUNC_DATA();
4816 while (pop_mark_stack(&data.mark_stack, &obj)) {
4817 rb_objspace_reachable_objects_from(data.root_obj = obj, allrefs_i, &data);
4819 free_stack_chunks(&data.mark_stack);
4821 dont_gc_set(prev_dont_gc);
4822 return data.references;
4826objspace_allrefs_destruct_i(st_data_t key, st_data_t value, st_data_t ptr)
4828 struct reflist *refs = (
struct reflist *)value;
4829 reflist_destruct(refs);
4834objspace_allrefs_destruct(
struct st_table *refs)
4836 st_foreach(refs, objspace_allrefs_destruct_i, 0);
4837 st_free_table(refs);
4840#if RGENGC_CHECK_MODE >= 5
4842allrefs_dump_i(st_data_t k, st_data_t v, st_data_t ptr)
4845 struct reflist *refs = (
struct reflist *)v;
4846 fprintf(stderr,
"[allrefs_dump_i] %s <- ", rb_obj_info(obj));
4848 fprintf(stderr,
"\n");
4856 fprintf(stderr,
"[all refs] (size: %"PRIuVALUE
")\n", size);
4857 st_foreach(
objspace->rgengc.allrefs_table, allrefs_dump_i, 0);
4862gc_check_after_marks_i(st_data_t k, st_data_t v, st_data_t ptr)
4865 struct reflist *refs = (
struct reflist *)v;
4869 if (!RVALUE_MARKED(
objspace, obj)) {
4870 fprintf(stderr,
"gc_check_after_marks_i: %s is not marked and not oldgen.\n", rb_obj_info(obj));
4871 fprintf(stderr,
"gc_check_after_marks_i: %p is referred from ", (
void *)obj);
4874 if (reflist_referred_from_machine_context(refs)) {
4875 fprintf(stderr,
" (marked from machine stack).\n");
4880 fprintf(stderr,
"\n");
4887gc_marks_check(
rb_objspace_t *
objspace, st_foreach_callback_func *checker_func,
const char *checker_name)
4889 size_t saved_malloc_increase =
objspace->malloc_params.increase;
4890#if RGENGC_ESTIMATE_OLDMALLOC
4891 size_t saved_oldmalloc_increase =
objspace->rgengc.oldmalloc_increase;
4898 st_foreach(
objspace->rgengc.allrefs_table, checker_func, (st_data_t)
objspace);
4901 if (
objspace->rgengc.error_count > 0) {
4902#if RGENGC_CHECK_MODE >= 5
4905 if (checker_name) rb_bug(
"%s: GC has problem.", checker_name);
4908 objspace_allrefs_destruct(
objspace->rgengc.allrefs_table);
4909 objspace->rgengc.allrefs_table = 0;
4912 objspace->malloc_params.increase = saved_malloc_increase;
4913#if RGENGC_ESTIMATE_OLDMALLOC
4914 objspace->rgengc.oldmalloc_increase = saved_oldmalloc_increase;
4922 size_t live_object_count;
4923 size_t zombie_object_count;
4926 size_t old_object_count;
4927 size_t remembered_shady_count;
4931check_generation_i(
const VALUE child,
void *ptr)
4934 const VALUE parent = data->parent;
4936 if (RGENGC_CHECK_MODE) GC_ASSERT(RVALUE_OLD_P(data->objspace, parent));
4938 if (!RVALUE_OLD_P(data->objspace, child)) {
4939 if (!RVALUE_REMEMBERED(data->objspace, parent) &&
4940 !RVALUE_REMEMBERED(data->objspace, child) &&
4941 !RVALUE_UNCOLLECTIBLE(data->objspace, child)) {
4942 fprintf(stderr,
"verify_internal_consistency_reachable_i: WB miss (O->Y) %s -> %s\n", rb_obj_info(parent), rb_obj_info(child));
4949check_color_i(
const VALUE child,
void *ptr)
4952 const VALUE parent = data->parent;
4954 if (!RVALUE_WB_UNPROTECTED(data->objspace, parent) && RVALUE_WHITE_P(data->objspace, child)) {
4955 fprintf(stderr,
"verify_internal_consistency_reachable_i: WB miss (B->W) - %s -> %s\n",
4956 rb_obj_info(parent), rb_obj_info(child));
4962check_children_i(
const VALUE child,
void *ptr)
4965 if (check_rvalue_consistency_force(data->objspace, child, FALSE) != 0) {
4966 fprintf(stderr,
"check_children_i: %s has error (referenced from %s)",
4967 rb_obj_info(child), rb_obj_info(data->parent));
4974check_shareable_i(
const VALUE child,
void *ptr)
4978 if (!rb_gc_obj_shareable_p(child)) {
4979 fprintf(stderr,
"(a) ");
4980 rb_gc_rp(data->parent);
4981 fprintf(stderr,
"(b) ");
4983 fprintf(stderr,
"check_shareable_i: shareable (a) -> unshareable (b)\n");
4986 rb_bug(
"!! violate shareable constraint !!");
4997 unsigned int lev = RB_GC_VM_LOCK();
4999 objspace->flags.check_shareable =
true;
5000 rb_objspace_reachable_objects_from(obj, check_shareable_i, (
void *)data);
5001 objspace->flags.check_shareable =
false;
5003 RB_GC_VM_UNLOCK(lev);
5008rb_gc_verify_shareable(
VALUE obj)
5015 gc_verify_shareable(
objspace, obj, &data);
5017 if (data.err_count > 0) {
5018 rb_bug(
"rb_gc_verify_shareable");
5023verify_internal_consistency_i(
void *page_start,
void *page_end,
size_t stride,
5029 for (obj = (
VALUE)page_start; obj != (
VALUE)page_end; obj += stride) {
5030 asan_unpoisoning_object(obj) {
5031 if (!rb_gc_impl_garbage_object_p(
objspace, obj)) {
5033 data->live_object_count++;
5038 if (!gc_object_moved_p(
objspace, obj)) {
5040 rb_objspace_reachable_objects_from(obj, check_children_i, (
void *)data);
5044 if (RVALUE_OLD_P(
objspace, obj)) data->old_object_count++;
5045 if (RVALUE_WB_UNPROTECTED(
objspace, obj) && RVALUE_UNCOLLECTIBLE(
objspace, obj)) data->remembered_shady_count++;
5050 rb_objspace_reachable_objects_from(obj, check_generation_i, (
void *)data);
5053 if (!is_marking(
objspace) && rb_gc_obj_shareable_p(obj)) {
5054 gc_verify_shareable(
objspace, obj, data);
5057 if (is_incremental_marking(
objspace)) {
5058 if (RVALUE_BLACK_P(
objspace, obj)) {
5061 rb_objspace_reachable_objects_from(obj, check_color_i, (
void *)data);
5067 data->zombie_object_count++;
5070 fprintf(stderr,
"verify_internal_consistency_i: T_ZOMBIE has extra flags set: %s\n",
5076 fprintf(stderr,
"verify_internal_consistency_i: FL_FINALIZE %s but %s finalizer_table: %s\n",
5077 FL_TEST(obj,
FL_FINALIZE) ?
"set" :
"not set", st_is_member(finalizer_table, obj) ?
"in" :
"not in",
5092 unsigned int has_remembered_shady = FALSE;
5093 unsigned int has_remembered_old = FALSE;
5094 int remembered_old_objects = 0;
5095 int free_objects = 0;
5096 int zombie_objects = 0;
5098 short slot_size = page->slot_size;
5099 uintptr_t start = (uintptr_t)page->start;
5100 uintptr_t end = start + page->total_slots * slot_size;
5102 for (uintptr_t ptr = start; ptr < end; ptr += slot_size) {
5104 asan_unpoisoning_object(val) {
5109 if (RVALUE_PAGE_UNCOLLECTIBLE(page, val) && RVALUE_PAGE_WB_UNPROTECTED(page, val)) {
5110 has_remembered_shady = TRUE;
5112 if (RVALUE_PAGE_MARKING(page, val)) {
5113 has_remembered_old = TRUE;
5114 remembered_old_objects++;
5119 if (!is_incremental_marking(
objspace) &&
5120 page->flags.has_remembered_objects == FALSE && has_remembered_old == TRUE) {
5122 for (uintptr_t ptr = start; ptr < end; ptr += slot_size) {
5124 if (RVALUE_PAGE_MARKING(page, val)) {
5125 fprintf(stderr,
"marking -> %s\n", rb_obj_info(val));
5128 rb_bug(
"page %p's has_remembered_objects should be false, but there are remembered old objects (%d). %s",
5129 (
void *)page, remembered_old_objects, obj ? rb_obj_info(obj) :
"");
5132 if (page->flags.has_uncollectible_wb_unprotected_objects == FALSE && has_remembered_shady == TRUE) {
5133 rb_bug(
"page %p's has_remembered_shady should be false, but there are remembered shady objects. %s",
5134 (
void *)page, obj ? rb_obj_info(obj) :
"");
5139 if (page->free_slots != free_objects) {
5140 rb_bug(
"page %p's free_slots should be %d, but %d", (
void *)page, page->free_slots, free_objects);
5143 if (page->final_slots != zombie_objects) {
5144 rb_bug(
"page %p's final_slots should be %d, but %d", (
void *)page, page->final_slots, zombie_objects);
5147 return remembered_old_objects;
5153 int remembered_old_objects = 0;
5156 ccan_list_for_each(head, page, page_node) {
5157 asan_unlock_freelist(page);
5162 rb_asan_unpoison_object(vp,
false);
5164 fprintf(stderr,
"freelist slot expected to be T_NONE but was: %s\n", rb_obj_info(vp));
5167 rb_asan_poison_object(prev);
5169 asan_lock_freelist(page);
5171 if (page->flags.has_remembered_objects == FALSE) {
5172 remembered_old_objects += gc_verify_heap_page(
objspace, page,
Qfalse);
5176 return remembered_old_objects;
5182 int remembered_old_objects = 0;
5183 for (
int i = 0; i < HEAP_COUNT; i++) {
5184 remembered_old_objects += gc_verify_heap_pages_(
objspace, &((&heaps[i])->pages));
5186 return remembered_old_objects;
5195 gc_report(5,
objspace,
"gc_verify_internal_consistency: start\n");
5198 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
5200 short slot_size = page->slot_size;
5202 uintptr_t start = (uintptr_t)page->start;
5203 uintptr_t end = start + page->total_slots * slot_size;
5205 verify_internal_consistency_i((
void *)start, (
void *)end, slot_size, &data);
5208 if (data.err_count != 0) {
5209#if RGENGC_CHECK_MODE >= 5
5210 objspace->rgengc.error_count = data.err_count;
5211 gc_marks_check(
objspace, NULL, NULL);
5214 rb_bug(
"gc_verify_internal_consistency: found internal inconsistency.");
5224 !rb_gc_multi_ractor_p()) {
5225 if (objspace_live_slots(
objspace) != data.live_object_count) {
5226 fprintf(stderr,
"heap_pages_final_slots: %"PRIdSIZE
", total_freed_objects: %"PRIdSIZE
"\n",
5228 rb_bug(
"inconsistent live slot number: expect %"PRIuSIZE
", but %"PRIuSIZE
".",
5229 objspace_live_slots(
objspace), data.live_object_count);
5234 if (
objspace->rgengc.old_objects != data.old_object_count) {
5235 rb_bug(
"inconsistent old slot number: expect %"PRIuSIZE
", but %"PRIuSIZE
".",
5236 objspace->rgengc.old_objects, data.old_object_count);
5238 if (
objspace->rgengc.uncollectible_wb_unprotected_objects != data.remembered_shady_count) {
5239 rb_bug(
"inconsistent number of wb unprotected objects: expect %"PRIuSIZE
", but %"PRIuSIZE
".",
5240 objspace->rgengc.uncollectible_wb_unprotected_objects, data.remembered_shady_count);
5245 size_t list_count = 0;
5248 VALUE z = heap_pages_deferred_final;
5251 z = RZOMBIE(z)->next;
5255 if (total_final_slots_count(
objspace) != data.zombie_object_count ||
5256 total_final_slots_count(
objspace) != list_count) {
5258 rb_bug(
"inconsistent finalizing object count:\n"
5259 " expect %"PRIuSIZE
"\n"
5260 " but %"PRIuSIZE
" zombies\n"
5261 " heap_pages_deferred_final list has %"PRIuSIZE
" items.",
5263 data.zombie_object_count,
5268 gc_report(5,
objspace,
"gc_verify_internal_consistency: OK\n");
5272gc_verify_internal_consistency(
void *objspace_ptr)
5276 unsigned int lev = RB_GC_VM_LOCK();
5280 unsigned int prev_during_gc = during_gc;
5283 gc_verify_internal_consistency_(
objspace);
5285 during_gc = prev_during_gc;
5287 RB_GC_VM_UNLOCK(lev);
5291heap_move_pooled_pages_to_free_pages(
rb_heap_t *heap)
5293 if (heap->pooled_pages) {
5294 if (heap->free_pages) {
5295 struct heap_page *free_pages_tail = heap->free_pages;
5296 while (free_pages_tail->free_next) {
5297 free_pages_tail = free_pages_tail->free_next;
5299 free_pages_tail->free_next = heap->pooled_pages;
5302 heap->free_pages = heap->pooled_pages;
5305 heap->pooled_pages = NULL;
5312 struct heap_page *page = GET_HEAP_PAGE(obj);
5313 bits_t *uncollectible_bits = &page->uncollectible_bits[0];
5315 if (!MARKED_IN_BITMAP(uncollectible_bits, obj)) {
5316 page->flags.has_uncollectible_wb_unprotected_objects = TRUE;
5317 MARK_IN_BITMAP(uncollectible_bits, obj);
5318 objspace->rgengc.uncollectible_wb_unprotected_objects++;
5320#if RGENGC_PROFILE > 0
5321 objspace->profile.total_remembered_shady_object_count++;
5322#if RGENGC_PROFILE >= 2
5339 gc_report(2,
objspace,
"gc_marks_wb_unprotected_objects: marked shady: %s\n", rb_obj_info((
VALUE)p));
5344 p += BASE_SLOT_SIZE;
5355 ccan_list_for_each(&heap->pages, page, page_node) {
5356 bits_t *mark_bits = page->mark_bits;
5357 bits_t *wbun_bits = page->wb_unprotected_bits;
5358 uintptr_t p = page->start;
5361 bits_t bits = mark_bits[0] & wbun_bits[0];
5362 bits >>= NUM_IN_PAGE(p);
5363 gc_marks_wb_unprotected_objects_plane(
objspace, p, bits);
5364 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
5366 for (j=1; j<HEAP_PAGE_BITMAP_LIMIT; j++) {
5367 bits_t bits = mark_bits[j] & wbun_bits[j];
5369 gc_marks_wb_unprotected_objects_plane(
objspace, p, bits);
5370 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
5374 gc_mark_stacked_objects_all(
objspace);
5380 size_t retained_weak_references_count = 0;
5382 rb_darray_foreach(
objspace->weak_references, i, ptr_ptr) {
5383 if (!*ptr_ptr)
continue;
5385 VALUE obj = **ptr_ptr;
5389 if (!RVALUE_MARKED(
objspace, obj)) {
5393 retained_weak_references_count++;
5397 objspace->profile.retained_weak_references_count = retained_weak_references_count;
5399 rb_darray_clear(
objspace->weak_references);
5400 rb_darray_resize_capa_without_gc(&
objspace->weak_references, retained_weak_references_count);
5407 if (is_incremental_marking(
objspace)) {
5408 if (RGENGC_CHECK_MODE && is_mark_stack_empty(&
objspace->mark_stack) == 0) {
5409 rb_bug(
"gc_marks_finish: mark stack is not empty (%"PRIdSIZE
").",
5410 mark_stack_size(&
objspace->mark_stack));
5414 while (gc_mark_stacked_objects_incremental(
objspace, INT_MAX) ==
false);
5416#if RGENGC_CHECK_MODE >= 2
5417 if (gc_verify_heap_pages(
objspace) != 0) {
5418 rb_bug(
"gc_marks_finish (incremental): there are remembered old objects.");
5422 objspace->flags.during_incremental_marking = FALSE;
5424 for (
int i = 0; i < HEAP_COUNT; i++) {
5425 gc_marks_wb_unprotected_objects(
objspace, &heaps[i]);
5429 gc_update_weak_references(
objspace);
5431#if RGENGC_CHECK_MODE >= 2
5432 gc_verify_internal_consistency(
objspace);
5435#if RGENGC_CHECK_MODE >= 4
5437 gc_marks_check(
objspace, gc_check_after_marks_i,
"after_marks");
5442 const unsigned long r_mul =
objspace->live_ractor_cache_count > 8 ? 8 :
objspace->live_ractor_cache_count;
5444 size_t total_slots = objspace_available_slots(
objspace);
5445 size_t sweep_slots = total_slots -
objspace->marked_slots;
5446 size_t max_free_slots = (size_t)(total_slots * gc_params.heap_free_slots_max_ratio);
5447 size_t min_free_slots = (size_t)(total_slots * gc_params.heap_free_slots_min_ratio);
5448 if (min_free_slots < gc_params.heap_free_slots * r_mul) {
5449 min_free_slots = gc_params.heap_free_slots * r_mul;
5452 int full_marking = is_full_marking(
objspace);
5457 size_t total_init_slots = 0;
5458 for (
int i = 0; i < HEAP_COUNT; i++) {
5459 total_init_slots += gc_params.heap_init_slots[i] * r_mul;
5462 if (max_free_slots < total_init_slots) {
5463 max_free_slots = total_init_slots;
5466 if (sweep_slots > max_free_slots) {
5467 heap_pages_freeable_pages = (sweep_slots - max_free_slots) / HEAP_PAGE_OBJ_LIMIT;
5470 heap_pages_freeable_pages = 0;
5473 if (
objspace->heap_pages.allocatable_slots == 0 && sweep_slots < min_free_slots) {
5474 if (!full_marking) {
5475 if (
objspace->profile.count -
objspace->rgengc.last_major_gc < RVALUE_OLD_AGE) {
5476 full_marking = TRUE;
5479 gc_report(1,
objspace,
"gc_marks_finish: next is full GC!!)\n");
5480 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_NOFREE;
5485 heap_allocatable_slots_expand(
objspace, NULL, sweep_slots, total_slots);
5491 const double r = gc_params.oldobject_limit_factor;
5492 objspace->rgengc.uncollectible_wb_unprotected_objects_limit = MAX(
5493 (
size_t)(
objspace->rgengc.uncollectible_wb_unprotected_objects * r),
5494 (
size_t)(
objspace->rgengc.old_objects * gc_params.uncollectible_wb_unprotected_objects_limit_ratio)
5496 objspace->rgengc.old_objects_limit = (size_t)(
objspace->rgengc.old_objects * r);
5499 if (
objspace->rgengc.uncollectible_wb_unprotected_objects >
objspace->rgengc.uncollectible_wb_unprotected_objects_limit) {
5500 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_SHADY;
5503 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_OLDGEN;
5506 gc_report(1,
objspace,
"gc_marks_finish (marks %"PRIdSIZE
" objects, "
5507 "old %"PRIdSIZE
" objects, total %"PRIdSIZE
" slots, "
5508 "sweep %"PRIdSIZE
" slots, allocatable %"PRIdSIZE
" slots, next GC: %s)\n",
5510 gc_needs_major_flags ?
"major" :
"minor");
5514 rb_ractor_finish_marking();
5520gc_compact_heap_cursors_met_p(
rb_heap_t *heap)
5522 return heap->sweeping_page == heap->compact_cursor;
5529 size_t obj_size = rb_gc_obj_optimal_size(obj);
5530 if (obj_size == 0) {
5535 if (rb_gc_impl_size_allocatable_p(obj_size)) {
5536 idx = heap_idx_for_size(obj_size);
5546 GC_ASSERT(gc_is_moveable_obj(
objspace, src));
5549 uint32_t orig_shape = 0;
5550 uint32_t new_shape = 0;
5552 if (gc_compact_heap_cursors_met_p(dest_pool)) {
5553 return dest_pool != heap;
5557 orig_shape = rb_gc_get_shape(src);
5559 if (dest_pool != heap) {
5560 new_shape = rb_gc_rebuild_shape(src, dest_pool - heaps);
5562 if (new_shape == 0) {
5568 while (!try_move(
objspace, dest_pool, dest_pool->free_pages, src)) {
5570 .page = dest_pool->sweeping_page,
5579 lock_page_body(
objspace, GET_PAGE_BODY(src));
5580 gc_sweep_page(
objspace, dest_pool, &ctx);
5581 unlock_page_body(
objspace, GET_PAGE_BODY(src));
5583 if (dest_pool->sweeping_page->free_slots > 0) {
5584 heap_add_freepage(dest_pool, dest_pool->sweeping_page);
5587 dest_pool->sweeping_page = ccan_list_next(&dest_pool->pages, dest_pool->sweeping_page, page_node);
5588 if (gc_compact_heap_cursors_met_p(dest_pool)) {
5589 return dest_pool != heap;
5593 if (orig_shape != 0) {
5594 if (new_shape != 0) {
5596 rb_gc_set_shape(dest, new_shape);
5598 RMOVED(src)->original_shape_id = orig_shape;
5607 short slot_size = page->slot_size;
5608 short slot_bits = slot_size / BASE_SLOT_SIZE;
5609 GC_ASSERT(slot_bits > 0);
5613 GC_ASSERT(vp % BASE_SLOT_SIZE == 0);
5618 if (gc_is_moveable_obj(
objspace, vp)) {
5619 if (!gc_compact_move(
objspace, heap, vp)) {
5626 bitset >>= slot_bits;
5636 GC_ASSERT(page == heap->compact_cursor);
5638 bits_t *mark_bits, *pin_bits;
5640 uintptr_t p = page->start;
5642 mark_bits = page->mark_bits;
5643 pin_bits = page->pinned_bits;
5646 bitset = (mark_bits[0] & ~pin_bits[0]);
5647 bitset >>= NUM_IN_PAGE(p);
5649 if (!gc_compact_plane(
objspace, heap, (uintptr_t)p, bitset, page))
5652 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
5654 for (
int j = 1; j < HEAP_PAGE_BITMAP_LIMIT; j++) {
5655 bitset = (mark_bits[j] & ~pin_bits[j]);
5657 if (!gc_compact_plane(
objspace, heap, (uintptr_t)p, bitset, page))
5660 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
5669 for (
int i = 0; i < HEAP_COUNT; i++) {
5672 if (heap->total_pages > 0 &&
5673 !gc_compact_heap_cursors_met_p(heap)) {
5685#if RGENGC_CHECK_MODE >= 2
5686 gc_verify_internal_consistency(
objspace);
5689 while (!gc_compact_all_compacted_p(
objspace)) {
5690 for (
int i = 0; i < HEAP_COUNT; i++) {
5693 if (gc_compact_heap_cursors_met_p(heap)) {
5697 struct heap_page *start_page = heap->compact_cursor;
5699 if (!gc_compact_page(
objspace, heap, start_page)) {
5700 lock_page_body(
objspace, start_page->body);
5707 lock_page_body(
objspace, start_page->body);
5708 heap->compact_cursor = ccan_list_prev(&heap->pages, heap->compact_cursor, page_node);
5714#if RGENGC_CHECK_MODE >= 2
5715 gc_verify_internal_consistency(
objspace);
5722 gc_report(1,
objspace,
"gc_marks_rest\n");
5724 for (
int i = 0; i < HEAP_COUNT; i++) {
5725 (&heaps[i])->pooled_pages = NULL;
5728 if (is_incremental_marking(
objspace)) {
5729 while (gc_mark_stacked_objects_incremental(
objspace, INT_MAX) == FALSE);
5732 gc_mark_stacked_objects_all(
objspace);
5741 bool marking_finished =
false;
5744 if (gc_mark_stacked_objects_incremental(
objspace, slots)) {
5747 marking_finished =
true;
5750 return marking_finished;
5756 GC_ASSERT(dont_gc_val() == FALSE ||
objspace->profile.latest_gc_info & GPR_FLAG_METHOD);
5757 bool marking_finished =
true;
5761 if (heap->free_pages) {
5762 gc_report(2,
objspace,
"gc_marks_continue: has pooled pages");
5767 gc_report(2,
objspace,
"gc_marks_continue: no more pooled pages (stack depth: %"PRIdSIZE
").\n",
5768 mark_stack_size(&
objspace->mark_stack));
5769 heap->force_incremental_marking_finish_count++;
5775 return marking_finished;
5782 gc_report(1,
objspace,
"gc_marks_start: (%s)\n", full_mark ?
"full" :
"minor");
5783 gc_mode_transition(
objspace, gc_mode_marking);
5786 size_t incremental_marking_steps = (
objspace->rincgc.pooled_slots / INCREMENTAL_MARK_STEP_ALLOCATIONS) + 1;
5787 objspace->rincgc.step_slots = (
objspace->marked_slots * 2) / incremental_marking_steps;
5789 if (0) fprintf(stderr,
"objspace->marked_slots: %"PRIdSIZE
", "
5790 "objspace->rincgc.pooled_page_num: %"PRIdSIZE
", "
5791 "objspace->rincgc.step_slots: %"PRIdSIZE
", \n",
5793 objspace->flags.during_minor_gc = FALSE;
5794 if (ruby_enable_autocompact) {
5795 objspace->flags.during_compacting |= TRUE;
5797 objspace->profile.major_gc_count++;
5798 objspace->rgengc.uncollectible_wb_unprotected_objects = 0;
5803 for (
int i = 0; i < HEAP_COUNT; i++) {
5805 rgengc_mark_and_rememberset_clear(
objspace, heap);
5806 heap_move_pooled_pages_to_free_pages(heap);
5808 if (
objspace->flags.during_compacting) {
5811 ccan_list_for_each(&heap->pages, page, page_node) {
5812 page->pinned_slots = 0;
5818 objspace->flags.during_minor_gc = TRUE;
5820 objspace->rgengc.old_objects +
objspace->rgengc.uncollectible_wb_unprotected_objects;
5821 objspace->profile.minor_gc_count++;
5823 for (
int i = 0; i < HEAP_COUNT; i++) {
5824 rgengc_rememberset_mark(
objspace, &heaps[i]);
5830 gc_report(1,
objspace,
"gc_marks_start: (%s) end, stack in %"PRIdSIZE
"\n",
5837 gc_prof_mark_timer_start(
objspace);
5840 bool marking_finished =
false;
5844 gc_marks_start(
objspace, full_mark);
5845 if (!is_incremental_marking(
objspace)) {
5847 marking_finished =
true;
5850#if RGENGC_PROFILE > 0
5853 record->old_objects =
objspace->rgengc.old_objects;
5860 return marking_finished;
5868 if (level <= RGENGC_DEBUG) {
5872 const char *status =
" ";
5875 status = is_full_marking(
objspace) ?
"+" :
"-";
5881 if (is_incremental_marking(
objspace)) {
5886 va_start(args, fmt);
5887 vsnprintf(buf, 1024, fmt, args);
5890 fprintf(out,
"%s|", status);
5900 struct heap_page *page = GET_HEAP_PAGE(obj);
5901 bits_t *bits = &page->remembered_bits[0];
5903 if (MARKED_IN_BITMAP(bits, obj)) {
5907 page->flags.has_remembered_objects = TRUE;
5908 MARK_IN_BITMAP(bits, obj);
5919 gc_report(6,
objspace,
"rgengc_remember: %s %s\n", rb_obj_info(obj),
5920 RVALUE_REMEMBERED(
objspace, obj) ?
"was already remembered" :
"is remembered now");
5922 check_rvalue_consistency(
objspace, obj);
5924 if (RGENGC_CHECK_MODE) {
5925 if (RVALUE_WB_UNPROTECTED(
objspace, obj)) rb_bug(
"rgengc_remember: %s is not wb protected.", rb_obj_info(obj));
5928#if RGENGC_PROFILE > 0
5929 if (!RVALUE_REMEMBERED(
objspace, obj)) {
5930 if (RVALUE_WB_UNPROTECTED(
objspace, obj) == 0) {
5931 objspace->profile.total_remembered_normal_object_count++;
5932#if RGENGC_PROFILE >= 2
5939 return rgengc_remembersetbits_set(
objspace, obj);
5942#ifndef PROFILE_REMEMBERSET_MARK
5943#define PROFILE_REMEMBERSET_MARK 0
5953 gc_report(2,
objspace,
"rgengc_rememberset_mark: mark %s\n", rb_obj_info(obj));
5954 GC_ASSERT(RVALUE_UNCOLLECTIBLE(
objspace, obj));
5955 GC_ASSERT(RVALUE_OLD_P(
objspace, obj) || RVALUE_WB_UNPROTECTED(
objspace, obj));
5959 p += BASE_SLOT_SIZE;
5970#if PROFILE_REMEMBERSET_MARK
5971 int has_old = 0, has_shady = 0, has_both = 0, skip = 0;
5973 gc_report(1,
objspace,
"rgengc_rememberset_mark: start\n");
5975 ccan_list_for_each(&heap->pages, page, page_node) {
5976 if (page->flags.has_remembered_objects | page->flags.has_uncollectible_wb_unprotected_objects) {
5977 uintptr_t p = page->start;
5978 bits_t bitset, bits[HEAP_PAGE_BITMAP_LIMIT];
5979 bits_t *remembered_bits = page->remembered_bits;
5980 bits_t *uncollectible_bits = page->uncollectible_bits;
5981 bits_t *wb_unprotected_bits = page->wb_unprotected_bits;
5982#if PROFILE_REMEMBERSET_MARK
5983 if (page->flags.has_remembered_objects && page->flags.has_uncollectible_wb_unprotected_objects) has_both++;
5984 else if (page->flags.has_remembered_objects) has_old++;
5985 else if (page->flags.has_uncollectible_wb_unprotected_objects) has_shady++;
5987 for (j=0; j<HEAP_PAGE_BITMAP_LIMIT; j++) {
5988 bits[j] = remembered_bits[j] | (uncollectible_bits[j] & wb_unprotected_bits[j]);
5989 remembered_bits[j] = 0;
5991 page->flags.has_remembered_objects = FALSE;
5994 bitset >>= NUM_IN_PAGE(p);
5995 rgengc_rememberset_mark_plane(
objspace, p, bitset);
5996 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
5998 for (j=1; j < HEAP_PAGE_BITMAP_LIMIT; j++) {
6000 rgengc_rememberset_mark_plane(
objspace, p, bitset);
6001 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
6004#if PROFILE_REMEMBERSET_MARK
6011#if PROFILE_REMEMBERSET_MARK
6012 fprintf(stderr,
"%d\t%d\t%d\t%d\n", has_both, has_old, has_shady, skip);
6014 gc_report(1,
objspace,
"rgengc_rememberset_mark: finished\n");
6022 ccan_list_for_each(&heap->pages, page, page_node) {
6023 memset(&page->mark_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6024 memset(&page->uncollectible_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6025 memset(&page->marking_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6026 memset(&page->remembered_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6027 memset(&page->pinned_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6028 page->flags.has_uncollectible_wb_unprotected_objects = FALSE;
6029 page->flags.has_remembered_objects = FALSE;
6040 if (RGENGC_CHECK_MODE) {
6041 if (!RVALUE_OLD_P(
objspace, a)) rb_bug(
"gc_writebarrier_generational: %s is not an old object.", rb_obj_info(a));
6042 if ( RVALUE_OLD_P(
objspace, b)) rb_bug(
"gc_writebarrier_generational: %s is an old object.", rb_obj_info(b));
6043 if (is_incremental_marking(
objspace)) rb_bug(
"gc_writebarrier_generational: called while incremental marking: %s -> %s", rb_obj_info(a), rb_obj_info(b));
6047 if (!RVALUE_REMEMBERED(
objspace, a)) {
6048 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6052 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6054 gc_report(1,
objspace,
"gc_writebarrier_generational: %s (remembered) -> %s\n", rb_obj_info(a), rb_obj_info(b));
6057 check_rvalue_consistency(
objspace, a);
6058 check_rvalue_consistency(
objspace, b);
6064 gc_mark_set_parent(
objspace, parent);
6065 rgengc_check_relation(
objspace, obj);
6066 if (gc_mark_set(
objspace, obj) != FALSE) {
6070 gc_mark_set_parent_invalid(
objspace);
6078 gc_report(2,
objspace,
"gc_writebarrier_incremental: [LG] %p -> %s\n", (
void *)a, rb_obj_info(b));
6082 if (!RVALUE_WB_UNPROTECTED(
objspace, a)) {
6083 gc_report(2,
objspace,
"gc_writebarrier_incremental: [IN] %p -> %s\n", (
void *)a, rb_obj_info(b));
6091 if (RB_UNLIKELY(
objspace->flags.during_compacting)) {
6092 MARK_IN_BITMAP(GET_HEAP_PINNED_BITS(b), b);
6098rb_gc_impl_writebarrier(
void *objspace_ptr,
VALUE a,
VALUE b)
6102 if (RGENGC_CHECK_MODE) {
6103 if (
SPECIAL_CONST_P(a)) rb_bug(
"rb_gc_writebarrier: a is special const: %"PRIxVALUE, a);
6108 GC_ASSERT(!during_gc);
6117 if (!is_incremental_marking(
objspace)) {
6122 gc_writebarrier_generational(a, b,
objspace);
6128 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6130 if (is_incremental_marking(
objspace)) {
6131 gc_writebarrier_incremental(a, b,
objspace);
6137 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6139 if (retry)
goto retry;
6145rb_gc_impl_writebarrier_unprotect(
void *objspace_ptr,
VALUE obj)
6149 if (RVALUE_WB_UNPROTECTED(
objspace, obj)) {
6153 gc_report(2,
objspace,
"rb_gc_writebarrier_unprotect: %s %s\n", rb_obj_info(obj),
6154 RVALUE_REMEMBERED(
objspace, obj) ?
" (already remembered)" :
"");
6156 unsigned int lev = RB_GC_VM_LOCK_NO_BARRIER();
6159 gc_report(1,
objspace,
"rb_gc_writebarrier_unprotect: %s\n", rb_obj_info(obj));
6162 gc_remember_unprotected(
objspace, obj);
6165 objspace->profile.total_shade_operation_count++;
6166#if RGENGC_PROFILE >= 2
6172 RVALUE_AGE_RESET(obj);
6175 RB_DEBUG_COUNTER_INC(obj_wb_unprotect);
6176 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), obj);
6178 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6183rb_gc_impl_copy_attributes(
void *objspace_ptr,
VALUE dest,
VALUE obj)
6187 if (RVALUE_WB_UNPROTECTED(
objspace, obj)) {
6188 rb_gc_impl_writebarrier_unprotect(
objspace, dest);
6190 rb_gc_impl_copy_finalizer(
objspace, dest, obj);
6194rb_gc_impl_active_gc_name(
void)
6200rb_gc_impl_writebarrier_remember(
void *objspace_ptr,
VALUE obj)
6204 gc_report(1,
objspace,
"rb_gc_writebarrier_remember: %s\n", rb_obj_info(obj));
6207 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6209 if (is_incremental_marking(
objspace)) {
6210 if (RVALUE_BLACK_P(
objspace, obj)) {
6214 else if (RVALUE_OLD_P(
objspace, obj)) {
6218 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6224 ID ID_wb_protected, ID_age, ID_old, ID_uncollectible, ID_marking,
6225 ID_marked, ID_pinned, ID_object_id, ID_shareable;
6228#define RB_GC_OBJECT_METADATA_ENTRY_COUNT (sizeof(struct rb_gc_object_metadata_names) / sizeof(ID))
6232rb_gc_impl_object_metadata(
void *objspace_ptr,
VALUE obj)
6238 if (!names.ID_marked) {
6239#define I(s) names.ID_##s = rb_intern(#s)
6252#define SET_ENTRY(na, v) do { \
6253 GC_ASSERT(n <= RB_GC_OBJECT_METADATA_ENTRY_COUNT); \
6254 object_metadata_entries[n].name = names.ID_##na; \
6255 object_metadata_entries[n].val = v; \
6259 if (!RVALUE_WB_UNPROTECTED(
objspace, obj)) SET_ENTRY(wb_protected,
Qtrue);
6260 SET_ENTRY(age,
INT2FIX(RVALUE_AGE_GET(obj)));
6262 if (RVALUE_UNCOLLECTIBLE(
objspace, obj)) SET_ENTRY(uncollectible,
Qtrue);
6263 if (RVALUE_MARKING(
objspace, obj)) SET_ENTRY(marking,
Qtrue);
6266 if (rb_obj_id_p(obj)) SET_ENTRY(object_id, rb_obj_id(obj));
6269 object_metadata_entries[n].name = 0;
6270 object_metadata_entries[n].val = 0;
6273 return object_metadata_entries;
6277rb_gc_impl_ractor_cache_alloc(
void *objspace_ptr,
void *ractor)
6281 objspace->live_ractor_cache_count++;
6287rb_gc_impl_ractor_cache_free(
void *objspace_ptr,
void *cache)
6291 objspace->live_ractor_cache_count--;
6292 gc_ractor_newobj_cache_clear(cache, NULL);
6299 if (!heap->free_pages) {
6300 if (!heap_page_allocate_and_initialize(
objspace, heap)) {
6301 objspace->heap_pages.allocatable_slots = 1;
6302 heap_page_allocate_and_initialize(
objspace, heap);
6310 if (dont_gc_val() || during_gc) {
6311 for (
int i = 0; i < HEAP_COUNT; i++) {
6328 size_t old_limit = malloc_limit;
6330 if (inc > malloc_limit) {
6331 malloc_limit = (size_t)(inc * gc_params.malloc_limit_growth_factor);
6332 if (malloc_limit > gc_params.malloc_limit_max) {
6333 malloc_limit = gc_params.malloc_limit_max;
6337 malloc_limit = (size_t)(malloc_limit * 0.98);
6338 if (malloc_limit < gc_params.malloc_limit_min) {
6339 malloc_limit = gc_params.malloc_limit_min;
6344 if (old_limit != malloc_limit) {
6345 fprintf(stderr,
"[%"PRIuSIZE
"] malloc_limit: %"PRIuSIZE
" -> %"PRIuSIZE
"\n",
6346 rb_gc_count(), old_limit, malloc_limit);
6349 fprintf(stderr,
"[%"PRIuSIZE
"] malloc_limit: not changed (%"PRIuSIZE
")\n",
6350 rb_gc_count(), malloc_limit);
6356#if RGENGC_ESTIMATE_OLDMALLOC
6358 if (
objspace->rgengc.oldmalloc_increase >
objspace->rgengc.oldmalloc_increase_limit) {
6359 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_OLDMALLOC;
6360 objspace->rgengc.oldmalloc_increase_limit =
6361 (size_t)(
objspace->rgengc.oldmalloc_increase_limit * gc_params.oldmalloc_limit_growth_factor);
6363 if (
objspace->rgengc.oldmalloc_increase_limit > gc_params.oldmalloc_limit_max) {
6364 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_max;
6368 if (0) fprintf(stderr,
"%"PRIdSIZE
"\t%d\t%"PRIuSIZE
"\t%"PRIuSIZE
"\t%"PRIdSIZE
"\n",
6370 gc_needs_major_flags,
6371 objspace->rgengc.oldmalloc_increase,
6372 objspace->rgengc.oldmalloc_increase_limit,
6373 gc_params.oldmalloc_limit_max);
6377 objspace->rgengc.oldmalloc_increase = 0;
6379 if ((
objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_BY_OLDMALLOC) == 0) {
6380 objspace->rgengc.oldmalloc_increase_limit =
6381 (size_t)(
objspace->rgengc.oldmalloc_increase_limit / ((gc_params.oldmalloc_limit_growth_factor - 1)/10 + 1));
6382 if (
objspace->rgengc.oldmalloc_increase_limit < gc_params.oldmalloc_limit_min) {
6383 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
6395 int lev = RB_GC_VM_LOCK();
6397#if GC_PROFILE_MORE_DETAIL
6398 objspace->profile.prepare_time = getrusage_time();
6403#if GC_PROFILE_MORE_DETAIL
6404 objspace->profile.prepare_time = getrusage_time() -
objspace->profile.prepare_time;
6409 RB_GC_VM_UNLOCK(lev);
6417 unsigned int do_full_mark = !!(reason & GPR_FLAG_FULL_MARK);
6419 if (!rb_darray_size(
objspace->heap_pages.sorted))
return TRUE;
6420 if (!(reason & GPR_FLAG_METHOD) && !ready_to_gc(
objspace))
return TRUE;
6422 GC_ASSERT(gc_mode(
objspace) == gc_mode_none,
"gc_mode is %s\n", gc_mode_name(gc_mode(
objspace)));
6423 GC_ASSERT(!is_lazy_sweeping(
objspace));
6424 GC_ASSERT(!is_incremental_marking(
objspace));
6426 unsigned int lock_lev;
6427 gc_enter(
objspace, gc_enter_event_start, &lock_lev);
6430 objspace->flags.immediate_sweep = !!(reason & GPR_FLAG_IMMEDIATE_SWEEP);
6432#if RGENGC_CHECK_MODE >= 2
6433 gc_verify_internal_consistency(
objspace);
6436 if (ruby_gc_stressful) {
6437 int flag =
FIXNUM_P(ruby_gc_stress_mode) ?
FIX2INT(ruby_gc_stress_mode) : 0;
6439 if ((flag & (1 << gc_stress_no_major)) == 0) {
6440 do_full_mark = TRUE;
6443 objspace->flags.immediate_sweep = !(flag & (1<<gc_stress_no_immediate_sweep));
6446 if (gc_needs_major_flags) {
6447 reason |= gc_needs_major_flags;
6448 do_full_mark = TRUE;
6452 if (!gc_config_full_mark_val) {
6453 do_full_mark = FALSE;
6455 gc_needs_major_flags = GPR_FLAG_NONE;
6457 if (do_full_mark && (reason & GPR_FLAG_MAJOR_MASK) == 0) {
6458 reason |= GPR_FLAG_MAJOR_BY_FORCE;
6461 if (
objspace->flags.dont_incremental ||
6462 reason & GPR_FLAG_IMMEDIATE_MARK ||
6463 ruby_gc_stressful) {
6464 objspace->flags.during_incremental_marking = FALSE;
6467 objspace->flags.during_incremental_marking = do_full_mark;
6471 if (do_full_mark && ruby_enable_autocompact) {
6472 objspace->flags.during_compacting = TRUE;
6473#if RGENGC_CHECK_MODE
6474 objspace->rcompactor.compare_func = ruby_autocompact_compare_func;
6478 objspace->flags.during_compacting = !!(reason & GPR_FLAG_COMPACT);
6481 if (!GC_ENABLE_LAZY_SWEEP ||
objspace->flags.dont_incremental) {
6482 objspace->flags.immediate_sweep = TRUE;
6485 if (
objspace->flags.immediate_sweep) reason |= GPR_FLAG_IMMEDIATE_SWEEP;
6487 gc_report(1,
objspace,
"gc_start(reason: %x) => %u, %d, %d\n",
6489 do_full_mark, !is_incremental_marking(
objspace),
objspace->flags.immediate_sweep);
6491 RB_DEBUG_COUNTER_INC(gc_count);
6493 if (reason & GPR_FLAG_MAJOR_MASK) {
6494 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_nofree, reason & GPR_FLAG_MAJOR_BY_NOFREE);
6495 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_oldgen, reason & GPR_FLAG_MAJOR_BY_OLDGEN);
6496 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_shady, reason & GPR_FLAG_MAJOR_BY_SHADY);
6497 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_force, reason & GPR_FLAG_MAJOR_BY_FORCE);
6498#if RGENGC_ESTIMATE_OLDMALLOC
6499 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_oldmalloc, reason & GPR_FLAG_MAJOR_BY_OLDMALLOC);
6503 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_newobj, reason & GPR_FLAG_NEWOBJ);
6504 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_malloc, reason & GPR_FLAG_MALLOC);
6505 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_method, reason & GPR_FLAG_METHOD);
6506 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_capi, reason & GPR_FLAG_CAPI);
6507 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_stress, reason & GPR_FLAG_STRESS);
6511 objspace->profile.latest_gc_info = reason;
6512 objspace->profile.total_allocated_objects_at_gc_start = total_allocated_objects(
objspace);
6513 objspace->profile.heap_used_at_gc_start = rb_darray_size(
objspace->heap_pages.sorted);
6514 objspace->profile.weak_references_count = 0;
6515 objspace->profile.retained_weak_references_count = 0;
6516 gc_prof_setup_new_record(
objspace, reason);
6517 gc_reset_malloc_info(
objspace, do_full_mark);
6521 GC_ASSERT(during_gc);
6525 if (gc_marks(
objspace, do_full_mark)) {
6531 gc_exit(
objspace, gc_enter_event_start, &lock_lev);
6539 unsigned int lock_lev;
6540 gc_enter(
objspace, gc_enter_event_rest, &lock_lev);
6542 if (RGENGC_CHECK_MODE >= 2) gc_verify_internal_consistency(
objspace);
6544 if (is_incremental_marking(
objspace)) {
6558 gc_exit(
objspace, gc_enter_event_rest, &lock_lev);
6564 unsigned int reason;
6573 if (is_full_marking(
objspace)) buff[i++] =
'F';
6574 if (is_incremental_marking(
objspace)) buff[i++] =
'I';
6578 if (is_lazy_sweeping(
objspace)) buff[i++] =
'L';
6589 static char buff[0x10];
6590 gc_current_status_fill(
objspace, buff);
6594#if PRINT_ENTER_EXIT_TICK
6596static tick_t last_exit_tick;
6597static tick_t enter_tick;
6598static int enter_count = 0;
6599static char last_gc_status[0x10];
6604 if (direction == 0) {
6606 enter_tick = tick();
6607 gc_current_status_fill(
objspace, last_gc_status);
6610 tick_t exit_tick = tick();
6611 char current_gc_status[0x10];
6612 gc_current_status_fill(
objspace, current_gc_status);
6615 fprintf(stderr,
"%"PRItick
"\t%"PRItick
"\t%s\t[%s->%s|%c]\n",
6616 enter_tick - last_exit_tick,
6617 exit_tick - enter_tick,
6619 last_gc_status, current_gc_status,
6620 (
objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_MASK) ?
'+' :
'-');
6621 last_exit_tick = exit_tick;
6624 fprintf(stderr,
"%"PRItick
"\t%"PRItick
"\t%s\t[%s->%s|%c]\n",
6626 exit_tick - enter_tick,
6628 last_gc_status, current_gc_status,
6629 (
objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_MASK) ?
'+' :
'-');
6642gc_enter_event_cstr(
enum gc_enter_event event)
6645 case gc_enter_event_start:
return "start";
6646 case gc_enter_event_continue:
return "continue";
6647 case gc_enter_event_rest:
return "rest";
6648 case gc_enter_event_finalizer:
return "finalizer";
6654gc_enter_count(
enum gc_enter_event event)
6657 case gc_enter_event_start: RB_DEBUG_COUNTER_INC(gc_enter_start);
break;
6658 case gc_enter_event_continue: RB_DEBUG_COUNTER_INC(gc_enter_continue);
break;
6659 case gc_enter_event_rest: RB_DEBUG_COUNTER_INC(gc_enter_rest);
break;
6660 case gc_enter_event_finalizer: RB_DEBUG_COUNTER_INC(gc_enter_finalizer);
break;
6664static bool current_process_time(
struct timespec *ts);
6669 if (!current_process_time(ts)) {
6675static unsigned long long
6680 if ((ts->tv_sec > 0 || ts->tv_nsec > 0) &&
6681 current_process_time(&end_time) &&
6682 end_time.tv_sec >= ts->tv_sec) {
6683 return (
unsigned long long)(end_time.tv_sec - ts->tv_sec) * (1000 * 1000 * 1000) +
6684 (end_time.tv_nsec - ts->tv_nsec);
6693 *lock_lev = RB_GC_VM_LOCK();
6696 case gc_enter_event_rest:
6697 case gc_enter_event_start:
6698 case gc_enter_event_continue:
6706 gc_enter_count(event);
6707 if (RB_UNLIKELY(during_gc != 0)) rb_bug(
"during_gc != 0");
6708 if (RGENGC_CHECK_MODE >= 3) gc_verify_internal_consistency(
objspace);
6709 GC_ASSERT(!
objspace->flags.check_shareable);
6712 RUBY_DEBUG_LOG(
"%s (%s)",gc_enter_event_cstr(event), gc_current_status(
objspace));
6713 gc_report(1,
objspace,
"gc_enter: %s [%s]\n", gc_enter_event_cstr(event), gc_current_status(
objspace));
6714 gc_record(
objspace, 0, gc_enter_event_cstr(event));
6722 GC_ASSERT(during_gc != 0);
6723 GC_ASSERT(!
objspace->flags.check_shareable);
6727 gc_record(
objspace, 1, gc_enter_event_cstr(event));
6728 RUBY_DEBUG_LOG(
"%s (%s)", gc_enter_event_cstr(event), gc_current_status(
objspace));
6729 gc_report(1,
objspace,
"gc_exit: %s [%s]\n", gc_enter_event_cstr(event), gc_current_status(
objspace));
6732 RB_GC_VM_UNLOCK(*lock_lev);
6736#define MEASURE_GC (objspace->flags.measure_gc)
6742 GC_ASSERT(during_gc != 0);
6745 gc_clock_start(&
objspace->profile.marking_start_time);
6752 GC_ASSERT(during_gc != 0);
6755 objspace->profile.marking_time_ns += gc_clock_end(&
objspace->profile.marking_start_time);
6762 GC_ASSERT(during_gc != 0);
6765 gc_clock_start(&
objspace->profile.sweeping_start_time);
6772 GC_ASSERT(during_gc != 0);
6775 objspace->profile.sweeping_time_ns += gc_clock_end(&
objspace->profile.sweeping_start_time);
6780gc_with_gvl(
void *ptr)
6783 return (
void *)(
VALUE)garbage_collect(oar->objspace, oar->reason);
6786int ruby_thread_has_gvl_p(
void);
6791 if (dont_gc_val()) {
6797 else if (!ruby_thread_has_gvl_p()) {
6801 oar.reason = reason;
6807 return garbage_collect(
objspace, reason);
6812gc_set_candidate_object_i(
void *vstart,
void *vend,
size_t stride,
void *data)
6817 for (; v != (
VALUE)vend; v += stride) {
6818 asan_unpoisoning_object(v) {
6824 rb_gc_prepare_heap_process_object(v);
6826 RVALUE_AGE_SET_CANDIDATE(
objspace, v);
6836rb_gc_impl_start(
void *objspace_ptr,
bool full_mark,
bool immediate_mark,
bool immediate_sweep,
bool compact)
6839 unsigned int reason = (GPR_FLAG_FULL_MARK |
6840 GPR_FLAG_IMMEDIATE_MARK |
6841 GPR_FLAG_IMMEDIATE_SWEEP |
6844 int full_marking_p = gc_config_full_mark_val;
6845 gc_config_full_mark_set(TRUE);
6849 GC_ASSERT(GC_COMPACTION_SUPPORTED);
6851 reason |= GPR_FLAG_COMPACT;
6854 if (!full_mark) reason &= ~GPR_FLAG_FULL_MARK;
6855 if (!immediate_mark) reason &= ~GPR_FLAG_IMMEDIATE_MARK;
6856 if (!immediate_sweep) reason &= ~GPR_FLAG_IMMEDIATE_SWEEP;
6862 gc_config_full_mark_set(full_marking_p);
6866rb_gc_impl_prepare_heap(
void *objspace_ptr)
6870 size_t orig_total_slots = objspace_available_slots(
objspace);
6871 size_t orig_allocatable_slots =
objspace->heap_pages.allocatable_slots;
6873 rb_gc_impl_each_objects(
objspace, gc_set_candidate_object_i, objspace_ptr);
6875 double orig_max_free_slots = gc_params.heap_free_slots_max_ratio;
6877 gc_params.heap_free_slots_max_ratio = 0.0;
6878 rb_gc_impl_start(
objspace,
true,
true,
true,
true);
6879 gc_params.heap_free_slots_max_ratio = orig_max_free_slots;
6881 objspace->heap_pages.allocatable_slots = 0;
6882 heap_pages_freeable_pages =
objspace->empty_pages_count;
6883 heap_pages_free_unused_pages(objspace_ptr);
6884 GC_ASSERT(heap_pages_freeable_pages == 0);
6885 GC_ASSERT(
objspace->empty_pages_count == 0);
6886 objspace->heap_pages.allocatable_slots = orig_allocatable_slots;
6888 size_t total_slots = objspace_available_slots(
objspace);
6889 if (orig_total_slots > total_slots) {
6890 objspace->heap_pages.allocatable_slots += orig_total_slots - total_slots;
6893#if defined(HAVE_MALLOC_TRIM) && !defined(RUBY_ALTERNATIVE_MALLOC_HEADER)
6939 GC_ASSERT(st_is_member(finalizer_table, obj));
6943 GC_ASSERT(RVALUE_MARKED(
objspace, obj));
6944 GC_ASSERT(!RVALUE_PINNED(
objspace, obj));
6949 rb_bug(
"gc_is_moveable_obj: unreachable (%d)", (
int)
BUILTIN_TYPE(obj));
6956void rb_mv_generic_ivar(
VALUE src,
VALUE dst);
6966 gc_report(4,
objspace,
"Moving object: %p -> %p\n", (
void *)src, (
void *)dest);
6969 GC_ASSERT(!MARKED_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest));
6971 GC_ASSERT(!RVALUE_MARKING(
objspace, src));
6974 marked = RVALUE_MARKED(
objspace, src);
6975 wb_unprotected = RVALUE_WB_UNPROTECTED(
objspace, src);
6976 uncollectible = RVALUE_UNCOLLECTIBLE(
objspace, src);
6977 bool remembered = RVALUE_REMEMBERED(
objspace, src);
6978 age = RVALUE_AGE_GET(src);
6981 CLEAR_IN_BITMAP(GET_HEAP_MARK_BITS(src), src);
6982 CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(src), src);
6983 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(src), src);
6984 CLEAR_IN_BITMAP(GET_HEAP_PAGE(src)->remembered_bits, src);
6987 memcpy((
void *)dest, (
void *)src, MIN(src_slot_size, slot_size));
6989 if (RVALUE_OVERHEAD > 0) {
6990 void *dest_overhead = (
void *)(((uintptr_t)dest) + slot_size - RVALUE_OVERHEAD);
6991 void *src_overhead = (
void *)(((uintptr_t)src) + src_slot_size - RVALUE_OVERHEAD);
6993 memcpy(dest_overhead, src_overhead, RVALUE_OVERHEAD);
6996 memset((
void *)src, 0, src_slot_size);
6997 RVALUE_AGE_RESET(src);
7001 MARK_IN_BITMAP(GET_HEAP_PAGE(dest)->remembered_bits, dest);
7004 CLEAR_IN_BITMAP(GET_HEAP_PAGE(dest)->remembered_bits, dest);
7008 MARK_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest);
7011 CLEAR_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest);
7014 if (wb_unprotected) {
7015 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(dest), dest);
7018 CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(dest), dest);
7021 if (uncollectible) {
7022 MARK_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(dest), dest);
7025 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(dest), dest);
7028 RVALUE_AGE_SET(dest, age);
7031 RMOVED(src)->dummy =
Qundef;
7032 RMOVED(src)->destination = dest;
7035 GET_HEAP_PAGE(src)->heap->total_freed_objects++;
7036 GET_HEAP_PAGE(dest)->heap->total_allocated_objects++;
7041#if GC_CAN_COMPILE_COMPACTION
7043compare_pinned_slots(
const void *left,
const void *right,
void *dummy)
7048 left_page = *(
struct heap_page *
const *)left;
7049 right_page = *(
struct heap_page *
const *)right;
7051 return left_page->pinned_slots - right_page->pinned_slots;
7055compare_free_slots(
const void *left,
const void *right,
void *dummy)
7060 left_page = *(
struct heap_page *
const *)left;
7061 right_page = *(
struct heap_page *
const *)right;
7063 return left_page->free_slots - right_page->free_slots;
7069 for (
int j = 0; j < HEAP_COUNT; j++) {
7072 size_t total_pages = heap->total_pages;
7074 struct heap_page *page = 0, **page_list = malloc(size);
7077 heap->free_pages = NULL;
7078 ccan_list_for_each(&heap->pages, page, page_node) {
7079 page_list[i++] = page;
7083 GC_ASSERT((
size_t)i == total_pages);
7090 ccan_list_head_init(&heap->pages);
7092 for (i = 0; i < total_pages; i++) {
7093 ccan_list_add(&heap->pages, &page_list[i]->page_node);
7094 if (page_list[i]->free_slots != 0) {
7095 heap_add_freepage(heap, page_list[i]);
7105rb_gc_impl_object_moved_p(
void *objspace_ptr,
VALUE obj)
7107 return gc_object_moved_p(objspace_ptr, obj);
7115 page->flags.has_uncollectible_wb_unprotected_objects = FALSE;
7116 page->flags.has_remembered_objects = FALSE;
7119 for (; v != (
VALUE)vend; v += stride) {
7120 asan_unpoisoning_object(v) {
7127 if (RVALUE_WB_UNPROTECTED(
objspace, v)) {
7128 page->flags.has_uncollectible_wb_unprotected_objects = TRUE;
7130 if (RVALUE_REMEMBERED(
objspace, v)) {
7131 page->flags.has_remembered_objects = TRUE;
7133 if (page->flags.before_sweep) {
7135 rb_gc_update_object_references(
objspace, v);
7139 rb_gc_update_object_references(
objspace, v);
7149gc_update_references_weak_table_i(
VALUE obj,
void *data)
7152 asan_unpoisoning_object(obj) {
7159gc_update_references_weak_table_replace_i(
VALUE *obj,
void *data)
7161 *obj = rb_gc_location(*obj);
7169 objspace->flags.during_reference_updating =
true;
7171 rb_gc_before_updating_jit_code();
7175 for (
int i = 0; i < HEAP_COUNT; i++) {
7176 bool should_set_mark_bits = TRUE;
7179 ccan_list_for_each(&heap->pages, page, page_node) {
7180 uintptr_t start = (uintptr_t)page->start;
7181 uintptr_t end = start + (page->total_slots * heap->slot_size);
7183 gc_ref_update((
void *)start, (
void *)end, heap->slot_size,
objspace, page);
7184 if (page == heap->sweeping_page) {
7185 should_set_mark_bits = FALSE;
7187 if (should_set_mark_bits) {
7188 gc_setup_mark_bits(page);
7193 gc_update_table_refs(finalizer_table);
7195 rb_gc_update_vm_references((
void *)
objspace);
7197 for (
int table = 0; table < RB_GC_VM_WEAK_TABLE_COUNT; table++) {
7198 rb_gc_vm_weak_table_foreach(
7199 gc_update_references_weak_table_i,
7200 gc_update_references_weak_table_replace_i,
7207 rb_gc_after_updating_jit_code();
7209 objspace->flags.during_reference_updating =
false;
7212#if GC_CAN_COMPILE_COMPACTION
7214root_obj_check_moved_i(
const char *category,
VALUE obj,
void *data)
7218 if (gc_object_moved_p(
objspace, obj)) {
7219 rb_bug(
"ROOT %s points to MOVED: %p -> %s", category, (
void *)obj, rb_obj_info(rb_gc_impl_location(
objspace, obj)));
7224reachable_object_check_moved_i(
VALUE ref,
void *data)
7227 if (gc_object_moved_p(rb_gc_get_objspace(), ref)) {
7228 rb_bug(
"Object %s points to MOVED: %p -> %s", rb_obj_info(parent), (
void *)ref, rb_obj_info(rb_gc_impl_location(rb_gc_get_objspace(), ref)));
7233heap_check_moved_i(
void *vstart,
void *vend,
size_t stride,
void *data)
7238 for (; v != (
VALUE)vend; v += stride) {
7239 if (gc_object_moved_p(
objspace, v)) {
7243 asan_unpoisoning_object(v) {
7249 if (!rb_gc_impl_garbage_object_p(
objspace, v)) {
7250 rb_objspace_reachable_objects_from(v, reachable_object_check_moved_i, (
void *)v);
7262rb_gc_impl_during_gc_p(
void *objspace_ptr)
7269#if RGENGC_PROFILE >= 2
7302 default:
return "unknown";
7307gc_count_add_each_types(
VALUE hash,
const char *name,
const size_t *types)
7311 for (i=0; i<
T_MASK; i++) {
7312 const char *
type = type_name(i, 0);
7315 rb_hash_aset(hash,
ID2SYM(rb_intern(name)), result);
7320rb_gc_impl_gc_count(
void *objspace_ptr)
7330 static VALUE sym_major_by =
Qnil, sym_gc_by, sym_immediate_sweep, sym_have_finalizer, sym_state, sym_need_major_by;
7331 static VALUE sym_nofree, sym_oldgen, sym_shady, sym_force, sym_stress;
7332#if RGENGC_ESTIMATE_OLDMALLOC
7333 static VALUE sym_oldmalloc;
7335 static VALUE sym_newobj, sym_malloc, sym_method, sym_capi;
7336 static VALUE sym_none, sym_marking, sym_sweeping;
7337 static VALUE sym_weak_references_count, sym_retained_weak_references_count;
7339 VALUE major_by, need_major_by;
7340 unsigned int flags = orig_flags ? orig_flags :
objspace->profile.latest_gc_info;
7349 rb_bug(
"gc_info_decode: non-hash or symbol given");
7352 if (
NIL_P(sym_major_by)) {
7353#define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
7366#if RGENGC_ESTIMATE_OLDMALLOC
7378 S(weak_references_count);
7379 S(retained_weak_references_count);
7383#define SET(name, attr) \
7384 if (key == sym_##name) \
7386 else if (hash != Qnil) \
7387 rb_hash_aset(hash, sym_##name, (attr));
7390 (flags & GPR_FLAG_MAJOR_BY_NOFREE) ? sym_nofree :
7391 (flags & GPR_FLAG_MAJOR_BY_OLDGEN) ? sym_oldgen :
7392 (flags & GPR_FLAG_MAJOR_BY_SHADY) ? sym_shady :
7393 (flags & GPR_FLAG_MAJOR_BY_FORCE) ? sym_force :
7394#if RGENGC_ESTIMATE_OLDMALLOC
7395 (flags & GPR_FLAG_MAJOR_BY_OLDMALLOC) ? sym_oldmalloc :
7398 SET(major_by, major_by);
7400 if (orig_flags == 0) {
7401 unsigned int need_major_flags = gc_needs_major_flags;
7403 (need_major_flags & GPR_FLAG_MAJOR_BY_NOFREE) ? sym_nofree :
7404 (need_major_flags & GPR_FLAG_MAJOR_BY_OLDGEN) ? sym_oldgen :
7405 (need_major_flags & GPR_FLAG_MAJOR_BY_SHADY) ? sym_shady :
7406 (need_major_flags & GPR_FLAG_MAJOR_BY_FORCE) ? sym_force :
7407#if RGENGC_ESTIMATE_OLDMALLOC
7408 (need_major_flags & GPR_FLAG_MAJOR_BY_OLDMALLOC) ? sym_oldmalloc :
7411 SET(need_major_by, need_major_by);
7415 (flags & GPR_FLAG_NEWOBJ) ? sym_newobj :
7416 (flags & GPR_FLAG_MALLOC) ? sym_malloc :
7417 (flags & GPR_FLAG_METHOD) ? sym_method :
7418 (flags & GPR_FLAG_CAPI) ? sym_capi :
7419 (flags & GPR_FLAG_STRESS) ? sym_stress :
7423 SET(have_finalizer, (flags & GPR_FLAG_HAVE_FINALIZE) ?
Qtrue :
Qfalse);
7424 SET(immediate_sweep, (flags & GPR_FLAG_IMMEDIATE_SWEEP) ?
Qtrue :
Qfalse);
7426 if (orig_flags == 0) {
7427 SET(state, gc_mode(
objspace) == gc_mode_none ? sym_none :
7428 gc_mode(
objspace) == gc_mode_marking ? sym_marking : sym_sweeping);
7431 SET(weak_references_count,
LONG2FIX(
objspace->profile.weak_references_count));
7432 SET(retained_weak_references_count,
LONG2FIX(
objspace->profile.retained_weak_references_count));
7444rb_gc_impl_latest_gc_info(
void *objspace_ptr,
VALUE key)
7448 return gc_info_decode(
objspace, key, 0);
7455 gc_stat_sym_marking_time,
7456 gc_stat_sym_sweeping_time,
7457 gc_stat_sym_heap_allocated_pages,
7458 gc_stat_sym_heap_empty_pages,
7459 gc_stat_sym_heap_allocatable_slots,
7460 gc_stat_sym_heap_available_slots,
7461 gc_stat_sym_heap_live_slots,
7462 gc_stat_sym_heap_free_slots,
7463 gc_stat_sym_heap_final_slots,
7464 gc_stat_sym_heap_marked_slots,
7465 gc_stat_sym_heap_eden_pages,
7466 gc_stat_sym_total_allocated_pages,
7467 gc_stat_sym_total_freed_pages,
7468 gc_stat_sym_total_allocated_objects,
7469 gc_stat_sym_total_freed_objects,
7470 gc_stat_sym_malloc_increase_bytes,
7471 gc_stat_sym_malloc_increase_bytes_limit,
7472 gc_stat_sym_minor_gc_count,
7473 gc_stat_sym_major_gc_count,
7474 gc_stat_sym_compact_count,
7475 gc_stat_sym_read_barrier_faults,
7476 gc_stat_sym_total_moved_objects,
7477 gc_stat_sym_remembered_wb_unprotected_objects,
7478 gc_stat_sym_remembered_wb_unprotected_objects_limit,
7479 gc_stat_sym_old_objects,
7480 gc_stat_sym_old_objects_limit,
7481#if RGENGC_ESTIMATE_OLDMALLOC
7482 gc_stat_sym_oldmalloc_increase_bytes,
7483 gc_stat_sym_oldmalloc_increase_bytes_limit,
7485 gc_stat_sym_weak_references_count,
7487 gc_stat_sym_total_generated_normal_object_count,
7488 gc_stat_sym_total_generated_shady_object_count,
7489 gc_stat_sym_total_shade_operation_count,
7490 gc_stat_sym_total_promoted_count,
7491 gc_stat_sym_total_remembered_normal_object_count,
7492 gc_stat_sym_total_remembered_shady_object_count,
7497static VALUE gc_stat_symbols[gc_stat_sym_last];
7500setup_gc_stat_symbols(
void)
7502 if (gc_stat_symbols[0] == 0) {
7503#define S(s) gc_stat_symbols[gc_stat_sym_##s] = ID2SYM(rb_intern_const(#s))
7508 S(heap_allocated_pages);
7509 S(heap_empty_pages);
7510 S(heap_allocatable_slots);
7511 S(heap_available_slots);
7514 S(heap_final_slots);
7515 S(heap_marked_slots);
7517 S(total_allocated_pages);
7518 S(total_freed_pages);
7519 S(total_allocated_objects);
7520 S(total_freed_objects);
7521 S(malloc_increase_bytes);
7522 S(malloc_increase_bytes_limit);
7526 S(read_barrier_faults);
7527 S(total_moved_objects);
7528 S(remembered_wb_unprotected_objects);
7529 S(remembered_wb_unprotected_objects_limit);
7531 S(old_objects_limit);
7532#if RGENGC_ESTIMATE_OLDMALLOC
7533 S(oldmalloc_increase_bytes);
7534 S(oldmalloc_increase_bytes_limit);
7536 S(weak_references_count);
7538 S(total_generated_normal_object_count);
7539 S(total_generated_shady_object_count);
7540 S(total_shade_operation_count);
7541 S(total_promoted_count);
7542 S(total_remembered_normal_object_count);
7543 S(total_remembered_shady_object_count);
7550ns_to_ms(uint64_t ns)
7552 return ns / (1000 * 1000);
7556rb_gc_impl_stat(
void *objspace_ptr,
VALUE hash_or_sym)
7561 setup_gc_stat_symbols();
7570 rb_bug(
"non-hash or symbol given");
7573#define SET(name, attr) \
7574 if (key == gc_stat_symbols[gc_stat_sym_##name]) \
7575 return SIZET2NUM(attr); \
7576 else if (hash != Qnil) \
7577 rb_hash_aset(hash, gc_stat_symbols[gc_stat_sym_##name], SIZET2NUM(attr));
7579 SET(count,
objspace->profile.count);
7580 SET(time, (
size_t)ns_to_ms(
objspace->profile.marking_time_ns +
objspace->profile.sweeping_time_ns));
7581 SET(marking_time, (
size_t)ns_to_ms(
objspace->profile.marking_time_ns));
7582 SET(sweeping_time, (
size_t)ns_to_ms(
objspace->profile.sweeping_time_ns));
7585 SET(heap_allocated_pages, rb_darray_size(
objspace->heap_pages.sorted));
7586 SET(heap_empty_pages,
objspace->empty_pages_count)
7587 SET(heap_allocatable_slots,
objspace->heap_pages.allocatable_slots);
7588 SET(heap_available_slots, objspace_available_slots(
objspace));
7589 SET(heap_live_slots, objspace_live_slots(
objspace));
7590 SET(heap_free_slots, objspace_free_slots(
objspace));
7591 SET(heap_final_slots, total_final_slots_count(
objspace));
7592 SET(heap_marked_slots,
objspace->marked_slots);
7593 SET(heap_eden_pages, heap_eden_total_pages(
objspace));
7594 SET(total_allocated_pages,
objspace->heap_pages.allocated_pages);
7595 SET(total_freed_pages,
objspace->heap_pages.freed_pages);
7596 SET(total_allocated_objects, total_allocated_objects(
objspace));
7597 SET(total_freed_objects, total_freed_objects(
objspace));
7598 SET(malloc_increase_bytes, malloc_increase);
7599 SET(malloc_increase_bytes_limit, malloc_limit);
7600 SET(minor_gc_count,
objspace->profile.minor_gc_count);
7601 SET(major_gc_count,
objspace->profile.major_gc_count);
7602 SET(compact_count,
objspace->profile.compact_count);
7603 SET(read_barrier_faults,
objspace->profile.read_barrier_faults);
7604 SET(total_moved_objects,
objspace->rcompactor.total_moved);
7605 SET(remembered_wb_unprotected_objects,
objspace->rgengc.uncollectible_wb_unprotected_objects);
7606 SET(remembered_wb_unprotected_objects_limit,
objspace->rgengc.uncollectible_wb_unprotected_objects_limit);
7607 SET(old_objects,
objspace->rgengc.old_objects);
7608 SET(old_objects_limit,
objspace->rgengc.old_objects_limit);
7609#if RGENGC_ESTIMATE_OLDMALLOC
7610 SET(oldmalloc_increase_bytes,
objspace->rgengc.oldmalloc_increase);
7611 SET(oldmalloc_increase_bytes_limit,
objspace->rgengc.oldmalloc_increase_limit);
7615 SET(total_generated_normal_object_count,
objspace->profile.total_generated_normal_object_count);
7616 SET(total_generated_shady_object_count,
objspace->profile.total_generated_shady_object_count);
7617 SET(total_shade_operation_count,
objspace->profile.total_shade_operation_count);
7618 SET(total_promoted_count,
objspace->profile.total_promoted_count);
7619 SET(total_remembered_normal_object_count,
objspace->profile.total_remembered_normal_object_count);
7620 SET(total_remembered_shady_object_count,
objspace->profile.total_remembered_shady_object_count);
7629#if defined(RGENGC_PROFILE) && RGENGC_PROFILE >= 2
7631 gc_count_add_each_types(hash,
"generated_normal_object_count_types",
objspace->profile.generated_normal_object_count_types);
7632 gc_count_add_each_types(hash,
"generated_shady_object_count_types",
objspace->profile.generated_shady_object_count_types);
7633 gc_count_add_each_types(hash,
"shade_operation_count_types",
objspace->profile.shade_operation_count_types);
7634 gc_count_add_each_types(hash,
"promoted_types",
objspace->profile.promoted_types);
7635 gc_count_add_each_types(hash,
"remembered_normal_object_count_types",
objspace->profile.remembered_normal_object_count_types);
7636 gc_count_add_each_types(hash,
"remembered_shady_object_count_types",
objspace->profile.remembered_shady_object_count_types);
7643enum gc_stat_heap_sym {
7644 gc_stat_heap_sym_slot_size,
7645 gc_stat_heap_sym_heap_eden_pages,
7646 gc_stat_heap_sym_heap_eden_slots,
7647 gc_stat_heap_sym_total_allocated_pages,
7648 gc_stat_heap_sym_force_major_gc_count,
7649 gc_stat_heap_sym_force_incremental_marking_finish_count,
7650 gc_stat_heap_sym_total_allocated_objects,
7651 gc_stat_heap_sym_total_freed_objects,
7652 gc_stat_heap_sym_last
7655static VALUE gc_stat_heap_symbols[gc_stat_heap_sym_last];
7658setup_gc_stat_heap_symbols(
void)
7660 if (gc_stat_heap_symbols[0] == 0) {
7661#define S(s) gc_stat_heap_symbols[gc_stat_heap_sym_##s] = ID2SYM(rb_intern_const(#s))
7665 S(total_allocated_pages);
7666 S(force_major_gc_count);
7667 S(force_incremental_marking_finish_count);
7668 S(total_allocated_objects);
7669 S(total_freed_objects);
7677#define SET(name, attr) \
7678 if (key == gc_stat_heap_symbols[gc_stat_heap_sym_##name]) \
7679 return SIZET2NUM(attr); \
7680 else if (hash != Qnil) \
7681 rb_hash_aset(hash, gc_stat_heap_symbols[gc_stat_heap_sym_##name], SIZET2NUM(attr));
7683 SET(slot_size, heap->slot_size);
7684 SET(heap_eden_pages, heap->total_pages);
7685 SET(heap_eden_slots, heap->total_slots);
7686 SET(total_allocated_pages, heap->total_allocated_pages);
7687 SET(force_major_gc_count, heap->force_major_gc_count);
7688 SET(force_incremental_marking_finish_count, heap->force_incremental_marking_finish_count);
7689 SET(total_allocated_objects, heap->total_allocated_objects);
7690 SET(total_freed_objects, heap->total_freed_objects);
7702rb_gc_impl_stat_heap(
void *objspace_ptr,
VALUE heap_name,
VALUE hash_or_sym)
7706 setup_gc_stat_heap_symbols();
7708 if (
NIL_P(heap_name)) {
7710 rb_bug(
"non-hash given");
7713 for (
int i = 0; i < HEAP_COUNT; i++) {
7716 hash = rb_hash_new();
7717 rb_hash_aset(hash_or_sym,
INT2FIX(i), hash);
7720 stat_one_heap(&heaps[i], hash,
Qnil);
7724 int heap_idx =
FIX2INT(heap_name);
7726 if (heap_idx < 0 || heap_idx >= HEAP_COUNT) {
7727 rb_raise(rb_eArgError,
"size pool index out of range");
7731 return stat_one_heap(&heaps[heap_idx],
Qnil, hash_or_sym);
7734 return stat_one_heap(&heaps[heap_idx], hash_or_sym,
Qnil);
7737 rb_bug(
"non-hash or symbol given");
7741 rb_bug(
"heap_name must be nil or an Integer");
7753#define RBOOL(v) (v ? Qtrue : Qfalse)
7757rb_gc_impl_config_get(
void *objspace_ptr)
7759#define sym(name) ID2SYM(rb_intern_const(name))
7761 VALUE hash = rb_hash_new();
7763 rb_hash_aset(hash, sym(
"rgengc_allow_full_mark"), RBOOL(gc_config_full_mark_val));
7772 if (
rb_sym2id(key) == rb_intern(
"rgengc_allow_full_mark")) {
7774 gc_config_full_mark_set(
RTEST(value));
7780rb_gc_impl_config_set(
void *objspace_ptr,
VALUE hash)
7785 rb_raise(rb_eArgError,
"expected keyword arguments");
7792rb_gc_impl_stress_get(
void *objspace_ptr)
7795 return ruby_gc_stress_mode;
7799rb_gc_impl_stress_set(
void *objspace_ptr,
VALUE flag)
7808get_envparam_size(
const char *name,
size_t *default_value,
size_t lower_bound)
7810 const char *ptr = getenv(name);
7813 if (ptr != NULL && *ptr) {
7816#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
7817 val = strtoll(ptr, &end, 0);
7819 val = strtol(ptr, &end, 0);
7831 unit = 1024*1024*1024;
7835 while (*end && isspace((
unsigned char)*end)) end++;
7837 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"invalid string for %s: %s\n", name, ptr);
7841 if (val < -(ssize_t)(SIZE_MAX / 2 / unit) || (ssize_t)(SIZE_MAX / 2 / unit) < val) {
7842 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"%s=%s is ignored because it overflows\n", name, ptr);
7847 if (val > 0 && (
size_t)val > lower_bound) {
7849 fprintf(stderr,
"%s=%"PRIdSIZE
" (default value: %"PRIuSIZE
")\n", name, val, *default_value);
7851 *default_value = (size_t)val;
7856 fprintf(stderr,
"%s=%"PRIdSIZE
" (default value: %"PRIuSIZE
") is ignored because it must be greater than %"PRIuSIZE
".\n",
7857 name, val, *default_value, lower_bound);
7866get_envparam_double(
const char *name,
double *default_value,
double lower_bound,
double upper_bound,
int accept_zero)
7868 const char *ptr = getenv(name);
7871 if (ptr != NULL && *ptr) {
7874 if (!*ptr || *end) {
7875 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"invalid string for %s: %s\n", name, ptr);
7879 if (accept_zero && val == 0.0) {
7882 else if (val <= lower_bound) {
7884 fprintf(stderr,
"%s=%f (default value: %f) is ignored because it must be greater than %f.\n",
7885 name, val, *default_value, lower_bound);
7888 else if (upper_bound != 0.0 &&
7889 val > upper_bound) {
7891 fprintf(stderr,
"%s=%f (default value: %f) is ignored because it must be lower than %f.\n",
7892 name, val, *default_value, upper_bound);
7902 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"%s=%f (default value: %f)\n", name, val, *default_value);
7903 *default_value = val;
7948rb_gc_impl_set_params(
void *objspace_ptr)
7952 if (get_envparam_size(
"RUBY_GC_HEAP_FREE_SLOTS", &gc_params.heap_free_slots, 0)) {
7956 for (
int i = 0; i < HEAP_COUNT; i++) {
7957 char env_key[
sizeof(
"RUBY_GC_HEAP_" "_INIT_SLOTS") +
DECIMAL_SIZE_OF_BITS(
sizeof(
int) * CHAR_BIT)];
7958 snprintf(env_key,
sizeof(env_key),
"RUBY_GC_HEAP_%d_INIT_SLOTS", i);
7960 get_envparam_size(env_key, &gc_params.heap_init_slots[i], 0);
7963 get_envparam_double(
"RUBY_GC_HEAP_GROWTH_FACTOR", &gc_params.growth_factor, 1.0, 0.0, FALSE);
7964 get_envparam_size (
"RUBY_GC_HEAP_GROWTH_MAX_SLOTS", &gc_params.growth_max_slots, 0);
7965 get_envparam_double(
"RUBY_GC_HEAP_FREE_SLOTS_MIN_RATIO", &gc_params.heap_free_slots_min_ratio,
7967 get_envparam_double(
"RUBY_GC_HEAP_FREE_SLOTS_MAX_RATIO", &gc_params.heap_free_slots_max_ratio,
7968 gc_params.heap_free_slots_min_ratio, 1.0, FALSE);
7969 get_envparam_double(
"RUBY_GC_HEAP_FREE_SLOTS_GOAL_RATIO", &gc_params.heap_free_slots_goal_ratio,
7970 gc_params.heap_free_slots_min_ratio, gc_params.heap_free_slots_max_ratio, TRUE);
7971 get_envparam_double(
"RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR", &gc_params.oldobject_limit_factor, 0.0, 0.0, TRUE);
7972 get_envparam_double(
"RUBY_GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO", &gc_params.uncollectible_wb_unprotected_objects_limit_ratio, 0.0, 0.0, TRUE);
7974 if (get_envparam_size(
"RUBY_GC_MALLOC_LIMIT", &gc_params.malloc_limit_min, 0)) {
7975 malloc_limit = gc_params.malloc_limit_min;
7977 get_envparam_size (
"RUBY_GC_MALLOC_LIMIT_MAX", &gc_params.malloc_limit_max, 0);
7978 if (!gc_params.malloc_limit_max) {
7979 gc_params.malloc_limit_max = SIZE_MAX;
7981 get_envparam_double(
"RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR", &gc_params.malloc_limit_growth_factor, 1.0, 0.0, FALSE);
7983#if RGENGC_ESTIMATE_OLDMALLOC
7984 if (get_envparam_size(
"RUBY_GC_OLDMALLOC_LIMIT", &gc_params.oldmalloc_limit_min, 0)) {
7985 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
7987 get_envparam_size (
"RUBY_GC_OLDMALLOC_LIMIT_MAX", &gc_params.oldmalloc_limit_max, 0);
7988 get_envparam_double(
"RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR", &gc_params.oldmalloc_limit_growth_factor, 1.0, 0.0, FALSE);
7995#ifdef HAVE_MALLOC_USABLE_SIZE
7997 hint = malloc_usable_size(ptr);
8004 MEMOP_TYPE_MALLOC = 0,
8010atomic_sub_nounderflow(
size_t *var,
size_t sub)
8012 if (sub == 0)
return;
8016 if (val < sub) sub = val;
8021#define gc_stress_full_mark_after_malloc_p() \
8022 (FIXNUM_P(ruby_gc_stress_mode) && (FIX2LONG(ruby_gc_stress_mode) & (1<<gc_stress_full_mark_after_malloc)))
8028 unsigned int reason = (GPR_FLAG_IMMEDIATE_MARK | GPR_FLAG_IMMEDIATE_SWEEP |
8029 GPR_FLAG_STRESS | GPR_FLAG_MALLOC);
8031 if (gc_stress_full_mark_after_malloc_p()) {
8032 reason |= GPR_FLAG_FULL_MARK;
8034 garbage_collect_with_gvl(
objspace, reason);
8039objspace_malloc_increase_report(
rb_objspace_t *
objspace,
void *mem,
size_t new_size,
size_t old_size,
enum memop_type
type,
bool gc_allowed)
8041 if (0) fprintf(stderr,
"increase - ptr: %p, type: %s, new_size: %"PRIdSIZE
", old_size: %"PRIdSIZE
"\n",
8043 type == MEMOP_TYPE_MALLOC ?
"malloc" :
8044 type == MEMOP_TYPE_FREE ?
"free " :
8045 type == MEMOP_TYPE_REALLOC ?
"realloc":
"error",
8046 new_size, old_size);
8051objspace_malloc_increase_body(
rb_objspace_t *
objspace,
void *mem,
size_t new_size,
size_t old_size,
enum memop_type
type,
bool gc_allowed)
8053 if (new_size > old_size) {
8055#if RGENGC_ESTIMATE_OLDMALLOC
8060 atomic_sub_nounderflow(&malloc_increase, old_size - new_size);
8061#if RGENGC_ESTIMATE_OLDMALLOC
8062 atomic_sub_nounderflow(&
objspace->rgengc.oldmalloc_increase, old_size - new_size);
8066 if (
type == MEMOP_TYPE_MALLOC && gc_allowed) {
8069 if (ruby_thread_has_gvl_p() && is_lazy_sweeping(
objspace)) {
8073 garbage_collect_with_gvl(
objspace, GPR_FLAG_MALLOC);
8077#if MALLOC_ALLOCATED_SIZE
8078 if (new_size >= old_size) {
8082 size_t dec_size = old_size - new_size;
8084#if MALLOC_ALLOCATED_SIZE_CHECK
8085 size_t allocated_size =
objspace->malloc_params.allocated_size;
8086 if (allocated_size < dec_size) {
8087 rb_bug(
"objspace_malloc_increase: underflow malloc_params.allocated_size.");
8090 atomic_sub_nounderflow(&
objspace->malloc_params.allocated_size, dec_size);
8094 case MEMOP_TYPE_MALLOC:
8097 case MEMOP_TYPE_FREE:
8099 size_t allocations =
objspace->malloc_params.allocations;
8100 if (allocations > 0) {
8101 atomic_sub_nounderflow(&
objspace->malloc_params.allocations, 1);
8103#if MALLOC_ALLOCATED_SIZE_CHECK
8105 GC_ASSERT(
objspace->malloc_params.allocations > 0);
8110 case MEMOP_TYPE_REALLOC:
break;
8116#define objspace_malloc_increase(...) \
8117 for (bool malloc_increase_done = objspace_malloc_increase_report(__VA_ARGS__); \
8118 !malloc_increase_done; \
8119 malloc_increase_done = objspace_malloc_increase_body(__VA_ARGS__))
8128 if (size == 0) size = 1;
8130#if CALC_EXACT_MALLOC_SIZE
8144 return during_gc && !dont_gc_val() && !rb_gc_multi_ractor_p() && ruby_thread_has_gvl_p();
8150 size = objspace_malloc_size(
objspace, mem, size);
8151 objspace_malloc_increase(
objspace, mem, size, 0, MEMOP_TYPE_MALLOC, gc_allowed) {}
8153#if CALC_EXACT_MALLOC_SIZE
8164#if defined(__GNUC__) && RUBY_DEBUG
8165#define RB_BUG_INSTEAD_OF_RB_MEMERROR 1
8168#ifndef RB_BUG_INSTEAD_OF_RB_MEMERROR
8169# define RB_BUG_INSTEAD_OF_RB_MEMERROR 0
8172#define GC_MEMERROR(...) \
8173 ((RB_BUG_INSTEAD_OF_RB_MEMERROR+0) ? rb_bug("" __VA_ARGS__) : (void)0)
8175#define TRY_WITH_GC(siz, expr) do { \
8176 const gc_profile_record_flag gpr = \
8177 GPR_FLAG_FULL_MARK | \
8178 GPR_FLAG_IMMEDIATE_MARK | \
8179 GPR_FLAG_IMMEDIATE_SWEEP | \
8181 objspace_malloc_gc_stress(objspace); \
8183 if (RB_LIKELY((expr))) { \
8186 else if (gc_allowed && !garbage_collect_with_gvl(objspace, gpr)) { \
8188 GC_MEMERROR("TRY_WITH_GC: could not GC"); \
8190 else if ((expr)) { \
8194 GC_MEMERROR("TRY_WITH_GC: could not allocate:" \
8195 "%"PRIdSIZE" bytes for %s", \
8203 if (RB_UNLIKELY(malloc_during_gc_p(
objspace))) {
8206 rb_bug(
"Cannot %s during GC", msg);
8211rb_gc_impl_free(
void *objspace_ptr,
void *ptr,
size_t old_size)
8222#if CALC_EXACT_MALLOC_SIZE
8225 old_size = info->size;
8227 old_size = objspace_malloc_size(
objspace, ptr, old_size);
8229 objspace_malloc_increase(
objspace, ptr, 0, old_size, MEMOP_TYPE_FREE,
true) {
8232 RB_DEBUG_COUNTER_INC(heap_xfree);
8237rb_gc_impl_malloc(
void *objspace_ptr,
size_t size,
bool gc_allowed)
8240 check_malloc_not_in_gc(
objspace,
"malloc");
8244 size = objspace_malloc_prepare(
objspace, size);
8245 TRY_WITH_GC(size, mem = malloc(size));
8246 RB_DEBUG_COUNTER_INC(heap_xmalloc);
8247 if (!mem)
return mem;
8248 return objspace_malloc_fixup(
objspace, mem, size, gc_allowed);
8252rb_gc_impl_calloc(
void *objspace_ptr,
size_t size,
bool gc_allowed)
8256 if (RB_UNLIKELY(malloc_during_gc_p(
objspace))) {
8257 rb_warn(
"calloc during GC detected, this could cause crashes if it triggers another GC");
8258#if RGENGC_CHECK_MODE || RUBY_DEBUG
8259 rb_bug(
"Cannot calloc during GC");
8265 size = objspace_malloc_prepare(
objspace, size);
8266 TRY_WITH_GC(size, mem = calloc1(size));
8267 if (!mem)
return mem;
8268 return objspace_malloc_fixup(
objspace, mem, size, gc_allowed);
8272rb_gc_impl_realloc(
void *objspace_ptr,
void *ptr,
size_t new_size,
size_t old_size,
bool gc_allowed)
8276 check_malloc_not_in_gc(
objspace,
"realloc");
8280 if (!ptr)
return rb_gc_impl_malloc(
objspace, new_size, gc_allowed);
8287 if (new_size == 0) {
8288 if ((mem = rb_gc_impl_malloc(
objspace, 0, gc_allowed)) != NULL) {
8311 rb_gc_impl_free(
objspace, ptr, old_size);
8325#if CALC_EXACT_MALLOC_SIZE
8330 old_size = info->size;
8334 old_size = objspace_malloc_size(
objspace, ptr, old_size);
8336 if (!mem)
return mem;
8337 new_size = objspace_malloc_size(
objspace, mem, new_size);
8339#if CALC_EXACT_MALLOC_SIZE
8342 info->size = new_size;
8347 objspace_malloc_increase(
objspace, mem, new_size, old_size, MEMOP_TYPE_REALLOC, gc_allowed);
8349 RB_DEBUG_COUNTER_INC(heap_xrealloc);
8354rb_gc_impl_adjust_memory_usage(
void *objspace_ptr, ssize_t diff)
8359 objspace_malloc_increase(
objspace, 0, diff, 0, MEMOP_TYPE_REALLOC,
true);
8361 else if (diff < 0) {
8362 objspace_malloc_increase(
objspace, 0, 0, -diff, MEMOP_TYPE_REALLOC,
true);
8371#define GC_PROFILE_RECORD_DEFAULT_SIZE 100
8374current_process_time(
struct timespec *ts)
8376#if defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_PROCESS_CPUTIME_ID)
8378 static int try_clock_gettime = 1;
8379 if (try_clock_gettime && clock_gettime(CLOCK_PROCESS_CPUTIME_ID, ts) == 0) {
8383 try_clock_gettime = 0;
8390 struct rusage usage;
8392 if (getrusage(RUSAGE_SELF, &usage) == 0) {
8393 time = usage.ru_utime;
8394 ts->tv_sec = time.tv_sec;
8395 ts->tv_nsec = (int32_t)time.tv_usec * 1000;
8403 FILETIME creation_time, exit_time, kernel_time, user_time;
8406 if (GetProcessTimes(GetCurrentProcess(),
8407 &creation_time, &exit_time, &kernel_time, &user_time) != 0) {
8408 memcpy(&ui, &user_time,
sizeof(FILETIME));
8409#define PER100NSEC (uint64_t)(1000 * 1000 * 10)
8410 ts->tv_nsec = (long)(ui.QuadPart % PER100NSEC);
8411 ts->tv_sec = (time_t)(ui.QuadPart / PER100NSEC);
8424 if (current_process_time(&ts)) {
8425 return ts.tv_sec + ts.tv_nsec * 1e-9;
8437 size_t index =
objspace->profile.next_index;
8444 objspace->profile.size = GC_PROFILE_RECORD_DEFAULT_SIZE;
8447 if (index >=
objspace->profile.size) {
8451 if (!ptr) rb_memerror();
8455 rb_bug(
"gc_profile malloc or realloc miss");
8461 record->flags = reason | (ruby_gc_stressful ? GPR_FLAG_STRESS : 0);
8462#if MALLOC_ALLOCATED_SIZE
8463 record->allocated_size = malloc_allocated_size;
8465#if GC_PROFILE_MORE_DETAIL && GC_PROFILE_DETAIL_MEMORY
8468 struct rusage usage;
8469 if (getrusage(RUSAGE_SELF, &usage) == 0) {
8470 record->maxrss = usage.ru_maxrss;
8471 record->minflt = usage.ru_minflt;
8472 record->majflt = usage.ru_majflt;
8485#if GC_PROFILE_MORE_DETAIL
8486 record->prepare_time =
objspace->profile.prepare_time;
8488 record->gc_time = 0;
8489 record->gc_invoke_time = getrusage_time();
8494elapsed_time_from(
double time)
8496 double now = getrusage_time();
8510 record->gc_time = elapsed_time_from(record->gc_invoke_time);
8511 record->gc_invoke_time -=
objspace->profile.invoke_time;
8515#ifdef BUILDING_MODULAR_GC
8516# define RUBY_DTRACE_GC_HOOK(name)
8518# define RUBY_DTRACE_GC_HOOK(name) \
8519 do {if (RUBY_DTRACE_GC_##name##_ENABLED()) RUBY_DTRACE_GC_##name();} while (0)
8525 RUBY_DTRACE_GC_HOOK(MARK_BEGIN);
8526#if GC_PROFILE_MORE_DETAIL
8528 gc_prof_record(
objspace)->gc_mark_time = getrusage_time();
8536 RUBY_DTRACE_GC_HOOK(MARK_END);
8537#if GC_PROFILE_MORE_DETAIL
8540 record->gc_mark_time = elapsed_time_from(record->gc_mark_time);
8548 RUBY_DTRACE_GC_HOOK(SWEEP_BEGIN);
8552 if (record->gc_time > 0 || GC_PROFILE_MORE_DETAIL) {
8553 objspace->profile.gc_sweep_start_time = getrusage_time();
8561 RUBY_DTRACE_GC_HOOK(SWEEP_END);
8567 if (record->gc_time > 0) {
8568 sweep_time = elapsed_time_from(
objspace->profile.gc_sweep_start_time);
8570 record->gc_time += sweep_time;
8572 else if (GC_PROFILE_MORE_DETAIL) {
8573 sweep_time = elapsed_time_from(
objspace->profile.gc_sweep_start_time);
8576#if GC_PROFILE_MORE_DETAIL
8577 record->gc_sweep_time += sweep_time;
8578 if (heap_pages_deferred_final) record->flags |= GPR_FLAG_HAVE_FINALIZE;
8580 if (heap_pages_deferred_final)
objspace->profile.latest_gc_info |= GPR_FLAG_HAVE_FINALIZE;
8587#if GC_PROFILE_MORE_DETAIL
8590 record->allocate_increase = malloc_increase;
8591 record->allocate_limit = malloc_limit;
8601 size_t live =
objspace->profile.total_allocated_objects_at_gc_start - total_freed_objects(
objspace);
8602 size_t total =
objspace->profile.heap_used_at_gc_start * HEAP_PAGE_OBJ_LIMIT;
8604#if GC_PROFILE_MORE_DETAIL
8605 record->heap_use_pages =
objspace->profile.heap_used_at_gc_start;
8606 record->heap_live_objects = live;
8607 record->heap_free_objects = total - live;
8610 record->heap_total_objects = total;
8611 record->heap_use_size = live * BASE_SLOT_SIZE;
8612 record->heap_total_size = total * BASE_SLOT_SIZE;
8628 void *p =
objspace->profile.records;
8632 objspace->profile.current_record = 0;
8688gc_profile_record_get(
VALUE _)
8699 for (i =0; i <
objspace->profile.next_index; i++) {
8702 prof = rb_hash_new();
8703 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_FLAGS")), gc_info_decode(
objspace, rb_hash_new(), record->flags));
8704 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_TIME")),
DBL2NUM(record->gc_time));
8705 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_INVOKE_TIME")),
DBL2NUM(record->gc_invoke_time));
8706 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_USE_SIZE")),
SIZET2NUM(record->heap_use_size));
8707 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_TOTAL_SIZE")),
SIZET2NUM(record->heap_total_size));
8708 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_TOTAL_OBJECTS")),
SIZET2NUM(record->heap_total_objects));
8709 rb_hash_aset(prof,
ID2SYM(rb_intern(
"MOVED_OBJECTS")),
SIZET2NUM(record->moved_objects));
8710 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_IS_MARKED")),
Qtrue);
8711#if GC_PROFILE_MORE_DETAIL
8712 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_MARK_TIME")),
DBL2NUM(record->gc_mark_time));
8713 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_SWEEP_TIME")),
DBL2NUM(record->gc_sweep_time));
8714 rb_hash_aset(prof,
ID2SYM(rb_intern(
"ALLOCATE_INCREASE")),
SIZET2NUM(record->allocate_increase));
8715 rb_hash_aset(prof,
ID2SYM(rb_intern(
"ALLOCATE_LIMIT")),
SIZET2NUM(record->allocate_limit));
8716 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_USE_PAGES")),
SIZET2NUM(record->heap_use_pages));
8717 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_LIVE_OBJECTS")),
SIZET2NUM(record->heap_live_objects));
8718 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_FREE_OBJECTS")),
SIZET2NUM(record->heap_free_objects));
8720 rb_hash_aset(prof,
ID2SYM(rb_intern(
"REMOVING_OBJECTS")),
SIZET2NUM(record->removing_objects));
8721 rb_hash_aset(prof,
ID2SYM(rb_intern(
"EMPTY_OBJECTS")),
SIZET2NUM(record->empty_objects));
8723 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HAVE_FINALIZE")), (record->flags & GPR_FLAG_HAVE_FINALIZE) ?
Qtrue :
Qfalse);
8726#if RGENGC_PROFILE > 0
8727 rb_hash_aset(prof,
ID2SYM(rb_intern(
"OLD_OBJECTS")),
SIZET2NUM(record->old_objects));
8728 rb_hash_aset(prof,
ID2SYM(rb_intern(
"REMEMBERED_NORMAL_OBJECTS")),
SIZET2NUM(record->remembered_normal_objects));
8729 rb_hash_aset(prof,
ID2SYM(rb_intern(
"REMEMBERED_SHADY_OBJECTS")),
SIZET2NUM(record->remembered_shady_objects));
8737#if GC_PROFILE_MORE_DETAIL
8738#define MAJOR_REASON_MAX 0x10
8741gc_profile_dump_major_reason(
unsigned int flags,
char *buff)
8743 unsigned int reason = flags & GPR_FLAG_MAJOR_MASK;
8746 if (reason == GPR_FLAG_NONE) {
8752 if (reason & GPR_FLAG_MAJOR_BY_##x) { \
8753 buff[i++] = #x[0]; \
8754 if (i >= MAJOR_REASON_MAX) rb_bug("gc_profile_dump_major_reason: overflow"); \
8760#if RGENGC_ESTIMATE_OLDMALLOC
8775 size_t count =
objspace->profile.next_index;
8776#ifdef MAJOR_REASON_MAX
8777 char reason_str[MAJOR_REASON_MAX];
8780 if (
objspace->profile.run && count ) {
8784 append(out, rb_sprintf(
"GC %"PRIuSIZE
" invokes.\n",
objspace->profile.count));
8785 append(out,
rb_str_new_cstr(
"Index Invoke Time(sec) Use Size(byte) Total Size(byte) Total Object GC Time(ms)\n"));
8787 for (i = 0; i < count; i++) {
8788 record = &
objspace->profile.records[i];
8789 append(out, rb_sprintf(
"%5"PRIuSIZE
" %19.3f %20"PRIuSIZE
" %20"PRIuSIZE
" %20"PRIuSIZE
" %30.20f\n",
8790 i+1, record->gc_invoke_time, record->heap_use_size,
8791 record->heap_total_size, record->heap_total_objects, record->gc_time*1000));
8794#if GC_PROFILE_MORE_DETAIL
8795 const char *str =
"\n\n" \
8797 "Prepare Time = Previously GC's rest sweep time\n"
8798 "Index Flags Allocate Inc. Allocate Limit"
8799#if CALC_EXACT_MALLOC_SIZE
8802 " Use Page Mark Time(ms) Sweep Time(ms) Prepare Time(ms) LivingObj FreeObj RemovedObj EmptyObj"
8804 " OldgenObj RemNormObj RemShadObj"
8806#if GC_PROFILE_DETAIL_MEMORY
8807 " MaxRSS(KB) MinorFLT MajorFLT"
8812 for (i = 0; i < count; i++) {
8813 record = &
objspace->profile.records[i];
8814 append(out, rb_sprintf(
"%5"PRIuSIZE
" %4s/%c/%6s%c %13"PRIuSIZE
" %15"PRIuSIZE
8815#
if CALC_EXACT_MALLOC_SIZE
8818 " %9"PRIuSIZE
" %17.12f %17.12f %17.12f %10"PRIuSIZE
" %10"PRIuSIZE
" %10"PRIuSIZE
" %10"PRIuSIZE
8820 "%10"PRIuSIZE
" %10"PRIuSIZE
" %10"PRIuSIZE
8822#
if GC_PROFILE_DETAIL_MEMORY
8828 gc_profile_dump_major_reason(record->flags, reason_str),
8829 (record->flags & GPR_FLAG_HAVE_FINALIZE) ?
'F' :
'.',
8830 (record->flags & GPR_FLAG_NEWOBJ) ?
"NEWOBJ" :
8831 (record->flags & GPR_FLAG_MALLOC) ?
"MALLOC" :
8832 (record->flags & GPR_FLAG_METHOD) ?
"METHOD" :
8833 (record->flags & GPR_FLAG_CAPI) ?
"CAPI__" :
"??????",
8834 (record->flags & GPR_FLAG_STRESS) ?
'!' :
' ',
8835 record->allocate_increase, record->allocate_limit,
8836#if CALC_EXACT_MALLOC_SIZE
8837 record->allocated_size,
8839 record->heap_use_pages,
8840 record->gc_mark_time*1000,
8841 record->gc_sweep_time*1000,
8842 record->prepare_time*1000,
8844 record->heap_live_objects,
8845 record->heap_free_objects,
8846 record->removing_objects,
8847 record->empty_objects
8850 record->old_objects,
8851 record->remembered_normal_objects,
8852 record->remembered_shady_objects
8854#if GC_PROFILE_DETAIL_MEMORY
8856 record->maxrss / 1024,
8879gc_profile_result(
VALUE _)
8896gc_profile_report(
int argc,
VALUE *argv,
VALUE self)
8901 gc_profile_dump_on(out, rb_io_write);
8914gc_profile_total_time(
VALUE self)
8921 size_t count =
objspace->profile.next_index;
8923 for (i = 0; i < count; i++) {
8924 time +=
objspace->profile.records[i].gc_time;
8938gc_profile_enable_get(
VALUE self)
8953gc_profile_enable(
VALUE _)
8957 objspace->profile.current_record = 0;
8970gc_profile_disable(
VALUE _)
8975 objspace->profile.current_record = 0;
8980rb_gc_verify_internal_consistency(
void)
8982 gc_verify_internal_consistency(rb_gc_get_objspace());
8996gc_verify_internal_consistency_m(
VALUE dummy)
8998 rb_gc_verify_internal_consistency();
9002#if GC_CAN_COMPILE_COMPACTION
9016 GC_ASSERT(GC_COMPACTION_SUPPORTED);
9018 ruby_enable_autocompact =
RTEST(v);
9020#if RGENGC_CHECK_MODE
9021 ruby_autocompact_compare_func = NULL;
9025 if (
id == rb_intern(
"empty")) {
9026 ruby_autocompact_compare_func = compare_free_slots;
9034# define gc_set_auto_compact rb_f_notimplement
9037#if GC_CAN_COMPILE_COMPACTION
9045gc_get_auto_compact(
VALUE _)
9050# define gc_get_auto_compact rb_f_notimplement
9053#if GC_CAN_COMPILE_COMPACTION
9079gc_compact_stats(
VALUE self)
9082 VALUE h = rb_hash_new();
9083 VALUE considered = rb_hash_new();
9084 VALUE moved = rb_hash_new();
9085 VALUE moved_up = rb_hash_new();
9086 VALUE moved_down = rb_hash_new();
9088 for (
size_t i = 0; i <
T_MASK; i++) {
9089 if (
objspace->rcompactor.considered_count_table[i]) {
9090 rb_hash_aset(considered, type_sym(i),
SIZET2NUM(
objspace->rcompactor.considered_count_table[i]));
9093 if (
objspace->rcompactor.moved_count_table[i]) {
9094 rb_hash_aset(moved, type_sym(i),
SIZET2NUM(
objspace->rcompactor.moved_count_table[i]));
9097 if (
objspace->rcompactor.moved_up_count_table[i]) {
9098 rb_hash_aset(moved_up, type_sym(i),
SIZET2NUM(
objspace->rcompactor.moved_up_count_table[i]));
9101 if (
objspace->rcompactor.moved_down_count_table[i]) {
9102 rb_hash_aset(moved_down, type_sym(i),
SIZET2NUM(
objspace->rcompactor.moved_down_count_table[i]));
9106 rb_hash_aset(h,
ID2SYM(rb_intern(
"considered")), considered);
9107 rb_hash_aset(h,
ID2SYM(rb_intern(
"moved")), moved);
9108 rb_hash_aset(h,
ID2SYM(rb_intern(
"moved_up")), moved_up);
9109 rb_hash_aset(h,
ID2SYM(rb_intern(
"moved_down")), moved_down);
9114# define gc_compact_stats rb_f_notimplement
9117#if GC_CAN_COMPILE_COMPACTION
9136gc_compact(
VALUE self)
9139 int full_marking_p = gc_config_full_mark_val;
9140 gc_config_full_mark_set(TRUE);
9143 rb_gc_impl_start(rb_gc_get_objspace(),
true,
true,
true,
true);
9144 gc_config_full_mark_set(full_marking_p);
9146 return gc_compact_stats(self);
9149# define gc_compact rb_f_notimplement
9152#if GC_CAN_COMPILE_COMPACTION
9153struct desired_compaction_pages_i_data {
9155 size_t required_slots[HEAP_COUNT];
9159desired_compaction_pages_i(
struct heap_page *page,
void *data)
9161 struct desired_compaction_pages_i_data *tdata = data;
9164 VALUE vend = vstart + (
VALUE)(page->total_slots * page->heap->slot_size);
9167 for (
VALUE v = vstart; v != vend; v += page->heap->slot_size) {
9168 asan_unpoisoning_object(v) {
9172 size_t dest_pool_idx = dest_pool - heaps;
9173 tdata->required_slots[dest_pool_idx]++;
9197gc_verify_compaction_references(
int argc,
VALUE* argv,
VALUE self)
9199 static ID keywords[3] = {0};
9201 keywords[0] = rb_intern(
"toward");
9202 keywords[1] = rb_intern(
"double_heap");
9203 keywords[2] = rb_intern(
"expand_heap");
9210 int kwarg_count =
rb_get_kwargs(options, keywords, 0, 3, arguments);
9211 bool toward_empty = kwarg_count > 0 &&
SYMBOL_P(arguments[0]) &&
SYM2ID(arguments[0]) == rb_intern(
"empty");
9212 bool expand_heap = (kwarg_count > 1 &&
RTEST(arguments[1])) || (kwarg_count > 2 &&
RTEST(arguments[2]));
9217 rb_gc_impl_start(
objspace,
true,
true,
true,
false);
9219 unsigned int lev = RB_GC_VM_LOCK();
9225 struct desired_compaction_pages_i_data desired_compaction = {
9227 .required_slots = {0},
9230 objspace_each_pages(
objspace, desired_compaction_pages_i, &desired_compaction, TRUE);
9233 size_t max_existing_pages = 0;
9234 for (
int i = 0; i < HEAP_COUNT; i++) {
9236 max_existing_pages = MAX(max_existing_pages, heap->total_pages);
9240 for (
int i = 0; i < HEAP_COUNT; i++) {
9243 size_t pages_to_add = 0;
9250 pages_to_add += max_existing_pages - heap->total_pages;
9255 objspace->heap_pages.allocatable_slots = desired_compaction.required_slots[i];
9256 while (
objspace->heap_pages.allocatable_slots > 0) {
9257 heap_page_allocate_and_initialize(
objspace, heap);
9265 for (; pages_to_add > 0; pages_to_add--) {
9266 heap_page_allocate_and_initialize_force(
objspace, heap);
9272 objspace->rcompactor.compare_func = compare_free_slots;
9275 RB_GC_VM_UNLOCK(lev);
9277 rb_gc_impl_start(rb_gc_get_objspace(),
true,
true,
true,
true);
9279 rb_objspace_reachable_objects_from_root(root_obj_check_moved_i,
objspace);
9282 objspace->rcompactor.compare_func = NULL;
9284 return gc_compact_stats(self);
9287# define gc_verify_compaction_references rb_f_notimplement
9291rb_gc_impl_objspace_free(
void *objspace_ptr)
9296 rb_bug(
"lazy sweeping underway when freeing object space");
9301 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
9304 rb_darray_free_without_gc(
objspace->heap_pages.sorted);
9305 heap_pages_lomem = 0;
9306 heap_pages_himem = 0;
9308 for (
int i = 0; i < HEAP_COUNT; i++) {
9310 heap->total_pages = 0;
9311 heap->total_slots = 0;
9314 free_stack_chunks(&
objspace->mark_stack);
9315 mark_stack_free_cache(&
objspace->mark_stack);
9317 rb_darray_free_without_gc(
objspace->weak_references);
9322#if MALLOC_ALLOCATED_SIZE
9333gc_malloc_allocated_size(
VALUE self)
9349gc_malloc_allocations(
VALUE self)
9356void rb_gc_impl_before_fork(
void *objspace_ptr) { }
9357void rb_gc_impl_after_fork(
void *objspace_ptr, rb_pid_t pid) {
9359 rb_gc_ractor_newobj_cache_foreach(gc_ractor_newobj_cache_clear, NULL);
9363VALUE rb_ident_hash_new_with_size(st_index_t size);
9373rb_gcdebug_add_stress_to_class(
int argc,
VALUE *argv,
VALUE self)
9377 if (!stress_to_class) {
9378 set_stress_to_class(rb_ident_hash_new_with_size(argc));
9381 for (
int i = 0; i < argc; i++) {
9382 VALUE klass = argv[i];
9383 rb_hash_aset(stress_to_class, klass,
Qtrue);
9398rb_gcdebug_remove_stress_to_class(
int argc,
VALUE *argv,
VALUE self)
9402 if (stress_to_class) {
9403 for (
int i = 0; i < argc; ++i) {
9404 rb_hash_delete(stress_to_class, argv[i]);
9407 if (rb_hash_size(stress_to_class) == 0) {
9408 stress_to_class = 0;
9416rb_gc_impl_objspace_alloc(
void)
9424rb_gc_impl_objspace_init(
void *objspace_ptr)
9428 gc_config_full_mark_set(TRUE);
9431 malloc_limit = gc_params.malloc_limit_min;
9433 if (
objspace->finalize_deferred_pjob == POSTPONED_JOB_HANDLE_INVALID) {
9434 rb_bug(
"Could not preregister postponed job for GC");
9437 for (
int i = 0; i < HEAP_COUNT; i++) {
9440 heap->slot_size = (1 << i) * BASE_SLOT_SIZE;
9442 ccan_list_head_init(&heap->pages);
9445 rb_darray_make_without_gc(&
objspace->heap_pages.sorted, 0);
9446 rb_darray_make_without_gc(&
objspace->weak_references, 0);
9453#if defined(INIT_HEAP_PAGE_ALLOC_USE_MMAP)
9455 heap_page_alloc_use_mmap = INIT_HEAP_PAGE_ALLOC_USE_MMAP;
9457#if RGENGC_ESTIMATE_OLDMALLOC
9458 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
9461 for (
int i = 0; i < HEAP_COUNT; i++) {
9463 gc_params.heap_init_slots[i] = GC_HEAP_INIT_SLOTS;
9466 init_mark_stack(&
objspace->mark_stack);
9468 objspace->profile.invoke_time = getrusage_time();
9469 finalizer_table = st_init_numtable();
9473rb_gc_impl_init(
void)
9475 VALUE gc_constants = rb_hash_new();
9476 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"DEBUG")), GC_DEBUG ?
Qtrue :
Qfalse);
9477 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"BASE_SLOT_SIZE")),
SIZET2NUM(BASE_SLOT_SIZE - RVALUE_OVERHEAD));
9479 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RVALUE_OVERHEAD")),
SIZET2NUM(RVALUE_OVERHEAD));
9480 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_PAGE_OBJ_LIMIT")),
SIZET2NUM(HEAP_PAGE_OBJ_LIMIT));
9481 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_PAGE_BITMAP_SIZE")),
SIZET2NUM(HEAP_PAGE_BITMAP_SIZE));
9482 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_PAGE_SIZE")),
SIZET2NUM(HEAP_PAGE_SIZE));
9483 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_COUNT")),
LONG2FIX(HEAP_COUNT));
9484 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RVARGC_MAX_ALLOCATE_SIZE")),
LONG2FIX(heap_slot_size(HEAP_COUNT - 1)));
9485 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RVALUE_OLD_AGE")),
LONG2FIX(RVALUE_OLD_AGE));
9486 if (RB_BUG_INSTEAD_OF_RB_MEMERROR+0) {
9487 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RB_BUG_INSTEAD_OF_RB_MEMERROR")),
Qtrue);
9491 rb_define_const(
rb_mGC,
"INTERNAL_CONSTANTS", gc_constants);
9493 if (GC_COMPACTION_SUPPORTED) {
9508 if (GC_DEBUG_STRESS_TO_CLASS) {
9516#if MALLOC_ALLOCATED_SIZE
9535#define OPT(o) if (o) rb_ary_push(opts, rb_interned_str(#o, sizeof(#o) - 1))
9539 OPT(RGENGC_CHECK_MODE);
9540 OPT(RGENGC_PROFILE);
9541 OPT(RGENGC_ESTIMATE_OLDMALLOC);
9542 OPT(GC_PROFILE_MORE_DETAIL);
9543 OPT(GC_ENABLE_LAZY_SWEEP);
9544 OPT(CALC_EXACT_MALLOC_SIZE);
9545 OPT(MALLOC_ALLOCATED_SIZE);
9546 OPT(MALLOC_ALLOCATED_SIZE_CHECK);
9547 OPT(GC_PROFILE_DETAIL_MEMORY);
9548 OPT(GC_COMPACTION_SUPPORTED);
#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_EXCHANGE(var, val)
Identical to RUBY_ATOMIC_EXCHANGE, except it expects its arguments are size_t.
#define RUBY_ATOMIC_SIZE_INC(var)
Identical to RUBY_ATOMIC_INC, except it expects its argument is size_t.
#define RUBY_ATOMIC_SIZE_CAS(var, oldval, newval)
Identical to RUBY_ATOMIC_CAS, except it expects its arguments are size_t.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define RUBY_ATOMIC_SIZE_ADD(var, val)
Identical to RUBY_ATOMIC_ADD, except it expects its arguments are size_t.
#define RUBY_ATOMIC_VALUE_EXCHANGE(var, val)
Identical to RUBY_ATOMIC_EXCHANGE, except it expects its arguments are VALUE.
#define RUBY_ATOMIC_SET(var, val)
Identical to RUBY_ATOMIC_EXCHANGE, except for the return type.
#define RUBY_ATOMIC_EXCHANGE(var, val)
Atomically replaces the value pointed by var with val.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
unsigned int rb_postponed_job_handle_t
The type of a handle returned from rb_postponed_job_preregister and passed to rb_postponed_job_trigge...
void rb_postponed_job_trigger(rb_postponed_job_handle_t h)
Triggers a pre-registered job registered with rb_postponed_job_preregister, scheduling it for executi...
rb_postponed_job_handle_t rb_postponed_job_preregister(unsigned int flags, rb_postponed_job_func_t func, void *data)
Pre-registers a func in Ruby's postponed job preregistration table, returning an opaque handle which ...
#define RUBY_INTERNAL_EVENT_GC_EXIT
gc_exit() is called.
#define RUBY_INTERNAL_EVENT_GC_ENTER
gc_enter() is called.
#define RUBY_INTERNAL_EVENT_GC_END_SWEEP
GC ended sweep phase.
#define RUBY_INTERNAL_EVENT_GC_END_MARK
GC ended mark phase.
#define RUBY_INTERNAL_EVENT_OBJSPACE_MASK
Bitmask of GC events.
#define RUBY_INTERNAL_EVENT_FREEOBJ
Object swept.
#define RUBY_INTERNAL_EVENT_GC_START
GC started.
uint32_t rb_event_flag_t
Represents event(s).
#define RUBY_INTERNAL_EVENT_NEWOBJ
Object allocated.
static VALUE RB_FL_TEST(VALUE obj, VALUE flags)
Tests if the given flag(s) are set or not.
static void RB_FL_SET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_SET().
static void RB_FL_UNSET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_UNSET().
@ RUBY_FL_PROMOTED
Ruby objects are "generational".
VALUE rb_define_module_under(VALUE outer, const char *name)
Defines a module under the namespace of outer.
int rb_scan_args_kw(int kw_flag, int argc, const VALUE *argv, const char *fmt,...)
Identical to rb_scan_args(), except it also accepts kw_splat.
int rb_keyword_given_p(void)
Determines if the current method is given a keyword argument.
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
#define T_COMPLEX
Old name of RUBY_T_COMPLEX.
#define T_FILE
Old name of RUBY_T_FILE.
#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 OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
#define T_NIL
Old name of RUBY_T_NIL.
#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 SYM2ID
Old name of RB_SYM2ID.
#define T_DATA
Old name of RUBY_T_DATA.
#define FL_SHAREABLE
Old name of RUBY_FL_SHAREABLE.
#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 xmalloc
Old name of ruby_xmalloc.
#define LONG2FIX
Old name of RB_INT2FIX.
#define FIX2INT
Old name of RB_FIX2INT.
#define FL_FINALIZE
Old name of RUBY_FL_FINALIZE.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define T_TRUE
Old name of RUBY_T_TRUE.
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define T_HASH
Old name of RUBY_T_HASH.
#define ALLOC_N
Old name of RB_ALLOC_N.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define FL_SET
Old name of RB_FL_SET.
#define rb_ary_new3
Old name of rb_ary_new_from_args.
#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 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 T_ARRAY
Old name of RUBY_T_ARRAY.
#define T_OBJECT
Old name of RUBY_T_OBJECT.
#define NIL_P
Old name of RB_NIL_P.
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
#define DBL2NUM
Old name of rb_float_new.
#define T_MATCH
Old name of RUBY_T_MATCH.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define T_MOVED
Old name of RUBY_T_MOVED.
#define FL_TEST
Old name of RB_FL_TEST.
#define FL_UNSET
Old name of RB_FL_UNSET.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
#define T_REGEXP
Old name of RUBY_T_REGEXP.
#define ruby_verbose
This variable controls whether the interpreter is in debug mode.
VALUE rb_eRuntimeError
RuntimeError exception.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
VALUE rb_equal(VALUE lhs, VALUE rhs)
This function is an optimised version of calling #==.
VALUE rb_stdout
STDOUT constant.
#define RB_GNUC_EXTENSION_BLOCK(x)
This is expanded to the passed token for non-GCC compilers.
Routines to manipulate encodings of strings.
static bool RB_OBJ_PROMOTED_RAW(VALUE obj)
This is the implementation of RB_OBJ_PROMOTED().
VALUE rb_ary_dup(VALUE ary)
Duplicates an array.
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
VALUE rb_str_buf_append(VALUE dst, VALUE src)
Identical to rb_str_cat_cstr(), except it takes Ruby's string instead of C's.
VALUE rb_str_buf_new(long capa)
Allocates a "string buffer".
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
const char * rb_sourcefile(void)
Resembles __FILE__.
VALUE rb_f_notimplement(int argc, const VALUE *argv, VALUE obj, VALUE marker)
Raises rb_eNotImpError.
int rb_sourceline(void)
Resembles __LINE__.
#define RB_SYM2ID
Just another name of rb_sym2id.
ID rb_sym2id(VALUE obj)
Converts an instance of rb_cSymbol into an ID.
int len
Length of the buffer.
void * rb_thread_call_with_gvl(void *(*func)(void *), void *data1)
(Re-)acquires the GVL.
#define strtod(s, e)
Just another name of ruby_strtod.
void ruby_qsort(void *, const size_t, const size_t, int(*)(const void *, const void *, void *), void *)
Reentrant implementation of quick sort.
#define DECIMAL_SIZE_OF_BITS(n)
an approximation of ceil(n * log10(2)), up to 1,048,576 (1<<20) without overflow within 32-bit calcul...
#define MEMZERO(p, type, n)
Handy macro to erase a region of memory.
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
#define RARRAY_LEN
Just another name of rb_array_len.
static void RARRAY_ASET(VALUE ary, long i, VALUE v)
Assigns an object in an array.
#define RARRAY_AREF(a, i)
#define RBASIC(obj)
Convenient casting macro.
#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.
Ruby object's base components.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static enum ruby_value_type RB_BUILTIN_TYPE(VALUE obj)
Queries the type of the 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.
@ RUBY_T_ICLASS
Hidden classes known as IClasses.
@ RUBY_T_FIXNUM
Integers formerly known as Fixnums.
@ RUBY_T_MASK
Bitmask of ruby_value_type.
@ RUBY_T_NONE
Non-object (swept etc.)