1 //! Implement thread-local storage.
3 use std::collections::BTreeMap;
4 use std::collections::btree_map::Entry as BTreeEntry;
5 use std::collections::hash_map::Entry as HashMapEntry;
9 use rustc_data_structures::fx::FxHashMap;
11 use rustc_target::abi::{Size, HasDataLayout};
12 use rustc_target::spec::abi::Abi;
16 pub type TlsKey = u128;
18 #[derive(Clone, Debug)]
19 pub struct TlsEntry<'tcx> {
20 /// The data for this key. None is used to represent NULL.
21 /// (We normalize this early to avoid having to do a NULL-ptr-test each time we access the data.)
22 data: BTreeMap<ThreadId, Scalar<Tag>>,
23 dtor: Option<ty::Instance<'tcx>>,
26 #[derive(Clone, Debug)]
27 struct RunningDtorsState {
28 /// The last TlsKey used to retrieve a TLS destructor. `None` means that we
29 /// have not tried to retrieve a TLS destructor yet or that we already tried
31 last_dtor_key: Option<TlsKey>,
35 pub struct TlsData<'tcx> {
36 /// The Key to use for the next thread-local allocation.
39 /// pthreads-style thread-local storage.
40 keys: BTreeMap<TlsKey, TlsEntry<'tcx>>,
42 /// A single per thread destructor of the thread local storage (that's how
43 /// things work on macOS) with a data argument.
44 macos_thread_dtors: BTreeMap<ThreadId, (ty::Instance<'tcx>, Scalar<Tag>)>,
46 /// State for currently running TLS dtors. If this map contains a key for a
47 /// specific thread, it means that we are in the "destruct" phase, during
48 /// which some operations are UB.
49 dtors_running: FxHashMap<ThreadId, RunningDtorsState>,
52 impl<'tcx> Default for TlsData<'tcx> {
53 fn default() -> Self {
55 next_key: 1, // start with 1 as we must not use 0 on Windows
56 keys: Default::default(),
57 macos_thread_dtors: Default::default(),
58 dtors_running: Default::default(),
63 impl<'tcx> TlsData<'tcx> {
64 /// Generate a new TLS key with the given destructor.
65 /// `max_size` determines the integer size the key has to fit in.
66 pub fn create_tls_key(&mut self, dtor: Option<ty::Instance<'tcx>>, max_size: Size) -> InterpResult<'tcx, TlsKey> {
67 let new_key = self.next_key;
69 self.keys.try_insert(new_key, TlsEntry { data: Default::default(), dtor }).unwrap();
70 trace!("New TLS key allocated: {} with dtor {:?}", new_key, dtor);
72 if max_size.bits() < 128 && new_key >= (1u128 << max_size.bits() as u128) {
73 throw_unsup_format!("we ran out of TLS key space");
78 pub fn delete_tls_key(&mut self, key: TlsKey) -> InterpResult<'tcx> {
79 match self.keys.remove(&key) {
81 trace!("TLS key {} removed", key);
84 None => throw_ub_format!("removing a non-existig TLS key: {}", key),
92 cx: &impl HasDataLayout,
93 ) -> InterpResult<'tcx, Scalar<Tag>> {
94 match self.keys.get(&key) {
95 Some(TlsEntry { data, .. }) => {
96 let value = data.get(&thread_id).copied();
97 trace!("TLS key {} for thread {:?} loaded: {:?}", key, thread_id, value);
98 Ok(value.unwrap_or_else(|| Scalar::null_ptr(cx).into()))
100 None => throw_ub_format!("loading from a non-existing TLS key: {}", key),
108 new_data: Option<Scalar<Tag>>
109 ) -> InterpResult<'tcx> {
110 match self.keys.get_mut(&key) {
111 Some(TlsEntry { data, .. }) => {
114 trace!("TLS key {} for thread {:?} stored: {:?}", key, thread_id, scalar);
115 data.insert(thread_id, scalar);
118 trace!("TLS key {} for thread {:?} removed", key, thread_id);
119 data.remove(&thread_id);
124 None => throw_ub_format!("storing to a non-existing TLS key: {}", key),
128 /// Set the thread wide destructor of the thread local storage for the given
129 /// thread. This function is used to implement `_tlv_atexit` shim on MacOS.
131 /// Thread wide dtors are available only on MacOS. There is one destructor
132 /// per thread as can be guessed from the following comment in the
134 /// implementation](https://github.com/opensource-apple/dyld/blob/195030646877261f0c8c7ad8b001f52d6a26f514/src/threadLocalVariables.c#L389):
136 /// // NOTE: this does not need locks because it only operates on current thread data
137 pub fn set_macos_thread_dtor(
140 dtor: ty::Instance<'tcx>,
142 ) -> InterpResult<'tcx> {
143 if self.dtors_running.contains_key(&thread) {
144 // UB, according to libstd docs.
145 throw_ub_format!("setting thread's local storage destructor while destructors are already running");
147 if self.macos_thread_dtors.insert(thread, (dtor, data)).is_some() {
148 throw_unsup_format!("setting more than one thread local storage destructor for the same thread is not supported");
153 /// Returns a dtor, its argument and its index, if one is supposed to run.
154 /// `key` is the last dtors that was run; we return the *next* one after that.
156 /// An optional destructor function may be associated with each key value.
157 /// At thread exit, if a key value has a non-NULL destructor pointer,
158 /// and the thread has a non-NULL value associated with that key,
159 /// the value of the key is set to NULL, and then the function pointed
160 /// to is called with the previously associated value as its sole argument.
161 /// The order of destructor calls is unspecified if more than one destructor
162 /// exists for a thread when it exits.
164 /// If, after all the destructors have been called for all non-NULL values
165 /// with associated destructors, there are still some non-NULL values with
166 /// associated destructors, then the process is repeated.
167 /// If, after at least {PTHREAD_DESTRUCTOR_ITERATIONS} iterations of destructor
168 /// calls for outstanding non-NULL values, there are still some non-NULL values
169 /// with associated destructors, implementations may stop calling destructors,
170 /// or they may continue calling destructors until no non-NULL values with
171 /// associated destructors exist, even though this might result in an infinite loop.
176 ) -> Option<(ty::Instance<'tcx>, Scalar<Tag>, TlsKey)> {
177 use std::ops::Bound::*;
179 let thread_local = &mut self.keys;
180 let start = match key {
181 Some(key) => Excluded(key),
184 for (&key, TlsEntry { data, dtor }) in
185 thread_local.range_mut((start, Unbounded))
187 match data.entry(thread_id) {
188 BTreeEntry::Occupied(entry) => {
189 if let Some(dtor) = dtor {
190 // Set TLS data to NULL, and call dtor with old value.
191 let data_scalar = entry.remove();
192 let ret = Some((*dtor, data_scalar, key));
196 BTreeEntry::Vacant(_) => {}
202 /// Set that dtors are running for `thread`. It is guaranteed not to change
203 /// the existing values stored in `dtors_running` for this thread. Returns
204 /// `true` if dtors for `thread` are already running.
205 fn set_dtors_running_for_thread(&mut self, thread: ThreadId) -> bool {
206 match self.dtors_running.entry(thread) {
207 HashMapEntry::Occupied(_) => true,
208 HashMapEntry::Vacant(entry) => {
209 // We cannot just do `self.dtors_running.insert` because that
210 // would overwrite `last_dtor_key` with `None`.
211 entry.insert(RunningDtorsState { last_dtor_key: None });
217 /// Delete all TLS entries for the given thread. This function should be
218 /// called after all TLS destructors have already finished.
219 fn delete_all_thread_tls(&mut self, thread_id: ThreadId) {
220 for TlsEntry { data, .. } in self.keys.values_mut() {
221 data.remove(&thread_id);
226 impl<'mir, 'tcx: 'mir> EvalContextPrivExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
227 trait EvalContextPrivExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
228 /// Schedule TLS destructors for the main thread on Windows. The
229 /// implementation assumes that we do not support concurrency on Windows
231 fn schedule_windows_tls_dtors(&mut self) -> InterpResult<'tcx> {
232 let this = self.eval_context_mut();
233 let active_thread = this.get_active_thread();
234 assert_eq!(this.get_total_thread_count(), 1, "concurrency on Windows is not supported");
235 // Windows has a special magic linker section that is run on certain events.
236 // Instead of searching for that section and supporting arbitrary hooks in there
237 // (that would be basically https://github.com/rust-lang/miri/issues/450),
238 // we specifically look up the static in libstd that we know is placed
240 let thread_callback = this.eval_path_scalar(&["std", "sys", "windows", "thread_local_key", "p_thread_callback"])?;
241 let thread_callback = this.memory.get_fn(thread_callback.check_init()?)?.as_instance()?;
243 // The signature of this function is `unsafe extern "system" fn(h: c::LPVOID, dwReason: c::DWORD, pv: c::LPVOID)`.
244 let reason = this.eval_path_scalar(&["std", "sys", "windows", "c", "DLL_THREAD_DETACH"])?;
245 let ret_place = MPlaceTy::dangling(this.machine.layouts.unit, this).into();
248 Abi::System { unwind: false },
249 &[Scalar::null_ptr(this).into(), reason.into(), Scalar::null_ptr(this).into()],
251 StackPopCleanup::None { cleanup: true },
254 this.enable_thread(active_thread);
258 /// Schedule the MacOS thread destructor of the thread local storage to be
259 /// executed. Returns `true` if scheduled.
261 /// Note: It is safe to call this function also on other Unixes.
262 fn schedule_macos_tls_dtor(&mut self) -> InterpResult<'tcx, bool> {
263 let this = self.eval_context_mut();
264 let thread_id = this.get_active_thread();
265 if let Some((instance, data)) = this.machine.tls.macos_thread_dtors.remove(&thread_id) {
266 trace!("Running macos dtor {:?} on {:?} at {:?}", instance, data, thread_id);
268 let ret_place = MPlaceTy::dangling(this.machine.layouts.unit, this).into();
271 Abi::C { unwind: false },
274 StackPopCleanup::None { cleanup: true },
277 // Enable the thread so that it steps through the destructor which
278 // we just scheduled. Since we deleted the destructor, it is
279 // guaranteed that we will schedule it again. The `dtors_running`
280 // flag will prevent the code from adding the destructor again.
281 this.enable_thread(thread_id);
288 /// Schedule a pthread TLS destructor. Returns `true` if found
289 /// a destructor to schedule, and `false` otherwise.
290 fn schedule_next_pthread_tls_dtor(&mut self) -> InterpResult<'tcx, bool> {
291 let this = self.eval_context_mut();
292 let active_thread = this.get_active_thread();
294 assert!(this.has_terminated(active_thread), "running TLS dtors for non-terminated thread");
295 // Fetch next dtor after `key`.
296 let last_key = this.machine.tls.dtors_running[&active_thread].last_dtor_key.clone();
297 let dtor = match this.machine.tls.fetch_tls_dtor(last_key, active_thread) {
298 dtor @ Some(_) => dtor,
299 // We ran each dtor once, start over from the beginning.
301 this.machine.tls.fetch_tls_dtor(None, active_thread)
304 if let Some((instance, ptr, key)) = dtor {
305 this.machine.tls.dtors_running.get_mut(&active_thread).unwrap().last_dtor_key = Some(key);
306 trace!("Running TLS dtor {:?} on {:?} at {:?}", instance, ptr, active_thread);
307 assert!(!this.is_null(ptr).unwrap(), "data can't be NULL when dtor is called!");
309 let ret_place = MPlaceTy::dangling(this.machine.layouts.unit, this).into();
312 Abi::C { unwind: false },
315 StackPopCleanup::None { cleanup: true },
318 this.enable_thread(active_thread);
321 this.machine.tls.dtors_running.get_mut(&active_thread).unwrap().last_dtor_key = None;
327 impl<'mir, 'tcx: 'mir> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
328 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
330 /// Schedule an active thread's TLS destructor to run on the active thread.
331 /// Note that this function does not run the destructors itself, it just
332 /// schedules them one by one each time it is called and reenables the
333 /// thread so that it can be executed normally by the main execution loop.
335 /// Note: we consistently run TLS destructors for all threads, including the
336 /// main thread. However, it is not clear that we should run the TLS
337 /// destructors for the main thread. See issue:
338 /// https://github.com/rust-lang/rust/issues/28129.
339 fn schedule_next_tls_dtor_for_active_thread(&mut self) -> InterpResult<'tcx> {
340 let this = self.eval_context_mut();
341 let active_thread = this.get_active_thread();
343 if !this.machine.tls.set_dtors_running_for_thread(active_thread) {
344 // This is the first time we got asked to schedule a destructor. The
345 // Windows schedule destructor function must be called exactly once,
346 // this is why it is in this block.
347 if this.tcx.sess.target.os == "windows" {
348 // On Windows, we signal that the thread quit by starting the
349 // relevant function, reenabling the thread, and going back to
351 this.schedule_windows_tls_dtors()?;
355 // The remaining dtors make some progress each time around the scheduler loop,
356 // until they return `false` to indicate that they are done.
358 // The macOS thread wide destructor runs "before any TLS slots get
359 // freed", so do that first.
360 if this.schedule_macos_tls_dtor()? {
361 // We have scheduled a MacOS dtor to run on the thread. Execute it
362 // to completion and come back here. Scheduling a destructor
363 // destroys it, so we will not enter this branch again.
366 if this.schedule_next_pthread_tls_dtor()? {
367 // We have scheduled a pthread destructor and removed it from the
368 // destructors list. Run it to completion and come back here.
373 this.machine.tls.delete_all_thread_tls(active_thread);
374 this.thread_terminated()?;