12#define RUBY_VM_INSNS_INFO 1
15#include "ruby/internal/config.h"
21#include "eval_intern.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"
40#include "vm_callinfo.h"
45#include "insns_info.inc"
51#if VM_INSN_INFO_TABLE_IMPL == 2
52static struct succ_index_table *succ_index_table_create(
int max_pos,
int *data,
int size);
53static unsigned int *succ_index_table_invert(
int max_pos,
struct succ_index_table *sd,
int size);
54static int succ_index_lookup(
const struct succ_index_table *sd,
int x);
57#define hidden_obj_p(obj) (!SPECIAL_CONST_P(obj) && !RBASIC(obj)->klass)
60obj_resurrect(
VALUE obj)
62 if (hidden_obj_p(obj)) {
68 obj = rb_ary_resurrect(obj);
71 obj = rb_hash_resurrect(obj);
96 free_arena(compile_data->node.storage_head);
97 free_arena(compile_data->insn.storage_head);
98 if (compile_data->ivar_cache_table) {
99 rb_id_table_free(compile_data->ivar_cache_table);
101 ruby_xfree(compile_data);
106remove_from_constant_cache(
ID id,
IC ic)
110 st_data_t ic_data = (st_data_t)ic;
112 if (rb_id_table_lookup(vm->constant_cache,
id, &lookup_result)) {
114 st_delete(ics, &ic_data, NULL);
116 if (ics->num_entries == 0 &&
118 id != vm->inserting_constant_cache_id) {
119 rb_id_table_delete(vm->constant_cache,
id);
129iseq_clear_ic_references(
const rb_iseq_t *iseq)
135 if (!ISEQ_BODY(iseq)->is_entries) {
139 for (
unsigned int ic_idx = 0; ic_idx < ISEQ_BODY(iseq)->ic_size; ic_idx++) {
140 IC ic = &ISEQ_IS_IC_ENTRY(ISEQ_BODY(iseq), ic_idx);
148 if (segments == NULL)
151 for (
int i = 0; segments[i]; i++) {
153 if (
id == idNULL)
continue;
154 remove_from_constant_cache(
id, ic);
157 ruby_xfree((
void *)segments);
164 RUBY_FREE_ENTER(
"iseq");
166 if (iseq && ISEQ_BODY(iseq)) {
167 iseq_clear_ic_references(iseq);
170 rb_yjit_iseq_free(iseq);
173 rb_yjit_live_iseq_count--;
176 ruby_xfree((
void *)body->iseq_encoded);
177 ruby_xfree((
void *)body->insns_info.body);
178 ruby_xfree((
void *)body->insns_info.positions);
179#if VM_INSN_INFO_TABLE_IMPL == 2
180 ruby_xfree(body->insns_info.succ_index_table);
182 ruby_xfree((
void *)body->is_entries);
183 ruby_xfree(body->call_data);
184 ruby_xfree((
void *)body->catch_table);
185 ruby_xfree((
void *)body->
param.opt_table);
186 if (ISEQ_MBITS_BUFLEN(body->iseq_size) > 1 && body->mark_bits.list) {
187 ruby_xfree((
void *)body->mark_bits.list);
190 ruby_xfree(body->variable.original_iseq);
192 if (body->
param.keyword != NULL) {
193 if (body->
param.keyword->table != &body->local_table[body->
param.keyword->bits_start - body->
param.keyword->num])
194 ruby_xfree((
void *)body->
param.keyword->table);
195 if (body->
param.keyword->default_values) {
196 ruby_xfree((
void *)body->
param.keyword->default_values);
198 ruby_xfree((
void *)body->
param.keyword);
200 if (LIKELY(body->local_table != rb_iseq_shared_exc_local_tbl))
201 ruby_xfree((
void *)body->local_table);
202 compile_data_free(ISEQ_COMPILE_DATA(iseq));
203 if (body->outer_variables) rb_id_table_free(body->outer_variables);
207 if (iseq && ISEQ_EXECUTABLE_P(iseq) && iseq->aux.exec.local_hooks) {
208 rb_hook_list_free(iseq->aux.exec.local_hooks);
211 RUBY_FREE_LEAVE(
"iseq");
214typedef VALUE iseq_value_itr_t(
void *ctx,
VALUE obj);
217iseq_scan_bits(
unsigned int page, iseq_bits_t bits,
VALUE *code,
VALUE *original_iseq)
220 unsigned int page_offset = (page * ISEQ_MBITS_BITLENGTH);
223 offset = ntz_intptr(bits);
224 VALUE op = code[page_offset + offset];
225 rb_gc_mark_and_move(&code[page_offset + offset]);
226 VALUE newop = code[page_offset + offset];
227 if (original_iseq && newop != op) {
228 original_iseq[page_offset + offset] = newop;
235rb_iseq_mark_and_move_each_compile_data_value(
const rb_iseq_t *iseq,
VALUE *original_iseq)
241 size = compile_data->iseq_size;
242 code = compile_data->iseq_encoded;
245 if (compile_data->mark_bits.list) {
246 if(compile_data->is_single_mark_bit) {
247 iseq_scan_bits(0, compile_data->mark_bits.single, code, original_iseq);
250 for (
unsigned int i = 0; i < ISEQ_MBITS_BUFLEN(size); i++) {
251 iseq_bits_t bits = compile_data->mark_bits.list[i];
252 iseq_scan_bits(i, bits, code, original_iseq);
258rb_iseq_mark_and_move_each_body_value(
const rb_iseq_t *iseq,
VALUE *original_iseq)
264 size = body->iseq_size;
265 code = body->iseq_encoded;
269 if (body->is_entries) {
271 is_entries += body->ivc_size;
274 for (
unsigned int i = 0; i < body->icvarc_size; i++, is_entries++) {
279 rb_gc_mark_and_move(&icvarc->entry->class_value);
284 for (
unsigned int i = 0; i < body->ise_size; i++, is_entries++) {
286 if (is->once.value) {
287 rb_gc_mark_and_move(&is->once.value);
292 for (
unsigned int i = 0; i < body->ic_size; i++, is_entries++) {
293 IC ic = (
IC)is_entries;
295 rb_gc_mark_and_move_ptr(&ic->entry);
301 if (body->mark_bits.list) {
302 if (ISEQ_MBITS_BUFLEN(size) == 1) {
303 iseq_scan_bits(0, body->mark_bits.single, code, original_iseq);
306 for (
unsigned int i = 0; i < ISEQ_MBITS_BUFLEN(size); i++) {
307 iseq_bits_t bits = body->mark_bits.list[i];
308 iseq_scan_bits(i, bits, code, original_iseq);
315cc_is_active(
const struct rb_callcache *cc,
bool reference_updating)
318 if (cc == rb_vm_empty_cc() || rb_vm_empty_cc_for_super()) {
322 if (reference_updating) {
326 if (vm_cc_markable(cc)) {
329 if (reference_updating) {
332 if (!METHOD_ENTRY_INVALIDATED(cme)) {
342rb_iseq_mark_and_move(
rb_iseq_t *iseq,
bool reference_updating)
344 RUBY_MARK_ENTER(
"iseq");
346 rb_gc_mark_and_move(&iseq->wrapper);
348 if (ISEQ_BODY(iseq)) {
351 rb_iseq_mark_and_move_each_body_value(iseq, reference_updating ? ISEQ_ORIGINAL_ISEQ(iseq) : NULL);
353 rb_gc_mark_and_move(&body->variable.coverage);
354 rb_gc_mark_and_move(&body->variable.pc2branchindex);
355 rb_gc_mark_and_move(&body->variable.script_lines);
356 rb_gc_mark_and_move(&body->location.label);
357 rb_gc_mark_and_move(&body->location.base_label);
358 rb_gc_mark_and_move(&body->location.pathobj);
359 if (body->local_iseq) rb_gc_mark_and_move_ptr(&body->local_iseq);
360 if (body->parent_iseq) rb_gc_mark_and_move_ptr(&body->parent_iseq);
361 if (body->mandatory_only_iseq) rb_gc_mark_and_move_ptr(&body->mandatory_only_iseq);
363 if (body->call_data) {
364 for (
unsigned int i = 0; i < body->ci_size; i++) {
367 if (cds[i].ci) rb_gc_mark_and_move_ptr(&cds[i].ci);
369 if (cc_is_active(cds[i].cc, reference_updating)) {
370 rb_gc_mark_and_move_ptr(&cds[i].cc);
372 else if (cds[i].cc != rb_vm_empty_cc()) {
373 cds[i].cc = rb_vm_empty_cc();
378 if (body->
param.flags.has_kw && body->
param.keyword != NULL) {
379 const struct rb_iseq_param_keyword *
const keyword = body->
param.keyword;
381 if (keyword->default_values != NULL) {
382 for (
int j = 0, i = keyword->required_num; i < keyword->num; i++, j++) {
383 rb_gc_mark_and_move(&keyword->default_values[j]);
388 if (body->catch_table) {
391 for (
unsigned int i = 0; i < table->size; i++) {
393 entry = UNALIGNED_MEMBER_PTR(table, entries[i]);
395 rb_gc_mark_and_move_ptr(&entry->iseq);
400 if (reference_updating) {
402 rb_yjit_iseq_update_references(iseq);
407 rb_yjit_iseq_mark(body->yjit_payload);
413 rb_gc_mark_and_move(&iseq->aux.loader.obj);
418 rb_iseq_mark_and_move_insn_storage(compile_data->insn.storage_head);
419 rb_iseq_mark_and_move_each_compile_data_value(iseq, reference_updating ? ISEQ_ORIGINAL_ISEQ(iseq) : NULL);
421 rb_gc_mark_and_move((
VALUE *)&compile_data->err_info);
422 rb_gc_mark_and_move((
VALUE *)&compile_data->catch_table_ary);
426 VM_ASSERT(ISEQ_EXECUTABLE_P(iseq));
428 if (iseq->aux.exec.local_hooks) {
429 rb_hook_list_mark_and_update(iseq->aux.exec.local_hooks);
433 RUBY_MARK_LEAVE(
"iseq");
437param_keyword_size(
const struct rb_iseq_param_keyword *pkw)
441 if (!pkw)
return size;
443 size +=
sizeof(
struct rb_iseq_param_keyword);
444 size +=
sizeof(
VALUE) * (pkw->num - pkw->required_num);
458 if (ISEQ_EXECUTABLE_P(iseq) && body) {
460 size += body->iseq_size *
sizeof(
VALUE);
462 size += body->local_table_size *
sizeof(
ID);
463 size += ISEQ_MBITS_BUFLEN(body->iseq_size) * ISEQ_MBITS_SIZE;
464 if (body->catch_table) {
465 size += iseq_catch_table_bytes(body->catch_table->size);
467 size += (body->
param.opt_num + 1) *
sizeof(
VALUE);
468 size += param_keyword_size(body->
param.keyword);
473 if (ISEQ_BODY(iseq)->is_entries) {
475 for (
unsigned int ic_idx = 0; ic_idx < body->ic_size; ic_idx++) {
476 IC ic = &ISEQ_IS_IC_ENTRY(body, ic_idx);
491 compile_data = ISEQ_COMPILE_DATA(iseq);
497 cur = compile_data->node.storage_head;
508rb_iseq_constant_body_alloc(
void)
519 ISEQ_BODY(iseq) = rb_iseq_constant_body_alloc();
524rb_iseq_pathobj_new(
VALUE path,
VALUE realpath)
530 if (path == realpath ||
532 pathobj = rb_fstring(path);
535 if (!
NIL_P(realpath)) realpath = rb_fstring(realpath);
536 pathobj = rb_ary_new_from_args(2, rb_fstring(path), realpath);
537 rb_ary_freeze(pathobj);
546 rb_iseq_pathobj_new(path, realpath));
551rb_iseq_alloc_with_dummy_path(
VALUE fname)
555 ISEQ_BODY(dummy_iseq)->type = ISEQ_TYPE_TOP;
556 RB_OBJ_WRITE(dummy_iseq, &ISEQ_BODY(dummy_iseq)->location.pathobj, fname);
557 RB_OBJ_WRITE(dummy_iseq, &ISEQ_BODY(dummy_iseq)->location.label, fname);
567 rb_iseq_pathobj_set(iseq, path, realpath);
570 loc->first_lineno = first_lineno;
572 if (ISEQ_BODY(iseq)->local_iseq == iseq && strcmp(RSTRING_PTR(name),
"initialize") == 0) {
573 ISEQ_BODY(iseq)->param.flags.use_block = 1;
577 loc->node_id = node_id;
578 loc->code_location = *code_location;
581 loc->code_location.beg_pos.lineno = 0;
582 loc->code_location.beg_pos.column = 0;
583 loc->code_location.end_pos.lineno = -1;
584 loc->code_location.end_pos.column = -1;
597 if (
type == ISEQ_TYPE_TOP) {
598 body->local_iseq = iseq;
600 else if (
type == ISEQ_TYPE_METHOD ||
type == ISEQ_TYPE_CLASS) {
601 body->local_iseq = iseq;
604 body->local_iseq = ISEQ_BODY(piseq)->local_iseq;
608 body->parent_iseq = piseq;
611 if (
type == ISEQ_TYPE_MAIN) {
612 body->local_iseq = iseq;
621 ALLOC_N(
char, INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE +
626 new_arena->size = INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE;
634 const rb_iseq_t *parent,
int isolated_depth,
enum rb_iseq_type
type,
641 if (parent && (
type == ISEQ_TYPE_MAIN ||
type == ISEQ_TYPE_TOP))
645 set_relation(iseq, parent);
647 name = rb_fstring(name);
648 iseq_location_setup(iseq, name, path, realpath, first_lineno, code_location, node_id);
649 if (iseq != body->local_iseq) {
650 RB_OBJ_WRITE(iseq, &body->location.base_label, ISEQ_BODY(body->local_iseq)->location.label);
652 ISEQ_COVERAGE_SET(iseq,
Qnil);
653 ISEQ_ORIGINAL_ISEQ_CLEAR(iseq);
654 body->variable.flip_count = 0;
656 if (
NIL_P(script_lines)) {
663 ISEQ_COMPILE_DATA_ALLOC(iseq);
664 RB_OBJ_WRITE(iseq, &ISEQ_COMPILE_DATA(iseq)->err_info, err_info);
667 ISEQ_COMPILE_DATA(iseq)->node.storage_head = ISEQ_COMPILE_DATA(iseq)->node.storage_current = new_arena();
668 ISEQ_COMPILE_DATA(iseq)->insn.storage_head = ISEQ_COMPILE_DATA(iseq)->insn.storage_current = new_arena();
669 ISEQ_COMPILE_DATA(iseq)->isolated_depth = isolated_depth;
670 ISEQ_COMPILE_DATA(iseq)->option = option;
671 ISEQ_COMPILE_DATA(iseq)->ivar_cache_table = NULL;
672 ISEQ_COMPILE_DATA(iseq)->builtin_function_table = GET_VM()->builtin_function_table;
674 if (option->coverage_enabled) {
675 VALUE coverages = rb_get_coverages();
676 if (
RTEST(coverages)) {
677 coverage = rb_hash_lookup(coverages, rb_iseq_path(iseq));
681 ISEQ_COVERAGE_SET(iseq, coverage);
682 if (coverage && ISEQ_BRANCH_COVERAGE(iseq))
683 ISEQ_PC2BRANCHINDEX_SET(iseq, rb_ary_hidden_new(0));
688#if VM_CHECK_MODE > 0 && VM_INSN_INFO_TABLE_IMPL > 0
689static void validate_get_insn_info(
const rb_iseq_t *iseq);
693rb_iseq_insns_info_encode_positions(
const rb_iseq_t *iseq)
695#if VM_INSN_INFO_TABLE_IMPL == 2
698 int size = body->insns_info.size;
699 int max_pos = body->iseq_size;
700 int *data = (
int *)body->insns_info.positions;
701 if (body->insns_info.succ_index_table) ruby_xfree(body->insns_info.succ_index_table);
702 body->insns_info.succ_index_table = succ_index_table_create(max_pos, data, size);
703#if VM_CHECK_MODE == 0
704 ruby_xfree(body->insns_info.positions);
705 body->insns_info.positions = NULL;
710#if VM_INSN_INFO_TABLE_IMPL == 2
714 int size = body->insns_info.size;
715 int max_pos = body->iseq_size;
716 struct succ_index_table *sd = body->insns_info.succ_index_table;
717 return succ_index_table_invert(max_pos, sd, size);
724 iseq->aux.exec.global_trace_events = 0;
725 if (ruby_vm_event_enabled_global_flags & ISEQ_TRACE_EVENTS) {
726 rb_iseq_trace_set(iseq, ruby_vm_event_enabled_global_flags & ISEQ_TRACE_EVENTS);
735 VALUE err = data->err_info;
736 ISEQ_COMPILE_DATA_CLEAR(iseq);
737 compile_data_free(data);
739#if VM_CHECK_MODE > 0 && VM_INSN_INFO_TABLE_IMPL > 0
740 validate_get_insn_info(iseq);
744 VALUE path = pathobj_path(body->location.pathobj);
746 rb_funcallv(err, rb_intern(
"set_backtrace"), 1, &path);
750 RB_DEBUG_COUNTER_INC(iseq_num);
751 RB_DEBUG_COUNTER_ADD(iseq_cd_num, ISEQ_BODY(iseq)->ci_size);
753 rb_iseq_init_trace(iseq);
758 .inline_const_cache = OPT_INLINE_CONST_CACHE,
759 .peephole_optimization = OPT_PEEPHOLE_OPTIMIZATION,
760 .tailcall_optimization = OPT_TAILCALL_OPTIMIZATION,
761 .specialized_instruction = OPT_SPECIALISED_INSTRUCTION,
762 .operands_unification = OPT_OPERANDS_UNIFICATION,
763 .instructions_unification = OPT_INSTRUCTIONS_UNIFICATION,
764 .frozen_string_literal = OPT_FROZEN_STRING_LITERAL,
765 .debug_frozen_string_literal = OPT_DEBUG_FROZEN_STRING_LITERAL,
766 .coverage_enabled = TRUE,
770 .frozen_string_literal = -1,
774rb_iseq_opt_frozen_string_literal(
void)
776 return COMPILE_OPTION_DEFAULT.frozen_string_literal;
782#define SET_COMPILE_OPTION(o, h, mem) \
783 { VALUE flag = rb_hash_aref((h), ID2SYM(rb_intern(#mem))); \
784 if (flag == Qtrue) { (o)->mem = 1; } \
785 else if (flag == Qfalse) { (o)->mem = 0; } \
787#define SET_COMPILE_OPTION_NUM(o, h, mem) \
788 { VALUE num = rb_hash_aref((h), ID2SYM(rb_intern(#mem))); \
789 if (!NIL_P(num)) (o)->mem = NUM2INT(num); \
791 SET_COMPILE_OPTION(option, opt, inline_const_cache);
792 SET_COMPILE_OPTION(option, opt, peephole_optimization);
793 SET_COMPILE_OPTION(option, opt, tailcall_optimization);
794 SET_COMPILE_OPTION(option, opt, specialized_instruction);
795 SET_COMPILE_OPTION(option, opt, operands_unification);
796 SET_COMPILE_OPTION(option, opt, instructions_unification);
797 SET_COMPILE_OPTION(option, opt, frozen_string_literal);
798 SET_COMPILE_OPTION(option, opt, debug_frozen_string_literal);
799 SET_COMPILE_OPTION(option, opt, coverage_enabled);
800 SET_COMPILE_OPTION_NUM(option, opt, debug_level);
801#undef SET_COMPILE_OPTION
802#undef SET_COMPILE_OPTION_NUM
808#define SET_COMPILE_OPTION(o, a, mem) \
809 ((a)->mem < 0 ? 0 : ((o)->mem = (a)->mem > 0))
810 SET_COMPILE_OPTION(option, ast, coverage_enabled);
811#undef SET_COMPILE_OPTION
812 if (ast->frozen_string_literal >= 0) {
813 option->frozen_string_literal = ast->frozen_string_literal;
822 *option = COMPILE_OPTION_DEFAULT;
825 *option = COMPILE_OPTION_FALSE;
827 else if (opt ==
Qtrue) {
830 ((
int *)option)[i] = 1;
833 *option = COMPILE_OPTION_DEFAULT;
834 set_compile_option_from_hash(option, opt);
837 rb_raise(
rb_eTypeError,
"Compile option must be Hash/true/false/nil");
844 VALUE opt = rb_hash_new_with_size(11);
845#define SET_COMPILE_OPTION(o, h, mem) \
846 rb_hash_aset((h), ID2SYM(rb_intern(#mem)), RBOOL((o)->mem))
847#define SET_COMPILE_OPTION_NUM(o, h, mem) \
848 rb_hash_aset((h), ID2SYM(rb_intern(#mem)), INT2NUM((o)->mem))
850 SET_COMPILE_OPTION(option, opt, inline_const_cache);
851 SET_COMPILE_OPTION(option, opt, peephole_optimization);
852 SET_COMPILE_OPTION(option, opt, tailcall_optimization);
853 SET_COMPILE_OPTION(option, opt, specialized_instruction);
854 SET_COMPILE_OPTION(option, opt, operands_unification);
855 SET_COMPILE_OPTION(option, opt, instructions_unification);
856 SET_COMPILE_OPTION(option, opt, debug_frozen_string_literal);
857 SET_COMPILE_OPTION(option, opt, coverage_enabled);
858 SET_COMPILE_OPTION_NUM(option, opt, debug_level);
860#undef SET_COMPILE_OPTION
861#undef SET_COMPILE_OPTION_NUM
862 VALUE frozen_string_literal = option->frozen_string_literal == -1 ?
Qnil : RBOOL(option->frozen_string_literal);
863 rb_hash_aset(opt,
ID2SYM(rb_intern(
"frozen_string_literal")), frozen_string_literal);
871 return rb_iseq_new_with_opt(ast_value, name, path, realpath, 0, parent,
872 0,
type, &COMPILE_OPTION_DEFAULT,
877ast_line_count(
const VALUE ast_value)
879 rb_ast_t *ast = rb_ruby_ast_data_get(ast_value);
880 return ast->body.line_count;
884iseq_setup_coverage(
VALUE coverages,
VALUE path,
int line_count)
886 if (line_count >= 0) {
887 int len = (rb_get_coverage_mode() & COVERAGE_TARGET_ONESHOT_LINES) ? 0 : line_count;
889 VALUE coverage = rb_default_coverage(
len);
890 rb_hash_aset(coverages, path, coverage);
899iseq_new_setup_coverage(
VALUE path,
int line_count)
901 VALUE coverages = rb_get_coverages();
903 if (
RTEST(coverages)) {
904 iseq_setup_coverage(coverages, path, line_count);
911 iseq_new_setup_coverage(path, ast_line_count(ast_value));
913 return rb_iseq_new_with_opt(ast_value, name, path, realpath, 0, parent, 0,
914 ISEQ_TYPE_TOP, &COMPILE_OPTION_DEFAULT,
926 return pm_iseq_new_with_opt(node, name, path, realpath, 0, parent, 0,
927 ISEQ_TYPE_TOP, &COMPILE_OPTION_DEFAULT, error_state);
933 iseq_new_setup_coverage(path, ast_line_count(ast_value));
935 return rb_iseq_new_with_opt(ast_value, rb_fstring_lit(
"<main>"),
937 parent, 0, ISEQ_TYPE_MAIN, opt ? &COMPILE_OPTION_DEFAULT : &COMPILE_OPTION_FALSE,
950 return pm_iseq_new_with_opt(node, rb_fstring_lit(
"<main>"),
952 parent, 0, ISEQ_TYPE_MAIN, opt ? &COMPILE_OPTION_DEFAULT : &COMPILE_OPTION_FALSE, error_state);
956rb_iseq_new_eval(
const VALUE ast_value,
VALUE name,
VALUE path,
VALUE realpath,
int first_lineno,
const rb_iseq_t *parent,
int isolated_depth)
958 if (rb_get_coverage_mode() & COVERAGE_TARGET_EVAL) {
959 VALUE coverages = rb_get_coverages();
960 if (
RTEST(coverages) &&
RTEST(path) && !
RTEST(rb_hash_has_key(coverages, path))) {
961 iseq_setup_coverage(coverages, path, ast_line_count(ast_value) + first_lineno - 1);
965 return rb_iseq_new_with_opt(ast_value, name, path, realpath, first_lineno,
966 parent, isolated_depth, ISEQ_TYPE_EVAL, &COMPILE_OPTION_DEFAULT,
972 int first_lineno,
const rb_iseq_t *parent,
int isolated_depth,
int *error_state)
974 if (rb_get_coverage_mode() & COVERAGE_TARGET_EVAL) {
975 VALUE coverages = rb_get_coverages();
976 if (
RTEST(coverages) &&
RTEST(path) && !
RTEST(rb_hash_has_key(coverages, path))) {
977 iseq_setup_coverage(coverages, path, ((
int) (node->parser->
newline_list.
size - 1)) + first_lineno - 1);
981 return pm_iseq_new_with_opt(node, name, path, realpath, first_lineno,
982 parent, isolated_depth, ISEQ_TYPE_EVAL, &COMPILE_OPTION_DEFAULT, error_state);
989 VALUE v1 = iseqw_new(iseq);
991 if (v1 != v2 &&
CLASS_OF(v2) == rb_cISeq) {
1001 int first_lineno,
const rb_iseq_t *parent,
int isolated_depth,
1005 rb_ast_t *ast = rb_ruby_ast_data_get(ast_value);
1007 const NODE *node = body ? body->root : 0;
1012 if (!option) option = &COMPILE_OPTION_DEFAULT;
1015 option = set_compile_option_from_ast(&new_opt, body);
1018 if (!
NIL_P(script_lines)) {
1021 else if (body && body->script_lines) {
1022 script_lines = rb_parser_build_script_lines_from(body->script_lines);
1025 script_lines = ISEQ_BODY(parent)->variable.script_lines;
1028 prepare_iseq_build(iseq, name, path, realpath, first_lineno, node ? &node->nd_loc : NULL, node ? nd_node_id(node) : -1,
1029 parent, isolated_depth,
type, script_lines, option);
1031 rb_iseq_compile_node(iseq, node);
1032 finish_iseq_build(iseq);
1035 return iseq_translate(iseq);
1044pm_iseq_new_with_opt_try(
VALUE d)
1049 pm_iseq_compile_node(data->iseq, data->node);
1052 finish_iseq_build(data->iseq);
1071 int first_lineno,
const rb_iseq_t *parent,
int isolated_depth,
1075 ISEQ_BODY(iseq)->prism =
true;
1078 if (!option) option = &COMPILE_OPTION_DEFAULT;
1080 next_option = *option;
1081 next_option.coverage_enabled = node->coverage_enabled < 0 ? 0 : node->coverage_enabled > 0;
1082 option = &next_option;
1085 int32_t start_line = node->parser->
start_line;
1091 .beg_pos = { .lineno = (int) start.
line, .column = (
int) start.
column },
1092 .end_pos = { .lineno = (int) end.
line, .column = (
int) end.
column }
1095 prepare_iseq_build(iseq, name, path, realpath, first_lineno, &code_location, node->ast_node->
node_id,
1096 parent, isolated_depth,
type, node->
script_lines == NULL ?
Qnil : *node->script_lines, option);
1102 rb_protect(pm_iseq_new_with_opt_try, (
VALUE)&data, error_state);
1104 if (*error_state)
return NULL;
1106 return iseq_translate(iseq);
1110rb_iseq_new_with_callback(
1113 int first_lineno,
const rb_iseq_t *parent,
1119 if (!option) option = &COMPILE_OPTION_DEFAULT;
1120 prepare_iseq_build(iseq, name, path, realpath, first_lineno, NULL, -1, parent, 0,
type,
Qnil, option);
1122 rb_iseq_compile_callback(iseq, ifunc);
1123 finish_iseq_build(iseq);
1129rb_iseq_load_iseq(
VALUE fname)
1134 return iseqw_check(iseqv);
1140#define CHECK_ARRAY(v) rb_to_array_type(v)
1141#define CHECK_HASH(v) rb_to_hash_type(v)
1142#define CHECK_STRING(v) rb_str_to_str(v)
1143#define CHECK_SYMBOL(v) rb_to_symbol_type(v)
1146static enum rb_iseq_type
1149 const ID id_top = rb_intern(
"top");
1150 const ID id_method = rb_intern(
"method");
1151 const ID id_block = rb_intern(
"block");
1152 const ID id_class = rb_intern(
"class");
1153 const ID id_rescue = rb_intern(
"rescue");
1154 const ID id_ensure = rb_intern(
"ensure");
1155 const ID id_eval = rb_intern(
"eval");
1156 const ID id_main = rb_intern(
"main");
1157 const ID id_plain = rb_intern(
"plain");
1161 if (
typeid == id_top)
return ISEQ_TYPE_TOP;
1162 if (
typeid == id_method)
return ISEQ_TYPE_METHOD;
1163 if (
typeid == id_block)
return ISEQ_TYPE_BLOCK;
1164 if (
typeid == id_class)
return ISEQ_TYPE_CLASS;
1165 if (
typeid == id_rescue)
return ISEQ_TYPE_RESCUE;
1166 if (
typeid == id_ensure)
return ISEQ_TYPE_ENSURE;
1167 if (
typeid == id_eval)
return ISEQ_TYPE_EVAL;
1168 if (
typeid == id_main)
return ISEQ_TYPE_MAIN;
1169 if (
typeid == id_plain)
return ISEQ_TYPE_PLAIN;
1170 return (
enum rb_iseq_type)-1;
1178 VALUE magic, version1, version2, format_type, misc;
1179 VALUE name, path, realpath, code_location, node_id;
1180 VALUE type, body, locals, params, exception;
1182 st_data_t iseq_type;
1192 data = CHECK_ARRAY(data);
1194 magic = CHECK_STRING(rb_ary_entry(data, i++));
1195 version1 = CHECK_INTEGER(rb_ary_entry(data, i++));
1196 version2 = CHECK_INTEGER(rb_ary_entry(data, i++));
1197 format_type = CHECK_INTEGER(rb_ary_entry(data, i++));
1198 misc = CHECK_HASH(rb_ary_entry(data, i++));
1199 ((void)magic, (
void)version1, (void)version2, (
void)format_type);
1201 name = CHECK_STRING(rb_ary_entry(data, i++));
1202 path = CHECK_STRING(rb_ary_entry(data, i++));
1203 realpath = rb_ary_entry(data, i++);
1204 realpath =
NIL_P(realpath) ?
Qnil : CHECK_STRING(realpath);
1205 int first_lineno =
RB_NUM2INT(rb_ary_entry(data, i++));
1207 type = CHECK_SYMBOL(rb_ary_entry(data, i++));
1208 locals = CHECK_ARRAY(rb_ary_entry(data, i++));
1209 params = CHECK_HASH(rb_ary_entry(data, i++));
1210 exception = CHECK_ARRAY(rb_ary_entry(data, i++));
1211 body = CHECK_ARRAY(rb_ary_entry(data, i++));
1213 ISEQ_BODY(iseq)->local_iseq = iseq;
1215 iseq_type = iseq_type_from_sym(
type);
1216 if (iseq_type == (
enum rb_iseq_type)-1) {
1220 node_id = rb_hash_aref(misc,
ID2SYM(rb_intern(
"node_id")));
1222 code_location = rb_hash_aref(misc,
ID2SYM(rb_intern(
"code_location")));
1224 tmp_loc.beg_pos.lineno =
NUM2INT(rb_ary_entry(code_location, 0));
1225 tmp_loc.beg_pos.column =
NUM2INT(rb_ary_entry(code_location, 1));
1226 tmp_loc.end_pos.lineno =
NUM2INT(rb_ary_entry(code_location, 2));
1227 tmp_loc.end_pos.column =
NUM2INT(rb_ary_entry(code_location, 3));
1230 if (
SYM2ID(rb_hash_aref(misc,
ID2SYM(rb_intern(
"parser")))) == rb_intern(
"prism")) {
1231 ISEQ_BODY(iseq)->prism =
true;
1234 make_compile_option(&option, opt);
1235 option.peephole_optimization = FALSE;
1236 prepare_iseq_build(iseq, name, path, realpath, first_lineno, &tmp_loc,
NUM2INT(node_id),
1237 parent, 0, (
enum rb_iseq_type)iseq_type,
Qnil, &option);
1239 rb_iseq_build_from_ary(iseq, misc, locals, params, exception, body);
1241 finish_iseq_build(iseq);
1243 return iseqw_new(iseq);
1250iseq_s_load(
int argc,
VALUE *argv,
VALUE self)
1254 return iseq_load(data, NULL, opt);
1260 return iseq_load(data,
RTEST(parent) ? (
rb_iseq_t *)parent : NULL, opt);
1268#if !defined(__GNUC__) || (__GNUC__ == 4 && __GNUC_MINOR__ == 8)
1269# define INITIALIZED volatile
1275 VALUE INITIALIZED ast_value;
1277 VALUE name = rb_fstring_lit(
"<compiled>");
1280 make_compile_option(&option, opt);
1284 parse = rb_parser_compile_file_path;
1287 parse = rb_parser_compile_string_path;
1291 const VALUE parser = rb_parser_new();
1292 const rb_iseq_t *outer_scope = rb_iseq_new(
Qnil, name, name,
Qnil, 0, ISEQ_TYPE_TOP);
1294 rb_parser_set_context(parser, outer_scope, FALSE);
1295 if (ruby_vm_keep_script_lines) rb_parser_set_script_lines(parser);
1297 ast_value = (*parse)(parser, file, src, ln);
1300 ast = rb_ruby_ast_data_get(ast_value);
1302 if (!ast || !ast->body.root) {
1303 rb_ast_dispose(ast);
1307 iseq = rb_iseq_new_with_opt(ast_value, name, file, realpath, ln,
1308 NULL, 0, ISEQ_TYPE_TOP, &option,
1310 rb_ast_dispose(ast);
1322 VALUE name = rb_fstring_lit(
"<compiled>");
1325 make_compile_option(&option, opt);
1331 pm_options_scopes_init(&result.
options, 1);
1332 result.
node.coverage_enabled = 1;
1334 switch (option.frozen_string_literal) {
1335 case ISEQ_FROZEN_STRING_LITERAL_UNSET:
1337 case ISEQ_FROZEN_STRING_LITERAL_DISABLED:
1338 pm_options_frozen_string_literal_set(&result.
options,
false);
1340 case ISEQ_FROZEN_STRING_LITERAL_ENABLED:
1341 pm_options_frozen_string_literal_set(&result.
options,
true);
1344 rb_bug(
"pm_iseq_compile_with_option: invalid frozen_string_literal=%d", option.frozen_string_literal);
1353 error = pm_load_parse_file(&result, filepath, ruby_vm_keep_script_lines ? &script_lines : NULL);
1358 error = pm_parse_string(&result, src, file, ruby_vm_keep_script_lines ? &script_lines : NULL);
1361 if (error ==
Qnil) {
1363 iseq = pm_iseq_new_with_opt(&result.
node, name, file, realpath, ln, NULL, 0, ISEQ_TYPE_TOP, &option, &error_state);
1365 pm_parse_result_free(&result);
1369 rb_jump_tag(error_state);
1373 pm_parse_result_free(&result);
1383 return pathobj_path(ISEQ_BODY(iseq)->location.pathobj);
1389 return pathobj_realpath(ISEQ_BODY(iseq)->location.pathobj);
1393rb_iseq_absolute_path(
const rb_iseq_t *iseq)
1395 return rb_iseq_realpath(iseq);
1399rb_iseq_from_eval_p(
const rb_iseq_t *iseq)
1401 return NIL_P(rb_iseq_realpath(iseq));
1407 return ISEQ_BODY(iseq)->location.label;
1411rb_iseq_base_label(
const rb_iseq_t *iseq)
1413 return ISEQ_BODY(iseq)->location.base_label;
1417rb_iseq_first_lineno(
const rb_iseq_t *iseq)
1419 return RB_INT2NUM(ISEQ_BODY(iseq)->location.first_lineno);
1423rb_iseq_method_name(
const rb_iseq_t *iseq)
1427 if (body->type == ISEQ_TYPE_METHOD) {
1428 return body->location.base_label;
1436rb_iseq_code_location(
const rb_iseq_t *iseq,
int *beg_pos_lineno,
int *beg_pos_column,
int *end_pos_lineno,
int *end_pos_column)
1439 if (beg_pos_lineno) *beg_pos_lineno = loc->beg_pos.lineno;
1440 if (beg_pos_column) *beg_pos_column = loc->beg_pos.column;
1441 if (end_pos_lineno) *end_pos_lineno = loc->end_pos.lineno;
1442 if (end_pos_column) *end_pos_column = loc->end_pos.column;
1445static ID iseq_type_id(
enum rb_iseq_type
type);
1450 return ID2SYM(iseq_type_id(ISEQ_BODY(iseq)->
type));
1456 return ISEQ_COVERAGE(iseq);
1460remove_coverage_i(
void *vstart,
void *vend,
size_t stride,
void *data)
1463 for (; v != (
VALUE)vend; v += stride) {
1464 void *ptr = rb_asan_poisoned_object_p(v);
1465 rb_asan_unpoison_object(v,
false);
1467 if (rb_obj_is_iseq(v)) {
1469 ISEQ_COVERAGE_SET(iseq,
Qnil);
1472 asan_poison_object_if(ptr, v);
1478rb_iseq_remove_coverage_all(
void)
1480 rb_objspace_each_objects(remove_coverage_i, NULL);
1486iseqw_mark(
void *ptr)
1488 rb_gc_mark_movable(*(
VALUE *)ptr);
1492iseqw_memsize(
const void *ptr)
1494 return rb_iseq_memsize(*(
const rb_iseq_t **)ptr);
1498iseqw_ref_update(
void *ptr)
1501 *vptr = rb_gc_location(*vptr);
1512 0, 0, RUBY_TYPED_FREE_IMMEDIATELY|RUBY_TYPED_WB_PROTECTED
1518 if (iseq->wrapper) {
1520 rb_raise(
rb_eTypeError,
"wrong iseq wrapper: %" PRIsVALUE
" for %p",
1521 iseq->wrapper, (
void *)iseq);
1523 return iseq->wrapper;
1541 return iseqw_new(iseq);
1550iseqw_s_compile_parser(
int argc,
VALUE *argv,
VALUE self,
bool prism)
1556 if (i > 4+
NIL_P(opt)) rb_error_arity(argc, 1, 5);
1558 case 5: opt = argv[--i];
1559 case 4: line = argv[--i];
1560 case 3: path = argv[--i];
1561 case 2: file = argv[--i];
1564 if (
NIL_P(file)) file = rb_fstring_lit(
"<compiled>");
1565 if (
NIL_P(path)) path = file;
1573 iseq = pm_iseq_compile_with_option(src, file, path, line, opt);
1576 iseq = rb_iseq_compile_with_option(src, file, path, line, opt);
1579 return iseqw_new(iseq);
1620iseqw_s_compile(
int argc,
VALUE *argv,
VALUE self)
1622 return iseqw_s_compile_parser(argc, argv, self, rb_ruby_prism_p());
1662iseqw_s_compile_parsey(
int argc,
VALUE *argv,
VALUE self)
1664 return iseqw_s_compile_parser(argc, argv, self,
false);
1704iseqw_s_compile_prism(
int argc,
VALUE *argv,
VALUE self)
1706 return iseqw_s_compile_parser(argc, argv, self,
true);
1730iseqw_s_compile_file(
int argc,
VALUE *argv,
VALUE self)
1739 i =
rb_scan_args(argc, argv,
"1*:", &file, NULL, &opt);
1740 if (i > 1+
NIL_P(opt)) rb_error_arity(argc, 1, 2);
1742 case 2: opt = argv[--i];
1745 file = rb_fstring(file);
1750 VALUE v = rb_vm_push_frame_fname(ec, file);
1752 parser = rb_parser_new();
1753 rb_parser_set_context(parser, NULL, FALSE);
1754 ast_value = rb_parser_load_file(parser, file);
1755 ast = rb_ruby_ast_data_get(ast_value);
1756 if (!ast->body.root) exc = GET_EC()->errinfo;
1759 if (!ast->body.root) {
1760 rb_ast_dispose(ast);
1764 make_compile_option(&option, opt);
1766 ret = iseqw_new(rb_iseq_new_with_opt(ast_value, rb_fstring_lit(
"<main>"),
1768 rb_realpath_internal(
Qnil, file, 1),
1769 1, NULL, 0, ISEQ_TYPE_TOP, &option,
1771 rb_ast_dispose(ast);
1774 rb_vm_pop_frame(ec);
1801iseqw_s_compile_file_prism(
int argc,
VALUE *argv,
VALUE self)
1807 i =
rb_scan_args(argc, argv,
"1*:", &file, NULL, &opt);
1808 if (i > 1+
NIL_P(opt)) rb_error_arity(argc, 1, 2);
1810 case 2: opt = argv[--i];
1813 file = rb_fstring(file);
1816 VALUE v = rb_vm_push_frame_fname(ec, file);
1820 result.
node.coverage_enabled = 1;
1823 VALUE error = pm_load_parse_file(&result, file, ruby_vm_keep_script_lines ? &script_lines : NULL);
1825 if (error ==
Qnil) {
1826 make_compile_option(&option, opt);
1829 rb_iseq_t *iseq = pm_iseq_new_with_opt(&result.
node, rb_fstring_lit(
"<main>"),
1831 rb_realpath_internal(
Qnil, file, 1),
1832 1, NULL, 0, ISEQ_TYPE_TOP, &option, &error_state);
1834 pm_parse_result_free(&result);
1838 rb_jump_tag(error_state);
1841 ret = iseqw_new(iseq);
1842 rb_vm_pop_frame(ec);
1847 pm_parse_result_free(&result);
1848 rb_vm_pop_frame(ec);
1885iseqw_s_compile_option_set(
VALUE self,
VALUE opt)
1888 make_compile_option(&option, opt);
1889 COMPILE_OPTION_DEFAULT = option;
1902iseqw_s_compile_option_get(
VALUE self)
1904 return make_compile_option_value(&COMPILE_OPTION_DEFAULT);
1908iseqw_check(
VALUE iseqw)
1914 if (!ISEQ_BODY(iseq)) {
1915 rb_ibf_load_iseq_complete(iseq);
1918 if (!ISEQ_BODY(iseq)->location.label) {
1919 rb_raise(
rb_eTypeError,
"uninitialized InstructionSequence");
1925rb_iseqw_to_iseq(
VALUE iseqw)
1927 return iseqw_check(iseqw);
1939iseqw_eval(
VALUE self)
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");
1945 return rb_iseq_eval(iseq);
1953iseqw_inspect(
VALUE self)
1955 const rb_iseq_t *iseq = iseqw_check(self);
1959 if (!body->location.label) {
1960 return rb_sprintf(
"#<%"PRIsVALUE
": uninitialized>", klass);
1963 return rb_sprintf(
"<%"PRIsVALUE
":%"PRIsVALUE
"@%"PRIsVALUE
":%d>",
1965 body->location.label, rb_iseq_path(iseq),
1966 FIX2INT(rb_iseq_first_lineno(iseq)));
1994iseqw_path(
VALUE self)
1996 return rb_iseq_path(iseqw_check(self));
2016iseqw_absolute_path(
VALUE self)
2018 return rb_iseq_realpath(iseqw_check(self));
2045iseqw_label(
VALUE self)
2047 return rb_iseq_label(iseqw_check(self));
2071iseqw_base_label(
VALUE self)
2073 return rb_iseq_base_label(iseqw_check(self));
2087iseqw_first_lineno(
VALUE self)
2089 return rb_iseq_first_lineno(iseqw_check(self));
2176iseqw_to_a(
VALUE self)
2178 const rb_iseq_t *iseq = iseqw_check(self);
2179 return iseq_data_to_ary(iseq);
2182#if VM_INSN_INFO_TABLE_IMPL == 1
2184get_insn_info_binary_search(
const rb_iseq_t *iseq,
size_t pos)
2187 size_t size = body->insns_info.size;
2189 const unsigned int *positions = body->insns_info.positions;
2190 const int debug = 0;
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);
2201 else if (size == 1) {
2202 return &insns_info[0];
2205 size_t l = 1, r = size - 1;
2207 size_t m = l + (r - l) / 2;
2208 if (positions[m] == pos) {
2209 return &insns_info[m];
2211 if (positions[m] < pos) {
2219 return &insns_info[size-1];
2221 if (positions[l] > pos) {
2222 return &insns_info[l-1];
2224 return &insns_info[l];
2229get_insn_info(
const rb_iseq_t *iseq,
size_t pos)
2231 return get_insn_info_binary_search(iseq, pos);
2235#if VM_INSN_INFO_TABLE_IMPL == 2
2237get_insn_info_succinct_bitvector(
const rb_iseq_t *iseq,
size_t pos)
2240 size_t size = body->insns_info.size;
2242 const int debug = 0;
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);
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);
2260 else if (size == 1) {
2261 return &insns_info[0];
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];
2272get_insn_info(
const rb_iseq_t *iseq,
size_t pos)
2274 return get_insn_info_succinct_bitvector(iseq, pos);
2278#if VM_CHECK_MODE > 0 || VM_INSN_INFO_TABLE_IMPL == 0
2280get_insn_info_linear_search(
const rb_iseq_t *iseq,
size_t pos)
2283 size_t i = 0, size = body->insns_info.size;
2285 const unsigned int *positions = body->insns_info.positions;
2286 const int debug = 0;
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);
2297 else if (size == 1) {
2298 return &insns_info[0];
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);
2305 if (positions[i] == pos) {
2306 return &insns_info[i];
2308 if (positions[i] > pos) {
2309 return &insns_info[i-1];
2313 return &insns_info[i-1];
2317#if VM_INSN_INFO_TABLE_IMPL == 0
2319get_insn_info(
const rb_iseq_t *iseq,
size_t pos)
2321 return get_insn_info_linear_search(iseq, pos);
2325#if VM_CHECK_MODE > 0 && VM_INSN_INFO_TABLE_IMPL > 0
2327validate_get_insn_info(
const rb_iseq_t *iseq)
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);
2340rb_iseq_line_no(
const rb_iseq_t *iseq,
size_t pos)
2345 return entry->line_no;
2352#ifdef USE_ISEQ_NODE_ID
2354rb_iseq_node_id(
const rb_iseq_t *iseq,
size_t pos)
2359 return entry->node_id;
2368rb_iseq_event_flags(
const rb_iseq_t *iseq,
size_t pos)
2372 return entry->events;
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);
2400 for (i = 0; i < level; i++) {
2401 diseq = ISEQ_BODY(diseq)->parent_iseq;
2403 idx = ISEQ_BODY(diseq)->local_table_size - (int)op - 1;
2404 lid = ISEQ_BODY(diseq)->local_table[idx];
2405 name = rb_id2str(lid);
2415 rb_str_catf(name,
"@%d", idx);
2419int rb_insn_unified_local_var_level(
VALUE);
2423rb_insn_operand_intern(
const rb_iseq_t *iseq,
2427 const char *types = insn_op_types(insn);
2428 char type = types[op_no];
2433 ret = rb_sprintf(
"%"PRIdVALUE, (
VALUE)(pos +
len + op));
2437 if (insn == BIN(defined) && op_no == 0) {
2438 enum defined_type deftype = (
enum defined_type)op;
2441 ret = rb_fstring_lit(
"func");
2444 ret = rb_fstring_lit(
"ref");
2446 case DEFINED_CONST_FROM:
2447 ret = rb_fstring_lit(
"constant-from");
2450 ret = rb_iseq_defined_string(deftype);
2455 else if (insn == BIN(checktype) && op_no == 0) {
2461 ret = rb_sprintf(
"%"PRIuVALUE, op);
2466 if (types[op_no+1] == TS_NUM && pnop) {
2467 ret = local_var_name(iseq, *pnop, op - VM_ENV_DATA_SIZE);
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);
2482 op = obj_resurrect(op);
2483 if (insn == BIN(defined) && op_no == 1 &&
FIXNUM_P(op)) {
2488 ret = rb_sprintf(
":$%c", (
type >> 1));
2491 ret = rb_sprintf(
":$%d", (
type >> 1));
2496 ret = rb_dump_literal(op);
2499 rb_ary_push(child, op);
2508 ret = ISEQ_BODY(iseq)->location.label;
2510 rb_ary_push(child, (
VALUE)iseq);
2522 const ID *segments = ((
IC)op)->segments;
2525 rb_str_catf(ret,
"::%s", rb_id2name(*segments++));
2540 VALUE ary = rb_ary_new();
2541 ID mid = vm_ci_mid(ci);
2544 rb_ary_push(ary, rb_sprintf(
"mid:%"PRIsVALUE, rb_id2str(mid)));
2547 rb_ary_push(ary, rb_sprintf(
"argc:%d", vm_ci_argc(ci)));
2549 if (vm_ci_flag(ci) & VM_CALL_KWARG) {
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(
","))));
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);
2563 CALL_FLAG(ARGS_SIMPLE);
2564 CALL_FLAG(TAILCALL);
2568 CALL_FLAG(KW_SPLAT);
2569 CALL_FLAG(KW_SPLAT_MUT);
2570 CALL_FLAG(FORWARDING);
2571 CALL_FLAG(OPT_SEND);
2572 rb_ary_push(ary, rb_ary_join(flags,
rb_str_new2(
"|")));
2575 ret = rb_sprintf(
"<calldata!%"PRIsVALUE
">", rb_ary_join(ary,
rb_str_new2(
", ")));
2587 if (dladdr((
void *)op, &info) && info.dli_sname) {
2599 ret = rb_sprintf(
"<builtin!%s/%d>",
2600 bf->name, bf->argc);
2605 rb_bug(
"unknown operand type: %c",
type);
2611right_strip(
VALUE str)
2613 const char *beg = RSTRING_PTR(str), *end =
RSTRING_END(str);
2614 while (end-- > beg && *end ==
' ');
2624rb_iseq_disasm_insn(
VALUE ret,
const VALUE *code,
size_t pos,
2627 VALUE insn = code[pos];
2628 int len = insn_len(insn);
2630 const char *types = insn_op_types(insn);
2632 const char *insn_name_buff;
2634 insn_name_buff = insn_name(insn);
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);
2640 rb_str_catf(str,
"%04"PRIuSIZE
" %-28.*s ", pos,
2641 (
int)strcspn(insn_name_buff,
"_"), insn_name_buff);
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],
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);
2668 str = rb_str_catf(str,
"[%s%s%s%s%s%s%s%s%s%s%s%s]",
2679 events & RUBY_EVENT_COVERAGE_LINE ?
"Cli" :
"",
2680 events & RUBY_EVENT_COVERAGE_BRANCH ?
"Cbr" :
"");
2690 printf(
"%.*s\n", (
int)RSTRING_LEN(str), RSTRING_PTR(str));
2699 case CATCH_TYPE_RESCUE:
2701 case CATCH_TYPE_ENSURE:
2703 case CATCH_TYPE_RETRY:
2705 case CATCH_TYPE_BREAK:
2707 case CATCH_TYPE_REDO:
2709 case CATCH_TYPE_NEXT:
2712 rb_bug(
"unknown catch type: %d",
type);
2721 if (!body->location.label) {
2722 return rb_sprintf(
"#<ISeq: uninitialized>");
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);
2738 {(void (*)(
void *))rb_mark_set, (void (*)(
void *))st_free_table, 0, 0,},
2739 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
2748 VALUE child = rb_ary_hidden_new(3);
2753 enum {header_minlen = 72};
2756 const char *indent_str;
2759 size = body->iseq_size;
2761 indent_len = RSTRING_LEN(indent);
2762 indent_str = RSTRING_PTR(indent);
2768 if ((l = RSTRING_LEN(str) - indent_len) < header_minlen) {
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); \
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);
2785 if (body->catch_table) {
2789 if (body->catch_table) {
2791 indent_str = RSTRING_PTR(indent);
2792 for (i = 0; i < body->catch_table->size; i++) {
2794 UNALIGNED_MEMBER_PTR(body->catch_table, entries[i]);
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));
2803 done_iseq = st_init_numtable();
2806 st_insert(done_iseq, (st_data_t)entry->iseq, (st_data_t)0);
2807 indent_str = RSTRING_PTR(indent);
2810 rb_str_resize(indent, indent_len);
2811 indent_str = RSTRING_PTR(indent);
2813 if (body->catch_table) {
2815 rb_str_cat2(str,
"|-------------------------------------"
2816 "-----------------------------------\n");
2820 if (body->local_table) {
2821 const struct rb_iseq_param_keyword *
const keyword = body->
param.keyword;
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);
2836 for (i = body->local_table_size; i > 0;) {
2837 int li = body->local_table_size - --i - 1;
2839 VALUE name = local_var_name(iseq, 0, i);
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]);
2853 snprintf(argi,
sizeof(argi),
"%s%s%s%s%s%s",
2854 (body->
param.lead_num > li) ? (body->
param.flags.ambiguous_param0 ?
"AmbiguousArg" :
"Arg") :
"",
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" :
"");
2862 rb_str_catf(str,
"[%2d] ", i + 1);
2863 width = RSTRING_LEN(str) + 11;
2865 if (*argi) rb_str_catf(str,
"<%s>", argi);
2866 if ((width -= RSTRING_LEN(str)) > 0) rb_str_catf(str,
"%*s", (
int)width,
"");
2872 code = rb_iseq_original_iseq(iseq);
2873 for (n = 0; n < size;) {
2875 n += rb_iseq_disasm_insn(str, code, n, iseq, child);
2879 VALUE isv = rb_ary_entry(child, l);
2880 if (done_iseq && st_is_member(done_iseq, (st_data_t)isv))
continue;
2883 indent_str = RSTRING_PTR(indent);
2894 rb_str_resize(str, RSTRING_LEN(str));
2904rb_estimate_iv_count(
VALUE klass,
const rb_iseq_t * initialize_iseq)
2906 struct rb_id_table * iv_names = rb_id_table_create(0);
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];
2911 if (cache->iv_set_name) {
2912 rb_id_table_insert(iv_names, cache->iv_set_name,
Qtrue);
2916 attr_index_t count = (attr_index_t)rb_id_table_size(iv_names);
2919 count += RCLASS_EXT(superclass)->max_iv_count;
2921 rb_id_table_free(iv_names);
2945iseqw_disasm(
VALUE self)
2947 return rb_iseq_disasm(iseqw_check(self));
2951iseq_iterate_children(
const rb_iseq_t *iseq,
void (*iter_func)(
const rb_iseq_t *child_iseq,
void *data),
void *data)
2954 VALUE *code = rb_iseq_original_iseq(iseq);
2959 if (body->catch_table) {
2960 for (i = 0; i < body->catch_table->size; i++) {
2962 UNALIGNED_MEMBER_PTR(body->catch_table, entries[i]);
2963 child = entry->iseq;
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);
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);
2979 for (j=0; types[j]; j++) {
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);
3001yield_each_children(
const rb_iseq_t *child_iseq,
void *data)
3015iseqw_each_child(
VALUE self)
3017 const rb_iseq_t *iseq = iseqw_check(self);
3018 iseq_iterate_children(iseq, yield_each_children, NULL);
3025#define C(ev, cstr, l) if (events & ev) rb_ary_push(ary, rb_ary_new_from_args(2, l, ID2SYM(rb_intern(cstr))));
3045iseqw_trace_points(
VALUE self)
3047 const rb_iseq_t *iseq = iseqw_check(self);
3050 VALUE ary = rb_ary_new();
3052 for (i=0; i<body->insns_info.size; i++) {
3054 if (entry->events) {
3055 push_event_info(iseq, entry->events, entry->line_no, ary);
3101 if (rb_frame_info_p(body)) {
3102 iseq = rb_get_iseq_from_frame_info(body);
3105 iseq = vm_proc_iseq(body);
3107 if (!rb_obj_is_iseq((
VALUE)iseq)) {
3112 iseq = rb_method_iseq(body);
3114 else if (rb_typeddata_is_instance_of(body, &iseqw_data_type)) {
3118 return iseq ? iseqw_new(iseq) :
Qnil;
3176 VALUE iseqw = iseqw_s_of(klass, body);
3177 return NIL_P(iseqw) ?
Qnil : rb_iseq_disasm(iseqw_check(iseqw));
3181register_label(
struct st_table *table,
unsigned long idx)
3184 st_insert(table, idx, sym);
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;
3200 rb_bug(
"unknown exception type: %d", (
int)
type);
3208 rb_ary_push(ary, obj_resurrect(key));
3209 rb_ary_push(ary, value);
3215 {(void (*)(
void *))rb_mark_tbl, (void (*)(
void *))st_free_table, 0, 0,},
3216 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3219#define DECL_ID(name) \
3222#define INIT_ID(name) \
3223 id_##name = rb_intern(#name)
3226iseq_type_id(
enum rb_iseq_type
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;
3262 rb_bug(
"unsupported iseq type: %d", (
int)
type);
3274 VALUE *seq, *iseq_original;
3276 VALUE val = rb_ary_new();
3278 VALUE locals = rb_ary_new();
3279 VALUE params = rb_hash_new();
3280 VALUE body = rb_ary_new();
3282 VALUE exception = rb_ary_new();
3283 VALUE misc = rb_hash_new();
3285 static ID insn_syms[VM_INSTRUCTION_SIZE/2];
3286 struct st_table *labels_table = st_init_numtable();
3289 if (insn_syms[0] == 0) {
3291 for (i=0; i<numberof(insn_syms); i++) {
3292 insn_syms[i] = rb_intern(insn_name(i));
3297 type = iseq_type_id(iseq_body->type);
3300 for (i=0; i<iseq_body->local_table_size; i++) {
3301 ID lid = iseq_body->local_table[i];
3303 if (rb_id2str(lid)) {
3304 rb_ary_push(locals,
ID2SYM(lid));
3307 rb_ary_push(locals,
ULONG2NUM(iseq_body->local_table_size-i+1));
3311 rb_ary_push(locals,
ID2SYM(rb_intern(
"#arg_rest")));
3317 const struct rb_iseq_param_keyword *
const keyword = iseq_body->
param.keyword;
3320 if (iseq_body->
param.flags.has_opt) {
3321 int len = iseq_body->
param.opt_num + 1;
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);
3328 rb_hash_aset(params,
ID2SYM(rb_intern(
"opt")), arg_opt_labels);
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();
3340 for (i=0; i<keyword->required_num; i++) {
3341 rb_ary_push(keywords,
ID2SYM(keyword->table[i]));
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]);
3348 rb_ary_push(keywords, key);
3351 rb_hash_aset(params,
ID2SYM(rb_intern(
"kwbits")),
3352 INT2FIX(keyword->bits_start));
3353 rb_hash_aset(params,
ID2SYM(rb_intern(
"keyword")), keywords);
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);
3361 iseq_original = rb_iseq_original_iseq((
rb_iseq_t *)iseq);
3363 for (seq = iseq_original; seq < iseq_original + iseq_body->iseq_size; ) {
3364 VALUE insn = *seq++;
3365 int j,
len = insn_len(insn);
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);
3375 unsigned long idx = nseq - iseq_original + *seq;
3376 rb_ary_push(ary, register_label(labels_table, idx));
3381 rb_ary_push(ary,
INT2FIX(*seq));
3384 rb_ary_push(ary, obj_resurrect(*seq));
3390 VALUE val = iseq_data_to_ary(rb_iseq_check(iseq));
3391 rb_ary_push(ary, val);
3394 rb_ary_push(ary,
Qnil);
3400 VALUE list = rb_ary_new();
3401 const ID *ids = ((
IC)*seq)->segments;
3403 rb_ary_push(list,
ID2SYM(*ids++));
3405 rb_ary_push(ary, list);
3413 rb_ary_push(ary,
INT2FIX(is - ISEQ_IS_ENTRY_START(ISEQ_BODY(iseq), op_type)));
3420 VALUE e = rb_hash_new();
3421 int argc = vm_ci_argc(ci);
3423 ID mid = vm_ci_mid(ci);
3425 rb_hash_aset(e,
ID2SYM(rb_intern(
"flag")),
UINT2NUM(vm_ci_flag(ci)));
3427 if (vm_ci_flag(ci) & VM_CALL_KWARG) {
3432 argc -= kwarg->keyword_len;
3433 for (i = 0; i < kwarg->keyword_len; i++) {
3434 rb_ary_push(kw, kwarg->keywords[i]);
3436 rb_hash_aset(e,
ID2SYM(rb_intern(
"kw_arg")), kw);
3439 rb_hash_aset(e,
ID2SYM(rb_intern(
"orig_argc")),
3441 rb_ary_push(ary, e);
3445 rb_ary_push(ary,
ID2SYM(*seq));
3450 VALUE val = rb_ary_new();
3457 unsigned long idx = nseq - iseq_original + pos;
3459 rb_ary_store(val, i+1,
3460 register_label(labels_table, idx));
3462 rb_ary_push(ary, val);
3467#if SIZEOF_VALUE <= SIZEOF_LONG
3472 rb_ary_push(ary, val);
3477 VALUE val = rb_hash_new();
3478#if SIZEOF_VALUE <= SIZEOF_LONG
3483 rb_hash_aset(val,
ID2SYM(rb_intern(
"func_ptr")), func_ptr);
3487 rb_ary_push(ary, val);
3491 rb_bug(
"unknown operand: %c", insn_op_type(insn, j));
3494 rb_ary_push(body, ary);
3500 if (iseq_body->catch_table)
for (i=0; i<iseq_body->catch_table->size; i++) {
3501 VALUE ary = rb_ary_new();
3503 UNALIGNED_MEMBER_PTR(iseq_body->catch_table, entries[i]);
3504 rb_ary_push(ary, exception_type2symbol(entry->type));
3506 rb_ary_push(ary, iseq_data_to_ary(rb_iseq_check(entry->iseq)));
3509 rb_ary_push(ary,
Qnil);
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);
3519 body = rb_ary_new();
3520 prev_insn_info = NULL;
3521#ifdef USE_ISEQ_NODE_ID
3522 VALUE node_ids = rb_ary_new();
3530 if (st_lookup(labels_table, pos, &label)) {
3531 rb_ary_push(body, (
VALUE)label);
3534 info = get_insn_info(iseq, pos);
3535#ifdef USE_ISEQ_NODE_ID
3536 rb_ary_push(node_ids,
INT2FIX(info->node_id));
3539 if (prev_insn_info != info) {
3540 int line = info->line_no;
3543 if (line > 0 && last_line != line) {
3544 rb_ary_push(body,
INT2FIX(line));
3547#define CHECK_EVENT(ev) if (events & ev) rb_ary_push(body, ID2SYM(rb_intern(#ev)));
3557 prev_insn_info = info;
3560 rb_ary_push(body, ary);
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);
3579 rb_hash_aset(misc,
ID2SYM(rb_intern(
"parser")), iseq_body->prism ?
ID2SYM(rb_intern(
"prism")) :
ID2SYM(rb_intern(
"parse.y")));
3586 rb_ary_push(val,
rb_str_new2(
"YARVInstructionSequence/SimpleDataFormat"));
3587 rb_ary_push(val,
INT2FIX(ISEQ_MAJOR_VERSION));
3588 rb_ary_push(val,
INT2FIX(ISEQ_MINOR_VERSION));
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));
3596 rb_ary_push(val, locals);
3597 rb_ary_push(val, params);
3598 rb_ary_push(val, exception);
3599 rb_ary_push(val, body);
3604rb_iseq_parameters(
const rb_iseq_t *iseq,
int is_proc)
3608 const struct rb_iseq_param_keyword *
const keyword = body->
param.keyword;
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) ( \
3615 rb_id2str(PARAM_ID(i)) ? \
3616 rb_ary_push(a, ID2SYM(PARAM_ID(i))) : \
3622 if (body->
param.flags.forwardable) {
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)));
3633 for (i = 0; i < body->
param.lead_num; i++) {
3635 if (rb_id2str(PARAM_ID(i))) {
3636 rb_ary_push(a,
ID2SYM(PARAM_ID(i)));
3638 rb_ary_push(args, a);
3642 for (i = 0; i < body->
param.lead_num; i++) {
3643 rb_ary_push(args, PARAM(i, req));
3646 r = body->
param.lead_num + body->
param.opt_num;
3647 for (; i < r; i++) {
3649 if (rb_id2str(PARAM_ID(i))) {
3650 rb_ary_push(a,
ID2SYM(PARAM_ID(i)));
3652 rb_ary_push(args, a);
3654 if (body->
param.flags.has_rest) {
3656 rb_ary_push(args, PARAM(body->
param.rest_start, rest));
3658 r = body->
param.post_start + body->
param.post_num;
3660 for (i = body->
param.post_start; i < r; i++) {
3662 if (rb_id2str(PARAM_ID(i))) {
3663 rb_ary_push(a,
ID2SYM(PARAM_ID(i)));
3665 rb_ary_push(args, a);
3669 for (i = body->
param.post_start; i < r; i++) {
3670 rb_ary_push(args, PARAM(i, req));
3673 if (body->
param.flags.accepts_no_kwarg) {
3677 rb_ary_push(args, a);
3679 if (body->
param.flags.has_kw) {
3681 if (keyword->required_num > 0) {
3684 for (; i < keyword->required_num; i++) {
3686 if (rb_id2str(keyword->table[i])) {
3687 rb_ary_push(a,
ID2SYM(keyword->table[i]));
3689 rb_ary_push(args, a);
3693 for (; i < keyword->num; i++) {
3695 if (rb_id2str(keyword->table[i])) {
3696 rb_ary_push(a,
ID2SYM(keyword->table[i]));
3698 rb_ary_push(args, a);
3701 if (body->
param.flags.has_kwrest || body->
param.flags.ruby2_keywords) {
3704 PARAM_TYPE(keyrest);
3705 if (body->
param.flags.has_kwrest &&
3706 rb_id2str(param = PARAM_ID(keyword->rest_start))) {
3707 rb_ary_push(a,
ID2SYM(param));
3709 else if (body->
param.flags.ruby2_keywords) {
3710 rb_ary_push(a,
ID2SYM(idPow));
3712 rb_ary_push(args, a);
3714 if (body->
param.flags.has_block) {
3716 rb_ary_push(args, PARAM(body->
param.block_start, block));
3722rb_iseq_defined_string(
enum defined_type
type)
3724 static const char expr_names[][18] = {
3726 "instance-variable",
3742 if ((
unsigned)(
type - 1) >= (
unsigned)numberof(expr_names)) rb_bug(
"unknown defined type %d",
type);
3743 estr = expr_names[
type - 1];
3744 return rb_fstring_cstr(estr);
3754 void *notrace_encoded_insn;
3755 void *trace_encoded_insn;
3757static insn_data_t insn_data[VM_INSTRUCTION_SIZE/2];
3760rb_free_encoded_insn_data(
void)
3762 st_free_table(encoded_insn_data);
3766rb_vm_encoded_insn_data_table_init(
void)
3768#if OPT_DIRECT_THREADED_CODE || OPT_CALL_THREADED_CODE
3769 const void *
const *table = rb_vm_get_insns_address_table();
3770#define INSN_CODE(insn) ((VALUE)table[insn])
3772#define INSN_CODE(insn) (insn)
3775 encoded_insn_data = st_init_numtable_with_size(VM_INSTRUCTION_SIZE / 2);
3777 for (insn = 0; insn < VM_INSTRUCTION_SIZE/2; insn++) {
3778 st_data_t key1 = (st_data_t)INSN_CODE(insn);
3779 st_data_t key2 = (st_data_t)INSN_CODE(insn + VM_INSTRUCTION_SIZE/2);
3781 insn_data[insn].insn = (int)insn;
3782 insn_data[insn].insn_len = insn_len(insn);
3784 if (insn != BIN(opt_invokebuiltin_delegate_leave)) {
3785 insn_data[insn].notrace_encoded_insn = (
void *) key1;
3786 insn_data[insn].trace_encoded_insn = (
void *) key2;
3789 insn_data[insn].notrace_encoded_insn = (
void *) INSN_CODE(BIN(opt_invokebuiltin_delegate));
3790 insn_data[insn].trace_encoded_insn = (
void *) INSN_CODE(BIN(opt_invokebuiltin_delegate) + VM_INSTRUCTION_SIZE/2);
3793 st_add_direct(encoded_insn_data, key1, (st_data_t)&insn_data[insn]);
3794 st_add_direct(encoded_insn_data, key2, (st_data_t)&insn_data[insn]);
3799rb_vm_insn_addr2insn(
const void *addr)
3801 st_data_t key = (st_data_t)addr;
3804 if (st_lookup(encoded_insn_data, key, &val)) {
3806 return (
int)e->insn;
3809 rb_bug(
"rb_vm_insn_addr2insn: invalid insn address: %p", addr);
3814rb_vm_insn_addr2opcode(
const void *addr)
3816 st_data_t key = (st_data_t)addr;
3819 if (st_lookup(encoded_insn_data, key, &val)) {
3821 int opcode = e->insn;
3822 if (addr == e->trace_encoded_insn) {
3823 opcode += VM_INSTRUCTION_SIZE/2;
3828 rb_bug(
"rb_vm_insn_addr2opcode: invalid insn address: %p", addr);
3833rb_vm_insn_decode(
const VALUE encoded)
3835#if OPT_DIRECT_THREADED_CODE || OPT_CALL_THREADED_CODE
3836 int insn = rb_vm_insn_addr2insn((
void *)encoded);
3838 int insn = (int)encoded;
3844encoded_iseq_trace_instrument(
VALUE *iseq_encoded_insn,
rb_event_flag_t turnon,
bool remain_current_trace)
3846 st_data_t key = (st_data_t)*iseq_encoded_insn;
3849 if (st_lookup(encoded_insn_data, key, &val)) {
3851 if (remain_current_trace && key == (st_data_t)e->trace_encoded_insn) {
3854 *iseq_encoded_insn = (
VALUE) (turnon ? e->trace_encoded_insn : e->notrace_encoded_insn);
3858 rb_bug(
"trace_instrument: invalid insn address: %p", (
void *)*iseq_encoded_insn);
3862rb_iseq_trace_flag_cleared(
const rb_iseq_t *iseq,
size_t pos)
3865 VALUE *iseq_encoded = (
VALUE *)body->iseq_encoded;
3866 encoded_iseq_trace_instrument(&iseq_encoded[pos], 0,
false);
3892 VALUE *iseq_encoded = (
VALUE *)body->iseq_encoded;
3894 VM_ASSERT(ISEQ_EXECUTABLE_P(iseq));
3896 for (pc=0; pc<body->iseq_size;) {
3900 unsigned int line = (int)entry->line_no;
3902 if (target_line == 0 || target_line == line) {
3906 target_events &= ~RUBY_EVENT_LINE;
3909 if (pc_events & target_events) {
3912 pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & (target_events | iseq->aux.exec.global_trace_events),
true);
3916 if (iseq->aux.exec.local_hooks == NULL) {
3918 iseq->aux.exec.local_hooks->is_local =
true;
3920 rb_hook_list_connect_tracepoint((
VALUE)iseq, iseq->aux.exec.local_hooks, tpval, target_line);
3929 unsigned int target_line;
3934iseq_add_local_tracepoint_i(
const rb_iseq_t *iseq,
void *p)
3937 data->n += iseq_add_local_tracepoint(iseq, data->turnon_events, data->tpval, data->target_line);
3938 iseq_iterate_children(iseq, iseq_add_local_tracepoint_i, p);
3942rb_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)
3945 if (target_bmethod) {
3946 turnon_events = add_bmethod_events(turnon_events);
3948 data.turnon_events = turnon_events;
3950 data.target_line = target_line;
3953 iseq_add_local_tracepoint_i(iseq, (
void *)&data);
3954 if (0)
rb_funcall(
Qnil, rb_intern(
"puts"), 1, rb_iseq_disasm(iseq));
3963 if (iseq->aux.exec.local_hooks) {
3966 VALUE *iseq_encoded = (
VALUE *)body->iseq_encoded;
3969 rb_hook_list_remove_tracepoint(iseq->aux.exec.local_hooks, tpval);
3970 local_events = iseq->aux.exec.local_hooks->events;
3972 if (local_events == 0) {
3973 rb_hook_list_free(iseq->aux.exec.local_hooks);
3974 ((
rb_iseq_t *)iseq)->aux.exec.local_hooks = NULL;
3977 local_events = add_bmethod_events(local_events);
3978 for (pc = 0; pc<body->iseq_size;) {
3980 pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & (local_events | iseq->aux.exec.global_trace_events),
false);
3992iseq_remove_local_tracepoint_i(
const rb_iseq_t *iseq,
void *p)
3995 data->n += iseq_remove_local_tracepoint(iseq, data->tpval);
3996 iseq_iterate_children(iseq, iseq_remove_local_tracepoint_i, p);
4000rb_iseq_remove_local_tracepoint_recursively(
const rb_iseq_t *iseq,
VALUE tpval)
4006 iseq_remove_local_tracepoint_i(iseq, (
void *)&data);
4013 if (iseq->aux.exec.global_trace_events == turnon_events) {
4017 if (!ISEQ_EXECUTABLE_P(iseq)) {
4024 VALUE *iseq_encoded = (
VALUE *)body->iseq_encoded;
4026 rb_event_flag_t local_events = iseq->aux.exec.local_hooks ? iseq->aux.exec.local_hooks->events : 0;
4027 ((
rb_iseq_t *)iseq)->aux.exec.global_trace_events = turnon_events;
4028 enabled_events = add_bmethod_events(turnon_events | local_events);
4030 for (pc=0; pc<body->iseq_size;) {
4032 pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & enabled_events,
true);
4040clear_attr_cc(
VALUE v)
4042 if (imemo_type_p(v, imemo_callcache) && vm_cc_ivar_p((
const struct rb_callcache *)v)) {
4054 if (imemo_type_p(v, imemo_callcache) && vm_cc_bf_p((
const struct rb_callcache *)v)) {
4064clear_attr_ccs_i(
void *vstart,
void *vend,
size_t stride,
void *data)
4067 for (; v != (
VALUE)vend; v += stride) {
4068 void *ptr = rb_asan_poisoned_object_p(v);
4069 rb_asan_unpoison_object(v,
false);
4071 asan_poison_object_if(ptr, v);
4077rb_clear_attr_ccs(
void)
4079 rb_objspace_each_objects(clear_attr_ccs_i, NULL);
4083clear_bf_ccs_i(
void *vstart,
void *vend,
size_t stride,
void *data)
4086 for (; v != (
VALUE)vend; v += stride) {
4087 void *ptr = rb_asan_poisoned_object_p(v);
4088 rb_asan_unpoison_object(v,
false);
4090 asan_poison_object_if(ptr, v);
4096rb_clear_bf_ccs(
void)
4098 rb_objspace_each_objects(clear_bf_ccs_i, NULL);
4102trace_set_i(
void *vstart,
void *vend,
size_t stride,
void *data)
4107 for (; v != (
VALUE)vend; v += stride) {
4108 void *ptr = rb_asan_poisoned_object_p(v);
4109 rb_asan_unpoison_object(v,
false);
4111 if (rb_obj_is_iseq(v)) {
4112 rb_iseq_trace_set(rb_iseq_check((
rb_iseq_t *)v), turnon_events);
4114 else if (clear_attr_cc(v)) {
4116 else if (clear_bf_cc(v)) {
4119 asan_poison_object_if(ptr, v);
4127 rb_objspace_each_objects(trace_set_i, &turnon_events);
4131rb_iseqw_local_variables(
VALUE iseqval)
4133 return rb_iseq_local_variables(iseqw_check(iseqval));
4154iseqw_to_binary(
int argc,
VALUE *argv,
VALUE self)
4157 return rb_iseq_ibf_dump(iseqw_check(self), opt);
4174iseqw_s_load_from_binary(
VALUE self,
VALUE str)
4176 return iseqw_new(rb_iseq_ibf_load(str));
4186iseqw_s_load_from_binary_extra_data(
VALUE self,
VALUE str)
4188 return rb_iseq_ibf_load_extra_data(str);
4191#if VM_INSN_INFO_TABLE_IMPL == 2
4224#define IMMEDIATE_TABLE_SIZE 54
4226struct succ_index_table {
4227 uint64_t imm_part[IMMEDIATE_TABLE_SIZE / 9];
4228 struct succ_dict_block {
4230 uint64_t small_block_ranks;
4231 uint64_t bits[512/64];
4232 } succ_part[FLEX_ARY_LEN];
4235#define imm_block_rank_set(v, i, r) (v) |= (uint64_t)(r) << (7 * (i))
4236#define imm_block_rank_get(v, i) (((int)((v) >> ((i) * 7))) & 0x7f)
4237#define small_block_rank_set(v, i, r) (v) |= (uint64_t)(r) << (9 * ((i) - 1))
4238#define small_block_rank_get(v, i) ((i) == 0 ? 0 : (((int)((v) >> (((i) - 1) * 9))) & 0x1ff))
4240static struct succ_index_table *
4241succ_index_table_create(
int max_pos,
int *data,
int size)
4243 const int imm_size = (max_pos < IMMEDIATE_TABLE_SIZE ? max_pos + 8 : IMMEDIATE_TABLE_SIZE) / 9;
4244 const int succ_size = (max_pos < IMMEDIATE_TABLE_SIZE ? 0 : (max_pos - IMMEDIATE_TABLE_SIZE + 511)) / 512;
4245 struct succ_index_table *sd =
4246 rb_xcalloc_mul_add_mul(
4247 imm_size,
sizeof(uint64_t),
4248 succ_size,
sizeof(
struct succ_dict_block));
4252 for (j = 0; j < imm_size; j++) {
4253 for (i = 0; i < 9; i++) {
4254 if (r < size && data[r] == j * 9 + i) r++;
4255 imm_block_rank_set(sd->imm_part[j], i, r);
4258 for (k = 0; k < succ_size; k++) {
4259 struct succ_dict_block *sd_block = &sd->succ_part[k];
4262 for (j = 0; j < 8; j++) {
4264 if (j) small_block_rank_set(sd_block->small_block_ranks, j, small_rank);
4265 for (i = 0; i < 64; i++) {
4266 if (r < size && data[r] == k * 512 + j * 64 + i + IMMEDIATE_TABLE_SIZE) {
4267 bits |= ((uint64_t)1) << i;
4271 sd_block->bits[j] = bits;
4272 small_rank += rb_popcount64(bits);
4278static unsigned int *
4279succ_index_table_invert(
int max_pos,
struct succ_index_table *sd,
int size)
4281 const int imm_size = (max_pos < IMMEDIATE_TABLE_SIZE ? max_pos + 8 : IMMEDIATE_TABLE_SIZE) / 9;
4282 const int succ_size = (max_pos < IMMEDIATE_TABLE_SIZE ? 0 : (max_pos - IMMEDIATE_TABLE_SIZE + 511)) / 512;
4283 unsigned int *positions =
ALLOC_N(
unsigned int, size), *p;
4284 int i, j, k, r = -1;
4286 for (j = 0; j < imm_size; j++) {
4287 for (i = 0; i < 9; i++) {
4288 int nr = imm_block_rank_get(sd->imm_part[j], i);
4289 if (r != nr) *p++ = j * 9 + i;
4293 for (k = 0; k < succ_size; k++) {
4294 for (j = 0; j < 8; j++) {
4295 for (i = 0; i < 64; i++) {
4296 if (sd->succ_part[k].bits[j] & (((uint64_t)1) << i)) {
4297 *p++ = k * 512 + j * 64 + i + IMMEDIATE_TABLE_SIZE;
4306succ_index_lookup(
const struct succ_index_table *sd,
int x)
4308 if (x < IMMEDIATE_TABLE_SIZE) {
4309 const int i = x / 9;
4310 const int j = x % 9;
4311 return imm_block_rank_get(sd->imm_part[i], j);
4314 const int block_index = (x - IMMEDIATE_TABLE_SIZE) / 512;
4315 const struct succ_dict_block *block = &sd->succ_part[block_index];
4316 const int block_bit_index = (x - IMMEDIATE_TABLE_SIZE) % 512;
4317 const int small_block_index = block_bit_index / 64;
4318 const int small_block_popcount = small_block_rank_get(block->small_block_ranks, small_block_index);
4319 const int popcnt = rb_popcount64(block->bits[small_block_index] << (63 - block_bit_index % 64));
4321 return block->rank + small_block_popcount + popcnt;
4340iseqw_script_lines(
VALUE self)
4342 const rb_iseq_t *iseq = iseqw_check(self);
4343 return ISEQ_BODY(iseq)->variable.script_lines;
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
#define rb_define_private_method(klass, mid, func, arity)
Defines klass#mid and makes it private.
#define RUBY_EVENT_END
Encountered an end of a class clause.
#define RUBY_EVENT_C_CALL
A method, written in C, is called.
#define RUBY_EVENT_B_RETURN
Encountered a next statement.
#define RUBY_EVENT_CLASS
Encountered a new class.
#define RUBY_EVENT_LINE
Encountered a new line.
#define RUBY_EVENT_RETURN
Encountered a return statement.
#define RUBY_EVENT_C_RETURN
Return from a method, written in C.
#define RUBY_EVENT_B_CALL
Encountered an yield statement.
uint32_t rb_event_flag_t
Represents event(s).
#define RUBY_EVENT_CALL
A method, written in Ruby, is called.
#define RUBY_EVENT_RESCUE
Encountered a rescue statement.
#define RB_OBJ_FREEZE
Just another name of rb_obj_freeze_inline.
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
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.
#define rb_str_new2
Old name of rb_str_new_cstr.
#define T_FILE
Old name of RUBY_T_FILE.
#define T_STRING
Old name of RUBY_T_STRING.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define rb_str_cat2
Old name of rb_str_cat_cstr.
#define ID2SYM
Old name of RB_ID2SYM.
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define ULONG2NUM
Old name of RB_ULONG2NUM.
#define SYM2ID
Old name of RB_SYM2ID.
#define ZALLOC
Old name of RB_ZALLOC.
#define LL2NUM
Old name of RB_LL2NUM.
#define CLASS_OF
Old name of rb_class_of.
#define T_NONE
Old name of RUBY_T_NONE.
#define FIX2INT
Old name of RB_FIX2INT.
#define T_HASH
Old name of RUBY_T_HASH.
#define ALLOC_N
Old name of RB_ALLOC_N.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define LONG2NUM
Old name of RB_LONG2NUM.
#define Qtrue
Old name of RUBY_Qtrue.
#define NUM2INT
Old name of RB_NUM2INT.
#define INT2NUM
Old name of RB_INT2NUM.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
#define NIL_P
Old name of RB_NIL_P.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define NUM2LONG
Old name of RB_NUM2LONG.
#define UINT2NUM
Old name of RB_UINT2NUM.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define CONST_ID
Old name of RUBY_CONST_ID.
#define rb_ary_new2
Old name of rb_ary_new_capa.
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
VALUE rb_eTypeError
TypeError exception.
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.
VALUE rb_eSyntaxError
SyntaxError exception.
VALUE rb_class_superclass(VALUE klass)
Queries the parent of the given class.
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
Defines RBIMPL_HAS_BUILTIN.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
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.
VALUE rb_io_close(VALUE io)
Closes the IO.
int rb_is_local_id(ID id)
Classifies the given ID, then sees if it is a local variable.
VALUE rb_obj_is_method(VALUE recv)
Queries if the given object is a method.
VALUE rb_obj_is_proc(VALUE recv)
Queries if the given object is a proc.
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
#define rb_str_new(str, len)
Allocates an instance of rb_cString.
#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.
VALUE rb_str_dup(VALUE str)
Duplicates a string.
VALUE rb_str_cat(VALUE dst, const char *src, long srclen)
Destructively appends the passed contents to the string.
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...
void rb_str_set_len(VALUE str, long len)
Overwrites the length of the string.
VALUE rb_str_inspect(VALUE str)
Generates a "readable" version of the receiver.
int rb_str_cmp(VALUE lhs, VALUE rhs)
Compares two strings, as in strcmp(3).
VALUE rb_str_concat(VALUE dst, VALUE src)
Identical to rb_str_append(), except it also accepts an integer as a codepoint.
#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.
void rb_str_modify_expand(VALUE str, long capa)
Identical to rb_str_modify(), except it additionally expands the capacity of the receiver.
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
VALUE rb_str_intern(VALUE str)
Identical to rb_to_symbol(), except it assumes the receiver being an instance of RString.
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
int rb_respond_to(VALUE obj, ID mid)
Queries if the object responds to the method.
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
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.
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
VALUE rb_sym2str(VALUE symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
VALUE rb_io_path(VALUE io)
Returns the path for the given IO.
int len
Length of the buffer.
VALUE rb_ractor_make_shareable(VALUE obj)
Destructively transforms the passed object so that multiple Ractors can share it.
#define RB_NUM2INT
Just another name of rb_num2int_inline.
#define RB_INT2NUM
Just another name of rb_int2num_inline.
VALUE rb_yield(VALUE val)
Yields the block.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
#define RB_ZALLOC(type)
Shorthand of RB_ZALLOC_N with n=1.
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
#define RARRAY_LEN
Just another name of rb_array_len.
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
#define RARRAY_AREF(a, i)
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define RHASH_SIZE(h)
Queries the size of the hash.
#define StringValue(v)
Ensures that the parameter object is a String.
static char * RSTRING_END(VALUE str)
Queries the end of the contents pointer of the string.
#define StringValueCStr(v)
Identical to StringValuePtr, except it additionally checks for the contents for viability as a C stri...
#define RUBY_TYPED_DEFAULT_FREE
This is a value you can set to rb_data_type_struct::dfree.
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
#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...
#define FilePathValue(v)
Ensures that the parameter object is a path.
#define RTEST
This is an old name of RB_TEST.
const ID * segments
A null-terminated list of ids, used to represent a constant's path idNULL is used to represent the ::...
A line and column in a string.
uint32_t column
The column number.
int32_t line
The line number.
This represents a range of bytes in the source string to which a node or token corresponds.
const uint8_t * start
A pointer to the start location of the range in the source.
const uint8_t * end
A pointer to the end location of the range in the source.
size_t size
The number of offsets in the list.
uint32_t node_id
The unique identifier for this node, which is deterministic based on the source.
pm_location_t location
This is the location of the node in the source.
int32_t line
The line within the file that the parse starts on.
pm_scope_node_t node
The resulting scope node that will hold the generated AST.
pm_options_t options
The options that will be passed to the parser.
int32_t start_line
The line number at the start of the parse.
pm_newline_list_t newline_list
This is the list of newline offsets in the source file.
VALUE * script_lines
This is a pointer to the list of script lines for the ISEQs that will be associated with this scope n...
This is the struct that holds necessary info for a struct.
struct rb_iseq_constant_body::@155 param
parameter information
intptr_t SIGNED_VALUE
A signed integer type that has the same width with VALUE.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
ruby_value_type
C-level type of an object.