From: Leonardo Bras <leobras@redhat.com>
To: Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
Jakub Kicinski <kuba@kernel.org>,
"Peter Zijlstra (Intel)" <peterz@infradead.org>,
Alexei Starovoitov <ast@kernel.org>,
Vlastimil Babka <vbabka@suse.cz>,
Leonardo Bras <leobras@redhat.com>
Cc: linux-kernel@vger.kernel.org
Subject: [PATCH v1 1/1] local_lock: Minor improvements of local_trylock*() documentation
Date: Mon, 5 May 2025 14:02:44 -0300 [thread overview]
Message-ID: <20250505170244.253170-1-leobras@redhat.com> (raw)
Fix local_trylock_init() documentation, as it was mentioning the non-try
helper instead, and use the opportunity to make clear the try_lock*() needs
to receive a local_trylock_t variable as parameter.
Signed-off-by: Leonardo Bras <leobras@redhat.com>
---
Changes since RFC:
- Replace try-enabled lock with local_trylock{,_t}
include/linux/local_lock.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/include/linux/local_lock.h b/include/linux/local_lock.h
index 16a2ee4f8310b..58adaaf98dd74 100644
--- a/include/linux/local_lock.h
+++ b/include/linux/local_lock.h
@@ -45,38 +45,38 @@
/**
* local_unlock_irqrestore - Release a per CPU local lock and restore
* interrupt flags
* @lock: The lock variable
* @flags: Interrupt flags to restore
*/
#define local_unlock_irqrestore(lock, flags) \
__local_unlock_irqrestore(lock, flags)
/**
- * local_lock_init - Runtime initialize a lock instance
+ * local_trylock_init - Runtime initialize a local_trylock instance
*/
#define local_trylock_init(lock) __local_trylock_init(lock)
/**
* local_trylock - Try to acquire a per CPU local lock
- * @lock: The lock variable
+ * @lock: The local_trylock_t variable
*
* The function can be used in any context such as NMI or HARDIRQ. Due to
* locking constrains it will _always_ fail to acquire the lock in NMI or
* HARDIRQ context on PREEMPT_RT.
*/
#define local_trylock(lock) __local_trylock(lock)
/**
* local_trylock_irqsave - Try to acquire a per CPU local lock, save and disable
* interrupts if acquired
- * @lock: The lock variable
+ * @lock: The local_trylock_t variable
* @flags: Storage for interrupt flags
*
* The function can be used in any context such as NMI or HARDIRQ. Due to
* locking constrains it will _always_ fail to acquire the lock in NMI or
* HARDIRQ context on PREEMPT_RT.
*/
#define local_trylock_irqsave(lock, flags) \
__local_trylock_irqsave(lock, flags)
DEFINE_GUARD(local_lock, local_lock_t __percpu*,
--
2.49.0
next reply other threads:[~2025-05-05 17:03 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-05 17:02 Leonardo Bras [this message]
2025-05-12 10:41 ` [PATCH v1 1/1] local_lock: Minor improvements of local_trylock*() documentation Sebastian Andrzej Siewior
2025-05-21 17:40 ` Leonardo Bras Soares Passos
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=20250505170244.253170-1-leobras@redhat.com \
--to=leobras@redhat.com \
--cc=ast@kernel.org \
--cc=bigeasy@linutronix.de \
--cc=kuba@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=peterz@infradead.org \
--cc=vbabka@suse.cz \
/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