Ruby 4.1.0dev (2026-10-27 revision cda3527671a07710b4af10209dde5e51595fb402)
thread_pthread.c (cda3527671a07710b4af10209dde5e51595fb402)
1/* -*-c-*- */
2/**********************************************************************
3
4 thread_pthread.c -
5
6 $Author$
7
8 Copyright (C) 2004-2007 Koichi Sasada
9
10**********************************************************************/
11
12#ifdef THREAD_SYSTEM_DEPENDENT_IMPLEMENTATION
13
14#include "internal/gc.h"
15#include "internal/sanitizers.h"
16
17#ifdef HAVE_SYS_RESOURCE_H
18#include <sys/resource.h>
19#endif
20#ifdef HAVE_THR_STKSEGMENT
21#include <thread.h>
22#endif
23#if defined(HAVE_FCNTL_H)
24#include <fcntl.h>
25#elif defined(HAVE_SYS_FCNTL_H)
26#include <sys/fcntl.h>
27#endif
28#ifdef HAVE_SYS_PRCTL_H
29#include <sys/prctl.h>
30#endif
31#if defined(HAVE_SYS_TIME_H)
32#include <sys/time.h>
33#endif
34#if defined(__HAIKU__)
35#include <kernel/OS.h>
36#endif
37#ifdef __linux__
38#include <sys/syscall.h> /* for SYS_gettid */
39#endif
40#include <time.h>
41#include <signal.h>
42
43#include "probes.h"
44
45#if defined(HAVE_SYS_EVENTFD_H) && defined(HAVE_EVENTFD)
46# define USE_EVENTFD (1)
47# include <sys/eventfd.h>
48#else
49# define USE_EVENTFD (0)
50#endif
51
52#if defined(HAVE_PTHREAD_CONDATTR_SETCLOCK) && \
53 defined(CLOCK_REALTIME) && defined(CLOCK_MONOTONIC) && \
54 defined(HAVE_CLOCK_GETTIME)
55static pthread_condattr_t condattr_mono;
56static pthread_condattr_t *condattr_monotonic = &condattr_mono;
57#else
58static const void *const condattr_monotonic = NULL;
59#endif
60
61// Whether native_cond_timedwait() takes an rb_hrtime_t deadline as is. It
62// does when the condvar counts in the same clock rb_hrtime_now() reads;
63// otherwise the caller has to restate the deadline in the condvar's clock.
64#define RB_NATIVE_COND_HRTIME_DEADLINE_P() (condattr_monotonic != NULL)
65
66#include COROUTINE_H
67
68#ifndef HAVE_SYS_EVENT_H
69#define HAVE_SYS_EVENT_H 0
70#endif
71
72#ifndef HAVE_SYS_EPOLL_H
73#define HAVE_SYS_EPOLL_H 0
74#else
75// force setting for debug
76// #undef HAVE_SYS_EPOLL_H
77// #define HAVE_SYS_EPOLL_H 0
78#endif
79
80#ifndef USE_MN_THREADS
81 #if defined(__EMSCRIPTEN__) || defined(COROUTINE_PTHREAD_CONTEXT)
82 // on __EMSCRIPTEN__ provides epoll* declarations, but no implementations.
83 // on COROUTINE_PTHREAD_CONTEXT, it doesn't worth to use it.
84 #define USE_MN_THREADS 0
85 #elif HAVE_SYS_EPOLL_H
86 #include <sys/epoll.h>
87 #ifdef EPOLLONESHOT
88 #define USE_MN_THREADS 1
89 #else
90 // the scheduler arms io fds with EPOLLONESHOT (Linux 2.6.2)
91 #define USE_MN_THREADS 0
92 #endif
93 #elif HAVE_SYS_EVENT_H
94 #include <sys/event.h>
95 #define USE_MN_THREADS 1
96 #else
97 #define USE_MN_THREADS 0
98 #endif
99#endif
100
101#ifdef HAVE_SCHED_YIELD
102#define native_thread_yield() (void)sched_yield()
103#else
104#define native_thread_yield() ((void)0)
105#endif
106
107// native thread wrappers
108
109#define NATIVE_MUTEX_LOCK_DEBUG 0
110#define NATIVE_MUTEX_LOCK_DEBUG_YIELD 0
111
112static void
113mutex_debug(const char *msg, void *lock)
114{
115 if (NATIVE_MUTEX_LOCK_DEBUG) {
116 int r;
117 static pthread_mutex_t dbglock = PTHREAD_MUTEX_INITIALIZER;
118
119 if ((r = pthread_mutex_lock(&dbglock)) != 0) {exit(EXIT_FAILURE);}
120 fprintf(stdout, "%s: %p\n", msg, lock);
121 if ((r = pthread_mutex_unlock(&dbglock)) != 0) {exit(EXIT_FAILURE);}
122 }
123}
124
125void
126rb_native_mutex_lock(pthread_mutex_t *lock)
127{
128 int r;
129#if NATIVE_MUTEX_LOCK_DEBUG_YIELD
130 native_thread_yield();
131#endif
132 mutex_debug("lock", lock);
133 if ((r = pthread_mutex_lock(lock)) != 0) {
134 rb_bug_errno("pthread_mutex_lock", r);
135 }
136}
137
138void
139rb_native_mutex_unlock(pthread_mutex_t *lock)
140{
141 int r;
142 mutex_debug("unlock", lock);
143 if ((r = pthread_mutex_unlock(lock)) != 0) {
144 rb_bug_errno("pthread_mutex_unlock", r);
145 }
146}
147
148int
149rb_native_mutex_trylock(pthread_mutex_t *lock)
150{
151 int r;
152 mutex_debug("trylock", lock);
153 if ((r = pthread_mutex_trylock(lock)) != 0) {
154 if (r == EBUSY) {
155 return EBUSY;
156 }
157 else {
158 rb_bug_errno("pthread_mutex_trylock", r);
159 }
160 }
161 return 0;
162}
163
164void
165rb_native_mutex_initialize(pthread_mutex_t *lock)
166{
167 int r = pthread_mutex_init(lock, 0);
168 mutex_debug("init", lock);
169 if (r != 0) {
170 rb_bug_errno("pthread_mutex_init", r);
171 }
172}
173
174void
175rb_native_mutex_destroy(pthread_mutex_t *lock)
176{
177 int r = pthread_mutex_destroy(lock);
178 mutex_debug("destroy", lock);
179 if (r != 0) {
180 rb_bug_errno("pthread_mutex_destroy", r);
181 }
182}
183
184void
185rb_native_cond_initialize(rb_nativethread_cond_t *cond)
186{
187 int r = pthread_cond_init(cond, condattr_monotonic);
188 if (r != 0) {
189 rb_bug_errno("pthread_cond_init", r);
190 }
191}
192
193void
194rb_native_cond_destroy(rb_nativethread_cond_t *cond)
195{
196 int r = pthread_cond_destroy(cond);
197 if (r != 0) {
198 rb_bug_errno("pthread_cond_destroy", r);
199 }
200}
201
202/*
203 * In OS X 10.7 (Lion), pthread_cond_signal and pthread_cond_broadcast return
204 * EAGAIN after retrying 8192 times. You can see them in the following page:
205 *
206 * http://www.opensource.apple.com/source/Libc/Libc-763.11/pthreads/pthread_cond.c
207 *
208 * The following rb_native_cond_signal and rb_native_cond_broadcast functions
209 * need to retrying until pthread functions don't return EAGAIN.
210 */
211
212void
213rb_native_cond_signal(rb_nativethread_cond_t *cond)
214{
215 int r;
216 do {
217 r = pthread_cond_signal(cond);
218 } while (r == EAGAIN);
219 if (r != 0) {
220 rb_bug_errno("pthread_cond_signal", r);
221 }
222}
223
224void
225rb_native_cond_broadcast(rb_nativethread_cond_t *cond)
226{
227 int r;
228 do {
229 r = pthread_cond_broadcast(cond);
230 } while (r == EAGAIN);
231 if (r != 0) {
232 rb_bug_errno("rb_native_cond_broadcast", r);
233 }
234}
235
236void
237rb_native_cond_wait(rb_nativethread_cond_t *cond, pthread_mutex_t *mutex)
238{
239 int r = pthread_cond_wait(cond, mutex);
240 if (r != 0) {
241 rb_bug_errno("pthread_cond_wait", r);
242 }
243}
244
245static int
246native_cond_timedwait(rb_nativethread_cond_t *cond, pthread_mutex_t *mutex, const rb_hrtime_t *abs)
247{
248 int r;
249 struct timespec ts;
250
251 /*
252 * An old Linux may return EINTR. Even though POSIX says
253 * "These functions shall not return an error code of [EINTR]".
254 * http://pubs.opengroup.org/onlinepubs/009695399/functions/pthread_cond_timedwait.html
255 * Let's hide it from arch generic code.
256 */
257 do {
258 rb_hrtime2timespec(&ts, abs);
259 r = pthread_cond_timedwait(cond, mutex, &ts);
260 } while (r == EINTR);
261
262 if (r != 0 && r != ETIMEDOUT) {
263 rb_bug_errno("pthread_cond_timedwait", r);
264 }
265
266 return r;
267}
268
269static rb_hrtime_t
270native_cond_timeout(rb_nativethread_cond_t *cond, const rb_hrtime_t rel)
271{
272 if (condattr_monotonic) {
273 return rb_hrtime_add(rb_hrtime_now(), rel);
274 }
275 else {
276 struct timespec ts;
277
278 rb_timespec_now(&ts);
279 return rb_hrtime_add(rb_timespec2hrtime(&ts), rel);
280 }
281}
282
283void
284rb_native_cond_timedwait(rb_nativethread_cond_t *cond, pthread_mutex_t *mutex, unsigned long msec)
285{
286 rb_hrtime_t hrmsec = native_cond_timeout(cond, RB_HRTIME_PER_MSEC * msec);
287 native_cond_timedwait(cond, mutex, &hrmsec);
288}
289
290// thread scheduling
291
292static rb_internal_thread_event_hook_t *rb_internal_thread_event_hooks = NULL;
293static void rb_thread_execute_hooks(rb_event_flag_t event, rb_thread_t *th);
294
295#if 0
296static const char *
297event_name(rb_event_flag_t event)
298{
299 switch (event) {
301 return "STARTED";
303 return "READY";
305 return "RESUMED";
307 return "SUSPENDED";
309 return "EXITED";
310 }
311 return "no-event";
312}
313
314#define RB_INTERNAL_THREAD_HOOK(event, th) \
315 if (UNLIKELY(rb_internal_thread_event_hooks)) { \
316 fprintf(stderr, "[thread=%"PRIxVALUE"] %s in %s (%s:%d)\n", th->self, event_name(event), __func__, __FILE__, __LINE__); \
317 rb_thread_execute_hooks(event, th); \
318 }
319#else
320#define RB_INTERNAL_THREAD_HOOK(event, th) if (UNLIKELY(rb_internal_thread_event_hooks)) { rb_thread_execute_hooks(event, th); }
321#endif
322
323static rb_serial_t current_fork_gen = 1; /* We can't use GET_VM()->fork_gen */
324
325#if defined(SIGVTALRM) && !defined(__EMSCRIPTEN__)
326# define USE_UBF_LIST 1
327#endif
328
329#if USE_MN_THREADS
330static void nt_machine_stack_atfork(void);
331
332// A coroutine thread's execution context: the coroutine_context (first, so
333// th->sched.context points at the whole block) plus what is needed to free
334// it without the rb_thread_t. Owned by the execution: the dying thread marks
335// it dead before its final transfer, and whichever context RESUMES from that
336// transfer frees it -- the resume itself proves the transfer's register save
337// into this block has completed, so no further synchronization is needed.
338struct rb_thread_context {
339 struct coroutine_context co; // must be first
340 void *stack; // the coroutine machine stack (pool stack)
341 struct rb_native_thread *nt; // final transfer target, stashed at termination
342 bool dead;
343};
344
345static bool thread_sched_reclaim(struct coroutine_context *dead_co);
346#endif
347
348
349#ifdef RB_THREAD_T_HAS_NATIVE_ID
350static int
351get_native_thread_id(void)
352{
353#ifdef __linux__
354 return (int)syscall(SYS_gettid);
355#elif defined(__FreeBSD__)
356 return pthread_getthreadid_np();
357#endif
358}
359#endif
360
361
362#ifdef RB_THREAD_LOCAL_SPECIFIER
363static RB_THREAD_LOCAL_SPECIFIER rb_thread_t *ruby_native_thread;
364#else
365static pthread_key_t ruby_native_thread_key;
366#endif
367
368static void
369null_func(int i)
370{
371 /* null */
372 // This function can be called from signal handler
373 // RUBY_DEBUG_LOG("i:%d", i);
374}
375
377ruby_thread_from_native(void)
378{
379#ifdef RB_THREAD_LOCAL_SPECIFIER
380 return ruby_native_thread;
381#else
382 return pthread_getspecific(ruby_native_thread_key);
383#endif
384}
385
386int
387ruby_thread_set_native(rb_thread_t *th)
388{
389 if (th) {
390#ifdef USE_UBF_LIST
391 ccan_list_node_init(&th->sched.node.ubf);
392#endif
393 }
394
395 // setup TLS
396
397 if (th && th->ec) {
398 rb_ractor_set_current_ec(th->ractor, th->ec);
399 }
400#ifdef RB_THREAD_LOCAL_SPECIFIER
401 ruby_native_thread = th;
402 return 1;
403#else
404 return pthread_setspecific(ruby_native_thread_key, th) == 0;
405#endif
406}
407
408static void native_thread_setup(struct rb_native_thread *nt);
409static void native_thread_setup_on_thread(struct rb_native_thread *nt);
410
411// Internal cache of page size:
412static size_t RB_THREAD_PAGE_SIZE;
413
414void
415Init_native_thread(rb_thread_t *main_th)
416{
417 // Get the system page size for later use in stack allocation and stack overflow checks:
418 RB_THREAD_PAGE_SIZE = sysconf(_SC_PAGESIZE);
419
420#if defined(HAVE_PTHREAD_CONDATTR_SETCLOCK)
421 if (condattr_monotonic) {
422 int r = pthread_condattr_init(condattr_monotonic);
423 if (r == 0) {
424 r = pthread_condattr_setclock(condattr_monotonic, CLOCK_MONOTONIC);
425 }
426 if (r) condattr_monotonic = NULL;
427 }
428#endif
429
430#ifndef RB_THREAD_LOCAL_SPECIFIER
431 if (pthread_key_create(&ruby_native_thread_key, 0) == EAGAIN) {
432 rb_bug("pthread_key_create failed (ruby_native_thread_key)");
433 }
434 if (pthread_key_create(&ruby_current_ec_key, 0) == EAGAIN) {
435 rb_bug("pthread_key_create failed (ruby_current_ec_key)");
436 }
437#endif
438 ruby_posix_signal(SIGVTALRM, null_func);
439
440 // setup vm
441 rb_vm_t *vm = main_th->vm;
442 thread_sched_init_vm(vm);
443
444 // setup main thread
445 main_th->nt->thread_id = pthread_self();
446 main_th->nt->serial = 1;
447#ifdef RUBY_NT_SERIAL
448 ruby_nt_serial = 1;
449#endif
450 ruby_thread_set_native(main_th);
451 native_thread_setup(main_th->nt);
452 native_thread_setup_on_thread(main_th->nt);
453
454 TH_SCHED(main_th)->running = main_th;
455 main_th->has_dedicated_nt = 1;
456
457 // setup main NT (before the record below: its kind decides where it goes)
458 main_th->nt->dedicated = 1;
459 main_th->nt->running_thread = main_th;
460 main_th->nt->vm = vm;
461
462 thread_sched_setup_running_threads(TH_SCHED(main_th), main_th->ractor, vm, main_th, NULL);
463
464 // setup mn
465#if USE_RUBY_DEBUG_LOG
466 vm->ractor.sched.dnt_cnt = 1;
467#endif
468}
469
470
471static void
472native_thread_destroy_atfork(struct rb_native_thread *nt)
473{
474 if (nt) {
475 /* We can't call rb_native_cond_destroy here because according to the
476 * specs of pthread_cond_destroy:
477 *
478 * Attempting to destroy a condition variable upon which other threads
479 * are currently blocked results in undefined behavior.
480 *
481 * Specifically, glibc's pthread_cond_destroy waits on all the other
482 * listeners. Since after forking all the threads are dead, the condition
483 * variable's listeners will never wake up, so it will hang forever.
484 */
485
486 RB_ALTSTACK_FREE(nt->altstack);
487 SIZED_FREE(nt->nt_context);
488 SIZED_FREE(nt);
489 }
490}
491
492static void
493native_thread_destroy(struct rb_native_thread *nt)
494{
495 if (nt) {
496 rb_native_cond_destroy(&nt->readyq);
497 rb_native_mutex_destroy(&nt->running_th_lock);
498
499 native_thread_destroy_atfork(nt);
500 }
501}
502
503// A retiring snt frees its own rb_native_thread as it exits. Disarm the
504// altstack registration first: a signal between the free and the thread's
505// end must not run on the freed block.
506static void
507native_thread_destroy_self(struct rb_native_thread *nt)
508{
509#ifdef USE_SIGALTSTACK
510 stack_t disable = {0};
511 disable.ss_flags = SS_DISABLE;
512 sigaltstack(&disable, NULL);
513#endif
514 native_thread_destroy(nt);
515}
516
517#if defined HAVE_PTHREAD_GETATTR_NP || defined HAVE_PTHREAD_ATTR_GET_NP
518#define STACKADDR_AVAILABLE 1
519# if defined(__linux__) && !defined __GLIBC__
520 /* Musl libc defines `pthread_getattr_np` but it can not get the
521 * correct value of the main thread. */
522# define MAINSTACKADDR_AVAILABLE 0
523# endif
524#elif defined HAVE_PTHREAD_GET_STACKADDR_NP && defined HAVE_PTHREAD_GET_STACKSIZE_NP
525#define STACKADDR_AVAILABLE 1
526#undef MAINSTACKADDR_AVAILABLE
527#define MAINSTACKADDR_AVAILABLE 1
528void *pthread_get_stackaddr_np(pthread_t);
529size_t pthread_get_stacksize_np(pthread_t);
530#elif defined HAVE_THR_STKSEGMENT || defined HAVE_PTHREAD_STACKSEG_NP
531#define STACKADDR_AVAILABLE 1
532#elif defined HAVE_PTHREAD_GETTHRDS_NP
533#define STACKADDR_AVAILABLE 1
534#elif defined __HAIKU__
535#define STACKADDR_AVAILABLE 1
536#endif
537
538#ifndef MAINSTACKADDR_AVAILABLE
539# ifdef STACKADDR_AVAILABLE
540# define MAINSTACKADDR_AVAILABLE 1
541# else
542# define MAINSTACKADDR_AVAILABLE 0
543# endif
544#endif
545#if MAINSTACKADDR_AVAILABLE && !defined(get_main_stack)
546# define get_main_stack(addr, size) get_stack(addr, size)
547#endif
548
549#ifdef STACKADDR_AVAILABLE
550/*
551 * Get the initial address and size of current thread's stack
552 */
553static int
554get_stack(void **addr, size_t *size)
555{
556#define CHECK_ERR(expr) \
557 {int err = (expr); if (err) return err;}
558#ifdef HAVE_PTHREAD_GETATTR_NP /* Linux */
559 pthread_attr_t attr;
560 size_t guard = 0;
561 STACK_GROW_DIR_DETECTION;
562 CHECK_ERR(pthread_getattr_np(pthread_self(), &attr));
563# ifdef HAVE_PTHREAD_ATTR_GETSTACK
564 CHECK_ERR(pthread_attr_getstack(&attr, addr, size));
565 STACK_DIR_UPPER((void)0, (void)(*addr = (char *)*addr + *size));
566# else
567 CHECK_ERR(pthread_attr_getstackaddr(&attr, addr));
568 CHECK_ERR(pthread_attr_getstacksize(&attr, size));
569# endif
570# ifdef HAVE_PTHREAD_ATTR_GETGUARDSIZE
571 CHECK_ERR(pthread_attr_getguardsize(&attr, &guard));
572# else
573 guard = RB_THREAD_PAGE_SIZE;
574# endif
575 *size -= guard;
576 pthread_attr_destroy(&attr);
577#elif defined HAVE_PTHREAD_ATTR_GET_NP /* FreeBSD, DragonFly BSD, NetBSD */
578 pthread_attr_t attr;
579 CHECK_ERR(pthread_attr_init(&attr));
580 CHECK_ERR(pthread_attr_get_np(pthread_self(), &attr));
581# ifdef HAVE_PTHREAD_ATTR_GETSTACK
582 CHECK_ERR(pthread_attr_getstack(&attr, addr, size));
583# else
584 CHECK_ERR(pthread_attr_getstackaddr(&attr, addr));
585 CHECK_ERR(pthread_attr_getstacksize(&attr, size));
586# endif
587 STACK_DIR_UPPER((void)0, (void)(*addr = (char *)*addr + *size));
588 pthread_attr_destroy(&attr);
589#elif (defined HAVE_PTHREAD_GET_STACKADDR_NP && defined HAVE_PTHREAD_GET_STACKSIZE_NP) /* MacOS X */
590 pthread_t th = pthread_self();
591 *addr = pthread_get_stackaddr_np(th);
592 *size = pthread_get_stacksize_np(th);
593#elif defined HAVE_THR_STKSEGMENT || defined HAVE_PTHREAD_STACKSEG_NP
594 stack_t stk;
595# if defined HAVE_THR_STKSEGMENT /* Solaris */
596 CHECK_ERR(thr_stksegment(&stk));
597# else /* OpenBSD */
598 CHECK_ERR(pthread_stackseg_np(pthread_self(), &stk));
599# endif
600 *addr = stk.ss_sp;
601 *size = stk.ss_size;
602#elif defined HAVE_PTHREAD_GETTHRDS_NP /* AIX */
603 pthread_t th = pthread_self();
604 struct __pthrdsinfo thinfo;
605 char reg[256];
606 int regsiz=sizeof(reg);
607 CHECK_ERR(pthread_getthrds_np(&th, PTHRDSINFO_QUERY_ALL,
608 &thinfo, sizeof(thinfo),
609 &reg, &regsiz));
610 *addr = thinfo.__pi_stackaddr;
611 /* Must not use thinfo.__pi_stacksize for size.
612 It is around 3KB smaller than the correct size
613 calculated by thinfo.__pi_stackend - thinfo.__pi_stackaddr. */
614 *size = thinfo.__pi_stackend - thinfo.__pi_stackaddr;
615 STACK_DIR_UPPER((void)0, (void)(*addr = (char *)*addr + *size));
616#elif defined __HAIKU__
617 thread_info info;
618 STACK_GROW_DIR_DETECTION;
619 CHECK_ERR(get_thread_info(find_thread(NULL), &info));
620 *addr = info.stack_base;
621 *size = (uintptr_t)info.stack_end - (uintptr_t)info.stack_base;
622 STACK_DIR_UPPER((void)0, (void)(*addr = (char *)*addr + *size));
623#else
624#error STACKADDR_AVAILABLE is defined but not implemented.
625#endif
626 return 0;
627#undef CHECK_ERR
628}
629#endif
630
631static struct {
632 rb_nativethread_id_t id;
633 size_t stack_maxsize;
634 VALUE *stack_start;
635} native_main_thread;
636
637// Whether the calling native thread may leave the shared pool. The process's
638// main pthread cannot: under RUBY_MN_THREADS=2 its loop runs on a stack only
639// it could free (thread_sched_main_to_shared). By pthread_self(), not
640// nt->thread_id, which pthread_create may still be writing.
641static bool
642native_thread_self_can_retire_p(void)
643{
644 return !pthread_equal(pthread_self(), native_main_thread.id);
645}
646
647#if defined(HAVE_WORKING_FORK)
648// The forking thread's pthread is the child's only one, hence its main one
649static void
650native_main_thread_atfork(void)
651{
652 native_main_thread.id = pthread_self();
653 // The stack recorded here is the parent's initial one; this thread's is
654 // another. Nothing reads it for a thread that is already running, and
655 // saying "unknown" beats saying the wrong bounds.
656 native_main_thread.stack_maxsize = 0;
657}
658#endif
659
660#ifdef STACK_END_ADDRESS
661extern void *STACK_END_ADDRESS;
662#endif
663
664static void
665native_thread_init_main_thread_stack(void *addr)
666{
667 native_main_thread.id = pthread_self();
668#ifdef RUBY_ASAN_ENABLED
669 addr = asan_get_real_stack_addr((void *)addr);
670#endif
671
672#if MAINSTACKADDR_AVAILABLE
673 if (native_main_thread.stack_maxsize) return;
674 {
675 void* stackaddr;
676 size_t size;
677 if (get_main_stack(&stackaddr, &size) == 0) {
678 native_main_thread.stack_maxsize = size;
679 native_main_thread.stack_start = stackaddr;
680 goto bound_check;
681 }
682 }
683#endif
684#ifdef STACK_END_ADDRESS
685 native_main_thread.stack_start = STACK_END_ADDRESS;
686#else
687 if (!native_main_thread.stack_start ||
688 STACK_UPPER((VALUE *)(void *)&addr,
689 native_main_thread.stack_start > (VALUE *)addr,
690 native_main_thread.stack_start < (VALUE *)addr)) {
691 native_main_thread.stack_start = (VALUE *)addr;
692 }
693#endif
694 {
695#if defined(HAVE_GETRLIMIT)
696#if defined(PTHREAD_STACK_DEFAULT)
697 size_t size = PTHREAD_STACK_DEFAULT;
698#else
699 size_t size = RUBY_VM_THREAD_VM_STACK_SIZE;
700#endif
701 size_t space;
702 struct rlimit rlim;
703 STACK_GROW_DIR_DETECTION;
704 if (getrlimit(RLIMIT_STACK, &rlim) == 0) {
705 size = (size_t)rlim.rlim_cur;
706 }
707 addr = native_main_thread.stack_start;
708 if (IS_STACK_DIR_UPPER()) {
709 space = ((size_t)((char *)addr + size) / RB_THREAD_PAGE_SIZE) * RB_THREAD_PAGE_SIZE - (size_t)addr;
710 }
711 else {
712 space = (size_t)addr - ((size_t)((char *)addr - size) / RB_THREAD_PAGE_SIZE + 1) * RB_THREAD_PAGE_SIZE;
713 }
714 native_main_thread.stack_maxsize = space;
715#endif
716 }
717
718#if MAINSTACKADDR_AVAILABLE
719 bound_check:
720#endif
721 /* If addr is out of range of main-thread stack range estimation, */
722 /* it should be on co-routine (alternative stack). [Feature #2294] */
723 {
724 void *start, *end;
725 STACK_GROW_DIR_DETECTION;
726
727 if (IS_STACK_DIR_UPPER()) {
728 start = native_main_thread.stack_start;
729 end = (char *)native_main_thread.stack_start + native_main_thread.stack_maxsize;
730 }
731 else {
732 start = (char *)native_main_thread.stack_start - native_main_thread.stack_maxsize;
733 end = native_main_thread.stack_start;
734 }
735
736 if ((void *)addr < start || (void *)addr > end) {
737 /* out of range */
738 native_main_thread.stack_start = (VALUE *)addr;
739 native_main_thread.stack_maxsize = 0; /* unknown */
740 }
741 }
742}
743
744#define CHECK_ERR(expr) \
745 {int err = (expr); if (err) {rb_bug_errno(#expr, err);}}
746
747static int
748native_thread_init_stack(rb_thread_t *th, void *local_in_parent_frame)
749{
750 rb_nativethread_id_t curr = pthread_self();
751#ifdef RUBY_ASAN_ENABLED
752 local_in_parent_frame = asan_get_real_stack_addr(local_in_parent_frame);
753 th->ec->machine.asan_fake_stack_handle = asan_get_thread_fake_stack_handle();
754#endif
755
756 if (!native_main_thread.id) {
757 /* This thread is the first thread, must be the main thread -
758 * configure the native_main_thread object */
759 native_thread_init_main_thread_stack(local_in_parent_frame);
760 }
761
762 if (th->sched.context != NULL) {
763 // an M:N thread runs on the pool stack native_thread_create_shared
764 // recorded, whichever native thread (the main one included) hosts it.
765 // Not by nt->dedicated: a RESUMED hook may have pinned the nt already.
766 }
767 else if (pthread_equal(curr, native_main_thread.id)) {
768 th->ec->machine.stack_start = native_main_thread.stack_start;
769 th->ec->machine.stack_maxsize = native_main_thread.stack_maxsize;
770 }
771 else {
772#ifdef STACKADDR_AVAILABLE
773 void *start;
774 size_t size;
775
776 if (get_stack(&start, &size) == 0) {
777 uintptr_t diff = (uintptr_t)start - (uintptr_t)local_in_parent_frame;
778 th->ec->machine.stack_start = local_in_parent_frame;
779 th->ec->machine.stack_maxsize = size - diff;
780 }
781#else
782 rb_raise(rb_eNotImpError, "ruby engine can initialize only in the main thread");
783#endif
784 }
785
786 return 0;
787}
788
789struct nt_param {
790 rb_vm_t *vm;
791 struct rb_native_thread *nt;
792};
793
794
795static int
796native_thread_create0(struct rb_native_thread *nt)
797{
798 int err = 0;
799 pthread_attr_t attr;
800
801 const size_t stack_size = nt->vm->default_params.thread_machine_stack_size;
802
803#ifdef USE_SIGALTSTACK
804 nt->altstack = rb_allocate_sigaltstack();
805#endif
806
807 CHECK_ERR(pthread_attr_init(&attr));
808
809# ifdef PTHREAD_STACK_MIN
810 RUBY_DEBUG_LOG("stack size: %lu", (unsigned long)stack_size);
811 CHECK_ERR(pthread_attr_setstacksize(&attr, stack_size));
812# endif
813
814# ifdef HAVE_PTHREAD_ATTR_SETINHERITSCHED
815 CHECK_ERR(pthread_attr_setinheritsched(&attr, PTHREAD_INHERIT_SCHED));
816# endif
817 CHECK_ERR(pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED));
818
819 err = pthread_create(&nt->thread_id, &attr, nt_start, nt);
820
821 RUBY_DEBUG_LOG("nt:%d err:%d", (int)nt->serial, err);
822
823 CHECK_ERR(pthread_attr_destroy(&attr));
824
825 return err;
826}
827
828static void
829native_thread_setup(struct rb_native_thread *nt)
830{
831 // init cond
832 rb_native_cond_initialize(&nt->readyq);
833 // also for the main thread's nt: a zero-filled mutex is not usable on macOS
834 rb_native_mutex_initialize(&nt->running_th_lock);
835}
836
837static void
838native_thread_setup_on_thread(struct rb_native_thread *nt)
839{
840 // init tid
841#ifdef RB_THREAD_T_HAS_NATIVE_ID
842 nt->tid = get_native_thread_id();
843#endif
844
845 // init signal handler
846 RB_ALTSTACK_INIT(nt->altstack, nt->altstack);
847}
848
849static struct rb_native_thread *
850native_thread_alloc(void)
851{
852 struct rb_native_thread *nt = ZALLOC(struct rb_native_thread);
853 native_thread_setup(nt);
854
855#if USE_MN_THREADS
856 nt->nt_context = ruby_xmalloc(sizeof(struct coroutine_context));
857#endif
858
859#if USE_RUBY_DEBUG_LOG
860 static rb_atomic_t nt_serial = 2;
861 nt->serial = RUBY_ATOMIC_FETCH_ADD(nt_serial, 1);
862#endif
863 return nt;
864}
865
866
867
868
869#if USE_NATIVE_THREAD_PRIORITY
870
871static void
872native_thread_apply_priority(rb_thread_t *th)
873{
874#if defined(_POSIX_PRIORITY_SCHEDULING) && (_POSIX_PRIORITY_SCHEDULING > 0)
875 struct sched_param sp;
876 int policy;
877 int priority = 0 - th->priority;
878 int max, min;
879 pthread_getschedparam(th->nt->thread_id, &policy, &sp);
880 max = sched_get_priority_max(policy);
881 min = sched_get_priority_min(policy);
882
883 if (min > priority) {
884 priority = min;
885 }
886 else if (max < priority) {
887 priority = max;
888 }
889
890 sp.sched_priority = priority;
891 pthread_setschedparam(th->nt->thread_id, policy, &sp);
892#else
893 /* not touched */
894#endif
895}
896
897#endif /* USE_NATIVE_THREAD_PRIORITY */
898
899static int
900native_fd_select(int n, rb_fdset_t *readfds, rb_fdset_t *writefds, rb_fdset_t *exceptfds, struct timeval *timeout, rb_thread_t *th)
901{
902 return rb_fd_select(n, readfds, writefds, exceptfds, timeout);
903}
904
905/*
906 * Send a signal to make the target thread return from a blocking syscall.
907 * Maybe any signal is ok, but we chose SIGVTALRM (see null_func).
908 */
909static void
910native_thread_interrupt(rb_thread_t *th)
911{
912 pthread_kill(th->nt->thread_id, SIGVTALRM);
913}
914
915static int
916native_thread_default_max_cpu(void)
917{
918#if defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_ONLN)
919 long nprocessors = sysconf(_SC_NPROCESSORS_ONLN);
920 return (nprocessors > 0) ? (int)nprocessors : 8;
921#else
922 return 8;
923#endif
924}
925
926
927#define TT_DEBUG 0
928#define WRITE_CONST(fd, str) (void)(write((fd),(str),sizeof(str)-1)<0)
929
930void
931rb_thread_wakeup_timer_thread(int sig)
932{
933 // This function can be called from signal handlers so that
934 // pthread_mutex_lock() should not be used.
935
936 // wakeup timer thread
937 timer_thread_wakeup_force();
938
939 // interrupt main thread if main thread is available
940 if (RUBY_ATOMIC_LOAD(system_working)) {
941 rb_vm_t *vm = GET_VM();
942 rb_thread_t *main_th = vm->ractor.main_thread;
943
944 if (main_th) {
945 volatile rb_execution_context_t *main_th_ec = ACCESS_ONCE(rb_execution_context_t *, main_th->ec);
946
947 if (main_th_ec) {
948 RUBY_VM_SET_TRAP_INTERRUPT(main_th_ec);
949
950 if (vm->ubf_async_safe && main_th->unblock.func) {
951 (main_th->unblock.func)(main_th->unblock.arg);
952 }
953 }
954 }
955 }
956}
957
958#define CLOSE_INVALIDATE_PAIR(expr) \
959 close_invalidate_pair(expr,"close_invalidate: "#expr)
960static void
961close_invalidate(int *fdp, const char *msg)
962{
963 int fd = *fdp;
964
965 *fdp = -1;
966 if (close(fd) < 0) {
967 async_bug_fd(msg, errno, fd);
968 }
969}
970
971static void
972close_invalidate_pair(int fds[2], const char *msg)
973{
974 if (USE_EVENTFD && fds[0] == fds[1]) {
975 fds[1] = -1; // disable write port first
976 close_invalidate(&fds[0], msg);
977 }
978 else {
979 close_invalidate(&fds[1], msg);
980 close_invalidate(&fds[0], msg);
981 }
982}
983
984static void
985set_nonblock(int fd)
986{
987 int oflags;
988 int err;
989
990 oflags = fcntl(fd, F_GETFL);
991 if (oflags == -1)
992 rb_sys_fail(0);
993 oflags |= O_NONBLOCK;
994 err = fcntl(fd, F_SETFL, oflags);
995 if (err == -1)
996 rb_sys_fail(0);
997}
998
999/* communication pipe with timer thread and signal handler */
1000static void
1001setup_communication_pipe_internal(int pipes[2])
1002{
1003 int err;
1004
1005 if (pipes[0] > 0 || pipes[1] > 0) {
1006 VM_ASSERT(pipes[0] > 0);
1007 VM_ASSERT(pipes[1] > 0);
1008 return;
1009 }
1010
1011 /*
1012 * Don't bother with eventfd on ancient Linux 2.6.22..2.6.26 which were
1013 * missing EFD_* flags, they can fall back to pipe
1014 */
1015#if USE_EVENTFD && defined(EFD_NONBLOCK) && defined(EFD_CLOEXEC)
1016 pipes[0] = pipes[1] = eventfd(0, EFD_NONBLOCK|EFD_CLOEXEC);
1017
1018 if (pipes[0] >= 0) {
1019 rb_update_max_fd(pipes[0]);
1020 return;
1021 }
1022#endif
1023
1024 err = rb_cloexec_pipe(pipes);
1025 if (err != 0) {
1026 rb_bug("can not create communication pipe");
1027 }
1028 rb_update_max_fd(pipes[0]);
1029 rb_update_max_fd(pipes[1]);
1030 set_nonblock(pipes[0]);
1031 set_nonblock(pipes[1]);
1032}
1033
1034#if !defined(SET_CURRENT_THREAD_NAME) && defined(__linux__) && defined(PR_SET_NAME)
1035# define SET_CURRENT_THREAD_NAME(name) prctl(PR_SET_NAME, name)
1036#endif
1037
1038enum {
1039 THREAD_NAME_MAX =
1040#if defined(__linux__)
1041 16
1042#elif defined(__APPLE__)
1043/* Undocumented, and main thread seems unlimited */
1044 64
1045#else
1046 16
1047#endif
1048};
1049
1050static VALUE threadptr_invoke_proc_location(rb_thread_t *th);
1051
1052static void
1053native_set_thread_name(rb_thread_t *th)
1054{
1055#ifdef SET_CURRENT_THREAD_NAME
1056 VALUE loc;
1057
1058 // An M:N thread does not own the native thread it runs on: naming it here
1059 // would name whichever nt started it (under RUBY_MN_THREADS=2 that can be
1060 // the process's main one, whose name is the process's). Thread#name= is
1061 // skipped for the same reason (rb_thread_setname).
1062 if (!th->has_dedicated_nt) return;
1063
1064 if (!NIL_P(loc = th->name)) {
1065 SET_CURRENT_THREAD_NAME(RSTRING_PTR(loc));
1066 }
1067 else if ((loc = threadptr_invoke_proc_location(th)) != Qnil) {
1068 char *name, *p;
1069 char buf[THREAD_NAME_MAX];
1070 size_t len;
1071 int n;
1072
1073 name = RSTRING_PTR(RARRAY_AREF(loc, 0));
1074 p = strrchr(name, '/'); /* show only the basename of the path. */
1075 if (p && p[1])
1076 name = p + 1;
1077
1078 n = snprintf(buf, sizeof(buf), "%s:%d", name, NUM2INT(RARRAY_AREF(loc, 1)));
1079 RB_GC_GUARD(loc);
1080
1081 len = (size_t)n;
1082 if (len >= sizeof(buf)) {
1083 buf[sizeof(buf)-2] = '*';
1084 buf[sizeof(buf)-1] = '\0';
1085 }
1086 SET_CURRENT_THREAD_NAME(buf);
1087 }
1088#endif
1089}
1090
1091static void
1092native_set_another_thread_name(rb_nativethread_id_t thread_id, VALUE name)
1093{
1094#if defined SET_ANOTHER_THREAD_NAME || defined SET_CURRENT_THREAD_NAME
1095 char buf[THREAD_NAME_MAX];
1096 const char *s = "";
1097# if !defined SET_ANOTHER_THREAD_NAME
1098 if (!pthread_equal(pthread_self(), thread_id)) return;
1099# endif
1100 if (!NIL_P(name)) {
1101 rb_len_t n;
1102 RSTRING_GETMEM(name, s, n);
1103 if (n >= (int)sizeof(buf)) {
1104 memcpy(buf, s, sizeof(buf)-1);
1105 buf[sizeof(buf)-1] = '\0';
1106 s = buf;
1107 }
1108 }
1109# if defined SET_ANOTHER_THREAD_NAME
1110 SET_ANOTHER_THREAD_NAME(thread_id, s);
1111# elif defined SET_CURRENT_THREAD_NAME
1112 SET_CURRENT_THREAD_NAME(s);
1113# endif
1114#endif
1115}
1116
1117#if defined(RB_THREAD_T_HAS_NATIVE_ID) || defined(__APPLE__)
1118static VALUE
1119native_thread_native_thread_id(rb_thread_t *target_th)
1120{
1121 if (!target_th->nt) return Qnil;
1122
1123#ifdef RB_THREAD_T_HAS_NATIVE_ID
1124 int tid = target_th->nt->tid;
1125 if (tid == 0) return Qnil;
1126 return INT2FIX(tid);
1127#elif defined(__APPLE__)
1128 uint64_t tid;
1129 int e = pthread_threadid_np(target_th->nt->thread_id, &tid);
1130 if (e != 0) rb_syserr_fail(e, "pthread_threadid_np");
1131 return ULL2NUM((unsigned long long)tid);
1132#endif
1133}
1134# define USE_NATIVE_THREAD_NATIVE_THREAD_ID 1
1135#else
1136# define USE_NATIVE_THREAD_NATIVE_THREAD_ID 0
1137#endif
1138
1139static struct {
1140 rb_serial_t created_fork_gen;
1141 pthread_t pthread_id;
1142
1143 int comm_fds[2]; // r, w
1144
1145#if (HAVE_SYS_EPOLL_H || HAVE_SYS_EVENT_H) && USE_MN_THREADS
1146 int event_fd; // kernel event queue fd (epoll/kqueue)
1147#endif
1148#if HAVE_SYS_EPOLL_H && USE_MN_THREADS
1149#define EPOLL_EVENTS_MAX 0x10
1150 struct epoll_event finished_events[EPOLL_EVENTS_MAX];
1151#elif HAVE_SYS_EVENT_H && USE_MN_THREADS
1152#define KQUEUE_EVENTS_MAX 0x10
1153 struct kevent finished_events[KQUEUE_EVENTS_MAX];
1154#endif
1155
1156#if USE_MN_THREADS
1157 /* Timed waiters, bucketed by deadline into a hierarchical timer wheel;
1158 * untimed (fd-only) waiters keep a plain list. Both under waiting_lock.
1159 * The wheel operations all live in thread_sched_mn.c (timer_wheel_*). */
1160#define TIMER_WHEEL_LEVELS 4
1161#define TIMER_WHEEL_SLOT_BITS 6
1162#define TIMER_WHEEL_SLOTS (1 << TIMER_WHEEL_SLOT_BITS)
1163 struct timer_wheel_level {
1164 uint64_t occupied; // bit s: slots[s] is non-empty
1165 struct ccan_list_head slots[TIMER_WHEEL_SLOTS];
1166 } wheel[TIMER_WHEEL_LEVELS];
1167 uint64_t wheel_cursor_tick; // slots for ticks <= this are drained
1168 rb_hrtime_t next_expiry; // never later than the earliest deadline
1169 pthread_mutex_t waiting_lock; // the wheel and the flags of fd-less timed waits
1170
1171 /* The fd map entries and the flags of io waits are guarded per fd by a
1172 * shard lock, so unrelated fds register and wake in parallel. Whoever
1173 * clears an io wait's flags under its shard owns the wakeup. Lock order:
1174 * shard -> waiting_lock -> wake_pending_lock, never the other way. */
1175#define IO_WAIT_SHARDS 16
1176 pthread_mutex_t fd_shard_locks[IO_WAIT_SHARDS];
1177
1178 // signaled when wake_pending clears on a thread; see timer_thread_wake_fence
1179 pthread_mutex_t wake_pending_lock;
1180 rb_nativethread_cond_t wake_pending_cond;
1181#endif
1182
1183#if (HAVE_SYS_EPOLL_H || HAVE_SYS_EVENT_H) && USE_MN_THREADS
1184 // fd -> struct rb_fd_waiters, in chunks so entries never move. The chunk
1185 // table installs slots by CAS (chunks span shards); entry state is guarded
1186 // by the fd's shard lock.
1187#define FDMAP_MAX_CHUNKS 1024 // fds up to FDMAP_MAX_CHUNKS * FDMAP_CHUNK_SIZE
1188 struct rb_fd_waiters *fdmap_chunks[FDMAP_MAX_CHUNKS];
1189#endif
1190} timer_th = {
1191 .created_fork_gen = 0,
1192};
1193
1194#define TIMER_THREAD_CREATED_P() (timer_th.created_fork_gen == current_fork_gen)
1195
1196static void timer_thread_check_timeslice(rb_vm_t *vm);
1197static bool timeslice_scan(rb_vm_t *vm, bool interrupt);
1198static int timer_thread_set_timeout(rb_vm_t *vm);
1199
1200#include "thread_sched_mn.c"
1201
1202/* only use signal-safe system calls here */
1203static void
1204signal_communication_pipe(int fd)
1205{
1206#if USE_EVENTFD
1207 const uint64_t buff = 1;
1208#else
1209 const char buff = '!';
1210#endif
1211 ssize_t result;
1212
1213 /* already opened */
1214 if (fd >= 0) {
1215 retry:
1216 if ((result = write(fd, &buff, sizeof(buff))) <= 0) {
1217 int e = errno;
1218 switch (e) {
1219 case EINTR: goto retry;
1220 case EAGAIN:
1221#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
1222 case EWOULDBLOCK:
1223#endif
1224 break;
1225 default:
1226 async_bug_fd("rb_thread_wakeup_timer_thread: write", e, fd);
1227 }
1228 }
1229 if (TT_DEBUG) WRITE_CONST(2, "rb_thread_wakeup_timer_thread: write\n");
1230 }
1231 else {
1232 // ignore wakeup
1233 }
1234}
1235
1236static void
1237timer_thread_wakeup_force(void)
1238{
1239 // should not use RUBY_DEBUG_LOG() because it can be called within signal handlers.
1240 signal_communication_pipe(timer_th.comm_fds[1]);
1241}
1242
1243
1244static void
1245rb_thread_create_timer_thread(void)
1246{
1247 rb_serial_t created_fork_gen = timer_th.created_fork_gen;
1248
1249 RUBY_DEBUG_LOG("fork_gen create:%d current:%d", (int)created_fork_gen, (int)current_fork_gen);
1250
1251 timer_th.created_fork_gen = current_fork_gen;
1252
1253 if (created_fork_gen != current_fork_gen) {
1254 if (created_fork_gen != 0) {
1255 RUBY_DEBUG_LOG("forked child process");
1256
1257 CLOSE_INVALIDATE_PAIR(timer_th.comm_fds);
1258#if USE_MN_THREADS
1259 // The parent's waiters do not exist in the child, and the armings
1260 // belong to the closed event backend: a stale entry would satisfy
1261 // fd_waiters_arm's want == armed_flags check and never arm the new
1262 // backend (a lost wake the old dynamic map also had).
1263 for (unsigned int ci = 0; ci < FDMAP_MAX_CHUNKS; ci++) {
1264 struct rb_fd_waiters *chunk = timer_th.fdmap_chunks[ci];
1265 if (chunk == NULL) continue;
1266 for (unsigned int i = 0; i < FDMAP_CHUNK_SIZE; i++) {
1267 ccan_list_head_init(&chunk[i].waiters);
1268 chunk[i].armed_flags = 0;
1269 chunk[i].generation++;
1270 }
1271 }
1272#endif
1273#if HAVE_SYS_EPOLL_H && USE_MN_THREADS
1274 close_invalidate(&timer_th.event_fd, "close event_fd");
1275#elif HAVE_SYS_EVENT_H && USE_MN_THREADS
1276 // A kqueue is not inherited across fork: the number names a closed
1277 // fd in the child, and closing it could hit a reused one.
1278 timer_th.event_fd = -1;
1279#endif
1280 // No mutex_destroy for waiting_lock: glibc returns EBUSY (and
1281 // rb_native_mutex_destroy rb_bugs) for a mutex another ractor's
1282 // M:N thread held at the fork moment. The initialize below
1283 // starts over.
1284 }
1285
1286#if USE_MN_THREADS
1287 for (int lvl = 0; lvl < TIMER_WHEEL_LEVELS; lvl++) {
1288 timer_th.wheel[lvl].occupied = 0;
1289 for (int slot = 0; slot < TIMER_WHEEL_SLOTS; slot++) {
1290 ccan_list_head_init(&timer_th.wheel[lvl].slots[slot]);
1291 }
1292 }
1293 timer_th.wheel_cursor_tick = timer_wheel_tick(rb_hrtime_now());
1294 timer_th.next_expiry = TIMER_WHEEL_NO_EXPIRY;
1295 rb_native_mutex_initialize(&timer_th.waiting_lock);
1296 for (int i = 0; i < IO_WAIT_SHARDS; i++) {
1297 rb_native_mutex_initialize(&timer_th.fd_shard_locks[i]);
1298 }
1299 rb_native_mutex_initialize(&timer_th.wake_pending_lock);
1300 rb_native_cond_initialize(&timer_th.wake_pending_cond);
1301#endif
1302
1303 // open communication channel
1304 setup_communication_pipe_internal(timer_th.comm_fds);
1305
1306 // open event fd
1307 timer_thread_setup_mn();
1308 }
1309
1310 int err = pthread_create(&timer_th.pthread_id, NULL, timer_thread_func, GET_VM());
1311 if (err != 0) {
1312 // The timer thread delivers signals and drives the M:N scheduler;
1313 // running without one only defers the failure to stranger places.
1314 rb_bug_errno("pthread_create (timer thread)", err);
1315 }
1316}
1317
1318static int
1319native_stop_timer_thread(void)
1320{
1321 RUBY_ATOMIC_SET(system_working, 0);
1322
1323 RUBY_DEBUG_LOG("wakeup send %d", timer_th.comm_fds[1]);
1324 timer_thread_wakeup_force();
1325 RUBY_DEBUG_LOG("wakeup sent");
1326 pthread_join(timer_th.pthread_id, NULL);
1327
1328 if (TT_DEBUG) fprintf(stderr, "stop timer thread\n");
1329
1330 return 1;
1331}
1332
1333static void
1334native_reset_timer_thread(void)
1335{
1336 //
1337}
1338
1339#ifdef HAVE_SIGALTSTACK
1340int
1341ruby_stack_overflowed_p(const rb_thread_t *th, const void *addr)
1342{
1343 void *base;
1344 size_t size;
1345 const size_t water_mark = RB_THREAD_PAGE_SIZE;
1346 STACK_GROW_DIR_DETECTION;
1347
1348 if (th) {
1349 size = th->ec->machine.stack_maxsize;
1350 base = (char *)th->ec->machine.stack_start - STACK_DIR_UPPER(0, size);
1351 }
1352#ifdef STACKADDR_AVAILABLE
1353 else if (get_stack(&base, &size) == 0) {
1354# ifdef __APPLE__
1355 // th is NULL in this branch; ask about the calling thread itself.
1356 if (pthread_equal(pthread_self(), native_main_thread.id)) {
1357 struct rlimit rlim;
1358 if (getrlimit(RLIMIT_STACK, &rlim) == 0 && rlim.rlim_cur > size) {
1359 size = (size_t)rlim.rlim_cur;
1360 }
1361 }
1362# endif
1363 base = (char *)base + STACK_DIR_UPPER(+size, -size);
1364 }
1365#endif
1366 else {
1367 return 0;
1368 }
1369
1370 if (size > water_mark) size = water_mark;
1371 if (IS_STACK_DIR_UPPER()) {
1372 if (size > ~(size_t)base+1) size = ~(size_t)base+1;
1373 if (addr > base && addr <= (void *)((char *)base + size)) return 1;
1374 }
1375 else {
1376 if (size > (size_t)base) size = (size_t)base;
1377 if (addr > (void *)((char *)base - size) && addr <= base) return 1;
1378 }
1379 return 0;
1380}
1381#endif
1382
1383int
1384rb_reserved_fd_p(int fd)
1385{
1386 /* no false-positive if out-of-FD at startup */
1387 if (fd < 0) return 0;
1388
1389 if (fd == timer_th.comm_fds[0] ||
1390 fd == timer_th.comm_fds[1]
1391#if (HAVE_SYS_EPOLL_H || HAVE_SYS_EVENT_H) && USE_MN_THREADS
1392 || fd == timer_th.event_fd
1393#endif
1394 ) {
1395 goto check_fork_gen;
1396 }
1397 return 0;
1398
1399 check_fork_gen:
1400 if (timer_th.created_fork_gen == current_fork_gen) {
1401 /* async-signal-safe */
1402 return 1;
1403 }
1404 else {
1405 return 0;
1406 }
1407}
1408
1409rb_nativethread_id_t
1411{
1412 return pthread_self();
1413}
1414
1415#if defined(USE_POLL) && !defined(HAVE_PPOLL)
1416/* TODO: don't ignore sigmask */
1417static int
1418ruby_ppoll(struct pollfd *fds, nfds_t nfds,
1419 const struct timespec *ts, const sigset_t *sigmask)
1420{
1421 int timeout_ms;
1422
1423 if (ts) {
1424 int tmp, tmp2;
1425
1426 if (ts->tv_sec > INT_MAX/1000)
1427 timeout_ms = INT_MAX;
1428 else {
1429 tmp = (int)(ts->tv_sec * 1000);
1430 /* round up 1ns to 1ms to avoid excessive wakeups for <1ms sleep */
1431 tmp2 = (int)((ts->tv_nsec + 999999L) / (1000L * 1000L));
1432 if (INT_MAX - tmp < tmp2)
1433 timeout_ms = INT_MAX;
1434 else
1435 timeout_ms = (int)(tmp + tmp2);
1436 }
1437 }
1438 else
1439 timeout_ms = -1;
1440
1441 return poll(fds, nfds, timeout_ms);
1442}
1443# define ppoll(fds,nfds,ts,sigmask) ruby_ppoll((fds),(nfds),(ts),(sigmask))
1444#endif
1445
1446
1447// fork read-write lock (only for pthread)
1448static pthread_rwlock_t rb_thread_fork_rw_lock = PTHREAD_RWLOCK_INITIALIZER;
1449
1450// the registered thread waiting to be joined, or NULL; no pthread_t is 0
1451static void *last_exiting_thread;
1452STATIC_ASSERT(pthread_t_fits_in_pointer, sizeof(pthread_t) <= sizeof(void *));
1453
1454void
1455rb_thread_release_fork_lock(void)
1456{
1457 int r;
1458 if ((r = pthread_rwlock_unlock(&rb_thread_fork_rw_lock))) {
1459 rb_bug_errno("pthread_rwlock_unlock", r);
1460 }
1461}
1462
1463void
1464rb_thread_reset_fork_lock(void)
1465{
1466 // On macOS the child's copy still counts a thread waiting for this lock
1467 // at fork: unlocking it leaves kernel state that later waiters hang on,
1468 // and destroying or initializing it fails with EBUSY.
1469 rb_thread_fork_rw_lock = (pthread_rwlock_t)PTHREAD_RWLOCK_INITIALIZER;
1470}
1471
1472void *
1473rb_thread_prevent_fork(void *(*func)(void *), void *data)
1474{
1475 int r;
1476 if ((r = pthread_rwlock_rdlock(&rb_thread_fork_rw_lock))) {
1477 rb_bug_errno("pthread_rwlock_rdlock", r);
1478 }
1479 void *result = func(data);
1480 rb_thread_release_fork_lock();
1481 return result;
1482}
1483
1484static void
1485thread_register_exiting(void *thread)
1486{
1487 void *previous_thread = RUBY_ATOMIC_PTR_EXCHANGE(last_exiting_thread, thread);
1488 if (previous_thread) {
1489 int r;
1490 if ((r = pthread_join((pthread_t)(uintptr_t)previous_thread, NULL))) {
1491 rb_bug_errno("pthread_join", r);
1492 }
1493 }
1494}
1495
1496// Called within rb_thread_prevent_fork() by a joinable thread just before it
1497// exits. The thread it replaces in the slot has usually exited by then.
1498void
1499rb_thread_register_exiting(void)
1500{
1501 thread_register_exiting((void *)(uintptr_t)pthread_self());
1502}
1503
1504void
1505rb_thread_acquire_fork_lock(void)
1506{
1507 int r;
1508 if ((r = pthread_rwlock_wrlock(&rb_thread_fork_rw_lock))) {
1509 rb_bug_errno("pthread_rwlock_wrlock", r);
1510 }
1511
1512 // A registered thread may still be exiting, and glibc's thread exit takes
1513 // the resolver configuration lock, which fork does not reset. None can
1514 // register while this lock is held.
1515 thread_register_exiting(NULL);
1516}
1517
1518// thread internal event hooks (only for pthread)
1519
1520struct rb_internal_thread_event_hook {
1521 rb_internal_thread_event_callback callback;
1522 rb_event_flag_t event;
1523 void *user_data;
1524
1525 struct rb_internal_thread_event_hook *next;
1526};
1527
1528static pthread_rwlock_t rb_internal_thread_event_hooks_rw_lock = PTHREAD_RWLOCK_INITIALIZER;
1529
1530/* For the GC: whether any thread-event hook is registered right now. The rwlock
1531 * makes the answer happen-after any completed registration; a hook registered
1532 * after this read gets no event from the asking thread (rb_thread_execute_hooks
1533 * skips a swept thread), so it never sees the objects the caller may collect. */
1534bool
1535rb_thread_event_hooks_registered_p(void)
1536{
1537 int r;
1538 if ((r = pthread_rwlock_rdlock(&rb_internal_thread_event_hooks_rw_lock))) {
1539 rb_bug_errno("pthread_rwlock_rdlock", r);
1540 }
1541 const bool registered = (rb_internal_thread_event_hooks != NULL);
1542 if ((r = pthread_rwlock_unlock(&rb_internal_thread_event_hooks_rw_lock))) {
1543 rb_bug_errno("pthread_rwlock_unlock", r);
1544 }
1545 return registered;
1546}
1547
1548#if defined(HAVE_WORKING_FORK)
1549static void
1550rb_internal_thread_event_hooks_rw_lock_atfork(void)
1551{
1552 // After fork(), this rwlock may have been held by a now-dead thread.
1553 //
1554 // pthread_rwlock_destroy() on a held lock is undefined behavior, and
1555 // pthread_rwlock_init() on an already-initialized lock is also undefined
1556 // behavior
1557 //
1558 // Direct assignment of PTHREAD_RWLOCK_INITIALIZER is safe and portable.
1559 rb_internal_thread_event_hooks_rw_lock =
1560 (pthread_rwlock_t)PTHREAD_RWLOCK_INITIALIZER;
1561}
1562#endif
1563
1564rb_internal_thread_event_hook_t *
1565rb_internal_thread_add_event_hook(rb_internal_thread_event_callback callback, rb_event_flag_t internal_event, void *user_data)
1566{
1567 rb_internal_thread_event_hook_t *hook = ALLOC_N(rb_internal_thread_event_hook_t, 1);
1568 hook->callback = callback;
1569 hook->user_data = user_data;
1570 hook->event = internal_event;
1571
1572 int r;
1573 if ((r = pthread_rwlock_wrlock(&rb_internal_thread_event_hooks_rw_lock))) {
1574 rb_bug_errno("pthread_rwlock_wrlock", r);
1575 }
1576
1577 hook->next = rb_internal_thread_event_hooks;
1578 ATOMIC_PTR_EXCHANGE(rb_internal_thread_event_hooks, hook);
1579
1580 if ((r = pthread_rwlock_unlock(&rb_internal_thread_event_hooks_rw_lock))) {
1581 rb_bug_errno("pthread_rwlock_unlock", r);
1582 }
1583 return hook;
1584}
1585
1586bool
1587rb_internal_thread_remove_event_hook(rb_internal_thread_event_hook_t * hook)
1588{
1589 int r;
1590 if ((r = pthread_rwlock_wrlock(&rb_internal_thread_event_hooks_rw_lock))) {
1591 rb_bug_errno("pthread_rwlock_wrlock", r);
1592 }
1593
1594 bool success = FALSE;
1595
1596 if (rb_internal_thread_event_hooks == hook) {
1597 ATOMIC_PTR_EXCHANGE(rb_internal_thread_event_hooks, hook->next);
1598 success = TRUE;
1599 }
1600 else {
1601 rb_internal_thread_event_hook_t *h = rb_internal_thread_event_hooks;
1602
1603 do {
1604 if (h->next == hook) {
1605 h->next = hook->next;
1606 success = TRUE;
1607 break;
1608 }
1609 } while ((h = h->next));
1610 }
1611
1612 if ((r = pthread_rwlock_unlock(&rb_internal_thread_event_hooks_rw_lock))) {
1613 rb_bug_errno("pthread_rwlock_unlock", r);
1614 }
1615
1616 if (success) {
1617 SIZED_FREE(hook);
1618 }
1619 return success;
1620}
1621
1622static void
1623rb_thread_execute_hooks(rb_event_flag_t event, rb_thread_t *th)
1624{
1625 int r;
1626
1627 /* th->self == 0: the dying thread's final collection swept its Thread wrapper, so
1628 * no hook existed then; one registered since has no ordering claim to this event. */
1629 if (th->self == 0) return;
1630 if ((r = pthread_rwlock_rdlock(&rb_internal_thread_event_hooks_rw_lock))) {
1631 rb_bug_errno("pthread_rwlock_rdlock", r);
1632 }
1633
1634 if (rb_internal_thread_event_hooks) {
1635 rb_internal_thread_event_hook_t *h = rb_internal_thread_event_hooks;
1636 do {
1637 if (h->event & event) {
1638 rb_internal_thread_event_data_t event_data = {
1639 .thread = th->self,
1640 };
1641 (*h->callback)(event, &event_data, h->user_data);
1642 }
1643 } while((h = h->next));
1644 }
1645 if ((r = pthread_rwlock_unlock(&rb_internal_thread_event_hooks_rw_lock))) {
1646 rb_bug_errno("pthread_rwlock_unlock", r);
1647 }
1648}
1649
1650#endif /* THREAD_SYSTEM_DEPENDENT_IMPLEMENTATION */
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
Definition atomic.h:69
#define RUBY_ATOMIC_PTR_EXCHANGE(var, val)
Identical to RUBY_ATOMIC_EXCHANGE, except it expects its arguments are void*.
Definition atomic.h:337
#define RUBY_ATOMIC_FETCH_ADD(var, val)
Atomically replaces the value pointed by var with the result of addition of val to the old value of v...
Definition atomic.h:118
#define RUBY_ATOMIC_LOAD(var)
Atomic load.
Definition atomic.h:175
#define RUBY_ATOMIC_SET(var, val)
Identical to RUBY_ATOMIC_EXCHANGE, except for the return type.
Definition atomic.h:185
uint32_t rb_event_flag_t
Represents event(s).
Definition event.h:108
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
#define ZALLOC
Old name of RB_ZALLOC.
Definition memory.h:402
#define ALLOC_N
Old name of RB_ALLOC_N.
Definition memory.h:399
#define ULL2NUM
Old name of RB_ULL2NUM.
Definition long_long.h:31
#define NUM2INT
Old name of RB_NUM2INT.
Definition int.h:44
#define Qnil
Old name of RUBY_Qnil.
#define NIL_P
Old name of RB_NIL_P.
VALUE rb_eNotImpError
NotImplementedError exception.
Definition error.c:1467
void rb_syserr_fail(int e, const char *mesg)
Raises appropriate exception that represents a C errno.
Definition error.c:4053
void rb_bug_errno(const char *mesg, int errno_arg)
This is a wrapper of rb_bug() which automatically constructs appropriate message from the passed errn...
Definition error.c:1177
int rb_cloexec_pipe(int fildes[2])
Opens a pipe with closing on exec.
Definition io.c:478
void rb_update_max_fd(int fd)
Informs the interpreter that the passed fd can be the max.
Definition io.c:274
int rb_reserved_fd_p(int fd)
Queries if the given FD is reserved or not.
void rb_timespec_now(struct timespec *ts)
Fills the current time into the given struct.
Definition time.c:2034
int len
Length of the buffer.
Definition io.h:8
#define RUBY_INTERNAL_THREAD_EVENT_RESUMED
Triggered when a thread successfully acquired the GVL.
Definition thread.h:249
rb_internal_thread_event_hook_t * rb_internal_thread_add_event_hook(rb_internal_thread_event_callback func, rb_event_flag_t events, void *data)
Registers a thread event hook function.
#define RUBY_INTERNAL_THREAD_EVENT_EXITED
Triggered when a thread exits.
Definition thread.h:263
#define RUBY_INTERNAL_THREAD_EVENT_SUSPENDED
Triggered when a thread released the GVL.
Definition thread.h:256
#define RUBY_INTERNAL_THREAD_EVENT_STARTED
Triggered when a new thread is started.
Definition thread.h:235
bool rb_internal_thread_remove_event_hook(rb_internal_thread_event_hook_t *hook)
Unregister the passed hook.
#define RUBY_INTERNAL_THREAD_EVENT_READY
Triggered when a thread attempt to acquire the GVL.
Definition thread.h:242
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
#define rb_fd_select
Waits for multiple file descriptors at once.
Definition posix.h:66
#define RARRAY_AREF(a, i)
References an object in an array.
Definition rarray.h:421
#define RSTRING_GETMEM(str, ptrvar, lenvar)
Convenient macro to obtain the contents and length at once.
Definition rstring.h:450
#define errno
Ractor-aware version of errno.
Definition ruby.h:388
The data structure which wraps the fd_set bitmap used by select(2).
Definition largesize.h:71
rb_nativethread_id_t rb_nativethread_self(void)
Queries the ID of the native thread that is calling this function.
void rb_native_mutex_lock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_lock.
void rb_native_cond_initialize(rb_nativethread_cond_t *cond)
Fills the passed condition variable with an initial value.
int rb_native_mutex_trylock(rb_nativethread_lock_t *lock)
Identical to rb_native_mutex_lock(), except it doesn't block in case rb_native_mutex_lock() would.
void rb_native_cond_broadcast(rb_nativethread_cond_t *cond)
Signals a condition variable.
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_native_mutex_destroy(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_destroy.
void rb_native_cond_destroy(rb_nativethread_cond_t *cond)
Destroys the passed condition variable.
void rb_native_cond_signal(rb_nativethread_cond_t *cond)
Signals a condition variable.
void rb_native_cond_wait(rb_nativethread_cond_t *cond, rb_nativethread_lock_t *mutex)
Waits for the passed condition variable to be signalled.
void rb_native_cond_timedwait(rb_nativethread_cond_t *cond, rb_nativethread_lock_t *mutex, unsigned long msec)
Identical to rb_native_cond_wait(), except it additionally takes timeout in msec resolution.
long rb_len_t
A signed integer type for lengths and indices of objects such as String and Array.
Definition value.h:142
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40