Skip to contentSkip to conversation

rust: locks: Add `get_mut` method to `Lock`

PATCH Superseded Mathys-Gasnier 3 participants 3 messages Feb 9, 2024

Subsystems (3)

v1 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rust: locks: Add `get_mut` method to `Lock`

Having a mutable reference guarantees that no other threads have access to the lock, so we can take advantage of that to grant callers access to the protected data without the the cost of acquiring and releasing the locks. Since the lifetime of the data is tied to the mutable reference, the borrow checker guarantees that the usage is safe.

---
 rust/kernel/sync/lock.rs | 5 +++++
 1 file changed, 5 insertions(+)
rust/kernel/sync/lock.rs +5 -0
index f12a684bc957..7711c6313e14 100644
@@ -121,6 +121,11 @@ pub fn lock(&self) -> Guard<'_, T, B> {
         // SAFETY: The lock was just acquired.
         unsafe { Guard::new(self, state) }
     }
+
+    /// Gets the data contained in the lock
+    pub fn get_mut(&mut self) -> &mut T {
+        self.data.get_mut()
+    }
 }
 
 /// A lock guard.

---
base-commit: 711cbfc717650532624ca9f56fbaf191bed56e67
change-id: 20240118-rust-locks-get-mut-c42072101d7a

Best regards,

Signature · 1 line
Mathys-Gasnier <[email protected]>
Reviewed-by on v1 1/1
#1 lore raw
Quoted 8 lines · Mathys-Gasnier

From: Mathys-Gasnier <[email protected]>

Having a mutable reference guarantees that no other threads have access to the lock, so we can take advantage of that to grant callers access to the protected data without the the cost of acquiring and releasing the locks. Since the lifetime of the data is tied to the mutable reference, the borrow checker guarantees that the usage is safe.

Quoted 4 lines

---
[...]
+ /// Gets the data contained in the lock

I wish that this doc comment mentioned what you've said about having a mutable reference avoids locking, much like the documentation on std::sync::Mutex::get_mut. If you do so then you can add my reviewed.

Quoted 5 lines
rust/kernel/sync/lock.rs +3 -0
+    pub fn get_mut(&mut self) -> &mut T {
+        self.data.get_mut()
+    }
  }
[...]
#2 lore raw
In reply to Mathys-Gasnier
Quoted 18 lines · On 2/9/24 17:22, Mathys-Gasnier via B4 Relay wrote:

From: Mathys-Gasnier <[email protected]>

Having a mutable reference guarantees that no other threads have access to the lock, so we can take advantage of that to grant callers access to the protected data without the the cost of acquiring and releasing the locks. Since the lifetime of the data is tied to the mutable reference, the borrow checker guarantees that the usage is safe.

---
  rust/kernel/sync/lock.rs | 5 +++++
  1 file changed, 5 insertions(+)
rust/kernel/sync/lock.rs +0 -0
index f12a684bc957..7711c6313e14 100644

rust/kernel/sync/lock.rs pub fn lock(&self) -> Guard<'_, T, B> { · line 128

Quoted 8 lines
rust/kernel/sync/lock.rs +5 -0
@@ -121,6 +121,11 @@ pub fn lock(&self) -> Guard<'_, T, B> {
          // SAFETY: The lock was just acquired.
          unsafe { Guard::new(self, state) }
      }
+
+    /// Gets the data contained in the lock
+    pub fn get_mut(&mut self) -> &mut T {
+        self.data.get_mut()
+    }

You can never have a mutable reference to a Linux mutex because we pin our locks. At most, you can have a Pin<&mut Self>.

Alice