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_BYTES
113#define GC_HEAP_INIT_BYTES (2560 * 1024)
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_BYTES
122#define GC_HEAP_GROWTH_MAX_BYTES 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_bytes;
206 size_t heap_free_slots;
207 double growth_factor;
208 size_t growth_max_bytes;
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;
228 GC_HEAP_GROWTH_FACTOR,
229 GC_HEAP_GROWTH_MAX_BYTES,
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
305#ifndef VERIFY_FREE_SIZE
307#define VERIFY_FREE_SIZE 1
309#define VERIFY_FREE_SIZE 0
314#undef CALC_EXACT_MALLOC_SIZE
315#define CALC_EXACT_MALLOC_SIZE 1
318#ifndef CALC_EXACT_MALLOC_SIZE
319# define CALC_EXACT_MALLOC_SIZE 0
322#if defined(HAVE_MALLOC_USABLE_SIZE) || CALC_EXACT_MALLOC_SIZE > 0
323# ifndef MALLOC_ALLOCATED_SIZE
324# define MALLOC_ALLOCATED_SIZE 0
327# define MALLOC_ALLOCATED_SIZE 0
329#ifndef MALLOC_ALLOCATED_SIZE_CHECK
330# define MALLOC_ALLOCATED_SIZE_CHECK 0
333#ifndef GC_DEBUG_STRESS_TO_CLASS
334# define GC_DEBUG_STRESS_TO_CLASS RUBY_DEBUG
338 GPR_FLAG_NONE = 0x000,
340 GPR_FLAG_MAJOR_BY_NOFREE = 0x001,
341 GPR_FLAG_MAJOR_BY_OLDGEN = 0x002,
342 GPR_FLAG_MAJOR_BY_SHADY = 0x004,
343 GPR_FLAG_MAJOR_BY_FORCE = 0x008,
344#if RGENGC_ESTIMATE_OLDMALLOC
345 GPR_FLAG_MAJOR_BY_OLDMALLOC = 0x020,
347 GPR_FLAG_MAJOR_MASK = 0x0ff,
350 GPR_FLAG_NEWOBJ = 0x100,
351 GPR_FLAG_MALLOC = 0x200,
352 GPR_FLAG_METHOD = 0x400,
353 GPR_FLAG_CAPI = 0x800,
354 GPR_FLAG_STRESS = 0x1000,
357 GPR_FLAG_IMMEDIATE_SWEEP = 0x2000,
358 GPR_FLAG_HAVE_FINALIZE = 0x4000,
359 GPR_FLAG_IMMEDIATE_MARK = 0x8000,
360 GPR_FLAG_FULL_MARK = 0x10000,
361 GPR_FLAG_COMPACT = 0x20000,
364 (GPR_FLAG_FULL_MARK | GPR_FLAG_IMMEDIATE_MARK |
365 GPR_FLAG_IMMEDIATE_SWEEP | GPR_FLAG_CAPI),
366} gc_profile_record_flag;
372 double gc_invoke_time;
374 size_t heap_total_objects;
375 size_t heap_use_size;
376 size_t heap_total_size;
377 size_t moved_objects;
379#if GC_PROFILE_MORE_DETAIL
381 double gc_sweep_time;
383 size_t heap_use_pages;
384 size_t heap_live_objects;
385 size_t heap_free_objects;
387 size_t allocate_increase;
388 size_t allocate_limit;
391 size_t removing_objects;
392 size_t empty_objects;
393#if GC_PROFILE_DETAIL_MEMORY
399#if MALLOC_ALLOCATED_SIZE
400 size_t allocated_size;
403#if RGENGC_PROFILE > 0
405 size_t remembered_normal_objects;
406 size_t remembered_shady_objects;
414 uint32_t original_shape_id;
417#define RMOVED(obj) ((struct RMoved *)(obj))
419typedef uintptr_t bits_t;
421 BITS_SIZE =
sizeof(bits_t),
422 BITS_BITLENGTH = ( BITS_SIZE * CHAR_BIT )
435#define STACK_CHUNK_SIZE 500
438 VALUE data[STACK_CHUNK_SIZE];
448 size_t unused_cache_size;
451typedef int (*gc_compact_compare_func)(
const void *l,
const void *r,
void *d);
457 size_t total_allocated_pages;
458 size_t force_major_gc_count;
459 size_t force_incremental_marking_finish_count;
460 size_t total_allocated_objects;
461 size_t total_freed_objects;
462 size_t final_slots_count;
469 struct ccan_list_head pages;
472 uintptr_t compact_cursor_index;
481 gc_stress_no_immediate_sweep,
482 gc_stress_full_mark_after_malloc,
496#if RGENGC_ESTIMATE_OLDMALLOC
497 size_t oldmalloc_increase;
503#if MALLOC_ALLOCATED_SIZE
504 size_t allocated_size;
514 unsigned int mode : 2;
515 unsigned int immediate_sweep : 1;
516 unsigned int dont_gc : 1;
517 unsigned int dont_incremental : 1;
518 unsigned int during_gc : 1;
519 unsigned int during_compacting : 1;
520 unsigned int during_reference_updating : 1;
521 unsigned int gc_stressful: 1;
522 unsigned int during_minor_gc : 1;
523 unsigned int during_incremental_marking : 1;
524 unsigned int measure_gc : 1;
530 size_t empty_pages_count;
543 size_t allocated_pages;
546 size_t freeable_pages;
548 size_t allocatable_bytes;
551 VALUE deferred_final;
558 unsigned int latest_gc_info;
564#if GC_PROFILE_MORE_DETAIL
569 size_t minor_gc_count;
570 size_t major_gc_count;
571 size_t compact_count;
572 size_t read_barrier_faults;
573#if RGENGC_PROFILE > 0
574 size_t total_generated_normal_object_count;
575 size_t total_generated_shady_object_count;
576 size_t total_shade_operation_count;
577 size_t total_promoted_count;
578 size_t total_remembered_normal_object_count;
579 size_t total_remembered_shady_object_count;
581#if RGENGC_PROFILE >= 2
582 size_t generated_normal_object_count_types[
RUBY_T_MASK];
583 size_t generated_shady_object_count_types[
RUBY_T_MASK];
586 size_t remembered_normal_object_count_types[
RUBY_T_MASK];
587 size_t remembered_shady_object_count_types[
RUBY_T_MASK];
592 double gc_sweep_start_time;
593 size_t total_allocated_objects_at_gc_start;
594 size_t heap_used_at_gc_start;
595 size_t heap_total_slots_at_gc_start;
599 unsigned long long marking_time_ns;
601 unsigned long long sweeping_time_ns;
602 struct timespec sweeping_start_time;
605 size_t weak_references_count;
608 VALUE gc_stress_mode;
611 bool parent_object_old_p;
615 size_t last_major_gc;
616 size_t uncollectible_wb_unprotected_objects;
617 size_t uncollectible_wb_unprotected_objects_limit;
619 size_t old_objects_limit;
621#if RGENGC_ESTIMATE_OLDMALLOC
622 size_t oldmalloc_increase_limit;
625#if RGENGC_CHECK_MODE >= 2
632 size_t considered_count_table[
T_MASK];
633 size_t moved_count_table[
T_MASK];
634 size_t moved_up_count_table[
T_MASK];
635 size_t moved_down_count_table[
T_MASK];
639 gc_compact_compare_func compare_func;
647#if GC_DEBUG_STRESS_TO_CLASS
648 VALUE stress_to_class;
651 rb_darray(
VALUE) weak_references;
654 unsigned long live_ractor_cache_count;
656 int fork_vm_lock_lev;
659#ifndef HEAP_PAGE_ALIGN_LOG
661#define HEAP_PAGE_ALIGN_LOG 16
664#if RACTOR_CHECK_MODE || GC_DEBUG
665struct rvalue_overhead {
666# if RACTOR_CHECK_MODE
667 uint32_t _ractor_belonging_id;
676# define RVALUE_OVERHEAD (sizeof(struct { \
678 struct rvalue_overhead overhead; \
682size_t rb_gc_impl_obj_slot_size(
VALUE obj);
683# define GET_RVALUE_OVERHEAD(obj) ((struct rvalue_overhead *)((uintptr_t)obj + rb_gc_impl_obj_slot_size(obj)))
685# ifndef RVALUE_OVERHEAD
686# define RVALUE_OVERHEAD 0
690#define RVALUE_SLOT_SIZE (sizeof(struct RBasic) + sizeof(VALUE[RBIMPL_RVALUE_EMBED_LEN_MAX]) + RVALUE_OVERHEAD)
692static const size_t pool_slot_sizes[HEAP_COUNT] = {
694 RVALUE_SLOT_SIZE * 2,
695 RVALUE_SLOT_SIZE * 4,
696 RVALUE_SLOT_SIZE * 8,
697 RVALUE_SLOT_SIZE * 16,
700static uint8_t size_to_heap_idx[RVALUE_SLOT_SIZE * (1 << (HEAP_COUNT - 1)) / 8 + 1];
703# define MAX(a, b) (((a) > (b)) ? (a) : (b))
706# define MIN(a, b) (((a) < (b)) ? (a) : (b))
708#define roomof(x, y) (((x) + (y) - 1) / (y))
709#define CEILDIV(i, mod) roomof(i, mod)
711 HEAP_PAGE_ALIGN = (1UL << HEAP_PAGE_ALIGN_LOG),
712 HEAP_PAGE_ALIGN_MASK = (~(~0UL << HEAP_PAGE_ALIGN_LOG)),
713 HEAP_PAGE_SIZE = HEAP_PAGE_ALIGN,
714 HEAP_PAGE_BITMAP_LIMIT = CEILDIV(CEILDIV(HEAP_PAGE_SIZE, RVALUE_SLOT_SIZE), BITS_BITLENGTH),
715 HEAP_PAGE_BITMAP_SIZE = (BITS_SIZE * HEAP_PAGE_BITMAP_LIMIT),
717#define HEAP_PAGE_ALIGN (1 << HEAP_PAGE_ALIGN_LOG)
718#define HEAP_PAGE_SIZE HEAP_PAGE_ALIGN
720#if !defined(INCREMENTAL_MARK_STEP_ALLOCATIONS)
721# define INCREMENTAL_MARK_STEP_ALLOCATIONS 500
724#undef INIT_HEAP_PAGE_ALLOC_USE_MMAP
730static const bool HEAP_PAGE_ALLOC_USE_MMAP =
false;
732#elif defined(__wasm__)
736static const bool HEAP_PAGE_ALLOC_USE_MMAP =
false;
738#elif HAVE_CONST_PAGE_SIZE
740static const bool HEAP_PAGE_ALLOC_USE_MMAP = (PAGE_SIZE <= HEAP_PAGE_SIZE);
742#elif defined(PAGE_MAX_SIZE) && (PAGE_MAX_SIZE <= HEAP_PAGE_SIZE)
744static const bool HEAP_PAGE_ALLOC_USE_MMAP =
true;
746#elif defined(PAGE_SIZE)
748# define INIT_HEAP_PAGE_ALLOC_USE_MMAP (PAGE_SIZE <= HEAP_PAGE_SIZE)
750#elif defined(HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
752# define INIT_HEAP_PAGE_ALLOC_USE_MMAP (sysconf(_SC_PAGE_SIZE) <= HEAP_PAGE_SIZE)
756static const bool HEAP_PAGE_ALLOC_USE_MMAP =
false;
759#ifdef INIT_HEAP_PAGE_ALLOC_USE_MMAP
761# define HEAP_PAGE_ALLOC_USE_MMAP (heap_page_alloc_use_mmap != false)
763static bool heap_page_alloc_use_mmap;
766#define RVALUE_AGE_BIT_COUNT 2
767#define RVALUE_AGE_BIT_MASK (((bits_t)1 << RVALUE_AGE_BIT_COUNT) - 1)
768#define RVALUE_OLD_AGE 3
776 unsigned short slot_size;
777 uint32_t slot_div_magic;
778 unsigned short total_slots;
779 unsigned short free_slots;
780 unsigned short final_slots;
781 unsigned short pinned_slots;
783 unsigned int before_sweep : 1;
784 unsigned int has_remembered_objects : 1;
785 unsigned int has_uncollectible_wb_unprotected_objects : 1;
794 struct ccan_list_node page_node;
796 bits_t wb_unprotected_bits[HEAP_PAGE_BITMAP_LIMIT];
798 bits_t mark_bits[HEAP_PAGE_BITMAP_LIMIT];
799 bits_t uncollectible_bits[HEAP_PAGE_BITMAP_LIMIT];
800 bits_t marking_bits[HEAP_PAGE_BITMAP_LIMIT];
802 bits_t remembered_bits[HEAP_PAGE_BITMAP_LIMIT];
805 bits_t pinned_bits[HEAP_PAGE_BITMAP_LIMIT];
806 bits_t age_bits[HEAP_PAGE_BITMAP_LIMIT * RVALUE_AGE_BIT_COUNT];
813asan_lock_freelist(
struct heap_page *page)
815 asan_poison_memory_region(&page->freelist,
sizeof(
struct free_list *));
822asan_unlock_freelist(
struct heap_page *page)
824 asan_unpoison_memory_region(&page->freelist,
sizeof(
struct free_list *),
false);
830 if (page->total_slots == 0) {
831 GC_ASSERT(page->start == 0);
832 GC_ASSERT(page->slot_size == 0);
833 GC_ASSERT(page->heap == NULL);
834 GC_ASSERT(page->free_slots == 0);
835 asan_unpoisoning_memory_region(&page->freelist,
sizeof(&page->freelist)) {
836 GC_ASSERT(page->freelist == NULL);
842 GC_ASSERT(page->start != 0);
843 GC_ASSERT(page->slot_size != 0);
844 GC_ASSERT(page->heap != NULL);
850#define GET_PAGE_BODY(x) ((struct heap_page_body *)((bits_t)(x) & ~(HEAP_PAGE_ALIGN_MASK)))
851#define GET_PAGE_HEADER(x) (&GET_PAGE_BODY(x)->header)
852#define GET_HEAP_PAGE(x) (GET_PAGE_HEADER(x)->page)
854static uint32_t slot_div_magics[HEAP_COUNT];
857slot_index_for_offset(
size_t offset, uint32_t div_magic)
859 return (
size_t)(((uint64_t)offset * div_magic) >> 32);
862#define SLOT_INDEX(page, p) slot_index_for_offset((uintptr_t)(p) - (page)->start, (page)->slot_div_magic)
863#define SLOT_BITMAP_INDEX(page, p) (SLOT_INDEX(page, p) / BITS_BITLENGTH)
864#define SLOT_BITMAP_OFFSET(page, p) (SLOT_INDEX(page, p) & (BITS_BITLENGTH - 1))
865#define SLOT_BITMAP_BIT(page, p) ((bits_t)1 << SLOT_BITMAP_OFFSET(page, p))
867#define _MARKED_IN_BITMAP(bits, page, p) ((bits)[SLOT_BITMAP_INDEX(page, p)] & SLOT_BITMAP_BIT(page, p))
868#define _MARK_IN_BITMAP(bits, page, p) ((bits)[SLOT_BITMAP_INDEX(page, p)] |= SLOT_BITMAP_BIT(page, p))
869#define _CLEAR_IN_BITMAP(bits, page, p) ((bits)[SLOT_BITMAP_INDEX(page, p)] &= ~SLOT_BITMAP_BIT(page, p))
871#define MARKED_IN_BITMAP(bits, p) _MARKED_IN_BITMAP(bits, GET_HEAP_PAGE(p), p)
872#define MARK_IN_BITMAP(bits, p) _MARK_IN_BITMAP(bits, GET_HEAP_PAGE(p), p)
873#define CLEAR_IN_BITMAP(bits, p) _CLEAR_IN_BITMAP(bits, GET_HEAP_PAGE(p), p)
875#define GET_HEAP_MARK_BITS(x) (&GET_HEAP_PAGE(x)->mark_bits[0])
876#define GET_HEAP_PINNED_BITS(x) (&GET_HEAP_PAGE(x)->pinned_bits[0])
877#define GET_HEAP_UNCOLLECTIBLE_BITS(x) (&GET_HEAP_PAGE(x)->uncollectible_bits[0])
878#define GET_HEAP_WB_UNPROTECTED_BITS(x) (&GET_HEAP_PAGE(x)->wb_unprotected_bits[0])
879#define GET_HEAP_MARKING_BITS(x) (&GET_HEAP_PAGE(x)->marking_bits[0])
882RVALUE_AGE_GET(
VALUE obj)
884 struct heap_page *page = GET_HEAP_PAGE(obj);
885 bits_t *age_bits = page->age_bits;
886 size_t slot_idx = SLOT_INDEX(page, obj);
887 size_t idx = (slot_idx / BITS_BITLENGTH) * 2;
888 int shift = (int)(slot_idx & (BITS_BITLENGTH - 1));
889 int lo = (age_bits[idx] >> shift) & 1;
890 int hi = (age_bits[idx + 1] >> shift) & 1;
891 return lo | (hi << 1);
895RVALUE_AGE_SET_BITMAP(
VALUE obj,
int age)
898 struct heap_page *page = GET_HEAP_PAGE(obj);
899 bits_t *age_bits = page->age_bits;
900 size_t slot_idx = SLOT_INDEX(page, obj);
901 size_t idx = (slot_idx / BITS_BITLENGTH) * 2;
902 int shift = (int)(slot_idx & (BITS_BITLENGTH - 1));
903 bits_t mask = (bits_t)1 << shift;
905 age_bits[idx] = (age_bits[idx] & ~mask) | ((bits_t)(age & 1) << shift);
906 age_bits[idx + 1] = (age_bits[idx + 1] & ~mask) | ((bits_t)((age >> 1) & 1) << shift);
910RVALUE_AGE_SET(
VALUE obj,
int age)
912 RVALUE_AGE_SET_BITMAP(obj, age);
913 if (age == RVALUE_OLD_AGE) {
921#define malloc_limit objspace->malloc_params.limit
922#define malloc_increase objspace->malloc_counters.increase
923#define malloc_allocated_size objspace->malloc_params.allocated_size
924#define heap_pages_lomem objspace->heap_pages.range[0]
925#define heap_pages_himem objspace->heap_pages.range[1]
926#define heap_pages_freeable_pages objspace->heap_pages.freeable_pages
927#define heap_pages_deferred_final objspace->heap_pages.deferred_final
928#define heaps objspace->heaps
929#define during_gc objspace->flags.during_gc
930#define finalizing objspace->atomic_flags.finalizing
931#define finalizer_table objspace->finalizer_table
932#define ruby_gc_stressful objspace->flags.gc_stressful
933#define ruby_gc_stress_mode objspace->gc_stress_mode
934#if GC_DEBUG_STRESS_TO_CLASS
935#define stress_to_class objspace->stress_to_class
936#define set_stress_to_class(c) (stress_to_class = (c))
938#define stress_to_class ((void)objspace, 0)
939#define set_stress_to_class(c) ((void)objspace, (c))
943#define dont_gc_on() (fprintf(stderr, "dont_gc_on@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = 1)
944#define dont_gc_off() (fprintf(stderr, "dont_gc_off@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = 0)
945#define dont_gc_set(b) (fprintf(stderr, "dont_gc_set(%d)@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = (int)(b))
946#define dont_gc_val() (objspace->flags.dont_gc)
948#define dont_gc_on() (objspace->flags.dont_gc = 1)
949#define dont_gc_off() (objspace->flags.dont_gc = 0)
950#define dont_gc_set(b) (objspace->flags.dont_gc = (int)(b))
951#define dont_gc_val() (objspace->flags.dont_gc)
954#define gc_config_full_mark_set(b) (objspace->gc_config.full_mark = (int)(b))
955#define gc_config_full_mark_val (objspace->gc_config.full_mark)
957#ifndef DURING_GC_COULD_MALLOC_REGION_START
958# define DURING_GC_COULD_MALLOC_REGION_START() \
959 assert(rb_during_gc()); \
960 bool _prev_enabled = rb_gc_impl_gc_enabled_p(objspace); \
961 rb_gc_impl_gc_disable(objspace, false)
964#ifndef DURING_GC_COULD_MALLOC_REGION_END
965# define DURING_GC_COULD_MALLOC_REGION_END() \
966 if (_prev_enabled) rb_gc_impl_gc_enable(objspace)
969static inline enum gc_mode
970gc_mode_verify(
enum gc_mode mode)
972#if RGENGC_CHECK_MODE > 0
975 case gc_mode_marking:
976 case gc_mode_sweeping:
977 case gc_mode_compacting:
980 rb_bug(
"gc_mode_verify: unreachable (%d)", (
int)mode);
989 for (
int i = 0; i < HEAP_COUNT; i++) {
990 if ((&heaps[i])->sweeping_page) {
1001 for (
int i = 0; i < HEAP_COUNT; i++) {
1002 count += (&heaps[i])->total_pages;
1011 for (
int i = 0; i < HEAP_COUNT; i++) {
1013 count += heap->total_allocated_objects;
1022 for (
int i = 0; i < HEAP_COUNT; i++) {
1024 count += heap->total_freed_objects;
1033 for (
int i = 0; i < HEAP_COUNT; i++) {
1035 count += heap->final_slots_count;
1040#define gc_mode(objspace) gc_mode_verify((enum gc_mode)(objspace)->flags.mode)
1041#define gc_mode_set(objspace, m) ((objspace)->flags.mode = (unsigned int)gc_mode_verify(m))
1042#define gc_needs_major_flags objspace->rgengc.need_major_gc
1044#define is_marking(objspace) (gc_mode(objspace) == gc_mode_marking)
1045#define is_sweeping(objspace) (gc_mode(objspace) == gc_mode_sweeping)
1046#define is_full_marking(objspace) ((objspace)->flags.during_minor_gc == FALSE)
1047#define is_incremental_marking(objspace) ((objspace)->flags.during_incremental_marking != FALSE)
1048#define will_be_incremental_marking(objspace) ((objspace)->rgengc.need_major_gc != GPR_FLAG_NONE)
1049#define GC_INCREMENTAL_SWEEP_SLOT_COUNT 2048
1050#define GC_INCREMENTAL_SWEEP_POOL_SLOT_COUNT 1024
1051#define is_lazy_sweeping(objspace) (GC_ENABLE_LAZY_SWEEP && has_sweeping_pages(objspace))
1053#define needs_continue_sweeping(objspace, heap) \
1054 ((heap)->free_pages == NULL && is_lazy_sweeping(objspace))
1056#if SIZEOF_LONG == SIZEOF_VOIDP
1057# define obj_id_to_ref(objid) ((objid) ^ FIXNUM_FLAG)
1058#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
1059# define obj_id_to_ref(objid) (FIXNUM_P(objid) ? \
1060 ((objid) ^ FIXNUM_FLAG) : (NUM2PTR(objid) << 1))
1062# error not supported
1068 void (*dfree)(
void *);
1072#define RZOMBIE(o) ((struct RZombie *)(o))
1074static bool ruby_enable_autocompact =
false;
1075#if RGENGC_CHECK_MODE
1076static gc_compact_compare_func ruby_autocompact_compare_func;
1080static int garbage_collect(
rb_objspace_t *,
unsigned int reason);
1085enum gc_enter_event {
1086 gc_enter_event_start,
1087 gc_enter_event_continue,
1088 gc_enter_event_rest,
1089 gc_enter_event_finalizer,
1092static inline void gc_enter(
rb_objspace_t *
objspace,
enum gc_enter_event event,
unsigned int *lock_lev);
1093static inline void gc_exit(
rb_objspace_t *
objspace,
enum gc_enter_event event,
unsigned int *lock_lev);
1108static int gc_mark_stacked_objects_incremental(
rb_objspace_t *,
size_t count);
1109NO_SANITIZE(
"memory",
static inline bool is_pointer_to_heap(
rb_objspace_t *
objspace,
const void *ptr));
1111static void gc_verify_internal_consistency(
void *objspace_ptr);
1113static double getrusage_time(
void);
1117static inline void gc_prof_mark_timer_start(
rb_objspace_t *);
1119static inline void gc_prof_sweep_timer_start(
rb_objspace_t *);
1120static inline void gc_prof_sweep_timer_stop(
rb_objspace_t *);
1124#define gc_prof_record(objspace) (objspace)->profile.current_record
1125#define gc_prof_enabled(objspace) ((objspace)->profile.run && (objspace)->profile.current_record)
1127#ifdef HAVE_VA_ARGS_MACRO
1128# define gc_report(level, objspace, ...) \
1129 if (!RGENGC_DEBUG_ENABLED(level)) {} else gc_report_body(level, objspace, __VA_ARGS__)
1131# define gc_report if (!RGENGC_DEBUG_ENABLED(0)) {} else gc_report_body
1133PRINTF_ARGS(
static void gc_report_body(
int level,
rb_objspace_t *
objspace,
const char *fmt, ...), 3, 4);
1135static void gc_finalize_deferred(
void *dmy);
1146#if defined(__GNUC__) && defined(__i386__)
1147typedef unsigned long long tick_t;
1148#define PRItick "llu"
1152 unsigned long long int x;
1153 __asm__ __volatile__ (
"rdtsc" :
"=A" (x));
1157#elif defined(__GNUC__) && defined(__x86_64__)
1158typedef unsigned long long tick_t;
1159#define PRItick "llu"
1161static __inline__ tick_t
1164 unsigned long hi, lo;
1165 __asm__ __volatile__ (
"rdtsc" :
"=a"(lo),
"=d"(hi));
1166 return ((
unsigned long long)lo)|( ((
unsigned long long)hi)<<32);
1169#elif defined(__powerpc64__) && (GCC_VERSION_SINCE(4,8,0) || defined(__clang__))
1170typedef unsigned long long tick_t;
1171#define PRItick "llu"
1173static __inline__ tick_t
1176 unsigned long long val = __builtin_ppc_get_timebase();
1180#elif defined(__POWERPC__) && defined(__APPLE__)
1184typedef unsigned long long tick_t;
1185#define PRItick "llu"
1187static __inline__ tick_t
1190 unsigned long int upper, lower, tmp;
1191 # define mftbu(r) __asm__ volatile("mftbu %0" : "=r"(r))
1192 # define mftb(r) __asm__ volatile("mftb %0" : "=r"(r))
1197 }
while (tmp != upper);
1198 return ((tick_t)upper << 32) | lower;
1201#elif defined(__aarch64__) && defined(__GNUC__)
1202typedef unsigned long tick_t;
1205static __inline__ tick_t
1209 __asm__ __volatile__ (
"mrs %0, cntvct_el0" :
"=r" (val));
1214#elif defined(_WIN32) && defined(_MSC_VER)
1216typedef unsigned __int64 tick_t;
1217#define PRItick "llu"
1226typedef clock_t tick_t;
1227#define PRItick "llu"
1236#define MEASURE_LINE(expr) expr
1241#define RVALUE_MARKED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_MARK_BITS(obj), (obj))
1242#define RVALUE_WB_UNPROTECTED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), (obj))
1243#define RVALUE_MARKING_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), (obj))
1244#define RVALUE_UNCOLLECTIBLE_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(obj), (obj))
1245#define RVALUE_PINNED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_PINNED_BITS(obj), (obj))
1250 check_rvalue_consistency(
objspace, obj);
1251 return RVALUE_MARKED_BITMAP(obj) != 0;
1257 check_rvalue_consistency(
objspace, obj);
1258 return RVALUE_PINNED_BITMAP(obj) != 0;
1264 check_rvalue_consistency(
objspace, obj);
1265 return RVALUE_WB_UNPROTECTED_BITMAP(obj) != 0;
1271 check_rvalue_consistency(
objspace, obj);
1272 return RVALUE_MARKING_BITMAP(obj) != 0;
1278 check_rvalue_consistency(
objspace, obj);
1279 return MARKED_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj) != 0;
1285 check_rvalue_consistency(
objspace, obj);
1286 return RVALUE_UNCOLLECTIBLE_BITMAP(obj) != 0;
1289#define RVALUE_PAGE_WB_UNPROTECTED(page, obj) MARKED_IN_BITMAP((page)->wb_unprotected_bits, (obj))
1290#define RVALUE_PAGE_UNCOLLECTIBLE(page, obj) MARKED_IN_BITMAP((page)->uncollectible_bits, (obj))
1291#define RVALUE_PAGE_MARKING(page, obj) MARKED_IN_BITMAP((page)->marking_bits, (obj))
1302 int lev = RB_GC_VM_LOCK_NO_BARRIER();
1305 fprintf(stderr,
"check_rvalue_consistency: %p is a special const.\n", (
void *)obj);
1308 else if (!is_pointer_to_heap(
objspace, (
void *)obj)) {
1310 while (empty_page) {
1311 if ((uintptr_t)empty_page->body <= (uintptr_t)obj &&
1312 (uintptr_t)obj < (uintptr_t)empty_page->body + HEAP_PAGE_SIZE) {
1313 GC_ASSERT(heap_page_in_global_empty_pages_pool(
objspace, empty_page));
1314 fprintf(stderr,
"check_rvalue_consistency: %p is in an empty page (%p).\n",
1315 (
void *)obj, (
void *)empty_page);
1320 fprintf(stderr,
"check_rvalue_consistency: %p is not a Ruby object.\n", (
void *)obj);
1326 const int wb_unprotected_bit = RVALUE_WB_UNPROTECTED_BITMAP(obj) != 0;
1327 const int uncollectible_bit = RVALUE_UNCOLLECTIBLE_BITMAP(obj) != 0;
1328 const int mark_bit = RVALUE_MARKED_BITMAP(obj) != 0;
1329 const int marking_bit = RVALUE_MARKING_BITMAP(obj) != 0;
1330 const int remembered_bit = MARKED_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj) != 0;
1331 const int age = RVALUE_AGE_GET((
VALUE)obj);
1333 if (heap_page_in_global_empty_pages_pool(
objspace, GET_HEAP_PAGE(obj))) {
1334 fprintf(stderr,
"check_rvalue_consistency: %s is in tomb page.\n", rb_obj_info(obj));
1338 fprintf(stderr,
"check_rvalue_consistency: %s is T_NONE.\n", rb_obj_info(obj));
1342 fprintf(stderr,
"check_rvalue_consistency: %s is T_ZOMBIE.\n", rb_obj_info(obj));
1347 rb_obj_memsize_of((
VALUE)obj);
1354 if (age > 0 && wb_unprotected_bit) {
1355 fprintf(stderr,
"check_rvalue_consistency: %s is not WB protected, but age is %d > 0.\n", rb_obj_info(obj), age);
1359 if (!is_marking(
objspace) && uncollectible_bit && !mark_bit) {
1360 fprintf(stderr,
"check_rvalue_consistency: %s is uncollectible, but is not marked while !gc.\n", rb_obj_info(obj));
1365 if (uncollectible_bit && age != RVALUE_OLD_AGE && !wb_unprotected_bit) {
1366 fprintf(stderr,
"check_rvalue_consistency: %s is uncollectible, but not old (age: %d) and not WB unprotected.\n",
1367 rb_obj_info(obj), age);
1370 if (remembered_bit && age != RVALUE_OLD_AGE) {
1371 fprintf(stderr,
"check_rvalue_consistency: %s is remembered, but not old (age: %d).\n",
1372 rb_obj_info(obj), age);
1384 if (is_incremental_marking(
objspace) && marking_bit) {
1385 if (!is_marking(
objspace) && !mark_bit) {
1386 fprintf(stderr,
"check_rvalue_consistency: %s is marking, but not marked.\n", rb_obj_info(obj));
1392 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
1394 if (err > 0 && terminate) {
1395 rb_bug(
"check_rvalue_consistency_force: there is %d errors.", err);
1400#if RGENGC_CHECK_MODE == 0
1410 check_rvalue_consistency_force(
objspace, obj, TRUE);
1420 asan_unpoisoning_object(obj) {
1430 check_rvalue_consistency(
objspace, obj);
1439 MARK_IN_BITMAP(&page->uncollectible_bits[0], obj);
1442#if RGENGC_PROFILE >= 2
1443 objspace->profile.total_promoted_count++;
1451 RB_DEBUG_COUNTER_INC(obj_promote);
1452 RVALUE_PAGE_OLD_UNCOLLECTIBLE_SET(
objspace, GET_HEAP_PAGE(obj), obj);
1459 int age = RVALUE_AGE_GET((
VALUE)obj);
1461 if (RGENGC_CHECK_MODE && age == RVALUE_OLD_AGE) {
1462 rb_bug(
"RVALUE_AGE_INC: can not increment age of OLD object %s.", rb_obj_info(obj));
1466 RVALUE_AGE_SET(obj, age);
1468 if (age == RVALUE_OLD_AGE) {
1469 RVALUE_OLD_UNCOLLECTIBLE_SET(
objspace, obj);
1472 check_rvalue_consistency(
objspace, obj);
1478 check_rvalue_consistency(
objspace, obj);
1479 GC_ASSERT(!RVALUE_OLD_P(
objspace, obj));
1480 RVALUE_AGE_SET(obj, RVALUE_OLD_AGE - 1);
1481 check_rvalue_consistency(
objspace, obj);
1485RVALUE_AGE_RESET(
VALUE obj)
1487 RVALUE_AGE_SET(obj, 0);
1493 check_rvalue_consistency(
objspace, obj);
1494 GC_ASSERT(RVALUE_OLD_P(
objspace, obj));
1496 if (!is_incremental_marking(
objspace) && RVALUE_REMEMBERED(
objspace, obj)) {
1497 CLEAR_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj);
1500 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(obj), obj);
1501 RVALUE_AGE_RESET(obj);
1503 if (RVALUE_MARKED(
objspace, obj)) {
1507 check_rvalue_consistency(
objspace, obj);
1519 return !RVALUE_MARKED(
objspace, obj);
1523rb_gc_impl_gc_enabled_p(
void *objspace_ptr)
1526 return !dont_gc_val();
1530rb_gc_impl_gc_enable(
void *objspace_ptr)
1538rb_gc_impl_gc_disable(
void *objspace_ptr,
bool finish_current_gc)
1542 if (finish_current_gc) {
1556 return calloc(1, n);
1560rb_gc_impl_set_event_hook(
void *objspace_ptr,
const rb_event_flag_t event)
1567rb_gc_impl_get_total_time(
void *objspace_ptr)
1571 unsigned long long marking_time =
objspace->profile.marking_time_ns;
1572 unsigned long long sweeping_time =
objspace->profile.sweeping_time_ns;
1574 return marking_time + sweeping_time;
1578rb_gc_impl_set_measure_total_time(
void *objspace_ptr,
VALUE flag)
1586rb_gc_impl_get_measure_total_time(
void *objspace_ptr)
1595rb_gc_impl_garbage_object_p(
void *objspace_ptr,
VALUE ptr)
1601 asan_unpoisoning_object(ptr) {
1613 if (dead)
return true;
1614 return is_lazy_sweeping(
objspace) && GET_HEAP_PAGE(ptr)->flags.before_sweep &&
1625 rb_asan_unpoison_object(obj,
false);
1627 asan_unlock_freelist(page);
1631 slot->next = page->freelist;
1632 page->freelist = slot;
1633 asan_lock_freelist(page);
1636 GC_ASSERT(RVALUE_AGE_GET(obj) == 0);
1638 if (RGENGC_CHECK_MODE &&
1640 !(page->start <= (uintptr_t)obj &&
1641 (uintptr_t)obj < ((uintptr_t)page->start + (page->total_slots * page->slot_size)) &&
1642 obj % pool_slot_sizes[0] == 0)) {
1643 rb_bug(
"heap_page_add_freeobj: %p is not rvalue.", (
void *)obj);
1646 rb_asan_poison_object(obj);
1647 gc_report(3,
objspace,
"heap_page_add_freeobj: add %p to freelist\n", (
void *)obj);
1652 rb_heap_t *heap,
size_t free_slots,
size_t total_slots,
size_t slot_size)
1654 double goal_ratio = gc_params.heap_free_slots_goal_ratio;
1655 size_t target_total_slots;
1657 if (goal_ratio == 0.0) {
1658 target_total_slots = (size_t)(total_slots * gc_params.growth_factor);
1660 else if (total_slots == 0) {
1661 target_total_slots = gc_params.heap_init_bytes / slot_size;
1667 double f = (double)(total_slots - free_slots) / ((1 - goal_ratio) * total_slots);
1669 if (f > gc_params.growth_factor) f = gc_params.growth_factor;
1670 if (f < 1.0) f = 1.1;
1672 target_total_slots = (size_t)(f * total_slots);
1676 "free_slots(%8"PRIuSIZE
")/total_slots(%8"PRIuSIZE
")=%1.2f,"
1677 " G(%1.2f), f(%1.2f),"
1678 " total_slots(%8"PRIuSIZE
") => target_total_slots(%8"PRIuSIZE
")\n",
1679 free_slots, total_slots, free_slots/(
double)total_slots,
1680 goal_ratio, f, total_slots, target_total_slots);
1684 if (gc_params.growth_max_bytes > 0) {
1685 size_t max_total_slots = total_slots + gc_params.growth_max_bytes / slot_size;
1686 if (target_total_slots > max_total_slots) target_total_slots = max_total_slots;
1689 size_t extend_slot_count = target_total_slots - total_slots;
1691 if (extend_slot_count == 0) extend_slot_count = 1;
1693 objspace->heap_pages.allocatable_bytes += extend_slot_count * slot_size;
1699 asan_unlock_freelist(page);
1700 GC_ASSERT(page->free_slots != 0);
1701 GC_ASSERT(page->freelist != NULL);
1703 page->free_next = heap->free_pages;
1704 heap->free_pages = page;
1706 RUBY_DEBUG_LOG(
"page:%p freelist:%p", (
void *)page, (
void *)page->freelist);
1708 asan_lock_freelist(page);
1714 asan_unlock_freelist(page);
1715 GC_ASSERT(page->free_slots != 0);
1716 GC_ASSERT(page->freelist != NULL);
1718 page->free_next = heap->pooled_pages;
1719 heap->pooled_pages = page;
1720 objspace->rincgc.pooled_slots += page->free_slots;
1722 asan_lock_freelist(page);
1728 ccan_list_del(&page->page_node);
1729 heap->total_pages--;
1730 heap->total_slots -= page->total_slots;
1734gc_aligned_free(
void *ptr,
size_t size)
1736#if defined __MINGW32__
1737 __mingw_aligned_free(ptr);
1740#elif defined(HAVE_POSIX_MEMALIGN) || defined(HAVE_MEMALIGN)
1743 free(((
void**)ptr)[-1]);
1750 GC_ASSERT((uintptr_t)page_body % HEAP_PAGE_ALIGN == 0);
1752 if (HEAP_PAGE_ALLOC_USE_MMAP) {
1754 GC_ASSERT(HEAP_PAGE_SIZE % sysconf(_SC_PAGE_SIZE) == 0);
1755 if (munmap(page_body, HEAP_PAGE_SIZE)) {
1756 rb_bug(
"heap_page_body_free: munmap failed");
1761 gc_aligned_free(page_body, HEAP_PAGE_SIZE);
1768 objspace->heap_pages.freed_pages++;
1769 heap_page_body_free(page->body);
1776 if (
objspace->empty_pages != NULL && heap_pages_freeable_pages > 0) {
1777 GC_ASSERT(
objspace->empty_pages_count > 0);
1782 for (i = j = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
1785 if (heap_page_in_global_empty_pages_pool(
objspace, page) && heap_pages_freeable_pages > 0) {
1787 heap_pages_freeable_pages--;
1790 if (heap_page_in_global_empty_pages_pool(
objspace, page)) {
1791 page->free_next =
objspace->empty_pages;
1797 rb_darray_set(
objspace->heap_pages.sorted, j, page);
1803 rb_darray_pop(
objspace->heap_pages.sorted, i - j);
1804 GC_ASSERT(rb_darray_size(
objspace->heap_pages.sorted) == j);
1807 uintptr_t himem = (uintptr_t)hipage->body + HEAP_PAGE_SIZE;
1808 GC_ASSERT(himem <= heap_pages_himem);
1809 heap_pages_himem = himem;
1812 uintptr_t lomem = (uintptr_t)lopage->body +
sizeof(
struct heap_page_header);
1813 GC_ASSERT(lomem >= heap_pages_lomem);
1814 heap_pages_lomem = lomem;
1819gc_aligned_malloc(
size_t alignment,
size_t size)
1822 GC_ASSERT(((alignment - 1) & alignment) == 0);
1823 GC_ASSERT(alignment %
sizeof(
void*) == 0);
1827#if defined __MINGW32__
1828 res = __mingw_aligned_malloc(size, alignment);
1830 void *_aligned_malloc(
size_t,
size_t);
1831 res = _aligned_malloc(size, alignment);
1832#elif defined(HAVE_POSIX_MEMALIGN)
1833 if (posix_memalign(&res, alignment, size) != 0) {
1836#elif defined(HAVE_MEMALIGN)
1837 res = memalign(alignment, size);
1840 res = malloc(alignment + size +
sizeof(
void*));
1841 aligned = (
char*)res + alignment +
sizeof(
void*);
1842 aligned -= ((
VALUE)aligned & (alignment - 1));
1843 ((
void**)aligned)[-1] = res;
1844 res = (
void*)aligned;
1847 GC_ASSERT((uintptr_t)res % alignment == 0);
1853heap_page_body_allocate(
void)
1857 if (HEAP_PAGE_ALLOC_USE_MMAP) {
1859 GC_ASSERT(HEAP_PAGE_ALIGN % sysconf(_SC_PAGE_SIZE) == 0);
1861 size_t mmap_size = HEAP_PAGE_ALIGN + HEAP_PAGE_SIZE;
1862 char *ptr = mmap(NULL, mmap_size,
1863 PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
1864 if (ptr == MAP_FAILED) {
1873#if defined(HAVE_SYS_PRCTL_H) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
1874 prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME, ptr, mmap_size,
"Ruby:GC:default:heap_page_body_allocate");
1878 char *aligned = ptr + HEAP_PAGE_ALIGN;
1879 aligned -= ((
VALUE)aligned & (HEAP_PAGE_ALIGN - 1));
1880 GC_ASSERT(aligned > ptr);
1881 GC_ASSERT(aligned <= ptr + HEAP_PAGE_ALIGN);
1883 size_t start_out_of_range_size = aligned - ptr;
1884 GC_ASSERT(start_out_of_range_size % sysconf(_SC_PAGE_SIZE) == 0);
1885 if (start_out_of_range_size > 0) {
1886 if (munmap(ptr, start_out_of_range_size)) {
1887 rb_bug(
"heap_page_body_allocate: munmap failed for start");
1891 size_t end_out_of_range_size = HEAP_PAGE_ALIGN - start_out_of_range_size;
1892 GC_ASSERT(end_out_of_range_size % sysconf(_SC_PAGE_SIZE) == 0);
1893 if (end_out_of_range_size > 0) {
1894 if (munmap(aligned + HEAP_PAGE_SIZE, end_out_of_range_size)) {
1895 rb_bug(
"heap_page_body_allocate: munmap failed for end");
1903 page_body = gc_aligned_malloc(HEAP_PAGE_ALIGN, HEAP_PAGE_SIZE);
1906 GC_ASSERT((uintptr_t)page_body % HEAP_PAGE_ALIGN == 0);
1915 if (
objspace->empty_pages == NULL) {
1916 GC_ASSERT(
objspace->empty_pages_count == 0);
1919 GC_ASSERT(
objspace->empty_pages_count > 0);
1922 objspace->empty_pages = page->free_next;
1932 if (page_body == 0) {
1938 heap_page_body_free(page_body);
1943 uintptr_t end = (uintptr_t)page_body + HEAP_PAGE_SIZE;
1946 size_t hi = rb_darray_size(
objspace->heap_pages.sorted);
1950 size_t mid = (lo + hi) / 2;
1951 mid_page = rb_darray_get(
objspace->heap_pages.sorted, mid);
1952 if ((uintptr_t)mid_page->start < start) {
1955 else if ((uintptr_t)mid_page->start > start) {
1959 rb_bug(
"same heap page is allocated: %p at %"PRIuVALUE, (
void *)page_body, (
VALUE)mid);
1963 rb_darray_insert_without_gc(&
objspace->heap_pages.sorted, hi, page);
1965 if (heap_pages_lomem == 0 || heap_pages_lomem > start) heap_pages_lomem = start;
1966 if (heap_pages_himem < end) heap_pages_himem = end;
1968 page->body = page_body;
1969 page_body->header.page = page;
1971 objspace->heap_pages.allocated_pages++;
1980 GC_ASSERT(!heap->sweeping_page);
1981 GC_ASSERT(heap_page_in_global_empty_pages_pool(
objspace, page));
1985 size_t remainder = start % heap->slot_size;
1986 if (remainder != 0) {
1987 start += heap->slot_size - remainder;
1990 int slot_count = (int)((HEAP_PAGE_SIZE - (start - (uintptr_t)page->body))/heap->slot_size);
1992 page->start = start;
1993 page->total_slots = slot_count;
1994 page->slot_size = heap->slot_size;
1995 page->slot_div_magic = slot_div_magics[heap - heaps];
1998 memset(&page->wb_unprotected_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
1999 memset(&page->age_bits[0], 0,
sizeof(page->age_bits));
2001 asan_unlock_freelist(page);
2002 page->freelist = NULL;
2003 asan_unpoison_memory_region(page->body, HEAP_PAGE_SIZE,
false);
2004 for (
VALUE p = (
VALUE)start; p < start + (slot_count * heap->slot_size); p += heap->slot_size) {
2005 heap_page_add_freeobj(
objspace, page, p);
2007 asan_lock_freelist(page);
2009 page->free_slots = slot_count;
2011 heap->total_allocated_pages++;
2013 ccan_list_add_tail(&heap->pages, &page->page_node);
2014 heap->total_pages++;
2015 heap->total_slots += page->total_slots;
2021 gc_report(1,
objspace,
"heap_page_allocate_and_initialize: rb_darray_size(objspace->heap_pages.sorted): %"PRIdSIZE
", "
2022 "allocatable_bytes: %"PRIdSIZE
", heap->total_pages: %"PRIdSIZE
"\n",
2023 rb_darray_size(
objspace->heap_pages.sorted),
objspace->heap_pages.allocatable_bytes, heap->total_pages);
2025 bool allocated =
false;
2028 if (page == NULL &&
objspace->heap_pages.allocatable_bytes > 0) {
2029 page = heap_page_allocate(
objspace);
2032 GC_ASSERT(page != NULL);
2036 heap_add_page(
objspace, heap, page);
2037 heap_add_freepage(heap, page);
2040 size_t page_bytes = (size_t)page->total_slots * page->slot_size;
2041 if (
objspace->heap_pages.allocatable_bytes > page_bytes) {
2042 objspace->heap_pages.allocatable_bytes -= page_bytes;
2045 objspace->heap_pages.allocatable_bytes = 0;
2050 return page != NULL;
2056 size_t prev_allocatable_bytes =
objspace->heap_pages.allocatable_bytes;
2057 objspace->heap_pages.allocatable_bytes = HEAP_PAGE_SIZE;
2058 heap_page_allocate_and_initialize(
objspace, heap);
2059 GC_ASSERT(heap->free_pages != NULL);
2060 objspace->heap_pages.allocatable_bytes = prev_allocatable_bytes;
2066 unsigned int lock_lev;
2067 bool needs_gc = is_incremental_marking(
objspace) || needs_continue_sweeping(
objspace, heap);
2068 if (!needs_gc)
return;
2070 gc_enter(
objspace, gc_enter_event_continue, &lock_lev);
2073 if (is_incremental_marking(
objspace)) {
2074 if (gc_marks_continue(
objspace, heap)) {
2079 if (needs_continue_sweeping(
objspace, heap)) {
2083 gc_exit(
objspace, gc_enter_event_continue, &lock_lev);
2089 GC_ASSERT(heap->free_pages == NULL);
2091 if (heap->total_slots < gc_params.heap_init_bytes / heap->slot_size &&
2092 heap->sweeping_page == NULL) {
2093 heap_page_allocate_and_initialize_force(
objspace, heap);
2094 GC_ASSERT(heap->free_pages != NULL);
2101 if (heap->free_pages == NULL) {
2102 heap_page_allocate_and_initialize(
objspace, heap);
2107 if (heap->free_pages == NULL) {
2108 GC_ASSERT(
objspace->empty_pages_count == 0);
2109 GC_ASSERT(
objspace->heap_pages.allocatable_bytes == 0);
2111 if (gc_start(
objspace, GPR_FLAG_NEWOBJ) == FALSE) {
2115 if (
objspace->heap_pages.allocatable_bytes == 0 && !gc_config_full_mark_val) {
2116 heap_allocatable_bytes_expand(
objspace, heap,
2117 heap->freed_slots + heap->empty_slots,
2118 heap->total_slots, heap->slot_size);
2119 GC_ASSERT(
objspace->heap_pages.allocatable_bytes > 0);
2127 if (heap->free_pages == NULL && !heap_page_allocate_and_initialize(
objspace, heap)) {
2128 if (gc_needs_major_flags == GPR_FLAG_NONE) {
2129 rb_bug(
"cannot create a new page after GC");
2132 if (gc_start(
objspace, GPR_FLAG_NEWOBJ) == FALSE) {
2139 if (heap->free_pages == NULL &&
2140 !heap_page_allocate_and_initialize(
objspace, heap)) {
2141 rb_bug(
"cannot create a new page after major GC");
2149 GC_ASSERT(heap->free_pages != NULL);
2153static inline const char*
2154rb_gc_impl_source_location_cstr(
int *ptr)
2175 RBASIC(obj)->flags = flags;
2177#if RBASIC_SHAPE_ID_FIELD
2178 RBASIC(obj)->shape_id = 0;
2182#if RACTOR_CHECK_MODE
2183 void rb_ractor_setup_belonging(
VALUE obj);
2184 rb_ractor_setup_belonging(obj);
2187#if RGENGC_CHECK_MODE
2188 int lev = RB_GC_VM_LOCK_NO_BARRIER();
2190 check_rvalue_consistency(
objspace, obj);
2192 GC_ASSERT(RVALUE_MARKED(
objspace, obj) == FALSE);
2193 GC_ASSERT(RVALUE_MARKING(
objspace, obj) == FALSE);
2194 GC_ASSERT(RVALUE_OLD_P(
objspace, obj) == FALSE);
2195 GC_ASSERT(RVALUE_WB_UNPROTECTED(
objspace, obj) == FALSE);
2197 if (RVALUE_REMEMBERED(
objspace, obj)) rb_bug(
"newobj: %s is remembered.", rb_obj_info(obj));
2199 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
2202 if (RB_UNLIKELY(wb_protected == FALSE)) {
2203 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), obj);
2208 objspace->profile.total_generated_normal_object_count++;
2209#if RGENGC_PROFILE >= 2
2214 objspace->profile.total_generated_shady_object_count++;
2215#if RGENGC_PROFILE >= 2
2222 GET_RVALUE_OVERHEAD(obj)->file = rb_gc_impl_source_location_cstr(&GET_RVALUE_OVERHEAD(obj)->line);
2226 gc_report(5,
objspace,
"newobj: %s\n", rb_obj_info(obj));
2233rb_gc_impl_obj_slot_size(
VALUE obj)
2235 return GET_HEAP_PAGE(obj)->slot_size - RVALUE_OVERHEAD;
2239heap_slot_size(
unsigned char pool_id)
2241 GC_ASSERT(pool_id < HEAP_COUNT);
2243 return pool_slot_sizes[pool_id] - RVALUE_OVERHEAD;
2247rb_gc_impl_size_allocatable_p(
size_t size)
2249 return size + RVALUE_OVERHEAD <= pool_slot_sizes[HEAP_COUNT - 1];
2252static const size_t ALLOCATED_COUNT_STEP = 1024;
2256 for (
int heap_idx = 0; heap_idx < HEAP_COUNT; heap_idx++) {
2261 heap_cache->allocated_objects_count = 0;
2270 struct free_slot *p = heap_cache->freelist;
2272 if (RB_UNLIKELY(is_incremental_marking(
objspace))) {
2274 if (cache->incremental_mark_step_allocated_slots >= INCREMENTAL_MARK_STEP_ALLOCATIONS) {
2279 cache->incremental_mark_step_allocated_slots++;
2285 rb_asan_unpoison_object(obj,
true);
2286 heap_cache->freelist = p->next;
2288 heap_cache->allocated_objects_count++;
2290 if (heap_cache->allocated_objects_count >= ALLOCATED_COUNT_STEP) {
2292 heap_cache->allocated_objects_count = 0;
2295#if RGENGC_CHECK_MODE
2296 GC_ASSERT(rb_gc_impl_obj_slot_size(obj) == heap_slot_size(heap_idx));
2298 MEMZERO((
char *)obj,
char, heap_slot_size(heap_idx));
2312 if (heap->free_pages == NULL) {
2316 page = heap->free_pages;
2317 heap->free_pages = page->free_next;
2319 GC_ASSERT(page->free_slots != 0);
2321 asan_unlock_freelist(page);
2330 gc_report(3,
objspace,
"ractor_set_cache: Using page %p\n", (
void *)page->body);
2334 GC_ASSERT(heap_cache->freelist == NULL);
2335 GC_ASSERT(page->free_slots != 0);
2336 GC_ASSERT(page->freelist != NULL);
2338 heap_cache->using_page = page;
2339 heap_cache->freelist = page->freelist;
2340 page->free_slots = 0;
2341 page->freelist = NULL;
2343 rb_asan_unpoison_object((
VALUE)heap_cache->freelist,
false);
2345 rb_asan_poison_object((
VALUE)heap_cache->freelist);
2349init_size_to_heap_idx(
void)
2351 for (
size_t i = 0; i <
sizeof(size_to_heap_idx); i++) {
2352 size_t effective = i * 8 + RVALUE_OVERHEAD;
2354 for (idx = 0; idx < HEAP_COUNT; idx++) {
2355 if (effective <= pool_slot_sizes[idx])
break;
2357 size_to_heap_idx[i] = idx;
2362heap_idx_for_size(
size_t size)
2364 size_t compressed = (size + 7) >> 3;
2365 if (compressed <
sizeof(size_to_heap_idx)) {
2366 size_t heap_idx = size_to_heap_idx[compressed];
2367 if (RB_LIKELY(heap_idx < HEAP_COUNT))
return heap_idx;
2370 rb_bug(
"heap_idx_for_size: allocation size too large "
2371 "(size=%"PRIuSIZE
")", size);
2375rb_gc_impl_heap_id_for_size(
void *objspace_ptr,
size_t size)
2377 return heap_idx_for_size(size);
2381static size_t heap_sizes[HEAP_COUNT + 1] = { 0 };
2384rb_gc_impl_heap_sizes(
void *objspace_ptr)
2386 if (heap_sizes[0] == 0) {
2387 for (
unsigned char i = 0; i < HEAP_COUNT; i++) {
2388 heap_sizes[i] = heap_slot_size(i);
2403 unsigned int lev = 0;
2404 bool unlock_vm =
false;
2407 lev = RB_GC_CR_LOCK();
2412 if (is_incremental_marking(
objspace)) {
2414 cache->incremental_mark_step_allocated_slots = 0;
2417 obj = ractor_cache_allocate_slot(
objspace, cache, heap_idx);
2423 ractor_cache_set_page(
objspace, cache, heap_idx, page);
2426 obj = ractor_cache_allocate_slot(
objspace, cache, heap_idx);
2431 RB_GC_CR_UNLOCK(lev);
2434 if (RB_UNLIKELY(obj ==
Qfalse)) {
2443 VALUE obj = ractor_cache_allocate_slot(
objspace, cache, heap_idx);
2445 if (RB_UNLIKELY(obj ==
Qfalse)) {
2446 obj = newobj_cache_miss(
objspace, cache, heap_idx, vm_locked);
2460 lev = RB_GC_CR_LOCK();
2462 if (RB_UNLIKELY(during_gc || ruby_gc_stressful)) {
2466 if (rb_memerror_reentered()) {
2469 rb_bug(
"object allocation during garbage collection phase");
2472 if (ruby_gc_stressful) {
2473 if (!garbage_collect(
objspace, GPR_FLAG_NEWOBJ)) {
2479 obj = newobj_alloc(
objspace, cache, heap_idx,
true);
2480 newobj_init(klass, flags, wb_protected,
objspace, obj);
2482 RB_GC_CR_UNLOCK(lev);
2487NOINLINE(
static VALUE newobj_slowpath_wb_protected(
VALUE klass,
VALUE flags,
2489NOINLINE(
static VALUE newobj_slowpath_wb_unprotected(
VALUE klass,
VALUE flags,
2495 return newobj_slowpath(klass, flags,
objspace, cache, TRUE, heap_idx);
2501 return newobj_slowpath(klass, flags,
objspace, cache, FALSE, heap_idx);
2505rb_gc_impl_new_obj(
void *objspace_ptr,
void *cache_ptr,
VALUE klass,
VALUE flags,
bool wb_protected,
size_t alloc_size)
2510 RB_DEBUG_COUNTER_INC(obj_newobj);
2511 (void)RB_DEBUG_COUNTER_INC_IF(obj_newobj_wb_unprotected, !wb_protected);
2513 if (RB_UNLIKELY(stress_to_class)) {
2514 if (rb_hash_lookup2(stress_to_class, klass,
Qundef) !=
Qundef) {
2519 size_t heap_idx = heap_idx_for_size(alloc_size);
2523 if (!RB_UNLIKELY(during_gc || ruby_gc_stressful) &&
2525 obj = newobj_alloc(
objspace, cache, heap_idx,
false);
2526 newobj_init(klass, flags, wb_protected,
objspace, obj);
2529 RB_DEBUG_COUNTER_INC(obj_newobj_slowpath);
2531 obj = wb_protected ?
2532 newobj_slowpath_wb_protected(klass, flags,
objspace, cache, heap_idx) :
2533 newobj_slowpath_wb_unprotected(klass, flags,
objspace, cache, heap_idx);
2540ptr_in_page_body_p(
const void *ptr,
const void *memb)
2543 uintptr_t p_body = (uintptr_t)page->body;
2545 if ((uintptr_t)ptr >= p_body) {
2546 return (uintptr_t)ptr < (p_body + HEAP_PAGE_SIZE) ? 0 : 1;
2559 if (ptr < (uintptr_t)heap_pages_lomem ||
2560 ptr > (uintptr_t)heap_pages_himem) {
2564 res = bsearch((
void *)ptr, rb_darray_ref(
objspace->heap_pages.sorted, 0),
2566 ptr_in_page_body_p);
2580 register uintptr_t p = (uintptr_t)ptr;
2583 RB_DEBUG_COUNTER_INC(gc_isptr_trial);
2585 if (p < heap_pages_lomem || p > heap_pages_himem)
return FALSE;
2586 RB_DEBUG_COUNTER_INC(gc_isptr_range);
2588 if (p % pool_slot_sizes[0] != 0)
return FALSE;
2589 RB_DEBUG_COUNTER_INC(gc_isptr_align);
2591 page = heap_page_for_ptr(
objspace, (uintptr_t)ptr);
2593 RB_DEBUG_COUNTER_INC(gc_isptr_maybe);
2594 if (heap_page_in_global_empty_pages_pool(
objspace, page)) {
2598 if (p < page->start)
return FALSE;
2599 if (p >= page->start + (page->total_slots * page->slot_size))
return FALSE;
2600 if ((p - page->start) % page->slot_size != 0)
return FALSE;
2609rb_gc_impl_pointer_to_heap_p(
void *objspace_ptr,
const void *ptr)
2611 return is_pointer_to_heap(objspace_ptr, ptr);
2614#define ZOMBIE_OBJ_KEPT_FLAGS (FL_FINALIZE)
2617rb_gc_impl_make_zombie(
void *objspace_ptr,
VALUE obj,
void (*dfree)(
void *),
void *data)
2621 struct RZombie *zombie = RZOMBIE(obj);
2622 zombie->flags =
T_ZOMBIE | (zombie->flags & ZOMBIE_OBJ_KEPT_FLAGS);
2623 zombie->dfree = dfree;
2624 zombie->data = data;
2625 VALUE prev, next = heap_pages_deferred_final;
2627 zombie->next = prev = next;
2629 }
while (next != prev);
2631 struct heap_page *page = GET_HEAP_PAGE(obj);
2632 page->final_slots++;
2633 page->heap->final_slots_count++;
2636typedef int each_obj_callback(
void *,
void *,
size_t,
void *);
2637typedef int each_page_callback(
struct heap_page *,
void *);
2641 bool reenable_incremental;
2643 each_obj_callback *each_obj_callback;
2644 each_page_callback *each_page_callback;
2648 size_t pages_counts[HEAP_COUNT];
2652objspace_each_objects_ensure(
VALUE arg)
2658 if (data->reenable_incremental) {
2659 objspace->flags.dont_incremental = FALSE;
2662 for (
int i = 0; i < HEAP_COUNT; i++) {
2663 struct heap_page **pages = data->pages[i];
2671objspace_each_objects_try(
VALUE arg)
2677 for (
int i = 0; i < HEAP_COUNT; i++) {
2679 size_t size = heap->total_pages *
sizeof(
struct heap_page *);
2681 struct heap_page **pages = malloc(size);
2682 if (!pages) rb_memerror();
2690 size_t pages_count = 0;
2691 ccan_list_for_each(&heap->pages, page, page_node) {
2692 pages[pages_count] = page;
2695 data->pages[i] = pages;
2696 data->pages_counts[i] = pages_count;
2697 GC_ASSERT(pages_count == heap->total_pages);
2700 for (
int i = 0; i < HEAP_COUNT; i++) {
2702 size_t pages_count = data->pages_counts[i];
2703 struct heap_page **pages = data->pages[i];
2706 for (
size_t i = 0; i < pages_count; i++) {
2709 if (page == NULL)
break;
2713 if (pages[i] != page)
continue;
2715 uintptr_t pstart = (uintptr_t)page->start;
2716 uintptr_t pend = pstart + (page->total_slots * heap->slot_size);
2718 if (data->each_obj_callback &&
2719 (*data->each_obj_callback)((
void *)pstart, (
void *)pend, heap->slot_size, data->data)) {
2722 if (data->each_page_callback &&
2723 (*data->each_page_callback)(page, data->data)) {
2727 page = ccan_list_next(&heap->pages, page, page_node);
2739 bool reenable_incremental = FALSE;
2741 reenable_incremental = !
objspace->flags.dont_incremental;
2744 objspace->flags.dont_incremental = TRUE;
2755objspace_each_objects(
rb_objspace_t *
objspace, each_obj_callback *callback,
void *data,
bool protected)
2759 .each_obj_callback = callback,
2760 .each_page_callback = NULL,
2767rb_gc_impl_each_objects(
void *objspace_ptr, each_obj_callback *callback,
void *data)
2769 objspace_each_objects(objspace_ptr, callback, data, TRUE);
2772#if GC_CAN_COMPILE_COMPACTION
2774objspace_each_pages(
rb_objspace_t *
objspace, each_page_callback *callback,
void *data,
bool protected)
2778 .each_obj_callback = NULL,
2779 .each_page_callback = callback,
2787rb_gc_impl_define_finalizer(
void *objspace_ptr,
VALUE obj,
VALUE block)
2797 unsigned int lev = RB_GC_VM_LOCK();
2799 if (st_lookup(finalizer_table, obj, &data)) {
2800 table = (
VALUE)data;
2803 RB_GC_VM_UNLOCK(lev);
2809 for (i = 0; i <
len; i++) {
2816 lev = RB_GC_VM_LOCK();
2824 st_add_direct(finalizer_table, obj, table);
2827 RB_GC_VM_UNLOCK(lev);
2833rb_gc_impl_undefine_finalizer(
void *objspace_ptr,
VALUE obj)
2839 st_data_t data = obj;
2841 int lev = RB_GC_VM_LOCK();
2842 st_delete(finalizer_table, &data, 0);
2843 RB_GC_VM_UNLOCK(lev);
2849rb_gc_impl_copy_finalizer(
void *objspace_ptr,
VALUE dest,
VALUE obj)
2857 int lev = RB_GC_VM_LOCK();
2858 if (RB_LIKELY(st_lookup(finalizer_table, obj, &data))) {
2861 st_insert(finalizer_table, dest, table);
2865 rb_bug(
"rb_gc_copy_finalizer: FL_FINALIZE set but not found in finalizer_table: %s", rb_obj_info(obj));
2867 RB_GC_VM_UNLOCK(lev);
2871get_final(
long i,
void *data)
2881 if (RZOMBIE(zombie)->dfree) {
2882 RZOMBIE(zombie)->dfree(RZOMBIE(zombie)->data);
2885 st_data_t key = (st_data_t)zombie;
2889 if (st_delete(finalizer_table, &key, &table)) {
2890 RB_GC_VM_UNLOCK(lev);
2892 lev = RB_GC_VM_LOCK();
2895 rb_bug(
"FL_FINALIZE flag is set, but finalizers are not found");
2899 GC_ASSERT(!st_lookup(finalizer_table, key, NULL));
2910 rb_asan_unpoison_object(zombie,
false);
2911 next_zombie = RZOMBIE(zombie)->next;
2912 page = GET_HEAP_PAGE(zombie);
2914 unsigned int lev = RB_GC_VM_LOCK();
2916 lev = run_final(
objspace, zombie, lev);
2919 GC_ASSERT(page->heap->final_slots_count > 0);
2920 GC_ASSERT(page->final_slots > 0);
2922 page->heap->final_slots_count--;
2923 page->final_slots--;
2925 RVALUE_AGE_SET_BITMAP(zombie, 0);
2926 heap_page_add_freeobj(
objspace, page, zombie);
2927 page->heap->total_freed_objects++;
2929 RB_GC_VM_UNLOCK(lev);
2931 zombie = next_zombie;
2947 rb_gc_set_pending_interrupt();
2948 finalize_deferred_heap_pages(
objspace);
2949 rb_gc_unset_pending_interrupt();
2953gc_finalize_deferred(
void *dmy)
2972gc_abort(
void *objspace_ptr)
2976 if (is_incremental_marking(
objspace)) {
2979 while (pop_mark_stack(&
objspace->mark_stack, &obj));
2981 objspace->flags.during_incremental_marking = FALSE;
2985 for (
int i = 0; i < HEAP_COUNT; i++) {
2988 heap->sweeping_page = NULL;
2991 ccan_list_for_each(&heap->pages, page, page_node) {
2992 page->flags.before_sweep =
false;
2997 for (
int i = 0; i < HEAP_COUNT; i++) {
2999 rgengc_mark_and_rememberset_clear(
objspace, heap);
3002 gc_mode_set(
objspace, gc_mode_none);
3006rb_gc_impl_shutdown_free_objects(
void *objspace_ptr)
3010 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
3012 short stride = page->slot_size;
3014 uintptr_t p = (uintptr_t)page->start;
3015 uintptr_t pend = p + page->total_slots * stride;
3016 for (; p < pend; p += stride) {
3018 asan_unpoisoning_object(vp) {
3020 rb_gc_obj_free_vm_weak_references(vp);
3021 if (rb_gc_obj_free(
objspace, vp)) {
3031rb_gc_impl_shutdown_call_finalizer_i(st_data_t key, st_data_t val, st_data_t _data)
3047rb_gc_impl_shutdown_call_finalizer(
void *objspace_ptr)
3051#if RGENGC_CHECK_MODE >= 2
3052 gc_verify_internal_consistency(
objspace);
3056 objspace->flags.dont_incremental = 1;
3065 while (finalizer_table->num_entries) {
3066 st_foreach(finalizer_table, rb_gc_impl_shutdown_call_finalizer_i, 0);
3071 GC_ASSERT(heap_pages_deferred_final == 0);
3080 unsigned int lock_lev;
3081 gc_enter(
objspace, gc_enter_event_finalizer, &lock_lev);
3084 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
3086 short stride = page->slot_size;
3088 uintptr_t p = (uintptr_t)page->start;
3089 uintptr_t pend = p + page->total_slots * stride;
3090 for (; p < pend; p += stride) {
3092 asan_unpoisoning_object(vp) {
3093 if (rb_gc_shutdown_call_finalizer_p(vp)) {
3094 rb_gc_obj_free_vm_weak_references(vp);
3095 if (rb_gc_obj_free(
objspace, vp)) {
3103 gc_exit(
objspace, gc_enter_event_finalizer, &lock_lev);
3105 finalize_deferred_heap_pages(
objspace);
3107 st_free_table(finalizer_table);
3108 finalizer_table = 0;
3113rb_gc_impl_each_object(
void *objspace_ptr,
void (*func)(
VALUE obj,
void *data),
void *data)
3117 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
3119 short stride = page->slot_size;
3121 uintptr_t p = (uintptr_t)page->start;
3122 uintptr_t pend = p + page->total_slots * stride;
3123 for (; p < pend; p += stride) {
3126 asan_unpoisoning_object(obj) {
3142 size_t total_slots = 0;
3143 for (
int i = 0; i < HEAP_COUNT; i++) {
3145 total_slots += heap->total_slots;
3163gc_setup_mark_bits(
struct heap_page *page)
3166 memcpy(&page->mark_bits[0], &page->uncollectible_bits[0], HEAP_PAGE_BITMAP_SIZE);
3173enum {HEAP_PAGE_LOCK = PAGE_NOACCESS, HEAP_PAGE_UNLOCK = PAGE_READWRITE};
3179 return VirtualProtect(body, HEAP_PAGE_SIZE, protect, &old_protect) != 0;
3181#elif defined(__wasi__)
3183enum {HEAP_PAGE_LOCK, HEAP_PAGE_UNLOCK};
3184#define protect_page_body(body, protect) 1
3186enum {HEAP_PAGE_LOCK = PROT_NONE, HEAP_PAGE_UNLOCK = PROT_READ | PROT_WRITE};
3187#define protect_page_body(body, protect) !mprotect((body), HEAP_PAGE_SIZE, (protect))
3193 if (!protect_page_body(body, HEAP_PAGE_LOCK)) {
3194 rb_bug(
"Couldn't protect page %p, errno: %s", (
void *)body, strerror(
errno));
3197 gc_report(5,
objspace,
"Protecting page in move %p\n", (
void *)body);
3204 if (!protect_page_body(body, HEAP_PAGE_UNLOCK)) {
3205 rb_bug(
"Couldn't unprotect page %p, errno: %s", (
void *)body, strerror(
errno));
3208 gc_report(5,
objspace,
"Unprotecting page in move %p\n", (
void *)body);
3215 GC_ASSERT(gc_is_moveable_obj(
objspace, src));
3217 struct heap_page *src_page = GET_HEAP_PAGE(src);
3225 GC_ASSERT(RVALUE_MARKED(
objspace, src));
3227 asan_unlock_freelist(free_page);
3229 asan_lock_freelist(free_page);
3231 rb_asan_unpoison_object(dest,
false);
3238 asan_unlock_freelist(free_page);
3239 free_page->freelist = ((
struct free_slot *)dest)->next;
3240 asan_lock_freelist(free_page);
3244 if (src_page->slot_size > free_page->slot_size) {
3247 else if (free_page->slot_size > src_page->slot_size) {
3251 objspace->rcompactor.total_moved++;
3253 gc_move(
objspace, src, dest, src_page->slot_size, free_page->slot_size);
3255 free_page->free_slots--;
3263 struct heap_page *cursor = heap->compact_cursor;
3266 unlock_page_body(
objspace, cursor->body);
3267 cursor = ccan_list_next(&heap->pages, cursor, page_node);
3272#if GC_CAN_COMPILE_COMPACTION
3276#if defined(__MINGW32__) || defined(_WIN32)
3277# define GC_COMPACTION_SUPPORTED 1
3281# define GC_COMPACTION_SUPPORTED (GC_CAN_COMPILE_COMPACTION && HEAP_PAGE_ALLOC_USE_MMAP)
3284#if GC_CAN_COMPILE_COMPACTION
3286read_barrier_handler(uintptr_t address)
3294 if (page_body == NULL) {
3295 rb_bug(
"read_barrier_handler: segmentation fault at %p", (
void *)address);
3298 int lev = RB_GC_VM_LOCK();
3300 unlock_page_body(
objspace, page_body);
3302 objspace->profile.read_barrier_faults++;
3304 invalidate_moved_page(
objspace, GET_HEAP_PAGE(address));
3306 RB_GC_VM_UNLOCK(lev);
3310#if !GC_CAN_COMPILE_COMPACTION
3312uninstall_handlers(
void)
3318install_handlers(
void)
3322#elif defined(_WIN32)
3323static LPTOP_LEVEL_EXCEPTION_FILTER old_handler;
3324typedef void (*signal_handler)(int);
3325static signal_handler old_sigsegv_handler;
3328read_barrier_signal(EXCEPTION_POINTERS *info)
3331 if (info->ExceptionRecord->ExceptionCode == EXCEPTION_ACCESS_VIOLATION) {
3336 read_barrier_handler((uintptr_t)info->ExceptionRecord->ExceptionInformation[1]);
3337 return EXCEPTION_CONTINUE_EXECUTION;
3340 return EXCEPTION_CONTINUE_SEARCH;
3345uninstall_handlers(
void)
3347 signal(SIGSEGV, old_sigsegv_handler);
3348 SetUnhandledExceptionFilter(old_handler);
3352install_handlers(
void)
3355 old_sigsegv_handler = signal(SIGSEGV, NULL);
3358 old_handler = SetUnhandledExceptionFilter(read_barrier_signal);
3361static struct sigaction old_sigbus_handler;
3362static struct sigaction old_sigsegv_handler;
3364#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3365static exception_mask_t old_exception_masks[32];
3366static mach_port_t old_exception_ports[32];
3367static exception_behavior_t old_exception_behaviors[32];
3368static thread_state_flavor_t old_exception_flavors[32];
3369static mach_msg_type_number_t old_exception_count;
3372disable_mach_bad_access_exc(
void)
3374 old_exception_count =
sizeof(old_exception_masks) /
sizeof(old_exception_masks[0]);
3375 task_swap_exception_ports(
3376 mach_task_self(), EXC_MASK_BAD_ACCESS,
3377 MACH_PORT_NULL, EXCEPTION_DEFAULT, 0,
3378 old_exception_masks, &old_exception_count,
3379 old_exception_ports, old_exception_behaviors, old_exception_flavors
3384restore_mach_bad_access_exc(
void)
3386 for (mach_msg_type_number_t i = 0; i < old_exception_count; i++) {
3387 task_set_exception_ports(
3389 old_exception_masks[i], old_exception_ports[i],
3390 old_exception_behaviors[i], old_exception_flavors[i]
3397read_barrier_signal(
int sig, siginfo_t *info,
void *data)
3400 struct sigaction prev_sigbus, prev_sigsegv;
3401 sigaction(SIGBUS, &old_sigbus_handler, &prev_sigbus);
3402 sigaction(SIGSEGV, &old_sigsegv_handler, &prev_sigsegv);
3405 sigset_t set, prev_set;
3407 sigaddset(&set, SIGBUS);
3408 sigaddset(&set, SIGSEGV);
3409 sigprocmask(SIG_UNBLOCK, &set, &prev_set);
3410#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3411 disable_mach_bad_access_exc();
3414 read_barrier_handler((uintptr_t)info->si_addr);
3417#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3418 restore_mach_bad_access_exc();
3420 sigaction(SIGBUS, &prev_sigbus, NULL);
3421 sigaction(SIGSEGV, &prev_sigsegv, NULL);
3422 sigprocmask(SIG_SETMASK, &prev_set, NULL);
3426uninstall_handlers(
void)
3428#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3429 restore_mach_bad_access_exc();
3431 sigaction(SIGBUS, &old_sigbus_handler, NULL);
3432 sigaction(SIGSEGV, &old_sigsegv_handler, NULL);
3436install_handlers(
void)
3438 struct sigaction action;
3439 memset(&action, 0,
sizeof(
struct sigaction));
3440 sigemptyset(&action.sa_mask);
3441 action.sa_sigaction = read_barrier_signal;
3442 action.sa_flags = SA_SIGINFO | SA_ONSTACK;
3444 sigaction(SIGBUS, &action, &old_sigbus_handler);
3445 sigaction(SIGSEGV, &action, &old_sigsegv_handler);
3446#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3447 disable_mach_bad_access_exc();
3455 for (
int i = 0; i < HEAP_COUNT; i++) {
3457 gc_unprotect_pages(
objspace, heap);
3460 uninstall_handlers();
3465 for (
int i = 0; i < HEAP_COUNT; i++) {
3467 heap->compact_cursor = NULL;
3468 heap->free_pages = NULL;
3469 heap->compact_cursor_index = 0;
3474 record->moved_objects =
objspace->rcompactor.total_moved - record->moved_objects;
3476 objspace->flags.during_compacting = FALSE;
3489 struct heap_page *sweep_page = ctx->page;
3490 short slot_size = sweep_page->slot_size;
3494 GC_ASSERT(vp % pool_slot_sizes[0] == 0);
3496 rb_asan_unpoison_object(vp,
false);
3500 if (
objspace->flags.during_compacting) {
3506 rb_bug(
"T_MOVED shouldn't be seen until compaction is finished");
3508 gc_report(3,
objspace,
"page_sweep: %s is added to freelist\n", rb_obj_info(vp));
3510 heap_page_add_freeobj(
objspace, sweep_page, vp);
3520#if RGENGC_CHECK_MODE
3522 if (RVALUE_OLD_P(
objspace, vp)) rb_bug(
"page_sweep: %p - old while minor GC.", (
void *)p);
3523 if (RVALUE_REMEMBERED(
objspace, vp)) rb_bug(
"page_sweep: %p - remembered.", (
void *)p);
3527#if RGENGC_CHECK_MODE
3528#define CHECK(x) if (x(objspace, vp) != FALSE) rb_bug("obj_free: " #x "(%s) != FALSE", rb_obj_info(vp))
3529 CHECK(RVALUE_WB_UNPROTECTED);
3530 CHECK(RVALUE_MARKED);
3531 CHECK(RVALUE_MARKING);
3532 CHECK(RVALUE_UNCOLLECTIBLE);
3536 if (!rb_gc_obj_needs_cleanup_p(vp)) {
3541 (void)VALGRIND_MAKE_MEM_UNDEFINED((
void*)p, slot_size);
3542 heap_page_add_freeobj(
objspace, sweep_page, vp);
3543 gc_report(3,
objspace,
"page_sweep: %s (fast path) added to freelist\n", rb_obj_info(vp));
3547 gc_report(2,
objspace,
"page_sweep: free %p\n", (
void *)p);
3551 rb_gc_obj_free_vm_weak_references(vp);
3552 if (rb_gc_obj_free(
objspace, vp)) {
3553 (void)VALGRIND_MAKE_MEM_UNDEFINED((
void*)p, slot_size);
3554 heap_page_add_freeobj(
objspace, sweep_page, vp);
3555 gc_report(3,
objspace,
"page_sweep: %s is added to freelist\n", rb_obj_info(vp));
3573 struct heap_page *sweep_page = ctx->page;
3574 GC_ASSERT(sweep_page->heap == heap);
3577 bits_t *bits, bitset;
3579 gc_report(2,
objspace,
"page_sweep: start.\n");
3581#if RGENGC_CHECK_MODE
3582 if (!
objspace->flags.immediate_sweep) {
3583 GC_ASSERT(sweep_page->flags.before_sweep == TRUE);
3586 sweep_page->flags.before_sweep = FALSE;
3587 sweep_page->free_slots = 0;
3589 p = (uintptr_t)sweep_page->start;
3590 bits = sweep_page->mark_bits;
3591 short slot_size = sweep_page->slot_size;
3592 int total_slots = sweep_page->total_slots;
3593 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
3595 int out_of_range_bits = total_slots % BITS_BITLENGTH;
3596 if (out_of_range_bits != 0) {
3597 bits[bitmap_plane_count - 1] |= ~(((bits_t)1 << out_of_range_bits) - 1);
3602 bits_t *wb_unprotected_bits = sweep_page->wb_unprotected_bits;
3603 bits_t *age_bits = sweep_page->age_bits;
3604 for (
int i = 0; i < bitmap_plane_count; i++) {
3605 bits_t unmarked = ~bits[i];
3606 wb_unprotected_bits[i] &= ~unmarked;
3607 age_bits[i * 2] &= ~unmarked;
3608 age_bits[i * 2 + 1] &= ~unmarked;
3612 for (
int i = 0; i < bitmap_plane_count; i++) {
3615 gc_sweep_plane(
objspace, heap, p, bitset, ctx);
3617 p += BITS_BITLENGTH * slot_size;
3620 if (!heap->compact_cursor) {
3621 gc_setup_mark_bits(sweep_page);
3624#if GC_PROFILE_MORE_DETAIL
3627 record->removing_objects += ctx->final_slots + ctx->freed_slots;
3628 record->empty_objects += ctx->empty_slots;
3631 if (0) fprintf(stderr,
"gc_sweep_page(%"PRIdSIZE
"): total_slots: %d, freed_slots: %d, empty_slots: %d, final_slots: %d\n",
3633 sweep_page->total_slots,
3634 ctx->freed_slots, ctx->empty_slots, ctx->final_slots);
3636 sweep_page->free_slots += ctx->freed_slots + ctx->empty_slots;
3637 sweep_page->heap->total_freed_objects += ctx->freed_slots;
3639 if (heap_pages_deferred_final && !finalizing) {
3640 gc_finalize_deferred_register(
objspace);
3643#if RGENGC_CHECK_MODE
3644 short freelist_len = 0;
3645 asan_unlock_freelist(sweep_page);
3646 struct free_slot *ptr = sweep_page->freelist;
3649 rb_asan_unpoison_object((
VALUE)ptr,
false);
3651 rb_asan_poison_object((
VALUE)ptr);
3654 asan_lock_freelist(sweep_page);
3655 if (freelist_len != sweep_page->free_slots) {
3656 rb_bug(
"inconsistent freelist length: expected %d but was %d", sweep_page->free_slots, freelist_len);
3660 gc_report(2,
objspace,
"page_sweep: end.\n");
3664gc_mode_name(
enum gc_mode mode)
3667 case gc_mode_none:
return "none";
3668 case gc_mode_marking:
return "marking";
3669 case gc_mode_sweeping:
return "sweeping";
3670 case gc_mode_compacting:
return "compacting";
3671 default: rb_bug(
"gc_mode_name: unknown mode: %d", (
int)mode);
3678#if RGENGC_CHECK_MODE
3679 enum gc_mode prev_mode = gc_mode(
objspace);
3680 switch (prev_mode) {
3681 case gc_mode_none: GC_ASSERT(mode == gc_mode_marking);
break;
3682 case gc_mode_marking: GC_ASSERT(mode == gc_mode_sweeping);
break;
3683 case gc_mode_sweeping: GC_ASSERT(mode == gc_mode_none || mode == gc_mode_compacting);
break;
3684 case gc_mode_compacting: GC_ASSERT(mode == gc_mode_none);
break;
3687 if (0) fprintf(stderr,
"gc_mode_transition: %s->%s\n", gc_mode_name(gc_mode(
objspace)), gc_mode_name(mode));
3695 asan_unlock_freelist(page);
3696 if (page->freelist) {
3698 rb_asan_unpoison_object((
VALUE)p,
false);
3702 rb_asan_poison_object((
VALUE)prev);
3703 rb_asan_unpoison_object((
VALUE)p,
false);
3706 rb_asan_poison_object((
VALUE)p);
3709 page->freelist = freelist;
3711 asan_lock_freelist(page);
3718 heap->sweeping_page = ccan_list_top(&heap->pages,
struct heap_page, page_node);
3719 heap->free_pages = NULL;
3720 heap->pooled_pages = NULL;
3721 if (!
objspace->flags.immediate_sweep) {
3724 ccan_list_for_each(&heap->pages, page, page_node) {
3725 page->flags.before_sweep = TRUE;
3730#if defined(__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ == 4
3734#if GC_CAN_COMPILE_COMPACTION
3735static void gc_sort_heap_by_compare_func(
rb_objspace_t *
objspace, gc_compact_compare_func compare_func);
3736static int compare_pinned_slots(
const void *left,
const void *right,
void *d);
3740gc_ractor_newobj_cache_clear(
void *c,
void *data)
3745 newobj_cache->incremental_mark_step_allocated_slots = 0;
3747 for (
size_t heap_idx = 0; heap_idx < HEAP_COUNT; heap_idx++) {
3753 cache->allocated_objects_count = 0;
3755 struct heap_page *page = cache->using_page;
3756 struct free_slot *freelist = cache->freelist;
3757 RUBY_DEBUG_LOG(
"ractor using_page:%p freelist:%p", (
void *)page, (
void *)freelist);
3759 heap_page_freelist_append(page, freelist);
3761 cache->using_page = NULL;
3762 cache->freelist = NULL;
3769 gc_mode_transition(
objspace, gc_mode_sweeping);
3772#if GC_CAN_COMPILE_COMPACTION
3773 if (
objspace->flags.during_compacting) {
3774 gc_sort_heap_by_compare_func(
3776 objspace->rcompactor.compare_func ?
objspace->rcompactor.compare_func : compare_pinned_slots
3781 for (
int i = 0; i < HEAP_COUNT; i++) {
3783 gc_sweep_start_heap(
objspace, heap);
3786 if (heap->sweeping_page == NULL) {
3787 GC_ASSERT(heap->total_pages == 0);
3788 GC_ASSERT(heap->total_slots == 0);
3789 gc_sweep_finish_heap(
objspace, heap);
3793 rb_gc_ractor_newobj_cache_foreach(gc_ractor_newobj_cache_clear, NULL);
3799 size_t total_slots = heap->total_slots;
3800 size_t swept_slots = heap->freed_slots + heap->empty_slots;
3802 size_t init_slots = gc_params.heap_init_bytes / heap->slot_size;
3803 size_t min_free_slots = (size_t)(MAX(total_slots, init_slots) * gc_params.heap_free_slots_min_ratio);
3805 if (swept_slots < min_free_slots &&
3807 ((heap->empty_slots == 0 && total_slots > 0) || heap->freed_slots > heap->empty_slots)) {
3813 while (swept_slots < min_free_slots &&
3814 (resurrected_page = heap_page_resurrect(
objspace))) {
3815 heap_add_page(
objspace, heap, resurrected_page);
3816 heap_add_freepage(heap, resurrected_page);
3818 swept_slots += resurrected_page->free_slots;
3821 if (swept_slots < min_free_slots) {
3825 objspace->profile.count -
objspace->rgengc.last_major_gc < RVALUE_OLD_AGE) {
3826 if (
objspace->heap_pages.allocatable_bytes < min_free_slots * heap->slot_size) {
3827 heap_allocatable_bytes_expand(
objspace, heap, swept_slots, heap->total_slots, heap->slot_size);
3830 else if (
objspace->heap_pages.allocatable_bytes < (min_free_slots - swept_slots) * heap->slot_size) {
3831 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_NOFREE;
3832 heap->force_major_gc_count++;
3841 gc_report(1,
objspace,
"gc_sweep_finish\n");
3844 heap_pages_free_unused_pages(
objspace);
3846 for (
int i = 0; i < HEAP_COUNT; i++) {
3849 heap->freed_slots = 0;
3850 heap->empty_slots = 0;
3852 if (!will_be_incremental_marking(
objspace)) {
3853 struct heap_page *end_page = heap->free_pages;
3855 while (end_page->free_next) end_page = end_page->free_next;
3856 end_page->free_next = heap->pooled_pages;
3859 heap->free_pages = heap->pooled_pages;
3861 heap->pooled_pages = NULL;
3867 gc_mode_transition(
objspace, gc_mode_none);
3869#if RGENGC_CHECK_MODE >= 2
3870 gc_verify_internal_consistency(
objspace);
3877 struct heap_page *sweep_page = heap->sweeping_page;
3878 int swept_slots = 0;
3879 int pooled_slots = 0;
3881 if (sweep_page == NULL)
return FALSE;
3883#if GC_ENABLE_LAZY_SWEEP
3884 gc_prof_sweep_timer_start(
objspace);
3888 RUBY_DEBUG_LOG(
"sweep_page:%p", (
void *)sweep_page);
3896 gc_sweep_page(
objspace, heap, &ctx);
3897 int free_slots = ctx.freed_slots + ctx.empty_slots;
3899 heap->sweeping_page = ccan_list_next(&heap->pages, sweep_page, page_node);
3901 if (free_slots == sweep_page->total_slots) {
3903 heap_unlink_page(
objspace, heap, sweep_page);
3905 sweep_page->start = 0;
3906 sweep_page->total_slots = 0;
3907 sweep_page->slot_size = 0;
3908 sweep_page->heap = NULL;
3909 sweep_page->free_slots = 0;
3911 asan_unlock_freelist(sweep_page);
3912 sweep_page->freelist = NULL;
3913 asan_lock_freelist(sweep_page);
3915 asan_poison_memory_region(sweep_page->body, HEAP_PAGE_SIZE);
3918 sweep_page->free_next =
objspace->empty_pages;
3919 objspace->empty_pages = sweep_page;
3921 else if (free_slots > 0) {
3922 heap->freed_slots += ctx.freed_slots;
3923 heap->empty_slots += ctx.empty_slots;
3925 if (pooled_slots < GC_INCREMENTAL_SWEEP_POOL_SLOT_COUNT) {
3926 heap_add_poolpage(
objspace, heap, sweep_page);
3927 pooled_slots += free_slots;
3930 heap_add_freepage(heap, sweep_page);
3931 swept_slots += free_slots;
3932 if (swept_slots > GC_INCREMENTAL_SWEEP_SLOT_COUNT) {
3938 sweep_page->free_next = NULL;
3940 }
while ((sweep_page = heap->sweeping_page));
3942 if (!heap->sweeping_page) {
3943 gc_sweep_finish_heap(
objspace, heap);
3945 if (!has_sweeping_pages(
objspace)) {
3950#if GC_ENABLE_LAZY_SWEEP
3951 gc_prof_sweep_timer_stop(
objspace);
3954 return heap->free_pages != NULL;
3960 for (
int i = 0; i < HEAP_COUNT; i++) {
3963 while (heap->sweeping_page) {
3972 GC_ASSERT(dont_gc_val() == FALSE ||
objspace->profile.latest_gc_info & GPR_FLAG_METHOD);
3973 if (!GC_ENABLE_LAZY_SWEEP)
return;
3977 for (
int i = 0; i < HEAP_COUNT; i++) {
3979 if (gc_sweep_step(
objspace, heap)) {
3980 GC_ASSERT(heap->free_pages != NULL);
3982 else if (heap == sweep_heap) {
3983 if (
objspace->empty_pages_count > 0 ||
objspace->heap_pages.allocatable_bytes > 0) {
3994 heap_page_allocate_and_initialize(
objspace, heap);
3996 GC_ASSERT(heap->free_pages != NULL);
4001 GC_ASSERT(gc_mode(
objspace) == gc_mode_none);
4011rb_gc_impl_location(
void *objspace_ptr,
VALUE value)
4015 asan_unpoisoning_object(value) {
4017 destination = (
VALUE)RMOVED(value)->destination;
4021 destination = value;
4028#if GC_CAN_COMPILE_COMPACTION
4039 GC_ASSERT(RVALUE_PINNED(
objspace, forwarding_object));
4040 GC_ASSERT(!RVALUE_MARKED(
objspace, forwarding_object));
4042 CLEAR_IN_BITMAP(GET_HEAP_PINNED_BITS(forwarding_object), forwarding_object);
4044 object = rb_gc_impl_location(
objspace, forwarding_object);
4046 uint32_t original_shape_id = 0;
4048 original_shape_id = RMOVED(forwarding_object)->original_shape_id;
4051 gc_move(
objspace,
object, forwarding_object, GET_HEAP_PAGE(
object)->slot_size, page->slot_size);
4055 if (original_shape_id) {
4056 rb_gc_set_shape(forwarding_object, original_shape_id);
4059 struct heap_page *orig_page = GET_HEAP_PAGE(
object);
4060 orig_page->free_slots++;
4061 RVALUE_AGE_SET_BITMAP(
object, 0);
4062 heap_page_add_freeobj(
objspace, orig_page,
object);
4064 GC_ASSERT(RVALUE_MARKED(
objspace, forwarding_object));
4069 p += page->slot_size;
4079 bits_t *mark_bits, *pin_bits;
4081 short slot_size = page->slot_size;
4082 int total_slots = page->total_slots;
4083 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
4085 mark_bits = page->mark_bits;
4086 pin_bits = page->pinned_bits;
4088 uintptr_t p = page->start;
4090 for (i=0; i < bitmap_plane_count; i++) {
4093 bitset = pin_bits[i] & ~mark_bits[i];
4094 invalidate_moved_plane(
objspace, page, p, bitset);
4095 p += BITS_BITLENGTH * slot_size;
4104 gc_mode_transition(
objspace, gc_mode_compacting);
4106 for (
int i = 0; i < HEAP_COUNT; i++) {
4108 ccan_list_for_each(&heap->pages, page, page_node) {
4109 page->flags.before_sweep = TRUE;
4112 heap->compact_cursor = ccan_list_tail(&heap->pages,
struct heap_page, page_node);
4113 heap->compact_cursor_index = 0;
4118 record->moved_objects =
objspace->rcompactor.total_moved;
4121 memset(
objspace->rcompactor.considered_count_table, 0,
T_MASK *
sizeof(
size_t));
4122 memset(
objspace->rcompactor.moved_count_table, 0,
T_MASK *
sizeof(
size_t));
4123 memset(
objspace->rcompactor.moved_up_count_table, 0,
T_MASK *
sizeof(
size_t));
4124 memset(
objspace->rcompactor.moved_down_count_table, 0,
T_MASK *
sizeof(
size_t));
4137 const unsigned int immediate_sweep =
objspace->flags.immediate_sweep;
4139 gc_report(1,
objspace,
"gc_sweep: immediate: %d\n", immediate_sweep);
4142 if (
objspace->flags.during_compacting) {
4146 if (immediate_sweep) {
4147#if !GC_ENABLE_LAZY_SWEEP
4148 gc_prof_sweep_timer_start(
objspace);
4151#if !GC_ENABLE_LAZY_SWEEP
4152 gc_prof_sweep_timer_stop(
objspace);
4158 for (
int i = 0; i < HEAP_COUNT; i++) {
4170stack_chunk_alloc(
void)
4184 return stack->chunk == NULL;
4190 size_t size = stack->index;
4191 stack_chunk_t *chunk = stack->chunk ? stack->chunk->next : NULL;
4194 size += stack->limit;
4195 chunk = chunk->next;
4203 chunk->next = stack->cache;
4204 stack->cache = chunk;
4205 stack->cache_size++;
4213 if (stack->unused_cache_size > (stack->cache_size/2)) {
4214 chunk = stack->cache;
4215 stack->cache = stack->cache->next;
4216 stack->cache_size--;
4219 stack->unused_cache_size = stack->cache_size;
4227 GC_ASSERT(stack->index == stack->limit);
4229 if (stack->cache_size > 0) {
4230 next = stack->cache;
4231 stack->cache = stack->cache->next;
4232 stack->cache_size--;
4233 if (stack->unused_cache_size > stack->cache_size)
4234 stack->unused_cache_size = stack->cache_size;
4237 next = stack_chunk_alloc();
4239 next->next = stack->chunk;
4240 stack->chunk = next;
4249 prev = stack->chunk->next;
4250 GC_ASSERT(stack->index == 0);
4251 add_stack_chunk_cache(stack, stack->chunk);
4252 stack->chunk = prev;
4253 stack->index = stack->limit;
4261 while (chunk != NULL) {
4271 mark_stack_chunk_list_free(stack->chunk);
4277 mark_stack_chunk_list_free(stack->cache);
4278 stack->cache_size = 0;
4279 stack->unused_cache_size = 0;
4306 if (stack->index == stack->limit) {
4307 push_mark_stack_chunk(stack);
4309 stack->chunk->data[stack->index++] = obj;
4319 rb_bug(
"push_mark_stack() called for broken object");
4323 rb_bug(
"push_mark_stack: unexpected T_NODE object");
4327 rb_bug(
"rb_gc_mark(): unknown data type 0x%x(%p) %s",
4329 is_pointer_to_heap((
rb_objspace_t *)rb_gc_get_objspace(), (
void *)obj) ?
"corrupted object" :
"non object");
4335 if (is_mark_stack_empty(stack)) {
4338 if (stack->index == 1) {
4339 *data = stack->chunk->data[--stack->index];
4340 pop_mark_stack_chunk(stack);
4343 *data = stack->chunk->data[--stack->index];
4354 stack->index = stack->limit = STACK_CHUNK_SIZE;
4356 for (i=0; i < 4; i++) {
4357 add_stack_chunk_cache(stack, stack_chunk_alloc());
4359 stack->unused_cache_size = stack->cache_size;
4367 if (
objspace->rgengc.parent_object_old_p) {
4368 if (RVALUE_WB_UNPROTECTED(
objspace, obj) || !RVALUE_OLD_P(
objspace, obj)) {
4377 if (RVALUE_MARKED(
objspace, obj))
return 0;
4378 MARK_IN_BITMAP(GET_HEAP_MARK_BITS(obj), obj);
4392 if(!gc_config_full_mark_val)
4395 struct heap_page *page = GET_HEAP_PAGE(obj);
4397 GC_ASSERT(RVALUE_MARKING(
objspace, obj) == FALSE);
4398 check_rvalue_consistency(
objspace, obj);
4400 if (!RVALUE_PAGE_WB_UNPROTECTED(page, obj)) {
4401 if (!RVALUE_OLD_P(
objspace, obj)) {
4404 gc_report(3,
objspace,
"gc_aging: YOUNG class: %s\n", rb_obj_info(obj));
4405 RVALUE_AGE_SET(obj, RVALUE_OLD_AGE);
4406 RVALUE_OLD_UNCOLLECTIBLE_SET(
objspace, obj);
4409 gc_report(3,
objspace,
"gc_aging: YOUNG: %s\n", rb_obj_info(obj));
4413 else if (is_full_marking(
objspace)) {
4414 GC_ASSERT(RVALUE_PAGE_UNCOLLECTIBLE(page, obj) == FALSE);
4415 RVALUE_PAGE_OLD_UNCOLLECTIBLE_SET(
objspace, page, obj);
4418 check_rvalue_consistency(
objspace, obj);
4426#if RGENGC_CHECK_MODE
4427 if (RVALUE_MARKED(
objspace, obj) == FALSE) rb_bug(
"gc_grey: %s is not marked.", rb_obj_info(obj));
4428 if (RVALUE_MARKING(
objspace, obj) == TRUE) rb_bug(
"gc_grey: %s is marking/remembered.", rb_obj_info(obj));
4431 if (is_incremental_marking(
objspace)) {
4432 MARK_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), obj);
4436 rb_darray_append_without_gc(&
objspace->weak_references, obj);
4439 push_mark_stack(&
objspace->mark_stack, obj);
4446 enum {info_size = 256};
4447 char obj_info_buf[info_size];
4448 rb_raw_obj_info(obj_info_buf, info_size, obj);
4450 char parent_obj_info_buf[info_size];
4451 rb_raw_obj_info(parent_obj_info_buf, info_size,
objspace->rgengc.parent_object);
4453 rb_bug(
"try to mark T_NONE object (obj: %s, parent: %s)", obj_info_buf, parent_obj_info_buf);
4460 GC_ASSERT(during_gc);
4461 GC_ASSERT(!
objspace->flags.during_reference_updating);
4463 rgengc_check_relation(
objspace, obj);
4464 if (!gc_mark_set(
objspace, obj))
return;
4467 RUBY_DEBUG_LOG(
"%p (%s) parent:%p (%s)",
4468 (
void *)obj, obj_type_name(obj),
4469 (
void *)
objspace->rgengc.parent_object, obj_type_name(
objspace->rgengc.parent_object));
4472 gc_mark_check_t_none(
objspace, obj);
4482 if (RB_UNLIKELY(
objspace->flags.during_compacting)) {
4483 if (RB_LIKELY(during_gc)) {
4484 if (!RVALUE_PINNED(
objspace, obj)) {
4485 GC_ASSERT(GET_HEAP_PAGE(obj)->pinned_slots <= GET_HEAP_PAGE(obj)->total_slots);
4486 GET_HEAP_PAGE(obj)->pinned_slots++;
4487 MARK_IN_BITMAP(GET_HEAP_PINNED_BITS(obj), obj);
4501rb_gc_impl_mark_and_move(
void *objspace_ptr,
VALUE *ptr)
4505 if (RB_UNLIKELY(
objspace->flags.during_reference_updating)) {
4506 GC_ASSERT(
objspace->flags.during_compacting);
4507 GC_ASSERT(during_gc);
4510 if (destination != *ptr) {
4520rb_gc_impl_mark(
void *objspace_ptr,
VALUE obj)
4528rb_gc_impl_mark_and_pin(
void *objspace_ptr,
VALUE obj)
4536rb_gc_impl_mark_maybe(
void *objspace_ptr,
VALUE obj)
4540 (void)VALGRIND_MAKE_MEM_DEFINED(&obj,
sizeof(obj));
4542 if (is_pointer_to_heap(
objspace, (
void *)obj)) {
4543 asan_unpoisoning_object(obj) {
4558pin_value(st_data_t key, st_data_t value, st_data_t data)
4560 rb_gc_impl_mark_and_pin((
void *)data, (
VALUE)value);
4568 asan_unpoison_memory_region(&
objspace->rgengc.parent_object,
sizeof(
objspace->rgengc.parent_object),
false);
4569 asan_unpoison_memory_region(&
objspace->rgengc.parent_object_old_p,
sizeof(
objspace->rgengc.parent_object_old_p),
false);
4570 objspace->rgengc.parent_object = obj;
4571 objspace->rgengc.parent_object_old_p = old_p;
4583 asan_poison_memory_region(&
objspace->rgengc.parent_object,
sizeof(
objspace->rgengc.parent_object));
4584 asan_poison_memory_region(&
objspace->rgengc.parent_object_old_p,
sizeof(
objspace->rgengc.parent_object_old_p));
4590#define MARK_CHECKPOINT(category) do { \
4591 if (categoryp) *categoryp = category; \
4594 MARK_CHECKPOINT(
"objspace");
4597 if (finalizer_table != NULL) {
4598 st_foreach(finalizer_table, pin_value, (st_data_t)
objspace);
4601 if (stress_to_class) rb_gc_mark(stress_to_class);
4603 rb_gc_save_machine_context();
4604 rb_gc_mark_roots(
objspace, categoryp);
4605 gc_mark_set_parent_invalid(
objspace);
4612 rb_gc_mark_children(
objspace, obj);
4613 gc_mark_set_parent_invalid(
objspace);
4625 size_t marked_slots_at_the_beginning =
objspace->marked_slots;
4626 size_t popped_count = 0;
4628 while (pop_mark_stack(mstack, &obj)) {
4629 if (obj ==
Qundef)
continue;
4631 if (RGENGC_CHECK_MODE && !RVALUE_MARKED(
objspace, obj)) {
4632 rb_bug(
"gc_mark_stacked_objects: %s is not marked.", rb_obj_info(obj));
4637 if (RGENGC_CHECK_MODE && !RVALUE_MARKING(
objspace, obj)) {
4638 rb_bug(
"gc_mark_stacked_objects: incremental, but marking bit is 0");
4640 CLEAR_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), obj);
4643 if (popped_count + (
objspace->marked_slots - marked_slots_at_the_beginning) > count) {
4652 if (RGENGC_CHECK_MODE >= 3) gc_verify_internal_consistency(
objspace);
4654 if (is_mark_stack_empty(mstack)) {
4655 shrink_stack_chunk_cache(mstack);
4666 return gc_mark_stacked_objects(
objspace, TRUE, count);
4672 return gc_mark_stacked_objects(
objspace, FALSE, 0);
4675#if RGENGC_CHECK_MODE >= 4
4677#define MAKE_ROOTSIG(obj) (((VALUE)(obj) << 1) | 0x01)
4678#define IS_ROOTSIG(obj) ((VALUE)(obj) & 0x01)
4679#define GET_ROOTSIG(obj) ((const char *)((VALUE)(obj) >> 1))
4687static struct reflist *
4688reflist_create(
VALUE obj)
4690 struct reflist *refs =
xmalloc(
sizeof(
struct reflist));
4693 refs->list[0] = obj;
4699reflist_destruct(
struct reflist *refs)
4706reflist_add(
struct reflist *refs,
VALUE obj)
4708 if (refs->pos == refs->size) {
4710 SIZED_REALLOC_N(refs->list,
VALUE, refs->size, refs->size/2);
4713 refs->list[refs->pos++] = obj;
4717reflist_dump(
struct reflist *refs)
4720 for (i=0; i<refs->pos; i++) {
4721 VALUE obj = refs->list[i];
4722 if (IS_ROOTSIG(obj)) {
4723 fprintf(stderr,
"<root@%s>", GET_ROOTSIG(obj));
4726 fprintf(stderr,
"<%s>", rb_obj_info(obj));
4728 if (i+1 < refs->pos) fprintf(stderr,
", ");
4733reflist_referred_from_machine_context(
struct reflist *refs)
4736 for (i=0; i<refs->pos; i++) {
4737 VALUE obj = refs->list[i];
4738 if (IS_ROOTSIG(obj) && strcmp(GET_ROOTSIG(obj),
"machine_context") == 0)
return 1;
4753 const char *category;
4759allrefs_add(
struct allrefs *data,
VALUE obj)
4761 struct reflist *refs;
4764 if (st_lookup(data->references, obj, &r)) {
4765 refs = (
struct reflist *)r;
4766 reflist_add(refs, data->root_obj);
4770 refs = reflist_create(data->root_obj);
4771 st_insert(data->references, obj, (st_data_t)refs);
4777allrefs_i(
VALUE obj,
void *ptr)
4779 struct allrefs *data = (
struct allrefs *)ptr;
4781 if (allrefs_add(data, obj)) {
4782 push_mark_stack(&data->mark_stack, obj);
4787allrefs_roots_i(
VALUE obj,
void *ptr)
4789 struct allrefs *data = (
struct allrefs *)ptr;
4790 if (strlen(data->category) == 0) rb_bug(
"!!!");
4791 data->root_obj = MAKE_ROOTSIG(data->category);
4793 if (allrefs_add(data, obj)) {
4794 push_mark_stack(&data->mark_stack, obj);
4797#define PUSH_MARK_FUNC_DATA(v) do { \
4798 struct gc_mark_func_data_struct *prev_mark_func_data = GET_VM()->gc.mark_func_data; \
4799 GET_VM()->gc.mark_func_data = (v);
4801#define POP_MARK_FUNC_DATA() GET_VM()->gc.mark_func_data = prev_mark_func_data;} while (0)
4806 struct allrefs data;
4807 struct gc_mark_func_data_struct mfd;
4809 int prev_dont_gc = dont_gc_val();
4813 data.references = st_init_numtable();
4814 init_mark_stack(&data.mark_stack);
4816 mfd.mark_func = allrefs_roots_i;
4820 PUSH_MARK_FUNC_DATA(&mfd);
4821 GET_VM()->gc.mark_func_data = &mfd;
4822 mark_roots(
objspace, &data.category);
4823 POP_MARK_FUNC_DATA();
4826 while (pop_mark_stack(&data.mark_stack, &obj)) {
4827 rb_objspace_reachable_objects_from(data.root_obj = obj, allrefs_i, &data);
4829 free_stack_chunks(&data.mark_stack);
4831 dont_gc_set(prev_dont_gc);
4832 return data.references;
4836objspace_allrefs_destruct_i(st_data_t key, st_data_t value, st_data_t ptr)
4838 struct reflist *refs = (
struct reflist *)value;
4839 reflist_destruct(refs);
4844objspace_allrefs_destruct(
struct st_table *refs)
4846 st_foreach(refs, objspace_allrefs_destruct_i, 0);
4847 st_free_table(refs);
4850#if RGENGC_CHECK_MODE >= 5
4852allrefs_dump_i(st_data_t k, st_data_t v, st_data_t ptr)
4855 struct reflist *refs = (
struct reflist *)v;
4856 fprintf(stderr,
"[allrefs_dump_i] %s <- ", rb_obj_info(obj));
4858 fprintf(stderr,
"\n");
4866 fprintf(stderr,
"[all refs] (size: %"PRIuVALUE
")\n", size);
4867 st_foreach(
objspace->rgengc.allrefs_table, allrefs_dump_i, 0);
4872gc_check_after_marks_i(st_data_t k, st_data_t v, st_data_t ptr)
4875 struct reflist *refs = (
struct reflist *)v;
4879 if (!RVALUE_MARKED(
objspace, obj)) {
4880 fprintf(stderr,
"gc_check_after_marks_i: %s is not marked and not oldgen.\n", rb_obj_info(obj));
4881 fprintf(stderr,
"gc_check_after_marks_i: %p is referred from ", (
void *)obj);
4884 if (reflist_referred_from_machine_context(refs)) {
4885 fprintf(stderr,
" (marked from machine stack).\n");
4890 fprintf(stderr,
"\n");
4897gc_marks_check(
rb_objspace_t *
objspace, st_foreach_callback_func *checker_func,
const char *checker_name)
4899 size_t saved_malloc_increase =
objspace->malloc_params.increase;
4900#if RGENGC_ESTIMATE_OLDMALLOC
4901 size_t saved_oldmalloc_increase =
objspace->malloc_counters.oldmalloc_increase;
4908 st_foreach(
objspace->rgengc.allrefs_table, checker_func, (st_data_t)
objspace);
4911 if (
objspace->rgengc.error_count > 0) {
4912#if RGENGC_CHECK_MODE >= 5
4915 if (checker_name) rb_bug(
"%s: GC has problem.", checker_name);
4918 objspace_allrefs_destruct(
objspace->rgengc.allrefs_table);
4919 objspace->rgengc.allrefs_table = 0;
4922 objspace->malloc_params.increase = saved_malloc_increase;
4923#if RGENGC_ESTIMATE_OLDMALLOC
4924 objspace->malloc_counters.oldmalloc_increase = saved_oldmalloc_increase;
4932 size_t live_object_count;
4933 size_t zombie_object_count;
4936 size_t old_object_count;
4937 size_t remembered_shady_count;
4941check_generation_i(
const VALUE child,
void *ptr)
4944 const VALUE parent = data->parent;
4946 if (RGENGC_CHECK_MODE) GC_ASSERT(RVALUE_OLD_P(data->objspace, parent));
4948 if (!RVALUE_OLD_P(data->objspace, child)) {
4949 if (!RVALUE_REMEMBERED(data->objspace, parent) &&
4950 !RVALUE_REMEMBERED(data->objspace, child) &&
4951 !RVALUE_UNCOLLECTIBLE(data->objspace, child)) {
4952 fprintf(stderr,
"verify_internal_consistency_reachable_i: WB miss (O->Y) %s -> %s\n", rb_obj_info(parent), rb_obj_info(child));
4959check_color_i(
const VALUE child,
void *ptr)
4962 const VALUE parent = data->parent;
4964 if (!RVALUE_WB_UNPROTECTED(data->objspace, parent) && RVALUE_WHITE_P(data->objspace, child)) {
4965 fprintf(stderr,
"verify_internal_consistency_reachable_i: WB miss (B->W) - %s -> %s\n",
4966 rb_obj_info(parent), rb_obj_info(child));
4972check_children_i(
const VALUE child,
void *ptr)
4975 if (check_rvalue_consistency_force(data->objspace, child, FALSE) != 0) {
4976 fprintf(stderr,
"check_children_i: %s has error (referenced from %s)",
4977 rb_obj_info(child), rb_obj_info(data->parent));
4984verify_internal_consistency_i(
void *page_start,
void *page_end,
size_t stride,
4990 for (obj = (
VALUE)page_start; obj != (
VALUE)page_end; obj += stride) {
4991 asan_unpoisoning_object(obj) {
4992 if (!rb_gc_impl_garbage_object_p(
objspace, obj)) {
4994 data->live_object_count++;
4999 if (!gc_object_moved_p(
objspace, obj)) {
5001 rb_objspace_reachable_objects_from(obj, check_children_i, (
void *)data);
5005 if (RVALUE_OLD_P(
objspace, obj)) data->old_object_count++;
5006 if (RVALUE_WB_UNPROTECTED(
objspace, obj) && RVALUE_UNCOLLECTIBLE(
objspace, obj)) data->remembered_shady_count++;
5011 rb_objspace_reachable_objects_from(obj, check_generation_i, (
void *)data);
5014 if (!is_marking(
objspace) && rb_gc_obj_shareable_p(obj)) {
5015 rb_gc_verify_shareable(obj);
5018 if (is_incremental_marking(
objspace)) {
5019 if (RVALUE_BLACK_P(
objspace, obj)) {
5022 rb_objspace_reachable_objects_from(obj, check_color_i, (
void *)data);
5028 data->zombie_object_count++;
5031 fprintf(stderr,
"verify_internal_consistency_i: T_ZOMBIE has extra flags set: %s\n",
5037 fprintf(stderr,
"verify_internal_consistency_i: FL_FINALIZE %s but %s finalizer_table: %s\n",
5038 FL_TEST(obj,
FL_FINALIZE) ?
"set" :
"not set", st_is_member(finalizer_table, obj) ?
"in" :
"not in",
5053 unsigned int has_remembered_shady = FALSE;
5054 unsigned int has_remembered_old = FALSE;
5055 int remembered_old_objects = 0;
5056 int free_objects = 0;
5057 int zombie_objects = 0;
5059 short slot_size = page->slot_size;
5060 uintptr_t start = (uintptr_t)page->start;
5061 uintptr_t end = start + page->total_slots * slot_size;
5063 for (uintptr_t ptr = start; ptr < end; ptr += slot_size) {
5065 asan_unpoisoning_object(val) {
5070 if (RVALUE_PAGE_UNCOLLECTIBLE(page, val) && RVALUE_PAGE_WB_UNPROTECTED(page, val)) {
5071 has_remembered_shady = TRUE;
5073 if (RVALUE_PAGE_MARKING(page, val)) {
5074 has_remembered_old = TRUE;
5075 remembered_old_objects++;
5080 if (!is_incremental_marking(
objspace) &&
5081 page->flags.has_remembered_objects == FALSE && has_remembered_old == TRUE) {
5083 for (uintptr_t ptr = start; ptr < end; ptr += slot_size) {
5085 if (RVALUE_PAGE_MARKING(page, val)) {
5086 fprintf(stderr,
"marking -> %s\n", rb_obj_info(val));
5089 rb_bug(
"page %p's has_remembered_objects should be false, but there are remembered old objects (%d). %s",
5090 (
void *)page, remembered_old_objects, obj ? rb_obj_info(obj) :
"");
5093 if (page->flags.has_uncollectible_wb_unprotected_objects == FALSE && has_remembered_shady == TRUE) {
5094 rb_bug(
"page %p's has_remembered_shady should be false, but there are remembered shady objects. %s",
5095 (
void *)page, obj ? rb_obj_info(obj) :
"");
5100 if (page->free_slots != free_objects) {
5101 rb_bug(
"page %p's free_slots should be %d, but %d", (
void *)page, page->free_slots, free_objects);
5104 if (page->final_slots != zombie_objects) {
5105 rb_bug(
"page %p's final_slots should be %d, but %d", (
void *)page, page->final_slots, zombie_objects);
5108 return remembered_old_objects;
5114 int remembered_old_objects = 0;
5117 ccan_list_for_each(head, page, page_node) {
5118 asan_unlock_freelist(page);
5123 rb_asan_unpoison_object(vp,
false);
5125 fprintf(stderr,
"freelist slot expected to be T_NONE but was: %s\n", rb_obj_info(vp));
5128 rb_asan_poison_object(prev);
5130 asan_lock_freelist(page);
5132 if (page->flags.has_remembered_objects == FALSE) {
5133 remembered_old_objects += gc_verify_heap_page(
objspace, page,
Qfalse);
5137 return remembered_old_objects;
5143 int remembered_old_objects = 0;
5144 for (
int i = 0; i < HEAP_COUNT; i++) {
5145 remembered_old_objects += gc_verify_heap_pages_(
objspace, &((&heaps[i])->pages));
5147 return remembered_old_objects;
5156 gc_report(5,
objspace,
"gc_verify_internal_consistency: start\n");
5159 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
5161 short slot_size = page->slot_size;
5163 uintptr_t start = (uintptr_t)page->start;
5164 uintptr_t end = start + page->total_slots * slot_size;
5166 verify_internal_consistency_i((
void *)start, (
void *)end, slot_size, &data);
5169 if (data.err_count != 0) {
5170#if RGENGC_CHECK_MODE >= 5
5171 objspace->rgengc.error_count = data.err_count;
5172 gc_marks_check(
objspace, NULL, NULL);
5175 rb_bug(
"gc_verify_internal_consistency: found internal inconsistency.");
5183 ractor_cache_flush_count(
objspace, rb_gc_get_ractor_newobj_cache());
5187 !rb_gc_multi_ractor_p()) {
5188 if (objspace_live_slots(
objspace) != data.live_object_count) {
5189 fprintf(stderr,
"heap_pages_final_slots: %"PRIdSIZE
", total_freed_objects: %"PRIdSIZE
"\n",
5191 rb_bug(
"inconsistent live slot number: expect %"PRIuSIZE
", but %"PRIuSIZE
".",
5192 objspace_live_slots(
objspace), data.live_object_count);
5197 if (
objspace->rgengc.old_objects != data.old_object_count) {
5198 rb_bug(
"inconsistent old slot number: expect %"PRIuSIZE
", but %"PRIuSIZE
".",
5199 objspace->rgengc.old_objects, data.old_object_count);
5201 if (
objspace->rgengc.uncollectible_wb_unprotected_objects != data.remembered_shady_count) {
5202 rb_bug(
"inconsistent number of wb unprotected objects: expect %"PRIuSIZE
", but %"PRIuSIZE
".",
5203 objspace->rgengc.uncollectible_wb_unprotected_objects, data.remembered_shady_count);
5208 size_t list_count = 0;
5211 VALUE z = heap_pages_deferred_final;
5214 z = RZOMBIE(z)->next;
5218 if (total_final_slots_count(
objspace) != data.zombie_object_count ||
5219 total_final_slots_count(
objspace) != list_count) {
5221 rb_bug(
"inconsistent finalizing object count:\n"
5222 " expect %"PRIuSIZE
"\n"
5223 " but %"PRIuSIZE
" zombies\n"
5224 " heap_pages_deferred_final list has %"PRIuSIZE
" items.",
5226 data.zombie_object_count,
5231 gc_report(5,
objspace,
"gc_verify_internal_consistency: OK\n");
5235gc_verify_internal_consistency(
void *objspace_ptr)
5239 unsigned int lev = RB_GC_VM_LOCK();
5243 unsigned int prev_during_gc = during_gc;
5246 gc_verify_internal_consistency_(
objspace);
5248 during_gc = prev_during_gc;
5250 RB_GC_VM_UNLOCK(lev);
5254heap_move_pooled_pages_to_free_pages(
rb_heap_t *heap)
5256 if (heap->pooled_pages) {
5257 if (heap->free_pages) {
5258 struct heap_page *free_pages_tail = heap->free_pages;
5259 while (free_pages_tail->free_next) {
5260 free_pages_tail = free_pages_tail->free_next;
5262 free_pages_tail->free_next = heap->pooled_pages;
5265 heap->free_pages = heap->pooled_pages;
5268 heap->pooled_pages = NULL;
5275 struct heap_page *page = GET_HEAP_PAGE(obj);
5276 bits_t *uncollectible_bits = &page->uncollectible_bits[0];
5278 if (!MARKED_IN_BITMAP(uncollectible_bits, obj)) {
5279 page->flags.has_uncollectible_wb_unprotected_objects = TRUE;
5280 MARK_IN_BITMAP(uncollectible_bits, obj);
5281 objspace->rgengc.uncollectible_wb_unprotected_objects++;
5283#if RGENGC_PROFILE > 0
5284 objspace->profile.total_remembered_shady_object_count++;
5285#if RGENGC_PROFILE >= 2
5297gc_marks_wb_unprotected_objects_plane(
rb_objspace_t *
objspace, uintptr_t p, bits_t bits,
short slot_size)
5302 gc_report(2,
objspace,
"gc_marks_wb_unprotected_objects: marked shady: %s\n", rb_obj_info((
VALUE)p));
5318 ccan_list_for_each(&heap->pages, page, page_node) {
5319 bits_t *mark_bits = page->mark_bits;
5320 bits_t *wbun_bits = page->wb_unprotected_bits;
5321 uintptr_t p = page->start;
5322 short slot_size = page->slot_size;
5323 int total_slots = page->total_slots;
5324 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
5327 for (j=0; j<(size_t)bitmap_plane_count; j++) {
5328 bits_t bits = mark_bits[j] & wbun_bits[j];
5329 gc_marks_wb_unprotected_objects_plane(
objspace, p, bits, slot_size);
5330 p += BITS_BITLENGTH * slot_size;
5334 gc_mark_stacked_objects_all(
objspace);
5338rb_gc_impl_declare_weak_references(
void *objspace_ptr,
VALUE obj)
5344rb_gc_impl_handle_weak_references_alive_p(
void *objspace_ptr,
VALUE obj)
5348 bool marked = RVALUE_MARKED(
objspace, obj);
5351 rgengc_check_relation(
objspace, obj);
5361 rb_darray_foreach(
objspace->weak_references, i, obj_ptr) {
5362 gc_mark_set_parent(
objspace, *obj_ptr);
5363 rb_gc_handle_weak_references(*obj_ptr);
5364 gc_mark_set_parent_invalid(
objspace);
5367 size_t capa = rb_darray_capa(
objspace->weak_references);
5368 size_t size = rb_darray_size(
objspace->weak_references);
5370 objspace->profile.weak_references_count = size;
5372 rb_darray_clear(
objspace->weak_references);
5376 if (
capa > size * 4) {
5377 rb_darray_resize_capa_without_gc(&
objspace->weak_references, size * 2);
5385 if (is_incremental_marking(
objspace)) {
5386 if (RGENGC_CHECK_MODE && is_mark_stack_empty(&
objspace->mark_stack) == 0) {
5387 rb_bug(
"gc_marks_finish: mark stack is not empty (%"PRIdSIZE
").",
5388 mark_stack_size(&
objspace->mark_stack));
5392 while (gc_mark_stacked_objects_incremental(
objspace, INT_MAX) ==
false);
5394#if RGENGC_CHECK_MODE >= 2
5395 if (gc_verify_heap_pages(
objspace) != 0) {
5396 rb_bug(
"gc_marks_finish (incremental): there are remembered old objects.");
5400 objspace->flags.during_incremental_marking = FALSE;
5402 for (
int i = 0; i < HEAP_COUNT; i++) {
5403 gc_marks_wb_unprotected_objects(
objspace, &heaps[i]);
5407 gc_update_weak_references(
objspace);
5409#if RGENGC_CHECK_MODE >= 2
5410 gc_verify_internal_consistency(
objspace);
5413#if RGENGC_CHECK_MODE >= 4
5415 gc_marks_check(
objspace, gc_check_after_marks_i,
"after_marks");
5420 const unsigned long r_mul =
objspace->live_ractor_cache_count > 8 ? 8 :
objspace->live_ractor_cache_count;
5422 size_t total_slots = objspace_available_slots(
objspace);
5423 size_t sweep_slots = total_slots -
objspace->marked_slots;
5424 size_t max_free_slots = (size_t)(total_slots * gc_params.heap_free_slots_max_ratio);
5425 size_t min_free_slots = (size_t)(total_slots * gc_params.heap_free_slots_min_ratio);
5426 if (min_free_slots < gc_params.heap_free_slots * r_mul) {
5427 min_free_slots = gc_params.heap_free_slots * r_mul;
5430 int full_marking = is_full_marking(
objspace);
5435 size_t total_init_slots = 0;
5436 for (
int i = 0; i < HEAP_COUNT; i++) {
5437 total_init_slots += (gc_params.heap_init_bytes / heaps[i].slot_size) * r_mul;
5440 if (max_free_slots < total_init_slots) {
5441 max_free_slots = total_init_slots;
5445 if (sweep_slots > max_free_slots) {
5446 size_t excess_slots = sweep_slots - max_free_slots;
5447 size_t total_heap_pages = heap_eden_total_pages(
objspace);
5448 heap_pages_freeable_pages = total_heap_pages > 0
5449 ? excess_slots * total_heap_pages / total_slots
5453 heap_pages_freeable_pages = 0;
5456 if (
objspace->heap_pages.allocatable_bytes == 0 && sweep_slots < min_free_slots) {
5457 if (!full_marking) {
5458 if (
objspace->profile.count -
objspace->rgengc.last_major_gc < RVALUE_OLD_AGE) {
5459 full_marking = TRUE;
5462 gc_report(1,
objspace,
"gc_marks_finish: next is full GC!!)\n");
5463 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_NOFREE;
5468 heap_allocatable_bytes_expand(
objspace, NULL, sweep_slots, total_slots, heaps[0].slot_size);
5474 const double r = gc_params.oldobject_limit_factor;
5475 objspace->rgengc.uncollectible_wb_unprotected_objects_limit = MAX(
5476 (
size_t)(
objspace->rgengc.uncollectible_wb_unprotected_objects * r),
5477 (
size_t)(
objspace->rgengc.old_objects * gc_params.uncollectible_wb_unprotected_objects_limit_ratio)
5479 objspace->rgengc.old_objects_limit = (size_t)(
objspace->rgengc.old_objects * r);
5482 if (
objspace->rgengc.uncollectible_wb_unprotected_objects >
objspace->rgengc.uncollectible_wb_unprotected_objects_limit) {
5483 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_SHADY;
5486 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_OLDGEN;
5489 gc_report(1,
objspace,
"gc_marks_finish (marks %"PRIdSIZE
" objects, "
5490 "old %"PRIdSIZE
" objects, total %"PRIdSIZE
" slots, "
5491 "sweep %"PRIdSIZE
" slots, allocatable %"PRIdSIZE
" bytes, next GC: %s)\n",
5493 gc_needs_major_flags ?
"major" :
"minor");
5497 rb_ractor_finish_marking();
5503gc_compact_heap_cursors_met_p(
rb_heap_t *heap)
5505 return heap->sweeping_page == heap->compact_cursor;
5512 size_t obj_size = rb_gc_obj_optimal_size(obj);
5513 if (obj_size == 0) {
5517 GC_ASSERT(rb_gc_impl_size_allocatable_p(obj_size));
5519 size_t idx = heap_idx_for_size(obj_size);
5528 GC_ASSERT(gc_is_moveable_obj(
objspace, src));
5531 uint32_t orig_shape = 0;
5532 uint32_t new_shape = 0;
5534 if (gc_compact_heap_cursors_met_p(dest_pool)) {
5535 return dest_pool != heap;
5539 orig_shape = rb_gc_get_shape(src);
5541 if (dest_pool != heap) {
5542 new_shape = rb_gc_rebuild_shape(src, dest_pool - heaps);
5544 if (new_shape == 0) {
5550 while (!try_move(
objspace, dest_pool, dest_pool->free_pages, src)) {
5552 .page = dest_pool->sweeping_page,
5561 lock_page_body(
objspace, GET_PAGE_BODY(src));
5562 gc_sweep_page(
objspace, dest_pool, &ctx);
5563 unlock_page_body(
objspace, GET_PAGE_BODY(src));
5565 if (dest_pool->sweeping_page->free_slots > 0) {
5566 heap_add_freepage(dest_pool, dest_pool->sweeping_page);
5569 dest_pool->sweeping_page = ccan_list_next(&dest_pool->pages, dest_pool->sweeping_page, page_node);
5570 if (gc_compact_heap_cursors_met_p(dest_pool)) {
5571 return dest_pool != heap;
5575 if (orig_shape != 0) {
5576 if (new_shape != 0) {
5578 rb_gc_set_shape(dest, new_shape);
5580 RMOVED(src)->original_shape_id = orig_shape;
5589 short slot_size = page->slot_size;
5593 GC_ASSERT(vp % pool_slot_sizes[0] == 0);
5598 if (gc_is_moveable_obj(
objspace, vp)) {
5599 if (!gc_compact_move(
objspace, heap, vp)) {
5616 GC_ASSERT(page == heap->compact_cursor);
5618 bits_t *mark_bits, *pin_bits;
5620 uintptr_t p = page->start;
5621 short slot_size = page->slot_size;
5622 int total_slots = page->total_slots;
5623 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
5625 mark_bits = page->mark_bits;
5626 pin_bits = page->pinned_bits;
5628 for (
int j = 0; j < bitmap_plane_count; j++) {
5630 bitset = (mark_bits[j] & ~pin_bits[j]);
5632 if (!gc_compact_plane(
objspace, heap, (uintptr_t)p, bitset, page))
5635 p += BITS_BITLENGTH * slot_size;
5644 for (
int i = 0; i < HEAP_COUNT; i++) {
5647 if (heap->total_pages > 0 &&
5648 !gc_compact_heap_cursors_met_p(heap)) {
5660#if RGENGC_CHECK_MODE >= 2
5661 gc_verify_internal_consistency(
objspace);
5664 while (!gc_compact_all_compacted_p(
objspace)) {
5665 for (
int i = 0; i < HEAP_COUNT; i++) {
5668 if (gc_compact_heap_cursors_met_p(heap)) {
5672 struct heap_page *start_page = heap->compact_cursor;
5674 if (!gc_compact_page(
objspace, heap, start_page)) {
5675 lock_page_body(
objspace, start_page->body);
5682 lock_page_body(
objspace, start_page->body);
5683 heap->compact_cursor = ccan_list_prev(&heap->pages, heap->compact_cursor, page_node);
5689#if RGENGC_CHECK_MODE >= 2
5690 gc_verify_internal_consistency(
objspace);
5697 gc_report(1,
objspace,
"gc_marks_rest\n");
5699 for (
int i = 0; i < HEAP_COUNT; i++) {
5700 (&heaps[i])->pooled_pages = NULL;
5703 if (is_incremental_marking(
objspace)) {
5704 while (gc_mark_stacked_objects_incremental(
objspace, INT_MAX) == FALSE);
5707 gc_mark_stacked_objects_all(
objspace);
5716 bool marking_finished =
false;
5719 if (gc_mark_stacked_objects_incremental(
objspace, slots)) {
5722 marking_finished =
true;
5725 return marking_finished;
5731 GC_ASSERT(dont_gc_val() == FALSE ||
objspace->profile.latest_gc_info & GPR_FLAG_METHOD);
5732 bool marking_finished =
true;
5736 if (heap->free_pages) {
5737 gc_report(2,
objspace,
"gc_marks_continue: has pooled pages");
5742 gc_report(2,
objspace,
"gc_marks_continue: no more pooled pages (stack depth: %"PRIdSIZE
").\n",
5743 mark_stack_size(&
objspace->mark_stack));
5744 heap->force_incremental_marking_finish_count++;
5750 return marking_finished;
5757 gc_report(1,
objspace,
"gc_marks_start: (%s)\n", full_mark ?
"full" :
"minor");
5758 gc_mode_transition(
objspace, gc_mode_marking);
5761 size_t incremental_marking_steps = (
objspace->rincgc.pooled_slots / INCREMENTAL_MARK_STEP_ALLOCATIONS) + 1;
5762 objspace->rincgc.step_slots = (
objspace->marked_slots * 2) / incremental_marking_steps;
5764 if (0) fprintf(stderr,
"objspace->marked_slots: %"PRIdSIZE
", "
5765 "objspace->rincgc.pooled_page_num: %"PRIdSIZE
", "
5766 "objspace->rincgc.step_slots: %"PRIdSIZE
", \n",
5768 objspace->flags.during_minor_gc = FALSE;
5769 if (ruby_enable_autocompact) {
5770 objspace->flags.during_compacting |= TRUE;
5772 objspace->profile.major_gc_count++;
5773 objspace->rgengc.uncollectible_wb_unprotected_objects = 0;
5778 for (
int i = 0; i < HEAP_COUNT; i++) {
5780 rgengc_mark_and_rememberset_clear(
objspace, heap);
5781 heap_move_pooled_pages_to_free_pages(heap);
5783 if (
objspace->flags.during_compacting) {
5786 ccan_list_for_each(&heap->pages, page, page_node) {
5787 page->pinned_slots = 0;
5793 objspace->flags.during_minor_gc = TRUE;
5795 objspace->rgengc.old_objects +
objspace->rgengc.uncollectible_wb_unprotected_objects;
5796 objspace->profile.minor_gc_count++;
5798 for (
int i = 0; i < HEAP_COUNT; i++) {
5799 rgengc_rememberset_mark(
objspace, &heaps[i]);
5805 gc_report(1,
objspace,
"gc_marks_start: (%s) end, stack in %"PRIdSIZE
"\n",
5812 gc_prof_mark_timer_start(
objspace);
5815 bool marking_finished =
false;
5819 gc_marks_start(
objspace, full_mark);
5820 if (!is_incremental_marking(
objspace)) {
5822 marking_finished =
true;
5825#if RGENGC_PROFILE > 0
5828 record->old_objects =
objspace->rgengc.old_objects;
5835 return marking_finished;
5843 if (level <= RGENGC_DEBUG) {
5847 const char *status =
" ";
5850 status = is_full_marking(
objspace) ?
"+" :
"-";
5856 if (is_incremental_marking(
objspace)) {
5861 va_start(args, fmt);
5862 vsnprintf(buf, 1024, fmt, args);
5865 fprintf(out,
"%s|", status);
5875 struct heap_page *page = GET_HEAP_PAGE(obj);
5876 bits_t *bits = &page->remembered_bits[0];
5878 if (MARKED_IN_BITMAP(bits, obj)) {
5882 page->flags.has_remembered_objects = TRUE;
5883 MARK_IN_BITMAP(bits, obj);
5894 gc_report(6,
objspace,
"rgengc_remember: %s %s\n", rb_obj_info(obj),
5895 RVALUE_REMEMBERED(
objspace, obj) ?
"was already remembered" :
"is remembered now");
5897 check_rvalue_consistency(
objspace, obj);
5899 if (RGENGC_CHECK_MODE) {
5900 if (RVALUE_WB_UNPROTECTED(
objspace, obj)) rb_bug(
"rgengc_remember: %s is not wb protected.", rb_obj_info(obj));
5903#if RGENGC_PROFILE > 0
5904 if (!RVALUE_REMEMBERED(
objspace, obj)) {
5905 if (RVALUE_WB_UNPROTECTED(
objspace, obj) == 0) {
5906 objspace->profile.total_remembered_normal_object_count++;
5907#if RGENGC_PROFILE >= 2
5914 return rgengc_remembersetbits_set(
objspace, obj);
5917#ifndef PROFILE_REMEMBERSET_MARK
5918#define PROFILE_REMEMBERSET_MARK 0
5928 gc_report(2,
objspace,
"rgengc_rememberset_mark: mark %s\n", rb_obj_info(obj));
5929 GC_ASSERT(RVALUE_UNCOLLECTIBLE(
objspace, obj));
5930 GC_ASSERT(RVALUE_OLD_P(
objspace, obj) || RVALUE_WB_UNPROTECTED(
objspace, obj));
5935 rb_darray_append_without_gc(&
objspace->weak_references, obj);
5949#if PROFILE_REMEMBERSET_MARK
5950 int has_old = 0, has_shady = 0, has_both = 0, skip = 0;
5952 gc_report(1,
objspace,
"rgengc_rememberset_mark: start\n");
5954 ccan_list_for_each(&heap->pages, page, page_node) {
5955 if (page->flags.has_remembered_objects | page->flags.has_uncollectible_wb_unprotected_objects) {
5956 uintptr_t p = page->start;
5957 short slot_size = page->slot_size;
5958 int total_slots = page->total_slots;
5959 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
5960 bits_t bitset, bits[HEAP_PAGE_BITMAP_LIMIT];
5961 bits_t *remembered_bits = page->remembered_bits;
5962 bits_t *uncollectible_bits = page->uncollectible_bits;
5963 bits_t *wb_unprotected_bits = page->wb_unprotected_bits;
5964#if PROFILE_REMEMBERSET_MARK
5965 if (page->flags.has_remembered_objects && page->flags.has_uncollectible_wb_unprotected_objects) has_both++;
5966 else if (page->flags.has_remembered_objects) has_old++;
5967 else if (page->flags.has_uncollectible_wb_unprotected_objects) has_shady++;
5969 for (j=0; j < (size_t)bitmap_plane_count; j++) {
5970 bits[j] = remembered_bits[j] | (uncollectible_bits[j] & wb_unprotected_bits[j]);
5971 remembered_bits[j] = 0;
5973 page->flags.has_remembered_objects = FALSE;
5975 for (j=0; j < (size_t)bitmap_plane_count; j++) {
5977 rgengc_rememberset_mark_plane(
objspace, p, bitset, slot_size);
5978 p += BITS_BITLENGTH * slot_size;
5981#if PROFILE_REMEMBERSET_MARK
5988#if PROFILE_REMEMBERSET_MARK
5989 fprintf(stderr,
"%d\t%d\t%d\t%d\n", has_both, has_old, has_shady, skip);
5991 gc_report(1,
objspace,
"rgengc_rememberset_mark: finished\n");
5999 ccan_list_for_each(&heap->pages, page, page_node) {
6000 memset(&page->mark_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6001 memset(&page->uncollectible_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6002 memset(&page->marking_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6003 memset(&page->remembered_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6004 memset(&page->pinned_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6005 page->flags.has_uncollectible_wb_unprotected_objects = FALSE;
6006 page->flags.has_remembered_objects = FALSE;
6017 if (RGENGC_CHECK_MODE) {
6018 if (!RVALUE_OLD_P(
objspace, a)) rb_bug(
"gc_writebarrier_generational: %s is not an old object.", rb_obj_info(a));
6019 if ( RVALUE_OLD_P(
objspace, b)) rb_bug(
"gc_writebarrier_generational: %s is an old object.", rb_obj_info(b));
6020 if (is_incremental_marking(
objspace)) rb_bug(
"gc_writebarrier_generational: called while incremental marking: %s -> %s", rb_obj_info(a), rb_obj_info(b));
6024 if (!RVALUE_REMEMBERED(
objspace, a)) {
6025 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6029 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6031 gc_report(1,
objspace,
"gc_writebarrier_generational: %s (remembered) -> %s\n", rb_obj_info(a), rb_obj_info(b));
6034 check_rvalue_consistency(
objspace, a);
6035 check_rvalue_consistency(
objspace, b);
6041 gc_mark_set_parent(
objspace, parent);
6042 rgengc_check_relation(
objspace, obj);
6043 if (gc_mark_set(
objspace, obj) != FALSE) {
6047 gc_mark_set_parent_invalid(
objspace);
6055 gc_report(2,
objspace,
"gc_writebarrier_incremental: [LG] %p -> %s\n", (
void *)a, rb_obj_info(b));
6059 if (!RVALUE_WB_UNPROTECTED(
objspace, a)) {
6060 gc_report(2,
objspace,
"gc_writebarrier_incremental: [IN] %p -> %s\n", (
void *)a, rb_obj_info(b));
6068 if (RB_UNLIKELY(
objspace->flags.during_compacting)) {
6069 MARK_IN_BITMAP(GET_HEAP_PINNED_BITS(b), b);
6075rb_gc_impl_writebarrier(
void *objspace_ptr,
VALUE a,
VALUE b)
6079#if RGENGC_CHECK_MODE
6080 if (
SPECIAL_CONST_P(a)) rb_bug(
"rb_gc_writebarrier: a is special const: %"PRIxVALUE, a);
6081 if (
SPECIAL_CONST_P(b)) rb_bug(
"rb_gc_writebarrier: b is special const: %"PRIxVALUE, b);
6087 GC_ASSERT(!during_gc);
6096 if (!is_incremental_marking(
objspace)) {
6101 gc_writebarrier_generational(a, b,
objspace);
6107 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6109 if (is_incremental_marking(
objspace)) {
6110 gc_writebarrier_incremental(a, b,
objspace);
6116 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6118 if (retry)
goto retry;
6124rb_gc_impl_writebarrier_unprotect(
void *objspace_ptr,
VALUE obj)
6128 if (RVALUE_WB_UNPROTECTED(
objspace, obj)) {
6132 gc_report(2,
objspace,
"rb_gc_writebarrier_unprotect: %s %s\n", rb_obj_info(obj),
6133 RVALUE_REMEMBERED(
objspace, obj) ?
" (already remembered)" :
"");
6135 unsigned int lev = RB_GC_VM_LOCK_NO_BARRIER();
6138 gc_report(1,
objspace,
"rb_gc_writebarrier_unprotect: %s\n", rb_obj_info(obj));
6141 gc_remember_unprotected(
objspace, obj);
6144 objspace->profile.total_shade_operation_count++;
6145#if RGENGC_PROFILE >= 2
6151 RVALUE_AGE_RESET(obj);
6154 RB_DEBUG_COUNTER_INC(obj_wb_unprotect);
6155 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), obj);
6157 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6162rb_gc_impl_copy_attributes(
void *objspace_ptr,
VALUE dest,
VALUE obj)
6166 if (RVALUE_WB_UNPROTECTED(
objspace, obj)) {
6167 rb_gc_impl_writebarrier_unprotect(
objspace, dest);
6169 rb_gc_impl_copy_finalizer(
objspace, dest, obj);
6173rb_gc_impl_active_gc_name(
void)
6179rb_gc_impl_writebarrier_remember(
void *objspace_ptr,
VALUE obj)
6183 gc_report(1,
objspace,
"rb_gc_writebarrier_remember: %s\n", rb_obj_info(obj));
6186 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6188 if (is_incremental_marking(
objspace)) {
6189 if (RVALUE_BLACK_P(
objspace, obj)) {
6193 else if (RVALUE_OLD_P(
objspace, obj)) {
6197 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6203 ID ID_wb_protected, ID_age, ID_old, ID_uncollectible, ID_marking,
6204 ID_marked, ID_pinned, ID_remembered, ID_object_id, ID_shareable;
6207#define RB_GC_OBJECT_METADATA_ENTRY_COUNT (sizeof(struct rb_gc_object_metadata_names) / sizeof(ID))
6211rb_gc_impl_object_metadata(
void *objspace_ptr,
VALUE obj)
6217 if (!names.ID_marked) {
6218#define I(s) names.ID_##s = rb_intern(#s)
6232#define SET_ENTRY(na, v) do { \
6233 GC_ASSERT(n <= RB_GC_OBJECT_METADATA_ENTRY_COUNT); \
6234 object_metadata_entries[n].name = names.ID_##na; \
6235 object_metadata_entries[n].val = v; \
6239 if (!RVALUE_WB_UNPROTECTED(
objspace, obj)) SET_ENTRY(wb_protected,
Qtrue);
6240 SET_ENTRY(age,
INT2FIX(RVALUE_AGE_GET(obj)));
6242 if (RVALUE_UNCOLLECTIBLE(
objspace, obj)) SET_ENTRY(uncollectible,
Qtrue);
6243 if (RVALUE_MARKING(
objspace, obj)) SET_ENTRY(marking,
Qtrue);
6246 if (RVALUE_REMEMBERED(
objspace, obj)) SET_ENTRY(remembered,
Qtrue);
6247 if (rb_obj_id_p(obj)) SET_ENTRY(object_id, rb_obj_id(obj));
6250 object_metadata_entries[n].name = 0;
6251 object_metadata_entries[n].val = 0;
6254 return object_metadata_entries;
6258rb_gc_impl_ractor_cache_alloc(
void *objspace_ptr,
void *ractor)
6262 objspace->live_ractor_cache_count++;
6268rb_gc_impl_ractor_cache_free(
void *objspace_ptr,
void *cache)
6272 objspace->live_ractor_cache_count--;
6273 gc_ractor_newobj_cache_clear(cache, NULL);
6280 if (!heap->free_pages) {
6281 if (!heap_page_allocate_and_initialize(
objspace, heap)) {
6282 objspace->heap_pages.allocatable_bytes = HEAP_PAGE_SIZE;
6283 heap_page_allocate_and_initialize(
objspace, heap);
6291 if (dont_gc_val() || during_gc) {
6292 for (
int i = 0; i < HEAP_COUNT; i++) {
6309 size_t old_limit = malloc_limit;
6311 if (inc > malloc_limit) {
6312 malloc_limit = (size_t)(inc * gc_params.malloc_limit_growth_factor);
6313 if (malloc_limit > gc_params.malloc_limit_max) {
6314 malloc_limit = gc_params.malloc_limit_max;
6318 malloc_limit = (size_t)(malloc_limit * 0.98);
6319 if (malloc_limit < gc_params.malloc_limit_min) {
6320 malloc_limit = gc_params.malloc_limit_min;
6325 if (old_limit != malloc_limit) {
6326 fprintf(stderr,
"[%"PRIuSIZE
"] malloc_limit: %"PRIuSIZE
" -> %"PRIuSIZE
"\n",
6327 rb_gc_count(), old_limit, malloc_limit);
6330 fprintf(stderr,
"[%"PRIuSIZE
"] malloc_limit: not changed (%"PRIuSIZE
")\n",
6331 rb_gc_count(), malloc_limit);
6337#if RGENGC_ESTIMATE_OLDMALLOC
6339 if (
objspace->malloc_counters.oldmalloc_increase >
objspace->rgengc.oldmalloc_increase_limit) {
6340 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_OLDMALLOC;
6341 objspace->rgengc.oldmalloc_increase_limit =
6342 (size_t)(
objspace->rgengc.oldmalloc_increase_limit * gc_params.oldmalloc_limit_growth_factor);
6344 if (
objspace->rgengc.oldmalloc_increase_limit > gc_params.oldmalloc_limit_max) {
6345 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_max;
6349 if (0) fprintf(stderr,
"%"PRIdSIZE
"\t%d\t%"PRIuSIZE
"\t%"PRIuSIZE
"\t%"PRIdSIZE
"\n",
6351 gc_needs_major_flags,
6352 objspace->malloc_counters.oldmalloc_increase,
6353 objspace->rgengc.oldmalloc_increase_limit,
6354 gc_params.oldmalloc_limit_max);
6358 objspace->malloc_counters.oldmalloc_increase = 0;
6360 if ((
objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_BY_OLDMALLOC) == 0) {
6361 objspace->rgengc.oldmalloc_increase_limit =
6362 (size_t)(
objspace->rgengc.oldmalloc_increase_limit / ((gc_params.oldmalloc_limit_growth_factor - 1)/10 + 1));
6363 if (
objspace->rgengc.oldmalloc_increase_limit < gc_params.oldmalloc_limit_min) {
6364 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
6376 int lev = RB_GC_VM_LOCK();
6378#if GC_PROFILE_MORE_DETAIL
6379 objspace->profile.prepare_time = getrusage_time();
6384#if GC_PROFILE_MORE_DETAIL
6385 objspace->profile.prepare_time = getrusage_time() -
objspace->profile.prepare_time;
6390 RB_GC_VM_UNLOCK(lev);
6398 unsigned int do_full_mark = !!(reason & GPR_FLAG_FULL_MARK);
6400 if (!rb_darray_size(
objspace->heap_pages.sorted))
return TRUE;
6401 if (!(reason & GPR_FLAG_METHOD) && !ready_to_gc(
objspace))
return TRUE;
6403 GC_ASSERT(gc_mode(
objspace) == gc_mode_none,
"gc_mode is %s\n", gc_mode_name(gc_mode(
objspace)));
6404 GC_ASSERT(!is_lazy_sweeping(
objspace));
6405 GC_ASSERT(!is_incremental_marking(
objspace));
6407 unsigned int lock_lev;
6408 gc_enter(
objspace, gc_enter_event_start, &lock_lev);
6411 objspace->flags.immediate_sweep = !!(reason & GPR_FLAG_IMMEDIATE_SWEEP);
6413#if RGENGC_CHECK_MODE >= 2
6414 gc_verify_internal_consistency(
objspace);
6417 if (ruby_gc_stressful) {
6418 int flag =
FIXNUM_P(ruby_gc_stress_mode) ?
FIX2INT(ruby_gc_stress_mode) : 0;
6420 if ((flag & (1 << gc_stress_no_major)) == 0) {
6421 do_full_mark = TRUE;
6424 objspace->flags.immediate_sweep = !(flag & (1<<gc_stress_no_immediate_sweep));
6427 if (gc_needs_major_flags) {
6428 reason |= gc_needs_major_flags;
6429 do_full_mark = TRUE;
6433 if (!gc_config_full_mark_val) {
6434 do_full_mark = FALSE;
6436 gc_needs_major_flags = GPR_FLAG_NONE;
6438 if (do_full_mark && (reason & GPR_FLAG_MAJOR_MASK) == 0) {
6439 reason |= GPR_FLAG_MAJOR_BY_FORCE;
6442 if (
objspace->flags.dont_incremental ||
6443 reason & GPR_FLAG_IMMEDIATE_MARK ||
6444 ruby_gc_stressful) {
6445 objspace->flags.during_incremental_marking = FALSE;
6448 objspace->flags.during_incremental_marking = do_full_mark;
6452 if (do_full_mark && ruby_enable_autocompact) {
6453 objspace->flags.during_compacting = TRUE;
6454#if RGENGC_CHECK_MODE
6455 objspace->rcompactor.compare_func = ruby_autocompact_compare_func;
6459 objspace->flags.during_compacting = !!(reason & GPR_FLAG_COMPACT);
6462 if (!GC_ENABLE_LAZY_SWEEP ||
objspace->flags.dont_incremental) {
6463 objspace->flags.immediate_sweep = TRUE;
6466 if (
objspace->flags.immediate_sweep) reason |= GPR_FLAG_IMMEDIATE_SWEEP;
6468 gc_report(1,
objspace,
"gc_start(reason: %x) => %u, %d, %d\n",
6470 do_full_mark, !is_incremental_marking(
objspace),
objspace->flags.immediate_sweep);
6472 RB_DEBUG_COUNTER_INC(gc_count);
6474 if (reason & GPR_FLAG_MAJOR_MASK) {
6475 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_nofree, reason & GPR_FLAG_MAJOR_BY_NOFREE);
6476 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_oldgen, reason & GPR_FLAG_MAJOR_BY_OLDGEN);
6477 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_shady, reason & GPR_FLAG_MAJOR_BY_SHADY);
6478 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_force, reason & GPR_FLAG_MAJOR_BY_FORCE);
6479#if RGENGC_ESTIMATE_OLDMALLOC
6480 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_oldmalloc, reason & GPR_FLAG_MAJOR_BY_OLDMALLOC);
6484 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_newobj, reason & GPR_FLAG_NEWOBJ);
6485 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_malloc, reason & GPR_FLAG_MALLOC);
6486 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_method, reason & GPR_FLAG_METHOD);
6487 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_capi, reason & GPR_FLAG_CAPI);
6488 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_stress, reason & GPR_FLAG_STRESS);
6492 objspace->profile.latest_gc_info = reason;
6493 objspace->profile.total_allocated_objects_at_gc_start = total_allocated_objects(
objspace);
6494 objspace->profile.heap_used_at_gc_start = rb_darray_size(
objspace->heap_pages.sorted);
6495 objspace->profile.heap_total_slots_at_gc_start = objspace_available_slots(
objspace);
6496 objspace->profile.weak_references_count = 0;
6497 gc_prof_setup_new_record(
objspace, reason);
6498 gc_reset_malloc_info(
objspace, do_full_mark);
6502 GC_ASSERT(during_gc);
6506 if (gc_marks(
objspace, do_full_mark)) {
6512 gc_exit(
objspace, gc_enter_event_start, &lock_lev);
6520 unsigned int lock_lev;
6521 gc_enter(
objspace, gc_enter_event_rest, &lock_lev);
6523 if (RGENGC_CHECK_MODE >= 2) gc_verify_internal_consistency(
objspace);
6525 if (is_incremental_marking(
objspace)) {
6539 gc_exit(
objspace, gc_enter_event_rest, &lock_lev);
6545 unsigned int reason;
6554 if (is_full_marking(
objspace)) buff[i++] =
'F';
6555 if (is_incremental_marking(
objspace)) buff[i++] =
'I';
6559 if (is_lazy_sweeping(
objspace)) buff[i++] =
'L';
6570 static char buff[0x10];
6571 gc_current_status_fill(
objspace, buff);
6575#if PRINT_ENTER_EXIT_TICK
6577static tick_t last_exit_tick;
6578static tick_t enter_tick;
6579static int enter_count = 0;
6580static char last_gc_status[0x10];
6585 if (direction == 0) {
6587 enter_tick = tick();
6588 gc_current_status_fill(
objspace, last_gc_status);
6591 tick_t exit_tick = tick();
6592 char current_gc_status[0x10];
6593 gc_current_status_fill(
objspace, current_gc_status);
6596 fprintf(stderr,
"%"PRItick
"\t%"PRItick
"\t%s\t[%s->%s|%c]\n",
6597 enter_tick - last_exit_tick,
6598 exit_tick - enter_tick,
6600 last_gc_status, current_gc_status,
6601 (
objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_MASK) ?
'+' :
'-');
6602 last_exit_tick = exit_tick;
6605 fprintf(stderr,
"%"PRItick
"\t%"PRItick
"\t%s\t[%s->%s|%c]\n",
6607 exit_tick - enter_tick,
6609 last_gc_status, current_gc_status,
6610 (
objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_MASK) ?
'+' :
'-');
6623gc_enter_event_cstr(
enum gc_enter_event event)
6626 case gc_enter_event_start:
return "start";
6627 case gc_enter_event_continue:
return "continue";
6628 case gc_enter_event_rest:
return "rest";
6629 case gc_enter_event_finalizer:
return "finalizer";
6635gc_enter_count(
enum gc_enter_event event)
6638 case gc_enter_event_start: RB_DEBUG_COUNTER_INC(gc_enter_start);
break;
6639 case gc_enter_event_continue: RB_DEBUG_COUNTER_INC(gc_enter_continue);
break;
6640 case gc_enter_event_rest: RB_DEBUG_COUNTER_INC(gc_enter_rest);
break;
6641 case gc_enter_event_finalizer: RB_DEBUG_COUNTER_INC(gc_enter_finalizer);
break;
6645static bool current_process_time(
struct timespec *ts);
6650 if (!current_process_time(ts)) {
6656static unsigned long long
6661 if ((ts->tv_sec > 0 || ts->tv_nsec > 0) &&
6662 current_process_time(&end_time) &&
6663 end_time.tv_sec >= ts->tv_sec) {
6664 return (
unsigned long long)(end_time.tv_sec - ts->tv_sec) * (1000 * 1000 * 1000) +
6665 (end_time.tv_nsec - ts->tv_nsec);
6674 *lock_lev = RB_GC_VM_LOCK();
6677 case gc_enter_event_rest:
6678 case gc_enter_event_start:
6679 case gc_enter_event_continue:
6687 gc_enter_count(event);
6688 if (RB_UNLIKELY(during_gc != 0)) rb_bug(
"during_gc != 0");
6689 if (RGENGC_CHECK_MODE >= 3) gc_verify_internal_consistency(
objspace);
6692 RUBY_DEBUG_LOG(
"%s (%s)",gc_enter_event_cstr(event), gc_current_status(
objspace));
6693 gc_report(1,
objspace,
"gc_enter: %s [%s]\n", gc_enter_event_cstr(event), gc_current_status(
objspace));
6694 gc_record(
objspace, 0, gc_enter_event_cstr(event));
6702 GC_ASSERT(during_gc != 0);
6706 gc_record(
objspace, 1, gc_enter_event_cstr(event));
6707 RUBY_DEBUG_LOG(
"%s (%s)", gc_enter_event_cstr(event), gc_current_status(
objspace));
6708 gc_report(1,
objspace,
"gc_exit: %s [%s]\n", gc_enter_event_cstr(event), gc_current_status(
objspace));
6711 RB_GC_VM_UNLOCK(*lock_lev);
6715#define MEASURE_GC (objspace->flags.measure_gc)
6721 GC_ASSERT(during_gc != 0);
6724 gc_clock_start(&
objspace->profile.marking_start_time);
6731 GC_ASSERT(during_gc != 0);
6734 objspace->profile.marking_time_ns += gc_clock_end(&
objspace->profile.marking_start_time);
6741 GC_ASSERT(during_gc != 0);
6744 gc_clock_start(&
objspace->profile.sweeping_start_time);
6751 GC_ASSERT(during_gc != 0);
6754 objspace->profile.sweeping_time_ns += gc_clock_end(&
objspace->profile.sweeping_start_time);
6759gc_with_gvl(
void *ptr)
6762 return (
void *)(
VALUE)garbage_collect(oar->objspace, oar->reason);
6765int ruby_thread_has_gvl_p(
void);
6770 if (dont_gc_val()) {
6776 else if (!ruby_thread_has_gvl_p()) {
6780 oar.reason = reason;
6786 return garbage_collect(
objspace, reason);
6791gc_set_candidate_object_i(
void *vstart,
void *vend,
size_t stride,
void *data)
6796 for (; v != (
VALUE)vend; v += stride) {
6797 asan_unpoisoning_object(v) {
6803 rb_gc_prepare_heap_process_object(v);
6805 RVALUE_AGE_SET_CANDIDATE(
objspace, v);
6815rb_gc_impl_start(
void *objspace_ptr,
bool full_mark,
bool immediate_mark,
bool immediate_sweep,
bool compact)
6818 unsigned int reason = (GPR_FLAG_FULL_MARK |
6819 GPR_FLAG_IMMEDIATE_MARK |
6820 GPR_FLAG_IMMEDIATE_SWEEP |
6823 int full_marking_p = gc_config_full_mark_val;
6824 gc_config_full_mark_set(TRUE);
6828 GC_ASSERT(GC_COMPACTION_SUPPORTED);
6830 reason |= GPR_FLAG_COMPACT;
6833 if (!full_mark) reason &= ~GPR_FLAG_FULL_MARK;
6834 if (!immediate_mark) reason &= ~GPR_FLAG_IMMEDIATE_MARK;
6835 if (!immediate_sweep) reason &= ~GPR_FLAG_IMMEDIATE_SWEEP;
6841 gc_config_full_mark_set(full_marking_p);
6845rb_gc_impl_prepare_heap(
void *objspace_ptr)
6849 size_t orig_total_slots = objspace_available_slots(
objspace);
6850 size_t orig_allocatable_bytes =
objspace->heap_pages.allocatable_bytes;
6852 rb_gc_impl_each_objects(
objspace, gc_set_candidate_object_i, objspace_ptr);
6854 double orig_max_free_slots = gc_params.heap_free_slots_max_ratio;
6856 gc_params.heap_free_slots_max_ratio = 0.0;
6857 rb_gc_impl_start(
objspace,
true,
true,
true,
true);
6858 gc_params.heap_free_slots_max_ratio = orig_max_free_slots;
6860 objspace->heap_pages.allocatable_bytes = 0;
6861 heap_pages_freeable_pages =
objspace->empty_pages_count;
6862 heap_pages_free_unused_pages(objspace_ptr);
6863 GC_ASSERT(heap_pages_freeable_pages == 0);
6864 GC_ASSERT(
objspace->empty_pages_count == 0);
6865 objspace->heap_pages.allocatable_bytes = orig_allocatable_bytes;
6867 size_t total_slots = objspace_available_slots(
objspace);
6868 if (orig_total_slots > total_slots) {
6869 objspace->heap_pages.allocatable_bytes += (orig_total_slots - total_slots) * heaps[0].slot_size;
6872#if defined(HAVE_MALLOC_TRIM) && !defined(RUBY_ALTERNATIVE_MALLOC_HEADER)
6912 GC_ASSERT(st_is_member(finalizer_table, obj));
6916 GC_ASSERT(RVALUE_MARKED(
objspace, obj));
6917 GC_ASSERT(!RVALUE_PINNED(
objspace, obj));
6922 rb_bug(
"gc_is_moveable_obj: unreachable (%d)", (
int)
BUILTIN_TYPE(obj));
6929void rb_mv_generic_ivar(
VALUE src,
VALUE dst);
6939 gc_report(4,
objspace,
"Moving object: %p -> %p\n", (
void *)src, (
void *)dest);
6942 GC_ASSERT(!MARKED_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest));
6944 GC_ASSERT(!RVALUE_MARKING(
objspace, src));
6947 marked = RVALUE_MARKED(
objspace, src);
6948 wb_unprotected = RVALUE_WB_UNPROTECTED(
objspace, src);
6949 uncollectible = RVALUE_UNCOLLECTIBLE(
objspace, src);
6950 bool remembered = RVALUE_REMEMBERED(
objspace, src);
6951 age = RVALUE_AGE_GET(src);
6954 CLEAR_IN_BITMAP(GET_HEAP_MARK_BITS(src), src);
6955 CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(src), src);
6956 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(src), src);
6957 CLEAR_IN_BITMAP(GET_HEAP_PAGE(src)->remembered_bits, src);
6960 memcpy((
void *)dest, (
void *)src, MIN(src_slot_size, slot_size));
6962 if (RVALUE_OVERHEAD > 0) {
6963 void *dest_overhead = (
void *)(((uintptr_t)dest) + slot_size - RVALUE_OVERHEAD);
6964 void *src_overhead = (
void *)(((uintptr_t)src) + src_slot_size - RVALUE_OVERHEAD);
6966 memcpy(dest_overhead, src_overhead, RVALUE_OVERHEAD);
6969 memset((
void *)src, 0, src_slot_size);
6970 RVALUE_AGE_SET_BITMAP(src, 0);
6974 MARK_IN_BITMAP(GET_HEAP_PAGE(dest)->remembered_bits, dest);
6977 CLEAR_IN_BITMAP(GET_HEAP_PAGE(dest)->remembered_bits, dest);
6981 MARK_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest);
6984 CLEAR_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest);
6987 if (wb_unprotected) {
6988 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(dest), dest);
6991 CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(dest), dest);
6994 if (uncollectible) {
6995 MARK_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(dest), dest);
6998 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(dest), dest);
7001 RVALUE_AGE_SET(dest, age);
7004 RMOVED(src)->dummy =
Qundef;
7005 RMOVED(src)->destination = dest;
7008 GET_HEAP_PAGE(src)->heap->total_freed_objects++;
7009 GET_HEAP_PAGE(dest)->heap->total_allocated_objects++;
7014#if GC_CAN_COMPILE_COMPACTION
7016compare_pinned_slots(
const void *left,
const void *right,
void *dummy)
7021 left_page = *(
struct heap_page *
const *)left;
7022 right_page = *(
struct heap_page *
const *)right;
7024 return left_page->pinned_slots - right_page->pinned_slots;
7028compare_free_slots(
const void *left,
const void *right,
void *dummy)
7033 left_page = *(
struct heap_page *
const *)left;
7034 right_page = *(
struct heap_page *
const *)right;
7036 return left_page->free_slots - right_page->free_slots;
7042 for (
int j = 0; j < HEAP_COUNT; j++) {
7045 size_t total_pages = heap->total_pages;
7047 struct heap_page *page = 0, **page_list = malloc(size);
7050 heap->free_pages = NULL;
7051 ccan_list_for_each(&heap->pages, page, page_node) {
7052 page_list[i++] = page;
7056 GC_ASSERT((
size_t)i == total_pages);
7063 ccan_list_head_init(&heap->pages);
7065 for (i = 0; i < total_pages; i++) {
7066 ccan_list_add(&heap->pages, &page_list[i]->page_node);
7067 if (page_list[i]->free_slots != 0) {
7068 heap_add_freepage(heap, page_list[i]);
7078rb_gc_impl_register_pinning_obj(
void *objspace_ptr,
VALUE obj)
7084rb_gc_impl_object_moved_p(
void *objspace_ptr,
VALUE obj)
7086 return gc_object_moved_p(objspace_ptr, obj);
7094 page->flags.has_uncollectible_wb_unprotected_objects = FALSE;
7095 page->flags.has_remembered_objects = FALSE;
7098 for (; v != (
VALUE)vend; v += stride) {
7099 asan_unpoisoning_object(v) {
7106 if (RVALUE_WB_UNPROTECTED(
objspace, v)) {
7107 page->flags.has_uncollectible_wb_unprotected_objects = TRUE;
7109 if (RVALUE_REMEMBERED(
objspace, v)) {
7110 page->flags.has_remembered_objects = TRUE;
7112 if (page->flags.before_sweep) {
7114 rb_gc_update_object_references(
objspace, v);
7118 rb_gc_update_object_references(
objspace, v);
7128gc_update_references_weak_table_i(
VALUE obj,
void *data)
7131 asan_unpoisoning_object(obj) {
7138gc_update_references_weak_table_replace_i(
VALUE *obj,
void *data)
7140 *obj = rb_gc_location(*obj);
7148 objspace->flags.during_reference_updating =
true;
7150 rb_gc_before_updating_jit_code();
7154 for (
int i = 0; i < HEAP_COUNT; i++) {
7155 bool should_set_mark_bits = TRUE;
7158 ccan_list_for_each(&heap->pages, page, page_node) {
7159 uintptr_t start = (uintptr_t)page->start;
7160 uintptr_t end = start + (page->total_slots * heap->slot_size);
7162 gc_ref_update((
void *)start, (
void *)end, heap->slot_size,
objspace, page);
7163 if (page == heap->sweeping_page) {
7164 should_set_mark_bits = FALSE;
7166 if (should_set_mark_bits) {
7167 gc_setup_mark_bits(page);
7172 gc_update_table_refs(finalizer_table);
7174 rb_gc_update_vm_references((
void *)
objspace);
7176 for (
int table = 0; table < RB_GC_VM_WEAK_TABLE_COUNT; table++) {
7177 rb_gc_vm_weak_table_foreach(
7178 gc_update_references_weak_table_i,
7179 gc_update_references_weak_table_replace_i,
7186 rb_gc_after_updating_jit_code();
7188 objspace->flags.during_reference_updating =
false;
7191#if GC_CAN_COMPILE_COMPACTION
7193root_obj_check_moved_i(
const char *category,
VALUE obj,
void *data)
7197 if (gc_object_moved_p(
objspace, obj)) {
7198 rb_bug(
"ROOT %s points to MOVED: %p -> %s", category, (
void *)obj, rb_obj_info(rb_gc_impl_location(
objspace, obj)));
7203reachable_object_check_moved_i(
VALUE ref,
void *data)
7206 if (gc_object_moved_p(rb_gc_get_objspace(), ref)) {
7207 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)));
7212heap_check_moved_i(
void *vstart,
void *vend,
size_t stride,
void *data)
7217 for (; v != (
VALUE)vend; v += stride) {
7218 if (gc_object_moved_p(
objspace, v)) {
7222 asan_unpoisoning_object(v) {
7228 if (!rb_gc_impl_garbage_object_p(
objspace, v)) {
7229 rb_objspace_reachable_objects_from(v, reachable_object_check_moved_i, (
void *)v);
7241rb_gc_impl_during_gc_p(
void *objspace_ptr)
7248#if RGENGC_PROFILE >= 2
7281 default:
return "unknown";
7286gc_count_add_each_types(
VALUE hash,
const char *name,
const size_t *types)
7290 for (i=0; i<
T_MASK; i++) {
7291 const char *
type = type_name(i, 0);
7294 rb_hash_aset(hash,
ID2SYM(rb_intern(name)), result);
7299rb_gc_impl_gc_count(
void *objspace_ptr)
7309 static VALUE sym_major_by =
Qnil, sym_gc_by, sym_immediate_sweep, sym_have_finalizer, sym_state, sym_need_major_by;
7310 static VALUE sym_nofree, sym_oldgen, sym_shady, sym_force, sym_stress;
7311#if RGENGC_ESTIMATE_OLDMALLOC
7312 static VALUE sym_oldmalloc;
7314 static VALUE sym_newobj, sym_malloc, sym_method, sym_capi;
7315 static VALUE sym_none, sym_marking, sym_sweeping;
7316 static VALUE sym_weak_references_count;
7318 VALUE major_by, need_major_by;
7319 unsigned int flags = orig_flags ? orig_flags :
objspace->profile.latest_gc_info;
7328 rb_bug(
"gc_info_decode: non-hash or symbol given");
7331 if (
NIL_P(sym_major_by)) {
7332#define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
7345#if RGENGC_ESTIMATE_OLDMALLOC
7357 S(weak_references_count);
7361#define SET(name, attr) \
7362 if (key == sym_##name) \
7364 else if (hash != Qnil) \
7365 rb_hash_aset(hash, sym_##name, (attr));
7368 (flags & GPR_FLAG_MAJOR_BY_NOFREE) ? sym_nofree :
7369 (flags & GPR_FLAG_MAJOR_BY_OLDGEN) ? sym_oldgen :
7370 (flags & GPR_FLAG_MAJOR_BY_SHADY) ? sym_shady :
7371 (flags & GPR_FLAG_MAJOR_BY_FORCE) ? sym_force :
7372#if RGENGC_ESTIMATE_OLDMALLOC
7373 (flags & GPR_FLAG_MAJOR_BY_OLDMALLOC) ? sym_oldmalloc :
7376 SET(major_by, major_by);
7378 if (orig_flags == 0) {
7379 unsigned int need_major_flags = gc_needs_major_flags;
7381 (need_major_flags & GPR_FLAG_MAJOR_BY_NOFREE) ? sym_nofree :
7382 (need_major_flags & GPR_FLAG_MAJOR_BY_OLDGEN) ? sym_oldgen :
7383 (need_major_flags & GPR_FLAG_MAJOR_BY_SHADY) ? sym_shady :
7384 (need_major_flags & GPR_FLAG_MAJOR_BY_FORCE) ? sym_force :
7385#if RGENGC_ESTIMATE_OLDMALLOC
7386 (need_major_flags & GPR_FLAG_MAJOR_BY_OLDMALLOC) ? sym_oldmalloc :
7389 SET(need_major_by, need_major_by);
7393 (flags & GPR_FLAG_NEWOBJ) ? sym_newobj :
7394 (flags & GPR_FLAG_MALLOC) ? sym_malloc :
7395 (flags & GPR_FLAG_METHOD) ? sym_method :
7396 (flags & GPR_FLAG_CAPI) ? sym_capi :
7397 (flags & GPR_FLAG_STRESS) ? sym_stress :
7401 SET(have_finalizer, (flags & GPR_FLAG_HAVE_FINALIZE) ?
Qtrue :
Qfalse);
7402 SET(immediate_sweep, (flags & GPR_FLAG_IMMEDIATE_SWEEP) ?
Qtrue :
Qfalse);
7404 if (orig_flags == 0) {
7405 SET(state, gc_mode(
objspace) == gc_mode_none ? sym_none :
7406 gc_mode(
objspace) == gc_mode_marking ? sym_marking : sym_sweeping);
7409 SET(weak_references_count,
LONG2FIX(
objspace->profile.weak_references_count));
7421rb_gc_impl_latest_gc_info(
void *objspace_ptr,
VALUE key)
7425 return gc_info_decode(
objspace, key, 0);
7432 gc_stat_sym_marking_time,
7433 gc_stat_sym_sweeping_time,
7434 gc_stat_sym_heap_allocated_pages,
7435 gc_stat_sym_heap_empty_pages,
7436 gc_stat_sym_heap_allocatable_bytes,
7437 gc_stat_sym_heap_available_slots,
7438 gc_stat_sym_heap_live_slots,
7439 gc_stat_sym_heap_free_slots,
7440 gc_stat_sym_heap_final_slots,
7441 gc_stat_sym_heap_marked_slots,
7442 gc_stat_sym_heap_eden_pages,
7443 gc_stat_sym_total_allocated_pages,
7444 gc_stat_sym_total_freed_pages,
7445 gc_stat_sym_total_allocated_objects,
7446 gc_stat_sym_total_freed_objects,
7447 gc_stat_sym_malloc_increase_bytes,
7448 gc_stat_sym_malloc_increase_bytes_limit,
7449 gc_stat_sym_minor_gc_count,
7450 gc_stat_sym_major_gc_count,
7451 gc_stat_sym_compact_count,
7452 gc_stat_sym_read_barrier_faults,
7453 gc_stat_sym_total_moved_objects,
7454 gc_stat_sym_remembered_wb_unprotected_objects,
7455 gc_stat_sym_remembered_wb_unprotected_objects_limit,
7456 gc_stat_sym_old_objects,
7457 gc_stat_sym_old_objects_limit,
7458#if RGENGC_ESTIMATE_OLDMALLOC
7459 gc_stat_sym_oldmalloc_increase_bytes,
7460 gc_stat_sym_oldmalloc_increase_bytes_limit,
7463 gc_stat_sym_total_generated_normal_object_count,
7464 gc_stat_sym_total_generated_shady_object_count,
7465 gc_stat_sym_total_shade_operation_count,
7466 gc_stat_sym_total_promoted_count,
7467 gc_stat_sym_total_remembered_normal_object_count,
7468 gc_stat_sym_total_remembered_shady_object_count,
7473static VALUE gc_stat_symbols[gc_stat_sym_last];
7476setup_gc_stat_symbols(
void)
7478 if (gc_stat_symbols[0] == 0) {
7479#define S(s) gc_stat_symbols[gc_stat_sym_##s] = ID2SYM(rb_intern_const(#s))
7484 S(heap_allocated_pages);
7485 S(heap_empty_pages);
7486 S(heap_allocatable_bytes);
7487 S(heap_available_slots);
7490 S(heap_final_slots);
7491 S(heap_marked_slots);
7493 S(total_allocated_pages);
7494 S(total_freed_pages);
7495 S(total_allocated_objects);
7496 S(total_freed_objects);
7497 S(malloc_increase_bytes);
7498 S(malloc_increase_bytes_limit);
7502 S(read_barrier_faults);
7503 S(total_moved_objects);
7504 S(remembered_wb_unprotected_objects);
7505 S(remembered_wb_unprotected_objects_limit);
7507 S(old_objects_limit);
7508#if RGENGC_ESTIMATE_OLDMALLOC
7509 S(oldmalloc_increase_bytes);
7510 S(oldmalloc_increase_bytes_limit);
7513 S(total_generated_normal_object_count);
7514 S(total_generated_shady_object_count);
7515 S(total_shade_operation_count);
7516 S(total_promoted_count);
7517 S(total_remembered_normal_object_count);
7518 S(total_remembered_shady_object_count);
7525ns_to_ms(uint64_t ns)
7527 return ns / (1000 * 1000);
7533rb_gc_impl_stat(
void *objspace_ptr,
VALUE hash_or_sym)
7538 setup_gc_stat_symbols();
7540 ractor_cache_flush_count(
objspace, rb_gc_get_ractor_newobj_cache());
7541 malloc_increase_local_flush(
objspace);
7550 rb_bug(
"non-hash or symbol given");
7553#define SET(name, attr) \
7554 if (key == gc_stat_symbols[gc_stat_sym_##name]) \
7555 return SIZET2NUM(attr); \
7556 else if (hash != Qnil) \
7557 rb_hash_aset(hash, gc_stat_symbols[gc_stat_sym_##name], SIZET2NUM(attr));
7559 SET(count,
objspace->profile.count);
7560 SET(time, (
size_t)ns_to_ms(
objspace->profile.marking_time_ns +
objspace->profile.sweeping_time_ns));
7561 SET(marking_time, (
size_t)ns_to_ms(
objspace->profile.marking_time_ns));
7562 SET(sweeping_time, (
size_t)ns_to_ms(
objspace->profile.sweeping_time_ns));
7565 SET(heap_allocated_pages, rb_darray_size(
objspace->heap_pages.sorted));
7566 SET(heap_empty_pages,
objspace->empty_pages_count)
7567 SET(heap_allocatable_bytes,
objspace->heap_pages.allocatable_bytes);
7568 SET(heap_available_slots, objspace_available_slots(
objspace));
7569 SET(heap_live_slots, objspace_live_slots(
objspace));
7570 SET(heap_free_slots, objspace_free_slots(
objspace));
7571 SET(heap_final_slots, total_final_slots_count(
objspace));
7572 SET(heap_marked_slots,
objspace->marked_slots);
7573 SET(heap_eden_pages, heap_eden_total_pages(
objspace));
7574 SET(total_allocated_pages,
objspace->heap_pages.allocated_pages);
7575 SET(total_freed_pages,
objspace->heap_pages.freed_pages);
7576 SET(total_allocated_objects, total_allocated_objects(
objspace));
7577 SET(total_freed_objects, total_freed_objects(
objspace));
7578 SET(malloc_increase_bytes, malloc_increase);
7579 SET(malloc_increase_bytes_limit, malloc_limit);
7580 SET(minor_gc_count,
objspace->profile.minor_gc_count);
7581 SET(major_gc_count,
objspace->profile.major_gc_count);
7582 SET(compact_count,
objspace->profile.compact_count);
7583 SET(read_barrier_faults,
objspace->profile.read_barrier_faults);
7584 SET(total_moved_objects,
objspace->rcompactor.total_moved);
7585 SET(remembered_wb_unprotected_objects,
objspace->rgengc.uncollectible_wb_unprotected_objects);
7586 SET(remembered_wb_unprotected_objects_limit,
objspace->rgengc.uncollectible_wb_unprotected_objects_limit);
7587 SET(old_objects,
objspace->rgengc.old_objects);
7588 SET(old_objects_limit,
objspace->rgengc.old_objects_limit);
7589#if RGENGC_ESTIMATE_OLDMALLOC
7590 SET(oldmalloc_increase_bytes,
objspace->malloc_counters.oldmalloc_increase);
7591 SET(oldmalloc_increase_bytes_limit,
objspace->rgengc.oldmalloc_increase_limit);
7595 SET(total_generated_normal_object_count,
objspace->profile.total_generated_normal_object_count);
7596 SET(total_generated_shady_object_count,
objspace->profile.total_generated_shady_object_count);
7597 SET(total_shade_operation_count,
objspace->profile.total_shade_operation_count);
7598 SET(total_promoted_count,
objspace->profile.total_promoted_count);
7599 SET(total_remembered_normal_object_count,
objspace->profile.total_remembered_normal_object_count);
7600 SET(total_remembered_shady_object_count,
objspace->profile.total_remembered_shady_object_count);
7609#if defined(RGENGC_PROFILE) && RGENGC_PROFILE >= 2
7611 gc_count_add_each_types(hash,
"generated_normal_object_count_types",
objspace->profile.generated_normal_object_count_types);
7612 gc_count_add_each_types(hash,
"generated_shady_object_count_types",
objspace->profile.generated_shady_object_count_types);
7613 gc_count_add_each_types(hash,
"shade_operation_count_types",
objspace->profile.shade_operation_count_types);
7614 gc_count_add_each_types(hash,
"promoted_types",
objspace->profile.promoted_types);
7615 gc_count_add_each_types(hash,
"remembered_normal_object_count_types",
objspace->profile.remembered_normal_object_count_types);
7616 gc_count_add_each_types(hash,
"remembered_shady_object_count_types",
objspace->profile.remembered_shady_object_count_types);
7623enum gc_stat_heap_sym {
7624 gc_stat_heap_sym_slot_size,
7625 gc_stat_heap_sym_heap_live_slots,
7626 gc_stat_heap_sym_heap_free_slots,
7627 gc_stat_heap_sym_heap_final_slots,
7628 gc_stat_heap_sym_heap_eden_pages,
7629 gc_stat_heap_sym_heap_eden_slots,
7630 gc_stat_heap_sym_total_allocated_pages,
7631 gc_stat_heap_sym_force_major_gc_count,
7632 gc_stat_heap_sym_force_incremental_marking_finish_count,
7633 gc_stat_heap_sym_heap_allocatable_slots,
7634 gc_stat_heap_sym_total_allocated_objects,
7635 gc_stat_heap_sym_total_freed_objects,
7636 gc_stat_heap_sym_last
7639static VALUE gc_stat_heap_symbols[gc_stat_heap_sym_last];
7642setup_gc_stat_heap_symbols(
void)
7644 if (gc_stat_heap_symbols[0] == 0) {
7645#define S(s) gc_stat_heap_symbols[gc_stat_heap_sym_##s] = ID2SYM(rb_intern_const(#s))
7649 S(heap_final_slots);
7652 S(heap_allocatable_slots);
7653 S(total_allocated_pages);
7654 S(force_major_gc_count);
7655 S(force_incremental_marking_finish_count);
7656 S(total_allocated_objects);
7657 S(total_freed_objects);
7665#define SET(name, attr) \
7666 if (key == gc_stat_heap_symbols[gc_stat_heap_sym_##name]) \
7667 return SIZET2NUM(attr); \
7668 else if (hash != Qnil) \
7669 rb_hash_aset(hash, gc_stat_heap_symbols[gc_stat_heap_sym_##name], SIZET2NUM(attr));
7671 SET(slot_size, heap->slot_size);
7672 SET(heap_live_slots, heap->total_allocated_objects - heap->total_freed_objects - heap->final_slots_count);
7673 SET(heap_free_slots, heap->total_slots - (heap->total_allocated_objects - heap->total_freed_objects));
7674 SET(heap_final_slots, heap->final_slots_count);
7675 SET(heap_eden_pages, heap->total_pages);
7676 SET(heap_eden_slots, heap->total_slots);
7677 SET(heap_allocatable_slots,
objspace->heap_pages.allocatable_bytes / heap->slot_size);
7678 SET(total_allocated_pages, heap->total_allocated_pages);
7679 SET(force_major_gc_count, heap->force_major_gc_count);
7680 SET(force_incremental_marking_finish_count, heap->force_incremental_marking_finish_count);
7681 SET(total_allocated_objects, heap->total_allocated_objects);
7682 SET(total_freed_objects, heap->total_freed_objects);
7694rb_gc_impl_stat_heap(
void *objspace_ptr,
VALUE heap_name,
VALUE hash_or_sym)
7698 ractor_cache_flush_count(
objspace, rb_gc_get_ractor_newobj_cache());
7700 setup_gc_stat_heap_symbols();
7702 if (
NIL_P(heap_name)) {
7704 rb_bug(
"non-hash given");
7707 for (
int i = 0; i < HEAP_COUNT; i++) {
7710 hash = rb_hash_new();
7711 rb_hash_aset(hash_or_sym,
INT2FIX(i), hash);
7718 int heap_idx =
FIX2INT(heap_name);
7720 if (heap_idx < 0 || heap_idx >= HEAP_COUNT) {
7721 rb_raise(rb_eArgError,
"size pool index out of range");
7725 return stat_one_heap(
objspace, &heaps[heap_idx],
Qnil, hash_or_sym);
7728 return stat_one_heap(
objspace, &heaps[heap_idx], hash_or_sym,
Qnil);
7731 rb_bug(
"non-hash or symbol given");
7735 rb_bug(
"heap_name must be nil or an Integer");
7747#define RBOOL(v) (v ? Qtrue : Qfalse)
7751rb_gc_impl_config_get(
void *objspace_ptr)
7753#define sym(name) ID2SYM(rb_intern_const(name))
7755 VALUE hash = rb_hash_new();
7757 rb_hash_aset(hash, sym(
"rgengc_allow_full_mark"), RBOOL(gc_config_full_mark_val));
7766 if (
rb_sym2id(key) == rb_intern(
"rgengc_allow_full_mark")) {
7768 gc_config_full_mark_set(
RTEST(value));
7774rb_gc_impl_config_set(
void *objspace_ptr,
VALUE hash)
7779 rb_raise(rb_eArgError,
"expected keyword arguments");
7786rb_gc_impl_stress_get(
void *objspace_ptr)
7789 return ruby_gc_stress_mode;
7793rb_gc_impl_stress_set(
void *objspace_ptr,
VALUE flag)
7802get_envparam_size(
const char *name,
size_t *default_value,
size_t lower_bound)
7804 const char *ptr = getenv(name);
7807 if (ptr != NULL && *ptr) {
7810#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
7811 val = strtoll(ptr, &end, 0);
7813 val = strtol(ptr, &end, 0);
7825 unit = 1024*1024*1024;
7829 while (*end && isspace((
unsigned char)*end)) end++;
7831 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"invalid string for %s: %s\n", name, ptr);
7835 if (val < -(ssize_t)(SIZE_MAX / 2 / unit) || (ssize_t)(SIZE_MAX / 2 / unit) < val) {
7836 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"%s=%s is ignored because it overflows\n", name, ptr);
7841 if (val > 0 && (
size_t)val > lower_bound) {
7843 fprintf(stderr,
"%s=%"PRIdSIZE
" (default value: %"PRIuSIZE
")\n", name, val, *default_value);
7845 *default_value = (size_t)val;
7850 fprintf(stderr,
"%s=%"PRIdSIZE
" (default value: %"PRIuSIZE
") is ignored because it must be greater than %"PRIuSIZE
".\n",
7851 name, val, *default_value, lower_bound);
7860get_envparam_double(
const char *name,
double *default_value,
double lower_bound,
double upper_bound,
int accept_zero)
7862 const char *ptr = getenv(name);
7865 if (ptr != NULL && *ptr) {
7868 if (!*ptr || *end) {
7869 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"invalid string for %s: %s\n", name, ptr);
7873 if (accept_zero && val == 0.0) {
7876 else if (val <= lower_bound) {
7878 fprintf(stderr,
"%s=%f (default value: %f) is ignored because it must be greater than %f.\n",
7879 name, val, *default_value, lower_bound);
7882 else if (upper_bound != 0.0 &&
7883 val > upper_bound) {
7885 fprintf(stderr,
"%s=%f (default value: %f) is ignored because it must be lower than %f.\n",
7886 name, val, *default_value, upper_bound);
7896 if (
RTEST(
ruby_verbose)) fprintf(stderr,
"%s=%f (default value: %f)\n", name, val, *default_value);
7897 *default_value = val;
7942rb_gc_impl_set_params(
void *objspace_ptr)
7946 if (get_envparam_size(
"RUBY_GC_HEAP_FREE_SLOTS", &gc_params.heap_free_slots, 0)) {
7950 get_envparam_size(
"RUBY_GC_HEAP_INIT_BYTES", &gc_params.heap_init_bytes, 0);
7952 get_envparam_double(
"RUBY_GC_HEAP_GROWTH_FACTOR", &gc_params.growth_factor, 1.0, 0.0, FALSE);
7953 get_envparam_size (
"RUBY_GC_HEAP_GROWTH_MAX_BYTES", &gc_params.growth_max_bytes, 0);
7954 get_envparam_double(
"RUBY_GC_HEAP_FREE_SLOTS_MIN_RATIO", &gc_params.heap_free_slots_min_ratio,
7956 get_envparam_double(
"RUBY_GC_HEAP_FREE_SLOTS_MAX_RATIO", &gc_params.heap_free_slots_max_ratio,
7957 gc_params.heap_free_slots_min_ratio, 1.0, FALSE);
7958 get_envparam_double(
"RUBY_GC_HEAP_FREE_SLOTS_GOAL_RATIO", &gc_params.heap_free_slots_goal_ratio,
7959 gc_params.heap_free_slots_min_ratio, gc_params.heap_free_slots_max_ratio, TRUE);
7960 get_envparam_double(
"RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR", &gc_params.oldobject_limit_factor, 0.0, 0.0, TRUE);
7961 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);
7963 if (get_envparam_size(
"RUBY_GC_MALLOC_LIMIT", &gc_params.malloc_limit_min, 0)) {
7964 malloc_limit = gc_params.malloc_limit_min;
7966 get_envparam_size (
"RUBY_GC_MALLOC_LIMIT_MAX", &gc_params.malloc_limit_max, 0);
7967 if (!gc_params.malloc_limit_max) {
7968 gc_params.malloc_limit_max = SIZE_MAX;
7970 get_envparam_double(
"RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR", &gc_params.malloc_limit_growth_factor, 1.0, 0.0, FALSE);
7972#if RGENGC_ESTIMATE_OLDMALLOC
7973 if (get_envparam_size(
"RUBY_GC_OLDMALLOC_LIMIT", &gc_params.oldmalloc_limit_min, 0)) {
7974 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
7976 get_envparam_size (
"RUBY_GC_OLDMALLOC_LIMIT_MAX", &gc_params.oldmalloc_limit_max, 0);
7977 get_envparam_double(
"RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR", &gc_params.oldmalloc_limit_growth_factor, 1.0, 0.0, FALSE);
7984#ifdef HAVE_MALLOC_USABLE_SIZE
7986 hint = malloc_usable_size(ptr);
7993 MEMOP_TYPE_MALLOC = 0,
7999atomic_sub_nounderflow(
size_t *var,
size_t sub)
8001 if (sub == 0)
return;
8005 if (val < sub) sub = val;
8010#define gc_stress_full_mark_after_malloc_p() \
8011 (FIXNUM_P(ruby_gc_stress_mode) && (FIX2LONG(ruby_gc_stress_mode) & (1<<gc_stress_full_mark_after_malloc)))
8017 unsigned int reason = (GPR_FLAG_IMMEDIATE_MARK | GPR_FLAG_IMMEDIATE_SWEEP |
8018 GPR_FLAG_STRESS | GPR_FLAG_MALLOC);
8020 if (gc_stress_full_mark_after_malloc_p()) {
8021 reason |= GPR_FLAG_FULL_MARK;
8023 garbage_collect_with_gvl(
objspace, reason);
8030 if (new_size > old_size) {
8032#if RGENGC_ESTIMATE_OLDMALLOC
8037 atomic_sub_nounderflow(&malloc_increase, old_size - new_size);
8038#if RGENGC_ESTIMATE_OLDMALLOC
8039 atomic_sub_nounderflow(&
objspace->malloc_counters.oldmalloc_increase, old_size - new_size);
8044#if USE_MALLOC_INCREASE_LOCAL
8048 int delta = malloc_increase_local;
8049 if (delta == 0)
return;
8051 malloc_increase_local = 0;
8053 malloc_increase_commit(
objspace, (
size_t)delta, 0);
8056 malloc_increase_commit(
objspace, 0, (
size_t)(-delta));
8067objspace_malloc_increase_report(
rb_objspace_t *
objspace,
void *mem,
size_t new_size,
size_t old_size,
enum memop_type
type,
bool gc_allowed)
8069 if (0) fprintf(stderr,
"increase - ptr: %p, type: %s, new_size: %"PRIdSIZE
", old_size: %"PRIdSIZE
"\n",
8071 type == MEMOP_TYPE_MALLOC ?
"malloc" :
8072 type == MEMOP_TYPE_FREE ?
"free " :
8073 type == MEMOP_TYPE_REALLOC ?
"realloc":
"error",
8074 new_size, old_size);
8079objspace_malloc_increase_body(
rb_objspace_t *
objspace,
void *mem,
size_t new_size,
size_t old_size,
enum memop_type
type,
bool gc_allowed)
8081#if USE_MALLOC_INCREASE_LOCAL
8082 if (new_size < GC_MALLOC_INCREASE_LOCAL_THRESHOLD &&
8083 old_size < GC_MALLOC_INCREASE_LOCAL_THRESHOLD) {
8084 malloc_increase_local += (int)new_size - (
int)old_size;
8086 if (malloc_increase_local >= GC_MALLOC_INCREASE_LOCAL_THRESHOLD ||
8087 malloc_increase_local <= -GC_MALLOC_INCREASE_LOCAL_THRESHOLD) {
8088 malloc_increase_local_flush(
objspace);
8092 malloc_increase_local_flush(
objspace);
8093 malloc_increase_commit(
objspace, new_size, old_size);
8096 malloc_increase_commit(
objspace, new_size, old_size);
8099 if (
type == MEMOP_TYPE_MALLOC && gc_allowed) {
8102 if (ruby_thread_has_gvl_p() && is_lazy_sweeping(
objspace)) {
8106 garbage_collect_with_gvl(
objspace, GPR_FLAG_MALLOC);
8110#if MALLOC_ALLOCATED_SIZE
8111 if (new_size >= old_size) {
8115 size_t dec_size = old_size - new_size;
8117#if MALLOC_ALLOCATED_SIZE_CHECK
8118 size_t allocated_size =
objspace->malloc_params.allocated_size;
8119 if (allocated_size < dec_size) {
8120 rb_bug(
"objspace_malloc_increase: underflow malloc_params.allocated_size.");
8123 atomic_sub_nounderflow(&
objspace->malloc_params.allocated_size, dec_size);
8127 case MEMOP_TYPE_MALLOC:
8130 case MEMOP_TYPE_FREE:
8132 size_t allocations =
objspace->malloc_params.allocations;
8133 if (allocations > 0) {
8134 atomic_sub_nounderflow(&
objspace->malloc_params.allocations, 1);
8136#if MALLOC_ALLOCATED_SIZE_CHECK
8138 GC_ASSERT(
objspace->malloc_params.allocations > 0);
8143 case MEMOP_TYPE_REALLOC:
break;
8149#define objspace_malloc_increase(...) \
8150 for (bool malloc_increase_done = objspace_malloc_increase_report(__VA_ARGS__); \
8151 !malloc_increase_done; \
8152 malloc_increase_done = objspace_malloc_increase_body(__VA_ARGS__))
8161 if (size == 0) size = 1;
8163#if CALC_EXACT_MALLOC_SIZE
8177 return during_gc && !dont_gc_val() && !rb_gc_multi_ractor_p() && ruby_thread_has_gvl_p();
8183 size = objspace_malloc_size(
objspace, mem, size);
8184 objspace_malloc_increase(
objspace, mem, size, 0, MEMOP_TYPE_MALLOC, gc_allowed) {}
8186#if CALC_EXACT_MALLOC_SIZE
8197#if defined(__GNUC__) && RUBY_DEBUG
8198#define RB_BUG_INSTEAD_OF_RB_MEMERROR 1
8201#ifndef RB_BUG_INSTEAD_OF_RB_MEMERROR
8202# define RB_BUG_INSTEAD_OF_RB_MEMERROR 0
8205#define GC_MEMERROR(...) \
8206 ((RB_BUG_INSTEAD_OF_RB_MEMERROR+0) ? rb_bug("" __VA_ARGS__) : (void)0)
8208#define TRY_WITH_GC(siz, expr) do { \
8209 const gc_profile_record_flag gpr = \
8210 GPR_FLAG_FULL_MARK | \
8211 GPR_FLAG_IMMEDIATE_MARK | \
8212 GPR_FLAG_IMMEDIATE_SWEEP | \
8214 objspace_malloc_gc_stress(objspace); \
8216 if (RB_LIKELY((expr))) { \
8219 else if (gc_allowed && !garbage_collect_with_gvl(objspace, gpr)) { \
8221 GC_MEMERROR("TRY_WITH_GC: could not GC"); \
8223 else if ((expr)) { \
8227 GC_MEMERROR("TRY_WITH_GC: could not allocate:" \
8228 "%"PRIdSIZE" bytes for %s", \
8236 if (RB_UNLIKELY(malloc_during_gc_p(
objspace))) {
8239 rb_bug(
"Cannot %s during GC", msg);
8244rb_gc_impl_free(
void *objspace_ptr,
void *ptr,
size_t old_size)
8255#if CALC_EXACT_MALLOC_SIZE
8259 rb_bug(
"buffer %p has no recorded size. Was it allocated with ruby_mimalloc? If so it should be freed with ruby_mimfree", ptr);
8262 if (old_size && (old_size +
sizeof(
struct malloc_obj_info)) != info->size) {
8263 rb_bug(
"buffer %p freed with old_size=%zu, but was allocated with size=%zu", ptr, old_size, info->size -
sizeof(
struct malloc_obj_info));
8267 old_size = info->size;
8269 old_size = objspace_malloc_size(
objspace, ptr, old_size);
8271 objspace_malloc_increase(
objspace, ptr, 0, old_size, MEMOP_TYPE_FREE,
true) {
8274 RB_DEBUG_COUNTER_INC(heap_xfree);
8279rb_gc_impl_malloc(
void *objspace_ptr,
size_t size,
bool gc_allowed)
8282 check_malloc_not_in_gc(
objspace,
"malloc");
8286 size = objspace_malloc_prepare(
objspace, size);
8287 TRY_WITH_GC(size, mem = malloc(size));
8288 RB_DEBUG_COUNTER_INC(heap_xmalloc);
8289 if (!mem)
return mem;
8290 return objspace_malloc_fixup(
objspace, mem, size, gc_allowed);
8294rb_gc_impl_calloc(
void *objspace_ptr,
size_t size,
bool gc_allowed)
8298 if (RB_UNLIKELY(malloc_during_gc_p(
objspace))) {
8299 rb_warn(
"calloc during GC detected, this could cause crashes if it triggers another GC");
8300#if RGENGC_CHECK_MODE || RUBY_DEBUG
8301 rb_bug(
"Cannot calloc during GC");
8307 size = objspace_malloc_prepare(
objspace, size);
8308 TRY_WITH_GC(size, mem = calloc1(size));
8309 if (!mem)
return mem;
8310 return objspace_malloc_fixup(
objspace, mem, size, gc_allowed);
8314rb_gc_impl_realloc(
void *objspace_ptr,
void *ptr,
size_t new_size,
size_t old_size,
bool gc_allowed)
8318 check_malloc_not_in_gc(
objspace,
"realloc");
8322 if (!ptr)
return rb_gc_impl_malloc(
objspace, new_size, gc_allowed);
8329 if (new_size == 0) {
8330 if ((mem = rb_gc_impl_malloc(
objspace, 0, gc_allowed)) != NULL) {
8353 rb_gc_impl_free(
objspace, ptr, old_size);
8367#if CALC_EXACT_MALLOC_SIZE
8373 if (old_size && (old_size +
sizeof(
struct malloc_obj_info)) != info->size) {
8374 rb_bug(
"buffer %p realloced with old_size=%zu, but was allocated with size=%zu", ptr, old_size, info->size -
sizeof(
struct malloc_obj_info));
8377 old_size = info->size;
8381 old_size = objspace_malloc_size(
objspace, ptr, old_size);
8383 if (!mem)
return mem;
8384 new_size = objspace_malloc_size(
objspace, mem, new_size);
8386#if CALC_EXACT_MALLOC_SIZE
8389 info->size = new_size;
8394 objspace_malloc_increase(
objspace, mem, new_size, old_size, MEMOP_TYPE_REALLOC, gc_allowed);
8396 RB_DEBUG_COUNTER_INC(heap_xrealloc);
8401rb_gc_impl_adjust_memory_usage(
void *objspace_ptr, ssize_t diff)
8406 objspace_malloc_increase(
objspace, 0, diff, 0, MEMOP_TYPE_REALLOC,
true);
8408 else if (diff < 0) {
8409 objspace_malloc_increase(
objspace, 0, 0, -diff, MEMOP_TYPE_REALLOC,
true);
8418#define GC_PROFILE_RECORD_DEFAULT_SIZE 100
8421current_process_time(
struct timespec *ts)
8423#if defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_PROCESS_CPUTIME_ID)
8425 static int try_clock_gettime = 1;
8426 if (try_clock_gettime && clock_gettime(CLOCK_PROCESS_CPUTIME_ID, ts) == 0) {
8430 try_clock_gettime = 0;
8437 struct rusage usage;
8439 if (getrusage(RUSAGE_SELF, &usage) == 0) {
8440 time = usage.ru_utime;
8441 ts->tv_sec = time.tv_sec;
8442 ts->tv_nsec = (int32_t)time.tv_usec * 1000;
8450 FILETIME creation_time, exit_time, kernel_time, user_time;
8453 if (GetProcessTimes(GetCurrentProcess(),
8454 &creation_time, &exit_time, &kernel_time, &user_time) != 0) {
8455 memcpy(&ui, &user_time,
sizeof(FILETIME));
8456#define PER100NSEC (uint64_t)(1000 * 1000 * 10)
8457 ts->tv_nsec = (long)(ui.QuadPart % PER100NSEC);
8458 ts->tv_sec = (time_t)(ui.QuadPart / PER100NSEC);
8471 if (current_process_time(&ts)) {
8472 return ts.tv_sec + ts.tv_nsec * 1e-9;
8484 size_t index =
objspace->profile.next_index;
8491 objspace->profile.size = GC_PROFILE_RECORD_DEFAULT_SIZE;
8494 if (index >=
objspace->profile.size) {
8498 if (!ptr) rb_memerror();
8502 rb_bug(
"gc_profile malloc or realloc miss");
8508 record->flags = reason | (ruby_gc_stressful ? GPR_FLAG_STRESS : 0);
8509#if MALLOC_ALLOCATED_SIZE
8510 record->allocated_size = malloc_allocated_size;
8512#if GC_PROFILE_MORE_DETAIL && GC_PROFILE_DETAIL_MEMORY
8515 struct rusage usage;
8516 if (getrusage(RUSAGE_SELF, &usage) == 0) {
8517 record->maxrss = usage.ru_maxrss;
8518 record->minflt = usage.ru_minflt;
8519 record->majflt = usage.ru_majflt;
8532#if GC_PROFILE_MORE_DETAIL
8533 record->prepare_time =
objspace->profile.prepare_time;
8535 record->gc_time = 0;
8536 record->gc_invoke_time = getrusage_time();
8541elapsed_time_from(
double time)
8543 double now = getrusage_time();
8557 record->gc_time = elapsed_time_from(record->gc_invoke_time);
8558 record->gc_invoke_time -=
objspace->profile.invoke_time;
8562#ifdef BUILDING_MODULAR_GC
8563# define RUBY_DTRACE_GC_HOOK(name)
8565# define RUBY_DTRACE_GC_HOOK(name) \
8566 do {if (RUBY_DTRACE_GC_##name##_ENABLED()) RUBY_DTRACE_GC_##name();} while (0)
8572 RUBY_DTRACE_GC_HOOK(MARK_BEGIN);
8573#if GC_PROFILE_MORE_DETAIL
8575 gc_prof_record(
objspace)->gc_mark_time = getrusage_time();
8583 RUBY_DTRACE_GC_HOOK(MARK_END);
8584#if GC_PROFILE_MORE_DETAIL
8587 record->gc_mark_time = elapsed_time_from(record->gc_mark_time);
8595 RUBY_DTRACE_GC_HOOK(SWEEP_BEGIN);
8599 if (record->gc_time > 0 || GC_PROFILE_MORE_DETAIL) {
8600 objspace->profile.gc_sweep_start_time = getrusage_time();
8608 RUBY_DTRACE_GC_HOOK(SWEEP_END);
8614 if (record->gc_time > 0) {
8615 sweep_time = elapsed_time_from(
objspace->profile.gc_sweep_start_time);
8617 record->gc_time += sweep_time;
8619 else if (GC_PROFILE_MORE_DETAIL) {
8620 sweep_time = elapsed_time_from(
objspace->profile.gc_sweep_start_time);
8623#if GC_PROFILE_MORE_DETAIL
8624 record->gc_sweep_time += sweep_time;
8625 if (heap_pages_deferred_final) record->flags |= GPR_FLAG_HAVE_FINALIZE;
8627 if (heap_pages_deferred_final)
objspace->profile.latest_gc_info |= GPR_FLAG_HAVE_FINALIZE;
8634#if GC_PROFILE_MORE_DETAIL
8637 record->allocate_increase = malloc_increase;
8638 record->allocate_limit = malloc_limit;
8651 size_t use_size = 0;
8652 size_t total_size = 0;
8653 for (
int i = 0; i < HEAP_COUNT; i++) {
8655 size_t heap_live = heap->total_allocated_objects - heap->total_freed_objects - heap->final_slots_count;
8656 total += heap->total_slots;
8657 use_size += heap_live * heap->slot_size;
8658 total_size += heap->total_slots * heap->slot_size;
8661#if GC_PROFILE_MORE_DETAIL
8662 size_t live =
objspace->profile.total_allocated_objects_at_gc_start - total_freed_objects(
objspace);
8663 record->heap_use_pages =
objspace->profile.heap_used_at_gc_start;
8664 record->heap_live_objects = live;
8665 record->heap_free_objects = total - live;
8668 record->heap_total_objects = total;
8669 record->heap_use_size = use_size;
8670 record->heap_total_size = total_size;
8686 void *p =
objspace->profile.records;
8690 objspace->profile.current_record = 0;
8746gc_profile_record_get(
VALUE _)
8757 for (i =0; i <
objspace->profile.next_index; i++) {
8760 prof = rb_hash_new();
8761 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_FLAGS")), gc_info_decode(
objspace, rb_hash_new(), record->flags));
8762 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_TIME")),
DBL2NUM(record->gc_time));
8763 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_INVOKE_TIME")),
DBL2NUM(record->gc_invoke_time));
8764 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_USE_SIZE")),
SIZET2NUM(record->heap_use_size));
8765 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_TOTAL_SIZE")),
SIZET2NUM(record->heap_total_size));
8766 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_TOTAL_OBJECTS")),
SIZET2NUM(record->heap_total_objects));
8767 rb_hash_aset(prof,
ID2SYM(rb_intern(
"MOVED_OBJECTS")),
SIZET2NUM(record->moved_objects));
8768 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_IS_MARKED")),
Qtrue);
8769#if GC_PROFILE_MORE_DETAIL
8770 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_MARK_TIME")),
DBL2NUM(record->gc_mark_time));
8771 rb_hash_aset(prof,
ID2SYM(rb_intern(
"GC_SWEEP_TIME")),
DBL2NUM(record->gc_sweep_time));
8772 rb_hash_aset(prof,
ID2SYM(rb_intern(
"ALLOCATE_INCREASE")),
SIZET2NUM(record->allocate_increase));
8773 rb_hash_aset(prof,
ID2SYM(rb_intern(
"ALLOCATE_LIMIT")),
SIZET2NUM(record->allocate_limit));
8774 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_USE_PAGES")),
SIZET2NUM(record->heap_use_pages));
8775 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_LIVE_OBJECTS")),
SIZET2NUM(record->heap_live_objects));
8776 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HEAP_FREE_OBJECTS")),
SIZET2NUM(record->heap_free_objects));
8778 rb_hash_aset(prof,
ID2SYM(rb_intern(
"REMOVING_OBJECTS")),
SIZET2NUM(record->removing_objects));
8779 rb_hash_aset(prof,
ID2SYM(rb_intern(
"EMPTY_OBJECTS")),
SIZET2NUM(record->empty_objects));
8781 rb_hash_aset(prof,
ID2SYM(rb_intern(
"HAVE_FINALIZE")), (record->flags & GPR_FLAG_HAVE_FINALIZE) ?
Qtrue :
Qfalse);
8784#if RGENGC_PROFILE > 0
8785 rb_hash_aset(prof,
ID2SYM(rb_intern(
"OLD_OBJECTS")),
SIZET2NUM(record->old_objects));
8786 rb_hash_aset(prof,
ID2SYM(rb_intern(
"REMEMBERED_NORMAL_OBJECTS")),
SIZET2NUM(record->remembered_normal_objects));
8787 rb_hash_aset(prof,
ID2SYM(rb_intern(
"REMEMBERED_SHADY_OBJECTS")),
SIZET2NUM(record->remembered_shady_objects));
8795#if GC_PROFILE_MORE_DETAIL
8796#define MAJOR_REASON_MAX 0x10
8799gc_profile_dump_major_reason(
unsigned int flags,
char *buff)
8801 unsigned int reason = flags & GPR_FLAG_MAJOR_MASK;
8804 if (reason == GPR_FLAG_NONE) {
8810 if (reason & GPR_FLAG_MAJOR_BY_##x) { \
8811 buff[i++] = #x[0]; \
8812 if (i >= MAJOR_REASON_MAX) rb_bug("gc_profile_dump_major_reason: overflow"); \
8818#if RGENGC_ESTIMATE_OLDMALLOC
8833 size_t count =
objspace->profile.next_index;
8834#ifdef MAJOR_REASON_MAX
8835 char reason_str[MAJOR_REASON_MAX];
8838 if (
objspace->profile.run && count ) {
8842 append(out, rb_sprintf(
"GC %"PRIuSIZE
" invokes.\n",
objspace->profile.count));
8843 append(out,
rb_str_new_cstr(
"Index Invoke Time(sec) Use Size(byte) Total Size(byte) Total Object GC Time(ms)\n"));
8845 for (i = 0; i < count; i++) {
8846 record = &
objspace->profile.records[i];
8847 append(out, rb_sprintf(
"%5"PRIuSIZE
" %19.3f %20"PRIuSIZE
" %20"PRIuSIZE
" %20"PRIuSIZE
" %30.20f\n",
8848 i+1, record->gc_invoke_time, record->heap_use_size,
8849 record->heap_total_size, record->heap_total_objects, record->gc_time*1000));
8852#if GC_PROFILE_MORE_DETAIL
8853 const char *str =
"\n\n" \
8855 "Prepare Time = Previously GC's rest sweep time\n"
8856 "Index Flags Allocate Inc. Allocate Limit"
8857#if CALC_EXACT_MALLOC_SIZE
8860 " Use Page Mark Time(ms) Sweep Time(ms) Prepare Time(ms) LivingObj FreeObj RemovedObj EmptyObj"
8862 " OldgenObj RemNormObj RemShadObj"
8864#if GC_PROFILE_DETAIL_MEMORY
8865 " MaxRSS(KB) MinorFLT MajorFLT"
8870 for (i = 0; i < count; i++) {
8871 record = &
objspace->profile.records[i];
8872 append(out, rb_sprintf(
"%5"PRIuSIZE
" %4s/%c/%6s%c %13"PRIuSIZE
" %15"PRIuSIZE
8873#
if CALC_EXACT_MALLOC_SIZE
8876 " %9"PRIuSIZE
" %17.12f %17.12f %17.12f %10"PRIuSIZE
" %10"PRIuSIZE
" %10"PRIuSIZE
" %10"PRIuSIZE
8878 "%10"PRIuSIZE
" %10"PRIuSIZE
" %10"PRIuSIZE
8880#
if GC_PROFILE_DETAIL_MEMORY
8886 gc_profile_dump_major_reason(record->flags, reason_str),
8887 (record->flags & GPR_FLAG_HAVE_FINALIZE) ?
'F' :
'.',
8888 (record->flags & GPR_FLAG_NEWOBJ) ?
"NEWOBJ" :
8889 (record->flags & GPR_FLAG_MALLOC) ?
"MALLOC" :
8890 (record->flags & GPR_FLAG_METHOD) ?
"METHOD" :
8891 (record->flags & GPR_FLAG_CAPI) ?
"CAPI__" :
"??????",
8892 (record->flags & GPR_FLAG_STRESS) ?
'!' :
' ',
8893 record->allocate_increase, record->allocate_limit,
8894#if CALC_EXACT_MALLOC_SIZE
8895 record->allocated_size,
8897 record->heap_use_pages,
8898 record->gc_mark_time*1000,
8899 record->gc_sweep_time*1000,
8900 record->prepare_time*1000,
8902 record->heap_live_objects,
8903 record->heap_free_objects,
8904 record->removing_objects,
8905 record->empty_objects
8908 record->old_objects,
8909 record->remembered_normal_objects,
8910 record->remembered_shady_objects
8912#if GC_PROFILE_DETAIL_MEMORY
8914 record->maxrss / 1024,
8937gc_profile_result(
VALUE _)
8954gc_profile_report(
int argc,
VALUE *argv,
VALUE self)
8959 gc_profile_dump_on(out, rb_io_write);
8972gc_profile_total_time(
VALUE self)
8979 size_t count =
objspace->profile.next_index;
8981 for (i = 0; i < count; i++) {
8982 time +=
objspace->profile.records[i].gc_time;
8996gc_profile_enable_get(
VALUE self)
9011gc_profile_enable(
VALUE _)
9015 objspace->profile.current_record = 0;
9028gc_profile_disable(
VALUE _)
9033 objspace->profile.current_record = 0;
9038rb_gc_verify_internal_consistency(
void)
9040 gc_verify_internal_consistency(rb_gc_get_objspace());
9054gc_verify_internal_consistency_m(
VALUE dummy)
9056 rb_gc_verify_internal_consistency();
9060#if GC_CAN_COMPILE_COMPACTION
9074 GC_ASSERT(GC_COMPACTION_SUPPORTED);
9076 ruby_enable_autocompact =
RTEST(v);
9078#if RGENGC_CHECK_MODE
9079 ruby_autocompact_compare_func = NULL;
9083 if (
id == rb_intern(
"empty")) {
9084 ruby_autocompact_compare_func = compare_free_slots;
9092# define gc_set_auto_compact rb_f_notimplement
9095#if GC_CAN_COMPILE_COMPACTION
9103gc_get_auto_compact(
VALUE _)
9108# define gc_get_auto_compact rb_f_notimplement
9111#if GC_CAN_COMPILE_COMPACTION
9137gc_compact_stats(
VALUE self)
9140 VALUE h = rb_hash_new();
9141 VALUE considered = rb_hash_new();
9142 VALUE moved = rb_hash_new();
9143 VALUE moved_up = rb_hash_new();
9144 VALUE moved_down = rb_hash_new();
9146 for (
size_t i = 0; i <
T_MASK; i++) {
9147 if (
objspace->rcompactor.considered_count_table[i]) {
9148 rb_hash_aset(considered, type_sym(i),
SIZET2NUM(
objspace->rcompactor.considered_count_table[i]));
9151 if (
objspace->rcompactor.moved_count_table[i]) {
9152 rb_hash_aset(moved, type_sym(i),
SIZET2NUM(
objspace->rcompactor.moved_count_table[i]));
9155 if (
objspace->rcompactor.moved_up_count_table[i]) {
9156 rb_hash_aset(moved_up, type_sym(i),
SIZET2NUM(
objspace->rcompactor.moved_up_count_table[i]));
9159 if (
objspace->rcompactor.moved_down_count_table[i]) {
9160 rb_hash_aset(moved_down, type_sym(i),
SIZET2NUM(
objspace->rcompactor.moved_down_count_table[i]));
9164 rb_hash_aset(h,
ID2SYM(rb_intern(
"considered")), considered);
9165 rb_hash_aset(h,
ID2SYM(rb_intern(
"moved")), moved);
9166 rb_hash_aset(h,
ID2SYM(rb_intern(
"moved_up")), moved_up);
9167 rb_hash_aset(h,
ID2SYM(rb_intern(
"moved_down")), moved_down);
9172# define gc_compact_stats rb_f_notimplement
9175#if GC_CAN_COMPILE_COMPACTION
9194gc_compact(
VALUE self)
9197 int full_marking_p = gc_config_full_mark_val;
9198 gc_config_full_mark_set(TRUE);
9201 rb_gc_impl_start(rb_gc_get_objspace(),
true,
true,
true,
true);
9202 gc_config_full_mark_set(full_marking_p);
9204 return gc_compact_stats(self);
9207# define gc_compact rb_f_notimplement
9210#if GC_CAN_COMPILE_COMPACTION
9211struct desired_compaction_pages_i_data {
9213 size_t required_slots[HEAP_COUNT];
9217desired_compaction_pages_i(
struct heap_page *page,
void *data)
9219 struct desired_compaction_pages_i_data *tdata = data;
9222 VALUE vend = vstart + (
VALUE)(page->total_slots * page->heap->slot_size);
9225 for (
VALUE v = vstart; v != vend; v += page->heap->slot_size) {
9226 asan_unpoisoning_object(v) {
9230 size_t dest_pool_idx = dest_pool - heaps;
9231 tdata->required_slots[dest_pool_idx]++;
9255gc_verify_compaction_references(
int argc,
VALUE* argv,
VALUE self)
9257 static ID keywords[3] = {0};
9259 keywords[0] = rb_intern(
"toward");
9260 keywords[1] = rb_intern(
"double_heap");
9261 keywords[2] = rb_intern(
"expand_heap");
9268 int kwarg_count =
rb_get_kwargs(options, keywords, 0, 3, arguments);
9269 bool toward_empty = kwarg_count > 0 &&
SYMBOL_P(arguments[0]) &&
SYM2ID(arguments[0]) == rb_intern(
"empty");
9270 bool expand_heap = (kwarg_count > 1 &&
RTEST(arguments[1])) || (kwarg_count > 2 &&
RTEST(arguments[2]));
9275 rb_gc_impl_start(
objspace,
true,
true,
true,
false);
9277 unsigned int lev = RB_GC_VM_LOCK();
9283 struct desired_compaction_pages_i_data desired_compaction = {
9285 .required_slots = {0},
9288 objspace_each_pages(
objspace, desired_compaction_pages_i, &desired_compaction, TRUE);
9291 size_t max_existing_pages = 0;
9292 for (
int i = 0; i < HEAP_COUNT; i++) {
9294 max_existing_pages = MAX(max_existing_pages, heap->total_pages);
9298 for (
int i = 0; i < HEAP_COUNT; i++) {
9301 size_t pages_to_add = 0;
9308 pages_to_add += max_existing_pages - heap->total_pages;
9313 objspace->heap_pages.allocatable_bytes = desired_compaction.required_slots[i] * heap->slot_size;
9314 while (
objspace->heap_pages.allocatable_bytes > 0) {
9315 heap_page_allocate_and_initialize(
objspace, heap);
9323 for (; pages_to_add > 0; pages_to_add--) {
9324 heap_page_allocate_and_initialize_force(
objspace, heap);
9330 objspace->rcompactor.compare_func = compare_free_slots;
9333 RB_GC_VM_UNLOCK(lev);
9335 rb_gc_impl_start(rb_gc_get_objspace(),
true,
true,
true,
true);
9337 rb_objspace_reachable_objects_from_root(root_obj_check_moved_i,
objspace);
9340 objspace->rcompactor.compare_func = NULL;
9342 return gc_compact_stats(self);
9345# define gc_verify_compaction_references rb_f_notimplement
9349rb_gc_impl_objspace_free(
void *objspace_ptr)
9354 rb_bug(
"lazy sweeping underway when freeing object space");
9359 for (
size_t i = 0; i < rb_darray_size(
objspace->heap_pages.sorted); i++) {
9362 rb_darray_free_without_gc(
objspace->heap_pages.sorted);
9363 heap_pages_lomem = 0;
9364 heap_pages_himem = 0;
9366 for (
int i = 0; i < HEAP_COUNT; i++) {
9368 heap->total_pages = 0;
9369 heap->total_slots = 0;
9372 free_stack_chunks(&
objspace->mark_stack);
9373 mark_stack_free_cache(&
objspace->mark_stack);
9375 rb_darray_free_without_gc(
objspace->weak_references);
9380#if MALLOC_ALLOCATED_SIZE
9391gc_malloc_allocated_size(
VALUE self)
9407gc_malloc_allocations(
VALUE self)
9415rb_gc_impl_before_fork(
void *objspace_ptr)
9419 objspace->fork_vm_lock_lev = RB_GC_VM_LOCK();
9424rb_gc_impl_after_fork(
void *objspace_ptr, rb_pid_t pid)
9428 RB_GC_VM_UNLOCK(
objspace->fork_vm_lock_lev);
9432 rb_gc_ractor_newobj_cache_foreach(gc_ractor_newobj_cache_clear, NULL);
9436VALUE rb_ident_hash_new_with_size(st_index_t size);
9438#if GC_DEBUG_STRESS_TO_CLASS
9447rb_gcdebug_add_stress_to_class(
int argc,
VALUE *argv,
VALUE self)
9451 if (!stress_to_class) {
9452 set_stress_to_class(rb_ident_hash_new_with_size(argc));
9455 for (
int i = 0; i < argc; i++) {
9456 VALUE klass = argv[i];
9457 rb_hash_aset(stress_to_class, klass,
Qtrue);
9472rb_gcdebug_remove_stress_to_class(
int argc,
VALUE *argv,
VALUE self)
9476 if (stress_to_class) {
9477 for (
int i = 0; i < argc; ++i) {
9478 rb_hash_delete(stress_to_class, argv[i]);
9481 if (rb_hash_size(stress_to_class) == 0) {
9482 stress_to_class = 0;
9491rb_gc_impl_objspace_alloc(
void)
9499rb_gc_impl_objspace_init(
void *objspace_ptr)
9503 gc_config_full_mark_set(TRUE);
9506 malloc_limit = gc_params.malloc_limit_min;
9508 if (
objspace->finalize_deferred_pjob == POSTPONED_JOB_HANDLE_INVALID) {
9509 rb_bug(
"Could not preregister postponed job for GC");
9512 for (
int i = 0; i < HEAP_COUNT; i++) {
9515 heap->slot_size = pool_slot_sizes[i];
9516 slot_div_magics[i] = (uint32_t)((uint64_t)UINT32_MAX / heap->slot_size + 1);
9518 ccan_list_head_init(&heap->pages);
9521 init_size_to_heap_idx();
9523 rb_darray_make_without_gc(&
objspace->heap_pages.sorted, 0);
9524 rb_darray_make_without_gc(&
objspace->weak_references, 0);
9526#if defined(INIT_HEAP_PAGE_ALLOC_USE_MMAP)
9528 heap_page_alloc_use_mmap = INIT_HEAP_PAGE_ALLOC_USE_MMAP;
9530#if RGENGC_ESTIMATE_OLDMALLOC
9531 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
9533 gc_params.heap_init_bytes = GC_HEAP_INIT_BYTES;
9535 init_mark_stack(&
objspace->mark_stack);
9537 objspace->profile.invoke_time = getrusage_time();
9538 finalizer_table = st_init_numtable();
9542rb_gc_impl_init(
void)
9544 VALUE gc_constants = rb_hash_new();
9545 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"DEBUG")), GC_DEBUG ?
Qtrue :
Qfalse);
9547 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RVALUE_OVERHEAD")),
SIZET2NUM(RVALUE_OVERHEAD));
9548 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_PAGE_BITMAP_SIZE")),
SIZET2NUM(HEAP_PAGE_BITMAP_SIZE));
9549 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_PAGE_SIZE")),
SIZET2NUM(HEAP_PAGE_SIZE));
9550 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"HEAP_COUNT")),
LONG2FIX(HEAP_COUNT));
9551 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RVARGC_MAX_ALLOCATE_SIZE")),
LONG2FIX(heap_slot_size(HEAP_COUNT - 1)));
9552 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RVALUE_OLD_AGE")),
LONG2FIX(RVALUE_OLD_AGE));
9553 if (RB_BUG_INSTEAD_OF_RB_MEMERROR+0) {
9554 rb_hash_aset(gc_constants,
ID2SYM(rb_intern(
"RB_BUG_INSTEAD_OF_RB_MEMERROR")),
Qtrue);
9558 rb_define_const(
rb_mGC,
"INTERNAL_CONSTANTS", gc_constants);
9560 if (GC_COMPACTION_SUPPORTED) {
9575#if GC_DEBUG_STRESS_TO_CLASS
9583#if MALLOC_ALLOCATED_SIZE
9602#define OPT(o) if (o) rb_ary_push(opts, rb_interned_str(#o, sizeof(#o) - 1))
9606 OPT(RGENGC_CHECK_MODE);
9607 OPT(RGENGC_PROFILE);
9608 OPT(RGENGC_ESTIMATE_OLDMALLOC);
9609 OPT(GC_PROFILE_MORE_DETAIL);
9610 OPT(GC_ENABLE_LAZY_SWEEP);
9611 OPT(CALC_EXACT_MALLOC_SIZE);
9612 OPT(MALLOC_ALLOCATED_SIZE);
9613 OPT(MALLOC_ALLOCATED_SIZE_CHECK);
9614 OPT(GC_PROFILE_DETAIL_MEMORY);
9615 OPT(GC_COMPACTION_SUPPORTED);
#define RBIMPL_ASSERT_OR_ASSUME(...)
This is either RUBY_ASSERT or RBIMPL_ASSUME, depending on RUBY_DEBUG.
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define RUBY_ATOMIC_VALUE_CAS(var, oldval, newval)
Identical to RUBY_ATOMIC_CAS, except it expects its arguments are VALUE.
#define RUBY_ATOMIC_SIZE_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 RB_GNUC_EXTENSION_BLOCK(x)
This is expanded to the passed token for non-GCC compilers.
#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).
static VALUE RB_FL_TEST(VALUE obj, VALUE flags)
Tests if the given flag(s) are set or not.
static VALUE RB_FL_TEST_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_TEST().
static void RB_FL_SET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_SET().
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".
@ RUBY_FL_WEAK_REFERENCE
This object weakly refers to other objects.
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 FL_SET_RAW
Old name of RB_FL_SET_RAW.
#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.
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 capa
Designed capacity of the buffer.
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 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.)