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))
52static VALUE rb_cContinuation;
53static VALUE rb_cFiber;
54static VALUE rb_eFiberError;
55#ifdef RB_EXPERIMENTAL_FIBER_POOL
56static VALUE rb_cFiberPool;
59#define CAPTURE_JUST_VALID_VM_STACK 1
62#ifdef COROUTINE_LIMITED_ADDRESS_SPACE
63#define FIBER_POOL_ALLOCATION_FREE
64#define FIBER_POOL_INITIAL_SIZE 8
65#define FIBER_POOL_ALLOCATION_MAXIMUM_SIZE 32
67#define FIBER_POOL_INITIAL_SIZE 32
68#define FIBER_POOL_ALLOCATION_MAXIMUM_SIZE 1024
70#ifdef RB_EXPERIMENTAL_FIBER_POOL
71#define FIBER_POOL_ALLOCATION_FREE
75 CONTINUATION_CONTEXT = 0,
81#ifdef CAPTURE_JUST_VALID_VM_STACK
118#ifdef FIBER_POOL_ALLOCATION_FREE
161#ifdef FIBER_POOL_ALLOCATION_FREE
169#ifdef FIBER_POOL_ALLOCATION_FREE
190 size_t initial_count;
201 size_t vm_stack_size;
214 enum context_type type;
252#define FIBER_CREATED_P(fiber) ((fiber)->status == FIBER_CREATED)
253#define FIBER_RESUMED_P(fiber) ((fiber)->status == FIBER_RESUMED)
254#define FIBER_SUSPENDED_P(fiber) ((fiber)->status == FIBER_SUSPENDED)
255#define FIBER_TERMINATED_P(fiber) ((fiber)->status == FIBER_TERMINATED)
256#define FIBER_RUNNABLE_P(fiber) (FIBER_CREATED_P(fiber) || FIBER_SUSPENDED_P(fiber))
264 BITFIELD(
enum fiber_status, status, 2);
266 unsigned int yielding : 1;
267 unsigned int blocking : 1;
269 unsigned int killed : 1;
275static struct fiber_pool shared_fiber_pool = {NULL, NULL, 0, 0, 0, 0};
278rb_free_shared_fiber_pool(
void)
281 while (allocations) {
288static ID fiber_initialize_keywords[3] = {0};
295#if defined(MAP_STACK) && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
296#define FIBER_STACK_FLAGS (MAP_PRIVATE | MAP_ANON | MAP_STACK)
298#define FIBER_STACK_FLAGS (MAP_PRIVATE | MAP_ANON)
301#define ERRNOMSG strerror(errno)
305fiber_pool_vacancy_pointer(
void * base,
size_t size)
307 STACK_GROW_DIR_DETECTION;
310 (
char*)base + STACK_DIR_UPPER(0, size - RB_PAGE_SIZE)
314#if defined(COROUTINE_SANITIZE_ADDRESS)
319 STACK_GROW_DIR_DETECTION;
321 return (
char*)stack->base + STACK_DIR_UPPER(RB_PAGE_SIZE, 0);
328 return stack->size - RB_PAGE_SIZE;
336 STACK_GROW_DIR_DETECTION;
338 stack->current = (
char*)stack->base + STACK_DIR_UPPER(0, stack->size);
339 stack->available = stack->size;
346 STACK_GROW_DIR_DETECTION;
348 VM_ASSERT(stack->current);
350 return STACK_DIR_UPPER(stack->current, (
char*)stack->current - stack->available);
358 STACK_GROW_DIR_DETECTION;
360 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_alloca(%p): %"PRIuSIZE
"/%"PRIuSIZE
"\n", (
void*)stack, offset, stack->available);
361 VM_ASSERT(stack->available >= offset);
364 void * pointer = STACK_DIR_UPPER(stack->current, (
char*)stack->current - offset);
367 stack->current = STACK_DIR_UPPER((
char*)stack->current + offset, (
char*)stack->current - offset);
368 stack->available -= offset;
377 fiber_pool_stack_reset(&vacancy->stack);
380 fiber_pool_stack_alloca(&vacancy->stack, RB_PAGE_SIZE);
386 vacancy->next = head;
388#ifdef FIBER_POOL_ALLOCATION_FREE
390 head->previous = vacancy;
391 vacancy->previous = NULL;
398#ifdef FIBER_POOL_ALLOCATION_FREE
403 vacancy->next->previous = vacancy->previous;
406 if (vacancy->previous) {
407 vacancy->previous->next = vacancy->next;
411 vacancy->stack.pool->vacancies = vacancy->next;
416fiber_pool_vacancy_pop(
struct fiber_pool * pool)
421 fiber_pool_vacancy_remove(vacancy);
428fiber_pool_vacancy_pop(
struct fiber_pool * pool)
433 pool->vacancies = vacancy->next;
448 vacancy->stack.base = base;
449 vacancy->stack.size = size;
451 fiber_pool_vacancy_reset(vacancy);
455 return fiber_pool_vacancy_push(vacancy, vacancies);
463fiber_pool_allocate_memory(
size_t * count,
size_t stride)
473 void * base = VirtualAlloc(0, (*count)*stride, MEM_COMMIT, PAGE_READWRITE);
476 *count = (*count) >> 1;
483 size_t mmap_size = (*count)*stride;
484 void * base = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE, FIBER_STACK_FLAGS, -1, 0);
486 if (base == MAP_FAILED) {
488 *count = (*count) >> 1;
491 ruby_annotate_mmap(base, mmap_size,
"Ruby:fiber_pool_allocate_memory");
492#if defined(MADV_FREE_REUSE)
496 while (madvise(base, mmap_size, MADV_FREE_REUSE) == -1 &&
errno == EAGAIN);
516 STACK_GROW_DIR_DETECTION;
519 size_t stride = size + RB_PAGE_SIZE;
522 void * base = fiber_pool_allocate_memory(&count, stride);
525 rb_raise(rb_eFiberError,
"can't alloc machine stack to fiber (%"PRIuSIZE
" x %"PRIuSIZE
" bytes): %s", count, size, ERRNOMSG);
532 allocation->base = base;
533 allocation->size = size;
534 allocation->stride = stride;
535 allocation->count = count;
536#ifdef FIBER_POOL_ALLOCATION_FREE
537 allocation->used = 0;
542 fprintf(stderr,
"fiber_pool_expand(%"PRIuSIZE
"): %p, %"PRIuSIZE
"/%"PRIuSIZE
" x [%"PRIuSIZE
":%"PRIuSIZE
"]\n",
547 for (
size_t i = 0; i < count; i += 1) {
548 void * base = (
char*)allocation->base + (stride * i);
549 void * page = (
char*)base + STACK_DIR_UPPER(size, 0);
553 if (!VirtualProtect(page, RB_PAGE_SIZE, PAGE_READWRITE | PAGE_GUARD, &old_protect)) {
554 VirtualFree(allocation->base, 0, MEM_RELEASE);
555 rb_raise(rb_eFiberError,
"can't set a guard page: %s", ERRNOMSG);
557#elif defined(__wasi__)
561 if (mprotect(page, RB_PAGE_SIZE, PROT_NONE) < 0) {
562 munmap(allocation->base, count*stride);
563 rb_raise(rb_eFiberError,
"can't set a guard page: %s", ERRNOMSG);
567 vacancies = fiber_pool_vacancy_initialize(
569 (
char*)base + STACK_DIR_UPPER(0, RB_PAGE_SIZE),
573#ifdef FIBER_POOL_ALLOCATION_FREE
574 vacancies->stack.allocation = allocation;
581#ifdef FIBER_POOL_ALLOCATION_FREE
582 if (allocation->next) {
583 allocation->next->previous = allocation;
586 allocation->previous = NULL;
601fiber_pool_initialize(
struct fiber_pool *
fiber_pool,
size_t size,
size_t count,
size_t vm_stack_size)
603 VM_ASSERT(vm_stack_size < size);
607 fiber_pool->size = ((size / RB_PAGE_SIZE) + 1) * RB_PAGE_SIZE;
618#ifdef FIBER_POOL_ALLOCATION_FREE
623 STACK_GROW_DIR_DETECTION;
625 VM_ASSERT(allocation->used == 0);
627 if (DEBUG) fprintf(stderr,
"fiber_pool_allocation_free: %p base=%p count=%"PRIuSIZE
"\n", (
void*)allocation, allocation->base, allocation->count);
630 for (i = 0; i < allocation->count; i += 1) {
631 void * base = (
char*)allocation->base + (allocation->stride * i) + STACK_DIR_UPPER(0, RB_PAGE_SIZE);
633 struct fiber_pool_vacancy * vacancy = fiber_pool_vacancy_pointer(base, allocation->size);
636 fiber_pool_vacancy_remove(vacancy);
640 VirtualFree(allocation->base, 0, MEM_RELEASE);
642 munmap(allocation->base, allocation->stride * allocation->count);
645 if (allocation->previous) {
646 allocation->previous->next = allocation->next;
650 allocation->pool->allocations = allocation->next;
653 if (allocation->next) {
654 allocation->next->previous = allocation->previous;
657 allocation->pool->count -= allocation->count;
659 ruby_xfree(allocation);
672 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_acquire: %p used=%"PRIuSIZE
"\n", (
void*)
fiber_pool->vacancies,
fiber_pool->used);
675 const size_t maximum = FIBER_POOL_ALLOCATION_MAXIMUM_SIZE;
676 const size_t minimum =
fiber_pool->initial_count;
679 if (count > maximum) count = maximum;
680 if (count < minimum) count = minimum;
691 VM_ASSERT(vacancy->stack.base);
693#if defined(COROUTINE_SANITIZE_ADDRESS)
694 __asan_unpoison_memory_region(fiber_pool_stack_poison_base(&vacancy->stack), fiber_pool_stack_poison_size(&vacancy->stack));
700#ifdef FIBER_POOL_ALLOCATION_FREE
701 vacancy->stack.allocation->used += 1;
704 fiber_pool_stack_reset(&vacancy->stack);
708 return vacancy->stack;
716 void * base = fiber_pool_stack_base(stack);
717 size_t size = stack->available;
720 VM_ASSERT(size <= (stack->size - RB_PAGE_SIZE));
722 int advice = stack->pool->free_stacks >> 1;
724 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_free: %p+%"PRIuSIZE
" [base=%p, size=%"PRIuSIZE
"] advice=%d\n", base, size, stack->base, stack->size, advice);
737#elif VM_CHECK_MODE > 0 && defined(MADV_DONTNEED)
738 if (!advice) advice = MADV_DONTNEED;
740 madvise(base, size, advice);
741#elif defined(MADV_FREE_REUSABLE)
742 if (!advice) advice = MADV_FREE_REUSABLE;
748 while (madvise(base, size, advice) == -1 &&
errno == EAGAIN);
749#elif defined(MADV_FREE)
750 if (!advice) advice = MADV_FREE;
752 madvise(base, size, advice);
753#elif defined(MADV_DONTNEED)
754 if (!advice) advice = MADV_DONTNEED;
756 madvise(base, size, advice);
757#elif defined(POSIX_MADV_DONTNEED)
758 if (!advice) advice = POSIX_MADV_DONTNEED;
760 posix_madvise(base, size, advice);
762 VirtualAlloc(base, size, MEM_RESET, PAGE_READWRITE);
767#if defined(COROUTINE_SANITIZE_ADDRESS)
768 __asan_poison_memory_region(fiber_pool_stack_poison_base(stack), fiber_pool_stack_poison_size(stack));
779 struct fiber_pool_vacancy * vacancy = fiber_pool_vacancy_pointer(stack->base, stack->size);
781 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_release: %p used=%"PRIuSIZE
"\n", stack->base, stack->pool->used);
784 vacancy->stack = *stack;
788 fiber_pool_vacancy_reset(vacancy);
791 pool->vacancies = fiber_pool_vacancy_push(vacancy, pool->vacancies);
794#ifdef FIBER_POOL_ALLOCATION_FREE
797 allocation->used -= 1;
800 if (allocation->used == 0) {
801 fiber_pool_allocation_free(allocation);
803 else if (stack->pool->free_stacks) {
804 fiber_pool_stack_free(&vacancy->stack);
809 if (stack->pool->free_stacks) {
810 fiber_pool_stack_free(&vacancy->stack);
821#ifdef RUBY_ASAN_ENABLED
822 ec->machine.asan_fake_stack_handle = asan_get_thread_fake_stack_handle();
824 rb_ractor_set_current_ec(th->ractor, th->ec = ec);
831 if (th->vm->ractor.main_thread == th &&
832 rb_signal_buff_size() > 0) {
833 RUBY_VM_SET_TRAP_INTERRUPT(ec);
836 VM_ASSERT(ec->fiber_ptr->cont.self == 0 || ec->vm_stack != NULL);
842 ec_switch(th, fiber);
843 VM_ASSERT(th->ec->fiber_ptr == fiber);
846#ifndef COROUTINE_DECL
847# define COROUTINE_DECL COROUTINE
855#if defined(COROUTINE_SANITIZE_ADDRESS)
865 __sanitizer_finish_switch_fiber(to->fake_stack, (
const void**)&from->stack_base, &from->stack_size);
868 rb_thread_t *thread = fiber->cont.saved_ec.thread_ptr;
870#ifdef COROUTINE_PTHREAD_CONTEXT
871 ruby_thread_set_native(thread);
874 fiber_restore_thread(thread, fiber);
876 rb_fiber_start(fiber);
878#ifndef COROUTINE_PTHREAD_CONTEXT
879 VM_UNREACHABLE(fiber_entry);
885fiber_initialize_coroutine(
rb_fiber_t *fiber,
size_t * vm_stack_size)
889 void * vm_stack = NULL;
893 fiber->stack = fiber_pool_stack_acquire(
fiber_pool);
894 vm_stack = fiber_pool_stack_alloca(&fiber->stack,
fiber_pool->vm_stack_size);
897 coroutine_initialize(&fiber->context, fiber_entry, fiber_pool_stack_base(&fiber->stack), fiber->stack.available);
900 sec->machine.stack_start = fiber->stack.current;
901 sec->machine.stack_maxsize = fiber->stack.available;
903 fiber->context.argument = (
void*)fiber;
915 if (DEBUG) fprintf(stderr,
"fiber_stack_release: %p, stack.base=%p\n", (
void*)fiber, fiber->stack.base);
918 if (fiber->stack.base) {
919 fiber_pool_stack_release(&fiber->stack);
920 fiber->stack.base = NULL;
924 rb_ec_clear_vm_stack(ec);
928fiber_status_name(
enum fiber_status s)
931 case FIBER_CREATED:
return "created";
932 case FIBER_RESUMED:
return "resumed";
933 case FIBER_SUSPENDED:
return "suspended";
934 case FIBER_TERMINATED:
return "terminated";
936 VM_UNREACHABLE(fiber_status_name);
944 VM_ASSERT(fiber->cont.saved_ec.fiber_ptr == fiber);
946 switch (fiber->status) {
948 VM_ASSERT(fiber->cont.saved_ec.vm_stack != NULL);
950 case FIBER_SUSPENDED:
951 VM_ASSERT(fiber->cont.saved_ec.vm_stack != NULL);
954 case FIBER_TERMINATED:
958 VM_UNREACHABLE(fiber_verify);
964fiber_status_set(
rb_fiber_t *fiber,
enum fiber_status s)
967 VM_ASSERT(!FIBER_TERMINATED_P(fiber));
968 VM_ASSERT(fiber->status != s);
989 if (!fiber) rb_raise(rb_eFiberError,
"uninitialized fiber");
994NOINLINE(
static VALUE cont_capture(
volatile int *
volatile stat));
996#define THREAD_MUST_BE_RUNNING(th) do { \
997 if (!(th)->ec->tag) rb_raise(rb_eThreadError, "not running thread"); \
1003 return fiber->cont.saved_ec.thread_ptr;
1009 return cont->saved_ec.thread_ptr->self;
1013cont_compact(
void *ptr)
1018 cont->self = rb_gc_location(cont->self);
1020 cont->value = rb_gc_location(cont->value);
1021 rb_execution_context_update(&cont->saved_ec);
1029 RUBY_MARK_ENTER(
"cont");
1031 rb_gc_mark_movable(cont->self);
1033 rb_gc_mark_movable(cont->value);
1035 rb_execution_context_mark(&cont->saved_ec);
1036 rb_gc_mark(cont_thread_value(cont));
1038 if (cont->saved_vm_stack.ptr) {
1039#ifdef CAPTURE_JUST_VALID_VM_STACK
1040 rb_gc_mark_locations(cont->saved_vm_stack.ptr,
1041 cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1043 rb_gc_mark_locations(cont->saved_vm_stack.ptr,
1044 cont->saved_vm_stack.ptr, cont->saved_ec.stack_size);
1048 if (cont->machine.stack) {
1049 if (cont->type == CONTINUATION_CONTEXT) {
1051 rb_gc_mark_locations(cont->machine.stack,
1052 cont->machine.stack + cont->machine.stack_size);
1060 RUBY_MARK_LEAVE(
"cont");
1067 return fiber == fiber->cont.saved_ec.thread_ptr->root_fiber;
1071static void jit_cont_free(
struct rb_jit_cont *cont);
1078 RUBY_FREE_ENTER(
"cont");
1080 if (cont->type == CONTINUATION_CONTEXT) {
1081 ruby_xfree(cont->saved_ec.vm_stack);
1082 RUBY_FREE_UNLESS_NULL(cont->machine.stack);
1086 coroutine_destroy(&fiber->context);
1087 fiber_stack_release(fiber);
1090 RUBY_FREE_UNLESS_NULL(cont->saved_vm_stack.ptr);
1092 VM_ASSERT(cont->jit_cont != NULL);
1093 jit_cont_free(cont->jit_cont);
1096 RUBY_FREE_LEAVE(
"cont");
1100cont_memsize(
const void *ptr)
1105 size =
sizeof(*cont);
1106 if (cont->saved_vm_stack.ptr) {
1107#ifdef CAPTURE_JUST_VALID_VM_STACK
1108 size_t n = (cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1110 size_t n = cont->saved_ec.vm_stack_size;
1112 size += n *
sizeof(*cont->saved_vm_stack.ptr);
1115 if (cont->machine.stack) {
1116 size += cont->machine.stack_size *
sizeof(*cont->machine.stack);
1125 if (fiber->cont.self) {
1126 fiber->cont.self = rb_gc_location(fiber->cont.self);
1129 rb_execution_context_update(&fiber->cont.saved_ec);
1136 if (fiber->cont.self) {
1137 rb_gc_mark_movable(fiber->cont.self);
1140 rb_execution_context_mark(&fiber->cont.saved_ec);
1145fiber_compact(
void *ptr)
1148 fiber->first_proc = rb_gc_location(fiber->first_proc);
1150 if (fiber->prev) rb_fiber_update_self(fiber->prev);
1152 cont_compact(&fiber->cont);
1153 fiber_verify(fiber);
1157fiber_mark(
void *ptr)
1160 RUBY_MARK_ENTER(
"cont");
1161 fiber_verify(fiber);
1162 rb_gc_mark_movable(fiber->first_proc);
1163 if (fiber->prev) rb_fiber_mark_self(fiber->prev);
1164 cont_mark(&fiber->cont);
1165 RUBY_MARK_LEAVE(
"cont");
1169fiber_free(
void *ptr)
1172 RUBY_FREE_ENTER(
"fiber");
1174 if (DEBUG) fprintf(stderr,
"fiber_free: %p[%p]\n", (
void *)fiber, fiber->stack.base);
1176 if (fiber->cont.saved_ec.local_storage) {
1177 rb_id_table_free(fiber->cont.saved_ec.local_storage);
1180 cont_free(&fiber->cont);
1181 RUBY_FREE_LEAVE(
"fiber");
1185fiber_memsize(
const void *ptr)
1188 size_t size =
sizeof(*fiber);
1190 const rb_thread_t *th = rb_ec_thread_ptr(saved_ec);
1195 if (saved_ec->local_storage && fiber != th->root_fiber) {
1196 size += rb_id_table_memsize(saved_ec->local_storage);
1197 size += rb_obj_memsize_of(saved_ec->storage);
1200 size += cont_memsize(&fiber->cont);
1215 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
1217 if (th->ec->machine.stack_start > th->ec->machine.stack_end) {
1218 size = cont->machine.stack_size = th->ec->machine.stack_start - th->ec->machine.stack_end;
1219 cont->machine.stack_src = th->ec->machine.stack_end;
1222 size = cont->machine.stack_size = th->ec->machine.stack_end - th->ec->machine.stack_start;
1223 cont->machine.stack_src = th->ec->machine.stack_start;
1226 if (cont->machine.stack) {
1233 FLUSH_REGISTER_WINDOWS;
1234 asan_unpoison_memory_region(cont->machine.stack_src, size,
false);
1235 MEMCPY(cont->machine.stack, cont->machine.stack_src,
VALUE, size);
1240 {cont_mark, cont_free, cont_memsize, cont_compact},
1241 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
1249 VM_ASSERT(th->status == THREAD_RUNNABLE);
1256 sec->machine.stack_end = NULL;
1259static rb_nativethread_lock_t jit_cont_lock;
1277 if (first_jit_cont == NULL) {
1278 cont->next = cont->prev = NULL;
1282 cont->next = first_jit_cont;
1283 first_jit_cont->prev = cont;
1285 first_jit_cont = cont;
1298 if (cont == first_jit_cont) {
1299 first_jit_cont = cont->next;
1300 if (first_jit_cont != NULL)
1301 first_jit_cont->prev = NULL;
1304 cont->prev->next = cont->next;
1305 if (cont->next != NULL)
1306 cont->next->prev = cont->prev;
1315rb_jit_cont_each_iseq(rb_iseq_callback callback,
void *data)
1318 for (cont = first_jit_cont; cont != NULL; cont = cont->next) {
1319 if (cont->ec->vm_stack == NULL)
1323 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(cont->ec, cfp)) {
1324 if (cfp->pc && cfp->iseq && imemo_type((
VALUE)cfp->iseq) == imemo_iseq) {
1325 callback(cfp->iseq, data);
1327 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1336rb_yjit_cancel_jit_return(
void *leave_exit,
void *leave_exception)
1339 for (cont = first_jit_cont; cont != NULL; cont = cont->next) {
1340 if (cont->ec->vm_stack == NULL)
1344 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(cont->ec, cfp)) {
1345 if (cfp->jit_return && cfp->jit_return != leave_exception) {
1348 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1356rb_jit_cont_finish(
void)
1359 for (cont = first_jit_cont; cont != NULL; cont = next) {
1369 VM_ASSERT(cont->jit_cont == NULL);
1371 cont->jit_cont = jit_cont_new(&(cont->saved_ec));
1377 return &fiber->cont.saved_ec;
1384 cont_save_thread(cont, th);
1385 cont->saved_ec.thread_ptr = th;
1386 cont->saved_ec.local_storage = NULL;
1387 cont->saved_ec.local_storage_recursive_hash =
Qnil;
1388 cont->saved_ec.local_storage_recursive_hash_for_trace =
Qnil;
1389 cont_init_jit_cont(cont);
1393cont_new(
VALUE klass)
1396 volatile VALUE contval;
1399 THREAD_MUST_BE_RUNNING(th);
1401 cont->self = contval;
1402 cont_init(cont, th);
1409 return fiber->cont.self;
1415 return fiber->blocking;
1420rb_jit_cont_init(
void)
1429 VALUE *p = ec->vm_stack;
1430 while (p < ec->cfp->sp) {
1431 fprintf(stderr,
"%3d ", (
int)(p - ec->vm_stack));
1432 rb_obj_info_dump(*p);
1442 while (cfp != end_of_cfp) {
1445 pc = cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded;
1447 fprintf(stderr,
"%2d pc: %d\n", i++, pc);
1448 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1454cont_capture(
volatile int *
volatile stat)
1458 volatile VALUE contval;
1461 THREAD_MUST_BE_RUNNING(th);
1462 rb_vm_stack_to_heap(th->ec);
1463 cont = cont_new(rb_cContinuation);
1464 contval = cont->self;
1466#ifdef CAPTURE_JUST_VALID_VM_STACK
1467 cont->saved_vm_stack.slen = ec->cfp->sp - ec->vm_stack;
1468 cont->saved_vm_stack.clen = ec->vm_stack + ec->vm_stack_size - (
VALUE*)ec->cfp;
1469 cont->saved_vm_stack.ptr =
ALLOC_N(
VALUE, cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1470 MEMCPY(cont->saved_vm_stack.ptr,
1472 VALUE, cont->saved_vm_stack.slen);
1473 MEMCPY(cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen,
1476 cont->saved_vm_stack.clen);
1478 cont->saved_vm_stack.ptr =
ALLOC_N(
VALUE, ec->vm_stack_size);
1479 MEMCPY(cont->saved_vm_stack.ptr, ec->vm_stack,
VALUE, ec->vm_stack_size);
1482 rb_ec_set_vm_stack(&cont->saved_ec, NULL, 0);
1483 VM_ASSERT(cont->saved_ec.cfp != NULL);
1484 cont_save_machine_stack(th, cont);
1486 if (ruby_setjmp(cont->jmpbuf)) {
1489 VAR_INITIALIZED(cont);
1490 value = cont->value;
1508 if (cont->type == CONTINUATION_CONTEXT) {
1513 if (sec->fiber_ptr != NULL) {
1514 fiber = sec->fiber_ptr;
1516 else if (th->root_fiber) {
1517 fiber = th->root_fiber;
1520 if (fiber && th->ec != &fiber->cont.saved_ec) {
1521 ec_switch(th, fiber);
1524 if (th->ec->trace_arg != sec->trace_arg) {
1528#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
1529 if (th->ec->tag != sec->tag) {
1532 struct rb_vm_tag *lowest_common_ancestor = NULL;
1533 size_t num_tags = 0;
1534 size_t num_saved_tags = 0;
1535 for (
struct rb_vm_tag *tag = th->ec->tag; tag != NULL; tag = tag->prev) {
1538 for (
struct rb_vm_tag *tag = sec->tag; tag != NULL; tag = tag->prev) {
1542 size_t min_tags = num_tags <= num_saved_tags ? num_tags : num_saved_tags;
1545 while (num_tags > min_tags) {
1551 while (num_saved_tags > min_tags) {
1552 saved_tag = saved_tag->prev;
1556 while (min_tags > 0) {
1557 if (tag == saved_tag) {
1558 lowest_common_ancestor = tag;
1562 saved_tag = saved_tag->prev;
1567 for (
struct rb_vm_tag *tag = th->ec->tag; tag != lowest_common_ancestor; tag = tag->prev) {
1568 rb_vm_tag_jmpbuf_deinit(&tag->buf);
1574#ifdef CAPTURE_JUST_VALID_VM_STACK
1576 cont->saved_vm_stack.ptr,
1577 VALUE, cont->saved_vm_stack.slen);
1578 MEMCPY(th->ec->vm_stack + th->ec->vm_stack_size - cont->saved_vm_stack.clen,
1579 cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen,
1580 VALUE, cont->saved_vm_stack.clen);
1582 MEMCPY(th->ec->vm_stack, cont->saved_vm_stack.ptr,
VALUE, sec->vm_stack_size);
1586 th->ec->cfp = sec->cfp;
1587 th->ec->raised_flag = sec->raised_flag;
1588 th->ec->tag = sec->tag;
1589 th->ec->root_lep = sec->root_lep;
1590 th->ec->root_svar = sec->root_svar;
1591 th->ec->errinfo = sec->errinfo;
1593 VM_ASSERT(th->ec->vm_stack != NULL);
1609 if (!FIBER_TERMINATED_P(old_fiber)) {
1610 STACK_GROW_DIR_DETECTION;
1611 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
1612 if (STACK_DIR_UPPER(0, 1)) {
1613 old_fiber->cont.machine.stack_size = th->ec->machine.stack_start - th->ec->machine.stack_end;
1614 old_fiber->cont.machine.stack = th->ec->machine.stack_end;
1617 old_fiber->cont.machine.stack_size = th->ec->machine.stack_end - th->ec->machine.stack_start;
1618 old_fiber->cont.machine.stack = th->ec->machine.stack_start;
1623 old_fiber->cont.saved_ec.machine.stack_start = th->ec->machine.stack_start;
1624 old_fiber->cont.saved_ec.machine.stack_end = FIBER_TERMINATED_P(old_fiber) ? NULL : th->ec->machine.stack_end;
1629#if defined(COROUTINE_SANITIZE_ADDRESS)
1630 __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);
1634 struct coroutine_context * from = coroutine_transfer(&old_fiber->context, &new_fiber->context);
1636#if defined(COROUTINE_SANITIZE_ADDRESS)
1637 __sanitizer_finish_switch_fiber(old_fiber->context.fake_stack, NULL, NULL);
1645 fiber_restore_thread(th, old_fiber);
1651NOINLINE(NORETURN(
static void cont_restore_1(
rb_context_t *)));
1656 cont_restore_thread(cont);
1659#if (defined(_M_AMD64) && !defined(__MINGW64__)) || defined(_M_ARM64)
1664 _JUMP_BUFFER *bp = (
void*)&cont->jmpbuf;
1665 bp->Frame = ((_JUMP_BUFFER*)((
void*)&buf))->Frame;
1668 if (cont->machine.stack_src) {
1669 FLUSH_REGISTER_WINDOWS;
1670 MEMCPY(cont->machine.stack_src, cont->machine.stack,
1671 VALUE, cont->machine.stack_size);
1674 ruby_longjmp(cont->jmpbuf, 1);
1682 if (cont->machine.stack_src) {
1684#define STACK_PAD_SIZE 1
1686#define STACK_PAD_SIZE 1024
1688 VALUE space[STACK_PAD_SIZE];
1690#if !STACK_GROW_DIRECTION
1691 if (addr_in_prev_frame > &space[0]) {
1694#if STACK_GROW_DIRECTION <= 0
1695 volatile VALUE *
const end = cont->machine.stack_src;
1696 if (&space[0] > end) {
1705 cont_restore_0(cont, &space[0]);
1709#if !STACK_GROW_DIRECTION
1714#if STACK_GROW_DIRECTION >= 0
1715 volatile VALUE *
const end = cont->machine.stack_src + cont->machine.stack_size;
1716 if (&space[STACK_PAD_SIZE] < end) {
1721 cont_restore_0(cont, &space[STACK_PAD_SIZE-1]);
1725#if !STACK_GROW_DIRECTION
1729 cont_restore_1(cont);
1816rb_callcc(
VALUE self)
1818 volatile int called;
1819 volatile VALUE val = cont_capture(&called);
1828#ifdef RUBY_ASAN_ENABLED
1831MAYBE_UNUSED(
static void notusing_callcc(
void)) { rb_callcc(
Qnil); }
1832# define rb_callcc rb_f_notimplement
1837make_passing_arg(
int argc,
const VALUE *argv)
1853NORETURN(
static VALUE rb_cont_call(
int argc,
VALUE *argv,
VALUE contval));
1871rb_cont_call(
int argc,
VALUE *argv,
VALUE contval)
1876 if (cont_thread_value(cont) != th->self) {
1879 if (cont->saved_ec.fiber_ptr) {
1880 if (th->ec->fiber_ptr != cont->saved_ec.fiber_ptr) {
1886 cont->value = make_passing_arg(argc, argv);
1888 cont_restore_0(cont, &contval);
1981 {fiber_mark, fiber_free, fiber_memsize, fiber_compact,},
1982 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
1986fiber_alloc(
VALUE klass)
1992fiber_t_alloc(
VALUE fiber_value,
unsigned int blocking)
2001 THREAD_MUST_BE_RUNNING(th);
2003 fiber->cont.self = fiber_value;
2004 fiber->cont.type = FIBER_CONTEXT;
2005 fiber->blocking = blocking;
2007 cont_init(&fiber->cont, th);
2009 fiber->cont.saved_ec.fiber_ptr = fiber;
2010 rb_ec_clear_vm_stack(&fiber->cont.saved_ec);
2016 VM_ASSERT(FIBER_CREATED_P(fiber));
2026 VALUE fiber_value = fiber_alloc(rb_cFiber);
2029 VM_ASSERT(
DATA_PTR(fiber_value) == NULL);
2030 VM_ASSERT(fiber->cont.type == FIBER_CONTEXT);
2031 VM_ASSERT(FIBER_RESUMED_P(fiber));
2033 th->root_fiber = fiber;
2035 fiber->cont.self = fiber_value;
2037 coroutine_initialize_main(&fiber->context);
2046 if (ec->fiber_ptr->cont.self == 0) {
2047 root_fiber_alloc(rb_ec_thread_ptr(ec));
2049 return ec->fiber_ptr;
2053current_fiber_storage(
void)
2060inherit_fiber_storage(
void)
2068 fiber->cont.saved_ec.storage = storage;
2072fiber_storage_get(
rb_fiber_t *fiber,
int allocate)
2074 VALUE storage = fiber->cont.saved_ec.storage;
2075 if (storage ==
Qnil && allocate) {
2076 storage = rb_hash_new();
2077 fiber_storage_set(fiber, storage);
2083storage_access_must_be_from_same_fiber(
VALUE self)
2087 if (fiber != current) {
2088 rb_raise(rb_eArgError,
"Fiber storage can only be accessed from the Fiber it belongs to");
2099rb_fiber_storage_get(
VALUE self)
2101 storage_access_must_be_from_same_fiber(self);
2103 VALUE storage = fiber_storage_get(fiber_ptr(self), FALSE);
2105 if (storage ==
Qnil) {
2122fiber_storage_validate(
VALUE value)
2125 if (value ==
Qnil)
return;
2165 "Fiber#storage= is experimental and may be removed in the future!");
2168 storage_access_must_be_from_same_fiber(self);
2169 fiber_storage_validate(value);
2171 fiber_ptr(self)->cont.saved_ec.storage =
rb_obj_dup(value);
2190 VALUE storage = fiber_storage_get(fiber_current(), FALSE);
2193 return rb_hash_aref(storage, key);
2211 VALUE storage = fiber_storage_get(fiber_current(), value !=
Qnil);
2214 if (value ==
Qnil) {
2215 return rb_hash_delete(storage, key);
2218 return rb_hash_aset(storage, key, value);
2227 storage = inherit_fiber_storage();
2230 fiber_storage_validate(storage);
2234 rb_fiber_t *fiber = fiber_t_alloc(self, blocking);
2236 fiber->cont.saved_ec.storage = storage;
2237 fiber->first_proc = proc;
2238 fiber->stack.base = NULL;
2250 size_t vm_stack_size = 0;
2251 VALUE *vm_stack = fiber_initialize_coroutine(fiber, &vm_stack_size);
2254 cont->saved_vm_stack.ptr = NULL;
2255 rb_ec_initialize_vm_stack(sec, vm_stack, vm_stack_size /
sizeof(
VALUE));
2258 sec->local_storage = NULL;
2259 sec->local_storage_recursive_hash =
Qnil;
2260 sec->local_storage_recursive_hash_for_trace =
Qnil;
2264rb_fiber_pool_default(
VALUE pool)
2266 return &shared_fiber_pool;
2272 fiber->cont.saved_ec.storage = storage;
2278rb_fiber_initialize_kw(
int argc,
VALUE* argv,
VALUE self,
int kw_splat)
2289 rb_get_kwargs(options, fiber_initialize_keywords, 0, 3, arguments);
2291 if (!UNDEF_P(arguments[0])) {
2292 blocking = arguments[0];
2295 if (!UNDEF_P(arguments[1])) {
2296 pool = arguments[1];
2299 storage = arguments[2];
2302 return fiber_initialize(self,
rb_block_proc(), rb_fiber_pool_default(pool),
RTEST(blocking), storage);
2355rb_fiber_initialize(
int argc,
VALUE* argv,
VALUE self)
2363 return fiber_initialize(fiber_alloc(rb_cFiber),
rb_proc_new(func, obj), rb_fiber_pool_default(
Qnil), 0, storage);
2369 return rb_fiber_new_storage(func, obj,
Qtrue);
2373rb_fiber_s_schedule_kw(
int argc,
VALUE* argv,
int kw_splat)
2376 VALUE scheduler = th->scheduler;
2379 if (scheduler !=
Qnil) {
2431rb_fiber_s_schedule(
int argc,
VALUE *argv,
VALUE obj)
2447rb_fiber_s_scheduler(
VALUE klass)
2461rb_fiber_current_scheduler(
VALUE klass)
2483rb_fiber_set_scheduler(
VALUE klass,
VALUE scheduler)
2488NORETURN(
static void rb_fiber_terminate(
rb_fiber_t *fiber,
int need_interrupt,
VALUE err));
2493 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2496 enum ruby_tag_type state;
2498 VM_ASSERT(th->ec == GET_EC());
2499 VM_ASSERT(FIBER_RESUMED_P(fiber));
2501 if (fiber->blocking) {
2505 EC_PUSH_TAG(th->ec);
2506 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2509 const VALUE *argv, args = cont->value;
2510 GetProcPtr(fiber->first_proc, proc);
2513 th->ec->errinfo =
Qnil;
2514 th->ec->root_lep = rb_vm_proc_local_ep(fiber->first_proc);
2515 th->ec->root_svar =
Qfalse;
2518 cont->value = rb_vm_invoke_proc(th->ec, proc, argc, argv, cont->kw_splat, VM_BLOCK_HANDLER_NONE);
2522 int need_interrupt = TRUE;
2525 err = th->ec->errinfo;
2526 VM_ASSERT(FIBER_RESUMED_P(fiber));
2528 if (state == TAG_RAISE) {
2531 else if (state == TAG_FATAL && err == RUBY_FATAL_FIBER_KILLED) {
2532 need_interrupt = FALSE;
2535 else if (state == TAG_FATAL) {
2536 rb_threadptr_pending_interrupt_enque(th, err);
2539 err = rb_vm_make_jump_tag_but_local_jump(state, err);
2543 rb_fiber_terminate(fiber, need_interrupt, err);
2552 rb_bug(
"%s", strerror(
errno));
2554 fiber->cont.type = FIBER_CONTEXT;
2555 fiber->cont.saved_ec.fiber_ptr = fiber;
2556 fiber->cont.saved_ec.thread_ptr = th;
2557 fiber->blocking = 1;
2559 fiber_status_set(fiber, FIBER_RESUMED);
2560 th->ec = &fiber->cont.saved_ec;
2561 cont_init_jit_cont(&fiber->cont);
2567 if (th->root_fiber) {
2573 VM_ASSERT(th->ec->fiber_ptr->cont.type == FIBER_CONTEXT);
2574 VM_ASSERT(th->ec->fiber_ptr->cont.self == 0);
2576 if (ec && th->ec == ec) {
2577 rb_ractor_set_current_ec(th->ractor, NULL);
2579 fiber_free(th->ec->fiber_ptr);
2589 fiber->status = FIBER_TERMINATED;
2592 rb_ec_clear_vm_stack(th->ec);
2596return_fiber(
bool terminate)
2603 prev->resuming_fiber = NULL;
2608 rb_raise(rb_eFiberError,
"attempt to yield on a not resumed fiber");
2614 VM_ASSERT(root_fiber != NULL);
2617 for (fiber = root_fiber; fiber->resuming_fiber; fiber = fiber->resuming_fiber) {
2625rb_fiber_current(
void)
2627 return fiber_current()->cont.self;
2636 if (th->ec->fiber_ptr != NULL) {
2637 fiber = th->ec->fiber_ptr;
2641 fiber = root_fiber_alloc(th);
2644 if (FIBER_CREATED_P(next_fiber)) {
2645 fiber_prepare_stack(next_fiber);
2648 VM_ASSERT(FIBER_RESUMED_P(fiber) || FIBER_TERMINATED_P(fiber));
2649 VM_ASSERT(FIBER_RUNNABLE_P(next_fiber));
2651 if (FIBER_RESUMED_P(fiber)) fiber_status_set(fiber, FIBER_SUSPENDED);
2653 fiber_status_set(next_fiber, FIBER_RESUMED);
2654 fiber_setcontext(next_fiber, fiber);
2660 VM_ASSERT(fiber == fiber_current());
2662 if (fiber->killed) {
2663 rb_thread_t *thread = fiber->cont.saved_ec.thread_ptr;
2665 thread->ec->errinfo = RUBY_FATAL_FIBER_KILLED;
2666 EC_JUMP_TAG(thread->ec, RUBY_TAG_FATAL);
2678 if (th->root_fiber == NULL) root_fiber_alloc(th);
2680 if (th->ec->fiber_ptr == fiber) {
2684 return make_passing_arg(argc, argv);
2687 if (cont_thread_value(cont) != th->self) {
2688 rb_raise(rb_eFiberError,
"fiber called across threads");
2691 if (FIBER_TERMINATED_P(fiber)) {
2692 value =
rb_exc_new2(rb_eFiberError,
"dead fiber called");
2694 if (!FIBER_TERMINATED_P(th->ec->fiber_ptr)) {
2696 VM_UNREACHABLE(fiber_switch);
2702 VM_ASSERT(FIBER_SUSPENDED_P(th->root_fiber));
2704 cont = &th->root_fiber->cont;
2706 cont->value = value;
2708 fiber_setcontext(th->root_fiber, th->ec->fiber_ptr);
2710 VM_UNREACHABLE(fiber_switch);
2714 VM_ASSERT(FIBER_RUNNABLE_P(fiber));
2718 VM_ASSERT(!current_fiber->resuming_fiber);
2720 if (resuming_fiber) {
2721 current_fiber->resuming_fiber = resuming_fiber;
2722 fiber->prev = fiber_current();
2723 fiber->yielding = 0;
2726 VM_ASSERT(!current_fiber->yielding);
2728 current_fiber->yielding = 1;
2731 if (current_fiber->blocking) {
2736 cont->kw_splat = kw_splat;
2737 cont->value = make_passing_arg(argc, argv);
2739 fiber_store(fiber, th);
2742#ifndef COROUTINE_PTHREAD_CONTEXT
2743 if (resuming_fiber && FIBER_TERMINATED_P(fiber)) {
2744 fiber_stack_release(fiber);
2748 if (fiber_current()->blocking) {
2752 RUBY_VM_CHECK_INTS(th->ec);
2756 current_fiber = th->ec->fiber_ptr;
2757 value = current_fiber->cont.value;
2759 fiber_check_killed(current_fiber);
2761 if (current_fiber->cont.argc == -1) {
2772 return fiber_switch(fiber_ptr(fiber_value), argc, argv,
RB_NO_KEYWORDS, NULL,
false);
2790rb_fiber_blocking_p(
VALUE fiber)
2792 return RBOOL(fiber_ptr(fiber)->blocking);
2796fiber_blocking_yield(
VALUE fiber_value)
2799 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2801 VM_ASSERT(fiber->blocking == 0);
2804 fiber->blocking = 1;
2813fiber_blocking_ensure(
VALUE fiber_value)
2816 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2819 fiber->blocking = 0;
2836rb_fiber_blocking(
VALUE class)
2838 VALUE fiber_value = rb_fiber_current();
2842 if (fiber->blocking) {
2846 return rb_ensure(fiber_blocking_yield, fiber_value, fiber_blocking_ensure, fiber_value);
2869rb_fiber_s_blocking_p(
VALUE klass)
2872 unsigned blocking = thread->blocking;
2883 fiber_status_set(fiber, FIBER_TERMINATED);
2889 VALUE value = fiber->cont.value;
2891 VM_ASSERT(FIBER_RESUMED_P(fiber));
2892 rb_fiber_close(fiber);
2894 fiber->cont.machine.stack = NULL;
2895 fiber->cont.machine.stack_size = 0;
2899 if (need_interrupt) RUBY_VM_SET_INTERRUPT(&next_fiber->cont.saved_ec);
2902 fiber_switch(next_fiber, -1, &error,
RB_NO_KEYWORDS, NULL,
false);
2904 fiber_switch(next_fiber, 1, &value,
RB_NO_KEYWORDS, NULL,
false);
2909fiber_resume_kw(
rb_fiber_t *fiber,
int argc,
const VALUE *argv,
int kw_splat)
2913 if (argc == -1 && FIBER_CREATED_P(fiber)) {
2914 rb_raise(rb_eFiberError,
"cannot raise exception on unborn fiber");
2916 else if (FIBER_TERMINATED_P(fiber)) {
2917 rb_raise(rb_eFiberError,
"attempt to resume a terminated fiber");
2919 else if (fiber == current_fiber) {
2920 rb_raise(rb_eFiberError,
"attempt to resume the current fiber");
2922 else if (fiber->prev != NULL) {
2923 rb_raise(rb_eFiberError,
"attempt to resume a resumed fiber (double resume)");
2925 else if (fiber->resuming_fiber) {
2926 rb_raise(rb_eFiberError,
"attempt to resume a resuming fiber");
2928 else if (fiber->prev == NULL &&
2929 (!fiber->yielding && fiber->status != FIBER_CREATED)) {
2930 rb_raise(rb_eFiberError,
"attempt to resume a transferring fiber");
2933 return fiber_switch(fiber, argc, argv, kw_splat, fiber,
false);
2937rb_fiber_resume_kw(
VALUE self,
int argc,
const VALUE *argv,
int kw_splat)
2939 return fiber_resume_kw(fiber_ptr(self), argc, argv, kw_splat);
2945 return fiber_resume_kw(fiber_ptr(self), argc, argv,
RB_NO_KEYWORDS);
2949rb_fiber_yield_kw(
int argc,
const VALUE *argv,
int kw_splat)
2951 return fiber_switch(return_fiber(
false), argc, argv, kw_splat, NULL,
true);
2955rb_fiber_yield(
int argc,
const VALUE *argv)
2957 return fiber_switch(return_fiber(
false), argc, argv,
RB_NO_KEYWORDS, NULL,
true);
2963 if (th->root_fiber && th->root_fiber != th->ec->fiber_ptr) {
2964 th->ec->local_storage = th->root_fiber->cont.saved_ec.local_storage;
2979 return RBOOL(!FIBER_TERMINATED_P(fiber_ptr(fiber_value)));
2998rb_fiber_m_resume(
int argc,
VALUE *argv,
VALUE fiber)
3050rb_fiber_backtrace(
int argc,
VALUE *argv,
VALUE fiber)
3052 return rb_vm_backtrace(argc, argv, &fiber_ptr(fiber)->cont.saved_ec);
3075rb_fiber_backtrace_locations(
int argc,
VALUE *argv,
VALUE fiber)
3077 return rb_vm_backtrace_locations(argc, argv, &fiber_ptr(fiber)->cont.saved_ec);
3163rb_fiber_m_transfer(
int argc,
VALUE *argv,
VALUE self)
3169fiber_transfer_kw(
rb_fiber_t *fiber,
int argc,
const VALUE *argv,
int kw_splat)
3171 if (fiber->resuming_fiber) {
3172 rb_raise(rb_eFiberError,
"attempt to transfer to a resuming fiber");
3175 if (fiber->yielding) {
3176 rb_raise(rb_eFiberError,
"attempt to transfer to a yielding fiber");
3179 return fiber_switch(fiber, argc, argv, kw_splat, NULL,
false);
3183rb_fiber_transfer_kw(
VALUE self,
int argc,
const VALUE *argv,
int kw_splat)
3185 return fiber_transfer_kw(fiber_ptr(self), argc, argv, kw_splat);
3199rb_fiber_s_yield(
int argc,
VALUE *argv,
VALUE klass)
3207 if (fiber == fiber_current()) {
3210 else if (fiber->resuming_fiber) {
3211 return fiber_raise(fiber->resuming_fiber, exception);
3213 else if (FIBER_SUSPENDED_P(fiber) && !fiber->yielding) {
3224 VALUE exception = rb_exception_setup(argc, argv);
3226 return fiber_raise(fiber_ptr(fiber), exception);
3255rb_fiber_m_raise(
int argc,
VALUE *argv,
VALUE self)
3257 return rb_fiber_raise(self, argc, argv);
3278rb_fiber_m_kill(
VALUE self)
3282 if (fiber->killed)
return Qfalse;
3285 if (fiber->status == FIBER_CREATED) {
3286 fiber->status = FIBER_TERMINATED;
3288 else if (fiber->status != FIBER_TERMINATED) {
3289 if (fiber_current() == fiber) {
3290 fiber_check_killed(fiber);
3293 fiber_raise(fiber_ptr(self),
Qnil);
3308rb_fiber_s_current(
VALUE klass)
3310 return rb_fiber_current();
3314fiber_to_s(
VALUE fiber_value)
3316 const rb_fiber_t *fiber = fiber_ptr(fiber_value);
3318 char status_info[0x20];
3320 if (fiber->resuming_fiber) {
3321 snprintf(status_info, 0x20,
" (%s by resuming)", fiber_status_name(fiber->status));
3324 snprintf(status_info, 0x20,
" (%s)", fiber_status_name(fiber->status));
3329 strlcat(status_info,
">",
sizeof(status_info));
3334 GetProcPtr(fiber->first_proc, proc);
3335 return rb_block_to_s(fiber_value, &proc->block, status_info);
3338#ifdef HAVE_WORKING_FORK
3342 if (th->root_fiber) {
3343 if (&th->root_fiber->cont.saved_ec != th->ec) {
3344 th->root_fiber = th->ec->fiber_ptr;
3346 th->root_fiber->prev = 0;
3351#ifdef RB_EXPERIMENTAL_FIBER_POOL
3353fiber_pool_free(
void *ptr)
3356 RUBY_FREE_ENTER(
"fiber_pool");
3358 fiber_pool_allocation_free(
fiber_pool->allocations);
3361 RUBY_FREE_LEAVE(
"fiber_pool");
3365fiber_pool_memsize(
const void *ptr)
3368 size_t size =
sizeof(*fiber_pool);
3377 {NULL, fiber_pool_free, fiber_pool_memsize,},
3378 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3382fiber_pool_alloc(
VALUE klass)
3390rb_fiber_pool_initialize(
int argc,
VALUE* argv,
VALUE self)
3397 rb_scan_args(argc, argv,
"03", &size, &count, &vm_stack_size);
3400 size =
SIZET2NUM(th->vm->default_params.fiber_machine_stack_size);
3407 if (
NIL_P(vm_stack_size)) {
3408 vm_stack_size =
SIZET2NUM(th->vm->default_params.fiber_vm_stack_size);
3436 size_t vm_stack_size = th->vm->default_params.fiber_vm_stack_size;
3437 size_t machine_stack_size = th->vm->default_params.fiber_machine_stack_size;
3438 size_t stack_size = machine_stack_size + vm_stack_size;
3442 GetSystemInfo(&info);
3443 pagesize = info.dwPageSize;
3445 pagesize = sysconf(_SC_PAGESIZE);
3447 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
3449 fiber_pool_initialize(&shared_fiber_pool, stack_size, FIBER_POOL_INITIAL_SIZE, vm_stack_size);
3455 const char *fiber_shared_fiber_pool_free_stacks = getenv(
"RUBY_SHARED_FIBER_POOL_FREE_STACKS");
3456 if (fiber_shared_fiber_pool_free_stacks) {
3457 shared_fiber_pool.free_stacks = atoi(fiber_shared_fiber_pool_free_stacks);
3459 if (shared_fiber_pool.free_stacks < 0) {
3460 rb_warn(
"Setting RUBY_SHARED_FIBER_POOL_FREE_STACKS to a negative value is not allowed.");
3461 shared_fiber_pool.free_stacks = 0;
3464 if (shared_fiber_pool.free_stacks > 1) {
3465 rb_warn(
"Setting RUBY_SHARED_FIBER_POOL_FREE_STACKS to a value greater than 1 is operating system specific, and may cause crashes.");
3486 rb_define_method(rb_cFiber,
"backtrace_locations", rb_fiber_backtrace_locations, -1);
3499#ifdef RB_EXPERIMENTAL_FIBER_POOL
3506 rb_define_method(rb_cFiberPool,
"initialize", rb_fiber_pool_initialize, -1);
3512RUBY_SYMBOL_EXPORT_BEGIN
3515ruby_Init_Continuation_body(
void)
3525RUBY_SYMBOL_EXPORT_END
#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.
int rb_typeddata_is_kind_of(VALUE obj, const rb_data_type_t *data_type)
Checks if the given object is of given kind.
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.
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.