Ruby 4.1.0dev (2026-04-14 revision e31f62afe3286054df887677f3f5a5baf47786f1)
variable.c (e31f62afe3286054df887677f3f5a5baf47786f1)
1/**********************************************************************
2
3 variable.c -
4
5 $Author$
6 created at: Tue Apr 19 23:55:15 JST 1994
7
8 Copyright (C) 1993-2007 Yukihiro Matsumoto
9 Copyright (C) 2000 Network Applied Communication Laboratory, Inc.
10 Copyright (C) 2000 Information-technology Promotion Agency, Japan
11
12**********************************************************************/
13
14#include "ruby/internal/config.h"
15#include <stddef.h>
17#include "ccan/list/list.h"
18#include "constant.h"
19#include "debug_counter.h"
20#include "id.h"
21#include "id_table.h"
22#include "internal.h"
23#include "internal/box.h"
24#include "internal/class.h"
25#include "internal/compilers.h"
26#include "internal/error.h"
27#include "internal/eval.h"
28#include "internal/hash.h"
29#include "internal/object.h"
30#include "internal/gc.h"
31#include "internal/re.h"
32#include "internal/struct.h"
33#include "internal/symbol.h"
34#include "internal/thread.h"
35#include "internal/variable.h"
36#include "ruby/encoding.h"
37#include "ruby/st.h"
38#include "ruby/util.h"
39#include "shape.h"
40#include "symbol.h"
41#include "variable.h"
42#include "vm_core.h"
43#include "ractor_core.h"
44#include "vm_sync.h"
45
46RUBY_EXTERN rb_serial_t ruby_vm_global_cvar_state;
47#define GET_GLOBAL_CVAR_STATE() (ruby_vm_global_cvar_state)
48
49typedef void rb_gvar_compact_t(void *var);
50
51static struct rb_id_table *rb_global_tbl;
52static ID autoload;
53
54// This hash table maps file paths to loadable features. We use this to track
55// autoload state until it's no longer needed.
56// feature (file path) => struct autoload_data
57static VALUE autoload_features;
58
59// This mutex is used to protect autoloading state. We use a global mutex which
60// is held until a per-feature mutex can be created. This ensures there are no
61// race conditions relating to autoload state.
62static VALUE autoload_mutex;
63
64static void check_before_mod_set(VALUE, ID, VALUE, const char *);
65static void setup_const_entry(rb_const_entry_t *, VALUE, VALUE, rb_const_flag_t);
66static VALUE rb_const_search(VALUE klass, ID id, int exclude, int recurse, int visibility, VALUE *found_in);
67static st_table *generic_fields_tbl_;
68
69typedef int rb_ivar_foreach_callback_func(ID key, VALUE val, st_data_t arg);
70static void rb_field_foreach(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg, bool ivar_only);
71
72void
73Init_var_tables(void)
74{
75 rb_global_tbl = rb_id_table_create(0);
76 generic_fields_tbl_ = st_init_numtable();
77 autoload = rb_intern_const("__autoload__");
78
79 autoload_mutex = rb_mutex_new();
80 rb_obj_hide(autoload_mutex);
81 rb_vm_register_global_object(autoload_mutex);
82
83 autoload_features = rb_ident_hash_new();
84 rb_obj_hide(autoload_features);
85 rb_vm_register_global_object(autoload_features);
86}
87
88static inline bool
89rb_namespace_p(VALUE obj)
90{
91 if (RB_SPECIAL_CONST_P(obj)) return false;
92 switch (RB_BUILTIN_TYPE(obj)) {
93 case T_MODULE: case T_CLASS: return true;
94 default: break;
95 }
96 return false;
97}
98
109static VALUE
110classname(VALUE klass, bool *permanent)
111{
112 *permanent = false;
113
114 VALUE classpath = RCLASS_CLASSPATH(klass);
115 if (classpath == 0) return Qnil;
116
117 *permanent = RCLASS_PERMANENT_CLASSPATH_P(klass);
118
119 return classpath;
120}
121
122VALUE
123rb_mod_name0(VALUE klass, bool *permanent)
124{
125 return classname(klass, permanent);
126}
127
128/*
129 * call-seq:
130 * mod.name -> string or nil
131 *
132 * Returns the name of the module <i>mod</i>. Returns +nil+ for anonymous modules.
133 */
134
135VALUE
137{
138 // YJIT needs this function to not allocate.
139 bool permanent;
140 return classname(mod, &permanent);
141}
142
143// Similar to logic in rb_mod_const_get().
144static bool
145is_constant_path(VALUE name)
146{
147 const char *path = RSTRING_PTR(name);
148 const char *pend = RSTRING_END(name);
149 rb_encoding *enc = rb_enc_get(name);
150
151 const char *p = path;
152
153 if (p >= pend || !*p) {
154 return false;
155 }
156
157 while (p < pend) {
158 if (p + 2 <= pend && p[0] == ':' && p[1] == ':') {
159 p += 2;
160 }
161
162 const char *pbeg = p;
163 while (p < pend && *p != ':') p++;
164
165 if (pbeg == p) return false;
166
167 if (rb_enc_symname_type(pbeg, p - pbeg, enc, 0) != ID_CONST) {
168 return false;
169 }
170 }
171
172 return true;
173}
174
176 VALUE names;
177 ID last;
178};
179
180static VALUE build_const_path(VALUE head, ID tail);
181static void set_sub_temporary_name_foreach(VALUE mod, struct sub_temporary_name_args *args, VALUE name);
182
183static VALUE
184set_sub_temporary_name_recursive(VALUE mod, VALUE data, int recursive)
185{
186 if (recursive) return Qfalse;
187
188 struct sub_temporary_name_args *args = (void *)data;
189 VALUE name = 0;
190 if (args->names) {
191 name = build_const_path(rb_ary_last(0, 0, args->names), args->last);
192 }
193 set_sub_temporary_name_foreach(mod, args, name);
194 return Qtrue;
195}
196
197static VALUE
198set_sub_temporary_name_topmost(VALUE mod, VALUE data, int recursive)
199{
200 if (recursive) return Qfalse;
201
202 struct sub_temporary_name_args *args = (void *)data;
203 VALUE name = args->names;
204 if (name) {
205 args->names = rb_ary_hidden_new(0);
206 }
207 set_sub_temporary_name_foreach(mod, args, name);
208 return Qtrue;
209}
210
211static enum rb_id_table_iterator_result
212set_sub_temporary_name_i(ID id, VALUE val, void *data)
213{
214 val = ((rb_const_entry_t *)val)->value;
215 if (rb_namespace_p(val) && !RCLASS_PERMANENT_CLASSPATH_P(val)) {
216 VALUE arg = (VALUE)data;
217 struct sub_temporary_name_args *args = data;
218 args->last = id;
219 rb_exec_recursive_paired(set_sub_temporary_name_recursive, val, arg, arg);
220 }
221 return ID_TABLE_CONTINUE;
222}
223
224static void
225set_sub_temporary_name_foreach(VALUE mod, struct sub_temporary_name_args *args, VALUE name)
226{
227 RCLASS_WRITE_CLASSPATH(mod, name, FALSE);
228 struct rb_id_table *tbl = RCLASS_CONST_TBL(mod);
229 if (!tbl) return;
230 if (!name) {
231 rb_id_table_foreach(tbl, set_sub_temporary_name_i, args);
232 }
233 else {
234 long names_len = RARRAY_LEN(args->names); // paranoiac check?
235 rb_ary_push(args->names, name);
236 rb_id_table_foreach(tbl, set_sub_temporary_name_i, args);
237 rb_ary_set_len(args->names, names_len);
238 }
239}
240
241static void
242set_sub_temporary_name(VALUE mod, VALUE name)
243{
244 struct sub_temporary_name_args args = {name};
245 VALUE arg = (VALUE)&args;
246 rb_exec_recursive_paired(set_sub_temporary_name_topmost, mod, arg, arg);
247}
248
249/*
250 * call-seq:
251 * mod.set_temporary_name(string) -> self
252 * mod.set_temporary_name(nil) -> self
253 *
254 * Sets the temporary name of the module. This name is reflected in
255 * introspection of the module and the values that are related to it, such
256 * as instances, constants, and methods.
257 *
258 * The name should be +nil+ or a non-empty string that is not a valid constant
259 * path (to avoid confusing between permanent and temporary names).
260 *
261 * The method can be useful to distinguish dynamically generated classes and
262 * modules without assigning them to constants.
263 *
264 * If the module is given a permanent name by assigning it to a constant,
265 * the temporary name is discarded. A temporary name can't be assigned to
266 * modules that have a permanent name.
267 *
268 * If the given name is +nil+, the module becomes anonymous again.
269 *
270 * Example:
271 *
272 * m = Module.new # => #<Module:0x0000000102c68f38>
273 * m.name #=> nil
274 *
275 * m.set_temporary_name("fake_name") # => fake_name
276 * m.name #=> "fake_name"
277 *
278 * m.set_temporary_name(nil) # => #<Module:0x0000000102c68f38>
279 * m.name #=> nil
280 *
281 * c = Class.new
282 * c.set_temporary_name("MyClass(with description)") # => MyClass(with description)
283 *
284 * c.new # => #<MyClass(with description):0x0....>
285 *
286 * c::M = m
287 * c::M.name #=> "MyClass(with description)::M"
288 *
289 * # Assigning to a constant replaces the name with a permanent one
290 * C = c
291 *
292 * C.name #=> "C"
293 * C::M.name #=> "C::M"
294 * c.new # => #<C:0x0....>
295 */
296
297VALUE
298rb_mod_set_temporary_name(VALUE mod, VALUE name)
299{
300 // We don't allow setting the name if the classpath is already permanent:
301 if (RCLASS_PERMANENT_CLASSPATH_P(mod)) {
302 rb_raise(rb_eRuntimeError, "can't change permanent name");
303 }
304
305 if (NIL_P(name)) {
306 // Set the temporary classpath to NULL (anonymous):
307 RB_VM_LOCKING() {
308 set_sub_temporary_name(mod, 0);
309 }
310 }
311 else {
312 // Ensure the name is a string:
313 StringValue(name);
314
315 if (RSTRING_LEN(name) == 0) {
316 rb_raise(rb_eArgError, "empty class/module name");
317 }
318
319 if (is_constant_path(name)) {
320 rb_raise(rb_eArgError, "the temporary name must not be a constant path to avoid confusion");
321 }
322
323 name = rb_str_new_frozen(name);
324 RB_OBJ_SET_SHAREABLE(name);
325
326 // Set the temporary classpath to the given name:
327 RB_VM_LOCKING() {
328 set_sub_temporary_name(mod, name);
329 }
330 }
331
332 return mod;
333}
334
335static VALUE
336make_temporary_path(VALUE obj, VALUE klass)
337{
338 VALUE path;
339 switch (klass) {
340 case Qnil:
341 path = rb_sprintf("#<Class:%p>", (void*)obj);
342 break;
343 case Qfalse:
344 path = rb_sprintf("#<Module:%p>", (void*)obj);
345 break;
346 default:
347 path = rb_sprintf("#<%"PRIsVALUE":%p>", klass, (void*)obj);
348 break;
349 }
350 OBJ_FREEZE(path);
351 return path;
352}
353
354typedef VALUE (*fallback_func)(VALUE obj, VALUE name);
355
356static VALUE
357rb_tmp_class_path(VALUE klass, bool *permanent, fallback_func fallback)
358{
359 VALUE path = classname(klass, permanent);
360
361 if (!NIL_P(path)) {
362 return path;
363 }
364
365 if (RB_TYPE_P(klass, T_MODULE)) {
366 if (rb_obj_class(klass) == rb_cModule) {
367 path = Qfalse;
368 }
369 else {
370 bool perm;
371 path = rb_tmp_class_path(RBASIC(klass)->klass, &perm, fallback);
372 }
373 }
374
375 *permanent = false;
376 return fallback(klass, path);
377}
378
379VALUE
381{
382 bool permanent;
383 VALUE path = rb_tmp_class_path(klass, &permanent, make_temporary_path);
384 if (!NIL_P(path)) path = rb_str_dup(path);
385 return path;
386}
387
388VALUE
390{
391 return rb_mod_name(klass);
392}
393
394static VALUE
395no_fallback(VALUE obj, VALUE name)
396{
397 return name;
398}
399
400VALUE
401rb_search_class_path(VALUE klass)
402{
403 bool permanent;
404 return rb_tmp_class_path(klass, &permanent, no_fallback);
405}
406
407static VALUE
408build_const_pathname(VALUE head, VALUE tail)
409{
410 VALUE path = rb_str_dup(head);
411 rb_str_cat2(path, "::");
412 rb_str_append(path, tail);
413 return rb_fstring(path);
414}
415
416static VALUE
417build_const_path(VALUE head, ID tail)
418{
419 return build_const_pathname(head, rb_id2str(tail));
420}
421
422void
424{
425 bool permanent = true;
426
427 VALUE str;
428 if (under == rb_cObject) {
429 str = rb_str_new_frozen(name);
430 }
431 else {
432 str = rb_tmp_class_path(under, &permanent, make_temporary_path);
433 str = build_const_pathname(str, name);
434 }
435
436 RB_OBJ_SET_SHAREABLE(str);
437 RCLASS_SET_CLASSPATH(klass, str, permanent);
438}
439
440void
441rb_set_class_path(VALUE klass, VALUE under, const char *name)
442{
443 VALUE str = rb_str_new2(name);
444 OBJ_FREEZE(str);
445 rb_set_class_path_string(klass, under, str);
446}
447
448VALUE
450{
451 rb_encoding *enc = rb_enc_get(pathname);
452 const char *pbeg, *pend, *p, *path = RSTRING_PTR(pathname);
453 ID id;
454 VALUE c = rb_cObject;
455
456 if (!rb_enc_asciicompat(enc)) {
457 rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)");
458 }
459 pbeg = p = path;
460 pend = path + RSTRING_LEN(pathname);
461 if (path == pend || path[0] == '#') {
462 rb_raise(rb_eArgError, "can't retrieve anonymous class %"PRIsVALUE,
463 QUOTE(pathname));
464 }
465 while (p < pend) {
466 while (p < pend && *p != ':') p++;
467 id = rb_check_id_cstr(pbeg, p-pbeg, enc);
468 if (p < pend && p[0] == ':') {
469 if ((size_t)(pend - p) < 2 || p[1] != ':') goto undefined_class;
470 p += 2;
471 pbeg = p;
472 }
473 if (!id) {
474 goto undefined_class;
475 }
476 c = rb_const_search(c, id, TRUE, FALSE, FALSE, NULL);
477 if (UNDEF_P(c)) goto undefined_class;
478 if (!rb_namespace_p(c)) {
479 rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module",
480 pathname);
481 }
482 }
483 RB_GC_GUARD(pathname);
484
485 return c;
486
487 undefined_class:
488 rb_raise(rb_eArgError, "undefined class/module % "PRIsVALUE,
489 rb_str_subseq(pathname, 0, p-path));
491}
492
493VALUE
494rb_path2class(const char *path)
495{
496 return rb_path_to_class(rb_str_new_cstr(path));
497}
498
499VALUE
501{
502 return rb_class_path(rb_class_real(klass));
503}
504
505const char *
507{
508 bool permanent;
509 VALUE path = rb_tmp_class_path(rb_class_real(klass), &permanent, make_temporary_path);
510 if (NIL_P(path)) return NULL;
511 return RSTRING_PTR(path);
512}
513
514const char *
516{
517 return rb_class2name(CLASS_OF(obj));
518}
519
520struct trace_var {
521 int removed;
522 void (*func)(VALUE arg, VALUE val);
523 VALUE data;
524 struct trace_var *next;
525};
526
528 int counter;
529 int block_trace;
530 VALUE *data;
531 rb_gvar_getter_t *getter;
532 rb_gvar_setter_t *setter;
533 rb_gvar_marker_t *marker;
534 rb_gvar_compact_t *compactor;
535 struct trace_var *trace;
536 bool box_ready;
537 bool box_dynamic;
538};
539
541 struct rb_global_variable *var;
542 ID id;
543 bool ractor_local;
544};
545
546static void
547free_global_variable(struct rb_global_variable *var)
548{
549 RUBY_ASSERT(var->counter == 0);
550
551 struct trace_var *trace = var->trace;
552 while (trace) {
553 struct trace_var *next = trace->next;
554 SIZED_FREE(trace);
555 trace = next;
556 }
557 SIZED_FREE(var);
558}
559
560static enum rb_id_table_iterator_result
561free_global_entry_i(VALUE val, void *arg)
562{
563 struct rb_global_entry *entry = (struct rb_global_entry *)val;
564 entry->var->counter--;
565 if (entry->var->counter == 0) {
566 free_global_variable(entry->var);
567 }
568 SIZED_FREE(entry);
569 return ID_TABLE_DELETE;
570}
571
572void
573rb_free_rb_global_tbl(void)
574{
575 rb_id_table_foreach_values(rb_global_tbl, free_global_entry_i, 0);
576 rb_id_table_free(rb_global_tbl);
577}
578
579void
580rb_free_generic_fields_tbl_(void)
581{
582 st_free_table(generic_fields_tbl_);
583}
584
585static struct rb_global_entry*
586rb_find_global_entry(ID id)
587{
588 struct rb_global_entry *entry;
589 VALUE data;
590
591 RB_VM_LOCKING() {
592 if (!rb_id_table_lookup(rb_global_tbl, id, &data)) {
593 entry = NULL;
594 }
595 else {
596 entry = (struct rb_global_entry *)data;
597 RUBY_ASSERT(entry != NULL);
598 }
599 }
600
601 if (UNLIKELY(!rb_ractor_main_p()) && (!entry || !entry->ractor_local)) {
602 rb_raise(rb_eRactorIsolationError, "can not access global variable %s from non-main Ractor", rb_id2name(id));
603 }
604
605 return entry;
606}
607
608void
609rb_gvar_ractor_local(const char *name)
610{
611 struct rb_global_entry *entry = rb_find_global_entry(rb_intern(name));
612 entry->ractor_local = true;
613}
614
615void
616rb_gvar_box_ready(const char *name)
617{
618 struct rb_global_entry *entry = rb_find_global_entry(rb_intern(name));
619 entry->var->box_ready = true;
620}
621
622void
623rb_gvar_box_dynamic(const char *name)
624{
625 struct rb_global_entry *entry = rb_find_global_entry(rb_intern(name));
626 entry->var->box_dynamic = true;
627}
628
629static void
630rb_gvar_undef_compactor(void *var)
631{
632}
633
634static struct rb_global_entry*
636{
637 struct rb_global_entry *entry;
638 RB_VM_LOCKING() {
639 entry = rb_find_global_entry(id);
640 if (!entry) {
641 struct rb_global_variable *var;
642 entry = ALLOC(struct rb_global_entry);
643 var = ALLOC(struct rb_global_variable);
644 entry->id = id;
645 entry->var = var;
646 entry->ractor_local = false;
647 var->counter = 1;
648 var->data = 0;
649 var->getter = rb_gvar_undef_getter;
650 var->setter = rb_gvar_undef_setter;
651 var->marker = rb_gvar_undef_marker;
652 var->compactor = rb_gvar_undef_compactor;
653
654 var->block_trace = 0;
655 var->trace = 0;
656 var->box_ready = false;
657 var->box_dynamic = false;
658 rb_id_table_insert(rb_global_tbl, id, (VALUE)entry);
659 }
660 }
661 return entry;
662}
663
664VALUE
666{
667 rb_warning("global variable '%"PRIsVALUE"' not initialized", QUOTE_ID(id));
668
669 return Qnil;
670}
671
672static void
673rb_gvar_val_compactor(void *_var)
674{
675 struct rb_global_variable *var = (struct rb_global_variable *)_var;
676
677 VALUE obj = (VALUE)var->data;
678
679 if (obj) {
680 VALUE new = rb_gc_location(obj);
681 if (new != obj) {
682 var->data = (void*)new;
683 }
684 }
685}
686
687void
689{
690 struct rb_global_variable *var = rb_global_entry(id)->var;
691 var->getter = rb_gvar_val_getter;
692 var->setter = rb_gvar_val_setter;
693 var->marker = rb_gvar_val_marker;
694 var->compactor = rb_gvar_val_compactor;
695
696 var->data = (void*)val;
697}
698
699void
701{
702}
703
704VALUE
705rb_gvar_val_getter(ID id, VALUE *data)
706{
707 return (VALUE)data;
708}
709
710void
712{
713 struct rb_global_variable *var = rb_global_entry(id)->var;
714 var->data = (void*)val;
715}
716
717void
719{
720 VALUE data = (VALUE)var;
721 if (data) rb_gc_mark_movable(data);
722}
723
724VALUE
726{
727 if (!var) return Qnil;
728 return *var;
729}
730
731void
732rb_gvar_var_setter(VALUE val, ID id, VALUE *data)
733{
734 *data = val;
735}
736
737void
739{
740 if (var) rb_gc_mark_maybe(*var);
741}
742
743void
745{
746 rb_name_error(id, "%"PRIsVALUE" is a read-only variable", QUOTE_ID(id));
747}
748
749static enum rb_id_table_iterator_result
750mark_global_entry(VALUE v, void *ignored)
751{
752 struct rb_global_entry *entry = (struct rb_global_entry *)v;
753 struct trace_var *trace;
754 struct rb_global_variable *var = entry->var;
755
756 (*var->marker)(var->data);
757 trace = var->trace;
758 while (trace) {
759 if (trace->data) rb_gc_mark_maybe(trace->data);
760 trace = trace->next;
761 }
762 return ID_TABLE_CONTINUE;
763}
764
765#define gc_mark_table(task) \
766 if (rb_global_tbl) { rb_id_table_foreach_values(rb_global_tbl, task##_global_entry, 0); }
767
768void
769rb_gc_mark_global_tbl(void)
770{
771 gc_mark_table(mark);
772}
773
774static enum rb_id_table_iterator_result
775update_global_entry(VALUE v, void *ignored)
776{
777 struct rb_global_entry *entry = (struct rb_global_entry *)v;
778 struct rb_global_variable *var = entry->var;
779
780 (*var->compactor)(var);
781 return ID_TABLE_CONTINUE;
782}
783
784void
785rb_gc_update_global_tbl(void)
786{
787 gc_mark_table(update);
788}
789
790static ID
791global_id(const char *name)
792{
793 ID id;
794
795 if (name[0] == '$') id = rb_intern(name);
796 else {
797 size_t len = strlen(name);
798 VALUE vbuf = 0;
799 char *buf = ALLOCV_N(char, vbuf, len+1);
800 buf[0] = '$';
801 memcpy(buf+1, name, len);
802 id = rb_intern2(buf, len+1);
803 ALLOCV_END(vbuf);
804 }
805 return id;
806}
807
808static ID
809find_global_id(const char *name)
810{
811 ID id;
812 size_t len = strlen(name);
813
814 if (name[0] == '$') {
815 id = rb_check_id_cstr(name, len, NULL);
816 }
817 else {
818 VALUE vbuf = 0;
819 char *buf = ALLOCV_N(char, vbuf, len+1);
820 buf[0] = '$';
821 memcpy(buf+1, name, len);
822 id = rb_check_id_cstr(buf, len+1, NULL);
823 ALLOCV_END(vbuf);
824 }
825
826 return id;
827}
828
829void
831 const char *name,
832 VALUE *var,
833 rb_gvar_getter_t *getter,
834 rb_gvar_setter_t *setter)
835{
836 volatile VALUE tmp = var ? *var : Qnil;
837 ID id = global_id(name);
838 struct rb_global_variable *gvar = rb_global_entry(id)->var;
839
840 gvar->data = (void*)var;
841 gvar->getter = getter ? (rb_gvar_getter_t *)getter : rb_gvar_var_getter;
842 gvar->setter = setter ? (rb_gvar_setter_t *)setter : rb_gvar_var_setter;
843 gvar->marker = rb_gvar_var_marker;
844
845 RB_GC_GUARD(tmp);
846}
847
848void
849rb_define_variable(const char *name, VALUE *var)
850{
851 rb_define_hooked_variable(name, var, 0, 0);
852}
853
854void
855rb_define_readonly_variable(const char *name, const VALUE *var)
856{
858}
859
860void
862 const char *name,
863 rb_gvar_getter_t *getter,
864 rb_gvar_setter_t *setter)
865{
866 if (!getter) getter = rb_gvar_val_getter;
867 if (!setter) setter = rb_gvar_readonly_setter;
868 rb_define_hooked_variable(name, 0, getter, setter);
869}
870
871static void
872rb_trace_eval(VALUE cmd, VALUE val)
873{
874 rb_eval_cmd_call_kw(cmd, 1, &val, RB_NO_KEYWORDS);
875}
876
877VALUE
878rb_f_trace_var(int argc, const VALUE *argv)
879{
880 VALUE var, cmd;
881 struct rb_global_entry *entry;
882 struct trace_var *trace;
883
884 if (rb_scan_args(argc, argv, "11", &var, &cmd) == 1) {
885 cmd = rb_block_proc();
886 }
887 if (NIL_P(cmd)) {
888 return rb_f_untrace_var(argc, argv);
889 }
890 entry = rb_global_entry(rb_to_id(var));
891 trace = ALLOC(struct trace_var);
892 trace->next = entry->var->trace;
893 trace->func = rb_trace_eval;
894 trace->data = cmd;
895 trace->removed = 0;
896 entry->var->trace = trace;
897
898 return Qnil;
899}
900
901static void
902remove_trace(struct rb_global_variable *var)
903{
904 struct trace_var *trace = var->trace;
905 struct trace_var t;
906 struct trace_var *next;
907
908 t.next = trace;
909 trace = &t;
910 while (trace->next) {
911 next = trace->next;
912 if (next->removed) {
913 trace->next = next->next;
914 SIZED_FREE(next);
915 }
916 else {
917 trace = next;
918 }
919 }
920 var->trace = t.next;
921}
922
923VALUE
924rb_f_untrace_var(int argc, const VALUE *argv)
925{
926 VALUE var, cmd;
927 ID id;
928 struct rb_global_entry *entry;
929 struct trace_var *trace;
930
931 rb_scan_args(argc, argv, "11", &var, &cmd);
932 id = rb_check_id(&var);
933 if (!id) {
934 rb_name_error_str(var, "undefined global variable %"PRIsVALUE"", QUOTE(var));
935 }
936 if ((entry = rb_find_global_entry(id)) == NULL) {
937 rb_name_error(id, "undefined global variable %"PRIsVALUE"", QUOTE_ID(id));
938 }
939
940 trace = entry->var->trace;
941 if (NIL_P(cmd)) {
942 VALUE ary = rb_ary_new();
943
944 while (trace) {
945 struct trace_var *next = trace->next;
946 rb_ary_push(ary, (VALUE)trace->data);
947 trace->removed = 1;
948 trace = next;
949 }
950
951 if (!entry->var->block_trace) remove_trace(entry->var);
952 return ary;
953 }
954 else {
955 while (trace) {
956 if (trace->data == cmd) {
957 trace->removed = 1;
958 if (!entry->var->block_trace) remove_trace(entry->var);
959 return rb_ary_new3(1, cmd);
960 }
961 trace = trace->next;
962 }
963 }
964 return Qnil;
965}
966
968 struct trace_var *trace;
969 VALUE val;
970};
971
972static VALUE
973trace_ev(VALUE v)
974{
975 struct trace_data *data = (void *)v;
976 struct trace_var *trace = data->trace;
977
978 while (trace) {
979 (*trace->func)(trace->data, data->val);
980 trace = trace->next;
981 }
982
983 return Qnil;
984}
985
986static VALUE
987trace_en(VALUE v)
988{
989 struct rb_global_variable *var = (void *)v;
990 var->block_trace = 0;
991 remove_trace(var);
992 return Qnil; /* not reached */
993}
994
995static VALUE
996rb_gvar_set_entry(struct rb_global_entry *entry, VALUE val)
997{
998 struct trace_data trace;
999 struct rb_global_variable *var = entry->var;
1000
1001 (*var->setter)(val, entry->id, var->data);
1002
1003 if (var->trace && !var->block_trace) {
1004 var->block_trace = 1;
1005 trace.trace = var->trace;
1006 trace.val = val;
1007 rb_ensure(trace_ev, (VALUE)&trace, trace_en, (VALUE)var);
1008 }
1009 return val;
1010}
1011
1012static inline bool
1013gvar_use_box_tbl(const rb_box_t *box, const struct rb_global_entry *entry)
1014{
1015 return BOX_USER_P(box) &&
1016 !entry->var->box_dynamic &&
1017 (!entry->var->box_ready || entry->var->setter != rb_gvar_readonly_setter);
1018}
1019
1020VALUE
1021rb_gvar_set(ID id, VALUE val)
1022{
1023 VALUE retval;
1024 struct rb_global_entry *entry = NULL;
1025 const rb_box_t *box = rb_current_box();
1026 bool use_box_tbl = false;
1027
1028 RB_VM_LOCKING() {
1029 entry = rb_global_entry(id);
1030
1031 if (gvar_use_box_tbl(box, entry)) {
1032 use_box_tbl = true;
1033 rb_hash_aset(box->gvar_tbl, rb_id2sym(entry->id), val);
1034 retval = val;
1035 // TODO: think about trace
1036 }
1037 }
1038
1039 if (!use_box_tbl) {
1040 retval = rb_gvar_set_entry(entry, val);
1041 }
1042 return retval;
1043}
1044
1045VALUE
1046rb_gv_set(const char *name, VALUE val)
1047{
1048 return rb_gvar_set(global_id(name), val);
1049}
1050
1051VALUE
1052rb_gvar_get(ID id)
1053{
1054 VALUE retval, gvars, key;
1055 const rb_box_t *box = rb_current_box();
1056 bool use_box_tbl = false;
1057 struct rb_global_entry *entry = NULL;
1058 struct rb_global_variable *var = NULL;
1059 // TODO: use lock-free rb_id_table when it's available for use (doesn't yet exist)
1060 RB_VM_LOCKING() {
1061 entry = rb_global_entry(id);
1062 var = entry->var;
1063
1064 if (gvar_use_box_tbl(box, entry)) {
1065 use_box_tbl = true;
1066 gvars = box->gvar_tbl;
1067 key = rb_id2sym(entry->id);
1068 if (RTEST(rb_hash_has_key(gvars, key))) { // this gvar is already cached
1069 retval = rb_hash_aref(gvars, key);
1070 }
1071 else {
1072 RB_VM_UNLOCK();
1073 {
1074 retval = (*var->getter)(entry->id, var->data);
1075 if (rb_obj_respond_to(retval, rb_intern("clone"), 1)) {
1076 retval = rb_funcall(retval, rb_intern("clone"), 0);
1077 }
1078 }
1079 RB_VM_LOCK();
1080 rb_hash_aset(gvars, key, retval);
1081 }
1082 }
1083 }
1084 if (!use_box_tbl) {
1085 retval = (*var->getter)(entry->id, var->data);
1086 }
1087 return retval;
1088}
1089
1090VALUE
1091rb_gv_get(const char *name)
1092{
1093 ID id = find_global_id(name);
1094
1095 if (!id) {
1096 rb_warning("global variable '%s' not initialized", name);
1097 return Qnil;
1098 }
1099
1100 return rb_gvar_get(id);
1101}
1102
1103VALUE
1104rb_gvar_defined(ID id)
1105{
1106 struct rb_global_entry *entry = rb_global_entry(id);
1107 return RBOOL(entry->var->getter != rb_gvar_undef_getter);
1108}
1109
1111rb_gvar_getter_function_of(ID id)
1112{
1113 const struct rb_global_entry *entry = rb_global_entry(id);
1114 return entry->var->getter;
1115}
1116
1118rb_gvar_setter_function_of(ID id)
1119{
1120 const struct rb_global_entry *entry = rb_global_entry(id);
1121 return entry->var->setter;
1122}
1123
1124static enum rb_id_table_iterator_result
1125gvar_i(ID key, VALUE val, void *a)
1126{
1127 VALUE ary = (VALUE)a;
1128 rb_ary_push(ary, ID2SYM(key));
1129 return ID_TABLE_CONTINUE;
1130}
1131
1132VALUE
1134{
1135 VALUE ary = rb_ary_new();
1136 VALUE sym, backref = rb_backref_get();
1137
1138 if (!rb_ractor_main_p()) {
1139 rb_raise(rb_eRactorIsolationError, "can not access global variables from non-main Ractors");
1140 }
1141 /* gvar access (get/set) in boxes creates gvar entries globally */
1142
1143 rb_id_table_foreach(rb_global_tbl, gvar_i, (void *)ary);
1144 if (!NIL_P(backref)) {
1145 char buf[2];
1146 int i, nmatch = rb_match_count(backref);
1147 buf[0] = '$';
1148 for (i = 1; i <= nmatch; ++i) {
1149 if (!RTEST(rb_reg_nth_defined(i, backref))) continue;
1150 if (i < 10) {
1151 /* probably reused, make static ID */
1152 buf[1] = (char)(i + '0');
1153 sym = ID2SYM(rb_intern2(buf, 2));
1154 }
1155 else {
1156 /* dynamic symbol */
1157 sym = rb_str_intern(rb_sprintf("$%d", i));
1158 }
1159 rb_ary_push(ary, sym);
1160 }
1161 }
1162 return ary;
1163}
1164
1165void
1167{
1168 struct rb_global_entry *entry1 = NULL, *entry2;
1169 VALUE data1;
1170 struct rb_id_table *gtbl = rb_global_tbl;
1171
1172 if (!rb_ractor_main_p()) {
1173 rb_raise(rb_eRactorIsolationError, "can not access global variables from non-main Ractors");
1174 }
1175
1176 RB_VM_LOCKING() {
1177 entry2 = rb_global_entry(name2);
1178 if (!rb_id_table_lookup(gtbl, name1, &data1)) {
1179 entry1 = ZALLOC(struct rb_global_entry);
1180 entry1->id = name1;
1181 rb_id_table_insert(gtbl, name1, (VALUE)entry1);
1182 }
1183 else if ((entry1 = (struct rb_global_entry *)data1)->var != entry2->var) {
1184 struct rb_global_variable *var = entry1->var;
1185 if (var->block_trace) {
1186 RB_VM_UNLOCK();
1187 rb_raise(rb_eRuntimeError, "can't alias in tracer");
1188 }
1189 var->counter--;
1190 if (var->counter == 0) {
1191 free_global_variable(var);
1192 }
1193 }
1194 if (entry1->var != entry2->var) {
1195 entry2->var->counter++;
1196 entry1->var = entry2->var;
1197 }
1198 }
1199}
1200
1201static void
1202IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(ID id)
1203{
1204 if (UNLIKELY(!rb_ractor_main_p())) {
1205 if (rb_is_instance_id(id)) { // check only normal ivars
1206 rb_raise(rb_eRactorIsolationError, "can not set instance variables of classes/modules by non-main Ractors");
1207 }
1208 }
1209}
1210
1211static void
1212CVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(VALUE klass, ID id)
1213{
1214 if (UNLIKELY(!rb_ractor_main_p())) {
1215 rb_raise(rb_eRactorIsolationError, "can not set class variables from non-main Ractors (%"PRIsVALUE" from %"PRIsVALUE")", rb_id2str(id), klass);
1216 }
1217}
1218
1219static void
1220cvar_read_ractor_check(VALUE klass, ID id, VALUE val)
1221{
1222 if (UNLIKELY(!rb_ractor_main_p()) && !rb_ractor_shareable_p(val)) {
1223 rb_raise(rb_eRactorIsolationError,
1224 "can not read non-shareable class variable %"PRIsVALUE" from non-main Ractors (%"PRIsVALUE")",
1225 rb_id2str(id), klass);
1226 }
1227}
1228
1229static inline void
1230ivar_ractor_check(VALUE obj, ID id)
1231{
1232 if (LIKELY(rb_is_instance_id(id)) /* not internal ID */ &&
1233 !RB_OBJ_FROZEN_RAW(obj) &&
1234 UNLIKELY(!rb_ractor_main_p()) &&
1235 UNLIKELY(rb_ractor_shareable_p(obj))) {
1236
1237 rb_raise(rb_eRactorIsolationError, "can not access instance variables of shareable objects from non-main Ractors");
1238 }
1239}
1240
1241static inline struct st_table *
1242generic_fields_tbl_no_ractor_check(void)
1243{
1244 ASSERT_vm_locking();
1245
1246 return generic_fields_tbl_;
1247}
1248
1249struct st_table *
1250rb_generic_fields_tbl_get(void)
1251{
1252 return generic_fields_tbl_;
1253}
1254
1255void
1256rb_mark_generic_ivar(VALUE obj)
1257{
1258 VALUE data;
1259 // Bypass ASSERT_vm_locking() check because marking may happen concurrently with mmtk
1260 if (st_lookup(generic_fields_tbl_, (st_data_t)obj, (st_data_t *)&data)) {
1261 rb_gc_mark_movable(data);
1262 }
1263}
1264
1265VALUE
1266rb_obj_fields_generic_uncached(VALUE obj)
1267{
1268 VALUE fields_obj = 0;
1269 RB_VM_LOCKING() {
1270 if (!st_lookup(generic_fields_tbl_, (st_data_t)obj, (st_data_t *)&fields_obj)) {
1271 rb_bug("Object is missing entry in generic_fields_tbl");
1272 }
1273 }
1274 return fields_obj;
1275}
1276
1277VALUE
1278rb_obj_fields(VALUE obj, ID field_name)
1279{
1281 ivar_ractor_check(obj, field_name);
1282
1283 VALUE fields_obj = 0;
1284 if (rb_shape_obj_has_fields(obj)) {
1285 switch (BUILTIN_TYPE(obj)) {
1286 case T_DATA:
1287 if (LIKELY(RTYPEDDATA_P(obj))) {
1288 fields_obj = RTYPEDDATA(obj)->fields_obj;
1289 break;
1290 }
1291 goto generic_fields;
1292 case T_STRUCT:
1293 if (LIKELY(!FL_TEST_RAW(obj, RSTRUCT_GEN_FIELDS))) {
1294 fields_obj = RSTRUCT_FIELDS_OBJ(obj);
1295 break;
1296 }
1297 goto generic_fields;
1298 default:
1299 generic_fields:
1300 {
1301 rb_execution_context_t *ec = GET_EC();
1302 if (ec->gen_fields_cache.obj == obj && !UNDEF_P(ec->gen_fields_cache.fields_obj) && rb_imemo_fields_owner(ec->gen_fields_cache.fields_obj) == obj) {
1303 fields_obj = ec->gen_fields_cache.fields_obj;
1304 RUBY_ASSERT(fields_obj == rb_obj_fields_generic_uncached(obj));
1305 }
1306 else {
1307 fields_obj = rb_obj_fields_generic_uncached(obj);
1308 ec->gen_fields_cache.fields_obj = fields_obj;
1309 ec->gen_fields_cache.obj = obj;
1310 }
1311 }
1312 }
1313 }
1314 return fields_obj;
1315}
1316
1317void
1319{
1320 if (rb_obj_gen_fields_p(obj)) {
1321 st_data_t key = (st_data_t)obj, value;
1322 switch (BUILTIN_TYPE(obj)) {
1323 case T_DATA:
1324 if (LIKELY(RTYPEDDATA_P(obj))) {
1325 RB_OBJ_WRITE(obj, &RTYPEDDATA(obj)->fields_obj, 0);
1326 break;
1327 }
1328 goto generic_fields;
1329 case T_STRUCT:
1330 if (LIKELY(!FL_TEST_RAW(obj, RSTRUCT_GEN_FIELDS))) {
1331 RSTRUCT_SET_FIELDS_OBJ(obj, 0);
1332 break;
1333 }
1334 goto generic_fields;
1335 default:
1336 generic_fields:
1337 {
1338 // Other EC may have stale caches, so fields_obj should be
1339 // invalidated and the GC will replace with Qundef
1340 rb_execution_context_t *ec = GET_EC();
1341 if (ec->gen_fields_cache.obj == obj) {
1342 ec->gen_fields_cache.obj = Qundef;
1343 ec->gen_fields_cache.fields_obj = Qundef;
1344 }
1345 RB_VM_LOCKING() {
1346 if (!st_delete(generic_fields_tbl_no_ractor_check(), &key, &value)) {
1347 rb_bug("Object is missing entry in generic_fields_tbl");
1348 }
1349 }
1350 }
1351 }
1352 RBASIC_SET_SHAPE_ID(obj, ROOT_SHAPE_ID);
1353 }
1354}
1355
1356static void
1357rb_obj_set_fields(VALUE obj, VALUE fields_obj, ID field_name, VALUE original_fields_obj)
1358{
1359 ivar_ractor_check(obj, field_name);
1360
1361 if (!fields_obj) {
1362 RUBY_ASSERT(original_fields_obj);
1364 rb_imemo_fields_clear(original_fields_obj);
1365 return;
1366 }
1367
1368 RUBY_ASSERT(IMEMO_TYPE_P(fields_obj, imemo_fields));
1369 RUBY_ASSERT(!original_fields_obj || IMEMO_TYPE_P(original_fields_obj, imemo_fields));
1370
1371 if (fields_obj != original_fields_obj) {
1372 switch (BUILTIN_TYPE(obj)) {
1373 case T_DATA:
1374 if (LIKELY(RTYPEDDATA_P(obj))) {
1375 RB_OBJ_WRITE(obj, &RTYPEDDATA(obj)->fields_obj, fields_obj);
1376 break;
1377 }
1378 goto generic_fields;
1379 case T_STRUCT:
1380 if (LIKELY(!FL_TEST_RAW(obj, RSTRUCT_GEN_FIELDS))) {
1381 RSTRUCT_SET_FIELDS_OBJ(obj, fields_obj);
1382 break;
1383 }
1384 goto generic_fields;
1385 default:
1386 generic_fields:
1387 {
1388 RB_VM_LOCKING() {
1389 st_insert(generic_fields_tbl_, (st_data_t)obj, (st_data_t)fields_obj);
1390 }
1391 RB_OBJ_WRITTEN(obj, original_fields_obj, fields_obj);
1392
1393 rb_execution_context_t *ec = GET_EC();
1394 if (ec->gen_fields_cache.fields_obj != fields_obj) {
1395 ec->gen_fields_cache.obj = obj;
1396 ec->gen_fields_cache.fields_obj = fields_obj;
1397 }
1398 }
1399 }
1400
1401 if (original_fields_obj) {
1402 // Clear root shape to avoid triggering cleanup such as free_object_id.
1403 rb_imemo_fields_clear(original_fields_obj);
1404 }
1405 }
1406
1407 RBASIC_SET_SHAPE_ID(obj, RBASIC_SHAPE_ID(fields_obj));
1408}
1409
1410void
1411rb_obj_replace_fields(VALUE obj, VALUE fields_obj)
1412{
1413 RB_VM_LOCKING() {
1414 VALUE original_fields_obj = rb_obj_fields_no_ractor_check(obj);
1415 rb_obj_set_fields(obj, fields_obj, 0, original_fields_obj);
1416 }
1417}
1418
1419VALUE
1420rb_obj_field_get(VALUE obj, shape_id_t target_shape_id)
1421{
1423 RUBY_ASSERT(RSHAPE_TYPE_P(target_shape_id, SHAPE_IVAR) || RSHAPE_TYPE_P(target_shape_id, SHAPE_OBJ_ID));
1424
1425 VALUE fields_obj;
1426
1427 switch (BUILTIN_TYPE(obj)) {
1428 case T_CLASS:
1429 case T_MODULE:
1430 fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
1431 break;
1432 case T_OBJECT:
1433 fields_obj = obj;
1434 break;
1435 case T_IMEMO:
1436 RUBY_ASSERT(IMEMO_TYPE_P(obj, imemo_fields));
1437 fields_obj = obj;
1438 break;
1439 default:
1440 fields_obj = rb_obj_fields(obj, RSHAPE_EDGE_NAME(target_shape_id));
1441 break;
1442 }
1443
1444 if (UNLIKELY(rb_shape_too_complex_p(target_shape_id))) {
1445 st_table *fields_hash = rb_imemo_fields_complex_tbl(fields_obj);
1446 VALUE value = Qundef;
1447 st_lookup(fields_hash, RSHAPE_EDGE_NAME(target_shape_id), &value);
1448 RUBY_ASSERT(!UNDEF_P(value));
1449 return value;
1450 }
1451
1452 attr_index_t index = RSHAPE_INDEX(target_shape_id);
1453 return rb_imemo_fields_ptr(fields_obj)[index];
1454}
1455
1456VALUE
1457rb_ivar_lookup(VALUE obj, ID id, VALUE undef)
1458{
1459 if (SPECIAL_CONST_P(obj)) return undef;
1460
1461 VALUE fields_obj;
1462
1463 switch (BUILTIN_TYPE(obj)) {
1464 case T_CLASS:
1465 case T_MODULE:
1466 {
1467 VALUE val = rb_ivar_lookup(RCLASS_WRITABLE_FIELDS_OBJ(obj), id, undef);
1468 if (val != undef &&
1469 rb_is_instance_id(id) &&
1470 UNLIKELY(!rb_ractor_main_p()) &&
1471 !rb_ractor_shareable_p(val)) {
1472 rb_raise(rb_eRactorIsolationError,
1473 "can not get unshareable values from instance variables of classes/modules from non-main Ractors (%"PRIsVALUE" from %"PRIsVALUE")",
1474 rb_id2str(id), obj);
1475 }
1476 return val;
1477 }
1478 case T_IMEMO:
1479 // Handled like T_OBJECT
1480 RUBY_ASSERT(IMEMO_TYPE_P(obj, imemo_fields));
1481 fields_obj = obj;
1482 break;
1483 case T_OBJECT:
1484 fields_obj = obj;
1485 break;
1486 default:
1487 fields_obj = rb_obj_fields(obj, id);
1488 break;
1489 }
1490
1491 if (!fields_obj) {
1492 return undef;
1493 }
1494
1495 shape_id_t shape_id = RBASIC_SHAPE_ID(fields_obj);
1496
1497 if (UNLIKELY(rb_shape_too_complex_p(shape_id))) {
1498 st_table *iv_table = rb_imemo_fields_complex_tbl(fields_obj);
1499 VALUE val;
1500 if (rb_st_lookup(iv_table, (st_data_t)id, (st_data_t *)&val)) {
1501 return val;
1502 }
1503 return undef;
1504 }
1505
1506 attr_index_t index = 0;
1507 if (rb_shape_get_iv_index(shape_id, id, &index)) {
1508 return rb_imemo_fields_ptr(fields_obj)[index];
1509 }
1510
1511 return undef;
1512}
1513
1514VALUE
1516{
1517 VALUE iv = rb_ivar_lookup(obj, id, Qnil);
1518 RB_DEBUG_COUNTER_INC(ivar_get_base);
1519 return iv;
1520}
1521
1522VALUE
1523rb_ivar_get_at(VALUE obj, attr_index_t index, ID id)
1524{
1526 // Used by JITs, but never for T_OBJECT.
1527
1528 switch (BUILTIN_TYPE(obj)) {
1529 case T_OBJECT:
1531 case T_CLASS:
1532 case T_MODULE:
1533 {
1534 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
1535 VALUE val = rb_imemo_fields_ptr(fields_obj)[index];
1536
1537 if (UNLIKELY(!rb_ractor_main_p()) && !rb_ractor_shareable_p(val)) {
1538 rb_raise(rb_eRactorIsolationError,
1539 "can not get unshareable values from instance variables of classes/modules from non-main Ractors");
1540 }
1541
1542 return val;
1543 }
1544 default:
1545 {
1546 VALUE fields_obj = rb_obj_fields(obj, id);
1547 return rb_imemo_fields_ptr(fields_obj)[index];
1548 }
1549 }
1550}
1551
1552VALUE
1553rb_ivar_get_at_no_ractor_check(VALUE obj, attr_index_t index)
1554{
1555 // Used by JITs, but never for T_OBJECT.
1556
1557 VALUE fields_obj;
1558 switch (BUILTIN_TYPE(obj)) {
1559 case T_OBJECT:
1561 case T_CLASS:
1562 case T_MODULE:
1563 fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
1564 break;
1565 default:
1566 fields_obj = rb_obj_fields_no_ractor_check(obj);
1567 break;
1568 }
1569 return rb_imemo_fields_ptr(fields_obj)[index];
1570}
1571
1572VALUE
1573rb_attr_get(VALUE obj, ID id)
1574{
1575 return rb_ivar_lookup(obj, id, Qnil);
1576}
1577
1578void rb_obj_copy_fields_to_hash_table(VALUE obj, st_table *table);
1579static VALUE imemo_fields_complex_from_obj(VALUE owner, VALUE source_fields_obj, shape_id_t shape_id);
1580
1581static shape_id_t
1582obj_transition_too_complex(VALUE obj, st_table *table)
1583{
1584 RUBY_ASSERT(!rb_shape_obj_too_complex_p(obj));
1585 shape_id_t shape_id = rb_shape_transition_complex(obj);
1586
1587 switch (BUILTIN_TYPE(obj)) {
1588 case T_OBJECT:
1589 {
1590 VALUE *old_fields = NULL;
1591 uint32_t old_fields_len = 0;
1592 if (FL_TEST_RAW(obj, ROBJECT_HEAP)) {
1593 old_fields = ROBJECT_FIELDS(obj);
1594 old_fields_len = ROBJECT_FIELDS_CAPACITY(obj);
1595 }
1596 else {
1597 FL_SET_RAW(obj, ROBJECT_HEAP);
1598 }
1599 RBASIC_SET_SHAPE_ID(obj, shape_id);
1600 ROBJECT_SET_FIELDS_HASH(obj, table);
1601 if (old_fields) {
1602 SIZED_FREE_N(old_fields, old_fields_len);
1603 }
1604 }
1605 break;
1606 case T_CLASS:
1607 case T_MODULE:
1608 case T_IMEMO:
1610 break;
1611 default:
1612 {
1613 VALUE fields_obj = rb_imemo_fields_new_complex_tbl(obj, table, RB_OBJ_SHAREABLE_P(obj));
1614 RBASIC_SET_SHAPE_ID(fields_obj, shape_id);
1615 rb_obj_replace_fields(obj, fields_obj);
1616 }
1617 }
1618
1619 return shape_id;
1620}
1621
1622// Copy all object fields, including ivars and internal object_id, etc
1623static shape_id_t
1624rb_evict_fields_to_hash(VALUE obj)
1625{
1626 RUBY_ASSERT(!rb_shape_obj_too_complex_p(obj));
1627
1628 st_table *table = st_init_numtable_with_size(RSHAPE_LEN(RBASIC_SHAPE_ID(obj)));
1629 rb_obj_copy_fields_to_hash_table(obj, table);
1630 shape_id_t new_shape_id = obj_transition_too_complex(obj, table);
1631
1632 RUBY_ASSERT(rb_shape_obj_too_complex_p(obj));
1633 return new_shape_id;
1634}
1635
1636void
1637rb_evict_ivars_to_hash(VALUE obj)
1638{
1639 RUBY_ASSERT(!rb_shape_obj_too_complex_p(obj));
1640
1641 st_table *table = st_init_numtable_with_size(rb_ivar_count(obj));
1642
1643 // Evacuate all previous values from shape into id_table
1644 rb_obj_copy_ivs_to_hash_table(obj, table);
1645 obj_transition_too_complex(obj, table);
1646
1647 RUBY_ASSERT(rb_shape_obj_too_complex_p(obj));
1648}
1649
1650static VALUE
1651rb_ivar_delete(VALUE obj, ID id, VALUE undef)
1652{
1653 rb_check_frozen(obj);
1654
1655 VALUE val = undef;
1656 VALUE fields_obj;
1657 bool concurrent = false;
1658 int type = BUILTIN_TYPE(obj);
1659
1660 switch(type) {
1661 case T_CLASS:
1662 case T_MODULE:
1663 IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(id);
1664
1665 fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
1666 if (rb_multi_ractor_p()) {
1667 concurrent = true;
1668 }
1669 break;
1670 case T_OBJECT:
1671 fields_obj = obj;
1672 break;
1673 default: {
1674 fields_obj = rb_obj_fields(obj, id);
1675 break;
1676 }
1677 }
1678
1679 if (!fields_obj) {
1680 return undef;
1681 }
1682
1683 const VALUE original_fields_obj = fields_obj;
1684 if (concurrent) {
1685 fields_obj = rb_imemo_fields_clone(fields_obj);
1686 }
1687
1688 shape_id_t old_shape_id = RBASIC_SHAPE_ID(fields_obj);
1689 shape_id_t removed_shape_id;
1690 shape_id_t next_shape_id = rb_shape_transition_remove_ivar(fields_obj, id, &removed_shape_id);
1691
1692 if (UNLIKELY(rb_shape_too_complex_p(next_shape_id))) {
1693 if (UNLIKELY(!rb_shape_too_complex_p(old_shape_id))) {
1694 if (type == T_OBJECT) {
1695 rb_evict_fields_to_hash(obj);
1696 }
1697 else {
1698 fields_obj = imemo_fields_complex_from_obj(obj, fields_obj, next_shape_id);
1699 }
1700 }
1701 st_data_t key = id;
1702 if (!st_delete(rb_imemo_fields_complex_tbl(fields_obj), &key, (st_data_t *)&val)) {
1703 val = undef;
1704 }
1705 }
1706 else {
1707 if (next_shape_id == old_shape_id) {
1708 return undef;
1709 }
1710
1711 RUBY_ASSERT(removed_shape_id != INVALID_SHAPE_ID);
1712 RUBY_ASSERT(RSHAPE_LEN(next_shape_id) == RSHAPE_LEN(old_shape_id) - 1);
1713
1714 VALUE *fields = rb_imemo_fields_ptr(fields_obj);
1715 attr_index_t removed_index = RSHAPE_INDEX(removed_shape_id);
1716 val = fields[removed_index];
1717
1718 attr_index_t new_fields_count = RSHAPE_LEN(next_shape_id);
1719 if (new_fields_count) {
1720 size_t trailing_fields = new_fields_count - removed_index;
1721
1722 MEMMOVE(&fields[removed_index], &fields[removed_index + 1], VALUE, trailing_fields);
1723 RBASIC_SET_SHAPE_ID(fields_obj, next_shape_id);
1724
1725 if (FL_TEST_RAW(fields_obj, OBJ_FIELD_HEAP)) {
1726 if (rb_obj_embedded_size(new_fields_count) <= rb_gc_obj_slot_size(fields_obj)) {
1727 // Re-embed objects when instances become small enough
1728 // This is necessary because YJIT assumes that objects with the same shape
1729 // have the same embeddedness for efficiency (avoid extra checks)
1730 FL_UNSET_RAW(fields_obj, ROBJECT_HEAP);
1731 MEMCPY(rb_imemo_fields_ptr(fields_obj), fields, VALUE, new_fields_count);
1732 SIZED_FREE_N(fields, RSHAPE_CAPACITY(old_shape_id));
1733 }
1734 else if (RSHAPE_CAPACITY(old_shape_id) != RSHAPE_CAPACITY(next_shape_id)) {
1735 IMEMO_OBJ_FIELDS(fields_obj)->as.external.ptr = ruby_xrealloc_sized(fields, RSHAPE_CAPACITY(next_shape_id) * sizeof(VALUE), RSHAPE_CAPACITY(old_shape_id) * sizeof(VALUE));
1736 }
1737 }
1738 }
1739 else {
1740 fields_obj = 0;
1742 }
1743 }
1744
1745 RBASIC_SET_SHAPE_ID(obj, next_shape_id);
1746 if (fields_obj != original_fields_obj) {
1747 switch (type) {
1748 case T_OBJECT:
1749 break;
1750 case T_CLASS:
1751 case T_MODULE:
1752 RCLASS_WRITABLE_SET_FIELDS_OBJ(obj, fields_obj);
1753 break;
1754 default:
1755 rb_obj_set_fields(obj, fields_obj, id, original_fields_obj);
1756 break;
1757 }
1758 }
1759
1760 return val;
1761}
1762
1763VALUE
1764rb_attr_delete(VALUE obj, ID id)
1765{
1766 return rb_ivar_delete(obj, id, Qnil);
1767}
1768
1769void
1770rb_obj_init_too_complex(VALUE obj, st_table *table)
1771{
1772 // This method is meant to be called on newly allocated object.
1773 RUBY_ASSERT(!rb_shape_obj_too_complex_p(obj));
1774 RUBY_ASSERT(rb_shape_canonical_p(RBASIC_SHAPE_ID(obj)));
1775 RUBY_ASSERT(RSHAPE_LEN(RBASIC_SHAPE_ID(obj)) == 0);
1776
1777 obj_transition_too_complex(obj, table);
1778}
1779
1780static int
1781imemo_fields_complex_from_obj_i(ID key, VALUE val, st_data_t arg)
1782{
1783 VALUE fields = (VALUE)arg;
1784 st_table *table = rb_imemo_fields_complex_tbl(fields);
1785
1786 RUBY_ASSERT(!st_lookup(table, (st_data_t)key, NULL));
1787 st_add_direct(table, (st_data_t)key, (st_data_t)val);
1788 RB_OBJ_WRITTEN(fields, Qundef, val);
1789
1790 return ST_CONTINUE;
1791}
1792
1793static VALUE
1794imemo_fields_complex_from_obj(VALUE owner, VALUE source_fields_obj, shape_id_t shape_id)
1795{
1796 attr_index_t len = source_fields_obj ? RSHAPE_LEN(RBASIC_SHAPE_ID(source_fields_obj)) : 0;
1797 VALUE fields_obj = rb_imemo_fields_new_complex(owner, len + 1, RB_OBJ_SHAREABLE_P(owner));
1798
1799 rb_field_foreach(source_fields_obj, imemo_fields_complex_from_obj_i, (st_data_t)fields_obj, false);
1800 RBASIC_SET_SHAPE_ID(fields_obj, shape_id);
1801
1802 return fields_obj;
1803}
1804
1805static VALUE
1806imemo_fields_copy_capa(VALUE owner, VALUE source_fields_obj, attr_index_t new_size)
1807{
1808 VALUE fields_obj = rb_imemo_fields_new(owner, new_size, RB_OBJ_SHAREABLE_P(owner));
1809 if (source_fields_obj) {
1810 attr_index_t fields_count = RSHAPE_LEN(RBASIC_SHAPE_ID(source_fields_obj));
1811 VALUE *fields = rb_imemo_fields_ptr(fields_obj);
1812 MEMCPY(fields, rb_imemo_fields_ptr(source_fields_obj), VALUE, fields_count);
1813 RBASIC_SET_SHAPE_ID(fields_obj, RBASIC_SHAPE_ID(source_fields_obj));
1814 for (attr_index_t i = 0; i < fields_count; i++) {
1815 RB_OBJ_WRITTEN(fields_obj, Qundef, fields[i]);
1816 }
1817 }
1818 return fields_obj;
1819}
1820
1821static VALUE
1822imemo_fields_set(VALUE owner, VALUE fields_obj, shape_id_t target_shape_id, ID field_name, VALUE val, bool concurrent)
1823{
1824 const VALUE original_fields_obj = fields_obj;
1825 shape_id_t current_shape_id = fields_obj ? RBASIC_SHAPE_ID(fields_obj) : ROOT_SHAPE_ID;
1826
1827 if (UNLIKELY(rb_shape_too_complex_p(target_shape_id))) {
1828 if (rb_shape_too_complex_p(current_shape_id)) {
1829 if (concurrent) {
1830 // In multi-ractor case, we must always work on a copy because
1831 // even if the field already exist, inserting in a st_table may
1832 // cause a rebuild.
1833 fields_obj = rb_imemo_fields_clone(fields_obj);
1834 }
1835 }
1836 else {
1837 fields_obj = imemo_fields_complex_from_obj(owner, original_fields_obj, target_shape_id);
1838 current_shape_id = target_shape_id;
1839 }
1840
1841 st_table *table = rb_imemo_fields_complex_tbl(fields_obj);
1842
1843 RUBY_ASSERT(field_name);
1844 st_insert(table, (st_data_t)field_name, (st_data_t)val);
1845 RB_OBJ_WRITTEN(fields_obj, Qundef, val);
1846 RBASIC_SET_SHAPE_ID(fields_obj, target_shape_id);
1847 }
1848 else {
1849 attr_index_t index = RSHAPE_INDEX(target_shape_id);
1850 if (concurrent || index >= RSHAPE_CAPACITY(current_shape_id)) {
1851 fields_obj = imemo_fields_copy_capa(owner, original_fields_obj, RSHAPE_CAPACITY(target_shape_id));
1852 }
1853
1854 VALUE *table = rb_imemo_fields_ptr(fields_obj);
1855 RB_OBJ_WRITE(fields_obj, &table[index], val);
1856
1857 if (RSHAPE_LEN(target_shape_id) > RSHAPE_LEN(current_shape_id)) {
1858 RBASIC_SET_SHAPE_ID(fields_obj, target_shape_id);
1859 }
1860 }
1861
1862 return fields_obj;
1863}
1864
1865static attr_index_t
1866generic_field_set(VALUE obj, shape_id_t target_shape_id, ID field_name, VALUE val)
1867{
1868 if (!field_name) {
1869 field_name = RSHAPE_EDGE_NAME(target_shape_id);
1870 RUBY_ASSERT(field_name);
1871 }
1872
1873 const VALUE original_fields_obj = rb_obj_fields(obj, field_name);
1874 VALUE fields_obj = imemo_fields_set(obj, original_fields_obj, target_shape_id, field_name, val, false);
1875
1876 rb_obj_set_fields(obj, fields_obj, field_name, original_fields_obj);
1877 return rb_shape_too_complex_p(target_shape_id) ? ATTR_INDEX_NOT_SET : RSHAPE_INDEX(target_shape_id);
1878}
1879
1880static shape_id_t
1881generic_shape_ivar(VALUE obj, ID id, bool *new_ivar_out)
1882{
1883 bool new_ivar = false;
1884 shape_id_t current_shape_id = RBASIC_SHAPE_ID(obj);
1885 shape_id_t target_shape_id = current_shape_id;
1886
1887 if (!rb_shape_too_complex_p(current_shape_id)) {
1888 if (!rb_shape_find_ivar(current_shape_id, id, &target_shape_id)) {
1889 if (RSHAPE_LEN(current_shape_id) >= SHAPE_MAX_FIELDS) {
1890 rb_raise(rb_eArgError, "too many instance variables");
1891 }
1892
1893 new_ivar = true;
1894 target_shape_id = rb_shape_transition_add_ivar(obj, id);
1895 }
1896 }
1897
1898 *new_ivar_out = new_ivar;
1899 return target_shape_id;
1900}
1901
1902static attr_index_t
1903generic_ivar_set(VALUE obj, ID id, VALUE val)
1904{
1905 bool dontcare;
1906 shape_id_t target_shape_id = generic_shape_ivar(obj, id, &dontcare);
1907 return generic_field_set(obj, target_shape_id, id, val);
1908}
1909
1910void
1911rb_ensure_iv_list_size(VALUE obj, uint32_t current_len, uint32_t new_capacity)
1912{
1913 RUBY_ASSERT(!rb_shape_obj_too_complex_p(obj));
1914
1915 if (FL_TEST_RAW(obj, ROBJECT_HEAP)) {
1916 SIZED_REALLOC_N(ROBJECT(obj)->as.heap.fields, VALUE, new_capacity, current_len);
1917 }
1918 else {
1919 VALUE *ptr = ROBJECT_FIELDS(obj);
1920 VALUE *newptr = ALLOC_N(VALUE, new_capacity);
1921 MEMCPY(newptr, ptr, VALUE, current_len);
1922 FL_SET_RAW(obj, ROBJECT_HEAP);
1923 ROBJECT(obj)->as.heap.fields = newptr;
1924 }
1925}
1926
1927static int
1928rb_obj_copy_ivs_to_hash_table_i(ID key, VALUE val, st_data_t arg)
1929{
1930 RUBY_ASSERT(!st_lookup((st_table *)arg, (st_data_t)key, NULL));
1931
1932 st_add_direct((st_table *)arg, (st_data_t)key, (st_data_t)val);
1933 return ST_CONTINUE;
1934}
1935
1936void
1937rb_obj_copy_ivs_to_hash_table(VALUE obj, st_table *table)
1938{
1939 rb_ivar_foreach(obj, rb_obj_copy_ivs_to_hash_table_i, (st_data_t)table);
1940}
1941
1942void
1943rb_obj_copy_fields_to_hash_table(VALUE obj, st_table *table)
1944{
1945 rb_field_foreach(obj, rb_obj_copy_ivs_to_hash_table_i, (st_data_t)table, false);
1946}
1947
1948static attr_index_t
1949obj_field_set(VALUE obj, shape_id_t target_shape_id, ID field_name, VALUE val)
1950{
1951 shape_id_t current_shape_id = RBASIC_SHAPE_ID(obj);
1952
1953 if (UNLIKELY(rb_shape_too_complex_p(target_shape_id))) {
1954 if (UNLIKELY(!rb_shape_too_complex_p(current_shape_id))) {
1955 current_shape_id = rb_evict_fields_to_hash(obj);
1956 }
1957
1958 if (RSHAPE_LEN(target_shape_id) > RSHAPE_LEN(current_shape_id)) {
1959 RBASIC_SET_SHAPE_ID(obj, target_shape_id);
1960 }
1961
1962 if (!field_name) {
1963 field_name = RSHAPE_EDGE_NAME(target_shape_id);
1964 RUBY_ASSERT(field_name);
1965 }
1966
1967 st_insert(ROBJECT_FIELDS_HASH(obj), (st_data_t)field_name, (st_data_t)val);
1968 RB_OBJ_WRITTEN(obj, Qundef, val);
1969
1970 return ATTR_INDEX_NOT_SET;
1971 }
1972 else {
1973 attr_index_t index = RSHAPE_INDEX(target_shape_id);
1974
1975 if (index >= RSHAPE_LEN(current_shape_id)) {
1976 if (UNLIKELY(index >= RSHAPE_CAPACITY(current_shape_id))) {
1977 rb_ensure_iv_list_size(obj, RSHAPE_CAPACITY(current_shape_id), RSHAPE_CAPACITY(target_shape_id));
1978 }
1979 RBASIC_SET_SHAPE_ID(obj, target_shape_id);
1980 }
1981
1982 RB_OBJ_WRITE(obj, &ROBJECT_FIELDS(obj)[index], val);
1983
1984 return index;
1985 }
1986}
1987
1988static attr_index_t
1989obj_ivar_set(VALUE obj, ID id, VALUE val)
1990{
1991 bool dontcare;
1992 shape_id_t target_shape_id = generic_shape_ivar(obj, id, &dontcare);
1993 return obj_field_set(obj, target_shape_id, id, val);
1994}
1995
1996/* Set the instance variable +val+ on object +obj+ at ivar name +id+.
1997 * This function only works with T_OBJECT objects, so make sure
1998 * +obj+ is of type T_OBJECT before using this function.
1999 */
2000VALUE
2001rb_vm_set_ivar_id(VALUE obj, ID id, VALUE val)
2002{
2003 rb_check_frozen(obj);
2004 obj_ivar_set(obj, id, val);
2005 return val;
2006}
2007
2009{
2010 if (RB_FL_ABLE(x)) {
2012 if (TYPE(x) == T_STRING) {
2013 RB_FL_UNSET_RAW(x, FL_USER2 | FL_USER3); // STR_CHILLED
2014 }
2015
2016 RB_SET_SHAPE_ID(x, rb_shape_transition_frozen(x));
2017
2018 if (RBASIC_CLASS(x)) {
2020 }
2021 }
2022}
2023
2024static attr_index_t class_ivar_set(VALUE obj, ID id, VALUE val, bool *new_ivar);
2025
2026static attr_index_t
2027ivar_set(VALUE obj, ID id, VALUE val)
2028{
2029 RB_DEBUG_COUNTER_INC(ivar_set_base);
2030
2031 switch (BUILTIN_TYPE(obj)) {
2032 case T_OBJECT:
2033 return obj_ivar_set(obj, id, val);
2034 case T_CLASS:
2035 case T_MODULE:
2036 {
2037 IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(id);
2038 bool dontcare;
2039 return class_ivar_set(obj, id, val, &dontcare);
2040 }
2041 default:
2042 return generic_ivar_set(obj, id, val);
2043 }
2044}
2045
2046VALUE
2048{
2049 rb_check_frozen(obj);
2050 ivar_set(obj, id, val);
2051 return val;
2052}
2053
2054attr_index_t
2055rb_ivar_set_index(VALUE obj, ID id, VALUE val)
2056{
2057 return ivar_set(obj, id, val);
2058}
2059
2060void
2061rb_ivar_set_internal(VALUE obj, ID id, VALUE val)
2062{
2063 // should be internal instance variable name (no @ prefix)
2064 VM_ASSERT(!rb_is_instance_id(id));
2065
2066 ivar_set(obj, id, val);
2067}
2068
2069attr_index_t
2070rb_obj_field_set(VALUE obj, shape_id_t target_shape_id, ID field_name, VALUE val)
2071{
2072 switch (BUILTIN_TYPE(obj)) {
2073 case T_OBJECT:
2074 return obj_field_set(obj, target_shape_id, field_name, val);
2075 case T_CLASS:
2076 case T_MODULE:
2077 // The only field is object_id and T_CLASS handle it differently.
2078 rb_bug("Unreachable");
2079 break;
2080 default:
2081 return generic_field_set(obj, target_shape_id, field_name, val);
2082 }
2083}
2084
2085static VALUE
2086ivar_defined0(VALUE obj, ID id)
2087{
2088 attr_index_t index;
2089
2090 if (rb_shape_obj_too_complex_p(obj)) {
2091 VALUE idx;
2092 st_table *table = NULL;
2093 switch (BUILTIN_TYPE(obj)) {
2094 case T_CLASS:
2095 case T_MODULE:
2096 rb_bug("Unreachable");
2097 break;
2098
2099 case T_IMEMO:
2100 RUBY_ASSERT(IMEMO_TYPE_P(obj, imemo_fields));
2101 table = rb_imemo_fields_complex_tbl(obj);
2102 break;
2103
2104 case T_OBJECT:
2105 table = ROBJECT_FIELDS_HASH(obj);
2106 break;
2107
2108 default: {
2109 VALUE fields_obj = rb_obj_fields_no_ractor_check(obj); // defined? doesn't require ractor checks
2110 table = rb_imemo_fields_complex_tbl(fields_obj);
2111 }
2112 }
2113
2114 if (!table || !rb_st_lookup(table, id, &idx)) {
2115 return Qfalse;
2116 }
2117
2118 return Qtrue;
2119 }
2120 else {
2121 return RBOOL(rb_shape_get_iv_index(RBASIC_SHAPE_ID(obj), id, &index));
2122 }
2123}
2124
2125VALUE
2127{
2128 if (SPECIAL_CONST_P(obj)) return Qfalse;
2129
2130 VALUE defined = Qfalse;
2131 switch (BUILTIN_TYPE(obj)) {
2132 case T_CLASS:
2133 case T_MODULE:
2134 {
2135 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
2136 if (fields_obj) {
2137 defined = ivar_defined0(fields_obj, id);
2138 }
2139 }
2140 break;
2141 default:
2142 defined = ivar_defined0(obj, id);
2143 break;
2144 }
2145 return defined;
2146}
2147
2149 VALUE obj;
2150 struct gen_fields_tbl *fields_tbl;
2151 st_data_t arg;
2152 rb_ivar_foreach_callback_func *func;
2153 VALUE *fields;
2154 bool ivar_only;
2155};
2156
2157static int
2158iterate_over_shapes_callback(shape_id_t shape_id, void *data)
2159{
2160 struct iv_itr_data *itr_data = data;
2161
2162 if (itr_data->ivar_only && !RSHAPE_TYPE_P(shape_id, SHAPE_IVAR)) {
2163 return ST_CONTINUE;
2164 }
2165
2166 VALUE *fields;
2167 switch (BUILTIN_TYPE(itr_data->obj)) {
2168 case T_OBJECT:
2169 RUBY_ASSERT(!rb_shape_obj_too_complex_p(itr_data->obj));
2170 fields = ROBJECT_FIELDS(itr_data->obj);
2171 break;
2172 case T_IMEMO:
2173 RUBY_ASSERT(IMEMO_TYPE_P(itr_data->obj, imemo_fields));
2174 RUBY_ASSERT(!rb_shape_obj_too_complex_p(itr_data->obj));
2175
2176 fields = rb_imemo_fields_ptr(itr_data->obj);
2177 break;
2178 default:
2179 rb_bug("Unreachable");
2180 }
2181
2182 VALUE val = fields[RSHAPE_INDEX(shape_id)];
2183 return itr_data->func(RSHAPE_EDGE_NAME(shape_id), val, itr_data->arg);
2184}
2185
2186/*
2187 * Returns a flag to stop iterating depending on the result of +callback+.
2188 */
2189static void
2190iterate_over_shapes(shape_id_t shape_id, rb_ivar_foreach_callback_func *callback, struct iv_itr_data *itr_data)
2191{
2192 rb_shape_foreach_field(shape_id, iterate_over_shapes_callback, itr_data);
2193}
2194
2195static int
2196each_hash_iv(st_data_t id, st_data_t val, st_data_t data)
2197{
2198 struct iv_itr_data * itr_data = (struct iv_itr_data *)data;
2199 rb_ivar_foreach_callback_func *callback = itr_data->func;
2200 if (is_internal_id((ID)id)) {
2201 return ST_CONTINUE;
2202 }
2203 return callback((ID)id, (VALUE)val, itr_data->arg);
2204}
2205
2206static void
2207obj_fields_each(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg, bool ivar_only)
2208{
2209 struct iv_itr_data itr_data = {
2210 .obj = obj,
2211 .arg = arg,
2212 .func = func,
2213 .ivar_only = ivar_only,
2214 };
2215
2216 shape_id_t shape_id = RBASIC_SHAPE_ID(obj);
2217 if (rb_shape_too_complex_p(shape_id)) {
2218 rb_st_foreach(ROBJECT_FIELDS_HASH(obj), each_hash_iv, (st_data_t)&itr_data);
2219 }
2220 else {
2221 itr_data.fields = ROBJECT_FIELDS(obj);
2222 iterate_over_shapes(shape_id, func, &itr_data);
2223 }
2224}
2225
2226static void
2227imemo_fields_each(VALUE fields_obj, rb_ivar_foreach_callback_func *func, st_data_t arg, bool ivar_only)
2228{
2229 IMEMO_TYPE_P(fields_obj, imemo_fields);
2230
2231 struct iv_itr_data itr_data = {
2232 .obj = fields_obj,
2233 .arg = arg,
2234 .func = func,
2235 .ivar_only = ivar_only,
2236 };
2237
2238 shape_id_t shape_id = RBASIC_SHAPE_ID(fields_obj);
2239 if (rb_shape_too_complex_p(shape_id)) {
2240 rb_st_foreach(rb_imemo_fields_complex_tbl(fields_obj), each_hash_iv, (st_data_t)&itr_data);
2241 }
2242 else {
2243 itr_data.fields = rb_imemo_fields_ptr(fields_obj);
2244 iterate_over_shapes(shape_id, func, &itr_data);
2245 }
2246}
2247
2248void
2250{
2251 VALUE new_fields_obj;
2252
2253 rb_check_frozen(dest);
2254
2255 if (!rb_obj_gen_fields_p(obj)) {
2256 return;
2257 }
2258
2259 shape_id_t src_shape_id = rb_obj_shape_id(obj);
2260
2261 VALUE fields_obj = rb_obj_fields_no_ractor_check(obj);
2262 if (fields_obj) {
2263 unsigned long src_num_ivs = rb_ivar_count(fields_obj);
2264 if (!src_num_ivs) {
2265 goto clear;
2266 }
2267
2268 if (rb_shape_too_complex_p(src_shape_id)) {
2269 rb_shape_copy_complex_ivars(dest, obj, src_shape_id, rb_imemo_fields_complex_tbl(fields_obj));
2270 return;
2271 }
2272
2273 shape_id_t dest_shape_id = src_shape_id;
2274 shape_id_t initial_shape_id = rb_obj_shape_id(dest);
2275
2276 if (!rb_shape_canonical_p(src_shape_id)) {
2277 RUBY_ASSERT(RSHAPE_TYPE_P(initial_shape_id, SHAPE_ROOT));
2278
2279 dest_shape_id = rb_shape_rebuild(initial_shape_id, src_shape_id);
2280 if (UNLIKELY(rb_shape_too_complex_p(dest_shape_id))) {
2281 st_table *table = rb_st_init_numtable_with_size(src_num_ivs);
2282 rb_obj_copy_ivs_to_hash_table(obj, table);
2283 rb_obj_init_too_complex(dest, table);
2284 return;
2285 }
2286 }
2287
2288 if (!RSHAPE_LEN(dest_shape_id)) {
2289 RBASIC_SET_SHAPE_ID(dest, dest_shape_id);
2290 return;
2291 }
2292
2293 new_fields_obj = rb_imemo_fields_new(dest, RSHAPE_CAPACITY(dest_shape_id), RB_OBJ_SHAREABLE_P(dest));
2294 VALUE *src_buf = rb_imemo_fields_ptr(fields_obj);
2295 VALUE *dest_buf = rb_imemo_fields_ptr(new_fields_obj);
2296 rb_shape_copy_fields(new_fields_obj, dest_buf, dest_shape_id, src_buf, src_shape_id);
2297 RBASIC_SET_SHAPE_ID(new_fields_obj, dest_shape_id);
2298
2299 rb_obj_replace_fields(dest, new_fields_obj);
2300 }
2301 return;
2302
2303 clear:
2305}
2306
2307void
2308rb_replace_generic_ivar(VALUE clone, VALUE obj)
2309{
2310 RB_VM_LOCKING() {
2311 st_data_t fields_tbl, obj_data = (st_data_t)obj;
2312 if (st_delete(generic_fields_tbl_, &obj_data, &fields_tbl)) {
2313 st_insert(generic_fields_tbl_, (st_data_t)clone, fields_tbl);
2314 RB_OBJ_WRITTEN(clone, Qundef, fields_tbl);
2315 }
2316 else {
2317 rb_bug("unreachable");
2318 }
2319 }
2320}
2321
2322void
2323rb_field_foreach(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg, bool ivar_only)
2324{
2325 if (SPECIAL_CONST_P(obj)) return;
2326 switch (BUILTIN_TYPE(obj)) {
2327 case T_IMEMO:
2328 if (IMEMO_TYPE_P(obj, imemo_fields)) {
2329 imemo_fields_each(obj, func, arg, ivar_only);
2330 }
2331 break;
2332 case T_OBJECT:
2333 obj_fields_each(obj, func, arg, ivar_only);
2334 break;
2335 case T_CLASS:
2336 case T_MODULE:
2337 {
2338 IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(0);
2339 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
2340 if (fields_obj) {
2341 imemo_fields_each(fields_obj, func, arg, ivar_only);
2342 }
2343 }
2344 break;
2345 default:
2346 {
2347 VALUE fields_obj = rb_obj_fields_no_ractor_check(obj);
2348 if (fields_obj) {
2349 imemo_fields_each(fields_obj, func, arg, ivar_only);
2350 }
2351 }
2352 break;
2353 }
2354}
2355
2356void
2357rb_ivar_foreach(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg)
2358{
2359 rb_field_foreach(obj, func, arg, true);
2360}
2361
2362st_index_t
2364{
2365 if (SPECIAL_CONST_P(obj)) return 0;
2366
2367 st_index_t iv_count = 0;
2368 switch (BUILTIN_TYPE(obj)) {
2369 case T_OBJECT:
2370 iv_count = ROBJECT_FIELDS_COUNT(obj);
2371 break;
2372
2373 case T_CLASS:
2374 case T_MODULE:
2375 {
2376 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
2377 if (!fields_obj) {
2378 return 0;
2379 }
2380 if (rb_shape_obj_too_complex_p(fields_obj)) {
2381 iv_count = rb_st_table_size(rb_imemo_fields_complex_tbl(fields_obj));
2382 }
2383 else {
2384 iv_count = RBASIC_FIELDS_COUNT(fields_obj);
2385 }
2386 }
2387 break;
2388
2389 case T_IMEMO:
2390 RUBY_ASSERT(IMEMO_TYPE_P(obj, imemo_fields));
2391
2392 if (rb_shape_obj_too_complex_p(obj)) {
2393 iv_count = rb_st_table_size(rb_imemo_fields_complex_tbl(obj));
2394 }
2395 else {
2396 iv_count = RBASIC_FIELDS_COUNT(obj);
2397 }
2398 break;
2399
2400 default:
2401 {
2402 VALUE fields_obj = rb_obj_fields_no_ractor_check(obj);
2403 if (fields_obj) {
2404 if (rb_shape_obj_too_complex_p(fields_obj)) {
2405 rb_st_table_size(rb_imemo_fields_complex_tbl(fields_obj));
2406 }
2407 else {
2408 iv_count = RBASIC_FIELDS_COUNT(obj);
2409 }
2410 }
2411 }
2412 break;
2413 }
2414
2415 if (rb_shape_obj_has_id(obj)) {
2416 iv_count--;
2417 }
2418
2419 return iv_count;
2420}
2421
2422static int
2423ivar_i(ID key, VALUE v, st_data_t a)
2424{
2425 VALUE ary = (VALUE)a;
2426
2427 if (rb_is_instance_id(key)) {
2428 rb_ary_push(ary, ID2SYM(key));
2429 }
2430 return ST_CONTINUE;
2431}
2432
2433/*
2434 * call-seq:
2435 * obj.instance_variables -> array
2436 *
2437 * Returns an array of instance variable names for the receiver. Note
2438 * that simply defining an accessor does not create the corresponding
2439 * instance variable.
2440 *
2441 * class Fred
2442 * attr_accessor :a1
2443 * def initialize
2444 * @iv = 3
2445 * end
2446 * end
2447 * Fred.new.instance_variables #=> [:@iv]
2448 */
2449
2450VALUE
2452{
2454 rb_ivar_foreach(obj, ivar_i, ary);
2455 return ary;
2456}
2457
2458#define rb_is_constant_id rb_is_const_id
2459#define rb_is_constant_name rb_is_const_name
2460#define id_for_var(obj, name, part, type) \
2461 id_for_var_message(obj, name, type, "'%1$s' is not allowed as "#part" "#type" variable name")
2462#define id_for_var_message(obj, name, type, message) \
2463 check_id_type(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message))
2464static ID
2465check_id_type(VALUE obj, VALUE *pname,
2466 int (*valid_id_p)(ID), int (*valid_name_p)(VALUE),
2467 const char *message, size_t message_len)
2468{
2469 ID id = rb_check_id(pname);
2470 VALUE name = *pname;
2471
2472 if (id ? !valid_id_p(id) : !valid_name_p(name)) {
2473 rb_name_err_raise_str(rb_fstring_new(message, message_len),
2474 obj, name);
2475 }
2476 return id;
2477}
2478
2479/*
2480 * call-seq:
2481 * obj.remove_instance_variable(symbol) -> obj
2482 * obj.remove_instance_variable(string) -> obj
2483 *
2484 * Removes the named instance variable from <i>obj</i>, returning that
2485 * variable's value. The name can be passed as a symbol or as a string.
2486 *
2487 * class Dummy
2488 * attr_reader :var
2489 * def initialize
2490 * @var = 99
2491 * end
2492 * def remove
2493 * remove_instance_variable(:@var)
2494 * end
2495 * end
2496 * d = Dummy.new
2497 * d.var #=> 99
2498 * d.remove #=> 99
2499 * d.var #=> nil
2500 */
2501
2502VALUE
2504{
2505 const ID id = id_for_var(obj, name, an, instance);
2506
2507 // Frozen check comes here because it's expected that we raise a
2508 // NameError (from the id_for_var check) before we raise a FrozenError
2509 rb_check_frozen(obj);
2510
2511 if (id) {
2512 VALUE val = rb_ivar_delete(obj, id, Qundef);
2513
2514 if (!UNDEF_P(val)) return val;
2515 }
2516
2517 rb_name_err_raise("instance variable %1$s not defined",
2518 obj, name);
2520}
2521
2522NORETURN(static void uninitialized_constant(VALUE, VALUE));
2523static void
2524uninitialized_constant(VALUE klass, VALUE name)
2525{
2526 if (klass && rb_class_real(klass) != rb_cObject)
2527 rb_name_err_raise("uninitialized constant %2$s::%1$s",
2528 klass, name);
2529 else
2530 rb_name_err_raise("uninitialized constant %1$s",
2531 klass, name);
2532}
2533
2534VALUE
2535rb_const_missing(VALUE klass, VALUE name)
2536{
2537 VALUE value = rb_funcallv(klass, idConst_missing, 1, &name);
2538 rb_vm_inc_const_missing_count();
2539 return value;
2540}
2541
2542
2543/*
2544 * call-seq:
2545 * mod.const_missing(sym) -> obj
2546 *
2547 * Invoked when a reference is made to an undefined constant in
2548 * <i>mod</i>. It is passed a symbol for the undefined constant, and
2549 * returns a value to be used for that constant. For example, consider:
2550 *
2551 * def Foo.const_missing(name)
2552 * name # return the constant name as Symbol
2553 * end
2554 *
2555 * Foo::UNDEFINED_CONST #=> :UNDEFINED_CONST: symbol returned
2556 *
2557 * As the example above shows, +const_missing+ is not required to create the
2558 * missing constant in <i>mod</i>, though that is often a side-effect. The
2559 * caller gets its return value when triggered. If the constant is also defined,
2560 * further lookups won't hit +const_missing+ and will return the value stored in
2561 * the constant as usual. Otherwise, +const_missing+ will be invoked again.
2562 *
2563 * In the next example, when a reference is made to an undefined constant,
2564 * +const_missing+ attempts to load a file whose path is the lowercase version
2565 * of the constant name (thus class <code>Fred</code> is assumed to be in file
2566 * <code>fred.rb</code>). If defined as a side-effect of loading the file, the
2567 * method returns the value stored in the constant. This implements an autoload
2568 * feature similar to Kernel#autoload and Module#autoload, though it differs in
2569 * important ways.
2570 *
2571 * def Object.const_missing(name)
2572 * @looked_for ||= {}
2573 * str_name = name.to_s
2574 * raise "Constant not found: #{name}" if @looked_for[str_name]
2575 * @looked_for[str_name] = 1
2576 * file = str_name.downcase
2577 * require file
2578 * const_get(name, false)
2579 * end
2580 *
2581 */
2582
2583VALUE
2584rb_mod_const_missing(VALUE klass, VALUE name)
2585{
2586 rb_execution_context_t *ec = GET_EC();
2587 VALUE ref = ec->private_const_reference;
2588 rb_vm_pop_cfunc_frame();
2589 if (ref) {
2590 ec->private_const_reference = 0;
2591 rb_name_err_raise("private constant %2$s::%1$s referenced", ref, name);
2592 }
2593 uninitialized_constant(klass, name);
2594
2596}
2597
2598static void
2599autoload_table_mark(void *ptr)
2600{
2601 rb_mark_tbl_no_pin((st_table *)ptr);
2602}
2603
2604static void
2605autoload_table_free(void *ptr)
2606{
2607 st_free_table((st_table *)ptr);
2608}
2609
2610static size_t
2611autoload_table_memsize(const void *ptr)
2612{
2613 const st_table *tbl = ptr;
2614 return st_memsize(tbl);
2615}
2616
2617static void
2618autoload_table_compact(void *ptr)
2619{
2620 rb_gc_ref_update_table_values_only((st_table *)ptr);
2621}
2622
2623static const rb_data_type_t autoload_table_type = {
2624 "autoload_table",
2625 {autoload_table_mark, autoload_table_free, autoload_table_memsize, autoload_table_compact,},
2626 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
2627};
2628
2629#define check_autoload_table(av) \
2630 (struct st_table *)rb_check_typeddata((av), &autoload_table_type)
2631
2632static VALUE
2633autoload_data(VALUE mod, ID id)
2634{
2635 struct st_table *tbl;
2636 st_data_t val;
2637
2638 // If we are called with a non-origin ICLASS, fetch the autoload data from
2639 // the original module.
2640 if (RB_TYPE_P(mod, T_ICLASS)) {
2641 if (RICLASS_IS_ORIGIN_P(mod)) {
2642 return 0;
2643 }
2644 else {
2645 mod = RBASIC(mod)->klass;
2646 }
2647 }
2648
2650
2651 // Look up the instance variable table for `autoload`, then index into that table with the given constant name `id`.
2652
2653 VALUE tbl_value = rb_ivar_lookup(mod, autoload, Qfalse);
2654 if (!RTEST(tbl_value) || !(tbl = check_autoload_table(tbl_value)) || !st_lookup(tbl, (st_data_t)id, &val)) {
2655 return 0;
2656 }
2657
2658 return (VALUE)val;
2659}
2660
2661// Every autoload constant has exactly one instance of autoload_const, stored in `autoload_features`. Since multiple autoload constants can refer to the same file, every `autoload_const` refers to a de-duplicated `autoload_data`.
2663 // The linked list node of all constants which are loaded by the related autoload feature.
2664 struct ccan_list_node cnode; /* <=> autoload_data.constants */
2665
2666 // The shared "autoload_data" if multiple constants are defined from the same feature.
2667 VALUE autoload_data_value;
2668
2669 // The box object when the autoload is called in a user box
2670 // Otherwise, Qnil means the root box
2671 VALUE box_value;
2672
2673 // The module we are loading a constant into.
2674 VALUE module;
2675
2676 // The name of the constant we are loading.
2677 ID name;
2678
2679 // The value of the constant (after it's loaded).
2680 VALUE value;
2681
2682 // The constant entry flags which need to be re-applied after autoloading the feature.
2683 rb_const_flag_t flag;
2684
2685 // The source file and line number that defined this constant (different from feature path).
2686 VALUE file;
2687 int line;
2688};
2689
2690// Each `autoload_data` uniquely represents a specific feature which can be loaded, and a list of constants which it is able to define. We use a mutex to coordinate multiple threads trying to load the same feature.
2692 // The feature path to require to load this constant.
2693 VALUE feature;
2694
2695 // The mutex which is protecting autoloading this feature.
2696 VALUE mutex;
2697
2698 // The process fork serial number since the autoload mutex will become invalid on fork.
2699 rb_serial_t fork_gen;
2700
2701 // The linked list of all constants that are going to be loaded by this autoload.
2702 struct ccan_list_head constants; /* <=> autoload_const.cnode */
2703};
2704
2705static void
2706autoload_data_mark_and_move(void *ptr)
2707{
2708 struct autoload_data *p = ptr;
2709
2710 rb_gc_mark_and_move(&p->feature);
2711 rb_gc_mark_and_move(&p->mutex);
2712}
2713
2714static void
2715autoload_data_free(void *ptr)
2716{
2717 struct autoload_data *p = ptr;
2718
2719 struct autoload_const *autoload_const, *next;
2720 ccan_list_for_each_safe(&p->constants, autoload_const, next, cnode) {
2721 ccan_list_del_init(&autoload_const->cnode);
2722 }
2723
2724 SIZED_FREE(p);
2725}
2726
2727static size_t
2728autoload_data_memsize(const void *ptr)
2729{
2730 return sizeof(struct autoload_data);
2731}
2732
2733static const rb_data_type_t autoload_data_type = {
2734 "autoload_data",
2735 {autoload_data_mark_and_move, autoload_data_free, autoload_data_memsize, autoload_data_mark_and_move},
2736 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
2737};
2738
2739static void
2740autoload_const_mark_and_move(void *ptr)
2741{
2742 struct autoload_const *ac = ptr;
2743
2744 rb_gc_mark_and_move(&ac->module);
2745 rb_gc_mark_and_move(&ac->autoload_data_value);
2746 rb_gc_mark_and_move(&ac->value);
2747 rb_gc_mark_and_move(&ac->file);
2748 rb_gc_mark_and_move(&ac->box_value);
2749}
2750
2751static size_t
2752autoload_const_memsize(const void *ptr)
2753{
2754 return sizeof(struct autoload_const);
2755}
2756
2757static void
2758autoload_const_free(void *ptr)
2759{
2760 struct autoload_const *autoload_const = ptr;
2761
2762 ccan_list_del(&autoload_const->cnode);
2763 SIZED_FREE(autoload_const);
2764}
2765
2766static const rb_data_type_t autoload_const_type = {
2767 "autoload_const",
2768 {autoload_const_mark_and_move, autoload_const_free, autoload_const_memsize, autoload_const_mark_and_move,},
2769 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
2770};
2771
2772static struct autoload_data *
2773get_autoload_data(VALUE autoload_const_value, struct autoload_const **autoload_const_pointer)
2774{
2775 struct autoload_const *autoload_const = rb_check_typeddata(autoload_const_value, &autoload_const_type);
2776
2777 VALUE autoload_data_value = autoload_const->autoload_data_value;
2778 struct autoload_data *autoload_data = rb_check_typeddata(autoload_data_value, &autoload_data_type);
2779
2780 /* do not reach across stack for ->state after forking: */
2781 if (autoload_data && autoload_data->fork_gen != GET_VM()->fork_gen) {
2782 RB_OBJ_WRITE(autoload_data_value, &autoload_data->mutex, Qnil);
2783 autoload_data->fork_gen = 0;
2784 }
2785
2786 if (autoload_const_pointer) *autoload_const_pointer = autoload_const;
2787
2788 return autoload_data;
2789}
2790
2792 VALUE dst_tbl_value;
2793 struct st_table *dst_tbl;
2794 const rb_box_t *box;
2795};
2796
2797static int
2798autoload_copy_table_for_box_i(st_data_t key, st_data_t value, st_data_t arg)
2799{
2801 struct autoload_copy_table_data *data = (struct autoload_copy_table_data *)arg;
2802 struct st_table *tbl = data->dst_tbl;
2803 VALUE tbl_value = data->dst_tbl_value;
2804 const rb_box_t *box = data->box;
2805
2806 VALUE src_value = (VALUE)value;
2807 struct autoload_const *src_const = rb_check_typeddata(src_value, &autoload_const_type);
2808 // autoload_data can be shared between copies because the feature is equal between copies.
2809 VALUE autoload_data_value = src_const->autoload_data_value;
2810 struct autoload_data *autoload_data = rb_check_typeddata(autoload_data_value, &autoload_data_type);
2811
2812 VALUE new_value = TypedData_Make_Struct(0, struct autoload_const, &autoload_const_type, autoload_const);
2813 RB_OBJ_WRITE(new_value, &autoload_const->box_value, rb_get_box_object((rb_box_t *)box));
2814 RB_OBJ_WRITE(new_value, &autoload_const->module, src_const->module);
2815 autoload_const->name = src_const->name;
2816 RB_OBJ_WRITE(new_value, &autoload_const->value, src_const->value);
2817 autoload_const->flag = src_const->flag;
2818 RB_OBJ_WRITE(new_value, &autoload_const->autoload_data_value, autoload_data_value);
2819 ccan_list_add_tail(&autoload_data->constants, &autoload_const->cnode);
2820
2821 st_insert(tbl, (st_data_t)autoload_const->name, (st_data_t)new_value);
2822 RB_OBJ_WRITTEN(tbl_value, Qundef, new_value);
2823
2824 return ST_CONTINUE;
2825}
2826
2827void
2828rb_autoload_copy_table_for_box(st_table *iv_ptr, const rb_box_t *box)
2829{
2830 struct st_table *src_tbl, *dst_tbl;
2831 VALUE src_tbl_value, dst_tbl_value;
2832 if (!rb_st_lookup(iv_ptr, (st_data_t)autoload, (st_data_t *)&src_tbl_value)) {
2833 // the class has no autoload table yet.
2834 return;
2835 }
2836 if (!RTEST(src_tbl_value) || !(src_tbl = check_autoload_table(src_tbl_value))) {
2837 // the __autoload__ ivar value isn't autoload table value.
2838 return;
2839 }
2840 src_tbl = check_autoload_table(src_tbl_value);
2841
2842 dst_tbl_value = TypedData_Wrap_Struct(0, &autoload_table_type, NULL);
2843 RTYPEDDATA_DATA(dst_tbl_value) = dst_tbl = st_init_numtable();
2844
2845 struct autoload_copy_table_data data = {
2846 .dst_tbl_value = dst_tbl_value,
2847 .dst_tbl = dst_tbl,
2848 .box = box,
2849 };
2850
2851 st_foreach(src_tbl, autoload_copy_table_for_box_i, (st_data_t)&data);
2852 st_insert(iv_ptr, (st_data_t)autoload, (st_data_t)dst_tbl_value);
2853}
2854
2855void
2856rb_autoload(VALUE module, ID name, const char *feature)
2857{
2858 if (!feature || !*feature) {
2859 rb_raise(rb_eArgError, "empty feature name");
2860 }
2861
2862 rb_autoload_str(module, name, rb_fstring_cstr(feature));
2863}
2864
2865static void const_set(VALUE klass, ID id, VALUE val);
2866static void const_added(VALUE klass, ID const_name);
2867
2869 VALUE module;
2870 ID name;
2871 VALUE feature;
2872 VALUE box_value;
2873};
2874
2875static VALUE
2876autoload_feature_lookup_or_create(VALUE feature, struct autoload_data **autoload_data_pointer)
2877{
2878 RUBY_ASSERT_MUTEX_OWNED(autoload_mutex);
2879 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
2880
2881 VALUE autoload_data_value = rb_hash_aref(autoload_features, feature);
2883
2884 if (NIL_P(autoload_data_value)) {
2885 autoload_data_value = TypedData_Make_Struct(0, struct autoload_data, &autoload_data_type, autoload_data);
2886 RB_OBJ_WRITE(autoload_data_value, &autoload_data->feature, feature);
2887 RB_OBJ_WRITE(autoload_data_value, &autoload_data->mutex, Qnil);
2888 ccan_list_head_init(&autoload_data->constants);
2889
2890 if (autoload_data_pointer) *autoload_data_pointer = autoload_data;
2891
2892 rb_hash_aset(autoload_features, feature, autoload_data_value);
2893 }
2894 else if (autoload_data_pointer) {
2895 *autoload_data_pointer = rb_check_typeddata(autoload_data_value, &autoload_data_type);
2896 }
2897
2898 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
2899 return autoload_data_value;
2900}
2901
2902static VALUE
2903autoload_table_lookup_or_create(VALUE module)
2904{
2905 VALUE autoload_table_value = rb_ivar_lookup(module, autoload, Qfalse);
2906 if (RTEST(autoload_table_value)) {
2907 return autoload_table_value;
2908 }
2909 else {
2910 autoload_table_value = TypedData_Wrap_Struct(0, &autoload_table_type, NULL);
2911 rb_class_ivar_set(module, autoload, autoload_table_value);
2912 RTYPEDDATA_DATA(autoload_table_value) = st_init_numtable();
2913 return autoload_table_value;
2914 }
2915}
2916
2917static VALUE
2918autoload_synchronized(VALUE _arguments)
2919{
2920 struct autoload_arguments *arguments = (struct autoload_arguments *)_arguments;
2921
2922 rb_const_entry_t *constant_entry = rb_const_lookup(arguments->module, arguments->name);
2923 if (constant_entry && !UNDEF_P(constant_entry->value)) {
2924 return Qfalse;
2925 }
2926
2927 // Reset any state associated with any previous constant:
2928 const_set(arguments->module, arguments->name, Qundef);
2929
2930 VALUE autoload_table_value = autoload_table_lookup_or_create(arguments->module);
2931 struct st_table *autoload_table = check_autoload_table(autoload_table_value);
2932
2933 // Ensure the string is uniqued since we use an identity lookup:
2934 VALUE feature = rb_fstring(arguments->feature);
2935
2937 VALUE autoload_data_value = autoload_feature_lookup_or_create(feature, &autoload_data);
2938
2939 {
2941 VALUE autoload_const_value = TypedData_Make_Struct(0, struct autoload_const, &autoload_const_type, autoload_const);
2942 RB_OBJ_WRITE(autoload_const_value, &autoload_const->box_value, arguments->box_value);
2943 RB_OBJ_WRITE(autoload_const_value, &autoload_const->module, arguments->module);
2944 autoload_const->name = arguments->name;
2945 autoload_const->value = Qundef;
2946 autoload_const->flag = CONST_PUBLIC;
2947 RB_OBJ_WRITE(autoload_const_value, &autoload_const->autoload_data_value, autoload_data_value);
2948 ccan_list_add_tail(&autoload_data->constants, &autoload_const->cnode);
2949 st_insert(autoload_table, (st_data_t)arguments->name, (st_data_t)autoload_const_value);
2950 RB_OBJ_WRITTEN(autoload_table_value, Qundef, autoload_const_value);
2951 }
2952
2953 return Qtrue;
2954}
2955
2956void
2957rb_autoload_str(VALUE module, ID name, VALUE feature)
2958{
2959 const rb_box_t *box = rb_current_box();
2960 VALUE current_box_value = rb_get_box_object((rb_box_t *)box);
2961
2962 if (!rb_is_const_id(name)) {
2963 rb_raise(rb_eNameError, "autoload must be constant name: %"PRIsVALUE"", QUOTE_ID(name));
2964 }
2965
2966 Check_Type(feature, T_STRING);
2967 if (!RSTRING_LEN(feature)) {
2968 rb_raise(rb_eArgError, "empty feature name");
2969 }
2970
2971 struct autoload_arguments arguments = {
2972 .module = module,
2973 .name = name,
2974 .feature = feature,
2975 .box_value = current_box_value,
2976 };
2977
2978 VALUE result = rb_mutex_synchronize(autoload_mutex, autoload_synchronized, (VALUE)&arguments);
2979
2980 if (result == Qtrue) {
2981 const_added(module, name);
2982 }
2983}
2984
2985static void
2986autoload_delete(VALUE module, ID name)
2987{
2988 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
2989
2990 st_data_t load = 0, key = name;
2991
2992 RUBY_ASSERT(RB_TYPE_P(module, T_CLASS) || RB_TYPE_P(module, T_MODULE));
2993
2994 VALUE table_value = rb_ivar_lookup(module, autoload, Qfalse);
2995 if (RTEST(table_value)) {
2996 struct st_table *table = check_autoload_table(table_value);
2997
2998 st_delete(table, &key, &load);
2999 RB_OBJ_WRITTEN(table_value, load, Qundef);
3000
3001 /* Qfalse can indicate already deleted */
3002 if (load != Qfalse) {
3004 struct autoload_data *autoload_data = get_autoload_data((VALUE)load, &autoload_const);
3005
3006 VM_ASSERT(autoload_data);
3007 VM_ASSERT(!ccan_list_empty(&autoload_data->constants));
3008
3009 /*
3010 * we must delete here to avoid "already initialized" warnings
3011 * with parallel autoload. Using list_del_init here so list_del
3012 * works in autoload_const_free
3013 */
3014 ccan_list_del_init(&autoload_const->cnode);
3015
3016 if (ccan_list_empty(&autoload_data->constants)) {
3017 rb_hash_delete(autoload_features, autoload_data->feature);
3018 }
3019
3020 // If the autoload table is empty, we can delete it.
3021 if (table->num_entries == 0) {
3022 rb_attr_delete(module, autoload);
3023 }
3024 }
3025 }
3026
3027 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
3028}
3029
3030static int
3031autoload_by_someone_else(struct autoload_data *ele)
3032{
3033 return ele->mutex != Qnil && !rb_mutex_owned_p(ele->mutex);
3034}
3035
3036static VALUE
3037check_autoload_required(VALUE mod, ID id, const char **loadingpath)
3038{
3039 VALUE autoload_const_value = autoload_data(mod, id);
3041 const char *loading;
3042
3043 if (!autoload_const_value || !(autoload_data = get_autoload_data(autoload_const_value, 0))) {
3044 return 0;
3045 }
3046
3047 VALUE feature = autoload_data->feature;
3048
3049 /*
3050 * if somebody else is autoloading, we MUST wait for them, since
3051 * rb_provide_feature can provide a feature before autoload_const_set
3052 * completes. We must wait until autoload_const_set finishes in
3053 * the other thread.
3054 */
3055 if (autoload_by_someone_else(autoload_data)) {
3056 return autoload_const_value;
3057 }
3058
3059 loading = RSTRING_PTR(feature);
3060
3061 if (!rb_feature_provided(loading, &loading)) {
3062 return autoload_const_value;
3063 }
3064
3065 if (loadingpath && loading) {
3066 *loadingpath = loading;
3067 return autoload_const_value;
3068 }
3069
3070 return 0;
3071}
3072
3073static struct autoload_const *autoloading_const_entry(VALUE mod, ID id);
3074
3075int
3076rb_autoloading_value(VALUE mod, ID id, VALUE* value, rb_const_flag_t *flag)
3077{
3078 struct autoload_const *ac = autoloading_const_entry(mod, id);
3079 if (!ac) return FALSE;
3080
3081 if (value) {
3082 *value = ac->value;
3083 }
3084
3085 if (flag) {
3086 *flag = ac->flag;
3087 }
3088
3089 return TRUE;
3090}
3091
3092static int
3093autoload_by_current(struct autoload_data *ele)
3094{
3095 return ele->mutex != Qnil && rb_mutex_owned_p(ele->mutex);
3096}
3097
3098// If there is an autoloading constant and it has been set by the current
3099// execution context, return it. This allows threads which are loading code to
3100// refer to their own autoloaded constants.
3101struct autoload_const *
3102autoloading_const_entry(VALUE mod, ID id)
3103{
3104 VALUE load = autoload_data(mod, id);
3105 struct autoload_data *ele;
3106 struct autoload_const *ac;
3107
3108 // Find the autoloading state:
3109 if (!load || !(ele = get_autoload_data(load, &ac))) {
3110 // Couldn't be found:
3111 return 0;
3112 }
3113
3114 // Check if it's being loaded by the current thread/fiber:
3115 if (autoload_by_current(ele)) {
3116 if (!UNDEF_P(ac->value)) {
3117 return ac;
3118 }
3119 }
3120
3121 return 0;
3122}
3123
3124static int
3125autoload_defined_p(VALUE mod, ID id)
3126{
3127 rb_const_entry_t *ce = rb_const_lookup(mod, id);
3128
3129 // If there is no constant or the constant is not undefined (special marker for autoloading):
3130 if (!ce || !UNDEF_P(ce->value)) {
3131 // We are not autoloading:
3132 return 0;
3133 }
3134
3135 // Otherwise check if there is an autoload in flight right now:
3136 return !rb_autoloading_value(mod, id, NULL, NULL);
3137}
3138
3139static void const_tbl_update(struct autoload_const *, int);
3140
3142 VALUE module;
3143 ID name;
3144 int flag;
3145
3146 VALUE mutex;
3147
3148 // The specific constant which triggered the autoload code to fire:
3150
3151 // The parent autoload data which is shared between multiple constants:
3153};
3154
3155static VALUE
3156autoload_const_set(struct autoload_const *ac)
3157{
3158 check_before_mod_set(ac->module, ac->name, ac->value, "constant");
3159
3160 RB_VM_LOCKING() {
3161 const_tbl_update(ac, true);
3162 }
3163
3164 return 0; /* ignored */
3165}
3166
3167static VALUE
3168autoload_load_needed(VALUE _arguments)
3169{
3170 struct autoload_load_arguments *arguments = (struct autoload_load_arguments*)_arguments;
3171
3172 const char *loading = 0, *src;
3173
3174 if (!autoload_defined_p(arguments->module, arguments->name)) {
3175 return Qfalse;
3176 }
3177
3178 VALUE autoload_const_value = check_autoload_required(arguments->module, arguments->name, &loading);
3179 if (!autoload_const_value) {
3180 return Qfalse;
3181 }
3182
3183 src = rb_sourcefile();
3184 if (src && loading && strcmp(src, loading) == 0) {
3185 return Qfalse;
3186 }
3187
3190 if (!(autoload_data = get_autoload_data(autoload_const_value, &autoload_const))) {
3191 return Qfalse;
3192 }
3193
3194 if (NIL_P(autoload_data->mutex)) {
3195 RB_OBJ_WRITE(autoload_const->autoload_data_value, &autoload_data->mutex, rb_mutex_new());
3196 autoload_data->fork_gen = GET_VM()->fork_gen;
3197 }
3198 else if (rb_mutex_owned_p(autoload_data->mutex)) {
3199 return Qfalse;
3200 }
3201
3202 arguments->mutex = autoload_data->mutex;
3203 arguments->autoload_const = autoload_const;
3204
3205 return autoload_const_value;
3206}
3207
3208static VALUE
3209autoload_apply_constants(VALUE _arguments)
3210{
3211 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
3212
3213 struct autoload_load_arguments *arguments = (struct autoload_load_arguments*)_arguments;
3214
3215 struct autoload_const *autoload_const = 0; // for ccan_container_off_var()
3216 struct autoload_const *next;
3217
3218 // We use safe iteration here because `autoload_const_set` will eventually invoke
3219 // `autoload_delete` which will remove the constant from the linked list. In theory, once
3220 // the `autoload_data->constants` linked list is empty, we can remove it.
3221
3222 // Iterate over all constants and assign them:
3223 ccan_list_for_each_safe(&arguments->autoload_data->constants, autoload_const, next, cnode) {
3224 if (!UNDEF_P(autoload_const->value)) {
3225 autoload_const_set(autoload_const);
3226 }
3227 }
3228
3229 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
3230
3231 return Qtrue;
3232}
3233
3234static VALUE
3235autoload_feature_require(VALUE _arguments)
3236{
3237 VALUE receiver = rb_vm_top_self();
3238
3239 struct autoload_load_arguments *arguments = (struct autoload_load_arguments*)_arguments;
3240
3241 struct autoload_const *autoload_const = arguments->autoload_const;
3242 VALUE autoload_box_value = autoload_const->box_value;
3243
3244 // We save this for later use in autoload_apply_constants:
3245 arguments->autoload_data = rb_check_typeddata(autoload_const->autoload_data_value, &autoload_data_type);
3246
3247 if (rb_box_available() && BOX_OBJ_P(autoload_box_value))
3248 receiver = autoload_box_value;
3249
3250 /*
3251 * Clear the global cc cache table because the require method can be different from the current
3252 * box's one and it may cause inconsistent cc-cme states.
3253 * For example, the assertion below may fail in gccct_method_search();
3254 * VM_ASSERT(vm_cc_check_cme(cc, rb_callable_method_entry(klass, mid)))
3255 */
3256 rb_gccct_clear_table();
3257
3258 VALUE result = rb_funcall(receiver, rb_intern("require"), 1, arguments->autoload_data->feature);
3259
3260 if (RTEST(result)) {
3261 return rb_mutex_synchronize(autoload_mutex, autoload_apply_constants, _arguments);
3262 }
3263 return result;
3264}
3265
3266static VALUE
3267autoload_try_load(VALUE _arguments)
3268{
3269 struct autoload_load_arguments *arguments = (struct autoload_load_arguments*)_arguments;
3270
3271 VALUE result = autoload_feature_require(_arguments);
3272
3273 // After we loaded the feature, if the constant is not defined, we remove it completely:
3274 rb_const_entry_t *ce = rb_const_lookup(arguments->module, arguments->name);
3275
3276 if (!ce || UNDEF_P(ce->value)) {
3277 result = Qfalse;
3278
3279 rb_const_remove(arguments->module, arguments->name);
3280
3281 if (arguments->module == rb_cObject) {
3282 rb_warning(
3283 "Expected %"PRIsVALUE" to define %"PRIsVALUE" but it didn't",
3284 arguments->autoload_data->feature,
3285 ID2SYM(arguments->name)
3286 );
3287 }
3288 else {
3289 rb_warning(
3290 "Expected %"PRIsVALUE" to define %"PRIsVALUE"::%"PRIsVALUE" but it didn't",
3291 arguments->autoload_data->feature,
3292 arguments->module,
3293 ID2SYM(arguments->name)
3294 );
3295 }
3296 }
3297 else {
3298 // Otherwise, it was loaded, copy the flags from the autoload constant:
3299 ce->flag |= arguments->flag;
3300 }
3301
3302 return result;
3303}
3304
3305VALUE
3307{
3308 rb_const_entry_t *ce = rb_const_lookup(module, name);
3309
3310 // We bail out as early as possible without any synchronisation:
3311 if (!ce || !UNDEF_P(ce->value)) {
3312 return Qfalse;
3313 }
3314
3315 // At this point, we assume there might be autoloading, so fail if it's ractor:
3316 if (UNLIKELY(!rb_ractor_main_p())) {
3317 return rb_ractor_autoload_load(module, name);
3318 }
3319
3320 // This state is stored on the stack and is used during the autoload process.
3321 struct autoload_load_arguments arguments = {.module = module, .name = name, .mutex = Qnil};
3322
3323 // Figure out whether we can autoload the named constant:
3324 VALUE autoload_const_value = rb_mutex_synchronize(autoload_mutex, autoload_load_needed, (VALUE)&arguments);
3325
3326 // This confirms whether autoloading is required or not:
3327 if (autoload_const_value == Qfalse) return autoload_const_value;
3328
3329 arguments.flag = ce->flag & (CONST_DEPRECATED | CONST_VISIBILITY_MASK);
3330
3331 // Only one thread will enter here at a time:
3332 VALUE result = rb_mutex_synchronize(arguments.mutex, autoload_try_load, (VALUE)&arguments);
3333
3334 // If you don't guard this value, it's possible for the autoload constant to
3335 // be freed by another thread which loads multiple constants, one of which
3336 // resolves to the constant this thread is trying to load, so proteect this
3337 // so that it is not freed until we are done with it in `autoload_try_load`:
3338 RB_GC_GUARD(autoload_const_value);
3339
3340 return result;
3341}
3342
3343VALUE
3345{
3346 return rb_autoload_at_p(mod, id, TRUE);
3347}
3348
3349VALUE
3350rb_autoload_at_p(VALUE mod, ID id, int recur)
3351{
3352 VALUE load;
3353 struct autoload_data *ele;
3354
3355 while (!autoload_defined_p(mod, id)) {
3356 if (!recur) return Qnil;
3357 mod = RCLASS_SUPER(mod);
3358 if (!mod) return Qnil;
3359 }
3360 load = check_autoload_required(mod, id, 0);
3361 if (!load) return Qnil;
3362 return (ele = get_autoload_data(load, 0)) ? ele->feature : Qnil;
3363}
3364
3365void
3366rb_const_warn_if_deprecated(const rb_const_entry_t *ce, VALUE klass, ID id)
3367{
3368 if (RB_CONST_DEPRECATED_P(ce) &&
3369 rb_warning_category_enabled_p(RB_WARN_CATEGORY_DEPRECATED)) {
3370 if (klass == rb_cObject) {
3371 rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "constant ::%"PRIsVALUE" is deprecated", QUOTE_ID(id));
3372 }
3373 else {
3374 rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "constant %"PRIsVALUE"::%"PRIsVALUE" is deprecated",
3375 rb_class_name(klass), QUOTE_ID(id));
3376 }
3377 }
3378}
3379
3380static VALUE
3381rb_const_get_0(VALUE klass, ID id, int exclude, int recurse, int visibility)
3382{
3383 VALUE found_in;
3384 VALUE c = rb_const_search(klass, id, exclude, recurse, visibility, &found_in);
3385 if (!UNDEF_P(c)) {
3386 if (UNLIKELY(!rb_ractor_main_p())) {
3387 if (!rb_ractor_shareable_p(c)) {
3388 rb_raise(rb_eRactorIsolationError, "can not access non-shareable objects in constant %"PRIsVALUE"::%"PRIsVALUE" by non-main Ractor.", rb_class_path(found_in), rb_id2str(id));
3389 }
3390 }
3391 return c;
3392 }
3393 return rb_const_missing(klass, ID2SYM(id));
3394}
3395
3396static VALUE
3397rb_const_search_from(VALUE klass, ID id, int exclude, int recurse, int visibility, VALUE *found_in)
3398{
3399 VALUE value, current;
3400 bool first_iteration = true;
3401
3402 for (current = klass;
3403 RTEST(current);
3404 current = RCLASS_SUPER(current), first_iteration = false) {
3405 VALUE tmp;
3406 VALUE am = 0;
3407 rb_const_entry_t *ce;
3408
3409 if (!first_iteration && RCLASS_ORIGIN(current) != current) {
3410 // This item in the super chain has an origin iclass
3411 // that comes later in the chain. Skip this item so
3412 // prepended modules take precedence.
3413 continue;
3414 }
3415
3416 // Do lookup in original class or module in case we are at an origin
3417 // iclass in the chain.
3418 tmp = current;
3419 if (BUILTIN_TYPE(tmp) == T_ICLASS) tmp = RBASIC(tmp)->klass;
3420
3421 // Do the lookup. Loop in case of autoload.
3422 while ((ce = rb_const_lookup(tmp, id))) {
3423 if (visibility && RB_CONST_PRIVATE_P(ce)) {
3424 GET_EC()->private_const_reference = tmp;
3425 return Qundef;
3426 }
3427 rb_const_warn_if_deprecated(ce, tmp, id);
3428 value = ce->value;
3429 if (UNDEF_P(value)) {
3430 struct autoload_const *ac;
3431 if (am == tmp) break;
3432 am = tmp;
3433 ac = autoloading_const_entry(tmp, id);
3434 if (ac) {
3435 if (found_in) { *found_in = tmp; }
3436 return ac->value;
3437 }
3438 rb_autoload_load(tmp, id);
3439 continue;
3440 }
3441 if (exclude && tmp == rb_cObject) {
3442 goto not_found;
3443 }
3444 if (found_in) { *found_in = tmp; }
3445 return value;
3446 }
3447 if (!recurse) break;
3448 }
3449
3450 not_found:
3451 GET_EC()->private_const_reference = 0;
3452 return Qundef;
3453}
3454
3455static VALUE
3456rb_const_search(VALUE klass, ID id, int exclude, int recurse, int visibility, VALUE *found_in)
3457{
3458 VALUE value;
3459
3460 if (klass == rb_cObject) exclude = FALSE;
3461 value = rb_const_search_from(klass, id, exclude, recurse, visibility, found_in);
3462 if (!UNDEF_P(value)) return value;
3463 if (exclude) return value;
3464 if (BUILTIN_TYPE(klass) != T_MODULE) return value;
3465 /* search global const too, if klass is a module */
3466 return rb_const_search_from(rb_cObject, id, FALSE, recurse, visibility, found_in);
3467}
3468
3469VALUE
3471{
3472 return rb_const_get_0(klass, id, TRUE, TRUE, FALSE);
3473}
3474
3475VALUE
3477{
3478 return rb_const_get_0(klass, id, FALSE, TRUE, FALSE);
3479}
3480
3481VALUE
3483{
3484 return rb_const_get_0(klass, id, TRUE, FALSE, FALSE);
3485}
3486
3487VALUE
3488rb_public_const_get_from(VALUE klass, ID id)
3489{
3490 return rb_const_get_0(klass, id, TRUE, TRUE, TRUE);
3491}
3492
3493VALUE
3494rb_public_const_get_at(VALUE klass, ID id)
3495{
3496 return rb_const_get_0(klass, id, TRUE, FALSE, TRUE);
3497}
3498
3499NORETURN(static void undefined_constant(VALUE mod, VALUE name));
3500static void
3501undefined_constant(VALUE mod, VALUE name)
3502{
3503 rb_name_err_raise("constant %2$s::%1$s not defined",
3504 mod, name);
3505}
3506
3507static VALUE
3508rb_const_location_from(VALUE klass, ID id, int exclude, int recurse, int visibility)
3509{
3510 while (RTEST(klass)) {
3511 rb_const_entry_t *ce;
3512
3513 while ((ce = rb_const_lookup(klass, id))) {
3514 if (visibility && RB_CONST_PRIVATE_P(ce)) {
3515 return Qnil;
3516 }
3517 if (exclude && klass == rb_cObject) {
3518 goto not_found;
3519 }
3520
3521 if (UNDEF_P(ce->value)) { // autoload
3522 VALUE autoload_const_value = autoload_data(klass, id);
3523 if (RTEST(autoload_const_value)) {
3525 struct autoload_data *autoload_data = get_autoload_data(autoload_const_value, &autoload_const);
3526
3527 if (!UNDEF_P(autoload_const->value) && RTEST(rb_mutex_owned_p(autoload_data->mutex))) {
3528 return rb_assoc_new(autoload_const->file, INT2NUM(autoload_const->line));
3529 }
3530 }
3531 }
3532
3533 if (NIL_P(ce->file)) return rb_ary_new();
3534 return rb_assoc_new(ce->file, INT2NUM(ce->line));
3535 }
3536 if (!recurse) break;
3537 klass = RCLASS_SUPER(klass);
3538 }
3539
3540 not_found:
3541 return Qnil;
3542}
3543
3544static VALUE
3545rb_const_location(VALUE klass, ID id, int exclude, int recurse, int visibility)
3546{
3547 VALUE loc;
3548
3549 if (klass == rb_cObject) exclude = FALSE;
3550 loc = rb_const_location_from(klass, id, exclude, recurse, visibility);
3551 if (!NIL_P(loc)) return loc;
3552 if (exclude) return loc;
3553 if (BUILTIN_TYPE(klass) != T_MODULE) return loc;
3554 /* search global const too, if klass is a module */
3555 return rb_const_location_from(rb_cObject, id, FALSE, recurse, visibility);
3556}
3557
3558VALUE
3559rb_const_source_location(VALUE klass, ID id)
3560{
3561 return rb_const_location(klass, id, FALSE, TRUE, FALSE);
3562}
3563
3564VALUE
3565rb_const_source_location_at(VALUE klass, ID id)
3566{
3567 return rb_const_location(klass, id, TRUE, FALSE, FALSE);
3568}
3569
3570/*
3571 * call-seq:
3572 * remove_const(sym) -> obj
3573 *
3574 * Removes the definition of the given constant, returning that
3575 * constant's previous value. If that constant referred to
3576 * a module, this will not change that module's name and can lead
3577 * to confusion.
3578 */
3579
3580VALUE
3582{
3583 const ID id = id_for_var(mod, name, a, constant);
3584
3585 if (!id) {
3586 undefined_constant(mod, name);
3587 }
3588 return rb_const_remove(mod, id);
3589}
3590
3591static rb_const_entry_t * const_lookup(struct rb_id_table *tbl, ID id);
3592
3593VALUE
3595{
3596 VALUE val;
3597 rb_const_entry_t *ce;
3598
3599 rb_check_frozen(mod);
3600
3601 ce = rb_const_lookup(mod, id);
3602
3603 if (!ce) {
3604 if (rb_const_defined_at(mod, id)) {
3605 rb_name_err_raise("cannot remove %2$s::%1$s", mod, ID2SYM(id));
3606 }
3607
3608 undefined_constant(mod, ID2SYM(id));
3609 }
3610
3611 VALUE writable_ce = 0;
3612 if (rb_id_table_lookup(RCLASS_WRITABLE_CONST_TBL(mod), id, &writable_ce)) {
3613 rb_id_table_delete(RCLASS_WRITABLE_CONST_TBL(mod), id);
3614 if ((rb_const_entry_t *)writable_ce != ce) {
3615 SIZED_FREE((rb_const_entry_t *)writable_ce);
3616 }
3617 }
3618
3619 rb_const_warn_if_deprecated(ce, mod, id);
3621
3622 val = ce->value;
3623
3624 if (UNDEF_P(val)) {
3625 autoload_delete(mod, id);
3626 val = Qnil;
3627 }
3628
3629 if (ce != const_lookup(RCLASS_PRIME_CONST_TBL(mod), id)) {
3630 SIZED_FREE(ce);
3631 }
3632 // else - skip free'ing the ce because it still exists in the prime classext
3633
3634 return val;
3635}
3636
3637static int
3638cv_i_update(st_data_t *k, st_data_t *v, st_data_t a, int existing)
3639{
3640 if (existing) return ST_STOP;
3641 *v = a;
3642 return ST_CONTINUE;
3643}
3644
3645static enum rb_id_table_iterator_result
3646sv_i(ID key, VALUE v, void *a)
3647{
3649 st_table *tbl = a;
3650
3651 if (rb_is_const_id(key)) {
3652 st_update(tbl, (st_data_t)key, cv_i_update, (st_data_t)ce);
3653 }
3654 return ID_TABLE_CONTINUE;
3655}
3656
3657static enum rb_id_table_iterator_result
3658rb_local_constants_i(ID const_name, VALUE const_value, void *ary)
3659{
3660 if (rb_is_const_id(const_name) && !RB_CONST_PRIVATE_P((rb_const_entry_t *)const_value)) {
3661 rb_ary_push((VALUE)ary, ID2SYM(const_name));
3662 }
3663 return ID_TABLE_CONTINUE;
3664}
3665
3666static VALUE
3667rb_local_constants(VALUE mod)
3668{
3669 struct rb_id_table *tbl = RCLASS_CONST_TBL(mod);
3670 VALUE ary;
3671
3672 if (!tbl) return rb_ary_new2(0);
3673
3674 RB_VM_LOCKING() {
3675 ary = rb_ary_new2(rb_id_table_size(tbl));
3676 rb_id_table_foreach(tbl, rb_local_constants_i, (void *)ary);
3677 }
3678
3679 return ary;
3680}
3681
3682void*
3683rb_mod_const_at(VALUE mod, void *data)
3684{
3685 st_table *tbl = data;
3686 if (!tbl) {
3687 tbl = st_init_numtable();
3688 }
3689 if (RCLASS_CONST_TBL(mod)) {
3690 RB_VM_LOCKING() {
3691 rb_id_table_foreach(RCLASS_CONST_TBL(mod), sv_i, tbl);
3692 }
3693 }
3694 return tbl;
3695}
3696
3697void*
3698rb_mod_const_of(VALUE mod, void *data)
3699{
3700 VALUE tmp = mod;
3701 for (;;) {
3702 data = rb_mod_const_at(tmp, data);
3703 tmp = RCLASS_SUPER(tmp);
3704 if (!tmp) break;
3705 if (tmp == rb_cObject && mod != rb_cObject) break;
3706 }
3707 return data;
3708}
3709
3710static int
3711list_i(st_data_t key, st_data_t value, VALUE ary)
3712{
3713 ID sym = (ID)key;
3714 rb_const_entry_t *ce = (rb_const_entry_t *)value;
3715 if (RB_CONST_PUBLIC_P(ce)) rb_ary_push(ary, ID2SYM(sym));
3716 return ST_CONTINUE;
3717}
3718
3719VALUE
3720rb_const_list(void *data)
3721{
3722 st_table *tbl = data;
3723 VALUE ary;
3724
3725 if (!tbl) return rb_ary_new2(0);
3726 ary = rb_ary_new2(tbl->num_entries);
3727 st_foreach_safe(tbl, list_i, ary);
3728 st_free_table(tbl);
3729
3730 return ary;
3731}
3732
3733/*
3734 * call-seq:
3735 * mod.constants(inherit=true) -> array
3736 *
3737 * Returns an array of the names of the constants accessible in
3738 * <i>mod</i>. This includes the names of constants in any included
3739 * modules (example at start of section), unless the <i>inherit</i>
3740 * parameter is set to <code>false</code>.
3741 *
3742 * The implementation makes no guarantees about the order in which the
3743 * constants are yielded.
3744 *
3745 * IO.constants.include?(:SYNC) #=> true
3746 * IO.constants(false).include?(:SYNC) #=> false
3747 *
3748 * Also see Module#const_defined?.
3749 */
3750
3751VALUE
3752rb_mod_constants(int argc, const VALUE *argv, VALUE mod)
3753{
3754 bool inherit = true;
3755
3756 if (rb_check_arity(argc, 0, 1)) inherit = RTEST(argv[0]);
3757
3758 if (inherit) {
3759 return rb_const_list(rb_mod_const_of(mod, 0));
3760 }
3761 else {
3762 return rb_local_constants(mod);
3763 }
3764}
3765
3766static int
3767rb_const_defined_0(VALUE klass, ID id, int exclude, int recurse, int visibility)
3768{
3769 VALUE tmp;
3770 int mod_retry = 0;
3771 rb_const_entry_t *ce;
3772
3773 tmp = klass;
3774 retry:
3775 while (tmp) {
3776 if ((ce = rb_const_lookup(tmp, id))) {
3777 if (visibility && RB_CONST_PRIVATE_P(ce)) {
3778 return (int)Qfalse;
3779 }
3780 if (UNDEF_P(ce->value) && !check_autoload_required(tmp, id, 0) &&
3781 !rb_autoloading_value(tmp, id, NULL, NULL))
3782 return (int)Qfalse;
3783
3784 if (exclude && tmp == rb_cObject && klass != rb_cObject) {
3785 return (int)Qfalse;
3786 }
3787
3788 return (int)Qtrue;
3789 }
3790 if (!recurse) break;
3791 tmp = RCLASS_SUPER(tmp);
3792 }
3793 if (!exclude && !mod_retry && BUILTIN_TYPE(klass) == T_MODULE) {
3794 mod_retry = 1;
3795 tmp = rb_cObject;
3796 goto retry;
3797 }
3798 return (int)Qfalse;
3799}
3800
3801int
3803{
3804 return rb_const_defined_0(klass, id, TRUE, TRUE, FALSE);
3805}
3806
3807int
3809{
3810 return rb_const_defined_0(klass, id, FALSE, TRUE, FALSE);
3811}
3812
3813int
3815{
3816 return rb_const_defined_0(klass, id, TRUE, FALSE, FALSE);
3817}
3818
3819int
3820rb_public_const_defined_from(VALUE klass, ID id)
3821{
3822 return rb_const_defined_0(klass, id, TRUE, TRUE, TRUE);
3823}
3824
3825static void
3826check_before_mod_set(VALUE klass, ID id, VALUE val, const char *dest)
3827{
3828 rb_check_frozen(klass);
3829}
3830
3831static void set_namespace_path(VALUE named_namespace, VALUE name);
3832
3833static enum rb_id_table_iterator_result
3834set_namespace_path_i(ID id, VALUE v, void *payload)
3835{
3837 VALUE value = ce->value;
3838 VALUE parental_path = *((VALUE *) payload);
3839 if (!rb_is_const_id(id) || !rb_namespace_p(value)) {
3840 return ID_TABLE_CONTINUE;
3841 }
3842
3843 bool has_permanent_classpath;
3844 classname(value, &has_permanent_classpath);
3845 if (has_permanent_classpath) {
3846 return ID_TABLE_CONTINUE;
3847 }
3848 set_namespace_path(value, build_const_path(parental_path, id));
3849
3850 if (!RCLASS_PERMANENT_CLASSPATH_P(value)) {
3851 RCLASS_WRITE_CLASSPATH(value, 0, false);
3852 }
3853
3854 return ID_TABLE_CONTINUE;
3855}
3856
3857/*
3858 * Assign permanent classpaths to all namespaces that are directly or indirectly
3859 * nested under +named_namespace+. +named_namespace+ must have a permanent
3860 * classpath.
3861 */
3862static void
3863set_namespace_path(VALUE named_namespace, VALUE namespace_path)
3864{
3865 struct rb_id_table *const_table = RCLASS_CONST_TBL(named_namespace);
3866 RB_OBJ_SET_SHAREABLE(namespace_path);
3867
3868 RB_VM_LOCKING() {
3869 RCLASS_WRITE_CLASSPATH(named_namespace, namespace_path, true);
3870
3871 if (const_table) {
3872 rb_id_table_foreach(const_table, set_namespace_path_i, &namespace_path);
3873 }
3874 }
3875}
3876
3877static void
3878const_added(VALUE klass, ID const_name)
3879{
3880 if (GET_VM()->running) {
3881 VALUE name = ID2SYM(const_name);
3882 rb_funcallv(klass, idConst_added, 1, &name);
3883 }
3884}
3885
3886static void
3887const_set(VALUE klass, ID id, VALUE val)
3888{
3889 rb_const_entry_t *ce;
3890
3891 if (NIL_P(klass)) {
3892 rb_raise(rb_eTypeError, "no class/module to define constant %"PRIsVALUE"",
3893 QUOTE_ID(id));
3894 }
3895
3896 if (!rb_ractor_main_p() && !rb_ractor_shareable_p(val)) {
3897 rb_raise(rb_eRactorIsolationError, "can not set constants with non-shareable objects by non-main Ractors");
3898 }
3899
3900 check_before_mod_set(klass, id, val, "constant");
3901
3902 RB_VM_LOCKING() {
3903 struct rb_id_table *tbl = RCLASS_WRITABLE_CONST_TBL(klass);
3904 if (!tbl) {
3905 tbl = rb_id_table_create(0);
3906 RCLASS_WRITE_CONST_TBL(klass, tbl, false);
3909 rb_id_table_insert(tbl, id, (VALUE)ce);
3910 setup_const_entry(ce, klass, val, CONST_PUBLIC);
3911 }
3912 else {
3913 struct autoload_const ac = {
3914 .module = klass, .name = id,
3915 .value = val, .flag = CONST_PUBLIC,
3916 /* fill the rest with 0 */
3917 };
3918 ac.file = rb_source_location(&ac.line);
3919 const_tbl_update(&ac, false);
3920 }
3921 }
3922
3923 /*
3924 * Resolve and cache class name immediately to resolve ambiguity
3925 * and avoid order-dependency on const_tbl
3926 */
3927 if (rb_cObject && rb_namespace_p(val)) {
3928 bool val_path_permanent;
3929 VALUE val_path = classname(val, &val_path_permanent);
3930 if (NIL_P(val_path) || !val_path_permanent) {
3931 if (klass == rb_cObject) {
3932 set_namespace_path(val, rb_id2str(id));
3933 }
3934 else {
3935 bool parental_path_permanent;
3936 VALUE parental_path = classname(klass, &parental_path_permanent);
3937 if (NIL_P(parental_path)) {
3938 bool throwaway;
3939 parental_path = rb_tmp_class_path(klass, &throwaway, make_temporary_path);
3940 }
3941 if (parental_path_permanent && !val_path_permanent) {
3942 set_namespace_path(val, build_const_path(parental_path, id));
3943 }
3944 else if (!parental_path_permanent && NIL_P(val_path)) {
3945 VALUE path = build_const_path(parental_path, id);
3946 RCLASS_SET_CLASSPATH(val, path, false);
3947 }
3948 }
3949 }
3950 }
3951}
3952
3953void
3955{
3956 const_set(klass, id, val);
3957 const_added(klass, id);
3958}
3959
3960static VALUE
3961autoload_const_value_for_named_constant(VALUE module, ID name, struct autoload_const **autoload_const_pointer)
3962{
3963 VALUE autoload_const_value = autoload_data(module, name);
3964 if (!autoload_const_value) return Qfalse;
3965
3966 struct autoload_data *autoload_data = get_autoload_data(autoload_const_value, autoload_const_pointer);
3967 if (!autoload_data) return Qfalse;
3968
3969 /* for autoloading thread, keep the defined value to autoloading storage */
3970 if (autoload_by_current(autoload_data)) {
3971 return autoload_const_value;
3972 }
3973
3974 return Qfalse;
3975}
3976
3977static void
3978const_tbl_update(struct autoload_const *ac, int autoload_force)
3979{
3980 VALUE value;
3981 VALUE klass = ac->module;
3982 VALUE val = ac->value;
3983 ID id = ac->name;
3984 struct rb_id_table *tbl = RCLASS_CONST_TBL(klass);
3985 rb_const_flag_t visibility = ac->flag;
3986 rb_const_entry_t *ce;
3987
3988 if (rb_id_table_lookup(tbl, id, &value)) {
3989 ce = (rb_const_entry_t *)value;
3990 if (UNDEF_P(ce->value)) {
3991 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
3992 VALUE file = ac->file;
3993 int line = ac->line;
3994 VALUE autoload_const_value = autoload_const_value_for_named_constant(klass, id, &ac);
3995
3996 if (!autoload_force && autoload_const_value) {
3998
3999 RB_OBJ_WRITE(autoload_const_value, &ac->value, val);
4000 RB_OBJ_WRITE(autoload_const_value, &ac->file, rb_source_location(&ac->line));
4001 }
4002 else {
4003 /* otherwise autoloaded constant, allow to override */
4004 autoload_delete(klass, id);
4005 ce->flag = visibility;
4006 RB_OBJ_WRITE(klass, &ce->value, val);
4007 RB_OBJ_WRITE(klass, &ce->file, file);
4008 ce->line = line;
4009 }
4010 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
4011 return;
4012 }
4013 else {
4014 VALUE name = QUOTE_ID(id);
4015 visibility = ce->flag;
4016
4017 VALUE previous = Qnil;
4018 if (!NIL_P(ce->file) && ce->line) {
4019 previous = rb_sprintf("\n%"PRIsVALUE":%d: warning: previous definition of %"PRIsVALUE" was here", ce->file, ce->line, name);
4020 }
4021
4022 if (klass == rb_cObject)
4023 rb_warn("already initialized constant %"PRIsVALUE"%"PRIsVALUE"", name, previous);
4024 else
4025 rb_warn("already initialized constant %"PRIsVALUE"::%"PRIsVALUE"%"PRIsVALUE"",
4026 rb_class_name(klass), name, previous);
4027 }
4029 setup_const_entry(ce, klass, val, visibility);
4030 }
4031 else {
4032 tbl = RCLASS_WRITABLE_CONST_TBL(klass);
4034
4036 rb_id_table_insert(tbl, id, (VALUE)ce);
4037 setup_const_entry(ce, klass, val, visibility);
4038 }
4039}
4040
4041static void
4042setup_const_entry(rb_const_entry_t *ce, VALUE klass, VALUE val,
4043 rb_const_flag_t visibility)
4044{
4045 ce->flag = visibility;
4046 RB_OBJ_WRITE(klass, &ce->value, val);
4047 RB_OBJ_WRITE(klass, &ce->file, rb_source_location(&ce->line));
4048}
4049
4050void
4051rb_define_const(VALUE klass, const char *name, VALUE val)
4052{
4053 ID id = rb_intern(name);
4054
4055 if (!rb_is_const_id(id)) {
4056 rb_warn("rb_define_const: invalid name '%s' for constant", name);
4057 }
4058 if (!RB_SPECIAL_CONST_P(val)) {
4059 rb_vm_register_global_object(val);
4060 }
4061 rb_const_set(klass, id, val);
4062}
4063
4064void
4065rb_define_global_const(const char *name, VALUE val)
4066{
4067 rb_define_const(rb_cObject, name, val);
4068}
4069
4070static void
4071set_const_visibility(VALUE mod, int argc, const VALUE *argv,
4072 rb_const_flag_t flag, rb_const_flag_t mask)
4073{
4074 int i;
4075 rb_const_entry_t *ce;
4076 ID id;
4077
4079 if (argc == 0) {
4080 rb_warning("%"PRIsVALUE" with no argument is just ignored",
4081 QUOTE_ID(rb_frame_callee()));
4082 return;
4083 }
4084
4085 for (i = 0; i < argc; i++) {
4086 struct autoload_const *ac;
4087 VALUE val = argv[i];
4088 id = rb_check_id(&val);
4089 if (!id) {
4090 undefined_constant(mod, val);
4091 }
4092 if ((ce = rb_const_lookup(mod, id))) {
4093 ce->flag &= ~mask;
4094 ce->flag |= flag;
4095 if (UNDEF_P(ce->value)) {
4096 if (autoload_const_value_for_named_constant(mod, id, &ac)) {
4097 ac->flag &= ~mask;
4098 ac->flag |= flag;
4099 }
4100 }
4102 }
4103 else {
4104 undefined_constant(mod, ID2SYM(id));
4105 }
4106 }
4107}
4108
4109void
4110rb_deprecate_constant(VALUE mod, const char *name)
4111{
4112 rb_const_entry_t *ce;
4113 ID id;
4114 long len = strlen(name);
4115
4117 if (!(id = rb_check_id_cstr(name, len, NULL))) {
4118 undefined_constant(mod, rb_fstring_new(name, len));
4119 }
4120 if (!(ce = rb_const_lookup(mod, id))) {
4121 undefined_constant(mod, ID2SYM(id));
4122 }
4123 ce->flag |= CONST_DEPRECATED;
4124}
4125
4126/*
4127 * call-seq:
4128 * mod.private_constant(symbol, ...) => mod
4129 *
4130 * Makes a list of existing constants private.
4131 */
4132
4133VALUE
4134rb_mod_private_constant(int argc, const VALUE *argv, VALUE obj)
4135{
4136 set_const_visibility(obj, argc, argv, CONST_PRIVATE, CONST_VISIBILITY_MASK);
4137 return obj;
4138}
4139
4140/*
4141 * call-seq:
4142 * mod.public_constant(symbol, ...) => mod
4143 *
4144 * Makes a list of existing constants public.
4145 */
4146
4147VALUE
4148rb_mod_public_constant(int argc, const VALUE *argv, VALUE obj)
4149{
4150 set_const_visibility(obj, argc, argv, CONST_PUBLIC, CONST_VISIBILITY_MASK);
4151 return obj;
4152}
4153
4154/*
4155 * call-seq:
4156 * mod.deprecate_constant(symbol, ...) => mod
4157 *
4158 * Makes a list of existing constants deprecated. Attempt
4159 * to refer to them will produce a warning.
4160 *
4161 * module HTTP
4162 * NotFound = Exception.new
4163 * NOT_FOUND = NotFound # previous version of the library used this name
4164 *
4165 * deprecate_constant :NOT_FOUND
4166 * end
4167 *
4168 * HTTP::NOT_FOUND
4169 * # warning: constant HTTP::NOT_FOUND is deprecated
4170 *
4171 */
4172
4173VALUE
4174rb_mod_deprecate_constant(int argc, const VALUE *argv, VALUE obj)
4175{
4176 set_const_visibility(obj, argc, argv, CONST_DEPRECATED, CONST_DEPRECATED);
4177 return obj;
4178}
4179
4180static VALUE
4181original_module(VALUE c)
4182{
4183 if (RB_TYPE_P(c, T_ICLASS))
4184 return RBASIC(c)->klass;
4185 return c;
4186}
4187
4188static int
4189cvar_lookup_at(VALUE klass, ID id, st_data_t *v)
4190{
4191 if (RB_TYPE_P(klass, T_ICLASS)) {
4192 if (RICLASS_IS_ORIGIN_P(klass)) {
4193 return 0;
4194 }
4195 else {
4196 // check the original module
4197 klass = RBASIC(klass)->klass;
4198 }
4199 }
4200
4201 VALUE n = rb_ivar_lookup(klass, id, Qundef);
4202 if (UNDEF_P(n)) return 0;
4203
4204 if (v) *v = n;
4205 return 1;
4206}
4207
4208static VALUE
4209cvar_front_klass(VALUE klass)
4210{
4211 if (RCLASS_SINGLETON_P(klass)) {
4212 VALUE obj = RCLASS_ATTACHED_OBJECT(klass);
4213 if (rb_namespace_p(obj)) {
4214 return obj;
4215 }
4216 }
4217 return RCLASS_SUPER(klass);
4218}
4219
4220static void
4221cvar_overtaken(VALUE front, VALUE target, ID id)
4222{
4223 if (front && target != front) {
4224 if (original_module(front) != original_module(target)) {
4225 rb_raise(rb_eRuntimeError,
4226 "class variable % "PRIsVALUE" of %"PRIsVALUE" is overtaken by %"PRIsVALUE"",
4227 ID2SYM(id), rb_class_name(original_module(front)),
4228 rb_class_name(original_module(target)));
4229 }
4230 if (BUILTIN_TYPE(front) == T_CLASS) {
4231 rb_ivar_delete(front, id, Qundef);
4232 }
4233 }
4234}
4235
4236#define CVAR_FOREACH_ANCESTORS(klass, v, r) \
4237 for (klass = cvar_front_klass(klass); klass; klass = RCLASS_SUPER(klass)) { \
4238 if (cvar_lookup_at(klass, id, (v))) { \
4239 r; \
4240 } \
4241 }
4242
4243#define CVAR_LOOKUP(v,r) do {\
4244 if (cvar_lookup_at(klass, id, (v))) {r;}\
4245 CVAR_FOREACH_ANCESTORS(klass, v, r);\
4246} while(0)
4247
4248static VALUE
4249find_cvar(VALUE klass, VALUE * front, VALUE * target, ID id)
4250{
4251 VALUE v = Qundef;
4252 CVAR_LOOKUP(&v, {
4253 if (!*front) {
4254 *front = klass;
4255 }
4256 *target = klass;
4257 });
4258
4259 return v;
4260}
4261
4262void
4263rb_cvar_set(VALUE klass, ID id, VALUE val)
4264{
4265 CVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(klass, id);
4266
4267 VALUE tmp, front = 0, target = 0;
4268
4269 tmp = klass;
4270 CVAR_LOOKUP(0, {if (!front) front = klass; target = klass;});
4271 if (target) {
4272 cvar_overtaken(front, target, id);
4273 }
4274 else {
4275 target = tmp;
4276 }
4277
4278 if (RB_TYPE_P(target, T_ICLASS)) {
4279 target = RBASIC(target)->klass;
4280 }
4281 check_before_mod_set(target, id, val, "class variable");
4282
4283 bool new_cvar = rb_class_ivar_set(target, id, val);
4284
4285 struct rb_id_table *rb_cvc_tbl = RCLASS_WRITABLE_CVC_TBL(target);
4286
4287 if (!rb_cvc_tbl) {
4288 rb_cvc_tbl = rb_id_table_create(2);
4289 RCLASS_WRITE_CVC_TBL(target, rb_cvc_tbl);
4290 }
4291
4292 struct rb_cvar_class_tbl_entry *ent;
4293 VALUE ent_data;
4294
4295 if (!rb_id_table_lookup(rb_cvc_tbl, id, &ent_data)) {
4296 ent = ALLOC(struct rb_cvar_class_tbl_entry);
4297 ent->class_value = target;
4298 ent->global_cvar_state = GET_GLOBAL_CVAR_STATE();
4299 ent->cref = 0;
4300 rb_id_table_insert(rb_cvc_tbl, id, (VALUE)ent);
4301 RB_DEBUG_COUNTER_INC(cvar_inline_miss);
4302 }
4303 else {
4304 ent = (void *)ent_data;
4305 ent->global_cvar_state = GET_GLOBAL_CVAR_STATE();
4306 }
4307
4308 // Break the cvar cache if this is a new class variable.
4309 // Existing caches may have resolved this name to a different
4310 // location in the hierarchy, so we must invalidate globally.
4311 if (new_cvar) {
4312 ruby_vm_global_cvar_state++;
4313 }
4314}
4315
4316VALUE
4317rb_cvar_find(VALUE klass, ID id, VALUE *front)
4318{
4319 VALUE target = 0;
4320 VALUE value;
4321
4322 value = find_cvar(klass, front, &target, id);
4323 if (!target) {
4324 rb_name_err_raise("uninitialized class variable %1$s in %2$s",
4325 klass, ID2SYM(id));
4326 }
4327 cvar_overtaken(*front, target, id);
4328 cvar_read_ractor_check(klass, id, value);
4329 return (VALUE)value;
4330}
4331
4332VALUE
4334{
4335 VALUE front = 0;
4336 return rb_cvar_find(klass, id, &front);
4337}
4338
4339VALUE
4341{
4342 if (!klass) return Qfalse;
4343 CVAR_LOOKUP(0,return Qtrue);
4344 return Qfalse;
4345}
4346
4347static ID
4348cv_intern(VALUE klass, const char *name)
4349{
4350 ID id = rb_intern(name);
4351 if (!rb_is_class_id(id)) {
4352 rb_name_err_raise("wrong class variable name %1$s",
4353 klass, rb_str_new_cstr(name));
4354 }
4355 return id;
4356}
4357
4358void
4359rb_cv_set(VALUE klass, const char *name, VALUE val)
4360{
4361 ID id = cv_intern(klass, name);
4362 rb_cvar_set(klass, id, val);
4363}
4364
4365VALUE
4366rb_cv_get(VALUE klass, const char *name)
4367{
4368 ID id = cv_intern(klass, name);
4369 return rb_cvar_get(klass, id);
4370}
4371
4372void
4373rb_define_class_variable(VALUE klass, const char *name, VALUE val)
4374{
4375 rb_cv_set(klass, name, val);
4376}
4377
4378static int
4379cv_i(ID key, VALUE v, st_data_t a)
4380{
4381 st_table *tbl = (st_table *)a;
4382
4383 if (rb_is_class_id(key)) {
4384 st_update(tbl, (st_data_t)key, cv_i_update, 0);
4385 }
4386 return ST_CONTINUE;
4387}
4388
4389static void*
4390mod_cvar_at(VALUE mod, void *data)
4391{
4392 st_table *tbl = data;
4393 if (!tbl) {
4394 tbl = st_init_numtable();
4395 }
4396 mod = original_module(mod);
4397
4398 rb_ivar_foreach(mod, cv_i, (st_data_t)tbl);
4399 return tbl;
4400}
4401
4402static void*
4403mod_cvar_of(VALUE mod, void *data)
4404{
4405 VALUE tmp = mod;
4406 if (RCLASS_SINGLETON_P(mod)) {
4407 if (rb_namespace_p(RCLASS_ATTACHED_OBJECT(mod))) {
4408 data = mod_cvar_at(tmp, data);
4409 tmp = cvar_front_klass(tmp);
4410 }
4411 }
4412 for (;;) {
4413 data = mod_cvar_at(tmp, data);
4414 tmp = RCLASS_SUPER(tmp);
4415 if (!tmp) break;
4416 }
4417 return data;
4418}
4419
4420static int
4421cv_list_i(st_data_t key, st_data_t value, VALUE ary)
4422{
4423 ID sym = (ID)key;
4424 rb_ary_push(ary, ID2SYM(sym));
4425 return ST_CONTINUE;
4426}
4427
4428static VALUE
4429cvar_list(void *data)
4430{
4431 st_table *tbl = data;
4432 VALUE ary;
4433
4434 if (!tbl) return rb_ary_new2(0);
4435 ary = rb_ary_new2(tbl->num_entries);
4436 st_foreach_safe(tbl, cv_list_i, ary);
4437 st_free_table(tbl);
4438
4439 return ary;
4440}
4441
4442/*
4443 * call-seq:
4444 * mod.class_variables(inherit=true) -> array
4445 *
4446 * Returns an array of the names of class variables in <i>mod</i>.
4447 * This includes the names of class variables in any included
4448 * modules, unless the <i>inherit</i> parameter is set to
4449 * <code>false</code>.
4450 *
4451 * class One
4452 * @@var1 = 1
4453 * end
4454 * class Two < One
4455 * @@var2 = 2
4456 * end
4457 * One.class_variables #=> [:@@var1]
4458 * Two.class_variables #=> [:@@var2, :@@var1]
4459 * Two.class_variables(false) #=> [:@@var2]
4460 */
4461
4462VALUE
4463rb_mod_class_variables(int argc, const VALUE *argv, VALUE mod)
4464{
4465 bool inherit = true;
4466 st_table *tbl;
4467
4468 if (rb_check_arity(argc, 0, 1)) inherit = RTEST(argv[0]);
4469 if (inherit) {
4470 tbl = mod_cvar_of(mod, 0);
4471 }
4472 else {
4473 tbl = mod_cvar_at(mod, 0);
4474 }
4475 return cvar_list(tbl);
4476}
4477
4478/*
4479 * call-seq:
4480 * remove_class_variable(sym) -> obj
4481 *
4482 * Removes the named class variable from the receiver, returning that
4483 * variable's value.
4484 *
4485 * class Example
4486 * @@var = 99
4487 * puts remove_class_variable(:@@var)
4488 * p(defined? @@var)
4489 * end
4490 *
4491 * <em>produces:</em>
4492 *
4493 * 99
4494 * nil
4495 */
4496
4497VALUE
4499{
4500 const ID id = id_for_var_message(mod, name, class, "wrong class variable name %1$s");
4501 st_data_t val;
4502
4503 if (!id) {
4504 goto not_defined;
4505 }
4506 rb_check_frozen(mod);
4507 val = rb_ivar_delete(mod, id, Qundef);
4508 if (!UNDEF_P(val)) {
4509 return (VALUE)val;
4510 }
4511 if (rb_cvar_defined(mod, id)) {
4512 rb_name_err_raise("cannot remove %1$s for %2$s", mod, ID2SYM(id));
4513 }
4514 not_defined:
4515 rb_name_err_raise("class variable %1$s not defined for %2$s",
4516 mod, name);
4518}
4519
4520VALUE
4521rb_iv_get(VALUE obj, const char *name)
4522{
4523 ID id = rb_check_id_cstr(name, strlen(name), rb_usascii_encoding());
4524
4525 if (!id) {
4526 return Qnil;
4527 }
4528 return rb_ivar_get(obj, id);
4529}
4530
4531VALUE
4532rb_iv_set(VALUE obj, const char *name, VALUE val)
4533{
4534 ID id = rb_intern(name);
4535
4536 return rb_ivar_set(obj, id, val);
4537}
4538
4539static attr_index_t
4540class_fields_ivar_set(VALUE klass, VALUE fields_obj, ID id, VALUE val, bool concurrent, VALUE *new_fields_obj, bool *new_ivar_out)
4541{
4542 const VALUE original_fields_obj = fields_obj;
4543 fields_obj = original_fields_obj ? original_fields_obj : rb_imemo_fields_new(klass, 1, true);
4544
4545 shape_id_t current_shape_id = RBASIC_SHAPE_ID(fields_obj);
4546 shape_id_t next_shape_id = current_shape_id; // for too_complex
4547 if (UNLIKELY(rb_shape_too_complex_p(current_shape_id))) {
4548 goto too_complex;
4549 }
4550
4551 bool new_ivar;
4552 next_shape_id = generic_shape_ivar(fields_obj, id, &new_ivar);
4553
4554 if (UNLIKELY(rb_shape_too_complex_p(next_shape_id))) {
4555 fields_obj = imemo_fields_complex_from_obj(klass, fields_obj, next_shape_id);
4556 goto too_complex;
4557 }
4558
4559 attr_index_t index = RSHAPE_INDEX(next_shape_id);
4560 if (new_ivar) {
4561 if (index >= RSHAPE_CAPACITY(current_shape_id)) {
4562 // We allocate a new fields_obj even when concurrency isn't a concern
4563 // so that we're embedded as long as possible.
4564 fields_obj = imemo_fields_copy_capa(klass, fields_obj, RSHAPE_CAPACITY(next_shape_id));
4565 }
4566 }
4567
4568 VALUE *fields = rb_imemo_fields_ptr(fields_obj);
4569
4570 if (concurrent && original_fields_obj == fields_obj) {
4571 // In the concurrent case, if we're mutating the existing
4572 // fields_obj, we must use an atomic write, because if we're
4573 // adding a new field, the shape_id must be written after the field
4574 // and if we're updating an existing field, we at least need a relaxed
4575 // write to avoid reaping.
4576 RB_OBJ_ATOMIC_WRITE(fields_obj, &fields[index], val);
4577 }
4578 else {
4579 RB_OBJ_WRITE(fields_obj, &fields[index], val);
4580 }
4581
4582 if (new_ivar) {
4583 RBASIC_SET_SHAPE_ID(fields_obj, next_shape_id);
4584 }
4585
4586 *new_fields_obj = fields_obj;
4587 *new_ivar_out = new_ivar;
4588 return index;
4589
4590too_complex:
4591 {
4592 if (concurrent && fields_obj == original_fields_obj) {
4593 // In multi-ractor case, we must always work on a copy because
4594 // even if the field already exist, inserting in a st_table may
4595 // cause a rebuild.
4596 fields_obj = rb_imemo_fields_clone(fields_obj);
4597 }
4598
4599 st_table *table = rb_imemo_fields_complex_tbl(fields_obj);
4600 new_ivar = !st_insert(table, (st_data_t)id, (st_data_t)val);
4601 RB_OBJ_WRITTEN(fields_obj, Qundef, val);
4602
4603 if (fields_obj != original_fields_obj) {
4604 RBASIC_SET_SHAPE_ID(fields_obj, next_shape_id);
4605 }
4606 }
4607
4608 *new_fields_obj = fields_obj;
4609 *new_ivar_out = new_ivar;
4610 return ATTR_INDEX_NOT_SET;
4611}
4612
4613static attr_index_t
4614class_ivar_set(VALUE obj, ID id, VALUE val, bool *new_ivar)
4615{
4616 rb_class_ensure_writable(obj);
4617
4618 const VALUE original_fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
4619 VALUE new_fields_obj = 0;
4620
4621 attr_index_t index = class_fields_ivar_set(obj, original_fields_obj, id, val, rb_multi_ractor_p(), &new_fields_obj, new_ivar);
4622
4623 if (new_fields_obj != original_fields_obj) {
4624 RCLASS_WRITABLE_SET_FIELDS_OBJ(obj, new_fields_obj);
4625 }
4626
4627 // TODO: What should we set as the T_CLASS shape_id?
4628 // In most case we can replicate the single `fields_obj` shape
4629 // but in namespaced case? Perhaps INVALID_SHAPE_ID?
4630 RBASIC_SET_SHAPE_ID(obj, RBASIC_SHAPE_ID(new_fields_obj));
4631 return index;
4632}
4633
4634bool
4635rb_class_ivar_set(VALUE obj, ID id, VALUE val)
4636{
4638 rb_check_frozen(obj);
4639
4640 bool new_ivar;
4641 class_ivar_set(obj, id, val, &new_ivar);
4642 return new_ivar;
4643}
4644
4645void
4646rb_fields_tbl_copy(VALUE dst, VALUE src)
4647{
4648 RUBY_ASSERT(rb_type(dst) == rb_type(src));
4650 RUBY_ASSERT(RSHAPE_TYPE_P(RBASIC_SHAPE_ID(dst), SHAPE_ROOT));
4651
4652 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(src);
4653 if (fields_obj) {
4654 RCLASS_WRITABLE_SET_FIELDS_OBJ(dst, rb_imemo_fields_clone(fields_obj));
4655 RBASIC_SET_SHAPE_ID(dst, RBASIC_SHAPE_ID(src));
4656 }
4657}
4658
4659static rb_const_entry_t *
4660const_lookup(struct rb_id_table *tbl, ID id)
4661{
4662 if (tbl) {
4663 VALUE val;
4664 bool r;
4665 RB_VM_LOCKING() {
4666 r = rb_id_table_lookup(tbl, id, &val);
4667 }
4668
4669 if (r) return (rb_const_entry_t *)val;
4670 }
4671 return NULL;
4672}
4673
4675rb_const_lookup(VALUE klass, ID id)
4676{
4677 return const_lookup(RCLASS_CONST_TBL(klass), id);
4678}
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
#define RUBY_EXTERN
Declaration of externally visible global variables.
Definition dllexport.h:45
static VALUE RB_OBJ_FROZEN_RAW(VALUE obj)
This is an implementation detail of RB_OBJ_FROZEN().
Definition fl_type.h:696
static bool RB_FL_ABLE(VALUE obj)
Checks if the object is flaggable.
Definition fl_type.h:381
static void RB_FL_SET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_SET().
Definition fl_type.h:541
void rb_obj_freeze_inline(VALUE obj)
Prevents further modifications to the given object.
Definition variable.c:2008
static void RB_FL_UNSET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_UNSET().
Definition fl_type.h:601
@ RUBY_FL_FREEZE
This flag has something to do with data immutability.
Definition fl_type.h:278
void rb_class_modify_check(VALUE klass)
Asserts that klass is not a frozen class.
Definition eval.c:429
void rb_freeze_singleton_class(VALUE attached_object)
This is an implementation detail of RB_OBJ_FREEZE().
Definition class.c:2813
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.
Definition class.c:3183
#define rb_str_new2
Old name of rb_str_new_cstr.
Definition string.h:1676
#define TYPE(_)
Old name of rb_type.
Definition value_type.h:108
#define FL_UNSET_RAW
Old name of RB_FL_UNSET_RAW.
Definition fl_type.h:130
#define FL_USER3
Old name of RUBY_FL_USER3.
Definition fl_type.h:72
#define ALLOC
Old name of RB_ALLOC.
Definition memory.h:400
#define T_STRING
Old name of RUBY_T_STRING.
Definition value_type.h:78
#define Qundef
Old name of RUBY_Qundef.
#define rb_str_cat2
Old name of rb_str_cat_cstr.
Definition string.h:1684
#define UNREACHABLE
Old name of RBIMPL_UNREACHABLE.
Definition assume.h:28
#define T_IMEMO
Old name of RUBY_T_IMEMO.
Definition value_type.h:67
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define T_STRUCT
Old name of RUBY_T_STRUCT.
Definition value_type.h:79
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
Definition fl_type.h:131
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
Definition assume.h:29
#define T_DATA
Old name of RUBY_T_DATA.
Definition value_type.h:60
#define ZALLOC
Old name of RB_ZALLOC.
Definition memory.h:402
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:205
#define T_MODULE
Old name of RUBY_T_MODULE.
Definition value_type.h:70
#define T_ICLASS
Old name of RUBY_T_ICLASS.
Definition value_type.h:66
#define ALLOC_N
Old name of RB_ALLOC_N.
Definition memory.h:399
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition fl_type.h:128
#define rb_ary_new3
Old name of rb_ary_new_from_args.
Definition array.h:658
#define FL_USER2
Old name of RUBY_FL_USER2.
Definition fl_type.h:71
#define Qtrue
Old name of RUBY_Qtrue.
#define INT2NUM
Old name of RB_INT2NUM.
Definition int.h:43
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_OBJECT
Old name of RUBY_T_OBJECT.
Definition value_type.h:75
#define NIL_P
Old name of RB_NIL_P.
#define ALLOCV_N
Old name of RB_ALLOCV_N.
Definition memory.h:405
#define T_CLASS
Old name of RUBY_T_CLASS.
Definition value_type.h:58
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition value_type.h:85
#define rb_ary_new2
Old name of rb_ary_new_capa.
Definition array.h:657
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
Definition fl_type.h:126
#define ALLOCV_END
Old name of RB_ALLOCV_END.
Definition memory.h:406
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:477
void rb_name_error(ID id, const char *fmt,...)
Raises an instance of rb_eNameError.
Definition error.c:2341
VALUE rb_eTypeError
TypeError exception.
Definition error.c:1427
void rb_name_error_str(VALUE str, const char *fmt,...)
Identical to rb_name_error(), except it takes a VALUE instead of ID.
Definition error.c:2356
VALUE rb_eNameError
NameError exception.
Definition error.c:1432
VALUE rb_eRuntimeError
RuntimeError exception.
Definition error.c:1425
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.
Definition error.c:1413
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:467
void rb_warning(const char *fmt,...)
Issues a warning.
Definition error.c:498
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
Definition error.h:48
VALUE rb_cObject
Object class.
Definition object.c:61
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
Definition object.c:95
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:235
VALUE rb_cModule
Module class.
Definition object.c:62
VALUE rb_class_real(VALUE klass)
Finds a "real" class.
Definition object.c:226
#define RB_OBJ_WRITTEN(old, oldv, young)
Identical to RB_OBJ_WRITE(), except it doesn't write any values, but only a WB declaration.
Definition gc.h:615
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Definition gc.h:603
Encoding relates APIs.
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.
Definition symbol.c:1254
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
Definition vm_eval.c:1120
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_ary_new_capa(long capa)
Identical to rb_ary_new(), except it additionally specifies how many rooms of objects it should alloc...
VALUE rb_ary_hidden_new(long capa)
Allocates a hidden (no class) empty array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
VALUE rb_assoc_new(VALUE car, VALUE cdr)
Identical to rb_ary_new_from_values(), except it expects exactly two parameters.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
Definition error.h:284
#define st_foreach_safe
Just another name of rb_st_foreach_safe.
Definition hash.h:51
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...
Definition load.c:666
VALUE rb_backref_get(void)
Queries the last match, or Regexp.last_match, or the $~.
Definition vm.c:2042
int rb_is_instance_id(ID id)
Classifies the given ID, then sees if it is an instance variable.
Definition symbol.c:1128
int rb_is_const_id(ID id)
Classifies the given ID, then sees if it is a constant.
Definition symbol.c:1110
int rb_is_class_id(ID id)
Classifies the given ID, then sees if it is a class variable.
Definition symbol.c:1116
VALUE rb_block_proc(void)
Constructs a Proc object from implicitly passed components.
Definition proc.c:988
VALUE rb_reg_nth_defined(int n, VALUE md)
Identical to rb_reg_nth_match(), except it just returns Boolean.
Definition re.c:1910
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
Definition string.c:3834
VALUE rb_str_subseq(VALUE str, long beg, long len)
Identical to rb_str_substr(), except the numbers are interpreted as byte offsets instead of character...
Definition string.c:3187
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
Definition string.c:1516
VALUE rb_str_dup(VALUE str)
Duplicates a string.
Definition string.c:1994
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
Definition string.h:1515
VALUE rb_str_intern(VALUE str)
Identical to rb_to_symbol(), except it assumes the receiver being an instance of RString.
Definition symbol.c:968
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_exec_recursive_paired(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE p, VALUE h)
Identical to rb_exec_recursive(), except it checks for the recursion on the ordered pair of { g,...
VALUE rb_mod_remove_cvar(VALUE mod, VALUE name)
Resembles Module#remove_class_variable.
Definition variable.c:4498
VALUE rb_obj_instance_variables(VALUE obj)
Resembles Object#instance_variables.
Definition variable.c:2451
VALUE rb_f_untrace_var(int argc, const VALUE *argv)
Deletes the passed tracer from the passed global variable, or if omitted, deletes everything.
Definition variable.c:924
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
Definition variable.c:3476
VALUE rb_const_list(void *)
This is another mysterious API that comes with no documents at all.
Definition variable.c:3720
VALUE rb_path2class(const char *path)
Resolves a Q::W::E::R-style path string to the actual class it points.
Definition variable.c:494
VALUE rb_autoload_p(VALUE space, ID name)
Queries if an autoload is defined at a point.
Definition variable.c:3344
void rb_set_class_path(VALUE klass, VALUE space, const char *name)
Names a class.
Definition variable.c:441
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.
Definition variable.c:2047
VALUE rb_mod_remove_const(VALUE space, VALUE name)
Resembles Module#remove_const.
Definition variable.c:3581
VALUE rb_class_path_cached(VALUE mod)
Just another name of rb_mod_name.
Definition variable.c:389
VALUE rb_f_trace_var(int argc, const VALUE *argv)
Traces a global variable.
Definition variable.c:878
void rb_cvar_set(VALUE klass, ID name, VALUE val)
Assigns a value to a class variable.
Definition variable.c:4263
VALUE rb_cvar_get(VALUE klass, ID name)
Obtains a value from a class variable.
Definition variable.c:4333
VALUE rb_mod_constants(int argc, const VALUE *argv, VALUE recv)
Resembles Module#constants.
Definition variable.c:3752
VALUE rb_cvar_find(VALUE klass, ID name, VALUE *front)
Identical to rb_cvar_get(), except it takes additional "front" pointer.
Definition variable.c:4317
VALUE rb_path_to_class(VALUE path)
Identical to rb_path2class(), except it accepts the path as Ruby's string instead of C's.
Definition variable.c:449
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.
Definition variable.c:1515
void rb_const_set(VALUE space, ID name, VALUE val)
Names a constant.
Definition variable.c:3954
VALUE rb_autoload_load(VALUE space, ID name)
Kicks the autoload procedure as if it was "touched".
Definition variable.c:3306
VALUE rb_mod_name(VALUE mod)
Queries the name of a module.
Definition variable.c:136
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
Definition variable.c:500
VALUE rb_const_get_at(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
Definition variable.c:3482
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.
Definition variable.c:423
void rb_alias_variable(ID dst, ID src)
Aliases a global variable.
Definition variable.c:1166
void rb_define_class_variable(VALUE, const char *, VALUE)
Just another name of rb_cv_set.
Definition variable.c:4373
VALUE rb_obj_remove_instance_variable(VALUE obj, VALUE name)
Resembles Object#remove_instance_variable.
Definition variable.c:2503
void * rb_mod_const_of(VALUE, void *)
This is a variant of rb_mod_const_at().
Definition variable.c:3698
st_index_t rb_ivar_count(VALUE obj)
Number of instance variables defined on an object.
Definition variable.c:2363
void * rb_mod_const_at(VALUE, void *)
This API is mysterious.
Definition variable.c:3683
VALUE rb_const_remove(VALUE space, ID name)
Identical to rb_mod_remove_const(), except it takes the name as ID instead of VALUE.
Definition variable.c:3594
VALUE rb_const_get_from(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
Definition variable.c:3470
VALUE rb_ivar_defined(VALUE obj, ID name)
Queries if the instance variable is defined at the object.
Definition variable.c:2126
VALUE rb_cv_get(VALUE klass, const char *name)
Identical to rb_cvar_get(), except it accepts C's string instead of ID.
Definition variable.c:4366
int rb_const_defined_at(VALUE space, ID name)
Identical to rb_const_defined(), except it doesn't look for parent classes.
Definition variable.c:3814
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.
Definition variable.c:4359
VALUE rb_mod_class_variables(int argc, const VALUE *argv, VALUE recv)
Resembles Module#class_variables.
Definition variable.c:4463
VALUE rb_f_global_variables(void)
Queries the list of global variables.
Definition variable.c:1133
VALUE rb_cvar_defined(VALUE klass, ID name)
Queries if the given class has the given class variable.
Definition variable.c:4340
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
Definition variable.c:380
int rb_const_defined_from(VALUE space, ID name)
Identical to rb_const_defined(), except it returns false for private constants.
Definition variable.c:3802
int rb_const_defined(VALUE space, ID name)
Queries if the constant is defined at the namespace.
Definition variable.c:3808
void rb_free_generic_ivar(VALUE obj)
Frees the list of instance variables.
Definition variable.c:1318
const char * rb_sourcefile(void)
Resembles __FILE__.
Definition vm.c:2079
void rb_clear_constant_cache_for_id(ID id)
Clears the inline constant caches associated with a particular ID.
Definition vm_method.c:329
int rb_obj_respond_to(VALUE obj, ID mid, int private_p)
Identical to rb_respond_to(), except it additionally takes the visibility parameter.
Definition vm_method.c:3458
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
Definition symbol.h:285
VALUE rb_id2sym(ID id)
Allocates an instance of rb_cSymbol that has the given id.
Definition symbol.c:1005
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
Definition symbol.c:1164
ID rb_to_id(VALUE str)
Identical to rb_intern_str(), except it tries to convert the parameter object to an instance of rb_cS...
Definition string.c:12709
rb_gvar_setter_t rb_gvar_var_setter
Definition variable.h:119
rb_gvar_marker_t rb_gvar_var_marker
Definition variable.h:128
void rb_define_global_const(const char *name, VALUE val)
Identical to rb_define_const(), except it defines that of "global", i.e.
Definition variable.c:4065
VALUE rb_gv_get(const char *name)
Obtains a global variable.
Definition variable.c:1091
void rb_define_variable(const char *name, VALUE *var)
"Shares" a global variable between Ruby and C.
Definition variable.c:849
void rb_gvar_marker_t(VALUE *var)
Type that represents a global variable marker function.
Definition variable.h:53
void rb_deprecate_constant(VALUE mod, const char *name)
Asserts that the given constant is deprecated.
Definition variable.c:4110
void rb_gvar_setter_t(VALUE val, ID id, VALUE *data)
Type that represents a global variable setter function.
Definition variable.h:46
rb_gvar_setter_t rb_gvar_val_setter
This is the setter function that backs global variables defined from a ruby script.
Definition variable.h:94
rb_gvar_marker_t rb_gvar_undef_marker
Definition variable.h:80
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...
Definition variable.c:855
rb_gvar_setter_t rb_gvar_readonly_setter
This function just raises rb_eNameError.
Definition variable.h:135
rb_gvar_getter_t rb_gvar_undef_getter
Definition variable.h:62
VALUE rb_gv_set(const char *name, VALUE val)
Assigns to a global variable.
Definition variable.c:1046
rb_gvar_marker_t rb_gvar_val_marker
This is the setter function that backs global variables defined from a ruby script.
Definition variable.h:101
VALUE rb_gvar_getter_t(ID id, VALUE *data)
Type that represents a global variable getter function.
Definition variable.h:37
VALUE rb_iv_get(VALUE obj, const char *name)
Obtains an instance variable.
Definition variable.c:4521
rb_gvar_setter_t rb_gvar_undef_setter
Definition variable.h:71
rb_gvar_getter_t rb_gvar_val_getter
This is the getter function that backs global variables defined from a ruby script.
Definition variable.h:87
VALUE rb_iv_set(VALUE obj, const char *name, VALUE val)
Assigns to an instance variable.
Definition variable.c:4532
rb_gvar_getter_t rb_gvar_var_getter
Definition variable.h:110
int len
Length of the buffer.
Definition io.h:8
static bool rb_ractor_shareable_p(VALUE obj)
Queries if multiple Ractors can share the passed object or not.
Definition ractor.h:249
#define RB_OBJ_SHAREABLE_P(obj)
Queries if the passed object has previously classified as shareable or not.
Definition ractor.h:235
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
Definition memory.h:372
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
#define MEMMOVE(p1, p2, type, n)
Handy macro to call memmove.
Definition memory.h:384
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.
Definition variable.c:2249
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
Definition rbasic.h:166
#define RBASIC(obj)
Convenient casting macro.
Definition rbasic.h:40
#define RCLASS_SUPER
Just another name of rb_class_get_superclass.
Definition rclass.h:44
#define ROBJECT(obj)
Convenient casting macro.
Definition robject.h:43
static VALUE * ROBJECT_FIELDS(VALUE obj)
Queries the instance variables.
Definition robject.h:128
#define StringValue(v)
Ensures that the parameter object is a String.
Definition rstring.h:66
static char * RSTRING_END(VALUE str)
Queries the end of the contents pointer of the string.
Definition rstring.h:409
static bool RTYPEDDATA_P(VALUE obj)
Checks whether the passed object is RTypedData or RData.
Definition rtypeddata.h:669
#define RTYPEDDATA_DATA(v)
Convenient getter macro.
Definition rtypeddata.h:106
#define RUBY_TYPED_FREE_IMMEDIATELY
Macros to see if each corresponding flag is defined.
Definition rtypeddata.h:122
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
Definition rtypeddata.h:531
#define RTYPEDDATA(obj)
Convenient casting macro.
Definition rtypeddata.h:96
#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...
Definition rtypeddata.h:578
const char * rb_class2name(VALUE klass)
Queries the name of the passed class.
Definition variable.c:506
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
Definition variable.c:515
#define RB_NO_KEYWORDS
Do not pass keywords.
Definition scan_args.h:69
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.
Definition stdarg.h:35
C99 shim for <stdbool.h>
Internal header for Ruby Box.
Definition box.h:14
Definition constant.h:33
Definition class.h:37
This is the struct that holds necessary info for a struct.
Definition rtypeddata.h:229
Definition variable.c:540
Definition st.h:79
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
static enum ruby_value_type rb_type(VALUE obj)
Identical to RB_BUILTIN_TYPE(), except it can also accept special constants.
Definition value_type.h:225
static enum ruby_value_type RB_BUILTIN_TYPE(VALUE obj)
Queries the type of the object.
Definition value_type.h:182
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
Definition value_type.h:433
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376