Skip to content

Enable TrapUnreachable in LLVM. #45920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 16, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/libcompiler_builtins
7 changes: 7 additions & 0 deletions src/librustc_back/target/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -435,6 +435,10 @@ pub struct TargetOptions {

/// Default number of codegen units to use in debug mode
pub default_codegen_units: Option<u64>,

/// Whether to generate trap instructions in places where optimization would
/// otherwise produce control flow that falls through into unrelated memory.
pub trap_unreachable: bool,
}

impl Default for TargetOptions {
Expand Down Expand Up @@ -498,6 +502,7 @@ impl Default for TargetOptions {
stack_probes: false,
min_global_align: None,
default_codegen_units: None,
trap_unreachable: true,
}
}
}
Expand Down Expand Up @@ -739,6 +744,7 @@ impl Target {
key!(stack_probes, bool);
key!(min_global_align, Option<u64>);
key!(default_codegen_units, Option<u64>);
key!(trap_unreachable, bool);

if let Some(array) = obj.find("abi-blacklist").and_then(Json::as_array) {
for name in array.iter().filter_map(|abi| abi.as_string()) {
Expand Down Expand Up @@ -932,6 +938,7 @@ impl ToJson for Target {
target_option_val!(stack_probes);
target_option_val!(min_global_align);
target_option_val!(default_codegen_units);
target_option_val!(trap_unreachable);

if default.abi_blacklist != self.options.abi_blacklist {
d.insert("abi-blacklist".to_string(), self.options.abi_blacklist.iter()
Expand Down
3 changes: 2 additions & 1 deletion src/librustc_llvm/ffi.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1605,7 +1605,8 @@ extern "C" {
UseSoftFP: bool,
PositionIndependentExecutable: bool,
FunctionSections: bool,
DataSections: bool)
DataSections: bool,
TrapUnreachable: bool)
-> TargetMachineRef;
pub fn LLVMRustDisposeTargetMachine(T: TargetMachineRef);
pub fn LLVMRustAddAnalysisPasses(T: TargetMachineRef, PM: PassManagerRef, M: ModuleRef);
Expand Down
2 changes: 2 additions & 0 deletions src/librustc_trans/back/write.rs
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@ pub fn target_machine_factory(sess: &Session)
let cpu = CString::new(cpu.as_bytes()).unwrap();
let features = CString::new(target_feature(sess).as_bytes()).unwrap();
let is_pie_binary = is_pie_binary(sess);
let trap_unreachable = sess.target.target.options.trap_unreachable;

Arc::new(move || {
let tm = unsafe {
Expand All @@ -208,6 +209,7 @@ pub fn target_machine_factory(sess: &Session)
is_pie_binary,
ffunction_sections,
fdata_sections,
trap_unreachable,
)
};

Expand Down
10 changes: 9 additions & 1 deletion src/rustllvm/PassWrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ extern "C" LLVMTargetMachineRef LLVMRustCreateTargetMachine(
LLVMRustCodeModel RustCM, LLVMRustRelocMode RustReloc,
LLVMRustCodeGenOptLevel RustOptLevel, bool UseSoftFloat,
bool PositionIndependentExecutable, bool FunctionSections,
bool DataSections) {
bool DataSections, bool TrapUnreachable) {

auto CM = fromRust(RustCM);
auto OptLevel = fromRust(RustOptLevel);
Expand Down Expand Up @@ -398,6 +398,14 @@ extern "C" LLVMTargetMachineRef LLVMRustCreateTargetMachine(
Options.DataSections = DataSections;
Options.FunctionSections = FunctionSections;

if (TrapUnreachable) {
// Tell LLVM to translate `unreachable` into an explicit trap instruction.
// This limits the extent of possible undefined behavior in some cases, as
// it prevents control flow from "falling through" into whatever code
// happens to be laid out next in memory.
Options.TrapUnreachable = true;
}

TargetMachine *TM = TheTarget->createTargetMachine(
Trip.getTriple(), RealCPU, Feature, Options, RM, CM, OptLevel);
return wrap(TM);
Expand Down
7 changes: 6 additions & 1 deletion src/test/run-make/intrinsic-unreachable/exit-ret.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,15 @@
#![feature(asm)]
#![crate_type="lib"]

pub fn exit(n: usize) {
#[deny(unreachable_code)]
pub fn exit(n: usize) -> i32 {
unsafe {
// Pretend this asm is an exit() syscall.
asm!("" :: "r"(n) :: "volatile");
// Can't actually reach this point, but rustc doesn't know that.
}
// This return value is just here to generate some extra code for a return
// value, making it easier for the test script to detect whether the
// compiler deleted it.
42
}
7 changes: 6 additions & 1 deletion src/test/run-make/intrinsic-unreachable/exit-unreachable.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,15 @@

use std::intrinsics;

pub fn exit(n: usize) -> ! {
#[allow(unreachable_code)]
pub fn exit(n: usize) -> i32 {
unsafe {
// Pretend this asm is an exit() syscall.
asm!("" :: "r"(n) :: "volatile");
intrinsics::unreachable()
}
// This return value is just here to generate some extra code for a return
// value, making it easier for the test script to detect whether the
// compiler deleted it.
42
}