f lockmetadata

Author: TheBlueMatt

lightning/src/debug_sync.rs

@@ -43,30 +43,30 @@ impl Condvar {
 }
 
 thread_local! {
-	/// We track the set of locks currently held by a reference to their `MutexMetadata`
-	static LOCKS_HELD: RefCell<HashSet<Arc<MutexMetadata>>> = RefCell::new(HashSet::new());
+	/// We track the set of locks currently held by a reference to their `LockMetadata`
+	static LOCKS_HELD: RefCell<HashSet<Arc<LockMetadata>>> = RefCell::new(HashSet::new());
 }
 static LOCK_IDX: AtomicUsize = AtomicUsize::new(0);
 
 /// Metadata about a single lock, by id, the set of things locked-before it, and the backtrace of
 /// when the Mutex itself was constructed.
-struct MutexMetadata {
+struct LockMetadata {
 	lock_idx: u64,
-	locked_before: StdMutex<HashSet<Arc<MutexMetadata>>>,
+	locked_before: StdMutex<HashSet<Arc<LockMetadata>>>,
 	#[cfg(feature = "backtrace")]
 	lock_construction_bt: Backtrace,
 }
-impl PartialEq for MutexMetadata {
-	fn eq(&self, o: &MutexMetadata) -> bool { self.lock_idx == o.lock_idx }
+impl PartialEq for LockMetadata {
+	fn eq(&self, o: &LockMetadata) -> bool { self.lock_idx == o.lock_idx }
 }
-impl Eq for MutexMetadata {}
-impl std::hash::Hash for MutexMetadata {
+impl Eq for LockMetadata {}
+impl std::hash::Hash for LockMetadata {
 	fn hash<H: std::hash::Hasher>(&self, hasher: &mut H) { hasher.write_u64(self.lock_idx); }
 }
 
-impl MutexMetadata {
-	fn new() -> MutexMetadata {
-		MutexMetadata {
+impl LockMetadata {
+	fn new() -> LockMetadata {
+		LockMetadata {
 			locked_before: StdMutex::new(HashSet::new()),
 			lock_idx: LOCK_IDX.fetch_add(1, Ordering::Relaxed) as u64,
 			#[cfg(feature = "backtrace")]
@@ -75,7 +75,7 @@ impl MutexMetadata {
 	}
 
 	// Returns whether we were a recursive lock (only relevant for read)
-	fn _pre_lock(this: &Arc<MutexMetadata>, read: bool) -> bool {
+	fn _pre_lock(this: &Arc<LockMetadata>, read: bool) -> bool {
 		let mut inserted = false;
 		LOCKS_HELD.with(|held| {
 			// For each lock which is currently locked, check that no lock's locked-before
@@ -108,10 +108,10 @@ impl MutexMetadata {
 		inserted
 	}
 
-	fn pre_lock(this: &Arc<MutexMetadata>) { Self::_pre_lock(this, false); }
-	fn pre_read_lock(this: &Arc<MutexMetadata>) -> bool { Self::_pre_lock(this, true) }
+	fn pre_lock(this: &Arc<LockMetadata>) { Self::_pre_lock(this, false); }
+	fn pre_read_lock(this: &Arc<LockMetadata>) -> bool { Self::_pre_lock(this, true) }
 
-	fn try_locked(this: &Arc<MutexMetadata>) {
+	fn try_locked(this: &Arc<LockMetadata>) {
 		LOCKS_HELD.with(|held| {
 			// Since a try-lock will simply fail if the lock is held already, we do not
 			// consider try-locks to ever generate lockorder inversions. However, if a try-lock
@@ -126,7 +126,7 @@ impl MutexMetadata {
 
 pub struct Mutex<T: Sized> {
 	inner: StdMutex<T>,
-	deps: Arc<MutexMetadata>,
+	deps: Arc<LockMetadata>,
 }
 
 #[must_use = "if unused the Mutex will immediately unlock"]
@@ -170,26 +170,26 @@ impl<T: Sized> DerefMut for MutexGuard<'_, T> {
 
 impl<T> Mutex<T> {
 	pub fn new(inner: T) -> Mutex<T> {
-		Mutex { inner: StdMutex::new(inner), deps: Arc::new(MutexMetadata::new()) }
+		Mutex { inner: StdMutex::new(inner), deps: Arc::new(LockMetadata::new()) }
 	}
 
 	pub fn lock<'a>(&'a self) -> LockResult<MutexGuard<'a, T>> {
-		MutexMetadata::pre_lock(&self.deps);
+		LockMetadata::pre_lock(&self.deps);
 		self.inner.lock().map(|lock| MutexGuard { mutex: self, lock }).map_err(|_| ())
 	}
 
 	pub fn try_lock<'a>(&'a self) -> LockResult<MutexGuard<'a, T>> {
 		let res = self.inner.try_lock().map(|lock| MutexGuard { mutex: self, lock }).map_err(|_| ());
 		if res.is_ok() {
-			MutexMetadata::try_locked(&self.deps);
+			LockMetadata::try_locked(&self.deps);
 		}
 		res
 	}
 }
 
 pub struct RwLock<T: Sized> {
 	inner: StdRwLock<T>,
-	deps: Arc<MutexMetadata>,
+	deps: Arc<LockMetadata>,
 }
 
 pub struct RwLockReadGuard<'a, T: Sized + 'a> {
@@ -249,23 +249,23 @@ impl<T: Sized> DerefMut for RwLockWriteGuard<'_, T> {
 
 impl<T> RwLock<T> {
 	pub fn new(inner: T) -> RwLock<T> {
-		RwLock { inner: StdRwLock::new(inner), deps: Arc::new(MutexMetadata::new()) }
+		RwLock { inner: StdRwLock::new(inner), deps: Arc::new(LockMetadata::new()) }
 	}
 
 	pub fn read<'a>(&'a self) -> LockResult<RwLockReadGuard<'a, T>> {
-		let first_lock = MutexMetadata::pre_read_lock(&self.deps);
+		let first_lock = LockMetadata::pre_read_lock(&self.deps);
 		self.inner.read().map(|guard| RwLockReadGuard { lock: self, guard, first_lock }).map_err(|_| ())
 	}
 
 	pub fn write<'a>(&'a self) -> LockResult<RwLockWriteGuard<'a, T>> {
-		MutexMetadata::pre_lock(&self.deps);
+		LockMetadata::pre_lock(&self.deps);
 		self.inner.write().map(|guard| RwLockWriteGuard { lock: self, guard }).map_err(|_| ())
 	}
 
 	pub fn try_write<'a>(&'a self) -> LockResult<RwLockWriteGuard<'a, T>> {
 		let res = self.inner.try_write().map(|guard| RwLockWriteGuard { lock: self, guard }).map_err(|_| ());
 		if res.is_ok() {
-			MutexMetadata::try_locked(&self.deps);
+			LockMetadata::try_locked(&self.deps);
 		}
 		res
 	}