Skip to content

Commit

Permalink
docs/scheduler: fix unit error
Browse files Browse the repository at this point in the history
The unit mentioned in the documentation of scheduler statistics is
outdated which may mislead the readers.

The unit of statistics that is reported by /proc/schedstat is modified
to nanosecond, and the unit of statistics that is reported by
/proc/PID/schedstat is provided as well to make the context consistent.

The rq_cpu_time and the rq_sched_info.run_delay of a run queue, and the
sched_info.run_delay of a task are all updated based on the clock of the
run queue, while the se.sum_exec_runtime of a task is updated based on
the clock_task of the run queue of the task. Both the clock and
clock_task are relied on the return value of the function sched_clock()
which is in the unit of nanosecond.

Signed-off-by: Jui-Tse Huang <juitse.huang@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
forward-jt authored and Jonathan Corbet committed Apr 16, 2022
1 parent 389cfd9 commit 6c757e9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Documentation/scheduler/sched-stats.rst
Expand Up @@ -155,8 +155,8 @@ schedstats also adds a new /proc/<pid>/schedstat file to include some of
the same information on a per-process level. There are three fields in
this file correlating for that process to:

1) time spent on the cpu
2) time spent waiting on a runqueue
1) time spent on the cpu (in nanoseconds)
2) time spent waiting on a runqueue (in nanoseconds)
3) # of timeslices run on this cpu

A program could be easily written to make use of these extra fields to
Expand Down

0 comments on commit 6c757e9

Please sign in to comment.