61#undef __USE_FORTIFY_LEVEL
62#define __USE_FORTIFY_LEVEL 0
66#include "ruby/internal/config.h"
73#define TH_SCHED(th) (&(th)->ractor->threads.sched)
75#include "eval_intern.h"
78#include "internal/class.h"
79#include "internal/cont.h"
80#include "internal/error.h"
81#include "internal/eval.h"
82#include "internal/gc.h"
83#include "internal/hash.h"
84#include "internal/io.h"
85#include "internal/object.h"
86#include "internal/proc.h"
88#include "internal/signal.h"
89#include "internal/thread.h"
90#include "internal/time.h"
91#include "internal/warnings.h"
99#include "ractor_core.h"
103#include "ccan/list/list.h"
105#ifndef USE_NATIVE_THREAD_PRIORITY
106#define USE_NATIVE_THREAD_PRIORITY 0
107#define RUBY_THREAD_PRIORITY_MAX 3
108#define RUBY_THREAD_PRIORITY_MIN -3
111static VALUE rb_cThreadShield;
112static VALUE cThGroup;
114static VALUE sym_immediate;
115static VALUE sym_on_blocking;
116static VALUE sym_never;
118static uint32_t thread_default_quantum_ms = 100;
120#define THREAD_LOCAL_STORAGE_INITIALISED FL_USER13
121#define THREAD_LOCAL_STORAGE_INITIALISED_P(th) RB_FL_TEST_RAW((th), THREAD_LOCAL_STORAGE_INITIALISED)
124rb_thread_local_storage(
VALUE thread)
126 if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) {
134 SLEEP_DEADLOCKABLE = 0x01,
135 SLEEP_SPURIOUS_CHECK = 0x02,
136 SLEEP_ALLOW_SPURIOUS = 0x04,
137 SLEEP_NO_CHECKINTS = 0x08,
140static void sleep_forever(
rb_thread_t *th,
unsigned int fl);
141static int sleep_hrtime(
rb_thread_t *, rb_hrtime_t,
unsigned int fl);
143static void rb_thread_sleep_deadly_allow_spurious_wakeup(
VALUE blocker,
VALUE timeout, rb_hrtime_t end);
146static int rb_threadptr_pending_interrupt_empty_p(
const rb_thread_t *th);
147static const char *thread_status_name(
rb_thread_t *th,
int detail);
148static int hrtime_update_expire(rb_hrtime_t *,
const rb_hrtime_t);
149NORETURN(
static void async_bug_fd(
const char *mesg,
int errno_arg,
int fd));
150MAYBE_UNUSED(
static int consume_communication_pipe(
int fd));
153static rb_internal_thread_specific_key_t specific_key_count;
157#define THREAD_SYSTEM_DEPENDENT_IMPLEMENTATION
160 enum rb_thread_status prev_status;
164static void unblock_function_clear(
rb_thread_t *th);
170#define THREAD_BLOCKING_BEGIN(th) do { \
171 struct rb_thread_sched * const sched = TH_SCHED(th); \
172 RB_VM_SAVE_MACHINE_CONTEXT(th); \
173 thread_sched_to_waiting((sched), (th));
175#define THREAD_BLOCKING_END(th) \
176 thread_sched_to_running((sched), (th)); \
177 rb_ractor_thread_switch(th->ractor, th, false); \
181#ifdef HAVE_BUILTIN___BUILTIN_CHOOSE_EXPR_CONSTANT_P
182#define only_if_constant(expr, notconst) __builtin_choose_expr(__builtin_constant_p(expr), (expr), (notconst))
184#define only_if_constant(expr, notconst) (__builtin_constant_p(expr) ? (expr) : (notconst))
187#define only_if_constant(expr, notconst) notconst
189#define BLOCKING_REGION(th, exec, ubf, ubfarg, fail_if_interrupted) do { \
190 struct rb_blocking_region_buffer __region; \
191 if (blocking_region_begin(th, &__region, (ubf), (ubfarg), fail_if_interrupted) || \
193 !only_if_constant(fail_if_interrupted, TRUE)) { \
196 RB_VM_SAVE_MACHINE_CONTEXT(th); \
197 thread_sched_to_waiting(TH_SCHED(th), th); \
199 blocking_region_end(th, &__region); \
207#define RUBY_VM_CHECK_INTS_BLOCKING(ec) vm_check_ints_blocking(ec)
211#ifdef RUBY_ASSERT_CRITICAL_SECTION
212 VM_ASSERT(ruby_assert_critical_section_entered == 0);
217 if (LIKELY(rb_threadptr_pending_interrupt_empty_p(th))) {
218 if (LIKELY(!RUBY_VM_INTERRUPTED_ANY(ec)))
return FALSE;
221 th->pending_interrupt_queue_checked = 0;
222 RUBY_VM_SET_INTERRUPT(ec);
224 return rb_threadptr_execute_interrupts(th, 1);
230 return vm_check_ints_blocking(ec);
238#if defined(HAVE_POLL)
239# if defined(__linux__)
242# if defined(__FreeBSD_version) && __FreeBSD_version >= 1100000
245# define POLLERR_SET (POLLHUP | POLLERR)
250timeout_prepare(rb_hrtime_t **to, rb_hrtime_t *rel, rb_hrtime_t *end,
254 *rel = rb_timeval2hrtime(timeout);
255 *end = rb_hrtime_add(rb_hrtime_now(), *rel);
263MAYBE_UNUSED(NOINLINE(
static int thread_start_func_2(
rb_thread_t *th,
VALUE *stack_start)));
264MAYBE_UNUSED(
static bool th_has_dedicated_nt(
const rb_thread_t *th));
265MAYBE_UNUSED(
static int waitfd_to_waiting_flag(
int wfd_event));
267#include THREAD_IMPL_SRC
274#ifndef BUSY_WAIT_SIGNALS
275# define BUSY_WAIT_SIGNALS (0)
279# define USE_EVENTFD (0)
282#include "thread_sync.c"
312 if (fail_if_interrupted) {
313 if (RUBY_VM_INTERRUPTED_ANY(th->ec)) {
318 RUBY_VM_CHECK_INTS(th->ec);
322 }
while (!th->ec->raised_flag && RUBY_VM_INTERRUPTED_ANY(th->ec) &&
325 VM_ASSERT(th->unblock.func == NULL);
327 th->unblock.func = func;
328 th->unblock.arg = arg;
338 th->unblock.func = 0;
343threadptr_set_interrupt_locked(
rb_thread_t *th,
bool trap)
347 RUBY_DEBUG_LOG(
"th:%u trap:%d", rb_th_serial(th), trap);
350 RUBY_VM_SET_TRAP_INTERRUPT(th->ec);
353 RUBY_VM_SET_INTERRUPT(th->ec);
356 if (th->unblock.func != NULL) {
357 (th->unblock.func)(th->unblock.arg);
369 threadptr_set_interrupt_locked(th, trap);
378 RUBY_DEBUG_LOG(
"th:%u", rb_th_serial(th));
379 threadptr_set_interrupt(th,
false);
385 threadptr_set_interrupt(th,
true);
393 ccan_list_for_each(&r->threads.set, th, lt_node) {
394 if (th != main_thread) {
395 RUBY_DEBUG_LOG(
"terminate start th:%u status:%s", rb_th_serial(th), thread_status_name(th, TRUE));
397 rb_threadptr_pending_interrupt_enque(th, RUBY_FATAL_THREAD_TERMINATED);
398 rb_threadptr_interrupt(th);
400 RUBY_DEBUG_LOG(
"terminate done th:%u status:%s", rb_th_serial(th), thread_status_name(th, TRUE));
403 RUBY_DEBUG_LOG(
"main thread th:%u", rb_th_serial(th));
411 while (thread->join_list) {
415 thread->join_list = join_list->next;
419 if (target_thread->scheduler !=
Qnil && join_list->fiber) {
423 rb_threadptr_interrupt(target_thread);
425 switch (target_thread->status) {
427 case THREAD_STOPPED_FOREVER:
428 target_thread->status = THREAD_RUNNABLE;
438rb_threadptr_unlock_all_locking_mutexes(
rb_thread_t *th)
440 while (th->keeping_mutexes) {
442 th->keeping_mutexes = mutex->next_mutex;
446 const char *error_message = rb_mutex_unlock_th(mutex, th, mutex->fiber);
447 if (error_message) rb_bug(
"invalid keeping_mutexes: %s", error_message);
456 volatile int sleeping = 0;
458 if (cr->threads.main != th) {
459 rb_bug(
"rb_thread_terminate_all: called by child thread (%p, %p)",
460 (
void *)cr->threads.main, (
void *)th);
464 rb_threadptr_unlock_all_locking_mutexes(th);
467 if (EC_EXEC_TAG() == TAG_NONE) {
469 RUBY_DEBUG_LOG(
"th:%u", rb_th_serial(th));
471 terminate_all(cr, th);
473 while (rb_ractor_living_thread_num(cr) > 1) {
474 rb_hrtime_t rel = RB_HRTIME_PER_SEC;
480 native_sleep(th, &rel);
481 RUBY_VM_CHECK_INTS_BLOCKING(ec);
499void rb_threadptr_root_fiber_terminate(
rb_thread_t *th);
500static void threadptr_interrupt_exec_cleanup(
rb_thread_t *th);
503thread_cleanup_func_before_exec(
void *th_ptr)
506 th->status = THREAD_KILLED;
509 th->ec->machine.stack_start = th->ec->machine.stack_end = NULL;
511 threadptr_interrupt_exec_cleanup(th);
512 rb_threadptr_root_fiber_terminate(th);
516thread_cleanup_func(
void *th_ptr,
int atfork)
520 th->locking_mutex =
Qfalse;
521 thread_cleanup_func_before_exec(th_ptr);
524 native_thread_destroy_atfork(th->nt);
536ruby_thread_init_stack(
rb_thread_t *th,
void *local_in_parent_frame)
538 native_thread_init_stack(th, local_in_parent_frame);
542rb_vm_proc_local_ep(
VALUE proc)
544 const VALUE *ep = vm_proc_ep(proc);
547 return rb_vm_ep_local_ep(ep);
556 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler);
561 VALUE args = th->invoke_arg.proc.args;
562 const VALUE *args_ptr;
564 VALUE procval = th->invoke_arg.proc.proc;
566 GetProcPtr(procval, proc);
568 th->ec->errinfo =
Qnil;
569 th->ec->root_lep = rb_vm_proc_local_ep(procval);
570 th->ec->root_svar =
Qfalse;
572 vm_check_ints_blocking(th->ec);
574 if (th->invoke_type == thread_invoke_type_ractor_proc) {
575 VALUE self = rb_ractor_self(th->ractor);
576 th->thgroup = th->ractor->thgroup_default =
rb_obj_alloc(cThGroup);
581 rb_ractor_receive_parameters(th->ec, th->ractor, args_len, (
VALUE *)args_ptr);
582 vm_check_ints_blocking(th->ec);
584 return rb_vm_invoke_proc_with_self(
587 th->invoke_arg.proc.kw_splat,
588 VM_BLOCK_HANDLER_NONE
597 th->invoke_arg.proc.args =
Qnil;
603 vm_check_ints_blocking(th->ec);
605 return rb_vm_invoke_proc(
608 th->invoke_arg.proc.kw_splat,
609 VM_BLOCK_HANDLER_NONE
617 native_set_thread_name(th);
620 switch (th->invoke_type) {
621 case thread_invoke_type_proc:
622 result = thread_do_start_proc(th);
625 case thread_invoke_type_ractor_proc:
626 result = thread_do_start_proc(th);
627 rb_ractor_atexit(th->ec, result);
630 case thread_invoke_type_func:
631 result = (*th->invoke_arg.func.func)(th->invoke_arg.func.arg);
634 case thread_invoke_type_none:
635 rb_bug(
"unreachable");
646 RUBY_DEBUG_LOG(
"th:%u", rb_th_serial(th));
647 VM_ASSERT(th != th->vm->ractor.main_thread);
649 enum ruby_tag_type state;
651 rb_thread_t *ractor_main_th = th->ractor->threads.main;
654 if (rb_ractor_status_p(th->ractor, ractor_blocking)) {
657 rb_vm_ractor_blocking_cnt_dec(th->vm, th->ractor, __FILE__, __LINE__);
659 r->r_stdin = rb_io_prep_stdin();
660 r->r_stdout = rb_io_prep_stdout();
661 r->r_stderr = rb_io_prep_stderr();
667 VM_ASSERT(UNDEF_P(th->value));
669 int fiber_scheduler_closed = 0, event_thread_end_hooked = 0;
674 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
677 result = thread_do_start(th);
680 if (!fiber_scheduler_closed) {
681 fiber_scheduler_closed = 1;
685 if (!event_thread_end_hooked) {
686 event_thread_end_hooked = 1;
690 if (state == TAG_NONE) {
695 errinfo = th->ec->errinfo;
697 VALUE exc = rb_vm_make_jump_tag_but_local_jump(state,
Qundef);
698 if (!
NIL_P(exc)) errinfo = exc;
700 if (state == TAG_FATAL) {
701 if (th->invoke_type == thread_invoke_type_ractor_proc) {
702 rb_ractor_atexit(th->ec,
Qnil);
707 if (th->invoke_type == thread_invoke_type_ractor_proc) {
708 rb_ractor_atexit_exception(th->ec);
714 if (th->report_on_exception) {
715 VALUE mesg = rb_thread_to_s(th->self);
716 rb_str_cat_cstr(mesg,
" terminated with exception (report_on_exception is true):\n");
717 rb_write_error_str(mesg);
718 rb_ec_error_print(th->ec, errinfo);
721 if (th->invoke_type == thread_invoke_type_ractor_proc) {
722 rb_ractor_atexit_exception(th->ec);
725 if (th->vm->thread_abort_on_exception ||
737 VM_ASSERT(!UNDEF_P(th->value));
739 rb_threadptr_join_list_wakeup(th);
740 rb_threadptr_unlock_all_locking_mutexes(th);
742 if (th->invoke_type == thread_invoke_type_ractor_proc) {
743 rb_thread_terminate_all(th);
744 rb_ractor_teardown(th->ec);
747 th->status = THREAD_KILLED;
748 RUBY_DEBUG_LOG(
"killed th:%u", rb_th_serial(th));
750 if (th->vm->ractor.main_thread == th) {
756 rb_threadptr_raise(ractor_main_th, 1, &errinfo);
761 rb_ec_clear_current_thread_trace_func(th->ec);
764 if (th->locking_mutex !=
Qfalse) {
765 rb_bug(
"thread_start_func_2: locking_mutex must not be set (%p:%"PRIxVALUE
")",
766 (
void *)th, th->locking_mutex);
769 if (ractor_main_th->status == THREAD_KILLED &&
770 th->ractor->threads.cnt <= 2 ) {
772 rb_threadptr_interrupt(ractor_main_th);
775 rb_check_deadlock(th->ractor);
777 rb_fiber_close(th->ec->fiber_ptr);
779 thread_cleanup_func(th, FALSE);
780 VM_ASSERT(th->ec->vm_stack == NULL);
782 if (th->invoke_type == thread_invoke_type_ractor_proc) {
786 thread_sched_to_dead(TH_SCHED(th), th);
787 rb_ractor_living_threads_remove(th->ractor, th);
790 rb_ractor_living_threads_remove(th->ractor, th);
791 thread_sched_to_dead(TH_SCHED(th), th);
798 enum thread_invoke_type type;
811static void thread_specific_storage_alloc(
rb_thread_t *th);
817 rb_thread_t *th = rb_thread_ptr(thval), *current_th = rb_ec_thread_ptr(ec);
820 thread_specific_storage_alloc(th);
824 "can't start a new thread (frozen ThreadGroup)");
827 rb_fiber_inherit_storage(ec, th->ec->fiber_ptr);
829 switch (params->type) {
830 case thread_invoke_type_proc:
831 th->invoke_type = thread_invoke_type_proc;
832 th->invoke_arg.proc.args = params->args;
833 th->invoke_arg.proc.proc = params->proc;
837 case thread_invoke_type_ractor_proc:
838#if RACTOR_CHECK_MODE > 0
839 rb_ractor_setup_belonging_to(thval, rb_ractor_id(params->g));
841 th->invoke_type = thread_invoke_type_ractor_proc;
842 th->ractor = params->g;
843 th->ractor->threads.main = th;
844 th->invoke_arg.proc.proc = rb_proc_isolate_bang(params->proc);
847 rb_ractor_send_parameters(ec, params->g, params->args);
850 case thread_invoke_type_func:
851 th->invoke_type = thread_invoke_type_func;
852 th->invoke_arg.func.func = params->fn;
853 th->invoke_arg.func.arg = (
void *)params->args;
857 rb_bug(
"unreachable");
860 th->priority = current_th->priority;
861 th->thgroup = current_th->thgroup;
864 th->pending_interrupt_queue_checked = 0;
865 th->pending_interrupt_mask_stack =
rb_ary_dup(current_th->pending_interrupt_mask_stack);
866 RBASIC_CLEAR_CLASS(th->pending_interrupt_mask_stack);
870 RUBY_DEBUG_LOG(
"r:%u th:%u", rb_ractor_id(th->ractor), rb_th_serial(th));
872 rb_ractor_living_threads_insert(th->ractor, th);
875 err = native_thread_create(th);
877 th->status = THREAD_KILLED;
878 rb_ractor_living_threads_remove(th->ractor, th);
884#define threadptr_initialized(th) ((th)->invoke_type != thread_invoke_type_none)
907thread_s_new(
int argc,
VALUE *argv,
VALUE klass)
910 VALUE thread = rb_thread_alloc(klass);
912 if (GET_RACTOR()->threads.main->status == THREAD_KILLED) {
917 th = rb_thread_ptr(thread);
918 if (!threadptr_initialized(th)) {
919 rb_raise(
rb_eThreadError,
"uninitialized thread - check '%"PRIsVALUE
"#initialize'",
939 .type = thread_invoke_type_proc,
943 return thread_create_core(rb_thread_alloc(klass), ¶ms);
949 if (th->invoke_type == thread_invoke_type_proc) {
950 return rb_proc_location(th->invoke_arg.proc.proc);
966 else if (th->invoke_type != thread_invoke_type_none) {
967 VALUE loc = threadptr_invoke_proc_location(th);
970 "already initialized thread - %"PRIsVALUE
":%"PRIsVALUE,
979 .type = thread_invoke_type_proc,
983 return thread_create_core(thread, ¶ms);
991 .type = thread_invoke_type_func,
995 return thread_create_core(rb_thread_alloc(
rb_cThread), ¶ms);
1002 .type = thread_invoke_type_ractor_proc,
1007 return thread_create_core(rb_thread_alloc(
rb_cThread), ¶ms);;
1019remove_from_join_list(
VALUE arg)
1024 if (target_thread->status != THREAD_KILLED) {
1027 while (*join_list) {
1028 if (*join_list == p->waiter) {
1029 *join_list = (*join_list)->next;
1033 join_list = &(*join_list)->next;
1043 return th->status == THREAD_KILLED || !UNDEF_P(th->value);
1047thread_join_sleep(
VALUE arg)
1050 rb_thread_t *target_th = p->target, *th = p->waiter->thread;
1051 rb_hrtime_t end = 0, *limit = p->limit;
1054 end = rb_hrtime_add(*limit, rb_hrtime_now());
1057 while (!thread_finished(target_th)) {
1061 if (scheduler !=
Qnil) {
1065 sleep_forever(th, SLEEP_DEADLOCKABLE | SLEEP_ALLOW_SPURIOUS | SLEEP_NO_CHECKINTS);
1069 if (hrtime_update_expire(limit, end)) {
1070 RUBY_DEBUG_LOG(
"timeout target_th:%u", rb_th_serial(target_th));
1074 if (scheduler !=
Qnil) {
1075 VALUE timeout = rb_float_new(hrtime2double(*limit));
1079 th->status = THREAD_STOPPED;
1080 native_sleep(th, limit);
1083 RUBY_VM_CHECK_INTS_BLOCKING(th->ec);
1084 th->status = THREAD_RUNNABLE;
1086 RUBY_DEBUG_LOG(
"interrupted target_th:%u status:%s", rb_th_serial(target_th), thread_status_name(target_th, TRUE));
1099 if (th == target_th) {
1100 rb_raise(
rb_eThreadError,
"Target thread must not be current thread");
1103 if (th->ractor->threads.main == target_th) {
1107 RUBY_DEBUG_LOG(
"target_th:%u status:%s", rb_th_serial(target_th), thread_status_name(target_th, TRUE));
1109 if (target_th->status != THREAD_KILLED) {
1111 waiter.next = target_th->join_list;
1113 waiter.fiber = rb_fiberptr_blocking(fiber) ? NULL : fiber;
1114 target_th->join_list = &waiter;
1117 arg.waiter = &waiter;
1118 arg.target = target_th;
1119 arg.timeout = timeout;
1127 RUBY_DEBUG_LOG(
"success target_th:%u status:%s", rb_th_serial(target_th), thread_status_name(target_th, TRUE));
1129 if (target_th->ec->errinfo !=
Qnil) {
1130 VALUE err = target_th->ec->errinfo;
1135 RUBY_DEBUG_LOG(
"terminated target_th:%u status:%s", rb_th_serial(target_th), thread_status_name(target_th, TRUE));
1140 if (err == RUBY_FATAL_FIBER_KILLED) {
1144 rb_bug(
"thread_join: Fixnum (%d) should not reach here.",
FIX2INT(err));
1147 else if (THROW_DATA_P(target_th->ec->errinfo)) {
1148 rb_bug(
"thread_join: THROW_DATA should not reach here.");
1155 return target_th->self;
1198thread_join_m(
int argc,
VALUE *argv,
VALUE self)
1201 rb_hrtime_t rel = 0, *limit = 0;
1212 if (
NIL_P(timeout)) {
1216 rel = rb_sec2hrtime(NUM2TIMET(timeout));
1220 limit = double2hrtime(&rel,
rb_num2dbl(timeout));
1223 return thread_join(rb_thread_ptr(self), timeout, limit);
1241thread_value(
VALUE self)
1244 thread_join(th,
Qnil, 0);
1245 if (UNDEF_P(th->value)) {
1259#if defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_MONOTONIC)
1260 if (clock_gettime(CLOCK_MONOTONIC, ts) == 0)
1270NOINLINE(rb_hrtime_t rb_hrtime_now(
void));
1277 return rb_timespec2hrtime(&ts);
1284COMPILER_WARNING_PUSH
1285#if defined(__GNUC__) && __GNUC__ == 7 && __GNUC_MINOR__ <= 3
1286COMPILER_WARNING_IGNORED(-Wmaybe-uninitialized)
1289#define PRIu64 PRI_64_PREFIX "u"
1297hrtime_update_expire(rb_hrtime_t *timeout,
const rb_hrtime_t end)
1299 rb_hrtime_t now = rb_hrtime_now();
1301 if (now > end)
return 1;
1303 RUBY_DEBUG_LOG(
"%"PRIu64
" > %"PRIu64
"", (uint64_t)end, (uint64_t)now);
1305 *timeout = end - now;
1311sleep_hrtime(
rb_thread_t *th, rb_hrtime_t rel,
unsigned int fl)
1313 enum rb_thread_status prev_status = th->status;
1315 rb_hrtime_t end = rb_hrtime_add(rb_hrtime_now(), rel);
1317 th->status = THREAD_STOPPED;
1318 RUBY_VM_CHECK_INTS_BLOCKING(th->ec);
1319 while (th->status == THREAD_STOPPED) {
1320 native_sleep(th, &rel);
1321 woke = vm_check_ints_blocking(th->ec);
1322 if (woke && !(fl & SLEEP_SPURIOUS_CHECK))
1324 if (hrtime_update_expire(&rel, end))
1328 th->status = prev_status;
1333sleep_hrtime_until(
rb_thread_t *th, rb_hrtime_t end,
unsigned int fl)
1335 enum rb_thread_status prev_status = th->status;
1337 rb_hrtime_t rel = rb_hrtime_sub(end, rb_hrtime_now());
1339 th->status = THREAD_STOPPED;
1340 RUBY_VM_CHECK_INTS_BLOCKING(th->ec);
1341 while (th->status == THREAD_STOPPED) {
1342 native_sleep(th, &rel);
1343 woke = vm_check_ints_blocking(th->ec);
1344 if (woke && !(fl & SLEEP_SPURIOUS_CHECK))
1346 if (hrtime_update_expire(&rel, end))
1350 th->status = prev_status;
1357 enum rb_thread_status prev_status = th->status;
1358 enum rb_thread_status status;
1361 status = fl & SLEEP_DEADLOCKABLE ? THREAD_STOPPED_FOREVER : THREAD_STOPPED;
1362 th->status = status;
1364 if (!(fl & SLEEP_NO_CHECKINTS)) RUBY_VM_CHECK_INTS_BLOCKING(th->ec);
1366 while (th->status == status) {
1367 if (fl & SLEEP_DEADLOCKABLE) {
1368 rb_ractor_sleeper_threads_inc(th->ractor);
1369 rb_check_deadlock(th->ractor);
1372 native_sleep(th, 0);
1374 if (fl & SLEEP_DEADLOCKABLE) {
1375 rb_ractor_sleeper_threads_dec(th->ractor);
1377 if (fl & SLEEP_ALLOW_SPURIOUS) {
1381 woke = vm_check_ints_blocking(th->ec);
1383 if (woke && !(fl & SLEEP_SPURIOUS_CHECK)) {
1387 th->status = prev_status;
1393 RUBY_DEBUG_LOG(
"forever");
1394 sleep_forever(GET_THREAD(), SLEEP_SPURIOUS_CHECK);
1400 RUBY_DEBUG_LOG(
"deadly");
1401 sleep_forever(GET_THREAD(), SLEEP_DEADLOCKABLE|SLEEP_SPURIOUS_CHECK);
1405rb_thread_sleep_deadly_allow_spurious_wakeup(
VALUE blocker,
VALUE timeout, rb_hrtime_t end)
1408 if (scheduler !=
Qnil) {
1412 RUBY_DEBUG_LOG(
"...");
1414 sleep_hrtime_until(GET_THREAD(), end, SLEEP_SPURIOUS_CHECK);
1417 sleep_forever(GET_THREAD(), SLEEP_DEADLOCKABLE);
1427 sleep_hrtime(th, rb_timeval2hrtime(&time), SLEEP_SPURIOUS_CHECK);
1433 RUBY_VM_CHECK_INTS_BLOCKING(ec);
1446 rb_ec_check_ints(GET_EC());
1454rb_thread_check_trap_pending(
void)
1456 return rb_signal_buff_size() != 0;
1463 return (
int)RUBY_VM_INTERRUPTED(rb_thread_ptr(thval)->ec);
1473rb_thread_schedule_limits(uint32_t limits_us)
1477 RUBY_DEBUG_LOG(
"us:%u", (
unsigned int)limits_us);
1479 if (th->running_time_us >= limits_us) {
1480 RUBY_DEBUG_LOG(
"switch %s",
"start");
1482 RB_VM_SAVE_MACHINE_CONTEXT(th);
1483 thread_sched_yield(TH_SCHED(th), th);
1484 rb_ractor_thread_switch(th->ractor, th,
true);
1486 RUBY_DEBUG_LOG(
"switch %s",
"done");
1494 rb_thread_schedule_limits(0);
1495 RUBY_VM_CHECK_INTS(GET_EC());
1504#ifdef RUBY_ASSERT_CRITICAL_SECTION
1505 VM_ASSERT(ruby_assert_critical_section_entered == 0);
1507 VM_ASSERT(th == GET_THREAD());
1509 region->prev_status = th->status;
1510 if (unblock_function_set(th, ubf, arg, fail_if_interrupted)) {
1511 th->blocking_region_buffer = region;
1512 th->status = THREAD_STOPPED;
1513 rb_ractor_blocking_threads_inc(th->ractor, __FILE__, __LINE__);
1515 RUBY_DEBUG_LOG(
"thread_id:%p", (
void *)th->nt->thread_id);
1527 unblock_function_clear(th);
1529 unregister_ubf_list(th);
1531 thread_sched_to_running(TH_SCHED(th), th);
1532 rb_ractor_thread_switch(th->ractor, th,
false);
1534 th->blocking_region_buffer = 0;
1535 rb_ractor_blocking_threads_dec(th->ractor, __FILE__, __LINE__);
1536 if (th->status == THREAD_STOPPED) {
1537 th->status = region->prev_status;
1540 RUBY_DEBUG_LOG(
"end");
1544 VM_ASSERT(th == GET_THREAD());
1564 *unblock_function = ubf_select;
1572rb_nogvl(
void *(*func)(
void *),
void *data1,
1578 if (scheduler !=
Qnil) {
1583 if (!UNDEF_P(result)) {
1584 rb_errno_set(state.saved_errno);
1585 return state.result;
1593 rb_vm_t *vm = rb_ec_vm_ptr(ec);
1594 bool is_main_thread = vm->ractor.main_thread == th;
1595 int saved_errno = 0;
1597 rb_thread_resolve_unblock_function(&ubf, &data2, th);
1599 if (ubf && rb_ractor_living_thread_num(th->ractor) == 1 && is_main_thread) {
1601 vm->ubf_async_safe = 1;
1605 rb_vm_t *
volatile saved_vm = vm;
1606 BLOCKING_REGION(th, {
1608 saved_errno = rb_errno();
1612 if (is_main_thread) vm->ubf_async_safe = 0;
1615 RUBY_VM_CHECK_INTS_BLOCKING(ec);
1618 rb_errno_set(saved_errno);
1719 return rb_nogvl(func, data1, ubf, data2, 0);
1723waitfd_to_waiting_flag(
int wfd_event)
1725 return wfd_event << 1;
1728static struct ccan_list_head *
1729rb_io_blocking_operations(
struct rb_io *io)
1731 rb_serial_t fork_generation = GET_VM()->fork_gen;
1735 if (io->fork_generation != fork_generation) {
1737 io->fork_generation = fork_generation;
1756 ccan_list_add(rb_io_blocking_operations(io), &blocking_operation->list);
1762 ccan_list_del(&blocking_operation->list);
1771io_blocking_operation_exit(
VALUE _arguments)
1776 rb_io_blocking_operation_pop(arguments->io, blocking_operation);
1780 rb_fiber_t *fiber = io->closing_ec->fiber_ptr;
1782 if (thread->scheduler !=
Qnil) {
1806 VALUE wakeup_mutex = io->wakeup_mutex;
1809 blocking_operation->ec = NULL;
1814 .blocking_operation = blocking_operation
1821 rb_io_blocking_operation_pop(io, blocking_operation);
1826rb_thread_io_blocking_operation_ensure(
VALUE _argument)
1830 rb_io_blocking_operation_exit(arguments->io, arguments->blocking_operation);
1858 rb_io_blocking_operation_enter(io, &blocking_operation);
1862 .blocking_operation = &blocking_operation
1871#if defined(USE_MN_THREADS) && USE_MN_THREADS
1872 return !th_has_dedicated_nt(th) && (events || timeout) && th->blocking;
1880thread_io_wait_events(
rb_thread_t *th,
int fd,
int events,
const struct timeval *timeout)
1882#if defined(USE_MN_THREADS) && USE_MN_THREADS
1883 if (thread_io_mn_schedulable(th, events, timeout)) {
1884 rb_hrtime_t rel, *prel;
1887 rel = rb_timeval2hrtime(timeout);
1894 VM_ASSERT(prel || (events & (RB_WAITFD_IN | RB_WAITFD_OUT)));
1896 if (thread_sched_wait_events(TH_SCHED(th), th, fd, waitfd_to_waiting_flag(events), prel)) {
1910blocking_call_retryable_p(
int r,
int eno)
1912 if (r != -1)
return false;
1916#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
1926rb_thread_mn_schedulable(
VALUE thval)
1929 return th->mn_schedulable;
1933rb_thread_io_blocking_call(
struct rb_io* io, rb_blocking_function_t *func,
void *data1,
int events)
1938 RUBY_DEBUG_LOG(
"th:%u fd:%d ev:%d", rb_th_serial(th), io->
fd, events);
1941 volatile int saved_errno = 0;
1942 enum ruby_tag_type state;
1943 volatile bool prev_mn_schedulable = th->mn_schedulable;
1944 th->mn_schedulable = thread_io_mn_schedulable(th, events, NULL);
1957 rb_io_blocking_operation_enter(io, &blocking_operation);
1961 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
1962 volatile enum ruby_tag_type saved_state = state;
1964 BLOCKING_REGION(th, {
1966 saved_errno =
errno;
1967 }, ubf_select, th, FALSE);
1971 blocking_call_retryable_p((
int)val, saved_errno) &&
1972 thread_io_wait_events(th, fd, events, NULL)) {
1973 RUBY_VM_CHECK_INTS_BLOCKING(ec);
1977 RUBY_VM_CHECK_INTS_BLOCKING(ec);
1979 state = saved_state;
1983 th = rb_ec_thread_ptr(ec);
1984 th->mn_schedulable = prev_mn_schedulable;
1987 rb_io_blocking_operation_exit(io, &blocking_operation);
1990 EC_JUMP_TAG(ec, state);
1994 if (saved_errno == ETIMEDOUT) {
1998 errno = saved_errno;
2004rb_thread_io_blocking_region(
struct rb_io *io, rb_blocking_function_t *func,
void *data1)
2006 return rb_thread_io_blocking_call(io, func, data1, 0);
2051 fprintf(stderr,
"[BUG] rb_thread_call_with_gvl() is called by non-ruby thread\n");
2056 prev_unblock = th->unblock;
2059 rb_bug(
"rb_thread_call_with_gvl: called by a thread which has GVL.");
2062 blocking_region_end(th, brb);
2066 int released = blocking_region_begin(th, brb, prev_unblock.func, prev_unblock.arg, FALSE);
2068 RB_VM_SAVE_MACHINE_CONTEXT(th);
2069 thread_sched_to_waiting(TH_SCHED(th), th);
2078ruby_thread_has_gvl_p(
void)
2082 if (th && th->blocking_region_buffer == 0) {
2099thread_s_pass(
VALUE klass)
2124rb_threadptr_pending_interrupt_clear(
rb_thread_t *th)
2133 th->pending_interrupt_queue_checked = 0;
2137threadptr_check_pending_interrupt_queue(
rb_thread_t *th)
2139 if (!th->pending_interrupt_queue) {
2144enum handle_interrupt_timing {
2146 INTERRUPT_IMMEDIATE,
2147 INTERRUPT_ON_BLOCKING,
2151static enum handle_interrupt_timing
2154 if (sym == sym_immediate) {
2155 return INTERRUPT_IMMEDIATE;
2157 else if (sym == sym_on_blocking) {
2158 return INTERRUPT_ON_BLOCKING;
2160 else if (sym == sym_never) {
2161 return INTERRUPT_NEVER;
2168static enum handle_interrupt_timing
2172 long mask_stack_len =
RARRAY_LEN(th->pending_interrupt_mask_stack);
2177 for (i=0; i<mask_stack_len; i++) {
2178 mask = mask_stack[mask_stack_len-(i+1)];
2183 return rb_threadptr_pending_interrupt_from_symbol(th, mask);
2195 klass =
RBASIC(mod)->klass;
2197 else if (mod != RCLASS_ORIGIN(mod)) {
2201 if ((sym = rb_hash_aref(mask, klass)) !=
Qnil) {
2202 return rb_threadptr_pending_interrupt_from_symbol(th, sym);
2207 return INTERRUPT_NONE;
2211rb_threadptr_pending_interrupt_empty_p(
const rb_thread_t *th)
2213 return RARRAY_LEN(th->pending_interrupt_queue) == 0;
2220 for (i=0; i<
RARRAY_LEN(th->pending_interrupt_queue); i++) {
2230rb_threadptr_pending_interrupt_deque(
rb_thread_t *th,
enum handle_interrupt_timing timing)
2235 for (i=0; i<
RARRAY_LEN(th->pending_interrupt_queue); i++) {
2238 enum handle_interrupt_timing mask_timing = rb_threadptr_pending_interrupt_check_mask(th,
CLASS_OF(err));
2240 switch (mask_timing) {
2241 case INTERRUPT_ON_BLOCKING:
2242 if (timing != INTERRUPT_ON_BLOCKING) {
2246 case INTERRUPT_NONE:
2247 case INTERRUPT_IMMEDIATE:
2250 case INTERRUPT_NEVER:
2255 th->pending_interrupt_queue_checked = 1;
2259 if (rb_threadptr_pending_interrupt_empty_p(th)) {
2260 th->pending_interrupt_queue_checked = 1;
2267threadptr_pending_interrupt_active_p(
rb_thread_t *th)
2274 if (th->pending_interrupt_queue_checked) {
2278 if (rb_threadptr_pending_interrupt_empty_p(th)) {
2290 if (val != sym_immediate && val != sym_on_blocking && val != sym_never) {
2291 rb_raise(rb_eArgError,
"unknown mask signature");
2299 if (
RTEST(*maskp)) {
2301 VALUE prev = *maskp;
2302 *maskp = rb_ident_hash_new();
2307 rb_hash_aset(*maskp, key, val);
2401rb_thread_s_handle_interrupt(
VALUE self,
VALUE mask_arg)
2407 enum ruby_tag_type state;
2410 rb_raise(rb_eArgError,
"block is needed.");
2413 mask_arg = rb_to_hash_type(mask_arg);
2415 if (
OBJ_FROZEN(mask_arg) && rb_hash_compare_by_id_p(mask_arg)) {
2421 if (UNDEF_P(mask)) {
2432 rb_ary_push(th->pending_interrupt_mask_stack, mask);
2433 if (!rb_threadptr_pending_interrupt_empty_p(th)) {
2434 th->pending_interrupt_queue_checked = 0;
2435 RUBY_VM_SET_INTERRUPT(th->ec);
2438 EC_PUSH_TAG(th->ec);
2439 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2444 rb_ary_pop(th->pending_interrupt_mask_stack);
2445 if (!rb_threadptr_pending_interrupt_empty_p(th)) {
2446 th->pending_interrupt_queue_checked = 0;
2447 RUBY_VM_SET_INTERRUPT(th->ec);
2450 RUBY_VM_CHECK_INTS(th->ec);
2453 EC_JUMP_TAG(th->ec, state);
2470rb_thread_pending_interrupt_p(
int argc,
VALUE *argv,
VALUE target_thread)
2472 rb_thread_t *target_th = rb_thread_ptr(target_thread);
2474 if (!target_th->pending_interrupt_queue) {
2477 if (rb_threadptr_pending_interrupt_empty_p(target_th)) {
2481 VALUE err = argv[0];
2483 rb_raise(
rb_eTypeError,
"class or module required for rescue clause");
2485 return RBOOL(rb_threadptr_pending_interrupt_include_p(target_th, err));
2550rb_thread_s_pending_interrupt_p(
int argc,
VALUE *argv,
VALUE self)
2552 return rb_thread_pending_interrupt_p(argc, argv, GET_THREAD()->self);
2555NORETURN(
static void rb_threadptr_to_kill(
rb_thread_t *th));
2560 VM_ASSERT(GET_THREAD() == th);
2561 rb_threadptr_pending_interrupt_clear(th);
2562 th->status = THREAD_RUNNABLE;
2564 th->ec->errinfo =
INT2FIX(TAG_FATAL);
2565 EC_JUMP_TAG(th->ec, TAG_FATAL);
2575 old = ATOMIC_LOAD_RELAXED(ec->interrupt_flag);
2578 old = ATOMIC_CAS(ec->interrupt_flag, interrupt, interrupt & ec->interrupt_mask);
2579 }
while (old != interrupt);
2580 return interrupt & (
rb_atomic_t)~ec->interrupt_mask;
2583static void threadptr_interrupt_exec_exec(
rb_thread_t *th);
2591rb_threadptr_execute_interrupts(
rb_thread_t *th,
int blocking_timing)
2594 int postponed_job_interrupt = 0;
2597 VM_ASSERT(GET_THREAD() == th);
2599 if (th->ec->raised_flag)
return ret;
2601 while ((interrupt = threadptr_get_interrupts(th)) != 0) {
2603 int timer_interrupt;
2604 int pending_interrupt;
2606 int terminate_interrupt;
2608 timer_interrupt = interrupt & TIMER_INTERRUPT_MASK;
2609 pending_interrupt = interrupt & PENDING_INTERRUPT_MASK;
2610 postponed_job_interrupt = interrupt & POSTPONED_JOB_INTERRUPT_MASK;
2611 trap_interrupt = interrupt & TRAP_INTERRUPT_MASK;
2612 terminate_interrupt = interrupt & TERMINATE_INTERRUPT_MASK;
2614 if (interrupt & VM_BARRIER_INTERRUPT_MASK) {
2618 if (postponed_job_interrupt) {
2619 rb_postponed_job_flush(th->vm);
2622 if (trap_interrupt) {
2624 if (th == th->vm->ractor.main_thread) {
2625 enum rb_thread_status prev_status = th->status;
2627 th->status = THREAD_RUNNABLE;
2629 while ((sig = rb_get_next_signal()) != 0) {
2630 ret |= rb_signal_exec(th, sig);
2633 th->status = prev_status;
2636 if (!ccan_list_empty(&th->interrupt_exec_tasks)) {
2637 enum rb_thread_status prev_status = th->status;
2639 th->status = THREAD_RUNNABLE;
2641 threadptr_interrupt_exec_exec(th);
2643 th->status = prev_status;
2648 if (pending_interrupt && threadptr_pending_interrupt_active_p(th)) {
2649 VALUE err = rb_threadptr_pending_interrupt_deque(th, blocking_timing ? INTERRUPT_ON_BLOCKING : INTERRUPT_NONE);
2650 RUBY_DEBUG_LOG(
"err:%"PRIdVALUE, err);
2656 else if (err == RUBY_FATAL_THREAD_KILLED ||
2657 err == RUBY_FATAL_THREAD_TERMINATED ||
2659 terminate_interrupt = 1;
2662 if (err == th->vm->special_exceptions[ruby_error_stream_closed]) {
2664 err = ruby_vm_special_exception_copy(err);
2667 if (th->status == THREAD_STOPPED ||
2668 th->status == THREAD_STOPPED_FOREVER)
2669 th->status = THREAD_RUNNABLE;
2674 if (terminate_interrupt) {
2675 rb_threadptr_to_kill(th);
2678 if (timer_interrupt) {
2679 uint32_t limits_us = thread_default_quantum_ms * 1000;
2681 if (th->priority > 0)
2682 limits_us <<= th->priority;
2684 limits_us >>= -th->priority;
2686 if (th->status == THREAD_RUNNABLE)
2687 th->running_time_us += 10 * 1000;
2689 VM_ASSERT(th->ec->cfp);
2693 rb_thread_schedule_limits(limits_us);
2700rb_thread_execute_interrupts(
VALUE thval)
2702 rb_threadptr_execute_interrupts(rb_thread_ptr(thval), 1);
2708 rb_threadptr_interrupt(th);
2714 if (rb_threadptr_dead(target_th)) {
2718 VALUE exception = rb_exception_setup(argc, argv);
2722 if (rb_threadptr_dead(target_th)) {
2726 rb_threadptr_pending_interrupt_enque(target_th, exception);
2727 rb_threadptr_interrupt(target_th);
2733rb_threadptr_signal_raise(
rb_thread_t *th,
int sig)
2739 rb_threadptr_raise(th->vm->ractor.main_thread, 2, argv);
2751 rb_threadptr_raise(th->vm->ractor.main_thread, 2, argv);
2757 if (ec->raised_flag & RAISED_EXCEPTION) {
2760 ec->raised_flag |= RAISED_EXCEPTION;
2767 if (!(ec->raised_flag & RAISED_EXCEPTION)) {
2770 ec->raised_flag &= ~RAISED_EXCEPTION;
2795thread_io_close_notify_all(
VALUE _io)
2800 rb_vm_t *vm = io->closing_ec->thread_ptr->vm;
2801 VALUE error = vm->special_exceptions[ruby_error_stream_closed];
2804 ccan_list_for_each(rb_io_blocking_operations(io), blocking_operation, list) {
2812 if (thread->scheduler !=
Qnil) {
2818 rb_threadptr_pending_interrupt_enque(thread, error);
2819 rb_threadptr_interrupt(thread);
2826 return (
VALUE)count;
2830rb_thread_io_close_interrupt(
struct rb_io *io)
2833 if (io->closing_ec) {
2838 if (ccan_list_empty(rb_io_blocking_operations(io))) {
2844 io->closing_ec = ec;
2848 rb_mutex_allow_trap(io->wakeup_mutex, 1);
2853 return (
size_t)result;
2857rb_thread_io_close_wait(
struct rb_io* io)
2859 VALUE wakeup_mutex = io->wakeup_mutex;
2867 while (!ccan_list_empty(rb_io_blocking_operations(io))) {
2873 io->wakeup_mutex =
Qnil;
2874 io->closing_ec = NULL;
2880 rb_warn(
"rb_thread_fd_close is deprecated (and is now a no-op).");
2905thread_raise_m(
int argc,
VALUE *argv,
VALUE self)
2910 threadptr_check_pending_interrupt_queue(target_th);
2911 rb_threadptr_raise(target_th, argc, argv);
2914 if (current_th == target_th) {
2915 RUBY_VM_CHECK_INTS(target_th->ec);
2937 if (target_th->to_kill || target_th->status == THREAD_KILLED) {
2940 if (target_th == target_th->vm->ractor.main_thread) {
2944 RUBY_DEBUG_LOG(
"target_th:%u", rb_th_serial(target_th));
2946 if (target_th == GET_THREAD()) {
2948 rb_threadptr_to_kill(target_th);
2951 threadptr_check_pending_interrupt_queue(target_th);
2952 rb_threadptr_pending_interrupt_enque(target_th, RUBY_FATAL_THREAD_KILLED);
2953 rb_threadptr_interrupt(target_th);
2960rb_thread_to_be_killed(
VALUE thread)
2964 if (target_th->to_kill || target_th->status == THREAD_KILLED) {
3040 if (target_th->status == THREAD_KILLED)
return Qnil;
3042 rb_threadptr_ready(target_th);
3044 if (target_th->status == THREAD_STOPPED ||
3045 target_th->status == THREAD_STOPPED_FOREVER) {
3046 target_th->status = THREAD_RUNNABLE;
3088 "stopping only thread\n\tnote: use sleep to stop forever");
3121 return rb_ractor_thread_list();
3147 return rb_thread_list();
3153 return GET_THREAD()->self;
3166thread_s_current(
VALUE klass)
3174 return GET_RACTOR()->threads.main->self;
3185rb_thread_s_main(
VALUE klass)
3212rb_thread_s_abort_exc(
VALUE _)
3214 return RBOOL(GET_THREAD()->vm->thread_abort_on_exception);
3249rb_thread_s_abort_exc_set(
VALUE self,
VALUE val)
3251 GET_THREAD()->vm->thread_abort_on_exception =
RTEST(val);
3272rb_thread_abort_exc(
VALUE thread)
3274 return RBOOL(rb_thread_ptr(thread)->abort_on_exception);
3292rb_thread_abort_exc_set(
VALUE thread,
VALUE val)
3294 rb_thread_ptr(thread)->abort_on_exception =
RTEST(val);
3342rb_thread_s_report_exc(
VALUE _)
3344 return RBOOL(GET_THREAD()->vm->thread_report_on_exception);
3379rb_thread_s_report_exc_set(
VALUE self,
VALUE val)
3381 GET_THREAD()->vm->thread_report_on_exception =
RTEST(val);
3398rb_thread_s_ignore_deadlock(
VALUE _)
3400 return RBOOL(GET_THREAD()->vm->thread_ignore_deadlock);
3425rb_thread_s_ignore_deadlock_set(
VALUE self,
VALUE val)
3427 GET_THREAD()->vm->thread_ignore_deadlock =
RTEST(val);
3449rb_thread_report_exc(
VALUE thread)
3451 return RBOOL(rb_thread_ptr(thread)->report_on_exception);
3469rb_thread_report_exc_set(
VALUE thread,
VALUE val)
3471 rb_thread_ptr(thread)->report_on_exception =
RTEST(val);
3486rb_thread_group(
VALUE thread)
3488 return rb_thread_ptr(thread)->thgroup;
3494 switch (th->status) {
3495 case THREAD_RUNNABLE:
3496 return th->to_kill ?
"aborting" :
"run";
3497 case THREAD_STOPPED_FOREVER:
3498 if (detail)
return "sleep_forever";
3499 case THREAD_STOPPED:
3511 return th->status == THREAD_KILLED;
3547rb_thread_status(
VALUE thread)
3551 if (rb_threadptr_dead(target_th)) {
3552 if (!
NIL_P(target_th->ec->errinfo) &&
3553 !
FIXNUM_P(target_th->ec->errinfo)) {
3561 return rb_str_new2(thread_status_name(target_th, FALSE));
3581rb_thread_alive_p(
VALUE thread)
3583 return RBOOL(!thread_finished(rb_thread_ptr(thread)));
3601rb_thread_stop_p(
VALUE thread)
3605 if (rb_threadptr_dead(th)) {
3608 return RBOOL(th->status == THREAD_STOPPED || th->status == THREAD_STOPPED_FOREVER);
3619rb_thread_getname(
VALUE thread)
3621 return rb_thread_ptr(thread)->name;
3640 enc = rb_enc_get(name);
3641 if (!rb_enc_asciicompat(enc)) {
3642 rb_raise(rb_eArgError,
"ASCII incompatible encoding (%s)",
3647 target_th->name = name;
3648 if (threadptr_initialized(target_th) && target_th->has_dedicated_nt) {
3649 native_set_another_thread_name(target_th->nt->thread_id, name);
3654#if USE_NATIVE_THREAD_NATIVE_THREAD_ID
3678rb_thread_native_thread_id(
VALUE thread)
3681 if (rb_threadptr_dead(target_th))
return Qnil;
3682 return native_thread_native_thread_id(target_th);
3685# define rb_thread_native_thread_id rb_f_notimplement
3696rb_thread_to_s(
VALUE thread)
3703 status = thread_status_name(target_th, TRUE);
3704 str = rb_sprintf(
"#<%"PRIsVALUE
":%p", cname, (
void *)thread);
3705 if (!
NIL_P(target_th->name)) {
3706 rb_str_catf(str,
"@%"PRIsVALUE, target_th->name);
3708 if ((loc = threadptr_invoke_proc_location(target_th)) !=
Qnil) {
3709 rb_str_catf(str,
" %"PRIsVALUE
":%"PRIsVALUE,
3712 rb_str_catf(str,
" %s>", status);
3718#define recursive_key id__recursive_key__
3723 if (
id == recursive_key) {
3724 return th->ec->local_storage_recursive_hash;
3728 struct rb_id_table *local_storage = th->ec->local_storage;
3730 if (local_storage != NULL && rb_id_table_lookup(local_storage,
id, &val)) {
3742 return threadptr_local_aref(rb_thread_ptr(thread),
id);
3809 if (!
id)
return Qnil;
3827rb_thread_fetch(
int argc,
VALUE *argv,
VALUE self)
3838 if (block_given && argc == 2) {
3839 rb_warn(
"block supersedes default value argument");
3844 if (
id == recursive_key) {
3845 return target_th->ec->local_storage_recursive_hash;
3847 else if (
id && target_th->ec->local_storage &&
3848 rb_id_table_lookup(target_th->ec->local_storage,
id, &val)) {
3851 else if (block_given) {
3854 else if (argc == 1) {
3855 rb_key_err_raise(rb_sprintf(
"key not found: %+"PRIsVALUE, key), self, key);
3865 if (
id == recursive_key) {
3866 th->ec->local_storage_recursive_hash = val;
3870 struct rb_id_table *local_storage = th->ec->local_storage;
3873 if (!local_storage)
return Qnil;
3874 rb_id_table_delete(local_storage,
id);
3878 if (local_storage == NULL) {
3879 th->ec->local_storage = local_storage = rb_id_table_create(0);
3881 rb_id_table_insert(local_storage,
id, val);
3894 return threadptr_local_aset(rb_thread_ptr(thread),
id, val);
3945rb_thread_variable_get(
VALUE thread,
VALUE key)
3950 if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) {
3953 locals = rb_thread_local_storage(thread);
3954 return rb_hash_aref(locals, symbol);
3975 locals = rb_thread_local_storage(thread);
3997 struct rb_id_table *local_storage = rb_thread_ptr(self)->ec->local_storage;
3999 if (!
id || local_storage == NULL) {
4002 return RBOOL(rb_id_table_lookup(local_storage,
id, &val));
4005static enum rb_id_table_iterator_result
4006thread_keys_i(
ID key,
VALUE value,
void *ary)
4009 return ID_TABLE_CONTINUE;
4016 return rb_ractor_living_thread_num(GET_RACTOR()) == 1;
4034rb_thread_keys(
VALUE self)
4036 struct rb_id_table *local_storage = rb_thread_ptr(self)->ec->local_storage;
4039 if (local_storage) {
4040 rb_id_table_foreach(local_storage, thread_keys_i, (
void *)ary);
4070rb_thread_variables(
VALUE thread)
4076 if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) {
4079 locals = rb_thread_local_storage(thread);
4107 if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) {
4110 locals = rb_thread_local_storage(thread);
4112 return RBOOL(rb_hash_lookup(locals, symbol) !=
Qnil);
4131rb_thread_priority(
VALUE thread)
4133 return INT2NUM(rb_thread_ptr(thread)->priority);
4164rb_thread_priority_set(
VALUE thread,
VALUE prio)
4169#if USE_NATIVE_THREAD_PRIORITY
4170 target_th->priority =
NUM2INT(prio);
4171 native_thread_apply_priority(th);
4174 if (priority > RUBY_THREAD_PRIORITY_MAX) {
4175 priority = RUBY_THREAD_PRIORITY_MAX;
4177 else if (priority < RUBY_THREAD_PRIORITY_MIN) {
4178 priority = RUBY_THREAD_PRIORITY_MIN;
4180 target_th->priority = (int8_t)priority;
4182 return INT2NUM(target_th->priority);
4187#if defined(NFDBITS) && defined(HAVE_RB_FD_INIT)
4223 FD_ZERO(fds->
fdset);
4229 size_t size = howmany(
rb_fd_max(src), NFDBITS) *
sizeof(fd_mask);
4231 if (size <
sizeof(fd_set))
4232 size =
sizeof(fd_set);
4256 size_t m = howmany(n + 1, NFDBITS) *
sizeof(fd_mask);
4257 size_t o = howmany(fds->
maxfd, NFDBITS) *
sizeof(fd_mask);
4259 if (m <
sizeof(fd_set)) m =
sizeof(fd_set);
4260 if (o <
sizeof(fd_set)) o =
sizeof(fd_set);
4264 memset((
char *)fds->
fdset + o, 0, m - o);
4273 FD_SET(n, fds->
fdset);
4279 if (n >= fds->
maxfd)
return;
4280 FD_CLR(n, fds->
fdset);
4286 if (n >= fds->
maxfd)
return 0;
4287 return FD_ISSET(n, fds->
fdset) != 0;
4293 size_t size = howmany(max, NFDBITS) *
sizeof(fd_mask);
4295 if (size <
sizeof(fd_set)) size =
sizeof(fd_set);
4298 memcpy(dst->
fdset, src, size);
4304 size_t size = howmany(
rb_fd_max(src), NFDBITS) *
sizeof(fd_mask);
4306 if (size <
sizeof(fd_set))
4307 size =
sizeof(fd_set);
4316 fd_set *r = NULL, *w = NULL, *e = NULL;
4329 return select(n, r, w, e, timeout);
4332#define rb_fd_no_init(fds) ((void)((fds)->fdset = 0), (void)((fds)->maxfd = 0))
4339#define FD_ZERO(f) rb_fd_zero(f)
4340#define FD_SET(i, f) rb_fd_set((i), (f))
4341#define FD_CLR(i, f) rb_fd_clr((i), (f))
4342#define FD_ISSET(i, f) rb_fd_isset((i), (f))
4344#elif defined(_WIN32)
4349 set->
capa = FD_SETSIZE;
4351 FD_ZERO(set->
fdset);
4373 SOCKET s = rb_w32_get_osfhandle(fd);
4375 for (i = 0; i < set->
fdset->fd_count; i++) {
4376 if (set->
fdset->fd_array[i] == s) {
4380 if (set->
fdset->fd_count >= (
unsigned)set->
capa) {
4381 set->
capa = (set->
fdset->fd_count / FD_SETSIZE + 1) * FD_SETSIZE;
4383 rb_xrealloc_mul_add(
4384 set->
fdset, set->
capa,
sizeof(SOCKET),
sizeof(
unsigned int));
4386 set->
fdset->fd_array[set->
fdset->fd_count++] = s;
4394#define FD_ZERO(f) rb_fd_zero(f)
4395#define FD_SET(i, f) rb_fd_set((i), (f))
4396#define FD_CLR(i, f) rb_fd_clr((i), (f))
4397#define FD_ISSET(i, f) rb_fd_isset((i), (f))
4399#define rb_fd_no_init(fds) (void)((fds)->fdset = 0)
4403#ifndef rb_fd_no_init
4404#define rb_fd_no_init(fds) (void)(fds)
4408wait_retryable(
volatile int *result,
int errnum, rb_hrtime_t *rel, rb_hrtime_t end)
4418 if (rel && hrtime_update_expire(rel, end)) {
4428 return !hrtime_update_expire(rel, end);
4448select_set_free(
VALUE p)
4463 volatile int result = 0;
4465 rb_hrtime_t *to, rel, end = 0;
4467 timeout_prepare(&to, &rel, &end, set->timeout);
4468 volatile rb_hrtime_t endtime = end;
4469#define restore_fdset(dst, src) \
4470 ((dst) ? rb_fd_dup(dst, src) : (void)0)
4471#define do_select_update() \
4472 (restore_fdset(set->rset, &set->orig_rset), \
4473 restore_fdset(set->wset, &set->orig_wset), \
4474 restore_fdset(set->eset, &set->orig_eset), \
4480 BLOCKING_REGION(set->th, {
4483 if (!RUBY_VM_INTERRUPTED(set->th->ec)) {
4484 result = native_fd_select(set->max,
4485 set->rset, set->wset, set->eset,
4486 rb_hrtime2timeval(&tv, to), set->th);
4487 if (result < 0) lerrno = errno;
4489 }, ubf_select, set->th, TRUE);
4491 RUBY_VM_CHECK_INTS_BLOCKING(set->th->ec);
4492 }
while (wait_retryable(&result, lerrno, to, endtime) && do_select_update());
4494 RUBY_VM_CHECK_INTS_BLOCKING(set->th->ec);
4500 return (
VALUE)result;
4509 set.th = GET_THREAD();
4510 RUBY_VM_CHECK_INTS_BLOCKING(set.th->ec);
4515 set.timeout = timeout;
4517 if (!set.rset && !set.wset && !set.eset) {
4526#define fd_init_copy(f) do { \
4528 rb_fd_resize(set.max - 1, set.f); \
4529 if (&set.orig_##f != set.f) { \
4530 rb_fd_init_copy(&set.orig_##f, set.f); \
4534 rb_fd_no_init(&set.orig_##f); \
4548#define POLLIN_SET (POLLRDNORM | POLLRDBAND | POLLIN | POLLHUP | POLLERR)
4549#define POLLOUT_SET (POLLWRBAND | POLLWRNORM | POLLOUT | POLLERR)
4550#define POLLEX_SET (POLLPRI)
4553# define POLLERR_SET (0)
4557wait_for_single_fd_blocking_region(
rb_thread_t *th,
struct pollfd *fds, nfds_t nfds,
4558 rb_hrtime_t *
const to,
volatile int *lerrno)
4561 volatile int result = 0;
4564 BLOCKING_REGION(th, {
4565 if (!RUBY_VM_INTERRUPTED(th->ec)) {
4566 result = ppoll(fds, nfds, rb_hrtime2timespec(&ts, to), 0);
4567 if (result < 0) *lerrno = errno;
4569 }, ubf_select, th, TRUE);
4577thread_io_wait(
struct rb_io *io,
int fd,
int events,
struct timeval *timeout)
4579 struct pollfd fds[1] = {{
4581 .events = (short)events,
4584 volatile int result = 0;
4587 enum ruby_tag_type state;
4588 volatile int lerrno;
4594 blocking_operation.ec = ec;
4595 rb_io_blocking_operation_enter(io, &blocking_operation);
4598 if (timeout == NULL && thread_io_wait_events(th, fd, events, NULL)) {
4601 fds[0].revents = events;
4606 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
4607 rb_hrtime_t *to, rel, end = 0;
4608 RUBY_VM_CHECK_INTS_BLOCKING(ec);
4609 timeout_prepare(&to, &rel, &end, timeout);
4611 nfds = numberof(fds);
4612 result = wait_for_single_fd_blocking_region(th, fds, nfds, to, &lerrno);
4614 RUBY_VM_CHECK_INTS_BLOCKING(ec);
4615 }
while (wait_retryable(&result, lerrno, to, end));
4617 RUBY_VM_CHECK_INTS_BLOCKING(ec);
4624 rb_io_blocking_operation_exit(io, &blocking_operation);
4628 EC_JUMP_TAG(ec, state);
4636 if (fds[0].revents & POLLNVAL) {
4646 if (fds[0].revents & POLLIN_SET)
4647 result |= RB_WAITFD_IN;
4648 if (fds[0].revents & POLLOUT_SET)
4649 result |= RB_WAITFD_OUT;
4650 if (fds[0].revents & POLLEX_SET)
4651 result |= RB_WAITFD_PRI;
4654 if (fds[0].revents & POLLERR_SET)
4675select_single(
VALUE ptr)
4681 args->read, args->write, args->except, args->tv);
4683 args->as.error =
errno;
4686 if (args->read &&
rb_fd_isset(args->as.fd, args->read))
4688 if (args->write &&
rb_fd_isset(args->as.fd, args->write))
4690 if (args->except &&
rb_fd_isset(args->as.fd, args->except))
4697select_single_cleanup(
VALUE ptr)
4701 if (args->blocking_operation) {
4702 rb_io_blocking_operation_exit(args->io, args->blocking_operation);
4725thread_io_wait(
struct rb_io *io,
int fd,
int events,
struct timeval *timeout)
4734 blocking_operation.ec = GET_EC();
4735 rb_io_blocking_operation_enter(io, &blocking_operation);
4736 args.blocking_operation = &blocking_operation;
4740 blocking_operation.ec = NULL;
4741 args.blocking_operation = NULL;
4745 args.read = (events & RB_WAITFD_IN) ? init_set_fd(fd, &rfds) : NULL;
4746 args.write = (events & RB_WAITFD_OUT) ? init_set_fd(fd, &wfds) : NULL;
4747 args.except = (events & RB_WAITFD_PRI) ? init_set_fd(fd, &efds) : NULL;
4750 int result = (int)
rb_ensure(select_single, ptr, select_single_cleanup, ptr);
4752 errno = args.as.error;
4759rb_thread_wait_for_single_fd(
int fd,
int events,
struct timeval *timeout)
4761 return thread_io_wait(NULL, fd, events, timeout);
4765rb_thread_io_wait(
struct rb_io *io,
int events,
struct timeval * timeout)
4767 return thread_io_wait(io, io->
fd, events, timeout);
4774#ifdef USE_CONSERVATIVE_STACK_END
4776rb_gc_set_stack_end(
VALUE **stack_end_p)
4779COMPILER_WARNING_PUSH
4780#if RBIMPL_COMPILER_IS(GCC)
4781COMPILER_WARNING_IGNORED(-Wdangling-pointer);
4783 *stack_end_p = &stack_end;
4796 if (rb_signal_buff_size() > 0) {
4798 threadptr_trap_interrupt(mth);
4803async_bug_fd(
const char *mesg,
int errno_arg,
int fd)
4806 size_t n = strlcpy(buff, mesg,
sizeof(buff));
4807 if (n <
sizeof(buff)-3) {
4810 rb_async_bug_errno(buff, errno_arg);
4815consume_communication_pipe(
int fd)
4821 static char buff[1024];
4827 result = read(fd, buff,
sizeof(buff));
4829 RUBY_DEBUG_LOG(
"resultf:%d buff:%lu", (
int)result, (
unsigned long)buff[0]);
4831 RUBY_DEBUG_LOG(
"result:%d", (
int)result);
4835 if (USE_EVENTFD || result < (ssize_t)
sizeof(buff)) {
4839 else if (result == 0) {
4842 else if (result < 0) {
4848#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
4853 async_bug_fd(
"consume_communication_pipe: read", e, fd);
4860rb_thread_stop_timer_thread(
void)
4862 if (TIMER_THREAD_CREATED_P() && native_stop_timer_thread()) {
4863 native_reset_timer_thread();
4868rb_thread_reset_timer_thread(
void)
4870 native_reset_timer_thread();
4874rb_thread_start_timer_thread(
void)
4877 rb_thread_create_timer_thread();
4881clear_coverage_i(st_data_t key, st_data_t val, st_data_t dummy)
4889 if (GET_VM()->coverage_mode & COVERAGE_TARGET_ONESHOT_LINES) {
4911rb_clear_coverages(
void)
4913 VALUE coverages = rb_get_coverages();
4914 if (
RTEST(coverages)) {
4919#if defined(HAVE_WORKING_FORK)
4927 vm->ractor.main_ractor = r;
4928 vm->ractor.main_thread = th;
4929 r->threads.main = th;
4930 r->status_ = ractor_created;
4932 thread_sched_atfork(TH_SCHED(th));
4937 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
4938 if (r != vm->ractor.main_ractor) {
4939 rb_ractor_terminate_atfork(vm, r);
4941 ccan_list_for_each(&r->threads.set, i, lt_node) {
4945 rb_vm_living_threads_init(vm);
4947 rb_ractor_atfork(vm, th);
4948 rb_vm_postponed_job_atfork();
4952 ccan_list_head_init(&th->interrupt_exec_tasks);
4955 rb_ractor_sleeper_threads_clear(th->ractor);
4956 rb_clear_coverages();
4959 rb_thread_reset_timer_thread();
4960 rb_thread_start_timer_thread();
4962 VM_ASSERT(vm->ractor.blocking_cnt == 0);
4963 VM_ASSERT(vm->ractor.cnt == 1);
4969 if (th != current_th) {
4971 rb_mutex_abandon_keeping_mutexes(th);
4972 rb_mutex_abandon_locking_mutex(th);
4973 thread_cleanup_func(th, TRUE);
4982 rb_threadptr_pending_interrupt_clear(th);
4983 rb_thread_atfork_internal(th, terminate_atfork_i);
4984 th->join_list = NULL;
4985 rb_fiber_atfork(th);
4994 if (th != current_th) {
4995 thread_cleanup_func_before_exec(th);
5003 rb_thread_atfork_internal(th, terminate_atfork_before_exec_i);
5028 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE
5051thgroup_s_alloc(
VALUE klass)
5072thgroup_list(
VALUE group)
5078 ccan_list_for_each(&r->threads.set, th, lt_node) {
5079 if (th->thgroup == group) {
5104thgroup_enclose(
VALUE group)
5123thgroup_enclosed_p(
VALUE group)
5128 return RBOOL(data->enclosed);
5168 if (data->enclosed) {
5176 if (data->enclosed) {
5178 "can't move from the enclosed thread group");
5181 target_th->thgroup = group;
5189thread_shield_mark(
void *ptr)
5191 rb_gc_mark((
VALUE)ptr);
5196 {thread_shield_mark, 0, 0,},
5197 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
5201thread_shield_alloc(
VALUE klass)
5206#define GetThreadShieldPtr(obj) ((VALUE)rb_check_typeddata((obj), &thread_shield_data_type))
5207#define THREAD_SHIELD_WAITING_MASK (((FL_USER19-1)&~(FL_USER0-1))|FL_USER19)
5208#define THREAD_SHIELD_WAITING_SHIFT (FL_USHIFT)
5209#define THREAD_SHIELD_WAITING_MAX (THREAD_SHIELD_WAITING_MASK>>THREAD_SHIELD_WAITING_SHIFT)
5210STATIC_ASSERT(THREAD_SHIELD_WAITING_MAX, THREAD_SHIELD_WAITING_MAX <= UINT_MAX);
5211static inline unsigned int
5212rb_thread_shield_waiting(
VALUE b)
5214 return ((
RBASIC(b)->flags&THREAD_SHIELD_WAITING_MASK)>>THREAD_SHIELD_WAITING_SHIFT);
5218rb_thread_shield_waiting_inc(
VALUE b)
5220 unsigned int w = rb_thread_shield_waiting(b);
5222 if (w > THREAD_SHIELD_WAITING_MAX)
5224 RBASIC(b)->flags &= ~THREAD_SHIELD_WAITING_MASK;
5225 RBASIC(b)->flags |= ((
VALUE)w << THREAD_SHIELD_WAITING_SHIFT);
5229rb_thread_shield_waiting_dec(
VALUE b)
5231 unsigned int w = rb_thread_shield_waiting(b);
5234 RBASIC(b)->flags &= ~THREAD_SHIELD_WAITING_MASK;
5235 RBASIC(b)->flags |= ((
VALUE)w << THREAD_SHIELD_WAITING_SHIFT);
5239rb_thread_shield_new(
void)
5241 VALUE thread_shield = thread_shield_alloc(rb_cThreadShield);
5243 return thread_shield;
5247rb_thread_shield_owned(
VALUE self)
5249 VALUE mutex = GetThreadShieldPtr(self);
5250 if (!mutex)
return false;
5254 return m->fiber == GET_EC()->fiber_ptr;
5266rb_thread_shield_wait(
VALUE self)
5268 VALUE mutex = GetThreadShieldPtr(self);
5271 if (!mutex)
return Qfalse;
5272 m = mutex_ptr(mutex);
5273 if (m->fiber == GET_EC()->fiber_ptr)
return Qnil;
5274 rb_thread_shield_waiting_inc(self);
5276 rb_thread_shield_waiting_dec(self);
5279 return rb_thread_shield_waiting(self) > 0 ?
Qnil :
Qfalse;
5283thread_shield_get_mutex(
VALUE self)
5285 VALUE mutex = GetThreadShieldPtr(self);
5287 rb_raise(
rb_eThreadError,
"destroyed thread shield - %p", (
void *)self);
5295rb_thread_shield_release(
VALUE self)
5297 VALUE mutex = thread_shield_get_mutex(self);
5299 return RBOOL(rb_thread_shield_waiting(self) > 0);
5306rb_thread_shield_destroy(
VALUE self)
5308 VALUE mutex = thread_shield_get_mutex(self);
5311 return RBOOL(rb_thread_shield_waiting(self) > 0);
5317 return th->ec->local_storage_recursive_hash;
5323 th->ec->local_storage_recursive_hash = hash;
5335recursive_list_access(
VALUE sym)
5338 VALUE hash = threadptr_recursive_hash(th);
5341 hash = rb_ident_hash_new();
5342 threadptr_recursive_hash_set(th, hash);
5346 list = rb_hash_aref(hash, sym);
5349 list = rb_ident_hash_new();
5350 rb_hash_aset(hash, sym, list);
5364#if SIZEOF_LONG == SIZEOF_VOIDP
5365 #define OBJ_ID_EQL(obj_id, other) ((obj_id) == (other))
5366#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
5367 #define OBJ_ID_EQL(obj_id, other) (RB_BIGNUM_TYPE_P((obj_id)) ? \
5368 rb_big_eql((obj_id), (other)) : ((obj_id) == (other)))
5371 VALUE pair_list = rb_hash_lookup2(list, obj,
Qundef);
5372 if (UNDEF_P(pair_list))
5374 if (paired_obj_id) {
5376 if (!OBJ_ID_EQL(paired_obj_id, pair_list))
5380 if (
NIL_P(rb_hash_lookup(pair_list, paired_obj_id)))
5402 rb_hash_aset(list, obj,
Qtrue);
5404 else if (UNDEF_P(pair_list = rb_hash_lookup2(list, obj,
Qundef))) {
5405 rb_hash_aset(list, obj, paired_obj);
5409 VALUE other_paired_obj = pair_list;
5410 pair_list = rb_hash_new();
5411 rb_hash_aset(pair_list, other_paired_obj,
Qtrue);
5412 rb_hash_aset(list, obj, pair_list);
5414 rb_hash_aset(pair_list, paired_obj,
Qtrue);
5430 VALUE pair_list = rb_hash_lookup2(list, obj,
Qundef);
5431 if (UNDEF_P(pair_list)) {
5435 rb_hash_delete_entry(pair_list, paired_obj);
5441 rb_hash_delete_entry(list, obj);
5457 return (*p->func)(p->obj, p->arg, FALSE);
5478 p.list = recursive_list_access(sym);
5482 outermost = outer && !recursive_check(p.list,
ID2SYM(recursive_key), 0);
5484 if (recursive_check(p.list, p.obj, pairid)) {
5485 if (outer && !outermost) {
5488 return (*func)(obj, arg, TRUE);
5491 enum ruby_tag_type state;
5496 recursive_push(p.list,
ID2SYM(recursive_key), 0);
5497 recursive_push(p.list, p.obj, p.pairid);
5498 result = rb_catch_protect(p.list, exec_recursive_i, (
VALUE)&p, &state);
5499 if (!recursive_pop(p.list, p.obj, p.pairid))
goto invalid;
5500 if (!recursive_pop(p.list,
ID2SYM(recursive_key), 0))
goto invalid;
5501 if (state != TAG_NONE) EC_JUMP_TAG(GET_EC(), state);
5502 if (result == p.list) {
5503 result = (*func)(obj, arg, TRUE);
5508 recursive_push(p.list, p.obj, p.pairid);
5509 EC_PUSH_TAG(GET_EC());
5510 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
5511 ret = (*func)(obj, arg, FALSE);
5514 if (!recursive_pop(p.list, p.obj, p.pairid)) {
5517 if (state != TAG_NONE) EC_JUMP_TAG(GET_EC(), state);
5526 "for %+"PRIsVALUE
" in %+"PRIsVALUE,
5550 return exec_recursive(func, obj, rb_memory_id(paired_obj), arg, 0,
rb_frame_last_func());
5568 return exec_recursive(func, obj, 0, arg, 1, mid);
5580 return exec_recursive(func, obj, rb_memory_id(paired_obj), arg, 1,
rb_frame_last_func());
5592rb_thread_backtrace_m(
int argc,
VALUE *argv,
VALUE thval)
5594 return rb_vm_thread_backtrace(argc, argv, thval);
5609rb_thread_backtrace_locations_m(
int argc,
VALUE *argv,
VALUE thval)
5611 return rb_vm_thread_backtrace_locations(argc, argv, thval);
5615Init_Thread_Mutex(
void)
5704 rb_vm_register_special_exception(ruby_error_stream_closed,
rb_eIOError,
5705 "stream closed in another thread");
5714 const char * ptr = getenv(
"RUBY_THREAD_TIMESLICE");
5717 long quantum = strtol(ptr, NULL, 0);
5718 if (quantum > 0 && !(SIZEOF_LONG > 4 && quantum > UINT32_MAX)) {
5719 thread_default_quantum_ms = (uint32_t)quantum;
5722 fprintf(stderr,
"Ignored RUBY_THREAD_TIMESLICE=%s\n", ptr);
5727 th->thgroup = th->ractor->thgroup_default =
rb_obj_alloc(cThGroup);
5728 rb_define_const(cThGroup,
"Default", th->thgroup);
5738#ifdef HAVE_PTHREAD_NP_H
5739 VM_ASSERT(TH_SCHED(th)->running == th);
5746 th->pending_interrupt_queue_checked = 0;
5751 rb_thread_create_timer_thread();
5767#ifdef NON_SCALAR_THREAD_ID
5768 #define thread_id_str(th) (NULL)
5770 #define thread_id_str(th) ((void *)(uintptr_t)(th)->nt->thread_id)
5779 rb_str_catf(msg,
"\n%d threads, %d sleeps current:%p main thread:%p\n",
5780 rb_ractor_living_thread_num(r), rb_ractor_sleeper_thread_num(r),
5781 (
void *)GET_THREAD(), (
void *)r->threads.main);
5783 ccan_list_for_each(&r->threads.set, th, lt_node) {
5784 rb_str_catf(msg,
"* %+"PRIsVALUE
"\n rb_thread_t:%p "
5786 th->self, (
void *)th, th->nt ? thread_id_str(th) :
"N/A", th->ec->interrupt_flag);
5788 if (th->locking_mutex) {
5789 rb_mutex_t *mutex = mutex_ptr(th->locking_mutex);
5790 rb_str_catf(msg,
" mutex:%p cond:%"PRIuSIZE,
5791 (
void *)mutex->fiber, rb_mutex_num_waiting(mutex));
5797 rb_str_catf(msg,
"\n depended by: tb_thread_id:%p", (
void *)list->thread);
5801 rb_str_catf(msg,
"\n ");
5802 rb_str_concat(msg,
rb_ary_join(rb_ec_backtrace_str_ary(th->ec, RUBY_BACKTRACE_START, RUBY_ALL_BACKTRACE_LINES), sep));
5803 rb_str_catf(msg,
"\n");
5810 if (GET_THREAD()->vm->thread_ignore_deadlock)
return;
5812#ifdef RUBY_THREAD_PTHREAD_H
5813 if (r->threads.sched.readyq_cnt > 0)
return;
5816 int sleeper_num = rb_ractor_sleeper_thread_num(r);
5817 int ltnum = rb_ractor_living_thread_num(r);
5819 if (ltnum > sleeper_num)
return;
5820 if (ltnum < sleeper_num) rb_bug(
"sleeper must not be more than vm_living_thread_num(vm)");
5825 ccan_list_for_each(&r->threads.set, th, lt_node) {
5826 if (th->status != THREAD_STOPPED_FOREVER || RUBY_VM_INTERRUPTED(th->ec)) {
5829 else if (th->locking_mutex) {
5830 rb_mutex_t *mutex = mutex_ptr(th->locking_mutex);
5831 if (mutex->fiber == th->ec->fiber_ptr || (!mutex->fiber && !ccan_list_empty(&mutex->waitq))) {
5842 argv[1] =
rb_str_new2(
"No live threads left. Deadlock?");
5843 debug_deadlock_check(r, argv[1]);
5844 rb_ractor_sleeper_threads_dec(GET_RACTOR());
5845 rb_threadptr_raise(r->threads.main, 2, argv);
5853 VALUE coverage = rb_iseq_coverage(cfp->iseq);
5858 VM_ASSERT(line >= 0);
5862 if (GET_VM()->coverage_mode & COVERAGE_TARGET_ONESHOT_LINES) {
5863 rb_iseq_clear_event_flags(cfp->iseq, cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded - 1, RUBY_EVENT_COVERAGE_LINE);
5884 VALUE coverage = rb_iseq_coverage(cfp->iseq);
5888 long pc = cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded - 1;
5903 VALUE path, beg_pos_lineno, beg_pos_column, end_pos_lineno, end_pos_column;
5905 if (!me->def)
return NULL;
5908 switch (me->def->type) {
5909 case VM_METHOD_TYPE_ISEQ: {
5912 path = rb_iseq_path(iseq);
5913 beg_pos_lineno =
INT2FIX(loc->code_location.beg_pos.lineno);
5914 beg_pos_column =
INT2FIX(loc->code_location.beg_pos.column);
5915 end_pos_lineno =
INT2FIX(loc->code_location.end_pos.lineno);
5916 end_pos_column =
INT2FIX(loc->code_location.end_pos.column);
5919 case VM_METHOD_TYPE_BMETHOD: {
5920 const rb_iseq_t *iseq = rb_proc_get_iseq(me->def->body.bmethod.proc, 0);
5923 rb_iseq_check(iseq);
5924 path = rb_iseq_path(iseq);
5925 loc = &ISEQ_BODY(iseq)->location;
5926 beg_pos_lineno =
INT2FIX(loc->code_location.beg_pos.lineno);
5927 beg_pos_column =
INT2FIX(loc->code_location.beg_pos.column);
5928 end_pos_lineno =
INT2FIX(loc->code_location.end_pos.lineno);
5929 end_pos_column =
INT2FIX(loc->code_location.end_pos.column);
5934 case VM_METHOD_TYPE_ALIAS:
5935 me = me->def->body.alias.original_me;
5937 case VM_METHOD_TYPE_REFINED:
5938 me = me->def->body.refined.orig_me;
5939 if (!me)
return NULL;
5950 if (resolved_location) {
5951 resolved_location[0] = path;
5952 resolved_location[1] = beg_pos_lineno;
5953 resolved_location[2] = beg_pos_column;
5954 resolved_location[3] = end_pos_lineno;
5955 resolved_location[4] = end_pos_column;
5969 me = rb_resolve_me_location(me, 0);
5972 rcount = rb_hash_aref(me2counter, (
VALUE) me);
5980rb_get_coverages(
void)
5982 return GET_VM()->coverages;
5986rb_get_coverage_mode(
void)
5988 return GET_VM()->coverage_mode;
5992rb_set_coverages(
VALUE coverages,
int mode,
VALUE me2counter)
5994 GET_VM()->coverages = coverages;
5995 GET_VM()->me2counter = me2counter;
5996 GET_VM()->coverage_mode = mode;
6000rb_resume_coverages(
void)
6002 int mode = GET_VM()->coverage_mode;
6003 VALUE me2counter = GET_VM()->me2counter;
6004 rb_add_event_hook2((
rb_event_hook_func_t) update_line_coverage, RUBY_EVENT_COVERAGE_LINE,
Qnil, RUBY_EVENT_HOOK_FLAG_SAFE | RUBY_EVENT_HOOK_FLAG_RAW_ARG);
6005 if (mode & COVERAGE_TARGET_BRANCHES) {
6006 rb_add_event_hook2((
rb_event_hook_func_t) update_branch_coverage, RUBY_EVENT_COVERAGE_BRANCH,
Qnil, RUBY_EVENT_HOOK_FLAG_SAFE | RUBY_EVENT_HOOK_FLAG_RAW_ARG);
6008 if (mode & COVERAGE_TARGET_METHODS) {
6014rb_suspend_coverages(
void)
6017 if (GET_VM()->coverage_mode & COVERAGE_TARGET_BRANCHES) {
6020 if (GET_VM()->coverage_mode & COVERAGE_TARGET_METHODS) {
6027rb_reset_coverages(
void)
6029 rb_clear_coverages();
6030 rb_iseq_remove_coverage_all();
6031 GET_VM()->coverages =
Qfalse;
6035rb_default_coverage(
int n)
6037 VALUE coverage = rb_ary_hidden_new_fill(3);
6039 int mode = GET_VM()->coverage_mode;
6041 if (mode & COVERAGE_TARGET_LINES) {
6044 RARRAY_ASET(coverage, COVERAGE_INDEX_LINES, lines);
6046 if (mode & COVERAGE_TARGET_BRANCHES) {
6047 branches = rb_ary_hidden_new_fill(2);
6069 VALUE structure = rb_hash_new();
6075 RARRAY_ASET(coverage, COVERAGE_INDEX_BRANCHES, branches);
6081uninterruptible_exit(
VALUE v)
6084 rb_ary_pop(cur_th->pending_interrupt_mask_stack);
6086 cur_th->pending_interrupt_queue_checked = 0;
6087 if (!rb_threadptr_pending_interrupt_empty_p(cur_th)) {
6088 RUBY_VM_SET_INTERRUPT(cur_th->ec);
6096 VALUE interrupt_mask = rb_ident_hash_new();
6099 rb_hash_aset(interrupt_mask, rb_cObject, sym_never);
6101 rb_ary_push(cur_th->pending_interrupt_mask_stack, interrupt_mask);
6105 RUBY_VM_CHECK_INTS(cur_th->ec);
6112 VM_ASSERT(th->specific_storage == NULL);
6114 if (UNLIKELY(specific_key_count > 0)) {
6115 th->specific_storage =
ZALLOC_N(
void *, RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX);
6119rb_internal_thread_specific_key_t
6124 if (specific_key_count == 0 && vm->ractor.cnt > 1) {
6125 rb_raise(
rb_eThreadError,
"The first rb_internal_thread_specific_key_create() is called with multiple ractors");
6127 else if (specific_key_count > RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX) {
6128 rb_raise(
rb_eThreadError,
"rb_internal_thread_specific_key_create() is called more than %d times", RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX);
6131 rb_internal_thread_specific_key_t key = specific_key_count++;
6138 ccan_list_for_each(&cr->threads.set, th, lt_node) {
6139 thread_specific_storage_alloc(th);
6152 VM_ASSERT(rb_thread_ptr(thread_val) == th);
6153 VM_ASSERT(key < RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX);
6154 VM_ASSERT(th->specific_storage);
6156 return th->specific_storage[key];
6165 VM_ASSERT(rb_thread_ptr(thread_val) == th);
6166 VM_ASSERT(key < RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX);
6167 VM_ASSERT(th->specific_storage);
6169 th->specific_storage[key] = data;
6175 struct ccan_list_node node;
6177 rb_interrupt_exec_func_t *func;
6179 enum rb_interrupt_exec_flag flags;
6183rb_threadptr_interrupt_exec_task_mark(
rb_thread_t *th)
6187 ccan_list_for_each(&th->interrupt_exec_tasks, task, node) {
6188 if (task->flags & rb_interrupt_exec_flag_value_data) {
6189 rb_gc_mark((
VALUE)task->data);
6197rb_threadptr_interrupt_exec(
rb_thread_t *th, rb_interrupt_exec_func_t *func,
void *data,
enum rb_interrupt_exec_flag flags)
6209 ccan_list_add_tail(&th->interrupt_exec_tasks, &task->node);
6210 threadptr_set_interrupt_locked(th,
true);
6227 RUBY_DEBUG_LOG(
"task:%p", task);
6230 if (task->flags & rb_interrupt_exec_flag_new_thread) {
6234 (*task->func)(task->data);
6262 rb_interrupt_exec_func_t *func,
void *data,
enum rb_interrupt_exec_flag flags)
6264 RUBY_DEBUG_LOG(
"flags:%d", (
int)flags);
6267 rb_threadptr_interrupt_exec(main_th, func, data, flags | rb_interrupt_exec_flag_new_thread);
#define RUBY_ASSERT_ALWAYS(expr,...)
A variant of RUBY_ASSERT that does not interface with RUBY_DEBUG.
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
#define RUBY_INTERNAL_EVENT_SWITCH
Thread switched.
int rb_remove_event_hook(rb_event_hook_func_t func)
Removes the passed function from the list of event hooks.
#define RUBY_EVENT_THREAD_BEGIN
Encountered a new thread.
void(* rb_event_hook_func_t)(rb_event_flag_t evflag, VALUE data, VALUE self, ID mid, VALUE klass)
Type of event hooks.
uint32_t rb_event_flag_t
Represents event(s).
#define RUBY_EVENT_CALL
A method, written in Ruby, is called.
#define RUBY_EVENT_THREAD_END
Encountered an end of a thread.
static void RB_FL_SET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_SET().
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
ID rb_frame_last_func(void)
Returns the ID of the last method in the call stack.
int rb_keyword_given_p(void)
Determines if the current method is given a keyword argument.
int rb_block_given_p(void)
Determines if the current method is given a block.
#define rb_str_new2
Old name of rb_str_new_cstr.
#define ALLOC
Old name of RB_ALLOC.
#define T_STRING
Old name of RUBY_T_STRING.
#define xfree
Old name of ruby_xfree.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
#define xrealloc
Old name of ruby_xrealloc.
#define ID2SYM
Old name of RB_ID2SYM.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
#define CLASS_OF
Old name of rb_class_of.
#define xmalloc
Old name of ruby_xmalloc.
#define LONG2FIX
Old name of RB_INT2FIX.
#define FIX2INT
Old name of RB_FIX2INT.
#define ZALLOC_N
Old name of RB_ZALLOC_N.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define T_HASH
Old name of RUBY_T_HASH.
#define Qtrue
Old name of RUBY_Qtrue.
#define NUM2INT
Old name of RB_NUM2INT.
#define INT2NUM
Old name of RB_INT2NUM.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define FIX2LONG
Old name of RB_FIX2LONG.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
#define T_OBJECT
Old name of RUBY_T_OBJECT.
#define NIL_P
Old name of RB_NIL_P.
#define POSFIXABLE
Old name of RB_POSFIXABLE.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
void ruby_stop(int ex)
Calls ruby_cleanup() and exits the process.
#define ruby_debug
This variable controls whether the interpreter is in debug mode.
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
VALUE rb_eSystemExit
SystemExit exception.
VALUE rb_eIOError
IOError exception.
VALUE rb_eStandardError
StandardError exception.
VALUE rb_eTypeError
TypeError exception.
void rb_frozen_error_raise(VALUE frozen_obj, const char *fmt,...)
Raises an instance of rb_eFrozenError.
VALUE rb_eFatal
fatal exception.
VALUE rb_eRuntimeError
RuntimeError exception.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
VALUE rb_eException
Mother of all exceptions.
VALUE rb_eThreadError
ThreadError exception.
void rb_exit(int status)
Terminates the current execution context.
VALUE rb_eSignal
SignalException exception.
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
VALUE rb_cInteger
Module class.
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_cThread
Thread class.
VALUE rb_cModule
Module class.
double rb_num2dbl(VALUE num)
Converts an instance of rb_cNumeric into C's double.
VALUE rb_obj_is_kind_of(VALUE obj, VALUE klass)
Queries if the given object is an instance (of possibly descendants) of the given class.
VALUE rb_ary_shift(VALUE ary)
Destructively deletes an element from the beginning of the passed array and returns what was deleted.
VALUE rb_ary_dup(VALUE ary)
Duplicates an array.
VALUE rb_ary_delete_at(VALUE ary, long pos)
Destructively removes an element which resides at the specific index of the passed array.
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_ary_pop(VALUE ary)
Destructively deletes an element from the end of the passed array and returns what was deleted.
VALUE rb_ary_hidden_new(long capa)
Allocates a hidden (no class) empty array.
VALUE rb_ary_clear(VALUE ary)
Destructively removes everything form an array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
VALUE rb_ary_entry(VALUE ary, long off)
Queries an element of an array.
VALUE rb_ary_join(VALUE ary, VALUE sep)
Recursively stringises the elements of the passed array, flattens that result, then joins the sequenc...
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
VALUE rb_block_proc(void)
Constructs a Proc object from implicitly passed components.
void rb_reset_random_seed(void)
Resets the RNG behind rb_genrand_int32()/rb_genrand_real().
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
VALUE rb_str_concat(VALUE dst, VALUE src)
Identical to rb_str_append(), except it also accepts an integer as a codepoint.
#define rb_str_cat_cstr(buf, str)
Identical to rb_str_cat(), except it assumes the passed pointer is a pointer to a C string.
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
int rb_thread_interrupted(VALUE thval)
Checks if the thread's execution was recently interrupted.
VALUE rb_thread_local_aref(VALUE thread, ID key)
This badly named function reads from a Fiber local storage.
VALUE rb_mutex_new(void)
Creates a mutex.
VALUE rb_thread_kill(VALUE thread)
Terminates the given thread.
#define RUBY_UBF_IO
A special UBF for blocking IO operations.
VALUE rb_thread_main(void)
Obtains the "main" thread.
VALUE rb_exec_recursive(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h)
"Recursion" API entry point.
void rb_thread_sleep_forever(void)
Blocks indefinitely.
void rb_thread_fd_close(int fd)
This funciton is now a no-op.
void rb_thread_wait_for(struct timeval time)
Identical to rb_thread_sleep(), except it takes struct timeval instead.
VALUE rb_mutex_synchronize(VALUE mutex, VALUE(*func)(VALUE arg), VALUE arg)
Obtains the lock, runs the passed function, and releases the lock when it completes.
VALUE rb_thread_stop(void)
Stops the current thread.
VALUE rb_mutex_sleep(VALUE self, VALUE timeout)
Releases the lock held in the mutex and waits for the period of time; reacquires the lock on wakeup.
VALUE rb_exec_recursive_paired(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE p, VALUE h)
Identical to rb_exec_recursive(), except it checks for the recursion on the ordered pair of { g,...
void rb_unblock_function_t(void *)
This is the type of UBFs.
void rb_thread_atfork_before_exec(void)
:FIXME: situation of this function is unclear.
void rb_thread_check_ints(void)
Checks for interrupts.
VALUE rb_thread_run(VALUE thread)
This is a rb_thread_wakeup() + rb_thread_schedule() combo.
VALUE rb_thread_wakeup(VALUE thread)
Marks a given thread as eligible for scheduling.
VALUE rb_mutex_unlock(VALUE mutex)
Releases the mutex.
VALUE rb_exec_recursive_paired_outer(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE p, VALUE h)
Identical to rb_exec_recursive_outer(), except it checks for the recursion on the ordered pair of { g...
void rb_thread_sleep_deadly(void)
Identical to rb_thread_sleep_forever(), except the thread calling this function is considered "dead" ...
void rb_thread_atfork(void)
A pthread_atfork(3posix)-like API.
VALUE rb_thread_current(void)
Obtains the "current" thread.
int rb_thread_alone(void)
Checks if the thread this function is running is the only thread that is currently alive.
VALUE rb_thread_local_aset(VALUE thread, ID key, VALUE val)
This badly named function writes to a Fiber local storage.
void rb_thread_schedule(void)
Tries to switch to another thread.
#define RUBY_UBF_PROCESS
A special UBF for blocking process operations.
VALUE rb_exec_recursive_outer(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h)
Identical to rb_exec_recursive(), except it calls f for outermost recursion only.
VALUE rb_thread_wakeup_alive(VALUE thread)
Identical to rb_thread_wakeup(), except it doesn't raise on an already killed thread.
VALUE rb_mutex_lock(VALUE mutex)
Attempts to lock the mutex.
void rb_thread_sleep(int sec)
Blocks for the given period of time.
void rb_timespec_now(struct timespec *ts)
Fills the current time into the given struct.
struct timeval rb_time_timeval(VALUE time)
Converts an instance of rb_cTime to a struct timeval that represents the identical point of time.
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
VALUE rb_ivar_get(VALUE obj, ID name)
Identical to rb_iv_get(), except it accepts the name as an ID instead of a C string.
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
void rb_define_alloc_func(VALUE klass, rb_alloc_func_t func)
Sets the allocator function of a class.
int rb_sourceline(void)
Resembles __LINE__.
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
VALUE rb_to_symbol(VALUE name)
Identical to rb_intern_str(), except it generates a dynamic symbol if necessary.
#define RB_IO_POINTER(obj, fp)
Queries the underlying IO pointer.
VALUE rb_eIOTimeoutError
Indicates that a timeout has occurred while performing an IO operation.
#define RB_NOGVL_UBF_ASYNC_SAFE
Passing this flag to rb_nogvl() indicates that the passed UBF is async-signal-safe.
void * rb_internal_thread_specific_get(VALUE thread_val, rb_internal_thread_specific_key_t key)
Get thread and tool specific data.
#define RB_NOGVL_INTR_FAIL
Passing this flag to rb_nogvl() prevents it from checking interrupts.
void rb_internal_thread_specific_set(VALUE thread_val, rb_internal_thread_specific_key_t key, void *data)
Set thread and tool specific data.
rb_internal_thread_specific_key_t rb_internal_thread_specific_key_create(void)
Create a key to store thread specific data.
void * rb_nogvl(void *(*func)(void *), void *data1, rb_unblock_function_t *ubf, void *data2, int flags)
Identical to rb_thread_call_without_gvl(), except it additionally takes "flags" that change the behav...
void * rb_thread_call_with_gvl(void *(*func)(void *), void *data1)
(Re-)acquires the GVL.
#define RB_NOGVL_OFFLOAD_SAFE
Passing this flag to rb_nogvl() indicates that the passed function is safe to offload to a background...
void * rb_thread_call_without_gvl2(void *(*func)(void *), void *data1, rb_unblock_function_t *ubf, void *data2)
Identical to rb_thread_call_without_gvl(), except it does not interface with signals etc.
void * rb_thread_call_without_gvl(void *(*func)(void *), void *data1, rb_unblock_function_t *ubf, void *data2)
Allows the passed function to run in parallel with other Ruby threads.
#define RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg)
Shim for block function parameters.
VALUE rb_yield(VALUE val)
Yields the block.
void rb_throw_obj(VALUE tag, VALUE val)
Identical to rb_throw(), except it allows arbitrary Ruby object to become a tag.
static int rb_fd_max(const rb_fdset_t *f)
It seems this function has no use.
void rb_fd_copy(rb_fdset_t *dst, const fd_set *src, int max)
Destructively overwrites an fdset with another.
void rb_fd_dup(rb_fdset_t *dst, const rb_fdset_t *src)
Identical to rb_fd_copy(), except it copies unlimited number of file descriptors.
void rb_fd_term(rb_fdset_t *f)
Destroys the rb_fdset_t, releasing any memory and resources it used.
static fd_set * rb_fd_ptr(const rb_fdset_t *f)
Raw pointer to fd_set.
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
#define ALLOCA_N(type, n)
#define MEMZERO(p, type, n)
Handy macro to erase a region of memory.
VALUE rb_thread_create(type *q, void *w)
Creates a rb_cThread instance.
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
#define rb_fd_isset
Queries if the given fd is in the rb_fdset_t.
#define rb_fd_select
Waits for multiple file descriptors at once.
#define rb_fd_init
Initialises the :given :rb_fdset_t.
#define rb_fd_set
Sets the given fd to the rb_fdset_t.
#define rb_fd_zero
Clears the given rb_fdset_t.
#define rb_fd_clr
Unsets the given fd from the rb_fdset_t.
#define RARRAY_LEN
Just another name of rb_array_len.
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
static void RARRAY_ASET(VALUE ary, long i, VALUE v)
Assigns an object in an array.
#define RARRAY_AREF(a, i)
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define RBASIC(obj)
Convenient casting macro.
#define RCLASS_SUPER
Just another name of rb_class_get_superclass.
#define DATA_PTR(obj)
Convenient getter macro.
#define RHASH_EMPTY_P(h)
Checks if the hash is empty.
#define StringValueCStr(v)
Identical to StringValuePtr, except it additionally checks for the contents for viability as a C stri...
#define RUBY_TYPED_DEFAULT_FREE
This is a value you can set to rb_data_type_struct::dfree.
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
#define TypedData_Make_Struct(klass, type, data_type, sval)
Identical to TypedData_Wrap_Struct, except it allocates a new data region internally instead of takin...
#define errno
Ractor-aware version of errno.
int ruby_native_thread_p(void)
Queries if the thread which calls this function is a ruby's thread.
int ruby_snprintf(char *str, size_t n, char const *fmt,...)
Our own locale-insensitive version of snprintf(3).
#define RB_PASS_CALLED_KEYWORDS
Pass keywords if current method is called with keywords, useful for argument delegation.
VALUE rb_fiber_scheduler_blocking_operation_wait(VALUE scheduler, void *(*function)(void *), void *data, rb_unblock_function_t *unblock_function, void *data2, int flags, struct rb_fiber_scheduler_blocking_operation_state *state)
Defer the execution of the passed function to the scheduler.
VALUE rb_fiber_scheduler_current(void)
Identical to rb_fiber_scheduler_get(), except it also returns RUBY_Qnil in case of a blocking fiber.
VALUE rb_fiber_scheduler_fiber_interrupt(VALUE scheduler, VALUE fiber, VALUE exception)
Interrupt a fiber by raising an exception.
VALUE rb_fiber_scheduler_block(VALUE scheduler, VALUE blocker, VALUE timeout)
Non-blocking wait for the passed "blocker", which is for instance Thread.join or Mutex....
VALUE rb_fiber_scheduler_set(VALUE scheduler)
Destructively assigns the passed scheduler to that of the current thread that is calling this functio...
VALUE rb_fiber_scheduler_unblock(VALUE scheduler, VALUE blocker, VALUE fiber)
Wakes up a fiber previously blocked using rb_fiber_scheduler_block().
int rb_thread_fd_select(int nfds, rb_fdset_t *rfds, rb_fdset_t *wfds, rb_fdset_t *efds, struct timeval *timeout)
Waits for multiple file descriptors at once.
#define rb_fd_resize(n, f)
Does nothing (defined for compatibility).
static bool RB_TEST(VALUE obj)
Emulates Ruby's "if" statement.
@ RUBY_Qundef
Represents so-called undef.
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
This is the struct that holds necessary info for a struct.
The data structure which wraps the fd_set bitmap used by select(2).
int maxfd
Maximum allowed number of FDs.
fd_set * fdset
File descriptors buffer.
int capa
Maximum allowed number of FDs.
Ruby's IO, metadata and buffers.
VALUE self
The IO's Ruby level counterpart.
struct ccan_list_head blocking_operations
Threads that are performing a blocking operation without the GVL using this IO.
const rb_iseq_t * iseqptr
iseq pointer, should be separated from iseqval
void rb_nativethread_lock_lock(rb_nativethread_lock_t *lock)
Blocks until the current thread obtains a lock.
void rb_native_mutex_lock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_lock.
void rb_native_mutex_initialize(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_initialize.
void rb_native_mutex_unlock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_unlock.
void rb_nativethread_lock_unlock(rb_nativethread_lock_t *lock)
Releases a lock.
void rb_native_mutex_destroy(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_destroy.
void rb_nativethread_lock_initialize(rb_nativethread_lock_t *lock)
Fills the passed lock with an initial value.
void rb_nativethread_lock_destroy(rb_nativethread_lock_t *lock)
Destroys the passed mutex.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.