Ruby 4.0.0dev (2025-12-14 revision b423204cb3851d1ad22d76578f7b516f1543c0dc)
vm_method.c (b423204cb3851d1ad22d76578f7b516f1543c0dc)
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 def->body.bmethod.defined_ractor_id = rb_ractor_id(rb_ec_ractor_ptr(GET_EC()));
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 /* give up to check all in a list */
1064 if (def->body.bmethod.hooks) rb_gc_writebarrier_remember((VALUE)me);
1065 break;
1066 case VM_METHOD_TYPE_REFINED:
1067 RB_OBJ_WRITTEN(me, Qundef, def->body.refined.orig_me);
1068 break;
1069 case VM_METHOD_TYPE_ALIAS:
1070 RB_OBJ_WRITTEN(me, Qundef, def->body.alias.original_me);
1071 break;
1072 case VM_METHOD_TYPE_CFUNC:
1073 case VM_METHOD_TYPE_ZSUPER:
1074 case VM_METHOD_TYPE_MISSING:
1075 case VM_METHOD_TYPE_OPTIMIZED:
1076 case VM_METHOD_TYPE_UNDEF:
1077 case VM_METHOD_TYPE_NOTIMPLEMENTED:
1078 break;
1079 }
1080}
1081
1082static rb_atomic_t method_serial = 1;
1083
1085rb_method_definition_create(rb_method_type_t type, ID mid)
1086{
1089 def->type = type;
1090 def->original_id = mid;
1091 def->method_serial = (uintptr_t)RUBY_ATOMIC_FETCH_ADD(method_serial, 1);
1092 def->box = rb_current_box();
1093 return def;
1094}
1095
1096static rb_method_entry_t *
1097rb_method_entry_alloc(ID called_id, VALUE owner, VALUE defined_class, rb_method_definition_t *def, bool complement)
1098{
1099 if (def) method_definition_addref(def, complement);
1100 if (RTEST(defined_class)) {
1101 // not negative cache
1102 VM_ASSERT_TYPE2(defined_class, T_CLASS, T_ICLASS);
1103 }
1104 rb_method_entry_t *me = SHAREABLE_IMEMO_NEW(rb_method_entry_t, imemo_ment, defined_class);
1105 *((rb_method_definition_t **)&me->def) = def;
1106 me->called_id = called_id;
1107 me->owner = owner;
1108
1109 return me;
1110}
1111
1112static VALUE
1113filter_defined_class(VALUE klass)
1114{
1115 switch (BUILTIN_TYPE(klass)) {
1116 case T_CLASS:
1117 return klass;
1118 case T_MODULE:
1119 return 0;
1120 case T_ICLASS:
1121 break;
1122 default:
1123 break;
1124 }
1125 rb_bug("filter_defined_class: %s", rb_obj_info(klass));
1126}
1127
1129rb_method_entry_create(ID called_id, VALUE klass, rb_method_visibility_t visi, rb_method_definition_t *def)
1130{
1131 rb_method_entry_t *me = rb_method_entry_alloc(called_id, klass, filter_defined_class(klass), def, false);
1132 METHOD_ENTRY_FLAGS_SET(me, visi, ruby_running ? FALSE : TRUE);
1133 if (def != NULL) method_definition_reset(me);
1134 return me;
1135}
1136
1137// Return a cloned ME that's not invalidated (MEs are disposable for caching).
1138const rb_method_entry_t *
1139rb_method_entry_clone(const rb_method_entry_t *src_me)
1140{
1141 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));
1142
1143 METHOD_ENTRY_FLAGS_COPY(me, src_me);
1144
1145 // Also clone inner ME in case of refinement ME
1146 if (src_me->def &&
1147 src_me->def->type == VM_METHOD_TYPE_REFINED &&
1148 src_me->def->body.refined.orig_me) {
1149 const rb_method_entry_t *orig_me = src_me->def->body.refined.orig_me;
1150 VM_ASSERT(orig_me->def->type != VM_METHOD_TYPE_REFINED);
1151
1152 rb_method_entry_t *orig_clone = rb_method_entry_alloc(orig_me->called_id,
1153 orig_me->owner, orig_me->defined_class, orig_me->def, METHOD_ENTRY_COMPLEMENTED(orig_me));
1154 METHOD_ENTRY_FLAGS_COPY(orig_clone, orig_me);
1155
1156 // Clone definition, since writing a VALUE to a shared definition
1157 // can create reference edges we can't run WBs for.
1158 rb_method_definition_t *clone_def =
1159 rb_method_definition_create(VM_METHOD_TYPE_REFINED, src_me->called_id);
1160 rb_method_definition_set(me, clone_def, orig_clone);
1161 }
1162 return me;
1163}
1164
1166rb_method_entry_complement_defined_class(const rb_method_entry_t *src_me, ID called_id, VALUE defined_class)
1167{
1168 rb_method_definition_t *def = src_me->def;
1170 const rb_method_entry_t *refined_orig_me = NULL;
1171
1172 if (!src_me->defined_class &&
1173 def->type == VM_METHOD_TYPE_REFINED &&
1174 def->body.refined.orig_me) {
1175 const rb_method_entry_t *orig_me =
1176 rb_method_entry_clone(def->body.refined.orig_me);
1177 RB_OBJ_WRITE((VALUE)orig_me, &orig_me->defined_class, defined_class);
1178 refined_orig_me = orig_me;
1179 def = NULL;
1180 }
1181
1182 me = rb_method_entry_alloc(called_id, src_me->owner, defined_class, def, true);
1183 METHOD_ENTRY_FLAGS_COPY(me, src_me);
1184 METHOD_ENTRY_COMPLEMENTED_SET(me);
1185 if (!def) {
1186 def = rb_method_definition_create(VM_METHOD_TYPE_REFINED, called_id);
1187 rb_method_definition_set(me, def, (void *)refined_orig_me);
1188 }
1189
1190 VM_ASSERT_TYPE(me->owner, T_MODULE);
1191
1192 return (rb_callable_method_entry_t *)me;
1193}
1194
1195void
1196rb_method_entry_copy(rb_method_entry_t *dst, const rb_method_entry_t *src)
1197{
1198 rb_method_definition_release(dst->def);
1199 *(rb_method_definition_t **)&dst->def = method_definition_addref(src->def, METHOD_ENTRY_COMPLEMENTED(src));
1200 method_definition_reset(dst);
1201 dst->called_id = src->called_id;
1202 RB_OBJ_WRITE((VALUE)dst, &dst->owner, src->owner);
1203 RB_OBJ_WRITE((VALUE)dst, &dst->defined_class, src->defined_class);
1204 METHOD_ENTRY_FLAGS_COPY(dst, src);
1205}
1206
1207static void
1208make_method_entry_refined(VALUE owner, rb_method_entry_t *me)
1209{
1210 if (me->def->type == VM_METHOD_TYPE_REFINED) {
1211 return;
1212 }
1213 else {
1215
1216 rb_vm_check_redefinition_opt_method(me, me->owner);
1217
1218 struct rb_method_entry_struct *orig_me =
1219 rb_method_entry_alloc(me->called_id,
1220 me->owner,
1221 me->defined_class,
1222 me->def,
1223 true);
1224 METHOD_ENTRY_FLAGS_COPY(orig_me, me);
1225
1226 def = rb_method_definition_create(VM_METHOD_TYPE_REFINED, me->called_id);
1227 rb_method_definition_set(me, def, orig_me);
1228 METHOD_ENTRY_VISI_SET(me, METHOD_VISI_PUBLIC);
1229 }
1230}
1231
1232static inline rb_method_entry_t *
1233lookup_method_table(VALUE klass, ID id)
1234{
1235 st_data_t body;
1236 struct rb_id_table *m_tbl = RCLASS_M_TBL(klass);
1237
1238 if (rb_id_table_lookup(m_tbl, id, &body)) {
1239 return (rb_method_entry_t *) body;
1240 }
1241 else {
1242 return 0;
1243 }
1244}
1245
1246void
1247rb_add_refined_method_entry(VALUE refined_class, ID mid)
1248{
1249 rb_method_entry_t *me = lookup_method_table(refined_class, mid);
1250
1251 if (me) {
1252 make_method_entry_refined(refined_class, me);
1253 rb_clear_method_cache(refined_class, mid);
1254 }
1255 else {
1256 rb_add_method(refined_class, mid, VM_METHOD_TYPE_REFINED, 0, METHOD_VISI_PUBLIC);
1257 }
1258}
1259
1260static void
1261check_override_opt_method_i(VALUE klass, VALUE arg)
1262{
1263 ID mid = (ID)arg;
1264 const rb_method_entry_t *me, *newme;
1265
1266 if (vm_redefinition_check_flag(klass)) {
1267 me = lookup_method_table(RCLASS_ORIGIN(klass), mid);
1268 if (me) {
1269 newme = rb_method_entry(klass, mid);
1270 if (newme != me) rb_vm_check_redefinition_opt_method(me, me->owner);
1271 }
1272 }
1273 rb_class_foreach_subclass(klass, check_override_opt_method_i, (VALUE)mid);
1274}
1275
1276static void
1277check_override_opt_method(VALUE klass, VALUE mid)
1278{
1279 if (rb_vm_check_optimizable_mid(mid)) {
1280 check_override_opt_method_i(klass, mid);
1281 }
1282}
1283
1284static inline rb_method_entry_t* search_method0(VALUE klass, ID id, VALUE *defined_class_ptr, bool skip_refined);
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 bool search_superclass = type == VM_METHOD_TYPE_ZSUPER && !lookup_method_table(refined_class, mid);
1326 rb_add_refined_method_entry(refined_class, mid);
1327 if (search_superclass) {
1328 rb_method_entry_t *me = lookup_method_table(refined_class, mid);
1329 me->def->body.refined.orig_me = search_method0(refined_class, mid, NULL, true);
1330 }
1331 }
1332 if (type == VM_METHOD_TYPE_REFINED) {
1333 rb_method_entry_t *old_me = lookup_method_table(RCLASS_ORIGIN(klass), mid);
1334 if (old_me) rb_vm_check_redefinition_opt_method(old_me, klass);
1335 }
1336 else {
1337 klass = RCLASS_ORIGIN(klass);
1338 if (klass != orig_klass) {
1339 rb_clear_method_cache(orig_klass, mid);
1340 }
1341 }
1342 mtbl = RCLASS_WRITABLE_M_TBL(klass);
1343
1344 /* check re-definition */
1345 if (rb_id_table_lookup(mtbl, mid, &data)) {
1346 rb_method_entry_t *old_me = (rb_method_entry_t *)data;
1347 rb_method_definition_t *old_def = old_me->def;
1348
1349 if (rb_method_definition_eq(old_def, def)) return old_me;
1350 rb_vm_check_redefinition_opt_method(old_me, klass);
1351
1352 if (old_def->type == VM_METHOD_TYPE_REFINED) make_refined = 1;
1353
1354 if (RTEST(ruby_verbose) &&
1355 type != VM_METHOD_TYPE_UNDEF &&
1356 (old_def->aliased == false) &&
1357 (!old_def->no_redef_warning) &&
1358 !make_refined &&
1359 old_def->type != VM_METHOD_TYPE_UNDEF &&
1360 old_def->type != VM_METHOD_TYPE_ZSUPER &&
1361 old_def->type != VM_METHOD_TYPE_ALIAS) {
1362 const rb_iseq_t *iseq = 0;
1363
1364 switch (old_def->type) {
1365 case VM_METHOD_TYPE_ISEQ:
1366 iseq = def_iseq_ptr(old_def);
1367 break;
1368 case VM_METHOD_TYPE_BMETHOD:
1369 iseq = rb_proc_get_iseq(old_def->body.bmethod.proc, 0);
1370 break;
1371 default:
1372 break;
1373 }
1374 if (iseq) {
1375 rb_warning(
1376 "method redefined; discarding old %"PRIsVALUE"\n%s:%d: warning: previous definition of %"PRIsVALUE" was here",
1377 rb_id2str(mid),
1378 RSTRING_PTR(rb_iseq_path(iseq)),
1379 ISEQ_BODY(iseq)->location.first_lineno,
1380 rb_id2str(old_def->original_id)
1381 );
1382 }
1383 else {
1384 rb_warning("method redefined; discarding old %"PRIsVALUE, rb_id2str(mid));
1385 }
1386 }
1387 }
1388
1389 /* create method entry */
1390 me = rb_method_entry_create(mid, defined_class, visi, NULL);
1391 if (def == NULL) {
1392 def = rb_method_definition_create(type, original_id);
1393 }
1394 rb_method_definition_set(me, def, opts);
1395
1396 rb_clear_method_cache(klass, mid);
1397
1398 /* check mid */
1399 if (klass == rb_cObject) {
1400 switch (mid) {
1401 case idInitialize:
1402 case idRespond_to_missing:
1403 case idMethodMissing:
1404 case idRespond_to:
1405 rb_warn("redefining Object#%s may cause infinite loop", rb_id2name(mid));
1406 }
1407 }
1408 /* check mid */
1409 if (mid == object_id || mid == id__id__ || mid == id__send__) {
1410 if (type != VM_METHOD_TYPE_CFUNC && search_method(klass, mid, 0)) {
1411 rb_warn("redefining '%s' may cause serious problems", rb_id2name(mid));
1412 }
1413 }
1414
1415 if (make_refined) {
1416 make_method_entry_refined(klass, me);
1417 }
1418
1419 rb_method_table_insert(klass, mtbl, mid, me);
1420
1421 VM_ASSERT(me->def != NULL);
1422
1423 /* check optimized method override by a prepended module */
1424 if (RB_TYPE_P(orig_klass, T_MODULE)) {
1425 check_override_opt_method(klass, (VALUE)mid);
1426 }
1427
1428 return me;
1429}
1430
1431static st_table *
1432overloaded_cme_table(void)
1433{
1434 VM_ASSERT(GET_VM()->overloaded_cme_table != NULL);
1435 return GET_VM()->overloaded_cme_table;
1436}
1437
1438#if VM_CHECK_MODE > 0
1439static int
1440vm_dump_overloaded_cme_table(st_data_t key, st_data_t val, st_data_t dmy)
1441{
1442 fprintf(stderr, "key: "); rp(key);
1443 fprintf(stderr, "val: "); rp(val);
1444 return ST_CONTINUE;
1445}
1446
1447void
1448rb_vm_dump_overloaded_cme_table(void)
1449{
1450 fprintf(stderr, "== rb_vm_dump_overloaded_cme_table\n");
1451 st_foreach(overloaded_cme_table(), vm_dump_overloaded_cme_table, 0);
1452}
1453#endif
1454
1455static int
1456lookup_overloaded_cme_i(st_data_t *key, st_data_t *value, st_data_t data, int existing)
1457{
1458 if (existing) {
1459 const rb_callable_method_entry_t *cme = (const rb_callable_method_entry_t *)*key;
1460 const rb_callable_method_entry_t *monly_cme = (const rb_callable_method_entry_t *)*value;
1461 const rb_callable_method_entry_t **ptr = (const rb_callable_method_entry_t **)data;
1462
1463 if (rb_objspace_garbage_object_p((VALUE)cme) ||
1464 rb_objspace_garbage_object_p((VALUE)monly_cme)) {
1465 *ptr = NULL;
1466 return ST_DELETE;
1467 }
1468 else {
1469 *ptr = monly_cme;
1470 }
1471 }
1472
1473 return ST_STOP;
1474}
1475
1476static const rb_callable_method_entry_t *
1477lookup_overloaded_cme(const rb_callable_method_entry_t *cme)
1478{
1479 ASSERT_vm_locking();
1480
1481 const rb_callable_method_entry_t *monly_cme = NULL;
1482 st_update(overloaded_cme_table(), (st_data_t)cme, lookup_overloaded_cme_i, (st_data_t)&monly_cme);
1483 return monly_cme;
1484}
1485
1486#if VM_CHECK_MODE > 0
1488rb_vm_lookup_overloaded_cme(const rb_callable_method_entry_t *cme)
1489{
1490 return lookup_overloaded_cme(cme);
1491}
1492#endif
1493
1494static void
1495delete_overloaded_cme(const rb_callable_method_entry_t *cme)
1496{
1497 st_data_t cme_data = (st_data_t)cme;
1498 ASSERT_vm_locking();
1499 st_delete(overloaded_cme_table(), &cme_data, NULL);
1500}
1501
1502static const rb_callable_method_entry_t *
1503get_overloaded_cme(const rb_callable_method_entry_t *cme)
1504{
1505 const rb_callable_method_entry_t *monly_cme = lookup_overloaded_cme(cme);
1506
1507 if (monly_cme && !METHOD_ENTRY_INVALIDATED(monly_cme)) {
1508 return monly_cme;
1509 }
1510 else {
1511 // create
1512 rb_method_definition_t *def = rb_method_definition_create(VM_METHOD_TYPE_ISEQ, cme->def->original_id);
1513 rb_method_entry_t *me = rb_method_entry_alloc(cme->called_id,
1514 cme->owner,
1515 cme->defined_class,
1516 def,
1517 false);
1518
1519 RB_OBJ_WRITE(me, &def->body.iseq.cref, cme->def->body.iseq.cref);
1520 RB_OBJ_WRITE(me, &def->body.iseq.iseqptr, ISEQ_BODY(cme->def->body.iseq.iseqptr)->mandatory_only_iseq);
1521
1522 ASSERT_vm_locking();
1523 st_insert(overloaded_cme_table(), (st_data_t)cme, (st_data_t)me);
1524
1525 METHOD_ENTRY_VISI_SET(me, METHOD_ENTRY_VISI(cme));
1526 return (rb_callable_method_entry_t *)me;
1527 }
1528}
1529
1531rb_check_overloaded_cme(const rb_callable_method_entry_t *cme, const struct rb_callinfo * const ci)
1532{
1533 if (UNLIKELY(cme->def->iseq_overload) &&
1534 (vm_ci_flag(ci) & (VM_CALL_ARGS_SIMPLE)) &&
1535 (!(vm_ci_flag(ci) & VM_CALL_FORWARDING)) &&
1536 (int)vm_ci_argc(ci) == ISEQ_BODY(method_entry_iseqptr(cme))->param.lead_num) {
1537 VM_ASSERT(cme->def->type == VM_METHOD_TYPE_ISEQ, "type: %d", cme->def->type); // iseq_overload is marked only on ISEQ methods
1538
1539 cme = get_overloaded_cme(cme);
1540
1541 VM_ASSERT(cme != NULL);
1542 METHOD_ENTRY_CACHED_SET((struct rb_callable_method_entry_struct *)cme);
1543 }
1544
1545 return cme;
1546}
1547
1548#define CALL_METHOD_HOOK(klass, hook, mid) do { \
1549 const VALUE arg = ID2SYM(mid); \
1550 VALUE recv_class = (klass); \
1551 ID hook_id = (hook); \
1552 if (RCLASS_SINGLETON_P((klass))) { \
1553 recv_class = RCLASS_ATTACHED_OBJECT((klass)); \
1554 hook_id = singleton_##hook; \
1555 } \
1556 rb_funcallv(recv_class, hook_id, 1, &arg); \
1557 } while (0)
1558
1559static void
1560method_added(VALUE klass, ID mid)
1561{
1562 if (ruby_running) {
1563 CALL_METHOD_HOOK(klass, added, mid);
1564 }
1565}
1566
1567void
1568rb_add_method(VALUE klass, ID mid, rb_method_type_t type, void *opts, rb_method_visibility_t visi)
1569{
1570 RB_VM_LOCKING() {
1571 rb_method_entry_make(klass, mid, klass, visi, type, NULL, mid, opts);
1572 }
1573
1574 if (type != VM_METHOD_TYPE_UNDEF && type != VM_METHOD_TYPE_REFINED) {
1575 method_added(klass, mid);
1576 }
1577}
1578
1579void
1580rb_add_method_iseq(VALUE klass, ID mid, const rb_iseq_t *iseq, rb_cref_t *cref, rb_method_visibility_t visi)
1581{
1582 struct { /* should be same fields with rb_method_iseq_struct */
1583 const rb_iseq_t *iseqptr;
1584 rb_cref_t *cref;
1585 } iseq_body;
1586
1587 iseq_body.iseqptr = iseq;
1588 iseq_body.cref = cref;
1589
1590 rb_add_method(klass, mid, VM_METHOD_TYPE_ISEQ, &iseq_body, visi);
1591}
1592
1593static rb_method_entry_t *
1594method_entry_set(VALUE klass, ID mid, const rb_method_entry_t *me,
1595 rb_method_visibility_t visi, VALUE defined_class)
1596{
1597 rb_method_entry_t *newme;
1598 RB_VM_LOCKING() {
1599 newme = rb_method_entry_make(klass, mid, defined_class, visi,
1600 me->def->type, me->def, 0, NULL);
1601 if (newme == me) {
1602 me->def->no_redef_warning = TRUE;
1603 METHOD_ENTRY_FLAGS_SET(newme, visi, FALSE);
1604 }
1605 }
1606
1607 method_added(klass, mid);
1608 return newme;
1609}
1610
1612rb_method_entry_set(VALUE klass, ID mid, const rb_method_entry_t *me, rb_method_visibility_t visi)
1613{
1614 return method_entry_set(klass, mid, me, visi, klass);
1615}
1616
1617#define UNDEF_ALLOC_FUNC ((rb_alloc_func_t)-1)
1618
1619void
1620rb_define_alloc_func(VALUE klass, VALUE (*func)(VALUE))
1621{
1622 Check_Type(klass, T_CLASS);
1623 if (RCLASS_SINGLETON_P(klass)) {
1624 rb_raise(rb_eTypeError, "can't define an allocator for a singleton class");
1625 }
1626 RCLASS_SET_ALLOCATOR(klass, func);
1627}
1628
1629void
1631{
1632 rb_define_alloc_func(klass, UNDEF_ALLOC_FUNC);
1633}
1634
1637{
1638 RBIMPL_ASSERT_TYPE(klass, T_CLASS);
1639
1640 rb_alloc_func_t allocator = RCLASS_ALLOCATOR(klass);
1641 if (allocator == UNDEF_ALLOC_FUNC) return 0;
1642 if (allocator) return allocator;
1643
1644 VALUE *superclasses = RCLASS_SUPERCLASSES(klass);
1645 size_t depth = RCLASS_SUPERCLASS_DEPTH(klass);
1646
1647 for (size_t i = depth; i > 0; i--) {
1648 klass = superclasses[i - 1];
1649 RBIMPL_ASSERT_TYPE(klass, T_CLASS);
1650
1651 allocator = RCLASS_ALLOCATOR(klass);
1652 if (allocator == UNDEF_ALLOC_FUNC) break;
1653 if (allocator) return allocator;
1654 }
1655 return 0;
1656}
1657
1658const rb_method_entry_t *
1659rb_method_entry_at(VALUE klass, ID id)
1660{
1661 return lookup_method_table(klass, id);
1662}
1663
1664static inline rb_method_entry_t*
1665search_method0(VALUE klass, ID id, VALUE *defined_class_ptr, bool skip_refined)
1666{
1667 rb_method_entry_t *me = NULL;
1668
1669 RB_DEBUG_COUNTER_INC(mc_search);
1670
1671 for (; klass; klass = RCLASS_SUPER(klass)) {
1672 RB_DEBUG_COUNTER_INC(mc_search_super);
1673 if ((me = lookup_method_table(klass, id)) != 0) {
1674 if (!skip_refined || me->def->type != VM_METHOD_TYPE_REFINED ||
1675 me->def->body.refined.orig_me) {
1676 break;
1677 }
1678 }
1679 }
1680
1681 if (defined_class_ptr) *defined_class_ptr = klass;
1682
1683 if (me == NULL) RB_DEBUG_COUNTER_INC(mc_search_notfound);
1684
1685 VM_ASSERT(me == NULL || !METHOD_ENTRY_INVALIDATED(me),
1686 "invalid me, mid:%s, klass:%s(%s)",
1687 rb_id2name(id),
1688 RTEST(rb_mod_name(klass)) ? RSTRING_PTR(rb_mod_name(klass)) : "anonymous",
1689 rb_obj_info(klass));
1690 return me;
1691}
1692
1693static inline rb_method_entry_t*
1694search_method(VALUE klass, ID id, VALUE *defined_class_ptr)
1695{
1696 return search_method0(klass, id, defined_class_ptr, false);
1697}
1698
1699static rb_method_entry_t *
1700search_method_protect(VALUE klass, ID id, VALUE *defined_class_ptr)
1701{
1702 rb_method_entry_t *me = search_method(klass, id, defined_class_ptr);
1703
1704 if (!UNDEFINED_METHOD_ENTRY_P(me)) {
1705 return me;
1706 }
1707 else {
1708 return NULL;
1709 }
1710}
1711
1712const rb_method_entry_t *
1713rb_method_entry(VALUE klass, ID id)
1714{
1715 return search_method_protect(klass, id, NULL);
1716}
1717
1718static inline const rb_callable_method_entry_t *
1719prepare_callable_method_entry(VALUE defined_class, ID id, const rb_method_entry_t * const me, int create)
1720{
1721 struct rb_id_table *mtbl;
1722 const rb_callable_method_entry_t *cme;
1723 VALUE cme_data;
1724 int cme_found = 0;
1725
1726 if (me) {
1727 if (me->defined_class == 0) {
1728 RB_DEBUG_COUNTER_INC(mc_cme_complement);
1729 VM_ASSERT_TYPE2(defined_class, T_ICLASS, T_MODULE);
1730
1731 mtbl = RCLASS_WRITABLE_CALLABLE_M_TBL(defined_class);
1732 if (mtbl && rb_id_table_lookup(mtbl, id, &cme_data)) {
1733 cme = (rb_callable_method_entry_t *)cme_data;
1734 cme_found = 1;
1735 }
1736 if (cme_found) {
1737 RB_DEBUG_COUNTER_INC(mc_cme_complement_hit);
1738 VM_ASSERT(callable_method_entry_p(cme));
1739 VM_ASSERT(!METHOD_ENTRY_INVALIDATED(cme));
1740 }
1741 else if (create) {
1742 if (!mtbl) {
1743 mtbl = rb_id_table_create(0);
1744 RCLASS_WRITE_CALLABLE_M_TBL(defined_class, mtbl);
1745 }
1746 cme = rb_method_entry_complement_defined_class(me, me->called_id, defined_class);
1747 rb_id_table_insert(mtbl, id, (VALUE)cme);
1748 RB_OBJ_WRITTEN(defined_class, Qundef, (VALUE)cme);
1749 VM_ASSERT(callable_method_entry_p(cme));
1750 }
1751 else {
1752 return NULL;
1753 }
1754 }
1755 else {
1756 cme = (const rb_callable_method_entry_t *)me;
1757 VM_ASSERT(callable_method_entry_p(cme));
1758 VM_ASSERT(!METHOD_ENTRY_INVALIDATED(cme));
1759 }
1760 return cme;
1761 }
1762 else {
1763 return NULL;
1764 }
1765}
1766
1767static const rb_callable_method_entry_t *
1768complemented_callable_method_entry(VALUE klass, ID id)
1769{
1770 VALUE defined_class;
1771 rb_method_entry_t *me = search_method(klass, id, &defined_class);
1772 return prepare_callable_method_entry(defined_class, id, me, FALSE);
1773}
1774
1775static const rb_callable_method_entry_t *
1776cached_callable_method_entry(VALUE klass, ID mid)
1777{
1778 ASSERT_vm_locking();
1779
1780 VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass);
1781 VALUE ccs_data;
1782
1783 if (cc_tbl && rb_managed_id_table_lookup(cc_tbl, mid, &ccs_data)) {
1784 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data;
1785 VM_ASSERT(vm_ccs_p(ccs));
1786
1787 if (LIKELY(!METHOD_ENTRY_INVALIDATED(ccs->cme))) {
1788 VM_ASSERT(ccs->cme->called_id == mid);
1789 RB_DEBUG_COUNTER_INC(ccs_found);
1790 return ccs->cme;
1791 }
1792 else {
1793 rb_vm_barrier();
1794
1795 rb_managed_id_table_delete(cc_tbl, mid);
1796 rb_vm_ccs_invalidate_and_free(ccs);
1797 }
1798 }
1799
1800 RB_DEBUG_COUNTER_INC(ccs_not_found);
1801 return NULL;
1802}
1803
1804static void
1805cache_callable_method_entry(VALUE klass, ID mid, const rb_callable_method_entry_t *cme)
1806{
1807 ASSERT_vm_locking();
1808 VM_ASSERT(cme != NULL);
1809
1810 VALUE cc_tbl = RCLASS_WRITABLE_CC_TBL(klass);
1811 VALUE ccs_data;
1812
1813 if (!cc_tbl) {
1814 cc_tbl = rb_vm_cc_table_create(2);
1815 RCLASS_WRITE_CC_TBL(klass, cc_tbl);
1816 }
1817
1818 if (rb_managed_id_table_lookup(cc_tbl, mid, &ccs_data)) {
1819#if VM_CHECK_MODE > 0
1820 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data;
1821 VM_ASSERT(ccs->cme == cme);
1822#endif
1823 }
1824 else {
1825 if (rb_multi_ractor_p()) {
1826 VALUE new_cc_tbl = rb_vm_cc_table_dup(cc_tbl);
1827 vm_ccs_create(klass, new_cc_tbl, mid, cme);
1828 RB_OBJ_ATOMIC_WRITE(klass, &RCLASSEXT_CC_TBL(RCLASS_EXT_WRITABLE(klass)), new_cc_tbl);
1829 }
1830 else {
1831 vm_ccs_create(klass, cc_tbl, mid, cme);
1832 }
1833 }
1834}
1835
1836static const rb_callable_method_entry_t *
1837negative_cme(ID mid)
1838{
1839 rb_vm_t *vm = GET_VM();
1840 const rb_callable_method_entry_t *cme;
1841 VALUE cme_data;
1842
1843 if (rb_id_table_lookup(vm->negative_cme_table, mid, &cme_data)) {
1844 cme = (rb_callable_method_entry_t *)cme_data;
1845 }
1846 else {
1847 cme = (rb_callable_method_entry_t *)rb_method_entry_alloc(mid, Qnil, Qnil, NULL, false);
1848 rb_id_table_insert(vm->negative_cme_table, mid, (VALUE)cme);
1849 }
1850
1851 VM_ASSERT(cme != NULL);
1852 return cme;
1853}
1854
1855static const rb_callable_method_entry_t *
1856callable_method_entry_or_negative(VALUE klass, ID mid, VALUE *defined_class_ptr)
1857{
1858 const rb_callable_method_entry_t *cme;
1859
1860 VM_ASSERT_TYPE2(klass, T_CLASS, T_ICLASS);
1861
1862 /* Fast path: lock-free read from cache */
1863 VALUE cc_tbl = RUBY_ATOMIC_VALUE_LOAD(RCLASS_WRITABLE_CC_TBL(klass));
1864 if (cc_tbl) {
1865 VALUE ccs_data;
1866 if (rb_managed_id_table_lookup(cc_tbl, mid, &ccs_data)) {
1867 struct rb_class_cc_entries *ccs = (struct rb_class_cc_entries *)ccs_data;
1868 VM_ASSERT(vm_ccs_p(ccs));
1869
1870 if (LIKELY(!METHOD_ENTRY_INVALIDATED(ccs->cme))) {
1871 VM_ASSERT(ccs->cme->called_id == mid);
1872 if (defined_class_ptr != NULL) *defined_class_ptr = ccs->cme->defined_class;
1873 RB_DEBUG_COUNTER_INC(ccs_found);
1874 return ccs->cme;
1875 }
1876 }
1877 }
1878
1879 /* Slow path: need to lock and potentially populate cache */
1880 RB_VM_LOCKING() {
1881 cme = cached_callable_method_entry(klass, mid);
1882
1883 if (cme) {
1884 if (defined_class_ptr != NULL) *defined_class_ptr = cme->defined_class;
1885 }
1886 else {
1887 VALUE defined_class;
1888 rb_method_entry_t *me = search_method(klass, mid, &defined_class);
1889 if (defined_class_ptr) *defined_class_ptr = defined_class;
1890
1891 if (me != NULL) {
1892 cme = prepare_callable_method_entry(defined_class, mid, me, TRUE);
1893 }
1894 else {
1895 cme = negative_cme(mid);
1896 }
1897
1898 cache_callable_method_entry(klass, mid, cme);
1899 }
1900 }
1901
1902 return cme;
1903}
1904
1905// This is exposed for YJIT so that we can make assumptions that methods are
1906// not defined.
1908rb_callable_method_entry_or_negative(VALUE klass, ID mid)
1909{
1910 return callable_method_entry_or_negative(klass, mid, NULL);
1911}
1912
1913static const rb_callable_method_entry_t *
1914callable_method_entry(VALUE klass, ID mid, VALUE *defined_class_ptr)
1915{
1916 const rb_callable_method_entry_t *cme;
1917 cme = callable_method_entry_or_negative(klass, mid, defined_class_ptr);
1918 return !UNDEFINED_METHOD_ENTRY_P(cme) ? cme : NULL;
1919}
1920
1922rb_callable_method_entry(VALUE klass, ID mid)
1923{
1924 return callable_method_entry(klass, mid, NULL);
1925}
1926
1927static const rb_method_entry_t *resolve_refined_method(VALUE refinements, const rb_method_entry_t *me, VALUE *defined_class_ptr);
1928
1929static const rb_method_entry_t *
1930method_entry_resolve_refinement(VALUE klass, ID id, int with_refinement, VALUE *defined_class_ptr)
1931{
1932 const rb_method_entry_t *me = search_method_protect(klass, id, defined_class_ptr);
1933
1934 if (me) {
1935 if (me->def->type == VM_METHOD_TYPE_REFINED) {
1936 if (with_refinement) {
1937 const rb_cref_t *cref = rb_vm_cref();
1938 VALUE refinements = cref ? CREF_REFINEMENTS(cref) : Qnil;
1939 me = resolve_refined_method(refinements, me, defined_class_ptr);
1940 }
1941 else {
1942 me = resolve_refined_method(Qnil, me, defined_class_ptr);
1943 }
1944
1945 if (UNDEFINED_METHOD_ENTRY_P(me)) me = NULL;
1946 }
1947 }
1948
1949 return me;
1950}
1951
1952const rb_method_entry_t *
1953rb_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1954{
1955 return method_entry_resolve_refinement(klass, id, TRUE, defined_class_ptr);
1956}
1957
1958static const rb_callable_method_entry_t *
1959callable_method_entry_refinements0(VALUE klass, ID id, VALUE *defined_class_ptr, bool with_refinements,
1960 const rb_callable_method_entry_t *cme)
1961{
1962 if (cme == NULL || LIKELY(cme->def->type != VM_METHOD_TYPE_REFINED)) {
1963 return cme;
1964 }
1965 else {
1966 VALUE defined_class, *dcp = defined_class_ptr ? defined_class_ptr : &defined_class;
1967 const rb_method_entry_t *me = method_entry_resolve_refinement(klass, id, with_refinements, dcp);
1968 return prepare_callable_method_entry(*dcp, id, me, TRUE);
1969 }
1970}
1971
1972static const rb_callable_method_entry_t *
1973callable_method_entry_refinements(VALUE klass, ID id, VALUE *defined_class_ptr, bool with_refinements)
1974{
1975 const rb_callable_method_entry_t *cme = callable_method_entry(klass, id, defined_class_ptr);
1976 return callable_method_entry_refinements0(klass, id, defined_class_ptr, with_refinements, cme);
1977}
1978
1980rb_callable_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1981{
1982 return callable_method_entry_refinements(klass, id, defined_class_ptr, true);
1983}
1984
1985static const rb_callable_method_entry_t *
1986callable_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1987{
1988 return callable_method_entry_refinements(klass, id, defined_class_ptr, false);
1989}
1990
1991const rb_method_entry_t *
1992rb_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1993{
1994 return method_entry_resolve_refinement(klass, id, FALSE, defined_class_ptr);
1995}
1996
1998rb_callable_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class_ptr)
1999{
2000 VALUE defined_class, *dcp = defined_class_ptr ? defined_class_ptr : &defined_class;
2001 const rb_method_entry_t *me = method_entry_resolve_refinement(klass, id, FALSE, dcp);
2002 return prepare_callable_method_entry(*dcp, id, me, TRUE);
2003}
2004
2005static const rb_method_entry_t *
2006resolve_refined_method(VALUE refinements, const rb_method_entry_t *me, VALUE *defined_class_ptr)
2007{
2008 while (me && me->def->type == VM_METHOD_TYPE_REFINED) {
2009 VALUE refinement;
2010 const rb_method_entry_t *tmp_me;
2011 VALUE super;
2012
2013 refinement = find_refinement(refinements, me->owner);
2014 if (!NIL_P(refinement)) {
2015 tmp_me = search_method_protect(refinement, me->called_id, defined_class_ptr);
2016
2017 if (tmp_me && tmp_me->def->type != VM_METHOD_TYPE_REFINED) {
2018 return tmp_me;
2019 }
2020 }
2021
2022 tmp_me = me->def->body.refined.orig_me;
2023 if (tmp_me) {
2024 if (!tmp_me->defined_class) {
2025 VM_ASSERT_TYPE(tmp_me->owner, T_MODULE);
2026 }
2027 else if (defined_class_ptr) {
2028 *defined_class_ptr = tmp_me->defined_class;
2029 }
2030 return tmp_me;
2031 }
2032
2033 super = RCLASS_SUPER(me->owner);
2034 if (!super) {
2035 return 0;
2036 }
2037
2038 me = search_method_protect(super, me->called_id, defined_class_ptr);
2039 }
2040 return me;
2041}
2042
2043const rb_method_entry_t *
2044rb_resolve_refined_method(VALUE refinements, const rb_method_entry_t *me)
2045{
2046 return resolve_refined_method(refinements, me, NULL);
2047}
2048
2050rb_resolve_refined_method_callable(VALUE refinements, const rb_callable_method_entry_t *me)
2051{
2052 VALUE defined_class = me->defined_class;
2053 const rb_method_entry_t *resolved_me = resolve_refined_method(refinements, (const rb_method_entry_t *)me, &defined_class);
2054
2055 if (resolved_me && resolved_me->defined_class == 0) {
2056 return rb_method_entry_complement_defined_class(resolved_me, me->called_id, defined_class);
2057 }
2058 else {
2059 return (const rb_callable_method_entry_t *)resolved_me;
2060 }
2061}
2062
2063static void
2064remove_method(VALUE klass, ID mid)
2065{
2066 VALUE data;
2067 rb_method_entry_t *me = 0;
2068 VALUE self = klass;
2069
2070 rb_class_modify_check(klass);
2071 klass = RCLASS_ORIGIN(klass);
2072 if (mid == object_id || mid == id__id__ || mid == id__send__ || mid == idInitialize) {
2073 rb_warn("removing '%s' may cause serious problems", rb_id2name(mid));
2074 }
2075
2076 if (!rb_id_table_lookup(RCLASS_M_TBL(klass), mid, &data) ||
2077 !(me = (rb_method_entry_t *)data) ||
2078 (!me->def || me->def->type == VM_METHOD_TYPE_UNDEF) ||
2079 UNDEFINED_REFINED_METHOD_P(me->def)) {
2080 rb_name_err_raise("method '%1$s' not defined in %2$s",
2081 klass, ID2SYM(mid));
2082 }
2083
2084 if (klass != self) {
2085 rb_clear_method_cache(self, mid);
2086 }
2087 rb_clear_method_cache(klass, mid);
2088 rb_id_table_delete(RCLASS_WRITABLE_M_TBL(klass), mid);
2089
2090 rb_vm_check_redefinition_opt_method(me, klass);
2091
2092 if (me->def->type == VM_METHOD_TYPE_REFINED) {
2093 rb_add_refined_method_entry(klass, mid);
2094 }
2095
2096 CALL_METHOD_HOOK(self, removed, mid);
2097}
2098
2099void
2101{
2102 remove_method(klass, mid);
2103}
2104
2105void
2106rb_remove_method(VALUE klass, const char *name)
2107{
2108 remove_method(klass, rb_intern(name));
2109}
2110
2111/*
2112 * call-seq:
2113 * remove_method(symbol) -> self
2114 * remove_method(string) -> self
2115 *
2116 * Removes the method identified by _symbol_ from the current
2117 * class. For an example, see Module#undef_method.
2118 * String arguments are converted to symbols.
2119 */
2120
2121static VALUE
2122rb_mod_remove_method(int argc, VALUE *argv, VALUE mod)
2123{
2124 int i;
2125
2126 for (i = 0; i < argc; i++) {
2127 VALUE v = argv[i];
2128 ID id = rb_check_id(&v);
2129 if (!id) {
2130 rb_name_err_raise("method '%1$s' not defined in %2$s",
2131 mod, v);
2132 }
2133 remove_method(mod, id);
2134 }
2135 return mod;
2136}
2137
2138static void
2139rb_export_method(VALUE klass, ID name, rb_method_visibility_t visi)
2140{
2142 VALUE defined_class;
2143 VALUE origin_class = RCLASS_ORIGIN(klass);
2144
2145 me = search_method0(origin_class, name, &defined_class, true);
2146
2147 if (!me && RB_TYPE_P(klass, T_MODULE)) {
2148 me = search_method(rb_cObject, name, &defined_class);
2149 }
2150
2151 if (UNDEFINED_METHOD_ENTRY_P(me) ||
2152 UNDEFINED_REFINED_METHOD_P(me->def)) {
2153 rb_print_undef(klass, name, METHOD_VISI_UNDEF);
2154 }
2155
2156 if (METHOD_ENTRY_VISI(me) != visi) {
2157 rb_vm_check_redefinition_opt_method(me, klass);
2158
2159 if (klass == defined_class || origin_class == defined_class) {
2160 if (me->def->type == VM_METHOD_TYPE_REFINED) {
2161 // Refinement method entries should always be public because the refinement
2162 // search is always performed.
2163 if (me->def->body.refined.orig_me) {
2164 METHOD_ENTRY_VISI_SET((rb_method_entry_t *)me->def->body.refined.orig_me, visi);
2165 }
2166 }
2167 else {
2168 METHOD_ENTRY_VISI_SET(me, visi);
2169 }
2170 rb_clear_method_cache(klass, name);
2171 }
2172 else {
2173 rb_add_method(klass, name, VM_METHOD_TYPE_ZSUPER, 0, visi);
2174 }
2175 }
2176}
2177
2178#define BOUND_PRIVATE 0x01
2179#define BOUND_RESPONDS 0x02
2180
2181static int
2182method_boundp(VALUE klass, ID id, int ex)
2183{
2184 const rb_callable_method_entry_t *cme;
2185
2186 VM_ASSERT_TYPE2(klass, T_CLASS, T_ICLASS);
2187
2188 if (ex & BOUND_RESPONDS) {
2189 cme = rb_callable_method_entry_with_refinements(klass, id, NULL);
2190 }
2191 else {
2192 cme = callable_method_entry_without_refinements(klass, id, NULL);
2193 }
2194
2195 if (cme != NULL) {
2196 if (ex & ~BOUND_RESPONDS) {
2197 switch (METHOD_ENTRY_VISI(cme)) {
2198 case METHOD_VISI_PRIVATE:
2199 return 0;
2200 case METHOD_VISI_PROTECTED:
2201 if (ex & BOUND_RESPONDS) return 0;
2202 default:
2203 break;
2204 }
2205 }
2206
2207 if (cme->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) {
2208 if (ex & BOUND_RESPONDS) return 2;
2209 return 0;
2210 }
2211 return 1;
2212 }
2213 return 0;
2214}
2215
2216// deprecated
2217int
2218rb_method_boundp(VALUE klass, ID id, int ex)
2219{
2220 return method_boundp(klass, id, ex);
2221}
2222
2223static void
2224vm_cref_set_visibility(rb_method_visibility_t method_visi, int module_func)
2225{
2226 rb_scope_visibility_t *scope_visi = (rb_scope_visibility_t *)&rb_vm_cref()->scope_visi;
2227 scope_visi->method_visi = method_visi;
2228 scope_visi->module_func = module_func;
2229}
2230
2231void
2232rb_scope_visibility_set(rb_method_visibility_t visi)
2233{
2234 vm_cref_set_visibility(visi, FALSE);
2235}
2236
2237static void
2238scope_visibility_check(void)
2239{
2240 /* Check for public/protected/private/module_function called inside a method */
2241 rb_control_frame_t *cfp = GET_EC()->cfp+1;
2242 if (cfp && cfp->iseq && ISEQ_BODY(cfp->iseq)->type == ISEQ_TYPE_METHOD) {
2243 rb_warn("calling %s without arguments inside a method may not have the intended effect",
2244 rb_id2name(rb_frame_this_func()));
2245 }
2246}
2247
2248static void
2249rb_scope_module_func_set(void)
2250{
2251 scope_visibility_check();
2252 vm_cref_set_visibility(METHOD_VISI_PRIVATE, TRUE);
2253}
2254
2255const rb_cref_t *rb_vm_cref_in_context(VALUE self, VALUE cbase);
2256void
2257rb_attr(VALUE klass, ID id, int read, int write, int ex)
2258{
2259 ID attriv;
2260 rb_method_visibility_t visi;
2261 const rb_execution_context_t *ec = GET_EC();
2262 const rb_cref_t *cref = rb_vm_cref_in_context(klass, klass);
2263
2264 if (!ex || !cref) {
2265 visi = METHOD_VISI_PUBLIC;
2266 }
2267 else {
2268 switch (vm_scope_visibility_get(ec)) {
2269 case METHOD_VISI_PRIVATE:
2270 if (vm_scope_module_func_check(ec)) {
2271 rb_warning("attribute accessor as module_function");
2272 }
2273 visi = METHOD_VISI_PRIVATE;
2274 break;
2275 case METHOD_VISI_PROTECTED:
2276 visi = METHOD_VISI_PROTECTED;
2277 break;
2278 default:
2279 visi = METHOD_VISI_PUBLIC;
2280 break;
2281 }
2282 }
2283
2284 attriv = rb_intern_str(rb_sprintf("@%"PRIsVALUE, rb_id2str(id)));
2285 if (read) {
2286 rb_add_method(klass, id, VM_METHOD_TYPE_IVAR, (void *)attriv, visi);
2287 }
2288 if (write) {
2289 rb_add_method(klass, rb_id_attrset(id), VM_METHOD_TYPE_ATTRSET, (void *)attriv, visi);
2290 }
2291}
2292
2293void
2295{
2296 const rb_method_entry_t *me;
2297
2298 if (NIL_P(klass)) {
2299 rb_raise(rb_eTypeError, "no class to undef method");
2300 }
2301 rb_class_modify_check(klass);
2302 if (id == object_id || id == id__id__ || id == id__send__ || id == idInitialize) {
2303 rb_warn("undefining '%s' may cause serious problems", rb_id2name(id));
2304 }
2305
2306 me = search_method(klass, id, 0);
2307 if (me && me->def->type == VM_METHOD_TYPE_REFINED) {
2308 me = rb_resolve_refined_method(Qnil, me);
2309 }
2310
2311 if (UNDEFINED_METHOD_ENTRY_P(me) ||
2312 UNDEFINED_REFINED_METHOD_P(me->def)) {
2313 rb_method_name_error(klass, rb_id2str(id));
2314 }
2315
2316 rb_add_method(klass, id, VM_METHOD_TYPE_UNDEF, 0, METHOD_VISI_PUBLIC);
2317
2318 CALL_METHOD_HOOK(klass, undefined, id);
2319}
2320
2321/*
2322 * call-seq:
2323 * undef_method(symbol) -> self
2324 * undef_method(string) -> self
2325 *
2326 * Prevents the current class from responding to calls to the named
2327 * method. Contrast this with <code>remove_method</code>, which deletes
2328 * the method from the particular class; Ruby will still search
2329 * superclasses and mixed-in modules for a possible receiver.
2330 * String arguments are converted to symbols.
2331 *
2332 * class Parent
2333 * def hello
2334 * puts "In parent"
2335 * end
2336 * end
2337 * class Child < Parent
2338 * def hello
2339 * puts "In child"
2340 * end
2341 * end
2342 *
2343 *
2344 * c = Child.new
2345 * c.hello
2346 *
2347 *
2348 * class Child
2349 * remove_method :hello # remove from child, still in parent
2350 * end
2351 * c.hello
2352 *
2353 *
2354 * class Child
2355 * undef_method :hello # prevent any calls to 'hello'
2356 * end
2357 * c.hello
2358 *
2359 * <em>produces:</em>
2360 *
2361 * In child
2362 * In parent
2363 * prog.rb:23: undefined method 'hello' for #<Child:0x401b3bb4> (NoMethodError)
2364 */
2365
2366static VALUE
2367rb_mod_undef_method(int argc, VALUE *argv, VALUE mod)
2368{
2369 int i;
2370 for (i = 0; i < argc; i++) {
2371 VALUE v = argv[i];
2372 ID id = rb_check_id(&v);
2373 if (!id) {
2374 rb_method_name_error(mod, v);
2375 }
2376 rb_undef(mod, id);
2377 }
2378 return mod;
2379}
2380
2381static rb_method_visibility_t
2382check_definition_visibility(VALUE mod, int argc, VALUE *argv)
2383{
2384 const rb_method_entry_t *me;
2385 VALUE mid, include_super, lookup_mod = mod;
2386 int inc_super;
2387 ID id;
2388
2389 rb_scan_args(argc, argv, "11", &mid, &include_super);
2390 id = rb_check_id(&mid);
2391 if (!id) return METHOD_VISI_UNDEF;
2392
2393 if (argc == 1) {
2394 inc_super = 1;
2395 }
2396 else {
2397 inc_super = RTEST(include_super);
2398 if (!inc_super) {
2399 lookup_mod = RCLASS_ORIGIN(mod);
2400 }
2401 }
2402
2403 me = rb_method_entry_without_refinements(lookup_mod, id, NULL);
2404 if (me) {
2405 if (me->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) return METHOD_VISI_UNDEF;
2406 if (!inc_super && me->owner != mod) return METHOD_VISI_UNDEF;
2407 return METHOD_ENTRY_VISI(me);
2408 }
2409 return METHOD_VISI_UNDEF;
2410}
2411
2412/*
2413 * call-seq:
2414 * mod.method_defined?(symbol, inherit=true) -> true or false
2415 * mod.method_defined?(string, inherit=true) -> true or false
2416 *
2417 * Returns +true+ if the named method is defined by
2418 * _mod_. If _inherit_ is set, the lookup will also search _mod_'s
2419 * ancestors. Public and protected methods are matched.
2420 * String arguments are converted to symbols.
2421 *
2422 * module A
2423 * def method1() end
2424 * def protected_method1() end
2425 * protected :protected_method1
2426 * end
2427 * class B
2428 * def method2() end
2429 * def private_method2() end
2430 * private :private_method2
2431 * end
2432 * class C < B
2433 * include A
2434 * def method3() end
2435 * end
2436 *
2437 * A.method_defined? :method1 #=> true
2438 * C.method_defined? "method1" #=> true
2439 * C.method_defined? "method2" #=> true
2440 * C.method_defined? "method2", true #=> true
2441 * C.method_defined? "method2", false #=> false
2442 * C.method_defined? "method3" #=> true
2443 * C.method_defined? "protected_method1" #=> true
2444 * C.method_defined? "method4" #=> false
2445 * C.method_defined? "private_method2" #=> false
2446 */
2447
2448static VALUE
2449rb_mod_method_defined(int argc, VALUE *argv, VALUE mod)
2450{
2451 rb_method_visibility_t visi = check_definition_visibility(mod, argc, argv);
2452 return RBOOL(visi == METHOD_VISI_PUBLIC || visi == METHOD_VISI_PROTECTED);
2453}
2454
2455static VALUE
2456check_definition(VALUE mod, int argc, VALUE *argv, rb_method_visibility_t visi)
2457{
2458 return RBOOL(check_definition_visibility(mod, argc, argv) == visi);
2459}
2460
2461/*
2462 * call-seq:
2463 * mod.public_method_defined?(symbol, inherit=true) -> true or false
2464 * mod.public_method_defined?(string, inherit=true) -> true or false
2465 *
2466 * Returns +true+ if the named public method is defined by
2467 * _mod_. If _inherit_ is set, the lookup will also search _mod_'s
2468 * ancestors.
2469 * String arguments are converted to symbols.
2470 *
2471 * module A
2472 * def method1() end
2473 * end
2474 * class B
2475 * protected
2476 * def method2() end
2477 * end
2478 * class C < B
2479 * include A
2480 * def method3() end
2481 * end
2482 *
2483 * A.method_defined? :method1 #=> true
2484 * C.public_method_defined? "method1" #=> true
2485 * C.public_method_defined? "method1", true #=> true
2486 * C.public_method_defined? "method1", false #=> true
2487 * C.public_method_defined? "method2" #=> false
2488 * C.method_defined? "method2" #=> true
2489 */
2490
2491static VALUE
2492rb_mod_public_method_defined(int argc, VALUE *argv, VALUE mod)
2493{
2494 return check_definition(mod, argc, argv, METHOD_VISI_PUBLIC);
2495}
2496
2497/*
2498 * call-seq:
2499 * mod.private_method_defined?(symbol, inherit=true) -> true or false
2500 * mod.private_method_defined?(string, inherit=true) -> true or false
2501 *
2502 * Returns +true+ if the named private method is defined by
2503 * _mod_. If _inherit_ is set, the lookup will also search _mod_'s
2504 * ancestors.
2505 * String arguments are converted to symbols.
2506 *
2507 * module A
2508 * def method1() end
2509 * end
2510 * class B
2511 * private
2512 * def method2() end
2513 * end
2514 * class C < B
2515 * include A
2516 * def method3() end
2517 * end
2518 *
2519 * A.method_defined? :method1 #=> true
2520 * C.private_method_defined? "method1" #=> false
2521 * C.private_method_defined? "method2" #=> true
2522 * C.private_method_defined? "method2", true #=> true
2523 * C.private_method_defined? "method2", false #=> false
2524 * C.method_defined? "method2" #=> false
2525 */
2526
2527static VALUE
2528rb_mod_private_method_defined(int argc, VALUE *argv, VALUE mod)
2529{
2530 return check_definition(mod, argc, argv, METHOD_VISI_PRIVATE);
2531}
2532
2533/*
2534 * call-seq:
2535 * mod.protected_method_defined?(symbol, inherit=true) -> true or false
2536 * mod.protected_method_defined?(string, inherit=true) -> true or false
2537 *
2538 * Returns +true+ if the named protected method is defined
2539 * _mod_. If _inherit_ is set, the lookup will also search _mod_'s
2540 * ancestors.
2541 * String arguments are converted to symbols.
2542 *
2543 * module A
2544 * def method1() end
2545 * end
2546 * class B
2547 * protected
2548 * def method2() end
2549 * end
2550 * class C < B
2551 * include A
2552 * def method3() end
2553 * end
2554 *
2555 * A.method_defined? :method1 #=> true
2556 * C.protected_method_defined? "method1" #=> false
2557 * C.protected_method_defined? "method2" #=> true
2558 * C.protected_method_defined? "method2", true #=> true
2559 * C.protected_method_defined? "method2", false #=> false
2560 * C.method_defined? "method2" #=> true
2561 */
2562
2563static VALUE
2564rb_mod_protected_method_defined(int argc, VALUE *argv, VALUE mod)
2565{
2566 return check_definition(mod, argc, argv, METHOD_VISI_PROTECTED);
2567}
2568
2569int
2570rb_method_entry_eq(const rb_method_entry_t *m1, const rb_method_entry_t *m2)
2571{
2572 return rb_method_definition_eq(m1->def, m2->def);
2573}
2574
2575static const rb_method_definition_t *
2576original_method_definition(const rb_method_definition_t *def)
2577{
2578 again:
2579 if (def) {
2580 switch (def->type) {
2581 case VM_METHOD_TYPE_REFINED:
2582 if (def->body.refined.orig_me) {
2583 def = def->body.refined.orig_me->def;
2584 goto again;
2585 }
2586 break;
2587 case VM_METHOD_TYPE_ALIAS:
2588 def = def->body.alias.original_me->def;
2589 goto again;
2590 default:
2591 break;
2592 }
2593 }
2594 return def;
2595}
2596
2597int
2598rb_method_definition_eq(const rb_method_definition_t *d1, const rb_method_definition_t *d2)
2599{
2600 d1 = original_method_definition(d1);
2601 d2 = original_method_definition(d2);
2602
2603 if (d1 == d2) return 1;
2604 if (!d1 || !d2) return 0;
2605 if (d1->type != d2->type) return 0;
2606
2607 switch (d1->type) {
2608 case VM_METHOD_TYPE_ISEQ:
2609 return d1->body.iseq.iseqptr == d2->body.iseq.iseqptr;
2610 case VM_METHOD_TYPE_CFUNC:
2611 return
2612 d1->body.cfunc.func == d2->body.cfunc.func &&
2613 d1->body.cfunc.argc == d2->body.cfunc.argc;
2614 case VM_METHOD_TYPE_ATTRSET:
2615 case VM_METHOD_TYPE_IVAR:
2616 return d1->body.attr.id == d2->body.attr.id;
2617 case VM_METHOD_TYPE_BMETHOD:
2618 return RTEST(rb_equal(d1->body.bmethod.proc, d2->body.bmethod.proc));
2619 case VM_METHOD_TYPE_MISSING:
2620 return d1->original_id == d2->original_id;
2621 case VM_METHOD_TYPE_ZSUPER:
2622 case VM_METHOD_TYPE_NOTIMPLEMENTED:
2623 case VM_METHOD_TYPE_UNDEF:
2624 return 1;
2625 case VM_METHOD_TYPE_OPTIMIZED:
2626 return (d1->body.optimized.type == d2->body.optimized.type) &&
2627 (d1->body.optimized.index == d2->body.optimized.index);
2628 case VM_METHOD_TYPE_REFINED:
2629 case VM_METHOD_TYPE_ALIAS:
2630 break;
2631 }
2632 rb_bug("rb_method_definition_eq: unsupported type: %d", d1->type);
2633}
2634
2635static st_index_t
2636rb_hash_method_definition(st_index_t hash, const rb_method_definition_t *def)
2637{
2638 hash = rb_hash_uint(hash, def->type);
2639 def = original_method_definition(def);
2640
2641 if (!def) return hash;
2642
2643 switch (def->type) {
2644 case VM_METHOD_TYPE_ISEQ:
2645 return rb_hash_uint(hash, (st_index_t)def->body.iseq.iseqptr->body);
2646 case VM_METHOD_TYPE_CFUNC:
2647 hash = rb_hash_uint(hash, (st_index_t)def->body.cfunc.func);
2648 return rb_hash_uint(hash, def->body.cfunc.argc);
2649 case VM_METHOD_TYPE_ATTRSET:
2650 case VM_METHOD_TYPE_IVAR:
2651 return rb_hash_uint(hash, def->body.attr.id);
2652 case VM_METHOD_TYPE_BMETHOD:
2653 return rb_hash_proc(hash, def->body.bmethod.proc);
2654 case VM_METHOD_TYPE_MISSING:
2655 return rb_hash_uint(hash, def->original_id);
2656 case VM_METHOD_TYPE_ZSUPER:
2657 case VM_METHOD_TYPE_NOTIMPLEMENTED:
2658 case VM_METHOD_TYPE_UNDEF:
2659 return hash;
2660 case VM_METHOD_TYPE_OPTIMIZED:
2661 hash = rb_hash_uint(hash, def->body.optimized.index);
2662 return rb_hash_uint(hash, def->body.optimized.type);
2663 case VM_METHOD_TYPE_REFINED:
2664 case VM_METHOD_TYPE_ALIAS:
2665 break; /* unreachable */
2666 }
2667 rb_bug("rb_hash_method_definition: unsupported method type (%d)", def->type);
2668}
2669
2670st_index_t
2671rb_hash_method_entry(st_index_t hash, const rb_method_entry_t *me)
2672{
2673 return rb_hash_method_definition(hash, me->def);
2674}
2675
2676void
2677rb_alias(VALUE klass, ID alias_name, ID original_name)
2678{
2679 const VALUE target_klass = klass;
2680 VALUE defined_class;
2681 const rb_method_entry_t *orig_me;
2682 rb_method_visibility_t visi = METHOD_VISI_UNDEF;
2683
2684 if (NIL_P(klass)) {
2685 rb_raise(rb_eTypeError, "no class to make alias");
2686 }
2687
2688 rb_class_modify_check(klass);
2689
2690 again:
2691 orig_me = search_method(klass, original_name, &defined_class);
2692
2693 if (orig_me && orig_me->def->type == VM_METHOD_TYPE_REFINED) {
2694 orig_me = rb_resolve_refined_method(Qnil, orig_me);
2695 }
2696
2697 if (UNDEFINED_METHOD_ENTRY_P(orig_me) ||
2698 UNDEFINED_REFINED_METHOD_P(orig_me->def)) {
2699 if ((!RB_TYPE_P(klass, T_MODULE)) ||
2700 (orig_me = search_method(rb_cObject, original_name, &defined_class),
2701 UNDEFINED_METHOD_ENTRY_P(orig_me))) {
2702 rb_print_undef(target_klass, original_name, METHOD_VISI_UNDEF);
2703 }
2704 }
2705
2706 switch (orig_me->def->type) {
2707 case VM_METHOD_TYPE_ZSUPER:
2708 klass = RCLASS_SUPER(klass);
2709 original_name = orig_me->def->original_id;
2710 visi = METHOD_ENTRY_VISI(orig_me);
2711 goto again;
2712 case VM_METHOD_TYPE_ALIAS:
2713 visi = METHOD_ENTRY_VISI(orig_me);
2714 orig_me = orig_me->def->body.alias.original_me;
2715 VM_ASSERT(orig_me->def->type != VM_METHOD_TYPE_ALIAS);
2716 break;
2717 default: break;
2718 }
2719
2720 if (visi == METHOD_VISI_UNDEF) visi = METHOD_ENTRY_VISI(orig_me);
2721
2722 if (orig_me->defined_class == 0) {
2723 rb_method_entry_make(target_klass, alias_name, target_klass, visi,
2724 VM_METHOD_TYPE_ALIAS, NULL, orig_me->called_id,
2725 (void *)rb_method_entry_clone(orig_me));
2726 method_added(target_klass, alias_name);
2727 }
2728 else {
2729 rb_method_entry_t *alias_me;
2730
2731 alias_me = method_entry_set(target_klass, alias_name, orig_me, visi, orig_me->owner);
2732 RB_OBJ_WRITE(alias_me, &alias_me->owner, target_klass);
2733
2734 if (RB_TYPE_P(target_klass, T_MODULE)) {
2735 // defined_class should not be set
2736 }
2737 else {
2738 RB_OBJ_WRITE(alias_me, &alias_me->defined_class, orig_me->defined_class);
2739 }
2740 }
2741}
2742
2743/*
2744 * call-seq:
2745 * alias_method(new_name, old_name) -> symbol
2746 *
2747 * Makes <i>new_name</i> a new copy of the method <i>old_name</i>. This can
2748 * be used to retain access to methods that are overridden.
2749 *
2750 * module Mod
2751 * alias_method :orig_exit, :exit #=> :orig_exit
2752 * def exit(code=0)
2753 * puts "Exiting with code #{code}"
2754 * orig_exit(code)
2755 * end
2756 * end
2757 * include Mod
2758 * exit(99)
2759 *
2760 * <em>produces:</em>
2761 *
2762 * Exiting with code 99
2763 */
2764
2765static VALUE
2766rb_mod_alias_method(VALUE mod, VALUE newname, VALUE oldname)
2767{
2768 ID oldid = rb_check_id(&oldname);
2769 if (!oldid) {
2770 rb_print_undef_str(mod, oldname);
2771 }
2772 VALUE id = rb_to_id(newname);
2773 rb_alias(mod, id, oldid);
2774 return ID2SYM(id);
2775}
2776
2777static void
2778check_and_export_method(VALUE self, VALUE name, rb_method_visibility_t visi)
2779{
2780 ID id = rb_check_id(&name);
2781 if (!id) {
2782 rb_print_undef_str(self, name);
2783 }
2784 rb_export_method(self, id, visi);
2785}
2786
2787static void
2788set_method_visibility(VALUE self, int argc, const VALUE *argv, rb_method_visibility_t visi)
2789{
2790 int i;
2791
2792 rb_check_frozen(self);
2793 if (argc == 0) {
2794 rb_warning("%"PRIsVALUE" with no argument is just ignored",
2795 QUOTE_ID(rb_frame_callee()));
2796 return;
2797 }
2798
2799
2800 VALUE v;
2801
2802 if (argc == 1 && (v = rb_check_array_type(argv[0])) != Qnil) {
2803 long j;
2804
2805 for (j = 0; j < RARRAY_LEN(v); j++) {
2806 check_and_export_method(self, RARRAY_AREF(v, j), visi);
2807 }
2808 }
2809 else {
2810 for (i = 0; i < argc; i++) {
2811 check_and_export_method(self, argv[i], visi);
2812 }
2813 }
2814}
2815
2816static VALUE
2817set_visibility(int argc, const VALUE *argv, VALUE module, rb_method_visibility_t visi)
2818{
2819 if (argc == 0) {
2820 scope_visibility_check();
2821 rb_scope_visibility_set(visi);
2822 return Qnil;
2823 }
2824
2825 set_method_visibility(module, argc, argv, visi);
2826 if (argc == 1) {
2827 return argv[0];
2828 }
2829 return rb_ary_new_from_values(argc, argv);
2830}
2831
2832/*
2833 * call-seq:
2834 * public -> nil
2835 * public(method_name) -> method_name
2836 * public(method_name, method_name, ...) -> array
2837 * public(array) -> array
2838 *
2839 * With no arguments, sets the default visibility for subsequently
2840 * defined methods to public. With arguments, sets the named methods to
2841 * have public visibility.
2842 * String arguments are converted to symbols.
2843 * An Array of Symbols and/or Strings is also accepted.
2844 * If a single argument is passed, it is returned.
2845 * If no argument is passed, nil is returned.
2846 * If multiple arguments are passed, the arguments are returned as an array.
2847 */
2848
2849static VALUE
2850rb_mod_public(int argc, VALUE *argv, VALUE module)
2851{
2852 return set_visibility(argc, argv, module, METHOD_VISI_PUBLIC);
2853}
2854
2855/*
2856 * call-seq:
2857 * protected -> nil
2858 * protected(method_name) -> method_name
2859 * protected(method_name, method_name, ...) -> array
2860 * protected(array) -> array
2861 *
2862 * Sets the visibility of a section or of a list of method names as protected.
2863 * Accepts no arguments, a splat of method names (symbols or strings) or an
2864 * array of method names. Returns the arguments that it received.
2865 *
2866 * == Important difference between protected in other languages
2867 *
2868 * Protected methods in Ruby are different from other languages such as Java,
2869 * where methods are marked as protected to give access to subclasses. In Ruby,
2870 * subclasses <b>already have access to all methods defined in the parent
2871 * class</b>, even private ones.
2872 *
2873 * Marking a method as protected allows <b>different objects of the same
2874 * class</b> to call it.
2875 *
2876 * One use case is for comparison methods, such as <code>==</code>, if we want
2877 * to expose a method for comparison between objects of the same class without
2878 * making the method public to objects of other classes.
2879 *
2880 * == Performance considerations
2881 *
2882 * Protected methods are slower than others because they can't use inline
2883 * cache.
2884 *
2885 * == Example
2886 *
2887 * class Account
2888 * # Mark balance as protected, so that we can compare between accounts
2889 * # without making it public.
2890 * attr_reader :balance
2891 * protected :balance
2892 *
2893 * def initialize(balance)
2894 * @balance = balance
2895 * end
2896 *
2897 * def >(other)
2898 * # The invocation to `other.balance` is allowed because `other` is a
2899 * # different object of the same class (Account).
2900 * balance > other.balance
2901 * end
2902 * end
2903 *
2904 * account1 = Account.new(100)
2905 * account2 = Account.new(50)
2906 *
2907 * account1 > account2 # => true (works)
2908 * account1.balance # => NoMethodError (fails because balance is not public)
2909 *
2910 * To show a private method on RDoc, use <code>:doc:</code> instead of this.
2911 */
2912
2913static VALUE
2914rb_mod_protected(int argc, VALUE *argv, VALUE module)
2915{
2916 return set_visibility(argc, argv, module, METHOD_VISI_PROTECTED);
2917}
2918
2919/*
2920 * call-seq:
2921 * private -> nil
2922 * private(method_name) -> method_name
2923 * private(method_name, method_name, ...) -> array
2924 * private(array) -> array
2925 *
2926 * With no arguments, sets the default visibility for subsequently
2927 * defined methods to private. With arguments, sets the named methods
2928 * to have private visibility.
2929 * String arguments are converted to symbols.
2930 * An Array of Symbols and/or Strings is also accepted.
2931 * If a single argument is passed, it is returned.
2932 * If no argument is passed, nil is returned.
2933 * If multiple arguments are passed, the arguments are returned as an array.
2934 *
2935 * module Mod
2936 * def a() end
2937 * def b() end
2938 * private
2939 * def c() end
2940 * private :a
2941 * end
2942 * Mod.private_instance_methods #=> [:a, :c]
2943 *
2944 * Note that to show a private method on RDoc, use <code>:doc:</code>.
2945 */
2946
2947static VALUE
2948rb_mod_private(int argc, VALUE *argv, VALUE module)
2949{
2950 return set_visibility(argc, argv, module, METHOD_VISI_PRIVATE);
2951}
2952
2953/*
2954 * call-seq:
2955 * ruby2_keywords(method_name, ...) -> nil
2956 *
2957 * For the given method names, marks the method as passing keywords through
2958 * a normal argument splat. This should only be called on methods that
2959 * accept an argument splat (<tt>*args</tt>) but not explicit keywords or
2960 * a keyword splat. It marks the method such that if the method is called
2961 * with keyword arguments, the final hash argument is marked with a special
2962 * flag such that if it is the final element of a normal argument splat to
2963 * another method call, and that method call does not include explicit
2964 * keywords or a keyword splat, the final element is interpreted as keywords.
2965 * In other words, keywords will be passed through the method to other
2966 * methods.
2967 *
2968 * This should only be used for methods that delegate keywords to another
2969 * method, and only for backwards compatibility with Ruby versions before 3.0.
2970 * See https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
2971 * for details on why +ruby2_keywords+ exists and when and how to use it.
2972 *
2973 * This method will probably be removed at some point, as it exists only
2974 * for backwards compatibility. As it does not exist in Ruby versions before
2975 * 2.7, check that the module responds to this method before calling it:
2976 *
2977 * module Mod
2978 * def foo(meth, *args, &block)
2979 * send(:"do_#{meth}", *args, &block)
2980 * end
2981 * ruby2_keywords(:foo) if respond_to?(:ruby2_keywords, true)
2982 * end
2983 *
2984 * However, be aware that if the +ruby2_keywords+ method is removed, the
2985 * behavior of the +foo+ method using the above approach will change so that
2986 * the method does not pass through keywords.
2987 */
2988
2989static VALUE
2990rb_mod_ruby2_keywords(int argc, VALUE *argv, VALUE module)
2991{
2992 int i;
2993 VALUE origin_class = RCLASS_ORIGIN(module);
2994
2996 rb_check_frozen(module);
2997
2998 for (i = 0; i < argc; i++) {
2999 VALUE v = argv[i];
3000 ID name = rb_check_id(&v);
3002 VALUE defined_class;
3003
3004 if (!name) {
3005 rb_print_undef_str(module, v);
3006 }
3007
3008 me = search_method(origin_class, name, &defined_class);
3009 if (!me && RB_TYPE_P(module, T_MODULE)) {
3010 me = search_method(rb_cObject, name, &defined_class);
3011 }
3012
3013 if (UNDEFINED_METHOD_ENTRY_P(me) ||
3014 UNDEFINED_REFINED_METHOD_P(me->def)) {
3015 rb_print_undef(module, name, METHOD_VISI_UNDEF);
3016 }
3017
3018 if (module == defined_class || origin_class == defined_class) {
3019 switch (me->def->type) {
3020 case VM_METHOD_TYPE_ISEQ:
3021 if (ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_rest &&
3022 !ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_post &&
3023 !ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_kw &&
3024 !ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.has_kwrest) {
3025 ISEQ_BODY(me->def->body.iseq.iseqptr)->param.flags.ruby2_keywords = 1;
3026 rb_clear_method_cache(module, name);
3027 }
3028 else {
3029 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));
3030 }
3031 break;
3032 case VM_METHOD_TYPE_BMETHOD: {
3033 VALUE procval = me->def->body.bmethod.proc;
3034 if (vm_block_handler_type(procval) == block_handler_type_proc) {
3035 procval = vm_proc_to_block_handler(VM_BH_TO_PROC(procval));
3036 }
3037
3038 if (vm_block_handler_type(procval) == block_handler_type_iseq) {
3039 const struct rb_captured_block *captured = VM_BH_TO_ISEQ_BLOCK(procval);
3040 const rb_iseq_t *iseq = rb_iseq_check(captured->code.iseq);
3041 if (ISEQ_BODY(iseq)->param.flags.has_rest &&
3042 !ISEQ_BODY(iseq)->param.flags.has_post &&
3043 !ISEQ_BODY(iseq)->param.flags.has_kw &&
3044 !ISEQ_BODY(iseq)->param.flags.has_kwrest) {
3045 ISEQ_BODY(iseq)->param.flags.ruby2_keywords = 1;
3046 rb_clear_method_cache(module, name);
3047 }
3048 else {
3049 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));
3050 }
3051 break;
3052 }
3053 }
3054 /* fallthrough */
3055 default:
3056 rb_warn("Skipping set of ruby2_keywords flag for %"PRIsVALUE" (method not defined in Ruby)", QUOTE_ID(name));
3057 break;
3058 }
3059 }
3060 else {
3061 rb_warn("Skipping set of ruby2_keywords flag for %"PRIsVALUE" (can only set in method defining module)", QUOTE_ID(name));
3062 }
3063 }
3064 return Qnil;
3065}
3066
3067/*
3068 * call-seq:
3069 * mod.public_class_method(symbol, ...) -> mod
3070 * mod.public_class_method(string, ...) -> mod
3071 * mod.public_class_method(array) -> mod
3072 *
3073 * Makes a list of existing class methods public.
3074 *
3075 * String arguments are converted to symbols.
3076 * An Array of Symbols and/or Strings is also accepted.
3077 */
3078
3079static VALUE
3080rb_mod_public_method(int argc, VALUE *argv, VALUE obj)
3081{
3082 set_method_visibility(rb_singleton_class(obj), argc, argv, METHOD_VISI_PUBLIC);
3083 return obj;
3084}
3085
3086/*
3087 * call-seq:
3088 * mod.private_class_method(symbol, ...) -> mod
3089 * mod.private_class_method(string, ...) -> mod
3090 * mod.private_class_method(array) -> mod
3091 *
3092 * Makes existing class methods private. Often used to hide the default
3093 * constructor <code>new</code>.
3094 *
3095 * String arguments are converted to symbols.
3096 * An Array of Symbols and/or Strings is also accepted.
3097 *
3098 * class SimpleSingleton # Not thread safe
3099 * private_class_method :new
3100 * def SimpleSingleton.create(*args, &block)
3101 * @me = new(*args, &block) if ! @me
3102 * @me
3103 * end
3104 * end
3105 */
3106
3107static VALUE
3108rb_mod_private_method(int argc, VALUE *argv, VALUE obj)
3109{
3110 set_method_visibility(rb_singleton_class(obj), argc, argv, METHOD_VISI_PRIVATE);
3111 return obj;
3112}
3113
3114/*
3115 * call-seq:
3116 * public
3117 * public(symbol, ...)
3118 * public(string, ...)
3119 * public(array)
3120 *
3121 * With no arguments, sets the default visibility for subsequently
3122 * defined methods to public. With arguments, sets the named methods to
3123 * have public visibility.
3124 *
3125 * String arguments are converted to symbols.
3126 * An Array of Symbols and/or Strings is also accepted.
3127 */
3128
3129static VALUE
3130top_public(int argc, VALUE *argv, VALUE _)
3131{
3132 return rb_mod_public(argc, argv, rb_top_main_class("public"));
3133}
3134
3135/*
3136 * call-seq:
3137 * private
3138 * private(symbol, ...)
3139 * private(string, ...)
3140 * private(array)
3141 *
3142 * With no arguments, sets the default visibility for subsequently
3143 * defined methods to private. With arguments, sets the named methods to
3144 * have private visibility.
3145 *
3146 * String arguments are converted to symbols.
3147 * An Array of Symbols and/or Strings is also accepted.
3148 */
3149static VALUE
3150top_private(int argc, VALUE *argv, VALUE _)
3151{
3152 return rb_mod_private(argc, argv, rb_top_main_class("private"));
3153}
3154
3155/*
3156 * call-seq:
3157 * ruby2_keywords(method_name, ...) -> self
3158 *
3159 * For the given method names, marks the method as passing keywords through
3160 * a normal argument splat. See Module#ruby2_keywords in detail.
3161 */
3162static VALUE
3163top_ruby2_keywords(int argc, VALUE *argv, VALUE module)
3164{
3165 return rb_mod_ruby2_keywords(argc, argv, rb_top_main_class("ruby2_keywords"));
3166}
3167
3168/*
3169 * call-seq:
3170 * module_function -> nil
3171 * module_function(method_name) -> method_name
3172 * module_function(method_name, method_name, ...) -> array
3173 *
3174 * Creates module functions for the named methods. These functions may
3175 * be called with the module as a receiver, and also become available
3176 * as instance methods to classes that mix in the module. Module
3177 * functions are copies of the original, and so may be changed
3178 * independently. The instance-method versions are made private. If
3179 * used with no arguments, subsequently defined methods become module
3180 * functions.
3181 * String arguments are converted to symbols.
3182 * If a single argument is passed, it is returned.
3183 * If no argument is passed, nil is returned.
3184 * If multiple arguments are passed, the arguments are returned as an array.
3185 *
3186 * module Mod
3187 * def one
3188 * "This is one"
3189 * end
3190 * module_function :one
3191 * end
3192 * class Cls
3193 * include Mod
3194 * def call_one
3195 * one
3196 * end
3197 * end
3198 * Mod.one #=> "This is one"
3199 * c = Cls.new
3200 * c.call_one #=> "This is one"
3201 * module Mod
3202 * def one
3203 * "This is the new one"
3204 * end
3205 * end
3206 * Mod.one #=> "This is one"
3207 * c.call_one #=> "This is the new one"
3208 */
3209
3210static VALUE
3211rb_mod_modfunc(int argc, VALUE *argv, VALUE module)
3212{
3213 int i;
3214 ID id;
3215 const rb_method_entry_t *me;
3216
3217 if (!RB_TYPE_P(module, T_MODULE)) {
3218 rb_raise(rb_eTypeError, "module_function must be called for modules");
3219 }
3220
3221 if (argc == 0) {
3222 rb_scope_module_func_set();
3223 return Qnil;
3224 }
3225
3226 set_method_visibility(module, argc, argv, METHOD_VISI_PRIVATE);
3227
3228 for (i = 0; i < argc; i++) {
3229 VALUE m = module;
3230
3231 id = rb_to_id(argv[i]);
3232 for (;;) {
3233 me = search_method(m, id, 0);
3234 if (me == 0) {
3235 me = search_method(rb_cObject, id, 0);
3236 }
3237 if (UNDEFINED_METHOD_ENTRY_P(me)) {
3238 rb_print_undef(module, id, METHOD_VISI_UNDEF);
3239 }
3240 if (me->def->type != VM_METHOD_TYPE_ZSUPER) {
3241 break; /* normal case: need not to follow 'super' link */
3242 }
3243 m = RCLASS_SUPER(m);
3244 if (!m)
3245 break;
3246 }
3247 rb_method_entry_set(rb_singleton_class(module), id, me, METHOD_VISI_PUBLIC);
3248 }
3249 if (argc == 1) {
3250 return argv[0];
3251 }
3252 return rb_ary_new_from_values(argc, argv);
3253}
3254
3255#ifdef __GNUC__
3256#pragma push_macro("rb_method_basic_definition_p")
3257#undef rb_method_basic_definition_p
3258#endif
3259int
3260rb_method_basic_definition_p(VALUE klass, ID id)
3261{
3262 const rb_callable_method_entry_t *cme;
3263 if (!klass) return TRUE; /* hidden object cannot be overridden */
3264 cme = rb_callable_method_entry(klass, id);
3265 return (cme && METHOD_ENTRY_BASIC(cme)) ? TRUE : FALSE;
3266}
3267#ifdef __GNUC__
3268#pragma pop_macro("rb_method_basic_definition_p")
3269#endif
3270
3271static VALUE
3272call_method_entry(rb_execution_context_t *ec, VALUE defined_class, VALUE obj, ID id,
3273 const rb_callable_method_entry_t *cme, int argc, const VALUE *argv, int kw_splat)
3274{
3275 VALUE passed_block_handler = vm_passed_block_handler(ec);
3276 VALUE result = rb_vm_call_kw(ec, obj, id, argc, argv, cme, kw_splat);
3277 vm_passed_block_handler_set(ec, passed_block_handler);
3278 return result;
3279}
3280
3281static VALUE
3282basic_obj_respond_to_missing(rb_execution_context_t *ec, VALUE klass, VALUE obj,
3283 VALUE mid, VALUE priv)
3284{
3285 VALUE defined_class, args[2];
3286 const ID rtmid = idRespond_to_missing;
3287 const rb_callable_method_entry_t *const cme = callable_method_entry(klass, rtmid, &defined_class);
3288
3289 if (!cme || METHOD_ENTRY_BASIC(cme)) return Qundef;
3290 args[0] = mid;
3291 args[1] = priv;
3292 return call_method_entry(ec, defined_class, obj, rtmid, cme, 2, args, RB_NO_KEYWORDS);
3293}
3294
3295static inline int
3296basic_obj_respond_to(rb_execution_context_t *ec, VALUE obj, ID id, int pub)
3297{
3298 VALUE klass = CLASS_OF(obj);
3299 VALUE ret;
3300
3301 switch (method_boundp(klass, id, pub|BOUND_RESPONDS)) {
3302 case 2:
3303 return FALSE;
3304 case 0:
3305 ret = basic_obj_respond_to_missing(ec, klass, obj, ID2SYM(id),
3306 RBOOL(!pub));
3307 return RTEST(ret) && !UNDEF_P(ret);
3308 default:
3309 return TRUE;
3310 }
3311}
3312
3313static int
3314vm_respond_to(rb_execution_context_t *ec, VALUE klass, VALUE obj, ID id, int priv)
3315{
3316 VALUE defined_class;
3317 const ID resid = idRespond_to;
3318 const rb_callable_method_entry_t *const cme = callable_method_entry(klass, resid, &defined_class);
3319
3320 if (!cme) return -1;
3321 if (METHOD_ENTRY_BASIC(cme)) {
3322 return -1;
3323 }
3324 else {
3325 int argc = 1;
3326 VALUE args[2];
3327 VALUE result;
3328
3329 args[0] = ID2SYM(id);
3330 args[1] = Qtrue;
3331 if (priv) {
3332 argc = rb_method_entry_arity((const rb_method_entry_t *)cme);
3333 if (argc > 2) {
3334 rb_raise(rb_eArgError,
3335 "respond_to? must accept 1 or 2 arguments (requires %d)",
3336 argc);
3337 }
3338 if (argc != 1) {
3339 argc = 2;
3340 }
3341 else if (!NIL_P(ruby_verbose)) {
3342 VALUE location = rb_method_entry_location((const rb_method_entry_t *)cme);
3344 "%"PRIsVALUE"%c""respond_to?(:%"PRIsVALUE") uses"
3345 " the deprecated method signature, which takes one parameter",
3346 (RCLASS_SINGLETON_P(klass) ? obj : klass),
3347 (RCLASS_SINGLETON_P(klass) ? '.' : '#'),
3348 QUOTE_ID(id));
3349 if (!NIL_P(location)) {
3350 VALUE path = RARRAY_AREF(location, 0);
3351 VALUE line = RARRAY_AREF(location, 1);
3352 if (!NIL_P(path)) {
3354 RSTRING_PTR(path), NUM2INT(line),
3355 "respond_to? is defined here");
3356 }
3357 }
3358 }
3359 }
3360 result = call_method_entry(ec, defined_class, obj, resid, cme, argc, args, RB_NO_KEYWORDS);
3361 return RTEST(result);
3362 }
3363}
3364
3365int
3366rb_obj_respond_to(VALUE obj, ID id, int priv)
3367{
3368 rb_execution_context_t *ec = GET_EC();
3369 return rb_ec_obj_respond_to(ec, obj, id, priv);
3370}
3371
3372int
3373rb_ec_obj_respond_to(rb_execution_context_t *ec, VALUE obj, ID id, int priv)
3374{
3375 VALUE klass = CLASS_OF(obj);
3376 int ret = vm_respond_to(ec, klass, obj, id, priv);
3377 if (ret == -1) ret = basic_obj_respond_to(ec, obj, id, !priv);
3378 return ret;
3379}
3380
3381int
3383{
3384 return rb_obj_respond_to(obj, id, FALSE);
3385}
3386
3387
3388/*
3389 * call-seq:
3390 * obj.respond_to?(symbol, include_all=false) -> true or false
3391 * obj.respond_to?(string, include_all=false) -> true or false
3392 *
3393 * Returns +true+ if _obj_ responds to the given method. Private and
3394 * protected methods are included in the search only if the optional
3395 * second parameter evaluates to +true+.
3396 *
3397 * If the method is not implemented,
3398 * as Process.fork on Windows, File.lchmod on GNU/Linux, etc.,
3399 * false is returned.
3400 *
3401 * If the method is not defined, <code>respond_to_missing?</code>
3402 * method is called and the result is returned.
3403 *
3404 * When the method name parameter is given as a string, the string is
3405 * converted to a symbol.
3406 */
3407
3408static VALUE
3409obj_respond_to(int argc, VALUE *argv, VALUE obj)
3410{
3411 VALUE mid, priv;
3412 ID id;
3413 rb_execution_context_t *ec = GET_EC();
3414
3415 rb_scan_args(argc, argv, "11", &mid, &priv);
3416 if (!(id = rb_check_id(&mid))) {
3417 VALUE ret = basic_obj_respond_to_missing(ec, CLASS_OF(obj), obj,
3418 rb_to_symbol(mid), priv);
3419 if (UNDEF_P(ret)) ret = Qfalse;
3420 return ret;
3421 }
3422 return RBOOL(basic_obj_respond_to(ec, obj, id, !RTEST(priv)));
3423}
3424
3425/*
3426 * call-seq:
3427 * obj.respond_to_missing?(symbol, include_all) -> true or false
3428 * obj.respond_to_missing?(string, include_all) -> true or false
3429 *
3430 * DO NOT USE THIS DIRECTLY.
3431 *
3432 * Hook method to return whether the _obj_ can respond to _id_ method
3433 * or not.
3434 *
3435 * When the method name parameter is given as a string, the string is
3436 * converted to a symbol.
3437 *
3438 * See #respond_to?, and the example of BasicObject.
3439 */
3440static VALUE
3441obj_respond_to_missing(VALUE obj, VALUE mid, VALUE priv)
3442{
3443 return Qfalse;
3444}
3445
3446void
3447Init_eval_method(void)
3448{
3449 rb_define_method(rb_mKernel, "respond_to?", obj_respond_to, -1);
3450 rb_define_method(rb_mKernel, "respond_to_missing?", obj_respond_to_missing, 2);
3451
3452 rb_define_method(rb_cModule, "remove_method", rb_mod_remove_method, -1);
3453 rb_define_method(rb_cModule, "undef_method", rb_mod_undef_method, -1);
3454 rb_define_method(rb_cModule, "alias_method", rb_mod_alias_method, 2);
3455 rb_define_private_method(rb_cModule, "public", rb_mod_public, -1);
3456 rb_define_private_method(rb_cModule, "protected", rb_mod_protected, -1);
3457 rb_define_private_method(rb_cModule, "private", rb_mod_private, -1);
3458 rb_define_private_method(rb_cModule, "module_function", rb_mod_modfunc, -1);
3459 rb_define_private_method(rb_cModule, "ruby2_keywords", rb_mod_ruby2_keywords, -1);
3460
3461 rb_define_method(rb_cModule, "method_defined?", rb_mod_method_defined, -1);
3462 rb_define_method(rb_cModule, "public_method_defined?", rb_mod_public_method_defined, -1);
3463 rb_define_method(rb_cModule, "private_method_defined?", rb_mod_private_method_defined, -1);
3464 rb_define_method(rb_cModule, "protected_method_defined?", rb_mod_protected_method_defined, -1);
3465 rb_define_method(rb_cModule, "public_class_method", rb_mod_public_method, -1);
3466 rb_define_method(rb_cModule, "private_class_method", rb_mod_private_method, -1);
3467
3469 "public", top_public, -1);
3471 "private", top_private, -1);
3473 "ruby2_keywords", top_ruby2_keywords, -1);
3474
3475 {
3476#define REPLICATE_METHOD(klass, id) do { \
3477 const rb_method_entry_t *me = rb_method_entry((klass), (id)); \
3478 rb_method_entry_set((klass), (id), me, METHOD_ENTRY_VISI(me)); \
3479 } while (0)
3480
3481 REPLICATE_METHOD(rb_eException, idMethodMissing);
3482 REPLICATE_METHOD(rb_eException, idRespond_to);
3483 REPLICATE_METHOD(rb_eException, idRespond_to_missing);
3484 }
3485}
#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:2899
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:3237
#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:176
#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:2294
#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:3382
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:219
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
Definition vm_method.c:1630
void rb_alias(VALUE klass, ID dst, ID src)
Resembles alias.
Definition vm_method.c:2677
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:2257
void rb_remove_method(VALUE klass, const char *name)
Removes a method.
Definition vm_method.c:2106
rb_alloc_func_t rb_get_alloc_func(VALUE klass)
Queries the allocator function of a class.
Definition vm_method.c:1636
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:2100
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:2218
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:3366
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:12658
ID rb_to_id(VALUE str)
Definition string.c:12648
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:208
size_t(* dsize)(const void *)
This function is to query the size of the underlying memory regions.
Definition rtypeddata.h:248
RUBY_DATA_FUNC dfree
This function is called when the object is no longer used.
Definition rtypeddata.h:238
const char * wrap_struct_name
Name of structs of this kind.
Definition rtypeddata.h:215
struct rb_data_type_struct::@55 function
Function pointers.
VALUE flags
Type-specific behavioural characteristics.
Definition rtypeddata.h:317
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