Skip to contentSkip to conversation

rcu: small rcu_dereference doc update

PATCH Applied Milos Vyletel 3 participants 3 messages Apr 17, 2015

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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.

---
 Documentation/RCU/whatisRCU.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/RCU/whatisRCU.txt +3 -1
index 88dfce1..16622c9 100644
@@ -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
reviewer Reviewed-by on v2 1/1
#1 lore raw
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.

-- Steve

Quoted 19 lines
---
 Documentation/RCU/whatisRCU.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/RCU/whatisRCU.txt +3 -1
index 88dfce1..16622c9 100644
@@ -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.
#2 lore raw
Quoted 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.

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
index 88dfce1..16622c9 100644
@@ -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.