Skip to content

Commit cad3e4c

Browse files
authored
Rollup merge of rust-lang#59336 - gnzlbg:hint_black_box, r=alexcrichton
Moves test::black_box to core::hint and fix black_box on wasm32 and asm.js This changes removes a cyclic dependency between the "test" and "libtest" crates, where "libtest" depends on "test" for "black_box", but "test" depends on "libtest" for everything else. I've chosen the "hint" module because there seems to be enough consensus in the discussion of RFC2360 that this module is where such an intrinsic would belong, but this PR does not implement that RFC! If that RFC ever gets merged, the API, docs, etc. of this API will need to change. This PR just move the implementation of the already existing API. For backwards compatibility reasons I've chosen to also keep the "test" feature gate for these instead of adding a new feature gate. If we change the feature gate, we'll potentially all benchmarks, and while that's something that we could do, it seems unnecessary to do that now - if RFC2360 gets merged, we'll need to do that anyways. Backwards compatibility is also why we continue to re-export "black_box" from the "test" crate. This PR also fixes black_box on the wasm32 target, which now supports inline assembly, and uses volatile loads on the asm.js target. r? @Amanieu (cc @rust-lang/libs)
2 parents 48c22d9 + 24db517 commit cad3e4c

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

src/libcore/hint.rs

+22
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,25 @@ pub fn spin_loop() {
9191
}
9292
}
9393
}
94+
95+
/// A function that is opaque to the optimizer, to allow benchmarks to
96+
/// pretend to use outputs to assist in avoiding dead-code
97+
/// elimination.
98+
///
99+
/// This function is a no-op, and does not even read from `dummy`.
100+
#[unstable(feature = "test", issue = "27812")]
101+
pub fn black_box<T>(dummy: T) -> T {
102+
#[cfg(not(target_arch = "asmjs"))] {
103+
// we need to "use" the argument in some way LLVM can't
104+
// introspect.
105+
unsafe { asm!("" : : "r"(&dummy)) }
106+
dummy
107+
}
108+
#[cfg(target_arch = "asmjs")] {
109+
unsafe {
110+
let ret = crate::ptr::read_volatile(&dummy);
111+
crate::mem::forget(dummy);
112+
ret
113+
}
114+
}
115+
}

src/libtest/lib.rs

+1-17
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,7 @@ pub use libtest::{
2727
TestResult, TrFailed, TrFailedMsg, TrIgnored, TrOk, stats::Summary
2828
};
2929

30-
/// A function that is opaque to the optimizer, to allow benchmarks to
31-
/// pretend to use outputs to assist in avoiding dead-code
32-
/// elimination.
33-
///
34-
/// This function is a no-op, and does not even read from `dummy`.
35-
#[cfg(not(any(target_arch = "asmjs", target_arch = "wasm32")))]
36-
pub fn black_box<T>(dummy: T) -> T {
37-
// we need to "use" the argument in some way LLVM can't
38-
// introspect.
39-
unsafe { asm!("" : : "r"(&dummy)) }
40-
dummy
41-
}
42-
#[cfg(any(target_arch = "asmjs", target_arch = "wasm32"))]
43-
#[inline(never)]
44-
pub fn black_box<T>(dummy: T) -> T {
45-
dummy
46-
}
30+
pub use std::hint::black_box;
4731

4832
#[cfg(test)]
4933
mod tests {

0 commit comments

Comments
 (0)