summaryrefslogtreecommitdiff
path: root/iseq.c
diff options
context:
space:
mode:
authorTakashi Kokubun <[email protected]>2025-04-28 11:45:53 -0700
committerTakashi Kokubun <[email protected]>2025-04-28 11:45:54 -0700
commit9996d692f4cd4194dcc699083e38fb5236ac987c ()
tree4d679520b28e2eae21b279395bc5c354f7782814 /iseq.c
parent58e3aa02240a9ec1b5fe6ce60d63828c2cf0c73a (diff)
Add comments for cryptic functions in iseq.c
-rw-r--r--iseq.c19
1 files changed, 16 insertions, 3 deletions
@@ -2377,6 +2377,8 @@ rb_iseq_event_flags(const rb_iseq_t *iseq, size_t pos)
}
}
void
rb_iseq_clear_event_flags(const rb_iseq_t *iseq, size_t pos, rb_event_flag_t reset)
{
@@ -3767,6 +3769,8 @@ rb_free_encoded_insn_data(void)
st_free_table(encoded_insn_data);
}
void
rb_vm_encoded_insn_data_table_init(void)
{
@@ -3783,7 +3787,8 @@ rb_vm_encoded_insn_data_table_init(void)
insn_data[insn].insn_len = insn_len(insn);
// When tracing :return events, we convert opt_invokebuiltin_delegate_leave + leave into
- // opt_invokebuiltin_delegate + trace_leave. https://.com/ruby/ruby/pull/3256
int notrace_insn = (insn != BIN(opt_invokebuiltin_delegate_leave)) ? insn : BIN(opt_invokebuiltin_delegate);
insn_data[insn].notrace_encoded_insn = (void *)INSN_CODE(notrace_insn);
insn_data[insn].trace_encoded_insn = (void *)INSN_CODE(notrace_insn + VM_BARE_INSTRUCTION_SIZE);
@@ -3806,6 +3811,9 @@ rb_vm_encoded_insn_data_table_init(void)
}
}
int
rb_vm_insn_addr2insn(const void *addr)
{
@@ -3820,7 +3828,8 @@ rb_vm_insn_addr2insn(const void *addr)
rb_bug("rb_vm_insn_addr2insn: invalid insn address: %p", addr);
}
-// Unlike rb_vm_insn_addr2insn, this function can return trace opcode variants.
int
rb_vm_insn_addr2opcode(const void *addr)
{
@@ -3844,7 +3853,9 @@ rb_vm_insn_addr2opcode(const void *addr)
rb_bug("rb_vm_insn_addr2opcode: invalid insn address: %p", addr);
}
-// Decode `ISEQ_BODY(iseq)->iseq_encoded[i]` to an insn.
int
rb_vm_insn_decode(const VALUE encoded)
{
@@ -3856,6 +3867,7 @@ rb_vm_insn_decode(const VALUE encoded)
return insn;
}
static inline int
encoded_iseq_trace_instrument(VALUE *iseq_encoded_insn, rb_event_flag_t turnon, bool remain_current_trace)
{
@@ -3874,6 +3886,7 @@ encoded_iseq_trace_instrument(VALUE *iseq_encoded_insn, rb_event_flag_t turnon,
rb_bug("trace_instrument: invalid insn address: %p", (void *)*iseq_encoded_insn);
}
void
rb_iseq_trace_flag_cleared(const rb_iseq_t *iseq, size_t pos)
{