Skip to content

Commit 30677c5

Browse files
committed
Create x86_64-asan-linux-gnu target which enables ASAN by default
As suggested, in order to distribute sanitizer instrumented standard libraries without introducing new rustc flags, this adds a new dedicated target. With the target, we can distribute the instrumented standard libraries through a separate rustup component.
1 parent 9b82a4f commit 30677c5

File tree

7 files changed

+73
-0
lines changed

7 files changed

+73
-0
lines changed

compiler/rustc_target/src/spec/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1800,6 +1800,8 @@ supported_targets! {
18001800
("x86_64-lynx-lynxos178", x86_64_lynx_lynxos178),
18011801

18021802
("x86_64-pc-cygwin", x86_64_pc_cygwin),
1803+
1804+
("x86_64-asan-linux-gnu", x86_64_asan_linux_gnu),
18031805
}
18041806

18051807
/// Cow-Vec-Str: Cow<'static, [Cow<'static, str>]>
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
use crate::spec::{SanitizerSet, Target, TargetMetadata};
2+
3+
pub(crate) fn target() -> Target {
4+
let mut base = super::x86_64_unknown_linux_gnu::target();
5+
base.metadata = TargetMetadata {
6+
description: Some("64-bit Linux (kernel 3.2+, glibc 2.17+) with ASAN enabled by default".into()),
7+
tier: Some(3),
8+
host_tools: Some(false),
9+
std: Some(true),
10+
};
11+
base.supported_sanitizers = SanitizerSet::ADDRESS;
12+
base.default_sanitizers = SanitizerSet::ADDRESS;
13+
base
14+
}

src/bootstrap/src/core/build_steps/llvm.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1293,6 +1293,7 @@ fn supported_sanitizers(
12931293
"x86_64",
12941294
&["asan", "dfsan", "lsan", "msan", "safestack", "tsan", "rtsan"],
12951295
),
1296+
"x86_64-asan-linux-gnu" => common_libs("linux", "x86_64", &["asan"]),
12961297
"x86_64-unknown-linux-musl" => {
12971298
common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
12981299
}

src/bootstrap/src/core/sanity.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const STAGE0_MISSING_TARGETS: &[&str] = &[
4242
// just a dummy comment so the list doesn't get onelined
4343
"riscv64gc-unknown-redox",
4444
"hexagon-unknown-qurt",
45+
"x86_64-asan-linux-gnu",
4546
];
4647

4748
/// Minimum version threshold for libstdc++ required when using prebuilt LLVM

src/doc/rustc/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,5 +150,6 @@
150150
- [x86_64-pc-cygwin](platform-support/x86_64-pc-cygwin.md)
151151
- [x86_64-unknown-linux-none](platform-support/x86_64-unknown-linux-none.md)
152152
- [x86_64-unknown-none](platform-support/x86_64-unknown-none.md)
153+
- [x86_64-asan-linux-gnu](platform-support/x86_64-asan-linux-gnu.md)
153154
- [xtensa-\*-none-elf](platform-support/xtensa.md)
154155
- [\*-nuttx-\*](platform-support/nuttx.md)

src/doc/rustc/src/platform-support.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,7 @@ target | std | host | notes
448448
[`x86_64-win7-windows-msvc`](platform-support/win7-windows-msvc.md) | ✓ | ✓ | 64-bit Windows 7 support
449449
[`x86_64-wrs-vxworks`](platform-support/vxworks.md) | ✓ | |
450450
[`x86_64h-apple-darwin`](platform-support/x86_64h-apple-darwin.md) | ✓ | ✓ | macOS with late-gen Intel (at least Haswell)
451+
[`x86_64-asan-linux-gnu`](platform-support/x86_64-asan-linux-gnu.md) | ✓ | | 64-bit Linux (kernel 3.2+, glibc 2.17+) with ASAN enabled by default
451452
[`xtensa-esp32-espidf`](platform-support/esp-idf.md) | ✓ | | Xtensa ESP32
452453
[`xtensa-esp32-none-elf`](platform-support/xtensa.md) | * | | Xtensa ESP32
453454
[`xtensa-esp32s2-espidf`](platform-support/esp-idf.md) | ✓ | | Xtensa ESP32-S2
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# `x86_64-asan-linux-gnu`
2+
3+
**Tier: 3**
4+
5+
Target mirroring `x86_64-unknown-linux-gnu` with AddressSanitizer enabled by
6+
default.
7+
The goal of this target is to allow shipping ASAN-instrumented standard
8+
libraries through rustup, enabling a fully instrumented binary without requiring
9+
nightly features (build-std).
10+
Once build-std stabilizes, we will likely no longer need this target.
11+
12+
## Target maintainers
13+
14+
- [@jakos-sec](https://github.com/jakos-sec)
15+
- [@1c3t3a](https://github.com/1c3t3a)
16+
- [@rust-lang/project-exploit-mitigations][project-exploit-mitigations]
17+
18+
## Requirements
19+
20+
The target is for cross-compilation only. Host tools are not supported, since
21+
there is no need to have the host tools instrumented with ASAN. std is fully
22+
supported.
23+
24+
In all other aspects the target is equivalent to `x86_64-unknown-linux-gnu`.
25+
26+
## Building the target
27+
28+
The target can be built by enabling it for a rustc build:
29+
30+
[build]
31+
target = ["x86_64-asan-linux-gnu"]
32+
33+
## Building Rust programs
34+
35+
Rust does not yet ship pre-compiled artifacts for this target. To compile for
36+
this target, you will either need to build Rust with the target enabled (see
37+
"Building the target" above), or build your own copy of `core` by using
38+
`build-std` or similar.
39+
40+
Compilation can be done with:
41+
42+
```
43+
rustc --target x86_64-asan-linux-gnu your-code.rs
44+
```
45+
46+
## Testing
47+
48+
Created binaries will run on Linux without any external requirements.
49+
50+
## Cross-compilation toolchains and C code
51+
52+
The target supports C code and should use the same toolchain target as
53+
`x86_64-unknown-linux-gnu`.

0 commit comments

Comments
 (0)