Ruby: thread_pthread.h Source File

Ruby 4.0.5p0 (2026-05-20 revision 64336ffd0ee9e1f4c05891695a3d7b49cb709721)

thread_pthread.h
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
26 struct rb_thread_sched_waiting {
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 uint32_t event_serial;
43 int fd; // -1 for timeout only
44 int result;
45 } data;
46
47 // connected to timer_th.waiting
48 struct ccan_list_node node;
49};
50
51// per-Thread scheduler helper data
52struct rb_thread_sched_item {
53 struct {
54 struct ccan_list_node ubf;
55
56 // connected to ractor->threads.sched.reqdyq
57 // locked by ractor->threads.sched.lock
58 struct ccan_list_node readyq;
59
60 // connected to vm->ractor.sched.timeslice_threads
61 // locked by vm->ractor.sched.lock
62 struct ccan_list_node timeslice_threads;
63
64 // connected to vm->ractor.sched.running_threads
65 // locked by vm->ractor.sched.lock
66 struct ccan_list_node running_threads;
67
68 // connected to vm->ractor.sched.zombie_threads
69 struct ccan_list_node zombie_threads;
70 } node;
71
72 struct rb_thread_sched_waiting waiting_reason;
73 uint32_t event_serial;
74
75 bool finished;
76 bool malloc_stack;
77 void *context_stack;
78 struct coroutine_context *context;
79};
80
81struct rb_native_thread {
82 rb_atomic_t serial;
83 struct rb_vm_struct *vm;
84
85 rb_nativethread_id_t thread_id;
86
87#ifdef RB_THREAD_T_HAS_NATIVE_ID
88 int tid;
89#endif
90
91 struct rb_thread_struct *running_thread;
92
93 // to control native thread
94#if defined(__GLIBC__) || defined(__FreeBSD__)
95 union
96#else
97 /*
98 * assume the platform condvars are badly implemented and have a
99 * "memory" of which mutex they're associated with
100 */
101 struct
102#endif
103 {
104 rb_nativethread_cond_t intr; /* th->interrupt_lock */
105 rb_nativethread_cond_t readyq; /* use sched->lock */
106 } cond;
107
108#ifdef USE_SIGALTSTACK
109 void *altstack;
110#endif
111
112 struct coroutine_context *nt_context;
113 int dedicated;
114
115 size_t machine_stack_maxsize;
116};
117
118#undef except
119#undef try
120#undef leave
121#undef finally
122
123// per-Ractor
124struct rb_thread_sched {
125 rb_nativethread_lock_t lock_;
126#if VM_CHECK_MODE
127 struct rb_thread_struct *lock_owner;
128#endif
129 struct rb_thread_struct *running; // running thread or NULL
130 bool is_running;
131 bool is_running_timeslice;
132 bool enable_mn_threads;
133
134 struct ccan_list_head readyq;
135 int readyq_cnt;
136 // ractor scheduling
137 struct ccan_list_node grq_node;
138};
139
140#ifdef RB_THREAD_LOCAL_SPECIFIER
141 NOINLINE(void rb_current_ec_set(struct rb_execution_context_struct *));
142
143 # ifdef RB_THREAD_CURRENT_EC_NOINLINE
144 NOINLINE(struct rb_execution_context_struct *rb_current_ec(void));
145 # else
146 RUBY_EXTERN RB_THREAD_LOCAL_SPECIFIER struct rb_execution_context_struct *ruby_current_ec;
147
148 // for RUBY_DEBUG_LOG()
149 RUBY_EXTERN RB_THREAD_LOCAL_SPECIFIER rb_atomic_t ruby_nt_serial;
150 #define RUBY_NT_SERIAL 1
151 # endif
152#else
153typedef pthread_key_t native_tls_key_t;
154
155static inline void *
156native_tls_get(native_tls_key_t key)
157{
158 // return value should be checked by caller
159 return pthread_getspecific(key);
160}
161
162static inline void
163native_tls_set(native_tls_key_t key, void *ptr)
164{
165 if (UNLIKELY(pthread_setspecific(key, ptr) != 0)) {
166 rb_bug("pthread_setspecific error");
167 }
168}
169
170 RUBY_EXTERN native_tls_key_t ruby_current_ec_key;
171#endif
172
173struct rb_ractor_struct;
174void rb_ractor_sched_wait(struct rb_execution_context_struct *ec, struct rb_ractor_struct *cr, rb_unblock_function_t *ubf, void *ptr);
175void rb_ractor_sched_wakeup(struct rb_ractor_struct *r, struct rb_thread_struct *th);
176
177#endif /* RUBY_THREAD_PTHREAD_H */
rb_atomic_t
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
Definition atomic.h:69
RUBY_EXTERN
#define RUBY_EXTERN
Declaration of externally visible global variables.
Definition dllexport.h:45
rb_unblock_function_t
void rb_unblock_function_t(void *)
This is the type of UBFs.
Definition thread.h:336
rb_execution_context_struct
Definition vm_core.h:1033
rb_native_thread
Definition thread_none.h:11
rb_ractor_struct
Definition ractor_core.h:68
rb_thread_sched_item
Definition thread_none.h:15
rb_thread_sched_waiting
Definition thread_pthread.h:26
rb_thread_sched
Definition thread_none.h:16
rb_thread_struct
Definition vm_core.h:1130