Skip to content
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

fix pthread-based tls on apple targets #137897

Merged
merged 1 commit into from
Apr 5, 2025
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
1 change: 1 addition & 0 deletions library/std/src/sys/thread_local/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ pub(crate) mod key {
not(target_family = "wasm"),
target_family = "unix",
),
all(not(target_thread_local), target_vendor = "apple"),
target_os = "teeos",
all(target_os = "wasi", target_env = "p1", target_feature = "atomics"),
))] {
Expand Down
2 changes: 2 additions & 0 deletions library/std/tests/thread_local/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#![feature(cfg_target_thread_local)]

#[cfg(not(any(target_os = "emscripten", target_os = "wasi")))]
mod tests;

Expand Down
21 changes: 20 additions & 1 deletion library/std/tests/thread_local/tests.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use std::cell::{Cell, UnsafeCell};
use std::sync::atomic::{AtomicU8, Ordering};
use std::sync::{Arc, Condvar, Mutex};
use std::thread::{self, Builder, LocalKey};
use std::thread::{self, LocalKey};
use std::thread_local;

#[derive(Clone, Default)]
Expand Down Expand Up @@ -345,8 +345,27 @@ fn join_orders_after_tls_destructors() {
}

// Test that thread::current is still available in TLS destructors.
//
// The test won't currently work without target_thread_local, aka with slow tls.
// The runtime tries very hard to drop last the TLS variable that keeps the information about the
// current thread, by using several tricks like deffering the drop to a later round of TLS destruction.
// However, this only seems to work with fast tls.
//
// With slow TLS, it seems that multiple libc implementations will just set the value to null the first
// time they encounter it, regardless of it having a destructor or not. This means that trying to
// retrieve it later in a drop impl of another TLS variable will not work.
//
// ** Apple libc: https://github.com/apple-oss-distributions/libpthread/blob/c032e0b076700a0a47db75528a282b8d3a06531a/src/pthread_tsd.c#L293
// Sets the variable to null if it has a destructor and the value is not null. However, all variables
// created with pthread_key_create are marked as having a destructor, even if the fn ptr called with
// it is null.
// ** glibc: https://github.com/bminor/glibc/blob/e5893e6349541d871e8a25120bca014551d13ff5/nptl/nptl_deallocate_tsd.c#L59
// ** musl: https://github.com/kraj/musl/blob/1880359b54ff7dd9f5016002bfdae4b136007dde/src/thread/pthread_key_create.c#L87
#[cfg(target_thread_local)]
#[test]
fn thread_current_in_dtor() {
use std::thread::Builder;

// Go through one round of TLS destruction first.
struct Defer;
impl Drop for Defer {
Expand Down
37 changes: 37 additions & 0 deletions tests/run-make/apple-slow-tls/rmake.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
//! Test if compilation with has-thread-local=false works, and if the output
//! has indeed no fast TLS variables.

//@ only-apple

use run_make_support::serde_json::{self, Value};
use run_make_support::{cargo, llvm_nm, rfs, rustc};

fn main() {
let output =
rustc().print("target-spec-json").args(["-Z", "unstable-options"]).run().stdout_utf8();

let mut target_json: Value = serde_json::from_str(&output).unwrap();
let has_thread_local = &mut target_json["has-thread-local"];
assert!(matches!(has_thread_local, Value::Bool(true)), "{:?}", has_thread_local);
*has_thread_local = Value::Bool(false);

let out_path = "t.json";
rfs::write(out_path, serde_json::to_string(&target_json).unwrap());

cargo()
.args([
"b",
"--manifest-path",
"tls_test/Cargo.toml",
"--target",
"t.json",
"-Zbuild-std=std,core,panic_abort",
])
.run();

// If a binary has any fast TLS variables, it should also contain the symbols
// __tlv_bootstrap and __tlv_atexit. We don't want them.
let output = llvm_nm().arg("tls_test/target/t/debug/tls_test").run().stdout_utf8();
assert!(!output.contains("_tlv_bootstrap"));
assert!(!output.contains("_tlv_atexit"));
}
6 changes: 6 additions & 0 deletions tests/run-make/apple-slow-tls/tls_test/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[package]
name = "tls_test"
version = "0.1.0"
edition = "2024"

[dependencies]
10 changes: 10 additions & 0 deletions tests/run-make/apple-slow-tls/tls_test/src/main.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
use std::cell::RefCell;

fn main() {
thread_local! {
static S: RefCell<String> = RefCell::default();
}

S.with(|x| *x.borrow_mut() = "pika pika".to_string());
S.with(|x| println!("{}", x.borrow()));
}
Loading