Ruby 3.5.0dev (2025-06-06 revision 347e581a4cbe2bbf7c13532038f2a68b0b37099a)
thread.h
1#ifndef INTERNAL_THREAD_H /*-*-C-*-vi:se ft=c:*/
2#define INTERNAL_THREAD_H
11#include "ruby/ruby.h" /* for VALUE */
12#include "ruby/intern.h" /* for rb_blocking_function_t */
13#include "ccan/list/list.h" /* for list in rb_io_close_wait_list */
14
15struct rb_thread_struct; /* in vm_core.h */
16struct rb_io;
17
18#define RB_VM_SAVE_MACHINE_CONTEXT(th) \
19 do { \
20 FLUSH_REGISTER_WINDOWS; \
21 setjmp((th)->ec->machine.regs); \
22 SET_MACHINE_STACK_END(&(th)->ec->machine.stack_end); \
23 } while (0)
24
25/* thread.c */
26#define COVERAGE_INDEX_LINES 0
27#define COVERAGE_INDEX_BRANCHES 1
28#define COVERAGE_TARGET_LINES 1
29#define COVERAGE_TARGET_BRANCHES 2
30#define COVERAGE_TARGET_METHODS 4
31#define COVERAGE_TARGET_ONESHOT_LINES 8
32#define COVERAGE_TARGET_EVAL 16
33
34#define RUBY_FATAL_THREAD_KILLED INT2FIX(0)
35#define RUBY_FATAL_THREAD_TERMINATED INT2FIX(1)
36#define RUBY_FATAL_FIBER_KILLED RB_INT2FIX(2)
37
38VALUE rb_obj_is_mutex(VALUE obj);
39VALUE rb_suppress_tracing(VALUE (*func)(VALUE), VALUE arg);
40void rb_thread_execute_interrupts(VALUE th);
41VALUE rb_get_coverages(void);
42int rb_get_coverage_mode(void);
43VALUE rb_default_coverage(int);
44VALUE rb_thread_shield_new(void);
45bool rb_thread_shield_owned(VALUE self);
46VALUE rb_thread_shield_wait(VALUE self);
47VALUE rb_thread_shield_release(VALUE self);
48VALUE rb_thread_shield_destroy(VALUE self);
49int rb_thread_to_be_killed(VALUE thread);
50void rb_thread_acquire_fork_lock(void);
51void rb_thread_release_fork_lock(void);
52void rb_thread_reset_fork_lock(void);
53void rb_mutex_allow_trap(VALUE self, int val);
54VALUE rb_uninterruptible(VALUE (*b_proc)(VALUE), VALUE data);
55VALUE rb_mutex_owned_p(VALUE self);
56VALUE rb_exec_recursive_outer_mid(VALUE (*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h, ID mid);
57void ruby_mn_threads_params(void);
58
59int rb_thread_io_wait(struct rb_io *io, int events, struct timeval * timeout);
60int rb_thread_wait_for_single_fd(int fd, int events, struct timeval * timeout);
61
62size_t rb_thread_io_close_interrupt(struct rb_io *);
63void rb_thread_io_close_wait(struct rb_io *);
64
65void rb_ec_check_ints(struct rb_execution_context_struct *ec);
66
67RUBY_SYMBOL_EXPORT_BEGIN
68
69void *rb_thread_prevent_fork(void *(*func)(void *), void *data); /* for ext/socket/raddrinfo.c */
70
71/* Temporary. This API will be removed (renamed). */
72VALUE rb_thread_io_blocking_region(struct rb_io *io, rb_blocking_function_t *func, void *data1);
73VALUE rb_thread_io_blocking_call(struct rb_io *io, rb_blocking_function_t *func, void *data1, int events);
74
75// Invoke the given function, with the specified argument, in a way that `IO#close` from another execution context can interrupt it.
76VALUE rb_thread_io_blocking_operation(VALUE self, VALUE(*function)(VALUE), VALUE argument);
77
78/* thread.c (export) */
79int ruby_thread_has_gvl_p(void); /* for ext/fiddle/closure.c */
80
81RUBY_SYMBOL_EXPORT_END
82
83int rb_threadptr_execute_interrupts(struct rb_thread_struct *th, int blocking_timing);
84bool rb_thread_mn_schedulable(VALUE thread);
85
86// interrupt exec
87
88typedef VALUE (rb_interrupt_exec_func_t)(void *data);
89
90enum rb_interrupt_exec_flag {
91 rb_interrupt_exec_flag_none = 0x00,
92 rb_interrupt_exec_flag_value_data = 0x01,
93};
94
95// interrupt the target_th and run func.
96struct rb_ractor_struct;
97
98void rb_threadptr_interrupt_exec(struct rb_thread_struct *target_th,
99 rb_interrupt_exec_func_t *func, void *data, enum rb_interrupt_exec_flag flags);
100
101// create a thread in the target_r and run func on the created thread.
102void rb_ractor_interrupt_exec(struct rb_ractor_struct *target_r,
103 rb_interrupt_exec_func_t *func, void *data, enum rb_interrupt_exec_flag flags);
104
105void rb_threadptr_interrupt_exec_task_mark(struct rb_thread_struct *th);
106
107#endif /* INTERNAL_THREAD_H */
Ruby's IO, metadata and buffers.
Definition io.h:295
VALUE self
The IO's Ruby level counterpart.
Definition io.h:298
VALUE timeout
The timeout associated with this IO when performing blocking operations.
Definition io.h:406
int fd
file descriptor.
Definition io.h:306
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40