docs/users_guide/using.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <chapter id="using-ghc">
   3   <title>Using GHC</title>
   4
   5   <indexterm><primary>GHC, using</primary></indexterm>
   6   <indexterm><primary>using GHC</primary></indexterm>
   7
   8   <sect1>
   9     <title>Options overview</title>
  10
  11     <para>GHC's behaviour is controlled by
  12     <firstterm>options</firstterm>, which for historical reasons are
  13     also sometimes referred to as command-line flags or arguments.
  14     Options can be specified in three ways:</para>
  15
  16     <sect2>
  17       <title>Command-line arguments</title>
  18
  19       <indexterm><primary>structure, command-line</primary></indexterm>
  20       <indexterm><primary>command-line</primary><secondary>arguments</secondary></indexterm>
  21       <indexterm><primary>arguments</primary><secondary>command-line</secondary></indexterm>
  22
  23       <para>An invocation of GHC takes the following form:</para>
  24
  25 <screen>
  26 ghc [argument...]
  27 </screen>
  28
  29       <para>Command-line arguments are either options or file names.</para>
  30
  31       <para>Command-line options begin with <literal>-</literal>.
  32       They may <emphasis>not</emphasis> be grouped:
  33       <option>-vO</option> is different from <option>-v -O</option>.
  34       Options need not precede filenames: e.g., <literal>ghc *.o -o
  35       foo</literal>.  All options are processed and then applied to
  36       all files; you cannot, for example, invoke <literal>ghc -c -O1
  37       Foo.hs -O2 Bar.hs</literal> to apply different optimisation
  38       levels to the files <filename>Foo.hs</filename> and
  39       <filename>Bar.hs</filename>.</para>
  40     </sect2>
  41
  42     <sect2 id="source-file-options">
  43       <title>Command line options in source files</title>
  44
  45       <indexterm><primary>source-file options</primary></indexterm>
  46
  47       <para>Sometimes it is useful to make the connection between a
  48       source file and the command-line options it requires quite
  49       tight. For instance, if a Haskell source file deliberately
  50         uses name shadowing, it should be compiled with  the
  51       <option>-fno-warn-name-shadowing</option> option.  Rather than maintaining
  52       the list of per-file options in a <filename>Makefile</filename>,
  53       it is possible to do this directly in the source file using the
  54       <literal>OPTIONS_GHC</literal> pragma <indexterm><primary>OPTIONS_GHC
  55       pragma</primary></indexterm>:</para>
  56
  57 <programlisting>
  58 {-# OPTIONS_GHC -fno-warn-name-shadowing #-}
  59 module X where
  60 ...
  61 </programlisting>
  62
  63       <para><literal>OPTIONS_GHC</literal> is a <emphasis>file-header pragma</emphasis>
  64       (see <xref linkend="pragmas"/>).</para>
  65
  66       <para>Only <emphasis>dynamic</emphasis> flags can be used in an <literal>OPTIONS_GHC</literal> pragma
  67       (see <xref linkend="static-dynamic-flags"/>).</para>
  68
  69       <para>Note that your command shell does not
  70       get to the source file options, they are just included literally
  71       in the array of command-line arguments the compiler
  72       maintains internally, so you'll be desperately disappointed if
  73       you try to glob etc. inside <literal>OPTIONS_GHC</literal>.</para>
  74
  75       <para>NOTE: the contents of OPTIONS_GHC are appended to the
  76       command-line options, so options given in the source file
  77       override those given on the command-line.</para>
  78
  79       <para>It is not recommended to move all the contents of your
  80       Makefiles into your source files, but in some circumstances, the
  81       <literal>OPTIONS_GHC</literal> pragma is the Right Thing. (If you
  82       use <option>-keep-hc-file</option> and have OPTION flags in
  83       your module, the OPTIONS_GHC will get put into the generated .hc
  84       file).</para>
  85     </sect2>
  86
  87     <sect2>
  88       <title>Setting options in GHCi</title>
  89
  90       <para>Options may also be modified from within GHCi, using the
  91       <literal>:set</literal> command.  See <xref linkend="ghci-set"/>
  92       for more details.</para>
  93     </sect2>
  94   </sect1>
  95
  96   <sect1 id="static-dynamic-flags">
  97     <title>Static, Dynamic, and Mode options</title>
  98     <indexterm><primary>static</primary><secondary>options</secondary>
  99     </indexterm>
 100     <indexterm><primary>dynamic</primary><secondary>options</secondary>
 101     </indexterm>
 102     <indexterm><primary>mode</primary><secondary>options</secondary>
 103     </indexterm>
 104
 105     <para>Each of GHC's command line options is classified as
 106     <firstterm>static</firstterm>, <firstterm>dynamic</firstterm> or
 107       <firstterm>mode</firstterm>:</para>
 108
 109     <variablelist>
 110       <varlistentry>
 111         <term>Mode flags</term>
 112         <listitem>
 113           <para>For example, <option>--make</option> or <option>-E</option>.
 114             There may only be a single mode flag on the command line.  The
 115             available modes are listed in <xref linkend="modes"/>.</para>
 116         </listitem>
 117       </varlistentry>
 118       <varlistentry>
 119         <term>Dynamic Flags</term>
 120         <listitem>
 121           <para>Most non-mode flags fall into this category.  A dynamic flag
 122             may be used on the command line, in a
 123             <literal>OPTIONS_GHC</literal> pragma in a source file, or set
 124             using <literal>:set</literal> in GHCi.</para>
 125         </listitem>
 126       </varlistentry>
 127       <varlistentry>
 128         <term>Static Flags</term>
 129         <listitem>
 130           <para>A few flags are "static", which means they can only be used on
 131             the command-line, and remain in force over the entire GHC/GHCi
 132             run.</para>
 133         </listitem>
 134       </varlistentry>
 135     </variablelist>
 136
 137     <para>The flag reference tables (<xref
 138     linkend="flag-reference"/>) lists the status of each flag.</para>
 139
 140     <para>There are a few flags that are static except that they can
 141     also be used with GHCi's <literal>:set</literal> command; these
 142     are listed as &ldquo;static/<literal>:set</literal>&rdquo; in the
 143     table.</para>
 144   </sect1>
 145
 146   <sect1 id="file-suffixes">
 147     <title>Meaningful file suffixes</title>
 148
 149     <indexterm><primary>suffixes, file</primary></indexterm>
 150     <indexterm><primary>file suffixes for GHC</primary></indexterm>
 151
 152     <para>File names with &ldquo;meaningful&rdquo; suffixes (e.g.,
 153     <filename>.lhs</filename> or <filename>.o</filename>) cause the
 154     &ldquo;right thing&rdquo; to happen to those files.</para>
 155
 156     <variablelist>
 157
 158       <varlistentry>
 159         <term><filename>.hs</filename></term>
 160         <listitem>
 161           <para>A Haskell module.</para>
 162         </listitem>
 163       </varlistentry>
 164
 165       <varlistentry>
 166         <term>
 167           <filename>.lhs</filename>
 168           <indexterm><primary><literal>lhs</literal> suffix</primary></indexterm>
 169         </term>
 170         <listitem>
 171           <para>A &ldquo;literate Haskell&rdquo; module.</para>
 172         </listitem>
 173       </varlistentry>
 174
 175       <varlistentry>
 176         <term><filename>.hi</filename></term>
 177         <listitem>
 178           <para>A Haskell interface file, probably
 179           compiler-generated.</para>
 180         </listitem>
 181       </varlistentry>
 182
 183       <varlistentry>
 184         <term><filename>.hc</filename></term>
 185         <listitem>
 186           <para>Intermediate C file produced by the Haskell
 187           compiler.</para>
 188         </listitem>
 189       </varlistentry>
 190
 191       <varlistentry>
 192         <term><filename>.c</filename></term>
 193         <listitem>
 194           <para>A C&nbsp;file not produced by the Haskell
 195           compiler.</para>
 196         </listitem>
 197       </varlistentry>
 198
 199       <varlistentry>
 200         <term><filename>.s</filename></term>
 201         <listitem>
 202           <para>An assembly-language source file, usually produced by
 203           the compiler.</para>
 204         </listitem>
 205       </varlistentry>
 206
 207       <varlistentry>
 208         <term><filename>.o</filename></term>
 209         <listitem>
 210           <para>An object file, produced by an assembler.</para>
 211         </listitem>
 212       </varlistentry>
 213     </variablelist>
 214
 215     <para>Files with other suffixes (or without suffixes) are passed
 216     straight to the linker.</para>
 217
 218   </sect1>
 219
 220   <sect1 id="modes">
 221     <title>Modes of operation</title>
 222
 223     <para>GHC's behaviour is firstly controlled by a mode flag.  Only
 224     one of these flags may be given, but it does not necessarily need
 225     to be the first option on the command-line.  The available modes
 226     are:</para>
 227
 228     <variablelist>
 229       <varlistentry>
 230         <term>
 231           <cmdsynopsis><command>ghc --interactive</command>
 232           </cmdsynopsis>
 233           <indexterm><primary>interactive mode</primary></indexterm>
 234           <indexterm><primary>ghci</primary></indexterm>
 235         </term>
 236         <listitem>
 237           <para>Interactive mode, which is also available as
 238           <command>ghci</command>.  Interactive mode is described in
 239           more detail in <xref linkend="ghci"/>.</para>
 240         </listitem>
 241       </varlistentry>
 242
 243       <varlistentry>
 244         <term>
 245           <cmdsynopsis><command>ghc --make</command>
 246           </cmdsynopsis>
 247           <indexterm><primary>make mode</primary></indexterm>
 248           <indexterm><primary><option>&ndash;&ndash;make</option></primary></indexterm>
 249         </term>
 250         <listitem>
 251           <para>In this mode, GHC will build a multi-module Haskell
 252           program automatically, figuring out dependencies for itself.
 253           If you have a straightforward Haskell program, this is
 254           likely to be much easier, and faster, than using
 255           <command>make</command>.  Make mode is described in <xref
 256           linkend="make-mode"/>.</para>
 257         </listitem>
 258       </varlistentry>
 259
 260       <varlistentry>
 261         <term>
 262           <cmdsynopsis><command>ghc -e</command>
 263              <arg choice='plain'><replaceable>expr</replaceable></arg>
 264           </cmdsynopsis>
 265           <indexterm><primary>eval mode</primary></indexterm>
 266         </term>
 267         <listitem>
 268           <para>Expression-evaluation mode.  This is very similar to
 269           interactive mode, except that there is a single expression
 270           to evaluate (<replaceable>expr</replaceable>) which is given
 271           on the command line.  See <xref linkend="eval-mode"/> for
 272           more details.</para>
 273         </listitem>
 274       </varlistentry>
 275
 276       <varlistentry>
 277         <term>
 278           <cmdsynopsis>
 279             <command>ghc -E</command>
 280             <command>ghc -c</command>
 281             <command>ghc -S</command>
 282             <command>ghc -c</command>
 283           </cmdsynopsis>
 284           <indexterm><primary><option>-E</option></primary></indexterm>
 285           <indexterm><primary><option>-C</option></primary></indexterm>
 286           <indexterm><primary><option>-S</option></primary></indexterm>
 287           <indexterm><primary><option>-c</option></primary></indexterm>
 288         </term>
 289         <listitem>
 290           <para>This is the traditional batch-compiler mode, in which
 291           GHC can compile source files one at a time, or link objects
 292           together into an executable.  This mode also applies if
 293           there is no other mode flag specified on the command line,
 294           in which case it means that the specified files should be
 295           compiled and then linked to form a program. See <xref
 296           linkend="options-order"/>.</para>
 297         </listitem>
 298       </varlistentry>
 299
 300       <varlistentry>
 301         <term>
 302           <cmdsynopsis>
 303             <command>ghc -M</command>
 304           </cmdsynopsis>
 305           <indexterm><primary>dependency-generation mode</primary></indexterm>
 306         </term>
 307         <listitem>
 308           <para>Dependency-generation mode.  In this mode, GHC can be
 309           used to generate dependency information suitable for use in
 310           a <literal>Makefile</literal>.  See <xref
 311           linkend="makefile-dependencies"/>.</para>
 312         </listitem>
 313       </varlistentry>
 314
 315       <varlistentry>
 316         <term>
 317           <cmdsynopsis>
 318             <command>ghc --mk-dll</command>
 319           </cmdsynopsis>
 320           <indexterm><primary>DLL-creation mode</primary></indexterm>
 321         </term>
 322         <listitem>
 323           <para>DLL-creation mode (Windows only).  See <xref
 324           linkend="win32-dlls-create"/>.</para>
 325         </listitem>
 326       </varlistentry>
 327
 328       <varlistentry>
 329         <term>
 330           <cmdsynopsis>
 331           <command>ghc --help</command> <command>ghc -?</command>
 332             </cmdsynopsis>
 333           <indexterm><primary><option>&ndash;&ndash;help</option></primary></indexterm>
 334         </term>
 335         <listitem>
 336           <para>Cause GHC to spew a long usage message to standard
 337           output and then exit.</para>
 338         </listitem>
 339       </varlistentry>
 340
 341       <varlistentry>
 342         <term>
 343           <cmdsynopsis>
 344             <command>ghc --show-iface <replaceable>file</replaceable></command>
 345           </cmdsynopsis>
 346           <indexterm><primary><option>&ndash;&ndash;--show-iface</option></primary></indexterm>
 347         </term>
 348         <listitem>
 349               <para>Read the interface in
 350               <replaceable>file</replaceable> and dump it as text to
 351               <literal>stdout</literal>. For example <literal>ghc --show-iface M.hi</literal>.</para>
 352         </listitem>
 353       </varlistentry>
 354
 355       <varlistentry>
 356         <term>
 357           <cmdsynopsis>
 358             <command>ghc --supported-languages</command>
 359           </cmdsynopsis>
 360           <indexterm><primary><option>&ndash;&ndash;supported-languages</option></primary></indexterm>
 361         </term>
 362         <listitem>
 363           <para>Print the supported language extensions.</para>
 364         </listitem>
 365       </varlistentry>
 366
 367       <varlistentry>
 368         <term>
 369           <cmdsynopsis>
 370             <command>ghc --info</command>
 371           </cmdsynopsis>
 372           <indexterm><primary><option>&ndash;&ndash;info</option></primary></indexterm>
 373         </term>
 374         <listitem>
 375           <para>Print information about the compiler.</para>
 376         </listitem>
 377       </varlistentry>
 378
 379       <varlistentry>
 380         <term>
 381           <cmdsynopsis>
 382             <command>ghc --version</command>
 383             <command>ghc -V</command>
 384           </cmdsynopsis>
 385           <indexterm><primary><option>-V</option></primary></indexterm>
 386           <indexterm><primary><option>&ndash;&ndash;version</option></primary></indexterm>
 387         </term>
 388         <listitem>
 389           <para>Print a one-line string including GHC's version number.</para>
 390         </listitem>
 391       </varlistentry>
 392
 393       <varlistentry>
 394         <term>
 395           <cmdsynopsis>
 396             <command>ghc --numeric-version</command>
 397           </cmdsynopsis>
 398           <indexterm><primary><option>&ndash;&ndash;numeric-version</option></primary></indexterm>
 399         </term>
 400         <listitem>
 401           <para>Print GHC's numeric version number only.</para>
 402         </listitem>
 403       </varlistentry>
 404
 405       <varlistentry>
 406         <term>
 407           <cmdsynopsis>
 408             <command>ghc --print-libdir</command>
 409           </cmdsynopsis>
 410           <indexterm><primary><option>&ndash;&ndash;print-libdir</option></primary></indexterm>
 411         </term>
 412         <listitem>
 413           <para>Print the path to GHC's library directory.  This is
 414           the top of the directory tree containing GHC's libraries,
 415           interfaces, and include files (usually something like
 416           <literal>/usr/local/lib/ghc-5.04</literal> on Unix).  This
 417           is the value of
 418           <literal>$libdir</literal><indexterm><primary><literal>libdir</literal></primary></indexterm>
 419       in the package configuration file
 420       (see <xref linkend="packages"/>).</para>
 421         </listitem>
 422       </varlistentry>
 423
 424     </variablelist>
 425
 426     <sect2 id="make-mode">
 427       <title>Using <command>ghc</command> <option>&ndash;&ndash;make</option></title>
 428       <indexterm><primary><option>&ndash;&ndash;make</option></primary></indexterm>
 429       <indexterm><primary>separate compilation</primary></indexterm>
 430
 431       <para>When given the <option>&ndash;&ndash;make</option> option,
 432       GHC will build a multi-module Haskell program by following
 433       dependencies from one or more root modules (usually just
 434       <literal>Main</literal>).  For example, if your
 435       <literal>Main</literal> module is in a file called
 436       <filename>Main.hs</filename>, you could compile and link the
 437       program like this:</para>
 438
 439 <screen>
 440 ghc &ndash;&ndash;make Main.hs
 441 </screen>
 442
 443       <para>The command line may contain any number of source file
 444       names or module names; GHC will figure out all the modules in
 445       the program by following the imports from these initial modules.
 446       It will then attempt to compile each module which is out of
 447       date, and finally, if there is a <literal>Main</literal> module,
 448       the program will also be linked into an executable.</para>
 449
 450       <para>The main advantages to using <literal>ghc
 451       &ndash;&ndash;make</literal> over traditional
 452       <literal>Makefile</literal>s are:</para>
 453
 454       <itemizedlist>
 455         <listitem>
 456           <para>GHC doesn't have to be restarted for each compilation,
 457           which means it can cache information between compilations.
 458           Compiling a multi-module program with <literal>ghc
 459           &ndash;&ndash;make</literal> can be up to twice as fast as
 460           running <literal>ghc</literal> individually on each source
 461           file.</para>
 462         </listitem>
 463         <listitem>
 464           <para>You don't have to write a <literal>Makefile</literal>.</para>
 465           <indexterm><primary><literal>Makefile</literal>s</primary><secondary>avoiding</secondary></indexterm>
 466         </listitem>
 467         <listitem>
 468           <para>GHC re-calculates the dependencies each time it is
 469           invoked, so the dependencies never get out of sync with the
 470           source.</para>
 471         </listitem>
 472       </itemizedlist>
 473
 474       <para>Any of the command-line options described in the rest of
 475       this chapter can be used with
 476       <option>&ndash;&ndash;make</option>, but note that any options
 477       you give on the command line will apply to all the source files
 478       compiled, so if you want any options to apply to a single source
 479       file only, you'll need to use an <literal>OPTIONS_GHC</literal>
 480       pragma (see <xref linkend="source-file-options"/>).</para>
 481
 482       <para>If the program needs to be linked with additional objects
 483       (say, some auxiliary C code), then the object files can be
 484       given on the command line and GHC will include them when linking
 485       the executable.</para>
 486
 487       <para>Note that GHC can only follow dependencies if it has the
 488       source file available, so if your program includes a module for
 489       which there is no source file, even if you have an object and an
 490       interface file for the module, then GHC will complain.  The
 491       exception to this rule is for package modules, which may or may
 492       not have source files.</para>
 493
 494       <para>The source files for the program don't all need to be in
 495       the same directory; the <option>-i</option> option can be used
 496       to add directories to the search path (see <xref
 497       linkend="search-path"/>).</para>
 498     </sect2>
 499
 500     <sect2 id="eval-mode">
 501       <title>Expression evaluation mode</title>
 502
 503       <para>This mode is very similar to interactive mode, except that
 504       there is a single expression to evaluate which is specified on
 505       the command line as an argument to the <option>-e</option>
 506       option:</para>
 507
 508 <screen>
 509 ghc -e <replaceable>expr</replaceable>
 510 </screen>
 511
 512       <para>Haskell source files may be named on the command line, and
 513       they will be loaded exactly as in interactive mode.  The
 514       expression is evaluated in the context of the loaded
 515       modules.</para>
 516
 517       <para>For example, to load and run a Haskell program containing
 518       a module <literal>Main</literal>, we might say</para>
 519
 520 <screen>
 521 ghc -e Main.main Main.hs
 522 </screen>
 523
 524       <para>or we can just use this mode to evaluate expressions in
 525       the context of the <literal>Prelude</literal>:</para>
 526
 527 <screen>
 528 $ ghc -e "interact (unlines.map reverse.lines)"
 529 hello
 530 olleh
 531 </screen>
 532     </sect2>
 533
 534     <sect2 id="options-order">
 535       <title>Batch compiler mode</title>
 536
 537       <para>In <emphasis>batch mode</emphasis>, GHC will compile one or more source files
 538       given on the command line.</para>
 539
 540       <para>The first phase to run is determined by each input-file
 541       suffix, and the last phase is determined by a flag.  If no
 542       relevant flag is present, then go all the way through to linking.
 543       This table summarises:</para>
 544
 545       <informaltable>
 546         <tgroup cols="4">
 547           <colspec align="left"/>
 548           <colspec align="left"/>
 549           <colspec align="left"/>
 550           <colspec align="left"/>
 551
 552           <thead>
 553             <row>
 554               <entry>Phase of the compilation system</entry>
 555               <entry>Suffix saying &ldquo;start here&rdquo;</entry>
 556               <entry>Flag saying &ldquo;stop after&rdquo;</entry>
 557               <entry>(suffix of) output file</entry>
 558             </row>
 559           </thead>
 560           <tbody>
 561             <row>
 562               <entry>literate pre-processor</entry>
 563               <entry><literal>.lhs</literal></entry>
 564               <entry>-</entry>
 565               <entry><literal>.hs</literal></entry>
 566             </row>
 567
 568             <row>
 569               <entry>C pre-processor (opt.) </entry>
 570               <entry><literal>.hs</literal> (with
 571               <option>-cpp</option>)</entry>
 572               <entry><option>-E</option></entry>
 573               <entry><literal>.hspp</literal></entry>
 574             </row>
 575
 576             <row>
 577               <entry>Haskell compiler</entry>
 578               <entry><literal>.hs</literal></entry>
 579               <entry><option>-C</option>, <option>-S</option></entry>
 580               <entry><literal>.hc</literal>, <literal>.s</literal></entry>
 581             </row>
 582
 583             <row>
 584               <entry>C compiler (opt.)</entry>
 585               <entry><literal>.hc</literal> or <literal>.c</literal></entry>
 586               <entry><option>-S</option></entry>
 587               <entry><literal>.s</literal></entry>
 588             </row>
 589
 590             <row>
 591               <entry>assembler</entry>
 592               <entry><literal>.s</literal></entry>
 593               <entry><option>-c</option></entry>
 594               <entry><literal>.o</literal></entry>
 595             </row>
 596
 597             <row>
 598               <entry>linker</entry>
 599               <entry><replaceable>other</replaceable></entry>
 600               <entry>-</entry>
 601               <entry><filename>a.out</filename></entry>
 602             </row>
 603           </tbody>
 604         </tgroup>
 605       </informaltable>
 606
 607       <indexterm><primary><option>-C</option></primary></indexterm>
 608       <indexterm><primary><option>-E</option></primary></indexterm>
 609       <indexterm><primary><option>-S</option></primary></indexterm>
 610       <indexterm><primary><option>-c</option></primary></indexterm>
 611
 612       <para>Thus, a common invocation would be: </para>
 613
 614 <screen>
 615 ghc -c Foo.hs</screen>
 616
 617       <para>to compile the Haskell source file
 618       <filename>Foo.hs</filename> to an object file
 619       <filename>Foo.o</filename>.</para>
 620
 621       <para>Note: What the Haskell compiler proper produces depends on
 622       whether a native-code generator<indexterm><primary>native-code
 623       generator</primary></indexterm> is used (producing assembly
 624       language) or not (producing C).  See <xref
 625       linkend="options-codegen"/> for more details.</para>
 626
 627       <para>Note: C pre-processing is optional, the
 628       <option>-cpp</option><indexterm><primary><option>-cpp</option></primary></indexterm>
 629       flag turns it on.  See <xref linkend="c-pre-processor"/> for more
 630       details.</para>
 631
 632       <para>Note: The option <option>-E</option><indexterm><primary>-E
 633       option</primary></indexterm> runs just the pre-processing passes
 634       of the compiler, dumping the result in a file.</para>
 635
 636       <sect3 id="overriding-suffixes">
 637         <title>Overriding the default behaviour for a file</title>
 638
 639         <para>As described above, the way in which a file is processed by GHC
 640           depends on its suffix.  This behaviour can be overridden using the
 641           <option>-x</option> option:</para>
 642
 643         <variablelist>
 644           <varlistentry>
 645             <term><option>-x</option> <replaceable>suffix</replaceable>
 646                       <indexterm><primary><option>-x</option></primary>
 647               </indexterm></term>
 648               <listitem>
 649                 <para>Causes all files following this option on the command
 650                   line to be processed as if they had the suffix
 651                   <replaceable>suffix</replaceable>.  For example, to compile a
 652                   Haskell module in the file <literal>M.my-hs</literal>,
 653                   use <literal>ghc -c -x hs M.my-hs</literal>.</para>
 654               </listitem>
 655           </varlistentry>
 656         </variablelist>
 657       </sect3>
 658
 659     </sect2>
 660   </sect1>
 661
 662   <sect1 id="options-help">
 663     <title>Help and verbosity options</title>
 664
 665     <indexterm><primary>help options</primary></indexterm>
 666     <indexterm><primary>verbosity options</primary></indexterm>
 667
 668     <para>See also the <option>--help</option>, <option>--version</option>, <option>--numeric-version</option>,
 669     and <option>--print-libdir</option> modes in <xref linkend="modes"/>.</para>
 670     <variablelist>
 671       <varlistentry>
 672         <term>
 673           <option>-n</option>
 674           <indexterm><primary><option>-n</option></primary></indexterm>
 675         </term>
 676         <listitem>
 677           <para>Does a dry-run, i.e. GHC goes through all the motions
 678           of compiling as normal, but does not actually run any
 679           external commands.</para>
 680         </listitem>
 681       </varlistentry>
 682
 683       <varlistentry>
 684         <term>
 685           <option>-v</option>
 686           <indexterm><primary><option>-v</option></primary></indexterm>
 687         </term>
 688         <listitem>
 689           <para>The <option>-v</option> option makes GHC
 690           <emphasis>verbose</emphasis>: it reports its version number
 691           and shows (on stderr) exactly how it invokes each phase of
 692           the compilation system.  Moreover, it passes the
 693           <option>-v</option> flag to most phases; each reports its
 694           version number (and possibly some other information).</para>
 695
 696           <para>Please, oh please, use the <option>-v</option> option
 697           when reporting bugs!  Knowing that you ran the right bits in
 698           the right order is always the first thing we want to
 699           verify.</para>
 700         </listitem>
 701       </varlistentry>
 702
 703       <varlistentry>
 704         <term>
 705           <option>-v</option><replaceable>n</replaceable>
 706           <indexterm><primary><option>-v</option></primary></indexterm>
 707         </term>
 708         <listitem>
 709           <para>To provide more control over the compiler's verbosity,
 710           the <option>-v</option> flag takes an optional numeric
 711           argument.  Specifying <option>-v</option> on its own is
 712           equivalent to <option>-v3</option>, and the other levels
 713           have the following meanings:</para>
 714
 715           <variablelist>
 716             <varlistentry>
 717               <term><option>-v0</option></term>
 718               <listitem>
 719                 <para>Disable all non-essential messages (this is the
 720                 default).</para>
 721               </listitem>
 722             </varlistentry>
 723
 724             <varlistentry>
 725               <term><option>-v1</option></term>
 726               <listitem>
 727                 <para>Minimal verbosity: print one line per
 728                 compilation (this is the default when
 729                 <option>&ndash;&ndash;make</option> or
 730                 <option>&ndash;&ndash;interactive</option> is on).</para>
 731               </listitem>
 732             </varlistentry>
 733
 734             <varlistentry>
 735               <term><option>-v2</option></term>
 736               <listitem>
 737                 <para>Print the name of each compilation phase as it
 738                 is executed. (equivalent to
 739                 <option>-dshow-passes</option>).</para>
 740               </listitem>
 741             </varlistentry>
 742
 743             <varlistentry>
 744               <term><option>-v3</option></term>
 745               <listitem>
 746                 <para>The same as <option>-v2</option>, except that in
 747                 addition the full command line (if appropriate) for
 748                 each compilation phase is also printed.</para>
 749               </listitem>
 750             </varlistentry>
 751
 752             <varlistentry>
 753               <term><option>-v4</option></term>
 754               <listitem>
 755                 <para>The same as <option>-v3</option> except that the
 756                 intermediate program representation after each
 757                 compilation phase is also printed (excluding
 758                 preprocessed and C/assembly files).</para>
 759               </listitem>
 760             </varlistentry>
 761           </variablelist>
 762         </listitem>
 763       </varlistentry>
 764
 765       <varlistentry>
 766         <term><option>-ferror-spans</option>
 767           <indexterm><primary><option>-ferror-spans</option></primary>
 768           </indexterm>
 769         </term>
 770         <listitem>
 771           <para>Causes GHC to emit the full source span of the
 772           syntactic entity relating to an error message.  Normally, GHC
 773           emits the source location of the start of the syntactic
 774           entity only.</para>
 775
 776           <para>For example:</para>
 777
 778 <screen>test.hs:3:6: parse error on input `where'</screen>
 779
 780           <para>becomes:</para>
 781
 782 <screen>test296.hs:3:6-10: parse error on input `where'</screen>
 783
 784           <para>And multi-line spans are possible too:</para>
 785
 786 <screen>test.hs:(5,4)-(6,7):
 787     Conflicting definitions for `a'
 788     Bound at: test.hs:5:4
 789               test.hs:6:7
 790     In the binding group for: a, b, a</screen>
 791
 792           <para>Note that line numbers start counting at one, but
 793           column numbers start at zero.  This choice was made to
 794           follow existing convention (i.e. this is how Emacs does
 795           it).</para>
 796         </listitem>
 797       </varlistentry>
 798
 799       <varlistentry>
 800         <term><option>-H</option><replaceable>size</replaceable>
 801         <indexterm><primary><option>-H</option></primary></indexterm>
 802         </term>
 803         <listitem>
 804           <para>Set the minimum size of the heap to
 805           <replaceable>size</replaceable>.
 806           This option is equivalent to
 807           <literal>+RTS&nbsp;-H<replaceable>size</replaceable></literal>,
 808           see <xref linkend="rts-options-gc" />.
 809           </para>
 810         </listitem>
 811       </varlistentry>
 812
 813       <varlistentry>
 814         <term><option>-Rghc-timing</option>
 815         <indexterm><primary><option>-Rghc-timing</option></primary></indexterm>
 816         </term>
 817         <listitem>
 818           <para>Prints a one-line summary of timing statistics for the
 819           GHC run.  This option is equivalent to
 820           <literal>+RTS&nbsp;-tstderr</literal>, see <xref
 821           linkend="rts-options-gc" />.
 822           </para>
 823         </listitem>
 824       </varlistentry>
 825     </variablelist>
 826   </sect1>
 827
 828   &separate;
 829
 830   <sect1 id="options-sanity">
 831     <title>Warnings and sanity-checking</title>
 832
 833     <indexterm><primary>sanity-checking options</primary></indexterm>
 834     <indexterm><primary>warnings</primary></indexterm>
 835
 836
 837     <para>GHC has a number of options that select which types of
 838     non-fatal error messages, otherwise known as warnings, can be
 839     generated during compilation.  By default, you get a standard set
 840     of warnings which are generally likely to indicate bugs in your
 841     program.  These are:
 842     <option>-fwarn-overlapping-patterns</option>,
 843     <option>-fwarn-warnings-deprecations</option>,
 844     <option>-fwarn-deprecated-flags</option>,
 845     <option>-fwarn-duplicate-exports</option>,
 846     <option>-fwarn-missing-fields</option>,
 847     <option>-fwarn-missing-methods</option>,
 848     <option>-fwarn-lazy-unlifted-bindings</option>,
 849     <option>-fwarn-wrong-do-bind</option>, and
 850     <option>-fwarn-dodgy-foreign-imports</option>.  The following
 851     flags are
 852     simple ways to select standard &ldquo;packages&rdquo; of warnings:
 853     </para>
 854
 855     <variablelist>
 856
 857       <varlistentry>
 858         <term><option>-W</option>:</term>
 859         <listitem>
 860           <indexterm><primary>-W option</primary></indexterm>
 861           <para>Provides the standard warnings plus
 862           <option>-fwarn-incomplete-patterns</option>,
 863           <option>-fwarn-dodgy-imports</option>,
 864           <option>-fwarn-unused-matches</option>,
 865           <option>-fwarn-unused-imports</option>, and
 866           <option>-fwarn-unused-binds</option>.</para>
 867         </listitem>
 868       </varlistentry>
 869
 870       <varlistentry>
 871         <term><option>-Wall</option>:</term>
 872         <listitem>
 873           <indexterm><primary><option>-Wall</option></primary></indexterm>
 874           <para>Turns on all warning options that indicate potentially
 875           suspicious code.  The warnings that are
 876           <emphasis>not</emphasis> enabled by <option>-Wall</option>
 877           are
 878             <option>-fwarn-simple-patterns</option>,
 879             <option>-fwarn-tabs</option>,
 880             <option>-fwarn-incomplete-record-updates</option>,
 881             <option>-fwarn-monomorphism-restriction</option>,
 882             <option>-fwarn-unused-do-bind</option>, and
 883             <option>-fwarn-implicit-prelude</option>.</para>
 884         </listitem>
 885       </varlistentry>
 886
 887       <varlistentry>
 888         <term><option>-w</option>:</term>
 889         <listitem>
 890           <indexterm><primary><option>-w</option></primary></indexterm>
 891           <para>Turns off all warnings, including the standard ones and
 892       those that <literal>-Wall</literal> doesn't enable.</para>
 893         </listitem>
 894       </varlistentry>
 895
 896       <varlistentry>
 897         <term><option>-Werror</option>:</term>
 898         <listitem>
 899           <indexterm><primary><option>-Werror</option></primary></indexterm>
 900           <para>Makes any warning into a fatal error. Useful so that you don't
 901             miss warnings when doing batch compilation. </para>
 902         </listitem>
 903       </varlistentry>
 904
 905       <varlistentry>
 906         <term><option>-Wwarn</option>:</term>
 907         <listitem>
 908           <indexterm><primary><option>-Wwarn</option></primary></indexterm>
 909           <para>Warnings are treated only as warnings, not as errors. This is
 910             the default, but can be useful to negate a
 911         <option>-Werror</option> flag.</para>
 912         </listitem>
 913       </varlistentry>
 914
 915     </variablelist>
 916
 917     <para>The full set of warning options is described below.  To turn
 918     off any warning, simply give the corresponding
 919     <option>-fno-warn-...</option> option on the command line.</para>
 920
 921     <variablelist>
 922
 923       <varlistentry>
 924         <term><option>-fwarn-unrecognised-pragmas</option>:</term>
 925         <listitem>
 926           <indexterm><primary><option>-fwarn-unrecognised-pragmas</option></primary>
 927           </indexterm>
 928           <indexterm><primary>warnings</primary></indexterm>
 929           <indexterm><primary>pragmas</primary></indexterm>
 930           <para>Causes a warning to be emitted when a
 931           pragma that GHC doesn't recognise is used. As well as pragmas
 932       that GHC itself uses, GHC also recognises pragmas known to be used
 933       by other tools, e.g. <literal>OPTIONS_HUGS</literal> and
 934       <literal>DERIVE</literal>.</para>
 935
 936           <para>This option is on by default.</para>
 937         </listitem>
 938       </varlistentry>
 939
 940       <varlistentry>
 941         <term><option>-fwarn-warnings-deprecations</option>:</term>
 942         <listitem>
 943           <indexterm><primary><option>-fwarn-warnings-deprecations</option></primary>
 944           </indexterm>
 945           <indexterm><primary>warnings</primary></indexterm>
 946           <indexterm><primary>deprecations</primary></indexterm>
 947           <para>Causes a warning to be emitted when a
 948           module, function or type with a WARNING or DEPRECATED pragma
 949       is used. See <xref linkend="warning-deprecated-pragma"/> for more
 950       details on the pragmas.</para>
 951
 952           <para>This option is on by default.</para>
 953         </listitem>
 954       </varlistentry>
 955
 956       <varlistentry>
 957         <term><option>-fwarn-deprecated-flags</option>:</term>
 958         <listitem>
 959           <indexterm><primary><option>-fwarn-deprecated-flags</option></primary>
 960           </indexterm>
 961           <indexterm><primary>deprecated-flags</primary></indexterm>
 962           <para>Causes a warning to be emitted when a deprecated
 963           commandline flag is used.</para>
 964
 965           <para>This option is on by default.</para>
 966         </listitem>
 967       </varlistentry>
 968
 969       <varlistentry>
 970         <term><option>-fwarn-dodgy-foreign-imports</option>:</term>
 971         <listitem>
 972           <indexterm><primary><option>-fwarn-dodgy-foreign-imports</option></primary>
 973           </indexterm>
 974           <para>Causes a warning to be emitted for foreign imports of
 975           the following form:</para>
 976 <programlisting>
 977 foreign import "f" f :: FunPtr t
 978 </programlisting>
 979           <para>on the grounds that it probably should be</para>
 980 <programlisting>
 981 foreign import "&amp;f" f :: FunPtr t
 982 </programlisting>
 983           <para>The first form declares that `f` is a (pure) C
 984           function that takes no arguments and returns a pointer to a
 985           C function with type `t`, whereas the second form declares
 986           that `f` itself is a C function with type `t`.  The first
 987           declaration is usually a mistake, and one that is hard to
 988           debug because it results in a crash, hence this
 989           warning.</para>
 990         </listitem>
 991       </varlistentry>
 992
 993       <varlistentry>
 994         <term><option>-fwarn-dodgy-imports</option>:</term>
 995         <listitem>
 996           <indexterm><primary><option>-fwarn-dodgy-imports</option></primary>
 997           </indexterm>
 998           <para>Causes a warning to be emitted when a datatype
 999       <literal>T</literal> is imported
1000       with all constructors, i.e. <literal>T(..)</literal>, but has been
1001       exported abstractly, i.e. <literal>T</literal>.</para>
1002         </listitem>
1003       </varlistentry>
1004
1005       <varlistentry>
1006         <term><option>-fwarn-lazy-unlifted-bindings</option>:</term>
1007         <listitem>
1008           <indexterm><primary><option>-fwarn-lazy-unlifted-bindings</option></primary>
1009           </indexterm>
1010           <para>Causes a warning to be emitted when an unlifted type
1011       is bound in a way that looks lazy, e.g.
1012       <literal>where (I# x) = ...</literal>. Use
1013       <literal>where !(I# x) = ...</literal> instead. This will be an
1014       error, rather than a warning, in GHC 6.14.
1015       </para>
1016         </listitem>
1017       </varlistentry>
1018
1019       <varlistentry>
1020         <term><option>-fwarn-duplicate-exports</option>:</term>
1021         <listitem>
1022           <indexterm><primary><option>-fwarn-duplicate-exports</option></primary></indexterm>
1023           <indexterm><primary>duplicate exports, warning</primary></indexterm>
1024           <indexterm><primary>export lists, duplicates</primary></indexterm>
1025
1026           <para>Have the compiler warn about duplicate entries in
1027           export lists. This is useful information if you maintain
1028           large export lists, and want to avoid the continued export
1029           of a definition after you've deleted (one) mention of it in
1030           the export list.</para>
1031
1032           <para>This option is on by default.</para>
1033         </listitem>
1034       </varlistentry>
1035
1036       <varlistentry>
1037         <term><option>-fwarn-hi-shadowing</option>:</term>
1038         <listitem>
1039           <indexterm><primary><option>-fwarn-hi-shadowing</option></primary></indexterm>
1040           <indexterm><primary>shadowing</primary>
1041             <secondary>interface files</secondary></indexterm>
1042
1043           <para>Causes the compiler to emit a warning when a module or
1044           interface file in the current directory is shadowing one
1045           with the same module name in a library or other
1046           directory.</para>
1047         </listitem>
1048       </varlistentry>
1049
1050       <varlistentry>
1051         <term><option>-fwarn-implicit-prelude</option>:</term>
1052         <listitem>
1053           <indexterm><primary><option>-fwarn-implicit-prelude</option></primary></indexterm>
1054           <indexterm><primary>implicit prelude, warning</primary></indexterm>
1055           <para>Have the compiler warn if the Prelude is implicitly
1056           imported.  This happens unless either the Prelude module is
1057           explicitly imported with an <literal>import ... Prelude ...</literal>
1058           line, or this implicit import is disabled (either by
1059           <option>-XNoImplicitPrelude</option> or a
1060           <literal>LANGUAGE NoImplicitPrelude</literal> pragma).</para>
1061
1062           <para>Note that no warning is given for syntax that implicitly
1063           refers to the Prelude, even if <option>-XNoImplicitPrelude</option>
1064           would change whether it refers to the Prelude.
1065           For example, no warning is given when
1066           <literal>368</literal> means
1067           <literal>Prelude.fromInteger (368::Prelude.Integer)</literal>
1068           (where <literal>Prelude</literal> refers to the actual Prelude module,
1069           regardless of the imports of the module being compiled).</para>
1070
1071           <para>This warning is off by default.</para>
1072         </listitem>
1073       </varlistentry>
1074
1075       <varlistentry>
1076         <term><option>-fwarn-incomplete-patterns</option>:</term>
1077         <listitem>
1078           <indexterm><primary><option>-fwarn-incomplete-patterns</option></primary></indexterm>
1079           <indexterm><primary>incomplete patterns, warning</primary></indexterm>
1080           <indexterm><primary>patterns, incomplete</primary></indexterm>
1081
1082           <para>Similarly for incomplete patterns, the function
1083           <function>g</function> below will fail when applied to
1084           non-empty lists, so the compiler will emit a warning about
1085           this when <option>-fwarn-incomplete-patterns</option> is
1086           enabled.</para>
1087
1088 <programlisting>
1089 g [] = 2
1090 </programlisting>
1091
1092           <para>This option isn't enabled by default because it can be
1093           a bit noisy, and it doesn't always indicate a bug in the
1094           program.  However, it's generally considered good practice
1095           to cover all the cases in your functions.</para>
1096         </listitem>
1097       </varlistentry>
1098
1099       <varlistentry>
1100         <term><option>-fwarn-incomplete-record-updates</option>:</term>
1101         <listitem>
1102           <indexterm><primary><option>-fwarn-incomplete-record-updates</option></primary></indexterm>
1103           <indexterm><primary>incomplete record updates, warning</primary></indexterm>
1104           <indexterm><primary>record updates, incomplete</primary></indexterm>
1105
1106           <para>The function
1107           <function>f</function> below will fail when applied to
1108           <literal>Bar</literal>, so the compiler will emit a warning about
1109           this when <option>-fwarn-incomplete-record-updates</option> is
1110           enabled.</para>
1111
1112 <programlisting>
1113 data Foo = Foo { x :: Int }
1114          | Bar
1115
1116 f :: Foo -> Foo
1117 f foo = foo { x = 6 }
1118 </programlisting>
1119
1120           <para>This option isn't enabled by default because it can be
1121           very noisy, and it often doesn't indicate a bug in the
1122           program.</para>
1123         </listitem>
1124       </varlistentry>
1125
1126       <varlistentry>
1127         <term>
1128           <option>-fwarn-missing-fields</option>:
1129           <indexterm><primary><option>-fwarn-missing-fields</option></primary></indexterm>
1130           <indexterm><primary>missing fields, warning</primary></indexterm>
1131           <indexterm><primary>fields, missing</primary></indexterm>
1132         </term>
1133         <listitem>
1134
1135           <para>This option is on by default, and warns you whenever
1136           the construction of a labelled field constructor isn't
1137           complete, missing initializers for one or more fields. While
1138           not an error (the missing fields are initialised with
1139           bottoms), it is often an indication of a programmer error.</para>
1140         </listitem>
1141       </varlistentry>
1142
1143       <varlistentry>
1144         <term><option>-fwarn-missing-methods</option>:</term>
1145         <listitem>
1146           <indexterm><primary><option>-fwarn-missing-methods</option></primary></indexterm>
1147           <indexterm><primary>missing methods, warning</primary></indexterm>
1148           <indexterm><primary>methods, missing</primary></indexterm>
1149
1150           <para>This option is on by default, and warns you whenever
1151           an instance declaration is missing one or more methods, and
1152           the corresponding class declaration has no default
1153           declaration for them.</para>
1154           <para>The warning is suppressed if the method name
1155           begins with an underscore.  Here's an example where this is useful:
1156             <programlisting>
1157               class C a where
1158                 _simpleFn :: a -> String
1159                 complexFn :: a -> a -> String
1160                 complexFn x y = ... _simpleFn ...
1161               </programlisting>
1162             The idea is that: (a) users of the class will only call <literal>complexFn</literal>;
1163             never <literal>_simpleFn</literal>; and (b)
1164             instance declarations can define either <literal>complexFn</literal> or <literal>_simpleFn</literal>.
1165             </para>
1166         </listitem>
1167       </varlistentry>
1168
1169       <varlistentry>
1170         <term><option>-fwarn-missing-signatures</option>:</term>
1171         <listitem>
1172           <indexterm><primary><option>-fwarn-missing-signatures</option></primary></indexterm>
1173           <indexterm><primary>type signatures, missing</primary></indexterm>
1174
1175           <para>If you would like GHC to check that every top-level
1176           function/value has a type signature, use the
1177           <option>-fwarn-missing-signatures</option> option.  As part of
1178             the warning GHC also reports the inferred type.  The
1179           option is off by default.</para>
1180         </listitem>
1181       </varlistentry>
1182
1183       <varlistentry>
1184         <term><option>-fwarn-name-shadowing</option>:</term>
1185         <listitem>
1186           <indexterm><primary><option>-fwarn-name-shadowing</option></primary></indexterm>
1187           <indexterm><primary>shadowing, warning</primary></indexterm>
1188
1189           <para>This option causes a warning to be emitted whenever an
1190           inner-scope value has the same name as an outer-scope value,
1191           i.e. the inner value shadows the outer one.  This can catch
1192           typographical errors that turn into hard-to-find bugs, e.g.,
1193           in the inadvertent capture of what would be a recursive call in
1194           <literal>f = ... let f = id in ... f ...</literal>.</para>
1195           <para>The warning is suppressed for names beginning with an underscore.  For example
1196           <programlisting>
1197              f x = do { _ignore &lt;- this; _ignore &lt;- that; return (the other) }
1198           </programlisting>
1199          </para>
1200         </listitem>
1201       </varlistentry>
1202
1203       <varlistentry>
1204         <term><option>-fwarn-orphans</option>:</term>
1205         <listitem>
1206           <indexterm><primary><option>-fwarn-orphans</option></primary></indexterm>
1207           <indexterm><primary>orphan instances, warning</primary></indexterm>
1208           <indexterm><primary>orphan rules, warning</primary></indexterm>
1209
1210           <para>This option causes a warning to be emitted whenever the
1211             module contains an "orphan" instance declaration or rewrite rule.
1212             An instance declaration is an orphan if it appears in a module in
1213             which neither the class nor the type being instanced are declared
1214             in the same module.  A rule is an orphan if it is a rule for a
1215             function declared in another module.  A module containing any
1216           orphans is called an orphan module.</para>
1217           <para>The trouble with orphans is that GHC must pro-actively read the interface
1218             files for all orphan modules, just in case their instances or rules
1219             play a role, whether or not the module's interface would otherwise
1220             be of any use.  See <xref linkend="orphan-modules"/> for details.
1221             </para>
1222         </listitem>
1223       </varlistentry>
1224
1225       <varlistentry>
1226         <term>
1227           <option>-fwarn-overlapping-patterns</option>:
1228           <indexterm><primary><option>-fwarn-overlapping-patterns</option></primary></indexterm>
1229           <indexterm><primary>overlapping patterns, warning</primary></indexterm>
1230           <indexterm><primary>patterns, overlapping</primary></indexterm>
1231         </term>
1232         <listitem>
1233           <para>By default, the compiler will warn you if a set of
1234           patterns are overlapping, e.g.,</para>
1235
1236 <programlisting>
1237 f :: String -&#62; Int
1238 f []     = 0
1239 f (_:xs) = 1
1240 f "2"    = 2
1241 </programlisting>
1242
1243           <para>where the last pattern match in <function>f</function>
1244           won't ever be reached, as the second pattern overlaps
1245           it. More often than not, redundant patterns is a programmer
1246           mistake/error, so this option is enabled by default.</para>
1247         </listitem>
1248       </varlistentry>
1249
1250       <varlistentry>
1251         <term><option>-fwarn-simple-patterns</option>:</term>
1252         <listitem>
1253           <indexterm><primary><option>-fwarn-simple-patterns</option></primary>
1254           </indexterm>
1255           <para>Causes the compiler to warn about lambda-bound
1256           patterns that can fail, eg. <literal>\(x:xs)->...</literal>.
1257           Normally, these aren't treated as incomplete patterns by
1258           <option>-fwarn-incomplete-patterns</option>.</para>
1259           <para>&ldquo;Lambda-bound patterns&rdquo; includes all places where there is a single pattern,
1260             including list comprehensions and do-notation.  In these cases, a pattern-match
1261             failure is quite legitimate, and triggers filtering (list comprehensions) or
1262             the monad <literal>fail</literal> operation (monads). For example:
1263             <programlisting>
1264               f :: [Maybe a] -> [a]
1265               f xs = [y | Just y &lt;- xs]
1266               </programlisting>
1267             Switching on <option>-fwarn-simple-patterns</option> will elicit warnings about
1268             these probably-innocent cases, which is why the flag is off by default. </para>
1269         </listitem>
1270       </varlistentry>
1271
1272       <varlistentry>
1273         <term><option>-fwarn-tabs</option>:</term>
1274         <listitem>
1275           <indexterm><primary><option>-fwarn-tabs</option></primary></indexterm>
1276           <indexterm><primary>tabs, warning</primary></indexterm>
1277           <para>Have the compiler warn if there are tabs in your source
1278           file.</para>
1279
1280           <para>This warning is off by default.</para>
1281         </listitem>
1282       </varlistentry>
1283
1284       <varlistentry>
1285         <term><option>-fwarn-type-defaults</option>:</term>
1286         <listitem>
1287           <indexterm><primary><option>-fwarn-type-defaults</option></primary></indexterm>
1288           <indexterm><primary>defaulting mechanism, warning</primary></indexterm>
1289           <para>Have the compiler warn/inform you where in your source
1290           the Haskell defaulting mechanism for numeric types kicks
1291           in. This is useful information when converting code from a
1292           context that assumed one default into one with another,
1293           e.g., the &lsquo;default default&rsquo; for Haskell 1.4 caused the
1294           otherwise unconstrained value <constant>1</constant> to be
1295           given the type <literal>Int</literal>, whereas Haskell 98
1296           defaults it to <literal>Integer</literal>.  This may lead to
1297           differences in performance and behaviour, hence the
1298           usefulness of being non-silent about this.</para>
1299
1300           <para>This warning is off by default.</para>
1301         </listitem>
1302       </varlistentry>
1303
1304       <varlistentry>
1305         <term><option>-fwarn-monomorphism-restriction</option>:</term>
1306         <listitem>
1307           <indexterm><primary><option>-fwarn-monomorphism-restriction</option></primary></indexterm>
1308           <indexterm><primary>monomorphism restriction, warning</primary></indexterm>
1309           <para>Have the compiler warn/inform you where in your source
1310           the Haskell Monomorphism Restriction is applied.  If applied silently
1311           the MR can give rise to unexpected behaviour, so it can be helpful
1312           to have an explicit warning that it is being applied.</para>
1313
1314           <para>This warning is off by default.</para>
1315         </listitem>
1316       </varlistentry>
1317
1318       <varlistentry>
1319         <term><option>-fwarn-unused-binds</option>:</term>
1320         <listitem>
1321           <indexterm><primary><option>-fwarn-unused-binds</option></primary></indexterm>
1322           <indexterm><primary>unused binds, warning</primary></indexterm>
1323           <indexterm><primary>binds, unused</primary></indexterm>
1324           <para>Report any function definitions (and local bindings)
1325           which are unused.  For top-level functions, the warning is
1326           only given if the binding is not exported.</para>
1327           <para>A definition is regarded as "used" if (a) it is exported, or (b) it is
1328             mentioned in the right hand side of another definition that is used, or (c) the
1329             function it defines begins with an underscore.  The last case provides a
1330             way to suppress unused-binding warnings selectively.  </para>
1331           <para> Notice that a variable
1332             is reported as unused even if it appears in the right-hand side of another
1333             unused binding. </para>
1334         </listitem>
1335       </varlistentry>
1336
1337       <varlistentry>
1338         <term><option>-fwarn-unused-imports</option>:</term>
1339         <listitem>
1340           <indexterm><primary><option>-fwarn-unused-imports</option></primary></indexterm>
1341           <indexterm><primary>unused imports, warning</primary></indexterm>
1342           <indexterm><primary>imports, unused</primary></indexterm>
1343
1344           <para>Report any modules that are explicitly imported but
1345           never used.  However, the form <literal>import M()</literal> is
1346           never reported as an unused import, because it is a useful idiom
1347           for importing instance declarations, which are anonymous in Haskell.</para>
1348         </listitem>
1349       </varlistentry>
1350
1351       <varlistentry>
1352         <term><option>-fwarn-unused-matches</option>:</term>
1353         <listitem>
1354           <indexterm><primary><option>-fwarn-unused-matches</option></primary></indexterm>
1355           <indexterm><primary>unused matches, warning</primary></indexterm>
1356           <indexterm><primary>matches, unused</primary></indexterm>
1357
1358           <para>Report all unused variables which arise from pattern
1359           matches, including patterns consisting of a single variable.
1360           For instance <literal>f x y = []</literal> would report
1361           <varname>x</varname> and <varname>y</varname> as unused.  The
1362           warning is suppressed if the variable name begins with an underscore, thus:
1363             <programlisting>
1364                f _x = True
1365             </programlisting>
1366           </para>
1367         </listitem>
1368       </varlistentry>
1369
1370       <varlistentry>
1371         <term><option>-fwarn-unused-do-bind</option>:</term>
1372         <listitem>
1373           <indexterm><primary><option>-fwarn-unused-do-bind</option></primary></indexterm>
1374           <indexterm><primary>unused do binding, warning</primary></indexterm>
1375           <indexterm><primary>do binding, unused</primary></indexterm>
1376
1377           <para>Report expressions occuring in <literal>do</literal> and <literal>mdo</literal> blocks
1378           that appear to silently throw information away.
1379           For instance <literal>do { mapM popInt xs ; return 10 }</literal> would report
1380           the first statement in the <literal>do</literal> block as suspicious,
1381           as it has the type <literal>StackM [Int]</literal> and not <literal>StackM ()</literal>, but that
1382           <literal>[Int]</literal> value is not bound to anything.  The warning is suppressed by
1383           explicitly mentioning in the source code that your program is throwing something away:
1384             <programlisting>
1385                do { _ &lt;- mapM popInt xs ; return 10 }
1386             </programlisting>
1387           Of course, in this particular situation you can do even better:
1388             <programlisting>
1389                do { mapM_ popInt xs ; return 10 }
1390             </programlisting>
1391           </para>
1392         </listitem>
1393       </varlistentry>
1394
1395       <varlistentry>
1396         <term><option>-fwarn-wrong-do-bind</option>:</term>
1397         <listitem>
1398           <indexterm><primary><option>-fwarn-wrong-do-bind</option></primary></indexterm>
1399           <indexterm><primary>apparently erroneous do binding, warning</primary></indexterm>
1400           <indexterm><primary>do binding, apparently erroneous</primary></indexterm>
1401
1402           <para>Report expressions occuring in <literal>do</literal> and <literal>mdo</literal> blocks
1403           that appear to lack a binding.
1404           For instance <literal>do { return (popInt 10) ; return 10 }</literal> would report
1405           the first statement in the <literal>do</literal> block as suspicious,
1406           as it has the type <literal>StackM (StackM Int)</literal> (which consists of two nested applications
1407           of the same monad constructor), but which is not then &quot;unpacked&quot; by binding the result.
1408           The warning is suppressed by explicitly mentioning in the source code that your program is throwing something away:
1409             <programlisting>
1410                do { _ &lt;- return (popInt 10) ; return 10 }
1411             </programlisting>
1412           For almost all sensible programs this will indicate a bug, and you probably intended to write:
1413             <programlisting>
1414                do { popInt 10 ; return 10 }
1415             </programlisting>
1416           </para>
1417         </listitem>
1418       </varlistentry>
1419
1420     </variablelist>
1421
1422     <para>If you're feeling really paranoid, the
1423     <option>-dcore-lint</option>
1424     option<indexterm><primary><option>-dcore-lint</option></primary></indexterm>
1425     is a good choice.  It turns on heavyweight intra-pass
1426     sanity-checking within GHC.  (It checks GHC's sanity, not
1427     yours.)</para>
1428
1429   </sect1>
1430
1431   &packages;
1432
1433   <sect1 id="options-optimise">
1434     <title>Optimisation (code improvement)</title>
1435
1436     <indexterm><primary>optimisation</primary></indexterm>
1437     <indexterm><primary>improvement, code</primary></indexterm>
1438
1439     <para>The <option>-O*</option> options specify convenient
1440     &ldquo;packages&rdquo; of optimisation flags; the
1441     <option>-f*</option> options described later on specify
1442     <emphasis>individual</emphasis> optimisations to be turned on/off;
1443     the <option>-m*</option> options specify
1444     <emphasis>machine-specific</emphasis> optimisations to be turned
1445     on/off.</para>
1446
1447     <sect2 id="optimise-pkgs">
1448       <title><option>-O*</option>: convenient &ldquo;packages&rdquo; of optimisation flags.</title>
1449
1450       <para>There are <emphasis>many</emphasis> options that affect
1451       the quality of code produced by GHC.  Most people only have a
1452       general goal, something like &ldquo;Compile quickly&rdquo; or
1453       &ldquo;Make my program run like greased lightning.&rdquo; The
1454       following &ldquo;packages&rdquo; of optimisations (or lack
1455       thereof) should suffice.</para>
1456
1457       <para>Note that higher optimisation levels cause more
1458       cross-module optimisation to be performed, which can have an
1459       impact on how much of your program needs to be recompiled when
1460       you change something.  This is one reason to stick to
1461       no-optimisation when developing code.</para>
1462
1463       <variablelist>
1464
1465         <varlistentry>
1466           <term>
1467             No <option>-O*</option>-type option specified:
1468             <indexterm><primary>-O* not specified</primary></indexterm>
1469           </term>
1470           <listitem>
1471             <para>This is taken to mean: &ldquo;Please compile
1472             quickly; I'm not over-bothered about compiled-code
1473             quality.&rdquo; So, for example: <command>ghc -c
1474             Foo.hs</command></para>
1475           </listitem>
1476         </varlistentry>
1477
1478         <varlistentry>
1479           <term>
1480             <option>-O0</option>:
1481             <indexterm><primary><option>-O0</option></primary></indexterm>
1482           </term>
1483           <listitem>
1484             <para>Means &ldquo;turn off all optimisation&rdquo;,
1485             reverting to the same settings as if no
1486             <option>-O</option> options had been specified.  Saying
1487             <option>-O0</option> can be useful if
1488             eg. <command>make</command> has inserted a
1489             <option>-O</option> on the command line already.</para>
1490           </listitem>
1491         </varlistentry>
1492
1493         <varlistentry>
1494           <term>
1495             <option>-O</option> or <option>-O1</option>:
1496             <indexterm><primary>-O option</primary></indexterm>
1497             <indexterm><primary>-O1 option</primary></indexterm>
1498             <indexterm><primary>optimise</primary><secondary>normally</secondary></indexterm>
1499           </term>
1500           <listitem>
1501             <para>Means: &ldquo;Generate good-quality code without
1502             taking too long about it.&rdquo; Thus, for example:
1503             <command>ghc -c -O Main.lhs</command></para>
1504           </listitem>
1505         </varlistentry>
1506
1507         <varlistentry>
1508           <term>
1509             <option>-O2</option>:
1510             <indexterm><primary>-O2 option</primary></indexterm>
1511             <indexterm><primary>optimise</primary><secondary>aggressively</secondary></indexterm>
1512           </term>
1513           <listitem>
1514             <para>Means: &ldquo;Apply every non-dangerous
1515             optimisation, even if it means significantly longer
1516             compile times.&rdquo;</para>
1517
1518             <para>The avoided &ldquo;dangerous&rdquo; optimisations
1519             are those that can make runtime or space
1520             <emphasis>worse</emphasis> if you're unlucky.  They are
1521             normally turned on or off individually.</para>
1522
1523             <para>At the moment, <option>-O2</option> is
1524             <emphasis>unlikely</emphasis> to produce better code than
1525             <option>-O</option>.</para>
1526           </listitem>
1527         </varlistentry>
1528
1529         <varlistentry>
1530           <term>
1531             <option>-Ofile &lt;file&gt;</option>:
1532             <indexterm><primary>-Ofile &lt;file&gt; option</primary></indexterm>
1533             <indexterm><primary>optimising, customised</primary></indexterm>
1534           </term>
1535           <listitem>
1536             <para>(NOTE: not supported since GHC 4.x.  Please ask if
1537             you're interested in this.)</para>
1538
1539             <para>For those who need <emphasis>absolute</emphasis>
1540             control over <emphasis>exactly</emphasis> what options are
1541             used (e.g., compiler writers, sometimes :-), a list of
1542             options can be put in a file and then slurped in with
1543             <option>-Ofile</option>.</para>
1544
1545             <para>In that file, comments are of the
1546             <literal>&num;</literal>-to-end-of-line variety; blank
1547             lines and most whitespace is ignored.</para>
1548
1549             <para>Please ask if you are baffled and would like an
1550             example of <option>-Ofile</option>!</para>
1551           </listitem>
1552         </varlistentry>
1553       </variablelist>
1554
1555       <para>We don't use a <option>-O*</option> flag for day-to-day
1556       work.  We use <option>-O</option> to get respectable speed;
1557       e.g., when we want to measure something.  When we want to go for
1558       broke, we tend to use <option>-O2 -fvia-C</option> (and we go for
1559       lots of coffee breaks).</para>
1560
1561       <para>The easiest way to see what <option>-O</option> (etc.)
1562       &ldquo;really mean&rdquo; is to run with <option>-v</option>,
1563       then stand back in amazement.</para>
1564     </sect2>
1565
1566     <sect2 id="options-f">
1567       <title><option>-f*</option>: platform-independent flags</title>
1568
1569       <indexterm><primary>-f* options (GHC)</primary></indexterm>
1570       <indexterm><primary>-fno-* options (GHC)</primary></indexterm>
1571
1572       <para>These flags turn on and off individual optimisations.
1573       They are normally set via the <option>-O</option> options
1574       described above, and as such, you shouldn't need to set any of
1575       them explicitly (indeed, doing so could lead to unexpected
1576       results).  However, there are one or two that may be of
1577       interest:</para>
1578
1579       <variablelist>
1580         <varlistentry>
1581           <term><option>-fexcess-precision</option>:</term>
1582           <listitem>
1583             <indexterm><primary><option>-fexcess-precision</option></primary></indexterm>
1584             <para>When this option is given, intermediate floating
1585             point values can have a <emphasis>greater</emphasis>
1586             precision/range than the final type.  Generally this is a
1587             good thing, but some programs may rely on the exact
1588             precision/range of
1589             <literal>Float</literal>/<literal>Double</literal> values
1590             and should not use this option for their compilation.</para>
1591           </listitem>
1592         </varlistentry>
1593
1594         <varlistentry>
1595           <term><option>-fignore-asserts</option>:</term>
1596           <listitem>
1597             <indexterm><primary><option>-fignore-asserts</option></primary></indexterm>
1598             <para>Causes GHC to ignore uses of the function
1599             <literal>Exception.assert</literal> in source code (in
1600             other words, rewriting <literal>Exception.assert p
1601             e</literal> to <literal>e</literal> (see <xref
1602             linkend="assertions"/>).  This flag is turned on by
1603             <option>-O</option>.
1604             </para>
1605           </listitem>
1606         </varlistentry>
1607
1608         <varlistentry>
1609           <term>
1610             <option>-fno-cse</option>
1611             <indexterm><primary><option>-fno-cse</option></primary></indexterm>
1612           </term>
1613           <listitem>
1614             <para>Turns off the common-sub-expression elimination optimisation.
1615               Can be useful if you have some <literal>unsafePerformIO</literal>
1616             expressions that you don't want commoned-up.</para>
1617           </listitem>
1618         </varlistentry>
1619
1620         <varlistentry>
1621           <term>
1622             <option>-fno-strictness</option>
1623             <indexterm><primary><option>-fno-strictness</option></primary></indexterm>
1624           </term>
1625           <listitem>
1626             <para>Turns off the strictness analyser; sometimes it eats
1627             too many cycles.</para>
1628           </listitem>
1629         </varlistentry>
1630
1631         <varlistentry>
1632           <term>
1633             <option>-fno-full-laziness</option>
1634             <indexterm><primary><option>-fno-full-laziness</option></primary></indexterm>
1635           </term>
1636           <listitem>
1637             <para>Turns off the full laziness optimisation (also known as
1638               let-floating).  Full laziness increases sharing, which can lead
1639               to increased memory residency.</para>
1640
1641             <para>NOTE: GHC doesn't implement complete full-laziness.
1642             When optimisation in on, and
1643             <option>-fno-full-laziness</option> is not given, some
1644             transformations that increase sharing are performed, such
1645             as extracting repeated computations from a loop.  These
1646             are the same transformations that a fully lazy
1647             implementation would do, the difference is that GHC
1648             doesn't consistently apply full-laziness, so don't rely on
1649             it.</para>
1650           </listitem>
1651         </varlistentry>
1652
1653         <varlistentry>
1654           <term>
1655             <option>-fspec-constr</option>
1656             <indexterm><primary><option>-fspec-constr</option></primary></indexterm>
1657           </term>
1658           <listitem>
1659             <para>Turn on call-pattern specialisation.</para>
1660           </listitem>
1661         </varlistentry>
1662
1663         <varlistentry>
1664           <term>
1665             <option>-fliberate-case</option>
1666             <indexterm><primary><option>-fliberate-case</option></primary></indexterm>
1667           </term>
1668           <listitem>
1669             <para>Turn on the liberate-case transformation.</para>
1670           </listitem>
1671         </varlistentry>
1672
1673         <varlistentry>
1674           <term>
1675             <option>-fstatic-argument-transformation</option>
1676             <indexterm><primary><option>-fstatic-argument-transformation</option></primary></indexterm>
1677           </term>
1678           <listitem>
1679             <para>Turn on the static argument transformation.</para>
1680           </listitem>
1681         </varlistentry>
1682
1683         <varlistentry>
1684           <term>
1685             <option>-fno-state-hack</option>
1686             <indexterm><primary><option>-fno-state-hack</option></primary></indexterm>
1687           </term>
1688           <listitem>
1689             <para>Turn off the "state hack" whereby any lambda with a
1690               <literal>State#</literal> token as argument is considered to be
1691               single-entry, hence it is considered OK to inline things inside
1692               it.  This can improve performance of IO and ST monad code, but it
1693             runs the risk of reducing sharing.</para>
1694           </listitem>
1695         </varlistentry>
1696
1697         <varlistentry>
1698           <term>
1699             <option>-fomit-interface-pragmas</option>
1700             <indexterm><primary><option>-fomit-interface-pragmas</option></primary></indexterm>
1701           </term>
1702           <listitem>
1703             <para>Tells GHC to omit all inessential information from the interface file
1704               generated for the module being compiled (say M).  This means that a module
1705               importing M will see only the <emphasis>types</emphasis> of the functions that M exports, but not
1706               their unfoldings, strictness info, etc.  Hence, for example,
1707               no function exported by M will be inlined
1708               into an importing module.  The benefit is that modules that import M will
1709               need to be recompiled less often (only when M's exports change their type,
1710               not when they change their implementation).
1711               </para>
1712           </listitem>
1713         </varlistentry>
1714
1715         <varlistentry>
1716           <term>
1717             <option>-fignore-interface-pragmas</option>
1718             <indexterm><primary><option>-fignore-interface-pragmas</option></primary></indexterm>
1719           </term>
1720           <listitem>
1721             <para>Tells GHC to ignore all inessential information when reading interface files.
1722             That is, even if <filename>M.hi</filename> contains unfolding or strictness information
1723             for a function, GHC will ignore that information.</para>
1724           </listitem>
1725         </varlistentry>
1726
1727         <varlistentry>
1728           <term>
1729             <option>-funbox-strict-fields</option>:
1730             <indexterm><primary><option>-funbox-strict-fields</option></primary></indexterm>
1731             <indexterm><primary>strict constructor fields</primary></indexterm>
1732             <indexterm><primary>constructor fields, strict</primary></indexterm>
1733           </term>
1734           <listitem>
1735             <para>This option causes all constructor fields which are
1736             marked strict (i.e. &ldquo;!&rdquo;) to be unboxed or
1737             unpacked if possible.  It is equivalent to adding an
1738             <literal>UNPACK</literal> pragma to every strict
1739             constructor field (see <xref
1740             linkend="unpack-pragma"/>).</para>
1741
1742             <para>This option is a bit of a sledgehammer: it might
1743             sometimes make things worse.  Selectively unboxing fields
1744             by using <literal>UNPACK</literal> pragmas might be
1745             better.</para>
1746           </listitem>
1747         </varlistentry>
1748
1749         <varlistentry>
1750           <term>
1751             <option>-funfolding-creation-threshold=<replaceable>n</replaceable></option>:
1752             <indexterm><primary><option>-funfolding-creation-threshold</option></primary></indexterm>
1753             <indexterm><primary>inlining, controlling</primary></indexterm>
1754             <indexterm><primary>unfolding, controlling</primary></indexterm>
1755           </term>
1756           <listitem>
1757             <para>(Default: 45) Governs the maximum size that GHC will
1758             allow a function unfolding to be.   (An unfolding has a
1759             &ldquo;size&rdquo; that reflects the cost in terms of
1760             &ldquo;code bloat&rdquo; of expanding that unfolding at
1761             at a call site. A bigger function would be assigned a
1762             bigger cost.) </para>
1763
1764             <para> Consequences: (a) nothing larger than this will be
1765             inlined (unless it has an INLINE pragma); (b) nothing
1766             larger than this will be spewed into an interface
1767             file. </para>
1768
1769
1770             <para> Increasing this figure is more likely to result in longer
1771             compile times than faster code.  The next option is more
1772             useful:</para>
1773           </listitem>
1774         </varlistentry>
1775
1776         <varlistentry>
1777           <term><option>-funfolding-use-threshold=<replaceable>n</replaceable></option></term>
1778           <listitem>
1779             <indexterm><primary><option>-funfolding-use-threshold</option></primary></indexterm>
1780             <indexterm><primary>inlining, controlling</primary></indexterm>
1781             <indexterm><primary>unfolding, controlling</primary></indexterm>
1782
1783             <para>(Default: 8) This is the magic cut-off figure for
1784             unfolding: below this size, a function definition will be
1785             unfolded at the call-site, any bigger and it won't.  The
1786             size computed for a function depends on two things: the
1787             actual size of the expression minus any discounts that
1788             apply (see <option>-funfolding-con-discount</option>).</para>
1789           </listitem>
1790         </varlistentry>
1791       </variablelist>
1792
1793     </sect2>
1794
1795   </sect1>
1796
1797   &phases;
1798
1799   <sect1 id="using-concurrent">
1800     <title>Using Concurrent Haskell</title>
1801     <indexterm><primary>Concurrent Haskell</primary><secondary>using</secondary></indexterm>
1802
1803     <para>GHC supports Concurrent Haskell by default, without requiring a
1804       special option or libraries compiled in a certain way.  To get access to
1805       the support libraries for Concurrent Haskell, just import
1806       <ulink
1807         url="../libraries/base/Control-Concurrent.html"><literal>Control.Concurrent</literal></ulink>.  More information on Concurrent Haskell is provided in the documentation for that module.</para>
1808
1809     <para>The following RTS option(s) affect the behaviour of Concurrent
1810       Haskell programs:<indexterm><primary>RTS options, concurrent</primary></indexterm></para>
1811
1812     <variablelist>
1813       <varlistentry>
1814         <term><option>-C<replaceable>s</replaceable></option></term>
1815         <listitem>
1816           <para><indexterm><primary><option>-C<replaceable>s</replaceable></option></primary><secondary>RTS option</secondary></indexterm>
1817             Sets the context switch interval to <replaceable>s</replaceable>
1818             seconds.  A context switch will occur at the next heap block
1819             allocation after the timer expires (a heap block allocation occurs
1820             every 4k of allocation).  With <option>-C0</option> or
1821             <option>-C</option>, context switches will occur as often as
1822             possible (at every heap block allocation).  By default, context
1823             switches occur every 20ms.</para>
1824         </listitem>
1825       </varlistentry>
1826     </variablelist>
1827   </sect1>
1828
1829   <sect1 id="using-smp">
1830     <title>Using SMP parallelism</title>
1831     <indexterm><primary>parallelism</primary>
1832     </indexterm>
1833     <indexterm><primary>SMP</primary>
1834     </indexterm>
1835
1836     <para>GHC supports running Haskell programs in parallel on an SMP
1837       (symmetric multiprocessor).</para>
1838
1839     <para>There's a fine distinction between
1840       <emphasis>concurrency</emphasis> and <emphasis>parallelism</emphasis>:
1841       parallelism is all about making your program run
1842       <emphasis>faster</emphasis> by making use of multiple processors
1843       simultaneously.  Concurrency, on the other hand, is a means of
1844       abstraction: it is a convenient way to structure a program that must
1845       respond to multiple asynchronous events.</para>
1846
1847     <para>However, the two terms are certainly related.  By making use of
1848       multiple CPUs it is possible to run concurrent threads in parallel,
1849       and this is exactly what GHC's SMP parallelism support does.  But it
1850       is also possible to obtain performance improvements with parallelism
1851       on programs that do not use concurrency.  This section describes how to
1852       use GHC to compile and run parallel programs, in <xref
1853         linkend="lang-parallel" /> we describe the language features that affect
1854     parallelism.</para>
1855
1856     <sect2 id="parallel-compile-options">
1857       <title>Compile-time options for SMP parallelism</title>
1858
1859       <para>In order to make use of multiple CPUs, your program must be
1860         linked with the <option>-threaded</option> option (see <xref
1861           linkend="options-linker" />).  Additionally, the following
1862         compiler options affect parallelism:</para>
1863
1864       <variablelist>
1865         <varlistentry>
1866           <term><option>-feager-blackholing</option></term>
1867           <indexterm><primary><option>-feager-blackholing</option></primary></indexterm>
1868           <listitem>
1869           <para>
1870             Blackholing is the act of marking a thunk (lazy
1871             computuation) as being under evaluation.  It is useful for
1872             three reasons: firstly it lets us detect certain kinds of
1873             infinite loop (the <literal>NonTermination</literal>
1874             exception), secondly it avoids certain kinds of space
1875             leak, and thirdly it avoids repeating a computation in a
1876             parallel program, because we can tell when a computation
1877             is already in progress.</para>
1878
1879           <para>
1880             The option <option>-feager-blackholing</option> causes
1881             each thunk to be blackholed as soon as evaluation begins.
1882             The default is "lazy blackholing", whereby thunks are only
1883             marked as being under evaluation when a thread is paused
1884             for some reason.  Lazy blackholing is typically more
1885             efficient (by 1-2&percnt; or so), because most thunks don't
1886             need to be blackholed.  However, eager blackholing can
1887             avoid more repeated computation in a parallel program, and
1888             this often turns out to be important for parallelism.
1889           </para>
1890
1891           <para>
1892             We recommend compiling any code that is intended to be run
1893             in parallel with the <option>-feager-blackholing</option>
1894             flag.
1895           </para>
1896           </listitem>
1897         </varlistentry>
1898       </variablelist>
1899     </sect2>
1900
1901     <sect2 id="parallel-options">
1902       <title>RTS options for SMP parallelism</title>
1903
1904       <para>To run a program on multiple CPUs, use the
1905         RTS <option>-N</option> option:</para>
1906
1907       <variablelist>
1908         <varlistentry>
1909           <term><option>-N<optional><replaceable>x</replaceable></optional></option></term>
1910           <listitem>
1911             <para><indexterm><primary><option>-N<replaceable>x</replaceable></option></primary><secondary>RTS option</secondary></indexterm>
1912               Use <replaceable>x</replaceable> simultaneous threads when
1913               running the program.  Normally <replaceable>x</replaceable>
1914               should be chosen to match the number of CPU cores on the
1915               machine<footnote><para>Whether hyperthreading cores should be counted or not is an
1916               open question; please feel free to experiment and let us know what
1917                   results you find.</para></footnote>.  For example,
1918               on a dual-core machine we would probably use
1919               <literal>+RTS -N2 -RTS</literal>.</para>
1920
1921             <para>Omitting <replaceable>x</replaceable>,
1922               i.e. <literal>+RTS -N -RTS</literal>, lets the runtime
1923               choose the value of <replaceable>x</replaceable> itself
1924               based on how many processors are in your machine.</para>
1925
1926             <para>Be careful when using all the processors in your
1927               machine: if some of your processors are in use by other
1928               programs, this can actually harm performance rather than
1929               improve it.</para>
1930
1931             <para>Setting <option>-N</option> also has the effect of
1932               enabling the parallel garbage collector (see
1933               <xref linkend="rts-options-gc" />).</para>
1934
1935             <para>There is no means (currently) by which this value
1936               may vary after the program has started.</para>
1937           </listitem>
1938         </varlistentry>
1939       </variablelist>
1940
1941       <para>The following options affect the way the runtime schedules
1942       threads on CPUs:</para>
1943
1944       <variablelist>
1945         <varlistentry>
1946           <term><option>-qm</option></term>
1947           <indexterm><primary><option>-qm</option></primary><secondary>RTS
1948           option</secondary></indexterm>
1949           <listitem>
1950             <para>Disable automatic migration for load balancing.
1951             Normally the runtime will automatically try to schedule
1952             threads across the available CPUs to make use of idle
1953             CPUs; this option disables that behaviour.  It is probably
1954             only of use if you are explicitly scheduling threads onto
1955             CPUs with <literal>GHC.Conc.forkOnIO</literal>.</para>
1956           </listitem>
1957         </varlistentry>
1958         <varlistentry>
1959           <term><option>-qw</option></term>
1960           <indexterm><primary><option>-qw</option></primary><secondary>RTS
1961           option</secondary></indexterm>
1962           <listitem>
1963             <para>Migrate a thread to the current CPU when it is woken
1964             up.  Normally when a thread is woken up after being
1965             blocked it will be scheduled on the CPU it was running on
1966             last; this option allows the thread to immediately migrate
1967             to the CPU that unblocked it.</para>
1968
1969             <para>The rationale for allowing this eager migration is
1970             that it tends to move threads that are communicating with
1971             each other onto the same CPU; however there are
1972             pathalogical situations where it turns out to be a poor
1973             strategy.  Depending on the communication pattern in your
1974             program, it may or may not be a good idea.</para>
1975           </listitem>
1976         </varlistentry>
1977        </variablelist>
1978     </sect2>
1979
1980     <sect2>
1981       <title>Hints for using SMP parallelism</title>
1982
1983       <para>Add the <literal>-s</literal> RTS option when
1984         running the program to see timing stats, which will help to tell you
1985         whether your program got faster by using more CPUs or not.  If the user
1986         time is greater than
1987         the elapsed time, then the program used more than one CPU.  You should
1988         also run the program without <literal>-N</literal> for comparison.</para>
1989
1990       <para>GHC's parallelism support is new and experimental.  It may make your
1991         program go faster, or it might slow it down - either way, we'd be
1992         interested to hear from you.</para>
1993
1994       <para>One significant limitation with the current implementation is that
1995         the garbage collector is still single-threaded, and all execution must
1996         stop when GC takes place.  This can be a significant bottleneck in a
1997         parallel program, especially if your program does a lot of GC.  If this
1998         happens to you, then try reducing the cost of GC by tweaking the GC
1999         settings (<xref linkend="rts-options-gc" />): enlarging the heap or the
2000         allocation area size is a good start.</para>
2001     </sect2>
2002   </sect1>
2003
2004   <sect1 id="options-platform">
2005     <title>Platform-specific Flags</title>
2006
2007     <indexterm><primary>-m* options</primary></indexterm>
2008     <indexterm><primary>platform-specific options</primary></indexterm>
2009     <indexterm><primary>machine-specific options</primary></indexterm>
2010
2011     <para>Some flags only make sense for particular target
2012     platforms.</para>
2013
2014     <variablelist>
2015
2016       <varlistentry>
2017         <term><option>-monly-[32]-regs</option>:</term>
2018         <listitem>
2019           <para>(iX86 machines)<indexterm><primary>-monly-N-regs
2020           option (iX86 only)</primary></indexterm> GHC tries to
2021           &ldquo;steal&rdquo; four registers from GCC, for performance
2022           reasons; it almost always works.  However, when GCC is
2023           compiling some modules with four stolen registers, it will
2024           crash, probably saying:
2025
2026 <screen>
2027 Foo.hc:533: fixed or forbidden register was spilled.
2028 This may be due to a compiler bug or to impossible asm
2029 statements or clauses.
2030 </screen>
2031
2032           Just give some registers back with
2033           <option>-monly-N-regs</option>.  Try `3' first, then `2'.
2034           If `2' doesn't work, please report the bug to us.</para>
2035         </listitem>
2036       </varlistentry>
2037     </variablelist>
2038
2039   </sect1>
2040
2041 &runtime;
2042
2043 <sect1 id="ext-core">
2044   <title>Generating and compiling External Core Files</title>
2045
2046   <indexterm><primary>intermediate code generation</primary></indexterm>
2047
2048   <para>GHC can dump its optimized intermediate code (said to be in &ldquo;Core&rdquo; format)
2049   to a file as a side-effect of compilation. Non-GHC back-end tools can read and process Core files; these files have the suffix
2050   <filename>.hcr</filename>. The Core format is described in <ulink url="../ext-core/core.pdf">
2051   <citetitle>An External Representation for the GHC Core Language</citetitle></ulink>,
2052   and sample tools
2053   for manipulating Core files (in Haskell) are in the GHC source distribution
2054   directory under <literal>utils/ext-core</literal>.
2055   Note that the format of <literal>.hcr</literal>
2056   files is <emphasis>different</emphasis> from the Core output format that GHC generates
2057   for debugging purposes (<xref linkend="options-debugging"/>), though the two formats appear somewhat similar.</para>
2058
2059   <para>The Core format natively supports notes which you can add to
2060   your source code using the <literal>CORE</literal> pragma (see <xref
2061   linkend="pragmas"/>).</para>
2062
2063     <variablelist>
2064
2065         <varlistentry>
2066           <term>
2067             <option>-fext-core</option>
2068             <indexterm><primary><option>-fext-core</option></primary></indexterm>
2069           </term>
2070           <listitem>
2071             <para>Generate <literal>.hcr</literal> files.</para>
2072           </listitem>
2073         </varlistentry>
2074
2075     </variablelist>
2076
2077 <para>Currently (as of version 6.8.2), GHC does not have the ability to read in External Core files as source. If you would like GHC to have this ability, please <ulink url="http://hackage.haskell.org/trac/ghc/wiki/MailingListsAndIRC">make your wishes known to the GHC Team</ulink>.</para>
2078
2079 </sect1>
2080
2081 &debug;
2082 &flags;
2083
2084 </chapter>
2085
2086 <!-- Emacs stuff:
2087      ;;; Local Variables: ***
2088      ;;; mode: xml ***
2089      ;;; sgml-parent-document: ("users_guide.xml" "book" "chapter") ***
2090      ;;; End: ***
2091  -->