Ruby 3.4.3p32 (2025-04-14 revision d0b7e5b6a04bde21ca483d20a1546b28b401c2d4)
iseq.c
1/**********************************************************************
2
3 iseq.c -
4
5 $Author$
6 created at: 2006-07-11(Tue) 09:00:03 +0900
7
8 Copyright (C) 2006 Koichi Sasada
9
10**********************************************************************/
11
12#define RUBY_VM_INSNS_INFO 1
13/* #define RUBY_MARK_FREE_DEBUG 1 */
14
15#include "ruby/internal/config.h"
16
17#ifdef HAVE_DLADDR
18# include <dlfcn.h>
19#endif
20
21#include "eval_intern.h"
22#include "id_table.h"
23#include "internal.h"
24#include "internal/bits.h"
25#include "internal/class.h"
26#include "internal/compile.h"
27#include "internal/error.h"
28#include "internal/file.h"
29#include "internal/gc.h"
30#include "internal/hash.h"
31#include "internal/io.h"
32#include "internal/ruby_parser.h"
33#include "internal/sanitizers.h"
34#include "internal/symbol.h"
35#include "internal/thread.h"
36#include "internal/variable.h"
37#include "iseq.h"
38#include "rjit.h"
39#include "ruby/util.h"
40#include "vm_core.h"
41#include "vm_callinfo.h"
42#include "yjit.h"
43#include "ruby/ractor.h"
44#include "builtin.h"
45#include "insns.inc"
46#include "insns_info.inc"
47
48VALUE rb_cISeq;
49static VALUE iseqw_new(const rb_iseq_t *iseq);
50static const rb_iseq_t *iseqw_check(VALUE iseqw);
51
52#if VM_INSN_INFO_TABLE_IMPL == 2
53static struct succ_index_table *succ_index_table_create(int max_pos, int *data, int size);
54static unsigned int *succ_index_table_invert(int max_pos, struct succ_index_table *sd, int size);
55static int succ_index_lookup(const struct succ_index_table *sd, int x);
56#endif
57
58#define hidden_obj_p(obj) (!SPECIAL_CONST_P(obj) && !RBASIC(obj)->klass)
59
60static inline VALUE
61obj_resurrect(VALUE obj)
62{
63 if (hidden_obj_p(obj)) {
64 switch (BUILTIN_TYPE(obj)) {
65 case T_STRING:
66 obj = rb_str_resurrect(obj);
67 break;
68 case T_ARRAY:
69 obj = rb_ary_resurrect(obj);
70 break;
71 case T_HASH:
72 obj = rb_hash_resurrect(obj);
73 break;
74 default:
75 break;
76 }
77 }
78 return obj;
79}
80
81static void
82free_arena(struct iseq_compile_data_storage *cur)
83{
84 struct iseq_compile_data_storage *next;
85
86 while (cur) {
87 next = cur->next;
88 ruby_xfree(cur);
89 cur = next;
90 }
91}
92
93static void
94compile_data_free(struct iseq_compile_data *compile_data)
95{
96 if (compile_data) {
97 free_arena(compile_data->node.storage_head);
98 free_arena(compile_data->insn.storage_head);
99 if (compile_data->ivar_cache_table) {
100 rb_id_table_free(compile_data->ivar_cache_table);
101 }
102 ruby_xfree(compile_data);
103 }
104}
105
106static void
107remove_from_constant_cache(ID id, IC ic)
108{
109 rb_vm_t *vm = GET_VM();
110 VALUE lookup_result;
111 st_data_t ic_data = (st_data_t)ic;
112
113 if (rb_id_table_lookup(vm->constant_cache, id, &lookup_result)) {
114 st_table *ics = (st_table *)lookup_result;
115 st_delete(ics, &ic_data, NULL);
116
117 if (ics->num_entries == 0 &&
118 // See comment in vm_track_constant_cache on why we need this check
119 id != vm->inserting_constant_cache_id) {
120 rb_id_table_delete(vm->constant_cache, id);
121 st_free_table(ics);
122 }
123 }
124}
125
126// When an ISEQ is being freed, all of its associated ICs are going to go away
127// as well. Because of this, we need to iterate over the ICs, and clear them
128// from the VM's constant cache.
129static void
130iseq_clear_ic_references(const rb_iseq_t *iseq)
131{
132 // In some cases (when there is a compilation error), we end up with
133 // ic_size greater than 0, but no allocated is_entries buffer.
134 // If there's no is_entries buffer to loop through, return early.
135 // [Bug #19173]
136 if (!ISEQ_BODY(iseq)->is_entries) {
137 return;
138 }
139
140 for (unsigned int ic_idx = 0; ic_idx < ISEQ_BODY(iseq)->ic_size; ic_idx++) {
141 IC ic = &ISEQ_IS_IC_ENTRY(ISEQ_BODY(iseq), ic_idx);
142
143 // Iterate over the IC's constant path's segments and clean any references to
144 // the ICs out of the VM's constant cache table.
145 const ID *segments = ic->segments;
146
147 // It's possible that segments is NULL if we overallocated an IC but
148 // optimizations removed the instruction using it
149 if (segments == NULL)
150 continue;
151
152 for (int i = 0; segments[i]; i++) {
153 ID id = segments[i];
154 if (id == idNULL) continue;
155 remove_from_constant_cache(id, ic);
156 }
157
158 ruby_xfree((void *)segments);
159 }
160}
161
162void
163rb_iseq_free(const rb_iseq_t *iseq)
164{
165 RUBY_FREE_ENTER("iseq");
166
167 if (iseq && ISEQ_BODY(iseq)) {
168 iseq_clear_ic_references(iseq);
169 struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
170 rb_rjit_free_iseq(iseq); /* Notify RJIT */
171#if USE_YJIT
172 rb_yjit_iseq_free(iseq);
173 if (FL_TEST_RAW((VALUE)iseq, ISEQ_TRANSLATED)) {
174 RUBY_ASSERT(rb_yjit_live_iseq_count > 0);
175 rb_yjit_live_iseq_count--;
176 }
177#endif
178 ruby_xfree((void *)body->iseq_encoded);
179 ruby_xfree((void *)body->insns_info.body);
180 ruby_xfree((void *)body->insns_info.positions);
181#if VM_INSN_INFO_TABLE_IMPL == 2
182 ruby_xfree(body->insns_info.succ_index_table);
183#endif
184 ruby_xfree((void *)body->is_entries);
185 ruby_xfree(body->call_data);
186 ruby_xfree((void *)body->catch_table);
187 ruby_xfree((void *)body->param.opt_table);
188 if (ISEQ_MBITS_BUFLEN(body->iseq_size) > 1 && body->mark_bits.list) {
189 ruby_xfree((void *)body->mark_bits.list);
190 }
191
192 ruby_xfree(body->variable.original_iseq);
193
194 if (body->param.keyword != NULL) {
195 if (body->param.keyword->table != &body->local_table[body->param.keyword->bits_start - body->param.keyword->num])
196 ruby_xfree((void *)body->param.keyword->table);
197 if (body->param.keyword->default_values) {
198 ruby_xfree((void *)body->param.keyword->default_values);
199 }
200 ruby_xfree((void *)body->param.keyword);
201 }
202 if (LIKELY(body->local_table != rb_iseq_shared_exc_local_tbl))
203 ruby_xfree((void *)body->local_table);
204 compile_data_free(ISEQ_COMPILE_DATA(iseq));
205 if (body->outer_variables) rb_id_table_free(body->outer_variables);
206 ruby_xfree(body);
207 }
208
209 if (iseq && ISEQ_EXECUTABLE_P(iseq) && iseq->aux.exec.local_hooks) {
210 rb_hook_list_free(iseq->aux.exec.local_hooks);
211 }
212
213 RUBY_FREE_LEAVE("iseq");
214}
215
216typedef VALUE iseq_value_itr_t(void *ctx, VALUE obj);
217
218static inline void
219iseq_scan_bits(unsigned int page, iseq_bits_t bits, VALUE *code, VALUE *original_iseq)
220{
221 unsigned int offset;
222 unsigned int page_offset = (page * ISEQ_MBITS_BITLENGTH);
223
224 while (bits) {
225 offset = ntz_intptr(bits);
226 VALUE op = code[page_offset + offset];
227 rb_gc_mark_and_move(&code[page_offset + offset]);
228 VALUE newop = code[page_offset + offset];
229 if (original_iseq && newop != op) {
230 original_iseq[page_offset + offset] = newop;
231 }
232 bits &= bits - 1; // Reset Lowest Set Bit (BLSR)
233 }
234}
235
236static void
237rb_iseq_mark_and_move_each_value(const rb_iseq_t *iseq, VALUE *original_iseq)
238{
239 unsigned int size;
240 VALUE *code;
241 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
242
243 size = body->iseq_size;
244 code = body->iseq_encoded;
245
246 union iseq_inline_storage_entry *is_entries = body->is_entries;
247
248 if (body->is_entries) {
249 // Skip iterating over ivc caches
250 is_entries += body->ivc_size;
251
252 // ICVARC entries
253 for (unsigned int i = 0; i < body->icvarc_size; i++, is_entries++) {
254 ICVARC icvarc = (ICVARC)is_entries;
255 if (icvarc->entry) {
256 RUBY_ASSERT(!RB_TYPE_P(icvarc->entry->class_value, T_NONE));
257
258 rb_gc_mark_and_move(&icvarc->entry->class_value);
259 }
260 }
261
262 // ISE entries
263 for (unsigned int i = 0; i < body->ise_size; i++, is_entries++) {
264 union iseq_inline_storage_entry *const is = (union iseq_inline_storage_entry *)is_entries;
265 if (is->once.value) {
266 rb_gc_mark_and_move(&is->once.value);
267 }
268 }
269
270 // IC Entries
271 for (unsigned int i = 0; i < body->ic_size; i++, is_entries++) {
272 IC ic = (IC)is_entries;
273 if (ic->entry) {
274 rb_gc_mark_and_move_ptr(&ic->entry);
275 }
276 }
277 }
278
279 // Embedded VALUEs
280 if (body->mark_bits.list) {
281 if (ISEQ_MBITS_BUFLEN(size) == 1) {
282 iseq_scan_bits(0, body->mark_bits.single, code, original_iseq);
283 }
284 else {
285 if (body->mark_bits.list) {
286 for (unsigned int i = 0; i < ISEQ_MBITS_BUFLEN(size); i++) {
287 iseq_bits_t bits = body->mark_bits.list[i];
288 iseq_scan_bits(i, bits, code, original_iseq);
289 }
290 }
291 }
292 }
293}
294
295static bool
296cc_is_active(const struct rb_callcache *cc, bool reference_updating)
297{
298 if (cc) {
299 if (cc == rb_vm_empty_cc() || rb_vm_empty_cc_for_super()) {
300 return false;
301 }
302
303 if (reference_updating) {
304 cc = (const struct rb_callcache *)rb_gc_location((VALUE)cc);
305 }
306
307 if (vm_cc_markable(cc)) {
308 if (cc->klass) { // cc is not invalidated
309 const struct rb_callable_method_entry_struct *cme = vm_cc_cme(cc);
310 if (reference_updating) {
311 cme = (const struct rb_callable_method_entry_struct *)rb_gc_location((VALUE)cme);
312 }
313 if (!METHOD_ENTRY_INVALIDATED(cme)) {
314 return true;
315 }
316 }
317 }
318 }
319 return false;
320}
321
322void
323rb_iseq_mark_and_move(rb_iseq_t *iseq, bool reference_updating)
324{
325 RUBY_MARK_ENTER("iseq");
326
327 rb_gc_mark_and_move(&iseq->wrapper);
328
329 if (ISEQ_BODY(iseq)) {
330 struct rb_iseq_constant_body *body = ISEQ_BODY(iseq);
331
332 rb_iseq_mark_and_move_each_value(iseq, reference_updating ? ISEQ_ORIGINAL_ISEQ(iseq) : NULL);
333
334 rb_gc_mark_and_move(&body->variable.coverage);
335 rb_gc_mark_and_move(&body->variable.pc2branchindex);
336 rb_gc_mark_and_move(&body->variable.script_lines);
337 rb_gc_mark_and_move(&body->location.label);
338 rb_gc_mark_and_move(&body->location.base_label);
339 rb_gc_mark_and_move(&body->location.pathobj);
340 if (body->local_iseq) rb_gc_mark_and_move_ptr(&body->local_iseq);
341 if (body->parent_iseq) rb_gc_mark_and_move_ptr(&body->parent_iseq);
342 if (body->mandatory_only_iseq) rb_gc_mark_and_move_ptr(&body->mandatory_only_iseq);
343
344 if (body->call_data) {
345 for (unsigned int i = 0; i < body->ci_size; i++) {
346 struct rb_call_data *cds = body->call_data;
347
348 if (cds[i].ci) rb_gc_mark_and_move_ptr(&cds[i].ci);
349
350 if (cc_is_active(cds[i].cc, reference_updating)) {
351 rb_gc_mark_and_move_ptr(&cds[i].cc);
352 }
353 else if (cds[i].cc != rb_vm_empty_cc()) {
354 cds[i].cc = rb_vm_empty_cc();
355 }
356 }
357 }
358
359 if (body->param.flags.has_kw && body->param.keyword != NULL) {
360 const struct rb_iseq_param_keyword *const keyword = body->param.keyword;
361
362 if (keyword->default_values != NULL) {
363 for (int j = 0, i = keyword->required_num; i < keyword->num; i++, j++) {
364 rb_gc_mark_and_move(&keyword->default_values[j]);
365 }
366 }
367 }
368
369 if (body->catch_table) {
370 struct iseq_catch_table *table = body->catch_table;
371
372 for (unsigned int i = 0; i < table->size; i++) {
373 struct iseq_catch_table_entry *entry;
374 entry = UNALIGNED_MEMBER_PTR(table, entries[i]);
375 if (entry->iseq) {
376 rb_gc_mark_and_move_ptr(&entry->iseq);
377 }
378 }
379 }
380
381 if (reference_updating) {
382#if USE_RJIT
383 rb_rjit_iseq_update_references(body);
384#endif
385#if USE_YJIT
386 rb_yjit_iseq_update_references(iseq);
387#endif
388 }
389 else {
390#if USE_RJIT
391 rb_rjit_iseq_mark(body->rjit_blocks);
392#endif
393#if USE_YJIT
394 rb_yjit_iseq_mark(body->yjit_payload);
395#endif
396 }
397 }
398
399 if (FL_TEST_RAW((VALUE)iseq, ISEQ_NOT_LOADED_YET)) {
400 rb_gc_mark_and_move(&iseq->aux.loader.obj);
401 }
402 else if (FL_TEST_RAW((VALUE)iseq, ISEQ_USE_COMPILE_DATA)) {
403 const struct iseq_compile_data *const compile_data = ISEQ_COMPILE_DATA(iseq);
404
405 if (!reference_updating) {
406 /* The operands in each instruction needs to be pinned because
407 * if auto-compaction runs in iseq_set_sequence, then the objects
408 * could exist on the generated_iseq buffer, which would not be
409 * reference updated which can lead to T_MOVED (and subsequently
410 * T_NONE) objects on the iseq. */
411 rb_iseq_mark_and_pin_insn_storage(compile_data->insn.storage_head);
412 }
413
414 rb_gc_mark_and_move((VALUE *)&compile_data->err_info);
415 rb_gc_mark_and_move((VALUE *)&compile_data->catch_table_ary);
416 }
417 else {
418 /* executable */
419 VM_ASSERT(ISEQ_EXECUTABLE_P(iseq));
420
421 if (iseq->aux.exec.local_hooks) {
422 rb_hook_list_mark_and_update(iseq->aux.exec.local_hooks);
423 }
424 }
425
426 RUBY_MARK_LEAVE("iseq");
427}
428
429static size_t
430param_keyword_size(const struct rb_iseq_param_keyword *pkw)
431{
432 size_t size = 0;
433
434 if (!pkw) return size;
435
436 size += sizeof(struct rb_iseq_param_keyword);
437 size += sizeof(VALUE) * (pkw->num - pkw->required_num);
438
439 return size;
440}
441
442size_t
443rb_iseq_memsize(const rb_iseq_t *iseq)
444{
445 size_t size = 0; /* struct already counted as RVALUE size */
446 const struct rb_iseq_constant_body *body = ISEQ_BODY(iseq);
447 const struct iseq_compile_data *compile_data;
448
449 /* TODO: should we count original_iseq? */
450
451 if (ISEQ_EXECUTABLE_P(iseq) && body) {
452 size += sizeof(struct rb_iseq_constant_body);
453 size += body->iseq_size * sizeof(VALUE);
454 size += body->insns_info.size * (sizeof(struct iseq_insn_info_entry) + sizeof(unsigned int));
455 size += body->local_table_size * sizeof(ID);
456 size += ISEQ_MBITS_BUFLEN(body->iseq_size) * ISEQ_MBITS_SIZE;
457 if (body->catch_table) {
458 size += iseq_catch_table_bytes(body->catch_table->size);
459 }
460 size += (body->param.opt_num + 1) * sizeof(VALUE);
461 size += param_keyword_size(body->param.keyword);
462
463 /* body->is_entries */
464 size += ISEQ_IS_SIZE(body) * sizeof(union iseq_inline_storage_entry);
465
466 if (ISEQ_BODY(iseq)->is_entries) {
467 /* IC entries constant segments */
468 for (unsigned int ic_idx = 0; ic_idx < body->ic_size; ic_idx++) {
469 IC ic = &ISEQ_IS_IC_ENTRY(body, ic_idx);
470 const ID *ids = ic->segments;
471 if (!ids) continue;
472 while (*ids++) {
473 size += sizeof(ID);
474 }
475 size += sizeof(ID); // null terminator
476 }
477 }
478
479 /* body->call_data */
480 size += body->ci_size * sizeof(struct rb_call_data);
481 // TODO: should we count imemo_callinfo?
482 }
483
484 compile_data = ISEQ_COMPILE_DATA(iseq);
485 if (compile_data) {
486 struct iseq_compile_data_storage *cur;
487
488 size += sizeof(struct iseq_compile_data);
489
490 cur = compile_data->node.storage_head;
491 while (cur) {
492 size += cur->size + offsetof(struct iseq_compile_data_storage, buff);
493 cur = cur->next;
494 }
495 }
496
497 return size;
498}
499
501rb_iseq_constant_body_alloc(void)
502{
503 struct rb_iseq_constant_body *iseq_body;
504 iseq_body = ZALLOC(struct rb_iseq_constant_body);
505 return iseq_body;
506}
507
508static rb_iseq_t *
509iseq_alloc(void)
510{
511 rb_iseq_t *iseq = iseq_imemo_alloc();
512 ISEQ_BODY(iseq) = rb_iseq_constant_body_alloc();
513 return iseq;
514}
515
516VALUE
517rb_iseq_pathobj_new(VALUE path, VALUE realpath)
518{
519 VALUE pathobj;
520 VM_ASSERT(RB_TYPE_P(path, T_STRING));
521 VM_ASSERT(NIL_P(realpath) || RB_TYPE_P(realpath, T_STRING));
522
523 if (path == realpath ||
524 (!NIL_P(realpath) && rb_str_cmp(path, realpath) == 0)) {
525 pathobj = rb_fstring(path);
526 }
527 else {
528 if (!NIL_P(realpath)) realpath = rb_fstring(realpath);
529 pathobj = rb_ary_new_from_args(2, rb_fstring(path), realpath);
530 rb_ary_freeze(pathobj);
531 }
532 return pathobj;
533}
534
535void
536rb_iseq_pathobj_set(const rb_iseq_t *iseq, VALUE path, VALUE realpath)
537{
538 RB_OBJ_WRITE(iseq, &ISEQ_BODY(iseq)->location.pathobj,
539 rb_iseq_pathobj_new(path, realpath));
540}
541
542// Make a dummy iseq for a dummy frame that exposes a path for profilers to inspect
543rb_iseq_t *
544rb_iseq_alloc_with_dummy_path(VALUE fname)
545{
546 rb_iseq_t *dummy_iseq = iseq_alloc();
547
548 ISEQ_BODY(dummy_iseq)->type = ISEQ_TYPE_TOP;
549 RB_OBJ_WRITE(dummy_iseq, &ISEQ_BODY(dummy_iseq)->location.pathobj, fname);
550 RB_OBJ_WRITE(dummy_iseq, &ISEQ_BODY(dummy_iseq)->location.label, fname);
551
552 return dummy_iseq;
553}
554
555static rb_iseq_location_t *
556iseq_location_setup(rb_iseq_t *iseq, VALUE name, VALUE path, VALUE realpath, int first_lineno, const rb_code_location_t *code_location, const int node_id)
557{
558 rb_iseq_location_t *loc = &ISEQ_BODY(iseq)->location;
559
560 rb_iseq_pathobj_set(iseq, path, realpath);
561 RB_OBJ_WRITE(iseq, &loc->label, name);
562 RB_OBJ_WRITE(iseq, &loc->base_label, name);
563 loc->first_lineno = first_lineno;
564
565 if (ISEQ_BODY(iseq)->local_iseq == iseq && strcmp(RSTRING_PTR(name), "initialize") == 0) {
566 ISEQ_BODY(iseq)->param.flags.use_block = 1;
567 }
568
569 if (code_location) {
570 loc->node_id = node_id;
571 loc->code_location = *code_location;
572 }
573 else {
574 loc->code_location.beg_pos.lineno = 0;
575 loc->code_location.beg_pos.column = 0;
576 loc->code_location.end_pos.lineno = -1;
577 loc->code_location.end_pos.column = -1;
578 }
579
580 return loc;
581}
582
583static void
584set_relation(rb_iseq_t *iseq, const rb_iseq_t *piseq)
585{
586 struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
587 const VALUE type = body->type;
588
589 /* set class nest stack */
590 if (type == ISEQ_TYPE_TOP) {
591 body->local_iseq = iseq;
592 }
593 else if (type == ISEQ_TYPE_METHOD || type == ISEQ_TYPE_CLASS) {
594 body->local_iseq = iseq;
595 }
596 else if (piseq) {
597 body->local_iseq = ISEQ_BODY(piseq)->local_iseq;
598 }
599
600 if (piseq) {
601 body->parent_iseq = piseq;
602 }
603
604 if (type == ISEQ_TYPE_MAIN) {
605 body->local_iseq = iseq;
606 }
607}
608
609static struct iseq_compile_data_storage *
610new_arena(void)
611{
612 struct iseq_compile_data_storage * new_arena =
614 ALLOC_N(char, INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE +
615 offsetof(struct iseq_compile_data_storage, buff));
616
617 new_arena->pos = 0;
618 new_arena->next = 0;
619 new_arena->size = INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE;
620
621 return new_arena;
622}
623
624static VALUE
625prepare_iseq_build(rb_iseq_t *iseq,
626 VALUE name, VALUE path, VALUE realpath, int first_lineno, const rb_code_location_t *code_location, const int node_id,
627 const rb_iseq_t *parent, int isolated_depth, enum rb_iseq_type type,
628 VALUE script_lines, const rb_compile_option_t *option)
629{
630 VALUE coverage = Qfalse;
631 VALUE err_info = Qnil;
632 struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
633
634 if (parent && (type == ISEQ_TYPE_MAIN || type == ISEQ_TYPE_TOP))
635 err_info = Qfalse;
636
637 body->type = type;
638 set_relation(iseq, parent);
639
640 name = rb_fstring(name);
641 iseq_location_setup(iseq, name, path, realpath, first_lineno, code_location, node_id);
642 if (iseq != body->local_iseq) {
643 RB_OBJ_WRITE(iseq, &body->location.base_label, ISEQ_BODY(body->local_iseq)->location.label);
644 }
645 ISEQ_COVERAGE_SET(iseq, Qnil);
646 ISEQ_ORIGINAL_ISEQ_CLEAR(iseq);
647 body->variable.flip_count = 0;
648
649 if (NIL_P(script_lines)) {
650 RB_OBJ_WRITE(iseq, &body->variable.script_lines, Qnil);
651 }
652 else {
653 RB_OBJ_WRITE(iseq, &body->variable.script_lines, rb_ractor_make_shareable(script_lines));
654 }
655
656 ISEQ_COMPILE_DATA_ALLOC(iseq);
657 RB_OBJ_WRITE(iseq, &ISEQ_COMPILE_DATA(iseq)->err_info, err_info);
658 RB_OBJ_WRITE(iseq, &ISEQ_COMPILE_DATA(iseq)->catch_table_ary, Qnil);
659
660 ISEQ_COMPILE_DATA(iseq)->node.storage_head = ISEQ_COMPILE_DATA(iseq)->node.storage_current = new_arena();
661 ISEQ_COMPILE_DATA(iseq)->insn.storage_head = ISEQ_COMPILE_DATA(iseq)->insn.storage_current = new_arena();
662 ISEQ_COMPILE_DATA(iseq)->isolated_depth = isolated_depth;
663 ISEQ_COMPILE_DATA(iseq)->option = option;
664 ISEQ_COMPILE_DATA(iseq)->ivar_cache_table = NULL;
665 ISEQ_COMPILE_DATA(iseq)->builtin_function_table = GET_VM()->builtin_function_table;
666
667 if (option->coverage_enabled) {
668 VALUE coverages = rb_get_coverages();
669 if (RTEST(coverages)) {
670 coverage = rb_hash_lookup(coverages, rb_iseq_path(iseq));
671 if (NIL_P(coverage)) coverage = Qfalse;
672 }
673 }
674 ISEQ_COVERAGE_SET(iseq, coverage);
675 if (coverage && ISEQ_BRANCH_COVERAGE(iseq))
676 ISEQ_PC2BRANCHINDEX_SET(iseq, rb_ary_hidden_new(0));
677
678 return Qtrue;
679}
680
681#if VM_CHECK_MODE > 0 && VM_INSN_INFO_TABLE_IMPL > 0
682static void validate_get_insn_info(const rb_iseq_t *iseq);
683#endif
684
685void
686rb_iseq_insns_info_encode_positions(const rb_iseq_t *iseq)
687{
688#if VM_INSN_INFO_TABLE_IMPL == 2
689 /* create succ_index_table */
690 struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
691 int size = body->insns_info.size;
692 int max_pos = body->iseq_size;
693 int *data = (int *)body->insns_info.positions;
694 if (body->insns_info.succ_index_table) ruby_xfree(body->insns_info.succ_index_table);
695 body->insns_info.succ_index_table = succ_index_table_create(max_pos, data, size);
696#if VM_CHECK_MODE == 0
697 ruby_xfree(body->insns_info.positions);
698 body->insns_info.positions = NULL;
699#endif
700#endif
701}
702
703#if VM_INSN_INFO_TABLE_IMPL == 2
704unsigned int *
705rb_iseq_insns_info_decode_positions(const struct rb_iseq_constant_body *body)
706{
707 int size = body->insns_info.size;
708 int max_pos = body->iseq_size;
709 struct succ_index_table *sd = body->insns_info.succ_index_table;
710 return succ_index_table_invert(max_pos, sd, size);
711}
712#endif
713
714void
715rb_iseq_init_trace(rb_iseq_t *iseq)
716{
717 iseq->aux.exec.global_trace_events = 0;
718 if (ruby_vm_event_enabled_global_flags & ISEQ_TRACE_EVENTS) {
719 rb_iseq_trace_set(iseq, ruby_vm_event_enabled_global_flags & ISEQ_TRACE_EVENTS);
720 }
721}
722
723static VALUE
724finish_iseq_build(rb_iseq_t *iseq)
725{
726 struct iseq_compile_data *data = ISEQ_COMPILE_DATA(iseq);
727 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
728 VALUE err = data->err_info;
729 ISEQ_COMPILE_DATA_CLEAR(iseq);
730 compile_data_free(data);
731
732#if VM_CHECK_MODE > 0 && VM_INSN_INFO_TABLE_IMPL > 0
733 validate_get_insn_info(iseq);
734#endif
735
736 if (RTEST(err)) {
737 VALUE path = pathobj_path(body->location.pathobj);
738 if (err == Qtrue) err = rb_exc_new_cstr(rb_eSyntaxError, "compile error");
739 rb_funcallv(err, rb_intern("set_backtrace"), 1, &path);
740 rb_exc_raise(err);
741 }
742
743 RB_DEBUG_COUNTER_INC(iseq_num);
744 RB_DEBUG_COUNTER_ADD(iseq_cd_num, ISEQ_BODY(iseq)->ci_size);
745
746 rb_iseq_init_trace(iseq);
747 return Qtrue;
748}
749
750static rb_compile_option_t COMPILE_OPTION_DEFAULT = {
751 .inline_const_cache = OPT_INLINE_CONST_CACHE,
752 .peephole_optimization = OPT_PEEPHOLE_OPTIMIZATION,
753 .tailcall_optimization = OPT_TAILCALL_OPTIMIZATION,
754 .specialized_instruction = OPT_SPECIALISED_INSTRUCTION,
755 .operands_unification = OPT_OPERANDS_UNIFICATION,
756 .instructions_unification = OPT_INSTRUCTIONS_UNIFICATION,
757 .frozen_string_literal = OPT_FROZEN_STRING_LITERAL,
758 .debug_frozen_string_literal = OPT_DEBUG_FROZEN_STRING_LITERAL,
759 .coverage_enabled = TRUE,
760};
761
762static const rb_compile_option_t COMPILE_OPTION_FALSE = {
763 .frozen_string_literal = -1, // unspecified
764};
765
766int
767rb_iseq_opt_frozen_string_literal(void)
768{
769 return COMPILE_OPTION_DEFAULT.frozen_string_literal;
770}
771
772static void
773set_compile_option_from_hash(rb_compile_option_t *option, VALUE opt)
774{
775#define SET_COMPILE_OPTION(o, h, mem) \
776 { VALUE flag = rb_hash_aref((h), ID2SYM(rb_intern(#mem))); \
777 if (flag == Qtrue) { (o)->mem = 1; } \
778 else if (flag == Qfalse) { (o)->mem = 0; } \
779 }
780#define SET_COMPILE_OPTION_NUM(o, h, mem) \
781 { VALUE num = rb_hash_aref((h), ID2SYM(rb_intern(#mem))); \
782 if (!NIL_P(num)) (o)->mem = NUM2INT(num); \
783 }
784 SET_COMPILE_OPTION(option, opt, inline_const_cache);
785 SET_COMPILE_OPTION(option, opt, peephole_optimization);
786 SET_COMPILE_OPTION(option, opt, tailcall_optimization);
787 SET_COMPILE_OPTION(option, opt, specialized_instruction);
788 SET_COMPILE_OPTION(option, opt, operands_unification);
789 SET_COMPILE_OPTION(option, opt, instructions_unification);
790 SET_COMPILE_OPTION(option, opt, frozen_string_literal);
791 SET_COMPILE_OPTION(option, opt, debug_frozen_string_literal);
792 SET_COMPILE_OPTION(option, opt, coverage_enabled);
793 SET_COMPILE_OPTION_NUM(option, opt, debug_level);
794#undef SET_COMPILE_OPTION
795#undef SET_COMPILE_OPTION_NUM
796}
797
798static rb_compile_option_t *
799set_compile_option_from_ast(rb_compile_option_t *option, const rb_ast_body_t *ast)
800{
801#define SET_COMPILE_OPTION(o, a, mem) \
802 ((a)->mem < 0 ? 0 : ((o)->mem = (a)->mem > 0))
803 SET_COMPILE_OPTION(option, ast, coverage_enabled);
804#undef SET_COMPILE_OPTION
805 if (ast->frozen_string_literal >= 0) {
806 option->frozen_string_literal = ast->frozen_string_literal;
807 }
808 return option;
809}
810
811static void
812make_compile_option(rb_compile_option_t *option, VALUE opt)
813{
814 if (NIL_P(opt)) {
815 *option = COMPILE_OPTION_DEFAULT;
816 }
817 else if (opt == Qfalse) {
818 *option = COMPILE_OPTION_FALSE;
819 }
820 else if (opt == Qtrue) {
821 int i;
822 for (i = 0; i < (int)(sizeof(rb_compile_option_t) / sizeof(int)); ++i)
823 ((int *)option)[i] = 1;
824 }
825 else if (RB_TYPE_P(opt, T_HASH)) {
826 *option = COMPILE_OPTION_DEFAULT;
827 set_compile_option_from_hash(option, opt);
828 }
829 else {
830 rb_raise(rb_eTypeError, "Compile option must be Hash/true/false/nil");
831 }
832}
833
834static VALUE
835make_compile_option_value(rb_compile_option_t *option)
836{
837 VALUE opt = rb_hash_new_with_size(11);
838#define SET_COMPILE_OPTION(o, h, mem) \
839 rb_hash_aset((h), ID2SYM(rb_intern(#mem)), RBOOL((o)->mem))
840#define SET_COMPILE_OPTION_NUM(o, h, mem) \
841 rb_hash_aset((h), ID2SYM(rb_intern(#mem)), INT2NUM((o)->mem))
842 {
843 SET_COMPILE_OPTION(option, opt, inline_const_cache);
844 SET_COMPILE_OPTION(option, opt, peephole_optimization);
845 SET_COMPILE_OPTION(option, opt, tailcall_optimization);
846 SET_COMPILE_OPTION(option, opt, specialized_instruction);
847 SET_COMPILE_OPTION(option, opt, operands_unification);
848 SET_COMPILE_OPTION(option, opt, instructions_unification);
849 SET_COMPILE_OPTION(option, opt, debug_frozen_string_literal);
850 SET_COMPILE_OPTION(option, opt, coverage_enabled);
851 SET_COMPILE_OPTION_NUM(option, opt, debug_level);
852 }
853#undef SET_COMPILE_OPTION
854#undef SET_COMPILE_OPTION_NUM
855 VALUE frozen_string_literal = option->frozen_string_literal == -1 ? Qnil : RBOOL(option->frozen_string_literal);
856 rb_hash_aset(opt, ID2SYM(rb_intern("frozen_string_literal")), frozen_string_literal);
857 return opt;
858}
859
860rb_iseq_t *
861rb_iseq_new(const VALUE ast_value, VALUE name, VALUE path, VALUE realpath,
862 const rb_iseq_t *parent, enum rb_iseq_type type)
863{
864 return rb_iseq_new_with_opt(ast_value, name, path, realpath, 0, parent,
865 0, type, &COMPILE_OPTION_DEFAULT,
866 Qnil);
867}
868
869static int
870ast_line_count(const VALUE ast_value)
871{
872 rb_ast_t *ast = rb_ruby_ast_data_get(ast_value);
873 return ast->body.line_count;
874}
875
876static VALUE
877iseq_setup_coverage(VALUE coverages, VALUE path, int line_count)
878{
879 if (line_count >= 0) {
880 int len = (rb_get_coverage_mode() & COVERAGE_TARGET_ONESHOT_LINES) ? 0 : line_count;
881
882 VALUE coverage = rb_default_coverage(len);
883 rb_hash_aset(coverages, path, coverage);
884
885 return coverage;
886 }
887
888 return Qnil;
889}
890
891static inline void
892iseq_new_setup_coverage(VALUE path, int line_count)
893{
894 VALUE coverages = rb_get_coverages();
895
896 if (RTEST(coverages)) {
897 iseq_setup_coverage(coverages, path, line_count);
898 }
899}
900
901rb_iseq_t *
902rb_iseq_new_top(const VALUE ast_value, VALUE name, VALUE path, VALUE realpath, const rb_iseq_t *parent)
903{
904 iseq_new_setup_coverage(path, ast_line_count(ast_value));
905
906 return rb_iseq_new_with_opt(ast_value, name, path, realpath, 0, parent, 0,
907 ISEQ_TYPE_TOP, &COMPILE_OPTION_DEFAULT,
908 Qnil);
909}
910
914rb_iseq_t *
915pm_iseq_new_top(pm_scope_node_t *node, VALUE name, VALUE path, VALUE realpath, const rb_iseq_t *parent, int *error_state)
916{
917 iseq_new_setup_coverage(path, (int) (node->parser->newline_list.size - 1));
918
919 return pm_iseq_new_with_opt(node, name, path, realpath, 0, parent, 0,
920 ISEQ_TYPE_TOP, &COMPILE_OPTION_DEFAULT, error_state);
921}
922
923rb_iseq_t *
924rb_iseq_new_main(const VALUE ast_value, VALUE path, VALUE realpath, const rb_iseq_t *parent, int opt)
925{
926 iseq_new_setup_coverage(path, ast_line_count(ast_value));
927
928 return rb_iseq_new_with_opt(ast_value, rb_fstring_lit("<main>"),
929 path, realpath, 0,
930 parent, 0, ISEQ_TYPE_MAIN, opt ? &COMPILE_OPTION_DEFAULT : &COMPILE_OPTION_FALSE,
931 Qnil);
932}
933
938rb_iseq_t *
939pm_iseq_new_main(pm_scope_node_t *node, VALUE path, VALUE realpath, const rb_iseq_t *parent, int opt, int *error_state)
940{
941 iseq_new_setup_coverage(path, (int) (node->parser->newline_list.size - 1));
942
943 return pm_iseq_new_with_opt(node, rb_fstring_lit("<main>"),
944 path, realpath, 0,
945 parent, 0, ISEQ_TYPE_MAIN, opt ? &COMPILE_OPTION_DEFAULT : &COMPILE_OPTION_FALSE, error_state);
946}
947
948rb_iseq_t *
949rb_iseq_new_eval(const VALUE ast_value, VALUE name, VALUE path, VALUE realpath, int first_lineno, const rb_iseq_t *parent, int isolated_depth)
950{
951 if (rb_get_coverage_mode() & COVERAGE_TARGET_EVAL) {
952 VALUE coverages = rb_get_coverages();
953 if (RTEST(coverages) && RTEST(path) && !RTEST(rb_hash_has_key(coverages, path))) {
954 iseq_setup_coverage(coverages, path, ast_line_count(ast_value) + first_lineno - 1);
955 }
956 }
957
958 return rb_iseq_new_with_opt(ast_value, name, path, realpath, first_lineno,
959 parent, isolated_depth, ISEQ_TYPE_EVAL, &COMPILE_OPTION_DEFAULT,
960 Qnil);
961}
962
963rb_iseq_t *
964pm_iseq_new_eval(pm_scope_node_t *node, VALUE name, VALUE path, VALUE realpath,
965 int first_lineno, const rb_iseq_t *parent, int isolated_depth, int *error_state)
966{
967 if (rb_get_coverage_mode() & COVERAGE_TARGET_EVAL) {
968 VALUE coverages = rb_get_coverages();
969 if (RTEST(coverages) && RTEST(path) && !RTEST(rb_hash_has_key(coverages, path))) {
970 iseq_setup_coverage(coverages, path, ((int) (node->parser->newline_list.size - 1)) + first_lineno - 1);
971 }
972 }
973
974 return pm_iseq_new_with_opt(node, name, path, realpath, first_lineno,
975 parent, isolated_depth, ISEQ_TYPE_EVAL, &COMPILE_OPTION_DEFAULT, error_state);
976}
977
978static inline rb_iseq_t *
979iseq_translate(rb_iseq_t *iseq)
980{
981 if (rb_respond_to(rb_cISeq, rb_intern("translate"))) {
982 VALUE v1 = iseqw_new(iseq);
983 VALUE v2 = rb_funcall(rb_cISeq, rb_intern("translate"), 1, v1);
984 if (v1 != v2 && CLASS_OF(v2) == rb_cISeq) {
985 iseq = (rb_iseq_t *)iseqw_check(v2);
986 }
987 }
988
989 return iseq;
990}
991
992rb_iseq_t *
993rb_iseq_new_with_opt(VALUE ast_value, VALUE name, VALUE path, VALUE realpath,
994 int first_lineno, const rb_iseq_t *parent, int isolated_depth,
995 enum rb_iseq_type type, const rb_compile_option_t *option,
996 VALUE script_lines)
997{
998 rb_ast_t *ast = rb_ruby_ast_data_get(ast_value);
999 rb_ast_body_t *body = ast ? &ast->body : NULL;
1000 const NODE *node = body ? body->root : 0;
1001 /* TODO: argument check */
1002 rb_iseq_t *iseq = iseq_alloc();
1003 rb_compile_option_t new_opt;
1004
1005 if (!option) option = &COMPILE_OPTION_DEFAULT;
1006 if (body) {
1007 new_opt = *option;
1008 option = set_compile_option_from_ast(&new_opt, body);
1009 }
1010
1011 if (!NIL_P(script_lines)) {
1012 // noop
1013 }
1014 else if (body && body->script_lines) {
1015 script_lines = rb_parser_build_script_lines_from(body->script_lines);
1016 }
1017 else if (parent) {
1018 script_lines = ISEQ_BODY(parent)->variable.script_lines;
1019 }
1020
1021 prepare_iseq_build(iseq, name, path, realpath, first_lineno, node ? &node->nd_loc : NULL, node ? nd_node_id(node) : -1,
1022 parent, isolated_depth, type, script_lines, option);
1023
1024 rb_iseq_compile_node(iseq, node);
1025 finish_iseq_build(iseq);
1026 RB_GC_GUARD(ast_value);
1027
1028 return iseq_translate(iseq);
1029}
1030
1032 rb_iseq_t *iseq;
1033 pm_scope_node_t *node;
1034};
1035
1036VALUE
1037pm_iseq_new_with_opt_try(VALUE d)
1038{
1039 struct pm_iseq_new_with_opt_data *data = (struct pm_iseq_new_with_opt_data *)d;
1040
1041 // This can compile child iseqs, which can raise syntax errors
1042 pm_iseq_compile_node(data->iseq, data->node);
1043
1044 // This raises an exception if there is a syntax error
1045 finish_iseq_build(data->iseq);
1046
1047 return Qundef;
1048}
1049
1062rb_iseq_t *
1063pm_iseq_new_with_opt(pm_scope_node_t *node, VALUE name, VALUE path, VALUE realpath,
1064 int first_lineno, const rb_iseq_t *parent, int isolated_depth,
1065 enum rb_iseq_type type, const rb_compile_option_t *option, int *error_state)
1066{
1067 rb_iseq_t *iseq = iseq_alloc();
1068 ISEQ_BODY(iseq)->prism = true;
1069
1070 rb_compile_option_t next_option;
1071 if (!option) option = &COMPILE_OPTION_DEFAULT;
1072
1073 next_option = *option;
1074 next_option.coverage_enabled = node->coverage_enabled < 0 ? 0 : node->coverage_enabled > 0;
1075 option = &next_option;
1076
1077 pm_location_t *location = &node->base.location;
1078 int32_t start_line = node->parser->start_line;
1079
1080 pm_line_column_t start = pm_newline_list_line_column(&node->parser->newline_list, location->start, start_line);
1081 pm_line_column_t end = pm_newline_list_line_column(&node->parser->newline_list, location->end, start_line);
1082
1083 rb_code_location_t code_location = (rb_code_location_t) {
1084 .beg_pos = { .lineno = (int) start.line, .column = (int) start.column },
1085 .end_pos = { .lineno = (int) end.line, .column = (int) end.column }
1086 };
1087
1088 prepare_iseq_build(iseq, name, path, realpath, first_lineno, &code_location, node->ast_node->node_id,
1089 parent, isolated_depth, type, node->script_lines == NULL ? Qnil : *node->script_lines, option);
1090
1091 struct pm_iseq_new_with_opt_data data = {
1092 .iseq = iseq,
1093 .node = node
1094 };
1095 rb_protect(pm_iseq_new_with_opt_try, (VALUE)&data, error_state);
1096
1097 if (*error_state) return NULL;
1098
1099 return iseq_translate(iseq);
1100}
1101
1102rb_iseq_t *
1103rb_iseq_new_with_callback(
1104 const struct rb_iseq_new_with_callback_callback_func * ifunc,
1105 VALUE name, VALUE path, VALUE realpath,
1106 int first_lineno, const rb_iseq_t *parent,
1107 enum rb_iseq_type type, const rb_compile_option_t *option)
1108{
1109 /* TODO: argument check */
1110 rb_iseq_t *iseq = iseq_alloc();
1111
1112 if (!option) option = &COMPILE_OPTION_DEFAULT;
1113 prepare_iseq_build(iseq, name, path, realpath, first_lineno, NULL, -1, parent, 0, type, Qnil, option);
1114
1115 rb_iseq_compile_callback(iseq, ifunc);
1116 finish_iseq_build(iseq);
1117
1118 return iseq;
1119}
1120
1121const rb_iseq_t *
1122rb_iseq_load_iseq(VALUE fname)
1123{
1124 VALUE iseqv = rb_check_funcall(rb_cISeq, rb_intern("load_iseq"), 1, &fname);
1125
1126 if (!SPECIAL_CONST_P(iseqv) && RBASIC_CLASS(iseqv) == rb_cISeq) {
1127 return iseqw_check(iseqv);
1128 }
1129
1130 return NULL;
1131}
1132
1133#define CHECK_ARRAY(v) rb_to_array_type(v)
1134#define CHECK_HASH(v) rb_to_hash_type(v)
1135#define CHECK_STRING(v) rb_str_to_str(v)
1136#define CHECK_SYMBOL(v) rb_to_symbol_type(v)
1137static inline VALUE CHECK_INTEGER(VALUE v) {(void)NUM2LONG(v); return v;}
1138
1139static enum rb_iseq_type
1140iseq_type_from_sym(VALUE type)
1141{
1142 const ID id_top = rb_intern("top");
1143 const ID id_method = rb_intern("method");
1144 const ID id_block = rb_intern("block");
1145 const ID id_class = rb_intern("class");
1146 const ID id_rescue = rb_intern("rescue");
1147 const ID id_ensure = rb_intern("ensure");
1148 const ID id_eval = rb_intern("eval");
1149 const ID id_main = rb_intern("main");
1150 const ID id_plain = rb_intern("plain");
1151 /* ensure all symbols are static or pinned down before
1152 * conversion */
1153 const ID typeid = rb_check_id(&type);
1154 if (typeid == id_top) return ISEQ_TYPE_TOP;
1155 if (typeid == id_method) return ISEQ_TYPE_METHOD;
1156 if (typeid == id_block) return ISEQ_TYPE_BLOCK;
1157 if (typeid == id_class) return ISEQ_TYPE_CLASS;
1158 if (typeid == id_rescue) return ISEQ_TYPE_RESCUE;
1159 if (typeid == id_ensure) return ISEQ_TYPE_ENSURE;
1160 if (typeid == id_eval) return ISEQ_TYPE_EVAL;
1161 if (typeid == id_main) return ISEQ_TYPE_MAIN;
1162 if (typeid == id_plain) return ISEQ_TYPE_PLAIN;
1163 return (enum rb_iseq_type)-1;
1164}
1165
1166static VALUE
1167iseq_load(VALUE data, const rb_iseq_t *parent, VALUE opt)
1168{
1169 rb_iseq_t *iseq = iseq_alloc();
1170
1171 VALUE magic, version1, version2, format_type, misc;
1172 VALUE name, path, realpath, code_location, node_id;
1173 VALUE type, body, locals, params, exception;
1174
1175 st_data_t iseq_type;
1176 rb_compile_option_t option;
1177 int i = 0;
1178 rb_code_location_t tmp_loc = { {0, 0}, {-1, -1} };
1179
1180 /* [magic, major_version, minor_version, format_type, misc,
1181 * label, path, first_lineno,
1182 * type, locals, args, exception_table, body]
1183 */
1184
1185 data = CHECK_ARRAY(data);
1186
1187 magic = CHECK_STRING(rb_ary_entry(data, i++));
1188 version1 = CHECK_INTEGER(rb_ary_entry(data, i++));
1189 version2 = CHECK_INTEGER(rb_ary_entry(data, i++));
1190 format_type = CHECK_INTEGER(rb_ary_entry(data, i++));
1191 misc = CHECK_HASH(rb_ary_entry(data, i++));
1192 ((void)magic, (void)version1, (void)version2, (void)format_type);
1193
1194 name = CHECK_STRING(rb_ary_entry(data, i++));
1195 path = CHECK_STRING(rb_ary_entry(data, i++));
1196 realpath = rb_ary_entry(data, i++);
1197 realpath = NIL_P(realpath) ? Qnil : CHECK_STRING(realpath);
1198 int first_lineno = RB_NUM2INT(rb_ary_entry(data, i++));
1199
1200 type = CHECK_SYMBOL(rb_ary_entry(data, i++));
1201 locals = CHECK_ARRAY(rb_ary_entry(data, i++));
1202 params = CHECK_HASH(rb_ary_entry(data, i++));
1203 exception = CHECK_ARRAY(rb_ary_entry(data, i++));
1204 body = CHECK_ARRAY(rb_ary_entry(data, i++));
1205
1206 ISEQ_BODY(iseq)->local_iseq = iseq;
1207
1208 iseq_type = iseq_type_from_sym(type);
1209 if (iseq_type == (enum rb_iseq_type)-1) {
1210 rb_raise(rb_eTypeError, "unsupported type: :%"PRIsVALUE, rb_sym2str(type));
1211 }
1212
1213 node_id = rb_hash_aref(misc, ID2SYM(rb_intern("node_id")));
1214
1215 code_location = rb_hash_aref(misc, ID2SYM(rb_intern("code_location")));
1216 if (RB_TYPE_P(code_location, T_ARRAY) && RARRAY_LEN(code_location) == 4) {
1217 tmp_loc.beg_pos.lineno = NUM2INT(rb_ary_entry(code_location, 0));
1218 tmp_loc.beg_pos.column = NUM2INT(rb_ary_entry(code_location, 1));
1219 tmp_loc.end_pos.lineno = NUM2INT(rb_ary_entry(code_location, 2));
1220 tmp_loc.end_pos.column = NUM2INT(rb_ary_entry(code_location, 3));
1221 }
1222
1223 if (SYM2ID(rb_hash_aref(misc, ID2SYM(rb_intern("parser")))) == rb_intern("prism")) {
1224 ISEQ_BODY(iseq)->prism = true;
1225 }
1226
1227 make_compile_option(&option, opt);
1228 option.peephole_optimization = FALSE; /* because peephole optimization can modify original iseq */
1229 prepare_iseq_build(iseq, name, path, realpath, first_lineno, &tmp_loc, NUM2INT(node_id),
1230 parent, 0, (enum rb_iseq_type)iseq_type, Qnil, &option);
1231
1232 rb_iseq_build_from_ary(iseq, misc, locals, params, exception, body);
1233
1234 finish_iseq_build(iseq);
1235
1236 return iseqw_new(iseq);
1237}
1238
1239/*
1240 * :nodoc:
1241 */
1242static VALUE
1243iseq_s_load(int argc, VALUE *argv, VALUE self)
1244{
1245 VALUE data, opt=Qnil;
1246 rb_scan_args(argc, argv, "11", &data, &opt);
1247 return iseq_load(data, NULL, opt);
1248}
1249
1250VALUE
1251rb_iseq_load(VALUE data, VALUE parent, VALUE opt)
1252{
1253 return iseq_load(data, RTEST(parent) ? (rb_iseq_t *)parent : NULL, opt);
1254}
1255
1256static rb_iseq_t *
1257rb_iseq_compile_with_option(VALUE src, VALUE file, VALUE realpath, VALUE line, VALUE opt)
1258{
1259 rb_iseq_t *iseq = NULL;
1260 rb_compile_option_t option;
1261#if !defined(__GNUC__) || (__GNUC__ == 4 && __GNUC_MINOR__ == 8)
1262# define INITIALIZED volatile /* suppress warnings by gcc 4.8 */
1263#else
1264# define INITIALIZED /* volatile */
1265#endif
1266 VALUE (*parse)(VALUE vparser, VALUE fname, VALUE file, int start);
1267 int ln;
1268 VALUE INITIALIZED ast_value;
1269 rb_ast_t *ast;
1270 VALUE name = rb_fstring_lit("<compiled>");
1271
1272 /* safe results first */
1273 make_compile_option(&option, opt);
1274 ln = NUM2INT(line);
1275 StringValueCStr(file);
1276 if (RB_TYPE_P(src, T_FILE)) {
1277 parse = rb_parser_compile_file_path;
1278 }
1279 else {
1280 parse = rb_parser_compile_string_path;
1281 StringValue(src);
1282 }
1283 {
1284 const VALUE parser = rb_parser_new();
1285 const rb_iseq_t *outer_scope = rb_iseq_new(Qnil, name, name, Qnil, 0, ISEQ_TYPE_TOP);
1286 VALUE outer_scope_v = (VALUE)outer_scope;
1287 rb_parser_set_context(parser, outer_scope, FALSE);
1288 if (ruby_vm_keep_script_lines) rb_parser_set_script_lines(parser);
1289 RB_GC_GUARD(outer_scope_v);
1290 ast_value = (*parse)(parser, file, src, ln);
1291 }
1292
1293 ast = rb_ruby_ast_data_get(ast_value);
1294
1295 if (!ast || !ast->body.root) {
1296 rb_ast_dispose(ast);
1297 rb_exc_raise(GET_EC()->errinfo);
1298 }
1299 else {
1300 iseq = rb_iseq_new_with_opt(ast_value, name, file, realpath, ln,
1301 NULL, 0, ISEQ_TYPE_TOP, &option,
1302 Qnil);
1303 rb_ast_dispose(ast);
1304 }
1305
1306 return iseq;
1307}
1308
1309static rb_iseq_t *
1310pm_iseq_compile_with_option(VALUE src, VALUE file, VALUE realpath, VALUE line, VALUE opt)
1311{
1312 rb_iseq_t *iseq = NULL;
1313 rb_compile_option_t option;
1314 int ln;
1315 VALUE name = rb_fstring_lit("<compiled>");
1316
1317 /* safe results first */
1318 make_compile_option(&option, opt);
1319 ln = NUM2INT(line);
1320 StringValueCStr(file);
1321
1322 pm_parse_result_t result = { 0 };
1323 pm_options_line_set(&result.options, NUM2INT(line));
1324 pm_options_scopes_init(&result.options, 1);
1325 result.node.coverage_enabled = 1;
1326
1327 switch (option.frozen_string_literal) {
1328 case ISEQ_FROZEN_STRING_LITERAL_UNSET:
1329 break;
1330 case ISEQ_FROZEN_STRING_LITERAL_DISABLED:
1331 pm_options_frozen_string_literal_set(&result.options, false);
1332 break;
1333 case ISEQ_FROZEN_STRING_LITERAL_ENABLED:
1334 pm_options_frozen_string_literal_set(&result.options, true);
1335 break;
1336 default:
1337 rb_bug("pm_iseq_compile_with_option: invalid frozen_string_literal=%d", option.frozen_string_literal);
1338 break;
1339 }
1340
1341 VALUE script_lines;
1342 VALUE error;
1343
1344 if (RB_TYPE_P(src, T_FILE)) {
1345 VALUE filepath = rb_io_path(src);
1346 error = pm_load_parse_file(&result, filepath, ruby_vm_keep_script_lines ? &script_lines : NULL);
1347 RB_GC_GUARD(filepath);
1348 }
1349 else {
1350 src = StringValue(src);
1351 error = pm_parse_string(&result, src, file, ruby_vm_keep_script_lines ? &script_lines : NULL);
1352 }
1353
1354 if (error == Qnil) {
1355 int error_state;
1356 iseq = pm_iseq_new_with_opt(&result.node, name, file, realpath, ln, NULL, 0, ISEQ_TYPE_TOP, &option, &error_state);
1357
1358 pm_parse_result_free(&result);
1359
1360 if (error_state) {
1361 RUBY_ASSERT(iseq == NULL);
1362 rb_jump_tag(error_state);
1363 }
1364 }
1365 else {
1366 pm_parse_result_free(&result);
1367 rb_exc_raise(error);
1368 }
1369
1370 return iseq;
1371}
1372
1373VALUE
1374rb_iseq_path(const rb_iseq_t *iseq)
1375{
1376 return pathobj_path(ISEQ_BODY(iseq)->location.pathobj);
1377}
1378
1379VALUE
1380rb_iseq_realpath(const rb_iseq_t *iseq)
1381{
1382 return pathobj_realpath(ISEQ_BODY(iseq)->location.pathobj);
1383}
1384
1385VALUE
1386rb_iseq_absolute_path(const rb_iseq_t *iseq)
1387{
1388 return rb_iseq_realpath(iseq);
1389}
1390
1391int
1392rb_iseq_from_eval_p(const rb_iseq_t *iseq)
1393{
1394 return NIL_P(rb_iseq_realpath(iseq));
1395}
1396
1397VALUE
1398rb_iseq_label(const rb_iseq_t *iseq)
1399{
1400 return ISEQ_BODY(iseq)->location.label;
1401}
1402
1403VALUE
1404rb_iseq_base_label(const rb_iseq_t *iseq)
1405{
1406 return ISEQ_BODY(iseq)->location.base_label;
1407}
1408
1409VALUE
1410rb_iseq_first_lineno(const rb_iseq_t *iseq)
1411{
1412 return RB_INT2NUM(ISEQ_BODY(iseq)->location.first_lineno);
1413}
1414
1415VALUE
1416rb_iseq_method_name(const rb_iseq_t *iseq)
1417{
1418 struct rb_iseq_constant_body *const body = ISEQ_BODY(ISEQ_BODY(iseq)->local_iseq);
1419
1420 if (body->type == ISEQ_TYPE_METHOD) {
1421 return body->location.base_label;
1422 }
1423 else {
1424 return Qnil;
1425 }
1426}
1427
1428void
1429rb_iseq_code_location(const rb_iseq_t *iseq, int *beg_pos_lineno, int *beg_pos_column, int *end_pos_lineno, int *end_pos_column)
1430{
1431 const rb_code_location_t *loc = &ISEQ_BODY(iseq)->location.code_location;
1432 if (beg_pos_lineno) *beg_pos_lineno = loc->beg_pos.lineno;
1433 if (beg_pos_column) *beg_pos_column = loc->beg_pos.column;
1434 if (end_pos_lineno) *end_pos_lineno = loc->end_pos.lineno;
1435 if (end_pos_column) *end_pos_column = loc->end_pos.column;
1436}
1437
1438static ID iseq_type_id(enum rb_iseq_type type);
1439
1440VALUE
1441rb_iseq_type(const rb_iseq_t *iseq)
1442{
1443 return ID2SYM(iseq_type_id(ISEQ_BODY(iseq)->type));
1444}
1445
1446VALUE
1447rb_iseq_coverage(const rb_iseq_t *iseq)
1448{
1449 return ISEQ_COVERAGE(iseq);
1450}
1451
1452static int
1453remove_coverage_i(void *vstart, void *vend, size_t stride, void *data)
1454{
1455 VALUE v = (VALUE)vstart;
1456 for (; v != (VALUE)vend; v += stride) {
1457 void *ptr = rb_asan_poisoned_object_p(v);
1458 rb_asan_unpoison_object(v, false);
1459
1460 if (rb_obj_is_iseq(v)) {
1461 rb_iseq_t *iseq = (rb_iseq_t *)v;
1462 ISEQ_COVERAGE_SET(iseq, Qnil);
1463 }
1464
1465 asan_poison_object_if(ptr, v);
1466 }
1467 return 0;
1468}
1469
1470void
1471rb_iseq_remove_coverage_all(void)
1472{
1473 rb_objspace_each_objects(remove_coverage_i, NULL);
1474}
1475
1476/* define wrapper class methods (RubyVM::InstructionSequence) */
1477
1478static void
1479iseqw_mark(void *ptr)
1480{
1481 rb_gc_mark_movable(*(VALUE *)ptr);
1482}
1483
1484static size_t
1485iseqw_memsize(const void *ptr)
1486{
1487 return rb_iseq_memsize(*(const rb_iseq_t **)ptr);
1488}
1489
1490static void
1491iseqw_ref_update(void *ptr)
1492{
1493 VALUE *vptr = ptr;
1494 *vptr = rb_gc_location(*vptr);
1495}
1496
1497static const rb_data_type_t iseqw_data_type = {
1498 "T_IMEMO/iseq",
1499 {
1500 iseqw_mark,
1502 iseqw_memsize,
1503 iseqw_ref_update,
1504 },
1505 0, 0, RUBY_TYPED_FREE_IMMEDIATELY|RUBY_TYPED_WB_PROTECTED
1506};
1507
1508static VALUE
1509iseqw_new(const rb_iseq_t *iseq)
1510{
1511 if (iseq->wrapper) {
1512 if (*(const rb_iseq_t **)rb_check_typeddata(iseq->wrapper, &iseqw_data_type) != iseq) {
1513 rb_raise(rb_eTypeError, "wrong iseq wrapper: %" PRIsVALUE " for %p",
1514 iseq->wrapper, (void *)iseq);
1515 }
1516 return iseq->wrapper;
1517 }
1518 else {
1519 rb_iseq_t **ptr;
1520 VALUE obj = TypedData_Make_Struct(rb_cISeq, rb_iseq_t *, &iseqw_data_type, ptr);
1521 RB_OBJ_WRITE(obj, ptr, iseq);
1522
1523 /* cache a wrapper object */
1524 RB_OBJ_WRITE((VALUE)iseq, &iseq->wrapper, obj);
1525 RB_OBJ_FREEZE((VALUE)iseq);
1526
1527 return obj;
1528 }
1529}
1530
1531VALUE
1532rb_iseqw_new(const rb_iseq_t *iseq)
1533{
1534 return iseqw_new(iseq);
1535}
1536
1542static VALUE
1543iseqw_s_compile_parser(int argc, VALUE *argv, VALUE self, bool prism)
1544{
1545 VALUE src, file = Qnil, path = Qnil, line = Qnil, opt = Qnil;
1546 int i;
1547
1548 i = rb_scan_args(argc, argv, "1*:", &src, NULL, &opt);
1549 if (i > 4+NIL_P(opt)) rb_error_arity(argc, 1, 5);
1550 switch (i) {
1551 case 5: opt = argv[--i];
1552 case 4: line = argv[--i];
1553 case 3: path = argv[--i];
1554 case 2: file = argv[--i];
1555 }
1556
1557 if (NIL_P(file)) file = rb_fstring_lit("<compiled>");
1558 if (NIL_P(path)) path = file;
1559 if (NIL_P(line)) line = INT2FIX(1);
1560
1561 Check_Type(path, T_STRING);
1562 Check_Type(file, T_STRING);
1563
1564 rb_iseq_t *iseq;
1565 if (prism) {
1566 iseq = pm_iseq_compile_with_option(src, file, path, line, opt);
1567 }
1568 else {
1569 iseq = rb_iseq_compile_with_option(src, file, path, line, opt);
1570 }
1571
1572 return iseqw_new(iseq);
1573}
1574
1575/*
1576 * call-seq:
1577 * InstructionSequence.compile(source[, file[, path[, line[, options]]]]) -> iseq
1578 * InstructionSequence.new(source[, file[, path[, line[, options]]]]) -> iseq
1579 *
1580 * Takes +source+, which can be a string of Ruby code, or an open +File+ object.
1581 * that contains Ruby source code.
1582 *
1583 * Optionally takes +file+, +path+, and +line+ which describe the file path,
1584 * real path and first line number of the ruby code in +source+ which are
1585 * metadata attached to the returned +iseq+.
1586 *
1587 * +file+ is used for `__FILE__` and exception backtrace. +path+ is used for
1588 * +require_relative+ base. It is recommended these should be the same full
1589 * path.
1590 *
1591 * +options+, which can be +true+, +false+ or a +Hash+, is used to
1592 * modify the default behavior of the Ruby iseq compiler.
1593 *
1594 * For details regarding valid compile options see ::compile_option=.
1595 *
1596 * RubyVM::InstructionSequence.compile("a = 1 + 2")
1597 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
1598 *
1599 * path = "test.rb"
1600 * RubyVM::InstructionSequence.compile(File.read(path), path, File.expand_path(path))
1601 * #=> <RubyVM::InstructionSequence:<compiled>@test.rb:1>
1602 *
1603 * file = File.open("test.rb")
1604 * RubyVM::InstructionSequence.compile(file)
1605 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>:1>
1606 *
1607 * path = File.expand_path("test.rb")
1608 * RubyVM::InstructionSequence.compile(File.read(path), path, path)
1609 * #=> <RubyVM::InstructionSequence:<compiled>@/absolute/path/to/test.rb:1>
1610 *
1611 */
1612static VALUE
1613iseqw_s_compile(int argc, VALUE *argv, VALUE self)
1614{
1615 return iseqw_s_compile_parser(argc, argv, self, rb_ruby_prism_p());
1616}
1617
1618/*
1619 * call-seq:
1620 * InstructionSequence.compile_parsey(source[, file[, path[, line[, options]]]]) -> iseq
1621 *
1622 * Takes +source+, which can be a string of Ruby code, or an open +File+ object.
1623 * that contains Ruby source code. It parses and compiles using parse.y.
1624 *
1625 * Optionally takes +file+, +path+, and +line+ which describe the file path,
1626 * real path and first line number of the ruby code in +source+ which are
1627 * metadata attached to the returned +iseq+.
1628 *
1629 * +file+ is used for `__FILE__` and exception backtrace. +path+ is used for
1630 * +require_relative+ base. It is recommended these should be the same full
1631 * path.
1632 *
1633 * +options+, which can be +true+, +false+ or a +Hash+, is used to
1634 * modify the default behavior of the Ruby iseq compiler.
1635 *
1636 * For details regarding valid compile options see ::compile_option=.
1637 *
1638 * RubyVM::InstructionSequence.compile_parsey("a = 1 + 2")
1639 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
1640 *
1641 * path = "test.rb"
1642 * RubyVM::InstructionSequence.compile_parsey(File.read(path), path, File.expand_path(path))
1643 * #=> <RubyVM::InstructionSequence:<compiled>@test.rb:1>
1644 *
1645 * file = File.open("test.rb")
1646 * RubyVM::InstructionSequence.compile_parsey(file)
1647 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>:1>
1648 *
1649 * path = File.expand_path("test.rb")
1650 * RubyVM::InstructionSequence.compile_parsey(File.read(path), path, path)
1651 * #=> <RubyVM::InstructionSequence:<compiled>@/absolute/path/to/test.rb:1>
1652 *
1653 */
1654static VALUE
1655iseqw_s_compile_parsey(int argc, VALUE *argv, VALUE self)
1656{
1657 return iseqw_s_compile_parser(argc, argv, self, false);
1658}
1659
1660/*
1661 * call-seq:
1662 * InstructionSequence.compile_prism(source[, file[, path[, line[, options]]]]) -> iseq
1663 *
1664 * Takes +source+, which can be a string of Ruby code, or an open +File+ object.
1665 * that contains Ruby source code. It parses and compiles using prism.
1666 *
1667 * Optionally takes +file+, +path+, and +line+ which describe the file path,
1668 * real path and first line number of the ruby code in +source+ which are
1669 * metadata attached to the returned +iseq+.
1670 *
1671 * +file+ is used for `__FILE__` and exception backtrace. +path+ is used for
1672 * +require_relative+ base. It is recommended these should be the same full
1673 * path.
1674 *
1675 * +options+, which can be +true+, +false+ or a +Hash+, is used to
1676 * modify the default behavior of the Ruby iseq compiler.
1677 *
1678 * For details regarding valid compile options see ::compile_option=.
1679 *
1680 * RubyVM::InstructionSequence.compile_prism("a = 1 + 2")
1681 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
1682 *
1683 * path = "test.rb"
1684 * RubyVM::InstructionSequence.compile_prism(File.read(path), path, File.expand_path(path))
1685 * #=> <RubyVM::InstructionSequence:<compiled>@test.rb:1>
1686 *
1687 * file = File.open("test.rb")
1688 * RubyVM::InstructionSequence.compile_prism(file)
1689 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>:1>
1690 *
1691 * path = File.expand_path("test.rb")
1692 * RubyVM::InstructionSequence.compile_prism(File.read(path), path, path)
1693 * #=> <RubyVM::InstructionSequence:<compiled>@/absolute/path/to/test.rb:1>
1694 *
1695 */
1696static VALUE
1697iseqw_s_compile_prism(int argc, VALUE *argv, VALUE self)
1698{
1699 return iseqw_s_compile_parser(argc, argv, self, true);
1700}
1701
1702/*
1703 * call-seq:
1704 * InstructionSequence.compile_file(file[, options]) -> iseq
1705 *
1706 * Takes +file+, a String with the location of a Ruby source file, reads,
1707 * parses and compiles the file, and returns +iseq+, the compiled
1708 * InstructionSequence with source location metadata set.
1709 *
1710 * Optionally takes +options+, which can be +true+, +false+ or a +Hash+, to
1711 * modify the default behavior of the Ruby iseq compiler.
1712 *
1713 * For details regarding valid compile options see ::compile_option=.
1714 *
1715 * # /tmp/hello.rb
1716 * puts "Hello, world!"
1717 *
1718 * # elsewhere
1719 * RubyVM::InstructionSequence.compile_file("/tmp/hello.rb")
1720 * #=> <RubyVM::InstructionSequence:<main>@/tmp/hello.rb>
1721 */
1722static VALUE
1723iseqw_s_compile_file(int argc, VALUE *argv, VALUE self)
1724{
1725 VALUE file, opt = Qnil;
1726 VALUE parser, f, exc = Qnil, ret;
1727 rb_ast_t *ast;
1728 VALUE ast_value;
1729 rb_compile_option_t option;
1730 int i;
1731
1732 i = rb_scan_args(argc, argv, "1*:", &file, NULL, &opt);
1733 if (i > 1+NIL_P(opt)) rb_error_arity(argc, 1, 2);
1734 switch (i) {
1735 case 2: opt = argv[--i];
1736 }
1737 FilePathValue(file);
1738 file = rb_fstring(file); /* rb_io_t->pathv gets frozen anyways */
1739
1740 f = rb_file_open_str(file, "r");
1741
1742 rb_execution_context_t *ec = GET_EC();
1743 VALUE v = rb_vm_push_frame_fname(ec, file);
1744
1745 parser = rb_parser_new();
1746 rb_parser_set_context(parser, NULL, FALSE);
1747 ast_value = rb_parser_load_file(parser, file);
1748 ast = rb_ruby_ast_data_get(ast_value);
1749 if (!ast->body.root) exc = GET_EC()->errinfo;
1750
1751 rb_io_close(f);
1752 if (!ast->body.root) {
1753 rb_ast_dispose(ast);
1754 rb_exc_raise(exc);
1755 }
1756
1757 make_compile_option(&option, opt);
1758
1759 ret = iseqw_new(rb_iseq_new_with_opt(ast_value, rb_fstring_lit("<main>"),
1760 file,
1761 rb_realpath_internal(Qnil, file, 1),
1762 1, NULL, 0, ISEQ_TYPE_TOP, &option,
1763 Qnil));
1764 rb_ast_dispose(ast);
1765 RB_GC_GUARD(ast_value);
1766
1767 rb_vm_pop_frame(ec);
1768 RB_GC_GUARD(v);
1769 return ret;
1770}
1771
1772/*
1773 * call-seq:
1774 * InstructionSequence.compile_file_prism(file[, options]) -> iseq
1775 *
1776 * Takes +file+, a String with the location of a Ruby source file, reads,
1777 * parses and compiles the file, and returns +iseq+, the compiled
1778 * InstructionSequence with source location metadata set. It parses and
1779 * compiles using prism.
1780 *
1781 * Optionally takes +options+, which can be +true+, +false+ or a +Hash+, to
1782 * modify the default behavior of the Ruby iseq compiler.
1783 *
1784 * For details regarding valid compile options see ::compile_option=.
1785 *
1786 * # /tmp/hello.rb
1787 * puts "Hello, world!"
1788 *
1789 * # elsewhere
1790 * RubyVM::InstructionSequence.compile_file_prism("/tmp/hello.rb")
1791 * #=> <RubyVM::InstructionSequence:<main>@/tmp/hello.rb>
1792 */
1793static VALUE
1794iseqw_s_compile_file_prism(int argc, VALUE *argv, VALUE self)
1795{
1796 VALUE file, opt = Qnil, ret;
1797 rb_compile_option_t option;
1798 int i;
1799
1800 i = rb_scan_args(argc, argv, "1*:", &file, NULL, &opt);
1801 if (i > 1+NIL_P(opt)) rb_error_arity(argc, 1, 2);
1802 switch (i) {
1803 case 2: opt = argv[--i];
1804 }
1805 FilePathValue(file);
1806 file = rb_fstring(file); /* rb_io_t->pathv gets frozen anyways */
1807
1808 rb_execution_context_t *ec = GET_EC();
1809 VALUE v = rb_vm_push_frame_fname(ec, file);
1810
1811 pm_parse_result_t result = { 0 };
1812 result.options.line = 1;
1813 result.node.coverage_enabled = 1;
1814
1815 VALUE script_lines;
1816 VALUE error = pm_load_parse_file(&result, file, ruby_vm_keep_script_lines ? &script_lines : NULL);
1817
1818 if (error == Qnil) {
1819 make_compile_option(&option, opt);
1820
1821 int error_state;
1822 rb_iseq_t *iseq = pm_iseq_new_with_opt(&result.node, rb_fstring_lit("<main>"),
1823 file,
1824 rb_realpath_internal(Qnil, file, 1),
1825 1, NULL, 0, ISEQ_TYPE_TOP, &option, &error_state);
1826
1827 pm_parse_result_free(&result);
1828
1829 if (error_state) {
1830 RUBY_ASSERT(iseq == NULL);
1831 rb_jump_tag(error_state);
1832 }
1833
1834 ret = iseqw_new(iseq);
1835 rb_vm_pop_frame(ec);
1836 RB_GC_GUARD(v);
1837 return ret;
1838 } else {
1839 pm_parse_result_free(&result);
1840 rb_vm_pop_frame(ec);
1841 RB_GC_GUARD(v);
1842 rb_exc_raise(error);
1843 }
1844}
1845
1846/*
1847 * call-seq:
1848 * InstructionSequence.compile_option = options
1849 *
1850 * Sets the default values for various optimizations in the Ruby iseq
1851 * compiler.
1852 *
1853 * Possible values for +options+ include +true+, which enables all options,
1854 * +false+ which disables all options, and +nil+ which leaves all options
1855 * unchanged.
1856 *
1857 * You can also pass a +Hash+ of +options+ that you want to change, any
1858 * options not present in the hash will be left unchanged.
1859 *
1860 * Possible option names (which are keys in +options+) which can be set to
1861 * +true+ or +false+ include:
1862 *
1863 * * +:inline_const_cache+
1864 * * +:instructions_unification+
1865 * * +:operands_unification+
1866 * * +:peephole_optimization+
1867 * * +:specialized_instruction+
1868 * * +:tailcall_optimization+
1869 *
1870 * Additionally, +:debug_level+ can be set to an integer.
1871 *
1872 * These default options can be overwritten for a single run of the iseq
1873 * compiler by passing any of the above values as the +options+ parameter to
1874 * ::new, ::compile and ::compile_file.
1875 */
1876static VALUE
1877iseqw_s_compile_option_set(VALUE self, VALUE opt)
1878{
1879 rb_compile_option_t option;
1880 make_compile_option(&option, opt);
1881 COMPILE_OPTION_DEFAULT = option;
1882 return opt;
1883}
1884
1885/*
1886 * call-seq:
1887 * InstructionSequence.compile_option -> options
1888 *
1889 * Returns a hash of default options used by the Ruby iseq compiler.
1890 *
1891 * For details, see InstructionSequence.compile_option=.
1892 */
1893static VALUE
1894iseqw_s_compile_option_get(VALUE self)
1895{
1896 return make_compile_option_value(&COMPILE_OPTION_DEFAULT);
1897}
1898
1899static const rb_iseq_t *
1900iseqw_check(VALUE iseqw)
1901{
1902 rb_iseq_t **iseq_ptr;
1903 TypedData_Get_Struct(iseqw, rb_iseq_t *, &iseqw_data_type, iseq_ptr);
1904 rb_iseq_t *iseq = *iseq_ptr;
1905
1906 if (!ISEQ_BODY(iseq)) {
1907 rb_ibf_load_iseq_complete(iseq);
1908 }
1909
1910 if (!ISEQ_BODY(iseq)->location.label) {
1911 rb_raise(rb_eTypeError, "uninitialized InstructionSequence");
1912 }
1913 return iseq;
1914}
1915
1916const rb_iseq_t *
1917rb_iseqw_to_iseq(VALUE iseqw)
1918{
1919 return iseqw_check(iseqw);
1920}
1921
1922/*
1923 * call-seq:
1924 * iseq.eval -> obj
1925 *
1926 * Evaluates the instruction sequence and returns the result.
1927 *
1928 * RubyVM::InstructionSequence.compile("1 + 2").eval #=> 3
1929 */
1930static VALUE
1931iseqw_eval(VALUE self)
1932{
1933 const rb_iseq_t *iseq = iseqw_check(self);
1934 if (0 == ISEQ_BODY(iseq)->iseq_size) {
1935 rb_raise(rb_eTypeError, "attempt to evaluate dummy InstructionSequence");
1936 }
1937 return rb_iseq_eval(iseq);
1938}
1939
1940/*
1941 * Returns a human-readable string representation of this instruction
1942 * sequence, including the #label and #path.
1943 */
1944static VALUE
1945iseqw_inspect(VALUE self)
1946{
1947 const rb_iseq_t *iseq = iseqw_check(self);
1948 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
1949 VALUE klass = rb_class_name(rb_obj_class(self));
1950
1951 if (!body->location.label) {
1952 return rb_sprintf("#<%"PRIsVALUE": uninitialized>", klass);
1953 }
1954 else {
1955 return rb_sprintf("<%"PRIsVALUE":%"PRIsVALUE"@%"PRIsVALUE":%d>",
1956 klass,
1957 body->location.label, rb_iseq_path(iseq),
1958 FIX2INT(rb_iseq_first_lineno(iseq)));
1959 }
1960}
1961
1962/*
1963 * Returns the path of this instruction sequence.
1964 *
1965 * <code><compiled></code> if the iseq was evaluated from a string.
1966 *
1967 * For example, using irb:
1968 *
1969 * iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
1970 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
1971 * iseq.path
1972 * #=> "<compiled>"
1973 *
1974 * Using ::compile_file:
1975 *
1976 * # /tmp/method.rb
1977 * def hello
1978 * puts "hello, world"
1979 * end
1980 *
1981 * # in irb
1982 * > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
1983 * > iseq.path #=> /tmp/method.rb
1984 */
1985static VALUE
1986iseqw_path(VALUE self)
1987{
1988 return rb_iseq_path(iseqw_check(self));
1989}
1990
1991/*
1992 * Returns the absolute path of this instruction sequence.
1993 *
1994 * +nil+ if the iseq was evaluated from a string.
1995 *
1996 * For example, using ::compile_file:
1997 *
1998 * # /tmp/method.rb
1999 * def hello
2000 * puts "hello, world"
2001 * end
2002 *
2003 * # in irb
2004 * > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
2005 * > iseq.absolute_path #=> /tmp/method.rb
2006 */
2007static VALUE
2008iseqw_absolute_path(VALUE self)
2009{
2010 return rb_iseq_realpath(iseqw_check(self));
2011}
2012
2013/* Returns the label of this instruction sequence.
2014 *
2015 * <code><main></code> if it's at the top level, <code><compiled></code> if it
2016 * was evaluated from a string.
2017 *
2018 * For example, using irb:
2019 *
2020 * iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
2021 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
2022 * iseq.label
2023 * #=> "<compiled>"
2024 *
2025 * Using ::compile_file:
2026 *
2027 * # /tmp/method.rb
2028 * def hello
2029 * puts "hello, world"
2030 * end
2031 *
2032 * # in irb
2033 * > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
2034 * > iseq.label #=> <main>
2035 */
2036static VALUE
2037iseqw_label(VALUE self)
2038{
2039 return rb_iseq_label(iseqw_check(self));
2040}
2041
2042/* Returns the base label of this instruction sequence.
2043 *
2044 * For example, using irb:
2045 *
2046 * iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
2047 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
2048 * iseq.base_label
2049 * #=> "<compiled>"
2050 *
2051 * Using ::compile_file:
2052 *
2053 * # /tmp/method.rb
2054 * def hello
2055 * puts "hello, world"
2056 * end
2057 *
2058 * # in irb
2059 * > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
2060 * > iseq.base_label #=> <main>
2061 */
2062static VALUE
2063iseqw_base_label(VALUE self)
2064{
2065 return rb_iseq_base_label(iseqw_check(self));
2066}
2067
2068/* Returns the number of the first source line where the instruction sequence
2069 * was loaded from.
2070 *
2071 * For example, using irb:
2072 *
2073 * iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
2074 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
2075 * iseq.first_lineno
2076 * #=> 1
2077 */
2078static VALUE
2079iseqw_first_lineno(VALUE self)
2080{
2081 return rb_iseq_first_lineno(iseqw_check(self));
2082}
2083
2084static VALUE iseq_data_to_ary(const rb_iseq_t *iseq);
2085
2086/*
2087 * call-seq:
2088 * iseq.to_a -> ary
2089 *
2090 * Returns an Array with 14 elements representing the instruction sequence
2091 * with the following data:
2092 *
2093 * [magic]
2094 * A string identifying the data format. <b>Always
2095 * +YARVInstructionSequence/SimpleDataFormat+.</b>
2096 *
2097 * [major_version]
2098 * The major version of the instruction sequence.
2099 *
2100 * [minor_version]
2101 * The minor version of the instruction sequence.
2102 *
2103 * [format_type]
2104 * A number identifying the data format. <b>Always 1</b>.
2105 *
2106 * [misc]
2107 * A hash containing:
2108 *
2109 * [+:arg_size+]
2110 * the total number of arguments taken by the method or the block (0 if
2111 * _iseq_ doesn't represent a method or block)
2112 * [+:local_size+]
2113 * the number of local variables + 1
2114 * [+:stack_max+]
2115 * used in calculating the stack depth at which a SystemStackError is
2116 * thrown.
2117 *
2118 * [#label]
2119 * The name of the context (block, method, class, module, etc.) that this
2120 * instruction sequence belongs to.
2121 *
2122 * <code><main></code> if it's at the top level, <code><compiled></code> if
2123 * it was evaluated from a string.
2124 *
2125 * [#path]
2126 * The relative path to the Ruby file where the instruction sequence was
2127 * loaded from.
2128 *
2129 * <code><compiled></code> if the iseq was evaluated from a string.
2130 *
2131 * [#absolute_path]
2132 * The absolute path to the Ruby file where the instruction sequence was
2133 * loaded from.
2134 *
2135 * +nil+ if the iseq was evaluated from a string.
2136 *
2137 * [#first_lineno]
2138 * The number of the first source line where the instruction sequence was
2139 * loaded from.
2140 *
2141 * [type]
2142 * The type of the instruction sequence.
2143 *
2144 * Valid values are +:top+, +:method+, +:block+, +:class+, +:rescue+,
2145 * +:ensure+, +:eval+, +:main+, and +plain+.
2146 *
2147 * [locals]
2148 * An array containing the names of all arguments and local variables as
2149 * symbols.
2150 *
2151 * [params]
2152 * An Hash object containing parameter information.
2153 *
2154 * More info about these values can be found in +vm_core.h+.
2155 *
2156 * [catch_table]
2157 * A list of exceptions and control flow operators (rescue, next, redo,
2158 * break, etc.).
2159 *
2160 * [bytecode]
2161 * An array of arrays containing the instruction names and operands that
2162 * make up the body of the instruction sequence.
2163 *
2164 * Note that this format is MRI specific and version dependent.
2165 *
2166 */
2167static VALUE
2168iseqw_to_a(VALUE self)
2169{
2170 const rb_iseq_t *iseq = iseqw_check(self);
2171 return iseq_data_to_ary(iseq);
2172}
2173
2174#if VM_INSN_INFO_TABLE_IMPL == 1 /* binary search */
2175static const struct iseq_insn_info_entry *
2176get_insn_info_binary_search(const rb_iseq_t *iseq, size_t pos)
2177{
2178 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2179 size_t size = body->insns_info.size;
2180 const struct iseq_insn_info_entry *insns_info = body->insns_info.body;
2181 const unsigned int *positions = body->insns_info.positions;
2182 const int debug = 0;
2183
2184 if (debug) {
2185 printf("size: %"PRIuSIZE"\n", size);
2186 printf("insns_info[%"PRIuSIZE"]: position: %d, line: %d, pos: %"PRIuSIZE"\n",
2187 (size_t)0, positions[0], insns_info[0].line_no, pos);
2188 }
2189
2190 if (size == 0) {
2191 return NULL;
2192 }
2193 else if (size == 1) {
2194 return &insns_info[0];
2195 }
2196 else {
2197 size_t l = 1, r = size - 1;
2198 while (l <= r) {
2199 size_t m = l + (r - l) / 2;
2200 if (positions[m] == pos) {
2201 return &insns_info[m];
2202 }
2203 if (positions[m] < pos) {
2204 l = m + 1;
2205 }
2206 else {
2207 r = m - 1;
2208 }
2209 }
2210 if (l >= size) {
2211 return &insns_info[size-1];
2212 }
2213 if (positions[l] > pos) {
2214 return &insns_info[l-1];
2215 }
2216 return &insns_info[l];
2217 }
2218}
2219
2220static const struct iseq_insn_info_entry *
2221get_insn_info(const rb_iseq_t *iseq, size_t pos)
2222{
2223 return get_insn_info_binary_search(iseq, pos);
2224}
2225#endif
2226
2227#if VM_INSN_INFO_TABLE_IMPL == 2 /* succinct bitvector */
2228static const struct iseq_insn_info_entry *
2229get_insn_info_succinct_bitvector(const rb_iseq_t *iseq, size_t pos)
2230{
2231 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2232 size_t size = body->insns_info.size;
2233 const struct iseq_insn_info_entry *insns_info = body->insns_info.body;
2234 const int debug = 0;
2235
2236 if (debug) {
2237#if VM_CHECK_MODE > 0
2238 const unsigned int *positions = body->insns_info.positions;
2239 printf("size: %"PRIuSIZE"\n", size);
2240 printf("insns_info[%"PRIuSIZE"]: position: %d, line: %d, pos: %"PRIuSIZE"\n",
2241 (size_t)0, positions[0], insns_info[0].line_no, pos);
2242#else
2243 printf("size: %"PRIuSIZE"\n", size);
2244 printf("insns_info[%"PRIuSIZE"]: line: %d, pos: %"PRIuSIZE"\n",
2245 (size_t)0, insns_info[0].line_no, pos);
2246#endif
2247 }
2248
2249 if (size == 0) {
2250 return NULL;
2251 }
2252 else if (size == 1) {
2253 return &insns_info[0];
2254 }
2255 else {
2256 int index;
2257 VM_ASSERT(body->insns_info.succ_index_table != NULL);
2258 index = succ_index_lookup(body->insns_info.succ_index_table, (int)pos);
2259 return &insns_info[index-1];
2260 }
2261}
2262
2263static const struct iseq_insn_info_entry *
2264get_insn_info(const rb_iseq_t *iseq, size_t pos)
2265{
2266 return get_insn_info_succinct_bitvector(iseq, pos);
2267}
2268#endif
2269
2270#if VM_CHECK_MODE > 0 || VM_INSN_INFO_TABLE_IMPL == 0
2271static const struct iseq_insn_info_entry *
2272get_insn_info_linear_search(const rb_iseq_t *iseq, size_t pos)
2273{
2274 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2275 size_t i = 0, size = body->insns_info.size;
2276 const struct iseq_insn_info_entry *insns_info = body->insns_info.body;
2277 const unsigned int *positions = body->insns_info.positions;
2278 const int debug = 0;
2279
2280 if (debug) {
2281 printf("size: %"PRIuSIZE"\n", size);
2282 printf("insns_info[%"PRIuSIZE"]: position: %d, line: %d, pos: %"PRIuSIZE"\n",
2283 i, positions[i], insns_info[i].line_no, pos);
2284 }
2285
2286 if (size == 0) {
2287 return NULL;
2288 }
2289 else if (size == 1) {
2290 return &insns_info[0];
2291 }
2292 else {
2293 for (i=1; i<size; i++) {
2294 if (debug) printf("insns_info[%"PRIuSIZE"]: position: %d, line: %d, pos: %"PRIuSIZE"\n",
2295 i, positions[i], insns_info[i].line_no, pos);
2296
2297 if (positions[i] == pos) {
2298 return &insns_info[i];
2299 }
2300 if (positions[i] > pos) {
2301 return &insns_info[i-1];
2302 }
2303 }
2304 }
2305 return &insns_info[i-1];
2306}
2307#endif
2308
2309#if VM_INSN_INFO_TABLE_IMPL == 0 /* linear search */
2310static const struct iseq_insn_info_entry *
2311get_insn_info(const rb_iseq_t *iseq, size_t pos)
2312{
2313 return get_insn_info_linear_search(iseq, pos);
2314}
2315#endif
2316
2317#if VM_CHECK_MODE > 0 && VM_INSN_INFO_TABLE_IMPL > 0
2318static void
2319validate_get_insn_info(const rb_iseq_t *iseq)
2320{
2321 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2322 size_t i;
2323 for (i = 0; i < body->iseq_size; i++) {
2324 if (get_insn_info_linear_search(iseq, i) != get_insn_info(iseq, i)) {
2325 rb_bug("validate_get_insn_info: get_insn_info_linear_search(iseq, %"PRIuSIZE") != get_insn_info(iseq, %"PRIuSIZE")", i, i);
2326 }
2327 }
2328}
2329#endif
2330
2331unsigned int
2332rb_iseq_line_no(const rb_iseq_t *iseq, size_t pos)
2333{
2334 const struct iseq_insn_info_entry *entry = get_insn_info(iseq, pos);
2335
2336 if (entry) {
2337 return entry->line_no;
2338 }
2339 else {
2340 return 0;
2341 }
2342}
2343
2344#ifdef USE_ISEQ_NODE_ID
2345int
2346rb_iseq_node_id(const rb_iseq_t *iseq, size_t pos)
2347{
2348 const struct iseq_insn_info_entry *entry = get_insn_info(iseq, pos);
2349
2350 if (entry) {
2351 return entry->node_id;
2352 }
2353 else {
2354 return 0;
2355 }
2356}
2357#endif
2358
2360rb_iseq_event_flags(const rb_iseq_t *iseq, size_t pos)
2361{
2362 const struct iseq_insn_info_entry *entry = get_insn_info(iseq, pos);
2363 if (entry) {
2364 return entry->events;
2365 }
2366 else {
2367 return 0;
2368 }
2369}
2370
2371void
2372rb_iseq_clear_event_flags(const rb_iseq_t *iseq, size_t pos, rb_event_flag_t reset)
2373{
2374 struct iseq_insn_info_entry *entry = (struct iseq_insn_info_entry *)get_insn_info(iseq, pos);
2375 if (entry) {
2376 entry->events &= ~reset;
2377 if (!(entry->events & iseq->aux.exec.global_trace_events)) {
2378 void rb_iseq_trace_flag_cleared(const rb_iseq_t *iseq, size_t pos);
2379 rb_iseq_trace_flag_cleared(iseq, pos);
2380 }
2381 }
2382}
2383
2384static VALUE
2385local_var_name(const rb_iseq_t *diseq, VALUE level, VALUE op)
2386{
2387 VALUE i;
2388 VALUE name;
2389 ID lid;
2390 int idx;
2391
2392 for (i = 0; i < level; i++) {
2393 diseq = ISEQ_BODY(diseq)->parent_iseq;
2394 }
2395 idx = ISEQ_BODY(diseq)->local_table_size - (int)op - 1;
2396 lid = ISEQ_BODY(diseq)->local_table[idx];
2397 name = rb_id2str(lid);
2398 if (!name) {
2399 name = rb_str_new_cstr("?");
2400 }
2401 else if (!rb_is_local_id(lid)) {
2402 name = rb_str_inspect(name);
2403 }
2404 else {
2405 name = rb_str_dup(name);
2406 }
2407 rb_str_catf(name, "@%d", idx);
2408 return name;
2409}
2410
2411int rb_insn_unified_local_var_level(VALUE);
2412VALUE rb_dump_literal(VALUE lit);
2413
2414VALUE
2415rb_insn_operand_intern(const rb_iseq_t *iseq,
2416 VALUE insn, int op_no, VALUE op,
2417 int len, size_t pos, const VALUE *pnop, VALUE child)
2418{
2419 const char *types = insn_op_types(insn);
2420 char type = types[op_no];
2421 VALUE ret = Qundef;
2422
2423 switch (type) {
2424 case TS_OFFSET: /* LONG */
2425 ret = rb_sprintf("%"PRIdVALUE, (VALUE)(pos + len + op));
2426 break;
2427
2428 case TS_NUM: /* ULONG */
2429 if (insn == BIN(defined) && op_no == 0) {
2430 enum defined_type deftype = (enum defined_type)op;
2431 switch (deftype) {
2432 case DEFINED_FUNC:
2433 ret = rb_fstring_lit("func");
2434 break;
2435 case DEFINED_REF:
2436 ret = rb_fstring_lit("ref");
2437 break;
2438 case DEFINED_CONST_FROM:
2439 ret = rb_fstring_lit("constant-from");
2440 break;
2441 default:
2442 ret = rb_iseq_defined_string(deftype);
2443 break;
2444 }
2445 if (ret) break;
2446 }
2447 else if (insn == BIN(checktype) && op_no == 0) {
2448 const char *type_str = rb_type_str((enum ruby_value_type)op);
2449 if (type_str) {
2450 ret = rb_str_new_cstr(type_str); break;
2451 }
2452 }
2453 ret = rb_sprintf("%"PRIuVALUE, op);
2454 break;
2455
2456 case TS_LINDEX:{
2457 int level;
2458 if (types[op_no+1] == TS_NUM && pnop) {
2459 ret = local_var_name(iseq, *pnop, op - VM_ENV_DATA_SIZE);
2460 }
2461 else if ((level = rb_insn_unified_local_var_level(insn)) >= 0) {
2462 ret = local_var_name(iseq, (VALUE)level, op - VM_ENV_DATA_SIZE);
2463 }
2464 else {
2465 ret = rb_inspect(INT2FIX(op));
2466 }
2467 break;
2468 }
2469 case TS_ID: /* ID (symbol) */
2470 ret = rb_inspect(ID2SYM(op));
2471 break;
2472
2473 case TS_VALUE: /* VALUE */
2474 op = obj_resurrect(op);
2475 if (insn == BIN(defined) && op_no == 1 && FIXNUM_P(op)) {
2476 /* should be DEFINED_REF */
2477 int type = NUM2INT(op);
2478 if (type) {
2479 if (type & 1) {
2480 ret = rb_sprintf(":$%c", (type >> 1));
2481 }
2482 else {
2483 ret = rb_sprintf(":$%d", (type >> 1));
2484 }
2485 break;
2486 }
2487 }
2488 ret = rb_dump_literal(op);
2489 if (CLASS_OF(op) == rb_cISeq) {
2490 if (child) {
2491 rb_ary_push(child, op);
2492 }
2493 }
2494 break;
2495
2496 case TS_ISEQ: /* iseq */
2497 {
2498 if (op) {
2499 const rb_iseq_t *iseq = rb_iseq_check((rb_iseq_t *)op);
2500 ret = ISEQ_BODY(iseq)->location.label;
2501 if (child) {
2502 rb_ary_push(child, (VALUE)iseq);
2503 }
2504 }
2505 else {
2506 ret = rb_str_new2("nil");
2507 }
2508 break;
2509 }
2510
2511 case TS_IC:
2512 {
2513 ret = rb_sprintf("<ic:%"PRIdPTRDIFF" ", (union iseq_inline_storage_entry *)op - ISEQ_BODY(iseq)->is_entries);
2514 const ID *segments = ((IC)op)->segments;
2515 rb_str_cat2(ret, rb_id2name(*segments++));
2516 while (*segments) {
2517 rb_str_catf(ret, "::%s", rb_id2name(*segments++));
2518 }
2519 rb_str_cat2(ret, ">");
2520 }
2521 break;
2522 case TS_IVC:
2523 case TS_ICVARC:
2524 case TS_ISE:
2525 ret = rb_sprintf("<is:%"PRIdPTRDIFF">", (union iseq_inline_storage_entry *)op - ISEQ_BODY(iseq)->is_entries);
2526 break;
2527
2528 case TS_CALLDATA:
2529 {
2530 struct rb_call_data *cd = (struct rb_call_data *)op;
2531 const struct rb_callinfo *ci = cd->ci;
2532 VALUE ary = rb_ary_new();
2533 ID mid = vm_ci_mid(ci);
2534
2535 if (mid) {
2536 rb_ary_push(ary, rb_sprintf("mid:%"PRIsVALUE, rb_id2str(mid)));
2537 }
2538
2539 rb_ary_push(ary, rb_sprintf("argc:%d", vm_ci_argc(ci)));
2540
2541 if (vm_ci_flag(ci) & VM_CALL_KWARG) {
2542 const struct rb_callinfo_kwarg *kw_args = vm_ci_kwarg(ci);
2543 VALUE kw_ary = rb_ary_new_from_values(kw_args->keyword_len, kw_args->keywords);
2544 rb_ary_push(ary, rb_sprintf("kw:[%"PRIsVALUE"]", rb_ary_join(kw_ary, rb_str_new2(","))));
2545 }
2546
2547 if (vm_ci_flag(ci)) {
2548 VALUE flags = rb_ary_new();
2549# define CALL_FLAG(n) if (vm_ci_flag(ci) & VM_CALL_##n) rb_ary_push(flags, rb_str_new2(#n))
2550 CALL_FLAG(ARGS_SPLAT);
2551 CALL_FLAG(ARGS_SPLAT_MUT);
2552 CALL_FLAG(ARGS_BLOCKARG);
2553 CALL_FLAG(FCALL);
2554 CALL_FLAG(VCALL);
2555 CALL_FLAG(ARGS_SIMPLE);
2556 CALL_FLAG(TAILCALL);
2557 CALL_FLAG(SUPER);
2558 CALL_FLAG(ZSUPER);
2559 CALL_FLAG(KWARG);
2560 CALL_FLAG(KW_SPLAT);
2561 CALL_FLAG(KW_SPLAT_MUT);
2562 CALL_FLAG(FORWARDING);
2563 CALL_FLAG(OPT_SEND); /* maybe not reachable */
2564 rb_ary_push(ary, rb_ary_join(flags, rb_str_new2("|")));
2565 }
2566
2567 ret = rb_sprintf("<calldata!%"PRIsVALUE">", rb_ary_join(ary, rb_str_new2(", ")));
2568 }
2569 break;
2570
2571 case TS_CDHASH:
2572 ret = rb_str_new2("<cdhash>");
2573 break;
2574
2575 case TS_FUNCPTR:
2576 {
2577#ifdef HAVE_DLADDR
2578 Dl_info info;
2579 if (dladdr((void *)op, &info) && info.dli_sname) {
2580 ret = rb_str_new_cstr(info.dli_sname);
2581 break;
2582 }
2583#endif
2584 ret = rb_str_new2("<funcptr>");
2585 }
2586 break;
2587
2588 case TS_BUILTIN:
2589 {
2590 const struct rb_builtin_function *bf = (const struct rb_builtin_function *)op;
2591 ret = rb_sprintf("<builtin!%s/%d>",
2592 bf->name, bf->argc);
2593 }
2594 break;
2595
2596 default:
2597 rb_bug("unknown operand type: %c", type);
2598 }
2599 return ret;
2600}
2601
2602static VALUE
2603right_strip(VALUE str)
2604{
2605 const char *beg = RSTRING_PTR(str), *end = RSTRING_END(str);
2606 while (end-- > beg && *end == ' ');
2607 rb_str_set_len(str, end - beg + 1);
2608 return str;
2609}
2610
2615int
2616rb_iseq_disasm_insn(VALUE ret, const VALUE *code, size_t pos,
2617 const rb_iseq_t *iseq, VALUE child)
2618{
2619 VALUE insn = code[pos];
2620 int len = insn_len(insn);
2621 int j;
2622 const char *types = insn_op_types(insn);
2623 VALUE str = rb_str_new(0, 0);
2624 const char *insn_name_buff;
2625
2626 insn_name_buff = insn_name(insn);
2627 if (1) {
2628 extern const int rb_vm_max_insn_name_size;
2629 rb_str_catf(str, "%04"PRIuSIZE" %-*s ", pos, rb_vm_max_insn_name_size, insn_name_buff);
2630 }
2631 else {
2632 rb_str_catf(str, "%04"PRIuSIZE" %-28.*s ", pos,
2633 (int)strcspn(insn_name_buff, "_"), insn_name_buff);
2634 }
2635
2636 for (j = 0; types[j]; j++) {
2637 VALUE opstr = rb_insn_operand_intern(iseq, insn, j, code[pos + j + 1],
2638 len, pos, &code[pos + j + 2],
2639 child);
2640 rb_str_concat(str, opstr);
2641
2642 if (types[j + 1]) {
2643 rb_str_cat2(str, ", ");
2644 }
2645 }
2646
2647 {
2648 unsigned int line_no = rb_iseq_line_no(iseq, pos);
2649 unsigned int prev = pos == 0 ? 0 : rb_iseq_line_no(iseq, pos - 1);
2650 if (line_no && line_no != prev) {
2651 long slen = RSTRING_LEN(str);
2652 slen = (slen > 70) ? 0 : (70 - slen);
2653 str = rb_str_catf(str, "%*s(%4d)", (int)slen, "", line_no);
2654 }
2655 }
2656
2657 {
2658 rb_event_flag_t events = rb_iseq_event_flags(iseq, pos);
2659 if (events) {
2660 str = rb_str_catf(str, "[%s%s%s%s%s%s%s%s%s%s%s%s]",
2661 events & RUBY_EVENT_LINE ? "Li" : "",
2662 events & RUBY_EVENT_CLASS ? "Cl" : "",
2663 events & RUBY_EVENT_END ? "En" : "",
2664 events & RUBY_EVENT_CALL ? "Ca" : "",
2665 events & RUBY_EVENT_RETURN ? "Re" : "",
2666 events & RUBY_EVENT_C_CALL ? "Cc" : "",
2667 events & RUBY_EVENT_C_RETURN ? "Cr" : "",
2668 events & RUBY_EVENT_B_CALL ? "Bc" : "",
2669 events & RUBY_EVENT_B_RETURN ? "Br" : "",
2670 events & RUBY_EVENT_RESCUE ? "Rs" : "",
2671 events & RUBY_EVENT_COVERAGE_LINE ? "Cli" : "",
2672 events & RUBY_EVENT_COVERAGE_BRANCH ? "Cbr" : "");
2673 }
2674 }
2675
2676 right_strip(str);
2677 if (ret) {
2678 rb_str_cat2(str, "\n");
2679 rb_str_concat(ret, str);
2680 }
2681 else {
2682 printf("%.*s\n", (int)RSTRING_LEN(str), RSTRING_PTR(str));
2683 }
2684 return len;
2685}
2686
2687static const char *
2688catch_type(int type)
2689{
2690 switch (type) {
2691 case CATCH_TYPE_RESCUE:
2692 return "rescue";
2693 case CATCH_TYPE_ENSURE:
2694 return "ensure";
2695 case CATCH_TYPE_RETRY:
2696 return "retry";
2697 case CATCH_TYPE_BREAK:
2698 return "break";
2699 case CATCH_TYPE_REDO:
2700 return "redo";
2701 case CATCH_TYPE_NEXT:
2702 return "next";
2703 default:
2704 rb_bug("unknown catch type: %d", type);
2705 return 0;
2706 }
2707}
2708
2709static VALUE
2710iseq_inspect(const rb_iseq_t *iseq)
2711{
2712 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2713 if (!body->location.label) {
2714 return rb_sprintf("#<ISeq: uninitialized>");
2715 }
2716 else {
2717 const rb_code_location_t *loc = &body->location.code_location;
2718 return rb_sprintf("#<ISeq:%"PRIsVALUE"@%"PRIsVALUE":%d (%d,%d)-(%d,%d)>",
2719 body->location.label, rb_iseq_path(iseq),
2720 loc->beg_pos.lineno,
2721 loc->beg_pos.lineno,
2722 loc->beg_pos.column,
2723 loc->end_pos.lineno,
2724 loc->end_pos.column);
2725 }
2726}
2727
2728static const rb_data_type_t tmp_set = {
2729 "tmpset",
2730 {(void (*)(void *))rb_mark_set, (void (*)(void *))st_free_table, 0, 0,},
2731 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
2732};
2733
2734static VALUE
2735rb_iseq_disasm_recursive(const rb_iseq_t *iseq, VALUE indent)
2736{
2737 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2738 VALUE *code;
2739 VALUE str = rb_str_new(0, 0);
2740 VALUE child = rb_ary_hidden_new(3);
2741 unsigned int size;
2742 unsigned int i;
2743 long l;
2744 size_t n;
2745 enum {header_minlen = 72};
2746 st_table *done_iseq = 0;
2747 VALUE done_iseq_wrapper = Qnil;
2748 const char *indent_str;
2749 long indent_len;
2750
2751 size = body->iseq_size;
2752
2753 indent_len = RSTRING_LEN(indent);
2754 indent_str = RSTRING_PTR(indent);
2755
2756 rb_str_cat(str, indent_str, indent_len);
2757 rb_str_cat2(str, "== disasm: ");
2758
2759 rb_str_append(str, iseq_inspect(iseq));
2760 if ((l = RSTRING_LEN(str) - indent_len) < header_minlen) {
2761 rb_str_modify_expand(str, header_minlen - l);
2762 memset(RSTRING_END(str), '=', header_minlen - l);
2763 }
2764 if (iseq->body->builtin_attrs) {
2765#define disasm_builtin_attr(str, iseq, attr) \
2766 if (iseq->body->builtin_attrs & BUILTIN_ATTR_ ## attr) { \
2767 rb_str_cat2(str, " " #attr); \
2768 }
2769 disasm_builtin_attr(str, iseq, LEAF);
2770 disasm_builtin_attr(str, iseq, SINGLE_NOARG_LEAF);
2771 disasm_builtin_attr(str, iseq, INLINE_BLOCK);
2772 disasm_builtin_attr(str, iseq, C_TRACE);
2773 }
2774 rb_str_cat2(str, "\n");
2775
2776 /* show catch table information */
2777 if (body->catch_table) {
2778 rb_str_cat(str, indent_str, indent_len);
2779 rb_str_cat2(str, "== catch table\n");
2780 }
2781 if (body->catch_table) {
2782 rb_str_cat_cstr(indent, "| ");
2783 indent_str = RSTRING_PTR(indent);
2784 for (i = 0; i < body->catch_table->size; i++) {
2785 const struct iseq_catch_table_entry *entry =
2786 UNALIGNED_MEMBER_PTR(body->catch_table, entries[i]);
2787 rb_str_cat(str, indent_str, indent_len);
2788 rb_str_catf(str,
2789 "| catch type: %-6s st: %04d ed: %04d sp: %04d cont: %04d\n",
2790 catch_type((int)entry->type), (int)entry->start,
2791 (int)entry->end, (int)entry->sp, (int)entry->cont);
2792 if (entry->iseq && !(done_iseq && st_is_member(done_iseq, (st_data_t)entry->iseq))) {
2793 rb_str_concat(str, rb_iseq_disasm_recursive(rb_iseq_check(entry->iseq), indent));
2794 if (!done_iseq) {
2795 done_iseq = st_init_numtable();
2796 done_iseq_wrapper = TypedData_Wrap_Struct(0, &tmp_set, done_iseq);
2797 }
2798 st_insert(done_iseq, (st_data_t)entry->iseq, (st_data_t)0);
2799 indent_str = RSTRING_PTR(indent);
2800 }
2801 }
2802 rb_str_resize(indent, indent_len);
2803 indent_str = RSTRING_PTR(indent);
2804 }
2805 if (body->catch_table) {
2806 rb_str_cat(str, indent_str, indent_len);
2807 rb_str_cat2(str, "|-------------------------------------"
2808 "-----------------------------------\n");
2809 }
2810
2811 /* show local table information */
2812 if (body->local_table) {
2813 const struct rb_iseq_param_keyword *const keyword = body->param.keyword;
2814 rb_str_cat(str, indent_str, indent_len);
2815 rb_str_catf(str,
2816 "local table (size: %d, argc: %d "
2817 "[opts: %d, rest: %d, post: %d, block: %d, kw: %d@%d, kwrest: %d])\n",
2818 body->local_table_size,
2819 body->param.lead_num,
2820 body->param.opt_num,
2821 body->param.flags.has_rest ? body->param.rest_start : -1,
2822 body->param.post_num,
2823 body->param.flags.has_block ? body->param.block_start : -1,
2824 body->param.flags.has_kw ? keyword->num : -1,
2825 body->param.flags.has_kw ? keyword->required_num : -1,
2826 body->param.flags.has_kwrest ? keyword->rest_start : -1);
2827
2828 for (i = body->local_table_size; i > 0;) {
2829 int li = body->local_table_size - --i - 1;
2830 long width;
2831 VALUE name = local_var_name(iseq, 0, i);
2832 char argi[0x100];
2833 char opti[0x100];
2834
2835 opti[0] = '\0';
2836 if (body->param.flags.has_opt) {
2837 int argc = body->param.lead_num;
2838 int opts = body->param.opt_num;
2839 if (li >= argc && li < argc + opts) {
2840 snprintf(opti, sizeof(opti), "Opt=%"PRIdVALUE,
2841 body->param.opt_table[li - argc]);
2842 }
2843 }
2844
2845 snprintf(argi, sizeof(argi), "%s%s%s%s%s%s", /* arg, opts, rest, post, kwrest, block */
2846 (body->param.lead_num > li) ? (body->param.flags.ambiguous_param0 ? "AmbiguousArg" : "Arg") : "",
2847 opti,
2848 (body->param.flags.has_rest && body->param.rest_start == li) ? (body->param.flags.anon_rest ? "AnonRest" : "Rest") : "",
2849 (body->param.flags.has_post && body->param.post_start <= li && li < body->param.post_start + body->param.post_num) ? "Post" : "",
2850 (body->param.flags.has_kwrest && keyword->rest_start == li) ? (body->param.flags.anon_kwrest ? "AnonKwrest" : "Kwrest") : "",
2851 (body->param.flags.has_block && body->param.block_start == li) ? "Block" : "");
2852
2853 rb_str_cat(str, indent_str, indent_len);
2854 rb_str_catf(str, "[%2d] ", i + 1);
2855 width = RSTRING_LEN(str) + 11;
2856 rb_str_append(str, name);
2857 if (*argi) rb_str_catf(str, "<%s>", argi);
2858 if ((width -= RSTRING_LEN(str)) > 0) rb_str_catf(str, "%*s", (int)width, "");
2859 }
2860 rb_str_cat_cstr(right_strip(str), "\n");
2861 }
2862
2863 /* show each line */
2864 code = rb_iseq_original_iseq(iseq);
2865 for (n = 0; n < size;) {
2866 rb_str_cat(str, indent_str, indent_len);
2867 n += rb_iseq_disasm_insn(str, code, n, iseq, child);
2868 }
2869
2870 for (l = 0; l < RARRAY_LEN(child); l++) {
2871 VALUE isv = rb_ary_entry(child, l);
2872 if (done_iseq && st_is_member(done_iseq, (st_data_t)isv)) continue;
2873 rb_str_cat_cstr(str, "\n");
2874 rb_str_concat(str, rb_iseq_disasm_recursive(rb_iseq_check((rb_iseq_t *)isv), indent));
2875 indent_str = RSTRING_PTR(indent);
2876 }
2877 RB_GC_GUARD(done_iseq_wrapper);
2878
2879 return str;
2880}
2881
2882VALUE
2883rb_iseq_disasm(const rb_iseq_t *iseq)
2884{
2885 VALUE str = rb_iseq_disasm_recursive(iseq, rb_str_new(0, 0));
2886 rb_str_resize(str, RSTRING_LEN(str));
2887 return str;
2888}
2889
2890/*
2891 * Estimates the number of instance variables that will be set on
2892 * a given `class` with the initialize method defined in
2893 * `initialize_iseq`
2894 */
2895attr_index_t
2896rb_estimate_iv_count(VALUE klass, const rb_iseq_t * initialize_iseq)
2897{
2898 struct rb_id_table * iv_names = rb_id_table_create(0);
2899
2900 for (unsigned int i = 0; i < ISEQ_BODY(initialize_iseq)->ivc_size; i++) {
2901 IVC cache = (IVC)&ISEQ_BODY(initialize_iseq)->is_entries[i];
2902
2903 if (cache->iv_set_name) {
2904 rb_id_table_insert(iv_names, cache->iv_set_name, Qtrue);
2905 }
2906 }
2907
2908 attr_index_t count = (attr_index_t)rb_id_table_size(iv_names);
2909
2910 VALUE superclass = rb_class_superclass(klass);
2911 count += RCLASS_EXT(superclass)->max_iv_count;
2912
2913 rb_id_table_free(iv_names);
2914
2915 return count;
2916}
2917
2918/*
2919 * call-seq:
2920 * iseq.disasm -> str
2921 * iseq.disassemble -> str
2922 *
2923 * Returns the instruction sequence as a +String+ in human readable form.
2924 *
2925 * puts RubyVM::InstructionSequence.compile('1 + 2').disasm
2926 *
2927 * Produces:
2928 *
2929 * == disasm: <RubyVM::InstructionSequence:<compiled>@<compiled>>==========
2930 * 0000 trace 1 ( 1)
2931 * 0002 putobject 1
2932 * 0004 putobject 2
2933 * 0006 opt_plus <ic:1>
2934 * 0008 leave
2935 */
2936static VALUE
2937iseqw_disasm(VALUE self)
2938{
2939 return rb_iseq_disasm(iseqw_check(self));
2940}
2941
2942static int
2943iseq_iterate_children(const rb_iseq_t *iseq, void (*iter_func)(const rb_iseq_t *child_iseq, void *data), void *data)
2944{
2945 unsigned int i;
2946 VALUE *code = rb_iseq_original_iseq(iseq);
2947 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2948 const rb_iseq_t *child;
2949 VALUE all_children = rb_obj_hide(rb_ident_hash_new());
2950
2951 if (body->catch_table) {
2952 for (i = 0; i < body->catch_table->size; i++) {
2953 const struct iseq_catch_table_entry *entry =
2954 UNALIGNED_MEMBER_PTR(body->catch_table, entries[i]);
2955 child = entry->iseq;
2956 if (child) {
2957 if (NIL_P(rb_hash_aref(all_children, (VALUE)child))) {
2958 rb_hash_aset(all_children, (VALUE)child, Qtrue);
2959 (*iter_func)(child, data);
2960 }
2961 }
2962 }
2963 }
2964
2965 for (i=0; i<body->iseq_size;) {
2966 VALUE insn = code[i];
2967 int len = insn_len(insn);
2968 const char *types = insn_op_types(insn);
2969 int j;
2970
2971 for (j=0; types[j]; j++) {
2972 switch (types[j]) {
2973 case TS_ISEQ:
2974 child = (const rb_iseq_t *)code[i+j+1];
2975 if (child) {
2976 if (NIL_P(rb_hash_aref(all_children, (VALUE)child))) {
2977 rb_hash_aset(all_children, (VALUE)child, Qtrue);
2978 (*iter_func)(child, data);
2979 }
2980 }
2981 break;
2982 default:
2983 break;
2984 }
2985 }
2986 i += len;
2987 }
2988
2989 return (int)RHASH_SIZE(all_children);
2990}
2991
2992static void
2993yield_each_children(const rb_iseq_t *child_iseq, void *data)
2994{
2995 rb_yield(iseqw_new(child_iseq));
2996}
2997
2998/*
2999 * call-seq:
3000 * iseq.each_child{|child_iseq| ...} -> iseq
3001 *
3002 * Iterate all direct child instruction sequences.
3003 * Iteration order is implementation/version defined
3004 * so that people should not rely on the order.
3005 */
3006static VALUE
3007iseqw_each_child(VALUE self)
3008{
3009 const rb_iseq_t *iseq = iseqw_check(self);
3010 iseq_iterate_children(iseq, yield_each_children, NULL);
3011 return self;
3012}
3013
3014static void
3015push_event_info(const rb_iseq_t *iseq, rb_event_flag_t events, int line, VALUE ary)
3016{
3017#define C(ev, cstr, l) if (events & ev) rb_ary_push(ary, rb_ary_new_from_args(2, l, ID2SYM(rb_intern(cstr))));
3018 C(RUBY_EVENT_CLASS, "class", rb_iseq_first_lineno(iseq));
3019 C(RUBY_EVENT_CALL, "call", rb_iseq_first_lineno(iseq));
3020 C(RUBY_EVENT_B_CALL, "b_call", rb_iseq_first_lineno(iseq));
3021 C(RUBY_EVENT_LINE, "line", INT2FIX(line));
3022 C(RUBY_EVENT_END, "end", INT2FIX(line));
3023 C(RUBY_EVENT_RETURN, "return", INT2FIX(line));
3024 C(RUBY_EVENT_B_RETURN, "b_return", INT2FIX(line));
3025 C(RUBY_EVENT_RESCUE, "rescue", INT2FIX(line));
3026#undef C
3027}
3028
3029/*
3030 * call-seq:
3031 * iseq.trace_points -> ary
3032 *
3033 * Return trace points in the instruction sequence.
3034 * Return an array of [line, event_symbol] pair.
3035 */
3036static VALUE
3037iseqw_trace_points(VALUE self)
3038{
3039 const rb_iseq_t *iseq = iseqw_check(self);
3040 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3041 unsigned int i;
3042 VALUE ary = rb_ary_new();
3043
3044 for (i=0; i<body->insns_info.size; i++) {
3045 const struct iseq_insn_info_entry *entry = &body->insns_info.body[i];
3046 if (entry->events) {
3047 push_event_info(iseq, entry->events, entry->line_no, ary);
3048 }
3049 }
3050 return ary;
3051}
3052
3053/*
3054 * Returns the instruction sequence containing the given proc or method.
3055 *
3056 * For example, using irb:
3057 *
3058 * # a proc
3059 * > p = proc { num = 1 + 2 }
3060 * > RubyVM::InstructionSequence.of(p)
3061 * > #=> <RubyVM::InstructionSequence:block in irb_binding@(irb)>
3062 *
3063 * # for a method
3064 * > def foo(bar); puts bar; end
3065 * > RubyVM::InstructionSequence.of(method(:foo))
3066 * > #=> <RubyVM::InstructionSequence:foo@(irb)>
3067 *
3068 * Using ::compile_file:
3069 *
3070 * # /tmp/iseq_of.rb
3071 * def hello
3072 * puts "hello, world"
3073 * end
3074 *
3075 * $a_global_proc = proc { str = 'a' + 'b' }
3076 *
3077 * # in irb
3078 * > require '/tmp/iseq_of.rb'
3079 *
3080 * # first the method hello
3081 * > RubyVM::InstructionSequence.of(method(:hello))
3082 * > #=> #<RubyVM::InstructionSequence:0x007fb73d7cb1d0>
3083 *
3084 * # then the global proc
3085 * > RubyVM::InstructionSequence.of($a_global_proc)
3086 * > #=> #<RubyVM::InstructionSequence:0x007fb73d7caf78>
3087 */
3088static VALUE
3089iseqw_s_of(VALUE klass, VALUE body)
3090{
3091 const rb_iseq_t *iseq = NULL;
3092
3093 if (rb_frame_info_p(body)) {
3094 iseq = rb_get_iseq_from_frame_info(body);
3095 }
3096 else if (rb_obj_is_proc(body)) {
3097 iseq = vm_proc_iseq(body);
3098
3099 if (!rb_obj_is_iseq((VALUE)iseq)) {
3100 iseq = NULL;
3101 }
3102 }
3103 else if (rb_obj_is_method(body)) {
3104 iseq = rb_method_iseq(body);
3105 }
3106 else if (rb_typeddata_is_instance_of(body, &iseqw_data_type)) {
3107 return body;
3108 }
3109
3110 return iseq ? iseqw_new(iseq) : Qnil;
3111}
3112
3113/*
3114 * call-seq:
3115 * InstructionSequence.disasm(body) -> str
3116 * InstructionSequence.disassemble(body) -> str
3117 *
3118 * Takes +body+, a Method or Proc object, and returns a String with the
3119 * human readable instructions for +body+.
3120 *
3121 * For a Method object:
3122 *
3123 * # /tmp/method.rb
3124 * def hello
3125 * puts "hello, world"
3126 * end
3127 *
3128 * puts RubyVM::InstructionSequence.disasm(method(:hello))
3129 *
3130 * Produces:
3131 *
3132 * == disasm: <RubyVM::InstructionSequence:hello@/tmp/method.rb>============
3133 * 0000 trace 8 ( 1)
3134 * 0002 trace 1 ( 2)
3135 * 0004 putself
3136 * 0005 putstring "hello, world"
3137 * 0007 send :puts, 1, nil, 8, <ic:0>
3138 * 0013 trace 16 ( 3)
3139 * 0015 leave ( 2)
3140 *
3141 * For a Proc:
3142 *
3143 * # /tmp/proc.rb
3144 * p = proc { num = 1 + 2 }
3145 * puts RubyVM::InstructionSequence.disasm(p)
3146 *
3147 * Produces:
3148 *
3149 * == disasm: <RubyVM::InstructionSequence:block in <main>@/tmp/proc.rb>===
3150 * == catch table
3151 * | catch type: redo st: 0000 ed: 0012 sp: 0000 cont: 0000
3152 * | catch type: next st: 0000 ed: 0012 sp: 0000 cont: 0012
3153 * |------------------------------------------------------------------------
3154 * local table (size: 2, argc: 0 [opts: 0, rest: -1, post: 0, block: -1] s1)
3155 * [ 2] num
3156 * 0000 trace 1 ( 1)
3157 * 0002 putobject 1
3158 * 0004 putobject 2
3159 * 0006 opt_plus <ic:1>
3160 * 0008 dup
3161 * 0009 setlocal num, 0
3162 * 0012 leave
3163 *
3164 */
3165static VALUE
3166iseqw_s_disasm(VALUE klass, VALUE body)
3167{
3168 VALUE iseqw = iseqw_s_of(klass, body);
3169 return NIL_P(iseqw) ? Qnil : rb_iseq_disasm(iseqw_check(iseqw));
3170}
3171
3172static VALUE
3173register_label(struct st_table *table, unsigned long idx)
3174{
3175 VALUE sym = rb_str_intern(rb_sprintf("label_%lu", idx));
3176 st_insert(table, idx, sym);
3177 return sym;
3178}
3179
3180static VALUE
3181exception_type2symbol(VALUE type)
3182{
3183 ID id;
3184 switch (type) {
3185 case CATCH_TYPE_RESCUE: CONST_ID(id, "rescue"); break;
3186 case CATCH_TYPE_ENSURE: CONST_ID(id, "ensure"); break;
3187 case CATCH_TYPE_RETRY: CONST_ID(id, "retry"); break;
3188 case CATCH_TYPE_BREAK: CONST_ID(id, "break"); break;
3189 case CATCH_TYPE_REDO: CONST_ID(id, "redo"); break;
3190 case CATCH_TYPE_NEXT: CONST_ID(id, "next"); break;
3191 default:
3192 rb_bug("unknown exception type: %d", (int)type);
3193 }
3194 return ID2SYM(id);
3195}
3196
3197static int
3198cdhash_each(VALUE key, VALUE value, VALUE ary)
3199{
3200 rb_ary_push(ary, obj_resurrect(key));
3201 rb_ary_push(ary, value);
3202 return ST_CONTINUE;
3203}
3204
3205static const rb_data_type_t label_wrapper = {
3206 "label_wrapper",
3207 {(void (*)(void *))rb_mark_tbl, (void (*)(void *))st_free_table, 0, 0,},
3208 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3209};
3210
3211#define DECL_ID(name) \
3212 static ID id_##name
3213
3214#define INIT_ID(name) \
3215 id_##name = rb_intern(#name)
3216
3217static VALUE
3218iseq_type_id(enum rb_iseq_type type)
3219{
3220 DECL_ID(top);
3221 DECL_ID(method);
3222 DECL_ID(block);
3223 DECL_ID(class);
3224 DECL_ID(rescue);
3225 DECL_ID(ensure);
3226 DECL_ID(eval);
3227 DECL_ID(main);
3228 DECL_ID(plain);
3229
3230 if (id_top == 0) {
3231 INIT_ID(top);
3232 INIT_ID(method);
3233 INIT_ID(block);
3234 INIT_ID(class);
3235 INIT_ID(rescue);
3236 INIT_ID(ensure);
3237 INIT_ID(eval);
3238 INIT_ID(main);
3239 INIT_ID(plain);
3240 }
3241
3242 switch (type) {
3243 case ISEQ_TYPE_TOP: return id_top;
3244 case ISEQ_TYPE_METHOD: return id_method;
3245 case ISEQ_TYPE_BLOCK: return id_block;
3246 case ISEQ_TYPE_CLASS: return id_class;
3247 case ISEQ_TYPE_RESCUE: return id_rescue;
3248 case ISEQ_TYPE_ENSURE: return id_ensure;
3249 case ISEQ_TYPE_EVAL: return id_eval;
3250 case ISEQ_TYPE_MAIN: return id_main;
3251 case ISEQ_TYPE_PLAIN: return id_plain;
3252 };
3253
3254 rb_bug("unsupported iseq type: %d", (int)type);
3255}
3256
3257static VALUE
3258iseq_data_to_ary(const rb_iseq_t *iseq)
3259{
3260 unsigned int i;
3261 long l;
3262 const struct rb_iseq_constant_body *const iseq_body = ISEQ_BODY(iseq);
3263 const struct iseq_insn_info_entry *prev_insn_info;
3264 unsigned int pos;
3265 int last_line = 0;
3266 VALUE *seq, *iseq_original;
3267
3268 VALUE val = rb_ary_new();
3269 ID type; /* Symbol */
3270 VALUE locals = rb_ary_new();
3271 VALUE params = rb_hash_new();
3272 VALUE body = rb_ary_new(); /* [[:insn1, ...], ...] */
3273 VALUE nbody;
3274 VALUE exception = rb_ary_new(); /* [[....]] */
3275 VALUE misc = rb_hash_new();
3276
3277 static ID insn_syms[VM_INSTRUCTION_SIZE/2]; /* w/o-trace only */
3278 struct st_table *labels_table = st_init_numtable();
3279 VALUE labels_wrapper = TypedData_Wrap_Struct(0, &label_wrapper, labels_table);
3280
3281 if (insn_syms[0] == 0) {
3282 int i;
3283 for (i=0; i<numberof(insn_syms); i++) {
3284 insn_syms[i] = rb_intern(insn_name(i));
3285 }
3286 }
3287
3288 /* type */
3289 type = iseq_type_id(iseq_body->type);
3290
3291 /* locals */
3292 for (i=0; i<iseq_body->local_table_size; i++) {
3293 ID lid = iseq_body->local_table[i];
3294 if (lid) {
3295 if (rb_id2str(lid)) {
3296 rb_ary_push(locals, ID2SYM(lid));
3297 }
3298 else { /* hidden variable from id_internal() */
3299 rb_ary_push(locals, ULONG2NUM(iseq_body->local_table_size-i+1));
3300 }
3301 }
3302 else {
3303 rb_ary_push(locals, ID2SYM(rb_intern("#arg_rest")));
3304 }
3305 }
3306
3307 /* params */
3308 {
3309 const struct rb_iseq_param_keyword *const keyword = iseq_body->param.keyword;
3310 int j;
3311
3312 if (iseq_body->param.flags.has_opt) {
3313 int len = iseq_body->param.opt_num + 1;
3314 VALUE arg_opt_labels = rb_ary_new2(len);
3315
3316 for (j = 0; j < len; j++) {
3317 VALUE l = register_label(labels_table, iseq_body->param.opt_table[j]);
3318 rb_ary_push(arg_opt_labels, l);
3319 }
3320 rb_hash_aset(params, ID2SYM(rb_intern("opt")), arg_opt_labels);
3321 }
3322
3323 /* commit */
3324 if (iseq_body->param.flags.has_lead) rb_hash_aset(params, ID2SYM(rb_intern("lead_num")), INT2FIX(iseq_body->param.lead_num));
3325 if (iseq_body->param.flags.has_post) rb_hash_aset(params, ID2SYM(rb_intern("post_num")), INT2FIX(iseq_body->param.post_num));
3326 if (iseq_body->param.flags.has_post) rb_hash_aset(params, ID2SYM(rb_intern("post_start")), INT2FIX(iseq_body->param.post_start));
3327 if (iseq_body->param.flags.has_rest) rb_hash_aset(params, ID2SYM(rb_intern("rest_start")), INT2FIX(iseq_body->param.rest_start));
3328 if (iseq_body->param.flags.has_block) rb_hash_aset(params, ID2SYM(rb_intern("block_start")), INT2FIX(iseq_body->param.block_start));
3329 if (iseq_body->param.flags.has_kw) {
3330 VALUE keywords = rb_ary_new();
3331 int i, j;
3332 for (i=0; i<keyword->required_num; i++) {
3333 rb_ary_push(keywords, ID2SYM(keyword->table[i]));
3334 }
3335 for (j=0; i<keyword->num; i++, j++) {
3336 VALUE key = rb_ary_new_from_args(1, ID2SYM(keyword->table[i]));
3337 if (!UNDEF_P(keyword->default_values[j])) {
3338 rb_ary_push(key, keyword->default_values[j]);
3339 }
3340 rb_ary_push(keywords, key);
3341 }
3342
3343 rb_hash_aset(params, ID2SYM(rb_intern("kwbits")),
3344 INT2FIX(keyword->bits_start));
3345 rb_hash_aset(params, ID2SYM(rb_intern("keyword")), keywords);
3346 }
3347 if (iseq_body->param.flags.has_kwrest) rb_hash_aset(params, ID2SYM(rb_intern("kwrest")), INT2FIX(keyword->rest_start));
3348 if (iseq_body->param.flags.ambiguous_param0) rb_hash_aset(params, ID2SYM(rb_intern("ambiguous_param0")), Qtrue);
3349 if (iseq_body->param.flags.use_block) rb_hash_aset(params, ID2SYM(rb_intern("use_block")), Qtrue);
3350 }
3351
3352 /* body */
3353 iseq_original = rb_iseq_original_iseq((rb_iseq_t *)iseq);
3354
3355 for (seq = iseq_original; seq < iseq_original + iseq_body->iseq_size; ) {
3356 VALUE insn = *seq++;
3357 int j, len = insn_len(insn);
3358 VALUE *nseq = seq + len - 1;
3359 VALUE ary = rb_ary_new2(len);
3360
3361 rb_ary_push(ary, ID2SYM(insn_syms[insn%numberof(insn_syms)]));
3362 for (j=0; j<len-1; j++, seq++) {
3363 enum ruby_insn_type_chars op_type = insn_op_type(insn, j);
3364
3365 switch (op_type) {
3366 case TS_OFFSET: {
3367 unsigned long idx = nseq - iseq_original + *seq;
3368 rb_ary_push(ary, register_label(labels_table, idx));
3369 break;
3370 }
3371 case TS_LINDEX:
3372 case TS_NUM:
3373 rb_ary_push(ary, INT2FIX(*seq));
3374 break;
3375 case TS_VALUE:
3376 rb_ary_push(ary, obj_resurrect(*seq));
3377 break;
3378 case TS_ISEQ:
3379 {
3380 const rb_iseq_t *iseq = (rb_iseq_t *)*seq;
3381 if (iseq) {
3382 VALUE val = iseq_data_to_ary(rb_iseq_check(iseq));
3383 rb_ary_push(ary, val);
3384 }
3385 else {
3386 rb_ary_push(ary, Qnil);
3387 }
3388 }
3389 break;
3390 case TS_IC:
3391 {
3392 VALUE list = rb_ary_new();
3393 const ID *ids = ((IC)*seq)->segments;
3394 while (*ids) {
3395 rb_ary_push(list, ID2SYM(*ids++));
3396 }
3397 rb_ary_push(ary, list);
3398 }
3399 break;
3400 case TS_IVC:
3401 case TS_ICVARC:
3402 case TS_ISE:
3403 {
3404 union iseq_inline_storage_entry *is = (union iseq_inline_storage_entry *)*seq;
3405 rb_ary_push(ary, INT2FIX(is - ISEQ_IS_ENTRY_START(ISEQ_BODY(iseq), op_type)));
3406 }
3407 break;
3408 case TS_CALLDATA:
3409 {
3410 struct rb_call_data *cd = (struct rb_call_data *)*seq;
3411 const struct rb_callinfo *ci = cd->ci;
3412 VALUE e = rb_hash_new();
3413 int argc = vm_ci_argc(ci);
3414
3415 ID mid = vm_ci_mid(ci);
3416 rb_hash_aset(e, ID2SYM(rb_intern("mid")), mid ? ID2SYM(mid) : Qnil);
3417 rb_hash_aset(e, ID2SYM(rb_intern("flag")), UINT2NUM(vm_ci_flag(ci)));
3418
3419 if (vm_ci_flag(ci) & VM_CALL_KWARG) {
3420 const struct rb_callinfo_kwarg *kwarg = vm_ci_kwarg(ci);
3421 int i;
3422 VALUE kw = rb_ary_new2((long)kwarg->keyword_len);
3423
3424 argc -= kwarg->keyword_len;
3425 for (i = 0; i < kwarg->keyword_len; i++) {
3426 rb_ary_push(kw, kwarg->keywords[i]);
3427 }
3428 rb_hash_aset(e, ID2SYM(rb_intern("kw_arg")), kw);
3429 }
3430
3431 rb_hash_aset(e, ID2SYM(rb_intern("orig_argc")),
3432 INT2FIX(argc));
3433 rb_ary_push(ary, e);
3434 }
3435 break;
3436 case TS_ID:
3437 rb_ary_push(ary, ID2SYM(*seq));
3438 break;
3439 case TS_CDHASH:
3440 {
3441 VALUE hash = *seq;
3442 VALUE val = rb_ary_new();
3443 int i;
3444
3445 rb_hash_foreach(hash, cdhash_each, val);
3446
3447 for (i=0; i<RARRAY_LEN(val); i+=2) {
3448 VALUE pos = FIX2INT(rb_ary_entry(val, i+1));
3449 unsigned long idx = nseq - iseq_original + pos;
3450
3451 rb_ary_store(val, i+1,
3452 register_label(labels_table, idx));
3453 }
3454 rb_ary_push(ary, val);
3455 }
3456 break;
3457 case TS_FUNCPTR:
3458 {
3459#if SIZEOF_VALUE <= SIZEOF_LONG
3460 VALUE val = LONG2NUM((SIGNED_VALUE)*seq);
3461#else
3462 VALUE val = LL2NUM((SIGNED_VALUE)*seq);
3463#endif
3464 rb_ary_push(ary, val);
3465 }
3466 break;
3467 case TS_BUILTIN:
3468 {
3469 VALUE val = rb_hash_new();
3470#if SIZEOF_VALUE <= SIZEOF_LONG
3471 VALUE func_ptr = LONG2NUM((SIGNED_VALUE)((RB_BUILTIN)*seq)->func_ptr);
3472#else
3473 VALUE func_ptr = LL2NUM((SIGNED_VALUE)((RB_BUILTIN)*seq)->func_ptr);
3474#endif
3475 rb_hash_aset(val, ID2SYM(rb_intern("func_ptr")), func_ptr);
3476 rb_hash_aset(val, ID2SYM(rb_intern("argc")), INT2NUM(((RB_BUILTIN)*seq)->argc));
3477 rb_hash_aset(val, ID2SYM(rb_intern("index")), INT2NUM(((RB_BUILTIN)*seq)->index));
3478 rb_hash_aset(val, ID2SYM(rb_intern("name")), rb_str_new_cstr(((RB_BUILTIN)*seq)->name));
3479 rb_ary_push(ary, val);
3480 }
3481 break;
3482 default:
3483 rb_bug("unknown operand: %c", insn_op_type(insn, j));
3484 }
3485 }
3486 rb_ary_push(body, ary);
3487 }
3488
3489 nbody = body;
3490
3491 /* exception */
3492 if (iseq_body->catch_table) for (i=0; i<iseq_body->catch_table->size; i++) {
3493 VALUE ary = rb_ary_new();
3494 const struct iseq_catch_table_entry *entry =
3495 UNALIGNED_MEMBER_PTR(iseq_body->catch_table, entries[i]);
3496 rb_ary_push(ary, exception_type2symbol(entry->type));
3497 if (entry->iseq) {
3498 rb_ary_push(ary, iseq_data_to_ary(rb_iseq_check(entry->iseq)));
3499 }
3500 else {
3501 rb_ary_push(ary, Qnil);
3502 }
3503 rb_ary_push(ary, register_label(labels_table, entry->start));
3504 rb_ary_push(ary, register_label(labels_table, entry->end));
3505 rb_ary_push(ary, register_label(labels_table, entry->cont));
3506 rb_ary_push(ary, UINT2NUM(entry->sp));
3507 rb_ary_push(exception, ary);
3508 }
3509
3510 /* make body with labels and insert line number */
3511 body = rb_ary_new();
3512 prev_insn_info = NULL;
3513#ifdef USE_ISEQ_NODE_ID
3514 VALUE node_ids = rb_ary_new();
3515#endif
3516
3517 for (l=0, pos=0; l<RARRAY_LEN(nbody); l++) {
3518 const struct iseq_insn_info_entry *info;
3519 VALUE ary = RARRAY_AREF(nbody, l);
3520 st_data_t label;
3521
3522 if (st_lookup(labels_table, pos, &label)) {
3523 rb_ary_push(body, (VALUE)label);
3524 }
3525
3526 info = get_insn_info(iseq, pos);
3527#ifdef USE_ISEQ_NODE_ID
3528 rb_ary_push(node_ids, INT2FIX(info->node_id));
3529#endif
3530
3531 if (prev_insn_info != info) {
3532 int line = info->line_no;
3533 rb_event_flag_t events = info->events;
3534
3535 if (line > 0 && last_line != line) {
3536 rb_ary_push(body, INT2FIX(line));
3537 last_line = line;
3538 }
3539#define CHECK_EVENT(ev) if (events & ev) rb_ary_push(body, ID2SYM(rb_intern(#ev)));
3540 CHECK_EVENT(RUBY_EVENT_LINE);
3541 CHECK_EVENT(RUBY_EVENT_CLASS);
3542 CHECK_EVENT(RUBY_EVENT_END);
3543 CHECK_EVENT(RUBY_EVENT_CALL);
3544 CHECK_EVENT(RUBY_EVENT_RETURN);
3545 CHECK_EVENT(RUBY_EVENT_B_CALL);
3546 CHECK_EVENT(RUBY_EVENT_B_RETURN);
3547 CHECK_EVENT(RUBY_EVENT_RESCUE);
3548#undef CHECK_EVENT
3549 prev_insn_info = info;
3550 }
3551
3552 rb_ary_push(body, ary);
3553 pos += RARRAY_LENINT(ary); /* reject too huge data */
3554 }
3555 RB_GC_GUARD(nbody);
3556 RB_GC_GUARD(labels_wrapper);
3557
3558 rb_hash_aset(misc, ID2SYM(rb_intern("arg_size")), INT2FIX(iseq_body->param.size));
3559 rb_hash_aset(misc, ID2SYM(rb_intern("local_size")), INT2FIX(iseq_body->local_table_size));
3560 rb_hash_aset(misc, ID2SYM(rb_intern("stack_max")), INT2FIX(iseq_body->stack_max));
3561 rb_hash_aset(misc, ID2SYM(rb_intern("node_id")), INT2FIX(iseq_body->location.node_id));
3562 rb_hash_aset(misc, ID2SYM(rb_intern("code_location")),
3563 rb_ary_new_from_args(4,
3564 INT2FIX(iseq_body->location.code_location.beg_pos.lineno),
3565 INT2FIX(iseq_body->location.code_location.beg_pos.column),
3566 INT2FIX(iseq_body->location.code_location.end_pos.lineno),
3567 INT2FIX(iseq_body->location.code_location.end_pos.column)));
3568#ifdef USE_ISEQ_NODE_ID
3569 rb_hash_aset(misc, ID2SYM(rb_intern("node_ids")), node_ids);
3570#endif
3571 rb_hash_aset(misc, ID2SYM(rb_intern("parser")), iseq_body->prism ? ID2SYM(rb_intern("prism")) : ID2SYM(rb_intern("parse.y")));
3572
3573 /*
3574 * [:magic, :major_version, :minor_version, :format_type, :misc,
3575 * :name, :path, :absolute_path, :start_lineno, :type, :locals, :args,
3576 * :catch_table, :bytecode]
3577 */
3578 rb_ary_push(val, rb_str_new2("YARVInstructionSequence/SimpleDataFormat"));
3579 rb_ary_push(val, INT2FIX(ISEQ_MAJOR_VERSION)); /* major */
3580 rb_ary_push(val, INT2FIX(ISEQ_MINOR_VERSION)); /* minor */
3581 rb_ary_push(val, INT2FIX(1));
3582 rb_ary_push(val, misc);
3583 rb_ary_push(val, iseq_body->location.label);
3584 rb_ary_push(val, rb_iseq_path(iseq));
3585 rb_ary_push(val, rb_iseq_realpath(iseq));
3586 rb_ary_push(val, RB_INT2NUM(iseq_body->location.first_lineno));
3587 rb_ary_push(val, ID2SYM(type));
3588 rb_ary_push(val, locals);
3589 rb_ary_push(val, params);
3590 rb_ary_push(val, exception);
3591 rb_ary_push(val, body);
3592 return val;
3593}
3594
3595VALUE
3596rb_iseq_parameters(const rb_iseq_t *iseq, int is_proc)
3597{
3598 int i, r;
3599 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3600 const struct rb_iseq_param_keyword *const keyword = body->param.keyword;
3601 VALUE a, args = rb_ary_new2(body->param.size);
3602 ID req, opt, rest, block, key, keyrest;
3603#define PARAM_TYPE(type) rb_ary_push(a = rb_ary_new2(2), ID2SYM(type))
3604#define PARAM_ID(i) body->local_table[(i)]
3605#define PARAM(i, type) ( \
3606 PARAM_TYPE(type), \
3607 rb_id2str(PARAM_ID(i)) ? \
3608 rb_ary_push(a, ID2SYM(PARAM_ID(i))) : \
3609 a)
3610
3611 CONST_ID(req, "req");
3612 CONST_ID(opt, "opt");
3613
3614 if (body->param.flags.forwardable) {
3615 // [[:rest, :*], [:keyrest, :**], [:block, :&]]
3616 CONST_ID(rest, "rest");
3617 CONST_ID(keyrest, "keyrest");
3618 CONST_ID(block, "block");
3619 rb_ary_push(args, rb_ary_new_from_args(2, ID2SYM(rest), ID2SYM(idMULT)));
3620 rb_ary_push(args, rb_ary_new_from_args(2, ID2SYM(keyrest), ID2SYM(idPow)));
3621 rb_ary_push(args, rb_ary_new_from_args(2, ID2SYM(block), ID2SYM(idAnd)));
3622 }
3623
3624 if (is_proc) {
3625 for (i = 0; i < body->param.lead_num; i++) {
3626 PARAM_TYPE(opt);
3627 rb_ary_push(a, rb_id2str(PARAM_ID(i)) ? ID2SYM(PARAM_ID(i)) : Qnil);
3628 rb_ary_push(args, a);
3629 }
3630 }
3631 else {
3632 for (i = 0; i < body->param.lead_num; i++) {
3633 rb_ary_push(args, PARAM(i, req));
3634 }
3635 }
3636 r = body->param.lead_num + body->param.opt_num;
3637 for (; i < r; i++) {
3638 PARAM_TYPE(opt);
3639 if (rb_id2str(PARAM_ID(i))) {
3640 rb_ary_push(a, ID2SYM(PARAM_ID(i)));
3641 }
3642 rb_ary_push(args, a);
3643 }
3644 if (body->param.flags.has_rest) {
3645 CONST_ID(rest, "rest");
3646 rb_ary_push(args, PARAM(body->param.rest_start, rest));
3647 }
3648 r = body->param.post_start + body->param.post_num;
3649 if (is_proc) {
3650 for (i = body->param.post_start; i < r; i++) {
3651 PARAM_TYPE(opt);
3652 rb_ary_push(a, rb_id2str(PARAM_ID(i)) ? ID2SYM(PARAM_ID(i)) : Qnil);
3653 rb_ary_push(args, a);
3654 }
3655 }
3656 else {
3657 for (i = body->param.post_start; i < r; i++) {
3658 rb_ary_push(args, PARAM(i, req));
3659 }
3660 }
3661 if (body->param.flags.accepts_no_kwarg) {
3662 ID nokey;
3663 CONST_ID(nokey, "nokey");
3664 PARAM_TYPE(nokey);
3665 rb_ary_push(args, a);
3666 }
3667 if (body->param.flags.has_kw) {
3668 i = 0;
3669 if (keyword->required_num > 0) {
3670 ID keyreq;
3671 CONST_ID(keyreq, "keyreq");
3672 for (; i < keyword->required_num; i++) {
3673 PARAM_TYPE(keyreq);
3674 if (rb_id2str(keyword->table[i])) {
3675 rb_ary_push(a, ID2SYM(keyword->table[i]));
3676 }
3677 rb_ary_push(args, a);
3678 }
3679 }
3680 CONST_ID(key, "key");
3681 for (; i < keyword->num; i++) {
3682 PARAM_TYPE(key);
3683 if (rb_id2str(keyword->table[i])) {
3684 rb_ary_push(a, ID2SYM(keyword->table[i]));
3685 }
3686 rb_ary_push(args, a);
3687 }
3688 }
3689 if (body->param.flags.has_kwrest || body->param.flags.ruby2_keywords) {
3690 ID param;
3691 CONST_ID(keyrest, "keyrest");
3692 PARAM_TYPE(keyrest);
3693 if (body->param.flags.has_kwrest &&
3694 rb_id2str(param = PARAM_ID(keyword->rest_start))) {
3695 rb_ary_push(a, ID2SYM(param));
3696 }
3697 else if (body->param.flags.ruby2_keywords) {
3698 rb_ary_push(a, ID2SYM(idPow));
3699 }
3700 rb_ary_push(args, a);
3701 }
3702 if (body->param.flags.has_block) {
3703 CONST_ID(block, "block");
3704 rb_ary_push(args, PARAM(body->param.block_start, block));
3705 }
3706 return args;
3707}
3708
3709VALUE
3710rb_iseq_defined_string(enum defined_type type)
3711{
3712 static const char expr_names[][18] = {
3713 "nil",
3714 "instance-variable",
3715 "local-variable",
3716 "global-variable",
3717 "class variable",
3718 "constant",
3719 "method",
3720 "yield",
3721 "super",
3722 "self",
3723 "true",
3724 "false",
3725 "assignment",
3726 "expression",
3727 };
3728 const char *estr;
3729
3730 if ((unsigned)(type - 1) >= (unsigned)numberof(expr_names)) rb_bug("unknown defined type %d", type);
3731 estr = expr_names[type - 1];
3732 return rb_fstring_cstr(estr);
3733}
3734
3735/* A map from encoded_insn to insn_data: decoded insn number, its len,
3736 * non-trace version of encoded insn, and trace version. */
3737
3738static st_table *encoded_insn_data;
3739typedef struct insn_data_struct {
3740 int insn;
3741 int insn_len;
3742 void *notrace_encoded_insn;
3743 void *trace_encoded_insn;
3744} insn_data_t;
3745static insn_data_t insn_data[VM_INSTRUCTION_SIZE/2];
3746
3747void
3748rb_free_encoded_insn_data(void)
3749{
3750 st_free_table(encoded_insn_data);
3751}
3752
3753void
3754rb_vm_encoded_insn_data_table_init(void)
3755{
3756#if OPT_DIRECT_THREADED_CODE || OPT_CALL_THREADED_CODE
3757 const void * const *table = rb_vm_get_insns_address_table();
3758#define INSN_CODE(insn) ((VALUE)table[insn])
3759#else
3760#define INSN_CODE(insn) (insn)
3761#endif
3762 st_data_t insn;
3763 encoded_insn_data = st_init_numtable_with_size(VM_INSTRUCTION_SIZE / 2);
3764
3765 for (insn = 0; insn < VM_INSTRUCTION_SIZE/2; insn++) {
3766 st_data_t key1 = (st_data_t)INSN_CODE(insn);
3767 st_data_t key2 = (st_data_t)INSN_CODE(insn + VM_INSTRUCTION_SIZE/2);
3768
3769 insn_data[insn].insn = (int)insn;
3770 insn_data[insn].insn_len = insn_len(insn);
3771
3772 if (insn != BIN(opt_invokebuiltin_delegate_leave)) {
3773 insn_data[insn].notrace_encoded_insn = (void *) key1;
3774 insn_data[insn].trace_encoded_insn = (void *) key2;
3775 }
3776 else {
3777 insn_data[insn].notrace_encoded_insn = (void *) INSN_CODE(BIN(opt_invokebuiltin_delegate));
3778 insn_data[insn].trace_encoded_insn = (void *) INSN_CODE(BIN(opt_invokebuiltin_delegate) + VM_INSTRUCTION_SIZE/2);
3779 }
3780
3781 st_add_direct(encoded_insn_data, key1, (st_data_t)&insn_data[insn]);
3782 st_add_direct(encoded_insn_data, key2, (st_data_t)&insn_data[insn]);
3783 }
3784}
3785
3786int
3787rb_vm_insn_addr2insn(const void *addr)
3788{
3789 st_data_t key = (st_data_t)addr;
3790 st_data_t val;
3791
3792 if (st_lookup(encoded_insn_data, key, &val)) {
3793 insn_data_t *e = (insn_data_t *)val;
3794 return (int)e->insn;
3795 }
3796
3797 rb_bug("rb_vm_insn_addr2insn: invalid insn address: %p", addr);
3798}
3799
3800// Unlike rb_vm_insn_addr2insn, this function can return trace opcode variants.
3801int
3802rb_vm_insn_addr2opcode(const void *addr)
3803{
3804 st_data_t key = (st_data_t)addr;
3805 st_data_t val;
3806
3807 if (st_lookup(encoded_insn_data, key, &val)) {
3808 insn_data_t *e = (insn_data_t *)val;
3809 int opcode = e->insn;
3810 if (addr == e->trace_encoded_insn) {
3811 opcode += VM_INSTRUCTION_SIZE/2;
3812 }
3813 return opcode;
3814 }
3815
3816 rb_bug("rb_vm_insn_addr2opcode: invalid insn address: %p", addr);
3817}
3818
3819// Decode `ISEQ_BODY(iseq)->iseq_encoded[i]` to an insn.
3820int
3821rb_vm_insn_decode(const VALUE encoded)
3822{
3823#if OPT_DIRECT_THREADED_CODE || OPT_CALL_THREADED_CODE
3824 int insn = rb_vm_insn_addr2insn((void *)encoded);
3825#else
3826 int insn = (int)encoded;
3827#endif
3828 return insn;
3829}
3830
3831static inline int
3832encoded_iseq_trace_instrument(VALUE *iseq_encoded_insn, rb_event_flag_t turnon, bool remain_current_trace)
3833{
3834 st_data_t key = (st_data_t)*iseq_encoded_insn;
3835 st_data_t val;
3836
3837 if (st_lookup(encoded_insn_data, key, &val)) {
3838 insn_data_t *e = (insn_data_t *)val;
3839 if (remain_current_trace && key == (st_data_t)e->trace_encoded_insn) {
3840 turnon = 1;
3841 }
3842 *iseq_encoded_insn = (VALUE) (turnon ? e->trace_encoded_insn : e->notrace_encoded_insn);
3843 return e->insn_len;
3844 }
3845
3846 rb_bug("trace_instrument: invalid insn address: %p", (void *)*iseq_encoded_insn);
3847}
3848
3849void
3850rb_iseq_trace_flag_cleared(const rb_iseq_t *iseq, size_t pos)
3851{
3852 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3853 VALUE *iseq_encoded = (VALUE *)body->iseq_encoded;
3854 encoded_iseq_trace_instrument(&iseq_encoded[pos], 0, false);
3855}
3856
3857// We need to fire call events on instructions with b_call events if the block
3858// is running as a method. So, if we are listening for call events, then
3859// instructions that have b_call events need to become trace variants.
3860// Use this function when making decisions about recompiling to trace variants.
3861static inline rb_event_flag_t
3862add_bmethod_events(rb_event_flag_t events)
3863{
3864 if (events & RUBY_EVENT_CALL) {
3865 events |= RUBY_EVENT_B_CALL;
3866 }
3867 if (events & RUBY_EVENT_RETURN) {
3868 events |= RUBY_EVENT_B_RETURN;
3869 }
3870 return events;
3871}
3872
3873// Note, to support call/return events for bmethods, turnon_event can have more events than tpval.
3874static int
3875iseq_add_local_tracepoint(const rb_iseq_t *iseq, rb_event_flag_t turnon_events, VALUE tpval, unsigned int target_line)
3876{
3877 unsigned int pc;
3878 int n = 0;
3879 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3880 VALUE *iseq_encoded = (VALUE *)body->iseq_encoded;
3881
3882 VM_ASSERT(ISEQ_EXECUTABLE_P(iseq));
3883
3884 for (pc=0; pc<body->iseq_size;) {
3885 const struct iseq_insn_info_entry *entry = get_insn_info(iseq, pc);
3886 rb_event_flag_t pc_events = entry->events;
3887 rb_event_flag_t target_events = turnon_events;
3888 unsigned int line = (int)entry->line_no;
3889
3890 if (target_line == 0 || target_line == line) {
3891 /* ok */
3892 }
3893 else {
3894 target_events &= ~RUBY_EVENT_LINE;
3895 }
3896
3897 if (pc_events & target_events) {
3898 n++;
3899 }
3900 pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & (target_events | iseq->aux.exec.global_trace_events), true);
3901 }
3902
3903 if (n > 0) {
3904 if (iseq->aux.exec.local_hooks == NULL) {
3905 ((rb_iseq_t *)iseq)->aux.exec.local_hooks = RB_ZALLOC(rb_hook_list_t);
3906 iseq->aux.exec.local_hooks->is_local = true;
3907 }
3908 rb_hook_list_connect_tracepoint((VALUE)iseq, iseq->aux.exec.local_hooks, tpval, target_line);
3909 }
3910
3911 return n;
3912}
3913
3915 rb_event_flag_t turnon_events;
3916 VALUE tpval;
3917 unsigned int target_line;
3918 int n;
3919};
3920
3921static void
3922iseq_add_local_tracepoint_i(const rb_iseq_t *iseq, void *p)
3923{
3925 data->n += iseq_add_local_tracepoint(iseq, data->turnon_events, data->tpval, data->target_line);
3926 iseq_iterate_children(iseq, iseq_add_local_tracepoint_i, p);
3927}
3928
3929int
3930rb_iseq_add_local_tracepoint_recursively(const rb_iseq_t *iseq, rb_event_flag_t turnon_events, VALUE tpval, unsigned int target_line, bool target_bmethod)
3931{
3933 if (target_bmethod) {
3934 turnon_events = add_bmethod_events(turnon_events);
3935 }
3936 data.turnon_events = turnon_events;
3937 data.tpval = tpval;
3938 data.target_line = target_line;
3939 data.n = 0;
3940
3941 iseq_add_local_tracepoint_i(iseq, (void *)&data);
3942 if (0) rb_funcall(Qnil, rb_intern("puts"), 1, rb_iseq_disasm(iseq)); /* for debug */
3943 return data.n;
3944}
3945
3946static int
3947iseq_remove_local_tracepoint(const rb_iseq_t *iseq, VALUE tpval)
3948{
3949 int n = 0;
3950
3951 if (iseq->aux.exec.local_hooks) {
3952 unsigned int pc;
3953 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3954 VALUE *iseq_encoded = (VALUE *)body->iseq_encoded;
3955 rb_event_flag_t local_events = 0;
3956
3957 rb_hook_list_remove_tracepoint(iseq->aux.exec.local_hooks, tpval);
3958 local_events = iseq->aux.exec.local_hooks->events;
3959
3960 if (local_events == 0) {
3961 rb_hook_list_free(iseq->aux.exec.local_hooks);
3962 ((rb_iseq_t *)iseq)->aux.exec.local_hooks = NULL;
3963 }
3964
3965 local_events = add_bmethod_events(local_events);
3966 for (pc = 0; pc<body->iseq_size;) {
3967 rb_event_flag_t pc_events = rb_iseq_event_flags(iseq, pc);
3968 pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & (local_events | iseq->aux.exec.global_trace_events), false);
3969 }
3970 }
3971 return n;
3972}
3973
3975 VALUE tpval;
3976 int n;
3977};
3978
3979static void
3980iseq_remove_local_tracepoint_i(const rb_iseq_t *iseq, void *p)
3981{
3983 data->n += iseq_remove_local_tracepoint(iseq, data->tpval);
3984 iseq_iterate_children(iseq, iseq_remove_local_tracepoint_i, p);
3985}
3986
3987int
3988rb_iseq_remove_local_tracepoint_recursively(const rb_iseq_t *iseq, VALUE tpval)
3989{
3991 data.tpval = tpval;
3992 data.n = 0;
3993
3994 iseq_remove_local_tracepoint_i(iseq, (void *)&data);
3995 return data.n;
3996}
3997
3998void
3999rb_iseq_trace_set(const rb_iseq_t *iseq, rb_event_flag_t turnon_events)
4000{
4001 if (iseq->aux.exec.global_trace_events == turnon_events) {
4002 return;
4003 }
4004
4005 if (!ISEQ_EXECUTABLE_P(iseq)) {
4006 /* this is building ISeq */
4007 return;
4008 }
4009 else {
4010 unsigned int pc;
4011 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
4012 VALUE *iseq_encoded = (VALUE *)body->iseq_encoded;
4013 rb_event_flag_t enabled_events;
4014 rb_event_flag_t local_events = iseq->aux.exec.local_hooks ? iseq->aux.exec.local_hooks->events : 0;
4015 ((rb_iseq_t *)iseq)->aux.exec.global_trace_events = turnon_events;
4016 enabled_events = add_bmethod_events(turnon_events | local_events);
4017
4018 for (pc=0; pc<body->iseq_size;) {
4019 rb_event_flag_t pc_events = rb_iseq_event_flags(iseq, pc);
4020 pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & enabled_events, true);
4021 }
4022 }
4023}
4024
4025void rb_vm_cc_general(const struct rb_callcache *cc);
4026
4027static bool
4028clear_attr_cc(VALUE v)
4029{
4030 if (imemo_type_p(v, imemo_callcache) && vm_cc_ivar_p((const struct rb_callcache *)v)) {
4031 rb_vm_cc_general((struct rb_callcache *)v);
4032 return true;
4033 }
4034 else {
4035 return false;
4036 }
4037}
4038
4039static bool
4040clear_bf_cc(VALUE v)
4041{
4042 if (imemo_type_p(v, imemo_callcache) && vm_cc_bf_p((const struct rb_callcache *)v)) {
4043 rb_vm_cc_general((struct rb_callcache *)v);
4044 return true;
4045 }
4046 else {
4047 return false;
4048 }
4049}
4050
4051static int
4052clear_attr_ccs_i(void *vstart, void *vend, size_t stride, void *data)
4053{
4054 VALUE v = (VALUE)vstart;
4055 for (; v != (VALUE)vend; v += stride) {
4056 void *ptr = rb_asan_poisoned_object_p(v);
4057 rb_asan_unpoison_object(v, false);
4058 clear_attr_cc(v);
4059 asan_poison_object_if(ptr, v);
4060 }
4061 return 0;
4062}
4063
4064void
4065rb_clear_attr_ccs(void)
4066{
4067 rb_objspace_each_objects(clear_attr_ccs_i, NULL);
4068}
4069
4070static int
4071clear_bf_ccs_i(void *vstart, void *vend, size_t stride, void *data)
4072{
4073 VALUE v = (VALUE)vstart;
4074 for (; v != (VALUE)vend; v += stride) {
4075 void *ptr = rb_asan_poisoned_object_p(v);
4076 rb_asan_unpoison_object(v, false);
4077 clear_bf_cc(v);
4078 asan_poison_object_if(ptr, v);
4079 }
4080 return 0;
4081}
4082
4083void
4084rb_clear_bf_ccs(void)
4085{
4086 rb_objspace_each_objects(clear_bf_ccs_i, NULL);
4087}
4088
4089static int
4090trace_set_i(void *vstart, void *vend, size_t stride, void *data)
4091{
4092 rb_event_flag_t turnon_events = *(rb_event_flag_t *)data;
4093
4094 VALUE v = (VALUE)vstart;
4095 for (; v != (VALUE)vend; v += stride) {
4096 void *ptr = rb_asan_poisoned_object_p(v);
4097 rb_asan_unpoison_object(v, false);
4098
4099 if (rb_obj_is_iseq(v)) {
4100 rb_iseq_trace_set(rb_iseq_check((rb_iseq_t *)v), turnon_events);
4101 }
4102 else if (clear_attr_cc(v)) {
4103 }
4104 else if (clear_bf_cc(v)) {
4105 }
4106
4107 asan_poison_object_if(ptr, v);
4108 }
4109 return 0;
4110}
4111
4112void
4113rb_iseq_trace_set_all(rb_event_flag_t turnon_events)
4114{
4115 rb_objspace_each_objects(trace_set_i, &turnon_events);
4116}
4117
4118VALUE
4119rb_iseqw_local_variables(VALUE iseqval)
4120{
4121 return rb_iseq_local_variables(iseqw_check(iseqval));
4122}
4123
4124/*
4125 * call-seq:
4126 * iseq.to_binary(extra_data = nil) -> binary str
4127 *
4128 * Returns serialized iseq binary format data as a String object.
4129 * A corresponding iseq object is created by
4130 * RubyVM::InstructionSequence.load_from_binary() method.
4131 *
4132 * String extra_data will be saved with binary data.
4133 * You can access this data with
4134 * RubyVM::InstructionSequence.load_from_binary_extra_data(binary).
4135 *
4136 * Note that the translated binary data is not portable.
4137 * You can not move this binary data to another machine.
4138 * You can not use the binary data which is created by another
4139 * version/another architecture of Ruby.
4140 */
4141static VALUE
4142iseqw_to_binary(int argc, VALUE *argv, VALUE self)
4143{
4144 VALUE opt = !rb_check_arity(argc, 0, 1) ? Qnil : argv[0];
4145 return rb_iseq_ibf_dump(iseqw_check(self), opt);
4146}
4147
4148/*
4149 * call-seq:
4150 * RubyVM::InstructionSequence.load_from_binary(binary) -> iseq
4151 *
4152 * Load an iseq object from binary format String object
4153 * created by RubyVM::InstructionSequence.to_binary.
4154 *
4155 * This loader does not have a verifier, so that loading broken/modified
4156 * binary causes critical problem.
4157 *
4158 * You should not load binary data provided by others.
4159 * You should use binary data translated by yourself.
4160 */
4161static VALUE
4162iseqw_s_load_from_binary(VALUE self, VALUE str)
4163{
4164 return iseqw_new(rb_iseq_ibf_load(str));
4165}
4166
4167/*
4168 * call-seq:
4169 * RubyVM::InstructionSequence.load_from_binary_extra_data(binary) -> str
4170 *
4171 * Load extra data embed into binary format String object.
4172 */
4173static VALUE
4174iseqw_s_load_from_binary_extra_data(VALUE self, VALUE str)
4175{
4176 return rb_iseq_ibf_load_extra_data(str);
4177}
4178
4179#if VM_INSN_INFO_TABLE_IMPL == 2
4180
4181/* An implementation of succinct bit-vector for insn_info table.
4182 *
4183 * A succinct bit-vector is a small and efficient data structure that provides
4184 * a bit-vector augmented with an index for O(1) rank operation:
4185 *
4186 * rank(bv, n): the number of 1's within a range from index 0 to index n
4187 *
4188 * This can be used to lookup insn_info table from PC.
4189 * For example, consider the following iseq and insn_info_table:
4190 *
4191 * iseq insn_info_table
4192 * PC insn+operand position lineno event
4193 * 0: insn1 0: 1 [Li]
4194 * 2: insn2 2: 2 [Li] <= (A)
4195 * 5: insn3 8: 3 [Li] <= (B)
4196 * 8: insn4
4197 *
4198 * In this case, a succinct bit-vector whose indexes 0, 2, 8 is "1" and
4199 * other indexes is "0", i.e., "101000001", is created.
4200 * To lookup the lineno of insn2, calculate rank("10100001", 2) = 2, so
4201 * the line (A) is the entry in question.
4202 * To lookup the lineno of insn4, calculate rank("10100001", 8) = 3, so
4203 * the line (B) is the entry in question.
4204 *
4205 * A naive implementation of succinct bit-vector works really well
4206 * not only for large size but also for small size. However, it has
4207 * tiny overhead for very small size. So, this implementation consist
4208 * of two parts: one part is the "immediate" table that keeps rank result
4209 * as a raw table, and the other part is a normal succinct bit-vector.
4210 */
4211
4212#define IMMEDIATE_TABLE_SIZE 54 /* a multiple of 9, and < 128 */
4213
4214struct succ_index_table {
4215 uint64_t imm_part[IMMEDIATE_TABLE_SIZE / 9];
4216 struct succ_dict_block {
4217 unsigned int rank;
4218 uint64_t small_block_ranks; /* 9 bits * 7 = 63 bits */
4219 uint64_t bits[512/64];
4220 } succ_part[FLEX_ARY_LEN];
4221};
4222
4223#define imm_block_rank_set(v, i, r) (v) |= (uint64_t)(r) << (7 * (i))
4224#define imm_block_rank_get(v, i) (((int)((v) >> ((i) * 7))) & 0x7f)
4225#define small_block_rank_set(v, i, r) (v) |= (uint64_t)(r) << (9 * ((i) - 1))
4226#define small_block_rank_get(v, i) ((i) == 0 ? 0 : (((int)((v) >> (((i) - 1) * 9))) & 0x1ff))
4227
4228static struct succ_index_table *
4229succ_index_table_create(int max_pos, int *data, int size)
4230{
4231 const int imm_size = (max_pos < IMMEDIATE_TABLE_SIZE ? max_pos + 8 : IMMEDIATE_TABLE_SIZE) / 9;
4232 const int succ_size = (max_pos < IMMEDIATE_TABLE_SIZE ? 0 : (max_pos - IMMEDIATE_TABLE_SIZE + 511)) / 512;
4233 struct succ_index_table *sd =
4234 rb_xcalloc_mul_add_mul(
4235 imm_size, sizeof(uint64_t),
4236 succ_size, sizeof(struct succ_dict_block));
4237 int i, j, k, r;
4238
4239 r = 0;
4240 for (j = 0; j < imm_size; j++) {
4241 for (i = 0; i < 9; i++) {
4242 if (r < size && data[r] == j * 9 + i) r++;
4243 imm_block_rank_set(sd->imm_part[j], i, r);
4244 }
4245 }
4246 for (k = 0; k < succ_size; k++) {
4247 struct succ_dict_block *sd_block = &sd->succ_part[k];
4248 int small_rank = 0;
4249 sd_block->rank = r;
4250 for (j = 0; j < 8; j++) {
4251 uint64_t bits = 0;
4252 if (j) small_block_rank_set(sd_block->small_block_ranks, j, small_rank);
4253 for (i = 0; i < 64; i++) {
4254 if (r < size && data[r] == k * 512 + j * 64 + i + IMMEDIATE_TABLE_SIZE) {
4255 bits |= ((uint64_t)1) << i;
4256 r++;
4257 }
4258 }
4259 sd_block->bits[j] = bits;
4260 small_rank += rb_popcount64(bits);
4261 }
4262 }
4263 return sd;
4264}
4265
4266static unsigned int *
4267succ_index_table_invert(int max_pos, struct succ_index_table *sd, int size)
4268{
4269 const int imm_size = (max_pos < IMMEDIATE_TABLE_SIZE ? max_pos + 8 : IMMEDIATE_TABLE_SIZE) / 9;
4270 const int succ_size = (max_pos < IMMEDIATE_TABLE_SIZE ? 0 : (max_pos - IMMEDIATE_TABLE_SIZE + 511)) / 512;
4271 unsigned int *positions = ALLOC_N(unsigned int, size), *p;
4272 int i, j, k, r = -1;
4273 p = positions;
4274 for (j = 0; j < imm_size; j++) {
4275 for (i = 0; i < 9; i++) {
4276 int nr = imm_block_rank_get(sd->imm_part[j], i);
4277 if (r != nr) *p++ = j * 9 + i;
4278 r = nr;
4279 }
4280 }
4281 for (k = 0; k < succ_size; k++) {
4282 for (j = 0; j < 8; j++) {
4283 for (i = 0; i < 64; i++) {
4284 if (sd->succ_part[k].bits[j] & (((uint64_t)1) << i)) {
4285 *p++ = k * 512 + j * 64 + i + IMMEDIATE_TABLE_SIZE;
4286 }
4287 }
4288 }
4289 }
4290 return positions;
4291}
4292
4293static int
4294succ_index_lookup(const struct succ_index_table *sd, int x)
4295{
4296 if (x < IMMEDIATE_TABLE_SIZE) {
4297 const int i = x / 9;
4298 const int j = x % 9;
4299 return imm_block_rank_get(sd->imm_part[i], j);
4300 }
4301 else {
4302 const int block_index = (x - IMMEDIATE_TABLE_SIZE) / 512;
4303 const struct succ_dict_block *block = &sd->succ_part[block_index];
4304 const int block_bit_index = (x - IMMEDIATE_TABLE_SIZE) % 512;
4305 const int small_block_index = block_bit_index / 64;
4306 const int small_block_popcount = small_block_rank_get(block->small_block_ranks, small_block_index);
4307 const int popcnt = rb_popcount64(block->bits[small_block_index] << (63 - block_bit_index % 64));
4308
4309 return block->rank + small_block_popcount + popcnt;
4310 }
4311}
4312#endif
4313
4314
4315/*
4316 * call-seq:
4317 * iseq.script_lines -> array or nil
4318 *
4319 * It returns recorded script lines if it is available.
4320 * The script lines are not limited to the iseq range, but
4321 * are entire lines of the source file.
4322 *
4323 * Note that this is an API for ruby internal use, debugging,
4324 * and research. Do not use this for any other purpose.
4325 * The compatibility is not guaranteed.
4326 */
4327static VALUE
4328iseqw_script_lines(VALUE self)
4329{
4330 const rb_iseq_t *iseq = iseqw_check(self);
4331 return ISEQ_BODY(iseq)->variable.script_lines;
4332}
4333
4334/*
4335 * Document-class: RubyVM::InstructionSequence
4336 *
4337 * The InstructionSequence class represents a compiled sequence of
4338 * instructions for the Virtual Machine used in MRI. Not all implementations of Ruby
4339 * may implement this class, and for the implementations that implement it,
4340 * the methods defined and behavior of the methods can change in any version.
4341 *
4342 * With it, you can get a handle to the instructions that make up a method or
4343 * a proc, compile strings of Ruby code down to VM instructions, and
4344 * disassemble instruction sequences to strings for easy inspection. It is
4345 * mostly useful if you want to learn how YARV works, but it also lets
4346 * you control various settings for the Ruby iseq compiler.
4347 *
4348 * You can find the source for the VM instructions in +insns.def+ in the Ruby
4349 * source.
4350 *
4351 * The instruction sequence results will almost certainly change as Ruby
4352 * changes, so example output in this documentation may be different from what
4353 * you see.
4354 *
4355 * Of course, this class is MRI specific.
4356 */
4357
4358void
4359Init_ISeq(void)
4360{
4361 /* declare ::RubyVM::InstructionSequence */
4362 rb_cISeq = rb_define_class_under(rb_cRubyVM, "InstructionSequence", rb_cObject);
4363 rb_undef_alloc_func(rb_cISeq);
4364 rb_define_method(rb_cISeq, "inspect", iseqw_inspect, 0);
4365 rb_define_method(rb_cISeq, "disasm", iseqw_disasm, 0);
4366 rb_define_method(rb_cISeq, "disassemble", iseqw_disasm, 0);
4367 rb_define_method(rb_cISeq, "to_a", iseqw_to_a, 0);
4368 rb_define_method(rb_cISeq, "eval", iseqw_eval, 0);
4369
4370 rb_define_method(rb_cISeq, "to_binary", iseqw_to_binary, -1);
4371 rb_define_singleton_method(rb_cISeq, "load_from_binary", iseqw_s_load_from_binary, 1);
4372 rb_define_singleton_method(rb_cISeq, "load_from_binary_extra_data", iseqw_s_load_from_binary_extra_data, 1);
4373
4374 /* location APIs */
4375 rb_define_method(rb_cISeq, "path", iseqw_path, 0);
4376 rb_define_method(rb_cISeq, "absolute_path", iseqw_absolute_path, 0);
4377 rb_define_method(rb_cISeq, "label", iseqw_label, 0);
4378 rb_define_method(rb_cISeq, "base_label", iseqw_base_label, 0);
4379 rb_define_method(rb_cISeq, "first_lineno", iseqw_first_lineno, 0);
4380 rb_define_method(rb_cISeq, "trace_points", iseqw_trace_points, 0);
4381 rb_define_method(rb_cISeq, "each_child", iseqw_each_child, 0);
4382
4383#if 0 /* TBD */
4384 rb_define_private_method(rb_cISeq, "marshal_dump", iseqw_marshal_dump, 0);
4385 rb_define_private_method(rb_cISeq, "marshal_load", iseqw_marshal_load, 1);
4386 /* disable this feature because there is no verifier. */
4387 rb_define_singleton_method(rb_cISeq, "load", iseq_s_load, -1);
4388#endif
4389 (void)iseq_s_load;
4390
4391 rb_define_singleton_method(rb_cISeq, "compile", iseqw_s_compile, -1);
4392 rb_define_singleton_method(rb_cISeq, "compile_parsey", iseqw_s_compile_parsey, -1);
4393 rb_define_singleton_method(rb_cISeq, "compile_prism", iseqw_s_compile_prism, -1);
4394 rb_define_singleton_method(rb_cISeq, "compile_file_prism", iseqw_s_compile_file_prism, -1);
4395 rb_define_singleton_method(rb_cISeq, "new", iseqw_s_compile, -1);
4396 rb_define_singleton_method(rb_cISeq, "compile_file", iseqw_s_compile_file, -1);
4397 rb_define_singleton_method(rb_cISeq, "compile_option", iseqw_s_compile_option_get, 0);
4398 rb_define_singleton_method(rb_cISeq, "compile_option=", iseqw_s_compile_option_set, 1);
4399 rb_define_singleton_method(rb_cISeq, "disasm", iseqw_s_disasm, 1);
4400 rb_define_singleton_method(rb_cISeq, "disassemble", iseqw_s_disasm, 1);
4401 rb_define_singleton_method(rb_cISeq, "of", iseqw_s_of, 1);
4402
4403 // script lines
4404 rb_define_method(rb_cISeq, "script_lines", iseqw_script_lines, 0);
4405
4406 rb_undef_method(CLASS_OF(rb_cISeq), "translate");
4407 rb_undef_method(CLASS_OF(rb_cISeq), "load_iseq");
4408}
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_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 RUBY_EVENT_END
Encountered an end of a class clause.
Definition event.h:40
#define RUBY_EVENT_C_CALL
A method, written in C, is called.
Definition event.h:43
#define RUBY_EVENT_B_RETURN
Encountered a next statement.
Definition event.h:56
#define RUBY_EVENT_CLASS
Encountered a new class.
Definition event.h:39
#define RUBY_EVENT_LINE
Encountered a new line.
Definition event.h:38
#define RUBY_EVENT_RETURN
Encountered a return statement.
Definition event.h:42
#define RUBY_EVENT_C_RETURN
Return from a method, written in C.
Definition event.h:44
#define RUBY_EVENT_B_CALL
Encountered an yield statement.
Definition event.h:55
uint32_t rb_event_flag_t
Represents event(s).
Definition event.h:108
#define RUBY_EVENT_CALL
A method, written in Ruby, is called.
Definition event.h:41
#define RUBY_EVENT_RESCUE
Encountered a rescue statement.
Definition event.h:61
#define RB_OBJ_FREEZE
Just another name of rb_obj_freeze_inline.
Definition fl_type.h:93
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
Definition class.c:1012
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
Definition class.c:2166
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:2635
#define rb_str_new2
Old name of rb_str_new_cstr.
Definition string.h:1675
#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 Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
#define rb_str_cat2
Old name of rb_str_cat_cstr.
Definition string.h:1683
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define ULONG2NUM
Old name of RB_ULONG2NUM.
Definition long.h:60
#define SYM2ID
Old name of RB_SYM2ID.
Definition symbol.h:45
#define ZALLOC
Old name of RB_ZALLOC.
Definition memory.h:402
#define LL2NUM
Old name of RB_LL2NUM.
Definition long_long.h:30
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:203
#define T_NONE
Old name of RUBY_T_NONE.
Definition value_type.h:74
#define FIX2INT
Old name of RB_FIX2INT.
Definition int.h:41
#define T_HASH
Old name of RUBY_T_HASH.
Definition value_type.h:65
#define ALLOC_N
Old name of RB_ALLOC_N.
Definition memory.h:399
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition fl_type.h:132
#define LONG2NUM
Old name of RB_LONG2NUM.
Definition long.h:50
#define Qtrue
Old name of RUBY_Qtrue.
#define NUM2INT
Old name of RB_NUM2INT.
Definition int.h:44
#define INT2NUM
Old name of RB_INT2NUM.
Definition int.h:43
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
Definition value_type.h:56
#define NIL_P
Old name of RB_NIL_P.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition value_type.h:85
#define NUM2LONG
Old name of RB_NUM2LONG.
Definition long.h:51
#define UINT2NUM
Old name of RB_UINT2NUM.
Definition int.h:46
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define CONST_ID
Old name of RUBY_CONST_ID.
Definition symbol.h:47
#define rb_ary_new2
Old name of rb_ary_new_capa.
Definition array.h:657
VALUE rb_eTypeError
TypeError exception.
Definition error.c:1430
void * rb_check_typeddata(VALUE obj, const rb_data_type_t *data_type)
Identical to rb_typeddata_is_kind_of(), except it raises exceptions instead of returning false.
Definition error.c:1397
VALUE rb_eSyntaxError
SyntaxError exception.
Definition error.c:1447
VALUE rb_class_superclass(VALUE klass)
Queries the parent of the given class.
Definition object.c:2153
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
Definition object.c:104
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:247
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
Definition object.c:680
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Definition gc.h:603
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
Definition vm_eval.c:1099
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
VALUE rb_file_open_str(VALUE fname, const char *fmode)
Identical to rb_file_open(), except it takes the pathname as a Ruby's string instead of C's.
Definition io.c:7268
VALUE rb_io_close(VALUE io)
Closes the IO.
Definition io.c:5758
int rb_is_local_id(ID id)
Classifies the given ID, then sees if it is a local variable.
Definition symbol.c:1093
VALUE rb_obj_is_method(VALUE recv)
Queries if the given object is a method.
Definition proc.c:1648
VALUE rb_obj_is_proc(VALUE recv)
Queries if the given object is a proc.
Definition proc.c:119
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
Definition string.c:3680
#define rb_str_new(str, len)
Allocates an instance of rb_cString.
Definition string.h:1498
#define rb_exc_new_cstr(exc, str)
Identical to rb_exc_new(), except it assumes the passed pointer is a pointer to a C string.
Definition string.h:1670
VALUE rb_str_dup(VALUE str)
Duplicates a string.
Definition string.c:1920
VALUE rb_str_cat(VALUE dst, const char *src, long srclen)
Destructively appends the passed contents to the string.
Definition string.c:3448
VALUE rb_str_resurrect(VALUE str)
I guess there is no use case of this function in extension libraries, but this is a routine identical...
Definition string.c:1938
void rb_str_set_len(VALUE str, long len)
Overwrites the length of the string.
Definition string.c:3272
VALUE rb_str_inspect(VALUE str)
Generates a "readable" version of the receiver.
Definition string.c:7201
int rb_str_cmp(VALUE lhs, VALUE rhs)
Compares two strings, as in strcmp(3).
Definition string.c:4105
VALUE rb_str_concat(VALUE dst, VALUE src)
Identical to rb_str_append(), except it also accepts an integer as a codepoint.
Definition string.c:3922
#define rb_str_cat_cstr(buf, str)
Identical to rb_str_cat(), except it assumes the passed pointer is a pointer to a C string.
Definition string.h:1656
void rb_str_modify_expand(VALUE str, long capa)
Identical to rb_str_modify(), except it additionally expands the capacity of the receiver.
Definition string.c:2652
#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:1514
VALUE rb_str_intern(VALUE str)
Identical to rb_to_symbol(), except it assumes the receiver being an instance of RString.
Definition symbol.c:878
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
Definition variable.c:492
int rb_respond_to(VALUE obj, ID mid)
Queries if the object responds to the method.
Definition vm_method.c:2960
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
Definition vm_method.c:1291
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:668
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
Definition symbol.c:1117
VALUE rb_sym2str(VALUE symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
Definition symbol.c:970
VALUE rb_io_path(VALUE io)
Returns the path for the given IO.
Definition io.c:2972
int len
Length of the buffer.
Definition io.h:8
VALUE rb_ractor_make_shareable(VALUE obj)
Destructively transforms the passed object so that multiple Ractors can share it.
Definition ractor.c:3115
#define RB_NUM2INT
Just another name of rb_num2int_inline.
Definition int.h:38
#define RB_INT2NUM
Just another name of rb_int2num_inline.
Definition int.h:37
VALUE rb_yield(VALUE val)
Yields the block.
Definition vm_eval.c:1354
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
#define RB_ZALLOC(type)
Shorthand of RB_ZALLOC_N with n=1.
Definition memory.h:249
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
Definition rarray.h:281
#define RARRAY_AREF(a, i)
Definition rarray.h:403
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
Definition rbasic.h:150
#define RHASH_SIZE(h)
Queries the size of the hash.
Definition rhash.h:69
#define StringValue(v)
Ensures that the parameter object is a String.
Definition rstring.h:66
static char * RSTRING_END(VALUE str)
Queries the end of the contents pointer of the string.
Definition rstring.h:442
#define StringValueCStr(v)
Identical to StringValuePtr, except it additionally checks for the contents for viability as a C stri...
Definition rstring.h:89
#define RUBY_TYPED_DEFAULT_FREE
This is a value you can set to rb_data_type_struct::dfree.
Definition rtypeddata.h:79
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
Definition rtypeddata.h:515
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
Definition rtypeddata.h:449
struct rb_data_type_struct rb_data_type_t
This is the struct that holds necessary info for a struct.
Definition rtypeddata.h:197
#define TypedData_Make_Struct(klass, type, data_type, sval)
Identical to TypedData_Wrap_Struct, except it allocates a new data region internally instead of takin...
Definition rtypeddata.h:497
#define FilePathValue(v)
Ensures that the parameter object is a path.
Definition ruby.h:90
#define RTEST
This is an old name of RB_TEST.
Definition iseq.h:270
const ID * segments
A null-terminated list of ids, used to represent a constant's path idNULL is used to represent the ::...
Definition vm_core.h:285
Definition iseq.h:241
A line and column in a string.
uint32_t column
The column number.
int32_t line
The line number.
This represents a range of bytes in the source string to which a node or token corresponds.
Definition ast.h:545
const uint8_t * start
A pointer to the start location of the range in the source.
Definition ast.h:547
const uint8_t * end
A pointer to the end location of the range in the source.
Definition ast.h:550
size_t size
The number of offsets in the list.
uint32_t node_id
The unique identifier for this node, which is deterministic based on the source.
Definition ast.h:1086
pm_location_t location
This is the location of the node in the source.
Definition ast.h:1092
int32_t line
The line within the file that the parse starts on.
Definition options.h:115
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.
int32_t start_line
The line number at the start of the parse.
Definition parser.h:809
pm_newline_list_t newline_list
This is the list of newline offsets in the source file.
Definition parser.h:789
VALUE * script_lines
This is a pointer to the list of script lines for the ISEQs that will be associated with this scope n...
Definition method.h:62
struct rb_iseq_constant_body::@000024342312237062266020177166377106262102236123 param
parameter information
Definition vm_core.h:297
intptr_t SIGNED_VALUE
A signed integer type that has the same width with VALUE.
Definition value.h:63
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