diff options
Diffstat (limited to 'vm_method.c')
| -rw-r--r-- | vm_method.c | 2997 |
1 files changed, 2174 insertions, 823 deletions
diff --git a/vm_method.c b/vm_method.c index 35634d275c..dcf35527f7 100644 --- a/vm_method.c +++ b/vm_method.c @@ -3,30 +3,13 @@ */ #include "id_table.h" +#include "yjit.h" #define METHOD_DEBUG 0 -#if OPT_GLOBAL_METHOD_CACHE -#ifndef GLOBAL_METHOD_CACHE_SIZE -#define GLOBAL_METHOD_CACHE_SIZE 0x800 -#endif -#define LSB_ONLY(x) ((x) & ~((x) - 1)) -#define POWER_OF_2_P(x) ((x) == LSB_ONLY(x)) -#if !POWER_OF_2_P(GLOBAL_METHOD_CACHE_SIZE) -# error GLOBAL_METHOD_CACHE_SIZE must be power of 2 -#endif -#ifndef GLOBAL_METHOD_CACHE_MASK -#define GLOBAL_METHOD_CACHE_MASK (GLOBAL_METHOD_CACHE_SIZE-1) -#endif - -#define GLOBAL_METHOD_CACHE_KEY(c,m) ((((c)>>3)^(m))&(global_method_cache.mask)) -#define GLOBAL_METHOD_CACHE(c,m) (global_method_cache.entries + GLOBAL_METHOD_CACHE_KEY(c,m)) -#else -#define GLOBAL_METHOD_CACHE(c,m) (rb_bug("global method cache disabled improperly"), NULL) -#endif - static int vm_redefinition_check_flag(VALUE klass); static void rb_vm_check_redefinition_opt_method(const rb_method_entry_t *me, VALUE klass); +static inline rb_method_entry_t *lookup_method_table(VALUE klass, ID id); #define object_id idObject_id #define added idMethod_added @@ -35,92 +18,791 @@ static void rb_vm_check_redefinition_opt_method(const rb_method_entry_t *me, VAL #define singleton_removed idSingleton_method_removed #define undefined idMethod_undefined #define singleton_undefined idSingleton_method_undefined -#define attached id__attached__ -struct cache_entry { - rb_serial_t method_state; - rb_serial_t class_serial; - ID mid; - rb_method_entry_t* me; - VALUE defined_class; -}; +#define ruby_running (GET_VM()->running) +/* int ruby_running = 0; */ + +static enum rb_id_table_iterator_result +mark_cc_entry_i(VALUE ccs_ptr, void *data) +{ + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_ptr; + + VM_ASSERT(vm_ccs_p(ccs)); + + if (METHOD_ENTRY_INVALIDATED(ccs->cme)) { + /* Before detaching the CCs from this class, we need to invalidate the cc + * since we will no longer be marking the cme on their behalf. + */ + for (int i = 0; i < ccs->len; i++) { + const struct rb_callcache *cc = ccs->entries[i].cc; + if (cc->klass == Qundef) continue; // already invalidated + VM_ASSERT(cc->klass == Qundef || vm_cc_check_cme(cc, ccs->cme)); + VM_ASSERT(!vm_cc_super_p(cc) && !vm_cc_refinement_p(cc)); + vm_cc_invalidate(cc); + } + ruby_xfree(ccs); + return ID_TABLE_DELETE; + } + else { + rb_gc_mark_movable((VALUE)ccs->cme); + + for (int i = 0; i < ccs->len; i++) { + const struct rb_callcache *cc = ccs->entries[i].cc; + VM_ASSERT(cc->klass == Qundef || vm_cc_check_cme(cc, ccs->cme)); + + rb_gc_mark_movable((VALUE)cc); + } + return ID_TABLE_CONTINUE; + } +} + +static void +vm_cc_table_mark(void *data) +{ + struct rb_id_table *tbl = (struct rb_id_table *)data; + if (tbl) { + rb_id_table_foreach_values(tbl, mark_cc_entry_i, NULL); + } +} + +static enum rb_id_table_iterator_result +cc_table_free_i(VALUE ccs_ptr, void *data) +{ + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_ptr; + VM_ASSERT(vm_ccs_p(ccs)); + + ruby_xfree(ccs); + + return ID_TABLE_CONTINUE; +} + +static void +vm_cc_table_free(void *data) +{ + struct rb_id_table *tbl = (struct rb_id_table *)data; + + rb_id_table_foreach_values(tbl, cc_table_free_i, NULL); + rb_managed_id_table_type.function.dfree(data); +} + +static enum rb_id_table_iterator_result +cc_table_memsize_i(VALUE ccs_ptr, void *data_ptr) +{ + size_t *total_size = data_ptr; + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_ptr; + *total_size += sizeof(*ccs); + *total_size += sizeof(ccs->entries[0]) * ccs->capa; + return ID_TABLE_CONTINUE; +} + +static size_t +vm_cc_table_memsize(const void *data) +{ + size_t memsize = rb_managed_id_table_type.function.dsize(data); + struct rb_id_table *tbl = (struct rb_id_table *)data; + rb_id_table_foreach_values(tbl, cc_table_memsize_i, &memsize); + return memsize; +} -#if OPT_GLOBAL_METHOD_CACHE -static struct { - unsigned int size; - unsigned int mask; - struct cache_entry *entries; -} global_method_cache = { - GLOBAL_METHOD_CACHE_SIZE, - GLOBAL_METHOD_CACHE_MASK, +static enum rb_id_table_iterator_result +compact_cc_entry_i(VALUE ccs_ptr, void *data) +{ + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_ptr; + + ccs->cme = (const struct rb_callable_method_entry_struct *)rb_gc_location((VALUE)ccs->cme); + VM_ASSERT(vm_ccs_p(ccs)); + + for (int i=0; i<ccs->len; i++) { + ccs->entries[i].cc = (const struct rb_callcache *)rb_gc_location((VALUE)ccs->entries[i].cc); + } + + return ID_TABLE_CONTINUE; +} + +static void +vm_cc_table_compact(void *data) +{ + struct rb_id_table *tbl = (struct rb_id_table *)data; + rb_id_table_foreach_values(tbl, compact_cc_entry_i, NULL); +} + +static const rb_data_type_t cc_table_type = { + .wrap_struct_name = "VM/cc_table", + .function = { + .dmark = vm_cc_table_mark, + .dfree = vm_cc_table_free, + .dsize = vm_cc_table_memsize, + .dcompact = vm_cc_table_compact, + }, + .parent = &rb_managed_id_table_type, + .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE, }; + +VALUE +rb_vm_cc_table_create(size_t capa) +{ + return rb_managed_id_table_create(&cc_table_type, capa); +} + +static enum rb_id_table_iterator_result +vm_cc_table_dup_i(ID key, VALUE old_ccs_ptr, void *data) +{ + VALUE new_table = (VALUE)data; + struct rb_class_cc_entries *old_ccs = (struct rb_class_cc_entries *)old_ccs_ptr; + + if (METHOD_ENTRY_INVALIDATED(old_ccs->cme)) { + // Invalidated CME. This entry will be removed from the old table on + // the next GC mark, so it's unsafe (and undesirable) to copy + return ID_TABLE_CONTINUE; + } + + size_t memsize = vm_ccs_alloc_size(old_ccs->capa); + struct rb_class_cc_entries *new_ccs = ruby_xcalloc(1, memsize); + rb_managed_id_table_insert(new_table, key, (VALUE)new_ccs); + + // We hold the VM lock, so invalidation should not have happened between + // our earlier invalidation check and now. + VM_ASSERT(!METHOD_ENTRY_INVALIDATED(old_ccs->cme)); + + memcpy(new_ccs, old_ccs, memsize); + +#if VM_CHECK_MODE > 0 + new_ccs->debug_sig = ~(VALUE)new_ccs; #endif -#define ruby_running (GET_VM()->running) -/* int ruby_running = 0; */ + RB_OBJ_WRITTEN(new_table, Qundef, (VALUE)new_ccs->cme); + for (int index = 0; index < new_ccs->len; index++) { + RB_OBJ_WRITTEN(new_table, Qundef, new_ccs->entries[index].cc); + } + return ID_TABLE_CONTINUE; +} + +VALUE +rb_vm_cc_table_dup(VALUE old_table) +{ + ASSERT_vm_locking(); + VALUE new_table = rb_vm_cc_table_create(rb_managed_id_table_size(old_table)); + rb_managed_id_table_foreach(old_table, vm_cc_table_dup_i, (void *)new_table); + return new_table; +} + +static void +vm_ccs_invalidate(struct rb_class_cc_entries *ccs) +{ + for (int i=0; i<ccs->len; i++) { + const struct rb_callcache *cc = ccs->entries[i].cc; + VM_ASSERT(!vm_cc_super_p(cc) && !vm_cc_refinement_p(cc)); + vm_cc_invalidate(cc); + } +} static void -rb_class_clear_method_cache(VALUE klass, VALUE arg) +rb_vm_ccs_invalidate_and_free(struct rb_class_cc_entries *ccs) { - mjit_remove_class_serial(RCLASS_SERIAL(klass)); - RCLASS_SERIAL(klass) = rb_next_class_serial(); + RB_DEBUG_COUNTER_INC(ccs_free); + vm_ccs_invalidate(ccs); + ruby_xfree(ccs); +} + +void +rb_vm_cc_table_delete(VALUE table, ID mid) +{ + VALUE ccs_obj; + if (rb_managed_id_table_lookup(table, mid, &ccs_obj)) { + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_obj; + rb_managed_id_table_delete(table, mid); + rb_vm_ccs_invalidate_and_free(ccs); + } +} +static enum rb_id_table_iterator_result +vm_ccs_dump_i(ID mid, VALUE val, void *data) +{ + const struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)val; + fprintf(stderr, " | %s (len:%d) ", rb_id2name(mid), ccs->len); + rp(ccs->cme); + + for (int i=0; i<ccs->len; i++) { + rp_m( " | \t", ccs->entries[i].cc); + } + + return ID_TABLE_CONTINUE; +} + +static void +vm_ccs_dump(VALUE klass, ID target_mid) +{ + VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass); + if (cc_tbl) { + VALUE ccs; + if (target_mid) { + if (rb_managed_id_table_lookup(cc_tbl, target_mid, &ccs)) { + fprintf(stderr, " [CCTB] %p\n", (void *)cc_tbl); + vm_ccs_dump_i(target_mid, ccs, NULL); + } + } + else { + fprintf(stderr, " [CCTB] %p\n", (void *)cc_tbl); + rb_managed_id_table_foreach(cc_tbl, vm_ccs_dump_i, (void *)target_mid); + } + } +} + +static enum rb_id_table_iterator_result +vm_cme_dump_i(ID mid, VALUE val, void *data) +{ + ID target_mid = (ID)data; + if (target_mid == 0 || mid == target_mid) { + rp_m(" > ", val); + } + return ID_TABLE_CONTINUE; +} + +static VALUE +vm_mtbl_dump(VALUE klass, ID target_mid) +{ + fprintf(stderr, "# vm_mtbl\n"); + while (klass) { + rp_m(" -> ", klass); + VALUE me; + + if (RCLASS_M_TBL(klass)) { + if (target_mid != 0) { + if (rb_id_table_lookup(RCLASS_M_TBL(klass), target_mid, &me)) { + rp_m(" [MTBL] ", me); + } + } + else { + fprintf(stderr, " ## RCLASS_M_TBL (%p)\n", (void *)RCLASS_M_TBL(klass)); + rb_id_table_foreach(RCLASS_M_TBL(klass), vm_cme_dump_i, NULL); + } + } + else { + fprintf(stderr, " MTBL: NULL\n"); + } + if (RCLASS_WRITABLE_CALLABLE_M_TBL(klass)) { + if (target_mid != 0) { + if (rb_id_table_lookup(RCLASS_WRITABLE_CALLABLE_M_TBL(klass), target_mid, &me)) { + rp_m(" [CM**] ", me); + } + } + else { + fprintf(stderr, " ## RCLASS_CALLABLE_M_TBL\n"); + rb_id_table_foreach(RCLASS_WRITABLE_CALLABLE_M_TBL(klass), vm_cme_dump_i, NULL); + } + } + if (RCLASS_WRITABLE_CC_TBL(klass)) { + vm_ccs_dump(klass, target_mid); + } + klass = RCLASS_SUPER(klass); + } + return Qnil; +} + +void +rb_vm_mtbl_dump(const char *msg, VALUE klass, ID target_mid) +{ + fprintf(stderr, "[%s] ", msg); + vm_mtbl_dump(klass, target_mid); +} + +static inline void +vm_cme_invalidate(rb_callable_method_entry_t *cme) +{ + VM_ASSERT(IMEMO_TYPE_P(cme, imemo_ment), "cme: %d", imemo_type((VALUE)cme)); + VM_ASSERT(callable_method_entry_p(cme)); + METHOD_ENTRY_INVALIDATED_SET(cme); + RB_DEBUG_COUNTER_INC(cc_cme_invalidate); + + rb_yjit_cme_invalidate(cme); + rb_zjit_cme_invalidate(cme); +} + +static int +rb_clear_constant_cache_for_id_i(st_data_t ic, st_data_t arg) +{ + ((IC) ic)->entry = NULL; + return ST_CONTINUE; +} + +void +rb_clear_constant_cache_for_id(ID id) +{ + VALUE lookup_result; + rb_vm_t *vm = GET_VM(); + + if (rb_id_table_lookup(vm->constant_cache, id, &lookup_result)) { + set_table *ics = (set_table *)lookup_result; + set_table_foreach(ics, rb_clear_constant_cache_for_id_i, (st_data_t) NULL); + ruby_vm_constant_cache_invalidations += ics->num_entries; + } + + rb_yjit_constant_state_changed(id); + rb_zjit_constant_state_changed(id); +} + +static void +invalidate_negative_cache(ID mid) +{ + VALUE cme; + rb_vm_t *vm = GET_VM(); + + if (rb_id_table_lookup(vm->negative_cme_table, mid, &cme)) { + rb_id_table_delete(vm->negative_cme_table, mid); + vm_cme_invalidate((rb_callable_method_entry_t *)cme); + RB_DEBUG_COUNTER_INC(cc_invalidate_negative); + } +} + +const rb_method_entry_t * rb_method_entry_clone(const rb_method_entry_t *src_me); +static const rb_callable_method_entry_t *complemented_callable_method_entry(VALUE klass, ID id); +static const rb_callable_method_entry_t *lookup_overloaded_cme(const rb_callable_method_entry_t *cme); + +static void +invalidate_method_cache_in_cc_table(VALUE tbl, ID mid) +{ + VALUE ccs_data; + if (tbl && rb_managed_id_table_lookup(tbl, mid, &ccs_data)) { + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data; + rb_yjit_cme_invalidate((rb_callable_method_entry_t *)ccs->cme); + rb_zjit_cme_invalidate((rb_callable_method_entry_t *)ccs->cme); + if (NIL_P(ccs->cme->owner)) invalidate_negative_cache(mid); + rb_vm_ccs_invalidate_and_free(ccs); + rb_managed_id_table_delete(tbl, mid); + RB_DEBUG_COUNTER_INC(cc_invalidate_leaf_ccs); + } +} + +static void +invalidate_callable_method_entry_in_callable_m_table(struct rb_id_table *tbl, ID mid) +{ + VALUE cme; + if (tbl && rb_id_table_lookup(tbl, mid, &cme)) { + rb_yjit_cme_invalidate((rb_callable_method_entry_t *)cme); + rb_zjit_cme_invalidate((rb_callable_method_entry_t *)cme); + rb_id_table_delete(tbl, mid); + RB_DEBUG_COUNTER_INC(cc_invalidate_leaf_callable); + } +} + +struct invalidate_callable_method_entry_foreach_arg { + VALUE klass; + ID mid; + const rb_method_entry_t *cme; + const rb_method_entry_t *newer; +}; + +static void +invalidate_callable_method_entry_in_every_m_table_i(rb_classext_t *ext, bool is_prime, VALUE box_value, void *data) +{ + st_data_t me; + struct invalidate_callable_method_entry_foreach_arg *arg = (struct invalidate_callable_method_entry_foreach_arg *)data; + struct rb_id_table *tbl = RCLASSEXT_M_TBL(ext); + + if (rb_id_table_lookup(tbl, arg->mid, &me) && arg->cme == (const rb_method_entry_t *)me) { + rb_method_table_insert(arg->klass, tbl, arg->mid, arg->newer); + } +} + +static void +invalidate_callable_method_entry_in_every_m_table(VALUE klass, ID mid, const rb_callable_method_entry_t *cme) +{ + // The argument cme must be invalidated later in the caller side + const rb_method_entry_t *newer = rb_method_entry_clone((const rb_method_entry_t *)cme); + struct invalidate_callable_method_entry_foreach_arg arg = { + .klass = klass, + .mid = mid, + .cme = (const rb_method_entry_t *) cme, + .newer = newer, + }; + rb_class_classext_foreach(klass, invalidate_callable_method_entry_in_every_m_table_i, (void *)&arg); +} + +static void +invalidate_complemented_method_entry_in_callable_m_table(struct rb_id_table *tbl, ID mid) +{ + VALUE cme; + if (tbl && rb_id_table_lookup(tbl, mid, &cme)) { + rb_yjit_cme_invalidate((rb_callable_method_entry_t *)cme); + rb_zjit_cme_invalidate((rb_callable_method_entry_t *)cme); + rb_id_table_delete(tbl, mid); + RB_DEBUG_COUNTER_INC(cc_invalidate_tree_callable); + } +} + +static void +clear_method_cache_by_id_in_class(VALUE klass, ID mid) +{ + VM_ASSERT_TYPE2(klass, T_CLASS, T_ICLASS); + if (rb_objspace_garbage_object_p(klass)) return; + + RB_VM_LOCKING() { + rb_vm_barrier(); + + if (LIKELY(RCLASS_SUBCLASSES_FIRST(klass) == NULL)) { + // no subclasses + // check only current class + + // invalidate CCs + VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass); + invalidate_method_cache_in_cc_table(cc_tbl, mid); + if (RCLASS_CC_TBL_NOT_PRIME_P(klass, cc_tbl)) { + invalidate_method_cache_in_cc_table(RCLASS_PRIME_CC_TBL(klass), mid); + } + + // remove from callable_m_tbl, if exists + struct rb_id_table *cm_tbl = RCLASS_WRITABLE_CALLABLE_M_TBL(klass); + invalidate_callable_method_entry_in_callable_m_table(cm_tbl, mid); + if (RCLASS_CALLABLE_M_TBL_NOT_PRIME_P(klass, cm_tbl)) { + invalidate_callable_method_entry_in_callable_m_table(RCLASS_PRIME_CALLABLE_M_TBL(klass), mid); + } + + RB_DEBUG_COUNTER_INC(cc_invalidate_leaf); + } + else { + const rb_callable_method_entry_t *cme = complemented_callable_method_entry(klass, mid); + + if (cme) { + // invalidate cme if found to invalidate the inline method cache. + if (METHOD_ENTRY_CACHED(cme)) { + if (METHOD_ENTRY_COMPLEMENTED(cme)) { + // do nothing + } + else { + // invalidate cc by invalidating cc->cme + VALUE owner = cme->owner; + VM_ASSERT_TYPE(owner, T_CLASS); + VALUE klass_housing_cme; + if (cme->def->type == VM_METHOD_TYPE_REFINED && !cme->def->body.refined.orig_me) { + klass_housing_cme = owner; + } + else { + klass_housing_cme = RCLASS_ORIGIN(owner); + } + + // replace the cme that will be invalid in the all classexts + invalidate_callable_method_entry_in_every_m_table(klass_housing_cme, mid, cme); + } + + vm_cme_invalidate((rb_callable_method_entry_t *)cme); + RB_DEBUG_COUNTER_INC(cc_invalidate_tree_cme); + + // In case of refinement ME, also invalidate the wrapped ME that + // could be cached at some callsite and is unreachable from any + // RCLASS_WRITABLE_CC_TBL. + if (cme->def->type == VM_METHOD_TYPE_REFINED && cme->def->body.refined.orig_me) { + vm_cme_invalidate((rb_callable_method_entry_t *)cme->def->body.refined.orig_me); + } + + if (cme->def->iseq_overload) { + rb_callable_method_entry_t *monly_cme = (rb_callable_method_entry_t *)lookup_overloaded_cme(cme); + if (monly_cme) { + vm_cme_invalidate(monly_cme); + } + } + } + + // invalidate complement tbl + if (METHOD_ENTRY_COMPLEMENTED(cme)) { + VALUE defined_class = cme->defined_class; + struct rb_id_table *cm_tbl = RCLASS_WRITABLE_CALLABLE_M_TBL(defined_class); + invalidate_complemented_method_entry_in_callable_m_table(cm_tbl, mid); + if (RCLASS_CALLABLE_M_TBL_NOT_PRIME_P(defined_class, cm_tbl)) { + struct rb_id_table *prime_cm_table = RCLASS_PRIME_CALLABLE_M_TBL(defined_class); + invalidate_complemented_method_entry_in_callable_m_table(prime_cm_table, mid); + } + } + + RB_DEBUG_COUNTER_INC(cc_invalidate_tree); + } + else { + invalidate_negative_cache(mid); + } + } + + rb_gccct_clear_table(Qnil); + } +} + +static void +clear_iclass_method_cache_by_id(VALUE iclass, VALUE d) +{ + VM_ASSERT_TYPE(iclass, T_ICLASS); + ID mid = (ID)d; + clear_method_cache_by_id_in_class(iclass, mid); +} + +static void +clear_iclass_method_cache_by_id_for_refinements(VALUE klass, VALUE d) +{ if (RB_TYPE_P(klass, T_ICLASS)) { - struct rb_id_table *table = RCLASS_CALLABLE_M_TBL(klass); - if (table) { - rb_id_table_clear(table); - } + ID mid = (ID)d; + clear_method_cache_by_id_in_class(klass, mid); + } +} + +void +rb_clear_method_cache(VALUE klass_or_module, ID mid) +{ + if (RB_TYPE_P(klass_or_module, T_MODULE)) { + VALUE module = klass_or_module; // alias + + if (FL_TEST(module, RMODULE_IS_REFINEMENT)) { + VALUE refined_class = rb_refinement_module_get_refined_class(module); + rb_clear_method_cache(refined_class, mid); + rb_class_foreach_subclass(refined_class, clear_iclass_method_cache_by_id_for_refinements, mid); + rb_clear_all_refinement_method_cache(); + } + rb_class_foreach_subclass(module, clear_iclass_method_cache_by_id, mid); } else { - if (RCLASS_CALLABLE_M_TBL(klass) != 0) { - rb_obj_info_dump(klass); - rb_bug("RCLASS_CALLABLE_M_TBL(klass) != 0"); - } + clear_method_cache_by_id_in_class(klass_or_module, mid); } +} + +static enum rb_id_table_iterator_result +invalidate_method_entry_in_iclass_callable_m_tbl(VALUE cme, void *data) +{ + vm_cme_invalidate((rb_callable_method_entry_t *)cme); + return ID_TABLE_DELETE; +} - rb_class_foreach_subclass(klass, rb_class_clear_method_cache, arg); +static enum rb_id_table_iterator_result +invalidate_ccs_in_iclass_cc_tbl(VALUE value, void *data) +{ + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)value; + vm_cme_invalidate((rb_callable_method_entry_t *)ccs->cme); + xfree(ccs); + return ID_TABLE_DELETE; } void -rb_clear_constant_cache(void) +rb_invalidate_method_caches(struct rb_id_table *cm_tbl, VALUE cc_tbl) +{ + if (cm_tbl) { + rb_id_table_foreach_values(cm_tbl, invalidate_method_entry_in_iclass_callable_m_tbl, NULL); + } + if (cc_tbl) { + rb_managed_id_table_foreach_values(cc_tbl, invalidate_ccs_in_iclass_cc_tbl, NULL); + } +} + +static int +invalidate_cc_refinement(st_data_t key, st_data_t data) { - INC_GLOBAL_CONSTANT_STATE(); + VALUE v = (VALUE)key; + void *ptr = rb_asan_poisoned_object_p(v); + rb_asan_unpoison_object(v, false); + + if (rb_gc_pointer_to_heap_p(v) && + !rb_objspace_garbage_object_p(v) && + RBASIC(v)->flags) { // liveness check + const struct rb_callcache *cc = (const struct rb_callcache *)v; + + VM_ASSERT(vm_cc_refinement_p(cc)); + + if (vm_cc_valid(cc)) { + vm_cc_invalidate(cc); + } + } + + if (ptr) { + rb_asan_poison_object(v); + } + + return ST_CONTINUE; +} + +static st_index_t +vm_ci_hash(VALUE v) +{ + const struct rb_callinfo *ci = (const struct rb_callinfo *)v; + st_index_t h; + h = rb_hash_start(ci->mid); + h = rb_hash_uint(h, ci->flag); + h = rb_hash_uint(h, ci->argc); + if (ci->kwarg) { + for (int i = 0; i < ci->kwarg->keyword_len; i++) { + h = rb_hash_uint(h, ci->kwarg->keywords[i]); + } + } + return h; +} + +static int +vm_ci_hash_cmp(VALUE v1, VALUE v2) +{ + const struct rb_callinfo *ci1 = (const struct rb_callinfo *)v1; + const struct rb_callinfo *ci2 = (const struct rb_callinfo *)v2; + if (ci1->mid != ci2->mid) return 1; + if (ci1->flag != ci2->flag) return 1; + if (ci1->argc != ci2->argc) return 1; + if (ci1->kwarg != NULL) { + VM_ASSERT(ci2->kwarg != NULL); // implied by matching flags + + if (ci1->kwarg->keyword_len != ci2->kwarg->keyword_len) + return 1; + + for (int i = 0; i < ci1->kwarg->keyword_len; i++) { + if (ci1->kwarg->keywords[i] != ci2->kwarg->keywords[i]) { + return 1; + } + } + } + else { + VM_ASSERT(ci2->kwarg == NULL); // implied by matching flags + } + return 0; +} + +static const struct st_hash_type vm_ci_hashtype = { + vm_ci_hash_cmp, + vm_ci_hash +}; + +static int +ci_lookup_i(st_data_t *key, st_data_t *value, st_data_t data, int existing) +{ + const struct rb_callinfo *ci = (const struct rb_callinfo *)*key; + st_data_t *ret = (st_data_t *)data; + + if (existing) { + if (rb_objspace_garbage_object_p((VALUE)ci)) { + *ret = (st_data_t)NULL; + return ST_DELETE; + } + else { + *ret = *key; + return ST_STOP; + } + } + else { + *key = *value = *ret = (st_data_t)ci; + return ST_CONTINUE; + } +} + +const struct rb_callinfo * +rb_vm_ci_lookup(ID mid, unsigned int flag, unsigned int argc, const struct rb_callinfo_kwarg *kwarg) +{ + rb_vm_t *vm = GET_VM(); + const struct rb_callinfo *ci = NULL; + + if (kwarg) { + ((struct rb_callinfo_kwarg *)kwarg)->references++; + } + + struct rb_callinfo *new_ci = SHAREABLE_IMEMO_NEW(struct rb_callinfo, imemo_callinfo, (VALUE)kwarg); + new_ci->mid = mid; + new_ci->flag = flag; + new_ci->argc = argc; + + RB_VM_LOCKING() { + st_table *ci_table = vm->ci_table; + VM_ASSERT(ci_table); + + do { + st_update(ci_table, (st_data_t)new_ci, ci_lookup_i, (st_data_t)&ci); + } while (ci == NULL); + } + + VM_ASSERT(ci); + + return ci; } void -rb_clear_method_cache_by_class(VALUE klass) +rb_vm_ci_free(const struct rb_callinfo *ci) { - if (klass && klass != Qundef) { - int global = klass == rb_cBasicObject || klass == rb_cObject || klass == rb_mKernel; + ASSERT_vm_locking(); + + rb_vm_t *vm = GET_VM(); + + st_data_t key = (st_data_t)ci; + st_delete(vm->ci_table, &key, NULL); +} - RUBY_DTRACE_HOOK(METHOD_CACHE_CLEAR, (global ? "global" : rb_class2name(klass))); +void +rb_vm_insert_cc_refinement(const struct rb_callcache *cc) +{ + st_data_t key = (st_data_t)cc; - if (global) { - INC_GLOBAL_METHOD_STATE(); - } - else { - rb_class_clear_method_cache(klass, Qnil); - } + rb_vm_t *vm = GET_VM(); + RB_VM_LOCK_ENTER(); + { + rb_set_insert(vm->cc_refinement_table, key); } + RB_VM_LOCK_LEAVE(); +} + +void +rb_vm_delete_cc_refinement(const struct rb_callcache *cc) +{ + ASSERT_vm_locking(); - if (klass == rb_mKernel) { - rb_subclass_entry_t *entry = RCLASS_EXT(klass)->subclasses; + rb_vm_t *vm = GET_VM(); + st_data_t key = (st_data_t)cc; - for (; entry != NULL; entry = entry->next) { - struct rb_id_table *table = RCLASS_CALLABLE_M_TBL(entry->klass); - if (table)rb_id_table_clear(table); - } + rb_set_table_delete(vm->cc_refinement_table, &key); +} + +void +rb_clear_all_refinement_method_cache(void) +{ + rb_vm_t *vm = GET_VM(); + + RB_VM_LOCK_ENTER(); + { + rb_set_table_foreach(vm->cc_refinement_table, invalidate_cc_refinement, (st_data_t)NULL); + rb_set_table_clear(vm->cc_refinement_table); + rb_set_compact_table(vm->cc_refinement_table); } + RB_VM_LOCK_LEAVE(); + + rb_yjit_invalidate_all_method_lookup_assumptions(); } -VALUE -rb_f_notimplement(int argc, const VALUE *argv, VALUE obj) +void +rb_method_table_insert(VALUE klass, struct rb_id_table *table, ID method_id, const rb_method_entry_t *me) +{ + RB_VM_LOCKING() { + rb_method_table_insert0(klass, table, method_id, me, RB_TYPE_P(klass, T_ICLASS) && !RICLASS_OWNS_M_TBL_P(klass)); + } +} + +void +rb_method_table_insert0(VALUE klass, struct rb_id_table *table, ID method_id, const rb_method_entry_t *me, bool iclass_shared_mtbl) +{ + VALUE table_owner = klass; + if (iclass_shared_mtbl) { + table_owner = RBASIC(table_owner)->klass; + } + VM_ASSERT_TYPE3(table_owner, T_CLASS, T_ICLASS, T_MODULE); + rb_id_table_insert(table, method_id, (VALUE)me); + RB_OBJ_WRITTEN(table_owner, Qundef, (VALUE)me); +} + +// rb_f_notimplement has an extra trailing argument to distinguish it from other methods +// at compile-time to override arity to be -1. But the trailing argument introduces a +// signature mismatch between caller and callee, so rb_define_method family inserts a +// method entry with rb_f_notimplement_internal, which has canonical arity=-1 signature, +// instead of rb_f_notimplement. +NORETURN(static VALUE rb_f_notimplement_internal(int argc, const VALUE *argv, VALUE obj)); + +static VALUE +rb_f_notimplement_internal(int argc, const VALUE *argv, VALUE obj) { rb_notimplement(); UNREACHABLE_RETURN(Qnil); } +VALUE +rb_f_notimplement(int argc, const VALUE *argv, VALUE obj, VALUE marker) +{ + rb_f_notimplement_internal(argc, argv, obj); +} + static void rb_define_notimplement_method_id(VALUE mod, ID id, rb_method_visibility_t visi) { @@ -131,177 +813,253 @@ void rb_add_method_cfunc(VALUE klass, ID mid, VALUE (*func)(ANYARGS), int argc, rb_method_visibility_t visi) { if (argc < -2 || 15 < argc) rb_raise(rb_eArgError, "arity out of range: %d for -2..15", argc); - if (func != rb_f_notimplement) { - rb_method_cfunc_t opt; - opt.func = func; - opt.argc = argc; - rb_add_method(klass, mid, VM_METHOD_TYPE_CFUNC, &opt, visi); + if (func != (VALUE(*)(ANYARGS))rb_f_notimplement) { + rb_method_cfunc_t opt; + opt.func = func; + opt.argc = argc; + rb_add_method(klass, mid, VM_METHOD_TYPE_CFUNC, &opt, visi); } else { - rb_define_notimplement_method_id(klass, mid, visi); + rb_define_notimplement_method_id(klass, mid, visi); } } +void +rb_add_method_optimized(VALUE klass, ID mid, enum method_optimized_type opt_type, unsigned int index, rb_method_visibility_t visi) +{ + rb_method_optimized_t opt = { + .type = opt_type, + .index = index, + }; + rb_add_method(klass, mid, VM_METHOD_TYPE_OPTIMIZED, &opt, visi); +} + static void -rb_method_definition_release(rb_method_definition_t *def, int complemented) +method_definition_release(rb_method_definition_t *def) { if (def != NULL) { - const int alias_count = def->alias_count; - const int complemented_count = def->complemented_count; - VM_ASSERT(alias_count >= 0); - VM_ASSERT(complemented_count >= 0); + const unsigned int reference_count_was = RUBY_ATOMIC_FETCH_SUB(def->reference_count, 1); - if (alias_count + complemented_count == 0) { - if (METHOD_DEBUG) fprintf(stderr, "-%p-%s:%d,%d (remove)\n", (void *)def, - rb_id2name(def->original_id), alias_count, complemented_count); - VM_ASSERT(def->type == VM_METHOD_TYPE_BMETHOD ? def->body.bmethod.hooks == NULL : TRUE); - xfree(def); - } - else { - if (complemented) def->complemented_count--; - else if (def->alias_count > 0) def->alias_count--; + RUBY_ASSERT_ALWAYS(reference_count_was != 0); - if (METHOD_DEBUG) fprintf(stderr, "-%p-%s:%d->%d,%d->%d (dec)\n", (void *)def, rb_id2name(def->original_id), - alias_count, def->alias_count, complemented_count, def->complemented_count); - } + if (reference_count_was == 1) { + if (METHOD_DEBUG) fprintf(stderr, "-%p-%s:1->0 (remove)\n", (void *)def, + rb_id2name(def->original_id)); + xfree(def); + } + else { + if (METHOD_DEBUG) fprintf(stderr, "-%p-%s:%d->%d (dec)\n", (void *)def, rb_id2name(def->original_id), + reference_count_was, reference_count_was - 1); + } } } void -rb_free_method_entry(const rb_method_entry_t *me) +rb_method_definition_release(rb_method_definition_t *def) { - rb_method_definition_release(me->def, METHOD_ENTRY_COMPLEMENTED(me)); + method_definition_release(def); } -static inline rb_method_entry_t *search_method(VALUE klass, ID id, VALUE *defined_class_ptr); -extern int rb_method_definition_eq(const rb_method_definition_t *d1, const rb_method_definition_t *d2); +static void delete_overloaded_cme(const rb_callable_method_entry_t *cme); -static inline rb_method_entry_t * -lookup_method_table(VALUE klass, ID id) +void +rb_free_method_entry_vm_weak_references(const rb_method_entry_t *me) { - st_data_t body; - struct rb_id_table *m_tbl = RCLASS_M_TBL(klass); - - if (rb_id_table_lookup(m_tbl, id, &body)) { - return (rb_method_entry_t *) body; + if (me->def && me->def->iseq_overload) { + delete_overloaded_cme((const rb_callable_method_entry_t *)me); } - else { - return 0; +} + +void +rb_free_method_entry(const rb_method_entry_t *me) +{ +#if USE_ZJIT + if (METHOD_ENTRY_CACHED(me)) { + rb_zjit_cme_free((const rb_callable_method_entry_t *)me); } +#endif + +#if USE_YJIT + // YJIT rb_yjit_root_mark() roots CMEs in `Invariants`, + // to remove from `Invariants` here. +#endif + + method_definition_release(me->def); } +static inline rb_method_entry_t *search_method(VALUE klass, ID id, VALUE *defined_class_ptr); +extern int rb_method_definition_eq(const rb_method_definition_t *d1, const rb_method_definition_t *d2); + static VALUE (*call_cfunc_invoker_func(int argc))(VALUE recv, int argc, const VALUE *, VALUE (*func)(ANYARGS)) { - switch (argc) { - case -2: return &call_cfunc_m2; - case -1: return &call_cfunc_m1; - case 0: return &call_cfunc_0; - case 1: return &call_cfunc_1; - case 2: return &call_cfunc_2; - case 3: return &call_cfunc_3; - case 4: return &call_cfunc_4; - case 5: return &call_cfunc_5; - case 6: return &call_cfunc_6; - case 7: return &call_cfunc_7; - case 8: return &call_cfunc_8; - case 9: return &call_cfunc_9; - case 10: return &call_cfunc_10; - case 11: return &call_cfunc_11; - case 12: return &call_cfunc_12; - case 13: return &call_cfunc_13; - case 14: return &call_cfunc_14; - case 15: return &call_cfunc_15; - default: - rb_bug("call_cfunc_func: unsupported length: %d", argc); + if (!GET_THREAD()->ext_config.ractor_safe) { + switch (argc) { + case -2: return &call_cfunc_m2; + case -1: return &call_cfunc_m1; + case 0: return &call_cfunc_0; + case 1: return &call_cfunc_1; + case 2: return &call_cfunc_2; + case 3: return &call_cfunc_3; + case 4: return &call_cfunc_4; + case 5: return &call_cfunc_5; + case 6: return &call_cfunc_6; + case 7: return &call_cfunc_7; + case 8: return &call_cfunc_8; + case 9: return &call_cfunc_9; + case 10: return &call_cfunc_10; + case 11: return &call_cfunc_11; + case 12: return &call_cfunc_12; + case 13: return &call_cfunc_13; + case 14: return &call_cfunc_14; + case 15: return &call_cfunc_15; + default: + rb_bug("unsupported length: %d", argc); + } + } + else { + switch (argc) { + case -2: return &ractor_safe_call_cfunc_m2; + case -1: return &ractor_safe_call_cfunc_m1; + case 0: return &ractor_safe_call_cfunc_0; + case 1: return &ractor_safe_call_cfunc_1; + case 2: return &ractor_safe_call_cfunc_2; + case 3: return &ractor_safe_call_cfunc_3; + case 4: return &ractor_safe_call_cfunc_4; + case 5: return &ractor_safe_call_cfunc_5; + case 6: return &ractor_safe_call_cfunc_6; + case 7: return &ractor_safe_call_cfunc_7; + case 8: return &ractor_safe_call_cfunc_8; + case 9: return &ractor_safe_call_cfunc_9; + case 10: return &ractor_safe_call_cfunc_10; + case 11: return &ractor_safe_call_cfunc_11; + case 12: return &ractor_safe_call_cfunc_12; + case 13: return &ractor_safe_call_cfunc_13; + case 14: return &ractor_safe_call_cfunc_14; + case 15: return &ractor_safe_call_cfunc_15; + default: + rb_bug("unsupported length: %d", argc); + } } } static void -setup_method_cfunc_struct(rb_method_cfunc_t *cfunc, VALUE (*func)(), int argc) +setup_method_cfunc_struct(rb_method_cfunc_t *cfunc, VALUE (*func)(ANYARGS), int argc) { cfunc->func = func; cfunc->argc = argc; cfunc->invoker = call_cfunc_invoker_func(argc); } -MJIT_FUNC_EXPORTED void + +static rb_method_definition_t * +method_definition_addref(rb_method_definition_t *def, bool complemented) +{ + unsigned int reference_count_was = RUBY_ATOMIC_FETCH_ADD(def->reference_count, 1); + if (!complemented && reference_count_was > 0) { + /* TODO: A Ractor can reach this via UnboundMethod#bind */ + def->aliased = true; + } + if (METHOD_DEBUG) fprintf(stderr, "+%p-%s:%d->%d\n", (void *)def, rb_id2name(def->original_id), reference_count_was, reference_count_was+1); + + return def; +} + +void +rb_method_definition_addref(rb_method_definition_t *def) +{ + method_definition_addref(def, false); +} + +void rb_method_definition_set(const rb_method_entry_t *me, rb_method_definition_t *def, void *opts) { - *(rb_method_definition_t **)&me->def = def; + method_definition_release(me->def); + *(rb_method_definition_t **)&me->def = method_definition_addref(def, METHOD_ENTRY_COMPLEMENTED(me)); + + if (!ruby_running) add_opt_method_entry(me); if (opts != NULL) { - switch (def->type) { - case VM_METHOD_TYPE_ISEQ: - { - rb_method_iseq_t *iseq_body = (rb_method_iseq_t *)opts; - rb_cref_t *method_cref, *cref = iseq_body->cref; - - /* setup iseq first (before invoking GC) */ - RB_OBJ_WRITE(me, &def->body.iseq.iseqptr, iseq_body->iseqptr); - - if (0) vm_cref_dump("rb_method_definition_create", cref); - - if (cref) { - method_cref = cref; - } - else { - method_cref = vm_cref_new_toplevel(GET_EC()); /* TODO: can we reuse? */ - } - - RB_OBJ_WRITE(me, &def->body.iseq.cref, method_cref); - return; - } - case VM_METHOD_TYPE_CFUNC: - { - rb_method_cfunc_t *cfunc = (rb_method_cfunc_t *)opts; - setup_method_cfunc_struct(UNALIGNED_MEMBER_PTR(def, body.cfunc), cfunc->func, cfunc->argc); - return; - } - case VM_METHOD_TYPE_ATTRSET: - case VM_METHOD_TYPE_IVAR: - { - const rb_execution_context_t *ec = GET_EC(); - rb_control_frame_t *cfp; - int line; - - def->body.attr.id = (ID)(VALUE)opts; - - cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp); - - if (cfp && (line = rb_vm_get_sourceline(cfp))) { - VALUE location = rb_ary_new3(2, rb_iseq_path(cfp->iseq), INT2FIX(line)); - RB_OBJ_WRITE(me, &def->body.attr.location, rb_ary_freeze(location)); - } - else { - VM_ASSERT(def->body.attr.location == 0); - } - return; - } - case VM_METHOD_TYPE_BMETHOD: + switch (def->type) { + case VM_METHOD_TYPE_ISEQ: + { + rb_method_iseq_t *iseq_body = (rb_method_iseq_t *)opts; + const rb_iseq_t *iseq = iseq_body->iseqptr; + rb_cref_t *method_cref, *cref = iseq_body->cref; + + /* setup iseq first (before invoking GC) */ + RB_OBJ_WRITE(me, &def->body.iseq.iseqptr, iseq); + + // Methods defined in `with_jit` should be considered METHOD_ENTRY_BASIC + if (rb_iseq_attr_p(iseq, BUILTIN_ATTR_C_TRACE)) { + METHOD_ENTRY_BASIC_SET((rb_method_entry_t *)me, TRUE); + } + + if (ISEQ_BODY(iseq)->mandatory_only_iseq) def->iseq_overload = 1; + + if (0) vm_cref_dump("rb_method_definition_create", cref); + + if (cref) { + method_cref = cref; + } + else { + method_cref = vm_cref_new_toplevel(GET_EC()); /* TODO: can we reuse? */ + } + + RB_OBJ_WRITE(me, &def->body.iseq.cref, method_cref); + return; + } + case VM_METHOD_TYPE_CFUNC: + { + rb_method_cfunc_t *cfunc = (rb_method_cfunc_t *)opts; + setup_method_cfunc_struct(UNALIGNED_MEMBER_PTR(def, body.cfunc), cfunc->func, cfunc->argc); + return; + } + case VM_METHOD_TYPE_ATTRSET: + case VM_METHOD_TYPE_IVAR: + { + const rb_execution_context_t *ec = GET_EC(); + rb_control_frame_t *cfp; + int line; + + def->body.attr.id = (ID)(VALUE)opts; + + cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp); + + if (cfp && (line = rb_vm_get_sourceline(cfp))) { + VALUE location = rb_ary_new3(2, rb_iseq_path(cfp->iseq), INT2FIX(line)); + rb_ary_freeze(location); + RB_OBJ_SET_SHAREABLE(location); + RB_OBJ_WRITE(me, &def->body.attr.location, location); + } + else { + VM_ASSERT(def->body.attr.location == 0); + } + return; + } + case VM_METHOD_TYPE_BMETHOD: RB_OBJ_WRITE(me, &def->body.bmethod.proc, (VALUE)opts); - return; - case VM_METHOD_TYPE_NOTIMPLEMENTED: - setup_method_cfunc_struct(UNALIGNED_MEMBER_PTR(def, body.cfunc), rb_f_notimplement, -1); - return; - case VM_METHOD_TYPE_OPTIMIZED: - def->body.optimize_type = (enum method_optimized_type)opts; - return; - case VM_METHOD_TYPE_REFINED: - { - const rb_method_refined_t *refined = (rb_method_refined_t *)opts; - RB_OBJ_WRITE(me, &def->body.refined.orig_me, refined->orig_me); - RB_OBJ_WRITE(me, &def->body.refined.owner, refined->owner); - return; - } - case VM_METHOD_TYPE_ALIAS: - RB_OBJ_WRITE(me, &def->body.alias.original_me, (rb_method_entry_t *)opts); - return; - case VM_METHOD_TYPE_ZSUPER: - case VM_METHOD_TYPE_UNDEF: - case VM_METHOD_TYPE_MISSING: - return; - } + def->body.bmethod.defined_ractor_id = rb_ec_ractor_id(GET_EC()); + return; + case VM_METHOD_TYPE_NOTIMPLEMENTED: + setup_method_cfunc_struct(UNALIGNED_MEMBER_PTR(def, body.cfunc), (VALUE(*)(ANYARGS))rb_f_notimplement_internal, -1); + return; + case VM_METHOD_TYPE_OPTIMIZED: + def->body.optimized = *(rb_method_optimized_t *)opts; + return; + case VM_METHOD_TYPE_REFINED: + { + RB_OBJ_WRITE(me, &def->body.refined.orig_me, (rb_method_entry_t *)opts); + return; + } + case VM_METHOD_TYPE_ALIAS: + RB_OBJ_WRITE(me, &def->body.alias.original_me, (rb_method_entry_t *)opts); + return; + case VM_METHOD_TYPE_ZSUPER: + case VM_METHOD_TYPE_UNDEF: + case VM_METHOD_TYPE_MISSING: + return; + } } } @@ -310,67 +1068,65 @@ method_definition_reset(const rb_method_entry_t *me) { rb_method_definition_t *def = me->def; - switch(def->type) { + switch (def->type) { case VM_METHOD_TYPE_ISEQ: - RB_OBJ_WRITTEN(me, Qundef, def->body.iseq.iseqptr); - RB_OBJ_WRITTEN(me, Qundef, def->body.iseq.cref); - break; + RB_OBJ_WRITTEN(me, Qundef, def->body.iseq.iseqptr); + RB_OBJ_WRITTEN(me, Qundef, def->body.iseq.cref); + break; case VM_METHOD_TYPE_ATTRSET: case VM_METHOD_TYPE_IVAR: - RB_OBJ_WRITTEN(me, Qundef, def->body.attr.location); - break; + RB_OBJ_WRITTEN(me, Qundef, def->body.attr.location); + break; case VM_METHOD_TYPE_BMETHOD: RB_OBJ_WRITTEN(me, Qundef, def->body.bmethod.proc); - /* give up to check all in a list */ - if (def->body.bmethod.hooks) rb_gc_writebarrier_remember((VALUE)me); - break; + break; case VM_METHOD_TYPE_REFINED: - RB_OBJ_WRITTEN(me, Qundef, def->body.refined.orig_me); - RB_OBJ_WRITTEN(me, Qundef, def->body.refined.owner); - break; + RB_OBJ_WRITTEN(me, Qundef, def->body.refined.orig_me); + break; case VM_METHOD_TYPE_ALIAS: - RB_OBJ_WRITTEN(me, Qundef, def->body.alias.original_me); - break; + RB_OBJ_WRITTEN(me, Qundef, def->body.alias.original_me); + break; case VM_METHOD_TYPE_CFUNC: case VM_METHOD_TYPE_ZSUPER: case VM_METHOD_TYPE_MISSING: case VM_METHOD_TYPE_OPTIMIZED: case VM_METHOD_TYPE_UNDEF: case VM_METHOD_TYPE_NOTIMPLEMENTED: - break; + break; } } -MJIT_FUNC_EXPORTED rb_method_definition_t * +static rb_atomic_t method_serial = 1; + +rb_method_definition_t * rb_method_definition_create(rb_method_type_t type, ID mid) { rb_method_definition_t *def; def = ZALLOC(rb_method_definition_t); def->type = type; def->original_id = mid; + def->method_serial = (uintptr_t)RUBY_ATOMIC_FETCH_ADD(method_serial, 1); + def->box = rb_current_box(); return def; } -static rb_method_definition_t * -method_definition_addref(rb_method_definition_t *def) +static rb_method_entry_t * +rb_method_entry_alloc(ID called_id, VALUE owner, VALUE defined_class, rb_method_definition_t *def, bool complement) { - def->alias_count++; - if (METHOD_DEBUG) fprintf(stderr, "+%p-%s:%d\n", (void *)def, rb_id2name(def->original_id), def->alias_count); - return def; -} + if (def) method_definition_addref(def, complement); + if (RTEST(defined_class)) { + // not negative cache + VM_ASSERT_TYPE2(defined_class, T_CLASS, T_ICLASS); + } + rb_method_entry_t *me = SHAREABLE_IMEMO_NEW(rb_method_entry_t, imemo_ment, defined_class); -static rb_method_definition_t * -method_definition_addref_complement(rb_method_definition_t *def) -{ - def->complemented_count++; - if (METHOD_DEBUG) fprintf(stderr, "+%p-%s:%d\n", (void *)def, rb_id2name(def->original_id), def->complemented_count); - return def; -} + // mark_and_move_method_entry pins itself when it is in the overloaded_cme table + rb_gc_register_pinning_obj((VALUE)me); + + *((rb_method_definition_t **)&me->def) = def; + me->called_id = called_id; + me->owner = owner; -static rb_method_entry_t * -rb_method_entry_alloc(ID called_id, VALUE owner, VALUE defined_class, const rb_method_definition_t *def) -{ - rb_method_entry_t *me = (rb_method_entry_t *)rb_imemo_new(imemo_ment, (VALUE)def, (VALUE)called_id, owner, defined_class); return me; } @@ -379,65 +1135,80 @@ filter_defined_class(VALUE klass) { switch (BUILTIN_TYPE(klass)) { case T_CLASS: - return klass; + return klass; case T_MODULE: - return 0; + return 0; case T_ICLASS: - break; + break; + default: + break; } rb_bug("filter_defined_class: %s", rb_obj_info(klass)); } rb_method_entry_t * -rb_method_entry_create(ID called_id, VALUE klass, rb_method_visibility_t visi, const rb_method_definition_t *def) +rb_method_entry_create(ID called_id, VALUE klass, rb_method_visibility_t visi, rb_method_definition_t *def) { - rb_method_entry_t *me = rb_method_entry_alloc(called_id, klass, filter_defined_class(klass), def); + rb_method_entry_t *me = rb_method_entry_alloc(called_id, klass, filter_defined_class(klass), def, false); METHOD_ENTRY_FLAGS_SET(me, visi, ruby_running ? FALSE : TRUE); if (def != NULL) method_definition_reset(me); return me; } +// Return a cloned ME that's not invalidated (MEs are disposable for caching). const rb_method_entry_t * rb_method_entry_clone(const rb_method_entry_t *src_me) { - rb_method_entry_t *me = rb_method_entry_alloc(src_me->called_id, src_me->owner, src_me->defined_class, - method_definition_addref(src_me->def)); + rb_method_entry_t *me = rb_method_entry_alloc(src_me->called_id, src_me->owner, src_me->defined_class, src_me->def, METHOD_ENTRY_COMPLEMENTED(src_me)); + METHOD_ENTRY_FLAGS_COPY(me, src_me); + + // Also clone inner ME in case of refinement ME + if (src_me->def && + src_me->def->type == VM_METHOD_TYPE_REFINED && + src_me->def->body.refined.orig_me) { + const rb_method_entry_t *orig_me = src_me->def->body.refined.orig_me; + VM_ASSERT(orig_me->def->type != VM_METHOD_TYPE_REFINED); + + rb_method_entry_t *orig_clone = rb_method_entry_alloc(orig_me->called_id, + orig_me->owner, orig_me->defined_class, orig_me->def, METHOD_ENTRY_COMPLEMENTED(orig_me)); + METHOD_ENTRY_FLAGS_COPY(orig_clone, orig_me); + + // Clone definition, since writing a VALUE to a shared definition + // can create reference edges we can't run WBs for. + rb_method_definition_t *clone_def = + rb_method_definition_create(VM_METHOD_TYPE_REFINED, src_me->called_id); + rb_method_definition_set(me, clone_def, orig_clone); + } return me; } -MJIT_FUNC_EXPORTED const rb_callable_method_entry_t * +const rb_callable_method_entry_t * rb_method_entry_complement_defined_class(const rb_method_entry_t *src_me, ID called_id, VALUE defined_class) { rb_method_definition_t *def = src_me->def; rb_method_entry_t *me; - struct { - const struct rb_method_entry_struct *orig_me; - VALUE owner; - } refined = {0}; + const rb_method_entry_t *refined_orig_me = NULL; if (!src_me->defined_class && - def->type == VM_METHOD_TYPE_REFINED && - def->body.refined.orig_me) { - const rb_method_entry_t *orig_me = - rb_method_entry_clone(def->body.refined.orig_me); - RB_OBJ_WRITE((VALUE)orig_me, &orig_me->defined_class, defined_class); - refined.orig_me = orig_me; - refined.owner = orig_me->owner; - def = NULL; + def->type == VM_METHOD_TYPE_REFINED && + def->body.refined.orig_me) { + const rb_method_entry_t *orig_me = + rb_method_entry_clone(def->body.refined.orig_me); + RB_OBJ_WRITE((VALUE)orig_me, &orig_me->defined_class, defined_class); + refined_orig_me = orig_me; + def = NULL; } - else { - def = method_definition_addref_complement(def); - } - me = rb_method_entry_alloc(called_id, src_me->owner, defined_class, def); + + me = rb_method_entry_alloc(called_id, src_me->owner, defined_class, def, true); METHOD_ENTRY_FLAGS_COPY(me, src_me); METHOD_ENTRY_COMPLEMENTED_SET(me); if (!def) { - def = rb_method_definition_create(VM_METHOD_TYPE_REFINED, called_id); - rb_method_definition_set(me, def, &refined); + def = rb_method_definition_create(VM_METHOD_TYPE_REFINED, called_id); + rb_method_definition_set(me, def, (void *)refined_orig_me); } - VM_ASSERT(RB_TYPE_P(me->owner, T_MODULE)); + VM_ASSERT_TYPE(me->owner, T_MODULE); return (rb_callable_method_entry_t *)me; } @@ -445,7 +1216,8 @@ rb_method_entry_complement_defined_class(const rb_method_entry_t *src_me, ID cal void rb_method_entry_copy(rb_method_entry_t *dst, const rb_method_entry_t *src) { - *(rb_method_definition_t **)&dst->def = method_definition_addref(src->def); + method_definition_release(dst->def); + *(rb_method_definition_t **)&dst->def = method_definition_addref(src->def, METHOD_ENTRY_COMPLEMENTED(src)); method_definition_reset(dst); dst->called_id = src->called_id; RB_OBJ_WRITE((VALUE)dst, &dst->owner, src->owner); @@ -457,28 +1229,38 @@ static void make_method_entry_refined(VALUE owner, rb_method_entry_t *me) { if (me->def->type == VM_METHOD_TYPE_REFINED) { - return; + return; } else { - struct { - struct rb_method_entry_struct *orig_me; - VALUE owner; - } refined; - rb_method_definition_t *def; + rb_method_definition_t *def; - rb_vm_check_redefinition_opt_method(me, me->owner); + rb_vm_check_redefinition_opt_method(me, me->owner); - refined.orig_me = - rb_method_entry_alloc(me->called_id, me->owner, - me->defined_class ? - me->defined_class : owner, - method_definition_addref(me->def)); - METHOD_ENTRY_FLAGS_COPY(refined.orig_me, me); - refined.owner = owner; + struct rb_method_entry_struct *orig_me = + rb_method_entry_alloc(me->called_id, + me->owner, + me->defined_class, + me->def, + true); + METHOD_ENTRY_FLAGS_COPY(orig_me, me); - def = rb_method_definition_create(VM_METHOD_TYPE_REFINED, me->called_id); - rb_method_definition_set(me, def, (void *)&refined); - METHOD_ENTRY_VISI_SET(me, METHOD_VISI_PUBLIC); + def = rb_method_definition_create(VM_METHOD_TYPE_REFINED, me->called_id); + rb_method_definition_set(me, def, orig_me); + METHOD_ENTRY_VISI_SET(me, METHOD_VISI_PUBLIC); + } +} + +static inline rb_method_entry_t * +lookup_method_table(VALUE klass, ID id) +{ + st_data_t body; + struct rb_id_table *m_tbl = RCLASS_M_TBL(klass); + + if (rb_id_table_lookup(m_tbl, id, &body)) { + return (rb_method_entry_t *) body; + } + else { + return 0; } } @@ -488,30 +1270,39 @@ rb_add_refined_method_entry(VALUE refined_class, ID mid) rb_method_entry_t *me = lookup_method_table(refined_class, mid); if (me) { - make_method_entry_refined(refined_class, me); - rb_clear_method_cache_by_class(refined_class); + make_method_entry_refined(refined_class, me); + rb_clear_method_cache(refined_class, mid); } else { - rb_add_method(refined_class, mid, VM_METHOD_TYPE_REFINED, 0, METHOD_VISI_PUBLIC); + rb_add_method(refined_class, mid, VM_METHOD_TYPE_REFINED, 0, METHOD_VISI_PUBLIC); } } static void -check_override_opt_method(VALUE klass, VALUE arg) +check_override_opt_method_i(VALUE klass, VALUE arg) { ID mid = (ID)arg; const rb_method_entry_t *me, *newme; if (vm_redefinition_check_flag(klass)) { - me = lookup_method_table(RCLASS_ORIGIN(klass), mid); - if (me) { - newme = rb_method_entry(klass, mid); - if (newme != me) rb_vm_check_redefinition_opt_method(me, me->owner); - } + me = lookup_method_table(RCLASS_ORIGIN(klass), mid); + if (me) { + newme = rb_method_entry(klass, mid); + if (newme != me) rb_vm_check_redefinition_opt_method(me, me->owner); + } } - rb_class_foreach_subclass(klass, check_override_opt_method, (VALUE)mid); + rb_class_foreach_subclass(klass, check_override_opt_method_i, (VALUE)mid); } +static void +check_override_opt_method(VALUE klass, VALUE mid) +{ + if (rb_vm_check_optimizable_mid(mid)) { + check_override_opt_method_i(klass, mid); + } +} + +static inline rb_method_entry_t* search_method0(VALUE klass, ID id, VALUE *defined_class_ptr, bool skip_refined); /* * klass->method_table[mid] = method_entry(defined_class, visi, def) * @@ -520,89 +1311,110 @@ check_override_opt_method(VALUE klass, VALUE arg) */ static rb_method_entry_t * rb_method_entry_make(VALUE klass, ID mid, VALUE defined_class, rb_method_visibility_t visi, - rb_method_type_t type, rb_method_definition_t *def, ID original_id, void *opts) + rb_method_type_t type, rb_method_definition_t *def, ID original_id, void *opts) { rb_method_entry_t *me; struct rb_id_table *mtbl; st_data_t data; int make_refined = 0; + VALUE orig_klass; if (NIL_P(klass)) { - klass = rb_cObject; + klass = rb_cObject; } - if (!FL_TEST(klass, FL_SINGLETON) && - type != VM_METHOD_TYPE_NOTIMPLEMENTED && - type != VM_METHOD_TYPE_ZSUPER) { - switch (mid) { - case idInitialize: - case idInitialize_copy: - case idInitialize_clone: - case idInitialize_dup: - case idRespond_to_missing: - visi = METHOD_VISI_PRIVATE; - } + orig_klass = klass; + + if (!RCLASS_SINGLETON_P(klass) && + type != VM_METHOD_TYPE_NOTIMPLEMENTED && + type != VM_METHOD_TYPE_ZSUPER) { + switch (mid) { + case idInitialize: + case idInitialize_copy: + case idInitialize_clone: + case idInitialize_dup: + case idRespond_to_missing: + visi = METHOD_VISI_PRIVATE; + } } - rb_class_modify_check(klass); + if (type != VM_METHOD_TYPE_REFINED) { + rb_class_modify_check(klass); + } - if (FL_TEST(klass, RMODULE_IS_REFINEMENT)) { - VALUE refined_class = rb_refinement_module_get_refined_class(klass); - rb_add_refined_method_entry(refined_class, mid); + if (RB_TYPE_P(klass, T_MODULE) && FL_TEST(klass, RMODULE_IS_REFINEMENT)) { + VALUE refined_class = rb_refinement_module_get_refined_class(klass); + bool search_superclass = type == VM_METHOD_TYPE_ZSUPER && !lookup_method_table(refined_class, mid); + rb_add_refined_method_entry(refined_class, mid); + if (search_superclass) { + rb_method_entry_t *me = lookup_method_table(refined_class, mid); + me->def->body.refined.orig_me = search_method0(refined_class, mid, NULL, true); + } } if (type == VM_METHOD_TYPE_REFINED) { - rb_method_entry_t *old_me = lookup_method_table(RCLASS_ORIGIN(klass), mid); - if (old_me) rb_vm_check_redefinition_opt_method(old_me, klass); + rb_method_entry_t *old_me = lookup_method_table(RCLASS_ORIGIN(klass), mid); + if (old_me) rb_vm_check_redefinition_opt_method(old_me, klass); } else { - klass = RCLASS_ORIGIN(klass); + klass = RCLASS_ORIGIN(klass); + if (klass != orig_klass) { + rb_clear_method_cache(orig_klass, mid); + } } - mtbl = RCLASS_M_TBL(klass); + mtbl = RCLASS_WRITABLE_M_TBL(klass); /* check re-definition */ if (rb_id_table_lookup(mtbl, mid, &data)) { - rb_method_entry_t *old_me = (rb_method_entry_t *)data; - rb_method_definition_t *old_def = old_me->def; - - if (rb_method_definition_eq(old_def, def)) return old_me; - rb_vm_check_redefinition_opt_method(old_me, klass); - - if (old_def->type == VM_METHOD_TYPE_REFINED) make_refined = 1; - - if (RTEST(ruby_verbose) && - type != VM_METHOD_TYPE_UNDEF && - (old_def->alias_count == 0) && - !make_refined && - old_def->type != VM_METHOD_TYPE_UNDEF && - old_def->type != VM_METHOD_TYPE_ZSUPER && - old_def->type != VM_METHOD_TYPE_ALIAS) { - const rb_iseq_t *iseq = 0; - - rb_warning("method redefined; discarding old %"PRIsVALUE, rb_id2str(mid)); - switch (old_def->type) { - case VM_METHOD_TYPE_ISEQ: - iseq = def_iseq_ptr(old_def); - break; - case VM_METHOD_TYPE_BMETHOD: + rb_method_entry_t *old_me = (rb_method_entry_t *)data; + rb_method_definition_t *old_def = old_me->def; + + if (rb_method_definition_eq(old_def, def)) return old_me; + rb_vm_check_redefinition_opt_method(old_me, klass); + + if (old_def->type == VM_METHOD_TYPE_REFINED) make_refined = 1; + + if (RTEST(ruby_verbose) && + type != VM_METHOD_TYPE_UNDEF && + (old_def->aliased == false) && + (!old_def->no_redef_warning) && + !make_refined && + old_def->type != VM_METHOD_TYPE_UNDEF && + old_def->type != VM_METHOD_TYPE_ZSUPER && + old_def->type != VM_METHOD_TYPE_ALIAS) { + const rb_iseq_t *iseq = 0; + + switch (old_def->type) { + case VM_METHOD_TYPE_ISEQ: + iseq = def_iseq_ptr(old_def); + break; + case VM_METHOD_TYPE_BMETHOD: iseq = rb_proc_get_iseq(old_def->body.bmethod.proc, 0); - break; - default: - break; - } - if (iseq) { - rb_compile_warning(RSTRING_PTR(rb_iseq_path(iseq)), - FIX2INT(iseq->body->location.first_lineno), - "previous definition of %"PRIsVALUE" was here", - rb_id2str(old_def->original_id)); - } - } + break; + default: + break; + } + if (iseq) { + rb_warning( + "method redefined; discarding old %"PRIsVALUE"\n%s:%d: warning: previous definition of %"PRIsVALUE" was here", + rb_id2str(mid), + RSTRING_PTR(rb_iseq_path(iseq)), + ISEQ_BODY(iseq)->location.first_lineno, + rb_id2str(old_def->original_id) + ); + } + else { + rb_warning("method redefined; discarding old %"PRIsVALUE, rb_id2str(mid)); + } + } } /* create method entry */ me = rb_method_entry_create(mid, defined_class, visi, NULL); - if (def == NULL) def = rb_method_definition_create(type, original_id); + if (def == NULL) { + def = rb_method_definition_create(type, original_id); + } rb_method_definition_set(me, def, opts); - rb_clear_method_cache_by_class(klass); + rb_clear_method_cache(klass, mid); /* check mid */ if (klass == rb_cObject) { @@ -615,59 +1427,177 @@ rb_method_entry_make(VALUE klass, ID mid, VALUE defined_class, rb_method_visibil } } /* check mid */ - if (mid == object_id || mid == id__send__) { - if (type == VM_METHOD_TYPE_ISEQ && search_method(klass, mid, 0)) { - rb_warn("redefining `%s' may cause serious problems", rb_id2name(mid)); - } + if (mid == object_id || mid == id__id__ || mid == id__send__) { + if (type != VM_METHOD_TYPE_CFUNC && search_method(klass, mid, 0)) { + rb_warn("redefining '%s' may cause serious problems", rb_id2name(mid)); + } } if (make_refined) { - make_method_entry_refined(klass, me); + make_method_entry_refined(klass, me); } - rb_id_table_insert(mtbl, mid, (VALUE)me); - RB_OBJ_WRITTEN(klass, Qundef, (VALUE)me); + rb_method_table_insert(klass, mtbl, mid, me); VM_ASSERT(me->def != NULL); /* check optimized method override by a prepended module */ - if (RB_TYPE_P(klass, T_MODULE)) { - check_override_opt_method(klass, (VALUE)mid); + if (RB_TYPE_P(orig_klass, T_MODULE)) { + check_override_opt_method(klass, (VALUE)mid); } return me; } +static st_table * +overloaded_cme_table(void) +{ + VM_ASSERT(GET_VM()->overloaded_cme_table != NULL); + return GET_VM()->overloaded_cme_table; +} + +#if VM_CHECK_MODE > 0 +static int +vm_dump_overloaded_cme_table(st_data_t key, st_data_t val, st_data_t dmy) +{ + fprintf(stderr, "key: "); rp(key); + fprintf(stderr, "val: "); rp(val); + return ST_CONTINUE; +} + +void +rb_vm_dump_overloaded_cme_table(void) +{ + fprintf(stderr, "== rb_vm_dump_overloaded_cme_table\n"); + st_foreach(overloaded_cme_table(), vm_dump_overloaded_cme_table, 0); +} +#endif + +static int +lookup_overloaded_cme_i(st_data_t *key, st_data_t *value, st_data_t data, int existing) +{ + if (existing) { + const rb_callable_method_entry_t *cme = (const rb_callable_method_entry_t *)*key; + const rb_callable_method_entry_t *monly_cme = (const rb_callable_method_entry_t *)*value; + const rb_callable_method_entry_t **ptr = (const rb_callable_method_entry_t **)data; + + if (rb_objspace_garbage_object_p((VALUE)cme) || + rb_objspace_garbage_object_p((VALUE)monly_cme)) { + *ptr = NULL; + return ST_DELETE; + } + else { + *ptr = monly_cme; + } + } + + return ST_STOP; +} + +static const rb_callable_method_entry_t * +lookup_overloaded_cme(const rb_callable_method_entry_t *cme) +{ + ASSERT_vm_locking(); + + const rb_callable_method_entry_t *monly_cme = NULL; + st_update(overloaded_cme_table(), (st_data_t)cme, lookup_overloaded_cme_i, (st_data_t)&monly_cme); + return monly_cme; +} + +#if VM_CHECK_MODE > 0 +const rb_callable_method_entry_t * +rb_vm_lookup_overloaded_cme(const rb_callable_method_entry_t *cme) +{ + return lookup_overloaded_cme(cme); +} +#endif + +static void +delete_overloaded_cme(const rb_callable_method_entry_t *cme) +{ + st_data_t cme_data = (st_data_t)cme; + ASSERT_vm_locking(); + st_delete(overloaded_cme_table(), &cme_data, NULL); +} + +static const rb_callable_method_entry_t * +get_overloaded_cme(const rb_callable_method_entry_t *cme) +{ + const rb_callable_method_entry_t *monly_cme = lookup_overloaded_cme(cme); + + if (monly_cme && !METHOD_ENTRY_INVALIDATED(monly_cme)) { + return monly_cme; + } + else { + // create + rb_method_definition_t *def = rb_method_definition_create(VM_METHOD_TYPE_ISEQ, cme->def->original_id); + rb_method_entry_t *me = rb_method_entry_alloc(cme->called_id, + cme->owner, + cme->defined_class, + def, + false); + + RB_OBJ_WRITE(me, &def->body.iseq.cref, cme->def->body.iseq.cref); + RB_OBJ_WRITE(me, &def->body.iseq.iseqptr, ISEQ_BODY(cme->def->body.iseq.iseqptr)->mandatory_only_iseq); + + ASSERT_vm_locking(); + st_insert(overloaded_cme_table(), (st_data_t)cme, (st_data_t)me); + + METHOD_ENTRY_VISI_SET(me, METHOD_ENTRY_VISI(cme)); + return (rb_callable_method_entry_t *)me; + } +} + +const rb_callable_method_entry_t * +rb_check_overloaded_cme(const rb_callable_method_entry_t *cme, const struct rb_callinfo * const ci) +{ + if (UNLIKELY(cme->def->iseq_overload) && + (vm_ci_flag(ci) & (VM_CALL_ARGS_SIMPLE)) && + (!(vm_ci_flag(ci) & VM_CALL_FORWARDING)) && + (int)vm_ci_argc(ci) == ISEQ_BODY(method_entry_iseqptr(cme))->param.lead_num) { + VM_ASSERT(cme->def->type == VM_METHOD_TYPE_ISEQ, "type: %d", cme->def->type); // iseq_overload is marked only on ISEQ methods + + cme = get_overloaded_cme(cme); + + VM_ASSERT(cme != NULL); + METHOD_ENTRY_CACHED_SET((struct rb_callable_method_entry_struct *)cme); + } + + return cme; +} + #define CALL_METHOD_HOOK(klass, hook, mid) do { \ - const VALUE arg = ID2SYM(mid); \ - VALUE recv_class = (klass); \ - ID hook_id = (hook); \ - if (FL_TEST((klass), FL_SINGLETON)) { \ - recv_class = rb_ivar_get((klass), attached); \ - hook_id = singleton_##hook; \ - } \ - rb_funcallv(recv_class, hook_id, 1, &arg); \ + const VALUE arg = ID2SYM(mid); \ + VALUE recv_class = (klass); \ + ID hook_id = (hook); \ + if (RCLASS_SINGLETON_P((klass))) { \ + recv_class = RCLASS_ATTACHED_OBJECT((klass)); \ + hook_id = singleton_##hook; \ + } \ + rb_funcallv(recv_class, hook_id, 1, &arg); \ } while (0) static void method_added(VALUE klass, ID mid) { if (ruby_running) { - CALL_METHOD_HOOK(klass, added, mid); + CALL_METHOD_HOOK(klass, added, mid); } } void rb_add_method(VALUE klass, ID mid, rb_method_type_t type, void *opts, rb_method_visibility_t visi) { - rb_method_entry_make(klass, mid, klass, visi, type, NULL, mid, opts); + RB_VM_LOCKING() { + rb_method_entry_make(klass, mid, klass, visi, type, NULL, mid, opts); + } if (type != VM_METHOD_TYPE_UNDEF && type != VM_METHOD_TYPE_REFINED) { - method_added(klass, mid); + method_added(klass, mid); } } -MJIT_FUNC_EXPORTED void +void rb_add_method_iseq(VALUE klass, ID mid, const rb_iseq_t *iseq, rb_cref_t *cref, rb_method_visibility_t visi) { struct { /* should be same fields with rb_method_iseq_struct */ @@ -677,15 +1607,24 @@ rb_add_method_iseq(VALUE klass, ID mid, const rb_iseq_t *iseq, rb_cref_t *cref, iseq_body.iseqptr = iseq; iseq_body.cref = cref; + rb_add_method(klass, mid, VM_METHOD_TYPE_ISEQ, &iseq_body, visi); } static rb_method_entry_t * method_entry_set(VALUE klass, ID mid, const rb_method_entry_t *me, - rb_method_visibility_t visi, VALUE defined_class) -{ - rb_method_entry_t *newme = rb_method_entry_make(klass, mid, defined_class, visi, - me->def->type, method_definition_addref(me->def), 0, NULL); + rb_method_visibility_t visi, VALUE defined_class) +{ + rb_method_entry_t *newme; + RB_VM_LOCKING() { + newme = rb_method_entry_make(klass, mid, defined_class, visi, + me->def->type, me->def, 0, NULL); + if (newme == me) { + me->def->no_redef_warning = TRUE; + METHOD_ENTRY_FLAGS_SET(newme, visi, FALSE); + } + } + method_added(klass, mid); return newme; } @@ -702,7 +1641,10 @@ void rb_define_alloc_func(VALUE klass, VALUE (*func)(VALUE)) { Check_Type(klass, T_CLASS); - RCLASS_EXT(klass)->allocator = func; + if (RCLASS_SINGLETON_P(klass)) { + rb_raise(rb_eTypeError, "can't define an allocator for a singleton class"); + } + RCLASS_SET_ALLOCATOR(klass, func); } void @@ -714,162 +1656,293 @@ rb_undef_alloc_func(VALUE klass) rb_alloc_func_t rb_get_alloc_func(VALUE klass) { - Check_Type(klass, T_CLASS); + RBIMPL_ASSERT_TYPE(klass, T_CLASS); - for (; klass; klass = RCLASS_SUPER(klass)) { - rb_alloc_func_t allocator = RCLASS_EXT(klass)->allocator; - if (allocator == UNDEF_ALLOC_FUNC) break; - if (allocator) return allocator; + rb_alloc_func_t allocator = RCLASS_ALLOCATOR(klass); + if (allocator == UNDEF_ALLOC_FUNC) return 0; + if (allocator) return allocator; + + VALUE *superclasses = RCLASS_SUPERCLASSES(klass); + size_t depth = RCLASS_SUPERCLASS_DEPTH(klass); + + for (size_t i = depth; i > 0; i--) { + klass = superclasses[i - 1]; + RBIMPL_ASSERT_TYPE(klass, T_CLASS); + + allocator = RCLASS_ALLOCATOR(klass); + if (allocator == UNDEF_ALLOC_FUNC) break; + if (allocator) return allocator; } return 0; } +const rb_method_entry_t * +rb_method_entry_at(VALUE klass, ID id) +{ + return lookup_method_table(klass, id); +} + static inline rb_method_entry_t* -search_method(VALUE klass, ID id, VALUE *defined_class_ptr) +search_method0(VALUE klass, ID id, VALUE *defined_class_ptr, bool skip_refined) { - rb_method_entry_t *me; + rb_method_entry_t *me = NULL; + + RB_DEBUG_COUNTER_INC(mc_search); for (; klass; klass = RCLASS_SUPER(klass)) { - RB_DEBUG_COUNTER_INC(mc_search_super); - if ((me = lookup_method_table(klass, id)) != 0) break; + RB_DEBUG_COUNTER_INC(mc_search_super); + if ((me = lookup_method_table(klass, id)) != 0) { + if (!skip_refined || me->def->type != VM_METHOD_TYPE_REFINED || + me->def->body.refined.orig_me) { + break; + } + } } - if (defined_class_ptr) - *defined_class_ptr = klass; + if (defined_class_ptr) *defined_class_ptr = klass; + + if (me == NULL) RB_DEBUG_COUNTER_INC(mc_search_notfound); + + VM_ASSERT(me == NULL || !METHOD_ENTRY_INVALIDATED(me), + "invalid me, mid:%s, klass:%s(%s)", + rb_id2name(id), + RTEST(rb_mod_name(klass)) ? RSTRING_PTR(rb_mod_name(klass)) : "anonymous", + rb_obj_info(klass)); return me; } -const rb_method_entry_t * -rb_method_entry_at(VALUE klass, ID id) +static inline rb_method_entry_t* +search_method(VALUE klass, ID id, VALUE *defined_class_ptr) { - return lookup_method_table(klass, id); + return search_method0(klass, id, defined_class_ptr, false); } -/* - * search method entry without the method cache. - * - * if you need method entry with method cache (normal case), use - * rb_method_entry() simply. - */ static rb_method_entry_t * -method_entry_get_without_cache(VALUE klass, ID id, - VALUE *defined_class_ptr) +search_method_protect(VALUE klass, ID id, VALUE *defined_class_ptr) +{ + rb_method_entry_t *me = search_method(klass, id, defined_class_ptr); + + if (!UNDEFINED_METHOD_ENTRY_P(me)) { + return me; + } + else { + return NULL; + } +} + +const rb_method_entry_t * +rb_method_entry(VALUE klass, ID id) +{ + return search_method_protect(klass, id, NULL); +} + +static inline const rb_callable_method_entry_t * +prepare_callable_method_entry(VALUE defined_class, ID id, const rb_method_entry_t * const me, int create) +{ + struct rb_id_table *mtbl; + const rb_callable_method_entry_t *cme; + VALUE cme_data; + int cme_found = 0; + + if (me) { + if (me->defined_class == 0) { + RB_DEBUG_COUNTER_INC(mc_cme_complement); + VM_ASSERT_TYPE2(defined_class, T_ICLASS, T_MODULE); + + mtbl = RCLASS_WRITABLE_CALLABLE_M_TBL(defined_class); + if (mtbl && rb_id_table_lookup(mtbl, id, &cme_data)) { + cme = (rb_callable_method_entry_t *)cme_data; + cme_found = 1; + } + if (cme_found) { + RB_DEBUG_COUNTER_INC(mc_cme_complement_hit); + VM_ASSERT(callable_method_entry_p(cme)); + VM_ASSERT(!METHOD_ENTRY_INVALIDATED(cme)); + } + else if (create) { + if (!mtbl) { + mtbl = rb_id_table_create(0); + RCLASS_WRITE_CALLABLE_M_TBL(defined_class, mtbl); + } + cme = rb_method_entry_complement_defined_class(me, me->called_id, defined_class); + rb_id_table_insert(mtbl, id, (VALUE)cme); + RB_OBJ_WRITTEN(defined_class, Qundef, (VALUE)cme); + VM_ASSERT(callable_method_entry_p(cme)); + } + else { + return NULL; + } + } + else { + cme = (const rb_callable_method_entry_t *)me; + VM_ASSERT(callable_method_entry_p(cme)); + VM_ASSERT(!METHOD_ENTRY_INVALIDATED(cme)); + } + return cme; + } + else { + return NULL; + } +} + +static const rb_callable_method_entry_t * +complemented_callable_method_entry(VALUE klass, ID id) { VALUE defined_class; rb_method_entry_t *me = search_method(klass, id, &defined_class); + return prepare_callable_method_entry(defined_class, id, me, FALSE); +} - if (ruby_running) { - if (OPT_GLOBAL_METHOD_CACHE) { - struct cache_entry *ent; - ent = GLOBAL_METHOD_CACHE(klass, id); - ent->class_serial = RCLASS_SERIAL(klass); - ent->method_state = GET_GLOBAL_METHOD_STATE(); - ent->defined_class = defined_class; - ent->mid = id; - - if (UNDEFINED_METHOD_ENTRY_P(me)) { - me = ent->me = NULL; - } - else { - ent->me = me; - } - } - else if (UNDEFINED_METHOD_ENTRY_P(me)) { - me = NULL; - } - } - else if (UNDEFINED_METHOD_ENTRY_P(me)) { - me = NULL; - } - - if (defined_class_ptr) - *defined_class_ptr = defined_class; - return me; +static const rb_callable_method_entry_t * +cached_callable_method_entry(VALUE klass, ID mid) +{ + ASSERT_vm_locking(); + + VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass); + VALUE ccs_data; + + if (cc_tbl && rb_managed_id_table_lookup(cc_tbl, mid, &ccs_data)) { + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data; + VM_ASSERT(vm_ccs_p(ccs)); + + if (LIKELY(!METHOD_ENTRY_INVALIDATED(ccs->cme))) { + VM_ASSERT(ccs->cme->called_id == mid); + RB_DEBUG_COUNTER_INC(ccs_found); + return ccs->cme; + } + else { + rb_vm_barrier(); + + rb_managed_id_table_delete(cc_tbl, mid); + rb_vm_ccs_invalidate_and_free(ccs); + } + } + + RB_DEBUG_COUNTER_INC(ccs_not_found); + return NULL; } -#if VM_DEBUG_VERIFY_METHOD_CACHE static void -verify_method_cache(VALUE klass, ID id, VALUE defined_class, rb_method_entry_t *me) +cache_callable_method_entry(VALUE klass, ID mid, const rb_callable_method_entry_t *cme) { - VALUE actual_defined_class; - rb_method_entry_t *actual_me = - method_entry_get_without_cache(klass, id, &actual_defined_class); + ASSERT_vm_locking(); + VM_ASSERT(cme != NULL); - if (me != actual_me || defined_class != actual_defined_class) { - rb_bug("method cache verification failed"); + VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass); + VALUE ccs_data; + + if (!cc_tbl) { + cc_tbl = rb_vm_cc_table_create(2); + RCLASS_WRITE_CC_TBL(klass, cc_tbl); } -} -#endif -static rb_method_entry_t * -method_entry_get(VALUE klass, ID id, VALUE *defined_class_ptr) -{ -#if OPT_GLOBAL_METHOD_CACHE - struct cache_entry *ent; - ent = GLOBAL_METHOD_CACHE(klass, id); - if (ent->method_state == GET_GLOBAL_METHOD_STATE() && - ent->class_serial == RCLASS_SERIAL(klass) && - ent->mid == id) { -#if VM_DEBUG_VERIFY_METHOD_CACHE - verify_method_cache(klass, id, ent->defined_class, ent->me); + if (rb_managed_id_table_lookup(cc_tbl, mid, &ccs_data)) { +#if VM_CHECK_MODE > 0 + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data; + VM_ASSERT(ccs->cme == cme); #endif - if (defined_class_ptr) *defined_class_ptr = ent->defined_class; - RB_DEBUG_COUNTER_INC(mc_global_hit); - return ent->me; } -#endif - - RB_DEBUG_COUNTER_INC(mc_global_miss); - return method_entry_get_without_cache(klass, id, defined_class_ptr); + else { + if (rb_multi_ractor_p()) { + VALUE new_cc_tbl = rb_vm_cc_table_dup(cc_tbl); + vm_ccs_create(klass, new_cc_tbl, mid, cme); + RB_OBJ_ATOMIC_WRITE(klass, &RCLASSEXT_CC_TBL(RCLASS_EXT_WRITABLE(klass)), new_cc_tbl); + } + else { + vm_ccs_create(klass, cc_tbl, mid, cme); + } + } } -MJIT_FUNC_EXPORTED const rb_method_entry_t * -rb_method_entry(VALUE klass, ID id) +static const rb_callable_method_entry_t * +negative_cme(ID mid) { - return method_entry_get(klass, id, NULL); + rb_vm_t *vm = GET_VM(); + const rb_callable_method_entry_t *cme; + VALUE cme_data; + + if (rb_id_table_lookup(vm->negative_cme_table, mid, &cme_data)) { + cme = (rb_callable_method_entry_t *)cme_data; + } + else { + cme = (rb_callable_method_entry_t *)rb_method_entry_alloc(mid, Qnil, Qnil, NULL, false); + rb_id_table_insert(vm->negative_cme_table, mid, (VALUE)cme); + } + + VM_ASSERT(cme != NULL); + return cme; } static const rb_callable_method_entry_t * -prepare_callable_method_entry(VALUE defined_class, ID id, const rb_method_entry_t *me) +callable_method_entry_or_negative(VALUE klass, ID mid, VALUE *defined_class_ptr) { - struct rb_id_table *mtbl; const rb_callable_method_entry_t *cme; - if (me && me->defined_class == 0) { - RB_DEBUG_COUNTER_INC(mc_cme_complement); - VM_ASSERT(RB_TYPE_P(defined_class, T_ICLASS) || RB_TYPE_P(defined_class, T_MODULE)); - VM_ASSERT(me->defined_class == 0); - - mtbl = RCLASS_CALLABLE_M_TBL(defined_class); - - if (mtbl && rb_id_table_lookup(mtbl, id, (VALUE *)&me)) { - RB_DEBUG_COUNTER_INC(mc_cme_complement_hit); - cme = (rb_callable_method_entry_t *)me; - VM_ASSERT(callable_method_entry_p(cme)); - } - else { - if (!mtbl) { - mtbl = RCLASS_EXT(defined_class)->callable_m_tbl = rb_id_table_create(0); - } - cme = rb_method_entry_complement_defined_class(me, me->called_id, defined_class); - rb_id_table_insert(mtbl, id, (VALUE)cme); - VM_ASSERT(callable_method_entry_p(cme)); - } + VM_ASSERT_TYPE2(klass, T_CLASS, T_ICLASS); + + /* Fast path: lock-free read from cache */ + VALUE cc_tbl = RUBY_ATOMIC_VALUE_LOAD(RCLASS_WRITABLE_CC_TBL(klass)); + if (cc_tbl) { + VALUE ccs_data; + if (rb_managed_id_table_lookup(cc_tbl, mid, &ccs_data)) { + struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data; + VM_ASSERT(vm_ccs_p(ccs)); + + if (LIKELY(!METHOD_ENTRY_INVALIDATED(ccs->cme))) { + VM_ASSERT(ccs->cme->called_id == mid); + if (defined_class_ptr != NULL) *defined_class_ptr = ccs->cme->defined_class; + RB_DEBUG_COUNTER_INC(ccs_found); + return ccs->cme; + } + } } - else { - cme = (const rb_callable_method_entry_t *)me; - VM_ASSERT(callable_method_entry_p(cme)); + + /* Slow path: need to lock and potentially populate cache */ + RB_VM_LOCKING() { + cme = cached_callable_method_entry(klass, mid); + + if (cme) { + if (defined_class_ptr != NULL) *defined_class_ptr = cme->defined_class; + } + else { + VALUE defined_class; + rb_method_entry_t *me = search_method(klass, mid, &defined_class); + if (defined_class_ptr) *defined_class_ptr = defined_class; + + if (me != NULL) { + cme = prepare_callable_method_entry(defined_class, mid, me, TRUE); + } + else { + cme = negative_cme(mid); + } + + cache_callable_method_entry(klass, mid, cme); + } } return cme; } -MJIT_FUNC_EXPORTED const rb_callable_method_entry_t * -rb_callable_method_entry(VALUE klass, ID id) +// This is exposed for YJIT so that we can make assumptions that methods are +// not defined. +const rb_callable_method_entry_t * +rb_callable_method_entry_or_negative(VALUE klass, ID mid) { - VALUE defined_class; - rb_method_entry_t *me = method_entry_get(klass, id, &defined_class); - return prepare_callable_method_entry(defined_class, id, me); + return callable_method_entry_or_negative(klass, mid, NULL); +} + +static const rb_callable_method_entry_t * +callable_method_entry(VALUE klass, ID mid, VALUE *defined_class_ptr) +{ + const rb_callable_method_entry_t *cme; + cme = callable_method_entry_or_negative(klass, mid, defined_class_ptr); + return !UNDEFINED_METHOD_ENTRY_P(cme) ? cme : NULL; +} + +const rb_callable_method_entry_t * +rb_callable_method_entry(VALUE klass, ID mid) +{ + return callable_method_entry(klass, mid, NULL); } static const rb_method_entry_t *resolve_refined_method(VALUE refinements, const rb_method_entry_t *me, VALUE *defined_class_ptr); @@ -877,21 +1950,21 @@ static const rb_method_entry_t *resolve_refined_method(VALUE refinements, const static const rb_method_entry_t * method_entry_resolve_refinement(VALUE klass, ID id, int with_refinement, VALUE *defined_class_ptr) { - const rb_method_entry_t *me = method_entry_get(klass, id, defined_class_ptr); + const rb_method_entry_t *me = search_method_protect(klass, id, defined_class_ptr); if (me) { - if (me->def->type == VM_METHOD_TYPE_REFINED) { - if (with_refinement) { - const rb_cref_t *cref = rb_vm_cref(); - VALUE refinements = cref ? CREF_REFINEMENTS(cref) : Qnil; - me = resolve_refined_method(refinements, me, defined_class_ptr); - } - else { - me = resolve_refined_method(Qnil, me, defined_class_ptr); - } - - if (UNDEFINED_METHOD_ENTRY_P(me)) me = NULL; - } + if (me->def->type == VM_METHOD_TYPE_REFINED) { + if (with_refinement) { + const rb_cref_t *cref = rb_vm_cref(); + VALUE refinements = cref ? CREF_REFINEMENTS(cref) : Qnil; + me = resolve_refined_method(refinements, me, defined_class_ptr); + } + else { + me = resolve_refined_method(Qnil, me, defined_class_ptr); + } + + if (UNDEFINED_METHOD_ENTRY_P(me)) me = NULL; + } } return me; @@ -903,12 +1976,37 @@ rb_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class_ptr) return method_entry_resolve_refinement(klass, id, TRUE, defined_class_ptr); } -MJIT_FUNC_EXPORTED const rb_callable_method_entry_t * +static const rb_callable_method_entry_t * +callable_method_entry_refinements0(VALUE klass, ID id, VALUE *defined_class_ptr, bool with_refinements, + const rb_callable_method_entry_t *cme) +{ + if (cme == NULL || LIKELY(cme->def->type != VM_METHOD_TYPE_REFINED)) { + return cme; + } + else { + VALUE defined_class, *dcp = defined_class_ptr ? defined_class_ptr : &defined_class; + const rb_method_entry_t *me = method_entry_resolve_refinement(klass, id, with_refinements, dcp); + return prepare_callable_method_entry(*dcp, id, me, TRUE); + } +} + +static const rb_callable_method_entry_t * +callable_method_entry_refinements(VALUE klass, ID id, VALUE *defined_class_ptr, bool with_refinements) +{ + const rb_callable_method_entry_t *cme = callable_method_entry(klass, id, defined_class_ptr); + return callable_method_entry_refinements0(klass, id, defined_class_ptr, with_refinements, cme); +} + +const rb_callable_method_entry_t * rb_callable_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class_ptr) { - VALUE defined_class, *dcp = defined_class_ptr ? defined_class_ptr : &defined_class; - const rb_method_entry_t *me = method_entry_resolve_refinement(klass, id, TRUE, dcp); - return prepare_callable_method_entry(*dcp, id, me); + return callable_method_entry_refinements(klass, id, defined_class_ptr, true); +} + +static const rb_callable_method_entry_t * +callable_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class_ptr) +{ + return callable_method_entry_refinements(klass, id, defined_class_ptr, false); } const rb_method_entry_t * @@ -917,34 +2015,39 @@ rb_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class_ptr return method_entry_resolve_refinement(klass, id, FALSE, defined_class_ptr); } -MJIT_FUNC_EXPORTED const rb_callable_method_entry_t * +const rb_callable_method_entry_t * rb_callable_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class_ptr) { VALUE defined_class, *dcp = defined_class_ptr ? defined_class_ptr : &defined_class; const rb_method_entry_t *me = method_entry_resolve_refinement(klass, id, FALSE, dcp); - return prepare_callable_method_entry(*dcp, id, me); + return prepare_callable_method_entry(*dcp, id, me, TRUE); } static const rb_method_entry_t * resolve_refined_method(VALUE refinements, const rb_method_entry_t *me, VALUE *defined_class_ptr) { while (me && me->def->type == VM_METHOD_TYPE_REFINED) { - VALUE refinement; + VALUE refinement; const rb_method_entry_t *tmp_me; VALUE super; - refinement = find_refinement(refinements, me->owner); + refinement = find_refinement(refinements, me->owner); if (!NIL_P(refinement)) { - tmp_me = method_entry_get(refinement, me->called_id, defined_class_ptr); + tmp_me = search_method_protect(refinement, me->called_id, defined_class_ptr); - if (tmp_me && tmp_me->def->type != VM_METHOD_TYPE_REFINED) { - return tmp_me; - } - } + if (tmp_me && tmp_me->def->type != VM_METHOD_TYPE_REFINED) { + return tmp_me; + } + } tmp_me = me->def->body.refined.orig_me; if (tmp_me) { - if (defined_class_ptr) *defined_class_ptr = tmp_me->defined_class; + if (!tmp_me->defined_class) { + VM_ASSERT_TYPE(tmp_me->owner, T_MODULE); + } + else if (defined_class_ptr) { + *defined_class_ptr = tmp_me->defined_class; + } return tmp_me; } @@ -953,7 +2056,7 @@ resolve_refined_method(VALUE refinements, const rb_method_entry_t *me, VALUE *de return 0; } - me = method_entry_get(super, me->called_id, defined_class_ptr); + me = search_method_protect(super, me->called_id, defined_class_ptr); } return me; } @@ -971,10 +2074,10 @@ rb_resolve_refined_method_callable(VALUE refinements, const rb_callable_method_e const rb_method_entry_t *resolved_me = resolve_refined_method(refinements, (const rb_method_entry_t *)me, &defined_class); if (resolved_me && resolved_me->defined_class == 0) { - return rb_method_entry_complement_defined_class(resolved_me, me->called_id, defined_class); + return rb_method_entry_complement_defined_class(resolved_me, me->called_id, defined_class); } else { - return (const rb_callable_method_entry_t *)resolved_me; + return (const rb_callable_method_entry_t *)resolved_me; } } @@ -985,27 +2088,30 @@ remove_method(VALUE klass, ID mid) rb_method_entry_t *me = 0; VALUE self = klass; - klass = RCLASS_ORIGIN(klass); rb_class_modify_check(klass); - if (mid == object_id || mid == id__send__ || mid == idInitialize) { - rb_warn("removing `%s' may cause serious problems", rb_id2name(mid)); + klass = RCLASS_ORIGIN(klass); + if (mid == object_id || mid == id__id__ || mid == id__send__ || mid == idInitialize) { + rb_warn("removing '%s' may cause serious problems", rb_id2name(mid)); } if (!rb_id_table_lookup(RCLASS_M_TBL(klass), mid, &data) || - !(me = (rb_method_entry_t *)data) || - (!me->def || me->def->type == VM_METHOD_TYPE_UNDEF) || + !(me = (rb_method_entry_t *)data) || + (!me->def || me->def->type == VM_METHOD_TYPE_UNDEF) || UNDEFINED_REFINED_METHOD_P(me->def)) { - rb_name_err_raise("method `%1$s' not defined in %2$s", - klass, ID2SYM(mid)); + rb_name_err_raise("method '%1$s' not defined in %2$s", + klass, ID2SYM(mid)); } - rb_id_table_delete(RCLASS_M_TBL(klass), mid); + if (klass != self) { + rb_clear_method_cache(self, mid); + } + rb_clear_method_cache(klass, mid); + rb_id_table_delete(RCLASS_WRITABLE_M_TBL(klass), mid); rb_vm_check_redefinition_opt_method(me, klass); - rb_clear_method_cache_by_class(klass); if (me->def->type == VM_METHOD_TYPE_REFINED) { - rb_add_refined_method_entry(klass, mid); + rb_add_refined_method_entry(klass, mid); } CALL_METHOD_HOOK(self, removed, mid); @@ -1039,13 +2145,13 @@ rb_mod_remove_method(int argc, VALUE *argv, VALUE mod) int i; for (i = 0; i < argc; i++) { - VALUE v = argv[i]; - ID id = rb_check_id(&v); - if (!id) { - rb_name_err_raise("method `%1$s' not defined in %2$s", - mod, v); - } - remove_method(mod, id); + VALUE v = argv[i]; + ID id = rb_check_id(&v); + if (!id) { + rb_name_err_raise("method '%1$s' not defined in %2$s", + mod, v); + } + remove_method(mod, id); } return mod; } @@ -1057,64 +2163,84 @@ rb_export_method(VALUE klass, ID name, rb_method_visibility_t visi) VALUE defined_class; VALUE origin_class = RCLASS_ORIGIN(klass); - me = search_method(origin_class, name, &defined_class); + me = search_method0(origin_class, name, &defined_class, true); + if (!me && RB_TYPE_P(klass, T_MODULE)) { - me = search_method(rb_cObject, name, &defined_class); + me = search_method(rb_cObject, name, &defined_class); } if (UNDEFINED_METHOD_ENTRY_P(me) || - UNDEFINED_REFINED_METHOD_P(me->def)) { - rb_print_undef(klass, name, METHOD_VISI_UNDEF); + UNDEFINED_REFINED_METHOD_P(me->def)) { + rb_print_undef(klass, name, METHOD_VISI_UNDEF); } if (METHOD_ENTRY_VISI(me) != visi) { - rb_vm_check_redefinition_opt_method(me, klass); - - if (klass == defined_class || origin_class == defined_class) { - METHOD_ENTRY_VISI_SET(me, visi); - - if (me->def->type == VM_METHOD_TYPE_REFINED && me->def->body.refined.orig_me) { - METHOD_ENTRY_VISI_SET((rb_method_entry_t *)me->def->body.refined.orig_me, visi); - } - rb_clear_method_cache_by_class(klass); - } - else { - rb_add_method(klass, name, VM_METHOD_TYPE_ZSUPER, 0, visi); - } + rb_vm_check_redefinition_opt_method(me, klass); + + if (klass == defined_class || origin_class == defined_class) { + if (me->def->type == VM_METHOD_TYPE_REFINED) { + // Refinement method entries should always be public because the refinement + // search is always performed. + if (me->def->body.refined.orig_me) { + METHOD_ENTRY_VISI_SET((rb_method_entry_t *)me->def->body.refined.orig_me, visi); + } + } + else { + METHOD_ENTRY_VISI_SET(me, visi); + } + rb_clear_method_cache(klass, name); + } + else { + rb_add_method(klass, name, VM_METHOD_TYPE_ZSUPER, 0, visi); + } } } #define BOUND_PRIVATE 0x01 #define BOUND_RESPONDS 0x02 -int -rb_method_boundp(VALUE klass, ID id, int ex) +static int +method_boundp(VALUE klass, ID id, int ex) { - const rb_method_entry_t *me; + const rb_callable_method_entry_t *cme; + + VM_ASSERT_TYPE2(klass, T_CLASS, T_ICLASS); if (ex & BOUND_RESPONDS) { - me = method_entry_resolve_refinement(klass, id, TRUE, NULL); + cme = rb_callable_method_entry_with_refinements(klass, id, NULL); } else { - me = rb_method_entry_without_refinements(klass, id, NULL); - } - - if (me != 0) { - if ((ex & ~BOUND_RESPONDS) && - ((METHOD_ENTRY_VISI(me) == METHOD_VISI_PRIVATE) || - ((ex & BOUND_RESPONDS) && (METHOD_ENTRY_VISI(me) == METHOD_VISI_PROTECTED)))) { - return 0; - } + cme = callable_method_entry_without_refinements(klass, id, NULL); + } + + if (cme != NULL) { + if (ex & ~BOUND_RESPONDS) { + switch (METHOD_ENTRY_VISI(cme)) { + case METHOD_VISI_PRIVATE: + return 0; + case METHOD_VISI_PROTECTED: + if (ex & BOUND_RESPONDS) return 0; + default: + break; + } + } - if (me->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) { - if (ex & BOUND_RESPONDS) return 2; - return 0; - } - return 1; + if (cme->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) { + if (ex & BOUND_RESPONDS) return 2; + return 0; + } + return 1; } return 0; } +// deprecated +int +rb_method_boundp(VALUE klass, ID id, int ex) +{ + return method_boundp(klass, id, ex); +} + static void vm_cref_set_visibility(rb_method_visibility_t method_visi, int module_func) { @@ -1130,44 +2256,58 @@ rb_scope_visibility_set(rb_method_visibility_t visi) } static void +scope_visibility_check(void) +{ + /* Check for public/protected/private/module_function called inside a method */ + rb_control_frame_t *cfp = GET_EC()->cfp+1; + if (cfp && cfp->iseq && ISEQ_BODY(cfp->iseq)->type == ISEQ_TYPE_METHOD) { + rb_warn("calling %s without arguments inside a method may not have the intended effect", + rb_id2name(rb_frame_this_func())); + } +} + +static void rb_scope_module_func_set(void) { + scope_visibility_check(); vm_cref_set_visibility(METHOD_VISI_PRIVATE, TRUE); } +const rb_cref_t *rb_vm_cref_in_context(VALUE self, VALUE cbase); void rb_attr(VALUE klass, ID id, int read, int write, int ex) { ID attriv; rb_method_visibility_t visi; const rb_execution_context_t *ec = GET_EC(); + const rb_cref_t *cref = rb_vm_cref_in_context(klass, klass); - if (!ex) { - visi = METHOD_VISI_PUBLIC; + if (!ex || !cref) { + visi = METHOD_VISI_PUBLIC; } else { switch (vm_scope_visibility_get(ec)) { - case METHOD_VISI_PRIVATE: + case METHOD_VISI_PRIVATE: if (vm_scope_module_func_check(ec)) { - rb_warning("attribute accessor as module_function"); - } - visi = METHOD_VISI_PRIVATE; - break; - case METHOD_VISI_PROTECTED: - visi = METHOD_VISI_PROTECTED; - break; - default: - visi = METHOD_VISI_PUBLIC; - break; - } + rb_warning("attribute accessor as module_function"); + } + visi = METHOD_VISI_PRIVATE; + break; + case METHOD_VISI_PROTECTED: + visi = METHOD_VISI_PROTECTED; + break; + default: + visi = METHOD_VISI_PUBLIC; + break; + } } attriv = rb_intern_str(rb_sprintf("@%"PRIsVALUE, rb_id2str(id))); if (read) { - rb_add_method(klass, id, VM_METHOD_TYPE_IVAR, (void *)attriv, visi); + rb_add_method(klass, id, VM_METHOD_TYPE_IVAR, (void *)attriv, visi); } if (write) { - rb_add_method(klass, rb_id_attrset(id), VM_METHOD_TYPE_ATTRSET, (void *)attriv, visi); + rb_add_method(klass, rb_id_attrset(id), VM_METHOD_TYPE_ATTRSET, (void *)attriv, visi); } } @@ -1177,21 +2317,21 @@ rb_undef(VALUE klass, ID id) const rb_method_entry_t *me; if (NIL_P(klass)) { - rb_raise(rb_eTypeError, "no class to undef method"); + rb_raise(rb_eTypeError, "no class to undef method"); } rb_class_modify_check(klass); - if (id == object_id || id == id__send__ || id == idInitialize) { - rb_warn("undefining `%s' may cause serious problems", rb_id2name(id)); + if (id == object_id || id == id__id__ || id == id__send__ || id == idInitialize) { + rb_warn("undefining '%s' may cause serious problems", rb_id2name(id)); } me = search_method(klass, id, 0); if (me && me->def->type == VM_METHOD_TYPE_REFINED) { - me = rb_resolve_refined_method(Qnil, me); + me = rb_resolve_refined_method(Qnil, me); } if (UNDEFINED_METHOD_ENTRY_P(me) || - UNDEFINED_REFINED_METHOD_P(me->def)) { - rb_method_name_error(klass, rb_id2str(id)); + UNDEFINED_REFINED_METHOD_P(me->def)) { + rb_method_name_error(klass, rb_id2str(id)); } rb_add_method(klass, id, VM_METHOD_TYPE_UNDEF, 0, METHOD_VISI_PUBLIC); @@ -1241,7 +2381,7 @@ rb_undef(VALUE klass, ID id) * * In child * In parent - * prog.rb:23: undefined method `hello' for #<Child:0x401b3bb4> (NoMethodError) + * prog.rb:23: undefined method 'hello' for #<Child:0x401b3bb4> (NoMethodError) */ static VALUE @@ -1249,12 +2389,12 @@ rb_mod_undef_method(int argc, VALUE *argv, VALUE mod) { int i; for (i = 0; i < argc; i++) { - VALUE v = argv[i]; - ID id = rb_check_id(&v); - if (!id) { - rb_method_name_error(mod, v); - } - rb_undef(mod, id); + VALUE v = argv[i]; + ID id = rb_check_id(&v); + if (!id) { + rb_method_name_error(mod, v); + } + rb_undef(mod, id); } return mod; } @@ -1272,20 +2412,20 @@ check_definition_visibility(VALUE mod, int argc, VALUE *argv) if (!id) return METHOD_VISI_UNDEF; if (argc == 1) { - inc_super = 1; + inc_super = 1; } else { - inc_super = RTEST(include_super); - if (!inc_super) { - lookup_mod = RCLASS_ORIGIN(mod); - } + inc_super = RTEST(include_super); + if (!inc_super) { + lookup_mod = RCLASS_ORIGIN(mod); + } } me = rb_method_entry_without_refinements(lookup_mod, id, NULL); if (me) { - if (me->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) return METHOD_VISI_UNDEF; - if (!inc_super && me->owner != mod) return METHOD_VISI_UNDEF; - return METHOD_ENTRY_VISI(me); + if (me->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) return METHOD_VISI_UNDEF; + if (!inc_super && me->owner != mod) return METHOD_VISI_UNDEF; + return METHOD_ENTRY_VISI(me); } return METHOD_VISI_UNDEF; } @@ -1330,13 +2470,13 @@ static VALUE rb_mod_method_defined(int argc, VALUE *argv, VALUE mod) { rb_method_visibility_t visi = check_definition_visibility(mod, argc, argv); - return (visi == METHOD_VISI_PUBLIC || visi == METHOD_VISI_PROTECTED) ? Qtrue : Qfalse; + return RBOOL(visi == METHOD_VISI_PUBLIC || visi == METHOD_VISI_PROTECTED); } static VALUE check_definition(VALUE mod, int argc, VALUE *argv, rb_method_visibility_t visi) { - return (check_definition_visibility(mod, argc, argv) == visi) ? Qtrue : Qfalse; + return RBOOL(check_definition_visibility(mod, argc, argv) == visi); } /* @@ -1458,24 +2598,24 @@ original_method_definition(const rb_method_definition_t *def) { again: if (def) { - switch (def->type) { - case VM_METHOD_TYPE_REFINED: - if (def->body.refined.orig_me) { - def = def->body.refined.orig_me->def; - goto again; - } - break; - case VM_METHOD_TYPE_ALIAS: - def = def->body.alias.original_me->def; - goto again; - default: - break; - } + switch (def->type) { + case VM_METHOD_TYPE_REFINED: + if (def->body.refined.orig_me) { + def = def->body.refined.orig_me->def; + goto again; + } + break; + case VM_METHOD_TYPE_ALIAS: + def = def->body.alias.original_me->def; + goto again; + default: + break; + } } return def; } -MJIT_FUNC_EXPORTED int +int rb_method_definition_eq(const rb_method_definition_t *d1, const rb_method_definition_t *d2) { d1 = original_method_definition(d1); @@ -1487,29 +2627,30 @@ rb_method_definition_eq(const rb_method_definition_t *d1, const rb_method_defini switch (d1->type) { case VM_METHOD_TYPE_ISEQ: - return d1->body.iseq.iseqptr == d2->body.iseq.iseqptr; + return d1->body.iseq.iseqptr == d2->body.iseq.iseqptr; case VM_METHOD_TYPE_CFUNC: - return - d1->body.cfunc.func == d2->body.cfunc.func && - d1->body.cfunc.argc == d2->body.cfunc.argc; + return + d1->body.cfunc.func == d2->body.cfunc.func && + d1->body.cfunc.argc == d2->body.cfunc.argc; case VM_METHOD_TYPE_ATTRSET: case VM_METHOD_TYPE_IVAR: - return d1->body.attr.id == d2->body.attr.id; + return d1->body.attr.id == d2->body.attr.id; case VM_METHOD_TYPE_BMETHOD: return RTEST(rb_equal(d1->body.bmethod.proc, d2->body.bmethod.proc)); case VM_METHOD_TYPE_MISSING: - return d1->original_id == d2->original_id; + return d1->original_id == d2->original_id; case VM_METHOD_TYPE_ZSUPER: case VM_METHOD_TYPE_NOTIMPLEMENTED: case VM_METHOD_TYPE_UNDEF: - return 1; + return 1; case VM_METHOD_TYPE_OPTIMIZED: - return d1->body.optimize_type == d2->body.optimize_type; + return (d1->body.optimized.type == d2->body.optimized.type) && + (d1->body.optimized.index == d2->body.optimized.index); case VM_METHOD_TYPE_REFINED: case VM_METHOD_TYPE_ALIAS: - break; + break; } - rb_bug("rb_method_definition_eq: unsupported type: %d\n", d1->type); + rb_bug("rb_method_definition_eq: unsupported type: %d", d1->type); } static st_index_t @@ -1522,29 +2663,30 @@ rb_hash_method_definition(st_index_t hash, const rb_method_definition_t *def) switch (def->type) { case VM_METHOD_TYPE_ISEQ: - return rb_hash_uint(hash, (st_index_t)def->body.iseq.iseqptr); + return rb_hash_uint(hash, (st_index_t)def->body.iseq.iseqptr->body); case VM_METHOD_TYPE_CFUNC: - hash = rb_hash_uint(hash, (st_index_t)def->body.cfunc.func); - return rb_hash_uint(hash, def->body.cfunc.argc); + hash = rb_hash_uint(hash, (st_index_t)def->body.cfunc.func); + return rb_hash_uint(hash, def->body.cfunc.argc); case VM_METHOD_TYPE_ATTRSET: case VM_METHOD_TYPE_IVAR: - return rb_hash_uint(hash, def->body.attr.id); + return rb_hash_uint(hash, def->body.attr.id); case VM_METHOD_TYPE_BMETHOD: return rb_hash_proc(hash, def->body.bmethod.proc); case VM_METHOD_TYPE_MISSING: - return rb_hash_uint(hash, def->original_id); + return rb_hash_uint(hash, def->original_id); case VM_METHOD_TYPE_ZSUPER: case VM_METHOD_TYPE_NOTIMPLEMENTED: case VM_METHOD_TYPE_UNDEF: - return hash; + return hash; case VM_METHOD_TYPE_OPTIMIZED: - return rb_hash_uint(hash, def->body.optimize_type); + hash = rb_hash_uint(hash, def->body.optimized.index); + return rb_hash_uint(hash, def->body.optimized.type); case VM_METHOD_TYPE_REFINED: case VM_METHOD_TYPE_ALIAS: - break; /* unreachable */ - } - rb_bug("rb_hash_method_definition: unsupported method type (%d)\n", def->type); + break; /* unreachable */ } + rb_bug("rb_hash_method_definition: unsupported method type (%d)", def->type); +} st_index_t rb_hash_method_entry(st_index_t hash, const rb_method_entry_t *me) @@ -1561,59 +2703,73 @@ rb_alias(VALUE klass, ID alias_name, ID original_name) rb_method_visibility_t visi = METHOD_VISI_UNDEF; if (NIL_P(klass)) { - rb_raise(rb_eTypeError, "no class to make alias"); + rb_raise(rb_eTypeError, "no class to make alias"); } rb_class_modify_check(klass); again: orig_me = search_method(klass, original_name, &defined_class); + if (orig_me && orig_me->def->type == VM_METHOD_TYPE_REFINED) { - orig_me = rb_resolve_refined_method(Qnil, orig_me); + orig_me = rb_resolve_refined_method(Qnil, orig_me); } if (UNDEFINED_METHOD_ENTRY_P(orig_me) || - UNDEFINED_REFINED_METHOD_P(orig_me->def)) { - if ((!RB_TYPE_P(klass, T_MODULE)) || - (orig_me = search_method(rb_cObject, original_name, &defined_class), - UNDEFINED_METHOD_ENTRY_P(orig_me))) { - rb_print_undef(klass, original_name, METHOD_VISI_UNDEF); - } + UNDEFINED_REFINED_METHOD_P(orig_me->def)) { + if ((!RB_TYPE_P(klass, T_MODULE)) || + (orig_me = search_method(rb_cObject, original_name, &defined_class), + UNDEFINED_METHOD_ENTRY_P(orig_me))) { + rb_print_undef(target_klass, original_name, METHOD_VISI_UNDEF); + } } - if (orig_me->def->type == VM_METHOD_TYPE_ZSUPER) { - klass = RCLASS_SUPER(klass); - original_name = orig_me->def->original_id; - visi = METHOD_ENTRY_VISI(orig_me); - goto again; + switch (orig_me->def->type) { + case VM_METHOD_TYPE_ZSUPER: + klass = RCLASS_SUPER(klass); + original_name = orig_me->def->original_id; + visi = METHOD_ENTRY_VISI(orig_me); + goto again; + case VM_METHOD_TYPE_ALIAS: + visi = METHOD_ENTRY_VISI(orig_me); + orig_me = orig_me->def->body.alias.original_me; + VM_ASSERT(orig_me->def->type != VM_METHOD_TYPE_ALIAS); + break; + default: break; } if (visi == METHOD_VISI_UNDEF) visi = METHOD_ENTRY_VISI(orig_me); if (orig_me->defined_class == 0) { - rb_method_entry_make(target_klass, alias_name, target_klass, visi, - VM_METHOD_TYPE_ALIAS, NULL, orig_me->called_id, - (void *)rb_method_entry_clone(orig_me)); - method_added(target_klass, alias_name); + rb_method_entry_make(target_klass, alias_name, target_klass, visi, + VM_METHOD_TYPE_ALIAS, NULL, orig_me->called_id, + (void *)rb_method_entry_clone(orig_me)); + method_added(target_klass, alias_name); } else { - rb_method_entry_t *alias_me; + rb_method_entry_t *alias_me; - alias_me = method_entry_set(target_klass, alias_name, orig_me, visi, orig_me->owner); - RB_OBJ_WRITE(alias_me, &alias_me->owner, target_klass); - RB_OBJ_WRITE(alias_me, &alias_me->defined_class, defined_class); + alias_me = method_entry_set(target_klass, alias_name, orig_me, visi, orig_me->owner); + RB_OBJ_WRITE(alias_me, &alias_me->owner, target_klass); + + if (RB_TYPE_P(target_klass, T_MODULE)) { + // defined_class should not be set + } + else { + RB_OBJ_WRITE(alias_me, &alias_me->defined_class, orig_me->defined_class); + } } } /* * call-seq: - * alias_method(new_name, old_name) -> self + * alias_method(new_name, old_name) -> symbol * * Makes <i>new_name</i> a new copy of the method <i>old_name</i>. This can * be used to retain access to methods that are overridden. * * module Mod - * alias_method :orig_exit, :exit + * alias_method :orig_exit, :exit #=> :orig_exit * def exit(code=0) * puts "Exiting with code #{code}" * orig_exit(code) @@ -1632,10 +2788,21 @@ rb_mod_alias_method(VALUE mod, VALUE newname, VALUE oldname) { ID oldid = rb_check_id(&oldname); if (!oldid) { - rb_print_undef_str(mod, oldname); + rb_print_undef_str(mod, oldname); } - rb_alias(mod, rb_to_id(newname), oldid); - return mod; + VALUE id = rb_to_id(newname); + rb_alias(mod, id, oldid); + return ID2SYM(id); +} + +static void +check_and_export_method(VALUE self, VALUE name, rb_method_visibility_t visi) +{ + ID id = rb_check_id(&name); + if (!id) { + rb_print_undef_str(self, name); + } + rb_export_method(self, id, visi); } static void @@ -1645,18 +2812,25 @@ set_method_visibility(VALUE self, int argc, const VALUE *argv, rb_method_visibil rb_check_frozen(self); if (argc == 0) { - rb_warning("%"PRIsVALUE" with no argument is just ignored", - QUOTE_ID(rb_frame_callee())); - return; + rb_warning("%"PRIsVALUE" with no argument is just ignored", + QUOTE_ID(rb_frame_callee())); + return; } - for (i = 0; i < argc; i++) { - VALUE v = argv[i]; - ID id = rb_check_id(&v); - if (!id) { - rb_print_undef_str(self, v); - } - rb_export_method(self, id, visi); + + VALUE v; + + if (argc == 1 && (v = rb_check_array_type(argv[0])) != Qnil) { + long j; + + for (j = 0; j < RARRAY_LEN(v); j++) { + check_and_export_method(self, RARRAY_AREF(v, j), visi); + } + } + else { + for (i = 0; i < argc; i++) { + check_and_export_method(self, argv[i], visi); + } } } @@ -1664,24 +2838,33 @@ static VALUE set_visibility(int argc, const VALUE *argv, VALUE module, rb_method_visibility_t visi) { if (argc == 0) { - rb_scope_visibility_set(visi); + scope_visibility_check(); + rb_scope_visibility_set(visi); + return Qnil; } - else { - set_method_visibility(module, argc, argv, visi); + + set_method_visibility(module, argc, argv, visi); + if (argc == 1) { + return argv[0]; } - return module; + return rb_ary_new_from_values(argc, argv); } /* * call-seq: - * public -> self - * public(symbol, ...) -> self - * public(string, ...) -> self + * public -> nil + * public(method_name) -> method_name + * public(method_name, method_name, ...) -> array + * public(array) -> array * * With no arguments, sets the default visibility for subsequently * defined methods to public. With arguments, sets the named methods to * have public visibility. * String arguments are converted to symbols. + * An Array of Symbols and/or Strings is also accepted. + * If a single argument is passed, it is returned. + * If no argument is passed, nil is returned. + * If multiple arguments are passed, the arguments are returned as an array. */ static VALUE @@ -1692,21 +2875,58 @@ rb_mod_public(int argc, VALUE *argv, VALUE module) /* * call-seq: - * protected -> self - * protected(symbol, ...) -> self - * protected(string, ...) -> self + * protected -> nil + * protected(method_name) -> method_name + * protected(method_name, method_name, ...) -> array + * protected(array) -> array * - * With no arguments, sets the default visibility for subsequently - * defined methods to protected. With arguments, sets the named methods - * to have protected visibility. - * String arguments are converted to symbols. + * Sets the visibility of a section or of a list of method names as protected. + * Accepts no arguments, a splat of method names (symbols or strings) or an + * array of method names. Returns the arguments that it received. + * + * == Important difference between protected in other languages + * + * Protected methods in Ruby are different from other languages such as Java, + * where methods are marked as protected to give access to subclasses. In Ruby, + * subclasses <b>already have access to all methods defined in the parent + * class</b>, even private ones. + * + * Marking a method as protected allows <b>different objects of the same + * class</b> to call it. + * + * One use case is for comparison methods, such as <code>==</code>, if we want + * to expose a method for comparison between objects of the same class without + * making the method public to objects of other classes. + * + * == Performance considerations * - * If a method has protected visibility, it is callable only where - * <code>self</code> of the context is the same as the method. - * (method definition or instance_eval). This behavior is different from - * Java's protected method. Usually <code>private</code> should be used. + * Protected methods are slower than others because they can't use inline + * cache. * - * Note that a protected method is slow because it can't use inline cache. + * == Example + * + * class Account + * # Mark balance as protected, so that we can compare between accounts + * # without making it public. + * attr_reader :balance + * protected :balance + * + * def initialize(balance) + * @balance = balance + * end + * + * def >(other) + * # The invocation to `other.balance` is allowed because `other` is a + * # different object of the same class (Account). + * balance > other.balance + * end + * end + * + * account1 = Account.new(100) + * account2 = Account.new(50) + * + * account1 > account2 # => true (works) + * account1.balance # => NoMethodError (fails because balance is not public) * * To show a private method on RDoc, use <code>:doc:</code> instead of this. */ @@ -1719,14 +2939,19 @@ rb_mod_protected(int argc, VALUE *argv, VALUE module) /* * call-seq: - * private -> self - * private(symbol, ...) -> self - * private(string, ...) -> self + * private -> nil + * private(method_name) -> method_name + * private(method_name, method_name, ...) -> array + * private(array) -> array * * With no arguments, sets the default visibility for subsequently * defined methods to private. With arguments, sets the named methods * to have private visibility. * String arguments are converted to symbols. + * An Array of Symbols and/or Strings is also accepted. + * If a single argument is passed, it is returned. + * If no argument is passed, nil is returned. + * If multiple arguments are passed, the arguments are returned as an array. * * module Mod * def a() end @@ -1748,12 +2973,128 @@ rb_mod_private(int argc, VALUE *argv, VALUE module) /* * call-seq: + * ruby2_keywords(method_name, ...) -> nil + * + * For the given method names, marks the method as passing keywords through + * a normal argument splat. This should only be called on methods that + * accept an argument splat (<tt>*args</tt>) but not explicit keywords or + * a keyword splat. It marks the method such that if the method is called + * with keyword arguments, the final hash argument is marked with a special + * flag such that if it is the final element of a normal argument splat to + * another method call, and that method call does not include explicit + * keywords or a keyword splat, the final element is interpreted as keywords. + * In other words, keywords will be passed through the method to other + * methods. + * + * This should only be used for methods that delegate keywords to another + * method, and only for backwards compatibility with Ruby versions before 3.0. + * See https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/ + * for details on why +ruby2_keywords+ exists and when and how to use it. + * + * This method will probably be removed at some point, as it exists only + * for backwards compatibility. As it does not exist in Ruby versions before + * 2.7, check that the module responds to this method before calling it: + * + * module Mod + * def foo(meth, *args, &block) + * send(:"do_#{meth}", *args, &block) + * end + * ruby2_keywords(:foo) if respond_to?(:ruby2_keywords, true) + * end + * + * However, be aware that if the +ruby2_keywords+ method is removed, the + * behavior of the +foo+ method using the above approach will change so that + * the method does not pass through keywords. + */ + +static VALUE +rb_mod_ruby2_keywords(int argc, VALUE *argv, VALUE module) +{ + int i; + VALUE origin_class = RCLASS_ORIGIN(module); + + rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS); + rb_check_frozen(module); + + for (i = 0; i < argc; i++) { + VALUE v = argv[i]; + ID name = rb_check_id(&v); + rb_method_entry_t *me; + VALUE defined_class; + + if (!name) { + rb_print_undef_str(module, v); + } + + me = search_method(origin_class, name, &defined_class); + if (!me && RB_TYPE_P(module, T_MODULE)) { + me = search_method(rb_cObject, name, &defined_class); + } + + if (UNDEFINED_METHOD_ENTRY_P(me) || + UNDEFINED_REFINED_METHOD_P(me->def)) { + rb_print_undef(module, name, METHOD_VISI_UNDEF); + } + + if (module == defined_class || origin_class == defined_class) { + switch (me->def->type) { + case VM_METHOD_TYPE_ISEQ: + if (ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_rest && + !ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_post && + !ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_kw && + !ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_kwrest) { + ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.ruby2_keywords = 1; + rb_clear_method_cache(module, name); + } + else { + rb_warn("Skipping set of ruby2_keywords flag for %"PRIsVALUE" (method accepts keywords or post arguments or method does not accept argument splat)", QUOTE_ID(name)); + } + break; + case VM_METHOD_TYPE_BMETHOD: { + VALUE procval = me->def->body.bmethod.proc; + if (vm_block_handler_type(procval) == block_handler_type_proc) { + procval = vm_proc_to_block_handler(VM_BH_TO_PROC(procval)); + } + + if (vm_block_handler_type(procval) == block_handler_type_iseq) { + const struct rb_captured_block *captured = VM_BH_TO_ISEQ_BLOCK(procval); + const rb_iseq_t *iseq = rb_iseq_check(captured->code.iseq); + if (ISEQ_BODY(iseq)->param.flags.has_rest && + !ISEQ_BODY(iseq)->param.flags.has_post && + !ISEQ_BODY(iseq)->param.flags.has_kw && + !ISEQ_BODY(iseq)->param.flags.has_kwrest) { + ISEQ_BODY(iseq)->param.flags.ruby2_keywords = 1; + rb_clear_method_cache(module, name); + } + else { + rb_warn("Skipping set of ruby2_keywords flag for %"PRIsVALUE" (method accepts keywords or post arguments or method does not accept argument splat)", QUOTE_ID(name)); + } + break; + } + } + /* fallthrough */ + default: + rb_warn("Skipping set of ruby2_keywords flag for %"PRIsVALUE" (method not defined in Ruby)", QUOTE_ID(name)); + break; + } + } + else { + rb_warn("Skipping set of ruby2_keywords flag for %"PRIsVALUE" (can only set in method defining module)", QUOTE_ID(name)); + } + } + return Qnil; +} + +/* + * call-seq: * mod.public_class_method(symbol, ...) -> mod * mod.public_class_method(string, ...) -> mod + * mod.public_class_method(array) -> mod * * Makes a list of existing class methods public. * * String arguments are converted to symbols. + * An Array of Symbols and/or Strings is also accepted. */ static VALUE @@ -1767,11 +3108,13 @@ rb_mod_public_method(int argc, VALUE *argv, VALUE obj) * call-seq: * mod.private_class_method(symbol, ...) -> mod * mod.private_class_method(string, ...) -> mod + * mod.private_class_method(array) -> mod * * Makes existing class methods private. Often used to hide the default * constructor <code>new</code>. * * String arguments are converted to symbols. + * An Array of Symbols and/or Strings is also accepted. * * class SimpleSingleton # Not thread safe * private_class_method :new @@ -1794,18 +3137,20 @@ rb_mod_private_method(int argc, VALUE *argv, VALUE obj) * public * public(symbol, ...) * public(string, ...) + * public(array) * * With no arguments, sets the default visibility for subsequently * defined methods to public. With arguments, sets the named methods to * have public visibility. * * String arguments are converted to symbols. + * An Array of Symbols and/or Strings is also accepted. */ static VALUE -top_public(int argc, VALUE *argv) +top_public(int argc, VALUE *argv, VALUE _) { - return rb_mod_public(argc, argv, rb_cObject); + return rb_mod_public(argc, argv, rb_top_main_class("public")); } /* @@ -1813,23 +3158,39 @@ top_public(int argc, VALUE *argv) * private * private(symbol, ...) * private(string, ...) + * private(array) * * With no arguments, sets the default visibility for subsequently * defined methods to private. With arguments, sets the named methods to * have private visibility. * * String arguments are converted to symbols. + * An Array of Symbols and/or Strings is also accepted. + */ +static VALUE +top_private(int argc, VALUE *argv, VALUE _) +{ + return rb_mod_private(argc, argv, rb_top_main_class("private")); +} + +/* + * call-seq: + * ruby2_keywords(method_name, ...) -> self + * + * For the given method names, marks the method as passing keywords through + * a normal argument splat. See Module#ruby2_keywords in detail. */ static VALUE -top_private(int argc, VALUE *argv) +top_ruby2_keywords(int argc, VALUE *argv, VALUE module) { - return rb_mod_private(argc, argv, rb_cObject); + return rb_mod_ruby2_keywords(argc, argv, rb_top_main_class("ruby2_keywords")); } /* * call-seq: - * module_function(symbol, ...) -> self - * module_function(string, ...) -> self + * module_function -> nil + * module_function(method_name) -> method_name + * module_function(method_name, method_name, ...) -> array * * Creates module functions for the named methods. These functions may * be called with the module as a receiver, and also become available @@ -1839,6 +3200,9 @@ top_private(int argc, VALUE *argv) * used with no arguments, subsequently defined methods become module * functions. * String arguments are converted to symbols. + * If a single argument is passed, it is returned. + * If no argument is passed, nil is returned. + * If multiple arguments are passed, the arguments are returned as an array. * * module Mod * def one @@ -1872,74 +3236,81 @@ rb_mod_modfunc(int argc, VALUE *argv, VALUE module) const rb_method_entry_t *me; if (!RB_TYPE_P(module, T_MODULE)) { - rb_raise(rb_eTypeError, "module_function must be called for modules"); + rb_raise(rb_eTypeError, "module_function must be called for modules"); } if (argc == 0) { - rb_scope_module_func_set(); - return module; + rb_scope_module_func_set(); + return Qnil; } set_method_visibility(module, argc, argv, METHOD_VISI_PRIVATE); for (i = 0; i < argc; i++) { - VALUE m = module; - - id = rb_to_id(argv[i]); - for (;;) { - me = search_method(m, id, 0); - if (me == 0) { - me = search_method(rb_cObject, id, 0); - } - if (UNDEFINED_METHOD_ENTRY_P(me)) { - rb_print_undef(module, id, METHOD_VISI_UNDEF); - } - if (me->def->type != VM_METHOD_TYPE_ZSUPER) { - break; /* normal case: need not to follow 'super' link */ - } - m = RCLASS_SUPER(m); - if (!m) - break; - } - rb_method_entry_set(rb_singleton_class(module), id, me, METHOD_VISI_PUBLIC); - } - return module; + VALUE m = module; + + id = rb_to_id(argv[i]); + for (;;) { + me = search_method(m, id, 0); + if (me == 0) { + me = search_method(rb_cObject, id, 0); + } + if (UNDEFINED_METHOD_ENTRY_P(me)) { + rb_print_undef(module, id, METHOD_VISI_UNDEF); + } + if (me->def->type != VM_METHOD_TYPE_ZSUPER) { + break; /* normal case: need not to follow 'super' link */ + } + m = RCLASS_SUPER(m); + if (!m) + break; + } + rb_method_entry_set(rb_singleton_class(module), id, me, METHOD_VISI_PUBLIC); + } + if (argc == 1) { + return argv[0]; + } + return rb_ary_new_from_values(argc, argv); } +#ifdef __GNUC__ +#pragma push_macro("rb_method_basic_definition_p") +#undef rb_method_basic_definition_p +#endif int rb_method_basic_definition_p(VALUE klass, ID id) { - const rb_method_entry_t *me; + const rb_callable_method_entry_t *cme; if (!klass) return TRUE; /* hidden object cannot be overridden */ - me = rb_method_entry(klass, id); - return (me && METHOD_ENTRY_BASIC(me)) ? TRUE : FALSE; + cme = rb_callable_method_entry(klass, id); + return (cme && METHOD_ENTRY_BASIC(cme)) ? TRUE : FALSE; } +#ifdef __GNUC__ +#pragma pop_macro("rb_method_basic_definition_p") +#endif static VALUE call_method_entry(rb_execution_context_t *ec, VALUE defined_class, VALUE obj, ID id, - const rb_method_entry_t *me, int argc, const VALUE *argv) + const rb_callable_method_entry_t *cme, int argc, const VALUE *argv, int kw_splat) { - const rb_callable_method_entry_t *cme = - prepare_callable_method_entry(defined_class, id, me); VALUE passed_block_handler = vm_passed_block_handler(ec); - VALUE result = rb_vm_call0(ec, obj, id, argc, argv, cme); + VALUE result = rb_vm_call_kw(ec, obj, id, argc, argv, cme, kw_splat); vm_passed_block_handler_set(ec, passed_block_handler); return result; } static VALUE basic_obj_respond_to_missing(rb_execution_context_t *ec, VALUE klass, VALUE obj, - VALUE mid, VALUE priv) + VALUE mid, VALUE priv) { VALUE defined_class, args[2]; const ID rtmid = idRespond_to_missing; - const rb_method_entry_t *const me = - method_entry_get(klass, rtmid, &defined_class); + const rb_callable_method_entry_t *const cme = callable_method_entry(klass, rtmid, &defined_class); - if (!me || METHOD_ENTRY_BASIC(me)) return Qundef; + if (!cme || METHOD_ENTRY_BASIC(cme)) return Qundef; args[0] = mid; args[1] = priv; - return call_method_entry(ec, defined_class, obj, rtmid, me, 2, args); + return call_method_entry(ec, defined_class, obj, rtmid, cme, 2, args, RB_NO_KEYWORDS); } static inline int @@ -1948,15 +3319,15 @@ basic_obj_respond_to(rb_execution_context_t *ec, VALUE obj, ID id, int pub) VALUE klass = CLASS_OF(obj); VALUE ret; - switch (rb_method_boundp(klass, id, pub|BOUND_RESPONDS)) { + switch (method_boundp(klass, id, pub|BOUND_RESPONDS)) { case 2: - return FALSE; + return FALSE; case 0: - ret = basic_obj_respond_to_missing(ec, klass, obj, ID2SYM(id), - pub ? Qfalse : Qtrue); - return RTEST(ret) && ret != Qundef; + ret = basic_obj_respond_to_missing(ec, klass, obj, ID2SYM(id), + RBOOL(!pub)); + return RTEST(ret) && !UNDEF_P(ret); default: - return TRUE; + return TRUE; } } @@ -1965,49 +3336,50 @@ vm_respond_to(rb_execution_context_t *ec, VALUE klass, VALUE obj, ID id, int pri { VALUE defined_class; const ID resid = idRespond_to; - const rb_method_entry_t *const me = - method_entry_get(klass, resid, &defined_class); + const rb_callable_method_entry_t *const cme = callable_method_entry(klass, resid, &defined_class); - if (!me) return -1; - if (METHOD_ENTRY_BASIC(me)) { - return -1; + if (!cme) return -1; + if (METHOD_ENTRY_BASIC(cme)) { + return -1; } else { - int argc = 1; - VALUE args[2]; - VALUE result; - - args[0] = ID2SYM(id); - args[1] = Qtrue; - if (priv) { - argc = rb_method_entry_arity(me); - if (argc > 2) { - rb_raise(rb_eArgError, - "respond_to? must accept 1 or 2 arguments (requires %d)", - argc); - } - if (argc != 1) { - argc = 2; - } - else if (!NIL_P(ruby_verbose)) { - VALUE location = rb_method_entry_location(me); - rb_warn("%"PRIsVALUE"%c""respond_to?(:%"PRIsVALUE") uses" - " the deprecated method signature, which takes one parameter", - (FL_TEST(klass, FL_SINGLETON) ? obj : klass), - (FL_TEST(klass, FL_SINGLETON) ? '.' : '#'), - QUOTE_ID(id)); - if (!NIL_P(location)) { - VALUE path = RARRAY_AREF(location, 0); - VALUE line = RARRAY_AREF(location, 1); - if (!NIL_P(path)) { - rb_compile_warn(RSTRING_PTR(path), NUM2INT(line), - "respond_to? is defined here"); - } - } - } - } - result = call_method_entry(ec, defined_class, obj, resid, me, argc, args); - return RTEST(result); + int argc = 1; + VALUE args[2]; + VALUE result; + + args[0] = ID2SYM(id); + args[1] = Qtrue; + if (priv) { + argc = rb_method_entry_arity((const rb_method_entry_t *)cme); + if (argc > 2) { + rb_raise(rb_eArgError, + "respond_to? must accept 1 or 2 arguments (requires %d)", + argc); + } + if (argc != 1) { + argc = 2; + } + else if (!NIL_P(ruby_verbose)) { + VALUE location = rb_method_entry_location((const rb_method_entry_t *)cme); + rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, + "%"PRIsVALUE"%c""respond_to?(:%"PRIsVALUE") uses" + " the deprecated method signature, which takes one parameter", + (RCLASS_SINGLETON_P(klass) ? obj : klass), + (RCLASS_SINGLETON_P(klass) ? '.' : '#'), + QUOTE_ID(id)); + if (!NIL_P(location)) { + VALUE path = RARRAY_AREF(location, 0); + VALUE line = RARRAY_AREF(location, 1); + if (!NIL_P(path)) { + rb_category_compile_warn(RB_WARN_CATEGORY_DEPRECATED, + RSTRING_PTR(path), NUM2INT(line), + "respond_to? is defined here"); + } + } + } + } + result = call_method_entry(ec, defined_class, obj, resid, cme, argc, args, RB_NO_KEYWORDS); + return RTEST(result); } } @@ -2015,6 +3387,12 @@ int rb_obj_respond_to(VALUE obj, ID id, int priv) { rb_execution_context_t *ec = GET_EC(); + return rb_ec_obj_respond_to(ec, obj, id, priv); +} + +int +rb_ec_obj_respond_to(rb_execution_context_t *ec, VALUE obj, ID id, int priv) +{ VALUE klass = CLASS_OF(obj); int ret = vm_respond_to(ec, klass, obj, id, priv); if (ret == -1) ret = basic_obj_respond_to(ec, obj, id, !priv); @@ -2057,14 +3435,12 @@ obj_respond_to(int argc, VALUE *argv, VALUE obj) rb_scan_args(argc, argv, "11", &mid, &priv); if (!(id = rb_check_id(&mid))) { - VALUE ret = basic_obj_respond_to_missing(ec, CLASS_OF(obj), obj, - rb_to_symbol(mid), priv); - if (ret == Qundef) ret = Qfalse; - return ret; + VALUE ret = basic_obj_respond_to_missing(ec, CLASS_OF(obj), obj, + rb_to_symbol(mid), priv); + if (UNDEF_P(ret)) ret = Qfalse; + return ret; } - if (basic_obj_respond_to(ec, obj, id, !RTEST(priv))) - return Qtrue; - return Qfalse; + return RBOOL(basic_obj_respond_to(ec, obj, id, !RTEST(priv))); } /* @@ -2089,36 +3465,8 @@ obj_respond_to_missing(VALUE obj, VALUE mid, VALUE priv) } void -Init_Method(void) -{ -#if OPT_GLOBAL_METHOD_CACHE - char *ptr = getenv("RUBY_GLOBAL_METHOD_CACHE_SIZE"); - int val; - - if (ptr != NULL && (val = atoi(ptr)) > 0) { - if ((val & (val - 1)) == 0) { /* ensure val is a power of 2 */ - global_method_cache.size = val; - global_method_cache.mask = val - 1; - } - else { - fprintf(stderr, "RUBY_GLOBAL_METHOD_CACHE_SIZE was set to %d but ignored because the value is not a power of 2.\n", val); - } - } - - global_method_cache.entries = (struct cache_entry *)calloc(global_method_cache.size, sizeof(struct cache_entry)); - if (global_method_cache.entries == NULL) { - fprintf(stderr, "[FATAL] failed to allocate memory\n"); - exit(EXIT_FAILURE); - } -#endif -} - -void Init_eval_method(void) { -#undef rb_intern -#define rb_intern(str) rb_intern_const(str) - rb_define_method(rb_mKernel, "respond_to?", obj_respond_to, -1); rb_define_method(rb_mKernel, "respond_to_missing?", obj_respond_to_missing, 2); @@ -2129,6 +3477,7 @@ Init_eval_method(void) rb_define_private_method(rb_cModule, "protected", rb_mod_protected, -1); rb_define_private_method(rb_cModule, "private", rb_mod_private, -1); rb_define_private_method(rb_cModule, "module_function", rb_mod_modfunc, -1); + rb_define_private_method(rb_cModule, "ruby2_keywords", rb_mod_ruby2_keywords, -1); rb_define_method(rb_cModule, "method_defined?", rb_mod_method_defined, -1); rb_define_method(rb_cModule, "public_method_defined?", rb_mod_public_method_defined, -1); @@ -2138,18 +3487,20 @@ Init_eval_method(void) rb_define_method(rb_cModule, "private_class_method", rb_mod_private_method, -1); rb_define_private_method(rb_singleton_class(rb_vm_top_self()), - "public", top_public, -1); + "public", top_public, -1); + rb_define_private_method(rb_singleton_class(rb_vm_top_self()), + "private", top_private, -1); rb_define_private_method(rb_singleton_class(rb_vm_top_self()), - "private", top_private, -1); + "ruby2_keywords", top_ruby2_keywords, -1); { #define REPLICATE_METHOD(klass, id) do { \ - const rb_method_entry_t *me = rb_method_entry((klass), (id)); \ - rb_method_entry_set((klass), (id), me, METHOD_ENTRY_VISI(me)); \ - } while (0) + const rb_method_entry_t *me = rb_method_entry((klass), (id)); \ + rb_method_entry_set((klass), (id), me, METHOD_ENTRY_VISI(me)); \ + } while (0) - REPLICATE_METHOD(rb_eException, idMethodMissing); - REPLICATE_METHOD(rb_eException, idRespond_to); - REPLICATE_METHOD(rb_eException, idRespond_to_missing); + REPLICATE_METHOD(rb_eException, idMethodMissing); + REPLICATE_METHOD(rb_eException, idRespond_to); + REPLICATE_METHOD(rb_eException, idRespond_to_missing); } } |