mirror of
https://github.com/linux-msm/laptops-kernel.git
synced 2026-08-13 14:19:53 -07:00
percpu_ref: fix documentation of maximum value
Tejun changd percpu_ref to use long instead of int back in 2014 but missed updating this bit of the documentation. Also add the documentation to the htmldocs. Link: https://lore.kernel.org/20241211204017.184512-1-willy@infradead.org Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> Acked-by: Tejun Heo <tj@kernel.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
committed by
Andrew Morton
parent
52b71fe000
commit
b55cc244d0
@@ -90,6 +90,9 @@ Reference counting
|
||||
.. kernel-doc:: lib/refcount.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: include/linux/percpu-refcount.h
|
||||
.. kernel-doc:: lib/percpu-refcount.c
|
||||
|
||||
Atomics
|
||||
-------
|
||||
|
||||
|
||||
@@ -12,8 +12,8 @@
|
||||
* start shutting down you call percpu_ref_kill() _before_ dropping the initial
|
||||
* refcount.
|
||||
*
|
||||
* The refcount will have a range of 0 to ((1U << 31) - 1), i.e. one bit less
|
||||
* than an atomic_t - this is because of the way shutdown works, see
|
||||
* The refcount will have a range of 0 to LONG_MAX, i.e. one bit less
|
||||
* than an atomic_long_t - this is because of the way shutdown works, see
|
||||
* percpu_ref_kill()/PERCPU_COUNT_BIAS.
|
||||
*
|
||||
* Before you call percpu_ref_kill(), percpu_ref_put() does not check for the
|
||||
@@ -269,6 +269,7 @@ static inline bool percpu_ref_tryget(struct percpu_ref *ref)
|
||||
/**
|
||||
* percpu_ref_tryget_live_rcu - same as percpu_ref_tryget_live() but the
|
||||
* caller is responsible for taking RCU.
|
||||
* @ref: percpu_ref to try-get
|
||||
*
|
||||
* This function is safe to call as long as @ref is between init and exit.
|
||||
*/
|
||||
|
||||
@@ -289,7 +289,7 @@ static void __percpu_ref_switch_mode(struct percpu_ref *ref,
|
||||
* @confirm_switch: optional confirmation callback
|
||||
*
|
||||
* There's no reason to use this function for the usual reference counting.
|
||||
* Use percpu_ref_kill[_and_confirm]().
|
||||
* Use percpu_ref_kill() or percpu_ref_kill_and_confirm().
|
||||
*
|
||||
* Schedule switching of @ref to atomic mode. All its percpu counts will
|
||||
* be collected to the main atomic counter. On completion, when all CPUs
|
||||
|
||||
Reference in New Issue
Block a user