docs/users_guide/using.xml

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