Correct documentation for /proc/schedstat
PATCH 1/1 Correct documentation for /proc/schedstat
Commit 425e0968a25fa3f111f9919964cac079738140b5 ("sched: move code into kernel/sched_stats.h") appears to have inadvertently changed the unit of time from jiffies to nanoseconds as part of the implementation of CFS.
--- Documentation/scheduler/sched-stats.txt | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)
Documentation/scheduler/sched-stats.txt +8 -2
@@ -19,6 +19,11 @@ are no architectures which need more than three domain levels. The first field in the domain stats is a bit map indicating which cpus are affected by that domain. +2.6.23 introduced the CFS scheduler, and also an inadvertent +backwards-incompatible change to the statistics. Although the schedstat version +is 14 in either case, in 2.6.23 and later, counters accumulate time in +nanoseconds. Prior to that, jiffies. + These fields are counters, and only increment. Programs which make use of these will need to start with a baseline observation and then calculate the change in the counters at each subsequent observation. A perl script
@@ -48,9 +53,10 @@ Next two are try_to_wake_up() statistics: 6) # of times try_to_wake_up() was called to wake up the local cpu Next three are statistics describing scheduling latency: - 7) sum of all time spent running by tasks on this processor (in jiffies) + 7) sum of all time spent running by tasks on this processor (in + nanoseconds, or jiffies prior to 2.6.23) 8) sum of all time spent waiting to run by tasks on this processor (in - jiffies) + nanoseconds, or jiffies prior to 2.6.23) 9) # of timeslices run on this cpu
Signature · 1 line
2.20.1 (Apple Git-117)
Jonathan Corbet
maintainerQuoted 14 lines · On Wed, 24 Jul 2019 11:50:27 -0700 Phil Frost <[email protected]> wrote:
Commit
425e0968a25fa3f111f9919964cac079738140b5("sched: move code intokernel/sched_stats.h") appears to have inadvertently changed the unit of time from jiffies to nanoseconds as part of the implementation of CFS.Signed-off-by Phil Frost <[email protected]>--- Documentation/scheduler/sched-stats.txt | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)Documentation/scheduler/sched-stats.txt +0
-0
Documentation/scheduler/sched-stats.txt are no architectures which need more than three domain levels. The first · line 25
Quoted 7 lines
Documentation/scheduler/sched-stats.txt +4
-0@@ -19,6 +19,11 @@ are no architectures which need more than three domain levels. The first field in the domain stats is a bit map indicating which cpus are affected by that domain. +2.6.23 introduced the CFS scheduler, and also an inadvertent +backwards-incompatible change to the statistics. Although the schedstat version +is 14 in either case, in 2.6.23 and later, counters accumulate time in +nanoseconds. Prior to that, jiffies.
Clearly, making the documentation correct is a good thing to do. I do have to wonder if we really have to document how things were 12 years ago as well, though. Anybody who is unfortunate enough to be dealing with a pre-2.6.23 kernel will want to refer to the documentation files shipped with that kernel rather than what we have now. So I'd recommend just making the file reflect the current state of affairs.
Thanks,
jon
Hi Phil,
Quoted 6 lines · Phil Frost
Commit
425e0968a25fa3f111f9919964cac079738140b5("sched: move code intokernel/sched_stats.h") appears to have inadvertently changed the unit of time from jiffies to nanoseconds as part of the implementation of CFS.Signed-off-by Phil Frost <[email protected]>
Do you plan to resend this patch? The file has been updated to sched-stats.rst.
Thanks,
Song