Ruby: internal/thread.h Source File

Ruby 3.3.5p100 (2024-09-03 revision ef084cc8f4958c1b6e4ead99136631bef6d8ddba)

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 */
16
17#define RB_VM_SAVE_MACHINE_CONTEXT(th) \
18 do { \
19 FLUSH_REGISTER_WINDOWS; \
20 setjmp((th)->ec->machine.regs); \
21 SET_MACHINE_STACK_END(&(th)->ec->machine.stack_end); \
22 } while (0)
23
24/* thread.c */
25#define COVERAGE_INDEX_LINES 0
26#define COVERAGE_INDEX_BRANCHES 1
27#define COVERAGE_TARGET_LINES 1
28#define COVERAGE_TARGET_BRANCHES 2
29#define COVERAGE_TARGET_METHODS 4
30#define COVERAGE_TARGET_ONESHOT_LINES 8
31#define COVERAGE_TARGET_EVAL 16
32
33#define RUBY_FATAL_THREAD_KILLED INT2FIX(0)
34#define RUBY_FATAL_THREAD_TERMINATED INT2FIX(1)
35#define RUBY_FATAL_FIBER_KILLED RB_INT2FIX(2)
36
37 VALUE rb_obj_is_mutex(VALUE obj);
38 VALUE rb_suppress_tracing(VALUE (*func)(VALUE), VALUE arg);
39void rb_thread_execute_interrupts(VALUE th);
40 VALUE rb_get_coverages(void);
41int rb_get_coverage_mode(void);
42 VALUE rb_default_coverage(int);
43 VALUE rb_thread_shield_new(void);
44bool rb_thread_shield_owned(VALUE self);
45 VALUE rb_thread_shield_wait(VALUE self);
46 VALUE rb_thread_shield_release(VALUE self);
47 VALUE rb_thread_shield_destroy(VALUE self);
48int rb_thread_to_be_killed(VALUE thread);
49void rb_mutex_allow_trap(VALUE self, int val);
50 VALUE rb_uninterruptible(VALUE (*b_proc)(VALUE), VALUE data);
51 VALUE rb_mutex_owned_p(VALUE self);
52 VALUE rb_exec_recursive_outer_mid(VALUE (*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h, ID mid);
53void ruby_mn_threads_params(void);
54
55int rb_thread_wait_for_single_fd(int fd, int events, struct timeval * timeout);
56
57 struct rb_io_close_wait_list {
58 struct ccan_list_head pending_fd_users;
59 VALUE closing_thread;
60 VALUE wakeup_mutex;
61};
62int rb_notify_fd_close(int fd, struct rb_io_close_wait_list *busy);
63void rb_notify_fd_close_wait(struct rb_io_close_wait_list *busy);
64
65RUBY_SYMBOL_EXPORT_BEGIN
66
67/* Temporary. This API will be removed (renamed). */
68 VALUE rb_thread_io_blocking_region(rb_blocking_function_t *func, void *data1, int fd);
69 VALUE rb_thread_io_blocking_call(rb_blocking_function_t *func, void *data1, int fd, int events);
70
71/* thread.c (export) */
72int ruby_thread_has_gvl_p(void); /* for ext/fiddle/closure.c */
73
74RUBY_SYMBOL_EXPORT_END
75
76int rb_threadptr_execute_interrupts(struct rb_thread_struct *th, int blocking_timing);
77
78#endif /* INTERNAL_THREAD_H */
intern.h
ruby.h
rb_io_close_wait_list
Definition thread.h:57
rb_thread_struct
Definition vm_core.h:1071
timeval
Definition missing.h:63
ID
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40