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-exports</option>,
 864           <option>-fwarn-dodgy-imports</option>,
 865           <option>-fwarn-unused-matches</option>,
 866           <option>-fwarn-unused-imports</option>, and
 867           <option>-fwarn-unused-binds</option>.</para>
 868         </listitem>
 869       </varlistentry>
 870
 871       <varlistentry>
 872         <term><option>-Wall</option>:</term>
 873         <listitem>
 874           <indexterm><primary><option>-Wall</option></primary></indexterm>
 875           <para>Turns on all warning options that indicate potentially
 876           suspicious code.  The warnings that are
 877           <emphasis>not</emphasis> enabled by <option>-Wall</option>
 878           are
 879             <option>-fwarn-simple-patterns</option>,
 880             <option>-fwarn-tabs</option>,
 881             <option>-fwarn-incomplete-record-updates</option>,
 882             <option>-fwarn-monomorphism-restriction</option>,
 883             <option>-fwarn-unused-do-bind</option>, and
 884             <option>-fwarn-implicit-prelude</option>.</para>
 885         </listitem>
 886       </varlistentry>
 887
 888       <varlistentry>
 889         <term><option>-w</option>:</term>
 890         <listitem>
 891           <indexterm><primary><option>-w</option></primary></indexterm>
 892           <para>Turns off all warnings, including the standard ones and
 893       those that <literal>-Wall</literal> doesn't enable.</para>
 894         </listitem>
 895       </varlistentry>
 896
 897       <varlistentry>
 898         <term><option>-Werror</option>:</term>
 899         <listitem>
 900           <indexterm><primary><option>-Werror</option></primary></indexterm>
 901           <para>Makes any warning into a fatal error. Useful so that you don't
 902             miss warnings when doing batch compilation. </para>
 903         </listitem>
 904       </varlistentry>
 905
 906       <varlistentry>
 907         <term><option>-Wwarn</option>:</term>
 908         <listitem>
 909           <indexterm><primary><option>-Wwarn</option></primary></indexterm>
 910           <para>Warnings are treated only as warnings, not as errors. This is
 911             the default, but can be useful to negate a
 912         <option>-Werror</option> flag.</para>
 913         </listitem>
 914       </varlistentry>
 915
 916     </variablelist>
 917
 918     <para>The full set of warning options is described below.  To turn
 919     off any warning, simply give the corresponding
 920     <option>-fno-warn-...</option> option on the command line.</para>
 921
 922     <variablelist>
 923
 924       <varlistentry>
 925         <term><option>-fwarn-unrecognised-pragmas</option>:</term>
 926         <listitem>
 927           <indexterm><primary><option>-fwarn-unrecognised-pragmas</option></primary>
 928           </indexterm>
 929           <indexterm><primary>warnings</primary></indexterm>
 930           <indexterm><primary>pragmas</primary></indexterm>
 931           <para>Causes a warning to be emitted when a
 932           pragma that GHC doesn't recognise is used. As well as pragmas
 933       that GHC itself uses, GHC also recognises pragmas known to be used
 934       by other tools, e.g. <literal>OPTIONS_HUGS</literal> and
 935       <literal>DERIVE</literal>.</para>
 936
 937           <para>This option is on by default.</para>
 938         </listitem>
 939       </varlistentry>
 940
 941       <varlistentry>
 942         <term><option>-fwarn-warnings-deprecations</option>:</term>
 943         <listitem>
 944           <indexterm><primary><option>-fwarn-warnings-deprecations</option></primary>
 945           </indexterm>
 946           <indexterm><primary>warnings</primary></indexterm>
 947           <indexterm><primary>deprecations</primary></indexterm>
 948           <para>Causes a warning to be emitted when a
 949           module, function or type with a WARNING or DEPRECATED pragma
 950       is used. See <xref linkend="warning-deprecated-pragma"/> for more
 951       details on the pragmas.</para>
 952
 953           <para>This option is on by default.</para>
 954         </listitem>
 955       </varlistentry>
 956
 957       <varlistentry>
 958         <term><option>-fwarn-deprecated-flags</option>:</term>
 959         <listitem>
 960           <indexterm><primary><option>-fwarn-deprecated-flags</option></primary>
 961           </indexterm>
 962           <indexterm><primary>deprecated-flags</primary></indexterm>
 963           <para>Causes a warning to be emitted when a deprecated
 964           commandline flag is used.</para>
 965
 966           <para>This option is on by default.</para>
 967         </listitem>
 968       </varlistentry>
 969
 970       <varlistentry>
 971         <term><option>-fwarn-dodgy-foreign-imports</option>:</term>
 972         <listitem>
 973           <indexterm><primary><option>-fwarn-dodgy-foreign-imports</option></primary>
 974           </indexterm>
 975           <para>Causes a warning to be emitted for foreign imports of
 976           the following form:</para>
 977 <programlisting>
 978 foreign import "f" f :: FunPtr t
 979 </programlisting>
 980           <para>on the grounds that it probably should be</para>
 981 <programlisting>
 982 foreign import "&amp;f" f :: FunPtr t
 983 </programlisting>
 984           <para>The first form declares that `f` is a (pure) C
 985           function that takes no arguments and returns a pointer to a
 986           C function with type `t`, whereas the second form declares
 987           that `f` itself is a C function with type `t`.  The first
 988           declaration is usually a mistake, and one that is hard to
 989           debug because it results in a crash, hence this
 990           warning.</para>
 991         </listitem>
 992       </varlistentry>
 993
 994       <varlistentry>
 995         <term><option>-fwarn-dodgy-exports</option>:</term>
 996         <listitem>
 997           <indexterm><primary><option>-fwarn-dodgy-exports</option></primary>
 998           </indexterm>
 999           <para>Causes a warning to be emitted when a datatype
1000       <literal>T</literal> is exported
1001       with all constructors, i.e. <literal>T(..)</literal>, but is it
1002       just a type synonym.</para>
1003           <para>Also causes a warning to be emitted when a module is
1004       re-exported, but that module exports nothing.</para>
1005         </listitem>
1006       </varlistentry>
1007
1008       <varlistentry>
1009         <term><option>-fwarn-dodgy-imports</option>:</term>
1010         <listitem>
1011           <indexterm><primary><option>-fwarn-dodgy-imports</option></primary>
1012           </indexterm>
1013           <para>Causes a warning to be emitted when a datatype
1014       <literal>T</literal> is imported
1015       with all constructors, i.e. <literal>T(..)</literal>, but has been
1016       exported abstractly, i.e. <literal>T</literal>.</para>
1017         </listitem>
1018       </varlistentry>
1019
1020       <varlistentry>
1021         <term><option>-fwarn-lazy-unlifted-bindings</option>:</term>
1022         <listitem>
1023           <indexterm><primary><option>-fwarn-lazy-unlifted-bindings</option></primary>
1024           </indexterm>
1025           <para>Causes a warning to be emitted when an unlifted type
1026       is bound in a way that looks lazy, e.g.
1027       <literal>where (I# x) = ...</literal>. Use
1028       <literal>where !(I# x) = ...</literal> instead. This will be an
1029       error, rather than a warning, in GHC 6.14.
1030       </para>
1031         </listitem>
1032       </varlistentry>
1033
1034       <varlistentry>
1035         <term><option>-fwarn-duplicate-exports</option>:</term>
1036         <listitem>
1037           <indexterm><primary><option>-fwarn-duplicate-exports</option></primary></indexterm>
1038           <indexterm><primary>duplicate exports, warning</primary></indexterm>
1039           <indexterm><primary>export lists, duplicates</primary></indexterm>
1040
1041           <para>Have the compiler warn about duplicate entries in
1042           export lists. This is useful information if you maintain
1043           large export lists, and want to avoid the continued export
1044           of a definition after you've deleted (one) mention of it in
1045           the export list.</para>
1046
1047           <para>This option is on by default.</para>
1048         </listitem>
1049       </varlistentry>
1050
1051       <varlistentry>
1052         <term><option>-fwarn-hi-shadowing</option>:</term>
1053         <listitem>
1054           <indexterm><primary><option>-fwarn-hi-shadowing</option></primary></indexterm>
1055           <indexterm><primary>shadowing</primary>
1056             <secondary>interface files</secondary></indexterm>
1057
1058           <para>Causes the compiler to emit a warning when a module or
1059           interface file in the current directory is shadowing one
1060           with the same module name in a library or other
1061           directory.</para>
1062         </listitem>
1063       </varlistentry>
1064
1065       <varlistentry>
1066         <term><option>-fwarn-implicit-prelude</option>:</term>
1067         <listitem>
1068           <indexterm><primary><option>-fwarn-implicit-prelude</option></primary></indexterm>
1069           <indexterm><primary>implicit prelude, warning</primary></indexterm>
1070           <para>Have the compiler warn if the Prelude is implicitly
1071           imported.  This happens unless either the Prelude module is
1072           explicitly imported with an <literal>import ... Prelude ...</literal>
1073           line, or this implicit import is disabled (either by
1074           <option>-XNoImplicitPrelude</option> or a
1075           <literal>LANGUAGE NoImplicitPrelude</literal> pragma).</para>
1076
1077           <para>Note that no warning is given for syntax that implicitly
1078           refers to the Prelude, even if <option>-XNoImplicitPrelude</option>
1079           would change whether it refers to the Prelude.
1080           For example, no warning is given when
1081           <literal>368</literal> means
1082           <literal>Prelude.fromInteger (368::Prelude.Integer)</literal>
1083           (where <literal>Prelude</literal> refers to the actual Prelude module,
1084           regardless of the imports of the module being compiled).</para>
1085
1086           <para>This warning is off by default.</para>
1087         </listitem>
1088       </varlistentry>
1089
1090       <varlistentry>
1091         <term><option>-fwarn-incomplete-patterns</option>:</term>
1092         <listitem>
1093           <indexterm><primary><option>-fwarn-incomplete-patterns</option></primary></indexterm>
1094           <indexterm><primary>incomplete patterns, warning</primary></indexterm>
1095           <indexterm><primary>patterns, incomplete</primary></indexterm>
1096
1097           <para>Similarly for incomplete patterns, the function
1098           <function>g</function> below will fail when applied to
1099           non-empty lists, so the compiler will emit a warning about
1100           this when <option>-fwarn-incomplete-patterns</option> is
1101           enabled.</para>
1102
1103 <programlisting>
1104 g [] = 2
1105 </programlisting>
1106
1107           <para>This option isn't enabled by default because it can be
1108           a bit noisy, and it doesn't always indicate a bug in the
1109           program.  However, it's generally considered good practice
1110           to cover all the cases in your functions.</para>
1111         </listitem>
1112       </varlistentry>
1113
1114       <varlistentry>
1115         <term><option>-fwarn-incomplete-record-updates</option>:</term>
1116         <listitem>
1117           <indexterm><primary><option>-fwarn-incomplete-record-updates</option></primary></indexterm>
1118           <indexterm><primary>incomplete record updates, warning</primary></indexterm>
1119           <indexterm><primary>record updates, incomplete</primary></indexterm>
1120
1121           <para>The function
1122           <function>f</function> below will fail when applied to
1123           <literal>Bar</literal>, so the compiler will emit a warning about
1124           this when <option>-fwarn-incomplete-record-updates</option> is
1125           enabled.</para>
1126
1127 <programlisting>
1128 data Foo = Foo { x :: Int }
1129          | Bar
1130
1131 f :: Foo -> Foo
1132 f foo = foo { x = 6 }
1133 </programlisting>
1134
1135           <para>This option isn't enabled by default because it can be
1136           very noisy, and it often doesn't indicate a bug in the
1137           program.</para>
1138         </listitem>
1139       </varlistentry>
1140
1141       <varlistentry>
1142         <term>
1143           <option>-fwarn-missing-fields</option>:
1144           <indexterm><primary><option>-fwarn-missing-fields</option></primary></indexterm>
1145           <indexterm><primary>missing fields, warning</primary></indexterm>
1146           <indexterm><primary>fields, missing</primary></indexterm>
1147         </term>
1148         <listitem>
1149
1150           <para>This option is on by default, and warns you whenever
1151           the construction of a labelled field constructor isn't
1152           complete, missing initializers for one or more fields. While
1153           not an error (the missing fields are initialised with
1154           bottoms), it is often an indication of a programmer error.</para>
1155         </listitem>
1156       </varlistentry>
1157
1158       <varlistentry>
1159         <term><option>-fwarn-missing-methods</option>:</term>
1160         <listitem>
1161           <indexterm><primary><option>-fwarn-missing-methods</option></primary></indexterm>
1162           <indexterm><primary>missing methods, warning</primary></indexterm>
1163           <indexterm><primary>methods, missing</primary></indexterm>
1164
1165           <para>This option is on by default, and warns you whenever
1166           an instance declaration is missing one or more methods, and
1167           the corresponding class declaration has no default
1168           declaration for them.</para>
1169           <para>The warning is suppressed if the method name
1170           begins with an underscore.  Here's an example where this is useful:
1171             <programlisting>
1172               class C a where
1173                 _simpleFn :: a -> String
1174                 complexFn :: a -> a -> String
1175                 complexFn x y = ... _simpleFn ...
1176               </programlisting>
1177             The idea is that: (a) users of the class will only call <literal>complexFn</literal>;
1178             never <literal>_simpleFn</literal>; and (b)
1179             instance declarations can define either <literal>complexFn</literal> or <literal>_simpleFn</literal>.
1180             </para>
1181         </listitem>
1182       </varlistentry>
1183
1184       <varlistentry>
1185         <term><option>-fwarn-missing-signatures</option>:</term>
1186         <listitem>
1187           <indexterm><primary><option>-fwarn-missing-signatures</option></primary></indexterm>
1188           <indexterm><primary>type signatures, missing</primary></indexterm>
1189
1190           <para>If you would like GHC to check that every top-level
1191           function/value has a type signature, use the
1192           <option>-fwarn-missing-signatures</option> option.  As part of
1193             the warning GHC also reports the inferred type.  The
1194           option is off by default.</para>
1195         </listitem>
1196       </varlistentry>
1197
1198       <varlistentry>
1199         <term><option>-fwarn-name-shadowing</option>:</term>
1200         <listitem>
1201           <indexterm><primary><option>-fwarn-name-shadowing</option></primary></indexterm>
1202           <indexterm><primary>shadowing, warning</primary></indexterm>
1203
1204           <para>This option causes a warning to be emitted whenever an
1205           inner-scope value has the same name as an outer-scope value,
1206           i.e. the inner value shadows the outer one.  This can catch
1207           typographical errors that turn into hard-to-find bugs, e.g.,
1208           in the inadvertent capture of what would be a recursive call in
1209           <literal>f = ... let f = id in ... f ...</literal>.</para>
1210           <para>The warning is suppressed for names beginning with an underscore.  For example
1211           <programlisting>
1212              f x = do { _ignore &lt;- this; _ignore &lt;- that; return (the other) }
1213           </programlisting>
1214          </para>
1215         </listitem>
1216       </varlistentry>
1217
1218       <varlistentry>
1219         <term><option>-fwarn-orphans</option>:</term>
1220         <listitem>
1221           <indexterm><primary><option>-fwarn-orphans</option></primary></indexterm>
1222           <indexterm><primary>orphan instances, warning</primary></indexterm>
1223           <indexterm><primary>orphan rules, warning</primary></indexterm>
1224
1225           <para>This option causes a warning to be emitted whenever the
1226             module contains an "orphan" instance declaration or rewrite rule.
1227             An instance declaration is an orphan if it appears in a module in
1228             which neither the class nor the type being instanced are declared
1229             in the same module.  A rule is an orphan if it is a rule for a
1230             function declared in another module.  A module containing any
1231           orphans is called an orphan module.</para>
1232           <para>The trouble with orphans is that GHC must pro-actively read the interface
1233             files for all orphan modules, just in case their instances or rules
1234             play a role, whether or not the module's interface would otherwise
1235             be of any use.  See <xref linkend="orphan-modules"/> for details.
1236             </para>
1237         </listitem>
1238       </varlistentry>
1239
1240       <varlistentry>
1241         <term>
1242           <option>-fwarn-overlapping-patterns</option>:
1243           <indexterm><primary><option>-fwarn-overlapping-patterns</option></primary></indexterm>
1244           <indexterm><primary>overlapping patterns, warning</primary></indexterm>
1245           <indexterm><primary>patterns, overlapping</primary></indexterm>
1246         </term>
1247         <listitem>
1248           <para>By default, the compiler will warn you if a set of
1249           patterns are overlapping, e.g.,</para>
1250
1251 <programlisting>
1252 f :: String -&#62; Int
1253 f []     = 0
1254 f (_:xs) = 1
1255 f "2"    = 2
1256 </programlisting>
1257
1258           <para>where the last pattern match in <function>f</function>
1259           won't ever be reached, as the second pattern overlaps
1260           it. More often than not, redundant patterns is a programmer
1261           mistake/error, so this option is enabled by default.</para>
1262         </listitem>
1263       </varlistentry>
1264
1265       <varlistentry>
1266         <term><option>-fwarn-simple-patterns</option>:</term>
1267         <listitem>
1268           <indexterm><primary><option>-fwarn-simple-patterns</option></primary>
1269           </indexterm>
1270           <para>Causes the compiler to warn about lambda-bound
1271           patterns that can fail, eg. <literal>\(x:xs)->...</literal>.
1272           Normally, these aren't treated as incomplete patterns by
1273           <option>-fwarn-incomplete-patterns</option>.</para>
1274           <para>&ldquo;Lambda-bound patterns&rdquo; includes all places where there is a single pattern,
1275             including list comprehensions and do-notation.  In these cases, a pattern-match
1276             failure is quite legitimate, and triggers filtering (list comprehensions) or
1277             the monad <literal>fail</literal> operation (monads). For example:
1278             <programlisting>
1279               f :: [Maybe a] -> [a]
1280               f xs = [y | Just y &lt;- xs]
1281               </programlisting>
1282             Switching on <option>-fwarn-simple-patterns</option> will elicit warnings about
1283             these probably-innocent cases, which is why the flag is off by default. </para>
1284         </listitem>
1285       </varlistentry>
1286
1287       <varlistentry>
1288         <term><option>-fwarn-tabs</option>:</term>
1289         <listitem>
1290           <indexterm><primary><option>-fwarn-tabs</option></primary></indexterm>
1291           <indexterm><primary>tabs, warning</primary></indexterm>
1292           <para>Have the compiler warn if there are tabs in your source
1293           file.</para>
1294
1295           <para>This warning is off by default.</para>
1296         </listitem>
1297       </varlistentry>
1298
1299       <varlistentry>
1300         <term><option>-fwarn-type-defaults</option>:</term>
1301         <listitem>
1302           <indexterm><primary><option>-fwarn-type-defaults</option></primary></indexterm>
1303           <indexterm><primary>defaulting mechanism, warning</primary></indexterm>
1304           <para>Have the compiler warn/inform you where in your source
1305           the Haskell defaulting mechanism for numeric types kicks
1306           in. This is useful information when converting code from a
1307           context that assumed one default into one with another,
1308           e.g., the &lsquo;default default&rsquo; for Haskell 1.4 caused the
1309           otherwise unconstrained value <constant>1</constant> to be
1310           given the type <literal>Int</literal>, whereas Haskell 98
1311           defaults it to <literal>Integer</literal>.  This may lead to
1312           differences in performance and behaviour, hence the
1313           usefulness of being non-silent about this.</para>
1314
1315           <para>This warning is off by default.</para>
1316         </listitem>
1317       </varlistentry>
1318
1319       <varlistentry>
1320         <term><option>-fwarn-monomorphism-restriction</option>:</term>
1321         <listitem>
1322           <indexterm><primary><option>-fwarn-monomorphism-restriction</option></primary></indexterm>
1323           <indexterm><primary>monomorphism restriction, warning</primary></indexterm>
1324           <para>Have the compiler warn/inform you where in your source
1325           the Haskell Monomorphism Restriction is applied.  If applied silently
1326           the MR can give rise to unexpected behaviour, so it can be helpful
1327           to have an explicit warning that it is being applied.</para>
1328
1329           <para>This warning is off by default.</para>
1330         </listitem>
1331       </varlistentry>
1332
1333       <varlistentry>
1334         <term><option>-fwarn-unused-binds</option>:</term>
1335         <listitem>
1336           <indexterm><primary><option>-fwarn-unused-binds</option></primary></indexterm>
1337           <indexterm><primary>unused binds, warning</primary></indexterm>
1338           <indexterm><primary>binds, unused</primary></indexterm>
1339           <para>Report any function definitions (and local bindings)
1340           which are unused.  For top-level functions, the warning is
1341           only given if the binding is not exported.</para>
1342           <para>A definition is regarded as "used" if (a) it is exported, or (b) it is
1343             mentioned in the right hand side of another definition that is used, or (c) the
1344             function it defines begins with an underscore.  The last case provides a
1345             way to suppress unused-binding warnings selectively.  </para>
1346           <para> Notice that a variable
1347             is reported as unused even if it appears in the right-hand side of another
1348             unused binding. </para>
1349         </listitem>
1350       </varlistentry>
1351
1352       <varlistentry>
1353         <term><option>-fwarn-unused-imports</option>:</term>
1354         <listitem>
1355           <indexterm><primary><option>-fwarn-unused-imports</option></primary></indexterm>
1356           <indexterm><primary>unused imports, warning</primary></indexterm>
1357           <indexterm><primary>imports, unused</primary></indexterm>
1358
1359           <para>Report any modules that are explicitly imported but
1360           never used.  However, the form <literal>import M()</literal> is
1361           never reported as an unused import, because it is a useful idiom
1362           for importing instance declarations, which are anonymous in Haskell.</para>
1363         </listitem>
1364       </varlistentry>
1365
1366       <varlistentry>
1367         <term><option>-fwarn-unused-matches</option>:</term>
1368         <listitem>
1369           <indexterm><primary><option>-fwarn-unused-matches</option></primary></indexterm>
1370           <indexterm><primary>unused matches, warning</primary></indexterm>
1371           <indexterm><primary>matches, unused</primary></indexterm>
1372
1373           <para>Report all unused variables which arise from pattern
1374           matches, including patterns consisting of a single variable.
1375           For instance <literal>f x y = []</literal> would report
1376           <varname>x</varname> and <varname>y</varname> as unused.  The
1377           warning is suppressed if the variable name begins with an underscore, thus:
1378             <programlisting>
1379                f _x = True
1380             </programlisting>
1381           </para>
1382         </listitem>
1383       </varlistentry>
1384
1385       <varlistentry>
1386         <term><option>-fwarn-unused-do-bind</option>:</term>
1387         <listitem>
1388           <indexterm><primary><option>-fwarn-unused-do-bind</option></primary></indexterm>
1389           <indexterm><primary>unused do binding, warning</primary></indexterm>
1390           <indexterm><primary>do binding, unused</primary></indexterm>
1391
1392           <para>Report expressions occuring in <literal>do</literal> and <literal>mdo</literal> blocks
1393           that appear to silently throw information away.
1394           For instance <literal>do { mapM popInt xs ; return 10 }</literal> would report
1395           the first statement in the <literal>do</literal> block as suspicious,
1396           as it has the type <literal>StackM [Int]</literal> and not <literal>StackM ()</literal>, but that
1397           <literal>[Int]</literal> value is not bound to anything.  The warning is suppressed by
1398           explicitly mentioning in the source code that your program is throwing something away:
1399             <programlisting>
1400                do { _ &lt;- mapM popInt xs ; return 10 }
1401             </programlisting>
1402           Of course, in this particular situation you can do even better:
1403             <programlisting>
1404                do { mapM_ popInt xs ; return 10 }
1405             </programlisting>
1406           </para>
1407         </listitem>
1408       </varlistentry>
1409
1410       <varlistentry>
1411         <term><option>-fwarn-wrong-do-bind</option>:</term>
1412         <listitem>
1413           <indexterm><primary><option>-fwarn-wrong-do-bind</option></primary></indexterm>
1414           <indexterm><primary>apparently erroneous do binding, warning</primary></indexterm>
1415           <indexterm><primary>do binding, apparently erroneous</primary></indexterm>
1416
1417           <para>Report expressions occuring in <literal>do</literal> and <literal>mdo</literal> blocks
1418           that appear to lack a binding.
1419           For instance <literal>do { return (popInt 10) ; return 10 }</literal> would report
1420           the first statement in the <literal>do</literal> block as suspicious,
1421           as it has the type <literal>StackM (StackM Int)</literal> (which consists of two nested applications
1422           of the same monad constructor), but which is not then &quot;unpacked&quot; by binding the result.
1423           The warning is suppressed by explicitly mentioning in the source code that your program is throwing something away:
1424             <programlisting>
1425                do { _ &lt;- return (popInt 10) ; return 10 }
1426             </programlisting>
1427           For almost all sensible programs this will indicate a bug, and you probably intended to write:
1428             <programlisting>
1429                do { popInt 10 ; return 10 }
1430             </programlisting>
1431           </para>
1432         </listitem>
1433       </varlistentry>
1434
1435     </variablelist>
1436
1437     <para>If you're feeling really paranoid, the
1438     <option>-dcore-lint</option>
1439     option<indexterm><primary><option>-dcore-lint</option></primary></indexterm>
1440     is a good choice.  It turns on heavyweight intra-pass
1441     sanity-checking within GHC.  (It checks GHC's sanity, not
1442     yours.)</para>
1443
1444   </sect1>
1445
1446   &packages;
1447
1448   <sect1 id="options-optimise">
1449     <title>Optimisation (code improvement)</title>
1450
1451     <indexterm><primary>optimisation</primary></indexterm>
1452     <indexterm><primary>improvement, code</primary></indexterm>
1453
1454     <para>The <option>-O*</option> options specify convenient
1455     &ldquo;packages&rdquo; of optimisation flags; the
1456     <option>-f*</option> options described later on specify
1457     <emphasis>individual</emphasis> optimisations to be turned on/off;
1458     the <option>-m*</option> options specify
1459     <emphasis>machine-specific</emphasis> optimisations to be turned
1460     on/off.</para>
1461
1462     <sect2 id="optimise-pkgs">
1463       <title><option>-O*</option>: convenient &ldquo;packages&rdquo; of optimisation flags.</title>
1464
1465       <para>There are <emphasis>many</emphasis> options that affect
1466       the quality of code produced by GHC.  Most people only have a
1467       general goal, something like &ldquo;Compile quickly&rdquo; or
1468       &ldquo;Make my program run like greased lightning.&rdquo; The
1469       following &ldquo;packages&rdquo; of optimisations (or lack
1470       thereof) should suffice.</para>
1471
1472       <para>Note that higher optimisation levels cause more
1473       cross-module optimisation to be performed, which can have an
1474       impact on how much of your program needs to be recompiled when
1475       you change something.  This is one reason to stick to
1476       no-optimisation when developing code.</para>
1477
1478       <variablelist>
1479
1480         <varlistentry>
1481           <term>
1482             No <option>-O*</option>-type option specified:
1483             <indexterm><primary>-O* not specified</primary></indexterm>
1484           </term>
1485           <listitem>
1486             <para>This is taken to mean: &ldquo;Please compile
1487             quickly; I'm not over-bothered about compiled-code
1488             quality.&rdquo; So, for example: <command>ghc -c
1489             Foo.hs</command></para>
1490           </listitem>
1491         </varlistentry>
1492
1493         <varlistentry>
1494           <term>
1495             <option>-O0</option>:
1496             <indexterm><primary><option>-O0</option></primary></indexterm>
1497           </term>
1498           <listitem>
1499             <para>Means &ldquo;turn off all optimisation&rdquo;,
1500             reverting to the same settings as if no
1501             <option>-O</option> options had been specified.  Saying
1502             <option>-O0</option> can be useful if
1503             eg. <command>make</command> has inserted a
1504             <option>-O</option> on the command line already.</para>
1505           </listitem>
1506         </varlistentry>
1507
1508         <varlistentry>
1509           <term>
1510             <option>-O</option> or <option>-O1</option>:
1511             <indexterm><primary>-O option</primary></indexterm>
1512             <indexterm><primary>-O1 option</primary></indexterm>
1513             <indexterm><primary>optimise</primary><secondary>normally</secondary></indexterm>
1514           </term>
1515           <listitem>
1516             <para>Means: &ldquo;Generate good-quality code without
1517             taking too long about it.&rdquo; Thus, for example:
1518             <command>ghc -c -O Main.lhs</command></para>
1519           </listitem>
1520         </varlistentry>
1521
1522         <varlistentry>
1523           <term>
1524             <option>-O2</option>:
1525             <indexterm><primary>-O2 option</primary></indexterm>
1526             <indexterm><primary>optimise</primary><secondary>aggressively</secondary></indexterm>
1527           </term>
1528           <listitem>
1529             <para>Means: &ldquo;Apply every non-dangerous
1530             optimisation, even if it means significantly longer
1531             compile times.&rdquo;</para>
1532
1533             <para>The avoided &ldquo;dangerous&rdquo; optimisations
1534             are those that can make runtime or space
1535             <emphasis>worse</emphasis> if you're unlucky.  They are
1536             normally turned on or off individually.</para>
1537
1538             <para>At the moment, <option>-O2</option> is
1539             <emphasis>unlikely</emphasis> to produce better code than
1540             <option>-O</option>.</para>
1541           </listitem>
1542         </varlistentry>
1543
1544         <varlistentry>
1545           <term>
1546             <option>-Ofile &lt;file&gt;</option>:
1547             <indexterm><primary>-Ofile &lt;file&gt; option</primary></indexterm>
1548             <indexterm><primary>optimising, customised</primary></indexterm>
1549           </term>
1550           <listitem>
1551             <para>(NOTE: not supported since GHC 4.x.  Please ask if
1552             you're interested in this.)</para>
1553
1554             <para>For those who need <emphasis>absolute</emphasis>
1555             control over <emphasis>exactly</emphasis> what options are
1556             used (e.g., compiler writers, sometimes :-), a list of
1557             options can be put in a file and then slurped in with
1558             <option>-Ofile</option>.</para>
1559
1560             <para>In that file, comments are of the
1561             <literal>&num;</literal>-to-end-of-line variety; blank
1562             lines and most whitespace is ignored.</para>
1563
1564             <para>Please ask if you are baffled and would like an
1565             example of <option>-Ofile</option>!</para>
1566           </listitem>
1567         </varlistentry>
1568       </variablelist>
1569
1570       <para>We don't use a <option>-O*</option> flag for day-to-day
1571       work.  We use <option>-O</option> to get respectable speed;
1572       e.g., when we want to measure something.  When we want to go for
1573       broke, we tend to use <option>-O2 -fvia-C</option> (and we go for
1574       lots of coffee breaks).</para>
1575
1576       <para>The easiest way to see what <option>-O</option> (etc.)
1577       &ldquo;really mean&rdquo; is to run with <option>-v</option>,
1578       then stand back in amazement.</para>
1579     </sect2>
1580
1581     <sect2 id="options-f">
1582       <title><option>-f*</option>: platform-independent flags</title>
1583
1584       <indexterm><primary>-f* options (GHC)</primary></indexterm>
1585       <indexterm><primary>-fno-* options (GHC)</primary></indexterm>
1586
1587       <para>These flags turn on and off individual optimisations.
1588       They are normally set via the <option>-O</option> options
1589       described above, and as such, you shouldn't need to set any of
1590       them explicitly (indeed, doing so could lead to unexpected
1591       results).  However, there are one or two that may be of
1592       interest:</para>
1593
1594       <variablelist>
1595         <varlistentry>
1596           <term><option>-fexcess-precision</option>:</term>
1597           <listitem>
1598             <indexterm><primary><option>-fexcess-precision</option></primary></indexterm>
1599             <para>When this option is given, intermediate floating
1600             point values can have a <emphasis>greater</emphasis>
1601             precision/range than the final type.  Generally this is a
1602             good thing, but some programs may rely on the exact
1603             precision/range of
1604             <literal>Float</literal>/<literal>Double</literal> values
1605             and should not use this option for their compilation.</para>
1606           </listitem>
1607         </varlistentry>
1608
1609         <varlistentry>
1610           <term><option>-fignore-asserts</option>:</term>
1611           <listitem>
1612             <indexterm><primary><option>-fignore-asserts</option></primary></indexterm>
1613             <para>Causes GHC to ignore uses of the function
1614             <literal>Exception.assert</literal> in source code (in
1615             other words, rewriting <literal>Exception.assert p
1616             e</literal> to <literal>e</literal> (see <xref
1617             linkend="assertions"/>).  This flag is turned on by
1618             <option>-O</option>.
1619             </para>
1620           </listitem>
1621         </varlistentry>
1622
1623         <varlistentry>
1624           <term>
1625             <option>-fno-cse</option>
1626             <indexterm><primary><option>-fno-cse</option></primary></indexterm>
1627           </term>
1628           <listitem>
1629             <para>Turns off the common-sub-expression elimination optimisation.
1630               Can be useful if you have some <literal>unsafePerformIO</literal>
1631             expressions that you don't want commoned-up.</para>
1632           </listitem>
1633         </varlistentry>
1634
1635         <varlistentry>
1636           <term>
1637             <option>-fno-strictness</option>
1638             <indexterm><primary><option>-fno-strictness</option></primary></indexterm>
1639           </term>
1640           <listitem>
1641             <para>Turns off the strictness analyser; sometimes it eats
1642             too many cycles.</para>
1643           </listitem>
1644         </varlistentry>
1645
1646         <varlistentry>
1647           <term>
1648             <option>-fno-full-laziness</option>
1649             <indexterm><primary><option>-fno-full-laziness</option></primary></indexterm>
1650           </term>
1651           <listitem>
1652             <para>Turns off the full laziness optimisation (also known as
1653               let-floating).  Full laziness increases sharing, which can lead
1654               to increased memory residency.</para>
1655
1656             <para>NOTE: GHC doesn't implement complete full-laziness.
1657             When optimisation in on, and
1658             <option>-fno-full-laziness</option> is not given, some
1659             transformations that increase sharing are performed, such
1660             as extracting repeated computations from a loop.  These
1661             are the same transformations that a fully lazy
1662             implementation would do, the difference is that GHC
1663             doesn't consistently apply full-laziness, so don't rely on
1664             it.</para>
1665           </listitem>
1666         </varlistentry>
1667
1668         <varlistentry>
1669           <term>
1670             <option>-fno-float-in</option>
1671             <indexterm><primary><option>-fno-float-in</option></primary></indexterm>
1672           </term>
1673           <listitem>
1674             <para>Turns off the float-in transformation.</para>
1675           </listitem>
1676         </varlistentry>
1677
1678         <varlistentry>
1679           <term>
1680             <option>-fno-specialise</option>
1681             <indexterm><primary><option>-fno-specialise</option></primary></indexterm>
1682           </term>
1683           <listitem>
1684             <para>Turns off the automatic specialisation of overloaded functions.</para>
1685           </listitem>
1686         </varlistentry>
1687
1688         <varlistentry>
1689           <term>
1690             <option>-fspec-constr</option>
1691             <indexterm><primary><option>-fspec-constr</option></primary></indexterm>
1692           </term>
1693           <listitem>
1694             <para>Turn on call-pattern specialisation.</para>
1695           </listitem>
1696         </varlistentry>
1697
1698         <varlistentry>
1699           <term>
1700             <option>-fliberate-case</option>
1701             <indexterm><primary><option>-fliberate-case</option></primary></indexterm>
1702           </term>
1703           <listitem>
1704             <para>Turn on the liberate-case transformation.</para>
1705           </listitem>
1706         </varlistentry>
1707
1708         <varlistentry>
1709           <term>
1710             <option>-fstatic-argument-transformation</option>
1711             <indexterm><primary><option>-fstatic-argument-transformation</option></primary></indexterm>
1712           </term>
1713           <listitem>
1714             <para>Turn on the static argument transformation.</para>
1715           </listitem>
1716         </varlistentry>
1717
1718         <varlistentry>
1719           <term>
1720             <option>-fno-state-hack</option>
1721             <indexterm><primary><option>-fno-state-hack</option></primary></indexterm>
1722           </term>
1723           <listitem>
1724             <para>Turn off the "state hack" whereby any lambda with a
1725               <literal>State#</literal> token as argument is considered to be
1726               single-entry, hence it is considered OK to inline things inside
1727               it.  This can improve performance of IO and ST monad code, but it
1728             runs the risk of reducing sharing.</para>
1729           </listitem>
1730         </varlistentry>
1731
1732         <varlistentry>
1733           <term>
1734             <option>-fomit-interface-pragmas</option>
1735             <indexterm><primary><option>-fomit-interface-pragmas</option></primary></indexterm>
1736           </term>
1737           <listitem>
1738             <para>Tells GHC to omit all inessential information from the interface file
1739               generated for the module being compiled (say M).  This means that a module
1740               importing M will see only the <emphasis>types</emphasis> of the functions that M exports, but not
1741               their unfoldings, strictness info, etc.  Hence, for example,
1742               no function exported by M will be inlined
1743               into an importing module.  The benefit is that modules that import M will
1744               need to be recompiled less often (only when M's exports change their type,
1745               not when they change their implementation).
1746               </para>
1747           </listitem>
1748         </varlistentry>
1749
1750         <varlistentry>
1751           <term>
1752             <option>-fignore-interface-pragmas</option>
1753             <indexterm><primary><option>-fignore-interface-pragmas</option></primary></indexterm>
1754           </term>
1755           <listitem>
1756             <para>Tells GHC to ignore all inessential information when reading interface files.
1757             That is, even if <filename>M.hi</filename> contains unfolding or strictness information
1758             for a function, GHC will ignore that information.</para>
1759           </listitem>
1760         </varlistentry>
1761
1762         <varlistentry>
1763           <term>
1764             <option>-funbox-strict-fields</option>:
1765             <indexterm><primary><option>-funbox-strict-fields</option></primary></indexterm>
1766             <indexterm><primary>strict constructor fields</primary></indexterm>
1767             <indexterm><primary>constructor fields, strict</primary></indexterm>
1768           </term>
1769           <listitem>
1770             <para>This option causes all constructor fields which are
1771             marked strict (i.e. &ldquo;!&rdquo;) to be unboxed or
1772             unpacked if possible.  It is equivalent to adding an
1773             <literal>UNPACK</literal> pragma to every strict
1774             constructor field (see <xref
1775             linkend="unpack-pragma"/>).</para>
1776
1777             <para>This option is a bit of a sledgehammer: it might
1778             sometimes make things worse.  Selectively unboxing fields
1779             by using <literal>UNPACK</literal> pragmas might be
1780             better.</para>
1781           </listitem>
1782         </varlistentry>
1783
1784         <varlistentry>
1785           <term>
1786             <option>-funfolding-creation-threshold=<replaceable>n</replaceable></option>:
1787             <indexterm><primary><option>-funfolding-creation-threshold</option></primary></indexterm>
1788             <indexterm><primary>inlining, controlling</primary></indexterm>
1789             <indexterm><primary>unfolding, controlling</primary></indexterm>
1790           </term>
1791           <listitem>
1792             <para>(Default: 45) Governs the maximum size that GHC will
1793             allow a function unfolding to be.   (An unfolding has a
1794             &ldquo;size&rdquo; that reflects the cost in terms of
1795             &ldquo;code bloat&rdquo; of expanding that unfolding at
1796             at a call site. A bigger function would be assigned a
1797             bigger cost.) </para>
1798
1799             <para> Consequences: (a) nothing larger than this will be
1800             inlined (unless it has an INLINE pragma); (b) nothing
1801             larger than this will be spewed into an interface
1802             file. </para>
1803
1804
1805             <para> Increasing this figure is more likely to result in longer
1806             compile times than faster code.  The next option is more
1807             useful:</para>
1808           </listitem>
1809         </varlistentry>
1810
1811         <varlistentry>
1812           <term><option>-funfolding-use-threshold=<replaceable>n</replaceable></option></term>
1813           <listitem>
1814             <indexterm><primary><option>-funfolding-use-threshold</option></primary></indexterm>
1815             <indexterm><primary>inlining, controlling</primary></indexterm>
1816             <indexterm><primary>unfolding, controlling</primary></indexterm>
1817
1818             <para>(Default: 8) This is the magic cut-off figure for
1819             unfolding: below this size, a function definition will be
1820             unfolded at the call-site, any bigger and it won't.  The
1821             size computed for a function depends on two things: the
1822             actual size of the expression minus any discounts that
1823             apply (see <option>-funfolding-con-discount</option>).</para>
1824           </listitem>
1825         </varlistentry>
1826       </variablelist>
1827
1828     </sect2>
1829
1830   </sect1>
1831
1832   &phases;
1833
1834   &shared_libs;
1835
1836   <sect1 id="using-concurrent">
1837     <title>Using Concurrent Haskell</title>
1838     <indexterm><primary>Concurrent Haskell</primary><secondary>using</secondary></indexterm>
1839
1840     <para>GHC supports Concurrent Haskell by default, without requiring a
1841       special option or libraries compiled in a certain way.  To get access to
1842       the support libraries for Concurrent Haskell, just import
1843       <ulink
1844         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>
1845
1846     <para>The following RTS option(s) affect the behaviour of Concurrent
1847       Haskell programs:<indexterm><primary>RTS options, concurrent</primary></indexterm></para>
1848
1849     <variablelist>
1850       <varlistentry>
1851         <term><option>-C<replaceable>s</replaceable></option></term>
1852         <listitem>
1853           <para><indexterm><primary><option>-C<replaceable>s</replaceable></option></primary><secondary>RTS option</secondary></indexterm>
1854             Sets the context switch interval to <replaceable>s</replaceable>
1855             seconds.  A context switch will occur at the next heap block
1856             allocation after the timer expires (a heap block allocation occurs
1857             every 4k of allocation).  With <option>-C0</option> or
1858             <option>-C</option>, context switches will occur as often as
1859             possible (at every heap block allocation).  By default, context
1860             switches occur every 20ms.</para>
1861         </listitem>
1862       </varlistentry>
1863     </variablelist>
1864   </sect1>
1865
1866   <sect1 id="using-smp">
1867     <title>Using SMP parallelism</title>
1868     <indexterm><primary>parallelism</primary>
1869     </indexterm>
1870     <indexterm><primary>SMP</primary>
1871     </indexterm>
1872
1873     <para>GHC supports running Haskell programs in parallel on an SMP
1874       (symmetric multiprocessor).</para>
1875
1876     <para>There's a fine distinction between
1877       <emphasis>concurrency</emphasis> and <emphasis>parallelism</emphasis>:
1878       parallelism is all about making your program run
1879       <emphasis>faster</emphasis> by making use of multiple processors
1880       simultaneously.  Concurrency, on the other hand, is a means of
1881       abstraction: it is a convenient way to structure a program that must
1882       respond to multiple asynchronous events.</para>
1883
1884     <para>However, the two terms are certainly related.  By making use of
1885       multiple CPUs it is possible to run concurrent threads in parallel,
1886       and this is exactly what GHC's SMP parallelism support does.  But it
1887       is also possible to obtain performance improvements with parallelism
1888       on programs that do not use concurrency.  This section describes how to
1889       use GHC to compile and run parallel programs, in <xref
1890         linkend="lang-parallel" /> we describe the language features that affect
1891     parallelism.</para>
1892
1893     <sect2 id="parallel-compile-options">
1894       <title>Compile-time options for SMP parallelism</title>
1895
1896       <para>In order to make use of multiple CPUs, your program must be
1897         linked with the <option>-threaded</option> option (see <xref
1898           linkend="options-linker" />).  Additionally, the following
1899         compiler options affect parallelism:</para>
1900
1901       <variablelist>
1902         <varlistentry>
1903           <term><option>-feager-blackholing</option></term>
1904           <indexterm><primary><option>-feager-blackholing</option></primary></indexterm>
1905           <listitem>
1906           <para>
1907             Blackholing is the act of marking a thunk (lazy
1908             computuation) as being under evaluation.  It is useful for
1909             three reasons: firstly it lets us detect certain kinds of
1910             infinite loop (the <literal>NonTermination</literal>
1911             exception), secondly it avoids certain kinds of space
1912             leak, and thirdly it avoids repeating a computation in a
1913             parallel program, because we can tell when a computation
1914             is already in progress.</para>
1915
1916           <para>
1917             The option <option>-feager-blackholing</option> causes
1918             each thunk to be blackholed as soon as evaluation begins.
1919             The default is "lazy blackholing", whereby thunks are only
1920             marked as being under evaluation when a thread is paused
1921             for some reason.  Lazy blackholing is typically more
1922             efficient (by 1-2&percnt; or so), because most thunks don't
1923             need to be blackholed.  However, eager blackholing can
1924             avoid more repeated computation in a parallel program, and
1925             this often turns out to be important for parallelism.
1926           </para>
1927
1928           <para>
1929             We recommend compiling any code that is intended to be run
1930             in parallel with the <option>-feager-blackholing</option>
1931             flag.
1932           </para>
1933           </listitem>
1934         </varlistentry>
1935       </variablelist>
1936     </sect2>
1937
1938     <sect2 id="parallel-options">
1939       <title>RTS options for SMP parallelism</title>
1940
1941       <para>To run a program on multiple CPUs, use the
1942         RTS <option>-N</option> option:</para>
1943
1944       <variablelist>
1945         <varlistentry>
1946           <term><option>-N<optional><replaceable>x</replaceable></optional></option></term>
1947           <listitem>
1948             <para><indexterm><primary><option>-N<replaceable>x</replaceable></option></primary><secondary>RTS option</secondary></indexterm>
1949               Use <replaceable>x</replaceable> simultaneous threads when
1950               running the program.  Normally <replaceable>x</replaceable>
1951               should be chosen to match the number of CPU cores on the
1952               machine<footnote><para>Whether hyperthreading cores should be counted or not is an
1953               open question; please feel free to experiment and let us know what
1954                   results you find.</para></footnote>.  For example,
1955               on a dual-core machine we would probably use
1956               <literal>+RTS -N2 -RTS</literal>.</para>
1957
1958             <para>Omitting <replaceable>x</replaceable>,
1959               i.e. <literal>+RTS -N -RTS</literal>, lets the runtime
1960               choose the value of <replaceable>x</replaceable> itself
1961               based on how many processors are in your machine.</para>
1962
1963             <para>Be careful when using all the processors in your
1964               machine: if some of your processors are in use by other
1965               programs, this can actually harm performance rather than
1966               improve it.</para>
1967
1968             <para>Setting <option>-N</option> also has the effect of
1969               enabling the parallel garbage collector (see
1970               <xref linkend="rts-options-gc" />).</para>
1971
1972             <para>There is no means (currently) by which this value
1973               may vary after the program has started.</para>
1974
1975             <para>The current value of the <option>-N</option> option
1976               is available to the Haskell program
1977               via <literal>GHC.Conc.numCapabilities</literal>.</para>
1978           </listitem>
1979         </varlistentry>
1980       </variablelist>
1981
1982       <para>The following options affect the way the runtime schedules
1983       threads on CPUs:</para>
1984
1985       <variablelist>
1986         <varlistentry>
1987           <term><option>-qa</option></term>
1988           <indexterm><primary><option>-qa</option></primary><secondary>RTS
1989           option</secondary></indexterm>
1990           <listitem>
1991             <para>Use the OS's affinity facilities to try to pin OS
1992               threads to CPU cores.  This is an experimental feature,
1993               and may or may not be useful.  Please let us know
1994               whether it helps for you!</para>
1995           </listitem>
1996         </varlistentry>
1997         <varlistentry>
1998           <term><option>-qm</option></term>
1999           <indexterm><primary><option>-qm</option></primary><secondary>RTS
2000           option</secondary></indexterm>
2001           <listitem>
2002             <para>Disable automatic migration for load balancing.
2003             Normally the runtime will automatically try to schedule
2004             threads across the available CPUs to make use of idle
2005             CPUs; this option disables that behaviour.  Note that
2006               migration only applies to threads; sparks created
2007               by <literal>par</literal> are load-balanced separately
2008               by work-stealing.</para>
2009
2010             <para>
2011               This option is probably only of use for concurrent
2012               programs that explicitly schedule threads onto CPUs
2013               with <literal>GHC.Conc.forkOnIO</literal>.
2014             </para>
2015           </listitem>
2016         </varlistentry>
2017         <varlistentry>
2018           <term><option>-qw</option></term>
2019           <indexterm><primary><option>-qw</option></primary><secondary>RTS
2020           option</secondary></indexterm>
2021           <listitem>
2022             <para>Migrate a thread to the current CPU when it is woken
2023             up.  Normally when a thread is woken up after being
2024             blocked it will be scheduled on the CPU it was running on
2025             last; this option allows the thread to immediately migrate
2026             to the CPU that unblocked it.</para>
2027
2028             <para>The rationale for allowing this eager migration is
2029             that it tends to move threads that are communicating with
2030             each other onto the same CPU; however there are
2031             pathalogical situations where it turns out to be a poor
2032             strategy.  Depending on the communication pattern in your
2033             program, it may or may not be a good idea.</para>
2034           </listitem>
2035         </varlistentry>
2036        </variablelist>
2037     </sect2>
2038
2039     <sect2>
2040       <title>Hints for using SMP parallelism</title>
2041
2042       <para>Add the <literal>-s</literal> RTS option when
2043         running the program to see timing stats, which will help to tell you
2044         whether your program got faster by using more CPUs or not.  If the user
2045         time is greater than
2046         the elapsed time, then the program used more than one CPU.  You should
2047         also run the program without <literal>-N</literal> for
2048         comparison.</para>
2049
2050       <para>The output of <literal>+RTS -s</literal> tells you how
2051         many &ldquo;sparks&rdquo; were created and executed during the
2052         run of the program (see <xref linkend="rts-options-gc" />), which
2053         will give you an idea how well your <literal>par</literal>
2054         annotations are working.</para>
2055
2056       <para>GHC's parallelism support has improved in 6.12.1 as a
2057         result of much experimentation and tuning in the runtime
2058         system.  We'd still be interested to hear how well it works
2059         for you, and we're also interested in collecting parallel
2060         programs to add to our benchmarking suite.</para>
2061     </sect2>
2062   </sect1>
2063
2064   <sect1 id="options-platform">
2065     <title>Platform-specific Flags</title>
2066
2067     <indexterm><primary>-m* options</primary></indexterm>
2068     <indexterm><primary>platform-specific options</primary></indexterm>
2069     <indexterm><primary>machine-specific options</primary></indexterm>
2070
2071     <para>Some flags only make sense for particular target
2072     platforms.</para>
2073
2074     <variablelist>
2075
2076       <varlistentry>
2077         <term><option>-msse2</option>:</term>
2078         <listitem>
2079           <para>
2080             (x86 only, added in GHC 6.14.1) Use the SSE2 registers and
2081             instruction set to implement floating point operations
2082             when using the native code generator.  This gives a
2083             substantial performance improvement for floating point,
2084             but the resulting compiled code will only run on
2085             processors that support SSE2 (Intel Pentium 4 and later,
2086             or AMD Athlon 64 and later).
2087           </para>
2088           <para>
2089             SSE2 is unconditionally used on x86-64 platforms.
2090           </para>
2091         </listitem>
2092       </varlistentry>
2093
2094       <varlistentry>
2095         <term><option>-monly-[32]-regs</option>:</term>
2096         <listitem>
2097           <para>(x86 only)<indexterm><primary>-monly-N-regs
2098           option (iX86 only)</primary></indexterm> GHC tries to
2099           &ldquo;steal&rdquo; four registers from GCC, for performance
2100           reasons; it almost always works.  However, when GCC is
2101           compiling some modules with four stolen registers, it will
2102           crash, probably saying:
2103
2104 <screen>
2105 Foo.hc:533: fixed or forbidden register was spilled.
2106 This may be due to a compiler bug or to impossible asm
2107 statements or clauses.
2108 </screen>
2109
2110           Just give some registers back with
2111           <option>-monly-N-regs</option>.  Try `3' first, then `2'.
2112           If `2' doesn't work, please report the bug to us.</para>
2113         </listitem>
2114       </varlistentry>
2115     </variablelist>
2116
2117   </sect1>
2118
2119 &runtime;
2120
2121 <sect1 id="ext-core">
2122   <title>Generating and compiling External Core Files</title>
2123
2124   <indexterm><primary>intermediate code generation</primary></indexterm>
2125
2126   <para>GHC can dump its optimized intermediate code (said to be in &ldquo;Core&rdquo; format)
2127   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
2128   <filename>.hcr</filename>. The Core format is described in <ulink url="../ext-core/core.pdf">
2129   <citetitle>An External Representation for the GHC Core Language</citetitle></ulink>,
2130   and sample tools
2131   for manipulating Core files (in Haskell) are in the GHC source distribution
2132   directory under <literal>utils/ext-core</literal>.
2133   Note that the format of <literal>.hcr</literal>
2134   files is <emphasis>different</emphasis> from the Core output format that GHC generates
2135   for debugging purposes (<xref linkend="options-debugging"/>), though the two formats appear somewhat similar.</para>
2136
2137   <para>The Core format natively supports notes which you can add to
2138   your source code using the <literal>CORE</literal> pragma (see <xref
2139   linkend="pragmas"/>).</para>
2140
2141     <variablelist>
2142
2143         <varlistentry>
2144           <term>
2145             <option>-fext-core</option>
2146             <indexterm><primary><option>-fext-core</option></primary></indexterm>
2147           </term>
2148           <listitem>
2149             <para>Generate <literal>.hcr</literal> files.</para>
2150           </listitem>
2151         </varlistentry>
2152
2153     </variablelist>
2154
2155 <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>
2156
2157 </sect1>
2158
2159 &debug;
2160 &flags;
2161
2162 </chapter>
2163
2164 <!-- Emacs stuff:
2165      ;;; Local Variables: ***
2166      ;;; mode: xml ***
2167      ;;; sgml-parent-document: ("users_guide.xml" "book" "chapter") ***
2168      ;;; End: ***
2169  -->