mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Zqiang <qiang.zhang@linux.dev>
To: paulmck@kernel.org, frederic@kernel.org,
	neeraj.upadhyay@kernel.org, joelagnelf@nvidia.com,
	urezki@gmail.com, boqun@kernel.org
Cc: qiang.zhang@linux.dev, rcu@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2] doc: Update recent RCU/SRCU API additions to whatisRCU.rst
Date: Mon, 19 Oct 2026 20:22:09 +0800	[thread overview]
Message-ID: <20261019122209.15604-2-qiang.zhang@linux.dev> (raw)
In-Reply-To: <20261019122209.15604-1-qiang.zhang@linux.dev>

The following commit introduces some new RCU/SRCU APIs:

Commit 'd3f52f53a562 ("srcu: Create an SRCU-fast-updown API")'
Commit 'dab06d6f9379 ("srcutree: Add an atomic Tree SRCU")'
Commit 'cacadb630375 ("srcu: Add guards for notrace variants of SRCU-fast readers")'
Commit 'fa8a2d55139f ("srcu: Add lock guard for srcu_fast_updown flavor")'
Commit '954c0d741299 ("srcu: Add guards for SRCU-fast readers")'

This commit therefore update thems and some missing RCU related APIs
to whatisRCU.rst.

Signed-off-by: Zqiang <qiang.zhang@linux.dev>
---
 Documentation/RCU/whatisRCU.rst | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/Documentation/RCU/whatisRCU.rst b/Documentation/RCU/whatisRCU.rst
index e6767baff2d3..fe9dc3948690 100644
--- a/Documentation/RCU/whatisRCU.rst
+++ b/Documentation/RCU/whatisRCU.rst
@@ -1084,8 +1084,9 @@ RCU::
 	rcu_dereference			call_rcu
 	rcu_dereference_check		call_rcu_hurry
 	rcu_dereference_protected	kfree_rcu
-	rcu_read_lock_held		kvfree_rcu
-	rcu_read_lock_any_held		kfree_rcu_mightsleep
+	rcu_dereference_all		kvfree_rcu
+	rcu_read_lock_held		kfree_rcu_mightsleep
+	rcu_read_lock_any_held		kvfree_rcu_mightsleep
 	rcu_pointer_handoff		cond_synchronize_rcu
 	unrcu_pointer			cond_synchronize_rcu_full
 					cond_synchronize_rcu_expedited
@@ -1209,13 +1210,23 @@ SRCU::
 	srcu_read_lock_nmisafe		start_poll_synchronize_srcu
 	srcu_read_unlock_nmisafe	start_poll_synchronize_srcu_expedited
 	srcu_read_lock_notrace		poll_state_synchronize_srcu
-	srcu_read_unlock_notrace
+	srcu_read_unlock_notrace	synchronize_srcu_atomic
 	srcu_down_read
 	srcu_up_read
 	srcu_down_read_fast
 	srcu_up_read_fast
+	srcu_read_lock_fast_updown
+	srcu_read_unlock_fast_updown
+	srcu_read_lock_atomic
+	srcu_read_unlock_atomic
 	guard(srcu)()
+	guard(srcu_fast)()
+	guard(srcu_fast_notrace)()
+	guard(srcu_fast_updown)()
 	scoped_guard(srcu)
+	scoped_guard(srcu_fast)
+	scoped_guard(srcu_fast_notrace)
+	scoped_guard(srcu_fast_updown)
 	srcu_read_lock_held
 	srcu_dereference
 	srcu_dereference_check
@@ -1229,9 +1240,16 @@ SRCU: Initialization/cleanup/ordering::
 	DEFINE_STATIC_SRCU
 	DEFINE_SRCU_FAST        // for srcu_read_lock_fast() and friends
 	DEFINE_STATIC_SRCU_FAST // for srcu_read_lock_fast() and friends
+	DEFINE_SRCU_FAST_UPDOWN		// for srcu_read_lock_fast_updown() and friends
+	DEFINE_STATIC_SRCU_FAST_UPDOWN	// for srcu_read_lock_fast_updown() and friends
+	DEFINE_SRCU_ATOMIC		// for srcu_read_lock_atomic() and friends
+	DEFINE_STATIC_SRCU_ATOMIC	// for srcu_read_lock_atomic() and friends
 	init_srcu_struct
 	init_srcu_struct_fast
+	init_srcu_struct_fast_updown
+	init_srcu_struct_atomic
 	cleanup_srcu_struct
+	smp_mb__after_srcu_read_lock
 	smp_mb__after_srcu_read_unlock
 
 All: lockdep-checked RCU utility APIs::
-- 
2.17.1


  reply	other threads:[~2026-10-19 12:22 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-19 12:22 [PATCH v2] rcu-tasks: Avoid alloc_percpu() failure in rcu_tasks_rude_wait_gp() Zqiang
2026-10-19 12:22 ` Zqiang [this message]
2026-10-19 15:12   ` [PATCH v2] doc: Update recent RCU/SRCU API additions to whatisRCU.rst Bradley Morgan
2026-10-19 16:44   ` Paul E. McKenney

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=20261019122209.15604-2-qiang.zhang@linux.dev \
    --to=qiang.zhang@linux.dev \
    --cc=boqun@kernel.org \
    --cc=frederic@kernel.org \
    --cc=joelagnelf@nvidia.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=neeraj.upadhyay@kernel.org \
    --cc=paulmck@kernel.org \
    --cc=rcu@vger.kernel.org \
    --cc=urezki@gmail.com \
    /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®