linux-kernel - Re: [PATCH v7 3/3] locking/mutex: Mark devm_mutex_init() as __must

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <aFGmsXTaVAgfRc_j@tardis.local>
Date: Tue, 17 Jun 2025 10:32:33 -0700
From: Boqun Feng <boqun.feng@...il.com>
To: Thomas Weißschuh <linux@...ssschuh.net>
Cc: Peter Zijlstra <peterz@...radead.org>, Ingo Molnar <mingo@...hat.com>,
	Waiman Long <longman@...hat.com>,
	Vicentiu Galanopulo <vicentiu.galanopulo@...ote-tech.co.uk>,
	Will Deacon <will@...nel.org>, Han Xu <han.xu@....com>,
	Haibo Chen <haibo.chen@....com>,
	Yogesh Gaur <yogeshgaur.83@...il.com>,
	Mark Brown <broonie@...nel.org>, Lee Jones <lee@...nel.org>,
	Pavel Machek <pavel@...nel.org>, Andrew Davis <afd@...com>,
	Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
	linux-kernel@...r.kernel.org, Bartosz Golaszewski <brgl@...ev.pl>,
	Bartosz Golaszewski <bartosz.golaszewski@...aro.org>,
	linux-spi@...r.kernel.org, imx@...ts.linux.dev,
	linux-leds@...r.kernel.org
Subject: Re: [PATCH v7 3/3] locking/mutex: Mark devm_mutex_init() as
 __must_check

On Tue, Jun 17, 2025 at 07:08:14PM +0200, Thomas Weißschuh wrote:
> devm_mutex_init() can fail. With CONFIG_DEBUG_MUTEXES=y the mutex will be
> marked as unusable and trigger errors on usage.
> Enforce all callers check the return value through the compiler.
> 
> As devm_mutex_init() itself is a macro, it can not be annotated
> directly. Annotate __devm_mutex_init() instead.
> Unfortunately __must_check/warn_unused_result don't propagate through
> statement expression. So move the statement expression into the argument
> list of the call to __devm_mutex_init() through a helper macro.
> 

Given it's Peter's suggestion [1] for __mutex_init_ret(), I think a

Suggested-by: Peter Zijlstra <peterz@...radead.org>

should be added here. No need for a new version just for that. If patch
#1 got some reviews, I would queue this in my lockdep-for-tip branch.
Hopefully these will land v6.17.

[1]: https://lore.kernel.org/all/20250204090106.GP7145@noisy.programming.kicks-ass.net/

Regards,
Boqun

> Signed-off-by: Thomas Weißschuh <linux@...ssschuh.net>
> Reviewed-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
> Reviewed-by: Bartosz Golaszewski <bartosz.golaszewski@...aro.org>
> ---
>  include/linux/mutex.h | 11 +++++++----
>  1 file changed, 7 insertions(+), 4 deletions(-)
> 
> diff --git a/include/linux/mutex.h b/include/linux/mutex.h
> index a039fa8c17807c700d3b61193feac0418cad1243..00afd341d293ddfcc0a427b576efdce044955e38 100644
> --- a/include/linux/mutex.h
> +++ b/include/linux/mutex.h
> @@ -126,11 +126,11 @@ do {							\
>  
>  #ifdef CONFIG_DEBUG_MUTEXES
>  
> -int __devm_mutex_init(struct device *dev, struct mutex *lock);
> +int __must_check __devm_mutex_init(struct device *dev, struct mutex *lock);
>  
>  #else
>  
> -static inline int __devm_mutex_init(struct device *dev, struct mutex *lock)
> +static inline int __must_check __devm_mutex_init(struct device *dev, struct mutex *lock)
>  {
>  	/*
>  	 * When CONFIG_DEBUG_MUTEXES is off mutex_destroy() is just a nop so
> @@ -141,14 +141,17 @@ static inline int __devm_mutex_init(struct device *dev, struct mutex *lock)
>  
>  #endif
>  
> -#define devm_mutex_init(dev, mutex)			\
> +#define __mutex_init_ret(mutex)				\
>  ({							\
>  	typeof(mutex) mutex_ = (mutex);			\
>  							\
>  	mutex_init(mutex_);				\
> -	__devm_mutex_init(dev, mutex_);			\
> +	mutex_;						\
>  })
>  
> +#define devm_mutex_init(dev, mutex) \
> +	__devm_mutex_init(dev, __mutex_init_ret(mutex))
> +
>  /*
>   * See kernel/locking/mutex.c for detailed documentation of these APIs.
>   * Also see Documentation/locking/mutex-design.rst.
> 
> -- 
> 2.50.0
>