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