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