Ruby 3.5.0dev (2025-04-26 revision e4f85bfc311a3812de7bc2e9d068934e8b364574)
mmtk.h
1#ifndef MMTK_H
2#define MMTK_H
3
4/* Warning, this file is autogenerated by cbindgen from the mmtk-ruby repository. Don't modify this manually. */
5
6#include <stdarg.h>
7#include <stdbool.h>
8#include <stddef.h>
9#include <stdint.h>
10#include <stdlib.h>
11
12typedef struct MMTk_Builder MMTk_Builder;
13typedef struct MMTk_Mutator MMTk_Mutator;
14
15typedef struct MMTk_ractor_cache *MMTk_VMThread;
18typedef void *MMTk_Address;
19typedef void *MMTk_ObjectReference;
20typedef void *MMTk_NullableObjectReference;
21typedef uint32_t MMTk_AllocationSemantics;
22
23
24#define MMTk_OBJREF_OFFSET 8
25
26#define MMTk_MIN_OBJ_ALIGN 8
27
28#define MMTk_GC_THREAD_KIND_WORKER 1
29
31 bool ractor_check_mode;
32 size_t suffix_size;
34
35typedef MMTk_ObjectReference (*MMTk_ObjectClosureFunction)(void*, void*, MMTk_ObjectReference, bool);
36
37typedef struct MMTk_ObjectClosure {
41 MMTk_ObjectClosureFunction c_function;
47
48typedef struct MMTk_GCThreadTLS {
49 int kind;
50 void *gc_context;
51 struct MMTk_ObjectClosure object_closure;
53
54typedef struct MMTk_RubyUpcalls {
55 void (*init_gc_worker_thread)(struct MMTk_GCThreadTLS *gc_worker_tls);
56 bool (*is_mutator)(void);
57 void (*stop_the_world)(void);
58 void (*resume_mutators)(void);
59 void (*block_for_gc)(MMTk_VMMutatorThread tls);
60 size_t (*number_of_mutators)(void);
61 void (*get_mutators)(void (*visit_mutator)(MMTk_Mutator*, void*), void *data);
62 void (*scan_gc_roots)(void);
63 void (*scan_objspace)(void);
64 void (*scan_object_ruby_style)(MMTk_ObjectReference object);
65 void (*call_gc_mark_children)(MMTk_ObjectReference object);
66 void (*call_obj_free)(MMTk_ObjectReference object);
67 size_t (*vm_live_bytes)(void);
68 void (*update_global_tables)(int tbl_idx);
69 int (*global_tables_count)(void);
70 void (*update_finalizer_table)(void);
71 void (*update_obj_id_tables)(void);
73
74typedef struct MMTk_RawVecOfObjRef {
75 MMTk_ObjectReference *ptr;
76 size_t len;
77 size_t capa;
79
80bool mmtk_is_live_object(MMTk_ObjectReference object);
81
82bool mmtk_is_reachable(MMTk_ObjectReference object);
83
84MMTk_Builder *mmtk_builder_default(void);
85
86void mmtk_init_binding(MMTk_Builder *builder,
87 const struct MMTk_RubyBindingOptions *_binding_options,
88 const struct MMTk_RubyUpcalls *upcalls,
89 MMTk_ObjectReference weak_reference_dead_value);
90
91void mmtk_initialize_collection(MMTk_VMThread tls);
92
93MMTk_Mutator *mmtk_bind_mutator(MMTk_VMMutatorThread tls);
94
95void mmtk_destroy_mutator(MMTk_Mutator *mutator);
96
97void mmtk_handle_user_collection_request(MMTk_VMMutatorThread tls, bool force, bool exhaustive);
98
99void mmtk_set_gc_enabled(bool enable);
100
101bool mmtk_gc_enabled_p(void);
102
103MMTk_Address mmtk_alloc(MMTk_Mutator *mutator,
104 size_t size,
105 size_t align,
106 size_t offset,
107 MMTk_AllocationSemantics semantics);
108
109void mmtk_post_alloc(MMTk_Mutator *mutator,
110 MMTk_ObjectReference refer,
111 size_t bytes,
112 MMTk_AllocationSemantics semantics);
113
114void mmtk_add_obj_free_candidate(MMTk_ObjectReference object);
115
116void mmtk_mark_weak(MMTk_ObjectReference *ptr);
117
118void mmtk_remove_weak(const MMTk_ObjectReference *ptr);
119
120void mmtk_object_reference_write_post(MMTk_Mutator *mutator, MMTk_ObjectReference object);
121
122void mmtk_register_wb_unprotected_object(MMTk_ObjectReference object);
123
124bool mmtk_object_wb_unprotected_p(MMTk_ObjectReference object);
125
126void mmtk_enumerate_objects(void (*callback)(MMTk_ObjectReference, void*), void *data);
127
128struct MMTk_RawVecOfObjRef mmtk_get_all_obj_free_candidates(void);
129
130void mmtk_free_raw_vec_of_obj_ref(struct MMTk_RawVecOfObjRef raw_vec);
131
132void mmtk_before_fork(void);
133
134void mmtk_after_fork(MMTk_VMThread tls);
135
136size_t mmtk_total_bytes(void);
137
138size_t mmtk_used_bytes(void);
139
140size_t mmtk_free_bytes(void);
141
142MMTk_Address mmtk_starting_heap_address(void);
143
144MMTk_Address mmtk_last_heap_address(void);
145
146size_t mmtk_worker_count(void);
147
148const uint8_t *mmtk_plan(void);
149
150const uint8_t *mmtk_heap_mode(void);
151
152size_t mmtk_heap_min(void);
153
154size_t mmtk_heap_max(void);
155
156bool mmtk_is_mmtk_object(MMTk_Address addr);
157
158#endif /* MMTK_H */
Defines old _.
C99 shim for <stdbool.h>
void * rust_closure
The pointer to the Rust-level closure object.
Definition mmtk.h:45
MMTk_ObjectClosureFunction c_function
The function to be called from C.
Definition mmtk.h:41