Ruby: include/ruby/thread.h Source File

Ruby 3.3.4p94 (2024-07-09 revision be1089c8ec5ba40e09b1553e36b3174bf4014d9d)

thread.h
Go to the documentation of this file.
1#ifndef RUBY_THREAD_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RUBY_THREAD_H 1
13#include "ruby/internal/attr/nonnull.h"
14#include "ruby/internal/intern/thread.h" /* rb_unblock_function_t */
15#include "ruby/internal/dllexport.h"
16
48#define RB_NOGVL_INTR_FAIL (0x1)
49
60#define RB_NOGVL_UBF_ASYNC_SAFE (0x2)
61
64 RBIMPL_SYMBOL_EXPORT_BEGIN()
65
66 RBIMPL_ATTR_NONNULL((1))
91void *rb_thread_call_with_gvl(void *(*func)(void *), void *data1);
92
93 RBIMPL_ATTR_NONNULL((1))
130void *rb_thread_call_without_gvl(void *(*func)(void *), void *data1,
131 rb_unblock_function_t *ubf, void *data2);
132
133 RBIMPL_ATTR_NONNULL((1))
154void *rb_thread_call_without_gvl2(void *(*func)(void *), void *data1,
155 rb_unblock_function_t *ubf, void *data2);
156
157/*
158 * XXX: unstable/unapproved - out-of-tree code should NOT not depend
159 * on this until it hits Ruby 2.6.1
160 */
161
162 RBIMPL_ATTR_NONNULL((1))
174void *rb_nogvl(void *(*func)(void *), void *data1,
175 rb_unblock_function_t *ubf, void *data2,
176 int flags);
177
185#define RUBY_CALL_WO_GVL_FLAG_SKIP_CHECK_INTS_AFTER 0x01
186
191#define RUBY_CALL_WO_GVL_FLAG_SKIP_CHECK_INTS_
192
198#define RUBY_INTERNAL_THREAD_EVENT_STARTED 1 << 0
199
205#define RUBY_INTERNAL_THREAD_EVENT_READY 1 << 1
212#define RUBY_INTERNAL_THREAD_EVENT_RESUMED 1 << 2
219#define RUBY_INTERNAL_THREAD_EVENT_SUSPENDED 1 << 3
226#define RUBY_INTERNAL_THREAD_EVENT_EXITED 1 << 4
228#define RUBY_INTERNAL_THREAD_EVENT_MASK 0xff
230 typedef struct rb_internal_thread_event_data {
231 VALUE thread;
232} rb_internal_thread_event_data_t;
233
234typedef void (*rb_internal_thread_event_callback)(rb_event_flag_t event,
235 const rb_internal_thread_event_data_t *event_data,
236 void *user_data);
237typedef struct rb_internal_thread_event_hook rb_internal_thread_event_hook_t;
238
254rb_internal_thread_event_hook_t *rb_internal_thread_add_event_hook(
255 rb_internal_thread_event_callback func, rb_event_flag_t events,
256 void *data);
257
258
267 bool rb_internal_thread_remove_event_hook(
268 rb_internal_thread_event_hook_t * hook);
269
270
271typedef int rb_internal_thread_specific_key_t;
272#define RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX 8
294rb_internal_thread_specific_key_t rb_internal_thread_specific_key_create(void);
295
301void *rb_internal_thread_specific_get(VALUE thread_val, rb_internal_thread_specific_key_t key);
302
308void rb_internal_thread_specific_set(VALUE thread_val, rb_internal_thread_specific_key_t key, void *data);
309
310 RBIMPL_SYMBOL_EXPORT_END()
311
312#endif /* RUBY_THREAD_H */
dllexport.h
Tweaking visibility of C variables/functions.
RBIMPL_SYMBOL_EXPORT_END
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition dllexport.h:74
RBIMPL_SYMBOL_EXPORT_BEGIN
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition dllexport.h:65
rb_event_flag_t
uint32_t rb_event_flag_t
Represents event(s).
Definition event.h:108
thread.h
Public APIs related to rb_cThread.
rb_unblock_function_t
void rb_unblock_function_t(void *)
This is the type of UBFs.
Definition thread.h:336
rb_internal_thread_specific_get
void * rb_internal_thread_specific_get(VALUE thread_val, rb_internal_thread_specific_key_t key)
Get thread and tool specific data.
Definition thread.c:5874
rb_internal_thread_specific_set
void rb_internal_thread_specific_set(VALUE thread_val, rb_internal_thread_specific_key_t key, void *data)
Set thread and tool specific data.
Definition thread.c:5887
rb_internal_thread_specific_key_create
rb_internal_thread_specific_key_t rb_internal_thread_specific_key_create(void)
Create a key to store thread specific data.
Definition thread.c:5846
rb_nogvl
void * rb_nogvl(void *(*func)(void *), void *data1, rb_unblock_function_t *ubf, void *data2, int flags)
Identical to rb_thread_call_without_gvl(), except it additionally takes "flags" that change the behav...
Definition thread.c:1523
rb_thread_call_with_gvl
void * rb_thread_call_with_gvl(void *(*func)(void *), void *data1)
(Re-)acquires the GVL.
Definition thread.c:1832
rb_internal_thread_add_event_hook
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.
rb_thread_call_without_gvl2
void * rb_thread_call_without_gvl2(void *(*func)(void *), void *data1, rb_unblock_function_t *ubf, void *data2)
Identical to rb_thread_call_without_gvl(), except it does not interface with signals etc.
Definition thread.c:1651
rb_thread_call_without_gvl
void * rb_thread_call_without_gvl(void *(*func)(void *), void *data1, rb_unblock_function_t *ubf, void *data2)
Allows the passed function to run in parallel with other Ruby threads.
Definition thread.c:1658
rb_internal_thread_remove_event_hook
bool rb_internal_thread_remove_event_hook(rb_internal_thread_event_hook_t *hook)
Unregister the passed hook.
nonnull.h
Defines RBIMPL_ATTR_NONNULL.
RBIMPL_ATTR_NONNULL
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition nonnull.h:30
rb_internal_thread_event_data
Definition thread.h:230
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40