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