Skip to content

AVM: frame pointers #4319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jannotti merged 16 commits into from
Sep 28, 2022
Merged

AVM: frame pointers #4319

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
7688d3f
Frame pointer work
jannotti Jul 23, 2022
3efad43
Test with example of using positive grame_get, for locals
jannotti Aug 30, 2022
2111bd7
Smarter limits on frame_{dig,bury}
jannotti Sep 1, 2022
18a7933
clearer error message
jannotti Sep 1, 2022
184313e
Intial DupN op.
jannotti Sep 9, 2022
ccae9d0
dupn and bury
jannotti Sep 15, 2022
e22fabc
Remove stacky() in favor of typed() + immediates()
jannotti Sep 19, 2022
d803ad3
Make bury and frame_bury type checking look more similar
jannotti Sep 19, 2022
badafe1
Fix small bug and other improvements
jasonpaulos Sep 19, 2022
5937ea6
Excised pushn
jannotti Sep 21, 2022
aac2007
Spec detail for retsub from a `proto` frame.
jannotti Sep 27, 2022
21ff73b
Re-org the new opcodes, move frames out of experimental
jannotti Sep 27, 2022
b58ff8e
remove a stray "b" in docs
jannotti Sep 28, 2022
41dae52
Remove useless clones
jannotti Sep 28, 2022
1bc1de7
Avoid allocation, and iterating twice, in `dupn`
jannotti Sep 28, 2022
74fa7eb
Coverage, small optimization
jannotti Sep 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions data/transactions/logic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,15 +584,21 @@ Account fields used in the `acct_params_get` opcode.
| `b target` | branch unconditionally to TARGET |
| `return` | use A as success value; end |
| `pop` | discard A |
| `popn n` | Remove N values from the top of the stack |
| `dup` | duplicate A |
| `dup2` | duplicate A and B |
| `dupn n` | duplicate A, N times |
| `dig n` | Nth value from the top of the stack. dig 0 is equivalent to dup |
| `bury n` | Replace the Nth value from the top of the stack. bury 0 fails. |
| `cover n` | remove top of stack, and place it deeper in the stack such that N elements are above it. Fails if stack depth <= N. |
| `uncover n` | remove the value at depth N in the stack and shift above items down so the Nth deep value is on top of the stack. Fails if stack depth <= N. |
| `frame_dig i` | Nth (signed) value from the frame pointer. |
| `frame_bury i` | Replace the Nth (signed) value from the frame pointer in the stack |
| `swap` | swaps A and B on stack |
| `select` | selects one of two values based on top-of-stack: B if C != 0, else A |
| `assert` | immediately fail unless A is a non-zero number |
| `callsub target` | branch unconditionally to TARGET, saving the next instruction on the call stack |
| `proto a r` | Prepare top call frame for a retsub that will assume A args and R return values. |
| `retsub` | pop the top instruction from the call stack and branch to it |
| `switch target ...` | branch to the Ath label. Continue at following instruction if index A exceeds the number of labels. |

Expand Down
52 changes: 48 additions & 4 deletions data/transactions/logic/TEAL_opcodes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,27 @@ See `bnz` for details on how branches work. `b` always jumps to the offset.
- immediately fail unless A is a non-zero number
- Availability: v3

## bury n

- Opcode: 0x45 {uint8 depth}
- Stack: ..., A &rarr; ...
- Replace the Nth value from the top of the stack. bury 0 fails.
- Availability: v8

## popn n

- Opcode: 0x46 {uint8 stack depth}
- Stack: ..., [N items] &rarr; ...
- Remove N values from the top of the stack
- Availability: v8

## dupn n

- Opcode: 0x47 {uint8 copy count}
- Stack: ..., A &rarr; ..., A, b[N copies of A]
- duplicate A, N times
- Availability: v8

## pop

- Opcode: 0x48
Expand Down Expand Up @@ -790,7 +811,7 @@ When A is a uint64, index 0 is the least significant bit. Setting bit 3 to 1 on

## json_ref r

- Opcode: 0x5f {string return type}
- Opcode: 0x5f {uint8 return type}
Comment thread
ahangsu marked this conversation as resolved.
Outdated
- Stack: ..., A: []byte, B: []byte &rarr; ..., any
- key B's value, of type R, from a [valid](jsonspec.md) utf-8 encoded json object A
- **Cost**: 25 + 2 per 7 bytes of A
Expand Down Expand Up @@ -1042,7 +1063,7 @@ pushint args are not added to the intcblock during assembly processes
- branch unconditionally to TARGET, saving the next instruction on the call stack
- Availability: v4

The call stack is separate from the data stack. Only `callsub` and `retsub` manipulate it.
The call stack is separate from the data stack. Only `callsub`, `retsub`, and `proto` manipulate it.

## retsub

Expand All @@ -1051,11 +1072,34 @@ The call stack is separate from the data stack. Only `callsub` and `retsub` mani
- pop the top instruction from the call stack and branch to it
- Availability: v4

The call stack is separate from the data stack. Only `callsub` and `retsub` manipulate it.
If the current frame was prepared by `proto A R`, `retsub` will remove the 'A' arguments from the stack, move the `R` return values down, and pop any stack locations above the relocated return values.

## proto a r

- Opcode: 0x8a {uint8 arguments} {uint8 return values}
- Stack: ... &rarr; ...
- Prepare top call frame for a retsub that will assume A args and R return values.
- Availability: v8

Fails unless the last instruction executed was a `callsub`.

## frame_dig i

- Opcode: 0x8b {int8 frame slot}
- Stack: ... &rarr; ..., any
- Nth (signed) value from the frame pointer.
- Availability: v8

## frame_bury i

- Opcode: 0x8c {int8 frame slot}
- Stack: ..., A &rarr; ...
- Replace the Nth (signed) value from the frame pointer in the stack
- Availability: v8

## switch target ...

- Opcode: 0x8a {uint8 branch count} [{int16 branch offset, big-endian}, ...]
- Opcode: 0x8d {uint8 branch count} [{int16 branch offset, big-endian}, ...]
- Stack: ..., A: uint64 &rarr; ...
- branch to the Ath label. Continue at following instruction if index A exceeds the number of labels.
- Availability: v8
Expand Down
Loading