Ruby 3.5.0dev (2025-10-06 revision f13e68e252ee96ee01e3b6eb11ad4109d5e033b1)
thread_pthread.h (f13e68e252ee96ee01e3b6eb11ad4109d5e033b1)
1#ifndef RUBY_THREAD_PTHREAD_H
2#define RUBY_THREAD_PTHREAD_H
3/**********************************************************************
4
5 thread_pthread.h -
6
7 $Author$
8
9 Copyright (C) 2004-2007 Koichi Sasada
10
11**********************************************************************/
12
13#ifdef HAVE_PTHREAD_NP_H
14#include <pthread_np.h>
15#endif
16
17#define RB_NATIVETHREAD_LOCK_INIT PTHREAD_MUTEX_INITIALIZER
18#define RB_NATIVETHREAD_COND_INIT PTHREAD_COND_INITIALIZER
19
20// TLS can not be accessed across .so on arm64 and perhaps ppc64le too.
21#if defined(__arm64__) || defined(__aarch64__) || defined(__powerpc64__)
22# define RB_THREAD_CURRENT_EC_NOINLINE
23#endif
24
25// this data should be protected by timer_th.waiting_lock
27 enum thread_sched_waiting_flag {
28 thread_sched_waiting_none = 0x00,
29 thread_sched_waiting_timeout = 0x01,
30 thread_sched_waiting_io_read = 0x02,
31 thread_sched_waiting_io_write = 0x08,
32 thread_sched_waiting_io_force = 0x40, // ignore readable
33 } flags;
34
35 struct {
36 // should be compat with hrtime.h
37#ifdef MY_RUBY_BUILD_MAY_TIME_TRAVEL
38 int128_t timeout;
39#else
40 uint64_t timeout;
41#endif
42 int fd; // -1 for timeout only
43 int result;
44 } data;
45
46 // connected to timer_th.waiting
47 struct ccan_list_node node;
48};
49
50// per-Thead scheduler helper data
52 struct {
53 struct ccan_list_node ubf;
54
55 // connected to ractor->threads.sched.reqdyq
56 // locked by ractor->threads.sched.lock
57 struct ccan_list_node readyq;
58
59 // connected to vm->ractor.sched.timeslice_threads
60 // locked by vm->ractor.sched.lock
61 struct ccan_list_node timeslice_threads;
62
63 // connected to vm->ractor.sched.running_threads
64 // locked by vm->ractor.sched.lock
65 struct ccan_list_node running_threads;
66
67 // connected to vm->ractor.sched.zombie_threads
68 struct ccan_list_node zombie_threads;
69 } node;
70
71 struct rb_thread_sched_waiting waiting_reason;
72
73 bool finished;
74 bool malloc_stack;
75 void *context_stack;
76 struct coroutine_context *context;
77};
78
79struct rb_native_thread {
80 rb_atomic_t serial;
81 struct rb_vm_struct *vm;
82
83 rb_nativethread_id_t thread_id;
84
85#ifdef RB_THREAD_T_HAS_NATIVE_ID
86 int tid;
87#endif
88
89 struct rb_thread_struct *running_thread;
90
91 // to control native thread
92#if defined(__GLIBC__) || defined(__FreeBSD__)
93 union
94#else
95 /*
96 * assume the platform condvars are badly implemented and have a
97 * "memory" of which mutex they're associated with
98 */
99 struct
100#endif
101 {
102 rb_nativethread_cond_t intr; /* th->interrupt_lock */
103 rb_nativethread_cond_t readyq; /* use sched->lock */
104 } cond;
105
106#ifdef USE_SIGALTSTACK
107 void *altstack;
108#endif
109
110 struct coroutine_context *nt_context;
111 int dedicated;
112
113 size_t machine_stack_maxsize;
114};
115
116#undef except
117#undef try
118#undef leave
119#undef finally
120
121// per-Ractor
122struct rb_thread_sched {
123 rb_nativethread_lock_t lock_;
124#if VM_CHECK_MODE
125 struct rb_thread_struct *lock_owner;
126#endif
127 struct rb_thread_struct *running; // running thread or NULL
128 bool is_running;
129 bool is_running_timeslice;
130 bool enable_mn_threads;
131
132 struct ccan_list_head readyq;
133 int readyq_cnt;
134 // ractor scheduling
135 struct ccan_list_node grq_node;
136};
137
138#ifdef RB_THREAD_LOCAL_SPECIFIER
139 NOINLINE(void rb_current_ec_set(struct rb_execution_context_struct *));
140
141 # ifdef RB_THREAD_CURRENT_EC_NOINLINE
142 NOINLINE(struct rb_execution_context_struct *rb_current_ec(void));
143 # else
144 RUBY_EXTERN RB_THREAD_LOCAL_SPECIFIER struct rb_execution_context_struct *ruby_current_ec;
145
146 // for RUBY_DEBUG_LOG()
147 RUBY_EXTERN RB_THREAD_LOCAL_SPECIFIER rb_atomic_t ruby_nt_serial;
148 #define RUBY_NT_SERIAL 1
149 # endif
150#else
151typedef pthread_key_t native_tls_key_t;
152
153static inline void *
154native_tls_get(native_tls_key_t key)
155{
156 // return value should be checked by caller
157 return pthread_getspecific(key);
158}
159
160static inline void
161native_tls_set(native_tls_key_t key, void *ptr)
162{
163 if (UNLIKELY(pthread_setspecific(key, ptr) != 0)) {
164 rb_bug("pthread_setspecific error");
165 }
166}
167
168RUBY_EXTERN native_tls_key_t ruby_current_ec_key;
169#endif
170
171struct rb_ractor_struct;
172void rb_ractor_sched_wait(struct rb_execution_context_struct *ec, struct rb_ractor_struct *cr, rb_unblock_function_t *ubf, void *ptr);
173void rb_ractor_sched_wakeup(struct rb_ractor_struct *r, struct rb_thread_struct *th);
174
175#endif /* RUBY_THREAD_PTHREAD_H */
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
Definition atomic.h:69
#define RUBY_EXTERN
Declaration of externally visible global variables.
Definition dllexport.h:45
void rb_unblock_function_t(void *)
This is the type of UBFs.
Definition thread.h:336