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