ghc/docs/users_guide/profiling.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <chapter id="profiling">
   3   <title>Profiling</title>
   4   <indexterm><primary>profiling</primary>
   5   </indexterm>
   6   <indexterm><primary>cost-centre profiling</primary></indexterm>
   7
   8   <para> Glasgow Haskell comes with a time and space profiling
   9   system. Its purpose is to help you improve your understanding of
  10   your program's execution behaviour, so you can improve it.</para>
  11
  12   <para> Any comments, suggestions and/or improvements you have are
  13   welcome.  Recommended &ldquo;profiling tricks&rdquo; would be
  14   especially cool! </para>
  15
  16   <para>Profiling a program is a three-step process:</para>
  17
  18   <orderedlist>
  19     <listitem>
  20       <para> Re-compile your program for profiling with the
  21       <literal>-prof</literal> option, and probably one of the
  22       <literal>-auto</literal> or <literal>-auto-all</literal>
  23       options.  These options are described in more detail in <xref
  24       linkend="prof-compiler-options"/> </para>
  25       <indexterm><primary><literal>-prof</literal></primary>
  26       </indexterm>
  27       <indexterm><primary><literal>-auto</literal></primary>
  28       </indexterm>
  29       <indexterm><primary><literal>-auto-all</literal></primary>
  30       </indexterm>
  31     </listitem>
  32
  33     <listitem>
  34       <para> Run your program with one of the profiling options, eg.
  35       <literal>+RTS -p -RTS</literal>.  This generates a file of
  36       profiling information.</para>
  37       <indexterm><primary><option>-p</option></primary><secondary>RTS
  38       option</secondary></indexterm>
  39     </listitem>
  40
  41     <listitem>
  42       <para> Examine the generated profiling information, using one of
  43       GHC's profiling tools.  The tool to use will depend on the kind
  44       of profiling information generated.</para>
  45     </listitem>
  46
  47   </orderedlist>
  48
  49   <sect1 id="cost-centres">
  50     <title>Cost centres and cost-centre stacks</title>
  51
  52     <para>GHC's profiling system assigns <firstterm>costs</firstterm>
  53     to <firstterm>cost centres</firstterm>.  A cost is simply the time
  54     or space required to evaluate an expression.  Cost centres are
  55     program annotations around expressions; all costs incurred by the
  56     annotated expression are assigned to the enclosing cost centre.
  57     Furthermore, GHC will remember the stack of enclosing cost centres
  58     for any given expression at run-time and generate a call-graph of
  59     cost attributions.</para>
  60
  61     <para>Let's take a look at an example:</para>
  62
  63     <programlisting>
  64 main = print (nfib 25)
  65 nfib n = if n &lt; 2 then 1 else nfib (n-1) + nfib (n-2)
  66 </programlisting>
  67
  68     <para>Compile and run this program as follows:</para>
  69
  70     <screen>
  71 $ ghc -prof -auto-all -o Main Main.hs
  72 $ ./Main +RTS -p
  73 121393
  74 $
  75 </screen>
  76
  77     <para>When a GHC-compiled program is run with the
  78     <option>-p</option> RTS option, it generates a file called
  79     <filename>&lt;prog&gt;.prof</filename>.  In this case, the file
  80     will contain something like this:</para>
  81
  82 <screen>
  83           Fri May 12 14:06 2000 Time and Allocation Profiling Report  (Final)
  84
  85            Main +RTS -p -RTS
  86
  87         total time  =        0.14 secs   (7 ticks @ 20 ms)
  88         total alloc =   8,741,204 bytes  (excludes profiling overheads)
  89
  90 COST CENTRE          MODULE     %time %alloc
  91
  92 nfib                 Main       100.0  100.0
  93
  94
  95                                               individual     inherited
  96 COST CENTRE              MODULE      entries %time %alloc   %time %alloc
  97
  98 MAIN                     MAIN             0    0.0   0.0    100.0 100.0
  99  main                    Main             0    0.0   0.0      0.0   0.0
 100  CAF                     PrelHandle       3    0.0   0.0      0.0   0.0
 101  CAF                     PrelAddr         1    0.0   0.0      0.0   0.0
 102  CAF                     Main             6    0.0   0.0    100.0 100.0
 103   main                   Main             1    0.0   0.0    100.0 100.0
 104    nfib                  Main        242785  100.0 100.0    100.0 100.0
 105 </screen>
 106
 107
 108     <para>The first part of the file gives the program name and
 109     options, and the total time and total memory allocation measured
 110     during the run of the program (note that the total memory
 111     allocation figure isn't the same as the amount of
 112     <emphasis>live</emphasis> memory needed by the program at any one
 113     time; the latter can be determined using heap profiling, which we
 114     will describe shortly).</para>
 115
 116     <para>The second part of the file is a break-down by cost centre
 117     of the most costly functions in the program.  In this case, there
 118     was only one significant function in the program, namely
 119     <function>nfib</function>, and it was responsible for 100&percnt;
 120     of both the time and allocation costs of the program.</para>
 121
 122     <para>The third and final section of the file gives a profile
 123     break-down by cost-centre stack.  This is roughly a call-graph
 124     profile of the program.  In the example above, it is clear that
 125     the costly call to <function>nfib</function> came from
 126     <function>main</function>.</para>
 127
 128     <para>The time and allocation incurred by a given part of the
 129     program is displayed in two ways: &ldquo;individual&rdquo;, which
 130     are the costs incurred by the code covered by this cost centre
 131     stack alone, and &ldquo;inherited&rdquo;, which includes the costs
 132     incurred by all the children of this node.</para>
 133
 134     <para>The usefulness of cost-centre stacks is better demonstrated
 135     by  modifying the example slightly:</para>
 136
 137     <programlisting>
 138 main = print (f 25 + g 25)
 139 f n  = nfib n
 140 g n  = nfib (n `div` 2)
 141 nfib n = if n &lt; 2 then 1 else nfib (n-1) + nfib (n-2)
 142 </programlisting>
 143
 144     <para>Compile and run this program as before, and take a look at
 145     the new profiling results:</para>
 146
 147 <screen>
 148 COST CENTRE              MODULE         scc  %time %alloc   %time %alloc
 149
 150 MAIN                     MAIN             0    0.0   0.0    100.0 100.0
 151  main                    Main             0    0.0   0.0      0.0   0.0
 152  CAF                     PrelHandle       3    0.0   0.0      0.0   0.0
 153  CAF                     PrelAddr         1    0.0   0.0      0.0   0.0
 154  CAF                     Main             9    0.0   0.0    100.0 100.0
 155   main                   Main             1    0.0   0.0    100.0 100.0
 156    g                     Main             1    0.0   0.0      0.0   0.2
 157     nfib                 Main           465    0.0   0.2      0.0   0.2
 158    f                     Main             1    0.0   0.0    100.0  99.8
 159     nfib                 Main        242785  100.0  99.8    100.0  99.8
 160 </screen>
 161
 162     <para>Now although we had two calls to <function>nfib</function>
 163     in the program, it is immediately clear that it was the call from
 164     <function>f</function> which took all the time.</para>
 165
 166     <para>The actual meaning of the various columns in the output is:</para>
 167
 168     <variablelist>
 169       <varlistentry>
 170         <term>entries</term>
 171         <listitem>
 172           <para>The number of times this particular point in the call
 173           graph was entered.</para>
 174         </listitem>
 175       </varlistentry>
 176
 177       <varlistentry>
 178         <term>individual &percnt;time</term>
 179         <listitem>
 180           <para>The percentage of the total run time of the program
 181           spent at this point in the call graph.</para>
 182         </listitem>
 183       </varlistentry>
 184
 185       <varlistentry>
 186         <term>individual &percnt;alloc</term>
 187         <listitem>
 188           <para>The percentage of the total memory allocations
 189           (excluding profiling overheads) of the program made by this
 190           call.</para>
 191         </listitem>
 192       </varlistentry>
 193
 194       <varlistentry>
 195         <term>inherited &percnt;time</term>
 196         <listitem>
 197           <para>The percentage of the total run time of the program
 198           spent below this point in the call graph.</para>
 199         </listitem>
 200       </varlistentry>
 201
 202       <varlistentry>
 203         <term>inherited &percnt;alloc</term>
 204         <listitem>
 205           <para>The percentage of the total memory allocations
 206           (excluding profiling overheads) of the program made by this
 207           call and all of its sub-calls.</para>
 208         </listitem>
 209       </varlistentry>
 210     </variablelist>
 211
 212     <para>In addition you can use the <option>-P</option> RTS option
 213     <indexterm><primary><option>-P</option></primary></indexterm> to
 214     get the following additional information:</para>
 215
 216     <variablelist>
 217       <varlistentry>
 218         <term><literal>ticks</literal></term>
 219         <listitem>
 220           <para>The raw number of time &ldquo;ticks&rdquo; which were
 221           attributed to this cost-centre; from this, we get the
 222           <literal>&percnt;time</literal> figure mentioned
 223           above.</para>
 224         </listitem>
 225       </varlistentry>
 226
 227       <varlistentry>
 228         <term><literal>bytes</literal></term>
 229         <listitem>
 230           <para>Number of bytes allocated in the heap while in this
 231           cost-centre; again, this is the raw number from which we get
 232           the <literal>&percnt;alloc</literal> figure mentioned
 233           above.</para>
 234         </listitem>
 235       </varlistentry>
 236     </variablelist>
 237
 238     <para>What about recursive functions, and mutually recursive
 239     groups of functions?  Where are the costs attributed?  Well,
 240     although GHC does keep information about which groups of functions
 241     called each other recursively, this information isn't displayed in
 242     the basic time and allocation profile, instead the call-graph is
 243     flattened into a tree.  The XML profiling tool (described in <xref
 244     linkend="prof-xml-tool"/>) will be able to display real loops in
 245     the call-graph.</para>
 246
 247     <sect2><title>Inserting cost centres by hand</title>
 248
 249       <para>Cost centres are just program annotations.  When you say
 250       <option>-auto-all</option> to the compiler, it automatically
 251       inserts a cost centre annotation around every top-level function
 252       in your program, but you are entirely free to add the cost
 253       centre annotations yourself.</para>
 254
 255       <para>The syntax of a cost centre annotation is</para>
 256
 257       <programlisting>
 258      {-# SCC "name" #-} &lt;expression&gt;
 259 </programlisting>
 260
 261       <para>where <literal>"name"</literal> is an arbitrary string,
 262       that will become the name of your cost centre as it appears
 263       in the profiling output, and
 264       <literal>&lt;expression&gt;</literal> is any Haskell
 265       expression.  An <literal>SCC</literal> annotation extends as
 266       far to the right as possible when parsing.</para>
 267
 268     </sect2>
 269
 270     <sect2 id="prof-rules">
 271       <title>Rules for attributing costs</title>
 272
 273       <para>The cost of evaluating any expression in your program is
 274       attributed to a cost-centre stack using the following rules:</para>
 275
 276       <itemizedlist>
 277         <listitem>
 278           <para>If the expression is part of the
 279           <firstterm>one-off</firstterm> costs of evaluating the
 280           enclosing top-level definition, then costs are attributed to
 281           the stack of lexically enclosing <literal>SCC</literal>
 282           annotations on top of the special <literal>CAF</literal>
 283           cost-centre. </para>
 284         </listitem>
 285
 286         <listitem>
 287           <para>Otherwise, costs are attributed to the stack of
 288           lexically-enclosing <literal>SCC</literal> annotations,
 289           appended to the cost-centre stack in effect at the
 290           <firstterm>call site</firstterm> of the current top-level
 291           definition<footnote> <para>The call-site is just the place
 292           in the source code which mentions the particular function or
 293           variable.</para></footnote>.  Notice that this is a recursive
 294           definition.</para>
 295         </listitem>
 296
 297         <listitem>
 298           <para>Time spent in foreign code (see <xref linkend="ffi"/>)
 299           is always attributed to the cost centre in force at the
 300           Haskell call-site of the foreign function.</para>
 301         </listitem>
 302       </itemizedlist>
 303
 304       <para>What do we mean by one-off costs?  Well, Haskell is a lazy
 305       language, and certain expressions are only ever evaluated once.
 306       For example, if we write:</para>
 307
 308       <programlisting>
 309 x = nfib 25
 310 </programlisting>
 311
 312       <para>then <varname>x</varname> will only be evaluated once (if
 313       at all), and subsequent demands for <varname>x</varname> will
 314       immediately get to see the cached result.  The definition
 315       <varname>x</varname> is called a CAF (Constant Applicative
 316       Form), because it has no arguments.</para>
 317
 318       <para>For the purposes of profiling, we say that the expression
 319       <literal>nfib 25</literal> belongs to the one-off costs of
 320       evaluating <varname>x</varname>.</para>
 321
 322       <para>Since one-off costs aren't strictly speaking part of the
 323       call-graph of the program, they are attributed to a special
 324       top-level cost centre, <literal>CAF</literal>.  There may be one
 325       <literal>CAF</literal> cost centre for each module (the
 326       default), or one for each top-level definition with any one-off
 327       costs (this behaviour can be selected by giving GHC the
 328       <option>-caf-all</option> flag).</para>
 329
 330       <indexterm><primary><literal>-caf-all</literal></primary>
 331       </indexterm>
 332
 333       <para>If you think you have a weird profile, or the call-graph
 334       doesn't look like you expect it to, feel free to send it (and
 335       your program) to us at
 336       <email>glasgow-haskell-bugs@haskell.org</email>.</para>
 337     </sect2>
 338   </sect1>
 339
 340   <sect1 id="prof-compiler-options">
 341     <title>Compiler options for profiling</title>
 342
 343     <indexterm><primary>profiling</primary><secondary>options</secondary></indexterm>
 344     <indexterm><primary>options</primary><secondary>for profiling</secondary></indexterm>
 345
 346     <variablelist>
 347       <varlistentry>
 348         <term>
 349           <option>-prof</option>:
 350           <indexterm><primary><option>-prof</option></primary></indexterm>
 351         </term>
 352         <listitem>
 353           <para> To make use of the profiling system
 354           <emphasis>all</emphasis> modules must be compiled and linked
 355           with the <option>-prof</option> option. Any
 356           <literal>SCC</literal> annotations you've put in your source
 357           will spring to life.</para>
 358
 359           <para> Without a <option>-prof</option> option, your
 360           <literal>SCC</literal>s are ignored; so you can compile
 361           <literal>SCC</literal>-laden code without changing
 362           it.</para>
 363         </listitem>
 364       </varlistentry>
 365     </variablelist>
 366
 367     <para>There are a few other profiling-related compilation options.
 368     Use them <emphasis>in addition to</emphasis>
 369     <option>-prof</option>.  These do not have to be used consistently
 370     for all modules in a program.</para>
 371
 372     <variablelist>
 373       <varlistentry>
 374         <term>
 375           <option>-auto</option>:
 376           <indexterm><primary><option>-auto</option></primary></indexterm>
 377           <indexterm><primary>cost centres</primary><secondary>automatically inserting</secondary></indexterm>
 378         </term>
 379         <listitem>
 380           <para> GHC will automatically add
 381           <function>&lowbar;scc&lowbar;</function> constructs for all
 382           top-level, exported functions.</para>
 383         </listitem>
 384       </varlistentry>
 385
 386       <varlistentry>
 387         <term>
 388           <option>-auto-all</option>:
 389           <indexterm><primary><option>-auto-all</option></primary></indexterm>
 390         </term>
 391         <listitem>
 392           <para> <emphasis>All</emphasis> top-level functions,
 393           exported or not, will be automatically
 394           <function>&lowbar;scc&lowbar;</function>'d.</para>
 395         </listitem>
 396       </varlistentry>
 397
 398       <varlistentry>
 399         <term>
 400           <option>-caf-all</option>:
 401           <indexterm><primary><option>-caf-all</option></primary></indexterm>
 402         </term>
 403         <listitem>
 404           <para> The costs of all CAFs in a module are usually
 405           attributed to one &ldquo;big&rdquo; CAF cost-centre. With
 406           this option, all CAFs get their own cost-centre.  An
 407           &ldquo;if all else fails&rdquo; option&hellip;</para>
 408         </listitem>
 409       </varlistentry>
 410
 411       <varlistentry>
 412         <term>
 413           <option>-ignore-scc</option>:
 414           <indexterm><primary><option>-ignore-scc</option></primary></indexterm>
 415         </term>
 416         <listitem>
 417           <para>Ignore any <function>&lowbar;scc&lowbar;</function>
 418           constructs, so a module which already has
 419           <function>&lowbar;scc&lowbar;</function>s can be compiled
 420           for profiling with the annotations ignored.</para>
 421         </listitem>
 422       </varlistentry>
 423
 424     </variablelist>
 425
 426   </sect1>
 427
 428   <sect1 id="prof-time-options">
 429     <title>Time and allocation profiling</title>
 430
 431     <para>To generate a time and allocation profile, give one of the
 432     following RTS options to the compiled program when you run it (RTS
 433     options should be enclosed between <literal>+RTS...-RTS</literal>
 434     as usual):</para>
 435
 436     <variablelist>
 437       <varlistentry>
 438         <term>
 439           <option>-p</option> or <option>-P</option>:
 440           <indexterm><primary><option>-p</option></primary></indexterm>
 441           <indexterm><primary><option>-P</option></primary></indexterm>
 442           <indexterm><primary>time profile</primary></indexterm>
 443         </term>
 444         <listitem>
 445           <para>The <option>-p</option> option produces a standard
 446           <emphasis>time profile</emphasis> report.  It is written
 447           into the file
 448           <filename><replaceable>program</replaceable>.prof</filename>.</para>
 449
 450           <para>The <option>-P</option> option produces a more
 451           detailed report containing the actual time and allocation
 452           data as well.  (Not used much.)</para>
 453         </listitem>
 454       </varlistentry>
 455
 456       <varlistentry>
 457         <term>
 458           <option>-px</option>:
 459           <indexterm><primary><option>-px</option></primary></indexterm>
 460         </term>
 461         <listitem>
 462           <para>The <option>-px</option> option generates profiling
 463           information in the XML format understood by our new
 464           profiling tool, see <xref linkend="prof-xml-tool"/>.</para>
 465         </listitem>
 466       </varlistentry>
 467
 468       <varlistentry>
 469         <term>
 470           <option>-xc</option>
 471           <indexterm><primary><option>-xc</option></primary><secondary>RTS option</secondary></indexterm>
 472         </term>
 473         <listitem>
 474           <para>This option makes use of the extra information
 475           maintained by the cost-centre-stack profiler to provide
 476           useful information about the location of runtime errors.
 477           See <xref linkend="rts-options-debugging"/>.</para>
 478         </listitem>
 479       </varlistentry>
 480
 481     </variablelist>
 482
 483   </sect1>
 484
 485   <sect1 id="prof-heap">
 486     <title>Profiling memory usage</title>
 487
 488     <para>In addition to profiling the time and allocation behaviour
 489     of your program, you can also generate a graph of its memory usage
 490     over time.  This is useful for detecting the causes of
 491     <firstterm>space leaks</firstterm>, when your program holds on to
 492     more memory at run-time that it needs to.  Space leaks lead to
 493     longer run-times due to heavy garbage collector activity, and may
 494     even cause the program to run out of memory altogether.</para>
 495
 496     <para>To generate a heap profile from your program:</para>
 497
 498     <orderedlist>
 499       <listitem>
 500         <para>Compile the program for profiling (<xref
 501         linkend="prof-compiler-options"/>).</para>
 502       </listitem>
 503       <listitem>
 504         <para>Run it with one of the heap profiling options described
 505         below (eg. <option>-hc</option> for a basic producer profile).
 506         This generates the file
 507         <filename><replaceable>prog</replaceable>.hp</filename>.</para>
 508       </listitem>
 509       <listitem>
 510         <para>Run <command>hp2ps</command> to produce a Postscript
 511         file,
 512         <filename><replaceable>prog</replaceable>.ps</filename>.  The
 513         <command>hp2ps</command> utility is described in detail in
 514         <xref linkend="hp2ps"/>.</para>
 515       </listitem>
 516       <listitem>
 517         <para>Display the heap profile using a postscript viewer such
 518         as <application>Ghostview</application>, or print it out on a
 519         Postscript-capable printer.</para>
 520       </listitem>
 521     </orderedlist>
 522
 523     <sect2 id="rts-options-heap-prof">
 524       <title>RTS options for heap profiling</title>
 525
 526       <para>There are several different kinds of heap profile that can
 527       be generated.  All the different profile types yield a graph of
 528       live heap against time, but they differ in how the live heap is
 529       broken down into bands.  The following RTS options select which
 530       break-down to use:</para>
 531
 532       <variablelist>
 533         <varlistentry>
 534           <term>
 535             <option>-hc</option>
 536             <indexterm><primary><option>-hc</option></primary><secondary>RTS option</secondary></indexterm>
 537           </term>
 538           <listitem>
 539             <para>Breaks down the graph by the cost-centre stack which
 540             produced the data.</para>
 541           </listitem>
 542         </varlistentry>
 543
 544         <varlistentry>
 545           <term>
 546             <option>-hm</option>
 547             <indexterm><primary><option>-hm</option></primary><secondary>RTS option</secondary></indexterm>
 548           </term>
 549           <listitem>
 550             <para>Break down the live heap by the module containing
 551             the code which produced the data.</para>
 552           </listitem>
 553         </varlistentry>
 554
 555         <varlistentry>
 556           <term>
 557             <option>-hd</option>
 558             <indexterm><primary><option>-hd</option></primary><secondary>RTS option</secondary></indexterm>
 559           </term>
 560           <listitem>
 561             <para>Breaks down the graph by <firstterm>closure
 562             description</firstterm>.  For actual data, the description
 563             is just the constructor name, for other closures it is a
 564             compiler-generated string identifying the closure.</para>
 565           </listitem>
 566         </varlistentry>
 567
 568         <varlistentry>
 569           <term>
 570             <option>-hy</option>
 571             <indexterm><primary><option>-hy</option></primary><secondary>RTS option</secondary></indexterm>
 572           </term>
 573           <listitem>
 574             <para>Breaks down the graph by
 575             <firstterm>type</firstterm>.  For closures which have
 576             function type or unknown/polymorphic type, the string will
 577             represent an approximation to the actual type.</para>
 578           </listitem>
 579         </varlistentry>
 580
 581         <varlistentry>
 582           <term>
 583             <option>-hr</option>
 584             <indexterm><primary><option>-hr</option></primary><secondary>RTS option</secondary></indexterm>
 585           </term>
 586           <listitem>
 587             <para>Break down the graph by <firstterm>retainer
 588             set</firstterm>.  Retainer profiling is described in more
 589             detail below (<xref linkend="retainer-prof"/>).</para>
 590           </listitem>
 591         </varlistentry>
 592
 593         <varlistentry>
 594           <term>
 595             <option>-hb</option>
 596             <indexterm><primary><option>-hb</option></primary><secondary>RTS option</secondary></indexterm>
 597           </term>
 598           <listitem>
 599             <para>Break down the graph by
 600             <firstterm>biography</firstterm>.  Biographical profiling
 601             is described in more detail below (<xref
 602             linkend="biography-prof"/>).</para>
 603           </listitem>
 604         </varlistentry>
 605       </variablelist>
 606
 607       <para>In addition, the profile can be restricted to heap data
 608       which satisfies certain criteria - for example, you might want
 609       to display a profile by type but only for data produced by a
 610       certain module, or a profile by retainer for a certain type of
 611       data.  Restrictions are specified as follows:</para>
 612
 613       <variablelist>
 614         <varlistentry>
 615           <term>
 616             <option>-hc</option><replaceable>name</replaceable>,...
 617             <indexterm><primary><option>-hc</option></primary><secondary>RTS option</secondary></indexterm>
 618           </term>
 619           <listitem>
 620             <para>Restrict the profile to closures produced by
 621             cost-centre stacks with one of the specified cost centres
 622             at the top.</para>
 623           </listitem>
 624         </varlistentry>
 625
 626         <varlistentry>
 627           <term>
 628             <option>-hC</option><replaceable>name</replaceable>,...
 629             <indexterm><primary><option>-hC</option></primary><secondary>RTS option</secondary></indexterm>
 630           </term>
 631           <listitem>
 632             <para>Restrict the profile to closures produced by
 633             cost-centre stacks with one of the specified cost centres
 634             anywhere in the stack.</para>
 635           </listitem>
 636         </varlistentry>
 637
 638         <varlistentry>
 639           <term>
 640             <option>-hm</option><replaceable>module</replaceable>,...
 641             <indexterm><primary><option>-hm</option></primary><secondary>RTS option</secondary></indexterm>
 642           </term>
 643           <listitem>
 644             <para>Restrict the profile to closures produced by the
 645             specified modules.</para>
 646           </listitem>
 647         </varlistentry>
 648
 649         <varlistentry>
 650           <term>
 651             <option>-hd</option><replaceable>desc</replaceable>,...
 652             <indexterm><primary><option>-hd</option></primary><secondary>RTS option</secondary></indexterm>
 653           </term>
 654           <listitem>
 655             <para>Restrict the profile to closures with the specified
 656             description strings.</para>
 657           </listitem>
 658         </varlistentry>
 659
 660         <varlistentry>
 661           <term>
 662             <option>-hy</option><replaceable>type</replaceable>,...
 663             <indexterm><primary><option>-hy</option></primary><secondary>RTS option</secondary></indexterm>
 664           </term>
 665           <listitem>
 666             <para>Restrict the profile to closures with the specified
 667             types.</para>
 668           </listitem>
 669         </varlistentry>
 670
 671         <varlistentry>
 672           <term>
 673             <option>-hr</option><replaceable>cc</replaceable>,...
 674             <indexterm><primary><option>-hr</option></primary><secondary>RTS option</secondary></indexterm>
 675           </term>
 676           <listitem>
 677             <para>Restrict the profile to closures with retainer sets
 678             containing cost-centre stacks with one of the specified
 679             cost centres at the top.</para>
 680           </listitem>
 681         </varlistentry>
 682
 683         <varlistentry>
 684           <term>
 685             <option>-hb</option><replaceable>bio</replaceable>,...
 686             <indexterm><primary><option>-hb</option></primary><secondary>RTS option</secondary></indexterm>
 687           </term>
 688           <listitem>
 689             <para>Restrict the profile to closures with one of the
 690             specified biographies, where
 691             <replaceable>bio</replaceable> is one of
 692             <literal>lag</literal>, <literal>drag</literal>,
 693             <literal>void</literal>, or <literal>use</literal>.</para>
 694           </listitem>
 695         </varlistentry>
 696       </variablelist>
 697
 698       <para>For example, the following options will generate a
 699       retainer profile restricted to <literal>Branch</literal> and
 700       <literal>Leaf</literal> constructors:</para>
 701
 702 <screen>
 703 <replaceable>prog</replaceable> +RTS -hr -hdBranch,Leaf
 704 </screen>
 705
 706       <para>There can only be one "break-down" option
 707       (eg. <option>-hr</option> in the example above), but there is no
 708       limit on the number of further restrictions that may be applied.
 709       All the options may be combined, with one exception: GHC doesn't
 710       currently support mixing the <option>-hr</option> and
 711       <option>-hb</option> options.</para>
 712
 713       <para>There are two more options which relate to heap
 714       profiling:</para>
 715
 716       <variablelist>
 717         <varlistentry>
 718           <term>
 719             <option>-i<replaceable>secs</replaceable></option>:
 720             <indexterm><primary><option>-i</option></primary></indexterm>
 721           </term>
 722           <listitem>
 723             <para>Set the profiling (sampling) interval to
 724             <replaceable>secs</replaceable> seconds (the default is
 725             0.1&nbsp;second).  Fractions are allowed: for example
 726             <option>-i0.2</option> will get 5 samples per second.
 727             This only affects heap profiling; time profiles are always
 728             sampled on a 1/50 second frequency.</para>
 729           </listitem>
 730         </varlistentry>
 731
 732         <varlistentry>
 733           <term>
 734             <option>-xt</option>
 735             <indexterm><primary><option>-xt</option></primary><secondary>RTS option</secondary></indexterm>
 736           </term>
 737           <listitem>
 738             <para>Include the memory occupied by threads in a heap
 739             profile.  Each thread takes up a small area for its thread
 740             state in addition to the space allocated for its stack
 741             (stacks normally start small and then grow as
 742             necessary).</para>
 743
 744             <para>This includes the main thread, so using
 745             <option>-xt</option> is a good way to see how much stack
 746             space the program is using.</para>
 747
 748             <para>Memory occupied by threads and their stacks is
 749             labelled as &ldquo;TSO&rdquo; when displaying the profile
 750             by closure description or type description.</para>
 751           </listitem>
 752         </varlistentry>
 753       </variablelist>
 754
 755     </sect2>
 756
 757     <sect2 id="retainer-prof">
 758       <title>Retainer Profiling</title>
 759
 760       <para>Retainer profiling is designed to help answer questions
 761       like <quote>why is this data being retained?</quote>.  We start
 762       by defining what we mean by a retainer:</para>
 763
 764       <blockquote>
 765         <para>A retainer is either the system stack, or an unevaluated
 766         closure (thunk).</para>
 767       </blockquote>
 768
 769       <para>In particular, constructors are <emphasis>not</emphasis>
 770       retainers.</para>
 771
 772       <para>An object B retains object A if (i) B is a retainer object and
 773      (ii) object A can be reached by recursively following pointers
 774      starting from object B, but not meeting any other retainer
 775      objects on the way. Each live object is retained by one or more
 776      retainer objects, collectively called its retainer set, or its
 777       <firstterm>retainer set</firstterm>, or its
 778       <firstterm>retainers</firstterm>.</para>
 779
 780       <para>When retainer profiling is requested by giving the program
 781       the <option>-hr</option> option, a graph is generated which is
 782       broken down by retainer set.  A retainer set is displayed as a
 783       set of cost-centre stacks; because this is usually too large to
 784       fit on the profile graph, each retainer set is numbered and
 785       shown abbreviated on the graph along with its number, and the
 786       full list of retainer sets is dumped into the file
 787       <filename><replaceable>prog</replaceable>.prof</filename>.</para>
 788
 789       <para>Retainer profiling requires multiple passes over the live
 790       heap in order to discover the full retainer set for each
 791       object, which can be quite slow.  So we set a limit on the
 792       maximum size of a retainer set, where all retainer sets larger
 793       than the maximum retainer set size are replaced by the special
 794       set <literal>MANY</literal>.  The maximum set size defaults to 8
 795       and can be altered with the <option>-R</option> RTS
 796       option:</para>
 797
 798       <variablelist>
 799         <varlistentry>
 800           <term><option>-R</option><replaceable>size</replaceable></term>
 801           <listitem>
 802             <para>Restrict the number of elements in a retainer set to
 803             <replaceable>size</replaceable> (default 8).</para>
 804           </listitem>
 805         </varlistentry>
 806       </variablelist>
 807
 808       <sect3>
 809         <title>Hints for using retainer profiling</title>
 810
 811         <para>The definition of retainers is designed to reflect a
 812         common cause of space leaks: a large structure is retained by
 813         an unevaluated computation, and will be released once the
 814         computation is forced.  A good example is looking up a value in
 815         a finite map, where unless the lookup is forced in a timely
 816         manner the unevaluated lookup will cause the whole mapping to
 817         be retained.  These kind of space leaks can often be
 818         eliminated by forcing the relevant computations to be
 819         performed eagerly, using <literal>seq</literal> or strictness
 820         annotations on data constructor fields.</para>
 821
 822         <para>Often a particular data structure is being retained by a
 823         chain of unevaluated closures, only the nearest of which will
 824         be reported by retainer profiling - for example A retains B, B
 825         retains C, and C retains a large structure.  There might be a
 826         large number of Bs but only a single A, so A is really the one
 827         we're interested in eliminating.  However, retainer profiling
 828         will in this case report B as the retainer of the large
 829         structure.  To move further up the chain of retainers, we can
 830         ask for another retainer profile but this time restrict the
 831         profile to B objects, so we get a profile of the retainers of
 832         B:</para>
 833
 834 <screen>
 835 <replaceable>prog</replaceable> +RTS -hr -hcB
 836 </screen>
 837
 838         <para>This trick isn't foolproof, because there might be other
 839         B closures in the heap which aren't the retainers we are
 840         interested in, but we've found this to be a useful technique
 841         in most cases.</para>
 842       </sect3>
 843     </sect2>
 844
 845     <sect2 id="biography-prof">
 846       <title>Biographical Profiling</title>
 847
 848       <para>A typical heap object may be in one of the following four
 849       states at each point in its lifetime:</para>
 850
 851       <itemizedlist>
 852         <listitem>
 853           <para>The <firstterm>lag</firstterm> stage, which is the
 854           time between creation and the first use of the
 855           object,</para>
 856         </listitem>
 857         <listitem>
 858           <para>the <firstterm>use</firstterm> stage, which lasts from
 859           the first use until the last use of the object, and</para>
 860         </listitem>
 861         <listitem>
 862           <para>The <firstterm>drag</firstterm> stage, which lasts
 863           from the final use until the last reference to the object
 864           is dropped.</para>
 865         </listitem>
 866         <listitem>
 867           <para>An object which is never used is said to be in the
 868           <firstterm>void</firstterm> state for its whole
 869           lifetime.</para>
 870         </listitem>
 871       </itemizedlist>
 872
 873       <para>A biographical heap profile displays the portion of the
 874       live heap in each of the four states listed above.  Usually the
 875       most interesting states are the void and drag states: live heap
 876       in these states is more likely to be wasted space than heap in
 877       the lag or use states.</para>
 878
 879       <para>It is also possible to break down the heap in one or more
 880       of these states by a different criteria, by restricting a
 881       profile by biography.  For example, to show the portion of the
 882       heap in the drag or void state by producer: </para>
 883
 884 <screen>
 885 <replaceable>prog</replaceable> +RTS -hc -hbdrag,void
 886 </screen>
 887
 888       <para>Once you know the producer or the type of the heap in the
 889       drag or void states, the next step is usually to find the
 890       retainer(s):</para>
 891
 892 <screen>
 893 <replaceable>prog</replaceable> +RTS -hr -hc<replaceable>cc</replaceable>...
 894 </screen>
 895
 896       <para>NOTE: this two stage process is required because GHC
 897       cannot currently profile using both biographical and retainer
 898       information simultaneously.</para>
 899     </sect2>
 900
 901
 902
 903
 904
 905   </sect1>
 906
 907   <sect1 id="prof-xml-tool">
 908     <title>Graphical time/allocation profile</title>
 909
 910     <para>You can view the time and allocation profiling graph of your
 911     program graphically, using <command>ghcprof</command>.  This is a
 912     new tool with GHC 4.08, and will eventually be the de-facto
 913     standard way of viewing GHC profiles<footnote><para>Actually this
 914     isn't true any more, we are working on a new tool for
 915     displaying heap profiles using Gtk+HS, so
 916     <command>ghcprof</command> may go away at some point in the future.</para>
 917       </footnote></para>
 918
 919     <para>To run <command>ghcprof</command>, you need
 920     <productname>daVinci</productname> installed, which can be
 921     obtained from <ulink
 922     url="http://www.informatik.uni-bremen.de/daVinci/"><citetitle>The Graph
 923     Visualisation Tool daVinci</citetitle></ulink>.  Install one of
 924     the binary
 925     distributions<footnote><para><productname>daVinci</productname> is
 926     sadly not open-source :-(.</para></footnote>, and set your
 927     <envar>DAVINCIHOME</envar> environment variable to point to the
 928     installation directory.</para>
 929
 930     <para><command>ghcprof</command> uses an XML-based profiling log
 931     format, and you therefore need to run your program with a
 932     different option: <option>-px</option>.  The file generated is
 933     still called <filename>&lt;prog&gt;.prof</filename>.  To see the
 934     profile, run <command>ghcprof</command> like this:</para>
 935
 936     <indexterm><primary><option>-px</option></primary></indexterm>
 937
 938 <screen>
 939 $ ghcprof &lt;prog&gt;.prof
 940 </screen>
 941
 942     <para>which should pop up a window showing the call-graph of your
 943     program in glorious detail.  More information on using
 944     <command>ghcprof</command> can be found at <ulink
 945     url="http://www.dcs.warwick.ac.uk/people/academic/Stephen.Jarvis/profiler/index.html"><citetitle>The
 946     Cost-Centre Stack Profiling Tool for
 947     GHC</citetitle></ulink>.</para>
 948
 949   </sect1>
 950
 951   <sect1 id="hp2ps">
 952     <title><command>hp2ps</command>&ndash;&ndash;heap profile to PostScript</title>
 953
 954     <indexterm><primary><command>hp2ps</command></primary></indexterm>
 955     <indexterm><primary>heap profiles</primary></indexterm>
 956     <indexterm><primary>postscript, from heap profiles</primary></indexterm>
 957     <indexterm><primary><option>-h&lt;break-down&gt;</option></primary></indexterm>
 958
 959     <para>Usage:</para>
 960
 961 <screen>
 962 hp2ps [flags] [&lt;file&gt;[.hp]]
 963 </screen>
 964
 965     <para>The program
 966     <command>hp2ps</command><indexterm><primary>hp2ps
 967     program</primary></indexterm> converts a heap profile as produced
 968     by the <option>-h&lt;break-down&gt;</option> runtime option into a
 969     PostScript graph of the heap profile. By convention, the file to
 970     be processed by <command>hp2ps</command> has a
 971     <filename>.hp</filename> extension. The PostScript output is
 972     written to <filename>&lt;file&gt;@.ps</filename>. If
 973     <filename>&lt;file&gt;</filename> is omitted entirely, then the
 974     program behaves as a filter.</para>
 975
 976     <para><command>hp2ps</command> is distributed in
 977     <filename>ghc/utils/hp2ps</filename> in a GHC source
 978     distribution. It was originally developed by Dave Wakeling as part
 979     of the HBC/LML heap profiler.</para>
 980
 981     <para>The flags are:</para>
 982
 983     <variablelist>
 984
 985       <varlistentry>
 986         <term><option>-d</option></term>
 987         <listitem>
 988           <para>In order to make graphs more readable,
 989           <command>hp2ps</command> sorts the shaded bands for each
 990           identifier. The default sort ordering is for the bands with
 991           the largest area to be stacked on top of the smaller ones.
 992           The <option>-d</option> option causes rougher bands (those
 993           representing series of values with the largest standard
 994           deviations) to be stacked on top of smoother ones.</para>
 995         </listitem>
 996       </varlistentry>
 997
 998       <varlistentry>
 999         <term><option>-b</option></term>
1000         <listitem>
1001           <para>Normally, <command>hp2ps</command> puts the title of
1002           the graph in a small box at the top of the page. However, if
1003           the JOB string is too long to fit in a small box (more than
1004           35 characters), then <command>hp2ps</command> will choose to
1005           use a big box instead.  The <option>-b</option> option
1006           forces <command>hp2ps</command> to use a big box.</para>
1007         </listitem>
1008       </varlistentry>
1009
1010       <varlistentry>
1011         <term><option>-e&lt;float&gt;[in&verbar;mm&verbar;pt]</option></term>
1012         <listitem>
1013           <para>Generate encapsulated PostScript suitable for
1014           inclusion in LaTeX documents.  Usually, the PostScript graph
1015           is drawn in landscape mode in an area 9 inches wide by 6
1016           inches high, and <command>hp2ps</command> arranges for this
1017           area to be approximately centred on a sheet of a4 paper.
1018           This format is convenient of studying the graph in detail,
1019           but it is unsuitable for inclusion in LaTeX documents.  The
1020           <option>-e</option> option causes the graph to be drawn in
1021           portrait mode, with float specifying the width in inches,
1022           millimetres or points (the default).  The resulting
1023           PostScript file conforms to the Encapsulated PostScript
1024           (EPS) convention, and it can be included in a LaTeX document
1025           using Rokicki's dvi-to-PostScript converter
1026           <command>dvips</command>.</para>
1027         </listitem>
1028       </varlistentry>
1029
1030       <varlistentry>
1031         <term><option>-g</option></term>
1032         <listitem>
1033           <para>Create output suitable for the <command>gs</command>
1034           PostScript previewer (or similar). In this case the graph is
1035           printed in portrait mode without scaling. The output is
1036           unsuitable for a laser printer.</para>
1037         </listitem>
1038       </varlistentry>
1039
1040       <varlistentry>
1041         <term><option>-l</option></term>
1042         <listitem>
1043           <para>Normally a profile is limited to 20 bands with
1044           additional identifiers being grouped into an
1045           <literal>OTHER</literal> band. The <option>-l</option> flag
1046           removes this 20 band and limit, producing as many bands as
1047           necessary. No key is produced as it won't fit!. It is useful
1048           for creation time profiles with many bands.</para>
1049         </listitem>
1050       </varlistentry>
1051
1052       <varlistentry>
1053         <term><option>-m&lt;int&gt;</option></term>
1054         <listitem>
1055           <para>Normally a profile is limited to 20 bands with
1056           additional identifiers being grouped into an
1057           <literal>OTHER</literal> band. The <option>-m</option> flag
1058           specifies an alternative band limit (the maximum is
1059           20).</para>
1060
1061           <para><option>-m0</option> requests the band limit to be
1062           removed. As many bands as necessary are produced. However no
1063           key is produced as it won't fit! It is useful for displaying
1064           creation time profiles with many bands.</para>
1065         </listitem>
1066       </varlistentry>
1067
1068       <varlistentry>
1069         <term><option>-p</option></term>
1070         <listitem>
1071           <para>Use previous parameters. By default, the PostScript
1072           graph is automatically scaled both horizontally and
1073           vertically so that it fills the page.  However, when
1074           preparing a series of graphs for use in a presentation, it
1075           is often useful to draw a new graph using the same scale,
1076           shading and ordering as a previous one. The
1077           <option>-p</option> flag causes the graph to be drawn using
1078           the parameters determined by a previous run of
1079           <command>hp2ps</command> on <filename>file</filename>. These
1080           are extracted from <filename>file@.aux</filename>.</para>
1081         </listitem>
1082       </varlistentry>
1083
1084       <varlistentry>
1085         <term><option>-s</option></term>
1086         <listitem>
1087           <para>Use a small box for the title.</para>
1088         </listitem>
1089       </varlistentry>
1090
1091       <varlistentry>
1092         <term><option>-t&lt;float&gt;</option></term>
1093         <listitem>
1094           <para>Normally trace elements which sum to a total of less
1095           than 1&percnt; of the profile are removed from the
1096           profile. The <option>-t</option> option allows this
1097           percentage to be modified (maximum 5&percnt;).</para>
1098
1099           <para><option>-t0</option> requests no trace elements to be
1100           removed from the profile, ensuring that all the data will be
1101           displayed.</para>
1102         </listitem>
1103       </varlistentry>
1104
1105       <varlistentry>
1106         <term><option>-c</option></term>
1107         <listitem>
1108           <para>Generate colour output.</para>
1109         </listitem>
1110       </varlistentry>
1111
1112       <varlistentry>
1113         <term><option>-y</option></term>
1114         <listitem>
1115           <para>Ignore marks.</para>
1116         </listitem>
1117       </varlistentry>
1118
1119       <varlistentry>
1120         <term><option>-?</option></term>
1121         <listitem>
1122           <para>Print out usage information.</para>
1123         </listitem>
1124       </varlistentry>
1125     </variablelist>
1126
1127
1128     <sect2 id="manipulating-hp">
1129       <title>Manipulating the hp file</title>
1130
1131 <para>(Notes kindly offered by Jan-Willhem Maessen.)</para>
1132
1133 <para>
1134 The <filename>FOO.hp</filename> file produced when you ask for the
1135 heap profile of a program <filename>FOO</filename> is a text file with a particularly
1136 simple structure. Here's a representative example, with much of the
1137 actual data omitted:
1138 <screen>
1139 JOB "FOO -hC"
1140 DATE "Thu Dec 26 18:17 2002"
1141 SAMPLE_UNIT "seconds"
1142 VALUE_UNIT "bytes"
1143 BEGIN_SAMPLE 0.00
1144 END_SAMPLE 0.00
1145 BEGIN_SAMPLE 15.07
1146   ... sample data ...
1147 END_SAMPLE 15.07
1148 BEGIN_SAMPLE 30.23
1149   ... sample data ...
1150 END_SAMPLE 30.23
1151 ... etc.
1152 BEGIN_SAMPLE 11695.47
1153 END_SAMPLE 11695.47
1154 </screen>
1155 The first four lines (<literal>JOB</literal>, <literal>DATE</literal>, <literal>SAMPLE_UNIT</literal>, <literal>VALUE_UNIT</literal>) form a
1156 header.  Each block of lines starting with <literal>BEGIN_SAMPLE</literal> and ending
1157 with <literal>END_SAMPLE</literal> forms a single sample (you can think of this as a
1158 vertical slice of your heap profile).  The hp2ps utility should accept
1159 any input with a properly-formatted header followed by a series of
1160 *complete* samples.
1161 </para>
1162 </sect2>
1163
1164     <sect2>
1165       <title>Zooming in on regions of your profile</title>
1166
1167 <para>
1168 You can look at particular regions of your profile simply by loading a
1169 copy of the <filename>.hp</filename> file into a text editor and deleting the unwanted
1170 samples.  The resulting <filename>.hp</filename> file can be run through <command>hp2ps</command> and viewed
1171 or printed.
1172 </para>
1173 </sect2>
1174
1175     <sect2>
1176       <title>Viewing the heap profile of a running program</title>
1177
1178 <para>
1179 The <filename>.hp</filename> file is generated incrementally as your
1180 program runs.  In principle, running <command>hp2ps</command> on the incomplete file
1181 should produce a snapshot of your program's heap usage.  However, the
1182 last sample in the file may be incomplete, causing <command>hp2ps</command> to fail.  If
1183 you are using a machine with UNIX utilities installed, it's not too
1184 hard to work around this problem (though the resulting command line
1185 looks rather Byzantine):
1186 <screen>
1187   head -`fgrep -n END_SAMPLE FOO.hp | tail -1 | cut -d : -f 1` FOO.hp \
1188     | hp2ps > FOO.ps
1189 </screen>
1190
1191 The command <command>fgrep -n END_SAMPLE FOO.hp</command> finds the
1192 end of every complete sample in <filename>FOO.hp</filename>, and labels each sample with
1193 its ending line number.  We then select the line number of the last
1194 complete sample using <command>tail</command> and <command>cut</command>.  This is used as a
1195 parameter to <command>head</command>; the result is as if we deleted the final
1196 incomplete sample from <filename>FOO.hp</filename>.  This results in a properly-formatted
1197 .hp file which we feed directly to <command>hp2ps</command>.
1198 </para>
1199 </sect2>
1200     <sect2>
1201       <title>Viewing a heap profile in real time</title>
1202
1203 <para>
1204 The <command>gv</command> and <command>ghostview</command> programs
1205 have a "watch file" option can be used to view an up-to-date heap
1206 profile of your program as it runs.  Simply generate an incremental
1207 heap profile as described in the previous section.  Run <command>gv</command> on your
1208 profile:
1209 <screen>
1210   gv -watch -seascape FOO.ps
1211 </screen>
1212 If you forget the <literal>-watch</literal> flag you can still select
1213 "Watch file" from the "State" menu.  Now each time you generate a new
1214 profile <filename>FOO.ps</filename> the view will update automatically.
1215 </para>
1216
1217 <para>
1218 This can all be encapsulated in a little script:
1219 <screen>
1220   #!/bin/sh
1221   head -`fgrep -n END_SAMPLE FOO.hp | tail -1 | cut -d : -f 1` FOO.hp \
1222     | hp2ps > FOO.ps
1223   gv -watch -seascape FOO.ps &amp;
1224   while [ 1 ] ; do
1225     sleep 10 # We generate a new profile every 10 seconds.
1226     head -`fgrep -n END_SAMPLE FOO.hp | tail -1 | cut -d : -f 1` FOO.hp \
1227       | hp2ps > FOO.ps
1228   done
1229 </screen>
1230 Occasionally <command>gv</command> will choke as it tries to read an incomplete copy of
1231 <filename>FOO.ps</filename> (because <command>hp2ps</command> is still running as an update
1232 occurs).  A slightly more complicated script works around this
1233 problem, by using the fact that sending a SIGHUP to gv will cause it
1234 to re-read its input file:
1235 <screen>
1236   #!/bin/sh
1237   head -`fgrep -n END_SAMPLE FOO.hp | tail -1 | cut -d : -f 1` FOO.hp \
1238     | hp2ps > FOO.ps
1239   gv FOO.ps &amp;
1240   gvpsnum=$!
1241   while [ 1 ] ; do
1242     sleep 10
1243     head -`fgrep -n END_SAMPLE FOO.hp | tail -1 | cut -d : -f 1` FOO.hp \
1244       | hp2ps > FOO.ps
1245     kill -HUP $gvpsnum
1246   done
1247 </screen>
1248 </para>
1249 </sect2>
1250
1251
1252   </sect1>
1253
1254   <sect1 id="ticky-ticky">
1255     <title>Using &ldquo;ticky-ticky&rdquo; profiling (for implementors)</title>
1256     <indexterm><primary>ticky-ticky profiling</primary></indexterm>
1257
1258     <para>(ToDo: document properly.)</para>
1259
1260     <para>It is possible to compile Glasgow Haskell programs so that
1261     they will count lots and lots of interesting things, e.g., number
1262     of updates, number of data constructors entered, etc., etc.  We
1263     call this &ldquo;ticky-ticky&rdquo;
1264     profiling,<indexterm><primary>ticky-ticky
1265     profiling</primary></indexterm> <indexterm><primary>profiling,
1266     ticky-ticky</primary></indexterm> because that's the sound a Sun4
1267     makes when it is running up all those counters
1268     (<emphasis>slowly</emphasis>).</para>
1269
1270     <para>Ticky-ticky profiling is mainly intended for implementors;
1271     it is quite separate from the main &ldquo;cost-centre&rdquo;
1272     profiling system, intended for all users everywhere.</para>
1273
1274     <para>To be able to use ticky-ticky profiling, you will need to
1275     have built appropriate libraries and things when you made the
1276     system.  See &ldquo;Customising what libraries to build,&rdquo; in
1277     the installation guide.</para>
1278
1279     <para>To get your compiled program to spit out the ticky-ticky
1280     numbers, use a <option>-r</option> RTS
1281     option<indexterm><primary>-r RTS option</primary></indexterm>.
1282     See <xref linkend="runtime-control"/>.</para>
1283
1284     <para>Compiling your program with the <option>-ticky</option>
1285     switch yields an executable that performs these counts.  Here is a
1286     sample ticky-ticky statistics file, generated by the invocation
1287     <command>foo +RTS -rfoo.ticky</command>.</para>
1288
1289 <screen>
1290  foo +RTS -rfoo.ticky
1291
1292
1293 ALLOCATIONS: 3964631 (11330900 words total: 3999476 admin, 6098829 goods, 1232595 slop)
1294                                 total words:        2     3     4     5    6+
1295   69647 (  1.8%) function values                 50.0  50.0   0.0   0.0   0.0
1296 2382937 ( 60.1%) thunks                           0.0  83.9  16.1   0.0   0.0
1297 1477218 ( 37.3%) data values                     66.8  33.2   0.0   0.0   0.0
1298       0 (  0.0%) big tuples
1299       2 (  0.0%) black holes                      0.0 100.0   0.0   0.0   0.0
1300       0 (  0.0%) prim things
1301   34825 (  0.9%) partial applications             0.0   0.0   0.0 100.0   0.0
1302       2 (  0.0%) thread state objects             0.0   0.0   0.0   0.0 100.0
1303
1304 Total storage-manager allocations: 3647137 (11882004 words)
1305         [551104 words lost to speculative heap-checks]
1306
1307 STACK USAGE:
1308
1309 ENTERS: 9400092  of which 2005772 (21.3%) direct to the entry code
1310                   [the rest indirected via Node's info ptr]
1311 1860318 ( 19.8%) thunks
1312 3733184 ( 39.7%) data values
1313 3149544 ( 33.5%) function values
1314                   [of which 1999880 (63.5%) bypassed arg-satisfaction chk]
1315  348140 (  3.7%) partial applications
1316  308906 (  3.3%) normal indirections
1317       0 (  0.0%) permanent indirections
1318
1319 RETURNS: 5870443
1320 2137257 ( 36.4%) from entering a new constructor
1321                   [the rest from entering an existing constructor]
1322 2349219 ( 40.0%) vectored [the rest unvectored]
1323
1324 RET_NEW:         2137257:  32.5% 46.2% 21.3%  0.0%  0.0%  0.0%  0.0%  0.0%  0.0%
1325 RET_OLD:         3733184:   2.8% 67.9% 29.3%  0.0%  0.0%  0.0%  0.0%  0.0%  0.0%
1326 RET_UNBOXED_TUP:       2:   0.0%  0.0%100.0%  0.0%  0.0%  0.0%  0.0%  0.0%  0.0%
1327
1328 RET_VEC_RETURN : 2349219:   0.0%  0.0%100.0%  0.0%  0.0%  0.0%  0.0%  0.0%  0.0%
1329
1330 UPDATE FRAMES: 2241725 (0 omitted from thunks)
1331 SEQ FRAMES:    1
1332 CATCH FRAMES:  1
1333 UPDATES: 2241725
1334       0 (  0.0%) data values
1335   34827 (  1.6%) partial applications
1336                   [2 in place, 34825 allocated new space]
1337 2206898 ( 98.4%) updates to existing heap objects (46 by squeezing)
1338 UPD_CON_IN_NEW:         0:       0      0      0      0      0      0      0      0      0
1339 UPD_PAP_IN_NEW:     34825:       0      0      0  34825      0      0      0      0      0
1340
1341 NEW GEN UPDATES: 2274700 ( 99.9%)
1342
1343 OLD GEN UPDATES: 1852 (  0.1%)
1344
1345 Total bytes copied during GC: 190096
1346
1347 **************************************************
1348 3647137 ALLOC_HEAP_ctr
1349 11882004 ALLOC_HEAP_tot
1350   69647 ALLOC_FUN_ctr
1351   69647 ALLOC_FUN_adm
1352   69644 ALLOC_FUN_gds
1353   34819 ALLOC_FUN_slp
1354   34831 ALLOC_FUN_hst_0
1355   34816 ALLOC_FUN_hst_1
1356       0 ALLOC_FUN_hst_2
1357       0 ALLOC_FUN_hst_3
1358       0 ALLOC_FUN_hst_4
1359 2382937 ALLOC_UP_THK_ctr
1360       0 ALLOC_SE_THK_ctr
1361  308906 ENT_IND_ctr
1362       0 E!NT_PERM_IND_ctr requires +RTS -Z
1363 [... lots more info omitted ...]
1364       0 GC_SEL_ABANDONED_ctr
1365       0 GC_SEL_MINOR_ctr
1366       0 GC_SEL_MAJOR_ctr
1367       0 GC_FAILED_PROMOTION_ctr
1368   47524 GC_WORDS_COPIED_ctr
1369 </screen>
1370
1371     <para>The formatting of the information above the row of asterisks
1372     is subject to change, but hopefully provides a useful
1373     human-readable summary.  Below the asterisks <emphasis>all
1374     counters</emphasis> maintained by the ticky-ticky system are
1375     dumped, in a format intended to be machine-readable: zero or more
1376     spaces, an integer, a space, the counter name, and a newline.</para>
1377
1378     <para>In fact, not <emphasis>all</emphasis> counters are
1379     necessarily dumped; compile- or run-time flags can render certain
1380     counters invalid.  In this case, either the counter will simply
1381     not appear, or it will appear with a modified counter name,
1382     possibly along with an explanation for the omission (notice
1383     <literal>ENT&lowbar;PERM&lowbar;IND&lowbar;ctr</literal> appears
1384     with an inserted <literal>!</literal> above).  Software analysing
1385     this output should always check that it has the counters it
1386     expects.  Also, beware: some of the counters can have
1387     <emphasis>large</emphasis> values!</para>
1388
1389   </sect1>
1390
1391 </chapter>
1392
1393 <!-- Emacs stuff:
1394      ;;; Local Variables: ***
1395      ;;; mode: xml ***
1396      ;;; sgml-parent-document: ("users_guide.xml" "book" "chapter") ***
1397      ;;; End: ***
1398  -->