mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Thomas Weißschuh" <linux@weissschuh.net>
To: Peter Zijlstra <peterz@infradead.org>,
	Ingo Molnar <mingo@redhat.com>,  Will Deacon <will@kernel.org>,
	Waiman Long <longman@redhat.com>,
	 Boqun Feng <boqun.feng@gmail.com>
Cc: "Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
	linux-kernel@vger.kernel.org,
	"Thomas Weißschuh" <linux@weissschuh.net>
Subject: [PATCH] locking/mutex: Mark devm_mutex_init() as __must_check
Date: Mon, 02 Dec 2024 18:45:41 +0100	[thread overview]
Message-ID: <20241202-must_check-devm_mutex_init-v1-1-e60eb97b8c72@weissschuh.net> (raw)

Even if it's not critical, the avoidance of checking the error code
from devm_mutex_init() call today diminishes the point of using devm
variant of it. Tomorrow it may even leak something. Enforce all callers
checking the return value through the compiler.

As devm_mutex_init() itself is a macro which can not be annotated,
annotate __devm_mutex_init() instead.
Unfortunately __must_check/warn_unused_result don't propagate through
statement expression. To work around this move the statement expression
into the argument list of the call to __devm_mutex_init() so
devm_mutex_init() directly expands to __devm_mutex_init().

Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
---
 include/linux/mutex.h | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/include/linux/mutex.h b/include/linux/mutex.h
index 2bf91b57591b49e4668752e773419ae945f124da..3ab77d0d85bd54a700e99694fd4bcf1d310175bd 100644
--- a/include/linux/mutex.h
+++ b/include/linux/mutex.h
@@ -126,11 +126,12 @@ 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,13 +142,12 @@ static inline int __devm_mutex_init(struct device *dev, struct mutex *lock)
 
 #endif
 
-#define devm_mutex_init(dev, mutex)			\
-({							\
-	typeof(mutex) mutex_ = (mutex);			\
-							\
-	mutex_init(mutex_);				\
-	__devm_mutex_init(dev, mutex_);			\
-})
+#define devm_mutex_init(dev, mutex) __devm_mutex_init(dev, ({	\
+	typeof(mutex) mutex_ = (mutex);				\
+								\
+	mutex_init(mutex_);					\
+	mutex_;							\
+}))
 
 /*
  * See kernel/locking/mutex.c for detailed documentation of these APIs.

---
base-commit: e70140ba0d2b1a30467d4af6bcfe761327b9ec95
change-id: 20241031-must_check-devm_mutex_init-cac583bda8fe

Best regards,
-- 
Thomas Weißschuh <linux@weissschuh.net>


             reply	other threads:[~2024-12-02 17:45 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-02 17:45 Thomas Weißschuh [this message]
2025-01-16 15:45 ` Andy Shevchenko
2025-01-16 17:31   ` Thomas Weißschuh

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241202-must_check-devm_mutex_init-v1-1-e60eb97b8c72@weissschuh.net \
    --to=linux@weissschuh.net \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=boqun.feng@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=longman@redhat.com \
    --cc=mingo@redhat.com \
    --cc=peterz@infradead.org \
    --cc=will@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®