Ruby 4.1.0dev (2026-05-14 revision 4c3de1a7b063c91015a54b8b125676b60d565959)
variable.c (4c3de1a7b063c91015a54b8b125676b60d565959)
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_obj_shape_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_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_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_complex(VALUE obj, st_table *table)
1583{
1584 RUBY_ASSERT(!rb_obj_shape_complex_p(obj));
1585 shape_id_t shape_id = rb_obj_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, shape_id, table, RB_OBJ_SHAREABLE_P(obj));
1614 rb_obj_replace_fields(obj, fields_obj);
1615 }
1616 }
1617
1618 return shape_id;
1619}
1620
1621// Copy all object fields, including ivars and internal object_id, etc
1622static shape_id_t
1623rb_evict_fields_to_hash(VALUE obj)
1624{
1625 RUBY_ASSERT(!rb_obj_shape_complex_p(obj));
1626
1627 st_table *table = st_init_numtable_with_size(RSHAPE_LEN(RBASIC_SHAPE_ID(obj)));
1628 rb_obj_copy_fields_to_hash_table(obj, table);
1629 shape_id_t new_shape_id = obj_transition_complex(obj, table);
1630
1631 RUBY_ASSERT(rb_obj_shape_complex_p(obj));
1632 return new_shape_id;
1633}
1634
1635void
1636rb_evict_ivars_to_hash(VALUE obj)
1637{
1638 RUBY_ASSERT(!rb_obj_shape_complex_p(obj));
1639
1640 st_table *table = st_init_numtable_with_size(rb_ivar_count(obj));
1641
1642 // Evacuate all previous values from shape into id_table
1643 rb_obj_copy_ivs_to_hash_table(obj, table);
1644 obj_transition_complex(obj, table);
1645
1646 RUBY_ASSERT(rb_obj_shape_complex_p(obj));
1647}
1648
1649static VALUE
1650rb_ivar_delete(VALUE obj, ID id, VALUE undef)
1651{
1652 rb_check_frozen(obj);
1653
1654 VALUE val = undef;
1655 VALUE fields_obj;
1656 bool concurrent = false;
1657 int type = BUILTIN_TYPE(obj);
1658
1659 switch(type) {
1660 case T_CLASS:
1661 case T_MODULE:
1662 IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(id);
1663
1664 fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
1665 if (rb_multi_ractor_p()) {
1666 concurrent = true;
1667 }
1668 break;
1669 case T_OBJECT:
1670 fields_obj = obj;
1671 break;
1672 default: {
1673 fields_obj = rb_obj_fields(obj, id);
1674 break;
1675 }
1676 }
1677
1678 if (!fields_obj) {
1679 return undef;
1680 }
1681
1682 const VALUE original_fields_obj = fields_obj;
1683 if (concurrent) {
1684 fields_obj = rb_imemo_fields_clone(fields_obj);
1685 }
1686
1687 shape_id_t old_shape_id = RBASIC_SHAPE_ID(fields_obj);
1688 shape_id_t removed_shape_id;
1689 shape_id_t next_shape_id = rb_obj_shape_transition_remove_ivar(fields_obj, id, &removed_shape_id);
1690
1691 if (UNLIKELY(rb_shape_complex_p(next_shape_id))) {
1692 if (UNLIKELY(!rb_shape_complex_p(old_shape_id))) {
1693 if (type == T_OBJECT) {
1694 rb_evict_fields_to_hash(obj);
1695 }
1696 else {
1697 fields_obj = imemo_fields_complex_from_obj(obj, fields_obj, next_shape_id);
1698 }
1699 }
1700 st_data_t key = id;
1701 if (!st_delete(rb_imemo_fields_complex_tbl(fields_obj), &key, (st_data_t *)&val)) {
1702 val = undef;
1703 }
1704 }
1705 else {
1706 if (next_shape_id == old_shape_id) {
1707 return undef;
1708 }
1709
1710 RUBY_ASSERT(removed_shape_id != INVALID_SHAPE_ID);
1711 RUBY_ASSERT(RSHAPE_LEN(next_shape_id) == RSHAPE_LEN(old_shape_id) - 1);
1712
1713 VALUE *fields = rb_imemo_fields_ptr(fields_obj);
1714 attr_index_t removed_index = RSHAPE_INDEX(removed_shape_id);
1715 val = fields[removed_index];
1716
1717 attr_index_t new_fields_count = RSHAPE_LEN(next_shape_id);
1718 if (new_fields_count) {
1719 size_t trailing_fields = new_fields_count - removed_index;
1720
1721 MEMMOVE(&fields[removed_index], &fields[removed_index + 1], VALUE, trailing_fields);
1722 RBASIC_SET_SHAPE_ID(fields_obj, next_shape_id);
1723
1724 if (FL_TEST_RAW(fields_obj, OBJ_FIELD_HEAP)) {
1725 if (rb_obj_embedded_size(new_fields_count) <= rb_gc_obj_slot_size(fields_obj)) {
1726 // Re-embed objects when instances become small enough
1727 // This is necessary because YJIT assumes that objects with the same shape
1728 // have the same embeddedness for efficiency (avoid extra checks)
1729 FL_UNSET_RAW(fields_obj, ROBJECT_HEAP);
1730 MEMCPY(rb_imemo_fields_ptr(fields_obj), fields, VALUE, new_fields_count);
1731 SIZED_FREE_N(fields, RSHAPE_CAPACITY(old_shape_id));
1732 }
1733 else if (RSHAPE_CAPACITY(old_shape_id) != RSHAPE_CAPACITY(next_shape_id)) {
1734 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));
1735 }
1736 }
1737 }
1738 else {
1739 fields_obj = 0;
1741 }
1742 }
1743
1744 RBASIC_SET_SHAPE_ID(obj, next_shape_id);
1745 if (fields_obj != original_fields_obj) {
1746 switch (type) {
1747 case T_OBJECT:
1748 break;
1749 case T_CLASS:
1750 case T_MODULE:
1751 RCLASS_WRITABLE_SET_FIELDS_OBJ(obj, fields_obj);
1752 break;
1753 default:
1754 rb_obj_set_fields(obj, fields_obj, id, original_fields_obj);
1755 break;
1756 }
1757 }
1758
1759 return val;
1760}
1761
1762VALUE
1763rb_attr_delete(VALUE obj, ID id)
1764{
1765 return rb_ivar_delete(obj, id, Qnil);
1766}
1767
1768void
1769rb_obj_init_complex(VALUE obj, st_table *table)
1770{
1771 // This method is meant to be called on newly allocated object.
1772 RUBY_ASSERT(rb_shape_canonical_p(RBASIC_SHAPE_ID(obj)));
1773 RUBY_ASSERT(RSHAPE_LEN(RBASIC_SHAPE_ID(obj)) == 0);
1774
1775 if (rb_obj_shape_complex_p(obj)) {
1776 st_table *old_table = ROBJECT_FIELDS_HASH(obj);
1777 ROBJECT_SET_FIELDS_HASH(obj, table);
1778 if (old_table) st_free_table(old_table);
1779 }
1780 else {
1781 obj_transition_complex(obj, table);
1782 }
1783}
1784
1785static int
1786imemo_fields_complex_from_obj_i(ID key, VALUE val, st_data_t arg)
1787{
1788 VALUE fields = (VALUE)arg;
1789 st_table *table = rb_imemo_fields_complex_tbl(fields);
1790
1791 RUBY_ASSERT(!st_lookup(table, (st_data_t)key, NULL));
1792 st_add_direct(table, (st_data_t)key, (st_data_t)val);
1793 RB_OBJ_WRITTEN(fields, Qundef, val);
1794
1795 return ST_CONTINUE;
1796}
1797
1798static VALUE
1799imemo_fields_complex_from_obj(VALUE owner, VALUE source_fields_obj, shape_id_t shape_id)
1800{
1801 attr_index_t len = source_fields_obj ? RSHAPE_LEN(RBASIC_SHAPE_ID(source_fields_obj)) : 0;
1802 VALUE fields_obj = rb_imemo_fields_new_complex(owner, shape_id, len + 1, RB_OBJ_SHAREABLE_P(owner));
1803
1804 rb_field_foreach(source_fields_obj, imemo_fields_complex_from_obj_i, (st_data_t)fields_obj, false);
1805
1806 return fields_obj;
1807}
1808
1809static VALUE
1810imemo_fields_copy_append(VALUE owner, VALUE source_fields_obj, shape_id_t current_shape_id, shape_id_t target_shape_id, VALUE val)
1811{
1812 attr_index_t fields_count = RSHAPE_LEN(current_shape_id);
1813
1814 VALUE fields_obj = rb_imemo_fields_new(owner, target_shape_id, RB_OBJ_SHAREABLE_P(owner));
1815
1816 VALUE *fields = rb_imemo_fields_ptr(fields_obj);
1817
1818 if (source_fields_obj) {
1819 MEMCPY(fields, rb_imemo_fields_ptr(source_fields_obj), VALUE, fields_count);
1820 for (attr_index_t i = 0; i < fields_count; i++) {
1821 RB_OBJ_WRITTEN(fields_obj, Qundef, fields[i]);
1822 }
1823 }
1824
1825 RB_OBJ_WRITE(fields_obj, &fields[fields_count], val);
1826
1827 return fields_obj;
1828}
1829
1830static VALUE
1831imemo_fields_set(VALUE owner, VALUE fields_obj, shape_id_t target_shape_id, ID field_name, VALUE val, bool concurrent)
1832{
1833 const VALUE original_fields_obj = fields_obj;
1834 shape_id_t current_shape_id = fields_obj ? RBASIC_SHAPE_ID(fields_obj) : ROOT_SHAPE_ID;
1835
1836 if (UNLIKELY(rb_shape_complex_p(target_shape_id))) {
1837 if (rb_shape_complex_p(current_shape_id)) {
1838 if (concurrent) {
1839 // In multi-ractor case, we must always work on a copy because
1840 // even if the field already exist, inserting in a st_table may
1841 // cause a rebuild.
1842 fields_obj = rb_imemo_fields_clone(fields_obj);
1843 }
1844 }
1845 else {
1846 fields_obj = imemo_fields_complex_from_obj(owner, original_fields_obj, target_shape_id);
1847 current_shape_id = target_shape_id;
1848 }
1849
1850 st_table *table = rb_imemo_fields_complex_tbl(fields_obj);
1851
1852 RUBY_ASSERT(field_name);
1853 st_insert(table, (st_data_t)field_name, (st_data_t)val);
1854 RB_OBJ_WRITTEN(fields_obj, Qundef, val);
1855 RBASIC_SET_SHAPE_ID(fields_obj, target_shape_id);
1856 }
1857 else {
1858 attr_index_t index = RSHAPE_INDEX(target_shape_id);
1859 if (concurrent || index >= RSHAPE_CAPACITY(current_shape_id)) {
1860 return imemo_fields_copy_append(owner, original_fields_obj, current_shape_id, target_shape_id, val);
1861 }
1862
1863 VALUE *table = rb_imemo_fields_ptr(fields_obj);
1864 RB_OBJ_WRITE(fields_obj, &table[index], val);
1865
1866 if (index >= RSHAPE_LEN(current_shape_id)) {
1867 RBASIC_SET_SHAPE_ID(fields_obj, target_shape_id);
1868 }
1869 }
1870
1871 return fields_obj;
1872}
1873
1874static attr_index_t
1875generic_field_set(VALUE obj, shape_id_t target_shape_id, ID field_name, VALUE val)
1876{
1877 if (!field_name) {
1878 field_name = RSHAPE_EDGE_NAME(target_shape_id);
1879 RUBY_ASSERT(field_name);
1880 }
1881
1882 const VALUE original_fields_obj = rb_obj_fields(obj, field_name);
1883 VALUE fields_obj = imemo_fields_set(obj, original_fields_obj, target_shape_id, field_name, val, false);
1884
1885 rb_obj_set_fields(obj, fields_obj, field_name, original_fields_obj);
1886 return rb_shape_complex_p(target_shape_id) ? ATTR_INDEX_NOT_SET : RSHAPE_INDEX(target_shape_id);
1887}
1888
1889static shape_id_t
1890generic_shape_ivar(VALUE obj, ID id, bool *new_ivar_out)
1891{
1892 bool new_ivar = false;
1893 shape_id_t current_shape_id = RBASIC_SHAPE_ID(obj);
1894 shape_id_t target_shape_id = current_shape_id;
1895
1896 if (!rb_shape_complex_p(current_shape_id)) {
1897 if (!rb_shape_find_ivar(current_shape_id, id, &target_shape_id)) {
1898 new_ivar = true;
1899 target_shape_id = rb_obj_shape_transition_add_ivar(obj, id);
1900 }
1901 }
1902
1903 *new_ivar_out = new_ivar;
1904 return target_shape_id;
1905}
1906
1907static attr_index_t
1908generic_ivar_set(VALUE obj, ID id, VALUE val)
1909{
1910 bool dontcare;
1911 shape_id_t target_shape_id = generic_shape_ivar(obj, id, &dontcare);
1912 return generic_field_set(obj, target_shape_id, id, val);
1913}
1914
1915void
1916rb_ensure_iv_list_size(VALUE obj, uint32_t current_len, uint32_t new_capacity)
1917{
1918 RUBY_ASSERT(!rb_obj_shape_complex_p(obj));
1919
1920 if (FL_TEST_RAW(obj, ROBJECT_HEAP)) {
1921 SIZED_REALLOC_N(ROBJECT(obj)->as.heap.fields, VALUE, new_capacity, current_len);
1922 }
1923 else {
1924 VALUE *ptr = ROBJECT_FIELDS(obj);
1925 VALUE *newptr = ALLOC_N(VALUE, new_capacity);
1926 MEMCPY(newptr, ptr, VALUE, current_len);
1927 FL_SET_RAW(obj, ROBJECT_HEAP);
1928 ROBJECT(obj)->as.heap.fields = newptr;
1929 }
1930}
1931
1932static int
1933rb_obj_copy_ivs_to_hash_table_i(ID key, VALUE val, st_data_t arg)
1934{
1935 RUBY_ASSERT(!st_lookup((st_table *)arg, (st_data_t)key, NULL));
1936
1937 st_add_direct((st_table *)arg, (st_data_t)key, (st_data_t)val);
1938 return ST_CONTINUE;
1939}
1940
1941void
1942rb_obj_copy_ivs_to_hash_table(VALUE obj, st_table *table)
1943{
1944 rb_ivar_foreach(obj, rb_obj_copy_ivs_to_hash_table_i, (st_data_t)table);
1945}
1946
1947void
1948rb_obj_copy_fields_to_hash_table(VALUE obj, st_table *table)
1949{
1950 rb_field_foreach(obj, rb_obj_copy_ivs_to_hash_table_i, (st_data_t)table, false);
1951}
1952
1953static attr_index_t
1954obj_field_set(VALUE obj, shape_id_t target_shape_id, ID field_name, VALUE val)
1955{
1956 shape_id_t current_shape_id = RBASIC_SHAPE_ID(obj);
1957
1958 if (UNLIKELY(rb_shape_complex_p(target_shape_id))) {
1959 if (UNLIKELY(!rb_shape_complex_p(current_shape_id))) {
1960 current_shape_id = rb_evict_fields_to_hash(obj);
1961 }
1962
1963 if (RSHAPE_LEN(target_shape_id) > RSHAPE_LEN(current_shape_id)) {
1964 RBASIC_SET_SHAPE_ID(obj, target_shape_id);
1965 }
1966
1967 if (!field_name) {
1968 field_name = RSHAPE_EDGE_NAME(target_shape_id);
1969 RUBY_ASSERT(field_name);
1970 }
1971
1972 st_insert(ROBJECT_FIELDS_HASH(obj), (st_data_t)field_name, (st_data_t)val);
1973 RB_OBJ_WRITTEN(obj, Qundef, val);
1974
1975 return ATTR_INDEX_NOT_SET;
1976 }
1977 else {
1978 attr_index_t index = RSHAPE_INDEX(target_shape_id);
1979
1980 if (index >= RSHAPE_LEN(current_shape_id)) {
1981 if (UNLIKELY(index >= RSHAPE_CAPACITY(current_shape_id))) {
1982 rb_ensure_iv_list_size(obj, RSHAPE_CAPACITY(current_shape_id), RSHAPE_CAPACITY(target_shape_id));
1983 }
1984 RBASIC_SET_SHAPE_ID(obj, target_shape_id);
1985 }
1986
1987 RB_OBJ_WRITE(obj, &ROBJECT_FIELDS(obj)[index], val);
1988
1989 return index;
1990 }
1991}
1992
1993static attr_index_t
1994obj_ivar_set(VALUE obj, ID id, VALUE val)
1995{
1996 bool dontcare;
1997 shape_id_t target_shape_id = generic_shape_ivar(obj, id, &dontcare);
1998 return obj_field_set(obj, target_shape_id, id, val);
1999}
2000
2001/* Set the instance variable +val+ on object +obj+ at ivar name +id+.
2002 * This function only works with T_OBJECT objects, so make sure
2003 * +obj+ is of type T_OBJECT before using this function.
2004 */
2005VALUE
2006rb_vm_set_ivar_id(VALUE obj, ID id, VALUE val)
2007{
2008 rb_check_frozen(obj);
2009 obj_ivar_set(obj, id, val);
2010 return val;
2011}
2012
2013void
2015{
2016 if (RB_FL_ABLE(x)) {
2018 if (TYPE(x) == T_STRING) {
2019 RB_FL_UNSET_RAW(x, FL_USER2 | FL_USER3); // STR_CHILLED
2020 }
2021
2022 shape_id_t shape_id = rb_obj_shape_transition_frozen(x);
2023 switch (BUILTIN_TYPE(x)) {
2024 case T_CLASS:
2025 case T_MODULE:
2026 RBASIC_SET_SHAPE_ID(RCLASS_WRITABLE_ENSURE_FIELDS_OBJ(x), shape_id);
2027 // FIXME: How to do multi-shape?
2028 RBASIC_SET_SHAPE_ID(x, shape_id);
2029 break;
2030 default:
2031 RBASIC_SET_SHAPE_ID(x, shape_id);
2032 break;
2033 }
2034
2035 if (RBASIC_CLASS(x) && RCLASS_SINGLETON_P(RBASIC_CLASS(x))) {
2037 }
2038 }
2039}
2040
2041static attr_index_t class_ivar_set(VALUE obj, ID id, VALUE val, bool *new_ivar);
2042
2043static attr_index_t
2044ivar_set(VALUE obj, ID id, VALUE val)
2045{
2046 RB_DEBUG_COUNTER_INC(ivar_set_base);
2047
2048 switch (BUILTIN_TYPE(obj)) {
2049 case T_OBJECT:
2050 return obj_ivar_set(obj, id, val);
2051 case T_CLASS:
2052 case T_MODULE:
2053 {
2054 IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(id);
2055 bool dontcare;
2056 return class_ivar_set(obj, id, val, &dontcare);
2057 }
2058 default:
2059 return generic_ivar_set(obj, id, val);
2060 }
2061}
2062
2063VALUE
2065{
2066 rb_check_frozen(obj);
2067 ivar_set(obj, id, val);
2068 return val;
2069}
2070
2071attr_index_t
2072rb_ivar_set_index(VALUE obj, ID id, VALUE val)
2073{
2074 return ivar_set(obj, id, val);
2075}
2076
2077void
2078rb_ivar_set_internal(VALUE obj, ID id, VALUE val)
2079{
2080 // should be internal instance variable name (no @ prefix)
2081 VM_ASSERT(!rb_is_instance_id(id));
2082
2083 ivar_set(obj, id, val);
2084}
2085
2086attr_index_t
2087rb_obj_field_set(VALUE obj, shape_id_t target_shape_id, ID field_name, VALUE val)
2088{
2089 switch (BUILTIN_TYPE(obj)) {
2090 case T_OBJECT:
2091 return obj_field_set(obj, target_shape_id, field_name, val);
2092 case T_CLASS:
2093 case T_MODULE:
2094 // The only field is object_id and T_CLASS handle it differently.
2095 rb_bug("Unreachable");
2096 break;
2097 default:
2098 return generic_field_set(obj, target_shape_id, field_name, val);
2099 }
2100}
2101
2102static VALUE
2103ivar_defined0(VALUE obj, ID id)
2104{
2105 attr_index_t index;
2106
2107 if (rb_obj_shape_complex_p(obj)) {
2108 VALUE idx;
2109 st_table *table = NULL;
2110 switch (BUILTIN_TYPE(obj)) {
2111 case T_CLASS:
2112 case T_MODULE:
2113 rb_bug("Unreachable");
2114 break;
2115
2116 case T_IMEMO:
2117 RUBY_ASSERT(IMEMO_TYPE_P(obj, imemo_fields));
2118 table = rb_imemo_fields_complex_tbl(obj);
2119 break;
2120
2121 case T_OBJECT:
2122 table = ROBJECT_FIELDS_HASH(obj);
2123 break;
2124
2125 default: {
2126 VALUE fields_obj = rb_obj_fields_no_ractor_check(obj); // defined? doesn't require ractor checks
2127 table = rb_imemo_fields_complex_tbl(fields_obj);
2128 }
2129 }
2130
2131 if (!table || !rb_st_lookup(table, id, &idx)) {
2132 return Qfalse;
2133 }
2134
2135 return Qtrue;
2136 }
2137 else {
2138 return RBOOL(rb_shape_get_iv_index(RBASIC_SHAPE_ID(obj), id, &index));
2139 }
2140}
2141
2142VALUE
2144{
2145 if (SPECIAL_CONST_P(obj)) return Qfalse;
2146
2147 VALUE defined = Qfalse;
2148 switch (BUILTIN_TYPE(obj)) {
2149 case T_CLASS:
2150 case T_MODULE:
2151 {
2152 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
2153 if (fields_obj) {
2154 defined = ivar_defined0(fields_obj, id);
2155 }
2156 }
2157 break;
2158 default:
2159 defined = ivar_defined0(obj, id);
2160 break;
2161 }
2162 return defined;
2163}
2164
2166 VALUE obj;
2167 struct gen_fields_tbl *fields_tbl;
2168 st_data_t arg;
2169 rb_ivar_foreach_callback_func *func;
2170 VALUE *fields;
2171 shape_id_t shape_id;
2172 bool ivar_only;
2173};
2174
2175static int
2176iterate_over_shapes_callback(shape_id_t shape_id, void *data)
2177{
2178 struct iv_itr_data *itr_data = data;
2179
2180 if (itr_data->ivar_only && !RSHAPE_TYPE_P(shape_id, SHAPE_IVAR)) {
2181 return ST_CONTINUE;
2182 }
2183
2184 VALUE *fields;
2185 switch (BUILTIN_TYPE(itr_data->obj)) {
2186 case T_OBJECT:
2187 RUBY_ASSERT(!rb_obj_shape_complex_p(itr_data->obj));
2188 fields = ROBJECT_FIELDS(itr_data->obj);
2189 break;
2190 case T_IMEMO:
2191 RUBY_ASSERT(IMEMO_TYPE_P(itr_data->obj, imemo_fields));
2192 RUBY_ASSERT(!rb_obj_shape_complex_p(itr_data->obj));
2193
2194 fields = rb_imemo_fields_ptr(itr_data->obj);
2195 break;
2196 default:
2197 rb_bug("Unreachable");
2198 }
2199
2200 RUBY_ASSERT(itr_data->shape_id == RBASIC_SHAPE_ID(itr_data->obj));
2201
2202 VALUE val = fields[RSHAPE_INDEX(shape_id)];
2203 int ret = itr_data->func(RSHAPE_EDGE_NAME(shape_id), val, itr_data->arg);
2204
2205 RUBY_ASSERT(itr_data->shape_id == RBASIC_SHAPE_ID(itr_data->obj));
2206
2207 return ret;
2208}
2209
2210/*
2211 * Returns a flag to stop iterating depending on the result of +callback+.
2212 */
2213static void
2214iterate_over_shapes(shape_id_t shape_id, rb_ivar_foreach_callback_func *callback, struct iv_itr_data *itr_data)
2215{
2216 rb_shape_foreach_field(shape_id, iterate_over_shapes_callback, itr_data);
2217}
2218
2219static int
2220each_hash_iv(st_data_t id, st_data_t val, st_data_t data)
2221{
2222 struct iv_itr_data * itr_data = (struct iv_itr_data *)data;
2223 rb_ivar_foreach_callback_func *callback = itr_data->func;
2224 if (is_internal_id((ID)id)) {
2225 return ST_CONTINUE;
2226 }
2227 return callback((ID)id, (VALUE)val, itr_data->arg);
2228}
2229
2230static void
2231obj_fields_each(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg, bool ivar_only)
2232{
2233 struct iv_itr_data itr_data = {
2234 .obj = obj,
2235 .arg = arg,
2236 .func = func,
2237 .ivar_only = ivar_only,
2238 };
2239
2240 shape_id_t shape_id = RBASIC_SHAPE_ID(obj);
2241 if (rb_shape_complex_p(shape_id)) {
2242 st_foreach_safe(ROBJECT_FIELDS_HASH(obj), each_hash_iv, (st_data_t)&itr_data);
2243 }
2244 else {
2245 itr_data.fields = ROBJECT_FIELDS(obj);
2246 itr_data.shape_id = shape_id;
2247 iterate_over_shapes(shape_id, func, &itr_data);
2248 }
2249}
2250
2251static void
2252imemo_fields_each(VALUE fields_obj, rb_ivar_foreach_callback_func *func, st_data_t arg, bool ivar_only)
2253{
2254 IMEMO_TYPE_P(fields_obj, imemo_fields);
2255
2256 struct iv_itr_data itr_data = {
2257 .obj = fields_obj,
2258 .arg = arg,
2259 .func = func,
2260 .ivar_only = ivar_only,
2261 };
2262
2263 shape_id_t shape_id = RBASIC_SHAPE_ID(fields_obj);
2264 if (rb_shape_complex_p(shape_id)) {
2265 rb_st_foreach(rb_imemo_fields_complex_tbl(fields_obj), each_hash_iv, (st_data_t)&itr_data);
2266 }
2267 else {
2268 itr_data.fields = rb_imemo_fields_ptr(fields_obj);
2269 itr_data.shape_id = shape_id;
2270 iterate_over_shapes(shape_id, func, &itr_data);
2271 }
2272}
2273
2274void
2276{
2277 VALUE new_fields_obj;
2278
2279 rb_check_frozen(dest);
2280
2281 if (!rb_obj_gen_fields_p(obj)) {
2282 return;
2283 }
2284
2285 shape_id_t src_shape_id = rb_obj_shape_id(obj);
2286
2287 VALUE fields_obj = rb_obj_fields_no_ractor_check(obj);
2288 if (fields_obj) {
2289 unsigned long src_num_ivs = rb_ivar_count(fields_obj);
2290 if (!src_num_ivs) {
2291 goto clear;
2292 }
2293
2294 if (rb_shape_complex_p(src_shape_id)) {
2295 rb_shape_copy_complex_ivars(dest, obj, src_shape_id, rb_imemo_fields_complex_tbl(fields_obj));
2296 return;
2297 }
2298
2299 shape_id_t dest_shape_id = src_shape_id;
2300 shape_id_t initial_shape_id = rb_obj_shape_id(dest);
2301
2302 if (!rb_shape_canonical_p(src_shape_id)) {
2303 RUBY_ASSERT(RSHAPE_TYPE_P(initial_shape_id, SHAPE_ROOT));
2304
2305 dest_shape_id = rb_shape_rebuild(initial_shape_id, src_shape_id);
2306 if (UNLIKELY(rb_shape_complex_p(dest_shape_id))) {
2307 st_table *table = rb_st_init_numtable_with_size(src_num_ivs);
2308 rb_obj_copy_ivs_to_hash_table(obj, table);
2309 rb_obj_init_complex(dest, table);
2310 return;
2311 }
2312 }
2313
2314 if (!RSHAPE_LEN(dest_shape_id)) {
2315 RBASIC_SET_SHAPE_ID(dest, dest_shape_id);
2316 return;
2317 }
2318
2319 new_fields_obj = rb_imemo_fields_new(dest, dest_shape_id, RB_OBJ_SHAREABLE_P(dest));
2320 VALUE *src_buf = rb_imemo_fields_ptr(fields_obj);
2321 VALUE *dest_buf = rb_imemo_fields_ptr(new_fields_obj);
2322 rb_shape_copy_fields(new_fields_obj, dest_buf, dest_shape_id, src_buf, src_shape_id);
2323
2324 rb_obj_replace_fields(dest, new_fields_obj);
2325 }
2326 return;
2327
2328 clear:
2330}
2331
2332void
2333rb_replace_generic_ivar(VALUE clone, VALUE obj)
2334{
2335 RB_VM_LOCKING() {
2336 st_data_t fields_tbl, obj_data = (st_data_t)obj;
2337 if (st_delete(generic_fields_tbl_, &obj_data, &fields_tbl)) {
2338 st_insert(generic_fields_tbl_, (st_data_t)clone, fields_tbl);
2339 RB_OBJ_WRITTEN(clone, Qundef, fields_tbl);
2340 }
2341 else {
2342 rb_bug("unreachable");
2343 }
2344 }
2345}
2346
2347void
2348rb_field_foreach(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg, bool ivar_only)
2349{
2350 if (SPECIAL_CONST_P(obj)) return;
2351 switch (BUILTIN_TYPE(obj)) {
2352 case T_IMEMO:
2353 if (IMEMO_TYPE_P(obj, imemo_fields)) {
2354 imemo_fields_each(obj, func, arg, ivar_only);
2355 }
2356 break;
2357 case T_OBJECT:
2358 obj_fields_each(obj, func, arg, ivar_only);
2359 break;
2360 case T_CLASS:
2361 case T_MODULE:
2362 {
2363 IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(0);
2364 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
2365 if (fields_obj) {
2366 imemo_fields_each(fields_obj, func, arg, ivar_only);
2367 }
2368 }
2369 break;
2370 default:
2371 {
2372 VALUE fields_obj = rb_obj_fields_no_ractor_check(obj);
2373 if (fields_obj) {
2374 imemo_fields_each(fields_obj, func, arg, ivar_only);
2375 }
2376 }
2377 break;
2378 }
2379}
2380
2382 ID name;
2383 VALUE val;
2384};
2385
2386static int
2387collect_ivar_i(ID id, VALUE val, st_data_t arg)
2388{
2389 struct ivar_buf_entry **pos = (struct ivar_buf_entry **)arg;
2390 (*pos)->name = id;
2391 (*pos)->val = val;
2392 (*pos)++;
2393 return ST_CONTINUE;
2394}
2395
2396void
2397rb_ivar_foreach(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg)
2398{
2399 rb_field_foreach(obj, func, arg, true);
2400}
2401
2402void
2403rb_ivar_foreach_buffered(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg)
2404{
2405 st_index_t count = rb_ivar_count(obj);
2406 if (count == 0) return;
2407
2408 VALUE tmpbuf;
2409 struct ivar_buf_entry *buf = ALLOCV_N(struct ivar_buf_entry, tmpbuf, count);
2410 struct ivar_buf_entry *pos = buf;
2411
2412 rb_field_foreach(obj, collect_ivar_i, (st_data_t)&pos, true);
2413 RUBY_ASSERT((st_index_t)(pos - buf) == count);
2414
2415 for (st_index_t i = 0; i < count; i++) {
2416 if (func(buf[i].name, buf[i].val, arg) == ST_STOP) break;
2417 }
2418
2419 ALLOCV_END(tmpbuf);
2420}
2421
2422st_index_t
2424{
2425 if (SPECIAL_CONST_P(obj)) return 0;
2426
2427 st_index_t iv_count = 0;
2428 switch (BUILTIN_TYPE(obj)) {
2429 case T_OBJECT:
2430 iv_count = ROBJECT_FIELDS_COUNT(obj);
2431 break;
2432
2433 case T_CLASS:
2434 case T_MODULE:
2435 {
2436 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
2437 if (!fields_obj) {
2438 return 0;
2439 }
2440 if (rb_obj_shape_complex_p(fields_obj)) {
2441 iv_count = rb_st_table_size(rb_imemo_fields_complex_tbl(fields_obj));
2442 }
2443 else {
2444 iv_count = RBASIC_FIELDS_COUNT(fields_obj);
2445 }
2446 }
2447 break;
2448
2449 case T_IMEMO:
2450 RUBY_ASSERT(IMEMO_TYPE_P(obj, imemo_fields));
2451
2452 if (rb_obj_shape_complex_p(obj)) {
2453 iv_count = rb_st_table_size(rb_imemo_fields_complex_tbl(obj));
2454 }
2455 else {
2456 iv_count = RBASIC_FIELDS_COUNT(obj);
2457 }
2458 break;
2459
2460 default:
2461 {
2462 VALUE fields_obj = rb_obj_fields_no_ractor_check(obj);
2463 if (fields_obj) {
2464 if (rb_obj_shape_complex_p(fields_obj)) {
2465 iv_count = rb_st_table_size(rb_imemo_fields_complex_tbl(fields_obj));
2466 }
2467 else {
2468 iv_count = RBASIC_FIELDS_COUNT(obj);
2469 }
2470 }
2471 }
2472 break;
2473 }
2474
2475 if (rb_obj_shape_has_id(obj)) {
2476 iv_count--;
2477 }
2478
2479 return iv_count;
2480}
2481
2482static int
2483ivar_i(ID key, VALUE v, st_data_t a)
2484{
2485 VALUE ary = (VALUE)a;
2486
2487 if (rb_is_instance_id(key)) {
2488 rb_ary_push(ary, ID2SYM(key));
2489 }
2490 return ST_CONTINUE;
2491}
2492
2493/*
2494 * call-seq:
2495 * obj.instance_variables -> array
2496 *
2497 * Returns an array of instance variable names for the receiver. Note
2498 * that simply defining an accessor does not create the corresponding
2499 * instance variable.
2500 *
2501 * class Fred
2502 * attr_accessor :a1
2503 * def initialize
2504 * @iv = 3
2505 * end
2506 * end
2507 * Fred.new.instance_variables #=> [:@iv]
2508 */
2509
2510VALUE
2512{
2514 rb_ivar_foreach(obj, ivar_i, ary);
2515 return ary;
2516}
2517
2518#define rb_is_constant_id rb_is_const_id
2519#define rb_is_constant_name rb_is_const_name
2520#define id_for_var(obj, name, part, type) \
2521 id_for_var_message(obj, name, type, "'%1$s' is not allowed as "#part" "#type" variable name")
2522#define id_for_var_message(obj, name, type, message) \
2523 check_id_type(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message))
2524static ID
2525check_id_type(VALUE obj, VALUE *pname,
2526 int (*valid_id_p)(ID), int (*valid_name_p)(VALUE),
2527 const char *message, size_t message_len)
2528{
2529 ID id = rb_check_id(pname);
2530 VALUE name = *pname;
2531
2532 if (id ? !valid_id_p(id) : !valid_name_p(name)) {
2533 rb_name_err_raise_str(rb_fstring_new(message, message_len),
2534 obj, name);
2535 }
2536 return id;
2537}
2538
2539/*
2540 * call-seq:
2541 * obj.remove_instance_variable(symbol) -> obj
2542 * obj.remove_instance_variable(string) -> obj
2543 *
2544 * Removes the named instance variable from <i>obj</i>, returning that
2545 * variable's value. The name can be passed as a symbol or as a string.
2546 *
2547 * class Dummy
2548 * attr_reader :var
2549 * def initialize
2550 * @var = 99
2551 * end
2552 * def remove
2553 * remove_instance_variable(:@var)
2554 * end
2555 * end
2556 * d = Dummy.new
2557 * d.var #=> 99
2558 * d.remove #=> 99
2559 * d.var #=> nil
2560 */
2561
2562VALUE
2564{
2565 const ID id = id_for_var(obj, name, an, instance);
2566
2567 // Frozen check comes here because it's expected that we raise a
2568 // NameError (from the id_for_var check) before we raise a FrozenError
2569 rb_check_frozen(obj);
2570
2571 if (id) {
2572 VALUE val = rb_ivar_delete(obj, id, Qundef);
2573
2574 if (!UNDEF_P(val)) return val;
2575 }
2576
2577 rb_name_err_raise("instance variable %1$s not defined",
2578 obj, name);
2580}
2581
2582NORETURN(static void uninitialized_constant(VALUE, VALUE));
2583static void
2584uninitialized_constant(VALUE klass, VALUE name)
2585{
2586 if (klass && rb_class_real(klass) != rb_cObject)
2587 rb_name_err_raise("uninitialized constant %2$s::%1$s",
2588 klass, name);
2589 else
2590 rb_name_err_raise("uninitialized constant %1$s",
2591 klass, name);
2592}
2593
2594VALUE
2595rb_const_missing(VALUE klass, VALUE name)
2596{
2597 VALUE value = rb_funcallv(klass, idConst_missing, 1, &name);
2598 rb_vm_inc_const_missing_count();
2599 return value;
2600}
2601
2602
2603/*
2604 * call-seq:
2605 * mod.const_missing(sym) -> obj
2606 *
2607 * Invoked when a reference is made to an undefined constant in
2608 * <i>mod</i>. It is passed a symbol for the undefined constant, and
2609 * returns a value to be used for that constant. For example, consider:
2610 *
2611 * def Foo.const_missing(name)
2612 * name # return the constant name as Symbol
2613 * end
2614 *
2615 * Foo::UNDEFINED_CONST #=> :UNDEFINED_CONST: symbol returned
2616 *
2617 * As the example above shows, +const_missing+ is not required to create the
2618 * missing constant in <i>mod</i>, though that is often a side-effect. The
2619 * caller gets its return value when triggered. If the constant is also defined,
2620 * further lookups won't hit +const_missing+ and will return the value stored in
2621 * the constant as usual. Otherwise, +const_missing+ will be invoked again.
2622 *
2623 * In the next example, when a reference is made to an undefined constant,
2624 * +const_missing+ attempts to load a file whose path is the lowercase version
2625 * of the constant name (thus class <code>Fred</code> is assumed to be in file
2626 * <code>fred.rb</code>). If defined as a side-effect of loading the file, the
2627 * method returns the value stored in the constant. This implements an autoload
2628 * feature similar to Kernel#autoload and Module#autoload, though it differs in
2629 * important ways.
2630 *
2631 * def Object.const_missing(name)
2632 * @looked_for ||= {}
2633 * str_name = name.to_s
2634 * raise "Constant not found: #{name}" if @looked_for[str_name]
2635 * @looked_for[str_name] = 1
2636 * file = str_name.downcase
2637 * require file
2638 * const_get(name, false)
2639 * end
2640 *
2641 */
2642
2643VALUE
2644rb_mod_const_missing(VALUE klass, VALUE name)
2645{
2646 rb_execution_context_t *ec = GET_EC();
2647 VALUE ref = ec->private_const_reference;
2648 rb_vm_pop_cfunc_frame();
2649 if (ref) {
2650 ec->private_const_reference = 0;
2651 rb_name_err_raise("private constant %2$s::%1$s referenced", ref, name);
2652 }
2653 uninitialized_constant(klass, name);
2654
2656}
2657
2658static void
2659autoload_table_mark(void *ptr)
2660{
2661 rb_mark_tbl_no_pin((st_table *)ptr);
2662}
2663
2664static void
2665autoload_table_free(void *ptr)
2666{
2667 st_free_table((st_table *)ptr);
2668}
2669
2670static size_t
2671autoload_table_memsize(const void *ptr)
2672{
2673 const st_table *tbl = ptr;
2674 return st_memsize(tbl);
2675}
2676
2677static void
2678autoload_table_compact(void *ptr)
2679{
2680 rb_gc_ref_update_table_values_only((st_table *)ptr);
2681}
2682
2683static const rb_data_type_t autoload_table_type = {
2684 "autoload_table",
2685 {autoload_table_mark, autoload_table_free, autoload_table_memsize, autoload_table_compact,},
2686 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
2687};
2688
2689#define check_autoload_table(av) \
2690 (struct st_table *)rb_check_typeddata((av), &autoload_table_type)
2691
2692static VALUE
2693autoload_data(VALUE mod, ID id)
2694{
2695 struct st_table *tbl;
2696 st_data_t val;
2697
2698 // If we are called with a non-origin ICLASS, fetch the autoload data from
2699 // the original module.
2700 if (RB_TYPE_P(mod, T_ICLASS)) {
2701 if (RICLASS_IS_ORIGIN_P(mod)) {
2702 return 0;
2703 }
2704 else {
2705 mod = RBASIC(mod)->klass;
2706 }
2707 }
2708
2710
2711 // Look up the instance variable table for `autoload`, then index into that table with the given constant name `id`.
2712
2713 VALUE tbl_value = rb_ivar_lookup(mod, autoload, Qfalse);
2714 if (!RTEST(tbl_value) || !(tbl = check_autoload_table(tbl_value)) || !st_lookup(tbl, (st_data_t)id, &val)) {
2715 return 0;
2716 }
2717
2718 return (VALUE)val;
2719}
2720
2721// 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`.
2723 // The linked list node of all constants which are loaded by the related autoload feature.
2724 struct ccan_list_node cnode; /* <=> autoload_data.constants */
2725
2726 // The shared "autoload_data" if multiple constants are defined from the same feature.
2727 VALUE autoload_data_value;
2728
2729 // The box object when the autoload is called in a user box
2730 // Otherwise, Qnil means the root box
2731 VALUE box_value;
2732
2733 // The module we are loading a constant into.
2734 VALUE module;
2735
2736 // The name of the constant we are loading.
2737 ID name;
2738
2739 // The value of the constant (after it's loaded).
2740 VALUE value;
2741
2742 // The constant entry flags which need to be re-applied after autoloading the feature.
2743 rb_const_flag_t flag;
2744
2745 // The source file and line number that defined this constant (different from feature path).
2746 VALUE file;
2747 int line;
2748};
2749
2750// 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.
2752 // The feature path to require to load this constant.
2753 VALUE feature;
2754
2755 // The mutex which is protecting autoloading this feature.
2756 VALUE mutex;
2757
2758 // The process fork serial number since the autoload mutex will become invalid on fork.
2759 rb_serial_t fork_gen;
2760
2761 // The linked list of all constants that are going to be loaded by this autoload.
2762 struct ccan_list_head constants; /* <=> autoload_const.cnode */
2763};
2764
2765static void
2766autoload_data_mark_and_move(void *ptr)
2767{
2768 struct autoload_data *p = ptr;
2769
2770 rb_gc_mark_and_move(&p->feature);
2771 rb_gc_mark_and_move(&p->mutex);
2772}
2773
2774static void
2775autoload_data_free(void *ptr)
2776{
2777 struct autoload_data *p = ptr;
2778
2779 struct autoload_const *autoload_const, *next;
2780 ccan_list_for_each_safe(&p->constants, autoload_const, next, cnode) {
2781 ccan_list_del_init(&autoload_const->cnode);
2782 }
2783
2784 SIZED_FREE(p);
2785}
2786
2787static size_t
2788autoload_data_memsize(const void *ptr)
2789{
2790 return sizeof(struct autoload_data);
2791}
2792
2793static const rb_data_type_t autoload_data_type = {
2794 "autoload_data",
2795 {autoload_data_mark_and_move, autoload_data_free, autoload_data_memsize, autoload_data_mark_and_move},
2796 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
2797};
2798
2799static void
2800autoload_const_mark_and_move(void *ptr)
2801{
2802 struct autoload_const *ac = ptr;
2803
2804 rb_gc_mark_and_move(&ac->module);
2805 rb_gc_mark_and_move(&ac->autoload_data_value);
2806 rb_gc_mark_and_move(&ac->value);
2807 rb_gc_mark_and_move(&ac->file);
2808 rb_gc_mark_and_move(&ac->box_value);
2809}
2810
2811static size_t
2812autoload_const_memsize(const void *ptr)
2813{
2814 return sizeof(struct autoload_const);
2815}
2816
2817static void
2818autoload_const_free(void *ptr)
2819{
2820 struct autoload_const *autoload_const = ptr;
2821
2822 ccan_list_del(&autoload_const->cnode);
2823 SIZED_FREE(autoload_const);
2824}
2825
2826static const rb_data_type_t autoload_const_type = {
2827 "autoload_const",
2828 {autoload_const_mark_and_move, autoload_const_free, autoload_const_memsize, autoload_const_mark_and_move,},
2829 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
2830};
2831
2832static struct autoload_data *
2833get_autoload_data(VALUE autoload_const_value, struct autoload_const **autoload_const_pointer)
2834{
2835 struct autoload_const *autoload_const = rb_check_typeddata(autoload_const_value, &autoload_const_type);
2836
2837 VALUE autoload_data_value = autoload_const->autoload_data_value;
2838 struct autoload_data *autoload_data = rb_check_typeddata(autoload_data_value, &autoload_data_type);
2839
2840 /* do not reach across stack for ->state after forking: */
2841 if (autoload_data && autoload_data->fork_gen != GET_VM()->fork_gen) {
2842 RB_OBJ_WRITE(autoload_data_value, &autoload_data->mutex, Qnil);
2843 autoload_data->fork_gen = 0;
2844 }
2845
2846 if (autoload_const_pointer) *autoload_const_pointer = autoload_const;
2847
2848 return autoload_data;
2849}
2850
2852 VALUE dst_tbl_value;
2853 struct st_table *dst_tbl;
2854 const rb_box_t *box;
2855};
2856
2857static int
2858autoload_copy_table_for_box_i(st_data_t key, st_data_t value, st_data_t arg)
2859{
2861 struct autoload_copy_table_data *data = (struct autoload_copy_table_data *)arg;
2862 struct st_table *tbl = data->dst_tbl;
2863 VALUE tbl_value = data->dst_tbl_value;
2864 const rb_box_t *box = data->box;
2865
2866 VALUE src_value = (VALUE)value;
2867 struct autoload_const *src_const = rb_check_typeddata(src_value, &autoload_const_type);
2868 // autoload_data can be shared between copies because the feature is equal between copies.
2869 VALUE autoload_data_value = src_const->autoload_data_value;
2870 struct autoload_data *autoload_data = rb_check_typeddata(autoload_data_value, &autoload_data_type);
2871
2872 VALUE new_value = TypedData_Make_Struct(0, struct autoload_const, &autoload_const_type, autoload_const);
2873 RB_OBJ_WRITE(new_value, &autoload_const->box_value, rb_get_box_object((rb_box_t *)box));
2874 RB_OBJ_WRITE(new_value, &autoload_const->module, src_const->module);
2875 autoload_const->name = src_const->name;
2876 RB_OBJ_WRITE(new_value, &autoload_const->value, src_const->value);
2877 autoload_const->flag = src_const->flag;
2878 RB_OBJ_WRITE(new_value, &autoload_const->autoload_data_value, autoload_data_value);
2879 ccan_list_add_tail(&autoload_data->constants, &autoload_const->cnode);
2880
2881 st_insert(tbl, (st_data_t)autoload_const->name, (st_data_t)new_value);
2882 RB_OBJ_WRITTEN(tbl_value, Qundef, new_value);
2883
2884 return ST_CONTINUE;
2885}
2886
2887void
2888rb_autoload_copy_table_for_box(st_table *iv_ptr, const rb_box_t *box)
2889{
2890 struct st_table *src_tbl, *dst_tbl;
2891 VALUE src_tbl_value, dst_tbl_value;
2892 if (!rb_st_lookup(iv_ptr, (st_data_t)autoload, (st_data_t *)&src_tbl_value)) {
2893 // the class has no autoload table yet.
2894 return;
2895 }
2896 if (!RTEST(src_tbl_value) || !(src_tbl = check_autoload_table(src_tbl_value))) {
2897 // the __autoload__ ivar value isn't autoload table value.
2898 return;
2899 }
2900 src_tbl = check_autoload_table(src_tbl_value);
2901
2902 dst_tbl_value = TypedData_Wrap_Struct(0, &autoload_table_type, NULL);
2903 RTYPEDDATA_DATA(dst_tbl_value) = dst_tbl = st_init_numtable();
2904
2905 struct autoload_copy_table_data data = {
2906 .dst_tbl_value = dst_tbl_value,
2907 .dst_tbl = dst_tbl,
2908 .box = box,
2909 };
2910
2911 st_foreach(src_tbl, autoload_copy_table_for_box_i, (st_data_t)&data);
2912 st_insert(iv_ptr, (st_data_t)autoload, (st_data_t)dst_tbl_value);
2913}
2914
2915void
2916rb_autoload(VALUE module, ID name, const char *feature)
2917{
2918 if (!feature || !*feature) {
2919 rb_raise(rb_eArgError, "empty feature name");
2920 }
2921
2922 rb_autoload_str(module, name, rb_fstring_cstr(feature));
2923}
2924
2925static void const_set(VALUE klass, ID id, VALUE val);
2926static void const_added(VALUE klass, ID const_name);
2927
2929 VALUE module;
2930 ID name;
2931 VALUE feature;
2932 VALUE box_value;
2933};
2934
2935static VALUE
2936autoload_feature_lookup_or_create(VALUE feature, struct autoload_data **autoload_data_pointer)
2937{
2938 RUBY_ASSERT_MUTEX_OWNED(autoload_mutex);
2939 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
2940
2941 VALUE autoload_data_value = rb_hash_aref(autoload_features, feature);
2943
2944 if (NIL_P(autoload_data_value)) {
2945 autoload_data_value = TypedData_Make_Struct(0, struct autoload_data, &autoload_data_type, autoload_data);
2946 RB_OBJ_WRITE(autoload_data_value, &autoload_data->feature, feature);
2947 RB_OBJ_WRITE(autoload_data_value, &autoload_data->mutex, Qnil);
2948 ccan_list_head_init(&autoload_data->constants);
2949
2950 if (autoload_data_pointer) *autoload_data_pointer = autoload_data;
2951
2952 rb_hash_aset(autoload_features, feature, autoload_data_value);
2953 }
2954 else if (autoload_data_pointer) {
2955 *autoload_data_pointer = rb_check_typeddata(autoload_data_value, &autoload_data_type);
2956 }
2957
2958 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
2959 return autoload_data_value;
2960}
2961
2962static VALUE
2963autoload_table_lookup_or_create(VALUE module)
2964{
2965 VALUE autoload_table_value = rb_ivar_lookup(module, autoload, Qfalse);
2966 if (RTEST(autoload_table_value)) {
2967 return autoload_table_value;
2968 }
2969 else {
2970 autoload_table_value = TypedData_Wrap_Struct(0, &autoload_table_type, NULL);
2971 rb_class_ivar_set(module, autoload, autoload_table_value);
2972 RTYPEDDATA_DATA(autoload_table_value) = st_init_numtable();
2973 return autoload_table_value;
2974 }
2975}
2976
2977static VALUE
2978autoload_synchronized(VALUE _arguments)
2979{
2980 struct autoload_arguments *arguments = (struct autoload_arguments *)_arguments;
2981
2982 rb_const_entry_t *constant_entry = rb_const_lookup(arguments->module, arguments->name);
2983 if (constant_entry && !UNDEF_P(constant_entry->value)) {
2984 return Qfalse;
2985 }
2986
2987 // Reset any state associated with any previous constant:
2988 const_set(arguments->module, arguments->name, Qundef);
2989
2990 VALUE autoload_table_value = autoload_table_lookup_or_create(arguments->module);
2991 struct st_table *autoload_table = check_autoload_table(autoload_table_value);
2992
2993 // Ensure the string is uniqued since we use an identity lookup:
2994 VALUE feature = rb_fstring(arguments->feature);
2995
2997 VALUE autoload_data_value = autoload_feature_lookup_or_create(feature, &autoload_data);
2998
2999 {
3001 VALUE autoload_const_value = TypedData_Make_Struct(0, struct autoload_const, &autoload_const_type, autoload_const);
3002 RB_OBJ_WRITE(autoload_const_value, &autoload_const->box_value, arguments->box_value);
3003 RB_OBJ_WRITE(autoload_const_value, &autoload_const->module, arguments->module);
3004 autoload_const->name = arguments->name;
3005 autoload_const->value = Qundef;
3006 autoload_const->flag = CONST_PUBLIC;
3007 RB_OBJ_WRITE(autoload_const_value, &autoload_const->autoload_data_value, autoload_data_value);
3008 ccan_list_add_tail(&autoload_data->constants, &autoload_const->cnode);
3009 st_insert(autoload_table, (st_data_t)arguments->name, (st_data_t)autoload_const_value);
3010 RB_OBJ_WRITTEN(autoload_table_value, Qundef, autoload_const_value);
3011 }
3012
3013 return Qtrue;
3014}
3015
3016void
3017rb_autoload_str(VALUE module, ID name, VALUE feature)
3018{
3019 const rb_box_t *box = rb_current_box();
3020 VALUE current_box_value = rb_get_box_object((rb_box_t *)box);
3021
3022 if (!rb_is_const_id(name)) {
3023 rb_raise(rb_eNameError, "autoload must be constant name: %"PRIsVALUE"", QUOTE_ID(name));
3024 }
3025
3026 Check_Type(feature, T_STRING);
3027 if (!RSTRING_LEN(feature)) {
3028 rb_raise(rb_eArgError, "empty feature name");
3029 }
3030
3031 struct autoload_arguments arguments = {
3032 .module = module,
3033 .name = name,
3034 .feature = feature,
3035 .box_value = current_box_value,
3036 };
3037
3038 VALUE result = rb_mutex_synchronize(autoload_mutex, autoload_synchronized, (VALUE)&arguments);
3039
3040 if (result == Qtrue) {
3041 const_added(module, name);
3042 }
3043}
3044
3045static void
3046autoload_delete(VALUE module, ID name)
3047{
3048 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
3049
3050 st_data_t load = 0, key = name;
3051
3052 RUBY_ASSERT(RB_TYPE_P(module, T_CLASS) || RB_TYPE_P(module, T_MODULE));
3053
3054 VALUE table_value = rb_ivar_lookup(module, autoload, Qfalse);
3055 if (RTEST(table_value)) {
3056 struct st_table *table = check_autoload_table(table_value);
3057
3058 st_delete(table, &key, &load);
3059 RB_OBJ_WRITTEN(table_value, load, Qundef);
3060
3061 /* Qfalse can indicate already deleted */
3062 if (load != Qfalse) {
3064 struct autoload_data *autoload_data = get_autoload_data((VALUE)load, &autoload_const);
3065
3066 VM_ASSERT(autoload_data);
3067 VM_ASSERT(!ccan_list_empty(&autoload_data->constants));
3068
3069 /*
3070 * we must delete here to avoid "already initialized" warnings
3071 * with parallel autoload. Using list_del_init here so list_del
3072 * works in autoload_const_free
3073 */
3074 ccan_list_del_init(&autoload_const->cnode);
3075
3076 if (ccan_list_empty(&autoload_data->constants)) {
3077 rb_hash_delete(autoload_features, autoload_data->feature);
3078 }
3079
3080 // If the autoload table is empty, we can delete it.
3081 if (table->num_entries == 0) {
3082 rb_attr_delete(module, autoload);
3083 }
3084 }
3085 }
3086
3087 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
3088}
3089
3090static int
3091autoload_by_someone_else(struct autoload_data *ele)
3092{
3093 return ele->mutex != Qnil && !rb_mutex_owned_p(ele->mutex);
3094}
3095
3096static VALUE
3097check_autoload_required(VALUE mod, ID id, const char **loadingpath)
3098{
3099 VALUE autoload_const_value = autoload_data(mod, id);
3101 const char *loading;
3102
3103 if (!autoload_const_value || !(autoload_data = get_autoload_data(autoload_const_value, 0))) {
3104 return 0;
3105 }
3106
3107 VALUE feature = autoload_data->feature;
3108
3109 /*
3110 * if somebody else is autoloading, we MUST wait for them, since
3111 * rb_provide_feature can provide a feature before autoload_const_set
3112 * completes. We must wait until autoload_const_set finishes in
3113 * the other thread.
3114 */
3115 if (autoload_by_someone_else(autoload_data)) {
3116 return autoload_const_value;
3117 }
3118
3119 loading = RSTRING_PTR(feature);
3120
3121 if (!rb_feature_provided(loading, &loading)) {
3122 return autoload_const_value;
3123 }
3124
3125 if (loadingpath && loading) {
3126 *loadingpath = loading;
3127 return autoload_const_value;
3128 }
3129
3130 return 0;
3131}
3132
3133static struct autoload_const *autoloading_const_entry(VALUE mod, ID id);
3134
3135int
3136rb_autoloading_value(VALUE mod, ID id, VALUE* value, rb_const_flag_t *flag)
3137{
3138 struct autoload_const *ac = autoloading_const_entry(mod, id);
3139 if (!ac) return FALSE;
3140
3141 if (value) {
3142 *value = ac->value;
3143 }
3144
3145 if (flag) {
3146 *flag = ac->flag;
3147 }
3148
3149 return TRUE;
3150}
3151
3152static int
3153autoload_by_current(struct autoload_data *ele)
3154{
3155 return ele->mutex != Qnil && rb_mutex_owned_p(ele->mutex);
3156}
3157
3158// If there is an autoloading constant and it has been set by the current
3159// execution context, return it. This allows threads which are loading code to
3160// refer to their own autoloaded constants.
3161struct autoload_const *
3162autoloading_const_entry(VALUE mod, ID id)
3163{
3164 VALUE load = autoload_data(mod, id);
3165 struct autoload_data *ele;
3166 struct autoload_const *ac;
3167
3168 // Find the autoloading state:
3169 if (!load || !(ele = get_autoload_data(load, &ac))) {
3170 // Couldn't be found:
3171 return 0;
3172 }
3173
3174 // Check if it's being loaded by the current thread/fiber:
3175 if (autoload_by_current(ele)) {
3176 if (!UNDEF_P(ac->value)) {
3177 return ac;
3178 }
3179 }
3180
3181 return 0;
3182}
3183
3184static int
3185autoload_defined_p(VALUE mod, ID id)
3186{
3187 rb_const_entry_t *ce = rb_const_lookup(mod, id);
3188
3189 // If there is no constant or the constant is not undefined (special marker for autoloading):
3190 if (!ce || !UNDEF_P(ce->value)) {
3191 // We are not autoloading:
3192 return 0;
3193 }
3194
3195 // Otherwise check if there is an autoload in flight right now:
3196 return !rb_autoloading_value(mod, id, NULL, NULL);
3197}
3198
3199static void const_tbl_update(struct autoload_const *, int);
3200
3202 VALUE module;
3203 ID name;
3204 int flag;
3205
3206 VALUE mutex;
3207
3208 // The specific constant which triggered the autoload code to fire:
3210
3211 // The parent autoload data which is shared between multiple constants:
3213};
3214
3215static VALUE
3216autoload_const_set(struct autoload_const *ac)
3217{
3218 check_before_mod_set(ac->module, ac->name, ac->value, "constant");
3219
3220 RB_VM_LOCKING() {
3221 const_tbl_update(ac, true);
3222 }
3223
3224 return 0; /* ignored */
3225}
3226
3227static VALUE
3228autoload_load_needed(VALUE _arguments)
3229{
3230 struct autoload_load_arguments *arguments = (struct autoload_load_arguments*)_arguments;
3231
3232 const char *loading = 0, *src;
3233
3234 if (!autoload_defined_p(arguments->module, arguments->name)) {
3235 return Qfalse;
3236 }
3237
3238 VALUE autoload_const_value = check_autoload_required(arguments->module, arguments->name, &loading);
3239 if (!autoload_const_value) {
3240 return Qfalse;
3241 }
3242
3243 src = rb_sourcefile();
3244 if (src && loading && strcmp(src, loading) == 0) {
3245 return Qfalse;
3246 }
3247
3250 if (!(autoload_data = get_autoload_data(autoload_const_value, &autoload_const))) {
3251 return Qfalse;
3252 }
3253
3254 if (NIL_P(autoload_data->mutex)) {
3255 RB_OBJ_WRITE(autoload_const->autoload_data_value, &autoload_data->mutex, rb_mutex_new());
3256 autoload_data->fork_gen = GET_VM()->fork_gen;
3257 }
3258 else if (rb_mutex_owned_p(autoload_data->mutex)) {
3259 return Qfalse;
3260 }
3261
3262 arguments->mutex = autoload_data->mutex;
3263 arguments->autoload_const = autoload_const;
3264
3265 return autoload_const_value;
3266}
3267
3268static VALUE
3269autoload_apply_constants(VALUE _arguments)
3270{
3271 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
3272
3273 struct autoload_load_arguments *arguments = (struct autoload_load_arguments*)_arguments;
3274
3275 struct autoload_const *autoload_const = 0; // for ccan_container_off_var()
3276 struct autoload_const *next;
3277
3278 // We use safe iteration here because `autoload_const_set` will eventually invoke
3279 // `autoload_delete` which will remove the constant from the linked list. In theory, once
3280 // the `autoload_data->constants` linked list is empty, we can remove it.
3281
3282 // Iterate over all constants and assign them:
3283 ccan_list_for_each_safe(&arguments->autoload_data->constants, autoload_const, next, cnode) {
3284 if (!UNDEF_P(autoload_const->value)) {
3285 autoload_const_set(autoload_const);
3286 }
3287 }
3288
3289 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
3290
3291 return Qtrue;
3292}
3293
3294static VALUE
3295autoload_feature_require(VALUE _arguments)
3296{
3297 VALUE receiver = rb_vm_top_self();
3298
3299 struct autoload_load_arguments *arguments = (struct autoload_load_arguments*)_arguments;
3300
3301 struct autoload_const *autoload_const = arguments->autoload_const;
3302 VALUE autoload_box_value = autoload_const->box_value;
3303
3304 // We save this for later use in autoload_apply_constants:
3305 arguments->autoload_data = rb_check_typeddata(autoload_const->autoload_data_value, &autoload_data_type);
3306
3307 if (rb_box_available() && BOX_OBJ_P(autoload_box_value))
3308 receiver = autoload_box_value;
3309
3310 /*
3311 * Clear the global cc cache table because the require method can be different from the current
3312 * box's one and it may cause inconsistent cc-cme states.
3313 * For example, the assertion below may fail in gccct_method_search();
3314 * VM_ASSERT(vm_cc_check_cme(cc, rb_callable_method_entry(klass, mid)))
3315 */
3316 rb_gccct_clear_table();
3317
3318 VALUE result = rb_funcall(receiver, rb_intern("require"), 1, arguments->autoload_data->feature);
3319
3320 if (RTEST(result)) {
3321 return rb_mutex_synchronize(autoload_mutex, autoload_apply_constants, _arguments);
3322 }
3323 return result;
3324}
3325
3326static VALUE
3327autoload_try_load(VALUE _arguments)
3328{
3329 struct autoload_load_arguments *arguments = (struct autoload_load_arguments*)_arguments;
3330
3331 VALUE result = autoload_feature_require(_arguments);
3332
3333 // After we loaded the feature, if the constant is not defined, we remove it completely:
3334 rb_const_entry_t *ce = rb_const_lookup(arguments->module, arguments->name);
3335
3336 if (!ce || UNDEF_P(ce->value)) {
3337 result = Qfalse;
3338
3339 rb_const_remove(arguments->module, arguments->name);
3340
3341 if (arguments->module == rb_cObject) {
3342 rb_warning(
3343 "Expected %"PRIsVALUE" to define %"PRIsVALUE" but it didn't",
3344 arguments->autoload_data->feature,
3345 ID2SYM(arguments->name)
3346 );
3347 }
3348 else {
3349 rb_warning(
3350 "Expected %"PRIsVALUE" to define %"PRIsVALUE"::%"PRIsVALUE" but it didn't",
3351 arguments->autoload_data->feature,
3352 arguments->module,
3353 ID2SYM(arguments->name)
3354 );
3355 }
3356 }
3357 else {
3358 // Otherwise, it was loaded, copy the flags from the autoload constant:
3359 ce->flag |= arguments->flag;
3360 }
3361
3362 return result;
3363}
3364
3365VALUE
3367{
3368 rb_const_entry_t *ce = rb_const_lookup(module, name);
3369
3370 // We bail out as early as possible without any synchronisation:
3371 if (!ce || !UNDEF_P(ce->value)) {
3372 return Qfalse;
3373 }
3374
3375 // At this point, we assume there might be autoloading, so fail if it's ractor:
3376 if (UNLIKELY(!rb_ractor_main_p())) {
3377 return rb_ractor_autoload_load(module, name);
3378 }
3379
3380 // This state is stored on the stack and is used during the autoload process.
3381 struct autoload_load_arguments arguments = {.module = module, .name = name, .mutex = Qnil};
3382
3383 // Figure out whether we can autoload the named constant:
3384 VALUE autoload_const_value = rb_mutex_synchronize(autoload_mutex, autoload_load_needed, (VALUE)&arguments);
3385
3386 // This confirms whether autoloading is required or not:
3387 if (autoload_const_value == Qfalse) return autoload_const_value;
3388
3389 arguments.flag = ce->flag & (CONST_DEPRECATED | CONST_VISIBILITY_MASK);
3390
3391 // Only one thread will enter here at a time:
3392 VALUE result = rb_mutex_synchronize(arguments.mutex, autoload_try_load, (VALUE)&arguments);
3393
3394 // If you don't guard this value, it's possible for the autoload constant to
3395 // be freed by another thread which loads multiple constants, one of which
3396 // resolves to the constant this thread is trying to load, so proteect this
3397 // so that it is not freed until we are done with it in `autoload_try_load`:
3398 RB_GC_GUARD(autoload_const_value);
3399
3400 return result;
3401}
3402
3403VALUE
3405{
3406 return rb_autoload_at_p(mod, id, TRUE);
3407}
3408
3409VALUE
3410rb_autoload_at_p(VALUE mod, ID id, int recur)
3411{
3412 VALUE load;
3413 struct autoload_data *ele;
3414
3415 while (!autoload_defined_p(mod, id)) {
3416 if (!recur) return Qnil;
3417 mod = RCLASS_SUPER(mod);
3418 if (!mod) return Qnil;
3419 }
3420 load = check_autoload_required(mod, id, 0);
3421 if (!load) return Qnil;
3422 return (ele = get_autoload_data(load, 0)) ? ele->feature : Qnil;
3423}
3424
3425void
3426rb_const_warn_if_deprecated(const rb_const_entry_t *ce, VALUE klass, ID id)
3427{
3428 if (RB_CONST_DEPRECATED_P(ce) &&
3429 rb_warning_category_enabled_p(RB_WARN_CATEGORY_DEPRECATED)) {
3430 if (klass == rb_cObject) {
3431 rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "constant ::%"PRIsVALUE" is deprecated", QUOTE_ID(id));
3432 }
3433 else {
3434 rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "constant %"PRIsVALUE"::%"PRIsVALUE" is deprecated",
3435 rb_class_name(klass), QUOTE_ID(id));
3436 }
3437 }
3438}
3439
3440static VALUE
3441rb_const_get_0(VALUE klass, ID id, int exclude, int recurse, int visibility)
3442{
3443 VALUE found_in;
3444 VALUE c = rb_const_search(klass, id, exclude, recurse, visibility, &found_in);
3445 if (!UNDEF_P(c)) {
3446 if (UNLIKELY(!rb_ractor_main_p())) {
3447 if (!rb_ractor_shareable_p(c)) {
3448 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));
3449 }
3450 }
3451 return c;
3452 }
3453 return rb_const_missing(klass, ID2SYM(id));
3454}
3455
3456static VALUE
3457rb_const_search_from(VALUE klass, ID id, int exclude, int recurse, int visibility, VALUE *found_in)
3458{
3459 VALUE value, current;
3460 bool first_iteration = true;
3461
3462 for (current = klass;
3463 RTEST(current);
3464 current = RCLASS_SUPER(current), first_iteration = false) {
3465 VALUE tmp;
3466 VALUE am = 0;
3467 rb_const_entry_t *ce;
3468
3469 if (!first_iteration && RCLASS_ORIGIN(current) != current) {
3470 // This item in the super chain has an origin iclass
3471 // that comes later in the chain. Skip this item so
3472 // prepended modules take precedence.
3473 continue;
3474 }
3475
3476 // Do lookup in original class or module in case we are at an origin
3477 // iclass in the chain.
3478 tmp = current;
3479 if (BUILTIN_TYPE(tmp) == T_ICLASS) tmp = RBASIC(tmp)->klass;
3480
3481 // Do the lookup. Loop in case of autoload.
3482 while ((ce = rb_const_lookup(tmp, id))) {
3483 if (visibility && RB_CONST_PRIVATE_P(ce)) {
3484 GET_EC()->private_const_reference = tmp;
3485 return Qundef;
3486 }
3487 rb_const_warn_if_deprecated(ce, tmp, id);
3488 value = ce->value;
3489 if (UNDEF_P(value)) {
3490 struct autoload_const *ac;
3491 if (am == tmp) break;
3492 am = tmp;
3493 ac = autoloading_const_entry(tmp, id);
3494 if (ac) {
3495 if (found_in) { *found_in = tmp; }
3496 return ac->value;
3497 }
3498 rb_autoload_load(tmp, id);
3499 continue;
3500 }
3501 if (exclude && tmp == rb_cObject) {
3502 goto not_found;
3503 }
3504 if (found_in) { *found_in = tmp; }
3505 return value;
3506 }
3507 if (!recurse) break;
3508 }
3509
3510 not_found:
3511 GET_EC()->private_const_reference = 0;
3512 return Qundef;
3513}
3514
3515static VALUE
3516rb_const_search(VALUE klass, ID id, int exclude, int recurse, int visibility, VALUE *found_in)
3517{
3518 VALUE value;
3519
3520 if (klass == rb_cObject) exclude = FALSE;
3521 value = rb_const_search_from(klass, id, exclude, recurse, visibility, found_in);
3522 if (!UNDEF_P(value)) return value;
3523 if (exclude) return value;
3524 if (BUILTIN_TYPE(klass) != T_MODULE) return value;
3525 /* search global const too, if klass is a module */
3526 return rb_const_search_from(rb_cObject, id, FALSE, recurse, visibility, found_in);
3527}
3528
3529VALUE
3531{
3532 return rb_const_get_0(klass, id, TRUE, TRUE, FALSE);
3533}
3534
3535VALUE
3537{
3538 return rb_const_get_0(klass, id, FALSE, TRUE, FALSE);
3539}
3540
3541VALUE
3543{
3544 return rb_const_get_0(klass, id, TRUE, FALSE, FALSE);
3545}
3546
3547VALUE
3548rb_public_const_get_from(VALUE klass, ID id)
3549{
3550 return rb_const_get_0(klass, id, TRUE, TRUE, TRUE);
3551}
3552
3553VALUE
3554rb_public_const_get_at(VALUE klass, ID id)
3555{
3556 return rb_const_get_0(klass, id, TRUE, FALSE, TRUE);
3557}
3558
3559NORETURN(static void undefined_constant(VALUE mod, VALUE name));
3560static void
3561undefined_constant(VALUE mod, VALUE name)
3562{
3563 rb_name_err_raise("constant %2$s::%1$s not defined",
3564 mod, name);
3565}
3566
3567static VALUE
3568rb_const_location_from(VALUE klass, ID id, int exclude, int recurse, int visibility)
3569{
3570 while (RTEST(klass)) {
3571 rb_const_entry_t *ce;
3572
3573 while ((ce = rb_const_lookup(klass, id))) {
3574 if (visibility && RB_CONST_PRIVATE_P(ce)) {
3575 return Qnil;
3576 }
3577 if (exclude && klass == rb_cObject) {
3578 goto not_found;
3579 }
3580
3581 if (UNDEF_P(ce->value)) { // autoload
3582 VALUE autoload_const_value = autoload_data(klass, id);
3583 if (RTEST(autoload_const_value)) {
3585 struct autoload_data *autoload_data = get_autoload_data(autoload_const_value, &autoload_const);
3586
3587 if (!UNDEF_P(autoload_const->value) && RTEST(rb_mutex_owned_p(autoload_data->mutex))) {
3588 return rb_assoc_new(autoload_const->file, INT2NUM(autoload_const->line));
3589 }
3590 }
3591 }
3592
3593 if (NIL_P(ce->file)) return rb_ary_new();
3594 return rb_assoc_new(ce->file, INT2NUM(ce->line));
3595 }
3596 if (!recurse) break;
3597 klass = RCLASS_SUPER(klass);
3598 }
3599
3600 not_found:
3601 return Qnil;
3602}
3603
3604static VALUE
3605rb_const_location(VALUE klass, ID id, int exclude, int recurse, int visibility)
3606{
3607 VALUE loc;
3608
3609 if (klass == rb_cObject) exclude = FALSE;
3610 loc = rb_const_location_from(klass, id, exclude, recurse, visibility);
3611 if (!NIL_P(loc)) return loc;
3612 if (exclude) return loc;
3613 if (BUILTIN_TYPE(klass) != T_MODULE) return loc;
3614 /* search global const too, if klass is a module */
3615 return rb_const_location_from(rb_cObject, id, FALSE, recurse, visibility);
3616}
3617
3618VALUE
3619rb_const_source_location(VALUE klass, ID id)
3620{
3621 return rb_const_location(klass, id, FALSE, TRUE, FALSE);
3622}
3623
3624VALUE
3625rb_const_source_location_at(VALUE klass, ID id)
3626{
3627 return rb_const_location(klass, id, TRUE, FALSE, FALSE);
3628}
3629
3630/*
3631 * call-seq:
3632 * remove_const(sym) -> obj
3633 *
3634 * Removes the definition of the given constant, returning that
3635 * constant's previous value. If that constant referred to
3636 * a module, this will not change that module's name and can lead
3637 * to confusion.
3638 */
3639
3640VALUE
3642{
3643 const ID id = id_for_var(mod, name, a, constant);
3644
3645 if (!id) {
3646 undefined_constant(mod, name);
3647 }
3648 return rb_const_remove(mod, id);
3649}
3650
3651static rb_const_entry_t * const_lookup(struct rb_id_table *tbl, ID id);
3652
3653VALUE
3655{
3656 VALUE val;
3657 rb_const_entry_t *ce;
3658
3659 rb_check_frozen(mod);
3660
3661 ce = rb_const_lookup(mod, id);
3662
3663 if (!ce) {
3664 if (rb_const_defined_at(mod, id)) {
3665 rb_name_err_raise("cannot remove %2$s::%1$s", mod, ID2SYM(id));
3666 }
3667
3668 undefined_constant(mod, ID2SYM(id));
3669 }
3670
3671 VALUE writable_ce = 0;
3672 if (rb_id_table_lookup(RCLASS_WRITABLE_CONST_TBL(mod), id, &writable_ce)) {
3673 rb_id_table_delete(RCLASS_WRITABLE_CONST_TBL(mod), id);
3674 if ((rb_const_entry_t *)writable_ce != ce) {
3675 SIZED_FREE((rb_const_entry_t *)writable_ce);
3676 }
3677 }
3678
3679 rb_const_warn_if_deprecated(ce, mod, id);
3681
3682 val = ce->value;
3683
3684 if (UNDEF_P(val)) {
3685 autoload_delete(mod, id);
3686 val = Qnil;
3687 }
3688
3689 if (ce != const_lookup(RCLASS_PRIME_CONST_TBL(mod), id)) {
3690 SIZED_FREE(ce);
3691 }
3692 // else - skip free'ing the ce because it still exists in the prime classext
3693
3694 return val;
3695}
3696
3697static int
3698cv_i_update(st_data_t *k, st_data_t *v, st_data_t a, int existing)
3699{
3700 if (existing) return ST_STOP;
3701 *v = a;
3702 return ST_CONTINUE;
3703}
3704
3705static enum rb_id_table_iterator_result
3706sv_i(ID key, VALUE v, void *a)
3707{
3709 st_table *tbl = a;
3710
3711 if (rb_is_const_id(key)) {
3712 st_update(tbl, (st_data_t)key, cv_i_update, (st_data_t)ce);
3713 }
3714 return ID_TABLE_CONTINUE;
3715}
3716
3717static enum rb_id_table_iterator_result
3718rb_local_constants_i(ID const_name, VALUE const_value, void *ary)
3719{
3720 if (rb_is_const_id(const_name) && !RB_CONST_PRIVATE_P((rb_const_entry_t *)const_value)) {
3721 rb_ary_push((VALUE)ary, ID2SYM(const_name));
3722 }
3723 return ID_TABLE_CONTINUE;
3724}
3725
3726static VALUE
3727rb_local_constants(VALUE mod)
3728{
3729 struct rb_id_table *tbl = RCLASS_CONST_TBL(mod);
3730 VALUE ary;
3731
3732 if (!tbl) return rb_ary_new2(0);
3733
3734 RB_VM_LOCKING() {
3735 ary = rb_ary_new2(rb_id_table_size(tbl));
3736 rb_id_table_foreach(tbl, rb_local_constants_i, (void *)ary);
3737 }
3738
3739 return ary;
3740}
3741
3742void*
3743rb_mod_const_at(VALUE mod, void *data)
3744{
3745 st_table *tbl = data;
3746 if (!tbl) {
3747 tbl = st_init_numtable();
3748 }
3749 if (RCLASS_CONST_TBL(mod)) {
3750 RB_VM_LOCKING() {
3751 rb_id_table_foreach(RCLASS_CONST_TBL(mod), sv_i, tbl);
3752 }
3753 }
3754 return tbl;
3755}
3756
3757void*
3758rb_mod_const_of(VALUE mod, void *data)
3759{
3760 VALUE tmp = mod;
3761 for (;;) {
3762 data = rb_mod_const_at(tmp, data);
3763 tmp = RCLASS_SUPER(tmp);
3764 if (!tmp) break;
3765 if (tmp == rb_cObject && mod != rb_cObject) break;
3766 }
3767 return data;
3768}
3769
3770static int
3771list_i(st_data_t key, st_data_t value, VALUE ary)
3772{
3773 ID sym = (ID)key;
3774 rb_const_entry_t *ce = (rb_const_entry_t *)value;
3775 if (RB_CONST_PUBLIC_P(ce)) rb_ary_push(ary, ID2SYM(sym));
3776 return ST_CONTINUE;
3777}
3778
3779VALUE
3780rb_const_list(void *data)
3781{
3782 st_table *tbl = data;
3783 VALUE ary;
3784
3785 if (!tbl) return rb_ary_new2(0);
3786 ary = rb_ary_new2(tbl->num_entries);
3787 st_foreach_safe(tbl, list_i, ary);
3788 st_free_table(tbl);
3789
3790 return ary;
3791}
3792
3793/*
3794 * call-seq:
3795 * mod.constants(inherit=true) -> array
3796 *
3797 * Returns an array of the names of the constants accessible in
3798 * <i>mod</i>. This includes the names of constants in any included
3799 * modules (example at start of section), unless the <i>inherit</i>
3800 * parameter is set to <code>false</code>.
3801 *
3802 * The implementation makes no guarantees about the order in which the
3803 * constants are yielded.
3804 *
3805 * IO.constants.include?(:SYNC) #=> true
3806 * IO.constants(false).include?(:SYNC) #=> false
3807 *
3808 * Also see Module#const_defined?.
3809 */
3810
3811VALUE
3812rb_mod_constants(int argc, const VALUE *argv, VALUE mod)
3813{
3814 bool inherit = true;
3815
3816 if (rb_check_arity(argc, 0, 1)) inherit = RTEST(argv[0]);
3817
3818 if (inherit) {
3819 return rb_const_list(rb_mod_const_of(mod, 0));
3820 }
3821 else {
3822 return rb_local_constants(mod);
3823 }
3824}
3825
3826static int
3827rb_const_defined_0(VALUE klass, ID id, int exclude, int recurse, int visibility)
3828{
3829 VALUE tmp;
3830 int mod_retry = 0;
3831 rb_const_entry_t *ce;
3832
3833 tmp = klass;
3834 retry:
3835 while (tmp) {
3836 if ((ce = rb_const_lookup(tmp, id))) {
3837 if (visibility && RB_CONST_PRIVATE_P(ce)) {
3838 return (int)Qfalse;
3839 }
3840 if (UNDEF_P(ce->value) && !check_autoload_required(tmp, id, 0) &&
3841 !rb_autoloading_value(tmp, id, NULL, NULL))
3842 return (int)Qfalse;
3843
3844 if (exclude && tmp == rb_cObject && klass != rb_cObject) {
3845 return (int)Qfalse;
3846 }
3847
3848 return (int)Qtrue;
3849 }
3850 if (!recurse) break;
3851 tmp = RCLASS_SUPER(tmp);
3852 }
3853 if (!exclude && !mod_retry && BUILTIN_TYPE(klass) == T_MODULE) {
3854 mod_retry = 1;
3855 tmp = rb_cObject;
3856 goto retry;
3857 }
3858 return (int)Qfalse;
3859}
3860
3861int
3863{
3864 return rb_const_defined_0(klass, id, TRUE, TRUE, FALSE);
3865}
3866
3867int
3869{
3870 return rb_const_defined_0(klass, id, FALSE, TRUE, FALSE);
3871}
3872
3873int
3875{
3876 return rb_const_defined_0(klass, id, TRUE, FALSE, FALSE);
3877}
3878
3879int
3880rb_public_const_defined_from(VALUE klass, ID id)
3881{
3882 return rb_const_defined_0(klass, id, TRUE, TRUE, TRUE);
3883}
3884
3885static void
3886check_before_mod_set(VALUE klass, ID id, VALUE val, const char *dest)
3887{
3888 rb_check_frozen(klass);
3889}
3890
3891static void set_namespace_path(VALUE named_namespace, VALUE name);
3892
3893static enum rb_id_table_iterator_result
3894set_namespace_path_i(ID id, VALUE v, void *payload)
3895{
3897 VALUE value = ce->value;
3898 VALUE parental_path = *((VALUE *) payload);
3899 if (!rb_is_const_id(id) || !rb_namespace_p(value)) {
3900 return ID_TABLE_CONTINUE;
3901 }
3902
3903 bool has_permanent_classpath;
3904 classname(value, &has_permanent_classpath);
3905 if (has_permanent_classpath) {
3906 return ID_TABLE_CONTINUE;
3907 }
3908 set_namespace_path(value, build_const_path(parental_path, id));
3909
3910 if (!RCLASS_PERMANENT_CLASSPATH_P(value)) {
3911 RCLASS_WRITE_CLASSPATH(value, 0, false);
3912 }
3913
3914 return ID_TABLE_CONTINUE;
3915}
3916
3917/*
3918 * Assign permanent classpaths to all namespaces that are directly or indirectly
3919 * nested under +named_namespace+. +named_namespace+ must have a permanent
3920 * classpath.
3921 */
3922static void
3923set_namespace_path(VALUE named_namespace, VALUE namespace_path)
3924{
3925 struct rb_id_table *const_table = RCLASS_CONST_TBL(named_namespace);
3926 RB_OBJ_SET_SHAREABLE(namespace_path);
3927
3928 RB_VM_LOCKING() {
3929 RCLASS_WRITE_CLASSPATH(named_namespace, namespace_path, true);
3930
3931 if (const_table) {
3932 rb_id_table_foreach(const_table, set_namespace_path_i, &namespace_path);
3933 }
3934 }
3935}
3936
3937static void
3938const_added(VALUE klass, ID const_name)
3939{
3940 if (GET_VM()->running) {
3941 VALUE name = ID2SYM(const_name);
3942 rb_funcallv(klass, idConst_added, 1, &name);
3943 }
3944}
3945
3946static void
3947const_set(VALUE klass, ID id, VALUE val)
3948{
3949 rb_const_entry_t *ce;
3950
3951 if (NIL_P(klass)) {
3952 rb_raise(rb_eTypeError, "no class/module to define constant %"PRIsVALUE"",
3953 QUOTE_ID(id));
3954 }
3955
3956 if (!rb_ractor_main_p() && !rb_ractor_shareable_p(val)) {
3957 rb_raise(rb_eRactorIsolationError, "can not set constants with non-shareable objects by non-main Ractors");
3958 }
3959
3960 check_before_mod_set(klass, id, val, "constant");
3961
3962 RB_VM_LOCKING() {
3963 struct rb_id_table *tbl = RCLASS_WRITABLE_CONST_TBL(klass);
3964 if (!tbl) {
3965 tbl = rb_id_table_create(0);
3966 RCLASS_WRITE_CONST_TBL(klass, tbl, false);
3969 rb_id_table_insert(tbl, id, (VALUE)ce);
3970 setup_const_entry(ce, klass, val, CONST_PUBLIC);
3971 }
3972 else {
3973 struct autoload_const ac = {
3974 .module = klass, .name = id,
3975 .value = val, .flag = CONST_PUBLIC,
3976 /* fill the rest with 0 */
3977 };
3978 ac.file = rb_source_location(&ac.line);
3979 const_tbl_update(&ac, false);
3980 }
3981 }
3982
3983 /*
3984 * Resolve and cache class name immediately to resolve ambiguity
3985 * and avoid order-dependency on const_tbl
3986 */
3987 if (rb_cObject && rb_namespace_p(val)) {
3988 bool val_path_permanent;
3989 VALUE val_path = classname(val, &val_path_permanent);
3990 if (NIL_P(val_path) || !val_path_permanent) {
3991 if (klass == rb_cObject) {
3992 set_namespace_path(val, rb_id2str(id));
3993 }
3994 else {
3995 bool parental_path_permanent;
3996 VALUE parental_path = classname(klass, &parental_path_permanent);
3997 if (NIL_P(parental_path)) {
3998 bool throwaway;
3999 parental_path = rb_tmp_class_path(klass, &throwaway, make_temporary_path);
4000 }
4001 if (parental_path_permanent && !val_path_permanent) {
4002 set_namespace_path(val, build_const_path(parental_path, id));
4003 }
4004 else if (!parental_path_permanent && NIL_P(val_path)) {
4005 VALUE path = build_const_path(parental_path, id);
4006 RCLASS_SET_CLASSPATH(val, path, false);
4007 }
4008 }
4009 }
4010 }
4011}
4012
4013void
4015{
4016 const_set(klass, id, val);
4017 const_added(klass, id);
4018}
4019
4020static VALUE
4021autoload_const_value_for_named_constant(VALUE module, ID name, struct autoload_const **autoload_const_pointer)
4022{
4023 VALUE autoload_const_value = autoload_data(module, name);
4024 if (!autoload_const_value) return Qfalse;
4025
4026 struct autoload_data *autoload_data = get_autoload_data(autoload_const_value, autoload_const_pointer);
4027 if (!autoload_data) return Qfalse;
4028
4029 /* for autoloading thread, keep the defined value to autoloading storage */
4030 if (autoload_by_current(autoload_data)) {
4031 return autoload_const_value;
4032 }
4033
4034 return Qfalse;
4035}
4036
4037static void
4038const_tbl_update(struct autoload_const *ac, int autoload_force)
4039{
4040 VALUE value;
4041 VALUE klass = ac->module;
4042 VALUE val = ac->value;
4043 ID id = ac->name;
4044 struct rb_id_table *tbl = RCLASS_CONST_TBL(klass);
4045 rb_const_flag_t visibility = ac->flag;
4046 rb_const_entry_t *ce;
4047
4048 if (rb_id_table_lookup(tbl, id, &value)) {
4049 ce = (rb_const_entry_t *)value;
4050 if (UNDEF_P(ce->value)) {
4051 RUBY_ASSERT_CRITICAL_SECTION_ENTER();
4052 VALUE file = ac->file;
4053 int line = ac->line;
4054 VALUE autoload_const_value = autoload_const_value_for_named_constant(klass, id, &ac);
4055
4056 if (!autoload_force && autoload_const_value) {
4058
4059 RB_OBJ_WRITE(autoload_const_value, &ac->value, val);
4060 RB_OBJ_WRITE(autoload_const_value, &ac->file, rb_source_location(&ac->line));
4061 }
4062 else {
4063 /* otherwise autoloaded constant, allow to override */
4064 autoload_delete(klass, id);
4065 ce->flag = visibility;
4066 RB_OBJ_WRITE(klass, &ce->value, val);
4067 RB_OBJ_WRITE(klass, &ce->file, file);
4068 ce->line = line;
4069 }
4070 RUBY_ASSERT_CRITICAL_SECTION_LEAVE();
4071 return;
4072 }
4073 else {
4074 VALUE name = QUOTE_ID(id);
4075 visibility = ce->flag;
4076
4077 VALUE previous = Qnil;
4078 if (!NIL_P(ce->file) && ce->line) {
4079 previous = rb_sprintf("\n%"PRIsVALUE":%d: warning: previous definition of %"PRIsVALUE" was here", ce->file, ce->line, name);
4080 }
4081
4082 if (klass == rb_cObject)
4083 rb_warn("already initialized constant %"PRIsVALUE"%"PRIsVALUE"", name, previous);
4084 else
4085 rb_warn("already initialized constant %"PRIsVALUE"::%"PRIsVALUE"%"PRIsVALUE"",
4086 rb_class_name(klass), name, previous);
4087 }
4089 setup_const_entry(ce, klass, val, visibility);
4090 }
4091 else {
4092 tbl = RCLASS_WRITABLE_CONST_TBL(klass);
4094
4096 rb_id_table_insert(tbl, id, (VALUE)ce);
4097 setup_const_entry(ce, klass, val, visibility);
4098 }
4099}
4100
4101static void
4102setup_const_entry(rb_const_entry_t *ce, VALUE klass, VALUE val,
4103 rb_const_flag_t visibility)
4104{
4105 ce->flag = visibility;
4106 RB_OBJ_WRITE(klass, &ce->value, val);
4107 RB_OBJ_WRITE(klass, &ce->file, rb_source_location(&ce->line));
4108}
4109
4110void
4111rb_define_const(VALUE klass, const char *name, VALUE val)
4112{
4113 ID id = rb_intern(name);
4114
4115 if (!rb_is_const_id(id)) {
4116 rb_warn("rb_define_const: invalid name '%s' for constant", name);
4117 }
4118 if (!RB_SPECIAL_CONST_P(val)) {
4119 rb_vm_register_global_object(val);
4120 }
4121 rb_const_set(klass, id, val);
4122}
4123
4124void
4125rb_define_global_const(const char *name, VALUE val)
4126{
4127 rb_define_const(rb_cObject, name, val);
4128}
4129
4130static void
4131set_const_visibility(VALUE mod, int argc, const VALUE *argv,
4132 rb_const_flag_t flag, rb_const_flag_t mask)
4133{
4134 int i;
4135 rb_const_entry_t *ce;
4136 ID id;
4137
4139 if (argc == 0) {
4140 rb_warning("%"PRIsVALUE" with no argument is just ignored",
4141 QUOTE_ID(rb_frame_callee()));
4142 return;
4143 }
4144
4145 for (i = 0; i < argc; i++) {
4146 struct autoload_const *ac;
4147 VALUE val = argv[i];
4148 id = rb_check_id(&val);
4149 if (!id) {
4150 undefined_constant(mod, val);
4151 }
4152 if ((ce = rb_const_lookup(mod, id))) {
4153 ce->flag &= ~mask;
4154 ce->flag |= flag;
4155 if (UNDEF_P(ce->value)) {
4156 if (autoload_const_value_for_named_constant(mod, id, &ac)) {
4157 ac->flag &= ~mask;
4158 ac->flag |= flag;
4159 }
4160 }
4162 }
4163 else {
4164 undefined_constant(mod, ID2SYM(id));
4165 }
4166 }
4167}
4168
4169void
4170rb_deprecate_constant(VALUE mod, const char *name)
4171{
4172 rb_const_entry_t *ce;
4173 ID id;
4174 long len = strlen(name);
4175
4177 if (!(id = rb_check_id_cstr(name, len, NULL))) {
4178 undefined_constant(mod, rb_fstring_new(name, len));
4179 }
4180 if (!(ce = rb_const_lookup(mod, id))) {
4181 undefined_constant(mod, ID2SYM(id));
4182 }
4183 ce->flag |= CONST_DEPRECATED;
4184}
4185
4186/*
4187 * call-seq:
4188 * mod.private_constant(symbol, ...) => mod
4189 *
4190 * Makes a list of existing constants private.
4191 */
4192
4193VALUE
4194rb_mod_private_constant(int argc, const VALUE *argv, VALUE obj)
4195{
4196 set_const_visibility(obj, argc, argv, CONST_PRIVATE, CONST_VISIBILITY_MASK);
4197 return obj;
4198}
4199
4200/*
4201 * call-seq:
4202 * mod.public_constant(symbol, ...) => mod
4203 *
4204 * Makes a list of existing constants public.
4205 */
4206
4207VALUE
4208rb_mod_public_constant(int argc, const VALUE *argv, VALUE obj)
4209{
4210 set_const_visibility(obj, argc, argv, CONST_PUBLIC, CONST_VISIBILITY_MASK);
4211 return obj;
4212}
4213
4214/*
4215 * call-seq:
4216 * mod.deprecate_constant(symbol, ...) => mod
4217 *
4218 * Makes a list of existing constants deprecated. Attempt
4219 * to refer to them will produce a warning.
4220 *
4221 * module HTTP
4222 * NotFound = Exception.new
4223 * NOT_FOUND = NotFound # previous version of the library used this name
4224 *
4225 * deprecate_constant :NOT_FOUND
4226 * end
4227 *
4228 * HTTP::NOT_FOUND
4229 * # warning: constant HTTP::NOT_FOUND is deprecated
4230 *
4231 */
4232
4233VALUE
4234rb_mod_deprecate_constant(int argc, const VALUE *argv, VALUE obj)
4235{
4236 set_const_visibility(obj, argc, argv, CONST_DEPRECATED, CONST_DEPRECATED);
4237 return obj;
4238}
4239
4240static VALUE
4241original_module(VALUE c)
4242{
4243 if (RB_TYPE_P(c, T_ICLASS))
4244 return RBASIC(c)->klass;
4245 return c;
4246}
4247
4248static int
4249cvar_lookup_at(VALUE klass, ID id, st_data_t *v)
4250{
4251 if (RB_TYPE_P(klass, T_ICLASS)) {
4252 if (RICLASS_IS_ORIGIN_P(klass)) {
4253 return 0;
4254 }
4255 else {
4256 // check the original module
4257 klass = RBASIC(klass)->klass;
4258 }
4259 }
4260
4261 VALUE n = rb_ivar_lookup(klass, id, Qundef);
4262 if (UNDEF_P(n)) return 0;
4263
4264 if (v) *v = n;
4265 return 1;
4266}
4267
4268static VALUE
4269cvar_front_klass(VALUE klass)
4270{
4271 if (RCLASS_SINGLETON_P(klass)) {
4272 VALUE obj = RCLASS_ATTACHED_OBJECT(klass);
4273 if (rb_namespace_p(obj)) {
4274 return obj;
4275 }
4276 }
4277 return RCLASS_SUPER(klass);
4278}
4279
4280static void
4281cvar_overtaken(VALUE front, VALUE target, ID id)
4282{
4283 if (front && target != front) {
4284 if (original_module(front) != original_module(target)) {
4285 rb_raise(rb_eRuntimeError,
4286 "class variable % "PRIsVALUE" of %"PRIsVALUE" is overtaken by %"PRIsVALUE"",
4287 ID2SYM(id), rb_class_name(original_module(front)),
4288 rb_class_name(original_module(target)));
4289 }
4290 if (BUILTIN_TYPE(front) == T_CLASS) {
4291 rb_ivar_delete(front, id, Qundef);
4292 }
4293 }
4294}
4295
4296#define CVAR_FOREACH_ANCESTORS(klass, v, r) \
4297 for (klass = cvar_front_klass(klass); klass; klass = RCLASS_SUPER(klass)) { \
4298 if (cvar_lookup_at(klass, id, (v))) { \
4299 r; \
4300 } \
4301 }
4302
4303#define CVAR_LOOKUP(v,r) do {\
4304 if (cvar_lookup_at(klass, id, (v))) {r;}\
4305 CVAR_FOREACH_ANCESTORS(klass, v, r);\
4306} while(0)
4307
4308static VALUE
4309find_cvar(VALUE klass, VALUE * front, VALUE * target, ID id)
4310{
4311 VALUE v = Qundef;
4312 CVAR_LOOKUP(&v, {
4313 if (!*front) {
4314 *front = klass;
4315 }
4316 *target = klass;
4317 });
4318
4319 return v;
4320}
4321
4322void
4323rb_cvar_set(VALUE klass, ID id, VALUE val)
4324{
4325 CVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(klass, id);
4326
4327 VALUE tmp, front = 0, target = 0;
4328
4329 tmp = klass;
4330 CVAR_LOOKUP(0, {if (!front) front = klass; target = klass;});
4331 if (target) {
4332 cvar_overtaken(front, target, id);
4333 }
4334 else {
4335 target = tmp;
4336 }
4337
4338 if (RB_TYPE_P(target, T_ICLASS)) {
4339 target = RBASIC(target)->klass;
4340 }
4341 check_before_mod_set(target, id, val, "class variable");
4342
4343 bool new_cvar = rb_class_ivar_set(target, id, val);
4344
4345 VALUE cvc_tbl = RCLASS_WRITABLE_CVC_TBL(target);
4346
4347 struct rb_cvar_class_tbl_entry *ent;
4348 VALUE ent_data;
4349
4350 if (!cvc_tbl || !rb_marked_id_table_lookup(cvc_tbl, id, &ent_data)) {
4351 ent = (struct rb_cvar_class_tbl_entry *)SHAREABLE_IMEMO_NEW(struct rb_cvar_class_tbl_entry, imemo_cvar_entry, 0);
4352 RB_OBJ_WRITE((VALUE)ent, &ent->class_value, target);
4353 RB_OBJ_WRITE((VALUE)ent, &ent->cref, 0);
4354 ent->global_cvar_state = GET_GLOBAL_CVAR_STATE();
4355
4356 VALUE new_cvc_tbl = cvc_tbl;
4357 if (!new_cvc_tbl) {
4358 new_cvc_tbl = rb_marked_id_table_new(2);
4359 }
4360 else if (rb_multi_ractor_p()) {
4361 new_cvc_tbl = rb_marked_id_table_new(rb_marked_id_table_size(cvc_tbl) + 1);
4362 }
4363
4364 rb_marked_id_table_insert(new_cvc_tbl, id, (VALUE)ent);
4365 if (new_cvc_tbl != cvc_tbl) {
4366 RCLASS_WRITE_CVC_TBL(target, new_cvc_tbl);
4367 }
4368 RB_DEBUG_COUNTER_INC(cvar_inline_miss);
4369 }
4370 else {
4371 ent = (void *)ent_data;
4372 ent->global_cvar_state = GET_GLOBAL_CVAR_STATE();
4373 }
4374
4375 // Break the cvar cache if this is a new class variable.
4376 // Existing caches may have resolved this name to a different
4377 // location in the hierarchy, so we must invalidate globally.
4378 if (new_cvar) {
4379 ruby_vm_global_cvar_state++;
4380 }
4381}
4382
4383VALUE
4384rb_cvar_find(VALUE klass, ID id, VALUE *front)
4385{
4386 VALUE target = 0;
4387 VALUE value;
4388
4389 value = find_cvar(klass, front, &target, id);
4390 if (!target) {
4391 rb_name_err_raise("uninitialized class variable %1$s in %2$s",
4392 klass, ID2SYM(id));
4393 }
4394 cvar_overtaken(*front, target, id);
4395 cvar_read_ractor_check(klass, id, value);
4396 return (VALUE)value;
4397}
4398
4399VALUE
4401{
4402 VALUE front = 0;
4403 return rb_cvar_find(klass, id, &front);
4404}
4405
4406VALUE
4408{
4409 if (!klass) return Qfalse;
4410 CVAR_LOOKUP(0,return Qtrue);
4411 return Qfalse;
4412}
4413
4414static ID
4415cv_intern(VALUE klass, const char *name)
4416{
4417 ID id = rb_intern(name);
4418 if (!rb_is_class_id(id)) {
4419 rb_name_err_raise("wrong class variable name %1$s",
4420 klass, rb_str_new_cstr(name));
4421 }
4422 return id;
4423}
4424
4425void
4426rb_cv_set(VALUE klass, const char *name, VALUE val)
4427{
4428 ID id = cv_intern(klass, name);
4429 rb_cvar_set(klass, id, val);
4430}
4431
4432VALUE
4433rb_cv_get(VALUE klass, const char *name)
4434{
4435 ID id = cv_intern(klass, name);
4436 return rb_cvar_get(klass, id);
4437}
4438
4439void
4440rb_define_class_variable(VALUE klass, const char *name, VALUE val)
4441{
4442 rb_cv_set(klass, name, val);
4443}
4444
4445static int
4446cv_i(ID key, VALUE v, st_data_t a)
4447{
4448 st_table *tbl = (st_table *)a;
4449
4450 if (rb_is_class_id(key)) {
4451 st_update(tbl, (st_data_t)key, cv_i_update, 0);
4452 }
4453 return ST_CONTINUE;
4454}
4455
4456static void*
4457mod_cvar_at(VALUE mod, void *data)
4458{
4459 st_table *tbl = data;
4460 if (!tbl) {
4461 tbl = st_init_numtable();
4462 }
4463 mod = original_module(mod);
4464
4465 rb_ivar_foreach(mod, cv_i, (st_data_t)tbl);
4466 return tbl;
4467}
4468
4469static void*
4470mod_cvar_of(VALUE mod, void *data)
4471{
4472 VALUE tmp = mod;
4473 if (RCLASS_SINGLETON_P(mod)) {
4474 if (rb_namespace_p(RCLASS_ATTACHED_OBJECT(mod))) {
4475 data = mod_cvar_at(tmp, data);
4476 tmp = cvar_front_klass(tmp);
4477 }
4478 }
4479 for (;;) {
4480 data = mod_cvar_at(tmp, data);
4481 tmp = RCLASS_SUPER(tmp);
4482 if (!tmp) break;
4483 }
4484 return data;
4485}
4486
4487static int
4488cv_list_i(st_data_t key, st_data_t value, VALUE ary)
4489{
4490 ID sym = (ID)key;
4491 rb_ary_push(ary, ID2SYM(sym));
4492 return ST_CONTINUE;
4493}
4494
4495static VALUE
4496cvar_list(void *data)
4497{
4498 st_table *tbl = data;
4499 VALUE ary;
4500
4501 if (!tbl) return rb_ary_new2(0);
4502 ary = rb_ary_new2(tbl->num_entries);
4503 st_foreach_safe(tbl, cv_list_i, ary);
4504 st_free_table(tbl);
4505
4506 return ary;
4507}
4508
4509/*
4510 * call-seq:
4511 * mod.class_variables(inherit=true) -> array
4512 *
4513 * Returns an array of the names of class variables in <i>mod</i>.
4514 * This includes the names of class variables in any included
4515 * modules, unless the <i>inherit</i> parameter is set to
4516 * <code>false</code>.
4517 *
4518 * class One
4519 * @@var1 = 1
4520 * end
4521 * class Two < One
4522 * @@var2 = 2
4523 * end
4524 * One.class_variables #=> [:@@var1]
4525 * Two.class_variables #=> [:@@var2, :@@var1]
4526 * Two.class_variables(false) #=> [:@@var2]
4527 */
4528
4529VALUE
4530rb_mod_class_variables(int argc, const VALUE *argv, VALUE mod)
4531{
4532 bool inherit = true;
4533 st_table *tbl;
4534
4535 if (rb_check_arity(argc, 0, 1)) inherit = RTEST(argv[0]);
4536 if (inherit) {
4537 tbl = mod_cvar_of(mod, 0);
4538 }
4539 else {
4540 tbl = mod_cvar_at(mod, 0);
4541 }
4542 return cvar_list(tbl);
4543}
4544
4545/*
4546 * call-seq:
4547 * remove_class_variable(sym) -> obj
4548 *
4549 * Removes the named class variable from the receiver, returning that
4550 * variable's value.
4551 *
4552 * class Example
4553 * @@var = 99
4554 * puts remove_class_variable(:@@var)
4555 * p(defined? @@var)
4556 * end
4557 *
4558 * <em>produces:</em>
4559 *
4560 * 99
4561 * nil
4562 */
4563
4564VALUE
4566{
4567 const ID id = id_for_var_message(mod, name, class, "wrong class variable name %1$s");
4568 st_data_t val;
4569
4570 if (!id) {
4571 goto not_defined;
4572 }
4573 rb_check_frozen(mod);
4574 val = rb_ivar_delete(mod, id, Qundef);
4575 if (!UNDEF_P(val)) {
4576 return (VALUE)val;
4577 }
4578 if (rb_cvar_defined(mod, id)) {
4579 rb_name_err_raise("cannot remove %1$s for %2$s", mod, ID2SYM(id));
4580 }
4581 not_defined:
4582 rb_name_err_raise("class variable %1$s not defined for %2$s",
4583 mod, name);
4585}
4586
4587VALUE
4588rb_iv_get(VALUE obj, const char *name)
4589{
4590 ID id = rb_check_id_cstr(name, strlen(name), rb_usascii_encoding());
4591
4592 if (!id) {
4593 return Qnil;
4594 }
4595 return rb_ivar_get(obj, id);
4596}
4597
4598VALUE
4599rb_iv_set(VALUE obj, const char *name, VALUE val)
4600{
4601 ID id = rb_intern(name);
4602
4603 return rb_ivar_set(obj, id, val);
4604}
4605
4606static attr_index_t
4607class_fields_ivar_set(VALUE klass, VALUE fields_obj, ID id, VALUE val, bool concurrent, VALUE *new_fields_obj, bool *new_ivar_out)
4608{
4609 const VALUE original_fields_obj = fields_obj;
4610 fields_obj = original_fields_obj ? original_fields_obj : rb_imemo_fields_new(klass, ROOT_SHAPE_ID, true);
4611
4612 shape_id_t current_shape_id = RBASIC_SHAPE_ID(fields_obj);
4613 shape_id_t next_shape_id = current_shape_id; // for complex
4614 if (UNLIKELY(rb_shape_complex_p(current_shape_id))) {
4615 goto complex;
4616 }
4617
4618 bool new_ivar;
4619 next_shape_id = generic_shape_ivar(fields_obj, id, &new_ivar);
4620
4621 if (UNLIKELY(rb_shape_complex_p(next_shape_id))) {
4622 fields_obj = imemo_fields_complex_from_obj(klass, fields_obj, next_shape_id);
4623 goto complex;
4624 }
4625
4626 attr_index_t index = RSHAPE_INDEX(next_shape_id);
4627 if (new_ivar && index >= RSHAPE_CAPACITY(current_shape_id)) {
4628 // We allocate a new fields_obj even when concurrency isn't a concern
4629 // so that we're embedded as long as possible.
4630 fields_obj = imemo_fields_copy_append(klass, fields_obj, current_shape_id, next_shape_id, val);
4631 }
4632 else {
4633 VALUE *fields = rb_imemo_fields_ptr(fields_obj);
4634
4635 if (concurrent && original_fields_obj == fields_obj) {
4636 // In the concurrent case, if we're mutating the existing
4637 // fields_obj, we must use an atomic write, because if we're
4638 // adding a new field, the shape_id must be written after the field
4639 // and if we're updating an existing field, we at least need a relaxed
4640 // write to avoid reaping.
4641 RB_OBJ_ATOMIC_WRITE(fields_obj, &fields[index], val);
4642 }
4643 else {
4644 RB_OBJ_WRITE(fields_obj, &fields[index], val);
4645 }
4646
4647 if (new_ivar) {
4648 RBASIC_SET_SHAPE_ID(fields_obj, next_shape_id);
4649 }
4650 }
4651
4652 *new_fields_obj = fields_obj;
4653 *new_ivar_out = new_ivar;
4654 return index;
4655
4656complex:
4657 {
4658 if (concurrent && fields_obj == original_fields_obj) {
4659 // In multi-ractor case, we must always work on a copy because
4660 // even if the field already exist, inserting in a st_table may
4661 // cause a rebuild.
4662 fields_obj = rb_imemo_fields_clone(fields_obj);
4663 }
4664
4665 st_table *table = rb_imemo_fields_complex_tbl(fields_obj);
4666 new_ivar = !st_insert(table, (st_data_t)id, (st_data_t)val);
4667 RB_OBJ_WRITTEN(fields_obj, Qundef, val);
4668
4669 if (fields_obj != original_fields_obj) {
4670 RBASIC_SET_SHAPE_ID(fields_obj, next_shape_id);
4671 }
4672 }
4673
4674 *new_fields_obj = fields_obj;
4675 *new_ivar_out = new_ivar;
4676 return ATTR_INDEX_NOT_SET;
4677}
4678
4679static attr_index_t
4680class_ivar_set(VALUE obj, ID id, VALUE val, bool *new_ivar)
4681{
4682 rb_class_ensure_writable(obj);
4683
4684 const VALUE original_fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
4685 VALUE new_fields_obj = 0;
4686
4687 attr_index_t index = class_fields_ivar_set(obj, original_fields_obj, id, val, rb_multi_ractor_p(), &new_fields_obj, new_ivar);
4688
4689 if (new_fields_obj != original_fields_obj) {
4690 RCLASS_WRITABLE_SET_FIELDS_OBJ(obj, new_fields_obj);
4691 }
4692
4693 // TODO: What should we set as the T_CLASS shape_id?
4694 // In most case we can replicate the single `fields_obj` shape
4695 // but in namespaced case? Perhaps INVALID_SHAPE_ID?
4696 RBASIC_SET_SHAPE_ID(obj, RBASIC_SHAPE_ID(new_fields_obj));
4697 return index;
4698}
4699
4700bool
4701rb_class_ivar_set(VALUE obj, ID id, VALUE val)
4702{
4704 rb_check_frozen(obj);
4705
4706 bool new_ivar;
4707 class_ivar_set(obj, id, val, &new_ivar);
4708 return new_ivar;
4709}
4710
4711void
4712rb_fields_tbl_copy(VALUE dst, VALUE src)
4713{
4714 RUBY_ASSERT(rb_type(dst) == rb_type(src));
4716 RUBY_ASSERT(RSHAPE_TYPE_P(RBASIC_SHAPE_ID(dst), SHAPE_ROOT));
4717
4718 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(src);
4719 if (fields_obj) {
4720 RCLASS_WRITABLE_SET_FIELDS_OBJ(dst, rb_imemo_fields_clone(fields_obj));
4721 RBASIC_SET_SHAPE_ID(dst, RBASIC_SHAPE_ID(src));
4722 }
4723}
4724
4725static rb_const_entry_t *
4726const_lookup(struct rb_id_table *tbl, ID id)
4727{
4728 if (tbl) {
4729 VALUE val;
4730 bool r;
4731 RB_VM_LOCKING() {
4732 r = rb_id_table_lookup(tbl, id, &val);
4733 }
4734
4735 if (r) return (rb_const_entry_t *)val;
4736 }
4737 return NULL;
4738}
4739
4741rb_const_lookup(VALUE klass, ID id)
4742{
4743 return const_lookup(RCLASS_CONST_TBL(klass), id);
4744}
#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:2014
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:2691
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:3061
#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:468
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Definition gc.h:456
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:1121
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:2037
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:1951
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:3836
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:3189
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
Definition string.c:1520
VALUE rb_str_dup(VALUE str)
Duplicates a string.
Definition string.c:1996
#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:4565
VALUE rb_obj_instance_variables(VALUE obj)
Resembles Object#instance_variables.
Definition variable.c:2511
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:3536
VALUE rb_const_list(void *)
This is another mysterious API that comes with no documents at all.
Definition variable.c:3780
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:3404
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:2064
VALUE rb_mod_remove_const(VALUE space, VALUE name)
Resembles Module#remove_const.
Definition variable.c:3641
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:4323
VALUE rb_cvar_get(VALUE klass, ID name)
Obtains a value from a class variable.
Definition variable.c:4400
VALUE rb_mod_constants(int argc, const VALUE *argv, VALUE recv)
Resembles Module#constants.
Definition variable.c:3812
VALUE rb_cvar_find(VALUE klass, ID name, VALUE *front)
Identical to rb_cvar_get(), except it takes additional "front" pointer.
Definition variable.c:4384
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:4014
VALUE rb_autoload_load(VALUE space, ID name)
Kicks the autoload procedure as if it was "touched".
Definition variable.c:3366
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:3542
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:4440
VALUE rb_obj_remove_instance_variable(VALUE obj, VALUE name)
Resembles Object#remove_instance_variable.
Definition variable.c:2563
void * rb_mod_const_of(VALUE, void *)
This is a variant of rb_mod_const_at().
Definition variable.c:3758
st_index_t rb_ivar_count(VALUE obj)
Number of instance variables defined on an object.
Definition variable.c:2423
void * rb_mod_const_at(VALUE, void *)
This API is mysterious.
Definition variable.c:3743
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:3654
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:3530
VALUE rb_ivar_defined(VALUE obj, ID name)
Queries if the instance variable is defined at the object.
Definition variable.c:2143
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:4433
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:3874
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:4426
VALUE rb_mod_class_variables(int argc, const VALUE *argv, VALUE recv)
Resembles Module#class_variables.
Definition variable.c:4530
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:4407
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:3862
int rb_const_defined(VALUE space, ID name)
Queries if the constant is defined at the namespace.
Definition variable.c:3868
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:2074
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:3469
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:12697
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:4125
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:4170
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:4588
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:4599
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:2275
#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:133
#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>
Definition variable.c:2381
Internal header for Ruby Box.
Definition box.h:14
Definition constant.h:33
Internal header for Class.
Definition class.h:30
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