[PATCH] rust: sync: add #[must_use] to GlobalGuard and GlobalLock::try_lock

[PATCH] rust: sync: add #[must_use] to GlobalGuard and GlobalLock::try_lock

[Ashutosh Desai]

Guard is marked #[must_use] since dropping it releases the lock. GlobalGuard
wraps Guard with identical semantics but was missing the annotation, so
discarding it would silently compile without warning.

Similarly, GlobalLock::try_lock was missing #[must_use]. Option<T> does not
propagate #[must_use] from T, so the attribute needs to be on the function
directly - same reason Lock::try_lock has it. Add the explanatory comment
there too.

Signed-off-by: Ashutosh Desai <ashutoshdesai993@gmail.com>
---
 rust/kernel/sync/lock/global.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/rust/kernel/sync/lock/global.rs b/rust/kernel/sync/lock/global.rs
index aecbdc34738f..7067bdcca9c2 100644
--- a/rust/kernel/sync/lock/global.rs
+++ b/rust/kernel/sync/lock/global.rs
@@ -85,6 +85,8 @@ pub fn lock(&'static self) -> GlobalGuard<B> {
     }
 
     /// Try to lock this global lock.
+    // `Option<T>` is not `#[must_use]` even if `T` is, thus the attribute is needed here.
+    #[must_use = "if unused, the lock will be immediately unlocked"]
     #[inline]
     pub fn try_lock(&'static self) -> Option<GlobalGuard<B>> {
         Some(GlobalGuard {
@@ -96,6 +98,7 @@ pub fn try_lock(&'static self) -> Option<GlobalGuard<B>> {
 /// A guard for a [`GlobalLock`].
 ///
 /// See [`global_lock!`] for examples.
+#[must_use = "the lock unlocks immediately when the guard is unused"]
 pub struct GlobalGuard<B: GlobalLockBackend> {
     inner: Guard<'static, B::Item, B::Backend>,
 }
-- 
2.34.1

Re: [PATCH] rust: sync: add #[must_use] to GlobalGuard and GlobalLock::try_lock

[Alice Ryhl]

On Sun, Apr 19, 2026 at 12:11:41AM +0000, Ashutosh Desai wrote:
> Guard is marked #[must_use] since dropping it releases the lock. GlobalGuard
> wraps Guard with identical semantics but was missing the annotation, so
> discarding it would silently compile without warning.
> 
> Similarly, GlobalLock::try_lock was missing #[must_use]. Option<T> does not
> propagate #[must_use] from T, so the attribute needs to be on the function
> directly - same reason Lock::try_lock has it. Add the explanatory comment
> there too.
> 
> Signed-off-by: Ashutosh Desai <ashutoshdesai993@gmail.com>
> ---
>  rust/kernel/sync/lock/global.rs | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/rust/kernel/sync/lock/global.rs b/rust/kernel/sync/lock/global.rs
> index aecbdc34738f..7067bdcca9c2 100644
> --- a/rust/kernel/sync/lock/global.rs
> +++ b/rust/kernel/sync/lock/global.rs
> @@ -85,6 +85,8 @@ pub fn lock(&'static self) -> GlobalGuard<B> {
>      }
>  
>      /// Try to lock this global lock.
> +    // `Option<T>` is not `#[must_use]` even if `T` is, thus the attribute is needed here.
> +    #[must_use = "if unused, the lock will be immediately unlocked"]

I don't think there's any need for this comment.

Otherwise LGTM.
Reviewed-by: Alice Ryhl <aliceryhl@google.com>

>      #[inline]
>      pub fn try_lock(&'static self) -> Option<GlobalGuard<B>> {
>          Some(GlobalGuard {
> @@ -96,6 +98,7 @@ pub fn try_lock(&'static self) -> Option<GlobalGuard<B>> {
>  /// A guard for a [`GlobalLock`].
>  ///
>  /// See [`global_lock!`] for examples.
> +#[must_use = "the lock unlocks immediately when the guard is unused"]
>  pub struct GlobalGuard<B: GlobalLockBackend> {
>      inner: Guard<'static, B::Item, B::Backend>,
>  }
> -- 
> 2.34.1
>