ghc/docs/users_guide/using.xml

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