Skip to content

Commit c7dcf81

Browse files
committed
rcu-tasks: Fix synchronize_rcu_tasks_trace() header comment
The synchronize_rcu_tasks_trace() header comment incorrectly claims that any number of things delimit RCU Tasks Trace read-side critical sections, when in fact only rcu_read_lock_trace() and rcu_read_unlock_trace() do so. This commit therefore fixes this comment, and, while in the area, fixes a typo in the rcu_read_lock_trace() header comment. Reported-by: Alexei Starovoitov <[email protected]> Signed-off-by: Paul E. McKenney <[email protected]>
1 parent e13ef44 commit c7dcf81

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

include/linux/rcupdate_trace.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ void rcu_read_unlock_trace_special(struct task_struct *t, int nesting);
3636
/**
3737
* rcu_read_lock_trace - mark beginning of RCU-trace read-side critical section
3838
*
39-
* When synchronize_rcu_trace() is invoked by one task, then that task
40-
* is guaranteed to block until all other tasks exit their read-side
39+
* When synchronize_rcu_tasks_trace() is invoked by one task, then that
40+
* task is guaranteed to block until all other tasks exit their read-side
4141
* critical sections. Similarly, if call_rcu_trace() is invoked on one
4242
* task while other tasks are within RCU read-side critical sections,
4343
* invocation of the corresponding RCU callback is deferred until after

kernel/rcu/tasks.h

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1118,11 +1118,10 @@ EXPORT_SYMBOL_GPL(call_rcu_tasks_trace);
11181118
* synchronize_rcu_tasks_trace - wait for a trace rcu-tasks grace period
11191119
*
11201120
* Control will return to the caller some time after a trace rcu-tasks
1121-
* grace period has elapsed, in other words after all currently
1122-
* executing rcu-tasks read-side critical sections have elapsed. These
1123-
* read-side critical sections are delimited by calls to schedule(),
1124-
* cond_resched_tasks_rcu_qs(), userspace execution, and (in theory,
1125-
* anyway) cond_resched().
1121+
* grace period has elapsed, in other words after all currently executing
1122+
* rcu-tasks read-side critical sections have elapsed. These read-side
1123+
* critical sections are delimited by calls to rcu_read_lock_trace()
1124+
* and rcu_read_unlock_trace().
11261125
*
11271126
* This is a very specialized primitive, intended only for a few uses in
11281127
* tracing and other situations requiring manipulation of function preambles

0 commit comments

Comments
 (0)