From 566414b6d72eaea4e1fde8625eca631bcd50b082 Mon Sep 17 00:00:00 2001 From: Ben Gamari Date: Tue, 17 May 2022 21:58:23 -0400 Subject: nonmoving: Fix documentation of GC statistics fields These were previously incorrect. Fixes #21553. --- libraries/base/GHC/Stats.hsc | 19 ++++++++----------- rts/include/RtsAPI.h | 23 +++++++++-------------- 2 files changed, 17 insertions(+), 25 deletions(-) diff --git a/libraries/base/GHC/Stats.hsc b/libraries/base/GHC/Stats.hsc index 7b5c0cd463..0d772ba765 100644 --- a/libraries/base/GHC/Stats.hsc +++ b/libraries/base/GHC/Stats.hsc @@ -105,23 +105,20 @@ data RTSStats = RTSStats { -- | Total elapsed time (at the previous GC) , elapsed_ns :: RtsTime - -- | The CPU time used during the post-mark pause phase of the concurrent - -- nonmoving GC. + -- | The total CPU time used during the post-mark pause phase of the + -- concurrent nonmoving GC. , nonmoving_gc_sync_cpu_ns :: RtsTime - -- | The time elapsed during the post-mark pause phase of the concurrent - -- nonmoving GC. + -- | The total time elapsed during the post-mark pause phase of the + -- concurrent nonmoving GC. , nonmoving_gc_sync_elapsed_ns :: RtsTime - -- | The maximum time elapsed during the post-mark pause phase of the + -- | The maximum elapsed length of any post-mark pause phase of the -- concurrent nonmoving GC. , nonmoving_gc_sync_max_elapsed_ns :: RtsTime - -- | The CPU time used during the post-mark pause phase of the concurrent - -- nonmoving GC. + -- | The total CPU time used by the nonmoving GC. , nonmoving_gc_cpu_ns :: RtsTime - -- | The time elapsed during the post-mark pause phase of the concurrent - -- nonmoving GC. + -- | The total time elapsed during which there is a nonmoving GC active. , nonmoving_gc_elapsed_ns :: RtsTime - -- | The maximum time elapsed during the post-mark pause phase of the - -- concurrent nonmoving GC. + -- | The maximum time elapsed during any nonmoving GC cycle. , nonmoving_gc_max_elapsed_ns :: RtsTime -- | Details about the most recent GC diff --git a/rts/include/RtsAPI.h b/rts/include/RtsAPI.h index e2d1845819..b6ea88623c 100644 --- a/rts/include/RtsAPI.h +++ b/rts/include/RtsAPI.h @@ -176,11 +176,9 @@ typedef struct GCDetails_ { // The time elapsed during the post-mark pause phase of the concurrent // nonmoving GC. Time nonmoving_gc_sync_elapsed_ns; - // The CPU time used during the post-mark pause phase of the concurrent - // nonmoving GC. + // The total CPU time used by the nonmoving GC. Time nonmoving_gc_cpu_ns; - // The time elapsed during the post-mark pause phase of the concurrent - // nonmoving GC. + // The total time elapsed during which there is a nonmoving GC active. Time nonmoving_gc_elapsed_ns; } GCDetails; @@ -261,23 +259,20 @@ typedef struct _RTSStats { // ---------------------------------- // Concurrent garbage collector - // The CPU time used during the post-mark pause phase of the concurrent - // nonmoving GC. + // The total CPU time used during the post-mark pause phase of the + // concurrent nonmoving GC. Time nonmoving_gc_sync_cpu_ns; - // The time elapsed during the post-mark pause phase of the concurrent - // nonmoving GC. + // The total time elapsed during the post-mark pause phase of the + // concurrent nonmoving GC. Time nonmoving_gc_sync_elapsed_ns; // The maximum time elapsed during the post-mark pause phase of the // concurrent nonmoving GC. Time nonmoving_gc_sync_max_elapsed_ns; - // The CPU time used during the post-mark pause phase of the concurrent - // nonmoving GC. + // The total CPU time used by the nonmoving GC. Time nonmoving_gc_cpu_ns; - // The time elapsed during the post-mark pause phase of the concurrent - // nonmoving GC. + // The total time elapsed during which there is a nonmoving GC active. Time nonmoving_gc_elapsed_ns; - // The maximum time elapsed during the post-mark pause phase of the - // concurrent nonmoving GC. + // The maximum time elapsed during any nonmoving GC cycle. Time nonmoving_gc_max_elapsed_ns; } RTSStats; -- cgit v1.2.1