1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

remove duplicate yarv_frames.md

Browse Source
This commit is contained in:
Alan Wu 2025-02-14 20:16:52 -05:00 committed by Takashi Kokubun
parent b6e4b37c44
commit 3e49f3304d
Notes: git 2025-04-18 13:48:37 +00:00 
Merged: https://github.com/ruby/ruby/pull/13131
2 changed files with 7 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/yarv_frame_layout.md
View File

@ -1,11 +1,11 @@
# YARV Frame Layout # YARV Frame Layout
This document is an introduction to the layout of the VM stack as calls happen. This document is an introduction to what happens on the VM stack as the VM
The code holds the ultimate truth for this subject, so beware that this services calls. The code holds the ultimate truth for this subject, so beware
document can become stale. that this document can become stale.
We'll walk through the following program, with explanation at selected points We'll walk through the following program, with explanation at selected points
in execution and abridged instruction sequence disassembly listings: in execution and abridged disassembly listings:
```ruby ```ruby
def foo(x, y) def foo(x, y)
@ -58,7 +58,7 @@ When accessing variables in the immediate scope, where `level=0`, it's
essentially `val = cfp->ep[-idx];`. essentially `val = cfp->ep[-idx];`.
Note that this EP-relative index has a different basis the index that comes Note that this EP-relative index has a different basis the index that comes
after "@" in disassembly listings. The `@` index is relative to the 0th local after "@" in disassembly listings. The "@" index is relative to the 0th local
(`x` in this case). (`x` in this case).
## Q&A ## Q&A
@ -73,11 +73,5 @@ A: Not all calls put the `self` in the callee on the stack. Two
Q: Why have `cfp->ep` when it seems that everything is below `cfp->sp`? Q: Why have `cfp->ep` when it seems that everything is below `cfp->sp`?
A: In the example, EP points to the stack, but it can also point to the GC heap. A: In the example, `cfp->ep` points to the stack, but it can also point to the
Blocks can capture and evacuate their environment to the heap. GC heap. Blocks can capture and evacuate their environment to the heap.

77
doc/yarv_frames.md
View File

@ -1,77 +0,0 @@
# YARV Frame Layout
This document is an introduction to what happens on the VM stack as the VM
services calls. The code holds the ultimate truth for this subject, so beware
that this document can become stale.
We'll walk through the following program, with explanation at selected points
in execution and abridged disassembly listings:
```ruby
def foo(x, y)
z = x.casecmp(y)
end
foo(:one, :two)
```
First, after arguments are evaluated and right before the `send` to `foo`:
```
┌────────────┐
putself │ :two │
putobject :one 0x2 ├────────────┤
putobject :two │ :one │
► send <:foo, argc:2> 0x1 ├────────────┤
leave │ self │
0x0 └────────────┘
```
The `put*` instructions have pushed 3 items onto the stack. It's now time to
add a new control frame for `foo`. The following is the shape of the stack
after one instruction in `foo`:
```
cfp->sp=0x8 at this point.
0x8 ┌────────────┐◄──Stack space for temporaries
│ :one │ live above the environment.
0x7 ├────────────┤
getlocal x@0 │ < flags > │ foo's rb_control_frame_t
► getlocal y@1 0x6 ├────────────┤◄──has cfp->ep=0x6
send <:casecmp, argc:1> │ <no block> │
dup 0x5 ├────────────┤ The flags, block, and CME triple
setlocal z@2 │ <CME: foo> │ (VM_ENV_DATA_SIZE) form an
leave 0x4 ├────────────┤ environment. They can be used to
│ z (nil) │ figure out what local variables
0x3 ├────────────┤ are below them.
│ :two │
0x2 ├────────────┤ Notice how the arguments, now
│ :one │ locals, never moved. This layout
0x1 ├────────────┤ allows for argument transfer
│ self │ without copying.
0x0 └────────────┘
```
Given that locals have lower address than `cfp->ep`, it makes sense then that
`getlocal` in `insns.def` has `val = *(vm_get_ep(GET_EP(), level) - idx);`.
When accessing variables in the immediate scope, where `level=0`, it's
essentially `val = cfp->ep[-idx];`.
Note that this EP-relative index has a different basis the index that comes
after "@" in disassembly listings. The "@" index is relative to the 0th local
(`x` in this case).
## Q&A
Q: It seems that the receiver is always at an offset relative to EP,
like locals. Couldn't we use EP to access it instead of using `cfp->self`?
A: Not all calls put the `self` in the callee on the stack. Two
examples are `Proc#call`, where the receiver is the Proc object, but `self`
inside the callee is `Proc#receiver`, and `yield`, where the receiver isn't
pushed onto the stack before the arguments.
Q: Why have `cfp->ep` when it seems that everything is below `cfp->sp`?
A: In the example, `cfp->ep` points to the stack, but it can also point to the
GC heap. Blocks can capture and evacuate their environment to the heap.