12#include "ruby/internal/config.h"
21#include "eval_intern.h"
23#include "internal/cont.h"
24#include "internal/jit.h"
25#include "internal/thread.h"
26#include "internal/error.h"
27#include "internal/eval.h"
28#include "internal/gc.h"
29#include "internal/proc.h"
30#include "internal/sanitizers.h"
31#include "internal/vm_map.h"
32#include "internal/warnings.h"
39#include "ractor_core.h"
48#define RB_PAGE_SIZE (pagesize)
49#define RB_PAGE_MASK (~(RB_PAGE_SIZE - 1))
54static VALUE rb_cContinuation;
55static VALUE rb_cFiber;
56static VALUE rb_eFiberError;
57#ifdef RB_EXPERIMENTAL_FIBER_POOL
58static VALUE rb_cFiberPool;
61#define CAPTURE_JUST_VALID_VM_STACK 1
64#ifdef COROUTINE_LIMITED_ADDRESS_SPACE
65#define FIBER_POOL_ALLOCATION_FREE
66#define FIBER_POOL_MINIMUM_COUNT 8
67#define FIBER_POOL_MAXIMUM_ALLOCATIONS 32
69#define FIBER_POOL_MINIMUM_COUNT 32
70#define FIBER_POOL_MAXIMUM_ALLOCATIONS 1024
72#ifdef RB_EXPERIMENTAL_FIBER_POOL
73#define FIBER_POOL_ALLOCATION_FREE
77 CONTINUATION_CONTEXT = 0,
84#ifdef CAPTURE_JUST_VALID_VM_STACK
121#ifdef FIBER_POOL_ALLOCATION_FREE
164#ifdef FIBER_POOL_ALLOCATION_FREE
172#ifdef FIBER_POOL_ALLOCATION_FREE
193 size_t minimum_count;
197 size_t maximum_count;
208 size_t vm_stack_size;
221 enum context_type type;
259#define FIBER_CREATED_P(fiber) ((fiber)->status == FIBER_CREATED)
260#define FIBER_RESUMED_P(fiber) ((fiber)->status == FIBER_RESUMED)
261#define FIBER_SUSPENDED_P(fiber) ((fiber)->status == FIBER_SUSPENDED)
262#define FIBER_TERMINATED_P(fiber) ((fiber)->status == FIBER_TERMINATED)
263#define FIBER_RUNNABLE_P(fiber) (FIBER_CREATED_P(fiber) || FIBER_SUSPENDED_P(fiber))
271 BITFIELD(
enum fiber_status, status, 2);
273 unsigned int yielding : 1;
274 unsigned int blocking : 1;
276 unsigned int killed : 1;
282static struct fiber_pool shared_fiber_pool = {NULL, NULL, 0, 0, 0, 0};
285rb_free_shared_fiber_pool(
void)
288 while (allocations) {
290 SIZED_FREE(allocations);
295static ID fiber_initialize_keywords[3] = {0};
302#if defined(MAP_STACK) && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
303#define FIBER_STACK_FLAGS (MAP_PRIVATE | MAP_ANON | MAP_STACK)
304#define FIBER_PROT_FLAGS (PROT_READ | PROT_WRITE)
306#define FIBER_STACK_FLAGS (MAP_PRIVATE | MAP_ANON)
308#define FIBER_BASE_PROT_FLAGS PROT_READ | PROT_WRITE
309#define FIBER_PROT_FLAGS (FIBER_BASE_PROT_FLAGS | PROT_MAX(FIBER_BASE_PROT_FLAGS))
311#define FIBER_PROT_FLAGS (PROT_READ | PROT_WRITE)
315#define ERRNOMSG strerror(errno)
319fiber_pool_vacancy_pointer(
void * base,
size_t size)
321 STACK_GROW_DIR_DETECTION;
324 (
char*)base + STACK_DIR_UPPER(0, size - RB_PAGE_SIZE)
328#if defined(COROUTINE_SANITIZE_ADDRESS)
333 STACK_GROW_DIR_DETECTION;
335 return (
char*)stack->base + STACK_DIR_UPPER(RB_PAGE_SIZE, 0);
342 return stack->size - RB_PAGE_SIZE;
350 STACK_GROW_DIR_DETECTION;
352 stack->current = (
char*)stack->base + STACK_DIR_UPPER(0, stack->size);
353 stack->available = stack->size;
360 STACK_GROW_DIR_DETECTION;
362 VM_ASSERT(stack->current);
364 return STACK_DIR_UPPER(stack->current, (
char*)stack->current - stack->available);
372 STACK_GROW_DIR_DETECTION;
374 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_alloca(%p): %"PRIuSIZE
"/%"PRIuSIZE
"\n", (
void*)stack, offset, stack->available);
375 VM_ASSERT(stack->available >= offset);
378 void * pointer = STACK_DIR_UPPER(stack->current, (
char*)stack->current - offset);
381 stack->current = STACK_DIR_UPPER((
char*)stack->current + offset, (
char*)stack->current - offset);
382 stack->available -= offset;
391 fiber_pool_stack_reset(&vacancy->stack);
394 fiber_pool_stack_alloca(&vacancy->stack, RB_PAGE_SIZE);
400 vacancy->next = head;
402#ifdef FIBER_POOL_ALLOCATION_FREE
404 head->previous = vacancy;
405 vacancy->previous = NULL;
412#ifdef FIBER_POOL_ALLOCATION_FREE
417 vacancy->next->previous = vacancy->previous;
420 if (vacancy->previous) {
421 vacancy->previous->next = vacancy->next;
425 vacancy->stack.pool->vacancies = vacancy->next;
430fiber_pool_vacancy_pop(
struct fiber_pool * pool)
435 fiber_pool_vacancy_remove(vacancy);
442fiber_pool_vacancy_pop(
struct fiber_pool * pool)
447 pool->vacancies = vacancy->next;
462 vacancy->stack.base = base;
463 vacancy->stack.size = size;
465 fiber_pool_vacancy_reset(vacancy);
469 return fiber_pool_vacancy_push(vacancy, vacancies);
477fiber_pool_allocate_memory(
size_t * count,
size_t stride)
487 void * base = VirtualAlloc(0, (*count)*stride, MEM_COMMIT, PAGE_READWRITE);
490 errno = rb_w32_map_errno(GetLastError());
491 *count = (*count) >> 1;
498 size_t mmap_size = (*count)*stride;
499 void * base = mmap(NULL, mmap_size, FIBER_PROT_FLAGS, FIBER_STACK_FLAGS, -1, 0);
501 if (base == MAP_FAILED) {
503 *count = (*count) >> 1;
506 ruby_annotate_mmap(base, mmap_size,
"Ruby:fiber_pool_allocate_memory");
507 rb_vm_map_reuse(base, mmap_size);
533 STACK_GROW_DIR_DETECTION;
536 size_t stride = size + RB_PAGE_SIZE;
545 if (count > remaining) {
555 void * base = fiber_pool_allocate_memory(&count, stride);
559 ruby_xfree(allocation);
566 allocation->base = base;
567 allocation->size = size;
568 allocation->stride = stride;
569 allocation->count = count;
570#ifdef FIBER_POOL_ALLOCATION_FREE
571 allocation->used = 0;
576 fprintf(stderr,
"fiber_pool_expand(%"PRIuSIZE
"): %p, %"PRIuSIZE
"/%"PRIuSIZE
" x [%"PRIuSIZE
":%"PRIuSIZE
"]\n",
581 for (
size_t i = 0; i < count; i += 1) {
582 void * base = (
char*)allocation->base + (stride * i);
583 void * page = (
char*)base + STACK_DIR_UPPER(size, 0);
587 if (!VirtualProtect(page, RB_PAGE_SIZE, PAGE_READWRITE | PAGE_GUARD, &old_protect)) {
588 int error = rb_w32_map_errno(GetLastError());
589 VirtualFree(allocation->base, 0, MEM_RELEASE);
590 ruby_xfree(allocation);
594#elif defined(__wasi__)
598 if (mprotect(page, RB_PAGE_SIZE, PROT_NONE) < 0) {
600 if (!error) error = ENOMEM;
601 munmap(allocation->base, count*stride);
602 ruby_xfree(allocation);
608 vacancies = fiber_pool_vacancy_initialize(
610 (
char*)base + STACK_DIR_UPPER(0, RB_PAGE_SIZE),
614#ifdef FIBER_POOL_ALLOCATION_FREE
615 vacancies->stack.allocation = allocation;
622#ifdef FIBER_POOL_ALLOCATION_FREE
623 if (allocation->next) {
624 allocation->next->previous = allocation;
627 allocation->previous = NULL;
640fiber_pool_initialize(
struct fiber_pool *
fiber_pool,
size_t size,
size_t minimum_count,
size_t maximum_count,
size_t vm_stack_size)
642 VM_ASSERT(vm_stack_size < size);
646 fiber_pool->size = ((size / RB_PAGE_SIZE) + 1) * RB_PAGE_SIZE;
656 rb_raise(rb_eFiberError,
"can't allocate initial fiber stacks (%"PRIuSIZE
" x %"PRIuSIZE
" bytes): %s",
fiber_pool->minimum_count,
fiber_pool->size, strerror(
errno));
661#ifdef FIBER_POOL_ALLOCATION_FREE
666 STACK_GROW_DIR_DETECTION;
668 VM_ASSERT(allocation->used == 0);
670 if (DEBUG) fprintf(stderr,
"fiber_pool_allocation_free: %p base=%p count=%"PRIuSIZE
"\n", (
void*)allocation, allocation->base, allocation->count);
673 for (i = 0; i < allocation->count; i += 1) {
674 void * base = (
char*)allocation->base + (allocation->stride * i) + STACK_DIR_UPPER(0, RB_PAGE_SIZE);
676 struct fiber_pool_vacancy * vacancy = fiber_pool_vacancy_pointer(base, allocation->size);
679 fiber_pool_vacancy_remove(vacancy);
683 VirtualFree(allocation->base, 0, MEM_RELEASE);
685 munmap(allocation->base, allocation->stride * allocation->count);
688 if (allocation->previous) {
689 allocation->previous->next = allocation->next;
693 allocation->pool->allocations = allocation->next;
696 if (allocation->next) {
697 allocation->next->previous = allocation->previous;
700 allocation->pool->count -= allocation->count;
702 SIZED_FREE(allocation);
708fiber_pool_stack_expand_count(
const struct fiber_pool *pool)
710 const size_t maximum_allocations = FIBER_POOL_MAXIMUM_ALLOCATIONS;
711 const size_t minimum_count = FIBER_POOL_MINIMUM_COUNT;
714 size_t count = pool->count;
715 if (count > maximum_allocations) count = maximum_allocations;
716 if (count < minimum_count) count = minimum_count;
719 if (pool->maximum_count > 0) {
720 if (pool->count >= pool->maximum_count) {
726 size_t remaining = pool->maximum_count - pool->count;
727 if (count > remaining) {
740 size_t count = fiber_pool_stack_expand_count(
fiber_pool);
742 if (DEBUG_ACQUIRE) fprintf(stderr,
"fiber_pool_stack_acquire: expanding fiber pool by %"PRIuSIZE
" stacks\n", count);
746 if (RB_LIKELY(fiber_pool_expand(
fiber_pool, count))) {
750 if (DEBUG_ACQUIRE) fprintf(stderr,
"fiber_pool_stack_acquire: expand failed (%s), collecting garbage\n", strerror(
errno));
756 if (RB_LIKELY(vacancy)) {
761 count = fiber_pool_stack_expand_count(
fiber_pool);
764 if (RB_LIKELY(fiber_pool_expand(
fiber_pool, count))) {
781 RB_VM_LOCK_ENTER_LEV(&lev);
786 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_acquire: %p used=%"PRIuSIZE
"\n", (
void*)
fiber_pool->vacancies,
fiber_pool->used);
789 if (RB_UNLIKELY(!vacancy)) {
790 vacancy = fiber_pool_stack_acquire_expand(
fiber_pool);
793 if (RB_UNLIKELY(!vacancy)) {
794 RB_VM_LOCK_LEAVE_LEV(&lev);
795 rb_raise(rb_eFiberError,
"can't allocate fiber stack: %s", strerror(
errno));
800 VM_ASSERT(vacancy->stack.base);
802#if defined(COROUTINE_SANITIZE_ADDRESS)
803 __asan_unpoison_memory_region(fiber_pool_stack_poison_base(&vacancy->stack), fiber_pool_stack_poison_size(&vacancy->stack));
809#ifdef FIBER_POOL_ALLOCATION_FREE
810 vacancy->stack.allocation->used += 1;
813 fiber_pool_stack_reset(&vacancy->stack);
815 RB_VM_LOCK_LEAVE_LEV(&lev);
817 return vacancy->stack;
825 void * base = fiber_pool_stack_base(stack);
826 size_t size = stack->available;
829 VM_ASSERT(size <= (stack->size - RB_PAGE_SIZE));
831 int advice = stack->pool->free_stacks >> 1;
833 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_free: %p+%"PRIuSIZE
" [base=%p, size=%"PRIuSIZE
"] advice=%d\n", base, size, stack->base, stack->size, advice);
844 rb_vm_map_reusable_lazy(base, size, advice);
846#if defined(COROUTINE_SANITIZE_ADDRESS)
847 __asan_poison_memory_region(fiber_pool_stack_poison_base(stack), fiber_pool_stack_poison_size(stack));
856 struct fiber_pool_vacancy * vacancy = fiber_pool_vacancy_pointer(stack->base, stack->size);
858 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_release: %p used=%"PRIuSIZE
"\n", stack->base, stack->pool->used);
869 unsigned int lev = 0;
870 const bool lock_here = !ruby_vm_during_cleanup && rb_current_execution_context(
false) != NULL;
871 if (lock_here) RB_VM_LOCK_ENTER_LEV_NB(&lev);
874 vacancy->stack = *stack;
878 fiber_pool_vacancy_reset(vacancy);
881 pool->vacancies = fiber_pool_vacancy_push(vacancy, pool->vacancies);
884#ifdef FIBER_POOL_ALLOCATION_FREE
887 allocation->used -= 1;
890 if (allocation->used == 0) {
891 fiber_pool_allocation_free(allocation);
893 else if (stack->pool->free_stacks) {
894 fiber_pool_stack_free(&vacancy->stack);
899 if (stack->pool->free_stacks) {
900 fiber_pool_stack_free(&vacancy->stack);
904 if (lock_here) RB_VM_LOCK_LEAVE_LEV_NB(&lev);
911#ifdef RUBY_ASAN_ENABLED
912 ec->machine.asan_fake_stack_handle = asan_get_thread_fake_stack_handle();
914 rb_ractor_set_current_ec(th->ractor, th->ec = ec);
921 if (th->vm->ractor.main_thread == th &&
922 rb_signal_buff_size() > 0) {
923 RUBY_VM_SET_TRAP_INTERRUPT(ec);
926 VM_ASSERT(ec->fiber_ptr->cont.self == 0 || ec->vm_stack != NULL);
932 ec_switch(th, fiber);
933 VM_ASSERT(th->ec->fiber_ptr == fiber);
936#ifndef COROUTINE_DECL
937# define COROUTINE_DECL COROUTINE
945#if defined(COROUTINE_SANITIZE_ADDRESS)
955 __sanitizer_finish_switch_fiber(to->fake_stack, (
const void**)&from->stack_base, &from->stack_size);
958 rb_thread_t *thread = fiber->cont.saved_ec.thread_ptr;
960#ifdef COROUTINE_PTHREAD_CONTEXT
961 ruby_thread_set_native(thread);
964 fiber_restore_thread(thread, fiber);
966 rb_fiber_start(fiber);
968#ifndef COROUTINE_PTHREAD_CONTEXT
969 VM_UNREACHABLE(fiber_entry);
975fiber_initialize_coroutine(
rb_fiber_t *fiber,
size_t * vm_stack_size)
979 void * vm_stack = NULL;
983 fiber->stack = fiber_pool_stack_acquire(
fiber_pool);
984 vm_stack = fiber_pool_stack_alloca(&fiber->stack,
fiber_pool->vm_stack_size);
987 coroutine_initialize(&fiber->context, fiber_entry, fiber_pool_stack_base(&fiber->stack), fiber->stack.available);
990 sec->machine.stack_start = fiber->stack.current;
991 sec->machine.stack_maxsize = fiber->stack.available;
993 fiber->context.argument = (
void*)fiber;
1005 if (DEBUG) fprintf(stderr,
"fiber_stack_release: %p, stack.base=%p\n", (
void*)fiber, fiber->stack.base);
1008 if (fiber->stack.base) {
1009 fiber_pool_stack_release(&fiber->stack);
1010 fiber->stack.base = NULL;
1014 rb_ec_clear_vm_stack(ec);
1023 fiber_stack_release(fiber);
1027fiber_status_name(
enum fiber_status s)
1030 case FIBER_CREATED:
return "created";
1031 case FIBER_RESUMED:
return "resumed";
1032 case FIBER_SUSPENDED:
return "suspended";
1033 case FIBER_TERMINATED:
return "terminated";
1035 VM_UNREACHABLE(fiber_status_name);
1042#if VM_CHECK_MODE > 0
1043 VM_ASSERT(fiber->cont.saved_ec.fiber_ptr == fiber);
1045 switch (fiber->status) {
1047 if (fiber->cont.saved_ec.thread_ptr->self == 0) {
1048 VM_ASSERT(fiber->cont.saved_ec.vm_stack != NULL);
1051 case FIBER_SUSPENDED:
1052 VM_ASSERT(fiber->cont.saved_ec.vm_stack != NULL);
1055 case FIBER_TERMINATED:
1059 VM_UNREACHABLE(fiber_verify);
1065fiber_status_set(
rb_fiber_t *fiber,
enum fiber_status s)
1068 VM_ASSERT(!FIBER_TERMINATED_P(fiber));
1069 VM_ASSERT(fiber->status != s);
1070 fiber_verify(fiber);
1090 if (!fiber) rb_raise(rb_eFiberError,
"uninitialized fiber");
1095NOINLINE(
static VALUE cont_capture(
volatile int *
volatile stat));
1097#define THREAD_MUST_BE_RUNNING(th) do { \
1098 if (!(th)->ec->tag) rb_raise(rb_eThreadError, "not running thread"); \
1104 return fiber->cont.saved_ec.thread_ptr;
1110 return cont->saved_ec.thread_ptr->self;
1114cont_compact(
void *ptr)
1119 rb_gc_update_moved(&cont->self);
1121 rb_gc_update_moved(&cont->value);
1122 rb_execution_context_update(&cont->saved_ec);
1130 RUBY_MARK_ENTER(
"cont");
1132 rb_gc_mark_movable(cont->self);
1134 rb_gc_mark_movable(cont->value);
1136 rb_execution_context_mark(&cont->saved_ec);
1137 rb_gc_mark(cont_thread_value(cont));
1139 if (cont->saved_vm_stack.ptr) {
1140#ifdef CAPTURE_JUST_VALID_VM_STACK
1141 rb_gc_mark_locations(cont->saved_vm_stack.ptr,
1142 cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1144 rb_gc_mark_locations(cont->saved_vm_stack.ptr,
1145 cont->saved_vm_stack.ptr, cont->saved_ec.stack_size);
1149 if (cont->machine.stack) {
1150 if (cont->type == CONTINUATION_CONTEXT) {
1152 rb_gc_mark_locations(cont->machine.stack,
1153 cont->machine.stack + cont->machine.stack_size);
1161 RUBY_MARK_LEAVE(
"cont");
1168 return fiber == fiber->cont.saved_ec.thread_ptr->root_fiber;
1172static void jit_cont_free(
struct rb_jit_cont *cont);
1179 RUBY_FREE_ENTER(
"cont");
1181 if (cont->type == CONTINUATION_CONTEXT) {
1182 SIZED_FREE_N(cont->saved_ec.vm_stack, cont->saved_ec.vm_stack_size);
1183 SIZED_FREE_N(cont->machine.stack, cont->machine.stack_size);
1187 coroutine_destroy(&fiber->context);
1188 fiber_stack_release_locked(fiber);
1191 SIZED_FREE_N(cont->saved_vm_stack.ptr, cont->saved_vm_stack.size);
1193 VM_ASSERT(cont->jit_cont != NULL);
1194 jit_cont_free(cont->jit_cont);
1196 if (cont->type == CONTINUATION_CONTEXT) {
1202 RUBY_FREE_LEAVE(
"cont");
1206cont_memsize(
const void *ptr)
1211 size =
sizeof(*cont);
1212 if (cont->saved_vm_stack.ptr) {
1213#ifdef CAPTURE_JUST_VALID_VM_STACK
1214 size_t n = (cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1216 size_t n = cont->saved_ec.vm_stack_size;
1218 size += n *
sizeof(*cont->saved_vm_stack.ptr);
1221 if (cont->machine.stack) {
1222 size += cont->machine.stack_size *
sizeof(*cont->machine.stack);
1231 if (fiber->cont.self) {
1232 rb_gc_update_moved(&fiber->cont.self);
1235 rb_execution_context_update(&fiber->cont.saved_ec);
1242 rb_gc_mark_movable(fiber->cont.self);
1246fiber_compact(
void *ptr)
1249 rb_gc_update_moved(&fiber->first_proc);
1251 if (fiber->prev) rb_fiber_update_self(fiber->prev);
1253 cont_compact(&fiber->cont);
1254 fiber_verify(fiber);
1258fiber_mark(
void *ptr)
1261 RUBY_MARK_ENTER(
"cont");
1262 fiber_verify(fiber);
1263 rb_gc_mark_movable(fiber->first_proc);
1264 if (fiber->prev) rb_fiber_mark_self(fiber->prev);
1265 cont_mark(&fiber->cont);
1266 RUBY_MARK_LEAVE(
"cont");
1270fiber_free(
void *ptr)
1278 if (&fiber->cont.saved_ec == rb_current_execution_context(
false)) {
1279 fiber->cont.self = 0;
1282 rb_fiber_free_body(ptr);
1286rb_fiber_free_body(
void *ptr)
1289 RUBY_FREE_ENTER(
"fiber");
1291 if (DEBUG) fprintf(stderr,
"fiber_free: %p[%p]\n", (
void *)fiber, fiber->stack.base);
1293 if (fiber->cont.saved_ec.local_storage) {
1294 rb_id_table_free(fiber->cont.saved_ec.local_storage);
1297 cont_free(&fiber->cont);
1298 RUBY_FREE_LEAVE(
"fiber");
1302fiber_memsize(
const void *ptr)
1305 size_t size =
sizeof(*fiber);
1311 if (saved_ec->local_storage && fiber->first_proc != 0) {
1312 size += rb_id_table_memsize(saved_ec->local_storage);
1313 size += rb_obj_memsize_of(saved_ec->storage);
1316 size += cont_memsize(&fiber->cont);
1323 return RBOOL(rb_typeddata_is_kind_of(obj, &rb_fiber_data_type));
1329 const size_t old_stack_size = cont->machine.stack_size;
1332 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
1334 if (th->ec->machine.stack_start > th->ec->machine.stack_end) {
1335 size = cont->machine.stack_size = th->ec->machine.stack_start - th->ec->machine.stack_end;
1336 cont->machine.stack_src = th->ec->machine.stack_end;
1339 size = cont->machine.stack_size = th->ec->machine.stack_end - th->ec->machine.stack_start;
1340 cont->machine.stack_src = th->ec->machine.stack_start;
1343 if (cont->machine.stack) {
1344 SIZED_REALLOC_N(cont->machine.stack,
VALUE, cont->machine.stack_size, old_stack_size);
1347 cont->machine.stack =
ALLOC_N(
VALUE, cont->machine.stack_size);
1350 FLUSH_REGISTER_WINDOWS;
1351 asan_unpoison_memory_region(cont->machine.stack_src, size,
false);
1352 MEMCPY(cont->machine.stack, cont->machine.stack_src,
VALUE, size);
1356cont_handle_weak_references(
void *ptr)
1362 if (!rb_gc_handle_weak_references_alive_p(cont->saved_ec.gen_fields_cache.obj) ||
1363 !rb_gc_handle_weak_references_alive_p(cont->saved_ec.gen_fields_cache.fields_obj)) {
1364 cont->saved_ec.gen_fields_cache.obj =
Qundef;
1365 cont->saved_ec.gen_fields_cache.fields_obj =
Qundef;
1371 {cont_mark, cont_free, cont_memsize, cont_compact, cont_handle_weak_references},
1380 VM_ASSERT(th->status == THREAD_RUNNABLE);
1387 sec->machine.stack_end = NULL;
1390static rb_nativethread_lock_t jit_cont_lock;
1402 cont = ruby_mimcalloc(1,
sizeof(
struct rb_jit_cont));
1408 if (first_jit_cont == NULL) {
1409 cont->next = cont->prev = NULL;
1413 cont->next = first_jit_cont;
1414 first_jit_cont->prev = cont;
1416 first_jit_cont = cont;
1429 if (cont == first_jit_cont) {
1430 first_jit_cont = cont->next;
1431 if (first_jit_cont != NULL)
1432 first_jit_cont->prev = NULL;
1435 cont->prev->next = cont->next;
1436 if (cont->next != NULL)
1437 cont->next->prev = cont->prev;
1446rb_jit_cont_each_iseq(rb_iseq_callback callback,
void *data)
1449 for (cont = first_jit_cont; cont != NULL; cont = cont->next) {
1450 if (cont->ec->vm_stack == NULL)
1454 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(cont->ec, cfp)) {
1455 if (CFP_PC(cfp) && CFP_ISEQ(cfp)) {
1457 if (iseq && imemo_type((
VALUE)iseq) == imemo_iseq) {
1458 callback(iseq, data);
1461 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1470rb_yjit_cancel_jit_return(
void *leave_exit,
void *leave_exception)
1473 for (cont = first_jit_cont; cont != NULL; cont = cont->next) {
1474 if (cont->ec->vm_stack == NULL)
1478 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(cont->ec, cfp)) {
1479 if (cfp->jit_return && cfp->jit_return != leave_exception) {
1482 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1490rb_jit_cont_finish(
void)
1493 for (cont = first_jit_cont; cont != NULL; cont = next) {
1503 VM_ASSERT(cont->jit_cont == NULL);
1505 cont->jit_cont = jit_cont_new(&(cont->saved_ec));
1511 return &fiber->cont.saved_ec;
1518 cont_save_thread(cont, th);
1519 cont->saved_ec.thread_ptr = th;
1520 cont->saved_ec.local_storage = NULL;
1521 cont->saved_ec.local_storage_recursive_hash =
Qnil;
1522 cont->saved_ec.local_storage_recursive_hash_for_trace =
Qnil;
1523 cont_init_jit_cont(cont);
1527cont_new(
VALUE klass)
1530 volatile VALUE contval;
1533 THREAD_MUST_BE_RUNNING(th);
1535 rb_gc_declare_weak_references(contval);
1536 cont->self = contval;
1537 cont_init(cont, th);
1544 return fiber->cont.self;
1550 return fiber->blocking;
1555rb_jit_cont_init(
void)
1564 VALUE *p = ec->vm_stack;
1565 while (p < ec->cfp->sp) {
1566 fprintf(stderr,
"%3d ", (
int)(p - ec->vm_stack));
1567 rb_obj_info_dump(*p);
1577 while (cfp != end_of_cfp) {
1579 if (CFP_ISEQ(cfp)) {
1580 pc = cfp->pc - ISEQ_BODY(CFP_ISEQ(cfp))->iseq_encoded;
1582 fprintf(stderr,
"%2d pc: %d\n", i++, pc);
1583 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1589cont_capture(
volatile int *
volatile stat)
1593 volatile VALUE contval;
1596 THREAD_MUST_BE_RUNNING(th);
1597 rb_vm_stack_to_heap(th->ec);
1598 cont = cont_new(rb_cContinuation);
1599 contval = cont->self;
1601#ifdef CAPTURE_JUST_VALID_VM_STACK
1602 cont->saved_vm_stack.slen = ec->cfp->sp - ec->vm_stack;
1603 cont->saved_vm_stack.clen = ec->vm_stack + ec->vm_stack_size - (
VALUE*)ec->cfp;
1604 cont->saved_vm_stack.size = cont->saved_vm_stack.slen + cont->saved_vm_stack.clen;
1605 cont->saved_vm_stack.ptr =
ALLOC_N(
VALUE, cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1606 MEMCPY(cont->saved_vm_stack.ptr,
1608 VALUE, cont->saved_vm_stack.slen);
1609 MEMCPY(cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen,
1612 cont->saved_vm_stack.clen);
1614 cont->saved_vm_stack.size = ec->vm_stack_size;
1615 cont->saved_vm_stack.ptr =
ALLOC_N(
VALUE, ec->vm_stack_size);
1616 MEMCPY(cont->saved_vm_stack.ptr, ec->vm_stack,
VALUE, ec->vm_stack_size);
1619 rb_ec_set_vm_stack(&cont->saved_ec, NULL, 0);
1620 VM_ASSERT(cont->saved_ec.cfp != NULL);
1621 cont_save_machine_stack(th, cont);
1623 if (ruby_setjmp(cont->jmpbuf)) {
1626 VAR_INITIALIZED(cont);
1627 value = cont->value;
1645 if (cont->type == CONTINUATION_CONTEXT) {
1650 if (sec->fiber_ptr != NULL) {
1651 fiber = sec->fiber_ptr;
1653 else if (th->root_fiber) {
1654 fiber = th->root_fiber;
1657 if (fiber && th->ec != &fiber->cont.saved_ec) {
1658 ec_switch(th, fiber);
1661 if (th->ec->trace_arg != sec->trace_arg) {
1665#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
1666 if (th->ec->tag != sec->tag) {
1669 struct rb_vm_tag *lowest_common_ancestor = NULL;
1670 size_t num_tags = 0;
1671 size_t num_saved_tags = 0;
1672 for (
struct rb_vm_tag *tag = th->ec->tag; tag != NULL; tag = tag->prev) {
1675 for (
struct rb_vm_tag *tag = sec->tag; tag != NULL; tag = tag->prev) {
1679 size_t min_tags = num_tags <= num_saved_tags ? num_tags : num_saved_tags;
1682 while (num_tags > min_tags) {
1688 while (num_saved_tags > min_tags) {
1689 saved_tag = saved_tag->prev;
1693 while (min_tags > 0) {
1694 if (tag == saved_tag) {
1695 lowest_common_ancestor = tag;
1699 saved_tag = saved_tag->prev;
1704 for (
struct rb_vm_tag *tag = th->ec->tag; tag != lowest_common_ancestor; tag = tag->prev) {
1705 rb_vm_tag_jmpbuf_deinit(&tag->buf);
1711#ifdef CAPTURE_JUST_VALID_VM_STACK
1713 cont->saved_vm_stack.ptr,
1714 VALUE, cont->saved_vm_stack.slen);
1715 MEMCPY(th->ec->vm_stack + th->ec->vm_stack_size - cont->saved_vm_stack.clen,
1716 cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen,
1717 VALUE, cont->saved_vm_stack.clen);
1719 MEMCPY(th->ec->vm_stack, cont->saved_vm_stack.ptr,
VALUE, sec->vm_stack_size);
1723 th->ec->cfp = sec->cfp;
1724 th->ec->raised_flag = sec->raised_flag;
1725 th->ec->tag = sec->tag;
1726 th->ec->root_lep = sec->root_lep;
1727 th->ec->root_svar = sec->root_svar;
1728 th->ec->errinfo = sec->errinfo;
1730 VM_ASSERT(th->ec->vm_stack != NULL);
1746 if (!FIBER_TERMINATED_P(old_fiber)) {
1747 STACK_GROW_DIR_DETECTION;
1748 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
1749 if (STACK_DIR_UPPER(0, 1)) {
1750 old_fiber->cont.machine.stack_size = th->ec->machine.stack_start - th->ec->machine.stack_end;
1751 old_fiber->cont.machine.stack = th->ec->machine.stack_end;
1754 old_fiber->cont.machine.stack_size = th->ec->machine.stack_end - th->ec->machine.stack_start;
1755 old_fiber->cont.machine.stack = th->ec->machine.stack_start;
1760 old_fiber->cont.saved_ec.machine.stack_start = th->ec->machine.stack_start;
1761 old_fiber->cont.saved_ec.machine.stack_end = FIBER_TERMINATED_P(old_fiber) ? NULL : th->ec->machine.stack_end;
1766#if defined(COROUTINE_SANITIZE_ADDRESS)
1767 __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);
1771 struct coroutine_context * from = coroutine_transfer(&old_fiber->context, &new_fiber->context);
1773#if defined(COROUTINE_SANITIZE_ADDRESS)
1774 __sanitizer_finish_switch_fiber(old_fiber->context.fake_stack, NULL, NULL);
1782 fiber_restore_thread(th, old_fiber);
1788NOINLINE(NORETURN(
static void cont_restore_1(
rb_context_t *)));
1793 cont_restore_thread(cont);
1796#if (defined(_M_AMD64) && !defined(__MINGW64__)) || defined(_M_ARM64)
1801 _JUMP_BUFFER *bp = (
void*)&cont->jmpbuf;
1802 bp->Frame = ((_JUMP_BUFFER*)((
void*)&buf))->Frame;
1805 if (cont->machine.stack_src) {
1806 FLUSH_REGISTER_WINDOWS;
1807 MEMCPY(cont->machine.stack_src, cont->machine.stack,
1808 VALUE, cont->machine.stack_size);
1811 ruby_longjmp(cont->jmpbuf, 1);
1819 if (cont->machine.stack_src) {
1821#define STACK_PAD_SIZE 1
1823#define STACK_PAD_SIZE 1024
1825 VALUE space[STACK_PAD_SIZE];
1827#if !STACK_GROW_DIRECTION
1828 if (addr_in_prev_frame > &space[0]) {
1831#if STACK_GROW_DIRECTION <= 0
1832 volatile VALUE *
const end = cont->machine.stack_src;
1833 if (&space[0] > end) {
1842 cont_restore_0(cont, &space[0]);
1846#if !STACK_GROW_DIRECTION
1851#if STACK_GROW_DIRECTION >= 0
1852 volatile VALUE *
const end = cont->machine.stack_src + cont->machine.stack_size;
1853 if (&space[STACK_PAD_SIZE] < end) {
1858 cont_restore_0(cont, &space[STACK_PAD_SIZE-1]);
1862#if !STACK_GROW_DIRECTION
1866 cont_restore_1(cont);
1953rb_callcc(
VALUE self)
1955 volatile int called;
1956 volatile VALUE val = cont_capture(&called);
1965#ifdef RUBY_ASAN_ENABLED
1968MAYBE_UNUSED(
static void notusing_callcc(
void)) { rb_callcc(
Qnil); }
1969# define rb_callcc rb_f_notimplement
1974make_passing_arg(
int argc,
const VALUE *argv)
1990NORETURN(
static VALUE rb_cont_call(
int argc,
VALUE *argv,
VALUE contval));
2008rb_cont_call(
int argc,
VALUE *argv,
VALUE contval)
2013 if (cont_thread_value(cont) != th->self) {
2016 if (cont->saved_ec.fiber_ptr) {
2017 if (th->ec->fiber_ptr != cont->saved_ec.fiber_ptr) {
2023 cont->value = make_passing_arg(argc, argv);
2025 cont_restore_0(cont, &contval);
2117fiber_handle_weak_references(
void *ptr)
2123 if (!rb_gc_handle_weak_references_alive_p(fiber->cont.saved_ec.gen_fields_cache.obj) ||
2124 !rb_gc_handle_weak_references_alive_p(fiber->cont.saved_ec.gen_fields_cache.fields_obj)) {
2125 fiber->cont.saved_ec.gen_fields_cache.obj =
Qundef;
2126 fiber->cont.saved_ec.gen_fields_cache.fields_obj =
Qundef;
2132 {fiber_mark, fiber_free, fiber_memsize, fiber_compact, fiber_handle_weak_references},
2139fiber_alloc(
VALUE klass)
2141 return fiber_alloc_in(klass, GET_RACTOR()->
objspace);
2147 VALUE obj = rb_data_typed_object_wrap_in_objspace(
objspace, klass, 0, &rb_fiber_data_type);
2148 rb_gc_declare_weak_references(obj);
2155 return cr->next_ec_serial++;
2159fiber_t_alloc(
VALUE fiber_value,
unsigned int blocking)
2168 THREAD_MUST_BE_RUNNING(th);
2170 fiber->cont.self = fiber_value;
2171 fiber->cont.type = FIBER_CONTEXT;
2172 fiber->blocking = blocking;
2174 cont_init(&fiber->cont, th);
2176 fiber->cont.saved_ec.fiber_ptr = fiber;
2177 fiber->cont.saved_ec.serial = next_ec_serial(th->ractor);
2178 rb_ec_clear_vm_stack(&fiber->cont.saved_ec);
2184 VM_ASSERT(FIBER_CREATED_P(fiber));
2197 return ec->fiber_ptr;
2201current_fiber_storage(
void)
2208inherit_fiber_storage(
void)
2216 fiber->cont.saved_ec.storage = storage;
2220fiber_storage_get(
rb_fiber_t *fiber,
int allocate)
2222 VALUE storage = fiber->cont.saved_ec.storage;
2223 if (storage ==
Qnil && allocate) {
2224 storage = rb_hash_new();
2225 fiber_storage_set(fiber, storage);
2231storage_access_must_be_from_same_fiber(
VALUE self)
2235 if (fiber != current) {
2236 rb_raise(rb_eArgError,
"Fiber storage can only be accessed from the Fiber it belongs to");
2247rb_fiber_storage_get(
VALUE self)
2249 storage_access_must_be_from_same_fiber(self);
2251 VALUE storage = fiber_storage_get(fiber_ptr(self), FALSE);
2253 if (storage ==
Qnil) {
2270fiber_storage_validate(
VALUE value)
2273 if (value ==
Qnil)
return;
2313 "Fiber#storage= is experimental and may be removed in the future!");
2316 storage_access_must_be_from_same_fiber(self);
2317 fiber_storage_validate(value);
2319 fiber_ptr(self)->cont.saved_ec.storage =
rb_obj_dup(value);
2338 VALUE storage = fiber_storage_get(fiber_current(), FALSE);
2341 return rb_hash_aref(storage, key);
2360 VALUE storage = fiber_storage_get(fiber_current(), value !=
Qnil);
2363 if (value ==
Qnil) {
2364 return rb_hash_delete(storage, key);
2367 return rb_hash_aset(storage, key, value);
2376 storage = inherit_fiber_storage();
2379 fiber_storage_validate(storage);
2383 rb_fiber_t *fiber = fiber_t_alloc(self, blocking);
2385 fiber->cont.saved_ec.storage = storage;
2386 fiber->first_proc = proc;
2387 fiber->stack.base = NULL;
2399 size_t vm_stack_size = 0;
2400 VALUE *vm_stack = fiber_initialize_coroutine(fiber, &vm_stack_size);
2403 cont->saved_vm_stack.ptr = NULL;
2404 rb_ec_initialize_vm_stack(sec, vm_stack, vm_stack_size /
sizeof(
VALUE));
2407 sec->local_storage = NULL;
2408 sec->local_storage_recursive_hash =
Qnil;
2409 sec->local_storage_recursive_hash_for_trace =
Qnil;
2413rb_fiber_pool_default(
VALUE pool)
2415 return &shared_fiber_pool;
2421 fiber->cont.saved_ec.storage = storage;
2427rb_fiber_initialize_kw(
int argc,
VALUE* argv,
VALUE self,
int kw_splat)
2438 rb_get_kwargs(options, fiber_initialize_keywords, 0, 3, arguments);
2440 if (!UNDEF_P(arguments[0])) {
2441 blocking = arguments[0];
2444 if (!UNDEF_P(arguments[1])) {
2445 pool = arguments[1];
2448 storage = arguments[2];
2451 return fiber_initialize(self,
rb_block_proc(), rb_fiber_pool_default(pool),
RTEST(blocking), storage);
2504rb_fiber_initialize(
int argc,
VALUE* argv,
VALUE self)
2512 return fiber_initialize(fiber_alloc(rb_cFiber),
rb_proc_new(func, obj), rb_fiber_pool_default(
Qnil), 0, storage);
2518 return rb_fiber_new_storage(func, obj,
Qtrue);
2522rb_fiber_s_schedule_kw(
int argc,
VALUE* argv,
int kw_splat)
2525 VALUE scheduler = th->scheduler;
2528 if (scheduler !=
Qnil) {
2580rb_fiber_s_schedule(
int argc,
VALUE *argv,
VALUE obj)
2596rb_fiber_s_scheduler(
VALUE klass)
2610rb_fiber_current_scheduler(
VALUE klass)
2632rb_fiber_set_scheduler(
VALUE klass,
VALUE scheduler)
2637NORETURN(
static void rb_fiber_terminate(
rb_fiber_t *fiber,
int need_interrupt,
VALUE err));
2643 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2645 enum ruby_tag_type state;
2647 VM_ASSERT(th->ec == GET_EC());
2648 VM_ASSERT(FIBER_RESUMED_P(fiber));
2650 if (fiber->blocking) {
2654 EC_PUSH_TAG(th->ec);
2655 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2659 const VALUE *argv, args = cont->value;
2660 GetProcPtr(fiber->first_proc, proc);
2663 th->ec->errinfo =
Qnil;
2664 th->ec->root_lep = rb_vm_proc_local_ep(fiber->first_proc);
2665 th->ec->root_svar =
Qfalse;
2668 const rb_cref_t *cref = rb_proc_refinements_cref_for_call(fiber->first_proc);
2669 cont->value = rb_vm_invoke_proc(th->ec, proc, argc, argv, cont->kw_splat, VM_BLOCK_HANDLER_NONE, cref);
2673 int need_interrupt = TRUE;
2676 err = th->ec->errinfo;
2677 VM_ASSERT(FIBER_RESUMED_P(fiber));
2679 if (state == TAG_RAISE) {
2682 else if (state == TAG_FATAL && err == RUBY_FATAL_FIBER_KILLED) {
2683 need_interrupt = FALSE;
2686 else if (state == TAG_FATAL) {
2687 rb_threadptr_pending_interrupt_enque(th, err);
2690 err = rb_vm_make_jump_tag_but_local_jump(state, err);
2694 rb_fiber_terminate(fiber, need_interrupt, err);
2703 rb_bug(
"%s", strerror(
errno));
2706 fiber->cont.type = FIBER_CONTEXT;
2707 fiber->cont.saved_ec.fiber_ptr = fiber;
2708 fiber->cont.saved_ec.serial = next_ec_serial(th->ractor);
2709 fiber->cont.saved_ec.thread_ptr = th;
2710 fiber->blocking = 1;
2712 fiber_status_set(fiber, FIBER_RESUMED);
2714 coroutine_initialize_main(&fiber->context);
2716 th->ec = &fiber->cont.saved_ec;
2718 cont_init_jit_cont(&fiber->cont);
2727 fiber->cont.self = fiber_value;
2733 if (th->root_fiber) {
2739 VM_ASSERT(th->ec->fiber_ptr->cont.type == FIBER_CONTEXT);
2740 VM_ASSERT(th->ec->fiber_ptr->cont.self == 0);
2742 if (ec && th->ec == ec) {
2743 rb_ractor_set_current_ec(th->ractor, NULL);
2745 fiber_free(th->ec->fiber_ptr);
2755 fiber->status = FIBER_TERMINATED;
2758 rb_ec_clear_vm_stack(th->ec);
2762return_fiber(
bool terminate)
2769 prev->resuming_fiber = NULL;
2774 rb_raise(rb_eFiberError,
"attempt to yield on a not resumed fiber");
2780 VM_ASSERT(root_fiber != NULL);
2783 for (fiber = root_fiber; fiber->resuming_fiber; fiber = fiber->resuming_fiber) {
2791rb_fiber_current(
void)
2793 return fiber_current()->cont.self;
2802 if (FIBER_CREATED_P(next_fiber)) {
2803 fiber_prepare_stack(next_fiber);
2806 VM_ASSERT(FIBER_RESUMED_P(fiber) || FIBER_TERMINATED_P(fiber));
2807 VM_ASSERT(FIBER_RUNNABLE_P(next_fiber));
2809 if (FIBER_RESUMED_P(fiber)) fiber_status_set(fiber, FIBER_SUSPENDED);
2811 fiber_status_set(next_fiber, FIBER_RESUMED);
2812 fiber_setcontext(next_fiber, fiber);
2818 VM_ASSERT(fiber == fiber_current());
2820 if (fiber->killed) {
2821 rb_thread_t *thread = fiber->cont.saved_ec.thread_ptr;
2823 thread->ec->errinfo = RUBY_FATAL_FIBER_KILLED;
2824 EC_JUMP_TAG(thread->ec, RUBY_TAG_FATAL);
2836 if (th->root_fiber == NULL) {
2837 th->root_fiber = th->ec->fiber_ptr;
2840 if (th->ec->fiber_ptr == fiber) {
2844 return make_passing_arg(argc, argv);
2847 if (cont_thread_value(cont) != th->self) {
2848 rb_raise(rb_eFiberError,
"fiber called across threads");
2851 if (FIBER_TERMINATED_P(fiber)) {
2852 value =
rb_exc_new2(rb_eFiberError,
"dead fiber called");
2854 if (!FIBER_TERMINATED_P(th->ec->fiber_ptr)) {
2856 VM_UNREACHABLE(fiber_switch);
2862 VM_ASSERT(FIBER_SUSPENDED_P(th->root_fiber));
2864 cont = &th->root_fiber->cont;
2866 cont->value = value;
2868 fiber_setcontext(th->root_fiber, th->ec->fiber_ptr);
2870 VM_UNREACHABLE(fiber_switch);
2874 VM_ASSERT(FIBER_RUNNABLE_P(fiber));
2881 VALUE fiber_value = fiber->cont.self;
2885 VM_ASSERT(!current_fiber->resuming_fiber);
2887 if (resuming_fiber) {
2888 current_fiber->resuming_fiber = resuming_fiber;
2889 fiber->prev = fiber_current();
2890 fiber->yielding = 0;
2893 VM_ASSERT(!current_fiber->yielding);
2895 current_fiber->yielding = 1;
2898 if (current_fiber->blocking) {
2903 cont->kw_splat = kw_splat;
2904 cont->value = make_passing_arg(argc, argv);
2906 fiber_store(fiber, th);
2909#ifndef COROUTINE_PTHREAD_CONTEXT
2910 if (FIBER_TERMINATED_P(fiber)) {
2912 fiber_stack_release(fiber);
2918 if (fiber_current()->blocking) {
2922 RUBY_VM_CHECK_INTS(th->ec);
2926 current_fiber = th->ec->fiber_ptr;
2927 value = current_fiber->cont.value;
2929 fiber_check_killed(current_fiber);
2931 if (current_fiber->cont.argc == -1) {
2942 return fiber_switch(fiber_ptr(fiber_value), argc, argv,
RB_NO_KEYWORDS, NULL,
false);
2960rb_fiber_blocking_p(
VALUE fiber)
2962 return RBOOL(fiber_ptr(fiber)->blocking);
2966fiber_blocking_yield(
VALUE fiber_value)
2969 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2971 VM_ASSERT(fiber->blocking == 0);
2974 fiber->blocking = 1;
2983fiber_blocking_ensure(
VALUE fiber_value)
2986 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2989 fiber->blocking = 0;
3006rb_fiber_blocking(
VALUE class)
3008 VALUE fiber_value = rb_fiber_current();
3012 if (fiber->blocking) {
3016 return rb_ensure(fiber_blocking_yield, fiber_value, fiber_blocking_ensure, fiber_value);
3039rb_fiber_s_blocking_p(
VALUE klass)
3042 unsigned blocking = thread->blocking;
3053 fiber_status_set(fiber, FIBER_TERMINATED);
3054 rb_ec_close(&fiber->cont.saved_ec);
3060 VALUE value = fiber->cont.value;
3062 VM_ASSERT(FIBER_RESUMED_P(fiber));
3063 rb_fiber_close(fiber);
3065 fiber->cont.machine.stack = NULL;
3066 fiber->cont.machine.stack_size = 0;
3070 if (need_interrupt) RUBY_VM_SET_INTERRUPT(&next_fiber->cont.saved_ec);
3073 fiber_switch(next_fiber, -1, &error,
RB_NO_KEYWORDS, NULL,
false);
3075 fiber_switch(next_fiber, 1, &value,
RB_NO_KEYWORDS, NULL,
false);
3080fiber_resume_kw(
rb_fiber_t *fiber,
int argc,
const VALUE *argv,
int kw_splat)
3084 if (argc == -1 && FIBER_CREATED_P(fiber)) {
3085 rb_raise(rb_eFiberError,
"cannot raise exception on unborn fiber");
3087 else if (FIBER_TERMINATED_P(fiber)) {
3088 rb_raise(rb_eFiberError,
"attempt to resume a terminated fiber");
3090 else if (fiber == current_fiber) {
3091 rb_raise(rb_eFiberError,
"attempt to resume the current fiber");
3093 else if (fiber->prev != NULL) {
3094 rb_raise(rb_eFiberError,
"attempt to resume a resumed fiber (double resume)");
3096 else if (fiber->resuming_fiber) {
3097 rb_raise(rb_eFiberError,
"attempt to resume a resuming fiber");
3099 else if (fiber->prev == NULL &&
3100 (!fiber->yielding && fiber->status != FIBER_CREATED)) {
3101 rb_raise(rb_eFiberError,
"attempt to resume a transferring fiber");
3104 return fiber_switch(fiber, argc, argv, kw_splat, fiber,
false);
3108rb_fiber_resume_kw(
VALUE self,
int argc,
const VALUE *argv,
int kw_splat)
3110 return fiber_resume_kw(fiber_ptr(self), argc, argv, kw_splat);
3116 return fiber_resume_kw(fiber_ptr(self), argc, argv,
RB_NO_KEYWORDS);
3120rb_fiber_yield_kw(
int argc,
const VALUE *argv,
int kw_splat)
3122 return fiber_switch(return_fiber(
false), argc, argv, kw_splat, NULL,
true);
3126rb_fiber_yield(
int argc,
const VALUE *argv)
3128 return fiber_switch(return_fiber(
false), argc, argv,
RB_NO_KEYWORDS, NULL,
true);
3134 if (th->root_fiber && th->root_fiber != th->ec->fiber_ptr) {
3135 th->ec->local_storage = th->root_fiber->cont.saved_ec.local_storage;
3150 return RBOOL(!FIBER_TERMINATED_P(fiber_ptr(fiber_value)));
3169rb_fiber_m_resume(
int argc,
VALUE *argv,
VALUE fiber)
3221rb_fiber_backtrace(
int argc,
VALUE *argv,
VALUE fiber)
3223 return rb_vm_backtrace(argc, argv, &fiber_ptr(fiber)->cont.saved_ec);
3246rb_fiber_backtrace_locations(
int argc,
VALUE *argv,
VALUE fiber)
3248 return rb_vm_backtrace_locations(argc, argv, &fiber_ptr(fiber)->cont.saved_ec);
3334rb_fiber_m_transfer(
int argc,
VALUE *argv,
VALUE self)
3340fiber_transfer_kw(
rb_fiber_t *fiber,
int argc,
const VALUE *argv,
int kw_splat)
3342 if (fiber->resuming_fiber) {
3343 rb_raise(rb_eFiberError,
"attempt to transfer to a resuming fiber");
3346 if (fiber->yielding) {
3347 rb_raise(rb_eFiberError,
"attempt to transfer to a yielding fiber");
3350 return fiber_switch(fiber, argc, argv, kw_splat, NULL,
false);
3354rb_fiber_transfer_kw(
VALUE self,
int argc,
const VALUE *argv,
int kw_splat)
3356 return fiber_transfer_kw(fiber_ptr(self), argc, argv, kw_splat);
3370rb_fiber_s_yield(
int argc,
VALUE *argv,
VALUE klass)
3378 if (fiber == fiber_current()) {
3381 else if (fiber->resuming_fiber) {
3382 return fiber_raise(fiber->resuming_fiber, exception);
3384 else if (FIBER_SUSPENDED_P(fiber) && !fiber->yielding) {
3395 VALUE exception = rb_exception_setup(argc, argv);
3397 return fiber_raise(fiber_ptr(fiber), exception);
3435rb_fiber_m_raise(
int argc,
VALUE *argv,
VALUE self)
3437 return rb_fiber_raise(self, argc, argv);
3458rb_fiber_m_kill(
VALUE self)
3462 if (fiber->killed)
return Qfalse;
3465 if (fiber->status == FIBER_CREATED) {
3466 fiber->status = FIBER_TERMINATED;
3468 else if (fiber->status != FIBER_TERMINATED) {
3469 if (fiber_current() == fiber) {
3470 fiber_check_killed(fiber);
3473 fiber_raise(fiber_ptr(self),
Qnil);
3488rb_fiber_s_current(
VALUE klass)
3490 return rb_fiber_current();
3494fiber_to_s(
VALUE fiber_value)
3496 const rb_fiber_t *fiber = fiber_ptr(fiber_value);
3498 char status_info[0x20];
3500 if (fiber->resuming_fiber) {
3501 snprintf(status_info, 0x20,
" (%s by resuming)", fiber_status_name(fiber->status));
3504 snprintf(status_info, 0x20,
" (%s)", fiber_status_name(fiber->status));
3509 strlcat(status_info,
">",
sizeof(status_info));
3514 GetProcPtr(fiber->first_proc, proc);
3515 return rb_block_to_s(fiber_value, &proc->block, status_info);
3518#ifdef HAVE_WORKING_FORK
3522 if (th->root_fiber) {
3523 if (&th->root_fiber->cont.saved_ec != th->ec) {
3524 th->root_fiber = th->ec->fiber_ptr;
3526 th->root_fiber->prev = 0;
3527 th->root_fiber->blocking = 1;
3533#ifdef RB_EXPERIMENTAL_FIBER_POOL
3535fiber_pool_free(
void *ptr)
3538 RUBY_FREE_ENTER(
"fiber_pool");
3540 fiber_pool_allocation_free(
fiber_pool->allocations);
3543 RUBY_FREE_LEAVE(
"fiber_pool");
3547fiber_pool_memsize(
const void *ptr)
3550 size_t size =
sizeof(*fiber_pool);
3559 {NULL, fiber_pool_free, fiber_pool_memsize,},
3564fiber_pool_alloc(
VALUE klass)
3572rb_fiber_pool_initialize(
int argc,
VALUE* argv,
VALUE self)
3579 rb_scan_args(argc, argv,
"03", &size, &count, &vm_stack_size);
3582 size =
SIZET2NUM(th->vm->default_params.fiber_machine_stack_size);
3589 if (
NIL_P(vm_stack_size)) {
3590 vm_stack_size =
SIZET2NUM(th->vm->default_params.fiber_vm_stack_size);
3615shared_fiber_pool_minimum_count(
void)
3617 size_t minimum_count = FIBER_POOL_MINIMUM_COUNT;
3619 const char *minimum_count_env = getenv(
"RUBY_SHARED_FIBER_POOL_MINIMUM_COUNT");
3620 if (minimum_count_env && minimum_count_env[0]) {
3622 unsigned long value = strtoul(minimum_count_env, &end, 10);
3623 if (end != minimum_count_env && *end ==
'\0') {
3624 minimum_count = (size_t)value;
3627 rb_warn(
"invalid RUBY_SHARED_FIBER_POOL_MINIMUM_COUNT=%s (expected a non-negative integer)", minimum_count_env);
3631 return minimum_count;
3635shared_fiber_pool_maximum_count(
void)
3637 size_t maximum_count = 0;
3639 const char *maximum_count_env = getenv(
"RUBY_SHARED_FIBER_POOL_MAXIMUM_COUNT");
3640 if (maximum_count_env && maximum_count_env[0]) {
3642 unsigned long value = strtoul(maximum_count_env, &end, 10);
3643 if (end != maximum_count_env && *end ==
'\0') {
3644 maximum_count = (size_t)value;
3647 rb_warn(
"invalid RUBY_SHARED_FIBER_POOL_MAXIMUM_COUNT=%s (expected a non-negative integer)", maximum_count_env);
3651 return maximum_count;
3658 size_t vm_stack_size = th->vm->default_params.fiber_vm_stack_size;
3659 size_t machine_stack_size = th->vm->default_params.fiber_machine_stack_size;
3660 size_t stack_size = machine_stack_size + vm_stack_size;
3664 GetSystemInfo(&info);
3665 pagesize = info.dwPageSize;
3667 pagesize = sysconf(_SC_PAGESIZE);
3669 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
3673 size_t minimum_count = shared_fiber_pool_minimum_count();
3674 size_t maximum_count = shared_fiber_pool_maximum_count();
3675 fiber_pool_initialize(&shared_fiber_pool, stack_size, minimum_count, maximum_count, vm_stack_size);
3681 const char *fiber_shared_fiber_pool_free_stacks = getenv(
"RUBY_SHARED_FIBER_POOL_FREE_STACKS");
3682 if (fiber_shared_fiber_pool_free_stacks) {
3683 shared_fiber_pool.free_stacks = atoi(fiber_shared_fiber_pool_free_stacks);
3685 if (shared_fiber_pool.free_stacks < 0) {
3686 rb_warn(
"Setting RUBY_SHARED_FIBER_POOL_FREE_STACKS to a negative value is not allowed.");
3687 shared_fiber_pool.free_stacks = 0;
3690 if (shared_fiber_pool.free_stacks > 1) {
3691 rb_warn(
"Setting RUBY_SHARED_FIBER_POOL_FREE_STACKS to a value greater than 1 is operating system specific, and may cause crashes.");
3695 rb_cFiber = rb_define_class(
"Fiber",
rb_cObject);
3711 rb_define_method(rb_cFiber,
"backtrace_locations", rb_fiber_backtrace_locations, -1);
3724 rb_thread_t *current_thread = rb_current_thread();
3726 *(
VALUE *)&((
struct RBasic *)current_thread->ec->fiber_ptr->cont.self)->klass = rb_cFiber;
3728#ifdef RB_EXPERIMENTAL_FIBER_POOL
3733 rb_cFiberPool = rb_define_class_under(rb_cFiber,
"Pool",
rb_cObject);
3735 rb_define_method(rb_cFiberPool,
"initialize", rb_fiber_pool_initialize, -1);
3741RUBY_SYMBOL_EXPORT_BEGIN
3744ruby_Init_Continuation_body(
void)
3746 rb_cContinuation = rb_define_class(
"Continuation",
rb_cObject);
3751#ifdef COROUTINE_SHADOW_STACK
3752 if (coroutine_shadow_stack_enabled()) {
3761RUBY_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.
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 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_cObject
Object class.
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.
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.
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.
VALUE rb_f_notimplement(int argc, const VALUE *argv, VALUE obj, VALUE marker)
Raises rb_eNotImpError.
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.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
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 RUBY_TYPED_FREE_IMMEDIATELY
Macros to see if each corresponding flag is defined.
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
#define DATA_PTR(obj)
Convenient casting macro for backward compatibility.
#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.
#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.