Skip to content

Commit 0fdf6a6

Browse files
committed
sanitizers: Add support for stable sanitizers
Add suppport for specifying stable sanitizers in addition to the existing supported sanitizers.
1 parent ebf0cf7 commit 0fdf6a6

File tree

124 files changed

+324
-254
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+324
-254
lines changed

compiler/rustc_codegen_llvm/src/abi.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ use rustc_session::config;
1414
use rustc_target::callconv::{
1515
ArgAbi, ArgAttribute, ArgAttributes, ArgExtension, CastTarget, Conv, FnAbi, PassMode,
1616
};
17-
use rustc_target::spec::SanitizerSet;
1817
use smallvec::SmallVec;
1918

2019
use crate::attributes::llfn_attrs_from_instance;
@@ -83,7 +82,7 @@ fn get_attrs<'ll>(this: &ArgAttributes, cx: &CodegenCx<'ll, '_>) -> SmallVec<[&'
8382
attrs.push(llattr.create_attr(cx.llcx));
8483
}
8584
}
86-
} else if cx.tcx.sess.opts.unstable_opts.sanitizer.contains(SanitizerSet::MEMORY) {
85+
} else if cx.tcx.sess.is_sanitizer_memory_enabled() {
8786
// If we're not optimising, *but* memory sanitizer is on, emit noundef, since it affects
8887
// memory sanitizer's behavior.
8988

compiler/rustc_codegen_llvm/src/attributes.rs

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ pub(crate) fn sanitize_attrs<'ll>(
8686
no_sanitize: SanitizerSet,
8787
) -> SmallVec<[&'ll Attribute; 4]> {
8888
let mut attrs = SmallVec::new();
89-
let enabled = cx.tcx.sess.opts.unstable_opts.sanitizer - no_sanitize;
89+
let enabled = cx.tcx.sess.opts.cg.sanitize - no_sanitize;
9090
if enabled.contains(SanitizerSet::ADDRESS) || enabled.contains(SanitizerSet::KERNELADDRESS) {
9191
attrs.push(llvm::AttributeKind::SanitizeAddress.create_attr(cx.llcx));
9292
}
@@ -219,13 +219,7 @@ fn probestack_attr<'ll>(cx: &CodegenCx<'ll, '_>) -> Option<&'ll Attribute> {
219219
// Currently stack probes seem somewhat incompatible with the address
220220
// sanitizer and thread sanitizer. With asan we're already protected from
221221
// stack overflow anyway so we don't really need stack probes regardless.
222-
if cx
223-
.sess()
224-
.opts
225-
.unstable_opts
226-
.sanitizer
227-
.intersects(SanitizerSet::ADDRESS | SanitizerSet::THREAD)
228-
{
222+
if cx.sess().is_sanitizer_address_enabled() || cx.sess().is_sanitizer_thread_enabled() {
229223
return None;
230224
}
231225

compiler/rustc_codegen_ssa/src/back/link.rs

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1248,7 +1248,7 @@ fn add_sanitizer_libraries(
12481248
return;
12491249
}
12501250

1251-
let sanitizer = sess.opts.unstable_opts.sanitizer;
1251+
let sanitizer = sess.opts.cg.sanitize;
12521252
if sanitizer.contains(SanitizerSet::ADDRESS) {
12531253
link_sanitizer_runtime(sess, flavor, linker, "asan");
12541254
}
@@ -2478,11 +2478,7 @@ fn add_order_independent_options(
24782478
&& crate_type == CrateType::Executable
24792479
&& !matches!(flavor, LinkerFlavor::Gnu(Cc::Yes, _))
24802480
{
2481-
let prefix = if sess.opts.unstable_opts.sanitizer.contains(SanitizerSet::ADDRESS) {
2482-
"asan/"
2483-
} else {
2484-
""
2485-
};
2481+
let prefix = if sess.is_sanitizer_address_enabled() { "asan/" } else { "" };
24862482
cmd.link_arg(format!("--dynamic-linker={prefix}ld.so.1"));
24872483
}
24882484

compiler/rustc_codegen_ssa/src/back/symbol_export.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ use rustc_middle::ty::{self, GenericArgKind, GenericArgsRef, Instance, SymbolNam
1414
use rustc_middle::util::Providers;
1515
use rustc_session::config::{CrateType, OomStrategy};
1616
use rustc_target::callconv::Conv;
17-
use rustc_target::spec::{SanitizerSet, TlsModel};
17+
use rustc_target::spec::TlsModel;
1818
use tracing::debug;
1919

2020
use crate::base::allocator_kind_for_codegen;
@@ -266,15 +266,15 @@ fn exported_symbols_provider_local(
266266
}));
267267
}
268268

269-
if tcx.sess.opts.unstable_opts.sanitizer.contains(SanitizerSet::MEMORY) {
269+
if tcx.sess.is_sanitizer_memory_enabled() {
270270
let mut msan_weak_symbols = Vec::new();
271271

272272
// Similar to profiling, preserve weak msan symbol during LTO.
273-
if tcx.sess.opts.unstable_opts.sanitizer_recover.contains(SanitizerSet::MEMORY) {
273+
if tcx.sess.is_sanitizer_memory_recover_enabled() {
274274
msan_weak_symbols.push("__msan_keep_going");
275275
}
276276

277-
if tcx.sess.opts.unstable_opts.sanitizer_memory_track_origins != 0 {
277+
if tcx.sess.is_sanitizer_memory_track_origins_enabled() {
278278
msan_weak_symbols.push("__msan_track_origins");
279279
}
280280

compiler/rustc_codegen_ssa/src/back/write.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ impl ModuleConfig {
186186
debug_info_for_profiling: sess.opts.unstable_opts.debug_info_for_profiling,
187187
instrument_coverage: if_regular!(sess.instrument_coverage(), false),
188188

189-
sanitizer: if_regular!(sess.opts.unstable_opts.sanitizer, SanitizerSet::empty()),
189+
sanitizer: if_regular!(sess.opts.cg.sanitize, SanitizerSet::empty()),
190190
sanitizer_dataflow_abilist: if_regular!(
191191
sess.opts.unstable_opts.sanitizer_dataflow_abilist.clone(),
192192
Vec::new()

compiler/rustc_interface/src/tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -636,6 +636,7 @@ fn test_codegen_options_tracking_hash() {
636636
tracked!(profile_use, Some(PathBuf::from("abc")));
637637
tracked!(relocation_model, Some(RelocModel::Pic));
638638
tracked!(relro_level, Some(RelroLevel::Full));
639+
tracked!(sanitize, SanitizerSet::ADDRESS);
639640
tracked!(soft_float, true);
640641
tracked!(split_debuginfo, Some(SplitDebuginfo::Packed));
641642
tracked!(symbol_mangling_version, Some(SymbolManglingVersion::V0));
@@ -847,7 +848,6 @@ fn test_unstable_options_tracking_hash() {
847848
tracked!(regparm, Some(3));
848849
tracked!(relax_elf_relocations, Some(true));
849850
tracked!(remap_cwd_prefix, Some(PathBuf::from("abc")));
850-
tracked!(sanitizer, SanitizerSet::ADDRESS);
851851
tracked!(sanitizer_cfi_canonical_jump_tables, None);
852852
tracked!(sanitizer_cfi_generalize_pointers, Some(true));
853853
tracked!(sanitizer_cfi_normalize_integers, Some(true));

compiler/rustc_metadata/src/native_libs.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ pub fn walk_native_lib_search_dirs<R>(
6161
|| sess.target.os == "linux"
6262
|| sess.target.os == "fuchsia"
6363
|| sess.target.is_like_aix
64-
|| sess.target.is_like_osx && !sess.opts.unstable_opts.sanitizer.is_empty()
64+
|| sess.target.is_like_osx && !sess.opts.cg.sanitize.is_empty()
6565
{
6666
f(&sess.target_tlib_path.dir, false)?;
6767
}

compiler/rustc_session/messages.ftl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ session_branch_protection_requires_aarch64 = `-Zbranch-protection` is only suppo
33
44
session_cannot_enable_crt_static_linux = sanitizer is incompatible with statically linked libc, disable it using `-C target-feature=-crt-static`
55
6-
session_cannot_mix_and_match_sanitizers = `-Zsanitizer={$first}` is incompatible with `-Zsanitizer={$second}`
6+
session_cannot_mix_and_match_sanitizers = `-Csanitize={$first}` is incompatible with `-Csanitize={$second}`
77
88
session_cli_feature_diagnostic_help =
99
add `-Zcrate-attr="feature({$feature})"` to the command-line options to enable
@@ -84,15 +84,15 @@ session_profile_sample_use_file_does_not_exist = file `{$path}` passed to `-C pr
8484
8585
session_profile_use_file_does_not_exist = file `{$path}` passed to `-C profile-use` does not exist
8686
87-
session_sanitizer_cfi_canonical_jump_tables_requires_cfi = `-Zsanitizer-cfi-canonical-jump-tables` requires `-Zsanitizer=cfi`
87+
session_sanitizer_cfi_canonical_jump_tables_requires_cfi = `-Zsanitizer-cfi-canonical-jump-tables` requires `-Csanitize=cfi`
8888
89-
session_sanitizer_cfi_generalize_pointers_requires_cfi = `-Zsanitizer-cfi-generalize-pointers` requires `-Zsanitizer=cfi` or `-Zsanitizer=kcfi`
89+
session_sanitizer_cfi_generalize_pointers_requires_cfi = `-Zsanitizer-cfi-generalize-pointers` requires `-Csanitize=cfi` or `-Csanitize=kcfi`
9090
91-
session_sanitizer_cfi_normalize_integers_requires_cfi = `-Zsanitizer-cfi-normalize-integers` requires `-Zsanitizer=cfi` or `-Zsanitizer=kcfi`
91+
session_sanitizer_cfi_normalize_integers_requires_cfi = `-Zsanitizer-cfi-normalize-integers` requires `-Csanitize=cfi` or `-Csanitize=kcfi`
9292
93-
session_sanitizer_cfi_requires_lto = `-Zsanitizer=cfi` requires `-Clto` or `-Clinker-plugin-lto`
93+
session_sanitizer_cfi_requires_lto = `-Csanitize=cfi` requires `-Clto` or `-Clinker-plugin-lto`
9494
95-
session_sanitizer_cfi_requires_single_codegen_unit = `-Zsanitizer=cfi` with `-Clto` requires `-Ccodegen-units=1`
95+
session_sanitizer_cfi_requires_single_codegen_unit = `-Csanitize=cfi` with `-Clto` requires `-Ccodegen-units=1`
9696
9797
session_sanitizer_kcfi_requires_panic_abort = `-Z sanitizer=kcfi` requires `-C panic=abort`
9898

compiler/rustc_session/src/config/cfg.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ pub(crate) fn default_configuration(sess: &Session) -> Cfg {
212212
ins_sym!(sym::relocation_model, sess.target.relocation_model.desc_symbol());
213213
}
214214

215-
for mut s in sess.opts.unstable_opts.sanitizer {
215+
for mut s in sess.opts.cg.sanitize {
216216
// KASAN is still ASAN under the hood, so it uses the same attribute.
217217
if s == SanitizerSet::KERNELADDRESS {
218218
s = SanitizerSet::ADDRESS;

compiler/rustc_session/src/options.rs

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1152,25 +1152,14 @@ pub mod parse {
11521152
}
11531153

11541154
pub(crate) fn parse_sanitizers(slot: &mut SanitizerSet, v: Option<&str>) -> bool {
1155-
if let Some(v) = v {
1156-
for s in v.split(',') {
1157-
*slot |= match s {
1158-
"address" => SanitizerSet::ADDRESS,
1159-
"cfi" => SanitizerSet::CFI,
1160-
"dataflow" => SanitizerSet::DATAFLOW,
1161-
"kcfi" => SanitizerSet::KCFI,
1162-
"kernel-address" => SanitizerSet::KERNELADDRESS,
1163-
"leak" => SanitizerSet::LEAK,
1164-
"memory" => SanitizerSet::MEMORY,
1165-
"memtag" => SanitizerSet::MEMTAG,
1166-
"shadow-call-stack" => SanitizerSet::SHADOWCALLSTACK,
1167-
"thread" => SanitizerSet::THREAD,
1168-
"hwaddress" => SanitizerSet::HWADDRESS,
1169-
"safestack" => SanitizerSet::SAFESTACK,
1170-
_ => return false,
1171-
}
1155+
if let Some(s) = v {
1156+
let sanitizer_set = SanitizerSet::from_comma_list(s);
1157+
if sanitizer_set.is_ok() {
1158+
*slot |= sanitizer_set.unwrap();
1159+
true
1160+
} else {
1161+
false
11721162
}
1173-
true
11741163
} else {
11751164
false
11761165
}
@@ -2034,6 +2023,8 @@ options! {
20342023
"output remarks for these optimization passes (space separated, or \"all\")"),
20352024
rpath: bool = (false, parse_bool, [UNTRACKED],
20362025
"set rpath values in libs/exes (default: no)"),
2026+
sanitize: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
2027+
"use one or multiple sanitizers"),
20372028
save_temps: bool = (false, parse_bool, [UNTRACKED],
20382029
"save all temporary output files during compilation (default: no)"),
20392030
soft_float: bool = (false, parse_bool, [TRACKED],
@@ -2423,8 +2414,6 @@ options! {
24232414
remark_dir: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
24242415
"directory into which to write optimization remarks (if not specified, they will be \
24252416
written to standard error output)"),
2426-
sanitizer: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
2427-
"use a sanitizer"),
24282417
sanitizer_cfi_canonical_jump_tables: Option<bool> = (Some(true), parse_opt_bool, [TRACKED],
24292418
"enable canonical jump tables (default: yes)"),
24302419
sanitizer_cfi_generalize_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],

compiler/rustc_session/src/session.rs

Lines changed: 45 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -362,8 +362,12 @@ impl Session {
362362
self.opts.unstable_opts.coverage_options.discard_all_spans_in_codegen
363363
}
364364

365+
pub fn is_sanitizer_address_enabled(&self) -> bool {
366+
self.opts.cg.sanitize.contains(SanitizerSet::ADDRESS)
367+
}
368+
365369
pub fn is_sanitizer_cfi_enabled(&self) -> bool {
366-
self.opts.unstable_opts.sanitizer.contains(SanitizerSet::CFI)
370+
self.opts.cg.sanitize.contains(SanitizerSet::CFI)
367371
}
368372

369373
pub fn is_sanitizer_cfi_canonical_jump_tables_disabled(&self) -> bool {
@@ -382,8 +386,32 @@ impl Session {
382386
self.opts.unstable_opts.sanitizer_cfi_normalize_integers == Some(true)
383387
}
384388

389+
pub fn is_sanitizer_hwaddress_enabled(&self) -> bool {
390+
self.opts.cg.sanitize.contains(SanitizerSet::HWADDRESS)
391+
}
392+
385393
pub fn is_sanitizer_kcfi_enabled(&self) -> bool {
386-
self.opts.unstable_opts.sanitizer.contains(SanitizerSet::KCFI)
394+
self.opts.cg.sanitize.contains(SanitizerSet::KCFI)
395+
}
396+
397+
pub fn is_sanitizer_kernel_address_enabled(&self) -> bool {
398+
self.opts.cg.sanitize.contains(SanitizerSet::KERNELADDRESS)
399+
}
400+
401+
pub fn is_sanitizer_memory_enabled(&self) -> bool {
402+
self.opts.cg.sanitize.contains(SanitizerSet::MEMORY)
403+
}
404+
405+
pub fn is_sanitizer_memory_recover_enabled(&self) -> bool {
406+
self.opts.unstable_opts.sanitizer_recover.contains(SanitizerSet::MEMORY)
407+
}
408+
409+
pub fn is_sanitizer_memory_track_origins_enabled(&self) -> bool {
410+
self.opts.unstable_opts.sanitizer_memory_track_origins != 0
411+
}
412+
413+
pub fn is_sanitizer_thread_enabled(&self) -> bool {
414+
self.opts.cg.sanitize.contains(SanitizerSet::THREAD)
387415
}
388416

389417
pub fn is_split_lto_unit_enabled(&self) -> bool {
@@ -565,7 +593,10 @@ impl Session {
565593
// AddressSanitizer and KernelAddressSanitizer uses lifetimes to detect use after scope bugs.
566594
// MemorySanitizer uses lifetimes to detect use of uninitialized stack variables.
567595
// HWAddressSanitizer will use lifetimes to detect use after scope bugs in the future.
568-
|| self.opts.unstable_opts.sanitizer.intersects(SanitizerSet::ADDRESS | SanitizerSet::KERNELADDRESS | SanitizerSet::MEMORY | SanitizerSet::HWADDRESS)
596+
|| self.is_sanitizer_address_enabled()
597+
|| self.is_sanitizer_kernel_address_enabled()
598+
|| self.is_sanitizer_memory_enabled()
599+
|| self.is_sanitizer_hwaddress_enabled()
569600
}
570601

571602
pub fn diagnostic_width(&self) -> usize {
@@ -693,7 +724,7 @@ impl Session {
693724
let more_names = self.opts.output_types.contains_key(&OutputType::LlvmAssembly)
694725
|| self.opts.output_types.contains_key(&OutputType::Bitcode)
695726
// AddressSanitizer and MemorySanitizer use alloca name when reporting an issue.
696-
|| self.opts.unstable_opts.sanitizer.intersects(SanitizerSet::ADDRESS | SanitizerSet::MEMORY);
727+
|| self.is_sanitizer_address_enabled() || self.is_sanitizer_memory_enabled();
697728
!more_names
698729
}
699730
}
@@ -1140,14 +1171,19 @@ fn validate_commandline_args_with_session_available(sess: &Session) {
11401171
}
11411172
}
11421173

1143-
// Sanitizers can only be used on platforms that we know have working sanitizer codegen.
1144-
let supported_sanitizers = sess.target.options.supported_sanitizers;
1145-
let mut unsupported_sanitizers = sess.opts.unstable_opts.sanitizer - supported_sanitizers;
1174+
let supported_sanitizers = if sess.unstable_options() {
1175+
sess.target.options.supported_sanitizers | sess.target.options.stable_sanitizers
1176+
} else {
1177+
sess.target.options.stable_sanitizers
1178+
};
1179+
let mut unsupported_sanitizers = sess.opts.cg.sanitize - supported_sanitizers;
1180+
11461181
// Niche: if `fixed-x18`, or effectively switching on `reserved-x18` flag, is enabled
11471182
// we should allow Shadow Call Stack sanitizer.
11481183
if sess.opts.unstable_opts.fixed_x18 && sess.target.arch == "aarch64" {
11491184
unsupported_sanitizers -= SanitizerSet::SHADOWCALLSTACK;
11501185
}
1186+
11511187
match unsupported_sanitizers.into_iter().count() {
11521188
0 => {}
11531189
1 => {
@@ -1162,18 +1198,15 @@ fn validate_commandline_args_with_session_available(sess: &Session) {
11621198
}
11631199

11641200
// Cannot mix and match mutually-exclusive sanitizers.
1165-
if let Some((first, second)) = sess.opts.unstable_opts.sanitizer.mutually_exclusive() {
1201+
if let Some((first, second)) = sess.opts.cg.sanitize.mutually_exclusive() {
11661202
sess.dcx().emit_err(errors::CannotMixAndMatchSanitizers {
11671203
first: first.to_string(),
11681204
second: second.to_string(),
11691205
});
11701206
}
11711207

11721208
// Cannot enable crt-static with sanitizers on Linux
1173-
if sess.crt_static(None)
1174-
&& !sess.opts.unstable_opts.sanitizer.is_empty()
1175-
&& !sess.target.is_like_msvc
1176-
{
1209+
if sess.crt_static(None) && !sess.opts.cg.sanitize.is_empty() && !sess.target.is_like_msvc {
11771210
sess.dcx().emit_err(errors::CannotEnableCrtStaticLinux);
11781211
}
11791212

compiler/rustc_target/src/spec/json.rs

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ use serde_json::Value;
66

77
use super::{Target, TargetKind, TargetOptions, TargetWarnings};
88
use crate::json::{Json, ToJson};
9+
use crate::spec::SanitizerSet;
910

1011
impl Target {
1112
/// Loads a target descriptor from a JSON object.
@@ -351,32 +352,15 @@ impl Target {
351352
} );
352353
($key_name:ident, SanitizerSet) => ( {
353354
let name = (stringify!($key_name)).replace("_", "-");
354-
if let Some(o) = obj.remove(&name) {
355-
if let Some(a) = o.as_array() {
356-
for s in a {
357-
use super::SanitizerSet;
358-
base.$key_name |= match s.as_str() {
359-
Some("address") => SanitizerSet::ADDRESS,
360-
Some("cfi") => SanitizerSet::CFI,
361-
Some("dataflow") => SanitizerSet::DATAFLOW,
362-
Some("kcfi") => SanitizerSet::KCFI,
363-
Some("kernel-address") => SanitizerSet::KERNELADDRESS,
364-
Some("leak") => SanitizerSet::LEAK,
365-
Some("memory") => SanitizerSet::MEMORY,
366-
Some("memtag") => SanitizerSet::MEMTAG,
367-
Some("safestack") => SanitizerSet::SAFESTACK,
368-
Some("shadow-call-stack") => SanitizerSet::SHADOWCALLSTACK,
369-
Some("thread") => SanitizerSet::THREAD,
370-
Some("hwaddress") => SanitizerSet::HWADDRESS,
371-
Some(s) => return Err(format!("unknown sanitizer {}", s)),
372-
_ => return Err(format!("not a string: {:?}", s)),
373-
};
374-
}
375-
} else {
376-
incorrect_type.push(name)
377-
}
378-
}
379-
Ok::<(), String>(())
355+
obj.remove(&name).and_then(|o| match SanitizerSet::from_json(&o) {
356+
Ok(v) => {
357+
base.$key_name = v;
358+
Some(Ok(()))
359+
},
360+
Err(s) => Some(Err(
361+
format!("`{:?}` is not a valid value for `{}`: {}", o, name, s)
362+
)),
363+
}).unwrap_or(Ok(()))
380364
} );
381365
($key_name:ident, link_self_contained_components) => ( {
382366
// Skeleton of what needs to be parsed:
@@ -649,6 +633,7 @@ impl Target {
649633
key!(split_debuginfo, SplitDebuginfo)?;
650634
key!(supported_split_debuginfo, fallible_list)?;
651635
key!(supported_sanitizers, SanitizerSet)?;
636+
key!(stable_sanitizers, SanitizerSet)?;
652637
key!(generate_arange_section, bool);
653638
key!(supports_stack_protector, bool);
654639
key!(small_data_threshold_support, SmallDataThresholdSupport)?;
@@ -827,6 +812,7 @@ impl ToJson for Target {
827812
target_option_val!(split_debuginfo);
828813
target_option_val!(supported_split_debuginfo);
829814
target_option_val!(supported_sanitizers);
815+
target_option_val!(stable_sanitizers);
830816
target_option_val!(c_enum_min_bits);
831817
target_option_val!(generate_arange_section);
832818
target_option_val!(supports_stack_protector);

0 commit comments

Comments
 (0)