[project @ 2005-01-28 12:55:17 by simonmar]
[ghc-hetmet.git] / ghc / docs / users_guide / runtime_control.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <sect1 id="runtime-control">
3   <title>Running a compiled program</title>
4
5   <indexterm><primary>runtime control of Haskell programs</primary></indexterm>
6   <indexterm><primary>running, compiled program</primary></indexterm>
7   <indexterm><primary>RTS options</primary></indexterm>
8
9   <para>To make an executable program, the GHC system compiles your
10   code and then links it with a non-trivial runtime system (RTS),
11   which handles storage management, profiling, etc.</para>
12
13   <para>You have some control over the behaviour of the RTS, by giving
14   special command-line arguments to your program.</para>
15
16   <para>When your Haskell program starts up, its RTS extracts
17   command-line arguments bracketed between
18   <option>+RTS</option><indexterm><primary><option>+RTS</option></primary></indexterm>
19   and
20   <option>-RTS</option><indexterm><primary><option>-RTS</option></primary></indexterm>
21   as its own.  For example:</para>
22
23 <screen>
24 % ./a.out -f +RTS -p -S -RTS -h foo bar
25 </screen>
26
27   <para>The RTS will snaffle <option>-p</option> <option>-S</option>
28   for itself, and the remaining arguments <literal>-f -h foo bar</literal>
29   will be handed to your program if/when it calls
30   <function>System.getArgs</function>.</para>
31
32   <para>No <option>-RTS</option> option is required if the
33   runtime-system options extend to the end of the command line, as in
34   this example:</para>
35
36 <screen>
37 % hls -ltr /usr/etc +RTS -A5m
38 </screen>
39
40   <para>If you absolutely positively want all the rest of the options
41   in a command line to go to the program (and not the RTS), use a
42   <option>&ndash;&ndash;RTS</option><indexterm><primary><option>--RTS</option></primary></indexterm>.</para>
43
44   <para>As always, for RTS options that take
45   <replaceable>size</replaceable>s: If the last character of
46   <replaceable>size</replaceable> is a K or k, multiply by 1000; if an
47   M or m, by 1,000,000; if a G or G, by 1,000,000,000.  (And any
48   wraparound in the counters is <emphasis>your</emphasis>
49   fault!)</para>
50
51   <para>Giving a <literal>+RTS -f</literal>
52   <indexterm><primary><option>-f</option></primary><secondary>RTS option</secondary></indexterm> option
53   will print out the RTS options actually available in your program
54   (which vary, depending on how you compiled).</para>
55
56   <para>NOTE: since GHC is itself compiled by GHC, you can change RTS
57   options in the compiler using the normal
58   <literal>+RTS ... -RTS</literal>
59   combination.  eg. to increase the maximum heap
60   size for a compilation to 128M, you would add
61   <literal>+RTS -M128m -RTS</literal>
62   to the command line.</para>
63
64   <sect2 id="rts-optinos-environment">
65     <title>Setting global RTS options</title>
66
67     <indexterm><primary>RTS options</primary><secondary>from the environment</secondary></indexterm>
68     <indexterm><primary>environment variable</primary><secondary>for
69     setting RTS options</secondary></indexterm>
70
71     <para>RTS options are also taken from the environment variable
72     <envar>GHCRTS</envar><indexterm><primary><envar>GHCRTS</envar></primary>
73       </indexterm>.  For example, to set the maximum heap size
74     to 128M for all GHC-compiled programs (using an
75     <literal>sh</literal>-like shell):</para>
76
77 <screen>
78    GHCRTS='-M128m'
79    export GHCRTS
80 </screen>
81
82     <para>RTS options taken from the <envar>GHCRTS</envar> environment
83     variable can be overridden by options given on the command
84     line.</para>
85
86   </sect2>
87
88   <sect2 id="rts-options-gc">
89     <title>RTS options to control the garbage collector</title>
90
91     <indexterm><primary>garbage collector</primary><secondary>options</secondary></indexterm>
92     <indexterm><primary>RTS options</primary><secondary>garbage collection</secondary></indexterm>
93
94     <para>There are several options to give you precise control over
95     garbage collection.  Hopefully, you won't need any of these in
96     normal operation, but there are several things that can be tweaked
97     for maximum performance.</para>
98
99     <variablelist>
100
101       <varlistentry>
102         <term>
103           <option>-A</option><replaceable>size</replaceable>
104           <indexterm><primary><option>-A</option></primary><secondary>RTS option</secondary></indexterm>
105           <indexterm><primary>allocation area, size</primary></indexterm>
106         </term>
107         <listitem>
108           <para>&lsqb;Default: 256k&rsqb; Set the allocation area size
109           used by the garbage collector.  The allocation area
110           (actually generation 0 step 0) is fixed and is never resized
111           (unless you use <option>-H</option>, below).</para>
112
113           <para>Increasing the allocation area size may or may not
114           give better performance (a bigger allocation area means
115           worse cache behaviour but fewer garbage collections and less
116           promotion).</para>
117
118           <para>With only 1 generation (<option>-G1</option>) the
119           <option>-A</option> option specifies the minimum allocation
120           area, since the actual size of the allocation area will be
121           resized according to the amount of data in the heap (see
122           <option>-F</option>, below).</para>
123         </listitem>
124       </varlistentry>
125
126       <varlistentry>
127         <term>
128           <option>-c</option>
129           <indexterm><primary><option>-c</option></primary><secondary>RTS option</secondary></indexterm>
130           <indexterm><primary>garbage collection</primary><secondary>compacting</secondary></indexterm>
131           <indexterm><primary>compacting garbage collection</primary></indexterm>
132         </term>
133         <listitem>
134           <para>Use a compacting algorithm for collecting the oldest
135           generation.  By default, the oldest generation is collected
136           using a copying algorithm; this option causes it to be
137           compacted in-place instead.  The compaction algorithm is
138           slower than the copying algorithm, but the savings in memory
139           use can be considerable.</para>
140
141           <para>For a given heap size (using the <option>-H</option>
142           option), compaction can in fact reduce the GC cost by
143           allowing fewer GCs to be performed.  This is more likely
144           when the ratio of live data to heap size is high, say
145           &gt;30&percnt;.</para>
146
147           <para>NOTE: compaction doesn't currently work when a single
148           generation is requested using the <option>-G1</option>
149           option.</para>
150         </listitem>
151       </varlistentry>
152
153       <varlistentry>
154         <term><option>-c</option><replaceable>n</replaceable></term>
155
156         <listitem>
157           <para>&lsqb;Default: 30&rsqb; Automatically enable
158           compacting collection when the live data exceeds
159           <replaceable>n</replaceable>&percnt; of the maximum heap size
160           (see the <option>-M</option> option).  Note that the maximum
161           heap size is unlimited by default, so this option has no
162           effect unless the maximum heap size is set with
163           <option>-M</option><replaceable>size</replaceable>. </para>
164         </listitem>
165       </varlistentry>
166
167       <varlistentry>
168         <term>
169           <option>-F</option><replaceable>factor</replaceable>
170           <indexterm><primary><option>-F</option></primary><secondary>RTS option</secondary></indexterm>
171           <indexterm><primary>heap size, factor</primary></indexterm>
172         </term>
173         <listitem>
174
175           <para>&lsqb;Default: 2&rsqb; This option controls the amount
176           of memory reserved for the older generations (and in the
177           case of a two space collector the size of the allocation
178           area) as a factor of the amount of live data.  For example,
179           if there was 2M of live data in the oldest generation when
180           we last collected it, then by default we'll wait until it
181           grows to 4M before collecting it again.</para>
182
183           <para>The default seems to work well here.  If you have
184           plenty of memory, it is usually better to use
185           <option>-H</option><replaceable>size</replaceable> than to
186           increase
187           <option>-F</option><replaceable>factor</replaceable>.</para>
188
189           <para>The <option>-F</option> setting will be automatically
190           reduced by the garbage collector when the maximum heap size
191           (the <option>-M</option><replaceable>size</replaceable>
192           setting) is approaching.</para>
193         </listitem>
194       </varlistentry>
195
196       <varlistentry>
197         <term>
198           <option>-G</option><replaceable>generations</replaceable>
199           <indexterm><primary><option>-G</option></primary><secondary>RTS option</secondary></indexterm>
200           <indexterm><primary>generations, number of</primary></indexterm>
201         </term>
202         <listitem>
203           <para>&lsqb;Default: 2&rsqb; Set the number of generations
204           used by the garbage collector.  The default of 2 seems to be
205           good, but the garbage collector can support any number of
206           generations.  Anything larger than about 4 is probably not a
207           good idea unless your program runs for a
208           <emphasis>long</emphasis> time, because the oldest
209           generation will hardly ever get collected.</para>
210
211           <para>Specifying 1 generation with <option>+RTS -G1</option>
212           gives you a simple 2-space collector, as you would expect.
213           In a 2-space collector, the <option>-A</option> option (see
214           above) specifies the <emphasis>minimum</emphasis> allocation
215           area size, since the allocation area will grow with the
216           amount of live data in the heap.  In a multi-generational
217           collector the allocation area is a fixed size (unless you
218           use the <option>-H</option> option, see below).</para>
219         </listitem>
220       </varlistentry>
221
222       <varlistentry>
223         <term>
224           <option>-H</option><replaceable>size</replaceable>
225           <indexterm><primary><option>-H</option></primary><secondary>RTS option</secondary></indexterm>
226           <indexterm><primary>heap size, suggested</primary></indexterm>
227         </term>
228         <listitem>
229           <para>&lsqb;Default: 0&rsqb; This option provides a
230           &ldquo;suggested heap size&rdquo; for the garbage collector.  The
231           garbage collector will use about this much memory until the
232           program residency grows and the heap size needs to be
233           expanded to retain reasonable performance.</para>
234
235           <para>By default, the heap will start small, and grow and
236           shrink as necessary.  This can be bad for performance, so if
237           you have plenty of memory it's worthwhile supplying a big
238           <option>-H</option><replaceable>size</replaceable>.  For
239           improving GC performance, using
240           <option>-H</option><replaceable>size</replaceable> is
241           usually a better bet than
242           <option>-A</option><replaceable>size</replaceable>.</para>
243         </listitem>
244       </varlistentry>
245
246       <varlistentry>
247         <term>
248          <option>-k</option><replaceable>size</replaceable>
249          <indexterm><primary><option>-k</option></primary><secondary>RTS option</secondary></indexterm>
250          <indexterm><primary>stack, minimum size</primary></indexterm>
251         </term>
252         <listitem>
253           <para>&lsqb;Default: 1k&rsqb; Set the initial stack size for
254           new threads.  Thread stacks (including the main thread's
255           stack) live on the heap, and grow as required.  The default
256           value is good for concurrent applications with lots of small
257           threads; if your program doesn't fit this model then
258           increasing this option may help performance.</para>
259
260           <para>The main thread is normally started with a slightly
261           larger heap to cut down on unnecessary stack growth while
262           the program is starting up.</para>
263         </listitem>
264       </varlistentry>
265
266       <varlistentry>
267         <term>
268           <option>-K</option><replaceable>size</replaceable>
269           <indexterm><primary><option>-K</option></primary><secondary>RTS option</secondary></indexterm>
270           <indexterm><primary>stack, maximum size</primary></indexterm>
271         </term>
272         <listitem>
273           <para>&lsqb;Default: 8M&rsqb; Set the maximum stack size for
274           an individual thread to <replaceable>size</replaceable>
275           bytes.  This option is there purely to stop the program
276           eating up all the available memory in the machine if it gets
277           into an infinite loop.</para>
278         </listitem>
279       </varlistentry>
280
281       <varlistentry>
282         <term>
283           <option>-m</option><replaceable>n</replaceable>
284           <indexterm><primary><option>-m</option></primary><secondary>RTS option</secondary></indexterm>
285           <indexterm><primary>heap, minimum free</primary></indexterm>
286         </term>
287         <listitem>
288           <para>Minimum &percnt; <replaceable>n</replaceable> of heap
289           which must be available for allocation.  The default is
290           3&percnt;.</para>
291         </listitem>
292       </varlistentry>
293
294       <varlistentry>
295         <term>
296           <option>-M</option><replaceable>size</replaceable>
297           <indexterm><primary><option>-M</option></primary><secondary>RTS option</secondary></indexterm>
298           <indexterm><primary>heap size, maximum</primary></indexterm>
299         </term>
300         <listitem>
301           <para>&lsqb;Default: unlimited&rsqb; Set the maximum heap size to
302           <replaceable>size</replaceable> bytes.  The heap normally
303           grows and shrinks according to the memory requirements of
304           the program.  The only reason for having this option is to
305           stop the heap growing without bound and filling up all the
306           available swap space, which at the least will result in the
307           program being summarily killed by the operating
308           system.</para>
309
310           <para>The maximum heap size also affects other garbage
311           collection parameters: when the amount of live data in the
312           heap exceeds a certain fraction of the maximum heap size,
313           compacting collection will be automatically enabled for the
314           oldest generation, and the <option>-F</option> parameter
315           will be reduced in order to avoid exceeding the maximum heap
316           size.</para>
317         </listitem>
318       </varlistentry>
319
320       <varlistentry>
321         <term>
322           <option>-s</option><replaceable>file</replaceable>
323           <indexterm><primary><option>-s</option></primary><secondary>RTS option</secondary></indexterm>
324         </term>
325         <term>
326           <option>-S</option><replaceable>file</replaceable>
327           <indexterm><primary><option>-S</option></primary><secondary>RTS option</secondary></indexterm>
328         </term>
329         <listitem>
330           <para>Write modest (<option>-s</option>) or verbose
331           (<option>-S</option>) garbage-collector statistics into file
332           <replaceable>file</replaceable>. The default
333           <replaceable>file</replaceable> is
334           <filename><replaceable>program</replaceable>.stat</filename>. The
335           <replaceable>file</replaceable> <constant>stderr</constant>
336           is treated specially, with the output really being sent to
337           <constant>stderr</constant>.</para>
338
339           <para>This option is useful for watching how the storage
340           manager adjusts the heap size based on the current amount of
341           live data.</para>
342         </listitem>
343       </varlistentry>
344
345       <varlistentry>
346         <term>
347           <option>-t</option>
348           <indexterm><primary><option>-t</option></primary><secondary>RTS option</secondary></indexterm>
349         </term>
350         <listitem>
351           <para>Write a one-line GC stats summary after running the
352           program.  This output is in the same format as that produced
353           by the <option>-Rghc-timing</option> option.</para>
354         </listitem>
355       </varlistentry>
356     </variablelist>
357
358   </sect2>
359
360   <sect2>
361     <title>RTS options for profiling and Concurrent/Parallel Haskell</title>
362
363     <para>The RTS options related to profiling are described in <xref
364     linkend="rts-options-heap-prof"/>; and those for concurrent/parallel
365     stuff, in <xref linkend="parallel-rts-opts"/>.</para>
366   </sect2>
367
368   <sect2 id="rts-options-debugging">
369     <title>RTS options for hackers, debuggers, and over-interested
370     souls</title>
371
372     <indexterm><primary>RTS options, hacking/debugging</primary></indexterm>
373
374     <para>These RTS options might be used (a)&nbsp;to avoid a GHC bug,
375     (b)&nbsp;to see &ldquo;what's really happening&rdquo;, or
376     (c)&nbsp;because you feel like it.  Not recommended for everyday
377     use!</para>
378
379     <variablelist>
380
381       <varlistentry>
382         <term>
383           <option>-B</option>
384           <indexterm><primary><option>-B</option></primary><secondary>RTS option</secondary></indexterm>
385         </term>
386         <listitem>
387           <para>Sound the bell at the start of each (major) garbage
388           collection.</para>
389
390           <para>Oddly enough, people really do use this option!  Our
391           pal in Durham (England), Paul Callaghan, writes: &ldquo;Some
392           people here use it for a variety of
393           purposes&mdash;honestly!&mdash;e.g., confirmation that the
394           code/machine is doing something, infinite loop detection,
395           gauging cost of recently added code. Certain people can even
396           tell what stage &lsqb;the program&rsqb; is in by the beep
397           pattern. But the major use is for annoying others in the
398           same office&hellip;&rdquo;</para>
399         </listitem>
400       </varlistentry>
401
402       <varlistentry>
403         <term>
404           <option>-D</option><replaceable>num</replaceable>
405           <indexterm><primary>-D</primary><secondary>RTS option</secondary></indexterm>
406         </term>
407         <listitem>
408           <para>An RTS debugging flag; varying quantities of output
409           depending on which bits are set in
410           <replaceable>num</replaceable>.  Only works if the RTS was
411           compiled with the <option>DEBUG</option> option.</para>
412         </listitem>
413       </varlistentry>
414
415       <varlistentry>
416         <term>
417           <option>-r</option><replaceable>file</replaceable>
418           <indexterm><primary><option>-r</option></primary><secondary>RTS option</secondary></indexterm>
419           <indexterm><primary>ticky ticky profiling</primary></indexterm>
420           <indexterm><primary>profiling</primary><secondary>ticky ticky</secondary></indexterm>
421         </term>
422         <listitem>
423           <para>Produce &ldquo;ticky-ticky&rdquo; statistics at the
424           end of the program run.  The <replaceable>file</replaceable>
425           business works just like on the <option>-S</option> RTS
426           option (above).</para>
427
428           <para>&ldquo;Ticky-ticky&rdquo; statistics are counts of
429           various program actions (updates, enters, etc.)  The program
430           must have been compiled using
431           <option>-ticky</option><indexterm><primary><option>-ticky</option></primary></indexterm>
432           (a.k.a. &ldquo;ticky-ticky profiling&rdquo;), and, for it to
433           be really useful, linked with suitable system libraries.
434           Not a trivial undertaking: consult the installation guide on
435           how to set things up for easy &ldquo;ticky-ticky&rdquo;
436           profiling.  For more information, see <xref
437           linkend="ticky-ticky"/>.</para>
438         </listitem>
439       </varlistentry>
440
441       <varlistentry>
442         <term>
443           <option>-xc</option>
444           <indexterm><primary><option>-xc</option></primary><secondary>RTS option</secondary></indexterm>
445         </term>
446         <listitem>
447           <para>(Only available when the program is compiled for
448           profiling.)  When an exception is raised in the program,
449           this option causes the current cost-centre-stack to be
450           dumped to <literal>stderr</literal>.</para>
451
452           <para>This can be particularly useful for debugging: if your
453           program is complaining about a <literal>head []</literal>
454           error and you haven't got a clue which bit of code is
455           causing it, compiling with <literal>-prof
456           -auto-all</literal> and running with <literal>+RTS -xc
457           -RTS</literal> will tell you exactly the call stack at the
458           point the error was raised.</para>
459
460           <para>The output contains one line for each exception raised
461           in the program (the program might raise and catch several
462           exceptions during its execution), where each line is of the
463           form:</para>
464
465 <screen>
466 &lt; cc<subscript>1</subscript>, ..., cc<subscript>n</subscript> &gt;
467 </screen>
468           <para>each <literal>cc</literal><subscript>i</subscript> is
469           a cost centre in the program (see <xref
470           linkend="cost-centres"/>), and the sequence represents the
471           &ldquo;call stack&rdquo; at the point the exception was
472           raised.  The leftmost item is the innermost function in the
473           call stack, and the rightmost item is the outermost
474           function.</para>
475
476         </listitem>
477       </varlistentry>
478
479       <varlistentry>
480         <term>
481           <option>-Z</option>
482           <indexterm><primary><option>-Z</option></primary><secondary>RTS option</secondary></indexterm>
483         </term>
484         <listitem>
485           <para>Turn <emphasis>off</emphasis> &ldquo;update-frame
486           squeezing&rdquo; at garbage-collection time.  (There's no
487           particularly good reason to turn it off, except to ensure
488           the accuracy of certain data collected regarding thunk entry
489           counts.)</para>
490         </listitem>
491       </varlistentry>
492     </variablelist>
493
494   </sect2>
495
496   <sect2 id="rts-hooks">
497     <title>&ldquo;Hooks&rdquo; to change RTS behaviour</title>
498
499     <indexterm><primary>hooks</primary><secondary>RTS</secondary></indexterm>
500     <indexterm><primary>RTS hooks</primary></indexterm>
501     <indexterm><primary>RTS behaviour, changing</primary></indexterm>
502
503     <para>GHC lets you exercise rudimentary control over the RTS
504     settings for any given program, by compiling in a
505     &ldquo;hook&rdquo; that is called by the run-time system.  The RTS
506     contains stub definitions for all these hooks, but by writing your
507     own version and linking it on the GHC command line, you can
508     override the defaults.</para>
509
510     <para>Owing to the vagaries of DLL linking, these hooks don't work
511     under Windows when the program is built dynamically.</para>
512
513     <para>The hook <literal>ghc_rts_opts</literal><indexterm><primary><literal>ghc_rts_opts</literal></primary>
514       </indexterm>lets you set RTS
515     options permanently for a given program.  A common use for this is
516     to give your program a default heap and/or stack size that is
517     greater than the default.  For example, to set <literal>-H128m
518     -K1m</literal>, place the following definition in a C source
519     file:</para>
520
521 <programlisting>
522 char *ghc_rts_opts = "-H128m -K1m";
523 </programlisting>
524
525     <para>Compile the C file, and include the object file on the
526     command line when you link your Haskell program.</para>
527
528     <para>These flags are interpreted first, before any RTS flags from
529     the <literal>GHCRTS</literal> environment variable and any flags
530     on the command line.</para>
531
532     <para>You can also change the messages printed when the runtime
533     system &ldquo;blows up,&rdquo; e.g., on stack overflow.  The hooks
534     for these are as follows:</para>
535
536     <variablelist>
537
538       <varlistentry>
539         <term>
540           <function>void OutOfHeapHook (unsigned long, unsigned long)</function>
541           <indexterm><primary><function>OutOfHeapHook</function></primary></indexterm>
542         </term>
543         <listitem>
544           <para>The heap-overflow message.</para>
545         </listitem>
546       </varlistentry>
547
548       <varlistentry>
549         <term>
550           <function>void StackOverflowHook (long int)</function>
551           <indexterm><primary><function>StackOverflowHook</function></primary></indexterm>
552         </term>
553         <listitem>
554           <para>The stack-overflow message.</para>
555         </listitem>
556       </varlistentry>
557
558       <varlistentry>
559         <term>
560           <function>void MallocFailHook (long int)</function>
561           <indexterm><primary><function>MallocFailHook</function></primary></indexterm>
562         </term>
563         <listitem>
564           <para>The message printed if <function>malloc</function>
565           fails.</para>
566         </listitem>
567       </varlistentry>
568     </variablelist>
569
570     <para>For examples of the use of these hooks, see GHC's own
571     versions in the file
572     <filename>ghc/compiler/parser/hschooks.c</filename> in a GHC
573     source tree.</para>
574   </sect2>
575 </sect1>
576
577 <!-- Emacs stuff:
578      ;;; Local Variables: ***
579      ;;; mode: xml ***
580      ;;; sgml-parent-document: ("users_guide.xml" "book" "chapter" "sect1") ***
581      ;;; End: ***
582  -->