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