Revision control
Copy as Markdown
Other Tools
#![allow(unused)]
use crate::lock::{RwLock, RwLockReadGuard, RwLockWriteGuard};
use std::{
backtrace::Backtrace,
cell::{Cell, RefCell, UnsafeCell},
panic::{self, Location},
thread,
};
use crate::lock::rank;
/// A guard that provides read access to snatchable data.
pub struct SnatchGuard<'a>(RwLockReadGuard<'a, ()>);
/// A guard that allows snatching the snatchable data.
pub struct ExclusiveSnatchGuard<'a>(RwLockWriteGuard<'a, ()>);
/// A value that is mostly immutable but can be "snatched" if we need to destroy
/// it early.
///
/// In order to safely access the underlying data, the device's global snatchable
/// lock must be taken. To guarantee it, methods take a read or write guard of that
/// special lock.
pub struct Snatchable<T> {
value: UnsafeCell<Option<T>>,
}
impl<T> Snatchable<T> {
pub fn new(val: T) -> Self {
Snatchable {
value: UnsafeCell::new(Some(val)),
}
}
pub fn empty() -> Self {
Snatchable {
value: UnsafeCell::new(None),
}
}
/// Get read access to the value. Requires a the snatchable lock's read guard.
pub fn get<'a>(&'a self, _guard: &'a SnatchGuard) -> Option<&'a T> {
unsafe { (*self.value.get()).as_ref() }
}
/// Take the value. Requires a the snatchable lock's write guard.
pub fn snatch(&self, _guard: &mut ExclusiveSnatchGuard) -> Option<T> {
unsafe { (*self.value.get()).take() }
}
/// Take the value without a guard. This can only be used with exclusive access
/// to self, so it does not require locking.
///
/// Typically useful in a drop implementation.
pub fn take(&mut self) -> Option<T> {
self.value.get_mut().take()
}
}
// Can't safely print the contents of a snatchable object without holding
// the lock.
impl<T> std::fmt::Debug for Snatchable<T> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "<snatchable>")
}
}
unsafe impl<T> Sync for Snatchable<T> {}
struct LockTrace {
purpose: &'static str,
caller: &'static Location<'static>,
backtrace: Backtrace,
}
impl std::fmt::Display for LockTrace {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"a {} lock at {}\n{}",
self.purpose, self.caller, self.backtrace
)
}
}
#[cfg(debug_assertions)]
impl LockTrace {
#[track_caller]
fn enter(purpose: &'static str) {
let new = LockTrace {
purpose,
caller: Location::caller(),
backtrace: Backtrace::capture(),
};
if let Some(prev) = SNATCH_LOCK_TRACE.take() {
let current = thread::current();
let name = current.name().unwrap_or("<unnamed>");
panic!(
"thread '{name}' attempted to acquire a snatch lock recursively.\n\
- Currently trying to acquire {new}\n\
- Previously acquired {prev}",
);
} else {
SNATCH_LOCK_TRACE.set(Some(new));
}
}
fn exit() {
SNATCH_LOCK_TRACE.take();
}
}
#[cfg(not(debug_assertions))]
impl LockTrace {
fn enter(purpose: &'static str) {}
fn exit() {}
}
thread_local! {
static SNATCH_LOCK_TRACE: Cell<Option<LockTrace>> = const { Cell::new(None) };
}
/// A Device-global lock for all snatchable data.
pub struct SnatchLock {
lock: RwLock<()>,
}
impl SnatchLock {
/// The safety of `Snatchable::get` and `Snatchable::snatch` rely on their using of the
/// right SnatchLock (the one associated to the same device). This method is unsafe
/// to force force sers to think twice about creating a SnatchLock. The only place this
/// method should be called is when creating the device.
pub unsafe fn new(rank: rank::LockRank) -> Self {
SnatchLock {
lock: RwLock::new(rank, ()),
}
}
/// Request read access to snatchable resources.
#[track_caller]
pub fn read(&self) -> SnatchGuard {
LockTrace::enter("read");
SnatchGuard(self.lock.read())
}
/// Request write access to snatchable resources.
///
/// This should only be called when a resource needs to be snatched. This has
/// a high risk of causing lock contention if called concurrently with other
/// wgpu work.
#[track_caller]
pub fn write(&self) -> ExclusiveSnatchGuard {
LockTrace::enter("write");
ExclusiveSnatchGuard(self.lock.write())
}
}
impl Drop for SnatchGuard<'_> {
fn drop(&mut self) {
LockTrace::exit();
}
}
impl Drop for ExclusiveSnatchGuard<'_> {
fn drop(&mut self) {
LockTrace::exit();
}
}