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