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/gc.h"
82#include "internal/hash.h"
83#include "internal/io.h"
84#include "internal/object.h"
85#include "internal/proc.h"
87#include "internal/signal.h"
88#include "internal/thread.h"
89#include "internal/time.h"
90#include "internal/warnings.h"
98#include "ractor_core.h"
102#include "ccan/list/list.h"
104#ifndef USE_NATIVE_THREAD_PRIORITY
105#define USE_NATIVE_THREAD_PRIORITY 0
106#define RUBY_THREAD_PRIORITY_MAX 3
107#define RUBY_THREAD_PRIORITY_MIN -3
110static VALUE rb_cThreadShield;
111static VALUE cThGroup;
113static VALUE sym_immediate;
114static VALUE sym_on_blocking;
115static VALUE sym_never;
117static uint32_t thread_default_quantum_ms = 100;
119#define THREAD_LOCAL_STORAGE_INITIALISED FL_USER13
120#define THREAD_LOCAL_STORAGE_INITIALISED_P(th) RB_FL_TEST_RAW((th), THREAD_LOCAL_STORAGE_INITIALISED)
123rb_thread_local_storage(
VALUE thread)
125 if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) {
133 SLEEP_DEADLOCKABLE = 0x01,
134 SLEEP_SPURIOUS_CHECK = 0x02,
135 SLEEP_ALLOW_SPURIOUS = 0x04,
136 SLEEP_NO_CHECKINTS = 0x08,
139static void sleep_forever(
rb_thread_t *th,
unsigned int fl);
140static int sleep_hrtime(
rb_thread_t *, rb_hrtime_t,
unsigned int fl);
142static void rb_thread_sleep_deadly_allow_spurious_wakeup(
VALUE blocker,
VALUE timeout, rb_hrtime_t end);
145static int rb_threadptr_pending_interrupt_empty_p(
const rb_thread_t *th);
146static const char *thread_status_name(
rb_thread_t *th,
int detail);
147static int hrtime_update_expire(rb_hrtime_t *,
const rb_hrtime_t);
148NORETURN(
static void async_bug_fd(
const char *mesg,
int errno_arg,
int fd));
149MAYBE_UNUSED(
static int consume_communication_pipe(
int fd));
152static rb_internal_thread_specific_key_t specific_key_count;
156#define THREAD_SYSTEM_DEPENDENT_IMPLEMENTATION
159 enum rb_thread_status prev_status;
163static void unblock_function_clear(
rb_thread_t *th);
169#define THREAD_BLOCKING_BEGIN(th) do { \
170 struct rb_thread_sched * const sched = TH_SCHED(th); \
171 RB_VM_SAVE_MACHINE_CONTEXT(th); \
172 thread_sched_to_waiting((sched), (th));
174#define THREAD_BLOCKING_END(th) \
175 thread_sched_to_running((sched), (th)); \
176 rb_ractor_thread_switch(th->ractor, th, false); \
180#ifdef HAVE_BUILTIN___BUILTIN_CHOOSE_EXPR_CONSTANT_P
181#define only_if_constant(expr, notconst) __builtin_choose_expr(__builtin_constant_p(expr), (expr), (notconst))
183#define only_if_constant(expr, notconst) (__builtin_constant_p(expr) ? (expr) : (notconst))
186#define only_if_constant(expr, notconst) notconst
188#define BLOCKING_REGION(th, exec, ubf, ubfarg, fail_if_interrupted) do { \
189 struct rb_blocking_region_buffer __region; \
190 if (blocking_region_begin(th, &__region, (ubf), (ubfarg), fail_if_interrupted) || \
192 !only_if_constant(fail_if_interrupted, TRUE)) { \
195 RB_VM_SAVE_MACHINE_CONTEXT(th); \
196 thread_sched_to_waiting(TH_SCHED(th), th); \
198 blocking_region_end(th, &__region); \
206#define RUBY_VM_CHECK_INTS_BLOCKING(ec) vm_check_ints_blocking(ec)
210#ifdef RUBY_ASSERT_CRITICAL_SECTION
211 VM_ASSERT(ruby_assert_critical_section_entered == 0);
216 if (LIKELY(rb_threadptr_pending_interrupt_empty_p(th))) {
217 if (LIKELY(!RUBY_VM_INTERRUPTED_ANY(ec)))
return FALSE;
220 th->pending_interrupt_queue_checked = 0;
221 RUBY_VM_SET_INTERRUPT(ec);
223 return rb_threadptr_execute_interrupts(th, 1);
229 return vm_check_ints_blocking(ec);
237#if defined(HAVE_POLL)
238# if defined(__linux__)
241# if defined(__FreeBSD_version) && __FreeBSD_version >= 1100000
244# define POLLERR_SET (POLLHUP | POLLERR)
249timeout_prepare(rb_hrtime_t **to, rb_hrtime_t *rel, rb_hrtime_t *end,
253 *rel = rb_timeval2hrtime(timeout);
254 *end = rb_hrtime_add(rb_hrtime_now(), *rel);
262MAYBE_UNUSED(NOINLINE(
static int thread_start_func_2(
rb_thread_t *th,
VALUE *stack_start)));
263MAYBE_UNUSED(
static bool th_has_dedicated_nt(
const rb_thread_t *th));
264MAYBE_UNUSED(
static int waitfd_to_waiting_flag(
int wfd_event));
266#include THREAD_IMPL_SRC
273#ifndef BUSY_WAIT_SIGNALS
274# define BUSY_WAIT_SIGNALS (0)
278# define USE_EVENTFD (0)
281#include "thread_sync.c"
311 if (fail_if_interrupted) {
312 if (RUBY_VM_INTERRUPTED_ANY(th->ec)) {
317 RUBY_VM_CHECK_INTS(th->ec);
321 }
while (!th->ec->raised_flag && RUBY_VM_INTERRUPTED_ANY(th->ec) &&
324 VM_ASSERT(th->unblock.func == NULL);
326 th->unblock.func = func;
327 th->unblock.arg = arg;
337 th->unblock.func = 0;
342threadptr_set_interrupt_locked(
rb_thread_t *th,
bool trap)
346 RUBY_DEBUG_LOG(
"th:%u trap:%d", rb_th_serial(th), trap);
349 RUBY_VM_SET_TRAP_INTERRUPT(th->ec);
352 RUBY_VM_SET_INTERRUPT(th->ec);
355 if (th->unblock.func != NULL) {
356 (th->unblock.func)(th->unblock.arg);
368 threadptr_set_interrupt_locked(th, trap);
377 RUBY_DEBUG_LOG(
"th:%u", rb_th_serial(th));
378 threadptr_set_interrupt(th,
false);
384 threadptr_set_interrupt(th,
true);
392 ccan_list_for_each(&r->threads.set, th, lt_node) {
393 if (th != main_thread) {
394 RUBY_DEBUG_LOG(
"terminate start th:%u status:%s", rb_th_serial(th), thread_status_name(th, TRUE));
396 rb_threadptr_pending_interrupt_enque(th, RUBY_FATAL_THREAD_TERMINATED);
397 rb_threadptr_interrupt(th);
399 RUBY_DEBUG_LOG(
"terminate done th:%u status:%s", rb_th_serial(th), thread_status_name(th, TRUE));
402 RUBY_DEBUG_LOG(
"main thread th:%u", rb_th_serial(th));
410 while (thread->join_list) {
414 thread->join_list = join_list->next;
418 if (target_thread->scheduler !=
Qnil && join_list->fiber) {
422 rb_threadptr_interrupt(target_thread);
424 switch (target_thread->status) {
426 case THREAD_STOPPED_FOREVER:
427 target_thread->status = THREAD_RUNNABLE;
437rb_threadptr_unlock_all_locking_mutexes(
rb_thread_t *th)
439 while (th->keeping_mutexes) {
441 th->keeping_mutexes = mutex->next_mutex;
445 const char *error_message = rb_mutex_unlock_th(mutex, th, mutex->fiber);
446 if (error_message) rb_bug(
"invalid keeping_mutexes: %s", error_message);
455 volatile int sleeping = 0;
457 if (cr->threads.main != th) {
458 rb_bug(
"rb_thread_terminate_all: called by child thread (%p, %p)",
459 (
void *)cr->threads.main, (
void *)th);
463 rb_threadptr_unlock_all_locking_mutexes(th);
466 if (EC_EXEC_TAG() == TAG_NONE) {
468 RUBY_DEBUG_LOG(
"th:%u", rb_th_serial(th));
470 terminate_all(cr, th);
472 while (rb_ractor_living_thread_num(cr) > 1) {
473 rb_hrtime_t rel = RB_HRTIME_PER_SEC;
479 native_sleep(th, &rel);
480 RUBY_VM_CHECK_INTS_BLOCKING(ec);
498void rb_threadptr_root_fiber_terminate(
rb_thread_t *th);
499static void threadptr_interrupt_exec_cleanup(
rb_thread_t *th);
502thread_cleanup_func_before_exec(
void *th_ptr)
505 th->status = THREAD_KILLED;
508 th->ec->machine.stack_start = th->ec->machine.stack_end = NULL;
510 threadptr_interrupt_exec_cleanup(th);
511 rb_threadptr_root_fiber_terminate(th);
515thread_cleanup_func(
void *th_ptr,
int atfork)
519 th->locking_mutex =
Qfalse;
520 thread_cleanup_func_before_exec(th_ptr);
523 native_thread_destroy_atfork(th->nt);
535ruby_thread_init_stack(
rb_thread_t *th,
void *local_in_parent_frame)
537 native_thread_init_stack(th, local_in_parent_frame);
541rb_vm_proc_local_ep(
VALUE proc)
543 const VALUE *ep = vm_proc_ep(proc);
546 return rb_vm_ep_local_ep(ep);
555 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler);
560 VALUE args = th->invoke_arg.proc.args;
561 const VALUE *args_ptr;
563 VALUE procval = th->invoke_arg.proc.proc;
565 GetProcPtr(procval, proc);
567 th->ec->errinfo =
Qnil;
568 th->ec->root_lep = rb_vm_proc_local_ep(procval);
569 th->ec->root_svar =
Qfalse;
571 vm_check_ints_blocking(th->ec);
573 if (th->invoke_type == thread_invoke_type_ractor_proc) {
574 VALUE self = rb_ractor_self(th->ractor);
575 th->thgroup = th->ractor->thgroup_default =
rb_obj_alloc(cThGroup);
580 rb_ractor_receive_parameters(th->ec, th->ractor, args_len, (
VALUE *)args_ptr);
581 vm_check_ints_blocking(th->ec);
583 return rb_vm_invoke_proc_with_self(
586 th->invoke_arg.proc.kw_splat,
587 VM_BLOCK_HANDLER_NONE
596 th->invoke_arg.proc.args =
Qnil;
602 vm_check_ints_blocking(th->ec);
604 return rb_vm_invoke_proc(
607 th->invoke_arg.proc.kw_splat,
608 VM_BLOCK_HANDLER_NONE
616 native_set_thread_name(th);
619 switch (th->invoke_type) {
620 case thread_invoke_type_proc:
621 result = thread_do_start_proc(th);
624 case thread_invoke_type_ractor_proc:
625 result = thread_do_start_proc(th);
626 rb_ractor_atexit(th->ec, result);
629 case thread_invoke_type_func:
630 result = (*th->invoke_arg.func.func)(th->invoke_arg.func.arg);
633 case thread_invoke_type_none:
634 rb_bug(
"unreachable");
645 RUBY_DEBUG_LOG(
"th:%u", rb_th_serial(th));
646 VM_ASSERT(th != th->vm->ractor.main_thread);
648 enum ruby_tag_type state;
650 rb_thread_t *ractor_main_th = th->ractor->threads.main;
653 if (rb_ractor_status_p(th->ractor, ractor_blocking)) {
656 rb_vm_ractor_blocking_cnt_dec(th->vm, th->ractor, __FILE__, __LINE__);
658 r->r_stdin = rb_io_prep_stdin();
659 r->r_stdout = rb_io_prep_stdout();
660 r->r_stderr = rb_io_prep_stderr();
666 VM_ASSERT(UNDEF_P(th->value));
668 int fiber_scheduler_closed = 0, event_thread_end_hooked = 0;
673 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
676 result = thread_do_start(th);
679 if (!fiber_scheduler_closed) {
680 fiber_scheduler_closed = 1;
684 if (!event_thread_end_hooked) {
685 event_thread_end_hooked = 1;
689 if (state == TAG_NONE) {
694 errinfo = th->ec->errinfo;
696 VALUE exc = rb_vm_make_jump_tag_but_local_jump(state,
Qundef);
697 if (!
NIL_P(exc)) errinfo = exc;
699 if (state == TAG_FATAL) {
700 if (th->invoke_type == thread_invoke_type_ractor_proc) {
701 rb_ractor_atexit(th->ec,
Qnil);
709 if (th->report_on_exception) {
710 VALUE mesg = rb_thread_to_s(th->self);
711 rb_str_cat_cstr(mesg,
" terminated with exception (report_on_exception is true):\n");
712 rb_write_error_str(mesg);
713 rb_ec_error_print(th->ec, errinfo);
716 if (th->invoke_type == thread_invoke_type_ractor_proc) {
717 rb_ractor_atexit_exception(th->ec);
720 if (th->vm->thread_abort_on_exception ||
732 VM_ASSERT(!UNDEF_P(th->value));
734 rb_threadptr_join_list_wakeup(th);
735 rb_threadptr_unlock_all_locking_mutexes(th);
737 if (th->invoke_type == thread_invoke_type_ractor_proc) {
738 rb_thread_terminate_all(th);
739 rb_ractor_teardown(th->ec);
742 th->status = THREAD_KILLED;
743 RUBY_DEBUG_LOG(
"killed th:%u", rb_th_serial(th));
745 if (th->vm->ractor.main_thread == th) {
751 rb_threadptr_raise(ractor_main_th, 1, &errinfo);
756 rb_ec_clear_current_thread_trace_func(th->ec);
759 if (th->locking_mutex !=
Qfalse) {
760 rb_bug(
"thread_start_func_2: locking_mutex must not be set (%p:%"PRIxVALUE
")",
761 (
void *)th, th->locking_mutex);
764 if (ractor_main_th->status == THREAD_KILLED &&
765 th->ractor->threads.cnt <= 2 ) {
767 rb_threadptr_interrupt(ractor_main_th);
770 rb_check_deadlock(th->ractor);
772 rb_fiber_close(th->ec->fiber_ptr);
774 thread_cleanup_func(th, FALSE);
775 VM_ASSERT(th->ec->vm_stack == NULL);
777 if (th->invoke_type == thread_invoke_type_ractor_proc) {
781 thread_sched_to_dead(TH_SCHED(th), th);
782 rb_ractor_living_threads_remove(th->ractor, th);
785 rb_ractor_living_threads_remove(th->ractor, th);
786 thread_sched_to_dead(TH_SCHED(th), th);
793 enum thread_invoke_type type;
806static void thread_specific_storage_alloc(
rb_thread_t *th);
812 rb_thread_t *th = rb_thread_ptr(thval), *current_th = rb_ec_thread_ptr(ec);
815 thread_specific_storage_alloc(th);
819 "can't start a new thread (frozen ThreadGroup)");
822 rb_fiber_inherit_storage(ec, th->ec->fiber_ptr);
824 switch (params->type) {
825 case thread_invoke_type_proc:
826 th->invoke_type = thread_invoke_type_proc;
827 th->invoke_arg.proc.args = params->args;
828 th->invoke_arg.proc.proc = params->proc;
832 case thread_invoke_type_ractor_proc:
833#if RACTOR_CHECK_MODE > 0
834 rb_ractor_setup_belonging_to(thval, rb_ractor_id(params->g));
836 th->invoke_type = thread_invoke_type_ractor_proc;
837 th->ractor = params->g;
838 th->ractor->threads.main = th;
839 th->invoke_arg.proc.proc = rb_proc_isolate_bang(params->proc);
842 rb_ractor_send_parameters(ec, params->g, params->args);
845 case thread_invoke_type_func:
846 th->invoke_type = thread_invoke_type_func;
847 th->invoke_arg.func.func = params->fn;
848 th->invoke_arg.func.arg = (
void *)params->args;
852 rb_bug(
"unreachable");
855 th->priority = current_th->priority;
856 th->thgroup = current_th->thgroup;
859 th->pending_interrupt_queue_checked = 0;
860 th->pending_interrupt_mask_stack =
rb_ary_dup(current_th->pending_interrupt_mask_stack);
861 RBASIC_CLEAR_CLASS(th->pending_interrupt_mask_stack);
865 RUBY_DEBUG_LOG(
"r:%u th:%u", rb_ractor_id(th->ractor), rb_th_serial(th));
867 rb_ractor_living_threads_insert(th->ractor, th);
870 err = native_thread_create(th);
872 th->status = THREAD_KILLED;
873 rb_ractor_living_threads_remove(th->ractor, th);
879#define threadptr_initialized(th) ((th)->invoke_type != thread_invoke_type_none)
902thread_s_new(
int argc,
VALUE *argv,
VALUE klass)
905 VALUE thread = rb_thread_alloc(klass);
907 if (GET_RACTOR()->threads.main->status == THREAD_KILLED) {
912 th = rb_thread_ptr(thread);
913 if (!threadptr_initialized(th)) {
914 rb_raise(
rb_eThreadError,
"uninitialized thread - check '%"PRIsVALUE
"#initialize'",
934 .type = thread_invoke_type_proc,
938 return thread_create_core(rb_thread_alloc(klass), ¶ms);
944 if (th->invoke_type == thread_invoke_type_proc) {
945 return rb_proc_location(th->invoke_arg.proc.proc);
961 else if (th->invoke_type != thread_invoke_type_none) {
962 VALUE loc = threadptr_invoke_proc_location(th);
965 "already initialized thread - %"PRIsVALUE
":%"PRIsVALUE,
974 .type = thread_invoke_type_proc,
978 return thread_create_core(thread, ¶ms);
986 .type = thread_invoke_type_func,
990 return thread_create_core(rb_thread_alloc(
rb_cThread), ¶ms);
997 .type = thread_invoke_type_ractor_proc,
1002 return thread_create_core(rb_thread_alloc(
rb_cThread), ¶ms);;
1014remove_from_join_list(
VALUE arg)
1019 if (target_thread->status != THREAD_KILLED) {
1022 while (*join_list) {
1023 if (*join_list == p->waiter) {
1024 *join_list = (*join_list)->next;
1028 join_list = &(*join_list)->next;
1038 return th->status == THREAD_KILLED || !UNDEF_P(th->value);
1042thread_join_sleep(
VALUE arg)
1045 rb_thread_t *target_th = p->target, *th = p->waiter->thread;
1046 rb_hrtime_t end = 0, *limit = p->limit;
1049 end = rb_hrtime_add(*limit, rb_hrtime_now());
1052 while (!thread_finished(target_th)) {
1056 if (scheduler !=
Qnil) {
1060 sleep_forever(th, SLEEP_DEADLOCKABLE | SLEEP_ALLOW_SPURIOUS | SLEEP_NO_CHECKINTS);
1064 if (hrtime_update_expire(limit, end)) {
1065 RUBY_DEBUG_LOG(
"timeout target_th:%u", rb_th_serial(target_th));
1069 if (scheduler !=
Qnil) {
1070 VALUE timeout = rb_float_new(hrtime2double(*limit));
1074 th->status = THREAD_STOPPED;
1075 native_sleep(th, limit);
1078 RUBY_VM_CHECK_INTS_BLOCKING(th->ec);
1079 th->status = THREAD_RUNNABLE;
1081 RUBY_DEBUG_LOG(
"interrupted target_th:%u status:%s", rb_th_serial(target_th), thread_status_name(target_th, TRUE));
1094 if (th == target_th) {
1095 rb_raise(
rb_eThreadError,
"Target thread must not be current thread");
1098 if (th->ractor->threads.main == target_th) {
1102 RUBY_DEBUG_LOG(
"target_th:%u status:%s", rb_th_serial(target_th), thread_status_name(target_th, TRUE));
1104 if (target_th->status != THREAD_KILLED) {
1106 waiter.next = target_th->join_list;
1108 waiter.fiber = rb_fiberptr_blocking(fiber) ? NULL : fiber;
1109 target_th->join_list = &waiter;
1112 arg.waiter = &waiter;
1113 arg.target = target_th;
1114 arg.timeout = timeout;
1122 RUBY_DEBUG_LOG(
"success target_th:%u status:%s", rb_th_serial(target_th), thread_status_name(target_th, TRUE));
1124 if (target_th->ec->errinfo !=
Qnil) {
1125 VALUE err = target_th->ec->errinfo;
1130 RUBY_DEBUG_LOG(
"terminated target_th:%u status:%s", rb_th_serial(target_th), thread_status_name(target_th, TRUE));
1135 if (err == RUBY_FATAL_FIBER_KILLED) {
1139 rb_bug(
"thread_join: Fixnum (%d) should not reach here.",
FIX2INT(err));
1142 else if (THROW_DATA_P(target_th->ec->errinfo)) {
1143 rb_bug(
"thread_join: THROW_DATA should not reach here.");
1150 return target_th->self;
1193thread_join_m(
int argc,
VALUE *argv,
VALUE self)
1196 rb_hrtime_t rel = 0, *limit = 0;
1207 if (
NIL_P(timeout)) {
1211 rel = rb_sec2hrtime(NUM2TIMET(timeout));
1215 limit = double2hrtime(&rel,
rb_num2dbl(timeout));
1218 return thread_join(rb_thread_ptr(self), timeout, limit);
1236thread_value(
VALUE self)
1239 thread_join(th,
Qnil, 0);
1240 if (UNDEF_P(th->value)) {
1254#if defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_MONOTONIC)
1255 if (clock_gettime(CLOCK_MONOTONIC, ts) == 0)
1265NOINLINE(rb_hrtime_t rb_hrtime_now(
void));
1272 return rb_timespec2hrtime(&ts);
1279COMPILER_WARNING_PUSH
1280#if defined(__GNUC__) && __GNUC__ == 7 && __GNUC_MINOR__ <= 3
1281COMPILER_WARNING_IGNORED(-Wmaybe-uninitialized)
1284#define PRIu64 PRI_64_PREFIX "u"
1292hrtime_update_expire(rb_hrtime_t *timeout,
const rb_hrtime_t end)
1294 rb_hrtime_t now = rb_hrtime_now();
1296 if (now > end)
return 1;
1298 RUBY_DEBUG_LOG(
"%"PRIu64
" > %"PRIu64
"", (uint64_t)end, (uint64_t)now);
1300 *timeout = end - now;
1306sleep_hrtime(
rb_thread_t *th, rb_hrtime_t rel,
unsigned int fl)
1308 enum rb_thread_status prev_status = th->status;
1310 rb_hrtime_t end = rb_hrtime_add(rb_hrtime_now(), rel);
1312 th->status = THREAD_STOPPED;
1313 RUBY_VM_CHECK_INTS_BLOCKING(th->ec);
1314 while (th->status == THREAD_STOPPED) {
1315 native_sleep(th, &rel);
1316 woke = vm_check_ints_blocking(th->ec);
1317 if (woke && !(fl & SLEEP_SPURIOUS_CHECK))
1319 if (hrtime_update_expire(&rel, end))
1323 th->status = prev_status;
1328sleep_hrtime_until(
rb_thread_t *th, rb_hrtime_t end,
unsigned int fl)
1330 enum rb_thread_status prev_status = th->status;
1332 rb_hrtime_t rel = rb_hrtime_sub(end, rb_hrtime_now());
1334 th->status = THREAD_STOPPED;
1335 RUBY_VM_CHECK_INTS_BLOCKING(th->ec);
1336 while (th->status == THREAD_STOPPED) {
1337 native_sleep(th, &rel);
1338 woke = vm_check_ints_blocking(th->ec);
1339 if (woke && !(fl & SLEEP_SPURIOUS_CHECK))
1341 if (hrtime_update_expire(&rel, end))
1345 th->status = prev_status;
1352 enum rb_thread_status prev_status = th->status;
1353 enum rb_thread_status status;
1356 status = fl & SLEEP_DEADLOCKABLE ? THREAD_STOPPED_FOREVER : THREAD_STOPPED;
1357 th->status = status;
1359 if (!(fl & SLEEP_NO_CHECKINTS)) RUBY_VM_CHECK_INTS_BLOCKING(th->ec);
1361 while (th->status == status) {
1362 if (fl & SLEEP_DEADLOCKABLE) {
1363 rb_ractor_sleeper_threads_inc(th->ractor);
1364 rb_check_deadlock(th->ractor);
1367 native_sleep(th, 0);
1369 if (fl & SLEEP_DEADLOCKABLE) {
1370 rb_ractor_sleeper_threads_dec(th->ractor);
1372 if (fl & SLEEP_ALLOW_SPURIOUS) {
1376 woke = vm_check_ints_blocking(th->ec);
1378 if (woke && !(fl & SLEEP_SPURIOUS_CHECK)) {
1382 th->status = prev_status;
1388 RUBY_DEBUG_LOG(
"forever");
1389 sleep_forever(GET_THREAD(), SLEEP_SPURIOUS_CHECK);
1395 RUBY_DEBUG_LOG(
"deadly");
1396 sleep_forever(GET_THREAD(), SLEEP_DEADLOCKABLE|SLEEP_SPURIOUS_CHECK);
1400rb_thread_sleep_deadly_allow_spurious_wakeup(
VALUE blocker,
VALUE timeout, rb_hrtime_t end)
1403 if (scheduler !=
Qnil) {
1407 RUBY_DEBUG_LOG(
"...");
1409 sleep_hrtime_until(GET_THREAD(), end, SLEEP_SPURIOUS_CHECK);
1412 sleep_forever(GET_THREAD(), SLEEP_DEADLOCKABLE);
1422 sleep_hrtime(th, rb_timeval2hrtime(&time), SLEEP_SPURIOUS_CHECK);
1428 RUBY_VM_CHECK_INTS_BLOCKING(ec);
1441 rb_ec_check_ints(GET_EC());
1449rb_thread_check_trap_pending(
void)
1451 return rb_signal_buff_size() != 0;
1458 return (
int)RUBY_VM_INTERRUPTED(rb_thread_ptr(thval)->ec);
1468rb_thread_schedule_limits(uint32_t limits_us)
1472 RUBY_DEBUG_LOG(
"us:%u", (
unsigned int)limits_us);
1474 if (th->running_time_us >= limits_us) {
1475 RUBY_DEBUG_LOG(
"switch %s",
"start");
1477 RB_VM_SAVE_MACHINE_CONTEXT(th);
1478 thread_sched_yield(TH_SCHED(th), th);
1479 rb_ractor_thread_switch(th->ractor, th,
true);
1481 RUBY_DEBUG_LOG(
"switch %s",
"done");
1489 rb_thread_schedule_limits(0);
1490 RUBY_VM_CHECK_INTS(GET_EC());
1499#ifdef RUBY_ASSERT_CRITICAL_SECTION
1500 VM_ASSERT(ruby_assert_critical_section_entered == 0);
1502 VM_ASSERT(th == GET_THREAD());
1504 region->prev_status = th->status;
1505 if (unblock_function_set(th, ubf, arg, fail_if_interrupted)) {
1506 th->blocking_region_buffer = region;
1507 th->status = THREAD_STOPPED;
1508 rb_ractor_blocking_threads_inc(th->ractor, __FILE__, __LINE__);
1510 RUBY_DEBUG_LOG(
"thread_id:%p", (
void *)th->nt->thread_id);
1522 unblock_function_clear(th);
1524 unregister_ubf_list(th);
1526 thread_sched_to_running(TH_SCHED(th), th);
1527 rb_ractor_thread_switch(th->ractor, th,
false);
1529 th->blocking_region_buffer = 0;
1530 rb_ractor_blocking_threads_dec(th->ractor, __FILE__, __LINE__);
1531 if (th->status == THREAD_STOPPED) {
1532 th->status = region->prev_status;
1535 RUBY_DEBUG_LOG(
"end");
1539 VM_ASSERT(th == GET_THREAD());
1559 *unblock_function = ubf_select;
1567rb_nogvl(
void *(*func)(
void *),
void *data1,
1573 if (scheduler !=
Qnil) {
1578 if (!UNDEF_P(result)) {
1579 rb_errno_set(state.saved_errno);
1580 return state.result;
1588 rb_vm_t *vm = rb_ec_vm_ptr(ec);
1589 bool is_main_thread = vm->ractor.main_thread == th;
1590 int saved_errno = 0;
1592 rb_thread_resolve_unblock_function(&ubf, &data2, th);
1594 if (ubf && rb_ractor_living_thread_num(th->ractor) == 1 && is_main_thread) {
1596 vm->ubf_async_safe = 1;
1600 rb_vm_t *
volatile saved_vm = vm;
1601 BLOCKING_REGION(th, {
1603 saved_errno = rb_errno();
1607 if (is_main_thread) vm->ubf_async_safe = 0;
1610 RUBY_VM_CHECK_INTS_BLOCKING(ec);
1613 rb_errno_set(saved_errno);
1714 return rb_nogvl(func, data1, ubf, data2, 0);
1718waitfd_to_waiting_flag(
int wfd_event)
1720 return wfd_event << 1;
1723static struct ccan_list_head *
1724rb_io_blocking_operations(
struct rb_io *io)
1726 rb_serial_t fork_generation = GET_VM()->fork_gen;
1730 if (io->fork_generation != fork_generation) {
1732 io->fork_generation = fork_generation;
1751 ccan_list_add(rb_io_blocking_operations(io), &blocking_operation->list);
1757 ccan_list_del(&blocking_operation->list);
1766io_blocking_operation_exit(
VALUE _arguments)
1771 rb_io_blocking_operation_pop(arguments->io, blocking_operation);
1775 rb_fiber_t *fiber = io->closing_ec->fiber_ptr;
1777 if (thread->scheduler !=
Qnil) {
1801 VALUE wakeup_mutex = io->wakeup_mutex;
1804 blocking_operation->ec = NULL;
1809 .blocking_operation = blocking_operation
1816 rb_io_blocking_operation_pop(io, blocking_operation);
1821rb_thread_io_blocking_operation_ensure(
VALUE _argument)
1825 rb_io_blocking_operation_exit(arguments->io, arguments->blocking_operation);
1853 rb_io_blocking_operation_enter(io, &blocking_operation);
1857 .blocking_operation = &blocking_operation
1866#if defined(USE_MN_THREADS) && USE_MN_THREADS
1867 return !th_has_dedicated_nt(th) && (events || timeout) && th->blocking;
1875thread_io_wait_events(
rb_thread_t *th,
int fd,
int events,
const struct timeval *timeout)
1877#if defined(USE_MN_THREADS) && USE_MN_THREADS
1878 if (thread_io_mn_schedulable(th, events, timeout)) {
1879 rb_hrtime_t rel, *prel;
1882 rel = rb_timeval2hrtime(timeout);
1889 VM_ASSERT(prel || (events & (RB_WAITFD_IN | RB_WAITFD_OUT)));
1891 if (thread_sched_wait_events(TH_SCHED(th), th, fd, waitfd_to_waiting_flag(events), prel)) {
1905blocking_call_retryable_p(
int r,
int eno)
1907 if (r != -1)
return false;
1911#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
1921rb_thread_mn_schedulable(
VALUE thval)
1924 return th->mn_schedulable;
1928rb_thread_io_blocking_call(
struct rb_io* io, rb_blocking_function_t *func,
void *data1,
int events)
1933 RUBY_DEBUG_LOG(
"th:%u fd:%d ev:%d", rb_th_serial(th), io->
fd, events);
1936 volatile int saved_errno = 0;
1937 enum ruby_tag_type state;
1938 volatile bool prev_mn_schedulable = th->mn_schedulable;
1939 th->mn_schedulable = thread_io_mn_schedulable(th, events, NULL);
1952 rb_io_blocking_operation_enter(io, &blocking_operation);
1956 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
1957 volatile enum ruby_tag_type saved_state = state;
1959 BLOCKING_REGION(th, {
1961 saved_errno =
errno;
1962 }, ubf_select, th, FALSE);
1966 blocking_call_retryable_p((
int)val, saved_errno) &&
1967 thread_io_wait_events(th, fd, events, NULL)) {
1968 RUBY_VM_CHECK_INTS_BLOCKING(ec);
1972 RUBY_VM_CHECK_INTS_BLOCKING(ec);
1974 state = saved_state;
1978 th = rb_ec_thread_ptr(ec);
1979 th->mn_schedulable = prev_mn_schedulable;
1982 rb_io_blocking_operation_exit(io, &blocking_operation);
1985 EC_JUMP_TAG(ec, state);
1989 if (saved_errno == ETIMEDOUT) {
1993 errno = saved_errno;
1999rb_thread_io_blocking_region(
struct rb_io *io, rb_blocking_function_t *func,
void *data1)
2001 return rb_thread_io_blocking_call(io, func, data1, 0);
2046 fprintf(stderr,
"[BUG] rb_thread_call_with_gvl() is called by non-ruby thread\n");
2051 prev_unblock = th->unblock;
2054 rb_bug(
"rb_thread_call_with_gvl: called by a thread which has GVL.");
2057 blocking_region_end(th, brb);
2061 int released = blocking_region_begin(th, brb, prev_unblock.func, prev_unblock.arg, FALSE);
2063 RB_VM_SAVE_MACHINE_CONTEXT(th);
2064 thread_sched_to_waiting(TH_SCHED(th), th);
2073ruby_thread_has_gvl_p(
void)
2077 if (th && th->blocking_region_buffer == 0) {
2094thread_s_pass(
VALUE klass)
2119rb_threadptr_pending_interrupt_clear(
rb_thread_t *th)
2128 th->pending_interrupt_queue_checked = 0;
2132threadptr_check_pending_interrupt_queue(
rb_thread_t *th)
2134 if (!th->pending_interrupt_queue) {
2139enum handle_interrupt_timing {
2141 INTERRUPT_IMMEDIATE,
2142 INTERRUPT_ON_BLOCKING,
2146static enum handle_interrupt_timing
2149 if (sym == sym_immediate) {
2150 return INTERRUPT_IMMEDIATE;
2152 else if (sym == sym_on_blocking) {
2153 return INTERRUPT_ON_BLOCKING;
2155 else if (sym == sym_never) {
2156 return INTERRUPT_NEVER;
2163static enum handle_interrupt_timing
2167 long mask_stack_len =
RARRAY_LEN(th->pending_interrupt_mask_stack);
2172 for (i=0; i<mask_stack_len; i++) {
2173 mask = mask_stack[mask_stack_len-(i+1)];
2178 return rb_threadptr_pending_interrupt_from_symbol(th, mask);
2190 klass =
RBASIC(mod)->klass;
2192 else if (mod != RCLASS_ORIGIN(mod)) {
2196 if ((sym = rb_hash_aref(mask, klass)) !=
Qnil) {
2197 return rb_threadptr_pending_interrupt_from_symbol(th, sym);
2202 return INTERRUPT_NONE;
2206rb_threadptr_pending_interrupt_empty_p(
const rb_thread_t *th)
2208 return RARRAY_LEN(th->pending_interrupt_queue) == 0;
2215 for (i=0; i<
RARRAY_LEN(th->pending_interrupt_queue); i++) {
2225rb_threadptr_pending_interrupt_deque(
rb_thread_t *th,
enum handle_interrupt_timing timing)
2230 for (i=0; i<
RARRAY_LEN(th->pending_interrupt_queue); i++) {
2233 enum handle_interrupt_timing mask_timing = rb_threadptr_pending_interrupt_check_mask(th,
CLASS_OF(err));
2235 switch (mask_timing) {
2236 case INTERRUPT_ON_BLOCKING:
2237 if (timing != INTERRUPT_ON_BLOCKING) {
2241 case INTERRUPT_NONE:
2242 case INTERRUPT_IMMEDIATE:
2245 case INTERRUPT_NEVER:
2250 th->pending_interrupt_queue_checked = 1;
2254 if (rb_threadptr_pending_interrupt_empty_p(th)) {
2255 th->pending_interrupt_queue_checked = 1;
2262threadptr_pending_interrupt_active_p(
rb_thread_t *th)
2269 if (th->pending_interrupt_queue_checked) {
2273 if (rb_threadptr_pending_interrupt_empty_p(th)) {
2285 if (val != sym_immediate && val != sym_on_blocking && val != sym_never) {
2286 rb_raise(rb_eArgError,
"unknown mask signature");
2294 if (
RTEST(*maskp)) {
2296 VALUE prev = *maskp;
2297 *maskp = rb_ident_hash_new();
2302 rb_hash_aset(*maskp, key, val);
2396rb_thread_s_handle_interrupt(
VALUE self,
VALUE mask_arg)
2402 enum ruby_tag_type state;
2405 rb_raise(rb_eArgError,
"block is needed.");
2408 mask_arg = rb_to_hash_type(mask_arg);
2410 if (
OBJ_FROZEN(mask_arg) && rb_hash_compare_by_id_p(mask_arg)) {
2416 if (UNDEF_P(mask)) {
2427 rb_ary_push(th->pending_interrupt_mask_stack, mask);
2428 if (!rb_threadptr_pending_interrupt_empty_p(th)) {
2429 th->pending_interrupt_queue_checked = 0;
2430 RUBY_VM_SET_INTERRUPT(th->ec);
2433 EC_PUSH_TAG(th->ec);
2434 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2439 rb_ary_pop(th->pending_interrupt_mask_stack);
2440 if (!rb_threadptr_pending_interrupt_empty_p(th)) {
2441 th->pending_interrupt_queue_checked = 0;
2442 RUBY_VM_SET_INTERRUPT(th->ec);
2445 RUBY_VM_CHECK_INTS(th->ec);
2448 EC_JUMP_TAG(th->ec, state);
2465rb_thread_pending_interrupt_p(
int argc,
VALUE *argv,
VALUE target_thread)
2467 rb_thread_t *target_th = rb_thread_ptr(target_thread);
2469 if (!target_th->pending_interrupt_queue) {
2472 if (rb_threadptr_pending_interrupt_empty_p(target_th)) {
2476 VALUE err = argv[0];
2478 rb_raise(
rb_eTypeError,
"class or module required for rescue clause");
2480 return RBOOL(rb_threadptr_pending_interrupt_include_p(target_th, err));
2545rb_thread_s_pending_interrupt_p(
int argc,
VALUE *argv,
VALUE self)
2547 return rb_thread_pending_interrupt_p(argc, argv, GET_THREAD()->self);
2550NORETURN(
static void rb_threadptr_to_kill(
rb_thread_t *th));
2555 VM_ASSERT(GET_THREAD() == th);
2556 rb_threadptr_pending_interrupt_clear(th);
2557 th->status = THREAD_RUNNABLE;
2559 th->ec->errinfo =
INT2FIX(TAG_FATAL);
2560 EC_JUMP_TAG(th->ec, TAG_FATAL);
2570 old = ATOMIC_LOAD_RELAXED(ec->interrupt_flag);
2573 old = ATOMIC_CAS(ec->interrupt_flag, interrupt, interrupt & ec->interrupt_mask);
2574 }
while (old != interrupt);
2575 return interrupt & (
rb_atomic_t)~ec->interrupt_mask;
2578static void threadptr_interrupt_exec_exec(
rb_thread_t *th);
2586rb_threadptr_execute_interrupts(
rb_thread_t *th,
int blocking_timing)
2589 int postponed_job_interrupt = 0;
2592 VM_ASSERT(GET_THREAD() == th);
2594 if (th->ec->raised_flag)
return ret;
2596 while ((interrupt = threadptr_get_interrupts(th)) != 0) {
2598 int timer_interrupt;
2599 int pending_interrupt;
2601 int terminate_interrupt;
2603 timer_interrupt = interrupt & TIMER_INTERRUPT_MASK;
2604 pending_interrupt = interrupt & PENDING_INTERRUPT_MASK;
2605 postponed_job_interrupt = interrupt & POSTPONED_JOB_INTERRUPT_MASK;
2606 trap_interrupt = interrupt & TRAP_INTERRUPT_MASK;
2607 terminate_interrupt = interrupt & TERMINATE_INTERRUPT_MASK;
2609 if (interrupt & VM_BARRIER_INTERRUPT_MASK) {
2613 if (postponed_job_interrupt) {
2614 rb_postponed_job_flush(th->vm);
2617 if (trap_interrupt) {
2619 if (th == th->vm->ractor.main_thread) {
2620 enum rb_thread_status prev_status = th->status;
2622 th->status = THREAD_RUNNABLE;
2624 while ((sig = rb_get_next_signal()) != 0) {
2625 ret |= rb_signal_exec(th, sig);
2628 th->status = prev_status;
2631 if (!ccan_list_empty(&th->interrupt_exec_tasks)) {
2632 enum rb_thread_status prev_status = th->status;
2634 th->status = THREAD_RUNNABLE;
2636 threadptr_interrupt_exec_exec(th);
2638 th->status = prev_status;
2643 if (pending_interrupt && threadptr_pending_interrupt_active_p(th)) {
2644 VALUE err = rb_threadptr_pending_interrupt_deque(th, blocking_timing ? INTERRUPT_ON_BLOCKING : INTERRUPT_NONE);
2645 RUBY_DEBUG_LOG(
"err:%"PRIdVALUE, err);
2651 else if (err == RUBY_FATAL_THREAD_KILLED ||
2652 err == RUBY_FATAL_THREAD_TERMINATED ||
2654 terminate_interrupt = 1;
2657 if (err == th->vm->special_exceptions[ruby_error_stream_closed]) {
2659 err = ruby_vm_special_exception_copy(err);
2662 if (th->status == THREAD_STOPPED ||
2663 th->status == THREAD_STOPPED_FOREVER)
2664 th->status = THREAD_RUNNABLE;
2669 if (terminate_interrupt) {
2670 rb_threadptr_to_kill(th);
2673 if (timer_interrupt) {
2674 uint32_t limits_us = thread_default_quantum_ms * 1000;
2676 if (th->priority > 0)
2677 limits_us <<= th->priority;
2679 limits_us >>= -th->priority;
2681 if (th->status == THREAD_RUNNABLE)
2682 th->running_time_us += 10 * 1000;
2684 VM_ASSERT(th->ec->cfp);
2688 rb_thread_schedule_limits(limits_us);
2695rb_thread_execute_interrupts(
VALUE thval)
2697 rb_threadptr_execute_interrupts(rb_thread_ptr(thval), 1);
2703 rb_threadptr_interrupt(th);
2711 if (rb_threadptr_dead(target_th)) {
2719 exc = rb_make_exception(argc, argv);
2724 if (rb_threadptr_dead(target_th)) {
2728 rb_ec_setup_exception(GET_EC(), exc,
Qundef);
2729 rb_threadptr_pending_interrupt_enque(target_th, exc);
2730 rb_threadptr_interrupt(target_th);
2735rb_threadptr_signal_raise(
rb_thread_t *th,
int sig)
2741 rb_threadptr_raise(th->vm->ractor.main_thread, 2, argv);
2753 rb_threadptr_raise(th->vm->ractor.main_thread, 2, argv);
2759 if (ec->raised_flag & RAISED_EXCEPTION) {
2762 ec->raised_flag |= RAISED_EXCEPTION;
2769 if (!(ec->raised_flag & RAISED_EXCEPTION)) {
2772 ec->raised_flag &= ~RAISED_EXCEPTION;
2797thread_io_close_notify_all(
VALUE _io)
2802 rb_vm_t *vm = io->closing_ec->thread_ptr->vm;
2803 VALUE error = vm->special_exceptions[ruby_error_stream_closed];
2806 ccan_list_for_each(rb_io_blocking_operations(io), blocking_operation, list) {
2814 if (thread->scheduler !=
Qnil) {
2820 rb_threadptr_pending_interrupt_enque(thread, error);
2821 rb_threadptr_interrupt(thread);
2828 return (
VALUE)count;
2832rb_thread_io_close_interrupt(
struct rb_io *io)
2835 if (io->closing_ec) {
2840 if (ccan_list_empty(rb_io_blocking_operations(io))) {
2846 io->closing_ec = ec;
2850 rb_mutex_allow_trap(io->wakeup_mutex, 1);
2855 return (
size_t)result;
2859rb_thread_io_close_wait(
struct rb_io* io)
2861 VALUE wakeup_mutex = io->wakeup_mutex;
2869 while (!ccan_list_empty(rb_io_blocking_operations(io))) {
2875 io->wakeup_mutex =
Qnil;
2876 io->closing_ec = NULL;
2882 rb_warn(
"rb_thread_fd_close is deprecated (and is now a no-op).");
2907thread_raise_m(
int argc,
VALUE *argv,
VALUE self)
2912 threadptr_check_pending_interrupt_queue(target_th);
2913 rb_threadptr_raise(target_th, argc, argv);
2916 if (current_th == target_th) {
2917 RUBY_VM_CHECK_INTS(target_th->ec);
2939 if (target_th->to_kill || target_th->status == THREAD_KILLED) {
2942 if (target_th == target_th->vm->ractor.main_thread) {
2946 RUBY_DEBUG_LOG(
"target_th:%u", rb_th_serial(target_th));
2948 if (target_th == GET_THREAD()) {
2950 rb_threadptr_to_kill(target_th);
2953 threadptr_check_pending_interrupt_queue(target_th);
2954 rb_threadptr_pending_interrupt_enque(target_th, RUBY_FATAL_THREAD_KILLED);
2955 rb_threadptr_interrupt(target_th);
2962rb_thread_to_be_killed(
VALUE thread)
2966 if (target_th->to_kill || target_th->status == THREAD_KILLED) {
3042 if (target_th->status == THREAD_KILLED)
return Qnil;
3044 rb_threadptr_ready(target_th);
3046 if (target_th->status == THREAD_STOPPED ||
3047 target_th->status == THREAD_STOPPED_FOREVER) {
3048 target_th->status = THREAD_RUNNABLE;
3090 "stopping only thread\n\tnote: use sleep to stop forever");
3123 return rb_ractor_thread_list();
3149 return rb_thread_list();
3155 return GET_THREAD()->self;
3168thread_s_current(
VALUE klass)
3176 return GET_RACTOR()->threads.main->self;
3187rb_thread_s_main(
VALUE klass)
3214rb_thread_s_abort_exc(
VALUE _)
3216 return RBOOL(GET_THREAD()->vm->thread_abort_on_exception);
3251rb_thread_s_abort_exc_set(
VALUE self,
VALUE val)
3253 GET_THREAD()->vm->thread_abort_on_exception =
RTEST(val);
3274rb_thread_abort_exc(
VALUE thread)
3276 return RBOOL(rb_thread_ptr(thread)->abort_on_exception);
3294rb_thread_abort_exc_set(
VALUE thread,
VALUE val)
3296 rb_thread_ptr(thread)->abort_on_exception =
RTEST(val);
3344rb_thread_s_report_exc(
VALUE _)
3346 return RBOOL(GET_THREAD()->vm->thread_report_on_exception);
3381rb_thread_s_report_exc_set(
VALUE self,
VALUE val)
3383 GET_THREAD()->vm->thread_report_on_exception =
RTEST(val);
3400rb_thread_s_ignore_deadlock(
VALUE _)
3402 return RBOOL(GET_THREAD()->vm->thread_ignore_deadlock);
3427rb_thread_s_ignore_deadlock_set(
VALUE self,
VALUE val)
3429 GET_THREAD()->vm->thread_ignore_deadlock =
RTEST(val);
3451rb_thread_report_exc(
VALUE thread)
3453 return RBOOL(rb_thread_ptr(thread)->report_on_exception);
3471rb_thread_report_exc_set(
VALUE thread,
VALUE val)
3473 rb_thread_ptr(thread)->report_on_exception =
RTEST(val);
3488rb_thread_group(
VALUE thread)
3490 return rb_thread_ptr(thread)->thgroup;
3496 switch (th->status) {
3497 case THREAD_RUNNABLE:
3498 return th->to_kill ?
"aborting" :
"run";
3499 case THREAD_STOPPED_FOREVER:
3500 if (detail)
return "sleep_forever";
3501 case THREAD_STOPPED:
3513 return th->status == THREAD_KILLED;
3549rb_thread_status(
VALUE thread)
3553 if (rb_threadptr_dead(target_th)) {
3554 if (!
NIL_P(target_th->ec->errinfo) &&
3555 !
FIXNUM_P(target_th->ec->errinfo)) {
3563 return rb_str_new2(thread_status_name(target_th, FALSE));
3583rb_thread_alive_p(
VALUE thread)
3585 return RBOOL(!thread_finished(rb_thread_ptr(thread)));
3603rb_thread_stop_p(
VALUE thread)
3607 if (rb_threadptr_dead(th)) {
3610 return RBOOL(th->status == THREAD_STOPPED || th->status == THREAD_STOPPED_FOREVER);
3621rb_thread_getname(
VALUE thread)
3623 return rb_thread_ptr(thread)->name;
3642 enc = rb_enc_get(name);
3643 if (!rb_enc_asciicompat(enc)) {
3644 rb_raise(rb_eArgError,
"ASCII incompatible encoding (%s)",
3649 target_th->name = name;
3650 if (threadptr_initialized(target_th) && target_th->has_dedicated_nt) {
3651 native_set_another_thread_name(target_th->nt->thread_id, name);
3656#if USE_NATIVE_THREAD_NATIVE_THREAD_ID
3680rb_thread_native_thread_id(
VALUE thread)
3683 if (rb_threadptr_dead(target_th))
return Qnil;
3684 return native_thread_native_thread_id(target_th);
3687# define rb_thread_native_thread_id rb_f_notimplement
3698rb_thread_to_s(
VALUE thread)
3705 status = thread_status_name(target_th, TRUE);
3706 str = rb_sprintf(
"#<%"PRIsVALUE
":%p", cname, (
void *)thread);
3707 if (!
NIL_P(target_th->name)) {
3708 rb_str_catf(str,
"@%"PRIsVALUE, target_th->name);
3710 if ((loc = threadptr_invoke_proc_location(target_th)) !=
Qnil) {
3711 rb_str_catf(str,
" %"PRIsVALUE
":%"PRIsVALUE,
3714 rb_str_catf(str,
" %s>", status);
3720#define recursive_key id__recursive_key__
3725 if (
id == recursive_key) {
3726 return th->ec->local_storage_recursive_hash;
3730 struct rb_id_table *local_storage = th->ec->local_storage;
3732 if (local_storage != NULL && rb_id_table_lookup(local_storage,
id, &val)) {
3744 return threadptr_local_aref(rb_thread_ptr(thread),
id);
3811 if (!
id)
return Qnil;
3829rb_thread_fetch(
int argc,
VALUE *argv,
VALUE self)
3840 if (block_given && argc == 2) {
3841 rb_warn(
"block supersedes default value argument");
3846 if (
id == recursive_key) {
3847 return target_th->ec->local_storage_recursive_hash;
3849 else if (
id && target_th->ec->local_storage &&
3850 rb_id_table_lookup(target_th->ec->local_storage,
id, &val)) {
3853 else if (block_given) {
3856 else if (argc == 1) {
3857 rb_key_err_raise(rb_sprintf(
"key not found: %+"PRIsVALUE, key), self, key);
3867 if (
id == recursive_key) {
3868 th->ec->local_storage_recursive_hash = val;
3872 struct rb_id_table *local_storage = th->ec->local_storage;
3875 if (!local_storage)
return Qnil;
3876 rb_id_table_delete(local_storage,
id);
3880 if (local_storage == NULL) {
3881 th->ec->local_storage = local_storage = rb_id_table_create(0);
3883 rb_id_table_insert(local_storage,
id, val);
3896 return threadptr_local_aset(rb_thread_ptr(thread),
id, val);
3947rb_thread_variable_get(
VALUE thread,
VALUE key)
3952 if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) {
3955 locals = rb_thread_local_storage(thread);
3956 return rb_hash_aref(locals, symbol);
3977 locals = rb_thread_local_storage(thread);
3999 struct rb_id_table *local_storage = rb_thread_ptr(self)->ec->local_storage;
4001 if (!
id || local_storage == NULL) {
4004 return RBOOL(rb_id_table_lookup(local_storage,
id, &val));
4007static enum rb_id_table_iterator_result
4008thread_keys_i(
ID key,
VALUE value,
void *ary)
4011 return ID_TABLE_CONTINUE;
4018 return rb_ractor_living_thread_num(GET_RACTOR()) == 1;
4036rb_thread_keys(
VALUE self)
4038 struct rb_id_table *local_storage = rb_thread_ptr(self)->ec->local_storage;
4041 if (local_storage) {
4042 rb_id_table_foreach(local_storage, thread_keys_i, (
void *)ary);
4072rb_thread_variables(
VALUE thread)
4078 if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) {
4081 locals = rb_thread_local_storage(thread);
4109 if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) {
4112 locals = rb_thread_local_storage(thread);
4114 return RBOOL(rb_hash_lookup(locals, symbol) !=
Qnil);
4133rb_thread_priority(
VALUE thread)
4135 return INT2NUM(rb_thread_ptr(thread)->priority);
4166rb_thread_priority_set(
VALUE thread,
VALUE prio)
4171#if USE_NATIVE_THREAD_PRIORITY
4172 target_th->priority =
NUM2INT(prio);
4173 native_thread_apply_priority(th);
4176 if (priority > RUBY_THREAD_PRIORITY_MAX) {
4177 priority = RUBY_THREAD_PRIORITY_MAX;
4179 else if (priority < RUBY_THREAD_PRIORITY_MIN) {
4180 priority = RUBY_THREAD_PRIORITY_MIN;
4182 target_th->priority = (int8_t)priority;
4184 return INT2NUM(target_th->priority);
4189#if defined(NFDBITS) && defined(HAVE_RB_FD_INIT)
4225 FD_ZERO(fds->
fdset);
4231 size_t size = howmany(
rb_fd_max(src), NFDBITS) *
sizeof(fd_mask);
4233 if (size <
sizeof(fd_set))
4234 size =
sizeof(fd_set);
4258 size_t m = howmany(n + 1, NFDBITS) *
sizeof(fd_mask);
4259 size_t o = howmany(fds->
maxfd, NFDBITS) *
sizeof(fd_mask);
4261 if (m <
sizeof(fd_set)) m =
sizeof(fd_set);
4262 if (o <
sizeof(fd_set)) o =
sizeof(fd_set);
4266 memset((
char *)fds->
fdset + o, 0, m - o);
4275 FD_SET(n, fds->
fdset);
4281 if (n >= fds->
maxfd)
return;
4282 FD_CLR(n, fds->
fdset);
4288 if (n >= fds->
maxfd)
return 0;
4289 return FD_ISSET(n, fds->
fdset) != 0;
4295 size_t size = howmany(max, NFDBITS) *
sizeof(fd_mask);
4297 if (size <
sizeof(fd_set)) size =
sizeof(fd_set);
4300 memcpy(dst->
fdset, src, size);
4306 size_t size = howmany(
rb_fd_max(src), NFDBITS) *
sizeof(fd_mask);
4308 if (size <
sizeof(fd_set))
4309 size =
sizeof(fd_set);
4318 fd_set *r = NULL, *w = NULL, *e = NULL;
4331 return select(n, r, w, e, timeout);
4334#define rb_fd_no_init(fds) ((void)((fds)->fdset = 0), (void)((fds)->maxfd = 0))
4341#define FD_ZERO(f) rb_fd_zero(f)
4342#define FD_SET(i, f) rb_fd_set((i), (f))
4343#define FD_CLR(i, f) rb_fd_clr((i), (f))
4344#define FD_ISSET(i, f) rb_fd_isset((i), (f))
4346#elif defined(_WIN32)
4351 set->
capa = FD_SETSIZE;
4353 FD_ZERO(set->
fdset);
4375 SOCKET s = rb_w32_get_osfhandle(fd);
4377 for (i = 0; i < set->
fdset->fd_count; i++) {
4378 if (set->
fdset->fd_array[i] == s) {
4382 if (set->
fdset->fd_count >= (
unsigned)set->
capa) {
4383 set->
capa = (set->
fdset->fd_count / FD_SETSIZE + 1) * FD_SETSIZE;
4385 rb_xrealloc_mul_add(
4386 set->
fdset, set->
capa,
sizeof(SOCKET),
sizeof(
unsigned int));
4388 set->
fdset->fd_array[set->
fdset->fd_count++] = s;
4396#define FD_ZERO(f) rb_fd_zero(f)
4397#define FD_SET(i, f) rb_fd_set((i), (f))
4398#define FD_CLR(i, f) rb_fd_clr((i), (f))
4399#define FD_ISSET(i, f) rb_fd_isset((i), (f))
4401#define rb_fd_no_init(fds) (void)((fds)->fdset = 0)
4405#ifndef rb_fd_no_init
4406#define rb_fd_no_init(fds) (void)(fds)
4410wait_retryable(
volatile int *result,
int errnum, rb_hrtime_t *rel, rb_hrtime_t end)
4420 if (rel && hrtime_update_expire(rel, end)) {
4430 return !hrtime_update_expire(rel, end);
4450select_set_free(
VALUE p)
4465 volatile int result = 0;
4467 rb_hrtime_t *to, rel, end = 0;
4469 timeout_prepare(&to, &rel, &end, set->timeout);
4470 volatile rb_hrtime_t endtime = end;
4471#define restore_fdset(dst, src) \
4472 ((dst) ? rb_fd_dup(dst, src) : (void)0)
4473#define do_select_update() \
4474 (restore_fdset(set->rset, &set->orig_rset), \
4475 restore_fdset(set->wset, &set->orig_wset), \
4476 restore_fdset(set->eset, &set->orig_eset), \
4482 BLOCKING_REGION(set->th, {
4485 if (!RUBY_VM_INTERRUPTED(set->th->ec)) {
4486 result = native_fd_select(set->max,
4487 set->rset, set->wset, set->eset,
4488 rb_hrtime2timeval(&tv, to), set->th);
4489 if (result < 0) lerrno = errno;
4491 }, ubf_select, set->th, TRUE);
4493 RUBY_VM_CHECK_INTS_BLOCKING(set->th->ec);
4494 }
while (wait_retryable(&result, lerrno, to, endtime) && do_select_update());
4496 RUBY_VM_CHECK_INTS_BLOCKING(set->th->ec);
4502 return (
VALUE)result;
4511 set.th = GET_THREAD();
4512 RUBY_VM_CHECK_INTS_BLOCKING(set.th->ec);
4517 set.timeout = timeout;
4519 if (!set.rset && !set.wset && !set.eset) {
4528#define fd_init_copy(f) do { \
4530 rb_fd_resize(set.max - 1, set.f); \
4531 if (&set.orig_##f != set.f) { \
4532 rb_fd_init_copy(&set.orig_##f, set.f); \
4536 rb_fd_no_init(&set.orig_##f); \
4550#define POLLIN_SET (POLLRDNORM | POLLRDBAND | POLLIN | POLLHUP | POLLERR)
4551#define POLLOUT_SET (POLLWRBAND | POLLWRNORM | POLLOUT | POLLERR)
4552#define POLLEX_SET (POLLPRI)
4555# define POLLERR_SET (0)
4559wait_for_single_fd_blocking_region(
rb_thread_t *th,
struct pollfd *fds, nfds_t nfds,
4560 rb_hrtime_t *
const to,
volatile int *lerrno)
4563 volatile int result = 0;
4566 BLOCKING_REGION(th, {
4567 if (!RUBY_VM_INTERRUPTED(th->ec)) {
4568 result = ppoll(fds, nfds, rb_hrtime2timespec(&ts, to), 0);
4569 if (result < 0) *lerrno = errno;
4571 }, ubf_select, th, TRUE);
4579thread_io_wait(
struct rb_io *io,
int fd,
int events,
struct timeval *timeout)
4581 struct pollfd fds[1] = {{
4583 .events = (short)events,
4586 volatile int result = 0;
4589 enum ruby_tag_type state;
4590 volatile int lerrno;
4596 blocking_operation.ec = ec;
4597 rb_io_blocking_operation_enter(io, &blocking_operation);
4600 if (timeout == NULL && thread_io_wait_events(th, fd, events, NULL)) {
4603 fds[0].revents = events;
4608 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
4609 rb_hrtime_t *to, rel, end = 0;
4610 RUBY_VM_CHECK_INTS_BLOCKING(ec);
4611 timeout_prepare(&to, &rel, &end, timeout);
4613 nfds = numberof(fds);
4614 result = wait_for_single_fd_blocking_region(th, fds, nfds, to, &lerrno);
4616 RUBY_VM_CHECK_INTS_BLOCKING(ec);
4617 }
while (wait_retryable(&result, lerrno, to, end));
4619 RUBY_VM_CHECK_INTS_BLOCKING(ec);
4626 rb_io_blocking_operation_exit(io, &blocking_operation);
4630 EC_JUMP_TAG(ec, state);
4638 if (fds[0].revents & POLLNVAL) {
4648 if (fds[0].revents & POLLIN_SET)
4649 result |= RB_WAITFD_IN;
4650 if (fds[0].revents & POLLOUT_SET)
4651 result |= RB_WAITFD_OUT;
4652 if (fds[0].revents & POLLEX_SET)
4653 result |= RB_WAITFD_PRI;
4656 if (fds[0].revents & POLLERR_SET)
4677select_single(
VALUE ptr)
4683 args->read, args->write, args->except, args->tv);
4685 args->as.error =
errno;
4688 if (args->read &&
rb_fd_isset(args->as.fd, args->read))
4690 if (args->write &&
rb_fd_isset(args->as.fd, args->write))
4692 if (args->except &&
rb_fd_isset(args->as.fd, args->except))
4699select_single_cleanup(
VALUE ptr)
4703 if (args->blocking_operation) {
4704 rb_io_blocking_operation_exit(args->io, args->blocking_operation);
4727thread_io_wait(
struct rb_io *io,
int fd,
int events,
struct timeval *timeout)
4736 blocking_operation.ec = GET_EC();
4737 rb_io_blocking_operation_enter(io, &blocking_operation);
4738 args.blocking_operation = &blocking_operation;
4742 blocking_operation.ec = NULL;
4743 args.blocking_operation = NULL;
4747 args.read = (events & RB_WAITFD_IN) ? init_set_fd(fd, &rfds) : NULL;
4748 args.write = (events & RB_WAITFD_OUT) ? init_set_fd(fd, &wfds) : NULL;
4749 args.except = (events & RB_WAITFD_PRI) ? init_set_fd(fd, &efds) : NULL;
4752 int result = (int)
rb_ensure(select_single, ptr, select_single_cleanup, ptr);
4754 errno = args.as.error;
4761rb_thread_wait_for_single_fd(
int fd,
int events,
struct timeval *timeout)
4763 return thread_io_wait(NULL, fd, events, timeout);
4767rb_thread_io_wait(
struct rb_io *io,
int events,
struct timeval * timeout)
4769 return thread_io_wait(io, io->
fd, events, timeout);
4776#ifdef USE_CONSERVATIVE_STACK_END
4778rb_gc_set_stack_end(
VALUE **stack_end_p)
4781COMPILER_WARNING_PUSH
4783COMPILER_WARNING_IGNORED(-Wdangling-pointer);
4785 *stack_end_p = &stack_end;
4798 if (rb_signal_buff_size() > 0) {
4800 threadptr_trap_interrupt(mth);
4805async_bug_fd(
const char *mesg,
int errno_arg,
int fd)
4808 size_t n = strlcpy(buff, mesg,
sizeof(buff));
4809 if (n <
sizeof(buff)-3) {
4812 rb_async_bug_errno(buff, errno_arg);
4817consume_communication_pipe(
int fd)
4823 static char buff[1024];
4829 result = read(fd, buff,
sizeof(buff));
4831 RUBY_DEBUG_LOG(
"resultf:%d buff:%lu", (
int)result, (
unsigned long)buff[0]);
4833 RUBY_DEBUG_LOG(
"result:%d", (
int)result);
4837 if (USE_EVENTFD || result < (ssize_t)
sizeof(buff)) {
4841 else if (result == 0) {
4844 else if (result < 0) {
4850#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
4855 async_bug_fd(
"consume_communication_pipe: read", e, fd);
4862rb_thread_stop_timer_thread(
void)
4864 if (TIMER_THREAD_CREATED_P() && native_stop_timer_thread()) {
4865 native_reset_timer_thread();
4870rb_thread_reset_timer_thread(
void)
4872 native_reset_timer_thread();
4876rb_thread_start_timer_thread(
void)
4879 rb_thread_create_timer_thread();
4883clear_coverage_i(st_data_t key, st_data_t val, st_data_t dummy)
4891 if (GET_VM()->coverage_mode & COVERAGE_TARGET_ONESHOT_LINES) {
4913rb_clear_coverages(
void)
4915 VALUE coverages = rb_get_coverages();
4916 if (
RTEST(coverages)) {
4921#if defined(HAVE_WORKING_FORK)
4929 vm->ractor.main_ractor = r;
4930 vm->ractor.main_thread = th;
4931 r->threads.main = th;
4932 r->status_ = ractor_created;
4934 thread_sched_atfork(TH_SCHED(th));
4938 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
4939 if (r != vm->ractor.main_ractor) {
4940 rb_ractor_terminate_atfork(vm, r);
4942 ccan_list_for_each(&r->threads.set, i, lt_node) {
4946 rb_vm_living_threads_init(vm);
4948 rb_ractor_atfork(vm, th);
4949 rb_vm_postponed_job_atfork();
4953 ccan_list_head_init(&th->interrupt_exec_tasks);
4956 rb_ractor_sleeper_threads_clear(th->ractor);
4957 rb_clear_coverages();
4960 rb_thread_reset_timer_thread();
4961 rb_thread_start_timer_thread();
4963 VM_ASSERT(vm->ractor.blocking_cnt == 0);
4964 VM_ASSERT(vm->ractor.cnt == 1);
4970 if (th != current_th) {
4972 rb_mutex_abandon_keeping_mutexes(th);
4973 rb_mutex_abandon_locking_mutex(th);
4974 thread_cleanup_func(th, TRUE);
4983 rb_threadptr_pending_interrupt_clear(th);
4984 rb_thread_atfork_internal(th, terminate_atfork_i);
4985 th->join_list = NULL;
4986 rb_fiber_atfork(th);
4995 if (th != current_th) {
4996 thread_cleanup_func_before_exec(th);
5004 rb_thread_atfork_internal(th, terminate_atfork_before_exec_i);
5029 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE
5052thgroup_s_alloc(
VALUE klass)
5073thgroup_list(
VALUE group)
5079 ccan_list_for_each(&r->threads.set, th, lt_node) {
5080 if (th->thgroup == group) {
5105thgroup_enclose(
VALUE group)
5124thgroup_enclosed_p(
VALUE group)
5129 return RBOOL(data->enclosed);
5169 if (data->enclosed) {
5177 if (data->enclosed) {
5179 "can't move from the enclosed thread group");
5182 target_th->thgroup = group;
5190thread_shield_mark(
void *ptr)
5192 rb_gc_mark((
VALUE)ptr);
5197 {thread_shield_mark, 0, 0,},
5198 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
5202thread_shield_alloc(
VALUE klass)
5207#define GetThreadShieldPtr(obj) ((VALUE)rb_check_typeddata((obj), &thread_shield_data_type))
5208#define THREAD_SHIELD_WAITING_MASK (((FL_USER19-1)&~(FL_USER0-1))|FL_USER19)
5209#define THREAD_SHIELD_WAITING_SHIFT (FL_USHIFT)
5210#define THREAD_SHIELD_WAITING_MAX (THREAD_SHIELD_WAITING_MASK>>THREAD_SHIELD_WAITING_SHIFT)
5211STATIC_ASSERT(THREAD_SHIELD_WAITING_MAX, THREAD_SHIELD_WAITING_MAX <= UINT_MAX);
5212static inline unsigned int
5213rb_thread_shield_waiting(
VALUE b)
5215 return ((
RBASIC(b)->flags&THREAD_SHIELD_WAITING_MASK)>>THREAD_SHIELD_WAITING_SHIFT);
5219rb_thread_shield_waiting_inc(
VALUE b)
5221 unsigned int w = rb_thread_shield_waiting(b);
5223 if (w > THREAD_SHIELD_WAITING_MAX)
5225 RBASIC(b)->flags &= ~THREAD_SHIELD_WAITING_MASK;
5226 RBASIC(b)->flags |= ((
VALUE)w << THREAD_SHIELD_WAITING_SHIFT);
5230rb_thread_shield_waiting_dec(
VALUE b)
5232 unsigned int w = rb_thread_shield_waiting(b);
5235 RBASIC(b)->flags &= ~THREAD_SHIELD_WAITING_MASK;
5236 RBASIC(b)->flags |= ((
VALUE)w << THREAD_SHIELD_WAITING_SHIFT);
5240rb_thread_shield_new(
void)
5242 VALUE thread_shield = thread_shield_alloc(rb_cThreadShield);
5244 return thread_shield;
5248rb_thread_shield_owned(
VALUE self)
5250 VALUE mutex = GetThreadShieldPtr(self);
5251 if (!mutex)
return false;
5255 return m->fiber == GET_EC()->fiber_ptr;
5267rb_thread_shield_wait(
VALUE self)
5269 VALUE mutex = GetThreadShieldPtr(self);
5272 if (!mutex)
return Qfalse;
5273 m = mutex_ptr(mutex);
5274 if (m->fiber == GET_EC()->fiber_ptr)
return Qnil;
5275 rb_thread_shield_waiting_inc(self);
5277 rb_thread_shield_waiting_dec(self);
5280 return rb_thread_shield_waiting(self) > 0 ?
Qnil :
Qfalse;
5284thread_shield_get_mutex(
VALUE self)
5286 VALUE mutex = GetThreadShieldPtr(self);
5288 rb_raise(
rb_eThreadError,
"destroyed thread shield - %p", (
void *)self);
5296rb_thread_shield_release(
VALUE self)
5298 VALUE mutex = thread_shield_get_mutex(self);
5300 return RBOOL(rb_thread_shield_waiting(self) > 0);
5307rb_thread_shield_destroy(
VALUE self)
5309 VALUE mutex = thread_shield_get_mutex(self);
5312 return RBOOL(rb_thread_shield_waiting(self) > 0);
5318 return th->ec->local_storage_recursive_hash;
5324 th->ec->local_storage_recursive_hash = hash;
5336recursive_list_access(
VALUE sym)
5339 VALUE hash = threadptr_recursive_hash(th);
5342 hash = rb_ident_hash_new();
5343 threadptr_recursive_hash_set(th, hash);
5347 list = rb_hash_aref(hash, sym);
5350 list = rb_ident_hash_new();
5351 rb_hash_aset(hash, sym, list);
5365#if SIZEOF_LONG == SIZEOF_VOIDP
5366 #define OBJ_ID_EQL(obj_id, other) ((obj_id) == (other))
5367#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
5368 #define OBJ_ID_EQL(obj_id, other) (RB_BIGNUM_TYPE_P((obj_id)) ? \
5369 rb_big_eql((obj_id), (other)) : ((obj_id) == (other)))
5372 VALUE pair_list = rb_hash_lookup2(list, obj,
Qundef);
5373 if (UNDEF_P(pair_list))
5375 if (paired_obj_id) {
5377 if (!OBJ_ID_EQL(paired_obj_id, pair_list))
5381 if (
NIL_P(rb_hash_lookup(pair_list, paired_obj_id)))
5403 rb_hash_aset(list, obj,
Qtrue);
5405 else if (UNDEF_P(pair_list = rb_hash_lookup2(list, obj,
Qundef))) {
5406 rb_hash_aset(list, obj, paired_obj);
5410 VALUE other_paired_obj = pair_list;
5411 pair_list = rb_hash_new();
5412 rb_hash_aset(pair_list, other_paired_obj,
Qtrue);
5413 rb_hash_aset(list, obj, pair_list);
5415 rb_hash_aset(pair_list, paired_obj,
Qtrue);
5431 VALUE pair_list = rb_hash_lookup2(list, obj,
Qundef);
5432 if (UNDEF_P(pair_list)) {
5436 rb_hash_delete_entry(pair_list, paired_obj);
5442 rb_hash_delete_entry(list, obj);
5458 return (*p->func)(p->obj, p->arg, FALSE);
5479 p.list = recursive_list_access(sym);
5483 outermost = outer && !recursive_check(p.list,
ID2SYM(recursive_key), 0);
5485 if (recursive_check(p.list, p.obj, pairid)) {
5486 if (outer && !outermost) {
5489 return (*func)(obj, arg, TRUE);
5492 enum ruby_tag_type state;
5497 recursive_push(p.list,
ID2SYM(recursive_key), 0);
5498 recursive_push(p.list, p.obj, p.pairid);
5499 result = rb_catch_protect(p.list, exec_recursive_i, (
VALUE)&p, &state);
5500 if (!recursive_pop(p.list, p.obj, p.pairid))
goto invalid;
5501 if (!recursive_pop(p.list,
ID2SYM(recursive_key), 0))
goto invalid;
5502 if (state != TAG_NONE) EC_JUMP_TAG(GET_EC(), state);
5503 if (result == p.list) {
5504 result = (*func)(obj, arg, TRUE);
5509 recursive_push(p.list, p.obj, p.pairid);
5510 EC_PUSH_TAG(GET_EC());
5511 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
5512 ret = (*func)(obj, arg, FALSE);
5515 if (!recursive_pop(p.list, p.obj, p.pairid)) {
5518 if (state != TAG_NONE) EC_JUMP_TAG(GET_EC(), state);
5527 "for %+"PRIsVALUE
" in %+"PRIsVALUE,
5551 return exec_recursive(func, obj, rb_memory_id(paired_obj), arg, 0,
rb_frame_last_func());
5569 return exec_recursive(func, obj, 0, arg, 1, mid);
5581 return exec_recursive(func, obj, rb_memory_id(paired_obj), arg, 1,
rb_frame_last_func());
5593rb_thread_backtrace_m(
int argc,
VALUE *argv,
VALUE thval)
5595 return rb_vm_thread_backtrace(argc, argv, thval);
5610rb_thread_backtrace_locations_m(
int argc,
VALUE *argv,
VALUE thval)
5612 return rb_vm_thread_backtrace_locations(argc, argv, thval);
5616Init_Thread_Mutex(
void)
5705 rb_vm_register_special_exception(ruby_error_stream_closed,
rb_eIOError,
5706 "stream closed in another thread");
5715 const char * ptr = getenv(
"RUBY_THREAD_TIMESLICE");
5718 long quantum = strtol(ptr, NULL, 0);
5719 if (quantum > 0 && !(SIZEOF_LONG > 4 && quantum > UINT32_MAX)) {
5720 thread_default_quantum_ms = (uint32_t)quantum;
5723 fprintf(stderr,
"Ignored RUBY_THREAD_TIMESLICE=%s\n", ptr);
5728 th->thgroup = th->ractor->thgroup_default =
rb_obj_alloc(cThGroup);
5729 rb_define_const(cThGroup,
"Default", th->thgroup);
5739#ifdef HAVE_PTHREAD_NP_H
5740 VM_ASSERT(TH_SCHED(th)->running == th);
5747 th->pending_interrupt_queue_checked = 0;
5752 rb_thread_create_timer_thread();
5768#ifdef NON_SCALAR_THREAD_ID
5769 #define thread_id_str(th) (NULL)
5771 #define thread_id_str(th) ((void *)(uintptr_t)(th)->nt->thread_id)
5780 rb_str_catf(msg,
"\n%d threads, %d sleeps current:%p main thread:%p\n",
5781 rb_ractor_living_thread_num(r), rb_ractor_sleeper_thread_num(r),
5782 (
void *)GET_THREAD(), (
void *)r->threads.main);
5784 ccan_list_for_each(&r->threads.set, th, lt_node) {
5785 rb_str_catf(msg,
"* %+"PRIsVALUE
"\n rb_thread_t:%p "
5787 th->self, (
void *)th, th->nt ? thread_id_str(th) :
"N/A", th->ec->interrupt_flag);
5789 if (th->locking_mutex) {
5790 rb_mutex_t *mutex = mutex_ptr(th->locking_mutex);
5791 rb_str_catf(msg,
" mutex:%p cond:%"PRIuSIZE,
5792 (
void *)mutex->fiber, rb_mutex_num_waiting(mutex));
5798 rb_str_catf(msg,
"\n depended by: tb_thread_id:%p", (
void *)list->thread);
5802 rb_str_catf(msg,
"\n ");
5803 rb_str_concat(msg,
rb_ary_join(rb_ec_backtrace_str_ary(th->ec, RUBY_BACKTRACE_START, RUBY_ALL_BACKTRACE_LINES), sep));
5804 rb_str_catf(msg,
"\n");
5811 if (GET_THREAD()->vm->thread_ignore_deadlock)
return;
5813#ifdef RUBY_THREAD_PTHREAD_H
5814 if (r->threads.sched.readyq_cnt > 0)
return;
5817 int sleeper_num = rb_ractor_sleeper_thread_num(r);
5818 int ltnum = rb_ractor_living_thread_num(r);
5820 if (ltnum > sleeper_num)
return;
5821 if (ltnum < sleeper_num) rb_bug(
"sleeper must not be more than vm_living_thread_num(vm)");
5826 ccan_list_for_each(&r->threads.set, th, lt_node) {
5827 if (th->status != THREAD_STOPPED_FOREVER || RUBY_VM_INTERRUPTED(th->ec)) {
5830 else if (th->locking_mutex) {
5831 rb_mutex_t *mutex = mutex_ptr(th->locking_mutex);
5832 if (mutex->fiber == th->ec->fiber_ptr || (!mutex->fiber && !ccan_list_empty(&mutex->waitq))) {
5843 argv[1] =
rb_str_new2(
"No live threads left. Deadlock?");
5844 debug_deadlock_check(r, argv[1]);
5845 rb_ractor_sleeper_threads_dec(GET_RACTOR());
5846 rb_threadptr_raise(r->threads.main, 2, argv);
5854 VALUE coverage = rb_iseq_coverage(cfp->iseq);
5859 VM_ASSERT(line >= 0);
5863 if (GET_VM()->coverage_mode & COVERAGE_TARGET_ONESHOT_LINES) {
5864 rb_iseq_clear_event_flags(cfp->iseq, cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded - 1, RUBY_EVENT_COVERAGE_LINE);
5885 VALUE coverage = rb_iseq_coverage(cfp->iseq);
5889 long pc = cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded - 1;
5904 VALUE path, beg_pos_lineno, beg_pos_column, end_pos_lineno, end_pos_column;
5906 if (!me->def)
return NULL;
5909 switch (me->def->type) {
5910 case VM_METHOD_TYPE_ISEQ: {
5913 path = rb_iseq_path(iseq);
5914 beg_pos_lineno =
INT2FIX(loc->code_location.beg_pos.lineno);
5915 beg_pos_column =
INT2FIX(loc->code_location.beg_pos.column);
5916 end_pos_lineno =
INT2FIX(loc->code_location.end_pos.lineno);
5917 end_pos_column =
INT2FIX(loc->code_location.end_pos.column);
5920 case VM_METHOD_TYPE_BMETHOD: {
5921 const rb_iseq_t *iseq = rb_proc_get_iseq(me->def->body.bmethod.proc, 0);
5924 rb_iseq_check(iseq);
5925 path = rb_iseq_path(iseq);
5926 loc = &ISEQ_BODY(iseq)->location;
5927 beg_pos_lineno =
INT2FIX(loc->code_location.beg_pos.lineno);
5928 beg_pos_column =
INT2FIX(loc->code_location.beg_pos.column);
5929 end_pos_lineno =
INT2FIX(loc->code_location.end_pos.lineno);
5930 end_pos_column =
INT2FIX(loc->code_location.end_pos.column);
5935 case VM_METHOD_TYPE_ALIAS:
5936 me = me->def->body.alias.original_me;
5938 case VM_METHOD_TYPE_REFINED:
5939 me = me->def->body.refined.orig_me;
5940 if (!me)
return NULL;
5951 if (resolved_location) {
5952 resolved_location[0] = path;
5953 resolved_location[1] = beg_pos_lineno;
5954 resolved_location[2] = beg_pos_column;
5955 resolved_location[3] = end_pos_lineno;
5956 resolved_location[4] = end_pos_column;
5970 me = rb_resolve_me_location(me, 0);
5973 rcount = rb_hash_aref(me2counter, (
VALUE) me);
5981rb_get_coverages(
void)
5983 return GET_VM()->coverages;
5987rb_get_coverage_mode(
void)
5989 return GET_VM()->coverage_mode;
5993rb_set_coverages(
VALUE coverages,
int mode,
VALUE me2counter)
5995 GET_VM()->coverages = coverages;
5996 GET_VM()->me2counter = me2counter;
5997 GET_VM()->coverage_mode = mode;
6001rb_resume_coverages(
void)
6003 int mode = GET_VM()->coverage_mode;
6004 VALUE me2counter = GET_VM()->me2counter;
6005 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);
6006 if (mode & COVERAGE_TARGET_BRANCHES) {
6007 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);
6009 if (mode & COVERAGE_TARGET_METHODS) {
6015rb_suspend_coverages(
void)
6018 if (GET_VM()->coverage_mode & COVERAGE_TARGET_BRANCHES) {
6021 if (GET_VM()->coverage_mode & COVERAGE_TARGET_METHODS) {
6028rb_reset_coverages(
void)
6030 rb_clear_coverages();
6031 rb_iseq_remove_coverage_all();
6032 GET_VM()->coverages =
Qfalse;
6036rb_default_coverage(
int n)
6038 VALUE coverage = rb_ary_hidden_new_fill(3);
6040 int mode = GET_VM()->coverage_mode;
6042 if (mode & COVERAGE_TARGET_LINES) {
6045 RARRAY_ASET(coverage, COVERAGE_INDEX_LINES, lines);
6047 if (mode & COVERAGE_TARGET_BRANCHES) {
6048 branches = rb_ary_hidden_new_fill(2);
6070 VALUE structure = rb_hash_new();
6076 RARRAY_ASET(coverage, COVERAGE_INDEX_BRANCHES, branches);
6082uninterruptible_exit(
VALUE v)
6085 rb_ary_pop(cur_th->pending_interrupt_mask_stack);
6087 cur_th->pending_interrupt_queue_checked = 0;
6088 if (!rb_threadptr_pending_interrupt_empty_p(cur_th)) {
6089 RUBY_VM_SET_INTERRUPT(cur_th->ec);
6097 VALUE interrupt_mask = rb_ident_hash_new();
6100 rb_hash_aset(interrupt_mask, rb_cObject, sym_never);
6102 rb_ary_push(cur_th->pending_interrupt_mask_stack, interrupt_mask);
6106 RUBY_VM_CHECK_INTS(cur_th->ec);
6113 VM_ASSERT(th->specific_storage == NULL);
6115 if (UNLIKELY(specific_key_count > 0)) {
6116 th->specific_storage =
ZALLOC_N(
void *, RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX);
6120rb_internal_thread_specific_key_t
6125 if (specific_key_count == 0 && vm->ractor.cnt > 1) {
6126 rb_raise(
rb_eThreadError,
"The first rb_internal_thread_specific_key_create() is called with multiple ractors");
6128 else if (specific_key_count > RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX) {
6129 rb_raise(
rb_eThreadError,
"rb_internal_thread_specific_key_create() is called more than %d times", RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX);
6132 rb_internal_thread_specific_key_t key = specific_key_count++;
6139 ccan_list_for_each(&cr->threads.set, th, lt_node) {
6140 thread_specific_storage_alloc(th);
6153 VM_ASSERT(rb_thread_ptr(thread_val) == th);
6154 VM_ASSERT(key < RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX);
6155 VM_ASSERT(th->specific_storage);
6157 return th->specific_storage[key];
6166 VM_ASSERT(rb_thread_ptr(thread_val) == th);
6167 VM_ASSERT(key < RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX);
6168 VM_ASSERT(th->specific_storage);
6170 th->specific_storage[key] = data;
6176 struct ccan_list_node node;
6178 rb_interrupt_exec_func_t *func;
6180 enum rb_interrupt_exec_flag flags;
6184rb_threadptr_interrupt_exec_task_mark(
rb_thread_t *th)
6188 ccan_list_for_each(&th->interrupt_exec_tasks, task, node) {
6189 if (task->flags & rb_interrupt_exec_flag_value_data) {
6190 rb_gc_mark((
VALUE)task->data);
6198rb_threadptr_interrupt_exec(
rb_thread_t *th, rb_interrupt_exec_func_t *func,
void *data,
enum rb_interrupt_exec_flag flags)
6210 ccan_list_add_tail(&th->interrupt_exec_tasks, &task->node);
6211 threadptr_set_interrupt_locked(th,
true);
6228 RUBY_DEBUG_LOG(
"task:%p", task);
6231 if (task->flags & rb_interrupt_exec_flag_new_thread) {
6235 (*task->func)(task->data);
6263 rb_interrupt_exec_func_t *func,
void *data,
enum rb_interrupt_exec_flag flags)
6265 RUBY_DEBUG_LOG(
"flags:%d", (
int)flags);
6268 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_exc_new(VALUE etype, const char *ptr, long len)
Creates an instance of the passed exception class.
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.