From: Paul E. McKenney Date: Mon, 4 May 2020 02:16:09 +0000 (-0700) Subject: rcu: Add comment documenting rcu_callback_map's purpose X-Git-Tag: howlett/maple_spf/20210104~1405^2^2^2~18 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=f8466f94685b5bd931384526cf51e090fd2ac706;p=users%2Fjedix%2Flinux-maple.git 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 --- diff --git a/kernel/rcu/update.c b/kernel/rcu/update.c index f5a82e107bcb1..ca17b771ad60a 100644 --- a/kernel/rcu/update.c +++ b/kernel/rcu/update.c @@ -279,6 +279,7 @@ struct lockdep_map rcu_sched_lock_map = { }; EXPORT_SYMBOL_GPL(rcu_sched_lock_map); +// Tell lockdep when RCU callbacks are being invoked. static struct lock_class_key rcu_callback_key; struct lockdep_map rcu_callback_map = STATIC_LOCKDEP_MAP_INIT("rcu_callback", &rcu_callback_key);