1#ifndef RUBY_RACTOR_CORE_H
2#define RUBY_RACTOR_CORE_H
3#include "internal/gc.h"
4#include "internal/sanitizers.h"
12#ifndef RACTOR_CHECK_MODE
13#define RACTOR_CHECK_MODE (VM_CHECK_MODE || RUBY_DEBUG) && (SIZEOF_UINT64_T == SIZEOF_VALUE)
19#ifndef RB_GC_REGISTERED_ADDR_CHECK
20# if RUBY_DEBUG || defined(RUBY_ASAN_ENABLED)
21# define RB_GC_REGISTERED_ADDR_CHECK 1
23# define RB_GC_REGISTERED_ADDR_CHECK 0
28#define RUBY_TYPED_FROZEN_SHAREABLE_NO_REC RUBY_FL_FINALIZE
35 rb_nativethread_lock_t lock;
37#if RACTOR_CHECK_MODE > 0
45 struct ccan_list_head waiters;
48 VALUE default_port_value;
60 struct ccan_list_head off_queue_baskets;
63 struct ccan_list_head monitors;
66 rb_ractor_t *successor;
97#if RB_GC_REGISTERED_ADDR_CHECK
110 VALUE *registered_marks;
111 size_t registered_marks_cnt, registered_marks_capa;
114 size_t registered_addrs_cnt, registered_addrs_capa;
115 bool registered_addrs_listed;
124 struct ccan_list_head set;
126 unsigned int blocking_cnt;
127 unsigned int sleeper;
129 rb_execution_context_t *running_ec;
133 rb_thread_t *dying_th;
149 VALUE thgroup_default;
154 enum ractor_status status_;
156 struct ccan_list_node vmlr_node;
157 bool in_terminated_set;
165 rb_serial_t next_ec_serial;
169 VALUE local_storage_store_lock;
180 bool malloc_gc_disabled;
193 void *creating_child_objspace;
198struct rb_gc_mark_ctx;
199void rb_ractor_mark_local_roots(
const struct rb_gc_mark_ctx *ctx, rb_ractor_t *r);
200void rb_ractor_mark_shareable_p_inflight(
const struct rb_gc_mark_ctx *ctx);
201void rb_ractor_mark_terminated_join_value(rb_ractor_t *r);
202void rb_ractor_reap_dead_ports(rb_ractor_t *r);
207void rb_ractor_absorb_registered_marks(rb_ractor_t *dst, rb_ractor_t *src);
209void rb_ractor_absorb_registered_addrs_without_gc(rb_ractor_t *dst, rb_ractor_t *src);
211enum ractor_wakeup_status {
219 enum ractor_wakeup_status wakeup_status;
221 struct ccan_list_node node;
225 const rb_hrtime_t *end;
229rb_ractor_self(
const rb_ractor_t *r)
234rb_ractor_t *rb_ractor_main_alloc(
void);
235void rb_ractor_main_setup(rb_vm_t *vm, rb_ractor_t *main_ractor, rb_thread_t *main_thread);
236void rb_ractor_atexit(rb_execution_context_t *ec,
VALUE result);
237void rb_ractor_atexit_exception(rb_execution_context_t *ec);
238void rb_ractor_teardown(rb_execution_context_t *ec);
239void rb_ractor_receive_parameters(rb_execution_context_t *ec, rb_ractor_t *g,
int len,
VALUE *ptr);
240void rb_ractor_send_parameters(rb_execution_context_t *ec, rb_ractor_t *g,
VALUE args);
241void rb_ractor_setup_default_port(rb_ractor_t *r);
245int rb_ractor_living_thread_num(
const rb_ractor_t *);
246VALUE rb_ractor_thread_list(
void);
247bool rb_ractor_p(
VALUE rv);
249void rb_ractor_living_threads_init(rb_ractor_t *r);
250void rb_ractor_living_threads_insert(rb_ractor_t *r, rb_thread_t *th);
251void rb_ractor_living_threads_remove(rb_ractor_t *r, rb_thread_t *th);
261void rb_ractor_cancel_creation(rb_ractor_t *r, rb_thread_t *th);
262void rb_ractor_blocking_threads_inc(rb_ractor_t *r,
const char *file,
int line);
263void rb_ractor_blocking_threads_dec(rb_ractor_t *r,
const char *file,
int line);
265void rb_ractor_vm_barrier_interrupt_running_thread(rb_ractor_t *r);
266void rb_ractor_terminate_interrupt_main_thread(rb_ractor_t *r);
267void rb_ractor_terminate_all(
void);
268bool rb_ractor_main_p_(
void);
269void rb_ractor_atfork(rb_vm_t *vm, rb_thread_t *th);
270void rb_ractor_terminate_atfork(rb_vm_t *vm, rb_ractor_t *th);
271VALUE rb_ractor_require(
VALUE feature,
bool silent);
275st_table *rb_ractor_targeted_hooks(rb_ractor_t *cr);
277RUBY_SYMBOL_EXPORT_BEGIN
278void rb_ractor_finish_marking(
bool full_mark);
280bool rb_ractor_shareable_p_continue(
VALUE obj);
286RUBY_SYMBOL_EXPORT_END
289rb_ractor_main_p(
void)
291 if (ruby_single_main_ractor) {
295 return rb_ractor_main_p_();
300rb_ractor_status_p(rb_ractor_t *r,
enum ractor_status status)
302 return r->status_ == status;
306rb_ractor_sleeper_threads_inc(rb_ractor_t *r)
308 r->threads.sleeper++;
312rb_ractor_sleeper_threads_dec(rb_ractor_t *r)
314 r->threads.sleeper--;
318rb_ractor_sleeper_threads_clear(rb_ractor_t *r)
320 r->threads.sleeper = 0;
324rb_ractor_sleeper_thread_num(rb_ractor_t *r)
326 return r->threads.sleeper;
330rb_ractor_thread_switch(rb_ractor_t *cr, rb_thread_t *th,
bool always_reset)
332 RUBY_DEBUG_LOG(
"th:%d->%u%s",
333 cr->threads.running_ec ? (
int)rb_th_serial(cr->threads.running_ec->thread_ptr) : -1,
334 rb_th_serial(th), cr->threads.running_ec == th->ec ?
" (same)" :
"");
336 if (cr->threads.running_ec != th->ec || always_reset) {
337 th->running_time_us = 0;
340 if (cr->threads.running_ec != th->ec) {
342 ruby_debug_printf(
"rb_ractor_thread_switch ec:%p->%p\n",
343 (
void *)cr->threads.running_ec, (
void *)th->ec);
352 RUBY_VM_SET_POSTPONED_JOB_INTERRUPT(th->ec);
355 VM_ASSERT(cr == GET_RACTOR());
358#define rb_ractor_set_current_ec(cr, ec) rb_ractor_set_current_ec_(cr, ec, __FILE__, __LINE__)
359#ifdef RB_THREAD_LOCAL_SPECIFIER
360void rb_current_ec_set(rb_execution_context_t *ec);
364rb_ractor_set_current_ec_(rb_ractor_t *cr, rb_execution_context_t *ec,
const char *file,
int line)
366#ifdef RB_THREAD_LOCAL_SPECIFIER
367 rb_current_ec_set(ec);
369 native_tls_set(ruby_current_ec_key, ec);
371 RUBY_DEBUG_LOG2(file, line,
"ec:%p->%p", (
void *)cr->threads.running_ec, (
void *)ec);
372 VM_ASSERT(ec == NULL || cr->threads.running_ec != ec);
376void rb_vm_ractor_blocking_cnt_inc(rb_vm_t *vm, rb_ractor_t *cr,
const char *file,
int line);
377void rb_vm_ractor_blocking_cnt_dec(rb_vm_t *vm, rb_ractor_t *cr,
const char *file,
int line);
379static inline rb_serial_t
380rb_ractor_id(
const rb_ractor_t *r)
386rb_ractor_targeted_hooks_incr(rb_ractor_t *cr)
388 cr->pub.targeted_hooks_cnt++;
392rb_ractor_targeted_hooks_decr(rb_ractor_t *cr)
395 cr->pub.targeted_hooks_cnt--;
398static inline unsigned int
399rb_ractor_targeted_hooks_cnt(rb_ractor_t *cr)
401 return cr->pub.targeted_hooks_cnt;
404#if RACTOR_CHECK_MODE > 0
406extern bool rb_ractor_ignore_belonging_flag;
412rb_ractor_confirm_belonging(
VALUE obj)
414 if (rb_ractor_ignore_belonging_flag)
return obj;
417 if (UNLIKELY(rb_gc_obj_foreign_p(obj))) {
419 rb_bug(
"rb_ractor_confirm_belonging: unshareable object of another Ractor's objspace");
425rb_ractor_ignore_belonging(
bool flag)
427 rb_ractor_ignore_belonging_flag = flag;
431#define rb_ractor_confirm_belonging(obj) obj
432#define rb_ractor_ignore_belonging(flag) (0)
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define RUBY_ATOMIC_LOAD(var)
Atomic load.
#define RUBY_ATOMIC_PTR_SET(var, val)
Identical to RUBY_ATOMIC_SET, except it expects its arguments are void*.
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
int len
Length of the buffer.
struct rb_ractor_local_key_struct * rb_ractor_local_key_t
(Opaque) struct that holds a ractor-local storage key.
#define RB_OBJ_SHAREABLE_P(obj)
Queries if the passed object has previously classified as shareable or not.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.