Ruby 4.1.0dev (2026-05-27 revision ce7f3ed832a50e493e3b6cb592791aa1fe784d85)
default.c
1#include "ruby/internal/config.h"
2
3#include <signal.h>
4
5#ifndef _WIN32
6# include <sys/mman.h>
7# include <unistd.h>
8# ifdef HAVE_SYS_PRCTL_H
9# include <sys/prctl.h>
10# endif
11#endif
12
13#if !defined(PAGE_SIZE) && defined(HAVE_SYS_USER_H)
14/* LIST_HEAD conflicts with sys/queue.h on macOS */
15# include <sys/user.h>
16#endif
17
18#ifdef BUILDING_MODULAR_GC
19# define nlz_int64(x) (x == 0 ? 64 : (unsigned int)__builtin_clzll((unsigned long long)x))
20#else
21# include "internal/bits.h"
22#endif
23
24#include "ruby/ruby.h"
25#include "ruby/atomic.h"
26#include "ruby_atomic.h"
27#include "ruby/debug.h"
28#include "ruby/thread.h"
29#include "ruby/util.h"
30#include "ruby/vm.h"
32#include "ccan/list/list.h"
33#include "darray.h"
34#include "gc/gc.h"
35#include "gc/gc_impl.h"
36
37#ifndef BUILDING_MODULAR_GC
38# include "probes.h"
39#endif
40
41#ifdef BUILDING_MODULAR_GC
42# define RB_DEBUG_COUNTER_INC(_name) ((void)0)
43# define RB_DEBUG_COUNTER_INC_IF(_name, cond) (!!(cond))
44#else
45# include "debug_counter.h"
46#endif
47
48#ifdef BUILDING_MODULAR_GC
49# define rb_asan_poison_object(obj) ((void)(obj))
50# define rb_asan_unpoison_object(obj, newobj_p) ((void)(obj), (void)(newobj_p))
51# define asan_unpoisoning_object(obj) if ((obj) || true)
52# define asan_poison_memory_region(ptr, size) ((void)(ptr), (void)(size))
53# define asan_unpoison_memory_region(ptr, size, malloc_p) ((void)(ptr), (size), (malloc_p))
54# define asan_unpoisoning_memory_region(ptr, size) if ((ptr) || (size) || true)
55
56# define VALGRIND_MAKE_MEM_DEFINED(ptr, size) ((void)(ptr), (void)(size))
57# define VALGRIND_MAKE_MEM_UNDEFINED(ptr, size) ((void)(ptr), (void)(size))
58#else
59# include "internal/sanitizers.h"
60#endif
61
62/* MALLOC_HEADERS_BEGIN */
63#ifndef HAVE_MALLOC_USABLE_SIZE
64# ifdef _WIN32
65# define HAVE_MALLOC_USABLE_SIZE
66# define malloc_usable_size(a) _msize(a)
67# elif defined HAVE_MALLOC_SIZE
68# define HAVE_MALLOC_USABLE_SIZE
69# define malloc_usable_size(a) malloc_size(a)
70# endif
71#endif
72
73#ifdef HAVE_MALLOC_USABLE_SIZE
74# ifdef RUBY_ALTERNATIVE_MALLOC_HEADER
75/* Alternative malloc header is included in ruby/missing.h */
76# elif defined(HAVE_MALLOC_H)
77# include <malloc.h>
78# elif defined(HAVE_MALLOC_NP_H)
79# include <malloc_np.h>
80# elif defined(HAVE_MALLOC_MALLOC_H)
81# include <malloc/malloc.h>
82# endif
83#endif
84
85#ifdef HAVE_MALLOC_TRIM
86# include <malloc.h>
87
88# ifdef __EMSCRIPTEN__
89/* malloc_trim is defined in emscripten/emmalloc.h on emscripten. */
90# include <emscripten/emmalloc.h>
91# endif
92#endif
93
94#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
95# include <mach/task.h>
96# include <mach/mach_init.h>
97# include <mach/mach_port.h>
98#endif
99
100#ifndef RUBY_DEBUG_LOG
101# define RUBY_DEBUG_LOG(...)
102#endif
103
104#ifndef GC_HEAP_INIT_BYTES
105#define GC_HEAP_INIT_BYTES (2560 * 1024)
106#endif
107#ifndef GC_HEAP_FREE_SLOTS
108#define GC_HEAP_FREE_SLOTS 4096
109#endif
110#ifndef GC_HEAP_GROWTH_FACTOR
111#define GC_HEAP_GROWTH_FACTOR 1.8
112#endif
113#ifndef GC_HEAP_GROWTH_MAX_BYTES
114#define GC_HEAP_GROWTH_MAX_BYTES 0 /* 0 is disable */
115#endif
116#ifndef GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO
117# define GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO 0.01
118#endif
119#ifndef GC_HEAP_OLDOBJECT_LIMIT_FACTOR
120#define GC_HEAP_OLDOBJECT_LIMIT_FACTOR 2.0
121#endif
122
123#ifndef GC_HEAP_FREE_SLOTS_MIN_RATIO
124#define GC_HEAP_FREE_SLOTS_MIN_RATIO 0.20
125#endif
126#ifndef GC_HEAP_FREE_SLOTS_GOAL_RATIO
127#define GC_HEAP_FREE_SLOTS_GOAL_RATIO 0.40
128#endif
129#ifndef GC_HEAP_FREE_SLOTS_MAX_RATIO
130#define GC_HEAP_FREE_SLOTS_MAX_RATIO 0.65
131#endif
132
133#ifndef GC_MALLOC_LIMIT_MIN
134#define GC_MALLOC_LIMIT_MIN (16 * 1024 * 1024 /* 16MB */)
135#endif
136#ifndef GC_MALLOC_LIMIT_MAX
137#define GC_MALLOC_LIMIT_MAX (32 * 1024 * 1024 /* 32MB */)
138#endif
139#ifndef GC_MALLOC_LIMIT_GROWTH_FACTOR
140#define GC_MALLOC_LIMIT_GROWTH_FACTOR 1.4
141#endif
142
143#ifndef GC_OLDMALLOC_LIMIT_MIN
144#define GC_OLDMALLOC_LIMIT_MIN (16 * 1024 * 1024 /* 16MB */)
145#endif
146#ifndef GC_OLDMALLOC_LIMIT_GROWTH_FACTOR
147#define GC_OLDMALLOC_LIMIT_GROWTH_FACTOR 1.2
148#endif
149#ifndef GC_OLDMALLOC_LIMIT_MAX
150#define GC_OLDMALLOC_LIMIT_MAX (128 * 1024 * 1024 /* 128MB */)
151#endif
152
153#ifndef GC_MALLOC_INCREASE_LOCAL_THRESHOLD
154#define GC_MALLOC_INCREASE_LOCAL_THRESHOLD (8 * 1024 /* 8KB */)
155#endif
156
157#ifdef RB_THREAD_LOCAL_SPECIFIER
158#define USE_MALLOC_INCREASE_LOCAL 1
159static RB_THREAD_LOCAL_SPECIFIER int malloc_increase_local;
160#else
161#define USE_MALLOC_INCREASE_LOCAL 0
162#endif
163
164#ifndef GC_CAN_COMPILE_COMPACTION
165#if defined(__wasi__) /* WebAssembly doesn't support signals */
166# define GC_CAN_COMPILE_COMPACTION 0
167#else
168# define GC_CAN_COMPILE_COMPACTION 1
169#endif
170#endif
171
172#ifndef PRINT_ENTER_EXIT_TICK
173# define PRINT_ENTER_EXIT_TICK 0
174#endif
175#ifndef PRINT_ROOT_TICKS
176#define PRINT_ROOT_TICKS 0
177#endif
178
179#define USE_TICK_T (PRINT_ENTER_EXIT_TICK || PRINT_ROOT_TICKS)
180
181#ifndef HEAP_COUNT
182# if SIZEOF_VALUE >= 8
183# define HEAP_COUNT 12
184# else
185# define HEAP_COUNT 5
186# endif
187#endif
188
189/* The reciprocal table and pool_slot_sizes array are both generated from this
190 * single definition, so they can never get out of sync. */
191#if SIZEOF_VALUE >= 8
192# define EACH_POOL_SLOT_SIZE(SLOT) \
193 SLOT(32) SLOT(40) SLOT(64) SLOT(80) SLOT(96) SLOT(128) \
194 SLOT(160) SLOT(256) SLOT(512) SLOT(640) SLOT(768) SLOT(1024)
195#else
196# define EACH_POOL_SLOT_SIZE(SLOT) \
197 SLOT(32) SLOT(64) SLOT(128) SLOT(256) SLOT(512)
198#endif
199
201 struct free_slot *freelist;
202 struct heap_page *using_page;
203 size_t allocated_objects_count;
205
206typedef struct ractor_newobj_cache {
207 size_t incremental_mark_step_allocated_slots;
208 rb_ractor_newobj_heap_cache_t heap_caches[HEAP_COUNT];
210
211typedef struct {
212 size_t heap_init_bytes;
213 size_t heap_free_slots;
214 double growth_factor;
215 size_t growth_max_bytes;
216
217 double heap_free_slots_min_ratio;
218 double heap_free_slots_goal_ratio;
219 double heap_free_slots_max_ratio;
220 double uncollectible_wb_unprotected_objects_limit_ratio;
221 double oldobject_limit_factor;
222
223 size_t malloc_limit_min;
224 size_t malloc_limit_max;
225 double malloc_limit_growth_factor;
226
227 size_t oldmalloc_limit_min;
228 size_t oldmalloc_limit_max;
229 double oldmalloc_limit_growth_factor;
231
232static ruby_gc_params_t gc_params = {
233 GC_HEAP_INIT_BYTES,
234 GC_HEAP_FREE_SLOTS,
235 GC_HEAP_GROWTH_FACTOR,
236 GC_HEAP_GROWTH_MAX_BYTES,
237
238 GC_HEAP_FREE_SLOTS_MIN_RATIO,
239 GC_HEAP_FREE_SLOTS_GOAL_RATIO,
240 GC_HEAP_FREE_SLOTS_MAX_RATIO,
241 GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO,
242 GC_HEAP_OLDOBJECT_LIMIT_FACTOR,
243
244 GC_MALLOC_LIMIT_MIN,
245 GC_MALLOC_LIMIT_MAX,
246 GC_MALLOC_LIMIT_GROWTH_FACTOR,
247
248 GC_OLDMALLOC_LIMIT_MIN,
249 GC_OLDMALLOC_LIMIT_MAX,
250 GC_OLDMALLOC_LIMIT_GROWTH_FACTOR,
251};
252
253/* GC_DEBUG:
254 * enable to embed GC debugging information.
255 */
256#ifndef GC_DEBUG
257#define GC_DEBUG 0
258#endif
259
260/* RGENGC_DEBUG:
261 * 1: basic information
262 * 2: remember set operation
263 * 3: mark
264 * 4:
265 * 5: sweep
266 */
267#ifndef RGENGC_DEBUG
268#ifdef RUBY_DEVEL
269#define RGENGC_DEBUG -1
270#else
271#define RGENGC_DEBUG 0
272#endif
273#endif
274#if RGENGC_DEBUG < 0 && !defined(_MSC_VER)
275# define RGENGC_DEBUG_ENABLED(level) (-(RGENGC_DEBUG) >= (level) && ruby_rgengc_debug >= (level))
276#elif defined(HAVE_VA_ARGS_MACRO)
277# define RGENGC_DEBUG_ENABLED(level) ((RGENGC_DEBUG) >= (level))
278#else
279# define RGENGC_DEBUG_ENABLED(level) 0
280#endif
281int ruby_rgengc_debug;
282
283/* RGENGC_PROFILE
284 * 0: disable RGenGC profiling
285 * 1: enable profiling for basic information
286 * 2: enable profiling for each types
287 */
288#ifndef RGENGC_PROFILE
289# define RGENGC_PROFILE 0
290#endif
291
292/* RGENGC_ESTIMATE_OLDMALLOC
293 * Enable/disable to estimate increase size of malloc'ed size by old objects.
294 * If estimation exceeds threshold, then will invoke full GC.
295 * 0: disable estimation.
296 * 1: enable estimation.
297 */
298#ifndef RGENGC_ESTIMATE_OLDMALLOC
299# define RGENGC_ESTIMATE_OLDMALLOC 1
300#endif
301
302#ifndef GC_PROFILE_MORE_DETAIL
303# define GC_PROFILE_MORE_DETAIL 0
304#endif
305#ifndef GC_PROFILE_DETAIL_MEMORY
306# define GC_PROFILE_DETAIL_MEMORY 0
307#endif
308#ifndef GC_ENABLE_LAZY_SWEEP
309# define GC_ENABLE_LAZY_SWEEP 1
310#endif
311
312#ifndef VERIFY_FREE_SIZE
313#if RUBY_DEBUG
314#define VERIFY_FREE_SIZE 1
315#else
316#define VERIFY_FREE_SIZE 0
317#endif
318#endif
319
320#if VERIFY_FREE_SIZE
321#undef CALC_EXACT_MALLOC_SIZE
322#define CALC_EXACT_MALLOC_SIZE 1
323#endif
324
325#ifndef CALC_EXACT_MALLOC_SIZE
326# define CALC_EXACT_MALLOC_SIZE 0
327#endif
328
329#if defined(HAVE_MALLOC_USABLE_SIZE) || CALC_EXACT_MALLOC_SIZE > 0
330# ifndef MALLOC_ALLOCATED_SIZE
331# define MALLOC_ALLOCATED_SIZE 0
332# endif
333#else
334# define MALLOC_ALLOCATED_SIZE 0
335#endif
336#ifndef MALLOC_ALLOCATED_SIZE_CHECK
337# define MALLOC_ALLOCATED_SIZE_CHECK 0
338#endif
339
340#ifndef GC_DEBUG_STRESS_TO_CLASS
341# define GC_DEBUG_STRESS_TO_CLASS RUBY_DEBUG
342#endif
343
344typedef enum {
345 GPR_FLAG_NONE = 0x000,
346 /* major reason */
347 GPR_FLAG_MAJOR_BY_NOFREE = 0x001,
348 GPR_FLAG_MAJOR_BY_OLDGEN = 0x002,
349 GPR_FLAG_MAJOR_BY_SHADY = 0x004,
350 GPR_FLAG_MAJOR_BY_FORCE = 0x008,
351#if RGENGC_ESTIMATE_OLDMALLOC
352 GPR_FLAG_MAJOR_BY_OLDMALLOC = 0x020,
353#endif
354 GPR_FLAG_MAJOR_MASK = 0x0ff,
355
356 /* gc reason */
357 GPR_FLAG_NEWOBJ = 0x100,
358 GPR_FLAG_MALLOC = 0x200,
359 GPR_FLAG_METHOD = 0x400,
360 GPR_FLAG_CAPI = 0x800,
361 GPR_FLAG_STRESS = 0x1000,
362
363 /* others */
364 GPR_FLAG_IMMEDIATE_SWEEP = 0x2000,
365 GPR_FLAG_HAVE_FINALIZE = 0x4000,
366 GPR_FLAG_IMMEDIATE_MARK = 0x8000,
367 GPR_FLAG_FULL_MARK = 0x10000,
368 GPR_FLAG_COMPACT = 0x20000,
369
370 GPR_DEFAULT_REASON =
371 (GPR_FLAG_FULL_MARK | GPR_FLAG_IMMEDIATE_MARK |
372 GPR_FLAG_IMMEDIATE_SWEEP | GPR_FLAG_CAPI),
373} gc_profile_record_flag;
374
375typedef struct gc_profile_record {
376 unsigned int flags;
377
378 double gc_time;
379 double gc_invoke_time;
380
381 size_t heap_total_objects;
382 size_t heap_use_size;
383 size_t heap_total_size;
384 size_t moved_objects;
385
386#if GC_PROFILE_MORE_DETAIL
387 double gc_mark_time;
388 double gc_sweep_time;
389
390 size_t heap_use_pages;
391 size_t heap_live_objects;
392 size_t heap_free_objects;
393
394 size_t allocate_increase;
395 size_t allocate_limit;
396
397 double prepare_time;
398 size_t removing_objects;
399 size_t empty_objects;
400#if GC_PROFILE_DETAIL_MEMORY
401 long maxrss;
402 long minflt;
403 long majflt;
404#endif
405#endif
406#if MALLOC_ALLOCATED_SIZE
407 size_t allocated_size;
408#endif
409
410#if RGENGC_PROFILE > 0
411 size_t old_objects;
412 size_t remembered_normal_objects;
413 size_t remembered_shady_objects;
414#endif
416
417struct RMoved {
418 VALUE flags;
419 VALUE dummy;
420 VALUE destination;
421};
422
423#define RMOVED(obj) ((struct RMoved *)(obj))
424
425typedef uintptr_t bits_t;
426enum {
427 BITS_SIZE = sizeof(bits_t),
428 BITS_BITLENGTH = ( BITS_SIZE * CHAR_BIT )
429};
430
432 struct heap_page *page;
433};
434
436 struct heap_page_header header;
437 /* char gap[]; */
438 /* RVALUE values[]; */
439};
440
441#define STACK_CHUNK_SIZE 500
442
443typedef struct stack_chunk {
444 VALUE data[STACK_CHUNK_SIZE];
445 struct stack_chunk *next;
447
448typedef struct mark_stack {
449 stack_chunk_t *chunk;
450 stack_chunk_t *cache;
451 int index;
452 int limit;
453 size_t cache_size;
454 size_t unused_cache_size;
456
457typedef int (*gc_compact_compare_func)(const void *l, const void *r, void *d);
458
459typedef struct rb_heap_struct {
460 short slot_size;
461
462 /* Basic statistics */
463 size_t total_allocated_pages;
464 size_t force_major_gc_count;
465 size_t force_incremental_marking_finish_count;
466 size_t total_allocated_objects;
467 size_t total_freed_objects;
468 size_t final_slots_count;
469
470 /* Sweeping statistics */
471 size_t freed_slots;
472 size_t empty_slots;
473
474 struct heap_page *free_pages;
475 struct ccan_list_head pages;
476 struct heap_page *sweeping_page; /* iterator for .pages */
477 struct heap_page *compact_cursor;
478 uintptr_t compact_cursor_index;
479 struct heap_page *pooled_pages;
480 size_t total_pages; /* total page count in a heap */
481 size_t total_slots; /* total slot count */
482
483} rb_heap_t;
484
485enum {
486 gc_stress_no_major,
487 gc_stress_no_immediate_sweep,
488 gc_stress_full_mark_after_malloc,
489 gc_stress_max
490};
491
492enum gc_mode {
493 gc_mode_none,
494 gc_mode_marking,
495 gc_mode_sweeping,
496 gc_mode_compacting,
497};
498
499typedef rbimpl_atomic_uint64_t gc_counter_t;
500
501#if !defined(HAVE_GCC_ATOMIC_BUILTINS_64) && !defined(_WIN32) && \
502 !(defined(__sun) && defined(HAVE_ATOMIC_H) && (defined(_LP64) || defined(_I32LPx)))
503# define MALLOC_COUNTERS_NEED_LOCK 1
504#endif
505
507 gc_counter_t malloc;
508 gc_counter_t free;
509
510 /* Snapshots of `malloc` / `free` taken at the end of the last GC */
511 gc_counter_t malloc_at_last_gc;
512 gc_counter_t free_at_last_gc;
513};
514
515typedef struct rb_objspace {
516 struct {
517 struct gc_malloc_bytes counters;
518#if RGENGC_ESTIMATE_OLDMALLOC
519 struct gc_malloc_bytes oldcounters;
520#endif
521#ifdef MALLOC_COUNTERS_NEED_LOCK
522 rb_nativethread_lock_t lock;
523#endif
524 } malloc_counters;
525
526 struct {
527 size_t limit;
528#if MALLOC_ALLOCATED_SIZE
529 size_t allocated_size;
530 size_t allocations;
531#endif
532 } malloc_params;
533
535 bool full_mark;
536 } gc_config;
537
538 struct {
539 unsigned int mode : 2;
540 unsigned int immediate_sweep : 1;
541 unsigned int dont_gc : 1;
542 unsigned int dont_incremental : 1;
543 unsigned int during_gc : 1;
544 unsigned int during_compacting : 1;
545 unsigned int during_reference_updating : 1;
546 unsigned int gc_stressful: 1;
547 unsigned int during_minor_gc : 1;
548 unsigned int during_incremental_marking : 1;
549 unsigned int measure_gc : 1;
550 } flags;
551
552 rb_event_flag_t hook_events;
553
554 rb_heap_t heaps[HEAP_COUNT];
555 size_t empty_pages_count;
556 struct heap_page *empty_pages;
557
558 struct {
559 rb_atomic_t finalizing;
560 } atomic_flags;
561
563 size_t marked_slots;
564
565 struct {
566 rb_darray(struct heap_page *) sorted;
567
568 size_t allocated_pages;
569 size_t freed_pages;
570 uintptr_t range[2];
571 size_t freeable_pages;
572
573 size_t allocatable_bytes;
574
575 /* final */
576 VALUE deferred_final;
577 } heap_pages;
578
579 st_table *finalizer_table;
580
581 struct {
582 int run;
583 unsigned int latest_gc_info;
584 gc_profile_record *records;
585 gc_profile_record *current_record;
586 size_t next_index;
587 size_t size;
588
589#if GC_PROFILE_MORE_DETAIL
590 double prepare_time;
591#endif
592 double invoke_time;
593
594 size_t minor_gc_count;
595 size_t major_gc_count;
596 size_t compact_count;
597 size_t read_barrier_faults;
598#if RGENGC_PROFILE > 0
599 size_t total_generated_normal_object_count;
600 size_t total_generated_shady_object_count;
601 size_t total_shade_operation_count;
602 size_t total_promoted_count;
603 size_t total_remembered_normal_object_count;
604 size_t total_remembered_shady_object_count;
605
606#if RGENGC_PROFILE >= 2
607 size_t generated_normal_object_count_types[RUBY_T_MASK];
608 size_t generated_shady_object_count_types[RUBY_T_MASK];
609 size_t shade_operation_count_types[RUBY_T_MASK];
610 size_t promoted_types[RUBY_T_MASK];
611 size_t remembered_normal_object_count_types[RUBY_T_MASK];
612 size_t remembered_shady_object_count_types[RUBY_T_MASK];
613#endif
614#endif /* RGENGC_PROFILE */
615
616 /* temporary profiling space */
617 double gc_sweep_start_time;
618 size_t total_allocated_objects_at_gc_start;
619 size_t heap_used_at_gc_start;
620 size_t heap_total_slots_at_gc_start;
621
622 /* basic statistics */
623 size_t count;
624 unsigned long long marking_time_ns;
625 struct timespec marking_start_time;
626 unsigned long long sweeping_time_ns;
627 struct timespec sweeping_start_time;
628
629 /* Weak references */
630 size_t weak_references_count;
631 } profile;
632
633 VALUE gc_stress_mode;
634
635 struct {
636 bool parent_object_old_p;
637 VALUE parent_object;
638
639 int need_major_gc;
640 size_t last_major_gc;
641 size_t uncollectible_wb_unprotected_objects;
642 size_t uncollectible_wb_unprotected_objects_limit;
643 size_t old_objects;
644 size_t old_objects_limit;
645
646#if RGENGC_ESTIMATE_OLDMALLOC
647 size_t oldmalloc_increase_limit;
648#endif
649
650#if RGENGC_CHECK_MODE >= 2
651 struct st_table *allrefs_table;
652 size_t error_count;
653#endif
654 } rgengc;
655
656 struct {
657 size_t considered_count_table[T_MASK];
658 size_t moved_count_table[T_MASK];
659 size_t moved_up_count_table[T_MASK];
660 size_t moved_down_count_table[T_MASK];
661 size_t total_moved;
662
663 /* This function will be used, if set, to sort the heap prior to compaction */
664 gc_compact_compare_func compare_func;
665 } rcompactor;
666
667 struct {
668 size_t pooled_slots;
669 size_t step_slots;
670 } rincgc;
671
672#if GC_DEBUG_STRESS_TO_CLASS
673 VALUE stress_to_class;
674#endif
675
676 rb_darray(VALUE) weak_references;
677 rb_postponed_job_handle_t finalize_deferred_pjob;
678
679 unsigned long live_ractor_cache_count;
680
681 int sweeping_heap_count;
682
683 int fork_vm_lock_lev;
684
685 struct rb_gc_vm_context vm_context;
687
688#ifndef HEAP_PAGE_ALIGN_LOG
689/* default tiny heap size: 64KiB */
690#define HEAP_PAGE_ALIGN_LOG 16
691#endif
692
693#if RB_GC_OBJ_HAS_SUFFIX || GC_DEBUG
694struct rvalue_overhead {
695# if RB_GC_OBJ_HAS_SUFFIX
696 struct rb_gc_obj_suffix suffix;
697# endif
698# if GC_DEBUG
699 const char *file;
700 int line;
701# endif
702};
703
704// Make sure that RVALUE_OVERHEAD aligns to sizeof(VALUE)
705# define RVALUE_OVERHEAD (sizeof(struct { \
706 union { \
707 struct rvalue_overhead overhead; \
708 VALUE value; \
709 }; \
710}))
711size_t rb_gc_impl_obj_slot_size(VALUE obj);
712# define GET_RVALUE_OVERHEAD(obj) ((struct rvalue_overhead *)((uintptr_t)obj + rb_gc_impl_obj_slot_size(obj)))
713#else
714# ifndef RVALUE_OVERHEAD
715# define RVALUE_OVERHEAD 0
716# endif
717#endif
718
719#define RVALUE_SLOT_SIZE (sizeof(struct RBasic) + sizeof(VALUE[RBIMPL_RVALUE_EMBED_LEN_MAX]) + RVALUE_OVERHEAD)
720
721static const size_t pool_slot_sizes[HEAP_COUNT] = {
722#define SLOT(size) ((size) + RVALUE_OVERHEAD),
723 EACH_POOL_SLOT_SIZE(SLOT)
724#undef SLOT
725};
726
727/* Precomputed reciprocals for fast slot index calculation.
728 * For slot size d: reciprocal = ceil(2^48 / d).
729 * Then offset / d == (uint32_t)((offset * reciprocal) >> 48)
730 * for all offset < HEAP_PAGE_SIZE. */
731#define SLOT_RECIPROCAL_SHIFT 48
732#define SLOT_RECIPROCAL(size) (((1ULL << SLOT_RECIPROCAL_SHIFT) + (size) - 1) / (size))
733
734static const uint64_t heap_slot_reciprocal_table[HEAP_COUNT] = {
735#define SLOT(size) SLOT_RECIPROCAL((size) + RVALUE_OVERHEAD),
736 EACH_POOL_SLOT_SIZE(SLOT)
737#undef SLOT
738};
739
740#if SIZEOF_VALUE >= 8
741static uint8_t size_to_heap_idx[1024 / 8 + 1];
742#else
743static uint8_t size_to_heap_idx[512 / 8 + 1];
744#endif
745
746#ifndef MAX
747# define MAX(a, b) (((a) > (b)) ? (a) : (b))
748#endif
749#ifndef MIN
750# define MIN(a, b) (((a) < (b)) ? (a) : (b))
751#endif
752#define roomof(x, y) (((x) + (y) - 1) / (y))
753#define CEILDIV(i, mod) roomof(i, mod)
754#define MIN_POOL_SLOT_SIZE 32
755enum {
756 HEAP_PAGE_ALIGN = (1UL << HEAP_PAGE_ALIGN_LOG),
757 HEAP_PAGE_ALIGN_MASK = (~(~0UL << HEAP_PAGE_ALIGN_LOG)),
758 HEAP_PAGE_SIZE = HEAP_PAGE_ALIGN,
759 HEAP_PAGE_BITMAP_LIMIT = CEILDIV(CEILDIV(HEAP_PAGE_SIZE, MIN_POOL_SLOT_SIZE), BITS_BITLENGTH),
760 HEAP_PAGE_BITMAP_SIZE = (BITS_SIZE * HEAP_PAGE_BITMAP_LIMIT),
761};
762#define HEAP_PAGE_ALIGN (1 << HEAP_PAGE_ALIGN_LOG)
763#define HEAP_PAGE_SIZE HEAP_PAGE_ALIGN
764
765#if !defined(INCREMENTAL_MARK_STEP_ALLOCATIONS)
766# define INCREMENTAL_MARK_STEP_ALLOCATIONS 500
767#endif
768
769#undef INIT_HEAP_PAGE_ALLOC_USE_MMAP
770/* Must define either HEAP_PAGE_ALLOC_USE_MMAP or
771 * INIT_HEAP_PAGE_ALLOC_USE_MMAP. */
772
773#ifndef HAVE_MMAP
774/* We can't use mmap of course, if it is not available. */
775static const bool HEAP_PAGE_ALLOC_USE_MMAP = false;
776
777#elif defined(__wasm__)
778/* wasmtime does not have proper support for mmap.
779 * See https://github.com/bytecodealliance/wasmtime/blob/main/docs/WASI-rationale.md#why-no-mmap-and-friends
780 */
781static const bool HEAP_PAGE_ALLOC_USE_MMAP = false;
782
783#elif HAVE_CONST_PAGE_SIZE
784/* If we have the PAGE_SIZE and it is a constant, then we can directly use it. */
785static const bool HEAP_PAGE_ALLOC_USE_MMAP = (PAGE_SIZE <= HEAP_PAGE_SIZE);
786
787#elif defined(PAGE_MAX_SIZE) && (PAGE_MAX_SIZE <= HEAP_PAGE_SIZE)
788/* If we can use the maximum page size. */
789static const bool HEAP_PAGE_ALLOC_USE_MMAP = true;
790
791#elif defined(PAGE_SIZE)
792/* If the PAGE_SIZE macro can be used dynamically. */
793# define INIT_HEAP_PAGE_ALLOC_USE_MMAP (PAGE_SIZE <= HEAP_PAGE_SIZE)
794
795#elif defined(HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
796/* If we can use sysconf to determine the page size. */
797# define INIT_HEAP_PAGE_ALLOC_USE_MMAP (sysconf(_SC_PAGE_SIZE) <= HEAP_PAGE_SIZE)
798
799#else
800/* Otherwise we can't determine the system page size, so don't use mmap. */
801static const bool HEAP_PAGE_ALLOC_USE_MMAP = false;
802#endif
803
804#ifdef INIT_HEAP_PAGE_ALLOC_USE_MMAP
805/* We can determine the system page size at runtime. */
806# define HEAP_PAGE_ALLOC_USE_MMAP (heap_page_alloc_use_mmap != false)
807
808static bool heap_page_alloc_use_mmap;
809#endif
810
811#define RVALUE_AGE_BIT_COUNT 2
812#define RVALUE_AGE_BIT_MASK (((bits_t)1 << RVALUE_AGE_BIT_COUNT) - 1)
813#define RVALUE_OLD_AGE 3
814
815struct free_slot {
816 VALUE flags; /* always 0 for freed obj */
817 struct free_slot *next;
818};
819
820struct heap_page {
821 /* Cache line 0: allocation fast path + SLOT_INDEX */
822 struct free_slot *freelist;
823 uintptr_t start;
824 uint64_t slot_size_reciprocal;
825 unsigned short slot_size;
826 unsigned short total_slots;
827 unsigned short free_slots;
828 unsigned short final_slots;
829 unsigned short pinned_slots;
830 struct {
831 unsigned int before_sweep : 1;
832 unsigned int has_remembered_objects : 1;
833 unsigned int has_uncollectible_wb_unprotected_objects : 1;
834 } flags;
835
836 rb_heap_t *heap;
837
838 struct heap_page *free_next;
839 struct heap_page_body *body;
840 struct ccan_list_node page_node;
841
842 bits_t wb_unprotected_bits[HEAP_PAGE_BITMAP_LIMIT];
843 /* the following three bitmaps are cleared at the beginning of full GC */
844 bits_t mark_bits[HEAP_PAGE_BITMAP_LIMIT];
845 bits_t uncollectible_bits[HEAP_PAGE_BITMAP_LIMIT];
846 bits_t marking_bits[HEAP_PAGE_BITMAP_LIMIT];
847
848 bits_t remembered_bits[HEAP_PAGE_BITMAP_LIMIT];
849
850 /* If set, the object is not movable */
851 bits_t pinned_bits[HEAP_PAGE_BITMAP_LIMIT];
852 bits_t age_bits[HEAP_PAGE_BITMAP_LIMIT * RVALUE_AGE_BIT_COUNT];
853};
854
855/*
856 * When asan is enabled, this will prohibit writing to the freelist until it is unlocked
857 */
858static void
859asan_lock_freelist(struct heap_page *page)
860{
861 asan_poison_memory_region(&page->freelist, sizeof(struct free_list *));
862}
863
864/*
865 * When asan is enabled, this will enable the ability to write to the freelist
866 */
867static void
868asan_unlock_freelist(struct heap_page *page)
869{
870 asan_unpoison_memory_region(&page->freelist, sizeof(struct free_list *), false);
871}
872
873static inline bool
874heap_page_in_global_empty_pages_pool(rb_objspace_t *objspace, struct heap_page *page)
875{
876 if (page->total_slots == 0) {
877 GC_ASSERT(page->start == 0);
878 GC_ASSERT(page->slot_size == 0);
879 GC_ASSERT(page->heap == NULL);
880 GC_ASSERT(page->free_slots == 0);
881 asan_unpoisoning_memory_region(&page->freelist, sizeof(&page->freelist)) {
882 GC_ASSERT(page->freelist == NULL);
883 }
884
885 return true;
886 }
887 else {
888 GC_ASSERT(page->start != 0);
889 GC_ASSERT(page->slot_size != 0);
890 GC_ASSERT(page->heap != NULL);
891
892 return false;
893 }
894}
895
896#define GET_PAGE_BODY(x) ((struct heap_page_body *)((bits_t)(x) & ~(HEAP_PAGE_ALIGN_MASK)))
897#define GET_PAGE_HEADER(x) (&GET_PAGE_BODY(x)->header)
898#define GET_HEAP_PAGE(x) (GET_PAGE_HEADER(x)->page)
899
900static inline size_t
901slot_index_for_offset(size_t offset, uint64_t reciprocal)
902{
903 return (uint32_t)(((uint64_t)offset * reciprocal) >> SLOT_RECIPROCAL_SHIFT);
904}
905
906#define SLOT_INDEX(page, p) slot_index_for_offset((uintptr_t)(p) - (page)->start, (page)->slot_size_reciprocal)
907#define SLOT_BITMAP_INDEX(page, p) (SLOT_INDEX(page, p) / BITS_BITLENGTH)
908#define SLOT_BITMAP_OFFSET(page, p) (SLOT_INDEX(page, p) & (BITS_BITLENGTH - 1))
909#define SLOT_BITMAP_BIT(page, p) ((bits_t)1 << SLOT_BITMAP_OFFSET(page, p))
910
911#define _MARKED_IN_BITMAP(bits, page, p) ((bits)[SLOT_BITMAP_INDEX(page, p)] & SLOT_BITMAP_BIT(page, p))
912#define _MARK_IN_BITMAP(bits, page, p) ((bits)[SLOT_BITMAP_INDEX(page, p)] |= SLOT_BITMAP_BIT(page, p))
913#define _CLEAR_IN_BITMAP(bits, page, p) ((bits)[SLOT_BITMAP_INDEX(page, p)] &= ~SLOT_BITMAP_BIT(page, p))
914
915#define MARKED_IN_BITMAP(bits, p) _MARKED_IN_BITMAP(bits, GET_HEAP_PAGE(p), p)
916#define MARK_IN_BITMAP(bits, p) _MARK_IN_BITMAP(bits, GET_HEAP_PAGE(p), p)
917#define CLEAR_IN_BITMAP(bits, p) _CLEAR_IN_BITMAP(bits, GET_HEAP_PAGE(p), p)
918
919#define GET_HEAP_MARK_BITS(x) (&GET_HEAP_PAGE(x)->mark_bits[0])
920#define GET_HEAP_PINNED_BITS(x) (&GET_HEAP_PAGE(x)->pinned_bits[0])
921#define GET_HEAP_UNCOLLECTIBLE_BITS(x) (&GET_HEAP_PAGE(x)->uncollectible_bits[0])
922#define GET_HEAP_WB_UNPROTECTED_BITS(x) (&GET_HEAP_PAGE(x)->wb_unprotected_bits[0])
923#define GET_HEAP_MARKING_BITS(x) (&GET_HEAP_PAGE(x)->marking_bits[0])
924
925static int
926RVALUE_AGE_GET(VALUE obj)
927{
928 struct heap_page *page = GET_HEAP_PAGE(obj);
929 bits_t *age_bits = page->age_bits;
930 size_t slot_idx = SLOT_INDEX(page, obj);
931 size_t idx = (slot_idx / BITS_BITLENGTH) * 2;
932 int shift = (int)(slot_idx & (BITS_BITLENGTH - 1));
933 int lo = (age_bits[idx] >> shift) & 1;
934 int hi = (age_bits[idx + 1] >> shift) & 1;
935 return lo | (hi << 1);
936}
937
938static void
939RVALUE_AGE_SET_BITMAP(VALUE obj, int age)
940{
941 RUBY_ASSERT(age <= RVALUE_OLD_AGE);
942 struct heap_page *page = GET_HEAP_PAGE(obj);
943 bits_t *age_bits = page->age_bits;
944 size_t slot_idx = SLOT_INDEX(page, obj);
945 size_t idx = (slot_idx / BITS_BITLENGTH) * 2;
946 int shift = (int)(slot_idx & (BITS_BITLENGTH - 1));
947 bits_t mask = (bits_t)1 << shift;
948
949 age_bits[idx] = (age_bits[idx] & ~mask) | ((bits_t)(age & 1) << shift);
950 age_bits[idx + 1] = (age_bits[idx + 1] & ~mask) | ((bits_t)((age >> 1) & 1) << shift);
951}
952
953static void
954RVALUE_AGE_SET(VALUE obj, int age)
955{
956 RVALUE_AGE_SET_BITMAP(obj, age);
957 if (age == RVALUE_OLD_AGE) {
959 }
960 else {
962 }
963}
964
965#define malloc_limit objspace->malloc_params.limit
966#define malloc_increase gc_malloc_counters_increase_unsigned(objspace, &objspace->malloc_counters.counters)
967#define malloc_allocated_size objspace->malloc_params.allocated_size
968
969#ifdef MALLOC_COUNTERS_NEED_LOCK
970# define MALLOC_COUNTERS_LOCK(o) rb_native_mutex_lock(&(o)->malloc_counters.lock)
971# define MALLOC_COUNTERS_UNLOCK(o) rb_native_mutex_unlock(&(o)->malloc_counters.lock)
972#else
973# define MALLOC_COUNTERS_LOCK(o) ((void)0)
974# define MALLOC_COUNTERS_UNLOCK(o) ((void)0)
975#endif
976
977static inline void
978gc_counter_add(gc_counter_t *p, size_t delta)
979{
980#ifdef MALLOC_COUNTERS_NEED_LOCK
981 *p += (gc_counter_t)delta;
982#else
983 rbimpl_atomic_u64_fetch_add_relaxed(p, (uint64_t)delta);
984#endif
985}
986
987static inline gc_counter_t
988gc_counter_load_relaxed(const gc_counter_t *p)
989{
990#ifdef MALLOC_COUNTERS_NEED_LOCK
991 return *p;
992#else
993 return rbimpl_atomic_u64_load_relaxed(p);
994#endif
995}
996
997static inline gc_counter_t
998gc_counter_load_acquire(const gc_counter_t *p)
999{
1000#ifdef MALLOC_COUNTERS_NEED_LOCK
1001 return *p;
1002#else
1003 return rbimpl_atomic_u64_load_acquire(p);
1004#endif
1005}
1006
1007static inline void
1008gc_counter_store_release(gc_counter_t *p, gc_counter_t v)
1009{
1010#ifdef MALLOC_COUNTERS_NEED_LOCK
1011 *p = v;
1012#else
1013 rbimpl_atomic_u64_set_release(p, v);
1014#endif
1015}
1016
1017static inline int64_t
1018gc_malloc_counters_increase(rb_objspace_t *objspace, const struct gc_malloc_bytes *c)
1019{
1020 MALLOC_COUNTERS_LOCK(objspace);
1021 gc_counter_t malloc_at = gc_counter_load_acquire(&c->malloc_at_last_gc);
1022 gc_counter_t free_at = gc_counter_load_acquire(&c->free_at_last_gc);
1023 gc_counter_t malloc_now = gc_counter_load_relaxed(&c->malloc);
1024 gc_counter_t free_now = gc_counter_load_relaxed(&c->free);
1025 MALLOC_COUNTERS_UNLOCK(objspace);
1026
1027 gc_counter_t malloc_delta = malloc_now - malloc_at;
1028 gc_counter_t free_delta = free_now - free_at;
1029
1030 if (malloc_delta >= free_delta) {
1031 return (int64_t)(malloc_delta - free_delta);
1032 }
1033 else {
1034 return -(int64_t)(free_delta - malloc_delta);
1035 }
1036}
1037
1038static inline size_t
1039gc_malloc_counters_increase_unsigned(rb_objspace_t *objspace, const struct gc_malloc_bytes *c)
1040{
1041 int64_t inc = gc_malloc_counters_increase(objspace, c);
1042 if (inc <= 0) return 0;
1043#if SIZEOF_SIZE_T < 8
1044 if ((uint64_t)inc > SIZE_MAX) return SIZE_MAX;
1045#endif
1046 return (size_t)inc;
1047}
1048
1049static inline int64_t
1050gc_malloc_counters_snapshot(rb_objspace_t *objspace, struct gc_malloc_bytes *c)
1051{
1052 MALLOC_COUNTERS_LOCK(objspace);
1053 gc_counter_t malloc_now = gc_counter_load_relaxed(&c->malloc);
1054 gc_counter_t free_now = gc_counter_load_relaxed(&c->free);
1055 gc_counter_t malloc_at = gc_counter_load_relaxed(&c->malloc_at_last_gc);
1056 gc_counter_t free_at = gc_counter_load_relaxed(&c->free_at_last_gc);
1057 gc_counter_store_release(&c->malloc_at_last_gc, malloc_now);
1058 gc_counter_store_release(&c->free_at_last_gc, free_now);
1059 MALLOC_COUNTERS_UNLOCK(objspace);
1060
1061 gc_counter_t malloc_delta = malloc_now - malloc_at;
1062 gc_counter_t free_delta = free_now - free_at;
1063
1064 if (malloc_delta >= free_delta) {
1065 return (int64_t)(malloc_delta - free_delta);
1066 }
1067 else {
1068 return -(int64_t)(free_delta - malloc_delta);
1069 }
1070}
1071
1072#define heap_pages_lomem objspace->heap_pages.range[0]
1073#define heap_pages_himem objspace->heap_pages.range[1]
1074#define heap_pages_freeable_pages objspace->heap_pages.freeable_pages
1075#define heap_pages_deferred_final objspace->heap_pages.deferred_final
1076#define heaps objspace->heaps
1077#define during_gc objspace->flags.during_gc
1078#define finalizing objspace->atomic_flags.finalizing
1079#define finalizer_table objspace->finalizer_table
1080#define ruby_gc_stressful objspace->flags.gc_stressful
1081#define ruby_gc_stress_mode objspace->gc_stress_mode
1082#if GC_DEBUG_STRESS_TO_CLASS
1083#define stress_to_class objspace->stress_to_class
1084#define set_stress_to_class(c) (stress_to_class = (c))
1085#else
1086#define stress_to_class ((void)objspace, 0)
1087#define set_stress_to_class(c) ((void)objspace, (c))
1088#endif
1089
1090#if 0
1091#define dont_gc_on() (fprintf(stderr, "dont_gc_on@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = 1)
1092#define dont_gc_off() (fprintf(stderr, "dont_gc_off@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = 0)
1093#define dont_gc_set(b) (fprintf(stderr, "dont_gc_set(%d)@%s:%d\n", __FILE__, __LINE__), objspace->flags.dont_gc = (int)(b))
1094#define dont_gc_val() (objspace->flags.dont_gc)
1095#else
1096#define dont_gc_on() (objspace->flags.dont_gc = 1)
1097#define dont_gc_off() (objspace->flags.dont_gc = 0)
1098#define dont_gc_set(b) (objspace->flags.dont_gc = (int)(b))
1099#define dont_gc_val() (objspace->flags.dont_gc)
1100#endif
1101
1102#define gc_config_full_mark_set(b) (objspace->gc_config.full_mark = (int)(b))
1103#define gc_config_full_mark_val (objspace->gc_config.full_mark)
1104
1105#ifndef DURING_GC_COULD_MALLOC_REGION_START
1106# define DURING_GC_COULD_MALLOC_REGION_START() \
1107 assert(rb_during_gc()); \
1108 bool _prev_enabled = rb_gc_impl_gc_enabled_p(objspace); \
1109 rb_gc_impl_gc_disable(objspace, false)
1110#endif
1111
1112#ifndef DURING_GC_COULD_MALLOC_REGION_END
1113# define DURING_GC_COULD_MALLOC_REGION_END() \
1114 if (_prev_enabled) rb_gc_impl_gc_enable(objspace)
1115#endif
1116
1117static inline enum gc_mode
1118gc_mode_verify(enum gc_mode mode)
1119{
1120#if RGENGC_CHECK_MODE > 0
1121 switch (mode) {
1122 case gc_mode_none:
1123 case gc_mode_marking:
1124 case gc_mode_sweeping:
1125 case gc_mode_compacting:
1126 break;
1127 default:
1128 rb_bug("gc_mode_verify: unreachable (%d)", (int)mode);
1129 }
1130#endif
1131 return mode;
1132}
1133
1134static inline bool
1135has_sweeping_pages(rb_objspace_t *objspace)
1136{
1137 return objspace->sweeping_heap_count != 0;
1138}
1139
1140static inline size_t
1141heap_eden_total_pages(rb_objspace_t *objspace)
1142{
1143 size_t count = 0;
1144 for (int i = 0; i < HEAP_COUNT; i++) {
1145 count += (&heaps[i])->total_pages;
1146 }
1147 return count;
1148}
1149
1150static inline size_t
1151total_allocated_objects(rb_objspace_t *objspace)
1152{
1153 size_t count = 0;
1154 for (int i = 0; i < HEAP_COUNT; i++) {
1155 rb_heap_t *heap = &heaps[i];
1156 count += heap->total_allocated_objects;
1157 }
1158 return count;
1159}
1160
1161static inline size_t
1162total_freed_objects(rb_objspace_t *objspace)
1163{
1164 size_t count = 0;
1165 for (int i = 0; i < HEAP_COUNT; i++) {
1166 rb_heap_t *heap = &heaps[i];
1167 count += heap->total_freed_objects;
1168 }
1169 return count;
1170}
1171
1172static inline size_t
1173total_final_slots_count(rb_objspace_t *objspace)
1174{
1175 size_t count = 0;
1176 for (int i = 0; i < HEAP_COUNT; i++) {
1177 rb_heap_t *heap = &heaps[i];
1178 count += heap->final_slots_count;
1179 }
1180 return count;
1181}
1182
1183#define gc_mode(objspace) gc_mode_verify((enum gc_mode)(objspace)->flags.mode)
1184#define gc_mode_set(objspace, m) ((objspace)->flags.mode = (unsigned int)gc_mode_verify(m))
1185#define gc_needs_major_flags objspace->rgengc.need_major_gc
1186
1187#define is_marking(objspace) (gc_mode(objspace) == gc_mode_marking)
1188#define is_sweeping(objspace) (gc_mode(objspace) == gc_mode_sweeping)
1189#define is_full_marking(objspace) ((objspace)->flags.during_minor_gc == FALSE)
1190#define is_incremental_marking(objspace) ((objspace)->flags.during_incremental_marking != FALSE)
1191#define will_be_incremental_marking(objspace) ((objspace)->rgengc.need_major_gc != GPR_FLAG_NONE)
1192/*
1193 * Byte budget for incremental sweep steps. Each step sweeps at most
1194 * this many bytes worth of slots before yielding. The effective slot
1195 * count per step is GC_INCREMENTAL_SWEEP_BYTES / heap->slot_size,
1196 * so larger slot pools (which are less heavily used) naturally get
1197 * fewer slots swept per step.
1198 *
1199 * Baseline: 2048 slots * RVALUE_SLOT_SIZE = 2048 * 40 = 81920 bytes,
1200 * preserving the historical behavior for the smallest heap.
1201 */
1202#define GC_INCREMENTAL_SWEEP_BYTES (2048 * RVALUE_SLOT_SIZE)
1203#define GC_INCREMENTAL_SWEEP_POOL_BYTES (1024 * RVALUE_SLOT_SIZE)
1204#define is_lazy_sweeping(objspace) (GC_ENABLE_LAZY_SWEEP && has_sweeping_pages(objspace))
1205/* In lazy sweeping or the previous incremental marking finished and did not yield a free page. */
1206#define needs_continue_sweeping(objspace, heap) \
1207 ((heap)->free_pages == NULL && is_lazy_sweeping(objspace))
1208
1209#if SIZEOF_LONG == SIZEOF_VOIDP
1210# define obj_id_to_ref(objid) ((objid) ^ FIXNUM_FLAG) /* unset FIXNUM_FLAG */
1211#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
1212# define obj_id_to_ref(objid) (FIXNUM_P(objid) ? \
1213 ((objid) ^ FIXNUM_FLAG) : (NUM2PTR(objid) << 1))
1214#else
1215# error not supported
1216#endif
1217
1218struct RZombie {
1219 VALUE flags;
1220 VALUE next;
1221 void (*dfree)(void *);
1222 void *data;
1223};
1224
1225#define RZOMBIE(o) ((struct RZombie *)(o))
1226
1227static bool ruby_enable_autocompact = false;
1228#if RGENGC_CHECK_MODE
1229static gc_compact_compare_func ruby_autocompact_compare_func;
1230#endif
1231
1232static void init_mark_stack(mark_stack_t *stack);
1233static int garbage_collect(rb_objspace_t *, unsigned int reason);
1234
1235static int gc_start(rb_objspace_t *objspace, unsigned int reason);
1236static void gc_rest(rb_objspace_t *objspace);
1237
1238enum gc_enter_event {
1239 gc_enter_event_start,
1240 gc_enter_event_continue,
1241 gc_enter_event_rest,
1242 gc_enter_event_finalizer,
1243};
1244
1245static inline void gc_enter(rb_objspace_t *objspace, enum gc_enter_event event, unsigned int *lock_lev);
1246static inline void gc_exit(rb_objspace_t *objspace, enum gc_enter_event event, unsigned int *lock_lev);
1247static void gc_marking_enter(rb_objspace_t *objspace);
1248static void gc_marking_exit(rb_objspace_t *objspace);
1249static void gc_sweeping_enter(rb_objspace_t *objspace);
1250static void gc_sweeping_exit(rb_objspace_t *objspace);
1251static bool gc_marks_continue(rb_objspace_t *objspace, rb_heap_t *heap);
1252
1253static void gc_sweep(rb_objspace_t *objspace);
1254static void gc_sweep_finish_heap(rb_objspace_t *objspace, rb_heap_t *heap);
1255static void gc_sweep_continue(rb_objspace_t *objspace, rb_heap_t *heap);
1256
1257static inline void gc_mark(rb_objspace_t *objspace, VALUE ptr);
1258static inline void gc_pin(rb_objspace_t *objspace, VALUE ptr);
1259static inline void gc_mark_and_pin(rb_objspace_t *objspace, VALUE ptr);
1260
1261static int gc_mark_stacked_objects_incremental(rb_objspace_t *, size_t count);
1262NO_SANITIZE("memory", static inline bool is_pointer_to_heap(rb_objspace_t *objspace, const void *ptr));
1263
1264static void gc_verify_internal_consistency(void *objspace_ptr);
1265
1266static double getrusage_time(void);
1267static inline void gc_prof_setup_new_record(rb_objspace_t *objspace, unsigned int reason);
1268static inline void gc_prof_timer_start(rb_objspace_t *);
1269static inline void gc_prof_timer_stop(rb_objspace_t *);
1270static inline void gc_prof_mark_timer_start(rb_objspace_t *);
1271static inline void gc_prof_mark_timer_stop(rb_objspace_t *);
1272static inline void gc_prof_sweep_timer_start(rb_objspace_t *);
1273static inline void gc_prof_sweep_timer_stop(rb_objspace_t *);
1274static inline void gc_prof_set_malloc_info(rb_objspace_t *);
1275static inline void gc_prof_set_heap_info(rb_objspace_t *);
1276
1277#define gc_prof_record(objspace) (objspace)->profile.current_record
1278#define gc_prof_enabled(objspace) ((objspace)->profile.run && (objspace)->profile.current_record)
1279
1280#ifdef HAVE_VA_ARGS_MACRO
1281# define gc_report(level, objspace, ...) \
1282 if (!RGENGC_DEBUG_ENABLED(level)) {} else gc_report_body(level, objspace, __VA_ARGS__)
1283#else
1284# define gc_report if (!RGENGC_DEBUG_ENABLED(0)) {} else gc_report_body
1285#endif
1286PRINTF_ARGS(static void gc_report_body(int level, rb_objspace_t *objspace, const char *fmt, ...), 3, 4);
1287
1288static void gc_finalize_deferred(void *dmy);
1289
1290#if USE_TICK_T
1291
1292/* the following code is only for internal tuning. */
1293
1294/* Source code to use RDTSC is quoted and modified from
1295 * https://www.mcs.anl.gov/~kazutomo/rdtsc.html
1296 * written by Kazutomo Yoshii <kazutomo@mcs.anl.gov>
1297 */
1298
1299#if defined(__GNUC__) && defined(__i386__)
1300typedef unsigned long long tick_t;
1301#define PRItick "llu"
1302static inline tick_t
1303tick(void)
1304{
1305 unsigned long long int x;
1306 __asm__ __volatile__ ("rdtsc" : "=A" (x));
1307 return x;
1308}
1309
1310#elif defined(__GNUC__) && defined(__x86_64__)
1311typedef unsigned long long tick_t;
1312#define PRItick "llu"
1313
1314static __inline__ tick_t
1315tick(void)
1316{
1317 unsigned long hi, lo;
1318 __asm__ __volatile__ ("rdtsc" : "=a"(lo), "=d"(hi));
1319 return ((unsigned long long)lo)|( ((unsigned long long)hi)<<32);
1320}
1321
1322#elif defined(__powerpc64__) && (GCC_VERSION_SINCE(4,8,0) || defined(__clang__))
1323typedef unsigned long long tick_t;
1324#define PRItick "llu"
1325
1326static __inline__ tick_t
1327tick(void)
1328{
1329 unsigned long long val = __builtin_ppc_get_timebase();
1330 return val;
1331}
1332
1333#elif defined(__POWERPC__) && defined(__APPLE__)
1334/* Implementation for macOS PPC by @nobu
1335 * See: https://github.com/ruby/ruby/pull/5975#discussion_r890045558
1336 */
1337typedef unsigned long long tick_t;
1338#define PRItick "llu"
1339
1340static __inline__ tick_t
1341tick(void)
1342{
1343 unsigned long int upper, lower, tmp;
1344 # define mftbu(r) __asm__ volatile("mftbu %0" : "=r"(r))
1345 # define mftb(r) __asm__ volatile("mftb %0" : "=r"(r))
1346 do {
1347 mftbu(upper);
1348 mftb(lower);
1349 mftbu(tmp);
1350 } while (tmp != upper);
1351 return ((tick_t)upper << 32) | lower;
1352}
1353
1354#elif defined(__aarch64__) && defined(__GNUC__)
1355typedef unsigned long tick_t;
1356#define PRItick "lu"
1357
1358static __inline__ tick_t
1359tick(void)
1360{
1361 unsigned long val;
1362 __asm__ __volatile__ ("mrs %0, cntvct_el0" : "=r" (val));
1363 return val;
1364}
1365
1366
1367#elif defined(_WIN32) && defined(_MSC_VER)
1368#include <intrin.h>
1369typedef unsigned __int64 tick_t;
1370#define PRItick "llu"
1371
1372static inline tick_t
1373tick(void)
1374{
1375 return __rdtsc();
1376}
1377
1378#else /* use clock */
1379typedef clock_t tick_t;
1380#define PRItick "llu"
1381
1382static inline tick_t
1383tick(void)
1384{
1385 return clock();
1386}
1387#endif /* TSC */
1388#else /* USE_TICK_T */
1389#define MEASURE_LINE(expr) expr
1390#endif /* USE_TICK_T */
1391
1392static inline VALUE check_rvalue_consistency(rb_objspace_t *objspace, const VALUE obj);
1393
1394#define RVALUE_MARKED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_MARK_BITS(obj), (obj))
1395#define RVALUE_WB_UNPROTECTED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), (obj))
1396#define RVALUE_MARKING_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), (obj))
1397#define RVALUE_UNCOLLECTIBLE_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(obj), (obj))
1398#define RVALUE_PINNED_BITMAP(obj) MARKED_IN_BITMAP(GET_HEAP_PINNED_BITS(obj), (obj))
1399
1400static inline int
1401RVALUE_MARKED(rb_objspace_t *objspace, VALUE obj)
1402{
1403 check_rvalue_consistency(objspace, obj);
1404 return RVALUE_MARKED_BITMAP(obj) != 0;
1405}
1406
1407static inline int
1408RVALUE_PINNED(rb_objspace_t *objspace, VALUE obj)
1409{
1410 check_rvalue_consistency(objspace, obj);
1411 return RVALUE_PINNED_BITMAP(obj) != 0;
1412}
1413
1414static inline int
1415RVALUE_WB_UNPROTECTED(rb_objspace_t *objspace, VALUE obj)
1416{
1417 check_rvalue_consistency(objspace, obj);
1418 return RVALUE_WB_UNPROTECTED_BITMAP(obj) != 0;
1419}
1420
1421static inline int
1422RVALUE_MARKING(rb_objspace_t *objspace, VALUE obj)
1423{
1424 check_rvalue_consistency(objspace, obj);
1425 return RVALUE_MARKING_BITMAP(obj) != 0;
1426}
1427
1428static inline int
1429RVALUE_REMEMBERED(rb_objspace_t *objspace, VALUE obj)
1430{
1431 check_rvalue_consistency(objspace, obj);
1432 return MARKED_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj) != 0;
1433}
1434
1435static inline int
1436RVALUE_UNCOLLECTIBLE(rb_objspace_t *objspace, VALUE obj)
1437{
1438 check_rvalue_consistency(objspace, obj);
1439 return RVALUE_UNCOLLECTIBLE_BITMAP(obj) != 0;
1440}
1441
1442#define RVALUE_PAGE_WB_UNPROTECTED(page, obj) MARKED_IN_BITMAP((page)->wb_unprotected_bits, (obj))
1443#define RVALUE_PAGE_UNCOLLECTIBLE(page, obj) MARKED_IN_BITMAP((page)->uncollectible_bits, (obj))
1444#define RVALUE_PAGE_MARKING(page, obj) MARKED_IN_BITMAP((page)->marking_bits, (obj))
1445
1446static int rgengc_remember(rb_objspace_t *objspace, VALUE obj);
1447static void rgengc_mark_and_rememberset_clear(rb_objspace_t *objspace, rb_heap_t *heap);
1448static void rgengc_rememberset_mark(rb_objspace_t *objspace, rb_heap_t *heap);
1449
1450static int
1451check_rvalue_consistency_force(rb_objspace_t *objspace, const VALUE obj, int terminate)
1452{
1453 int err = 0;
1454
1455 int lev = RB_GC_VM_LOCK_NO_BARRIER();
1456 {
1457 if (SPECIAL_CONST_P(obj)) {
1458 fprintf(stderr, "check_rvalue_consistency: %p is a special const.\n", (void *)obj);
1459 err++;
1460 }
1461 else if (!is_pointer_to_heap(objspace, (void *)obj)) {
1462 struct heap_page *empty_page = objspace->empty_pages;
1463 while (empty_page) {
1464 if ((uintptr_t)empty_page->body <= (uintptr_t)obj &&
1465 (uintptr_t)obj < (uintptr_t)empty_page->body + HEAP_PAGE_SIZE) {
1466 GC_ASSERT(heap_page_in_global_empty_pages_pool(objspace, empty_page));
1467 fprintf(stderr, "check_rvalue_consistency: %p is in an empty page (%p).\n",
1468 (void *)obj, (void *)empty_page);
1469 err++;
1470 goto skip;
1471 }
1472 }
1473 fprintf(stderr, "check_rvalue_consistency: %p is not a Ruby object.\n", (void *)obj);
1474 err++;
1475 skip:
1476 ;
1477 }
1478 else {
1479 const int wb_unprotected_bit = RVALUE_WB_UNPROTECTED_BITMAP(obj) != 0;
1480 const int uncollectible_bit = RVALUE_UNCOLLECTIBLE_BITMAP(obj) != 0;
1481 const int mark_bit = RVALUE_MARKED_BITMAP(obj) != 0;
1482 const int marking_bit = RVALUE_MARKING_BITMAP(obj) != 0;
1483 const int remembered_bit = MARKED_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj) != 0;
1484 const int age = RVALUE_AGE_GET((VALUE)obj);
1485
1486 if (heap_page_in_global_empty_pages_pool(objspace, GET_HEAP_PAGE(obj))) {
1487 fprintf(stderr, "check_rvalue_consistency: %s is in tomb page.\n", rb_obj_info(obj));
1488 err++;
1489 }
1490 if (BUILTIN_TYPE(obj) == T_NONE) {
1491 fprintf(stderr, "check_rvalue_consistency: %s is T_NONE.\n", rb_obj_info(obj));
1492 err++;
1493 }
1494 if (BUILTIN_TYPE(obj) == T_ZOMBIE) {
1495 fprintf(stderr, "check_rvalue_consistency: %s is T_ZOMBIE.\n", rb_obj_info(obj));
1496 err++;
1497 }
1498
1499 if (BUILTIN_TYPE(obj) != T_DATA) {
1500 rb_obj_memsize_of((VALUE)obj);
1501 }
1502
1503 /* check generation
1504 *
1505 * OLD == age == 3 && old-bitmap && mark-bit (except incremental marking)
1506 */
1507 if (age > 0 && wb_unprotected_bit) {
1508 fprintf(stderr, "check_rvalue_consistency: %s is not WB protected, but age is %d > 0.\n", rb_obj_info(obj), age);
1509 err++;
1510 }
1511
1512 if (!is_marking(objspace) && uncollectible_bit && !mark_bit) {
1513 fprintf(stderr, "check_rvalue_consistency: %s is uncollectible, but is not marked while !gc.\n", rb_obj_info(obj));
1514 err++;
1515 }
1516
1517 if (!is_full_marking(objspace)) {
1518 if (uncollectible_bit && age != RVALUE_OLD_AGE && !wb_unprotected_bit) {
1519 fprintf(stderr, "check_rvalue_consistency: %s is uncollectible, but not old (age: %d) and not WB unprotected.\n",
1520 rb_obj_info(obj), age);
1521 err++;
1522 }
1523 if (remembered_bit && age != RVALUE_OLD_AGE) {
1524 fprintf(stderr, "check_rvalue_consistency: %s is remembered, but not old (age: %d).\n",
1525 rb_obj_info(obj), age);
1526 err++;
1527 }
1528 }
1529
1530 /*
1531 * check coloring
1532 *
1533 * marking:false marking:true
1534 * marked:false white *invalid*
1535 * marked:true black grey
1536 */
1537 if (is_incremental_marking(objspace) && marking_bit) {
1538 if (!is_marking(objspace) && !mark_bit) {
1539 fprintf(stderr, "check_rvalue_consistency: %s is marking, but not marked.\n", rb_obj_info(obj));
1540 err++;
1541 }
1542 }
1543 }
1544 }
1545 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
1546
1547 if (err > 0 && terminate) {
1548 rb_bug("check_rvalue_consistency_force: there is %d errors.", err);
1549 }
1550 return err;
1551}
1552
1553#if RGENGC_CHECK_MODE == 0
1554static inline VALUE
1555check_rvalue_consistency(rb_objspace_t *objspace, const VALUE obj)
1556{
1557 return obj;
1558}
1559#else
1560static VALUE
1561check_rvalue_consistency(rb_objspace_t *objspace, const VALUE obj)
1562{
1563 check_rvalue_consistency_force(objspace, obj, TRUE);
1564 return obj;
1565}
1566#endif
1567
1568static inline bool
1569gc_object_moved_p(rb_objspace_t *objspace, VALUE obj)
1570{
1571
1572 bool ret;
1573 asan_unpoisoning_object(obj) {
1574 ret = BUILTIN_TYPE(obj) == T_MOVED;
1575 }
1576 return ret;
1577}
1578
1579static inline int
1580RVALUE_OLD_P(rb_objspace_t *objspace, VALUE obj)
1581{
1582 GC_ASSERT(!RB_SPECIAL_CONST_P(obj));
1583 check_rvalue_consistency(objspace, obj);
1584 // Because this will only ever be called on GC controlled objects,
1585 // we can use the faster _RAW function here
1586 return RB_OBJ_PROMOTED_RAW(obj);
1587}
1588
1589static inline void
1590RVALUE_PAGE_OLD_UNCOLLECTIBLE_SET(rb_objspace_t *objspace, struct heap_page *page, VALUE obj)
1591{
1592 MARK_IN_BITMAP(&page->uncollectible_bits[0], obj);
1593 objspace->rgengc.old_objects++;
1594
1595#if RGENGC_PROFILE >= 2
1596 objspace->profile.total_promoted_count++;
1597 objspace->profile.promoted_types[BUILTIN_TYPE(obj)]++;
1598#endif
1599}
1600
1601static inline void
1602RVALUE_OLD_UNCOLLECTIBLE_SET(rb_objspace_t *objspace, VALUE obj)
1603{
1604 RB_DEBUG_COUNTER_INC(obj_promote);
1605 RVALUE_PAGE_OLD_UNCOLLECTIBLE_SET(objspace, GET_HEAP_PAGE(obj), obj);
1606}
1607
1608/* set age to age+1 */
1609static inline void
1610RVALUE_AGE_INC(rb_objspace_t *objspace, VALUE obj)
1611{
1612 int age = RVALUE_AGE_GET((VALUE)obj);
1613
1614 if (RGENGC_CHECK_MODE && age == RVALUE_OLD_AGE) {
1615 rb_bug("RVALUE_AGE_INC: can not increment age of OLD object %s.", rb_obj_info(obj));
1616 }
1617
1618 age++;
1619 RVALUE_AGE_SET(obj, age);
1620
1621 if (age == RVALUE_OLD_AGE) {
1622 RVALUE_OLD_UNCOLLECTIBLE_SET(objspace, obj);
1623 }
1624
1625 check_rvalue_consistency(objspace, obj);
1626}
1627
1628static inline void
1629RVALUE_AGE_SET_CANDIDATE(rb_objspace_t *objspace, VALUE obj)
1630{
1631 check_rvalue_consistency(objspace, obj);
1632 GC_ASSERT(!RVALUE_OLD_P(objspace, obj));
1633 RVALUE_AGE_SET(obj, RVALUE_OLD_AGE - 1);
1634 check_rvalue_consistency(objspace, obj);
1635}
1636
1637static inline void
1638RVALUE_AGE_RESET(VALUE obj)
1639{
1640 RVALUE_AGE_SET(obj, 0);
1641}
1642
1643static inline void
1644RVALUE_DEMOTE(rb_objspace_t *objspace, VALUE obj)
1645{
1646 check_rvalue_consistency(objspace, obj);
1647 GC_ASSERT(RVALUE_OLD_P(objspace, obj));
1648
1649 if (!is_incremental_marking(objspace) && RVALUE_REMEMBERED(objspace, obj)) {
1650 CLEAR_IN_BITMAP(GET_HEAP_PAGE(obj)->remembered_bits, obj);
1651 }
1652
1653 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(obj), obj);
1654 RVALUE_AGE_RESET(obj);
1655
1656 if (RVALUE_MARKED(objspace, obj)) {
1657 objspace->rgengc.old_objects--;
1658 }
1659
1660 check_rvalue_consistency(objspace, obj);
1661}
1662
1663static inline int
1664RVALUE_BLACK_P(rb_objspace_t *objspace, VALUE obj)
1665{
1666 return RVALUE_MARKED(objspace, obj) && !RVALUE_MARKING(objspace, obj);
1667}
1668
1669static inline int
1670RVALUE_WHITE_P(rb_objspace_t *objspace, VALUE obj)
1671{
1672 return !RVALUE_MARKED(objspace, obj);
1673}
1674
1675bool
1676rb_gc_impl_gc_enabled_p(void *objspace_ptr)
1677{
1678 rb_objspace_t *objspace = objspace_ptr;
1679 return !dont_gc_val();
1680}
1681
1682void
1683rb_gc_impl_gc_enable(void *objspace_ptr)
1684{
1685 rb_objspace_t *objspace = objspace_ptr;
1686
1687 dont_gc_off();
1688}
1689
1690void
1691rb_gc_impl_gc_disable(void *objspace_ptr, bool finish_current_gc)
1692{
1693 rb_objspace_t *objspace = objspace_ptr;
1694
1695 if (finish_current_gc) {
1696 gc_rest(objspace);
1697 }
1698
1699 dont_gc_on();
1700}
1701
1702/*
1703 --------------------------- ObjectSpace -----------------------------
1704*/
1705
1706static inline void *
1707calloc1(size_t n)
1708{
1709 return calloc(1, n);
1710}
1711
1712void
1713rb_gc_impl_set_event_hook(void *objspace_ptr, const rb_event_flag_t event)
1714{
1715 rb_objspace_t *objspace = objspace_ptr;
1716 objspace->hook_events = event & RUBY_INTERNAL_EVENT_OBJSPACE_MASK;
1717}
1718
1719unsigned long long
1720rb_gc_impl_get_total_time(void *objspace_ptr)
1721{
1722 rb_objspace_t *objspace = objspace_ptr;
1723
1724 unsigned long long marking_time = objspace->profile.marking_time_ns;
1725 unsigned long long sweeping_time = objspace->profile.sweeping_time_ns;
1726
1727 return marking_time + sweeping_time;
1728}
1729
1730void
1731rb_gc_impl_set_measure_total_time(void *objspace_ptr, VALUE flag)
1732{
1733 rb_objspace_t *objspace = objspace_ptr;
1734
1735 objspace->flags.measure_gc = RTEST(flag) ? TRUE : FALSE;
1736}
1737
1738bool
1739rb_gc_impl_get_measure_total_time(void *objspace_ptr)
1740{
1741 rb_objspace_t *objspace = objspace_ptr;
1742
1743 return objspace->flags.measure_gc;
1744}
1745
1746/* garbage objects will be collected soon. */
1747bool
1748rb_gc_impl_garbage_object_p(void *objspace_ptr, VALUE ptr)
1749{
1750 rb_objspace_t *objspace = objspace_ptr;
1751
1752 bool dead = false;
1753
1754 asan_unpoisoning_object(ptr) {
1755 switch (BUILTIN_TYPE(ptr)) {
1756 case T_NONE:
1757 case T_MOVED:
1758 case T_ZOMBIE:
1759 dead = true;
1760 break;
1761 default:
1762 break;
1763 }
1764 }
1765
1766 if (dead) return true;
1767 return is_lazy_sweeping(objspace) && GET_HEAP_PAGE(ptr)->flags.before_sweep &&
1768 !RVALUE_MARKED(objspace, ptr);
1769}
1770
1771struct rb_gc_vm_context *
1772rb_gc_impl_get_vm_context(void *objspace_ptr)
1773{
1774 rb_objspace_t *objspace = objspace_ptr;
1775
1776 return &objspace->vm_context;
1777}
1778
1779static void free_stack_chunks(mark_stack_t *);
1780static void mark_stack_free_cache(mark_stack_t *);
1781static void heap_page_free(rb_objspace_t *objspace, struct heap_page *page);
1782
1783static inline void
1784heap_page_add_freeobj(rb_objspace_t *objspace, struct heap_page *page, VALUE obj)
1785{
1786 rb_asan_unpoison_object(obj, false);
1787
1788 asan_unlock_freelist(page);
1789
1790 struct free_slot *slot = (struct free_slot *)obj;
1791 slot->flags = 0;
1792 slot->next = page->freelist;
1793 page->freelist = slot;
1794 asan_lock_freelist(page);
1795
1796 // Should have already been reset
1797 GC_ASSERT(RVALUE_AGE_GET(obj) == 0);
1798
1799 if (RGENGC_CHECK_MODE &&
1800 /* obj should belong to page */
1801 !(page->start <= (uintptr_t)obj &&
1802 (uintptr_t)obj < ((uintptr_t)page->start + (page->total_slots * page->slot_size)) &&
1803 obj % sizeof(VALUE) == 0)) {
1804 rb_bug("heap_page_add_freeobj: %p is not rvalue.", (void *)obj);
1805 }
1806
1807 rb_asan_poison_object(obj);
1808 gc_report(3, objspace, "heap_page_add_freeobj: add %p to freelist\n", (void *)obj);
1809}
1810
1811static void
1812heap_allocatable_bytes_expand(rb_objspace_t *objspace,
1813 rb_heap_t *heap, size_t free_slots, size_t total_slots, size_t slot_size)
1814{
1815 double goal_ratio = gc_params.heap_free_slots_goal_ratio;
1816 size_t target_total_slots;
1817
1818 if (goal_ratio == 0.0) {
1819 target_total_slots = (size_t)(total_slots * gc_params.growth_factor);
1820 }
1821 else if (total_slots == 0) {
1822 target_total_slots = gc_params.heap_init_bytes / slot_size;
1823 }
1824 else {
1825 /* Find `f' where free_slots = f * total_slots * goal_ratio
1826 * => f = (total_slots - free_slots) / ((1 - goal_ratio) * total_slots)
1827 */
1828 double f = (double)(total_slots - free_slots) / ((1 - goal_ratio) * total_slots);
1829
1830 if (f > gc_params.growth_factor) f = gc_params.growth_factor;
1831 if (f < 1.0) f = 1.1;
1832
1833 target_total_slots = (size_t)(f * total_slots);
1834
1835 if (0) {
1836 fprintf(stderr,
1837 "free_slots(%8"PRIuSIZE")/total_slots(%8"PRIuSIZE")=%1.2f,"
1838 " G(%1.2f), f(%1.2f),"
1839 " total_slots(%8"PRIuSIZE") => target_total_slots(%8"PRIuSIZE")\n",
1840 free_slots, total_slots, free_slots/(double)total_slots,
1841 goal_ratio, f, total_slots, target_total_slots);
1842 }
1843 }
1844
1845 if (gc_params.growth_max_bytes > 0) {
1846 size_t max_total_slots = total_slots + gc_params.growth_max_bytes / slot_size;
1847 if (target_total_slots > max_total_slots) target_total_slots = max_total_slots;
1848 }
1849
1850 size_t extend_slot_count = target_total_slots - total_slots;
1851 /* Extend by at least 1 page. */
1852 if (extend_slot_count == 0) extend_slot_count = 1;
1853
1854 objspace->heap_pages.allocatable_bytes += extend_slot_count * slot_size;
1855}
1856
1857static inline void
1858heap_add_freepage(rb_heap_t *heap, struct heap_page *page)
1859{
1860 asan_unlock_freelist(page);
1861 GC_ASSERT(page->free_slots != 0);
1862 GC_ASSERT(page->freelist != NULL);
1863
1864 page->free_next = heap->free_pages;
1865 heap->free_pages = page;
1866
1867 RUBY_DEBUG_LOG("page:%p freelist:%p", (void *)page, (void *)page->freelist);
1868
1869 asan_lock_freelist(page);
1870}
1871
1872static inline void
1873heap_add_poolpage(rb_objspace_t *objspace, rb_heap_t *heap, struct heap_page *page)
1874{
1875 asan_unlock_freelist(page);
1876 GC_ASSERT(page->free_slots != 0);
1877 GC_ASSERT(page->freelist != NULL);
1878
1879 page->free_next = heap->pooled_pages;
1880 heap->pooled_pages = page;
1881 objspace->rincgc.pooled_slots += page->free_slots;
1882
1883 asan_lock_freelist(page);
1884}
1885
1886static void
1887heap_unlink_page(rb_objspace_t *objspace, rb_heap_t *heap, struct heap_page *page)
1888{
1889 ccan_list_del(&page->page_node);
1890 heap->total_pages--;
1891 heap->total_slots -= page->total_slots;
1892}
1893
1894static void
1895gc_aligned_free(void *ptr, size_t size)
1896{
1897#if defined __MINGW32__
1898 __mingw_aligned_free(ptr);
1899#elif defined _WIN32
1900 _aligned_free(ptr);
1901#elif defined(HAVE_POSIX_MEMALIGN) || defined(HAVE_MEMALIGN)
1902 free(ptr);
1903#else
1904 free(((void**)ptr)[-1]);
1905#endif
1906}
1907
1908static void
1909heap_page_body_free(struct heap_page_body *page_body)
1910{
1911 GC_ASSERT((uintptr_t)page_body % HEAP_PAGE_ALIGN == 0);
1912
1913 if (HEAP_PAGE_ALLOC_USE_MMAP) {
1914#ifdef HAVE_MMAP
1915 GC_ASSERT(HEAP_PAGE_SIZE % sysconf(_SC_PAGE_SIZE) == 0);
1916 if (munmap(page_body, HEAP_PAGE_SIZE)) {
1917 rb_bug("heap_page_body_free: munmap failed");
1918 }
1919#endif
1920 }
1921 else {
1922 gc_aligned_free(page_body, HEAP_PAGE_SIZE);
1923 }
1924}
1925
1926static void
1927heap_page_free(rb_objspace_t *objspace, struct heap_page *page)
1928{
1929 objspace->heap_pages.freed_pages++;
1930 heap_page_body_free(page->body);
1931 free(page);
1932}
1933
1934static void
1935heap_pages_free_unused_pages(rb_objspace_t *objspace)
1936{
1937 if (objspace->empty_pages != NULL && heap_pages_freeable_pages > 0) {
1938 GC_ASSERT(objspace->empty_pages_count > 0);
1939 objspace->empty_pages = NULL;
1940 objspace->empty_pages_count = 0;
1941
1942 size_t i, j;
1943 for (i = j = 0; i < rb_darray_size(objspace->heap_pages.sorted); i++) {
1944 struct heap_page *page = rb_darray_get(objspace->heap_pages.sorted, i);
1945
1946 if (heap_page_in_global_empty_pages_pool(objspace, page) && heap_pages_freeable_pages > 0) {
1947 heap_page_free(objspace, page);
1948 heap_pages_freeable_pages--;
1949 }
1950 else {
1951 if (heap_page_in_global_empty_pages_pool(objspace, page)) {
1952 page->free_next = objspace->empty_pages;
1953 objspace->empty_pages = page;
1954 objspace->empty_pages_count++;
1955 }
1956
1957 if (i != j) {
1958 rb_darray_set(objspace->heap_pages.sorted, j, page);
1959 }
1960 j++;
1961 }
1962 }
1963
1964 rb_darray_pop(objspace->heap_pages.sorted, i - j);
1965 GC_ASSERT(rb_darray_size(objspace->heap_pages.sorted) == j);
1966
1967 struct heap_page *hipage = rb_darray_get(objspace->heap_pages.sorted, rb_darray_size(objspace->heap_pages.sorted) - 1);
1968 uintptr_t himem = (uintptr_t)hipage->body + HEAP_PAGE_SIZE;
1969 GC_ASSERT(himem <= heap_pages_himem);
1970 heap_pages_himem = himem;
1971
1972 struct heap_page *lopage = rb_darray_get(objspace->heap_pages.sorted, 0);
1973 uintptr_t lomem = (uintptr_t)lopage->body + sizeof(struct heap_page_header);
1974 GC_ASSERT(lomem >= heap_pages_lomem);
1975 heap_pages_lomem = lomem;
1976 }
1977}
1978
1979static void *
1980gc_aligned_malloc(size_t alignment, size_t size)
1981{
1982 /* alignment must be a power of 2 */
1983 GC_ASSERT(((alignment - 1) & alignment) == 0);
1984 GC_ASSERT(alignment % sizeof(void*) == 0);
1985
1986 void *res;
1987
1988#if defined __MINGW32__
1989 res = __mingw_aligned_malloc(size, alignment);
1990#elif defined _WIN32
1991 void *_aligned_malloc(size_t, size_t);
1992 res = _aligned_malloc(size, alignment);
1993#elif defined(HAVE_POSIX_MEMALIGN)
1994 if (posix_memalign(&res, alignment, size) != 0) {
1995 return NULL;
1996 }
1997#elif defined(HAVE_MEMALIGN)
1998 res = memalign(alignment, size);
1999#else
2000 char* aligned;
2001 res = malloc(alignment + size + sizeof(void*));
2002 aligned = (char*)res + alignment + sizeof(void*);
2003 aligned -= ((VALUE)aligned & (alignment - 1));
2004 ((void**)aligned)[-1] = res;
2005 res = (void*)aligned;
2006#endif
2007
2008 GC_ASSERT((uintptr_t)res % alignment == 0);
2009
2010 return res;
2011}
2012
2013static struct heap_page_body *
2014heap_page_body_allocate(void)
2015{
2016 struct heap_page_body *page_body;
2017
2018 if (HEAP_PAGE_ALLOC_USE_MMAP) {
2019#ifdef HAVE_MMAP
2020 GC_ASSERT(HEAP_PAGE_ALIGN % sysconf(_SC_PAGE_SIZE) == 0);
2021
2022 size_t mmap_size = HEAP_PAGE_ALIGN + HEAP_PAGE_SIZE;
2023 char *ptr = mmap(NULL, mmap_size,
2024 PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
2025 if (ptr == MAP_FAILED) {
2026 return NULL;
2027 }
2028
2029 // If we are building `default.c` as part of the ruby executable, we
2030 // may just call `ruby_annotate_mmap`. But if we are building
2031 // `default.c` as a shared library, we will not have access to private
2032 // symbols, and we have to either call prctl directly or make our own
2033 // wrapper.
2034#if defined(HAVE_SYS_PRCTL_H) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
2035 prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME, ptr, mmap_size, "Ruby:GC:default:heap_page_body_allocate");
2036 errno = 0;
2037#endif
2038
2039 char *aligned = ptr + HEAP_PAGE_ALIGN;
2040 aligned -= ((VALUE)aligned & (HEAP_PAGE_ALIGN - 1));
2041 GC_ASSERT(aligned > ptr);
2042 GC_ASSERT(aligned <= ptr + HEAP_PAGE_ALIGN);
2043
2044 size_t start_out_of_range_size = aligned - ptr;
2045 GC_ASSERT(start_out_of_range_size % sysconf(_SC_PAGE_SIZE) == 0);
2046 if (start_out_of_range_size > 0) {
2047 if (munmap(ptr, start_out_of_range_size)) {
2048 rb_bug("heap_page_body_allocate: munmap failed for start");
2049 }
2050 }
2051
2052 size_t end_out_of_range_size = HEAP_PAGE_ALIGN - start_out_of_range_size;
2053 GC_ASSERT(end_out_of_range_size % sysconf(_SC_PAGE_SIZE) == 0);
2054 if (end_out_of_range_size > 0) {
2055 if (munmap(aligned + HEAP_PAGE_SIZE, end_out_of_range_size)) {
2056 rb_bug("heap_page_body_allocate: munmap failed for end");
2057 }
2058 }
2059
2060 page_body = (struct heap_page_body *)aligned;
2061#endif
2062 }
2063 else {
2064 page_body = gc_aligned_malloc(HEAP_PAGE_ALIGN, HEAP_PAGE_SIZE);
2065 }
2066
2067 GC_ASSERT((uintptr_t)page_body % HEAP_PAGE_ALIGN == 0);
2068
2069 return page_body;
2070}
2071
2072static struct heap_page *
2073heap_page_resurrect(rb_objspace_t *objspace)
2074{
2075 struct heap_page *page = NULL;
2076 if (objspace->empty_pages == NULL) {
2077 GC_ASSERT(objspace->empty_pages_count == 0);
2078 }
2079 else {
2080 GC_ASSERT(objspace->empty_pages_count > 0);
2081 objspace->empty_pages_count--;
2082 page = objspace->empty_pages;
2083 objspace->empty_pages = page->free_next;
2084 }
2085
2086 return page;
2087}
2088
2089static struct heap_page *
2090heap_page_allocate(rb_objspace_t *objspace)
2091{
2092 struct heap_page_body *page_body = heap_page_body_allocate();
2093 if (page_body == 0) {
2094 rb_memerror();
2095 }
2096
2097 struct heap_page *page = calloc1(sizeof(struct heap_page));
2098 if (page == 0) {
2099 heap_page_body_free(page_body);
2100 rb_memerror();
2101 }
2102
2103 uintptr_t start = (uintptr_t)page_body + sizeof(struct heap_page_header);
2104 uintptr_t end = (uintptr_t)page_body + HEAP_PAGE_SIZE;
2105
2106 size_t lo = 0;
2107 size_t hi = rb_darray_size(objspace->heap_pages.sorted);
2108 while (lo < hi) {
2109 struct heap_page *mid_page;
2110
2111 size_t mid = (lo + hi) / 2;
2112 mid_page = rb_darray_get(objspace->heap_pages.sorted, mid);
2113 if ((uintptr_t)mid_page->start < start) {
2114 lo = mid + 1;
2115 }
2116 else if ((uintptr_t)mid_page->start > start) {
2117 hi = mid;
2118 }
2119 else {
2120 rb_bug("same heap page is allocated: %p at %"PRIuVALUE, (void *)page_body, (VALUE)mid);
2121 }
2122 }
2123
2124 rb_darray_insert_without_gc(&objspace->heap_pages.sorted, hi, page);
2125
2126 if (heap_pages_lomem == 0 || heap_pages_lomem > start) heap_pages_lomem = start;
2127 if (heap_pages_himem < end) heap_pages_himem = end;
2128
2129 page->body = page_body;
2130 page_body->header.page = page;
2131
2132 objspace->heap_pages.allocated_pages++;
2133
2134 return page;
2135}
2136
2137static void
2138heap_add_page(rb_objspace_t *objspace, rb_heap_t *heap, struct heap_page *page)
2139{
2140 /* Adding to eden heap during incremental sweeping is forbidden */
2141 GC_ASSERT(!heap->sweeping_page);
2142 GC_ASSERT(heap_page_in_global_empty_pages_pool(objspace, page));
2143
2144 /* Align start to slot_size boundary */
2145 uintptr_t start = (uintptr_t)page->body + sizeof(struct heap_page_header);
2146 uintptr_t rem = start % heap->slot_size;
2147 if (rem) start += heap->slot_size - rem;
2148
2149 int slot_count = (int)((HEAP_PAGE_SIZE - (start - (uintptr_t)page->body))/heap->slot_size);
2150
2151 page->start = start;
2152 page->total_slots = slot_count;
2153 page->slot_size = heap->slot_size;
2154 page->slot_size_reciprocal = heap_slot_reciprocal_table[heap - heaps];
2155 page->heap = heap;
2156
2157 memset(&page->wb_unprotected_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
2158 memset(&page->age_bits[0], 0, sizeof(page->age_bits));
2159
2160 asan_unlock_freelist(page);
2161 page->freelist = NULL;
2162 asan_unpoison_memory_region(page->body, HEAP_PAGE_SIZE, false);
2163 for (VALUE p = (VALUE)start; p < start + (slot_count * heap->slot_size); p += heap->slot_size) {
2164 heap_page_add_freeobj(objspace, page, p);
2165 }
2166 asan_lock_freelist(page);
2167
2168 page->free_slots = slot_count;
2169
2170 heap->total_allocated_pages++;
2171
2172 ccan_list_add_tail(&heap->pages, &page->page_node);
2173 heap->total_pages++;
2174 heap->total_slots += page->total_slots;
2175}
2176
2177static int
2178heap_page_allocate_and_initialize(rb_objspace_t *objspace, rb_heap_t *heap)
2179{
2180 gc_report(1, objspace, "heap_page_allocate_and_initialize: rb_darray_size(objspace->heap_pages.sorted): %"PRIdSIZE", "
2181 "allocatable_bytes: %"PRIdSIZE", heap->total_pages: %"PRIdSIZE"\n",
2182 rb_darray_size(objspace->heap_pages.sorted), objspace->heap_pages.allocatable_bytes, heap->total_pages);
2183
2184 bool allocated = false;
2185 struct heap_page *page = heap_page_resurrect(objspace);
2186
2187 if (page == NULL && objspace->heap_pages.allocatable_bytes > 0) {
2188 page = heap_page_allocate(objspace);
2189 allocated = true;
2190
2191 GC_ASSERT(page != NULL);
2192 }
2193
2194 if (page != NULL) {
2195 heap_add_page(objspace, heap, page);
2196 heap_add_freepage(heap, page);
2197
2198 if (allocated) {
2199 size_t page_bytes = (size_t)page->total_slots * page->slot_size;
2200 if (objspace->heap_pages.allocatable_bytes > page_bytes) {
2201 objspace->heap_pages.allocatable_bytes -= page_bytes;
2202 }
2203 else {
2204 objspace->heap_pages.allocatable_bytes = 0;
2205 }
2206 }
2207 }
2208
2209 return page != NULL;
2210}
2211
2212static void
2213heap_page_allocate_and_initialize_force(rb_objspace_t *objspace, rb_heap_t *heap)
2214{
2215 size_t prev_allocatable_bytes = objspace->heap_pages.allocatable_bytes;
2216 objspace->heap_pages.allocatable_bytes = HEAP_PAGE_SIZE;
2217 heap_page_allocate_and_initialize(objspace, heap);
2218 GC_ASSERT(heap->free_pages != NULL);
2219 objspace->heap_pages.allocatable_bytes = prev_allocatable_bytes;
2220}
2221
2222static void
2223gc_continue(rb_objspace_t *objspace, rb_heap_t *heap)
2224{
2225 unsigned int lock_lev;
2226 bool needs_gc = is_incremental_marking(objspace) || needs_continue_sweeping(objspace, heap);
2227 if (!needs_gc) return;
2228
2229 gc_enter(objspace, gc_enter_event_continue, &lock_lev); // takes vm barrier, try to avoid
2230
2231 /* Continue marking if in incremental marking. */
2232 if (is_incremental_marking(objspace)) {
2233 if (gc_marks_continue(objspace, heap)) {
2234 gc_sweep(objspace);
2235 }
2236 }
2237
2238 if (needs_continue_sweeping(objspace, heap)) {
2239 gc_sweep_continue(objspace, heap);
2240 }
2241
2242 gc_exit(objspace, gc_enter_event_continue, &lock_lev);
2243}
2244
2245static void
2246heap_prepare(rb_objspace_t *objspace, rb_heap_t *heap)
2247{
2248 GC_ASSERT(heap->free_pages == NULL);
2249
2250 if (heap->total_slots < gc_params.heap_init_bytes / heap->slot_size &&
2251 heap->sweeping_page == NULL) {
2252 heap_page_allocate_and_initialize_force(objspace, heap);
2253 GC_ASSERT(heap->free_pages != NULL);
2254 return;
2255 }
2256
2257 /* Continue incremental marking or lazy sweeping, if in any of those steps. */
2258 gc_continue(objspace, heap);
2259
2260 if (heap->free_pages == NULL) {
2261 heap_page_allocate_and_initialize(objspace, heap);
2262 }
2263
2264 /* If we still don't have a free page and not allowed to create a new page,
2265 * we should start a new GC cycle. */
2266 if (heap->free_pages == NULL) {
2267 GC_ASSERT(objspace->empty_pages_count == 0);
2268 GC_ASSERT(objspace->heap_pages.allocatable_bytes == 0);
2269
2270 if (gc_start(objspace, GPR_FLAG_NEWOBJ) == FALSE) {
2271 rb_memerror();
2272 }
2273 else {
2274 if (objspace->heap_pages.allocatable_bytes == 0 && !gc_config_full_mark_val) {
2275 heap_allocatable_bytes_expand(objspace, heap,
2276 heap->freed_slots + heap->empty_slots,
2277 heap->total_slots, heap->slot_size);
2278 GC_ASSERT(objspace->heap_pages.allocatable_bytes > 0);
2279 }
2280 /* Do steps of incremental marking or lazy sweeping if the GC run permits. */
2281 gc_continue(objspace, heap);
2282
2283 /* If we're not incremental marking (e.g. a minor GC) or finished
2284 * sweeping and still don't have a free page, then
2285 * gc_sweep_finish_heap should allow us to create a new page. */
2286 if (heap->free_pages == NULL && !heap_page_allocate_and_initialize(objspace, heap)) {
2287 if (gc_needs_major_flags == GPR_FLAG_NONE) {
2288 rb_bug("cannot create a new page after GC");
2289 }
2290 else { // Major GC is required, which will allow us to create new page
2291 if (gc_start(objspace, GPR_FLAG_NEWOBJ) == FALSE) {
2292 rb_memerror();
2293 }
2294 else {
2295 /* Do steps of incremental marking or lazy sweeping. */
2296 gc_continue(objspace, heap);
2297
2298 if (heap->free_pages == NULL &&
2299 !heap_page_allocate_and_initialize(objspace, heap)) {
2300 rb_bug("cannot create a new page after major GC");
2301 }
2302 }
2303 }
2304 }
2305 }
2306 }
2307
2308 GC_ASSERT(heap->free_pages != NULL);
2309}
2310
2311#if GC_DEBUG
2312static inline const char*
2313rb_gc_impl_source_location_cstr(int *ptr)
2314{
2315 /* We could directly refer `rb_source_location_cstr()` before, but not any
2316 * longer. We have to heavy lift using our debugging API. */
2317 if (! ptr) {
2318 return NULL;
2319 }
2320 else if (! (*ptr = rb_sourceline())) {
2321 return NULL;
2322 }
2323 else {
2324 return rb_sourcefile();
2325 }
2326}
2327#endif
2328
2329static inline VALUE
2330newobj_init(VALUE klass, VALUE flags, int wb_protected, rb_objspace_t *objspace, VALUE obj)
2331{
2332 GC_ASSERT(BUILTIN_TYPE(obj) == T_NONE);
2333 GC_ASSERT((flags & FL_WB_PROTECTED) == 0);
2334 RBASIC(obj)->flags = flags;
2335 *((VALUE *)&RBASIC(obj)->klass) = klass;
2336#if RBASIC_SHAPE_ID_FIELD
2337 RBASIC(obj)->shape_id = 0;
2338#endif
2339
2340#if RGENGC_CHECK_MODE
2341 int lev = RB_GC_VM_LOCK_NO_BARRIER();
2342 {
2343 check_rvalue_consistency(objspace, obj);
2344
2345 GC_ASSERT(RVALUE_MARKED(objspace, obj) == FALSE);
2346 GC_ASSERT(RVALUE_MARKING(objspace, obj) == FALSE);
2347 GC_ASSERT(RVALUE_OLD_P(objspace, obj) == FALSE);
2348 GC_ASSERT(RVALUE_WB_UNPROTECTED(objspace, obj) == FALSE);
2349
2350 if (RVALUE_REMEMBERED(objspace, obj)) rb_bug("newobj: %s is remembered.", rb_obj_info(obj));
2351 }
2352 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
2353#endif
2354
2355 if (RB_UNLIKELY(wb_protected == FALSE)) {
2356 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), obj);
2357 }
2358
2359#if RGENGC_PROFILE
2360 if (wb_protected) {
2361 objspace->profile.total_generated_normal_object_count++;
2362#if RGENGC_PROFILE >= 2
2363 objspace->profile.generated_normal_object_count_types[BUILTIN_TYPE(obj)]++;
2364#endif
2365 }
2366 else {
2367 objspace->profile.total_generated_shady_object_count++;
2368#if RGENGC_PROFILE >= 2
2369 objspace->profile.generated_shady_object_count_types[BUILTIN_TYPE(obj)]++;
2370#endif
2371 }
2372#endif
2373
2374#if GC_DEBUG
2375 GET_RVALUE_OVERHEAD(obj)->file = rb_gc_impl_source_location_cstr(&GET_RVALUE_OVERHEAD(obj)->line);
2376 GC_ASSERT(!SPECIAL_CONST_P(obj)); /* check alignment */
2377#endif
2378
2379 gc_report(5, objspace, "newobj: %s\n", rb_obj_info(obj));
2380
2381 // RUBY_DEBUG_LOG("obj:%p (%s)", (void *)obj, rb_obj_info(obj));
2382 return obj;
2383}
2384
2385size_t
2386rb_gc_impl_obj_slot_size(VALUE obj)
2387{
2388 return GET_HEAP_PAGE(obj)->slot_size - RVALUE_OVERHEAD;
2389}
2390
2391static inline size_t
2392heap_slot_size(unsigned char pool_id)
2393{
2394 GC_ASSERT(pool_id < HEAP_COUNT);
2395
2396 return pool_slot_sizes[pool_id] - RVALUE_OVERHEAD;
2397}
2398
2399bool
2400rb_gc_impl_size_allocatable_p(size_t size)
2401{
2402 return size + RVALUE_OVERHEAD <= pool_slot_sizes[HEAP_COUNT - 1];
2403}
2404
2405static const size_t ALLOCATED_COUNT_STEP = 1024;
2406static void
2407ractor_cache_flush_count(rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache)
2408{
2409 for (int heap_idx = 0; heap_idx < HEAP_COUNT; heap_idx++) {
2410 rb_ractor_newobj_heap_cache_t *heap_cache = &cache->heap_caches[heap_idx];
2411
2412 rb_heap_t *heap = &heaps[heap_idx];
2413 RUBY_ATOMIC_SIZE_ADD(heap->total_allocated_objects, heap_cache->allocated_objects_count);
2414 heap_cache->allocated_objects_count = 0;
2415 }
2416}
2417
2418static inline VALUE
2419ractor_cache_allocate_slot(rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache,
2420 size_t heap_idx)
2421{
2422 rb_ractor_newobj_heap_cache_t *heap_cache = &cache->heap_caches[heap_idx];
2423 struct free_slot *p = heap_cache->freelist;
2424
2425 if (RB_UNLIKELY(is_incremental_marking(objspace))) {
2426 // Not allowed to allocate without running an incremental marking step
2427 if (cache->incremental_mark_step_allocated_slots >= INCREMENTAL_MARK_STEP_ALLOCATIONS) {
2428 return Qfalse;
2429 }
2430
2431 if (p) {
2432 cache->incremental_mark_step_allocated_slots++;
2433 }
2434 }
2435
2436 if (RB_LIKELY(p)) {
2437 VALUE obj = (VALUE)p;
2438 rb_asan_unpoison_object(obj, true);
2439 heap_cache->freelist = p->next;
2440
2441 heap_cache->allocated_objects_count++;
2442 rb_heap_t *heap = &heaps[heap_idx];
2443 if (heap_cache->allocated_objects_count >= ALLOCATED_COUNT_STEP) {
2444 RUBY_ATOMIC_SIZE_ADD(heap->total_allocated_objects, heap_cache->allocated_objects_count);
2445 heap_cache->allocated_objects_count = 0;
2446 }
2447
2448#if RGENGC_CHECK_MODE
2449 GC_ASSERT(rb_gc_impl_obj_slot_size(obj) == heap_slot_size(heap_idx));
2450 // zero clear
2451 MEMZERO((char *)obj, char, heap_slot_size(heap_idx));
2452#endif
2453 return obj;
2454 }
2455 else {
2456 return Qfalse;
2457 }
2458}
2459
2460static struct heap_page *
2461heap_next_free_page(rb_objspace_t *objspace, rb_heap_t *heap)
2462{
2463 struct heap_page *page;
2464
2465 if (heap->free_pages == NULL) {
2466 heap_prepare(objspace, heap);
2467 }
2468
2469 page = heap->free_pages;
2470 heap->free_pages = page->free_next;
2471
2472 GC_ASSERT(page->free_slots != 0);
2473
2474 asan_unlock_freelist(page);
2475
2476 return page;
2477}
2478
2479static inline void
2480ractor_cache_set_page(rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, size_t heap_idx,
2481 struct heap_page *page)
2482{
2483 gc_report(3, objspace, "ractor_set_cache: Using page %p\n", (void *)page->body);
2484
2485 rb_ractor_newobj_heap_cache_t *heap_cache = &cache->heap_caches[heap_idx];
2486
2487 GC_ASSERT(heap_cache->freelist == NULL);
2488 GC_ASSERT(page->free_slots != 0);
2489 GC_ASSERT(page->freelist != NULL);
2490
2491 heap_cache->using_page = page;
2492 heap_cache->freelist = page->freelist;
2493 page->free_slots = 0;
2494 page->freelist = NULL;
2495
2496 rb_asan_unpoison_object((VALUE)heap_cache->freelist, false);
2497 GC_ASSERT(RB_TYPE_P((VALUE)heap_cache->freelist, T_NONE));
2498 rb_asan_poison_object((VALUE)heap_cache->freelist);
2499}
2500
2501static void
2502init_size_to_heap_idx(void)
2503{
2504 for (size_t i = 0; i < sizeof(size_to_heap_idx); i++) {
2505 size_t effective = i * 8 + RVALUE_OVERHEAD;
2506 uint8_t idx;
2507 for (idx = 0; idx < HEAP_COUNT; idx++) {
2508 if (effective <= pool_slot_sizes[idx]) break;
2509 }
2510 size_to_heap_idx[i] = idx;
2511 }
2512}
2513
2514static inline size_t
2515heap_idx_for_size(size_t size)
2516{
2517 size_t compressed = (size + 7) >> 3;
2518 if (compressed < sizeof(size_to_heap_idx)) {
2519 size_t heap_idx = size_to_heap_idx[compressed];
2520 if (RB_LIKELY(heap_idx < HEAP_COUNT)) return heap_idx;
2521 }
2522
2523 rb_bug("heap_idx_for_size: allocation size too large "
2524 "(size=%"PRIuSIZE")", size);
2525}
2526
2527size_t
2528rb_gc_impl_heap_id_for_size(void *objspace_ptr, size_t size)
2529{
2530 return heap_idx_for_size(size);
2531}
2532
2533
2534static size_t heap_sizes[HEAP_COUNT + 1] = { 0 };
2535
2536size_t *
2537rb_gc_impl_heap_sizes(void *objspace_ptr)
2538{
2539 if (heap_sizes[0] == 0) {
2540 for (unsigned char i = 0; i < HEAP_COUNT; i++) {
2541 heap_sizes[i] = heap_slot_size(i);
2542 }
2543 }
2544
2545 return heap_sizes;
2546}
2547
2548NOINLINE(static VALUE newobj_cache_miss(rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, size_t heap_idx, bool vm_locked));
2549
2550static VALUE
2551newobj_cache_miss(rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, size_t heap_idx, bool vm_locked)
2552{
2553 rb_heap_t *heap = &heaps[heap_idx];
2554 VALUE obj = Qfalse;
2555
2556 unsigned int lev = 0;
2557 bool unlock_vm = false;
2558
2559 if (!vm_locked) {
2560 lev = RB_GC_CR_LOCK();
2561 unlock_vm = true;
2562 }
2563
2564 {
2565 if (is_incremental_marking(objspace)) {
2566 gc_continue(objspace, heap);
2567 cache->incremental_mark_step_allocated_slots = 0;
2568
2569 // Retry allocation after resetting incremental_mark_step_allocated_slots
2570 obj = ractor_cache_allocate_slot(objspace, cache, heap_idx);
2571 }
2572
2573 if (obj == Qfalse) {
2574 // Get next free page (possibly running GC)
2575 struct heap_page *page = heap_next_free_page(objspace, heap);
2576 ractor_cache_set_page(objspace, cache, heap_idx, page);
2577
2578 // Retry allocation after moving to new page
2579 obj = ractor_cache_allocate_slot(objspace, cache, heap_idx);
2580 }
2581 }
2582
2583 if (unlock_vm) {
2584 RB_GC_CR_UNLOCK(lev);
2585 }
2586
2587 if (RB_UNLIKELY(obj == Qfalse)) {
2588 rb_memerror();
2589 }
2590 return obj;
2591}
2592
2593static VALUE
2594newobj_alloc(rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, size_t heap_idx, bool vm_locked)
2595{
2596 VALUE obj = ractor_cache_allocate_slot(objspace, cache, heap_idx);
2597
2598 if (RB_UNLIKELY(obj == Qfalse)) {
2599 obj = newobj_cache_miss(objspace, cache, heap_idx, vm_locked);
2600 }
2601
2602 return obj;
2603}
2604
2605ALWAYS_INLINE(static VALUE newobj_slowpath(VALUE klass, VALUE flags, rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, int wb_protected, size_t heap_idx));
2606
2607static inline VALUE
2608newobj_slowpath(VALUE klass, VALUE flags, rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, int wb_protected, size_t heap_idx)
2609{
2610 VALUE obj;
2611 unsigned int lev;
2612
2613 lev = RB_GC_CR_LOCK();
2614 {
2615 if (RB_UNLIKELY(during_gc || ruby_gc_stressful)) {
2616 if (during_gc) {
2617 dont_gc_on();
2618 during_gc = 0;
2619 if (rb_memerror_reentered()) {
2620 rb_memerror();
2621 }
2622 rb_bug("object allocation during garbage collection phase");
2623 }
2624
2625 if (ruby_gc_stressful) {
2626 if (!garbage_collect(objspace, GPR_FLAG_NEWOBJ)) {
2627 rb_memerror();
2628 }
2629 }
2630 }
2631
2632 obj = newobj_alloc(objspace, cache, heap_idx, true);
2633 newobj_init(klass, flags, wb_protected, objspace, obj);
2634 }
2635 RB_GC_CR_UNLOCK(lev);
2636
2637 return obj;
2638}
2639
2640NOINLINE(static VALUE newobj_slowpath_wb_protected(VALUE klass, VALUE flags,
2641 rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, size_t heap_idx));
2642NOINLINE(static VALUE newobj_slowpath_wb_unprotected(VALUE klass, VALUE flags,
2643 rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, size_t heap_idx));
2644
2645static VALUE
2646newobj_slowpath_wb_protected(VALUE klass, VALUE flags, rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, size_t heap_idx)
2647{
2648 return newobj_slowpath(klass, flags, objspace, cache, TRUE, heap_idx);
2649}
2650
2651static VALUE
2652newobj_slowpath_wb_unprotected(VALUE klass, VALUE flags, rb_objspace_t *objspace, rb_ractor_newobj_cache_t *cache, size_t heap_idx)
2653{
2654 return newobj_slowpath(klass, flags, objspace, cache, FALSE, heap_idx);
2655}
2656
2657VALUE
2658rb_gc_impl_new_obj(void *objspace_ptr, void *cache_ptr, VALUE klass, VALUE flags, bool wb_protected, size_t alloc_size)
2659{
2660 VALUE obj;
2661 rb_objspace_t *objspace = objspace_ptr;
2662
2663 RB_DEBUG_COUNTER_INC(obj_newobj);
2664 (void)RB_DEBUG_COUNTER_INC_IF(obj_newobj_wb_unprotected, !wb_protected);
2665
2666 if (RB_UNLIKELY(stress_to_class)) {
2667 if (rb_hash_lookup2(stress_to_class, klass, Qundef) != Qundef) {
2668 rb_memerror();
2669 }
2670 }
2671
2672 size_t heap_idx = heap_idx_for_size(alloc_size);
2673
2675
2676 if (!RB_UNLIKELY(during_gc || ruby_gc_stressful) &&
2677 wb_protected) {
2678 obj = newobj_alloc(objspace, cache, heap_idx, false);
2679 newobj_init(klass, flags, wb_protected, objspace, obj);
2680 }
2681 else {
2682 RB_DEBUG_COUNTER_INC(obj_newobj_slowpath);
2683
2684 obj = wb_protected ?
2685 newobj_slowpath_wb_protected(klass, flags, objspace, cache, heap_idx) :
2686 newobj_slowpath_wb_unprotected(klass, flags, objspace, cache, heap_idx);
2687 }
2688
2689 return obj;
2690}
2691
2692static int
2693ptr_in_page_body_p(const void *ptr, const void *memb)
2694{
2695 struct heap_page *page = *(struct heap_page **)memb;
2696 uintptr_t p_body = (uintptr_t)page->body;
2697
2698 if ((uintptr_t)ptr >= p_body) {
2699 return (uintptr_t)ptr < (p_body + HEAP_PAGE_SIZE) ? 0 : 1;
2700 }
2701 else {
2702 return -1;
2703 }
2704}
2705
2706PUREFUNC(static inline struct heap_page *heap_page_for_ptr(rb_objspace_t *objspace, uintptr_t ptr);)
2707static inline struct heap_page *
2708heap_page_for_ptr(rb_objspace_t *objspace, uintptr_t ptr)
2709{
2710 struct heap_page **res;
2711
2712 if (ptr < (uintptr_t)heap_pages_lomem ||
2713 ptr > (uintptr_t)heap_pages_himem) {
2714 return NULL;
2715 }
2716
2717 res = bsearch((void *)ptr, rb_darray_ref(objspace->heap_pages.sorted, 0),
2718 rb_darray_size(objspace->heap_pages.sorted), sizeof(struct heap_page *),
2719 ptr_in_page_body_p);
2720
2721 if (res) {
2722 return *res;
2723 }
2724 else {
2725 return NULL;
2726 }
2727}
2728
2729PUREFUNC(static inline bool is_pointer_to_heap(rb_objspace_t *objspace, const void *ptr);)
2730static inline bool
2731is_pointer_to_heap(rb_objspace_t *objspace, const void *ptr)
2732{
2733 register uintptr_t p = (uintptr_t)ptr;
2734 register struct heap_page *page;
2735
2736 RB_DEBUG_COUNTER_INC(gc_isptr_trial);
2737
2738 if (p < heap_pages_lomem || p > heap_pages_himem) return FALSE;
2739 RB_DEBUG_COUNTER_INC(gc_isptr_range);
2740
2741 if (p % sizeof(VALUE) != 0) return FALSE;
2742 RB_DEBUG_COUNTER_INC(gc_isptr_align);
2743
2744 page = heap_page_for_ptr(objspace, (uintptr_t)ptr);
2745 if (page) {
2746 RB_DEBUG_COUNTER_INC(gc_isptr_maybe);
2747 if (heap_page_in_global_empty_pages_pool(objspace, page)) {
2748 return FALSE;
2749 }
2750 else {
2751 if (p < page->start) return FALSE;
2752 if (p >= page->start + (page->total_slots * page->slot_size)) return FALSE;
2753 if ((p - page->start) % page->slot_size != 0) return FALSE;
2754
2755 return TRUE;
2756 }
2757 }
2758 return FALSE;
2759}
2760
2761bool
2762rb_gc_impl_pointer_to_heap_p(void *objspace_ptr, const void *ptr)
2763{
2764 return is_pointer_to_heap(objspace_ptr, ptr);
2765}
2766
2767#define ZOMBIE_OBJ_KEPT_FLAGS (FL_FINALIZE)
2768
2769void
2770rb_gc_impl_make_zombie(void *objspace_ptr, VALUE obj, void (*dfree)(void *), void *data)
2771{
2772 rb_objspace_t *objspace = objspace_ptr;
2773
2774 struct RZombie *zombie = RZOMBIE(obj);
2775 zombie->flags = T_ZOMBIE | (zombie->flags & ZOMBIE_OBJ_KEPT_FLAGS);
2776 zombie->dfree = dfree;
2777 zombie->data = data;
2778 VALUE prev, next = heap_pages_deferred_final;
2779 do {
2780 zombie->next = prev = next;
2781 next = RUBY_ATOMIC_VALUE_CAS(heap_pages_deferred_final, prev, obj);
2782 } while (next != prev);
2783
2784 struct heap_page *page = GET_HEAP_PAGE(obj);
2785 page->final_slots++;
2786 page->heap->final_slots_count++;
2787}
2788
2789typedef int each_obj_callback(void *, void *, size_t, void *);
2790typedef int each_page_callback(struct heap_page *, void *);
2791
2794 bool reenable_incremental;
2795
2796 each_obj_callback *each_obj_callback;
2797 each_page_callback *each_page_callback;
2798 void *data;
2799
2800 struct heap_page **pages[HEAP_COUNT];
2801 size_t pages_counts[HEAP_COUNT];
2802};
2803
2804static VALUE
2805objspace_each_objects_ensure(VALUE arg)
2806{
2807 struct each_obj_data *data = (struct each_obj_data *)arg;
2808 rb_objspace_t *objspace = data->objspace;
2809
2810 /* Reenable incremental GC */
2811 if (data->reenable_incremental) {
2812 objspace->flags.dont_incremental = FALSE;
2813 }
2814
2815 for (int i = 0; i < HEAP_COUNT; i++) {
2816 struct heap_page **pages = data->pages[i];
2817 free(pages);
2818 }
2819
2820 return Qnil;
2821}
2822
2823static VALUE
2824objspace_each_objects_try(VALUE arg)
2825{
2826 struct each_obj_data *data = (struct each_obj_data *)arg;
2827 rb_objspace_t *objspace = data->objspace;
2828
2829 /* Copy pages from all heaps to their respective buffers. */
2830 for (int i = 0; i < HEAP_COUNT; i++) {
2831 rb_heap_t *heap = &heaps[i];
2832 size_t size = heap->total_pages * sizeof(struct heap_page *);
2833
2834 struct heap_page **pages = malloc(size);
2835 if (!pages) rb_memerror();
2836
2837 /* Set up pages buffer by iterating over all pages in the current eden
2838 * heap. This will be a snapshot of the state of the heap before we
2839 * call the callback over each page that exists in this buffer. Thus it
2840 * is safe for the callback to allocate objects without possibly entering
2841 * an infinite loop. */
2842 struct heap_page *page = 0;
2843 size_t pages_count = 0;
2844 ccan_list_for_each(&heap->pages, page, page_node) {
2845 pages[pages_count] = page;
2846 pages_count++;
2847 }
2848 data->pages[i] = pages;
2849 data->pages_counts[i] = pages_count;
2850 GC_ASSERT(pages_count == heap->total_pages);
2851 }
2852
2853 for (int i = 0; i < HEAP_COUNT; i++) {
2854 rb_heap_t *heap = &heaps[i];
2855 size_t pages_count = data->pages_counts[i];
2856 struct heap_page **pages = data->pages[i];
2857
2858 struct heap_page *page = ccan_list_top(&heap->pages, struct heap_page, page_node);
2859 for (size_t i = 0; i < pages_count; i++) {
2860 /* If we have reached the end of the linked list then there are no
2861 * more pages, so break. */
2862 if (page == NULL) break;
2863
2864 /* If this page does not match the one in the buffer, then move to
2865 * the next page in the buffer. */
2866 if (pages[i] != page) continue;
2867
2868 uintptr_t pstart = (uintptr_t)page->start;
2869 uintptr_t pend = pstart + (page->total_slots * heap->slot_size);
2870
2871 if (data->each_obj_callback &&
2872 (*data->each_obj_callback)((void *)pstart, (void *)pend, heap->slot_size, data->data)) {
2873 break;
2874 }
2875 if (data->each_page_callback &&
2876 (*data->each_page_callback)(page, data->data)) {
2877 break;
2878 }
2879
2880 page = ccan_list_next(&heap->pages, page, page_node);
2881 }
2882 }
2883
2884 return Qnil;
2885}
2886
2887static void
2888objspace_each_exec(bool protected, struct each_obj_data *each_obj_data)
2889{
2890 /* Disable incremental GC */
2892 bool reenable_incremental = FALSE;
2893 if (protected) {
2894 reenable_incremental = !objspace->flags.dont_incremental;
2895
2896 gc_rest(objspace);
2897 objspace->flags.dont_incremental = TRUE;
2898 }
2899
2900 each_obj_data->reenable_incremental = reenable_incremental;
2901 memset(&each_obj_data->pages, 0, sizeof(each_obj_data->pages));
2902 memset(&each_obj_data->pages_counts, 0, sizeof(each_obj_data->pages_counts));
2903 rb_ensure(objspace_each_objects_try, (VALUE)each_obj_data,
2904 objspace_each_objects_ensure, (VALUE)each_obj_data);
2905}
2906
2907static void
2908objspace_each_objects(rb_objspace_t *objspace, each_obj_callback *callback, void *data, bool protected)
2909{
2910 struct each_obj_data each_obj_data = {
2911 .objspace = objspace,
2912 .each_obj_callback = callback,
2913 .each_page_callback = NULL,
2914 .data = data,
2915 };
2916 objspace_each_exec(protected, &each_obj_data);
2917}
2918
2919void
2920rb_gc_impl_each_objects(void *objspace_ptr, each_obj_callback *callback, void *data)
2921{
2922 objspace_each_objects(objspace_ptr, callback, data, TRUE);
2923}
2924
2925#if GC_CAN_COMPILE_COMPACTION
2926static void
2927objspace_each_pages(rb_objspace_t *objspace, each_page_callback *callback, void *data, bool protected)
2928{
2929 struct each_obj_data each_obj_data = {
2930 .objspace = objspace,
2931 .each_obj_callback = NULL,
2932 .each_page_callback = callback,
2933 .data = data,
2934 };
2935 objspace_each_exec(protected, &each_obj_data);
2936}
2937#endif
2938
2939VALUE
2940rb_gc_impl_define_finalizer(void *objspace_ptr, VALUE obj, VALUE block)
2941{
2942 rb_objspace_t *objspace = objspace_ptr;
2943 VALUE table;
2944 st_data_t data;
2945
2946 GC_ASSERT(!OBJ_FROZEN(obj));
2947
2948 RBASIC(obj)->flags |= FL_FINALIZE;
2949
2950 unsigned int lev = RB_GC_VM_LOCK();
2951
2952 if (st_lookup(finalizer_table, obj, &data)) {
2953 table = (VALUE)data;
2954 VALUE dup_table = rb_ary_dup(table);
2955
2956 RB_GC_VM_UNLOCK(lev);
2957 /* avoid duplicate block, table is usually small */
2958 {
2959 long len = RARRAY_LEN(table);
2960 long i;
2961
2962 for (i = 0; i < len; i++) {
2963 VALUE recv = RARRAY_AREF(dup_table, i);
2964 if (rb_equal(recv, block)) { // can't be called with VM lock held
2965 return recv;
2966 }
2967 }
2968 }
2969 lev = RB_GC_VM_LOCK();
2970 RB_GC_GUARD(dup_table);
2971
2972 rb_ary_push(table, block);
2973 }
2974 else {
2975 table = rb_ary_new3(2, rb_obj_id(obj), block);
2976 rb_obj_hide(table);
2977 st_add_direct(finalizer_table, obj, table);
2978 }
2979
2980 RB_GC_VM_UNLOCK(lev);
2981
2982 return block;
2983}
2984
2985void
2986rb_gc_impl_undefine_finalizer(void *objspace_ptr, VALUE obj)
2987{
2988 rb_objspace_t *objspace = objspace_ptr;
2989
2990 GC_ASSERT(!OBJ_FROZEN(obj));
2991
2992 st_data_t data = obj;
2993
2994 int lev = RB_GC_VM_LOCK();
2995 st_delete(finalizer_table, &data, 0);
2996 RB_GC_VM_UNLOCK(lev);
2997
2998 FL_UNSET(obj, FL_FINALIZE);
2999}
3000
3001void
3002rb_gc_impl_copy_finalizer(void *objspace_ptr, VALUE dest, VALUE obj)
3003{
3004 rb_objspace_t *objspace = objspace_ptr;
3005 VALUE table;
3006 st_data_t data;
3007
3008 if (!FL_TEST(obj, FL_FINALIZE)) return;
3009
3010 int lev = RB_GC_VM_LOCK();
3011 if (RB_LIKELY(st_lookup(finalizer_table, obj, &data))) {
3012 table = rb_ary_dup((VALUE)data);
3013 RARRAY_ASET(table, 0, rb_obj_id(dest));
3014 st_insert(finalizer_table, dest, table);
3015 FL_SET(dest, FL_FINALIZE);
3016 }
3017 else {
3018 rb_bug("rb_gc_copy_finalizer: FL_FINALIZE set but not found in finalizer_table: %s", rb_obj_info(obj));
3019 }
3020 RB_GC_VM_UNLOCK(lev);
3021}
3022
3023static VALUE
3024get_final(long i, void *data)
3025{
3026 VALUE table = (VALUE)data;
3027
3028 return RARRAY_AREF(table, i + 1);
3029}
3030
3031static unsigned int
3032run_final(rb_objspace_t *objspace, VALUE zombie, unsigned int lev)
3033{
3034 if (RZOMBIE(zombie)->dfree) {
3035 RZOMBIE(zombie)->dfree(RZOMBIE(zombie)->data);
3036 }
3037
3038 st_data_t key = (st_data_t)zombie;
3039 if (FL_TEST_RAW(zombie, FL_FINALIZE)) {
3040 FL_UNSET(zombie, FL_FINALIZE);
3041 st_data_t table;
3042 if (st_delete(finalizer_table, &key, &table)) {
3043 RB_GC_VM_UNLOCK(lev);
3044 rb_gc_run_obj_finalizer(RARRAY_AREF(table, 0), RARRAY_LEN(table) - 1, get_final, (void *)table);
3045 lev = RB_GC_VM_LOCK();
3046 }
3047 else {
3048 rb_bug("FL_FINALIZE flag is set, but finalizers are not found");
3049 }
3050 }
3051 else {
3052 GC_ASSERT(!st_lookup(finalizer_table, key, NULL));
3053 }
3054 return lev;
3055}
3056
3057static void
3058finalize_list(rb_objspace_t *objspace, VALUE zombie)
3059{
3060 while (zombie) {
3061 VALUE next_zombie;
3062 struct heap_page *page;
3063 rb_asan_unpoison_object(zombie, false);
3064 next_zombie = RZOMBIE(zombie)->next;
3065 page = GET_HEAP_PAGE(zombie);
3066
3067 unsigned int lev = RB_GC_VM_LOCK();
3068
3069 lev = run_final(objspace, zombie, lev);
3070 {
3071 GC_ASSERT(BUILTIN_TYPE(zombie) == T_ZOMBIE);
3072 GC_ASSERT(page->heap->final_slots_count > 0);
3073 GC_ASSERT(page->final_slots > 0);
3074
3075 page->heap->final_slots_count--;
3076 page->final_slots--;
3077 page->free_slots++;
3078 RVALUE_AGE_SET_BITMAP(zombie, 0);
3079 heap_page_add_freeobj(objspace, page, zombie);
3080 page->heap->total_freed_objects++;
3081 }
3082 RB_GC_VM_UNLOCK(lev);
3083
3084 zombie = next_zombie;
3085 }
3086}
3087
3088static void
3089finalize_deferred_heap_pages(rb_objspace_t *objspace)
3090{
3091 VALUE zombie;
3092 while ((zombie = RUBY_ATOMIC_VALUE_EXCHANGE(heap_pages_deferred_final, 0)) != 0) {
3093 finalize_list(objspace, zombie);
3094 }
3095}
3096
3097static void
3098finalize_deferred(rb_objspace_t *objspace)
3099{
3100 rb_gc_set_pending_interrupt();
3101 finalize_deferred_heap_pages(objspace);
3102 rb_gc_unset_pending_interrupt();
3103}
3104
3105static void
3106gc_finalize_deferred(void *dmy)
3107{
3108 rb_objspace_t *objspace = dmy;
3109 if (RUBY_ATOMIC_EXCHANGE(finalizing, 1)) return;
3110
3111 finalize_deferred(objspace);
3112 RUBY_ATOMIC_SET(finalizing, 0);
3113}
3114
3115static void
3116gc_finalize_deferred_register(rb_objspace_t *objspace)
3117{
3118 /* will enqueue a call to gc_finalize_deferred */
3119 rb_postponed_job_trigger(objspace->finalize_deferred_pjob);
3120}
3121
3122static int pop_mark_stack(mark_stack_t *stack, VALUE *data);
3123
3124static void
3125gc_abort(void *objspace_ptr)
3126{
3127 rb_objspace_t *objspace = objspace_ptr;
3128
3129 if (is_incremental_marking(objspace)) {
3130 /* Remove all objects from the mark stack. */
3131 VALUE obj;
3132 while (pop_mark_stack(&objspace->mark_stack, &obj));
3133
3134 objspace->flags.during_incremental_marking = FALSE;
3135 }
3136
3137 if (is_lazy_sweeping(objspace)) {
3138 objspace->sweeping_heap_count = 0;
3139 for (int i = 0; i < HEAP_COUNT; i++) {
3140 rb_heap_t *heap = &heaps[i];
3141
3142 heap->sweeping_page = NULL;
3143 struct heap_page *page = NULL;
3144
3145 ccan_list_for_each(&heap->pages, page, page_node) {
3146 page->flags.before_sweep = false;
3147 }
3148 }
3149 }
3150
3151 for (int i = 0; i < HEAP_COUNT; i++) {
3152 rb_heap_t *heap = &heaps[i];
3153 rgengc_mark_and_rememberset_clear(objspace, heap);
3154 }
3155
3156 gc_mode_set(objspace, gc_mode_none);
3157}
3158
3159void
3160rb_gc_impl_shutdown_free_objects(void *objspace_ptr)
3161{
3162 rb_objspace_t *objspace = objspace_ptr;
3163
3164 for (size_t i = 0; i < rb_darray_size(objspace->heap_pages.sorted); i++) {
3165 struct heap_page *page = rb_darray_get(objspace->heap_pages.sorted, i);
3166 short stride = page->slot_size;
3167
3168 uintptr_t p = (uintptr_t)page->start;
3169 uintptr_t pend = p + page->total_slots * stride;
3170 for (; p < pend; p += stride) {
3171 VALUE vp = (VALUE)p;
3172 asan_unpoisoning_object(vp) {
3173 if (RB_BUILTIN_TYPE(vp) != T_NONE) {
3174 rb_gc_obj_free_vm_weak_references(vp);
3175 if (rb_gc_obj_free(objspace, vp)) {
3176 RBASIC(vp)->flags = 0;
3177 }
3178 }
3179 }
3180 }
3181 }
3182}
3183
3184static int
3185rb_gc_impl_shutdown_call_finalizer_i(st_data_t key, st_data_t val, st_data_t _data)
3186{
3187 VALUE obj = (VALUE)key;
3188 VALUE table = (VALUE)val;
3189
3190 GC_ASSERT(RB_FL_TEST(obj, FL_FINALIZE));
3191 GC_ASSERT(RB_BUILTIN_TYPE(val) == T_ARRAY);
3192
3193 rb_gc_run_obj_finalizer(RARRAY_AREF(table, 0), RARRAY_LEN(table) - 1, get_final, (void *)table);
3194
3195 FL_UNSET(obj, FL_FINALIZE);
3196
3197 return ST_DELETE;
3198}
3199
3200void
3201rb_gc_impl_shutdown_call_finalizer(void *objspace_ptr)
3202{
3203 rb_objspace_t *objspace = objspace_ptr;
3204
3205#if RGENGC_CHECK_MODE >= 2
3206 gc_verify_internal_consistency(objspace);
3207#endif
3208
3209 /* prohibit incremental GC */
3210 objspace->flags.dont_incremental = 1;
3211
3212 if (RUBY_ATOMIC_EXCHANGE(finalizing, 1)) {
3213 /* Abort incremental marking and lazy sweeping to speed up shutdown. */
3214 gc_abort(objspace);
3215 dont_gc_on();
3216 return;
3217 }
3218
3219 while (finalizer_table->num_entries) {
3220 st_foreach(finalizer_table, rb_gc_impl_shutdown_call_finalizer_i, 0);
3221 }
3222
3223 /* run finalizers */
3224 finalize_deferred(objspace);
3225 GC_ASSERT(heap_pages_deferred_final == 0);
3226
3227 /* Abort incremental marking and lazy sweeping to speed up shutdown. */
3228 gc_abort(objspace);
3229
3230 /* prohibit GC because force T_DATA finalizers can break an object graph consistency */
3231 dont_gc_on();
3232
3233 /* running data/file finalizers are part of garbage collection */
3234 unsigned int lock_lev;
3235 gc_enter(objspace, gc_enter_event_finalizer, &lock_lev);
3236
3237 /* run data/file object's finalizers */
3238 for (size_t i = 0; i < rb_darray_size(objspace->heap_pages.sorted); i++) {
3239 struct heap_page *page = rb_darray_get(objspace->heap_pages.sorted, i);
3240 short stride = page->slot_size;
3241
3242 uintptr_t p = (uintptr_t)page->start;
3243 uintptr_t pend = p + page->total_slots * stride;
3244 for (; p < pend; p += stride) {
3245 VALUE vp = (VALUE)p;
3246 asan_unpoisoning_object(vp) {
3247 if (rb_gc_shutdown_call_finalizer_p(vp)) {
3248 rb_gc_obj_free_vm_weak_references(vp);
3249 if (rb_gc_obj_free(objspace, vp)) {
3250 RBASIC(vp)->flags = 0;
3251 }
3252 }
3253 }
3254 }
3255 }
3256
3257 gc_exit(objspace, gc_enter_event_finalizer, &lock_lev);
3258
3259 finalize_deferred_heap_pages(objspace);
3260
3261 st_free_table(finalizer_table);
3262 finalizer_table = 0;
3263 RUBY_ATOMIC_SET(finalizing, 0);
3264}
3265
3266void
3267rb_gc_impl_each_object(void *objspace_ptr, void (*func)(VALUE obj, void *data), void *data)
3268{
3269 rb_objspace_t *objspace = objspace_ptr;
3270
3271 for (size_t i = 0; i < rb_darray_size(objspace->heap_pages.sorted); i++) {
3272 struct heap_page *page = rb_darray_get(objspace->heap_pages.sorted, i);
3273 short stride = page->slot_size;
3274
3275 uintptr_t p = (uintptr_t)page->start;
3276 uintptr_t pend = p + page->total_slots * stride;
3277 for (; p < pend; p += stride) {
3278 VALUE obj = (VALUE)p;
3279
3280 asan_unpoisoning_object(obj) {
3281 func(obj, data);
3282 }
3283 }
3284 }
3285}
3286
3287/*
3288 ------------------------ Garbage Collection ------------------------
3289*/
3290
3291/* Sweeping */
3292
3293static size_t
3294objspace_available_slots(rb_objspace_t *objspace)
3295{
3296 size_t total_slots = 0;
3297 for (int i = 0; i < HEAP_COUNT; i++) {
3298 rb_heap_t *heap = &heaps[i];
3299 total_slots += heap->total_slots;
3300 }
3301 return total_slots;
3302}
3303
3304static size_t
3305objspace_live_slots(rb_objspace_t *objspace)
3306{
3307 return total_allocated_objects(objspace) - total_freed_objects(objspace) - total_final_slots_count(objspace);
3308}
3309
3310static size_t
3311objspace_free_slots(rb_objspace_t *objspace)
3312{
3313 return objspace_available_slots(objspace) - objspace_live_slots(objspace) - total_final_slots_count(objspace);
3314}
3315
3316static void
3317gc_setup_mark_bits(struct heap_page *page)
3318{
3319 /* copy oldgen bitmap to mark bitmap */
3320 memcpy(&page->mark_bits[0], &page->uncollectible_bits[0], HEAP_PAGE_BITMAP_SIZE);
3321}
3322
3323static int gc_is_moveable_obj(rb_objspace_t *objspace, VALUE obj);
3324static VALUE gc_move(rb_objspace_t *objspace, VALUE scan, VALUE free, struct heap_page *src_page, struct heap_page *dest_page);
3325
3326#if defined(_WIN32)
3327enum {HEAP_PAGE_LOCK = PAGE_NOACCESS, HEAP_PAGE_UNLOCK = PAGE_READWRITE};
3328
3329static BOOL
3330protect_page_body(struct heap_page_body *body, DWORD protect)
3331{
3332 DWORD old_protect;
3333 return VirtualProtect(body, HEAP_PAGE_SIZE, protect, &old_protect) != 0;
3334}
3335#elif defined(__wasi__)
3336// wasi-libc's mprotect emulation does not support PROT_NONE
3337enum {HEAP_PAGE_LOCK, HEAP_PAGE_UNLOCK};
3338#define protect_page_body(body, protect) 1
3339#else
3340enum {HEAP_PAGE_LOCK = PROT_NONE, HEAP_PAGE_UNLOCK = PROT_READ | PROT_WRITE};
3341#define protect_page_body(body, protect) !mprotect((body), HEAP_PAGE_SIZE, (protect))
3342#endif
3343
3344static void
3345lock_page_body(rb_objspace_t *objspace, struct heap_page_body *body)
3346{
3347 if (!protect_page_body(body, HEAP_PAGE_LOCK)) {
3348 rb_bug("Couldn't protect page %p, errno: %s", (void *)body, strerror(errno));
3349 }
3350 else {
3351 gc_report(5, objspace, "Protecting page in move %p\n", (void *)body);
3352 }
3353}
3354
3355static void
3356unlock_page_body(rb_objspace_t *objspace, struct heap_page_body *body)
3357{
3358 if (!protect_page_body(body, HEAP_PAGE_UNLOCK)) {
3359 rb_bug("Couldn't unprotect page %p, errno: %s", (void *)body, strerror(errno));
3360 }
3361 else {
3362 gc_report(5, objspace, "Unprotecting page in move %p\n", (void *)body);
3363 }
3364}
3365
3366static bool
3367try_move(rb_objspace_t *objspace, rb_heap_t *heap, struct heap_page *free_page, VALUE src)
3368{
3369 GC_ASSERT(gc_is_moveable_obj(objspace, src));
3370
3371 struct heap_page *src_page = GET_HEAP_PAGE(src);
3372 if (!free_page) {
3373 return false;
3374 }
3375
3376 /* We should return true if either src is successfully moved, or src is
3377 * unmoveable. A false return will cause the sweeping cursor to be
3378 * incremented to the next page, and src will attempt to move again */
3379 GC_ASSERT(RVALUE_MARKED(objspace, src));
3380
3381 asan_unlock_freelist(free_page);
3382 VALUE dest = (VALUE)free_page->freelist;
3383 asan_lock_freelist(free_page);
3384 if (dest) {
3385 rb_asan_unpoison_object(dest, false);
3386 }
3387 else {
3388 /* if we can't get something from the freelist then the page must be
3389 * full */
3390 return false;
3391 }
3392 asan_unlock_freelist(free_page);
3393 free_page->freelist = ((struct free_slot *)dest)->next;
3394 asan_lock_freelist(free_page);
3395
3396 GC_ASSERT(RB_BUILTIN_TYPE(dest) == T_NONE);
3397
3398 if (src_page->slot_size > free_page->slot_size) {
3399 objspace->rcompactor.moved_down_count_table[BUILTIN_TYPE(src)]++;
3400 }
3401 else if (free_page->slot_size > src_page->slot_size) {
3402 objspace->rcompactor.moved_up_count_table[BUILTIN_TYPE(src)]++;
3403 }
3404 objspace->rcompactor.moved_count_table[BUILTIN_TYPE(src)]++;
3405 objspace->rcompactor.total_moved++;
3406
3407 gc_move(objspace, src, dest, src_page, free_page);
3408 gc_pin(objspace, src);
3409 free_page->free_slots--;
3410
3411 return true;
3412}
3413
3414static void
3415gc_unprotect_pages(rb_objspace_t *objspace, rb_heap_t *heap)
3416{
3417 struct heap_page *cursor = heap->compact_cursor;
3418
3419 while (cursor) {
3420 unlock_page_body(objspace, cursor->body);
3421 cursor = ccan_list_next(&heap->pages, cursor, page_node);
3422 }
3423}
3424
3425static void gc_update_references(rb_objspace_t *objspace);
3426#if GC_CAN_COMPILE_COMPACTION
3427static void invalidate_moved_page(rb_objspace_t *objspace, struct heap_page *page);
3428#endif
3429
3430#if defined(__MINGW32__) || defined(_WIN32)
3431# define GC_COMPACTION_SUPPORTED 1
3432#else
3433/* If not MinGW, Windows, or does not have mmap, we cannot use mprotect for
3434 * the read barrier, so we must disable compaction. */
3435# define GC_COMPACTION_SUPPORTED (GC_CAN_COMPILE_COMPACTION && HEAP_PAGE_ALLOC_USE_MMAP)
3436#endif
3437
3438#if GC_CAN_COMPILE_COMPACTION
3439static void
3440read_barrier_handler(uintptr_t address)
3441{
3442 rb_objspace_t *objspace = (rb_objspace_t *)rb_gc_get_objspace();
3443
3444 struct heap_page_body *page_body = GET_PAGE_BODY(address);
3445
3446 /* If the page_body is NULL, then mprotect cannot handle it and will crash
3447 * with "Cannot allocate memory". */
3448 if (page_body == NULL) {
3449 rb_bug("read_barrier_handler: segmentation fault at %p", (void *)address);
3450 }
3451
3452 int lev = RB_GC_VM_LOCK();
3453 {
3454 unlock_page_body(objspace, page_body);
3455
3456 objspace->profile.read_barrier_faults++;
3457
3458 invalidate_moved_page(objspace, GET_HEAP_PAGE(address));
3459 }
3460 RB_GC_VM_UNLOCK(lev);
3461}
3462#endif
3463
3464#if !GC_CAN_COMPILE_COMPACTION
3465static void
3466uninstall_handlers(void)
3467{
3468 /* no-op */
3469}
3470
3471static void
3472install_handlers(void)
3473{
3474 /* no-op */
3475}
3476#elif defined(_WIN32)
3477static LPTOP_LEVEL_EXCEPTION_FILTER old_handler;
3478typedef void (*signal_handler)(int);
3479static signal_handler old_sigsegv_handler;
3480
3481static LONG WINAPI
3482read_barrier_signal(EXCEPTION_POINTERS *info)
3483{
3484 /* EXCEPTION_ACCESS_VIOLATION is what's raised by access to protected pages */
3485 if (info->ExceptionRecord->ExceptionCode == EXCEPTION_ACCESS_VIOLATION) {
3486 /* > The second array element specifies the virtual address of the inaccessible data.
3487 * https://docs.microsoft.com/en-us/windows/win32/api/winnt/ns-winnt-exception_record
3488 *
3489 * Use this address to invalidate the page */
3490 read_barrier_handler((uintptr_t)info->ExceptionRecord->ExceptionInformation[1]);
3491 return EXCEPTION_CONTINUE_EXECUTION;
3492 }
3493 else {
3494 return EXCEPTION_CONTINUE_SEARCH;
3495 }
3496}
3497
3498static void
3499uninstall_handlers(void)
3500{
3501 signal(SIGSEGV, old_sigsegv_handler);
3502 SetUnhandledExceptionFilter(old_handler);
3503}
3504
3505static void
3506install_handlers(void)
3507{
3508 /* Remove SEGV handler so that the Unhandled Exception Filter handles it */
3509 old_sigsegv_handler = signal(SIGSEGV, NULL);
3510 /* Unhandled Exception Filter has access to the violation address similar
3511 * to si_addr from sigaction */
3512 old_handler = SetUnhandledExceptionFilter(read_barrier_signal);
3513}
3514#else
3515static struct sigaction old_sigbus_handler;
3516static struct sigaction old_sigsegv_handler;
3517
3518#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3519static exception_mask_t old_exception_masks[32];
3520static mach_port_t old_exception_ports[32];
3521static exception_behavior_t old_exception_behaviors[32];
3522static thread_state_flavor_t old_exception_flavors[32];
3523static mach_msg_type_number_t old_exception_count;
3524
3525static void
3526disable_mach_bad_access_exc(void)
3527{
3528 old_exception_count = sizeof(old_exception_masks) / sizeof(old_exception_masks[0]);
3529 task_swap_exception_ports(
3530 mach_task_self(), EXC_MASK_BAD_ACCESS,
3531 MACH_PORT_NULL, EXCEPTION_DEFAULT, 0,
3532 old_exception_masks, &old_exception_count,
3533 old_exception_ports, old_exception_behaviors, old_exception_flavors
3534 );
3535}
3536
3537static void
3538restore_mach_bad_access_exc(void)
3539{
3540 for (mach_msg_type_number_t i = 0; i < old_exception_count; i++) {
3541 task_set_exception_ports(
3542 mach_task_self(),
3543 old_exception_masks[i], old_exception_ports[i],
3544 old_exception_behaviors[i], old_exception_flavors[i]
3545 );
3546 }
3547}
3548#endif
3549
3550static void
3551read_barrier_signal(int sig, siginfo_t *info, void *data)
3552{
3553 // setup SEGV/BUS handlers for errors
3554 struct sigaction prev_sigbus, prev_sigsegv;
3555 sigaction(SIGBUS, &old_sigbus_handler, &prev_sigbus);
3556 sigaction(SIGSEGV, &old_sigsegv_handler, &prev_sigsegv);
3557
3558 // enable SIGBUS/SEGV
3559 sigset_t set, prev_set;
3560 sigemptyset(&set);
3561 sigaddset(&set, SIGBUS);
3562 sigaddset(&set, SIGSEGV);
3563 sigprocmask(SIG_UNBLOCK, &set, &prev_set);
3564#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3565 disable_mach_bad_access_exc();
3566#endif
3567 // run handler
3568 read_barrier_handler((uintptr_t)info->si_addr);
3569
3570 // reset SEGV/BUS handlers
3571#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3572 restore_mach_bad_access_exc();
3573#endif
3574 sigaction(SIGBUS, &prev_sigbus, NULL);
3575 sigaction(SIGSEGV, &prev_sigsegv, NULL);
3576 sigprocmask(SIG_SETMASK, &prev_set, NULL);
3577}
3578
3579static void
3580uninstall_handlers(void)
3581{
3582#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3583 restore_mach_bad_access_exc();
3584#endif
3585 sigaction(SIGBUS, &old_sigbus_handler, NULL);
3586 sigaction(SIGSEGV, &old_sigsegv_handler, NULL);
3587}
3588
3589static void
3590install_handlers(void)
3591{
3592 struct sigaction action;
3593 memset(&action, 0, sizeof(struct sigaction));
3594 sigemptyset(&action.sa_mask);
3595 action.sa_sigaction = read_barrier_signal;
3596 action.sa_flags = SA_SIGINFO | SA_ONSTACK;
3597
3598 sigaction(SIGBUS, &action, &old_sigbus_handler);
3599 sigaction(SIGSEGV, &action, &old_sigsegv_handler);
3600#ifdef HAVE_MACH_TASK_EXCEPTION_PORTS
3601 disable_mach_bad_access_exc();
3602#endif
3603}
3604#endif
3605
3606static void
3607gc_compact_finish(rb_objspace_t *objspace)
3608{
3609 for (int i = 0; i < HEAP_COUNT; i++) {
3610 rb_heap_t *heap = &heaps[i];
3611 gc_unprotect_pages(objspace, heap);
3612 }
3613
3614 uninstall_handlers();
3615
3616 gc_update_references(objspace);
3617 objspace->profile.compact_count++;
3618
3619 for (int i = 0; i < HEAP_COUNT; i++) {
3620 rb_heap_t *heap = &heaps[i];
3621 heap->compact_cursor = NULL;
3622 heap->free_pages = NULL;
3623 heap->compact_cursor_index = 0;
3624 }
3625
3626 if (gc_prof_enabled(objspace)) {
3627 gc_profile_record *record = gc_prof_record(objspace);
3628 record->moved_objects = objspace->rcompactor.total_moved - record->moved_objects;
3629 }
3630 objspace->flags.during_compacting = FALSE;
3631}
3632
3634 struct heap_page *page;
3635 int final_slots;
3636 int freed_slots;
3637 int empty_slots;
3638};
3639
3640static inline void
3641gc_sweep_plane(rb_objspace_t *objspace, rb_heap_t *heap, uintptr_t p, bits_t bitset, struct gc_sweep_context *ctx)
3642{
3643 struct heap_page *sweep_page = ctx->page;
3644 short slot_size = sweep_page->slot_size;
3645
3646 do {
3647 VALUE vp = (VALUE)p;
3648 GC_ASSERT(vp % sizeof(VALUE) == 0);
3649
3650 rb_asan_unpoison_object(vp, false);
3651 if (bitset & 1) {
3652 switch (BUILTIN_TYPE(vp)) {
3653 case T_MOVED:
3654 if (objspace->flags.during_compacting) {
3655 /* The sweep cursor shouldn't have made it to any
3656 * T_MOVED slots while the compact flag is enabled.
3657 * The sweep cursor and compact cursor move in
3658 * opposite directions, and when they meet references will
3659 * get updated and "during_compacting" should get disabled */
3660 rb_bug("T_MOVED shouldn't be seen until compaction is finished");
3661 }
3662 gc_report(3, objspace, "page_sweep: %s is added to freelist\n", rb_obj_info(vp));
3663 ctx->empty_slots++;
3664 heap_page_add_freeobj(objspace, sweep_page, vp);
3665 break;
3666 case T_ZOMBIE:
3667 /* already counted */
3668 break;
3669 case T_NONE:
3670 ctx->empty_slots++; /* already freed */
3671 break;
3672
3673 default:
3674#if RGENGC_CHECK_MODE
3675 if (!is_full_marking(objspace)) {
3676 if (RVALUE_OLD_P(objspace, vp)) rb_bug("page_sweep: %p - old while minor GC.", (void *)p);
3677 if (RVALUE_REMEMBERED(objspace, vp)) rb_bug("page_sweep: %p - remembered.", (void *)p);
3678 }
3679#endif
3680
3681#if RGENGC_CHECK_MODE
3682#define CHECK(x) if (x(objspace, vp) != FALSE) rb_bug("obj_free: " #x "(%s) != FALSE", rb_obj_info(vp))
3683 CHECK(RVALUE_WB_UNPROTECTED);
3684 CHECK(RVALUE_MARKED);
3685 CHECK(RVALUE_MARKING);
3686 CHECK(RVALUE_UNCOLLECTIBLE);
3687#undef CHECK
3688#endif
3689
3690 if (!rb_gc_obj_needs_cleanup_p(vp)) {
3691 if (RB_UNLIKELY(objspace->hook_events & RUBY_INTERNAL_EVENT_FREEOBJ)) {
3692 rb_gc_event_hook(vp, RUBY_INTERNAL_EVENT_FREEOBJ);
3693 }
3694
3695 (void)VALGRIND_MAKE_MEM_UNDEFINED((void*)p, slot_size);
3696 heap_page_add_freeobj(objspace, sweep_page, vp);
3697 gc_report(3, objspace, "page_sweep: %s (fast path) added to freelist\n", rb_obj_info(vp));
3698 ctx->freed_slots++;
3699 }
3700 else {
3701 gc_report(2, objspace, "page_sweep: free %p\n", (void *)p);
3702
3703 rb_gc_event_hook(vp, RUBY_INTERNAL_EVENT_FREEOBJ);
3704
3705 rb_gc_obj_free_vm_weak_references(vp);
3706 if (rb_gc_obj_free(objspace, vp)) {
3707 (void)VALGRIND_MAKE_MEM_UNDEFINED((void*)p, slot_size);
3708 heap_page_add_freeobj(objspace, sweep_page, vp);
3709 gc_report(3, objspace, "page_sweep: %s is added to freelist\n", rb_obj_info(vp));
3710 ctx->freed_slots++;
3711 }
3712 else {
3713 ctx->final_slots++;
3714 }
3715 }
3716 break;
3717 }
3718 }
3719 p += slot_size;
3720 bitset >>= 1;
3721 } while (bitset);
3722}
3723
3724static inline void
3725gc_sweep_page(rb_objspace_t *objspace, rb_heap_t *heap, struct gc_sweep_context *ctx)
3726{
3727 struct heap_page *sweep_page = ctx->page;
3728 GC_ASSERT(sweep_page->heap == heap);
3729
3730 uintptr_t p;
3731 bits_t *bits, bitset;
3732
3733 gc_report(2, objspace, "page_sweep: start.\n");
3734
3735#if RGENGC_CHECK_MODE
3736 if (!objspace->flags.immediate_sweep) {
3737 GC_ASSERT(sweep_page->flags.before_sweep == TRUE);
3738 }
3739#endif
3740 sweep_page->flags.before_sweep = FALSE;
3741 sweep_page->free_slots = 0;
3742
3743 p = (uintptr_t)sweep_page->start;
3744 bits = sweep_page->mark_bits;
3745 short slot_size = sweep_page->slot_size;
3746 int total_slots = sweep_page->total_slots;
3747 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
3748
3749 int out_of_range_bits = total_slots % BITS_BITLENGTH;
3750 if (out_of_range_bits != 0) {
3751 bits[bitmap_plane_count - 1] |= ~(((bits_t)1 << out_of_range_bits) - 1);
3752 }
3753
3754 // Clear wb_unprotected and age bits for all unmarked slots
3755 {
3756 bits_t *wb_unprotected_bits = sweep_page->wb_unprotected_bits;
3757 bits_t *age_bits = sweep_page->age_bits;
3758 for (int i = 0; i < bitmap_plane_count; i++) {
3759 bits_t unmarked = ~bits[i];
3760 wb_unprotected_bits[i] &= ~unmarked;
3761 age_bits[i * 2] &= ~unmarked;
3762 age_bits[i * 2 + 1] &= ~unmarked;
3763 }
3764 }
3765
3766 for (int i = 0; i < bitmap_plane_count; i++) {
3767 bitset = ~bits[i];
3768 if (bitset) {
3769 gc_sweep_plane(objspace, heap, p, bitset, ctx);
3770 }
3771 p += BITS_BITLENGTH * slot_size;
3772 }
3773
3774 if (!heap->compact_cursor) {
3775 gc_setup_mark_bits(sweep_page);
3776 }
3777
3778#if GC_PROFILE_MORE_DETAIL
3779 if (gc_prof_enabled(objspace)) {
3780 gc_profile_record *record = gc_prof_record(objspace);
3781 record->removing_objects += ctx->final_slots + ctx->freed_slots;
3782 record->empty_objects += ctx->empty_slots;
3783 }
3784#endif
3785 if (0) fprintf(stderr, "gc_sweep_page(%"PRIdSIZE"): total_slots: %d, freed_slots: %d, empty_slots: %d, final_slots: %d\n",
3786 rb_gc_count(),
3787 sweep_page->total_slots,
3788 ctx->freed_slots, ctx->empty_slots, ctx->final_slots);
3789
3790 sweep_page->free_slots += ctx->freed_slots + ctx->empty_slots;
3791 sweep_page->heap->total_freed_objects += ctx->freed_slots;
3792
3793 if (heap_pages_deferred_final && !finalizing) {
3794 gc_finalize_deferred_register(objspace);
3795 }
3796
3797#if RGENGC_CHECK_MODE
3798 short freelist_len = 0;
3799 asan_unlock_freelist(sweep_page);
3800 struct free_slot *ptr = sweep_page->freelist;
3801 while (ptr) {
3802 freelist_len++;
3803 rb_asan_unpoison_object((VALUE)ptr, false);
3804 struct free_slot *next = ptr->next;
3805 rb_asan_poison_object((VALUE)ptr);
3806 ptr = next;
3807 }
3808 asan_lock_freelist(sweep_page);
3809 if (freelist_len != sweep_page->free_slots) {
3810 rb_bug("inconsistent freelist length: expected %d but was %d", sweep_page->free_slots, freelist_len);
3811 }
3812#endif
3813
3814 gc_report(2, objspace, "page_sweep: end.\n");
3815}
3816
3817static const char *
3818gc_mode_name(enum gc_mode mode)
3819{
3820 switch (mode) {
3821 case gc_mode_none: return "none";
3822 case gc_mode_marking: return "marking";
3823 case gc_mode_sweeping: return "sweeping";
3824 case gc_mode_compacting: return "compacting";
3825 default: rb_bug("gc_mode_name: unknown mode: %d", (int)mode);
3826 }
3827}
3828
3829static void
3830gc_mode_transition(rb_objspace_t *objspace, enum gc_mode mode)
3831{
3832#if RGENGC_CHECK_MODE
3833 enum gc_mode prev_mode = gc_mode(objspace);
3834 switch (prev_mode) {
3835 case gc_mode_none: GC_ASSERT(mode == gc_mode_marking); break;
3836 case gc_mode_marking: GC_ASSERT(mode == gc_mode_sweeping); break;
3837 case gc_mode_sweeping: GC_ASSERT(mode == gc_mode_none || mode == gc_mode_compacting); break;
3838 case gc_mode_compacting: GC_ASSERT(mode == gc_mode_none); break;
3839 }
3840#endif
3841 if (0) fprintf(stderr, "gc_mode_transition: %s->%s\n", gc_mode_name(gc_mode(objspace)), gc_mode_name(mode));
3842 gc_mode_set(objspace, mode);
3843}
3844
3845static void
3846heap_page_freelist_append(struct heap_page *page, struct free_slot *freelist)
3847{
3848 if (freelist) {
3849 asan_unlock_freelist(page);
3850 if (page->freelist) {
3851 struct free_slot *p = page->freelist;
3852 rb_asan_unpoison_object((VALUE)p, false);
3853 while (p->next) {
3854 struct free_slot *prev = p;
3855 p = p->next;
3856 rb_asan_poison_object((VALUE)prev);
3857 rb_asan_unpoison_object((VALUE)p, false);
3858 }
3859 p->next = freelist;
3860 rb_asan_poison_object((VALUE)p);
3861 }
3862 else {
3863 page->freelist = freelist;
3864 }
3865 asan_lock_freelist(page);
3866 }
3867}
3868
3869static void
3870gc_sweep_start_heap(rb_objspace_t *objspace, rb_heap_t *heap)
3871{
3872 heap->sweeping_page = ccan_list_top(&heap->pages, struct heap_page, page_node);
3873 if (heap->sweeping_page) {
3874 objspace->sweeping_heap_count++;
3875 }
3876 heap->free_pages = NULL;
3877 heap->pooled_pages = NULL;
3878 if (!objspace->flags.immediate_sweep) {
3879 struct heap_page *page = NULL;
3880
3881 ccan_list_for_each(&heap->pages, page, page_node) {
3882 page->flags.before_sweep = TRUE;
3883 }
3884 }
3885}
3886
3887#if defined(__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ == 4
3888__attribute__((noinline))
3889#endif
3890
3891#if GC_CAN_COMPILE_COMPACTION
3892static void gc_sort_heap_by_compare_func(rb_objspace_t *objspace, gc_compact_compare_func compare_func);
3893static int compare_pinned_slots(const void *left, const void *right, void *d);
3894#endif
3895
3896static void
3897gc_ractor_newobj_cache_clear(void *c, void *data)
3898{
3899 rb_objspace_t *objspace = rb_gc_get_objspace();
3900 rb_ractor_newobj_cache_t *newobj_cache = c;
3901
3902 newobj_cache->incremental_mark_step_allocated_slots = 0;
3903
3904 for (size_t heap_idx = 0; heap_idx < HEAP_COUNT; heap_idx++) {
3905
3906 rb_ractor_newobj_heap_cache_t *cache = &newobj_cache->heap_caches[heap_idx];
3907
3908 rb_heap_t *heap = &heaps[heap_idx];
3909 RUBY_ATOMIC_SIZE_ADD(heap->total_allocated_objects, cache->allocated_objects_count);
3910 cache->allocated_objects_count = 0;
3911
3912 struct heap_page *page = cache->using_page;
3913 struct free_slot *freelist = cache->freelist;
3914 RUBY_DEBUG_LOG("ractor using_page:%p freelist:%p", (void *)page, (void *)freelist);
3915
3916 heap_page_freelist_append(page, freelist);
3917
3918 cache->using_page = NULL;
3919 cache->freelist = NULL;
3920 }
3921}
3922
3923static void
3924gc_sweep_start(rb_objspace_t *objspace)
3925{
3926 gc_mode_transition(objspace, gc_mode_sweeping);
3927 objspace->rincgc.pooled_slots = 0;
3928
3929#if GC_CAN_COMPILE_COMPACTION
3930 if (objspace->flags.during_compacting) {
3931 gc_sort_heap_by_compare_func(
3932 objspace,
3933 objspace->rcompactor.compare_func ? objspace->rcompactor.compare_func : compare_pinned_slots
3934 );
3935 }
3936#endif
3937
3938 for (int i = 0; i < HEAP_COUNT; i++) {
3939 rb_heap_t *heap = &heaps[i];
3940 gc_sweep_start_heap(objspace, heap);
3941
3942 /* We should call gc_sweep_finish_heap for size pools with no pages. */
3943 if (heap->sweeping_page == NULL) {
3944 GC_ASSERT(heap->total_pages == 0);
3945 GC_ASSERT(heap->total_slots == 0);
3946 gc_sweep_finish_heap(objspace, heap);
3947 }
3948 }
3949
3950 rb_gc_ractor_newobj_cache_foreach(gc_ractor_newobj_cache_clear, NULL);
3951}
3952
3953static void
3954gc_sweep_finish_heap(rb_objspace_t *objspace, rb_heap_t *heap)
3955{
3956 size_t total_slots = heap->total_slots;
3957 size_t swept_slots = heap->freed_slots + heap->empty_slots;
3958
3959 size_t init_slots = gc_params.heap_init_bytes / heap->slot_size;
3960 size_t min_free_slots = (size_t)(MAX(total_slots, init_slots) * gc_params.heap_free_slots_min_ratio);
3961
3962 if (swept_slots < min_free_slots &&
3963 /* The heap is a growth heap if it freed more slots than had empty slots. */
3964 ((heap->empty_slots == 0 && total_slots > 0) || heap->freed_slots > heap->empty_slots)) {
3965 /* If we don't have enough slots and we have pages on the tomb heap, move
3966 * pages from the tomb heap to the eden heap. This may prevent page
3967 * creation thrashing (frequently allocating and deallocting pages) and
3968 * GC thrashing (running GC more frequently than required). */
3969 struct heap_page *resurrected_page;
3970 while (swept_slots < min_free_slots &&
3971 (resurrected_page = heap_page_resurrect(objspace))) {
3972 heap_add_page(objspace, heap, resurrected_page);
3973 heap_add_freepage(heap, resurrected_page);
3974
3975 swept_slots += resurrected_page->free_slots;
3976 }
3977
3978 if (swept_slots < min_free_slots) {
3979 /* Grow this heap if we are in a major GC or if we haven't run at least
3980 * RVALUE_OLD_AGE minor GC since the last major GC. */
3981 if (is_full_marking(objspace) ||
3982 objspace->profile.count - objspace->rgengc.last_major_gc < RVALUE_OLD_AGE) {
3983 if (objspace->heap_pages.allocatable_bytes < min_free_slots * heap->slot_size) {
3984 heap_allocatable_bytes_expand(objspace, heap, swept_slots, heap->total_slots, heap->slot_size);
3985 }
3986 }
3987 else if (swept_slots < min_free_slots * 7 / 8 &&
3988 objspace->heap_pages.allocatable_bytes < (min_free_slots * 7 / 8 - swept_slots) * heap->slot_size) {
3989 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_NOFREE;
3990 heap->force_major_gc_count++;
3991 }
3992 }
3993 }
3994}
3995
3996static void
3997gc_sweep_finish(rb_objspace_t *objspace)
3998{
3999 gc_report(1, objspace, "gc_sweep_finish\n");
4000
4001 gc_prof_set_heap_info(objspace);
4002 heap_pages_free_unused_pages(objspace);
4003
4004 for (int i = 0; i < HEAP_COUNT; i++) {
4005 rb_heap_t *heap = &heaps[i];
4006
4007 heap->freed_slots = 0;
4008 heap->empty_slots = 0;
4009
4010 if (!will_be_incremental_marking(objspace)) {
4011 struct heap_page *end_page = heap->free_pages;
4012 if (end_page) {
4013 while (end_page->free_next) end_page = end_page->free_next;
4014 end_page->free_next = heap->pooled_pages;
4015 }
4016 else {
4017 heap->free_pages = heap->pooled_pages;
4018 }
4019 heap->pooled_pages = NULL;
4020 objspace->rincgc.pooled_slots = 0;
4021 }
4022 }
4023
4024 (void)gc_malloc_counters_snapshot(objspace, &objspace->malloc_counters.counters);
4025#if RGENGC_ESTIMATE_OLDMALLOC
4026 if (objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_MASK) {
4027 (void)gc_malloc_counters_snapshot(objspace, &objspace->malloc_counters.oldcounters);
4028 }
4029#endif
4030
4031 rb_gc_event_hook(0, RUBY_INTERNAL_EVENT_GC_END_SWEEP);
4032 gc_mode_transition(objspace, gc_mode_none);
4033
4034#if RGENGC_CHECK_MODE >= 2
4035 gc_verify_internal_consistency(objspace);
4036#endif
4037}
4038
4039static int
4040gc_sweep_step(rb_objspace_t *objspace, rb_heap_t *heap)
4041{
4042 struct heap_page *sweep_page = heap->sweeping_page;
4043 int swept_slots = 0;
4044 int pooled_slots = 0;
4045 int sweep_budget = GC_INCREMENTAL_SWEEP_BYTES / heap->slot_size;
4046 int pool_budget = GC_INCREMENTAL_SWEEP_POOL_BYTES / heap->slot_size;
4047
4048 if (sweep_page == NULL) return FALSE;
4049
4050#if GC_ENABLE_LAZY_SWEEP
4051 gc_prof_sweep_timer_start(objspace);
4052#endif
4053
4054 do {
4055 RUBY_DEBUG_LOG("sweep_page:%p", (void *)sweep_page);
4056
4057 struct gc_sweep_context ctx = {
4058 .page = sweep_page,
4059 .final_slots = 0,
4060 .freed_slots = 0,
4061 .empty_slots = 0,
4062 };
4063 gc_sweep_page(objspace, heap, &ctx);
4064 int free_slots = ctx.freed_slots + ctx.empty_slots;
4065
4066 heap->sweeping_page = ccan_list_next(&heap->pages, sweep_page, page_node);
4067
4068 if (free_slots == sweep_page->total_slots) {
4069 /* There are no living objects, so move this page to the global empty pages. */
4070 heap_unlink_page(objspace, heap, sweep_page);
4071
4072 sweep_page->start = 0;
4073 sweep_page->total_slots = 0;
4074 sweep_page->slot_size = 0;
4075 sweep_page->heap = NULL;
4076 sweep_page->free_slots = 0;
4077
4078 asan_unlock_freelist(sweep_page);
4079 sweep_page->freelist = NULL;
4080 asan_lock_freelist(sweep_page);
4081
4082 asan_poison_memory_region(sweep_page->body, HEAP_PAGE_SIZE);
4083
4084 objspace->empty_pages_count++;
4085 sweep_page->free_next = objspace->empty_pages;
4086 objspace->empty_pages = sweep_page;
4087 }
4088 else if (free_slots > 0) {
4089 heap->freed_slots += ctx.freed_slots;
4090 heap->empty_slots += ctx.empty_slots;
4091
4092 if (pooled_slots < pool_budget) {
4093 heap_add_poolpage(objspace, heap, sweep_page);
4094 pooled_slots += free_slots;
4095 }
4096 else {
4097 heap_add_freepage(heap, sweep_page);
4098 swept_slots += free_slots;
4099 if (swept_slots > sweep_budget) {
4100 break;
4101 }
4102 }
4103 }
4104 else {
4105 sweep_page->free_next = NULL;
4106 }
4107 } while ((sweep_page = heap->sweeping_page));
4108
4109 if (!heap->sweeping_page) {
4110 objspace->sweeping_heap_count--;
4111 GC_ASSERT(objspace->sweeping_heap_count >= 0);
4112 gc_sweep_finish_heap(objspace, heap);
4113
4114 if (!has_sweeping_pages(objspace)) {
4115 gc_sweep_finish(objspace);
4116 }
4117 }
4118
4119#if GC_ENABLE_LAZY_SWEEP
4120 gc_prof_sweep_timer_stop(objspace);
4121#endif
4122
4123 return heap->free_pages != NULL;
4124}
4125
4126static void
4127gc_sweep_rest(rb_objspace_t *objspace)
4128{
4129 for (int i = 0; i < HEAP_COUNT; i++) {
4130 rb_heap_t *heap = &heaps[i];
4131
4132 while (heap->sweeping_page) {
4133 gc_sweep_step(objspace, heap);
4134 }
4135 }
4136}
4137
4138static void
4139gc_sweep_continue(rb_objspace_t *objspace, rb_heap_t *sweep_heap)
4140{
4141 GC_ASSERT(dont_gc_val() == FALSE || objspace->profile.latest_gc_info & GPR_FLAG_METHOD);
4142 if (!GC_ENABLE_LAZY_SWEEP) return;
4143
4144 gc_sweeping_enter(objspace);
4145
4146 for (int i = 0; i < HEAP_COUNT; i++) {
4147 rb_heap_t *heap = &heaps[i];
4148 if (gc_sweep_step(objspace, heap)) {
4149 GC_ASSERT(heap->free_pages != NULL);
4150 }
4151 else if (heap == sweep_heap) {
4152 if (objspace->empty_pages_count > 0 || objspace->heap_pages.allocatable_bytes > 0) {
4153 /* [Bug #21548]
4154 *
4155 * If this heap is the heap we want to sweep, but we weren't able
4156 * to free any slots, but we also either have empty pages or could
4157 * allocate new pages, then we want to preemptively claim a page
4158 * because it's possible that sweeping another heap will call
4159 * gc_sweep_finish_heap, which may use up all of the
4160 * empty/allocatable pages. If other heaps are not finished sweeping
4161 * then we do not finish this GC and we will end up triggering a new
4162 * GC cycle during this GC phase. */
4163 heap_page_allocate_and_initialize(objspace, heap);
4164
4165 GC_ASSERT(heap->free_pages != NULL);
4166 }
4167 else {
4168 /* Not allowed to create a new page so finish sweeping. */
4169 gc_sweep_rest(objspace);
4170 GC_ASSERT(gc_mode(objspace) == gc_mode_none);
4171 break;
4172 }
4173 }
4174 }
4175
4176 gc_sweeping_exit(objspace);
4177}
4178
4179VALUE
4180rb_gc_impl_location(void *objspace_ptr, VALUE value)
4181{
4182 VALUE destination;
4183
4184 asan_unpoisoning_object(value) {
4185 if (BUILTIN_TYPE(value) == T_MOVED) {
4186 destination = (VALUE)RMOVED(value)->destination;
4187 GC_ASSERT(BUILTIN_TYPE(destination) != T_NONE);
4188 }
4189 else {
4190 destination = value;
4191 }
4192 }
4193
4194 return destination;
4195}
4196
4197#if GC_CAN_COMPILE_COMPACTION
4198static void
4199invalidate_moved_plane(rb_objspace_t *objspace, struct heap_page *page, uintptr_t p, bits_t bitset)
4200{
4201 if (bitset) {
4202 do {
4203 if (bitset & 1) {
4204 VALUE forwarding_object = (VALUE)p;
4205 VALUE object;
4206
4207 if (BUILTIN_TYPE(forwarding_object) == T_MOVED) {
4208 GC_ASSERT(RVALUE_PINNED(objspace, forwarding_object));
4209 GC_ASSERT(!RVALUE_MARKED(objspace, forwarding_object));
4210
4211 CLEAR_IN_BITMAP(GET_HEAP_PINNED_BITS(forwarding_object), forwarding_object);
4212
4213 object = rb_gc_impl_location(objspace, forwarding_object);
4214 gc_move(objspace, object, forwarding_object, GET_HEAP_PAGE(object), page);
4215 /* forwarding_object is now our actual object, and "object"
4216 * is the free slot for the original page */
4217
4218 struct heap_page *orig_page = GET_HEAP_PAGE(object);
4219 orig_page->free_slots++;
4220 RVALUE_AGE_SET_BITMAP(object, 0);
4221 heap_page_add_freeobj(objspace, orig_page, object);
4222
4223 GC_ASSERT(RVALUE_MARKED(objspace, forwarding_object));
4224 GC_ASSERT(BUILTIN_TYPE(forwarding_object) != T_MOVED);
4225 GC_ASSERT(BUILTIN_TYPE(forwarding_object) != T_NONE);
4226 }
4227 }
4228 p += page->slot_size;
4229 bitset >>= 1;
4230 } while (bitset);
4231 }
4232}
4233
4234static void
4235invalidate_moved_page(rb_objspace_t *objspace, struct heap_page *page)
4236{
4237 int i;
4238 bits_t *mark_bits, *pin_bits;
4239 bits_t bitset;
4240 short slot_size = page->slot_size;
4241 int total_slots = page->total_slots;
4242 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
4243
4244 mark_bits = page->mark_bits;
4245 pin_bits = page->pinned_bits;
4246
4247 uintptr_t p = page->start;
4248
4249 for (i=0; i < bitmap_plane_count; i++) {
4250 /* Moved objects are pinned but never marked. We reuse the pin bits
4251 * to indicate there is a moved object in this slot. */
4252 bitset = pin_bits[i] & ~mark_bits[i];
4253 invalidate_moved_plane(objspace, page, p, bitset);
4254 p += BITS_BITLENGTH * slot_size;
4255 }
4256}
4257#endif
4258
4259static void
4260gc_compact_start(rb_objspace_t *objspace)
4261{
4262 struct heap_page *page = NULL;
4263 gc_mode_transition(objspace, gc_mode_compacting);
4264
4265 for (int i = 0; i < HEAP_COUNT; i++) {
4266 rb_heap_t *heap = &heaps[i];
4267 ccan_list_for_each(&heap->pages, page, page_node) {
4268 page->flags.before_sweep = TRUE;
4269 }
4270
4271 heap->compact_cursor = ccan_list_tail(&heap->pages, struct heap_page, page_node);
4272 heap->compact_cursor_index = 0;
4273 }
4274
4275 if (gc_prof_enabled(objspace)) {
4276 gc_profile_record *record = gc_prof_record(objspace);
4277 record->moved_objects = objspace->rcompactor.total_moved;
4278 }
4279
4280 memset(objspace->rcompactor.considered_count_table, 0, T_MASK * sizeof(size_t));
4281 memset(objspace->rcompactor.moved_count_table, 0, T_MASK * sizeof(size_t));
4282 memset(objspace->rcompactor.moved_up_count_table, 0, T_MASK * sizeof(size_t));
4283 memset(objspace->rcompactor.moved_down_count_table, 0, T_MASK * sizeof(size_t));
4284
4285 /* Set up read barrier for pages containing MOVED objects */
4286 install_handlers();
4287}
4288
4289static void gc_sweep_compact(rb_objspace_t *objspace);
4290
4291static void
4292gc_sweep(rb_objspace_t *objspace)
4293{
4294 gc_sweeping_enter(objspace);
4295
4296 const unsigned int immediate_sweep = objspace->flags.immediate_sweep;
4297
4298 gc_report(1, objspace, "gc_sweep: immediate: %d\n", immediate_sweep);
4299
4300 gc_sweep_start(objspace);
4301 if (objspace->flags.during_compacting) {
4302 gc_sweep_compact(objspace);
4303 }
4304
4305 if (immediate_sweep) {
4306#if !GC_ENABLE_LAZY_SWEEP
4307 gc_prof_sweep_timer_start(objspace);
4308#endif
4309 gc_sweep_rest(objspace);
4310#if !GC_ENABLE_LAZY_SWEEP
4311 gc_prof_sweep_timer_stop(objspace);
4312#endif
4313 }
4314 else {
4315
4316 /* Sweep every size pool. */
4317 for (int i = 0; i < HEAP_COUNT; i++) {
4318 rb_heap_t *heap = &heaps[i];
4319 gc_sweep_step(objspace, heap);
4320 }
4321 }
4322
4323 gc_sweeping_exit(objspace);
4324}
4325
4326/* Marking - Marking stack */
4327
4328static stack_chunk_t *
4329stack_chunk_alloc(void)
4330{
4331 stack_chunk_t *res;
4332
4333 res = malloc(sizeof(stack_chunk_t));
4334 if (!res)
4335 rb_memerror();
4336
4337 return res;
4338}
4339
4340static inline int
4341is_mark_stack_empty(mark_stack_t *stack)
4342{
4343 return stack->chunk == NULL;
4344}
4345
4346static size_t
4347mark_stack_size(mark_stack_t *stack)
4348{
4349 size_t size = stack->index;
4350 stack_chunk_t *chunk = stack->chunk ? stack->chunk->next : NULL;
4351
4352 while (chunk) {
4353 size += stack->limit;
4354 chunk = chunk->next;
4355 }
4356 return size;
4357}
4358
4359static void
4360add_stack_chunk_cache(mark_stack_t *stack, stack_chunk_t *chunk)
4361{
4362 chunk->next = stack->cache;
4363 stack->cache = chunk;
4364 stack->cache_size++;
4365}
4366
4367static void
4368shrink_stack_chunk_cache(mark_stack_t *stack)
4369{
4370 stack_chunk_t *chunk;
4371
4372 if (stack->unused_cache_size > (stack->cache_size/2)) {
4373 chunk = stack->cache;
4374 stack->cache = stack->cache->next;
4375 stack->cache_size--;
4376 free(chunk);
4377 }
4378 stack->unused_cache_size = stack->cache_size;
4379}
4380
4381static void
4382push_mark_stack_chunk(mark_stack_t *stack)
4383{
4384 stack_chunk_t *next;
4385
4386 GC_ASSERT(stack->index == stack->limit);
4387
4388 if (stack->cache_size > 0) {
4389 next = stack->cache;
4390 stack->cache = stack->cache->next;
4391 stack->cache_size--;
4392 if (stack->unused_cache_size > stack->cache_size)
4393 stack->unused_cache_size = stack->cache_size;
4394 }
4395 else {
4396 next = stack_chunk_alloc();
4397 }
4398 next->next = stack->chunk;
4399 stack->chunk = next;
4400 stack->index = 0;
4401}
4402
4403static void
4404pop_mark_stack_chunk(mark_stack_t *stack)
4405{
4406 stack_chunk_t *prev;
4407
4408 prev = stack->chunk->next;
4409 GC_ASSERT(stack->index == 0);
4410 add_stack_chunk_cache(stack, stack->chunk);
4411 stack->chunk = prev;
4412 stack->index = stack->limit;
4413}
4414
4415static void
4416mark_stack_chunk_list_free(stack_chunk_t *chunk)
4417{
4418 stack_chunk_t *next = NULL;
4419
4420 while (chunk != NULL) {
4421 next = chunk->next;
4422 free(chunk);
4423 chunk = next;
4424 }
4425}
4426
4427static void
4428free_stack_chunks(mark_stack_t *stack)
4429{
4430 mark_stack_chunk_list_free(stack->chunk);
4431}
4432
4433static void
4434mark_stack_free_cache(mark_stack_t *stack)
4435{
4436 mark_stack_chunk_list_free(stack->cache);
4437 stack->cache_size = 0;
4438 stack->unused_cache_size = 0;
4439}
4440
4441static void
4442push_mark_stack(mark_stack_t *stack, VALUE obj)
4443{
4444 switch (BUILTIN_TYPE(obj)) {
4445 case T_OBJECT:
4446 case T_CLASS:
4447 case T_MODULE:
4448 case T_FLOAT:
4449 case T_STRING:
4450 case T_REGEXP:
4451 case T_ARRAY:
4452 case T_HASH:
4453 case T_STRUCT:
4454 case T_BIGNUM:
4455 case T_FILE:
4456 case T_DATA:
4457 case T_MATCH:
4458 case T_COMPLEX:
4459 case T_RATIONAL:
4460 case T_TRUE:
4461 case T_FALSE:
4462 case T_SYMBOL:
4463 case T_IMEMO:
4464 case T_ICLASS:
4465 if (stack->index == stack->limit) {
4466 push_mark_stack_chunk(stack);
4467 }
4468 stack->chunk->data[stack->index++] = obj;
4469 return;
4470
4471 case T_NONE:
4472 case T_NIL:
4473 case T_FIXNUM:
4474 case T_MOVED:
4475 case T_ZOMBIE:
4476 case T_UNDEF:
4477 case T_MASK:
4478 rb_bug("push_mark_stack() called for broken object");
4479 break;
4480
4481 case T_NODE:
4482 rb_bug("push_mark_stack: unexpected T_NODE object");
4483 break;
4484 }
4485
4486 rb_bug("rb_gc_mark(): unknown data type 0x%x(%p) %s",
4487 BUILTIN_TYPE(obj), (void *)obj,
4488 is_pointer_to_heap((rb_objspace_t *)rb_gc_get_objspace(), (void *)obj) ? "corrupted object" : "non object");
4489}
4490
4491static int
4492pop_mark_stack(mark_stack_t *stack, VALUE *data)
4493{
4494 if (is_mark_stack_empty(stack)) {
4495 return FALSE;
4496 }
4497 if (stack->index == 1) {
4498 *data = stack->chunk->data[--stack->index];
4499 pop_mark_stack_chunk(stack);
4500 }
4501 else {
4502 *data = stack->chunk->data[--stack->index];
4503 }
4504 return TRUE;
4505}
4506
4507static void
4508init_mark_stack(mark_stack_t *stack)
4509{
4510 int i;
4511
4512 MEMZERO(stack, mark_stack_t, 1);
4513 stack->index = stack->limit = STACK_CHUNK_SIZE;
4514
4515 for (i=0; i < 4; i++) {
4516 add_stack_chunk_cache(stack, stack_chunk_alloc());
4517 }
4518 stack->unused_cache_size = stack->cache_size;
4519}
4520
4521/* Marking */
4522
4523static void
4524rgengc_check_relation(rb_objspace_t *objspace, VALUE obj)
4525{
4526 if (objspace->rgengc.parent_object_old_p) {
4527 if (RVALUE_WB_UNPROTECTED(objspace, obj) || !RVALUE_OLD_P(objspace, obj)) {
4528 rgengc_remember(objspace, objspace->rgengc.parent_object);
4529 }
4530 }
4531}
4532
4533static inline int
4534gc_mark_set(rb_objspace_t *objspace, VALUE obj)
4535{
4536 if (RVALUE_MARKED(objspace, obj)) return 0;
4537 MARK_IN_BITMAP(GET_HEAP_MARK_BITS(obj), obj);
4538 return 1;
4539}
4540
4541static void
4542gc_aging(rb_objspace_t *objspace, VALUE obj)
4543{
4544 /* Disable aging if Major GC's are disabled. This will prevent longish lived
4545 * objects filling up the heap at the expense of marking many more objects.
4546 *
4547 * We should always pre-warm our process when disabling majors, by running
4548 * GC manually several times so that most objects likely to become oldgen
4549 * are already oldgen.
4550 */
4551 if(!gc_config_full_mark_val)
4552 return;
4553
4554 struct heap_page *page = GET_HEAP_PAGE(obj);
4555
4556 GC_ASSERT(RVALUE_MARKING(objspace, obj) == FALSE);
4557 check_rvalue_consistency(objspace, obj);
4558
4559 if (!RVALUE_PAGE_WB_UNPROTECTED(page, obj)) {
4560 if (!RVALUE_OLD_P(objspace, obj)) {
4561 int t = BUILTIN_TYPE(obj);
4562 if (t == T_CLASS || t == T_MODULE || t == T_ICLASS) {
4563 gc_report(3, objspace, "gc_aging: YOUNG class: %s\n", rb_obj_info(obj));
4564 RVALUE_AGE_SET(obj, RVALUE_OLD_AGE);
4565 RVALUE_OLD_UNCOLLECTIBLE_SET(objspace, obj);
4566 }
4567 else {
4568 gc_report(3, objspace, "gc_aging: YOUNG: %s\n", rb_obj_info(obj));
4569 RVALUE_AGE_INC(objspace, obj);
4570 }
4571 }
4572 else if (is_full_marking(objspace)) {
4573 GC_ASSERT(RVALUE_PAGE_UNCOLLECTIBLE(page, obj) == FALSE);
4574 RVALUE_PAGE_OLD_UNCOLLECTIBLE_SET(objspace, page, obj);
4575 }
4576 }
4577 check_rvalue_consistency(objspace, obj);
4578
4579 objspace->marked_slots++;
4580}
4581
4582static void
4583gc_grey(rb_objspace_t *objspace, VALUE obj)
4584{
4585#if RGENGC_CHECK_MODE
4586 if (RVALUE_MARKED(objspace, obj) == FALSE) rb_bug("gc_grey: %s is not marked.", rb_obj_info(obj));
4587 if (RVALUE_MARKING(objspace, obj) == TRUE) rb_bug("gc_grey: %s is marking/remembered.", rb_obj_info(obj));
4588#endif
4589
4590 if (is_incremental_marking(objspace)) {
4591 MARK_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), obj);
4592 }
4593
4595 rb_darray_append_without_gc(&objspace->weak_references, obj);
4596 }
4597
4598 push_mark_stack(&objspace->mark_stack, obj);
4599}
4600
4601static inline void
4602gc_mark_check_t_none(rb_objspace_t *objspace, VALUE obj)
4603{
4604 if (RB_UNLIKELY(BUILTIN_TYPE(obj) == T_NONE)) {
4605 enum {info_size = 256};
4606 char obj_info_buf[info_size];
4607 rb_raw_obj_info(obj_info_buf, info_size, obj);
4608
4609 char parent_obj_info_buf[info_size];
4610 rb_raw_obj_info(parent_obj_info_buf, info_size, objspace->rgengc.parent_object);
4611
4612 rb_bug("try to mark T_NONE object (obj: %s, parent: %s)", obj_info_buf, parent_obj_info_buf);
4613 }
4614}
4615
4616static void
4617gc_mark(rb_objspace_t *objspace, VALUE obj)
4618{
4619 GC_ASSERT(during_gc);
4620 GC_ASSERT(!objspace->flags.during_reference_updating);
4621
4622 rgengc_check_relation(objspace, obj);
4623 if (!gc_mark_set(objspace, obj)) return; /* already marked */
4624
4625 if (0) { // for debug GC marking miss
4626 RUBY_DEBUG_LOG("%p (%s) parent:%p (%s)",
4627 (void *)obj, obj_type_name(obj),
4628 (void *)objspace->rgengc.parent_object, obj_type_name(objspace->rgengc.parent_object));
4629 }
4630
4631 gc_mark_check_t_none(objspace, obj);
4632
4633 gc_aging(objspace, obj);
4634 gc_grey(objspace, obj);
4635}
4636
4637static inline void
4638gc_pin(rb_objspace_t *objspace, VALUE obj)
4639{
4640 GC_ASSERT(!SPECIAL_CONST_P(obj));
4641 if (RB_UNLIKELY(objspace->flags.during_compacting)) {
4642 if (RB_LIKELY(during_gc)) {
4643 if (!RVALUE_PINNED(objspace, obj)) {
4644 GC_ASSERT(GET_HEAP_PAGE(obj)->pinned_slots <= GET_HEAP_PAGE(obj)->total_slots);
4645 GET_HEAP_PAGE(obj)->pinned_slots++;
4646 MARK_IN_BITMAP(GET_HEAP_PINNED_BITS(obj), obj);
4647 }
4648 }
4649 }
4650}
4651
4652static inline void
4653gc_mark_and_pin(rb_objspace_t *objspace, VALUE obj)
4654{
4655 gc_pin(objspace, obj);
4656 gc_mark(objspace, obj);
4657}
4658
4659void
4660rb_gc_impl_mark_and_move(void *objspace_ptr, VALUE *ptr)
4661{
4662 rb_objspace_t *objspace = objspace_ptr;
4663
4664 if (RB_UNLIKELY(objspace->flags.during_reference_updating)) {
4665 GC_ASSERT(objspace->flags.during_compacting);
4666 GC_ASSERT(during_gc);
4667
4668 VALUE destination = rb_gc_impl_location(objspace, *ptr);
4669 if (destination != *ptr) {
4670 *ptr = destination;
4671 }
4672 }
4673 else {
4674 gc_mark(objspace, *ptr);
4675 }
4676}
4677
4678void
4679rb_gc_impl_mark(void *objspace_ptr, VALUE obj)
4680{
4681 rb_objspace_t *objspace = objspace_ptr;
4682
4683 gc_mark(objspace, obj);
4684}
4685
4686void
4687rb_gc_impl_mark_and_pin(void *objspace_ptr, VALUE obj)
4688{
4689 rb_objspace_t *objspace = objspace_ptr;
4690
4691 gc_mark_and_pin(objspace, obj);
4692}
4693
4694void
4695rb_gc_impl_mark_maybe(void *objspace_ptr, VALUE obj)
4696{
4697 rb_objspace_t *objspace = objspace_ptr;
4698
4699 (void)VALGRIND_MAKE_MEM_DEFINED(&obj, sizeof(obj));
4700
4701 if (is_pointer_to_heap(objspace, (void *)obj)) {
4702 asan_unpoisoning_object(obj) {
4703 /* Garbage can live on the stack, so do not mark or pin */
4704 switch (BUILTIN_TYPE(obj)) {
4705 case T_ZOMBIE:
4706 case T_NONE:
4707 break;
4708 default:
4709 gc_mark_and_pin(objspace, obj);
4710 break;
4711 }
4712 }
4713 }
4714}
4715
4716static int
4717pin_value(st_data_t key, st_data_t value, st_data_t data)
4718{
4719 rb_gc_impl_mark_and_pin((void *)data, (VALUE)value);
4720
4721 return ST_CONTINUE;
4722}
4723
4724static inline void
4725gc_mark_set_parent_raw(rb_objspace_t *objspace, VALUE obj, bool old_p)
4726{
4727 asan_unpoison_memory_region(&objspace->rgengc.parent_object, sizeof(objspace->rgengc.parent_object), false);
4728 asan_unpoison_memory_region(&objspace->rgengc.parent_object_old_p, sizeof(objspace->rgengc.parent_object_old_p), false);
4729 objspace->rgengc.parent_object = obj;
4730 objspace->rgengc.parent_object_old_p = old_p;
4731}
4732
4733static inline void
4734gc_mark_set_parent(rb_objspace_t *objspace, VALUE obj)
4735{
4736 gc_mark_set_parent_raw(objspace, obj, RVALUE_OLD_P(objspace, obj));
4737}
4738
4739static inline void
4740gc_mark_set_parent_invalid(rb_objspace_t *objspace)
4741{
4742 asan_poison_memory_region(&objspace->rgengc.parent_object, sizeof(objspace->rgengc.parent_object));
4743 asan_poison_memory_region(&objspace->rgengc.parent_object_old_p, sizeof(objspace->rgengc.parent_object_old_p));
4744}
4745
4746static void
4747mark_roots(rb_objspace_t *objspace, const char **categoryp)
4748{
4749#define MARK_CHECKPOINT(category) do { \
4750 if (categoryp) *categoryp = category; \
4751} while (0)
4752
4753 MARK_CHECKPOINT("objspace");
4754 gc_mark_set_parent_raw(objspace, Qundef, false);
4755
4756 if (finalizer_table != NULL) {
4757 st_foreach(finalizer_table, pin_value, (st_data_t)objspace);
4758 }
4759
4760 if (stress_to_class) rb_gc_mark(stress_to_class);
4761
4762 rb_gc_save_machine_context();
4763 rb_gc_mark_roots(objspace, categoryp);
4764 gc_mark_set_parent_invalid(objspace);
4765}
4766
4767static void
4768gc_mark_children(rb_objspace_t *objspace, VALUE obj)
4769{
4770 gc_mark_set_parent(objspace, obj);
4771 rb_gc_mark_children(objspace, obj);
4772 gc_mark_set_parent_invalid(objspace);
4773}
4774
4779static inline int
4780gc_mark_stacked_objects(rb_objspace_t *objspace, int incremental, size_t count)
4781{
4782 mark_stack_t *mstack = &objspace->mark_stack;
4783 VALUE obj;
4784 size_t marked_slots_at_the_beginning = objspace->marked_slots;
4785 size_t popped_count = 0;
4786
4787 while (pop_mark_stack(mstack, &obj)) {
4788 if (obj == Qundef) continue; /* skip */
4789
4790 if (RGENGC_CHECK_MODE && !RVALUE_MARKED(objspace, obj)) {
4791 rb_bug("gc_mark_stacked_objects: %s is not marked.", rb_obj_info(obj));
4792 }
4793 gc_mark_children(objspace, obj);
4794
4795 if (incremental) {
4796 if (RGENGC_CHECK_MODE && !RVALUE_MARKING(objspace, obj)) {
4797 rb_bug("gc_mark_stacked_objects: incremental, but marking bit is 0");
4798 }
4799 CLEAR_IN_BITMAP(GET_HEAP_MARKING_BITS(obj), obj);
4800 popped_count++;
4801
4802 if (popped_count + (objspace->marked_slots - marked_slots_at_the_beginning) > count) {
4803 break;
4804 }
4805 }
4806 else {
4807 /* just ignore marking bits */
4808 }
4809 }
4810
4811 if (RGENGC_CHECK_MODE >= 3) gc_verify_internal_consistency(objspace);
4812
4813 if (is_mark_stack_empty(mstack)) {
4814 shrink_stack_chunk_cache(mstack);
4815 return TRUE;
4816 }
4817 else {
4818 return FALSE;
4819 }
4820}
4821
4822static int
4823gc_mark_stacked_objects_incremental(rb_objspace_t *objspace, size_t count)
4824{
4825 return gc_mark_stacked_objects(objspace, TRUE, count);
4826}
4827
4828static int
4829gc_mark_stacked_objects_all(rb_objspace_t *objspace)
4830{
4831 return gc_mark_stacked_objects(objspace, FALSE, 0);
4832}
4833
4834#if RGENGC_CHECK_MODE >= 4
4835
4836#define MAKE_ROOTSIG(obj) (((VALUE)(obj) << 1) | 0x01)
4837#define IS_ROOTSIG(obj) ((VALUE)(obj) & 0x01)
4838#define GET_ROOTSIG(obj) ((const char *)((VALUE)(obj) >> 1))
4839
4840struct reflist {
4841 VALUE *list;
4842 int pos;
4843 int size;
4844};
4845
4846static struct reflist *
4847reflist_create(VALUE obj)
4848{
4849 struct reflist *refs = xmalloc(sizeof(struct reflist));
4850 refs->size = 1;
4851 refs->list = ALLOC_N(VALUE, refs->size);
4852 refs->list[0] = obj;
4853 refs->pos = 1;
4854 return refs;
4855}
4856
4857static void
4858reflist_destruct(struct reflist *refs)
4859{
4860 xfree(refs->list);
4861 xfree(refs);
4862}
4863
4864static void
4865reflist_add(struct reflist *refs, VALUE obj)
4866{
4867 if (refs->pos == refs->size) {
4868 refs->size *= 2;
4869 SIZED_REALLOC_N(refs->list, VALUE, refs->size, refs->size/2);
4870 }
4871
4872 refs->list[refs->pos++] = obj;
4873}
4874
4875static void
4876reflist_dump(struct reflist *refs)
4877{
4878 int i;
4879 for (i=0; i<refs->pos; i++) {
4880 VALUE obj = refs->list[i];
4881 if (IS_ROOTSIG(obj)) { /* root */
4882 fprintf(stderr, "<root@%s>", GET_ROOTSIG(obj));
4883 }
4884 else {
4885 fprintf(stderr, "<%s>", rb_obj_info(obj));
4886 }
4887 if (i+1 < refs->pos) fprintf(stderr, ", ");
4888 }
4889}
4890
4891static int
4892reflist_referred_from_machine_context(struct reflist *refs)
4893{
4894 int i;
4895 for (i=0; i<refs->pos; i++) {
4896 VALUE obj = refs->list[i];
4897 if (IS_ROOTSIG(obj) && strcmp(GET_ROOTSIG(obj), "machine_context") == 0) return 1;
4898 }
4899 return 0;
4900}
4901
4902struct allrefs {
4904 /* a -> obj1
4905 * b -> obj1
4906 * c -> obj1
4907 * c -> obj2
4908 * d -> obj3
4909 * #=> {obj1 => [a, b, c], obj2 => [c, d]}
4910 */
4911 struct st_table *references;
4912 const char *category;
4913 VALUE root_obj;
4915};
4916
4917static int
4918allrefs_add(struct allrefs *data, VALUE obj)
4919{
4920 struct reflist *refs;
4921 st_data_t r;
4922
4923 if (st_lookup(data->references, obj, &r)) {
4924 refs = (struct reflist *)r;
4925 reflist_add(refs, data->root_obj);
4926 return 0;
4927 }
4928 else {
4929 refs = reflist_create(data->root_obj);
4930 st_insert(data->references, obj, (st_data_t)refs);
4931 return 1;
4932 }
4933}
4934
4935static void
4936allrefs_i(VALUE obj, void *ptr)
4937{
4938 struct allrefs *data = (struct allrefs *)ptr;
4939
4940 if (allrefs_add(data, obj)) {
4941 push_mark_stack(&data->mark_stack, obj);
4942 }
4943}
4944
4945static void
4946allrefs_roots_i(VALUE obj, void *ptr)
4947{
4948 struct allrefs *data = (struct allrefs *)ptr;
4949 if (strlen(data->category) == 0) rb_bug("!!!");
4950 data->root_obj = MAKE_ROOTSIG(data->category);
4951
4952 if (allrefs_add(data, obj)) {
4953 push_mark_stack(&data->mark_stack, obj);
4954 }
4955}
4956#define PUSH_MARK_FUNC_DATA(v) do { \
4957 struct gc_mark_func_data_struct *prev_mark_func_data = GET_VM()->gc.mark_func_data; \
4958 GET_VM()->gc.mark_func_data = (v);
4959
4960#define POP_MARK_FUNC_DATA() GET_VM()->gc.mark_func_data = prev_mark_func_data;} while (0)
4961
4962static st_table *
4963objspace_allrefs(rb_objspace_t *objspace)
4964{
4965 struct allrefs data;
4966 struct gc_mark_func_data_struct mfd;
4967 VALUE obj;
4968 int prev_dont_gc = dont_gc_val();
4969 dont_gc_on();
4970
4971 data.objspace = objspace;
4972 data.references = st_init_numtable();
4973 init_mark_stack(&data.mark_stack);
4974
4975 mfd.mark_func = allrefs_roots_i;
4976 mfd.data = &data;
4977
4978 /* traverse root objects */
4979 PUSH_MARK_FUNC_DATA(&mfd);
4980 GET_VM()->gc.mark_func_data = &mfd;
4981 mark_roots(objspace, &data.category);
4982 POP_MARK_FUNC_DATA();
4983
4984 /* traverse rest objects reachable from root objects */
4985 while (pop_mark_stack(&data.mark_stack, &obj)) {
4986 rb_objspace_reachable_objects_from(data.root_obj = obj, allrefs_i, &data);
4987 }
4988 free_stack_chunks(&data.mark_stack);
4989
4990 dont_gc_set(prev_dont_gc);
4991 return data.references;
4992}
4993
4994static int
4995objspace_allrefs_destruct_i(st_data_t key, st_data_t value, st_data_t ptr)
4996{
4997 struct reflist *refs = (struct reflist *)value;
4998 reflist_destruct(refs);
4999 return ST_CONTINUE;
5000}
5001
5002static void
5003objspace_allrefs_destruct(struct st_table *refs)
5004{
5005 st_foreach(refs, objspace_allrefs_destruct_i, 0);
5006 st_free_table(refs);
5007}
5008
5009#if RGENGC_CHECK_MODE >= 5
5010static int
5011allrefs_dump_i(st_data_t k, st_data_t v, st_data_t ptr)
5012{
5013 VALUE obj = (VALUE)k;
5014 struct reflist *refs = (struct reflist *)v;
5015 fprintf(stderr, "[allrefs_dump_i] %s <- ", rb_obj_info(obj));
5016 reflist_dump(refs);
5017 fprintf(stderr, "\n");
5018 return ST_CONTINUE;
5019}
5020
5021static void
5022allrefs_dump(rb_objspace_t *objspace)
5023{
5024 VALUE size = objspace->rgengc.allrefs_table->num_entries;
5025 fprintf(stderr, "[all refs] (size: %"PRIuVALUE")\n", size);
5026 st_foreach(objspace->rgengc.allrefs_table, allrefs_dump_i, 0);
5027}
5028#endif
5029
5030static int
5031gc_check_after_marks_i(st_data_t k, st_data_t v, st_data_t ptr)
5032{
5033 VALUE obj = k;
5034 struct reflist *refs = (struct reflist *)v;
5036
5037 /* object should be marked or oldgen */
5038 if (!RVALUE_MARKED(objspace, obj)) {
5039 fprintf(stderr, "gc_check_after_marks_i: %s is not marked and not oldgen.\n", rb_obj_info(obj));
5040 fprintf(stderr, "gc_check_after_marks_i: %p is referred from ", (void *)obj);
5041 reflist_dump(refs);
5042
5043 if (reflist_referred_from_machine_context(refs)) {
5044 fprintf(stderr, " (marked from machine stack).\n");
5045 /* marked from machine context can be false positive */
5046 }
5047 else {
5048 objspace->rgengc.error_count++;
5049 fprintf(stderr, "\n");
5050 }
5051 }
5052 return ST_CONTINUE;
5053}
5054
5055static void
5056gc_marks_check(rb_objspace_t *objspace, st_foreach_callback_func *checker_func, const char *checker_name)
5057{
5058 MALLOC_COUNTERS_LOCK(objspace);
5059 struct gc_malloc_bytes saved_malloc = {
5060 .malloc = gc_counter_load_relaxed(&objspace->malloc_counters.counters.malloc),
5061 .free = gc_counter_load_relaxed(&objspace->malloc_counters.counters.free),
5062 .malloc_at_last_gc = gc_counter_load_relaxed(&objspace->malloc_counters.counters.malloc_at_last_gc),
5063 .free_at_last_gc = gc_counter_load_relaxed(&objspace->malloc_counters.counters.free_at_last_gc),
5064 };
5065#if RGENGC_ESTIMATE_OLDMALLOC
5066 struct gc_malloc_bytes saved_oldmalloc = {
5067 .malloc = gc_counter_load_relaxed(&objspace->malloc_counters.oldcounters.malloc),
5068 .free = gc_counter_load_relaxed(&objspace->malloc_counters.oldcounters.free),
5069 .malloc_at_last_gc = gc_counter_load_relaxed(&objspace->malloc_counters.oldcounters.malloc_at_last_gc),
5070 .free_at_last_gc = gc_counter_load_relaxed(&objspace->malloc_counters.oldcounters.free_at_last_gc),
5071 };
5072#endif
5073 MALLOC_COUNTERS_UNLOCK(objspace);
5074 VALUE already_disabled = rb_objspace_gc_disable(objspace);
5075
5076 objspace->rgengc.allrefs_table = objspace_allrefs(objspace);
5077
5078 if (checker_func) {
5079 st_foreach(objspace->rgengc.allrefs_table, checker_func, (st_data_t)objspace);
5080 }
5081
5082 if (objspace->rgengc.error_count > 0) {
5083#if RGENGC_CHECK_MODE >= 5
5084 allrefs_dump(objspace);
5085#endif
5086 if (checker_name) rb_bug("%s: GC has problem.", checker_name);
5087 }
5088
5089 objspace_allrefs_destruct(objspace->rgengc.allrefs_table);
5090 objspace->rgengc.allrefs_table = 0;
5091
5092 if (already_disabled == Qfalse) rb_objspace_gc_enable(objspace);
5093 MALLOC_COUNTERS_LOCK(objspace);
5094 gc_counter_store_release(&objspace->malloc_counters.counters.malloc, saved_malloc.malloc);
5095 gc_counter_store_release(&objspace->malloc_counters.counters.free, saved_malloc.free);
5096 gc_counter_store_release(&objspace->malloc_counters.counters.malloc_at_last_gc, saved_malloc.malloc_at_last_gc);
5097 gc_counter_store_release(&objspace->malloc_counters.counters.free_at_last_gc, saved_malloc.free_at_last_gc);
5098#if RGENGC_ESTIMATE_OLDMALLOC
5099 gc_counter_store_release(&objspace->malloc_counters.oldcounters.malloc, saved_oldmalloc.malloc);
5100 gc_counter_store_release(&objspace->malloc_counters.oldcounters.free, saved_oldmalloc.free);
5101 gc_counter_store_release(&objspace->malloc_counters.oldcounters.malloc_at_last_gc, saved_oldmalloc.malloc_at_last_gc);
5102 gc_counter_store_release(&objspace->malloc_counters.oldcounters.free_at_last_gc, saved_oldmalloc.free_at_last_gc);
5103#endif
5104 MALLOC_COUNTERS_UNLOCK(objspace);
5105}
5106#endif /* RGENGC_CHECK_MODE >= 4 */
5107
5110 int err_count;
5111 size_t live_object_count;
5112 size_t zombie_object_count;
5113
5114 VALUE parent;
5115 size_t old_object_count;
5116 size_t remembered_shady_count;
5117};
5118
5119static void
5120check_generation_i(const VALUE child, void *ptr)
5121{
5123 const VALUE parent = data->parent;
5124
5125 if (RGENGC_CHECK_MODE) GC_ASSERT(RVALUE_OLD_P(data->objspace, parent));
5126
5127 if (!RVALUE_OLD_P(data->objspace, child)) {
5128 if (!RVALUE_REMEMBERED(data->objspace, parent) &&
5129 !RVALUE_REMEMBERED(data->objspace, child) &&
5130 !RVALUE_UNCOLLECTIBLE(data->objspace, child)) {
5131 fprintf(stderr, "verify_internal_consistency_reachable_i: WB miss (O->Y) %s -> %s\n", rb_obj_info(parent), rb_obj_info(child));
5132 data->err_count++;
5133 }
5134 }
5135}
5136
5137static void
5138check_color_i(const VALUE child, void *ptr)
5139{
5141 const VALUE parent = data->parent;
5142
5143 if (!RVALUE_WB_UNPROTECTED(data->objspace, parent) && RVALUE_WHITE_P(data->objspace, child)) {
5144 fprintf(stderr, "verify_internal_consistency_reachable_i: WB miss (B->W) - %s -> %s\n",
5145 rb_obj_info(parent), rb_obj_info(child));
5146 data->err_count++;
5147 }
5148}
5149
5150static void
5151check_children_i(const VALUE child, void *ptr)
5152{
5154 if (check_rvalue_consistency_force(data->objspace, child, FALSE) != 0) {
5155 fprintf(stderr, "check_children_i: %s has error (referenced from %s)",
5156 rb_obj_info(child), rb_obj_info(data->parent));
5157
5158 data->err_count++;
5159 }
5160}
5161
5162static int
5163verify_internal_consistency_i(void *page_start, void *page_end, size_t stride,
5165{
5166 VALUE obj;
5167 rb_objspace_t *objspace = data->objspace;
5168
5169 for (obj = (VALUE)page_start; obj != (VALUE)page_end; obj += stride) {
5170 asan_unpoisoning_object(obj) {
5171 if (!rb_gc_impl_garbage_object_p(objspace, obj)) {
5172 /* count objects */
5173 data->live_object_count++;
5174 data->parent = obj;
5175
5176 /* Normally, we don't expect T_MOVED objects to be in the heap.
5177 * But they can stay alive on the stack, */
5178 if (!gc_object_moved_p(objspace, obj)) {
5179 /* moved slots don't have children */
5180 rb_objspace_reachable_objects_from(obj, check_children_i, (void *)data);
5181 }
5182
5183 /* check health of children */
5184 if (RVALUE_OLD_P(objspace, obj)) data->old_object_count++;
5185 if (RVALUE_WB_UNPROTECTED(objspace, obj) && RVALUE_UNCOLLECTIBLE(objspace, obj)) data->remembered_shady_count++;
5186
5187 if (!is_marking(objspace) && RVALUE_OLD_P(objspace, obj)) {
5188 /* reachable objects from an oldgen object should be old or (young with remember) */
5189 data->parent = obj;
5190 rb_objspace_reachable_objects_from(obj, check_generation_i, (void *)data);
5191 }
5192
5193 if (!is_marking(objspace) && rb_gc_obj_shareable_p(obj)) {
5194 rb_gc_verify_shareable(obj);
5195 }
5196
5197 if (is_incremental_marking(objspace)) {
5198 if (RVALUE_BLACK_P(objspace, obj)) {
5199 /* reachable objects from black objects should be black or grey objects */
5200 data->parent = obj;
5201 rb_objspace_reachable_objects_from(obj, check_color_i, (void *)data);
5202 }
5203 }
5204 }
5205 else {
5206 if (BUILTIN_TYPE(obj) == T_ZOMBIE) {
5207 data->zombie_object_count++;
5208
5209 if ((RBASIC(obj)->flags & ~ZOMBIE_OBJ_KEPT_FLAGS) != T_ZOMBIE) {
5210 fprintf(stderr, "verify_internal_consistency_i: T_ZOMBIE has extra flags set: %s\n",
5211 rb_obj_info(obj));
5212 data->err_count++;
5213 }
5214
5215 if (!!FL_TEST(obj, FL_FINALIZE) != !!st_is_member(finalizer_table, obj)) {
5216 fprintf(stderr, "verify_internal_consistency_i: FL_FINALIZE %s but %s finalizer_table: %s\n",
5217 FL_TEST(obj, FL_FINALIZE) ? "set" : "not set", st_is_member(finalizer_table, obj) ? "in" : "not in",
5218 rb_obj_info(obj));
5219 data->err_count++;
5220 }
5221 }
5222 }
5223 }
5224 }
5225
5226 return 0;
5227}
5228
5229static int
5230gc_verify_heap_page(rb_objspace_t *objspace, struct heap_page *page, VALUE obj)
5231{
5232 unsigned int has_remembered_shady = FALSE;
5233 unsigned int has_remembered_old = FALSE;
5234 int remembered_old_objects = 0;
5235 int free_objects = 0;
5236 int zombie_objects = 0;
5237
5238 short slot_size = page->slot_size;
5239 uintptr_t start = (uintptr_t)page->start;
5240 uintptr_t end = start + page->total_slots * slot_size;
5241
5242 for (uintptr_t ptr = start; ptr < end; ptr += slot_size) {
5243 VALUE val = (VALUE)ptr;
5244 asan_unpoisoning_object(val) {
5245 enum ruby_value_type type = BUILTIN_TYPE(val);
5246
5247 if (type == T_NONE) free_objects++;
5248 if (type == T_ZOMBIE) zombie_objects++;
5249 if (RVALUE_PAGE_UNCOLLECTIBLE(page, val) && RVALUE_PAGE_WB_UNPROTECTED(page, val)) {
5250 has_remembered_shady = TRUE;
5251 }
5252 if (RVALUE_PAGE_MARKING(page, val)) {
5253 has_remembered_old = TRUE;
5254 remembered_old_objects++;
5255 }
5256 }
5257 }
5258
5259 if (!is_incremental_marking(objspace) &&
5260 page->flags.has_remembered_objects == FALSE && has_remembered_old == TRUE) {
5261
5262 for (uintptr_t ptr = start; ptr < end; ptr += slot_size) {
5263 VALUE val = (VALUE)ptr;
5264 if (RVALUE_PAGE_MARKING(page, val)) {
5265 fprintf(stderr, "marking -> %s\n", rb_obj_info(val));
5266 }
5267 }
5268 rb_bug("page %p's has_remembered_objects should be false, but there are remembered old objects (%d). %s",
5269 (void *)page, remembered_old_objects, obj ? rb_obj_info(obj) : "");
5270 }
5271
5272 if (page->flags.has_uncollectible_wb_unprotected_objects == FALSE && has_remembered_shady == TRUE) {
5273 rb_bug("page %p's has_remembered_shady should be false, but there are remembered shady objects. %s",
5274 (void *)page, obj ? rb_obj_info(obj) : "");
5275 }
5276
5277 if (0) {
5278 /* free_slots may not equal to free_objects */
5279 if (page->free_slots != free_objects) {
5280 rb_bug("page %p's free_slots should be %d, but %d", (void *)page, page->free_slots, free_objects);
5281 }
5282 }
5283 if (page->final_slots != zombie_objects) {
5284 rb_bug("page %p's final_slots should be %d, but %d", (void *)page, page->final_slots, zombie_objects);
5285 }
5286
5287 return remembered_old_objects;
5288}
5289
5290static int
5291gc_verify_heap_pages_(rb_objspace_t *objspace, struct ccan_list_head *head)
5292{
5293 int remembered_old_objects = 0;
5294 struct heap_page *page = 0;
5295
5296 ccan_list_for_each(head, page, page_node) {
5297 asan_unlock_freelist(page);
5298 struct free_slot *p = page->freelist;
5299 while (p) {
5300 VALUE vp = (VALUE)p;
5301 VALUE prev = vp;
5302 rb_asan_unpoison_object(vp, false);
5303 if (BUILTIN_TYPE(vp) != T_NONE) {
5304 fprintf(stderr, "freelist slot expected to be T_NONE but was: %s\n", rb_obj_info(vp));
5305 }
5306 p = p->next;
5307 rb_asan_poison_object(prev);
5308 }
5309 asan_lock_freelist(page);
5310
5311 if (page->flags.has_remembered_objects == FALSE) {
5312 remembered_old_objects += gc_verify_heap_page(objspace, page, Qfalse);
5313 }
5314 }
5315
5316 return remembered_old_objects;
5317}
5318
5319static int
5320gc_verify_heap_pages(rb_objspace_t *objspace)
5321{
5322 int remembered_old_objects = 0;
5323 for (int i = 0; i < HEAP_COUNT; i++) {
5324 remembered_old_objects += gc_verify_heap_pages_(objspace, &((&heaps[i])->pages));
5325 }
5326 return remembered_old_objects;
5327}
5328
5329static void
5330gc_verify_internal_consistency_(rb_objspace_t *objspace)
5331{
5332 struct verify_internal_consistency_struct data = {0};
5333
5334 data.objspace = objspace;
5335 gc_report(5, objspace, "gc_verify_internal_consistency: start\n");
5336
5337 /* check relations */
5338 for (size_t i = 0; i < rb_darray_size(objspace->heap_pages.sorted); i++) {
5339 struct heap_page *page = rb_darray_get(objspace->heap_pages.sorted, i);
5340 short slot_size = page->slot_size;
5341
5342 uintptr_t start = (uintptr_t)page->start;
5343 uintptr_t end = start + page->total_slots * slot_size;
5344
5345 verify_internal_consistency_i((void *)start, (void *)end, slot_size, &data);
5346 }
5347
5348 if (data.err_count != 0) {
5349#if RGENGC_CHECK_MODE >= 5
5350 objspace->rgengc.error_count = data.err_count;
5351 gc_marks_check(objspace, NULL, NULL);
5352 allrefs_dump(objspace);
5353#endif
5354 rb_bug("gc_verify_internal_consistency: found internal inconsistency.");
5355 }
5356
5357 /* check heap_page status */
5358 gc_verify_heap_pages(objspace);
5359
5360 /* check counters */
5361
5362 ractor_cache_flush_count(objspace, rb_gc_get_ractor_newobj_cache());
5363
5364 if (!is_lazy_sweeping(objspace) &&
5365 !finalizing &&
5366 !rb_gc_multi_ractor_p()) {
5367 if (objspace_live_slots(objspace) != data.live_object_count) {
5368 fprintf(stderr, "heap_pages_final_slots: %"PRIdSIZE", total_freed_objects: %"PRIdSIZE"\n",
5369 total_final_slots_count(objspace), total_freed_objects(objspace));
5370 rb_bug("inconsistent live slot number: expect %"PRIuSIZE", but %"PRIuSIZE".",
5371 objspace_live_slots(objspace), data.live_object_count);
5372 }
5373 }
5374
5375 if (!is_marking(objspace)) {
5376 if (objspace->rgengc.old_objects != data.old_object_count) {
5377 rb_bug("inconsistent old slot number: expect %"PRIuSIZE", but %"PRIuSIZE".",
5378 objspace->rgengc.old_objects, data.old_object_count);
5379 }
5380 if (objspace->rgengc.uncollectible_wb_unprotected_objects != data.remembered_shady_count) {
5381 rb_bug("inconsistent number of wb unprotected objects: expect %"PRIuSIZE", but %"PRIuSIZE".",
5382 objspace->rgengc.uncollectible_wb_unprotected_objects, data.remembered_shady_count);
5383 }
5384 }
5385
5386 if (!finalizing) {
5387 size_t list_count = 0;
5388
5389 {
5390 VALUE z = heap_pages_deferred_final;
5391 while (z) {
5392 list_count++;
5393 z = RZOMBIE(z)->next;
5394 }
5395 }
5396
5397 if (total_final_slots_count(objspace) != data.zombie_object_count ||
5398 total_final_slots_count(objspace) != list_count) {
5399
5400 rb_bug("inconsistent finalizing object count:\n"
5401 " expect %"PRIuSIZE"\n"
5402 " but %"PRIuSIZE" zombies\n"
5403 " heap_pages_deferred_final list has %"PRIuSIZE" items.",
5404 total_final_slots_count(objspace),
5405 data.zombie_object_count,
5406 list_count);
5407 }
5408 }
5409
5410 gc_report(5, objspace, "gc_verify_internal_consistency: OK\n");
5411}
5412
5413static void
5414gc_verify_internal_consistency(void *objspace_ptr)
5415{
5416 rb_objspace_t *objspace = objspace_ptr;
5417
5418 unsigned int lev = RB_GC_VM_LOCK();
5419 {
5420 rb_gc_vm_barrier(); // stop other ractors
5421
5422 unsigned int prev_during_gc = during_gc;
5423 during_gc = FALSE; // stop gc here
5424 {
5425 gc_verify_internal_consistency_(objspace);
5426 }
5427 during_gc = prev_during_gc;
5428 }
5429 RB_GC_VM_UNLOCK(lev);
5430}
5431
5432static void
5433heap_move_pooled_pages_to_free_pages(rb_heap_t *heap)
5434{
5435 if (heap->pooled_pages) {
5436 if (heap->free_pages) {
5437 struct heap_page *free_pages_tail = heap->free_pages;
5438 while (free_pages_tail->free_next) {
5439 free_pages_tail = free_pages_tail->free_next;
5440 }
5441 free_pages_tail->free_next = heap->pooled_pages;
5442 }
5443 else {
5444 heap->free_pages = heap->pooled_pages;
5445 }
5446
5447 heap->pooled_pages = NULL;
5448 }
5449}
5450
5451static int
5452gc_remember_unprotected(rb_objspace_t *objspace, VALUE obj)
5453{
5454 struct heap_page *page = GET_HEAP_PAGE(obj);
5455 bits_t *uncollectible_bits = &page->uncollectible_bits[0];
5456
5457 if (!MARKED_IN_BITMAP(uncollectible_bits, obj)) {
5458 page->flags.has_uncollectible_wb_unprotected_objects = TRUE;
5459 MARK_IN_BITMAP(uncollectible_bits, obj);
5460 objspace->rgengc.uncollectible_wb_unprotected_objects++;
5461
5462#if RGENGC_PROFILE > 0
5463 objspace->profile.total_remembered_shady_object_count++;
5464#if RGENGC_PROFILE >= 2
5465 objspace->profile.remembered_shady_object_count_types[BUILTIN_TYPE(obj)]++;
5466#endif
5467#endif
5468 return TRUE;
5469 }
5470 else {
5471 return FALSE;
5472 }
5473}
5474
5475static inline void
5476gc_marks_wb_unprotected_objects_plane(rb_objspace_t *objspace, uintptr_t p, bits_t bits, short slot_size)
5477{
5478 if (bits) {
5479 do {
5480 if (bits & 1) {
5481 gc_report(2, objspace, "gc_marks_wb_unprotected_objects: marked shady: %s\n", rb_obj_info((VALUE)p));
5482 GC_ASSERT(RVALUE_WB_UNPROTECTED(objspace, (VALUE)p));
5483 GC_ASSERT(RVALUE_MARKED(objspace, (VALUE)p));
5484 gc_mark_children(objspace, (VALUE)p);
5485 }
5486 p += slot_size;
5487 bits >>= 1;
5488 } while (bits);
5489 }
5490}
5491
5492static void
5493gc_marks_wb_unprotected_objects(rb_objspace_t *objspace, rb_heap_t *heap)
5494{
5495 struct heap_page *page = 0;
5496
5497 ccan_list_for_each(&heap->pages, page, page_node) {
5498 bits_t *mark_bits = page->mark_bits;
5499 bits_t *wbun_bits = page->wb_unprotected_bits;
5500 uintptr_t p = page->start;
5501 short slot_size = page->slot_size;
5502 int total_slots = page->total_slots;
5503 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
5504 size_t j;
5505
5506 for (j=0; j<(size_t)bitmap_plane_count; j++) {
5507 bits_t bits = mark_bits[j] & wbun_bits[j];
5508 gc_marks_wb_unprotected_objects_plane(objspace, p, bits, slot_size);
5509 p += BITS_BITLENGTH * slot_size;
5510 }
5511 }
5512
5513 gc_mark_stacked_objects_all(objspace);
5514}
5515
5516void
5517rb_gc_impl_declare_weak_references(void *objspace_ptr, VALUE obj)
5518{
5520}
5521
5522bool
5523rb_gc_impl_handle_weak_references_alive_p(void *objspace_ptr, VALUE obj)
5524{
5525 rb_objspace_t *objspace = objspace_ptr;
5526
5527 bool marked = RVALUE_MARKED(objspace, obj);
5528
5529 if (marked) {
5530 rgengc_check_relation(objspace, obj);
5531 }
5532
5533 return marked;
5534}
5535
5536static void
5537gc_update_weak_references(rb_objspace_t *objspace)
5538{
5539 VALUE *obj_ptr;
5540 rb_darray_foreach(objspace->weak_references, i, obj_ptr) {
5541 gc_mark_set_parent(objspace, *obj_ptr);
5542 rb_gc_handle_weak_references(*obj_ptr);
5543 gc_mark_set_parent_invalid(objspace);
5544 }
5545
5546 size_t capa = rb_darray_capa(objspace->weak_references);
5547 size_t size = rb_darray_size(objspace->weak_references);
5548
5549 objspace->profile.weak_references_count = size;
5550
5551 rb_darray_clear(objspace->weak_references);
5552
5553 /* If the darray has capacity for more than four times the amount used, we
5554 * shrink it down to half of that capacity. */
5555 if (capa > size * 4) {
5556 rb_darray_resize_capa_without_gc(&objspace->weak_references, size * 2);
5557 }
5558}
5559
5560static void
5561gc_marks_finish(rb_objspace_t *objspace)
5562{
5563 /* finish incremental GC */
5564 if (is_incremental_marking(objspace)) {
5565 if (RGENGC_CHECK_MODE && is_mark_stack_empty(&objspace->mark_stack) == 0) {
5566 rb_bug("gc_marks_finish: mark stack is not empty (%"PRIdSIZE").",
5567 mark_stack_size(&objspace->mark_stack));
5568 }
5569
5570 mark_roots(objspace, NULL);
5571 while (gc_mark_stacked_objects_incremental(objspace, INT_MAX) == false);
5572
5573#if RGENGC_CHECK_MODE >= 2
5574 if (gc_verify_heap_pages(objspace) != 0) {
5575 rb_bug("gc_marks_finish (incremental): there are remembered old objects.");
5576 }
5577#endif
5578
5579 objspace->flags.during_incremental_marking = FALSE;
5580 /* check children of all marked wb-unprotected objects */
5581 for (int i = 0; i < HEAP_COUNT; i++) {
5582 gc_marks_wb_unprotected_objects(objspace, &heaps[i]);
5583 }
5584 }
5585
5586 gc_update_weak_references(objspace);
5587
5588#if RGENGC_CHECK_MODE >= 2
5589 gc_verify_internal_consistency(objspace);
5590#endif
5591
5592#if RGENGC_CHECK_MODE >= 4
5593 during_gc = FALSE;
5594 gc_marks_check(objspace, gc_check_after_marks_i, "after_marks");
5595 during_gc = TRUE;
5596#endif
5597
5598 {
5599 const unsigned long r_mul = objspace->live_ractor_cache_count > 8 ? 8 : objspace->live_ractor_cache_count; // upto 8
5600
5601 size_t total_slots = objspace_available_slots(objspace);
5602 size_t sweep_slots = total_slots - objspace->marked_slots; /* will be swept slots */
5603 size_t max_free_slots = (size_t)(total_slots * gc_params.heap_free_slots_max_ratio);
5604 size_t min_free_slots = (size_t)(total_slots * gc_params.heap_free_slots_min_ratio);
5605 if (min_free_slots < gc_params.heap_free_slots * r_mul) {
5606 min_free_slots = gc_params.heap_free_slots * r_mul;
5607 }
5608
5609 int full_marking = is_full_marking(objspace);
5610
5611 GC_ASSERT(objspace_available_slots(objspace) >= objspace->marked_slots);
5612
5613 /* Setup freeable slots. */
5614 size_t total_init_slots = 0;
5615 for (int i = 0; i < HEAP_COUNT; i++) {
5616 total_init_slots += (gc_params.heap_init_bytes / heaps[i].slot_size) * r_mul;
5617 }
5618
5619 if (max_free_slots < total_init_slots) {
5620 max_free_slots = total_init_slots;
5621 }
5622
5623 /* Approximate freeable pages using the average slots-per-pages across all heaps */
5624 if (sweep_slots > max_free_slots) {
5625 size_t excess_slots = sweep_slots - max_free_slots;
5626 size_t total_heap_pages = heap_eden_total_pages(objspace);
5627 heap_pages_freeable_pages = total_heap_pages > 0
5628 ? excess_slots * total_heap_pages / total_slots
5629 : 0;
5630 }
5631 else {
5632 heap_pages_freeable_pages = 0;
5633 }
5634
5635 if (objspace->heap_pages.allocatable_bytes == 0 && sweep_slots < min_free_slots) {
5636 if (!full_marking && sweep_slots < min_free_slots * 7 / 8) {
5637 if (objspace->profile.count - objspace->rgengc.last_major_gc < RVALUE_OLD_AGE) {
5638 full_marking = TRUE;
5639 }
5640 else {
5641 gc_report(1, objspace, "gc_marks_finish: next is full GC!!)\n");
5642 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_NOFREE;
5643 }
5644 }
5645
5646 if (full_marking) {
5647 heap_allocatable_bytes_expand(objspace, NULL, sweep_slots, total_slots, heaps[0].slot_size);
5648 }
5649 }
5650
5651 if (full_marking) {
5652 /* See the comment about RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR */
5653 const double r = gc_params.oldobject_limit_factor;
5654 objspace->rgengc.uncollectible_wb_unprotected_objects_limit = MAX(
5655 (size_t)(objspace->rgengc.uncollectible_wb_unprotected_objects * r),
5656 (size_t)(objspace->rgengc.old_objects * gc_params.uncollectible_wb_unprotected_objects_limit_ratio)
5657 );
5658 objspace->rgengc.old_objects_limit = (size_t)(objspace->rgengc.old_objects * r);
5659 }
5660
5661 if (objspace->rgengc.uncollectible_wb_unprotected_objects > objspace->rgengc.uncollectible_wb_unprotected_objects_limit) {
5662 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_SHADY;
5663 }
5664 if (objspace->rgengc.old_objects > objspace->rgengc.old_objects_limit) {
5665 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_OLDGEN;
5666 }
5667
5668 gc_report(1, objspace, "gc_marks_finish (marks %"PRIdSIZE" objects, "
5669 "old %"PRIdSIZE" objects, total %"PRIdSIZE" slots, "
5670 "sweep %"PRIdSIZE" slots, allocatable %"PRIdSIZE" bytes, next GC: %s)\n",
5671 objspace->marked_slots, objspace->rgengc.old_objects, objspace_available_slots(objspace), sweep_slots, objspace->heap_pages.allocatable_bytes,
5672 gc_needs_major_flags ? "major" : "minor");
5673 }
5674
5675 // TODO: refactor so we don't need to call this
5676 rb_ractor_finish_marking();
5677
5678 rb_gc_event_hook(0, RUBY_INTERNAL_EVENT_GC_END_MARK);
5679}
5680
5681static bool
5682gc_compact_heap_cursors_met_p(rb_heap_t *heap)
5683{
5684 return heap->sweeping_page == heap->compact_cursor;
5685}
5686
5687
5688static rb_heap_t *
5689gc_compact_destination_pool(rb_objspace_t *objspace, rb_heap_t *src_pool, VALUE obj)
5690{
5691 size_t obj_size = rb_gc_obj_optimal_size(obj);
5692 if (obj_size == 0) {
5693 return src_pool;
5694 }
5695
5696 GC_ASSERT(rb_gc_impl_size_allocatable_p(obj_size));
5697
5698 size_t idx = heap_idx_for_size(obj_size);
5699
5700 return &heaps[idx];
5701}
5702
5703static bool
5704gc_compact_move(rb_objspace_t *objspace, rb_heap_t *heap, VALUE src)
5705{
5706 GC_ASSERT(BUILTIN_TYPE(src) != T_MOVED);
5707 GC_ASSERT(gc_is_moveable_obj(objspace, src));
5708
5709 rb_heap_t *dest_pool = gc_compact_destination_pool(objspace, heap, src);
5710 if (gc_compact_heap_cursors_met_p(dest_pool)) {
5711 return dest_pool != heap;
5712 }
5713
5714 while (!try_move(objspace, dest_pool, dest_pool->free_pages, src)) {
5715 struct gc_sweep_context ctx = {
5716 .page = dest_pool->sweeping_page,
5717 .final_slots = 0,
5718 .freed_slots = 0,
5719 .empty_slots = 0,
5720 };
5721
5722 /* The page of src could be partially compacted, so it may contain
5723 * T_MOVED. Sweeping a page may read objects on this page, so we
5724 * need to lock the page. */
5725 lock_page_body(objspace, GET_PAGE_BODY(src));
5726 gc_sweep_page(objspace, dest_pool, &ctx);
5727 unlock_page_body(objspace, GET_PAGE_BODY(src));
5728
5729 if (dest_pool->sweeping_page->free_slots > 0) {
5730 heap_add_freepage(dest_pool, dest_pool->sweeping_page);
5731 }
5732
5733 dest_pool->sweeping_page = ccan_list_next(&dest_pool->pages, dest_pool->sweeping_page, page_node);
5734 if (gc_compact_heap_cursors_met_p(dest_pool)) {
5735 return dest_pool != heap;
5736 }
5737 }
5738
5739 return true;
5740}
5741
5742static bool
5743gc_compact_plane(rb_objspace_t *objspace, rb_heap_t *heap, uintptr_t p, bits_t bitset, struct heap_page *page)
5744{
5745 short slot_size = page->slot_size;
5746
5747 do {
5748 VALUE vp = (VALUE)p;
5749 GC_ASSERT(vp % sizeof(VALUE) == 0);
5750
5751 if (bitset & 1) {
5752 objspace->rcompactor.considered_count_table[BUILTIN_TYPE(vp)]++;
5753
5754 if (gc_is_moveable_obj(objspace, vp)) {
5755 if (!gc_compact_move(objspace, heap, vp)) {
5756 //the cursors met. bubble up
5757 return false;
5758 }
5759 }
5760 }
5761 p += slot_size;
5762 bitset >>= 1;
5763 } while (bitset);
5764
5765 return true;
5766}
5767
5768// Iterate up all the objects in page, moving them to where they want to go
5769static bool
5770gc_compact_page(rb_objspace_t *objspace, rb_heap_t *heap, struct heap_page *page)
5771{
5772 GC_ASSERT(page == heap->compact_cursor);
5773
5774 bits_t *mark_bits, *pin_bits;
5775 bits_t bitset;
5776 uintptr_t p = page->start;
5777 short slot_size = page->slot_size;
5778 int total_slots = page->total_slots;
5779 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
5780
5781 mark_bits = page->mark_bits;
5782 pin_bits = page->pinned_bits;
5783
5784 for (int j = 0; j < bitmap_plane_count; j++) {
5785 // objects that can be moved are marked and not pinned
5786 bitset = (mark_bits[j] & ~pin_bits[j]);
5787 if (bitset) {
5788 if (!gc_compact_plane(objspace, heap, (uintptr_t)p, bitset, page))
5789 return false;
5790 }
5791 p += BITS_BITLENGTH * slot_size;
5792 }
5793
5794 return true;
5795}
5796
5797static bool
5798gc_compact_all_compacted_p(rb_objspace_t *objspace)
5799{
5800 for (int i = 0; i < HEAP_COUNT; i++) {
5801 rb_heap_t *heap = &heaps[i];
5802
5803 if (heap->total_pages > 0 &&
5804 !gc_compact_heap_cursors_met_p(heap)) {
5805 return false;
5806 }
5807 }
5808
5809 return true;
5810}
5811
5812static void
5813gc_sweep_compact(rb_objspace_t *objspace)
5814{
5815 gc_compact_start(objspace);
5816#if RGENGC_CHECK_MODE >= 2
5817 gc_verify_internal_consistency(objspace);
5818#endif
5819
5820 while (!gc_compact_all_compacted_p(objspace)) {
5821 for (int i = 0; i < HEAP_COUNT; i++) {
5822 rb_heap_t *heap = &heaps[i];
5823
5824 if (gc_compact_heap_cursors_met_p(heap)) {
5825 continue;
5826 }
5827
5828 struct heap_page *start_page = heap->compact_cursor;
5829
5830 if (!gc_compact_page(objspace, heap, start_page)) {
5831 lock_page_body(objspace, start_page->body);
5832
5833 continue;
5834 }
5835
5836 // If we get here, we've finished moving all objects on the compact_cursor page
5837 // So we can lock it and move the cursor on to the next one.
5838 lock_page_body(objspace, start_page->body);
5839 heap->compact_cursor = ccan_list_prev(&heap->pages, heap->compact_cursor, page_node);
5840 }
5841 }
5842
5843 gc_compact_finish(objspace);
5844
5845#if RGENGC_CHECK_MODE >= 2
5846 gc_verify_internal_consistency(objspace);
5847#endif
5848}
5849
5850static void
5851gc_marks_rest(rb_objspace_t *objspace)
5852{
5853 gc_report(1, objspace, "gc_marks_rest\n");
5854
5855 for (int i = 0; i < HEAP_COUNT; i++) {
5856 (&heaps[i])->pooled_pages = NULL;
5857 }
5858
5859 if (is_incremental_marking(objspace)) {
5860 while (gc_mark_stacked_objects_incremental(objspace, INT_MAX) == FALSE);
5861 }
5862 else {
5863 gc_mark_stacked_objects_all(objspace);
5864 }
5865
5866 gc_marks_finish(objspace);
5867}
5868
5869static bool
5870gc_marks_step(rb_objspace_t *objspace, size_t slots)
5871{
5872 bool marking_finished = false;
5873
5874 GC_ASSERT(is_marking(objspace));
5875 if (gc_mark_stacked_objects_incremental(objspace, slots)) {
5876 gc_marks_finish(objspace);
5877
5878 marking_finished = true;
5879 }
5880
5881 return marking_finished;
5882}
5883
5884static bool
5885gc_marks_continue(rb_objspace_t *objspace, rb_heap_t *heap)
5886{
5887 GC_ASSERT(dont_gc_val() == FALSE || objspace->profile.latest_gc_info & GPR_FLAG_METHOD);
5888 bool marking_finished = true;
5889
5890 gc_marking_enter(objspace);
5891
5892 if (heap->free_pages) {
5893 gc_report(2, objspace, "gc_marks_continue: has pooled pages");
5894
5895 marking_finished = gc_marks_step(objspace, objspace->rincgc.step_slots);
5896 }
5897 else {
5898 gc_report(2, objspace, "gc_marks_continue: no more pooled pages (stack depth: %"PRIdSIZE").\n",
5899 mark_stack_size(&objspace->mark_stack));
5900 heap->force_incremental_marking_finish_count++;
5901 gc_marks_rest(objspace);
5902 }
5903
5904 gc_marking_exit(objspace);
5905
5906 return marking_finished;
5907}
5908
5909static void
5910gc_marks_start(rb_objspace_t *objspace, int full_mark)
5911{
5912 /* start marking */
5913 gc_report(1, objspace, "gc_marks_start: (%s)\n", full_mark ? "full" : "minor");
5914 gc_mode_transition(objspace, gc_mode_marking);
5915
5916 if (full_mark) {
5917 size_t incremental_marking_steps = (objspace->rincgc.pooled_slots / INCREMENTAL_MARK_STEP_ALLOCATIONS) + 1;
5918 objspace->rincgc.step_slots = (objspace->marked_slots * 2) / incremental_marking_steps;
5919
5920 if (0) fprintf(stderr, "objspace->marked_slots: %"PRIdSIZE", "
5921 "objspace->rincgc.pooled_page_num: %"PRIdSIZE", "
5922 "objspace->rincgc.step_slots: %"PRIdSIZE", \n",
5923 objspace->marked_slots, objspace->rincgc.pooled_slots, objspace->rincgc.step_slots);
5924 objspace->flags.during_minor_gc = FALSE;
5925 if (ruby_enable_autocompact) {
5926 objspace->flags.during_compacting |= TRUE;
5927 }
5928 objspace->profile.major_gc_count++;
5929 objspace->rgengc.uncollectible_wb_unprotected_objects = 0;
5930 objspace->rgengc.old_objects = 0;
5931 objspace->rgengc.last_major_gc = objspace->profile.count;
5932 objspace->marked_slots = 0;
5933
5934 for (int i = 0; i < HEAP_COUNT; i++) {
5935 rb_heap_t *heap = &heaps[i];
5936 rgengc_mark_and_rememberset_clear(objspace, heap);
5937 heap_move_pooled_pages_to_free_pages(heap);
5938
5939 if (objspace->flags.during_compacting) {
5940 struct heap_page *page = NULL;
5941
5942 ccan_list_for_each(&heap->pages, page, page_node) {
5943 page->pinned_slots = 0;
5944 }
5945 }
5946 }
5947 }
5948 else {
5949 objspace->flags.during_minor_gc = TRUE;
5950 objspace->marked_slots =
5951 objspace->rgengc.old_objects + objspace->rgengc.uncollectible_wb_unprotected_objects; /* uncollectible objects are marked already */
5952 objspace->profile.minor_gc_count++;
5953
5954 for (int i = 0; i < HEAP_COUNT; i++) {
5955 rgengc_rememberset_mark(objspace, &heaps[i]);
5956 }
5957 }
5958
5959 mark_roots(objspace, NULL);
5960
5961 gc_report(1, objspace, "gc_marks_start: (%s) end, stack in %"PRIdSIZE"\n",
5962 full_mark ? "full" : "minor", mark_stack_size(&objspace->mark_stack));
5963}
5964
5965static bool
5966gc_marks(rb_objspace_t *objspace, int full_mark)
5967{
5968 gc_prof_mark_timer_start(objspace);
5969 gc_marking_enter(objspace);
5970
5971 bool marking_finished = false;
5972
5973 /* setup marking */
5974
5975 gc_marks_start(objspace, full_mark);
5976 if (!is_incremental_marking(objspace)) {
5977 gc_marks_rest(objspace);
5978 marking_finished = true;
5979 }
5980
5981#if RGENGC_PROFILE > 0
5982 if (gc_prof_record(objspace)) {
5983 gc_profile_record *record = gc_prof_record(objspace);
5984 record->old_objects = objspace->rgengc.old_objects;
5985 }
5986#endif
5987
5988 gc_marking_exit(objspace);
5989 gc_prof_mark_timer_stop(objspace);
5990
5991 return marking_finished;
5992}
5993
5994/* RGENGC */
5995
5996static void
5997gc_report_body(int level, rb_objspace_t *objspace, const char *fmt, ...)
5998{
5999 if (level <= RGENGC_DEBUG) {
6000 char buf[1024];
6001 FILE *out = stderr;
6002 va_list args;
6003 const char *status = " ";
6004
6005 if (during_gc) {
6006 status = is_full_marking(objspace) ? "+" : "-";
6007 }
6008 else {
6009 if (is_lazy_sweeping(objspace)) {
6010 status = "S";
6011 }
6012 if (is_incremental_marking(objspace)) {
6013 status = "M";
6014 }
6015 }
6016
6017 va_start(args, fmt);
6018 vsnprintf(buf, 1024, fmt, args);
6019 va_end(args);
6020
6021 fprintf(out, "%s|", status);
6022 fputs(buf, out);
6023 }
6024}
6025
6026/* bit operations */
6027
6028static int
6029rgengc_remembersetbits_set(rb_objspace_t *objspace, VALUE obj)
6030{
6031 struct heap_page *page = GET_HEAP_PAGE(obj);
6032 bits_t *bits = &page->remembered_bits[0];
6033
6034 if (MARKED_IN_BITMAP(bits, obj)) {
6035 return FALSE;
6036 }
6037 else {
6038 page->flags.has_remembered_objects = TRUE;
6039 MARK_IN_BITMAP(bits, obj);
6040 return TRUE;
6041 }
6042}
6043
6044/* wb, etc */
6045
6046/* return FALSE if already remembered */
6047static int
6048rgengc_remember(rb_objspace_t *objspace, VALUE obj)
6049{
6050 gc_report(6, objspace, "rgengc_remember: %s %s\n", rb_obj_info(obj),
6051 RVALUE_REMEMBERED(objspace, obj) ? "was already remembered" : "is remembered now");
6052
6053 check_rvalue_consistency(objspace, obj);
6054
6055 if (RGENGC_CHECK_MODE) {
6056 if (RVALUE_WB_UNPROTECTED(objspace, obj)) rb_bug("rgengc_remember: %s is not wb protected.", rb_obj_info(obj));
6057 }
6058
6059#if RGENGC_PROFILE > 0
6060 if (!RVALUE_REMEMBERED(objspace, obj)) {
6061 if (RVALUE_WB_UNPROTECTED(objspace, obj) == 0) {
6062 objspace->profile.total_remembered_normal_object_count++;
6063#if RGENGC_PROFILE >= 2
6064 objspace->profile.remembered_normal_object_count_types[BUILTIN_TYPE(obj)]++;
6065#endif
6066 }
6067 }
6068#endif /* RGENGC_PROFILE > 0 */
6069
6070 return rgengc_remembersetbits_set(objspace, obj);
6071}
6072
6073#ifndef PROFILE_REMEMBERSET_MARK
6074#define PROFILE_REMEMBERSET_MARK 0
6075#endif
6076
6077static inline void
6078rgengc_rememberset_mark_plane(rb_objspace_t *objspace, uintptr_t p, bits_t bitset, short slot_size)
6079{
6080 if (bitset) {
6081 do {
6082 if (bitset & 1) {
6083 VALUE obj = (VALUE)p;
6084 gc_report(2, objspace, "rgengc_rememberset_mark: mark %s\n", rb_obj_info(obj));
6085 GC_ASSERT(RVALUE_UNCOLLECTIBLE(objspace, obj));
6086 GC_ASSERT(RVALUE_OLD_P(objspace, obj) || RVALUE_WB_UNPROTECTED(objspace, obj));
6087
6088 gc_mark_children(objspace, obj);
6089
6091 rb_darray_append_without_gc(&objspace->weak_references, obj);
6092 }
6093 }
6094 p += slot_size;
6095 bitset >>= 1;
6096 } while (bitset);
6097 }
6098}
6099
6100static void
6101rgengc_rememberset_mark(rb_objspace_t *objspace, rb_heap_t *heap)
6102{
6103 size_t j;
6104 struct heap_page *page = 0;
6105#if PROFILE_REMEMBERSET_MARK
6106 int has_old = 0, has_shady = 0, has_both = 0, skip = 0;
6107#endif
6108 gc_report(1, objspace, "rgengc_rememberset_mark: start\n");
6109
6110 ccan_list_for_each(&heap->pages, page, page_node) {
6111 if (page->flags.has_remembered_objects | page->flags.has_uncollectible_wb_unprotected_objects) {
6112 uintptr_t p = page->start;
6113 short slot_size = page->slot_size;
6114 int total_slots = page->total_slots;
6115 int bitmap_plane_count = CEILDIV(total_slots, BITS_BITLENGTH);
6116 bits_t bitset, bits[HEAP_PAGE_BITMAP_LIMIT];
6117 bits_t *remembered_bits = page->remembered_bits;
6118 bits_t *uncollectible_bits = page->uncollectible_bits;
6119 bits_t *wb_unprotected_bits = page->wb_unprotected_bits;
6120#if PROFILE_REMEMBERSET_MARK
6121 if (page->flags.has_remembered_objects && page->flags.has_uncollectible_wb_unprotected_objects) has_both++;
6122 else if (page->flags.has_remembered_objects) has_old++;
6123 else if (page->flags.has_uncollectible_wb_unprotected_objects) has_shady++;
6124#endif
6125 for (j=0; j < (size_t)bitmap_plane_count; j++) {
6126 bits[j] = remembered_bits[j] | (uncollectible_bits[j] & wb_unprotected_bits[j]);
6127 remembered_bits[j] = 0;
6128 }
6129 page->flags.has_remembered_objects = FALSE;
6130
6131 for (j=0; j < (size_t)bitmap_plane_count; j++) {
6132 bitset = bits[j];
6133 rgengc_rememberset_mark_plane(objspace, p, bitset, slot_size);
6134 p += BITS_BITLENGTH * slot_size;
6135 }
6136 }
6137#if PROFILE_REMEMBERSET_MARK
6138 else {
6139 skip++;
6140 }
6141#endif
6142 }
6143
6144#if PROFILE_REMEMBERSET_MARK
6145 fprintf(stderr, "%d\t%d\t%d\t%d\n", has_both, has_old, has_shady, skip);
6146#endif
6147 gc_report(1, objspace, "rgengc_rememberset_mark: finished\n");
6148}
6149
6150static void
6151rgengc_mark_and_rememberset_clear(rb_objspace_t *objspace, rb_heap_t *heap)
6152{
6153 struct heap_page *page = 0;
6154
6155 ccan_list_for_each(&heap->pages, page, page_node) {
6156 memset(&page->mark_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6157 memset(&page->uncollectible_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6158 memset(&page->marking_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6159 memset(&page->remembered_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6160 memset(&page->pinned_bits[0], 0, HEAP_PAGE_BITMAP_SIZE);
6161 page->flags.has_uncollectible_wb_unprotected_objects = FALSE;
6162 page->flags.has_remembered_objects = FALSE;
6163 }
6164}
6165
6166/* RGENGC: APIs */
6167
6168NOINLINE(static void gc_writebarrier_generational(VALUE a, VALUE b, rb_objspace_t *objspace));
6169
6170static void
6171gc_writebarrier_generational(VALUE a, VALUE b, rb_objspace_t *objspace)
6172{
6173 if (RGENGC_CHECK_MODE) {
6174 if (!RVALUE_OLD_P(objspace, a)) rb_bug("gc_writebarrier_generational: %s is not an old object.", rb_obj_info(a));
6175 if ( RVALUE_OLD_P(objspace, b)) rb_bug("gc_writebarrier_generational: %s is an old object.", rb_obj_info(b));
6176 if (is_incremental_marking(objspace)) rb_bug("gc_writebarrier_generational: called while incremental marking: %s -> %s", rb_obj_info(a), rb_obj_info(b));
6177 }
6178
6179 /* mark `a' and remember (default behavior) */
6180 if (!RVALUE_REMEMBERED(objspace, a)) {
6181 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6182 {
6183 rgengc_remember(objspace, a);
6184 }
6185 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6186
6187 gc_report(1, objspace, "gc_writebarrier_generational: %s (remembered) -> %s\n", rb_obj_info(a), rb_obj_info(b));
6188 }
6189
6190 check_rvalue_consistency(objspace, a);
6191 check_rvalue_consistency(objspace, b);
6192}
6193
6194static void
6195gc_mark_from(rb_objspace_t *objspace, VALUE obj, VALUE parent)
6196{
6197 gc_mark_set_parent(objspace, parent);
6198 rgengc_check_relation(objspace, obj);
6199 if (gc_mark_set(objspace, obj) != FALSE) {
6200 gc_aging(objspace, obj);
6201 gc_grey(objspace, obj);
6202 }
6203 gc_mark_set_parent_invalid(objspace);
6204}
6205
6206NOINLINE(static void gc_writebarrier_incremental(VALUE a, VALUE b, rb_objspace_t *objspace));
6207
6208static void
6209gc_writebarrier_incremental(VALUE a, VALUE b, rb_objspace_t *objspace)
6210{
6211 gc_report(2, objspace, "gc_writebarrier_incremental: [LG] %p -> %s\n", (void *)a, rb_obj_info(b));
6212
6213 if (RVALUE_BLACK_P(objspace, a)) {
6214 if (RVALUE_WHITE_P(objspace, b)) {
6215 if (!RVALUE_WB_UNPROTECTED(objspace, a)) {
6216 gc_report(2, objspace, "gc_writebarrier_incremental: [IN] %p -> %s\n", (void *)a, rb_obj_info(b));
6217 gc_mark_from(objspace, b, a);
6218 }
6219 }
6220 else if (RVALUE_OLD_P(objspace, a) && !RVALUE_OLD_P(objspace, b)) {
6221 rgengc_remember(objspace, a);
6222 }
6223
6224 if (RB_UNLIKELY(objspace->flags.during_compacting)) {
6225 MARK_IN_BITMAP(GET_HEAP_PINNED_BITS(b), b);
6226 }
6227 }
6228}
6229
6230void
6231rb_gc_impl_writebarrier(void *objspace_ptr, VALUE a, VALUE b)
6232{
6233 rb_objspace_t *objspace = objspace_ptr;
6234
6235#if RGENGC_CHECK_MODE
6236 if (SPECIAL_CONST_P(a)) rb_bug("rb_gc_writebarrier: a is special const: %"PRIxVALUE, a);
6237 if (SPECIAL_CONST_P(b)) rb_bug("rb_gc_writebarrier: b is special const: %"PRIxVALUE, b);
6238#else
6241#endif
6242
6243 GC_ASSERT(!during_gc);
6244 GC_ASSERT(RB_BUILTIN_TYPE(a) != T_NONE);
6245 GC_ASSERT(RB_BUILTIN_TYPE(a) != T_MOVED);
6246 GC_ASSERT(RB_BUILTIN_TYPE(a) != T_ZOMBIE);
6247 GC_ASSERT(RB_BUILTIN_TYPE(b) != T_NONE);
6248 GC_ASSERT(RB_BUILTIN_TYPE(b) != T_MOVED);
6249 GC_ASSERT(RB_BUILTIN_TYPE(b) != T_ZOMBIE);
6250
6251 retry:
6252 if (!is_incremental_marking(objspace)) {
6253 if (!RVALUE_OLD_P(objspace, a) || RVALUE_OLD_P(objspace, b)) {
6254 // do nothing
6255 }
6256 else {
6257 gc_writebarrier_generational(a, b, objspace);
6258 }
6259 }
6260 else {
6261 bool retry = false;
6262 /* slow path */
6263 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6264 {
6265 if (is_incremental_marking(objspace)) {
6266 gc_writebarrier_incremental(a, b, objspace);
6267 }
6268 else {
6269 retry = true;
6270 }
6271 }
6272 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6273
6274 if (retry) goto retry;
6275 }
6276 return;
6277}
6278
6279void
6280rb_gc_impl_writebarrier_unprotect(void *objspace_ptr, VALUE obj)
6281{
6282 rb_objspace_t *objspace = objspace_ptr;
6283
6284 if (RVALUE_WB_UNPROTECTED(objspace, obj)) {
6285 return;
6286 }
6287 else {
6288 gc_report(2, objspace, "rb_gc_writebarrier_unprotect: %s %s\n", rb_obj_info(obj),
6289 RVALUE_REMEMBERED(objspace, obj) ? " (already remembered)" : "");
6290
6291 unsigned int lev = RB_GC_VM_LOCK_NO_BARRIER();
6292 {
6293 if (RVALUE_OLD_P(objspace, obj)) {
6294 gc_report(1, objspace, "rb_gc_writebarrier_unprotect: %s\n", rb_obj_info(obj));
6295 RVALUE_DEMOTE(objspace, obj);
6296 gc_mark_set(objspace, obj);
6297 gc_remember_unprotected(objspace, obj);
6298
6299#if RGENGC_PROFILE
6300 objspace->profile.total_shade_operation_count++;
6301#if RGENGC_PROFILE >= 2
6302 objspace->profile.shade_operation_count_types[BUILTIN_TYPE(obj)]++;
6303#endif /* RGENGC_PROFILE >= 2 */
6304#endif /* RGENGC_PROFILE */
6305 }
6306 else {
6307 RVALUE_AGE_RESET(obj);
6308 }
6309
6310 RB_DEBUG_COUNTER_INC(obj_wb_unprotect);
6311 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(obj), obj);
6312 }
6313 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6314 }
6315}
6316
6317void
6318rb_gc_impl_copy_attributes(void *objspace_ptr, VALUE dest, VALUE obj)
6319{
6320 rb_objspace_t *objspace = objspace_ptr;
6321
6322 if (RVALUE_WB_UNPROTECTED(objspace, obj)) {
6323 rb_gc_impl_writebarrier_unprotect(objspace, dest);
6324 }
6325 rb_gc_impl_copy_finalizer(objspace, dest, obj);
6326}
6327
6328const char *
6329rb_gc_impl_active_gc_name(void)
6330{
6331 return "default";
6332}
6333
6334void
6335rb_gc_impl_writebarrier_remember(void *objspace_ptr, VALUE obj)
6336{
6337 rb_objspace_t *objspace = objspace_ptr;
6338
6339 gc_report(1, objspace, "rb_gc_writebarrier_remember: %s\n", rb_obj_info(obj));
6340
6341 if (is_incremental_marking(objspace) || RVALUE_OLD_P(objspace, obj)) {
6342 int lev = RB_GC_VM_LOCK_NO_BARRIER();
6343 {
6344 if (is_incremental_marking(objspace)) {
6345 if (RVALUE_BLACK_P(objspace, obj)) {
6346 gc_grey(objspace, obj);
6347 }
6348 }
6349 else if (RVALUE_OLD_P(objspace, obj)) {
6350 rgengc_remember(objspace, obj);
6351 }
6352 }
6353 RB_GC_VM_UNLOCK_NO_BARRIER(lev);
6354 }
6355}
6356
6358 // Must be ID only
6359 ID ID_wb_protected, ID_age, ID_old, ID_uncollectible, ID_marking,
6360 ID_marked, ID_pinned, ID_remembered, ID_object_id, ID_shareable;
6361};
6362
6363#define RB_GC_OBJECT_METADATA_ENTRY_COUNT (sizeof(struct rb_gc_object_metadata_names) / sizeof(ID))
6364static struct rb_gc_object_metadata_entry object_metadata_entries[RB_GC_OBJECT_METADATA_ENTRY_COUNT + 1];
6365
6367rb_gc_impl_object_metadata(void *objspace_ptr, VALUE obj)
6368{
6369 rb_objspace_t *objspace = objspace_ptr;
6370 size_t n = 0;
6371 static struct rb_gc_object_metadata_names names;
6372
6373 if (!names.ID_marked) {
6374#define I(s) names.ID_##s = rb_intern(#s)
6375 I(wb_protected);
6376 I(age);
6377 I(old);
6378 I(uncollectible);
6379 I(marking);
6380 I(marked);
6381 I(pinned);
6382 I(remembered);
6383 I(object_id);
6384 I(shareable);
6385#undef I
6386 }
6387
6388#define SET_ENTRY(na, v) do { \
6389 GC_ASSERT(n <= RB_GC_OBJECT_METADATA_ENTRY_COUNT); \
6390 object_metadata_entries[n].name = names.ID_##na; \
6391 object_metadata_entries[n].val = v; \
6392 n++; \
6393} while (0)
6394
6395 if (!RVALUE_WB_UNPROTECTED(objspace, obj)) SET_ENTRY(wb_protected, Qtrue);
6396 SET_ENTRY(age, INT2FIX(RVALUE_AGE_GET(obj)));
6397 if (RVALUE_OLD_P(objspace, obj)) SET_ENTRY(old, Qtrue);
6398 if (RVALUE_UNCOLLECTIBLE(objspace, obj)) SET_ENTRY(uncollectible, Qtrue);
6399 if (RVALUE_MARKING(objspace, obj)) SET_ENTRY(marking, Qtrue);
6400 if (RVALUE_MARKED(objspace, obj)) SET_ENTRY(marked, Qtrue);
6401 if (RVALUE_PINNED(objspace, obj)) SET_ENTRY(pinned, Qtrue);
6402 if (RVALUE_REMEMBERED(objspace, obj)) SET_ENTRY(remembered, Qtrue);
6403 if (rb_obj_id_p(obj)) SET_ENTRY(object_id, rb_obj_id(obj));
6404 if (FL_TEST(obj, FL_SHAREABLE)) SET_ENTRY(shareable, Qtrue);
6405
6406 object_metadata_entries[n].name = 0;
6407 object_metadata_entries[n].val = 0;
6408#undef SET_ENTRY
6409
6410 return object_metadata_entries;
6411}
6412
6413void *
6414rb_gc_impl_ractor_cache_alloc(void *objspace_ptr, void *ractor)
6415{
6416 rb_objspace_t *objspace = objspace_ptr;
6417
6418 objspace->live_ractor_cache_count++;
6419
6420 return calloc1(sizeof(rb_ractor_newobj_cache_t));
6421}
6422
6423void
6424rb_gc_impl_ractor_cache_free(void *objspace_ptr, void *cache)
6425{
6426 rb_objspace_t *objspace = objspace_ptr;
6427
6428 objspace->live_ractor_cache_count--;
6429 gc_ractor_newobj_cache_clear(cache, NULL);
6430 free(cache);
6431}
6432
6433static void
6434heap_ready_to_gc(rb_objspace_t *objspace, rb_heap_t *heap)
6435{
6436 if (!heap->free_pages) {
6437 if (!heap_page_allocate_and_initialize(objspace, heap)) {
6438 objspace->heap_pages.allocatable_bytes = HEAP_PAGE_SIZE;
6439 heap_page_allocate_and_initialize(objspace, heap);
6440 }
6441 }
6442}
6443
6444static int
6445ready_to_gc(rb_objspace_t *objspace)
6446{
6447 if (dont_gc_val() || during_gc) {
6448 for (int i = 0; i < HEAP_COUNT; i++) {
6449 rb_heap_t *heap = &heaps[i];
6450 heap_ready_to_gc(objspace, heap);
6451 }
6452 return FALSE;
6453 }
6454 else {
6455 return TRUE;
6456 }
6457}
6458
6459static void
6460gc_reset_malloc_info(rb_objspace_t *objspace, bool full_mark)
6461{
6462 gc_prof_set_malloc_info(objspace);
6463 {
6464 int64_t inc = gc_malloc_counters_increase(objspace, &objspace->malloc_counters.counters);
6465 size_t old_limit = malloc_limit;
6466
6467 /* A net-negative `inc` (more freed than malloc'd since last GC) is
6468 * treated the same as "allocated less than malloc_limit".
6469 * This matches what we were doing pre-monotonic counters, but is it right? */
6470 if (inc > 0 && (size_t)inc > malloc_limit) {
6471 malloc_limit = (size_t)((size_t)inc * gc_params.malloc_limit_growth_factor);
6472 if (malloc_limit > gc_params.malloc_limit_max) {
6473 malloc_limit = gc_params.malloc_limit_max;
6474 }
6475 }
6476 else {
6477 malloc_limit = (size_t)(malloc_limit * 0.98); /* magic number */
6478 if (malloc_limit < gc_params.malloc_limit_min) {
6479 malloc_limit = gc_params.malloc_limit_min;
6480 }
6481 }
6482
6483 if (0) {
6484 if (old_limit != malloc_limit) {
6485 fprintf(stderr, "[%"PRIuSIZE"] malloc_limit: %"PRIuSIZE" -> %"PRIuSIZE"\n",
6486 rb_gc_count(), old_limit, malloc_limit);
6487 }
6488 else {
6489 fprintf(stderr, "[%"PRIuSIZE"] malloc_limit: not changed (%"PRIuSIZE")\n",
6490 rb_gc_count(), malloc_limit);
6491 }
6492 }
6493 }
6494
6495 /* reset oldmalloc info */
6496#if RGENGC_ESTIMATE_OLDMALLOC
6497 if (!full_mark) {
6498 /* Don't snapshot on minor GC: oldmalloc_increase is meant to
6499 * accumulate across minor GCs and only reset at major GC. */
6500 int64_t oldmalloc_increase = gc_malloc_counters_increase(objspace, &objspace->malloc_counters.oldcounters);
6501 if (oldmalloc_increase > 0 &&
6502 (uint64_t)oldmalloc_increase > objspace->rgengc.oldmalloc_increase_limit) {
6503 gc_needs_major_flags |= GPR_FLAG_MAJOR_BY_OLDMALLOC;
6504 objspace->rgengc.oldmalloc_increase_limit =
6505 (size_t)(objspace->rgengc.oldmalloc_increase_limit * gc_params.oldmalloc_limit_growth_factor);
6506
6507 if (objspace->rgengc.oldmalloc_increase_limit > gc_params.oldmalloc_limit_max) {
6508 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_max;
6509 }
6510 }
6511
6512 if (0) fprintf(stderr, "%"PRIdSIZE"\t%d\t%"PRId64"\t%"PRIuSIZE"\t%"PRIdSIZE"\n",
6513 rb_gc_count(),
6514 gc_needs_major_flags,
6515 oldmalloc_increase,
6516 objspace->rgengc.oldmalloc_increase_limit,
6517 gc_params.oldmalloc_limit_max);
6518 }
6519 else {
6520 if ((objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_BY_OLDMALLOC) == 0) {
6521 objspace->rgengc.oldmalloc_increase_limit =
6522 (size_t)(objspace->rgengc.oldmalloc_increase_limit / ((gc_params.oldmalloc_limit_growth_factor - 1)/10 + 1));
6523 if (objspace->rgengc.oldmalloc_increase_limit < gc_params.oldmalloc_limit_min) {
6524 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
6525 }
6526 }
6527 }
6528#endif
6529}
6530
6531static int
6532garbage_collect(rb_objspace_t *objspace, unsigned int reason)
6533{
6534 int ret;
6535
6536 int lev = RB_GC_VM_LOCK();
6537 {
6538#if GC_PROFILE_MORE_DETAIL
6539 objspace->profile.prepare_time = getrusage_time();
6540#endif
6541
6542 gc_rest(objspace);
6543
6544#if GC_PROFILE_MORE_DETAIL
6545 objspace->profile.prepare_time = getrusage_time() - objspace->profile.prepare_time;
6546#endif
6547
6548 ret = gc_start(objspace, reason);
6549 }
6550 RB_GC_VM_UNLOCK(lev);
6551
6552 return ret;
6553}
6554
6555static int
6556gc_start(rb_objspace_t *objspace, unsigned int reason)
6557{
6558 unsigned int do_full_mark = !!(reason & GPR_FLAG_FULL_MARK);
6559
6560 if (!rb_darray_size(objspace->heap_pages.sorted)) return TRUE; /* heap is not ready */
6561 if (!(reason & GPR_FLAG_METHOD) && !ready_to_gc(objspace)) return TRUE; /* GC is not allowed */
6562
6563 rb_gc_initialize_vm_context(&objspace->vm_context);
6564
6565 GC_ASSERT(gc_mode(objspace) == gc_mode_none, "gc_mode is %s\n", gc_mode_name(gc_mode(objspace)));
6566 GC_ASSERT(!is_lazy_sweeping(objspace));
6567 GC_ASSERT(!is_incremental_marking(objspace));
6568
6569 unsigned int lock_lev;
6570 gc_enter(objspace, gc_enter_event_start, &lock_lev);
6571
6572 /* reason may be clobbered, later, so keep set immediate_sweep here */
6573 objspace->flags.immediate_sweep = !!(reason & GPR_FLAG_IMMEDIATE_SWEEP);
6574
6575#if RGENGC_CHECK_MODE >= 2
6576 gc_verify_internal_consistency(objspace);
6577#endif
6578
6579 if (ruby_gc_stressful) {
6580 int flag = FIXNUM_P(ruby_gc_stress_mode) ? FIX2INT(ruby_gc_stress_mode) : 0;
6581
6582 if ((flag & (1 << gc_stress_no_major)) == 0) {
6583 do_full_mark = TRUE;
6584 }
6585
6586 objspace->flags.immediate_sweep = !(flag & (1<<gc_stress_no_immediate_sweep));
6587 }
6588
6589 if (gc_needs_major_flags) {
6590 reason |= gc_needs_major_flags;
6591 do_full_mark = TRUE;
6592 }
6593
6594 /* if major gc has been disabled, never do a full mark */
6595 if (!gc_config_full_mark_val) {
6596 do_full_mark = FALSE;
6597 }
6598 gc_needs_major_flags = GPR_FLAG_NONE;
6599
6600 if (do_full_mark && (reason & GPR_FLAG_MAJOR_MASK) == 0) {
6601 reason |= GPR_FLAG_MAJOR_BY_FORCE; /* GC by CAPI, METHOD, and so on. */
6602 }
6603
6604 if (objspace->flags.dont_incremental ||
6605 reason & GPR_FLAG_IMMEDIATE_MARK ||
6606 ruby_gc_stressful) {
6607 objspace->flags.during_incremental_marking = FALSE;
6608 }
6609 else {
6610 objspace->flags.during_incremental_marking = do_full_mark;
6611 }
6612
6613 /* Explicitly enable compaction (GC.compact) */
6614 if (do_full_mark && ruby_enable_autocompact) {
6615 objspace->flags.during_compacting = TRUE;
6616#if RGENGC_CHECK_MODE
6617 objspace->rcompactor.compare_func = ruby_autocompact_compare_func;
6618#endif
6619 }
6620 else {
6621 objspace->flags.during_compacting = !!(reason & GPR_FLAG_COMPACT);
6622 }
6623
6624 if (!GC_ENABLE_LAZY_SWEEP || objspace->flags.dont_incremental) {
6625 objspace->flags.immediate_sweep = TRUE;
6626 }
6627
6628 if (objspace->flags.immediate_sweep) reason |= GPR_FLAG_IMMEDIATE_SWEEP;
6629
6630 gc_report(1, objspace, "gc_start(reason: %x) => %u, %d, %d\n",
6631 reason,
6632 do_full_mark, !is_incremental_marking(objspace), objspace->flags.immediate_sweep);
6633
6634 RB_DEBUG_COUNTER_INC(gc_count);
6635
6636 if (reason & GPR_FLAG_MAJOR_MASK) {
6637 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_nofree, reason & GPR_FLAG_MAJOR_BY_NOFREE);
6638 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_oldgen, reason & GPR_FLAG_MAJOR_BY_OLDGEN);
6639 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_shady, reason & GPR_FLAG_MAJOR_BY_SHADY);
6640 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_force, reason & GPR_FLAG_MAJOR_BY_FORCE);
6641#if RGENGC_ESTIMATE_OLDMALLOC
6642 (void)RB_DEBUG_COUNTER_INC_IF(gc_major_oldmalloc, reason & GPR_FLAG_MAJOR_BY_OLDMALLOC);
6643#endif
6644 }
6645 else {
6646 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_newobj, reason & GPR_FLAG_NEWOBJ);
6647 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_malloc, reason & GPR_FLAG_MALLOC);
6648 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_method, reason & GPR_FLAG_METHOD);
6649 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_capi, reason & GPR_FLAG_CAPI);
6650 (void)RB_DEBUG_COUNTER_INC_IF(gc_minor_stress, reason & GPR_FLAG_STRESS);
6651 }
6652
6653 objspace->profile.count++;
6654 objspace->profile.latest_gc_info = reason;
6655 objspace->profile.total_allocated_objects_at_gc_start = total_allocated_objects(objspace);
6656 objspace->profile.heap_used_at_gc_start = rb_darray_size(objspace->heap_pages.sorted);
6657 objspace->profile.heap_total_slots_at_gc_start = objspace_available_slots(objspace);
6658 objspace->profile.weak_references_count = 0;
6659 gc_prof_setup_new_record(objspace, reason);
6660 gc_reset_malloc_info(objspace, do_full_mark);
6661
6662 rb_gc_event_hook(0, RUBY_INTERNAL_EVENT_GC_START);
6663
6664 GC_ASSERT(during_gc);
6665
6666 gc_prof_timer_start(objspace);
6667 {
6668 if (gc_marks(objspace, do_full_mark)) {
6669 gc_sweep(objspace);
6670 }
6671 }
6672 gc_prof_timer_stop(objspace);
6673
6674 gc_exit(objspace, gc_enter_event_start, &lock_lev);
6675 return TRUE;
6676}
6677
6678static void
6679gc_rest(rb_objspace_t *objspace)
6680{
6681 if (is_incremental_marking(objspace) || is_lazy_sweeping(objspace)) {
6682 unsigned int lock_lev;
6683 gc_enter(objspace, gc_enter_event_rest, &lock_lev);
6684
6685 if (RGENGC_CHECK_MODE >= 2) gc_verify_internal_consistency(objspace);
6686
6687 if (is_incremental_marking(objspace)) {
6688 gc_marking_enter(objspace);
6689 gc_marks_rest(objspace);
6690 gc_marking_exit(objspace);
6691
6692 gc_sweep(objspace);
6693 }
6694
6695 if (is_lazy_sweeping(objspace)) {
6696 gc_sweeping_enter(objspace);
6697 gc_sweep_rest(objspace);
6698 gc_sweeping_exit(objspace);
6699 }
6700
6701 gc_exit(objspace, gc_enter_event_rest, &lock_lev);
6702 }
6703}
6704
6707 unsigned int reason;
6708};
6709
6710static void
6711gc_current_status_fill(rb_objspace_t *objspace, char *buff)
6712{
6713 int i = 0;
6714 if (is_marking(objspace)) {
6715 buff[i++] = 'M';
6716 if (is_full_marking(objspace)) buff[i++] = 'F';
6717 if (is_incremental_marking(objspace)) buff[i++] = 'I';
6718 }
6719 else if (is_sweeping(objspace)) {
6720 buff[i++] = 'S';
6721 if (is_lazy_sweeping(objspace)) buff[i++] = 'L';
6722 }
6723 else {
6724 buff[i++] = 'N';
6725 }
6726 buff[i] = '\0';
6727}
6728
6729static const char *
6730gc_current_status(rb_objspace_t *objspace)
6731{
6732 static char buff[0x10];
6733 gc_current_status_fill(objspace, buff);
6734 return buff;
6735}
6736
6737#if PRINT_ENTER_EXIT_TICK
6738
6739static tick_t last_exit_tick;
6740static tick_t enter_tick;
6741static int enter_count = 0;
6742static char last_gc_status[0x10];
6743
6744static inline void
6745gc_record(rb_objspace_t *objspace, int direction, const char *event)
6746{
6747 if (direction == 0) { /* enter */
6748 enter_count++;
6749 enter_tick = tick();
6750 gc_current_status_fill(objspace, last_gc_status);
6751 }
6752 else { /* exit */
6753 tick_t exit_tick = tick();
6754 char current_gc_status[0x10];
6755 gc_current_status_fill(objspace, current_gc_status);
6756#if 1
6757 /* [last mutator time] [gc time] [event] */
6758 fprintf(stderr, "%"PRItick"\t%"PRItick"\t%s\t[%s->%s|%c]\n",
6759 enter_tick - last_exit_tick,
6760 exit_tick - enter_tick,
6761 event,
6762 last_gc_status, current_gc_status,
6763 (objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_MASK) ? '+' : '-');
6764 last_exit_tick = exit_tick;
6765#else
6766 /* [enter_tick] [gc time] [event] */
6767 fprintf(stderr, "%"PRItick"\t%"PRItick"\t%s\t[%s->%s|%c]\n",
6768 enter_tick,
6769 exit_tick - enter_tick,
6770 event,
6771 last_gc_status, current_gc_status,
6772 (objspace->profile.latest_gc_info & GPR_FLAG_MAJOR_MASK) ? '+' : '-');
6773#endif
6774 }
6775}
6776#else /* PRINT_ENTER_EXIT_TICK */
6777static inline void
6778gc_record(rb_objspace_t *objspace, int direction, const char *event)
6779{
6780 /* null */
6781}
6782#endif /* PRINT_ENTER_EXIT_TICK */
6783
6784static const char *
6785gc_enter_event_cstr(enum gc_enter_event event)
6786{
6787 switch (event) {
6788 case gc_enter_event_start: return "start";
6789 case gc_enter_event_continue: return "continue";
6790 case gc_enter_event_rest: return "rest";
6791 case gc_enter_event_finalizer: return "finalizer";
6792 }
6793 return NULL;
6794}
6795
6796static void
6797gc_enter_count(enum gc_enter_event event)
6798{
6799 switch (event) {
6800 case gc_enter_event_start: RB_DEBUG_COUNTER_INC(gc_enter_start); break;
6801 case gc_enter_event_continue: RB_DEBUG_COUNTER_INC(gc_enter_continue); break;
6802 case gc_enter_event_rest: RB_DEBUG_COUNTER_INC(gc_enter_rest); break;
6803 case gc_enter_event_finalizer: RB_DEBUG_COUNTER_INC(gc_enter_finalizer); break;
6804 }
6805}
6806
6807static bool current_process_time(struct timespec *ts);
6808
6809static void
6810gc_clock_start(struct timespec *ts)
6811{
6812 if (!current_process_time(ts)) {
6813 ts->tv_sec = 0;
6814 ts->tv_nsec = 0;
6815 }
6816}
6817
6818static unsigned long long
6819gc_clock_end(struct timespec *ts)
6820{
6821 struct timespec end_time;
6822
6823 if ((ts->tv_sec > 0 || ts->tv_nsec > 0) &&
6824 current_process_time(&end_time) &&
6825 end_time.tv_sec >= ts->tv_sec) {
6826 return (unsigned long long)(end_time.tv_sec - ts->tv_sec) * (1000 * 1000 * 1000) +
6827 (end_time.tv_nsec - ts->tv_nsec);
6828 }
6829
6830 return 0;
6831}
6832
6833static inline void
6834gc_enter(rb_objspace_t *objspace, enum gc_enter_event event, unsigned int *lock_lev)
6835{
6836 *lock_lev = RB_GC_VM_LOCK();
6837
6838 switch (event) {
6839 case gc_enter_event_rest:
6840 case gc_enter_event_start:
6841 case gc_enter_event_continue:
6842 // stop other ractors
6843 rb_gc_vm_barrier();
6844 break;
6845 default:
6846 break;
6847 }
6848
6849 gc_enter_count(event);
6850 if (RB_UNLIKELY(during_gc != 0)) rb_bug("during_gc != 0");
6851 if (RGENGC_CHECK_MODE >= 3) gc_verify_internal_consistency(objspace);
6852
6853 during_gc = TRUE;
6854 RUBY_DEBUG_LOG("%s (%s)",gc_enter_event_cstr(event), gc_current_status(objspace));
6855 gc_report(1, objspace, "gc_enter: %s [%s]\n", gc_enter_event_cstr(event), gc_current_status(objspace));
6856 gc_record(objspace, 0, gc_enter_event_cstr(event));
6857
6858 rb_gc_event_hook(0, RUBY_INTERNAL_EVENT_GC_ENTER);
6859}
6860
6861static inline void
6862gc_exit(rb_objspace_t *objspace, enum gc_enter_event event, unsigned int *lock_lev)
6863{
6864 GC_ASSERT(during_gc != 0);
6865
6866 rb_gc_event_hook(0, RUBY_INTERNAL_EVENT_GC_EXIT);
6867
6868 gc_record(objspace, 1, gc_enter_event_cstr(event));
6869 RUBY_DEBUG_LOG("%s (%s)", gc_enter_event_cstr(event), gc_current_status(objspace));
6870 gc_report(1, objspace, "gc_exit: %s [%s]\n", gc_enter_event_cstr(event), gc_current_status(objspace));
6871 during_gc = FALSE;
6872
6873 RB_GC_VM_UNLOCK(*lock_lev);
6874}
6875
6876#ifndef MEASURE_GC
6877#define MEASURE_GC (objspace->flags.measure_gc)
6878#endif
6879
6880static void
6881gc_marking_enter(rb_objspace_t *objspace)
6882{
6883 GC_ASSERT(during_gc != 0);
6884
6885 if (MEASURE_GC) {
6886 gc_clock_start(&objspace->profile.marking_start_time);
6887 }
6888
6889 rb_gc_initialize_vm_context(&objspace->vm_context);
6890}
6891
6892static void
6893gc_marking_exit(rb_objspace_t *objspace)
6894{
6895 GC_ASSERT(during_gc != 0);
6896
6897 if (MEASURE_GC) {
6898 objspace->profile.marking_time_ns += gc_clock_end(&objspace->profile.marking_start_time);
6899 }
6900}
6901
6902static void
6903gc_sweeping_enter(rb_objspace_t *objspace)
6904{
6905 GC_ASSERT(during_gc != 0);
6906
6907 if (MEASURE_GC) {
6908 gc_clock_start(&objspace->profile.sweeping_start_time);
6909 }
6910}
6911
6912static void
6913gc_sweeping_exit(rb_objspace_t *objspace)
6914{
6915 GC_ASSERT(during_gc != 0);
6916
6917 if (MEASURE_GC) {
6918 objspace->profile.sweeping_time_ns += gc_clock_end(&objspace->profile.sweeping_start_time);
6919 }
6920}
6921
6922static void *
6923gc_with_gvl(void *ptr)
6924{
6925 struct objspace_and_reason *oar = (struct objspace_and_reason *)ptr;
6926 return (void *)(VALUE)garbage_collect(oar->objspace, oar->reason);
6927}
6928
6929int ruby_thread_has_gvl_p(void);
6930
6931static int
6932garbage_collect_with_gvl(rb_objspace_t *objspace, unsigned int reason)
6933{
6934 if (dont_gc_val()) {
6935 return TRUE;
6936 }
6937 else if (!ruby_native_thread_p()) {
6938 return TRUE;
6939 }
6940 else if (!ruby_thread_has_gvl_p()) {
6941 void *ret;
6942 struct objspace_and_reason oar;
6943 oar.objspace = objspace;
6944 oar.reason = reason;
6945 ret = rb_thread_call_with_gvl(gc_with_gvl, (void *)&oar);
6946
6947 return !!ret;
6948 }
6949 else {
6950 return garbage_collect(objspace, reason);
6951 }
6952}
6953
6954static int
6955gc_set_candidate_object_i(void *vstart, void *vend, size_t stride, void *data)
6956{
6958
6959 VALUE v = (VALUE)vstart;
6960 for (; v != (VALUE)vend; v += stride) {
6961 asan_unpoisoning_object(v) {
6962 switch (BUILTIN_TYPE(v)) {
6963 case T_NONE:
6964 case T_ZOMBIE:
6965 break;
6966 default:
6967 rb_gc_prepare_heap_process_object(v);
6968 if (!RVALUE_OLD_P(objspace, v) && !RVALUE_WB_UNPROTECTED(objspace, v)) {
6969 RVALUE_AGE_SET_CANDIDATE(objspace, v);
6970 }
6971 }
6972 }
6973 }
6974
6975 return 0;
6976}
6977
6978void
6979rb_gc_impl_start(void *objspace_ptr, bool full_mark, bool immediate_mark, bool immediate_sweep, bool compact)
6980{
6981 rb_objspace_t *objspace = objspace_ptr;
6982 unsigned int reason = (GPR_FLAG_FULL_MARK |
6983 GPR_FLAG_IMMEDIATE_MARK |
6984 GPR_FLAG_IMMEDIATE_SWEEP |
6985 GPR_FLAG_METHOD);
6986
6987 int full_marking_p = gc_config_full_mark_val;
6988 gc_config_full_mark_set(TRUE);
6989
6990 /* For now, compact implies full mark / sweep, so ignore other flags */
6991 if (compact) {
6992 GC_ASSERT(GC_COMPACTION_SUPPORTED);
6993
6994 reason |= GPR_FLAG_COMPACT;
6995 }
6996 else {
6997 if (!full_mark) reason &= ~GPR_FLAG_FULL_MARK;
6998 if (!immediate_mark) reason &= ~GPR_FLAG_IMMEDIATE_MARK;
6999 if (!immediate_sweep) reason &= ~GPR_FLAG_IMMEDIATE_SWEEP;
7000 }
7001
7002 garbage_collect(objspace, reason);
7003 gc_finalize_deferred(objspace);
7004
7005 gc_config_full_mark_set(full_marking_p);
7006}
7007
7008void
7009rb_gc_impl_prepare_heap(void *objspace_ptr)
7010{
7011 rb_objspace_t *objspace = objspace_ptr;
7012
7013 size_t orig_total_slots = objspace_available_slots(objspace);
7014 size_t orig_allocatable_bytes = objspace->heap_pages.allocatable_bytes;
7015
7016 rb_gc_impl_each_objects(objspace, gc_set_candidate_object_i, objspace_ptr);
7017
7018 double orig_max_free_slots = gc_params.heap_free_slots_max_ratio;
7019 /* Ensure that all empty pages are moved onto empty_pages. */
7020 gc_params.heap_free_slots_max_ratio = 0.0;
7021 rb_gc_impl_start(objspace, true, true, true, true);
7022 gc_params.heap_free_slots_max_ratio = orig_max_free_slots;
7023
7024 objspace->heap_pages.allocatable_bytes = 0;
7025 heap_pages_freeable_pages = objspace->empty_pages_count;
7026 heap_pages_free_unused_pages(objspace_ptr);
7027 GC_ASSERT(heap_pages_freeable_pages == 0);
7028 GC_ASSERT(objspace->empty_pages_count == 0);
7029 objspace->heap_pages.allocatable_bytes = orig_allocatable_bytes;
7030
7031 size_t total_slots = objspace_available_slots(objspace);
7032 if (orig_total_slots > total_slots) {
7033 objspace->heap_pages.allocatable_bytes += (orig_total_slots - total_slots) * heaps[0].slot_size;
7034 }
7035
7036#if defined(HAVE_MALLOC_TRIM) && !defined(RUBY_ALTERNATIVE_MALLOC_HEADER)
7037 malloc_trim(0);
7038#endif
7039}
7040
7041static int
7042gc_is_moveable_obj(rb_objspace_t *objspace, VALUE obj)
7043{
7044 GC_ASSERT(!SPECIAL_CONST_P(obj));
7045
7046 switch (BUILTIN_TYPE(obj)) {
7047 case T_NONE:
7048 case T_MOVED:
7049 case T_ZOMBIE:
7050 return FALSE;
7051 case T_SYMBOL:
7052 case T_STRING:
7053 case T_OBJECT:
7054 case T_FLOAT:
7055 case T_IMEMO:
7056 case T_ARRAY:
7057 case T_BIGNUM:
7058 case T_ICLASS:
7059 case T_MODULE:
7060 case T_REGEXP:
7061 case T_DATA:
7062 case T_MATCH:
7063 case T_STRUCT:
7064 case T_HASH:
7065 case T_FILE:
7066 case T_COMPLEX:
7067 case T_RATIONAL:
7068 case T_NODE:
7069 case T_CLASS:
7070 if (FL_TEST_RAW(obj, FL_FINALIZE)) {
7071 /* The finalizer table is a numtable. It looks up objects by address.
7072 * We can't mark the keys in the finalizer table because that would
7073 * prevent the objects from being collected. This check prevents
7074 * objects that are keys in the finalizer table from being moved
7075 * without directly pinning them. */
7076 GC_ASSERT(st_is_member(finalizer_table, obj));
7077
7078 return FALSE;
7079 }
7080 GC_ASSERT(RVALUE_MARKED(objspace, obj));
7081 GC_ASSERT(!RVALUE_PINNED(objspace, obj));
7082
7083 return TRUE;
7084
7085 default:
7086 rb_bug("gc_is_moveable_obj: unreachable (%d)", (int)BUILTIN_TYPE(obj));
7087 break;
7088 }
7089
7090 return FALSE;
7091}
7092
7093void rb_mv_generic_ivar(VALUE src, VALUE dst);
7094
7095static VALUE
7096gc_move(rb_objspace_t *objspace, VALUE src, VALUE dest, struct heap_page *src_page, struct heap_page *dest_page)
7097{
7098 size_t src_slot_size = src_page->slot_size;
7099 size_t slot_size = dest_page->slot_size;
7100
7101 int marked;
7102 int wb_unprotected;
7103 int uncollectible;
7104 int age;
7105
7106 gc_report(4, objspace, "Moving object: %p -> %p\n", (void *)src, (void *)dest);
7107
7108 GC_ASSERT(BUILTIN_TYPE(src) != T_NONE);
7109 GC_ASSERT(!MARKED_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest));
7110
7111 GC_ASSERT(!RVALUE_MARKING(objspace, src));
7112
7113 /* Save off bits for current object. */
7114 marked = RVALUE_MARKED(objspace, src);
7115 wb_unprotected = RVALUE_WB_UNPROTECTED(objspace, src);
7116 uncollectible = RVALUE_UNCOLLECTIBLE(objspace, src);
7117 bool remembered = RVALUE_REMEMBERED(objspace, src);
7118 age = RVALUE_AGE_GET(src);
7119
7120 /* Clear bits for eventual T_MOVED */
7121 CLEAR_IN_BITMAP(GET_HEAP_MARK_BITS(src), src);
7122 CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(src), src);
7123 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(src), src);
7124 CLEAR_IN_BITMAP(GET_HEAP_PAGE(src)->remembered_bits, src);
7125
7126 /* Move the object */
7127 memcpy((void *)dest, (void *)src, MIN(src_slot_size, slot_size));
7128
7129 if (src_slot_size != slot_size && RB_TYPE_P(src, T_OBJECT)) {
7130 rb_gc_obj_changed_pool(dest, dest_page->heap - heaps);
7131 }
7132
7133 if (RVALUE_OVERHEAD > 0) {
7134 void *dest_overhead = (void *)(((uintptr_t)dest) + slot_size - RVALUE_OVERHEAD);
7135 void *src_overhead = (void *)(((uintptr_t)src) + src_slot_size - RVALUE_OVERHEAD);
7136
7137 memcpy(dest_overhead, src_overhead, RVALUE_OVERHEAD);
7138 }
7139
7140 memset((void *)src, 0, src_slot_size);
7141 RVALUE_AGE_SET_BITMAP(src, 0);
7142
7143 /* Set bits for object in new location */
7144 if (remembered) {
7145 MARK_IN_BITMAP(GET_HEAP_PAGE(dest)->remembered_bits, dest);
7146 }
7147 else {
7148 CLEAR_IN_BITMAP(GET_HEAP_PAGE(dest)->remembered_bits, dest);
7149 }
7150
7151 if (marked) {
7152 MARK_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest);
7153 }
7154 else {
7155 CLEAR_IN_BITMAP(GET_HEAP_MARK_BITS(dest), dest);
7156 }
7157
7158 if (wb_unprotected) {
7159 MARK_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(dest), dest);
7160 }
7161 else {
7162 CLEAR_IN_BITMAP(GET_HEAP_WB_UNPROTECTED_BITS(dest), dest);
7163 }
7164
7165 if (uncollectible) {
7166 MARK_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(dest), dest);
7167 }
7168 else {
7169 CLEAR_IN_BITMAP(GET_HEAP_UNCOLLECTIBLE_BITS(dest), dest);
7170 }
7171
7172 RVALUE_AGE_SET(dest, age);
7173 /* Assign forwarding address */
7174 RMOVED(src)->flags = T_MOVED;
7175 RMOVED(src)->dummy = Qundef;
7176 RMOVED(src)->destination = dest;
7177 GC_ASSERT(BUILTIN_TYPE(dest) != T_NONE);
7178
7179 GET_HEAP_PAGE(src)->heap->total_freed_objects++;
7180 GET_HEAP_PAGE(dest)->heap->total_allocated_objects++;
7181
7182 return src;
7183}
7184
7185#if GC_CAN_COMPILE_COMPACTION
7186static int
7187compare_pinned_slots(const void *left, const void *right, void *dummy)
7188{
7189 struct heap_page *left_page;
7190 struct heap_page *right_page;
7191
7192 left_page = *(struct heap_page * const *)left;
7193 right_page = *(struct heap_page * const *)right;
7194
7195 return left_page->pinned_slots - right_page->pinned_slots;
7196}
7197
7198static int
7199compare_free_slots(const void *left, const void *right, void *dummy)
7200{
7201 struct heap_page *left_page;
7202 struct heap_page *right_page;
7203
7204 left_page = *(struct heap_page * const *)left;
7205 right_page = *(struct heap_page * const *)right;
7206
7207 return left_page->free_slots - right_page->free_slots;
7208}
7209
7210static void
7211gc_sort_heap_by_compare_func(rb_objspace_t *objspace, gc_compact_compare_func compare_func)
7212{
7213 for (int j = 0; j < HEAP_COUNT; j++) {
7214 rb_heap_t *heap = &heaps[j];
7215
7216 size_t total_pages = heap->total_pages;
7217 size_t size = rb_size_mul_or_raise(total_pages, sizeof(struct heap_page *), rb_eRuntimeError);
7218 struct heap_page *page = 0, **page_list = malloc(size);
7219 size_t i = 0;
7220
7221 heap->free_pages = NULL;
7222 ccan_list_for_each(&heap->pages, page, page_node) {
7223 page_list[i++] = page;
7224 GC_ASSERT(page);
7225 }
7226
7227 GC_ASSERT((size_t)i == total_pages);
7228
7229 /* Sort the heap so "filled pages" are first. `heap_add_page` adds to the
7230 * head of the list, so empty pages will end up at the start of the heap */
7231 ruby_qsort(page_list, total_pages, sizeof(struct heap_page *), compare_func, NULL);
7232
7233 /* Reset the eden heap */
7234 ccan_list_head_init(&heap->pages);
7235
7236 for (i = 0; i < total_pages; i++) {
7237 ccan_list_add(&heap->pages, &page_list[i]->page_node);
7238 if (page_list[i]->free_slots != 0) {
7239 heap_add_freepage(heap, page_list[i]);
7240 }
7241 }
7242
7243 free(page_list);
7244 }
7245}
7246#endif
7247
7248void
7249rb_gc_impl_register_pinning_obj(void *objspace_ptr, VALUE obj)
7250{
7251 /* no-op */
7252}
7253
7254bool
7255rb_gc_impl_object_moved_p(void *objspace_ptr, VALUE obj)
7256{
7257 return gc_object_moved_p(objspace_ptr, obj);
7258}
7259
7260static int
7261gc_ref_update(void *vstart, void *vend, size_t stride, rb_objspace_t *objspace, struct heap_page *page)
7262{
7263 VALUE v = (VALUE)vstart;
7264
7265 page->flags.has_uncollectible_wb_unprotected_objects = FALSE;
7266 page->flags.has_remembered_objects = FALSE;
7267
7268 /* For each object on the page */
7269 for (; v != (VALUE)vend; v += stride) {
7270 asan_unpoisoning_object(v) {
7271 switch (BUILTIN_TYPE(v)) {
7272 case T_NONE:
7273 case T_MOVED:
7274 case T_ZOMBIE:
7275 break;
7276 default:
7277 if (RVALUE_WB_UNPROTECTED(objspace, v)) {
7278 page->flags.has_uncollectible_wb_unprotected_objects = TRUE;
7279 }
7280 if (RVALUE_REMEMBERED(objspace, v)) {
7281 page->flags.has_remembered_objects = TRUE;
7282 }
7283 if (page->flags.before_sweep) {
7284 if (RVALUE_MARKED(objspace, v)) {
7285 rb_gc_update_object_references(objspace, v);
7286 }
7287 }
7288 else {
7289 rb_gc_update_object_references(objspace, v);
7290 }
7291 }
7292 }
7293 }
7294
7295 return 0;
7296}
7297
7298static int
7299gc_update_references_weak_table_i(VALUE obj, void *data)
7300{
7301 int ret;
7302 asan_unpoisoning_object(obj) {
7303 ret = BUILTIN_TYPE(obj) == T_MOVED ? ST_REPLACE : ST_CONTINUE;
7304 }
7305 return ret;
7306}
7307
7308static int
7309gc_update_references_weak_table_replace_i(VALUE *obj, void *data)
7310{
7311 *obj = rb_gc_location(*obj);
7312
7313 return ST_CONTINUE;
7314}
7315
7316static void
7317gc_update_references(rb_objspace_t *objspace)
7318{
7319 objspace->flags.during_reference_updating = true;
7320
7321 rb_gc_before_updating_jit_code();
7322
7323 struct heap_page *page = NULL;
7324
7325 for (int i = 0; i < HEAP_COUNT; i++) {
7326 bool should_set_mark_bits = TRUE;
7327 rb_heap_t *heap = &heaps[i];
7328
7329 ccan_list_for_each(&heap->pages, page, page_node) {
7330 uintptr_t start = (uintptr_t)page->start;
7331 uintptr_t end = start + (page->total_slots * heap->slot_size);
7332
7333 gc_ref_update((void *)start, (void *)end, heap->slot_size, objspace, page);
7334 if (page == heap->sweeping_page) {
7335 should_set_mark_bits = FALSE;
7336 }
7337 if (should_set_mark_bits) {
7338 gc_setup_mark_bits(page);
7339 }
7340 }
7341 }
7342
7343 gc_update_table_refs(finalizer_table);
7344
7345 rb_gc_update_vm_references((void *)objspace);
7346
7347 for (int table = 0; table < RB_GC_VM_WEAK_TABLE_COUNT; table++) {
7348 rb_gc_vm_weak_table_foreach(
7349 gc_update_references_weak_table_i,
7350 gc_update_references_weak_table_replace_i,
7351 NULL,
7352 false,
7353 table
7354 );
7355 }
7356
7357 rb_gc_after_updating_jit_code();
7358
7359 objspace->flags.during_reference_updating = false;
7360}
7361
7362#if GC_CAN_COMPILE_COMPACTION
7363static void
7364root_obj_check_moved_i(const char *category, VALUE obj, void *data)
7365{
7366 rb_objspace_t *objspace = data;
7367
7368 if (gc_object_moved_p(objspace, obj)) {
7369 rb_bug("ROOT %s points to MOVED: %p -> %s", category, (void *)obj, rb_obj_info(rb_gc_impl_location(objspace, obj)));
7370 }
7371}
7372
7373static void
7374reachable_object_check_moved_i(VALUE ref, void *data)
7375{
7376 VALUE parent = (VALUE)data;
7377 if (gc_object_moved_p(rb_gc_get_objspace(), ref)) {
7378 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)));
7379 }
7380}
7381
7382static int
7383heap_check_moved_i(void *vstart, void *vend, size_t stride, void *data)
7384{
7385 rb_objspace_t *objspace = data;
7386
7387 VALUE v = (VALUE)vstart;
7388 for (; v != (VALUE)vend; v += stride) {
7389 if (gc_object_moved_p(objspace, v)) {
7390 /* Moved object still on the heap, something may have a reference. */
7391 }
7392 else {
7393 asan_unpoisoning_object(v) {
7394 switch (BUILTIN_TYPE(v)) {
7395 case T_NONE:
7396 case T_ZOMBIE:
7397 break;
7398 default:
7399 if (!rb_gc_impl_garbage_object_p(objspace, v)) {
7400 rb_objspace_reachable_objects_from(v, reachable_object_check_moved_i, (void *)v);
7401 }
7402 }
7403 }
7404 }
7405 }
7406
7407 return 0;
7408}
7409#endif
7410
7411bool
7412rb_gc_impl_during_gc_p(void *objspace_ptr)
7413{
7414 rb_objspace_t *objspace = objspace_ptr;
7415
7416 return during_gc;
7417}
7418
7419#if RGENGC_PROFILE >= 2
7420
7421static const char*
7422type_name(int type, VALUE obj)
7423{
7424 switch ((enum ruby_value_type)type) {
7425 case RUBY_T_NONE: return "T_NONE";
7426 case RUBY_T_OBJECT: return "T_OBJECT";
7427 case RUBY_T_CLASS: return "T_CLASS";
7428 case RUBY_T_MODULE: return "T_MODULE";
7429 case RUBY_T_FLOAT: return "T_FLOAT";
7430 case RUBY_T_STRING: return "T_STRING";
7431 case RUBY_T_REGEXP: return "T_REGEXP";
7432 case RUBY_T_ARRAY: return "T_ARRAY";
7433 case RUBY_T_HASH: return "T_HASH";
7434 case RUBY_T_STRUCT: return "T_STRUCT";
7435 case RUBY_T_BIGNUM: return "T_BIGNUM";
7436 case RUBY_T_FILE: return "T_FILE";
7437 case RUBY_T_DATA: return "T_DATA";
7438 case RUBY_T_MATCH: return "T_MATCH";
7439 case RUBY_T_COMPLEX: return "T_COMPLEX";
7440 case RUBY_T_RATIONAL: return "T_RATIONAL";
7441 case RUBY_T_NIL: return "T_NIL";
7442 case RUBY_T_TRUE: return "T_TRUE";
7443 case RUBY_T_FALSE: return "T_FALSE";
7444 case RUBY_T_SYMBOL: return "T_SYMBOL";
7445 case RUBY_T_FIXNUM: return "T_FIXNUM";
7446 case RUBY_T_UNDEF: return "T_UNDEF";
7447 case RUBY_T_IMEMO: return "T_IMEMO";
7448 case RUBY_T_NODE: return "T_NODE";
7449 case RUBY_T_ICLASS: return "T_ICLASS";
7450 case RUBY_T_ZOMBIE: return "T_ZOMBIE";
7451 case RUBY_T_MOVED: return "T_MOVED";
7452 default: return "unknown";
7453 }
7454}
7455
7456static void
7457gc_count_add_each_types(VALUE hash, const char *name, const size_t *types)
7458{
7459 VALUE result = rb_hash_new_with_size(T_MASK);
7460 int i;
7461 for (i=0; i<T_MASK; i++) {
7462 const char *type = type_name(i, 0);
7463 rb_hash_aset(result, ID2SYM(rb_intern(type)), SIZET2NUM(types[i]));
7464 }
7465 rb_hash_aset(hash, ID2SYM(rb_intern(name)), result);
7466}
7467#endif
7468
7469size_t
7470rb_gc_impl_gc_count(void *objspace_ptr)
7471{
7472 rb_objspace_t *objspace = objspace_ptr;
7473
7474 return objspace->profile.count;
7475}
7476
7477static VALUE
7478gc_info_decode(rb_objspace_t *objspace, const VALUE hash_or_key, const unsigned int orig_flags)
7479{
7480 static VALUE sym_major_by = Qnil, sym_gc_by, sym_immediate_sweep, sym_have_finalizer, sym_state, sym_need_major_by;
7481 static VALUE sym_nofree, sym_oldgen, sym_shady, sym_force, sym_stress;
7482#if RGENGC_ESTIMATE_OLDMALLOC
7483 static VALUE sym_oldmalloc;
7484#endif
7485 static VALUE sym_newobj, sym_malloc, sym_method, sym_capi;
7486 static VALUE sym_none, sym_marking, sym_sweeping;
7487 static VALUE sym_weak_references_count;
7488 VALUE hash = Qnil, key = Qnil;
7489 VALUE major_by, need_major_by;
7490 unsigned int flags = orig_flags ? orig_flags : objspace->profile.latest_gc_info;
7491
7492 if (SYMBOL_P(hash_or_key)) {
7493 key = hash_or_key;
7494 }
7495 else if (RB_TYPE_P(hash_or_key, T_HASH)) {
7496 hash = hash_or_key;
7497 }
7498 else {
7499 rb_bug("gc_info_decode: non-hash or symbol given");
7500 }
7501
7502 if (NIL_P(sym_major_by)) {
7503#define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
7504 S(major_by);
7505 S(gc_by);
7506 S(immediate_sweep);
7507 S(have_finalizer);
7508 S(state);
7509 S(need_major_by);
7510
7511 S(stress);
7512 S(nofree);
7513 S(oldgen);
7514 S(shady);
7515 S(force);
7516#if RGENGC_ESTIMATE_OLDMALLOC
7517 S(oldmalloc);
7518#endif
7519 S(newobj);
7520 S(malloc);
7521 S(method);
7522 S(capi);
7523
7524 S(none);
7525 S(marking);
7526 S(sweeping);
7527
7528 S(weak_references_count);
7529#undef S
7530 }
7531
7532#define SET(name, attr) \
7533 if (key == sym_##name) \
7534 return (attr); \
7535 else if (hash != Qnil) \
7536 rb_hash_aset(hash, sym_##name, (attr));
7537
7538 major_by =
7539 (flags & GPR_FLAG_MAJOR_BY_NOFREE) ? sym_nofree :
7540 (flags & GPR_FLAG_MAJOR_BY_OLDGEN) ? sym_oldgen :
7541 (flags & GPR_FLAG_MAJOR_BY_SHADY) ? sym_shady :
7542 (flags & GPR_FLAG_MAJOR_BY_FORCE) ? sym_force :
7543#if RGENGC_ESTIMATE_OLDMALLOC
7544 (flags & GPR_FLAG_MAJOR_BY_OLDMALLOC) ? sym_oldmalloc :
7545#endif
7546 Qnil;
7547 SET(major_by, major_by);
7548
7549 if (orig_flags == 0) { /* set need_major_by only if flags not set explicitly */
7550 unsigned int need_major_flags = gc_needs_major_flags;
7551 need_major_by =
7552 (need_major_flags & GPR_FLAG_MAJOR_BY_NOFREE) ? sym_nofree :
7553 (need_major_flags & GPR_FLAG_MAJOR_BY_OLDGEN) ? sym_oldgen :
7554 (need_major_flags & GPR_FLAG_MAJOR_BY_SHADY) ? sym_shady :
7555 (need_major_flags & GPR_FLAG_MAJOR_BY_FORCE) ? sym_force :
7556#if RGENGC_ESTIMATE_OLDMALLOC
7557 (need_major_flags & GPR_FLAG_MAJOR_BY_OLDMALLOC) ? sym_oldmalloc :
7558#endif
7559 Qnil;
7560 SET(need_major_by, need_major_by);
7561 }
7562
7563 SET(gc_by,
7564 (flags & GPR_FLAG_NEWOBJ) ? sym_newobj :
7565 (flags & GPR_FLAG_MALLOC) ? sym_malloc :
7566 (flags & GPR_FLAG_METHOD) ? sym_method :
7567 (flags & GPR_FLAG_CAPI) ? sym_capi :
7568 (flags & GPR_FLAG_STRESS) ? sym_stress :
7569 Qnil
7570 );
7571
7572 SET(have_finalizer, (flags & GPR_FLAG_HAVE_FINALIZE) ? Qtrue : Qfalse);
7573 SET(immediate_sweep, (flags & GPR_FLAG_IMMEDIATE_SWEEP) ? Qtrue : Qfalse);
7574
7575 if (orig_flags == 0) {
7576 SET(state, gc_mode(objspace) == gc_mode_none ? sym_none :
7577 gc_mode(objspace) == gc_mode_marking ? sym_marking : sym_sweeping);
7578 }
7579
7580 SET(weak_references_count, LONG2FIX(objspace->profile.weak_references_count));
7581#undef SET
7582
7583 if (!NIL_P(key)) {
7584 // Matched key should return above
7585 return Qundef;
7586 }
7587
7588 return hash;
7589}
7590
7591VALUE
7592rb_gc_impl_latest_gc_info(void *objspace_ptr, VALUE key)
7593{
7594 rb_objspace_t *objspace = objspace_ptr;
7595
7596 return gc_info_decode(objspace, key, 0);
7597}
7598
7599
7600enum gc_stat_sym {
7601 gc_stat_sym_count,
7602 gc_stat_sym_time,
7603 gc_stat_sym_marking_time,
7604 gc_stat_sym_sweeping_time,
7605 gc_stat_sym_heap_allocated_pages,
7606 gc_stat_sym_heap_empty_pages,
7607 gc_stat_sym_heap_allocatable_bytes,
7608 gc_stat_sym_heap_available_slots,
7609 gc_stat_sym_heap_live_slots,
7610 gc_stat_sym_heap_free_slots,
7611 gc_stat_sym_heap_final_slots,
7612 gc_stat_sym_heap_marked_slots,
7613 gc_stat_sym_heap_eden_pages,
7614 gc_stat_sym_total_allocated_pages,
7615 gc_stat_sym_total_freed_pages,
7616 gc_stat_sym_total_allocated_objects,
7617 gc_stat_sym_total_freed_objects,
7618 gc_stat_sym_total_malloc_bytes,
7619 gc_stat_sym_total_free_bytes,
7620 gc_stat_sym_malloc_increase_bytes,
7621 gc_stat_sym_malloc_increase_bytes_limit,
7622 gc_stat_sym_minor_gc_count,
7623 gc_stat_sym_major_gc_count,
7624 gc_stat_sym_compact_count,
7625 gc_stat_sym_read_barrier_faults,
7626 gc_stat_sym_total_moved_objects,
7627 gc_stat_sym_remembered_wb_unprotected_objects,
7628 gc_stat_sym_remembered_wb_unprotected_objects_limit,
7629 gc_stat_sym_old_objects,
7630 gc_stat_sym_old_objects_limit,
7631#if RGENGC_ESTIMATE_OLDMALLOC
7632 gc_stat_sym_oldmalloc_increase_bytes,
7633 gc_stat_sym_oldmalloc_increase_bytes_limit,
7634#endif
7635#if RGENGC_PROFILE
7636 gc_stat_sym_total_generated_normal_object_count,
7637 gc_stat_sym_total_generated_shady_object_count,
7638 gc_stat_sym_total_shade_operation_count,
7639 gc_stat_sym_total_promoted_count,
7640 gc_stat_sym_total_remembered_normal_object_count,
7641 gc_stat_sym_total_remembered_shady_object_count,
7642#endif
7643 gc_stat_sym_last
7644};
7645
7646static VALUE gc_stat_symbols[gc_stat_sym_last];
7647
7648static void
7649setup_gc_stat_symbols(void)
7650{
7651 if (gc_stat_symbols[0] == 0) {
7652#define S(s) gc_stat_symbols[gc_stat_sym_##s] = ID2SYM(rb_intern_const(#s))
7653 S(count);
7654 S(time);
7655 S(marking_time),
7656 S(sweeping_time),
7657 S(heap_allocated_pages);
7658 S(heap_empty_pages);
7659 S(heap_allocatable_bytes);
7660 S(heap_available_slots);
7661 S(heap_live_slots);
7662 S(heap_free_slots);
7663 S(heap_final_slots);
7664 S(heap_marked_slots);
7665 S(heap_eden_pages);
7666 S(total_allocated_pages);
7667 S(total_freed_pages);
7668 S(total_allocated_objects);
7669 S(total_freed_objects);
7670 S(total_malloc_bytes);
7671 S(total_free_bytes);
7672 S(malloc_increase_bytes);
7673 S(malloc_increase_bytes_limit);
7674 S(minor_gc_count);
7675 S(major_gc_count);
7676 S(compact_count);
7677 S(read_barrier_faults);
7678 S(total_moved_objects);
7679 S(remembered_wb_unprotected_objects);
7680 S(remembered_wb_unprotected_objects_limit);
7681 S(old_objects);
7682 S(old_objects_limit);
7683#if RGENGC_ESTIMATE_OLDMALLOC
7684 S(oldmalloc_increase_bytes);
7685 S(oldmalloc_increase_bytes_limit);
7686#endif
7687#if RGENGC_PROFILE
7688 S(total_generated_normal_object_count);
7689 S(total_generated_shady_object_count);
7690 S(total_shade_operation_count);
7691 S(total_promoted_count);
7692 S(total_remembered_normal_object_count);
7693 S(total_remembered_shady_object_count);
7694#endif /* RGENGC_PROFILE */
7695#undef S
7696 }
7697}
7698
7699static uint64_t
7700ns_to_ms(uint64_t ns)
7701{
7702 return ns / (1000 * 1000);
7703}
7704
7705static void malloc_increase_local_flush(rb_objspace_t *objspace);
7706
7707VALUE
7708rb_gc_impl_stat(void *objspace_ptr, VALUE hash_or_sym)
7709{
7710 rb_objspace_t *objspace = objspace_ptr;
7711 VALUE hash = Qnil, key = Qnil;
7712
7713 setup_gc_stat_symbols();
7714
7715 ractor_cache_flush_count(objspace, rb_gc_get_ractor_newobj_cache());
7716 malloc_increase_local_flush(objspace);
7717
7718 if (RB_TYPE_P(hash_or_sym, T_HASH)) {
7719 hash = hash_or_sym;
7720 }
7721 else if (SYMBOL_P(hash_or_sym)) {
7722 key = hash_or_sym;
7723 }
7724 else {
7725 rb_bug("non-hash or symbol given");
7726 }
7727
7728#define SET(name, attr) \
7729 if (key == gc_stat_symbols[gc_stat_sym_##name]) \
7730 return SIZET2NUM(attr); \
7731 else if (hash != Qnil) \
7732 rb_hash_aset(hash, gc_stat_symbols[gc_stat_sym_##name], SIZET2NUM(attr));
7733#define SET64(name, attr) \
7734 if (key == gc_stat_symbols[gc_stat_sym_##name]) \
7735 return ULL2NUM(attr); \
7736 else if (hash != Qnil) \
7737 rb_hash_aset(hash, gc_stat_symbols[gc_stat_sym_##name], ULL2NUM(attr));
7738
7739 SET(count, objspace->profile.count);
7740 SET(time, (size_t)ns_to_ms(objspace->profile.marking_time_ns + objspace->profile.sweeping_time_ns)); // TODO: UINT64T2NUM
7741 SET(marking_time, (size_t)ns_to_ms(objspace->profile.marking_time_ns));
7742 SET(sweeping_time, (size_t)ns_to_ms(objspace->profile.sweeping_time_ns));
7743
7744 {
7745 uint64_t total_malloc = (uint64_t)gc_counter_load_relaxed(&objspace->malloc_counters.counters.malloc);
7746 uint64_t total_free = (uint64_t)gc_counter_load_relaxed(&objspace->malloc_counters.counters.free);
7747 SET64(total_malloc_bytes, total_malloc);
7748 SET64(total_free_bytes, total_free);
7749 }
7750
7751 /* implementation dependent counters (small / fixnum-safe) */
7752 SET(heap_allocated_pages, rb_darray_size(objspace->heap_pages.sorted));
7753 SET(heap_empty_pages, objspace->empty_pages_count)
7754 SET(heap_allocatable_bytes, objspace->heap_pages.allocatable_bytes);
7755 SET(heap_eden_pages, heap_eden_total_pages(objspace));
7756 SET(total_allocated_pages, objspace->heap_pages.allocated_pages);
7757 SET(total_freed_pages, objspace->heap_pages.freed_pages);
7758 SET(malloc_increase_bytes, gc_malloc_counters_increase_unsigned(objspace, &objspace->malloc_counters.counters));
7759 SET(malloc_increase_bytes_limit, malloc_limit);
7760 SET(minor_gc_count, objspace->profile.minor_gc_count);
7761 SET(major_gc_count, objspace->profile.major_gc_count);
7762 SET(compact_count, objspace->profile.compact_count);
7763 SET(read_barrier_faults, objspace->profile.read_barrier_faults);
7764 SET(total_moved_objects, objspace->rcompactor.total_moved);
7765 SET(remembered_wb_unprotected_objects, objspace->rgengc.uncollectible_wb_unprotected_objects);
7766 SET(remembered_wb_unprotected_objects_limit, objspace->rgengc.uncollectible_wb_unprotected_objects_limit);
7767 SET(old_objects, objspace->rgengc.old_objects);
7768 SET(old_objects_limit, objspace->rgengc.old_objects_limit);
7769#if RGENGC_ESTIMATE_OLDMALLOC
7770 SET(oldmalloc_increase_bytes, gc_malloc_counters_increase_unsigned(objspace, &objspace->malloc_counters.oldcounters));
7771 SET(oldmalloc_increase_bytes_limit, objspace->rgengc.oldmalloc_increase_limit);
7772#endif
7773
7774 ractor_cache_flush_count(objspace, rb_gc_get_ractor_newobj_cache());
7775 SET(total_allocated_objects, total_allocated_objects(objspace));
7776 SET(total_freed_objects, total_freed_objects(objspace));
7777 SET(heap_available_slots, objspace_available_slots(objspace));
7778 SET(heap_live_slots, objspace_live_slots(objspace));
7779 SET(heap_free_slots, objspace_free_slots(objspace));
7780 SET(heap_final_slots, total_final_slots_count(objspace));
7781 SET(heap_marked_slots, objspace->marked_slots);
7782
7783#if RGENGC_PROFILE
7784 SET(total_generated_normal_object_count, objspace->profile.total_generated_normal_object_count);
7785 SET(total_generated_shady_object_count, objspace->profile.total_generated_shady_object_count);
7786 SET(total_shade_operation_count, objspace->profile.total_shade_operation_count);
7787 SET(total_promoted_count, objspace->profile.total_promoted_count);
7788 SET(total_remembered_normal_object_count, objspace->profile.total_remembered_normal_object_count);
7789 SET(total_remembered_shady_object_count, objspace->profile.total_remembered_shady_object_count);
7790#endif /* RGENGC_PROFILE */
7791#undef SET
7792#undef SET64
7793
7794 if (!NIL_P(key)) {
7795 // Matched key should return above
7796 return Qundef;
7797 }
7798
7799#if defined(RGENGC_PROFILE) && RGENGC_PROFILE >= 2
7800 if (hash != Qnil) {
7801 gc_count_add_each_types(hash, "generated_normal_object_count_types", objspace->profile.generated_normal_object_count_types);
7802 gc_count_add_each_types(hash, "generated_shady_object_count_types", objspace->profile.generated_shady_object_count_types);
7803 gc_count_add_each_types(hash, "shade_operation_count_types", objspace->profile.shade_operation_count_types);
7804 gc_count_add_each_types(hash, "promoted_types", objspace->profile.promoted_types);
7805 gc_count_add_each_types(hash, "remembered_normal_object_count_types", objspace->profile.remembered_normal_object_count_types);
7806 gc_count_add_each_types(hash, "remembered_shady_object_count_types", objspace->profile.remembered_shady_object_count_types);
7807 }
7808#endif
7809
7810 return hash;
7811}
7812
7813enum gc_stat_heap_sym {
7814 gc_stat_heap_sym_slot_size,
7815 gc_stat_heap_sym_heap_live_slots,
7816 gc_stat_heap_sym_heap_free_slots,
7817 gc_stat_heap_sym_heap_final_slots,
7818 gc_stat_heap_sym_heap_eden_pages,
7819 gc_stat_heap_sym_heap_eden_slots,
7820 gc_stat_heap_sym_total_allocated_pages,
7821 gc_stat_heap_sym_force_major_gc_count,
7822 gc_stat_heap_sym_force_incremental_marking_finish_count,
7823 gc_stat_heap_sym_heap_allocatable_slots,
7824 gc_stat_heap_sym_total_allocated_objects,
7825 gc_stat_heap_sym_total_freed_objects,
7826 gc_stat_heap_sym_last
7827};
7828
7829static VALUE gc_stat_heap_symbols[gc_stat_heap_sym_last];
7830
7831static void
7832setup_gc_stat_heap_symbols(void)
7833{
7834 if (gc_stat_heap_symbols[0] == 0) {
7835#define S(s) gc_stat_heap_symbols[gc_stat_heap_sym_##s] = ID2SYM(rb_intern_const(#s))
7836 S(slot_size);
7837 S(heap_live_slots);
7838 S(heap_free_slots);
7839 S(heap_final_slots);
7840 S(heap_eden_pages);
7841 S(heap_eden_slots);
7842 S(heap_allocatable_slots);
7843 S(total_allocated_pages);
7844 S(force_major_gc_count);
7845 S(force_incremental_marking_finish_count);
7846 S(total_allocated_objects);
7847 S(total_freed_objects);
7848#undef S
7849 }
7850}
7851
7852static VALUE
7853stat_one_heap(rb_objspace_t *objspace, rb_heap_t *heap, VALUE hash, VALUE key)
7854{
7855#define SET(name, attr) \
7856 if (key == gc_stat_heap_symbols[gc_stat_heap_sym_##name]) \
7857 return SIZET2NUM(attr); \
7858 else if (hash != Qnil) \
7859 rb_hash_aset(hash, gc_stat_heap_symbols[gc_stat_heap_sym_##name], SIZET2NUM(attr));
7860
7861 SET(slot_size, heap->slot_size);
7862 SET(heap_live_slots, heap->total_allocated_objects - heap->total_freed_objects - heap->final_slots_count);
7863 SET(heap_free_slots, heap->total_slots - (heap->total_allocated_objects - heap->total_freed_objects));
7864 SET(heap_final_slots, heap->final_slots_count);
7865 SET(heap_eden_pages, heap->total_pages);
7866 SET(heap_eden_slots, heap->total_slots);
7867 SET(heap_allocatable_slots, objspace->heap_pages.allocatable_bytes / heap->slot_size);
7868 SET(total_allocated_pages, heap->total_allocated_pages);
7869 SET(force_major_gc_count, heap->force_major_gc_count);
7870 SET(force_incremental_marking_finish_count, heap->force_incremental_marking_finish_count);
7871 SET(total_allocated_objects, heap->total_allocated_objects);
7872 SET(total_freed_objects, heap->total_freed_objects);
7873#undef SET
7874
7875 if (!NIL_P(key)) {
7876 // Matched key should return above
7877 return Qundef;
7878 }
7879
7880 return hash;
7881}
7882
7883VALUE
7884rb_gc_impl_stat_heap(void *objspace_ptr, VALUE heap_name, VALUE hash_or_sym)
7885{
7886 rb_objspace_t *objspace = objspace_ptr;
7887
7888 ractor_cache_flush_count(objspace, rb_gc_get_ractor_newobj_cache());
7889
7890 setup_gc_stat_heap_symbols();
7891
7892 if (NIL_P(heap_name)) {
7893 if (!RB_TYPE_P(hash_or_sym, T_HASH)) {
7894 rb_bug("non-hash given");
7895 }
7896
7897 for (int i = 0; i < HEAP_COUNT; i++) {
7898 VALUE hash = rb_hash_aref(hash_or_sym, INT2FIX(i));
7899 if (NIL_P(hash)) {
7900 hash = rb_hash_new();
7901 rb_hash_aset(hash_or_sym, INT2FIX(i), hash);
7902 }
7903
7904 stat_one_heap(objspace, &heaps[i], hash, Qnil);
7905 }
7906 }
7907 else if (FIXNUM_P(heap_name)) {
7908 int heap_idx = FIX2INT(heap_name);
7909
7910 if (heap_idx < 0 || heap_idx >= HEAP_COUNT) {
7911 rb_raise(rb_eArgError, "size pool index out of range");
7912 }
7913
7914 if (SYMBOL_P(hash_or_sym)) {
7915 return stat_one_heap(objspace, &heaps[heap_idx], Qnil, hash_or_sym);
7916 }
7917 else if (RB_TYPE_P(hash_or_sym, T_HASH)) {
7918 return stat_one_heap(objspace, &heaps[heap_idx], hash_or_sym, Qnil);
7919 }
7920 else {
7921 rb_bug("non-hash or symbol given");
7922 }
7923 }
7924 else {
7925 rb_bug("heap_name must be nil or an Integer");
7926 }
7927
7928 return hash_or_sym;
7929}
7930
7931/* I could include internal.h for this, but doing so undefines some Array macros
7932 * necessary for initialising objects, and I don't want to include all the array
7933 * headers to get them back
7934 * TODO: Investigate why RARRAY_AREF gets undefined in internal.h
7935 */
7936#ifndef RBOOL
7937#define RBOOL(v) (v ? Qtrue : Qfalse)
7938#endif
7939
7940VALUE
7941rb_gc_impl_config_get(void *objspace_ptr)
7942{
7943#define sym(name) ID2SYM(rb_intern_const(name))
7944 rb_objspace_t *objspace = objspace_ptr;
7945 VALUE hash = rb_hash_new();
7946
7947 rb_hash_aset(hash, sym("rgengc_allow_full_mark"), RBOOL(gc_config_full_mark_val));
7948
7949 return hash;
7950}
7951
7952static int
7953gc_config_set_key(VALUE key, VALUE value, VALUE data)
7954{
7956 if (rb_sym2id(key) == rb_intern("rgengc_allow_full_mark")) {
7957 gc_rest(objspace);
7958 gc_config_full_mark_set(RTEST(value));
7959 }
7960 return ST_CONTINUE;
7961}
7962
7963void
7964rb_gc_impl_config_set(void *objspace_ptr, VALUE hash)
7965{
7966 rb_objspace_t *objspace = objspace_ptr;
7967
7968 if (!RB_TYPE_P(hash, T_HASH)) {
7969 rb_raise(rb_eArgError, "expected keyword arguments");
7970 }
7971
7972 rb_hash_foreach(hash, gc_config_set_key, (st_data_t)objspace);
7973}
7974
7975VALUE
7976rb_gc_impl_stress_get(void *objspace_ptr)
7977{
7978 rb_objspace_t *objspace = objspace_ptr;
7979 return ruby_gc_stress_mode;
7980}
7981
7982void
7983rb_gc_impl_stress_set(void *objspace_ptr, VALUE flag)
7984{
7985 rb_objspace_t *objspace = objspace_ptr;
7986
7987 objspace->flags.gc_stressful = RTEST(flag);
7988 objspace->gc_stress_mode = flag;
7989}
7990
7991static int
7992get_envparam_size(const char *name, size_t *default_value, size_t lower_bound)
7993{
7994 const char *ptr = getenv(name);
7995 ssize_t val;
7996
7997 if (ptr != NULL && *ptr) {
7998 size_t unit = 0;
7999 char *end;
8000#if SIZEOF_SIZE_T == SIZEOF_LONG_LONG
8001 val = strtoll(ptr, &end, 0);
8002#else
8003 val = strtol(ptr, &end, 0);
8004#endif
8005 switch (*end) {
8006 case 'k': case 'K':
8007 unit = 1024;
8008 ++end;
8009 break;
8010 case 'm': case 'M':
8011 unit = 1024*1024;
8012 ++end;
8013 break;
8014 case 'g': case 'G':
8015 unit = 1024*1024*1024;
8016 ++end;
8017 break;
8018 }
8019 while (*end && isspace((unsigned char)*end)) end++;
8020 if (*end) {
8021 if (RTEST(ruby_verbose)) fprintf(stderr, "invalid string for %s: %s\n", name, ptr);
8022 return 0;
8023 }
8024 if (unit > 0) {
8025 if (val < -(ssize_t)(SIZE_MAX / 2 / unit) || (ssize_t)(SIZE_MAX / 2 / unit) < val) {
8026 if (RTEST(ruby_verbose)) fprintf(stderr, "%s=%s is ignored because it overflows\n", name, ptr);
8027 return 0;
8028 }
8029 val *= unit;
8030 }
8031 if (val > 0 && (size_t)val > lower_bound) {
8032 if (RTEST(ruby_verbose)) {
8033 fprintf(stderr, "%s=%"PRIdSIZE" (default value: %"PRIuSIZE")\n", name, val, *default_value);
8034 }
8035 *default_value = (size_t)val;
8036 return 1;
8037 }
8038 else {
8039 if (RTEST(ruby_verbose)) {
8040 fprintf(stderr, "%s=%"PRIdSIZE" (default value: %"PRIuSIZE") is ignored because it must be greater than %"PRIuSIZE".\n",
8041 name, val, *default_value, lower_bound);
8042 }
8043 return 0;
8044 }
8045 }
8046 return 0;
8047}
8048
8049static int
8050get_envparam_double(const char *name, double *default_value, double lower_bound, double upper_bound, int accept_zero)
8051{
8052 const char *ptr = getenv(name);
8053 double val;
8054
8055 if (ptr != NULL && *ptr) {
8056 char *end;
8057 val = strtod(ptr, &end);
8058 if (!*ptr || *end) {
8059 if (RTEST(ruby_verbose)) fprintf(stderr, "invalid string for %s: %s\n", name, ptr);
8060 return 0;
8061 }
8062
8063 if (accept_zero && val == 0.0) {
8064 goto accept;
8065 }
8066 else if (val <= lower_bound) {
8067 if (RTEST(ruby_verbose)) {
8068 fprintf(stderr, "%s=%f (default value: %f) is ignored because it must be greater than %f.\n",
8069 name, val, *default_value, lower_bound);
8070 }
8071 }
8072 else if (upper_bound != 0.0 && /* ignore upper_bound if it is 0.0 */
8073 val > upper_bound) {
8074 if (RTEST(ruby_verbose)) {
8075 fprintf(stderr, "%s=%f (default value: %f) is ignored because it must be lower than %f.\n",
8076 name, val, *default_value, upper_bound);
8077 }
8078 }
8079 else {
8080 goto accept;
8081 }
8082 }
8083 return 0;
8084
8085 accept:
8086 if (RTEST(ruby_verbose)) fprintf(stderr, "%s=%f (default value: %f)\n", name, val, *default_value);
8087 *default_value = val;
8088 return 1;
8089}
8090
8091/*
8092 * GC tuning environment variables
8093 *
8094 * * RUBY_GC_HEAP_FREE_SLOTS
8095 * - Prepare at least this amount of slots after GC.
8096 * - Allocate slots if there are not enough slots.
8097 * * RUBY_GC_HEAP_GROWTH_FACTOR (new from 2.1)
8098 * - Allocate slots by this factor.
8099 * - (next slots number) = (current slots number) * (this factor)
8100 * * RUBY_GC_HEAP_GROWTH_MAX_BYTES (was RUBY_GC_HEAP_GROWTH_MAX_SLOTS)
8101 * - Allocation rate is limited to this number of bytes.
8102 * * RUBY_GC_HEAP_FREE_SLOTS_MIN_RATIO (new from 2.4)
8103 * - Allocate additional pages when the number of free slots is
8104 * lower than the value (total_slots * (this ratio)).
8105 * * RUBY_GC_HEAP_FREE_SLOTS_GOAL_RATIO (new from 2.4)
8106 * - Allocate slots to satisfy this formula:
8107 * free_slots = total_slots * goal_ratio
8108 * - In other words, prepare (total_slots * goal_ratio) free slots.
8109 * - if this value is 0.0, then use RUBY_GC_HEAP_GROWTH_FACTOR directly.
8110 * * RUBY_GC_HEAP_FREE_SLOTS_MAX_RATIO (new from 2.4)
8111 * - Allow to free pages when the number of free slots is
8112 * greater than the value (total_slots * (this ratio)).
8113 * * RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR (new from 2.1.1)
8114 * - Do full GC when the number of old objects is more than R * N
8115 * where R is this factor and
8116 * N is the number of old objects just after last full GC.
8117 *
8118 * * obsolete
8119 * * RUBY_FREE_MIN -> RUBY_GC_HEAP_FREE_SLOTS (from 2.1)
8120 * * RUBY_HEAP_MIN_SLOTS -> RUBY_GC_HEAP_INIT_SLOTS (from 2.1) -> RUBY_GC_HEAP_INIT_BYTES
8121 *
8122 * * RUBY_GC_MALLOC_LIMIT
8123 * * RUBY_GC_MALLOC_LIMIT_MAX (new from 2.1)
8124 * * RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR (new from 2.1)
8125 *
8126 * * RUBY_GC_OLDMALLOC_LIMIT (new from 2.1)
8127 * * RUBY_GC_OLDMALLOC_LIMIT_MAX (new from 2.1)
8128 * * RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR (new from 2.1)
8129 */
8130
8131void
8132rb_gc_impl_set_params(void *objspace_ptr)
8133{
8134 rb_objspace_t *objspace = objspace_ptr;
8135 /* RUBY_GC_HEAP_FREE_SLOTS */
8136 if (get_envparam_size("RUBY_GC_HEAP_FREE_SLOTS", &gc_params.heap_free_slots, 0)) {
8137 /* ok */
8138 }
8139
8140 get_envparam_size("RUBY_GC_HEAP_INIT_BYTES", &gc_params.heap_init_bytes, 0);
8141
8142 get_envparam_double("RUBY_GC_HEAP_GROWTH_FACTOR", &gc_params.growth_factor, 1.0, 0.0, FALSE);
8143 get_envparam_size ("RUBY_GC_HEAP_GROWTH_MAX_BYTES", &gc_params.growth_max_bytes, 0);
8144 get_envparam_double("RUBY_GC_HEAP_FREE_SLOTS_MIN_RATIO", &gc_params.heap_free_slots_min_ratio,
8145 0.0, 1.0, FALSE);
8146 get_envparam_double("RUBY_GC_HEAP_FREE_SLOTS_MAX_RATIO", &gc_params.heap_free_slots_max_ratio,
8147 gc_params.heap_free_slots_min_ratio, 1.0, FALSE);
8148 get_envparam_double("RUBY_GC_HEAP_FREE_SLOTS_GOAL_RATIO", &gc_params.heap_free_slots_goal_ratio,
8149 gc_params.heap_free_slots_min_ratio, gc_params.heap_free_slots_max_ratio, TRUE);
8150 get_envparam_double("RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR", &gc_params.oldobject_limit_factor, 0.0, 0.0, TRUE);
8151 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);
8152
8153 if (get_envparam_size("RUBY_GC_MALLOC_LIMIT", &gc_params.malloc_limit_min, 0)) {
8154 malloc_limit = gc_params.malloc_limit_min;
8155 }
8156 get_envparam_size ("RUBY_GC_MALLOC_LIMIT_MAX", &gc_params.malloc_limit_max, 0);
8157 if (!gc_params.malloc_limit_max) { /* ignore max-check if 0 */
8158 gc_params.malloc_limit_max = SIZE_MAX;
8159 }
8160 get_envparam_double("RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR", &gc_params.malloc_limit_growth_factor, 1.0, 0.0, FALSE);
8161
8162#if RGENGC_ESTIMATE_OLDMALLOC
8163 if (get_envparam_size("RUBY_GC_OLDMALLOC_LIMIT", &gc_params.oldmalloc_limit_min, 0)) {
8164 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
8165 }
8166 get_envparam_size ("RUBY_GC_OLDMALLOC_LIMIT_MAX", &gc_params.oldmalloc_limit_max, 0);
8167 get_envparam_double("RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR", &gc_params.oldmalloc_limit_growth_factor, 1.0, 0.0, FALSE);
8168#endif
8169}
8170
8171static inline size_t
8172objspace_malloc_size(rb_objspace_t *objspace, void *ptr, size_t hint)
8173{
8174#ifdef HAVE_MALLOC_USABLE_SIZE
8175 if (!hint) {
8176 hint = malloc_usable_size(ptr);
8177 }
8178#endif
8179 return hint;
8180}
8181
8182enum memop_type {
8183 MEMOP_TYPE_MALLOC = 0,
8184 MEMOP_TYPE_FREE,
8185 MEMOP_TYPE_REALLOC
8186};
8187
8188static inline void
8189atomic_sub_nounderflow(size_t *var, size_t sub)
8190{
8191 if (sub == 0) return;
8192
8193 while (1) {
8194 size_t val = *var;
8195 if (val < sub) sub = val;
8196 if (RUBY_ATOMIC_SIZE_CAS(*var, val, val-sub) == val) break;
8197 }
8198}
8199
8200#define gc_stress_full_mark_after_malloc_p() \
8201 (FIXNUM_P(ruby_gc_stress_mode) && (FIX2LONG(ruby_gc_stress_mode) & (1<<gc_stress_full_mark_after_malloc)))
8202
8203static void
8204objspace_malloc_gc_stress(rb_objspace_t *objspace)
8205{
8206 if (ruby_gc_stressful && ruby_native_thread_p()) {
8207 unsigned int reason = (GPR_FLAG_IMMEDIATE_MARK | GPR_FLAG_IMMEDIATE_SWEEP |
8208 GPR_FLAG_STRESS | GPR_FLAG_MALLOC);
8209
8210 if (gc_stress_full_mark_after_malloc_p()) {
8211 reason |= GPR_FLAG_FULL_MARK;
8212 }
8213 garbage_collect_with_gvl(objspace, reason);
8214 }
8215}
8216
8217static void
8218malloc_increase_commit(rb_objspace_t *objspace, size_t new_size, size_t old_size)
8219{
8220 if (new_size > old_size) {
8221 size_t delta = new_size - old_size;
8222 MALLOC_COUNTERS_LOCK(objspace);
8223 gc_counter_add(&objspace->malloc_counters.counters.malloc, delta);
8224#if RGENGC_ESTIMATE_OLDMALLOC
8225 gc_counter_add(&objspace->malloc_counters.oldcounters.malloc, delta);
8226#endif
8227 MALLOC_COUNTERS_UNLOCK(objspace);
8228 }
8229 else if (old_size > new_size) {
8230 size_t delta = old_size - new_size;
8231 MALLOC_COUNTERS_LOCK(objspace);
8232 gc_counter_add(&objspace->malloc_counters.counters.free, delta);
8233#if RGENGC_ESTIMATE_OLDMALLOC
8234 gc_counter_add(&objspace->malloc_counters.oldcounters.free, delta);
8235#endif
8236 MALLOC_COUNTERS_UNLOCK(objspace);
8237 }
8238}
8239
8240#if USE_MALLOC_INCREASE_LOCAL
8241static void
8242malloc_increase_local_flush(rb_objspace_t *objspace)
8243{
8244 int delta = malloc_increase_local;
8245 if (delta == 0) return;
8246
8247 malloc_increase_local = 0;
8248 if (delta > 0) {
8249 malloc_increase_commit(objspace, (size_t)delta, 0);
8250 }
8251 else {
8252 malloc_increase_commit(objspace, 0, (size_t)(-delta));
8253 }
8254}
8255#else
8256static void
8257malloc_increase_local_flush(rb_objspace_t *objspace)
8258{
8259}
8260#endif
8261
8262static inline bool
8263objspace_malloc_increase_report(rb_objspace_t *objspace, void *mem, size_t new_size, size_t old_size, enum memop_type type, bool gc_allowed)
8264{
8265 if (0) fprintf(stderr, "increase - ptr: %p, type: %s, new_size: %"PRIdSIZE", old_size: %"PRIdSIZE"\n",
8266 mem,
8267 type == MEMOP_TYPE_MALLOC ? "malloc" :
8268 type == MEMOP_TYPE_FREE ? "free " :
8269 type == MEMOP_TYPE_REALLOC ? "realloc": "error",
8270 new_size, old_size);
8271 return false;
8272}
8273
8274static bool
8275objspace_malloc_increase_body(rb_objspace_t *objspace, void *mem, size_t new_size, size_t old_size, enum memop_type type, bool gc_allowed)
8276{
8277#if USE_MALLOC_INCREASE_LOCAL
8278 if (new_size < GC_MALLOC_INCREASE_LOCAL_THRESHOLD &&
8279 old_size < GC_MALLOC_INCREASE_LOCAL_THRESHOLD) {
8280 malloc_increase_local += (int)new_size - (int)old_size;
8281
8282 if (malloc_increase_local >= GC_MALLOC_INCREASE_LOCAL_THRESHOLD ||
8283 malloc_increase_local <= -GC_MALLOC_INCREASE_LOCAL_THRESHOLD) {
8284 malloc_increase_local_flush(objspace);
8285 }
8286 }
8287 else {
8288 malloc_increase_local_flush(objspace);
8289 malloc_increase_commit(objspace, new_size, old_size);
8290 }
8291#else
8292 malloc_increase_commit(objspace, new_size, old_size);
8293#endif
8294
8295 if (type == MEMOP_TYPE_MALLOC && gc_allowed) {
8296 retry:
8297 if (malloc_increase > malloc_limit && ruby_native_thread_p() && !dont_gc_val()) {
8298 if (ruby_thread_has_gvl_p() && is_lazy_sweeping(objspace)) {
8299 gc_rest(objspace); /* gc_rest can reduce malloc_increase */
8300 goto retry;
8301 }
8302 garbage_collect_with_gvl(objspace, GPR_FLAG_MALLOC);
8303 }
8304 }
8305
8306#if MALLOC_ALLOCATED_SIZE
8307 if (new_size >= old_size) {
8308 RUBY_ATOMIC_SIZE_ADD(objspace->malloc_params.allocated_size, new_size - old_size);
8309 }
8310 else {
8311 size_t dec_size = old_size - new_size;
8312
8313#if MALLOC_ALLOCATED_SIZE_CHECK
8314 size_t allocated_size = objspace->malloc_params.allocated_size;
8315 if (allocated_size < dec_size) {
8316 rb_bug("objspace_malloc_increase: underflow malloc_params.allocated_size.");
8317 }
8318#endif
8319 atomic_sub_nounderflow(&objspace->malloc_params.allocated_size, dec_size);
8320 }
8321
8322 switch (type) {
8323 case MEMOP_TYPE_MALLOC:
8324 RUBY_ATOMIC_SIZE_INC(objspace->malloc_params.allocations);
8325 break;
8326 case MEMOP_TYPE_FREE:
8327 {
8328 size_t allocations = objspace->malloc_params.allocations;
8329 if (allocations > 0) {
8330 atomic_sub_nounderflow(&objspace->malloc_params.allocations, 1);
8331 }
8332#if MALLOC_ALLOCATED_SIZE_CHECK
8333 else {
8334 GC_ASSERT(objspace->malloc_params.allocations > 0);
8335 }
8336#endif
8337 }
8338 break;
8339 case MEMOP_TYPE_REALLOC: /* ignore */ break;
8340 }
8341#endif
8342 return true;
8343}
8344
8345#define objspace_malloc_increase(...) \
8346 for (bool malloc_increase_done = objspace_malloc_increase_report(__VA_ARGS__); \
8347 !malloc_increase_done; \
8348 malloc_increase_done = objspace_malloc_increase_body(__VA_ARGS__))
8349
8350struct malloc_obj_info { /* 4 words */
8351 size_t size;
8352};
8353
8354static inline size_t
8355objspace_malloc_prepare(rb_objspace_t *objspace, size_t size)
8356{
8357 if (size == 0) size = 1;
8358
8359#if CALC_EXACT_MALLOC_SIZE
8360 size += sizeof(struct malloc_obj_info);
8361#endif
8362
8363 return size;
8364}
8365
8366static bool
8367malloc_during_gc_p(rb_objspace_t *objspace)
8368{
8369 /* malloc is not allowed during GC when we're not using multiple ractors
8370 * (since ractors can run while another thread is sweeping) and when we
8371 * have the GVL (since if we don't have the GVL, we'll try to acquire the
8372 * GVL which will block and ensure the other thread finishes GC). */
8373 return during_gc && !dont_gc_val() && !rb_gc_multi_ractor_p() && ruby_thread_has_gvl_p();
8374}
8375
8376static inline void *
8377objspace_malloc_fixup(rb_objspace_t *objspace, void *mem, size_t size, bool gc_allowed)
8378{
8379 size = objspace_malloc_size(objspace, mem, size);
8380 objspace_malloc_increase(objspace, mem, size, 0, MEMOP_TYPE_MALLOC, gc_allowed) {}
8381
8382#if CALC_EXACT_MALLOC_SIZE
8383 {
8384 struct malloc_obj_info *info = mem;
8385 info->size = size;
8386 mem = info + 1;
8387 }
8388#endif
8389
8390 return mem;
8391}
8392
8393#if defined(__GNUC__) && RUBY_DEBUG
8394#define RB_BUG_INSTEAD_OF_RB_MEMERROR 1
8395#endif
8396
8397#ifndef RB_BUG_INSTEAD_OF_RB_MEMERROR
8398# define RB_BUG_INSTEAD_OF_RB_MEMERROR 0
8399#endif
8400
8401#define GC_MEMERROR(...) \
8402 ((RB_BUG_INSTEAD_OF_RB_MEMERROR+0) ? rb_bug("" __VA_ARGS__) : (void)0)
8403
8404#define TRY_WITH_GC(siz, expr) do { \
8405 const gc_profile_record_flag gpr = \
8406 GPR_FLAG_FULL_MARK | \
8407 GPR_FLAG_IMMEDIATE_MARK | \
8408 GPR_FLAG_IMMEDIATE_SWEEP | \
8409 GPR_FLAG_MALLOC; \
8410 objspace_malloc_gc_stress(objspace); \
8411 \
8412 if (RB_LIKELY((expr))) { \
8413 /* Success on 1st try */ \
8414 } \
8415 else if (gc_allowed && !garbage_collect_with_gvl(objspace, gpr)) { \
8416 /* @shyouhei thinks this doesn't happen */ \
8417 GC_MEMERROR("TRY_WITH_GC: could not GC"); \
8418 } \
8419 else if ((expr)) { \
8420 /* Success on 2nd try */ \
8421 } \
8422 else { \
8423 GC_MEMERROR("TRY_WITH_GC: could not allocate:" \
8424 "%"PRIdSIZE" bytes for %s", \
8425 siz, # expr); \
8426 } \
8427 } while (0)
8428
8429static void
8430check_malloc_not_in_gc(rb_objspace_t *objspace, const char *msg)
8431{
8432 if (RB_UNLIKELY(malloc_during_gc_p(objspace))) {
8433 dont_gc_on();
8434 during_gc = false;
8435 rb_bug("Cannot %s during GC", msg);
8436 }
8437}
8438
8439void
8440rb_gc_impl_free(void *objspace_ptr, void *ptr, size_t old_size)
8441{
8442 rb_objspace_t *objspace = objspace_ptr;
8443
8444 if (!ptr) {
8445 /*
8446 * ISO/IEC 9899 says "If ptr is a null pointer, no action occurs" since
8447 * its first version. We would better follow.
8448 */
8449 return;
8450 }
8451#if CALC_EXACT_MALLOC_SIZE
8452 struct malloc_obj_info *info = (struct malloc_obj_info *)ptr - 1;
8453#if VERIFY_FREE_SIZE
8454 if (!info->size) {
8455 rb_bug("buffer %p has no recorded size. Was it allocated with ruby_mimalloc? If so it should be freed with ruby_mimfree", ptr);
8456 }
8457
8458 if (old_size && (old_size + sizeof(struct malloc_obj_info)) != info->size) {
8459 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));
8460 }
8461#endif
8462 ptr = info;
8463 old_size = info->size;
8464#endif
8465 old_size = objspace_malloc_size(objspace, ptr, old_size);
8466
8467 objspace_malloc_increase(objspace, ptr, 0, old_size, MEMOP_TYPE_FREE, true) {
8468 free(ptr);
8469 ptr = NULL;
8470 RB_DEBUG_COUNTER_INC(heap_xfree);
8471 }
8472}
8473
8474void *
8475rb_gc_impl_malloc(void *objspace_ptr, size_t size, bool gc_allowed)
8476{
8477 rb_objspace_t *objspace = objspace_ptr;
8478 check_malloc_not_in_gc(objspace, "malloc");
8479
8480 void *mem;
8481
8482 size = objspace_malloc_prepare(objspace, size);
8483 TRY_WITH_GC(size, mem = malloc(size));
8484 RB_DEBUG_COUNTER_INC(heap_xmalloc);
8485 if (!mem) return mem;
8486 return objspace_malloc_fixup(objspace, mem, size, gc_allowed);
8487}
8488
8489void *
8490rb_gc_impl_calloc(void *objspace_ptr, size_t size, bool gc_allowed)
8491{
8492 rb_objspace_t *objspace = objspace_ptr;
8493
8494 if (RB_UNLIKELY(malloc_during_gc_p(objspace))) {
8495 rb_warn("calloc during GC detected, this could cause crashes if it triggers another GC");
8496#if RGENGC_CHECK_MODE || RUBY_DEBUG
8497 rb_bug("Cannot calloc during GC");
8498#endif
8499 }
8500
8501 void *mem;
8502
8503 size = objspace_malloc_prepare(objspace, size);
8504 TRY_WITH_GC(size, mem = calloc1(size));
8505 if (!mem) return mem;
8506 return objspace_malloc_fixup(objspace, mem, size, gc_allowed);
8507}
8508
8509void *
8510rb_gc_impl_realloc(void *objspace_ptr, void *ptr, size_t new_size, size_t old_size, bool gc_allowed)
8511{
8512 rb_objspace_t *objspace = objspace_ptr;
8513
8514 check_malloc_not_in_gc(objspace, "realloc");
8515
8516 void *mem;
8517
8518 if (!ptr) return rb_gc_impl_malloc(objspace, new_size, gc_allowed);
8519
8520 /*
8521 * The behavior of realloc(ptr, 0) is implementation defined.
8522 * Therefore we don't use realloc(ptr, 0) for portability reason.
8523 * see http://www.open-std.org/jtc1/sc22/wg14/www/docs/dr_400.htm
8524 */
8525 if (new_size == 0) {
8526 if ((mem = rb_gc_impl_malloc(objspace, 0, gc_allowed)) != NULL) {
8527 /*
8528 * - OpenBSD's malloc(3) man page says that when 0 is passed, it
8529 * returns a non-NULL pointer to an access-protected memory page.
8530 * The returned pointer cannot be read / written at all, but
8531 * still be a valid argument of free().
8532 *
8533 * https://man.openbsd.org/malloc.3
8534 *
8535 * - Linux's malloc(3) man page says that it _might_ perhaps return
8536 * a non-NULL pointer when its argument is 0. That return value
8537 * is safe (and is expected) to be passed to free().
8538 *
8539 * https://man7.org/linux/man-pages/man3/malloc.3.html
8540 *
8541 * - As I read the implementation jemalloc's malloc() returns fully
8542 * normal 16 bytes memory region when its argument is 0.
8543 *
8544 * - As I read the implementation musl libc's malloc() returns
8545 * fully normal 32 bytes memory region when its argument is 0.
8546 *
8547 * - Other malloc implementations can also return non-NULL.
8548 */
8549 rb_gc_impl_free(objspace, ptr, old_size);
8550 return mem;
8551 }
8552 else {
8553 /*
8554 * It is dangerous to return NULL here, because that could lead to
8555 * RCE. Fallback to 1 byte instead of zero.
8556 *
8557 * https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-11932
8558 */
8559 new_size = 1;
8560 }
8561 }
8562
8563#if CALC_EXACT_MALLOC_SIZE
8564 {
8565 struct malloc_obj_info *info = (struct malloc_obj_info *)ptr - 1;
8566 new_size += sizeof(struct malloc_obj_info);
8567 ptr = info;
8568#if VERIFY_FREE_SIZE
8569 if (old_size && (old_size + sizeof(struct malloc_obj_info)) != info->size) {
8570 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));
8571 }
8572#endif
8573 old_size = info->size;
8574 }
8575#endif
8576
8577 old_size = objspace_malloc_size(objspace, ptr, old_size);
8578 TRY_WITH_GC(new_size, mem = RB_GNUC_EXTENSION_BLOCK(realloc(ptr, new_size)));
8579 if (!mem) return mem;
8580 new_size = objspace_malloc_size(objspace, mem, new_size);
8581
8582#if CALC_EXACT_MALLOC_SIZE
8583 {
8584 struct malloc_obj_info *info = mem;
8585 info->size = new_size;
8586 mem = info + 1;
8587 }
8588#endif
8589
8590 objspace_malloc_increase(objspace, mem, new_size, old_size, MEMOP_TYPE_REALLOC, gc_allowed);
8591
8592 RB_DEBUG_COUNTER_INC(heap_xrealloc);
8593 return mem;
8594}
8595
8596void
8597rb_gc_impl_adjust_memory_usage(void *objspace_ptr, ssize_t diff)
8598{
8599 rb_objspace_t *objspace = objspace_ptr;
8600
8601 if (diff > 0) {
8602 objspace_malloc_increase(objspace, 0, diff, 0, MEMOP_TYPE_REALLOC, true);
8603 }
8604 else if (diff < 0) {
8605 objspace_malloc_increase(objspace, 0, 0, -diff, MEMOP_TYPE_REALLOC, true);
8606 }
8607}
8608
8609// TODO: move GC profiler stuff back into gc.c
8610/*
8611 ------------------------------ GC profiler ------------------------------
8612*/
8613
8614#define GC_PROFILE_RECORD_DEFAULT_SIZE 100
8615
8616static bool
8617current_process_time(struct timespec *ts)
8618{
8619#if defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_PROCESS_CPUTIME_ID)
8620 {
8621 static int try_clock_gettime = 1;
8622 if (try_clock_gettime && clock_gettime(CLOCK_PROCESS_CPUTIME_ID, ts) == 0) {
8623 return true;
8624 }
8625 else {
8626 try_clock_gettime = 0;
8627 }
8628 }
8629#endif
8630
8631#ifdef RUSAGE_SELF
8632 {
8633 struct rusage usage;
8634 struct timeval time;
8635 if (getrusage(RUSAGE_SELF, &usage) == 0) {
8636 time = usage.ru_utime;
8637 ts->tv_sec = time.tv_sec;
8638 ts->tv_nsec = (int32_t)time.tv_usec * 1000;
8639 return true;
8640 }
8641 }
8642#endif
8643
8644#ifdef _WIN32
8645 {
8646 FILETIME creation_time, exit_time, kernel_time, user_time;
8647 ULARGE_INTEGER ui;
8648
8649 if (GetProcessTimes(GetCurrentProcess(),
8650 &creation_time, &exit_time, &kernel_time, &user_time) != 0) {
8651 memcpy(&ui, &user_time, sizeof(FILETIME));
8652#define PER100NSEC (uint64_t)(1000 * 1000 * 10)
8653 ts->tv_nsec = (long)(ui.QuadPart % PER100NSEC);
8654 ts->tv_sec = (time_t)(ui.QuadPart / PER100NSEC);
8655 return true;
8656 }
8657 }
8658#endif
8659
8660 return false;
8661}
8662
8663static double
8664getrusage_time(void)
8665{
8666 struct timespec ts;
8667 if (current_process_time(&ts)) {
8668 return ts.tv_sec + ts.tv_nsec * 1e-9;
8669 }
8670 else {
8671 return 0.0;
8672 }
8673}
8674
8675
8676static inline void
8677gc_prof_setup_new_record(rb_objspace_t *objspace, unsigned int reason)
8678{
8679 if (objspace->profile.run) {
8680 size_t index = objspace->profile.next_index;
8681 gc_profile_record *record;
8682
8683 /* create new record */
8684 objspace->profile.next_index++;
8685
8686 if (!objspace->profile.records) {
8687 objspace->profile.size = GC_PROFILE_RECORD_DEFAULT_SIZE;
8688 objspace->profile.records = malloc(xmalloc2_size(sizeof(gc_profile_record), objspace->profile.size));
8689 }
8690 if (index >= objspace->profile.size) {
8691 void *ptr;
8692 objspace->profile.size += 1000;
8693 ptr = realloc(objspace->profile.records, xmalloc2_size(sizeof(gc_profile_record), objspace->profile.size));
8694 if (!ptr) rb_memerror();
8695 objspace->profile.records = ptr;
8696 }
8697 if (!objspace->profile.records) {
8698 rb_bug("gc_profile malloc or realloc miss");
8699 }
8700 record = objspace->profile.current_record = &objspace->profile.records[objspace->profile.next_index - 1];
8701 MEMZERO(record, gc_profile_record, 1);
8702
8703 /* setup before-GC parameter */
8704 record->flags = reason | (ruby_gc_stressful ? GPR_FLAG_STRESS : 0);
8705#if MALLOC_ALLOCATED_SIZE
8706 record->allocated_size = malloc_allocated_size;
8707#endif
8708#if GC_PROFILE_MORE_DETAIL && GC_PROFILE_DETAIL_MEMORY
8709#ifdef RUSAGE_SELF
8710 {
8711 struct rusage usage;
8712 if (getrusage(RUSAGE_SELF, &usage) == 0) {
8713 record->maxrss = usage.ru_maxrss;
8714 record->minflt = usage.ru_minflt;
8715 record->majflt = usage.ru_majflt;
8716 }
8717 }
8718#endif
8719#endif
8720 }
8721}
8722
8723static inline void
8724gc_prof_timer_start(rb_objspace_t *objspace)
8725{
8726 if (gc_prof_enabled(objspace)) {
8727 gc_profile_record *record = gc_prof_record(objspace);
8728#if GC_PROFILE_MORE_DETAIL
8729 record->prepare_time = objspace->profile.prepare_time;
8730#endif
8731 record->gc_time = 0;
8732 record->gc_invoke_time = getrusage_time();
8733 }
8734}
8735
8736static double
8737elapsed_time_from(double time)
8738{
8739 double now = getrusage_time();
8740 if (now > time) {
8741 return now - time;
8742 }
8743 else {
8744 return 0;
8745 }
8746}
8747
8748static inline void
8749gc_prof_timer_stop(rb_objspace_t *objspace)
8750{
8751 if (gc_prof_enabled(objspace)) {
8752 gc_profile_record *record = gc_prof_record(objspace);
8753 record->gc_time = elapsed_time_from(record->gc_invoke_time);
8754 record->gc_invoke_time -= objspace->profile.invoke_time;
8755 }
8756}
8757
8758#ifdef BUILDING_MODULAR_GC
8759# define RUBY_DTRACE_GC_HOOK(name)
8760#else
8761# define RUBY_DTRACE_GC_HOOK(name) \
8762 do {if (RUBY_DTRACE_GC_##name##_ENABLED()) RUBY_DTRACE_GC_##name();} while (0)
8763#endif
8764
8765static inline void
8766gc_prof_mark_timer_start(rb_objspace_t *objspace)
8767{
8768 RUBY_DTRACE_GC_HOOK(MARK_BEGIN);
8769#if GC_PROFILE_MORE_DETAIL
8770 if (gc_prof_enabled(objspace)) {
8771 gc_prof_record(objspace)->gc_mark_time = getrusage_time();
8772 }
8773#endif
8774}
8775
8776static inline void
8777gc_prof_mark_timer_stop(rb_objspace_t *objspace)
8778{
8779 RUBY_DTRACE_GC_HOOK(MARK_END);
8780#if GC_PROFILE_MORE_DETAIL
8781 if (gc_prof_enabled(objspace)) {
8782 gc_profile_record *record = gc_prof_record(objspace);
8783 record->gc_mark_time = elapsed_time_from(record->gc_mark_time);
8784 }
8785#endif
8786}
8787
8788static inline void
8789gc_prof_sweep_timer_start(rb_objspace_t *objspace)
8790{
8791 RUBY_DTRACE_GC_HOOK(SWEEP_BEGIN);
8792 if (gc_prof_enabled(objspace)) {
8793 gc_profile_record *record = gc_prof_record(objspace);
8794
8795 if (record->gc_time > 0 || GC_PROFILE_MORE_DETAIL) {
8796 objspace->profile.gc_sweep_start_time = getrusage_time();
8797 }
8798 }
8799}
8800
8801static inline void
8802gc_prof_sweep_timer_stop(rb_objspace_t *objspace)
8803{
8804 RUBY_DTRACE_GC_HOOK(SWEEP_END);
8805
8806 if (gc_prof_enabled(objspace)) {
8807 double sweep_time;
8808 gc_profile_record *record = gc_prof_record(objspace);
8809
8810 if (record->gc_time > 0) {
8811 sweep_time = elapsed_time_from(objspace->profile.gc_sweep_start_time);
8812 /* need to accumulate GC time for lazy sweep after gc() */
8813 record->gc_time += sweep_time;
8814 }
8815 else if (GC_PROFILE_MORE_DETAIL) {
8816 sweep_time = elapsed_time_from(objspace->profile.gc_sweep_start_time);
8817 }
8818
8819#if GC_PROFILE_MORE_DETAIL
8820 record->gc_sweep_time += sweep_time;
8821 if (heap_pages_deferred_final) record->flags |= GPR_FLAG_HAVE_FINALIZE;
8822#endif
8823 if (heap_pages_deferred_final) objspace->profile.latest_gc_info |= GPR_FLAG_HAVE_FINALIZE;
8824 }
8825}
8826
8827static inline void
8828gc_prof_set_malloc_info(rb_objspace_t *objspace)
8829{
8830#if GC_PROFILE_MORE_DETAIL
8831 if (gc_prof_enabled(objspace)) {
8832 gc_profile_record *record = gc_prof_record(objspace);
8833 record->allocate_increase = malloc_increase;
8834 record->allocate_limit = malloc_limit;
8835 }
8836#endif
8837}
8838
8839static inline void
8840gc_prof_set_heap_info(rb_objspace_t *objspace)
8841{
8842 if (gc_prof_enabled(objspace)) {
8843 gc_profile_record *record = gc_prof_record(objspace);
8844
8845 /* Sum across all size pools since each has a different slot size. */
8846 size_t total = 0;
8847 size_t use_size = 0;
8848 size_t total_size = 0;
8849 for (int i = 0; i < HEAP_COUNT; i++) {
8850 rb_heap_t *heap = &heaps[i];
8851 size_t heap_live = heap->total_allocated_objects - heap->total_freed_objects - heap->final_slots_count;
8852 total += heap->total_slots;
8853 use_size += heap_live * heap->slot_size;
8854 total_size += heap->total_slots * heap->slot_size;
8855 }
8856
8857#if GC_PROFILE_MORE_DETAIL
8858 size_t live = objspace->profile.total_allocated_objects_at_gc_start - total_freed_objects(objspace);
8859 record->heap_use_pages = objspace->profile.heap_used_at_gc_start;
8860 record->heap_live_objects = live;
8861 record->heap_free_objects = total - live;
8862#endif
8863
8864 record->heap_total_objects = total;
8865 record->heap_use_size = use_size;
8866 record->heap_total_size = total_size;
8867 }
8868}
8869
8870/*
8871 * call-seq:
8872 * GC::Profiler.clear -> nil
8873 *
8874 * Clears the \GC profiler data.
8875 *
8876 */
8877
8878static VALUE
8879gc_profile_clear(VALUE _)
8880{
8881 rb_objspace_t *objspace = rb_gc_get_objspace();
8882 void *p = objspace->profile.records;
8883 objspace->profile.records = NULL;
8884 objspace->profile.size = 0;
8885 objspace->profile.next_index = 0;
8886 objspace->profile.current_record = 0;
8887 free(p);
8888 return Qnil;
8889}
8890
8891/*
8892 * call-seq:
8893 * GC::Profiler.raw_data -> [Hash, ...]
8894 *
8895 * Returns an Array of individual raw profile data Hashes ordered
8896 * from earliest to latest by +:GC_INVOKE_TIME+.
8897 *
8898 * For example:
8899 *
8900 * [
8901 * {
8902 * :GC_TIME=>1.3000000000000858e-05,
8903 * :GC_INVOKE_TIME=>0.010634999999999999,
8904 * :HEAP_USE_SIZE=>289640,
8905 * :HEAP_TOTAL_SIZE=>588960,
8906 * :HEAP_TOTAL_OBJECTS=>14724,
8907 * :GC_IS_MARKED=>false
8908 * },
8909 * # ...
8910 * ]
8911 *
8912 * The keys mean:
8913 *
8914 * +:GC_TIME+::
8915 * Time elapsed in seconds for this GC run
8916 * +:GC_INVOKE_TIME+::
8917 * Time elapsed in seconds from startup to when the GC was invoked
8918 * +:HEAP_USE_SIZE+::
8919 * Total bytes of heap used
8920 * +:HEAP_TOTAL_SIZE+::
8921 * Total size of heap in bytes
8922 * +:HEAP_TOTAL_OBJECTS+::
8923 * Total number of objects
8924 * +:GC_IS_MARKED+::
8925 * Returns +true+ if the GC is in mark phase
8926 *
8927 * If ruby was built with +GC_PROFILE_MORE_DETAIL+, you will also have access
8928 * to the following hash keys:
8929 *
8930 * +:GC_MARK_TIME+::
8931 * +:GC_SWEEP_TIME+::
8932 * +:ALLOCATE_INCREASE+::
8933 * +:ALLOCATE_LIMIT+::
8934 * +:HEAP_USE_PAGES+::
8935 * +:HEAP_LIVE_OBJECTS+::
8936 * +:HEAP_FREE_OBJECTS+::
8937 * +:HAVE_FINALIZE+::
8938 *
8939 */
8940
8941static VALUE
8942gc_profile_record_get(VALUE _)
8943{
8944 VALUE prof;
8945 VALUE gc_profile = rb_ary_new();
8946 size_t i;
8947 rb_objspace_t *objspace = rb_gc_get_objspace();
8948
8949 if (!objspace->profile.run) {
8950 return Qnil;
8951 }
8952
8953 for (i =0; i < objspace->profile.next_index; i++) {
8954 gc_profile_record *record = &objspace->profile.records[i];
8955
8956 prof = rb_hash_new();
8957 rb_hash_aset(prof, ID2SYM(rb_intern("GC_FLAGS")), gc_info_decode(objspace, rb_hash_new(), record->flags));
8958 rb_hash_aset(prof, ID2SYM(rb_intern("GC_TIME")), DBL2NUM(record->gc_time));
8959 rb_hash_aset(prof, ID2SYM(rb_intern("GC_INVOKE_TIME")), DBL2NUM(record->gc_invoke_time));
8960 rb_hash_aset(prof, ID2SYM(rb_intern("HEAP_USE_SIZE")), SIZET2NUM(record->heap_use_size));
8961 rb_hash_aset(prof, ID2SYM(rb_intern("HEAP_TOTAL_SIZE")), SIZET2NUM(record->heap_total_size));
8962 rb_hash_aset(prof, ID2SYM(rb_intern("HEAP_TOTAL_OBJECTS")), SIZET2NUM(record->heap_total_objects));
8963 rb_hash_aset(prof, ID2SYM(rb_intern("MOVED_OBJECTS")), SIZET2NUM(record->moved_objects));
8964 rb_hash_aset(prof, ID2SYM(rb_intern("GC_IS_MARKED")), Qtrue);
8965#if GC_PROFILE_MORE_DETAIL
8966 rb_hash_aset(prof, ID2SYM(rb_intern("GC_MARK_TIME")), DBL2NUM(record->gc_mark_time));
8967 rb_hash_aset(prof, ID2SYM(rb_intern("GC_SWEEP_TIME")), DBL2NUM(record->gc_sweep_time));
8968 rb_hash_aset(prof, ID2SYM(rb_intern("ALLOCATE_INCREASE")), SIZET2NUM(record->allocate_increase));
8969 rb_hash_aset(prof, ID2SYM(rb_intern("ALLOCATE_LIMIT")), SIZET2NUM(record->allocate_limit));
8970 rb_hash_aset(prof, ID2SYM(rb_intern("HEAP_USE_PAGES")), SIZET2NUM(record->heap_use_pages));
8971 rb_hash_aset(prof, ID2SYM(rb_intern("HEAP_LIVE_OBJECTS")), SIZET2NUM(record->heap_live_objects));
8972 rb_hash_aset(prof, ID2SYM(rb_intern("HEAP_FREE_OBJECTS")), SIZET2NUM(record->heap_free_objects));
8973
8974 rb_hash_aset(prof, ID2SYM(rb_intern("REMOVING_OBJECTS")), SIZET2NUM(record->removing_objects));
8975 rb_hash_aset(prof, ID2SYM(rb_intern("EMPTY_OBJECTS")), SIZET2NUM(record->empty_objects));
8976
8977 rb_hash_aset(prof, ID2SYM(rb_intern("HAVE_FINALIZE")), (record->flags & GPR_FLAG_HAVE_FINALIZE) ? Qtrue : Qfalse);
8978#endif
8979
8980#if RGENGC_PROFILE > 0
8981 rb_hash_aset(prof, ID2SYM(rb_intern("OLD_OBJECTS")), SIZET2NUM(record->old_objects));
8982 rb_hash_aset(prof, ID2SYM(rb_intern("REMEMBERED_NORMAL_OBJECTS")), SIZET2NUM(record->remembered_normal_objects));
8983 rb_hash_aset(prof, ID2SYM(rb_intern("REMEMBERED_SHADY_OBJECTS")), SIZET2NUM(record->remembered_shady_objects));
8984#endif
8985 rb_ary_push(gc_profile, prof);
8986 }
8987
8988 return gc_profile;
8989}
8990
8991#if GC_PROFILE_MORE_DETAIL
8992#define MAJOR_REASON_MAX 0x10
8993
8994static char *
8995gc_profile_dump_major_reason(unsigned int flags, char *buff)
8996{
8997 unsigned int reason = flags & GPR_FLAG_MAJOR_MASK;
8998 int i = 0;
8999
9000 if (reason == GPR_FLAG_NONE) {
9001 buff[0] = '-';
9002 buff[1] = 0;
9003 }
9004 else {
9005#define C(x, s) \
9006 if (reason & GPR_FLAG_MAJOR_BY_##x) { \
9007 buff[i++] = #x[0]; \
9008 if (i >= MAJOR_REASON_MAX) rb_bug("gc_profile_dump_major_reason: overflow"); \
9009 buff[i] = 0; \
9010 }
9011 C(NOFREE, N);
9012 C(OLDGEN, O);
9013 C(SHADY, S);
9014#if RGENGC_ESTIMATE_OLDMALLOC
9015 C(OLDMALLOC, M);
9016#endif
9017#undef C
9018 }
9019 return buff;
9020}
9021#endif
9022
9023
9024
9025static void
9026gc_profile_dump_on(VALUE out, VALUE (*append)(VALUE, VALUE))
9027{
9028 rb_objspace_t *objspace = rb_gc_get_objspace();
9029 size_t count = objspace->profile.next_index;
9030#ifdef MAJOR_REASON_MAX
9031 char reason_str[MAJOR_REASON_MAX];
9032#endif
9033
9034 if (objspace->profile.run && count /* > 1 */) {
9035 size_t i;
9036 const gc_profile_record *record;
9037
9038 append(out, rb_sprintf("GC %"PRIuSIZE" invokes.\n", objspace->profile.count));
9039 append(out, rb_str_new_cstr("Index Invoke Time(sec) Use Size(byte) Total Size(byte) Total Object GC Time(ms)\n"));
9040
9041 for (i = 0; i < count; i++) {
9042 record = &objspace->profile.records[i];
9043 append(out, rb_sprintf("%5"PRIuSIZE" %19.3f %20"PRIuSIZE" %20"PRIuSIZE" %20"PRIuSIZE" %30.20f\n",
9044 i+1, record->gc_invoke_time, record->heap_use_size,
9045 record->heap_total_size, record->heap_total_objects, record->gc_time*1000));
9046 }
9047
9048#if GC_PROFILE_MORE_DETAIL
9049 const char *str = "\n\n" \
9050 "More detail.\n" \
9051 "Prepare Time = Previously GC's rest sweep time\n"
9052 "Index Flags Allocate Inc. Allocate Limit"
9053#if CALC_EXACT_MALLOC_SIZE
9054 " Allocated Size"
9055#endif
9056 " Use Page Mark Time(ms) Sweep Time(ms) Prepare Time(ms) LivingObj FreeObj RemovedObj EmptyObj"
9057#if RGENGC_PROFILE
9058 " OldgenObj RemNormObj RemShadObj"
9059#endif
9060#if GC_PROFILE_DETAIL_MEMORY
9061 " MaxRSS(KB) MinorFLT MajorFLT"
9062#endif
9063 "\n";
9064 append(out, rb_str_new_cstr(str));
9065
9066 for (i = 0; i < count; i++) {
9067 record = &objspace->profile.records[i];
9068 append(out, rb_sprintf("%5"PRIuSIZE" %4s/%c/%6s%c %13"PRIuSIZE" %15"PRIuSIZE
9069#if CALC_EXACT_MALLOC_SIZE
9070 " %15"PRIuSIZE
9071#endif
9072 " %9"PRIuSIZE" %17.12f %17.12f %17.12f %10"PRIuSIZE" %10"PRIuSIZE" %10"PRIuSIZE" %10"PRIuSIZE
9073#if RGENGC_PROFILE
9074 "%10"PRIuSIZE" %10"PRIuSIZE" %10"PRIuSIZE
9075#endif
9076#if GC_PROFILE_DETAIL_MEMORY
9077 "%11ld %8ld %8ld"
9078#endif
9079
9080 "\n",
9081 i+1,
9082 gc_profile_dump_major_reason(record->flags, reason_str),
9083 (record->flags & GPR_FLAG_HAVE_FINALIZE) ? 'F' : '.',
9084 (record->flags & GPR_FLAG_NEWOBJ) ? "NEWOBJ" :
9085 (record->flags & GPR_FLAG_MALLOC) ? "MALLOC" :
9086 (record->flags & GPR_FLAG_METHOD) ? "METHOD" :
9087 (record->flags & GPR_FLAG_CAPI) ? "CAPI__" : "??????",
9088 (record->flags & GPR_FLAG_STRESS) ? '!' : ' ',
9089 record->allocate_increase, record->allocate_limit,
9090#if CALC_EXACT_MALLOC_SIZE
9091 record->allocated_size,
9092#endif
9093 record->heap_use_pages,
9094 record->gc_mark_time*1000,
9095 record->gc_sweep_time*1000,
9096 record->prepare_time*1000,
9097
9098 record->heap_live_objects,
9099 record->heap_free_objects,
9100 record->removing_objects,
9101 record->empty_objects
9102#if RGENGC_PROFILE
9103 ,
9104 record->old_objects,
9105 record->remembered_normal_objects,
9106 record->remembered_shady_objects
9107#endif
9108#if GC_PROFILE_DETAIL_MEMORY
9109 ,
9110 record->maxrss / 1024,
9111 record->minflt,
9112 record->majflt
9113#endif
9114
9115 ));
9116 }
9117#endif
9118 }
9119}
9120
9121/*
9122 * call-seq:
9123 * GC::Profiler.result -> String
9124 *
9125 * Returns a profile data report such as:
9126 *
9127 * GC 1 invokes.
9128 * Index Invoke Time(sec) Use Size(byte) Total Size(byte) Total Object GC time(ms)
9129 * 1 0.012 159240 212940 10647 0.00000000000001530000
9130 */
9131
9132static VALUE
9133gc_profile_result(VALUE _)
9134{
9135 VALUE str = rb_str_buf_new(0);
9136 gc_profile_dump_on(str, rb_str_buf_append);
9137 return str;
9138}
9139
9140/*
9141 * call-seq:
9142 * GC::Profiler.report
9143 * GC::Profiler.report(io)
9144 *
9145 * Writes the GC::Profiler.result to <tt>$stdout</tt> or the given IO object.
9146 *
9147 */
9148
9149static VALUE
9150gc_profile_report(int argc, VALUE *argv, VALUE self)
9151{
9152 VALUE out;
9153
9154 out = (!rb_check_arity(argc, 0, 1) ? rb_stdout : argv[0]);
9155 gc_profile_dump_on(out, rb_io_write);
9156
9157 return Qnil;
9158}
9159
9160/*
9161 * call-seq:
9162 * GC::Profiler.total_time -> float
9163 *
9164 * The total time used for garbage collection in seconds
9165 */
9166
9167static VALUE
9168gc_profile_total_time(VALUE self)
9169{
9170 double time = 0;
9171 rb_objspace_t *objspace = rb_gc_get_objspace();
9172
9173 if (objspace->profile.run && objspace->profile.next_index > 0) {
9174 size_t i;
9175 size_t count = objspace->profile.next_index;
9176
9177 for (i = 0; i < count; i++) {
9178 time += objspace->profile.records[i].gc_time;
9179 }
9180 }
9181 return DBL2NUM(time);
9182}
9183
9184/*
9185 * call-seq:
9186 * GC::Profiler.enabled? -> true or false
9187 *
9188 * The current status of \GC profile mode.
9189 */
9190
9191static VALUE
9192gc_profile_enable_get(VALUE self)
9193{
9194 rb_objspace_t *objspace = rb_gc_get_objspace();
9195 return objspace->profile.run ? Qtrue : Qfalse;
9196}
9197
9198/*
9199 * call-seq:
9200 * GC::Profiler.enable -> nil
9201 *
9202 * Starts the \GC profiler.
9203 *
9204 */
9205
9206static VALUE
9207gc_profile_enable(VALUE _)
9208{
9209 rb_objspace_t *objspace = rb_gc_get_objspace();
9210 objspace->profile.run = TRUE;
9211 objspace->profile.current_record = 0;
9212 return Qnil;
9213}
9214
9215/*
9216 * call-seq:
9217 * GC::Profiler.disable -> nil
9218 *
9219 * Stops the \GC profiler.
9220 *
9221 */
9222
9223static VALUE
9224gc_profile_disable(VALUE _)
9225{
9226 rb_objspace_t *objspace = rb_gc_get_objspace();
9227
9228 objspace->profile.run = FALSE;
9229 objspace->profile.current_record = 0;
9230 return Qnil;
9231}
9232
9233void
9234rb_gc_verify_internal_consistency(void)
9235{
9236 gc_verify_internal_consistency(rb_gc_get_objspace());
9237}
9238
9239/*
9240 * call-seq:
9241 * GC.verify_internal_consistency -> nil
9242 *
9243 * Verify internal consistency.
9244 *
9245 * This method is implementation specific.
9246 * Now this method checks generational consistency
9247 * if RGenGC is supported.
9248 */
9249static VALUE
9250gc_verify_internal_consistency_m(VALUE dummy)
9251{
9252 rb_gc_verify_internal_consistency();
9253 return Qnil;
9254}
9255
9256#if GC_CAN_COMPILE_COMPACTION
9257/*
9258 * call-seq:
9259 * GC.auto_compact = flag
9260 *
9261 * Updates automatic compaction mode.
9262 *
9263 * When enabled, the compactor will execute on every major collection.
9264 *
9265 * Enabling compaction will degrade performance on major collections.
9266 */
9267static VALUE
9268gc_set_auto_compact(VALUE _, VALUE v)
9269{
9270 GC_ASSERT(GC_COMPACTION_SUPPORTED);
9271
9272 ruby_enable_autocompact = RTEST(v);
9273
9274#if RGENGC_CHECK_MODE
9275 ruby_autocompact_compare_func = NULL;
9276
9277 if (SYMBOL_P(v)) {
9278 ID id = RB_SYM2ID(v);
9279 if (id == rb_intern("empty")) {
9280 ruby_autocompact_compare_func = compare_free_slots;
9281 }
9282 }
9283#endif
9284
9285 return v;
9286}
9287#else
9288# define gc_set_auto_compact rb_f_notimplement
9289#endif
9290
9291#if GC_CAN_COMPILE_COMPACTION
9292/*
9293 * call-seq:
9294 * GC.auto_compact -> true or false
9295 *
9296 * Returns whether or not automatic compaction has been enabled.
9297 */
9298static VALUE
9299gc_get_auto_compact(VALUE _)
9300{
9301 return ruby_enable_autocompact ? Qtrue : Qfalse;
9302}
9303#else
9304# define gc_get_auto_compact rb_f_notimplement
9305#endif
9306
9307#if GC_CAN_COMPILE_COMPACTION
9308/*
9309 * call-seq:
9310 * GC.latest_compact_info -> hash
9311 *
9312 * Returns information about object moved in the most recent \GC compaction.
9313 *
9314 * The returned +hash+ contains the following keys:
9315 *
9316 * [considered]
9317 * Hash containing the type of the object as the key and the number of
9318 * objects of that type that were considered for movement.
9319 * [moved]
9320 * Hash containing the type of the object as the key and the number of
9321 * objects of that type that were actually moved.
9322 * [moved_up]
9323 * Hash containing the type of the object as the key and the number of
9324 * objects of that type that were increased in size.
9325 * [moved_down]
9326 * Hash containing the type of the object as the key and the number of
9327 * objects of that type that were decreased in size.
9328 *
9329 * Some objects can't be moved (due to pinning) so these numbers can be used to
9330 * calculate compaction efficiency.
9331 */
9332static VALUE
9333gc_compact_stats(VALUE self)
9334{
9335 rb_objspace_t *objspace = rb_gc_get_objspace();
9336 VALUE h = rb_hash_new();
9337 VALUE considered = rb_hash_new();
9338 VALUE moved = rb_hash_new();
9339 VALUE moved_up = rb_hash_new();
9340 VALUE moved_down = rb_hash_new();
9341
9342 for (size_t i = 0; i < T_MASK; i++) {
9343 if (objspace->rcompactor.considered_count_table[i]) {
9344 rb_hash_aset(considered, type_sym(i), SIZET2NUM(objspace->rcompactor.considered_count_table[i]));
9345 }
9346
9347 if (objspace->rcompactor.moved_count_table[i]) {
9348 rb_hash_aset(moved, type_sym(i), SIZET2NUM(objspace->rcompactor.moved_count_table[i]));
9349 }
9350
9351 if (objspace->rcompactor.moved_up_count_table[i]) {
9352 rb_hash_aset(moved_up, type_sym(i), SIZET2NUM(objspace->rcompactor.moved_up_count_table[i]));
9353 }
9354
9355 if (objspace->rcompactor.moved_down_count_table[i]) {
9356 rb_hash_aset(moved_down, type_sym(i), SIZET2NUM(objspace->rcompactor.moved_down_count_table[i]));
9357 }
9358 }
9359
9360 rb_hash_aset(h, ID2SYM(rb_intern("considered")), considered);
9361 rb_hash_aset(h, ID2SYM(rb_intern("moved")), moved);
9362 rb_hash_aset(h, ID2SYM(rb_intern("moved_up")), moved_up);
9363 rb_hash_aset(h, ID2SYM(rb_intern("moved_down")), moved_down);
9364
9365 return h;
9366}
9367#else
9368# define gc_compact_stats rb_f_notimplement
9369#endif
9370
9371#if GC_CAN_COMPILE_COMPACTION
9372/*
9373 * call-seq:
9374 * GC.compact -> hash
9375 *
9376 * This function compacts objects together in Ruby's heap. It eliminates
9377 * unused space (or fragmentation) in the heap by moving objects in to that
9378 * unused space.
9379 *
9380 * The returned +hash+ contains statistics about the objects that were moved;
9381 * see GC.latest_compact_info.
9382 *
9383 * This method is only expected to work on CRuby.
9384 *
9385 * To test whether \GC compaction is supported, use the idiom:
9386 *
9387 * GC.respond_to?(:compact)
9388 */
9389static VALUE
9390gc_compact(VALUE self)
9391{
9392 rb_objspace_t *objspace = rb_gc_get_objspace();
9393 int full_marking_p = gc_config_full_mark_val;
9394 gc_config_full_mark_set(TRUE);
9395
9396 /* Run GC with compaction enabled */
9397 rb_gc_impl_start(rb_gc_get_objspace(), true, true, true, true);
9398 gc_config_full_mark_set(full_marking_p);
9399
9400 return gc_compact_stats(self);
9401}
9402#else
9403# define gc_compact rb_f_notimplement
9404#endif
9405
9406#if GC_CAN_COMPILE_COMPACTION
9407struct desired_compaction_pages_i_data {
9409 size_t required_slots[HEAP_COUNT];
9410};
9411
9412static int
9413desired_compaction_pages_i(struct heap_page *page, void *data)
9414{
9415 struct desired_compaction_pages_i_data *tdata = data;
9416 rb_objspace_t *objspace = tdata->objspace;
9417 VALUE vstart = (VALUE)page->start;
9418 VALUE vend = vstart + (VALUE)(page->total_slots * page->heap->slot_size);
9419
9420
9421 for (VALUE v = vstart; v != vend; v += page->heap->slot_size) {
9422 asan_unpoisoning_object(v) {
9423 /* skip T_NONEs; they won't be moved */
9424 if (BUILTIN_TYPE(v) != T_NONE) {
9425 rb_heap_t *dest_pool = gc_compact_destination_pool(objspace, page->heap, v);
9426 size_t dest_pool_idx = dest_pool - heaps;
9427 tdata->required_slots[dest_pool_idx]++;
9428 }
9429 }
9430 }
9431
9432 return 0;
9433}
9434
9435/* call-seq:
9436 * GC.verify_compaction_references(toward: nil, double_heap: false) -> hash
9437 *
9438 * Verify compaction reference consistency.
9439 *
9440 * This method is implementation specific. During compaction, objects that
9441 * were moved are replaced with T_MOVED objects. No object should have a
9442 * reference to a T_MOVED object after compaction.
9443 *
9444 * This function expands the heap to ensure room to move all objects,
9445 * compacts the heap to make sure everything moves, updates all references,
9446 * then performs a full \GC. If any object contains a reference to a T_MOVED
9447 * object, that object should be pushed on the mark stack, and will
9448 * make a SEGV.
9449 */
9450static VALUE
9451gc_verify_compaction_references(int argc, VALUE* argv, VALUE self)
9452{
9453 static ID keywords[3] = {0};
9454 if (!keywords[0]) {
9455 keywords[0] = rb_intern("toward");
9456 keywords[1] = rb_intern("double_heap");
9457 keywords[2] = rb_intern("expand_heap");
9458 }
9459
9460 VALUE options;
9461 rb_scan_args_kw(rb_keyword_given_p(), argc, argv, ":", &options);
9462
9463 VALUE arguments[3] = { Qnil, Qfalse, Qfalse };
9464 int kwarg_count = rb_get_kwargs(options, keywords, 0, 3, arguments);
9465 bool toward_empty = kwarg_count > 0 && SYMBOL_P(arguments[0]) && SYM2ID(arguments[0]) == rb_intern("empty");
9466 bool expand_heap = (kwarg_count > 1 && RTEST(arguments[1])) || (kwarg_count > 2 && RTEST(arguments[2]));
9467
9468 rb_objspace_t *objspace = rb_gc_get_objspace();
9469
9470 /* Clear the heap. */
9471 rb_gc_impl_start(objspace, true, true, true, false);
9472
9473 unsigned int lev = RB_GC_VM_LOCK();
9474 {
9475 gc_rest(objspace);
9476
9477 /* if both double_heap and expand_heap are set, expand_heap takes precedence */
9478 if (expand_heap) {
9479 struct desired_compaction_pages_i_data desired_compaction = {
9480 .objspace = objspace,
9481 .required_slots = {0},
9482 };
9483 /* Work out how many objects want to be in each size pool, taking account of moves */
9484 objspace_each_pages(objspace, desired_compaction_pages_i, &desired_compaction, TRUE);
9485
9486 /* Find out which pool has the most pages */
9487 size_t max_existing_pages = 0;
9488 for (int i = 0; i < HEAP_COUNT; i++) {
9489 rb_heap_t *heap = &heaps[i];
9490 max_existing_pages = MAX(max_existing_pages, heap->total_pages);
9491 }
9492
9493 /* Add pages to each size pool so that compaction is guaranteed to move every object */
9494 for (int i = 0; i < HEAP_COUNT; i++) {
9495 rb_heap_t *heap = &heaps[i];
9496
9497 size_t pages_to_add = 0;
9498 /*
9499 * Step 1: Make sure every pool has the same number of pages, by adding empty pages
9500 * to smaller pools. This is required to make sure the compact cursor can advance
9501 * through all of the pools in `gc_sweep_compact` without hitting the "sweep &
9502 * compact cursors met" condition on some pools before fully compacting others
9503 */
9504 pages_to_add += max_existing_pages - heap->total_pages;
9505 /*
9506 * Step 2: Now add additional free pages to each size pool sufficient to hold all objects
9507 * that want to be in that size pool, whether moved into it or moved within it
9508 */
9509 objspace->heap_pages.allocatable_bytes = desired_compaction.required_slots[i] * heap->slot_size;
9510 while (objspace->heap_pages.allocatable_bytes > 0) {
9511 heap_page_allocate_and_initialize(objspace, heap);
9512 }
9513 /*
9514 * Step 3: Add two more pages so that the compact & sweep cursors will meet _after_ all objects
9515 * have been moved, and not on the last iteration of the `gc_sweep_compact` loop
9516 */
9517 pages_to_add += 2;
9518
9519 for (; pages_to_add > 0; pages_to_add--) {
9520 heap_page_allocate_and_initialize_force(objspace, heap);
9521 }
9522 }
9523 }
9524
9525 if (toward_empty) {
9526 objspace->rcompactor.compare_func = compare_free_slots;
9527 }
9528 }
9529 RB_GC_VM_UNLOCK(lev);
9530
9531 rb_gc_impl_start(rb_gc_get_objspace(), true, true, true, true);
9532
9533 rb_objspace_reachable_objects_from_root(root_obj_check_moved_i, objspace);
9534 objspace_each_objects(objspace, heap_check_moved_i, objspace, TRUE);
9535
9536 objspace->rcompactor.compare_func = NULL;
9537
9538 return gc_compact_stats(self);
9539}
9540#else
9541# define gc_verify_compaction_references rb_f_notimplement
9542#endif
9543
9544void
9545rb_gc_impl_objspace_free(void *objspace_ptr)
9546{
9547 rb_objspace_t *objspace = objspace_ptr;
9548
9549 if (is_lazy_sweeping(objspace))
9550 rb_bug("lazy sweeping underway when freeing object space");
9551
9552 free(objspace->profile.records);
9553 objspace->profile.records = NULL;
9554
9555 for (size_t i = 0; i < rb_darray_size(objspace->heap_pages.sorted); i++) {
9556 heap_page_free(objspace, rb_darray_get(objspace->heap_pages.sorted, i));
9557 }
9558 rb_darray_free_without_gc(objspace->heap_pages.sorted);
9559 heap_pages_lomem = 0;
9560 heap_pages_himem = 0;
9561
9562 for (int i = 0; i < HEAP_COUNT; i++) {
9563 rb_heap_t *heap = &heaps[i];
9564 heap->total_pages = 0;
9565 heap->total_slots = 0;
9566 }
9567
9568 free_stack_chunks(&objspace->mark_stack);
9569 mark_stack_free_cache(&objspace->mark_stack);
9570
9571 rb_darray_free_without_gc(objspace->weak_references);
9572
9573#ifdef MALLOC_COUNTERS_NEED_LOCK
9574 rb_native_mutex_destroy(&objspace->malloc_counters.lock);
9575#endif
9576
9577 free(objspace);
9578}
9579
9580#if MALLOC_ALLOCATED_SIZE
9581/*
9582 * call-seq:
9583 * GC.malloc_allocated_size -> Integer
9584 *
9585 * Returns the size of memory allocated by malloc().
9586 *
9587 * Only available if ruby was built with +CALC_EXACT_MALLOC_SIZE+.
9588 */
9589
9590static VALUE
9591gc_malloc_allocated_size(VALUE self)
9592{
9593 rb_objspace_t *objspace = (rb_objspace_t *)rb_gc_get_objspace();
9594 return ULL2NUM(objspace->malloc_params.allocated_size);
9595}
9596
9597/*
9598 * call-seq:
9599 * GC.malloc_allocations -> Integer
9600 *
9601 * Returns the number of malloc() allocations.
9602 *
9603 * Only available if ruby was built with +CALC_EXACT_MALLOC_SIZE+.
9604 */
9605
9606static VALUE
9607gc_malloc_allocations(VALUE self)
9608{
9609 rb_objspace_t *objspace = (rb_objspace_t *)rb_gc_get_objspace();
9610 return ULL2NUM(objspace->malloc_params.allocations);
9611}
9612#endif
9613
9614void
9615rb_gc_impl_before_fork(void *objspace_ptr)
9616{
9617 rb_objspace_t *objspace = objspace_ptr;
9618
9619 objspace->fork_vm_lock_lev = RB_GC_VM_LOCK();
9620 rb_gc_vm_barrier();
9621}
9622
9623void
9624rb_gc_impl_after_fork(void *objspace_ptr, rb_pid_t pid)
9625{
9626 rb_objspace_t *objspace = objspace_ptr;
9627
9628 RB_GC_VM_UNLOCK(objspace->fork_vm_lock_lev);
9629 objspace->fork_vm_lock_lev = 0;
9630
9631 if (pid == 0) { /* child process */
9632 rb_gc_ractor_newobj_cache_foreach(gc_ractor_newobj_cache_clear, NULL);
9633 }
9634}
9635
9636VALUE rb_ident_hash_new_with_size(st_index_t size);
9637
9638#if GC_DEBUG_STRESS_TO_CLASS
9639/*
9640 * call-seq:
9641 * GC.add_stress_to_class(class[, ...])
9642 *
9643 * Raises NoMemoryError when allocating an instance of the given classes.
9644 *
9645 */
9646static VALUE
9647rb_gcdebug_add_stress_to_class(int argc, VALUE *argv, VALUE self)
9648{
9649 rb_objspace_t *objspace = rb_gc_get_objspace();
9650
9651 if (!stress_to_class) {
9652 set_stress_to_class(rb_ident_hash_new_with_size(argc));
9653 }
9654
9655 for (int i = 0; i < argc; i++) {
9656 VALUE klass = argv[i];
9657 rb_hash_aset(stress_to_class, klass, Qtrue);
9658 }
9659
9660 return self;
9661}
9662
9663/*
9664 * call-seq:
9665 * GC.remove_stress_to_class(class[, ...])
9666 *
9667 * No longer raises NoMemoryError when allocating an instance of the
9668 * given classes.
9669 *
9670 */
9671static VALUE
9672rb_gcdebug_remove_stress_to_class(int argc, VALUE *argv, VALUE self)
9673{
9674 rb_objspace_t *objspace = rb_gc_get_objspace();
9675
9676 if (stress_to_class) {
9677 for (int i = 0; i < argc; ++i) {
9678 rb_hash_delete(stress_to_class, argv[i]);
9679 }
9680
9681 if (rb_hash_size(stress_to_class) == 0) {
9682 stress_to_class = 0;
9683 }
9684 }
9685
9686 return Qnil;
9687}
9688#endif
9689
9690void *
9691rb_gc_impl_objspace_alloc(void)
9692{
9693 rb_objspace_t *objspace = calloc1(sizeof(rb_objspace_t));
9694
9695 return objspace;
9696}
9697
9698void
9699rb_gc_impl_objspace_init(void *objspace_ptr)
9700{
9701 rb_objspace_t *objspace = objspace_ptr;
9702
9703 gc_config_full_mark_set(TRUE);
9704
9705 objspace->flags.measure_gc = true;
9706 malloc_limit = gc_params.malloc_limit_min;
9707#ifdef MALLOC_COUNTERS_NEED_LOCK
9708 rb_native_mutex_initialize(&objspace->malloc_counters.lock);
9709#endif
9710 objspace->finalize_deferred_pjob = rb_postponed_job_preregister(0, gc_finalize_deferred, objspace);
9711 if (objspace->finalize_deferred_pjob == POSTPONED_JOB_HANDLE_INVALID) {
9712 rb_bug("Could not preregister postponed job for GC");
9713 }
9714
9715 /* A standard RVALUE (RBasic + embedded VALUEs + debug overhead) must fit
9716 * in at least one pool. In debug builds RVALUE_OVERHEAD can push this
9717 * beyond the 48-byte pool into the 64-byte pool, which is fine. */
9718 GC_ASSERT(rb_gc_impl_size_allocatable_p(sizeof(struct RBasic) + sizeof(VALUE[RBIMPL_RVALUE_EMBED_LEN_MAX])));
9719
9720 for (int i = 0; i < HEAP_COUNT; i++) {
9721 rb_heap_t *heap = &heaps[i];
9722
9723 heap->slot_size = pool_slot_sizes[i];
9724
9725 ccan_list_head_init(&heap->pages);
9726 }
9727
9728 init_size_to_heap_idx();
9729
9730 rb_darray_make_without_gc(&objspace->heap_pages.sorted, 0);
9731 rb_darray_make_without_gc(&objspace->weak_references, 0);
9732
9733#if defined(INIT_HEAP_PAGE_ALLOC_USE_MMAP)
9734 /* Need to determine if we can use mmap at runtime. */
9735 heap_page_alloc_use_mmap = INIT_HEAP_PAGE_ALLOC_USE_MMAP;
9736#endif
9737#if RGENGC_ESTIMATE_OLDMALLOC
9738 objspace->rgengc.oldmalloc_increase_limit = gc_params.oldmalloc_limit_min;
9739#endif
9740 gc_params.heap_init_bytes = GC_HEAP_INIT_BYTES;
9741
9742 init_mark_stack(&objspace->mark_stack);
9743
9744 objspace->profile.invoke_time = getrusage_time();
9745 finalizer_table = st_init_numtable();
9746}
9747
9748void
9749rb_gc_impl_init(void)
9750{
9751 VALUE gc_constants = rb_hash_new();
9752 rb_hash_aset(gc_constants, ID2SYM(rb_intern("DEBUG")), GC_DEBUG ? Qtrue : Qfalse);
9753 /* Minimum slot size that fits a standard RVALUE */
9754 size_t rvalue_pool = 0;
9755 for (size_t i = 0; i < HEAP_COUNT; i++) {
9756 if (pool_slot_sizes[i] >= RVALUE_SLOT_SIZE) { rvalue_pool = pool_slot_sizes[i]; break; }
9757 }
9758 rb_hash_aset(gc_constants, ID2SYM(rb_intern("RVALUE_SIZE")), SIZET2NUM(rvalue_pool - RVALUE_OVERHEAD));
9759 rb_hash_aset(gc_constants, ID2SYM(rb_intern("RBASIC_SIZE")), SIZET2NUM(sizeof(struct RBasic)));
9760 rb_hash_aset(gc_constants, ID2SYM(rb_intern("RVALUE_OVERHEAD")), SIZET2NUM(RVALUE_OVERHEAD));
9761 rb_hash_aset(gc_constants, ID2SYM(rb_intern("HEAP_PAGE_BITMAP_SIZE")), SIZET2NUM(HEAP_PAGE_BITMAP_SIZE));
9762 rb_hash_aset(gc_constants, ID2SYM(rb_intern("HEAP_PAGE_SIZE")), SIZET2NUM(HEAP_PAGE_SIZE));
9763 rb_hash_aset(gc_constants, ID2SYM(rb_intern("HEAP_COUNT")), LONG2FIX(HEAP_COUNT));
9764 rb_hash_aset(gc_constants, ID2SYM(rb_intern("RVARGC_MAX_ALLOCATE_SIZE")), LONG2FIX(heap_slot_size(HEAP_COUNT - 1)));
9765 rb_hash_aset(gc_constants, ID2SYM(rb_intern("RVALUE_OLD_AGE")), LONG2FIX(RVALUE_OLD_AGE));
9766 if (RB_BUG_INSTEAD_OF_RB_MEMERROR+0) {
9767 rb_hash_aset(gc_constants, ID2SYM(rb_intern("RB_BUG_INSTEAD_OF_RB_MEMERROR")), Qtrue);
9768 }
9769 OBJ_FREEZE(gc_constants);
9770 /* Internal constants in the garbage collector. */
9771 rb_define_const(rb_mGC, "INTERNAL_CONSTANTS", gc_constants);
9772
9773 if (GC_COMPACTION_SUPPORTED) {
9774 rb_define_singleton_method(rb_mGC, "compact", gc_compact, 0);
9775 rb_define_singleton_method(rb_mGC, "auto_compact", gc_get_auto_compact, 0);
9776 rb_define_singleton_method(rb_mGC, "auto_compact=", gc_set_auto_compact, 1);
9777 rb_define_singleton_method(rb_mGC, "latest_compact_info", gc_compact_stats, 0);
9778 rb_define_singleton_method(rb_mGC, "verify_compaction_references", gc_verify_compaction_references, -1);
9779 }
9780 else {
9784 rb_define_singleton_method(rb_mGC, "latest_compact_info", rb_f_notimplement, 0);
9785 rb_define_singleton_method(rb_mGC, "verify_compaction_references", rb_f_notimplement, -1);
9786 }
9787
9788#if GC_DEBUG_STRESS_TO_CLASS
9789 rb_define_singleton_method(rb_mGC, "add_stress_to_class", rb_gcdebug_add_stress_to_class, -1);
9790 rb_define_singleton_method(rb_mGC, "remove_stress_to_class", rb_gcdebug_remove_stress_to_class, -1);
9791#endif
9792
9793 /* internal methods */
9794 rb_define_singleton_method(rb_mGC, "verify_internal_consistency", gc_verify_internal_consistency_m, 0);
9795
9796#if MALLOC_ALLOCATED_SIZE
9797 rb_define_singleton_method(rb_mGC, "malloc_allocated_size", gc_malloc_allocated_size, 0);
9798 rb_define_singleton_method(rb_mGC, "malloc_allocations", gc_malloc_allocations, 0);
9799#endif
9800
9801 VALUE rb_mProfiler = rb_define_module_under(rb_mGC, "Profiler");
9802 rb_define_singleton_method(rb_mProfiler, "enabled?", gc_profile_enable_get, 0);
9803 rb_define_singleton_method(rb_mProfiler, "enable", gc_profile_enable, 0);
9804 rb_define_singleton_method(rb_mProfiler, "raw_data", gc_profile_record_get, 0);
9805 rb_define_singleton_method(rb_mProfiler, "disable", gc_profile_disable, 0);
9806 rb_define_singleton_method(rb_mProfiler, "clear", gc_profile_clear, 0);
9807 rb_define_singleton_method(rb_mProfiler, "result", gc_profile_result, 0);
9808 rb_define_singleton_method(rb_mProfiler, "report", gc_profile_report, -1);
9809 rb_define_singleton_method(rb_mProfiler, "total_time", gc_profile_total_time, 0);
9810
9811 {
9812 VALUE opts;
9813 /* \GC build options */
9814 rb_define_const(rb_mGC, "OPTS", opts = rb_ary_new());
9815#define OPT(o) if (o) rb_ary_push(opts, rb_interned_str(#o, sizeof(#o) - 1))
9816 OPT(GC_DEBUG);
9817 OPT(USE_RGENGC);
9818 OPT(RGENGC_DEBUG);
9819 OPT(RGENGC_CHECK_MODE);
9820 OPT(RGENGC_PROFILE);
9821 OPT(RGENGC_ESTIMATE_OLDMALLOC);
9822 OPT(GC_PROFILE_MORE_DETAIL);
9823 OPT(GC_ENABLE_LAZY_SWEEP);
9824 OPT(CALC_EXACT_MALLOC_SIZE);
9825 OPT(MALLOC_ALLOCATED_SIZE);
9826 OPT(MALLOC_ALLOCATED_SIZE_CHECK);
9827 OPT(GC_PROFILE_DETAIL_MEMORY);
9828 OPT(GC_COMPACTION_SUPPORTED);
9829#undef OPT
9830 OBJ_FREEZE(opts);
9831 }
9832}
#define RBIMPL_ASSERT_OR_ASSUME(...)
This is either RUBY_ASSERT or RBIMPL_ASSUME, depending on RUBY_DEBUG.
Definition assert.h:311
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
Atomic operations.
#define RUBY_ATOMIC_VALUE_CAS(var, oldval, newval)
Identical to RUBY_ATOMIC_CAS, except it expects its arguments are VALUE.
Definition atomic.h:406
#define RUBY_ATOMIC_SIZE_INC(var)
Identical to RUBY_ATOMIC_INC, except it expects its argument is size_t.
Definition atomic.h:246
#define RUBY_ATOMIC_SIZE_CAS(var, oldval, newval)
Identical to RUBY_ATOMIC_CAS, except it expects its arguments are size_t.
Definition atomic.h:284
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
Definition atomic.h:69
#define RUBY_ATOMIC_SIZE_ADD(var, val)
Identical to RUBY_ATOMIC_ADD, except it expects its arguments are size_t.
Definition atomic.h:297
#define RUBY_ATOMIC_VALUE_EXCHANGE(var, val)
Identical to RUBY_ATOMIC_EXCHANGE, except it expects its arguments are VALUE.
Definition atomic.h:392
#define RUBY_ATOMIC_SET(var, val)
Identical to RUBY_ATOMIC_EXCHANGE, except for the return type.
Definition atomic.h:185
#define RUBY_ATOMIC_EXCHANGE(var, val)
Atomically replaces the value pointed by var with val.
Definition atomic.h:152
#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...
Definition debug.h:703
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...
Definition vm_trace.c:1916
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 ...
Definition vm_trace.c:1882
#define RB_GNUC_EXTENSION_BLOCK(x)
This is expanded to the passed token for non-GCC compilers.
Definition defines.h:91
#define RUBY_INTERNAL_EVENT_GC_EXIT
gc_exit() is called.
Definition event.h:99
#define RUBY_INTERNAL_EVENT_GC_ENTER
gc_enter() is called.
Definition event.h:98
#define RUBY_INTERNAL_EVENT_GC_END_SWEEP
GC ended sweep phase.
Definition event.h:97
#define RUBY_INTERNAL_EVENT_GC_END_MARK
GC ended mark phase.
Definition event.h:96
#define RUBY_INTERNAL_EVENT_OBJSPACE_MASK
Bitmask of GC events.
Definition event.h:100
#define RUBY_INTERNAL_EVENT_FREEOBJ
Object swept.
Definition event.h:94
#define RUBY_INTERNAL_EVENT_GC_START
GC started.
Definition event.h:95
uint32_t rb_event_flag_t
Represents event(s).
Definition event.h:108
static VALUE RB_FL_TEST(VALUE obj, VALUE flags)
Tests if the given flag(s) are set or not.
Definition fl_type.h:430
static VALUE RB_FL_TEST_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_TEST().
Definition fl_type.h:404
static void RB_FL_SET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_SET().
Definition fl_type.h:541
static void RB_FL_UNSET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_UNSET().
Definition fl_type.h:601
@ RUBY_FL_PROMOTED
Ruby objects are "generational".
Definition fl_type.h:205
@ RUBY_FL_WEAK_REFERENCE
This object weakly refers to other objects.
Definition fl_type.h:260
VALUE rb_define_module_under(VALUE outer, const char *name)
Defines a module under the namespace of outer.
Definition class.c:1532
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.
Definition class.c:3074
int rb_keyword_given_p(void)
Determines if the current method is given a keyword argument.
Definition eval.c:1031
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
Definition class.c:2850
#define T_COMPLEX
Old name of RUBY_T_COMPLEX.
Definition value_type.h:59
#define T_FILE
Old name of RUBY_T_FILE.
Definition value_type.h:62
#define T_STRING
Old name of RUBY_T_STRING.
Definition value_type.h:78
#define xfree
Old name of ruby_xfree.
Definition xmalloc.h:58
#define T_MASK
Old name of RUBY_T_MASK.
Definition value_type.h:68
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
#define OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
Definition fl_type.h:133
#define T_NIL
Old name of RUBY_T_NIL.
Definition value_type.h:72
#define T_FLOAT
Old name of RUBY_T_FLOAT.
Definition value_type.h:64
#define T_IMEMO
Old name of RUBY_T_IMEMO.
Definition value_type.h:67
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
Definition value_type.h:57
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define T_STRUCT
Old name of RUBY_T_STRUCT.
Definition value_type.h:79
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
Definition fl_type.h:131
#define T_FIXNUM
Old name of RUBY_T_FIXNUM.
Definition value_type.h:63
#define SYM2ID
Old name of RB_SYM2ID.
Definition symbol.h:45
#define T_DATA
Old name of RUBY_T_DATA.
Definition value_type.h:60
#define FL_SHAREABLE
Old name of RUBY_FL_SHAREABLE.
Definition fl_type.h:62
#define T_NONE
Old name of RUBY_T_NONE.
Definition value_type.h:74
#define T_NODE
Old name of RUBY_T_NODE.
Definition value_type.h:73
#define SIZET2NUM
Old name of RB_SIZE2NUM.
Definition size_t.h:62
#define xmalloc
Old name of ruby_xmalloc.
Definition xmalloc.h:53
#define LONG2FIX
Old name of RB_INT2FIX.
Definition long.h:49
#define FIX2INT
Old name of RB_FIX2INT.
Definition int.h:41
#define FL_FINALIZE
Old name of RUBY_FL_FINALIZE.
Definition fl_type.h:61
#define T_MODULE
Old name of RUBY_T_MODULE.
Definition value_type.h:70
#define T_TRUE
Old name of RUBY_T_TRUE.
Definition value_type.h:81
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
Definition value_type.h:76
#define T_ICLASS
Old name of RUBY_T_ICLASS.
Definition value_type.h:66
#define T_HASH
Old name of RUBY_T_HASH.
Definition value_type.h:65
#define ALLOC_N
Old name of RB_ALLOC_N.
Definition memory.h:399
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition fl_type.h:128
#define FL_SET
Old name of RB_FL_SET.
Definition fl_type.h:125
#define rb_ary_new3
Old name of rb_ary_new_from_args.
Definition array.h:658
#define T_FALSE
Old name of RUBY_T_FALSE.
Definition value_type.h:61
#define ULL2NUM
Old name of RB_ULL2NUM.
Definition long_long.h:31
#define T_UNDEF
Old name of RUBY_T_UNDEF.
Definition value_type.h:82
#define Qtrue
Old name of RUBY_Qtrue.
#define T_ZOMBIE
Old name of RUBY_T_ZOMBIE.
Definition value_type.h:83
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
Definition value_type.h:56
#define T_OBJECT
Old name of RUBY_T_OBJECT.
Definition value_type.h:75
#define NIL_P
Old name of RB_NIL_P.
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
Definition fl_type.h:59
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
Definition value_type.h:80
#define DBL2NUM
Old name of rb_float_new.
Definition double.h:29
#define T_MATCH
Old name of RUBY_T_MATCH.
Definition value_type.h:69
#define T_CLASS
Old name of RUBY_T_CLASS.
Definition value_type.h:58
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition value_type.h:85
#define T_MOVED
Old name of RUBY_T_MOVED.
Definition value_type.h:71
#define FL_TEST
Old name of RB_FL_TEST.
Definition fl_type.h:127
#define FL_UNSET
Old name of RB_FL_UNSET.
Definition fl_type.h:129
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
Definition fl_type.h:126
#define SYMBOL_P
Old name of RB_SYMBOL_P.
Definition value_type.h:88
#define T_REGEXP
Old name of RUBY_T_REGEXP.
Definition value_type.h:77
#define ruby_verbose
This variable controls whether the interpreter is in debug mode.
Definition error.h:476
VALUE rb_eRuntimeError
RuntimeError exception.
Definition error.c:1425
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:467
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
Definition object.c:95
VALUE rb_mGC
GC module.
Definition gc.c:410
VALUE rb_equal(VALUE lhs, VALUE rhs)
This function is an optimised version of calling #==.
Definition object.c:141
VALUE rb_stdout
STDOUT constant.
Definition io.c:201
Routines to manipulate encodings of strings.
static bool RB_OBJ_PROMOTED_RAW(VALUE obj)
This is the implementation of RB_OBJ_PROMOTED().
Definition gc.h:558
#define USE_RGENGC
Definition gc.h:428
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.
Definition error.h:284
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.
Definition string.c:3802
VALUE rb_str_buf_new(long capa)
Allocates a "string buffer".
Definition string.c:1720
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
Definition string.h:1515
const char * rb_sourcefile(void)
Resembles __FILE__.
Definition vm.c:2072
VALUE rb_f_notimplement(int argc, const VALUE *argv, VALUE obj, VALUE marker)
Raises rb_eNotImpError.
Definition vm_method.c:905
int rb_sourceline(void)
Resembles __LINE__.
Definition vm.c:2086
#define RB_SYM2ID
Just another name of rb_sym2id.
Definition symbol.h:43
ID rb_sym2id(VALUE obj)
Converts an instance of rb_cSymbol into an ID.
Definition symbol.c:974
int capa
Designed capacity of the buffer.
Definition io.h:11
int len
Length of the buffer.
Definition io.h:8
void * rb_thread_call_with_gvl(void *(*func)(void *), void *data1)
(Re-)acquires the GVL.
Definition thread.c:2063
#define strtod(s, e)
Just another name of ruby_strtod.
Definition util.h:223
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.
Definition memory.h:360
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
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.
Definition rarray.h:51
static void RARRAY_ASET(VALUE ary, long i, VALUE v)
Assigns an object in an array.
Definition rarray.h:386
#define RARRAY_AREF(a, i)
Definition rarray.h:403
#define RBASIC(obj)
Convenient casting macro.
Definition rbasic.h:40
#define errno
Ractor-aware version of errno.
Definition ruby.h:388
int ruby_native_thread_p(void)
Queries if the thread which calls this function is a ruby's thread.
Definition thread.c:5815
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.
Definition stdarg.h:35
Ruby object's base components.
Definition rbasic.h:69
Definition gc_impl.h:15
Definition st.h:79
void rb_native_mutex_initialize(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_initialize.
void rb_native_mutex_destroy(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_destroy.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
static enum ruby_value_type RB_BUILTIN_TYPE(VALUE obj)
Queries the type of the object.
Definition value_type.h:182
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376
ruby_value_type
C-level type of an object.
Definition value_type.h:113
@ RUBY_T_SYMBOL
Definition value_type.h:135
@ RUBY_T_MATCH
Definition value_type.h:128
@ RUBY_T_MODULE
Definition value_type.h:118
@ RUBY_T_ICLASS
Hidden classes known as IClasses.
Definition value_type.h:141
@ RUBY_T_MOVED
Definition value_type.h:143
@ RUBY_T_FIXNUM
Integers formerly known as Fixnums.
Definition value_type.h:136
@ RUBY_T_IMEMO
Definition value_type.h:139
@ RUBY_T_NODE
Definition value_type.h:140
@ RUBY_T_OBJECT
Definition value_type.h:116
@ RUBY_T_DATA
Definition value_type.h:127
@ RUBY_T_FALSE
Definition value_type.h:134
@ RUBY_T_UNDEF
Definition value_type.h:137
@ RUBY_T_COMPLEX
Definition value_type.h:129
@ RUBY_T_STRING
Definition value_type.h:120
@ RUBY_T_HASH
Definition value_type.h:123
@ RUBY_T_NIL
Definition value_type.h:132
@ RUBY_T_CLASS
Definition value_type.h:117
@ RUBY_T_ARRAY
Definition value_type.h:122
@ RUBY_T_MASK
Bitmask of ruby_value_type.
Definition value_type.h:145
@ RUBY_T_RATIONAL
Definition value_type.h:130
@ RUBY_T_ZOMBIE
Definition value_type.h:142
@ RUBY_T_BIGNUM
Definition value_type.h:125
@ RUBY_T_TRUE
Definition value_type.h:133
@ RUBY_T_FLOAT
Definition value_type.h:119
@ RUBY_T_STRUCT
Definition value_type.h:124
@ RUBY_T_NONE
Non-object (swept etc.)
Definition value_type.h:114
@ RUBY_T_REGEXP
Definition value_type.h:121
@ RUBY_T_FILE
Definition value_type.h:126