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