Ruby 4.1.0dev (2026-04-04 revision 6ab9b22553ac802819aa1643a9ac9575e75d1286)
vm_eval.c (6ab9b22553ac802819aa1643a9ac9575e75d1286)
1/**********************************************************************
2
3 vm_eval.c - Included into vm.c.
4
5 $Author$
6 created at: Sat May 24 16:02:32 JST 2008
7
8 Copyright (C) 1993-2007 Yukihiro Matsumoto
9 Copyright (C) 2000 Network Applied Communication Laboratory, Inc.
10 Copyright (C) 2000 Information-technology Promotion Agency, Japan
11
12**********************************************************************/
13
14#include "internal/thread.h"
16 VALUE tbl;
17};
18
19static inline VALUE method_missing(rb_execution_context_t *ec, VALUE obj, ID id, int argc, const VALUE *argv, enum method_missing_reason call_status, int kw_splat);
20static inline VALUE vm_yield_with_cref(rb_execution_context_t *ec, int argc, const VALUE *argv, int kw_splat, const rb_cref_t *cref, int is_lambda);
21static inline VALUE vm_yield(rb_execution_context_t *ec, int argc, const VALUE *argv, int kw_splat);
22static inline VALUE vm_yield_with_block(rb_execution_context_t *ec, int argc, const VALUE *argv, VALUE block_handler, int kw_splat);
23static inline VALUE vm_yield_force_blockarg(rb_execution_context_t *ec, VALUE args);
24VALUE vm_exec(rb_execution_context_t *ec);
25static void vm_set_eval_stack(rb_execution_context_t * th, const rb_iseq_t *iseq, const rb_cref_t *cref, const struct rb_block *base_block);
26static int vm_collect_local_variables_in_heap(const VALUE *dfp, const struct local_var_list *vars);
27
28static VALUE rb_eUncaughtThrow;
29static ID id_result, id_tag, id_value;
30#define id_mesg idMesg
31
32static VALUE send_internal(int argc, const VALUE *argv, VALUE recv, call_type scope);
33static VALUE vm_call0_body(rb_execution_context_t* ec, struct rb_calling_info *calling, const VALUE *argv);
34
35static VALUE *
36vm_argv_ruby_array(VALUE *av, const VALUE *argv, int *flags, int *argc, int kw_splat)
37{
38 *flags |= VM_CALL_ARGS_SPLAT;
39 VALUE argv_ary = rb_ary_hidden_new(*argc);
40 rb_ary_cat(argv_ary, argv, *argc);
41 *argc = 2;
42 av[0] = argv_ary;
43 if (kw_splat) {
44 av[1] = rb_ary_pop(argv_ary);
45 }
46 else {
47 // Make sure flagged keyword hash passed as regular argument
48 // isn't treated as keywords
49 *flags |= VM_CALL_KW_SPLAT;
50 av[1] = rb_hash_new();
51 }
52 return av;
53}
54
55static inline VALUE vm_call0_cc(rb_execution_context_t *ec, VALUE recv, ID id, int argc, const VALUE *argv, const struct rb_callcache *cc, int kw_splat);
56
58rb_vm_call0(rb_execution_context_t *ec, VALUE recv, ID id, int argc, const VALUE *argv, const rb_callable_method_entry_t *cme, int kw_splat)
59{
60 const struct rb_callcache cc = VM_CC_ON_STACK(Qundef, vm_call_general, {{ 0 }}, cme);
61 return vm_call0_cc(ec, recv, id, argc, argv, &cc, kw_splat);
62}
63
65rb_vm_call_with_refinements(rb_execution_context_t *ec, VALUE recv, ID id, int argc, const VALUE *argv, int kw_splat)
66{
68 rb_callable_method_entry_with_refinements(CLASS_OF(recv), id, NULL);
69 if (me) {
70 return rb_vm_call0(ec, recv, id, argc, argv, me, kw_splat);
71 }
72 else {
73 /* fallback to funcall (e.g. method_missing) */
74 return rb_funcallv(recv, id, argc, argv);
75 }
76}
77
78static inline VALUE
79vm_call0_cc(rb_execution_context_t *ec, VALUE recv, ID id, int argc, const VALUE *argv, const struct rb_callcache *cc, int kw_splat)
80{
81 int flags = kw_splat ? VM_CALL_KW_SPLAT : 0;
82 VALUE *use_argv = (VALUE *)argv;
83 VALUE av[2];
84
85 if (UNLIKELY(vm_cc_cme(cc)->def->type == VM_METHOD_TYPE_ISEQ && argc > VM_ARGC_STACK_MAX)) {
86 use_argv = vm_argv_ruby_array(av, argv, &flags, &argc, kw_splat);
87 }
88
89 struct rb_calling_info calling = {
90 .cd = &(struct rb_call_data) {
91 .ci = &VM_CI_ON_STACK(id, flags, argc, NULL),
92 .cc = NULL,
93 },
94 .cc = cc,
95 .block_handler = vm_passed_block_handler(ec),
96 .recv = recv,
97 .argc = argc,
98 .kw_splat = kw_splat,
99 };
100
101 return vm_call0_body(ec, &calling, use_argv);
102}
103
104static VALUE
105vm_call0_cme(rb_execution_context_t *ec, struct rb_calling_info *calling, const VALUE *argv, const rb_callable_method_entry_t *cme)
106{
107 calling->cc = &VM_CC_ON_STACK(Qundef, vm_call_general, {{ 0 }}, cme);
108 return vm_call0_body(ec, calling, argv);
109}
110
111static VALUE
112vm_call0_super(rb_execution_context_t *ec, struct rb_calling_info *calling, const VALUE *argv, VALUE klass, enum method_missing_reason ex)
113{
114 ID mid = vm_ci_mid(calling->cd->ci);
115 klass = RCLASS_SUPER(klass);
116
117 if (klass) {
118 const rb_callable_method_entry_t *cme = rb_callable_method_entry(klass, mid);
119
120 if (cme) {
121 RUBY_VM_CHECK_INTS(ec);
122 return vm_call0_cme(ec, calling, argv, cme);
123 }
124 }
125
126 vm_passed_block_handler_set(ec, calling->block_handler);
127 return method_missing(ec, calling->recv, mid, calling->argc, argv, ex, calling->kw_splat);
128}
129
130static VALUE
131vm_call0_cfunc_with_frame(rb_execution_context_t* ec, struct rb_calling_info *calling, const VALUE *argv)
132{
133 const struct rb_callinfo *ci = calling->cd->ci;
134 VALUE val;
135 const rb_callable_method_entry_t *me = vm_cc_cme(calling->cc);
136 const rb_method_cfunc_t *cfunc = UNALIGNED_MEMBER_PTR(me->def, body.cfunc);
137 int len = cfunc->argc;
138 VALUE recv = calling->recv;
139 int argc = calling->argc;
140 ID mid = vm_ci_mid(ci);
141 VALUE block_handler = calling->block_handler;
142 int frame_flags = VM_FRAME_MAGIC_CFUNC | VM_FRAME_FLAG_CFRAME | VM_ENV_FLAG_LOCAL;
143
144 if (calling->kw_splat) {
145 if (argc > 0 && RB_TYPE_P(argv[argc-1], T_HASH) && RHASH_EMPTY_P(argv[argc-1])) {
146 argc--;
147 }
148 else {
149 frame_flags |= VM_FRAME_FLAG_CFRAME_KW;
150 }
151 }
152
153 RUBY_DTRACE_CMETHOD_ENTRY_HOOK(ec, me->owner, me->def->original_id);
154 EXEC_EVENT_HOOK(ec, RUBY_EVENT_C_CALL, recv, me->def->original_id, mid, me->owner, Qnil);
155 {
156 rb_control_frame_t *reg_cfp = ec->cfp;
157
158 vm_push_frame(ec, 0, frame_flags, recv,
159 block_handler, (VALUE)me,
160 0, reg_cfp->sp, 0, 0);
161
162 if (len >= 0) rb_check_arity(argc, len, len);
163
164 val = (*cfunc->invoker)(recv, argc, argv, cfunc->func);
165
166 CHECK_CFP_CONSISTENCY("vm_call0_cfunc_with_frame");
167 rb_vm_pop_frame(ec);
168 }
169 EXEC_EVENT_HOOK(ec, RUBY_EVENT_C_RETURN, recv, me->def->original_id, mid, me->owner, val);
170 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec, me->owner, me->def->original_id);
171
172 return val;
173}
174
175static VALUE
176vm_call0_cfunc(rb_execution_context_t *ec, struct rb_calling_info *calling, const VALUE *argv)
177{
178 return vm_call0_cfunc_with_frame(ec, calling, argv);
179}
180
181static void
182vm_call_check_arity(struct rb_calling_info *calling, int argc, const VALUE *argv)
183{
184 if (calling->kw_splat &&
185 calling->argc > 0 &&
186 RB_TYPE_P(argv[calling->argc-1], T_HASH) &&
187 RHASH_EMPTY_P(argv[calling->argc-1])) {
188 calling->argc--;
189 }
190
191 rb_check_arity(calling->argc, argc, argc);
192}
193
194/* `ci' should point temporal value (on stack value) */
195static VALUE
196vm_call0_body(rb_execution_context_t *ec, struct rb_calling_info *calling, const VALUE *argv)
197{
198 const struct rb_callinfo *ci = calling->cd->ci;
199 const struct rb_callcache *cc = calling->cc;
200 VALUE ret;
201
202 retry:
203
204 switch (vm_cc_cme(cc)->def->type) {
205 case VM_METHOD_TYPE_ISEQ:
206 {
207 rb_control_frame_t *reg_cfp = ec->cfp;
208 int i;
209
210 CHECK_VM_STACK_OVERFLOW(reg_cfp, calling->argc + 1);
211 vm_check_canary(ec, reg_cfp->sp);
212
213 *reg_cfp->sp++ = calling->recv;
214 for (i = 0; i < calling->argc; i++) {
215 *reg_cfp->sp++ = argv[i];
216 }
217
218 if (ISEQ_BODY(def_iseq_ptr(vm_cc_cme(cc)->def))->param.flags.forwardable) {
219 vm_call_iseq_fwd_setup(ec, reg_cfp, calling);
220 }
221 else {
222 vm_call_iseq_setup(ec, reg_cfp, calling);
223 }
224 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_FINISH);
225 return vm_exec(ec); // CHECK_INTS in this function
226 }
227 case VM_METHOD_TYPE_NOTIMPLEMENTED:
228 case VM_METHOD_TYPE_CFUNC:
229 ret = vm_call0_cfunc(ec, calling, argv);
230 goto success;
231 case VM_METHOD_TYPE_ATTRSET:
232 vm_call_check_arity(calling, 1, argv);
233 VM_CALL_METHOD_ATTR(ret,
234 rb_ivar_set(calling->recv, vm_cc_cme(cc)->def->body.attr.id, argv[0]),
235 (void)0);
236 goto success;
237 case VM_METHOD_TYPE_IVAR:
238 vm_call_check_arity(calling, 0, argv);
239 VM_CALL_METHOD_ATTR(ret,
240 rb_attr_get(calling->recv, vm_cc_cme(cc)->def->body.attr.id),
241 (void)0);
242 goto success;
243 case VM_METHOD_TYPE_BMETHOD:
244 ret = vm_call_bmethod_body(ec, calling, argv);
245 goto success;
246 case VM_METHOD_TYPE_ZSUPER:
247 {
248 VALUE klass = RCLASS_ORIGIN(vm_cc_cme(cc)->defined_class);
249 return vm_call0_super(ec, calling, argv, klass, MISSING_SUPER);
250 }
251 case VM_METHOD_TYPE_REFINED:
252 {
253 const rb_callable_method_entry_t *cme = vm_cc_cme(cc);
254
255 if (cme->def->body.refined.orig_me) {
256 const rb_callable_method_entry_t *orig_cme = refined_method_callable_without_refinement(cme);
257 return vm_call0_cme(ec, calling, argv, orig_cme);
258 }
259
260 VALUE klass = cme->defined_class;
261 return vm_call0_super(ec, calling, argv, klass, 0);
262 }
263 case VM_METHOD_TYPE_ALIAS:
264 {
265 const rb_callable_method_entry_t *cme = vm_cc_cme(cc);
266 const rb_callable_method_entry_t *orig_cme = aliased_callable_method_entry(cme);
267
268 if (cme == orig_cme) rb_bug("same!!");
269
270 if (vm_cc_markable(cc)) {
271 return vm_call0_cme(ec, calling, argv, orig_cme);
272 }
273 else {
274 *((const rb_callable_method_entry_t **)&cc->cme_) = orig_cme;
275 goto retry;
276 }
277 }
278 case VM_METHOD_TYPE_MISSING:
279 {
280 vm_passed_block_handler_set(ec, calling->block_handler);
281 return method_missing(ec, calling->recv, vm_ci_mid(ci), calling->argc,
282 argv, MISSING_NOENTRY, calling->kw_splat);
283 }
284 case VM_METHOD_TYPE_OPTIMIZED:
285 switch (vm_cc_cme(cc)->def->body.optimized.type) {
286 case OPTIMIZED_METHOD_TYPE_SEND:
287 ret = send_internal(calling->argc, argv, calling->recv, calling->kw_splat ? CALL_FCALL_KW : CALL_FCALL);
288 goto success;
289 case OPTIMIZED_METHOD_TYPE_CALL:
290 {
291 rb_proc_t *proc;
292 GetProcPtr(calling->recv, proc);
293 ret = rb_vm_invoke_proc(ec, proc, calling->argc, argv, calling->kw_splat, calling->block_handler);
294 goto success;
295 }
296 case OPTIMIZED_METHOD_TYPE_STRUCT_AREF:
297 vm_call_check_arity(calling, 0, argv);
298 VM_CALL_METHOD_ATTR(ret,
299 vm_call_opt_struct_aref0(ec, calling),
300 (void)0);
301 goto success;
302 case OPTIMIZED_METHOD_TYPE_STRUCT_ASET:
303 vm_call_check_arity(calling, 1, argv);
304 VM_CALL_METHOD_ATTR(ret,
305 vm_call_opt_struct_aset0(ec, calling, argv[0]),
306 (void)0);
307 goto success;
308 default:
309 rb_bug("vm_call0: unsupported optimized method type (%d)", vm_cc_cme(cc)->def->body.optimized.type);
310 }
311 break;
312 case VM_METHOD_TYPE_UNDEF:
313 break;
314 }
315 rb_bug("vm_call0: unsupported method type (%d)", vm_cc_cme(cc)->def->type);
316 return Qundef;
317
318 success:
319 RUBY_VM_CHECK_INTS(ec);
320 return ret;
321}
322
323VALUE
324rb_vm_call_kw(rb_execution_context_t *ec, VALUE recv, VALUE id, int argc, const VALUE *argv, const rb_callable_method_entry_t *me, int kw_splat)
325{
326 return rb_vm_call0(ec, recv, id, argc, argv, me, kw_splat);
327}
328
329static inline VALUE
330vm_call_super(rb_execution_context_t *ec, int argc, const VALUE *argv, int kw_splat)
331{
332 VALUE recv = ec->cfp->self;
333 VALUE klass;
334 ID id;
335 rb_control_frame_t *cfp = ec->cfp;
336 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(cfp);
337
338 if (VM_FRAME_RUBYFRAME_P(cfp)) {
339 rb_bug("vm_call_super: should not be reached");
340 }
341
342 klass = RCLASS_ORIGIN(me->defined_class);
343 klass = RCLASS_SUPER(klass);
344 id = me->def->original_id;
345 me = rb_callable_method_entry(klass, id);
346
347 if (!me) {
348 return method_missing(ec, recv, id, argc, argv, MISSING_SUPER, kw_splat);
349 }
350 return rb_vm_call_kw(ec, recv, id, argc, argv, me, kw_splat);
351}
352
353VALUE
354rb_call_super_kw(int argc, const VALUE *argv, int kw_splat)
355{
356 rb_execution_context_t *ec = GET_EC();
357 PASS_PASSED_BLOCK_HANDLER_EC(ec);
358 return vm_call_super(ec, argc, argv, kw_splat);
359}
360
361VALUE
362rb_call_super(int argc, const VALUE *argv)
363{
364 return rb_call_super_kw(argc, argv, RB_NO_KEYWORDS);
365}
366
367VALUE
369{
370 const rb_execution_context_t *ec = GET_EC();
372 if (!ec || !(cfp = ec->cfp)) {
373 rb_raise(rb_eRuntimeError, "no self, no life");
374 }
375 return cfp->self;
376}
377
378static inline void
379stack_check(rb_execution_context_t *ec)
380{
381 if (!rb_ec_raised_p(ec, RAISED_STACKOVERFLOW) &&
382 rb_ec_stack_check(ec)) {
383 rb_ec_raised_set(ec, RAISED_STACKOVERFLOW);
384 rb_ec_stack_overflow(ec, 0);
385 }
386}
387
388void
389rb_check_stack_overflow(void)
390{
391#ifndef RB_THREAD_LOCAL_SPECIFIER
392 if (!ruby_current_ec_key) return;
393#endif
394 rb_execution_context_t *ec = GET_EC();
395 if (ec) stack_check(ec);
396}
397
398NORETURN(static void uncallable_object(VALUE recv, ID mid));
399static inline const rb_callable_method_entry_t *rb_search_method_entry(VALUE recv, ID mid);
400static inline enum method_missing_reason rb_method_call_status(rb_execution_context_t *ec, const rb_callable_method_entry_t *me, call_type scope, VALUE self);
401
402static VALUE
403gccct_hash(VALUE klass, VALUE box_value, ID mid)
404{
405 return ((klass ^ box_value) >> 3) ^ (VALUE)mid;
406}
407
408NOINLINE(static const struct rb_callcache *gccct_method_search_slowpath(rb_vm_t *vm, VALUE klass, unsigned int index, const struct rb_callinfo * ci));
409
410static const struct rb_callcache *
411gccct_method_search_slowpath(rb_vm_t *vm, VALUE klass, unsigned int index, const struct rb_callinfo *ci)
412{
413 struct rb_call_data cd = {
414 .ci = ci,
415 .cc = NULL
416 };
417
418 vm_search_method_slowpath0(vm->self, &cd, klass);
419
420 if (UNLIKELY(!vm->global_cc_cache_table_used)) {
421 vm->global_cc_cache_table_used = true;
422 }
423 return vm->global_cc_cache_table[index] = cd.cc;
424}
425
426static void
427scope_to_ci(call_type scope, ID mid, int argc, struct rb_callinfo *ci)
428{
429 int flags = 0;
430
431 switch(scope) {
432 case CALL_PUBLIC:
433 break;
434 case CALL_FCALL:
435 flags |= VM_CALL_FCALL;
436 break;
437 case CALL_VCALL:
438 flags |= VM_CALL_VCALL;
439 break;
440 case CALL_PUBLIC_KW:
441 flags |= VM_CALL_KWARG;
442 break;
443 case CALL_FCALL_KW:
444 flags |= (VM_CALL_KWARG | VM_CALL_FCALL);
445 break;
446 }
447 *ci = VM_CI_ON_STACK(mid, flags, argc, NULL);
448}
449
450static inline const struct rb_callcache *
451gccct_method_search(rb_execution_context_t *ec, VALUE recv, ID mid, const struct rb_callinfo *ci)
452{
453 VALUE klass, box_value;
454 const rb_box_t *box = rb_current_box();
455
456 if (!SPECIAL_CONST_P(recv)) {
457 klass = RBASIC_CLASS(recv);
458 if (UNLIKELY(!klass)) uncallable_object(recv, mid);
459 }
460 else {
461 klass = CLASS_OF(recv);
462 }
463
464 if (BOX_USER_P(box)) {
465 box_value = box->box_object;
466 }
467 else {
468 box_value = 0;
469 }
470 // search global method cache
471 unsigned int index = (unsigned int)(gccct_hash(klass, box_value, mid) % VM_GLOBAL_CC_CACHE_TABLE_SIZE);
472 rb_vm_t *vm = rb_ec_vm_ptr(ec);
473 const struct rb_callcache *cc = vm->global_cc_cache_table[index];
474
475 if (LIKELY(cc)) {
476 if (LIKELY(vm_cc_class_check(cc, klass))) {
477 const rb_callable_method_entry_t *cme = vm_cc_cme(cc);
478 if (LIKELY(!METHOD_ENTRY_INVALIDATED(cme) &&
479 cme->called_id == mid)) {
480
481 VM_ASSERT(vm_cc_check_cme(cc, rb_callable_method_entry(klass, mid)));
482 RB_DEBUG_COUNTER_INC(gccct_hit);
483
484 return cc;
485 }
486 }
487 }
488 else {
489 RB_DEBUG_COUNTER_INC(gccct_null);
490 }
491
492 RB_DEBUG_COUNTER_INC(gccct_miss);
493 return gccct_method_search_slowpath(vm, klass, index, ci);
494}
495
496VALUE
497rb_gccct_clear_table(void)
498{
499 rb_vm_t *vm = GET_VM();
500 if (vm->global_cc_cache_table_used) {
501 MEMZERO(vm->global_cc_cache_table, struct rb_callcache *, VM_GLOBAL_CC_CACHE_TABLE_SIZE);
502 vm->global_cc_cache_table_used = false;
503 }
504 return Qnil;
505}
506
523static inline VALUE
524rb_call0(rb_execution_context_t *ec,
525 VALUE recv, ID mid, int argc, const VALUE *argv,
526 call_type call_scope, VALUE self)
527{
528 enum method_missing_reason call_status;
529 call_type scope = call_scope;
530 int kw_splat = RB_NO_KEYWORDS;
531
532 switch (scope) {
533 case CALL_PUBLIC_KW:
534 scope = CALL_PUBLIC;
535 kw_splat = 1;
536 break;
537 case CALL_FCALL_KW:
538 scope = CALL_FCALL;
539 kw_splat = 1;
540 break;
541 default:
542 break;
543 }
544
545 struct rb_callinfo ci;
546 scope_to_ci(scope, mid, argc, &ci);
547
548 const struct rb_callcache *cc = gccct_method_search(ec, recv, mid, &ci);
549
550 if (scope == CALL_PUBLIC) {
551 RB_DEBUG_COUNTER_INC(call0_public);
552
553 const rb_callable_method_entry_t *cc_cme = cc ? vm_cc_cme(cc) : NULL;
554 const rb_callable_method_entry_t *cme = callable_method_entry_refinements0(CLASS_OF(recv), mid, NULL, true, cc_cme);
555 call_status = rb_method_call_status(ec, cme, scope, self);
556
557 if (UNLIKELY(call_status != MISSING_NONE)) {
558 return method_missing(ec, recv, mid, argc, argv, call_status, kw_splat);
559 }
560 else if (UNLIKELY(cc_cme != cme)) { // refinement is solved
561 stack_check(ec);
562 return rb_vm_call_kw(ec, recv, mid, argc, argv, cme, kw_splat);
563 }
564 }
565 else {
566 RB_DEBUG_COUNTER_INC(call0_other);
567 call_status = rb_method_call_status(ec, cc ? vm_cc_cme(cc) : NULL, scope, self);
568
569 if (UNLIKELY(call_status != MISSING_NONE)) {
570 return method_missing(ec, recv, mid, argc, argv, call_status, kw_splat);
571 }
572 }
573
574 stack_check(ec);
575 return vm_call0_cc(ec, recv, mid, argc, argv, cc, kw_splat);
576}
577
579 VALUE defined_class;
580 VALUE recv;
581 ID mid;
584 unsigned int respond: 1;
585 unsigned int respond_to_missing: 1;
586 int argc;
587 const VALUE *argv;
588 int kw_splat;
589};
590
591static VALUE
592check_funcall_exec(VALUE v)
593{
594 struct rescue_funcall_args *args = (void *)v;
595 return call_method_entry(args->ec, args->defined_class,
596 args->recv, idMethodMissing,
597 args->cme, args->argc, args->argv, args->kw_splat);
598}
599
600static VALUE
601check_funcall_failed(VALUE v, VALUE e)
602{
603 struct rescue_funcall_args *args = (void *)v;
604 int ret = args->respond;
605 if (!ret) {
606 switch (method_boundp(args->defined_class, args->mid,
607 BOUND_PRIVATE|BOUND_RESPONDS)) {
608 case 2:
609 ret = TRUE;
610 break;
611 case 0:
612 ret = args->respond_to_missing;
613 break;
614 default:
615 ret = FALSE;
616 break;
617 }
618 }
619 if (ret) {
620 rb_exc_raise(e);
621 }
622 return Qundef;
623}
624
625static int
626check_funcall_respond_to(rb_execution_context_t *ec, VALUE klass, VALUE recv, ID mid)
627{
628 return vm_respond_to(ec, klass, recv, mid, TRUE);
629}
630
631static int
632check_funcall_callable(rb_execution_context_t *ec, const rb_callable_method_entry_t *me)
633{
634 return rb_method_call_status(ec, me, CALL_FCALL, ec->cfp->self) == MISSING_NONE;
635}
636
637static VALUE
638check_funcall_missing(rb_execution_context_t *ec, VALUE klass, VALUE recv, ID mid, int argc, const VALUE *argv, int respond, VALUE def, int kw_splat)
639{
640 struct rescue_funcall_args args;
642 VALUE ret = Qundef;
643
644 ret = basic_obj_respond_to_missing(ec, klass, recv,
645 ID2SYM(mid), Qtrue);
646 if (!RTEST(ret)) return def;
647 args.respond = respond > 0;
648 args.respond_to_missing = !UNDEF_P(ret);
649 ret = def;
650 cme = callable_method_entry(klass, idMethodMissing, &args.defined_class);
651
652 if (cme && !METHOD_ENTRY_BASIC(cme)) {
653 VALUE argbuf, *new_args = ALLOCV_N(VALUE, argbuf, argc+1);
654
655 new_args[0] = ID2SYM(mid);
656 #ifdef __GLIBC__
657 if (!argv) {
658 static const VALUE buf = Qfalse;
659 VM_ASSERT(argc == 0);
660 argv = &buf;
661 }
662 #endif
663 MEMCPY(new_args+1, argv, VALUE, argc);
664 ec->method_missing_reason = MISSING_NOENTRY;
665 args.ec = ec;
666 args.recv = recv;
667 args.cme = cme;
668 args.mid = mid;
669 args.argc = argc + 1;
670 args.argv = new_args;
671 args.kw_splat = kw_splat;
672 ret = rb_rescue2(check_funcall_exec, (VALUE)&args,
673 check_funcall_failed, (VALUE)&args,
675 ALLOCV_END(argbuf);
676 }
677 return ret;
678}
679
680static VALUE rb_check_funcall_default_kw(VALUE recv, ID mid, int argc, const VALUE *argv, VALUE def, int kw_splat);
681
682VALUE
683rb_check_funcall_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
684{
685 return rb_check_funcall_default_kw(recv, mid, argc, argv, Qundef, kw_splat);
686}
687
688VALUE
689rb_check_funcall(VALUE recv, ID mid, int argc, const VALUE *argv)
690{
691 return rb_check_funcall_default_kw(recv, mid, argc, argv, Qundef, RB_NO_KEYWORDS);
692}
693
694static VALUE
695rb_check_funcall_default_kw(VALUE recv, ID mid, int argc, const VALUE *argv, VALUE def, int kw_splat)
696{
697 VM_ASSERT(ruby_thread_has_gvl_p());
698
699 VALUE klass = CLASS_OF(recv);
701 rb_execution_context_t *ec = GET_EC();
702 int respond = check_funcall_respond_to(ec, klass, recv, mid);
703
704 if (!respond)
705 return def;
706
707 me = rb_search_method_entry(recv, mid);
708 if (!check_funcall_callable(ec, me)) {
709 VALUE ret = check_funcall_missing(ec, klass, recv, mid, argc, argv,
710 respond, def, kw_splat);
711 if (UNDEF_P(ret)) ret = def;
712 return ret;
713 }
714 stack_check(ec);
715 return rb_vm_call_kw(ec, recv, mid, argc, argv, me, kw_splat);
716}
717
718VALUE
719rb_check_funcall_default(VALUE recv, ID mid, int argc, const VALUE *argv, VALUE def)
720{
721 return rb_check_funcall_default_kw(recv, mid, argc, argv, def, RB_NO_KEYWORDS);
722}
723
724VALUE
725rb_check_funcall_with_hook_kw(VALUE recv, ID mid, int argc, const VALUE *argv,
726 rb_check_funcall_hook *hook, VALUE arg, int kw_splat)
727{
728 VALUE klass = CLASS_OF(recv);
730 rb_execution_context_t *ec = GET_EC();
731 int respond = check_funcall_respond_to(ec, klass, recv, mid);
732
733 if (!respond) {
734 (*hook)(FALSE, recv, mid, argc, argv, arg);
735 return Qundef;
736 }
737
738 me = rb_search_method_entry(recv, mid);
739 if (!check_funcall_callable(ec, me)) {
740 VALUE ret = check_funcall_missing(ec, klass, recv, mid, argc, argv,
741 respond, Qundef, kw_splat);
742 (*hook)(!UNDEF_P(ret), recv, mid, argc, argv, arg);
743 return ret;
744 }
745 stack_check(ec);
746 (*hook)(TRUE, recv, mid, argc, argv, arg);
747 return rb_vm_call_kw(ec, recv, mid, argc, argv, me, kw_splat);
748}
749
750const char *
751rb_type_str(enum ruby_value_type type)
752{
753#define type_case(t) t: return #t
754 switch (type) {
755 case type_case(T_NONE);
756 case type_case(T_OBJECT);
757 case type_case(T_CLASS);
758 case type_case(T_MODULE);
759 case type_case(T_FLOAT);
760 case type_case(T_STRING);
761 case type_case(T_REGEXP);
762 case type_case(T_ARRAY);
763 case type_case(T_HASH);
764 case type_case(T_STRUCT);
765 case type_case(T_BIGNUM);
766 case type_case(T_FILE);
767 case type_case(T_DATA);
768 case type_case(T_MATCH);
769 case type_case(T_COMPLEX);
770 case type_case(T_RATIONAL);
771 case type_case(T_NIL);
772 case type_case(T_TRUE);
773 case type_case(T_FALSE);
774 case type_case(T_SYMBOL);
775 case type_case(T_FIXNUM);
776 case type_case(T_IMEMO);
777 case type_case(T_UNDEF);
778 case type_case(T_NODE);
779 case type_case(T_ICLASS);
780 case type_case(T_ZOMBIE);
781 case type_case(T_MOVED);
782 case T_MASK: break;
783 }
784#undef type_case
785 return NULL;
786}
787
788static void
789uncallable_object(VALUE recv, ID mid)
790{
791 VALUE flags;
792 int type;
793 const char *typestr;
794 VALUE mname = rb_id2str(mid);
795
796 if (SPECIAL_CONST_P(recv)) {
797 rb_raise(rb_eNotImpError,
798 "method '%"PRIsVALUE"' called on unexpected immediate object (%p)",
799 mname, (void *)recv);
800 }
801 else if ((flags = RBASIC(recv)->flags) == 0) {
802 rb_raise(rb_eNotImpError,
803 "method '%"PRIsVALUE"' called on terminated object (%p)",
804 mname, (void *)recv);
805 }
806 else if (!(typestr = rb_type_str(type = BUILTIN_TYPE(recv)))) {
807 rb_raise(rb_eNotImpError,
808 "method '%"PRIsVALUE"' called on broken T_?""?""?(0x%02x) object"
809 " (%p flags=0x%"PRIxVALUE")",
810 mname, type, (void *)recv, flags);
811 }
812 else if (T_OBJECT <= type && type < T_NIL) {
813 rb_raise(rb_eNotImpError,
814 "method '%"PRIsVALUE"' called on hidden %s object"
815 " (%p flags=0x%"PRIxVALUE")",
816 mname, typestr, (void *)recv, flags);
817 }
818 else {
819 rb_raise(rb_eNotImpError,
820 "method '%"PRIsVALUE"' called on unexpected %s object"
821 " (%p flags=0x%"PRIxVALUE")",
822 mname, typestr, (void *)recv, flags);
823 }
824}
825
826static inline const rb_callable_method_entry_t *
827rb_search_method_entry(VALUE recv, ID mid)
828{
829 VALUE klass = CLASS_OF(recv);
830
831 if (!klass) uncallable_object(recv, mid);
832 return rb_callable_method_entry(klass, mid);
833}
834
835static inline enum method_missing_reason
836rb_method_call_status(rb_execution_context_t *ec, const rb_callable_method_entry_t *me, call_type scope, VALUE self)
837{
838 if (UNLIKELY(UNDEFINED_METHOD_ENTRY_P(me))) {
839 goto undefined;
840 }
841 else if (UNLIKELY(me->def->type == VM_METHOD_TYPE_REFINED)) {
842 me = rb_resolve_refined_method_callable(Qnil, me);
843 if (UNDEFINED_METHOD_ENTRY_P(me)) goto undefined;
844 }
845
846 rb_method_visibility_t visi = METHOD_ENTRY_VISI(me);
847
848 /* receiver specified form for private method */
849 if (UNLIKELY(visi != METHOD_VISI_PUBLIC)) {
850 if (me->def->original_id == idMethodMissing) {
851 return MISSING_NONE;
852 }
853 else if (visi == METHOD_VISI_PRIVATE &&
854 scope == CALL_PUBLIC) {
855 return MISSING_PRIVATE;
856 }
857 /* self must be kind of a specified form for protected method */
858 else if (visi == METHOD_VISI_PROTECTED &&
859 scope == CALL_PUBLIC) {
860
861 VALUE defined_class = me->owner;
862 if (RB_TYPE_P(defined_class, T_ICLASS)) {
863 defined_class = RBASIC(defined_class)->klass;
864 }
865
866 if (UNDEF_P(self) || !rb_obj_is_kind_of(self, defined_class)) {
867 return MISSING_PROTECTED;
868 }
869 }
870 }
871
872 return MISSING_NONE;
873
874 undefined:
875 return scope == CALL_VCALL ? MISSING_VCALL : MISSING_NOENTRY;
876}
877
878
890static inline VALUE
891rb_call(VALUE recv, ID mid, int argc, const VALUE *argv, call_type scope)
892{
893 rb_execution_context_t *ec = GET_EC();
894 return rb_call0(ec, recv, mid, argc, argv, scope, ec->cfp->self);
895}
896
897NORETURN(static void raise_method_missing(rb_execution_context_t *ec, int argc, const VALUE *argv,
898 VALUE obj, enum method_missing_reason call_status));
899
900/*
901 * call-seq:
902 * obj.method_missing(symbol [, *args] ) -> result
903 *
904 * Invoked by Ruby when <i>obj</i> is sent a message it cannot handle.
905 * <i>symbol</i> is the symbol for the method called, and <i>args</i>
906 * are any arguments that were passed to it. By default, the interpreter
907 * raises an error when this method is called. However, it is possible
908 * to override the method to provide more dynamic behavior.
909 * If it is decided that a particular method should not be handled, then
910 * <i>super</i> should be called, so that ancestors can pick up the
911 * missing method.
912 * The example below creates
913 * a class <code>Roman</code>, which responds to methods with names
914 * consisting of roman numerals, returning the corresponding integer
915 * values.
916 *
917 * class Roman
918 * def roman_to_int(str)
919 * # ...
920 * end
921 *
922 * def method_missing(symbol, *args)
923 * str = symbol.id2name
924 * begin
925 * roman_to_int(str)
926 * rescue
927 * super(symbol, *args)
928 * end
929 * end
930 * end
931 *
932 * r = Roman.new
933 * r.iv #=> 4
934 * r.xxiii #=> 23
935 * r.mm #=> 2000
936 * r.foo #=> NoMethodError
937 */
938
939static VALUE
940rb_method_missing(int argc, const VALUE *argv, VALUE obj)
941{
942 rb_execution_context_t *ec = GET_EC();
943 raise_method_missing(ec, argc, argv, obj, ec->method_missing_reason);
945}
946
947VALUE
948rb_make_no_method_exception(VALUE exc, VALUE format, VALUE obj,
949 int argc, const VALUE *argv, int priv)
950{
951 VALUE name = argv[0];
952
953 if (!format) {
954 format = rb_fstring_lit("undefined method '%1$s' for %3$s%4$s");
955 }
956 if (exc == rb_eNoMethodError) {
957 VALUE args = rb_ary_new4(argc - 1, argv + 1);
958 return rb_nomethod_err_new(format, obj, name, args, priv);
959 }
960 else {
961 return rb_name_err_new(format, obj, name);
962 }
963}
964
965static void
966raise_method_missing(rb_execution_context_t *ec, int argc, const VALUE *argv, VALUE obj,
967 enum method_missing_reason last_call_status)
968{
970 VALUE format = 0;
971
972 if (UNLIKELY(argc == 0)) {
973 rb_raise(rb_eArgError, "no method name given");
974 }
975 else if (UNLIKELY(!SYMBOL_P(argv[0]))) {
976 const VALUE e = rb_eArgError; /* TODO: TypeError? */
977 rb_raise(e, "method name must be a Symbol but %"PRIsVALUE" is given",
978 rb_obj_class(argv[0]));
979 }
980
981 stack_check(ec);
982
983 if (last_call_status & MISSING_PRIVATE) {
984 format = rb_fstring_lit("private method '%1$s' called for %3$s%4$s");
985 }
986 else if (last_call_status & MISSING_PROTECTED) {
987 format = rb_fstring_lit("protected method '%1$s' called for %3$s%4$s");
988 }
989 else if (last_call_status & MISSING_VCALL) {
990 format = rb_fstring_lit("undefined local variable or method '%1$s' for %3$s%4$s");
991 exc = rb_eNameError;
992 }
993 else if (last_call_status & MISSING_SUPER) {
994 format = rb_fstring_lit("super: no superclass method '%1$s' for %3$s%4$s");
995 }
996
997 {
998 exc = rb_make_no_method_exception(exc, format, obj, argc, argv,
999 last_call_status & (MISSING_FCALL|MISSING_VCALL));
1000 if (!(last_call_status & MISSING_MISSING)) {
1001 rb_vm_pop_cfunc_frame();
1002 }
1003 rb_exc_raise(exc);
1004 }
1005}
1006
1007static void
1008vm_raise_method_missing(rb_execution_context_t *ec, int argc, const VALUE *argv,
1009 VALUE obj, int call_status)
1010{
1011 vm_passed_block_handler_set(ec, VM_BLOCK_HANDLER_NONE);
1012 raise_method_missing(ec, argc, argv, obj, call_status | MISSING_MISSING);
1013}
1014
1015static inline VALUE
1016method_missing(rb_execution_context_t *ec, VALUE obj, ID id, int argc, const VALUE *argv, enum method_missing_reason call_status, int kw_splat)
1017{
1018 VALUE *nargv, result, work, klass;
1019 VALUE block_handler = vm_passed_block_handler(ec);
1021
1022 ec->method_missing_reason = call_status;
1023
1024 if (id == idMethodMissing) {
1025 goto missing;
1026 }
1027
1028 nargv = ALLOCV_N(VALUE, work, argc + 1);
1029 nargv[0] = ID2SYM(id);
1030 #ifdef __GLIBC__
1031 if (!argv) {
1032 static const VALUE buf = Qfalse;
1033 VM_ASSERT(argc == 0);
1034 argv = &buf;
1035 }
1036 #endif
1037 MEMCPY(nargv + 1, argv, VALUE, argc);
1038 ++argc;
1039 argv = nargv;
1040
1041 klass = CLASS_OF(obj);
1042 if (!klass) goto missing;
1043 me = rb_callable_method_entry(klass, idMethodMissing);
1044 if (!me || METHOD_ENTRY_BASIC(me)) goto missing;
1045 vm_passed_block_handler_set(ec, block_handler);
1046 result = rb_vm_call_kw(ec, obj, idMethodMissing, argc, argv, me, kw_splat);
1047 if (work) ALLOCV_END(work);
1048 return result;
1049 missing:
1050 raise_method_missing(ec, argc, argv, obj, call_status | MISSING_MISSING);
1052}
1053
1054static inline VALUE
1055rb_funcallv_scope(VALUE recv, ID mid, int argc, const VALUE *argv, call_type scope)
1056{
1057 rb_execution_context_t *ec = GET_EC();
1058
1059 struct rb_callinfo ci;
1060 scope_to_ci(scope, mid, argc, &ci);
1061
1062 const struct rb_callcache *cc = gccct_method_search(ec, recv, mid, &ci);
1063 VALUE self = ec->cfp->self;
1064
1065 if (LIKELY(cc) &&
1066 LIKELY(rb_method_call_status(ec, vm_cc_cme(cc), scope, self) == MISSING_NONE)) {
1067 // fastpath
1068 return vm_call0_cc(ec, recv, mid, argc, argv, cc, false);
1069 }
1070 else {
1071 return rb_call0(ec, recv, mid, argc, argv, scope, self);
1072 }
1073}
1074
1075#ifdef rb_funcallv
1076#undef rb_funcallv
1077#endif
1078VALUE
1079rb_funcallv(VALUE recv, ID mid, int argc, const VALUE *argv)
1080{
1081 VM_ASSERT(ruby_thread_has_gvl_p());
1082
1083 return rb_funcallv_scope(recv, mid, argc, argv, CALL_FCALL);
1084}
1085
1086VALUE
1087rb_funcallv_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
1088{
1089 VM_ASSERT(ruby_thread_has_gvl_p());
1090
1091 return rb_call(recv, mid, argc, argv, kw_splat ? CALL_FCALL_KW : CALL_FCALL);
1092}
1093
1094VALUE
1095rb_apply(VALUE recv, ID mid, VALUE args)
1096{
1097 int argc;
1098 VALUE *argv, ret;
1099
1100 argc = RARRAY_LENINT(args);
1101 if (argc >= 0x100) {
1102 args = rb_ary_subseq(args, 0, argc);
1103 RBASIC_CLEAR_CLASS(args);
1104 OBJ_FREEZE(args);
1105 ret = rb_call(recv, mid, argc, RARRAY_CONST_PTR(args), CALL_FCALL);
1106 RB_GC_GUARD(args);
1107 return ret;
1108 }
1109 argv = ALLOCA_N(VALUE, argc);
1110 MEMCPY(argv, RARRAY_CONST_PTR(args), VALUE, argc);
1111
1112 return rb_funcallv(recv, mid, argc, argv);
1113}
1114
1115#ifdef rb_funcall
1116#undef rb_funcall
1117#endif
1118
1119VALUE
1120rb_funcall(VALUE recv, ID mid, int n, ...)
1121{
1122 VALUE *argv;
1123 va_list ar;
1124
1125 if (n > 0) {
1126 long i;
1127
1128 va_start(ar, n);
1129
1130 argv = ALLOCA_N(VALUE, n);
1131
1132 for (i = 0; i < n; i++) {
1133 argv[i] = va_arg(ar, VALUE);
1134 }
1135 va_end(ar);
1136 }
1137 else {
1138 argv = 0;
1139 }
1140 return rb_funcallv(recv, mid, n, argv);
1141}
1142
1153VALUE
1154rb_check_funcall_basic_kw(VALUE recv, ID mid, VALUE ancestor, int argc, const VALUE *argv, int kw_splat)
1155{
1156 const rb_callable_method_entry_t *cme;
1158 VALUE klass = CLASS_OF(recv);
1159 if (!klass) return Qundef; /* hidden object */
1160
1161 cme = rb_callable_method_entry(klass, mid);
1162 if (cme && METHOD_ENTRY_BASIC(cme) && RBASIC_CLASS(cme->defined_class) == ancestor) {
1163 ec = GET_EC();
1164 return rb_vm_call0(ec, recv, mid, argc, argv, cme, kw_splat);
1165 }
1166
1167 return Qundef;
1168}
1169
1170VALUE
1171rb_funcallv_public(VALUE recv, ID mid, int argc, const VALUE *argv)
1172{
1173 return rb_funcallv_scope(recv, mid, argc, argv, CALL_PUBLIC);
1174}
1175
1176VALUE
1177rb_funcallv_public_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
1178{
1179 return rb_call(recv, mid, argc, argv, kw_splat ? CALL_PUBLIC_KW : CALL_PUBLIC);
1180}
1181
1182VALUE
1183rb_funcall_passing_block(VALUE recv, ID mid, int argc, const VALUE *argv)
1184{
1185 PASS_PASSED_BLOCK_HANDLER();
1186 return rb_funcallv_public(recv, mid, argc, argv);
1187}
1188
1189VALUE
1190rb_funcall_passing_block_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
1191{
1192 PASS_PASSED_BLOCK_HANDLER();
1193 return rb_call(recv, mid, argc, argv, kw_splat ? CALL_PUBLIC_KW : CALL_PUBLIC);
1194}
1195
1196VALUE
1197rb_funcall_with_block(VALUE recv, ID mid, int argc, const VALUE *argv, VALUE passed_procval)
1198{
1199 if (!NIL_P(passed_procval)) {
1200 vm_passed_block_handler_set(GET_EC(), passed_procval);
1201 }
1202
1203 return rb_funcallv_public(recv, mid, argc, argv);
1204}
1205
1206VALUE
1207rb_funcall_with_block_kw(VALUE recv, ID mid, int argc, const VALUE *argv, VALUE passed_procval, int kw_splat)
1208{
1209 if (!NIL_P(passed_procval)) {
1210 vm_passed_block_handler_set(GET_EC(), passed_procval);
1211 }
1212
1213 return rb_call(recv, mid, argc, argv, kw_splat ? CALL_PUBLIC_KW : CALL_PUBLIC);
1214}
1215
1216static VALUE *
1217current_vm_stack_arg(const rb_execution_context_t *ec, const VALUE *argv)
1218{
1219 rb_control_frame_t *prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(ec->cfp);
1220 if (RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, prev_cfp)) return NULL;
1221 if (prev_cfp->sp + 1 != argv) return NULL;
1222 return prev_cfp->sp + 1;
1223}
1224
1225static VALUE
1226send_internal(int argc, const VALUE *argv, VALUE recv, call_type scope)
1227{
1228 ID id;
1229 VALUE vid;
1230 VALUE self;
1231 VALUE ret, vargv = 0;
1232 rb_execution_context_t *ec = GET_EC();
1233 int public = scope == CALL_PUBLIC || scope == CALL_PUBLIC_KW;
1234
1235 if (public) {
1236 self = Qundef;
1237 }
1238 else {
1239 self = RUBY_VM_PREVIOUS_CONTROL_FRAME(ec->cfp)->self;
1240 }
1241
1242 if (argc == 0) {
1243 rb_raise(rb_eArgError, "no method name given");
1244 }
1245
1246 vid = *argv;
1247
1248 id = rb_check_id(&vid);
1249 if (!id) {
1250 if (rb_method_basic_definition_p(CLASS_OF(recv), idMethodMissing)) {
1251 VALUE exc = rb_make_no_method_exception(rb_eNoMethodError, 0,
1252 recv, argc, argv,
1253 !public);
1254 rb_exc_raise(exc);
1255 }
1256 if (!SYMBOL_P(*argv)) {
1257 VALUE *tmp_argv = current_vm_stack_arg(ec, argv);
1258 vid = rb_str_intern(vid);
1259 if (tmp_argv) {
1260 tmp_argv[0] = vid;
1261 }
1262 else if (argc > 1) {
1263 tmp_argv = ALLOCV_N(VALUE, vargv, argc);
1264 tmp_argv[0] = vid;
1265 MEMCPY(tmp_argv+1, argv+1, VALUE, argc-1);
1266 argv = tmp_argv;
1267 }
1268 else {
1269 argv = &vid;
1270 }
1271 }
1272 id = idMethodMissing;
1273 ec->method_missing_reason = MISSING_NOENTRY;
1274 }
1275 else {
1276 argv++; argc--;
1277 }
1278 PASS_PASSED_BLOCK_HANDLER_EC(ec);
1279 ret = rb_call0(ec, recv, id, argc, argv, scope, self);
1280 ALLOCV_END(vargv);
1281 return ret;
1282}
1283
1284static VALUE
1285send_internal_kw(int argc, const VALUE *argv, VALUE recv, call_type scope)
1286{
1287 if (rb_keyword_given_p()) {
1288 switch (scope) {
1289 case CALL_PUBLIC:
1290 scope = CALL_PUBLIC_KW;
1291 break;
1292 case CALL_FCALL:
1293 scope = CALL_FCALL_KW;
1294 break;
1295 default:
1296 break;
1297 }
1298 }
1299 return send_internal(argc, argv, recv, scope);
1300}
1301
1302/*
1303 * call-seq:
1304 * foo.send(symbol [, args...]) -> obj
1305 * foo.__send__(symbol [, args...]) -> obj
1306 * foo.send(string [, args...]) -> obj
1307 * foo.__send__(string [, args...]) -> obj
1308 *
1309 * Invokes the method identified by _symbol_, passing it any
1310 * arguments specified.
1311 * When the method is identified by a string, the string is converted
1312 * to a symbol.
1313 *
1314 * BasicObject implements +__send__+, Kernel implements +send+.
1315 * <code>__send__</code> is safer than +send+
1316 * when _obj_ has the same method name like <code>Socket</code>.
1317 * See also <code>public_send</code>.
1318 *
1319 * class Klass
1320 * def hello(*args)
1321 * "Hello " + args.join(' ')
1322 * end
1323 * end
1324 * k = Klass.new
1325 * k.send :hello, "gentle", "readers" #=> "Hello gentle readers"
1326 */
1327
1328VALUE
1329rb_f_send(int argc, VALUE *argv, VALUE recv)
1330{
1331 return send_internal_kw(argc, argv, recv, CALL_FCALL);
1332}
1333
1334/*
1335 * call-seq:
1336 * obj.public_send(symbol [, args...]) -> obj
1337 * obj.public_send(string [, args...]) -> obj
1338 *
1339 * Invokes the method identified by _symbol_, passing it any
1340 * arguments specified. Unlike send, public_send calls public
1341 * methods only.
1342 * When the method is identified by a string, the string is converted
1343 * to a symbol.
1344 *
1345 * 1.public_send(:puts, "hello") # causes NoMethodError
1346 */
1347
1348static VALUE
1349rb_f_public_send(int argc, VALUE *argv, VALUE recv)
1350{
1351 return send_internal_kw(argc, argv, recv, CALL_PUBLIC);
1352}
1353
1354/* yield */
1355
1356static inline VALUE
1357rb_yield_0_kw(int argc, const VALUE * argv, int kw_splat)
1358{
1359 return vm_yield(GET_EC(), argc, argv, kw_splat);
1360}
1361
1362static inline VALUE
1363rb_yield_0(int argc, const VALUE * argv)
1364{
1365 return vm_yield(GET_EC(), argc, argv, RB_NO_KEYWORDS);
1366}
1367
1368VALUE
1369rb_yield_1(VALUE val)
1370{
1371 return rb_yield_0(1, &val);
1372}
1373
1374VALUE
1376{
1377 if (UNDEF_P(val)) {
1378 return rb_yield_0(0, NULL);
1379 }
1380 else {
1381 return rb_yield_0(1, &val);
1382 }
1383}
1384
1385VALUE
1386rb_ec_yield(rb_execution_context_t *ec, VALUE val)
1387{
1388 if (UNDEF_P(val)) {
1389 return vm_yield(ec, 0, NULL, RB_NO_KEYWORDS);
1390 }
1391 else {
1392 return vm_yield(ec, 1, &val, RB_NO_KEYWORDS);
1393 }
1394}
1395
1396#undef rb_yield_values
1397VALUE
1399{
1400 if (n == 0) {
1401 return rb_yield_0(0, 0);
1402 }
1403 else {
1404 int i;
1405 VALUE *argv;
1406 va_list args;
1407 argv = ALLOCA_N(VALUE, n);
1408
1409 va_start(args, n);
1410 for (i=0; i<n; i++) {
1411 argv[i] = va_arg(args, VALUE);
1412 }
1413 va_end(args);
1414
1415 return rb_yield_0(n, argv);
1416 }
1417}
1418
1419VALUE
1420rb_yield_values2(int argc, const VALUE *argv)
1421{
1422 return rb_yield_0(argc, argv);
1423}
1424
1425VALUE
1426rb_yield_values_kw(int argc, const VALUE *argv, int kw_splat)
1427{
1428 return rb_yield_0_kw(argc, argv, kw_splat);
1429}
1430
1431VALUE
1433{
1434 VALUE tmp = rb_check_array_type(values);
1435 VALUE v;
1436 if (NIL_P(tmp)) {
1437 rb_raise(rb_eArgError, "not an array");
1438 }
1439 v = rb_yield_0(RARRAY_LENINT(tmp), RARRAY_CONST_PTR(tmp));
1440 RB_GC_GUARD(tmp);
1441 return v;
1442}
1443
1444VALUE
1445rb_yield_splat_kw(VALUE values, int kw_splat)
1446{
1447 VALUE tmp = rb_check_array_type(values);
1448 VALUE v;
1449 if (NIL_P(tmp)) {
1450 rb_raise(rb_eArgError, "not an array");
1451 }
1452 v = rb_yield_0_kw(RARRAY_LENINT(tmp), RARRAY_CONST_PTR(tmp), kw_splat);
1453 RB_GC_GUARD(tmp);
1454 return v;
1455}
1456
1457VALUE
1458rb_yield_force_blockarg(VALUE values)
1459{
1460 return vm_yield_force_blockarg(GET_EC(), values);
1461}
1462
1463VALUE
1465{
1466 return vm_yield_with_block(GET_EC(), argc, argv,
1467 NIL_P(blockarg) ? VM_BLOCK_HANDLER_NONE : blockarg,
1469}
1470
1471#if VMDEBUG
1472static const char *
1473vm_frametype_name(const rb_control_frame_t *cfp);
1474#endif
1475
1476static VALUE
1477rb_iterate0(VALUE (* it_proc) (VALUE), VALUE data1,
1478 const struct vm_ifunc *const ifunc,
1480{
1481 enum ruby_tag_type state;
1482 volatile VALUE retval = Qnil;
1483 rb_control_frame_t *const cfp = ec->cfp;
1484
1485 EC_PUSH_TAG(ec);
1486 state = EC_EXEC_TAG();
1487 if (state == 0) {
1488 iter_retry:
1489 {
1490 VALUE block_handler;
1491
1492 if (ifunc) {
1493 struct rb_captured_block *captured = VM_CFP_TO_CAPTURED_BLOCK(cfp);
1494 captured->code.ifunc = ifunc;
1495 block_handler = VM_BH_FROM_IFUNC_BLOCK(captured);
1496 }
1497 else {
1498 block_handler = VM_CF_BLOCK_HANDLER(cfp);
1499 }
1500 vm_passed_block_handler_set(ec, block_handler);
1501 }
1502 retval = (*it_proc) (data1);
1503 }
1504 else if (state == TAG_BREAK || state == TAG_RETRY) {
1505 const struct vm_throw_data *const err = (struct vm_throw_data *)ec->errinfo;
1506 const rb_control_frame_t *const escape_cfp = THROW_DATA_CATCH_FRAME(err);
1507
1508 if (cfp == escape_cfp) {
1509 rb_vm_rewind_cfp(ec, cfp);
1510
1511 state = 0;
1512 ec->tag->state = TAG_NONE;
1513 ec->errinfo = Qnil;
1514
1515 if (state == TAG_RETRY) goto iter_retry;
1516 retval = THROW_DATA_VAL(err);
1517 }
1518 else if (0) {
1519 SDR(); fprintf(stderr, "%p, %p\n", (void *)cfp, (void *)escape_cfp);
1520 }
1521 }
1522 EC_POP_TAG();
1523
1524 if (state) {
1525 EC_JUMP_TAG(ec, state);
1526 }
1527 return retval;
1528}
1529
1530static VALUE
1531rb_iterate_internal(VALUE (* it_proc)(VALUE), VALUE data1,
1532 rb_block_call_func_t bl_proc, VALUE data2)
1533{
1534 return rb_iterate0(it_proc, data1,
1535 bl_proc ? rb_vm_ifunc_proc_new(bl_proc, (void *)data2) : 0,
1536 GET_EC());
1537}
1538
1540 VALUE obj;
1541 ID mid;
1542 int argc;
1543 const VALUE *argv;
1544 int kw_splat;
1545};
1546
1547static VALUE
1548iterate_method(VALUE obj)
1549{
1550 const struct iter_method_arg * arg =
1551 (struct iter_method_arg *) obj;
1552
1553 return rb_call(arg->obj, arg->mid, arg->argc, arg->argv, arg->kw_splat ? CALL_FCALL_KW : CALL_FCALL);
1554}
1555
1556VALUE rb_block_call_kw(VALUE obj, ID mid, int argc, const VALUE * argv, rb_block_call_func_t bl_proc, VALUE data2, int kw_splat);
1557
1558VALUE
1559rb_block_call(VALUE obj, ID mid, int argc, const VALUE * argv,
1560 rb_block_call_func_t bl_proc, VALUE data2)
1561{
1562 return rb_block_call_kw(obj, mid, argc, argv, bl_proc, data2, RB_NO_KEYWORDS);
1563}
1564
1565VALUE
1566rb_block_call_kw(VALUE obj, ID mid, int argc, const VALUE * argv,
1567 rb_block_call_func_t bl_proc, VALUE data2, int kw_splat)
1568{
1569 struct iter_method_arg arg;
1570
1571 arg.obj = obj;
1572 arg.mid = mid;
1573 arg.argc = argc;
1574 arg.argv = argv;
1575 arg.kw_splat = kw_splat;
1576 return rb_iterate_internal(iterate_method, (VALUE)&arg, bl_proc, data2);
1577}
1578
1579/*
1580 * A flexible variant of rb_block_call and rb_block_call_kw.
1581 * This function accepts flags:
1582 *
1583 * RB_NO_KEYWORDS, RB_PASS_KEYWORDS, RB_PASS_CALLED_KEYWORDS:
1584 * Works as the same as rb_block_call_kw.
1585 *
1586 * RB_BLOCK_NO_USE_PACKED_ARGS:
1587 * The given block ("bl_proc") does not use "yielded_arg" of rb_block_call_func_t.
1588 * Instead, the block accesses the yielded arguments via "argc" and "argv".
1589 * This flag allows the called method to yield arguments without allocating an Array.
1590 */
1591VALUE
1592rb_block_call2(VALUE obj, ID mid, int argc, const VALUE *argv,
1593 rb_block_call_func_t bl_proc, VALUE data2, long flags)
1594{
1595 struct iter_method_arg arg;
1596
1597 arg.obj = obj;
1598 arg.mid = mid;
1599 arg.argc = argc;
1600 arg.argv = argv;
1601 arg.kw_splat = flags & 1;
1602
1603 struct vm_ifunc *ifunc = rb_vm_ifunc_proc_new(bl_proc, (void *)data2);
1604 if (flags & RB_BLOCK_NO_USE_PACKED_ARGS)
1605 ifunc->flags |= IFUNC_YIELD_OPTIMIZABLE;
1606
1607 return rb_iterate0(iterate_method, (VALUE)&arg, ifunc, GET_EC());
1608}
1609
1610VALUE
1611rb_lambda_call(VALUE obj, ID mid, int argc, const VALUE *argv,
1612 rb_block_call_func_t bl_proc, int min_argc, int max_argc,
1613 VALUE data2)
1614{
1615 struct iter_method_arg arg;
1616 struct vm_ifunc *block;
1617
1618 if (!bl_proc) rb_raise(rb_eArgError, "NULL lambda function");
1619 arg.obj = obj;
1620 arg.mid = mid;
1621 arg.argc = argc;
1622 arg.argv = argv;
1623 arg.kw_splat = 0;
1624 block = rb_vm_ifunc_new(bl_proc, (void *)data2, min_argc, max_argc);
1625 return rb_iterate0(iterate_method, (VALUE)&arg, block, GET_EC());
1626}
1627
1628static VALUE
1629iterate_check_method(VALUE obj)
1630{
1631 const struct iter_method_arg * arg =
1632 (struct iter_method_arg *) obj;
1633
1634 return rb_check_funcall(arg->obj, arg->mid, arg->argc, arg->argv);
1635}
1636
1637VALUE
1638rb_check_block_call(VALUE obj, ID mid, int argc, const VALUE *argv,
1639 rb_block_call_func_t bl_proc, VALUE data2)
1640{
1641 struct iter_method_arg arg;
1642
1643 arg.obj = obj;
1644 arg.mid = mid;
1645 arg.argc = argc;
1646 arg.argv = argv;
1647 arg.kw_splat = 0;
1648 return rb_iterate_internal(iterate_check_method, (VALUE)&arg, bl_proc, data2);
1649}
1650
1651VALUE
1653{
1654 return rb_call(obj, idEach, 0, 0, CALL_FCALL);
1655}
1656
1657static VALUE eval_default_path = Qfalse;
1658
1659#define EVAL_LOCATION_MARK "eval at "
1660#define EVAL_LOCATION_MARK_LEN (int)rb_strlen_lit(EVAL_LOCATION_MARK)
1661
1662static VALUE
1663get_eval_default_path(void)
1664{
1665 int location_lineno;
1666 VALUE location_path = rb_source_location(&location_lineno);
1667 if (!NIL_P(location_path)) {
1668 return rb_fstring(rb_sprintf("("EVAL_LOCATION_MARK"%"PRIsVALUE":%d)",
1669 location_path, location_lineno));
1670 }
1671
1672 if (!eval_default_path) {
1673 eval_default_path = rb_fstring_lit("(eval)");
1674 rb_vm_register_global_object(eval_default_path);
1675 }
1676 return eval_default_path;
1677}
1678
1679static inline int
1680compute_isolated_depth_from_ep(const VALUE *ep)
1681{
1682 int depth = 1;
1683 while (1) {
1684 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ISOLATED)) return depth;
1685 if (VM_ENV_LOCAL_P(ep)) return 0;
1686 ep = VM_ENV_PREV_EP(ep);
1687 depth++;
1688 }
1689}
1690
1691static inline int
1692compute_isolated_depth_from_block(const struct rb_block *blk)
1693{
1694 return compute_isolated_depth_from_ep(vm_block_ep(blk));
1695}
1696
1697static const rb_iseq_t *
1698pm_eval_make_iseq(VALUE src, VALUE fname, int line,
1699 const struct rb_block *base_block)
1700{
1701 const rb_iseq_t *const parent = vm_block_iseq(base_block);
1702 const rb_iseq_t *iseq = parent;
1703 VALUE name = rb_fstring_lit("<compiled>");
1704
1705 int coverage_enabled = ((rb_get_coverage_mode() & COVERAGE_TARGET_EVAL) != 0) ? 1 : 0;
1706 int isolated_depth = compute_isolated_depth_from_block(base_block);
1707
1708 if (!fname) {
1709 fname = rb_source_location(&line);
1710 }
1711
1712 if (!UNDEF_P(fname)) {
1713 if (!NIL_P(fname)) fname = rb_fstring(fname);
1714 }
1715 else {
1716 fname = get_eval_default_path();
1717 coverage_enabled = 0;
1718 }
1719
1720 pm_parse_result_t result;
1721 pm_parse_result_init(&result);
1722 pm_options_line_set(result.options, line);
1723 result.node.coverage_enabled = coverage_enabled;
1724
1725 // Count scopes, one for each parent iseq, plus one for our local scope
1726 int scopes_count = 0;
1727 do {
1728 scopes_count++;
1729 } while ((iseq = ISEQ_BODY(iseq)->parent_iseq));
1730 pm_options_scopes_init(result.options, scopes_count + 1);
1731
1732 // Walk over the scope tree, adding known locals at the correct depths. The
1733 // scope array should be deepest -> shallowest. so lower indexes in the
1734 // scopes array refer to root nodes on the tree, and higher indexes are the
1735 // leaf nodes.
1736 iseq = parent;
1737 rb_encoding *encoding = rb_enc_get(src);
1738
1739#define FORWARDING_POSITIONALS_CHR '*'
1740#define FORWARDING_POSITIONALS_STR "*"
1741#define FORWARDING_KEYWORDS_CHR ':'
1742#define FORWARDING_KEYWORDS_STR ":"
1743#define FORWARDING_BLOCK_CHR '&'
1744#define FORWARDING_BLOCK_STR "&"
1745#define FORWARDING_ALL_CHR '.'
1746#define FORWARDING_ALL_STR "."
1747
1748 for (int scopes_index = 0; scopes_index < scopes_count; scopes_index++) {
1749 VALUE iseq_value = (VALUE)iseq;
1750 int locals_count = ISEQ_BODY(iseq)->local_table_size;
1751
1752 pm_options_scope_t *options_scope = pm_options_scope_mut(result.options, scopes_count - scopes_index - 1);
1753 pm_options_scope_init(options_scope, locals_count);
1754
1755 uint8_t forwarding = PM_OPTIONS_SCOPE_FORWARDING_NONE;
1756
1757 for (int local_index = 0; local_index < locals_count; local_index++) {
1758 pm_string_t *scope_local = pm_options_scope_local_mut(options_scope, local_index);
1759 ID local = ISEQ_BODY(iseq)->local_table[local_index];
1760
1761 if (rb_is_local_id(local)) {
1762 VALUE name_obj = rb_id2str(local);
1763 const char *name = RSTRING_PTR(name_obj);
1764 size_t length = RSTRING_LEN(name_obj);
1765
1766 // Explicitly skip numbered parameters. These should not be sent
1767 // into the eval.
1768 if (length == 2 && name[0] == '_' && name[1] >= '1' && name[1] <= '9') {
1769 continue;
1770 }
1771
1772 // Check here if this local can be represented validly in the
1773 // encoding of the source string. If it _cannot_, then it should
1774 // not be added to the constant pool as it would not be able to
1775 // be referenced anyway.
1776 if (rb_enc_str_coderange_scan(name_obj, encoding) == ENC_CODERANGE_BROKEN) {
1777 continue;
1778 }
1779
1780 /* We need to duplicate the string because the Ruby string may
1781 * be embedded so compaction could move the string and the pointer
1782 * will change. */
1783 char *name_dup = xmalloc(length);
1784 MEMCPY(name_dup, name, char, length);
1785
1786 RB_GC_GUARD(name_obj);
1787
1788 pm_string_owned_init(scope_local, (uint8_t *) name_dup, length);
1789 }
1790 else if (local == idMULT) {
1792 pm_string_constant_init(scope_local, FORWARDING_POSITIONALS_STR, 1);
1793 }
1794 else if (local == idPow) {
1796 pm_string_constant_init(scope_local, FORWARDING_KEYWORDS_STR, 1);
1797 }
1798 else if (local == idAnd) {
1800 pm_string_constant_init(scope_local, FORWARDING_BLOCK_STR, 1);
1801 }
1802 else if (local == idDot3) {
1803 forwarding |= PM_OPTIONS_SCOPE_FORWARDING_ALL;
1804 pm_string_constant_init(scope_local, FORWARDING_ALL_STR, 1);
1805 }
1806 }
1807
1808 pm_options_scope_forwarding_set(options_scope, forwarding);
1809 iseq = ISEQ_BODY(iseq)->parent_iseq;
1810
1811 /* We need to GC guard the iseq because the code above malloc memory
1812 * which could trigger a GC. Since we only use ISEQ_BODY, the compiler
1813 * may optimize out the iseq local variable so we need to GC guard it. */
1814 RB_GC_GUARD(iseq_value);
1815 }
1816
1817 // Add our empty local scope at the very end of the array for our eval
1818 // scope's locals.
1819 pm_options_scope_init(pm_options_scope_mut(result.options, scopes_count), 0);
1820
1821 VALUE script_lines;
1822 VALUE error = pm_parse_string(&result, src, fname, ruby_vm_keep_script_lines ? &script_lines : NULL);
1823
1824 // If the parse failed, clean up and raise.
1825 if (error != Qnil) {
1826 pm_parse_result_free(&result);
1827 rb_exc_raise(error);
1828 }
1829
1830 // Create one scope node for each scope passed in, initialize the local
1831 // lookup table with all the local variable information attached to the
1832 // scope used by the parser.
1833 pm_scope_node_t *node = &result.node;
1834 iseq = parent;
1835
1836 for (int scopes_index = 0; scopes_index < scopes_count; scopes_index++) {
1837 pm_scope_node_t *parent_scope = ruby_xcalloc(1, sizeof(pm_scope_node_t));
1838 RUBY_ASSERT(parent_scope != NULL);
1839
1840 const pm_options_scope_t *options_scope = pm_options_scope(result.options, scopes_count - scopes_index - 1);
1841 parent_scope->coverage_enabled = coverage_enabled;
1842 parent_scope->parser = result.parser;
1843 int locals_count = ISEQ_BODY(iseq)->local_table_size;
1844 pm_index_lookup_table_init_heap(&parent_scope->index_lookup_table, (int) pm_parser_constants_size(result.parser));
1845 parent_scope->local_table_for_iseq_size = locals_count;
1846 pm_constant_id_list_init(&parent_scope->locals);
1847
1848 for (int local_index = 0; local_index < locals_count; local_index++) {
1849 const pm_string_t *scope_local = pm_options_scope_local(options_scope, local_index);
1850 pm_constant_id_t constant_id = 0;
1851
1852 const uint8_t *source = pm_string_source(scope_local);
1853 size_t length = pm_string_length(scope_local);
1854
1855 if (length > 0) {
1856 if (length == 1) {
1857 switch (*source) {
1858 case FORWARDING_POSITIONALS_CHR:
1859 constant_id = PM_CONSTANT_MULT;
1860 break;
1861 case FORWARDING_KEYWORDS_CHR:
1862 constant_id = PM_CONSTANT_POW;
1863 break;
1864 case FORWARDING_BLOCK_CHR:
1865 constant_id = PM_CONSTANT_AND;
1866 break;
1867 case FORWARDING_ALL_CHR:
1868 constant_id = PM_CONSTANT_DOT3;
1869 break;
1870 default:
1871 constant_id = pm_parser_constant_find(result.parser, source, length);
1872 break;
1873 }
1874 }
1875 else {
1876 constant_id = pm_parser_constant_find(result.parser, source, length);
1877 }
1878
1879 pm_index_lookup_table_insert(&parent_scope->index_lookup_table, constant_id, local_index);
1880 }
1881
1882 pm_constant_id_list_append(result.arena, &parent_scope->locals, constant_id);
1883 }
1884
1885 node->previous = parent_scope;
1886 node = parent_scope;
1887 iseq = ISEQ_BODY(iseq)->parent_iseq;
1888 }
1889
1890#undef FORWARDING_POSITIONALS_CHR
1891#undef FORWARDING_POSITIONALS_STR
1892#undef FORWARDING_KEYWORDS_CHR
1893#undef FORWARDING_KEYWORDS_STR
1894#undef FORWARDING_BLOCK_CHR
1895#undef FORWARDING_BLOCK_STR
1896#undef FORWARDING_ALL_CHR
1897#undef FORWARDING_ALL_STR
1898
1899 int error_state;
1900 iseq = pm_iseq_new_eval(&result.node, name, fname, Qnil, line, parent, isolated_depth, &error_state);
1901
1902 pm_scope_node_t *prev = result.node.previous;
1903 while (prev) {
1904 pm_scope_node_t *next = prev->previous;
1905 pm_scope_node_destroy(prev);
1906 SIZED_FREE(prev);
1907 prev = next;
1908 }
1909
1910 pm_parse_result_free(&result);
1911
1912 // If there was an error, raise it after memory has been cleaned up
1913 if (error_state) {
1914 RUBY_ASSERT(iseq == NULL);
1915 rb_jump_tag(error_state);
1916 }
1917
1918 rb_exec_event_hook_script_compiled(GET_EC(), iseq, src);
1919
1920 return iseq;
1921}
1922
1923static const rb_iseq_t *
1924eval_make_iseq(VALUE src, VALUE fname, int line,
1925 const struct rb_block *base_block)
1926{
1927 if (rb_ruby_prism_p()) {
1928 return pm_eval_make_iseq(src, fname, line, base_block);
1929 }
1930 const VALUE parser = rb_parser_new();
1931 const rb_iseq_t *const parent = vm_block_iseq(base_block);
1932 rb_iseq_t *iseq = NULL;
1933 VALUE ast_value;
1934 rb_ast_t *ast;
1935
1936 int coverage_enabled = (rb_get_coverage_mode() & COVERAGE_TARGET_EVAL) != 0;
1937 int isolated_depth = compute_isolated_depth_from_block(base_block);
1938
1939 if (!fname) {
1940 fname = rb_source_location(&line);
1941 }
1942
1943 if (!UNDEF_P(fname)) {
1944 if (!NIL_P(fname)) fname = rb_fstring(fname);
1945 }
1946 else {
1947 fname = get_eval_default_path();
1948 coverage_enabled = FALSE;
1949 }
1950
1951 rb_parser_set_context(parser, parent, FALSE);
1952 if (ruby_vm_keep_script_lines) rb_parser_set_script_lines(parser);
1953 ast_value = rb_parser_compile_string_path(parser, fname, src, line);
1954
1955 ast = rb_ruby_ast_data_get(ast_value);
1956
1957 if (ast->body.root) {
1958 ast->body.coverage_enabled = coverage_enabled;
1959 iseq = rb_iseq_new_eval(ast_value,
1960 ISEQ_BODY(parent)->location.label,
1961 fname, Qnil, line,
1962 parent, isolated_depth);
1963 }
1964 rb_ast_dispose(ast);
1965
1966 if (iseq != NULL) {
1967 if (0 && iseq) { /* for debug */
1968 VALUE disasm = rb_iseq_disasm(iseq);
1969 printf("%s\n", StringValuePtr(disasm));
1970 }
1971
1972 rb_exec_event_hook_script_compiled(GET_EC(), iseq, src);
1973 }
1974
1975 return iseq;
1976}
1977
1978static VALUE
1979eval_string_with_cref(VALUE self, VALUE src, rb_cref_t *cref, VALUE file, int line)
1980{
1981 rb_execution_context_t *ec = GET_EC();
1982 struct rb_block block;
1983 const rb_iseq_t *iseq;
1984 rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1985 if (!cfp) {
1986 rb_raise(rb_eRuntimeError, "Can't eval on top of Fiber or Thread");
1987 }
1988
1989 block.as.captured = *VM_CFP_TO_CAPTURED_BLOCK(cfp);
1990 block.as.captured.self = self;
1991 block.as.captured.code.iseq = CFP_ISEQ(cfp);
1992 block.type = block_type_iseq;
1993
1994 // EP is not escaped to the heap here, but captured and reused by another frame.
1995 // ZJIT's locals are incompatible with it unlike YJIT's, so invalidate the ISEQ for ZJIT.
1996 rb_zjit_invalidate_no_ep_escape(CFP_ISEQ(cfp));
1997
1998 iseq = eval_make_iseq(src, file, line, &block);
1999 if (!iseq) {
2000 rb_exc_raise(ec->errinfo);
2001 }
2002
2003 /* TODO: what the code checking? */
2004 if (!cref && block.as.captured.code.val) {
2005 rb_cref_t *orig_cref = vm_get_cref(vm_block_ep(&block));
2006 cref = vm_cref_dup(orig_cref);
2007 }
2008 vm_set_eval_stack(ec, iseq, cref, &block);
2009
2010 /* kick */
2011 return vm_exec(ec);
2012}
2013
2014static VALUE
2015eval_string_with_scope(VALUE scope, VALUE src, VALUE file, int line)
2016{
2017 rb_execution_context_t *ec = GET_EC();
2018 rb_binding_t *bind = Check_TypedStruct(scope, &ruby_binding_data_type);
2019 const rb_iseq_t *iseq = eval_make_iseq(src, file, line, &bind->block);
2020 if (!iseq) {
2021 rb_exc_raise(ec->errinfo);
2022 }
2023
2024 vm_set_eval_stack(ec, iseq, NULL, &bind->block);
2025
2026 /* save new env */
2027 if (ISEQ_BODY(iseq)->local_table_size > 0) {
2028 vm_bind_update_env(scope, bind, vm_make_env_object(ec, ec->cfp));
2029 }
2030
2031 /* kick */
2032 return vm_exec(ec);
2033}
2034
2035/*
2036 * call-seq:
2037 * eval(string, binding = nil, filename = default_filename, lineno = 1) -> obj
2038 *
2039 * Evaluates the Ruby expression(s) in +string+. Returns the result of the last
2040 * expression.
2041 *
2042 * str = "Hello"
2043 * eval("str + ' World'") # => "Hello World"
2044 *
2045 * If +binding+ is given, which must be a Binding object, the
2046 * evaluation is performed in its context. Otherwise, the
2047 * evaluation is performed in the context of the caller.
2048 *
2049 * def get_binding(str) = binding
2050 * str = "Hello"
2051 * eval("str + ' World'", get_binding("Bye")) # => "Bye World"
2052 *
2053 * If the optional +filename+ is given, it will be used as the
2054 * filename of the evaluation (for <tt>__FILE__</tt> and errors).
2055 * Otherwise, it will default to <tt>(eval at __FILE__:__LINE__)</tt>
2056 * where <tt>__FILE__</tt> and <tt>__LINE__</tt> are the filename and
2057 * line number of the caller, respectively.
2058 *
2059 * eval("puts __FILE__") # => "(eval at test.rb:1)"
2060 * eval("puts __FILE__", nil, "foobar.rb") # => "foobar.rb"
2061 *
2062 * If the optional +lineno+ is given, it will be used as the
2063 * line number of the evaluation (for <tt>__LINE__</tt> and errors).
2064 * Otherwise, it will default to 1.
2065 *
2066 * eval("puts __LINE__") # => 1
2067 * eval("puts __LINE__", nil, "foobar.rb", 10) # => 10
2068 */
2069
2070VALUE
2071rb_f_eval(int argc, const VALUE *argv, VALUE self)
2072{
2073 VALUE src, scope, vfile, vline;
2074 VALUE file = Qundef;
2075 int line = 1;
2076
2077 rb_scan_args(argc, argv, "13", &src, &scope, &vfile, &vline);
2078 StringValue(src);
2079 if (argc >= 3) {
2080 StringValue(vfile);
2081 }
2082 if (argc >= 4) {
2083 line = NUM2INT(vline);
2084 }
2085
2086 if (!NIL_P(vfile))
2087 file = vfile;
2088
2089 if (NIL_P(scope))
2090 return eval_string_with_cref(self, src, NULL, file, line);
2091 else
2092 return eval_string_with_scope(scope, src, file, line);
2093}
2094
2096VALUE
2097ruby_eval_string_from_file(const char *str, const char *filename)
2098{
2099 VALUE file = filename ? rb_str_new_cstr(filename) : 0;
2100 rb_execution_context_t *ec = GET_EC();
2101 rb_control_frame_t *cfp = ec ? rb_vm_get_ruby_level_next_cfp(ec, ec->cfp) : NULL;
2102 VALUE self = cfp ? cfp->self : rb_vm_top_self();
2103 return eval_string_with_cref(self, rb_str_new2(str), NULL, file, 1);
2104}
2105
2106VALUE
2107rb_eval_string(const char *str)
2108{
2109 return ruby_eval_string_from_file(str, "eval");
2110}
2111
2112static VALUE
2113eval_string_protect(VALUE str)
2114{
2115 return rb_eval_string((char *)str);
2116}
2117
2118VALUE
2119rb_eval_string_protect(const char *str, int *pstate)
2120{
2121 return rb_protect(eval_string_protect, (VALUE)str, pstate);
2122}
2123
2125 VALUE top_self;
2126 VALUE klass;
2127 const char *str;
2128};
2129
2130static VALUE
2131eval_string_wrap_protect(VALUE data)
2132{
2133 const struct eval_string_wrap_arg *const arg = (struct eval_string_wrap_arg*)data;
2134 rb_cref_t *cref = rb_vm_cref_new_toplevel();
2135 cref->klass_or_self = arg->klass;
2136 return eval_string_with_cref(arg->top_self, rb_str_new_cstr(arg->str), cref, rb_str_new_cstr("eval"), 1);
2137}
2138
2139VALUE
2140rb_eval_string_wrap(const char *str, int *pstate)
2141{
2142 int state;
2143 rb_thread_t *th = GET_THREAD();
2144 VALUE self = th->top_self;
2145 VALUE wrapper = th->top_wrapper;
2146 VALUE val;
2147 struct eval_string_wrap_arg data;
2148
2149 th->top_wrapper = rb_module_new();
2150 th->top_self = rb_obj_clone(rb_vm_top_self());
2151 rb_extend_object(th->top_self, th->top_wrapper);
2152
2153 data.top_self = th->top_self;
2154 data.klass = th->top_wrapper;
2155 data.str = str;
2156
2157 val = rb_protect(eval_string_wrap_protect, (VALUE)&data, &state);
2158
2159 th->top_self = self;
2160 th->top_wrapper = wrapper;
2161
2162 if (pstate) {
2163 *pstate = state;
2164 }
2165 else if (state != TAG_NONE) {
2166 EC_JUMP_TAG(th->ec, state);
2167 }
2168 return val;
2169}
2170
2171VALUE
2172rb_eval_cmd_kw(VALUE cmd, VALUE arg, int kw_splat)
2173{
2174 Check_Type(arg, T_ARRAY);
2175 int argc = RARRAY_LENINT(arg);
2176 const VALUE *argv = RARRAY_CONST_PTR(arg);
2177 VALUE val = rb_eval_cmd_call_kw(cmd, argc, argv, kw_splat);
2178 RB_GC_GUARD(arg);
2179 return val;
2180}
2181
2182VALUE
2183rb_eval_cmd_call_kw(VALUE cmd, int argc, const VALUE *argv, int kw_splat)
2184{
2185 enum ruby_tag_type state;
2186 volatile VALUE val = Qnil; /* OK */
2187 rb_execution_context_t * volatile ec = GET_EC();
2188
2189 EC_PUSH_TAG(ec);
2190 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2191 if (!RB_TYPE_P(cmd, T_STRING)) {
2192 val = rb_funcallv_kw(cmd, idCall, argc, argv, kw_splat);
2193 }
2194 else {
2195 val = eval_string_with_cref(rb_vm_top_self(), cmd, NULL, 0, 0);
2196 }
2197 }
2198 EC_POP_TAG();
2199
2200 if (state) EC_JUMP_TAG(ec, state);
2201 return val;
2202}
2203
2204/* block eval under the class/module context */
2205
2206static VALUE
2207yield_under(VALUE self, int singleton, int argc, const VALUE *argv, int kw_splat)
2208{
2209 rb_execution_context_t *ec = GET_EC();
2210 rb_control_frame_t *cfp = ec->cfp;
2211 VALUE block_handler = VM_CF_BLOCK_HANDLER(cfp);
2212 VALUE new_block_handler = 0;
2213 const struct rb_captured_block *captured = NULL;
2214 struct rb_captured_block new_captured;
2215 const VALUE *ep = NULL;
2216 rb_cref_t *cref;
2217 int is_lambda = FALSE;
2218
2219 if (block_handler != VM_BLOCK_HANDLER_NONE) {
2220 again:
2221 switch (vm_block_handler_type(block_handler)) {
2222 case block_handler_type_iseq:
2223 captured = VM_BH_TO_CAPT_BLOCK(block_handler);
2224 new_captured = *captured;
2225 new_block_handler = VM_BH_FROM_ISEQ_BLOCK(&new_captured);
2226 break;
2227 case block_handler_type_ifunc:
2228 captured = VM_BH_TO_CAPT_BLOCK(block_handler);
2229 new_captured = *captured;
2230 new_block_handler = VM_BH_FROM_IFUNC_BLOCK(&new_captured);
2231 break;
2232 case block_handler_type_proc:
2233 is_lambda = rb_proc_lambda_p(block_handler) != Qfalse;
2234 block_handler = vm_proc_to_block_handler(VM_BH_TO_PROC(block_handler));
2235 goto again;
2236 case block_handler_type_symbol:
2237 return rb_sym_proc_call(SYM2ID(VM_BH_TO_SYMBOL(block_handler)),
2238 argc, argv, kw_splat,
2239 VM_BLOCK_HANDLER_NONE);
2240 }
2241
2242 new_captured.self = self;
2243 ep = captured->ep;
2244
2245 VM_FORCE_WRITE_SPECIAL_CONST(&VM_CF_LEP(ec->cfp)[VM_ENV_DATA_INDEX_SPECVAL], new_block_handler);
2246 }
2247
2248 VM_ASSERT(singleton || RB_TYPE_P(self, T_MODULE) || RB_TYPE_P(self, T_CLASS));
2249 cref = vm_cref_push(ec, self, ep, TRUE, singleton);
2250
2251 return vm_yield_with_cref(ec, argc, argv, kw_splat, cref, is_lambda);
2252}
2253
2254VALUE
2255rb_yield_refine_block(VALUE refinement, VALUE refinements)
2256{
2257 rb_execution_context_t *ec = GET_EC();
2258 VALUE block_handler = VM_CF_BLOCK_HANDLER(ec->cfp);
2259
2260 if (vm_block_handler_type(block_handler) != block_handler_type_iseq) {
2261 rb_bug("rb_yield_refine_block: an iseq block is required");
2262 }
2263 else {
2264 const struct rb_captured_block *captured = VM_BH_TO_ISEQ_BLOCK(block_handler);
2265 struct rb_captured_block new_captured = *captured;
2266 const VALUE *const argv = &new_captured.self; /* dummy to suppress nonnull warning from gcc */
2267 VALUE new_block_handler = VM_BH_FROM_ISEQ_BLOCK(&new_captured);
2268 const VALUE *ep = captured->ep;
2269 rb_cref_t *cref = vm_cref_push(ec, refinement, ep, TRUE, FALSE);
2270 CREF_REFINEMENTS_SET(cref, refinements);
2271 VM_FORCE_WRITE_SPECIAL_CONST(&VM_CF_LEP(ec->cfp)[VM_ENV_DATA_INDEX_SPECVAL], new_block_handler);
2272 new_captured.self = refinement;
2273 return vm_yield_with_cref(ec, 0, argv, RB_NO_KEYWORDS, cref, FALSE);
2274 }
2275}
2276
2277/* string eval under the class/module context */
2278static VALUE
2279eval_under(VALUE self, int singleton, VALUE src, VALUE file, int line)
2280{
2281 rb_cref_t *cref = vm_cref_push(GET_EC(), self, NULL, FALSE, singleton);
2282 StringValue(src);
2283
2284 return eval_string_with_cref(self, src, cref, file, line);
2285}
2286
2287static VALUE
2288specific_eval(int argc, const VALUE *argv, VALUE self, int singleton, int kw_splat)
2289{
2290 if (rb_block_given_p()) {
2291 rb_check_arity(argc, 0, 0);
2292 return yield_under(self, singleton, 1, &self, kw_splat);
2293 }
2294 else {
2295 VALUE file = Qnil;
2296 int line = 1;
2297 VALUE code;
2298
2299 rb_check_arity(argc, 1, 3);
2300 code = argv[0];
2301 StringValue(code);
2302 if (argc > 2)
2303 line = NUM2INT(argv[2]);
2304 if (argc > 1) {
2305 file = argv[1];
2306 if (!NIL_P(file)) StringValue(file);
2307 }
2308
2309 if (NIL_P(file)) {
2310 file = get_eval_default_path();
2311 }
2312
2313 return eval_under(self, singleton, code, file, line);
2314 }
2315}
2316
2317/*
2318 * call-seq:
2319 * obj.instance_eval(string [, filename [, lineno]] ) -> obj
2320 * obj.instance_eval {|obj| block } -> obj
2321 *
2322 * Evaluates a string containing Ruby source code, or the given block,
2323 * within the context of the receiver (_obj_). In order to set the
2324 * context, the variable +self+ is set to _obj_ while
2325 * the code is executing, giving the code access to _obj_'s
2326 * instance variables and private methods.
2327 *
2328 * When <code>instance_eval</code> is given a block, _obj_ is also
2329 * passed in as the block's only argument.
2330 *
2331 * When <code>instance_eval</code> is given a +String+, the optional
2332 * second and third parameters supply a filename and starting line number
2333 * that are used when reporting compilation errors.
2334 *
2335 * class KlassWithSecret
2336 * def initialize
2337 * @secret = 99
2338 * end
2339 * private
2340 * def the_secret
2341 * "Ssssh! The secret is #{@secret}."
2342 * end
2343 * end
2344 * k = KlassWithSecret.new
2345 * k.instance_eval { @secret } #=> 99
2346 * k.instance_eval { the_secret } #=> "Ssssh! The secret is 99."
2347 * k.instance_eval {|obj| obj == self } #=> true
2348 */
2349
2350static VALUE
2351rb_obj_instance_eval_internal(int argc, const VALUE *argv, VALUE self)
2352{
2353 return specific_eval(argc, argv, self, TRUE, RB_PASS_CALLED_KEYWORDS);
2354}
2355
2356VALUE
2357rb_obj_instance_eval(int argc, const VALUE *argv, VALUE self)
2358{
2359 return specific_eval(argc, argv, self, TRUE, RB_NO_KEYWORDS);
2360}
2361
2362/*
2363 * call-seq:
2364 * obj.instance_exec(arg...) {|var...| block } -> obj
2365 *
2366 * Executes the given block within the context of the receiver
2367 * (_obj_). In order to set the context, the variable +self+ is set
2368 * to _obj_ while the code is executing, giving the code access to
2369 * _obj_'s instance variables. Arguments are passed as block parameters.
2370 *
2371 * class KlassWithSecret
2372 * def initialize
2373 * @secret = 99
2374 * end
2375 * end
2376 * k = KlassWithSecret.new
2377 * k.instance_exec(5) {|x| @secret+x } #=> 104
2378 */
2379
2380static VALUE
2381rb_obj_instance_exec_internal(int argc, const VALUE *argv, VALUE self)
2382{
2383 return yield_under(self, TRUE, argc, argv, RB_PASS_CALLED_KEYWORDS);
2384}
2385
2386VALUE
2387rb_obj_instance_exec(int argc, const VALUE *argv, VALUE self)
2388{
2389 return yield_under(self, TRUE, argc, argv, RB_NO_KEYWORDS);
2390}
2391
2392/*
2393 * call-seq:
2394 * mod.class_eval(string [, filename [, lineno]]) -> obj
2395 * mod.class_eval {|mod| block } -> obj
2396 * mod.module_eval(string [, filename [, lineno]]) -> obj
2397 * mod.module_eval {|mod| block } -> obj
2398 *
2399 * Evaluates the string or block in the context of _mod_, except that when
2400 * a block is given, constant/class variable lookup is not affected. This
2401 * can be used to add methods to a class. <code>module_eval</code> returns
2402 * the result of evaluating its argument. The optional _filename_ and
2403 * _lineno_ parameters set the text for error messages.
2404 *
2405 * class Thing
2406 * end
2407 * a = %q{def hello() "Hello there!" end}
2408 * Thing.module_eval(a)
2409 * puts Thing.new.hello()
2410 * Thing.module_eval("invalid code", "dummy", 123)
2411 *
2412 * <em>produces:</em>
2413 *
2414 * Hello there!
2415 * dummy:123:in `module_eval': undefined local variable
2416 * or method `code' for Thing:Class
2417 */
2418
2419static VALUE
2420rb_mod_module_eval_internal(int argc, const VALUE *argv, VALUE mod)
2421{
2422 return specific_eval(argc, argv, mod, FALSE, RB_PASS_CALLED_KEYWORDS);
2423}
2424
2425VALUE
2426rb_mod_module_eval(int argc, const VALUE *argv, VALUE mod)
2427{
2428 return specific_eval(argc, argv, mod, FALSE, RB_NO_KEYWORDS);
2429}
2430
2431/*
2432 * call-seq:
2433 * mod.module_exec(arg...) {|var...| block } -> obj
2434 * mod.class_exec(arg...) {|var...| block } -> obj
2435 *
2436 * Evaluates the given block in the context of the class/module.
2437 * The method defined in the block will belong to the receiver.
2438 * Any arguments passed to the method will be passed to the block.
2439 * This can be used if the block needs to access instance variables.
2440 *
2441 * class Thing
2442 * end
2443 * Thing.class_exec{
2444 * def hello() "Hello there!" end
2445 * }
2446 * puts Thing.new.hello()
2447 *
2448 * <em>produces:</em>
2449 *
2450 * Hello there!
2451 */
2452
2453static VALUE
2454rb_mod_module_exec_internal(int argc, const VALUE *argv, VALUE mod)
2455{
2456 return yield_under(mod, FALSE, argc, argv, RB_PASS_CALLED_KEYWORDS);
2457}
2458
2459VALUE
2460rb_mod_module_exec(int argc, const VALUE *argv, VALUE mod)
2461{
2462 return yield_under(mod, FALSE, argc, argv, RB_NO_KEYWORDS);
2463}
2464
2465/*
2466 * Document-class: UncaughtThrowError
2467 *
2468 * Raised when +throw+ is called with a _tag_ which does not have
2469 * corresponding +catch+ block.
2470 *
2471 * throw "foo", "bar"
2472 *
2473 * <em>raises the exception:</em>
2474 *
2475 * UncaughtThrowError: uncaught throw "foo"
2476 */
2477
2478static VALUE
2479uncaught_throw_init(int argc, const VALUE *argv, VALUE exc)
2480{
2482 rb_call_super(argc - 2, argv + 2);
2483 rb_ivar_set(exc, id_tag, argv[0]);
2484 rb_ivar_set(exc, id_value, argv[1]);
2485 return exc;
2486}
2487
2488/*
2489 * call-seq:
2490 * uncaught_throw.tag -> obj
2491 *
2492 * Return the tag object which was called for.
2493 */
2494
2495static VALUE
2496uncaught_throw_tag(VALUE exc)
2497{
2498 return rb_ivar_get(exc, id_tag);
2499}
2500
2501/*
2502 * call-seq:
2503 * uncaught_throw.value -> obj
2504 *
2505 * Return the return value which was called for.
2506 */
2507
2508static VALUE
2509uncaught_throw_value(VALUE exc)
2510{
2511 return rb_ivar_get(exc, id_value);
2512}
2513
2514/*
2515 * call-seq:
2516 * uncaught_throw.to_s -> string
2517 *
2518 * Returns formatted message with the inspected tag.
2519 */
2520
2521static VALUE
2522uncaught_throw_to_s(VALUE exc)
2523{
2524 VALUE mesg = rb_attr_get(exc, id_mesg);
2525 VALUE tag = uncaught_throw_tag(exc);
2526 return rb_str_format(1, &tag, mesg);
2527}
2528
2529/*
2530 * call-seq:
2531 * throw(tag [, obj])
2532 *
2533 * Transfers control to the end of the active +catch+ block
2534 * waiting for _tag_. Raises +UncaughtThrowError+ if there
2535 * is no +catch+ block for the _tag_. The optional second
2536 * parameter supplies a return value for the +catch+ block,
2537 * which otherwise defaults to +nil+. For examples, see
2538 * Kernel::catch.
2539 */
2540
2541static VALUE
2542rb_f_throw(int argc, VALUE *argv, VALUE _)
2543{
2544 VALUE tag, value;
2545
2546 rb_scan_args(argc, argv, "11", &tag, &value);
2547 rb_throw_obj(tag, value);
2549}
2550
2551void
2553{
2554 rb_execution_context_t *ec = GET_EC();
2555 struct rb_vm_tag *tt = ec->tag;
2556
2557 while (tt) {
2558 if (tt->tag == tag) {
2559 tt->retval = value;
2560 break;
2561 }
2562 tt = tt->prev;
2563 }
2564 if (!tt) {
2565 VALUE desc[3];
2566 desc[0] = tag;
2567 desc[1] = value;
2568 desc[2] = rb_str_new_cstr("uncaught throw %p");
2569 rb_exc_raise(rb_class_new_instance(numberof(desc), desc, rb_eUncaughtThrow));
2570 }
2571
2572 ec->errinfo = (VALUE)THROW_DATA_NEW(tag, NULL, TAG_THROW);
2573 EC_JUMP_TAG(ec, TAG_THROW);
2574}
2575
2576void
2577rb_throw(const char *tag, VALUE val)
2578{
2579 rb_throw_obj(rb_sym_intern_ascii_cstr(tag), val);
2580}
2581
2582static VALUE
2583catch_i(RB_BLOCK_CALL_FUNC_ARGLIST(tag, _))
2584{
2585 return rb_yield_0(1, &tag);
2586}
2587
2588/*
2589 * call-seq:
2590 * catch([tag]) {|tag| block } -> obj
2591 *
2592 * +catch+ executes its block. If +throw+ is not called, the block executes
2593 * normally, and +catch+ returns the value of the last expression evaluated.
2594 *
2595 * catch(1) { 123 } # => 123
2596 *
2597 * If <code>throw(tag2, val)</code> is called, Ruby searches up its stack for
2598 * a +catch+ block whose +tag+ has the same +object_id+ as _tag2_. When found,
2599 * the block stops executing and returns _val_ (or +nil+ if no second argument
2600 * was given to +throw+).
2601 *
2602 * catch(1) { throw(1, 456) } # => 456
2603 * catch(1) { throw(1) } # => nil
2604 *
2605 * When +tag+ is passed as the first argument, +catch+ yields it as the
2606 * parameter of the block.
2607 *
2608 * catch(1) {|x| x + 2 } # => 3
2609 *
2610 * When no +tag+ is given, +catch+ yields a new unique object (as from
2611 * +Object.new+) as the block parameter. This object can then be used as the
2612 * argument to +throw+, and will match the correct +catch+ block.
2613 *
2614 * catch do |obj_A|
2615 * catch do |obj_B|
2616 * throw(obj_B, 123)
2617 * puts "This puts is not reached"
2618 * end
2619 *
2620 * puts "This puts is displayed"
2621 * 456
2622 * end
2623 *
2624 * # => 456
2625 *
2626 * catch do |obj_A|
2627 * catch do |obj_B|
2628 * throw(obj_A, 123)
2629 * puts "This puts is still not reached"
2630 * end
2631 *
2632 * puts "Now this puts is also not reached"
2633 * 456
2634 * end
2635 *
2636 * # => 123
2637 */
2638
2639static VALUE
2640rb_f_catch(int argc, VALUE *argv, VALUE self)
2641{
2642 VALUE tag = rb_check_arity(argc, 0, 1) ? argv[0] : rb_obj_alloc(rb_cObject);
2643 return rb_catch_obj(tag, catch_i, 0);
2644}
2645
2646VALUE
2647rb_catch(const char *tag, rb_block_call_func_t func, VALUE data)
2648{
2649 VALUE vtag = tag ? rb_sym_intern_ascii_cstr(tag) : rb_obj_alloc(rb_cObject);
2650 return rb_catch_obj(vtag, func, data);
2651}
2652
2653static VALUE
2654vm_catch_protect(VALUE tag, rb_block_call_func *func, VALUE data,
2655 enum ruby_tag_type *stateptr, rb_execution_context_t *volatile ec)
2656{
2657 enum ruby_tag_type state;
2658 VALUE val = Qnil; /* OK */
2659 rb_control_frame_t *volatile saved_cfp = ec->cfp;
2660
2661 EC_PUSH_TAG(ec);
2662
2663 _tag.tag = tag;
2664
2665 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2666 /* call with argc=1, argv = [tag], block = Qnil to insure compatibility */
2667 val = (*func)(tag, data, 1, (const VALUE *)&tag, Qnil);
2668 }
2669 else if (state == TAG_THROW && THROW_DATA_VAL((struct vm_throw_data *)ec->errinfo) == tag) {
2670 rb_vm_rewind_cfp(ec, saved_cfp);
2671 val = ec->tag->retval;
2672 ec->errinfo = Qnil;
2673 state = 0;
2674 }
2675 EC_POP_TAG();
2676 if (stateptr)
2677 *stateptr = state;
2678
2679 return val;
2680}
2681
2682VALUE
2683rb_catch_protect(VALUE t, rb_block_call_func *func, VALUE data, enum ruby_tag_type *stateptr)
2684{
2685 return vm_catch_protect(t, func, data, stateptr, GET_EC());
2686}
2687
2688VALUE
2690{
2691 enum ruby_tag_type state;
2692 rb_execution_context_t *ec = GET_EC();
2693 VALUE val = vm_catch_protect(t, (rb_block_call_func *)func, data, &state, ec);
2694 if (state) EC_JUMP_TAG(ec, state);
2695 return val;
2696}
2697
2698static void
2699local_var_list_init(struct local_var_list *vars)
2700{
2701 vars->tbl = rb_ident_hash_new();
2702 RBASIC_CLEAR_CLASS(vars->tbl);
2703}
2704
2705static VALUE
2706local_var_list_finish(struct local_var_list *vars)
2707{
2708 /* TODO: not to depend on the order of st_table */
2709 VALUE ary = rb_hash_keys(vars->tbl);
2710 rb_hash_clear(vars->tbl);
2711 vars->tbl = 0;
2712 return ary;
2713}
2714
2715static int
2716local_var_list_update(st_data_t *key, st_data_t *value, st_data_t arg, int existing)
2717{
2718 if (existing) return ST_STOP;
2719 *value = (st_data_t)Qtrue; /* INT2FIX(arg) */
2720 return ST_CONTINUE;
2721}
2722
2723extern int rb_numparam_id_p(ID id);
2724
2725static void
2726local_var_list_add(const struct local_var_list *vars, ID lid)
2727{
2728 /* should skip temporary variable */
2729 if (!lid) return;
2730 if (!rb_is_local_id(lid)) return;
2731
2732 /* should skip numbered parameters as well */
2733 if (rb_numparam_id_p(lid)) return;
2734
2735 st_data_t idx = 0; /* tbl->num_entries */
2736 rb_hash_stlike_update(vars->tbl, ID2SYM(lid), local_var_list_update, idx);
2737}
2738
2739static void
2740numparam_list_add(const struct local_var_list *vars, ID lid)
2741{
2742 /* should skip temporary variable */
2743 if (!lid) return;
2744 if (!rb_is_local_id(lid)) return;
2745
2746 /* should skip anything but numbered parameters */
2747 if (rb_numparam_id_p(lid)) {
2748 st_data_t idx = 0; /* tbl->num_entries */
2749 rb_hash_stlike_update(vars->tbl, ID2SYM(lid), local_var_list_update, idx);
2750 }
2751}
2752
2753/*
2754 * call-seq:
2755 * local_variables -> array
2756 *
2757 * Returns the names of the current local variables.
2758 *
2759 * fred = 1
2760 * for i in 1..10
2761 * # ...
2762 * end
2763 * local_variables #=> [:fred, :i]
2764 */
2765
2766static VALUE
2767rb_f_local_variables(VALUE _)
2768{
2769 struct local_var_list vars;
2770 rb_execution_context_t *ec = GET_EC();
2771 rb_control_frame_t *cfp = vm_get_ruby_level_caller_cfp(ec, RUBY_VM_PREVIOUS_CONTROL_FRAME(ec->cfp));
2772 unsigned int i;
2773
2774 local_var_list_init(&vars);
2775 while (cfp) {
2776 if (CFP_ISEQ(cfp)) {
2777 for (i = 0; i < ISEQ_BODY(CFP_ISEQ(cfp))->local_table_size; i++) {
2778 local_var_list_add(&vars, ISEQ_BODY(CFP_ISEQ(cfp))->local_table[i]);
2779 }
2780 }
2781 if (!VM_ENV_LOCAL_P(cfp->ep)) {
2782 /* block */
2783 const VALUE *ep = VM_CF_PREV_EP(cfp);
2784
2785 if (vm_collect_local_variables_in_heap(ep, &vars)) {
2786 break;
2787 }
2788 else {
2789 while (cfp->ep != ep) {
2790 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2791 }
2792 }
2793 }
2794 else {
2795 break;
2796 }
2797 }
2798 return local_var_list_finish(&vars);
2799}
2800
2801/*
2802 * call-seq:
2803 * block_given? -> true or false
2804 *
2805 * Returns <code>true</code> if <code>yield</code> would execute a
2806 * block in the current context. The <code>iterator?</code> form
2807 * is mildly deprecated.
2808 *
2809 * def try
2810 * if block_given?
2811 * yield
2812 * else
2813 * "no block"
2814 * end
2815 * end
2816 * try #=> "no block"
2817 * try { "hello" } #=> "hello"
2818 * try do "hello" end #=> "hello"
2819 */
2820
2821static VALUE
2822rb_f_block_given_p(VALUE _)
2823{
2824 rb_execution_context_t *ec = GET_EC();
2825 rb_control_frame_t *cfp = ec->cfp;
2826 cfp = vm_get_ruby_level_caller_cfp(ec, RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp));
2827
2828 return RBOOL(cfp != NULL && VM_CF_BLOCK_HANDLER(cfp) != VM_BLOCK_HANDLER_NONE);
2829}
2830
2831/*
2832 * call-seq:
2833 * iterator? -> true or false
2834 *
2835 * Deprecated. Use block_given? instead.
2836 */
2837
2838static VALUE
2839rb_f_iterator_p(VALUE self)
2840{
2841 rb_warn_deprecated("iterator?", "block_given?");
2842 return rb_f_block_given_p(self);
2843}
2844
2845VALUE
2846rb_current_realfilepath(void)
2847{
2848 const rb_execution_context_t *ec = GET_EC();
2849 rb_control_frame_t *cfp = ec->cfp;
2850 cfp = vm_get_ruby_level_caller_cfp(ec, RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp));
2851 if (cfp != NULL) {
2852 const rb_iseq_t *iseq = CFP_ISEQ(cfp);
2853 VALUE path = rb_iseq_realpath(iseq);
2854 if (RTEST(path)) return path;
2855 // eval context
2856 path = rb_iseq_path(iseq);
2857 if (path == eval_default_path) {
2858 return Qnil;
2859 }
2860
2861 // [Feature #19755] implicit eval location is "(eval at #{__FILE__}:#{__LINE__})"
2862 const long len = RSTRING_LEN(path);
2863 if (len > EVAL_LOCATION_MARK_LEN+1) {
2864 const char *const ptr = RSTRING_PTR(path);
2865 if (ptr[len - 1] == ')' &&
2866 memcmp(ptr, "("EVAL_LOCATION_MARK, EVAL_LOCATION_MARK_LEN+1) == 0) {
2867 return Qnil;
2868 }
2869 }
2870
2871 return path;
2872 }
2873 return Qnil;
2874}
2875
2876// Assert that an internal function is running and return
2877// the imemo object that represents it.
2878struct vm_ifunc *
2879rb_current_ifunc(void)
2880{
2881 // Search VM_FRAME_MAGIC_IFUNC to see ifunc imemos put on the iseq field.
2882 VALUE ifunc = (VALUE)CFP_ISEQ(GET_EC()->cfp);
2883 RUBY_ASSERT_ALWAYS(imemo_type_p(ifunc, imemo_ifunc));
2884 return (struct vm_ifunc *)ifunc;
2885}
2886
2887void
2888Init_vm_eval(void)
2889{
2890 rb_define_global_function("eval", rb_f_eval, -1);
2891 rb_define_global_function("local_variables", rb_f_local_variables, 0);
2892 rb_define_global_function("iterator?", rb_f_iterator_p, 0);
2893 rb_define_global_function("block_given?", rb_f_block_given_p, 0);
2894
2895 rb_define_global_function("catch", rb_f_catch, -1);
2896 rb_define_global_function("throw", rb_f_throw, -1);
2897
2898 rb_define_method(rb_cBasicObject, "instance_eval", rb_obj_instance_eval_internal, -1);
2899 rb_define_method(rb_cBasicObject, "instance_exec", rb_obj_instance_exec_internal, -1);
2900 rb_define_private_method(rb_cBasicObject, "method_missing", rb_method_missing, -1);
2901
2902#if 1
2903 rb_add_method(rb_cBasicObject, id__send__,
2904 VM_METHOD_TYPE_OPTIMIZED, (void *)OPTIMIZED_METHOD_TYPE_SEND, METHOD_VISI_PUBLIC);
2905 rb_add_method(rb_mKernel, idSend,
2906 VM_METHOD_TYPE_OPTIMIZED, (void *)OPTIMIZED_METHOD_TYPE_SEND, METHOD_VISI_PUBLIC);
2907#else
2908 rb_define_method(rb_cBasicObject, "__send__", rb_f_send, -1);
2909 rb_define_method(rb_mKernel, "send", rb_f_send, -1);
2910#endif
2911 rb_define_method(rb_mKernel, "public_send", rb_f_public_send, -1);
2912
2913 rb_define_method(rb_cModule, "module_exec", rb_mod_module_exec_internal, -1);
2914 rb_define_method(rb_cModule, "class_exec", rb_mod_module_exec_internal, -1);
2915 rb_define_method(rb_cModule, "module_eval", rb_mod_module_eval_internal, -1);
2916 rb_define_method(rb_cModule, "class_eval", rb_mod_module_eval_internal, -1);
2917
2918 rb_eUncaughtThrow = rb_define_class("UncaughtThrowError", rb_eArgError);
2919 rb_define_method(rb_eUncaughtThrow, "initialize", uncaught_throw_init, -1);
2920 rb_define_method(rb_eUncaughtThrow, "tag", uncaught_throw_tag, 0);
2921 rb_define_method(rb_eUncaughtThrow, "value", uncaught_throw_value, 0);
2922 rb_define_method(rb_eUncaughtThrow, "to_s", uncaught_throw_to_s, 0);
2923
2924 id_result = rb_intern_const("result");
2925 id_tag = rb_intern_const("tag");
2926 id_value = rb_intern_const("value");
2927}
#define RUBY_ASSERT_ALWAYS(expr,...)
A variant of RUBY_ASSERT that does not interface with RUBY_DEBUG.
Definition assert.h:199
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
uint32_t pm_constant_id_t
A constant id is a unique identifier for a constant in the constant pool.
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_private_method(klass, mid, func, arity)
Defines klass#mid and makes it private.
#define rb_define_global_function(mid, func, arity)
Defines rb_mKernel #mid.
#define RUBY_EVENT_C_CALL
A method, written in C, is called.
Definition event.h:43
#define RUBY_EVENT_C_RETURN
Return from a method, written in C.
Definition event.h:44
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
Definition class.c:1523
void rb_extend_object(VALUE obj, VALUE module)
Extend the object with the module.
Definition eval.c:1868
VALUE rb_module_new(void)
Creates a new, anonymous module.
Definition class.c:1617
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:3180
int rb_keyword_given_p(void)
Determines if the current method is given a keyword argument.
Definition eval.c:1031
int rb_block_given_p(void)
Determines if the current method is given a block.
Definition eval.c:1018
#define rb_str_new2
Old name of rb_str_new_cstr.
Definition string.h:1676
#define T_COMPLEX
Old name of RUBY_T_COMPLEX.
Definition value_type.h:59
#define T_FILE
Old name of RUBY_T_FILE.
Definition value_type.h:62
#define T_STRING
Old name of RUBY_T_STRING.
Definition value_type.h:78
#define T_MASK
Old name of RUBY_T_MASK.
Definition value_type.h:68
#define Qundef
Old name of RUBY_Qundef.
#define T_NIL
Old name of RUBY_T_NIL.
Definition value_type.h:72
#define T_FLOAT
Old name of RUBY_T_FLOAT.
Definition value_type.h:64
#define T_IMEMO
Old name of RUBY_T_IMEMO.
Definition value_type.h:67
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
Definition value_type.h:57
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define T_STRUCT
Old name of RUBY_T_STRUCT.
Definition value_type.h:79
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
Definition fl_type.h:131
#define T_FIXNUM
Old name of RUBY_T_FIXNUM.
Definition value_type.h:63
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
Definition assume.h:29
#define SYM2ID
Old name of RB_SYM2ID.
Definition symbol.h:45
#define T_DATA
Old name of RUBY_T_DATA.
Definition value_type.h:60
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:205
#define T_NONE
Old name of RUBY_T_NONE.
Definition value_type.h:74
#define T_NODE
Old name of RUBY_T_NODE.
Definition value_type.h:73
#define rb_ary_new4
Old name of rb_ary_new_from_values.
Definition array.h:659
#define xmalloc
Old name of ruby_xmalloc.
Definition xmalloc.h:53
#define T_MODULE
Old name of RUBY_T_MODULE.
Definition value_type.h:70
#define T_TRUE
Old name of RUBY_T_TRUE.
Definition value_type.h:81
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
Definition value_type.h:76
#define T_ICLASS
Old name of RUBY_T_ICLASS.
Definition value_type.h:66
#define T_HASH
Old name of RUBY_T_HASH.
Definition value_type.h:65
#define T_FALSE
Old name of RUBY_T_FALSE.
Definition value_type.h:61
#define T_UNDEF
Old name of RUBY_T_UNDEF.
Definition value_type.h:82
#define Qtrue
Old name of RUBY_Qtrue.
#define NUM2INT
Old name of RB_NUM2INT.
Definition int.h:44
#define T_ZOMBIE
Old name of RUBY_T_ZOMBIE.
Definition value_type.h:83
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define ENC_CODERANGE_BROKEN
Old name of RUBY_ENC_CODERANGE_BROKEN.
Definition coderange.h:182
#define T_ARRAY
Old name of RUBY_T_ARRAY.
Definition value_type.h:56
#define T_OBJECT
Old name of RUBY_T_OBJECT.
Definition value_type.h:75
#define NIL_P
Old name of RB_NIL_P.
#define ALLOCV_N
Old name of RB_ALLOCV_N.
Definition memory.h:405
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
Definition value_type.h:80
#define T_MATCH
Old name of RUBY_T_MATCH.
Definition value_type.h:69
#define T_CLASS
Old name of RUBY_T_CLASS.
Definition value_type.h:58
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition value_type.h:85
#define T_MOVED
Old name of RUBY_T_MOVED.
Definition value_type.h:71
#define Check_TypedStruct(v, t)
Old name of rb_check_typeddata.
Definition rtypeddata.h:109
#define ALLOCV_END
Old name of RB_ALLOCV_END.
Definition memory.h:406
#define SYMBOL_P
Old name of RB_SYMBOL_P.
Definition value_type.h:88
#define T_REGEXP
Old name of RUBY_T_REGEXP.
Definition value_type.h:77
VALUE rb_eNotImpError
NotImplementedError exception.
Definition error.c:1437
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
Definition eval.c:661
VALUE rb_eNameError
NameError exception.
Definition error.c:1432
VALUE rb_eNoMethodError
NoMethodError exception.
Definition error.c:1435
VALUE rb_eRuntimeError
RuntimeError exception.
Definition error.c:1425
VALUE rb_mKernel
Kernel module.
Definition object.c:60
VALUE rb_cObject
Object class.
Definition object.c:61
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
Definition object.c:2247
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
Definition object.c:2288
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:229
VALUE rb_cBasicObject
BasicObject class.
Definition object.c:59
VALUE rb_cModule
Module class.
Definition object.c:62
VALUE rb_obj_clone(VALUE obj)
Produces a shallow copy of the given object.
Definition object.c:492
VALUE rb_obj_is_kind_of(VALUE obj, VALUE klass)
Queries if the given object is an instance (of possibly descendants) of the given class.
Definition object.c:888
VALUE rb_eval_string_wrap(const char *str, int *state)
Identical to rb_eval_string_protect(), except it evaluates the given string under a module binding in...
Definition vm_eval.c:2140
VALUE rb_funcall_passing_block(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv_public(), except you can pass the passed block.
Definition vm_eval.c:1183
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
Definition vm_eval.c:1120
VALUE rb_funcallv_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
Identical to rb_funcallv(), except you can specify how to handle the last element of the given array.
Definition vm_eval.c:1087
VALUE rb_funcall_with_block(VALUE recv, ID mid, int argc, const VALUE *argv, VALUE procval)
Identical to rb_funcallv_public(), except you can pass a block.
Definition vm_eval.c:1197
VALUE rb_eval_string_protect(const char *str, int *state)
Identical to rb_eval_string(), except it avoids potential global escapes.
Definition vm_eval.c:2119
VALUE rb_call_super_kw(int argc, const VALUE *argv, int kw_splat)
Identical to rb_call_super(), except you can specify how to handle the last element of the given arra...
Definition vm_eval.c:354
VALUE rb_funcallv_public(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv(), except it only takes public methods into account.
Definition vm_eval.c:1171
VALUE rb_current_receiver(void)
This resembles ruby's self.
Definition vm_eval.c:368
VALUE rb_funcall_passing_block_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
Identical to rb_funcallv_passing_block(), except you can specify how to handle the last element of th...
Definition vm_eval.c:1190
VALUE rb_funcall_with_block_kw(VALUE recv, ID mid, int argc, const VALUE *argv, VALUE procval, int kw_splat)
Identical to rb_funcallv_with_block(), except you can specify how to handle the last element of the g...
Definition vm_eval.c:1207
VALUE rb_eval_string(const char *str)
Evaluates the given string.
Definition vm_eval.c:2107
VALUE rb_call_super(int argc, const VALUE *argv)
This resembles ruby's super.
Definition vm_eval.c:362
VALUE rb_funcallv_public_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
Identical to rb_funcallv_public(), except you can specify how to handle the last element of the given...
Definition vm_eval.c:1177
VALUE rb_ary_cat(VALUE ary, const VALUE *train, long len)
Destructively appends multiple elements at the end of the array.
VALUE rb_check_array_type(VALUE obj)
Try converting an object to its array representation using its to_ary method, if any.
VALUE rb_ary_pop(VALUE ary)
Destructively deletes an element from the end of the passed array and returns what was deleted.
VALUE rb_ary_hidden_new(long capa)
Allocates a hidden (no class) empty array.
VALUE rb_ary_subseq(VALUE ary, long beg, long len)
Obtains a part of the passed array.
#define UNLIMITED_ARGUMENTS
This macro is used in conjunction with rb_check_arity().
Definition error.h:35
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
Definition error.h:284
int rb_is_local_id(ID id)
Classifies the given ID, then sees if it is a local variable.
Definition symbol.c:1140
VALUE rb_proc_lambda_p(VALUE recv)
Queries if the given object is a lambda.
Definition proc.c:247
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
Definition string.h:1515
VALUE rb_str_intern(VALUE str)
Identical to rb_to_symbol(), except it assumes the receiver being an instance of RString.
Definition symbol.c:968
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
Definition variable.c:2034
VALUE rb_ivar_get(VALUE obj, ID name)
Identical to rb_iv_get(), except it accepts the name as an ID instead of a C string.
Definition variable.c:1502
VALUE rb_check_funcall(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv(), except it returns RUBY_Qundef instead of raising rb_eNoMethodError.
Definition vm_eval.c:689
VALUE rb_check_funcall_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
Identical to rb_check_funcall(), except you can specify how to handle the last element of the given a...
Definition vm_eval.c:683
VALUE rb_mod_module_eval(int argc, const VALUE *argv, VALUE mod)
Identical to rb_obj_instance_eval(), except it evaluates within the context of module.
Definition vm_eval.c:2426
VALUE rb_mod_module_exec(int argc, const VALUE *argv, VALUE mod)
Identical to rb_obj_instance_exec(), except it evaluates within the context of module.
Definition vm_eval.c:2460
VALUE rb_obj_instance_exec(int argc, const VALUE *argv, VALUE recv)
Executes the given block within the context of the receiver.
Definition vm_eval.c:2387
VALUE rb_eval_cmd_kw(VALUE cmd, VALUE arg, int kw_splat)
This API is practically a variant of rb_proc_call_kw() now.
Definition vm_eval.c:2172
VALUE rb_apply(VALUE recv, ID mid, VALUE args)
Identical to rb_funcallv(), except it takes Ruby's array instead of C's.
Definition vm_eval.c:1095
VALUE rb_obj_instance_eval(int argc, const VALUE *argv, VALUE recv)
Evaluates a string containing Ruby source code, or the given block, within the context of the receive...
Definition vm_eval.c:2357
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
Definition symbol.h:285
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
Definition symbol.c:1164
int len
Length of the buffer.
Definition io.h:8
VALUE rb_str_format(int argc, const VALUE *argv, VALUE fmt)
Formats a string.
Definition sprintf.c:215
#define RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg)
Shim for block function parameters.
Definition iterator.h:58
VALUE rb_each(VALUE obj)
This is a shorthand of calling obj.each.
Definition vm_eval.c:1652
VALUE rb_yield_values(int n,...)
Identical to rb_yield(), except it takes variadic number of parameters and pass them to the block.
Definition vm_eval.c:1398
VALUE rb_yield_splat(VALUE ary)
Identical to rb_yield_values(), except it splats an array to generate the list of parameters.
Definition vm_eval.c:1432
void rb_throw(const char *tag, VALUE val)
Transfers control to the end of the active catch block waiting for tag.
Definition vm_eval.c:2577
VALUE rb_yield_values2(int n, const VALUE *argv)
Identical to rb_yield_values(), except it takes the parameters as a C array instead of variadic argum...
Definition vm_eval.c:1420
VALUE rb_yield(VALUE val)
Yields the block.
Definition vm_eval.c:1375
VALUE rb_yield_values_kw(int n, const VALUE *argv, int kw_splat)
Identical to rb_yield_values2(), except you can specify how to handle the last element of the given a...
Definition vm_eval.c:1426
rb_block_call_func * rb_block_call_func_t
Shorthand type that represents an iterator-written-in-C function pointer.
Definition iterator.h:88
VALUE rb_yield_block(RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg))
Pass a passed block.
void rb_throw_obj(VALUE tag, VALUE val)
Identical to rb_throw(), except it allows arbitrary Ruby object to become a tag.
Definition vm_eval.c:2552
VALUE rb_block_call_func(RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg))
This is the type of a function that the interpreter expect for C-backended blocks.
Definition iterator.h:83
VALUE rb_block_call_kw(VALUE obj, ID mid, int argc, const VALUE *argv, rb_block_call_func_t proc, VALUE data2, int kw_splat)
Identical to rb_funcallv_kw(), except it additionally passes a function as a block.
Definition vm_eval.c:1566
VALUE rb_yield_splat_kw(VALUE ary, int kw_splat)
Identical to rb_yield_splat(), except you can specify how to handle the last element of the given arr...
Definition vm_eval.c:1445
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
Definition memory.h:372
#define ALLOCA_N(type, n)
Definition memory.h:292
#define MEMZERO(p, type, n)
Handy macro to erase a region of memory.
Definition memory.h:360
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
VALUE rb_catch_obj(VALUE q, type *w, VALUE e)
An equivalent of Kernel#catch.
VALUE rb_catch(const char *q, type *w, VALUE e)
An equivalent of Kernel#catch.
VALUE rb_block_call(VALUE q, ID w, int e, const VALUE *r, type *t, VALUE y)
Call a method with a block.
VALUE type(ANYARGS)
ANYARGS-ed function type.
VALUE rb_rescue2(type *q, VALUE w, type *e, VALUE r,...)
An equivalent of rescue clause.
static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_NONE
The default value for parameters.
Definition options.h:45
static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_ALL
When the scope is forwarding with the ... parameter.
Definition options.h:57
static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_POSITIONALS
When the scope is forwarding with the * parameter.
Definition options.h:48
static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_KEYWORDS
When the scope is forwarding with the ** parameter.
Definition options.h:51
static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_BLOCK
When the scope is forwarding with the & parameter.
Definition options.h:54
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
Definition rarray.h:281
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
Definition rarray.h:52
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
Definition rbasic.h:166
#define RBASIC(obj)
Convenient casting macro.
Definition rbasic.h:40
#define RCLASS_SUPER
Just another name of rb_class_get_superclass.
Definition rclass.h:44
#define RHASH_EMPTY_P(h)
Checks if the hash is empty.
Definition rhash.h:79
#define StringValue(v)
Ensures that the parameter object is a String.
Definition rstring.h:66
#define StringValuePtr(v)
Identical to StringValue, except it returns a char*.
Definition rstring.h:76
#define RB_PASS_CALLED_KEYWORDS
Pass keywords if current method is called with keywords, useful for argument delegation.
Definition scan_args.h:78
#define RB_NO_KEYWORDS
Do not pass keywords.
Definition scan_args.h:69
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
Definition stdarg.h:35
pm_parser_t * parser
The parser that will do the actual parsing.
pm_scope_node_t node
The resulting scope node that will hold the generated AST.
pm_options_t * options
The options that will be passed to the parser.
pm_arena_t * arena
The arena allocator for AST-lifetime memory.
pm_index_lookup_table_t index_lookup_table
A flat lookup table mapping constant IDs (or special IDs) to local variable indices.
A generic string type that can have various ownership semantics.
Definition stringy.h:18
Internal header for Ruby Box.
Definition box.h:14
Definition method.h:63
CREF (Class REFerence)
Definition method.h:45
IFUNC (Internal FUNCtion)
Definition imemo.h:84
THROW_DATA.
Definition imemo.h:58
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
Definition value_type.h:433
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376
ruby_value_type
C-level type of an object.
Definition value_type.h:113