Find a file
Matthias Krüger 04e4f95e7e
Rollup merge of #147736 - folkertdev:stabilize-asm-cfg, r=jdonszelmann
Stabilize `asm_cfg`

tracking issue: https://github.com/rust-lang/rust/issues/140364
closes https://github.com/rust-lang/rust/issues/140364

Reference PR:

- https://github.com/rust-lang/reference/pull/2063

# Request for Stabilization

## Summary

The `cfg_asm` feature allows `#[cfg(...)]` and `#[cfg_attr(...)]` on  the arguments of the assembly macros, for instance:

```rust
asm!( // or global_asm! or naked_asm!
    "nop",
    #[cfg(target_feature = "sse2")]
    "nop",
    // ...
    #[cfg(target_feature = "sse2")]
    a = const 123, // only used on sse2
);
```

## Semantics

Templates, operands, `options` and `clobber_abi` in the assembly macros (`asm!`, `naked_asm!` and `global_asm!`) can be annotated with `#[cfg(...)]` and `#[cfg_attr(...)]`. When the condition evaluates to true, the annotated argument has no effect, and is completely ignored when expanding the assembly macro.
## Documentation

reference PR: https://github.com/rust-lang/reference/pull/2063

## Tests

- [tests/ui/asm/cfg.rs](https://github.com/rust-lang/rust/blob/master/tests/ui/asm/cfg.rs) checks that `cfg`'d arguments where the condition evaluates to false have no effect
- [tests/ui/asm/cfg-parse-error.rs](https://github.com/rust-lang/rust/blob/master/tests/ui/asm/cfg.rs) checks the parsing rules (parsing effectively assumes that the cfg conditions are all true)

## History

- https://github.com/rust-lang/rust/issues/140279
- https://github.com/rust-lang/rust/pull/140367

# Resolved questions

**how are other attributes handled**

Other attributes are parsed,  but explicitly rejected.

# unresolved questions

**operand before template**

The current implementation expects at least one template string before any operands. In the example below, if the `cfg` condition evaluates to true, the assembly block is ill-formed. But even when it evaluates to `false` this block is rejected, because the parser still expects just a template (a template is parsed as an expression and then validated to ensure that it is or expands to a string literal).

Changing how this works is difficult.
```rust
// This is rejected because `a = out(reg) x` does not parse as an expresion.
asm!(
	#[cfg(false)]
	a = out(reg) x, //~ ERROR expected token: `,`
	"",
);
```

**lint on positional arguments?**

Adding a lint to warn on the definition or use of positional arguments being `cfg`'d out was discussed in https://github.com/rust-lang/rust/issues/140279#issuecomment-2832237372 and subsequent comments. Such a lint is not currently implemented, but that may not be a blocker based on the comments there.

r? `@traviscross` (I'm assuming you'll reassign as needed)
2025-11-25 17:51:13 +01:00
.github Change default branch to main 2025-11-10 10:21:34 +01:00
compiler Rollup merge of #147736 - folkertdev:stabilize-asm-cfg, r=jdonszelmann 2025-11-25 17:51:13 +01:00
library Rollup merge of #147736 - folkertdev:stabilize-asm-cfg, r=jdonszelmann 2025-11-25 17:51:13 +01:00
LICENSES Synchronize Unicode license text from unicode.org 2024-11-20 00:54:12 -08:00
src Auto merge of #149148 - davidtwco:v0-mangling-on-nightly-std, r=Kobzol 2025-11-25 10:25:47 +00:00
tests Rollup merge of #147736 - folkertdev:stabilize-asm-cfg, r=jdonszelmann 2025-11-25 17:51:13 +01:00
.clang-format Add .clang-format 2024-06-26 05:56:00 +08:00
.editorconfig editorconfig: don't use nonexistant syntax 2025-08-24 10:37:19 -05:00
.git-blame-ignore-revs git: ignore 60600a6fa4 for blame purposes 2025-04-17 11:50:24 +08:00
.gitattributes Mark .pp files as Rust 2025-03-29 12:39:06 +01:00
.gitignore ignore build-rust-analyzer even if it's a symlink 2025-11-12 16:41:41 +01:00
.gitmodules Update to LLVM 21 2025-08-01 10:17:04 +02:00
.ignore change config.toml to bootstrap.toml for bootstrap module 2025-03-17 12:56:41 +05:30
.mailmap Auto merge of #149040 - RustyYato:patch-2, r=Kivooeo 2025-11-18 04:30:45 +00:00
bootstrap.example.toml feat: add rust.rustflags and per target rustflags options to bootstrap.toml 2025-11-21 16:25:36 +01:00
Cargo.lock miri: use tikv-jemalloc-sys from sysroot 2025-11-24 10:00:23 +01:00
Cargo.toml Fix building rustdoc and clippy with jemalloc feature 2025-11-11 20:16:16 +01:00
CODE_OF_CONDUCT.md Merge commit 'c936595d17' into clippy-subtree-update 2025-10-31 19:15:42 +01:00
configure Ensure ./configure works when configure.py path contains spaces 2024-02-16 18:57:22 +00:00
CONTRIBUTING.md chore: remove dead links 2025-09-22 10:15:50 +01:00
COPYRIGHT dist: Re-work how we describe the licence of Rust in our distributions 2024-12-09 10:18:55 +00:00
INSTALL.md mention about x.py setup in INSTALL.md 2025-04-24 09:15:53 +03:00
LICENSE-APACHE Remove appendix from LICENCE-APACHE 2019-12-30 14:25:53 +00:00
license-metadata.json Update license metadata 2025-02-15 16:48:37 +01:00
LICENSE-MIT dist: Re-work how we describe the licence of Rust in our distributions 2024-12-09 10:18:55 +00:00
package.json Update npm package, remove another unused one, and fix some typing errors that started popping when we moved to yarn 2025-11-17 10:58:18 +02:00
README.md Update Rust Foundation links in Readme 2025-03-16 19:03:40 -07:00
RELEASES.md update release notes 2025-11-06 20:24:37 +01:00
REUSE.toml Use yarn instead of npm in tidy 2025-11-17 10:58:13 +02:00
rust-bors.toml Add t- prefix to S-waiting-on-{team} labels 2025-10-07 18:15:02 +02:00
rustfmt.toml Rename tests/codegen into tests/codegen-llvm 2025-07-22 14:28:48 +02:00
triagebot.toml Remove jsha from notifications for rustdoc HTML 2025-11-16 16:11:15 -08:00
typos.toml chore: Update typos to 1.38.1 2025-10-20 12:20:15 -06:00
x fix ./x readdir logic when CDPATH is set 2025-09-19 16:48:05 +02:00
x.ps1 use & instead of start-process in x.ps1 2023-12-09 09:46:16 -05:00
x.py Reformat Python code with ruff 2024-12-04 23:03:44 +01:00
yarn.lock Update npm package, remove another unused one, and fix some typing errors that started popping when we moved to yarn 2025-11-17 10:58:18 +02:00

This is the main source code repository for Rust. It contains the compiler, standard library, and documentation.

Why Rust?

  • Performance: Fast and memory-efficient, suitable for critical services, embedded devices, and easily integrated with other languages.

  • Reliability: Our rich type system and ownership model ensure memory and thread safety, reducing bugs at compile-time.

  • Productivity: Comprehensive documentation, a compiler committed to providing great diagnostics, and advanced tooling including package manager and build tool (Cargo), auto-formatter (rustfmt), linter (Clippy) and editor support (rust-analyzer).

Quick Start

Read "Installation" from The Book.

Installing from Source

If you really want to install from source (though this is not recommended), see INSTALL.md.

Getting Help

See https://www.rust-lang.org/community for a list of chat platforms and forums.

Contributing

See CONTRIBUTING.md.

License

Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.

Trademark

The Rust Foundation owns and protects the Rust and Cargo trademarks and logos (the "Rust Trademarks").

If you want to use these names or brands, please read the Rust language trademark policy.

Third-party logos may be subject to third-party copyrights and trademarks. See Licenses for details.