diff options
Diffstat (limited to 'variable.c')
| -rw-r--r-- | variable.c | 3465 |
1 files changed, 2521 insertions, 944 deletions
diff --git a/variable.c b/variable.c index 3da500eddb..74d5b699b8 100644 --- a/variable.c +++ b/variable.c @@ -11,162 +11,103 @@ **********************************************************************/ -#include "ruby/ruby.h" -#include "ruby/st.h" -#include "ruby/util.h" -#include "ruby/encoding.h" -#include "node.h" +#include "ruby/internal/config.h" +#include <stddef.h> +#include "ruby/internal/stdbool.h" +#include "ccan/list/list.h" #include "constant.h" +#include "debug_counter.h" +#include "id.h" +#include "id_table.h" #include "internal.h" - -st_table *rb_global_tbl; -st_table *rb_class_tbl; -static ID autoload, classpath, tmp_classpath, classid; +#include "internal/class.h" +#include "internal/compilers.h" +#include "internal/error.h" +#include "internal/eval.h" +#include "internal/hash.h" +#include "internal/object.h" +#include "internal/re.h" +#include "internal/symbol.h" +#include "internal/thread.h" +#include "internal/variable.h" +#include "ruby/encoding.h" +#include "ruby/st.h" +#include "ruby/util.h" +#include "transient_heap.h" +#include "variable.h" +#include "vm_core.h" +#include "ractor_core.h" +#include "vm_sync.h" + +RUBY_EXTERN rb_serial_t ruby_vm_global_cvar_state; +#define GET_GLOBAL_CVAR_STATE() (ruby_vm_global_cvar_state) + +typedef void rb_gvar_compact_t(void *var); + +static struct rb_id_table *rb_global_tbl; +static ID autoload, classpath, tmp_classpath; +static VALUE autoload_featuremap; /* feature => autoload_i */ + +static void check_before_mod_set(VALUE, ID, VALUE, const char *); +static void setup_const_entry(rb_const_entry_t *, VALUE, VALUE, rb_const_flag_t); +static VALUE rb_const_search(VALUE klass, ID id, int exclude, int recurse, int visibility); +static st_table *generic_iv_tbl_; + +struct ivar_update { + union { + st_table *iv_index_tbl; + struct gen_ivtbl *ivtbl; + } u; + st_data_t index; + int iv_extended; +}; void Init_var_tables(void) { - rb_global_tbl = st_init_numtable(); - rb_class_tbl = st_init_numtable(); - CONST_ID(autoload, "__autoload__"); - CONST_ID(classpath, "__classpath__"); - CONST_ID(tmp_classpath, "__tmp_classpath__"); - CONST_ID(classid, "__classid__"); -} - -struct fc_result { - ID name; - VALUE klass; - VALUE path; - VALUE track; - struct fc_result *prev; -}; - -static VALUE -fc_path(struct fc_result *fc, ID name) -{ - VALUE path, tmp; - - path = rb_str_dup(rb_id2str(name)); - while (fc) { - st_data_t n; - if (fc->track == rb_cObject) break; - if (RCLASS_IV_TBL(fc->track) && - st_lookup(RCLASS_IV_TBL(fc->track), (st_data_t)classpath, &n)) { - tmp = rb_str_dup((VALUE)n); - rb_str_cat2(tmp, "::"); - rb_str_append(tmp, path); - path = tmp; - break; - } - tmp = rb_str_dup(rb_id2str(fc->name)); - rb_str_cat2(tmp, "::"); - rb_str_append(tmp, path); - path = tmp; - fc = fc->prev; - } - OBJ_FREEZE(path); - return path; -} - -static int -fc_i(ID key, rb_const_entry_t *ce, struct fc_result *res) -{ - VALUE value = ce->value; - if (!rb_is_const_id(key)) return ST_CONTINUE; - - if (value == res->klass) { - res->path = fc_path(res, key); - return ST_STOP; - } - switch (TYPE(value)) { - case T_MODULE: - case T_CLASS: - if (!RCLASS_CONST_TBL(value)) return ST_CONTINUE; - else { - struct fc_result arg; - struct fc_result *list; - - list = res; - while (list) { - if (list->track == value) return ST_CONTINUE; - list = list->prev; - } - - arg.name = key; - arg.path = 0; - arg.klass = res->klass; - arg.track = value; - arg.prev = res; - st_foreach(RCLASS_CONST_TBL(value), fc_i, (st_data_t)&arg); - if (arg.path) { - res->path = arg.path; - return ST_STOP; - } - } - break; - - default: - break; - } - return ST_CONTINUE; + rb_global_tbl = rb_id_table_create(0); + generic_iv_tbl_ = st_init_numtable(); + autoload = rb_intern_const("__autoload__"); + /* __classpath__: fully qualified class path */ + classpath = rb_intern_const("__classpath__"); + /* __tmp_classpath__: temporary class path which contains anonymous names */ + tmp_classpath = rb_intern_const("__tmp_classpath__"); } -static VALUE -find_class_path(VALUE klass) +static inline bool +rb_namespace_p(VALUE obj) { - struct fc_result arg; - - arg.name = 0; - arg.path = 0; - arg.klass = klass; - arg.track = rb_cObject; - arg.prev = 0; - if (RCLASS_CONST_TBL(rb_cObject)) { - st_foreach_safe(RCLASS_CONST_TBL(rb_cObject), fc_i, (st_data_t)&arg); - } - if (arg.path == 0) { - st_foreach_safe(rb_class_tbl, fc_i, (st_data_t)&arg); - } - if (arg.path) { - st_data_t tmp = tmp_classpath; - if (!RCLASS_IV_TBL(klass)) { - RCLASS_IV_TBL(klass) = st_init_numtable(); - } - st_insert(RCLASS_IV_TBL(klass), (st_data_t)classpath, arg.path); - st_delete(RCLASS_IV_TBL(klass), &tmp, 0); - return arg.path; + if (RB_SPECIAL_CONST_P(obj)) return false; + switch (RB_BUILTIN_TYPE(obj)) { + case T_MODULE: case T_CLASS: return true; + default: break; } - return Qnil; + return false; } +/** + * Returns +classpath+ of _klass_, if it is named, or +nil+ for + * anonymous +class+/+module+. A named +classpath+ may contain + * an anonymous component, but the last component is guaranteed + * to not be anonymous. <code>*permanent</code> is set to 1 + * if +classpath+ has no anonymous components. There is no builtin + * Ruby level APIs that can change a permanent +classpath+. + */ static VALUE -classname(VALUE klass) +classname(VALUE klass, int *permanent) { - VALUE path = Qnil; + st_table *ivtbl; st_data_t n; - if (!klass) klass = rb_cObject; - if (RCLASS_IV_TBL(klass)) { - if (!st_lookup(RCLASS_IV_TBL(klass), (st_data_t)classpath, &n)) { - if (!st_lookup(RCLASS_IV_TBL(klass), (st_data_t)classid, &n)) { - return find_class_path(klass); - } - path = rb_str_dup(rb_id2str(SYM2ID((VALUE)n))); - OBJ_FREEZE(path); - st_insert(RCLASS_IV_TBL(klass), (st_data_t)classpath, (st_data_t)path); - n = classid; - st_delete(RCLASS_IV_TBL(klass), &n, 0); - } - else { - path = (VALUE)n; - } - if (TYPE(path) != T_STRING) { - rb_bug("class path is not set properly"); - } - return path; + *permanent = 0; + if (!RCLASS_EXT(klass)) return Qnil; + if (!(ivtbl = RCLASS_IV_TBL(klass))) return Qnil; + if (st_lookup(ivtbl, (st_data_t)classpath, &n)) { + *permanent = 1; + return (VALUE)n; } - return find_class_path(klass); + if (st_lookup(ivtbl, (st_data_t)tmp_classpath, &n)) return (VALUE)n; + return Qnil; } /* @@ -179,81 +120,130 @@ classname(VALUE klass) VALUE rb_mod_name(VALUE mod) { - VALUE path = classname(mod); + int permanent; + return classname(mod, &permanent); +} - if (!NIL_P(path)) return rb_str_dup(path); +static VALUE +make_temporary_path(VALUE obj, VALUE klass) +{ + VALUE path; + switch (klass) { + case Qnil: + path = rb_sprintf("#<Class:%p>", (void*)obj); + break; + case Qfalse: + path = rb_sprintf("#<Module:%p>", (void*)obj); + break; + default: + path = rb_sprintf("#<%"PRIsVALUE":%p>", klass, (void*)obj); + break; + } + OBJ_FREEZE(path); return path; } -VALUE -rb_class_path(VALUE klass) +typedef VALUE (*fallback_func)(VALUE obj, VALUE name); + +static VALUE +rb_tmp_class_path(VALUE klass, int *permanent, fallback_func fallback) { - VALUE path = classname(klass); - st_data_t n = (st_data_t)path; + VALUE path = classname(klass, permanent); - if (!NIL_P(path)) return path; - if (RCLASS_IV_TBL(klass) && st_lookup(RCLASS_IV_TBL(klass), - (st_data_t)tmp_classpath, &n)) { - return (VALUE)n; + if (!NIL_P(path)) { + return path; } else { - const char *s = "Class"; - - if (TYPE(klass) == T_MODULE) { + if (RB_TYPE_P(klass, T_MODULE)) { if (rb_obj_class(klass) == rb_cModule) { - s = "Module"; + path = Qfalse; } else { - s = rb_class2name(RBASIC(klass)->klass); + int perm; + path = rb_tmp_class_path(RBASIC(klass)->klass, &perm, fallback); } } - path = rb_sprintf("#<%s:%p>", s, (void*)klass); - OBJ_FREEZE(path); - rb_ivar_set(klass, tmp_classpath, path); - - return path; + *permanent = 0; + return fallback(klass, path); } } +VALUE +rb_class_path(VALUE klass) +{ + int permanent; + VALUE path = rb_tmp_class_path(klass, &permanent, make_temporary_path); + if (!NIL_P(path)) path = rb_str_dup(path); + return path; +} + +VALUE +rb_class_path_cached(VALUE klass) +{ + return rb_mod_name(klass); +} + +static VALUE +no_fallback(VALUE obj, VALUE name) +{ + return name; +} + +VALUE +rb_search_class_path(VALUE klass) +{ + int permanent; + return rb_tmp_class_path(klass, &permanent, no_fallback); +} + +static VALUE +build_const_pathname(VALUE head, VALUE tail) +{ + VALUE path = rb_str_dup(head); + rb_str_cat2(path, "::"); + rb_str_append(path, tail); + return rb_fstring(path); +} + +static VALUE +build_const_path(VALUE head, ID tail) +{ + return build_const_pathname(head, rb_id2str(tail)); +} + void rb_set_class_path_string(VALUE klass, VALUE under, VALUE name) { VALUE str; + ID pathid = classpath; if (under == rb_cObject) { str = rb_str_new_frozen(name); } else { - str = rb_str_dup(rb_class_path(under)); - rb_str_cat2(str, "::"); - rb_str_append(str, name); - OBJ_FREEZE(str); + int permanent; + str = rb_tmp_class_path(under, &permanent, make_temporary_path); + str = build_const_pathname(str, name); + if (!permanent) { + pathid = tmp_classpath; + } } - rb_ivar_set(klass, classpath, str); + rb_ivar_set(klass, pathid, str); } void rb_set_class_path(VALUE klass, VALUE under, const char *name) { - VALUE str; - - if (under == rb_cObject) { - str = rb_str_new2(name); - } - else { - str = rb_str_dup(rb_class_path(under)); - rb_str_cat2(str, "::"); - rb_str_cat2(str, name); - } + VALUE str = rb_str_new2(name); OBJ_FREEZE(str); - rb_ivar_set(klass, classpath, str); + rb_set_class_path_string(klass, under, str); } VALUE rb_path_to_class(VALUE pathname) { rb_encoding *enc = rb_enc_get(pathname); - const char *pbeg, *p, *path = RSTRING_PTR(pathname); + const char *pbeg, *pend, *p, *path = RSTRING_PTR(pathname); ID id; VALUE c = rb_cObject; @@ -261,32 +251,37 @@ rb_path_to_class(VALUE pathname) rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)"); } pbeg = p = path; - if (path[0] == '#') { - rb_raise(rb_eArgError, "can't retrieve anonymous class %s", path); - } - while (*p) { - while (*p && *p != ':') p++; - id = rb_intern3(pbeg, p-pbeg, enc); - if (p[0] == ':') { - if (p[1] != ':') goto undefined_class; + pend = path + RSTRING_LEN(pathname); + if (path == pend || path[0] == '#') { + rb_raise(rb_eArgError, "can't retrieve anonymous class %"PRIsVALUE, + QUOTE(pathname)); + } + while (p < pend) { + while (p < pend && *p != ':') p++; + id = rb_check_id_cstr(pbeg, p-pbeg, enc); + if (p < pend && p[0] == ':') { + if ((size_t)(pend - p) < 2 || p[1] != ':') goto undefined_class; p += 2; pbeg = p; } - if (!rb_const_defined(c, id)) { - undefined_class: - rb_raise(rb_eArgError, "undefined class/module %.*s", (int)(p-path), path); + if (!id) { + goto undefined_class; } - c = rb_const_get_at(c, id); - switch (TYPE(c)) { - case T_MODULE: - case T_CLASS: - break; - default: - rb_raise(rb_eTypeError, "%s does not refer to class/module", path); + c = rb_const_search(c, id, TRUE, FALSE, FALSE); + if (c == Qundef) goto undefined_class; + if (!rb_namespace_p(c)) { + rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module", + pathname); } } + RB_GC_GUARD(pathname); return c; + + undefined_class: + rb_raise(rb_eArgError, "undefined class/module % "PRIsVALUE, + rb_str_subseq(pathname, 0, p-path)); + UNREACHABLE_RETURN(Qundef); } VALUE @@ -295,12 +290,6 @@ rb_path2class(const char *path) return rb_path_to_class(rb_str_new_cstr(path)); } -void -rb_name_class(VALUE klass, ID id) -{ - rb_ivar_set(klass, classid, ID2SYM(id)); -} - VALUE rb_class_name(VALUE klass) { @@ -310,8 +299,10 @@ rb_class_name(VALUE klass) const char * rb_class2name(VALUE klass) { - VALUE name = rb_class_name(klass); - return RSTRING_PTR(name); + int permanent; + VALUE path = rb_tmp_class_path(rb_class_real(klass), &permanent, make_temporary_path); + if (NIL_P(path)) return NULL; + return RSTRING_PTR(path); } const char * @@ -320,13 +311,6 @@ rb_obj_classname(VALUE obj) return rb_class2name(CLASS_OF(obj)); } -#define global_variable rb_global_variable -#define global_entry rb_global_entry - -#define gvar_getter_t rb_gvar_getter_t -#define gvar_setter_t rb_gvar_setter_t -#define gvar_marker_t rb_gvar_marker_t - struct trace_var { int removed; void (*func)(VALUE arg, VALUE val); @@ -334,131 +318,172 @@ struct trace_var { struct trace_var *next; }; -struct global_variable { - int counter; - void *data; - gvar_getter_t *getter; - gvar_setter_t *setter; - gvar_marker_t *marker; +struct rb_global_variable { + int counter; int block_trace; + VALUE *data; + rb_gvar_getter_t *getter; + rb_gvar_setter_t *setter; + rb_gvar_marker_t *marker; + rb_gvar_compact_t *compactor; struct trace_var *trace; }; -#define undef_getter rb_gvar_undef_getter -#define undef_setter rb_gvar_undef_setter -#define undef_marker rb_gvar_undef_marker +struct rb_global_entry { + struct rb_global_variable *var; + ID id; + bool ractor_local; +}; + +static struct rb_global_entry* +rb_find_global_entry(ID id) +{ + struct rb_global_entry *entry; + VALUE data; -#define val_getter rb_gvar_val_getter -#define val_setter rb_gvar_val_setter -#define val_marker rb_gvar_val_marker + if (!rb_id_table_lookup(rb_global_tbl, id, &data)) { + entry = NULL; + } + else { + entry = (struct rb_global_entry *)data; + RUBY_ASSERT(entry != NULL); + } -#define var_getter rb_gvar_var_getter -#define var_setter rb_gvar_var_setter -#define var_marker rb_gvar_var_marker + if (UNLIKELY(!rb_ractor_main_p()) && (!entry || !entry->ractor_local)) { + rb_raise(rb_eRactorIsolationError, "can not access global variables %s from non-main Ractors", rb_id2name(id)); + } -#define readonly_setter rb_gvar_readonly_setter + return entry; +} -struct global_entry* -rb_global_entry(ID id) +void +rb_gvar_ractor_local(const char *name) { - struct global_entry *entry; - st_data_t data; + struct rb_global_entry *entry = rb_find_global_entry(rb_intern(name)); + entry->ractor_local = true; +} - if (!st_lookup(rb_global_tbl, (st_data_t)id, &data)) { - struct global_variable *var; - entry = ALLOC(struct global_entry); - var = ALLOC(struct global_variable); +static void +rb_gvar_undef_compactor(void *var) +{ +} + +static struct rb_global_entry* +rb_global_entry(ID id) +{ + struct rb_global_entry *entry = rb_find_global_entry(id); + if (!entry) { + struct rb_global_variable *var; + entry = ALLOC(struct rb_global_entry); + var = ALLOC(struct rb_global_variable); entry->id = id; entry->var = var; + entry->ractor_local = false; var->counter = 1; var->data = 0; - var->getter = undef_getter; - var->setter = undef_setter; - var->marker = undef_marker; + var->getter = rb_gvar_undef_getter; + var->setter = rb_gvar_undef_setter; + var->marker = rb_gvar_undef_marker; + var->compactor = rb_gvar_undef_compactor; var->block_trace = 0; var->trace = 0; - st_add_direct(rb_global_tbl, id, (st_data_t)entry); - } - else { - entry = (struct global_entry *)data; + rb_id_table_insert(rb_global_tbl, id, (VALUE)entry); } return entry; } VALUE -undef_getter(ID id, void *data, struct global_variable *var) +rb_gvar_undef_getter(ID id, VALUE *_) { - rb_warning("global variable `%s' not initialized", rb_id2name(id)); + rb_warning("global variable `%"PRIsVALUE"' not initialized", QUOTE_ID(id)); return Qnil; } +static void +rb_gvar_val_compactor(void *_var) +{ + struct rb_global_variable *var = (struct rb_global_variable *)_var; + + VALUE obj = (VALUE)var->data; + + if (obj) { + VALUE new = rb_gc_location(obj); + if (new != obj) { + var->data = (void*)new; + } + } +} + void -undef_setter(VALUE val, ID id, void *data, struct global_variable *var) +rb_gvar_undef_setter(VALUE val, ID id, VALUE *_) { - var->getter = val_getter; - var->setter = val_setter; - var->marker = val_marker; + struct rb_global_variable *var = rb_global_entry(id)->var; + var->getter = rb_gvar_val_getter; + var->setter = rb_gvar_val_setter; + var->marker = rb_gvar_val_marker; + var->compactor = rb_gvar_val_compactor; var->data = (void*)val; } void -undef_marker(VALUE *var) +rb_gvar_undef_marker(VALUE *var) { } VALUE -val_getter(ID id, void *data, struct global_variable *var) +rb_gvar_val_getter(ID id, VALUE *data) { return (VALUE)data; } void -val_setter(VALUE val, ID id, void *data, struct global_variable *var) +rb_gvar_val_setter(VALUE val, ID id, VALUE *_) { + struct rb_global_variable *var = rb_global_entry(id)->var; var->data = (void*)val; } void -val_marker(VALUE *var) +rb_gvar_val_marker(VALUE *var) { VALUE data = (VALUE)var; - if (data) rb_gc_mark_maybe(data); + if (data) rb_gc_mark_movable(data); } VALUE -var_getter(ID id, void *data, struct global_variable *gvar) +rb_gvar_var_getter(ID id, VALUE *var) { - VALUE *var = data; if (!var) return Qnil; return *var; } void -var_setter(VALUE val, ID id, void *data, struct global_variable *gvar) +rb_gvar_var_setter(VALUE val, ID id, VALUE *data) { - *(VALUE *)data = val; + *data = val; } void -var_marker(VALUE *var) +rb_gvar_var_marker(VALUE *var) { if (var) rb_gc_mark_maybe(*var); } void -readonly_setter(VALUE val, ID id, void *data, struct global_variable *gvar) +rb_gvar_readonly_setter(VALUE v, ID id, VALUE *_) { - rb_name_error(id, "%s is a read-only variable", rb_id2name(id)); + rb_name_error(id, "%"PRIsVALUE" is a read-only variable", QUOTE_ID(id)); } -static int -mark_global_entry(ID key, struct global_entry *entry) +static enum rb_id_table_iterator_result +mark_global_entry(VALUE v, void *ignored) { + struct rb_global_entry *entry = (struct rb_global_entry *)v; struct trace_var *trace; - struct global_variable *var = entry->var; + struct rb_global_variable *var = entry->var; (*var->marker)(var->data); trace = var->trace; @@ -466,14 +491,33 @@ mark_global_entry(ID key, struct global_entry *entry) if (trace->data) rb_gc_mark_maybe(trace->data); trace = trace->next; } - return ST_CONTINUE; + return ID_TABLE_CONTINUE; } void rb_gc_mark_global_tbl(void) { - if (rb_global_tbl) - st_foreach_safe(rb_global_tbl, mark_global_entry, 0); + if (rb_global_tbl) { + rb_id_table_foreach_values(rb_global_tbl, mark_global_entry, 0); + } +} + +static enum rb_id_table_iterator_result +update_global_entry(VALUE v, void *ignored) +{ + struct rb_global_entry *entry = (struct rb_global_entry *)v; + struct rb_global_variable *var = entry->var; + + (*var->compactor)(var); + return ID_TABLE_CONTINUE; +} + +void +rb_gc_update_global_tbl(void) +{ + if (rb_global_tbl) { + rb_id_table_foreach_values(rb_global_tbl, update_global_entry, 0); + } } static ID @@ -484,11 +528,34 @@ global_id(const char *name) if (name[0] == '$') id = rb_intern(name); else { size_t len = strlen(name); - char *buf = ALLOCA_N(char, len+1); + VALUE vbuf = 0; + char *buf = ALLOCV_N(char, vbuf, len+1); buf[0] = '$'; memcpy(buf+1, name, len); id = rb_intern2(buf, len+1); + ALLOCV_END(vbuf); + } + return id; +} + +static ID +find_global_id(const char *name) +{ + ID id; + size_t len = strlen(name); + + if (name[0] == '$') { + id = rb_check_id_cstr(name, len, NULL); } + else { + VALUE vbuf = 0; + char *buf = ALLOCV_N(char, vbuf, len+1); + buf[0] = '$'; + memcpy(buf+1, name, len); + id = rb_check_id_cstr(buf, len+1, NULL); + ALLOCV_END(vbuf); + } + return id; } @@ -496,17 +563,17 @@ void rb_define_hooked_variable( const char *name, VALUE *var, - VALUE (*getter)(ANYARGS), - void (*setter)(ANYARGS)) + rb_gvar_getter_t *getter, + rb_gvar_setter_t *setter) { volatile VALUE tmp = var ? *var : Qnil; ID id = global_id(name); - struct global_variable *gvar = rb_global_entry(id)->var; + struct rb_global_variable *gvar = rb_global_entry(id)->var; gvar->data = (void*)var; - gvar->getter = getter?(gvar_getter_t *)getter:var_getter; - gvar->setter = setter?(gvar_setter_t *)setter:var_setter; - gvar->marker = var_marker; + gvar->getter = getter ? (rb_gvar_getter_t *)getter : rb_gvar_var_getter; + gvar->setter = setter ? (rb_gvar_setter_t *)setter : rb_gvar_var_setter; + gvar->marker = rb_gvar_var_marker; RB_GC_GUARD(tmp); } @@ -518,59 +585,35 @@ rb_define_variable(const char *name, VALUE *var) } void -rb_define_readonly_variable(const char *name, VALUE *var) +rb_define_readonly_variable(const char *name, const VALUE *var) { - rb_define_hooked_variable(name, var, 0, readonly_setter); + rb_define_hooked_variable(name, (VALUE *)var, 0, rb_gvar_readonly_setter); } void rb_define_virtual_variable( const char *name, - VALUE (*getter)(ANYARGS), - void (*setter)(ANYARGS)) + rb_gvar_getter_t *getter, + rb_gvar_setter_t *setter) { - if (!getter) getter = val_getter; - if (!setter) setter = readonly_setter; + if (!getter) getter = rb_gvar_val_getter; + if (!setter) setter = rb_gvar_readonly_setter; rb_define_hooked_variable(name, 0, getter, setter); } static void rb_trace_eval(VALUE cmd, VALUE val) { - rb_eval_cmd(cmd, rb_ary_new3(1, val), 0); + rb_eval_cmd_kw(cmd, rb_ary_new3(1, val), RB_NO_KEYWORDS); } -/* - * call-seq: - * trace_var(symbol, cmd ) -> nil - * trace_var(symbol) {|val| block } -> nil - * - * Controls tracing of assignments to global variables. The parameter - * +symbol_ identifies the variable (as either a string name or a - * symbol identifier). _cmd_ (which may be a string or a - * +Proc+ object) or block is executed whenever the variable - * is assigned. The block or +Proc+ object receives the - * variable's new value as a parameter. Also see - * <code>Kernel::untrace_var</code>. - * - * trace_var :$_, proc {|v| puts "$_ is now '#{v}'" } - * $_ = "hello" - * $_ = ' there' - * - * <em>produces:</em> - * - * $_ is now 'hello' - * $_ is now ' there' - */ - VALUE -rb_f_trace_var(int argc, VALUE *argv) +rb_f_trace_var(int argc, const VALUE *argv) { VALUE var, cmd; - struct global_entry *entry; + struct rb_global_entry *entry; struct trace_var *trace; - rb_secure(4); if (rb_scan_args(argc, argv, "11", &var, &cmd) == 1) { cmd = rb_block_proc(); } @@ -578,9 +621,6 @@ rb_f_trace_var(int argc, VALUE *argv) return rb_f_untrace_var(argc, argv); } entry = rb_global_entry(rb_to_id(var)); - if (OBJ_TAINTED(cmd)) { - rb_raise(rb_eSecurityError, "Insecure: tainted variable trace"); - } trace = ALLOC(struct trace_var); trace->next = entry->var->trace; trace->func = rb_trace_eval; @@ -592,7 +632,7 @@ rb_f_trace_var(int argc, VALUE *argv) } static void -remove_trace(struct global_variable *var) +remove_trace(struct rb_global_variable *var) { struct trace_var *trace = var->trace; struct trace_var t; @@ -613,33 +653,24 @@ remove_trace(struct global_variable *var) var->trace = t.next; } -/* - * call-seq: - * untrace_var(symbol [, cmd] ) -> array or nil - * - * Removes tracing for the specified command on the given global - * variable and returns +nil+. If no command is specified, - * removes all tracing for that variable and returns an array - * containing the commands actually removed. - */ - VALUE -rb_f_untrace_var(int argc, VALUE *argv) +rb_f_untrace_var(int argc, const VALUE *argv) { VALUE var, cmd; ID id; - struct global_entry *entry; + struct rb_global_entry *entry; struct trace_var *trace; - st_data_t data; - rb_secure(4); rb_scan_args(argc, argv, "11", &var, &cmd); - id = rb_to_id(var); - if (!st_lookup(rb_global_tbl, (st_data_t)id, &data)) { - rb_name_error(id, "undefined global variable %s", rb_id2name(id)); + id = rb_check_id(&var); + if (!id) { + rb_name_error_str(var, "undefined global variable %"PRIsVALUE"", QUOTE(var)); + } + if ((entry = rb_find_global_entry(id)) == NULL) { + rb_name_error(id, "undefined global variable %"PRIsVALUE"", QUOTE_ID(id)); } - trace = (entry = (struct global_entry *)data)->var->trace; + trace = entry->var->trace; if (NIL_P(cmd)) { VALUE ary = rb_ary_new(); @@ -666,47 +697,41 @@ rb_f_untrace_var(int argc, VALUE *argv) return Qnil; } -VALUE -rb_gvar_get(struct global_entry *entry) -{ - struct global_variable *var = entry->var; - return (*var->getter)(entry->id, var->data, var); -} - struct trace_data { struct trace_var *trace; VALUE val; }; static VALUE -trace_ev(struct trace_data *data) +trace_ev(VALUE v) { + struct trace_data *data = (void *)v; struct trace_var *trace = data->trace; while (trace) { (*trace->func)(trace->data, data->val); trace = trace->next; } - return Qnil; /* not reached */ + + return Qnil; } static VALUE -trace_en(struct global_variable *var) +trace_en(VALUE v) { + struct rb_global_variable *var = (void *)v; var->block_trace = 0; remove_trace(var); return Qnil; /* not reached */ } -VALUE -rb_gvar_set(struct global_entry *entry, VALUE val) +static VALUE +rb_gvar_set_entry(struct rb_global_entry *entry, VALUE val) { struct trace_data trace; - struct global_variable *var = entry->var; + struct rb_global_variable *var = entry->var; - if (rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't change global variable value"); - (*var->setter)(val, entry->id, var->data, var); + (*var->setter)(val, entry->id, var->data); if (var->trace && !var->block_trace) { var->block_trace = 1; @@ -718,58 +743,98 @@ rb_gvar_set(struct global_entry *entry, VALUE val) } VALUE +rb_gvar_set(ID id, VALUE val) +{ + struct rb_global_entry *entry; + entry = rb_global_entry(id); + + return rb_gvar_set_entry(entry, val); +} + +VALUE rb_gv_set(const char *name, VALUE val) { - struct global_entry *entry; + return rb_gvar_set(global_id(name), val); +} - entry = rb_global_entry(global_id(name)); - return rb_gvar_set(entry, val); +VALUE +rb_gvar_get(ID id) +{ + struct rb_global_entry *entry = rb_global_entry(id); + struct rb_global_variable *var = entry->var; + return (*var->getter)(entry->id, var->data); } VALUE rb_gv_get(const char *name) { - struct global_entry *entry; + ID id = find_global_id(name); + + if (!id) { + rb_warning("global variable `%s' not initialized", name); + return Qnil; + } - entry = rb_global_entry(global_id(name)); - return rb_gvar_get(entry); + return rb_gvar_get(id); } -VALUE -rb_gvar_defined(struct global_entry *entry) +MJIT_FUNC_EXPORTED VALUE +rb_gvar_defined(ID id) { - if (entry->var->getter == undef_getter) return Qfalse; - return Qtrue; + struct rb_global_entry *entry = rb_global_entry(id); + return RBOOL(entry->var->getter != rb_gvar_undef_getter); } -static int -gvar_i(ID key, struct global_entry *entry, VALUE ary) +rb_gvar_getter_t * +rb_gvar_getter_function_of(ID id) { - rb_ary_push(ary, ID2SYM(key)); - return ST_CONTINUE; + const struct rb_global_entry *entry = rb_global_entry(id); + return entry->var->getter; } -/* - * call-seq: - * global_variables -> array - * - * Returns an array of the names of global variables. - * - * global_variables.grep /std/ #=> [:$stdin, :$stdout, :$stderr] - */ +rb_gvar_setter_t * +rb_gvar_setter_function_of(ID id) +{ + const struct rb_global_entry *entry = rb_global_entry(id); + return entry->var->setter; +} + +static enum rb_id_table_iterator_result +gvar_i(ID key, VALUE val, void *a) +{ + VALUE ary = (VALUE)a; + rb_ary_push(ary, ID2SYM(key)); + return ID_TABLE_CONTINUE; +} VALUE rb_f_global_variables(void) { VALUE ary = rb_ary_new(); - char buf[2]; - int i; + VALUE sym, backref = rb_backref_get(); + + if (!rb_ractor_main_p()) { + rb_raise(rb_eRactorIsolationError, "can not access global variables from non-main Ractors"); + } - st_foreach_safe(rb_global_tbl, gvar_i, ary); - buf[0] = '$'; - for (i = 1; i <= 9; ++i) { - buf[1] = (char)(i + '0'); - rb_ary_push(ary, ID2SYM(rb_intern2(buf, 2))); + rb_id_table_foreach(rb_global_tbl, gvar_i, (void *)ary); + if (!NIL_P(backref)) { + char buf[2]; + int i, nmatch = rb_match_count(backref); + buf[0] = '$'; + for (i = 1; i <= nmatch; ++i) { + if (!rb_match_nth_defined(i, backref)) continue; + if (i < 10) { + /* probably reused, make static ID */ + buf[1] = (char)(i + '0'); + sym = ID2SYM(rb_intern2(buf, 2)); + } + else { + /* dynamic symbol */ + sym = rb_str_intern(rb_sprintf("$%d", i)); + } + rb_ary_push(ary, sym); + } } return ary; } @@ -777,20 +842,22 @@ rb_f_global_variables(void) void rb_alias_variable(ID name1, ID name2) { - struct global_entry *entry1, *entry2; - st_data_t data1; + struct rb_global_entry *entry1, *entry2; + VALUE data1; + struct rb_id_table *gtbl = rb_global_tbl; - if (rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't alias global variable"); + if (!rb_ractor_main_p()) { + rb_raise(rb_eRactorIsolationError, "can not access global variables from non-main Ractors"); + } entry2 = rb_global_entry(name2); - if (!st_lookup(rb_global_tbl, (st_data_t)name1, &data1)) { - entry1 = ALLOC(struct global_entry); + if (!rb_id_table_lookup(gtbl, name1, &data1)) { + entry1 = ALLOC(struct rb_global_entry); entry1->id = name1; - st_add_direct(rb_global_tbl, name1, (st_data_t)entry1); + rb_id_table_insert(gtbl, name1, (VALUE)entry1); } - else if ((entry1 = (struct global_entry *)data1)->var != entry2->var) { - struct global_variable *var = entry1->var; + else if ((entry1 = (struct rb_global_entry *)data1)->var != entry2->var) { + struct rb_global_variable *var = entry1->var; if (var->block_trace) { rb_raise(rb_eRuntimeError, "can't alias in tracer"); } @@ -812,388 +879,936 @@ rb_alias_variable(ID name1, ID name2) entry1->var = entry2->var; } -static int special_generic_ivar = 0; -static st_table *generic_iv_tbl; - -st_table* -rb_generic_ivar_table(VALUE obj) +static bool +iv_index_tbl_lookup(struct st_table *tbl, ID id, uint32_t *indexp) { - st_data_t tbl; + st_data_t ent_data; + int r; - if (!FL_TEST(obj, FL_EXIVAR)) return 0; - if (!generic_iv_tbl) return 0; - if (!st_lookup(generic_iv_tbl, (st_data_t)obj, &tbl)) return 0; - return (st_table *)tbl; -} + if (tbl == NULL) return false; -static VALUE -generic_ivar_get(VALUE obj, ID id, int warn) -{ - st_data_t tbl, val; + RB_VM_LOCK_ENTER(); + { + r = st_lookup(tbl, (st_data_t)id, &ent_data); + } + RB_VM_LOCK_LEAVE(); - if (generic_iv_tbl) { - if (st_lookup(generic_iv_tbl, (st_data_t)obj, &tbl)) { - if (st_lookup((st_table *)tbl, (st_data_t)id, &val)) { - return (VALUE)val; - } - } + if (r) { + struct rb_iv_index_tbl_entry *ent = (void *)ent_data; + *indexp = ent->index; + return true; } - if (warn) { - rb_warning("instance variable %s not initialized", rb_id2name(id)); + else { + return false; } - return Qnil; } static void -generic_ivar_set(VALUE obj, ID id, VALUE val) +IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(ID id) +{ + if (UNLIKELY(!rb_ractor_main_p())) { + if (rb_is_instance_id(id)) { // check only normal ivars + rb_raise(rb_eRactorIsolationError, "can not set instance variables of classes/modules by non-main Ractors"); + } + } +} + +#define CVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR() \ + if (UNLIKELY(!rb_ractor_main_p())) { \ + rb_raise(rb_eRactorIsolationError, "can not access class variables from non-main Ractors"); \ + } + +static inline struct st_table * +generic_ivtbl(VALUE obj, ID id, bool force_check_ractor) +{ + ASSERT_vm_locking(); + + if ((force_check_ractor || LIKELY(rb_is_instance_id(id)) /* not internal ID */ ) && + !RB_OBJ_FROZEN_RAW(obj) && + UNLIKELY(!rb_ractor_main_p()) && + UNLIKELY(rb_ractor_shareable_p(obj))) { + + rb_raise(rb_eRactorIsolationError, "can not access instance variables of shareable objects from non-main Ractors"); + } + return generic_iv_tbl_; +} + +static inline struct st_table * +generic_ivtbl_no_ractor_check(VALUE obj) +{ + return generic_ivtbl(obj, 0, false); +} + +static int +gen_ivtbl_get(VALUE obj, ID id, struct gen_ivtbl **ivtbl) { - st_table *tbl; st_data_t data; + int r = 0; - if (rb_special_const_p(obj)) { - if (rb_obj_frozen_p(obj)) rb_error_frozen("object"); - special_generic_ivar = 1; + RB_VM_LOCK_ENTER(); + { + if (st_lookup(generic_ivtbl(obj, id, false), (st_data_t)obj, &data)) { + *ivtbl = (struct gen_ivtbl *)data; + r = 1; + } } - if (!generic_iv_tbl) { - generic_iv_tbl = st_init_numtable(); + RB_VM_LOCK_LEAVE(); + + return r; +} + +MJIT_FUNC_EXPORTED int +rb_ivar_generic_ivtbl_lookup(VALUE obj, struct gen_ivtbl **ivtbl) +{ + return gen_ivtbl_get(obj, 0, ivtbl); +} + +MJIT_FUNC_EXPORTED VALUE +rb_ivar_generic_lookup_with_index(VALUE obj, ID id, uint32_t index) +{ + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, id, &ivtbl)) { + if (LIKELY(index < ivtbl->numiv)) { + VALUE val = ivtbl->ivptr[index]; + return val; + } } - if (!st_lookup(generic_iv_tbl, (st_data_t)obj, &data)) { - FL_SET(obj, FL_EXIVAR); - tbl = st_init_numtable(); - st_add_direct(generic_iv_tbl, (st_data_t)obj, (st_data_t)tbl); - st_add_direct(tbl, (st_data_t)id, (st_data_t)val); - return; + + return Qundef; +} + +static VALUE +generic_ivar_delete(VALUE obj, ID id, VALUE undef) +{ + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, id, &ivtbl)) { + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + uint32_t index; + + if (iv_index_tbl && iv_index_tbl_lookup(iv_index_tbl, id, &index)) { + if (index < ivtbl->numiv) { + VALUE ret = ivtbl->ivptr[index]; + + ivtbl->ivptr[index] = Qundef; + return ret == Qundef ? undef : ret; + } + } } - st_insert((st_table *)data, (st_data_t)id, (st_data_t)val); + return undef; } static VALUE -generic_ivar_defined(VALUE obj, ID id) +generic_ivar_get(VALUE obj, ID id, VALUE undef) { - st_table *tbl; - st_data_t data; + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, id, &ivtbl)) { + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + uint32_t index; + + if (iv_index_tbl && iv_index_tbl_lookup(iv_index_tbl, id, &index)) { + if (index < ivtbl->numiv) { + VALUE ret = ivtbl->ivptr[index]; - if (!generic_iv_tbl) return Qfalse; - if (!st_lookup(generic_iv_tbl, (st_data_t)obj, &data)) return Qfalse; - tbl = (st_table *)data; - if (st_lookup(tbl, (st_data_t)id, &data)) { - return Qtrue; + return ret == Qundef ? undef : ret; + } + } } - return Qfalse; + return undef; } -static int -generic_ivar_remove(VALUE obj, ID id, st_data_t *valp) +static size_t +gen_ivtbl_bytes(size_t n) { - st_table *tbl; - st_data_t data, key = (st_data_t)id; - int status; + return offsetof(struct gen_ivtbl, ivptr) + n * sizeof(VALUE); +} + +static struct gen_ivtbl * +gen_ivtbl_resize(struct gen_ivtbl *old, uint32_t n) +{ + uint32_t len = old ? old->numiv : 0; + struct gen_ivtbl *ivtbl = xrealloc(old, gen_ivtbl_bytes(n)); - if (!generic_iv_tbl) return 0; - if (!st_lookup(generic_iv_tbl, (st_data_t)obj, &data)) return 0; - tbl = (st_table *)data; - status = st_delete(tbl, &key, valp); - if (tbl->num_entries == 0) { - key = (st_data_t)obj; - st_delete(generic_iv_tbl, &key, &data); - st_free_table((st_table *)data); + ivtbl->numiv = n; + for (; len < n; len++) { + ivtbl->ivptr[len] = Qundef; } - return status; + + return ivtbl; } -void -rb_mark_generic_ivar(VALUE obj) +#if 0 +static struct gen_ivtbl * +gen_ivtbl_dup(const struct gen_ivtbl *orig) { - st_data_t tbl; + size_t s = gen_ivtbl_bytes(orig->numiv); + struct gen_ivtbl *ivtbl = xmalloc(s); + + memcpy(ivtbl, orig, s); + + return ivtbl; +} +#endif - if (!generic_iv_tbl) return; - if (st_lookup(generic_iv_tbl, (st_data_t)obj, &tbl)) { - rb_mark_tbl((st_table *)tbl); +static uint32_t +iv_index_tbl_newsize(struct ivar_update *ivup) +{ + if (!ivup->iv_extended) { + return (uint32_t)ivup->u.iv_index_tbl->num_entries; + } + else { + uint32_t index = (uint32_t)ivup->index; /* should not overflow */ + return (index+1) + (index+1)/4; /* (index+1)*1.25 */ } } static int -givar_mark_i(ID key, VALUE value) +generic_ivar_update(st_data_t *k, st_data_t *v, st_data_t u, int existing) { - rb_gc_mark(value); + ASSERT_vm_locking(); + + struct ivar_update *ivup = (struct ivar_update *)u; + struct gen_ivtbl *ivtbl = 0; + + if (existing) { + ivtbl = (struct gen_ivtbl *)*v; + if (ivup->index < ivtbl->numiv) { + ivup->u.ivtbl = ivtbl; + return ST_STOP; + } + } + FL_SET((VALUE)*k, FL_EXIVAR); + uint32_t newsize = iv_index_tbl_newsize(ivup); + ivtbl = gen_ivtbl_resize(ivtbl, newsize); + *v = (st_data_t)ivtbl; + ivup->u.ivtbl = ivtbl; return ST_CONTINUE; } +static VALUE +generic_ivar_defined(VALUE obj, ID id) +{ + struct gen_ivtbl *ivtbl; + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + uint32_t index; + + if (!iv_index_tbl_lookup(iv_index_tbl, id, &index)) return Qfalse; + if (!gen_ivtbl_get(obj, id, &ivtbl)) return Qfalse; + + return RBOOL((index < ivtbl->numiv) && (ivtbl->ivptr[index] != Qundef)); +} + static int -givar_i(VALUE obj, st_table *tbl) +generic_ivar_remove(VALUE obj, ID id, VALUE *valp) { - if (rb_special_const_p(obj)) { - st_foreach_safe(tbl, givar_mark_i, 0); + struct gen_ivtbl *ivtbl; + uint32_t index; + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + + if (!iv_index_tbl) return 0; + if (!iv_index_tbl_lookup(iv_index_tbl, id, &index)) return 0; + if (!gen_ivtbl_get(obj, id, &ivtbl)) return 0; + + if (index < ivtbl->numiv) { + if (ivtbl->ivptr[index] != Qundef) { + *valp = ivtbl->ivptr[index]; + ivtbl->ivptr[index] = Qundef; + return 1; + } + } + return 0; +} + +static void +gen_ivtbl_mark(const struct gen_ivtbl *ivtbl) +{ + uint32_t i; + + for (i = 0; i < ivtbl->numiv; i++) { + rb_gc_mark(ivtbl->ivptr[i]); + } +} + +void +rb_mark_generic_ivar(VALUE obj) +{ + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, 0, &ivtbl)) { + gen_ivtbl_mark(ivtbl); } - return ST_CONTINUE; } void -rb_mark_generic_ivar_tbl(void) +rb_mv_generic_ivar(VALUE rsrc, VALUE dst) { - if (!generic_iv_tbl) return; - if (special_generic_ivar == 0) return; - st_foreach_safe(generic_iv_tbl, givar_i, 0); + st_data_t key = (st_data_t)rsrc; + st_data_t ivtbl; + + if (st_delete(generic_ivtbl_no_ractor_check(rsrc), &key, &ivtbl)) + st_insert(generic_ivtbl_no_ractor_check(dst), (st_data_t)dst, ivtbl); } void rb_free_generic_ivar(VALUE obj) { - st_data_t key = (st_data_t)obj, tbl; + st_data_t key = (st_data_t)obj, ivtbl; - if (!generic_iv_tbl) return; - if (st_delete(generic_iv_tbl, &key, &tbl)) - st_free_table((st_table *)tbl); + if (st_delete(generic_ivtbl_no_ractor_check(obj), &key, &ivtbl)) + xfree((struct gen_ivtbl *)ivtbl); } RUBY_FUNC_EXPORTED size_t rb_generic_ivar_memsize(VALUE obj) { - st_data_t tbl; - if (st_lookup(generic_iv_tbl, (st_data_t)obj, &tbl)) - return st_memsize((st_table *)tbl); + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, 0, &ivtbl)) + return gen_ivtbl_bytes(ivtbl->numiv); return 0; } -void -rb_copy_generic_ivar(VALUE clone, VALUE obj) +static size_t +gen_ivtbl_count(const struct gen_ivtbl *ivtbl) { - st_data_t data; + uint32_t i; + size_t n = 0; - if (!generic_iv_tbl) return; - if (!FL_TEST(obj, FL_EXIVAR)) { - clear: - if (FL_TEST(clone, FL_EXIVAR)) { - rb_free_generic_ivar(clone); - FL_UNSET(clone, FL_EXIVAR); - } - return; + for (i = 0; i < ivtbl->numiv; i++) { + if (ivtbl->ivptr[i] != Qundef) { + n++; + } } - if (st_lookup(generic_iv_tbl, (st_data_t)obj, &data)) { - st_table *tbl = (st_table *)data; - if (tbl->num_entries == 0) - goto clear; + return n; +} - if (st_lookup(generic_iv_tbl, (st_data_t)clone, &data)) { - st_free_table((st_table *)data); - st_insert(generic_iv_tbl, (st_data_t)clone, (st_data_t)st_copy(tbl)); - } - else { - st_add_direct(generic_iv_tbl, (st_data_t)clone, (st_data_t)st_copy(tbl)); - FL_SET(clone, FL_EXIVAR); - } +static int +lock_st_lookup(st_table *tab, st_data_t key, st_data_t *value) +{ + int r; + RB_VM_LOCK_ENTER(); + { + r = st_lookup(tab, key, value); } + RB_VM_LOCK_LEAVE(); + return r; } -static VALUE -ivar_get(VALUE obj, ID id, int warn) +static int +lock_st_delete(st_table *tab, st_data_t *key, st_data_t *value) { - VALUE val, *ptr; - struct st_table *iv_index_tbl; - long len; - st_data_t index; + int r; + RB_VM_LOCK_ENTER(); + { + r = st_delete(tab, key, value); + } + RB_VM_LOCK_LEAVE(); + return r; +} + +static int +lock_st_is_member(st_table *tab, st_data_t key) +{ + int r; + RB_VM_LOCK_ENTER(); + { + r = st_is_member(tab, key); + } + RB_VM_LOCK_LEAVE(); + return r; +} + +static int +lock_st_insert(st_table *tab, st_data_t key, st_data_t value) +{ + int r; + RB_VM_LOCK_ENTER(); + { + r = st_insert(tab, key, value); + } + RB_VM_LOCK_LEAVE(); + return r; +} - switch (TYPE(obj)) { +VALUE +rb_ivar_lookup(VALUE obj, ID id, VALUE undef) +{ + if (SPECIAL_CONST_P(obj)) return undef; + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: - len = ROBJECT_NUMIV(obj); - ptr = ROBJECT_IVPTR(obj); - iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj); - if (!iv_index_tbl) break; - if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) break; - if (len <= (long)index) break; - val = ptr[index]; - if (val != Qundef) - return val; - break; + { + uint32_t index; + uint32_t len = ROBJECT_NUMIV(obj); + VALUE *ptr = ROBJECT_IVPTR(obj); + VALUE val; + + if (iv_index_tbl_lookup(ROBJECT_IV_INDEX_TBL(obj), id, &index) && + index < len && + (val = ptr[index]) != Qundef) { + return val; + } + else { + break; + } + } case T_CLASS: case T_MODULE: - if (RCLASS_IV_TBL(obj) && st_lookup(RCLASS_IV_TBL(obj), (st_data_t)id, &index)) - return (VALUE)index; - break; + { + st_data_t val; + + if (RCLASS_IV_TBL(obj) && + lock_st_lookup(RCLASS_IV_TBL(obj), (st_data_t)id, &val)) { + if (rb_is_instance_id(id) && + UNLIKELY(!rb_ractor_main_p()) && + !rb_ractor_shareable_p(val)) { + rb_raise(rb_eRactorIsolationError, + "can not get unshareable values from instance variables of classes/modules from non-main Ractors"); + } + return val; + } + else { + break; + } + } default: - if (FL_TEST(obj, FL_EXIVAR) || rb_special_const_p(obj)) - return generic_ivar_get(obj, id, warn); + if (FL_TEST(obj, FL_EXIVAR)) + return generic_ivar_get(obj, id, undef); break; } - if (warn) { - rb_warning("instance variable %s not initialized", rb_id2name(id)); - } - return Qnil; + return undef; } VALUE rb_ivar_get(VALUE obj, ID id) { - return ivar_get(obj, id, TRUE); + VALUE iv = rb_ivar_lookup(obj, id, Qnil); + RB_DEBUG_COUNTER_INC(ivar_get_base); + return iv; } VALUE rb_attr_get(VALUE obj, ID id) { - return ivar_get(obj, id, FALSE); + return rb_ivar_lookup(obj, id, Qnil); } -VALUE -rb_ivar_set(VALUE obj, ID id, VALUE val) +static VALUE +rb_ivar_delete(VALUE obj, ID id, VALUE undef) { + VALUE *ptr; struct st_table *iv_index_tbl; - st_data_t index; - long i, len; - int ivar_extended; + uint32_t len, index; - if (!OBJ_UNTRUSTED(obj) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't modify instance variable"); rb_check_frozen(obj); - switch (TYPE(obj)) { + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: + len = ROBJECT_NUMIV(obj); + ptr = ROBJECT_IVPTR(obj); iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj); - if (!iv_index_tbl) { - VALUE klass = rb_obj_class(obj); - iv_index_tbl = RCLASS_IV_INDEX_TBL(klass); - if (!iv_index_tbl) { - iv_index_tbl = RCLASS_IV_INDEX_TBL(klass) = st_init_numtable(); + if (iv_index_tbl_lookup(iv_index_tbl, id, &index) && + index < len) { + VALUE val = ptr[index]; + ptr[index] = Qundef; + + if (val != Qundef) { + return val; } } - ivar_extended = 0; - if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) { - index = iv_index_tbl->num_entries; - st_add_direct(iv_index_tbl, (st_data_t)id, index); - ivar_extended = 1; - } - len = ROBJECT_NUMIV(obj); - if (len <= (long)index) { - VALUE *ptr = ROBJECT_IVPTR(obj); - if (index < ROBJECT_EMBED_LEN_MAX) { - RBASIC(obj)->flags |= ROBJECT_EMBED; - ptr = ROBJECT(obj)->as.ary; - for (i = 0; i < ROBJECT_EMBED_LEN_MAX; i++) { - ptr[i] = Qundef; - } - } - else { - VALUE *newptr; - long newsize = (index+1) + (index+1)/4; /* (index+1)*1.25 */ - if (!ivar_extended && - iv_index_tbl->num_entries < (st_index_t)newsize) { - newsize = iv_index_tbl->num_entries; - } - if (RBASIC(obj)->flags & ROBJECT_EMBED) { - newptr = ALLOC_N(VALUE, newsize); - MEMCPY(newptr, ptr, VALUE, len); - RBASIC(obj)->flags &= ~ROBJECT_EMBED; - ROBJECT(obj)->as.heap.ivptr = newptr; - } - else { - REALLOC_N(ROBJECT(obj)->as.heap.ivptr, VALUE, newsize); - newptr = ROBJECT(obj)->as.heap.ivptr; - } - for (; len < newsize; len++) - newptr[len] = Qundef; - ROBJECT(obj)->as.heap.numiv = newsize; - ROBJECT(obj)->as.heap.iv_index_tbl = iv_index_tbl; + break; + case T_CLASS: + case T_MODULE: + IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(id); + if (RCLASS_IV_TBL(obj)) { + st_data_t id_data = (st_data_t)id, val; + if (lock_st_delete(RCLASS_IV_TBL(obj), &id_data, &val)) { + return (VALUE)val; } } - ROBJECT_IVPTR(obj)[index] = val; break; + default: + if (FL_TEST(obj, FL_EXIVAR)) + return generic_ivar_delete(obj, id, undef); + break; + } + return undef; +} + +VALUE +rb_attr_delete(VALUE obj, ID id) +{ + return rb_ivar_delete(obj, id, Qnil); +} + +static st_table * +iv_index_tbl_make(VALUE obj, VALUE klass) +{ + st_table *iv_index_tbl; + + if (UNLIKELY(!klass)) { + rb_raise(rb_eTypeError, "hidden object cannot have instance variables"); + } + + if ((iv_index_tbl = RCLASS_IV_INDEX_TBL(klass)) == NULL) { + RB_VM_LOCK_ENTER(); + if ((iv_index_tbl = RCLASS_IV_INDEX_TBL(klass)) == NULL) { + iv_index_tbl = RCLASS_IV_INDEX_TBL(klass) = st_init_numtable(); + } + RB_VM_LOCK_LEAVE(); + } + + return iv_index_tbl; +} + +static void +iv_index_tbl_extend(struct ivar_update *ivup, ID id, VALUE klass) +{ + ASSERT_vm_locking(); + st_data_t ent_data; + struct rb_iv_index_tbl_entry *ent; + + if (st_lookup(ivup->u.iv_index_tbl, (st_data_t)id, &ent_data)) { + ent = (void *)ent_data; + ivup->index = ent->index; + return; + } + if (ivup->u.iv_index_tbl->num_entries >= INT_MAX) { + rb_raise(rb_eArgError, "too many instance variables"); + } + ent = ALLOC(struct rb_iv_index_tbl_entry); + ent->index = ivup->index = (uint32_t)ivup->u.iv_index_tbl->num_entries; + ent->class_value = klass; + ent->class_serial = RCLASS_SERIAL(klass); + st_add_direct(ivup->u.iv_index_tbl, (st_data_t)id, (st_data_t)ent); + ivup->iv_extended = 1; +} + +static void +generic_ivar_set(VALUE obj, ID id, VALUE val) +{ + VALUE klass = rb_obj_class(obj); + struct ivar_update ivup; + ivup.iv_extended = 0; + ivup.u.iv_index_tbl = iv_index_tbl_make(obj, klass); + + RB_VM_LOCK_ENTER(); + { + iv_index_tbl_extend(&ivup, id, klass); + st_update(generic_ivtbl(obj, id, false), (st_data_t)obj, generic_ivar_update, + (st_data_t)&ivup); + } + RB_VM_LOCK_LEAVE(); + + ivup.u.ivtbl->ivptr[ivup.index] = val; + + RB_OBJ_WRITTEN(obj, Qundef, val); +} + +static VALUE * +obj_ivar_heap_alloc(VALUE obj, size_t newsize) +{ + VALUE *newptr = rb_transient_heap_alloc(obj, sizeof(VALUE) * newsize); + + if (newptr != NULL) { + ROBJ_TRANSIENT_SET(obj); + } + else { + ROBJ_TRANSIENT_UNSET(obj); + newptr = ALLOC_N(VALUE, newsize); + } + return newptr; +} + +static VALUE * +obj_ivar_heap_realloc(VALUE obj, int32_t len, size_t newsize) +{ + VALUE *newptr; + int i; + + if (ROBJ_TRANSIENT_P(obj)) { + const VALUE *orig_ptr = ROBJECT(obj)->as.heap.ivptr; + newptr = obj_ivar_heap_alloc(obj, newsize); + + assert(newptr); + ROBJECT(obj)->as.heap.ivptr = newptr; + for (i=0; i<(int)len; i++) { + newptr[i] = orig_ptr[i]; + } + } + else { + REALLOC_N(ROBJECT(obj)->as.heap.ivptr, VALUE, newsize); + newptr = ROBJECT(obj)->as.heap.ivptr; + } + + return newptr; +} + +#if USE_TRANSIENT_HEAP +void +rb_obj_transient_heap_evacuate(VALUE obj, int promote) +{ + if (ROBJ_TRANSIENT_P(obj)) { + uint32_t len = ROBJECT_NUMIV(obj); + const VALUE *old_ptr = ROBJECT_IVPTR(obj); + VALUE *new_ptr; + + if (promote) { + new_ptr = ALLOC_N(VALUE, len); + ROBJ_TRANSIENT_UNSET(obj); + } + else { + new_ptr = obj_ivar_heap_alloc(obj, len); + } + MEMCPY(new_ptr, old_ptr, VALUE, len); + ROBJECT(obj)->as.heap.ivptr = new_ptr; + } +} +#endif + +static void +init_iv_list(VALUE obj, uint32_t len, uint32_t newsize, st_table *index_tbl) +{ + VALUE *ptr = ROBJECT_IVPTR(obj); + VALUE *newptr; + + if (RBASIC(obj)->flags & ROBJECT_EMBED) { + newptr = obj_ivar_heap_alloc(obj, newsize); + MEMCPY(newptr, ptr, VALUE, len); + RBASIC(obj)->flags &= ~ROBJECT_EMBED; + ROBJECT(obj)->as.heap.ivptr = newptr; + } + else { + newptr = obj_ivar_heap_realloc(obj, len, newsize); + } + + for (; len < newsize; len++) { + newptr[len] = Qundef; + } + ROBJECT(obj)->as.heap.numiv = newsize; + ROBJECT(obj)->as.heap.iv_index_tbl = index_tbl; +} + +void +rb_init_iv_list(VALUE obj) +{ + st_table *index_tbl = ROBJECT_IV_INDEX_TBL(obj); + uint32_t newsize = (uint32_t)index_tbl->num_entries; + uint32_t len = ROBJECT_NUMIV(obj); + init_iv_list(obj, len, newsize, index_tbl); +} + +// Retrieve or create the id-to-index mapping for a given object and an +// instance variable name. +static struct ivar_update +obj_ensure_iv_index_mapping(VALUE obj, ID id) +{ + VALUE klass = rb_obj_class(obj); + struct ivar_update ivup; + ivup.iv_extended = 0; + ivup.u.iv_index_tbl = iv_index_tbl_make(obj, klass); + + RB_VM_LOCK_ENTER(); + { + iv_index_tbl_extend(&ivup, id, klass); + } + RB_VM_LOCK_LEAVE(); + + return ivup; +} + +// Return the instance variable index for a given name and T_OBJECT object. The +// mapping between name and index lives on `rb_obj_class(obj)` and is created +// if not already present. +// +// @note May raise when there are too many instance variables. +// @note YJIT uses this function at compile time to simplify the work needed to +// access the variable at runtime. +uint32_t +rb_obj_ensure_iv_index_mapping(VALUE obj, ID id) +{ + RUBY_ASSERT(RB_TYPE_P(obj, T_OBJECT)); + // This uint32_t cast shouldn't lose information as it's checked in + // iv_index_tbl_extend(). The index is stored as an uint32_t in + // struct rb_iv_index_tbl_entry. + return (uint32_t)obj_ensure_iv_index_mapping(obj, id).index; +} + +static VALUE +obj_ivar_set(VALUE obj, ID id, VALUE val) +{ + uint32_t len; + struct ivar_update ivup = obj_ensure_iv_index_mapping(obj, id); + + len = ROBJECT_NUMIV(obj); + if (len <= ivup.index) { + uint32_t newsize = iv_index_tbl_newsize(&ivup); + init_iv_list(obj, len, newsize, ivup.u.iv_index_tbl); + } + RB_OBJ_WRITE(obj, &ROBJECT_IVPTR(obj)[ivup.index], val); + + return val; +} + +static void +ivar_set(VALUE obj, ID id, VALUE val) +{ + RB_DEBUG_COUNTER_INC(ivar_set_base); + + switch (BUILTIN_TYPE(obj)) { + case T_OBJECT: + obj_ivar_set(obj, id, val); + break; case T_CLASS: case T_MODULE: - if (!RCLASS_IV_TBL(obj)) RCLASS_IV_TBL(obj) = st_init_numtable(); - st_insert(RCLASS_IV_TBL(obj), (st_data_t)id, val); + IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(id); + rb_class_ivar_set(obj, id, val); break; default: - generic_ivar_set(obj, id, val); - break; + generic_ivar_set(obj, id, val); + break; } +} + +VALUE +rb_ivar_set(VALUE obj, ID id, VALUE val) +{ + rb_check_frozen(obj); + ivar_set(obj, id, val); return val; } +void +rb_ivar_set_internal(VALUE obj, ID id, VALUE val) +{ + // should be internal instance variable name (no @ prefix) + VM_ASSERT(!rb_is_instance_id(id)); + + ivar_set(obj, id, val); +} + VALUE rb_ivar_defined(VALUE obj, ID id) { VALUE val; struct st_table *iv_index_tbl; - st_data_t index; - switch (TYPE(obj)) { + uint32_t index; + + if (SPECIAL_CONST_P(obj)) return Qfalse; + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj); - if (!iv_index_tbl) break; - if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) break; - if (ROBJECT_NUMIV(obj) <= (long)index) break; - val = ROBJECT_IVPTR(obj)[index]; - if (val != Qundef) + if (iv_index_tbl_lookup(iv_index_tbl, id, &index) && + index < ROBJECT_NUMIV(obj) && + (val = ROBJECT_IVPTR(obj)[index]) != Qundef) { return Qtrue; + } break; case T_CLASS: case T_MODULE: - if (RCLASS_IV_TBL(obj) && st_lookup(RCLASS_IV_TBL(obj), (st_data_t)id, 0)) + if (RCLASS_IV_TBL(obj) && lock_st_is_member(RCLASS_IV_TBL(obj), (st_data_t)id)) return Qtrue; break; default: - if (FL_TEST(obj, FL_EXIVAR) || rb_special_const_p(obj)) + if (FL_TEST(obj, FL_EXIVAR)) return generic_ivar_defined(obj, id); break; } return Qfalse; } -struct obj_ivar_tag { +typedef int rb_ivar_foreach_callback_func(ID key, VALUE val, st_data_t arg); +st_data_t rb_st_nth_key(st_table *tab, st_index_t index); + +static ID +iv_index_tbl_nth_id(st_table *iv_index_tbl, uint32_t index) +{ + st_data_t key; + RB_VM_LOCK_ENTER(); + { + key = rb_st_nth_key(iv_index_tbl, index); + } + RB_VM_LOCK_LEAVE(); + return (ID)key; +} + +static inline bool +ivar_each_i(st_table *iv_index_tbl, VALUE val, uint32_t i, rb_ivar_foreach_callback_func *func, st_data_t arg) +{ + if (val != Qundef) { + ID id = iv_index_tbl_nth_id(iv_index_tbl, i); + switch (func(id, val, arg)) { + case ST_CHECK: + case ST_CONTINUE: + break; + case ST_STOP: + return true; + default: + rb_bug("unreachable"); + } + } + return false; +} + +static void +obj_ivar_each(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg) +{ + st_table *iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj); + if (!iv_index_tbl) return; + uint32_t i=0; + + for (i=0; i < ROBJECT_NUMIV(obj); i++) { + VALUE val = ROBJECT_IVPTR(obj)[i]; + if (ivar_each_i(iv_index_tbl, val, i, func, arg)) { + return; + } + } +} + +static void +gen_ivar_each(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg) +{ + struct gen_ivtbl *ivtbl; + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + if (!iv_index_tbl) return; + if (!gen_ivtbl_get(obj, 0, &ivtbl)) return; + + for (uint32_t i=0; i<ivtbl->numiv; i++) { + VALUE val = ivtbl->ivptr[i]; + if (ivar_each_i(iv_index_tbl, val, i, func, arg)) { + return; + } + } +} + +struct givar_copy { VALUE obj; - int (*func)(ID key, VALUE val, st_data_t arg); - st_data_t arg; + VALUE klass; + st_table *iv_index_tbl; + struct gen_ivtbl *ivtbl; }; static int -obj_ivar_i(st_data_t key, st_data_t index, st_data_t arg) +gen_ivar_copy(ID id, VALUE val, st_data_t arg) { - struct obj_ivar_tag *data = (struct obj_ivar_tag *)arg; - if ((long)index < ROBJECT_NUMIV(data->obj)) { - VALUE val = ROBJECT_IVPTR(data->obj)[(long)index]; - if (val != Qundef) { - return (data->func)((ID)key, val, data->arg); - } + struct givar_copy *c = (struct givar_copy *)arg; + struct ivar_update ivup; + + ivup.iv_extended = 0; + ivup.u.iv_index_tbl = c->iv_index_tbl; + + RB_VM_LOCK_ENTER(); + { + iv_index_tbl_extend(&ivup, id, c->klass); } + RB_VM_LOCK_LEAVE(); + + if (ivup.index >= c->ivtbl->numiv) { + uint32_t newsize = iv_index_tbl_newsize(&ivup); + c->ivtbl = gen_ivtbl_resize(c->ivtbl, newsize); + } + c->ivtbl->ivptr[ivup.index] = val; + + RB_OBJ_WRITTEN(c->obj, Qundef, val); + return ST_CONTINUE; } -static void -obj_ivar_each(VALUE obj, int (*func)(ANYARGS), st_data_t arg) +void +rb_copy_generic_ivar(VALUE clone, VALUE obj) { - st_table *tbl; - struct obj_ivar_tag data; + struct gen_ivtbl *ivtbl; - tbl = ROBJECT_IV_INDEX_TBL(obj); - if (!tbl) - return; + rb_check_frozen(clone); - data.obj = obj; - data.func = (int (*)(ID key, VALUE val, st_data_t arg))func; - data.arg = arg; + if (!FL_TEST(obj, FL_EXIVAR)) { + goto clear; + } + if (gen_ivtbl_get(obj, 0, &ivtbl)) { + struct givar_copy c; + uint32_t i; + + if (gen_ivtbl_count(ivtbl) == 0) + goto clear; - st_foreach_safe(tbl, obj_ivar_i, (st_data_t)&data); + if (gen_ivtbl_get(clone, 0, &c.ivtbl)) { + for (i = 0; i < c.ivtbl->numiv; i++) + c.ivtbl->ivptr[i] = Qundef; + } + else { + c.ivtbl = gen_ivtbl_resize(0, ivtbl->numiv); + FL_SET(clone, FL_EXIVAR); + } + + VALUE klass = rb_obj_class(clone); + c.iv_index_tbl = iv_index_tbl_make(clone, klass); + c.obj = clone; + c.klass = klass; + gen_ivar_each(obj, gen_ivar_copy, (st_data_t)&c); + /* + * c.ivtbl may change in gen_ivar_copy due to realloc, + * no need to free + */ + RB_VM_LOCK_ENTER(); + { + generic_ivtbl_no_ractor_check(clone); + st_insert(generic_ivtbl_no_ractor_check(obj), (st_data_t)clone, (st_data_t)c.ivtbl); + } + RB_VM_LOCK_LEAVE(); + } + return; + + clear: + if (FL_TEST(clone, FL_EXIVAR)) { + rb_free_generic_ivar(clone); + FL_UNSET(clone, FL_EXIVAR); + } } void -rb_ivar_foreach(VALUE obj, int (*func)(ANYARGS), st_data_t arg) +rb_replace_generic_ivar(VALUE clone, VALUE obj) { - switch (TYPE(obj)) { + RUBY_ASSERT(FL_TEST(obj, FL_EXIVAR)); + + RB_VM_LOCK_ENTER(); + { + st_data_t ivtbl, obj_data = (st_data_t)obj; + if (st_lookup(generic_iv_tbl_, (st_data_t)obj, &ivtbl)) { + st_insert(generic_iv_tbl_, (st_data_t)clone, ivtbl); + st_delete(generic_iv_tbl_, &obj_data, NULL); + } + else { + rb_bug("unreachable"); + } + } + RB_VM_LOCK_LEAVE(); + + FL_SET(clone, FL_EXIVAR); +} + +void +rb_ivar_foreach(VALUE obj, rb_ivar_foreach_callback_func *func, st_data_t arg) +{ + if (SPECIAL_CONST_P(obj)) return; + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: obj_ivar_each(obj, func, arg); break; case T_CLASS: case T_MODULE: + IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(0); if (RCLASS_IV_TBL(obj)) { - st_foreach_safe(RCLASS_IV_TBL(obj), func, arg); + RB_VM_LOCK_ENTER(); + { + st_foreach_safe(RCLASS_IV_TBL(obj), func, arg); + } + RB_VM_LOCK_LEAVE(); } break; default: - if (!generic_iv_tbl) break; - if (FL_TEST(obj, FL_EXIVAR) || rb_special_const_p(obj)) { - st_data_t tbl; - - if (st_lookup(generic_iv_tbl, (st_data_t)obj, &tbl)) { - st_foreach_safe((st_table *)tbl, func, arg); - } + if (FL_TEST(obj, FL_EXIVAR)) { + gen_ivar_each(obj, func, arg); } break; } @@ -1203,10 +1818,13 @@ st_index_t rb_ivar_count(VALUE obj) { st_table *tbl; - switch (TYPE(obj)) { + + if (SPECIAL_CONST_P(obj)) return 0; + + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: - if ((tbl = ROBJECT_IV_INDEX_TBL(obj)) != 0) { - st_index_t i, count, num = tbl->num_entries; + if (ROBJECT_IV_INDEX_TBL(obj) != 0) { + st_index_t i, count, num = ROBJECT_NUMIV(obj); const VALUE *const ivptr = ROBJECT_IVPTR(obj); for (i = count = 0; i < num; ++i) { if (ivptr[i] != Qundef) { @@ -1214,7 +1832,7 @@ rb_ivar_count(VALUE obj) } } return count; - } + } break; case T_CLASS: case T_MODULE: @@ -1223,13 +1841,11 @@ rb_ivar_count(VALUE obj) } break; default: - if (!generic_iv_tbl) break; - if (FL_TEST(obj, FL_EXIVAR) || rb_special_const_p(obj)) { - st_data_t data; + if (FL_TEST(obj, FL_EXIVAR)) { + struct gen_ivtbl *ivtbl; - if (st_lookup(generic_iv_tbl, (st_data_t)obj, &data) && - (tbl = (st_table *)data) != 0) { - return tbl->num_entries; + if (gen_ivtbl_get(obj, 0, &ivtbl)) { + return gen_ivtbl_count(ivtbl); } } break; @@ -1238,8 +1854,11 @@ rb_ivar_count(VALUE obj) } static int -ivar_i(ID key, VALUE val, VALUE ary) +ivar_i(st_data_t k, st_data_t v, st_data_t a) { + ID key = (ID)k; + VALUE ary = (VALUE)a; + if (rb_is_instance_id(key)) { rb_ary_push(ary, ID2SYM(key)); } @@ -1273,12 +1892,35 @@ rb_obj_instance_variables(VALUE obj) return ary; } +#define rb_is_constant_id rb_is_const_id +#define rb_is_constant_name rb_is_const_name +#define id_for_var(obj, name, part, type) \ + id_for_var_message(obj, name, type, "`%1$s' is not allowed as "#part" "#type" variable name") +#define id_for_var_message(obj, name, type, message) \ + check_id_type(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message)) +static ID +check_id_type(VALUE obj, VALUE *pname, + int (*valid_id_p)(ID), int (*valid_name_p)(VALUE), + const char *message, size_t message_len) +{ + ID id = rb_check_id(pname); + VALUE name = *pname; + + if (id ? !valid_id_p(id) : !valid_name_p(name)) { + rb_name_err_raise_str(rb_fstring_new(message, message_len), + obj, name); + } + return id; +} + /* * call-seq: * obj.remove_instance_variable(symbol) -> obj + * obj.remove_instance_variable(string) -> obj * * Removes the named instance variable from <i>obj</i>, returning that * variable's value. + * String arguments are converted to symbols. * * class Dummy * attr_reader :var @@ -1299,67 +1941,67 @@ VALUE rb_obj_remove_instance_variable(VALUE obj, VALUE name) { VALUE val = Qnil; - const ID id = rb_to_id(name); + const ID id = id_for_var(obj, name, an, instance); st_data_t n, v; struct st_table *iv_index_tbl; - st_data_t index; + uint32_t index; - if (!OBJ_UNTRUSTED(obj) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't modify instance variable"); rb_check_frozen(obj); - if (!rb_is_instance_id(id)) { - rb_name_error(id, "`%s' is not allowed as an instance variable name", rb_id2name(id)); + if (!id) { + goto not_defined; } - switch (TYPE(obj)) { + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj); - if (!iv_index_tbl) break; - if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) break; - if (ROBJECT_NUMIV(obj) <= (long)index) break; - val = ROBJECT_IVPTR(obj)[index]; - if (val != Qundef) { + if (iv_index_tbl_lookup(iv_index_tbl, id, &index) && + index < ROBJECT_NUMIV(obj) && + (val = ROBJECT_IVPTR(obj)[index]) != Qundef) { ROBJECT_IVPTR(obj)[index] = Qundef; return val; } break; case T_CLASS: case T_MODULE: + IVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(id); n = id; - if (RCLASS_IV_TBL(obj) && st_delete(RCLASS_IV_TBL(obj), &n, &v)) { + if (RCLASS_IV_TBL(obj) && lock_st_delete(RCLASS_IV_TBL(obj), &n, &v)) { return (VALUE)v; } break; default: - if (FL_TEST(obj, FL_EXIVAR) || rb_special_const_p(obj)) { - v = val; - if (generic_ivar_remove(obj, (st_data_t)id, &v)) { - return (VALUE)v; + if (FL_TEST(obj, FL_EXIVAR)) { + if (generic_ivar_remove(obj, id, &val)) { + return val; } } break; } - rb_name_error(id, "instance variable %s not defined", rb_id2name(id)); - return Qnil; /* not reached */ + + not_defined: + rb_name_err_raise("instance variable %1$s not defined", + obj, name); + UNREACHABLE_RETURN(Qnil); } -NORETURN(static void uninitialized_constant(VALUE, ID)); +NORETURN(static void uninitialized_constant(VALUE, VALUE)); static void -uninitialized_constant(VALUE klass, ID id) +uninitialized_constant(VALUE klass, VALUE name) { if (klass && rb_class_real(klass) != rb_cObject) - rb_name_error(id, "uninitialized constant %s::%s", - rb_class2name(klass), - rb_id2name(id)); - else { - rb_name_error(id, "uninitialized constant %s", rb_id2name(id)); - } + rb_name_err_raise("uninitialized constant %2$s::%1$s", + klass, name); + else + rb_name_err_raise("uninitialized constant %1$s", + klass, name); } -static VALUE -const_missing(VALUE klass, ID id) +VALUE +rb_const_missing(VALUE klass, VALUE name) { - return rb_funcall(klass, rb_intern("const_missing"), 1, ID2SYM(id)); + VALUE value = rb_funcallv(klass, idConst_missing, 1, &name); + rb_vm_inc_const_missing_count(); + return value; } @@ -1402,15 +2044,21 @@ const_missing(VALUE klass, ID id) VALUE rb_mod_const_missing(VALUE klass, VALUE name) { - rb_frame_pop(); /* pop frame for "const_missing" */ - uninitialized_constant(klass, rb_to_id(name)); - return Qnil; /* not reached */ + VALUE ref = GET_EC()->private_const_reference; + rb_vm_pop_cfunc_frame(); + if (ref) { + rb_name_err_raise("private constant %2$s::%1$s referenced", + ref, name); + } + uninitialized_constant(klass, name); + + UNREACHABLE_RETURN(Qnil); } static void autoload_mark(void *ptr) { - rb_mark_tbl((st_table *)ptr); + rb_mark_tbl_no_pin((st_table *)ptr); } static void @@ -1426,30 +2074,194 @@ autoload_memsize(const void *ptr) return st_memsize(tbl); } +static void +autoload_compact(void *ptr) +{ + rb_gc_update_tbl_refs((st_table *)ptr); +} + static const rb_data_type_t autoload_data_type = { "autoload", - {autoload_mark, autoload_free, autoload_memsize,}, + {autoload_mark, autoload_free, autoload_memsize, autoload_compact,}, + 0, 0, RUBY_TYPED_FREE_IMMEDIATELY }; #define check_autoload_table(av) \ (struct st_table *)rb_check_typeddata((av), &autoload_data_type) -void +static VALUE +autoload_data(VALUE mod, ID id) +{ + struct st_table *tbl; + st_data_t val; + + if (!st_lookup(RCLASS_IV_TBL(mod), autoload, &val) || + !(tbl = check_autoload_table((VALUE)val)) || + !st_lookup(tbl, (st_data_t)id, &val)) { + return 0; + } + return (VALUE)val; +} + +struct autoload_const { + struct list_node cnode; /* <=> autoload_data_i.constants */ + VALUE mod; + VALUE ad; /* autoload_data_i */ + VALUE value; + VALUE file; + ID id; + rb_const_flag_t flag; + int line; +}; + +/* always on stack, no need to mark */ +struct autoload_state { + struct autoload_const *ac; + VALUE result; + VALUE thread; + struct list_head waitq; +}; + +struct autoload_data_i { + VALUE feature; + struct autoload_state *state; /* points to on-stack struct */ + rb_serial_t fork_gen; + struct list_head constants; /* <=> autoload_const.cnode */ +}; + +static void +autoload_i_compact(void *ptr) +{ + struct autoload_data_i *p = ptr; + p->feature = rb_gc_location(p->feature); +} + +static void +autoload_i_mark(void *ptr) +{ + struct autoload_data_i *p = ptr; + + rb_gc_mark_movable(p->feature); + + /* allow GC to free us if no modules refer to this via autoload_const.ad */ + if (list_empty(&p->constants)) { + rb_hash_delete(autoload_featuremap, p->feature); + } +} + +static void +autoload_i_free(void *ptr) +{ + struct autoload_data_i *p = ptr; + + /* we may leak some memory at VM shutdown time, no big deal */ + if (list_empty(&p->constants)) { + xfree(p); + } +} + +static size_t +autoload_i_memsize(const void *ptr) +{ + return sizeof(struct autoload_data_i); +} + +static const rb_data_type_t autoload_data_i_type = { + "autoload_i", + {autoload_i_mark, autoload_i_free, autoload_i_memsize, autoload_i_compact}, + 0, 0, RUBY_TYPED_FREE_IMMEDIATELY +}; + +static void +autoload_c_compact(void *ptr) +{ + struct autoload_const *ac = ptr; + + ac->mod = rb_gc_location(ac->mod); + ac->ad = rb_gc_location(ac->ad); + ac->value = rb_gc_location(ac->value); + ac->file = rb_gc_location(ac->file); +} + +static void +autoload_c_mark(void *ptr) +{ + struct autoload_const *ac = ptr; + + rb_gc_mark_movable(ac->mod); + rb_gc_mark_movable(ac->ad); + rb_gc_mark_movable(ac->value); + rb_gc_mark_movable(ac->file); +} + +static void +autoload_c_free(void *ptr) +{ + struct autoload_const *ac = ptr; + list_del(&ac->cnode); + xfree(ac); +} + +static size_t +autoload_c_memsize(const void *ptr) +{ + return sizeof(struct autoload_const); +} + +static const rb_data_type_t autoload_const_type = { + "autoload_const", + {autoload_c_mark, autoload_c_free, autoload_c_memsize, autoload_c_compact,}, + 0, 0, RUBY_TYPED_FREE_IMMEDIATELY +}; + +static struct autoload_data_i * +get_autoload_data(VALUE acv, struct autoload_const **acp) +{ + struct autoload_const *ac = rb_check_typeddata(acv, &autoload_const_type); + struct autoload_data_i *ele; + + ele = rb_check_typeddata(ac->ad, &autoload_data_i_type); + /* do not reach across stack for ->state after forking: */ + if (ele && ele->state && ele->fork_gen != GET_VM()->fork_gen) { + ele->state = 0; + ele->fork_gen = 0; + } + if (acp) *acp = ac; + return ele; +} + +RUBY_FUNC_EXPORTED void rb_autoload(VALUE mod, ID id, const char *file) { + if (!file || !*file) { + rb_raise(rb_eArgError, "empty file name"); + } + rb_autoload_str(mod, id, rb_fstring_cstr(file)); +} + +void +rb_autoload_str(VALUE mod, ID id, VALUE file) +{ st_data_t av; - VALUE fn; + VALUE ad; struct st_table *tbl; + struct autoload_data_i *ele; + rb_const_entry_t *ce; if (!rb_is_const_id(id)) { - rb_raise(rb_eNameError, "autoload must be constant name: %s", rb_id2name(id)); + rb_raise(rb_eNameError, "autoload must be constant name: %"PRIsVALUE"", + QUOTE_ID(id)); } - if (!file || !*file) { + + Check_Type(file, T_STRING); + if (!RSTRING_LEN(file)) { rb_raise(rb_eArgError, "empty file name"); } - if ((tbl = RCLASS_CONST_TBL(mod)) && st_lookup(tbl, (st_data_t)id, &av) && ((rb_const_entry_t*)av)->value != Qundef) + ce = rb_const_lookup(mod, id); + if (ce && ce->value != Qundef) { return; + } rb_const_set(mod, id, Qundef); tbl = RCLASS_IV_TBL(mod); @@ -1460,75 +2272,106 @@ rb_autoload(VALUE mod, ID id, const char *file) if (!tbl) tbl = RCLASS_IV_TBL(mod) = st_init_numtable(); av = (st_data_t)TypedData_Wrap_Struct(0, &autoload_data_type, 0); st_add_direct(tbl, (st_data_t)autoload, av); + RB_OBJ_WRITTEN(mod, Qnil, av); DATA_PTR(av) = tbl = st_init_numtable(); } - fn = rb_str_new2(file); - FL_UNSET(fn, FL_TAINT); - OBJ_FREEZE(fn); - st_insert(tbl, (st_data_t)id, (st_data_t)rb_node_newnode(NODE_MEMO, fn, rb_safe_level(), 0)); + + file = rb_fstring(file); + if (!autoload_featuremap) { + autoload_featuremap = rb_ident_hash_new(); + rb_obj_hide(autoload_featuremap); + rb_gc_register_mark_object(autoload_featuremap); + } + ad = rb_hash_aref(autoload_featuremap, file); + if (NIL_P(ad)) { + ad = TypedData_Make_Struct(0, struct autoload_data_i, + &autoload_data_i_type, ele); + ele->feature = file; + ele->state = 0; + list_head_init(&ele->constants); + rb_hash_aset(autoload_featuremap, file, ad); + } + else { + ele = rb_check_typeddata(ad, &autoload_data_i_type); + } + { + VALUE acv; + struct autoload_const *ac; + acv = TypedData_Make_Struct(0, struct autoload_const, + &autoload_const_type, ac); + ac->mod = mod; + ac->id = id; + ac->value = Qundef; + ac->flag = CONST_PUBLIC; + ac->ad = ad; + list_add_tail(&ele->constants, &ac->cnode); + st_insert(tbl, (st_data_t)id, (st_data_t)acv); + } } -static NODE* +static void autoload_delete(VALUE mod, ID id) { st_data_t val, load = 0, n = id; - rb_const_entry_t *ce; - st_delete(RCLASS_CONST_TBL(mod), &n, &val); - ce = (rb_const_entry_t*)val; - if (ce) xfree(ce); if (st_lookup(RCLASS_IV_TBL(mod), (st_data_t)autoload, &val)) { struct st_table *tbl = check_autoload_table((VALUE)val); + struct autoload_data_i *ele; + struct autoload_const *ac; st_delete(tbl, &n, &load); + /* Qfalse can indicate already deleted */ + if (load != Qfalse) { + ele = get_autoload_data((VALUE)load, &ac); + VM_ASSERT(ele); + if (ele) { + VM_ASSERT(!list_empty(&ele->constants)); + } - if (tbl->num_entries == 0) { - n = autoload; - st_delete(RCLASS_IV_TBL(mod), &n, &val); - } - } - - return (NODE *)load; -} + /* + * we must delete here to avoid "already initialized" warnings + * with parallel autoload. Using list_del_init here so list_del + * works in autoload_c_free + */ + list_del_init(&ac->cnode); -static VALUE -autoload_provided(VALUE arg) -{ - const char **p = (const char **)arg; - return rb_feature_provided(*p, p); + if (tbl->num_entries == 0) { + n = autoload; + st_delete(RCLASS_IV_TBL(mod), &n, &val); + } + } + } } static VALUE -reset_safe(VALUE safe) -{ - rb_set_safe_level_force((int)safe); - return safe; -} - -static NODE * -autoload_node(VALUE mod, ID id, const char **loadingpath) +check_autoload_required(VALUE mod, ID id, const char **loadingpath) { VALUE file; - struct st_table *tbl; - st_data_t val; - NODE *load; + VALUE load = autoload_data(mod, id); + struct autoload_data_i *ele; const char *loading; - int safe; - if (!st_lookup(RCLASS_IV_TBL(mod), autoload, &val) || - !(tbl = check_autoload_table((VALUE)val)) || !st_lookup(tbl, (st_data_t)id, &val)) { + if (!load || !(ele = get_autoload_data(load, 0))) { return 0; } - load = (NODE *)val; - file = load->nd_lit; + file = ele->feature; Check_Type(file, T_STRING); - if (!RSTRING_PTR(file) || !*RSTRING_PTR(file)) { + if (!RSTRING_LEN(file) || !*RSTRING_PTR(file)) { rb_raise(rb_eArgError, "empty file name"); } + + /* + * if somebody else is autoloading, we MUST wait for them, since + * rb_provide_feature can provide a feature before autoload_const_set + * completes. We must wait until autoload_const_set finishes in + * the other thread. + */ + if (ele->state && ele->state->thread != rb_thread_current()) { + return load; + } + loading = RSTRING_PTR(file); - safe = rb_safe_level(); - rb_set_safe_level_force(0); - if (!rb_ensure(autoload_provided, (VALUE)&loading, reset_safe, (VALUE)safe)) { + if (!rb_feature_provided(loading, &loading)) { return load; } if (loadingpath && loading) { @@ -1538,91 +2381,346 @@ autoload_node(VALUE mod, ID id, const char **loadingpath) return 0; } +static struct autoload_const *autoloading_const_entry(VALUE mod, ID id); + +MJIT_FUNC_EXPORTED int +rb_autoloading_value(VALUE mod, ID id, VALUE* value, rb_const_flag_t *flag) +{ + struct autoload_const *ac = autoloading_const_entry(mod, id); + if (!ac) return FALSE; + + if (value) { + *value = ac->value; + } + if (flag) { + *flag = ac->flag; + } + return TRUE; +} + +struct autoload_const * +autoloading_const_entry(VALUE mod, ID id) +{ + VALUE load = autoload_data(mod, id); + struct autoload_data_i *ele; + struct autoload_const *ac; + + if (!load || !(ele = get_autoload_data(load, &ac))) { + return 0; + } + + if (ele->state && ele->state->thread == rb_thread_current()) { + if (ac->value != Qundef) { + return ac; + } + } + return 0; +} + static int -autoload_node_id(VALUE mod, ID id) +autoload_defined_p(VALUE mod, ID id) { - struct st_table *tbl = RCLASS_CONST_TBL(mod); - st_data_t val; + rb_const_entry_t *ce = rb_const_lookup(mod, id); - if (!tbl || !st_lookup(tbl, (st_data_t)id, &val) || ((rb_const_entry_t*)val)->value != Qundef) { + if (!ce || ce->value != Qundef) { return 0; } - return 1; + return !rb_autoloading_value(mod, id, NULL, NULL); +} + +static void const_tbl_update(struct autoload_const *); + +static VALUE +autoload_const_set(struct autoload_const *ac) +{ + VALUE klass = ac->mod; + ID id = ac->id; + check_before_mod_set(klass, id, ac->value, "constant"); + + RB_VM_LOCK_ENTER(); + { + const_tbl_update(ac); + } + RB_VM_LOCK_LEAVE(); + + return 0; /* ignored */ +} + +static VALUE +autoload_require(VALUE arg) +{ + struct autoload_state *state = (struct autoload_state *)arg; + struct autoload_const *ac = state->ac; + struct autoload_data_i *ele; + + ele = rb_check_typeddata(ac->ad, &autoload_data_i_type); + /* this may release GVL and switch threads: */ + state->result = rb_funcall(rb_vm_top_self(), rb_intern("require"), 1, + ele->feature); + + return state->result; +} + +static VALUE +autoload_reset(VALUE arg) +{ + struct autoload_state *state = (struct autoload_state *)arg; + int need_wakeups = 0; + struct autoload_const *ac = state->ac; + struct autoload_data_i *ele; + + ele = rb_check_typeddata(ac->ad, &autoload_data_i_type); + if (ele->state == state) { + need_wakeups = 1; + ele->state = 0; + ele->fork_gen = 0; + } + + /* At the last, move a value defined in autoload to constant table */ + if (RTEST(state->result)) { + struct autoload_const *next; + + list_for_each_safe(&ele->constants, ac, next, cnode) { + if (ac->value != Qundef) { + autoload_const_set(ac); + } + } + } + + /* wakeup any waiters we had */ + if (need_wakeups) { + struct autoload_state *cur = 0, *nxt; + + list_for_each_safe(&state->waitq, cur, nxt, waitq.n) { + VALUE th = cur->thread; + + cur->thread = Qfalse; + list_del_init(&cur->waitq.n); /* idempotent */ + + /* + * cur is stored on the stack of cur->waiting_th, + * do not touch cur after waking up waiting_th + */ + rb_thread_wakeup_alive(th); + } + } + + return 0; /* ignored */ +} + +static VALUE +autoload_sleep(VALUE arg) +{ + struct autoload_state *state = (struct autoload_state *)arg; + + /* + * autoload_reset in other thread will resume us and remove us + * from the waitq list + */ + do { + rb_thread_sleep_deadly(); + } while (state->thread != Qfalse); + + return Qfalse; +} + +static VALUE +autoload_sleep_done(VALUE arg) +{ + struct autoload_state *state = (struct autoload_state *)arg; + + if (state->thread != Qfalse && rb_thread_to_be_killed(state->thread)) { + list_del(&state->waitq.n); /* idempotent after list_del_init */ + } + + return Qfalse; } VALUE rb_autoload_load(VALUE mod, ID id) { - VALUE file; - NODE *load; + VALUE load, result; const char *loading = 0, *src; + struct autoload_data_i *ele; + struct autoload_const *ac; + struct autoload_state state; + int flag = -1; + rb_const_entry_t *ce; - if (!autoload_node_id(mod, id)) return Qfalse; - load = autoload_node(mod, id, &loading); + if (!autoload_defined_p(mod, id)) return Qfalse; + load = check_autoload_required(mod, id, &loading); if (!load) return Qfalse; src = rb_sourcefile(); if (src && loading && strcmp(src, loading) == 0) return Qfalse; - file = load->nd_lit; - return rb_require_safe(file, (int)load->nd_nth); + + if (UNLIKELY(!rb_ractor_main_p())) { + rb_raise(rb_eRactorUnsafeError, "require by autoload on non-main Ractor is not supported (%s)", rb_id2name(id)); + } + + if ((ce = rb_const_lookup(mod, id))) { + flag = ce->flag & (CONST_DEPRECATED | CONST_VISIBILITY_MASK); + } + + /* set ele->state for a marker of autoloading thread */ + if (!(ele = get_autoload_data(load, &ac))) { + return Qfalse; + } + state.ac = ac; + state.thread = rb_thread_current(); + if (!ele->state) { + ele->state = &state; + ele->fork_gen = GET_VM()->fork_gen; + + /* + * autoload_reset will wake up any threads added to this + * if and only if the GVL is released during autoload_require + */ + list_head_init(&state.waitq); + } + else if (state.thread == ele->state->thread) { + return Qfalse; + } + else { + list_add_tail(&ele->state->waitq, &state.waitq.n); + + rb_ensure(autoload_sleep, (VALUE)&state, + autoload_sleep_done, (VALUE)&state); + } + + /* autoload_data_i can be deleted by another thread while require */ + state.result = Qfalse; + result = rb_ensure(autoload_require, (VALUE)&state, + autoload_reset, (VALUE)&state); + + if (!(ce = rb_const_lookup(mod, id)) || ce->value == Qundef) { + rb_const_remove(mod, id); + } + else if (flag > 0) { + ce->flag |= flag; + } + RB_GC_GUARD(load); + return result; } VALUE rb_autoload_p(VALUE mod, ID id) { - VALUE file; - NODE *load; - const char *loading = 0; + return rb_autoload_at_p(mod, id, TRUE); +} - while (!autoload_node_id(mod, id)) { +VALUE +rb_autoload_at_p(VALUE mod, ID id, int recur) +{ + VALUE load; + struct autoload_data_i *ele; + + while (!autoload_defined_p(mod, id)) { + if (!recur) return Qnil; mod = RCLASS_SUPER(mod); if (!mod) return Qnil; } - load = autoload_node(mod, id, &loading); + load = check_autoload_required(mod, id, 0); if (!load) return Qnil; - return load && (file = load->nd_lit) ? file : Qnil; + return (ele = get_autoload_data(load, 0)) ? ele->feature : Qnil; +} + +MJIT_FUNC_EXPORTED void +rb_const_warn_if_deprecated(const rb_const_entry_t *ce, VALUE klass, ID id) +{ + if (RB_CONST_DEPRECATED_P(ce) && + rb_warning_category_enabled_p(RB_WARN_CATEGORY_DEPRECATED)) { + if (klass == rb_cObject) { + rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "constant ::%"PRIsVALUE" is deprecated", QUOTE_ID(id)); + } + else { + rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "constant %"PRIsVALUE"::%"PRIsVALUE" is deprecated", + rb_class_name(klass), QUOTE_ID(id)); + } + } } static VALUE rb_const_get_0(VALUE klass, ID id, int exclude, int recurse, int visibility) { - VALUE value, tmp; - int mod_retry = 0; + VALUE c = rb_const_search(klass, id, exclude, recurse, visibility); + if (c != Qundef) { + if (UNLIKELY(!rb_ractor_main_p())) { + if (!rb_ractor_shareable_p(c)) { + rb_raise(rb_eRactorIsolationError, "can not access non-shareable objects in constant %"PRIsVALUE"::%s by non-main Ractor.", rb_class_path(klass), rb_id2name(id)); + } + } + return c; + } + return rb_const_missing(klass, ID2SYM(id)); +} - tmp = klass; - retry: - while (RTEST(tmp)) { +static VALUE +rb_const_search_from(VALUE klass, ID id, int exclude, int recurse, int visibility) +{ + VALUE value, current; + bool first_iteration = true; + + for (current = klass; + RTEST(current); + current = RCLASS_SUPER(current), first_iteration = false) { + VALUE tmp; VALUE am = 0; - st_data_t data; - while (RCLASS_CONST_TBL(tmp) && st_lookup(RCLASS_CONST_TBL(tmp), (st_data_t)id, &data)) { - rb_const_entry_t *ce = (rb_const_entry_t *)data; - if (visibility && ce->flag == CONST_PRIVATE) { - rb_name_error(id, "private constant %s::%s referenced", rb_class2name(klass), rb_id2name(id)); + rb_const_entry_t *ce; + + if (!first_iteration && RCLASS_ORIGIN(current) != current) { + // This item in the super chain has an origin iclass + // that comes later in the chain. Skip this item so + // prepended modules take precedence. + continue; + } + + // Do lookup in original class or module in case we are at an origin + // iclass in the chain. + tmp = current; + if (BUILTIN_TYPE(tmp) == T_ICLASS) tmp = RBASIC(tmp)->klass; + + // Do the lookup. Loop in case of autoload. + while ((ce = rb_const_lookup(tmp, id))) { + if (visibility && RB_CONST_PRIVATE_P(ce)) { + GET_EC()->private_const_reference = tmp; + return Qundef; } + rb_const_warn_if_deprecated(ce, tmp, id); value = ce->value; if (value == Qundef) { + struct autoload_const *ac; if (am == tmp) break; am = tmp; + ac = autoloading_const_entry(tmp, id); + if (ac) return ac->value; rb_autoload_load(tmp, id); continue; } - if (exclude && tmp == rb_cObject && klass != rb_cObject) { - rb_warn("toplevel constant %s referenced by %s::%s", - rb_id2name(id), rb_class2name(klass), rb_id2name(id)); + if (exclude && tmp == rb_cObject) { + goto not_found; } return value; } if (!recurse) break; - tmp = RCLASS_SUPER(tmp); - } - if (!exclude && !mod_retry && BUILTIN_TYPE(klass) == T_MODULE) { - mod_retry = 1; - tmp = rb_cObject; - goto retry; } - value = const_missing(klass, id); - rb_vm_inc_const_missing_count(); - return value; + not_found: + GET_EC()->private_const_reference = 0; + return Qundef; +} + +static VALUE +rb_const_search(VALUE klass, ID id, int exclude, int recurse, int visibility) +{ + VALUE value; + + if (klass == rb_cObject) exclude = FALSE; + value = rb_const_search_from(klass, id, exclude, recurse, visibility); + if (value != Qundef) return value; + if (exclude) return value; + if (BUILTIN_TYPE(klass) != T_MODULE) return value; + /* search global const too, if klass is a module */ + return rb_const_search_from(rb_cObject, id, FALSE, recurse, visibility); } VALUE @@ -1643,22 +2741,74 @@ rb_const_get_at(VALUE klass, ID id) return rb_const_get_0(klass, id, TRUE, FALSE, FALSE); } -VALUE +MJIT_FUNC_EXPORTED VALUE rb_public_const_get_from(VALUE klass, ID id) { return rb_const_get_0(klass, id, TRUE, TRUE, TRUE); } -VALUE -rb_public_const_get(VALUE klass, ID id) +MJIT_FUNC_EXPORTED VALUE +rb_public_const_get_at(VALUE klass, ID id) +{ + return rb_const_get_0(klass, id, TRUE, FALSE, TRUE); +} + +NORETURN(static void undefined_constant(VALUE mod, VALUE name)); +static void +undefined_constant(VALUE mod, VALUE name) { - return rb_const_get_0(klass, id, FALSE, TRUE, TRUE); + rb_name_err_raise("constant %2$s::%1$s not defined", + mod, name); +} + +static VALUE +rb_const_location_from(VALUE klass, ID id, int exclude, int recurse, int visibility) +{ + while (RTEST(klass)) { + rb_const_entry_t *ce; + + while ((ce = rb_const_lookup(klass, id))) { + if (visibility && RB_CONST_PRIVATE_P(ce)) { + return Qnil; + } + if (exclude && klass == rb_cObject) { + goto not_found; + } + if (NIL_P(ce->file)) return rb_ary_new(); + return rb_assoc_new(ce->file, INT2NUM(ce->line)); + } + if (!recurse) break; + klass = RCLASS_SUPER(klass); + } + + not_found: + return Qnil; +} + +static VALUE +rb_const_location(VALUE klass, ID id, int exclude, int recurse, int visibility) +{ + VALUE loc; + + if (klass == rb_cObject) exclude = FALSE; + loc = rb_const_location_from(klass, id, exclude, recurse, visibility); + if (!NIL_P(loc)) return loc; + if (exclude) return loc; + if (BUILTIN_TYPE(klass) != T_MODULE) return loc; + /* search global const too, if klass is a module */ + return rb_const_location_from(rb_cObject, id, FALSE, recurse, visibility); } VALUE -rb_public_const_get_at(VALUE klass, ID id) +rb_const_source_location(VALUE klass, ID id) { - return rb_const_get_0(klass, id, TRUE, FALSE, TRUE); + return rb_const_location(klass, id, FALSE, TRUE, FALSE); +} + +MJIT_FUNC_EXPORTED VALUE +rb_const_source_location_at(VALUE klass, ID id) +{ + return rb_const_location(klass, id, TRUE, FALSE, FALSE); } /* @@ -1674,10 +2824,10 @@ rb_public_const_get_at(VALUE klass, ID id) VALUE rb_mod_remove_const(VALUE mod, VALUE name) { - const ID id = rb_to_id(name); + const ID id = id_for_var(mod, name, a, constant); - if (!rb_is_const_id(id)) { - rb_name_error(id, "`%s' is not allowed as a constant name", rb_id2name(id)); + if (!id) { + undefined_constant(mod, name); } return rb_const_remove(mod, id); } @@ -1686,40 +2836,74 @@ VALUE rb_const_remove(VALUE mod, ID id) { VALUE val; - st_data_t v, n = id; + rb_const_entry_t *ce; - if (!OBJ_UNTRUSTED(mod) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't remove constant"); rb_check_frozen(mod); - if (!RCLASS_CONST_TBL(mod) || !st_delete(RCLASS_CONST_TBL(mod), &n, &v)) { + ce = rb_const_lookup(mod, id); + if (!ce || !rb_id_table_delete(RCLASS_CONST_TBL(mod), id)) { if (rb_const_defined_at(mod, id)) { - rb_name_error(id, "cannot remove %s::%s", - rb_class2name(mod), rb_id2name(id)); + rb_name_err_raise("cannot remove %2$s::%1$s", + mod, ID2SYM(id)); } - rb_name_error(id, "constant %s::%s not defined", - rb_class2name(mod), rb_id2name(id)); + undefined_constant(mod, ID2SYM(id)); } - rb_vm_change_state(); + rb_clear_constant_cache(); - val = ((rb_const_entry_t*)v)->value; + val = ce->value; if (val == Qundef) { autoload_delete(mod, id); val = Qnil; } - xfree((rb_const_entry_t*)v); + xfree(ce); return val; } static int -sv_i(ID key, rb_const_entry_t *ce, st_table *tbl) +cv_i_update(st_data_t *k, st_data_t *v, st_data_t a, int existing) +{ + if (existing) return ST_STOP; + *v = a; + return ST_CONTINUE; +} + +static enum rb_id_table_iterator_result +sv_i(ID key, VALUE v, void *a) { + rb_const_entry_t *ce = (rb_const_entry_t *)v; + st_table *tbl = a; + if (rb_is_const_id(key)) { - if (!st_lookup(tbl, (st_data_t)key, 0)) { - st_insert(tbl, (st_data_t)key, (st_data_t)ce); - } + st_update(tbl, (st_data_t)key, cv_i_update, (st_data_t)ce); } - return ST_CONTINUE; + return ID_TABLE_CONTINUE; +} + +static enum rb_id_table_iterator_result +rb_local_constants_i(ID const_name, VALUE const_value, void *ary) +{ + if (rb_is_const_id(const_name) && !RB_CONST_PRIVATE_P((rb_const_entry_t *)const_value)) { + rb_ary_push((VALUE)ary, ID2SYM(const_name)); + } + return ID_TABLE_CONTINUE; +} + +static VALUE +rb_local_constants(VALUE mod) +{ + struct rb_id_table *tbl = RCLASS_CONST_TBL(mod); + VALUE ary; + + if (!tbl) return rb_ary_new2(0); + + RB_VM_LOCK_ENTER(); + { + ary = rb_ary_new2(rb_id_table_size(tbl)); + rb_id_table_foreach(tbl, rb_local_constants_i, (void *)ary); + } + RB_VM_LOCK_LEAVE(); + + return ary; } void* @@ -1730,7 +2914,11 @@ rb_mod_const_at(VALUE mod, void *data) tbl = st_init_numtable(); } if (RCLASS_CONST_TBL(mod)) { - st_foreach_safe(RCLASS_CONST_TBL(mod), sv_i, (st_data_t)tbl); + RB_VM_LOCK_ENTER(); + { + rb_id_table_foreach(RCLASS_CONST_TBL(mod), sv_i, tbl); + } + RB_VM_LOCK_LEAVE(); } return tbl; } @@ -1753,7 +2941,7 @@ list_i(st_data_t key, st_data_t value, VALUE ary) { ID sym = (ID)key; rb_const_entry_t *ce = (rb_const_entry_t *)value; - if (ce->flag != CONST_PRIVATE) rb_ary_push(ary, ID2SYM(sym)); + if (RB_CONST_PUBLIC_P(ce)) rb_ary_push(ary, ID2SYM(sym)); return ST_CONTINUE; } @@ -1777,53 +2965,55 @@ rb_const_list(void *data) * * Returns an array of the names of the constants accessible in * <i>mod</i>. This includes the names of constants in any included - * modules (example at start of section), unless the <i>all</i> + * modules (example at start of section), unless the <i>inherit</i> * parameter is set to <code>false</code>. * + * The implementation makes no guarantees about the order in which the + * constants are yielded. + * * IO.constants.include?(:SYNC) #=> true * IO.constants(false).include?(:SYNC) #=> false * - * Also see <code>Module::const_defined?</code>. + * Also see Module#const_defined?. */ VALUE -rb_mod_constants(int argc, VALUE *argv, VALUE mod) +rb_mod_constants(int argc, const VALUE *argv, VALUE mod) { - VALUE inherit; - st_table *tbl; + bool inherit = true; - if (argc == 0) { - inherit = Qtrue; - } - else { - rb_scan_args(argc, argv, "01", &inherit); - } - if (RTEST(inherit)) { - tbl = rb_mod_const_of(mod, 0); + if (rb_check_arity(argc, 0, 1)) inherit = RTEST(argv[0]); + + if (inherit) { + return rb_const_list(rb_mod_const_of(mod, 0)); } else { - tbl = rb_mod_const_at(mod, 0); + return rb_local_constants(mod); } - return rb_const_list(tbl); } static int rb_const_defined_0(VALUE klass, ID id, int exclude, int recurse, int visibility) { - st_data_t value; VALUE tmp; int mod_retry = 0; + rb_const_entry_t *ce; tmp = klass; retry: while (tmp) { - if (RCLASS_CONST_TBL(tmp) && st_lookup(RCLASS_CONST_TBL(tmp), (st_data_t)id, &value)) { - rb_const_entry_t *ce = (rb_const_entry_t *)value; - if (visibility && ce->flag == CONST_PRIVATE) { + if ((ce = rb_const_lookup(tmp, id))) { + if (visibility && RB_CONST_PRIVATE_P(ce)) { return (int)Qfalse; } - if (ce->value == Qundef && !autoload_node(tmp, id, 0)) + if (ce->value == Qundef && !check_autoload_required(tmp, id, 0) && + !rb_autoloading_value(tmp, id, NULL, NULL)) return (int)Qfalse; + + if (exclude && tmp == rb_cObject && klass != rb_cObject) { + return (int)Qfalse; + } + return (int)Qtrue; } if (!recurse) break; @@ -1855,68 +3045,208 @@ rb_const_defined_at(VALUE klass, ID id) return rb_const_defined_0(klass, id, TRUE, FALSE, FALSE); } -int +MJIT_FUNC_EXPORTED int rb_public_const_defined_from(VALUE klass, ID id) { return rb_const_defined_0(klass, id, TRUE, TRUE, TRUE); } -int -rb_public_const_defined(VALUE klass, ID id) +static void +check_before_mod_set(VALUE klass, ID id, VALUE val, const char *dest) { - return rb_const_defined_0(klass, id, FALSE, TRUE, TRUE); + rb_check_frozen(klass); } -int -rb_public_const_defined_at(VALUE klass, ID id) +static void set_namespace_path(VALUE named_namespace, VALUE name); + +static enum rb_id_table_iterator_result +set_namespace_path_i(ID id, VALUE v, void *payload) { - return rb_const_defined_0(klass, id, TRUE, FALSE, TRUE); + rb_const_entry_t *ce = (rb_const_entry_t *)v; + VALUE value = ce->value; + int has_permanent_classpath; + VALUE parental_path = *((VALUE *) payload); + if (!rb_is_const_id(id) || !rb_namespace_p(value)) { + return ID_TABLE_CONTINUE; + } + classname(value, &has_permanent_classpath); + if (has_permanent_classpath) { + return ID_TABLE_CONTINUE; + } + set_namespace_path(value, build_const_path(parental_path, id)); + if (RCLASS_IV_TBL(value)) { + st_data_t tmp = tmp_classpath; + st_delete(RCLASS_IV_TBL(value), &tmp, 0); + } + + return ID_TABLE_CONTINUE; } -void -check_before_mod_set(VALUE klass, ID id, VALUE val, const char *dest) +/* + * Assign permanent classpaths to all namespaces that are directly or indirectly + * nested under +named_namespace+. +named_namespace+ must have a permanent + * classpath. + */ +static void +set_namespace_path(VALUE named_namespace, VALUE namespace_path) { - if (!OBJ_UNTRUSTED(klass) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't set %s", dest); - rb_check_frozen(klass); + struct rb_id_table *const_table = RCLASS_CONST_TBL(named_namespace); + + RB_VM_LOCK_ENTER(); + { + rb_class_ivar_set(named_namespace, classpath, namespace_path); + if (const_table) { + rb_id_table_foreach(const_table, set_namespace_path_i, &namespace_path); + } + } + RB_VM_LOCK_LEAVE(); } void rb_const_set(VALUE klass, ID id, VALUE val) { rb_const_entry_t *ce; - VALUE visibility = CONST_PUBLIC; if (NIL_P(klass)) { - rb_raise(rb_eTypeError, "no class/module to define constant %s", - rb_id2name(id)); + rb_raise(rb_eTypeError, "no class/module to define constant %"PRIsVALUE"", + QUOTE_ID(id)); } - check_before_mod_set(klass, id, val, "constant"); - if (!RCLASS_CONST_TBL(klass)) { - RCLASS_CONST_TBL(klass) = st_init_numtable(); + if (!rb_ractor_main_p() && !rb_ractor_shareable_p(val)) { + rb_raise(rb_eRactorIsolationError, "can not set constants with non-shareable objects by non-main Ractors"); } - else { - st_data_t value; - if (st_lookup(RCLASS_CONST_TBL(klass), (st_data_t)id, &value)) { - rb_const_entry_t *ce = (rb_const_entry_t*)value; - if (ce->value == Qundef) - autoload_delete(klass, id); + check_before_mod_set(klass, id, val, "constant"); + + RB_VM_LOCK_ENTER(); + { + struct rb_id_table *tbl = RCLASS_CONST_TBL(klass); + if (!tbl) { + RCLASS_CONST_TBL(klass) = tbl = rb_id_table_create(0); + rb_clear_constant_cache(); + ce = ZALLOC(rb_const_entry_t); + rb_id_table_insert(tbl, id, (VALUE)ce); + setup_const_entry(ce, klass, val, CONST_PUBLIC); + } + else { + struct autoload_const ac = { + .mod = klass, .id = id, + .value = val, .flag = CONST_PUBLIC, + /* fill the rest with 0 */ + }; + const_tbl_update(&ac); + } + } + RB_VM_LOCK_LEAVE(); + + /* + * Resolve and cache class name immediately to resolve ambiguity + * and avoid order-dependency on const_tbl + */ + if (rb_cObject && rb_namespace_p(val)) { + int val_path_permanent; + VALUE val_path = classname(val, &val_path_permanent); + if (NIL_P(val_path) || !val_path_permanent) { + if (klass == rb_cObject) { + set_namespace_path(val, rb_id2str(id)); + } else { - visibility = ce->flag; - rb_warn("already initialized constant %s", rb_id2name(id)); + int parental_path_permanent; + VALUE parental_path = classname(klass, &parental_path_permanent); + if (NIL_P(parental_path)) { + int throwaway; + parental_path = rb_tmp_class_path(klass, &throwaway, make_temporary_path); + } + if (parental_path_permanent && !val_path_permanent) { + set_namespace_path(val, build_const_path(parental_path, id)); + } + else if (!parental_path_permanent && NIL_P(val_path)) { + ivar_set(val, tmp_classpath, build_const_path(parental_path, id)); + } } } } +} + +static struct autoload_data_i * +current_autoload_data(VALUE mod, ID id, struct autoload_const **acp) +{ + struct autoload_data_i *ele; + VALUE load = autoload_data(mod, id); + if (!load) return 0; + ele = get_autoload_data(load, acp); + if (!ele) return 0; + /* for autoloading thread, keep the defined value to autoloading storage */ + if (ele->state && (ele->state->thread == rb_thread_current())) { + return ele; + } + return 0; +} + +static void +const_tbl_update(struct autoload_const *ac) +{ + VALUE value; + VALUE klass = ac->mod; + VALUE val = ac->value; + ID id = ac->id; + struct rb_id_table *tbl = RCLASS_CONST_TBL(klass); + rb_const_flag_t visibility = ac->flag; + rb_const_entry_t *ce; + + if (rb_id_table_lookup(tbl, id, &value)) { + ce = (rb_const_entry_t *)value; + if (ce->value == Qundef) { + struct autoload_data_i *ele = current_autoload_data(klass, id, &ac); - rb_vm_change_state(); + if (ele) { + rb_clear_constant_cache(); + + ac->value = val; /* autoload_i is non-WB-protected */ + ac->file = rb_source_location(&ac->line); + } + else { + /* otherwise autoloaded constant, allow to override */ + autoload_delete(klass, id); + ce->flag = visibility; + RB_OBJ_WRITE(klass, &ce->value, val); + RB_OBJ_WRITE(klass, &ce->file, ac->file); + ce->line = ac->line; + } + return; + } + else { + VALUE name = QUOTE_ID(id); + visibility = ce->flag; + if (klass == rb_cObject) + rb_warn("already initialized constant %"PRIsVALUE"", name); + else + rb_warn("already initialized constant %"PRIsVALUE"::%"PRIsVALUE"", + rb_class_name(klass), name); + if (!NIL_P(ce->file) && ce->line) { + rb_compile_warn(RSTRING_PTR(ce->file), ce->line, + "previous definition of %"PRIsVALUE" was here", name); + } + } + rb_clear_constant_cache(); + setup_const_entry(ce, klass, val, visibility); + } + else { + rb_clear_constant_cache(); - ce = ALLOC(rb_const_entry_t); - ce->flag = (rb_const_flag_t)visibility; - ce->value = val; + ce = ZALLOC(rb_const_entry_t); + rb_id_table_insert(tbl, id, (VALUE)ce); + setup_const_entry(ce, klass, val, visibility); + } +} - st_insert(RCLASS_CONST_TBL(klass), (st_data_t)id, (st_data_t)ce); +static void +setup_const_entry(rb_const_entry_t *ce, VALUE klass, VALUE val, + rb_const_flag_t visibility) +{ + ce->flag = visibility; + RB_OBJ_WRITE(klass, &ce->value, val); + RB_OBJ_WRITE(klass, &ce->file, rb_source_location(&ce->line)); } void @@ -1927,9 +3257,7 @@ rb_define_const(VALUE klass, const char *name, VALUE val) if (!rb_is_const_id(id)) { rb_warn("rb_define_const: invalid name `%s' for constant", name); } - if (klass == rb_cObject) { - rb_secure(4); - } + rb_gc_register_mark_object(val); rb_const_set(klass, id, val); } @@ -1940,35 +3268,69 @@ rb_define_global_const(const char *name, VALUE val) } static void -set_const_visibility(VALUE mod, int argc, VALUE *argv, rb_const_flag_t flag) +set_const_visibility(VALUE mod, int argc, const VALUE *argv, + rb_const_flag_t flag, rb_const_flag_t mask) { int i; - st_data_t v; + rb_const_entry_t *ce; ID id; - if (rb_safe_level() >= 4 && !OBJ_UNTRUSTED(mod)) { - rb_raise(rb_eSecurityError, - "Insecure: can't change constant visibility"); - } - + rb_class_modify_check(mod); if (argc == 0) { - rb_warning("%s with no argument is just ignored", rb_id2name(rb_frame_callee())); + rb_warning("%"PRIsVALUE" with no argument is just ignored", + QUOTE_ID(rb_frame_callee())); + return; } for (i = 0; i < argc; i++) { + struct autoload_const *ac; VALUE val = argv[i]; - id = rb_to_id(val); - if (RCLASS_CONST_TBL(mod) && - st_lookup(RCLASS_CONST_TBL(mod), (st_data_t)id, &v)) { - ((rb_const_entry_t*)v)->flag = flag; + id = rb_check_id(&val); + if (!id) { + if (i > 0) { + rb_clear_constant_cache(); + } + + undefined_constant(mod, val); + } + if ((ce = rb_const_lookup(mod, id))) { + ce->flag &= ~mask; + ce->flag |= flag; + if (ce->value == Qundef) { + struct autoload_data_i *ele; + + ele = current_autoload_data(mod, id, &ac); + if (ele) { + ac->flag &= ~mask; + ac->flag |= flag; + } + } } else { - if ( i > 0 ) - rb_clear_cache_by_class(mod); - rb_name_error(id, "constant %s::%s not defined", rb_class2name(mod), rb_id2name(id)); + if (i > 0) { + rb_clear_constant_cache(); + } + undefined_constant(mod, ID2SYM(id)); } } - rb_clear_cache_by_class(mod); + rb_clear_constant_cache(); +} + +void +rb_deprecate_constant(VALUE mod, const char *name) +{ + rb_const_entry_t *ce; + ID id; + long len = strlen(name); + + rb_class_modify_check(mod); + if (!(id = rb_check_id_cstr(name, len, NULL))) { + undefined_constant(mod, rb_fstring_new(name, len)); + } + if (!(ce = rb_const_lookup(mod, id))) { + undefined_constant(mod, ID2SYM(id)); + } + ce->flag |= CONST_DEPRECATED; } /* @@ -1979,9 +3341,9 @@ set_const_visibility(VALUE mod, int argc, VALUE *argv, rb_const_flag_t flag) */ VALUE -rb_mod_private_constant(int argc, VALUE *argv, VALUE obj) +rb_mod_private_constant(int argc, const VALUE *argv, VALUE obj) { - set_const_visibility(obj, argc, argv, CONST_PRIVATE); + set_const_visibility(obj, argc, argv, CONST_PRIVATE, CONST_VISIBILITY_MASK); return obj; } @@ -1993,47 +3355,134 @@ rb_mod_private_constant(int argc, VALUE *argv, VALUE obj) */ VALUE -rb_mod_public_constant(int argc, VALUE *argv, VALUE obj) +rb_mod_public_constant(int argc, const VALUE *argv, VALUE obj) +{ + set_const_visibility(obj, argc, argv, CONST_PUBLIC, CONST_VISIBILITY_MASK); + return obj; +} + +/* + * call-seq: + * mod.deprecate_constant(symbol, ...) => mod + * + * Makes a list of existing constants deprecated. Attempt + * to refer to them will produce a warning. + * + * module HTTP + * NotFound = Exception.new + * NOT_FOUND = NotFound # previous version of the library used this name + * + * deprecate_constant :NOT_FOUND + * end + * + * HTTP::NOT_FOUND + * # warning: constant HTTP::NOT_FOUND is deprecated + * + */ + +VALUE +rb_mod_deprecate_constant(int argc, const VALUE *argv, VALUE obj) { - set_const_visibility(obj, argc, argv, CONST_PUBLIC); + set_const_visibility(obj, argc, argv, CONST_DEPRECATED, CONST_DEPRECATED); return obj; } static VALUE original_module(VALUE c) { - if (TYPE(c) == T_ICLASS) + if (RB_TYPE_P(c, T_ICLASS)) return RBASIC(c)->klass; return c; } +static int +cvar_lookup_at(VALUE klass, ID id, st_data_t *v) +{ + if (!RCLASS_IV_TBL(klass)) return 0; + return st_lookup(RCLASS_IV_TBL(klass), (st_data_t)id, v); +} + +static VALUE +cvar_front_klass(VALUE klass) +{ + if (FL_TEST(klass, FL_SINGLETON)) { + VALUE obj = rb_ivar_get(klass, id__attached__); + if (rb_namespace_p(obj)) { + return obj; + } + } + return RCLASS_SUPER(klass); +} + +static void +cvar_overtaken(VALUE front, VALUE target, ID id) +{ + if (front && target != front) { + st_data_t did = (st_data_t)id; + + if (original_module(front) != original_module(target)) { + rb_raise(rb_eRuntimeError, + "class variable % "PRIsVALUE" of %"PRIsVALUE" is overtaken by %"PRIsVALUE"", + ID2SYM(id), rb_class_name(original_module(front)), + rb_class_name(original_module(target))); + } + if (BUILTIN_TYPE(front) == T_CLASS) { + st_delete(RCLASS_IV_TBL(front), &did, 0); + } + } +} + +static VALUE +find_cvar(VALUE klass, VALUE * front, VALUE * target, ID id) +{ + VALUE v = Qundef; + CVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(); + if (cvar_lookup_at(klass, id, (&v))) { + if (!*front) { + *front = klass; + } + *target = klass; + } + + for (klass = cvar_front_klass(klass); klass; klass = RCLASS_SUPER(klass)) { + if (cvar_lookup_at(klass, id, (&v))) { + if (!*front) { + *front = klass; + } + *target = klass; + } + } + + return v; +} + +#define CVAR_FOREACH_ANCESTORS(klass, v, r) \ + for (klass = cvar_front_klass(klass); klass; klass = RCLASS_SUPER(klass)) { \ + if (cvar_lookup_at(klass, id, (v))) { \ + r; \ + } \ + } + #define CVAR_LOOKUP(v,r) do {\ - if (RCLASS_IV_TBL(klass) && st_lookup(RCLASS_IV_TBL(klass),(st_data_t)id,(v))) {\ - r;\ - }\ - if (FL_TEST(klass, FL_SINGLETON) ) {\ - VALUE obj = rb_iv_get(klass, "__attached__");\ - switch (TYPE(obj)) {\ - case T_MODULE:\ - case T_CLASS:\ - klass = obj;\ - break;\ - default:\ - klass = RCLASS_SUPER(klass);\ - break;\ - }\ - }\ - else {\ - klass = RCLASS_SUPER(klass);\ - }\ - while (klass) {\ - if (RCLASS_IV_TBL(klass) && st_lookup(RCLASS_IV_TBL(klass),(st_data_t)id,(v))) {\ - r;\ - }\ - klass = RCLASS_SUPER(klass);\ - }\ + CVAR_ACCESSOR_SHOULD_BE_MAIN_RACTOR(); \ + if (cvar_lookup_at(klass, id, (v))) {r;}\ + CVAR_FOREACH_ANCESTORS(klass, v, r);\ } while(0) +static void +check_for_cvar_table(VALUE subclass, VALUE key) +{ + st_table *tbl = RCLASS_IV_TBL(subclass); + + if (tbl && st_lookup(tbl, key, NULL)) { + RB_DEBUG_COUNTER_INC(cvar_class_invalidate); + ruby_vm_global_cvar_state++; + return; + } + + rb_class_foreach_subclass(subclass, check_for_cvar_table, key); +} + void rb_cvar_set(VALUE klass, ID id, VALUE val) { @@ -2042,59 +3491,76 @@ rb_cvar_set(VALUE klass, ID id, VALUE val) tmp = klass; CVAR_LOOKUP(0, {if (!front) front = klass; target = klass;}); if (target) { - if (front && target != front) { - st_data_t did = id; - - if (RTEST(ruby_verbose)) { - rb_warning("class variable %s of %s is overtaken by %s", - rb_id2name(id), rb_class2name(original_module(front)), - rb_class2name(original_module(target))); - } - if (BUILTIN_TYPE(front) == T_CLASS) { - st_delete(RCLASS_IV_TBL(front),&did,0); - } - } + cvar_overtaken(front, target, id); } else { target = tmp; } + if (RB_TYPE_P(target, T_ICLASS)) { + target = RBASIC(target)->klass; + } check_before_mod_set(target, id, val, "class variable"); - if (!RCLASS_IV_TBL(target)) { - RCLASS_IV_TBL(target) = st_init_numtable(); + + int result = rb_class_ivar_set(target, id, val); + + struct rb_id_table *rb_cvc_tbl = RCLASS_CVC_TBL(target); + + if (!rb_cvc_tbl) { + rb_cvc_tbl = RCLASS_CVC_TBL(target) = rb_id_table_create(2); + } + + struct rb_cvar_class_tbl_entry *ent; + VALUE ent_data; + + if (!rb_id_table_lookup(rb_cvc_tbl, id, &ent_data)) { + ent = ALLOC(struct rb_cvar_class_tbl_entry); + ent->class_value = target; + ent->global_cvar_state = GET_GLOBAL_CVAR_STATE(); + ent->cref = 0; + rb_id_table_insert(rb_cvc_tbl, id, (VALUE)ent); + RB_DEBUG_COUNTER_INC(cvar_inline_miss); + } + else { + ent = (void *)ent_data; + ent->global_cvar_state = GET_GLOBAL_CVAR_STATE(); } - st_insert(RCLASS_IV_TBL(target), (st_data_t)id, (st_data_t)val); + // Break the cvar cache if this is a new class variable + // and target is a module or a subclass with the same + // cvar in this lookup. + if (result == 0) { + if (RB_TYPE_P(target, T_CLASS)) { + if (RCLASS_SUBCLASSES(target)) { + rb_class_foreach_subclass(target, check_for_cvar_table, id); + } + } + } } VALUE -rb_cvar_get(VALUE klass, ID id) +rb_cvar_find(VALUE klass, ID id, VALUE *front) { - VALUE tmp, front = 0, target = 0; - st_data_t value; + VALUE target = 0; + VALUE value; - tmp = klass; - CVAR_LOOKUP(&value, {if (!front) front = klass; target = klass;}); + value = find_cvar(klass, front, &target, id); if (!target) { - rb_name_error(id,"uninitialized class variable %s in %s", - rb_id2name(id), rb_class2name(tmp)); - } - if (front && target != front) { - st_data_t did = id; - - if (RTEST(ruby_verbose)) { - rb_warning("class variable %s of %s is overtaken by %s", - rb_id2name(id), rb_class2name(original_module(front)), - rb_class2name(original_module(target))); - } - if (BUILTIN_TYPE(front) == T_CLASS) { - st_delete(RCLASS_IV_TBL(front),&did,0); - } + rb_name_err_raise("uninitialized class variable %1$s in %2$s", + klass, ID2SYM(id)); } + cvar_overtaken(*front, target, id); return (VALUE)value; } VALUE +rb_cvar_get(VALUE klass, ID id) +{ + VALUE front = 0; + return rb_cvar_find(klass, id, &front); +} + +VALUE rb_cvar_defined(VALUE klass, ID id) { if (!klass) return Qfalse; @@ -2102,54 +3568,110 @@ rb_cvar_defined(VALUE klass, ID id) return Qfalse; } -void -rb_cv_set(VALUE klass, const char *name, VALUE val) +static ID +cv_intern(VALUE klass, const char *name) { ID id = rb_intern(name); if (!rb_is_class_id(id)) { - rb_name_error(id, "wrong class variable name %s", name); + rb_name_err_raise("wrong class variable name %1$s", + klass, rb_str_new_cstr(name)); } + return id; +} + +void +rb_cv_set(VALUE klass, const char *name, VALUE val) +{ + ID id = cv_intern(klass, name); rb_cvar_set(klass, id, val); } VALUE rb_cv_get(VALUE klass, const char *name) { - ID id = rb_intern(name); - if (!rb_is_class_id(id)) { - rb_name_error(id, "wrong class variable name %s", name); - } + ID id = cv_intern(klass, name); return rb_cvar_get(klass, id); } void rb_define_class_variable(VALUE klass, const char *name, VALUE val) { - ID id = rb_intern(name); - - if (!rb_is_class_id(id)) { - rb_name_error(id, "wrong class variable name %s", name); - } - rb_cvar_set(klass, id, val); + rb_cv_set(klass, name, val); } static int -cv_i(ID key, VALUE value, VALUE ary) +cv_i(st_data_t k, st_data_t v, st_data_t a) { + ID key = (ID)k; + st_table *tbl = (st_table *)a; + if (rb_is_class_id(key)) { - VALUE kval = ID2SYM(key); - if (!rb_ary_includes(ary, kval)) { - rb_ary_push(ary, kval); - } + st_update(tbl, (st_data_t)key, cv_i_update, 0); } return ST_CONTINUE; } +static void* +mod_cvar_at(VALUE mod, void *data) +{ + st_table *tbl = data; + if (!tbl) { + tbl = st_init_numtable(); + } + if (RCLASS_IV_TBL(mod)) { + st_foreach_safe(RCLASS_IV_TBL(mod), cv_i, (st_data_t)tbl); + } + return tbl; +} + +static void* +mod_cvar_of(VALUE mod, void *data) +{ + VALUE tmp = mod; + if (FL_TEST(mod, FL_SINGLETON)) { + if (rb_namespace_p(rb_ivar_get(mod, id__attached__))) { + data = mod_cvar_at(tmp, data); + tmp = cvar_front_klass(tmp); + } + } + for (;;) { + data = mod_cvar_at(tmp, data); + tmp = RCLASS_SUPER(tmp); + if (!tmp) break; + } + return data; +} + +static int +cv_list_i(st_data_t key, st_data_t value, VALUE ary) +{ + ID sym = (ID)key; + rb_ary_push(ary, ID2SYM(sym)); + return ST_CONTINUE; +} + +static VALUE +cvar_list(void *data) +{ + st_table *tbl = data; + VALUE ary; + + if (!tbl) return rb_ary_new2(0); + ary = rb_ary_new2(tbl->num_entries); + st_foreach_safe(tbl, cv_list_i, ary); + st_free_table(tbl); + + return ary; +} + /* * call-seq: - * mod.class_variables -> array + * mod.class_variables(inherit=true) -> array * * Returns an array of the names of class variables in <i>mod</i>. + * This includes the names of class variables in any included + * modules, unless the <i>inherit</i> parameter is set to + * <code>false</code>. * * class One * @@var1 = 1 @@ -2157,32 +3679,37 @@ cv_i(ID key, VALUE value, VALUE ary) * class Two < One * @@var2 = 2 * end - * One.class_variables #=> [:@@var1] - * Two.class_variables #=> [:@@var2] + * One.class_variables #=> [:@@var1] + * Two.class_variables #=> [:@@var2, :@@var1] + * Two.class_variables(false) #=> [:@@var2] */ VALUE -rb_mod_class_variables(VALUE obj) +rb_mod_class_variables(int argc, const VALUE *argv, VALUE mod) { - VALUE ary = rb_ary_new(); + bool inherit = true; + st_table *tbl; - if (RCLASS_IV_TBL(obj)) { - st_foreach_safe(RCLASS_IV_TBL(obj), cv_i, ary); + if (rb_check_arity(argc, 0, 1)) inherit = RTEST(argv[0]); + if (inherit) { + tbl = mod_cvar_of(mod, 0); } - return ary; + else { + tbl = mod_cvar_at(mod, 0); + } + return cvar_list(tbl); } /* * call-seq: * remove_class_variable(sym) -> obj * - * Removes the definition of the <i>sym</i>, returning that - * constant's value. + * Removes the named class variable from the receiver, returning that + * variable's value. * - * class Dummy + * class Example * @@var = 99 - * puts @@var - * remove_class_variable(:@@var) + * puts remove_class_variable(:@@var) * p(defined? @@var) * end * @@ -2195,32 +3722,33 @@ rb_mod_class_variables(VALUE obj) VALUE rb_mod_remove_cvar(VALUE mod, VALUE name) { - const ID id = rb_to_id(name); + const ID id = id_for_var_message(mod, name, class, "wrong class variable name %1$s"); st_data_t val, n = id; - if (!rb_is_class_id(id)) { - rb_name_error(id, "wrong class variable name %s", rb_id2name(id)); + if (!id) { + goto not_defined; } - if (!OBJ_UNTRUSTED(mod) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't remove class variable"); rb_check_frozen(mod); if (RCLASS_IV_TBL(mod) && st_delete(RCLASS_IV_TBL(mod), &n, &val)) { return (VALUE)val; } if (rb_cvar_defined(mod, id)) { - rb_name_error(id, "cannot remove %s for %s", - rb_id2name(id), rb_class2name(mod)); + rb_name_err_raise("cannot remove %1$s for %2$s", mod, ID2SYM(id)); } - rb_name_error(id, "class variable %s not defined for %s", - rb_id2name(id), rb_class2name(mod)); - return Qnil; /* not reached */ + not_defined: + rb_name_err_raise("class variable %1$s not defined for %2$s", + mod, name); + UNREACHABLE_RETURN(Qundef); } VALUE rb_iv_get(VALUE obj, const char *name) { - ID id = rb_intern(name); + ID id = rb_check_id_cstr(name, strlen(name), rb_usascii_encoding()); + if (!id) { + return Qnil; + } return rb_ivar_get(obj, id); } @@ -2231,3 +3759,52 @@ rb_iv_set(VALUE obj, const char *name, VALUE val) return rb_ivar_set(obj, id, val); } + +/* tbl = xx(obj); tbl[key] = value; */ +int +rb_class_ivar_set(VALUE obj, ID key, VALUE value) +{ + if (!RCLASS_IV_TBL(obj)) { + RCLASS_IV_TBL(obj) = st_init_numtable(); + } + + st_table *tbl = RCLASS_IV_TBL(obj); + int result = lock_st_insert(tbl, (st_data_t)key, (st_data_t)value); + RB_OBJ_WRITTEN(obj, Qundef, value); + return result; +} + +static int +tbl_copy_i(st_data_t key, st_data_t value, st_data_t data) +{ + RB_OBJ_WRITTEN((VALUE)data, Qundef, (VALUE)value); + return ST_CONTINUE; +} + +void +rb_iv_tbl_copy(VALUE dst, VALUE src) +{ + st_table *orig_tbl = RCLASS_IV_TBL(src); + st_table *new_tbl = st_copy(orig_tbl); + st_foreach(new_tbl, tbl_copy_i, (st_data_t)dst); + RCLASS_IV_TBL(dst) = new_tbl; +} + +MJIT_FUNC_EXPORTED rb_const_entry_t * +rb_const_lookup(VALUE klass, ID id) +{ + struct rb_id_table *tbl = RCLASS_CONST_TBL(klass); + + if (tbl) { + VALUE val; + bool r; + RB_VM_LOCK_ENTER(); + { + r = rb_id_table_lookup(tbl, id, &val); + } + RB_VM_LOCK_LEAVE(); + + if (r) return (rb_const_entry_t *)val; + } + return NULL; +} |