Ruby 2.7.7p221 (2022-11-24 revision 168ec2b1e5ad0e4688e963d9de019557c78feed9)
gc.h
Go to the documentation of this file.
1
2#ifndef RUBY_GC_H
3#define RUBY_GC_H 1
4
5#if defined(__x86_64__) && !defined(_ILP32) && defined(__GNUC__)
6#define SET_MACHINE_STACK_END(p) __asm__ __volatile__ ("movq\t%%rsp, %0" : "=r" (*(p)))
7#elif defined(__i386) && defined(__GNUC__)
8#define SET_MACHINE_STACK_END(p) __asm__ __volatile__ ("movl\t%%esp, %0" : "=r" (*(p)))
9#elif defined(__powerpc64__) && defined(__GNUC__)
10#define SET_MACHINE_STACK_END(p) __asm__ __volatile__ ("mr\t%0, %%r1" : "=r" (*(p)))
11#elif defined(__aarch64__) && defined(__GNUC__)
12#define SET_MACHINE_STACK_END(p) __asm__ __volatile__ ("mov\t%0, sp" : "=r" (*(p)))
13#else
14NOINLINE(void rb_gc_set_stack_end(VALUE **stack_end_p));
15#define SET_MACHINE_STACK_END(p) rb_gc_set_stack_end(p)
16#define USE_CONSERVATIVE_STACK_END
17#endif
18
19/* for GC debug */
20
21#ifndef RUBY_MARK_FREE_DEBUG
22#define RUBY_MARK_FREE_DEBUG 0
23#endif
24
25#if RUBY_MARK_FREE_DEBUG
26extern int ruby_gc_debug_indent;
27
28static inline void
29rb_gc_debug_indent(void)
30{
31 printf("%*s", ruby_gc_debug_indent, "");
32}
33
34static inline void
35rb_gc_debug_body(const char *mode, const char *msg, int st, void *ptr)
36{
37 if (st == 0) {
38 ruby_gc_debug_indent--;
39 }
40 rb_gc_debug_indent();
41 printf("%s: %s %s (%p)\n", mode, st ? "->" : "<-", msg, ptr);
42
43 if (st) {
44 ruby_gc_debug_indent++;
45 }
46
48}
49
50#define RUBY_MARK_ENTER(msg) rb_gc_debug_body("mark", (msg), 1, ptr)
51#define RUBY_MARK_LEAVE(msg) rb_gc_debug_body("mark", (msg), 0, ptr)
52#define RUBY_FREE_ENTER(msg) rb_gc_debug_body("free", (msg), 1, ptr)
53#define RUBY_FREE_LEAVE(msg) rb_gc_debug_body("free", (msg), 0, ptr)
54#define RUBY_GC_INFO rb_gc_debug_indent(); printf
55
56#else
57#define RUBY_MARK_ENTER(msg)
58#define RUBY_MARK_LEAVE(msg)
59#define RUBY_FREE_ENTER(msg)
60#define RUBY_FREE_LEAVE(msg)
61#define RUBY_GC_INFO if(0)printf
62#endif
63
64#define RUBY_MARK_NO_PIN_UNLESS_NULL(ptr) do { \
65 VALUE markobj = (ptr); \
66 if (RTEST(markobj)) {rb_gc_mark_movable(markobj);} \
67} while (0)
68#define RUBY_MARK_UNLESS_NULL(ptr) do { \
69 VALUE markobj = (ptr); \
70 if (RTEST(markobj)) {rb_gc_mark(markobj);} \
71} while (0)
72#define RUBY_FREE_UNLESS_NULL(ptr) if(ptr){ruby_xfree(ptr);(ptr)=NULL;}
73
74#if STACK_GROW_DIRECTION > 0
75# define STACK_UPPER(x, a, b) (a)
76#elif STACK_GROW_DIRECTION < 0
77# define STACK_UPPER(x, a, b) (b)
78#else
80int ruby_get_stack_grow_direction(volatile VALUE *addr);
81# define stack_growup_p(x) ( \
82 (ruby_stack_grow_direction ? \
83 ruby_stack_grow_direction : \
84 ruby_get_stack_grow_direction(x)) > 0)
85# define STACK_UPPER(x, a, b) (stack_growup_p(x) ? (a) : (b))
86#endif
87
88/*
89 STACK_GROW_DIR_DETECTION is used with STACK_DIR_UPPER.
90
91 On most normal systems, stacks grow from high address to lower address. In
92 this case, STACK_DIR_UPPER(a, b) will return (b), but on exotic systems where
93 the stack grows UP (from low address to high address), it will return (a).
94*/
95
96#if STACK_GROW_DIRECTION
97#define STACK_GROW_DIR_DETECTION
98#define STACK_DIR_UPPER(a,b) STACK_UPPER(0, (a), (b))
99#else
100#define STACK_GROW_DIR_DETECTION VALUE stack_grow_dir_detection
101#define STACK_DIR_UPPER(a,b) STACK_UPPER(&stack_grow_dir_detection, (a), (b))
102#endif
103#define IS_STACK_DIR_UPPER() STACK_DIR_UPPER(1,0)
104
105const char *rb_obj_info(VALUE obj);
106const char *rb_raw_obj_info(char *buff, const int buff_size, VALUE obj);
107
109
110struct rb_thread_struct;
111
113
114/* exports for objspace module */
116void rb_objspace_reachable_objects_from(VALUE obj, void (func)(VALUE, void *), void *data);
117void rb_objspace_reachable_objects_from_root(void (func)(const char *category, VALUE, void *), void *data);
122
124 int (*callback)(void *start, void *end, size_t stride, void *data),
125 void *data);
126
128 int (*callback)(void *, void *, size_t, void *),
129 void *data);
130
132
133#endif /* RUBY_GC_H */
struct RIMemo * ptr
Definition: debug.c:65
int rb_objspace_internal_object_p(VALUE obj)
Definition: gc.c:3110
void rb_objspace_each_objects(int(*callback)(void *start, void *end, size_t stride, void *data), void *data)
void rb_objspace_reachable_objects_from_root(void(func)(const char *category, VALUE, void *), void *data)
Definition: gc.c:9509
int rb_objspace_garbage_object_p(VALUE obj)
Definition: gc.c:3620
NOINLINE(void rb_gc_set_stack_end(VALUE **stack_end_p))
const char * rb_raw_obj_info(char *buff, const int buff_size, VALUE obj)
Definition: gc.c:11477
void rb_objspace_each_objects_without_setup(int(*callback)(void *, void *, size_t, void *), void *data)
int rb_objspace_marked_object_p(VALUE obj)
Definition: gc.c:5238
RUBY_EXTERN int ruby_stack_grow_direction
Definition: gc.h:79
void rb_objspace_reachable_objects_from(VALUE obj, void(func)(VALUE, void *), void *data)
Definition: gc.c:9481
int ruby_get_stack_grow_direction(volatile VALUE *addr)
Definition: gc.c:4636
int rb_objspace_markable_object_p(VALUE obj)
Definition: gc.c:3613
RUBY_SYMBOL_EXPORT_BEGIN size_t rb_objspace_data_type_memsize(VALUE obj)
Definition: gc.c:2432
const char * rb_obj_info(VALUE obj)
Definition: gc.c:11713
VALUE rb_gc_disable_no_rest(void)
Definition: gc.c:9247
#define stdout
enum ruby_tag_type st
const VALUE VALUE obj
int int int printf(const char *__restrict__,...) __attribute__((__format__(__printf__
#define RUBY_SYMBOL_EXPORT_BEGIN
#define RUBY_SYMBOL_EXPORT_END
#define RUBY_EXTERN
int fflush(FILE *)
unsigned long VALUE
Definition: ruby.h:102
void rb_gc_set_stack_end(VALUE **stack_end_p)
Definition: thread.c:4305