8#include "eval_intern.h"
10#include "ractor_core.h"
11#include "internal/complex.h"
12#include "internal/error.h"
13#include "internal/gc.h"
14#include "internal/hash.h"
15#include "internal/ractor.h"
16#include "internal/rational.h"
17#include "internal/struct.h"
18#include "internal/thread.h"
24static VALUE rb_cRactorSelector;
26VALUE rb_eRactorUnsafeError;
27VALUE rb_eRactorIsolationError;
28static VALUE rb_eRactorError;
29static VALUE rb_eRactorRemoteError;
30static VALUE rb_eRactorMovedError;
31static VALUE rb_eRactorClosedError;
32static VALUE rb_cRactorMovedObject;
34static void vm_ractor_blocking_cnt_inc(rb_vm_t *vm, rb_ractor_t *r,
const char *file,
int line);
39ASSERT_ractor_unlocking(rb_ractor_t *r)
41#if RACTOR_CHECK_MODE > 0
43 if (rb_current_execution_context(
false) != NULL && r->sync.locked_by == rb_ractor_self(GET_RACTOR())) {
44 rb_bug(
"recursive ractor locking");
50ASSERT_ractor_locking(rb_ractor_t *r)
52#if RACTOR_CHECK_MODE > 0
54 if (rb_current_execution_context(
false) != NULL && r->sync.locked_by != rb_ractor_self(GET_RACTOR())) {
55 rp(r->sync.locked_by);
56 rb_bug(
"ractor lock is not acquired.");
62ractor_lock(rb_ractor_t *r,
const char *file,
int line)
64 RUBY_DEBUG_LOG2(file, line,
"locking r:%u%s", r->pub.id, rb_current_ractor_raw(
false) == r ?
" (self)" :
"");
66 ASSERT_ractor_unlocking(r);
69#if RACTOR_CHECK_MODE > 0
70 if (rb_current_execution_context(
false) != NULL) {
71 rb_ractor_t *cr = rb_current_ractor_raw(
false);
72 r->sync.locked_by = cr ? rb_ractor_self(cr) :
Qundef;
76 RUBY_DEBUG_LOG2(file, line,
"locked r:%u%s", r->pub.id, rb_current_ractor_raw(
false) == r ?
" (self)" :
"");
80ractor_lock_self(rb_ractor_t *cr,
const char *file,
int line)
82 VM_ASSERT(cr == GET_RACTOR());
83#if RACTOR_CHECK_MODE > 0
84 VM_ASSERT(cr->sync.locked_by != cr->pub.self);
86 ractor_lock(cr, file, line);
90ractor_unlock(rb_ractor_t *r,
const char *file,
int line)
92 ASSERT_ractor_locking(r);
93#if RACTOR_CHECK_MODE > 0
94 r->sync.locked_by =
Qnil;
98 RUBY_DEBUG_LOG2(file, line,
"r:%u%s", r->pub.id, rb_current_ractor_raw(
false) == r ?
" (self)" :
"");
102ractor_unlock_self(rb_ractor_t *cr,
const char *file,
int line)
104 VM_ASSERT(cr == GET_RACTOR());
105#if RACTOR_CHECK_MODE > 0
106 VM_ASSERT(cr->sync.locked_by == cr->pub.self);
108 ractor_unlock(cr, file, line);
111#define RACTOR_LOCK(r) ractor_lock(r, __FILE__, __LINE__)
112#define RACTOR_UNLOCK(r) ractor_unlock(r, __FILE__, __LINE__)
113#define RACTOR_LOCK_SELF(r) ractor_lock_self(r, __FILE__, __LINE__)
114#define RACTOR_UNLOCK_SELF(r) ractor_unlock_self(r, __FILE__, __LINE__)
117rb_ractor_lock_self(rb_ractor_t *r)
123rb_ractor_unlock_self(rb_ractor_t *r)
125 RACTOR_UNLOCK_SELF(r);
131ractor_status_str(
enum ractor_status status)
134 case ractor_created:
return "created";
135 case ractor_running:
return "running";
136 case ractor_blocking:
return "blocking";
137 case ractor_terminated:
return "terminated";
139 rb_bug(
"unreachable");
143ractor_status_set(rb_ractor_t *r,
enum ractor_status status)
145 RUBY_DEBUG_LOG(
"r:%u [%s]->[%s]", r->pub.id, ractor_status_str(r->status_), ractor_status_str(status));
148 if (r->status_ != ractor_created) {
149 VM_ASSERT(r == GET_RACTOR());
154 switch (r->status_) {
156 VM_ASSERT(status == ractor_blocking);
159 VM_ASSERT(status == ractor_blocking||
160 status == ractor_terminated);
162 case ractor_blocking:
163 VM_ASSERT(status == ractor_running);
165 case ractor_terminated:
166 rb_bug(
"unreachable");
174ractor_status_p(rb_ractor_t *r,
enum ractor_status status)
176 return rb_ractor_status_p(r, status);
182static void ractor_local_storage_mark(rb_ractor_t *r);
183static void ractor_local_storage_free(rb_ractor_t *r);
188 for (
int i=0; i<rq->cnt; i++) {
190 rb_gc_mark(b->sender);
193 case basket_type_yielding:
194 case basket_type_take_basket:
195 case basket_type_deleted:
196 case basket_type_reserved:
200 rb_gc_mark(b->p.send.v);
206ractor_mark(
void *ptr)
208 rb_ractor_t *r = (rb_ractor_t *)ptr;
210 ractor_queue_mark(&r->sync.recv_queue);
211 ractor_queue_mark(&r->sync.takers_queue);
213 rb_gc_mark(r->receiving_mutex);
217 rb_gc_mark(r->r_stdin);
218 rb_gc_mark(r->r_stdout);
219 rb_gc_mark(r->r_stderr);
220 rb_gc_mark(r->verbose);
221 rb_gc_mark(r->debug);
222 rb_hook_list_mark(&r->pub.hooks);
224 if (r->threads.cnt > 0) {
226 ccan_list_for_each(&r->threads.set, th, lt_node) {
227 VM_ASSERT(th != NULL);
228 rb_gc_mark(th->self);
232 ractor_local_storage_mark(r);
242ractor_free(
void *ptr)
244 rb_ractor_t *r = (rb_ractor_t *)ptr;
245 RUBY_DEBUG_LOG(
"free r:%d", rb_ractor_id(r));
247#ifdef RUBY_THREAD_WIN32_H
250 ractor_queue_free(&r->sync.recv_queue);
251 ractor_queue_free(&r->sync.takers_queue);
252 ractor_local_storage_free(r);
253 rb_hook_list_free(&r->pub.hooks);
255 if (r->newobj_cache) {
258 rb_gc_ractor_cache_free(r->newobj_cache);
259 r->newobj_cache = NULL;
272ractor_memsize(
const void *ptr)
274 rb_ractor_t *r = (rb_ractor_t *)ptr;
277 return sizeof(rb_ractor_t) +
278 ractor_queue_memsize(&r->sync.recv_queue) +
279 ractor_queue_memsize(&r->sync.takers_queue);
290 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
304static inline rb_ractor_t *
305RACTOR_PTR(
VALUE self)
307 VM_ASSERT(rb_ractor_p(self));
314#if RACTOR_CHECK_MODE > 0
316rb_ractor_current_id(
void)
318 if (GET_THREAD()->ractor == NULL) {
322 return rb_ractor_id(GET_RACTOR());
341 if (r != NULL) ASSERT_ractor_locking(r);
342 return &rq->baskets[rq->start];
348 if (r != NULL) ASSERT_ractor_locking(r);
349 return &rq->baskets[(rq->start + i) % rq->size];
355 ASSERT_ractor_locking(r);
357 if (rq->reserved_cnt == 0) {
359 rq->start = (rq->start + 1) % rq->size;
363 ractor_queue_at(r, rq, 0)->type.e = basket_type_deleted;
371 return basket_type_p(b, basket_type_deleted) ||
372 basket_type_p(b, basket_type_reserved);
378 ASSERT_ractor_locking(r);
380 while (rq->cnt > 0 && basket_type_p(ractor_queue_at(r, rq, 0), basket_type_deleted)) {
381 ractor_queue_advance(r, rq);
388 ASSERT_ractor_locking(r);
394 ractor_queue_compact(r, rq);
396 for (
int i=0; i<rq->cnt; i++) {
397 if (!ractor_queue_skip_p(r, rq, i)) {
408 ASSERT_ractor_locking(r);
410 for (
int i=0; i<rq->cnt; i++) {
411 if (!ractor_queue_skip_p(r, rq, i)) {
416 b->type.e = basket_type_deleted;
417 ractor_queue_compact(r, rq);
428 ASSERT_ractor_locking(r);
430 if (rq->size <= rq->cnt) {
431 rq->baskets = realloc(rq->baskets,
sizeof(
struct rb_ractor_basket) * rq->size * 2);
432 for (
int i=rq->size - rq->start; i<rq->cnt; i++) {
433 rq->baskets[i + rq->start] = rq->baskets[i + rq->start - rq->size];
437 rq->baskets[(rq->start + rq->cnt++) % rq->size] = *basket;
444 basket->type.e = basket_type_deleted;
449static VALUE ractor_reset_belonging(
VALUE obj);
455 case basket_type_ref:
457 case basket_type_copy:
458 case basket_type_move:
459 case basket_type_will:
460 b->type.e = basket_type_ref;
461 b->p.send.v = ractor_reset_belonging(b->p.send.v);
464 rb_bug(
"unreachable");
473 VALUE v = ractor_basket_value(b);
475 if (b->p.send.exception) {
479 rb_ec_setup_exception(NULL, err, cause);
488#if USE_RUBY_DEBUG_LOG
490wait_status_str(
enum rb_ractor_wait_status wait_status)
492 switch ((
int)wait_status) {
493 case wait_none:
return "none";
494 case wait_receiving:
return "receiving";
495 case wait_taking:
return "taking";
496 case wait_yielding:
return "yielding";
497 case wait_receiving|wait_taking:
return "receiving|taking";
498 case wait_receiving|wait_yielding:
return "receiving|yielding";
499 case wait_taking|wait_yielding:
return "taking|yielding";
500 case wait_receiving|wait_taking|wait_yielding:
return "receiving|taking|yielding";
502 rb_bug(
"unreachable");
506wakeup_status_str(
enum rb_ractor_wakeup_status wakeup_status)
508 switch (wakeup_status) {
509 case wakeup_none:
return "none";
510 case wakeup_by_send:
return "by_send";
511 case wakeup_by_yield:
return "by_yield";
512 case wakeup_by_take:
return "by_take";
513 case wakeup_by_close:
return "by_close";
514 case wakeup_by_interrupt:
return "by_interrupt";
515 case wakeup_by_retry:
return "by_retry";
517 rb_bug(
"unreachable");
521basket_type_name(
enum rb_ractor_basket_type
type)
524 case basket_type_none:
return "none";
525 case basket_type_ref:
return "ref";
526 case basket_type_copy:
return "copy";
527 case basket_type_move:
return "move";
528 case basket_type_will:
return "will";
529 case basket_type_deleted:
return "deleted";
530 case basket_type_reserved:
return "reserved";
531 case basket_type_take_basket:
return "take_basket";
532 case basket_type_yielding:
return "yielding";
540ractor_sleeping_by(
const rb_ractor_t *r,
enum rb_ractor_wait_status wait_status)
542 return (r->sync.wait.status & wait_status) && r->sync.wait.wakeup_status == wakeup_none;
545#ifdef RUBY_THREAD_PTHREAD_H
547void rb_ractor_sched_wakeup(rb_ractor_t *r);
551rb_ractor_sched_wakeup(rb_ractor_t *r)
559ractor_wakeup(rb_ractor_t *r,
enum rb_ractor_wait_status wait_status,
enum rb_ractor_wakeup_status wakeup_status)
561 ASSERT_ractor_locking(r);
563 RUBY_DEBUG_LOG(
"r:%u wait_by:%s -> wait:%s wakeup:%s",
565 wait_status_str(r->sync.wait.status),
566 wait_status_str(wait_status),
567 wakeup_status_str(wakeup_status));
569 if (ractor_sleeping_by(r, wait_status)) {
570 r->sync.wait.wakeup_status = wakeup_status;
571 rb_ractor_sched_wakeup(r);
580ractor_sleep_interrupt(
void *ptr)
582 rb_ractor_t *r = ptr;
586 ractor_wakeup(r, wait_receiving | wait_taking | wait_yielding, wakeup_by_interrupt);
591typedef void (*ractor_sleep_cleanup_function)(rb_ractor_t *cr,
void *p);
594ractor_check_ints(rb_execution_context_t *ec, rb_ractor_t *cr, ractor_sleep_cleanup_function cf_func,
void *cf_data)
596 if (cr->sync.wait.status != wait_none) {
597 enum rb_ractor_wait_status prev_wait_status = cr->sync.wait.status;
598 cr->sync.wait.status = wait_none;
599 cr->sync.wait.wakeup_status = wakeup_by_interrupt;
604 enum ruby_tag_type state;
606 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
607 rb_ec_check_ints(ec);
612 (*cf_func)(cr, cf_data);
613 EC_JUMP_TAG(ec, state);
617 rb_ec_check_ints(ec);
623 cr->sync.wait.status = prev_wait_status;
627#ifdef RUBY_THREAD_PTHREAD_H
633ractor_cond_wait(rb_ractor_t *r)
635#if RACTOR_CHECK_MODE > 0
636 VALUE locked_by = r->sync.locked_by;
637 r->sync.locked_by =
Qnil;
641#if RACTOR_CHECK_MODE > 0
642 r->sync.locked_by = locked_by;
647ractor_sleep_wo_gvl(
void *ptr)
649 rb_ractor_t *cr = ptr;
650 RACTOR_LOCK_SELF(cr);
652 VM_ASSERT(cr->sync.wait.status != wait_none);
653 if (cr->sync.wait.wakeup_status == wakeup_none) {
654 ractor_cond_wait(cr);
656 cr->sync.wait.status = wait_none;
658 RACTOR_UNLOCK_SELF(cr);
675static enum rb_ractor_wakeup_status
676ractor_sleep_with_cleanup(rb_execution_context_t *ec, rb_ractor_t *cr,
enum rb_ractor_wait_status wait_status,
677 ractor_sleep_cleanup_function cf_func,
void *cf_data)
679 enum rb_ractor_wakeup_status wakeup_status;
680 VM_ASSERT(GET_RACTOR() == cr);
683 VM_ASSERT(cr->sync.wait.status == wait_none);
684 VM_ASSERT(wait_status != wait_none);
685 cr->sync.wait.status = wait_status;
686 cr->sync.wait.wakeup_status = wakeup_none;
691 RUBY_DEBUG_LOG(
"sleep by %s", wait_status_str(wait_status));
693 while (cr->sync.wait.wakeup_status == wakeup_none) {
694 rb_ractor_sched_sleep(ec, cr, ractor_sleep_interrupt);
695 ractor_check_ints(ec, cr, cf_func, cf_data);
698 cr->sync.wait.status = wait_none;
701 wakeup_status = cr->sync.wait.wakeup_status;
702 cr->sync.wait.wakeup_status = wakeup_none;
704 RUBY_DEBUG_LOG(
"wakeup %s", wakeup_status_str(wakeup_status));
706 return wakeup_status;
709static enum rb_ractor_wakeup_status
710ractor_sleep(rb_execution_context_t *ec, rb_ractor_t *cr,
enum rb_ractor_wait_status wait_status)
712 return ractor_sleep_with_cleanup(ec, cr, wait_status, 0, NULL);
718ractor_recursive_receive_if(rb_ractor_t *r)
720 if (r->receiving_mutex && rb_mutex_owned_p(r->receiving_mutex)) {
721 rb_raise(rb_eRactorError,
"can not call receive/receive_if recursively");
726ractor_try_receive(rb_execution_context_t *ec, rb_ractor_t *cr,
struct rb_ractor_queue *rq)
729 ractor_recursive_receive_if(cr);
730 bool received =
false;
732 RACTOR_LOCK_SELF(cr);
734 RUBY_DEBUG_LOG(
"rq->cnt:%d", rq->cnt);
735 received = ractor_queue_deq(cr, rq, &basket);
737 RACTOR_UNLOCK_SELF(cr);
740 if (cr->sync.incoming_port_closed) {
741 rb_raise(rb_eRactorClosedError,
"The incoming port is already closed");
746 return ractor_basket_accept(&basket);
751ractor_wait_receive(rb_execution_context_t *ec, rb_ractor_t *cr,
struct rb_ractor_queue *rq)
753 VM_ASSERT(cr == rb_ec_ractor_ptr(ec));
754 ractor_recursive_receive_if(cr);
758 while (ractor_queue_empty_p(cr, rq) && !cr->sync.incoming_port_closed) {
759 ractor_sleep(ec, cr, wait_receiving);
766ractor_receive(rb_execution_context_t *ec, rb_ractor_t *cr)
768 VM_ASSERT(cr == rb_ec_ractor_ptr(ec));
772 while (UNDEF_P(v = ractor_try_receive(ec, cr, rq))) {
773 ractor_wait_receive(ec, cr, rq);
784 for (
int i=0; i<rq->cnt; i++) {
786 fprintf(stderr,
"%d (start:%d) type:%s %p %s\n", i, rq->start, basket_type_name(b->type),
788 if (basket_type_p(b, basket_type_reserved) bug =
true;
790 if (bug) rb_bug(
"!!");
803ractor_receive_if_lock(rb_ractor_t *cr)
805 VALUE m = cr->receiving_mutex;
813receive_if_body(
VALUE ptr)
817 ractor_receive_if_lock(data->cr);
819 rb_ractor_t *cr = data->cr;
821 RACTOR_LOCK_SELF(cr);
824 VM_ASSERT(basket_type_p(b, basket_type_reserved));
825 data->rq->reserved_cnt--;
827 if (
RTEST(block_result)) {
828 ractor_queue_delete(cr, data->rq, b);
829 ractor_queue_compact(cr, data->rq);
832 b->type.e = basket_type_ref;
835 RACTOR_UNLOCK_SELF(cr);
837 data->success =
true;
839 if (
RTEST(block_result)) {
848receive_if_ensure(
VALUE v)
851 rb_ractor_t *cr = data->cr;
853 if (!data->success) {
854 RACTOR_LOCK_SELF(cr);
857 VM_ASSERT(basket_type_p(b, basket_type_reserved));
858 b->type.e = basket_type_deleted;
859 data->rq->reserved_cnt--;
861 RACTOR_UNLOCK_SELF(cr);
869ractor_receive_if(rb_execution_context_t *ec,
VALUE crv,
VALUE b)
871 if (!
RTEST(b)) rb_raise(rb_eArgError,
"no block given");
873 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
874 unsigned int serial = (
unsigned int)-1;
881 ractor_wait_receive(ec, cr, rq);
883 RACTOR_LOCK_SELF(cr);
885 if (serial != rq->serial) {
891 for (
int i=index; i<rq->cnt; i++) {
892 if (!ractor_queue_skip_p(cr, rq, i)) {
894 v = ractor_basket_value(b);
895 b->type.e = basket_type_reserved;
902 RACTOR_UNLOCK_SELF(cr);
914 receive_if_ensure, (
VALUE)&data);
916 if (!UNDEF_P(result))
return result;
920 RUBY_VM_CHECK_INTS(ec);
925ractor_send_basket(rb_execution_context_t *ec, rb_ractor_t *r,
struct rb_ractor_basket *b)
931 if (r->sync.incoming_port_closed) {
935 ractor_queue_enq(r, &r->sync.recv_queue, b);
936 ractor_wakeup(r, wait_receiving, wakeup_by_send);
942 rb_raise(rb_eRactorClosedError,
"The incoming-port is already closed");
952ractor_basket_prepare_contents(
VALUE obj,
VALUE move,
volatile VALUE *pobj,
enum rb_ractor_basket_type *ptype)
955 enum rb_ractor_basket_type
type;
958 type = basket_type_ref;
961 else if (!
RTEST(move)) {
962 v = ractor_copy(obj);
963 type = basket_type_copy;
966 type = basket_type_move;
967 v = ractor_move(obj);
977 VM_ASSERT(cr == GET_RACTOR());
979 basket->sender = cr->pub.self;
980 basket->p.send.exception = exc;
981 basket->p.send.v = obj;
988 enum rb_ractor_basket_type
type;
989 ractor_basket_prepare_contents(obj, move, &v, &
type);
990 ractor_basket_fill_(cr, basket, v, exc);
991 basket->type.e =
type;
997 ractor_basket_fill_(cr, basket, obj, exc);
998 basket->type.e = basket_type_will;
1002ractor_send(rb_execution_context_t *ec, rb_ractor_t *r,
VALUE obj,
VALUE move)
1006 ractor_basket_fill(rb_ec_ractor_ptr(ec), &basket, obj, move,
false);
1007 ractor_send_basket(ec, r, &basket);
1014ractor_take_has_will(rb_ractor_t *r)
1016 ASSERT_ractor_locking(r);
1018 return basket_type_p(&r->sync.will_basket, basket_type_will);
1024 ASSERT_ractor_locking(r);
1026 if (ractor_take_has_will(r)) {
1027 *b = r->sync.will_basket;
1028 r->sync.will_basket.type.e = basket_type_none;
1032 VM_ASSERT(basket_type_p(&r->sync.will_basket, basket_type_none));
1040 ASSERT_ractor_unlocking(r);
1045 taken = ractor_take_will(r, b);
1053ractor_register_take(rb_ractor_t *cr, rb_ractor_t *r,
struct rb_ractor_basket *take_basket,
1057 .type.e = basket_type_take_basket,
1058 .sender = cr->pub.self,
1061 .basket = take_basket,
1066 bool closed =
false;
1070 if (is_take && ractor_take_will(r, take_basket)) {
1071 RUBY_DEBUG_LOG(
"take over a will of r:%d", rb_ractor_id(r));
1073 else if (!is_take && ractor_take_has_will(r)) {
1074 RUBY_DEBUG_LOG(
"has_will");
1075 VM_ASSERT(config != NULL);
1076 config->closed =
true;
1078 else if (r->sync.outgoing_port_closed) {
1082 RUBY_DEBUG_LOG(
"register in r:%d", rb_ractor_id(r));
1083 ractor_queue_enq(r, &r->sync.takers_queue, &b);
1085 if (basket_none_p(take_basket)) {
1086 ractor_wakeup(r, wait_yielding, wakeup_by_take);
1093 if (!ignore_error) rb_raise(rb_eRactorClosedError,
"The outgoing-port is already closed");
1102ractor_deregister_take(rb_ractor_t *r,
struct rb_ractor_basket *take_basket)
1105 bool deleted =
false;
1109 if (r->sync.outgoing_port_closed) {
1113 for (
int i=0; i<ts->cnt; i++) {
1115 if (basket_type_p(b, basket_type_take_basket) && b->p.take.basket == take_basket) {
1116 ractor_queue_delete(r, ts, b);
1121 ractor_queue_compact(r, ts);
1131ractor_try_take(rb_ractor_t *cr, rb_ractor_t *r,
struct rb_ractor_basket *take_basket)
1135 RACTOR_LOCK_SELF(cr);
1137 if (basket_none_p(take_basket) || basket_type_p(take_basket, basket_type_yielding)) {
1144 RACTOR_UNLOCK_SELF(cr);
1147 RUBY_DEBUG_LOG(
"taken");
1148 if (basket_type_p(take_basket, basket_type_deleted)) {
1149 VM_ASSERT(r->sync.outgoing_port_closed);
1150 rb_raise(rb_eRactorClosedError,
"The outgoing-port is already closed");
1152 return ractor_basket_accept(take_basket);
1155 RUBY_DEBUG_LOG(
"not taken");
1161#if VM_CHECK_MODE > 0
1163ractor_check_specific_take_basket_lock(rb_ractor_t *r,
struct rb_ractor_basket *tb)
1170 for (
int i=0; i<ts->cnt; i++) {
1172 if (basket_type_p(b, basket_type_take_basket) && b->p.take.basket == tb) {
1185ractor_take_cleanup(rb_ractor_t *cr, rb_ractor_t *r,
struct rb_ractor_basket *tb)
1188 if (basket_none_p(tb)) {
1189 if (!ractor_deregister_take(r, tb)) {
1196 VM_ASSERT(!ractor_check_specific_take_basket_lock(r, tb));
1206ractor_wait_take_cleanup(rb_ractor_t *cr,
void *ptr)
1209 ractor_take_cleanup(cr, data->r, data->tb);
1213ractor_wait_take(rb_execution_context_t *ec, rb_ractor_t *cr, rb_ractor_t *r,
struct rb_ractor_basket *take_basket)
1220 RACTOR_LOCK_SELF(cr);
1222 if (basket_none_p(take_basket) || basket_type_p(take_basket, basket_type_yielding)) {
1223 ractor_sleep_with_cleanup(ec, cr, wait_taking, ractor_wait_take_cleanup, &data);
1226 RACTOR_UNLOCK_SELF(cr);
1230ractor_take(rb_execution_context_t *ec, rb_ractor_t *r)
1232 RUBY_DEBUG_LOG(
"from r:%u", rb_ractor_id(r));
1234 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
1237 .type.e = basket_type_none,
1241 ractor_register_take(cr, r, &take_basket,
true, NULL,
false);
1243 while (UNDEF_P(v = ractor_try_take(cr, r, &take_basket))) {
1244 ractor_wait_take(ec, cr, r, &take_basket);
1247 VM_ASSERT(!basket_none_p(&take_basket));
1248 VM_ASSERT(!ractor_check_specific_take_basket_lock(r, &take_basket));
1258 ASSERT_ractor_locking(cr);
1260 for (
int i=0; i<rs->cnt; i++) {
1262 if (basket_type_p(b, basket_type_take_basket) &&
1263 basket_none_p(b->p.take.basket)) {
1274 ASSERT_ractor_unlocking(cr);
1278 RACTOR_LOCK_SELF(cr);
1280 while (ractor_queue_deq(cr, rs, b)) {
1281 if (basket_type_p(b, basket_type_take_basket)) {
1284 if (
RUBY_ATOMIC_CAS(tb->type.atomic, basket_type_none, basket_type_yielding) == basket_type_none) {
1289 ractor_queue_enq(cr, rs, b);
1290 if (first_tb == NULL) first_tb = tb;
1292 VM_ASSERT(head != NULL);
1293 if (basket_type_p(head, basket_type_take_basket) && head->p.take.basket == first_tb) {
1299 VM_ASSERT(basket_none_p(b));
1303 if (found && b->p.take.config && !b->p.take.config->oneshot) {
1304 ractor_queue_enq(cr, rs, b);
1307 RACTOR_UNLOCK_SELF(cr);
1313ractor_try_yield(rb_execution_context_t *ec, rb_ractor_t *cr,
struct rb_ractor_queue *ts,
volatile VALUE obj,
VALUE move,
bool exc,
bool is_will)
1315 ASSERT_ractor_unlocking(cr);
1319 if (ractor_deq_take_basket(cr, ts, &b)) {
1320 VM_ASSERT(basket_type_p(&b, basket_type_take_basket));
1321 VM_ASSERT(basket_type_p(b.p.take.basket, basket_type_yielding));
1323 rb_ractor_t *
tr = RACTOR_PTR(b.sender);
1325 enum rb_ractor_basket_type
type;
1327 RUBY_DEBUG_LOG(
"basket from r:%u", rb_ractor_id(
tr));
1330 type = basket_type_will;
1333 enum ruby_tag_type state;
1337 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
1339 ractor_basket_prepare_contents(obj, move, &obj, &
type);
1344 RACTOR_LOCK_SELF(cr);
1346 b.p.take.basket->type.e = basket_type_none;
1347 ractor_queue_enq(cr, ts, &b);
1349 RACTOR_UNLOCK_SELF(cr);
1350 EC_JUMP_TAG(ec, state);
1356 VM_ASSERT(basket_type_p(tb, basket_type_yielding));
1358 RUBY_DEBUG_LOG(
"fill %sbasket from r:%u", is_will ?
"will " :
"", rb_ractor_id(
tr));
1359 ractor_basket_fill_(cr, tb, obj, exc);
1360 if (
RUBY_ATOMIC_CAS(tb->type.atomic, basket_type_yielding,
type) != basket_type_yielding) {
1361 rb_bug(
"unreachable");
1363 ractor_wakeup(
tr, wait_taking, wakeup_by_yield);
1369 else if (cr->sync.outgoing_port_closed) {
1370 rb_raise(rb_eRactorClosedError,
"The outgoing-port is already closed");
1373 RUBY_DEBUG_LOG(
"no take basket");
1379ractor_wait_yield(rb_execution_context_t *ec, rb_ractor_t *cr,
struct rb_ractor_queue *ts)
1381 RACTOR_LOCK_SELF(cr);
1383 while (!ractor_check_take_basket(cr, ts) && !cr->sync.outgoing_port_closed) {
1384 ractor_sleep(ec, cr, wait_yielding);
1387 RACTOR_UNLOCK_SELF(cr);
1391ractor_yield(rb_execution_context_t *ec, rb_ractor_t *cr,
VALUE obj,
VALUE move)
1395 while (!ractor_try_yield(ec, cr, ts, obj, move,
false,
false)) {
1396 ractor_wait_yield(ec, cr, ts);
1411ractor_selector_mark_ractors_i(st_data_t key, st_data_t value, st_data_t data)
1413 const rb_ractor_t *r = (rb_ractor_t *)key;
1414 rb_gc_mark(r->pub.self);
1419ractor_selector_mark(
void *ptr)
1423 if (s->take_ractors) {
1424 st_foreach(s->take_ractors, ractor_selector_mark_ractors_i, 0);
1427 switch (s->take_basket.type.e) {
1428 case basket_type_ref:
1429 case basket_type_copy:
1430 case basket_type_move:
1431 case basket_type_will:
1432 rb_gc_mark(s->take_basket.sender);
1433 rb_gc_mark(s->take_basket.p.send.v);
1441ractor_selector_release_i(st_data_t key, st_data_t val, st_data_t data)
1446 if (!config->closed) {
1447 ractor_deregister_take((rb_ractor_t *)key, &s->take_basket);
1454ractor_selector_free(
void *ptr)
1457 st_foreach(s->take_ractors, ractor_selector_release_i, (st_data_t)s);
1458 st_free_table(s->take_ractors);
1463ractor_selector_memsize(
const void *ptr)
1467 st_memsize(s->take_ractors) +
1474 ractor_selector_mark,
1475 ractor_selector_free,
1476 ractor_selector_memsize,
1479 0, 0, RUBY_TYPED_FREE_IMMEDIATELY,
1483RACTOR_SELECTOR_PTR(
VALUE selv)
1493ractor_selector_create(
VALUE klass)
1497 s->take_basket.type.e = basket_type_reserved;
1498 s->take_ractors = st_init_numtable();
1514 if (!rb_ractor_p(rv)) {
1515 rb_raise(rb_eArgError,
"Not a ractor object");
1518 rb_ractor_t *r = RACTOR_PTR(rv);
1521 if (st_lookup(s->take_ractors, (st_data_t)r, NULL)) {
1522 rb_raise(rb_eArgError,
"already added");
1526 VM_ASSERT(config != NULL);
1527 config->closed =
false;
1528 config->oneshot =
false;
1530 if (ractor_register_take(GET_RACTOR(), r, &s->take_basket,
false, config,
true)) {
1531 st_insert(s->take_ractors, (st_data_t)r, (st_data_t)config);
1548 if (!rb_ractor_p(rv)) {
1549 rb_raise(rb_eArgError,
"Not a ractor object");
1552 rb_ractor_t *r = RACTOR_PTR(rv);
1555 RUBY_DEBUG_LOG(
"r:%u", rb_ractor_id(r));
1557 if (!st_lookup(s->take_ractors, (st_data_t)r, NULL)) {
1558 rb_raise(rb_eArgError,
"not added yet");
1561 ractor_deregister_take(r, &s->take_basket);
1563 st_delete(s->take_ractors, (st_data_t *)&r, (st_data_t *)&config);
1573 rb_execution_context_t *ec;
1577ractor_selector_clear_i(st_data_t key, st_data_t val, st_data_t data)
1580 rb_ractor_t *r = (rb_ractor_t *)key;
1581 ractor_selector_remove(selv, r->pub.self);
1592ractor_selector_clear(
VALUE selv)
1596 st_foreach(s->take_ractors, ractor_selector_clear_i, (st_data_t)selv);
1597 st_clear(s->take_ractors);
1608ractor_selector_empty_p(
VALUE selv)
1611 return s->take_ractors->num_entries == 0 ?
Qtrue :
Qfalse;
1615ractor_selector_wait_i(st_data_t key, st_data_t val, st_data_t dat)
1617 rb_ractor_t *r = (rb_ractor_t *)key;
1621 if (!basket_none_p(tb)) {
1622 RUBY_DEBUG_LOG(
"already taken:%s", basket_type_name(tb->type.e));
1628 if (basket_type_p(&r->sync.will_basket, basket_type_will)) {
1629 RUBY_DEBUG_LOG(
"r:%u has will", rb_ractor_id(r));
1631 if (
RUBY_ATOMIC_CAS(tb->type.atomic, basket_type_none, basket_type_will) == basket_type_none) {
1632 ractor_take_will(r, tb);
1636 RUBY_DEBUG_LOG(
"has will, but already taken (%s)", basket_type_name(tb->type.e));
1640 else if (r->sync.outgoing_port_closed) {
1641 RUBY_DEBUG_LOG(
"r:%u is closed", rb_ractor_id(r));
1643 if (
RUBY_ATOMIC_CAS(tb->type.atomic, basket_type_none, basket_type_deleted) == basket_type_none) {
1644 tb->sender = r->pub.self;
1648 RUBY_DEBUG_LOG(
"closed, but already taken (%s)", basket_type_name(tb->type.e));
1653 RUBY_DEBUG_LOG(
"wakeup r:%u", rb_ractor_id(r));
1654 ractor_wakeup(r, wait_yielding, wakeup_by_take);
1666ractor_selector_wait_cleaup(rb_ractor_t *cr,
void *ptr)
1670 RACTOR_LOCK_SELF(cr);
1674 tb->type.e = basket_type_reserved;
1676 RACTOR_UNLOCK_SELF(cr);
1683 rb_execution_context_t *ec = GET_EC();
1687 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
1688 bool do_receive = !!
RTEST(do_receivev);
1689 bool do_yield = !!
RTEST(do_yieldv);
1691 enum rb_ractor_wait_status wait_status;
1695 RUBY_DEBUG_LOG(
"start");
1698 RUBY_DEBUG_LOG(
"takers:%ld", s->take_ractors->num_entries);
1701 wait_status = wait_none;
1702 if (s->take_ractors->num_entries > 0) wait_status |= wait_taking;
1703 if (do_receive) wait_status |= wait_receiving;
1704 if (do_yield) wait_status |= wait_yielding;
1706 RUBY_DEBUG_LOG(
"wait:%s", wait_status_str(wait_status));
1708 if (wait_status == wait_none) {
1709 rb_raise(rb_eRactorError,
"no taking ractors");
1713 if (do_receive && !UNDEF_P(ret_v = ractor_try_receive(ec, cr, rq))) {
1714 ret_r =
ID2SYM(rb_intern(
"receive"));
1719 if (do_yield && ractor_try_yield(ec, cr, ts, yield_value, move,
false,
false)) {
1721 ret_r =
ID2SYM(rb_intern(
"yield"));
1726 VM_ASSERT(basket_type_p(&s->take_basket, basket_type_reserved));
1727 s->take_basket.type.e = basket_type_none;
1729 st_foreach(s->take_ractors, ractor_selector_wait_i, (st_data_t)tb);
1731 RACTOR_LOCK_SELF(cr);
1735 if (!basket_none_p(tb)) {
1736 RUBY_DEBUG_LOG(
"taken:%s from r:%u", basket_type_name(tb->type.e),
1737 tb->sender ? rb_ractor_id(RACTOR_PTR(tb->sender)) : 0);
1740 if (do_receive && !ractor_queue_empty_p(cr, rq)) {
1741 RUBY_DEBUG_LOG(
"can receive (%d)", rq->cnt);
1744 if (do_yield && ractor_check_take_basket(cr, ts)) {
1745 RUBY_DEBUG_LOG(
"can yield");
1749 ractor_sleep_with_cleanup(ec, cr, wait_status, ractor_selector_wait_cleaup, tb);
1756 if (taken_basket.type.e == basket_type_yielding ||
1757 RUBY_ATOMIC_CAS(tb->type.atomic, taken_basket.type.e, basket_type_reserved) != taken_basket.type.e) {
1759 if (basket_type_p(tb, basket_type_yielding)) {
1760 RACTOR_UNLOCK_SELF(cr);
1764 RACTOR_LOCK_SELF(cr);
1769 RACTOR_UNLOCK_SELF(cr);
1772 switch (taken_basket.type.e) {
1773 case basket_type_none:
1774 VM_ASSERT(do_receive || do_yield);
1776 case basket_type_yielding:
1777 rb_bug(
"unreachable");
1778 case basket_type_deleted: {
1779 ractor_selector_remove(selv, taken_basket.sender);
1781 rb_ractor_t *r = RACTOR_PTR(taken_basket.sender);
1782 if (ractor_take_will_lock(r, &taken_basket)) {
1783 RUBY_DEBUG_LOG(
"has_will");
1786 RUBY_DEBUG_LOG(
"no will");
1793 case basket_type_will:
1795 ractor_selector_remove(selv, taken_basket.sender);
1801 RUBY_DEBUG_LOG(
"taken_basket:%s", basket_type_name(taken_basket.type.e));
1803 ret_v = ractor_basket_accept(&taken_basket);
1804 ret_r = taken_basket.sender;
1806 return rb_ary_new_from_args(2, ret_r, ret_v);
1816ractor_selector_wait(
int argc,
VALUE *argv,
VALUE selector)
1822 keywords[0] = rb_intern(
"receive");
1823 keywords[1] = rb_intern(
"yield_value");
1824 keywords[2] = rb_intern(
"move");
1827 rb_get_kwargs(options, keywords, 0, numberof(values), values);
1828 return ractor_selector__wait(selector,
1830 values[1] !=
Qundef, values[1], values[2]);
1834ractor_selector_new(
int argc,
VALUE *ractors,
VALUE klass)
1836 VALUE selector = ractor_selector_create(klass);
1838 for (
int i=0; i<argc; i++) {
1839 ractor_selector_add(selector, ractors[i]);
1853 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
1854 result = ractor_selector__wait(selector, do_receive, do_yield, yield_value, move);
1857 if (state != TAG_NONE) {
1859 ractor_selector_clear(selector);
1862 EC_JUMP_TAG(ec, state);
1872ractor_close_incoming(rb_execution_context_t *ec, rb_ractor_t *r)
1878 if (!r->sync.incoming_port_closed) {
1880 r->sync.incoming_port_closed =
true;
1881 if (ractor_wakeup(r, wait_receiving, wakeup_by_close)) {
1882 VM_ASSERT(ractor_queue_empty_p(r, &r->sync.recv_queue));
1883 RUBY_DEBUG_LOG(
"cancel receiving");
1897ractor_close_outgoing(rb_execution_context_t *ec, rb_ractor_t *r)
1907 if (!r->sync.outgoing_port_closed) {
1909 r->sync.outgoing_port_closed =
true;
1912 VM_ASSERT(ractor_queue_empty_p(r, ts));
1917 while (ractor_queue_deq(r, ts, &b)) {
1918 if (basket_type_p(&b, basket_type_take_basket)) {
1919 tr = RACTOR_PTR(b.sender);
1922 if (
RUBY_ATOMIC_CAS(tb->type.atomic, basket_type_none, basket_type_yielding) == basket_type_none) {
1923 b.p.take.basket->sender = r->pub.self;
1924 if (
RUBY_ATOMIC_CAS(tb->type.atomic, basket_type_yielding, basket_type_deleted) != basket_type_yielding) {
1925 rb_bug(
"unreachable");
1927 RUBY_DEBUG_LOG(
"set delete for r:%u", rb_ractor_id(RACTOR_PTR(b.sender)));
1930 if (b.p.take.config) {
1931 b.p.take.config->closed =
true;
1937 ractor_wakeup(
tr, wait_taking, wakeup_by_close);
1944 ractor_wakeup(r, wait_yielding, wakeup_by_close);
1946 VM_ASSERT(ractor_queue_empty_p(r, ts));
1965vm_insert_ractor0(rb_vm_t *vm, rb_ractor_t *r,
bool single_ractor_mode)
1967 RUBY_DEBUG_LOG(
"r:%u ractor.cnt:%u++", r->pub.id, vm->ractor.cnt);
1968 VM_ASSERT(single_ractor_mode || RB_VM_LOCKED_P());
1970 ccan_list_add_tail(&vm->ractor.set, &r->vmlr_node);
1973 if (r->newobj_cache) {
1974 VM_ASSERT(r == ruby_single_main_ractor);
1977 r->newobj_cache = rb_gc_ractor_cache_alloc(r);
1982cancel_single_ractor_mode(
void)
1985 RUBY_DEBUG_LOG(
"enable multi-ractor mode");
1995 ruby_single_main_ractor = NULL;
2000vm_insert_ractor(rb_vm_t *vm, rb_ractor_t *r)
2002 VM_ASSERT(ractor_status_p(r, ractor_created));
2004 if (rb_multi_ractor_p()) {
2007 vm_insert_ractor0(vm, r,
false);
2008 vm_ractor_blocking_cnt_inc(vm, r, __FILE__, __LINE__);
2013 if (vm->ractor.cnt == 0) {
2015 vm_insert_ractor0(vm, r,
true);
2016 ractor_status_set(r, ractor_blocking);
2017 ractor_status_set(r, ractor_running);
2020 cancel_single_ractor_mode();
2021 vm_insert_ractor0(vm, r,
true);
2022 vm_ractor_blocking_cnt_inc(vm, r, __FILE__, __LINE__);
2028vm_remove_ractor(rb_vm_t *vm, rb_ractor_t *cr)
2030 VM_ASSERT(ractor_status_p(cr, ractor_running));
2031 VM_ASSERT(vm->ractor.cnt > 1);
2032 VM_ASSERT(cr->threads.cnt == 1);
2036 RUBY_DEBUG_LOG(
"ractor.cnt:%u-- terminate_waiting:%d",
2037 vm->ractor.cnt, vm->ractor.sync.terminate_waiting);
2039 VM_ASSERT(vm->ractor.cnt > 0);
2040 ccan_list_del(&cr->vmlr_node);
2042 if (vm->ractor.cnt <= 2 && vm->ractor.sync.terminate_waiting) {
2047 rb_gc_ractor_cache_free(cr->newobj_cache);
2048 cr->newobj_cache = NULL;
2050 ractor_status_set(cr, ractor_terminated);
2056ractor_alloc(
VALUE klass)
2062 VM_ASSERT(ractor_status_p(r, ractor_created));
2067rb_ractor_main_alloc(
void)
2069 rb_ractor_t *r = ruby_mimcalloc(1,
sizeof(rb_ractor_t));
2071 fprintf(stderr,
"[FATAL] failed to allocate memory for main ractor\n");
2074 r->pub.id = ++ractor_last_id;
2078 r->newobj_cache = rb_gc_ractor_cache_alloc(r);
2079 ruby_single_main_ractor = r;
2084#if defined(HAVE_WORKING_FORK)
2086rb_ractor_atfork(rb_vm_t *vm, rb_thread_t *th)
2090 vm->ractor.blocking_cnt = 0;
2091 ruby_single_main_ractor = th->ractor;
2092 th->ractor->status_ = ractor_created;
2094 rb_ractor_living_threads_init(th->ractor);
2095 rb_ractor_living_threads_insert(th->ractor, th);
2097 VM_ASSERT(vm->ractor.blocking_cnt == 0);
2098 VM_ASSERT(vm->ractor.cnt == 1);
2105rb_ractor_living_threads_init(rb_ractor_t *r)
2107 ccan_list_head_init(&r->threads.set);
2109 r->threads.blocking_cnt = 0;
2113ractor_init(rb_ractor_t *r,
VALUE name,
VALUE loc)
2115 ractor_queue_setup(&r->sync.recv_queue);
2116 ractor_queue_setup(&r->sync.takers_queue);
2120#ifdef RUBY_THREAD_WIN32_H
2126 rb_thread_sched_init(&r->threads.sched,
false);
2127 rb_ractor_living_threads_init(r);
2133 enc = rb_enc_get(name);
2134 if (!rb_enc_asciicompat(enc)) {
2135 rb_raise(rb_eArgError,
"ASCII incompatible encoding (%s)",
2145rb_ractor_main_setup(rb_vm_t *vm, rb_ractor_t *r, rb_thread_t *th)
2150 r->threads.main = th;
2151 rb_ractor_living_threads_insert(r, th);
2157 VALUE rv = ractor_alloc(self);
2158 rb_ractor_t *r = RACTOR_PTR(rv);
2159 ractor_init(r, name, loc);
2162 r->pub.id = ractor_next_id();
2163 RUBY_DEBUG_LOG(
"r:%u", r->pub.id);
2165 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
2166 r->verbose = cr->verbose;
2167 r->debug = cr->debug;
2169 rb_yjit_before_ractor_spawn();
2170 rb_rjit_before_ractor_spawn();
2171 rb_thread_create_ractor(r, args, block);
2181 return ractor_create(rb_current_ec_noinline(), klass, loc, name, args, block);
2185ractor_yield_atexit(rb_execution_context_t *ec, rb_ractor_t *cr,
VALUE v,
bool exc)
2187 if (cr->sync.outgoing_port_closed) {
2191 ASSERT_ractor_unlocking(cr);
2196 if (ractor_try_yield(ec, cr, ts, v,
Qfalse, exc,
true)) {
2203 if (!ractor_check_take_basket(cr, ts)) {
2204 VM_ASSERT(cr->sync.wait.status == wait_none);
2205 RUBY_DEBUG_LOG(
"leave a will");
2206 ractor_basket_fill_will(cr, &cr->sync.will_basket, v, exc);
2209 RUBY_DEBUG_LOG(
"rare timing!");
2215 if (retry)
goto retry;
2220rb_ractor_atexit(rb_execution_context_t *ec,
VALUE result)
2222 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
2223 ractor_yield_atexit(ec, cr, result,
false);
2227rb_ractor_atexit_exception(rb_execution_context_t *ec)
2229 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
2230 ractor_yield_atexit(ec, cr, ec->errinfo,
true);
2234rb_ractor_teardown(rb_execution_context_t *ec)
2236 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
2237 ractor_close_incoming(ec, cr);
2238 ractor_close_outgoing(ec, cr);
2243 VM_ASSERT(cr->threads.main != NULL);
2244 cr->threads.main = NULL;
2250rb_ractor_receive_parameters(rb_execution_context_t *ec, rb_ractor_t *r,
int len,
VALUE *ptr)
2252 for (
int i=0; i<
len; i++) {
2253 ptr[i] = ractor_receive(ec, r);
2258rb_ractor_send_parameters(rb_execution_context_t *ec, rb_ractor_t *r,
VALUE args)
2261 for (
int i=0; i<
len; i++) {
2267rb_ractor_main_p_(
void)
2269 VM_ASSERT(rb_multi_ractor_p());
2270 rb_execution_context_t *ec = GET_EC();
2271 return rb_ec_ractor_ptr(ec) == rb_ec_vm_ptr(ec)->ractor.main_ractor;
2275rb_obj_is_main_ractor(
VALUE gv)
2277 if (!rb_ractor_p(gv))
return false;
2279 return r == GET_VM()->ractor.main_ractor;
2283rb_ractor_living_thread_num(
const rb_ractor_t *r)
2285 return r->threads.cnt;
2290rb_ractor_thread_list(
void)
2292 rb_ractor_t *r = GET_RACTOR();
2293 rb_thread_t *th = 0;
2296 ccan_list_for_each(&r->threads.set, th, lt_node) {
2297 switch (th->status) {
2298 case THREAD_RUNNABLE:
2299 case THREAD_STOPPED:
2300 case THREAD_STOPPED_FOREVER:
2301 rb_ary_push(ary, th->self);
2311rb_ractor_living_threads_insert(rb_ractor_t *r, rb_thread_t *th)
2313 VM_ASSERT(th != NULL);
2317 RUBY_DEBUG_LOG(
"r(%d)->threads.cnt:%d++", r->pub.id, r->threads.cnt);
2318 ccan_list_add_tail(&r->threads.set, &th->lt_node);
2324 if (r->threads.cnt == 1) {
2325 VM_ASSERT(ractor_status_p(r, ractor_created));
2326 vm_insert_ractor(th->vm, r);
2331vm_ractor_blocking_cnt_inc(rb_vm_t *vm, rb_ractor_t *r,
const char *file,
int line)
2333 ractor_status_set(r, ractor_blocking);
2335 RUBY_DEBUG_LOG2(file, line,
"vm->ractor.blocking_cnt:%d++", vm->ractor.blocking_cnt);
2336 vm->ractor.blocking_cnt++;
2337 VM_ASSERT(vm->ractor.blocking_cnt <= vm->ractor.cnt);
2341rb_vm_ractor_blocking_cnt_inc(rb_vm_t *vm, rb_ractor_t *cr,
const char *file,
int line)
2343 ASSERT_vm_locking();
2344 VM_ASSERT(GET_RACTOR() == cr);
2345 vm_ractor_blocking_cnt_inc(vm, cr, file, line);
2349rb_vm_ractor_blocking_cnt_dec(rb_vm_t *vm, rb_ractor_t *cr,
const char *file,
int line)
2351 ASSERT_vm_locking();
2352 VM_ASSERT(GET_RACTOR() == cr);
2354 RUBY_DEBUG_LOG2(file, line,
"vm->ractor.blocking_cnt:%d--", vm->ractor.blocking_cnt);
2355 VM_ASSERT(vm->ractor.blocking_cnt > 0);
2356 vm->ractor.blocking_cnt--;
2358 ractor_status_set(cr, ractor_running);
2362ractor_check_blocking(rb_ractor_t *cr,
unsigned int remained_thread_cnt,
const char *file,
int line)
2364 VM_ASSERT(cr == GET_RACTOR());
2366 RUBY_DEBUG_LOG2(file, line,
2367 "cr->threads.cnt:%u cr->threads.blocking_cnt:%u vm->ractor.cnt:%u vm->ractor.blocking_cnt:%u",
2368 cr->threads.cnt, cr->threads.blocking_cnt,
2369 GET_VM()->ractor.cnt, GET_VM()->ractor.blocking_cnt);
2371 VM_ASSERT(cr->threads.cnt >= cr->threads.blocking_cnt + 1);
2373 if (remained_thread_cnt > 0 &&
2375 cr->threads.cnt == cr->threads.blocking_cnt + 1) {
2377 rb_vm_t *vm = GET_VM();
2381 rb_vm_ractor_blocking_cnt_inc(vm, cr, file, line);
2387void rb_threadptr_remove(rb_thread_t *th);
2390rb_ractor_living_threads_remove(rb_ractor_t *cr, rb_thread_t *th)
2392 VM_ASSERT(cr == GET_RACTOR());
2393 RUBY_DEBUG_LOG(
"r->threads.cnt:%d--", cr->threads.cnt);
2394 ractor_check_blocking(cr, cr->threads.cnt - 1, __FILE__, __LINE__);
2396 rb_threadptr_remove(th);
2398 if (cr->threads.cnt == 1) {
2399 vm_remove_ractor(th->vm, cr);
2404 ccan_list_del(&th->lt_node);
2412rb_ractor_blocking_threads_inc(rb_ractor_t *cr,
const char *file,
int line)
2414 RUBY_DEBUG_LOG2(file, line,
"cr->threads.blocking_cnt:%d++", cr->threads.blocking_cnt);
2416 VM_ASSERT(cr->threads.cnt > 0);
2417 VM_ASSERT(cr == GET_RACTOR());
2419 ractor_check_blocking(cr, cr->threads.cnt, __FILE__, __LINE__);
2420 cr->threads.blocking_cnt++;
2424rb_ractor_blocking_threads_dec(rb_ractor_t *cr,
const char *file,
int line)
2426 RUBY_DEBUG_LOG2(file, line,
2427 "r->threads.blocking_cnt:%d--, r->threads.cnt:%u",
2428 cr->threads.blocking_cnt, cr->threads.cnt);
2430 VM_ASSERT(cr == GET_RACTOR());
2432 if (cr->threads.cnt == cr->threads.blocking_cnt) {
2433 rb_vm_t *vm = GET_VM();
2437 rb_vm_ractor_blocking_cnt_dec(vm, cr, __FILE__, __LINE__);
2442 cr->threads.blocking_cnt--;
2446rb_ractor_vm_barrier_interrupt_running_thread(rb_ractor_t *r)
2448 VM_ASSERT(r != GET_RACTOR());
2449 ASSERT_ractor_unlocking(r);
2450 ASSERT_vm_locking();
2454 if (ractor_status_p(r, ractor_running)) {
2455 rb_execution_context_t *ec = r->threads.running_ec;
2457 RUBY_VM_SET_VM_BARRIER_INTERRUPT(ec);
2465rb_ractor_terminate_interrupt_main_thread(rb_ractor_t *r)
2467 VM_ASSERT(r != GET_RACTOR());
2468 ASSERT_ractor_unlocking(r);
2469 ASSERT_vm_locking();
2471 rb_thread_t *main_th = r->threads.main;
2473 if (main_th->status != THREAD_KILLED) {
2474 RUBY_VM_SET_TERMINATE_INTERRUPT(main_th->ec);
2475 rb_threadptr_interrupt(main_th);
2478 RUBY_DEBUG_LOG(
"killed (%p)", (
void *)main_th);
2483void rb_thread_terminate_all(rb_thread_t *th);
2486ractor_terminal_interrupt_all(rb_vm_t *vm)
2488 if (vm->ractor.cnt > 1) {
2491 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
2492 if (r != vm->ractor.main_ractor) {
2493 RUBY_DEBUG_LOG(
"r:%d", rb_ractor_id(r));
2494 rb_ractor_terminate_interrupt_main_thread(r);
2500void rb_add_running_thread(rb_thread_t *th);
2501void rb_del_running_thread(rb_thread_t *th);
2504rb_ractor_terminate_all(
void)
2506 rb_vm_t *vm = GET_VM();
2507 rb_ractor_t *cr = vm->ractor.main_ractor;
2509 RUBY_DEBUG_LOG(
"ractor.cnt:%d", (
int)vm->ractor.cnt);
2511 VM_ASSERT(cr == GET_RACTOR());
2513 if (vm->ractor.cnt > 1) {
2516 ractor_terminal_interrupt_all(vm);
2520 rb_thread_terminate_all(GET_THREAD());
2524 while (vm->ractor.cnt > 1) {
2525 RUBY_DEBUG_LOG(
"terminate_waiting:%d", vm->ractor.sync.terminate_waiting);
2526 vm->ractor.sync.terminate_waiting =
true;
2529 rb_vm_ractor_blocking_cnt_inc(vm, cr, __FILE__, __LINE__);
2530 rb_del_running_thread(rb_ec_thread_ptr(cr->threads.running_ec));
2531 rb_vm_cond_timedwait(vm, &vm->ractor.sync.terminate_cond, 1000 );
2532 rb_add_running_thread(rb_ec_thread_ptr(cr->threads.running_ec));
2533 rb_vm_ractor_blocking_cnt_dec(vm, cr, __FILE__, __LINE__);
2535 ractor_terminal_interrupt_all(vm);
2541rb_execution_context_t *
2542rb_vm_main_ractor_ec(rb_vm_t *vm)
2558 rb_execution_context_t *running_ec = vm->ractor.main_ractor->threads.running_ec;
2559 if (running_ec) {
return running_ec; }
2560 return vm->ractor.main_thread->ec;
2564ractor_moved_missing(
int argc,
VALUE *argv,
VALUE self)
2566 rb_raise(rb_eRactorMovedError,
"can not send any methods to a moved object");
2569#ifndef USE_RACTOR_SELECTOR
2570#define USE_RACTOR_SELECTOR 0
2573RUBY_SYMBOL_EXPORT_BEGIN
2574void rb_init_ractor_selector(
void);
2575RUBY_SYMBOL_EXPORT_END
2584rb_init_ractor_selector(
void)
2593 rb_define_method(rb_cRactorSelector,
"empty?", ractor_selector_empty_p, 0);
2706 rb_define_method(rb_cRactorMovedObject,
"method_missing", ractor_moved_missing, -1);
2709 rb_define_method(rb_cRactorMovedObject,
"__send__", ractor_moved_missing, -1);
2713 rb_define_method(rb_cRactorMovedObject,
"__id__", ractor_moved_missing, -1);
2714 rb_define_method(rb_cRactorMovedObject,
"equal?", ractor_moved_missing, -1);
2715 rb_define_method(rb_cRactorMovedObject,
"instance_eval", ractor_moved_missing, -1);
2716 rb_define_method(rb_cRactorMovedObject,
"instance_exec", ractor_moved_missing, -1);
2720#if USE_RACTOR_SELECTOR
2721 rb_init_ractor_selector();
2728 rb_vm_t *vm = GET_VM();
2731 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
2732 if (r != vm->ractor.main_ractor) {
2733 fprintf(stderr,
"r:%u (%s)\n", r->pub.id, ractor_status_str(r->status_));
2741 if (rb_ractor_main_p()) {
2745 rb_ractor_t *cr = GET_RACTOR();
2753 if (rb_ractor_main_p()) {
2757 rb_ractor_t *cr = GET_RACTOR();
2758 return cr->r_stdout;
2765 if (rb_ractor_main_p()) {
2769 rb_ractor_t *cr = GET_RACTOR();
2770 return cr->r_stderr;
2777 if (rb_ractor_main_p()) {
2781 rb_ractor_t *cr = GET_RACTOR();
2789 if (rb_ractor_main_p()) {
2793 rb_ractor_t *cr = GET_RACTOR();
2801 if (rb_ractor_main_p()) {
2805 rb_ractor_t *cr = GET_RACTOR();
2811rb_ractor_hooks(rb_ractor_t *cr)
2813 return &cr->pub.hooks;
2822enum obj_traverse_iterator_result {
2828typedef enum obj_traverse_iterator_result (*rb_obj_traverse_enter_func)(
VALUE obj);
2829typedef enum obj_traverse_iterator_result (*rb_obj_traverse_leave_func)(
VALUE obj);
2830typedef enum obj_traverse_iterator_result (*rb_obj_traverse_final_func)(
VALUE obj);
2832static enum obj_traverse_iterator_result null_leave(
VALUE obj);
2835 rb_obj_traverse_enter_func enter_func;
2836 rb_obj_traverse_leave_func leave_func;
2855 if (obj_traverse_i(key, d->data)) {
2860 if (obj_traverse_i(val, d->data)) {
2869obj_traverse_reachable_i(
VALUE obj,
void *ptr)
2873 if (obj_traverse_i(obj, d->data)) {
2878static struct st_table *
2881 if (UNLIKELY(!data->rec)) {
2882 data->rec_hash = rb_ident_hash_new();
2883 data->rec = RHASH_ST_TABLE(data->rec_hash);
2889obj_traverse_ivar_foreach_i(
ID key,
VALUE val, st_data_t ptr)
2893 if (obj_traverse_i(val, d->data)) {
2906 switch (data->enter_func(obj)) {
2907 case traverse_cont:
break;
2908 case traverse_skip:
return 0;
2909 case traverse_stop:
return 1;
2912 if (UNLIKELY(st_insert(obj_traverse_rec(data), obj, 1))) {
2923 if (d.stop)
return 1;
2943 VALUE e = rb_ary_entry(obj, i);
2944 if (obj_traverse_i(e, data))
return 1;
2958 if (d.stop)
return 1;
2964 long len = RSTRUCT_LEN(obj);
2965 const VALUE *ptr = RSTRUCT_CONST_PTR(obj);
2967 for (
long i=0; i<
len; i++) {
2968 if (obj_traverse_i(ptr[i], data))
return 1;
2974 if (obj_traverse_i(RRATIONAL(obj)->num, data))
return 1;
2975 if (obj_traverse_i(RRATIONAL(obj)->den, data))
return 1;
2978 if (obj_traverse_i(RCOMPLEX(obj)->real, data))
return 1;
2979 if (obj_traverse_i(RCOMPLEX(obj)->imag, data))
return 1;
2989 RB_VM_LOCK_ENTER_NO_BARRIER();
2991 rb_objspace_reachable_objects_from(obj, obj_traverse_reachable_i, &d);
2993 RB_VM_LOCK_LEAVE_NO_BARRIER();
2994 if (d.stop)
return 1;
3004 rb_bug(
"unreachable");
3007 if (data->leave_func(obj) == traverse_stop) {
3016 rb_obj_traverse_final_func final_func;
3021obj_traverse_final_i(st_data_t key, st_data_t val, st_data_t arg)
3024 if (data->final_func(key)) {
3034rb_obj_traverse(
VALUE obj,
3035 rb_obj_traverse_enter_func enter_func,
3036 rb_obj_traverse_leave_func leave_func,
3037 rb_obj_traverse_final_func final_func)
3040 .enter_func = enter_func,
3041 .leave_func = leave_func,
3045 if (obj_traverse_i(obj, &data))
return 1;
3046 if (final_func && data.rec) {
3048 st_foreach(data.rec, obj_traverse_final_i, (st_data_t)&f);
3055frozen_shareable_p(
VALUE obj,
bool *made_shareable)
3062 if (
type->flags & RUBY_TYPED_FROZEN_SHAREABLE) {
3067 rb_proc_ractor_make_shareable(obj);
3068 *made_shareable =
true;
3077static enum obj_traverse_iterator_result
3078make_shareable_check_shareable(
VALUE obj)
3081 bool made_shareable =
false;
3084 return traverse_skip;
3086 if (!frozen_shareable_p(obj, &made_shareable)) {
3087 if (made_shareable) {
3088 return traverse_skip;
3091 rb_raise(rb_eRactorError,
"can not make shareable object for %"PRIsVALUE, obj);
3099 rb_raise(rb_eRactorError,
"#freeze does not freeze object correctly");
3103 return traverse_skip;
3107 return traverse_cont;
3110static enum obj_traverse_iterator_result
3111mark_shareable(
VALUE obj)
3114 return traverse_cont;
3120 rb_obj_traverse(obj,
3121 make_shareable_check_shareable,
3122 null_leave, mark_shareable);
3129 VALUE copy = ractor_copy(obj);
3134rb_ractor_ensure_shareable(
VALUE obj,
VALUE name)
3137 VALUE message = rb_sprintf(
"cannot assign unshareable object to %"PRIsVALUE,
3145rb_ractor_ensure_main_ractor(
const char *msg)
3147 if (!rb_ractor_main_p()) {
3148 rb_raise(rb_eRactorIsolationError,
"%s", msg);
3152static enum obj_traverse_iterator_result
3153shareable_p_enter(
VALUE obj)
3156 return traverse_skip;
3162 mark_shareable(obj);
3163 return traverse_skip;
3166 frozen_shareable_p(obj, NULL)) {
3167 return traverse_cont;
3170 return traverse_stop;
3174rb_ractor_shareable_p_continue(
VALUE obj)
3176 if (rb_obj_traverse(obj,
3177 shareable_p_enter, null_leave,
3186#if RACTOR_CHECK_MODE > 0
3188rb_ractor_setup_belonging(
VALUE obj)
3190 rb_ractor_setup_belonging_to(obj, rb_ractor_current_id());
3193static enum obj_traverse_iterator_result
3194reset_belonging_enter(
VALUE obj)
3197 return traverse_skip;
3200 rb_ractor_setup_belonging(obj);
3201 return traverse_cont;
3206static enum obj_traverse_iterator_result
3207null_leave(
VALUE obj)
3209 return traverse_cont;
3213ractor_reset_belonging(
VALUE obj)
3215#if RACTOR_CHECK_MODE > 0
3216 rb_obj_traverse(obj, reset_belonging_enter, null_leave, NULL);
3234 rb_obj_traverse_replace_enter_func enter_func;
3235 rb_obj_traverse_replace_leave_func leave_func;
3251obj_hash_traverse_replace_foreach_i(st_data_t key, st_data_t value, st_data_t argp,
int error)
3257obj_hash_traverse_replace_i(st_data_t *key, st_data_t *val, st_data_t ptr,
int exists)
3262 if (obj_traverse_replace_i(*key, data)) {
3266 else if (*key != data->replacement) {
3267 VALUE v = *key = data->replacement;
3271 if (obj_traverse_replace_i(*val, data)) {
3275 else if (*val != data->replacement) {
3276 VALUE v = *val = data->replacement;
3284obj_iv_hash_traverse_replace_foreach_i(st_data_t _key, st_data_t _val, st_data_t _data,
int _x)
3290obj_iv_hash_traverse_replace_i(st_data_t * _key, st_data_t * val, st_data_t ptr,
int exists)
3295 if (obj_traverse_replace_i(*(
VALUE *)val, data)) {
3299 else if (*(
VALUE *)val != data->replacement) {
3307static struct st_table *
3310 if (UNLIKELY(!data->rec)) {
3311 data->rec_hash = rb_ident_hash_new();
3312 data->rec = RHASH_ST_TABLE(data->rec_hash);
3318obj_refer_only_shareables_p_i(
VALUE obj,
void *ptr)
3320 int *pcnt = (
int *)ptr;
3328obj_refer_only_shareables_p(
VALUE obj)
3331 RB_VM_LOCK_ENTER_NO_BARRIER();
3333 rb_objspace_reachable_objects_from(obj, obj_refer_only_shareables_p_i, &cnt);
3335 RB_VM_LOCK_LEAVE_NO_BARRIER();
3342 st_data_t replacement;
3345 data->replacement = obj;
3349 switch (data->enter_func(obj, data)) {
3350 case traverse_cont:
break;
3351 case traverse_skip:
return 0;
3352 case traverse_stop:
return 1;
3355 replacement = (st_data_t)data->replacement;
3357 if (UNLIKELY(st_lookup(obj_traverse_replace_rec(data), (st_data_t)obj, &replacement))) {
3358 data->replacement = (
VALUE)replacement;
3362 st_insert(obj_traverse_replace_rec(data), (st_data_t)obj, replacement);
3371#define CHECK_AND_REPLACE(v) do { \
3373 if (obj_traverse_replace_i(_val, data)) { return 1; } \
3374 else if (data->replacement != _val) { RB_OBJ_WRITE(obj, &v, data->replacement); } \
3379 rb_ivar_generic_ivtbl_lookup(obj, &ivtbl);
3381 if (UNLIKELY(rb_shape_obj_too_complex(obj))) {
3387 rb_st_foreach_with_replace(
3388 ivtbl->as.complex.table,
3389 obj_iv_hash_traverse_replace_foreach_i,
3390 obj_iv_hash_traverse_replace_i,
3393 if (d.stop)
return 1;
3396 for (uint32_t i = 0; i < ivtbl->as.shape.numiv; i++) {
3397 if (!UNDEF_P(ivtbl->as.shape.ivptr[i])) {
3398 CHECK_AND_REPLACE(ivtbl->as.shape.ivptr[i]);
3414 rb_str_make_independent(obj);
3419 if (rb_shape_obj_too_complex(obj)) {
3425 rb_st_foreach_with_replace(
3426 ROBJECT_IV_HASH(obj),
3427 obj_iv_hash_traverse_replace_foreach_i,
3428 obj_iv_hash_traverse_replace_i,
3431 if (d.stop)
return 1;
3434 uint32_t
len = ROBJECT_IV_COUNT(obj);
3437 for (uint32_t i = 0; i <
len; i++) {
3438 CHECK_AND_REPLACE(ptr[i]);
3446 rb_ary_cancel_sharing(obj);
3449 VALUE e = rb_ary_entry(obj, i);
3451 if (obj_traverse_replace_i(e, data)) {
3454 else if (e != data->replacement) {
3468 rb_hash_stlike_foreach_with_replace(obj,
3469 obj_hash_traverse_replace_foreach_i,
3470 obj_hash_traverse_replace_i,
3472 if (d.stop)
return 1;
3476 if (obj_traverse_replace_i(ifnone, data)) {
3479 else if (ifnone != data->replacement) {
3487 long len = RSTRUCT_LEN(obj);
3488 const VALUE *ptr = RSTRUCT_CONST_PTR(obj);
3490 for (
long i=0; i<
len; i++) {
3491 CHECK_AND_REPLACE(ptr[i]);
3497 CHECK_AND_REPLACE(RRATIONAL(obj)->num);
3498 CHECK_AND_REPLACE(RRATIONAL(obj)->den);
3501 CHECK_AND_REPLACE(RCOMPLEX(obj)->real);
3502 CHECK_AND_REPLACE(RCOMPLEX(obj)->imag);
3506 if (!data->move && obj_refer_only_shareables_p(obj)) {
3510 rb_raise(rb_eRactorError,
"can not %s %"PRIsVALUE
" object.",
3524 rb_bug(
"unreachable");
3527 data->replacement = (
VALUE)replacement;
3529 if (data->leave_func(obj, data) == traverse_stop) {
3540rb_obj_traverse_replace(
VALUE obj,
3541 rb_obj_traverse_replace_enter_func enter_func,
3542 rb_obj_traverse_replace_leave_func leave_func,
3546 .enter_func = enter_func,
3547 .leave_func = leave_func,
3553 if (obj_traverse_replace_i(obj, &data)) {
3557 return data.replacement;
3576ractor_moved_bang(
VALUE obj)
3579 struct RVALUE *rv = (
void *)obj;
3581 rv->klass = rb_cRactorMovedObject;
3585 rv->flags = rv->flags & ~fl_users;
3592static enum obj_traverse_iterator_result
3596 data->replacement = obj;
3597 return traverse_skip;
3601 rb_shape_set_shape(moved, rb_shape_get_shape(obj));
3602 data->replacement = moved;
3603 return traverse_cont;
3607void rb_replace_generic_ivar(
VALUE clone,
VALUE obj);
3609static enum obj_traverse_iterator_result
3612 VALUE v = data->replacement;
3616 dst->flags = (dst->flags & ~fl_users) | (src->flags & fl_users);
3623 rb_replace_generic_ivar(v, obj);
3632 ractor_moved_bang(obj);
3633 return traverse_cont;
3637ractor_move(
VALUE obj)
3639 VALUE val = rb_obj_traverse_replace(obj, move_enter, move_leave,
true);
3640 if (!UNDEF_P(val)) {
3644 rb_raise(rb_eRactorError,
"can not move the object");
3648static enum obj_traverse_iterator_result
3652 data->replacement = obj;
3653 return traverse_skip;
3657 return traverse_cont;
3661static enum obj_traverse_iterator_result
3664 return traverse_cont;
3668ractor_copy(
VALUE obj)
3670 VALUE val = rb_obj_traverse_replace(obj, copy_enter, copy_leave,
false);
3671 if (!UNDEF_P(val)) {
3675 rb_raise(rb_eRactorError,
"can not copy the object");
3690} freed_ractor_local_keys;
3693ractor_local_storage_mark_i(st_data_t key, st_data_t val, st_data_t dmy)
3696 if (k->type->
mark) (*k->type->
mark)((
void *)val);
3700static enum rb_id_table_iterator_result
3701idkey_local_storage_mark_i(
VALUE val,
void *dmy)
3704 return ID_TABLE_CONTINUE;
3708ractor_local_storage_mark(rb_ractor_t *r)
3710 if (r->local_storage) {
3711 st_foreach(r->local_storage, ractor_local_storage_mark_i, 0);
3713 for (
int i=0; i<freed_ractor_local_keys.cnt; i++) {
3715 st_data_t val, k = (st_data_t)key;
3716 if (st_delete(r->local_storage, &k, &val) &&
3718 (*key->type->free)((
void *)val);
3723 if (r->idkey_local_storage) {
3724 rb_id_table_foreach_values(r->idkey_local_storage, idkey_local_storage_mark_i, NULL);
3727 rb_gc_mark(r->local_storage_store_lock);
3731ractor_local_storage_free_i(st_data_t key, st_data_t val, st_data_t dmy)
3734 if (k->type->
free) (*k->type->
free)((
void *)val);
3739ractor_local_storage_free(rb_ractor_t *r)
3741 if (r->local_storage) {
3742 st_foreach(r->local_storage, ractor_local_storage_free_i, 0);
3743 st_free_table(r->local_storage);
3746 if (r->idkey_local_storage) {
3747 rb_id_table_free(r->idkey_local_storage);
3752rb_ractor_local_storage_value_mark(
void *ptr)
3754 rb_gc_mark((
VALUE)ptr);
3768 rb_ractor_local_storage_value_mark,
3776 key->type =
type ?
type : &ractor_local_storage_type_null;
3777 key->main_cache = (
void *)
Qundef;
3792 if (freed_ractor_local_keys.cnt == freed_ractor_local_keys.capa) {
3793 freed_ractor_local_keys.capa = freed_ractor_local_keys.capa ? freed_ractor_local_keys.capa * 2 : 4;
3796 freed_ractor_local_keys.keys[freed_ractor_local_keys.cnt++] = key;
3804 if (rb_ractor_main_p()) {
3805 if (!UNDEF_P((
VALUE)key->main_cache)) {
3806 *pret = key->main_cache;
3814 rb_ractor_t *cr = GET_RACTOR();
3816 if (cr->local_storage && st_lookup(cr->local_storage, (st_data_t)key, (st_data_t *)pret)) {
3828 rb_ractor_t *cr = GET_RACTOR();
3830 if (cr->local_storage == NULL) {
3831 cr->local_storage = st_init_numtable();
3834 st_insert(cr->local_storage, (st_data_t)key, (st_data_t)ptr);
3836 if (rb_ractor_main_p()) {
3837 key->main_cache = ptr;
3845 if (ractor_local_ref(key, &val)) {
3856 if (ractor_local_ref(key, (
void **)val)) {
3867 ractor_local_set(key, (
void *)val);
3874 if (ractor_local_ref(key, &ret)) {
3885 ractor_local_set(key, ptr);
3888#define DEFAULT_KEYS_CAPA 0x10
3891rb_ractor_finish_marking(
void)
3893 for (
int i=0; i<freed_ractor_local_keys.cnt; i++) {
3894 ruby_xfree(freed_ractor_local_keys.keys[i]);
3896 freed_ractor_local_keys.cnt = 0;
3897 if (freed_ractor_local_keys.capa > DEFAULT_KEYS_CAPA) {
3898 freed_ractor_local_keys.capa = DEFAULT_KEYS_CAPA;
3904ractor_local_value(rb_execution_context_t *ec,
VALUE self,
VALUE sym)
3906 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
3908 struct rb_id_table *tbl = cr->idkey_local_storage;
3911 if (
id && tbl && rb_id_table_lookup(tbl,
id, &val)) {
3920ractor_local_value_set(rb_execution_context_t *ec,
VALUE self,
VALUE sym,
VALUE val)
3922 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
3924 struct rb_id_table *tbl = cr->idkey_local_storage;
3927 tbl = cr->idkey_local_storage = rb_id_table_create(2);
3929 rb_id_table_insert(tbl,
id, val);
3934 rb_execution_context_t *ec;
3941ractor_local_value_store_i(
VALUE ptr)
3946 if (rb_id_table_lookup(data->tbl, data->id, &val)) {
3951 ractor_local_value_set(data->ec,
Qnil, data->sym, val);
3957ractor_local_value_store_if_absent(rb_execution_context_t *ec,
VALUE self,
VALUE sym)
3959 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
3964 .tbl = cr->idkey_local_storage,
3968 if (data.tbl == NULL) {
3969 data.tbl = cr->idkey_local_storage = rb_id_table_create(2);
3971 else if (rb_id_table_lookup(data.tbl, data.id, &val)) {
3976 if (!cr->local_storage_store_lock) {
3985typedef rb_ractor_t rb_ractor_channel_t;
3990 rb_execution_context_t *ec = GET_EC();
3991 rb_ractor_t *cr = rb_ec_ractor_ptr(ec);
3997 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
3998 VALUE obj = ractor_receive(ec, cr);
3999 ractor_yield(ec, cr, obj,
Qfalse);
4013rb_ractor_channel_new(
void)
4036rb_ractor_channel_yield(rb_execution_context_t *ec,
VALUE vch,
VALUE obj)
4038 VM_ASSERT(ec == rb_current_ec_noinline());
4039 rb_ractor_channel_t *ch = RACTOR_PTR(vch);
4041 ractor_send(ec, (rb_ractor_t *)ch, obj,
Qfalse);
4046rb_ractor_channel_take(rb_execution_context_t *ec,
VALUE vch)
4048 VM_ASSERT(ec == rb_current_ec_noinline());
4049 rb_ractor_channel_t *ch = RACTOR_PTR(vch);
4051 return ractor_take(ec, (rb_ractor_t *)ch);
4055rb_ractor_channel_close(rb_execution_context_t *ec,
VALUE vch)
4057 VM_ASSERT(ec == rb_current_ec_noinline());
4058 rb_ractor_channel_t *ch = RACTOR_PTR(vch);
4060 ractor_close_incoming(ec, (rb_ractor_t *)ch);
4061 return ractor_close_outgoing(ec, (rb_ractor_t *)ch);
4080require_body(
VALUE data)
4086 crr->result = rb_funcallv(
Qnil, require, 1, &crr->feature);
4095 crr->exception = errinfo;
4100require_result_copy_body(
VALUE data)
4104 if (crr->exception !=
Qundef) {
4105 VM_ASSERT(crr->result ==
Qundef);
4106 crr->exception = ractor_copy(crr->exception);
4109 VM_ASSERT(crr->result !=
Qundef);
4110 crr->result = ractor_copy(crr->result);
4117require_result_copy_resuce(
VALUE data,
VALUE errinfo)
4120 crr->exception = errinfo;
4134 rb_ractor_channel_yield(GET_EC(), crr->ch,
Qtrue);
4140ractore_require_func(
void *data)
4143 return ractor_require_protect(crr, require_body);
4147rb_ractor_require(
VALUE feature)
4152 .ch = rb_ractor_channel_new(),
4157 rb_execution_context_t *ec = GET_EC();
4158 rb_ractor_t *main_r = GET_VM()->ractor.main_ractor;
4159 rb_ractor_interrupt_exec(main_r, ractore_require_func, &crr, 0);
4162 rb_ractor_channel_take(ec, crr.ch);
4163 rb_ractor_channel_close(ec, crr.ch);
4165 if (crr.exception !=
Qundef) {
4166 rb_exc_raise(crr.exception);
4174ractor_require(rb_execution_context_t *ec,
VALUE self,
VALUE feature)
4176 return rb_ractor_require(feature);
4180autoload_load_body(
VALUE data)
4188ractor_autoload_load_func(
void *data)
4191 return ractor_require_protect(crr, autoload_load_body);
4195rb_ractor_autoload_load(
VALUE module,
ID name)
4200 .ch = rb_ractor_channel_new(),
4205 rb_execution_context_t *ec = GET_EC();
4206 rb_ractor_t *main_r = GET_VM()->ractor.main_ractor;
4207 rb_ractor_interrupt_exec(main_r, ractor_autoload_load_func, &crr, 0);
4210 rb_ractor_channel_take(ec, crr.ch);
4211 rb_ractor_channel_close(ec, crr.ch);
4213 if (crr.exception !=
Qundef) {
4214 rb_exc_raise(crr.exception);
4221#include "ractor.rbinc"
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define RUBY_ATOMIC_CAS(var, oldval, newval)
Atomic compare-and-swap.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define RUBY_ATOMIC_FETCH_ADD(var, val)
Atomically replaces the value pointed by var with the result of addition of val to the old value of v...
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
static VALUE RB_OBJ_FROZEN_RAW(VALUE obj)
This is an implementation detail of RB_OBJ_FROZEN().
@ RUBY_FL_SHAREABLE
This flag has something to do with Ractor.
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.
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_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
#define rb_str_new2
Old name of rb_str_new_cstr.
#define T_COMPLEX
Old name of RUBY_T_COMPLEX.
#define T_FILE
Old name of RUBY_T_FILE.
#define FL_EXIVAR
Old name of RUBY_FL_EXIVAR.
#define FL_USER3
Old name of RUBY_FL_USER3.
#define REALLOC_N
Old name of RB_REALLOC_N.
#define ALLOC
Old name of RB_ALLOC.
#define T_STRING
Old name of RUBY_T_STRING.
#define FL_USER7
Old name of RUBY_FL_USER7.
#define FL_USER10
Old name of RUBY_FL_USER10.
#define Qundef
Old name of RUBY_Qundef.
#define OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
#define FL_USER6
Old name of RUBY_FL_USER6.
#define T_FLOAT
Old name of RUBY_T_FLOAT.
#define T_IMEMO
Old name of RUBY_T_IMEMO.
#define FL_USER1
Old name of RUBY_FL_USER1.
#define ID2SYM
Old name of RB_ID2SYM.
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define T_STRUCT
Old name of RUBY_T_STRUCT.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define FL_USER19
Old name of RUBY_FL_USER19.
#define SYM2ID
Old name of RB_SYM2ID.
#define FL_USER12
Old name of RUBY_FL_USER12.
#define T_DATA
Old name of RUBY_T_DATA.
#define FL_USER11
Old name of RUBY_FL_USER11.
#define FL_USER15
Old name of RUBY_FL_USER15.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define FL_USER8
Old name of RUBY_FL_USER8.
#define FL_USER14
Old name of RUBY_FL_USER14.
#define FL_USER17
Old name of RUBY_FL_USER17.
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define T_HASH
Old name of RUBY_T_HASH.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define FL_USER18
Old name of RUBY_FL_USER18.
#define FL_USER2
Old name of RUBY_FL_USER2.
#define FL_USER9
Old name of RUBY_FL_USER9.
#define Qtrue
Old name of RUBY_Qtrue.
#define FL_USER13
Old name of RUBY_FL_USER13.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
#define T_OBJECT
Old name of RUBY_T_OBJECT.
#define NIL_P
Old name of RB_NIL_P.
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
#define T_MATCH
Old name of RUBY_T_MATCH.
#define FL_USER16
Old name of RUBY_FL_USER16.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define FL_USER5
Old name of RUBY_FL_USER5.
#define CONST_ID
Old name of RUBY_CONST_ID.
#define FL_USER4
Old name of RUBY_FL_USER4.
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
#define T_REGEXP
Old name of RUBY_T_REGEXP.
int rb_typeddata_is_kind_of(VALUE obj, const rb_data_type_t *data_type)
Checks if the given object is of given kind.
VALUE rb_eRuntimeError
RuntimeError exception.
VALUE rb_eStopIteration
StopIteration exception.
VALUE rb_exc_new_str(VALUE etype, VALUE str)
Identical to rb_exc_new_cstr(), except it takes a Ruby's string instead of C's.
VALUE rb_eException
Mother of all exceptions.
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
VALUE rb_cRactor
Ractor class.
VALUE rb_stdin
STDIN constant.
VALUE rb_stderr
STDERR constant.
static VALUE rb_class_of(VALUE obj)
Object to class mapping function.
VALUE rb_cBasicObject
BasicObject class.
VALUE rb_obj_clone(VALUE obj)
Produces a shallow copy of the given object.
VALUE rb_stdout
STDOUT constant.
#define RB_OBJ_WRITTEN(old, oldv, young)
Identical to RB_OBJ_WRITE(), except it doesn't write any values, but only a WB declaration.
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
VALUE rb_gc_disable(void)
Disables GC.
VALUE rb_gc_start(void)
Identical to rb_gc(), except the return value.
VALUE rb_gc_enable(void)
(Re-) enables GC.
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_obj_is_proc(VALUE recv)
Queries if the given object is a proc.
#define rb_exc_new_cstr(exc, str)
Identical to rb_exc_new(), except it assumes the passed pointer is a pointer to a C string.
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
VALUE rb_mutex_new(void)
Creates a mutex.
VALUE rb_mutex_synchronize(VALUE mutex, VALUE(*func)(VALUE arg), VALUE arg)
Obtains the lock, runs the passed function, and releases the lock when it completes.
void rb_unblock_function_t(void *)
This is the type of UBFs.
VALUE rb_mutex_unlock(VALUE mutex)
Releases the mutex.
VALUE rb_mutex_lock(VALUE mutex)
Attempts to lock the mutex.
void rb_thread_sleep(int sec)
Blocks for the given period of time.
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
VALUE rb_autoload_load(VALUE space, ID name)
Kicks the autoload procedure as if it was "touched".
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
VALUE rb_to_symbol(VALUE name)
Identical to rb_intern_str(), except it generates a dynamic symbol if necessary.
int len
Length of the buffer.
const struct rb_ractor_local_storage_type rb_ractor_local_storage_type_free
A type of ractor-local storage that destructs itself using ruby_xfree.
VALUE rb_ractor_make_shareable_copy(VALUE obj)
Identical to rb_ractor_make_shareable(), except it returns a (deep) copy of the passed one instead of...
struct rb_ractor_local_key_struct * rb_ractor_local_key_t
(Opaque) struct that holds a ractor-local storage key.
void * rb_ractor_local_storage_ptr(rb_ractor_local_key_t key)
Identical to rb_ractor_local_storage_value() except the return type.
void rb_ractor_local_storage_ptr_set(rb_ractor_local_key_t key, void *ptr)
Identical to rb_ractor_local_storage_value_set() except the parameter type.
rb_ractor_local_key_t rb_ractor_local_storage_ptr_newkey(const struct rb_ractor_local_storage_type *type)
Extended version of rb_ractor_local_storage_value_newkey().
VALUE rb_ractor_stderr(void)
Queries the standard error of the current Ractor that is calling this function.
VALUE rb_ractor_stdin(void)
Queries the standard input of the current Ractor that is calling this function.
static bool rb_ractor_shareable_p(VALUE obj)
Queries if multiple Ractors can share the passed object or not.
void rb_ractor_stderr_set(VALUE io)
Assigns an IO to the standard error of the Ractor that is calling this function.
void rb_ractor_local_storage_value_set(rb_ractor_local_key_t key, VALUE val)
Associates the passed value to the passed key.
bool rb_ractor_local_storage_value_lookup(rb_ractor_local_key_t key, VALUE *val)
Queries the key.
VALUE rb_ractor_stdout(void)
Queries the standard output of the current Ractor that is calling this function.
#define RB_OBJ_SHAREABLE_P(obj)
Queries if the passed object has previously classified as shareable or not.
VALUE rb_ractor_make_shareable(VALUE obj)
Destructively transforms the passed object so that multiple Ractors can share it.
rb_ractor_local_key_t rb_ractor_local_storage_value_newkey(void)
Issues a new key.
void rb_ractor_stdout_set(VALUE io)
Assigns an IO to the standard output of the Ractor that is calling this function.
void rb_ractor_stdin_set(VALUE io)
Assigns an IO to the standard input of the Ractor that is calling this function.
VALUE rb_ractor_local_storage_value(rb_ractor_local_key_t key)
Queries the key.
#define RB_NOGVL_UBF_ASYNC_SAFE
Passing this flag to rb_nogvl() indicates that the passed UBF is async-signal-safe.
#define RB_NOGVL_INTR_FAIL
Passing this flag to rb_nogvl() prevents it from checking interrupts.
void * rb_nogvl(void *(*func)(void *), void *data1, rb_unblock_function_t *ubf, void *data2, int flags)
Identical to rb_thread_call_without_gvl(), except it additionally takes "flags" that change the behav...
#define RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg)
Shim for block function parameters.
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 RB_GC_GUARD(v)
Prevents premature destruction of local objects.
VALUE rb_proc_new(type *q, VALUE w)
Creates a rb_cProc instance.
VALUE type(ANYARGS)
ANYARGS-ed function type.
int st_foreach(st_table *q, int_type *w, st_data_t e)
Iteration over the given table.
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
void rb_ivar_foreach(VALUE q, int_type *w, VALUE e)
Iteration over each instance variable of the object.
VALUE rb_rescue2(type *q, VALUE w, type *e, VALUE r,...)
An equivalent of rescue clause.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
static void RARRAY_ASET(VALUE ary, long i, VALUE v)
Assigns an object in an array.
#define RARRAY_AREF(a, i)
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define DATA_PTR(obj)
Convenient getter macro.
#define RHASH_SET_IFNONE(h, ifnone)
Destructively updates the default value of the hash.
static VALUE * ROBJECT_IVPTR(VALUE obj)
Queries the instance variables.
#define StringValueCStr(v)
Identical to StringValuePtr, except it additionally checks for the contents for viability as a C stri...
static bool RTYPEDDATA_P(VALUE obj)
Checks whether the passed object is RTypedData or RData.
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
struct rb_data_type_struct rb_data_type_t
This is the struct that holds necessary info for a struct.
#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...
static const struct rb_data_type_struct * RTYPEDDATA_TYPE(VALUE obj)
Queries for the type of given object.
static bool RB_SPECIAL_CONST_P(VALUE obj)
Checks if the given object is of enum ruby_special_consts.
#define RTEST
This is an old name of RB_TEST.
Type that defines a ractor-local storage.
void(* free)(void *ptr)
A function to destruct a ractor-local storage.
void(* mark)(void *ptr)
A function to mark a ractor-local storage.
void rb_native_mutex_lock(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_lock.
void rb_native_cond_initialize(rb_nativethread_cond_t *cond)
Fills the passed condition variable with an initial value.
void rb_native_cond_broadcast(rb_nativethread_cond_t *cond)
Signals a condition variable.
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.
void rb_native_cond_destroy(rb_nativethread_cond_t *cond)
Destroys the passed condition variable.
void rb_native_cond_signal(rb_nativethread_cond_t *cond)
Signals a condition variable.
void rb_native_cond_wait(rb_nativethread_cond_t *cond, rb_nativethread_lock_t *mutex)
Waits for the passed condition variable to be signalled.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.