From: Boqun Feng <boqun.feng@gmail.com>
To: linux-kernel@vger.kernel.org, rcu@vger.kernel.org,
linux-doc@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>,
"Paul E. McKenney" <paulmck@kernel.org>,
kernel test robot <lkp@intel.com>,
Randy Dunlap <rdunlap@infradead.org>,
Frederic Weisbecker <frederic@kernel.org>
Subject: [PATCH 6/8] context_tracking: Fix kerneldoc headers for __ct_user_{enter,exit}()
Date: Thu, 25 Jan 2024 19:58:09 -0800 [thread overview]
Message-ID: <20240126035816.3129296-7-boqun.feng@gmail.com> (raw)
In-Reply-To: <20240126035816.3129296-1-boqun.feng@gmail.com>
From: "Paul E. McKenney" <paulmck@kernel.org>
Document the "state" parameter of both of these functions.
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202312041922.YZCcEPYD-lkp@intel.com/
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Frederic Weisbecker <frederic@kernel.org>
---
kernel/context_tracking.c | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/kernel/context_tracking.c b/kernel/context_tracking.c
index 6ef0b35fc28c..70ae70d03823 100644
--- a/kernel/context_tracking.c
+++ b/kernel/context_tracking.c
@@ -458,6 +458,8 @@ static __always_inline void context_tracking_recursion_exit(void)
* __ct_user_enter - Inform the context tracking that the CPU is going
* to enter user or guest space mode.
*
+ * @state: userspace context-tracking state to enter.
+ *
* This function must be called right before we switch from the kernel
* to user or guest space, when it's guaranteed the remaining kernel
* instructions to execute won't use any RCU read side critical section
@@ -595,6 +597,8 @@ NOKPROBE_SYMBOL(user_enter_callable);
* __ct_user_exit - Inform the context tracking that the CPU is
* exiting user or guest mode and entering the kernel.
*
+ * @state: userspace context-tracking state being exited from.
+ *
* This function must be called after we entered the kernel from user or
* guest space before any use of RCU read side critical section. This
* potentially include any high level kernel code like syscalls, exceptions,
--
2.43.0
next prev parent reply other threads:[~2024-01-26 3:59 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-26 3:58 [PATCH 0/8] RCU doc updates for v6.9 Boqun Feng
2024-01-26 3:58 ` [PATCH 1/8] doc: Spinlocks are implied RCU readers Boqun Feng
2024-01-26 3:58 ` [PATCH 2/8] doc: Make whatisRCU.rst note that spinlocks are " Boqun Feng
2024-01-26 3:58 ` [PATCH 3/8] doc: Make checklist.rst note that spinlocks are implied " Boqun Feng
2024-01-26 3:58 ` [PATCH 4/8] doc: Add CONFIG_RCU_STRICT_GRACE_PERIOD to checklist.rst Boqun Feng
2024-01-26 3:58 ` [PATCH 5/8] doc: Add EARLY flag to early-parsed kernel boot parameters Boqun Feng
2024-01-26 3:58 ` Boqun Feng [this message]
2024-01-26 3:58 ` [PATCH 7/8] doc: Clarify use of slab constructors and SLAB_TYPESAFE_BY_RCU Boqun Feng
2024-01-26 3:58 ` [PATCH 8/8] doc: Update checklist.rst discussion of callback execution Boqun Feng
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=20240126035816.3129296-7-boqun.feng@gmail.com \
--to=boqun.feng@gmail.com \
--cc=corbet@lwn.net \
--cc=frederic@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkp@intel.com \
--cc=paulmck@kernel.org \
--cc=rcu@vger.kernel.org \
--cc=rdunlap@infradead.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®