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/gc.h"
34#include "internal/proc.h"
35#include "internal/sanitizers.h"
36#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;
253#define FIBER_CREATED_P(fiber) ((fiber)->status == FIBER_CREATED)
254#define FIBER_RESUMED_P(fiber) ((fiber)->status == FIBER_RESUMED)
255#define FIBER_SUSPENDED_P(fiber) ((fiber)->status == FIBER_SUSPENDED)
256#define FIBER_TERMINATED_P(fiber) ((fiber)->status == FIBER_TERMINATED)
257#define FIBER_RUNNABLE_P(fiber) (FIBER_CREATED_P(fiber) || FIBER_SUSPENDED_P(fiber))
265 BITFIELD(
enum fiber_status, status, 2);
267 unsigned int yielding : 1;
268 unsigned int blocking : 1;
270 unsigned int killed : 1;
276static struct fiber_pool shared_fiber_pool = {NULL, NULL, 0, 0, 0, 0};
279rb_free_shared_fiber_pool(
void)
281 xfree(shared_fiber_pool.allocations);
284static ID fiber_initialize_keywords[3] = {0};
291#if defined(MAP_STACK) && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
292#define FIBER_STACK_FLAGS (MAP_PRIVATE | MAP_ANON | MAP_STACK)
294#define FIBER_STACK_FLAGS (MAP_PRIVATE | MAP_ANON)
297#define ERRNOMSG strerror(errno)
301fiber_pool_vacancy_pointer(
void * base,
size_t size)
303 STACK_GROW_DIR_DETECTION;
306 (
char*)base + STACK_DIR_UPPER(0, size - RB_PAGE_SIZE)
310#if defined(COROUTINE_SANITIZE_ADDRESS)
315 STACK_GROW_DIR_DETECTION;
317 return (
char*)stack->base + STACK_DIR_UPPER(RB_PAGE_SIZE, 0);
324 return stack->size - RB_PAGE_SIZE;
332 STACK_GROW_DIR_DETECTION;
334 stack->current = (
char*)stack->base + STACK_DIR_UPPER(0, stack->size);
335 stack->available = stack->size;
342 STACK_GROW_DIR_DETECTION;
344 VM_ASSERT(stack->current);
346 return STACK_DIR_UPPER(stack->current, (
char*)stack->current - stack->available);
354 STACK_GROW_DIR_DETECTION;
356 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_alloca(%p): %"PRIuSIZE
"/%"PRIuSIZE
"\n", (
void*)stack, offset, stack->available);
357 VM_ASSERT(stack->available >= offset);
360 void * pointer = STACK_DIR_UPPER(stack->current, (
char*)stack->current - offset);
363 stack->current = STACK_DIR_UPPER((
char*)stack->current + offset, (
char*)stack->current - offset);
364 stack->available -= offset;
373 fiber_pool_stack_reset(&vacancy->stack);
376 fiber_pool_stack_alloca(&vacancy->stack, RB_PAGE_SIZE);
382 vacancy->next = head;
384#ifdef FIBER_POOL_ALLOCATION_FREE
386 head->previous = vacancy;
387 vacancy->previous = NULL;
394#ifdef FIBER_POOL_ALLOCATION_FREE
399 vacancy->next->previous = vacancy->previous;
402 if (vacancy->previous) {
403 vacancy->previous->next = vacancy->next;
407 vacancy->stack.pool->vacancies = vacancy->next;
412fiber_pool_vacancy_pop(
struct fiber_pool * pool)
417 fiber_pool_vacancy_remove(vacancy);
424fiber_pool_vacancy_pop(
struct fiber_pool * pool)
429 pool->vacancies = vacancy->next;
444 vacancy->stack.base = base;
445 vacancy->stack.size = size;
447 fiber_pool_vacancy_reset(vacancy);
451 return fiber_pool_vacancy_push(vacancy, vacancies);
459fiber_pool_allocate_memory(
size_t * count,
size_t stride)
469 void * base = VirtualAlloc(0, (*count)*stride, MEM_COMMIT, PAGE_READWRITE);
472 *count = (*count) >> 1;
479 void * base = mmap(NULL, (*count)*stride, PROT_READ | PROT_WRITE, FIBER_STACK_FLAGS, -1, 0);
481 if (base == MAP_FAILED) {
483 *count = (*count) >> 1;
486#if defined(MADV_FREE_REUSE)
490 while (madvise(base, (*count)*stride, MADV_FREE_REUSE) == -1 &&
errno == EAGAIN);
507 STACK_GROW_DIR_DETECTION;
510 size_t stride = size + RB_PAGE_SIZE;
513 void * base = fiber_pool_allocate_memory(&count, stride);
516 rb_raise(rb_eFiberError,
"can't alloc machine stack to fiber (%"PRIuSIZE
" x %"PRIuSIZE
" bytes): %s", count, size, ERRNOMSG);
523 allocation->base = base;
524 allocation->size = size;
525 allocation->stride = stride;
526 allocation->count = count;
527#ifdef FIBER_POOL_ALLOCATION_FREE
528 allocation->used = 0;
533 fprintf(stderr,
"fiber_pool_expand(%"PRIuSIZE
"): %p, %"PRIuSIZE
"/%"PRIuSIZE
" x [%"PRIuSIZE
":%"PRIuSIZE
"]\n",
538 for (
size_t i = 0; i < count; i += 1) {
539 void * base = (
char*)allocation->base + (stride * i);
540 void * page = (
char*)base + STACK_DIR_UPPER(size, 0);
545 if (!VirtualProtect(page, RB_PAGE_SIZE, PAGE_READWRITE | PAGE_GUARD, &old_protect)) {
546 VirtualFree(allocation->base, 0, MEM_RELEASE);
547 rb_raise(rb_eFiberError,
"can't set a guard page: %s", ERRNOMSG);
550 if (mprotect(page, RB_PAGE_SIZE, PROT_NONE) < 0) {
551 munmap(allocation->base, count*stride);
552 rb_raise(rb_eFiberError,
"can't set a guard page: %s", ERRNOMSG);
556 vacancies = fiber_pool_vacancy_initialize(
558 (
char*)base + STACK_DIR_UPPER(0, RB_PAGE_SIZE),
562#ifdef FIBER_POOL_ALLOCATION_FREE
563 vacancies->stack.allocation = allocation;
570#ifdef FIBER_POOL_ALLOCATION_FREE
571 if (allocation->next) {
572 allocation->next->previous = allocation;
575 allocation->previous = NULL;
588fiber_pool_initialize(
struct fiber_pool *
fiber_pool,
size_t size,
size_t count,
size_t vm_stack_size)
590 VM_ASSERT(vm_stack_size < size);
594 fiber_pool->size = ((size / RB_PAGE_SIZE) + 1) * RB_PAGE_SIZE;
605#ifdef FIBER_POOL_ALLOCATION_FREE
610 STACK_GROW_DIR_DETECTION;
612 VM_ASSERT(allocation->used == 0);
614 if (DEBUG) fprintf(stderr,
"fiber_pool_allocation_free: %p base=%p count=%"PRIuSIZE
"\n", (
void*)allocation, allocation->base, allocation->count);
617 for (i = 0; i < allocation->count; i += 1) {
618 void * base = (
char*)allocation->base + (allocation->stride * i) + STACK_DIR_UPPER(0, RB_PAGE_SIZE);
620 struct fiber_pool_vacancy * vacancy = fiber_pool_vacancy_pointer(base, allocation->size);
623 fiber_pool_vacancy_remove(vacancy);
627 VirtualFree(allocation->base, 0, MEM_RELEASE);
629 munmap(allocation->base, allocation->stride * allocation->count);
632 if (allocation->previous) {
633 allocation->previous->next = allocation->next;
637 allocation->pool->allocations = allocation->next;
640 if (allocation->next) {
641 allocation->next->previous = allocation->previous;
644 allocation->pool->count -= allocation->count;
646 ruby_xfree(allocation);
656 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_acquire: %p used=%"PRIuSIZE
"\n", (
void*)
fiber_pool->vacancies,
fiber_pool->used);
659 const size_t maximum = FIBER_POOL_ALLOCATION_MAXIMUM_SIZE;
660 const size_t minimum =
fiber_pool->initial_count;
663 if (count > maximum) count = maximum;
664 if (count < minimum) count = minimum;
675 VM_ASSERT(vacancy->stack.base);
677#if defined(COROUTINE_SANITIZE_ADDRESS)
678 __asan_unpoison_memory_region(fiber_pool_stack_poison_base(&vacancy->stack), fiber_pool_stack_poison_size(&vacancy->stack));
684#ifdef FIBER_POOL_ALLOCATION_FREE
685 vacancy->stack.allocation->used += 1;
688 fiber_pool_stack_reset(&vacancy->stack);
690 return vacancy->stack;
698 void * base = fiber_pool_stack_base(stack);
699 size_t size = stack->available;
702 VM_ASSERT(size <= (stack->size - RB_PAGE_SIZE));
704 int advice = stack->pool->free_stacks >> 1;
706 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_free: %p+%"PRIuSIZE
" [base=%p, size=%"PRIuSIZE
"] advice=%d\n", base, size, stack->base, stack->size, advice);
719#elif VM_CHECK_MODE > 0 && defined(MADV_DONTNEED)
720 if (!advice) advice = MADV_DONTNEED;
722 madvise(base, size, advice);
723#elif defined(MADV_FREE_REUSABLE)
724 if (!advice) advice = MADV_FREE_REUSABLE;
730 while (madvise(base, size, advice) == -1 &&
errno == EAGAIN);
731#elif defined(MADV_FREE)
732 if (!advice) advice = MADV_FREE;
734 madvise(base, size, advice);
735#elif defined(MADV_DONTNEED)
736 if (!advice) advice = MADV_DONTNEED;
738 madvise(base, size, advice);
739#elif defined(POSIX_MADV_DONTNEED)
740 if (!advice) advice = POSIX_MADV_DONTNEED;
742 posix_madvise(base, size, advice);
744 VirtualAlloc(base, size, MEM_RESET, PAGE_READWRITE);
749#if defined(COROUTINE_SANITIZE_ADDRESS)
750 __asan_poison_memory_region(fiber_pool_stack_poison_base(stack), fiber_pool_stack_poison_size(stack));
759 struct fiber_pool_vacancy * vacancy = fiber_pool_vacancy_pointer(stack->base, stack->size);
761 if (DEBUG) fprintf(stderr,
"fiber_pool_stack_release: %p used=%"PRIuSIZE
"\n", stack->base, stack->pool->used);
764 vacancy->stack = *stack;
768 fiber_pool_vacancy_reset(vacancy);
771 pool->vacancies = fiber_pool_vacancy_push(vacancy, pool->vacancies);
774#ifdef FIBER_POOL_ALLOCATION_FREE
777 allocation->used -= 1;
780 if (allocation->used == 0) {
781 fiber_pool_allocation_free(allocation);
783 else if (stack->pool->free_stacks) {
784 fiber_pool_stack_free(&vacancy->stack);
789 if (stack->pool->free_stacks) {
790 fiber_pool_stack_free(&vacancy->stack);
799 rb_ractor_set_current_ec(th->ractor, th->ec = ec);
806 if (th->vm->ractor.main_thread == th &&
807 rb_signal_buff_size() > 0) {
808 RUBY_VM_SET_TRAP_INTERRUPT(ec);
811 VM_ASSERT(ec->fiber_ptr->cont.self == 0 || ec->vm_stack != NULL);
817 ec_switch(th, fiber);
818 VM_ASSERT(th->ec->fiber_ptr == fiber);
826#if defined(COROUTINE_SANITIZE_ADDRESS)
836 __sanitizer_finish_switch_fiber(to->fake_stack, (
const void**)&from->stack_base, &from->stack_size);
839 rb_thread_t *thread = fiber->cont.saved_ec.thread_ptr;
841#ifdef COROUTINE_PTHREAD_CONTEXT
842 ruby_thread_set_native(thread);
845 fiber_restore_thread(thread, fiber);
847 rb_fiber_start(fiber);
849#ifndef COROUTINE_PTHREAD_CONTEXT
850 VM_UNREACHABLE(fiber_entry);
856fiber_initialize_coroutine(
rb_fiber_t *fiber,
size_t * vm_stack_size)
860 void * vm_stack = NULL;
864 fiber->stack = fiber_pool_stack_acquire(
fiber_pool);
865 vm_stack = fiber_pool_stack_alloca(&fiber->stack,
fiber_pool->vm_stack_size);
868 coroutine_initialize(&fiber->context, fiber_entry, fiber_pool_stack_base(&fiber->stack), fiber->stack.available);
871 sec->machine.stack_start = fiber->stack.current;
872 sec->machine.stack_maxsize = fiber->stack.available;
874 fiber->context.argument = (
void*)fiber;
886 if (DEBUG) fprintf(stderr,
"fiber_stack_release: %p, stack.base=%p\n", (
void*)fiber, fiber->stack.base);
889 if (fiber->stack.base) {
890 fiber_pool_stack_release(&fiber->stack);
891 fiber->stack.base = NULL;
895 rb_ec_clear_vm_stack(ec);
899fiber_status_name(
enum fiber_status s)
902 case FIBER_CREATED:
return "created";
903 case FIBER_RESUMED:
return "resumed";
904 case FIBER_SUSPENDED:
return "suspended";
905 case FIBER_TERMINATED:
return "terminated";
907 VM_UNREACHABLE(fiber_status_name);
915 VM_ASSERT(fiber->cont.saved_ec.fiber_ptr == fiber);
917 switch (fiber->status) {
919 VM_ASSERT(fiber->cont.saved_ec.vm_stack != NULL);
921 case FIBER_SUSPENDED:
922 VM_ASSERT(fiber->cont.saved_ec.vm_stack != NULL);
925 case FIBER_TERMINATED:
929 VM_UNREACHABLE(fiber_verify);
935fiber_status_set(
rb_fiber_t *fiber,
enum fiber_status s)
938 VM_ASSERT(!FIBER_TERMINATED_P(fiber));
939 VM_ASSERT(fiber->status != s);
960 if (!fiber) rb_raise(rb_eFiberError,
"uninitialized fiber");
965NOINLINE(
static VALUE cont_capture(
volatile int *
volatile stat));
967#define THREAD_MUST_BE_RUNNING(th) do { \
968 if (!(th)->ec->tag) rb_raise(rb_eThreadError, "not running thread"); \
974 return fiber->cont.saved_ec.thread_ptr;
980 return cont->saved_ec.thread_ptr->self;
984cont_compact(
void *ptr)
989 cont->self = rb_gc_location(cont->self);
991 cont->value = rb_gc_location(cont->value);
992 rb_execution_context_update(&cont->saved_ec);
1000 RUBY_MARK_ENTER(
"cont");
1002 rb_gc_mark_movable(cont->self);
1004 rb_gc_mark_movable(cont->value);
1006 rb_execution_context_mark(&cont->saved_ec);
1007 rb_gc_mark(cont_thread_value(cont));
1009 if (cont->saved_vm_stack.ptr) {
1010#ifdef CAPTURE_JUST_VALID_VM_STACK
1011 rb_gc_mark_locations(cont->saved_vm_stack.ptr,
1012 cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1014 rb_gc_mark_locations(cont->saved_vm_stack.ptr,
1015 cont->saved_vm_stack.ptr, cont->saved_ec.stack_size);
1019 if (cont->machine.stack) {
1020 if (cont->type == CONTINUATION_CONTEXT) {
1022 rb_gc_mark_locations(cont->machine.stack,
1023 cont->machine.stack + cont->machine.stack_size);
1029 if (!FIBER_TERMINATED_P(fiber)) {
1030 rb_gc_mark_locations(cont->machine.stack,
1031 cont->machine.stack + cont->machine.stack_size);
1036 RUBY_MARK_LEAVE(
"cont");
1043 return fiber == fiber->cont.saved_ec.thread_ptr->root_fiber;
1047static void jit_cont_free(
struct rb_jit_cont *cont);
1054 RUBY_FREE_ENTER(
"cont");
1056 if (cont->type == CONTINUATION_CONTEXT) {
1057 ruby_xfree(cont->saved_ec.vm_stack);
1058 ruby_xfree(cont->ensure_array);
1059 RUBY_FREE_UNLESS_NULL(cont->machine.stack);
1063 coroutine_destroy(&fiber->context);
1064 fiber_stack_release(fiber);
1067 RUBY_FREE_UNLESS_NULL(cont->saved_vm_stack.ptr);
1069 VM_ASSERT(cont->jit_cont != NULL);
1070 jit_cont_free(cont->jit_cont);
1073 RUBY_FREE_LEAVE(
"cont");
1077cont_memsize(
const void *ptr)
1082 size =
sizeof(*cont);
1083 if (cont->saved_vm_stack.ptr) {
1084#ifdef CAPTURE_JUST_VALID_VM_STACK
1085 size_t n = (cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1087 size_t n = cont->saved_ec.vm_stack_size;
1089 size += n *
sizeof(*cont->saved_vm_stack.ptr);
1092 if (cont->machine.stack) {
1093 size += cont->machine.stack_size *
sizeof(*cont->machine.stack);
1102 if (fiber->cont.self) {
1103 fiber->cont.self = rb_gc_location(fiber->cont.self);
1106 rb_execution_context_update(&fiber->cont.saved_ec);
1113 if (fiber->cont.self) {
1114 rb_gc_mark_movable(fiber->cont.self);
1117 rb_execution_context_mark(&fiber->cont.saved_ec);
1122fiber_compact(
void *ptr)
1125 fiber->first_proc = rb_gc_location(fiber->first_proc);
1127 if (fiber->prev) rb_fiber_update_self(fiber->prev);
1129 cont_compact(&fiber->cont);
1130 fiber_verify(fiber);
1134fiber_mark(
void *ptr)
1137 RUBY_MARK_ENTER(
"cont");
1138 fiber_verify(fiber);
1139 rb_gc_mark_movable(fiber->first_proc);
1140 if (fiber->prev) rb_fiber_mark_self(fiber->prev);
1141 cont_mark(&fiber->cont);
1142 RUBY_MARK_LEAVE(
"cont");
1146fiber_free(
void *ptr)
1149 RUBY_FREE_ENTER(
"fiber");
1151 if (DEBUG) fprintf(stderr,
"fiber_free: %p[%p]\n", (
void *)fiber, fiber->stack.base);
1153 if (fiber->cont.saved_ec.local_storage) {
1154 rb_id_table_free(fiber->cont.saved_ec.local_storage);
1157 cont_free(&fiber->cont);
1158 RUBY_FREE_LEAVE(
"fiber");
1162fiber_memsize(
const void *ptr)
1165 size_t size =
sizeof(*fiber);
1167 const rb_thread_t *th = rb_ec_thread_ptr(saved_ec);
1172 if (saved_ec->local_storage && fiber != th->root_fiber) {
1173 size += rb_id_table_memsize(saved_ec->local_storage);
1174 size += rb_obj_memsize_of(saved_ec->storage);
1177 size += cont_memsize(&fiber->cont);
1192 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
1194 if (th->ec->machine.stack_start > th->ec->machine.stack_end) {
1195 size = cont->machine.stack_size = th->ec->machine.stack_start - th->ec->machine.stack_end;
1196 cont->machine.stack_src = th->ec->machine.stack_end;
1199 size = cont->machine.stack_size = th->ec->machine.stack_end - th->ec->machine.stack_start;
1200 cont->machine.stack_src = th->ec->machine.stack_start;
1203 if (cont->machine.stack) {
1210 FLUSH_REGISTER_WINDOWS;
1211 asan_unpoison_memory_region(cont->machine.stack_src, size,
false);
1212 MEMCPY(cont->machine.stack, cont->machine.stack_src,
VALUE, size);
1217 {cont_mark, cont_free, cont_memsize, cont_compact},
1218 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
1226 VM_ASSERT(th->status == THREAD_RUNNABLE);
1233 sec->machine.stack_end = NULL;
1236static rb_nativethread_lock_t jit_cont_lock;
1254 if (first_jit_cont == NULL) {
1255 cont->next = cont->prev = NULL;
1259 cont->next = first_jit_cont;
1260 first_jit_cont->prev = cont;
1262 first_jit_cont = cont;
1275 if (cont == first_jit_cont) {
1276 first_jit_cont = cont->next;
1277 if (first_jit_cont != NULL)
1278 first_jit_cont->prev = NULL;
1281 cont->prev->next = cont->next;
1282 if (cont->next != NULL)
1283 cont->next->prev = cont->prev;
1292rb_jit_cont_each_iseq(rb_iseq_callback callback,
void *data)
1295 for (cont = first_jit_cont; cont != NULL; cont = cont->next) {
1296 if (cont->ec->vm_stack == NULL)
1300 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(cont->ec, cfp)) {
1301 if (cfp->pc && cfp->iseq && imemo_type((
VALUE)cfp->iseq) == imemo_iseq) {
1302 callback(cfp->iseq, data);
1304 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1313rb_yjit_cancel_jit_return(
void *leave_exit,
void *leave_exception)
1316 for (cont = first_jit_cont; cont != NULL; cont = cont->next) {
1317 if (cont->ec->vm_stack == NULL)
1321 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(cont->ec, cfp)) {
1322 if (cfp->jit_return && cfp->jit_return != leave_exception) {
1325 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1333rb_jit_cont_finish(
void)
1336 for (cont = first_jit_cont; cont != NULL; cont = next) {
1346 VM_ASSERT(cont->jit_cont == NULL);
1348 cont->jit_cont = jit_cont_new(&(cont->saved_ec));
1354 return &fiber->cont.saved_ec;
1361 cont_save_thread(cont, th);
1362 cont->saved_ec.thread_ptr = th;
1363 cont->saved_ec.local_storage = NULL;
1364 cont->saved_ec.local_storage_recursive_hash =
Qnil;
1365 cont->saved_ec.local_storage_recursive_hash_for_trace =
Qnil;
1366 cont_init_jit_cont(cont);
1370cont_new(
VALUE klass)
1373 volatile VALUE contval;
1376 THREAD_MUST_BE_RUNNING(th);
1378 cont->self = contval;
1379 cont_init(cont, th);
1386 return fiber->cont.self;
1392 return fiber->blocking;
1397rb_jit_cont_init(
void)
1406 VALUE *p = ec->vm_stack;
1407 while (p < ec->cfp->sp) {
1408 fprintf(stderr,
"%3d ", (
int)(p - ec->vm_stack));
1409 rb_obj_info_dump(*p);
1419 while (cfp != end_of_cfp) {
1422 pc = cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded;
1424 fprintf(stderr,
"%2d pc: %d\n", i++, pc);
1425 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1431cont_capture(
volatile int *
volatile stat)
1435 volatile VALUE contval;
1438 THREAD_MUST_BE_RUNNING(th);
1439 rb_vm_stack_to_heap(th->ec);
1440 cont = cont_new(rb_cContinuation);
1441 contval = cont->self;
1443#ifdef CAPTURE_JUST_VALID_VM_STACK
1444 cont->saved_vm_stack.slen = ec->cfp->sp - ec->vm_stack;
1445 cont->saved_vm_stack.clen = ec->vm_stack + ec->vm_stack_size - (
VALUE*)ec->cfp;
1446 cont->saved_vm_stack.ptr =
ALLOC_N(
VALUE, cont->saved_vm_stack.slen + cont->saved_vm_stack.clen);
1447 MEMCPY(cont->saved_vm_stack.ptr,
1449 VALUE, cont->saved_vm_stack.slen);
1450 MEMCPY(cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen,
1453 cont->saved_vm_stack.clen);
1455 cont->saved_vm_stack.ptr =
ALLOC_N(
VALUE, ec->vm_stack_size);
1456 MEMCPY(cont->saved_vm_stack.ptr, ec->vm_stack,
VALUE, ec->vm_stack_size);
1459 rb_ec_set_vm_stack(&cont->saved_ec, NULL, 0);
1460 VM_ASSERT(cont->saved_ec.cfp != NULL);
1461 cont_save_machine_stack(th, cont);
1468 for (p=th->ec->ensure_list; p; p=p->next)
1471 for (p=th->ec->ensure_list; p; p=p->next) {
1472 if (!p->entry.marker)
1473 p->entry.marker = rb_ary_hidden_new(0);
1474 *entry++ = p->entry;
1479 if (ruby_setjmp(cont->jmpbuf)) {
1482 VAR_INITIALIZED(cont);
1483 value = cont->value;
1484 if (cont->argc == -1) rb_exc_raise(value);
1501 if (cont->type == CONTINUATION_CONTEXT) {
1506 if (sec->fiber_ptr != NULL) {
1507 fiber = sec->fiber_ptr;
1509 else if (th->root_fiber) {
1510 fiber = th->root_fiber;
1513 if (fiber && th->ec != &fiber->cont.saved_ec) {
1514 ec_switch(th, fiber);
1517 if (th->ec->trace_arg != sec->trace_arg) {
1522#ifdef CAPTURE_JUST_VALID_VM_STACK
1524 cont->saved_vm_stack.ptr,
1525 VALUE, cont->saved_vm_stack.slen);
1526 MEMCPY(th->ec->vm_stack + th->ec->vm_stack_size - cont->saved_vm_stack.clen,
1527 cont->saved_vm_stack.ptr + cont->saved_vm_stack.slen,
1528 VALUE, cont->saved_vm_stack.clen);
1530 MEMCPY(th->ec->vm_stack, cont->saved_vm_stack.ptr,
VALUE, sec->vm_stack_size);
1534 th->ec->cfp = sec->cfp;
1535 th->ec->raised_flag = sec->raised_flag;
1536 th->ec->tag = sec->tag;
1537 th->ec->root_lep = sec->root_lep;
1538 th->ec->root_svar = sec->root_svar;
1539 th->ec->ensure_list = sec->ensure_list;
1540 th->ec->errinfo = sec->errinfo;
1542 VM_ASSERT(th->ec->vm_stack != NULL);
1558 if (!FIBER_TERMINATED_P(old_fiber)) {
1559 STACK_GROW_DIR_DETECTION;
1560 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
1561 if (STACK_DIR_UPPER(0, 1)) {
1562 old_fiber->cont.machine.stack_size = th->ec->machine.stack_start - th->ec->machine.stack_end;
1563 old_fiber->cont.machine.stack = th->ec->machine.stack_end;
1566 old_fiber->cont.machine.stack_size = th->ec->machine.stack_end - th->ec->machine.stack_start;
1567 old_fiber->cont.machine.stack = th->ec->machine.stack_start;
1572 old_fiber->cont.saved_ec.machine.stack_start = th->ec->machine.stack_start;
1575 old_fiber->cont.saved_ec.machine.stack_end = NULL;
1579#if defined(COROUTINE_SANITIZE_ADDRESS)
1580 __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);
1584 struct coroutine_context * from = coroutine_transfer(&old_fiber->context, &new_fiber->context);
1586#if defined(COROUTINE_SANITIZE_ADDRESS)
1587 __sanitizer_finish_switch_fiber(old_fiber->context.fake_stack, NULL, NULL);
1595 fiber_restore_thread(th, old_fiber);
1601NOINLINE(NORETURN(
static void cont_restore_1(
rb_context_t *)));
1606 cont_restore_thread(cont);
1609#if defined(_M_AMD64) && !defined(__MINGW64__)
1614 _JUMP_BUFFER *bp = (
void*)&cont->jmpbuf;
1615 bp->Frame = ((_JUMP_BUFFER*)((
void*)&buf))->Frame;
1618 if (cont->machine.stack_src) {
1619 FLUSH_REGISTER_WINDOWS;
1620 MEMCPY(cont->machine.stack_src, cont->machine.stack,
1621 VALUE, cont->machine.stack_size);
1624 ruby_longjmp(cont->jmpbuf, 1);
1632 if (cont->machine.stack_src) {
1634#define STACK_PAD_SIZE 1
1636#define STACK_PAD_SIZE 1024
1638 VALUE space[STACK_PAD_SIZE];
1640#if !STACK_GROW_DIRECTION
1641 if (addr_in_prev_frame > &space[0]) {
1644#if STACK_GROW_DIRECTION <= 0
1645 volatile VALUE *
const end = cont->machine.stack_src;
1646 if (&space[0] > end) {
1655 cont_restore_0(cont, &space[0]);
1659#if !STACK_GROW_DIRECTION
1664#if STACK_GROW_DIRECTION >= 0
1665 volatile VALUE *
const end = cont->machine.stack_src + cont->machine.stack_size;
1666 if (&space[STACK_PAD_SIZE] < end) {
1671 cont_restore_0(cont, &space[STACK_PAD_SIZE-1]);
1675#if !STACK_GROW_DIRECTION
1679 cont_restore_1(cont);
1766rb_callcc(
VALUE self)
1768 volatile int called;
1769 volatile VALUE val = cont_capture(&called);
1780make_passing_arg(
int argc,
const VALUE *argv)
1799ruby_register_rollback_func_for_ensure(e_proc *ensure_func, e_proc *rollback_func)
1801 st_table **table_p = &GET_VM()->ensure_rollback_table;
1802 if (UNLIKELY(*table_p == NULL)) {
1803 *table_p = st_init_numtable();
1805 st_insert(*table_p, (st_data_t)ensure_func, (st_data_t)rollback_func);
1808static inline e_proc *
1809lookup_rollback_func(e_proc *ensure_func)
1811 st_table *table = GET_VM()->ensure_rollback_table;
1813 if (table && st_lookup(table, (st_data_t)ensure_func, &val))
1814 return (e_proc *) val;
1815 return (e_proc *)
Qundef;
1831 for (p=current; p; p=p->next)
1834 for (entry=target; entry->marker; entry++)
1839 base_point = cur_size;
1840 while (base_point) {
1841 if (target_size >= base_point &&
1842 p->entry.marker == target[target_size - base_point].marker)
1849 for (i=0; i < target_size - base_point; i++) {
1850 if (!lookup_rollback_func(target[i].e_proc)) {
1851 rb_raise(
rb_eRuntimeError,
"continuation called from out of critical rb_ensure scope");
1855 while (cur_size > base_point) {
1857 (*current->entry.e_proc)(current->entry.data2);
1858 current = current->next;
1862 for (j = 0; j < i; j++) {
1863 func = lookup_rollback_func(target[i - j - 1].e_proc);
1864 if (!UNDEF_P((
VALUE)func)) {
1865 (*func)(target[i - j - 1].data2);
1870NORETURN(
static VALUE rb_cont_call(
int argc,
VALUE *argv,
VALUE contval));
1888rb_cont_call(
int argc,
VALUE *argv,
VALUE contval)
1893 if (cont_thread_value(cont) != th->self) {
1896 if (cont->saved_ec.fiber_ptr) {
1897 if (th->ec->fiber_ptr != cont->saved_ec.fiber_ptr) {
1901 rollback_ensure_stack(contval, th->ec->ensure_list, cont->ensure_array);
1904 cont->value = make_passing_arg(argc, argv);
1906 cont_restore_0(cont, &contval);
1999 {fiber_mark, fiber_free, fiber_memsize, fiber_compact,},
2000 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
2004fiber_alloc(
VALUE klass)
2010fiber_t_alloc(
VALUE fiber_value,
unsigned int blocking)
2019 THREAD_MUST_BE_RUNNING(th);
2021 fiber->cont.self = fiber_value;
2022 fiber->cont.type = FIBER_CONTEXT;
2023 fiber->blocking = blocking;
2025 cont_init(&fiber->cont, th);
2027 fiber->cont.saved_ec.fiber_ptr = fiber;
2028 rb_ec_clear_vm_stack(&fiber->cont.saved_ec);
2034 VM_ASSERT(FIBER_CREATED_P(fiber));
2044 VALUE fiber_value = fiber_alloc(rb_cFiber);
2047 VM_ASSERT(
DATA_PTR(fiber_value) == NULL);
2048 VM_ASSERT(fiber->cont.type == FIBER_CONTEXT);
2049 VM_ASSERT(FIBER_RESUMED_P(fiber));
2051 th->root_fiber = fiber;
2053 fiber->cont.self = fiber_value;
2055 coroutine_initialize_main(&fiber->context);
2064 if (ec->fiber_ptr->cont.self == 0) {
2065 root_fiber_alloc(rb_ec_thread_ptr(ec));
2067 return ec->fiber_ptr;
2071current_fiber_storage(
void)
2078inherit_fiber_storage(
void)
2086 fiber->cont.saved_ec.storage = storage;
2090fiber_storage_get(
rb_fiber_t *fiber,
int allocate)
2092 VALUE storage = fiber->cont.saved_ec.storage;
2093 if (storage ==
Qnil && allocate) {
2094 storage = rb_hash_new();
2095 fiber_storage_set(fiber, storage);
2101storage_access_must_be_from_same_fiber(
VALUE self)
2105 if (fiber != current) {
2106 rb_raise(rb_eArgError,
"Fiber storage can only be accessed from the Fiber it belongs to");
2117rb_fiber_storage_get(
VALUE self)
2119 storage_access_must_be_from_same_fiber(self);
2121 VALUE storage = fiber_storage_get(fiber_ptr(self), FALSE);
2123 if (storage ==
Qnil) {
2140fiber_storage_validate(
VALUE value)
2143 if (value ==
Qnil)
return;
2145 if (!RB_TYPE_P(value,
T_HASH)) {
2149 if (RB_OBJ_FROZEN(value)) {
2183 "Fiber#storage= is experimental and may be removed in the future!");
2186 storage_access_must_be_from_same_fiber(self);
2187 fiber_storage_validate(value);
2189 fiber_ptr(self)->cont.saved_ec.storage =
rb_obj_dup(value);
2208 VALUE storage = fiber_storage_get(fiber_current(), FALSE);
2211 return rb_hash_aref(storage, key);
2229 VALUE storage = fiber_storage_get(fiber_current(), value !=
Qnil);
2232 if (value ==
Qnil) {
2233 return rb_hash_delete(storage, key);
2236 return rb_hash_aset(storage, key, value);
2245 storage = inherit_fiber_storage();
2248 fiber_storage_validate(storage);
2252 rb_fiber_t *fiber = fiber_t_alloc(self, blocking);
2254 fiber->cont.saved_ec.storage = storage;
2255 fiber->first_proc = proc;
2256 fiber->stack.base = NULL;
2268 size_t vm_stack_size = 0;
2269 VALUE *vm_stack = fiber_initialize_coroutine(fiber, &vm_stack_size);
2272 cont->saved_vm_stack.ptr = NULL;
2273 rb_ec_initialize_vm_stack(sec, vm_stack, vm_stack_size /
sizeof(
VALUE));
2276 sec->local_storage = NULL;
2277 sec->local_storage_recursive_hash =
Qnil;
2278 sec->local_storage_recursive_hash_for_trace =
Qnil;
2282rb_fiber_pool_default(
VALUE pool)
2284 return &shared_fiber_pool;
2290 fiber->cont.saved_ec.storage = storage;
2296rb_fiber_initialize_kw(
int argc,
VALUE* argv,
VALUE self,
int kw_splat)
2307 rb_get_kwargs(options, fiber_initialize_keywords, 0, 3, arguments);
2309 if (!UNDEF_P(arguments[0])) {
2310 blocking = arguments[0];
2313 if (!UNDEF_P(arguments[1])) {
2314 pool = arguments[1];
2317 storage = arguments[2];
2320 return fiber_initialize(self,
rb_block_proc(), rb_fiber_pool_default(pool),
RTEST(blocking), storage);
2373rb_fiber_initialize(
int argc,
VALUE* argv,
VALUE self)
2381 return fiber_initialize(fiber_alloc(rb_cFiber),
rb_proc_new(func, obj), rb_fiber_pool_default(
Qnil), 0, storage);
2387 return rb_fiber_new_storage(func, obj,
Qtrue);
2391rb_fiber_s_schedule_kw(
int argc,
VALUE* argv,
int kw_splat)
2394 VALUE scheduler = th->scheduler;
2397 if (scheduler !=
Qnil) {
2449rb_fiber_s_schedule(
int argc,
VALUE *argv,
VALUE obj)
2465rb_fiber_s_scheduler(
VALUE klass)
2479rb_fiber_current_scheduler(
VALUE klass)
2501rb_fiber_set_scheduler(
VALUE klass,
VALUE scheduler)
2506NORETURN(
static void rb_fiber_terminate(
rb_fiber_t *fiber,
int need_interrupt,
VALUE err));
2511 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2514 enum ruby_tag_type state;
2516 VM_ASSERT(th->ec == GET_EC());
2517 VM_ASSERT(FIBER_RESUMED_P(fiber));
2519 if (fiber->blocking) {
2523 EC_PUSH_TAG(th->ec);
2524 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2527 const VALUE *argv, args = cont->value;
2528 GetProcPtr(fiber->first_proc, proc);
2531 th->ec->errinfo =
Qnil;
2532 th->ec->root_lep = rb_vm_proc_local_ep(fiber->first_proc);
2533 th->ec->root_svar =
Qfalse;
2536 cont->value = rb_vm_invoke_proc(th->ec, proc, argc, argv, cont->kw_splat, VM_BLOCK_HANDLER_NONE);
2540 int need_interrupt = TRUE;
2543 err = th->ec->errinfo;
2544 VM_ASSERT(FIBER_RESUMED_P(fiber));
2546 if (state == TAG_RAISE) {
2549 else if (state == TAG_FATAL && err == RUBY_FATAL_FIBER_KILLED) {
2550 need_interrupt = FALSE;
2553 else if (state == TAG_FATAL) {
2554 rb_threadptr_pending_interrupt_enque(th, err);
2557 err = rb_vm_make_jump_tag_but_local_jump(state, err);
2561 rb_fiber_terminate(fiber, need_interrupt, err);
2570 rb_bug(
"%s", strerror(
errno));
2573 fiber->cont.type = FIBER_CONTEXT;
2574 fiber->cont.saved_ec.fiber_ptr = fiber;
2575 fiber->cont.saved_ec.thread_ptr = th;
2576 fiber->blocking = 1;
2578 fiber_status_set(fiber, FIBER_RESUMED);
2579 th->ec = &fiber->cont.saved_ec;
2580 cont_init_jit_cont(&fiber->cont);
2586 if (th->root_fiber) {
2592 VM_ASSERT(th->ec->fiber_ptr->cont.type == FIBER_CONTEXT);
2593 VM_ASSERT(th->ec->fiber_ptr->cont.self == 0);
2595 if (ec && th->ec == ec) {
2596 rb_ractor_set_current_ec(th->ractor, NULL);
2598 fiber_free(th->ec->fiber_ptr);
2608 fiber->status = FIBER_TERMINATED;
2611 rb_ec_clear_vm_stack(th->ec);
2615return_fiber(
bool terminate)
2622 prev->resuming_fiber = NULL;
2627 rb_raise(rb_eFiberError,
"attempt to yield on a not resumed fiber");
2633 VM_ASSERT(root_fiber != NULL);
2636 for (fiber = root_fiber; fiber->resuming_fiber; fiber = fiber->resuming_fiber) {
2644rb_fiber_current(
void)
2646 return fiber_current()->cont.self;
2655 if (th->ec->fiber_ptr != NULL) {
2656 fiber = th->ec->fiber_ptr;
2660 fiber = root_fiber_alloc(th);
2663 if (FIBER_CREATED_P(next_fiber)) {
2664 fiber_prepare_stack(next_fiber);
2667 VM_ASSERT(FIBER_RESUMED_P(fiber) || FIBER_TERMINATED_P(fiber));
2668 VM_ASSERT(FIBER_RUNNABLE_P(next_fiber));
2670 if (FIBER_RESUMED_P(fiber)) fiber_status_set(fiber, FIBER_SUSPENDED);
2672 fiber_status_set(next_fiber, FIBER_RESUMED);
2673 fiber_setcontext(next_fiber, fiber);
2679 VM_ASSERT(fiber == fiber_current());
2681 if (fiber->killed) {
2682 rb_thread_t *thread = fiber->cont.saved_ec.thread_ptr;
2684 thread->ec->errinfo = RUBY_FATAL_FIBER_KILLED;
2685 EC_JUMP_TAG(thread->ec, RUBY_TAG_FATAL);
2697 if (th->root_fiber == NULL) root_fiber_alloc(th);
2699 if (th->ec->fiber_ptr == fiber) {
2703 return make_passing_arg(argc, argv);
2706 if (cont_thread_value(cont) != th->self) {
2707 rb_raise(rb_eFiberError,
"fiber called across threads");
2710 if (FIBER_TERMINATED_P(fiber)) {
2711 value =
rb_exc_new2(rb_eFiberError,
"dead fiber called");
2713 if (!FIBER_TERMINATED_P(th->ec->fiber_ptr)) {
2714 rb_exc_raise(value);
2715 VM_UNREACHABLE(fiber_switch);
2721 VM_ASSERT(FIBER_SUSPENDED_P(th->root_fiber));
2723 cont = &th->root_fiber->cont;
2725 cont->value = value;
2727 fiber_setcontext(th->root_fiber, th->ec->fiber_ptr);
2729 VM_UNREACHABLE(fiber_switch);
2733 VM_ASSERT(FIBER_RUNNABLE_P(fiber));
2737 VM_ASSERT(!current_fiber->resuming_fiber);
2739 if (resuming_fiber) {
2740 current_fiber->resuming_fiber = resuming_fiber;
2741 fiber->prev = fiber_current();
2742 fiber->yielding = 0;
2745 VM_ASSERT(!current_fiber->yielding);
2747 current_fiber->yielding = 1;
2750 if (current_fiber->blocking) {
2755 cont->kw_splat = kw_splat;
2756 cont->value = make_passing_arg(argc, argv);
2758 fiber_store(fiber, th);
2761#ifndef COROUTINE_PTHREAD_CONTEXT
2762 if (resuming_fiber && FIBER_TERMINATED_P(fiber)) {
2763 fiber_stack_release(fiber);
2767 if (fiber_current()->blocking) {
2771 RUBY_VM_CHECK_INTS(th->ec);
2775 current_fiber = th->ec->fiber_ptr;
2776 value = current_fiber->cont.value;
2778 fiber_check_killed(current_fiber);
2780 if (current_fiber->cont.argc == -1) {
2782 rb_exc_raise(value);
2791 return fiber_switch(fiber_ptr(fiber_value), argc, argv,
RB_NO_KEYWORDS, NULL,
false);
2809rb_fiber_blocking_p(
VALUE fiber)
2811 return RBOOL(fiber_ptr(fiber)->blocking);
2815fiber_blocking_yield(
VALUE fiber_value)
2818 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2820 VM_ASSERT(fiber->blocking == 0);
2823 fiber->blocking = 1;
2832fiber_blocking_ensure(
VALUE fiber_value)
2835 rb_thread_t *
volatile th = fiber->cont.saved_ec.thread_ptr;
2838 fiber->blocking = 0;
2855rb_fiber_blocking(
VALUE class)
2857 VALUE fiber_value = rb_fiber_current();
2861 if (fiber->blocking) {
2865 return rb_ensure(fiber_blocking_yield, fiber_value, fiber_blocking_ensure, fiber_value);
2888rb_fiber_s_blocking_p(
VALUE klass)
2891 unsigned blocking = thread->blocking;
2902 fiber_status_set(fiber, FIBER_TERMINATED);
2908 VALUE value = fiber->cont.value;
2910 VM_ASSERT(FIBER_RESUMED_P(fiber));
2911 rb_fiber_close(fiber);
2913 fiber->cont.machine.stack = NULL;
2914 fiber->cont.machine.stack_size = 0;
2918 if (need_interrupt) RUBY_VM_SET_INTERRUPT(&next_fiber->cont.saved_ec);
2921 fiber_switch(next_fiber, -1, &error,
RB_NO_KEYWORDS, NULL,
false);
2923 fiber_switch(next_fiber, 1, &value,
RB_NO_KEYWORDS, NULL,
false);
2928fiber_resume_kw(
rb_fiber_t *fiber,
int argc,
const VALUE *argv,
int kw_splat)
2932 if (argc == -1 && FIBER_CREATED_P(fiber)) {
2933 rb_raise(rb_eFiberError,
"cannot raise exception on unborn fiber");
2935 else if (FIBER_TERMINATED_P(fiber)) {
2936 rb_raise(rb_eFiberError,
"attempt to resume a terminated fiber");
2938 else if (fiber == current_fiber) {
2939 rb_raise(rb_eFiberError,
"attempt to resume the current fiber");
2941 else if (fiber->prev != NULL) {
2942 rb_raise(rb_eFiberError,
"attempt to resume a resumed fiber (double resume)");
2944 else if (fiber->resuming_fiber) {
2945 rb_raise(rb_eFiberError,
"attempt to resume a resuming fiber");
2947 else if (fiber->prev == NULL &&
2948 (!fiber->yielding && fiber->status != FIBER_CREATED)) {
2949 rb_raise(rb_eFiberError,
"attempt to resume a transferring fiber");
2952 return fiber_switch(fiber, argc, argv, kw_splat, fiber,
false);
2956rb_fiber_resume_kw(
VALUE self,
int argc,
const VALUE *argv,
int kw_splat)
2958 return fiber_resume_kw(fiber_ptr(self), argc, argv, kw_splat);
2964 return fiber_resume_kw(fiber_ptr(self), argc, argv,
RB_NO_KEYWORDS);
2968rb_fiber_yield_kw(
int argc,
const VALUE *argv,
int kw_splat)
2970 return fiber_switch(return_fiber(
false), argc, argv, kw_splat, NULL,
true);
2974rb_fiber_yield(
int argc,
const VALUE *argv)
2976 return fiber_switch(return_fiber(
false), argc, argv,
RB_NO_KEYWORDS, NULL,
true);
2982 if (th->root_fiber && th->root_fiber != th->ec->fiber_ptr) {
2983 th->ec->local_storage = th->root_fiber->cont.saved_ec.local_storage;
2998 return RBOOL(!FIBER_TERMINATED_P(fiber_ptr(fiber_value)));
3017rb_fiber_m_resume(
int argc,
VALUE *argv,
VALUE fiber)
3069rb_fiber_backtrace(
int argc,
VALUE *argv,
VALUE fiber)
3071 return rb_vm_backtrace(argc, argv, &fiber_ptr(fiber)->cont.saved_ec);
3094rb_fiber_backtrace_locations(
int argc,
VALUE *argv,
VALUE fiber)
3096 return rb_vm_backtrace_locations(argc, argv, &fiber_ptr(fiber)->cont.saved_ec);
3182rb_fiber_m_transfer(
int argc,
VALUE *argv,
VALUE self)
3188fiber_transfer_kw(
rb_fiber_t *fiber,
int argc,
const VALUE *argv,
int kw_splat)
3190 if (fiber->resuming_fiber) {
3191 rb_raise(rb_eFiberError,
"attempt to transfer to a resuming fiber");
3194 if (fiber->yielding) {
3195 rb_raise(rb_eFiberError,
"attempt to transfer to a yielding fiber");
3198 return fiber_switch(fiber, argc, argv, kw_splat, NULL,
false);
3202rb_fiber_transfer_kw(
VALUE self,
int argc,
const VALUE *argv,
int kw_splat)
3204 return fiber_transfer_kw(fiber_ptr(self), argc, argv, kw_splat);
3218rb_fiber_s_yield(
int argc,
VALUE *argv,
VALUE klass)
3226 if (fiber == fiber_current()) {
3227 rb_exc_raise(exception);
3229 else if (fiber->resuming_fiber) {
3230 return fiber_raise(fiber->resuming_fiber, exception);
3232 else if (FIBER_SUSPENDED_P(fiber) && !fiber->yielding) {
3243 VALUE exception = rb_make_exception(argc, argv);
3245 return fiber_raise(fiber_ptr(fiber), exception);
3272rb_fiber_m_raise(
int argc,
VALUE *argv,
VALUE self)
3274 return rb_fiber_raise(self, argc, argv);
3295rb_fiber_m_kill(
VALUE self)
3299 if (fiber->killed)
return Qfalse;
3302 if (fiber->status == FIBER_CREATED) {
3303 fiber->status = FIBER_TERMINATED;
3305 else if (fiber->status != FIBER_TERMINATED) {
3306 if (fiber_current() == fiber) {
3307 fiber_check_killed(fiber);
3309 fiber_raise(fiber_ptr(self),
Qnil);
3324rb_fiber_s_current(
VALUE klass)
3326 return rb_fiber_current();
3330fiber_to_s(
VALUE fiber_value)
3332 const rb_fiber_t *fiber = fiber_ptr(fiber_value);
3334 char status_info[0x20];
3336 if (fiber->resuming_fiber) {
3337 snprintf(status_info, 0x20,
" (%s by resuming)", fiber_status_name(fiber->status));
3340 snprintf(status_info, 0x20,
" (%s)", fiber_status_name(fiber->status));
3345 strlcat(status_info,
">",
sizeof(status_info));
3346 rb_str_set_len(str, RSTRING_LEN(str)-1);
3350 GetProcPtr(fiber->first_proc, proc);
3351 return rb_block_to_s(fiber_value, &proc->block, status_info);
3354#ifdef HAVE_WORKING_FORK
3358 if (th->root_fiber) {
3359 if (&th->root_fiber->cont.saved_ec != th->ec) {
3360 th->root_fiber = th->ec->fiber_ptr;
3362 th->root_fiber->prev = 0;
3367#ifdef RB_EXPERIMENTAL_FIBER_POOL
3369fiber_pool_free(
void *ptr)
3372 RUBY_FREE_ENTER(
"fiber_pool");
3374 fiber_pool_allocation_free(
fiber_pool->allocations);
3377 RUBY_FREE_LEAVE(
"fiber_pool");
3381fiber_pool_memsize(
const void *ptr)
3384 size_t size =
sizeof(*fiber_pool);
3393 {NULL, fiber_pool_free, fiber_pool_memsize,},
3394 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3398fiber_pool_alloc(
VALUE klass)
3406rb_fiber_pool_initialize(
int argc,
VALUE* argv,
VALUE self)
3413 rb_scan_args(argc, argv,
"03", &size, &count, &vm_stack_size);
3416 size =
SIZET2NUM(th->vm->default_params.fiber_machine_stack_size);
3423 if (
NIL_P(vm_stack_size)) {
3424 vm_stack_size =
SIZET2NUM(th->vm->default_params.fiber_vm_stack_size);
3452 size_t vm_stack_size = th->vm->default_params.fiber_vm_stack_size;
3453 size_t machine_stack_size = th->vm->default_params.fiber_machine_stack_size;
3454 size_t stack_size = machine_stack_size + vm_stack_size;
3458 GetSystemInfo(&info);
3459 pagesize = info.dwPageSize;
3461 pagesize = sysconf(_SC_PAGESIZE);
3463 SET_MACHINE_STACK_END(&th->ec->machine.stack_end);
3465 fiber_pool_initialize(&shared_fiber_pool, stack_size, FIBER_POOL_INITIAL_SIZE, vm_stack_size);
3471 const char *fiber_shared_fiber_pool_free_stacks = getenv(
"RUBY_SHARED_FIBER_POOL_FREE_STACKS");
3472 if (fiber_shared_fiber_pool_free_stacks) {
3473 shared_fiber_pool.free_stacks = atoi(fiber_shared_fiber_pool_free_stacks);
3475 if (shared_fiber_pool.free_stacks < 0) {
3476 rb_warn(
"Setting RUBY_SHARED_FIBER_POOL_FREE_STACKS to a negative value is not allowed.");
3477 shared_fiber_pool.free_stacks = 0;
3480 if (shared_fiber_pool.free_stacks > 1) {
3481 rb_warn(
"Setting RUBY_SHARED_FIBER_POOL_FREE_STACKS to a value greater than 1 is operating system specific, and may cause crashes.");
3502 rb_define_method(rb_cFiber,
"backtrace_locations", rb_fiber_backtrace_locations, -1);
3515#ifdef RB_EXPERIMENTAL_FIBER_POOL
3518 rb_define_method(rb_cFiberPool,
"initialize", rb_fiber_pool_initialize, -1);
3524RUBY_SYMBOL_EXPORT_BEGIN
3527ruby_Init_Continuation_body(
void)
3537RUBY_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.
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.
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.
#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_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 MEMZERO(p, type, n)
Handy macro to erase a region of memory.
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.