Ruby  3.4.0dev (2024-12-06 revision 892c46283a5ea4179500d951c9d4866c0051f27b)
ractor_core.h (892c46283a5ea4179500d951c9d4866c0051f27b)
1 #include "internal/gc.h"
2 #include "ruby/ruby.h"
3 #include "ruby/ractor.h"
4 #include "vm_core.h"
5 #include "id_table.h"
6 #include "vm_debug.h"
7 
8 #ifndef RACTOR_CHECK_MODE
9 #define RACTOR_CHECK_MODE (VM_CHECK_MODE || RUBY_DEBUG) && (SIZEOF_UINT64_T == SIZEOF_VALUE)
10 #endif
11 
12 enum rb_ractor_basket_type {
13  // basket is empty
14  basket_type_none,
15 
16  // value is available
17  basket_type_ref,
18  basket_type_copy,
19  basket_type_move,
20  basket_type_will,
21 
22  // basket should be deleted
23  basket_type_deleted,
24 
25  // basket is reserved
26  basket_type_reserved,
27 
28  // take_basket is available
29  basket_type_take_basket,
30 
31  // basket is keeping by yielding ractor
32  basket_type_yielding,
33 };
34 
35 // per ractor taking configuration
37  bool closed;
38  bool oneshot;
39 };
40 
42  union {
43  enum rb_ractor_basket_type e;
44  rb_atomic_t atomic;
45  } type;
46  VALUE sender;
47 
48  union {
49  struct {
50  VALUE v;
51  bool exception;
52  } send;
53 
54  struct {
55  struct rb_ractor_basket *basket;
56  struct rb_ractor_selector_take_config *config;
57  } take;
58  } p; // payload
59 };
60 
61 static inline bool
62 basket_type_p(struct rb_ractor_basket *b, enum rb_ractor_basket_type type)
63 {
64  return b->type.e == type;
65 }
66 
67 static inline bool
68 basket_none_p(struct rb_ractor_basket *b)
69 {
70  return basket_type_p(b, basket_type_none);
71 }
72 
74  struct rb_ractor_basket *baskets;
75  int start;
76  int cnt;
77  int size;
78  unsigned int serial;
79  unsigned int reserved_cnt;
80 };
81 
82 enum rb_ractor_wait_status {
83  wait_none = 0x00,
84  wait_receiving = 0x01,
85  wait_taking = 0x02,
86  wait_yielding = 0x04,
87  wait_moving = 0x08,
88 };
89 
90 enum rb_ractor_wakeup_status {
91  wakeup_none,
92  wakeup_by_send,
93  wakeup_by_yield,
94  wakeup_by_take,
95  wakeup_by_close,
96  wakeup_by_interrupt,
97  wakeup_by_retry,
98 };
99 
101  // ractor lock
102  rb_nativethread_lock_t lock;
103 #if RACTOR_CHECK_MODE > 0
104  VALUE locked_by;
105 #endif
106 
107  bool incoming_port_closed;
108  bool outgoing_port_closed;
109 
110  // All sent messages will be pushed into recv_queue
111  struct rb_ractor_queue recv_queue;
112 
113  // The following ractors waiting for the yielding by this ractor
114  struct rb_ractor_queue takers_queue;
115 
116  // Enabled if the ractor already terminated and not taken yet.
117  struct rb_ractor_basket will_basket;
118 
119  struct ractor_wait {
120  enum rb_ractor_wait_status status;
121  enum rb_ractor_wakeup_status wakeup_status;
122  rb_thread_t *waiting_thread;
123  } wait;
124 
125 #ifndef RUBY_THREAD_PTHREAD_H
126  rb_nativethread_cond_t cond;
127 #endif
128 };
129 
130 // created
131 // | ready to run
132 // ====================== inserted to vm->ractor
133 // v
134 // blocking <---+ all threads are blocking
135 // | |
136 // v |
137 // running -----+
138 // | all threads are terminated.
139 // ====================== removed from vm->ractor
140 // v
141 // terminated
142 //
143 // status is protected by VM lock (global state)
144 enum ractor_status {
145  ractor_created,
146  ractor_running,
147  ractor_blocking,
148  ractor_terminated,
149 };
150 
152  struct rb_ractor_pub pub;
153 
154  struct rb_ractor_sync sync;
155  VALUE receiving_mutex;
156 
157  // vm wide barrier synchronization
158  rb_nativethread_cond_t barrier_wait_cond;
159 
160  // thread management
161  struct {
162  struct ccan_list_head set;
163  unsigned int cnt;
164  unsigned int blocking_cnt;
165  unsigned int sleeper;
166  struct rb_thread_sched sched;
167  rb_execution_context_t *running_ec;
168  rb_thread_t *main;
169  } threads;
170  VALUE thgroup_default;
171 
172  VALUE name;
173  VALUE loc;
174 
175  enum ractor_status status_;
176 
177  struct ccan_list_node vmlr_node;
178 
179  // ractor local data
180 
181  st_table *local_storage;
182  struct rb_id_table *idkey_local_storage;
183 
184  VALUE r_stdin;
185  VALUE r_stdout;
186  VALUE r_stderr;
187  VALUE verbose;
188  VALUE debug;
189 
190  void *newobj_cache;
191 }; // rb_ractor_t is defined in vm_core.h
192 
193 
194 static inline VALUE
195 rb_ractor_self(const rb_ractor_t *r)
196 {
197  return r->pub.self;
198 }
199 
200 rb_ractor_t *rb_ractor_main_alloc(void);
201 void rb_ractor_main_setup(rb_vm_t *vm, rb_ractor_t *main_ractor, rb_thread_t *main_thread);
202 void rb_ractor_atexit(rb_execution_context_t *ec, VALUE result);
203 void rb_ractor_atexit_exception(rb_execution_context_t *ec);
204 void rb_ractor_teardown(rb_execution_context_t *ec);
205 void rb_ractor_receive_parameters(rb_execution_context_t *ec, rb_ractor_t *g, int len, VALUE *ptr);
206 void rb_ractor_send_parameters(rb_execution_context_t *ec, rb_ractor_t *g, VALUE args);
207 
208 VALUE rb_thread_create_ractor(rb_ractor_t *g, VALUE args, VALUE proc); // defined in thread.c
209 
210 int rb_ractor_living_thread_num(const rb_ractor_t *);
211 VALUE rb_ractor_thread_list(void);
212 bool rb_ractor_p(VALUE rv);
213 
214 void rb_ractor_living_threads_init(rb_ractor_t *r);
215 void rb_ractor_living_threads_insert(rb_ractor_t *r, rb_thread_t *th);
216 void rb_ractor_living_threads_remove(rb_ractor_t *r, rb_thread_t *th);
217 void rb_ractor_blocking_threads_inc(rb_ractor_t *r, const char *file, int line); // TODO: file, line only for RUBY_DEBUG_LOG
218 void rb_ractor_blocking_threads_dec(rb_ractor_t *r, const char *file, int line); // TODO: file, line only for RUBY_DEBUG_LOG
219 
220 void rb_ractor_vm_barrier_interrupt_running_thread(rb_ractor_t *r);
221 void rb_ractor_terminate_interrupt_main_thread(rb_ractor_t *r);
222 void rb_ractor_terminate_all(void);
223 bool rb_ractor_main_p_(void);
224 void rb_ractor_atfork(rb_vm_t *vm, rb_thread_t *th);
225 VALUE rb_ractor_require(VALUE feature);
226 VALUE rb_ractor_autoload_load(VALUE space, ID id);
227 
228 VALUE rb_ractor_ensure_shareable(VALUE obj, VALUE name);
229 
230 RUBY_SYMBOL_EXPORT_BEGIN
231 void rb_ractor_finish_marking(void);
232 
233 bool rb_ractor_shareable_p_continue(VALUE obj);
234 
235 // THIS FUNCTION SHOULD NOT CALL WHILE INCREMENTAL MARKING!!
236 // This function is for T_DATA::free_func
237 void rb_ractor_local_storage_delkey(rb_ractor_local_key_t key);
238 
239 RUBY_SYMBOL_EXPORT_END
240 
241 static inline bool
242 rb_ractor_main_p(void)
243 {
244  if (ruby_single_main_ractor) {
245  return true;
246  }
247  else {
248  return rb_ractor_main_p_();
249  }
250 }
251 
252 static inline bool
253 rb_ractor_status_p(rb_ractor_t *r, enum ractor_status status)
254 {
255  return r->status_ == status;
256 }
257 
258 static inline void
259 rb_ractor_sleeper_threads_inc(rb_ractor_t *r)
260 {
261  r->threads.sleeper++;
262 }
263 
264 static inline void
265 rb_ractor_sleeper_threads_dec(rb_ractor_t *r)
266 {
267  r->threads.sleeper--;
268 }
269 
270 static inline void
271 rb_ractor_sleeper_threads_clear(rb_ractor_t *r)
272 {
273  r->threads.sleeper = 0;
274 }
275 
276 static inline int
277 rb_ractor_sleeper_thread_num(rb_ractor_t *r)
278 {
279  return r->threads.sleeper;
280 }
281 
282 static inline void
283 rb_ractor_thread_switch(rb_ractor_t *cr, rb_thread_t *th)
284 {
285  RUBY_DEBUG_LOG("th:%d->%u%s",
286  cr->threads.running_ec ? (int)rb_th_serial(cr->threads.running_ec->thread_ptr) : -1,
287  rb_th_serial(th), cr->threads.running_ec == th->ec ? " (same)" : "");
288 
289  if (cr->threads.running_ec != th->ec) {
290  if (0) {
291  ruby_debug_printf("rb_ractor_thread_switch ec:%p->%p\n",
292  (void *)cr->threads.running_ec, (void *)th->ec);
293  }
294  }
295  else {
296  return;
297  }
298 
299  if (cr->threads.running_ec != th->ec) {
300  th->running_time_us = 0;
301  }
302 
303  cr->threads.running_ec = th->ec;
304 
305  VM_ASSERT(cr == GET_RACTOR());
306 }
307 
308 #define rb_ractor_set_current_ec(cr, ec) rb_ractor_set_current_ec_(cr, ec, __FILE__, __LINE__)
309 #ifdef RB_THREAD_LOCAL_SPECIFIER
310 void rb_current_ec_set(rb_execution_context_t *ec);
311 #endif
312 
313 static inline void
314 rb_ractor_set_current_ec_(rb_ractor_t *cr, rb_execution_context_t *ec, const char *file, int line)
315 {
316 #ifdef RB_THREAD_LOCAL_SPECIFIER
317  rb_current_ec_set(ec);
318 #else
319  native_tls_set(ruby_current_ec_key, ec);
320 #endif
321  RUBY_DEBUG_LOG2(file, line, "ec:%p->%p", (void *)cr->threads.running_ec, (void *)ec);
322  VM_ASSERT(ec == NULL || cr->threads.running_ec != ec);
323  cr->threads.running_ec = ec;
324 }
325 
326 void rb_vm_ractor_blocking_cnt_inc(rb_vm_t *vm, rb_ractor_t *cr, const char *file, int line);
327 void rb_vm_ractor_blocking_cnt_dec(rb_vm_t *vm, rb_ractor_t *cr, const char *file, int line);
328 
329 static inline uint32_t
330 rb_ractor_id(const rb_ractor_t *r)
331 {
332  return r->pub.id;
333 }
334 
335 #if RACTOR_CHECK_MODE > 0
336 # define RACTOR_BELONGING_ID(obj) (*(uint32_t *)(((uintptr_t)(obj)) + rb_gc_obj_slot_size(obj)))
337 
338 uint32_t rb_ractor_current_id(void);
339 
340 static inline void
341 rb_ractor_setup_belonging_to(VALUE obj, uint32_t rid)
342 {
343  RACTOR_BELONGING_ID(obj) = rid;
344 }
345 
346 static inline uint32_t
347 rb_ractor_belonging(VALUE obj)
348 {
349  if (SPECIAL_CONST_P(obj) || RB_OBJ_SHAREABLE_P(obj)) {
350  return 0;
351  }
352  else {
353  return RACTOR_BELONGING_ID(obj);
354  }
355 }
356 
357 static inline VALUE
358 rb_ractor_confirm_belonging(VALUE obj)
359 {
360  uint32_t id = rb_ractor_belonging(obj);
361 
362  if (id == 0) {
363  if (UNLIKELY(!rb_ractor_shareable_p(obj))) {
364  rp(obj);
365  rb_bug("id == 0 but not shareable");
366  }
367  }
368  else if (UNLIKELY(id != rb_ractor_current_id())) {
369  if (rb_ractor_shareable_p(obj)) {
370  // ok
371  }
372  else {
373  rp(obj);
374  rb_bug("rb_ractor_confirm_belonging object-ractor id:%u, current-ractor id:%u", id, rb_ractor_current_id());
375  }
376  }
377  return obj;
378 }
379 #else
380 #define rb_ractor_confirm_belonging(obj) obj
381 #endif
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
Definition: atomic.h:69
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
void rb_bug(const char *fmt,...)
Interpreter panic switch.
Definition: error.c:1089
char * ptr
Pointer to the underlying memory region, of at least capa bytes.
Definition: io.h:2
int len
Length of the buffer.
Definition: io.h:8
static bool rb_ractor_shareable_p(VALUE obj)
Queries if multiple Ractors can share the passed object or not.
Definition: ractor.h:249
#define RB_OBJ_SHAREABLE_P(obj)
Queries if the passed object has previously classified as shareable or not.
Definition: ractor.h:235
VALUE type(ANYARGS)
ANYARGS-ed function type.
Definition: cxxanyargs.hpp:56
Definition: st.h:79
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