19#include "internal/thread.h"
22#include "ruby_atomic.h"
25static ID id_scheduler_close;
30static ID id_timeout_after;
31static ID id_kernel_sleep;
32static ID id_process_wait;
34static ID id_io_read, id_io_pread;
35static ID id_io_write, id_io_pwrite;
37static ID id_io_select;
40static ID id_address_resolve;
42static ID id_blocking_operation_wait;
43static ID id_fiber_interrupt;
45static ID id_fiber_schedule;
48static VALUE rb_cFiberSchedulerBlockingOperation;
57 RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_QUEUED,
58 RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_EXECUTING,
59 RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_COMPLETED,
60 RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_CANCELLED
61} rb_fiber_blocking_operation_status_t;
64 void *(*function)(
void *);
76blocking_operation_mark(
void *ptr)
82blocking_operation_free(
void *ptr)
85 ruby_xfree(blocking_operation);
89blocking_operation_memsize(
const void *ptr)
95 "Fiber::Scheduler::BlockingOperation",
97 blocking_operation_mark,
98 blocking_operation_free,
99 blocking_operation_memsize,
101 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
108blocking_operation_alloc(
VALUE klass)
113 blocking_operation->function = NULL;
114 blocking_operation->data = NULL;
115 blocking_operation->unblock_function = NULL;
116 blocking_operation->data2 = NULL;
117 blocking_operation->flags = 0;
118 blocking_operation->state = NULL;
119 blocking_operation->status = RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_QUEUED;
128get_blocking_operation(
VALUE obj)
132 return blocking_operation;
144blocking_operation_call(
VALUE self)
148 if (blocking_operation->status != RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_QUEUED) {
149 rb_raise(
rb_eRuntimeError,
"Blocking operation has already been executed!");
152 if (blocking_operation->function == NULL) {
153 rb_raise(
rb_eRuntimeError,
"Blocking operation has no function to execute!");
156 if (blocking_operation->state == NULL) {
161 blocking_operation->status = RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_EXECUTING;
164 blocking_operation->state->result =
rb_nogvl(blocking_operation->function, blocking_operation->data,
165 blocking_operation->unblock_function, blocking_operation->data2,
166 blocking_operation->flags);
167 blocking_operation->state->saved_errno = rb_errno();
170 blocking_operation->status = RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_COMPLETED;
188 return get_blocking_operation(self);
203 if (blocking_operation == NULL) {
207 if (blocking_operation->function == NULL || blocking_operation->state == NULL) {
212 rb_atomic_t expected = RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_QUEUED;
213 if (
RUBY_ATOMIC_CAS(blocking_operation->status, expected, RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_EXECUTING) != expected) {
219 blocking_operation->state->result = blocking_operation->function(blocking_operation->data);
220 blocking_operation->state->saved_errno =
errno;
223 expected = RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_EXECUTING;
224 if (
RUBY_ATOMIC_CAS(blocking_operation->status, expected, RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_COMPLETED) == expected) {
229 blocking_operation->state->saved_errno = EINTR;
241rb_fiber_scheduler_blocking_operation_new(
void *(*function)(
void *),
void *data,
245 VALUE self = blocking_operation_alloc(rb_cFiberSchedulerBlockingOperation);
248 blocking_operation->function = function;
249 blocking_operation->data = data;
250 blocking_operation->unblock_function = unblock_function;
251 blocking_operation->data2 = data2;
252 blocking_operation->flags = flags;
253 blocking_operation->state = state;
311Init_Fiber_Scheduler(
void)
334 id_blocking_operation_wait =
rb_intern_const(
"blocking_operation_wait");
341 rb_cFiberSchedulerBlockingOperation =
rb_class_new(rb_cObject);
343 rb_define_method(rb_cFiberSchedulerBlockingOperation,
"call", blocking_operation_call, 0);
346 rb_gc_register_mark_object(rb_cFiberSchedulerBlockingOperation);
360 rb_define_method(rb_cFiberScheduler,
"timeout_after", rb_fiber_scheduler_timeout_after, 3);
376 return thread->scheduler;
380verify_interface(
VALUE scheduler)
383 rb_raise(rb_eArgError,
"Scheduler must implement #block");
387 rb_raise(rb_eArgError,
"Scheduler must implement #unblock");
391 rb_raise(rb_eArgError,
"Scheduler must implement #kernel_sleep");
395 rb_raise(rb_eArgError,
"Scheduler must implement #io_wait");
399 rb_warn(
"Scheduler should implement #fiber_interrupt");
404fiber_scheduler_close(
VALUE scheduler)
410fiber_scheduler_close_ensure(
VALUE _thread)
413 thread->scheduler =
Qnil;
426 if (scheduler !=
Qnil) {
427 verify_interface(scheduler);
434 if (thread->scheduler !=
Qnil) {
436 rb_ensure(fiber_scheduler_close, thread->scheduler, fiber_scheduler_close_ensure, (
VALUE)thread);
439 thread->scheduler = scheduler;
441 return thread->scheduler;
445rb_fiber_scheduler_current_for_threadptr(
rb_thread_t *thread)
449 if (thread->blocking == 0) {
450 return thread->scheduler;
460 return rb_fiber_scheduler_current_for_threadptr(GET_THREAD());
465 return rb_fiber_scheduler_current_for_threadptr(rb_thread_ptr(thread));
492 if (!UNDEF_P(result))
return result;
495 if (!UNDEF_P(result))
return result;
504 return rb_float_new((
double)timeout->tv_sec + (0.000001 * timeout->tv_usec));
524 return rb_funcall(scheduler, id_kernel_sleep, 1, timeout);
530 return rb_funcallv(scheduler, id_kernel_sleep, argc, argv);
565 VALUE arguments[] = {
566 timeout, exception, message
573rb_fiber_scheduler_timeout_afterv(
VALUE scheduler,
int argc,
VALUE * argv)
600 VALUE arguments[] = {
624 return rb_funcall(scheduler, id_block, 2, blocker, timeout);
647 int saved_errno =
errno;
651 if (RUBY_VM_INTERRUPTED(ec)) {
652 rb_bug(
"rb_fiber_scheduler_unblock called with pending interrupt");
683fiber_scheduler_io_wait(
VALUE _argument) {
686 return rb_funcallv(arguments[0], id_io_wait, 3, arguments + 1);
692 VALUE arguments[] = {
693 scheduler, io, events, timeout
697 return rb_thread_io_blocking_operation(io, fiber_scheduler_io_wait, (
VALUE)&arguments);
699 return fiber_scheduler_io_wait((
VALUE)&arguments);
727 VALUE arguments[] = {
728 readables, writables, exceptables, timeout
771fiber_scheduler_io_read(
VALUE _argument) {
774 return rb_funcallv(arguments[0], id_io_read, 4, arguments + 1);
784 VALUE arguments[] = {
789 return rb_thread_io_blocking_operation(io, fiber_scheduler_io_read, (
VALUE)&arguments);
791 return fiber_scheduler_io_read((
VALUE)&arguments);
810fiber_scheduler_io_pread(
VALUE _argument) {
813 return rb_funcallv(arguments[0], id_io_pread, 5, arguments + 1);
823 VALUE arguments[] = {
828 return rb_thread_io_blocking_operation(io, fiber_scheduler_io_pread, (
VALUE)&arguments);
830 return fiber_scheduler_io_pread((
VALUE)&arguments);
863fiber_scheduler_io_write(
VALUE _argument) {
866 return rb_funcallv(arguments[0], id_io_write, 4, arguments + 1);
876 VALUE arguments[] = {
881 return rb_thread_io_blocking_operation(io, fiber_scheduler_io_write, (
VALUE)&arguments);
883 return fiber_scheduler_io_write((
VALUE)&arguments);
903fiber_scheduler_io_pwrite(
VALUE _argument) {
906 return rb_funcallv(arguments[0], id_io_pwrite, 5, arguments + 1);
916 VALUE arguments[] = {
921 return rb_thread_io_blocking_operation(io, fiber_scheduler_io_pwrite, (
VALUE)&arguments);
923 return fiber_scheduler_io_pwrite((
VALUE)&arguments);
930 VALUE buffer = rb_io_buffer_new(base, size, RB_IO_BUFFER_LOCKED);
934 rb_io_buffer_free_locked(buffer);
942 VALUE buffer = rb_io_buffer_new((
void*)base, size, RB_IO_BUFFER_LOCKED|RB_IO_BUFFER_READONLY);
946 rb_io_buffer_free_locked(buffer);
954 VALUE buffer = rb_io_buffer_new(base, size, RB_IO_BUFFER_LOCKED);
958 rb_io_buffer_free_locked(buffer);
966 VALUE buffer = rb_io_buffer_new((
void*)base, size, RB_IO_BUFFER_LOCKED|RB_IO_BUFFER_READONLY);
970 rb_io_buffer_free_locked(buffer);
978 VALUE arguments[] = {io};
1018 VALUE arguments[] = {
1044 if (!
rb_respond_to(scheduler, id_blocking_operation_wait)) {
1049 VALUE blocking_operation = rb_fiber_scheduler_blocking_operation_new(function, data, unblock_function, data2, flags, state);
1051 VALUE result =
rb_funcall(scheduler, id_blocking_operation_wait, 1, blocking_operation);
1058 operation->function = NULL;
1059 operation->state = NULL;
1060 operation->data = NULL;
1061 operation->data2 = NULL;
1062 operation->unblock_function = NULL;
1066 if (current_status != RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_COMPLETED) {
1075 VALUE arguments[] = {
1081 if (RUBY_VM_INTERRUPTED(ec)) {
1082 rb_bug(
"rb_fiber_scheduler_fiber_interrupt called with pending interrupt");
1122 if (blocking_operation == NULL) {
1128 switch (current_state) {
1129 case RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_QUEUED:
1131 if (
RUBY_ATOMIC_CAS(blocking_operation->status, current_state, RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_CANCELLED) == current_state) {
1136 case RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_EXECUTING:
1138 RUBY_ATOMIC_SET(blocking_operation->status, RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_CANCELLED);
1139 if (blocking_operation->unblock_function) {
1140 blocking_operation->unblock_function(blocking_operation->data2);
1144 case RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_COMPLETED:
1145 case RB_FIBER_SCHEDULER_BLOCKING_OPERATION_STATUS_CANCELLED:
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define RUBY_ATOMIC_CAS(var, oldval, newval)
Atomic compare-and-swap.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define RUBY_ATOMIC_LOAD(var)
Atomic load.
#define RUBY_ATOMIC_SET(var, val)
Identical to RUBY_ATOMIC_EXCHANGE, except for the return type.
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
VALUE rb_class_new(VALUE super)
Creates a new, anonymous class.
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
#define Qundef
Old name of RUBY_Qundef.
#define SIZET2NUM
Old name of RB_SIZE2NUM.
#define Qnil
Old name of RUBY_Qnil.
VALUE rb_eRuntimeError
RuntimeError exception.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
VALUE rb_funcall_passing_block_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
Identical to rb_funcallv_passing_block(), except you can specify how to handle the last element of th...
void rb_unblock_function_t(void *)
This is the type of UBFs.
int rb_respond_to(VALUE obj, ID mid)
Queries if the object responds to the method.
VALUE rb_check_funcall(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv(), except it returns RUBY_Qundef instead of raising rb_eNoMethodError.
void rb_define_alloc_func(VALUE klass, rb_alloc_func_t func)
Sets the allocator function of a class.
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
VALUE rb_io_timeout(VALUE io)
Get the timeout associated with the specified io object.
@ RUBY_IO_READABLE
IO::READABLE
@ RUBY_IO_WRITABLE
IO::WRITABLE
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...
#define RB_UINT2NUM
Just another name of rb_uint2num_inline.
#define RB_INT2NUM
Just another name of rb_int2num_inline.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
#define OFFT2NUM
Converts a C's off_t into an instance of rb_cInteger.
#define PIDT2NUM
Converts a C's pid_t into an instance of rb_cInteger.
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
#define TypedData_Make_Struct(klass, type, data_type, sval)
Identical to TypedData_Wrap_Struct, except it allocates a new data region internally instead of takin...
#define errno
Ractor-aware version of errno.
VALUE rb_fiber_scheduler_blocking_operation_wait(VALUE scheduler, void *(*function)(void *), void *data, rb_unblock_function_t *unblock_function, void *data2, int flags, struct rb_fiber_scheduler_blocking_operation_state *state)
Defer the execution of the passed function to the scheduler.
VALUE rb_fiber_scheduler_current(void)
Identical to rb_fiber_scheduler_get(), except it also returns RUBY_Qnil in case of a blocking fiber.
VALUE rb_fiber_scheduler_io_pread_memory(VALUE scheduler, VALUE io, rb_off_t from, void *base, size_t size, size_t length)
Non-blocking pread from the passed IO using a native buffer.
VALUE rb_fiber_scheduler_make_timeout(struct timeval *timeout)
Converts the passed timeout to an expression that rb_fiber_scheduler_block() etc.
VALUE rb_fiber_scheduler_io_wait_readable(VALUE scheduler, VALUE io)
Non-blocking wait until the passed IO is ready for reading.
VALUE rb_fiber_scheduler_io_read_memory(VALUE scheduler, VALUE io, void *base, size_t size, size_t length)
Non-blocking read from the passed IO using a native buffer.
VALUE rb_fiber_scheduler_io_pwrite(VALUE scheduler, VALUE io, rb_off_t from, VALUE buffer, size_t length, size_t offset)
Non-blocking write to the passed IO at the specified offset.
VALUE rb_fiber_scheduler_kernel_sleepv(VALUE scheduler, int argc, VALUE *argv)
Identical to rb_fiber_scheduler_kernel_sleep(), except it can pass multiple arguments.
VALUE rb_fiber_scheduler_fiber_interrupt(VALUE scheduler, VALUE fiber, VALUE exception)
Interrupt a fiber by raising an exception.
VALUE rb_fiber_scheduler_io_wait(VALUE scheduler, VALUE io, VALUE events, VALUE timeout)
Non-blocking version of rb_io_wait().
VALUE rb_fiber_scheduler_io_select(VALUE scheduler, VALUE readables, VALUE writables, VALUE exceptables, VALUE timeout)
Non-blocking version of IO.select.
VALUE rb_fiber_scheduler_io_read(VALUE scheduler, VALUE io, VALUE buffer, size_t length, size_t offset)
Non-blocking read from the passed IO.
int rb_fiber_scheduler_blocking_operation_cancel(rb_fiber_scheduler_blocking_operation_t *blocking_operation)
Cancel a blocking operation.
VALUE rb_fiber_scheduler_io_selectv(VALUE scheduler, int argc, VALUE *argv)
Non-blocking version of IO.select, argv variant.
VALUE rb_fiber_scheduler_process_wait(VALUE scheduler, rb_pid_t pid, int flags)
Non-blocking waitpid.
VALUE rb_fiber_scheduler_block(VALUE scheduler, VALUE blocker, VALUE timeout)
Non-blocking wait for the passed "blocker", which is for instance Thread.join or Mutex....
int rb_fiber_scheduler_blocking_operation_execute(rb_fiber_scheduler_blocking_operation_t *blocking_operation)
Execute blocking operation from handle (GVL not required).
VALUE rb_fiber_scheduler_io_pread(VALUE scheduler, VALUE io, rb_off_t from, VALUE buffer, size_t length, size_t offset)
Non-blocking read from the passed IO at the specified offset.
VALUE rb_fiber_scheduler_io_pwrite_memory(VALUE scheduler, VALUE io, rb_off_t from, const void *base, size_t size, size_t length)
Non-blocking pwrite to the passed IO using a native buffer.
VALUE rb_fiber_scheduler_io_write(VALUE scheduler, VALUE io, VALUE buffer, size_t length, size_t offset)
Non-blocking write to the passed IO.
VALUE rb_fiber_scheduler_close(VALUE scheduler)
Closes the passed scheduler object.
rb_fiber_scheduler_blocking_operation_t * rb_fiber_scheduler_blocking_operation_extract(VALUE self)
Extract the blocking operation handle from a BlockingOperationRuby object.
VALUE rb_fiber_scheduler_current_for_thread(VALUE thread)
Identical to rb_fiber_scheduler_current(), except it queries for that of the passed thread instead of...
VALUE rb_fiber_scheduler_kernel_sleep(VALUE scheduler, VALUE duration)
Non-blocking sleep.
VALUE rb_fiber_scheduler_address_resolve(VALUE scheduler, VALUE hostname)
Non-blocking DNS lookup.
VALUE rb_fiber_scheduler_set(VALUE scheduler)
Destructively assigns the passed scheduler to that of the current thread that is calling this functio...
VALUE rb_fiber_scheduler_io_write_memory(VALUE scheduler, VALUE io, const void *base, size_t size, size_t length)
Non-blocking write to the passed IO using a native buffer.
VALUE rb_fiber_scheduler_io_wait_writable(VALUE scheduler, VALUE io)
Non-blocking wait until the passed IO is ready for writing.
VALUE rb_fiber_scheduler_io_close(VALUE scheduler, VALUE io)
Non-blocking close the given IO.
VALUE rb_fiber_scheduler_get(void)
Queries the current scheduler of the current thread that is calling this function.
VALUE rb_fiber_scheduler_unblock(VALUE scheduler, VALUE blocker, VALUE fiber)
Wakes up a fiber previously blocked using rb_fiber_scheduler_block().
VALUE rb_fiber_scheduler_fiber(VALUE scheduler, int argc, VALUE *argv, int kw_splat)
Create and schedule a non-blocking fiber.
@ RUBY_Qundef
Represents so-called undef.
This is the struct that holds necessary info for a struct.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.