doc: Update the comparisons rule in rcu_dereference.txt
Subsystems (2)
PATCH 1/1 doc: Update the comparisons rule in rcu_dereference.txt
When an RCU-protected pointer is fetched but never dereferenced rcu_access_pointer() should be used in place of rcu_dereference(). This commit explicitly records this very fact in Documentation/ RCU/rcu_dereference.txt, in order to prevent the usage of rcu_dereference() in comparisons.
Signed-off-by Michalis Kokologiannakis <[email protected]>
--- Documentation/RCU/rcu_dereference.txt | 9 +++++++++ 1 file changed, 9 insertions(+)
Documentation/RCU/rcu_dereference.txt +9 -0
@@ -138,6 +138,15 @@ o Be very careful about comparing pointers obtained from This sort of comparison occurs frequently when scanning RCU-protected circular linked lists. + Note that if checks for being within an RCU read-side + critical section are not required and the pointer is never + dereferenced, rcu_access_pointer() should be used in place + of rcu_dereference(). The rcu_access_pointer() primitive + does not require an enclosing read-side critical section, + and also omits the smp_read_barrier_depends() included in + rcu_dereference(), which in turn should provide a small + performance gain in some CPUs (e.g., the DEC Alpha). + o The comparison is against a pointer that references memory that was initialized "a long time ago." The reason this is safe is that even if misordering occurs, the
Signature · 1 line
2.1.4
Paul E. McKenney
AppliedQuoted 7 lines · Michalis Kokologiannakis
When an RCU-protected pointer is fetched but never dereferenced
rcu_access_pointer()should be used in place ofrcu_dereference(). This commit explicitly records this very fact inDocumentation/RCU/rcu_dereference.txt, in order to prevent the usage ofrcu_dereference()in comparisons.Signed-off-by Michalis Kokologiannakis <[email protected]>
Queued for review, thank you!
Thanx, Paul
Quoted 27 lines
--- Documentation/RCU/rcu_dereference.txt | 9 +++++++++ 1 file changed, 9 insertions(+)Documentation/RCU/rcu_dereference.txt +9
-0@@ -138,6 +138,15 @@ o Be very careful about comparing pointers obtained from This sort of comparison occurs frequently when scanning RCU-protected circular linked lists. + Note that if checks for being within an RCU read-side + critical section are not required and the pointer is never + dereferenced, rcu_access_pointer() should be used in place + of rcu_dereference(). The rcu_access_pointer() primitive + does not require an enclosing read-side critical section, + and also omits the smp_read_barrier_depends() included in + rcu_dereference(), which in turn should provide a small + performance gain in some CPUs (e.g., the DEC Alpha). + o The comparison is against a pointer that references memory that was initialized "a long time ago." The reason this is safe is that even if misordering occurs, theSignature · 1 line
2.1.4