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