Skip to content

Commit

Permalink
Add reference for asm-goto
Browse files Browse the repository at this point in the history
The asm-goto-with-outputs is still unstable, so in the reference it's
still mentioned as forbidden by a check rule.
  • Loading branch information
nbdd0121 committed Dec 4, 2024
1 parent ede56d1 commit 4055915
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions src/inline-assembly.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ format_string := STRING_LITERAL / RAW_STRING_LITERAL
dir_spec := "in" / "out" / "lateout" / "inout" / "inlateout"
reg_spec := <register class> / "\"" <explicit register> "\""
operand_expr := expr / "_" / expr "=>" expr / expr "=>" "_"
reg_operand := [ident "="] dir_spec "(" reg_spec ")" operand_expr / sym <path> / const <expr>
reg_operand := [ident "="] dir_spec "(" reg_spec ")" operand_expr / sym <path> / const <expr> / label <block>
clobber_abi := "clobber_abi(" <abi> *("," <abi>) [","] ")"
option := "pure" / "nomem" / "readonly" / "preserves_flags" / "noreturn" / "nostack" / "att_syntax" / "raw"
options := "options(" option *("," option) [","] ")"
Expand Down Expand Up @@ -180,6 +180,13 @@ r[asm.operand-type.supported-operands.sym]
- The type of the expression may be any integer type, but defaults to `i32` just like integer literals.
- The value of the expression is formatted as a string and substituted directly into the asm template string.

r[asm.operand-type.supported-operands.label]
* `label <block>`
- The address of the block is substituted into the asm template string. The assembly block may jump to the substituted addresses.
- After execution of the block, the `asm!` expression returns.
- The type of the block must be unit or `!` (never).
- The block starts new safety context; despite the outer `unsafe` needed for `asm!`, you need extra unsafe to perform unsafe operations inside the block.

r[asm.operand-type.left-to-right]
Operand expressions are evaluated from left to right, just like function call arguments.
After the `asm!` has executed, outputs are written to in left to right order.
Expand Down Expand Up @@ -553,6 +560,8 @@ r[asm.options.supported-options.noreturn]
- `noreturn`: The `asm!` block never returns, and its return type is defined as `!` (never).
Behavior is undefined if execution falls through past the end of the asm code.
A `noreturn` asm block behaves just like a function which doesn't return; notably, local variables in scope are not dropped before it is invoked.
- When labels are present, `noreturn` means the `asm!` block never fallthrough; the asm block may jump to one of the specified blocks.
The entire `asm!` block will have unit type in this case, unless all label blocks diverge, in which case the return type is `!`.

r[asm.options.supported-options.nostack]
- `nostack`: The `asm!` block does not push data to the stack, or write to the stack red-zone (if supported by the target).
Expand All @@ -576,7 +585,10 @@ r[asm.options.checks.pure]
- It is a compile-time error to specify `pure` on an asm block with no outputs or only discarded outputs (`_`).

r[asm.options.checks.noreturn]
- It is a compile-time error to specify `noreturn` on an asm block with outputs.
- It is a compile-time error to specify `noreturn` on an asm block with outputs and without labels.

r[asm.options.checks.label-with-outputs]
- It is a compile-time error to specify label on an asm block with outputs.

r[asm.options.global_asm-restriction]
`global_asm!` only supports the `att_syntax` and `raw` options.
Expand Down

0 comments on commit 4055915

Please sign in to comment.