<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>GHC.Stats</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_GHC-Stats.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">base-4.5.1.0: Basic libraries</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr></table><p class="caption">GHC.Stats</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module provides access to internal garbage collection and
memory usage statistics. These statistics are not available unless
a program is run with the <code>-T</code> RTS flag.
</p><p>This module is GHC-only and should not be considered portable.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:GCStats">GCStats</a> = <a href="#v:GCStats">GCStats</a> {<ul class="subs"><li><a href="#v:bytesAllocated">bytesAllocated</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:numGcs">numGcs</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:maxBytesUsed">maxBytesUsed</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:numByteUsageSamples">numByteUsageSamples</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:cumulativeBytesUsed">cumulativeBytesUsed</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:bytesCopied">bytesCopied</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:currentBytesUsed">currentBytesUsed</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:currentBytesSlop">currentBytesSlop</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:maxBytesSlop">maxBytesSlop</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:peakMegabytesAllocated">peakMegabytesAllocated</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:mutatorCpuSeconds">mutatorCpuSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></li><li><a href="#v:mutatorWallSeconds">mutatorWallSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></li><li><a href="#v:gcCpuSeconds">gcCpuSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></li><li><a href="#v:gcWallSeconds">gcWallSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></li><li><a href="#v:cpuSeconds">cpuSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></li><li><a href="#v:wallSeconds">wallSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></li><li><a href="#v:parAvgBytesCopied">parAvgBytesCopied</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li><li><a href="#v:parMaxBytesCopied">parMaxBytesCopied</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></li></ul>}</li><li class="src short"><a href="#v:getGCStats">getGCStats</a> :: <a href="System-IO.html#t:IO">IO</a> <a href="GHC-Stats.html#t:GCStats">GCStats</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:GCStats" class="def">GCStats</a> </p><div class="doc"><p>Global garbage collection and memory statistics.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:GCStats" class="def">GCStats</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:bytesAllocated" class="def">bytesAllocated</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Total number of bytes allocated
</p></dd><dt class="src"><a name="v:numGcs" class="def">numGcs</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Number of garbage collections performed
</p></dd><dt class="src"><a name="v:maxBytesUsed" class="def">maxBytesUsed</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Maximum number of live bytes seen so far
</p></dd><dt class="src"><a name="v:numByteUsageSamples" class="def">numByteUsageSamples</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Number of byte usage samples taken
| Sum of all byte usage samples, can be used with
<code><a href="GHC-Stats.html#v:numByteUsageSamples">numByteUsageSamples</a></code> to calculate averages with
arbitrary weighting (if you are sampling this record multiple
times).
</p></dd><dt class="src"><a name="v:cumulativeBytesUsed" class="def">cumulativeBytesUsed</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:bytesCopied" class="def">bytesCopied</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Number of bytes copied during GC
</p></dd><dt class="src"><a name="v:currentBytesUsed" class="def">currentBytesUsed</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Current number of live bytes
</p></dd><dt class="src"><a name="v:currentBytesSlop" class="def">currentBytesSlop</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Current number of bytes lost to slop
</p></dd><dt class="src"><a name="v:maxBytesSlop" class="def">maxBytesSlop</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Maximum number of bytes lost to slop at any one time so far
</p></dd><dt class="src"><a name="v:peakMegabytesAllocated" class="def">peakMegabytesAllocated</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Maximum number of megabytes allocated
| CPU time spent running mutator threads. This does not include
any profiling overhead or initialization.
</p></dd><dt class="src"><a name="v:mutatorCpuSeconds" class="def">mutatorCpuSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:mutatorWallSeconds" class="def">mutatorWallSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></dt><dd class="doc"><p>Wall clock time spent running mutator threads. This does not
include initialization.
</p></dd><dt class="src"><a name="v:gcCpuSeconds" class="def">gcCpuSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></dt><dd class="doc"><p>CPU time spent running GC
</p></dd><dt class="src"><a name="v:gcWallSeconds" class="def">gcWallSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></dt><dd class="doc"><p>Wall clock time spent running GC
</p></dd><dt class="src"><a name="v:cpuSeconds" class="def">cpuSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></dt><dd class="doc"><p>Total CPU time elapsed since program start
</p></dd><dt class="src"><a name="v:wallSeconds" class="def">wallSeconds</a> :: !<a href="Prelude.html#t:Double">Double</a></dt><dd class="doc"><p>Total wall clock time elapsed since start
| Number of bytes copied during GC, minus space held by mutable
lists held by the capabilities. Can be used with
<code><a href="GHC-Stats.html#v:parMaxBytesCopied">parMaxBytesCopied</a></code> to determine how well parallel GC utilized
all cores.
</p></dd><dt class="src"><a name="v:parAvgBytesCopied" class="def">parAvgBytesCopied</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:parMaxBytesCopied" class="def">parMaxBytesCopied</a> :: !<a href="Data-Int.html#t:Int64">Int64</a></dt><dd class="doc"><p>Sum of number of bytes copied each GC by the most active GC
thread each GC. The ratio of <code><a href="GHC-Stats.html#v:parAvgBytesCopied">parAvgBytesCopied</a></code> divided by
<code><a href="GHC-Stats.html#v:parMaxBytesCopied">parMaxBytesCopied</a></code> approaches 1 for a maximally sequential
run and approaches the number of threads (set by the RTS flag
<code>-N</code>) for a maximally parallel run.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:GCStats" class="caption collapser" onclick="toggleSection('i:GCStats')">Instances</p><div id="section.i:GCStats" class="show"><table><tr><td class="src"><a href="Text-Read.html#t:Read">Read</a> <a href="GHC-Stats.html#t:GCStats">GCStats</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Text-Show.html#t:Show">Show</a> <a href="GHC-Stats.html#t:GCStats">GCStats</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:getGCStats" class="def">getGCStats</a> :: <a href="System-IO.html#t:IO">IO</a> <a href="GHC-Stats.html#t:GCStats">GCStats</a></p><div class="doc"><p>Retrieves garbage collection and memory statistics as of the last
garbage collection. If you would like your statistics as recent as
possible, first run a <code><a href="System-Mem.html#v:performGC">performGC</a></code>.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
6e204a966e8c42d976f99a1700ce5f20
>
files
>
2316
