From: John Ogness <john.ogness@linutronix.de>
To: Petr Mladek <pmladek@suse.com>
Cc: Sergey Senozhatsky <senozhatsky@chromium.org>,
Steven Rostedt <rostedt@goodmis.org>,
Thomas Gleixner <tglx@linutronix.de>,
linux-kernel@vger.kernel.org,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: [PATCH printk v7 12/35] console: Improve console_srcu_read_flags() comments
Date: Sun, 4 Aug 2024 02:57:15 +0206 [thread overview]
Message-ID: <20240804005138.3722656-13-john.ogness@linutronix.de> (raw)
In-Reply-To: <20240804005138.3722656-1-john.ogness@linutronix.de>
It was not clear when exactly console_srcu_read_flags() must be
used vs. directly reading @console->flags.
Refactor and clarify that console_srcu_read_flags() is only
needed if the console is registered or the caller is in a
context where the registration status of the console may change
(due to another context).
The function requires the caller holds @console_srcu, which will
ensure that the caller sees an appropriate @flags value for the
registered console and that exit/cleanup routines will not run
if the console is in the process of unregistration.
Signed-off-by: John Ogness <john.ogness@linutronix.de>
Reviewed-by: Petr Mladek <pmladek@suse.com>
---
include/linux/console.h | 28 +++++++++++++++++-----------
1 file changed, 17 insertions(+), 11 deletions(-)
diff --git a/include/linux/console.h b/include/linux/console.h
index 46b3c210b931..aafe3121b74e 100644
--- a/include/linux/console.h
+++ b/include/linux/console.h
@@ -446,28 +446,34 @@ extern void console_list_unlock(void) __releases(console_mutex);
extern struct hlist_head console_list;
/**
- * console_srcu_read_flags - Locklessly read the console flags
+ * console_srcu_read_flags - Locklessly read flags of a possibly registered
+ * console
* @con: struct console pointer of console to read flags from
*
- * This function provides the necessary READ_ONCE() and data_race()
- * notation for locklessly reading the console flags. The READ_ONCE()
- * in this function matches the WRITE_ONCE() when @flags are modified
- * for registered consoles with console_srcu_write_flags().
+ * Locklessly reading @con->flags provides a consistent read value because
+ * there is at most one CPU modifying @con->flags and that CPU is using only
+ * read-modify-write operations to do so.
*
- * Only use this function to read console flags when locklessly
- * iterating the console list via srcu.
+ * Requires console_srcu_read_lock to be held, which implies that @con might
+ * be a registered console. The purpose of holding console_srcu_read_lock is
+ * to guarantee that the console state is valid (CON_SUSPENDED/CON_ENABLED)
+ * and that no exit/cleanup routines will run if the console is currently
+ * undergoing unregistration.
+ *
+ * If the caller is holding the console_list_lock or it is _certain_ that
+ * @con is not and will not become registered, the caller may read
+ * @con->flags directly instead.
*
* Context: Any context.
+ * Return: The current value of the @con->flags field.
*/
static inline short console_srcu_read_flags(const struct console *con)
{
WARN_ON_ONCE(!console_srcu_read_lock_is_held());
/*
- * Locklessly reading console->flags provides a consistent
- * read value because there is at most one CPU modifying
- * console->flags and that CPU is using only read-modify-write
- * operations to do so.
+ * The READ_ONCE() matches the WRITE_ONCE() when @flags are modified
+ * for registered consoles with console_srcu_write_flags().
*/
return data_race(READ_ONCE(con->flags));
}
--
2.39.2
next prev parent reply other threads:[~2024-08-04 0:51 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-04 0:51 [PATCH printk v7 00/35] wire up write_atomic() printing John Ogness
2024-08-04 0:51 ` [PATCH printk v7 01/35] printk: Add notation to console_srcu locking John Ogness
2024-08-04 0:51 ` [PATCH printk v7 02/35] printk: nbcon: Consolidate alloc() and init() John Ogness
2024-08-05 14:39 ` Petr Mladek
2024-08-04 0:51 ` [PATCH printk v7 03/35] printk: Properly deal with nbcon consoles on seq init John Ogness
2024-08-04 0:51 ` [PATCH printk v7 04/35] printk: Check printk_deferred_enter()/_exit() usage John Ogness
2024-08-04 0:51 ` [PATCH printk v7 05/35] printk: nbcon: Clarify rules of the owner/waiter matching John Ogness
2024-08-04 0:51 ` [PATCH printk v7 06/35] printk: nbcon: Remove return value for write_atomic() John Ogness
2024-08-04 0:51 ` [PATCH printk v7 07/35] printk: nbcon: Add detailed doc " John Ogness
2024-08-04 0:51 ` [PATCH printk v7 08/35] printk: nbcon: Add callbacks to synchronize with driver John Ogness
2024-08-04 0:51 ` [PATCH printk v7 09/35] printk: nbcon: Use driver synchronization while (un)registering John Ogness
2024-08-04 0:51 ` [PATCH printk v7 10/35] serial: core: Provide low-level functions to lock port John Ogness
2024-08-04 0:51 ` [PATCH printk v7 11/35] serial: core: Introduce wrapper to set @uart_port->cons John Ogness
2024-08-04 0:51 ` John Ogness [this message]
2024-08-04 0:51 ` [PATCH printk v7 13/35] nbcon: Add API to acquire context for non-printing operations John Ogness
2024-08-04 0:51 ` [PATCH printk v7 14/35] serial: core: Acquire nbcon context in port->lock wrapper John Ogness
2024-08-04 0:51 ` [PATCH printk v7 15/35] printk: nbcon: Do not rely on proxy headers John Ogness
2024-08-04 0:51 ` [PATCH printk v7 16/35] printk: Make console_is_usable() available to nbcon.c John Ogness
2024-08-04 0:51 ` [PATCH printk v7 17/35] printk: Let console_is_usable() handle nbcon John Ogness
2024-08-04 0:51 ` [PATCH printk v7 18/35] printk: Add @flags argument for console_is_usable() John Ogness
2024-08-04 0:51 ` [PATCH printk v7 19/35] printk: nbcon: Add helper to assign priority based on CPU state John Ogness
2024-08-04 0:51 ` [PATCH printk v7 20/35] printk: nbcon: Provide function to flush using write_atomic() John Ogness
2024-08-05 14:59 ` Petr Mladek
2024-08-04 0:51 ` [PATCH printk v7 21/35] printk: Track registered boot consoles John Ogness
2024-08-04 0:51 ` [PATCH printk v7 22/35] printk: nbcon: Use nbcon consoles in console_flush_all() John Ogness
2024-08-04 0:51 ` [PATCH printk v7 23/35] printk: Add is_printk_legacy_deferred() John Ogness
2024-08-05 15:03 ` Petr Mladek
2024-08-04 0:51 ` [PATCH printk v7 24/35] printk: nbcon: Flush new records on device_release() John Ogness
2024-08-05 15:31 ` Petr Mladek
2024-08-07 1:15 ` John Ogness
2024-08-07 12:48 ` Petr Mladek
2024-08-04 0:51 ` [PATCH printk v7 25/35] printk: Flush nbcon consoles first on panic John Ogness
2024-08-06 8:31 ` Petr Mladek
2024-08-04 0:51 ` [PATCH printk v7 26/35] printk: nbcon: Add unsafe flushing " John Ogness
2024-08-04 0:51 ` [PATCH printk v7 27/35] printk: Avoid console_lock dance if no legacy or boot consoles John Ogness
2024-08-06 8:40 ` Petr Mladek
2024-08-04 0:51 ` [PATCH printk v7 28/35] printk: Track nbcon consoles John Ogness
2024-08-04 0:51 ` [PATCH printk v7 29/35] printk: Coordinate direct printing in panic John Ogness
2024-08-06 9:59 ` Petr Mladek
2024-08-06 17:29 ` Linus Torvalds
2024-08-06 12:17 ` Petr Mladek
2024-08-04 0:51 ` [PATCH printk v7 30/35] printk: Add helper for flush type logic John Ogness
2024-08-07 11:39 ` Petr Mladek
2024-08-07 14:11 ` John Ogness
2024-08-08 9:03 ` Petr Mladek
2024-08-04 0:51 ` [PATCH printk v7 31/35] printk: nbcon: Implement emergency sections John Ogness
2024-08-07 12:52 ` Petr Mladek
2024-08-04 0:51 ` [PATCH printk v7 32/35] panic: Mark emergency section in warn John Ogness
2024-08-04 0:51 ` [PATCH printk v7 33/35] panic: Mark emergency section in oops John Ogness
2024-08-04 0:51 ` [PATCH printk v7 34/35] rcu: Mark emergency sections in rcu stalls John Ogness
2024-08-04 0:51 ` [PATCH printk v7 35/35] lockdep: Mark emergency sections in lockdep splats John Ogness
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=20240804005138.3722656-13-john.ogness@linutronix.de \
--to=john.ogness@linutronix.de \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pmladek@suse.com \
--cc=rostedt@goodmis.org \
--cc=senozhatsky@chromium.org \
--cc=tglx@linutronix.de \
/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®