14#include "ruby/internal/config.h"
17#include "ccan/list/list.h"
19#include "debug_counter.h"
23#include "internal/class.h"
24#include "internal/compilers.h"
25#include "internal/error.h"
26#include "internal/eval.h"
27#include "internal/hash.h"
28#include "internal/object.h"
29#include "internal/re.h"
30#include "internal/symbol.h"
31#include "internal/thread.h"
32#include "internal/variable.h"
40#include "ractor_core.h"
44#define GET_GLOBAL_CVAR_STATE() (ruby_vm_global_cvar_state)
46typedef void rb_gvar_compact_t(
void *var);
54static VALUE autoload_features;
59static VALUE autoload_mutex;
61static void check_before_mod_set(
VALUE,
ID,
VALUE,
const char *);
63static VALUE rb_const_search(
VALUE klass,
ID id,
int exclude,
int recurse,
int visibility);
69 rb_global_tbl = rb_id_table_create(0);
70 generic_iv_tbl_ = st_init_numtable();
74 rb_obj_hide(autoload_mutex);
75 rb_gc_register_mark_object(autoload_mutex);
77 autoload_features = rb_ident_hash_new();
78 rb_obj_hide(autoload_features);
79 rb_gc_register_mark_object(autoload_features);
83rb_namespace_p(
VALUE obj)
102classname(
VALUE klass,
bool *permanent)
106 VALUE classpath = RCLASS_EXT(klass)->classpath;
107 if (classpath == 0)
return Qnil;
109 *permanent = RCLASS_EXT(klass)->permanent_classpath;
125 return classname(mod, &permanent);
130is_constant_path(
VALUE name)
132 const char *path = RSTRING_PTR(name);
133 const char *pend = RSTRING_END(name);
136 const char *p = path;
138 if (p >= pend || !*p) {
143 if (p + 2 <= pend && p[0] ==
':' && p[1] ==
':') {
147 const char *pbeg = p;
148 while (p < pend && *p !=
':') p++;
150 if (pbeg == p)
return false;
152 if (rb_enc_symname_type(pbeg, p - pbeg, enc, 0) != ID_CONST) {
209rb_mod_set_temporary_name(
VALUE mod,
VALUE name)
212 if (RCLASS_EXT(mod)->permanent_classpath) {
218 RCLASS_SET_CLASSPATH(mod, 0, FALSE);
223 if (RSTRING_LEN(name) == 0) {
224 rb_raise(rb_eArgError,
"empty class/module name");
227 if (is_constant_path(name)) {
228 rb_raise(rb_eArgError,
"the temporary name must not be a constant path to avoid confusion");
232 RCLASS_SET_CLASSPATH(mod, name, FALSE);
244 path = rb_sprintf(
"#<Class:%p>", (
void*)obj);
247 path = rb_sprintf(
"#<Module:%p>", (
void*)obj);
250 path = rb_sprintf(
"#<%"PRIsVALUE
":%p>", klass, (
void*)obj);
260rb_tmp_class_path(
VALUE klass,
bool *permanent, fallback_func fallback)
262 VALUE path = classname(klass, permanent);
274 path = rb_tmp_class_path(
RBASIC(klass)->klass, &perm, fallback);
278 return fallback(klass, path);
286 VALUE path = rb_tmp_class_path(klass, &permanent, make_temporary_path);
287 if (!
NIL_P(path)) path = rb_str_dup(path);
304rb_search_class_path(
VALUE klass)
307 return rb_tmp_class_path(klass, &permanent, no_fallback);
313 VALUE path = rb_str_dup(head);
316 return rb_fstring(path);
320build_const_path(
VALUE head,
ID tail)
322 return build_const_pathname(head, rb_id2str(tail));
328 bool permanent =
true;
331 if (under == rb_cObject) {
332 str = rb_str_new_frozen(name);
335 str = rb_tmp_class_path(under, &permanent, make_temporary_path);
336 str = build_const_pathname(str, name);
339 RCLASS_SET_CLASSPATH(klass, str, permanent);
354 const char *pbeg, *pend, *p, *path = RSTRING_PTR(pathname);
356 VALUE c = rb_cObject;
358 if (!rb_enc_asciicompat(enc)) {
359 rb_raise(rb_eArgError,
"invalid class path encoding (non ASCII)");
362 pend = path + RSTRING_LEN(pathname);
363 if (path == pend || path[0] ==
'#') {
364 rb_raise(rb_eArgError,
"can't retrieve anonymous class %"PRIsVALUE,
368 while (p < pend && *p !=
':') p++;
370 if (p < pend && p[0] ==
':') {
371 if ((
size_t)(pend - p) < 2 || p[1] !=
':')
goto undefined_class;
376 goto undefined_class;
378 c = rb_const_search(c,
id, TRUE, FALSE, FALSE);
379 if (UNDEF_P(c))
goto undefined_class;
380 if (!rb_namespace_p(c)) {
381 rb_raise(
rb_eTypeError,
"%"PRIsVALUE
" does not refer to class/module",
390 rb_raise(rb_eArgError,
"undefined class/module % "PRIsVALUE,
391 rb_str_subseq(pathname, 0, p-path));
411 VALUE path = rb_tmp_class_path(
rb_class_real(klass), &permanent, make_temporary_path);
412 if (
NIL_P(path))
return NULL;
413 return RSTRING_PTR(path);
436 rb_gvar_compact_t *compactor;
446static enum rb_id_table_iterator_result
447free_global_entry_i(
ID key,
VALUE val,
void *arg)
450 if (entry->var->counter == 1) {
451 ruby_xfree(entry->var);
454 entry->var->counter--;
457 return ID_TABLE_DELETE;
461rb_free_rb_global_tbl(
void)
463 rb_id_table_foreach(rb_global_tbl, free_global_entry_i, 0);
464 rb_id_table_free(rb_global_tbl);
468rb_free_generic_iv_tbl_(
void)
470 st_free_table(generic_iv_tbl_);
474rb_find_global_entry(
ID id)
479 if (!rb_id_table_lookup(rb_global_tbl,
id, &data)) {
487 if (UNLIKELY(!rb_ractor_main_p()) && (!entry || !entry->ractor_local)) {
488 rb_raise(rb_eRactorIsolationError,
"can not access global variables %s from non-main Ractors", rb_id2name(
id));
495rb_gvar_ractor_local(
const char *name)
498 entry->ractor_local =
true;
502rb_gvar_undef_compactor(
void *var)
516 entry->ractor_local =
false;
522 var->compactor = rb_gvar_undef_compactor;
524 var->block_trace = 0;
526 rb_id_table_insert(rb_global_tbl,
id, (
VALUE)entry);
534 rb_warning(
"global variable `%"PRIsVALUE
"' not initialized", QUOTE_ID(
id));
540rb_gvar_val_compactor(
void *_var)
547 VALUE new = rb_gc_location(obj);
549 var->data = (
void*)
new;
561 var->compactor = rb_gvar_val_compactor;
563 var->data = (
void*)val;
581 var->data = (
void*)val;
588 if (data) rb_gc_mark_movable(data);
594 if (!var)
return Qnil;
607 if (var) rb_gc_mark_maybe(*var);
613 rb_name_error(
id,
"%"PRIsVALUE
" is a read-only variable", QUOTE_ID(
id));
616static enum rb_id_table_iterator_result
617mark_global_entry(
VALUE v,
void *ignored)
623 (*var->marker)(var->data);
626 if (trace->data) rb_gc_mark_maybe(trace->data);
629 return ID_TABLE_CONTINUE;
632#define gc_mark_table(task) \
633 if (rb_global_tbl) { rb_id_table_foreach_values(rb_global_tbl, task##_global_entry, 0); }
636rb_gc_mark_global_tbl(
void)
641static enum rb_id_table_iterator_result
642update_global_entry(
VALUE v,
void *ignored)
647 (*var->compactor)(var);
648 return ID_TABLE_CONTINUE;
652rb_gc_update_global_tbl(
void)
654 gc_mark_table(update);
658global_id(
const char *name)
662 if (name[0] ==
'$')
id = rb_intern(name);
664 size_t len = strlen(name);
668 memcpy(buf+1, name,
len);
669 id = rb_intern2(buf,
len+1);
676find_global_id(
const char *name)
679 size_t len = strlen(name);
681 if (name[0] ==
'$') {
688 memcpy(buf+1, name,
len);
704 ID id = global_id(name);
707 gvar->data = (
void*)var;
759 trace->next = entry->var->trace;
760 trace->func = rb_trace_eval;
763 entry->var->trace = trace;
777 while (trace->next) {
780 trace->next = next->next;
803 if ((entry = rb_find_global_entry(
id)) == NULL) {
804 rb_name_error(
id,
"undefined global variable %"PRIsVALUE
"", QUOTE_ID(
id));
807 trace = entry->var->trace;
809 VALUE ary = rb_ary_new();
813 rb_ary_push(ary, (
VALUE)trace->data);
818 if (!entry->var->block_trace) remove_trace(entry->var);
823 if (trace->data == cmd) {
825 if (!entry->var->block_trace) remove_trace(entry->var);
846 (*trace->func)(trace->data, data->val);
857 var->block_trace = 0;
868 (*var->setter)(val, entry->id, var->data);
870 if (var->trace && !var->block_trace) {
871 var->block_trace = 1;
872 trace.trace = var->trace;
885 return rb_gvar_set_entry(entry, val);
891 return rb_gvar_set(global_id(name), val);
899 return (*var->getter)(entry->id, var->data);
905 ID id = find_global_id(name);
908 rb_warning(
"global variable `%s' not initialized", name);
912 return rb_gvar_get(
id);
916rb_gvar_defined(
ID id)
923rb_gvar_getter_function_of(
ID id)
926 return entry->var->getter;
930rb_gvar_setter_function_of(
ID id)
933 return entry->var->setter;
936static enum rb_id_table_iterator_result
937gvar_i(
ID key,
VALUE val,
void *a)
940 rb_ary_push(ary,
ID2SYM(key));
941 return ID_TABLE_CONTINUE;
947 VALUE ary = rb_ary_new();
950 if (!rb_ractor_main_p()) {
951 rb_raise(rb_eRactorIsolationError,
"can not access global variables from non-main Ractors");
954 rb_id_table_foreach(rb_global_tbl, gvar_i, (
void *)ary);
955 if (!
NIL_P(backref)) {
957 int i, nmatch = rb_match_count(backref);
959 for (i = 1; i <= nmatch; ++i) {
963 buf[1] = (char)(i +
'0');
964 sym =
ID2SYM(rb_intern2(buf, 2));
968 sym = rb_str_intern(rb_sprintf(
"$%d", i));
970 rb_ary_push(ary, sym);
983 if (!rb_ractor_main_p()) {
984 rb_raise(rb_eRactorIsolationError,
"can not access global variables from non-main Ractors");
988 if (!rb_id_table_lookup(gtbl, name1, &data1)) {
991 rb_id_table_insert(gtbl, name1, (
VALUE)entry1);
993 else if ((entry1 = (
struct rb_global_entry *)data1)->var != entry2->var) {
995 if (var->block_trace) {
999 if (var->counter == 0) {
1012 entry2->var->counter++;
1013 entry1->var = entry2->var;
1017IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(
ID id)
1019 if (UNLIKELY(!rb_ractor_main_p())) {
1021 rb_raise(rb_eRactorIsolationError,
"can not set instance variables of classes/modules by non-main Ractors");
1026#define CVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR() \
1027 if (UNLIKELY(!rb_ractor_main_p())) { \
1028 rb_raise(rb_eRactorIsolationError, "can not access class variables from non-main Ractors"); \
1032generic_ivtbl(
VALUE obj,
ID id,
bool force_check_ractor)
1034 ASSERT_vm_locking();
1038 UNLIKELY(!rb_ractor_main_p()) &&
1041 rb_raise(rb_eRactorIsolationError,
"can not access instance variables of shareable objects from non-main Ractors");
1043 return generic_iv_tbl_;
1047generic_ivtbl_no_ractor_check(
VALUE obj)
1049 return generic_ivtbl(obj, 0,
false);
1062 if (st_lookup(generic_ivtbl(obj,
id,
false), (st_data_t)obj, &data)) {
1075 return rb_gen_ivtbl_get(obj, 0, ivtbl);
1079gen_ivtbl_bytes(
size_t n)
1081 return offsetof(
struct gen_ivtbl, as.shape.ivptr) + n *
sizeof(
VALUE);
1085gen_ivtbl_resize(
struct gen_ivtbl *old, uint32_t n)
1089 uint32_t
len = old ? old->as.shape.numiv : 0;
1092 ivtbl->as.shape.numiv = n;
1101rb_mark_generic_ivar(
VALUE obj)
1105 if (rb_gen_ivtbl_get(obj, 0, &ivtbl)) {
1106 if (rb_shape_obj_too_complex(obj)) {
1107 rb_mark_tbl_no_pin(ivtbl->as.complex.table);
1110 for (uint32_t i = 0; i < ivtbl->as.shape.numiv; i++) {
1111 rb_gc_mark_movable(ivtbl->as.shape.ivptr[i]);
1118rb_ref_update_generic_ivar(
VALUE obj)
1122 if (rb_gen_ivtbl_get(obj, 0, &ivtbl)) {
1123 if (rb_shape_obj_too_complex(obj)) {
1124 rb_gc_ref_update_table_values_only(ivtbl->as.complex.table);
1127 for (uint32_t i = 0; i < ivtbl->as.shape.numiv; i++) {
1128 ivtbl->as.shape.ivptr[i] = rb_gc_location(ivtbl->as.shape.ivptr[i]);
1137 st_data_t key = (st_data_t)rsrc;
1140 if (st_delete(generic_ivtbl_no_ractor_check(rsrc), &key, &ivtbl))
1141 st_insert(generic_ivtbl_no_ractor_check(dst), (st_data_t)dst, ivtbl);
1147 st_data_t key = (st_data_t)obj, value;
1149 bool too_complex = rb_shape_obj_too_complex(obj);
1151 if (st_delete(generic_ivtbl_no_ractor_check(obj), &key, &value)) {
1154 if (UNLIKELY(too_complex)) {
1155 st_free_table(ivtbl->as.complex.table);
1162RUBY_FUNC_EXPORTED
size_t
1163rb_generic_ivar_memsize(
VALUE obj)
1167 if (rb_gen_ivtbl_get(obj, 0, &ivtbl)) {
1168 if (rb_shape_obj_too_complex(obj)) {
1169 return sizeof(
struct gen_ivtbl) + st_memsize(ivtbl->as.complex.table);
1172 return gen_ivtbl_bytes(ivtbl->as.shape.numiv);
1178#if !SHAPE_IN_BASIC_FLAGS
1180rb_generic_shape_id(
VALUE obj)
1183 shape_id_t shape_id = 0;
1187 st_table* global_iv_table = generic_ivtbl(obj, 0,
false);
1189 if (global_iv_table && st_lookup(global_iv_table, obj, (st_data_t *)&ivtbl)) {
1190 shape_id = ivtbl->shape_id;
1193 shape_id = SPECIAL_CONST_SHAPE_ID;
1208 if (rb_shape_obj_too_complex(obj)) {
1209 n = st_table_size(ivtbl->as.complex.table);
1212 for (i = 0; i < ivtbl->as.shape.numiv; i++) {
1213 if (!UNDEF_P(ivtbl->as.shape.ivptr[i])) {
1227 shape_id_t shape_id;
1231#if SHAPE_IN_BASIC_FLAGS
1232 shape_id = RBASIC_SHAPE_ID(obj);
1244#if !SHAPE_IN_BASIC_FLAGS
1245 shape_id = RCLASS_SHAPE_ID(obj);
1248 if (rb_shape_obj_too_complex(obj)) {
1249 st_table * iv_table = RCLASS_IV_HASH(obj);
1250 if (rb_st_lookup(iv_table, (st_data_t)
id, (st_data_t *)&val)) {
1258 attr_index_t index = 0;
1259 shape = rb_shape_get_shape_by_id(shape_id);
1260 found = rb_shape_get_iv_index(shape,
id, &index);
1263 ivar_list = RCLASS_IVPTR(obj);
1266 val = ivar_list[index];
1277 UNLIKELY(!rb_ractor_main_p()) &&
1279 rb_raise(rb_eRactorIsolationError,
1280 "can not get unshareable values from instance variables of classes/modules from non-main Ractors");
1286#if !SHAPE_IN_BASIC_FLAGS
1287 shape_id = ROBJECT_SHAPE_ID(obj);
1289 if (rb_shape_obj_too_complex(obj)) {
1290 st_table * iv_table = ROBJECT_IV_HASH(obj);
1292 if (rb_st_lookup(iv_table, (st_data_t)
id, (st_data_t *)&val)) {
1307 rb_gen_ivtbl_get(obj,
id, &ivtbl);
1309 if (rb_shape_obj_too_complex(obj)) {
1311 if (rb_st_lookup(ivtbl->as.complex.table, (st_data_t)
id, (st_data_t *)&val)) {
1319#if !SHAPE_IN_BASIC_FLAGS
1320 shape_id = ivtbl->shape_id;
1322 ivar_list = ivtbl->as.shape.ivptr;
1330 attr_index_t index = 0;
1331 shape = rb_shape_get_shape_by_id(shape_id);
1332 if (rb_shape_get_iv_index(shape,
id, &index)) {
1333 return ivar_list[index];
1342 VALUE iv = rb_ivar_lookup(obj,
id,
Qnil);
1343 RB_DEBUG_COUNTER_INC(ivar_get_base);
1350 return rb_ivar_lookup(obj,
id,
Qnil);
1362 IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(
id);
1365 if (!rb_shape_transition_shape_remove_ivar(obj,
id, shape, &val)) {
1366 if (!rb_shape_obj_too_complex(obj)) {
1367 rb_evict_ivars_to_hash(obj);
1374 table = RCLASS_IV_HASH(obj);
1378 table = ROBJECT_IV_HASH(obj);
1383 if (rb_gen_ivtbl_get(obj, 0, &ivtbl)) {
1384 table = ivtbl->as.complex.table;
1391 if (!st_delete(table, (st_data_t *)&
id, (st_data_t *)&val)) {
1401rb_attr_delete(
VALUE obj,
ID id)
1403 return rb_ivar_delete(obj,
id,
Qnil);
1411 VALUE *old_ivptr = NULL;
1415 if (!(
RBASIC(obj)->flags & ROBJECT_EMBED)) {
1418 rb_shape_set_shape_id(obj, OBJ_TOO_COMPLEX_SHAPE_ID);
1419 ROBJECT_SET_IV_HASH(obj, table);
1423 old_ivptr = RCLASS_IVPTR(obj);
1424 rb_shape_set_shape_id(obj, OBJ_TOO_COMPLEX_SHAPE_ID);
1425 RCLASS_SET_IV_HASH(obj, table);
1430 struct st_table *gen_ivs = generic_ivtbl_no_ractor_check(obj);
1433 st_lookup(gen_ivs, (st_data_t)obj, (st_data_t *)&old_ivtbl);
1440#if SHAPE_IN_BASIC_FLAGS
1441 rb_shape_set_shape_id(obj, OBJ_TOO_COMPLEX_SHAPE_ID);
1443 old_ivtbl->shape_id = OBJ_TOO_COMPLEX_SHAPE_ID;
1445 old_ivtbl->as.complex.table = table;
1446 old_ivptr = (
VALUE *)old_ivtbl;
1450 ivtbl->as.complex.table = table;
1451 st_insert(gen_ivs, (st_data_t)obj, (st_data_t)ivtbl);
1452#if SHAPE_IN_BASIC_FLAGS
1453 rb_shape_set_shape_id(obj, OBJ_TOO_COMPLEX_SHAPE_ID);
1455 ivtbl->shape_id = OBJ_TOO_COMPLEX_SHAPE_ID;
1467rb_evict_ivars_to_hash(
VALUE obj)
1474 rb_obj_copy_ivs_to_hash_table(obj, table);
1475 rb_obj_convert_to_too_complex(obj, table);
1486general_ivar_set(
VALUE obj,
ID id,
VALUE val, void *data,
1488 void (*shape_resize_ivptr_func)(
VALUE, attr_index_t, attr_index_t,
void *),
1490 void (*transition_too_complex_func)(
VALUE,
void *),
1498 rb_shape_t *current_shape = rb_shape_get_shape(obj);
1500 if (UNLIKELY(current_shape->type == SHAPE_OBJ_TOO_COMPLEX)) {
1505 if (!rb_shape_get_iv_index(current_shape,
id, &index)) {
1506 result.existing =
false;
1508 index = current_shape->next_iv_index;
1509 if (index >= MAX_IVARS) {
1510 rb_raise(rb_eArgError,
"too many instance variables");
1513 rb_shape_t *next_shape = rb_shape_get_next(current_shape, obj,
id);
1514 if (UNLIKELY(next_shape->type == SHAPE_OBJ_TOO_COMPLEX)) {
1515 transition_too_complex_func(obj, data);
1518 else if (UNLIKELY(next_shape->capacity != current_shape->capacity)) {
1519 RUBY_ASSERT(next_shape->capacity > current_shape->capacity);
1520 shape_resize_ivptr_func(obj, current_shape->capacity, next_shape->capacity, data);
1524 RUBY_ASSERT(index == (next_shape->next_iv_index - 1));
1525 set_shape_func(obj, next_shape, data);
1528 VALUE *table = shape_ivptr_func(obj, data);
1531 result.index = index;
1538 st_table *table = too_complex_table_func(obj, data);
1539 result.existing = st_insert(table, (st_data_t)
id, (st_data_t)val);
1555generic_ivar_lookup_ensure_size(st_data_t *k, st_data_t *v, st_data_t u,
int existing)
1557 ASSERT_vm_locking();
1562 if (!existing || ivar_lookup->resize) {
1564 RUBY_ASSERT(ivar_lookup->shape->type == SHAPE_IVAR);
1565 RUBY_ASSERT(rb_shape_get_shape_by_id(ivar_lookup->shape->parent_id)->capacity < ivar_lookup->shape->capacity);
1571 ivtbl = gen_ivtbl_resize(ivtbl, ivar_lookup->shape->capacity);
1572 *v = (st_data_t)ivtbl;
1577 ivar_lookup->ivtbl = ivtbl;
1578 if (ivar_lookup->shape) {
1579#if SHAPE_IN_BASIC_FLAGS
1580 rb_shape_set_shape(ivar_lookup->obj, ivar_lookup->shape);
1582 ivtbl->shape_id = rb_shape_id(ivar_lookup->shape);
1590generic_ivar_set_shape_ivptr(
VALUE obj,
void *data)
1598 st_update(generic_ivtbl(obj, ivar_lookup->id,
false), (st_data_t)obj, generic_ivar_lookup_ensure_size, (st_data_t)ivar_lookup);
1604 return ivar_lookup->ivtbl->as.shape.ivptr;
1608generic_ivar_set_shape_resize_ivptr(
VALUE obj, attr_index_t _old_capa, attr_index_t new_capa,
void *data)
1612 ivar_lookup->resize =
true;
1620 ivar_lookup->shape = shape;
1624generic_ivar_set_transition_too_complex(
VALUE obj,
void *_data)
1626 rb_evict_ivars_to_hash(obj);
1631generic_ivar_set_too_complex_table(
VALUE obj,
void *data)
1636 if (!rb_gen_ivtbl_get(obj, 0, &ivtbl)) {
1638#if !SHAPE_IN_BASIC_FLAGS
1639 ivtbl->shape_id = SHAPE_OBJ_TOO_COMPLEX;
1641 ivtbl->as.complex.table = st_init_numtable_with_size(1);
1645 st_insert(generic_ivtbl(obj, ivar_lookup->id,
false), (st_data_t)obj, (st_data_t)ivtbl);
1654 return ivtbl->as.complex.table;
1667 general_ivar_set(obj,
id, val, &ivar_lookup,
1668 generic_ivar_set_shape_ivptr,
1669 generic_ivar_set_shape_resize_ivptr,
1670 generic_ivar_set_set_shape,
1671 generic_ivar_set_transition_too_complex,
1672 generic_ivar_set_too_complex_table);
1676rb_ensure_iv_list_size(
VALUE obj, uint32_t current_capacity, uint32_t new_capacity)
1680 if (
RBASIC(obj)->flags & ROBJECT_EMBED) {
1685 ROBJECT(obj)->as.heap.ivptr = newptr;
1693rb_obj_copy_ivs_to_hash_table_i(
ID key,
VALUE val, st_data_t arg)
1697 st_add_direct((
st_table *)arg, (st_data_t)key, (st_data_t)val);
1704 rb_ivar_foreach(obj, rb_obj_copy_ivs_to_hash_table_i, (st_data_t)table);
1708obj_ivar_set_shape_ivptr(
VALUE obj,
void *_data)
1716obj_ivar_set_shape_resize_ivptr(
VALUE obj, attr_index_t old_capa, attr_index_t new_capa,
void *_data)
1718 rb_ensure_iv_list_size(obj, old_capa, new_capa);
1724 rb_shape_set_shape(obj, shape);
1728obj_ivar_set_transition_too_complex(
VALUE obj,
void *_data)
1730 rb_evict_ivars_to_hash(obj);
1734obj_ivar_set_too_complex_table(
VALUE obj,
void *_data)
1738 return ROBJECT_IV_HASH(obj);
1744 return general_ivar_set(obj,
id, val, NULL,
1745 obj_ivar_set_shape_ivptr,
1746 obj_ivar_set_shape_resize_ivptr,
1747 obj_ivar_set_set_shape,
1748 obj_ivar_set_transition_too_complex,
1749 obj_ivar_set_too_complex_table).index;
1760 rb_obj_ivar_set(obj,
id, val);
1765rb_shape_set_shape_id(
VALUE obj, shape_id_t shape_id)
1767 if (rb_shape_get_shape_id(obj) == shape_id) {
1771#if SHAPE_IN_BASIC_FLAGS
1772 RBASIC_SET_SHAPE_ID(obj, shape_id);
1776 ROBJECT_SET_SHAPE_ID(obj, shape_id);
1780 RCLASS_SET_SHAPE_ID(obj, shape_id);
1783 if (shape_id != SPECIAL_CONST_SHAPE_ID) {
1787 st_table* global_iv_table = generic_ivtbl(obj, 0,
false);
1789 if (st_lookup(global_iv_table, obj, (st_data_t *)&ivtbl)) {
1790 ivtbl->shape_id = shape_id;
1793 rb_bug(
"Expected shape_id entry in global iv table");
1815 rb_shape_t * next_shape = rb_shape_transition_shape_frozen(x);
1819 if (!rb_shape_obj_too_complex(x) && next_shape->type == SHAPE_OBJ_TOO_COMPLEX) {
1820 rb_evict_ivars_to_hash(x);
1822 rb_shape_set_shape(x, next_shape);
1833 RB_DEBUG_COUNTER_INC(ivar_set_base);
1838 rb_obj_ivar_set(obj,
id, val);
1843 IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(
id);
1844 rb_class_ivar_set(obj,
id, val);
1848 generic_ivar_set(obj,
id, val);
1857 ivar_set(obj,
id, val);
1867 ivar_set(obj,
id, val);
1876 if (rb_shape_obj_too_complex(obj)) {
1882 table = (
st_table *)RCLASS_IVPTR(obj);
1886 table = ROBJECT_IV_HASH(obj);
1891 if (rb_gen_ivtbl_get(obj, 0, &ivtbl)) {
1892 table = ivtbl->as.complex.table;
1898 if (!table || !rb_st_lookup(table,
id, &idx)) {
1905 return RBOOL(rb_shape_get_iv_index(rb_shape_get_shape(obj),
id, &index));
1909typedef int rb_ivar_foreach_callback_func(
ID key,
VALUE val, st_data_t arg);
1910st_data_t rb_st_nth_key(
st_table *tab, st_index_t index);
1916 rb_ivar_foreach_callback_func *func;
1923iterate_over_shapes_with_callback(
rb_shape_t *shape, rb_ivar_foreach_callback_func *callback,
struct iv_itr_data * itr_data)
1925 switch ((
enum shape_type)shape->type) {
1930 if (iterate_over_shapes_with_callback(rb_shape_get_parent(shape), callback, itr_data))
1935 RUBY_ASSERT(!rb_shape_obj_too_complex(itr_data->obj));
1940 iv_list = RCLASS_IVPTR(itr_data->obj);
1943 iv_list = itr_data->ivtbl->as.shape.ivptr;
1946 VALUE val = iv_list[shape->next_iv_index - 1];
1947 if (!UNDEF_P(val)) {
1948 switch (callback(shape->edge_name, val, itr_data->arg)) {
1955 rb_bug(
"unreachable");
1960 case SHAPE_T_OBJECT:
1961 return iterate_over_shapes_with_callback(rb_shape_get_parent(shape), callback, itr_data);
1962 case SHAPE_OBJ_TOO_COMPLEX:
1964 rb_bug(
"Unreachable");
1969each_hash_iv(st_data_t
id, st_data_t val, st_data_t data)
1972 rb_ivar_foreach_callback_func *callback = itr_data->func;
1973 return callback((
ID)
id, (
VALUE)val, itr_data->arg);
1977obj_ivar_each(
VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg)
1983 itr_data.func = func;
1984 if (rb_shape_obj_too_complex(obj)) {
1985 rb_st_foreach(ROBJECT_IV_HASH(obj), each_hash_iv, (st_data_t)&itr_data);
1988 iterate_over_shapes_with_callback(shape, func, &itr_data);
1993gen_ivar_each(
VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg)
1997 if (!rb_gen_ivtbl_get(obj, 0, &ivtbl))
return;
2001 itr_data.ivtbl = ivtbl;
2003 itr_data.func = func;
2004 if (rb_shape_obj_too_complex(obj)) {
2005 rb_st_foreach(ivtbl->as.complex.table, each_hash_iv, (st_data_t)&itr_data);
2008 iterate_over_shapes_with_callback(shape, func, &itr_data);
2013class_ivar_each(
VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg)
2021 itr_data.func = func;
2022 if (rb_shape_obj_too_complex(obj)) {
2023 rb_st_foreach(RCLASS_IV_HASH(obj), each_hash_iv, (st_data_t)&itr_data);
2026 iterate_over_shapes_with_callback(shape, func, &itr_data);
2042 if (rb_gen_ivtbl_get(obj, 0, &obj_ivtbl)) {
2043 if (gen_ivtbl_count(obj, obj_ivtbl) == 0)
2048 if (rb_shape_obj_too_complex(obj)) {
2050#if !SHAPE_IN_BASIC_FLAGS
2051 new_ivtbl->shape_id = SHAPE_OBJ_TOO_COMPLEX;
2053 new_ivtbl->as.complex.table = st_copy(obj_ivtbl->as.complex.table);
2056 new_ivtbl = gen_ivtbl_resize(0, obj_ivtbl->as.shape.numiv);
2058 for (uint32_t i=0; i<obj_ivtbl->as.shape.numiv; i++) {
2059 RB_OBJ_WRITE(clone, &new_ivtbl->as.shape.ivptr[i], obj_ivtbl->as.shape.ivptr[i]);
2069 generic_ivtbl_no_ractor_check(clone);
2070 st_insert(generic_ivtbl_no_ractor_check(obj), (st_data_t)clone, (st_data_t)new_ivtbl);
2074 rb_shape_t * obj_shape = rb_shape_get_shape(obj);
2075 if (rb_shape_frozen_shape_p(obj_shape)) {
2076 rb_shape_set_shape_id(clone, obj_shape->parent_id);
2079 rb_shape_set_shape(clone, obj_shape);
2092rb_replace_generic_ivar(
VALUE clone,
VALUE obj)
2098 st_data_t ivtbl, obj_data = (st_data_t)obj;
2099 if (st_lookup(generic_iv_tbl_, (st_data_t)obj, &ivtbl)) {
2100 st_insert(generic_iv_tbl_, (st_data_t)clone, ivtbl);
2101 st_delete(generic_iv_tbl_, &obj_data, NULL);
2104 rb_bug(
"unreachable");
2118 obj_ivar_each(obj, func, arg);
2122 IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(0);
2125 class_ivar_each(obj, func, arg);
2131 gen_ivar_each(obj, func, arg);
2144 return ROBJECT_IV_COUNT(obj);
2147 return RCLASS_IV_COUNT(obj);
2152 if (rb_gen_ivtbl_get(obj, 0, &ivtbl)) {
2153 return gen_ivtbl_count(obj, ivtbl);
2162ivar_i(
ID key,
VALUE v, st_data_t a)
2167 rb_ary_push(ary,
ID2SYM(key));
2199#define rb_is_constant_id rb_is_const_id
2200#define rb_is_constant_name rb_is_const_name
2201#define id_for_var(obj, name, part, type) \
2202 id_for_var_message(obj, name, type, "`%1$s' is not allowed as "#part" "#type" variable name")
2203#define id_for_var_message(obj, name, type, message) \
2204 check_id_type(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message))
2207 int (*valid_id_p)(
ID),
int (*valid_name_p)(
VALUE),
2208 const char *message,
size_t message_len)
2211 VALUE name = *pname;
2213 if (
id ? !valid_id_p(
id) : !valid_name_p(name)) {
2214 rb_name_err_raise_str(rb_fstring_new(message, message_len),
2247 const ID id = id_for_var(obj, name, an, instance);
2256 if (val !=
Qundef)
return val;
2259 rb_name_err_raise(
"instance variable %1$s not defined",
2264NORETURN(
static void uninitialized_constant(
VALUE,
VALUE));
2266uninitialized_constant(
VALUE klass,
VALUE name)
2269 rb_name_err_raise(
"uninitialized constant %2$s::%1$s",
2272 rb_name_err_raise(
"uninitialized constant %1$s",
2279 VALUE value = rb_funcallv(klass, idConst_missing, 1, &name);
2280 rb_vm_inc_const_missing_count();
2325 VALUE ref = ec->private_const_reference;
2326 rb_vm_pop_cfunc_frame();
2328 ec->private_const_reference = 0;
2329 rb_name_err_raise(
"private constant %2$s::%1$s referenced", ref, name);
2331 uninitialized_constant(klass, name);
2337autoload_table_mark(
void *ptr)
2339 rb_mark_tbl_no_pin((
st_table *)ptr);
2343autoload_table_free(
void *ptr)
2349autoload_table_memsize(
const void *ptr)
2352 return st_memsize(tbl);
2356autoload_table_compact(
void *ptr)
2358 rb_gc_update_tbl_refs((
st_table *)ptr);
2363 {autoload_table_mark, autoload_table_free, autoload_table_memsize, autoload_table_compact,},
2364 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
2367#define check_autoload_table(av) \
2368 (struct st_table *)rb_check_typeddata((av), &autoload_table_type)
2383 mod =
RBASIC(mod)->klass;
2391 VALUE tbl_value = rb_ivar_lookup(mod, autoload,
Qfalse);
2392 if (!
RTEST(tbl_value) || !(tbl = check_autoload_table(tbl_value)) || !st_lookup(tbl, (st_data_t)
id, &val)) {
2402 struct ccan_list_node cnode;
2405 VALUE autoload_data_value;
2417 rb_const_flag_t flag;
2433 rb_serial_t fork_gen;
2436 struct ccan_list_head constants;
2440autoload_data_compact(
void *ptr)
2444 p->feature = rb_gc_location(p->feature);
2445 p->mutex = rb_gc_location(p->mutex);
2449autoload_data_mark(
void *ptr)
2453 rb_gc_mark_movable(p->feature);
2454 rb_gc_mark_movable(p->mutex);
2458autoload_data_free(
void *ptr)
2463 if (ccan_list_empty(&p->constants)) {
2469autoload_data_memsize(
const void *ptr)
2476 {autoload_data_mark, autoload_data_free, autoload_data_memsize, autoload_data_compact},
2477 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
2481autoload_const_compact(
void *ptr)
2485 ac->module = rb_gc_location(ac->module);
2486 ac->autoload_data_value = rb_gc_location(ac->autoload_data_value);
2487 ac->value = rb_gc_location(ac->value);
2488 ac->file = rb_gc_location(ac->file);
2492autoload_const_mark(
void *ptr)
2496 rb_gc_mark_movable(ac->module);
2497 rb_gc_mark_movable(ac->autoload_data_value);
2498 rb_gc_mark_movable(ac->value);
2499 rb_gc_mark_movable(ac->file);
2503autoload_const_memsize(
const void *ptr)
2509autoload_const_free(
void *ptr)
2519 {autoload_const_mark, autoload_const_free, autoload_const_memsize, autoload_const_compact,},
2520 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
2524get_autoload_data(
VALUE autoload_const_value,
struct autoload_const **autoload_const_pointer)
2537 if (autoload_const_pointer) *autoload_const_pointer =
autoload_const;
2542RUBY_FUNC_EXPORTED
void
2543rb_autoload(
VALUE module,
ID name,
const char *feature)
2545 if (!feature || !*feature) {
2546 rb_raise(rb_eArgError,
"empty feature name");
2549 rb_autoload_str(module, name, rb_fstring_cstr(feature));
2553static void const_added(
VALUE klass,
ID const_name);
2562autoload_feature_lookup_or_create(
VALUE feature,
struct autoload_data **autoload_data_pointer)
2564 RUBY_ASSERT_MUTEX_OWNED(autoload_mutex);
2565 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
2567 VALUE autoload_data_value = rb_hash_aref(autoload_features, feature);
2570 if (
NIL_P(autoload_data_value)) {
2576 if (autoload_data_pointer) *autoload_data_pointer =
autoload_data;
2578 rb_hash_aset(autoload_features, feature, autoload_data_value);
2580 else if (autoload_data_pointer) {
2581 *autoload_data_pointer =
rb_check_typeddata(autoload_data_value, &autoload_data_type);
2584 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
2585 return autoload_data_value;
2589autoload_table_lookup_or_create(
VALUE module)
2591 VALUE autoload_table_value = rb_ivar_lookup(module, autoload,
Qfalse);
2592 if (
RTEST(autoload_table_value)) {
2593 return autoload_table_value;
2597 rb_class_ivar_set(module, autoload, autoload_table_value);
2599 return autoload_table_value;
2604autoload_synchronized(
VALUE _arguments)
2608 rb_const_entry_t *constant_entry = rb_const_lookup(arguments->module, arguments->name);
2609 if (constant_entry && !UNDEF_P(constant_entry->value)) {
2614 const_set(arguments->module, arguments->name,
Qundef);
2616 VALUE autoload_table_value = autoload_table_lookup_or_create(arguments->module);
2617 struct st_table *autoload_table = check_autoload_table(autoload_table_value);
2620 VALUE feature = rb_fstring(arguments->feature);
2623 VALUE autoload_data_value = autoload_feature_lookup_or_create(feature, &
autoload_data);
2634 st_insert(autoload_table, (st_data_t)arguments->name, (st_data_t)autoload_const_value);
2645 rb_raise(
rb_eNameError,
"autoload must be constant name: %"PRIsVALUE
"", QUOTE_ID(name));
2649 if (!RSTRING_LEN(feature)) {
2650 rb_raise(rb_eArgError,
"empty feature name");
2661 if (result ==
Qtrue) {
2662 const_added(module, name);
2667autoload_delete(
VALUE module,
ID name)
2669 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
2671 st_data_t load = 0, key = name;
2675 VALUE table_value = rb_ivar_lookup(module, autoload,
Qfalse);
2676 if (
RTEST(table_value)) {
2677 struct st_table *table = check_autoload_table(table_value);
2679 st_delete(table, &key, &load);
2702 if (table->num_entries == 0) {
2703 rb_attr_delete(module, autoload);
2708 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
2714 return ele->mutex !=
Qnil && !rb_mutex_owned_p(ele->mutex);
2718check_autoload_required(
VALUE mod,
ID id,
const char **loadingpath)
2722 const char *loading;
2724 if (!autoload_const_value || !(
autoload_data = get_autoload_data(autoload_const_value, 0))) {
2737 return autoload_const_value;
2740 loading = RSTRING_PTR(feature);
2743 return autoload_const_value;
2746 if (loadingpath && loading) {
2747 *loadingpath = loading;
2748 return autoload_const_value;
2757rb_autoloading_value(
VALUE mod,
ID id,
VALUE* value, rb_const_flag_t *flag)
2760 if (!ac)
return FALSE;
2776 return ele->mutex !=
Qnil && rb_mutex_owned_p(ele->mutex);
2783autoloading_const_entry(
VALUE mod,
ID id)
2790 if (!load || !(ele = get_autoload_data(load, &ac))) {
2796 if (autoload_by_current(ele)) {
2797 if (!UNDEF_P(ac->value)) {
2806autoload_defined_p(
VALUE mod,
ID id)
2811 if (!ce || !UNDEF_P(ce->value)) {
2817 return !rb_autoloading_value(mod,
id, NULL, NULL);
2839 check_before_mod_set(ac->module, ac->name, ac->value,
"constant");
2843 const_tbl_update(ac,
true);
2851autoload_load_needed(
VALUE _arguments)
2855 const char *loading = 0, *src;
2857 if (!autoload_defined_p(arguments->module, arguments->name)) {
2861 VALUE autoload_const_value = check_autoload_required(arguments->module, arguments->name, &loading);
2862 if (!autoload_const_value) {
2867 if (src && loading && strcmp(src, loading) == 0) {
2888 return autoload_const_value;
2892autoload_apply_constants(
VALUE _arguments)
2894 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
2906 ccan_list_for_each_safe(&arguments->autoload_data->constants,
autoload_const, next, cnode) {
2912 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
2918autoload_feature_require(
VALUE _arguments)
2927 VALUE result =
rb_funcall(rb_vm_top_self(), rb_intern(
"require"), 1, arguments->autoload_data->feature);
2929 if (
RTEST(result)) {
2937autoload_try_load(
VALUE _arguments)
2941 VALUE result = autoload_feature_require(_arguments);
2944 rb_const_entry_t *ce = rb_const_lookup(arguments->module, arguments->name);
2946 if (!ce || UNDEF_P(ce->value)) {
2951 if (arguments->module == rb_cObject) {
2953 "Expected %"PRIsVALUE
" to define %"PRIsVALUE
" but it didn't",
2954 arguments->autoload_data->feature,
2960 "Expected %"PRIsVALUE
" to define %"PRIsVALUE
"::%"PRIsVALUE
" but it didn't",
2961 arguments->autoload_data->feature,
2969 ce->flag |= arguments->flag;
2981 if (!ce || !UNDEF_P(ce->value)) {
2986 if (UNLIKELY(!rb_ractor_main_p())) {
2987 rb_raise(rb_eRactorUnsafeError,
"require by autoload on non-main Ractor is not supported (%s)", rb_id2name(name));
2997 if (autoload_const_value ==
Qfalse)
return autoload_const_value;
2999 arguments.flag = ce->flag & (CONST_DEPRECATED | CONST_VISIBILITY_MASK);
3016 return rb_autoload_at_p(mod,
id, TRUE);
3020rb_autoload_at_p(
VALUE mod,
ID id,
int recur)
3025 while (!autoload_defined_p(mod,
id)) {
3026 if (!recur)
return Qnil;
3028 if (!mod)
return Qnil;
3030 load = check_autoload_required(mod,
id, 0);
3031 if (!load)
return Qnil;
3032 return (ele = get_autoload_data(load, 0)) ? ele->feature :
Qnil;
3038 if (RB_CONST_DEPRECATED_P(ce) &&
3040 if (klass == rb_cObject) {
3051rb_const_get_0(
VALUE klass,
ID id,
int exclude,
int recurse,
int visibility)
3053 VALUE c = rb_const_search(klass,
id, exclude, recurse, visibility);
3055 if (UNLIKELY(!rb_ractor_main_p())) {
3057 rb_raise(rb_eRactorIsolationError,
"can not access non-shareable objects in constant %"PRIsVALUE
"::%s by non-main Ractor.",
rb_class_path(klass), rb_id2name(
id));
3062 return rb_const_missing(klass,
ID2SYM(
id));
3066rb_const_search_from(
VALUE klass,
ID id,
int exclude,
int recurse,
int visibility)
3068 VALUE value, current;
3069 bool first_iteration =
true;
3071 for (current = klass;
3073 current =
RCLASS_SUPER(current), first_iteration =
false) {
3078 if (!first_iteration && RCLASS_ORIGIN(current) != current) {
3091 while ((ce = rb_const_lookup(tmp,
id))) {
3092 if (visibility && RB_CONST_PRIVATE_P(ce)) {
3093 GET_EC()->private_const_reference = tmp;
3096 rb_const_warn_if_deprecated(ce, tmp,
id);
3098 if (UNDEF_P(value)) {
3100 if (am == tmp)
break;
3102 ac = autoloading_const_entry(tmp,
id);
3103 if (ac)
return ac->value;
3107 if (exclude && tmp == rb_cObject) {
3112 if (!recurse)
break;
3116 GET_EC()->private_const_reference = 0;
3121rb_const_search(
VALUE klass,
ID id,
int exclude,
int recurse,
int visibility)
3125 if (klass == rb_cObject) exclude = FALSE;
3126 value = rb_const_search_from(klass,
id, exclude, recurse, visibility);
3127 if (!UNDEF_P(value))
return value;
3128 if (exclude)
return value;
3131 return rb_const_search_from(rb_cObject,
id, FALSE, recurse, visibility);
3137 return rb_const_get_0(klass,
id, TRUE, TRUE, FALSE);
3143 return rb_const_get_0(klass,
id, FALSE, TRUE, FALSE);
3149 return rb_const_get_0(klass,
id, TRUE, FALSE, FALSE);
3153rb_public_const_get_from(
VALUE klass,
ID id)
3155 return rb_const_get_0(klass,
id, TRUE, TRUE, TRUE);
3159rb_public_const_get_at(
VALUE klass,
ID id)
3161 return rb_const_get_0(klass,
id, TRUE, FALSE, TRUE);
3164NORETURN(
static void undefined_constant(
VALUE mod,
VALUE name));
3168 rb_name_err_raise(
"constant %2$s::%1$s not defined",
3173rb_const_location_from(
VALUE klass,
ID id,
int exclude,
int recurse,
int visibility)
3175 while (
RTEST(klass)) {
3178 while ((ce = rb_const_lookup(klass,
id))) {
3179 if (visibility && RB_CONST_PRIVATE_P(ce)) {
3182 if (exclude && klass == rb_cObject) {
3185 if (
NIL_P(ce->file))
return rb_ary_new();
3186 return rb_assoc_new(ce->file,
INT2NUM(ce->line));
3188 if (!recurse)
break;
3197rb_const_location(
VALUE klass,
ID id,
int exclude,
int recurse,
int visibility)
3201 if (klass == rb_cObject) exclude = FALSE;
3202 loc = rb_const_location_from(klass,
id, exclude, recurse, visibility);
3203 if (!
NIL_P(loc))
return loc;
3204 if (exclude)
return loc;
3207 return rb_const_location_from(rb_cObject,
id, FALSE, recurse, visibility);
3211rb_const_source_location(
VALUE klass,
ID id)
3213 return rb_const_location(klass,
id, FALSE, TRUE, FALSE);
3217rb_const_source_location_at(
VALUE klass,
ID id)
3219 return rb_const_location(klass,
id, TRUE, FALSE, FALSE);
3235 const ID id = id_for_var(mod, name, a, constant);
3238 undefined_constant(mod, name);
3251 ce = rb_const_lookup(mod,
id);
3252 if (!ce || !rb_id_table_delete(RCLASS_CONST_TBL(mod),
id)) {
3254 rb_name_err_raise(
"cannot remove %2$s::%1$s", mod,
ID2SYM(
id));
3257 undefined_constant(mod,
ID2SYM(
id));
3265 autoload_delete(mod,
id);
3275cv_i_update(st_data_t *k, st_data_t *v, st_data_t a,
int existing)
3277 if (existing)
return ST_STOP;
3282static enum rb_id_table_iterator_result
3289 st_update(tbl, (st_data_t)key, cv_i_update, (st_data_t)ce);
3291 return ID_TABLE_CONTINUE;
3294static enum rb_id_table_iterator_result
3295rb_local_constants_i(
ID const_name,
VALUE const_value,
void *ary)
3300 return ID_TABLE_CONTINUE;
3304rb_local_constants(
VALUE mod)
3314 rb_id_table_foreach(tbl, rb_local_constants_i, (
void *)ary);
3326 tbl = st_init_numtable();
3328 if (RCLASS_CONST_TBL(mod)) {
3331 rb_id_table_foreach(RCLASS_CONST_TBL(mod), sv_i, tbl);
3346 if (tmp == rb_cObject && mod != rb_cObject)
break;
3352list_i(st_data_t key, st_data_t value,
VALUE ary)
3356 if (RB_CONST_PUBLIC_P(ce)) rb_ary_push(ary,
ID2SYM(sym));
3395 bool inherit =
true;
3403 return rb_local_constants(mod);
3408rb_const_defined_0(
VALUE klass,
ID id,
int exclude,
int recurse,
int visibility)
3417 if ((ce = rb_const_lookup(tmp,
id))) {
3418 if (visibility && RB_CONST_PRIVATE_P(ce)) {
3421 if (UNDEF_P(ce->value) && !check_autoload_required(tmp,
id, 0) &&
3422 !rb_autoloading_value(tmp,
id, NULL, NULL))
3425 if (exclude && tmp == rb_cObject && klass != rb_cObject) {
3431 if (!recurse)
break;
3445 return rb_const_defined_0(klass,
id, TRUE, TRUE, FALSE);
3451 return rb_const_defined_0(klass,
id, FALSE, TRUE, FALSE);
3457 return rb_const_defined_0(klass,
id, TRUE, FALSE, FALSE);
3461rb_public_const_defined_from(
VALUE klass,
ID id)
3463 return rb_const_defined_0(klass,
id, TRUE, TRUE, TRUE);
3467check_before_mod_set(
VALUE klass,
ID id,
VALUE val,
const char *dest)
3472static void set_namespace_path(
VALUE named_namespace,
VALUE name);
3474static enum rb_id_table_iterator_result
3475set_namespace_path_i(
ID id,
VALUE v,
void *payload)
3478 VALUE value = ce->value;
3481 return ID_TABLE_CONTINUE;
3484 bool has_permanent_classpath;
3485 classname(value, &has_permanent_classpath);
3486 if (has_permanent_classpath) {
3487 return ID_TABLE_CONTINUE;
3489 set_namespace_path(value, build_const_path(parental_path,
id));
3491 if (!RCLASS_EXT(value)->permanent_classpath) {
3492 RCLASS_SET_CLASSPATH(value, 0,
false);
3495 return ID_TABLE_CONTINUE;
3504set_namespace_path(
VALUE named_namespace,
VALUE namespace_path)
3506 struct rb_id_table *const_table = RCLASS_CONST_TBL(named_namespace);
3510 RCLASS_SET_CLASSPATH(named_namespace, namespace_path,
true);
3513 rb_id_table_foreach(const_table, set_namespace_path_i, &namespace_path);
3520const_added(
VALUE klass,
ID const_name)
3522 if (GET_VM()->running) {
3524 rb_funcallv(klass, idConst_added, 1, &name);
3534 rb_raise(
rb_eTypeError,
"no class/module to define constant %"PRIsVALUE
"",
3539 rb_raise(rb_eRactorIsolationError,
"can not set constants with non-shareable objects by non-main Ractors");
3542 check_before_mod_set(klass,
id, val,
"constant");
3546 struct rb_id_table *tbl = RCLASS_CONST_TBL(klass);
3548 RCLASS_CONST_TBL(klass) = tbl = rb_id_table_create(0);
3551 rb_id_table_insert(tbl,
id, (
VALUE)ce);
3552 setup_const_entry(ce, klass, val, CONST_PUBLIC);
3556 .module = klass, .name = id,
3557 .value = val, .flag = CONST_PUBLIC,
3560 ac.file = rb_source_location(&ac.line);
3561 const_tbl_update(&ac,
false);
3570 if (rb_cObject && rb_namespace_p(val)) {
3571 bool val_path_permanent;
3572 VALUE val_path = classname(val, &val_path_permanent);
3573 if (
NIL_P(val_path) || !val_path_permanent) {
3574 if (klass == rb_cObject) {
3575 set_namespace_path(val, rb_id2str(
id));
3578 bool parental_path_permanent;
3579 VALUE parental_path = classname(klass, &parental_path_permanent);
3580 if (
NIL_P(parental_path)) {
3582 parental_path = rb_tmp_class_path(klass, &throwaway, make_temporary_path);
3584 if (parental_path_permanent && !val_path_permanent) {
3585 set_namespace_path(val, build_const_path(parental_path,
id));
3587 else if (!parental_path_permanent &&
NIL_P(val_path)) {
3588 RCLASS_SET_CLASSPATH(val, build_const_path(parental_path,
id),
false);
3598 const_set(klass,
id, val);
3599 const_added(klass,
id);
3603autoload_data_for_named_constant(
VALUE module,
ID name,
struct autoload_const **autoload_const_pointer)
3606 if (!autoload_data_value)
return 0;
3623 VALUE klass = ac->module;
3624 VALUE val = ac->value;
3626 struct rb_id_table *tbl = RCLASS_CONST_TBL(klass);
3627 rb_const_flag_t visibility = ac->flag;
3630 if (rb_id_table_lookup(tbl,
id, &value)) {
3632 if (UNDEF_P(ce->value)) {
3633 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
3634 VALUE file = ac->file;
3635 int line = ac->line;
3636 struct autoload_data *ele = autoload_data_for_named_constant(klass,
id, &ac);
3638 if (!autoload_force && ele) {
3642 ac->file = rb_source_location(&ac->line);
3646 autoload_delete(klass,
id);
3647 ce->flag = visibility;
3652 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
3656 VALUE name = QUOTE_ID(
id);
3657 visibility = ce->flag;
3658 if (klass == rb_cObject)
3659 rb_warn(
"already initialized constant %"PRIsVALUE
"", name);
3661 rb_warn(
"already initialized constant %"PRIsVALUE
"::%"PRIsVALUE
"",
3663 if (!
NIL_P(ce->file) && ce->line) {
3664 rb_compile_warn(RSTRING_PTR(ce->file), ce->line,
3665 "previous definition of %"PRIsVALUE
" was here", name);
3669 setup_const_entry(ce, klass, val, visibility);
3675 rb_id_table_insert(tbl,
id, (
VALUE)ce);
3676 setup_const_entry(ce, klass, val, visibility);
3682 rb_const_flag_t visibility)
3684 ce->flag = visibility;
3686 RB_OBJ_WRITE(klass, &ce->file, rb_source_location(&ce->line));
3692 ID id = rb_intern(name);
3695 rb_warn(
"rb_define_const: invalid name `%s' for constant", name);
3697 rb_gc_register_mark_object(val);
3708set_const_visibility(
VALUE mod,
int argc,
const VALUE *argv,
3709 rb_const_flag_t flag, rb_const_flag_t mask)
3717 rb_warning(
"%"PRIsVALUE
" with no argument is just ignored",
3718 QUOTE_ID(rb_frame_callee()));
3722 for (i = 0; i < argc; i++) {
3724 VALUE val = argv[i];
3727 undefined_constant(mod, val);
3729 if ((ce = rb_const_lookup(mod,
id))) {
3732 if (UNDEF_P(ce->value)) {
3735 ele = autoload_data_for_named_constant(mod,
id, &ac);
3744 undefined_constant(mod,
ID2SYM(
id));
3754 long len = strlen(name);
3758 undefined_constant(mod, rb_fstring_new(name,
len));
3760 if (!(ce = rb_const_lookup(mod,
id))) {
3761 undefined_constant(mod,
ID2SYM(
id));
3763 ce->flag |= CONST_DEPRECATED;
3774rb_mod_private_constant(
int argc,
const VALUE *argv,
VALUE obj)
3776 set_const_visibility(obj, argc, argv, CONST_PRIVATE, CONST_VISIBILITY_MASK);
3788rb_mod_public_constant(
int argc,
const VALUE *argv,
VALUE obj)
3790 set_const_visibility(obj, argc, argv, CONST_PUBLIC, CONST_VISIBILITY_MASK);
3814rb_mod_deprecate_constant(
int argc,
const VALUE *argv,
VALUE obj)
3816 set_const_visibility(obj, argc, argv, CONST_DEPRECATED, CONST_DEPRECATED);
3821original_module(
VALUE c)
3829cvar_lookup_at(
VALUE klass,
ID id, st_data_t *v)
3837 klass =
RBASIC(klass)->klass;
3842 if (UNDEF_P(n))
return 0;
3849cvar_front_klass(
VALUE klass)
3852 VALUE obj = RCLASS_ATTACHED_OBJECT(klass);
3853 if (rb_namespace_p(obj)) {
3863 if (front && target != front) {
3864 if (original_module(front) != original_module(target)) {
3866 "class variable % "PRIsVALUE
" of %"PRIsVALUE
" is overtaken by %"PRIsVALUE
"",
3871 rb_ivar_delete(front,
id,
Qundef);
3876#define CVAR_FOREACH_ANCESTORS(klass, v, r) \
3877 for (klass = cvar_front_klass(klass); klass; klass = RCLASS_SUPER(klass)) { \
3878 if (cvar_lookup_at(klass, id, (v))) { \
3883#define CVAR_LOOKUP(v,r) do {\
3884 CVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(); \
3885 if (cvar_lookup_at(klass, id, (v))) {r;}\
3886 CVAR_FOREACH_ANCESTORS(klass, v, r);\
3904check_for_cvar_table(
VALUE subclass,
VALUE key)
3908 RB_DEBUG_COUNTER_INC(cvar_class_invalidate);
3909 ruby_vm_global_cvar_state++;
3913 rb_class_foreach_subclass(subclass, check_for_cvar_table, key);
3919 VALUE tmp, front = 0, target = 0;
3922 CVAR_LOOKUP(0, {
if (!front) front = klass; target = klass;});
3924 cvar_overtaken(front, target,
id);
3931 target =
RBASIC(target)->klass;
3933 check_before_mod_set(target,
id, val,
"class variable");
3935 int result = rb_class_ivar_set(target,
id, val);
3937 struct rb_id_table *rb_cvc_tbl = RCLASS_CVC_TBL(target);
3940 rb_cvc_tbl = RCLASS_CVC_TBL(target) = rb_id_table_create(2);
3946 if (!rb_id_table_lookup(rb_cvc_tbl,
id, &ent_data)) {
3948 ent->class_value = target;
3949 ent->global_cvar_state = GET_GLOBAL_CVAR_STATE();
3951 rb_id_table_insert(rb_cvc_tbl,
id, (
VALUE)ent);
3952 RB_DEBUG_COUNTER_INC(cvar_inline_miss);
3955 ent = (
void *)ent_data;
3956 ent->global_cvar_state = GET_GLOBAL_CVAR_STATE();
3963 if (RB_TYPE_P(target,
T_CLASS)) {
3964 if (RCLASS_SUBCLASSES(target)) {
3965 rb_class_foreach_subclass(target, check_for_cvar_table,
id);
3977 value = find_cvar(klass, front, &target,
id);
3979 rb_name_err_raise(
"uninitialized class variable %1$s in %2$s",
3982 cvar_overtaken(*front, target,
id);
3983 return (
VALUE)value;
3996 if (!klass)
return Qfalse;
3997 CVAR_LOOKUP(0,
return Qtrue);
4002cv_intern(
VALUE klass,
const char *name)
4004 ID id = rb_intern(name);
4006 rb_name_err_raise(
"wrong class variable name %1$s",
4015 ID id = cv_intern(klass, name);
4022 ID id = cv_intern(klass, name);
4033cv_i(
ID key,
VALUE v, st_data_t a)
4038 st_update(tbl, (st_data_t)key, cv_i_update, 0);
4044mod_cvar_at(
VALUE mod,
void *data)
4048 tbl = st_init_numtable();
4050 mod = original_module(mod);
4057mod_cvar_of(
VALUE mod,
void *data)
4061 if (rb_namespace_p(RCLASS_ATTACHED_OBJECT(mod))) {
4062 data = mod_cvar_at(tmp, data);
4063 tmp = cvar_front_klass(tmp);
4067 data = mod_cvar_at(tmp, data);
4075cv_list_i(st_data_t key, st_data_t value,
VALUE ary)
4078 rb_ary_push(ary,
ID2SYM(sym));
4083cvar_list(
void *data)
4119 bool inherit =
true;
4124 tbl = mod_cvar_of(mod, 0);
4127 tbl = mod_cvar_at(mod, 0);
4129 return cvar_list(tbl);
4154 const ID id = id_for_var_message(mod, name,
class,
"wrong class variable name %1$s");
4161 val = rb_ivar_delete(mod,
id,
Qundef);
4162 if (!UNDEF_P(val)) {
4166 rb_name_err_raise(
"cannot remove %1$s for %2$s", mod,
ID2SYM(
id));
4169 rb_name_err_raise(
"class variable %1$s not defined for %2$s",
4188 ID id = rb_intern(name);
4194class_ivar_set_shape_ivptr(
VALUE obj,
void *_data)
4198 return RCLASS_IVPTR(obj);
4202class_ivar_set_shape_resize_ivptr(
VALUE obj, attr_index_t _old_capa, attr_index_t new_capa,
void *_data)
4210 rb_shape_set_shape(obj, shape);
4214class_ivar_set_transition_too_complex(
VALUE obj,
void *_data)
4216 rb_evict_ivars_to_hash(obj);
4220class_ivar_set_too_complex_table(
VALUE obj,
void *_data)
4224 return RCLASS_IV_HASH(obj);
4231 bool existing =
false;
4236 existing = general_ivar_set(obj,
id, val, NULL,
4237 class_ivar_set_shape_ivptr,
4238 class_ivar_set_shape_resize_ivptr,
4239 class_ivar_set_set_shape,
4240 class_ivar_set_transition_too_complex,
4241 class_ivar_set_too_complex_table).existing;
4249tbl_copy_i(
ID key,
VALUE val, st_data_t dest)
4251 rb_class_ivar_set((
VALUE)dest, key, val);
4269rb_const_lookup(
VALUE klass,
ID id)
4271 struct rb_id_table *tbl = RCLASS_CONST_TBL(klass);
4278 r = rb_id_table_lookup(tbl,
id, &val);
#define RUBY_ASSERT(expr)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define RUBY_EXTERN
Declaration of externally visible global variables.
static VALUE RB_OBJ_FROZEN_RAW(VALUE obj)
This is an implementation detail of RB_OBJ_FROZEN().
static bool RB_FL_ABLE(VALUE obj)
Checks if the object is flaggable.
void rb_obj_freeze_inline(VALUE obj)
Prevents further modifications to the given object.
static void RB_FL_UNSET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_UNSET().
static void RB_OBJ_FREEZE_RAW(VALUE obj)
This is an implementation detail of RB_OBJ_FREEZE().
@ RUBY_FL_SINGLETON
This flag has something to do with an object's class.
void rb_class_modify_check(VALUE klass)
Asserts that klass is not a frozen class.
void rb_freeze_singleton_class(VALUE x)
This is an implementation detail of RB_OBJ_FREEZE().
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.
#define rb_str_new2
Old name of rb_str_new_cstr.
#define FL_SINGLETON
Old name of RUBY_FL_SINGLETON.
#define FL_EXIVAR
Old name of RUBY_FL_EXIVAR.
#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 xfree
Old name of ruby_xfree.
#define Qundef
Old name of RUBY_Qundef.
#define OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
#define rb_str_cat2
Old name of rb_str_cat_cstr.
#define xrealloc
Old name of ruby_xrealloc.
#define ID2SYM
Old name of RB_ID2SYM.
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#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 xmalloc
Old name of ruby_xmalloc.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define ASSUME
Old name of RBIMPL_ASSUME.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define ALLOC_N
Old name of RB_ALLOC_N.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define FL_SET
Old name of RB_FL_SET.
#define rb_ary_new3
Old name of rb_ary_new_from_args.
#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 T_OBJECT
Old name of RUBY_T_OBJECT.
#define NIL_P
Old name of RB_NIL_P.
#define ALLOCV_N
Old name of RB_ALLOCV_N.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define FL_TEST
Old name of RB_FL_TEST.
#define FL_UNSET
Old name of RB_FL_UNSET.
#define rb_ary_new2
Old name of rb_ary_new_capa.
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
#define ALLOCV_END
Old name of RB_ALLOCV_END.
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
void rb_name_error(ID id, const char *fmt,...)
Raises an instance of rb_eNameError.
VALUE rb_eTypeError
TypeError exception.
void rb_name_error_str(VALUE str, const char *fmt,...)
Identical to rb_name_error(), except it takes a VALUE instead of ID.
VALUE rb_eNameError
NameError exception.
VALUE rb_eRuntimeError
RuntimeError exception.
void * rb_check_typeddata(VALUE obj, const rb_data_type_t *data_type)
Identical to rb_typeddata_is_kind_of(), except it raises exceptions instead of returning false.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
void rb_warning(const char *fmt,...)
Issues a warning.
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_cModule
Module class.
VALUE rb_class_real(VALUE klass)
Finds a "real" class.
#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.
ID rb_check_id_cstr(const char *ptr, long len, rb_encoding *enc)
Identical to rb_check_id(), except it takes a pointer to a memory region instead of Ruby's string.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
#define rb_check_frozen
Just another name of rb_check_frozen
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
#define rb_check_frozen_internal(obj)
#define st_foreach_safe
Just another name of rb_st_foreach_safe
int rb_feature_provided(const char *feature, const char **loading)
Identical to rb_provided(), except it additionally returns the "canonical" name of the loaded feature...
VALUE rb_backref_get(void)
Queries the last match, or Regexp.last_match, or the $~.
int rb_is_instance_id(ID id)
Classifies the given ID, then sees if it is an instance variable.
int rb_is_const_id(ID id)
Classifies the given ID, then sees if it is a constant.
int rb_is_class_id(ID id)
Classifies the given ID, then sees if it is a class variable.
VALUE rb_block_proc(void)
Constructs a Proc object from implicitly passed components.
VALUE rb_reg_nth_defined(int n, VALUE md)
Identical to rb_reg_nth_match(), except it just returns Boolean.
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
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.
VALUE rb_mod_remove_cvar(VALUE mod, VALUE name)
Resembles Module#remove_class_variable.
VALUE rb_obj_instance_variables(VALUE obj)
Resembles Object#instance_variables.
VALUE rb_f_untrace_var(int argc, const VALUE *argv)
Deletes the passed tracer from the passed global variable, or if omitted, deletes everything.
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
VALUE rb_const_list(void *)
This is another mysterious API that comes with no documents at all.
VALUE rb_path2class(const char *path)
Resolves a Q::W::E::R-style path string to the actual class it points.
VALUE rb_autoload_p(VALUE space, ID name)
Queries if an autoload is defined at a point.
void rb_set_class_path(VALUE klass, VALUE space, const char *name)
Names a class.
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_mod_remove_const(VALUE space, VALUE name)
Resembles Module#remove_const.
VALUE rb_class_path_cached(VALUE mod)
Just another name of rb_mod_name.
VALUE rb_f_trace_var(int argc, const VALUE *argv)
Traces a global variable.
void rb_cvar_set(VALUE klass, ID name, VALUE val)
Assigns a value to a class variable.
VALUE rb_cvar_get(VALUE klass, ID name)
Obtains a value from a class variable.
VALUE rb_mod_constants(int argc, const VALUE *argv, VALUE recv)
Resembles Module#constants.
VALUE rb_cvar_find(VALUE klass, ID name, VALUE *front)
Identical to rb_cvar_get(), except it takes additional "front" pointer.
VALUE rb_path_to_class(VALUE path)
Identical to rb_path2class(), except it accepts the path as Ruby's string instead of C's.
VALUE rb_ivar_get(VALUE obj, ID name)
Identical to rb_iv_get(), except it accepts the name as an ID instead of a C string.
void rb_const_set(VALUE space, ID name, VALUE val)
Names a constant.
VALUE rb_autoload_load(VALUE space, ID name)
Kicks the autoload procedure as if it was "touched".
VALUE rb_mod_name(VALUE mod)
Queries the name of a module.
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
VALUE rb_const_get_at(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
void rb_set_class_path_string(VALUE klass, VALUE space, VALUE name)
Identical to rb_set_class_path(), except it accepts the name as Ruby's string instead of C's.
void rb_alias_variable(ID dst, ID src)
Aliases a global variable.
void rb_define_class_variable(VALUE, const char *, VALUE)
Just another name of rb_cv_set.
VALUE rb_obj_remove_instance_variable(VALUE obj, VALUE name)
Resembles Object#remove_instance_variable.
void * rb_mod_const_of(VALUE, void *)
This is a variant of rb_mod_const_at().
st_index_t rb_ivar_count(VALUE obj)
Number of instance variables defined on an object.
void * rb_mod_const_at(VALUE, void *)
This API is mysterious.
VALUE rb_const_remove(VALUE space, ID name)
Identical to rb_mod_remove_const(), except it takes the name as ID instead of VALUE.
VALUE rb_const_get_from(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
VALUE rb_ivar_defined(VALUE obj, ID name)
Queries if the instance variable is defined at the object.
VALUE rb_cv_get(VALUE klass, const char *name)
Identical to rb_cvar_get(), except it accepts C's string instead of ID.
int rb_const_defined_at(VALUE space, ID name)
Identical to rb_const_defined(), except it doesn't look for parent classes.
void rb_cv_set(VALUE klass, const char *name, VALUE val)
Identical to rb_cvar_set(), except it accepts C's string instead of ID.
VALUE rb_mod_class_variables(int argc, const VALUE *argv, VALUE recv)
Resembles Module#class_variables.
VALUE rb_f_global_variables(void)
Queries the list of global variables.
VALUE rb_cvar_defined(VALUE klass, ID name)
Queries if the given class has the given class variable.
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
int rb_const_defined_from(VALUE space, ID name)
Identical to rb_const_defined(), except it returns false for private constants.
int rb_const_defined(VALUE space, ID name)
Queries if the constant is defined at the namespace.
void rb_free_generic_ivar(VALUE obj)
Frees the list of instance variables.
const char * rb_sourcefile(void)
Resembles __FILE__.
void rb_clear_constant_cache_for_id(ID id)
Clears the inline constant caches associated with a particular ID.
VALUE rb_eval_cmd_kw(VALUE cmd, VALUE arg, int kw_splat)
This API is practically a variant of rb_proc_call_kw() now.
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
rb_gvar_setter_t rb_gvar_var_setter
rb_gvar_marker_t rb_gvar_var_marker
void rb_define_global_const(const char *name, VALUE val)
Identical to rb_define_const(), except it defines that of "global", i.e.
VALUE rb_gv_get(const char *name)
Obtains a global variable.
void rb_define_variable(const char *name, VALUE *var)
"Shares" a global variable between Ruby and C.
void rb_gvar_marker_t(VALUE *var)
Type that represents a global variable marker function.
void rb_deprecate_constant(VALUE mod, const char *name)
Asserts that the given constant is deprecated.
void rb_gvar_setter_t(VALUE val, ID id, VALUE *data)
Type that represents a global variable setter function.
rb_gvar_setter_t rb_gvar_val_setter
This is the setter function that backs global variables defined from a ruby script.
rb_gvar_marker_t rb_gvar_undef_marker
void rb_define_readonly_variable(const char *name, const VALUE *var)
Identical to rb_define_variable(), except it does not allow Ruby programs to assign values to such gl...
rb_gvar_setter_t rb_gvar_readonly_setter
This function just raises rb_eNameError.
rb_gvar_getter_t rb_gvar_undef_getter
VALUE rb_gv_set(const char *name, VALUE val)
Assigns to a global variable.
rb_gvar_marker_t rb_gvar_val_marker
This is the setter function that backs global variables defined from a ruby script.
void rb_define_const(VALUE klass, const char *name, VALUE val)
Defines a Ruby level constant under a namespace.
VALUE rb_gvar_getter_t(ID id, VALUE *data)
Type that represents a global variable getter function.
VALUE rb_iv_get(VALUE obj, const char *name)
Obtains an instance variable.
rb_gvar_setter_t rb_gvar_undef_setter
rb_gvar_getter_t rb_gvar_val_getter
This is the getter function that backs global variables defined from a ruby script.
VALUE rb_iv_set(VALUE obj, const char *name, VALUE val)
Assigns to an instance variable.
rb_gvar_getter_t rb_gvar_var_getter
int len
Length of the buffer.
static bool rb_ractor_shareable_p(VALUE obj)
Queries if multiple Ractors can share the passed object or not.
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
void rb_define_hooked_variable(const char *q, VALUE *w, type *e, void_type *r)
Define a function-backended global variable.
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_define_virtual_variable(const char *q, type *w, void_type *e)
Define a function-backended global variable.
void rb_ivar_foreach(VALUE q, int_type *w, VALUE e)
Iteration over each instance variable of the object.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
void rb_copy_generic_ivar(VALUE clone, VALUE obj)
Copies the list of instance variables.
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define RBASIC(obj)
Convenient casting macro.
#define RCLASS_SUPER
Just another name of rb_class_get_superclass
#define ROBJECT(obj)
Convenient casting macro.
static VALUE * ROBJECT_IVPTR(VALUE obj)
Queries the instance variables.
#define StringValue(v)
Ensures that the parameter object is a String.
#define RTYPEDDATA_DATA(v)
Convenient getter macro.
#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...
const char * rb_class2name(VALUE klass)
Queries the name of the passed class.
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
#define RB_NO_KEYWORDS
Do not pass keywords.
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.
#define _(args)
This was a transition path from K&R to ANSI.
This is the struct that holds necessary info for a struct.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static enum ruby_value_type rb_type(VALUE obj)
Identical to RB_BUILTIN_TYPE(), except it can also accept special constants.
static enum ruby_value_type RB_BUILTIN_TYPE(VALUE obj)
Queries the type of the object.
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.