summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--includes/RtsAPI.h7
-rw-r--r--libraries/base/GHC/Stats.hsc7
2 files changed, 10 insertions, 4 deletions
diff --git a/includes/RtsAPI.h b/includes/RtsAPI.h
index 69ec6075db..79c4d8ef53 100644
--- a/includes/RtsAPI.h
+++ b/includes/RtsAPI.h
@@ -127,7 +127,9 @@ typedef struct GCDetails_ {
uint32_t threads;
// Number of bytes allocated since the previous GC
uint64_t allocated_bytes;
- // Total amount of live data in the heap (incliudes large + compact data)
+ // Total amount of live data in the heap (incliudes large + compact data).
+ // Updated after every GC. Data in uncollected generations (in minor GCs)
+ // are considered live.
uint64_t live_bytes;
// Total amount of live data in large objects
uint64_t large_objects_bytes;
@@ -165,7 +167,8 @@ typedef struct _RTSStats {
uint32_t major_gcs;
// Total bytes allocated
uint64_t allocated_bytes;
- // Maximum live data (including large objects + compact regions)
+ // Maximum live data (including large objects + compact regions) in the
+ // heap. Updated after a major GC.
uint64_t max_live_bytes;
// Maximum live data in large objects
uint64_t max_large_objects_bytes;
diff --git a/libraries/base/GHC/Stats.hsc b/libraries/base/GHC/Stats.hsc
index d81173fe58..58b5e22d04 100644
--- a/libraries/base/GHC/Stats.hsc
+++ b/libraries/base/GHC/Stats.hsc
@@ -56,7 +56,8 @@ data RTSStats = RTSStats {
, major_gcs :: Word32
-- | Total bytes allocated
, allocated_bytes :: Word64
- -- | Maximum live data (including large objects + compact regions)
+ -- | Maximum live data (including large objects + compact regions) in the
+ -- heap. Updated after a major GC.
, max_live_bytes :: Word64
-- | Maximum live data in large objects
, max_large_objects_bytes :: Word64
@@ -120,7 +121,9 @@ data GCDetails = GCDetails {
, gcdetails_threads :: Word32
-- | Number of bytes allocated since the previous GC
, gcdetails_allocated_bytes :: Word64
- -- | Total amount of live data in the heap (incliudes large + compact data)
+ -- | Total amount of live data in the heap (incliudes large + compact data).
+ -- Updated after every GC. Data in uncollected generations (in minor GCs)
+ -- are considered live.
, gcdetails_live_bytes :: Word64
-- | Total amount of live data in large objects
, gcdetails_large_objects_bytes :: Word64