Skip to content

Commit

Permalink
Rollup merge of #76675 - lzutao:asm_doc, r=Amanieu
Browse files Browse the repository at this point in the history
Small improvements to asm documentation

Save people from searching and reading tons of comments in tracking issues.
  • Loading branch information
Dylan-DPC authored Sep 16, 2020
2 parents d1b0504 + e82be71 commit 6194d7e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
19 changes: 19 additions & 0 deletions src/doc/unstable-book/src/library-features/asm.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,25 @@ The `h` modifier will emit the register name for the high byte of that register

If you use a smaller data type (e.g. `u16`) with an operand and forget the use template modifiers, the compiler will emit a warning and suggest the correct modifier to use.

## Memory address operands

Sometimes assembly instructions require operands passed via memory addresses/memory locations.
You have to manually use the memory address syntax specified by the respectively architectures.
For example, in x86/x86_64 and intel assembly syntax, you should wrap inputs/outputs in `[]`
to indicate they are memory operands:

```rust,allow_fail
# #![feature(asm, llvm_asm)]
# fn load_fpu_control_word(control: u16) {
unsafe {
asm!("fldcw [{}]", in(reg) &control, options(nostack));
// Previously this would have been written with the deprecated `llvm_asm!` like this
llvm_asm!("fldcw $0" :: "m" (control) :: "volatile");
}
# }
```

## Options

By default, an inline assembly block is treated the same way as an external FFI function call with a custom calling convention: it may read/write memory, have observable side effects, etc. However in many cases, it is desirable to give the compiler more information about what the assembly code is actually doing so that it can optimize better.
Expand Down
6 changes: 3 additions & 3 deletions src/doc/unstable-book/src/library-features/llvm-asm.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,12 +159,12 @@ specify some extra info about the inline assembly:

Current valid options are:

1. *volatile* - specifying this is analogous to
1. `volatile` - specifying this is analogous to
`__asm__ __volatile__ (...)` in gcc/clang.
2. *alignstack* - certain instructions expect the stack to be
2. `alignstack` - certain instructions expect the stack to be
aligned a certain way (i.e. SSE) and specifying this indicates to
the compiler to insert its usual stack alignment code
3. *intel* - use intel syntax instead of the default AT&T.
3. `intel` - use intel syntax instead of the default AT&T.

```rust
# #![feature(llvm_asm)]
Expand Down

0 comments on commit 6194d7e

Please sign in to comment.