Ruby 4.0.0dev (2025-11-26 revision 38022961ae399015c542c409948aa4885e8e56e0)
vm_method.c (38022961ae399015c542c409948aa4885e8e56e0)
1/*
2 * This file is included by vm.c
3 */
4
5#include "id_table.h"
6#include "yjit.h"
7
8#define METHOD_DEBUG 0
9
10static int vm_redefinition_check_flag(VALUE klass);
11static void rb_vm_check_redefinition_opt_method(const rb_method_entry_t *me, VALUE klass);
12static inline rb_method_entry_t *lookup_method_table(VALUE klass, ID id);
13
14#define object_id idObject_id
15#define added idMethod_added
16#define singleton_added idSingleton_method_added
17#define removed idMethod_removed
18#define singleton_removed idSingleton_method_removed
19#define undefined idMethod_undefined
20#define singleton_undefined idSingleton_method_undefined
21
22#define ruby_running (GET_VM()->running)
23/* int ruby_running = 0; */
24
25static enum rb_id_table_iterator_result
26mark_cc_entry_i(VALUE ccs_ptr, void *data)
27{
28 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_ptr;
29
30 VM_ASSERT(vm_ccs_p(ccs));
31
32 if (METHOD_ENTRY_INVALIDATED(ccs->cme)) {
33 /* Before detaching the CCs from this class, we need to invalidate the cc
34 * since we will no longer be marking the cme on their behalf.
35 */
36 for (int i = 0; i < ccs->len; i++) {
37 const struct rb_callcache *cc = ccs->entries[i].cc;
38 if (cc->klass == Qundef) continue; // already invalidated
39 VM_ASSERT(cc->klass == Qundef || vm_cc_check_cme(cc, ccs->cme));
40 VM_ASSERT(!vm_cc_super_p(cc) && !vm_cc_refinement_p(cc));
41 vm_cc_invalidate(cc);
42 }
43 ruby_xfree(ccs);
44 return ID_TABLE_DELETE;
45 }
46 else {
47 rb_gc_mark_movable((VALUE)ccs->cme);
48
49 for (int i = 0; i < ccs->len; i++) {
50 const struct rb_callcache *cc = ccs->entries[i].cc;
51 VM_ASSERT(cc->klass == Qundef || vm_cc_check_cme(cc, ccs->cme));
52
53 rb_gc_mark_movable((VALUE)cc);
54 }
55 return ID_TABLE_CONTINUE;
56 }
57}
58
59static void
60vm_cc_table_mark(void *data)
61{
62 struct rb_id_table *tbl = (struct rb_id_table *)data;
63 if (tbl) {
64 rb_id_table_foreach_values(tbl, mark_cc_entry_i, NULL);
65 }
66}
67
68static enum rb_id_table_iterator_result
69cc_table_free_i(VALUE ccs_ptr, void *data)
70{
71 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_ptr;
72 VM_ASSERT(vm_ccs_p(ccs));
73
74 ruby_xfree(ccs);
75
76 return ID_TABLE_CONTINUE;
77}
78
79static void
80vm_cc_table_free(void *data)
81{
82 struct rb_id_table *tbl = (struct rb_id_table *)data;
83
84 rb_id_table_foreach_values(tbl, cc_table_free_i, NULL);
85 rb_managed_id_table_type.function.dfree(data);
86}
87
88static enum rb_id_table_iterator_result
89cc_table_memsize_i(VALUE ccs_ptr, void *data_ptr)
90{
91 size_t *total_size = data_ptr;
92 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_ptr;
93 *total_size += sizeof(*ccs);
94 *total_size += sizeof(ccs->entries[0]) * ccs->capa;
95 return ID_TABLE_CONTINUE;
96}
97
98static size_t
99vm_cc_table_memsize(const void *data)
100{
101 size_t memsize = rb_managed_id_table_type.function.dsize(data);
102 struct rb_id_table *tbl = (struct rb_id_table *)data;
103 rb_id_table_foreach_values(tbl, cc_table_memsize_i, &memsize);
104 return memsize;
105}
106
107static enum rb_id_table_iterator_result
108compact_cc_entry_i(VALUE ccs_ptr, void *data)
109{
110 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_ptr;
111
112 ccs->cme = (const struct rb_callable_method_entry_struct *)rb_gc_location((VALUE)ccs->cme);
113 VM_ASSERT(vm_ccs_p(ccs));
114
115 for (int i=0; i<ccs->len; i++) {
116 ccs->entries[i].cc = (const struct rb_callcache *)rb_gc_location((VALUE)ccs->entries[i].cc);
117 }
118
119 return ID_TABLE_CONTINUE;
120}
121
122static void
123vm_cc_table_compact(void *data)
124{
125 struct rb_id_table *tbl = (struct rb_id_table *)data;
126 rb_id_table_foreach_values(tbl, compact_cc_entry_i, NULL);
127}
128
129static const rb_data_type_t cc_table_type = {
130 .wrap_struct_name = "VM/cc_table",
131 .function = {
132 .dmark = vm_cc_table_mark,
133 .dfree = vm_cc_table_free,
134 .dsize = vm_cc_table_memsize,
135 .dcompact = vm_cc_table_compact,
136 },
137 .parent = &rb_managed_id_table_type,
138 .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE,
139};
140
141VALUE
142rb_vm_cc_table_create(size_t capa)
143{
144 return rb_managed_id_table_create(&cc_table_type, capa);
145}
146
147static enum rb_id_table_iterator_result
148vm_cc_table_dup_i(ID key, VALUE old_ccs_ptr, void *data)
149{
150 VALUE new_table = (VALUE)data;
151 struct rb_class_cc_entries *old_ccs = (struct rb_class_cc_entries *)old_ccs_ptr;
152 size_t memsize = vm_ccs_alloc_size(old_ccs->capa);
153 struct rb_class_cc_entries *new_ccs = ruby_xcalloc(1, memsize);
154 rb_managed_id_table_insert(new_table, key, (VALUE)new_ccs);
155
156 memcpy(new_ccs, old_ccs, memsize);
157
158#if VM_CHECK_MODE > 0
159 new_ccs->debug_sig = ~(VALUE)new_ccs;
160#endif
161
162 RB_OBJ_WRITTEN(new_table, Qundef, (VALUE)new_ccs->cme);
163 for (int index = 0; index < new_ccs->len; index++) {
164 RB_OBJ_WRITTEN(new_table, Qundef, new_ccs->entries[index].cc);
165 }
166 return ID_TABLE_CONTINUE;
167}
168
169VALUE
170rb_vm_cc_table_dup(VALUE old_table)
171{
172 VALUE new_table = rb_vm_cc_table_create(rb_managed_id_table_size(old_table));
173 rb_managed_id_table_foreach(old_table, vm_cc_table_dup_i, (void *)new_table);
174 return new_table;
175}
176
177static void
178vm_ccs_invalidate(struct rb_class_cc_entries *ccs)
179{
180 for (int i=0; i<ccs->len; i++) {
181 const struct rb_callcache *cc = ccs->entries[i].cc;
182 VM_ASSERT(!vm_cc_super_p(cc) && !vm_cc_refinement_p(cc));
183 vm_cc_invalidate(cc);
184 }
185}
186
187static void
188rb_vm_ccs_invalidate_and_free(struct rb_class_cc_entries *ccs)
189{
190 RB_DEBUG_COUNTER_INC(ccs_free);
191 vm_ccs_invalidate(ccs);
192 ruby_xfree(ccs);
193}
194
195void
196rb_vm_cc_table_delete(VALUE table, ID mid)
197{
198 VALUE ccs_obj;
199 if (rb_managed_id_table_lookup(table, mid, &ccs_obj)) {
200 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_obj;
201 rb_managed_id_table_delete(table, mid);
202 rb_vm_ccs_invalidate_and_free(ccs);
203 }
204}
205
206static enum rb_id_table_iterator_result
207vm_ccs_dump_i(ID mid, VALUE val, void *data)
208{
209 const struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)val;
210 fprintf(stderr, " | %s (len:%d) ", rb_id2name(mid), ccs->len);
211 rp(ccs->cme);
212
213 for (int i=0; i<ccs->len; i++) {
214 rp_m( " | \t", ccs->entries[i].cc);
215 }
216
217 return ID_TABLE_CONTINUE;
218}
219
220static void
221vm_ccs_dump(VALUE klass, ID target_mid)
222{
223 VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass);
224 if (cc_tbl) {
225 VALUE ccs;
226 if (target_mid) {
227 if (rb_managed_id_table_lookup(cc_tbl, target_mid, &ccs)) {
228 fprintf(stderr, " [CCTB] %p\n", (void *)cc_tbl);
229 vm_ccs_dump_i(target_mid, ccs, NULL);
230 }
231 }
232 else {
233 fprintf(stderr, " [CCTB] %p\n", (void *)cc_tbl);
234 rb_managed_id_table_foreach(cc_tbl, vm_ccs_dump_i, (void *)target_mid);
235 }
236 }
237}
238
239static enum rb_id_table_iterator_result
240vm_cme_dump_i(ID mid, VALUE val, void *data)
241{
242 ID target_mid = (ID)data;
243 if (target_mid == 0 || mid == target_mid) {
244 rp_m(" > ", val);
245 }
246 return ID_TABLE_CONTINUE;
247}
248
249static VALUE
250vm_mtbl_dump(VALUE klass, ID target_mid)
251{
252 fprintf(stderr, "# vm_mtbl\n");
253 while (klass) {
254 rp_m(" -> ", klass);
255 VALUE me;
256
257 if (RCLASS_M_TBL(klass)) {
258 if (target_mid != 0) {
259 if (rb_id_table_lookup(RCLASS_M_TBL(klass), target_mid, &me)) {
260 rp_m(" [MTBL] ", me);
261 }
262 }
263 else {
264 fprintf(stderr, " ## RCLASS_M_TBL (%p)\n", (void *)RCLASS_M_TBL(klass));
265 rb_id_table_foreach(RCLASS_M_TBL(klass), vm_cme_dump_i, NULL);
266 }
267 }
268 else {
269 fprintf(stderr, " MTBL: NULL\n");
270 }
271 if (RCLASS_WRITABLE_CALLABLE_M_TBL(klass)) {
272 if (target_mid != 0) {
273 if (rb_id_table_lookup(RCLASS_WRITABLE_CALLABLE_M_TBL(klass), target_mid, &me)) {
274 rp_m(" [CM**] ", me);
275 }
276 }
277 else {
278 fprintf(stderr, " ## RCLASS_CALLABLE_M_TBL\n");
279 rb_id_table_foreach(RCLASS_WRITABLE_CALLABLE_M_TBL(klass), vm_cme_dump_i, NULL);
280 }
281 }
282 if (RCLASS_WRITABLE_CC_TBL(klass)) {
283 vm_ccs_dump(klass, target_mid);
284 }
285 klass = RCLASS_SUPER(klass);
286 }
287 return Qnil;
288}
289
290void
291rb_vm_mtbl_dump(const char *msg, VALUE klass, ID target_mid)
292{
293 fprintf(stderr, "[%s] ", msg);
294 vm_mtbl_dump(klass, target_mid);
295}
296
297static inline void
298vm_cme_invalidate(rb_callable_method_entry_t *cme)
299{
300 VM_ASSERT(IMEMO_TYPE_P(cme, imemo_ment), "cme: %d", imemo_type((VALUE)cme));
301 VM_ASSERT(callable_method_entry_p(cme));
302 METHOD_ENTRY_INVALIDATED_SET(cme);
303 RB_DEBUG_COUNTER_INC(cc_cme_invalidate);
304
305 rb_yjit_cme_invalidate(cme);
306 rb_zjit_cme_invalidate(cme);
307}
308
309static int
310rb_clear_constant_cache_for_id_i(st_data_t ic, st_data_t arg)
311{
312 ((IC) ic)->entry = NULL;
313 return ST_CONTINUE;
314}
315
316// Here for backward compat.
317void rb_clear_constant_cache(void) {}
318
319void
321{
322 VALUE lookup_result;
323 rb_vm_t *vm = GET_VM();
324
325 if (rb_id_table_lookup(vm->constant_cache, id, &lookup_result)) {
326 set_table *ics = (set_table *)lookup_result;
327 set_table_foreach(ics, rb_clear_constant_cache_for_id_i, (st_data_t) NULL);
328 ruby_vm_constant_cache_invalidations += ics->num_entries;
329 }
330
331 rb_yjit_constant_state_changed(id);
332 rb_zjit_constant_state_changed(id);
333}
334
335static void
336invalidate_negative_cache(ID mid)
337{
338 VALUE cme;
339 rb_vm_t *vm = GET_VM();
340
341 if (rb_id_table_lookup(vm->negative_cme_table, mid, &cme)) {
342 rb_id_table_delete(vm->negative_cme_table, mid);
343 vm_cme_invalidate((rb_callable_method_entry_t *)cme);
344 RB_DEBUG_COUNTER_INC(cc_invalidate_negative);
345 }
346}
347
348const rb_method_entry_t * rb_method_entry_clone(const rb_method_entry_t *src_me);
349static const rb_callable_method_entry_t *complemented_callable_method_entry(VALUE klass, ID id);
350static const rb_callable_method_entry_t *lookup_overloaded_cme(const rb_callable_method_entry_t *cme);
351
352static void
353invalidate_method_cache_in_cc_table(VALUE tbl, ID mid)
354{
355 VALUE ccs_data;
356 if (tbl && rb_managed_id_table_lookup(tbl, mid, &ccs_data)) {
357 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data;
358 rb_yjit_cme_invalidate((rb_callable_method_entry_t *)ccs->cme);
359 rb_zjit_cme_invalidate((rb_callable_method_entry_t *)ccs->cme);
360 if (NIL_P(ccs->cme->owner)) invalidate_negative_cache(mid);
361 rb_vm_ccs_invalidate_and_free(ccs);
362 rb_managed_id_table_delete(tbl, mid);
363 RB_DEBUG_COUNTER_INC(cc_invalidate_leaf_ccs);
364 }
365}
366
367static void
368invalidate_callable_method_entry_in_callable_m_table(struct rb_id_table *tbl, ID mid)
369{
370 VALUE cme;
371 if (tbl && rb_id_table_lookup(tbl, mid, &cme)) {
372 rb_yjit_cme_invalidate((rb_callable_method_entry_t *)cme);
373 rb_zjit_cme_invalidate((rb_callable_method_entry_t *)cme);
374 rb_id_table_delete(tbl, mid);
375 RB_DEBUG_COUNTER_INC(cc_invalidate_leaf_callable);
376 }
377}
378
380 VALUE klass;
381 ID mid;
382 const rb_method_entry_t *cme;
383 const rb_method_entry_t *newer;
384};
385
386static void
387invalidate_callable_method_entry_in_every_m_table_i(rb_classext_t *ext, bool is_prime, VALUE box_value, void *data)
388{
389 st_data_t me;
391 struct rb_id_table *tbl = RCLASSEXT_M_TBL(ext);
392
393 if (rb_id_table_lookup(tbl, arg->mid, &me) && arg->cme == (const rb_method_entry_t *)me) {
394 rb_method_table_insert(arg->klass, tbl, arg->mid, arg->newer);
395 }
396}
397
398static void
399invalidate_callable_method_entry_in_every_m_table(VALUE klass, ID mid, const rb_callable_method_entry_t *cme)
400{
401 // The argument cme must be invalidated later in the caller side
402 const rb_method_entry_t *newer = rb_method_entry_clone((const rb_method_entry_t *)cme);
404 .klass = klass,
405 .mid = mid,
406 .cme = (const rb_method_entry_t *) cme,
407 .newer = newer,
408 };
409 rb_class_classext_foreach(klass, invalidate_callable_method_entry_in_every_m_table_i, (void *)&arg);
410}
411
412static void
413invalidate_complemented_method_entry_in_callable_m_table(struct rb_id_table *tbl, ID mid)
414{
415 VALUE cme;
416 if (tbl && rb_id_table_lookup(tbl, mid, &cme)) {
417 rb_yjit_cme_invalidate((rb_callable_method_entry_t *)cme);
418 rb_zjit_cme_invalidate((rb_callable_method_entry_t *)cme);
419 rb_id_table_delete(tbl, mid);
420 RB_DEBUG_COUNTER_INC(cc_invalidate_tree_callable);
421 }
422}
423
424static void
425clear_method_cache_by_id_in_class(VALUE klass, ID mid)
426{
427 VM_ASSERT_TYPE2(klass, T_CLASS, T_ICLASS);
428 if (rb_objspace_garbage_object_p(klass)) return;
429
430 RB_VM_LOCKING() {
431 rb_vm_barrier();
432
433 if (LIKELY(RCLASS_SUBCLASSES_FIRST(klass) == NULL)) {
434 // no subclasses
435 // check only current class
436
437 // invalidate CCs
438 VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass);
439 invalidate_method_cache_in_cc_table(cc_tbl, mid);
440 if (RCLASS_CC_TBL_NOT_PRIME_P(klass, cc_tbl)) {
441 invalidate_method_cache_in_cc_table(RCLASS_PRIME_CC_TBL(klass), mid);
442 }
443
444 // remove from callable_m_tbl, if exists
445 struct rb_id_table *cm_tbl = RCLASS_WRITABLE_CALLABLE_M_TBL(klass);
446 invalidate_callable_method_entry_in_callable_m_table(cm_tbl, mid);
447 if (RCLASS_CALLABLE_M_TBL_NOT_PRIME_P(klass, cm_tbl)) {
448 invalidate_callable_method_entry_in_callable_m_table(RCLASS_PRIME_CALLABLE_M_TBL(klass), mid);
449 }
450
451 RB_DEBUG_COUNTER_INC(cc_invalidate_leaf);
452 }
453 else {
454 const rb_callable_method_entry_t *cme = complemented_callable_method_entry(klass, mid);
455
456 if (cme) {
457 // invalidate cme if found to invalidate the inline method cache.
458 if (METHOD_ENTRY_CACHED(cme)) {
459 if (METHOD_ENTRY_COMPLEMENTED(cme)) {
460 // do nothing
461 }
462 else {
463 // invalidate cc by invalidating cc->cme
464 VALUE owner = cme->owner;
465 VM_ASSERT_TYPE(owner, T_CLASS);
466 VALUE klass_housing_cme;
467 if (cme->def->type == VM_METHOD_TYPE_REFINED && !cme->def->body.refined.orig_me) {
468 klass_housing_cme = owner;
469 }
470 else {
471 klass_housing_cme = RCLASS_ORIGIN(owner);
472 }
473
474 // replace the cme that will be invalid in the all classexts
475 invalidate_callable_method_entry_in_every_m_table(klass_housing_cme, mid, cme);
476 }
477
478 vm_cme_invalidate((rb_callable_method_entry_t *)cme);
479 RB_DEBUG_COUNTER_INC(cc_invalidate_tree_cme);
480
481 // In case of refinement ME, also invalidate the wrapped ME that
482 // could be cached at some callsite and is unreachable from any
483 // RCLASS_WRITABLE_CC_TBL.
484 if (cme->def->type == VM_METHOD_TYPE_REFINED && cme->def->body.refined.orig_me) {
485 vm_cme_invalidate((rb_callable_method_entry_t *)cme->def->body.refined.orig_me);
486 }
487
488 if (cme->def->iseq_overload) {
489 rb_callable_method_entry_t *monly_cme = (rb_callable_method_entry_t *)lookup_overloaded_cme(cme);
490 if (monly_cme) {
491 vm_cme_invalidate(monly_cme);
492 }
493 }
494 }
495
496 // invalidate complement tbl
497 if (METHOD_ENTRY_COMPLEMENTED(cme)) {
498 VALUE defined_class = cme->defined_class;
499 struct rb_id_table *cm_tbl = RCLASS_WRITABLE_CALLABLE_M_TBL(defined_class);
500 invalidate_complemented_method_entry_in_callable_m_table(cm_tbl, mid);
501 if (RCLASS_CALLABLE_M_TBL_NOT_PRIME_P(defined_class, cm_tbl)) {
502 struct rb_id_table *prime_cm_table = RCLASS_PRIME_CALLABLE_M_TBL(defined_class);
503 invalidate_complemented_method_entry_in_callable_m_table(prime_cm_table, mid);
504 }
505 }
506
507 RB_DEBUG_COUNTER_INC(cc_invalidate_tree);
508 }
509 else {
510 invalidate_negative_cache(mid);
511 }
512 }
513
514 rb_gccct_clear_table(Qnil);
515 }
516}
517
518static void
519clear_iclass_method_cache_by_id(VALUE iclass, VALUE d)
520{
521 VM_ASSERT_TYPE(iclass, T_ICLASS);
522 ID mid = (ID)d;
523 clear_method_cache_by_id_in_class(iclass, mid);
524}
525
526static void
527clear_iclass_method_cache_by_id_for_refinements(VALUE klass, VALUE d)
528{
529 if (RB_TYPE_P(klass, T_ICLASS)) {
530 ID mid = (ID)d;
531 clear_method_cache_by_id_in_class(klass, mid);
532 }
533}
534
535void
536rb_clear_method_cache(VALUE klass_or_module, ID mid)
537{
538 if (RB_TYPE_P(klass_or_module, T_MODULE)) {
539 VALUE module = klass_or_module; // alias
540
541 if (FL_TEST(module, RMODULE_IS_REFINEMENT)) {
542 VALUE refined_class = rb_refinement_module_get_refined_class(module);
543 rb_clear_method_cache(refined_class, mid);
544 rb_class_foreach_subclass(refined_class, clear_iclass_method_cache_by_id_for_refinements, mid);
545 rb_clear_all_refinement_method_cache();
546 }
547 rb_class_foreach_subclass(module, clear_iclass_method_cache_by_id, mid);
548 }
549 else {
550 clear_method_cache_by_id_in_class(klass_or_module, mid);
551 }
552}
553
554static enum rb_id_table_iterator_result
555invalidate_method_entry_in_iclass_callable_m_tbl(VALUE cme, void *data)
556{
557 vm_cme_invalidate((rb_callable_method_entry_t *)cme);
558 return ID_TABLE_DELETE;
559}
560
561static enum rb_id_table_iterator_result
562invalidate_ccs_in_iclass_cc_tbl(VALUE value, void *data)
563{
564 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)value;
565 vm_cme_invalidate((rb_callable_method_entry_t *)ccs->cme);
566 xfree(ccs);
567 return ID_TABLE_DELETE;
568}
569
570void
571rb_invalidate_method_caches(struct rb_id_table *cm_tbl, VALUE cc_tbl)
572{
573 if (cm_tbl) {
574 rb_id_table_foreach_values(cm_tbl, invalidate_method_entry_in_iclass_callable_m_tbl, NULL);
575 }
576 if (cc_tbl) {
577 rb_managed_id_table_foreach_values(cc_tbl, invalidate_ccs_in_iclass_cc_tbl, NULL);
578 }
579}
580
581static int
582invalidate_cc_refinement(st_data_t key, st_data_t data)
583{
584 VALUE v = (VALUE)key;
585 void *ptr = rb_asan_poisoned_object_p(v);
586 rb_asan_unpoison_object(v, false);
587
588 if (rb_gc_pointer_to_heap_p(v) &&
589 !rb_objspace_garbage_object_p(v) &&
590 RBASIC(v)->flags) { // liveness check
591 const struct rb_callcache *cc = (const struct rb_callcache *)v;
592
593 VM_ASSERT(vm_cc_refinement_p(cc));
594
595 if (vm_cc_valid(cc)) {
596 vm_cc_invalidate(cc);
597 }
598 }
599
600 if (ptr) {
601 rb_asan_poison_object(v);
602 }
603
604 return ST_CONTINUE;
605}
606
607static st_index_t
608vm_ci_hash(VALUE v)
609{
610 const struct rb_callinfo *ci = (const struct rb_callinfo *)v;
611 st_index_t h;
612 h = rb_hash_start(ci->mid);
613 h = rb_hash_uint(h, ci->flag);
614 h = rb_hash_uint(h, ci->argc);
615 if (ci->kwarg) {
616 for (int i = 0; i < ci->kwarg->keyword_len; i++) {
617 h = rb_hash_uint(h, ci->kwarg->keywords[i]);
618 }
619 }
620 return h;
621}
622
623static int
624vm_ci_hash_cmp(VALUE v1, VALUE v2)
625{
626 const struct rb_callinfo *ci1 = (const struct rb_callinfo *)v1;
627 const struct rb_callinfo *ci2 = (const struct rb_callinfo *)v2;
628 if (ci1->mid != ci2->mid) return 1;
629 if (ci1->flag != ci2->flag) return 1;
630 if (ci1->argc != ci2->argc) return 1;
631 if (ci1->kwarg != NULL) {
632 VM_ASSERT(ci2->kwarg != NULL); // implied by matching flags
633
634 if (ci1->kwarg->keyword_len != ci2->kwarg->keyword_len)
635 return 1;
636
637 for (int i = 0; i < ci1->kwarg->keyword_len; i++) {
638 if (ci1->kwarg->keywords[i] != ci2->kwarg->keywords[i]) {
639 return 1;
640 }
641 }
642 }
643 else {
644 VM_ASSERT(ci2->kwarg == NULL); // implied by matching flags
645 }
646 return 0;
647}
648
649static const struct st_hash_type vm_ci_hashtype = {
650 vm_ci_hash_cmp,
651 vm_ci_hash
652};
653
654static int
655ci_lookup_i(st_data_t *key, st_data_t *value, st_data_t data, int existing)
656{
657 const struct rb_callinfo *ci = (const struct rb_callinfo *)*key;
658 st_data_t *ret = (st_data_t *)data;
659
660 if (existing) {
661 if (rb_objspace_garbage_object_p((VALUE)ci)) {
662 *ret = (st_data_t)NULL;
663 return ST_DELETE;
664 }
665 else {
666 *ret = *key;
667 return ST_STOP;
668 }
669 }
670 else {
671 *key = *value = *ret = (st_data_t)ci;
672 return ST_CONTINUE;
673 }
674}
675
676const struct rb_callinfo *
677rb_vm_ci_lookup(ID mid, unsigned int flag, unsigned int argc, const struct rb_callinfo_kwarg *kwarg)
678{
679 rb_vm_t *vm = GET_VM();
680 const struct rb_callinfo *ci = NULL;
681
682 if (kwarg) {
683 ((struct rb_callinfo_kwarg *)kwarg)->references++;
684 }
685
686 struct rb_callinfo *new_ci = SHAREABLE_IMEMO_NEW(struct rb_callinfo, imemo_callinfo, (VALUE)kwarg);
687 new_ci->mid = mid;
688 new_ci->flag = flag;
689 new_ci->argc = argc;
690
691 RB_VM_LOCKING() {
692 st_table *ci_table = vm->ci_table;
693 VM_ASSERT(ci_table);
694
695 do {
696 st_update(ci_table, (st_data_t)new_ci, ci_lookup_i, (st_data_t)&ci);
697 } while (ci == NULL);
698 }
699
700 VM_ASSERT(ci);
701
702 return ci;
703}
704
705void
706rb_vm_ci_free(const struct rb_callinfo *ci)
707{
708 ASSERT_vm_locking();
709
710 rb_vm_t *vm = GET_VM();
711
712 st_data_t key = (st_data_t)ci;
713 st_delete(vm->ci_table, &key, NULL);
714}
715
716void
717rb_vm_insert_cc_refinement(const struct rb_callcache *cc)
718{
719 st_data_t key = (st_data_t)cc;
720
721 rb_vm_t *vm = GET_VM();
722 RB_VM_LOCK_ENTER();
723 {
724 rb_set_insert(vm->cc_refinement_table, key);
725 }
726 RB_VM_LOCK_LEAVE();
727}
728
729void
730rb_vm_delete_cc_refinement(const struct rb_callcache *cc)
731{
732 ASSERT_vm_locking();
733
734 rb_vm_t *vm = GET_VM();
735 st_data_t key = (st_data_t)cc;
736
737 rb_set_table_delete(vm->cc_refinement_table, &key);
738}
739
740void
741rb_clear_all_refinement_method_cache(void)
742{
743 rb_vm_t *vm = GET_VM();
744
745 RB_VM_LOCK_ENTER();
746 {
747 rb_set_table_foreach(vm->cc_refinement_table, invalidate_cc_refinement, (st_data_t)NULL);
748 rb_set_table_clear(vm->cc_refinement_table);
749 rb_set_compact_table(vm->cc_refinement_table);
750 }
751 RB_VM_LOCK_LEAVE();
752
753 rb_yjit_invalidate_all_method_lookup_assumptions();
754}
755
756void
757rb_method_table_insert(VALUE klass, struct rb_id_table *table, ID method_id, const rb_method_entry_t *me)
758{
759 RB_VM_LOCKING() {
760 rb_method_table_insert0(klass, table, method_id, me, RB_TYPE_P(klass, T_ICLASS) && !RICLASS_OWNS_M_TBL_P(klass));
761 }
762}
763
764void
765rb_method_table_insert0(VALUE klass, struct rb_id_table *table, ID method_id, const rb_method_entry_t *me, bool iclass_shared_mtbl)
766{
767 VALUE table_owner = klass;
768 if (iclass_shared_mtbl) {
769 table_owner = RBASIC(table_owner)->klass;
770 }
771 VM_ASSERT_TYPE3(table_owner, T_CLASS, T_ICLASS, T_MODULE);
772 rb_id_table_insert(table, method_id, (VALUE)me);
773 RB_OBJ_WRITTEN(table_owner, Qundef, (VALUE)me);
774}
775
776// rb_f_notimplement has an extra trailing argument to distinguish it from other methods
777// at compile-time to override arity to be -1. But the trailing argument introduces a
778// signature mismatch between caller and callee, so rb_define_method family inserts a
779// method entry with rb_f_notimplement_internal, which has canonical arity=-1 signature,
780// instead of rb_f_notimplement.
781NORETURN(static VALUE rb_f_notimplement_internal(int argc, const VALUE *argv, VALUE obj));
782
783static VALUE
784rb_f_notimplement_internal(int argc, const VALUE *argv, VALUE obj)
785{
787
789}
790
791VALUE
792rb_f_notimplement(int argc, const VALUE *argv, VALUE obj, VALUE marker)
793{
794 rb_f_notimplement_internal(argc, argv, obj);
795}
796
797static void
798rb_define_notimplement_method_id(VALUE mod, ID id, rb_method_visibility_t visi)
799{
800 rb_add_method(mod, id, VM_METHOD_TYPE_NOTIMPLEMENTED, (void *)1, visi);
801}
802
803void
804rb_add_method_cfunc(VALUE klass, ID mid, VALUE (*func)(ANYARGS), int argc, rb_method_visibility_t visi)
805{
806 if (argc < -2 || 15 < argc) rb_raise(rb_eArgError, "arity out of range: %d for -2..15", argc);
807 if (func != (VALUE(*)(ANYARGS))rb_f_notimplement) {
809 opt.func = func;
810 opt.argc = argc;
811 rb_add_method(klass, mid, VM_METHOD_TYPE_CFUNC, &opt, visi);
812 }
813 else {
814 rb_define_notimplement_method_id(klass, mid, visi);
815 }
816}
817
818void
819rb_add_method_optimized(VALUE klass, ID mid, enum method_optimized_type opt_type, unsigned int index, rb_method_visibility_t visi)
820{
822 .type = opt_type,
823 .index = index,
824 };
825 rb_add_method(klass, mid, VM_METHOD_TYPE_OPTIMIZED, &opt, visi);
826}
827
828static void
829rb_method_definition_release(rb_method_definition_t *def)
830{
831 if (def != NULL) {
832 const unsigned int reference_count_was = RUBY_ATOMIC_FETCH_SUB(def->reference_count, 1);
833
834 RUBY_ASSERT_ALWAYS(reference_count_was != 0);
835
836 if (reference_count_was == 1) {
837 if (METHOD_DEBUG) fprintf(stderr, "-%p-%s:1->0 (remove)\n", (void *)def,
838 rb_id2name(def->original_id));
839 if (def->type == VM_METHOD_TYPE_BMETHOD && def->body.bmethod.hooks) {
840 xfree(def->body.bmethod.hooks);
841 }
842 xfree(def);
843 }
844 else {
845 if (METHOD_DEBUG) fprintf(stderr, "-%p-%s:%d->%d (dec)\n", (void *)def, rb_id2name(def->original_id),
846 reference_count_was, reference_count_was - 1);
847 }
848 }
849}
850
851static void delete_overloaded_cme(const rb_callable_method_entry_t *cme);
852
853void
854rb_free_method_entry_vm_weak_references(const rb_method_entry_t *me)
855{
856 if (me->def && me->def->iseq_overload) {
857 delete_overloaded_cme((const rb_callable_method_entry_t *)me);
858 }
859}
860
861void
862rb_free_method_entry(const rb_method_entry_t *me)
863{
864#if USE_ZJIT
865 if (METHOD_ENTRY_CACHED(me)) {
866 rb_zjit_cme_free((const rb_callable_method_entry_t *)me);
867 }
868#endif
869
870#if USE_YJIT
871 // YJIT rb_yjit_root_mark() roots CMEs in `Invariants`,
872 // to remove from `Invariants` here.
873#endif
874
875 rb_method_definition_release(me->def);
876}
877
878static inline rb_method_entry_t *search_method(VALUE klass, ID id, VALUE *defined_class_ptr);
879extern int rb_method_definition_eq(const rb_method_definition_t *d1, const rb_method_definition_t *d2);
880
881static VALUE
882(*call_cfunc_invoker_func(int argc))(VALUE recv, int argc, const VALUE *, VALUE (*func)(ANYARGS))
883{
884 if (!GET_THREAD()->ext_config.ractor_safe) {
885 switch (argc) {
886 case -2: return &call_cfunc_m2;
887 case -1: return &call_cfunc_m1;
888 case 0: return &call_cfunc_0;
889 case 1: return &call_cfunc_1;
890 case 2: return &call_cfunc_2;
891 case 3: return &call_cfunc_3;
892 case 4: return &call_cfunc_4;
893 case 5: return &call_cfunc_5;
894 case 6: return &call_cfunc_6;
895 case 7: return &call_cfunc_7;
896 case 8: return &call_cfunc_8;
897 case 9: return &call_cfunc_9;
898 case 10: return &call_cfunc_10;
899 case 11: return &call_cfunc_11;
900 case 12: return &call_cfunc_12;
901 case 13: return &call_cfunc_13;
902 case 14: return &call_cfunc_14;
903 case 15: return &call_cfunc_15;
904 default:
905 rb_bug("unsupported length: %d", argc);
906 }
907 }
908 else {
909 switch (argc) {
910 case -2: return &ractor_safe_call_cfunc_m2;
911 case -1: return &ractor_safe_call_cfunc_m1;
912 case 0: return &ractor_safe_call_cfunc_0;
913 case 1: return &ractor_safe_call_cfunc_1;
914 case 2: return &ractor_safe_call_cfunc_2;
915 case 3: return &ractor_safe_call_cfunc_3;
916 case 4: return &ractor_safe_call_cfunc_4;
917 case 5: return &ractor_safe_call_cfunc_5;
918 case 6: return &ractor_safe_call_cfunc_6;
919 case 7: return &ractor_safe_call_cfunc_7;
920 case 8: return &ractor_safe_call_cfunc_8;
921 case 9: return &ractor_safe_call_cfunc_9;
922 case 10: return &ractor_safe_call_cfunc_10;
923 case 11: return &ractor_safe_call_cfunc_11;
924 case 12: return &ractor_safe_call_cfunc_12;
925 case 13: return &ractor_safe_call_cfunc_13;
926 case 14: return &ractor_safe_call_cfunc_14;
927 case 15: return &ractor_safe_call_cfunc_15;
928 default:
929 rb_bug("unsupported length: %d", argc);
930 }
931 }
932}
933
934static void
935setup_method_cfunc_struct(rb_method_cfunc_t *cfunc, VALUE (*func)(ANYARGS), int argc)
936{
937 cfunc->func = func;
938 cfunc->argc = argc;
939 cfunc->invoker = call_cfunc_invoker_func(argc);
940}
941
943method_definition_addref(rb_method_definition_t *def, bool complemented)
944{
945 unsigned int reference_count_was = RUBY_ATOMIC_FETCH_ADD(def->reference_count, 1);
946 if (!complemented && reference_count_was > 0) {
947 /* TODO: A Ractor can reach this via UnboundMethod#bind */
948 def->aliased = true;
949 }
950 if (METHOD_DEBUG) fprintf(stderr, "+%p-%s:%d->%d\n", (void *)def, rb_id2name(def->original_id), reference_count_was, reference_count_was+1);
951
952 return def;
953}
954
955void
956rb_method_definition_set(const rb_method_entry_t *me, rb_method_definition_t *def, void *opts)
957{
958 rb_method_definition_release(me->def);
959 *(rb_method_definition_t **)&me->def = method_definition_addref(def, METHOD_ENTRY_COMPLEMENTED(me));
960
961 if (!ruby_running) add_opt_method_entry(me);
962
963 if (opts != NULL) {
964 switch (def->type) {
965 case VM_METHOD_TYPE_ISEQ:
966 {
967 rb_method_iseq_t *iseq_body = (rb_method_iseq_t *)opts;
968 const rb_iseq_t *iseq = iseq_body->iseqptr;
969 rb_cref_t *method_cref, *cref = iseq_body->cref;
970
971 /* setup iseq first (before invoking GC) */
972 RB_OBJ_WRITE(me, &def->body.iseq.iseqptr, iseq);
973
974 // Methods defined in `with_jit` should be considered METHOD_ENTRY_BASIC
975 if (rb_iseq_attr_p(iseq, BUILTIN_ATTR_C_TRACE)) {
976 METHOD_ENTRY_BASIC_SET((rb_method_entry_t *)me, TRUE);
977 }
978
979 if (ISEQ_BODY(iseq)->mandatory_only_iseq) def->iseq_overload = 1;
980
981 if (0) vm_cref_dump("rb_method_definition_create", cref);
982
983 if (cref) {
984 method_cref = cref;
985 }
986 else {
987 method_cref = vm_cref_new_toplevel(GET_EC()); /* TODO: can we reuse? */
988 }
989
990 RB_OBJ_WRITE(me, &def->body.iseq.cref, method_cref);
991 return;
992 }
993 case VM_METHOD_TYPE_CFUNC:
994 {
995 rb_method_cfunc_t *cfunc = (rb_method_cfunc_t *)opts;
996 setup_method_cfunc_struct(UNALIGNED_MEMBER_PTR(def, body.cfunc), cfunc->func, cfunc->argc);
997 return;
998 }
999 case VM_METHOD_TYPE_ATTRSET:
1000 case VM_METHOD_TYPE_IVAR:
1001 {
1002 const rb_execution_context_t *ec = GET_EC();
1003 rb_control_frame_t *cfp;
1004 int line;
1005
1006 def->body.attr.id = (ID)(VALUE)opts;
1007
1008 cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1009
1010 if (cfp && (line = rb_vm_get_sourceline(cfp))) {
1011 VALUE location = rb_ary_new3(2, rb_iseq_path(cfp->iseq), INT2FIX(line));
1012 rb_ary_freeze(location);
1013 RB_OBJ_SET_SHAREABLE(location);
1014 RB_OBJ_WRITE(me, &def->body.attr.location, location);
1015 }
1016 else {
1017 VM_ASSERT(def->body.attr.location == 0);
1018 }
1019 return;
1020 }
1021 case VM_METHOD_TYPE_BMETHOD:
1022 RB_OBJ_WRITE(me, &def->body.bmethod.proc, (VALUE)opts);
1023 RB_OBJ_WRITE(me, &def->body.bmethod.defined_ractor, rb_ractor_self(GET_RACTOR()));
1024 return;
1025 case VM_METHOD_TYPE_NOTIMPLEMENTED:
1026 setup_method_cfunc_struct(UNALIGNED_MEMBER_PTR(def, body.cfunc), (VALUE(*)(ANYARGS))rb_f_notimplement_internal, -1);
1027 return;
1028 case VM_METHOD_TYPE_OPTIMIZED:
1029 def->body.optimized = *(rb_method_optimized_t *)opts;
1030 return;
1031 case VM_METHOD_TYPE_REFINED:
1032 {
1033 RB_OBJ_WRITE(me, &def->body.refined.orig_me, (rb_method_entry_t *)opts);
1034 return;
1035 }
1036 case VM_METHOD_TYPE_ALIAS:
1037 RB_OBJ_WRITE(me, &def->body.alias.original_me, (rb_method_entry_t *)opts);
1038 return;
1039 case VM_METHOD_TYPE_ZSUPER:
1040 case VM_METHOD_TYPE_UNDEF:
1041 case VM_METHOD_TYPE_MISSING:
1042 return;
1043 }
1044 }
1045}
1046
1047static void
1048method_definition_reset(const rb_method_entry_t *me)
1049{
1050 rb_method_definition_t *def = me->def;
1051
1052 switch (def->type) {
1053 case VM_METHOD_TYPE_ISEQ:
1054 RB_OBJ_WRITTEN(me, Qundef, def->body.iseq.iseqptr);
1055 RB_OBJ_WRITTEN(me, Qundef, def->body.iseq.cref);
1056 break;
1057 case VM_METHOD_TYPE_ATTRSET:
1058 case VM_METHOD_TYPE_IVAR:
1059 RB_OBJ_WRITTEN(me, Qundef, def->body.attr.location);
1060 break;
1061 case VM_METHOD_TYPE_BMETHOD:
1062 RB_OBJ_WRITTEN(me, Qundef, def->body.bmethod.proc);
1063 RB_OBJ_WRITTEN(me, Qundef, def->body.bmethod.defined_ractor);
1064 /* give up to check all in a list */
1065 if (def->body.bmethod.hooks) rb_gc_writebarrier_remember((VALUE)me);
1066 break;
1067 case VM_METHOD_TYPE_REFINED:
1068 RB_OBJ_WRITTEN(me, Qundef, def->body.refined.orig_me);
1069 break;
1070 case VM_METHOD_TYPE_ALIAS:
1071 RB_OBJ_WRITTEN(me, Qundef, def->body.alias.original_me);
1072 break;
1073 case VM_METHOD_TYPE_CFUNC:
1074 case VM_METHOD_TYPE_ZSUPER:
1075 case VM_METHOD_TYPE_MISSING:
1076 case VM_METHOD_TYPE_OPTIMIZED:
1077 case VM_METHOD_TYPE_UNDEF:
1078 case VM_METHOD_TYPE_NOTIMPLEMENTED:
1079 break;
1080 }
1081}
1082
1083static rb_atomic_t method_serial = 1;
1084
1086rb_method_definition_create(rb_method_type_t type, ID mid)
1087{
1090 def->type = type;
1091 def->original_id = mid;
1092 def->method_serial = (uintptr_t)RUBY_ATOMIC_FETCH_ADD(method_serial, 1);
1093 def->box = rb_current_box();
1094 return def;
1095}
1096
1097static rb_method_entry_t *
1098rb_method_entry_alloc(ID called_id, VALUE owner, VALUE defined_class, rb_method_definition_t *def, bool complement)
1099{
1100 if (def) method_definition_addref(def, complement);
1101 if (RTEST(defined_class)) {
1102 // not negative cache
1103 VM_ASSERT_TYPE2(defined_class, T_CLASS, T_ICLASS);
1104 }
1105 rb_method_entry_t *me = SHAREABLE_IMEMO_NEW(rb_method_entry_t, imemo_ment, defined_class);
1106 *((rb_method_definition_t **)&me->def) = def;
1107 me->called_id = called_id;
1108 me->owner = owner;
1109
1110 return me;
1111}
1112
1113static VALUE
1114filter_defined_class(VALUE klass)
1115{
1116 switch (BUILTIN_TYPE(klass)) {
1117 case T_CLASS:
1118 return klass;
1119 case T_MODULE:
1120 return 0;
1121 case T_ICLASS:
1122 break;
1123 default:
1124 break;
1125 }
1126 rb_bug("filter_defined_class: %s", rb_obj_info(klass));
1127}
1128
1130rb_method_entry_create(ID called_id, VALUE klass, rb_method_visibility_t visi, rb_method_definition_t *def)
1131{
1132 rb_method_entry_t *me = rb_method_entry_alloc(called_id, klass, filter_defined_class(klass), def, false);
1133 METHOD_ENTRY_FLAGS_SET(me, visi, ruby_running ? FALSE : TRUE);
1134 if (def != NULL) method_definition_reset(me);
1135 return me;
1136}
1137
1138// Return a cloned ME that's not invalidated (MEs are disposable for caching).
1139const rb_method_entry_t *
1140rb_method_entry_clone(const rb_method_entry_t *src_me)
1141{
1142 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));
1143
1144 METHOD_ENTRY_FLAGS_COPY(me, src_me);
1145
1146 // Also clone inner ME in case of refinement ME
1147 if (src_me->def &&
1148 src_me->def->type == VM_METHOD_TYPE_REFINED &&
1149 src_me->def->body.refined.orig_me) {
1150 const rb_method_entry_t *orig_me = src_me->def->body.refined.orig_me;
1151 VM_ASSERT(orig_me->def->type != VM_METHOD_TYPE_REFINED);
1152
1153 rb_method_entry_t *orig_clone = rb_method_entry_alloc(orig_me->called_id,
1154 orig_me->owner, orig_me->defined_class, orig_me->def, METHOD_ENTRY_COMPLEMENTED(orig_me));
1155 METHOD_ENTRY_FLAGS_COPY(orig_clone, orig_me);
1156
1157 // Clone definition, since writing a VALUE to a shared definition
1158 // can create reference edges we can't run WBs for.
1159 rb_method_definition_t *clone_def =
1160 rb_method_definition_create(VM_METHOD_TYPE_REFINED, src_me->called_id);
1161 rb_method_definition_set(me, clone_def, orig_clone);
1162 }
1163 return me;
1164}
1165
1167rb_method_entry_complement_defined_class(const rb_method_entry_t *src_me, ID called_id, VALUE defined_class)
1168{
1169 rb_method_definition_t *def = src_me->def;
1171 const rb_method_entry_t *refined_orig_me = NULL;
1172
1173 if (!src_me->defined_class &&
1174 def->type == VM_METHOD_TYPE_REFINED &&
1175 def->body.refined.orig_me) {
1176 const rb_method_entry_t *orig_me =
1177 rb_method_entry_clone(def->body.refined.orig_me);
1178 RB_OBJ_WRITE((VALUE)orig_me, &orig_me->defined_class, defined_class);
1179 refined_orig_me = orig_me;
1180 def = NULL;
1181 }
1182
1183 me = rb_method_entry_alloc(called_id, src_me->owner, defined_class, def, true);
1184 METHOD_ENTRY_FLAGS_COPY(me, src_me);
1185 METHOD_ENTRY_COMPLEMENTED_SET(me);
1186 if (!def) {
1187 def = rb_method_definition_create(VM_METHOD_TYPE_REFINED, called_id);
1188 rb_method_definition_set(me, def, (void *)refined_orig_me);
1189 }
1190
1191 VM_ASSERT_TYPE(me->owner, T_MODULE);
1192
1193 return (rb_callable_method_entry_t *)me;
1194}
1195
1196void
1197rb_method_entry_copy(rb_method_entry_t *dst, const rb_method_entry_t *src)
1198{
1199 rb_method_definition_release(dst->def);
1200 *(rb_method_definition_t **)&dst->def = method_definition_addref(src->def, METHOD_ENTRY_COMPLEMENTED(src));
1201 method_definition_reset(dst);
1202 dst->called_id = src->called_id;
1203 RB_OBJ_WRITE((VALUE)dst, &dst->owner, src->owner);
1204 RB_OBJ_WRITE((VALUE)dst, &dst->defined_class, src->defined_class);
1205 METHOD_ENTRY_FLAGS_COPY(dst, src);
1206}
1207
1208static void
1209make_method_entry_refined(VALUE owner, rb_method_entry_t *me)
1210{
1211 if (me->def->type == VM_METHOD_TYPE_REFINED) {
1212 return;
1213 }
1214 else {
1216
1217 rb_vm_check_redefinition_opt_method(me, me->owner);
1218
1219 struct rb_method_entry_struct *orig_me =
1220 rb_method_entry_alloc(me->called_id,
1221 me->owner,
1222 me->defined_class,
1223 me->def,
1224 true);
1225 METHOD_ENTRY_FLAGS_COPY(orig_me, me);
1226
1227 def = rb_method_definition_create(VM_METHOD_TYPE_REFINED, me->called_id);
1228 rb_method_definition_set(me, def, orig_me);
1229 METHOD_ENTRY_VISI_SET(me, METHOD_VISI_PUBLIC);
1230 }
1231}
1232
1233static inline rb_method_entry_t *
1234lookup_method_table(VALUE klass, ID id)
1235{
1236 st_data_t body;
1237 struct rb_id_table *m_tbl = RCLASS_M_TBL(klass);
1238
1239 if (rb_id_table_lookup(m_tbl, id, &body)) {
1240 return (rb_method_entry_t *) body;
1241 }
1242 else {
1243 return 0;
1244 }
1245}
1246
1247void
1248rb_add_refined_method_entry(VALUE refined_class, ID mid)
1249{
1250 rb_method_entry_t *me = lookup_method_table(refined_class, mid);
1251
1252 if (me) {
1253 make_method_entry_refined(refined_class, me);
1254 rb_clear_method_cache(refined_class, mid);
1255 }
1256 else {
1257 rb_add_method(refined_class, mid, VM_METHOD_TYPE_REFINED, 0, METHOD_VISI_PUBLIC);
1258 }
1259}
1260
1261static void
1262check_override_opt_method_i(VALUE klass, VALUE arg)
1263{
1264 ID mid = (ID)arg;
1265 const rb_method_entry_t *me, *newme;
1266
1267 if (vm_redefinition_check_flag(klass)) {
1268 me = lookup_method_table(RCLASS_ORIGIN(klass), mid);
1269 if (me) {
1270 newme = rb_method_entry(klass, mid);
1271 if (newme != me) rb_vm_check_redefinition_opt_method(me, me->owner);
1272 }
1273 }
1274 rb_class_foreach_subclass(klass, check_override_opt_method_i, (VALUE)mid);
1275}
1276
1277static void
1278check_override_opt_method(VALUE klass, VALUE mid)
1279{
1280 if (rb_vm_check_optimizable_mid(mid)) {
1281 check_override_opt_method_i(klass, mid);
1282 }
1283}
1284
1285/*
1286 * klass->method_table[mid] = method_entry(defined_class, visi, def)
1287 *
1288 * If def is given (!= NULL), then just use it and ignore original_id and otps.
1289 * If not given, then make a new def with original_id and opts.
1290 */
1291static rb_method_entry_t *
1292rb_method_entry_make(VALUE klass, ID mid, VALUE defined_class, rb_method_visibility_t visi,
1293 rb_method_type_t type, rb_method_definition_t *def, ID original_id, void *opts)
1294{
1296 struct rb_id_table *mtbl;
1297 st_data_t data;
1298 int make_refined = 0;
1299 VALUE orig_klass;
1300
1301 if (NIL_P(klass)) {
1302 klass = rb_cObject;
1303 }
1304 orig_klass = klass;
1305
1306 if (!RCLASS_SINGLETON_P(klass) &&
1307 type != VM_METHOD_TYPE_NOTIMPLEMENTED &&
1308 type != VM_METHOD_TYPE_ZSUPER) {
1309 switch (mid) {
1310 case idInitialize:
1311 case idInitialize_copy:
1312 case idInitialize_clone:
1313 case idInitialize_dup:
1314 case idRespond_to_missing:
1315 visi = METHOD_VISI_PRIVATE;
1316 }
1317 }
1318
1319 if (type != VM_METHOD_TYPE_REFINED) {
1320 rb_class_modify_check(klass);
1321 }
1322
1323 if (RB_TYPE_P(klass, T_MODULE) && FL_TEST(klass, RMODULE_IS_REFINEMENT)) {
1324 VALUE refined_class = rb_refinement_module_get_refined_class(klass);
1325 rb_add_refined_method_entry(refined_class, mid);
1326 }
1327 if (type == VM_METHOD_TYPE_REFINED) {
1328 rb_method_entry_t *old_me = lookup_method_table(RCLASS_ORIGIN(klass), mid);
1329 if (old_me) rb_vm_check_redefinition_opt_method(old_me, klass);
1330 }
1331 else {
1332 klass = RCLASS_ORIGIN(klass);
1333 if (klass != orig_klass) {
1334 rb_clear_method_cache(orig_klass, mid);
1335 }
1336 }
1337 mtbl = RCLASS_WRITABLE_M_TBL(klass);
1338
1339 /* check re-definition */
1340 if (rb_id_table_lookup(mtbl, mid, &data)) {
1341 rb_method_entry_t *old_me = (rb_method_entry_t *)data;
1342 rb_method_definition_t *old_def = old_me->def;
1343
1344 if (rb_method_definition_eq(old_def, def)) return old_me;
1345 rb_vm_check_redefinition_opt_method(old_me, klass);
1346
1347 if (old_def->type == VM_METHOD_TYPE_REFINED) make_refined = 1;
1348
1349 if (RTEST(ruby_verbose) &&
1350 type != VM_METHOD_TYPE_UNDEF &&
1351 (old_def->aliased == false) &&
1352 (!old_def->no_redef_warning) &&
1353 !make_refined &&
1354 old_def->type != VM_METHOD_TYPE_UNDEF &&
1355 old_def->type != VM_METHOD_TYPE_ZSUPER &&
1356 old_def->type != VM_METHOD_TYPE_ALIAS) {
1357 const rb_iseq_t *iseq = 0;
1358
1359 switch (old_def->type) {
1360 case VM_METHOD_TYPE_ISEQ:
1361 iseq = def_iseq_ptr(old_def);
1362 break;
1363 case VM_METHOD_TYPE_BMETHOD:
1364 iseq = rb_proc_get_iseq(old_def->body.bmethod.proc, 0);
1365 break;
1366 default:
1367 break;
1368 }
1369 if (iseq) {
1370 rb_warning(
1371 "method redefined; discarding old %"PRIsVALUE"\n%s:%d: warning: previous definition of %"PRIsVALUE" was here",
1372 rb_id2str(mid),
1373 RSTRING_PTR(rb_iseq_path(iseq)),
1374 ISEQ_BODY(iseq)->location.first_lineno,
1375 rb_id2str(old_def->original_id)
1376 );
1377 }
1378 else {
1379 rb_warning("method redefined; discarding old %"PRIsVALUE, rb_id2str(mid));
1380 }
1381 }
1382 }
1383
1384 /* create method entry */
1385 me = rb_method_entry_create(mid, defined_class, visi, NULL);
1386 if (def == NULL) {
1387 def = rb_method_definition_create(type, original_id);
1388 }
1389 rb_method_definition_set(me, def, opts);
1390
1391 rb_clear_method_cache(klass, mid);
1392
1393 /* check mid */
1394 if (klass == rb_cObject) {
1395 switch (mid) {
1396 case idInitialize:
1397 case idRespond_to_missing:
1398 case idMethodMissing:
1399 case idRespond_to:
1400 rb_warn("redefining Object#%s may cause infinite loop", rb_id2name(mid));
1401 }
1402 }
1403 /* check mid */
1404 if (mid == object_id || mid == id__id__ || mid == id__send__) {
1405 if (type != VM_METHOD_TYPE_CFUNC && search_method(klass, mid, 0)) {
1406 rb_warn("redefining '%s' may cause serious problems", rb_id2name(mid));
1407 }
1408 }
1409
1410 if (make_refined) {
1411 make_method_entry_refined(klass, me);
1412 }
1413
1414 rb_method_table_insert(klass, mtbl, mid, me);
1415
1416 VM_ASSERT(me->def != NULL);
1417
1418 /* check optimized method override by a prepended module */
1419 if (RB_TYPE_P(orig_klass, T_MODULE)) {
1420 check_override_opt_method(klass, (VALUE)mid);
1421 }
1422
1423 return me;
1424}
1425
1426static st_table *
1427overloaded_cme_table(void)
1428{
1429 VM_ASSERT(GET_VM()->overloaded_cme_table != NULL);
1430 return GET_VM()->overloaded_cme_table;
1431}
1432
1433#if VM_CHECK_MODE > 0
1434static int
1435vm_dump_overloaded_cme_table(st_data_t key, st_data_t val, st_data_t dmy)
1436{
1437 fprintf(stderr, "key: "); rp(key);
1438 fprintf(stderr, "val: "); rp(val);
1439 return ST_CONTINUE;
1440}
1441
1442void
1443rb_vm_dump_overloaded_cme_table(void)
1444{
1445 fprintf(stderr, "== rb_vm_dump_overloaded_cme_table\n");
1446 st_foreach(overloaded_cme_table(), vm_dump_overloaded_cme_table, 0);
1447}
1448#endif
1449
1450static int
1451lookup_overloaded_cme_i(st_data_t *key, st_data_t *value, st_data_t data, int existing)
1452{
1453 if (existing) {
1454 const rb_callable_method_entry_t *cme = (const rb_callable_method_entry_t *)*key;
1455 const rb_callable_method_entry_t *monly_cme = (const rb_callable_method_entry_t *)*value;
1456 const rb_callable_method_entry_t **ptr = (const rb_callable_method_entry_t **)data;
1457
1458 if (rb_objspace_garbage_object_p((VALUE)cme) ||
1459 rb_objspace_garbage_object_p((VALUE)monly_cme)) {
1460 *ptr = NULL;
1461 return ST_DELETE;
1462 }
1463 else {
1464 *ptr = monly_cme;
1465 }
1466 }
1467
1468 return ST_STOP;
1469}
1470
1471static const rb_callable_method_entry_t *
1472lookup_overloaded_cme(const rb_callable_method_entry_t *cme)
1473{
1474 ASSERT_vm_locking();
1475
1476 const rb_callable_method_entry_t *monly_cme = NULL;
1477 st_update(overloaded_cme_table(), (st_data_t)cme, lookup_overloaded_cme_i, (st_data_t)&monly_cme);
1478 return monly_cme;
1479}
1480
1481#if VM_CHECK_MODE > 0
1483rb_vm_lookup_overloaded_cme(const rb_callable_method_entry_t *cme)
1484{
1485 return lookup_overloaded_cme(cme);
1486}
1487#endif
1488
1489static void
1490delete_overloaded_cme(const rb_callable_method_entry_t *cme)
1491{
1492 st_data_t cme_data = (st_data_t)cme;
1493 ASSERT_vm_locking();
1494 st_delete(overloaded_cme_table(), &cme_data, NULL);
1495}
1496
1497static const rb_callable_method_entry_t *
1498get_overloaded_cme(const rb_callable_method_entry_t *cme)
1499{
1500 const rb_callable_method_entry_t *monly_cme = lookup_overloaded_cme(cme);
1501
1502 if (monly_cme && !METHOD_ENTRY_INVALIDATED(monly_cme)) {
1503 return monly_cme;
1504 }
1505 else {
1506 // create
1507 rb_method_definition_t *def = rb_method_definition_create(VM_METHOD_TYPE_ISEQ, cme->def->original_id);
1508 rb_method_entry_t *me = rb_method_entry_alloc(cme->called_id,
1509 cme->owner,
1510 cme->defined_class,
1511 def,
1512 false);
1513
1514 RB_OBJ_WRITE(me, &def->body.iseq.cref, cme->def->body.iseq.cref);
1515 RB_OBJ_WRITE(me, &def->body.iseq.iseqptr, ISEQ_BODY(cme->def->body.iseq.iseqptr)->mandatory_only_iseq);
1516
1517 ASSERT_vm_locking();
1518 st_insert(overloaded_cme_table(), (st_data_t)cme, (st_data_t)me);
1519
1520 METHOD_ENTRY_VISI_SET(me, METHOD_ENTRY_VISI(cme));
1521 return (rb_callable_method_entry_t *)me;
1522 }
1523}
1524
1526rb_check_overloaded_cme(const rb_callable_method_entry_t *cme, const struct rb_callinfo * const ci)
1527{
1528 if (UNLIKELY(cme->def->iseq_overload) &&
1529 (vm_ci_flag(ci) & (VM_CALL_ARGS_SIMPLE)) &&
1530 (!(vm_ci_flag(ci) & VM_CALL_FORWARDING)) &&
1531 (int)vm_ci_argc(ci) == ISEQ_BODY(method_entry_iseqptr(cme))->param.lead_num) {
1532 VM_ASSERT(cme->def->type == VM_METHOD_TYPE_ISEQ, "type: %d", cme->def->type); // iseq_overload is marked only on ISEQ methods
1533
1534 cme = get_overloaded_cme(cme);
1535
1536 VM_ASSERT(cme != NULL);
1537 METHOD_ENTRY_CACHED_SET((struct rb_callable_method_entry_struct *)cme);
1538 }
1539
1540 return cme;
1541}
1542
1543#define CALL_METHOD_HOOK(klass, hook, mid) do { \
1544 const VALUE arg = ID2SYM(mid); \
1545 VALUE recv_class = (klass); \
1546 ID hook_id = (hook); \
1547 if (RCLASS_SINGLETON_P((klass))) { \
1548 recv_class = RCLASS_ATTACHED_OBJECT((klass)); \
1549 hook_id = singleton_##hook; \
1550 } \
1551 rb_funcallv(recv_class, hook_id, 1, &arg); \
1552 } while (0)
1553
1554static void
1555method_added(VALUE klass, ID mid)
1556{
1557 if (ruby_running) {
1558 CALL_METHOD_HOOK(klass, added, mid);
1559 }
1560}
1561
1562void
1563rb_add_method(VALUE klass, ID mid, rb_method_type_t type, void *opts, rb_method_visibility_t visi)
1564{
1565 RB_VM_LOCKING() {
1566 rb_method_entry_make(klass, mid, klass, visi, type, NULL, mid, opts);
1567 }
1568
1569 if (type != VM_METHOD_TYPE_UNDEF && type != VM_METHOD_TYPE_REFINED) {
1570 method_added(klass, mid);
1571 }
1572}
1573
1574void
1575rb_add_method_iseq(VALUE klass, ID mid, const rb_iseq_t *iseq, rb_cref_t *cref, rb_method_visibility_t visi)
1576{
1577 struct { /* should be same fields with rb_method_iseq_struct */
1578 const rb_iseq_t *iseqptr;
1579 rb_cref_t *cref;
1580 } iseq_body;
1581
1582 iseq_body.iseqptr = iseq;
1583 iseq_body.cref = cref;
1584
1585 rb_add_method(klass, mid, VM_METHOD_TYPE_ISEQ, &iseq_body, visi);
1586}
1587
1588static rb_method_entry_t *
1589method_entry_set(VALUE klass, ID mid, const rb_method_entry_t *me,
1590 rb_method_visibility_t visi, VALUE defined_class)
1591{
1592 rb_method_entry_t *newme;
1593 RB_VM_LOCKING() {
1594 newme = rb_method_entry_make(klass, mid, defined_class, visi,
1595 me->def->type, me->def, 0, NULL);
1596 if (newme == me) {
1597 me->def->no_redef_warning = TRUE;
1598 METHOD_ENTRY_FLAGS_SET(newme, visi, FALSE);
1599 }
1600 }
1601
1602 method_added(klass, mid);
1603 return newme;
1604}
1605
1607rb_method_entry_set(VALUE klass, ID mid, const rb_method_entry_t *me, rb_method_visibility_t visi)
1608{
1609 return method_entry_set(klass, mid, me, visi, klass);
1610}
1611
1612#define UNDEF_ALLOC_FUNC ((rb_alloc_func_t)-1)
1613
1614void
1615rb_define_alloc_func(VALUE klass, VALUE (*func)(VALUE))
1616{
1617 Check_Type(klass, T_CLASS);
1618 if (RCLASS_SINGLETON_P(klass)) {
1619 rb_raise(rb_eTypeError, "can't define an allocator for a singleton class");
1620 }
1621 RCLASS_SET_ALLOCATOR(klass, func);
1622}
1623
1624void
1626{
1627 rb_define_alloc_func(klass, UNDEF_ALLOC_FUNC);
1628}
1629
1632{
1633 Check_Type(klass, T_CLASS);
1634
1635 for (; klass; klass = RCLASS_SUPER(klass)) {
1636 rb_alloc_func_t allocator = RCLASS_ALLOCATOR(klass);
1637 if (allocator == UNDEF_ALLOC_FUNC) break;
1638 if (allocator) return allocator;
1639 }
1640 return 0;
1641}
1642
1643const rb_method_entry_t *
1644rb_method_entry_at(VALUE klass, ID id)
1645{
1646 return lookup_method_table(klass, id);
1647}
1648
1649static inline rb_method_entry_t*
1650search_method0(VALUE klass, ID id, VALUE *defined_class_ptr, bool skip_refined)
1651{
1652 rb_method_entry_t *me = NULL;
1653
1654 RB_DEBUG_COUNTER_INC(mc_search);
1655
1656 for (; klass; klass = RCLASS_SUPER(klass)) {
1657 RB_DEBUG_COUNTER_INC(mc_search_super);
1658 if ((me = lookup_method_table(klass, id)) != 0) {
1659 if (!skip_refined || me->def->type != VM_METHOD_TYPE_REFINED ||
1660 me->def->body.refined.orig_me) {
1661 break;
1662 }
1663 }
1664 }
1665
1666 if (defined_class_ptr) *defined_class_ptr = klass;
1667
1668 if (me == NULL) RB_DEBUG_COUNTER_INC(mc_search_notfound);
1669
1670 VM_ASSERT(me == NULL || !METHOD_ENTRY_INVALIDATED(me),
1671 "invalid me, mid:%s, klass:%s(%s)",
1672 rb_id2name(id),
1673 RTEST(rb_mod_name(klass)) ? RSTRING_PTR(rb_mod_name(klass)) : "anonymous",
1674 rb_obj_info(klass));
1675 return me;
1676}
1677
1678static inline rb_method_entry_t*
1679search_method(VALUE klass, ID id, VALUE *defined_class_ptr)
1680{
1681 return search_method0(klass, id, defined_class_ptr, false);
1682}
1683
1684static rb_method_entry_t *
1685search_method_protect(VALUE klass, ID id, VALUE *defined_class_ptr)
1686{
1687 rb_method_entry_t *me = search_method(klass, id, defined_class_ptr);
1688
1689 if (!UNDEFINED_METHOD_ENTRY_P(me)) {
1690 return me;
1691 }
1692 else {
1693 return NULL;
1694 }
1695}
1696
1697const rb_method_entry_t *
1698rb_method_entry(VALUE klass, ID id)
1699{
1700 return search_method_protect(klass, id, NULL);
1701}
1702
1703static inline const rb_callable_method_entry_t *
1704prepare_callable_method_entry(VALUE defined_class, ID id, const rb_method_entry_t * const me, int create)
1705{
1706 struct rb_id_table *mtbl;
1707 const rb_callable_method_entry_t *cme;
1708 VALUE cme_data;
1709 int cme_found = 0;
1710
1711 if (me) {
1712 if (me->defined_class == 0) {
1713 RB_DEBUG_COUNTER_INC(mc_cme_complement);
1714 VM_ASSERT_TYPE2(defined_class, T_ICLASS, T_MODULE);
1715
1716 mtbl = RCLASS_WRITABLE_CALLABLE_M_TBL(defined_class);
1717 if (mtbl && rb_id_table_lookup(mtbl, id, &cme_data)) {
1718 cme = (rb_callable_method_entry_t *)cme_data;
1719 cme_found = 1;
1720 }
1721 if (cme_found) {
1722 RB_DEBUG_COUNTER_INC(mc_cme_complement_hit);
1723 VM_ASSERT(callable_method_entry_p(cme));
1724 VM_ASSERT(!METHOD_ENTRY_INVALIDATED(cme));
1725 }
1726 else if (create) {
1727 if (!mtbl) {
1728 mtbl = rb_id_table_create(0);
1729 RCLASS_WRITE_CALLABLE_M_TBL(defined_class, mtbl);
1730 }
1731 cme = rb_method_entry_complement_defined_class(me, me->called_id, defined_class);
1732 rb_id_table_insert(mtbl, id, (VALUE)cme);
1733 RB_OBJ_WRITTEN(defined_class, Qundef, (VALUE)cme);
1734 VM_ASSERT(callable_method_entry_p(cme));
1735 }
1736 else {
1737 return NULL;
1738 }
1739 }
1740 else {
1741 cme = (const rb_callable_method_entry_t *)me;
1742 VM_ASSERT(callable_method_entry_p(cme));
1743 VM_ASSERT(!METHOD_ENTRY_INVALIDATED(cme));
1744 }
1745 return cme;
1746 }
1747 else {
1748 return NULL;
1749 }
1750}
1751
1752static const rb_callable_method_entry_t *
1753complemented_callable_method_entry(VALUE klass, ID id)
1754{
1755 VALUE defined_class;
1756 rb_method_entry_t *me = search_method(klass, id, &defined_class);
1757 return prepare_callable_method_entry(defined_class, id, me, FALSE);
1758}
1759
1760static const rb_callable_method_entry_t *
1761cached_callable_method_entry(VALUE klass, ID mid)
1762{
1763 ASSERT_vm_locking();
1764
1765 VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass);
1766 VALUE ccs_data;
1767
1768 if (cc_tbl && rb_managed_id_table_lookup(cc_tbl, mid, &ccs_data)) {
1769 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data;
1770 VM_ASSERT(vm_ccs_p(ccs));
1771
1772 if (LIKELY(!METHOD_ENTRY_INVALIDATED(ccs->cme))) {
1773 VM_ASSERT(ccs->cme->called_id == mid);
1774 RB_DEBUG_COUNTER_INC(ccs_found);
1775 return ccs->cme;
1776 }
1777 else {
1778 rb_vm_barrier();
1779
1780 rb_managed_id_table_delete(cc_tbl, mid);
1781 rb_vm_ccs_invalidate_and_free(ccs);
1782 }
1783 }
1784
1785 RB_DEBUG_COUNTER_INC(ccs_not_found);
1786 return NULL;
1787}
1788
1789static void
1790cache_callable_method_entry(VALUE klass, ID mid, const rb_callable_method_entry_t *cme)
1791{
1792 ASSERT_vm_locking();
1793 VM_ASSERT(cme != NULL);
1794
1795 VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass);
1796 VALUE ccs_data;
1797
1798 if (!cc_tbl) {
1799 cc_tbl = rb_vm_cc_table_create(2);
1800 RCLASS_WRITE_CC_TBL(klass, cc_tbl);
1801 }
1802
1803 if (rb_managed_id_table_lookup(cc_tbl, mid, &ccs_data)) {
1804#if VM_CHECK_MODE > 0
1805 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data;
1806 VM_ASSERT(ccs->cme == cme);
1807#endif
1808 }
1809 else {
1810 if (rb_multi_ractor_p()) {
1811 VALUE new_cc_tbl = rb_vm_cc_table_dup(cc_tbl);
1812 vm_ccs_create(klass, new_cc_tbl, mid, cme);
1813 RB_OBJ_ATOMIC_WRITE(klass, &RCLASSEXT_CC_TBL(RCLASS_EXT_WRITABLE(klass)), new_cc_tbl);
1814 }
1815 else {
1816 vm_ccs_create(klass, cc_tbl, mid, cme);
1817 }
1818 }
1819}
1820
1821static const rb_callable_method_entry_t *
1822negative_cme(ID mid)
1823{
1824 rb_vm_t *vm = GET_VM();
1825 const rb_callable_method_entry_t *cme;
1826 VALUE cme_data;
1827
1828 if (rb_id_table_lookup(vm->negative_cme_table, mid, &cme_data)) {
1829 cme = (rb_callable_method_entry_t *)cme_data;
1830 }
1831 else {
1832 cme = (rb_callable_method_entry_t *)rb_method_entry_alloc(mid, Qnil, Qnil, NULL, false);
1833 rb_id_table_insert(vm->negative_cme_table, mid, (VALUE)cme);
1834 }
1835
1836 VM_ASSERT(cme != NULL);
1837 return cme;
1838}
1839
1840static const rb_callable_method_entry_t *
1841callable_method_entry_or_negative(VALUE klass, ID mid, VALUE *defined_class_ptr)
1842{
1843 const rb_callable_method_entry_t *cme;
1844
1845 VM_ASSERT_TYPE2(klass, T_CLASS, T_ICLASS);
1846
1847 /* Fast path: lock-free read from cache */
1848 VALUE cc_tbl = RUBY_ATOMIC_VALUE_LOAD(RCLASS_WRITABLE_CC_TBL(klass));
1849 if (cc_tbl) {
1850 VALUE ccs_data;
1851 if (rb_managed_id_table_lookup(cc_tbl, mid, &ccs_data)) {
1852 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data;
1853 VM_ASSERT(vm_ccs_p(ccs));
1854
1855 if (LIKELY(!METHOD_ENTRY_INVALIDATED(ccs->cme))) {
1856 VM_ASSERT(ccs->cme->called_id == mid);
1857 if (defined_class_ptr != NULL) *defined_class_ptr = ccs->cme->defined_class;
1858 RB_DEBUG_COUNTER_INC(ccs_found);
1859 return ccs->cme;
1860 }
1861 }
1862 }
1863
1864 /* Slow path: need to lock and potentially populate cache */
1865 RB_VM_LOCKING() {
1866 cme = cached_callable_method_entry(klass, mid);
1867
1868 if (cme) {
1869 if (defined_class_ptr != NULL) *defined_class_ptr = cme->defined_class;
1870 }
1871 else {
1872 VALUE defined_class;
1873 rb_method_entry_t *me = search_method(klass, mid, &defined_class);
1874 if (defined_class_ptr) *defined_class_ptr = defined_class;
1875
1876 if (me != NULL) {
1877 cme = prepare_callable_method_entry(defined_class, mid, me, TRUE);
1878 }
1879 else {
1880 cme = negative_cme(mid);
1881 }
1882
1883 cache_callable_method_entry(klass, mid, cme);
1884 }
1885 }
1886
1887 return cme;
1888}
1889
1890// This is exposed for YJIT so that we can make assumptions that methods are
1891// not defined.
1893rb_callable_method_entry_or_negative(VALUE klass, ID mid)
1894{
1895 return callable_method_entry_or_negative(klass, mid, NULL);
1896}
1897
1898static const rb_callable_method_entry_t *
1899callable_method_entry(VALUE klass, ID mid, VALUE *defined_class_ptr)
1900{
1901 const rb_callable_method_entry_t *cme;
1902 cme = callable_method_entry_or_negative(klass, mid, defined_class_ptr);
1903 return !UNDEFINED_METHOD_ENTRY_P(cme) ? cme : NULL;
1904}
1905
1907rb_callable_method_entry(VALUE klass, ID mid)
1908{
1909 return callable_method_entry(klass, mid, NULL);
1910}
1911
1912static const rb_method_entry_t *resolve_refined_method(VALUE refinements, const rb_method_entry_t *me, VALUE *defined_class_ptr);
1913
1914static const rb_method_entry_t *
1915method_entry_resolve_refinement(VALUE klass, ID id, int with_refinement, VALUE *defined_class_ptr)
1916{
1917 const rb_method_entry_t *me = search_method_protect(klass, id, defined_class_ptr);
1918
1919 if (me) {
1920 if (me->def->type == VM_METHOD_TYPE_REFINED) {
1921 if (with_refinement) {
1922 const rb_cref_t *cref = rb_vm_cref();
1923 VALUE refinements = cref ? CREF_REFINEMENTS(cref) : Qnil;
1924 me = resolve_refined_method(refinements, me, defined_class_ptr);
1925 }
1926 else {
1927 me = resolve_refined_method(Qnil, me, defined_class_ptr);
1928 }
1929
1930 if (UNDEFINED_METHOD_ENTRY_P(me)) me = NULL;
1931 }
1932 }
1933
1934 return me;
1935}
1936
1937const rb_method_entry_t *
1938rb_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1939{
1940 return method_entry_resolve_refinement(klass, id, TRUE, defined_class_ptr);
1941}
1942
1943static const rb_callable_method_entry_t *
1944callable_method_entry_refinements0(VALUE klass, ID id, VALUE *defined_class_ptr, bool with_refinements,
1945 const rb_callable_method_entry_t *cme)
1946{
1947 if (cme == NULL || LIKELY(cme->def->type != VM_METHOD_TYPE_REFINED)) {
1948 return cme;
1949 }
1950 else {
1951 VALUE defined_class, *dcp = defined_class_ptr ? defined_class_ptr : &defined_class;
1952 const rb_method_entry_t *me = method_entry_resolve_refinement(klass, id, with_refinements, dcp);
1953 return prepare_callable_method_entry(*dcp, id, me, TRUE);
1954 }
1955}
1956
1957static const rb_callable_method_entry_t *
1958callable_method_entry_refinements(VALUE klass, ID id, VALUE *defined_class_ptr, bool with_refinements)
1959{
1960 const rb_callable_method_entry_t *cme = callable_method_entry(klass, id, defined_class_ptr);
1961 return callable_method_entry_refinements0(klass, id, defined_class_ptr, with_refinements, cme);
1962}
1963
1965rb_callable_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1966{
1967 return callable_method_entry_refinements(klass, id, defined_class_ptr, true);
1968}
1969
1970static const rb_callable_method_entry_t *
1971callable_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1972{
1973 return callable_method_entry_refinements(klass, id, defined_class_ptr, false);
1974}
1975
1976const rb_method_entry_t *
1977rb_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1978{
1979 return method_entry_resolve_refinement(klass, id, FALSE, defined_class_ptr);
1980}
1981
1983rb_callable_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1984{
1985 VALUE defined_class, *dcp = defined_class_ptr ? defined_class_ptr : &defined_class;
1986 const rb_method_entry_t *me = method_entry_resolve_refinement(klass, id, FALSE, dcp);
1987 return prepare_callable_method_entry(*dcp, id, me, TRUE);
1988}
1989
1990static const rb_method_entry_t *
1991resolve_refined_method(VALUE refinements, const rb_method_entry_t *me, VALUE *defined_class_ptr)
1992{
1993 while (me && me->def->type == VM_METHOD_TYPE_REFINED) {
1994 VALUE refinement;
1995 const rb_method_entry_t *tmp_me;
1996 VALUE super;
1997
1998 refinement = find_refinement(refinements, me->owner);
1999 if (!NIL_P(refinement)) {
2000 tmp_me = search_method_protect(refinement, me->called_id, defined_class_ptr);
2001
2002 if (tmp_me && tmp_me->def->type != VM_METHOD_TYPE_REFINED) {
2003 return tmp_me;
2004 }
2005 }
2006
2007 tmp_me = me->def->body.refined.orig_me;
2008 if (tmp_me) {
2009 if (!tmp_me->defined_class) {
2010 VM_ASSERT_TYPE(tmp_me->owner, T_MODULE);
2011 }
2012 else if (defined_class_ptr) {
2013 *defined_class_ptr = tmp_me->defined_class;
2014 }
2015 return tmp_me;
2016 }
2017
2018 super = RCLASS_SUPER(me->owner);
2019 if (!super) {
2020 return 0;
2021 }
2022
2023 me = search_method_protect(super, me->called_id, defined_class_ptr);
2024 }
2025 return me;
2026}
2027
2028const rb_method_entry_t *
2029rb_resolve_refined_method(VALUE refinements, const rb_method_entry_t *me)
2030{
2031 return resolve_refined_method(refinements, me, NULL);
2032}
2033
2035rb_resolve_refined_method_callable(VALUE refinements, const rb_callable_method_entry_t *me)
2036{
2037 VALUE defined_class = me->defined_class;
2038 const rb_method_entry_t *resolved_me = resolve_refined_method(refinements, (const rb_method_entry_t *)me, &defined_class);
2039
2040 if (resolved_me && resolved_me->defined_class == 0) {
2041 return rb_method_entry_complement_defined_class(resolved_me, me->called_id, defined_class);
2042 }
2043 else {
2044 return (const rb_callable_method_entry_t *)resolved_me;
2045 }
2046}
2047
2048static void
2049remove_method(VALUE klass, ID mid)
2050{
2051 VALUE data;
2052 rb_method_entry_t *me = 0;
2053 VALUE self = klass;
2054
2055 rb_class_modify_check(klass);
2056 klass = RCLASS_ORIGIN(klass);
2057 if (mid == object_id || mid == id__id__ || mid == id__send__ || mid == idInitialize) {
2058 rb_warn("removing '%s' may cause serious problems", rb_id2name(mid));
2059 }
2060
2061 if (!rb_id_table_lookup(RCLASS_M_TBL(klass), mid, &data) ||
2062 !(me = (rb_method_entry_t *)data) ||
2063 (!me->def || me->def->type == VM_METHOD_TYPE_UNDEF) ||
2064 UNDEFINED_REFINED_METHOD_P(me->def)) {
2065 rb_name_err_raise("method '%1$s' not defined in %2$s",
2066 klass, ID2SYM(mid));
2067 }
2068
2069 if (klass != self) {
2070 rb_clear_method_cache(self, mid);
2071 }
2072 rb_clear_method_cache(klass, mid);
2073 rb_id_table_delete(RCLASS_WRITABLE_M_TBL(klass), mid);
2074
2075 rb_vm_check_redefinition_opt_method(me, klass);
2076
2077 if (me->def->type == VM_METHOD_TYPE_REFINED) {
2078 rb_add_refined_method_entry(klass, mid);
2079 }
2080
2081 CALL_METHOD_HOOK(self, removed, mid);
2082}
2083
2084void
2086{
2087 remove_method(klass, mid);
2088}
2089
2090void
2091rb_remove_method(VALUE klass, const char *name)
2092{
2093 remove_method(klass, rb_intern(name));
2094}
2095
2096/*
2097 * call-seq:
2098 * remove_method(symbol) -> self
2099 * remove_method(string) -> self
2100 *
2101 * Removes the method identified by _symbol_ from the current
2102 * class. For an example, see Module#undef_method.
2103 * String arguments are converted to symbols.
2104 */
2105
2106static VALUE
2107rb_mod_remove_method(int argc, VALUE *argv, VALUE mod)
2108{
2109 int i;
2110
2111 for (i = 0; i < argc; i++) {
2112 VALUE v = argv[i];
2113 ID id = rb_check_id(&v);
2114 if (!id) {
2115 rb_name_err_raise("method '%1$s' not defined in %2$s",
2116 mod, v);
2117 }
2118 remove_method(mod, id);
2119 }
2120 return mod;
2121}
2122
2123static void
2124rb_export_method(VALUE klass, ID name, rb_method_visibility_t visi)
2125{
2127 VALUE defined_class;
2128 VALUE origin_class = RCLASS_ORIGIN(klass);
2129
2130 me = search_method0(origin_class, name, &defined_class, true);
2131
2132 if (!me && RB_TYPE_P(klass, T_MODULE)) {
2133 me = search_method(rb_cObject, name, &defined_class);
2134 }
2135
2136 if (UNDEFINED_METHOD_ENTRY_P(me) ||
2137 UNDEFINED_REFINED_METHOD_P(me->def)) {
2138 rb_print_undef(klass, name, METHOD_VISI_UNDEF);
2139 }
2140
2141 if (METHOD_ENTRY_VISI(me) != visi) {
2142 rb_vm_check_redefinition_opt_method(me, klass);
2143
2144 if (klass == defined_class || origin_class == defined_class) {
2145 if (me->def->type == VM_METHOD_TYPE_REFINED) {
2146 // Refinement method entries should always be public because the refinement
2147 // search is always performed.
2148 if (me->def->body.refined.orig_me) {
2149 METHOD_ENTRY_VISI_SET((rb_method_entry_t *)me->def->body.refined.orig_me, visi);
2150 }
2151 }
2152 else {
2153 METHOD_ENTRY_VISI_SET(me, visi);
2154 }
2155 rb_clear_method_cache(klass, name);
2156 }
2157 else {
2158 rb_add_method(klass, name, VM_METHOD_TYPE_ZSUPER, 0, visi);
2159 }
2160 }
2161}
2162
2163#define BOUND_PRIVATE 0x01
2164#define BOUND_RESPONDS 0x02
2165
2166static int
2167method_boundp(VALUE klass, ID id, int ex)
2168{
2169 const rb_callable_method_entry_t *cme;
2170
2171 VM_ASSERT_TYPE2(klass, T_CLASS, T_ICLASS);
2172
2173 if (ex & BOUND_RESPONDS) {
2174 cme = rb_callable_method_entry_with_refinements(klass, id, NULL);
2175 }
2176 else {
2177 cme = callable_method_entry_without_refinements(klass, id, NULL);
2178 }
2179
2180 if (cme != NULL) {
2181 if (ex & ~BOUND_RESPONDS) {
2182 switch (METHOD_ENTRY_VISI(cme)) {
2183 case METHOD_VISI_PRIVATE:
2184 return 0;
2185 case METHOD_VISI_PROTECTED:
2186 if (ex & BOUND_RESPONDS) return 0;
2187 default:
2188 break;
2189 }
2190 }
2191
2192 if (cme->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) {
2193 if (ex & BOUND_RESPONDS) return 2;
2194 return 0;
2195 }
2196 return 1;
2197 }
2198 return 0;
2199}
2200
2201// deprecated
2202int
2203rb_method_boundp(VALUE klass, ID id, int ex)
2204{
2205 return method_boundp(klass, id, ex);
2206}
2207
2208static void
2209vm_cref_set_visibility(rb_method_visibility_t method_visi, int module_func)
2210{
2211 rb_scope_visibility_t *scope_visi = (rb_scope_visibility_t *)&rb_vm_cref()->scope_visi;
2212 scope_visi->method_visi = method_visi;
2213 scope_visi->module_func = module_func;
2214}
2215
2216void
2217rb_scope_visibility_set(rb_method_visibility_t visi)
2218{
2219 vm_cref_set_visibility(visi, FALSE);
2220}
2221
2222static void
2223scope_visibility_check(void)
2224{
2225 /* Check for public/protected/private/module_function called inside a method */
2226 rb_control_frame_t *cfp = GET_EC()->cfp+1;
2227 if (cfp && cfp->iseq && ISEQ_BODY(cfp->iseq)->type == ISEQ_TYPE_METHOD) {
2228 rb_warn("calling %s without arguments inside a method may not have the intended effect",
2229 rb_id2name(rb_frame_this_func()));
2230 }
2231}
2232
2233static void
2234rb_scope_module_func_set(void)
2235{
2236 scope_visibility_check();
2237 vm_cref_set_visibility(METHOD_VISI_PRIVATE, TRUE);
2238}
2239
2240const rb_cref_t *rb_vm_cref_in_context(VALUE self, VALUE cbase);
2241void
2242rb_attr(VALUE klass, ID id, int read, int write, int ex)
2243{
2244 ID attriv;
2245 rb_method_visibility_t visi;
2246 const rb_execution_context_t *ec = GET_EC();
2247 const rb_cref_t *cref = rb_vm_cref_in_context(klass, klass);
2248
2249 if (!ex || !cref) {
2250 visi = METHOD_VISI_PUBLIC;
2251 }
2252 else {
2253 switch (vm_scope_visibility_get(ec)) {
2254 case METHOD_VISI_PRIVATE:
2255 if (vm_scope_module_func_check(ec)) {
2256 rb_warning("attribute accessor as module_function");
2257 }
2258 visi = METHOD_VISI_PRIVATE;
2259 break;
2260 case METHOD_VISI_PROTECTED:
2261 visi = METHOD_VISI_PROTECTED;
2262 break;
2263 default:
2264 visi = METHOD_VISI_PUBLIC;
2265 break;
2266 }
2267 }
2268
2269 attriv = rb_intern_str(rb_sprintf("@%"PRIsVALUE, rb_id2str(id)));
2270 if (read) {
2271 rb_add_method(klass, id, VM_METHOD_TYPE_IVAR, (void *)attriv, visi);
2272 }
2273 if (write) {
2274 rb_add_method(klass, rb_id_attrset(id), VM_METHOD_TYPE_ATTRSET, (void *)attriv, visi);
2275 }
2276}
2277
2278void
2280{
2281 const rb_method_entry_t *me;
2282
2283 if (NIL_P(klass)) {
2284 rb_raise(rb_eTypeError, "no class to undef method");
2285 }
2286 rb_class_modify_check(klass);
2287 if (id == object_id || id == id__id__ || id == id__send__ || id == idInitialize) {
2288 rb_warn("undefining '%s' may cause serious problems", rb_id2name(id));
2289 }
2290
2291 me = search_method(klass, id, 0);
2292 if (me && me->def->type == VM_METHOD_TYPE_REFINED) {
2293 me = rb_resolve_refined_method(Qnil, me);
2294 }
2295
2296 if (UNDEFINED_METHOD_ENTRY_P(me) ||
2297 UNDEFINED_REFINED_METHOD_P(me->def)) {
2298 rb_method_name_error(klass, rb_id2str(id));
2299 }
2300
2301 rb_add_method(klass, id, VM_METHOD_TYPE_UNDEF, 0, METHOD_VISI_PUBLIC);
2302
2303 CALL_METHOD_HOOK(klass, undefined, id);
2304}
2305
2306/*
2307 * call-seq:
2308 * undef_method(symbol) -> self
2309 * undef_method(string) -> self
2310 *
2311 * Prevents the current class from responding to calls to the named
2312 * method. Contrast this with <code>remove_method</code>, which deletes
2313 * the method from the particular class; Ruby will still search
2314 * superclasses and mixed-in modules for a possible receiver.
2315 * String arguments are converted to symbols.
2316 *
2317 * class Parent
2318 * def hello
2319 * puts "In parent"
2320 * end
2321 * end
2322 * class Child < Parent
2323 * def hello
2324 * puts "In child"
2325 * end
2326 * end
2327 *
2328 *
2329 * c = Child.new
2330 * c.hello
2331 *
2332 *
2333 * class Child
2334 * remove_method :hello # remove from child, still in parent
2335 * end
2336 * c.hello
2337 *
2338 *
2339 * class Child
2340 * undef_method :hello # prevent any calls to 'hello'
2341 * end
2342 * c.hello
2343 *
2344 * <em>produces:</em>
2345 *
2346 * In child
2347 * In parent
2348 * prog.rb:23: undefined method 'hello' for #<Child:0x401b3bb4> (NoMethodError)
2349 */
2350
2351static VALUE
2352rb_mod_undef_method(int argc, VALUE *argv, VALUE mod)
2353{
2354 int i;
2355 for (i = 0; i < argc; i++) {
2356 VALUE v = argv[i];
2357 ID id = rb_check_id(&v);
2358 if (!id) {
2359 rb_method_name_error(mod, v);
2360 }
2361 rb_undef(mod, id);
2362 }
2363 return mod;
2364}
2365
2366static rb_method_visibility_t
2367check_definition_visibility(VALUE mod, int argc, VALUE *argv)
2368{
2369 const rb_method_entry_t *me;
2370 VALUE mid, include_super, lookup_mod = mod;
2371 int inc_super;
2372 ID id;
2373
2374 rb_scan_args(argc, argv, "11", &mid, &include_super);
2375 id = rb_check_id(&mid);
2376 if (!id) return METHOD_VISI_UNDEF;
2377
2378 if (argc == 1) {
2379 inc_super = 1;
2380 }
2381 else {
2382 inc_super = RTEST(include_super);
2383 if (!inc_super) {
2384 lookup_mod = RCLASS_ORIGIN(mod);
2385 }
2386 }
2387
2388 me = rb_method_entry_without_refinements(lookup_mod, id, NULL);
2389 if (me) {
2390 if (me->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) return METHOD_VISI_UNDEF;
2391 if (!inc_super && me->owner != mod) return METHOD_VISI_UNDEF;
2392 return METHOD_ENTRY_VISI(me);
2393 }
2394 return METHOD_VISI_UNDEF;
2395}
2396
2397/*
2398 * call-seq:
2399 * mod.method_defined?(symbol, inherit=true) -> true or false
2400 * mod.method_defined?(string, inherit=true) -> true or false
2401 *
2402 * Returns +true+ if the named method is defined by
2403 * _mod_. If _inherit_ is set, the lookup will also search _mod_'s
2404 * ancestors. Public and protected methods are matched.
2405 * String arguments are converted to symbols.
2406 *
2407 * module A
2408 * def method1() end
2409 * def protected_method1() end
2410 * protected :protected_method1
2411 * end
2412 * class B
2413 * def method2() end
2414 * def private_method2() end
2415 * private :private_method2
2416 * end
2417 * class C < B
2418 * include A
2419 * def method3() end
2420 * end
2421 *
2422 * A.method_defined? :method1 #=> true
2423 * C.method_defined? "method1" #=> true
2424 * C.method_defined? "method2" #=> true
2425 * C.method_defined? "method2", true #=> true
2426 * C.method_defined? "method2", false #=> false
2427 * C.method_defined? "method3" #=> true
2428 * C.method_defined? "protected_method1" #=> true
2429 * C.method_defined? "method4" #=> false
2430 * C.method_defined? "private_method2" #=> false
2431 */
2432
2433static VALUE
2434rb_mod_method_defined(int argc, VALUE *argv, VALUE mod)
2435{
2436 rb_method_visibility_t visi = check_definition_visibility(mod, argc, argv);
2437 return RBOOL(visi == METHOD_VISI_PUBLIC || visi == METHOD_VISI_PROTECTED);
2438}
2439
2440static VALUE
2441check_definition(VALUE mod, int argc, VALUE *argv, rb_method_visibility_t visi)
2442{
2443 return RBOOL(check_definition_visibility(mod, argc, argv) == visi);
2444}
2445
2446/*
2447 * call-seq:
2448 * mod.public_method_defined?(symbol, inherit=true) -> true or false
2449 * mod.public_method_defined?(string, inherit=true) -> true or false
2450 *
2451 * Returns +true+ if the named public method is defined by
2452 * _mod_. If _inherit_ is set, the lookup will also search _mod_'s
2453 * ancestors.
2454 * String arguments are converted to symbols.
2455 *
2456 * module A
2457 * def method1() end
2458 * end
2459 * class B
2460 * protected
2461 * def method2() end
2462 * end
2463 * class C < B
2464 * include A
2465 * def method3() end
2466 * end
2467 *
2468 * A.method_defined? :method1 #=> true
2469 * C.public_method_defined? "method1" #=> true
2470 * C.public_method_defined? "method1", true #=> true
2471 * C.public_method_defined? "method1", false #=> true
2472 * C.public_method_defined? "method2" #=> false
2473 * C.method_defined? "method2" #=> true
2474 */
2475
2476static VALUE
2477rb_mod_public_method_defined(int argc, VALUE *argv, VALUE mod)
2478{
2479 return check_definition(mod, argc, argv, METHOD_VISI_PUBLIC);
2480}
2481
2482/*
2483 * call-seq:
2484 * mod.private_method_defined?(symbol, inherit=true) -> true or false
2485 * mod.private_method_defined?(string, inherit=true) -> true or false
2486 *
2487 * Returns +true+ if the named private method is defined by
2488 * _mod_. If _inherit_ is set, the lookup will also search _mod_'s
2489 * ancestors.
2490 * String arguments are converted to symbols.
2491 *
2492 * module A
2493 * def method1() end
2494 * end
2495 * class B
2496 * private
2497 * def method2() end
2498 * end
2499 * class C < B
2500 * include A
2501 * def method3() end
2502 * end
2503 *
2504 * A.method_defined? :method1 #=> true
2505 * C.private_method_defined? "method1" #=> false
2506 * C.private_method_defined? "method2" #=> true
2507 * C.private_method_defined? "method2", true #=> true
2508 * C.private_method_defined? "method2", false #=> false
2509 * C.method_defined? "method2" #=> false
2510 */
2511
2512static VALUE
2513rb_mod_private_method_defined(int argc, VALUE *argv, VALUE mod)
2514{
2515 return check_definition(mod, argc, argv, METHOD_VISI_PRIVATE);
2516}
2517
2518/*
2519 * call-seq:
2520 * mod.protected_method_defined?(symbol, inherit=true) -> true or false
2521 * mod.protected_method_defined?(string, inherit=true) -> true or false
2522 *
2523 * Returns +true+ if the named protected method is defined
2524 * _mod_. If _inherit_ is set, the lookup will also search _mod_'s
2525 * ancestors.
2526 * String arguments are converted to symbols.
2527 *
2528 * module A
2529 * def method1() end
2530 * end
2531 * class B
2532 * protected
2533 * def method2() end
2534 * end
2535 * class C < B
2536 * include A
2537 * def method3() end
2538 * end
2539 *
2540 * A.method_defined? :method1 #=> true
2541 * C.protected_method_defined? "method1" #=> false
2542 * C.protected_method_defined? "method2" #=> true
2543 * C.protected_method_defined? "method2", true #=> true
2544 * C.protected_method_defined? "method2", false #=> false
2545 * C.method_defined? "method2" #=> true
2546 */
2547
2548static VALUE
2549rb_mod_protected_method_defined(int argc, VALUE *argv, VALUE mod)
2550{
2551 return check_definition(mod, argc, argv, METHOD_VISI_PROTECTED);
2552}
2553
2554int
2555rb_method_entry_eq(const rb_method_entry_t *m1, const rb_method_entry_t *m2)
2556{
2557 return rb_method_definition_eq(m1->def, m2->def);
2558}
2559
2560static const rb_method_definition_t *
2561original_method_definition(const rb_method_definition_t *def)
2562{
2563 again:
2564 if (def) {
2565 switch (def->type) {
2566 case VM_METHOD_TYPE_REFINED:
2567 if (def->body.refined.orig_me) {
2568 def = def->body.refined.orig_me->def;
2569 goto again;
2570 }
2571 break;
2572 case VM_METHOD_TYPE_ALIAS:
2573 def = def->body.alias.original_me->def;
2574 goto again;
2575 default:
2576 break;
2577 }
2578 }
2579 return def;
2580}
2581
2582int
2583rb_method_definition_eq(const rb_method_definition_t *d1, const rb_method_definition_t *d2)
2584{
2585 d1 = original_method_definition(d1);
2586 d2 = original_method_definition(d2);
2587
2588 if (d1 == d2) return 1;
2589 if (!d1 || !d2) return 0;
2590 if (d1->type != d2->type) return 0;
2591
2592 switch (d1->type) {
2593 case VM_METHOD_TYPE_ISEQ:
2594 return d1->body.iseq.iseqptr == d2->body.iseq.iseqptr;
2595 case VM_METHOD_TYPE_CFUNC:
2596 return
2597 d1->body.cfunc.func == d2->body.cfunc.func &&
2598 d1->body.cfunc.argc == d2->body.cfunc.argc;
2599 case VM_METHOD_TYPE_ATTRSET:
2600 case VM_METHOD_TYPE_IVAR:
2601 return d1->body.attr.id == d2->body.attr.id;
2602 case VM_METHOD_TYPE_BMETHOD:
2603 return RTEST(rb_equal(d1->body.bmethod.proc, d2->body.bmethod.proc));
2604 case VM_METHOD_TYPE_MISSING:
2605 return d1->original_id == d2->original_id;
2606 case VM_METHOD_TYPE_ZSUPER:
2607 case VM_METHOD_TYPE_NOTIMPLEMENTED:
2608 case VM_METHOD_TYPE_UNDEF:
2609 return 1;
2610 case VM_METHOD_TYPE_OPTIMIZED:
2611 return (d1->body.optimized.type == d2->body.optimized.type) &&
2612 (d1->body.optimized.index == d2->body.optimized.index);
2613 case VM_METHOD_TYPE_REFINED:
2614 case VM_METHOD_TYPE_ALIAS:
2615 break;
2616 }
2617 rb_bug("rb_method_definition_eq: unsupported type: %d", d1->type);
2618}
2619
2620static st_index_t
2621rb_hash_method_definition(st_index_t hash, const rb_method_definition_t *def)
2622{
2623 hash = rb_hash_uint(hash, def->type);
2624 def = original_method_definition(def);
2625
2626 if (!def) return hash;
2627
2628 switch (def->type) {
2629 case VM_METHOD_TYPE_ISEQ:
2630 return rb_hash_uint(hash, (st_index_t)def->body.iseq.iseqptr->body);
2631 case VM_METHOD_TYPE_CFUNC:
2632 hash = rb_hash_uint(hash, (st_index_t)def->body.cfunc.func);
2633 return rb_hash_uint(hash, def->body.cfunc.argc);
2634 case VM_METHOD_TYPE_ATTRSET:
2635 case VM_METHOD_TYPE_IVAR:
2636 return rb_hash_uint(hash, def->body.attr.id);
2637 case VM_METHOD_TYPE_BMETHOD:
2638 return rb_hash_proc(hash, def->body.bmethod.proc);
2639 case VM_METHOD_TYPE_MISSING:
2640 return rb_hash_uint(hash, def->original_id);
2641 case VM_METHOD_TYPE_ZSUPER:
2642 case VM_METHOD_TYPE_NOTIMPLEMENTED:
2643 case VM_METHOD_TYPE_UNDEF:
2644 return hash;
2645 case VM_METHOD_TYPE_OPTIMIZED:
2646 hash = rb_hash_uint(hash, def->body.optimized.index);
2647 return rb_hash_uint(hash, def->body.optimized.type);
2648 case VM_METHOD_TYPE_REFINED:
2649 case VM_METHOD_TYPE_ALIAS:
2650 break; /* unreachable */
2651 }
2652 rb_bug("rb_hash_method_definition: unsupported method type (%d)", def->type);
2653}
2654
2655st_index_t
2656rb_hash_method_entry(st_index_t hash, const rb_method_entry_t *me)
2657{
2658 return rb_hash_method_definition(hash, me->def);
2659}
2660
2661void
2662rb_alias(VALUE klass, ID alias_name, ID original_name)
2663{
2664 const VALUE target_klass = klass;
2665 VALUE defined_class;
2666 const rb_method_entry_t *orig_me;
2667 rb_method_visibility_t visi = METHOD_VISI_UNDEF;
2668
2669 if (NIL_P(klass)) {
2670 rb_raise(rb_eTypeError, "no class to make alias");
2671 }
2672
2673 rb_class_modify_check(klass);
2674
2675 again:
2676 orig_me = search_method(klass, original_name, &defined_class);
2677
2678 if (orig_me && orig_me->def->type == VM_METHOD_TYPE_REFINED) {
2679 orig_me = rb_resolve_refined_method(Qnil, orig_me);
2680 }
2681
2682 if (UNDEFINED_METHOD_ENTRY_P(orig_me) ||
2683 UNDEFINED_REFINED_METHOD_P(orig_me->def)) {
2684 if ((!RB_TYPE_P(klass, T_MODULE)) ||
2685 (orig_me = search_method(rb_cObject, original_name, &defined_class),
2686 UNDEFINED_METHOD_ENTRY_P(orig_me))) {
2687 rb_print_undef(target_klass, original_name, METHOD_VISI_UNDEF);
2688 }
2689 }
2690
2691 switch (orig_me->def->type) {
2692 case VM_METHOD_TYPE_ZSUPER:
2693 klass = RCLASS_SUPER(klass);
2694 original_name = orig_me->def->original_id;
2695 visi = METHOD_ENTRY_VISI(orig_me);
2696 goto again;
2697 case VM_METHOD_TYPE_ALIAS:
2698 visi = METHOD_ENTRY_VISI(orig_me);
2699 orig_me = orig_me->def->body.alias.original_me;
2700 VM_ASSERT(orig_me->def->type != VM_METHOD_TYPE_ALIAS);
2701 break;
2702 default: break;
2703 }
2704
2705 if (visi == METHOD_VISI_UNDEF) visi = METHOD_ENTRY_VISI(orig_me);
2706
2707 if (orig_me->defined_class == 0) {
2708 rb_method_entry_make(target_klass, alias_name, target_klass, visi,
2709 VM_METHOD_TYPE_ALIAS, NULL, orig_me->called_id,
2710 (void *)rb_method_entry_clone(orig_me));
2711 method_added(target_klass, alias_name);
2712 }
2713 else {
2714 rb_method_entry_t *alias_me;
2715
2716 alias_me = method_entry_set(target_klass, alias_name, orig_me, visi, orig_me->owner);
2717 RB_OBJ_WRITE(alias_me, &alias_me->owner, target_klass);
2718
2719 if (RB_TYPE_P(target_klass, T_MODULE)) {
2720 // defined_class should not be set
2721 }
2722 else {
2723 RB_OBJ_WRITE(alias_me, &alias_me->defined_class, orig_me->defined_class);
2724 }
2725 }
2726}
2727
2728/*
2729 * call-seq:
2730 * alias_method(new_name, old_name) -> symbol
2731 *
2732 * Makes <i>new_name</i> a new copy of the method <i>old_name</i>. This can
2733 * be used to retain access to methods that are overridden.
2734 *
2735 * module Mod
2736 * alias_method :orig_exit, :exit #=> :orig_exit
2737 * def exit(code=0)
2738 * puts "Exiting with code #{code}"
2739 * orig_exit(code)
2740 * end
2741 * end
2742 * include Mod
2743 * exit(99)
2744 *
2745 * <em>produces:</em>
2746 *
2747 * Exiting with code 99
2748 */
2749
2750static VALUE
2751rb_mod_alias_method(VALUE mod, VALUE newname, VALUE oldname)
2752{
2753 ID oldid = rb_check_id(&oldname);
2754 if (!oldid) {
2755 rb_print_undef_str(mod, oldname);
2756 }
2757 VALUE id = rb_to_id(newname);
2758 rb_alias(mod, id, oldid);
2759 return ID2SYM(id);
2760}
2761
2762static void
2763check_and_export_method(VALUE self, VALUE name, rb_method_visibility_t visi)
2764{
2765 ID id = rb_check_id(&name);
2766 if (!id) {
2767 rb_print_undef_str(self, name);
2768 }
2769 rb_export_method(self, id, visi);
2770}
2771
2772static void
2773set_method_visibility(VALUE self, int argc, const VALUE *argv, rb_method_visibility_t visi)
2774{
2775 int i;
2776
2777 rb_check_frozen(self);
2778 if (argc == 0) {
2779 rb_warning("%"PRIsVALUE" with no argument is just ignored",
2780 QUOTE_ID(rb_frame_callee()));
2781 return;
2782 }
2783
2784
2785 VALUE v;
2786
2787 if (argc == 1 && (v = rb_check_array_type(argv[0])) != Qnil) {
2788 long j;
2789
2790 for (j = 0; j < RARRAY_LEN(v); j++) {
2791 check_and_export_method(self, RARRAY_AREF(v, j), visi);
2792 }
2793 }
2794 else {
2795 for (i = 0; i < argc; i++) {
2796 check_and_export_method(self, argv[i], visi);
2797 }
2798 }
2799}
2800
2801static VALUE
2802set_visibility(int argc, const VALUE *argv, VALUE module, rb_method_visibility_t visi)
2803{
2804 if (argc == 0) {
2805 scope_visibility_check();
2806 rb_scope_visibility_set(visi);
2807 return Qnil;
2808 }
2809
2810 set_method_visibility(module, argc, argv, visi);
2811 if (argc == 1) {
2812 return argv[0];
2813 }
2814 return rb_ary_new_from_values(argc, argv);
2815}
2816
2817/*
2818 * call-seq:
2819 * public -> nil
2820 * public(method_name) -> method_name
2821 * public(method_name, method_name, ...) -> array
2822 * public(array) -> array
2823 *
2824 * With no arguments, sets the default visibility for subsequently
2825 * defined methods to public. With arguments, sets the named methods to
2826 * have public visibility.
2827 * String arguments are converted to symbols.
2828 * An Array of Symbols and/or Strings is also accepted.
2829 * If a single argument is passed, it is returned.
2830 * If no argument is passed, nil is returned.
2831 * If multiple arguments are passed, the arguments are returned as an array.
2832 */
2833
2834static VALUE
2835rb_mod_public(int argc, VALUE *argv, VALUE module)
2836{
2837 return set_visibility(argc, argv, module, METHOD_VISI_PUBLIC);
2838}
2839
2840/*
2841 * call-seq:
2842 * protected -> nil
2843 * protected(method_name) -> method_name
2844 * protected(method_name, method_name, ...) -> array
2845 * protected(array) -> array
2846 *
2847 * Sets the visibility of a section or of a list of method names as protected.
2848 * Accepts no arguments, a splat of method names (symbols or strings) or an
2849 * array of method names. Returns the arguments that it received.
2850 *
2851 * == Important difference between protected in other languages
2852 *
2853 * Protected methods in Ruby are different from other languages such as Java,
2854 * where methods are marked as protected to give access to subclasses. In Ruby,
2855 * subclasses <b>already have access to all methods defined in the parent
2856 * class</b>, even private ones.
2857 *
2858 * Marking a method as protected allows <b>different objects of the same
2859 * class</b> to call it.
2860 *
2861 * One use case is for comparison methods, such as <code>==</code>, if we want
2862 * to expose a method for comparison between objects of the same class without
2863 * making the method public to objects of other classes.
2864 *
2865 * == Performance considerations
2866 *
2867 * Protected methods are slower than others because they can't use inline
2868 * cache.
2869 *
2870 * == Example
2871 *
2872 * class Account
2873 * # Mark balance as protected, so that we can compare between accounts
2874 * # without making it public.
2875 * attr_reader :balance
2876 * protected :balance
2877 *
2878 * def initialize(balance)
2879 * @balance = balance
2880 * end
2881 *
2882 * def >(other)
2883 * # The invocation to `other.balance` is allowed because `other` is a
2884 * # different object of the same class (Account).
2885 * balance > other.balance
2886 * end
2887 * end
2888 *
2889 * account1 = Account.new(100)
2890 * account2 = Account.new(50)
2891 *
2892 * account1 > account2 # => true (works)
2893 * account1.balance # => NoMethodError (fails because balance is not public)
2894 *
2895 * To show a private method on RDoc, use <code>:doc:</code> instead of this.
2896 */
2897
2898static VALUE
2899rb_mod_protected(int argc, VALUE *argv, VALUE module)
2900{
2901 return set_visibility(argc, argv, module, METHOD_VISI_PROTECTED);
2902}
2903
2904/*
2905 * call-seq:
2906 * private -> nil
2907 * private(method_name) -> method_name
2908 * private(method_name, method_name, ...) -> array
2909 * private(array) -> array
2910 *
2911 * With no arguments, sets the default visibility for subsequently
2912 * defined methods to private. With arguments, sets the named methods
2913 * to have private visibility.
2914 * String arguments are converted to symbols.
2915 * An Array of Symbols and/or Strings is also accepted.
2916 * If a single argument is passed, it is returned.
2917 * If no argument is passed, nil is returned.
2918 * If multiple arguments are passed, the arguments are returned as an array.
2919 *
2920 * module Mod
2921 * def a() end
2922 * def b() end
2923 * private
2924 * def c() end
2925 * private :a
2926 * end
2927 * Mod.private_instance_methods #=> [:a, :c]
2928 *
2929 * Note that to show a private method on RDoc, use <code>:doc:</code>.
2930 */
2931
2932static VALUE
2933rb_mod_private(int argc, VALUE *argv, VALUE module)
2934{
2935 return set_visibility(argc, argv, module, METHOD_VISI_PRIVATE);
2936}
2937
2938/*
2939 * call-seq:
2940 * ruby2_keywords(method_name, ...) -> nil
2941 *
2942 * For the given method names, marks the method as passing keywords through
2943 * a normal argument splat. This should only be called on methods that
2944 * accept an argument splat (<tt>*args</tt>) but not explicit keywords or
2945 * a keyword splat. It marks the method such that if the method is called
2946 * with keyword arguments, the final hash argument is marked with a special
2947 * flag such that if it is the final element of a normal argument splat to
2948 * another method call, and that method call does not include explicit
2949 * keywords or a keyword splat, the final element is interpreted as keywords.
2950 * In other words, keywords will be passed through the method to other
2951 * methods.
2952 *
2953 * This should only be used for methods that delegate keywords to another
2954 * method, and only for backwards compatibility with Ruby versions before 3.0.
2955 * See https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
2956 * for details on why +ruby2_keywords+ exists and when and how to use it.
2957 *
2958 * This method will probably be removed at some point, as it exists only
2959 * for backwards compatibility. As it does not exist in Ruby versions before
2960 * 2.7, check that the module responds to this method before calling it:
2961 *
2962 * module Mod
2963 * def foo(meth, *args, &block)
2964 * send(:"do_#{meth}", *args, &block)
2965 * end
2966 * ruby2_keywords(:foo) if respond_to?(:ruby2_keywords, true)
2967 * end
2968 *
2969 * However, be aware that if the +ruby2_keywords+ method is removed, the
2970 * behavior of the +foo+ method using the above approach will change so that
2971 * the method does not pass through keywords.
2972 */
2973
2974static VALUE
2975rb_mod_ruby2_keywords(int argc, VALUE *argv, VALUE module)
2976{
2977 int i;
2978 VALUE origin_class = RCLASS_ORIGIN(module);
2979
2981 rb_check_frozen(module);
2982
2983 for (i = 0; i < argc; i++) {
2984 VALUE v = argv[i];
2985 ID name = rb_check_id(&v);
2987 VALUE defined_class;
2988
2989 if (!name) {
2990 rb_print_undef_str(module, v);
2991 }
2992
2993 me = search_method(origin_class, name, &defined_class);
2994 if (!me && RB_TYPE_P(module, T_MODULE)) {
2995 me = search_method(rb_cObject, name, &defined_class);
2996 }
2997
2998 if (UNDEFINED_METHOD_ENTRY_P(me) ||
2999 UNDEFINED_REFINED_METHOD_P(me->def)) {
3000 rb_print_undef(module, name, METHOD_VISI_UNDEF);
3001 }
3002
3003 if (module == defined_class || origin_class == defined_class) {
3004 switch (me->def->type) {
3005 case VM_METHOD_TYPE_ISEQ:
3006 if (ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_rest &&
3007 !ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_post &&
3008 !ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_kw &&
3009 !ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_kwrest) {
3010 ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.ruby2_keywords = 1;
3011 rb_clear_method_cache(module, name);
3012 }
3013 else {
3014 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));
3015 }
3016 break;
3017 case VM_METHOD_TYPE_BMETHOD: {
3018 VALUE procval = me->def->body.bmethod.proc;
3019 if (vm_block_handler_type(procval) == block_handler_type_proc) {
3020 procval = vm_proc_to_block_handler(VM_BH_TO_PROC(procval));
3021 }
3022
3023 if (vm_block_handler_type(procval) == block_handler_type_iseq) {
3024 const struct rb_captured_block *captured = VM_BH_TO_ISEQ_BLOCK(procval);
3025 const rb_iseq_t *iseq = rb_iseq_check(captured->code.iseq);
3026 if (ISEQ_BODY(iseq)->param.flags.has_rest &&
3027 !ISEQ_BODY(iseq)->param.flags.has_post &&
3028 !ISEQ_BODY(iseq)->param.flags.has_kw &&
3029 !ISEQ_BODY(iseq)->param.flags.has_kwrest) {
3030 ISEQ_BODY(iseq)->param.flags.ruby2_keywords = 1;
3031 rb_clear_method_cache(module, name);
3032 }
3033 else {
3034 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));
3035 }
3036 break;
3037 }
3038 }
3039 /* fallthrough */
3040 default:
3041 rb_warn("Skipping set of ruby2_keywords flag for %"PRIsVALUE" (method not defined in Ruby)", QUOTE_ID(name));
3042 break;
3043 }
3044 }
3045 else {
3046 rb_warn("Skipping set of ruby2_keywords flag for %"PRIsVALUE" (can only set in method defining module)", QUOTE_ID(name));
3047 }
3048 }
3049 return Qnil;
3050}
3051
3052/*
3053 * call-seq:
3054 * mod.public_class_method(symbol, ...) -> mod
3055 * mod.public_class_method(string, ...) -> mod
3056 * mod.public_class_method(array) -> mod
3057 *
3058 * Makes a list of existing class methods public.
3059 *
3060 * String arguments are converted to symbols.
3061 * An Array of Symbols and/or Strings is also accepted.
3062 */
3063
3064static VALUE
3065rb_mod_public_method(int argc, VALUE *argv, VALUE obj)
3066{
3067 set_method_visibility(rb_singleton_class(obj), argc, argv, METHOD_VISI_PUBLIC);
3068 return obj;
3069}
3070
3071/*
3072 * call-seq:
3073 * mod.private_class_method(symbol, ...) -> mod
3074 * mod.private_class_method(string, ...) -> mod
3075 * mod.private_class_method(array) -> mod
3076 *
3077 * Makes existing class methods private. Often used to hide the default
3078 * constructor <code>new</code>.
3079 *
3080 * String arguments are converted to symbols.
3081 * An Array of Symbols and/or Strings is also accepted.
3082 *
3083 * class SimpleSingleton # Not thread safe
3084 * private_class_method :new
3085 * def SimpleSingleton.create(*args, &block)
3086 * @me = new(*args, &block) if ! @me
3087 * @me
3088 * end
3089 * end
3090 */
3091
3092static VALUE
3093rb_mod_private_method(int argc, VALUE *argv, VALUE obj)
3094{
3095 set_method_visibility(rb_singleton_class(obj), argc, argv, METHOD_VISI_PRIVATE);
3096 return obj;
3097}
3098
3099/*
3100 * call-seq:
3101 * public
3102 * public(symbol, ...)
3103 * public(string, ...)
3104 * public(array)
3105 *
3106 * With no arguments, sets the default visibility for subsequently
3107 * defined methods to public. With arguments, sets the named methods to
3108 * have public visibility.
3109 *
3110 * String arguments are converted to symbols.
3111 * An Array of Symbols and/or Strings is also accepted.
3112 */
3113
3114static VALUE
3115top_public(int argc, VALUE *argv, VALUE _)
3116{
3117 return rb_mod_public(argc, argv, rb_top_main_class("public"));
3118}
3119
3120/*
3121 * call-seq:
3122 * private
3123 * private(symbol, ...)
3124 * private(string, ...)
3125 * private(array)
3126 *
3127 * With no arguments, sets the default visibility for subsequently
3128 * defined methods to private. With arguments, sets the named methods to
3129 * have private visibility.
3130 *
3131 * String arguments are converted to symbols.
3132 * An Array of Symbols and/or Strings is also accepted.
3133 */
3134static VALUE
3135top_private(int argc, VALUE *argv, VALUE _)
3136{
3137 return rb_mod_private(argc, argv, rb_top_main_class("private"));
3138}
3139
3140/*
3141 * call-seq:
3142 * ruby2_keywords(method_name, ...) -> self
3143 *
3144 * For the given method names, marks the method as passing keywords through
3145 * a normal argument splat. See Module#ruby2_keywords in detail.
3146 */
3147static VALUE
3148top_ruby2_keywords(int argc, VALUE *argv, VALUE module)
3149{
3150 return rb_mod_ruby2_keywords(argc, argv, rb_top_main_class("ruby2_keywords"));
3151}
3152
3153/*
3154 * call-seq:
3155 * module_function -> nil
3156 * module_function(method_name) -> method_name
3157 * module_function(method_name, method_name, ...) -> array
3158 *
3159 * Creates module functions for the named methods. These functions may
3160 * be called with the module as a receiver, and also become available
3161 * as instance methods to classes that mix in the module. Module
3162 * functions are copies of the original, and so may be changed
3163 * independently. The instance-method versions are made private. If
3164 * used with no arguments, subsequently defined methods become module
3165 * functions.
3166 * String arguments are converted to symbols.
3167 * If a single argument is passed, it is returned.
3168 * If no argument is passed, nil is returned.
3169 * If multiple arguments are passed, the arguments are returned as an array.
3170 *
3171 * module Mod
3172 * def one
3173 * "This is one"
3174 * end
3175 * module_function :one
3176 * end
3177 * class Cls
3178 * include Mod
3179 * def call_one
3180 * one
3181 * end
3182 * end
3183 * Mod.one #=> "This is one"
3184 * c = Cls.new
3185 * c.call_one #=> "This is one"
3186 * module Mod
3187 * def one
3188 * "This is the new one"
3189 * end
3190 * end
3191 * Mod.one #=> "This is one"
3192 * c.call_one #=> "This is the new one"
3193 */
3194
3195static VALUE
3196rb_mod_modfunc(int argc, VALUE *argv, VALUE module)
3197{
3198 int i;
3199 ID id;
3200 const rb_method_entry_t *me;
3201
3202 if (!RB_TYPE_P(module, T_MODULE)) {
3203 rb_raise(rb_eTypeError, "module_function must be called for modules");
3204 }
3205
3206 if (argc == 0) {
3207 rb_scope_module_func_set();
3208 return Qnil;
3209 }
3210
3211 set_method_visibility(module, argc, argv, METHOD_VISI_PRIVATE);
3212
3213 for (i = 0; i < argc; i++) {
3214 VALUE m = module;
3215
3216 id = rb_to_id(argv[i]);
3217 for (;;) {
3218 me = search_method(m, id, 0);
3219 if (me == 0) {
3220 me = search_method(rb_cObject, id, 0);
3221 }
3222 if (UNDEFINED_METHOD_ENTRY_P(me)) {
3223 rb_print_undef(module, id, METHOD_VISI_UNDEF);
3224 }
3225 if (me->def->type != VM_METHOD_TYPE_ZSUPER) {
3226 break; /* normal case: need not to follow 'super' link */
3227 }
3228 m = RCLASS_SUPER(m);
3229 if (!m)
3230 break;
3231 }
3232 rb_method_entry_set(rb_singleton_class(module), id, me, METHOD_VISI_PUBLIC);
3233 }
3234 if (argc == 1) {
3235 return argv[0];
3236 }
3237 return rb_ary_new_from_values(argc, argv);
3238}
3239
3240#ifdef __GNUC__
3241#pragma push_macro("rb_method_basic_definition_p")
3242#undef rb_method_basic_definition_p
3243#endif
3244int
3245rb_method_basic_definition_p(VALUE klass, ID id)
3246{
3247 const rb_callable_method_entry_t *cme;
3248 if (!klass) return TRUE; /* hidden object cannot be overridden */
3249 cme = rb_callable_method_entry(klass, id);
3250 return (cme && METHOD_ENTRY_BASIC(cme)) ? TRUE : FALSE;
3251}
3252#ifdef __GNUC__
3253#pragma pop_macro("rb_method_basic_definition_p")
3254#endif
3255
3256static VALUE
3257call_method_entry(rb_execution_context_t *ec, VALUE defined_class, VALUE obj, ID id,
3258 const rb_callable_method_entry_t *cme, int argc, const VALUE *argv, int kw_splat)
3259{
3260 VALUE passed_block_handler = vm_passed_block_handler(ec);
3261 VALUE result = rb_vm_call_kw(ec, obj, id, argc, argv, cme, kw_splat);
3262 vm_passed_block_handler_set(ec, passed_block_handler);
3263 return result;
3264}
3265
3266static VALUE
3267basic_obj_respond_to_missing(rb_execution_context_t *ec, VALUE klass, VALUE obj,
3268 VALUE mid, VALUE priv)
3269{
3270 VALUE defined_class, args[2];
3271 const ID rtmid = idRespond_to_missing;
3272 const rb_callable_method_entry_t *const cme = callable_method_entry(klass, rtmid, &defined_class);
3273
3274 if (!cme || METHOD_ENTRY_BASIC(cme)) return Qundef;
3275 args[0] = mid;
3276 args[1] = priv;
3277 return call_method_entry(ec, defined_class, obj, rtmid, cme, 2, args, RB_NO_KEYWORDS);
3278}
3279
3280static inline int
3281basic_obj_respond_to(rb_execution_context_t *ec, VALUE obj, ID id, int pub)
3282{
3283 VALUE klass = CLASS_OF(obj);
3284 VALUE ret;
3285
3286 switch (method_boundp(klass, id, pub|BOUND_RESPONDS)) {
3287 case 2:
3288 return FALSE;
3289 case 0:
3290 ret = basic_obj_respond_to_missing(ec, klass, obj, ID2SYM(id),
3291 RBOOL(!pub));
3292 return RTEST(ret) && !UNDEF_P(ret);
3293 default:
3294 return TRUE;
3295 }
3296}
3297
3298static int
3299vm_respond_to(rb_execution_context_t *ec, VALUE klass, VALUE obj, ID id, int priv)
3300{
3301 VALUE defined_class;
3302 const ID resid = idRespond_to;
3303 const rb_callable_method_entry_t *const cme = callable_method_entry(klass, resid, &defined_class);
3304
3305 if (!cme) return -1;
3306 if (METHOD_ENTRY_BASIC(cme)) {
3307 return -1;
3308 }
3309 else {
3310 int argc = 1;
3311 VALUE args[2];
3312 VALUE result;
3313
3314 args[0] = ID2SYM(id);
3315 args[1] = Qtrue;
3316 if (priv) {
3317 argc = rb_method_entry_arity((const rb_method_entry_t *)cme);
3318 if (argc > 2) {
3319 rb_raise(rb_eArgError,
3320 "respond_to? must accept 1 or 2 arguments (requires %d)",
3321 argc);
3322 }
3323 if (argc != 1) {
3324 argc = 2;
3325 }
3326 else if (!NIL_P(ruby_verbose)) {
3327 VALUE location = rb_method_entry_location((const rb_method_entry_t *)cme);
3329 "%"PRIsVALUE"%c""respond_to?(:%"PRIsVALUE") uses"
3330 " the deprecated method signature, which takes one parameter",
3331 (RCLASS_SINGLETON_P(klass) ? obj : klass),
3332 (RCLASS_SINGLETON_P(klass) ? '.' : '#'),
3333 QUOTE_ID(id));
3334 if (!NIL_P(location)) {
3335 VALUE path = RARRAY_AREF(location, 0);
3336 VALUE line = RARRAY_AREF(location, 1);
3337 if (!NIL_P(path)) {
3339 RSTRING_PTR(path), NUM2INT(line),
3340 "respond_to? is defined here");
3341 }
3342 }
3343 }
3344 }
3345 result = call_method_entry(ec, defined_class, obj, resid, cme, argc, args, RB_NO_KEYWORDS);
3346 return RTEST(result);
3347 }
3348}
3349
3350int
3351rb_obj_respond_to(VALUE obj, ID id, int priv)
3352{
3353 rb_execution_context_t *ec = GET_EC();
3354 return rb_ec_obj_respond_to(ec, obj, id, priv);
3355}
3356
3357int
3358rb_ec_obj_respond_to(rb_execution_context_t *ec, VALUE obj, ID id, int priv)
3359{
3360 VALUE klass = CLASS_OF(obj);
3361 int ret = vm_respond_to(ec, klass, obj, id, priv);
3362 if (ret == -1) ret = basic_obj_respond_to(ec, obj, id, !priv);
3363 return ret;
3364}
3365
3366int
3368{
3369 return rb_obj_respond_to(obj, id, FALSE);
3370}
3371
3372
3373/*
3374 * call-seq:
3375 * obj.respond_to?(symbol, include_all=false) -> true or false
3376 * obj.respond_to?(string, include_all=false) -> true or false
3377 *
3378 * Returns +true+ if _obj_ responds to the given method. Private and
3379 * protected methods are included in the search only if the optional
3380 * second parameter evaluates to +true+.
3381 *
3382 * If the method is not implemented,
3383 * as Process.fork on Windows, File.lchmod on GNU/Linux, etc.,
3384 * false is returned.
3385 *
3386 * If the method is not defined, <code>respond_to_missing?</code>
3387 * method is called and the result is returned.
3388 *
3389 * When the method name parameter is given as a string, the string is
3390 * converted to a symbol.
3391 */
3392
3393static VALUE
3394obj_respond_to(int argc, VALUE *argv, VALUE obj)
3395{
3396 VALUE mid, priv;
3397 ID id;
3398 rb_execution_context_t *ec = GET_EC();
3399
3400 rb_scan_args(argc, argv, "11", &mid, &priv);
3401 if (!(id = rb_check_id(&mid))) {
3402 VALUE ret = basic_obj_respond_to_missing(ec, CLASS_OF(obj), obj,
3403 rb_to_symbol(mid), priv);
3404 if (UNDEF_P(ret)) ret = Qfalse;
3405 return ret;
3406 }
3407 return RBOOL(basic_obj_respond_to(ec, obj, id, !RTEST(priv)));
3408}
3409
3410/*
3411 * call-seq:
3412 * obj.respond_to_missing?(symbol, include_all) -> true or false
3413 * obj.respond_to_missing?(string, include_all) -> true or false
3414 *
3415 * DO NOT USE THIS DIRECTLY.
3416 *
3417 * Hook method to return whether the _obj_ can respond to _id_ method
3418 * or not.
3419 *
3420 * When the method name parameter is given as a string, the string is
3421 * converted to a symbol.
3422 *
3423 * See #respond_to?, and the example of BasicObject.
3424 */
3425static VALUE
3426obj_respond_to_missing(VALUE obj, VALUE mid, VALUE priv)
3427{
3428 return Qfalse;
3429}
3430
3431void
3432Init_eval_method(void)
3433{
3434 rb_define_method(rb_mKernel, "respond_to?", obj_respond_to, -1);
3435 rb_define_method(rb_mKernel, "respond_to_missing?", obj_respond_to_missing, 2);
3436
3437 rb_define_method(rb_cModule, "remove_method", rb_mod_remove_method, -1);
3438 rb_define_method(rb_cModule, "undef_method", rb_mod_undef_method, -1);
3439 rb_define_method(rb_cModule, "alias_method", rb_mod_alias_method, 2);
3440 rb_define_private_method(rb_cModule, "public", rb_mod_public, -1);
3441 rb_define_private_method(rb_cModule, "protected", rb_mod_protected, -1);
3442 rb_define_private_method(rb_cModule, "private", rb_mod_private, -1);
3443 rb_define_private_method(rb_cModule, "module_function", rb_mod_modfunc, -1);
3444 rb_define_private_method(rb_cModule, "ruby2_keywords", rb_mod_ruby2_keywords, -1);
3445
3446 rb_define_method(rb_cModule, "method_defined?", rb_mod_method_defined, -1);
3447 rb_define_method(rb_cModule, "public_method_defined?", rb_mod_public_method_defined, -1);
3448 rb_define_method(rb_cModule, "private_method_defined?", rb_mod_private_method_defined, -1);
3449 rb_define_method(rb_cModule, "protected_method_defined?", rb_mod_protected_method_defined, -1);
3450 rb_define_method(rb_cModule, "public_class_method", rb_mod_public_method, -1);
3451 rb_define_method(rb_cModule, "private_class_method", rb_mod_private_method, -1);
3452
3454 "public", top_public, -1);
3456 "private", top_private, -1);
3458 "ruby2_keywords", top_ruby2_keywords, -1);
3459
3460 {
3461#define REPLICATE_METHOD(klass, id) do { \
3462 const rb_method_entry_t *me = rb_method_entry((klass), (id)); \
3463 rb_method_entry_set((klass), (id), me, METHOD_ENTRY_VISI(me)); \
3464 } while (0)
3465
3466 REPLICATE_METHOD(rb_eException, idMethodMissing);
3467 REPLICATE_METHOD(rb_eException, idRespond_to);
3468 REPLICATE_METHOD(rb_eException, idRespond_to_missing);
3469 }
3470}
#define RUBY_ASSERT_ALWAYS(expr,...)
A variant of RUBY_ASSERT that does not interface with RUBY_DEBUG.
Definition assert.h:199
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
Definition atomic.h:69
#define RUBY_ATOMIC_FETCH_ADD(var, val)
Atomically replaces the value pointed by var with the result of addition of val to the old value of v...
Definition atomic.h:118
#define RUBY_ATOMIC_FETCH_SUB(var, val)
Atomically replaces the value pointed by var with the result of subtraction of val to the old value o...
Definition atomic.h:129
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_private_method(klass, mid, func, arity)
Defines klass#mid and makes it private.
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
Definition class.c:2883
void rb_class_modify_check(VALUE klass)
Asserts that klass is not a frozen class.
Definition eval.c:421
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
Definition class.c:3221
#define xfree
Old name of ruby_xfree.
Definition xmalloc.h:58
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
Definition assume.h:29
#define ZALLOC
Old name of RB_ZALLOC.
Definition memory.h:402
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:205
#define T_MODULE
Old name of RUBY_T_MODULE.
Definition value_type.h:70
#define T_ICLASS
Old name of RUBY_T_ICLASS.
Definition value_type.h:66
#define rb_ary_new3
Old name of rb_ary_new_from_args.
Definition array.h:658
#define Qtrue
Old name of RUBY_Qtrue.
#define NUM2INT
Old name of RB_NUM2INT.
Definition int.h:44
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define NIL_P
Old name of RB_NIL_P.
#define T_CLASS
Old name of RUBY_T_CLASS.
Definition value_type.h:58
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition value_type.h:85
#define FL_TEST
Old name of RB_FL_TEST.
Definition fl_type.h:130
void rb_notimplement(void)
Definition error.c:3840
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:476
#define ruby_verbose
This variable controls whether the interpreter is in debug mode.
Definition error.h:475
VALUE rb_eTypeError
TypeError exception.
Definition error.c:1431
void rb_category_compile_warn(rb_warning_category_t category, const char *file, int line, const char *fmt,...)
Identical to rb_compile_warn(), except it also accepts category.
Definition error.c:439
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:466
VALUE rb_eException
Mother of all exceptions.
Definition error.c:1423
void rb_warning(const char *fmt,...)
Issues a warning.
Definition error.c:497
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
Definition error.h:48
VALUE rb_mKernel
Kernel module.
Definition object.c:60
VALUE rb_cModule
Module class.
Definition object.c:62
VALUE rb_equal(VALUE lhs, VALUE rhs)
This function is an optimised version of calling #==.
Definition object.c:177
#define RB_OBJ_WRITTEN(old, oldv, young)
Identical to RB_OBJ_WRITE(), except it doesn't write any values, but only a WB declaration.
Definition gc.h:615
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Definition gc.h:603
VALUE rb_ary_new_from_values(long n, const VALUE *elts)
Identical to rb_ary_new_from_args(), except how objects are passed.
VALUE rb_check_array_type(VALUE obj)
Try converting an object to its array representation using its to_ary method, if any.
VALUE rb_ary_freeze(VALUE obj)
Freeze an array, preventing further modifications.
void rb_undef(VALUE mod, ID mid)
Inserts a method entry that hides previous method definition of the given name.
Definition vm_method.c:2279
#define UNLIMITED_ARGUMENTS
This macro is used in conjunction with rb_check_arity().
Definition error.h:35
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
Definition error.h:284
#define rb_hash_uint(h, i)
Just another name of st_hash_uint.
Definition string.h:941
st_index_t rb_hash_start(st_index_t i)
Starts a series of hashing.
Definition random.c:1776
VALUE rb_mod_name(VALUE mod)
Queries the name of a module.
Definition variable.c:136
int rb_respond_to(VALUE obj, ID mid)
Queries if the object responds to the method.
Definition vm_method.c:3367
VALUE(* rb_alloc_func_t)(VALUE klass)
This is the type of functions that ruby calls when trying to allocate an object.
Definition vm.h:216
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
Definition vm_method.c:1625
void rb_alias(VALUE klass, ID dst, ID src)
Resembles alias.
Definition vm_method.c:2662
void rb_attr(VALUE klass, ID name, int need_reader, int need_writer, int honour_visibility)
This function resembles now-deprecated Module#attr.
Definition vm_method.c:2242
void rb_remove_method(VALUE klass, const char *name)
Removes a method.
Definition vm_method.c:2091
rb_alloc_func_t rb_get_alloc_func(VALUE klass)
Queries the allocator function of a class.
Definition vm_method.c:1631
void rb_clear_constant_cache_for_id(ID id)
Clears the inline constant caches associated with a particular ID.
Definition vm_method.c:320
void rb_remove_method_id(VALUE klass, ID mid)
Identical to rb_remove_method(), except it accepts the method name as ID.
Definition vm_method.c:2085
void rb_define_alloc_func(VALUE klass, rb_alloc_func_t func)
Sets the allocator function of a class.
VALUE rb_f_notimplement(int argc, const VALUE *argv, VALUE obj, VALUE marker)
Raises rb_eNotImpError.
Definition vm_method.c:792
int rb_method_boundp(VALUE klass, ID id, int ex)
Queries if the klass has this method.
Definition vm_method.c:2203
int rb_obj_respond_to(VALUE obj, ID mid, int private_p)
Identical to rb_respond_to(), except it additionally takes the visibility parameter.
Definition vm_method.c:3351
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
Definition symbol.c:1133
VALUE rb_to_symbol(VALUE name)
Identical to rb_intern_str(), except it generates a dynamic symbol if necessary.
Definition string.c:12508
ID rb_to_id(VALUE str)
Definition string.c:12498
int capa
Designed capacity of the buffer.
Definition io.h:11
VALUE type(ANYARGS)
ANYARGS-ed function type.
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
#define RARRAY_AREF(a, i)
Definition rarray.h:403
#define RBASIC(obj)
Convenient casting macro.
Definition rbasic.h:40
#define RCLASS_SUPER
Just another name of rb_class_get_superclass.
Definition rclass.h:44
#define RB_NO_KEYWORDS
Do not pass keywords.
Definition scan_args.h:69
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
Definition stdarg.h:35
#define ANYARGS
Functions declared using this macro take arbitrary arguments, including void.
Definition stdarg.h:64
Definition vm_method.c:379
Definition method.h:63
CREF (Class REFerence)
Definition method.h:45
This is the struct that holds necessary info for a struct.
Definition rtypeddata.h:202
size_t(* dsize)(const void *)
This function is to query the size of the underlying memory regions.
Definition rtypeddata.h:242
RUBY_DATA_FUNC dfree
This function is called when the object is no longer used.
Definition rtypeddata.h:232
struct rb_data_type_struct::@54 function
Function pointers.
const char * wrap_struct_name
Name of structs of this kind.
Definition rtypeddata.h:209
VALUE flags
Type-specific behavioural characteristics.
Definition rtypeddata.h:311
Definition method.h:55
rb_cref_t * cref
class reference, should be marked
Definition method.h:144
const rb_iseq_t * iseqptr
iseq pointer, should be separated from iseqval
Definition method.h:143
Definition st.h:79
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
Definition value_type.h:433
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376