Ruby: iseq.c Source File

Ruby 3.4.8p72 (2025-12-17 revision 995b59f66677d44767ce9faac6957e5543617ff9)

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
48 VALUE 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
500struct rb_iseq_constant_body *
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
516 VALUE
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 RB_OBJ_WRITE(iseq, &body->local_iseq, ISEQ_BODY(piseq)->local_iseq);
598 }
599
600 if (piseq) {
601 RB_OBJ_WRITE(iseq, &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 =
613 (struct iseq_compile_data_storage *)
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
1031 struct pm_iseq_new_with_opt_data {
1032 rb_iseq_t *iseq;
1033 pm_scope_node_t *node;
1034};
1035
1036 VALUE
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
1250 VALUE
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 bool parse_file = false;
1323 if (RB_TYPE_P(src, T_FILE)) {
1324 parse_file = true;
1325 src = rb_io_path(src);
1326 }
1327 else {
1328 src = StringValue(src);
1329 }
1330
1331 pm_parse_result_t result = { 0 };
1332 pm_options_line_set(&result.options, NUM2INT(line));
1333 pm_options_scopes_init(&result.options, 1);
1334 result.node.coverage_enabled = 1;
1335
1336 switch (option.frozen_string_literal) {
1337 case ISEQ_FROZEN_STRING_LITERAL_UNSET:
1338 break;
1339 case ISEQ_FROZEN_STRING_LITERAL_DISABLED:
1340 pm_options_frozen_string_literal_set(&result.options, false);
1341 break;
1342 case ISEQ_FROZEN_STRING_LITERAL_ENABLED:
1343 pm_options_frozen_string_literal_set(&result.options, true);
1344 break;
1345 default:
1346 rb_bug("pm_iseq_compile_with_option: invalid frozen_string_literal=%d", option.frozen_string_literal);
1347 break;
1348 }
1349
1350 VALUE script_lines;
1351 VALUE error;
1352
1353 if (parse_file) {
1354 error = pm_load_parse_file(&result, src, ruby_vm_keep_script_lines ? &script_lines : NULL);
1355 }
1356 else {
1357 error = pm_parse_string(&result, src, file, ruby_vm_keep_script_lines ? &script_lines : NULL);
1358 }
1359
1360 RB_GC_GUARD(src);
1361
1362 if (error == Qnil) {
1363 int error_state;
1364 iseq = pm_iseq_new_with_opt(&result.node, name, file, realpath, ln, NULL, 0, ISEQ_TYPE_TOP, &option, &error_state);
1365
1366 pm_parse_result_free(&result);
1367
1368 if (error_state) {
1369 RUBY_ASSERT(iseq == NULL);
1370 rb_jump_tag(error_state);
1371 }
1372 }
1373 else {
1374 pm_parse_result_free(&result);
1375 rb_exc_raise(error);
1376 }
1377
1378 return iseq;
1379}
1380
1381 VALUE
1382rb_iseq_path(const rb_iseq_t *iseq)
1383{
1384 return pathobj_path(ISEQ_BODY(iseq)->location.pathobj);
1385}
1386
1387 VALUE
1388rb_iseq_realpath(const rb_iseq_t *iseq)
1389{
1390 return pathobj_realpath(ISEQ_BODY(iseq)->location.pathobj);
1391}
1392
1393 VALUE
1394rb_iseq_absolute_path(const rb_iseq_t *iseq)
1395{
1396 return rb_iseq_realpath(iseq);
1397}
1398
1399int
1400rb_iseq_from_eval_p(const rb_iseq_t *iseq)
1401{
1402 return NIL_P(rb_iseq_realpath(iseq));
1403}
1404
1405 VALUE
1406rb_iseq_label(const rb_iseq_t *iseq)
1407{
1408 return ISEQ_BODY(iseq)->location.label;
1409}
1410
1411 VALUE
1412rb_iseq_base_label(const rb_iseq_t *iseq)
1413{
1414 return ISEQ_BODY(iseq)->location.base_label;
1415}
1416
1417 VALUE
1418rb_iseq_first_lineno(const rb_iseq_t *iseq)
1419{
1420 return RB_INT2NUM(ISEQ_BODY(iseq)->location.first_lineno);
1421}
1422
1423 VALUE
1424rb_iseq_method_name(const rb_iseq_t *iseq)
1425{
1426 struct rb_iseq_constant_body *const body = ISEQ_BODY(ISEQ_BODY(iseq)->local_iseq);
1427
1428 if (body->type == ISEQ_TYPE_METHOD) {
1429 return body->location.base_label;
1430 }
1431 else {
1432 return Qnil;
1433 }
1434}
1435
1436void
1437rb_iseq_code_location(const rb_iseq_t *iseq, int *beg_pos_lineno, int *beg_pos_column, int *end_pos_lineno, int *end_pos_column)
1438{
1439 const rb_code_location_t *loc = &ISEQ_BODY(iseq)->location.code_location;
1440 if (beg_pos_lineno) *beg_pos_lineno = loc->beg_pos.lineno;
1441 if (beg_pos_column) *beg_pos_column = loc->beg_pos.column;
1442 if (end_pos_lineno) *end_pos_lineno = loc->end_pos.lineno;
1443 if (end_pos_column) *end_pos_column = loc->end_pos.column;
1444}
1445
1446static ID iseq_type_id(enum rb_iseq_type type);
1447
1448 VALUE
1449rb_iseq_type(const rb_iseq_t *iseq)
1450{
1451 return ID2SYM(iseq_type_id(ISEQ_BODY(iseq)->type));
1452}
1453
1454 VALUE
1455rb_iseq_coverage(const rb_iseq_t *iseq)
1456{
1457 return ISEQ_COVERAGE(iseq);
1458}
1459
1460static int
1461remove_coverage_i(void *vstart, void *vend, size_t stride, void *data)
1462{
1463 VALUE v = (VALUE)vstart;
1464 for (; v != (VALUE)vend; v += stride) {
1465 void *ptr = rb_asan_poisoned_object_p(v);
1466 rb_asan_unpoison_object(v, false);
1467
1468 if (rb_obj_is_iseq(v)) {
1469 rb_iseq_t *iseq = (rb_iseq_t *)v;
1470 ISEQ_COVERAGE_SET(iseq, Qnil);
1471 }
1472
1473 asan_poison_object_if(ptr, v);
1474 }
1475 return 0;
1476}
1477
1478void
1479rb_iseq_remove_coverage_all(void)
1480{
1481 rb_objspace_each_objects(remove_coverage_i, NULL);
1482}
1483
1484/* define wrapper class methods (RubyVM::InstructionSequence) */
1485
1486static void
1487iseqw_mark(void *ptr)
1488{
1489 rb_gc_mark_movable(*(VALUE *)ptr);
1490}
1491
1492static size_t
1493iseqw_memsize(const void *ptr)
1494{
1495 return rb_iseq_memsize(*(const rb_iseq_t **)ptr);
1496}
1497
1498static void
1499iseqw_ref_update(void *ptr)
1500{
1501 VALUE *vptr = ptr;
1502 *vptr = rb_gc_location(*vptr);
1503}
1504
1505static const rb_data_type_t iseqw_data_type = {
1506 "T_IMEMO/iseq",
1507 {
1508 iseqw_mark,
1509 RUBY_TYPED_DEFAULT_FREE,
1510 iseqw_memsize,
1511 iseqw_ref_update,
1512 },
1513 0, 0, RUBY_TYPED_FREE_IMMEDIATELY|RUBY_TYPED_WB_PROTECTED
1514};
1515
1516static VALUE
1517iseqw_new(const rb_iseq_t *iseq)
1518{
1519 if (iseq->wrapper) {
1520 if (*(const rb_iseq_t **)rb_check_typeddata(iseq->wrapper, &iseqw_data_type) != iseq) {
1521 rb_raise(rb_eTypeError, "wrong iseq wrapper: %" PRIsVALUE " for %p",
1522 iseq->wrapper, (void *)iseq);
1523 }
1524 return iseq->wrapper;
1525 }
1526 else {
1527 rb_iseq_t **ptr;
1528 VALUE obj = TypedData_Make_Struct(rb_cISeq, rb_iseq_t *, &iseqw_data_type, ptr);
1529 RB_OBJ_WRITE(obj, ptr, iseq);
1530
1531 /* cache a wrapper object */
1532 RB_OBJ_WRITE((VALUE)iseq, &iseq->wrapper, obj);
1533 RB_OBJ_FREEZE((VALUE)iseq);
1534
1535 return obj;
1536 }
1537}
1538
1539 VALUE
1540rb_iseqw_new(const rb_iseq_t *iseq)
1541{
1542 return iseqw_new(iseq);
1543}
1544
1550static VALUE
1551iseqw_s_compile_parser(int argc, VALUE *argv, VALUE self, bool prism)
1552{
1553 VALUE src, file = Qnil, path = Qnil, line = Qnil, opt = Qnil;
1554 int i;
1555
1556 i = rb_scan_args(argc, argv, "1*:", &src, NULL, &opt);
1557 if (i > 4+NIL_P(opt)) rb_error_arity(argc, 1, 5);
1558 switch (i) {
1559 case 5: opt = argv[--i];
1560 case 4: line = argv[--i];
1561 case 3: path = argv[--i];
1562 case 2: file = argv[--i];
1563 }
1564
1565 if (NIL_P(file)) file = rb_fstring_lit("<compiled>");
1566 if (NIL_P(path)) path = file;
1567 if (NIL_P(line)) line = INT2FIX(1);
1568
1569 Check_Type(path, T_STRING);
1570 Check_Type(file, T_STRING);
1571
1572 rb_iseq_t *iseq;
1573 if (prism) {
1574 iseq = pm_iseq_compile_with_option(src, file, path, line, opt);
1575 }
1576 else {
1577 iseq = rb_iseq_compile_with_option(src, file, path, line, opt);
1578 }
1579
1580 return iseqw_new(iseq);
1581}
1582
1583/*
1584 * call-seq:
1585 * InstructionSequence.compile(source[, file[, path[, line[, options]]]]) -> iseq
1586 * InstructionSequence.new(source[, file[, path[, line[, options]]]]) -> iseq
1587 *
1588 * Takes +source+, which can be a string of Ruby code, or an open +File+ object.
1589 * that contains Ruby source code.
1590 *
1591 * Optionally takes +file+, +path+, and +line+ which describe the file path,
1592 * real path and first line number of the ruby code in +source+ which are
1593 * metadata attached to the returned +iseq+.
1594 *
1595 * +file+ is used for `__FILE__` and exception backtrace. +path+ is used for
1596 * +require_relative+ base. It is recommended these should be the same full
1597 * path.
1598 *
1599 * +options+, which can be +true+, +false+ or a +Hash+, is used to
1600 * modify the default behavior of the Ruby iseq compiler.
1601 *
1602 * For details regarding valid compile options see ::compile_option=.
1603 *
1604 * RubyVM::InstructionSequence.compile("a = 1 + 2")
1605 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
1606 *
1607 * path = "test.rb"
1608 * RubyVM::InstructionSequence.compile(File.read(path), path, File.expand_path(path))
1609 * #=> <RubyVM::InstructionSequence:<compiled>@test.rb:1>
1610 *
1611 * file = File.open("test.rb")
1612 * RubyVM::InstructionSequence.compile(file)
1613 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>:1>
1614 *
1615 * path = File.expand_path("test.rb")
1616 * RubyVM::InstructionSequence.compile(File.read(path), path, path)
1617 * #=> <RubyVM::InstructionSequence:<compiled>@/absolute/path/to/test.rb:1>
1618 *
1619 */
1620static VALUE
1621iseqw_s_compile(int argc, VALUE *argv, VALUE self)
1622{
1623 return iseqw_s_compile_parser(argc, argv, self, rb_ruby_prism_p());
1624}
1625
1626/*
1627 * call-seq:
1628 * InstructionSequence.compile_parsey(source[, file[, path[, line[, options]]]]) -> iseq
1629 *
1630 * Takes +source+, which can be a string of Ruby code, or an open +File+ object.
1631 * that contains Ruby source code. It parses and compiles using parse.y.
1632 *
1633 * Optionally takes +file+, +path+, and +line+ which describe the file path,
1634 * real path and first line number of the ruby code in +source+ which are
1635 * metadata attached to the returned +iseq+.
1636 *
1637 * +file+ is used for `__FILE__` and exception backtrace. +path+ is used for
1638 * +require_relative+ base. It is recommended these should be the same full
1639 * path.
1640 *
1641 * +options+, which can be +true+, +false+ or a +Hash+, is used to
1642 * modify the default behavior of the Ruby iseq compiler.
1643 *
1644 * For details regarding valid compile options see ::compile_option=.
1645 *
1646 * RubyVM::InstructionSequence.compile_parsey("a = 1 + 2")
1647 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
1648 *
1649 * path = "test.rb"
1650 * RubyVM::InstructionSequence.compile_parsey(File.read(path), path, File.expand_path(path))
1651 * #=> <RubyVM::InstructionSequence:<compiled>@test.rb:1>
1652 *
1653 * file = File.open("test.rb")
1654 * RubyVM::InstructionSequence.compile_parsey(file)
1655 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>:1>
1656 *
1657 * path = File.expand_path("test.rb")
1658 * RubyVM::InstructionSequence.compile_parsey(File.read(path), path, path)
1659 * #=> <RubyVM::InstructionSequence:<compiled>@/absolute/path/to/test.rb:1>
1660 *
1661 */
1662static VALUE
1663iseqw_s_compile_parsey(int argc, VALUE *argv, VALUE self)
1664{
1665 return iseqw_s_compile_parser(argc, argv, self, false);
1666}
1667
1668/*
1669 * call-seq:
1670 * InstructionSequence.compile_prism(source[, file[, path[, line[, options]]]]) -> iseq
1671 *
1672 * Takes +source+, which can be a string of Ruby code, or an open +File+ object.
1673 * that contains Ruby source code. It parses and compiles using prism.
1674 *
1675 * Optionally takes +file+, +path+, and +line+ which describe the file path,
1676 * real path and first line number of the ruby code in +source+ which are
1677 * metadata attached to the returned +iseq+.
1678 *
1679 * +file+ is used for `__FILE__` and exception backtrace. +path+ is used for
1680 * +require_relative+ base. It is recommended these should be the same full
1681 * path.
1682 *
1683 * +options+, which can be +true+, +false+ or a +Hash+, is used to
1684 * modify the default behavior of the Ruby iseq compiler.
1685 *
1686 * For details regarding valid compile options see ::compile_option=.
1687 *
1688 * RubyVM::InstructionSequence.compile_prism("a = 1 + 2")
1689 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
1690 *
1691 * path = "test.rb"
1692 * RubyVM::InstructionSequence.compile_prism(File.read(path), path, File.expand_path(path))
1693 * #=> <RubyVM::InstructionSequence:<compiled>@test.rb:1>
1694 *
1695 * file = File.open("test.rb")
1696 * RubyVM::InstructionSequence.compile_prism(file)
1697 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>:1>
1698 *
1699 * path = File.expand_path("test.rb")
1700 * RubyVM::InstructionSequence.compile_prism(File.read(path), path, path)
1701 * #=> <RubyVM::InstructionSequence:<compiled>@/absolute/path/to/test.rb:1>
1702 *
1703 */
1704static VALUE
1705iseqw_s_compile_prism(int argc, VALUE *argv, VALUE self)
1706{
1707 return iseqw_s_compile_parser(argc, argv, self, true);
1708}
1709
1710/*
1711 * call-seq:
1712 * InstructionSequence.compile_file(file[, options]) -> iseq
1713 *
1714 * Takes +file+, a String with the location of a Ruby source file, reads,
1715 * parses and compiles the file, and returns +iseq+, the compiled
1716 * InstructionSequence with source location metadata set.
1717 *
1718 * Optionally takes +options+, which can be +true+, +false+ or a +Hash+, to
1719 * modify the default behavior of the Ruby iseq compiler.
1720 *
1721 * For details regarding valid compile options see ::compile_option=.
1722 *
1723 * # /tmp/hello.rb
1724 * puts "Hello, world!"
1725 *
1726 * # elsewhere
1727 * RubyVM::InstructionSequence.compile_file("/tmp/hello.rb")
1728 * #=> <RubyVM::InstructionSequence:<main>@/tmp/hello.rb>
1729 */
1730static VALUE
1731iseqw_s_compile_file(int argc, VALUE *argv, VALUE self)
1732{
1733 VALUE file, opt = Qnil;
1734 VALUE parser, f, exc = Qnil, ret;
1735 rb_ast_t *ast;
1736 VALUE ast_value;
1737 rb_compile_option_t option;
1738 int i;
1739
1740 i = rb_scan_args(argc, argv, "1*:", &file, NULL, &opt);
1741 if (i > 1+NIL_P(opt)) rb_error_arity(argc, 1, 2);
1742 switch (i) {
1743 case 2: opt = argv[--i];
1744 }
1745 FilePathValue(file);
1746 file = rb_fstring(file); /* rb_io_t->pathv gets frozen anyways */
1747
1748 f = rb_file_open_str(file, "r");
1749
1750 rb_execution_context_t *ec = GET_EC();
1751 VALUE v = rb_vm_push_frame_fname(ec, file);
1752
1753 parser = rb_parser_new();
1754 rb_parser_set_context(parser, NULL, FALSE);
1755 ast_value = rb_parser_load_file(parser, file);
1756 ast = rb_ruby_ast_data_get(ast_value);
1757 if (!ast->body.root) exc = GET_EC()->errinfo;
1758
1759 rb_io_close(f);
1760 if (!ast->body.root) {
1761 rb_ast_dispose(ast);
1762 rb_exc_raise(exc);
1763 }
1764
1765 make_compile_option(&option, opt);
1766
1767 ret = iseqw_new(rb_iseq_new_with_opt(ast_value, rb_fstring_lit("<main>"),
1768 file,
1769 rb_realpath_internal(Qnil, file, 1),
1770 1, NULL, 0, ISEQ_TYPE_TOP, &option,
1771 Qnil));
1772 rb_ast_dispose(ast);
1773 RB_GC_GUARD(ast_value);
1774
1775 rb_vm_pop_frame(ec);
1776 RB_GC_GUARD(v);
1777 return ret;
1778}
1779
1780/*
1781 * call-seq:
1782 * InstructionSequence.compile_file_prism(file[, options]) -> iseq
1783 *
1784 * Takes +file+, a String with the location of a Ruby source file, reads,
1785 * parses and compiles the file, and returns +iseq+, the compiled
1786 * InstructionSequence with source location metadata set. It parses and
1787 * compiles using prism.
1788 *
1789 * Optionally takes +options+, which can be +true+, +false+ or a +Hash+, to
1790 * modify the default behavior of the Ruby iseq compiler.
1791 *
1792 * For details regarding valid compile options see ::compile_option=.
1793 *
1794 * # /tmp/hello.rb
1795 * puts "Hello, world!"
1796 *
1797 * # elsewhere
1798 * RubyVM::InstructionSequence.compile_file_prism("/tmp/hello.rb")
1799 * #=> <RubyVM::InstructionSequence:<main>@/tmp/hello.rb>
1800 */
1801static VALUE
1802iseqw_s_compile_file_prism(int argc, VALUE *argv, VALUE self)
1803{
1804 VALUE file, opt = Qnil, ret;
1805 rb_compile_option_t option;
1806 int i;
1807
1808 i = rb_scan_args(argc, argv, "1*:", &file, NULL, &opt);
1809 if (i > 1+NIL_P(opt)) rb_error_arity(argc, 1, 2);
1810 switch (i) {
1811 case 2: opt = argv[--i];
1812 }
1813 FilePathValue(file);
1814 file = rb_fstring(file); /* rb_io_t->pathv gets frozen anyways */
1815
1816 rb_execution_context_t *ec = GET_EC();
1817 VALUE v = rb_vm_push_frame_fname(ec, file);
1818
1819 pm_parse_result_t result = { 0 };
1820 result.options.line = 1;
1821 result.node.coverage_enabled = 1;
1822
1823 VALUE script_lines;
1824 VALUE error = pm_load_parse_file(&result, file, ruby_vm_keep_script_lines ? &script_lines : NULL);
1825
1826 if (error == Qnil) {
1827 make_compile_option(&option, opt);
1828
1829 int error_state;
1830 rb_iseq_t *iseq = pm_iseq_new_with_opt(&result.node, rb_fstring_lit("<main>"),
1831 file,
1832 rb_realpath_internal(Qnil, file, 1),
1833 1, NULL, 0, ISEQ_TYPE_TOP, &option, &error_state);
1834
1835 pm_parse_result_free(&result);
1836
1837 if (error_state) {
1838 RUBY_ASSERT(iseq == NULL);
1839 rb_jump_tag(error_state);
1840 }
1841
1842 ret = iseqw_new(iseq);
1843 rb_vm_pop_frame(ec);
1844 RB_GC_GUARD(v);
1845 return ret;
1846 } else {
1847 pm_parse_result_free(&result);
1848 rb_vm_pop_frame(ec);
1849 RB_GC_GUARD(v);
1850 rb_exc_raise(error);
1851 }
1852}
1853
1854/*
1855 * call-seq:
1856 * InstructionSequence.compile_option = options
1857 *
1858 * Sets the default values for various optimizations in the Ruby iseq
1859 * compiler.
1860 *
1861 * Possible values for +options+ include +true+, which enables all options,
1862 * +false+ which disables all options, and +nil+ which leaves all options
1863 * unchanged.
1864 *
1865 * You can also pass a +Hash+ of +options+ that you want to change, any
1866 * options not present in the hash will be left unchanged.
1867 *
1868 * Possible option names (which are keys in +options+) which can be set to
1869 * +true+ or +false+ include:
1870 *
1871 * * +:inline_const_cache+
1872 * * +:instructions_unification+
1873 * * +:operands_unification+
1874 * * +:peephole_optimization+
1875 * * +:specialized_instruction+
1876 * * +:tailcall_optimization+
1877 *
1878 * Additionally, +:debug_level+ can be set to an integer.
1879 *
1880 * These default options can be overwritten for a single run of the iseq
1881 * compiler by passing any of the above values as the +options+ parameter to
1882 * ::new, ::compile and ::compile_file.
1883 */
1884static VALUE
1885iseqw_s_compile_option_set(VALUE self, VALUE opt)
1886{
1887 rb_compile_option_t option;
1888 make_compile_option(&option, opt);
1889 COMPILE_OPTION_DEFAULT = option;
1890 return opt;
1891}
1892
1893/*
1894 * call-seq:
1895 * InstructionSequence.compile_option -> options
1896 *
1897 * Returns a hash of default options used by the Ruby iseq compiler.
1898 *
1899 * For details, see InstructionSequence.compile_option=.
1900 */
1901static VALUE
1902iseqw_s_compile_option_get(VALUE self)
1903{
1904 return make_compile_option_value(&COMPILE_OPTION_DEFAULT);
1905}
1906
1907static const rb_iseq_t *
1908iseqw_check(VALUE iseqw)
1909{
1910 rb_iseq_t **iseq_ptr;
1911 TypedData_Get_Struct(iseqw, rb_iseq_t *, &iseqw_data_type, iseq_ptr);
1912 rb_iseq_t *iseq = *iseq_ptr;
1913
1914 if (!ISEQ_BODY(iseq)) {
1915 rb_ibf_load_iseq_complete(iseq);
1916 }
1917
1918 if (!ISEQ_BODY(iseq)->location.label) {
1919 rb_raise(rb_eTypeError, "uninitialized InstructionSequence");
1920 }
1921 return iseq;
1922}
1923
1924const rb_iseq_t *
1925rb_iseqw_to_iseq(VALUE iseqw)
1926{
1927 return iseqw_check(iseqw);
1928}
1929
1930/*
1931 * call-seq:
1932 * iseq.eval -> obj
1933 *
1934 * Evaluates the instruction sequence and returns the result.
1935 *
1936 * RubyVM::InstructionSequence.compile("1 + 2").eval #=> 3
1937 */
1938static VALUE
1939iseqw_eval(VALUE self)
1940{
1941 const rb_iseq_t *iseq = iseqw_check(self);
1942 if (0 == ISEQ_BODY(iseq)->iseq_size) {
1943 rb_raise(rb_eTypeError, "attempt to evaluate dummy InstructionSequence");
1944 }
1945 return rb_iseq_eval(iseq);
1946}
1947
1948/*
1949 * Returns a human-readable string representation of this instruction
1950 * sequence, including the #label and #path.
1951 */
1952static VALUE
1953iseqw_inspect(VALUE self)
1954{
1955 const rb_iseq_t *iseq = iseqw_check(self);
1956 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
1957 VALUE klass = rb_class_name(rb_obj_class(self));
1958
1959 if (!body->location.label) {
1960 return rb_sprintf("#<%"PRIsVALUE": uninitialized>", klass);
1961 }
1962 else {
1963 return rb_sprintf("<%"PRIsVALUE":%"PRIsVALUE"@%"PRIsVALUE":%d>",
1964 klass,
1965 body->location.label, rb_iseq_path(iseq),
1966 FIX2INT(rb_iseq_first_lineno(iseq)));
1967 }
1968}
1969
1970/*
1971 * Returns the path of this instruction sequence.
1972 *
1973 * <code><compiled></code> if the iseq was evaluated from a string.
1974 *
1975 * For example, using irb:
1976 *
1977 * iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
1978 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
1979 * iseq.path
1980 * #=> "<compiled>"
1981 *
1982 * Using ::compile_file:
1983 *
1984 * # /tmp/method.rb
1985 * def hello
1986 * puts "hello, world"
1987 * end
1988 *
1989 * # in irb
1990 * > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
1991 * > iseq.path #=> /tmp/method.rb
1992 */
1993static VALUE
1994iseqw_path(VALUE self)
1995{
1996 return rb_iseq_path(iseqw_check(self));
1997}
1998
1999/*
2000 * Returns the absolute path of this instruction sequence.
2001 *
2002 * +nil+ if the iseq was evaluated from a string.
2003 *
2004 * For example, using ::compile_file:
2005 *
2006 * # /tmp/method.rb
2007 * def hello
2008 * puts "hello, world"
2009 * end
2010 *
2011 * # in irb
2012 * > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
2013 * > iseq.absolute_path #=> /tmp/method.rb
2014 */
2015static VALUE
2016iseqw_absolute_path(VALUE self)
2017{
2018 return rb_iseq_realpath(iseqw_check(self));
2019}
2020
2021/* Returns the label of this instruction sequence.
2022 *
2023 * <code><main></code> if it's at the top level, <code><compiled></code> if it
2024 * was evaluated from a string.
2025 *
2026 * For example, using irb:
2027 *
2028 * iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
2029 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
2030 * iseq.label
2031 * #=> "<compiled>"
2032 *
2033 * Using ::compile_file:
2034 *
2035 * # /tmp/method.rb
2036 * def hello
2037 * puts "hello, world"
2038 * end
2039 *
2040 * # in irb
2041 * > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
2042 * > iseq.label #=> <main>
2043 */
2044static VALUE
2045iseqw_label(VALUE self)
2046{
2047 return rb_iseq_label(iseqw_check(self));
2048}
2049
2050/* Returns the base label of this instruction sequence.
2051 *
2052 * For example, using irb:
2053 *
2054 * iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
2055 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
2056 * iseq.base_label
2057 * #=> "<compiled>"
2058 *
2059 * Using ::compile_file:
2060 *
2061 * # /tmp/method.rb
2062 * def hello
2063 * puts "hello, world"
2064 * end
2065 *
2066 * # in irb
2067 * > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
2068 * > iseq.base_label #=> <main>
2069 */
2070static VALUE
2071iseqw_base_label(VALUE self)
2072{
2073 return rb_iseq_base_label(iseqw_check(self));
2074}
2075
2076/* Returns the number of the first source line where the instruction sequence
2077 * was loaded from.
2078 *
2079 * For example, using irb:
2080 *
2081 * iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
2082 * #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
2083 * iseq.first_lineno
2084 * #=> 1
2085 */
2086static VALUE
2087iseqw_first_lineno(VALUE self)
2088{
2089 return rb_iseq_first_lineno(iseqw_check(self));
2090}
2091
2092static VALUE iseq_data_to_ary(const rb_iseq_t *iseq);
2093
2094/*
2095 * call-seq:
2096 * iseq.to_a -> ary
2097 *
2098 * Returns an Array with 14 elements representing the instruction sequence
2099 * with the following data:
2100 *
2101 * [magic]
2102 * A string identifying the data format. <b>Always
2103 * +YARVInstructionSequence/SimpleDataFormat+.</b>
2104 *
2105 * [major_version]
2106 * The major version of the instruction sequence.
2107 *
2108 * [minor_version]
2109 * The minor version of the instruction sequence.
2110 *
2111 * [format_type]
2112 * A number identifying the data format. <b>Always 1</b>.
2113 *
2114 * [misc]
2115 * A hash containing:
2116 *
2117 * [+:arg_size+]
2118 * the total number of arguments taken by the method or the block (0 if
2119 * _iseq_ doesn't represent a method or block)
2120 * [+:local_size+]
2121 * the number of local variables + 1
2122 * [+:stack_max+]
2123 * used in calculating the stack depth at which a SystemStackError is
2124 * thrown.
2125 *
2126 * [#label]
2127 * The name of the context (block, method, class, module, etc.) that this
2128 * instruction sequence belongs to.
2129 *
2130 * <code><main></code> if it's at the top level, <code><compiled></code> if
2131 * it was evaluated from a string.
2132 *
2133 * [#path]
2134 * The relative path to the Ruby file where the instruction sequence was
2135 * loaded from.
2136 *
2137 * <code><compiled></code> if the iseq was evaluated from a string.
2138 *
2139 * [#absolute_path]
2140 * The absolute path to the Ruby file where the instruction sequence was
2141 * loaded from.
2142 *
2143 * +nil+ if the iseq was evaluated from a string.
2144 *
2145 * [#first_lineno]
2146 * The number of the first source line where the instruction sequence was
2147 * loaded from.
2148 *
2149 * [type]
2150 * The type of the instruction sequence.
2151 *
2152 * Valid values are +:top+, +:method+, +:block+, +:class+, +:rescue+,
2153 * +:ensure+, +:eval+, +:main+, and +plain+.
2154 *
2155 * [locals]
2156 * An array containing the names of all arguments and local variables as
2157 * symbols.
2158 *
2159 * [params]
2160 * An Hash object containing parameter information.
2161 *
2162 * More info about these values can be found in +vm_core.h+.
2163 *
2164 * [catch_table]
2165 * A list of exceptions and control flow operators (rescue, next, redo,
2166 * break, etc.).
2167 *
2168 * [bytecode]
2169 * An array of arrays containing the instruction names and operands that
2170 * make up the body of the instruction sequence.
2171 *
2172 * Note that this format is MRI specific and version dependent.
2173 *
2174 */
2175static VALUE
2176iseqw_to_a(VALUE self)
2177{
2178 const rb_iseq_t *iseq = iseqw_check(self);
2179 return iseq_data_to_ary(iseq);
2180}
2181
2182#if VM_INSN_INFO_TABLE_IMPL == 1 /* binary search */
2183static const struct iseq_insn_info_entry *
2184get_insn_info_binary_search(const rb_iseq_t *iseq, size_t pos)
2185{
2186 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2187 size_t size = body->insns_info.size;
2188 const struct iseq_insn_info_entry *insns_info = body->insns_info.body;
2189 const unsigned int *positions = body->insns_info.positions;
2190 const int debug = 0;
2191
2192 if (debug) {
2193 printf("size: %"PRIuSIZE"\n", size);
2194 printf("insns_info[%"PRIuSIZE"]: position: %d, line: %d, pos: %"PRIuSIZE"\n",
2195 (size_t)0, positions[0], insns_info[0].line_no, pos);
2196 }
2197
2198 if (size == 0) {
2199 return NULL;
2200 }
2201 else if (size == 1) {
2202 return &insns_info[0];
2203 }
2204 else {
2205 size_t l = 1, r = size - 1;
2206 while (l <= r) {
2207 size_t m = l + (r - l) / 2;
2208 if (positions[m] == pos) {
2209 return &insns_info[m];
2210 }
2211 if (positions[m] < pos) {
2212 l = m + 1;
2213 }
2214 else {
2215 r = m - 1;
2216 }
2217 }
2218 if (l >= size) {
2219 return &insns_info[size-1];
2220 }
2221 if (positions[l] > pos) {
2222 return &insns_info[l-1];
2223 }
2224 return &insns_info[l];
2225 }
2226}
2227
2228static const struct iseq_insn_info_entry *
2229get_insn_info(const rb_iseq_t *iseq, size_t pos)
2230{
2231 return get_insn_info_binary_search(iseq, pos);
2232}
2233#endif
2234
2235#if VM_INSN_INFO_TABLE_IMPL == 2 /* succinct bitvector */
2236static const struct iseq_insn_info_entry *
2237get_insn_info_succinct_bitvector(const rb_iseq_t *iseq, size_t pos)
2238{
2239 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2240 size_t size = body->insns_info.size;
2241 const struct iseq_insn_info_entry *insns_info = body->insns_info.body;
2242 const int debug = 0;
2243
2244 if (debug) {
2245#if VM_CHECK_MODE > 0
2246 const unsigned int *positions = body->insns_info.positions;
2247 printf("size: %"PRIuSIZE"\n", size);
2248 printf("insns_info[%"PRIuSIZE"]: position: %d, line: %d, pos: %"PRIuSIZE"\n",
2249 (size_t)0, positions[0], insns_info[0].line_no, pos);
2250#else
2251 printf("size: %"PRIuSIZE"\n", size);
2252 printf("insns_info[%"PRIuSIZE"]: line: %d, pos: %"PRIuSIZE"\n",
2253 (size_t)0, insns_info[0].line_no, pos);
2254#endif
2255 }
2256
2257 if (size == 0) {
2258 return NULL;
2259 }
2260 else if (size == 1) {
2261 return &insns_info[0];
2262 }
2263 else {
2264 int index;
2265 VM_ASSERT(body->insns_info.succ_index_table != NULL);
2266 index = succ_index_lookup(body->insns_info.succ_index_table, (int)pos);
2267 return &insns_info[index-1];
2268 }
2269}
2270
2271static const struct iseq_insn_info_entry *
2272get_insn_info(const rb_iseq_t *iseq, size_t pos)
2273{
2274 return get_insn_info_succinct_bitvector(iseq, pos);
2275}
2276#endif
2277
2278#if VM_CHECK_MODE > 0 || VM_INSN_INFO_TABLE_IMPL == 0
2279static const struct iseq_insn_info_entry *
2280get_insn_info_linear_search(const rb_iseq_t *iseq, size_t pos)
2281{
2282 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2283 size_t i = 0, size = body->insns_info.size;
2284 const struct iseq_insn_info_entry *insns_info = body->insns_info.body;
2285 const unsigned int *positions = body->insns_info.positions;
2286 const int debug = 0;
2287
2288 if (debug) {
2289 printf("size: %"PRIuSIZE"\n", size);
2290 printf("insns_info[%"PRIuSIZE"]: position: %d, line: %d, pos: %"PRIuSIZE"\n",
2291 i, positions[i], insns_info[i].line_no, pos);
2292 }
2293
2294 if (size == 0) {
2295 return NULL;
2296 }
2297 else if (size == 1) {
2298 return &insns_info[0];
2299 }
2300 else {
2301 for (i=1; i<size; i++) {
2302 if (debug) printf("insns_info[%"PRIuSIZE"]: position: %d, line: %d, pos: %"PRIuSIZE"\n",
2303 i, positions[i], insns_info[i].line_no, pos);
2304
2305 if (positions[i] == pos) {
2306 return &insns_info[i];
2307 }
2308 if (positions[i] > pos) {
2309 return &insns_info[i-1];
2310 }
2311 }
2312 }
2313 return &insns_info[i-1];
2314}
2315#endif
2316
2317#if VM_INSN_INFO_TABLE_IMPL == 0 /* linear search */
2318static const struct iseq_insn_info_entry *
2319get_insn_info(const rb_iseq_t *iseq, size_t pos)
2320{
2321 return get_insn_info_linear_search(iseq, pos);
2322}
2323#endif
2324
2325#if VM_CHECK_MODE > 0 && VM_INSN_INFO_TABLE_IMPL > 0
2326static void
2327validate_get_insn_info(const rb_iseq_t *iseq)
2328{
2329 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2330 size_t i;
2331 for (i = 0; i < body->iseq_size; i++) {
2332 if (get_insn_info_linear_search(iseq, i) != get_insn_info(iseq, i)) {
2333 rb_bug("validate_get_insn_info: get_insn_info_linear_search(iseq, %"PRIuSIZE") != get_insn_info(iseq, %"PRIuSIZE")", i, i);
2334 }
2335 }
2336}
2337#endif
2338
2339unsigned int
2340rb_iseq_line_no(const rb_iseq_t *iseq, size_t pos)
2341{
2342 const struct iseq_insn_info_entry *entry = get_insn_info(iseq, pos);
2343
2344 if (entry) {
2345 return entry->line_no;
2346 }
2347 else {
2348 return 0;
2349 }
2350}
2351
2352#ifdef USE_ISEQ_NODE_ID
2353int
2354rb_iseq_node_id(const rb_iseq_t *iseq, size_t pos)
2355{
2356 const struct iseq_insn_info_entry *entry = get_insn_info(iseq, pos);
2357
2358 if (entry) {
2359 return entry->node_id;
2360 }
2361 else {
2362 return 0;
2363 }
2364}
2365#endif
2366
2367 rb_event_flag_t
2368rb_iseq_event_flags(const rb_iseq_t *iseq, size_t pos)
2369{
2370 const struct iseq_insn_info_entry *entry = get_insn_info(iseq, pos);
2371 if (entry) {
2372 return entry->events;
2373 }
2374 else {
2375 return 0;
2376 }
2377}
2378
2379void
2380rb_iseq_clear_event_flags(const rb_iseq_t *iseq, size_t pos, rb_event_flag_t reset)
2381{
2382 struct iseq_insn_info_entry *entry = (struct iseq_insn_info_entry *)get_insn_info(iseq, pos);
2383 if (entry) {
2384 entry->events &= ~reset;
2385 if (!(entry->events & iseq->aux.exec.global_trace_events)) {
2386 void rb_iseq_trace_flag_cleared(const rb_iseq_t *iseq, size_t pos);
2387 rb_iseq_trace_flag_cleared(iseq, pos);
2388 }
2389 }
2390}
2391
2392static VALUE
2393local_var_name(const rb_iseq_t *diseq, VALUE level, VALUE op)
2394{
2395 VALUE i;
2396 VALUE name;
2397 ID lid;
2398 int idx;
2399
2400 for (i = 0; i < level; i++) {
2401 diseq = ISEQ_BODY(diseq)->parent_iseq;
2402 }
2403 idx = ISEQ_BODY(diseq)->local_table_size - (int)op - 1;
2404 lid = ISEQ_BODY(diseq)->local_table[idx];
2405 name = rb_id2str(lid);
2406 if (!name) {
2407 name = rb_str_new_cstr("?");
2408 }
2409 else if (!rb_is_local_id(lid)) {
2410 name = rb_str_inspect(name);
2411 }
2412 else {
2413 name = rb_str_dup(name);
2414 }
2415 rb_str_catf(name, "@%d", idx);
2416 return name;
2417}
2418
2419int rb_insn_unified_local_var_level(VALUE);
2420 VALUE rb_dump_literal(VALUE lit);
2421
2422 VALUE
2423rb_insn_operand_intern(const rb_iseq_t *iseq,
2424 VALUE insn, int op_no, VALUE op,
2425 int len, size_t pos, const VALUE *pnop, VALUE child)
2426{
2427 const char *types = insn_op_types(insn);
2428 char type = types[op_no];
2429 VALUE ret = Qundef;
2430
2431 switch (type) {
2432 case TS_OFFSET: /* LONG */
2433 ret = rb_sprintf("%"PRIdVALUE, (VALUE)(pos + len + op));
2434 break;
2435
2436 case TS_NUM: /* ULONG */
2437 if (insn == BIN(defined) && op_no == 0) {
2438 enum defined_type deftype = (enum defined_type)op;
2439 switch (deftype) {
2440 case DEFINED_FUNC:
2441 ret = rb_fstring_lit("func");
2442 break;
2443 case DEFINED_REF:
2444 ret = rb_fstring_lit("ref");
2445 break;
2446 case DEFINED_CONST_FROM:
2447 ret = rb_fstring_lit("constant-from");
2448 break;
2449 default:
2450 ret = rb_iseq_defined_string(deftype);
2451 break;
2452 }
2453 if (ret) break;
2454 }
2455 else if (insn == BIN(checktype) && op_no == 0) {
2456 const char *type_str = rb_type_str((enum ruby_value_type)op);
2457 if (type_str) {
2458 ret = rb_str_new_cstr(type_str); break;
2459 }
2460 }
2461 ret = rb_sprintf("%"PRIuVALUE, op);
2462 break;
2463
2464 case TS_LINDEX:{
2465 int level;
2466 if (types[op_no+1] == TS_NUM && pnop) {
2467 ret = local_var_name(iseq, *pnop, op - VM_ENV_DATA_SIZE);
2468 }
2469 else if ((level = rb_insn_unified_local_var_level(insn)) >= 0) {
2470 ret = local_var_name(iseq, (VALUE)level, op - VM_ENV_DATA_SIZE);
2471 }
2472 else {
2473 ret = rb_inspect(INT2FIX(op));
2474 }
2475 break;
2476 }
2477 case TS_ID: /* ID (symbol) */
2478 ret = rb_inspect(ID2SYM(op));
2479 break;
2480
2481 case TS_VALUE: /* VALUE */
2482 op = obj_resurrect(op);
2483 if (insn == BIN(defined) && op_no == 1 && FIXNUM_P(op)) {
2484 /* should be DEFINED_REF */
2485 int type = NUM2INT(op);
2486 if (type) {
2487 if (type & 1) {
2488 ret = rb_sprintf(":$%c", (type >> 1));
2489 }
2490 else {
2491 ret = rb_sprintf(":$%d", (type >> 1));
2492 }
2493 break;
2494 }
2495 }
2496 ret = rb_dump_literal(op);
2497 if (CLASS_OF(op) == rb_cISeq) {
2498 if (child) {
2499 rb_ary_push(child, op);
2500 }
2501 }
2502 break;
2503
2504 case TS_ISEQ: /* iseq */
2505 {
2506 if (op) {
2507 const rb_iseq_t *iseq = rb_iseq_check((rb_iseq_t *)op);
2508 ret = ISEQ_BODY(iseq)->location.label;
2509 if (child) {
2510 rb_ary_push(child, (VALUE)iseq);
2511 }
2512 }
2513 else {
2514 ret = rb_str_new2("nil");
2515 }
2516 break;
2517 }
2518
2519 case TS_IC:
2520 {
2521 ret = rb_sprintf("<ic:%"PRIdPTRDIFF" ", (union iseq_inline_storage_entry *)op - ISEQ_BODY(iseq)->is_entries);
2522 const ID *segments = ((IC)op)->segments;
2523 rb_str_cat2(ret, rb_id2name(*segments++));
2524 while (*segments) {
2525 rb_str_catf(ret, "::%s", rb_id2name(*segments++));
2526 }
2527 rb_str_cat2(ret, ">");
2528 }
2529 break;
2530 case TS_IVC:
2531 case TS_ICVARC:
2532 case TS_ISE:
2533 ret = rb_sprintf("<is:%"PRIdPTRDIFF">", (union iseq_inline_storage_entry *)op - ISEQ_BODY(iseq)->is_entries);
2534 break;
2535
2536 case TS_CALLDATA:
2537 {
2538 struct rb_call_data *cd = (struct rb_call_data *)op;
2539 const struct rb_callinfo *ci = cd->ci;
2540 VALUE ary = rb_ary_new();
2541 ID mid = vm_ci_mid(ci);
2542
2543 if (mid) {
2544 rb_ary_push(ary, rb_sprintf("mid:%"PRIsVALUE, rb_id2str(mid)));
2545 }
2546
2547 rb_ary_push(ary, rb_sprintf("argc:%d", vm_ci_argc(ci)));
2548
2549 if (vm_ci_flag(ci) & VM_CALL_KWARG) {
2550 const struct rb_callinfo_kwarg *kw_args = vm_ci_kwarg(ci);
2551 VALUE kw_ary = rb_ary_new_from_values(kw_args->keyword_len, kw_args->keywords);
2552 rb_ary_push(ary, rb_sprintf("kw:[%"PRIsVALUE"]", rb_ary_join(kw_ary, rb_str_new2(","))));
2553 }
2554
2555 if (vm_ci_flag(ci)) {
2556 VALUE flags = rb_ary_new();
2557# define CALL_FLAG(n) if (vm_ci_flag(ci) & VM_CALL_##n) rb_ary_push(flags, rb_str_new2(#n))
2558 CALL_FLAG(ARGS_SPLAT);
2559 CALL_FLAG(ARGS_SPLAT_MUT);
2560 CALL_FLAG(ARGS_BLOCKARG);
2561 CALL_FLAG(FCALL);
2562 CALL_FLAG(VCALL);
2563 CALL_FLAG(ARGS_SIMPLE);
2564 CALL_FLAG(TAILCALL);
2565 CALL_FLAG(SUPER);
2566 CALL_FLAG(ZSUPER);
2567 CALL_FLAG(KWARG);
2568 CALL_FLAG(KW_SPLAT);
2569 CALL_FLAG(KW_SPLAT_MUT);
2570 CALL_FLAG(FORWARDING);
2571 CALL_FLAG(OPT_SEND); /* maybe not reachable */
2572 rb_ary_push(ary, rb_ary_join(flags, rb_str_new2("|")));
2573 }
2574
2575 ret = rb_sprintf("<calldata!%"PRIsVALUE">", rb_ary_join(ary, rb_str_new2(", ")));
2576 }
2577 break;
2578
2579 case TS_CDHASH:
2580 ret = rb_str_new2("<cdhash>");
2581 break;
2582
2583 case TS_FUNCPTR:
2584 {
2585#ifdef HAVE_DLADDR
2586 Dl_info info;
2587 if (dladdr((void *)op, &info) && info.dli_sname) {
2588 ret = rb_str_new_cstr(info.dli_sname);
2589 break;
2590 }
2591#endif
2592 ret = rb_str_new2("<funcptr>");
2593 }
2594 break;
2595
2596 case TS_BUILTIN:
2597 {
2598 const struct rb_builtin_function *bf = (const struct rb_builtin_function *)op;
2599 ret = rb_sprintf("<builtin!%s/%d>",
2600 bf->name, bf->argc);
2601 }
2602 break;
2603
2604 default:
2605 rb_bug("unknown operand type: %c", type);
2606 }
2607 return ret;
2608}
2609
2610static VALUE
2611right_strip(VALUE str)
2612{
2613 const char *beg = RSTRING_PTR(str), *end = RSTRING_END(str);
2614 while (end-- > beg && *end == ' ');
2615 rb_str_set_len(str, end - beg + 1);
2616 return str;
2617}
2618
2623int
2624rb_iseq_disasm_insn(VALUE ret, const VALUE *code, size_t pos,
2625 const rb_iseq_t *iseq, VALUE child)
2626{
2627 VALUE insn = code[pos];
2628 int len = insn_len(insn);
2629 int j;
2630 const char *types = insn_op_types(insn);
2631 VALUE str = rb_str_new(0, 0);
2632 const char *insn_name_buff;
2633
2634 insn_name_buff = insn_name(insn);
2635 if (1) {
2636 extern const int rb_vm_max_insn_name_size;
2637 rb_str_catf(str, "%04"PRIuSIZE" %-*s ", pos, rb_vm_max_insn_name_size, insn_name_buff);
2638 }
2639 else {
2640 rb_str_catf(str, "%04"PRIuSIZE" %-28.*s ", pos,
2641 (int)strcspn(insn_name_buff, "_"), insn_name_buff);
2642 }
2643
2644 for (j = 0; types[j]; j++) {
2645 VALUE opstr = rb_insn_operand_intern(iseq, insn, j, code[pos + j + 1],
2646 len, pos, &code[pos + j + 2],
2647 child);
2648 rb_str_concat(str, opstr);
2649
2650 if (types[j + 1]) {
2651 rb_str_cat2(str, ", ");
2652 }
2653 }
2654
2655 {
2656 unsigned int line_no = rb_iseq_line_no(iseq, pos);
2657 unsigned int prev = pos == 0 ? 0 : rb_iseq_line_no(iseq, pos - 1);
2658 if (line_no && line_no != prev) {
2659 long slen = RSTRING_LEN(str);
2660 slen = (slen > 70) ? 0 : (70 - slen);
2661 str = rb_str_catf(str, "%*s(%4d)", (int)slen, "", line_no);
2662 }
2663 }
2664
2665 {
2666 rb_event_flag_t events = rb_iseq_event_flags(iseq, pos);
2667 if (events) {
2668 str = rb_str_catf(str, "[%s%s%s%s%s%s%s%s%s%s%s%s]",
2669 events & RUBY_EVENT_LINE ? "Li" : "",
2670 events & RUBY_EVENT_CLASS ? "Cl" : "",
2671 events & RUBY_EVENT_END ? "En" : "",
2672 events & RUBY_EVENT_CALL ? "Ca" : "",
2673 events & RUBY_EVENT_RETURN ? "Re" : "",
2674 events & RUBY_EVENT_C_CALL ? "Cc" : "",
2675 events & RUBY_EVENT_C_RETURN ? "Cr" : "",
2676 events & RUBY_EVENT_B_CALL ? "Bc" : "",
2677 events & RUBY_EVENT_B_RETURN ? "Br" : "",
2678 events & RUBY_EVENT_RESCUE ? "Rs" : "",
2679 events & RUBY_EVENT_COVERAGE_LINE ? "Cli" : "",
2680 events & RUBY_EVENT_COVERAGE_BRANCH ? "Cbr" : "");
2681 }
2682 }
2683
2684 right_strip(str);
2685 if (ret) {
2686 rb_str_cat2(str, "\n");
2687 rb_str_concat(ret, str);
2688 }
2689 else {
2690 printf("%.*s\n", (int)RSTRING_LEN(str), RSTRING_PTR(str));
2691 }
2692 return len;
2693}
2694
2695static const char *
2696catch_type(int type)
2697{
2698 switch (type) {
2699 case CATCH_TYPE_RESCUE:
2700 return "rescue";
2701 case CATCH_TYPE_ENSURE:
2702 return "ensure";
2703 case CATCH_TYPE_RETRY:
2704 return "retry";
2705 case CATCH_TYPE_BREAK:
2706 return "break";
2707 case CATCH_TYPE_REDO:
2708 return "redo";
2709 case CATCH_TYPE_NEXT:
2710 return "next";
2711 default:
2712 rb_bug("unknown catch type: %d", type);
2713 return 0;
2714 }
2715}
2716
2717static VALUE
2718iseq_inspect(const rb_iseq_t *iseq)
2719{
2720 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2721 if (!body->location.label) {
2722 return rb_sprintf("#<ISeq: uninitialized>");
2723 }
2724 else {
2725 const rb_code_location_t *loc = &body->location.code_location;
2726 return rb_sprintf("#<ISeq:%"PRIsVALUE"@%"PRIsVALUE":%d (%d,%d)-(%d,%d)>",
2727 body->location.label, rb_iseq_path(iseq),
2728 loc->beg_pos.lineno,
2729 loc->beg_pos.lineno,
2730 loc->beg_pos.column,
2731 loc->end_pos.lineno,
2732 loc->end_pos.column);
2733 }
2734}
2735
2736static const rb_data_type_t tmp_set = {
2737 "tmpset",
2738 {(void (*)(void *))rb_mark_set, (void (*)(void *))st_free_table, 0, 0,},
2739 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
2740};
2741
2742static VALUE
2743rb_iseq_disasm_recursive(const rb_iseq_t *iseq, VALUE indent)
2744{
2745 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2746 VALUE *code;
2747 VALUE str = rb_str_new(0, 0);
2748 VALUE child = rb_ary_hidden_new(3);
2749 unsigned int size;
2750 unsigned int i;
2751 long l;
2752 size_t n;
2753 enum {header_minlen = 72};
2754 st_table *done_iseq = 0;
2755 VALUE done_iseq_wrapper = Qnil;
2756 const char *indent_str;
2757 long indent_len;
2758
2759 size = body->iseq_size;
2760
2761 indent_len = RSTRING_LEN(indent);
2762 indent_str = RSTRING_PTR(indent);
2763
2764 rb_str_cat(str, indent_str, indent_len);
2765 rb_str_cat2(str, "== disasm: ");
2766
2767 rb_str_append(str, iseq_inspect(iseq));
2768 if ((l = RSTRING_LEN(str) - indent_len) < header_minlen) {
2769 rb_str_modify_expand(str, header_minlen - l);
2770 memset(RSTRING_END(str), '=', header_minlen - l);
2771 }
2772 if (iseq->body->builtin_attrs) {
2773#define disasm_builtin_attr(str, iseq, attr) \
2774 if (iseq->body->builtin_attrs & BUILTIN_ATTR_ ## attr) { \
2775 rb_str_cat2(str, " " #attr); \
2776 }
2777 disasm_builtin_attr(str, iseq, LEAF);
2778 disasm_builtin_attr(str, iseq, SINGLE_NOARG_LEAF);
2779 disasm_builtin_attr(str, iseq, INLINE_BLOCK);
2780 disasm_builtin_attr(str, iseq, C_TRACE);
2781 }
2782 rb_str_cat2(str, "\n");
2783
2784 /* show catch table information */
2785 if (body->catch_table) {
2786 rb_str_cat(str, indent_str, indent_len);
2787 rb_str_cat2(str, "== catch table\n");
2788 }
2789 if (body->catch_table) {
2790 rb_str_cat_cstr(indent, "| ");
2791 indent_str = RSTRING_PTR(indent);
2792 for (i = 0; i < body->catch_table->size; i++) {
2793 const struct iseq_catch_table_entry *entry =
2794 UNALIGNED_MEMBER_PTR(body->catch_table, entries[i]);
2795 rb_str_cat(str, indent_str, indent_len);
2796 rb_str_catf(str,
2797 "| catch type: %-6s st: %04d ed: %04d sp: %04d cont: %04d\n",
2798 catch_type((int)entry->type), (int)entry->start,
2799 (int)entry->end, (int)entry->sp, (int)entry->cont);
2800 if (entry->iseq && !(done_iseq && st_is_member(done_iseq, (st_data_t)entry->iseq))) {
2801 rb_str_concat(str, rb_iseq_disasm_recursive(rb_iseq_check(entry->iseq), indent));
2802 if (!done_iseq) {
2803 done_iseq = st_init_numtable();
2804 done_iseq_wrapper = TypedData_Wrap_Struct(0, &tmp_set, done_iseq);
2805 }
2806 st_insert(done_iseq, (st_data_t)entry->iseq, (st_data_t)0);
2807 indent_str = RSTRING_PTR(indent);
2808 }
2809 }
2810 rb_str_resize(indent, indent_len);
2811 indent_str = RSTRING_PTR(indent);
2812 }
2813 if (body->catch_table) {
2814 rb_str_cat(str, indent_str, indent_len);
2815 rb_str_cat2(str, "|-------------------------------------"
2816 "-----------------------------------\n");
2817 }
2818
2819 /* show local table information */
2820 if (body->local_table) {
2821 const struct rb_iseq_param_keyword *const keyword = body->param.keyword;
2822 rb_str_cat(str, indent_str, indent_len);
2823 rb_str_catf(str,
2824 "local table (size: %d, argc: %d "
2825 "[opts: %d, rest: %d, post: %d, block: %d, kw: %d@%d, kwrest: %d])\n",
2826 body->local_table_size,
2827 body->param.lead_num,
2828 body->param.opt_num,
2829 body->param.flags.has_rest ? body->param.rest_start : -1,
2830 body->param.post_num,
2831 body->param.flags.has_block ? body->param.block_start : -1,
2832 body->param.flags.has_kw ? keyword->num : -1,
2833 body->param.flags.has_kw ? keyword->required_num : -1,
2834 body->param.flags.has_kwrest ? keyword->rest_start : -1);
2835
2836 for (i = body->local_table_size; i > 0;) {
2837 int li = body->local_table_size - --i - 1;
2838 long width;
2839 VALUE name = local_var_name(iseq, 0, i);
2840 char argi[0x100];
2841 char opti[0x100];
2842
2843 opti[0] = '\0';
2844 if (body->param.flags.has_opt) {
2845 int argc = body->param.lead_num;
2846 int opts = body->param.opt_num;
2847 if (li >= argc && li < argc + opts) {
2848 snprintf(opti, sizeof(opti), "Opt=%"PRIdVALUE,
2849 body->param.opt_table[li - argc]);
2850 }
2851 }
2852
2853 snprintf(argi, sizeof(argi), "%s%s%s%s%s%s", /* arg, opts, rest, post, kwrest, block */
2854 (body->param.lead_num > li) ? (body->param.flags.ambiguous_param0 ? "AmbiguousArg" : "Arg") : "",
2855 opti,
2856 (body->param.flags.has_rest && body->param.rest_start == li) ? (body->param.flags.anon_rest ? "AnonRest" : "Rest") : "",
2857 (body->param.flags.has_post && body->param.post_start <= li && li < body->param.post_start + body->param.post_num) ? "Post" : "",
2858 (body->param.flags.has_kwrest && keyword->rest_start == li) ? (body->param.flags.anon_kwrest ? "AnonKwrest" : "Kwrest") : "",
2859 (body->param.flags.has_block && body->param.block_start == li) ? "Block" : "");
2860
2861 rb_str_cat(str, indent_str, indent_len);
2862 rb_str_catf(str, "[%2d] ", i + 1);
2863 width = RSTRING_LEN(str) + 11;
2864 rb_str_append(str, name);
2865 if (*argi) rb_str_catf(str, "<%s>", argi);
2866 if ((width -= RSTRING_LEN(str)) > 0) rb_str_catf(str, "%*s", (int)width, "");
2867 }
2868 rb_str_cat_cstr(right_strip(str), "\n");
2869 }
2870
2871 /* show each line */
2872 code = rb_iseq_original_iseq(iseq);
2873 for (n = 0; n < size;) {
2874 rb_str_cat(str, indent_str, indent_len);
2875 n += rb_iseq_disasm_insn(str, code, n, iseq, child);
2876 }
2877
2878 for (l = 0; l < RARRAY_LEN(child); l++) {
2879 VALUE isv = rb_ary_entry(child, l);
2880 if (done_iseq && st_is_member(done_iseq, (st_data_t)isv)) continue;
2881 rb_str_cat_cstr(str, "\n");
2882 rb_str_concat(str, rb_iseq_disasm_recursive(rb_iseq_check((rb_iseq_t *)isv), indent));
2883 indent_str = RSTRING_PTR(indent);
2884 }
2885 RB_GC_GUARD(done_iseq_wrapper);
2886
2887 return str;
2888}
2889
2890 VALUE
2891rb_iseq_disasm(const rb_iseq_t *iseq)
2892{
2893 VALUE str = rb_iseq_disasm_recursive(iseq, rb_str_new(0, 0));
2894 rb_str_resize(str, RSTRING_LEN(str));
2895 return str;
2896}
2897
2898/*
2899 * Estimates the number of instance variables that will be set on
2900 * a given `class` with the initialize method defined in
2901 * `initialize_iseq`
2902 */
2903attr_index_t
2904rb_estimate_iv_count(VALUE klass, const rb_iseq_t * initialize_iseq)
2905{
2906 struct rb_id_table * iv_names = rb_id_table_create(0);
2907
2908 for (unsigned int i = 0; i < ISEQ_BODY(initialize_iseq)->ivc_size; i++) {
2909 IVC cache = (IVC)&ISEQ_BODY(initialize_iseq)->is_entries[i];
2910
2911 if (cache->iv_set_name) {
2912 rb_id_table_insert(iv_names, cache->iv_set_name, Qtrue);
2913 }
2914 }
2915
2916 attr_index_t count = (attr_index_t)rb_id_table_size(iv_names);
2917
2918 VALUE superclass = rb_class_superclass(klass);
2919 count += RCLASS_EXT(superclass)->max_iv_count;
2920
2921 rb_id_table_free(iv_names);
2922
2923 return count;
2924}
2925
2926/*
2927 * call-seq:
2928 * iseq.disasm -> str
2929 * iseq.disassemble -> str
2930 *
2931 * Returns the instruction sequence as a +String+ in human readable form.
2932 *
2933 * puts RubyVM::InstructionSequence.compile('1 + 2').disasm
2934 *
2935 * Produces:
2936 *
2937 * == disasm: <RubyVM::InstructionSequence:<compiled>@<compiled>>==========
2938 * 0000 trace 1 ( 1)
2939 * 0002 putobject 1
2940 * 0004 putobject 2
2941 * 0006 opt_plus <ic:1>
2942 * 0008 leave
2943 */
2944static VALUE
2945iseqw_disasm(VALUE self)
2946{
2947 return rb_iseq_disasm(iseqw_check(self));
2948}
2949
2950static int
2951iseq_iterate_children(const rb_iseq_t *iseq, void (*iter_func)(const rb_iseq_t *child_iseq, void *data), void *data)
2952{
2953 unsigned int i;
2954 VALUE *code = rb_iseq_original_iseq(iseq);
2955 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
2956 const rb_iseq_t *child;
2957 VALUE all_children = rb_obj_hide(rb_ident_hash_new());
2958
2959 if (body->catch_table) {
2960 for (i = 0; i < body->catch_table->size; i++) {
2961 const struct iseq_catch_table_entry *entry =
2962 UNALIGNED_MEMBER_PTR(body->catch_table, entries[i]);
2963 child = entry->iseq;
2964 if (child) {
2965 if (NIL_P(rb_hash_aref(all_children, (VALUE)child))) {
2966 rb_hash_aset(all_children, (VALUE)child, Qtrue);
2967 (*iter_func)(child, data);
2968 }
2969 }
2970 }
2971 }
2972
2973 for (i=0; i<body->iseq_size;) {
2974 VALUE insn = code[i];
2975 int len = insn_len(insn);
2976 const char *types = insn_op_types(insn);
2977 int j;
2978
2979 for (j=0; types[j]; j++) {
2980 switch (types[j]) {
2981 case TS_ISEQ:
2982 child = (const rb_iseq_t *)code[i+j+1];
2983 if (child) {
2984 if (NIL_P(rb_hash_aref(all_children, (VALUE)child))) {
2985 rb_hash_aset(all_children, (VALUE)child, Qtrue);
2986 (*iter_func)(child, data);
2987 }
2988 }
2989 break;
2990 default:
2991 break;
2992 }
2993 }
2994 i += len;
2995 }
2996
2997 return (int)RHASH_SIZE(all_children);
2998}
2999
3000static void
3001yield_each_children(const rb_iseq_t *child_iseq, void *data)
3002{
3003 rb_yield(iseqw_new(child_iseq));
3004}
3005
3006/*
3007 * call-seq:
3008 * iseq.each_child{|child_iseq| ...} -> iseq
3009 *
3010 * Iterate all direct child instruction sequences.
3011 * Iteration order is implementation/version defined
3012 * so that people should not rely on the order.
3013 */
3014static VALUE
3015iseqw_each_child(VALUE self)
3016{
3017 const rb_iseq_t *iseq = iseqw_check(self);
3018 iseq_iterate_children(iseq, yield_each_children, NULL);
3019 return self;
3020}
3021
3022static void
3023push_event_info(const rb_iseq_t *iseq, rb_event_flag_t events, int line, VALUE ary)
3024{
3025#define C(ev, cstr, l) if (events & ev) rb_ary_push(ary, rb_ary_new_from_args(2, l, ID2SYM(rb_intern(cstr))));
3026 C(RUBY_EVENT_CLASS, "class", rb_iseq_first_lineno(iseq));
3027 C(RUBY_EVENT_CALL, "call", rb_iseq_first_lineno(iseq));
3028 C(RUBY_EVENT_B_CALL, "b_call", rb_iseq_first_lineno(iseq));
3029 C(RUBY_EVENT_LINE, "line", INT2FIX(line));
3030 C(RUBY_EVENT_END, "end", INT2FIX(line));
3031 C(RUBY_EVENT_RETURN, "return", INT2FIX(line));
3032 C(RUBY_EVENT_B_RETURN, "b_return", INT2FIX(line));
3033 C(RUBY_EVENT_RESCUE, "rescue", INT2FIX(line));
3034#undef C
3035}
3036
3037/*
3038 * call-seq:
3039 * iseq.trace_points -> ary
3040 *
3041 * Return trace points in the instruction sequence.
3042 * Return an array of [line, event_symbol] pair.
3043 */
3044static VALUE
3045iseqw_trace_points(VALUE self)
3046{
3047 const rb_iseq_t *iseq = iseqw_check(self);
3048 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3049 unsigned int i;
3050 VALUE ary = rb_ary_new();
3051
3052 for (i=0; i<body->insns_info.size; i++) {
3053 const struct iseq_insn_info_entry *entry = &body->insns_info.body[i];
3054 if (entry->events) {
3055 push_event_info(iseq, entry->events, entry->line_no, ary);
3056 }
3057 }
3058 return ary;
3059}
3060
3061/*
3062 * Returns the instruction sequence containing the given proc or method.
3063 *
3064 * For example, using irb:
3065 *
3066 * # a proc
3067 * > p = proc { num = 1 + 2 }
3068 * > RubyVM::InstructionSequence.of(p)
3069 * > #=> <RubyVM::InstructionSequence:block in irb_binding@(irb)>
3070 *
3071 * # for a method
3072 * > def foo(bar); puts bar; end
3073 * > RubyVM::InstructionSequence.of(method(:foo))
3074 * > #=> <RubyVM::InstructionSequence:foo@(irb)>
3075 *
3076 * Using ::compile_file:
3077 *
3078 * # /tmp/iseq_of.rb
3079 * def hello
3080 * puts "hello, world"
3081 * end
3082 *
3083 * $a_global_proc = proc { str = 'a' + 'b' }
3084 *
3085 * # in irb
3086 * > require '/tmp/iseq_of.rb'
3087 *
3088 * # first the method hello
3089 * > RubyVM::InstructionSequence.of(method(:hello))
3090 * > #=> #<RubyVM::InstructionSequence:0x007fb73d7cb1d0>
3091 *
3092 * # then the global proc
3093 * > RubyVM::InstructionSequence.of($a_global_proc)
3094 * > #=> #<RubyVM::InstructionSequence:0x007fb73d7caf78>
3095 */
3096static VALUE
3097iseqw_s_of(VALUE klass, VALUE body)
3098{
3099 const rb_iseq_t *iseq = NULL;
3100
3101 if (rb_frame_info_p(body)) {
3102 iseq = rb_get_iseq_from_frame_info(body);
3103 }
3104 else if (rb_obj_is_proc(body)) {
3105 iseq = vm_proc_iseq(body);
3106
3107 if (!rb_obj_is_iseq((VALUE)iseq)) {
3108 iseq = NULL;
3109 }
3110 }
3111 else if (rb_obj_is_method(body)) {
3112 iseq = rb_method_iseq(body);
3113 }
3114 else if (rb_typeddata_is_instance_of(body, &iseqw_data_type)) {
3115 return body;
3116 }
3117
3118 return iseq ? iseqw_new(iseq) : Qnil;
3119}
3120
3121/*
3122 * call-seq:
3123 * InstructionSequence.disasm(body) -> str
3124 * InstructionSequence.disassemble(body) -> str
3125 *
3126 * Takes +body+, a Method or Proc object, and returns a String with the
3127 * human readable instructions for +body+.
3128 *
3129 * For a Method object:
3130 *
3131 * # /tmp/method.rb
3132 * def hello
3133 * puts "hello, world"
3134 * end
3135 *
3136 * puts RubyVM::InstructionSequence.disasm(method(:hello))
3137 *
3138 * Produces:
3139 *
3140 * == disasm: <RubyVM::InstructionSequence:hello@/tmp/method.rb>============
3141 * 0000 trace 8 ( 1)
3142 * 0002 trace 1 ( 2)
3143 * 0004 putself
3144 * 0005 putstring "hello, world"
3145 * 0007 send :puts, 1, nil, 8, <ic:0>
3146 * 0013 trace 16 ( 3)
3147 * 0015 leave ( 2)
3148 *
3149 * For a Proc:
3150 *
3151 * # /tmp/proc.rb
3152 * p = proc { num = 1 + 2 }
3153 * puts RubyVM::InstructionSequence.disasm(p)
3154 *
3155 * Produces:
3156 *
3157 * == disasm: <RubyVM::InstructionSequence:block in <main>@/tmp/proc.rb>===
3158 * == catch table
3159 * | catch type: redo st: 0000 ed: 0012 sp: 0000 cont: 0000
3160 * | catch type: next st: 0000 ed: 0012 sp: 0000 cont: 0012
3161 * |------------------------------------------------------------------------
3162 * local table (size: 2, argc: 0 [opts: 0, rest: -1, post: 0, block: -1] s1)
3163 * [ 2] num
3164 * 0000 trace 1 ( 1)
3165 * 0002 putobject 1
3166 * 0004 putobject 2
3167 * 0006 opt_plus <ic:1>
3168 * 0008 dup
3169 * 0009 setlocal num, 0
3170 * 0012 leave
3171 *
3172 */
3173static VALUE
3174iseqw_s_disasm(VALUE klass, VALUE body)
3175{
3176 VALUE iseqw = iseqw_s_of(klass, body);
3177 return NIL_P(iseqw) ? Qnil : rb_iseq_disasm(iseqw_check(iseqw));
3178}
3179
3180static VALUE
3181register_label(struct st_table *table, unsigned long idx)
3182{
3183 VALUE sym = rb_str_intern(rb_sprintf("label_%lu", idx));
3184 st_insert(table, idx, sym);
3185 return sym;
3186}
3187
3188static VALUE
3189exception_type2symbol(VALUE type)
3190{
3191 ID id;
3192 switch (type) {
3193 case CATCH_TYPE_RESCUE: CONST_ID(id, "rescue"); break;
3194 case CATCH_TYPE_ENSURE: CONST_ID(id, "ensure"); break;
3195 case CATCH_TYPE_RETRY: CONST_ID(id, "retry"); break;
3196 case CATCH_TYPE_BREAK: CONST_ID(id, "break"); break;
3197 case CATCH_TYPE_REDO: CONST_ID(id, "redo"); break;
3198 case CATCH_TYPE_NEXT: CONST_ID(id, "next"); break;
3199 default:
3200 rb_bug("unknown exception type: %d", (int)type);
3201 }
3202 return ID2SYM(id);
3203}
3204
3205static int
3206cdhash_each(VALUE key, VALUE value, VALUE ary)
3207{
3208 rb_ary_push(ary, obj_resurrect(key));
3209 rb_ary_push(ary, value);
3210 return ST_CONTINUE;
3211}
3212
3213static const rb_data_type_t label_wrapper = {
3214 "label_wrapper",
3215 {(void (*)(void *))rb_mark_tbl, (void (*)(void *))st_free_table, 0, 0,},
3216 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3217};
3218
3219#define DECL_ID(name) \
3220 static ID id_##name
3221
3222#define INIT_ID(name) \
3223 id_##name = rb_intern(#name)
3224
3225static VALUE
3226iseq_type_id(enum rb_iseq_type type)
3227{
3228 DECL_ID(top);
3229 DECL_ID(method);
3230 DECL_ID(block);
3231 DECL_ID(class);
3232 DECL_ID(rescue);
3233 DECL_ID(ensure);
3234 DECL_ID(eval);
3235 DECL_ID(main);
3236 DECL_ID(plain);
3237
3238 if (id_top == 0) {
3239 INIT_ID(top);
3240 INIT_ID(method);
3241 INIT_ID(block);
3242 INIT_ID(class);
3243 INIT_ID(rescue);
3244 INIT_ID(ensure);
3245 INIT_ID(eval);
3246 INIT_ID(main);
3247 INIT_ID(plain);
3248 }
3249
3250 switch (type) {
3251 case ISEQ_TYPE_TOP: return id_top;
3252 case ISEQ_TYPE_METHOD: return id_method;
3253 case ISEQ_TYPE_BLOCK: return id_block;
3254 case ISEQ_TYPE_CLASS: return id_class;
3255 case ISEQ_TYPE_RESCUE: return id_rescue;
3256 case ISEQ_TYPE_ENSURE: return id_ensure;
3257 case ISEQ_TYPE_EVAL: return id_eval;
3258 case ISEQ_TYPE_MAIN: return id_main;
3259 case ISEQ_TYPE_PLAIN: return id_plain;
3260 };
3261
3262 rb_bug("unsupported iseq type: %d", (int)type);
3263}
3264
3265static VALUE
3266iseq_data_to_ary(const rb_iseq_t *iseq)
3267{
3268 unsigned int i;
3269 long l;
3270 const struct rb_iseq_constant_body *const iseq_body = ISEQ_BODY(iseq);
3271 const struct iseq_insn_info_entry *prev_insn_info;
3272 unsigned int pos;
3273 int last_line = 0;
3274 VALUE *seq, *iseq_original;
3275
3276 VALUE val = rb_ary_new();
3277 ID type; /* Symbol */
3278 VALUE locals = rb_ary_new();
3279 VALUE params = rb_hash_new();
3280 VALUE body = rb_ary_new(); /* [[:insn1, ...], ...] */
3281 VALUE nbody;
3282 VALUE exception = rb_ary_new(); /* [[....]] */
3283 VALUE misc = rb_hash_new();
3284
3285 static ID insn_syms[VM_INSTRUCTION_SIZE/2]; /* w/o-trace only */
3286 struct st_table *labels_table = st_init_numtable();
3287 VALUE labels_wrapper = TypedData_Wrap_Struct(0, &label_wrapper, labels_table);
3288
3289 if (insn_syms[0] == 0) {
3290 int i;
3291 for (i=0; i<numberof(insn_syms); i++) {
3292 insn_syms[i] = rb_intern(insn_name(i));
3293 }
3294 }
3295
3296 /* type */
3297 type = iseq_type_id(iseq_body->type);
3298
3299 /* locals */
3300 for (i=0; i<iseq_body->local_table_size; i++) {
3301 ID lid = iseq_body->local_table[i];
3302 if (lid) {
3303 if (rb_id2str(lid)) {
3304 rb_ary_push(locals, ID2SYM(lid));
3305 }
3306 else { /* hidden variable from id_internal() */
3307 rb_ary_push(locals, ULONG2NUM(iseq_body->local_table_size-i+1));
3308 }
3309 }
3310 else {
3311 rb_ary_push(locals, ID2SYM(rb_intern("#arg_rest")));
3312 }
3313 }
3314
3315 /* params */
3316 {
3317 const struct rb_iseq_param_keyword *const keyword = iseq_body->param.keyword;
3318 int j;
3319
3320 if (iseq_body->param.flags.has_opt) {
3321 int len = iseq_body->param.opt_num + 1;
3322 VALUE arg_opt_labels = rb_ary_new2(len);
3323
3324 for (j = 0; j < len; j++) {
3325 VALUE l = register_label(labels_table, iseq_body->param.opt_table[j]);
3326 rb_ary_push(arg_opt_labels, l);
3327 }
3328 rb_hash_aset(params, ID2SYM(rb_intern("opt")), arg_opt_labels);
3329 }
3330
3331 /* commit */
3332 if (iseq_body->param.flags.has_lead) rb_hash_aset(params, ID2SYM(rb_intern("lead_num")), INT2FIX(iseq_body->param.lead_num));
3333 if (iseq_body->param.flags.has_post) rb_hash_aset(params, ID2SYM(rb_intern("post_num")), INT2FIX(iseq_body->param.post_num));
3334 if (iseq_body->param.flags.has_post) rb_hash_aset(params, ID2SYM(rb_intern("post_start")), INT2FIX(iseq_body->param.post_start));
3335 if (iseq_body->param.flags.has_rest) rb_hash_aset(params, ID2SYM(rb_intern("rest_start")), INT2FIX(iseq_body->param.rest_start));
3336 if (iseq_body->param.flags.has_block) rb_hash_aset(params, ID2SYM(rb_intern("block_start")), INT2FIX(iseq_body->param.block_start));
3337 if (iseq_body->param.flags.has_kw) {
3338 VALUE keywords = rb_ary_new();
3339 int i, j;
3340 for (i=0; i<keyword->required_num; i++) {
3341 rb_ary_push(keywords, ID2SYM(keyword->table[i]));
3342 }
3343 for (j=0; i<keyword->num; i++, j++) {
3344 VALUE key = rb_ary_new_from_args(1, ID2SYM(keyword->table[i]));
3345 if (!UNDEF_P(keyword->default_values[j])) {
3346 rb_ary_push(key, keyword->default_values[j]);
3347 }
3348 rb_ary_push(keywords, key);
3349 }
3350
3351 rb_hash_aset(params, ID2SYM(rb_intern("kwbits")),
3352 INT2FIX(keyword->bits_start));
3353 rb_hash_aset(params, ID2SYM(rb_intern("keyword")), keywords);
3354 }
3355 if (iseq_body->param.flags.has_kwrest) rb_hash_aset(params, ID2SYM(rb_intern("kwrest")), INT2FIX(keyword->rest_start));
3356 if (iseq_body->param.flags.ambiguous_param0) rb_hash_aset(params, ID2SYM(rb_intern("ambiguous_param0")), Qtrue);
3357 if (iseq_body->param.flags.use_block) rb_hash_aset(params, ID2SYM(rb_intern("use_block")), Qtrue);
3358 }
3359
3360 /* body */
3361 iseq_original = rb_iseq_original_iseq((rb_iseq_t *)iseq);
3362
3363 for (seq = iseq_original; seq < iseq_original + iseq_body->iseq_size; ) {
3364 VALUE insn = *seq++;
3365 int j, len = insn_len(insn);
3366 VALUE *nseq = seq + len - 1;
3367 VALUE ary = rb_ary_new2(len);
3368
3369 rb_ary_push(ary, ID2SYM(insn_syms[insn%numberof(insn_syms)]));
3370 for (j=0; j<len-1; j++, seq++) {
3371 enum ruby_insn_type_chars op_type = insn_op_type(insn, j);
3372
3373 switch (op_type) {
3374 case TS_OFFSET: {
3375 unsigned long idx = nseq - iseq_original + *seq;
3376 rb_ary_push(ary, register_label(labels_table, idx));
3377 break;
3378 }
3379 case TS_LINDEX:
3380 case TS_NUM:
3381 rb_ary_push(ary, INT2FIX(*seq));
3382 break;
3383 case TS_VALUE:
3384 rb_ary_push(ary, obj_resurrect(*seq));
3385 break;
3386 case TS_ISEQ:
3387 {
3388 const rb_iseq_t *iseq = (rb_iseq_t *)*seq;
3389 if (iseq) {
3390 VALUE val = iseq_data_to_ary(rb_iseq_check(iseq));
3391 rb_ary_push(ary, val);
3392 }
3393 else {
3394 rb_ary_push(ary, Qnil);
3395 }
3396 }
3397 break;
3398 case TS_IC:
3399 {
3400 VALUE list = rb_ary_new();
3401 const ID *ids = ((IC)*seq)->segments;
3402 while (*ids) {
3403 rb_ary_push(list, ID2SYM(*ids++));
3404 }
3405 rb_ary_push(ary, list);
3406 }
3407 break;
3408 case TS_IVC:
3409 case TS_ICVARC:
3410 case TS_ISE:
3411 {
3412 union iseq_inline_storage_entry *is = (union iseq_inline_storage_entry *)*seq;
3413 rb_ary_push(ary, INT2FIX(is - ISEQ_IS_ENTRY_START(ISEQ_BODY(iseq), op_type)));
3414 }
3415 break;
3416 case TS_CALLDATA:
3417 {
3418 struct rb_call_data *cd = (struct rb_call_data *)*seq;
3419 const struct rb_callinfo *ci = cd->ci;
3420 VALUE e = rb_hash_new();
3421 int argc = vm_ci_argc(ci);
3422
3423 ID mid = vm_ci_mid(ci);
3424 rb_hash_aset(e, ID2SYM(rb_intern("mid")), mid ? ID2SYM(mid) : Qnil);
3425 rb_hash_aset(e, ID2SYM(rb_intern("flag")), UINT2NUM(vm_ci_flag(ci)));
3426
3427 if (vm_ci_flag(ci) & VM_CALL_KWARG) {
3428 const struct rb_callinfo_kwarg *kwarg = vm_ci_kwarg(ci);
3429 int i;
3430 VALUE kw = rb_ary_new2((long)kwarg->keyword_len);
3431
3432 argc -= kwarg->keyword_len;
3433 for (i = 0; i < kwarg->keyword_len; i++) {
3434 rb_ary_push(kw, kwarg->keywords[i]);
3435 }
3436 rb_hash_aset(e, ID2SYM(rb_intern("kw_arg")), kw);
3437 }
3438
3439 rb_hash_aset(e, ID2SYM(rb_intern("orig_argc")),
3440 INT2FIX(argc));
3441 rb_ary_push(ary, e);
3442 }
3443 break;
3444 case TS_ID:
3445 rb_ary_push(ary, ID2SYM(*seq));
3446 break;
3447 case TS_CDHASH:
3448 {
3449 VALUE hash = *seq;
3450 VALUE val = rb_ary_new();
3451 int i;
3452
3453 rb_hash_foreach(hash, cdhash_each, val);
3454
3455 for (i=0; i<RARRAY_LEN(val); i+=2) {
3456 VALUE pos = FIX2INT(rb_ary_entry(val, i+1));
3457 unsigned long idx = nseq - iseq_original + pos;
3458
3459 rb_ary_store(val, i+1,
3460 register_label(labels_table, idx));
3461 }
3462 rb_ary_push(ary, val);
3463 }
3464 break;
3465 case TS_FUNCPTR:
3466 {
3467#if SIZEOF_VALUE <= SIZEOF_LONG
3468 VALUE val = LONG2NUM((SIGNED_VALUE)*seq);
3469#else
3470 VALUE val = LL2NUM((SIGNED_VALUE)*seq);
3471#endif
3472 rb_ary_push(ary, val);
3473 }
3474 break;
3475 case TS_BUILTIN:
3476 {
3477 VALUE val = rb_hash_new();
3478#if SIZEOF_VALUE <= SIZEOF_LONG
3479 VALUE func_ptr = LONG2NUM((SIGNED_VALUE)((RB_BUILTIN)*seq)->func_ptr);
3480#else
3481 VALUE func_ptr = LL2NUM((SIGNED_VALUE)((RB_BUILTIN)*seq)->func_ptr);
3482#endif
3483 rb_hash_aset(val, ID2SYM(rb_intern("func_ptr")), func_ptr);
3484 rb_hash_aset(val, ID2SYM(rb_intern("argc")), INT2NUM(((RB_BUILTIN)*seq)->argc));
3485 rb_hash_aset(val, ID2SYM(rb_intern("index")), INT2NUM(((RB_BUILTIN)*seq)->index));
3486 rb_hash_aset(val, ID2SYM(rb_intern("name")), rb_str_new_cstr(((RB_BUILTIN)*seq)->name));
3487 rb_ary_push(ary, val);
3488 }
3489 break;
3490 default:
3491 rb_bug("unknown operand: %c", insn_op_type(insn, j));
3492 }
3493 }
3494 rb_ary_push(body, ary);
3495 }
3496
3497 nbody = body;
3498
3499 /* exception */
3500 if (iseq_body->catch_table) for (i=0; i<iseq_body->catch_table->size; i++) {
3501 VALUE ary = rb_ary_new();
3502 const struct iseq_catch_table_entry *entry =
3503 UNALIGNED_MEMBER_PTR(iseq_body->catch_table, entries[i]);
3504 rb_ary_push(ary, exception_type2symbol(entry->type));
3505 if (entry->iseq) {
3506 rb_ary_push(ary, iseq_data_to_ary(rb_iseq_check(entry->iseq)));
3507 }
3508 else {
3509 rb_ary_push(ary, Qnil);
3510 }
3511 rb_ary_push(ary, register_label(labels_table, entry->start));
3512 rb_ary_push(ary, register_label(labels_table, entry->end));
3513 rb_ary_push(ary, register_label(labels_table, entry->cont));
3514 rb_ary_push(ary, UINT2NUM(entry->sp));
3515 rb_ary_push(exception, ary);
3516 }
3517
3518 /* make body with labels and insert line number */
3519 body = rb_ary_new();
3520 prev_insn_info = NULL;
3521#ifdef USE_ISEQ_NODE_ID
3522 VALUE node_ids = rb_ary_new();
3523#endif
3524
3525 for (l=0, pos=0; l<RARRAY_LEN(nbody); l++) {
3526 const struct iseq_insn_info_entry *info;
3527 VALUE ary = RARRAY_AREF(nbody, l);
3528 st_data_t label;
3529
3530 if (st_lookup(labels_table, pos, &label)) {
3531 rb_ary_push(body, (VALUE)label);
3532 }
3533
3534 info = get_insn_info(iseq, pos);
3535#ifdef USE_ISEQ_NODE_ID
3536 rb_ary_push(node_ids, INT2FIX(info->node_id));
3537#endif
3538
3539 if (prev_insn_info != info) {
3540 int line = info->line_no;
3541 rb_event_flag_t events = info->events;
3542
3543 if (line > 0 && last_line != line) {
3544 rb_ary_push(body, INT2FIX(line));
3545 last_line = line;
3546 }
3547#define CHECK_EVENT(ev) if (events & ev) rb_ary_push(body, ID2SYM(rb_intern(#ev)));
3548 CHECK_EVENT(RUBY_EVENT_LINE);
3549 CHECK_EVENT(RUBY_EVENT_CLASS);
3550 CHECK_EVENT(RUBY_EVENT_END);
3551 CHECK_EVENT(RUBY_EVENT_CALL);
3552 CHECK_EVENT(RUBY_EVENT_RETURN);
3553 CHECK_EVENT(RUBY_EVENT_B_CALL);
3554 CHECK_EVENT(RUBY_EVENT_B_RETURN);
3555 CHECK_EVENT(RUBY_EVENT_RESCUE);
3556#undef CHECK_EVENT
3557 prev_insn_info = info;
3558 }
3559
3560 rb_ary_push(body, ary);
3561 pos += RARRAY_LENINT(ary); /* reject too huge data */
3562 }
3563 RB_GC_GUARD(nbody);
3564 RB_GC_GUARD(labels_wrapper);
3565
3566 rb_hash_aset(misc, ID2SYM(rb_intern("arg_size")), INT2FIX(iseq_body->param.size));
3567 rb_hash_aset(misc, ID2SYM(rb_intern("local_size")), INT2FIX(iseq_body->local_table_size));
3568 rb_hash_aset(misc, ID2SYM(rb_intern("stack_max")), INT2FIX(iseq_body->stack_max));
3569 rb_hash_aset(misc, ID2SYM(rb_intern("node_id")), INT2FIX(iseq_body->location.node_id));
3570 rb_hash_aset(misc, ID2SYM(rb_intern("code_location")),
3571 rb_ary_new_from_args(4,
3572 INT2FIX(iseq_body->location.code_location.beg_pos.lineno),
3573 INT2FIX(iseq_body->location.code_location.beg_pos.column),
3574 INT2FIX(iseq_body->location.code_location.end_pos.lineno),
3575 INT2FIX(iseq_body->location.code_location.end_pos.column)));
3576#ifdef USE_ISEQ_NODE_ID
3577 rb_hash_aset(misc, ID2SYM(rb_intern("node_ids")), node_ids);
3578#endif
3579 rb_hash_aset(misc, ID2SYM(rb_intern("parser")), iseq_body->prism ? ID2SYM(rb_intern("prism")) : ID2SYM(rb_intern("parse.y")));
3580
3581 /*
3582 * [:magic, :major_version, :minor_version, :format_type, :misc,
3583 * :name, :path, :absolute_path, :start_lineno, :type, :locals, :args,
3584 * :catch_table, :bytecode]
3585 */
3586 rb_ary_push(val, rb_str_new2("YARVInstructionSequence/SimpleDataFormat"));
3587 rb_ary_push(val, INT2FIX(ISEQ_MAJOR_VERSION)); /* major */
3588 rb_ary_push(val, INT2FIX(ISEQ_MINOR_VERSION)); /* minor */
3589 rb_ary_push(val, INT2FIX(1));
3590 rb_ary_push(val, misc);
3591 rb_ary_push(val, iseq_body->location.label);
3592 rb_ary_push(val, rb_iseq_path(iseq));
3593 rb_ary_push(val, rb_iseq_realpath(iseq));
3594 rb_ary_push(val, RB_INT2NUM(iseq_body->location.first_lineno));
3595 rb_ary_push(val, ID2SYM(type));
3596 rb_ary_push(val, locals);
3597 rb_ary_push(val, params);
3598 rb_ary_push(val, exception);
3599 rb_ary_push(val, body);
3600 return val;
3601}
3602
3603 VALUE
3604rb_iseq_parameters(const rb_iseq_t *iseq, int is_proc)
3605{
3606 int i, r;
3607 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3608 const struct rb_iseq_param_keyword *const keyword = body->param.keyword;
3609 VALUE a, args = rb_ary_new2(body->param.size);
3610 ID req, opt, rest, block, key, keyrest;
3611#define PARAM_TYPE(type) rb_ary_push(a = rb_ary_new2(2), ID2SYM(type))
3612#define PARAM_ID(i) body->local_table[(i)]
3613#define PARAM(i, type) ( \
3614 PARAM_TYPE(type), \
3615 rb_id2str(PARAM_ID(i)) ? \
3616 rb_ary_push(a, ID2SYM(PARAM_ID(i))) : \
3617 a)
3618
3619 CONST_ID(req, "req");
3620 CONST_ID(opt, "opt");
3621
3622 if (body->param.flags.forwardable) {
3623 // [[:rest, :*], [:keyrest, :**], [:block, :&]]
3624 CONST_ID(rest, "rest");
3625 CONST_ID(keyrest, "keyrest");
3626 CONST_ID(block, "block");
3627 rb_ary_push(args, rb_ary_new_from_args(2, ID2SYM(rest), ID2SYM(idMULT)));
3628 rb_ary_push(args, rb_ary_new_from_args(2, ID2SYM(keyrest), ID2SYM(idPow)));
3629 rb_ary_push(args, rb_ary_new_from_args(2, ID2SYM(block), ID2SYM(idAnd)));
3630 }
3631
3632 if (is_proc) {
3633 for (i = 0; i < body->param.lead_num; i++) {
3634 PARAM_TYPE(opt);
3635 rb_ary_push(a, rb_id2str(PARAM_ID(i)) ? ID2SYM(PARAM_ID(i)) : Qnil);
3636 rb_ary_push(args, a);
3637 }
3638 }
3639 else {
3640 for (i = 0; i < body->param.lead_num; i++) {
3641 rb_ary_push(args, PARAM(i, req));
3642 }
3643 }
3644 r = body->param.lead_num + body->param.opt_num;
3645 for (; i < r; i++) {
3646 PARAM_TYPE(opt);
3647 if (rb_id2str(PARAM_ID(i))) {
3648 rb_ary_push(a, ID2SYM(PARAM_ID(i)));
3649 }
3650 rb_ary_push(args, a);
3651 }
3652 if (body->param.flags.has_rest) {
3653 CONST_ID(rest, "rest");
3654 rb_ary_push(args, PARAM(body->param.rest_start, rest));
3655 }
3656 r = body->param.post_start + body->param.post_num;
3657 if (is_proc) {
3658 for (i = body->param.post_start; i < r; i++) {
3659 PARAM_TYPE(opt);
3660 rb_ary_push(a, rb_id2str(PARAM_ID(i)) ? ID2SYM(PARAM_ID(i)) : Qnil);
3661 rb_ary_push(args, a);
3662 }
3663 }
3664 else {
3665 for (i = body->param.post_start; i < r; i++) {
3666 rb_ary_push(args, PARAM(i, req));
3667 }
3668 }
3669 if (body->param.flags.accepts_no_kwarg) {
3670 ID nokey;
3671 CONST_ID(nokey, "nokey");
3672 PARAM_TYPE(nokey);
3673 rb_ary_push(args, a);
3674 }
3675 if (body->param.flags.has_kw) {
3676 i = 0;
3677 if (keyword->required_num > 0) {
3678 ID keyreq;
3679 CONST_ID(keyreq, "keyreq");
3680 for (; i < keyword->required_num; i++) {
3681 PARAM_TYPE(keyreq);
3682 if (rb_id2str(keyword->table[i])) {
3683 rb_ary_push(a, ID2SYM(keyword->table[i]));
3684 }
3685 rb_ary_push(args, a);
3686 }
3687 }
3688 CONST_ID(key, "key");
3689 for (; i < keyword->num; i++) {
3690 PARAM_TYPE(key);
3691 if (rb_id2str(keyword->table[i])) {
3692 rb_ary_push(a, ID2SYM(keyword->table[i]));
3693 }
3694 rb_ary_push(args, a);
3695 }
3696 }
3697 if (body->param.flags.has_kwrest || body->param.flags.ruby2_keywords) {
3698 ID param;
3699 CONST_ID(keyrest, "keyrest");
3700 PARAM_TYPE(keyrest);
3701 if (body->param.flags.has_kwrest &&
3702 rb_id2str(param = PARAM_ID(keyword->rest_start))) {
3703 rb_ary_push(a, ID2SYM(param));
3704 }
3705 else if (body->param.flags.ruby2_keywords) {
3706 rb_ary_push(a, ID2SYM(idPow));
3707 }
3708 rb_ary_push(args, a);
3709 }
3710 if (body->param.flags.has_block) {
3711 CONST_ID(block, "block");
3712 rb_ary_push(args, PARAM(body->param.block_start, block));
3713 }
3714 return args;
3715}
3716
3717 VALUE
3718rb_iseq_defined_string(enum defined_type type)
3719{
3720 static const char expr_names[][18] = {
3721 "nil",
3722 "instance-variable",
3723 "local-variable",
3724 "global-variable",
3725 "class variable",
3726 "constant",
3727 "method",
3728 "yield",
3729 "super",
3730 "self",
3731 "true",
3732 "false",
3733 "assignment",
3734 "expression",
3735 };
3736 const char *estr;
3737
3738 if ((unsigned)(type - 1) >= (unsigned)numberof(expr_names)) rb_bug("unknown defined type %d", type);
3739 estr = expr_names[type - 1];
3740 return rb_fstring_cstr(estr);
3741}
3742
3743/* A map from encoded_insn to insn_data: decoded insn number, its len,
3744 * non-trace version of encoded insn, and trace version. */
3745
3746static st_table *encoded_insn_data;
3747 typedef struct insn_data_struct {
3748 int insn;
3749 int insn_len;
3750 void *notrace_encoded_insn;
3751 void *trace_encoded_insn;
3752} insn_data_t;
3753static insn_data_t insn_data[VM_INSTRUCTION_SIZE/2];
3754
3755void
3756rb_free_encoded_insn_data(void)
3757{
3758 st_free_table(encoded_insn_data);
3759}
3760
3761void
3762rb_vm_encoded_insn_data_table_init(void)
3763{
3764#if OPT_DIRECT_THREADED_CODE || OPT_CALL_THREADED_CODE
3765 const void * const *table = rb_vm_get_insns_address_table();
3766#define INSN_CODE(insn) ((VALUE)table[insn])
3767#else
3768#define INSN_CODE(insn) ((VALUE)(insn))
3769#endif
3770 st_data_t insn;
3771 encoded_insn_data = st_init_numtable_with_size(VM_INSTRUCTION_SIZE / 2);
3772
3773 for (insn = 0; insn < VM_INSTRUCTION_SIZE/2; insn++) {
3774 st_data_t key1 = (st_data_t)INSN_CODE(insn);
3775 st_data_t key2 = (st_data_t)INSN_CODE(insn + VM_INSTRUCTION_SIZE/2);
3776
3777 insn_data[insn].insn = (int)insn;
3778 insn_data[insn].insn_len = insn_len(insn);
3779
3780 if (insn != BIN(opt_invokebuiltin_delegate_leave)) {
3781 insn_data[insn].notrace_encoded_insn = (void *) key1;
3782 insn_data[insn].trace_encoded_insn = (void *) key2;
3783 }
3784 else {
3785 insn_data[insn].notrace_encoded_insn = (void *) INSN_CODE(BIN(opt_invokebuiltin_delegate));
3786 insn_data[insn].trace_encoded_insn = (void *) INSN_CODE(BIN(opt_invokebuiltin_delegate) + VM_INSTRUCTION_SIZE/2);
3787 }
3788
3789 st_add_direct(encoded_insn_data, key1, (st_data_t)&insn_data[insn]);
3790 st_add_direct(encoded_insn_data, key2, (st_data_t)&insn_data[insn]);
3791 }
3792}
3793
3794int
3795rb_vm_insn_addr2insn(const void *addr)
3796{
3797 st_data_t key = (st_data_t)addr;
3798 st_data_t val;
3799
3800 if (st_lookup(encoded_insn_data, key, &val)) {
3801 insn_data_t *e = (insn_data_t *)val;
3802 return (int)e->insn;
3803 }
3804
3805 rb_bug("rb_vm_insn_addr2insn: invalid insn address: %p", addr);
3806}
3807
3808// Unlike rb_vm_insn_addr2insn, this function can return trace opcode variants.
3809int
3810rb_vm_insn_addr2opcode(const void *addr)
3811{
3812 st_data_t key = (st_data_t)addr;
3813 st_data_t val;
3814
3815 if (st_lookup(encoded_insn_data, key, &val)) {
3816 insn_data_t *e = (insn_data_t *)val;
3817 int opcode = e->insn;
3818 if (addr == e->trace_encoded_insn) {
3819 opcode += VM_INSTRUCTION_SIZE/2;
3820 }
3821 return opcode;
3822 }
3823
3824 rb_bug("rb_vm_insn_addr2opcode: invalid insn address: %p", addr);
3825}
3826
3827// Decode `ISEQ_BODY(iseq)->iseq_encoded[i]` to an insn.
3828int
3829rb_vm_insn_decode(const VALUE encoded)
3830{
3831#if OPT_DIRECT_THREADED_CODE || OPT_CALL_THREADED_CODE
3832 int insn = rb_vm_insn_addr2insn((void *)encoded);
3833#else
3834 int insn = (int)encoded;
3835#endif
3836 return insn;
3837}
3838
3839static inline int
3840encoded_iseq_trace_instrument(VALUE *iseq_encoded_insn, rb_event_flag_t turnon, bool remain_current_trace)
3841{
3842 st_data_t key = (st_data_t)*iseq_encoded_insn;
3843 st_data_t val;
3844
3845 if (st_lookup(encoded_insn_data, key, &val)) {
3846 insn_data_t *e = (insn_data_t *)val;
3847 if (remain_current_trace && key == (st_data_t)e->trace_encoded_insn) {
3848 turnon = 1;
3849 }
3850 *iseq_encoded_insn = (VALUE) (turnon ? e->trace_encoded_insn : e->notrace_encoded_insn);
3851 return e->insn_len;
3852 }
3853
3854 rb_bug("trace_instrument: invalid insn address: %p", (void *)*iseq_encoded_insn);
3855}
3856
3857void
3858rb_iseq_trace_flag_cleared(const rb_iseq_t *iseq, size_t pos)
3859{
3860 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3861 VALUE *iseq_encoded = (VALUE *)body->iseq_encoded;
3862 encoded_iseq_trace_instrument(&iseq_encoded[pos], 0, false);
3863}
3864
3865// We need to fire call events on instructions with b_call events if the block
3866// is running as a method. So, if we are listening for call events, then
3867// instructions that have b_call events need to become trace variants.
3868// Use this function when making decisions about recompiling to trace variants.
3869static inline rb_event_flag_t
3870add_bmethod_events(rb_event_flag_t events)
3871{
3872 if (events & RUBY_EVENT_CALL) {
3873 events |= RUBY_EVENT_B_CALL;
3874 }
3875 if (events & RUBY_EVENT_RETURN) {
3876 events |= RUBY_EVENT_B_RETURN;
3877 }
3878 return events;
3879}
3880
3881// Note, to support call/return events for bmethods, turnon_event can have more events than tpval.
3882static int
3883iseq_add_local_tracepoint(const rb_iseq_t *iseq, rb_event_flag_t turnon_events, VALUE tpval, unsigned int target_line)
3884{
3885 unsigned int pc;
3886 int n = 0;
3887 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3888 VALUE *iseq_encoded = (VALUE *)body->iseq_encoded;
3889
3890 VM_ASSERT(ISEQ_EXECUTABLE_P(iseq));
3891
3892 for (pc=0; pc<body->iseq_size;) {
3893 const struct iseq_insn_info_entry *entry = get_insn_info(iseq, pc);
3894 rb_event_flag_t pc_events = entry->events;
3895 rb_event_flag_t target_events = turnon_events;
3896 unsigned int line = (int)entry->line_no;
3897
3898 if (target_line == 0 || target_line == line) {
3899 /* ok */
3900 }
3901 else {
3902 target_events &= ~RUBY_EVENT_LINE;
3903 }
3904
3905 if (pc_events & target_events) {
3906 n++;
3907 }
3908 pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & (target_events | iseq->aux.exec.global_trace_events), true);
3909 }
3910
3911 if (n > 0) {
3912 if (iseq->aux.exec.local_hooks == NULL) {
3913 ((rb_iseq_t *)iseq)->aux.exec.local_hooks = RB_ZALLOC(rb_hook_list_t);
3914 iseq->aux.exec.local_hooks->is_local = true;
3915 }
3916 rb_hook_list_connect_tracepoint((VALUE)iseq, iseq->aux.exec.local_hooks, tpval, target_line);
3917 }
3918
3919 return n;
3920}
3921
3922 struct trace_set_local_events_struct {
3923 rb_event_flag_t turnon_events;
3924 VALUE tpval;
3925 unsigned int target_line;
3926 int n;
3927};
3928
3929static void
3930iseq_add_local_tracepoint_i(const rb_iseq_t *iseq, void *p)
3931{
3932 struct trace_set_local_events_struct *data = (struct trace_set_local_events_struct *)p;
3933 data->n += iseq_add_local_tracepoint(iseq, data->turnon_events, data->tpval, data->target_line);
3934 iseq_iterate_children(iseq, iseq_add_local_tracepoint_i, p);
3935}
3936
3937int
3938rb_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)
3939{
3940 struct trace_set_local_events_struct data;
3941 if (target_bmethod) {
3942 turnon_events = add_bmethod_events(turnon_events);
3943 }
3944 data.turnon_events = turnon_events;
3945 data.tpval = tpval;
3946 data.target_line = target_line;
3947 data.n = 0;
3948
3949 iseq_add_local_tracepoint_i(iseq, (void *)&data);
3950 if (0) rb_funcall(Qnil, rb_intern("puts"), 1, rb_iseq_disasm(iseq)); /* for debug */
3951 return data.n;
3952}
3953
3954static int
3955iseq_remove_local_tracepoint(const rb_iseq_t *iseq, VALUE tpval)
3956{
3957 int n = 0;
3958
3959 if (iseq->aux.exec.local_hooks) {
3960 unsigned int pc;
3961 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
3962 VALUE *iseq_encoded = (VALUE *)body->iseq_encoded;
3963 rb_event_flag_t local_events = 0;
3964
3965 rb_hook_list_remove_tracepoint(iseq->aux.exec.local_hooks, tpval);
3966 local_events = iseq->aux.exec.local_hooks->events;
3967
3968 if (local_events == 0) {
3969 rb_hook_list_free(iseq->aux.exec.local_hooks);
3970 ((rb_iseq_t *)iseq)->aux.exec.local_hooks = NULL;
3971 }
3972
3973 local_events = add_bmethod_events(local_events);
3974 for (pc = 0; pc<body->iseq_size;) {
3975 rb_event_flag_t pc_events = rb_iseq_event_flags(iseq, pc);
3976 pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & (local_events | iseq->aux.exec.global_trace_events), false);
3977 }
3978 }
3979 return n;
3980}
3981
3982 struct trace_clear_local_events_struct {
3983 VALUE tpval;
3984 int n;
3985};
3986
3987static void
3988iseq_remove_local_tracepoint_i(const rb_iseq_t *iseq, void *p)
3989{
3990 struct trace_clear_local_events_struct *data = (struct trace_clear_local_events_struct *)p;
3991 data->n += iseq_remove_local_tracepoint(iseq, data->tpval);
3992 iseq_iterate_children(iseq, iseq_remove_local_tracepoint_i, p);
3993}
3994
3995int
3996rb_iseq_remove_local_tracepoint_recursively(const rb_iseq_t *iseq, VALUE tpval)
3997{
3998 struct trace_clear_local_events_struct data;
3999 data.tpval = tpval;
4000 data.n = 0;
4001
4002 iseq_remove_local_tracepoint_i(iseq, (void *)&data);
4003 return data.n;
4004}
4005
4006void
4007rb_iseq_trace_set(const rb_iseq_t *iseq, rb_event_flag_t turnon_events)
4008{
4009 if (iseq->aux.exec.global_trace_events == turnon_events) {
4010 return;
4011 }
4012
4013 if (!ISEQ_EXECUTABLE_P(iseq)) {
4014 /* this is building ISeq */
4015 return;
4016 }
4017 else {
4018 unsigned int pc;
4019 const struct rb_iseq_constant_body *const body = ISEQ_BODY(iseq);
4020 VALUE *iseq_encoded = (VALUE *)body->iseq_encoded;
4021 rb_event_flag_t enabled_events;
4022 rb_event_flag_t local_events = iseq->aux.exec.local_hooks ? iseq->aux.exec.local_hooks->events : 0;
4023 ((rb_iseq_t *)iseq)->aux.exec.global_trace_events = turnon_events;
4024 enabled_events = add_bmethod_events(turnon_events | local_events);
4025
4026 for (pc=0; pc<body->iseq_size;) {
4027 rb_event_flag_t pc_events = rb_iseq_event_flags(iseq, pc);
4028 pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & enabled_events, true);
4029 }
4030 }
4031}
4032
4033void rb_vm_cc_general(const struct rb_callcache *cc);
4034
4035static bool
4036clear_attr_cc(VALUE v)
4037{
4038 if (imemo_type_p(v, imemo_callcache) && vm_cc_ivar_p((const struct rb_callcache *)v)) {
4039 rb_vm_cc_general((struct rb_callcache *)v);
4040 return true;
4041 }
4042 else {
4043 return false;
4044 }
4045}
4046
4047static bool
4048clear_bf_cc(VALUE v)
4049{
4050 if (imemo_type_p(v, imemo_callcache) && vm_cc_bf_p((const struct rb_callcache *)v)) {
4051 rb_vm_cc_general((struct rb_callcache *)v);
4052 return true;
4053 }
4054 else {
4055 return false;
4056 }
4057}
4058
4059static int
4060clear_attr_ccs_i(void *vstart, void *vend, size_t stride, void *data)
4061{
4062 VALUE v = (VALUE)vstart;
4063 for (; v != (VALUE)vend; v += stride) {
4064 void *ptr = rb_asan_poisoned_object_p(v);
4065 rb_asan_unpoison_object(v, false);
4066 clear_attr_cc(v);
4067 asan_poison_object_if(ptr, v);
4068 }
4069 return 0;
4070}
4071
4072void
4073rb_clear_attr_ccs(void)
4074{
4075 rb_objspace_each_objects(clear_attr_ccs_i, NULL);
4076}
4077
4078static int
4079clear_bf_ccs_i(void *vstart, void *vend, size_t stride, void *data)
4080{
4081 VALUE v = (VALUE)vstart;
4082 for (; v != (VALUE)vend; v += stride) {
4083 void *ptr = rb_asan_poisoned_object_p(v);
4084 rb_asan_unpoison_object(v, false);
4085 clear_bf_cc(v);
4086 asan_poison_object_if(ptr, v);
4087 }
4088 return 0;
4089}
4090
4091void
4092rb_clear_bf_ccs(void)
4093{
4094 rb_objspace_each_objects(clear_bf_ccs_i, NULL);
4095}
4096
4097static int
4098trace_set_i(void *vstart, void *vend, size_t stride, void *data)
4099{
4100 rb_event_flag_t turnon_events = *(rb_event_flag_t *)data;
4101
4102 VALUE v = (VALUE)vstart;
4103 for (; v != (VALUE)vend; v += stride) {
4104 void *ptr = rb_asan_poisoned_object_p(v);
4105 rb_asan_unpoison_object(v, false);
4106
4107 if (rb_obj_is_iseq(v)) {
4108 rb_iseq_trace_set(rb_iseq_check((rb_iseq_t *)v), turnon_events);
4109 }
4110 else if (clear_attr_cc(v)) {
4111 }
4112 else if (clear_bf_cc(v)) {
4113 }
4114
4115 asan_poison_object_if(ptr, v);
4116 }
4117 return 0;
4118}
4119
4120void
4121rb_iseq_trace_set_all(rb_event_flag_t turnon_events)
4122{
4123 rb_objspace_each_objects(trace_set_i, &turnon_events);
4124}
4125
4126 VALUE
4127rb_iseqw_local_variables(VALUE iseqval)
4128{
4129 return rb_iseq_local_variables(iseqw_check(iseqval));
4130}
4131
4132/*
4133 * call-seq:
4134 * iseq.to_binary(extra_data = nil) -> binary str
4135 *
4136 * Returns serialized iseq binary format data as a String object.
4137 * A corresponding iseq object is created by
4138 * RubyVM::InstructionSequence.load_from_binary() method.
4139 *
4140 * String extra_data will be saved with binary data.
4141 * You can access this data with
4142 * RubyVM::InstructionSequence.load_from_binary_extra_data(binary).
4143 *
4144 * Note that the translated binary data is not portable.
4145 * You can not move this binary data to another machine.
4146 * You can not use the binary data which is created by another
4147 * version/another architecture of Ruby.
4148 */
4149static VALUE
4150iseqw_to_binary(int argc, VALUE *argv, VALUE self)
4151{
4152 VALUE opt = !rb_check_arity(argc, 0, 1) ? Qnil : argv[0];
4153 return rb_iseq_ibf_dump(iseqw_check(self), opt);
4154}
4155
4156/*
4157 * call-seq:
4158 * RubyVM::InstructionSequence.load_from_binary(binary) -> iseq
4159 *
4160 * Load an iseq object from binary format String object
4161 * created by RubyVM::InstructionSequence.to_binary.
4162 *
4163 * This loader does not have a verifier, so that loading broken/modified
4164 * binary causes critical problem.
4165 *
4166 * You should not load binary data provided by others.
4167 * You should use binary data translated by yourself.
4168 */
4169static VALUE
4170iseqw_s_load_from_binary(VALUE self, VALUE str)
4171{
4172 return iseqw_new(rb_iseq_ibf_load(str));
4173}
4174
4175/*
4176 * call-seq:
4177 * RubyVM::InstructionSequence.load_from_binary_extra_data(binary) -> str
4178 *
4179 * Load extra data embed into binary format String object.
4180 */
4181static VALUE
4182iseqw_s_load_from_binary_extra_data(VALUE self, VALUE str)
4183{
4184 return rb_iseq_ibf_load_extra_data(str);
4185}
4186
4187#if VM_INSN_INFO_TABLE_IMPL == 2
4188
4189/* An implementation of succinct bit-vector for insn_info table.
4190 *
4191 * A succinct bit-vector is a small and efficient data structure that provides
4192 * a bit-vector augmented with an index for O(1) rank operation:
4193 *
4194 * rank(bv, n): the number of 1's within a range from index 0 to index n
4195 *
4196 * This can be used to lookup insn_info table from PC.
4197 * For example, consider the following iseq and insn_info_table:
4198 *
4199 * iseq insn_info_table
4200 * PC insn+operand position lineno event
4201 * 0: insn1 0: 1 [Li]
4202 * 2: insn2 2: 2 [Li] <= (A)
4203 * 5: insn3 8: 3 [Li] <= (B)
4204 * 8: insn4
4205 *
4206 * In this case, a succinct bit-vector whose indexes 0, 2, 8 is "1" and
4207 * other indexes is "0", i.e., "101000001", is created.
4208 * To lookup the lineno of insn2, calculate rank("10100001", 2) = 2, so
4209 * the line (A) is the entry in question.
4210 * To lookup the lineno of insn4, calculate rank("10100001", 8) = 3, so
4211 * the line (B) is the entry in question.
4212 *
4213 * A naive implementation of succinct bit-vector works really well
4214 * not only for large size but also for small size. However, it has
4215 * tiny overhead for very small size. So, this implementation consist
4216 * of two parts: one part is the "immediate" table that keeps rank result
4217 * as a raw table, and the other part is a normal succinct bit-vector.
4218 */
4219
4220#define IMMEDIATE_TABLE_SIZE 54 /* a multiple of 9, and < 128 */
4221
4222struct succ_index_table {
4223 uint64_t imm_part[IMMEDIATE_TABLE_SIZE / 9];
4224 struct succ_dict_block {
4225 unsigned int rank;
4226 uint64_t small_block_ranks; /* 9 bits * 7 = 63 bits */
4227 uint64_t bits[512/64];
4228 } succ_part[FLEX_ARY_LEN];
4229};
4230
4231#define imm_block_rank_set(v, i, r) (v) |= (uint64_t)(r) << (7 * (i))
4232#define imm_block_rank_get(v, i) (((int)((v) >> ((i) * 7))) & 0x7f)
4233#define small_block_rank_set(v, i, r) (v) |= (uint64_t)(r) << (9 * ((i) - 1))
4234#define small_block_rank_get(v, i) ((i) == 0 ? 0 : (((int)((v) >> (((i) - 1) * 9))) & 0x1ff))
4235
4236static struct succ_index_table *
4237succ_index_table_create(int max_pos, int *data, int size)
4238{
4239 const int imm_size = (max_pos < IMMEDIATE_TABLE_SIZE ? max_pos + 8 : IMMEDIATE_TABLE_SIZE) / 9;
4240 const int succ_size = (max_pos < IMMEDIATE_TABLE_SIZE ? 0 : (max_pos - IMMEDIATE_TABLE_SIZE + 511)) / 512;
4241 struct succ_index_table *sd =
4242 rb_xcalloc_mul_add_mul(
4243 imm_size, sizeof(uint64_t),
4244 succ_size, sizeof(struct succ_dict_block));
4245 int i, j, k, r;
4246
4247 r = 0;
4248 for (j = 0; j < imm_size; j++) {
4249 for (i = 0; i < 9; i++) {
4250 if (r < size && data[r] == j * 9 + i) r++;
4251 imm_block_rank_set(sd->imm_part[j], i, r);
4252 }
4253 }
4254 for (k = 0; k < succ_size; k++) {
4255 struct succ_dict_block *sd_block = &sd->succ_part[k];
4256 int small_rank = 0;
4257 sd_block->rank = r;
4258 for (j = 0; j < 8; j++) {
4259 uint64_t bits = 0;
4260 if (j) small_block_rank_set(sd_block->small_block_ranks, j, small_rank);
4261 for (i = 0; i < 64; i++) {
4262 if (r < size && data[r] == k * 512 + j * 64 + i + IMMEDIATE_TABLE_SIZE) {
4263 bits |= ((uint64_t)1) << i;
4264 r++;
4265 }
4266 }
4267 sd_block->bits[j] = bits;
4268 small_rank += rb_popcount64(bits);
4269 }
4270 }
4271 return sd;
4272}
4273
4274static unsigned int *
4275succ_index_table_invert(int max_pos, struct succ_index_table *sd, int size)
4276{
4277 const int imm_size = (max_pos < IMMEDIATE_TABLE_SIZE ? max_pos + 8 : IMMEDIATE_TABLE_SIZE) / 9;
4278 const int succ_size = (max_pos < IMMEDIATE_TABLE_SIZE ? 0 : (max_pos - IMMEDIATE_TABLE_SIZE + 511)) / 512;
4279 unsigned int *positions = ALLOC_N(unsigned int, size), *p;
4280 int i, j, k, r = -1;
4281 p = positions;
4282 for (j = 0; j < imm_size; j++) {
4283 for (i = 0; i < 9; i++) {
4284 int nr = imm_block_rank_get(sd->imm_part[j], i);
4285 if (r != nr) *p++ = j * 9 + i;
4286 r = nr;
4287 }
4288 }
4289 for (k = 0; k < succ_size; k++) {
4290 for (j = 0; j < 8; j++) {
4291 for (i = 0; i < 64; i++) {
4292 if (sd->succ_part[k].bits[j] & (((uint64_t)1) << i)) {
4293 *p++ = k * 512 + j * 64 + i + IMMEDIATE_TABLE_SIZE;
4294 }
4295 }
4296 }
4297 }
4298 return positions;
4299}
4300
4301static int
4302succ_index_lookup(const struct succ_index_table *sd, int x)
4303{
4304 if (x < IMMEDIATE_TABLE_SIZE) {
4305 const int i = x / 9;
4306 const int j = x % 9;
4307 return imm_block_rank_get(sd->imm_part[i], j);
4308 }
4309 else {
4310 const int block_index = (x - IMMEDIATE_TABLE_SIZE) / 512;
4311 const struct succ_dict_block *block = &sd->succ_part[block_index];
4312 const int block_bit_index = (x - IMMEDIATE_TABLE_SIZE) % 512;
4313 const int small_block_index = block_bit_index / 64;
4314 const int small_block_popcount = small_block_rank_get(block->small_block_ranks, small_block_index);
4315 const int popcnt = rb_popcount64(block->bits[small_block_index] << (63 - block_bit_index % 64));
4316
4317 return block->rank + small_block_popcount + popcnt;
4318 }
4319}
4320#endif
4321
4322
4323/*
4324 * call-seq:
4325 * iseq.script_lines -> array or nil
4326 *
4327 * It returns recorded script lines if it is available.
4328 * The script lines are not limited to the iseq range, but
4329 * are entire lines of the source file.
4330 *
4331 * Note that this is an API for ruby internal use, debugging,
4332 * and research. Do not use this for any other purpose.
4333 * The compatibility is not guaranteed.
4334 */
4335static VALUE
4336iseqw_script_lines(VALUE self)
4337{
4338 const rb_iseq_t *iseq = iseqw_check(self);
4339 return ISEQ_BODY(iseq)->variable.script_lines;
4340}
4341
4342/*
4343 * Document-class: RubyVM::InstructionSequence
4344 *
4345 * The InstructionSequence class represents a compiled sequence of
4346 * instructions for the Virtual Machine used in MRI. Not all implementations of Ruby
4347 * may implement this class, and for the implementations that implement it,
4348 * the methods defined and behavior of the methods can change in any version.
4349 *
4350 * With it, you can get a handle to the instructions that make up a method or
4351 * a proc, compile strings of Ruby code down to VM instructions, and
4352 * disassemble instruction sequences to strings for easy inspection. It is
4353 * mostly useful if you want to learn how YARV works, but it also lets
4354 * you control various settings for the Ruby iseq compiler.
4355 *
4356 * You can find the source for the VM instructions in +insns.def+ in the Ruby
4357 * source.
4358 *
4359 * The instruction sequence results will almost certainly change as Ruby
4360 * changes, so example output in this documentation may be different from what
4361 * you see.
4362 *
4363 * Of course, this class is MRI specific.
4364 */
4365
4366void
4367Init_ISeq(void)
4368{
4369 /* declare ::RubyVM::InstructionSequence */
4370 rb_cISeq = rb_define_class_under(rb_cRubyVM, "InstructionSequence", rb_cObject);
4371 rb_undef_alloc_func(rb_cISeq);
4372 rb_define_method(rb_cISeq, "inspect", iseqw_inspect, 0);
4373 rb_define_method(rb_cISeq, "disasm", iseqw_disasm, 0);
4374 rb_define_method(rb_cISeq, "disassemble", iseqw_disasm, 0);
4375 rb_define_method(rb_cISeq, "to_a", iseqw_to_a, 0);
4376 rb_define_method(rb_cISeq, "eval", iseqw_eval, 0);
4377
4378 rb_define_method(rb_cISeq, "to_binary", iseqw_to_binary, -1);
4379 rb_define_singleton_method(rb_cISeq, "load_from_binary", iseqw_s_load_from_binary, 1);
4380 rb_define_singleton_method(rb_cISeq, "load_from_binary_extra_data", iseqw_s_load_from_binary_extra_data, 1);
4381
4382 /* location APIs */
4383 rb_define_method(rb_cISeq, "path", iseqw_path, 0);
4384 rb_define_method(rb_cISeq, "absolute_path", iseqw_absolute_path, 0);
4385 rb_define_method(rb_cISeq, "label", iseqw_label, 0);
4386 rb_define_method(rb_cISeq, "base_label", iseqw_base_label, 0);
4387 rb_define_method(rb_cISeq, "first_lineno", iseqw_first_lineno, 0);
4388 rb_define_method(rb_cISeq, "trace_points", iseqw_trace_points, 0);
4389 rb_define_method(rb_cISeq, "each_child", iseqw_each_child, 0);
4390
4391#if 0 /* TBD */
4392 rb_define_private_method(rb_cISeq, "marshal_dump", iseqw_marshal_dump, 0);
4393 rb_define_private_method(rb_cISeq, "marshal_load", iseqw_marshal_load, 1);
4394 /* disable this feature because there is no verifier. */
4395 rb_define_singleton_method(rb_cISeq, "load", iseq_s_load, -1);
4396#endif
4397 (void)iseq_s_load;
4398
4399 rb_define_singleton_method(rb_cISeq, "compile", iseqw_s_compile, -1);
4400 rb_define_singleton_method(rb_cISeq, "compile_parsey", iseqw_s_compile_parsey, -1);
4401 rb_define_singleton_method(rb_cISeq, "compile_prism", iseqw_s_compile_prism, -1);
4402 rb_define_singleton_method(rb_cISeq, "compile_file_prism", iseqw_s_compile_file_prism, -1);
4403 rb_define_singleton_method(rb_cISeq, "new", iseqw_s_compile, -1);
4404 rb_define_singleton_method(rb_cISeq, "compile_file", iseqw_s_compile_file, -1);
4405 rb_define_singleton_method(rb_cISeq, "compile_option", iseqw_s_compile_option_get, 0);
4406 rb_define_singleton_method(rb_cISeq, "compile_option=", iseqw_s_compile_option_set, 1);
4407 rb_define_singleton_method(rb_cISeq, "disasm", iseqw_s_disasm, 1);
4408 rb_define_singleton_method(rb_cISeq, "disassemble", iseqw_s_disasm, 1);
4409 rb_define_singleton_method(rb_cISeq, "of", iseqw_s_of, 1);
4410
4411 // script lines
4412 rb_define_method(rb_cISeq, "script_lines", iseqw_script_lines, 0);
4413
4414 rb_undef_method(CLASS_OF(rb_cISeq), "translate");
4415 rb_undef_method(CLASS_OF(rb_cISeq), "load_iseq");
4416}
RUBY_ASSERT
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
rb_define_method
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
Definition cxxanyargs.hpp:670
rb_define_singleton_method
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
Definition cxxanyargs.hpp:685
rb_define_private_method
#define rb_define_private_method(klass, mid, func, arity)
Defines klass#mid and makes it private.
Definition cxxanyargs.hpp:677
RUBY_EVENT_END
#define RUBY_EVENT_END
Encountered an end of a class clause.
Definition event.h:40
RUBY_EVENT_C_CALL
#define RUBY_EVENT_C_CALL
A method, written in C, is called.
Definition event.h:43
RUBY_EVENT_B_RETURN
#define RUBY_EVENT_B_RETURN
Encountered a next statement.
Definition event.h:56
RUBY_EVENT_CLASS
#define RUBY_EVENT_CLASS
Encountered a new class.
Definition event.h:39
RUBY_EVENT_LINE
#define RUBY_EVENT_LINE
Encountered a new line.
Definition event.h:38
RUBY_EVENT_RETURN
#define RUBY_EVENT_RETURN
Encountered a return statement.
Definition event.h:42
RUBY_EVENT_C_RETURN
#define RUBY_EVENT_C_RETURN
Return from a method, written in C.
Definition event.h:44
RUBY_EVENT_B_CALL
#define RUBY_EVENT_B_CALL
Encountered an yield statement.
Definition event.h:55
rb_event_flag_t
uint32_t rb_event_flag_t
Represents event(s).
Definition event.h:108
RUBY_EVENT_CALL
#define RUBY_EVENT_CALL
A method, written in Ruby, is called.
Definition event.h:41
RUBY_EVENT_RESCUE
#define RUBY_EVENT_RESCUE
Encountered a rescue statement.
Definition event.h:61
RB_OBJ_FREEZE
#define RB_OBJ_FREEZE
Just another name of rb_obj_freeze_inline.
Definition fl_type.h:93
rb_define_class_under
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
Definition class.c:1012
rb_undef_method
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
Definition class.c:2171
rb_scan_args
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
Definition class.c:2640
rb_str_new2
#define rb_str_new2
Old name of rb_str_new_cstr.
Definition string.h:1675
T_FILE
#define T_FILE
Old name of RUBY_T_FILE.
Definition value_type.h:62
T_STRING
#define T_STRING
Old name of RUBY_T_STRING.
Definition value_type.h:78
Qundef
#define Qundef
Old name of RUBY_Qundef.
Definition special_consts.h:62
INT2FIX
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
rb_str_cat2
#define rb_str_cat2
Old name of rb_str_cat_cstr.
Definition string.h:1683
ID2SYM
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
SPECIAL_CONST_P
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
Definition special_consts.h:56
ULONG2NUM
#define ULONG2NUM
Old name of RB_ULONG2NUM.
Definition long.h:60
SYM2ID
#define SYM2ID
Old name of RB_SYM2ID.
Definition symbol.h:45
ZALLOC
#define ZALLOC
Old name of RB_ZALLOC.
Definition memory.h:402
LL2NUM
#define LL2NUM
Old name of RB_LL2NUM.
Definition long_long.h:30
CLASS_OF
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:203
T_NONE
#define T_NONE
Old name of RUBY_T_NONE.
Definition value_type.h:74
FIX2INT
#define FIX2INT
Old name of RB_FIX2INT.
Definition int.h:41
T_HASH
#define T_HASH
Old name of RUBY_T_HASH.
Definition value_type.h:65
ALLOC_N
#define ALLOC_N
Old name of RB_ALLOC_N.
Definition memory.h:399
FL_TEST_RAW
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition fl_type.h:132
LONG2NUM
#define LONG2NUM
Old name of RB_LONG2NUM.
Definition long.h:50
Qtrue
#define Qtrue
Old name of RUBY_Qtrue.
Definition special_consts.h:61
NUM2INT
#define NUM2INT
Old name of RB_NUM2INT.
Definition int.h:44
INT2NUM
#define INT2NUM
Old name of RB_INT2NUM.
Definition int.h:43
Qnil
#define Qnil
Old name of RUBY_Qnil.
Definition special_consts.h:60
Qfalse
#define Qfalse
Old name of RUBY_Qfalse.
Definition special_consts.h:59
T_ARRAY
#define T_ARRAY
Old name of RUBY_T_ARRAY.
Definition value_type.h:56
NIL_P
#define NIL_P
Old name of RB_NIL_P.
Definition special_consts.h:55
BUILTIN_TYPE
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition value_type.h:85
NUM2LONG
#define NUM2LONG
Old name of RB_NUM2LONG.
Definition long.h:51
UINT2NUM
#define UINT2NUM
Old name of RB_UINT2NUM.
Definition int.h:46
FIXNUM_P
#define FIXNUM_P
Old name of RB_FIXNUM_P.
Definition special_consts.h:53
CONST_ID
#define CONST_ID
Old name of RUBY_CONST_ID.
Definition symbol.h:47
rb_ary_new2
#define rb_ary_new2
Old name of rb_ary_new_capa.
Definition array.h:657
rb_eTypeError
VALUE rb_eTypeError
TypeError exception.
Definition error.c:1430
rb_check_typeddata
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
rb_eSyntaxError
VALUE rb_eSyntaxError
SyntaxError exception.
Definition error.c:1447
rb_class_superclass
VALUE rb_class_superclass(VALUE klass)
Queries the parent of the given class.
Definition object.c:2153
rb_obj_hide
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
Definition object.c:104
rb_obj_class
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:247
rb_inspect
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
Definition object.c:680
RB_OBJ_WRITE
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Definition gc.h:603
rb_funcall
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
Definition vm_eval.c:1099
rb_ary_new
VALUE rb_ary_new(void)
Allocates a new, empty array.
Definition array.c:741
rb_check_arity
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
Definition error.h:284
rb_hash_new
VALUE rb_hash_new(void)
Creates a new, empty hash object.
Definition hash.c:1477
rb_file_open_str
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
rb_io_close
VALUE rb_io_close(VALUE io)
Closes the IO.
Definition io.c:5758
rb_is_local_id
int rb_is_local_id(ID id)
Classifies the given ID, then sees if it is a local variable.
Definition symbol.c:1094
rb_obj_is_method
VALUE rb_obj_is_method(VALUE recv)
Queries if the given object is a method.
Definition proc.c:1652
rb_obj_is_proc
VALUE rb_obj_is_proc(VALUE recv)
Queries if the given object is a proc.
Definition proc.c:120
rb_str_append
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:3681
rb_str_new
#define rb_str_new(str, len)
Allocates an instance of rb_cString.
Definition string.h:1498
rb_exc_new_cstr
#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
rb_str_dup
VALUE rb_str_dup(VALUE str)
Duplicates a string.
Definition string.c:1921
rb_str_cat
VALUE rb_str_cat(VALUE dst, const char *src, long srclen)
Destructively appends the passed contents to the string.
Definition string.c:3449
rb_str_resurrect
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:1939
rb_str_set_len
void rb_str_set_len(VALUE str, long len)
Overwrites the length of the string.
Definition string.c:3273
rb_str_inspect
VALUE rb_str_inspect(VALUE str)
Generates a "readable" version of the receiver.
Definition string.c:7202
rb_str_cmp
int rb_str_cmp(VALUE lhs, VALUE rhs)
Compares two strings, as in strcmp(3).
Definition string.c:4106
rb_str_concat
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:3923
rb_str_cat_cstr
#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
rb_str_modify_expand
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:2653
rb_str_new_cstr
#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
rb_str_intern
VALUE rb_str_intern(VALUE str)
Identical to rb_to_symbol(), except it assumes the receiver being an instance of RString.
Definition symbol.c:879
rb_class_name
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
Definition variable.c:492
rb_respond_to
int rb_respond_to(VALUE obj, ID mid)
Queries if the object responds to the method.
Definition vm_method.c:2973
rb_undef_alloc_func
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
Definition vm_method.c:1297
rb_check_funcall
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
rb_check_id
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
Definition symbol.c:1118
rb_sym2str
VALUE rb_sym2str(VALUE symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
Definition symbol.c:971
rb_io_path
VALUE rb_io_path(VALUE io)
Returns the path for the given IO.
Definition io.c:2972
len
int len
Length of the buffer.
Definition io.h:8
ractor.h
rb_ractor_make_shareable
VALUE rb_ractor_make_shareable(VALUE obj)
Destructively transforms the passed object so that multiple Ractors can share it.
Definition ractor.c:3118
util.h
RB_NUM2INT
#define RB_NUM2INT
Just another name of rb_num2int_inline.
Definition int.h:38
RB_INT2NUM
#define RB_INT2NUM
Just another name of rb_int2num_inline.
Definition int.h:37
rb_yield
VALUE rb_yield(VALUE val)
Yields the block.
Definition vm_eval.c:1354
RB_GC_GUARD
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
RB_ZALLOC
#define RB_ZALLOC(type)
Shorthand of RB_ZALLOC_N with n=1.
Definition memory.h:249
ruby::backward::cxxanyargs::type
VALUE type(ANYARGS)
ANYARGS-ed function type.
Definition cxxanyargs.hpp:56
ruby::backward::cxxanyargs::rb_hash_foreach
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
Definition cxxanyargs.hpp:482
RARRAY_LEN
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
RARRAY_LENINT
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
Definition rarray.h:281
RARRAY_AREF
#define RARRAY_AREF(a, i)
Definition rarray.h:403
RBASIC_CLASS
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
Definition rbasic.h:153
RHASH_SIZE
#define RHASH_SIZE(h)
Queries the size of the hash.
Definition rhash.h:69
StringValue
#define StringValue(v)
Ensures that the parameter object is a String.
Definition rstring.h:66
RSTRING_END
static char * RSTRING_END(VALUE str)
Queries the end of the contents pointer of the string.
Definition rstring.h:409
StringValueCStr
#define StringValueCStr(v)
Identical to StringValuePtr, except it additionally checks for the contents for viability as a C stri...
Definition rstring.h:89
RUBY_TYPED_DEFAULT_FREE
#define RUBY_TYPED_DEFAULT_FREE
This is a value you can set to rb_data_type_struct::dfree.
Definition rtypeddata.h:79
TypedData_Get_Struct
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
Definition rtypeddata.h:515
TypedData_Wrap_Struct
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
Definition rtypeddata.h:449
rb_data_type_t
struct rb_data_type_struct rb_data_type_t
This is the struct that holds necessary info for a struct.
Definition rtypeddata.h:197
TypedData_Make_Struct
#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
FilePathValue
#define FilePathValue(v)
Ensures that the parameter object is a path.
Definition ruby.h:90
RTEST
#define RTEST
This is an old name of RB_TEST.
Definition special_consts.h:51
insn_data_struct
Definition iseq.c:3747
iseq_catch_table_entry
Definition iseq.h:270
iseq_catch_table
Definition iseq.h:281
iseq_compile_data_storage
Definition iseq.h:300
iseq_compile_data
Definition iseq.h:102
iseq_inline_constant_cache::segments
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
iseq_insn_info_entry
Definition iseq.h:241
pm_iseq_new_with_opt_data
Definition iseq.c:1031
pm_line_column_t
A line and column in a string.
Definition pm_newline_list.h:45
pm_line_column_t::column
uint32_t column
The column number.
Definition pm_newline_list.h:50
pm_line_column_t::line
int32_t line
The line number.
Definition pm_newline_list.h:47
pm_location_t
This represents a range of bytes in the source string to which a node or token corresponds.
Definition ast.h:544
pm_location_t::start
const uint8_t * start
A pointer to the start location of the range in the source.
Definition ast.h:546
pm_location_t::end
const uint8_t * end
A pointer to the end location of the range in the source.
Definition ast.h:549
pm_newline_list_t::size
size_t size
The number of offsets in the list.
Definition pm_newline_list.h:33
pm_node::node_id
uint32_t node_id
The unique identifier for this node, which is deterministic based on the source.
Definition ast.h:1085
pm_node::location
pm_location_t location
This is the location of the node in the source.
Definition ast.h:1091
pm_options::line
int32_t line
The line within the file that the parse starts on.
Definition options.h:124
pm_parse_result_t
Definition prism_compile.h:69
pm_parse_result_t::node
pm_scope_node_t node
The resulting scope node that will hold the generated AST.
Definition prism_compile.h:80
pm_parse_result_t::options
pm_options_t options
The options that will be passed to the parser.
Definition prism_compile.h:74
pm_parser::start_line
int32_t start_line
The line number at the start of the parse.
Definition parser.h:809
pm_parser::newline_list
pm_newline_list_t newline_list
This is the list of newline offsets in the source file.
Definition parser.h:789
pm_scope_node::script_lines
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 prism_compile.h:40
rb_builtin_function
Definition builtin.h:6
rb_call_data
Definition vm_callinfo.h:576
rb_callable_method_entry_struct
Definition method.h:62
rb_callcache
Definition vm_callinfo.h:278
rb_callinfo_kwarg
Definition vm_callinfo.h:48
rb_callinfo
Definition vm_callinfo.h:65
rb_id_table
Definition id_table.c:41
rb_iseq_constant_body
Definition vm_core.h:404
rb_iseq_constant_body::param
struct rb_iseq_constant_body::@000024342312237062266020177166377106262102236123 param
parameter information
rb_iseq_new_with_callback_callback_func
Definition vm_core.h:1233
trace_clear_local_events_struct
Definition iseq.c:3982
trace_set_local_events_struct
Definition iseq.c:3922
iseq_inline_storage_entry
Definition vm_core.h:297
SIGNED_VALUE
intptr_t SIGNED_VALUE
A signed integer type that has the same width with VALUE.
Definition value.h:63
ID
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
Check_Type
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
Definition value_type.h:433
RB_TYPE_P
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376
ruby_value_type
ruby_value_type
C-level type of an object.
Definition value_type.h:113