12#include "ruby/internal/config.h"
21#ifdef NEED_MADVICE_PROTOTYPE_USING_CADDR_T
23extern int madvise(caddr_t,
size_t,
int);
28#include "eval_intern.h"
30#include "internal/cont.h"
31#include "internal/thread.h"
32#include "internal/error.h"
33#include "internal/eval.h"
34#include "internal/gc.h"
35#include "internal/proc.h"
36#include "internal/sanitizers.h"
37#include "internal/warnings.h"
43#include "ractor_core.h"
45static const int DEBUG = 0;
47#define RB_PAGE_SIZE (pagesize)
48#define RB_PAGE_MASK (~(RB_PAGE_SIZE - 1))
53static VALUE rb_cContinuation;
54static VALUE rb_cFiber;
55static VALUE rb_eFiberError;
56#ifdef RB_EXPERIMENTAL_FIBER_POOL
57static VALUE rb_cFiberPool;
60#define CAPTURE_JUST_VALID_VM_STACK 1
63#ifdef COROUTINE_LIMITED_ADDRESS_SPACE
64#define FIBER_POOL_ALLOCATION_FREE
65#define FIBER_POOL_INITIAL_SIZE 8
66#define FIBER_POOL_ALLOCATION_MAXIMUM_SIZE 32
68#define FIBER_POOL_INITIAL_SIZE 32
69#define FIBER_POOL_ALLOCATION_MAXIMUM_SIZE 1024
71#ifdef RB_EXPERIMENTAL_FIBER_POOL
72#define FIBER_POOL_ALLOCATION_FREE
76 CONTINUATION_CONTEXT = 0,
82#ifdef CAPTURE_JUST_VALID_VM_STACK
119#ifdef FIBER_POOL_ALLOCATION_FREE
162#ifdef FIBER_POOL_ALLOCATION_FREE
170#ifdef FIBER_POOL_ALLOCATION_FREE
191 size_t initial_count;
202 size_t vm_stack_size;
215 enum context_type type;
253#define FIBER_CREATED_P(fiber) ((fiber)->status == FIBER_CREATED)
254#define FIBER_RESUMED_P(fiber) ((fiber)->status == FIBER_RESUMED)
255#define FIBER_SUSPENDED_P(fiber) ((fiber)->status == FIBER_SUSPENDED)
256#define FIBER_TERMINATED_P(fiber) ((fiber)->status == FIBER_TERMINATED)
257#define FIBER_RUNNABLE_P(fiber) (FIBER_CREATED_P(fiber) || FIBER_SUSPENDED_P(fiber))
265 BITFIELD(
enum fiber_status, status, 2);
267 unsigned int yielding : 1;
268 unsigned int blocking : 1;
270 unsigned int killed : 1;
276static struct fiber_pool shared_fiber_pool = {NULL, NULL, 0, 0, 0, 0};
279rb_free_shared_fiber_pool(
void)
282 while (allocations) {
289static ID fiber_initialize_keywords[3] = {0};
296#if defined(MAP_STACK) && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
297#define FIBER_STACK_FLAGS (MAP_PRIVATE | MAP_ANON | MAP_STACK)
299#define FIBER_STACK_FLAGS (MAP_PRIVATE | MAP_ANON)
302#define ERRNOMSG strerror(errno)
306fiber_pool_vacancy_pointer(
void * base,
size_t size)
308 STACK_GROW_DIR_DETECTION;
311 (
char*)base + STACK_DIR_UPPER(0, size - RB_PAGE_SIZE)
315#if defined(COROUTINE_SANITIZE_ADDRESS)
320 STACK_GROW_DIR_DETECTION;
322 return (
char*)stack->base + STACK_DIR_UPPER(RB_PAGE_SIZE, 0);
329 return stack->size - RB_PAGE_SIZE;
337 STACK_GROW_DIR_DETECTION;
339 stack->current = (
char*)stack->base + STACK_DIR_UPPER(0, stack->size);
340 stack->available = stack->size;
347 STACK_GROW_DIR_DETECTION;
349 VM_ASSERT(stack->current);
351 return STACK_DIR_UPPER(stack->current, (
char*)stack->current - stack->available);
359 STACK_GROW_DIR_DETECTION;
361 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_alloca(%p): %"PRIuSIZE
"/%"PRIuSIZE
"\n", (
void*)stack, offset, stack->available);
362 VM_ASSERT(stack->available >= offset);
365 void * pointer = STACK_DIR_UPPER(stack->current, (
char*)stack->current - offset);
368 stack->current = STACK_DIR_UPPER((
char*)stack->current + offset, (
char*)stack->current - offset);
369 stack->available -= offset;
378 fiber_pool_stack_reset(&vacancy->stack);
381 fiber_pool_stack_alloca(&vacancy->stack, RB_PAGE_SIZE);
387 vacancy->next = head;
389#ifdef FIBER_POOL_ALLOCATION_FREE
391 head->previous = vacancy;
392 vacancy->previous = NULL;
399#ifdef FIBER_POOL_ALLOCATION_FREE
404 vacancy->next->previous = vacancy->previous;
407 if (vacancy->previous) {
408 vacancy->previous->next = vacancy->next;
412 vacancy->stack.pool->vacancies = vacancy->next;
417fiber_pool_vacancy_pop(
struct fiber_pool * pool)
422 fiber_pool_vacancy_remove(vacancy);
429fiber_pool_vacancy_pop(
struct fiber_pool * pool)
434 pool->vacancies = vacancy->next;
449 vacancy->stack.base = base;
450 vacancy->stack.size = size;
452 fiber_pool_vacancy_reset(vacancy);
456 return fiber_pool_vacancy_push(vacancy, vacancies);
464fiber_pool_allocate_memory(
size_t * count,
size_t stride)
474 void * base = VirtualAlloc(0, (*count)*stride, MEM_COMMIT, PAGE_READWRITE);
477 *count = (*count) >> 1;
484 size_t mmap_size = (*count)*stride;
485 void * base = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE, FIBER_STACK_FLAGS, -1, 0);
487 if (base == MAP_FAILED) {
489 *count = (*count) >> 1;
492 ruby_annotate_mmap(base, mmap_size,
"Ruby:fiber_pool_allocate_memory");
493#if defined(MADV_FREE_REUSE)
497 while (madvise(base, mmap_size, MADV_FREE_REUSE) == -1 &&
errno == EAGAIN);
517 STACK_GROW_DIR_DETECTION;
520 size_t stride = size + RB_PAGE_SIZE;
523 void * base = fiber_pool_allocate_memory(&count, stride);
526 rb_raise(rb_eFiberError,
"can't alloc machine stack to fiber (%"PRIuSIZE
" x %"PRIuSIZE
" bytes): %s", count, size, ERRNOMSG);
533 allocation->base = base;
534 allocation->size = size;
535 allocation->stride = stride;
536 allocation->count = count;
537#ifdef FIBER_POOL_ALLOCATION_FREE
538 allocation->used = 0;
543 fprintf(stderr,
"fiber_pool_expand(%"PRIuSIZE
"): %p, %"PRIuSIZE
"/%"PRIuSIZE
" x [%"PRIuSIZE
":%"PRIuSIZE
"]\n",
548 for (
size_t i = 0; i < count; i += 1) {
549 void * base = (
char*)allocation->base + (stride * i);
550 void * page = (
char*)base + STACK_DIR_UPPER(size, 0);
554 if (!VirtualProtect(page, RB_PAGE_SIZE, PAGE_READWRITE | PAGE_GUARD, &old_protect)) {
555 VirtualFree(allocation->base, 0, MEM_RELEASE);
556 rb_raise(rb_eFiberError,
"can't set a guard page: %s", ERRNOMSG);
558#elif defined(__wasi__)
562 if (mprotect(page, RB_PAGE_SIZE, PROT_NONE) < 0) {
563 munmap(allocation->base, count*stride);
564 rb_raise(rb_eFiberError,
"can't set a guard page: %s", ERRNOMSG);
568 vacancies = fiber_pool_vacancy_initialize(
570 (
char*)base + STACK_DIR_UPPER(0, RB_PAGE_SIZE),
574#ifdef FIBER_POOL_ALLOCATION_FREE
575 vacancies->stack.allocation = allocation;
582#ifdef FIBER_POOL_ALLOCATION_FREE
583 if (allocation->next) {
584 allocation->next->previous = allocation;
587 allocation->previous = NULL;
602fiber_pool_initialize(
struct fiber_pool *
fiber_pool,
size_t size,
size_t count,
size_t vm_stack_size)
604 VM_ASSERT(vm_stack_size < size);
608 fiber_pool->size = ((size / RB_PAGE_SIZE) + 1) * RB_PAGE_SIZE;
619#ifdef FIBER_POOL_ALLOCATION_FREE
624 STACK_GROW_DIR_DETECTION;
626 VM_ASSERT(allocation->used == 0);
628 if (DEBUG) fprintf(stderr,
"fiber_pool_allocation_free: %p base=%p count=%"PRIuSIZE
"\n", (
void*)allocation, allocation->base, allocation->count);
631 for (i = 0; i < allocation->count; i += 1) {
632 void * base = (
char*)allocation->base + (allocation->stride * i) + STACK_DIR_UPPER(0, RB_PAGE_SIZE);
634 struct fiber_pool_vacancy * vacancy = fiber_pool_vacancy_pointer(base, allocation->size);
637 fiber_pool_vacancy_remove(vacancy);
641 VirtualFree(allocation->base, 0, MEM_RELEASE);
643 munmap(allocation->base, allocation->stride * allocation->count);
646 if (allocation->previous) {
647 allocation->previous->next = allocation->next;
651 allocation->pool->allocations = allocation->next;
654 if (allocation->next) {
655 allocation->next->previous = allocation->previous;
658 allocation->pool->count -= allocation->count;
660 ruby_xfree(allocation);
673 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_acquire: %p used=%"PRIuSIZE
"\n", (
void*)
fiber_pool->vacancies,
fiber_pool->used);
676 const size_t maximum = FIBER_POOL_ALLOCATION_MAXIMUM_SIZE;
677 const size_t minimum =
fiber_pool->initial_count;
680 if (count > maximum) count = maximum;
681 if (count < minimum) count = minimum;
692 VM_ASSERT(vacancy->stack.base);
694#if defined(COROUTINE_SANITIZE_ADDRESS)
695 __asan_unpoison_memory_region(fiber_pool_stack_poison_base(&vacancy->stack), fiber_pool_stack_poison_size(&vacancy->stack));
701#ifdef FIBER_POOL_ALLOCATION_FREE
702 vacancy->stack.allocation->used += 1;
705 fiber_pool_stack_reset(&vacancy->stack);
709 return vacancy->stack;
717 void * base = fiber_pool_stack_base(stack);
718 size_t size = stack->available;
721 VM_ASSERT(size <= (stack->size - RB_PAGE_SIZE));
723 int advice = stack->pool->free_stacks >> 1;
725 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_free: %p+%"PRIuSIZE
" [base=%p, size=%"PRIuSIZE
"] advice=%d\n", base, size, stack->base, stack->size, advice);
738#elif VM_CHECK_MODE > 0 && defined(MADV_DONTNEED)
739 if (!advice) advice = MADV_DONTNEED;
741 madvise(base, size, advice);
742#elif defined(MADV_FREE_REUSABLE)
743 if (!advice) advice = MADV_FREE_REUSABLE;
749 while (madvise(base, size, advice) == -1 &&
errno == EAGAIN);
750#elif defined(MADV_FREE)
751 if (!advice) advice = MADV_FREE;
753 madvise(base, size, advice);
754#elif defined(MADV_DONTNEED)
755 if (!advice) advice = MADV_DONTNEED;
757 madvise(base, size, advice);
758#elif defined(POSIX_MADV_DONTNEED)
759 if (!advice) advice = POSIX_MADV_DONTNEED;
761 posix_madvise(base, size, advice);
763 VirtualAlloc(base, size, MEM_RESET, PAGE_READWRITE);
768#if defined(COROUTINE_SANITIZE_ADDRESS)
769 __asan_poison_memory_region(fiber_pool_stack_poison_base(stack), fiber_pool_stack_poison_size(stack));
778 struct fiber_pool_vacancy * vacancy = fiber_pool_vacancy_pointer(stack->base, stack->size);
780 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_release: %p used=%"PRIuSIZE
"\n", stack->base, stack->pool->used);
783 vacancy->stack = *stack;
787 fiber_pool_vacancy_reset(vacancy);
790 pool->vacancies = fiber_pool_vacancy_push(vacancy, pool->vacancies);
793#ifdef FIBER_POOL_ALLOCATION_FREE
796 allocation->used -= 1;
799 if (allocation->used == 0) {
800 fiber_pool_allocation_free(allocation);
802 else if (stack->pool->free_stacks) {
803 fiber_pool_stack_free(&vacancy->stack);
808 if (stack->pool->free_stacks) {
809 fiber_pool_stack_free(&vacancy->stack);
818#ifdef RUBY_ASAN_ENABLED
819 ec->machine.asan_fake_stack_handle = asan_get_thread_fake_stack_handle();
821 rb_ractor_set_current_ec(th->ractor, th->ec = ec);
828 if (th->vm->ractor.main_thread == th &&
829 rb_signal_buff_size() > 0) {
830 RUBY_VM_SET_TRAP_INTERRUPT(ec);
833 VM_ASSERT(ec->fiber_ptr->cont.self == 0 || ec->vm_stack != NULL);
839 ec_switch(th, fiber);
840 VM_ASSERT(th->ec->fiber_ptr == fiber);
843#ifndef COROUTINE_DECL
844# define COROUTINE_DECL COROUTINE
852#if defined(COROUTINE_SANITIZE_ADDRESS)
862 __sanitizer_finish_switch_fiber(to->fake_stack, (
const void**)&from->stack_base, &from->stack_size);
865 rb_thread_t *thread = fiber->cont.saved_ec.thread_ptr;
867#ifdef COROUTINE_PTHREAD_CONTEXT
868 ruby_thread_set_native(thread);
871 fiber_restore_thread(thread, fiber);
873 rb_fiber_start(fiber);
875#ifndef COROUTINE_PTHREAD_CONTEXT
876 VM_UNREACHABLE(fiber_entry);
882fiber_initialize_coroutine(
rb_fiber_t *fiber,
size_t * vm_stack_size)
886 void * vm_stack = NULL;
890 fiber->stack = fiber_pool_stack_acquire(
fiber_pool);
891 vm_stack = fiber_pool_stack_alloca(&fiber->stack,
fiber_pool->vm_stack_size);
894 coroutine_initialize(&fiber->context, fiber_entry, fiber_pool_stack_base(&fiber->stack), fiber->stack.available);
897 sec->machine.stack_start = fiber->stack.current;
898 sec->machine.stack_maxsize = fiber->stack.available;
900 fiber->context.argument = (
void*)fiber;
912 if (DEBUG) fprintf(stderr,
"fiber_stack_release: %p, stack.base=%p\n", (
void*)fiber, fiber->stack.base);
915 if (fiber->stack.base) {
916 fiber_pool_stack_release(&fiber->stack);
917 fiber->stack.base = NULL;
921 rb_ec_clear_vm_stack(ec);
927 if (!ruby_vm_during_cleanup) {
930 ASSERT_vm_locking_with_barrier();
932 fiber_stack_release(fiber);
936fiber_status_name(
enum fiber_status s)
939 case FIBER_CREATED:
return "created";
940 case FIBER_RESUMED:
return "resumed";
941 case FIBER_SUSPENDED:
return "suspended";
942 case FIBER_TERMINATED:
return "terminated";
944 VM_UNREACHABLE(fiber_status_name);
952 VM_ASSERT(fiber->cont.saved_ec.fiber_ptr == fiber);
954 switch (fiber->status) {
956 if (fiber->cont.saved_ec.thread_ptr->self == 0) {
957 VM_ASSERT(fiber->cont.saved_ec.vm_stack != NULL);
960 case FIBER_SUSPENDED:
961 VM_ASSERT(fiber->cont.saved_ec.vm_stack != NULL);
964 case FIBER_TERMINATED:
968 VM_UNREACHABLE(fiber_verify);
974fiber_status_set(
rb_fiber_t *fiber,
enum fiber_status s)
977 VM_ASSERT(!FIBER_TERMINATED_P(fiber));
978 VM_ASSERT(fiber->status != s);
999 if (!fiber) rb_raise(rb_eFiberError,
"uninitialized fiber");
1004NOINLINE(
static VALUE cont_capture(
volatile int *
volatile stat));
1006#define THREAD_MUST_BE_RUNNING(th) do { \
1007 if (!(th)->ec->tag) rb_raise(rb_eThreadError, "not running thread"); \
1013 return fiber->cont.saved_ec.thread_ptr;
1019 return cont->saved_ec.thread_ptr->self;
1023cont_compact(
void *ptr)
1028 cont->self = rb_gc_location(cont->self);
1030 cont->value = rb_gc_location(cont->value);
1031 rb_execution_context_update(&cont->saved_ec);
1039 RUBY_MARK_ENTER(
"cont");
1041 rb_gc_mark_movable(cont->self);
1043 rb_gc_mark_movable(cont->value);
1045 rb_execution_context_mark(&cont->saved_ec);
1046 rb_gc_mark(cont_thread_value(cont));
1048 if (cont->saved_vm_stack.ptr) {
1049#ifdef CAPTURE_JUST_VALID_VM_STACK
1050 rb_gc_mark_locations(cont->saved_vm_stack.ptr,
1051 cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1053 rb_gc_mark_locations(cont->saved_vm_stack.ptr,
1054 cont->saved_vm_stack.ptr, cont->saved_ec.stack_size);
1058 if (cont->machine.stack) {
1059 if (cont->type == CONTINUATION_CONTEXT) {
1061 rb_gc_mark_locations(cont->machine.stack,
1062 cont->machine.stack + cont->machine.stack_size);
1070 RUBY_MARK_LEAVE(
"cont");
1077 return fiber == fiber->cont.saved_ec.thread_ptr->root_fiber;
1081static void jit_cont_free(
struct rb_jit_cont *cont);
1088 RUBY_FREE_ENTER(
"cont");
1090 if (cont->type == CONTINUATION_CONTEXT) {
1091 ruby_xfree(cont->saved_ec.vm_stack);
1092 RUBY_FREE_UNLESS_NULL(cont->machine.stack);
1096 coroutine_destroy(&fiber->context);
1097 fiber_stack_release_locked(fiber);
1100 RUBY_FREE_UNLESS_NULL(cont->saved_vm_stack.ptr);
1102 VM_ASSERT(cont->jit_cont != NULL);
1103 jit_cont_free(cont->jit_cont);
1106 RUBY_FREE_LEAVE(
"cont");
1110cont_memsize(
const void *ptr)
1115 size =
sizeof(*cont);
1116 if (cont->saved_vm_stack.ptr) {
1117#ifdef CAPTURE_JUST_VALID_VM_STACK
1118 size_t n = (cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1120 size_t n = cont->saved_ec.vm_stack_size;
1122 size += n *
sizeof(*cont->saved_vm_stack.ptr);
1125 if (cont->machine.stack) {
1126 size += cont->machine.stack_size *
sizeof(*cont->machine.stack);
1135 if (fiber->cont.self) {
1136 fiber->cont.self = rb_gc_location(fiber->cont.self);
1139 rb_execution_context_update(&fiber->cont.saved_ec);
1146 rb_gc_mark_movable(fiber->cont.self);
1150fiber_compact(
void *ptr)
1153 fiber->first_proc = rb_gc_location(fiber->first_proc);
1155 if (fiber->prev) rb_fiber_update_self(fiber->prev);
1157 cont_compact(&fiber->cont);
1158 fiber_verify(fiber);
1162fiber_mark(
void *ptr)
1165 RUBY_MARK_ENTER(
"cont");
1166 fiber_verify(fiber);
1167 rb_gc_mark_movable(fiber->first_proc);
1168 if (fiber->prev) rb_fiber_mark_self(fiber->prev);
1169 cont_mark(&fiber->cont);
1170 RUBY_MARK_LEAVE(
"cont");
1174fiber_free(
void *ptr)
1177 RUBY_FREE_ENTER(
"fiber");
1179 if (DEBUG) fprintf(stderr,
"fiber_free: %p[%p]\n", (
void *)fiber, fiber->stack.base);
1181 if (fiber->cont.saved_ec.local_storage) {
1182 rb_id_table_free(fiber->cont.saved_ec.local_storage);
1185 cont_free(&fiber->cont);
1186 RUBY_FREE_LEAVE(
"fiber");
1190fiber_memsize(
const void *ptr)
1193 size_t size =
sizeof(*fiber);
1195 const rb_thread_t *th = rb_ec_thread_ptr(saved_ec);
1200 if (saved_ec->local_storage && fiber != th->root_fiber) {
1201 size += rb_id_table_memsize(saved_ec->local_storage);
1202 size += rb_obj_memsize_of(saved_ec->storage);
1205 size += cont_memsize(&fiber->cont);
1212 return RBOOL(rb_typeddata_is_kind_of(obj, &rb_fiber_data_type));
1220 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
1222 if (th->ec->machine.stack_start > th->ec->machine.stack_end) {
1223 size = cont->machine.stack_size = th->ec->machine.stack_start - th->ec->machine.stack_end;
1224 cont->machine.stack_src = th->ec->machine.stack_end;
1227 size = cont->machine.stack_size = th->ec->machine.stack_end - th->ec->machine.stack_start;
1228 cont->machine.stack_src = th->ec->machine.stack_start;
1231 if (cont->machine.stack) {
1238 FLUSH_REGISTER_WINDOWS;
1239 asan_unpoison_memory_region(cont->machine.stack_src, size,
false);
1240 MEMCPY(cont->machine.stack, cont->machine.stack_src,
VALUE, size);
1244 {cont_mark, cont_free, cont_memsize, cont_compact},
1245 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
1249rb_cont_handle_weak_references(
VALUE obj)
1256 if (!rb_gc_handle_weak_references_alive_p(cont->saved_ec.gen_fields_cache.obj) ||
1257 !rb_gc_handle_weak_references_alive_p(cont->saved_ec.gen_fields_cache.fields_obj)) {
1258 cont->saved_ec.gen_fields_cache.obj =
Qundef;
1259 cont->saved_ec.gen_fields_cache.fields_obj =
Qundef;
1268 VM_ASSERT(th->status == THREAD_RUNNABLE);
1275 sec->machine.stack_end = NULL;
1278static rb_nativethread_lock_t jit_cont_lock;
1296 if (first_jit_cont == NULL) {
1297 cont->next = cont->prev = NULL;
1301 cont->next = first_jit_cont;
1302 first_jit_cont->prev = cont;
1304 first_jit_cont = cont;
1317 if (cont == first_jit_cont) {
1318 first_jit_cont = cont->next;
1319 if (first_jit_cont != NULL)
1320 first_jit_cont->prev = NULL;
1323 cont->prev->next = cont->next;
1324 if (cont->next != NULL)
1325 cont->next->prev = cont->prev;
1334rb_jit_cont_each_iseq(rb_iseq_callback callback,
void *data)
1337 for (cont = first_jit_cont; cont != NULL; cont = cont->next) {
1338 if (cont->ec->vm_stack == NULL)
1342 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(cont->ec, cfp)) {
1343 if (cfp->pc && cfp->iseq && imemo_type((
VALUE)cfp->iseq) == imemo_iseq) {
1344 callback(cfp->iseq, data);
1346 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1355rb_yjit_cancel_jit_return(
void *leave_exit,
void *leave_exception)
1358 for (cont = first_jit_cont; cont != NULL; cont = cont->next) {
1359 if (cont->ec->vm_stack == NULL)
1363 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(cont->ec, cfp)) {
1364 if (cfp->jit_return && cfp->jit_return != leave_exception) {
1367 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1375rb_jit_cont_finish(
void)
1378 for (cont = first_jit_cont; cont != NULL; cont = next) {
1388 VM_ASSERT(cont->jit_cont == NULL);
1390 cont->jit_cont = jit_cont_new(&(cont->saved_ec));
1396 return &fiber->cont.saved_ec;
1403 cont_save_thread(cont, th);
1404 cont->saved_ec.thread_ptr = th;
1405 cont->saved_ec.local_storage = NULL;
1406 cont->saved_ec.local_storage_recursive_hash =
Qnil;
1407 cont->saved_ec.local_storage_recursive_hash_for_trace =
Qnil;
1408 cont_init_jit_cont(cont);
1412cont_new(
VALUE klass)
1415 volatile VALUE contval;
1418 THREAD_MUST_BE_RUNNING(th);
1420 rb_gc_declare_weak_references(contval);
1421 cont->self = contval;
1422 cont_init(cont, th);
1429 return fiber->cont.self;
1435 return fiber->blocking;
1440rb_jit_cont_init(
void)
1449 VALUE *p = ec->vm_stack;
1450 while (p < ec->cfp->sp) {
1451 fprintf(stderr,
"%3d ", (
int)(p - ec->vm_stack));
1452 rb_obj_info_dump(*p);
1462 while (cfp != end_of_cfp) {
1465 pc = cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded;
1467 fprintf(stderr,
"%2d pc: %d\n", i++, pc);
1468 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1474cont_capture(
volatile int *
volatile stat)
1478 volatile VALUE contval;
1481 THREAD_MUST_BE_RUNNING(th);
1482 rb_vm_stack_to_heap(th->ec);
1483 cont = cont_new(rb_cContinuation);
1484 contval = cont->self;
1486#ifdef CAPTURE_JUST_VALID_VM_STACK
1487 cont->saved_vm_stack.slen = ec->cfp->sp - ec->vm_stack;
1488 cont->saved_vm_stack.clen = ec->vm_stack + ec->vm_stack_size - (
VALUE*)ec->cfp;
1489 cont->saved_vm_stack.ptr =
ALLOC_N(
VALUE, cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1490 MEMCPY(cont->saved_vm_stack.ptr,
1492 VALUE, cont->saved_vm_stack.slen);
1493 MEMCPY(cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen,
1496 cont->saved_vm_stack.clen);
1498 cont->saved_vm_stack.ptr =
ALLOC_N(
VALUE, ec->vm_stack_size);
1499 MEMCPY(cont->saved_vm_stack.ptr, ec->vm_stack,
VALUE, ec->vm_stack_size);
1502 rb_ec_set_vm_stack(&cont->saved_ec, NULL, 0);
1503 VM_ASSERT(cont->saved_ec.cfp != NULL);
1504 cont_save_machine_stack(th, cont);
1506 if (ruby_setjmp(cont->jmpbuf)) {
1509 VAR_INITIALIZED(cont);
1510 value = cont->value;
1528 if (cont->type == CONTINUATION_CONTEXT) {
1533 if (sec->fiber_ptr != NULL) {
1534 fiber = sec->fiber_ptr;
1536 else if (th->root_fiber) {
1537 fiber = th->root_fiber;
1540 if (fiber && th->ec != &fiber->cont.saved_ec) {
1541 ec_switch(th, fiber);
1544 if (th->ec->trace_arg != sec->trace_arg) {
1548#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
1549 if (th->ec->tag != sec->tag) {
1552 struct rb_vm_tag *lowest_common_ancestor = NULL;
1553 size_t num_tags = 0;
1554 size_t num_saved_tags = 0;
1555 for (
struct rb_vm_tag *tag = th->ec->tag; tag != NULL; tag = tag->prev) {
1558 for (
struct rb_vm_tag *tag = sec->tag; tag != NULL; tag = tag->prev) {
1562 size_t min_tags = num_tags <= num_saved_tags ? num_tags : num_saved_tags;
1565 while (num_tags > min_tags) {
1571 while (num_saved_tags > min_tags) {
1572 saved_tag = saved_tag->prev;
1576 while (min_tags > 0) {
1577 if (tag == saved_tag) {
1578 lowest_common_ancestor = tag;
1582 saved_tag = saved_tag->prev;
1587 for (
struct rb_vm_tag *tag = th->ec->tag; tag != lowest_common_ancestor; tag = tag->prev) {
1588 rb_vm_tag_jmpbuf_deinit(&tag->buf);
1594#ifdef CAPTURE_JUST_VALID_VM_STACK
1596 cont->saved_vm_stack.ptr,
1597 VALUE, cont->saved_vm_stack.slen);
1598 MEMCPY(th->ec->vm_stack + th->ec->vm_stack_size - cont->saved_vm_stack.clen,
1599 cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen,
1600 VALUE, cont->saved_vm_stack.clen);
1602 MEMCPY(th->ec->vm_stack, cont->saved_vm_stack.ptr,
VALUE, sec->vm_stack_size);
1606 th->ec->cfp = sec->cfp;
1607 th->ec->raised_flag = sec->raised_flag;
1608 th->ec->tag = sec->tag;
1609 th->ec->root_lep = sec->root_lep;
1610 th->ec->root_svar = sec->root_svar;
1611 th->ec->errinfo = sec->errinfo;
1613 VM_ASSERT(th->ec->vm_stack != NULL);
1629 if (!FIBER_TERMINATED_P(old_fiber)) {
1630 STACK_GROW_DIR_DETECTION;
1631 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
1632 if (STACK_DIR_UPPER(0, 1)) {
1633 old_fiber->cont.machine.stack_size = th->ec->machine.stack_start - th->ec->machine.stack_end;
1634 old_fiber->cont.machine.stack = th->ec->machine.stack_end;
1637 old_fiber->cont.machine.stack_size = th->ec->machine.stack_end - th->ec->machine.stack_start;
1638 old_fiber->cont.machine.stack = th->ec->machine.stack_start;
1643 old_fiber->cont.saved_ec.machine.stack_start = th->ec->machine.stack_start;
1644 old_fiber->cont.saved_ec.machine.stack_end = FIBER_TERMINATED_P(old_fiber) ? NULL : th->ec->machine.stack_end;
1649#if defined(COROUTINE_SANITIZE_ADDRESS)
1650 __sanitizer_start_switch_fiber(FIBER_TERMINATED_P(old_fiber) ? NULL : &old_fiber->context.fake_stack, new_fiber->context.stack_base, new_fiber->context.stack_size);
1654 struct coroutine_context * from = coroutine_transfer(&old_fiber->context, &new_fiber->context);
1656#if defined(COROUTINE_SANITIZE_ADDRESS)
1657 __sanitizer_finish_switch_fiber(old_fiber->context.fake_stack, NULL, NULL);
1665 fiber_restore_thread(th, old_fiber);
1671NOINLINE(NORETURN(
static void cont_restore_1(
rb_context_t *)));
1676 cont_restore_thread(cont);
1679#if (defined(_M_AMD64) && !defined(__MINGW64__)) || defined(_M_ARM64)
1684 _JUMP_BUFFER *bp = (
void*)&cont->jmpbuf;
1685 bp->Frame = ((_JUMP_BUFFER*)((
void*)&buf))->Frame;
1688 if (cont->machine.stack_src) {
1689 FLUSH_REGISTER_WINDOWS;
1690 MEMCPY(cont->machine.stack_src, cont->machine.stack,
1691 VALUE, cont->machine.stack_size);
1694 ruby_longjmp(cont->jmpbuf, 1);
1702 if (cont->machine.stack_src) {
1704#define STACK_PAD_SIZE 1
1706#define STACK_PAD_SIZE 1024
1708 VALUE space[STACK_PAD_SIZE];
1710#if !STACK_GROW_DIRECTION
1711 if (addr_in_prev_frame > &space[0]) {
1714#if STACK_GROW_DIRECTION <= 0
1715 volatile VALUE *
const end = cont->machine.stack_src;
1716 if (&space[0] > end) {
1725 cont_restore_0(cont, &space[0]);
1729#if !STACK_GROW_DIRECTION
1734#if STACK_GROW_DIRECTION >= 0
1735 volatile VALUE *
const end = cont->machine.stack_src + cont->machine.stack_size;
1736 if (&space[STACK_PAD_SIZE] < end) {
1741 cont_restore_0(cont, &space[STACK_PAD_SIZE-1]);
1745#if !STACK_GROW_DIRECTION
1749 cont_restore_1(cont);
1836rb_callcc(
VALUE self)
1838 volatile int called;
1839 volatile VALUE val = cont_capture(&called);
1848#ifdef RUBY_ASAN_ENABLED
1851MAYBE_UNUSED(
static void notusing_callcc(
void)) { rb_callcc(
Qnil); }
1852# define rb_callcc rb_f_notimplement
1857make_passing_arg(
int argc,
const VALUE *argv)
1873NORETURN(
static VALUE rb_cont_call(
int argc,
VALUE *argv,
VALUE contval));
1891rb_cont_call(
int argc,
VALUE *argv,
VALUE contval)
1896 if (cont_thread_value(cont) != th->self) {
1899 if (cont->saved_ec.fiber_ptr) {
1900 if (th->ec->fiber_ptr != cont->saved_ec.fiber_ptr) {
1906 cont->value = make_passing_arg(argc, argv);
1908 cont_restore_0(cont, &contval);
2001 {fiber_mark, fiber_free, fiber_memsize, fiber_compact,},
2002 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
2006rb_fiber_handle_weak_references(
VALUE obj)
2013 if (!rb_gc_handle_weak_references_alive_p(fiber->cont.saved_ec.gen_fields_cache.obj) ||
2014 !rb_gc_handle_weak_references_alive_p(fiber->cont.saved_ec.gen_fields_cache.fields_obj)) {
2015 fiber->cont.saved_ec.gen_fields_cache.obj =
Qundef;
2016 fiber->cont.saved_ec.gen_fields_cache.fields_obj =
Qundef;
2021fiber_alloc(
VALUE klass)
2024 rb_gc_declare_weak_references(obj);
2031 return cr->next_ec_serial++;
2035fiber_t_alloc(
VALUE fiber_value,
unsigned int blocking)
2044 THREAD_MUST_BE_RUNNING(th);
2046 fiber->cont.self = fiber_value;
2047 fiber->cont.type = FIBER_CONTEXT;
2048 fiber->blocking = blocking;
2050 cont_init(&fiber->cont, th);
2052 fiber->cont.saved_ec.fiber_ptr = fiber;
2053 fiber->cont.saved_ec.serial = next_ec_serial(th->ractor);
2054 rb_ec_clear_vm_stack(&fiber->cont.saved_ec);
2060 VM_ASSERT(FIBER_CREATED_P(fiber));
2071 return ec->fiber_ptr;
2075current_fiber_storage(
void)
2082inherit_fiber_storage(
void)
2090 fiber->cont.saved_ec.storage = storage;
2094fiber_storage_get(
rb_fiber_t *fiber,
int allocate)
2096 VALUE storage = fiber->cont.saved_ec.storage;
2097 if (storage ==
Qnil && allocate) {
2098 storage = rb_hash_new();
2099 fiber_storage_set(fiber, storage);
2105storage_access_must_be_from_same_fiber(
VALUE self)
2109 if (fiber != current) {
2110 rb_raise(rb_eArgError,
"Fiber storage can only be accessed from the Fiber it belongs to");
2121rb_fiber_storage_get(
VALUE self)
2123 storage_access_must_be_from_same_fiber(self);
2125 VALUE storage = fiber_storage_get(fiber_ptr(self), FALSE);
2127 if (storage ==
Qnil) {
2144fiber_storage_validate(
VALUE value)
2147 if (value ==
Qnil)
return;
2187 "Fiber#storage= is experimental and may be removed in the future!");
2190 storage_access_must_be_from_same_fiber(self);
2191 fiber_storage_validate(value);
2193 fiber_ptr(self)->cont.saved_ec.storage =
rb_obj_dup(value);
2212 VALUE storage = fiber_storage_get(fiber_current(), FALSE);
2215 return rb_hash_aref(storage, key);
2233 VALUE storage = fiber_storage_get(fiber_current(), value !=
Qnil);
2236 if (value ==
Qnil) {
2237 return rb_hash_delete(storage, key);
2240 return rb_hash_aset(storage, key, value);
2249 storage = inherit_fiber_storage();
2252 fiber_storage_validate(storage);
2256 rb_fiber_t *fiber = fiber_t_alloc(self, blocking);
2258 fiber->cont.saved_ec.storage = storage;
2259 fiber->first_proc = proc;
2260 fiber->stack.base = NULL;
2272 size_t vm_stack_size = 0;
2273 VALUE *vm_stack = fiber_initialize_coroutine(fiber, &vm_stack_size);
2276 cont->saved_vm_stack.ptr = NULL;
2277 rb_ec_initialize_vm_stack(sec, vm_stack, vm_stack_size /
sizeof(
VALUE));
2280 sec->local_storage = NULL;
2281 sec->local_storage_recursive_hash =
Qnil;
2282 sec->local_storage_recursive_hash_for_trace =
Qnil;
2286rb_fiber_pool_default(
VALUE pool)
2288 return &shared_fiber_pool;
2294 fiber->cont.saved_ec.storage = storage;
2300rb_fiber_initialize_kw(
int argc,
VALUE* argv,
VALUE self,
int kw_splat)
2311 rb_get_kwargs(options, fiber_initialize_keywords, 0, 3, arguments);
2313 if (!UNDEF_P(arguments[0])) {
2314 blocking = arguments[0];
2317 if (!UNDEF_P(arguments[1])) {
2318 pool = arguments[1];
2321 storage = arguments[2];
2324 return fiber_initialize(self,
rb_block_proc(), rb_fiber_pool_default(pool),
RTEST(blocking), storage);
2377rb_fiber_initialize(
int argc,
VALUE* argv,
VALUE self)
2385 return fiber_initialize(fiber_alloc(rb_cFiber),
rb_proc_new(func, obj), rb_fiber_pool_default(
Qnil), 0, storage);
2391 return rb_fiber_new_storage(func, obj,
Qtrue);
2395rb_fiber_s_schedule_kw(
int argc,
VALUE* argv,
int kw_splat)
2398 VALUE scheduler = th->scheduler;
2401 if (scheduler !=
Qnil) {
2453rb_fiber_s_schedule(
int argc,
VALUE *argv,
VALUE obj)
2469rb_fiber_s_scheduler(
VALUE klass)
2483rb_fiber_current_scheduler(
VALUE klass)
2505rb_fiber_set_scheduler(
VALUE klass,
VALUE scheduler)
2510NORETURN(
static void rb_fiber_terminate(
rb_fiber_t *fiber,
int need_interrupt,
VALUE err));
2515 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2518 enum ruby_tag_type state;
2520 VM_ASSERT(th->ec == GET_EC());
2521 VM_ASSERT(FIBER_RESUMED_P(fiber));
2523 if (fiber->blocking) {
2527 EC_PUSH_TAG(th->ec);
2528 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2531 const VALUE *argv, args = cont->value;
2532 GetProcPtr(fiber->first_proc, proc);
2535 th->ec->errinfo =
Qnil;
2536 th->ec->root_lep = rb_vm_proc_local_ep(fiber->first_proc);
2537 th->ec->root_svar =
Qfalse;
2540 cont->value = rb_vm_invoke_proc(th->ec, proc, argc, argv, cont->kw_splat, VM_BLOCK_HANDLER_NONE);
2544 int need_interrupt = TRUE;
2547 err = th->ec->errinfo;
2548 VM_ASSERT(FIBER_RESUMED_P(fiber));
2550 if (state == TAG_RAISE) {
2553 else if (state == TAG_FATAL && err == RUBY_FATAL_FIBER_KILLED) {
2554 need_interrupt = FALSE;
2557 else if (state == TAG_FATAL) {
2558 rb_threadptr_pending_interrupt_enque(th, err);
2561 err = rb_vm_make_jump_tag_but_local_jump(state, err);
2565 rb_fiber_terminate(fiber, need_interrupt, err);
2574 rb_bug(
"%s", strerror(
errno));
2577 fiber->cont.type = FIBER_CONTEXT;
2578 fiber->cont.saved_ec.fiber_ptr = fiber;
2579 fiber->cont.saved_ec.serial = next_ec_serial(th->ractor);
2580 fiber->cont.saved_ec.thread_ptr = th;
2581 fiber->blocking = 1;
2583 fiber_status_set(fiber, FIBER_RESUMED);
2585 coroutine_initialize_main(&fiber->context);
2587 th->ec = &fiber->cont.saved_ec;
2589 cont_init_jit_cont(&fiber->cont);
2596 VALUE fiber_value = fiber_alloc(rb_cFiber);
2598 fiber->cont.self = fiber_value;
2604 if (th->root_fiber) {
2610 VM_ASSERT(th->ec->fiber_ptr->cont.type == FIBER_CONTEXT);
2611 VM_ASSERT(th->ec->fiber_ptr->cont.self == 0);
2613 if (ec && th->ec == ec) {
2614 rb_ractor_set_current_ec(th->ractor, NULL);
2616 fiber_free(th->ec->fiber_ptr);
2626 fiber->status = FIBER_TERMINATED;
2629 rb_ec_clear_vm_stack(th->ec);
2633return_fiber(
bool terminate)
2640 prev->resuming_fiber = NULL;
2645 rb_raise(rb_eFiberError,
"attempt to yield on a not resumed fiber");
2651 VM_ASSERT(root_fiber != NULL);
2654 for (fiber = root_fiber; fiber->resuming_fiber; fiber = fiber->resuming_fiber) {
2662rb_fiber_current(
void)
2664 return fiber_current()->cont.self;
2673 if (FIBER_CREATED_P(next_fiber)) {
2674 fiber_prepare_stack(next_fiber);
2677 VM_ASSERT(FIBER_RESUMED_P(fiber) || FIBER_TERMINATED_P(fiber));
2678 VM_ASSERT(FIBER_RUNNABLE_P(next_fiber));
2680 if (FIBER_RESUMED_P(fiber)) fiber_status_set(fiber, FIBER_SUSPENDED);
2682 fiber_status_set(next_fiber, FIBER_RESUMED);
2683 fiber_setcontext(next_fiber, fiber);
2689 VM_ASSERT(fiber == fiber_current());
2691 if (fiber->killed) {
2692 rb_thread_t *thread = fiber->cont.saved_ec.thread_ptr;
2694 thread->ec->errinfo = RUBY_FATAL_FIBER_KILLED;
2695 EC_JUMP_TAG(thread->ec, RUBY_TAG_FATAL);
2707 if (th->root_fiber == NULL) {
2708 th->root_fiber = th->ec->fiber_ptr;
2711 if (th->ec->fiber_ptr == fiber) {
2715 return make_passing_arg(argc, argv);
2718 if (cont_thread_value(cont) != th->self) {
2719 rb_raise(rb_eFiberError,
"fiber called across threads");
2722 if (FIBER_TERMINATED_P(fiber)) {
2723 value =
rb_exc_new2(rb_eFiberError,
"dead fiber called");
2725 if (!FIBER_TERMINATED_P(th->ec->fiber_ptr)) {
2727 VM_UNREACHABLE(fiber_switch);
2733 VM_ASSERT(FIBER_SUSPENDED_P(th->root_fiber));
2735 cont = &th->root_fiber->cont;
2737 cont->value = value;
2739 fiber_setcontext(th->root_fiber, th->ec->fiber_ptr);
2741 VM_UNREACHABLE(fiber_switch);
2745 VM_ASSERT(FIBER_RUNNABLE_P(fiber));
2749 VM_ASSERT(!current_fiber->resuming_fiber);
2751 if (resuming_fiber) {
2752 current_fiber->resuming_fiber = resuming_fiber;
2753 fiber->prev = fiber_current();
2754 fiber->yielding = 0;
2757 VM_ASSERT(!current_fiber->yielding);
2759 current_fiber->yielding = 1;
2762 if (current_fiber->blocking) {
2767 cont->kw_splat = kw_splat;
2768 cont->value = make_passing_arg(argc, argv);
2770 fiber_store(fiber, th);
2773#ifndef COROUTINE_PTHREAD_CONTEXT
2774 if (resuming_fiber && FIBER_TERMINATED_P(fiber)) {
2776 fiber_stack_release(fiber);
2781 if (fiber_current()->blocking) {
2785 RUBY_VM_CHECK_INTS(th->ec);
2789 current_fiber = th->ec->fiber_ptr;
2790 value = current_fiber->cont.value;
2792 fiber_check_killed(current_fiber);
2794 if (current_fiber->cont.argc == -1) {
2805 return fiber_switch(fiber_ptr(fiber_value), argc, argv,
RB_NO_KEYWORDS, NULL,
false);
2823rb_fiber_blocking_p(
VALUE fiber)
2825 return RBOOL(fiber_ptr(fiber)->blocking);
2829fiber_blocking_yield(
VALUE fiber_value)
2832 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2834 VM_ASSERT(fiber->blocking == 0);
2837 fiber->blocking = 1;
2846fiber_blocking_ensure(
VALUE fiber_value)
2849 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2852 fiber->blocking = 0;
2869rb_fiber_blocking(
VALUE class)
2871 VALUE fiber_value = rb_fiber_current();
2875 if (fiber->blocking) {
2879 return rb_ensure(fiber_blocking_yield, fiber_value, fiber_blocking_ensure, fiber_value);
2902rb_fiber_s_blocking_p(
VALUE klass)
2905 unsigned blocking = thread->blocking;
2916 fiber_status_set(fiber, FIBER_TERMINATED);
2917 rb_ec_close(&fiber->cont.saved_ec);
2923 VALUE value = fiber->cont.value;
2925 VM_ASSERT(FIBER_RESUMED_P(fiber));
2926 rb_fiber_close(fiber);
2928 fiber->cont.machine.stack = NULL;
2929 fiber->cont.machine.stack_size = 0;
2933 if (need_interrupt) RUBY_VM_SET_INTERRUPT(&next_fiber->cont.saved_ec);
2936 fiber_switch(next_fiber, -1, &error,
RB_NO_KEYWORDS, NULL,
false);
2938 fiber_switch(next_fiber, 1, &value,
RB_NO_KEYWORDS, NULL,
false);
2943fiber_resume_kw(
rb_fiber_t *fiber,
int argc,
const VALUE *argv,
int kw_splat)
2947 if (argc == -1 && FIBER_CREATED_P(fiber)) {
2948 rb_raise(rb_eFiberError,
"cannot raise exception on unborn fiber");
2950 else if (FIBER_TERMINATED_P(fiber)) {
2951 rb_raise(rb_eFiberError,
"attempt to resume a terminated fiber");
2953 else if (fiber == current_fiber) {
2954 rb_raise(rb_eFiberError,
"attempt to resume the current fiber");
2956 else if (fiber->prev != NULL) {
2957 rb_raise(rb_eFiberError,
"attempt to resume a resumed fiber (double resume)");
2959 else if (fiber->resuming_fiber) {
2960 rb_raise(rb_eFiberError,
"attempt to resume a resuming fiber");
2962 else if (fiber->prev == NULL &&
2963 (!fiber->yielding && fiber->status != FIBER_CREATED)) {
2964 rb_raise(rb_eFiberError,
"attempt to resume a transferring fiber");
2967 return fiber_switch(fiber, argc, argv, kw_splat, fiber,
false);
2971rb_fiber_resume_kw(
VALUE self,
int argc,
const VALUE *argv,
int kw_splat)
2973 return fiber_resume_kw(fiber_ptr(self), argc, argv, kw_splat);
2979 return fiber_resume_kw(fiber_ptr(self), argc, argv,
RB_NO_KEYWORDS);
2983rb_fiber_yield_kw(
int argc,
const VALUE *argv,
int kw_splat)
2985 return fiber_switch(return_fiber(
false), argc, argv, kw_splat, NULL,
true);
2989rb_fiber_yield(
int argc,
const VALUE *argv)
2991 return fiber_switch(return_fiber(
false), argc, argv,
RB_NO_KEYWORDS, NULL,
true);
2997 if (th->root_fiber && th->root_fiber != th->ec->fiber_ptr) {
2998 th->ec->local_storage = th->root_fiber->cont.saved_ec.local_storage;
3013 return RBOOL(!FIBER_TERMINATED_P(fiber_ptr(fiber_value)));
3032rb_fiber_m_resume(
int argc,
VALUE *argv,
VALUE fiber)
3084rb_fiber_backtrace(
int argc,
VALUE *argv,
VALUE fiber)
3086 return rb_vm_backtrace(argc, argv, &fiber_ptr(fiber)->cont.saved_ec);
3109rb_fiber_backtrace_locations(
int argc,
VALUE *argv,
VALUE fiber)
3111 return rb_vm_backtrace_locations(argc, argv, &fiber_ptr(fiber)->cont.saved_ec);
3197rb_fiber_m_transfer(
int argc,
VALUE *argv,
VALUE self)
3203fiber_transfer_kw(
rb_fiber_t *fiber,
int argc,
const VALUE *argv,
int kw_splat)
3205 if (fiber->resuming_fiber) {
3206 rb_raise(rb_eFiberError,
"attempt to transfer to a resuming fiber");
3209 if (fiber->yielding) {
3210 rb_raise(rb_eFiberError,
"attempt to transfer to a yielding fiber");
3213 return fiber_switch(fiber, argc, argv, kw_splat, NULL,
false);
3217rb_fiber_transfer_kw(
VALUE self,
int argc,
const VALUE *argv,
int kw_splat)
3219 return fiber_transfer_kw(fiber_ptr(self), argc, argv, kw_splat);
3233rb_fiber_s_yield(
int argc,
VALUE *argv,
VALUE klass)
3241 if (fiber == fiber_current()) {
3244 else if (fiber->resuming_fiber) {
3245 return fiber_raise(fiber->resuming_fiber, exception);
3247 else if (FIBER_SUSPENDED_P(fiber) && !fiber->yielding) {
3258 VALUE exception = rb_exception_setup(argc, argv);
3260 return fiber_raise(fiber_ptr(fiber), exception);
3298rb_fiber_m_raise(
int argc,
VALUE *argv,
VALUE self)
3300 return rb_fiber_raise(self, argc, argv);
3321rb_fiber_m_kill(
VALUE self)
3325 if (fiber->killed)
return Qfalse;
3328 if (fiber->status == FIBER_CREATED) {
3329 fiber->status = FIBER_TERMINATED;
3331 else if (fiber->status != FIBER_TERMINATED) {
3332 if (fiber_current() == fiber) {
3333 fiber_check_killed(fiber);
3336 fiber_raise(fiber_ptr(self),
Qnil);
3351rb_fiber_s_current(
VALUE klass)
3353 return rb_fiber_current();
3357fiber_to_s(
VALUE fiber_value)
3359 const rb_fiber_t *fiber = fiber_ptr(fiber_value);
3361 char status_info[0x20];
3363 if (fiber->resuming_fiber) {
3364 snprintf(status_info, 0x20,
" (%s by resuming)", fiber_status_name(fiber->status));
3367 snprintf(status_info, 0x20,
" (%s)", fiber_status_name(fiber->status));
3372 strlcat(status_info,
">",
sizeof(status_info));
3377 GetProcPtr(fiber->first_proc, proc);
3378 return rb_block_to_s(fiber_value, &proc->block, status_info);
3381#ifdef HAVE_WORKING_FORK
3385 if (th->root_fiber) {
3386 if (&th->root_fiber->cont.saved_ec != th->ec) {
3387 th->root_fiber = th->ec->fiber_ptr;
3389 th->root_fiber->prev = 0;
3390 th->root_fiber->blocking = 1;
3396#ifdef RB_EXPERIMENTAL_FIBER_POOL
3398fiber_pool_free(
void *ptr)
3401 RUBY_FREE_ENTER(
"fiber_pool");
3403 fiber_pool_allocation_free(
fiber_pool->allocations);
3406 RUBY_FREE_LEAVE(
"fiber_pool");
3410fiber_pool_memsize(
const void *ptr)
3413 size_t size =
sizeof(*fiber_pool);
3422 {NULL, fiber_pool_free, fiber_pool_memsize,},
3423 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3427fiber_pool_alloc(
VALUE klass)
3435rb_fiber_pool_initialize(
int argc,
VALUE* argv,
VALUE self)
3442 rb_scan_args(argc, argv,
"03", &size, &count, &vm_stack_size);
3445 size =
SIZET2NUM(th->vm->default_params.fiber_machine_stack_size);
3452 if (
NIL_P(vm_stack_size)) {
3453 vm_stack_size =
SIZET2NUM(th->vm->default_params.fiber_vm_stack_size);
3481 size_t vm_stack_size = th->vm->default_params.fiber_vm_stack_size;
3482 size_t machine_stack_size = th->vm->default_params.fiber_machine_stack_size;
3483 size_t stack_size = machine_stack_size + vm_stack_size;
3487 GetSystemInfo(&info);
3488 pagesize = info.dwPageSize;
3490 pagesize = sysconf(_SC_PAGESIZE);
3492 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
3494 fiber_pool_initialize(&shared_fiber_pool, stack_size, FIBER_POOL_INITIAL_SIZE, vm_stack_size);
3500 const char *fiber_shared_fiber_pool_free_stacks = getenv(
"RUBY_SHARED_FIBER_POOL_FREE_STACKS");
3501 if (fiber_shared_fiber_pool_free_stacks) {
3502 shared_fiber_pool.free_stacks = atoi(fiber_shared_fiber_pool_free_stacks);
3504 if (shared_fiber_pool.free_stacks < 0) {
3505 rb_warn(
"Setting RUBY_SHARED_FIBER_POOL_FREE_STACKS to a negative value is not allowed.");
3506 shared_fiber_pool.free_stacks = 0;
3509 if (shared_fiber_pool.free_stacks > 1) {
3510 rb_warn(
"Setting RUBY_SHARED_FIBER_POOL_FREE_STACKS to a value greater than 1 is operating system specific, and may cause crashes.");
3531 rb_define_method(rb_cFiber,
"backtrace_locations", rb_fiber_backtrace_locations, -1);
3544 rb_thread_t *current_thread = rb_current_thread();
3546 *(
VALUE *)&((
struct RBasic *)current_thread->ec->fiber_ptr->cont.self)->klass = rb_cFiber;
3548#ifdef RB_EXPERIMENTAL_FIBER_POOL
3555 rb_define_method(rb_cFiberPool,
"initialize", rb_fiber_pool_initialize, -1);
3561RUBY_SYMBOL_EXPORT_BEGIN
3564ruby_Init_Continuation_body(
void)
3574RUBY_SYMBOL_EXPORT_END
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
#define rb_define_global_function(mid, func, arity)
Defines rb_mKernel #mid.
#define RUBY_EVENT_FIBER_SWITCH
Encountered a Fiber#yield.
static bool RB_OBJ_FROZEN(VALUE obj)
Checks if an object is frozen.
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
int rb_scan_args_kw(int kw_flag, int argc, const VALUE *argv, const char *fmt,...)
Identical to rb_scan_args(), except it also accepts kw_splat.
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
int rb_keyword_given_p(void)
Determines if the current method is given a keyword argument.
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
#define REALLOC_N
Old name of RB_REALLOC_N.
#define xfree
Old name of ruby_xfree.
#define Qundef
Old name of RUBY_Qundef.
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
#define ZALLOC
Old name of RB_ZALLOC.
#define CLASS_OF
Old name of rb_class_of.
#define rb_ary_new4
Old name of rb_ary_new_from_values.
#define SIZET2NUM
Old name of RB_SIZE2NUM.
#define rb_exc_new2
Old name of rb_exc_new_cstr.
#define T_HASH
Old name of RUBY_T_HASH.
#define ALLOC_N
Old name of RB_ALLOC_N.
#define Qtrue
Old name of RUBY_Qtrue.
#define INT2NUM
Old name of RB_INT2NUM.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define NIL_P
Old name of RB_NIL_P.
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
#define NUM2SIZET
Old name of RB_NUM2SIZE.
void ruby_stop(int ex)
Calls ruby_cleanup() and exits the process.
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
void rb_syserr_fail(int e, const char *mesg)
Raises appropriate exception that represents a C errno.
VALUE rb_eStandardError
StandardError exception.
VALUE rb_eFrozenError
FrozenError exception.
VALUE rb_eTypeError
TypeError exception.
VALUE rb_eRuntimeError
RuntimeError exception.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
@ RB_WARN_CATEGORY_EXPERIMENTAL
Warning is for experimental features.
VALUE rb_any_to_s(VALUE obj)
Generates a textual representation of the given object.
VALUE rb_obj_dup(VALUE obj)
Duplicates the given object.
void rb_provide(const char *feature)
Declares that the given feature is already provided by someone else.
VALUE rb_block_proc(void)
Constructs a Proc object from implicitly passed components.
VALUE rb_obj_is_proc(VALUE recv)
Queries if the given object is a proc.
void rb_str_set_len(VALUE str, long len)
Overwrites the length of the string.
#define rb_str_cat_cstr(buf, str)
Identical to rb_str_cat(), except it assumes the passed pointer is a pointer to a C string.
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
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_to_symbol(VALUE name)
Identical to rb_intern_str(), except it generates a dynamic symbol if necessary.
VALUE rb_yield(VALUE val)
Yields the block.
rb_block_call_func * rb_block_call_func_t
Shorthand type that represents an iterator-written-in-C function pointer.
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
#define ALLOCA_N(type, n)
#define RB_ALLOC(type)
Shorthand of RB_ALLOC_N with n=1.
VALUE rb_proc_new(type *q, VALUE w)
Creates a rb_cProc instance.
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
#define DATA_PTR(obj)
Convenient getter macro.
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a 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.
#define RB_NO_KEYWORDS
Do not pass keywords.
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_set(VALUE scheduler)
Destructively assigns the passed scheduler to that of the current thread that is calling this functio...
VALUE rb_fiber_scheduler_get(void)
Queries the current scheduler of the current thread that is calling this function.
VALUE rb_fiber_scheduler_fiber(VALUE scheduler, int argc, VALUE *argv, int kw_splat)
Create and schedule a non-blocking fiber.
#define RTEST
This is an old name of RB_TEST.
Ruby object's base components.
This is the struct that holds necessary info for a struct.
void rb_native_mutex_lock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_lock.
void rb_native_mutex_initialize(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_initialize.
void rb_native_mutex_unlock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_unlock.
void rb_native_mutex_destroy(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_destroy.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.