rcu: Add comment documenting rcu_callback_map's purpose
authorPaul E. McKenney <paulmck@kernel.org>
Mon, 4 May 2020 02:16:09 +0000 (19:16 -0700)
committerPaul E. McKenney <paulmck@kernel.org>
Mon, 29 Jun 2020 18:58:49 +0000 (11:58 -0700)
commitf8466f94685b5bd931384526cf51e090fd2ac706
tree3f4336becb9cf16cf590d9c400233e17203dcd0b
parente816d56fad57ba9817cef6606b12f5e14647c3bf
rcu: Add comment documenting rcu_callback_map's purpose

The rcu_callback_map lockdep_map structure was added back in 2013, but
its purpose has become obscure.  This commit therefore documments that the
purpose of rcu_callback map is, in the words of commit 24ef659a857 ("rcu:
Provide better diagnostics for blocking in RCU callback functions"),
to help lockdep to tie an "inappropriate voluntary context switch back
to the fact that the function is being invoked from within a callback."

Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
kernel/rcu/update.c