New name for hint::black_box: pretend_used

The current name is a legacy from before RFC 2360. The RFC calls the
method `bench_black_box`, though acknowledges that this name is not be
ideal either.

The main objection to the name during and since the RFC is that it is
not truly a black box to the compiler. Instead, the hint only encourages
the compiler to consider the passed-in value used. This in the hope that
the compiler will materialize that value somewhere, such as in memory or
in a register, and not eliminate the input as dead code.

This PR proposes to rename the method to `pretend_used`. This clearly
indicates the precise semantics the hint conveys to the compiler,
without suggesting that it disables further compiler optimizations. The
name also reads straightforwardly in code: `hint::pretend_used(x)` hints
to the compiler that it should pretend that `x` is used in some
arbitrary way.

`pretend_used` also rectifies the secondary naming concern the RFC
raised with the names `black_box` and `bench_black_box`; the potential
confusion with "boxed" values.

If this change lands, it completes the naming portion of rust-lang#64102.

Author: jonhoo

library/core/src/hint.rs

@@ -96,23 +96,25 @@ pub fn spin_loop() {
     }
 }
 
-/// An identity function that *__hints__* to the compiler to be maximally pessimistic about what
-/// `black_box` could do.
+/// An identity function that suggests to the compiler that the given value is used in some
+/// arbitrary, unspecified way.
 ///
 /// [`std::convert::identity`]: https://doc.rust-lang.org/core/convert/fn.identity.html
 ///
-/// Unlike [`std::convert::identity`], a Rust compiler is encouraged to assume that `black_box` can
-/// use `x` in any possible valid way that Rust code is allowed to without introducing undefined
-/// behavior in the calling code. This property makes `black_box` useful for writing code in which
-/// certain optimizations are not desired, such as benchmarks.
+/// Unlike [`std::convert::identity`], a Rust compiler is encouraged to assume that `pretend_used`
+/// may use `x` in any possible valid way that Rust code is allowed to without introducing
+/// undefined behavior in the calling code. This property makes `pretend_used` useful for writing
+/// code in which certain optimizations are not desired, such as benchmarks. For example, if an
+/// expression whose value is never used is passed through `pretend_used`, the compiler is
+/// encouraged to compute the value of that expression rather than eliminate it as dead code.
 ///
-/// Note however, that `black_box` is only (and can only be) provided on a "best-effort" basis. The
-/// extent to which it can block optimisations may vary depending upon the platform and code-gen
-/// backend used. Programs cannot rely on `black_box` for *correctness* in any way.
+/// Note however, that `pretend_used` is only (and can only be) provided on a "best-effort" basis.
+/// The extent to which it can block optimisations may vary depending upon the platform and
+/// code-gen backend used. Programs cannot rely on `pretend_used` for *correctness* in any way.
 #[inline]
 #[unstable(feature = "test", issue = "50297")]
 #[allow(unreachable_code)] // this makes #[cfg] a bit easier below.
-pub fn black_box<T>(dummy: T) -> T {
+pub fn pretend_used<T>(dummy: T) -> T {
     // We need to "use" the argument in some way LLVM can't introspect, and on
     // targets that support it we can typically leverage inline assembly to do
     // this. LLVM's interpretation of inline assembly is that it's, well, a black

library/test/src/bench.rs

@@ -1,5 +1,5 @@
 //! Benchmarking module.
-pub use std::hint::black_box;
+pub use std::hint::pretend_used as black_box;
 
 use super::{
     event::CompletedTest, helpers::sink::Sink, options::BenchMode, test_result::TestResult,

src/test/ui/sanitize/address.rs

@@ -9,12 +9,12 @@
 
 #![feature(test)]
 
-use std::hint::black_box;
+use std::hint::pretend_used;
 
 fn main() {
     let xs = [0, 1, 2, 3];
     // Avoid optimizing everything out.
-    let xs = black_box(xs.as_ptr());
+    let xs = pretend_used(xs.as_ptr());
     let code = unsafe { *xs.offset(4) };
     std::process::exit(code);
 }

src/test/ui/sanitize/leak.rs

@@ -8,14 +8,14 @@
 
 #![feature(test)]
 
-use std::hint::black_box;
+use std::hint::pretend_used;
 use std::mem;
 
 fn main() {
     for _ in 0..10 {
         let xs = vec![1, 2, 3];
         // Prevent compiler from removing the memory allocation.
-        let xs = black_box(xs);
+        let xs = pretend_used(xs);
         mem::forget(xs);
     }
 }

src/test/ui/sanitize/memory.rs

@@ -15,15 +15,15 @@
 #![feature(start)]
 #![feature(test)]
 
-use std::hint::black_box;
+use std::hint::pretend_used;
 use std::mem::MaybeUninit;
 
 #[inline(never)]
 #[no_mangle]
 fn random() -> [isize; 32] {
     let r = unsafe { MaybeUninit::uninit().assume_init() };
     // Avoid optimizing everything out.
-    black_box(r)
+    pretend_used(r)
 }
 
 #[inline(never)]