rcu_sync: Fix comment to properly reflect rcu_sync_exit() behavior
authorDavid Vernet <void@manifault.com>
Tue, 29 Mar 2022 22:26:13 +0000 (15:26 -0700)
committerPaul E. McKenney <paulmck@kernel.org>
Wed, 20 Apr 2022 23:51:11 +0000 (16:51 -0700)
commitf1efe84d6fd2af163989025bc285ff9b3b0c764f
tree6e882fa8778f703f3c037285441f3158e479b9b6
parent88ca472f80604c070526eb58b977ea0a9c3c2e1f
rcu_sync: Fix comment to properly reflect rcu_sync_exit() behavior

The rcu_sync_enter() function is used by updaters to force RCU readers
(e.g. percpu-rwsem) to use their slow paths during an update.  This is
accomplished by setting the ->gp_state of the rcu_sync structure to
GP_ENTER.  In the case of percpu-rwsem, the readers' slow path waits on
a semaphore instead of just incrementing a reader count.  Each updater
invokes the rcu_sync_exit() function to signal to readers that they
may again take their fastpaths.  The rcu_sync_exit() function sets the
->gp_state of the rcu_sync structure to GP_EXIT, and if all goes well,
after a grace period the ->gp_state reverts back to GP_IDLE.

Unfortunately, the rcu_sync_enter() function currently has a comment
incorrectly stating that rcu_sync_exit() (by an updater) will re-enable
reader "slowpaths".  This patch changes the comment to state that this
function re-enables reader fastpaths.

Signed-off-by: David Vernet <void@manifault.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
kernel/rcu/sync.c