mirror of
https://github.com/torvalds/linux.git
synced 2024-11-24 21:21:41 +00:00
docs: remove :c:func: from refcount-vs-atomic.rst
As of 5.3, the automarkup extension will do the right thing with function() notation, so we don't need to clutter the text with :c:func: invocations. So remove them. Looking at the generated output reveals that we lack kerneldoc coverage for much of this API, but that's a separate problem. Acked-by: Paul E. McKenney <paulmck@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
185271a1fa
commit
81584a6a77
@ -35,7 +35,7 @@ atomics & refcounters only provide atomicity and
|
|||||||
program order (po) relation (on the same CPU). It guarantees that
|
program order (po) relation (on the same CPU). It guarantees that
|
||||||
each ``atomic_*()`` and ``refcount_*()`` operation is atomic and instructions
|
each ``atomic_*()`` and ``refcount_*()`` operation is atomic and instructions
|
||||||
are executed in program order on a single CPU.
|
are executed in program order on a single CPU.
|
||||||
This is implemented using :c:func:`READ_ONCE`/:c:func:`WRITE_ONCE` and
|
This is implemented using READ_ONCE()/WRITE_ONCE() and
|
||||||
compare-and-swap primitives.
|
compare-and-swap primitives.
|
||||||
|
|
||||||
A strong (full) memory ordering guarantees that all prior loads and
|
A strong (full) memory ordering guarantees that all prior loads and
|
||||||
@ -44,7 +44,7 @@ before any po-later instruction is executed on the same CPU.
|
|||||||
It also guarantees that all po-earlier stores on the same CPU
|
It also guarantees that all po-earlier stores on the same CPU
|
||||||
and all propagated stores from other CPUs must propagate to all
|
and all propagated stores from other CPUs must propagate to all
|
||||||
other CPUs before any po-later instruction is executed on the original
|
other CPUs before any po-later instruction is executed on the original
|
||||||
CPU (A-cumulative property). This is implemented using :c:func:`smp_mb`.
|
CPU (A-cumulative property). This is implemented using smp_mb().
|
||||||
|
|
||||||
A RELEASE memory ordering guarantees that all prior loads and
|
A RELEASE memory ordering guarantees that all prior loads and
|
||||||
stores (all po-earlier instructions) on the same CPU are completed
|
stores (all po-earlier instructions) on the same CPU are completed
|
||||||
@ -52,14 +52,14 @@ before the operation. It also guarantees that all po-earlier
|
|||||||
stores on the same CPU and all propagated stores from other CPUs
|
stores on the same CPU and all propagated stores from other CPUs
|
||||||
must propagate to all other CPUs before the release operation
|
must propagate to all other CPUs before the release operation
|
||||||
(A-cumulative property). This is implemented using
|
(A-cumulative property). This is implemented using
|
||||||
:c:func:`smp_store_release`.
|
smp_store_release().
|
||||||
|
|
||||||
An ACQUIRE memory ordering guarantees that all post loads and
|
An ACQUIRE memory ordering guarantees that all post loads and
|
||||||
stores (all po-later instructions) on the same CPU are
|
stores (all po-later instructions) on the same CPU are
|
||||||
completed after the acquire operation. It also guarantees that all
|
completed after the acquire operation. It also guarantees that all
|
||||||
po-later stores on the same CPU must propagate to all other CPUs
|
po-later stores on the same CPU must propagate to all other CPUs
|
||||||
after the acquire operation executes. This is implemented using
|
after the acquire operation executes. This is implemented using
|
||||||
:c:func:`smp_acquire__after_ctrl_dep`.
|
smp_acquire__after_ctrl_dep().
|
||||||
|
|
||||||
A control dependency (on success) for refcounters guarantees that
|
A control dependency (on success) for refcounters guarantees that
|
||||||
if a reference for an object was successfully obtained (reference
|
if a reference for an object was successfully obtained (reference
|
||||||
@ -78,8 +78,8 @@ case 1) - non-"Read/Modify/Write" (RMW) ops
|
|||||||
|
|
||||||
Function changes:
|
Function changes:
|
||||||
|
|
||||||
* :c:func:`atomic_set` --> :c:func:`refcount_set`
|
* atomic_set() --> refcount_set()
|
||||||
* :c:func:`atomic_read` --> :c:func:`refcount_read`
|
* atomic_read() --> refcount_read()
|
||||||
|
|
||||||
Memory ordering guarantee changes:
|
Memory ordering guarantee changes:
|
||||||
|
|
||||||
@ -91,8 +91,8 @@ case 2) - increment-based ops that return no value
|
|||||||
|
|
||||||
Function changes:
|
Function changes:
|
||||||
|
|
||||||
* :c:func:`atomic_inc` --> :c:func:`refcount_inc`
|
* atomic_inc() --> refcount_inc()
|
||||||
* :c:func:`atomic_add` --> :c:func:`refcount_add`
|
* atomic_add() --> refcount_add()
|
||||||
|
|
||||||
Memory ordering guarantee changes:
|
Memory ordering guarantee changes:
|
||||||
|
|
||||||
@ -103,7 +103,7 @@ case 3) - decrement-based RMW ops that return no value
|
|||||||
|
|
||||||
Function changes:
|
Function changes:
|
||||||
|
|
||||||
* :c:func:`atomic_dec` --> :c:func:`refcount_dec`
|
* atomic_dec() --> refcount_dec()
|
||||||
|
|
||||||
Memory ordering guarantee changes:
|
Memory ordering guarantee changes:
|
||||||
|
|
||||||
@ -115,8 +115,8 @@ case 4) - increment-based RMW ops that return a value
|
|||||||
|
|
||||||
Function changes:
|
Function changes:
|
||||||
|
|
||||||
* :c:func:`atomic_inc_not_zero` --> :c:func:`refcount_inc_not_zero`
|
* atomic_inc_not_zero() --> refcount_inc_not_zero()
|
||||||
* no atomic counterpart --> :c:func:`refcount_add_not_zero`
|
* no atomic counterpart --> refcount_add_not_zero()
|
||||||
|
|
||||||
Memory ordering guarantees changes:
|
Memory ordering guarantees changes:
|
||||||
|
|
||||||
@ -131,8 +131,8 @@ case 5) - generic dec/sub decrement-based RMW ops that return a value
|
|||||||
|
|
||||||
Function changes:
|
Function changes:
|
||||||
|
|
||||||
* :c:func:`atomic_dec_and_test` --> :c:func:`refcount_dec_and_test`
|
* atomic_dec_and_test() --> refcount_dec_and_test()
|
||||||
* :c:func:`atomic_sub_and_test` --> :c:func:`refcount_sub_and_test`
|
* atomic_sub_and_test() --> refcount_sub_and_test()
|
||||||
|
|
||||||
Memory ordering guarantees changes:
|
Memory ordering guarantees changes:
|
||||||
|
|
||||||
@ -144,14 +144,14 @@ case 6) other decrement-based RMW ops that return a value
|
|||||||
|
|
||||||
Function changes:
|
Function changes:
|
||||||
|
|
||||||
* no atomic counterpart --> :c:func:`refcount_dec_if_one`
|
* no atomic counterpart --> refcount_dec_if_one()
|
||||||
* ``atomic_add_unless(&var, -1, 1)`` --> ``refcount_dec_not_one(&var)``
|
* ``atomic_add_unless(&var, -1, 1)`` --> ``refcount_dec_not_one(&var)``
|
||||||
|
|
||||||
Memory ordering guarantees changes:
|
Memory ordering guarantees changes:
|
||||||
|
|
||||||
* fully ordered --> RELEASE ordering + control dependency
|
* fully ordered --> RELEASE ordering + control dependency
|
||||||
|
|
||||||
.. note:: :c:func:`atomic_add_unless` only provides full order on success.
|
.. note:: atomic_add_unless() only provides full order on success.
|
||||||
|
|
||||||
|
|
||||||
case 7) - lock-based RMW
|
case 7) - lock-based RMW
|
||||||
@ -159,10 +159,10 @@ case 7) - lock-based RMW
|
|||||||
|
|
||||||
Function changes:
|
Function changes:
|
||||||
|
|
||||||
* :c:func:`atomic_dec_and_lock` --> :c:func:`refcount_dec_and_lock`
|
* atomic_dec_and_lock() --> refcount_dec_and_lock()
|
||||||
* :c:func:`atomic_dec_and_mutex_lock` --> :c:func:`refcount_dec_and_mutex_lock`
|
* atomic_dec_and_mutex_lock() --> refcount_dec_and_mutex_lock()
|
||||||
|
|
||||||
Memory ordering guarantees changes:
|
Memory ordering guarantees changes:
|
||||||
|
|
||||||
* fully ordered --> RELEASE ordering + control dependency + hold
|
* fully ordered --> RELEASE ordering + control dependency + hold
|
||||||
:c:func:`spin_lock` on success
|
spin_lock() on success
|
||||||
|
Loading…
Reference in New Issue
Block a user