rcu: small rcu_dereference doc update
Subsystems (2)
PATCH v2 1/1 rcu: small rcu_dereference doc update
Make a note stating that repeated calls of rcu_dereference() may not return the same pointer if update happens while in critical section.
Reported-by Jeff Haran <[email protected]>
Signed-off-by Milos Vyletel <[email protected]>
--- Documentation/RCU/whatisRCU.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/RCU/whatisRCU.txt +3 -1
@@ -256,7 +256,9 @@ rcu_dereference() If you are going to be fetching multiple fields from the RCU-protected structure, using the local variable is of course preferred. Repeated rcu_dereference() calls look - ugly and incur unnecessary overhead on Alpha CPUs. + ugly, do not guarantee that the same pointer will be returned + if an update happened while in the critical section, and incur + unnecessary overhead on Alpha CPUs. Note that the value returned by rcu_dereference() is valid only within the enclosing RCU read-side critical section.
Signature · 1 line
2.1.0
Quoted 5 lines · On Fri, 17 Apr 2015 16:38:04 +0200 Milos Vyletel <[email protected]> wrote:
Make a note stating that repeated calls of
rcu_dereference()may not return the same pointer if update happens while in critical section.Reported-by Jeff Haran <[email protected]>Signed-off-by Milos Vyletel <[email protected]>
Reviewed-by Steven Rostedt <[email protected]>
-- Steve
Quoted 19 lines
--- Documentation/RCU/whatisRCU.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)Documentation/RCU/whatisRCU.txt +3
-1@@ -256,7 +256,9 @@ rcu_dereference() If you are going to be fetching multiple fields from the RCU-protected structure, using the local variable is of course preferred. Repeated rcu_dereference() calls look - ugly and incur unnecessary overhead on Alpha CPUs. + ugly, do not guarantee that the same pointer will be returned + if an update happened while in the critical section, and incur + unnecessary overhead on Alpha CPUs. Note that the value returned by rcu_dereference() is valid only within the enclosing RCU read-side critical section.
Paul E. McKenney
AppliedQuoted 10 lines · Steven Rostedt
Quoted 5 lines · On Fri, 17 Apr 2015 16:38:04 +0200 Milos Vyletel <[email protected]> wrote:
Make a note stating that repeated calls of
rcu_dereference()may not return the same pointer if update happens while in critical section.Reported-by Jeff Haran <[email protected]>Signed-off-by Milos Vyletel <[email protected]>Reviewed-by Steven Rostedt <[email protected]>
Queued for 4.2, thank you both!
Thanx, Paul
Quoted 22 lines
-- Steve
Quoted 19 lines
--- Documentation/RCU/whatisRCU.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)Documentation/RCU/whatisRCU.txt +3
-1@@ -256,7 +256,9 @@ rcu_dereference() If you are going to be fetching multiple fields from the RCU-protected structure, using the local variable is of course preferred. Repeated rcu_dereference() calls look - ugly and incur unnecessary overhead on Alpha CPUs. + ugly, do not guarantee that the same pointer will be returned + if an update happened while in the critical section, and incur + unnecessary overhead on Alpha CPUs. Note that the value returned by rcu_dereference() is valid only within the enclosing RCU read-side critical section.