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 #else
10 NOINLINE(void rb_gc_set_stack_end(VALUE **stack_end_p));
11 #define SET_MACHINE_STACK_END(p) rb_gc_set_stack_end(p)
12 #define USE_CONSERVATIVE_STACK_END
13 #endif
14 
15 /* for GC debug */
16 
17 #ifndef RUBY_MARK_FREE_DEBUG
18 #define RUBY_MARK_FREE_DEBUG 0
19 #endif
20 
21 #if RUBY_MARK_FREE_DEBUG
22 extern int ruby_gc_debug_indent;
23 
24 static inline void
rb_gc_debug_indent(void)25 rb_gc_debug_indent(void)
26 {
27     printf("%*s", ruby_gc_debug_indent, "");
28 }
29 
30 static inline void
rb_gc_debug_body(const char * mode,const char * msg,int st,void * ptr)31 rb_gc_debug_body(const char *mode, const char *msg, int st, void *ptr)
32 {
33     if (st == 0) {
34 	ruby_gc_debug_indent--;
35     }
36     rb_gc_debug_indent();
37     printf("%s: %s %s (%p)\n", mode, st ? "->" : "<-", msg, ptr);
38 
39     if (st) {
40 	ruby_gc_debug_indent++;
41     }
42 
43     fflush(stdout);
44 }
45 
46 #define RUBY_MARK_ENTER(msg) rb_gc_debug_body("mark", (msg), 1, ptr)
47 #define RUBY_MARK_LEAVE(msg) rb_gc_debug_body("mark", (msg), 0, ptr)
48 #define RUBY_FREE_ENTER(msg) rb_gc_debug_body("free", (msg), 1, ptr)
49 #define RUBY_FREE_LEAVE(msg) rb_gc_debug_body("free", (msg), 0, ptr)
50 #define RUBY_GC_INFO         rb_gc_debug_indent(); printf
51 
52 #else
53 #define RUBY_MARK_ENTER(msg)
54 #define RUBY_MARK_LEAVE(msg)
55 #define RUBY_FREE_ENTER(msg)
56 #define RUBY_FREE_LEAVE(msg)
57 #define RUBY_GC_INFO if(0)printf
58 #endif
59 
60 #define RUBY_MARK_UNLESS_NULL(ptr) do { \
61     VALUE markobj = (ptr); \
62     if (RTEST(markobj)) {rb_gc_mark(markobj);} \
63 } while (0)
64 #define RUBY_FREE_UNLESS_NULL(ptr) if(ptr){ruby_xfree(ptr);(ptr)=NULL;}
65 
66 #if STACK_GROW_DIRECTION > 0
67 # define STACK_UPPER(x, a, b) (a)
68 #elif STACK_GROW_DIRECTION < 0
69 # define STACK_UPPER(x, a, b) (b)
70 #else
71 RUBY_EXTERN int ruby_stack_grow_direction;
72 int ruby_get_stack_grow_direction(volatile VALUE *addr);
73 # define stack_growup_p(x) (			\
74 	(ruby_stack_grow_direction ?		\
75 	 ruby_stack_grow_direction :		\
76 	 ruby_get_stack_grow_direction(x)) > 0)
77 # define STACK_UPPER(x, a, b) (stack_growup_p(x) ? (a) : (b))
78 #endif
79 
80 #if STACK_GROW_DIRECTION
81 #define STACK_GROW_DIR_DETECTION
82 #define STACK_DIR_UPPER(a,b) STACK_UPPER(0, (a), (b))
83 #else
84 #define STACK_GROW_DIR_DETECTION VALUE stack_grow_dir_detection
85 #define STACK_DIR_UPPER(a,b) STACK_UPPER(&stack_grow_dir_detection, (a), (b))
86 #endif
87 #define IS_STACK_DIR_UPPER() STACK_DIR_UPPER(1,0)
88 
89 const char *rb_obj_info(VALUE obj);
90 const char *rb_raw_obj_info(char *buff, const int buff_size, VALUE obj);
91 void rb_obj_info_dump(VALUE obj);
92 
93 struct rb_thread_struct;
94 
95 RUBY_SYMBOL_EXPORT_BEGIN
96 
97 /* exports for objspace module */
98 size_t rb_objspace_data_type_memsize(VALUE obj);
99 void rb_objspace_reachable_objects_from(VALUE obj, void (func)(VALUE, void *), void *data);
100 void rb_objspace_reachable_objects_from_root(void (func)(const char *category, VALUE, void *), void *data);
101 int rb_objspace_markable_object_p(VALUE obj);
102 int rb_objspace_internal_object_p(VALUE obj);
103 int rb_objspace_marked_object_p(VALUE obj);
104 int rb_objspace_garbage_object_p(VALUE obj);
105 
106 void rb_objspace_each_objects(
107     int (*callback)(void *start, void *end, size_t stride, void *data),
108     void *data);
109 
110 void rb_objspace_each_objects_without_setup(
111     int (*callback)(void *, void *, size_t, void *),
112     void *data);
113 
114 RUBY_SYMBOL_EXPORT_END
115 
116 #endif /* RUBY_GC_H */
117