1 <chapter id="using-ghc">
2 <title>Using GHC</title>
4 <indexterm><primary>GHC, using</primary></indexterm>
5 <indexterm><primary>using GHC</primary></indexterm>
7 <para>GHC can work in one of three “modes”:</para>
11 <term><cmdsynopsis><command>ghc</command>
12 <arg choice=plain>––interactive</arg>
14 <indexterm><primary>interactive mode</primary>
16 <indexterm><primary>ghci</primary>
19 <para>Interactive mode, which is also available as
20 <command>ghci</command>. Interactive mode is described in
21 more detail in <xref linkend="ghci">.</para>
26 <term><cmdsynopsis><command>ghc</command>
27 <arg choice=plain>––make</arg>
29 <indexterm><primary>make mode</primary>
31 <indexterm><primary><option>––make</option></primary>
34 <para>In this mode, GHC will build a multi-module Haskell
35 program automatically, figuring out dependencies for itself.
36 If you have a straightforward Haskell program, this is likely
37 to be much easier, and faster, than using
38 <command>make</command>.</para>
44 <command>ghc</command>
52 <indexterm><primary><option>-E</option></primary></indexterm>
53 <indexterm><primary><option>-C</option></primary></indexterm>
54 <indexterm><primary><option>-S</option></primary></indexterm>
55 <indexterm><primary><option>-c</option></primary></indexterm>
57 <para>This is the traditional batch-compiler mode, in which
58 GHC can compile source files one at a time, or link objects
59 together into an executable.</para>
65 <title>Options overview</title>
67 <para>GHC's behaviour is controlled by
68 <firstterm>options</firstterm>, which for historical reasons are
69 also sometimes referred to as command-line flags or arguments.
70 Options can be specified in three ways:</para>
73 <title>Command-line arguments</title>
75 <indexterm><primary>structure, command-line</primary></indexterm>
76 <indexterm><primary>command-line</primary><secondary>arguments</secondary></indexterm>
77 <indexterm><primary>arguments</primary><secondary>command-line</secondary></indexterm>
79 <para>An invocation of GHC takes the following form:</para>
85 <para>Command-line arguments are either options or file names.</para>
87 <para>Command-line options begin with <literal>-</literal>.
88 They may <emphasis>not</emphasis> be grouped:
89 <option>-vO</option> is different from <option>-v -O</option>.
90 Options need not precede filenames: e.g., <literal>ghc *.o -o
91 foo</literal>. All options are processed and then applied to
92 all files; you cannot, for example, invoke <literal>ghc -c -O1
93 Foo.hs -O2 Bar.hs</literal> to apply different optimisation
94 levels to the files <filename>Foo.hs</filename> and
95 <filename>Bar.hs</filename>.</para>
98 <Sect2 id="source-file-options">
99 <title>Command line options in source files</title>
101 <indexterm><primary>source-file options</primary></indexterm>
103 <para>Sometimes it is useful to make the connection between a
104 source file and the command-line options it requires quite
105 tight. For instance, if a Haskell source file uses GHC
106 extensions, it will always need to be compiled with the
107 <option>-fglasgow-exts</option> option. Rather than maintaining
108 the list of per-file options in a <filename>Makefile</filename>,
109 it is possible to do this directly in the source file using the
110 <literal>OPTIONS</literal> pragma <indexterm><primary>OPTIONS
111 pragma</primary></indexterm>:</para>
114 {-# OPTIONS -fglasgow-exts #-}
119 <para><literal>OPTIONS</literal> pragmas are only looked for at
120 the top of your source files, upto the first
121 (non-literate,non-empty) line not containing
122 <literal>OPTIONS</literal>. Multiple <literal>OPTIONS</literal>
123 pragmas are recognised. Note that your command shell does not
124 get to the source file options, they are just included literally
125 in the array of command-line arguments the compiler driver
126 maintains internally, so you'll be desperately disappointed if
127 you try to glob etc. inside <literal>OPTIONS</literal>.</para>
129 <para>NOTE: the contents of OPTIONS are prepended to the
130 command-line options, so you <emphasis>do</emphasis> have the
131 ability to override OPTIONS settings via the command
134 <para>It is not recommended to move all the contents of your
135 Makefiles into your source files, but in some circumstances, the
136 <literal>OPTIONS</literal> pragma is the Right Thing. (If you
137 use <option>-keep-hc-file-too</option> and have OPTION flags in
138 your module, the OPTIONS will get put into the generated .hc
143 <title>Setting options in GHCi</title>
145 <para>Options may also be modified from within GHCi, using the
146 <literal>:set</literal> command. See <xref linkend="ghci-set">
147 for more details.</para>
151 <sect1 id="static-dynamic-flags">
152 <title>Static vs. Dynamic options</title>
153 <indexterm><primary>static</primary><secondary>options</secondary>
155 <indexterm><primary>dynamic</primary><secondary>options</secondary>
158 <para>Each of GHC's command line options is classified as either
159 <firstterm>static</firstterm> or <firstterm>dynamic</firstterm>.
160 A static flag may only be specified on the command line, whereas a
161 dynamic flag may also be given in an <literal>OPTIONS</literal>
162 pragma in a source file or set from the GHCi command-line with
163 <literal>:set</literal>.</para>
165 <para>As a rule of thumb, all the language options are dynamic, as
166 are the warning options and the debugging options. The rest are
167 static, with the notable exceptions of <option>-v</option>,
168 <option>-cpp</option>, <option>-fasm</option>,
169 <option>-fvia-C</option>, and <option>-#include</option>.
171 The flag reference tables (<xref linkend="flag-reference">) lists
172 the status of each flag.</para>
175 <sect1 id="file-suffixes">
176 <title>Meaningful file suffixes</title>
178 <indexterm><primary>suffixes, file</primary></indexterm>
179 <indexterm><primary>file suffixes for GHC</primary></indexterm>
181 <para>File names with “meaningful” suffixes (e.g.,
182 <filename>.lhs</filename> or <filename>.o</filename>) cause the
183 “right thing” to happen to those files.</para>
188 <term><filename>.lhs</filename></term>
189 <indexterm><primary><literal>lhs</literal> suffix</primary></indexterm>
191 <para>A “literate Haskell” module.</para>
196 <term><filename>.hs</filename></term>
198 <para>A not-so-literate Haskell module.</para>
203 <term><filename>.hi</filename></term>
205 <para>A Haskell interface file, probably
206 compiler-generated.</para>
211 <term><filename>.hc</filename></term>
213 <para>Intermediate C file produced by the Haskell
219 <term><filename>.c</filename></term>
221 <para>A C file not produced by the Haskell
227 <term><filename>.s</filename></term>
229 <para>An assembly-language source file, usually produced by
235 <term><filename>.o</filename></term>
237 <para>An object file, produced by an assembler.</para>
242 <para>Files with other suffixes (or without suffixes) are passed
243 straight to the linker.</para>
247 <sect1 id="options-help">
248 <title>Help and verbosity options</title>
250 <IndexTerm><Primary>help options</Primary></IndexTerm>
251 <IndexTerm><Primary>verbosity options</Primary></IndexTerm>
255 <term><option>––help</option></term>
256 <term><option>-?</option></term>
257 <indexterm><primary><option>-?</option></primary></indexterm>
258 <indexterm><primary><option>––help</option></primary></indexterm>
260 <para>Cause GHC to spew a long usage message to standard
261 output and then exit.</para>
266 <term><option>-v</option></term>
267 <indexterm><primary><option>-v</option></primary></indexterm>
269 <para>The <option>-v</option> option makes GHC
270 <emphasis>verbose</emphasis>: it reports its version number
271 and shows (on stderr) exactly how it invokes each phase of
272 the compilation system. Moreover, it passes the
273 <option>-v</option> flag to most phases; each reports its
274 version number (and possibly some other information).</para>
276 <para>Please, oh please, use the <option>-v</option> option
277 when reporting bugs! Knowing that you ran the right bits in
278 the right order is always the first thing we want to
284 <term><option>-v</option><replaceable>n</replaceable></term>
285 <indexterm><primary><option>-v</option></primary></indexterm>
287 <para>To provide more control over the compiler's verbosity,
288 the <option>-v</option> flag takes an optional numeric
289 argument. Specifying <option>-v</option> on its own is
290 equivalent to <option>-v3</option>, and the other levels
291 have the following meanings:</para>
295 <term><option>-v0</option></term>
297 <para>Disable all non-essential messages (this is the
303 <term><option>-v1</option></term>
305 <para>Minimal verbosity: print one line per
306 compilation (this is the default when
307 <option>––make</option> or
308 <option>––interactive</option> is on).</para>
313 <term><option>-v2</option></term>
315 <para>Print the name of each compilation phase as it
316 is executed. (equivalent to
317 <option>-dshow-passes</option>).</para>
322 <term><option>-v3</option></term>
324 <para>The same as <option>-v2</option>, except that in
325 addition the full command line (if appropriate) for
326 each compilation phase is also printed.</para>
331 <term><option>-v4</option></term>
333 <para>The same as <option>-v3</option> except that the
334 intermediate program representation after each
335 compilation phase is also printed (excluding
336 preprocessed and C/assembly files).</para>
344 <term><option>––version</option></term>
345 <indexterm><primary><option>––version</option></primary></indexterm>
347 <para>Print a one-line string including GHC's version number.</para>
352 <term><option>––numeric-version</option></term>
353 <indexterm><primary><option>––numeric-version</option></primary></indexterm>
355 <para>Print GHC's numeric version number only.</para>
360 <term><option>––print-libdir</option></term>
361 <indexterm><primary><option>––print-libdir</option></primary></indexterm>
363 <para>Print the path to GHC's library directory. This is
364 the top of the directory tree containing GHC's libraries,
365 interfaces, and include files (usually something like
366 <literal>/usr/local/lib/ghc-5.04</literal> on Unix). This
368 <literal>$libdir</literal><indexterm><primary><literal>libdir</literal></primary>
369 </indexterm>in the package configuration file (see <xref
370 linkend="packages">).</para>
377 <sect1 id="make-mode">
378 <title>Using <command>ghc</command> <option>––make</option></title>
380 <indexterm><primary><option>––make</option></primary>
382 <indexterm><primary>separate compilation</primary>
385 <para>When given the <option>––make</option> option, GHC will
386 build a multi-module Haskell program by following dependencies
387 from a single root module (usually <literal>Main</literal>). For
388 example, if your <literal>Main</literal> module is in a file
389 called <filename>Main.hs</filename>, you could compile and link
390 the program like this:</para>
393 ghc ––make Main.hs
396 <para>The command line must contain one source file or module
397 name; GHC will figure out all the modules in the program by
398 following the imports from this initial module. It will then
399 attempt to compile each module which is out of date, and finally
400 if the top module is <literal>Main</literal>, the program
401 will also be linked into an executable.</para>
403 <para>The main advantages to using <literal>ghc ––make</literal>
404 over traditional <literal>Makefile</literal>s are:</para>
408 <para>GHC doesn't have to be restarted for each compilation,
409 which means it can cache information between compilations.
410 Compiling a muli-module program with <literal>ghc
411 ––make</literal> can be up to twice as fast as running
412 <literal>ghc</literal> individually on each source
416 <para>You don't have to write a
417 <literal>Makefile</literal>.</para>
419 <indexterm><primary><literal>Makefile</literal>s</primary><secondary>avoiding</secondary>
422 <para>GHC re-calculates the dependencies each time it is
423 invoked, so the dependencies never get out of sync with the
428 <para>Any of the command-line options described in the rest of
429 this chapter can be used with <option>––make</option>, but note
430 that any options you give on the command line will apply to all
431 the source files compiled, so if you want any options to apply to
432 a single source file only, you'll need to use an
433 <literal>OPTIONS</literal> pragma (see <xref
434 linkend="source-file-options">).</para>
436 <para>If the program needs to be linked with additional objects
437 (say, some auxilliary C code), these can be specified on the
438 command line as usual.</para>
440 <para>Note that GHC can only follow dependencies if it has the
441 source file available, so if your program includes a module for
442 which there is no source file, even if you have an object and an
443 interface file for the module, then GHC will complain. The
444 exception to this rule is for package modules, which may or may
445 not have source files.</para>
447 <para>The source files for the program don't all need to be in the
448 same directory; the <option>-i</option> option can be used to add
449 directories to the search path (see <xref
450 linkend="options-finding-imports">).</para>
454 <Sect1 id="options-order">
455 <title>GHC without <option>––make</option></title>
457 <para>Without <option>––make</option>, GHC will compile one or
458 more source files given on the command line.</para>
460 <para>The first phase to run is determined by each input-file
461 suffix, and the last phase is determined by a flag. If no
462 relevant flag is present, then go all the way through linking.
463 This table summarises:</para>
467 <colspec align="left">
468 <colspec align="left">
469 <colspec align="left">
470 <colspec align="left">
474 <entry>Phase of the compilation system</entry>
475 <entry>Suffix saying “start here”</entry>
476 <entry>Flag saying “stop after”</entry>
477 <entry>(suffix of) output file</entry>
482 <entry>literate pre-processor</entry>
483 <entry><literal>.lhs</literal></entry>
485 <entry><literal>.hs</literal></entry>
489 <entry>C pre-processor (opt.)
491 <entry><literal>.hs</literal> (with
492 <option>-cpp</option>)</entry>
493 <entry><option>-E</option></entry>
494 <entry><literal>.hspp</literal></entry>
498 <entry>Haskell compiler</entry>
499 <entry><literal>.hs</literal></entry>
500 <entry><option>-C</option>, <option>-S</option></entry>
501 <entry><literal>.hc</literal>, <literal>.s</literal></entry>
505 <entry>C compiler (opt.)</entry>
506 <entry><literal>.hc</literal> or <literal>.c</literal></entry>
507 <entry><option>-S</option></entry>
508 <entry><literal>.s</literal></entry>
512 <entry>assembler</entry>
513 <entry><literal>.s</literal></entry>
514 <entry><option>-c</option></entry>
515 <entry><literal>.o</literal></entry>
519 <entry>linker</entry>
520 <entry><replaceable>other</replaceable></entry>
522 <entry><filename>a.out</filename></entry>
528 <indexterm><primary><option>-C</option></primary></indexterm>
529 <indexterm><primary><option>-E</option></primary></indexterm>
530 <indexterm><primary><option>-S</option></primary></indexterm>
531 <indexterm><primary><option>-c</option></primary></indexterm>
533 <para>Thus, a common invocation would be: <literal>ghc -c
534 Foo.hs</literal></para>
536 <para>Note: What the Haskell compiler proper produces depends on
537 whether a native-code generator<indexterm><primary>native-code
538 generator</primary></indexterm> is used (producing assembly
539 language) or not (producing C). See <xref
540 linkend="options-codegen"> for more details.</para>
542 <para>Note: C pre-processing is optional, the
543 <option>-ccp</option><indexterm><primary><option>-cpp</option></primary>
544 </indexterm>flag turns it on. See <xref
545 linkend="c-pre-processor"> for more details.</para>
547 <para>Note: The option <option>-E</option><IndexTerm><Primary>-E
548 option</Primary></IndexTerm> runs just the pre-processing passes
549 of the compiler, dumping the result in a file. Note that this
550 differs from the previous behaviour of dumping the file to
551 standard output.</para>
554 <sect1 id="options-output">
555 <title>Re-directing the compilation output(s)</title>
557 <indexterm><primary>output-directing options</primary></indexterm>
558 <indexterm><primary>redirecting compilation output</primary></indexterm>
563 <term><option>-o</option></term>
564 <indexterm><primary><option>-o</option></primary></indexterm>
566 <para>GHC's compiled output normally goes into a
567 <filename>.hc</filename>, <filename>.o</filename>, etc.,
568 file, depending on the last-run compilation phase. The
569 option <option>-o foo</option><IndexTerm><Primary>-o
570 option</Primary></IndexTerm> re-directs the output of that
571 last-run phase to file <filename>foo</filename>.</para>
573 <para>Note: this “feature” can be
574 counterintuitive: <command>ghc -C -o foo.o foo.hs</command>
575 will put the intermediate C code in the file
576 <filename>foo.o</filename>, name notwithstanding!</para>
578 <para>Note: on Windows, if the result is an executable file, the
579 extension "<filename>.exe</filename>" is added if the specified filename
580 does not already have an extension. Thus
584 will compile and link the module <filename>Main.hs</filename>, and put the
585 resulting executable in <filename>foo.exe</filename> (not <filename>foo</filename>).
591 <term><option>-odir</option></term>
592 <indexterm><primary><option>-odir</option></primary></indexterm>
594 <para>The <option>-o</option> option isn't of much use if
595 you have <emphasis>several</emphasis> input files…
596 Non-interface output files are normally put in the same
597 directory as their corresponding input file came from. You
598 may specify that they be put in another directory using the
599 <option>-odir <dir></option><IndexTerm><Primary>-odir
600 <dir> option</Primary></IndexTerm> (the “Oh,
601 dear” option). For example:</para>
604 % ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch`
607 <para>The output files, <filename>Foo.o</filename>,
608 <filename>Bar.o</filename>, and
609 <filename>Bumble.o</filename> would be put into a
610 subdirectory named after the architecture of the executing
611 machine (<filename>sun4</filename>,
612 <filename>mips</filename>, etc). The directory must already
613 exist; it won't be created.</para>
615 <para>Note that the <option>-odir</option> option does
616 <emphasis>not</emphasis> affect where the interface files
617 are put. In the above example, they would still be put in
618 <filename>parse/Foo.hi</filename>,
619 <filename>parse/Bar.hi</filename>, and
620 <filename>gurgle/Bumble.hi</filename>.</para>
625 <term><option>-ohi</option> <replaceable>file</replaceable></term>
626 <indexterm><primary><option>-ohi</option></primary>
629 <para>The interface output may be directed to another file
630 <filename>bar2/Wurble.iface</filename> with the option
631 <option>-ohi bar2/Wurble.iface</option> (not
634 <para>WARNING: if you redirect the interface file somewhere
635 that GHC can't find it, then the recompilation checker may
636 get confused (at the least, you won't get any recompilation
637 avoidance). We recommend using a combination of
638 <option>-hidir</option> and <option>-hisuf</option> options
639 instead, if possible.</para>
641 <para>To avoid generating an interface at all, you could use
642 this option to redirect the interface into the bit bucket:
643 <literal>-ohi /dev/null</literal>, for example.</para>
648 <term><option>-hidir</option> <replaceable>directory</replaceable></term>
649 <indexterm><primary><option>-hidir</option></primary>
652 <para>Redirects all generated interface files into
653 <replaceable>directory</replaceable>, instead of the default
654 which is to place the interface file in the same directory
655 as the source file.</para>
660 <term><option>-osuf</option> <replaceable>suffix</replaceable></term>
661 <term><option>-hisuf</option> <replaceable>suffix</replaceable></term>
662 <term><option>-hcsuf</option> <replaceable>suffix</replaceable></term>
663 <indexterm><primary><option>-osuf</option></primary></indexterm>
664 <indexterm><primary><option>-hisuf</option></primary></indexterm>
665 <indexterm><primary><option>-hcsuf</option></primary></indexterm>
667 <para>EXOTICA: The <option>-osuf</option>
668 <replaceable>suffix</replaceable> will change the
669 <literal>.o</literal> file suffix for object files to
670 whatever you specify. We use this when compiling libraries,
671 so that objects for the profiling versions of the libraries
672 don't clobber the normal ones.</para>
674 <para>Similarly, the <option>-hisuf</option>
675 <replaceable>suffix</replaceable> will change the
676 <literal>.hi</literal> file suffix for non-system interface
677 files (see <XRef LinkEnd="hi-options">).</para>
679 <para>Finally, the option <option>-hcsuf</option>
680 <replaceable>suffix</replaceable> will change the
681 <literal>.hc</literal> file suffix for compiler-generated
682 intermediate C files.</para>
684 <para>The <option>-hisuf</option>/<option>-osuf</option>
685 game is particularly useful if you want to compile a program both with and without
686 profiling, in the same directory. You can say:
690 to get the ordinary version, and
692 ghc ... -osuf prof.o -hisuf prof.hi -prof -auto-all
694 to get the profiled version.</para>
699 <sect2 id="keeping-intermediates">
700 <title>Keeping Intermediate Files</title>
701 <indexterm><primary>intermediate files, saving</primary>
703 <indexterm><primary><literal>.hc</literal> files, saving</primary>
705 <indexterm><primary><literal>.s</literal> files, saving</primary>
709 <para>The following options are useful for keeping certain
710 intermediate files around, when normally GHC would throw these
711 away after compilation:</para>
715 <term><option>-keep-hc-files</option></term>
717 <primary><option>-keep-hc-files</option></primary>
720 <para>Keep intermediate <literal>.hc</literal> files when
721 doing <literal>.hs</literal>-to-<literal>.o</literal>
722 compilations via C (NOTE: <literal>.hc</literal> files
723 aren't generated when using the native code generator, you
724 may need to use <option>-fvia-C</option> to force them
725 to be produced).</para>
730 <term><option>-keep-s-files</option></term>
732 <primary><option>-keep-s-files</option></primary>
735 <para>Keep intermediate <literal>.s</literal> files.</para>
740 <term><option>-keep-raw-s-files</option></term>
742 <primary><option>-keep-raw-s-files</option></primary>
745 <para>Keep intermediate <literal>.raw-s</literal> files.
746 These are the direct output from the C compiler, before
747 GHC does “assembly mangling” to produce the
748 <literal>.s</literal> file. Again, these are not produced
749 when using the native code generator.</para>
754 <term><option>-keep-tmp-files</option></term>
756 <primary><option>-keep-tmp-files</option></primary>
759 <primary>temporary files</primary>
760 <secondary>keeping</secondary>
763 <para>Instructs the GHC driver not to delete any of its
764 temporary files, which it normally keeps in
765 <literal>/tmp</literal> (or possibly elsewhere; see <xref
766 linkend="temp-files">). Running GHC with
767 <option>-v</option> will show you what temporary files
768 were generated along the way.</para>
774 <sect2 id="temp-files">
775 <title>Redirecting temporary files</title>
778 <primary>temporary files</primary>
779 <secondary>redirecting</secondary>
784 <term><option>-tmpdir</option></term>
785 <indexterm><primary><option>-tmpdir</option></primary></indexterm>
787 <para>If you have trouble because of running out of space
788 in <filename>/tmp</filename> (or wherever your
789 installation thinks temporary files should go), you may
790 use the <option>-tmpdir
791 <dir></option><IndexTerm><Primary>-tmpdir
792 <dir> option</Primary></IndexTerm> option to specify
793 an alternate directory. For example, <option>-tmpdir
794 .</option> says to put temporary files in the current
795 working directory.</para>
797 <para>Alternatively, use your <Constant>TMPDIR</Constant>
798 environment variable.<IndexTerm><Primary>TMPDIR
799 environment variable</Primary></IndexTerm> Set it to the
800 name of the directory where temporary files should be put.
801 GCC and other programs will honour the
802 <Constant>TMPDIR</Constant> variable as well.</para>
804 <para>Even better idea: Set the
805 <Constant>DEFAULT_TMPDIR</Constant> make variable when
806 building GHC, and never worry about
807 <Constant>TMPDIR</Constant> again. (see the build
808 documentation).</para>
816 <sect1 id="options-sanity">
817 <title>Warnings and sanity-checking</title>
819 <indexterm><primary>sanity-checking options</primary></indexterm>
820 <indexterm><primary>warnings</primary></indexterm>
823 <para>GHC has a number of options that select which types of
824 non-fatal error messages, otherwise known as warnings, can be
825 generated during compilation. By default, you get a standard set
826 of warnings which are generally likely to indicate bugs in your
828 <option>-fwarn-overlpapping-patterns</option>,
829 <option>-fwarn-deprecations</option>,
830 <option>-fwarn-duplicate-exports</option>,
831 <option>-fwarn-missing-fields</option>, and
832 <option>-fwarn-missing-methods</option>. The following flags are
833 simple ways to select standard “packages” of warnings:
839 <term><option>-W</option>:</term>
841 <IndexTerm><Primary>-W option</Primary></IndexTerm>
842 <para>Provides the standard warnings plus
843 <option>-fwarn-incomplete-patterns</option>,
844 <option>-fwarn-unused-matches</option>,
845 <option>-fwarn-unused-imports</option>,
846 <option>-fwarn-misc</option>, and
847 <option>-fwarn-unused-binds</option>.</para>
852 <term><option>-w</option>:</term>
854 <IndexTerm><Primary><option>-w</option></Primary></IndexTerm>
855 <para>Turns off all warnings, including the standard ones.</para>
860 <term><option>-Wall</option>:</term>
862 <indexterm><primary><option>-Wall</option></primary></indexterm>
863 <para>Turns on all warning options.</para>
868 <term><option>-Werror</option>:</term>
870 <indexterm><primary><option>-Werror</option></primary></indexterm>
871 <para>Makes any warning into a fatal error. Useful so that you don't
872 miss warnings when doing batch compilation. </para>
878 <para>The full set of warning options is described below. To turn
879 off any warning, simply give the corresponding
880 <option>-fno-warn-...</option> option on the command line.</para>
885 <term><option>-fwarn-deprecations</option>:</term>
887 <indexterm><primary><option>-fwarn-deprecations</option></primary>
889 <indexterm><primary>deprecations</primary></indexterm>
890 <para>Causes a warning to be emitted when a deprecated
891 function or type is used. Entities can be marked as
892 deprecated using a pragma, see <xref
893 linkend="deprecated-pragma">.</para>
898 <term><option>-fwarn-duplicate-exports</option>:</term>
900 <indexterm><primary><option>-fwarn-duplicate-exports</option></primary></indexterm>
901 <indexterm><primary>duplicate exports, warning</primary></indexterm>
902 <indexterm><primary>export lists, duplicates</primary></indexterm>
904 <para>Have the compiler warn about duplicate entries in
905 export lists. This is useful information if you maintain
906 large export lists, and want to avoid the continued export
907 of a definition after you've deleted (one) mention of it in
908 the export list.</para>
910 <para>This option is on by default.</para>
915 <term><option>-fwarn-hi-shadowing</option>:</term>
917 <indexterm><primary><option>-fwarn-hi-shadowing</option></primary></indexterm>
918 <indexterm><primary>shadowing</primary>
919 <secondary>interface files</secondary></indexterm>
921 <para>Causes the compiler to emit a warning when a module or
922 interface file in the current directory is shadowing one
923 with the same module name in a library or other
929 <term><option>-fwarn-incomplete-patterns</option>:</term>
931 <indexterm><primary><option>-fwarn-incomplete-patterns</option></primary></indexterm>
932 <indexterm><primary>incomplete patterns, warning</primary></indexterm>
933 <indexterm><primary>patterns, incomplete</primary></indexterm>
935 <para>Similarly for incomplete patterns, the function
936 <function>g</function> below will fail when applied to
937 non-empty lists, so the compiler will emit a warning about
938 this when <option>-fwarn-incomplete-patterns</option> is
945 <para>This option isn't enabled be default because it can be
946 a bit noisy, and it doesn't always indicate a bug in the
947 program. However, it's generally considered good practice
948 to cover all the cases in your functions.</para>
953 <term><option>-fwarn-misc</option>:</term>
954 <indexterm><primary><option>-fwarn-misc</option></primary></indexterm>
956 <para>Turns on warnings for various harmless but untidy
957 things. This currently includes: importing a type with
958 <literal>(..)</literal> when the export is abstract, and
959 listing duplicate class assertions in a qualified type.</para>
964 <term><option>-fwarn-missing-fields</option>:</term>
966 <indexterm><primary><option>-fwarn-missing-fields</option></primary></indexterm>
967 <indexterm><primary>missing fields, warning</primary></indexterm>
968 <indexterm><primary>fields, missing</primary></indexterm>
970 <para>This option is on by default, and warns you whenever
971 the construction of a labelled field constructor isn't
972 complete, missing initializers for one or more fields. While
973 not an error (the missing fields are initialised with
974 bottoms), it is often an indication of a programmer error.</para>
979 <term><option>-fwarn-missing-methods</option>:</term>
981 <indexterm><primary><option>-fwarn-missing-methods</option></primary></indexterm>
982 <indexterm><primary>missing methods, warning</primary></indexterm>
983 <indexterm><primary>methods, missing</primary></indexterm>
985 <para>This option is on by default, and warns you whenever
986 an instance declaration is missing one or more methods, and
987 the corresponding class declaration has no default
988 declaration for them.</para>
993 <term><option>-fwarn-missing-signatures</option>:</term>
995 <indexterm><primary><option>-fwarn-missing-signatures</option></primary></indexterm>
996 <indexterm><primary>type signatures, missing</primary></indexterm>
998 <para>If you would like GHC to check that every top-level
999 function/value has a type signature, use the
1000 <option>-fwarn-missing-signatures</option> option. This
1001 option is off by default.</para>
1006 <term><option>-fwarn-name-shadowing</option>:</term>
1008 <indexterm><primary><option>-fwarn-name-shadowing</option></primary></indexterm>
1009 <indexterm><primary>shadowing, warning</primary></indexterm>
1011 <para>This option causes a warning to be emitted whenever an
1012 inner-scope value has the same name as an outer-scope value,
1013 i.e. the inner value shadows the outer one. This can catch
1014 typographical errors that turn into hard-to-find bugs, e.g.,
1015 in the inadvertent cyclic definition <literal>let x = ... x
1016 ... in</literal>.</para>
1018 <para>Consequently, this option does
1019 <emphasis>will</emphasis> complain about cyclic recursive
1025 <term><option>-fwarn-overlapping-patterns</option>:</term>
1026 <indexterm><primary><option>-fwarn-overlapping-patterns</option></primary></indexterm>
1027 <indexterm><primary>overlapping patterns, warning</primary></indexterm>
1028 <indexterm><primary>patterns, overlapping</primary></indexterm>
1030 <para>By default, the compiler will warn you if a set of
1031 patterns are overlapping, i.e.,</para>
1034 f :: String -> Int
1040 <para>where the last pattern match in <Function>f</Function>
1041 won't ever be reached, as the second pattern overlaps
1042 it. More often than not, redundant patterns is a programmer
1043 mistake/error, so this option is enabled by default.</para>
1048 <term><option>-fwarn-simple-patterns</option>:</term>
1050 <indexterm><primary><option>-fwarn-simple-patterns</option></primary>
1052 <para>Causes the compiler to warn about lambda-bound
1053 patterns that can fail, eg. <literal>\(x:xs)->...</literal>.
1054 Normally, these aren't treated as incomplete patterns by
1055 <option>-fwarn-incomplete-patterns</option>.</para>
1060 <term><option>-fwarn-type-defaults</option>:</term>
1062 <indexterm><primary><option>-fwarn-type-defaults</option></primary></indexterm>
1063 <indexterm><primary>defaulting mechanism, warning</primary></indexterm>
1064 <para>Have the compiler warn/inform you where in your source
1065 the Haskell defaulting mechanism for numeric types kicks
1066 in. This is useful information when converting code from a
1067 context that assumed one default into one with another,
1068 e.g., the `default default' for Haskell 1.4 caused the
1069 otherwise unconstrained value <Constant>1</Constant> to be
1070 given the type <literal>Int</literal>, whereas Haskell 98
1071 defaults it to <literal>Integer</literal>. This may lead to
1072 differences in performance and behaviour, hence the
1073 usefulness of being non-silent about this.</para>
1075 <para>This warning is off by default.</para>
1080 <term><option>-fwarn-unused-binds</option>:</term>
1082 <indexterm><primary><option>-fwarn-unused-binds</option></primary></indexterm>
1083 <indexterm><primary>unused binds, warning</primary></indexterm>
1084 <indexterm><primary>binds, unused</primary></indexterm>
1085 <para>Report any function definitions (and local bindings)
1086 which are unused. For top-level functions, the warning is
1087 only given if the binding is not exported.</para>
1092 <term><option>-fwarn-unused-imports</option>:</term>
1094 <indexterm><primary><option>-fwarn-unused-imports</option></primary></indexterm>
1095 <indexterm><primary>unused imports, warning</primary></indexterm>
1096 <indexterm><primary>imports, unused</primary></indexterm>
1098 <para>Report any objects that are explicitly imported but
1104 <term><option>-fwarn-unused-matches</option>:</term>
1106 <indexterm><primary><option>-fwarn-unused-matches</option></primary></indexterm>
1107 <indexterm><primary>unused matches, warning</primary></indexterm>
1108 <indexterm><primary>matches, unused</primary></indexterm>
1110 <para>Report all unused variables which arise from pattern
1111 matches, including patterns consisting of a single variable.
1112 For instance <literal>f x y = []</literal> would report
1113 <VarName>x</VarName> and <VarName>y</VarName> as unused. To
1114 eliminate the warning, all unused variables can be replaced
1115 with wildcards.</para>
1121 <para>If you're feeling really paranoid, the
1122 <option>-dcore-lint</option>
1123 option<indexterm><primary><option>-dcore-lint</option></primary></indexterm>
1124 is a good choice. It turns on heavyweight intra-pass
1125 sanity-checking within GHC. (It checks GHC's sanity, not
1133 <sect1 id="options-optimise">
1134 <title>Optimisation (code improvement)</title>
1136 <indexterm><primary>optimisation</primary></indexterm>
1137 <indexterm><primary>improvement, code</primary></indexterm>
1139 <para>The <option>-O*</option> options specify convenient
1140 “packages” of optimisation flags; the
1141 <option>-f*</option> options described later on specify
1142 <emphasis>individual</emphasis> optimisations to be turned on/off;
1143 the <option>-m*</option> options specify
1144 <emphasis>machine-specific</emphasis> optimisations to be turned
1147 <sect2 id="optimise-pkgs">
1148 <title><option>-O*</option>: convenient “packages” of optimisation flags.</title>
1150 <para>There are <emphasis>many</emphasis> options that affect
1151 the quality of code produced by GHC. Most people only have a
1152 general goal, something like “Compile quickly” or
1153 “Make my program run like greased lightning.” The
1154 following “packages” of optimisations (or lack
1155 thereof) should suffice.</para>
1157 <para>Once you choose a <option>-O*</option>
1158 “package,” stick with it—don't chop and
1159 change. Modules' interfaces <emphasis>will</emphasis> change
1160 with a shift to a new <option>-O*</option> option, and you may
1161 have to recompile a large chunk of all importing modules before
1162 your program can again be run safely (see <XRef
1163 LinkEnd="recomp">).</para>
1168 <term>No <option>-O*</option>-type option specified:</term>
1169 <indexterm><primary>-O* not specified</primary></indexterm>
1171 <para>This is taken to mean: “Please compile
1172 quickly; I'm not over-bothered about compiled-code
1173 quality.” So, for example: <command>ghc -c
1174 Foo.hs</command></para>
1179 <term><option>-O0</option>:</term>
1180 <indexterm><primary><option>-O0</option></primary></indexterm>
1182 <para>Means “turn off all optimisation”,
1183 reverting to the same settings as if no
1184 <option>-O</option> options had been specified. Saying
1185 <option>-O0</option> can be useful if
1186 eg. <command>make</command> has inserted a
1187 <option>-O</option> on the command line already.</para>
1192 <term><option>-O</option> or <option>-O1</option>:</term>
1193 <indexterm><primary>-O option</primary></indexterm>
1194 <indexterm><primary>-O1 option</primary></indexterm>
1195 <indexterm><primary>optimise</primary><secondary>normally</secondary></indexterm>
1197 <para>Means: “Generate good-quality code without
1198 taking too long about it.” Thus, for example:
1199 <command>ghc -c -O Main.lhs</command></para>
1204 <term><option>-O2</option>:</term>
1205 <indexterm><primary>-O2 option</primary></indexterm>
1206 <indexterm><primary>optimise</primary><secondary>aggressively</secondary></indexterm>
1208 <para>Means: “Apply every non-dangerous
1209 optimisation, even if it means significantly longer
1210 compile times.”</para>
1212 <para>The avoided “dangerous” optimisations
1213 are those that can make runtime or space
1214 <emphasis>worse</emphasis> if you're unlucky. They are
1215 normally turned on or off individually.</para>
1217 <para>At the moment, <option>-O2</option> is
1218 <emphasis>unlikely</emphasis> to produce better code than
1219 <option>-O</option>.</para>
1224 <term><option>-Ofile <file></option>:</term>
1225 <indexterm><primary>-Ofile <file> option</primary></indexterm>
1226 <indexterm><primary>optimising, customised</primary></indexterm>
1228 <para>(NOTE: not supported yet in GHC 5.x. Please ask if
1229 you're interested in this.)</para>
1231 <para>For those who need <emphasis>absolute</emphasis>
1232 control over <emphasis>exactly</emphasis> what options are
1233 used (e.g., compiler writers, sometimes :-), a list of
1234 options can be put in a file and then slurped in with
1235 <option>-Ofile</option>.</para>
1237 <para>In that file, comments are of the
1238 <literal>#</literal>-to-end-of-line variety; blank
1239 lines and most whitespace is ignored.</para>
1241 <para>Please ask if you are baffled and would like an
1242 example of <option>-Ofile</option>!</para>
1247 <para>We don't use a <option>-O*</option> flag for day-to-day
1248 work. We use <option>-O</option> to get respectable speed;
1249 e.g., when we want to measure something. When we want to go for
1250 broke, we tend to use <option>-O -fvia-C</option> (and we go for
1251 lots of coffee breaks).</para>
1253 <para>The easiest way to see what <option>-O</option> (etc.)
1254 “really mean” is to run with <option>-v</option>,
1255 then stand back in amazement.</para>
1258 <sect2 id="options-f">
1259 <title><option>-f*</option>: platform-independent flags</title>
1261 <indexterm><primary>-f* options (GHC)</primary></indexterm>
1262 <indexterm><primary>-fno-* options (GHC)</primary></indexterm>
1264 <para>These flags turn on and off individual optimisations.
1265 They are normally set via the <option>-O</option> options
1266 described above, and as such, you shouldn't need to set any of
1267 them explicitly (indeed, doing so could lead to unexpected
1268 results). However, there are one or two that may be of
1273 <term><option>-fexcess-precision</option>:</term>
1275 <indexterm><primary><option>-fexcess-precision</option></primary></indexterm>
1276 <para>When this option is given, intermediate floating
1277 point values can have a <emphasis>greater</emphasis>
1278 precision/range than the final type. Generally this is a
1279 good thing, but some programs may rely on the exact
1281 <literal>Float</literal>/<literal>Double</literal> values
1282 and should not use this option for their compilation.</para>
1287 <term><option>-fignore-asserts</option>:</term>
1289 <indexterm><primary><option>-fignore-asserts</option></primary></indexterm>
1290 <para>Causes GHC to ignore uses of the function
1291 <literal>Exception.assert</literal> in source code (in
1292 other words, rewriting <literal>Exception.assert p
1293 e</literal> to <literal>e</literal> (see <xref
1294 linkend="sec-assertions">). This flag is turned on by
1295 <option>-O</option>.
1301 <term><option>-fno-strictness</option></term>
1302 <indexterm><primary><option>-fno-strictness</option></primary>
1305 <para>Turns off the strictness analyser; sometimes it eats
1306 too many cycles.</para>
1311 <term><option>-fno-cpr-analyse</option></term>
1312 <indexterm><primary><option>-fno-cpr-analyse</option></primary>
1315 <para>Turns off the CPR (constructed product result)
1316 analysis; it is somewhat experimental.</para>
1321 <term><option>-funbox-strict-fields</option>:</term>
1323 <indexterm><primary><option>-funbox-strict-fields</option></primary></indexterm>
1324 <indexterm><primary>strict constructor fields</primary></indexterm>
1325 <indexterm><primary>constructor fields, strict</primary></indexterm>
1327 <para>This option causes all constructor fields which are
1328 marked strict (i.e. “!”) to be unboxed or
1329 unpacked if possible. For example:</para>
1332 data T = T !Float !Float
1335 <para>will create a constructor <literal>T</literal>
1336 containing two unboxed floats if the
1337 <option>-funbox-strict-fields</option> flag is given.
1338 This may not always be an optimisation: if the
1339 <Function>T</Function> constructor is scrutinised and the
1340 floats passed to a non-strict function for example, they
1341 will have to be reboxed (this is done automatically by the
1344 <para>This option should only be used in conjunction with
1345 <option>-O</option>, in order to expose unfoldings to the
1346 compiler so the reboxing can be removed as often as
1347 possible. For example:</para>
1351 f (T f1 f2) = f1 + f2
1354 <para>The compiler will avoid reboxing
1355 <Function>f1</Function> and <Function>f2</Function> by
1356 inlining <Function>+</Function> on floats, but only when
1357 <option>-O</option> is on.</para>
1359 <para>Any single-constructor data is eligible for
1360 unpacking; for example</para>
1363 data T = T !(Int,Int)
1366 <para>will store the two <literal>Int</literal>s directly
1367 in the <Function>T</Function> constructor, by flattening
1368 the pair. Multi-level unpacking is also supported:</para>
1372 data S = S !Int !Int
1375 <para>will store two unboxed <literal>Int#</literal>s
1376 directly in the <Function>T</Function> constructor.</para>
1381 <term><option>-funfolding-update-in-place<n></option></term>
1382 <indexterm><primary><option>-funfolding-update-in-place</option></primary></indexterm>
1384 <para>Switches on an experimental "optimisation".
1385 Switching it on makes the compiler a little keener to
1386 inline a function that returns a constructor, if the
1387 context is that of a thunk.
1391 If we inlined plusInt we might get an opportunity to use
1392 update-in-place for the thunk 'x'.</para>
1397 <term><option>-funfolding-creation-threshold<n></option>:</term>
1399 <indexterm><primary><option>-funfolding-creation-threshold</option></primary></indexterm>
1400 <indexterm><primary>inlining, controlling</primary></indexterm>
1401 <indexterm><primary>unfolding, controlling</primary></indexterm>
1403 <para>(Default: 45) Governs the maximum size that GHC will
1404 allow a function unfolding to be. (An unfolding has a
1405 “size” that reflects the cost in terms of
1406 “code bloat” of expanding that unfolding at
1407 at a call site. A bigger function would be assigned a
1408 bigger cost.) </para>
1410 <para> Consequences: (a) nothing larger than this will be
1411 inlined (unless it has an INLINE pragma); (b) nothing
1412 larger than this will be spewed into an interface
1416 <para> Increasing this figure is more likely to result in longer
1417 compile times than faster code. The next option is more
1423 <term><option>-funfolding-use-threshold<n></option>:</term>
1425 <indexterm><primary><option>-funfolding-use-threshold</option></primary></indexterm>
1426 <indexterm><primary>inlining, controlling</primary></indexterm>
1427 <indexterm><primary>unfolding, controlling</primary></indexterm>
1429 <para>(Default: 8) This is the magic cut-off figure for
1430 unfolding: below this size, a function definition will be
1431 unfolded at the call-site, any bigger and it won't. The
1432 size computed for a function depends on two things: the
1433 actual size of the expression minus any discounts that
1434 apply (see <option>-funfolding-con-discount</option>).</para>
1445 <sect1 id="sec-using-concurrent">
1446 <title>Using Concurrent Haskell</title>
1448 <indexterm><primary>Concurrent Haskell—use</primary></indexterm>
1451 GHC supports Concurrent Haskell by default, without requiring a
1452 special option or libraries compiled in a certain way. To get access
1453 to the support libraries for Concurrent Haskell, just import
1454 <literal>Control.Concurrent</literal> (details are in the accompanying
1455 library documentation).</para>
1458 RTS options are provided for modifying the behaviour of the threaded
1459 runtime system. See <XRef LinkEnd="parallel-rts-opts">.
1463 Concurrent Haskell is described in more detail in the documentation
1464 for the <literal>Control.Concurrent</literal> module.
1469 <Sect1 id="sec-using-parallel">
1470 <title>Using Parallel Haskell</title>
1473 <indexterm><primary>Parallel Haskell—use</primary></indexterm>
1477 [You won't be able to execute parallel Haskell programs unless PVM3
1478 (Parallel Virtual Machine, version 3) is installed at your site.]
1482 To compile a Haskell program for parallel execution under PVM, use the
1483 <Option>-parallel</Option> option,<IndexTerm><Primary>-parallel
1484 option</Primary></IndexTerm> both when compiling <Emphasis>and
1485 linking</Emphasis>. You will probably want to <Literal>import
1486 Parallel</Literal> into your Haskell modules.
1490 To run your parallel program, once PVM is going, just invoke it
1491 “as normal”. The main extra RTS option is
1492 <Option>-qp<n></Option>, to say how many PVM
1493 “processors” your program to run on. (For more details of
1494 all relevant RTS options, please see <XRef
1495 LinkEnd="parallel-rts-opts">.)
1499 In truth, running Parallel Haskell programs and getting information
1500 out of them (e.g., parallelism profiles) is a battle with the vagaries of
1501 PVM, detailed in the following sections.
1504 <Sect2 id="pvm-dummies">
1505 <Title>Dummy's guide to using PVM</Title>
1508 <indexterm><primary>PVM, how to use</primary></indexterm>
1509 <indexterm><primary>Parallel Haskell—PVM use</primary></indexterm>
1510 Before you can run a parallel program under PVM, you must set the
1511 required environment variables (PVM's idea, not ours); something like,
1512 probably in your <filename>.cshrc</filename> or equivalent:
1515 setenv PVM_ROOT /wherever/you/put/it
1516 setenv PVM_ARCH `$PVM_ROOT/lib/pvmgetarch`
1517 setenv PVM_DPATH $PVM_ROOT/lib/pvmd
1523 Creating and/or controlling your “parallel machine” is a purely-PVM
1524 business; nothing specific to Parallel Haskell. The following paragraphs
1525 describe how to configure your parallel machine interactively.
1529 If you use parallel Haskell regularly on the same machine configuration it
1530 is a good idea to maintain a file with all machine names and to make the
1531 environment variable PVM_HOST_FILE point to this file. Then you can avoid
1532 the interactive operations described below by just saying
1540 You use the <Command>pvm</Command><IndexTerm><Primary>pvm command</Primary></IndexTerm> command to start PVM on your
1541 machine. You can then do various things to control/monitor your
1542 “parallel machine;” the most useful being:
1548 <ColSpec Align="Left">
1552 <entry><KeyCombo><KeyCap>Control</KeyCap><KeyCap>D</KeyCap></KeyCombo></entry>
1553 <entry>exit <command>pvm</command>, leaving it running</entry>
1557 <entry><command>halt</command></entry>
1558 <entry>kill off this “parallel machine” & exit</entry>
1562 <entry><command>add <host></command></entry>
1563 <entry>add <command><host></command> as a processor</entry>
1567 <entry><command>delete <host></command></entry>
1568 <entry>delete <command><host></command></entry>
1572 <entry><command>reset</command></entry>
1573 <entry>kill what's going, but leave PVM up</entry>
1577 <entry><command>conf</command></entry>
1578 <entry>list the current configuration</entry>
1582 <entry><command>ps</command></entry>
1583 <entry>report processes' status</entry>
1587 <entry><command>pstat <pid></command></entry>
1588 <entry>status of a particular process</entry>
1597 The PVM documentation can tell you much, much more about <command>pvm</command>!
1602 <Sect2 id="par-profiles">
1603 <Title>Parallelism profiles</Title>
1606 <indexterm><primary>parallelism profiles</primary></indexterm>
1607 <indexterm><primary>profiles, parallelism</primary></indexterm>
1608 <indexterm><primary>visualisation tools</primary></indexterm>
1612 With Parallel Haskell programs, we usually don't care about the
1613 results—only with “how parallel” it was! We want pretty pictures.
1617 Parallelism profiles (à la <Command>hbcpp</Command>) can be generated with the
1618 <Option>-qP</Option><IndexTerm><Primary>-qP RTS option (concurrent, parallel)</Primary></IndexTerm> RTS option. The
1619 per-processor profiling info is dumped into files named
1620 <Filename><full-path><program>.gr</Filename>. These are then munged into a PostScript picture,
1621 which you can then display. For example, to run your program
1622 <Filename>a.out</Filename> on 8 processors, then view the parallelism profile, do:
1628 <prompt>$</prompt> ./a.out +RTS -qP -qp8
1629 <prompt>$</prompt> grs2gr *.???.gr > temp.gr # combine the 8 .gr files into one
1630 <prompt>$</prompt> gr2ps -O temp.gr # cvt to .ps; output in temp.ps
1631 <prompt>$</prompt> ghostview -seascape temp.ps # look at it!
1637 The scripts for processing the parallelism profiles are distributed
1638 in <filename>ghc/utils/parallel/</filename>.
1644 <Title>Other useful info about running parallel programs</Title>
1647 The “garbage-collection statistics” RTS options can be useful for
1648 seeing what parallel programs are doing. If you do either
1649 <Option>+RTS -Sstderr</Option><IndexTerm><Primary>-Sstderr RTS option</Primary></IndexTerm> or <Option>+RTS -sstderr</Option>, then
1650 you'll get mutator, garbage-collection, etc., times on standard
1651 error. The standard error of all PE's other than the `main thread'
1652 appears in <filename>/tmp/pvml.nnn</filename>, courtesy of PVM.
1656 Whether doing <option>+RTS -Sstderr</option> or not, a handy way to watch
1657 what's happening overall is: <command>tail -f /tmp/pvml.nnn</command>.
1662 <Sect2 id="parallel-rts-opts">
1663 <title>RTS options for Concurrent/Parallel Haskell
1667 <indexterm><primary>RTS options, concurrent</primary></indexterm>
1668 <indexterm><primary>RTS options, parallel</primary></indexterm>
1669 <indexterm><primary>Concurrent Haskell—RTS options</primary></indexterm>
1670 <indexterm><primary>Parallel Haskell—RTS options</primary></indexterm>
1674 Besides the usual runtime system (RTS) options
1675 (<XRef LinkEnd="runtime-control">), there are a few options particularly
1676 for concurrent/parallel execution.
1683 <Term><Option>-qp<N></Option>:</Term>
1686 <IndexTerm><Primary>-qp<N> RTS option</Primary></IndexTerm>
1687 (PARALLEL ONLY) Use <Literal><N></Literal> PVM processors to run this program;
1693 <term><option>-C[<us>]</option>:</term>
1696 <indexterm><primary>-C<us> RTS option</primary></indexterm> Sets
1697 the context switch interval to <literal><s></literal> seconds.
1698 A context switch will occur at the next heap block allocation after
1699 the timer expires (a heap block allocation occurs every 4k of
1700 allocation). With <option>-C0</option> or <option>-C</option>,
1701 context switches will occur as often as possible (at every heap block
1702 allocation). By default, context switches occur every 20ms
1703 milliseconds. Note that GHC's internal timer ticks every 20ms, and
1704 the context switch timer is always a multiple of this timer, so 20ms
1705 is the maximum granularity available for timed context switches.
1710 <term><option>-q[v]</option>:</term>
1713 <indexterm><primary>-q RTS option</primary></indexterm>
1714 (PARALLEL ONLY) Produce a quasi-parallel profile of thread activity,
1715 in the file <FIlename><program>.qp</FIlename>. In the style of <command>hbcpp</command>, this profile
1716 records the movement of threads between the green (runnable) and red
1717 (blocked) queues. If you specify the verbose suboption (<option>-qv</option>), the
1718 green queue is split into green (for the currently running thread
1719 only) and amber (for other runnable threads). We do not recommend
1720 that you use the verbose suboption if you are planning to use the
1721 <Command>hbcpp</Command> profiling tools or if you are context switching at every heap
1722 check (with <Option>-C</Option>).
1728 <Term><Option>-qt<num></Option>:</Term>
1731 <IndexTerm><Primary>-qt<num> RTS option</Primary></IndexTerm>
1732 (PARALLEL ONLY) Limit the thread pool size, i.e. the number of concurrent
1733 threads per processor to <Literal><num></Literal>. The default is
1734 32. Each thread requires slightly over 1K <Emphasis>words</Emphasis> in
1735 the heap for thread state and stack objects. (For 32-bit machines, this
1736 translates to 4K bytes, and for 64-bit machines, 8K bytes.)
1742 <Term><Option>-d</Option>:</Term>
1745 <IndexTerm><Primary>-d RTS option (parallel)</Primary></IndexTerm>
1746 (PARALLEL ONLY) Turn on debugging. It pops up one xterm (or GDB, or
1747 something…) per PVM processor. We use the standard <Command>debugger</Command>
1748 script that comes with PVM3, but we sometimes meddle with the
1749 <Command>debugger2</Command> script. We include ours in the GHC distribution,
1750 in <Filename>ghc/utils/pvm/</Filename>.
1756 <Term><Option>-qe<num></Option>:</Term>
1759 <IndexTerm><Primary>-qe<num> RTS option
1760 (parallel)</Primary></IndexTerm> (PARALLEL ONLY) Limit the spark pool size
1761 i.e. the number of pending sparks per processor to
1762 <Literal><num></Literal>. The default is 100. A larger number may be
1763 appropriate if your program generates large amounts of parallelism
1769 <Term><Option>-qQ<num></Option>:</Term>
1772 <IndexTerm><Primary>-qQ<num> RTS option (parallel)</Primary></IndexTerm>
1773 (PARALLEL ONLY) Set the size of packets transmitted between processors
1774 to <Literal><num></Literal>. The default is 1024 words. A larger number may be
1775 appropriate if your machine has a high communication cost relative to
1781 <Term><Option>-qh<num></Option>:</Term>
1784 <IndexTerm><Primary>-qh<num> RTS option (parallel)</Primary></IndexTerm>
1785 (PARALLEL ONLY) Select a packing scheme. Set the number of non-root thunks to pack in one packet to
1786 <num>-1 (0 means infinity). By default GUM uses full-subgraph
1787 packing, i.e. the entire subgraph with the requested closure as root is
1788 transmitted (provided it fits into one packet). Choosing a smaller value
1789 reduces the amount of pre-fetching of work done in GUM. This can be
1790 advantageous for improving data locality but it can also worsen the balance
1791 of the load in the system.
1796 <Term><Option>-qg<num></Option>:</Term>
1799 <IndexTerm><Primary>-qg<num> RTS option
1800 (parallel)</Primary></IndexTerm> (PARALLEL ONLY) Select a globalisation
1801 scheme. This option affects the
1802 generation of global addresses when transferring data. Global addresses are
1803 globally unique identifiers required to maintain sharing in the distributed
1804 graph structure. Currently this is a binary option. With <num>=0 full globalisation is used
1805 (default). This means a global address is generated for every closure that
1806 is transmitted. With <num>=1 a thunk-only globalisation scheme is
1807 used, which generated global address only for thunks. The latter case may
1808 lose sharing of data but has a reduced overhead in packing graph structures
1809 and maintaining internal tables of global addresses.
1820 <sect1 id="options-platform">
1821 <title>Platform-specific Flags</title>
1823 <indexterm><primary>-m* options</primary></indexterm>
1824 <indexterm><primary>platform-specific options</primary></indexterm>
1825 <indexterm><primary>machine-specific options</primary></indexterm>
1827 <para>Some flags only make sense for particular target
1833 <term><option>-mv8</option>:</term>
1835 <para>(SPARC machines)<indexterm><primary>-mv8 option (SPARC
1836 only)</primary></indexterm> Means to pass the like-named
1837 option to GCC; it says to use the Version 8 SPARC
1838 instructions, notably integer multiply and divide. The
1839 similiar <option>-m*</option> GCC options for SPARC also
1840 work, actually.</para>
1845 <term><option>-monly-[32]-regs</option>:</term>
1847 <para>(iX86 machines)<indexterm><primary>-monly-N-regs
1848 option (iX86 only)</primary></indexterm> GHC tries to
1849 “steal” four registers from GCC, for performance
1850 reasons; it almost always works. However, when GCC is
1851 compiling some modules with four stolen registers, it will
1852 crash, probably saying:
1855 Foo.hc:533: fixed or forbidden register was spilled.
1856 This may be due to a compiler bug or to impossible asm
1857 statements or clauses.
1860 Just give some registers back with
1861 <option>-monly-N-regs</option>. Try `3' first, then `2'.
1862 If `2' doesn't work, please report the bug to us.</para>
1871 <sect1 id="ext-core">
1872 <title>Generating External Core Files</title>
1874 <indexterm><primary>intermediate code generation</primary></indexterm>
1876 <para>GHC can dump its optimized intermediate code (said to be in “Core” format)
1877 to a file as a side-effect of compilation. Core files, which are given the suffix
1878 <filename>.hcr</filename>, can be read and processed by non-GHC back-end
1879 tools. The Core format is formally described in <ulink url="http://www.haskell.org/ghc/docs/papers/core.ps.gz"
1880 <citetitle>An External Representation for the GHC Core Language</citetitle></ulink>,
1881 and sample tools (in Haskell)
1882 for manipulating Core files are available in the GHC source distribution
1883 directory <literal>/fptools/ghc/utils/ext-core</literal>.
1884 Note that the format of <literal>.hcr</literal>
1885 files is <emphasis>different</emphasis> (though similar) to the Core output format generated
1886 for debugging purposes (<xref linkend="options-debugging">).</para>
1891 <term><option>-fext-core</option></term>
1893 <primary><option>-fext-core</option></primary>
1896 <para>Generate <literal>.hcr</literal> files.</para>
1910 ;;; Local Variables: ***
1912 ;;; sgml-parent-document: ("users_guide.sgml" "book" "chapter") ***