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_MALLOC_INCREASE_LOCAL_THRESHOLD
162#define GC_MALLOC_INCREASE_LOCAL_THRESHOLD (8 * 1024 )
165#ifdef RB_THREAD_LOCAL_SPECIFIER
166#define USE_MALLOC_INCREASE_LOCAL 1
167static RB_THREAD_LOCAL_SPECIFIER
int malloc_increase_local;
169#define USE_MALLOC_INCREASE_LOCAL 0
172#ifndef GC_CAN_COMPILE_COMPACTION
174# define GC_CAN_COMPILE_COMPACTION 0
176# define GC_CAN_COMPILE_COMPACTION 1
180#ifndef PRINT_ENTER_EXIT_TICK
181# define PRINT_ENTER_EXIT_TICK 0
183#ifndef PRINT_ROOT_TICKS
184#define PRINT_ROOT_TICKS 0
187#define USE_TICK_T (PRINT_ENTER_EXIT_TICK || PRINT_ROOT_TICKS)
196 size_t allocated_objects_count;
200 size_t incremental_mark_step_allocated_slots;
205 size_t heap_init_slots[HEAP_COUNT];
206 size_t heap_free_slots;
207 double growth_factor;
208 size_t growth_max_slots;
210 double heap_free_slots_min_ratio;
211 double heap_free_slots_goal_ratio;
212 double heap_free_slots_max_ratio;
213 double uncollectible_wb_unprotected_objects_limit_ratio;
214 double oldobject_limit_factor;
216 size_t malloc_limit_min;
217 size_t malloc_limit_max;
218 double malloc_limit_growth_factor;
220 size_t oldmalloc_limit_min;
221 size_t oldmalloc_limit_max;
222 double oldmalloc_limit_growth_factor;
226 { GC_HEAP_INIT_SLOTS },
228 GC_HEAP_GROWTH_FACTOR,
229 GC_HEAP_GROWTH_MAX_SLOTS,
231 GC_HEAP_FREE_SLOTS_MIN_RATIO,
232 GC_HEAP_FREE_SLOTS_GOAL_RATIO,
233 GC_HEAP_FREE_SLOTS_MAX_RATIO,
234 GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO,
235 GC_HEAP_OLDOBJECT_LIMIT_FACTOR,
239 GC_MALLOC_LIMIT_GROWTH_FACTOR,
241 GC_OLDMALLOC_LIMIT_MIN,
242 GC_OLDMALLOC_LIMIT_MAX,
243 GC_OLDMALLOC_LIMIT_GROWTH_FACTOR,
262#define RGENGC_DEBUG -1
264#define RGENGC_DEBUG 0
267#if RGENGC_DEBUG < 0 && !defined(_MSC_VER)
268# define RGENGC_DEBUG_ENABLED(level) (-(RGENGC_DEBUG) >= (level) && ruby_rgengc_debug >= (level))
269#elif defined(HAVE_VA_ARGS_MACRO)
270# define RGENGC_DEBUG_ENABLED(level) ((RGENGC_DEBUG) >= (level))
272# define RGENGC_DEBUG_ENABLED(level) 0
274int ruby_rgengc_debug;
281#ifndef RGENGC_PROFILE
282# define RGENGC_PROFILE 0
291#ifndef RGENGC_ESTIMATE_OLDMALLOC
292# define RGENGC_ESTIMATE_OLDMALLOC 1
295#ifndef GC_PROFILE_MORE_DETAIL
296# define GC_PROFILE_MORE_DETAIL 0
298#ifndef GC_PROFILE_DETAIL_MEMORY
299# define GC_PROFILE_DETAIL_MEMORY 0
301#ifndef GC_ENABLE_LAZY_SWEEP
302# define GC_ENABLE_LAZY_SWEEP 1
304#ifndef CALC_EXACT_MALLOC_SIZE
305# define CALC_EXACT_MALLOC_SIZE 0
307#if defined(HAVE_MALLOC_USABLE_SIZE) || CALC_EXACT_MALLOC_SIZE > 0
308# ifndef MALLOC_ALLOCATED_SIZE
309# define MALLOC_ALLOCATED_SIZE 0
312# define MALLOC_ALLOCATED_SIZE 0
314#ifndef MALLOC_ALLOCATED_SIZE_CHECK
315# define MALLOC_ALLOCATED_SIZE_CHECK 0
318#ifndef GC_DEBUG_STRESS_TO_CLASS
319# define GC_DEBUG_STRESS_TO_CLASS 1
323 GPR_FLAG_NONE = 0x000,
325 GPR_FLAG_MAJOR_BY_NOFREE = 0x001,
326 GPR_FLAG_MAJOR_BY_OLDGEN = 0x002,
327 GPR_FLAG_MAJOR_BY_SHADY = 0x004,
328 GPR_FLAG_MAJOR_BY_FORCE = 0x008,
329#if RGENGC_ESTIMATE_OLDMALLOC
330 GPR_FLAG_MAJOR_BY_OLDMALLOC = 0x020,
332 GPR_FLAG_MAJOR_MASK = 0x0ff,
335 GPR_FLAG_NEWOBJ = 0x100,
336 GPR_FLAG_MALLOC = 0x200,
337 GPR_FLAG_METHOD = 0x400,
338 GPR_FLAG_CAPI = 0x800,
339 GPR_FLAG_STRESS = 0x1000,
342 GPR_FLAG_IMMEDIATE_SWEEP = 0x2000,
343 GPR_FLAG_HAVE_FINALIZE = 0x4000,
344 GPR_FLAG_IMMEDIATE_MARK = 0x8000,
345 GPR_FLAG_FULL_MARK = 0x10000,
346 GPR_FLAG_COMPACT = 0x20000,
349 (GPR_FLAG_FULL_MARK | GPR_FLAG_IMMEDIATE_MARK |
350 GPR_FLAG_IMMEDIATE_SWEEP | GPR_FLAG_CAPI),
351} gc_profile_record_flag;
357 double gc_invoke_time;
359 size_t heap_total_objects;
360 size_t heap_use_size;
361 size_t heap_total_size;
362 size_t moved_objects;
364#if GC_PROFILE_MORE_DETAIL
366 double gc_sweep_time;
368 size_t heap_use_pages;
369 size_t heap_live_objects;
370 size_t heap_free_objects;
372 size_t allocate_increase;
373 size_t allocate_limit;
376 size_t removing_objects;
377 size_t empty_objects;
378#if GC_PROFILE_DETAIL_MEMORY
384#if MALLOC_ALLOCATED_SIZE
385 size_t allocated_size;
388#if RGENGC_PROFILE > 0
390 size_t remembered_normal_objects;
391 size_t remembered_shady_objects;
399 uint32_t original_shape_id;
402#define RMOVED(obj) ((struct RMoved *)(obj))
404typedef uintptr_t bits_t;
406 BITS_SIZE =
sizeof(bits_t),
407 BITS_BITLENGTH = ( BITS_SIZE * CHAR_BIT )
420#define STACK_CHUNK_SIZE 500
423 VALUE data[STACK_CHUNK_SIZE];
433 size_t unused_cache_size;
436typedef int (*gc_compact_compare_func)(
const void *l,
const void *r,
void *d);
440 bits_t slot_bits_mask;
443 size_t total_allocated_pages;
444 size_t force_major_gc_count;
445 size_t force_incremental_marking_finish_count;
446 size_t total_allocated_objects;
447 size_t total_freed_objects;
448 size_t final_slots_count;
455 struct ccan_list_head pages;
458 uintptr_t compact_cursor_index;
467 gc_stress_no_immediate_sweep,
468 gc_stress_full_mark_after_malloc,
482#if RGENGC_ESTIMATE_OLDMALLOC
483 size_t oldmalloc_increase;
489#if MALLOC_ALLOCATED_SIZE
490 size_t allocated_size;
500 unsigned int mode : 2;
501 unsigned int immediate_sweep : 1;
502 unsigned int dont_gc : 1;
503 unsigned int dont_incremental : 1;
504 unsigned int during_gc : 1;
505 unsigned int during_compacting : 1;
506 unsigned int during_reference_updating : 1;
507 unsigned int gc_stressful: 1;
508 unsigned int has_newobj_hook: 1;
509 unsigned int during_minor_gc : 1;
510 unsigned int during_incremental_marking : 1;
511 unsigned int measure_gc : 1;
517 size_t empty_pages_count;
530 size_t allocated_pages;
533 size_t freeable_pages;
535 size_t allocatable_slots;
538 VALUE deferred_final;
545 unsigned int latest_gc_info;
551#if GC_PROFILE_MORE_DETAIL
556 size_t minor_gc_count;
557 size_t major_gc_count;
558 size_t compact_count;
559 size_t read_barrier_faults;
560#if RGENGC_PROFILE > 0
561 size_t total_generated_normal_object_count;
562 size_t total_generated_shady_object_count;
563 size_t total_shade_operation_count;
564 size_t total_promoted_count;
565 size_t total_remembered_normal_object_count;
566 size_t total_remembered_shady_object_count;
568#if RGENGC_PROFILE >= 2
569 size_t generated_normal_object_count_types[
RUBY_T_MASK];
570 size_t generated_shady_object_count_types[
RUBY_T_MASK];
573 size_t remembered_normal_object_count_types[
RUBY_T_MASK];
574 size_t remembered_shady_object_count_types[
RUBY_T_MASK];
579 double gc_sweep_start_time;
580 size_t total_allocated_objects_at_gc_start;
581 size_t heap_used_at_gc_start;
585 unsigned long long marking_time_ns;
587 unsigned long long sweeping_time_ns;
588 struct timespec sweeping_start_time;
591 size_t weak_references_count;
592 size_t retained_weak_references_count;
595 VALUE gc_stress_mode;
598 bool parent_object_old_p;
602 size_t last_major_gc;
603 size_t uncollectible_wb_unprotected_objects;
604 size_t uncollectible_wb_unprotected_objects_limit;
606 size_t old_objects_limit;
608#if RGENGC_ESTIMATE_OLDMALLOC
609 size_t oldmalloc_increase_limit;
612#if RGENGC_CHECK_MODE >= 2
619 size_t considered_count_table[
T_MASK];
620 size_t moved_count_table[
T_MASK];
621 size_t moved_up_count_table[
T_MASK];
622 size_t moved_down_count_table[
T_MASK];
626 gc_compact_compare_func compare_func;
634#if GC_DEBUG_STRESS_TO_CLASS
635 VALUE stress_to_class;
638 rb_darray(
VALUE *) weak_references;
641 unsigned long live_ractor_cache_count;
643 int fork_vm_lock_lev;
646#ifndef HEAP_PAGE_ALIGN_LOG
648#define HEAP_PAGE_ALIGN_LOG 16
651#if RACTOR_CHECK_MODE || GC_DEBUG
652struct rvalue_overhead {
653# if RACTOR_CHECK_MODE
654 uint32_t _ractor_belonging_id;
663# define RVALUE_OVERHEAD (sizeof(struct { \
665 struct rvalue_overhead overhead; \
669size_t rb_gc_impl_obj_slot_size(
VALUE obj);
670# define GET_RVALUE_OVERHEAD(obj) ((struct rvalue_overhead *)((uintptr_t)obj + rb_gc_impl_obj_slot_size(obj)))
672# ifndef RVALUE_OVERHEAD
673# define RVALUE_OVERHEAD 0
677#define BASE_SLOT_SIZE (sizeof(struct RBasic) + sizeof(VALUE[RBIMPL_RVALUE_EMBED_LEN_MAX]) + RVALUE_OVERHEAD)
680# define MAX(a, b) (((a) > (b)) ? (a) : (b))
683# define MIN(a, b) (((a) < (b)) ? (a) : (b))
685#define roomof(x, y) (((x) + (y) - 1) / (y))
686#define CEILDIV(i, mod) roomof(i, mod)
688 HEAP_PAGE_ALIGN = (1UL << HEAP_PAGE_ALIGN_LOG),
689 HEAP_PAGE_ALIGN_MASK = (~(~0UL << HEAP_PAGE_ALIGN_LOG)),
690 HEAP_PAGE_SIZE = HEAP_PAGE_ALIGN,
691 HEAP_PAGE_OBJ_LIMIT = (
unsigned int)((HEAP_PAGE_SIZE -
sizeof(
struct heap_page_header)) / BASE_SLOT_SIZE),
692 HEAP_PAGE_BITMAP_LIMIT = CEILDIV(CEILDIV(HEAP_PAGE_SIZE, BASE_SLOT_SIZE), BITS_BITLENGTH),
693 HEAP_PAGE_BITMAP_SIZE = (BITS_SIZE * HEAP_PAGE_BITMAP_LIMIT),
695#define HEAP_PAGE_ALIGN (1 << HEAP_PAGE_ALIGN_LOG)
696#define HEAP_PAGE_SIZE HEAP_PAGE_ALIGN
698#if !defined(INCREMENTAL_MARK_STEP_ALLOCATIONS)
699# define INCREMENTAL_MARK_STEP_ALLOCATIONS 500
702#undef INIT_HEAP_PAGE_ALLOC_USE_MMAP
708static const bool HEAP_PAGE_ALLOC_USE_MMAP =
false;
710#elif defined(__wasm__)
714static const bool HEAP_PAGE_ALLOC_USE_MMAP =
false;
716#elif HAVE_CONST_PAGE_SIZE
718static const bool HEAP_PAGE_ALLOC_USE_MMAP = (PAGE_SIZE <= HEAP_PAGE_SIZE);
720#elif defined(PAGE_MAX_SIZE) && (PAGE_MAX_SIZE <= HEAP_PAGE_SIZE)
722static const bool HEAP_PAGE_ALLOC_USE_MMAP =
true;
724#elif defined(PAGE_SIZE)
726# define INIT_HEAP_PAGE_ALLOC_USE_MMAP (PAGE_SIZE <= HEAP_PAGE_SIZE)
728#elif defined(HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
730# define INIT_HEAP_PAGE_ALLOC_USE_MMAP (sysconf(_SC_PAGE_SIZE) <= HEAP_PAGE_SIZE)
734static const bool HEAP_PAGE_ALLOC_USE_MMAP =
false;
737#ifdef INIT_HEAP_PAGE_ALLOC_USE_MMAP
739# define HEAP_PAGE_ALLOC_USE_MMAP (heap_page_alloc_use_mmap != false)
741static bool heap_page_alloc_use_mmap;
744#define RVALUE_AGE_BIT_COUNT 2
745#define RVALUE_AGE_BIT_MASK (((bits_t)1 << RVALUE_AGE_BIT_COUNT) - 1)
746#define RVALUE_OLD_AGE 3
754 unsigned short slot_size;
755 unsigned short total_slots;
756 unsigned short free_slots;
757 unsigned short final_slots;
758 unsigned short pinned_slots;
760 unsigned int before_sweep : 1;
761 unsigned int has_remembered_objects : 1;
762 unsigned int has_uncollectible_wb_unprotected_objects : 1;
771 struct ccan_list_node page_node;
773 bits_t wb_unprotected_bits[HEAP_PAGE_BITMAP_LIMIT];
775 bits_t mark_bits[HEAP_PAGE_BITMAP_LIMIT];
776 bits_t uncollectible_bits[HEAP_PAGE_BITMAP_LIMIT];
777 bits_t marking_bits[HEAP_PAGE_BITMAP_LIMIT];
779 bits_t remembered_bits[HEAP_PAGE_BITMAP_LIMIT];
782 bits_t pinned_bits[HEAP_PAGE_BITMAP_LIMIT];
783 bits_t age_bits[HEAP_PAGE_BITMAP_LIMIT * RVALUE_AGE_BIT_COUNT];
790asan_lock_freelist(
struct heap_page *page)
792 asan_poison_memory_region(&page->freelist,
sizeof(
struct free_list *));
799asan_unlock_freelist(
struct heap_page *page)
801 asan_unpoison_memory_region(&page->freelist,
sizeof(
struct free_list *),
false);
807 if (page->total_slots == 0) {
808 GC_ASSERT(page->start == 0);
809 GC_ASSERT(page->slot_size == 0);
810 GC_ASSERT(page->heap == NULL);
811 GC_ASSERT(page->free_slots == 0);
812 asan_unpoisoning_memory_region(&page->freelist,
sizeof(&page->freelist)) {
813 GC_ASSERT(page->freelist == NULL);
819 GC_ASSERT(page->start != 0);
820 GC_ASSERT(page->slot_size != 0);
821 GC_ASSERT(page->heap != NULL);
827#define GET_PAGE_BODY(x) ((struct heap_page_body *)((bits_t)(x) & ~(HEAP_PAGE_ALIGN_MASK)))
828#define GET_PAGE_HEADER(x) (&GET_PAGE_BODY(x)->header)
829#define GET_HEAP_PAGE(x) (GET_PAGE_HEADER(x)->page)
831#define NUM_IN_PAGE(p) (((bits_t)(p) & HEAP_PAGE_ALIGN_MASK) / BASE_SLOT_SIZE)
832#define BITMAP_INDEX(p) (NUM_IN_PAGE(p) / BITS_BITLENGTH )
833#define BITMAP_OFFSET(p) (NUM_IN_PAGE(p) & (BITS_BITLENGTH-1))
834#define BITMAP_BIT(p) ((bits_t)1 << BITMAP_OFFSET(p))
837#define MARKED_IN_BITMAP(bits, p) ((bits)[BITMAP_INDEX(p)] & BITMAP_BIT(p))
838#define MARK_IN_BITMAP(bits, p) ((bits)[BITMAP_INDEX(p)] = (bits)[BITMAP_INDEX(p)] | BITMAP_BIT(p))
839#define CLEAR_IN_BITMAP(bits, p) ((bits)[BITMAP_INDEX(p)] = (bits)[BITMAP_INDEX(p)] & ~BITMAP_BIT(p))
842#define GET_HEAP_MARK_BITS(x) (&GET_HEAP_PAGE(x)->mark_bits[0])
843#define GET_HEAP_PINNED_BITS(x) (&GET_HEAP_PAGE(x)->pinned_bits[0])
844#define GET_HEAP_UNCOLLECTIBLE_BITS(x) (&GET_HEAP_PAGE(x)->uncollectible_bits[0])
845#define GET_HEAP_WB_UNPROTECTED_BITS(x) (&GET_HEAP_PAGE(x)->wb_unprotected_bits[0])
846#define GET_HEAP_MARKING_BITS(x) (&GET_HEAP_PAGE(x)->marking_bits[0])
848#define RVALUE_AGE_BITMAP_INDEX(n) (NUM_IN_PAGE(n) / (BITS_BITLENGTH / RVALUE_AGE_BIT_COUNT))
849#define RVALUE_AGE_BITMAP_OFFSET(n) ((NUM_IN_PAGE(n) % (BITS_BITLENGTH / RVALUE_AGE_BIT_COUNT)) * RVALUE_AGE_BIT_COUNT)
852RVALUE_AGE_GET(
VALUE obj)
854 bits_t *age_bits = GET_HEAP_PAGE(obj)->age_bits;
855 return (
int)(age_bits[RVALUE_AGE_BITMAP_INDEX(obj)] >> RVALUE_AGE_BITMAP_OFFSET(obj)) & RVALUE_AGE_BIT_MASK;
859RVALUE_AGE_SET_BITMAP(
VALUE obj,
int age)
862 bits_t *age_bits = GET_HEAP_PAGE(obj)->age_bits;
864 age_bits[RVALUE_AGE_BITMAP_INDEX(obj)] &= ~(RVALUE_AGE_BIT_MASK << (RVALUE_AGE_BITMAP_OFFSET(obj)));
866 age_bits[RVALUE_AGE_BITMAP_INDEX(obj)] |= ((bits_t)age << RVALUE_AGE_BITMAP_OFFSET(obj));
870RVALUE_AGE_SET(
VALUE obj,
int age)
872 RVALUE_AGE_SET_BITMAP(obj, age);
873 if (age == RVALUE_OLD_AGE) {
881#define malloc_limit objspace->malloc_params.limit
882#define malloc_increase objspace->malloc_counters.increase
883#define malloc_allocated_size objspace->malloc_params.allocated_size
884#define heap_pages_lomem objspace->heap_pages.range[0]
885#define heap_pages_himem objspace->heap_pages.range[1]
886#define heap_pages_freeable_pages objspace->heap_pages.freeable_pages
887#define heap_pages_deferred_final objspace->heap_pages.deferred_final
888#define heaps objspace->heaps
889#define during_gc objspace->flags.during_gc
890#define finalizing objspace->atomic_flags.finalizing
891#define finalizer_table objspace->finalizer_table
892#define ruby_gc_stressful objspace->flags.gc_stressful
893#define ruby_gc_stress_mode objspace->gc_stress_mode
894#if GC_DEBUG_STRESS_TO_CLASS
895#define stress_to_class objspace->stress_to_class
896#define set_stress_to_class(c) (stress_to_class = (c))
898#define stress_to_class ((void)objspace, 0)
899#define set_stress_to_class(c) ((void)objspace, (c))
903#define dont_gc_on() (fprintf(stderr, "dont_gc_on@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = 1)
904#define dont_gc_off() (fprintf(stderr, "dont_gc_off@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = 0)
905#define dont_gc_set(b) (fprintf(stderr, "dont_gc_set(%d)@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = (int)(b))
906#define dont_gc_val() (objspace->flags.dont_gc)
908#define dont_gc_on() (objspace->flags.dont_gc = 1)
909#define dont_gc_off() (objspace->flags.dont_gc = 0)
910#define dont_gc_set(b) (objspace->flags.dont_gc = (int)(b))
911#define dont_gc_val() (objspace->flags.dont_gc)
914#define gc_config_full_mark_set(b) (objspace->gc_config.full_mark = (int)(b))
915#define gc_config_full_mark_val (objspace->gc_config.full_mark)
917#ifndef DURING_GC_COULD_MALLOC_REGION_START
918# define DURING_GC_COULD_MALLOC_REGION_START() \
919 assert(rb_during_gc()); \
920 bool _prev_enabled = rb_gc_impl_gc_enabled_p(objspace); \
921 rb_gc_impl_gc_disable(objspace, false)
924#ifndef DURING_GC_COULD_MALLOC_REGION_END
925# define DURING_GC_COULD_MALLOC_REGION_END() \
926 if (_prev_enabled) rb_gc_impl_gc_enable(objspace)
929static inline enum gc_mode
930gc_mode_verify(
enum gc_mode mode)
932#if RGENGC_CHECK_MODE > 0
935 case gc_mode_marking:
936 case gc_mode_sweeping:
937 case gc_mode_compacting:
940 rb_bug(
"gc_mode_verify: unreachable (%d)", (
int)mode);
949 for (
int i = 0; i < HEAP_COUNT; i++) {
950 if ((&heaps[i])->sweeping_page) {
961 for (
int i = 0; i < HEAP_COUNT; i++) {
962 count += (&heaps[i])->total_pages;
971 for (
int i = 0; i < HEAP_COUNT; i++) {
973 count += heap->total_allocated_objects;
982 for (
int i = 0; i < HEAP_COUNT; i++) {
984 count += heap->total_freed_objects;
993 for (
int i = 0; i < HEAP_COUNT; i++) {
995 count += heap->final_slots_count;
1000#define gc_mode(objspace) gc_mode_verify((enum gc_mode)(objspace)->flags.mode)
1001#define gc_mode_set(objspace, m) ((objspace)->flags.mode = (unsigned int)gc_mode_verify(m))
1002#define gc_needs_major_flags objspace->rgengc.need_major_gc
1004#define is_marking(objspace) (gc_mode(objspace) == gc_mode_marking)
1005#define is_sweeping(objspace) (gc_mode(objspace) == gc_mode_sweeping)
1006#define is_full_marking(objspace) ((objspace)->flags.during_minor_gc == FALSE)
1007#define is_incremental_marking(objspace) ((objspace)->flags.during_incremental_marking != FALSE)
1008#define will_be_incremental_marking(objspace) ((objspace)->rgengc.need_major_gc != GPR_FLAG_NONE)
1009#define GC_INCREMENTAL_SWEEP_SLOT_COUNT 2048
1010#define GC_INCREMENTAL_SWEEP_POOL_SLOT_COUNT 1024
1011#define is_lazy_sweeping(objspace) (GC_ENABLE_LAZY_SWEEP && has_sweeping_pages(objspace))
1013#define needs_continue_sweeping(objspace, heap) \
1014 ((heap)->free_pages == NULL && is_lazy_sweeping(objspace))
1016#if SIZEOF_LONG == SIZEOF_VOIDP
1017# define obj_id_to_ref(objid) ((objid) ^ FIXNUM_FLAG)
1018#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
1019# define obj_id_to_ref(objid) (FIXNUM_P(objid) ? \
1020 ((objid) ^ FIXNUM_FLAG) : (NUM2PTR(objid) << 1))
1022# error not supported
1028 void (*dfree)(
void *);
1032#define RZOMBIE(o) ((struct RZombie *)(o))
1034static bool ruby_enable_autocompact =
false;
1035#if RGENGC_CHECK_MODE
1036static gc_compact_compare_func ruby_autocompact_compare_func;
1040static int garbage_collect(
rb_objspace_t *,
unsigned int reason);
1045enum gc_enter_event {
1046 gc_enter_event_start,
1047 gc_enter_event_continue,
1048 gc_enter_event_rest,
1049 gc_enter_event_finalizer,
1052static inline void gc_enter(
rb_objspace_t *
objspace,
enum gc_enter_event event,
unsigned int *lock_lev);
1053static inline void gc_exit(
rb_objspace_t *
objspace,
enum gc_enter_event event,
unsigned int *lock_lev);
1068static int gc_mark_stacked_objects_incremental(
rb_objspace_t *,
size_t count);
1069NO_SANITIZE(
"memory",
static inline bool is_pointer_to_heap(
rb_objspace_t *
objspace,
const void *ptr));
1071static void gc_verify_internal_consistency(
void *objspace_ptr);
1073static double getrusage_time(
void);
1077static inline void gc_prof_mark_timer_start(
rb_objspace_t *);
1079static inline void gc_prof_sweep_timer_start(
rb_objspace_t *);
1080static inline void gc_prof_sweep_timer_stop(
rb_objspace_t *);
1084#define gc_prof_record(objspace) (objspace)->profile.current_record
1085#define gc_prof_enabled(objspace) ((objspace)->profile.run && (objspace)->profile.current_record)
1087#ifdef HAVE_VA_ARGS_MACRO
1088# define gc_report(level, objspace, ...) \
1089 if (!RGENGC_DEBUG_ENABLED(level)) {} else gc_report_body(level, objspace, __VA_ARGS__)
1091# define gc_report if (!RGENGC_DEBUG_ENABLED(0)) {} else gc_report_body
1093PRINTF_ARGS(
static void gc_report_body(
int level,
rb_objspace_t *
objspace,
const char *fmt, ...), 3, 4);
1095static void gc_finalize_deferred(
void *dmy);
1106#if defined(__GNUC__) && defined(__i386__)
1107typedef unsigned long long tick_t;
1108#define PRItick "llu"
1112 unsigned long long int x;
1113 __asm__ __volatile__ (
"rdtsc" :
"=A" (x));
1117#elif defined(__GNUC__) && defined(__x86_64__)
1118typedef unsigned long long tick_t;
1119#define PRItick "llu"
1121static __inline__ tick_t
1124 unsigned long hi, lo;
1125 __asm__ __volatile__ (
"rdtsc" :
"=a"(lo),
"=d"(hi));
1126 return ((
unsigned long long)lo)|( ((
unsigned long long)hi)<<32);
1129#elif defined(__powerpc64__) && (GCC_VERSION_SINCE(4,8,0) || defined(__clang__))
1130typedef unsigned long long tick_t;
1131#define PRItick "llu"
1133static __inline__ tick_t
1136 unsigned long long val = __builtin_ppc_get_timebase();
1140#elif defined(__POWERPC__) && defined(__APPLE__)
1144typedef unsigned long long tick_t;
1145#define PRItick "llu"
1147static __inline__ tick_t
1150 unsigned long int upper, lower, tmp;
1151 # define mftbu(r) __asm__ volatile("mftbu %0" : "=r"(r))
1152 # define mftb(r) __asm__ volatile("mftb %0" : "=r"(r))
1157 }
while (tmp != upper);
1158 return ((tick_t)upper << 32) | lower;
1161#elif defined(__aarch64__) && defined(__GNUC__)
1162typedef unsigned long tick_t;
1165static __inline__ tick_t
1169 __asm__ __volatile__ (
"mrs %0, cntvct_el0" :
"=r" (val));
1174#elif defined(_WIN32) && defined(_MSC_VER)
1176typedef unsigned __int64 tick_t;
1177#define PRItick "llu"
1186typedef clock_t tick_t;
1187#define PRItick "llu"
1196#define MEASURE_LINE(expr) expr
1201#define RVALUE_MARKED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_MARK_BITS(obj), (obj))
1202#define RVALUE_WB_UNPROTECTED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), (obj))
1203#define RVALUE_MARKING_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), (obj))
1204#define RVALUE_UNCOLLECTIBLE_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(obj), (obj))
1205#define RVALUE_PINNED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_PINNED_BITS(obj), (obj))
1210 check_rvalue_consistency(
objspace, obj);
1211 return RVALUE_MARKED_BITMAP(obj) != 0;
1217 check_rvalue_consistency(
objspace, obj);
1218 return RVALUE_PINNED_BITMAP(obj) != 0;
1224 check_rvalue_consistency(
objspace, obj);
1225 return RVALUE_WB_UNPROTECTED_BITMAP(obj) != 0;
1231 check_rvalue_consistency(
objspace, obj);
1232 return RVALUE_MARKING_BITMAP(obj) != 0;
1238 check_rvalue_consistency(
objspace, obj);
1239 return MARKED_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj) != 0;
1245 check_rvalue_consistency(
objspace, obj);
1246 return RVALUE_UNCOLLECTIBLE_BITMAP(obj) != 0;
1249#define RVALUE_PAGE_WB_UNPROTECTED(page, obj) MARKED_IN_BITMAP((page)->wb_unprotected_bits, (obj))
1250#define RVALUE_PAGE_UNCOLLECTIBLE(page, obj) MARKED_IN_BITMAP((page)->uncollectible_bits, (obj))
1251#define RVALUE_PAGE_MARKING(page, obj) MARKED_IN_BITMAP((page)->marking_bits, (obj))
1262 int lev = RB_GC_VM_LOCK_NO_BARRIER();
1265 fprintf(stderr,
"check_rvalue_consistency: %p is a special const.\n", (
void *)obj);
1268 else if (!is_pointer_to_heap(
objspace, (
void *)obj)) {
1270 while (empty_page) {
1271 if ((uintptr_t)empty_page->body <= (uintptr_t)obj &&
1272 (uintptr_t)obj < (uintptr_t)empty_page->body + HEAP_PAGE_SIZE) {
1273 GC_ASSERT(heap_page_in_global_empty_pages_pool(
objspace, empty_page));
1274 fprintf(stderr,
"check_rvalue_consistency: %p is in an empty page (%p).\n",
1275 (
void *)obj, (
void *)empty_page);
1280 fprintf(stderr,
"check_rvalue_consistency: %p is not a Ruby object.\n", (
void *)obj);
1286 const int wb_unprotected_bit = RVALUE_WB_UNPROTECTED_BITMAP(obj) != 0;
1287 const int uncollectible_bit = RVALUE_UNCOLLECTIBLE_BITMAP(obj) != 0;
1288 const int mark_bit = RVALUE_MARKED_BITMAP(obj) != 0;
1289 const int marking_bit = RVALUE_MARKING_BITMAP(obj) != 0;
1290 const int remembered_bit = MARKED_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj) != 0;
1291 const int age = RVALUE_AGE_GET((
VALUE)obj);
1293 if (heap_page_in_global_empty_pages_pool(
objspace, GET_HEAP_PAGE(obj))) {
1294 fprintf(stderr,
"check_rvalue_consistency: %s is in tomb page.\n", rb_obj_info(obj));
1298 fprintf(stderr,
"check_rvalue_consistency: %s is T_NONE.\n", rb_obj_info(obj));
1302 fprintf(stderr,
"check_rvalue_consistency: %s is T_ZOMBIE.\n", rb_obj_info(obj));
1307 rb_obj_memsize_of((
VALUE)obj);
1314 if (age > 0 && wb_unprotected_bit) {
1315 fprintf(stderr,
"check_rvalue_consistency: %s is not WB protected, but age is %d > 0.\n", rb_obj_info(obj), age);
1319 if (!is_marking(
objspace) && uncollectible_bit && !mark_bit) {
1320 fprintf(stderr,
"check_rvalue_consistency: %s is uncollectible, but is not marked while !gc.\n", rb_obj_info(obj));
1325 if (uncollectible_bit && age != RVALUE_OLD_AGE && !wb_unprotected_bit) {
1326 fprintf(stderr,
"check_rvalue_consistency: %s is uncollectible, but not old (age: %d) and not WB unprotected.\n",
1327 rb_obj_info(obj), age);
1330 if (remembered_bit && age != RVALUE_OLD_AGE) {
1331 fprintf(stderr,
"check_rvalue_consistency: %s is remembered, but not old (age: %d).\n",
1332 rb_obj_info(obj), age);
1344 if (is_incremental_marking(
objspace) && marking_bit) {
1345 if (!is_marking(
objspace) && !mark_bit) {
1346 fprintf(stderr,
"check_rvalue_consistency: %s is marking, but not marked.\n", rb_obj_info(obj));
1352 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
1354 if (err > 0 && terminate) {
1355 rb_bug(
"check_rvalue_consistency_force: there is %d errors.", err);
1360#if RGENGC_CHECK_MODE == 0
1370 check_rvalue_consistency_force(
objspace, obj, TRUE);
1383 asan_unpoisoning_object(obj) {
1394 check_rvalue_consistency(
objspace, obj);
1403 MARK_IN_BITMAP(&page->uncollectible_bits[0], obj);
1406#if RGENGC_PROFILE >= 2
1407 objspace->profile.total_promoted_count++;
1415 RB_DEBUG_COUNTER_INC(obj_promote);
1416 RVALUE_PAGE_OLD_UNCOLLECTIBLE_SET(
objspace, GET_HEAP_PAGE(obj), obj);
1423 int age = RVALUE_AGE_GET((
VALUE)obj);
1425 if (RGENGC_CHECK_MODE && age == RVALUE_OLD_AGE) {
1426 rb_bug(
"RVALUE_AGE_INC: can not increment age of OLD object %s.", rb_obj_info(obj));
1430 RVALUE_AGE_SET(obj, age);
1432 if (age == RVALUE_OLD_AGE) {
1433 RVALUE_OLD_UNCOLLECTIBLE_SET(
objspace, obj);
1436 check_rvalue_consistency(
objspace, obj);
1442 check_rvalue_consistency(
objspace, obj);
1443 GC_ASSERT(!RVALUE_OLD_P(
objspace, obj));
1444 RVALUE_AGE_SET(obj, RVALUE_OLD_AGE - 1);
1445 check_rvalue_consistency(
objspace, obj);
1449RVALUE_AGE_RESET(
VALUE obj)
1451 RVALUE_AGE_SET(obj, 0);
1457 check_rvalue_consistency(
objspace, obj);
1458 GC_ASSERT(RVALUE_OLD_P(
objspace, obj));
1460 if (!is_incremental_marking(
objspace) && RVALUE_REMEMBERED(
objspace, obj)) {
1461 CLEAR_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj);
1464 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(obj), obj);
1465 RVALUE_AGE_RESET(obj);
1467 if (RVALUE_MARKED(
objspace, obj)) {
1471 check_rvalue_consistency(
objspace, obj);
1483 return !RVALUE_MARKED(
objspace, obj);
1487rb_gc_impl_gc_enabled_p(
void *objspace_ptr)
1490 return !dont_gc_val();
1494rb_gc_impl_gc_enable(
void *objspace_ptr)
1502rb_gc_impl_gc_disable(
void *objspace_ptr,
bool finish_current_gc)
1506 if (finish_current_gc) {
1520 return calloc(1, n);
1524rb_gc_impl_set_event_hook(
void *objspace_ptr,
const rb_event_flag_t event)
1532rb_gc_impl_get_total_time(
void *objspace_ptr)
1536 unsigned long long marking_time =
objspace->profile.marking_time_ns;
1537 unsigned long long sweeping_time =
objspace->profile.sweeping_time_ns;
1539 return marking_time + sweeping_time;
1543rb_gc_impl_set_measure_total_time(
void *objspace_ptr,
VALUE flag)
1551rb_gc_impl_get_measure_total_time(
void *objspace_ptr)
1561 size_t heap_idx = heap - heaps;
1562 return gc_params.heap_init_slots[heap_idx];
1567rb_gc_impl_garbage_object_p(
void *objspace_ptr,
VALUE ptr)
1573 asan_unpoisoning_object(ptr) {
1585 if (dead)
return true;
1586 return is_lazy_sweeping(
objspace) && GET_HEAP_PAGE(ptr)->flags.before_sweep &&
1597 rb_asan_unpoison_object(obj,
false);
1599 asan_unlock_freelist(page);
1603 slot->next = page->freelist;
1604 page->freelist = slot;
1605 asan_lock_freelist(page);
1608 GC_ASSERT(RVALUE_AGE_GET(obj) == 0);
1610 if (RGENGC_CHECK_MODE &&
1612 !(page->start <= (uintptr_t)obj &&
1613 (uintptr_t)obj < ((uintptr_t)page->start + (page->total_slots * page->slot_size)) &&
1614 obj % BASE_SLOT_SIZE == 0)) {
1615 rb_bug(
"heap_page_add_freeobj: %p is not rvalue.", (
void *)obj);
1618 rb_asan_poison_object(obj);
1619 gc_report(3,
objspace,
"heap_page_add_freeobj: add %p to freelist\n", (
void *)obj);
1624 rb_heap_t *heap,
size_t free_slots,
size_t total_slots)
1626 double goal_ratio = gc_params.heap_free_slots_goal_ratio;
1627 size_t target_total_slots;
1629 if (goal_ratio == 0.0) {
1630 target_total_slots = (size_t)(total_slots * gc_params.growth_factor);
1632 else if (total_slots == 0) {
1633 target_total_slots = minimum_slots_for_heap(
objspace, heap);
1639 double f = (double)(total_slots - free_slots) / ((1 - goal_ratio) * total_slots);
1641 if (f > gc_params.growth_factor) f = gc_params.growth_factor;
1642 if (f < 1.0) f = 1.1;
1644 target_total_slots = (size_t)(f * total_slots);
1648 "free_slots(%8"PRIuSIZE
")/total_slots(%8"PRIuSIZE
")=%1.2f,"
1649 " G(%1.2f), f(%1.2f),"
1650 " total_slots(%8"PRIuSIZE
") => target_total_slots(%8"PRIuSIZE
")\n",
1651 free_slots, total_slots, free_slots/(
double)total_slots,
1652 goal_ratio, f, total_slots, target_total_slots);
1656 if (gc_params.growth_max_slots > 0) {
1657 size_t max_total_slots = (size_t)(total_slots + gc_params.growth_max_slots);
1658 if (target_total_slots > max_total_slots) target_total_slots = max_total_slots;
1661 size_t extend_slot_count = target_total_slots - total_slots;
1663 if (extend_slot_count == 0) extend_slot_count = 1;
1665 objspace->heap_pages.allocatable_slots += extend_slot_count;
1671 asan_unlock_freelist(page);
1672 GC_ASSERT(page->free_slots != 0);
1673 GC_ASSERT(page->freelist != NULL);
1675 page->free_next = heap->free_pages;
1676 heap->free_pages = page;
1678 RUBY_DEBUG_LOG(
"page:%p freelist:%p", (
void *)page, (
void *)page->freelist);
1680 asan_lock_freelist(page);
1686 asan_unlock_freelist(page);
1687 GC_ASSERT(page->free_slots != 0);
1688 GC_ASSERT(page->freelist != NULL);
1690 page->free_next = heap->pooled_pages;
1691 heap->pooled_pages = page;
1692 objspace->rincgc.pooled_slots += page->free_slots;
1694 asan_lock_freelist(page);
1700 ccan_list_del(&page->page_node);
1701 heap->total_pages--;
1702 heap->total_slots -= page->total_slots;
1706gc_aligned_free(
void *ptr,
size_t size)
1708#if defined __MINGW32__
1709 __mingw_aligned_free(ptr);
1712#elif defined(HAVE_POSIX_MEMALIGN) || defined(HAVE_MEMALIGN)
1715 free(((
void**)ptr)[-1]);
1722 GC_ASSERT((uintptr_t)page_body % HEAP_PAGE_ALIGN == 0);
1724 if (HEAP_PAGE_ALLOC_USE_MMAP) {
1726 GC_ASSERT(HEAP_PAGE_SIZE % sysconf(_SC_PAGE_SIZE) == 0);
1727 if (munmap(page_body, HEAP_PAGE_SIZE)) {
1728 rb_bug(
"heap_page_body_free: munmap failed");
1733 gc_aligned_free(page_body, HEAP_PAGE_SIZE);
1740 objspace->heap_pages.freed_pages++;
1741 heap_page_body_free(page->body);
1748 if (
objspace->empty_pages != NULL && heap_pages_freeable_pages > 0) {
1749 GC_ASSERT(
objspace->empty_pages_count > 0);
1754 for (i = j = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
1757 if (heap_page_in_global_empty_pages_pool(
objspace, page) && heap_pages_freeable_pages > 0) {
1759 heap_pages_freeable_pages--;
1762 if (heap_page_in_global_empty_pages_pool(
objspace, page)) {
1763 page->free_next =
objspace->empty_pages;
1769 rb_darray_set(
objspace->heap_pages.sorted, j, page);
1775 rb_darray_pop(
objspace->heap_pages.sorted, i - j);
1776 GC_ASSERT(rb_darray_size(
objspace->heap_pages.sorted) == j);
1779 uintptr_t himem = (uintptr_t)hipage->body + HEAP_PAGE_SIZE;
1780 GC_ASSERT(himem <= heap_pages_himem);
1781 heap_pages_himem = himem;
1784 uintptr_t lomem = (uintptr_t)lopage->body +
sizeof(
struct heap_page_header);
1785 GC_ASSERT(lomem >= heap_pages_lomem);
1786 heap_pages_lomem = lomem;
1791gc_aligned_malloc(
size_t alignment,
size_t size)
1794 GC_ASSERT(((alignment - 1) & alignment) == 0);
1795 GC_ASSERT(alignment %
sizeof(
void*) == 0);
1799#if defined __MINGW32__
1800 res = __mingw_aligned_malloc(size, alignment);
1802 void *_aligned_malloc(
size_t,
size_t);
1803 res = _aligned_malloc(size, alignment);
1804#elif defined(HAVE_POSIX_MEMALIGN)
1805 if (posix_memalign(&res, alignment, size) != 0) {
1808#elif defined(HAVE_MEMALIGN)
1809 res = memalign(alignment, size);
1812 res = malloc(alignment + size +
sizeof(
void*));
1813 aligned = (
char*)res + alignment +
sizeof(
void*);
1814 aligned -= ((
VALUE)aligned & (alignment - 1));
1815 ((
void**)aligned)[-1] = res;
1816 res = (
void*)aligned;
1819 GC_ASSERT((uintptr_t)res % alignment == 0);
1825heap_page_body_allocate(
void)
1829 if (HEAP_PAGE_ALLOC_USE_MMAP) {
1831 GC_ASSERT(HEAP_PAGE_ALIGN % sysconf(_SC_PAGE_SIZE) == 0);
1833 size_t mmap_size = HEAP_PAGE_ALIGN + HEAP_PAGE_SIZE;
1834 char *ptr = mmap(NULL, mmap_size,
1835 PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
1836 if (ptr == MAP_FAILED) {
1845#if defined(HAVE_SYS_PRCTL_H) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
1846 prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME, ptr, mmap_size,
"Ruby:GC:default:heap_page_body_allocate");
1850 char *aligned = ptr + HEAP_PAGE_ALIGN;
1851 aligned -= ((
VALUE)aligned & (HEAP_PAGE_ALIGN - 1));
1852 GC_ASSERT(aligned > ptr);
1853 GC_ASSERT(aligned <= ptr + HEAP_PAGE_ALIGN);
1855 size_t start_out_of_range_size = aligned - ptr;
1856 GC_ASSERT(start_out_of_range_size % sysconf(_SC_PAGE_SIZE) == 0);
1857 if (start_out_of_range_size > 0) {
1858 if (munmap(ptr, start_out_of_range_size)) {
1859 rb_bug(
"heap_page_body_allocate: munmap failed for start");
1863 size_t end_out_of_range_size = HEAP_PAGE_ALIGN - start_out_of_range_size;
1864 GC_ASSERT(end_out_of_range_size % sysconf(_SC_PAGE_SIZE) == 0);
1865 if (end_out_of_range_size > 0) {
1866 if (munmap(aligned + HEAP_PAGE_SIZE, end_out_of_range_size)) {
1867 rb_bug(
"heap_page_body_allocate: munmap failed for end");
1875 page_body = gc_aligned_malloc(HEAP_PAGE_ALIGN, HEAP_PAGE_SIZE);
1878 GC_ASSERT((uintptr_t)page_body % HEAP_PAGE_ALIGN == 0);
1887 if (
objspace->empty_pages == NULL) {
1888 GC_ASSERT(
objspace->empty_pages_count == 0);
1891 GC_ASSERT(
objspace->empty_pages_count > 0);
1894 objspace->empty_pages = page->free_next;
1904 if (page_body == 0) {
1910 heap_page_body_free(page_body);
1915 uintptr_t end = (uintptr_t)page_body + HEAP_PAGE_SIZE;
1918 size_t hi = rb_darray_size(
objspace->heap_pages.sorted);
1922 size_t mid = (lo + hi) / 2;
1923 mid_page = rb_darray_get(
objspace->heap_pages.sorted, mid);
1924 if ((uintptr_t)mid_page->start < start) {
1927 else if ((uintptr_t)mid_page->start > start) {
1931 rb_bug(
"same heap page is allocated: %p at %"PRIuVALUE, (
void *)page_body, (
VALUE)mid);
1935 rb_darray_insert_without_gc(&
objspace->heap_pages.sorted, hi, page);
1937 if (heap_pages_lomem == 0 || heap_pages_lomem > start) heap_pages_lomem = start;
1938 if (heap_pages_himem < end) heap_pages_himem = end;
1940 page->body = page_body;
1941 page_body->header.page = page;
1943 objspace->heap_pages.allocated_pages++;
1952 GC_ASSERT(!heap->sweeping_page);
1953 GC_ASSERT(heap_page_in_global_empty_pages_pool(
objspace, page));
1957 if (start % BASE_SLOT_SIZE != 0) {
1958 int delta = BASE_SLOT_SIZE - (start % BASE_SLOT_SIZE);
1959 start = start + delta;
1960 GC_ASSERT(NUM_IN_PAGE(start) == 0 || NUM_IN_PAGE(start) == 1);
1966 if (NUM_IN_PAGE(start) == 1) {
1967 start += heap->slot_size - BASE_SLOT_SIZE;
1970 GC_ASSERT(NUM_IN_PAGE(start) * BASE_SLOT_SIZE % heap->slot_size == 0);
1973 int slot_count = (int)((HEAP_PAGE_SIZE - (start - (uintptr_t)page->body))/heap->slot_size);
1975 page->start = start;
1976 page->total_slots = slot_count;
1977 page->slot_size = heap->slot_size;
1980 asan_unlock_freelist(page);
1981 page->freelist = NULL;
1982 asan_unpoison_memory_region(page->body, HEAP_PAGE_SIZE,
false);
1983 for (
VALUE p = (
VALUE)start; p < start + (slot_count * heap->slot_size); p += heap->slot_size) {
1984 heap_page_add_freeobj(
objspace, page, p);
1986 asan_lock_freelist(page);
1988 page->free_slots = slot_count;
1990 heap->total_allocated_pages++;
1992 ccan_list_add_tail(&heap->pages, &page->page_node);
1993 heap->total_pages++;
1994 heap->total_slots += page->total_slots;
2000 gc_report(1,
objspace,
"heap_page_allocate_and_initialize: rb_darray_size(objspace->heap_pages.sorted): %"PRIdSIZE
", "
2001 "allocatable_slots: %"PRIdSIZE
", heap->total_pages: %"PRIdSIZE
"\n",
2002 rb_darray_size(
objspace->heap_pages.sorted),
objspace->heap_pages.allocatable_slots, heap->total_pages);
2004 bool allocated =
false;
2007 if (page == NULL &&
objspace->heap_pages.allocatable_slots > 0) {
2008 page = heap_page_allocate(
objspace);
2011 GC_ASSERT(page != NULL);
2015 heap_add_page(
objspace, heap, page);
2016 heap_add_freepage(heap, page);
2019 if (
objspace->heap_pages.allocatable_slots > (
size_t)page->total_slots) {
2020 objspace->heap_pages.allocatable_slots -= page->total_slots;
2023 objspace->heap_pages.allocatable_slots = 0;
2028 return page != NULL;
2034 size_t prev_allocatable_slots =
objspace->heap_pages.allocatable_slots;
2036 objspace->heap_pages.allocatable_slots = 1;
2037 heap_page_allocate_and_initialize(
objspace, heap);
2038 GC_ASSERT(heap->free_pages != NULL);
2039 objspace->heap_pages.allocatable_slots = prev_allocatable_slots;
2045 unsigned int lock_lev;
2046 bool needs_gc = is_incremental_marking(
objspace) || needs_continue_sweeping(
objspace, heap);
2047 if (!needs_gc)
return;
2049 gc_enter(
objspace, gc_enter_event_continue, &lock_lev);
2052 if (is_incremental_marking(
objspace)) {
2053 if (gc_marks_continue(
objspace, heap)) {
2058 if (needs_continue_sweeping(
objspace, heap)) {
2062 gc_exit(
objspace, gc_enter_event_continue, &lock_lev);
2068 GC_ASSERT(heap->free_pages == NULL);
2070 if (heap->total_slots < gc_params.heap_init_slots[heap - heaps] &&
2071 heap->sweeping_page == NULL) {
2072 heap_page_allocate_and_initialize_force(
objspace, heap);
2073 GC_ASSERT(heap->free_pages != NULL);
2080 if (heap->free_pages == NULL) {
2081 heap_page_allocate_and_initialize(
objspace, heap);
2086 if (heap->free_pages == NULL) {
2087 GC_ASSERT(
objspace->empty_pages_count == 0);
2088 GC_ASSERT(
objspace->heap_pages.allocatable_slots == 0);
2090 if (gc_start(
objspace, GPR_FLAG_NEWOBJ) == FALSE) {
2094 if (
objspace->heap_pages.allocatable_slots == 0 && !gc_config_full_mark_val) {
2095 heap_allocatable_slots_expand(
objspace, heap,
2096 heap->freed_slots + heap->empty_slots,
2098 GC_ASSERT(
objspace->heap_pages.allocatable_slots > 0);
2106 if (heap->free_pages == NULL && !heap_page_allocate_and_initialize(
objspace, heap)) {
2107 if (gc_needs_major_flags == GPR_FLAG_NONE) {
2108 rb_bug(
"cannot create a new page after GC");
2111 if (gc_start(
objspace, GPR_FLAG_NEWOBJ) == FALSE) {
2118 if (heap->free_pages == NULL &&
2119 !heap_page_allocate_and_initialize(
objspace, heap)) {
2120 rb_bug(
"cannot create a new page after major GC");
2128 GC_ASSERT(heap->free_pages != NULL);
2132static inline const char*
2133rb_gc_impl_source_location_cstr(
int *ptr)
2154 RBASIC(obj)->flags = flags;
2156#if RBASIC_SHAPE_ID_FIELD
2157 RBASIC(obj)->shape_id = 0;
2162 RVALUE_AGE_SET_CANDIDATE(
objspace, obj);
2165#if RACTOR_CHECK_MODE
2166 void rb_ractor_setup_belonging(
VALUE obj);
2167 rb_ractor_setup_belonging(obj);
2170#if RGENGC_CHECK_MODE
2171 int lev = RB_GC_VM_LOCK_NO_BARRIER();
2173 check_rvalue_consistency(
objspace, obj);
2175 GC_ASSERT(RVALUE_MARKED(
objspace, obj) == FALSE);
2176 GC_ASSERT(RVALUE_MARKING(
objspace, obj) == FALSE);
2177 GC_ASSERT(RVALUE_OLD_P(
objspace, obj) == FALSE);
2178 GC_ASSERT(RVALUE_WB_UNPROTECTED(
objspace, obj) == FALSE);
2180 if (RVALUE_REMEMBERED(
objspace, obj)) rb_bug(
"newobj: %s is remembered.", rb_obj_info(obj));
2182 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
2185 if (RB_UNLIKELY(wb_protected == FALSE)) {
2186 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), obj);
2191 objspace->profile.total_generated_normal_object_count++;
2192#if RGENGC_PROFILE >= 2
2197 objspace->profile.total_generated_shady_object_count++;
2198#if RGENGC_PROFILE >= 2
2205 GET_RVALUE_OVERHEAD(obj)->file = rb_gc_impl_source_location_cstr(&GET_RVALUE_OVERHEAD(obj)->line);
2209 gc_report(5,
objspace,
"newobj: %s\n", rb_obj_info(obj));
2216rb_gc_impl_obj_slot_size(
VALUE obj)
2218 return GET_HEAP_PAGE(obj)->slot_size - RVALUE_OVERHEAD;
2222heap_slot_size(
unsigned char pool_id)
2224 GC_ASSERT(pool_id < HEAP_COUNT);
2226 size_t slot_size = (1 << pool_id) * BASE_SLOT_SIZE;
2228#if RGENGC_CHECK_MODE
2230 GC_ASSERT(heaps[pool_id].slot_size == (
short)slot_size);
2233 slot_size -= RVALUE_OVERHEAD;
2239rb_gc_impl_size_allocatable_p(
size_t size)
2241 return size <= heap_slot_size(HEAP_COUNT - 1);
2244static const size_t ALLOCATED_COUNT_STEP = 1024;
2248 for (
int heap_idx = 0; heap_idx < HEAP_COUNT; heap_idx++) {
2253 heap_cache->allocated_objects_count = 0;
2262 struct free_slot *p = heap_cache->freelist;
2264 if (RB_UNLIKELY(is_incremental_marking(
objspace))) {
2266 if (cache->incremental_mark_step_allocated_slots >= INCREMENTAL_MARK_STEP_ALLOCATIONS) {
2271 cache->incremental_mark_step_allocated_slots++;
2277 rb_asan_unpoison_object(obj,
true);
2278 heap_cache->freelist = p->next;
2280 heap_cache->allocated_objects_count++;
2282 if (heap_cache->allocated_objects_count >= ALLOCATED_COUNT_STEP) {
2284 heap_cache->allocated_objects_count = 0;
2287#if RGENGC_CHECK_MODE
2288 GC_ASSERT(rb_gc_impl_obj_slot_size(obj) == heap_slot_size(heap_idx));
2290 MEMZERO((
char *)obj,
char, heap_slot_size(heap_idx));
2304 if (heap->free_pages == NULL) {
2308 page = heap->free_pages;
2309 heap->free_pages = page->free_next;
2311 GC_ASSERT(page->free_slots != 0);
2313 asan_unlock_freelist(page);
2322 gc_report(3,
objspace,
"ractor_set_cache: Using page %p\n", (
void *)page->body);
2326 GC_ASSERT(heap_cache->freelist == NULL);
2327 GC_ASSERT(page->free_slots != 0);
2328 GC_ASSERT(page->freelist != NULL);
2330 heap_cache->using_page = page;
2331 heap_cache->freelist = page->freelist;
2332 page->free_slots = 0;
2333 page->freelist = NULL;
2335 rb_asan_unpoison_object((
VALUE)heap_cache->freelist,
false);
2337 rb_asan_poison_object((
VALUE)heap_cache->freelist);
2341heap_idx_for_size(
size_t size)
2343 size += RVALUE_OVERHEAD;
2345 size_t slot_count = CEILDIV(size, BASE_SLOT_SIZE);
2348 size_t heap_idx = 64 - nlz_int64(slot_count - 1);
2350 if (heap_idx >= HEAP_COUNT) {
2351 rb_bug(
"heap_idx_for_size: allocation size too large "
2352 "(size=%"PRIuSIZE
"u, heap_idx=%"PRIuSIZE
"u)", size, heap_idx);
2355#if RGENGC_CHECK_MODE
2357 GC_ASSERT(size <= (
size_t)heaps[heap_idx].slot_size);
2358 if (heap_idx > 0) GC_ASSERT(size > (
size_t)heaps[heap_idx - 1].slot_size);
2365rb_gc_impl_heap_id_for_size(
void *objspace_ptr,
size_t size)
2367 return heap_idx_for_size(size);
2371static size_t heap_sizes[HEAP_COUNT + 1] = { 0 };
2374rb_gc_impl_heap_sizes(
void *objspace_ptr)
2376 if (heap_sizes[0] == 0) {
2377 for (
unsigned char i = 0; i < HEAP_COUNT; i++) {
2378 heap_sizes[i] = heap_slot_size(i);
2393 unsigned int lev = 0;
2394 bool unlock_vm =
false;
2397 lev = RB_GC_CR_LOCK();
2402 if (is_incremental_marking(
objspace)) {
2404 cache->incremental_mark_step_allocated_slots = 0;
2407 obj = ractor_cache_allocate_slot(
objspace, cache, heap_idx);
2413 ractor_cache_set_page(
objspace, cache, heap_idx, page);
2416 obj = ractor_cache_allocate_slot(
objspace, cache, heap_idx);
2421 RB_GC_CR_UNLOCK(lev);
2424 if (RB_UNLIKELY(obj ==
Qfalse)) {
2433 VALUE obj = ractor_cache_allocate_slot(
objspace, cache, heap_idx);
2435 if (RB_UNLIKELY(obj ==
Qfalse)) {
2436 obj = newobj_cache_miss(
objspace, cache, heap_idx, vm_locked);
2450 lev = RB_GC_CR_LOCK();
2452 if (RB_UNLIKELY(during_gc || ruby_gc_stressful)) {
2456 if (rb_memerror_reentered()) {
2459 rb_bug(
"object allocation during garbage collection phase");
2462 if (ruby_gc_stressful) {
2463 if (!garbage_collect(
objspace, GPR_FLAG_NEWOBJ)) {
2469 obj = newobj_alloc(
objspace, cache, heap_idx,
true);
2470 newobj_init(klass, flags, wb_protected,
objspace, obj);
2472 RB_GC_CR_UNLOCK(lev);
2477NOINLINE(
static VALUE newobj_slowpath_wb_protected(
VALUE klass,
VALUE flags,
2479NOINLINE(
static VALUE newobj_slowpath_wb_unprotected(
VALUE klass,
VALUE flags,
2485 return newobj_slowpath(klass, flags,
objspace, cache, TRUE, heap_idx);
2491 return newobj_slowpath(klass, flags,
objspace, cache, FALSE, heap_idx);
2495rb_gc_impl_new_obj(
void *objspace_ptr,
void *cache_ptr,
VALUE klass,
VALUE flags,
bool wb_protected,
size_t alloc_size)
2500 RB_DEBUG_COUNTER_INC(obj_newobj);
2501 (void)RB_DEBUG_COUNTER_INC_IF(obj_newobj_wb_unprotected, !wb_protected);
2503 if (RB_UNLIKELY(stress_to_class)) {
2504 if (rb_hash_lookup2(stress_to_class, klass,
Qundef) !=
Qundef) {
2509 size_t heap_idx = heap_idx_for_size(alloc_size);
2513 if (!RB_UNLIKELY(during_gc || ruby_gc_stressful) &&
2515 obj = newobj_alloc(
objspace, cache, heap_idx,
false);
2516 newobj_init(klass, flags, wb_protected,
objspace, obj);
2519 RB_DEBUG_COUNTER_INC(obj_newobj_slowpath);
2521 obj = wb_protected ?
2522 newobj_slowpath_wb_protected(klass, flags,
objspace, cache, heap_idx) :
2523 newobj_slowpath_wb_unprotected(klass, flags,
objspace, cache, heap_idx);
2530ptr_in_page_body_p(
const void *ptr,
const void *memb)
2533 uintptr_t p_body = (uintptr_t)page->body;
2535 if ((uintptr_t)ptr >= p_body) {
2536 return (uintptr_t)ptr < (p_body + HEAP_PAGE_SIZE) ? 0 : 1;
2549 if (ptr < (uintptr_t)heap_pages_lomem ||
2550 ptr > (uintptr_t)heap_pages_himem) {
2554 res = bsearch((
void *)ptr, rb_darray_ref(
objspace->heap_pages.sorted, 0),
2556 ptr_in_page_body_p);
2570 register uintptr_t p = (uintptr_t)ptr;
2573 RB_DEBUG_COUNTER_INC(gc_isptr_trial);
2575 if (p < heap_pages_lomem || p > heap_pages_himem)
return FALSE;
2576 RB_DEBUG_COUNTER_INC(gc_isptr_range);
2578 if (p % BASE_SLOT_SIZE != 0)
return FALSE;
2579 RB_DEBUG_COUNTER_INC(gc_isptr_align);
2581 page = heap_page_for_ptr(
objspace, (uintptr_t)ptr);
2583 RB_DEBUG_COUNTER_INC(gc_isptr_maybe);
2584 if (heap_page_in_global_empty_pages_pool(
objspace, page)) {
2588 if (p < page->start)
return FALSE;
2589 if (p >= page->start + (page->total_slots * page->slot_size))
return FALSE;
2590 if ((NUM_IN_PAGE(p) * BASE_SLOT_SIZE) % page->slot_size != 0)
return FALSE;
2599rb_gc_impl_pointer_to_heap_p(
void *objspace_ptr,
const void *ptr)
2601 return is_pointer_to_heap(objspace_ptr, ptr);
2604#define ZOMBIE_OBJ_KEPT_FLAGS (FL_FINALIZE)
2607rb_gc_impl_make_zombie(
void *objspace_ptr,
VALUE obj,
void (*dfree)(
void *),
void *data)
2611 struct RZombie *zombie = RZOMBIE(obj);
2612 zombie->flags =
T_ZOMBIE | (zombie->flags & ZOMBIE_OBJ_KEPT_FLAGS);
2613 zombie->dfree = dfree;
2614 zombie->data = data;
2615 VALUE prev, next = heap_pages_deferred_final;
2617 zombie->next = prev = next;
2619 }
while (next != prev);
2621 struct heap_page *page = GET_HEAP_PAGE(obj);
2622 page->final_slots++;
2623 page->heap->final_slots_count++;
2626typedef int each_obj_callback(
void *,
void *,
size_t,
void *);
2627typedef int each_page_callback(
struct heap_page *,
void *);
2631 bool reenable_incremental;
2633 each_obj_callback *each_obj_callback;
2634 each_page_callback *each_page_callback;
2638 size_t pages_counts[HEAP_COUNT];
2642objspace_each_objects_ensure(
VALUE arg)
2648 if (data->reenable_incremental) {
2649 objspace->flags.dont_incremental = FALSE;
2652 for (
int i = 0; i < HEAP_COUNT; i++) {
2653 struct heap_page **pages = data->pages[i];
2661objspace_each_objects_try(
VALUE arg)
2667 for (
int i = 0; i < HEAP_COUNT; i++) {
2669 size_t size = heap->total_pages *
sizeof(
struct heap_page *);
2671 struct heap_page **pages = malloc(size);
2672 if (!pages) rb_memerror();
2680 size_t pages_count = 0;
2681 ccan_list_for_each(&heap->pages, page, page_node) {
2682 pages[pages_count] = page;
2685 data->pages[i] = pages;
2686 data->pages_counts[i] = pages_count;
2687 GC_ASSERT(pages_count == heap->total_pages);
2690 for (
int i = 0; i < HEAP_COUNT; i++) {
2692 size_t pages_count = data->pages_counts[i];
2693 struct heap_page **pages = data->pages[i];
2696 for (
size_t i = 0; i < pages_count; i++) {
2699 if (page == NULL)
break;
2703 if (pages[i] != page)
continue;
2705 uintptr_t pstart = (uintptr_t)page->start;
2706 uintptr_t pend = pstart + (page->total_slots * heap->slot_size);
2708 if (data->each_obj_callback &&
2709 (*data->each_obj_callback)((
void *)pstart, (
void *)pend, heap->slot_size, data->data)) {
2712 if (data->each_page_callback &&
2713 (*data->each_page_callback)(page, data->data)) {
2717 page = ccan_list_next(&heap->pages, page, page_node);
2729 bool reenable_incremental = FALSE;
2731 reenable_incremental = !
objspace->flags.dont_incremental;
2734 objspace->flags.dont_incremental = TRUE;
2745objspace_each_objects(
rb_objspace_t *
objspace, each_obj_callback *callback,
void *data,
bool protected)
2749 .each_obj_callback = callback,
2750 .each_page_callback = NULL,
2757rb_gc_impl_each_objects(
void *objspace_ptr, each_obj_callback *callback,
void *data)
2759 objspace_each_objects(objspace_ptr, callback, data, TRUE);
2762#if GC_CAN_COMPILE_COMPACTION
2764objspace_each_pages(
rb_objspace_t *
objspace, each_page_callback *callback,
void *data,
bool protected)
2768 .each_obj_callback = NULL,
2769 .each_page_callback = callback,
2777rb_gc_impl_define_finalizer(
void *objspace_ptr,
VALUE obj,
VALUE block)
2787 unsigned int lev = RB_GC_VM_LOCK();
2789 if (st_lookup(finalizer_table, obj, &data)) {
2790 table = (
VALUE)data;
2793 RB_GC_VM_UNLOCK(lev);
2799 for (i = 0; i <
len; i++) {
2806 lev = RB_GC_VM_LOCK();
2814 st_add_direct(finalizer_table, obj, table);
2817 RB_GC_VM_UNLOCK(lev);
2823rb_gc_impl_undefine_finalizer(
void *objspace_ptr,
VALUE obj)
2829 st_data_t data = obj;
2831 int lev = RB_GC_VM_LOCK();
2832 st_delete(finalizer_table, &data, 0);
2833 RB_GC_VM_UNLOCK(lev);
2839rb_gc_impl_copy_finalizer(
void *objspace_ptr,
VALUE dest,
VALUE obj)
2847 int lev = RB_GC_VM_LOCK();
2848 if (RB_LIKELY(st_lookup(finalizer_table, obj, &data))) {
2851 st_insert(finalizer_table, dest, table);
2855 rb_bug(
"rb_gc_copy_finalizer: FL_FINALIZE set but not found in finalizer_table: %s", rb_obj_info(obj));
2857 RB_GC_VM_UNLOCK(lev);
2861get_final(
long i,
void *data)
2871 if (RZOMBIE(zombie)->dfree) {
2872 RZOMBIE(zombie)->dfree(RZOMBIE(zombie)->data);
2875 st_data_t key = (st_data_t)zombie;
2879 if (st_delete(finalizer_table, &key, &table)) {
2880 RB_GC_VM_UNLOCK(lev);
2882 lev = RB_GC_VM_LOCK();
2885 rb_bug(
"FL_FINALIZE flag is set, but finalizers are not found");
2889 GC_ASSERT(!st_lookup(finalizer_table, key, NULL));
2900 rb_asan_unpoison_object(zombie,
false);
2901 next_zombie = RZOMBIE(zombie)->next;
2902 page = GET_HEAP_PAGE(zombie);
2904 unsigned int lev = RB_GC_VM_LOCK();
2906 lev = run_final(
objspace, zombie, lev);
2909 GC_ASSERT(page->heap->final_slots_count > 0);
2910 GC_ASSERT(page->final_slots > 0);
2912 page->heap->final_slots_count--;
2913 page->final_slots--;
2915 RVALUE_AGE_SET_BITMAP(zombie, 0);
2916 heap_page_add_freeobj(
objspace, page, zombie);
2917 page->heap->total_freed_objects++;
2919 RB_GC_VM_UNLOCK(lev);
2921 zombie = next_zombie;
2937 rb_gc_set_pending_interrupt();
2938 finalize_deferred_heap_pages(
objspace);
2939 rb_gc_unset_pending_interrupt();
2943gc_finalize_deferred(
void *dmy)
2962gc_abort(
void *objspace_ptr)
2966 if (is_incremental_marking(
objspace)) {
2969 while (pop_mark_stack(&
objspace->mark_stack, &obj));
2971 objspace->flags.during_incremental_marking = FALSE;
2975 for (
int i = 0; i < HEAP_COUNT; i++) {
2978 heap->sweeping_page = NULL;
2981 ccan_list_for_each(&heap->pages, page, page_node) {
2982 page->flags.before_sweep =
false;
2987 for (
int i = 0; i < HEAP_COUNT; i++) {
2989 rgengc_mark_and_rememberset_clear(
objspace, heap);
2992 gc_mode_set(
objspace, gc_mode_none);
2996rb_gc_impl_shutdown_free_objects(
void *objspace_ptr)
3000 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
3002 short stride = page->slot_size;
3004 uintptr_t p = (uintptr_t)page->start;
3005 uintptr_t pend = p + page->total_slots * stride;
3006 for (; p < pend; p += stride) {
3008 asan_unpoisoning_object(vp) {
3010 rb_gc_obj_free_vm_weak_references(vp);
3011 if (rb_gc_obj_free(
objspace, vp)) {
3021rb_gc_impl_shutdown_call_finalizer_i(st_data_t key, st_data_t val, st_data_t _data)
3037rb_gc_impl_shutdown_call_finalizer(
void *objspace_ptr)
3041#if RGENGC_CHECK_MODE >= 2
3042 gc_verify_internal_consistency(
objspace);
3046 objspace->flags.dont_incremental = 1;
3055 while (finalizer_table->num_entries) {
3056 st_foreach(finalizer_table, rb_gc_impl_shutdown_call_finalizer_i, 0);
3061 GC_ASSERT(heap_pages_deferred_final == 0);
3070 unsigned int lock_lev;
3071 gc_enter(
objspace, gc_enter_event_finalizer, &lock_lev);
3074 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
3076 short stride = page->slot_size;
3078 uintptr_t p = (uintptr_t)page->start;
3079 uintptr_t pend = p + page->total_slots * stride;
3080 for (; p < pend; p += stride) {
3082 asan_unpoisoning_object(vp) {
3083 if (rb_gc_shutdown_call_finalizer_p(vp)) {
3084 rb_gc_obj_free_vm_weak_references(vp);
3085 if (rb_gc_obj_free(
objspace, vp)) {
3093 gc_exit(
objspace, gc_enter_event_finalizer, &lock_lev);
3095 finalize_deferred_heap_pages(
objspace);
3097 st_free_table(finalizer_table);
3098 finalizer_table = 0;
3103rb_gc_impl_each_object(
void *objspace_ptr,
void (*func)(
VALUE obj,
void *data),
void *data)
3107 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
3109 short stride = page->slot_size;
3111 uintptr_t p = (uintptr_t)page->start;
3112 uintptr_t pend = p + page->total_slots * stride;
3113 for (; p < pend; p += stride) {
3116 asan_unpoisoning_object(obj) {
3132 size_t total_slots = 0;
3133 for (
int i = 0; i < HEAP_COUNT; i++) {
3135 total_slots += heap->total_slots;
3153gc_setup_mark_bits(
struct heap_page *page)
3156 memcpy(&page->mark_bits[0], &page->uncollectible_bits[0], HEAP_PAGE_BITMAP_SIZE);
3163enum {HEAP_PAGE_LOCK = PAGE_NOACCESS, HEAP_PAGE_UNLOCK = PAGE_READWRITE};
3169 return VirtualProtect(body, HEAP_PAGE_SIZE, protect, &old_protect) != 0;
3171#elif defined(__wasi__)
3173enum {HEAP_PAGE_LOCK, HEAP_PAGE_UNLOCK};
3174#define protect_page_body(body, protect) 1
3176enum {HEAP_PAGE_LOCK = PROT_NONE, HEAP_PAGE_UNLOCK = PROT_READ | PROT_WRITE};
3177#define protect_page_body(body, protect) !mprotect((body), HEAP_PAGE_SIZE, (protect))
3183 if (!protect_page_body(body, HEAP_PAGE_LOCK)) {
3184 rb_bug(
"Couldn't protect page %p, errno: %s", (
void *)body, strerror(
errno));
3187 gc_report(5,
objspace,
"Protecting page in move %p\n", (
void *)body);
3194 if (!protect_page_body(body, HEAP_PAGE_UNLOCK)) {
3195 rb_bug(
"Couldn't unprotect page %p, errno: %s", (
void *)body, strerror(
errno));
3198 gc_report(5,
objspace,
"Unprotecting page in move %p\n", (
void *)body);
3205 GC_ASSERT(gc_is_moveable_obj(
objspace, src));
3207 struct heap_page *src_page = GET_HEAP_PAGE(src);
3215 GC_ASSERT(RVALUE_MARKED(
objspace, src));
3217 asan_unlock_freelist(free_page);
3219 asan_lock_freelist(free_page);
3221 rb_asan_unpoison_object(dest,
false);
3228 asan_unlock_freelist(free_page);
3229 free_page->freelist = ((
struct free_slot *)dest)->next;
3230 asan_lock_freelist(free_page);
3234 if (src_page->slot_size > free_page->slot_size) {
3237 else if (free_page->slot_size > src_page->slot_size) {
3241 objspace->rcompactor.total_moved++;
3243 gc_move(
objspace, src, dest, src_page->slot_size, free_page->slot_size);
3245 free_page->free_slots--;
3253 struct heap_page *cursor = heap->compact_cursor;
3256 unlock_page_body(
objspace, cursor->body);
3257 cursor = ccan_list_next(&heap->pages, cursor, page_node);
3262#if GC_CAN_COMPILE_COMPACTION
3266#if defined(__MINGW32__) || defined(_WIN32)
3267# define GC_COMPACTION_SUPPORTED 1
3271# define GC_COMPACTION_SUPPORTED (GC_CAN_COMPILE_COMPACTION && HEAP_PAGE_ALLOC_USE_MMAP)
3274#if GC_CAN_COMPILE_COMPACTION
3276read_barrier_handler(uintptr_t address)
3284 if (page_body == NULL) {
3285 rb_bug(
"read_barrier_handler: segmentation fault at %p", (
void *)address);
3288 int lev = RB_GC_VM_LOCK();
3290 unlock_page_body(
objspace, page_body);
3292 objspace->profile.read_barrier_faults++;
3294 invalidate_moved_page(
objspace, GET_HEAP_PAGE(address));
3296 RB_GC_VM_UNLOCK(lev);
3300#if !GC_CAN_COMPILE_COMPACTION
3302uninstall_handlers(
void)
3308install_handlers(
void)
3312#elif defined(_WIN32)
3313static LPTOP_LEVEL_EXCEPTION_FILTER old_handler;
3314typedef void (*signal_handler)(int);
3315static signal_handler old_sigsegv_handler;
3318read_barrier_signal(EXCEPTION_POINTERS *info)
3321 if (info->ExceptionRecord->ExceptionCode == EXCEPTION_ACCESS_VIOLATION) {
3326 read_barrier_handler((uintptr_t)info->ExceptionRecord->ExceptionInformation[1]);
3327 return EXCEPTION_CONTINUE_EXECUTION;
3330 return EXCEPTION_CONTINUE_SEARCH;
3335uninstall_handlers(
void)
3337 signal(SIGSEGV, old_sigsegv_handler);
3338 SetUnhandledExceptionFilter(old_handler);
3342install_handlers(
void)
3345 old_sigsegv_handler = signal(SIGSEGV, NULL);
3348 old_handler = SetUnhandledExceptionFilter(read_barrier_signal);
3351static struct sigaction old_sigbus_handler;
3352static struct sigaction old_sigsegv_handler;
3354#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3355static exception_mask_t old_exception_masks[32];
3356static mach_port_t old_exception_ports[32];
3357static exception_behavior_t old_exception_behaviors[32];
3358static thread_state_flavor_t old_exception_flavors[32];
3359static mach_msg_type_number_t old_exception_count;
3362disable_mach_bad_access_exc(
void)
3364 old_exception_count =
sizeof(old_exception_masks) /
sizeof(old_exception_masks[0]);
3365 task_swap_exception_ports(
3366 mach_task_self(), EXC_MASK_BAD_ACCESS,
3367 MACH_PORT_NULL, EXCEPTION_DEFAULT, 0,
3368 old_exception_masks, &old_exception_count,
3369 old_exception_ports, old_exception_behaviors, old_exception_flavors
3374restore_mach_bad_access_exc(
void)
3376 for (mach_msg_type_number_t i = 0; i < old_exception_count; i++) {
3377 task_set_exception_ports(
3379 old_exception_masks[i], old_exception_ports[i],
3380 old_exception_behaviors[i], old_exception_flavors[i]
3387read_barrier_signal(
int sig, siginfo_t *info,
void *data)
3390 struct sigaction prev_sigbus, prev_sigsegv;
3391 sigaction(SIGBUS, &old_sigbus_handler, &prev_sigbus);
3392 sigaction(SIGSEGV, &old_sigsegv_handler, &prev_sigsegv);
3395 sigset_t set, prev_set;
3397 sigaddset(&set, SIGBUS);
3398 sigaddset(&set, SIGSEGV);
3399 sigprocmask(SIG_UNBLOCK, &set, &prev_set);
3400#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3401 disable_mach_bad_access_exc();
3404 read_barrier_handler((uintptr_t)info->si_addr);
3407#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3408 restore_mach_bad_access_exc();
3410 sigaction(SIGBUS, &prev_sigbus, NULL);
3411 sigaction(SIGSEGV, &prev_sigsegv, NULL);
3412 sigprocmask(SIG_SETMASK, &prev_set, NULL);
3416uninstall_handlers(
void)
3418#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3419 restore_mach_bad_access_exc();
3421 sigaction(SIGBUS, &old_sigbus_handler, NULL);
3422 sigaction(SIGSEGV, &old_sigsegv_handler, NULL);
3426install_handlers(
void)
3428 struct sigaction action;
3429 memset(&action, 0,
sizeof(
struct sigaction));
3430 sigemptyset(&action.sa_mask);
3431 action.sa_sigaction = read_barrier_signal;
3432 action.sa_flags = SA_SIGINFO | SA_ONSTACK;
3434 sigaction(SIGBUS, &action, &old_sigbus_handler);
3435 sigaction(SIGSEGV, &action, &old_sigsegv_handler);
3436#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3437 disable_mach_bad_access_exc();
3445 for (
int i = 0; i < HEAP_COUNT; i++) {
3447 gc_unprotect_pages(
objspace, heap);
3450 uninstall_handlers();
3455 for (
int i = 0; i < HEAP_COUNT; i++) {
3457 heap->compact_cursor = NULL;
3458 heap->free_pages = NULL;
3459 heap->compact_cursor_index = 0;
3464 record->moved_objects =
objspace->rcompactor.total_moved - record->moved_objects;
3466 objspace->flags.during_compacting = FALSE;
3479 struct heap_page *sweep_page = ctx->page;
3480 short slot_size = sweep_page->slot_size;
3481 short slot_bits = slot_size / BASE_SLOT_SIZE;
3482 GC_ASSERT(slot_bits > 0);
3486 GC_ASSERT(vp % BASE_SLOT_SIZE == 0);
3488 rb_asan_unpoison_object(vp,
false);
3492 gc_report(2,
objspace,
"page_sweep: free %p\n", (
void *)p);
3493#if RGENGC_CHECK_MODE
3495 if (RVALUE_OLD_P(
objspace, vp)) rb_bug(
"page_sweep: %p - old while minor GC.", (
void *)p);
3496 if (RVALUE_REMEMBERED(
objspace, vp)) rb_bug(
"page_sweep: %p - remembered.", (
void *)p);
3500 if (RVALUE_WB_UNPROTECTED(
objspace, vp)) CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(vp), vp);
3502#if RGENGC_CHECK_MODE
3503#define CHECK(x) if (x(objspace, vp) != FALSE) rb_bug("obj_free: " #x "(%s) != FALSE", rb_obj_info(vp))
3504 CHECK(RVALUE_WB_UNPROTECTED);
3505 CHECK(RVALUE_MARKED);
3506 CHECK(RVALUE_MARKING);
3507 CHECK(RVALUE_UNCOLLECTIBLE);
3513 rb_gc_obj_free_vm_weak_references(vp);
3514 if (rb_gc_obj_free(
objspace, vp)) {
3517 (void)VALGRIND_MAKE_MEM_UNDEFINED((
void*)p, BASE_SLOT_SIZE);
3518 RVALUE_AGE_SET_BITMAP(vp, 0);
3519 heap_page_add_freeobj(
objspace, sweep_page, vp);
3520 gc_report(3,
objspace,
"page_sweep: %s is added to freelist\n", rb_obj_info(vp));
3529 if (
objspace->flags.during_compacting) {
3535 rb_bug(
"T_MOVED shouldn't be seen until compaction is finished");
3537 gc_report(3,
objspace,
"page_sweep: %s is added to freelist\n", rb_obj_info(vp));
3539 RVALUE_AGE_SET_BITMAP(vp, 0);
3540 heap_page_add_freeobj(
objspace, sweep_page, vp);
3551 bitset >>= slot_bits;
3558 struct heap_page *sweep_page = ctx->page;
3559 GC_ASSERT(sweep_page->heap == heap);
3562 bits_t *bits, bitset;
3564 gc_report(2,
objspace,
"page_sweep: start.\n");
3566#if RGENGC_CHECK_MODE
3567 if (!
objspace->flags.immediate_sweep) {
3568 GC_ASSERT(sweep_page->flags.before_sweep == TRUE);
3571 sweep_page->flags.before_sweep = FALSE;
3572 sweep_page->free_slots = 0;
3574 p = (uintptr_t)sweep_page->start;
3575 bits = sweep_page->mark_bits;
3577 int page_rvalue_count = sweep_page->total_slots * (sweep_page->slot_size / BASE_SLOT_SIZE);
3578 int out_of_range_bits = (NUM_IN_PAGE(p) + page_rvalue_count) % BITS_BITLENGTH;
3579 if (out_of_range_bits != 0) {
3580 bits[BITMAP_INDEX(p) + page_rvalue_count / BITS_BITLENGTH] |= ~(((bits_t)1 << out_of_range_bits) - 1);
3586 int bitmap_plane_count = CEILDIV(NUM_IN_PAGE(p) + page_rvalue_count, BITS_BITLENGTH);
3587 GC_ASSERT(bitmap_plane_count == HEAP_PAGE_BITMAP_LIMIT - 1 ||
3588 bitmap_plane_count == HEAP_PAGE_BITMAP_LIMIT);
3590 bits_t slot_mask = heap->slot_bits_mask;
3594 bitset >>= NUM_IN_PAGE(p);
3595 bitset &= slot_mask;
3597 gc_sweep_plane(
objspace, heap, p, bitset, ctx);
3599 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
3601 for (
int i = 1; i < bitmap_plane_count; i++) {
3603 bitset &= slot_mask;
3605 gc_sweep_plane(
objspace, heap, p, bitset, ctx);
3607 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
3610 if (!heap->compact_cursor) {
3611 gc_setup_mark_bits(sweep_page);
3614#if GC_PROFILE_MORE_DETAIL
3617 record->removing_objects += ctx->final_slots + ctx->freed_slots;
3618 record->empty_objects += ctx->empty_slots;
3621 if (0) fprintf(stderr,
"gc_sweep_page(%"PRIdSIZE
"): total_slots: %d, freed_slots: %d, empty_slots: %d, final_slots: %d\n",
3623 sweep_page->total_slots,
3624 ctx->freed_slots, ctx->empty_slots, ctx->final_slots);
3626 sweep_page->free_slots += ctx->freed_slots + ctx->empty_slots;
3627 sweep_page->heap->total_freed_objects += ctx->freed_slots;
3629 if (heap_pages_deferred_final && !finalizing) {
3630 gc_finalize_deferred_register(
objspace);
3633#if RGENGC_CHECK_MODE
3634 short freelist_len = 0;
3635 asan_unlock_freelist(sweep_page);
3636 struct free_slot *ptr = sweep_page->freelist;
3639 rb_asan_unpoison_object((
VALUE)ptr,
false);
3641 rb_asan_poison_object((
VALUE)ptr);
3644 asan_lock_freelist(sweep_page);
3645 if (freelist_len != sweep_page->free_slots) {
3646 rb_bug(
"inconsistent freelist length: expected %d but was %d", sweep_page->free_slots, freelist_len);
3650 gc_report(2,
objspace,
"page_sweep: end.\n");
3654gc_mode_name(
enum gc_mode mode)
3657 case gc_mode_none:
return "none";
3658 case gc_mode_marking:
return "marking";
3659 case gc_mode_sweeping:
return "sweeping";
3660 case gc_mode_compacting:
return "compacting";
3661 default: rb_bug(
"gc_mode_name: unknown mode: %d", (
int)mode);
3668#if RGENGC_CHECK_MODE
3669 enum gc_mode prev_mode = gc_mode(
objspace);
3670 switch (prev_mode) {
3671 case gc_mode_none: GC_ASSERT(mode == gc_mode_marking);
break;
3672 case gc_mode_marking: GC_ASSERT(mode == gc_mode_sweeping);
break;
3673 case gc_mode_sweeping: GC_ASSERT(mode == gc_mode_none || mode == gc_mode_compacting);
break;
3674 case gc_mode_compacting: GC_ASSERT(mode == gc_mode_none);
break;
3677 if (0) fprintf(stderr,
"gc_mode_transition: %s->%s\n", gc_mode_name(gc_mode(
objspace)), gc_mode_name(mode));
3685 asan_unlock_freelist(page);
3686 if (page->freelist) {
3688 rb_asan_unpoison_object((
VALUE)p,
false);
3692 rb_asan_poison_object((
VALUE)prev);
3693 rb_asan_unpoison_object((
VALUE)p,
false);
3696 rb_asan_poison_object((
VALUE)p);
3699 page->freelist = freelist;
3701 asan_lock_freelist(page);
3708 heap->sweeping_page = ccan_list_top(&heap->pages,
struct heap_page, page_node);
3709 heap->free_pages = NULL;
3710 heap->pooled_pages = NULL;
3711 if (!
objspace->flags.immediate_sweep) {
3714 ccan_list_for_each(&heap->pages, page, page_node) {
3715 page->flags.before_sweep = TRUE;
3720#if defined(__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ == 4
3724#if GC_CAN_COMPILE_COMPACTION
3725static void gc_sort_heap_by_compare_func(
rb_objspace_t *
objspace, gc_compact_compare_func compare_func);
3726static int compare_pinned_slots(
const void *left,
const void *right,
void *d);
3730gc_ractor_newobj_cache_clear(
void *c,
void *data)
3735 newobj_cache->incremental_mark_step_allocated_slots = 0;
3737 for (
size_t heap_idx = 0; heap_idx < HEAP_COUNT; heap_idx++) {
3743 cache->allocated_objects_count = 0;
3745 struct heap_page *page = cache->using_page;
3746 struct free_slot *freelist = cache->freelist;
3747 RUBY_DEBUG_LOG(
"ractor using_page:%p freelist:%p", (
void *)page, (
void *)freelist);
3749 heap_page_freelist_append(page, freelist);
3751 cache->using_page = NULL;
3752 cache->freelist = NULL;
3759 gc_mode_transition(
objspace, gc_mode_sweeping);
3762#if GC_CAN_COMPILE_COMPACTION
3763 if (
objspace->flags.during_compacting) {
3764 gc_sort_heap_by_compare_func(
3766 objspace->rcompactor.compare_func ?
objspace->rcompactor.compare_func : compare_pinned_slots
3771 for (
int i = 0; i < HEAP_COUNT; i++) {
3773 gc_sweep_start_heap(
objspace, heap);
3776 if (heap->sweeping_page == NULL) {
3777 GC_ASSERT(heap->total_pages == 0);
3778 GC_ASSERT(heap->total_slots == 0);
3779 gc_sweep_finish_heap(
objspace, heap);
3783 rb_gc_ractor_newobj_cache_foreach(gc_ractor_newobj_cache_clear, NULL);
3789 size_t total_slots = heap->total_slots;
3790 size_t swept_slots = heap->freed_slots + heap->empty_slots;
3792 size_t init_slots = gc_params.heap_init_slots[heap - heaps];
3793 size_t min_free_slots = (size_t)(MAX(total_slots, init_slots) * gc_params.heap_free_slots_min_ratio);
3795 if (swept_slots < min_free_slots &&
3797 ((heap->empty_slots == 0 && total_slots > 0) || heap->freed_slots > heap->empty_slots)) {
3803 while (swept_slots < min_free_slots &&
3804 (resurrected_page = heap_page_resurrect(
objspace))) {
3805 heap_add_page(
objspace, heap, resurrected_page);
3806 heap_add_freepage(heap, resurrected_page);
3808 swept_slots += resurrected_page->free_slots;
3811 if (swept_slots < min_free_slots) {
3815 objspace->profile.count -
objspace->rgengc.last_major_gc < RVALUE_OLD_AGE) {
3816 if (
objspace->heap_pages.allocatable_slots < min_free_slots) {
3817 heap_allocatable_slots_expand(
objspace, heap, swept_slots, heap->total_slots);
3821 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_NOFREE;
3822 heap->force_major_gc_count++;
3831 gc_report(1,
objspace,
"gc_sweep_finish\n");
3834 heap_pages_free_unused_pages(
objspace);
3836 for (
int i = 0; i < HEAP_COUNT; i++) {
3839 heap->freed_slots = 0;
3840 heap->empty_slots = 0;
3842 if (!will_be_incremental_marking(
objspace)) {
3843 struct heap_page *end_page = heap->free_pages;
3845 while (end_page->free_next) end_page = end_page->free_next;
3846 end_page->free_next = heap->pooled_pages;
3849 heap->free_pages = heap->pooled_pages;
3851 heap->pooled_pages = NULL;
3857 gc_mode_transition(
objspace, gc_mode_none);
3859#if RGENGC_CHECK_MODE >= 2
3860 gc_verify_internal_consistency(
objspace);
3867 struct heap_page *sweep_page = heap->sweeping_page;
3868 int swept_slots = 0;
3869 int pooled_slots = 0;
3871 if (sweep_page == NULL)
return FALSE;
3873#if GC_ENABLE_LAZY_SWEEP
3874 gc_prof_sweep_timer_start(
objspace);
3878 RUBY_DEBUG_LOG(
"sweep_page:%p", (
void *)sweep_page);
3886 gc_sweep_page(
objspace, heap, &ctx);
3887 int free_slots = ctx.freed_slots + ctx.empty_slots;
3889 heap->sweeping_page = ccan_list_next(&heap->pages, sweep_page, page_node);
3891 if (free_slots == sweep_page->total_slots) {
3893 heap_unlink_page(
objspace, heap, sweep_page);
3895 sweep_page->start = 0;
3896 sweep_page->total_slots = 0;
3897 sweep_page->slot_size = 0;
3898 sweep_page->heap = NULL;
3899 sweep_page->free_slots = 0;
3901 asan_unlock_freelist(sweep_page);
3902 sweep_page->freelist = NULL;
3903 asan_lock_freelist(sweep_page);
3905 asan_poison_memory_region(sweep_page->body, HEAP_PAGE_SIZE);
3908 sweep_page->free_next =
objspace->empty_pages;
3909 objspace->empty_pages = sweep_page;
3911 else if (free_slots > 0) {
3912 heap->freed_slots += ctx.freed_slots;
3913 heap->empty_slots += ctx.empty_slots;
3915 if (pooled_slots < GC_INCREMENTAL_SWEEP_POOL_SLOT_COUNT) {
3916 heap_add_poolpage(
objspace, heap, sweep_page);
3917 pooled_slots += free_slots;
3920 heap_add_freepage(heap, sweep_page);
3921 swept_slots += free_slots;
3922 if (swept_slots > GC_INCREMENTAL_SWEEP_SLOT_COUNT) {
3928 sweep_page->free_next = NULL;
3930 }
while ((sweep_page = heap->sweeping_page));
3932 if (!heap->sweeping_page) {
3933 gc_sweep_finish_heap(
objspace, heap);
3935 if (!has_sweeping_pages(
objspace)) {
3940#if GC_ENABLE_LAZY_SWEEP
3941 gc_prof_sweep_timer_stop(
objspace);
3944 return heap->free_pages != NULL;
3950 for (
int i = 0; i < HEAP_COUNT; i++) {
3953 while (heap->sweeping_page) {
3962 GC_ASSERT(dont_gc_val() == FALSE ||
objspace->profile.latest_gc_info & GPR_FLAG_METHOD);
3963 if (!GC_ENABLE_LAZY_SWEEP)
return;
3967 for (
int i = 0; i < HEAP_COUNT; i++) {
3969 if (gc_sweep_step(
objspace, heap)) {
3970 GC_ASSERT(heap->free_pages != NULL);
3972 else if (heap == sweep_heap) {
3973 if (
objspace->empty_pages_count > 0 ||
objspace->heap_pages.allocatable_slots > 0) {
3984 heap_page_allocate_and_initialize(
objspace, heap);
3986 GC_ASSERT(heap->free_pages != NULL);
3991 GC_ASSERT(gc_mode(
objspace) == gc_mode_none);
4001rb_gc_impl_location(
void *objspace_ptr,
VALUE value)
4005 asan_unpoisoning_object(value) {
4007 destination = (
VALUE)RMOVED(value)->destination;
4011 destination = value;
4018#if GC_CAN_COMPILE_COMPACTION
4029 GC_ASSERT(RVALUE_PINNED(
objspace, forwarding_object));
4030 GC_ASSERT(!RVALUE_MARKED(
objspace, forwarding_object));
4032 CLEAR_IN_BITMAP(GET_HEAP_PINNED_BITS(forwarding_object), forwarding_object);
4034 object = rb_gc_impl_location(
objspace, forwarding_object);
4036 uint32_t original_shape_id = 0;
4038 original_shape_id = RMOVED(forwarding_object)->original_shape_id;
4041 gc_move(
objspace,
object, forwarding_object, GET_HEAP_PAGE(
object)->slot_size, page->slot_size);
4045 if (original_shape_id) {
4046 rb_gc_set_shape(forwarding_object, original_shape_id);
4049 struct heap_page *orig_page = GET_HEAP_PAGE(
object);
4050 orig_page->free_slots++;
4051 RVALUE_AGE_SET_BITMAP(
object, 0);
4052 heap_page_add_freeobj(
objspace, orig_page,
object);
4054 GC_ASSERT(RVALUE_MARKED(
objspace, forwarding_object));
4059 p += BASE_SLOT_SIZE;
4069 bits_t *mark_bits, *pin_bits;
4072 mark_bits = page->mark_bits;
4073 pin_bits = page->pinned_bits;
4075 uintptr_t p = page->start;
4078 bitset = pin_bits[0] & ~mark_bits[0];
4079 bitset >>= NUM_IN_PAGE(p);
4080 invalidate_moved_plane(
objspace, page, p, bitset);
4081 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
4083 for (i=1; i < HEAP_PAGE_BITMAP_LIMIT; i++) {
4086 bitset = pin_bits[i] & ~mark_bits[i];
4088 invalidate_moved_plane(
objspace, page, p, bitset);
4089 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
4098 gc_mode_transition(
objspace, gc_mode_compacting);
4100 for (
int i = 0; i < HEAP_COUNT; i++) {
4102 ccan_list_for_each(&heap->pages, page, page_node) {
4103 page->flags.before_sweep = TRUE;
4106 heap->compact_cursor = ccan_list_tail(&heap->pages,
struct heap_page, page_node);
4107 heap->compact_cursor_index = 0;
4112 record->moved_objects =
objspace->rcompactor.total_moved;
4115 memset(
objspace->rcompactor.considered_count_table, 0,
T_MASK *
sizeof(
size_t));
4116 memset(
objspace->rcompactor.moved_count_table, 0,
T_MASK *
sizeof(
size_t));
4117 memset(
objspace->rcompactor.moved_up_count_table, 0,
T_MASK *
sizeof(
size_t));
4118 memset(
objspace->rcompactor.moved_down_count_table, 0,
T_MASK *
sizeof(
size_t));
4131 const unsigned int immediate_sweep =
objspace->flags.immediate_sweep;
4133 gc_report(1,
objspace,
"gc_sweep: immediate: %d\n", immediate_sweep);
4136 if (
objspace->flags.during_compacting) {
4140 if (immediate_sweep) {
4141#if !GC_ENABLE_LAZY_SWEEP
4142 gc_prof_sweep_timer_start(
objspace);
4145#if !GC_ENABLE_LAZY_SWEEP
4146 gc_prof_sweep_timer_stop(
objspace);
4152 for (
int i = 0; i < HEAP_COUNT; i++) {
4164stack_chunk_alloc(
void)
4178 return stack->chunk == NULL;
4184 size_t size = stack->index;
4185 stack_chunk_t *chunk = stack->chunk ? stack->chunk->next : NULL;
4188 size += stack->limit;
4189 chunk = chunk->next;
4197 chunk->next = stack->cache;
4198 stack->cache = chunk;
4199 stack->cache_size++;
4207 if (stack->unused_cache_size > (stack->cache_size/2)) {
4208 chunk = stack->cache;
4209 stack->cache = stack->cache->next;
4210 stack->cache_size--;
4213 stack->unused_cache_size = stack->cache_size;
4221 GC_ASSERT(stack->index == stack->limit);
4223 if (stack->cache_size > 0) {
4224 next = stack->cache;
4225 stack->cache = stack->cache->next;
4226 stack->cache_size--;
4227 if (stack->unused_cache_size > stack->cache_size)
4228 stack->unused_cache_size = stack->cache_size;
4231 next = stack_chunk_alloc();
4233 next->next = stack->chunk;
4234 stack->chunk = next;
4243 prev = stack->chunk->next;
4244 GC_ASSERT(stack->index == 0);
4245 add_stack_chunk_cache(stack, stack->chunk);
4246 stack->chunk = prev;
4247 stack->index = stack->limit;
4255 while (chunk != NULL) {
4265 mark_stack_chunk_list_free(stack->chunk);
4271 mark_stack_chunk_list_free(stack->cache);
4272 stack->cache_size = 0;
4273 stack->unused_cache_size = 0;
4300 if (stack->index == stack->limit) {
4301 push_mark_stack_chunk(stack);
4303 stack->chunk->data[stack->index++] = obj;
4313 rb_bug(
"push_mark_stack() called for broken object");
4317 rb_bug(
"push_mark_stack: unexpected T_NODE object");
4321 rb_bug(
"rb_gc_mark(): unknown data type 0x%x(%p) %s",
4323 is_pointer_to_heap((
rb_objspace_t *)rb_gc_get_objspace(), (
void *)obj) ?
"corrupted object" :
"non object");
4329 if (is_mark_stack_empty(stack)) {
4332 if (stack->index == 1) {
4333 *data = stack->chunk->data[--stack->index];
4334 pop_mark_stack_chunk(stack);
4337 *data = stack->chunk->data[--stack->index];
4348 stack->index = stack->limit = STACK_CHUNK_SIZE;
4350 for (i=0; i < 4; i++) {
4351 add_stack_chunk_cache(stack, stack_chunk_alloc());
4353 stack->unused_cache_size = stack->cache_size;
4361 if (
objspace->rgengc.parent_object_old_p) {
4362 if (RVALUE_WB_UNPROTECTED(
objspace, obj) || !RVALUE_OLD_P(
objspace, obj)) {
4371 if (RVALUE_MARKED(
objspace, obj))
return 0;
4372 MARK_IN_BITMAP(GET_HEAP_MARK_BITS(obj), obj);
4386 if(!gc_config_full_mark_val)
4389 struct heap_page *page = GET_HEAP_PAGE(obj);
4391 GC_ASSERT(RVALUE_MARKING(
objspace, obj) == FALSE);
4392 check_rvalue_consistency(
objspace, obj);
4394 if (!RVALUE_PAGE_WB_UNPROTECTED(page, obj)) {
4395 if (!RVALUE_OLD_P(
objspace, obj)) {
4396 gc_report(3,
objspace,
"gc_aging: YOUNG: %s\n", rb_obj_info(obj));
4399 else if (is_full_marking(
objspace)) {
4400 GC_ASSERT(RVALUE_PAGE_UNCOLLECTIBLE(page, obj) == FALSE);
4401 RVALUE_PAGE_OLD_UNCOLLECTIBLE_SET(
objspace, page, obj);
4404 check_rvalue_consistency(
objspace, obj);
4412#if RGENGC_CHECK_MODE
4413 if (RVALUE_MARKED(
objspace, obj) == FALSE) rb_bug(
"gc_grey: %s is not marked.", rb_obj_info(obj));
4414 if (RVALUE_MARKING(
objspace, obj) == TRUE) rb_bug(
"gc_grey: %s is marking/remembered.", rb_obj_info(obj));
4417 if (is_incremental_marking(
objspace)) {
4418 MARK_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), obj);
4421 push_mark_stack(&
objspace->mark_stack, obj);
4428 enum {info_size = 256};
4429 char obj_info_buf[info_size];
4430 rb_raw_obj_info(obj_info_buf, info_size, obj);
4432 char parent_obj_info_buf[info_size];
4433 rb_raw_obj_info(parent_obj_info_buf, info_size,
objspace->rgengc.parent_object);
4435 rb_bug(
"try to mark T_NONE object (obj: %s, parent: %s)", obj_info_buf, parent_obj_info_buf);
4442 GC_ASSERT(during_gc);
4443 GC_ASSERT(!
objspace->flags.during_reference_updating);
4445 rgengc_check_relation(
objspace, obj);
4446 if (!gc_mark_set(
objspace, obj))
return;
4449 RUBY_DEBUG_LOG(
"%p (%s) parent:%p (%s)",
4450 (
void *)obj, obj_type_name(obj),
4451 (
void *)
objspace->rgengc.parent_object, obj_type_name(
objspace->rgengc.parent_object));
4454 gc_mark_check_t_none(
objspace, obj);
4464 if (RB_UNLIKELY(
objspace->flags.during_compacting)) {
4465 if (RB_LIKELY(during_gc)) {
4466 if (!RVALUE_PINNED(
objspace, obj)) {
4467 GC_ASSERT(GET_HEAP_PAGE(obj)->pinned_slots <= GET_HEAP_PAGE(obj)->total_slots);
4468 GET_HEAP_PAGE(obj)->pinned_slots++;
4469 MARK_IN_BITMAP(GET_HEAP_PINNED_BITS(obj), obj);
4483rb_gc_impl_mark_and_move(
void *objspace_ptr,
VALUE *ptr)
4487 if (RB_UNLIKELY(
objspace->flags.during_reference_updating)) {
4488 GC_ASSERT(
objspace->flags.during_compacting);
4489 GC_ASSERT(during_gc);
4492 if (destination != *ptr) {
4502rb_gc_impl_mark(
void *objspace_ptr,
VALUE obj)
4510rb_gc_impl_mark_and_pin(
void *objspace_ptr,
VALUE obj)
4518rb_gc_impl_mark_maybe(
void *objspace_ptr,
VALUE obj)
4522 (void)VALGRIND_MAKE_MEM_DEFINED(&obj,
sizeof(obj));
4524 if (is_pointer_to_heap(
objspace, (
void *)obj)) {
4525 asan_unpoisoning_object(obj) {
4540rb_gc_impl_mark_weak(
void *objspace_ptr,
VALUE *ptr)
4546 gc_mark_check_t_none(
objspace, obj);
4552 GC_ASSERT(RVALUE_MARKED(
objspace, obj));
4553 GC_ASSERT(!
objspace->flags.during_compacting);
4558 rgengc_check_relation(
objspace, obj);
4560 rb_darray_append_without_gc(&
objspace->weak_references, ptr);
4562 objspace->profile.weak_references_count++;
4566rb_gc_impl_remove_weak(
void *objspace_ptr,
VALUE parent_obj,
VALUE *ptr)
4572 if (!is_incremental_marking(
objspace))
return;
4575 if (!RVALUE_MARKED(
objspace, parent_obj))
return;
4578 rb_darray_foreach(
objspace->weak_references, i, ptr_ptr) {
4579 if (*ptr_ptr == ptr) {
4587pin_value(st_data_t key, st_data_t value, st_data_t data)
4589 rb_gc_impl_mark_and_pin((
void *)data, (
VALUE)value);
4597 asan_unpoison_memory_region(&
objspace->rgengc.parent_object,
sizeof(
objspace->rgengc.parent_object),
false);
4598 asan_unpoison_memory_region(&
objspace->rgengc.parent_object_old_p,
sizeof(
objspace->rgengc.parent_object_old_p),
false);
4599 objspace->rgengc.parent_object = obj;
4600 objspace->rgengc.parent_object_old_p = old_p;
4612 asan_poison_memory_region(&
objspace->rgengc.parent_object,
sizeof(
objspace->rgengc.parent_object));
4613 asan_poison_memory_region(&
objspace->rgengc.parent_object_old_p,
sizeof(
objspace->rgengc.parent_object_old_p));
4619#define MARK_CHECKPOINT(category) do { \
4620 if (categoryp) *categoryp = category; \
4623 MARK_CHECKPOINT(
"objspace");
4626 if (finalizer_table != NULL) {
4627 st_foreach(finalizer_table, pin_value, (st_data_t)
objspace);
4630 if (stress_to_class) rb_gc_mark(stress_to_class);
4632 rb_gc_save_machine_context();
4633 rb_gc_mark_roots(
objspace, categoryp);
4634 gc_mark_set_parent_invalid(
objspace);
4641 rb_gc_mark_children(
objspace, obj);
4642 gc_mark_set_parent_invalid(
objspace);
4654 size_t marked_slots_at_the_beginning =
objspace->marked_slots;
4655 size_t popped_count = 0;
4657 while (pop_mark_stack(mstack, &obj)) {
4658 if (obj ==
Qundef)
continue;
4660 if (RGENGC_CHECK_MODE && !RVALUE_MARKED(
objspace, obj)) {
4661 rb_bug(
"gc_mark_stacked_objects: %s is not marked.", rb_obj_info(obj));
4666 if (RGENGC_CHECK_MODE && !RVALUE_MARKING(
objspace, obj)) {
4667 rb_bug(
"gc_mark_stacked_objects: incremental, but marking bit is 0");
4669 CLEAR_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), obj);
4672 if (popped_count + (
objspace->marked_slots - marked_slots_at_the_beginning) > count) {
4681 if (RGENGC_CHECK_MODE >= 3) gc_verify_internal_consistency(
objspace);
4683 if (is_mark_stack_empty(mstack)) {
4684 shrink_stack_chunk_cache(mstack);
4695 return gc_mark_stacked_objects(
objspace, TRUE, count);
4701 return gc_mark_stacked_objects(
objspace, FALSE, 0);
4704#if RGENGC_CHECK_MODE >= 4
4706#define MAKE_ROOTSIG(obj) (((VALUE)(obj) << 1) | 0x01)
4707#define IS_ROOTSIG(obj) ((VALUE)(obj) & 0x01)
4708#define GET_ROOTSIG(obj) ((const char *)((VALUE)(obj) >> 1))
4716static struct reflist *
4717reflist_create(
VALUE obj)
4719 struct reflist *refs =
xmalloc(
sizeof(
struct reflist));
4722 refs->list[0] = obj;
4728reflist_destruct(
struct reflist *refs)
4735reflist_add(
struct reflist *refs,
VALUE obj)
4737 if (refs->pos == refs->size) {
4739 SIZED_REALLOC_N(refs->list,
VALUE, refs->size, refs->size/2);
4742 refs->list[refs->pos++] = obj;
4746reflist_dump(
struct reflist *refs)
4749 for (i=0; i<refs->pos; i++) {
4750 VALUE obj = refs->list[i];
4751 if (IS_ROOTSIG(obj)) {
4752 fprintf(stderr,
"<root@%s>", GET_ROOTSIG(obj));
4755 fprintf(stderr,
"<%s>", rb_obj_info(obj));
4757 if (i+1 < refs->pos) fprintf(stderr,
", ");
4762reflist_referred_from_machine_context(
struct reflist *refs)
4765 for (i=0; i<refs->pos; i++) {
4766 VALUE obj = refs->list[i];
4767 if (IS_ROOTSIG(obj) && strcmp(GET_ROOTSIG(obj),
"machine_context") == 0)
return 1;
4782 const char *category;
4788allrefs_add(
struct allrefs *data,
VALUE obj)
4790 struct reflist *refs;
4793 if (st_lookup(data->references, obj, &r)) {
4794 refs = (
struct reflist *)r;
4795 reflist_add(refs, data->root_obj);
4799 refs = reflist_create(data->root_obj);
4800 st_insert(data->references, obj, (st_data_t)refs);
4806allrefs_i(
VALUE obj,
void *ptr)
4808 struct allrefs *data = (
struct allrefs *)ptr;
4810 if (allrefs_add(data, obj)) {
4811 push_mark_stack(&data->mark_stack, obj);
4816allrefs_roots_i(
VALUE obj,
void *ptr)
4818 struct allrefs *data = (
struct allrefs *)ptr;
4819 if (strlen(data->category) == 0) rb_bug(
"!!!");
4820 data->root_obj = MAKE_ROOTSIG(data->category);
4822 if (allrefs_add(data, obj)) {
4823 push_mark_stack(&data->mark_stack, obj);
4826#define PUSH_MARK_FUNC_DATA(v) do { \
4827 struct gc_mark_func_data_struct *prev_mark_func_data = GET_VM()->gc.mark_func_data; \
4828 GET_VM()->gc.mark_func_data = (v);
4830#define POP_MARK_FUNC_DATA() GET_VM()->gc.mark_func_data = prev_mark_func_data;} while (0)
4835 struct allrefs data;
4836 struct gc_mark_func_data_struct mfd;
4838 int prev_dont_gc = dont_gc_val();
4842 data.references = st_init_numtable();
4843 init_mark_stack(&data.mark_stack);
4845 mfd.mark_func = allrefs_roots_i;
4849 PUSH_MARK_FUNC_DATA(&mfd);
4850 GET_VM()->gc.mark_func_data = &mfd;
4851 mark_roots(
objspace, &data.category);
4852 POP_MARK_FUNC_DATA();
4855 while (pop_mark_stack(&data.mark_stack, &obj)) {
4856 rb_objspace_reachable_objects_from(data.root_obj = obj, allrefs_i, &data);
4858 free_stack_chunks(&data.mark_stack);
4860 dont_gc_set(prev_dont_gc);
4861 return data.references;
4865objspace_allrefs_destruct_i(st_data_t key, st_data_t value, st_data_t ptr)
4867 struct reflist *refs = (
struct reflist *)value;
4868 reflist_destruct(refs);
4873objspace_allrefs_destruct(
struct st_table *refs)
4875 st_foreach(refs, objspace_allrefs_destruct_i, 0);
4876 st_free_table(refs);
4879#if RGENGC_CHECK_MODE >= 5
4881allrefs_dump_i(st_data_t k, st_data_t v, st_data_t ptr)
4884 struct reflist *refs = (
struct reflist *)v;
4885 fprintf(stderr,
"[allrefs_dump_i] %s <- ", rb_obj_info(obj));
4887 fprintf(stderr,
"\n");
4895 fprintf(stderr,
"[all refs] (size: %"PRIuVALUE
")\n", size);
4896 st_foreach(
objspace->rgengc.allrefs_table, allrefs_dump_i, 0);
4901gc_check_after_marks_i(st_data_t k, st_data_t v, st_data_t ptr)
4904 struct reflist *refs = (
struct reflist *)v;
4908 if (!RVALUE_MARKED(
objspace, obj)) {
4909 fprintf(stderr,
"gc_check_after_marks_i: %s is not marked and not oldgen.\n", rb_obj_info(obj));
4910 fprintf(stderr,
"gc_check_after_marks_i: %p is referred from ", (
void *)obj);
4913 if (reflist_referred_from_machine_context(refs)) {
4914 fprintf(stderr,
" (marked from machine stack).\n");
4919 fprintf(stderr,
"\n");
4926gc_marks_check(
rb_objspace_t *
objspace, st_foreach_callback_func *checker_func,
const char *checker_name)
4928 size_t saved_malloc_increase =
objspace->malloc_params.increase;
4929#if RGENGC_ESTIMATE_OLDMALLOC
4930 size_t saved_oldmalloc_increase =
objspace->malloc_counters.oldmalloc_increase;
4937 st_foreach(
objspace->rgengc.allrefs_table, checker_func, (st_data_t)
objspace);
4940 if (
objspace->rgengc.error_count > 0) {
4941#if RGENGC_CHECK_MODE >= 5
4944 if (checker_name) rb_bug(
"%s: GC has problem.", checker_name);
4947 objspace_allrefs_destruct(
objspace->rgengc.allrefs_table);
4948 objspace->rgengc.allrefs_table = 0;
4951 objspace->malloc_params.increase = saved_malloc_increase;
4952#if RGENGC_ESTIMATE_OLDMALLOC
4953 objspace->malloc_counters.oldmalloc_increase = saved_oldmalloc_increase;
4961 size_t live_object_count;
4962 size_t zombie_object_count;
4965 size_t old_object_count;
4966 size_t remembered_shady_count;
4970check_generation_i(
const VALUE child,
void *ptr)
4973 const VALUE parent = data->parent;
4975 if (RGENGC_CHECK_MODE) GC_ASSERT(RVALUE_OLD_P(data->objspace, parent));
4977 if (!RVALUE_OLD_P(data->objspace, child)) {
4978 if (!RVALUE_REMEMBERED(data->objspace, parent) &&
4979 !RVALUE_REMEMBERED(data->objspace, child) &&
4980 !RVALUE_UNCOLLECTIBLE(data->objspace, child)) {
4981 fprintf(stderr,
"verify_internal_consistency_reachable_i: WB miss (O->Y) %s -> %s\n", rb_obj_info(parent), rb_obj_info(child));
4988check_color_i(
const VALUE child,
void *ptr)
4991 const VALUE parent = data->parent;
4993 if (!RVALUE_WB_UNPROTECTED(data->objspace, parent) && RVALUE_WHITE_P(data->objspace, child)) {
4994 fprintf(stderr,
"verify_internal_consistency_reachable_i: WB miss (B->W) - %s -> %s\n",
4995 rb_obj_info(parent), rb_obj_info(child));
5001check_children_i(
const VALUE child,
void *ptr)
5004 if (check_rvalue_consistency_force(data->objspace, child, FALSE) != 0) {
5005 fprintf(stderr,
"check_children_i: %s has error (referenced from %s)",
5006 rb_obj_info(child), rb_obj_info(data->parent));
5013verify_internal_consistency_i(
void *page_start,
void *page_end,
size_t stride,
5019 for (obj = (
VALUE)page_start; obj != (
VALUE)page_end; obj += stride) {
5020 asan_unpoisoning_object(obj) {
5021 if (!rb_gc_impl_garbage_object_p(
objspace, obj)) {
5023 data->live_object_count++;
5028 if (!gc_object_moved_p(
objspace, obj)) {
5030 rb_objspace_reachable_objects_from(obj, check_children_i, (
void *)data);
5034 if (RVALUE_OLD_P(
objspace, obj)) data->old_object_count++;
5035 if (RVALUE_WB_UNPROTECTED(
objspace, obj) && RVALUE_UNCOLLECTIBLE(
objspace, obj)) data->remembered_shady_count++;
5040 rb_objspace_reachable_objects_from(obj, check_generation_i, (
void *)data);
5043 if (!is_marking(
objspace) && rb_gc_obj_shareable_p(obj)) {
5044 rb_gc_verify_shareable(obj);
5047 if (is_incremental_marking(
objspace)) {
5048 if (RVALUE_BLACK_P(
objspace, obj)) {
5051 rb_objspace_reachable_objects_from(obj, check_color_i, (
void *)data);
5057 data->zombie_object_count++;
5060 fprintf(stderr,
"verify_internal_consistency_i: T_ZOMBIE has extra flags set: %s\n",
5066 fprintf(stderr,
"verify_internal_consistency_i: FL_FINALIZE %s but %s finalizer_table: %s\n",
5067 FL_TEST(obj,
FL_FINALIZE) ?
"set" :
"not set", st_is_member(finalizer_table, obj) ?
"in" :
"not in",
5082 unsigned int has_remembered_shady = FALSE;
5083 unsigned int has_remembered_old = FALSE;
5084 int remembered_old_objects = 0;
5085 int free_objects = 0;
5086 int zombie_objects = 0;
5088 short slot_size = page->slot_size;
5089 uintptr_t start = (uintptr_t)page->start;
5090 uintptr_t end = start + page->total_slots * slot_size;
5092 for (uintptr_t ptr = start; ptr < end; ptr += slot_size) {
5094 asan_unpoisoning_object(val) {
5099 if (RVALUE_PAGE_UNCOLLECTIBLE(page, val) && RVALUE_PAGE_WB_UNPROTECTED(page, val)) {
5100 has_remembered_shady = TRUE;
5102 if (RVALUE_PAGE_MARKING(page, val)) {
5103 has_remembered_old = TRUE;
5104 remembered_old_objects++;
5109 if (!is_incremental_marking(
objspace) &&
5110 page->flags.has_remembered_objects == FALSE && has_remembered_old == TRUE) {
5112 for (uintptr_t ptr = start; ptr < end; ptr += slot_size) {
5114 if (RVALUE_PAGE_MARKING(page, val)) {
5115 fprintf(stderr,
"marking -> %s\n", rb_obj_info(val));
5118 rb_bug(
"page %p's has_remembered_objects should be false, but there are remembered old objects (%d). %s",
5119 (
void *)page, remembered_old_objects, obj ? rb_obj_info(obj) :
"");
5122 if (page->flags.has_uncollectible_wb_unprotected_objects == FALSE && has_remembered_shady == TRUE) {
5123 rb_bug(
"page %p's has_remembered_shady should be false, but there are remembered shady objects. %s",
5124 (
void *)page, obj ? rb_obj_info(obj) :
"");
5129 if (page->free_slots != free_objects) {
5130 rb_bug(
"page %p's free_slots should be %d, but %d", (
void *)page, page->free_slots, free_objects);
5133 if (page->final_slots != zombie_objects) {
5134 rb_bug(
"page %p's final_slots should be %d, but %d", (
void *)page, page->final_slots, zombie_objects);
5137 return remembered_old_objects;
5143 int remembered_old_objects = 0;
5146 ccan_list_for_each(head, page, page_node) {
5147 asan_unlock_freelist(page);
5152 rb_asan_unpoison_object(vp,
false);
5154 fprintf(stderr,
"freelist slot expected to be T_NONE but was: %s\n", rb_obj_info(vp));
5157 rb_asan_poison_object(prev);
5159 asan_lock_freelist(page);
5161 if (page->flags.has_remembered_objects == FALSE) {
5162 remembered_old_objects += gc_verify_heap_page(
objspace, page,
Qfalse);
5166 return remembered_old_objects;
5172 int remembered_old_objects = 0;
5173 for (
int i = 0; i < HEAP_COUNT; i++) {
5174 remembered_old_objects += gc_verify_heap_pages_(
objspace, &((&heaps[i])->pages));
5176 return remembered_old_objects;
5185 gc_report(5,
objspace,
"gc_verify_internal_consistency: start\n");
5188 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
5190 short slot_size = page->slot_size;
5192 uintptr_t start = (uintptr_t)page->start;
5193 uintptr_t end = start + page->total_slots * slot_size;
5195 verify_internal_consistency_i((
void *)start, (
void *)end, slot_size, &data);
5198 if (data.err_count != 0) {
5199#if RGENGC_CHECK_MODE >= 5
5200 objspace->rgengc.error_count = data.err_count;
5201 gc_marks_check(
objspace, NULL, NULL);
5204 rb_bug(
"gc_verify_internal_consistency: found internal inconsistency.");
5212 ractor_cache_flush_count(
objspace, rb_gc_get_ractor_newobj_cache());
5216 !rb_gc_multi_ractor_p()) {
5217 if (objspace_live_slots(
objspace) != data.live_object_count) {
5218 fprintf(stderr,
"heap_pages_final_slots: %"PRIdSIZE
", total_freed_objects: %"PRIdSIZE
"\n",
5220 rb_bug(
"inconsistent live slot number: expect %"PRIuSIZE
", but %"PRIuSIZE
".",
5221 objspace_live_slots(
objspace), data.live_object_count);
5226 if (
objspace->rgengc.old_objects != data.old_object_count) {
5227 rb_bug(
"inconsistent old slot number: expect %"PRIuSIZE
", but %"PRIuSIZE
".",
5228 objspace->rgengc.old_objects, data.old_object_count);
5230 if (
objspace->rgengc.uncollectible_wb_unprotected_objects != data.remembered_shady_count) {
5231 rb_bug(
"inconsistent number of wb unprotected objects: expect %"PRIuSIZE
", but %"PRIuSIZE
".",
5232 objspace->rgengc.uncollectible_wb_unprotected_objects, data.remembered_shady_count);
5237 size_t list_count = 0;
5240 VALUE z = heap_pages_deferred_final;
5243 z = RZOMBIE(z)->next;
5247 if (total_final_slots_count(
objspace) != data.zombie_object_count ||
5248 total_final_slots_count(
objspace) != list_count) {
5250 rb_bug(
"inconsistent finalizing object count:\n"
5251 " expect %"PRIuSIZE
"\n"
5252 " but %"PRIuSIZE
" zombies\n"
5253 " heap_pages_deferred_final list has %"PRIuSIZE
" items.",
5255 data.zombie_object_count,
5260 gc_report(5,
objspace,
"gc_verify_internal_consistency: OK\n");
5264gc_verify_internal_consistency(
void *objspace_ptr)
5268 unsigned int lev = RB_GC_VM_LOCK();
5272 unsigned int prev_during_gc = during_gc;
5275 gc_verify_internal_consistency_(
objspace);
5277 during_gc = prev_during_gc;
5279 RB_GC_VM_UNLOCK(lev);
5283heap_move_pooled_pages_to_free_pages(
rb_heap_t *heap)
5285 if (heap->pooled_pages) {
5286 if (heap->free_pages) {
5287 struct heap_page *free_pages_tail = heap->free_pages;
5288 while (free_pages_tail->free_next) {
5289 free_pages_tail = free_pages_tail->free_next;
5291 free_pages_tail->free_next = heap->pooled_pages;
5294 heap->free_pages = heap->pooled_pages;
5297 heap->pooled_pages = NULL;
5304 struct heap_page *page = GET_HEAP_PAGE(obj);
5305 bits_t *uncollectible_bits = &page->uncollectible_bits[0];
5307 if (!MARKED_IN_BITMAP(uncollectible_bits, obj)) {
5308 page->flags.has_uncollectible_wb_unprotected_objects = TRUE;
5309 MARK_IN_BITMAP(uncollectible_bits, obj);
5310 objspace->rgengc.uncollectible_wb_unprotected_objects++;
5312#if RGENGC_PROFILE > 0
5313 objspace->profile.total_remembered_shady_object_count++;
5314#if RGENGC_PROFILE >= 2
5331 gc_report(2,
objspace,
"gc_marks_wb_unprotected_objects: marked shady: %s\n", rb_obj_info((
VALUE)p));
5336 p += BASE_SLOT_SIZE;
5347 ccan_list_for_each(&heap->pages, page, page_node) {
5348 bits_t *mark_bits = page->mark_bits;
5349 bits_t *wbun_bits = page->wb_unprotected_bits;
5350 uintptr_t p = page->start;
5353 bits_t bits = mark_bits[0] & wbun_bits[0];
5354 bits >>= NUM_IN_PAGE(p);
5355 gc_marks_wb_unprotected_objects_plane(
objspace, p, bits);
5356 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
5358 for (j=1; j<HEAP_PAGE_BITMAP_LIMIT; j++) {
5359 bits_t bits = mark_bits[j] & wbun_bits[j];
5361 gc_marks_wb_unprotected_objects_plane(
objspace, p, bits);
5362 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
5366 gc_mark_stacked_objects_all(
objspace);
5372 size_t retained_weak_references_count = 0;
5374 rb_darray_foreach(
objspace->weak_references, i, ptr_ptr) {
5375 if (!*ptr_ptr)
continue;
5377 VALUE obj = **ptr_ptr;
5381 if (!RVALUE_MARKED(
objspace, obj)) {
5385 retained_weak_references_count++;
5389 objspace->profile.retained_weak_references_count = retained_weak_references_count;
5391 rb_darray_clear(
objspace->weak_references);
5392 rb_darray_resize_capa_without_gc(&
objspace->weak_references, retained_weak_references_count);
5399 if (is_incremental_marking(
objspace)) {
5400 if (RGENGC_CHECK_MODE && is_mark_stack_empty(&
objspace->mark_stack) == 0) {
5401 rb_bug(
"gc_marks_finish: mark stack is not empty (%"PRIdSIZE
").",
5402 mark_stack_size(&
objspace->mark_stack));
5406 while (gc_mark_stacked_objects_incremental(
objspace, INT_MAX) ==
false);
5408#if RGENGC_CHECK_MODE >= 2
5409 if (gc_verify_heap_pages(
objspace) != 0) {
5410 rb_bug(
"gc_marks_finish (incremental): there are remembered old objects.");
5414 objspace->flags.during_incremental_marking = FALSE;
5416 for (
int i = 0; i < HEAP_COUNT; i++) {
5417 gc_marks_wb_unprotected_objects(
objspace, &heaps[i]);
5421 gc_update_weak_references(
objspace);
5423#if RGENGC_CHECK_MODE >= 2
5424 gc_verify_internal_consistency(
objspace);
5427#if RGENGC_CHECK_MODE >= 4
5429 gc_marks_check(
objspace, gc_check_after_marks_i,
"after_marks");
5434 const unsigned long r_mul =
objspace->live_ractor_cache_count > 8 ? 8 :
objspace->live_ractor_cache_count;
5436 size_t total_slots = objspace_available_slots(
objspace);
5437 size_t sweep_slots = total_slots -
objspace->marked_slots;
5438 size_t max_free_slots = (size_t)(total_slots * gc_params.heap_free_slots_max_ratio);
5439 size_t min_free_slots = (size_t)(total_slots * gc_params.heap_free_slots_min_ratio);
5440 if (min_free_slots < gc_params.heap_free_slots * r_mul) {
5441 min_free_slots = gc_params.heap_free_slots * r_mul;
5444 int full_marking = is_full_marking(
objspace);
5449 size_t total_init_slots = 0;
5450 for (
int i = 0; i < HEAP_COUNT; i++) {
5451 total_init_slots += gc_params.heap_init_slots[i] * r_mul;
5454 if (max_free_slots < total_init_slots) {
5455 max_free_slots = total_init_slots;
5458 if (sweep_slots > max_free_slots) {
5459 heap_pages_freeable_pages = (sweep_slots - max_free_slots) / HEAP_PAGE_OBJ_LIMIT;
5462 heap_pages_freeable_pages = 0;
5465 if (
objspace->heap_pages.allocatable_slots == 0 && sweep_slots < min_free_slots) {
5466 if (!full_marking) {
5467 if (
objspace->profile.count -
objspace->rgengc.last_major_gc < RVALUE_OLD_AGE) {
5468 full_marking = TRUE;
5471 gc_report(1,
objspace,
"gc_marks_finish: next is full GC!!)\n");
5472 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_NOFREE;
5477 heap_allocatable_slots_expand(
objspace, NULL, sweep_slots, total_slots);
5483 const double r = gc_params.oldobject_limit_factor;
5484 objspace->rgengc.uncollectible_wb_unprotected_objects_limit = MAX(
5485 (
size_t)(
objspace->rgengc.uncollectible_wb_unprotected_objects * r),
5486 (
size_t)(
objspace->rgengc.old_objects * gc_params.uncollectible_wb_unprotected_objects_limit_ratio)
5488 objspace->rgengc.old_objects_limit = (size_t)(
objspace->rgengc.old_objects * r);
5491 if (
objspace->rgengc.uncollectible_wb_unprotected_objects >
objspace->rgengc.uncollectible_wb_unprotected_objects_limit) {
5492 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_SHADY;
5495 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_OLDGEN;
5498 gc_report(1,
objspace,
"gc_marks_finish (marks %"PRIdSIZE
" objects, "
5499 "old %"PRIdSIZE
" objects, total %"PRIdSIZE
" slots, "
5500 "sweep %"PRIdSIZE
" slots, allocatable %"PRIdSIZE
" slots, next GC: %s)\n",
5502 gc_needs_major_flags ?
"major" :
"minor");
5506 rb_ractor_finish_marking();
5512gc_compact_heap_cursors_met_p(
rb_heap_t *heap)
5514 return heap->sweeping_page == heap->compact_cursor;
5521 size_t obj_size = rb_gc_obj_optimal_size(obj);
5522 if (obj_size == 0) {
5526 GC_ASSERT(rb_gc_impl_size_allocatable_p(obj_size));
5528 size_t idx = heap_idx_for_size(obj_size);
5537 GC_ASSERT(gc_is_moveable_obj(
objspace, src));
5540 uint32_t orig_shape = 0;
5541 uint32_t new_shape = 0;
5543 if (gc_compact_heap_cursors_met_p(dest_pool)) {
5544 return dest_pool != heap;
5548 orig_shape = rb_gc_get_shape(src);
5550 if (dest_pool != heap) {
5551 new_shape = rb_gc_rebuild_shape(src, dest_pool - heaps);
5553 if (new_shape == 0) {
5559 while (!try_move(
objspace, dest_pool, dest_pool->free_pages, src)) {
5561 .page = dest_pool->sweeping_page,
5570 lock_page_body(
objspace, GET_PAGE_BODY(src));
5571 gc_sweep_page(
objspace, dest_pool, &ctx);
5572 unlock_page_body(
objspace, GET_PAGE_BODY(src));
5574 if (dest_pool->sweeping_page->free_slots > 0) {
5575 heap_add_freepage(dest_pool, dest_pool->sweeping_page);
5578 dest_pool->sweeping_page = ccan_list_next(&dest_pool->pages, dest_pool->sweeping_page, page_node);
5579 if (gc_compact_heap_cursors_met_p(dest_pool)) {
5580 return dest_pool != heap;
5584 if (orig_shape != 0) {
5585 if (new_shape != 0) {
5587 rb_gc_set_shape(dest, new_shape);
5589 RMOVED(src)->original_shape_id = orig_shape;
5598 short slot_size = page->slot_size;
5599 short slot_bits = slot_size / BASE_SLOT_SIZE;
5600 GC_ASSERT(slot_bits > 0);
5604 GC_ASSERT(vp % BASE_SLOT_SIZE == 0);
5609 if (gc_is_moveable_obj(
objspace, vp)) {
5610 if (!gc_compact_move(
objspace, heap, vp)) {
5617 bitset >>= slot_bits;
5627 GC_ASSERT(page == heap->compact_cursor);
5629 bits_t *mark_bits, *pin_bits;
5631 uintptr_t p = page->start;
5633 mark_bits = page->mark_bits;
5634 pin_bits = page->pinned_bits;
5637 bitset = (mark_bits[0] & ~pin_bits[0]);
5638 bitset >>= NUM_IN_PAGE(p);
5640 if (!gc_compact_plane(
objspace, heap, (uintptr_t)p, bitset, page))
5643 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
5645 for (
int j = 1; j < HEAP_PAGE_BITMAP_LIMIT; j++) {
5646 bitset = (mark_bits[j] & ~pin_bits[j]);
5648 if (!gc_compact_plane(
objspace, heap, (uintptr_t)p, bitset, page))
5651 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
5660 for (
int i = 0; i < HEAP_COUNT; i++) {
5663 if (heap->total_pages > 0 &&
5664 !gc_compact_heap_cursors_met_p(heap)) {
5676#if RGENGC_CHECK_MODE >= 2
5677 gc_verify_internal_consistency(
objspace);
5680 while (!gc_compact_all_compacted_p(
objspace)) {
5681 for (
int i = 0; i < HEAP_COUNT; i++) {
5684 if (gc_compact_heap_cursors_met_p(heap)) {
5688 struct heap_page *start_page = heap->compact_cursor;
5690 if (!gc_compact_page(
objspace, heap, start_page)) {
5691 lock_page_body(
objspace, start_page->body);
5698 lock_page_body(
objspace, start_page->body);
5699 heap->compact_cursor = ccan_list_prev(&heap->pages, heap->compact_cursor, page_node);
5705#if RGENGC_CHECK_MODE >= 2
5706 gc_verify_internal_consistency(
objspace);
5713 gc_report(1,
objspace,
"gc_marks_rest\n");
5715 for (
int i = 0; i < HEAP_COUNT; i++) {
5716 (&heaps[i])->pooled_pages = NULL;
5719 if (is_incremental_marking(
objspace)) {
5720 while (gc_mark_stacked_objects_incremental(
objspace, INT_MAX) == FALSE);
5723 gc_mark_stacked_objects_all(
objspace);
5732 bool marking_finished =
false;
5735 if (gc_mark_stacked_objects_incremental(
objspace, slots)) {
5738 marking_finished =
true;
5741 return marking_finished;
5747 GC_ASSERT(dont_gc_val() == FALSE ||
objspace->profile.latest_gc_info & GPR_FLAG_METHOD);
5748 bool marking_finished =
true;
5752 if (heap->free_pages) {
5753 gc_report(2,
objspace,
"gc_marks_continue: has pooled pages");
5758 gc_report(2,
objspace,
"gc_marks_continue: no more pooled pages (stack depth: %"PRIdSIZE
").\n",
5759 mark_stack_size(&
objspace->mark_stack));
5760 heap->force_incremental_marking_finish_count++;
5766 return marking_finished;
5773 gc_report(1,
objspace,
"gc_marks_start: (%s)\n", full_mark ?
"full" :
"minor");
5774 gc_mode_transition(
objspace, gc_mode_marking);
5777 size_t incremental_marking_steps = (
objspace->rincgc.pooled_slots / INCREMENTAL_MARK_STEP_ALLOCATIONS) + 1;
5778 objspace->rincgc.step_slots = (
objspace->marked_slots * 2) / incremental_marking_steps;
5780 if (0) fprintf(stderr,
"objspace->marked_slots: %"PRIdSIZE
", "
5781 "objspace->rincgc.pooled_page_num: %"PRIdSIZE
", "
5782 "objspace->rincgc.step_slots: %"PRIdSIZE
", \n",
5784 objspace->flags.during_minor_gc = FALSE;
5785 if (ruby_enable_autocompact) {
5786 objspace->flags.during_compacting |= TRUE;
5788 objspace->profile.major_gc_count++;
5789 objspace->rgengc.uncollectible_wb_unprotected_objects = 0;
5794 for (
int i = 0; i < HEAP_COUNT; i++) {
5796 rgengc_mark_and_rememberset_clear(
objspace, heap);
5797 heap_move_pooled_pages_to_free_pages(heap);
5799 if (
objspace->flags.during_compacting) {
5802 ccan_list_for_each(&heap->pages, page, page_node) {
5803 page->pinned_slots = 0;
5809 objspace->flags.during_minor_gc = TRUE;
5811 objspace->rgengc.old_objects +
objspace->rgengc.uncollectible_wb_unprotected_objects;
5812 objspace->profile.minor_gc_count++;
5814 for (
int i = 0; i < HEAP_COUNT; i++) {
5815 rgengc_rememberset_mark(
objspace, &heaps[i]);
5821 gc_report(1,
objspace,
"gc_marks_start: (%s) end, stack in %"PRIdSIZE
"\n",
5828 gc_prof_mark_timer_start(
objspace);
5831 bool marking_finished =
false;
5835 gc_marks_start(
objspace, full_mark);
5836 if (!is_incremental_marking(
objspace)) {
5838 marking_finished =
true;
5841#if RGENGC_PROFILE > 0
5844 record->old_objects =
objspace->rgengc.old_objects;
5851 return marking_finished;
5859 if (level <= RGENGC_DEBUG) {
5863 const char *status =
" ";
5866 status = is_full_marking(
objspace) ?
"+" :
"-";
5872 if (is_incremental_marking(
objspace)) {
5877 va_start(args, fmt);
5878 vsnprintf(buf, 1024, fmt, args);
5881 fprintf(out,
"%s|", status);
5891 struct heap_page *page = GET_HEAP_PAGE(obj);
5892 bits_t *bits = &page->remembered_bits[0];
5894 if (MARKED_IN_BITMAP(bits, obj)) {
5898 page->flags.has_remembered_objects = TRUE;
5899 MARK_IN_BITMAP(bits, obj);
5910 gc_report(6,
objspace,
"rgengc_remember: %s %s\n", rb_obj_info(obj),
5911 RVALUE_REMEMBERED(
objspace, obj) ?
"was already remembered" :
"is remembered now");
5913 check_rvalue_consistency(
objspace, obj);
5915 if (RGENGC_CHECK_MODE) {
5916 if (RVALUE_WB_UNPROTECTED(
objspace, obj)) rb_bug(
"rgengc_remember: %s is not wb protected.", rb_obj_info(obj));
5919#if RGENGC_PROFILE > 0
5920 if (!RVALUE_REMEMBERED(
objspace, obj)) {
5921 if (RVALUE_WB_UNPROTECTED(
objspace, obj) == 0) {
5922 objspace->profile.total_remembered_normal_object_count++;
5923#if RGENGC_PROFILE >= 2
5930 return rgengc_remembersetbits_set(
objspace, obj);
5933#ifndef PROFILE_REMEMBERSET_MARK
5934#define PROFILE_REMEMBERSET_MARK 0
5944 gc_report(2,
objspace,
"rgengc_rememberset_mark: mark %s\n", rb_obj_info(obj));
5945 GC_ASSERT(RVALUE_UNCOLLECTIBLE(
objspace, obj));
5946 GC_ASSERT(RVALUE_OLD_P(
objspace, obj) || RVALUE_WB_UNPROTECTED(
objspace, obj));
5950 p += BASE_SLOT_SIZE;
5961#if PROFILE_REMEMBERSET_MARK
5962 int has_old = 0, has_shady = 0, has_both = 0, skip = 0;
5964 gc_report(1,
objspace,
"rgengc_rememberset_mark: start\n");
5966 ccan_list_for_each(&heap->pages, page, page_node) {
5967 if (page->flags.has_remembered_objects | page->flags.has_uncollectible_wb_unprotected_objects) {
5968 uintptr_t p = page->start;
5969 bits_t bitset, bits[HEAP_PAGE_BITMAP_LIMIT];
5970 bits_t *remembered_bits = page->remembered_bits;
5971 bits_t *uncollectible_bits = page->uncollectible_bits;
5972 bits_t *wb_unprotected_bits = page->wb_unprotected_bits;
5973#if PROFILE_REMEMBERSET_MARK
5974 if (page->flags.has_remembered_objects && page->flags.has_uncollectible_wb_unprotected_objects) has_both++;
5975 else if (page->flags.has_remembered_objects) has_old++;
5976 else if (page->flags.has_uncollectible_wb_unprotected_objects) has_shady++;
5978 for (j=0; j<HEAP_PAGE_BITMAP_LIMIT; j++) {
5979 bits[j] = remembered_bits[j] | (uncollectible_bits[j] & wb_unprotected_bits[j]);
5980 remembered_bits[j] = 0;
5982 page->flags.has_remembered_objects = FALSE;
5985 bitset >>= NUM_IN_PAGE(p);
5986 rgengc_rememberset_mark_plane(
objspace, p, bitset);
5987 p += (BITS_BITLENGTH - NUM_IN_PAGE(p)) * BASE_SLOT_SIZE;
5989 for (j=1; j < HEAP_PAGE_BITMAP_LIMIT; j++) {
5991 rgengc_rememberset_mark_plane(
objspace, p, bitset);
5992 p += BITS_BITLENGTH * BASE_SLOT_SIZE;
5995#if PROFILE_REMEMBERSET_MARK
6002#if PROFILE_REMEMBERSET_MARK
6003 fprintf(stderr,
"%d\t%d\t%d\t%d\n", has_both, has_old, has_shady, skip);
6005 gc_report(1,
objspace,
"rgengc_rememberset_mark: finished\n");
6013 ccan_list_for_each(&heap->pages, page, page_node) {
6014 memset(&page->mark_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6015 memset(&page->uncollectible_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6016 memset(&page->marking_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6017 memset(&page->remembered_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6018 memset(&page->pinned_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6019 page->flags.has_uncollectible_wb_unprotected_objects = FALSE;
6020 page->flags.has_remembered_objects = FALSE;
6031 if (RGENGC_CHECK_MODE) {
6032 if (!RVALUE_OLD_P(
objspace, a)) rb_bug(
"gc_writebarrier_generational: %s is not an old object.", rb_obj_info(a));
6033 if ( RVALUE_OLD_P(
objspace, b)) rb_bug(
"gc_writebarrier_generational: %s is an old object.", rb_obj_info(b));
6034 if (is_incremental_marking(
objspace)) rb_bug(
"gc_writebarrier_generational: called while incremental marking: %s -> %s", rb_obj_info(a), rb_obj_info(b));
6038 if (!RVALUE_REMEMBERED(
objspace, a)) {
6039 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6043 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6045 gc_report(1,
objspace,
"gc_writebarrier_generational: %s (remembered) -> %s\n", rb_obj_info(a), rb_obj_info(b));
6048 check_rvalue_consistency(
objspace, a);
6049 check_rvalue_consistency(
objspace, b);
6055 gc_mark_set_parent(
objspace, parent);
6056 rgengc_check_relation(
objspace, obj);
6057 if (gc_mark_set(
objspace, obj) != FALSE) {
6061 gc_mark_set_parent_invalid(
objspace);
6069 gc_report(2,
objspace,
"gc_writebarrier_incremental: [LG] %p -> %s\n", (
void *)a, rb_obj_info(b));
6073 if (!RVALUE_WB_UNPROTECTED(
objspace, a)) {
6074 gc_report(2,
objspace,
"gc_writebarrier_incremental: [IN] %p -> %s\n", (
void *)a, rb_obj_info(b));
6082 if (RB_UNLIKELY(
objspace->flags.during_compacting)) {
6083 MARK_IN_BITMAP(GET_HEAP_PINNED_BITS(b), b);
6089rb_gc_impl_writebarrier(
void *objspace_ptr,
VALUE a,
VALUE b)
6093 if (RGENGC_CHECK_MODE) {
6094 if (
SPECIAL_CONST_P(a)) rb_bug(
"rb_gc_writebarrier: a is special const: %"PRIxVALUE, a);
6099 GC_ASSERT(!during_gc);
6108 if (!is_incremental_marking(
objspace)) {
6113 gc_writebarrier_generational(a, b,
objspace);
6119 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6121 if (is_incremental_marking(
objspace)) {
6122 gc_writebarrier_incremental(a, b,
objspace);
6128 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6130 if (retry)
goto retry;
6136rb_gc_impl_writebarrier_unprotect(
void *objspace_ptr,
VALUE obj)
6140 if (RVALUE_WB_UNPROTECTED(
objspace, obj)) {
6144 gc_report(2,
objspace,
"rb_gc_writebarrier_unprotect: %s %s\n", rb_obj_info(obj),
6145 RVALUE_REMEMBERED(
objspace, obj) ?
" (already remembered)" :
"");
6147 unsigned int lev = RB_GC_VM_LOCK_NO_BARRIER();
6150 gc_report(1,
objspace,
"rb_gc_writebarrier_unprotect: %s\n", rb_obj_info(obj));
6153 gc_remember_unprotected(
objspace, obj);
6156 objspace->profile.total_shade_operation_count++;
6157#if RGENGC_PROFILE >= 2
6163 RVALUE_AGE_RESET(obj);
6166 RB_DEBUG_COUNTER_INC(obj_wb_unprotect);
6167 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), obj);
6169 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6174rb_gc_impl_copy_attributes(
void *objspace_ptr,
VALUE dest,
VALUE obj)
6178 if (RVALUE_WB_UNPROTECTED(
objspace, obj)) {
6179 rb_gc_impl_writebarrier_unprotect(
objspace, dest);
6181 rb_gc_impl_copy_finalizer(
objspace, dest, obj);
6185rb_gc_impl_active_gc_name(
void)
6191rb_gc_impl_writebarrier_remember(
void *objspace_ptr,
VALUE obj)
6195 gc_report(1,
objspace,
"rb_gc_writebarrier_remember: %s\n", rb_obj_info(obj));
6198 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6200 if (is_incremental_marking(
objspace)) {
6201 if (RVALUE_BLACK_P(
objspace, obj)) {
6205 else if (RVALUE_OLD_P(
objspace, obj)) {
6209 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6215 ID ID_wb_protected, ID_age, ID_old, ID_uncollectible, ID_marking,
6216 ID_marked, ID_pinned, ID_remembered, ID_object_id, ID_shareable;
6219#define RB_GC_OBJECT_METADATA_ENTRY_COUNT (sizeof(struct rb_gc_object_metadata_names) / sizeof(ID))
6223rb_gc_impl_object_metadata(
void *objspace_ptr,
VALUE obj)
6229 if (!names.ID_marked) {
6230#define I(s) names.ID_##s = rb_intern(#s)
6244#define SET_ENTRY(na, v) do { \
6245 GC_ASSERT(n <= RB_GC_OBJECT_METADATA_ENTRY_COUNT); \
6246 object_metadata_entries[n].name = names.ID_##na; \
6247 object_metadata_entries[n].val = v; \
6251 if (!RVALUE_WB_UNPROTECTED(
objspace, obj)) SET_ENTRY(wb_protected,
Qtrue);
6252 SET_ENTRY(age,
INT2FIX(RVALUE_AGE_GET(obj)));
6254 if (RVALUE_UNCOLLECTIBLE(
objspace, obj)) SET_ENTRY(uncollectible,
Qtrue);
6255 if (RVALUE_MARKING(
objspace, obj)) SET_ENTRY(marking,
Qtrue);
6258 if (RVALUE_REMEMBERED(
objspace, obj)) SET_ENTRY(remembered,
Qtrue);
6259 if (rb_obj_id_p(obj)) SET_ENTRY(object_id, rb_obj_id(obj));
6262 object_metadata_entries[n].name = 0;
6263 object_metadata_entries[n].val = 0;
6266 return object_metadata_entries;
6270rb_gc_impl_ractor_cache_alloc(
void *objspace_ptr,
void *ractor)
6274 objspace->live_ractor_cache_count++;
6280rb_gc_impl_ractor_cache_free(
void *objspace_ptr,
void *cache)
6284 objspace->live_ractor_cache_count--;
6285 gc_ractor_newobj_cache_clear(cache, NULL);
6292 if (!heap->free_pages) {
6293 if (!heap_page_allocate_and_initialize(
objspace, heap)) {
6294 objspace->heap_pages.allocatable_slots = 1;
6295 heap_page_allocate_and_initialize(
objspace, heap);
6303 if (dont_gc_val() || during_gc) {
6304 for (
int i = 0; i < HEAP_COUNT; i++) {
6321 size_t old_limit = malloc_limit;
6323 if (inc > malloc_limit) {
6324 malloc_limit = (size_t)(inc * gc_params.malloc_limit_growth_factor);
6325 if (malloc_limit > gc_params.malloc_limit_max) {
6326 malloc_limit = gc_params.malloc_limit_max;
6330 malloc_limit = (size_t)(malloc_limit * 0.98);
6331 if (malloc_limit < gc_params.malloc_limit_min) {
6332 malloc_limit = gc_params.malloc_limit_min;
6337 if (old_limit != malloc_limit) {
6338 fprintf(stderr,
"[%"PRIuSIZE
"] malloc_limit: %"PRIuSIZE
" -> %"PRIuSIZE
"\n",
6339 rb_gc_count(), old_limit, malloc_limit);
6342 fprintf(stderr,
"[%"PRIuSIZE
"] malloc_limit: not changed (%"PRIuSIZE
")\n",
6343 rb_gc_count(), malloc_limit);
6349#if RGENGC_ESTIMATE_OLDMALLOC
6351 if (
objspace->malloc_counters.oldmalloc_increase >
objspace->rgengc.oldmalloc_increase_limit) {
6352 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_OLDMALLOC;
6353 objspace->rgengc.oldmalloc_increase_limit =
6354 (size_t)(
objspace->rgengc.oldmalloc_increase_limit * gc_params.oldmalloc_limit_growth_factor);
6356 if (
objspace->rgengc.oldmalloc_increase_limit > gc_params.oldmalloc_limit_max) {
6357 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_max;
6361 if (0) fprintf(stderr,
"%"PRIdSIZE
"\t%d\t%"PRIuSIZE
"\t%"PRIuSIZE
"\t%"PRIdSIZE
"\n",
6363 gc_needs_major_flags,
6364 objspace->malloc_counters.oldmalloc_increase,
6365 objspace->rgengc.oldmalloc_increase_limit,
6366 gc_params.oldmalloc_limit_max);
6370 objspace->malloc_counters.oldmalloc_increase = 0;
6372 if ((
objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_BY_OLDMALLOC) == 0) {
6373 objspace->rgengc.oldmalloc_increase_limit =
6374 (size_t)(
objspace->rgengc.oldmalloc_increase_limit / ((gc_params.oldmalloc_limit_growth_factor - 1)/10 + 1));
6375 if (
objspace->rgengc.oldmalloc_increase_limit < gc_params.oldmalloc_limit_min) {
6376 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
6388 int lev = RB_GC_VM_LOCK();
6390#if GC_PROFILE_MORE_DETAIL
6391 objspace->profile.prepare_time = getrusage_time();
6396#if GC_PROFILE_MORE_DETAIL
6397 objspace->profile.prepare_time = getrusage_time() -
objspace->profile.prepare_time;
6402 RB_GC_VM_UNLOCK(lev);
6410 unsigned int do_full_mark = !!(reason & GPR_FLAG_FULL_MARK);
6412 if (!rb_darray_size(
objspace->heap_pages.sorted))
return TRUE;
6413 if (!(reason & GPR_FLAG_METHOD) && !ready_to_gc(
objspace))
return TRUE;
6415 GC_ASSERT(gc_mode(
objspace) == gc_mode_none,
"gc_mode is %s\n", gc_mode_name(gc_mode(
objspace)));
6416 GC_ASSERT(!is_lazy_sweeping(
objspace));
6417 GC_ASSERT(!is_incremental_marking(
objspace));
6419 unsigned int lock_lev;
6420 gc_enter(
objspace, gc_enter_event_start, &lock_lev);
6423 objspace->flags.immediate_sweep = !!(reason & GPR_FLAG_IMMEDIATE_SWEEP);
6425#if RGENGC_CHECK_MODE >= 2
6426 gc_verify_internal_consistency(
objspace);
6429 if (ruby_gc_stressful) {
6430 int flag =
FIXNUM_P(ruby_gc_stress_mode) ?
FIX2INT(ruby_gc_stress_mode) : 0;
6432 if ((flag & (1 << gc_stress_no_major)) == 0) {
6433 do_full_mark = TRUE;
6436 objspace->flags.immediate_sweep = !(flag & (1<<gc_stress_no_immediate_sweep));
6439 if (gc_needs_major_flags) {
6440 reason |= gc_needs_major_flags;
6441 do_full_mark = TRUE;
6445 if (!gc_config_full_mark_val) {
6446 do_full_mark = FALSE;
6448 gc_needs_major_flags = GPR_FLAG_NONE;
6450 if (do_full_mark && (reason & GPR_FLAG_MAJOR_MASK) == 0) {
6451 reason |= GPR_FLAG_MAJOR_BY_FORCE;
6454 if (
objspace->flags.dont_incremental ||
6455 reason & GPR_FLAG_IMMEDIATE_MARK ||
6456 ruby_gc_stressful) {
6457 objspace->flags.during_incremental_marking = FALSE;
6460 objspace->flags.during_incremental_marking = do_full_mark;
6464 if (do_full_mark && ruby_enable_autocompact) {
6465 objspace->flags.during_compacting = TRUE;
6466#if RGENGC_CHECK_MODE
6467 objspace->rcompactor.compare_func = ruby_autocompact_compare_func;
6471 objspace->flags.during_compacting = !!(reason & GPR_FLAG_COMPACT);
6474 if (!GC_ENABLE_LAZY_SWEEP ||
objspace->flags.dont_incremental) {
6475 objspace->flags.immediate_sweep = TRUE;
6478 if (
objspace->flags.immediate_sweep) reason |= GPR_FLAG_IMMEDIATE_SWEEP;
6480 gc_report(1,
objspace,
"gc_start(reason: %x) => %u, %d, %d\n",
6482 do_full_mark, !is_incremental_marking(
objspace),
objspace->flags.immediate_sweep);
6484 RB_DEBUG_COUNTER_INC(gc_count);
6486 if (reason & GPR_FLAG_MAJOR_MASK) {
6487 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_nofree, reason & GPR_FLAG_MAJOR_BY_NOFREE);
6488 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_oldgen, reason & GPR_FLAG_MAJOR_BY_OLDGEN);
6489 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_shady, reason & GPR_FLAG_MAJOR_BY_SHADY);
6490 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_force, reason & GPR_FLAG_MAJOR_BY_FORCE);
6491#if RGENGC_ESTIMATE_OLDMALLOC
6492 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_oldmalloc, reason & GPR_FLAG_MAJOR_BY_OLDMALLOC);
6496 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_newobj, reason & GPR_FLAG_NEWOBJ);
6497 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_malloc, reason & GPR_FLAG_MALLOC);
6498 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_method, reason & GPR_FLAG_METHOD);
6499 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_capi, reason & GPR_FLAG_CAPI);
6500 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_stress, reason & GPR_FLAG_STRESS);
6504 objspace->profile.latest_gc_info = reason;
6505 objspace->profile.total_allocated_objects_at_gc_start = total_allocated_objects(
objspace);
6506 objspace->profile.heap_used_at_gc_start = rb_darray_size(
objspace->heap_pages.sorted);
6507 objspace->profile.weak_references_count = 0;
6508 objspace->profile.retained_weak_references_count = 0;
6509 gc_prof_setup_new_record(
objspace, reason);
6510 gc_reset_malloc_info(
objspace, do_full_mark);
6514 GC_ASSERT(during_gc);
6518 if (gc_marks(
objspace, do_full_mark)) {
6524 gc_exit(
objspace, gc_enter_event_start, &lock_lev);
6532 unsigned int lock_lev;
6533 gc_enter(
objspace, gc_enter_event_rest, &lock_lev);
6535 if (RGENGC_CHECK_MODE >= 2) gc_verify_internal_consistency(
objspace);
6537 if (is_incremental_marking(
objspace)) {
6551 gc_exit(
objspace, gc_enter_event_rest, &lock_lev);
6557 unsigned int reason;
6566 if (is_full_marking(
objspace)) buff[i++] =
'F';
6567 if (is_incremental_marking(
objspace)) buff[i++] =
'I';
6571 if (is_lazy_sweeping(
objspace)) buff[i++] =
'L';
6582 static char buff[0x10];
6583 gc_current_status_fill(
objspace, buff);
6587#if PRINT_ENTER_EXIT_TICK
6589static tick_t last_exit_tick;
6590static tick_t enter_tick;
6591static int enter_count = 0;
6592static char last_gc_status[0x10];
6597 if (direction == 0) {
6599 enter_tick = tick();
6600 gc_current_status_fill(
objspace, last_gc_status);
6603 tick_t exit_tick = tick();
6604 char current_gc_status[0x10];
6605 gc_current_status_fill(
objspace, current_gc_status);
6608 fprintf(stderr,
"%"PRItick
"\t%"PRItick
"\t%s\t[%s->%s|%c]\n",
6609 enter_tick - last_exit_tick,
6610 exit_tick - enter_tick,
6612 last_gc_status, current_gc_status,
6613 (
objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_MASK) ?
'+' :
'-');
6614 last_exit_tick = exit_tick;
6617 fprintf(stderr,
"%"PRItick
"\t%"PRItick
"\t%s\t[%s->%s|%c]\n",
6619 exit_tick - enter_tick,
6621 last_gc_status, current_gc_status,
6622 (
objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_MASK) ?
'+' :
'-');
6635gc_enter_event_cstr(
enum gc_enter_event event)
6638 case gc_enter_event_start:
return "start";
6639 case gc_enter_event_continue:
return "continue";
6640 case gc_enter_event_rest:
return "rest";
6641 case gc_enter_event_finalizer:
return "finalizer";
6647gc_enter_count(
enum gc_enter_event event)
6650 case gc_enter_event_start: RB_DEBUG_COUNTER_INC(gc_enter_start);
break;
6651 case gc_enter_event_continue: RB_DEBUG_COUNTER_INC(gc_enter_continue);
break;
6652 case gc_enter_event_rest: RB_DEBUG_COUNTER_INC(gc_enter_rest);
break;
6653 case gc_enter_event_finalizer: RB_DEBUG_COUNTER_INC(gc_enter_finalizer);
break;
6657static bool current_process_time(
struct timespec *ts);
6662 if (!current_process_time(ts)) {
6668static unsigned long long
6673 if ((ts->tv_sec > 0 || ts->tv_nsec > 0) &&
6674 current_process_time(&end_time) &&
6675 end_time.tv_sec >= ts->tv_sec) {
6676 return (
unsigned long long)(end_time.tv_sec - ts->tv_sec) * (1000 * 1000 * 1000) +
6677 (end_time.tv_nsec - ts->tv_nsec);
6686 *lock_lev = RB_GC_VM_LOCK();
6689 case gc_enter_event_rest:
6690 case gc_enter_event_start:
6691 case gc_enter_event_continue:
6699 gc_enter_count(event);
6700 if (RB_UNLIKELY(during_gc != 0)) rb_bug(
"during_gc != 0");
6701 if (RGENGC_CHECK_MODE >= 3) gc_verify_internal_consistency(
objspace);
6704 RUBY_DEBUG_LOG(
"%s (%s)",gc_enter_event_cstr(event), gc_current_status(
objspace));
6705 gc_report(1,
objspace,
"gc_enter: %s [%s]\n", gc_enter_event_cstr(event), gc_current_status(
objspace));
6706 gc_record(
objspace, 0, gc_enter_event_cstr(event));
6714 GC_ASSERT(during_gc != 0);
6718 gc_record(
objspace, 1, gc_enter_event_cstr(event));
6719 RUBY_DEBUG_LOG(
"%s (%s)", gc_enter_event_cstr(event), gc_current_status(
objspace));
6720 gc_report(1,
objspace,
"gc_exit: %s [%s]\n", gc_enter_event_cstr(event), gc_current_status(
objspace));
6723 RB_GC_VM_UNLOCK(*lock_lev);
6727#define MEASURE_GC (objspace->flags.measure_gc)
6733 GC_ASSERT(during_gc != 0);
6736 gc_clock_start(&
objspace->profile.marking_start_time);
6743 GC_ASSERT(during_gc != 0);
6746 objspace->profile.marking_time_ns += gc_clock_end(&
objspace->profile.marking_start_time);
6753 GC_ASSERT(during_gc != 0);
6756 gc_clock_start(&
objspace->profile.sweeping_start_time);
6763 GC_ASSERT(during_gc != 0);
6766 objspace->profile.sweeping_time_ns += gc_clock_end(&
objspace->profile.sweeping_start_time);
6771gc_with_gvl(
void *ptr)
6774 return (
void *)(
VALUE)garbage_collect(oar->objspace, oar->reason);
6777int ruby_thread_has_gvl_p(
void);
6782 if (dont_gc_val()) {
6788 else if (!ruby_thread_has_gvl_p()) {
6792 oar.reason = reason;
6798 return garbage_collect(
objspace, reason);
6803gc_set_candidate_object_i(
void *vstart,
void *vend,
size_t stride,
void *data)
6808 for (; v != (
VALUE)vend; v += stride) {
6809 asan_unpoisoning_object(v) {
6815 rb_gc_prepare_heap_process_object(v);
6817 RVALUE_AGE_SET_CANDIDATE(
objspace, v);
6827rb_gc_impl_start(
void *objspace_ptr,
bool full_mark,
bool immediate_mark,
bool immediate_sweep,
bool compact)
6830 unsigned int reason = (GPR_FLAG_FULL_MARK |
6831 GPR_FLAG_IMMEDIATE_MARK |
6832 GPR_FLAG_IMMEDIATE_SWEEP |
6835 int full_marking_p = gc_config_full_mark_val;
6836 gc_config_full_mark_set(TRUE);
6840 GC_ASSERT(GC_COMPACTION_SUPPORTED);
6842 reason |= GPR_FLAG_COMPACT;
6845 if (!full_mark) reason &= ~GPR_FLAG_FULL_MARK;
6846 if (!immediate_mark) reason &= ~GPR_FLAG_IMMEDIATE_MARK;
6847 if (!immediate_sweep) reason &= ~GPR_FLAG_IMMEDIATE_SWEEP;
6853 gc_config_full_mark_set(full_marking_p);
6857rb_gc_impl_prepare_heap(
void *objspace_ptr)
6861 size_t orig_total_slots = objspace_available_slots(
objspace);
6862 size_t orig_allocatable_slots =
objspace->heap_pages.allocatable_slots;
6864 rb_gc_impl_each_objects(
objspace, gc_set_candidate_object_i, objspace_ptr);
6866 double orig_max_free_slots = gc_params.heap_free_slots_max_ratio;
6868 gc_params.heap_free_slots_max_ratio = 0.0;
6869 rb_gc_impl_start(
objspace,
true,
true,
true,
true);
6870 gc_params.heap_free_slots_max_ratio = orig_max_free_slots;
6872 objspace->heap_pages.allocatable_slots = 0;
6873 heap_pages_freeable_pages =
objspace->empty_pages_count;
6874 heap_pages_free_unused_pages(objspace_ptr);
6875 GC_ASSERT(heap_pages_freeable_pages == 0);
6876 GC_ASSERT(
objspace->empty_pages_count == 0);
6877 objspace->heap_pages.allocatable_slots = orig_allocatable_slots;
6879 size_t total_slots = objspace_available_slots(
objspace);
6880 if (orig_total_slots > total_slots) {
6881 objspace->heap_pages.allocatable_slots += orig_total_slots - total_slots;
6884#if defined(HAVE_MALLOC_TRIM) && !defined(RUBY_ALTERNATIVE_MALLOC_HEADER)
6930 GC_ASSERT(st_is_member(finalizer_table, obj));
6934 GC_ASSERT(RVALUE_MARKED(
objspace, obj));
6935 GC_ASSERT(!RVALUE_PINNED(
objspace, obj));
6940 rb_bug(
"gc_is_moveable_obj: unreachable (%d)", (
int)
BUILTIN_TYPE(obj));
6947void rb_mv_generic_ivar(
VALUE src,
VALUE dst);
6957 gc_report(4,
objspace,
"Moving object: %p -> %p\n", (
void *)src, (
void *)dest);
6960 GC_ASSERT(!MARKED_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest));
6962 GC_ASSERT(!RVALUE_MARKING(
objspace, src));
6965 marked = RVALUE_MARKED(
objspace, src);
6966 wb_unprotected = RVALUE_WB_UNPROTECTED(
objspace, src);
6967 uncollectible = RVALUE_UNCOLLECTIBLE(
objspace, src);
6968 bool remembered = RVALUE_REMEMBERED(
objspace, src);
6969 age = RVALUE_AGE_GET(src);
6972 CLEAR_IN_BITMAP(GET_HEAP_MARK_BITS(src), src);
6973 CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(src), src);
6974 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(src), src);
6975 CLEAR_IN_BITMAP(GET_HEAP_PAGE(src)->remembered_bits, src);
6978 memcpy((
void *)dest, (
void *)src, MIN(src_slot_size, slot_size));
6980 if (RVALUE_OVERHEAD > 0) {
6981 void *dest_overhead = (
void *)(((uintptr_t)dest) + slot_size - RVALUE_OVERHEAD);
6982 void *src_overhead = (
void *)(((uintptr_t)src) + src_slot_size - RVALUE_OVERHEAD);
6984 memcpy(dest_overhead, src_overhead, RVALUE_OVERHEAD);
6987 memset((
void *)src, 0, src_slot_size);
6988 RVALUE_AGE_SET_BITMAP(src, 0);
6992 MARK_IN_BITMAP(GET_HEAP_PAGE(dest)->remembered_bits, dest);
6995 CLEAR_IN_BITMAP(GET_HEAP_PAGE(dest)->remembered_bits, dest);
6999 MARK_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest);
7002 CLEAR_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest);
7005 if (wb_unprotected) {
7006 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(dest), dest);
7009 CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(dest), dest);
7012 if (uncollectible) {
7013 MARK_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(dest), dest);
7016 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(dest), dest);
7019 RVALUE_AGE_SET(dest, age);
7022 RMOVED(src)->dummy =
Qundef;
7023 RMOVED(src)->destination = dest;
7026 GET_HEAP_PAGE(src)->heap->total_freed_objects++;
7027 GET_HEAP_PAGE(dest)->heap->total_allocated_objects++;
7032#if GC_CAN_COMPILE_COMPACTION
7034compare_pinned_slots(
const void *left,
const void *right,
void *dummy)
7039 left_page = *(
struct heap_page *
const *)left;
7040 right_page = *(
struct heap_page *
const *)right;
7042 return left_page->pinned_slots - right_page->pinned_slots;
7046compare_free_slots(
const void *left,
const void *right,
void *dummy)
7051 left_page = *(
struct heap_page *
const *)left;
7052 right_page = *(
struct heap_page *
const *)right;
7054 return left_page->free_slots - right_page->free_slots;
7060 for (
int j = 0; j < HEAP_COUNT; j++) {
7063 size_t total_pages = heap->total_pages;
7065 struct heap_page *page = 0, **page_list = malloc(size);
7068 heap->free_pages = NULL;
7069 ccan_list_for_each(&heap->pages, page, page_node) {
7070 page_list[i++] = page;
7074 GC_ASSERT((
size_t)i == total_pages);
7081 ccan_list_head_init(&heap->pages);
7083 for (i = 0; i < total_pages; i++) {
7084 ccan_list_add(&heap->pages, &page_list[i]->page_node);
7085 if (page_list[i]->free_slots != 0) {
7086 heap_add_freepage(heap, page_list[i]);
7096rb_gc_impl_object_moved_p(
void *objspace_ptr,
VALUE obj)
7098 return gc_object_moved_p(objspace_ptr, obj);
7106 page->flags.has_uncollectible_wb_unprotected_objects = FALSE;
7107 page->flags.has_remembered_objects = FALSE;
7110 for (; v != (
VALUE)vend; v += stride) {
7111 asan_unpoisoning_object(v) {
7118 if (RVALUE_WB_UNPROTECTED(
objspace, v)) {
7119 page->flags.has_uncollectible_wb_unprotected_objects = TRUE;
7121 if (RVALUE_REMEMBERED(
objspace, v)) {
7122 page->flags.has_remembered_objects = TRUE;
7124 if (page->flags.before_sweep) {
7126 rb_gc_update_object_references(
objspace, v);
7130 rb_gc_update_object_references(
objspace, v);
7140gc_update_references_weak_table_i(
VALUE obj,
void *data)
7143 asan_unpoisoning_object(obj) {
7150gc_update_references_weak_table_replace_i(
VALUE *obj,
void *data)
7152 *obj = rb_gc_location(*obj);
7160 objspace->flags.during_reference_updating =
true;
7162 rb_gc_before_updating_jit_code();
7166 for (
int i = 0; i < HEAP_COUNT; i++) {
7167 bool should_set_mark_bits = TRUE;
7170 ccan_list_for_each(&heap->pages, page, page_node) {
7171 uintptr_t start = (uintptr_t)page->start;
7172 uintptr_t end = start + (page->total_slots * heap->slot_size);
7174 gc_ref_update((
void *)start, (
void *)end, heap->slot_size,
objspace, page);
7175 if (page == heap->sweeping_page) {
7176 should_set_mark_bits = FALSE;
7178 if (should_set_mark_bits) {
7179 gc_setup_mark_bits(page);
7184 gc_update_table_refs(finalizer_table);
7186 rb_gc_update_vm_references((
void *)
objspace);
7188 for (
int table = 0; table < RB_GC_VM_WEAK_TABLE_COUNT; table++) {
7189 rb_gc_vm_weak_table_foreach(
7190 gc_update_references_weak_table_i,
7191 gc_update_references_weak_table_replace_i,
7198 rb_gc_after_updating_jit_code();
7200 objspace->flags.during_reference_updating =
false;
7203#if GC_CAN_COMPILE_COMPACTION
7205root_obj_check_moved_i(
const char *category,
VALUE obj,
void *data)
7209 if (gc_object_moved_p(
objspace, obj)) {
7210 rb_bug(
"ROOT %s points to MOVED: %p -> %s", category, (
void *)obj, rb_obj_info(rb_gc_impl_location(
objspace, obj)));
7215reachable_object_check_moved_i(
VALUE ref,
void *data)
7218 if (gc_object_moved_p(rb_gc_get_objspace(), ref)) {
7219 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)));
7224heap_check_moved_i(
void *vstart,
void *vend,
size_t stride,
void *data)
7229 for (; v != (
VALUE)vend; v += stride) {
7230 if (gc_object_moved_p(
objspace, v)) {
7234 asan_unpoisoning_object(v) {
7240 if (!rb_gc_impl_garbage_object_p(
objspace, v)) {
7241 rb_objspace_reachable_objects_from(v, reachable_object_check_moved_i, (
void *)v);
7253rb_gc_impl_during_gc_p(
void *objspace_ptr)
7260#if RGENGC_PROFILE >= 2
7293 default:
return "unknown";
7298gc_count_add_each_types(
VALUE hash,
const char *name,
const size_t *types)
7302 for (i=0; i<
T_MASK; i++) {
7303 const char *
type = type_name(i, 0);
7306 rb_hash_aset(hash,
ID2SYM(rb_intern(name)), result);
7311rb_gc_impl_gc_count(
void *objspace_ptr)
7321 static VALUE sym_major_by =
Qnil, sym_gc_by, sym_immediate_sweep, sym_have_finalizer, sym_state, sym_need_major_by;
7322 static VALUE sym_nofree, sym_oldgen, sym_shady, sym_force, sym_stress;
7323#if RGENGC_ESTIMATE_OLDMALLOC
7324 static VALUE sym_oldmalloc;
7326 static VALUE sym_newobj, sym_malloc, sym_method, sym_capi;
7327 static VALUE sym_none, sym_marking, sym_sweeping;
7328 static VALUE sym_weak_references_count, sym_retained_weak_references_count;
7330 VALUE major_by, need_major_by;
7331 unsigned int flags = orig_flags ? orig_flags :
objspace->profile.latest_gc_info;
7340 rb_bug(
"gc_info_decode: non-hash or symbol given");
7343 if (
NIL_P(sym_major_by)) {
7344#define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
7357#if RGENGC_ESTIMATE_OLDMALLOC
7369 S(weak_references_count);
7370 S(retained_weak_references_count);
7374#define SET(name, attr) \
7375 if (key == sym_##name) \
7377 else if (hash != Qnil) \
7378 rb_hash_aset(hash, sym_##name, (attr));
7381 (flags & GPR_FLAG_MAJOR_BY_NOFREE) ? sym_nofree :
7382 (flags & GPR_FLAG_MAJOR_BY_OLDGEN) ? sym_oldgen :
7383 (flags & GPR_FLAG_MAJOR_BY_SHADY) ? sym_shady :
7384 (flags & GPR_FLAG_MAJOR_BY_FORCE) ? sym_force :
7385#if RGENGC_ESTIMATE_OLDMALLOC
7386 (flags & GPR_FLAG_MAJOR_BY_OLDMALLOC) ? sym_oldmalloc :
7389 SET(major_by, major_by);
7391 if (orig_flags == 0) {
7392 unsigned int need_major_flags = gc_needs_major_flags;
7394 (need_major_flags & GPR_FLAG_MAJOR_BY_NOFREE) ? sym_nofree :
7395 (need_major_flags & GPR_FLAG_MAJOR_BY_OLDGEN) ? sym_oldgen :
7396 (need_major_flags & GPR_FLAG_MAJOR_BY_SHADY) ? sym_shady :
7397 (need_major_flags & GPR_FLAG_MAJOR_BY_FORCE) ? sym_force :
7398#if RGENGC_ESTIMATE_OLDMALLOC
7399 (need_major_flags & GPR_FLAG_MAJOR_BY_OLDMALLOC) ? sym_oldmalloc :
7402 SET(need_major_by, need_major_by);
7406 (flags & GPR_FLAG_NEWOBJ) ? sym_newobj :
7407 (flags & GPR_FLAG_MALLOC) ? sym_malloc :
7408 (flags & GPR_FLAG_METHOD) ? sym_method :
7409 (flags & GPR_FLAG_CAPI) ? sym_capi :
7410 (flags & GPR_FLAG_STRESS) ? sym_stress :
7414 SET(have_finalizer, (flags & GPR_FLAG_HAVE_FINALIZE) ?
Qtrue :
Qfalse);
7415 SET(immediate_sweep, (flags & GPR_FLAG_IMMEDIATE_SWEEP) ?
Qtrue :
Qfalse);
7417 if (orig_flags == 0) {
7418 SET(state, gc_mode(
objspace) == gc_mode_none ? sym_none :
7419 gc_mode(
objspace) == gc_mode_marking ? sym_marking : sym_sweeping);
7422 SET(weak_references_count,
LONG2FIX(
objspace->profile.weak_references_count));
7423 SET(retained_weak_references_count,
LONG2FIX(
objspace->profile.retained_weak_references_count));
7435rb_gc_impl_latest_gc_info(
void *objspace_ptr,
VALUE key)
7439 return gc_info_decode(
objspace, key, 0);
7446 gc_stat_sym_marking_time,
7447 gc_stat_sym_sweeping_time,
7448 gc_stat_sym_heap_allocated_pages,
7449 gc_stat_sym_heap_empty_pages,
7450 gc_stat_sym_heap_allocatable_slots,
7451 gc_stat_sym_heap_available_slots,
7452 gc_stat_sym_heap_live_slots,
7453 gc_stat_sym_heap_free_slots,
7454 gc_stat_sym_heap_final_slots,
7455 gc_stat_sym_heap_marked_slots,
7456 gc_stat_sym_heap_eden_pages,
7457 gc_stat_sym_total_allocated_pages,
7458 gc_stat_sym_total_freed_pages,
7459 gc_stat_sym_total_allocated_objects,
7460 gc_stat_sym_total_freed_objects,
7461 gc_stat_sym_malloc_increase_bytes,
7462 gc_stat_sym_malloc_increase_bytes_limit,
7463 gc_stat_sym_minor_gc_count,
7464 gc_stat_sym_major_gc_count,
7465 gc_stat_sym_compact_count,
7466 gc_stat_sym_read_barrier_faults,
7467 gc_stat_sym_total_moved_objects,
7468 gc_stat_sym_remembered_wb_unprotected_objects,
7469 gc_stat_sym_remembered_wb_unprotected_objects_limit,
7470 gc_stat_sym_old_objects,
7471 gc_stat_sym_old_objects_limit,
7472#if RGENGC_ESTIMATE_OLDMALLOC
7473 gc_stat_sym_oldmalloc_increase_bytes,
7474 gc_stat_sym_oldmalloc_increase_bytes_limit,
7476 gc_stat_sym_weak_references_count,
7478 gc_stat_sym_total_generated_normal_object_count,
7479 gc_stat_sym_total_generated_shady_object_count,
7480 gc_stat_sym_total_shade_operation_count,
7481 gc_stat_sym_total_promoted_count,
7482 gc_stat_sym_total_remembered_normal_object_count,
7483 gc_stat_sym_total_remembered_shady_object_count,
7488static VALUE gc_stat_symbols[gc_stat_sym_last];
7491setup_gc_stat_symbols(
void)
7493 if (gc_stat_symbols[0] == 0) {
7494#define S(s) gc_stat_symbols[gc_stat_sym_##s] = ID2SYM(rb_intern_const(#s))
7499 S(heap_allocated_pages);
7500 S(heap_empty_pages);
7501 S(heap_allocatable_slots);
7502 S(heap_available_slots);
7505 S(heap_final_slots);
7506 S(heap_marked_slots);
7508 S(total_allocated_pages);
7509 S(total_freed_pages);
7510 S(total_allocated_objects);
7511 S(total_freed_objects);
7512 S(malloc_increase_bytes);
7513 S(malloc_increase_bytes_limit);
7517 S(read_barrier_faults);
7518 S(total_moved_objects);
7519 S(remembered_wb_unprotected_objects);
7520 S(remembered_wb_unprotected_objects_limit);
7522 S(old_objects_limit);
7523#if RGENGC_ESTIMATE_OLDMALLOC
7524 S(oldmalloc_increase_bytes);
7525 S(oldmalloc_increase_bytes_limit);
7527 S(weak_references_count);
7529 S(total_generated_normal_object_count);
7530 S(total_generated_shady_object_count);
7531 S(total_shade_operation_count);
7532 S(total_promoted_count);
7533 S(total_remembered_normal_object_count);
7534 S(total_remembered_shady_object_count);
7541ns_to_ms(uint64_t ns)
7543 return ns / (1000 * 1000);
7549rb_gc_impl_stat(
void *objspace_ptr,
VALUE hash_or_sym)
7554 setup_gc_stat_symbols();
7556 ractor_cache_flush_count(
objspace, rb_gc_get_ractor_newobj_cache());
7557 malloc_increase_local_flush(
objspace);
7566 rb_bug(
"non-hash or symbol given");
7569#define SET(name, attr) \
7570 if (key == gc_stat_symbols[gc_stat_sym_##name]) \
7571 return SIZET2NUM(attr); \
7572 else if (hash != Qnil) \
7573 rb_hash_aset(hash, gc_stat_symbols[gc_stat_sym_##name], SIZET2NUM(attr));
7575 SET(count,
objspace->profile.count);
7576 SET(time, (
size_t)ns_to_ms(
objspace->profile.marking_time_ns +
objspace->profile.sweeping_time_ns));
7577 SET(marking_time, (
size_t)ns_to_ms(
objspace->profile.marking_time_ns));
7578 SET(sweeping_time, (
size_t)ns_to_ms(
objspace->profile.sweeping_time_ns));
7581 SET(heap_allocated_pages, rb_darray_size(
objspace->heap_pages.sorted));
7582 SET(heap_empty_pages,
objspace->empty_pages_count)
7583 SET(heap_allocatable_slots,
objspace->heap_pages.allocatable_slots);
7584 SET(heap_available_slots, objspace_available_slots(
objspace));
7585 SET(heap_live_slots, objspace_live_slots(
objspace));
7586 SET(heap_free_slots, objspace_free_slots(
objspace));
7587 SET(heap_final_slots, total_final_slots_count(
objspace));
7588 SET(heap_marked_slots,
objspace->marked_slots);
7589 SET(heap_eden_pages, heap_eden_total_pages(
objspace));
7590 SET(total_allocated_pages,
objspace->heap_pages.allocated_pages);
7591 SET(total_freed_pages,
objspace->heap_pages.freed_pages);
7592 SET(total_allocated_objects, total_allocated_objects(
objspace));
7593 SET(total_freed_objects, total_freed_objects(
objspace));
7594 SET(malloc_increase_bytes, malloc_increase);
7595 SET(malloc_increase_bytes_limit, malloc_limit);
7596 SET(minor_gc_count,
objspace->profile.minor_gc_count);
7597 SET(major_gc_count,
objspace->profile.major_gc_count);
7598 SET(compact_count,
objspace->profile.compact_count);
7599 SET(read_barrier_faults,
objspace->profile.read_barrier_faults);
7600 SET(total_moved_objects,
objspace->rcompactor.total_moved);
7601 SET(remembered_wb_unprotected_objects,
objspace->rgengc.uncollectible_wb_unprotected_objects);
7602 SET(remembered_wb_unprotected_objects_limit,
objspace->rgengc.uncollectible_wb_unprotected_objects_limit);
7603 SET(old_objects,
objspace->rgengc.old_objects);
7604 SET(old_objects_limit,
objspace->rgengc.old_objects_limit);
7605#if RGENGC_ESTIMATE_OLDMALLOC
7606 SET(oldmalloc_increase_bytes,
objspace->malloc_counters.oldmalloc_increase);
7607 SET(oldmalloc_increase_bytes_limit,
objspace->rgengc.oldmalloc_increase_limit);
7611 SET(total_generated_normal_object_count,
objspace->profile.total_generated_normal_object_count);
7612 SET(total_generated_shady_object_count,
objspace->profile.total_generated_shady_object_count);
7613 SET(total_shade_operation_count,
objspace->profile.total_shade_operation_count);
7614 SET(total_promoted_count,
objspace->profile.total_promoted_count);
7615 SET(total_remembered_normal_object_count,
objspace->profile.total_remembered_normal_object_count);
7616 SET(total_remembered_shady_object_count,
objspace->profile.total_remembered_shady_object_count);
7625#if defined(RGENGC_PROFILE) && RGENGC_PROFILE >= 2
7627 gc_count_add_each_types(hash,
"generated_normal_object_count_types",
objspace->profile.generated_normal_object_count_types);
7628 gc_count_add_each_types(hash,
"generated_shady_object_count_types",
objspace->profile.generated_shady_object_count_types);
7629 gc_count_add_each_types(hash,
"shade_operation_count_types",
objspace->profile.shade_operation_count_types);
7630 gc_count_add_each_types(hash,
"promoted_types",
objspace->profile.promoted_types);
7631 gc_count_add_each_types(hash,
"remembered_normal_object_count_types",
objspace->profile.remembered_normal_object_count_types);
7632 gc_count_add_each_types(hash,
"remembered_shady_object_count_types",
objspace->profile.remembered_shady_object_count_types);
7639enum gc_stat_heap_sym {
7640 gc_stat_heap_sym_slot_size,
7641 gc_stat_heap_sym_heap_live_slots,
7642 gc_stat_heap_sym_heap_free_slots,
7643 gc_stat_heap_sym_heap_final_slots,
7644 gc_stat_heap_sym_heap_eden_pages,
7645 gc_stat_heap_sym_heap_eden_slots,
7646 gc_stat_heap_sym_total_allocated_pages,
7647 gc_stat_heap_sym_force_major_gc_count,
7648 gc_stat_heap_sym_force_incremental_marking_finish_count,
7649 gc_stat_heap_sym_total_allocated_objects,
7650 gc_stat_heap_sym_total_freed_objects,
7651 gc_stat_heap_sym_last
7654static VALUE gc_stat_heap_symbols[gc_stat_heap_sym_last];
7657setup_gc_stat_heap_symbols(
void)
7659 if (gc_stat_heap_symbols[0] == 0) {
7660#define S(s) gc_stat_heap_symbols[gc_stat_heap_sym_##s] = ID2SYM(rb_intern_const(#s))
7664 S(heap_final_slots);
7667 S(total_allocated_pages);
7668 S(force_major_gc_count);
7669 S(force_incremental_marking_finish_count);
7670 S(total_allocated_objects);
7671 S(total_freed_objects);
7679#define SET(name, attr) \
7680 if (key == gc_stat_heap_symbols[gc_stat_heap_sym_##name]) \
7681 return SIZET2NUM(attr); \
7682 else if (hash != Qnil) \
7683 rb_hash_aset(hash, gc_stat_heap_symbols[gc_stat_heap_sym_##name], SIZET2NUM(attr));
7685 SET(slot_size, heap->slot_size);
7686 SET(heap_live_slots, heap->total_allocated_objects - heap->total_freed_objects - heap->final_slots_count);
7687 SET(heap_free_slots, heap->total_slots - (heap->total_allocated_objects - heap->total_freed_objects));
7688 SET(heap_final_slots, heap->final_slots_count);
7689 SET(heap_eden_pages, heap->total_pages);
7690 SET(heap_eden_slots, heap->total_slots);
7691 SET(total_allocated_pages, heap->total_allocated_pages);
7692 SET(force_major_gc_count, heap->force_major_gc_count);
7693 SET(force_incremental_marking_finish_count, heap->force_incremental_marking_finish_count);
7694 SET(total_allocated_objects, heap->total_allocated_objects);
7695 SET(total_freed_objects, heap->total_freed_objects);
7707rb_gc_impl_stat_heap(
void *objspace_ptr,
VALUE heap_name,
VALUE hash_or_sym)
7711 ractor_cache_flush_count(
objspace, rb_gc_get_ractor_newobj_cache());
7713 setup_gc_stat_heap_symbols();
7715 if (
NIL_P(heap_name)) {
7717 rb_bug(
"non-hash given");
7720 for (
int i = 0; i < HEAP_COUNT; i++) {
7723 hash = rb_hash_new();
7724 rb_hash_aset(hash_or_sym,
INT2FIX(i), hash);
7727 stat_one_heap(&heaps[i], hash,
Qnil);
7731 int heap_idx =
FIX2INT(heap_name);
7733 if (heap_idx < 0 || heap_idx >= HEAP_COUNT) {
7734 rb_raise(rb_eArgError,
"size pool index out of range");
7738 return stat_one_heap(&heaps[heap_idx],
Qnil, hash_or_sym);
7741 return stat_one_heap(&heaps[heap_idx], hash_or_sym,
Qnil);
7744 rb_bug(
"non-hash or symbol given");
7748 rb_bug(
"heap_name must be nil or an Integer");
7760#define RBOOL(v) (v ? Qtrue : Qfalse)
7764rb_gc_impl_config_get(
void *objspace_ptr)
7766#define sym(name) ID2SYM(rb_intern_const(name))
7768 VALUE hash = rb_hash_new();
7770 rb_hash_aset(hash, sym(
"rgengc_allow_full_mark"), RBOOL(gc_config_full_mark_val));
7779 if (
rb_sym2id(key) == rb_intern(
"rgengc_allow_full_mark")) {
7781 gc_config_full_mark_set(
RTEST(value));
7787rb_gc_impl_config_set(
void *objspace_ptr,
VALUE hash)
7792 rb_raise(rb_eArgError,
"expected keyword arguments");
7799rb_gc_impl_stress_get(
void *objspace_ptr)
7802 return ruby_gc_stress_mode;
7806rb_gc_impl_stress_set(
void *objspace_ptr,
VALUE flag)
7815get_envparam_size(
const char *name,
size_t *default_value,
size_t lower_bound)
7817 const char *ptr = getenv(name);
7820 if (ptr != NULL && *ptr) {
7823#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
7824 val = strtoll(ptr, &end, 0);
7826 val = strtol(ptr, &end, 0);
7838 unit = 1024*1024*1024;
7842 while (*end && isspace((
unsigned char)*end)) end++;
7844 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"invalid string for %s: %s\n", name, ptr);
7848 if (val < -(ssize_t)(SIZE_MAX / 2 / unit) || (ssize_t)(SIZE_MAX / 2 / unit) < val) {
7849 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"%s=%s is ignored because it overflows\n", name, ptr);
7854 if (val > 0 && (
size_t)val > lower_bound) {
7856 fprintf(stderr,
"%s=%"PRIdSIZE
" (default value: %"PRIuSIZE
")\n", name, val, *default_value);
7858 *default_value = (size_t)val;
7863 fprintf(stderr,
"%s=%"PRIdSIZE
" (default value: %"PRIuSIZE
") is ignored because it must be greater than %"PRIuSIZE
".\n",
7864 name, val, *default_value, lower_bound);
7873get_envparam_double(
const char *name,
double *default_value,
double lower_bound,
double upper_bound,
int accept_zero)
7875 const char *ptr = getenv(name);
7878 if (ptr != NULL && *ptr) {
7881 if (!*ptr || *end) {
7882 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"invalid string for %s: %s\n", name, ptr);
7886 if (accept_zero && val == 0.0) {
7889 else if (val <= lower_bound) {
7891 fprintf(stderr,
"%s=%f (default value: %f) is ignored because it must be greater than %f.\n",
7892 name, val, *default_value, lower_bound);
7895 else if (upper_bound != 0.0 &&
7896 val > upper_bound) {
7898 fprintf(stderr,
"%s=%f (default value: %f) is ignored because it must be lower than %f.\n",
7899 name, val, *default_value, upper_bound);
7909 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"%s=%f (default value: %f)\n", name, val, *default_value);
7910 *default_value = val;
7955rb_gc_impl_set_params(
void *objspace_ptr)
7959 if (get_envparam_size(
"RUBY_GC_HEAP_FREE_SLOTS", &gc_params.heap_free_slots, 0)) {
7963 for (
int i = 0; i < HEAP_COUNT; i++) {
7964 char env_key[
sizeof(
"RUBY_GC_HEAP_" "_INIT_SLOTS") +
DECIMAL_SIZE_OF_BITS(
sizeof(
int) * CHAR_BIT)];
7965 snprintf(env_key,
sizeof(env_key),
"RUBY_GC_HEAP_%d_INIT_SLOTS", i);
7967 get_envparam_size(env_key, &gc_params.heap_init_slots[i], 0);
7970 get_envparam_double(
"RUBY_GC_HEAP_GROWTH_FACTOR", &gc_params.growth_factor, 1.0, 0.0, FALSE);
7971 get_envparam_size (
"RUBY_GC_HEAP_GROWTH_MAX_SLOTS", &gc_params.growth_max_slots, 0);
7972 get_envparam_double(
"RUBY_GC_HEAP_FREE_SLOTS_MIN_RATIO", &gc_params.heap_free_slots_min_ratio,
7974 get_envparam_double(
"RUBY_GC_HEAP_FREE_SLOTS_MAX_RATIO", &gc_params.heap_free_slots_max_ratio,
7975 gc_params.heap_free_slots_min_ratio, 1.0, FALSE);
7976 get_envparam_double(
"RUBY_GC_HEAP_FREE_SLOTS_GOAL_RATIO", &gc_params.heap_free_slots_goal_ratio,
7977 gc_params.heap_free_slots_min_ratio, gc_params.heap_free_slots_max_ratio, TRUE);
7978 get_envparam_double(
"RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR", &gc_params.oldobject_limit_factor, 0.0, 0.0, TRUE);
7979 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);
7981 if (get_envparam_size(
"RUBY_GC_MALLOC_LIMIT", &gc_params.malloc_limit_min, 0)) {
7982 malloc_limit = gc_params.malloc_limit_min;
7984 get_envparam_size (
"RUBY_GC_MALLOC_LIMIT_MAX", &gc_params.malloc_limit_max, 0);
7985 if (!gc_params.malloc_limit_max) {
7986 gc_params.malloc_limit_max = SIZE_MAX;
7988 get_envparam_double(
"RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR", &gc_params.malloc_limit_growth_factor, 1.0, 0.0, FALSE);
7990#if RGENGC_ESTIMATE_OLDMALLOC
7991 if (get_envparam_size(
"RUBY_GC_OLDMALLOC_LIMIT", &gc_params.oldmalloc_limit_min, 0)) {
7992 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
7994 get_envparam_size (
"RUBY_GC_OLDMALLOC_LIMIT_MAX", &gc_params.oldmalloc_limit_max, 0);
7995 get_envparam_double(
"RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR", &gc_params.oldmalloc_limit_growth_factor, 1.0, 0.0, FALSE);
8002#ifdef HAVE_MALLOC_USABLE_SIZE
8004 hint = malloc_usable_size(ptr);
8011 MEMOP_TYPE_MALLOC = 0,
8017atomic_sub_nounderflow(
size_t *var,
size_t sub)
8019 if (sub == 0)
return;
8023 if (val < sub) sub = val;
8028#define gc_stress_full_mark_after_malloc_p() \
8029 (FIXNUM_P(ruby_gc_stress_mode) && (FIX2LONG(ruby_gc_stress_mode) & (1<<gc_stress_full_mark_after_malloc)))
8035 unsigned int reason = (GPR_FLAG_IMMEDIATE_MARK | GPR_FLAG_IMMEDIATE_SWEEP |
8036 GPR_FLAG_STRESS | GPR_FLAG_MALLOC);
8038 if (gc_stress_full_mark_after_malloc_p()) {
8039 reason |= GPR_FLAG_FULL_MARK;
8041 garbage_collect_with_gvl(
objspace, reason);
8048 if (new_size > old_size) {
8050#if RGENGC_ESTIMATE_OLDMALLOC
8055 atomic_sub_nounderflow(&malloc_increase, old_size - new_size);
8056#if RGENGC_ESTIMATE_OLDMALLOC
8057 atomic_sub_nounderflow(&
objspace->malloc_counters.oldmalloc_increase, old_size - new_size);
8062#if USE_MALLOC_INCREASE_LOCAL
8066 int delta = malloc_increase_local;
8067 if (delta == 0)
return;
8069 malloc_increase_local = 0;
8071 malloc_increase_commit(
objspace, (
size_t)delta, 0);
8074 malloc_increase_commit(
objspace, 0, (
size_t)(-delta));
8085objspace_malloc_increase_report(
rb_objspace_t *
objspace,
void *mem,
size_t new_size,
size_t old_size,
enum memop_type
type,
bool gc_allowed)
8087 if (0) fprintf(stderr,
"increase - ptr: %p, type: %s, new_size: %"PRIdSIZE
", old_size: %"PRIdSIZE
"\n",
8089 type == MEMOP_TYPE_MALLOC ?
"malloc" :
8090 type == MEMOP_TYPE_FREE ?
"free " :
8091 type == MEMOP_TYPE_REALLOC ?
"realloc":
"error",
8092 new_size, old_size);
8097objspace_malloc_increase_body(
rb_objspace_t *
objspace,
void *mem,
size_t new_size,
size_t old_size,
enum memop_type
type,
bool gc_allowed)
8099#if USE_MALLOC_INCREASE_LOCAL
8100 if (new_size < GC_MALLOC_INCREASE_LOCAL_THRESHOLD &&
8101 old_size < GC_MALLOC_INCREASE_LOCAL_THRESHOLD) {
8102 malloc_increase_local += (int)new_size - (
int)old_size;
8104 if (malloc_increase_local >= GC_MALLOC_INCREASE_LOCAL_THRESHOLD ||
8105 malloc_increase_local <= -GC_MALLOC_INCREASE_LOCAL_THRESHOLD) {
8106 malloc_increase_local_flush(
objspace);
8110 malloc_increase_local_flush(
objspace);
8111 malloc_increase_commit(
objspace, new_size, old_size);
8114 malloc_increase_commit(
objspace, new_size, old_size);
8117 if (
type == MEMOP_TYPE_MALLOC && gc_allowed) {
8120 if (ruby_thread_has_gvl_p() && is_lazy_sweeping(
objspace)) {
8124 garbage_collect_with_gvl(
objspace, GPR_FLAG_MALLOC);
8128#if MALLOC_ALLOCATED_SIZE
8129 if (new_size >= old_size) {
8133 size_t dec_size = old_size - new_size;
8135#if MALLOC_ALLOCATED_SIZE_CHECK
8136 size_t allocated_size =
objspace->malloc_params.allocated_size;
8137 if (allocated_size < dec_size) {
8138 rb_bug(
"objspace_malloc_increase: underflow malloc_params.allocated_size.");
8141 atomic_sub_nounderflow(&
objspace->malloc_params.allocated_size, dec_size);
8145 case MEMOP_TYPE_MALLOC:
8148 case MEMOP_TYPE_FREE:
8150 size_t allocations =
objspace->malloc_params.allocations;
8151 if (allocations > 0) {
8152 atomic_sub_nounderflow(&
objspace->malloc_params.allocations, 1);
8154#if MALLOC_ALLOCATED_SIZE_CHECK
8156 GC_ASSERT(
objspace->malloc_params.allocations > 0);
8161 case MEMOP_TYPE_REALLOC:
break;
8167#define objspace_malloc_increase(...) \
8168 for (bool malloc_increase_done = objspace_malloc_increase_report(__VA_ARGS__); \
8169 !malloc_increase_done; \
8170 malloc_increase_done = objspace_malloc_increase_body(__VA_ARGS__))
8179 if (size == 0) size = 1;
8181#if CALC_EXACT_MALLOC_SIZE
8195 return during_gc && !dont_gc_val() && !rb_gc_multi_ractor_p() && ruby_thread_has_gvl_p();
8201 size = objspace_malloc_size(
objspace, mem, size);
8202 objspace_malloc_increase(
objspace, mem, size, 0, MEMOP_TYPE_MALLOC, gc_allowed) {}
8204#if CALC_EXACT_MALLOC_SIZE
8215#if defined(__GNUC__) && RUBY_DEBUG
8216#define RB_BUG_INSTEAD_OF_RB_MEMERROR 1
8219#ifndef RB_BUG_INSTEAD_OF_RB_MEMERROR
8220# define RB_BUG_INSTEAD_OF_RB_MEMERROR 0
8223#define GC_MEMERROR(...) \
8224 ((RB_BUG_INSTEAD_OF_RB_MEMERROR+0) ? rb_bug("" __VA_ARGS__) : (void)0)
8226#define TRY_WITH_GC(siz, expr) do { \
8227 const gc_profile_record_flag gpr = \
8228 GPR_FLAG_FULL_MARK | \
8229 GPR_FLAG_IMMEDIATE_MARK | \
8230 GPR_FLAG_IMMEDIATE_SWEEP | \
8232 objspace_malloc_gc_stress(objspace); \
8234 if (RB_LIKELY((expr))) { \
8237 else if (gc_allowed && !garbage_collect_with_gvl(objspace, gpr)) { \
8239 GC_MEMERROR("TRY_WITH_GC: could not GC"); \
8241 else if ((expr)) { \
8245 GC_MEMERROR("TRY_WITH_GC: could not allocate:" \
8246 "%"PRIdSIZE" bytes for %s", \
8254 if (RB_UNLIKELY(malloc_during_gc_p(
objspace))) {
8257 rb_bug(
"Cannot %s during GC", msg);
8262rb_gc_impl_free(
void *objspace_ptr,
void *ptr,
size_t old_size)
8273#if CALC_EXACT_MALLOC_SIZE
8276 old_size = info->size;
8278 old_size = objspace_malloc_size(
objspace, ptr, old_size);
8280 objspace_malloc_increase(
objspace, ptr, 0, old_size, MEMOP_TYPE_FREE,
true) {
8283 RB_DEBUG_COUNTER_INC(heap_xfree);
8288rb_gc_impl_malloc(
void *objspace_ptr,
size_t size,
bool gc_allowed)
8291 check_malloc_not_in_gc(
objspace,
"malloc");
8295 size = objspace_malloc_prepare(
objspace, size);
8296 TRY_WITH_GC(size, mem = malloc(size));
8297 RB_DEBUG_COUNTER_INC(heap_xmalloc);
8298 if (!mem)
return mem;
8299 return objspace_malloc_fixup(
objspace, mem, size, gc_allowed);
8303rb_gc_impl_calloc(
void *objspace_ptr,
size_t size,
bool gc_allowed)
8307 if (RB_UNLIKELY(malloc_during_gc_p(
objspace))) {
8308 rb_warn(
"calloc during GC detected, this could cause crashes if it triggers another GC");
8309#if RGENGC_CHECK_MODE || RUBY_DEBUG
8310 rb_bug(
"Cannot calloc during GC");
8316 size = objspace_malloc_prepare(
objspace, size);
8317 TRY_WITH_GC(size, mem = calloc1(size));
8318 if (!mem)
return mem;
8319 return objspace_malloc_fixup(
objspace, mem, size, gc_allowed);
8323rb_gc_impl_realloc(
void *objspace_ptr,
void *ptr,
size_t new_size,
size_t old_size,
bool gc_allowed)
8327 check_malloc_not_in_gc(
objspace,
"realloc");
8331 if (!ptr)
return rb_gc_impl_malloc(
objspace, new_size, gc_allowed);
8338 if (new_size == 0) {
8339 if ((mem = rb_gc_impl_malloc(
objspace, 0, gc_allowed)) != NULL) {
8362 rb_gc_impl_free(
objspace, ptr, old_size);
8376#if CALC_EXACT_MALLOC_SIZE
8381 old_size = info->size;
8385 old_size = objspace_malloc_size(
objspace, ptr, old_size);
8387 if (!mem)
return mem;
8388 new_size = objspace_malloc_size(
objspace, mem, new_size);
8390#if CALC_EXACT_MALLOC_SIZE
8393 info->size = new_size;
8398 objspace_malloc_increase(
objspace, mem, new_size, old_size, MEMOP_TYPE_REALLOC, gc_allowed);
8400 RB_DEBUG_COUNTER_INC(heap_xrealloc);
8405rb_gc_impl_adjust_memory_usage(
void *objspace_ptr, ssize_t diff)
8410 objspace_malloc_increase(
objspace, 0, diff, 0, MEMOP_TYPE_REALLOC,
true);
8412 else if (diff < 0) {
8413 objspace_malloc_increase(
objspace, 0, 0, -diff, MEMOP_TYPE_REALLOC,
true);
8422#define GC_PROFILE_RECORD_DEFAULT_SIZE 100
8425current_process_time(
struct timespec *ts)
8427#if defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_PROCESS_CPUTIME_ID)
8429 static int try_clock_gettime = 1;
8430 if (try_clock_gettime && clock_gettime(CLOCK_PROCESS_CPUTIME_ID, ts) == 0) {
8434 try_clock_gettime = 0;
8441 struct rusage usage;
8443 if (getrusage(RUSAGE_SELF, &usage) == 0) {
8444 time = usage.ru_utime;
8445 ts->tv_sec = time.tv_sec;
8446 ts->tv_nsec = (int32_t)time.tv_usec * 1000;
8454 FILETIME creation_time, exit_time, kernel_time, user_time;
8457 if (GetProcessTimes(GetCurrentProcess(),
8458 &creation_time, &exit_time, &kernel_time, &user_time) != 0) {
8459 memcpy(&ui, &user_time,
sizeof(FILETIME));
8460#define PER100NSEC (uint64_t)(1000 * 1000 * 10)
8461 ts->tv_nsec = (long)(ui.QuadPart % PER100NSEC);
8462 ts->tv_sec = (time_t)(ui.QuadPart / PER100NSEC);
8475 if (current_process_time(&ts)) {
8476 return ts.tv_sec + ts.tv_nsec * 1e-9;
8488 size_t index =
objspace->profile.next_index;
8495 objspace->profile.size = GC_PROFILE_RECORD_DEFAULT_SIZE;
8498 if (index >=
objspace->profile.size) {
8502 if (!ptr) rb_memerror();
8506 rb_bug(
"gc_profile malloc or realloc miss");
8512 record->flags = reason | (ruby_gc_stressful ? GPR_FLAG_STRESS : 0);
8513#if MALLOC_ALLOCATED_SIZE
8514 record->allocated_size = malloc_allocated_size;
8516#if GC_PROFILE_MORE_DETAIL && GC_PROFILE_DETAIL_MEMORY
8519 struct rusage usage;
8520 if (getrusage(RUSAGE_SELF, &usage) == 0) {
8521 record->maxrss = usage.ru_maxrss;
8522 record->minflt = usage.ru_minflt;
8523 record->majflt = usage.ru_majflt;
8536#if GC_PROFILE_MORE_DETAIL
8537 record->prepare_time =
objspace->profile.prepare_time;
8539 record->gc_time = 0;
8540 record->gc_invoke_time = getrusage_time();
8545elapsed_time_from(
double time)
8547 double now = getrusage_time();
8561 record->gc_time = elapsed_time_from(record->gc_invoke_time);
8562 record->gc_invoke_time -=
objspace->profile.invoke_time;
8566#ifdef BUILDING_MODULAR_GC
8567# define RUBY_DTRACE_GC_HOOK(name)
8569# define RUBY_DTRACE_GC_HOOK(name) \
8570 do {if (RUBY_DTRACE_GC_##name##_ENABLED()) RUBY_DTRACE_GC_##name();} while (0)
8576 RUBY_DTRACE_GC_HOOK(MARK_BEGIN);
8577#if GC_PROFILE_MORE_DETAIL
8579 gc_prof_record(
objspace)->gc_mark_time = getrusage_time();
8587 RUBY_DTRACE_GC_HOOK(MARK_END);
8588#if GC_PROFILE_MORE_DETAIL
8591 record->gc_mark_time = elapsed_time_from(record->gc_mark_time);
8599 RUBY_DTRACE_GC_HOOK(SWEEP_BEGIN);
8603 if (record->gc_time > 0 || GC_PROFILE_MORE_DETAIL) {
8604 objspace->profile.gc_sweep_start_time = getrusage_time();
8612 RUBY_DTRACE_GC_HOOK(SWEEP_END);
8618 if (record->gc_time > 0) {
8619 sweep_time = elapsed_time_from(
objspace->profile.gc_sweep_start_time);
8621 record->gc_time += sweep_time;
8623 else if (GC_PROFILE_MORE_DETAIL) {
8624 sweep_time = elapsed_time_from(
objspace->profile.gc_sweep_start_time);
8627#if GC_PROFILE_MORE_DETAIL
8628 record->gc_sweep_time += sweep_time;
8629 if (heap_pages_deferred_final) record->flags |= GPR_FLAG_HAVE_FINALIZE;
8631 if (heap_pages_deferred_final)
objspace->profile.latest_gc_info |= GPR_FLAG_HAVE_FINALIZE;
8638#if GC_PROFILE_MORE_DETAIL
8641 record->allocate_increase = malloc_increase;
8642 record->allocate_limit = malloc_limit;
8652 size_t live =
objspace->profile.total_allocated_objects_at_gc_start - total_freed_objects(
objspace);
8653 size_t total =
objspace->profile.heap_used_at_gc_start * HEAP_PAGE_OBJ_LIMIT;
8655#if GC_PROFILE_MORE_DETAIL
8656 record->heap_use_pages =
objspace->profile.heap_used_at_gc_start;
8657 record->heap_live_objects = live;
8658 record->heap_free_objects = total - live;
8661 record->heap_total_objects = total;
8662 record->heap_use_size = live * BASE_SLOT_SIZE;
8663 record->heap_total_size = total * BASE_SLOT_SIZE;
8679 void *p =
objspace->profile.records;
8683 objspace->profile.current_record = 0;
8739gc_profile_record_get(
VALUE _)
8750 for (i =0; i <
objspace->profile.next_index; i++) {
8753 prof = rb_hash_new();
8754 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_FLAGS")), gc_info_decode(
objspace, rb_hash_new(), record->flags));
8755 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_TIME")),
DBL2NUM(record->gc_time));
8756 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_INVOKE_TIME")),
DBL2NUM(record->gc_invoke_time));
8757 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_USE_SIZE")),
SIZET2NUM(record->heap_use_size));
8758 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_TOTAL_SIZE")),
SIZET2NUM(record->heap_total_size));
8759 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_TOTAL_OBJECTS")),
SIZET2NUM(record->heap_total_objects));
8760 rb_hash_aset(prof,
ID2SYM(rb_intern(
"MOVED_OBJECTS")),
SIZET2NUM(record->moved_objects));
8761 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_IS_MARKED")),
Qtrue);
8762#if GC_PROFILE_MORE_DETAIL
8763 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_MARK_TIME")),
DBL2NUM(record->gc_mark_time));
8764 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_SWEEP_TIME")),
DBL2NUM(record->gc_sweep_time));
8765 rb_hash_aset(prof,
ID2SYM(rb_intern(
"ALLOCATE_INCREASE")),
SIZET2NUM(record->allocate_increase));
8766 rb_hash_aset(prof,
ID2SYM(rb_intern(
"ALLOCATE_LIMIT")),
SIZET2NUM(record->allocate_limit));
8767 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_USE_PAGES")),
SIZET2NUM(record->heap_use_pages));
8768 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_LIVE_OBJECTS")),
SIZET2NUM(record->heap_live_objects));
8769 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_FREE_OBJECTS")),
SIZET2NUM(record->heap_free_objects));
8771 rb_hash_aset(prof,
ID2SYM(rb_intern(
"REMOVING_OBJECTS")),
SIZET2NUM(record->removing_objects));
8772 rb_hash_aset(prof,
ID2SYM(rb_intern(
"EMPTY_OBJECTS")),
SIZET2NUM(record->empty_objects));
8774 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HAVE_FINALIZE")), (record->flags & GPR_FLAG_HAVE_FINALIZE) ?
Qtrue :
Qfalse);
8777#if RGENGC_PROFILE > 0
8778 rb_hash_aset(prof,
ID2SYM(rb_intern(
"OLD_OBJECTS")),
SIZET2NUM(record->old_objects));
8779 rb_hash_aset(prof,
ID2SYM(rb_intern(
"REMEMBERED_NORMAL_OBJECTS")),
SIZET2NUM(record->remembered_normal_objects));
8780 rb_hash_aset(prof,
ID2SYM(rb_intern(
"REMEMBERED_SHADY_OBJECTS")),
SIZET2NUM(record->remembered_shady_objects));
8788#if GC_PROFILE_MORE_DETAIL
8789#define MAJOR_REASON_MAX 0x10
8792gc_profile_dump_major_reason(
unsigned int flags,
char *buff)
8794 unsigned int reason = flags & GPR_FLAG_MAJOR_MASK;
8797 if (reason == GPR_FLAG_NONE) {
8803 if (reason & GPR_FLAG_MAJOR_BY_##x) { \
8804 buff[i++] = #x[0]; \
8805 if (i >= MAJOR_REASON_MAX) rb_bug("gc_profile_dump_major_reason: overflow"); \
8811#if RGENGC_ESTIMATE_OLDMALLOC
8826 size_t count =
objspace->profile.next_index;
8827#ifdef MAJOR_REASON_MAX
8828 char reason_str[MAJOR_REASON_MAX];
8831 if (
objspace->profile.run && count ) {
8835 append(out, rb_sprintf(
"GC %"PRIuSIZE
" invokes.\n",
objspace->profile.count));
8836 append(out,
rb_str_new_cstr(
"Index Invoke Time(sec) Use Size(byte) Total Size(byte) Total Object GC Time(ms)\n"));
8838 for (i = 0; i < count; i++) {
8839 record = &
objspace->profile.records[i];
8840 append(out, rb_sprintf(
"%5"PRIuSIZE
" %19.3f %20"PRIuSIZE
" %20"PRIuSIZE
" %20"PRIuSIZE
" %30.20f\n",
8841 i+1, record->gc_invoke_time, record->heap_use_size,
8842 record->heap_total_size, record->heap_total_objects, record->gc_time*1000));
8845#if GC_PROFILE_MORE_DETAIL
8846 const char *str =
"\n\n" \
8848 "Prepare Time = Previously GC's rest sweep time\n"
8849 "Index Flags Allocate Inc. Allocate Limit"
8850#if CALC_EXACT_MALLOC_SIZE
8853 " Use Page Mark Time(ms) Sweep Time(ms) Prepare Time(ms) LivingObj FreeObj RemovedObj EmptyObj"
8855 " OldgenObj RemNormObj RemShadObj"
8857#if GC_PROFILE_DETAIL_MEMORY
8858 " MaxRSS(KB) MinorFLT MajorFLT"
8863 for (i = 0; i < count; i++) {
8864 record = &
objspace->profile.records[i];
8865 append(out, rb_sprintf(
"%5"PRIuSIZE
" %4s/%c/%6s%c %13"PRIuSIZE
" %15"PRIuSIZE
8866#
if CALC_EXACT_MALLOC_SIZE
8869 " %9"PRIuSIZE
" %17.12f %17.12f %17.12f %10"PRIuSIZE
" %10"PRIuSIZE
" %10"PRIuSIZE
" %10"PRIuSIZE
8871 "%10"PRIuSIZE
" %10"PRIuSIZE
" %10"PRIuSIZE
8873#
if GC_PROFILE_DETAIL_MEMORY
8879 gc_profile_dump_major_reason(record->flags, reason_str),
8880 (record->flags & GPR_FLAG_HAVE_FINALIZE) ?
'F' :
'.',
8881 (record->flags & GPR_FLAG_NEWOBJ) ?
"NEWOBJ" :
8882 (record->flags & GPR_FLAG_MALLOC) ?
"MALLOC" :
8883 (record->flags & GPR_FLAG_METHOD) ?
"METHOD" :
8884 (record->flags & GPR_FLAG_CAPI) ?
"CAPI__" :
"??????",
8885 (record->flags & GPR_FLAG_STRESS) ?
'!' :
' ',
8886 record->allocate_increase, record->allocate_limit,
8887#if CALC_EXACT_MALLOC_SIZE
8888 record->allocated_size,
8890 record->heap_use_pages,
8891 record->gc_mark_time*1000,
8892 record->gc_sweep_time*1000,
8893 record->prepare_time*1000,
8895 record->heap_live_objects,
8896 record->heap_free_objects,
8897 record->removing_objects,
8898 record->empty_objects
8901 record->old_objects,
8902 record->remembered_normal_objects,
8903 record->remembered_shady_objects
8905#if GC_PROFILE_DETAIL_MEMORY
8907 record->maxrss / 1024,
8930gc_profile_result(
VALUE _)
8947gc_profile_report(
int argc,
VALUE *argv,
VALUE self)
8952 gc_profile_dump_on(out, rb_io_write);
8965gc_profile_total_time(
VALUE self)
8972 size_t count =
objspace->profile.next_index;
8974 for (i = 0; i < count; i++) {
8975 time +=
objspace->profile.records[i].gc_time;
8989gc_profile_enable_get(
VALUE self)
9004gc_profile_enable(
VALUE _)
9008 objspace->profile.current_record = 0;
9021gc_profile_disable(
VALUE _)
9026 objspace->profile.current_record = 0;
9031rb_gc_verify_internal_consistency(
void)
9033 gc_verify_internal_consistency(rb_gc_get_objspace());
9047gc_verify_internal_consistency_m(
VALUE dummy)
9049 rb_gc_verify_internal_consistency();
9053#if GC_CAN_COMPILE_COMPACTION
9067 GC_ASSERT(GC_COMPACTION_SUPPORTED);
9069 ruby_enable_autocompact =
RTEST(v);
9071#if RGENGC_CHECK_MODE
9072 ruby_autocompact_compare_func = NULL;
9076 if (
id == rb_intern(
"empty")) {
9077 ruby_autocompact_compare_func = compare_free_slots;
9085# define gc_set_auto_compact rb_f_notimplement
9088#if GC_CAN_COMPILE_COMPACTION
9096gc_get_auto_compact(
VALUE _)
9101# define gc_get_auto_compact rb_f_notimplement
9104#if GC_CAN_COMPILE_COMPACTION
9130gc_compact_stats(
VALUE self)
9133 VALUE h = rb_hash_new();
9134 VALUE considered = rb_hash_new();
9135 VALUE moved = rb_hash_new();
9136 VALUE moved_up = rb_hash_new();
9137 VALUE moved_down = rb_hash_new();
9139 for (
size_t i = 0; i <
T_MASK; i++) {
9140 if (
objspace->rcompactor.considered_count_table[i]) {
9141 rb_hash_aset(considered, type_sym(i),
SIZET2NUM(
objspace->rcompactor.considered_count_table[i]));
9144 if (
objspace->rcompactor.moved_count_table[i]) {
9145 rb_hash_aset(moved, type_sym(i),
SIZET2NUM(
objspace->rcompactor.moved_count_table[i]));
9148 if (
objspace->rcompactor.moved_up_count_table[i]) {
9149 rb_hash_aset(moved_up, type_sym(i),
SIZET2NUM(
objspace->rcompactor.moved_up_count_table[i]));
9152 if (
objspace->rcompactor.moved_down_count_table[i]) {
9153 rb_hash_aset(moved_down, type_sym(i),
SIZET2NUM(
objspace->rcompactor.moved_down_count_table[i]));
9157 rb_hash_aset(h,
ID2SYM(rb_intern(
"considered")), considered);
9158 rb_hash_aset(h,
ID2SYM(rb_intern(
"moved")), moved);
9159 rb_hash_aset(h,
ID2SYM(rb_intern(
"moved_up")), moved_up);
9160 rb_hash_aset(h,
ID2SYM(rb_intern(
"moved_down")), moved_down);
9165# define gc_compact_stats rb_f_notimplement
9168#if GC_CAN_COMPILE_COMPACTION
9187gc_compact(
VALUE self)
9190 int full_marking_p = gc_config_full_mark_val;
9191 gc_config_full_mark_set(TRUE);
9194 rb_gc_impl_start(rb_gc_get_objspace(),
true,
true,
true,
true);
9195 gc_config_full_mark_set(full_marking_p);
9197 return gc_compact_stats(self);
9200# define gc_compact rb_f_notimplement
9203#if GC_CAN_COMPILE_COMPACTION
9204struct desired_compaction_pages_i_data {
9206 size_t required_slots[HEAP_COUNT];
9210desired_compaction_pages_i(
struct heap_page *page,
void *data)
9212 struct desired_compaction_pages_i_data *tdata = data;
9215 VALUE vend = vstart + (
VALUE)(page->total_slots * page->heap->slot_size);
9218 for (
VALUE v = vstart; v != vend; v += page->heap->slot_size) {
9219 asan_unpoisoning_object(v) {
9223 size_t dest_pool_idx = dest_pool - heaps;
9224 tdata->required_slots[dest_pool_idx]++;
9248gc_verify_compaction_references(
int argc,
VALUE* argv,
VALUE self)
9250 static ID keywords[3] = {0};
9252 keywords[0] = rb_intern(
"toward");
9253 keywords[1] = rb_intern(
"double_heap");
9254 keywords[2] = rb_intern(
"expand_heap");
9261 int kwarg_count =
rb_get_kwargs(options, keywords, 0, 3, arguments);
9262 bool toward_empty = kwarg_count > 0 &&
SYMBOL_P(arguments[0]) &&
SYM2ID(arguments[0]) == rb_intern(
"empty");
9263 bool expand_heap = (kwarg_count > 1 &&
RTEST(arguments[1])) || (kwarg_count > 2 &&
RTEST(arguments[2]));
9268 rb_gc_impl_start(
objspace,
true,
true,
true,
false);
9270 unsigned int lev = RB_GC_VM_LOCK();
9276 struct desired_compaction_pages_i_data desired_compaction = {
9278 .required_slots = {0},
9281 objspace_each_pages(
objspace, desired_compaction_pages_i, &desired_compaction, TRUE);
9284 size_t max_existing_pages = 0;
9285 for (
int i = 0; i < HEAP_COUNT; i++) {
9287 max_existing_pages = MAX(max_existing_pages, heap->total_pages);
9291 for (
int i = 0; i < HEAP_COUNT; i++) {
9294 size_t pages_to_add = 0;
9301 pages_to_add += max_existing_pages - heap->total_pages;
9306 objspace->heap_pages.allocatable_slots = desired_compaction.required_slots[i];
9307 while (
objspace->heap_pages.allocatable_slots > 0) {
9308 heap_page_allocate_and_initialize(
objspace, heap);
9316 for (; pages_to_add > 0; pages_to_add--) {
9317 heap_page_allocate_and_initialize_force(
objspace, heap);
9323 objspace->rcompactor.compare_func = compare_free_slots;
9326 RB_GC_VM_UNLOCK(lev);
9328 rb_gc_impl_start(rb_gc_get_objspace(),
true,
true,
true,
true);
9330 rb_objspace_reachable_objects_from_root(root_obj_check_moved_i,
objspace);
9333 objspace->rcompactor.compare_func = NULL;
9335 return gc_compact_stats(self);
9338# define gc_verify_compaction_references rb_f_notimplement
9342rb_gc_impl_objspace_free(
void *objspace_ptr)
9347 rb_bug(
"lazy sweeping underway when freeing object space");
9352 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
9355 rb_darray_free_without_gc(
objspace->heap_pages.sorted);
9356 heap_pages_lomem = 0;
9357 heap_pages_himem = 0;
9359 for (
int i = 0; i < HEAP_COUNT; i++) {
9361 heap->total_pages = 0;
9362 heap->total_slots = 0;
9365 free_stack_chunks(&
objspace->mark_stack);
9366 mark_stack_free_cache(&
objspace->mark_stack);
9368 rb_darray_free_without_gc(
objspace->weak_references);
9373#if MALLOC_ALLOCATED_SIZE
9384gc_malloc_allocated_size(
VALUE self)
9400gc_malloc_allocations(
VALUE self)
9408rb_gc_impl_before_fork(
void *objspace_ptr)
9412 objspace->fork_vm_lock_lev = RB_GC_VM_LOCK();
9417rb_gc_impl_after_fork(
void *objspace_ptr, rb_pid_t pid)
9421 RB_GC_VM_UNLOCK(
objspace->fork_vm_lock_lev);
9425 rb_gc_ractor_newobj_cache_foreach(gc_ractor_newobj_cache_clear, NULL);
9429VALUE rb_ident_hash_new_with_size(st_index_t size);
9439rb_gcdebug_add_stress_to_class(
int argc,
VALUE *argv,
VALUE self)
9443 if (!stress_to_class) {
9444 set_stress_to_class(rb_ident_hash_new_with_size(argc));
9447 for (
int i = 0; i < argc; i++) {
9448 VALUE klass = argv[i];
9449 rb_hash_aset(stress_to_class, klass,
Qtrue);
9464rb_gcdebug_remove_stress_to_class(
int argc,
VALUE *argv,
VALUE self)
9468 if (stress_to_class) {
9469 for (
int i = 0; i < argc; ++i) {
9470 rb_hash_delete(stress_to_class, argv[i]);
9473 if (rb_hash_size(stress_to_class) == 0) {
9474 stress_to_class = 0;
9482rb_gc_impl_objspace_alloc(
void)
9490rb_gc_impl_objspace_init(
void *objspace_ptr)
9494 gc_config_full_mark_set(TRUE);
9497 malloc_limit = gc_params.malloc_limit_min;
9499 if (
objspace->finalize_deferred_pjob == POSTPONED_JOB_HANDLE_INVALID) {
9500 rb_bug(
"Could not preregister postponed job for GC");
9503 for (
int i = 0; i < HEAP_COUNT; i++) {
9506 heap->slot_size = (1 << i) * BASE_SLOT_SIZE;
9509 static const bits_t slot_bits_masks[] = {
9511 (bits_t)0x5555555555555555ULL,
9512 (bits_t)0x1111111111111111ULL,
9513 (bits_t)0x0101010101010101ULL,
9514 (bits_t)0x0001000100010001ULL,
9516 GC_ASSERT(HEAP_COUNT ==
sizeof(slot_bits_masks) /
sizeof(slot_bits_masks[0]));
9517 heap->slot_bits_mask = slot_bits_masks[i];
9519 ccan_list_head_init(&heap->pages);
9522 rb_darray_make_without_gc(&
objspace->heap_pages.sorted, 0);
9523 rb_darray_make_without_gc(&
objspace->weak_references, 0);
9530#if defined(INIT_HEAP_PAGE_ALLOC_USE_MMAP)
9532 heap_page_alloc_use_mmap = INIT_HEAP_PAGE_ALLOC_USE_MMAP;
9534#if RGENGC_ESTIMATE_OLDMALLOC
9535 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
9538 for (
int i = 0; i < HEAP_COUNT; i++) {
9540 gc_params.heap_init_slots[i] = GC_HEAP_INIT_SLOTS;
9543 init_mark_stack(&
objspace->mark_stack);
9545 objspace->profile.invoke_time = getrusage_time();
9546 finalizer_table = st_init_numtable();
9550rb_gc_impl_init(
void)
9552 VALUE gc_constants = rb_hash_new();
9553 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"DEBUG")), GC_DEBUG ?
Qtrue :
Qfalse);
9554 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"BASE_SLOT_SIZE")),
SIZET2NUM(BASE_SLOT_SIZE - RVALUE_OVERHEAD));
9556 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RVALUE_OVERHEAD")),
SIZET2NUM(RVALUE_OVERHEAD));
9557 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_PAGE_OBJ_LIMIT")),
SIZET2NUM(HEAP_PAGE_OBJ_LIMIT));
9558 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_PAGE_BITMAP_SIZE")),
SIZET2NUM(HEAP_PAGE_BITMAP_SIZE));
9559 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_PAGE_SIZE")),
SIZET2NUM(HEAP_PAGE_SIZE));
9560 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_COUNT")),
LONG2FIX(HEAP_COUNT));
9561 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RVARGC_MAX_ALLOCATE_SIZE")),
LONG2FIX(heap_slot_size(HEAP_COUNT - 1)));
9562 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RVALUE_OLD_AGE")),
LONG2FIX(RVALUE_OLD_AGE));
9563 if (RB_BUG_INSTEAD_OF_RB_MEMERROR+0) {
9564 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RB_BUG_INSTEAD_OF_RB_MEMERROR")),
Qtrue);
9568 rb_define_const(
rb_mGC,
"INTERNAL_CONSTANTS", gc_constants);
9570 if (GC_COMPACTION_SUPPORTED) {
9585 if (GC_DEBUG_STRESS_TO_CLASS) {
9593#if MALLOC_ALLOCATED_SIZE
9612#define OPT(o) if (o) rb_ary_push(opts, rb_interned_str(#o, sizeof(#o) - 1))
9616 OPT(RGENGC_CHECK_MODE);
9617 OPT(RGENGC_PROFILE);
9618 OPT(RGENGC_ESTIMATE_OLDMALLOC);
9619 OPT(GC_PROFILE_MORE_DETAIL);
9620 OPT(GC_ENABLE_LAZY_SWEEP);
9621 OPT(CALC_EXACT_MALLOC_SIZE);
9622 OPT(MALLOC_ALLOCATED_SIZE);
9623 OPT(MALLOC_ALLOCATED_SIZE_CHECK);
9624 OPT(GC_PROFILE_DETAIL_MEMORY);
9625 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.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
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.)