ghc/docs/users_guide/using.sgml

   1 <Chapter id="using-GHC">
   2 <Title>Using GHC
   3 </Title>
   4
   5 <Para>
   6 <IndexTerm><Primary>GHC, using</Primary></IndexTerm>
   7 <IndexTerm><Primary>using GHC</Primary></IndexTerm>
   8 GHC is a command-line compiler: in order to compile a Haskell program,
   9 GHC must be invoked on the source file(s) by typing a command to the
  10 shell.  The steps involved in compiling a program can be automated
  11 using the <Command>make</Command> tool (this is especially useful if the program
  12 consists of multiple source files which depend on each other).  This
  13 section describes how to use GHC from the command-line.
  14 </Para>
  15
  16 <Sect1 id="command-line-structure">
  17 <Title>Overall command-line structure
  18 </Title>
  19
  20 <Para>
  21 <IndexTerm><Primary>structure, command-line</Primary></IndexTerm>
  22 <IndexTerm><Primary>command-line structure</Primary></IndexTerm>
  23 </Para>
  24
  25 <Para>
  26 An invocation of GHC takes the following form:
  27 </Para>
  28
  29 <Para>
  30
  31 <Screen>
  32 ghc [argument...]
  33 </Screen>
  34
  35 </Para>
  36
  37 <Para>
  38 Command-line arguments are either options or file names.
  39 </Para>
  40
  41 <Para>
  42 Command-line options begin with <Literal>-</Literal>.  They may <Emphasis>not</Emphasis> be
  43 grouped: <Option>-vO</Option> is different from <Option>-v -O</Option>.  Options need not
  44 precede filenames: e.g., <Command>ghc *.o -o foo</Command>.  All options are
  45 processed and then applied to all files; you cannot, for example, invoke
  46 <Command>ghc -c -O1 Foo.hs -O2 Bar.hs</Command> to apply different optimisation
  47 levels to the files <Filename>Foo.hs</Filename> and <Filename>Bar.hs</Filename>.  For conflicting
  48 options, e.g., <Option>-c -S</Option>, we reserve the right to do anything we
  49 want.  (Usually, the last one applies.)
  50 </Para>
  51
  52 </Sect1>
  53
  54 <Sect1 id="file-suffixes">
  55 <Title>Meaningful file suffixes
  56 </Title>
  57
  58 <Para>
  59 <IndexTerm><Primary>suffixes, file</Primary></IndexTerm>
  60 <IndexTerm><Primary>file suffixes for GHC</Primary></IndexTerm>
  61 </Para>
  62
  63 <Para>
  64 File names with &ldquo;meaningful&rdquo; suffixes (e.g., <Filename>.lhs</Filename> or <Filename>.o</Filename>)
  65 cause the &ldquo;right thing&rdquo; to happen to those files.
  66 </Para>
  67
  68 <Para>
  69 <VariableList>
  70
  71 <VarListEntry>
  72 <Term><Filename>.lhs</Filename>:</Term>
  73 <ListItem>
  74 <Para>
  75 <IndexTerm><Primary>lhs suffix</Primary></IndexTerm>
  76 A &ldquo;literate Haskell&rdquo; module.
  77 </Para>
  78 </ListItem>
  79 </VarListEntry>
  80 <VarListEntry>
  81 <Term><Filename>.hs</Filename>:</Term>
  82 <ListItem>
  83 <Para>
  84 A not-so-literate Haskell module.
  85 </Para>
  86 </ListItem>
  87 </VarListEntry>
  88 <VarListEntry>
  89 <Term><Filename>.hi</Filename>:</Term>
  90 <ListItem>
  91 <Para>
  92 A Haskell interface file, probably compiler-generated.
  93 </Para>
  94 </ListItem>
  95 </VarListEntry>
  96 <VarListEntry>
  97 <Term><Filename>.hc</Filename>:</Term>
  98 <ListItem>
  99 <Para>
 100 Intermediate C file produced by the Haskell compiler.
 101 </Para>
 102 </ListItem>
 103 </VarListEntry>
 104 <VarListEntry>
 105 <Term><Filename>.c</Filename>:</Term>
 106 <ListItem>
 107 <Para>
 108 A C&nbsp;file not produced by the Haskell compiler.
 109 </Para>
 110 </ListItem>
 111 </VarListEntry>
 112 <VarListEntry>
 113 <Term><Filename>.s</Filename>:</Term>
 114 <ListItem>
 115 <Para>
 116 An assembly-language source file, usually
 117 produced by the compiler.
 118 </Para>
 119 </ListItem>
 120 </VarListEntry>
 121 <VarListEntry>
 122 <Term><Filename>.o</Filename>:</Term>
 123 <ListItem>
 124 <Para>
 125 An object file, produced by an assembler.
 126 </Para>
 127 </ListItem>
 128 </VarListEntry>
 129 </VariableList>
 130 </Para>
 131
 132 <Para>
 133 Files with other suffixes (or without suffixes) are passed straight
 134 to the linker.
 135 </Para>
 136
 137 </Sect1>
 138
 139 <Sect1 id="options-help">
 140 <Title>Help and verbosity options
 141 </Title>
 142
 143 <Para>
 144 <IndexTerm><Primary>help options (GHC)</Primary></IndexTerm>
 145 <IndexTerm><Primary>verbose option (GHC)</Primary></IndexTerm>
 146 </Para>
 147
 148 <Para>
 149 A good option to start with is the <Option>-help</Option> (or <Option>-?</Option>) option.
 150 <IndexTerm><Primary>-help option</Primary></IndexTerm>
 151 <IndexTerm><Primary>-? option</Primary></IndexTerm>
 152 GHC spews a long message to standard output and then exits.
 153 </Para>
 154
 155 <Para>
 156 The <Option>-v</Option><IndexTerm><Primary>-v option</Primary></IndexTerm> option makes GHC <Emphasis>verbose</Emphasis>: it
 157 reports its version number and shows (on stderr) exactly how it invokes each
 158 phase of the compilation system.  Moreover, it passes
 159 the <Option>-v</Option> flag to most phases; each reports
 160 its version number (and possibly some other information).
 161 </Para>
 162
 163 <Para>
 164 Please, oh please, use the <Option>-v</Option> option when reporting bugs!
 165 Knowing that you ran the right bits in the right order is always the
 166 first thing we want to verify.
 167 </Para>
 168
 169 <Para>
 170 If you're just interested in the compiler version number, the
 171 <Option>--version</Option><IndexTerm><Primary>--version option</Primary></IndexTerm> option prints out a
 172 one-line string containing the requested info.
 173 </Para>
 174
 175 </Sect1>
 176
 177 <Sect1 id="options-order">
 178 <Title>Running the right phases in the right order
 179 </Title>
 180
 181 <Para>
 182 <IndexTerm><Primary>order of passes in GHC</Primary></IndexTerm>
 183 <IndexTerm><Primary>pass ordering in GHC</Primary></IndexTerm>
 184 The basic task of the <Command>ghc</Command> driver is to run each input file
 185 through the right phases (compiling, linking, etc.).
 186 </Para>
 187
 188 <Para>
 189 The first phase to run is determined by the input-file suffix, and the
 190 last phase is determined by a flag.  If no relevant flag is present,
 191 then go all the way through linking.  This table summarises:
 192 </Para>
 193
 194 <Para>
 195 <InformalTable>
 196 <TGroup Cols="4">
 197 <ColSpec Align="Left">
 198 <ColSpec Align="Left">
 199 <ColSpec Align="Left">
 200 <ColSpec Align="Left">
 201 <TBody>
 202
 203 <Row>
 204 <Entry>Phase of the compilation system</Entry>
 205 <Entry>Suffix saying &ldquo;start here&rdquo;</Entry>
 206 <Entry>Flag saying &ldquo;stop after&rdquo;</Entry>
 207 <Entry>(suffix of) output file</Entry>
 208 </Row>
 209
 210 <Row>
 211 <Entry>
 212 literate pre-processor </Entry>
 213 <Entry> .lhs </Entry>
 214 <Entry> - </Entry>
 215 <Entry> - </Entry>
 216 </Row>
 217 <Row>
 218 <Entry>
 219 C pre-processor (opt.) </Entry>
 220 <Entry> - </Entry>
 221 <Entry> - </Entry>
 222 <Entry> - </Entry>
 223 </Row>
 224 <Row>
 225 <Entry>
 226 Haskell compiler </Entry>
 227 <Entry> .hs </Entry>
 228 <Entry> -C, -S </Entry>
 229 <Entry> .hc, .s </Entry>
 230 </Row>
 231 <Row>
 232 <Entry>
 233 C compiler (opt.) </Entry>
 234 <Entry> .hc or .c </Entry>
 235 <Entry> -S </Entry>
 236 <Entry> .s </Entry>
 237 </Row>
 238 <Row>
 239 <Entry>
 240 assembler </Entry>
 241 <Entry> .s </Entry>
 242 <Entry> -c </Entry>
 243 <Entry> .o </Entry>
 244 </Row>
 245 <Row>
 246 <Entry>
 247 linker </Entry>
 248 <Entry> other </Entry>
 249 <Entry> - </Entry>
 250 <Entry> a.out </Entry>
 251 </Row>
 252 </TBody>
 253 </TGroup>
 254 </InformalTable>
 255
 256 <IndexTerm><Primary>-C option</Primary></IndexTerm>
 257 <IndexTerm><Primary>-S option</Primary></IndexTerm>
 258 <IndexTerm><Primary>-c option</Primary></IndexTerm>
 259 </Para>
 260
 261 <Para>
 262 Thus, a common invocation would be: <Command>ghc -c Foo.hs</Command>
 263 </Para>
 264
 265 <Para>
 266 Note: What the Haskell compiler proper produces depends on whether a
 267 native-code generator is used (producing assembly language) or not
 268 (producing C).
 269 </Para>
 270
 271 <Para>
 272 The option <Option>-cpp</Option><IndexTerm><Primary>-cpp option</Primary></IndexTerm> must be given for the C
 273 pre-processor phase to be run, that is, the pre-processor will be run
 274 over your Haskell source file before continuing.
 275 </Para>
 276
 277 <Para>
 278 The option <Option>-E</Option><IndexTerm><Primary>-E option</Primary></IndexTerm> runs just the pre-processing
 279 passes of the compiler, outputting the result on stdout before
 280 stopping. If used in conjunction with -cpp, the output is the
 281 code blocks of the original (literal) source after having put it
 282 through the grinder that is the C pre-processor. Sans <Option>-cpp</Option>, the
 283 output is the de-litted version of the original source.
 284 </Para>
 285
 286 <Para>
 287 The option <Option>-optcpp-E</Option><IndexTerm><Primary>-optcpp-E option</Primary></IndexTerm> runs just the
 288 pre-processing stage of the C-compiling phase, sending the result to
 289 stdout.  (For debugging or obfuscation contests, usually.)
 290 </Para>
 291
 292 </Sect1>
 293
 294 <Sect1 id="options-output">
 295 <Title>Re-directing the compilation output(s)
 296 </Title>
 297
 298 <Para>
 299 <IndexTerm><Primary>output-directing options</Primary></IndexTerm>
 300 </Para>
 301
 302 <Para>
 303 GHC's compiled output normally goes into a <Filename>.hc</Filename>, <Filename>.o</Filename>, etc., file,
 304 depending on the last-run compilation phase.  The option <Option>-o
 305 foo</Option><IndexTerm><Primary>-o option</Primary></IndexTerm> re-directs the output of that last-run
 306 phase to file <Filename>foo</Filename>.
 307 </Para>
 308
 309 <Para>
 310 Note: this &ldquo;feature&rdquo; can be counterintuitive:
 311 <Command>ghc -C -o foo.o foo.hs</Command> will put the intermediate C code in the
 312 file <Filename>foo.o</Filename>, name notwithstanding!
 313 </Para>
 314
 315 <Para>
 316 EXOTICA: But the <Option>-o</Option> option isn't of much use if you have
 317 <Emphasis>several</Emphasis> input files&hellip; Non-interface output files are
 318 normally put in the same directory as their corresponding input file
 319 came from.  You may specify that they be put in another directory
 320 using the <Option>-odir &lt;dir&gt;</Option><IndexTerm><Primary>-odir &lt;dir&gt; option</Primary></IndexTerm> (the
 321 &ldquo;Oh, dear&rdquo; option).  For example:
 322 </Para>
 323
 324 <Para>
 325
 326 <Screen>
 327 % ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch`
 328 </Screen>
 329
 330 </Para>
 331
 332 <Para>
 333 The output files, <Filename>Foo.o</Filename>, <Filename>Bar.o</Filename>, and <Filename>Bumble.o</Filename> would be
 334 put into a subdirectory named after the architecture of the executing
 335 machine (<Filename>sun4</Filename>, <Filename>mips</Filename>, etc).  The directory must already
 336 exist; it won't be created.
 337 </Para>
 338
 339 <Para>
 340 Note that the <Option>-odir</Option> option does <Emphasis>not</Emphasis> affect where the
 341 interface files are put.  In the above example, they would still be
 342 put in <Filename>parse/Foo.hi</Filename>, <Filename>parse/Bar.hi</Filename>, and <Filename>gurgle/Bumble.hi</Filename>.
 343 </Para>
 344
 345 <Para>
 346 MORE EXOTICA: The <Option>-osuf &lt;suffix&gt;</Option><IndexTerm><Primary>-osuf &lt;suffix&gt;
 347 option</Primary></IndexTerm> will change the <Filename>.o</Filename> file suffix for object files to
 348 whatever you specify.  (We use this in compiling the prelude.).
 349 Similarly, the <Option>-hisuf &lt;suffix&gt;</Option><IndexTerm><Primary>-hisuf &lt;suffix&gt;
 350 option</Primary></IndexTerm> will change the <Filename>.hi</Filename> file suffix for non-system
 351 interface files (see <XRef LinkEnd="hi-options">).
 352 </Para>
 353
 354 <Para>
 355 The <Option>-hisuf</Option>/<Option>-osuf</Option> game is useful if you want to compile a program
 356 with both GHC and HBC (say) in the same directory.  Let HBC use the
 357 standard <Filename>.hi</Filename>/<Filename>.o</Filename> suffixes; add <Option>-hisuf g&lowbar;hi -osuf g&lowbar;o</Option> to your
 358 <Command>make</Command> rule for GHC compiling&hellip;
 359 </Para>
 360
 361     <sect2 id="keeping-intermediates">
 362       <title>Keeping Intermediate Files</title>
 363       <indexterm><primary>intermediate files, saving</primary>
 364       </indexterm>
 365       <indexterm><primary><literal>.hc</literal> files, saving</primary>
 366       </indexterm>
 367       <indexterm><primary><literal>.s</literal> files, saving</primary>
 368       </indexterm>
 369
 370       <para>The following options are useful for keeping certain
 371       intermediate files around, when normally GHC would throw these
 372       away after compilation:</para>
 373
 374       <variablelist>
 375         <varlistentry>
 376           <term><literal>-keep-hc-files</literal></term>
 377           <indexterm>
 378             <primary><literal>-keep-hc-files</literal></primary>
 379           </indexterm>
 380           <listitem>
 381             <para>Keep intermediate <literal>.hc</literal> files when
 382             doing <literal>.hs</literal>-to-<literal>.o</literal>
 383             compilations via C (NOTE: <literal>.hc</literal> files
 384             aren't generated when using the native code generator, you
 385             may need to use <literal>-fvia-C</literal> to force them
 386             to be produced).</para>
 387           </listitem>
 388         </varlistentry>
 389
 390         <varlistentry>
 391           <term><literal>-keep-s-files</literal></term>
 392           <indexterm>
 393             <primary><literal>-keep-s-files</literal></primary>
 394           </indexterm>
 395           <listitem>
 396             <para>Keep intermediate <literal>.s</literal> files.</para>
 397           </listitem>
 398         </varlistentry>
 399
 400         <varlistentry>
 401           <term><literal>-keep-raw-s-files</literal></term>
 402           <indexterm>
 403             <primary><literal>-keep-raw-s-files</literal></primary>
 404           </indexterm>
 405           <listitem>
 406             <para>Keep intermediate <literal>.raw-s</literal> files.
 407             These are the direct output from the C compiler, before
 408             GHC does &ldquo;assembly mangling&rdquo; to produce the
 409             <literal>.s</literal> file.  Again, these are not produced
 410             when using the native code generator.</para>
 411           </listitem>
 412         </varlistentry>
 413
 414         <varlistentry>
 415           <term><literal>-keep-tmp-files</literal></term>
 416           <indexterm>
 417             <primary><literal>-keep-tmp-files</literal></primary>
 418           </indexterm>
 419           <indexterm>
 420             <primary>temporary files</primary>
 421             <secondary>keeping</secondary>
 422           </indexterm>
 423           <listitem>
 424             <para>Instructs the GHC driver not to delete any of its
 425             temporary files, which it normally keeps in
 426             <literal>/tmp</literal> (or possibly elsewhere; see <xref
 427             linkend="temp-files">).  Running GHC with
 428             <literal>-v</literal> will show you what temporary files
 429             were generated along the way.</para>
 430           </listitem>
 431         </varlistentry>
 432       </variablelist>
 433     </sect2>
 434
 435 <Sect2 id="saving-ghc-stderr">
 436 <Title>Saving GHC's standard error output
 437 </Title>
 438
 439 <Para>
 440 <IndexTerm><Primary>standard error, saving</Primary></IndexTerm>
 441 </Para>
 442
 443 <Para>
 444 Sometimes, you may cause GHC to be rather chatty on standard error;
 445 with <Option>-v</Option>, for example.  You can instruct GHC to <Emphasis>append</Emphasis> this
 446 output to a particular log file with a <Option>-odump &lt;blah&gt;</Option><IndexTerm><Primary>-odump
 447 &lt;blah&gt; option</Primary></IndexTerm> option.
 448 </Para>
 449
 450 </Sect2>
 451
 452 <Sect2 id="temp-files">
 453 <Title>Redirecting temporary files
 454 </Title>
 455
 456       <indexterm>
 457         <primary>temporary files</primary>
 458         <secondary>redirecting</secondary>
 459       </indexterm>
 460
 461 <Para>
 462 If you have trouble because of running out of space in
 463 <Filename>/tmp</Filename> (or wherever your installation thinks
 464 temporary files should go), you may use the <Option>-tmpdir
 465 &lt;dir&gt;</Option><IndexTerm><Primary>-tmpdir &lt;dir&gt;
 466 option</Primary></IndexTerm> option to specify an alternate directory.
 467 For example, <Option>-tmpdir .</Option> says to put temporary files in
 468 the current working directory.
 469 </Para>
 470
 471 <Para>
 472 Alternatively, use your <Constant>TMPDIR</Constant> environment
 473 variable.<IndexTerm><Primary>TMPDIR environment
 474 variable</Primary></IndexTerm> Set it to the name of the directory
 475 where temporary files should be put.  GCC and other programs will
 476 honour the <Constant>TMPDIR</Constant> variable as well.
 477 </Para>
 478
 479 <Para>
 480 Even better idea: Set the <Constant>TMPDIR</Constant> variable when building GHC, and
 481 never worry about <Constant>TMPDIR</Constant> again. (see the build documentation).
 482 </Para>
 483
 484 </Sect2>
 485
 486 </Sect1>
 487
 488 <Sect1 id="options-sanity">
 489 <Title>Warnings and sanity-checking
 490 </Title>
 491
 492 <Para>
 493 <IndexTerm><Primary>sanity-checking options</Primary></IndexTerm>
 494 <IndexTerm><Primary>warnings</Primary></IndexTerm>
 495 GHC has a number of options that select which types of non-fatal error
 496 messages, otherwise known as warnings, can be generated during
 497 compilation.  By default, you get a standard set of warnings which are
 498 generally likely to indicate bugs in your program.  These are:
 499 <Option>-fwarn-overlpapping-patterns</Option>, <Option>-fwarn-duplicate-exports</Option>, and
 500 <Option>-fwarn-missing-methods</Option>.  The following flags are simple ways to
 501 select standard &ldquo;packages&rdquo; of warnings:
 502 </Para>
 503
 504 <Para>
 505 <VariableList>
 506
 507 <VarListEntry>
 508 <Term><Option>-Wnot</Option>:</Term>
 509 <ListItem>
 510 <Para>
 511 <IndexTerm><Primary>-Wnot option</Primary></IndexTerm>
 512 Turns off all warnings, including the standard ones.
 513 </Para>
 514 </ListItem>
 515 </VarListEntry>
 516
 517 <VarListEntry>
 518 <Term><Option>-w</Option>:</Term>
 519 <ListItem>
 520 <Para>
 521 <IndexTerm><Primary>-w option</Primary></IndexTerm>
 522 Synonym for <Option>-Wnot</Option>.
 523 </Para>
 524 </ListItem>
 525 </VarListEntry>
 526
 527 <VarListEntry>
 528 <Term><Option>-W</Option>:</Term>
 529 <ListItem>
 530 <Para>
 531 <IndexTerm><Primary>-W option</Primary></IndexTerm>
 532 Provides the standard warnings plus <Option>-fwarn-incomplete-patterns</Option>,
 533 <Option>-fwarn-unused-imports</Option> and <Option>-fwarn-unused-binds</Option>.
 534 </Para>
 535 </ListItem>
 536 </VarListEntry>
 537
 538 <VarListEntry>
 539 <Term><Option>-Wall</Option>:</Term>
 540 <ListItem>
 541 <Para>
 542 <IndexTerm><Primary>-Wall option</Primary></IndexTerm>
 543 Turns on all warning options.
 544 </Para>
 545 </ListItem>
 546 </VarListEntry>
 547
 548 </VariableList>
 549 </Para>
 550
 551 <Para>
 552 The full set of warning options is described below.  To turn off any
 553 warning, simply give the corresponding <Option>-fno-warn-...</Option> option on
 554 the command line.
 555 </Para>
 556
 557 <Para>
 558 <VariableList>
 559
 560 <VarListEntry>
 561 <Term><Option>-fwarn-name-shadowing</Option>:</Term>
 562 <ListItem>
 563 <Para>
 564 <IndexTerm><Primary>-fwarn-name-shadowing option</Primary></IndexTerm>
 565 <IndexTerm><Primary>shadowing, warning</Primary></IndexTerm>This option causes a warning to be emitted whenever an inner-scope
 566 value has the same name as an outer-scope value, i.e. the inner value
 567 shadows the outer one.  This can catch typographical errors that turn
 568 into hard-to-find bugs, e.g., in the inadvertent cyclic definition
 569 <Literal>let x = ... x ... in</Literal>.
 570 </Para>
 571
 572 <Para>
 573 Consequently, this option does <Emphasis>not</Emphasis> allow cyclic recursive
 574 definitions.
 575 </Para>
 576 </ListItem>
 577 </VarListEntry>
 578
 579 <VarListEntry>
 580 <Term><Option>-fwarn-overlapping-patterns</Option>:</Term>
 581 <ListItem>
 582 <Para>
 583 <IndexTerm><Primary>-fwarn-overlapping-patterns option</Primary></IndexTerm>
 584 <IndexTerm><Primary>overlapping patterns, warning</Primary></IndexTerm>
 585 <IndexTerm><Primary>patterns, overlapping</Primary></IndexTerm>
 586 By default, the compiler will warn you if a set of patterns are
 587 overlapping, i.e.,
 588 </Para>
 589
 590 <Para>
 591 <ProgramListing>
 592 f :: String -&#62; Int
 593 f []     = 0
 594 f (_:xs) = 1
 595 f "2"    = 2
 596 </ProgramListing>
 597 </Para>
 598
 599 <Para>
 600 where the last pattern match in <Function>f</Function> won't ever be reached, as the
 601 second pattern overlaps it. More often than not, redundant patterns
 602 is a programmer mistake/error, so this option is enabled by default.
 603 </Para>
 604 </ListItem>
 605 </VarListEntry>
 606
 607 <VarListEntry>
 608 <Term><Option>-fwarn-incomplete-patterns</Option>:</Term>
 609 <ListItem>
 610 <Para>
 611 <IndexTerm><Primary>-fwarn-incomplete-patterns option</Primary></IndexTerm>
 612 <IndexTerm><Primary>incomplete patterns, warning</Primary></IndexTerm>
 613 <IndexTerm><Primary>patterns, incomplete</Primary></IndexTerm>
 614 Similarly for incomplete patterns, the function <Function>g</Function> below will fail
 615 when applied to non-empty lists, so the compiler will emit a warning
 616 about this when <Option>-fwarn-incomplete-patterns</Option> is enabled.
 617 </Para>
 618
 619 <Para>
 620 <ProgramListing>
 621 g [] = 2
 622 </ProgramListing>
 623 </Para>
 624
 625 <Para>
 626 This option isn't enabled be default because it can be a bit noisy,
 627 and it doesn't always indicate a bug in the program.  However, it's
 628 generally considered good practice to cover all the cases in your
 629 functions.
 630 </Para>
 631 </ListItem>
 632 </VarListEntry>
 633
 634 <VarListEntry>
 635 <Term><Option>-fwarn-missing-methods</Option>:</Term>
 636 <ListItem>
 637 <Para>
 638 <IndexTerm><Primary>-fwarn-missing-methods option</Primary></IndexTerm>
 639 <IndexTerm><Primary>missing methods, warning</Primary></IndexTerm>
 640 <IndexTerm><Primary>methods, missing</Primary></IndexTerm>
 641 This option is on by default, and warns you whenever an instance
 642 declaration is missing one or more methods, and the corresponding
 643 class declaration has no default declaration for them.
 644 </Para>
 645 </ListItem>
 646 </VarListEntry>
 647
 648 <VarListEntry>
 649 <Term><Option>-fwarn-missing-fields</Option>:</Term>
 650 <ListItem>
 651 <Para>
 652 <IndexTerm><Primary>-fwarn-missing-fields option</Primary></IndexTerm>
 653 <IndexTerm><Primary>missing fields, warning</Primary></IndexTerm>
 654 <IndexTerm><Primary>fields, missing</Primary></IndexTerm>
 655 This option is on by default, and warns you whenever the construction
 656 of a labelled field constructor isn't complete, missing initializers
 657 for one or more fields. While not an error (the missing fields are
 658 initialised with bottoms), it is often an indication of a programmer
 659 error.
 660 </Para>
 661 </ListItem>
 662 </VarListEntry>
 663
 664 <VarListEntry>
 665 <Term><Option>-fwarn-unused-imports</Option>:</Term>
 666 <ListItem>
 667 <Para>
 668 <IndexTerm><Primary>-fwarn-unused-imports option</Primary></IndexTerm>
 669 <IndexTerm><Primary>unused imports, warning</Primary></IndexTerm>
 670 <IndexTerm><Primary>imports, unused</Primary></IndexTerm>
 671 Report any objects that are explicitly imported but never used.
 672 </Para>
 673 </ListItem>
 674 </VarListEntry>
 675
 676 <VarListEntry>
 677 <Term><Option>-fwarn-unused-binds</Option>:</Term>
 678 <ListItem>
 679 <Para>
 680 <IndexTerm><Primary>-fwarn-unused-binds option</Primary></IndexTerm>
 681 <IndexTerm><Primary>unused binds, warning</Primary></IndexTerm>
 682 <IndexTerm><Primary>binds, unused</Primary></IndexTerm>
 683 Report any function definitions (and local bindings) which are unused.
 684 For top-level functions, the warning is only given if the binding is
 685 not exported.
 686 </Para>
 687 </ListItem>
 688 </VarListEntry>
 689 <VarListEntry>
 690 <Term><Option>-fwarn-unused-matches</Option>:</Term>
 691 <ListItem>
 692 <Para>
 693 <IndexTerm><Primary>-fwarn-unused-matches option</Primary></IndexTerm>
 694 <IndexTerm><Primary>unused matches, warning</Primary></IndexTerm>
 695 <IndexTerm><Primary>matches, unused</Primary></IndexTerm>
 696 Report all unused variables which arise from pattern matches,
 697 including patterns consisting of a single variable.  For instance <Literal>f x
 698 y = []</Literal> would report <VarName>x</VarName> and <VarName>y</VarName> as unused.  To eliminate the warning,
 699 all unused variables can be replaced with wildcards.
 700 </Para>
 701 </ListItem>
 702 </VarListEntry>
 703
 704 <VarListEntry>
 705 <Term><Option>-fwarn-duplicate-exports</Option>:</Term>
 706 <ListItem>
 707 <Para>
 708 <IndexTerm><Primary>-fwarn-duplicate-exports option</Primary></IndexTerm>
 709 <IndexTerm><Primary>duplicate exports, warning</Primary></IndexTerm>
 710 <IndexTerm><Primary>export lists, duplicates</Primary></IndexTerm>
 711 Have the compiler warn about duplicate entries in export lists. This
 712 is useful information if you maintain large export lists, and want to
 713 avoid the continued export of a definition after you've deleted (one)
 714 mention of it in the export list.
 715 </Para>
 716
 717 <Para>
 718 This option is on by default.
 719 </Para>
 720 </ListItem>
 721 </VarListEntry>
 722
 723 <VarListEntry>
 724 <Term><Option>-fwarn-type-defaults</Option>:</Term>
 725 <ListItem>
 726 <Para>
 727 <IndexTerm><Primary>-fwarn-type-defaults option</Primary></IndexTerm>
 728 <IndexTerm><Primary>defaulting mechanism, warning</Primary></IndexTerm>
 729 Have the compiler warn/inform you where in your source the Haskell
 730 defaulting mechanism for numeric types kicks in. This is useful
 731 information when converting code from a context that assumed one
 732 default into one with another, e.g., the `default default' for Haskell
 733 1.4 caused the otherwise unconstrained value <Constant>1</Constant> to be given
 734 the type <Literal>Int</Literal>, whereas Haskell 98 defaults it to
 735 <Literal>Integer</Literal>.  This may lead to differences in performance and
 736 behaviour, hence the usefulness of being non-silent about this.
 737 </Para>
 738
 739 <Para>
 740 This warning is off by default.
 741 </Para>
 742 </ListItem>
 743 </VarListEntry>
 744
 745 <VarListEntry>
 746 <Term><Option>-fwarn-missing-signatures</Option>:</Term>
 747 <ListItem>
 748 <Para>
 749 <IndexTerm><Primary>-fwarn-missing-signatures option</Primary></IndexTerm>
 750 <IndexTerm><Primary>type signatures, missing</Primary></IndexTerm>
 751 If you would like GHC to check that every top-level function/value has
 752 a type signature, use the <Option>-fwarn-missing-signatures</Option> option.  This
 753 option is off by default.
 754 </Para>
 755 </ListItem>
 756 </VarListEntry>
 757 </VariableList>
 758 </Para>
 759
 760 <Para>
 761 If you're feeling really paranoid, the <Option>-dcore-lint</Option>
 762 option<IndexTerm><Primary>-dcore-lint option</Primary></IndexTerm> is a good choice.  It turns on
 763 heavyweight intra-pass sanity-checking within GHC.  (It checks GHC's
 764 sanity, not yours.)
 765 </Para>
 766
 767 </Sect1>
 768
 769 <Sect1 id="separate-compilation">
 770 <Title>Separate compilation
 771 </Title>
 772
 773 <Para>
 774 <IndexTerm><Primary>separate compilation</Primary></IndexTerm>
 775 <IndexTerm><Primary>recompilation checker</Primary></IndexTerm>
 776 <IndexTerm><Primary>make and recompilation</Primary></IndexTerm>
 777 This section describes how GHC supports separate compilation.
 778 </Para>
 779
 780 <Sect2 id="hi-files">
 781 <Title>Interface files
 782 </Title>
 783
 784 <Para>
 785 <IndexTerm><Primary>interface files</Primary></IndexTerm>
 786 <IndexTerm><Primary>.hi files</Primary></IndexTerm>
 787 </Para>
 788
 789 <Para>
 790 When GHC compiles a source file <Filename>F</Filename> which contains a module <Literal>A</Literal>, say,
 791 it generates an object <Filename>F.o</Filename>, <Emphasis>and</Emphasis> a companion <Emphasis>interface
 792 file</Emphasis> <Filename>A.hi</Filename>.  The interface file is not intended for human
 793 consumption, as you'll see if you take a look at one.  It's merely
 794 there to help the compiler compile other modules in the same program.
 795 </Para>
 796
 797 <Para>
 798 NOTE: Having the name of the interface file follow the module name and
 799 not the file name, means that working with tools such as <Command>make</Command>
 800 become harder. <Command>make</Command> implicitly assumes that any output files
 801 produced by processing a translation unit will have file names that
 802 can be derived from the file name of the translation unit.  For
 803 instance, pattern rules becomes unusable.  For this reason, we
 804 recommend you stick to using the same file name as the module name.
 805 </Para>
 806
 807 <Para>
 808 The interface file for <Literal>A</Literal> contains information needed by the compiler
 809 when it compiles any module <Literal>B</Literal> that imports <Literal>A</Literal>, whether directly or
 810 indirectly.  When compiling <Literal>B</Literal>, GHC will read <Filename>A.hi</Filename> to find the
 811 details that it needs to know about things defined in <Literal>A</Literal>.
 812 </Para>
 813
 814 <Para>
 815 Furthermore, when compiling module <Literal>C</Literal> which imports <Literal>B</Literal>, GHC may
 816 decide that it needs to know something about <Literal>A</Literal>&mdash;for example, <Literal>B</Literal>
 817 might export a function that involves a type defined in <Literal>A</Literal>.  In this
 818 case, GHC will go and read <Command>A.hi</Command> even though <Literal>C</Literal> does not explicitly
 819 import <Literal>A</Literal> at all.
 820 </Para>
 821
 822 <Para>
 823 The interface file may contain all sorts of things that aren't
 824 explicitly exported from <Literal>A</Literal> by the programmer.  For example, even
 825 though a data type is exported abstractly, <Filename>A.hi</Filename> will contain the
 826 full data type definition.  For small function definitions, <Filename>A.hi</Filename>
 827 will contain the complete definition of the function.  For bigger
 828 functions, <Filename>A.hi</Filename> will contain strictness information about the
 829 function.  And so on.  GHC puts much more information into <Filename>.hi</Filename> files
 830 when optimisation is turned on with the <Option>-O</Option> flag.  Without <Option>-O</Option> it
 831 puts in just the minimum; with <Option>-O</Option> it lobs in a whole pile of stuff.
 832 <IndexTerm><Primary>optimsation, effect on .hi files</Primary></IndexTerm>
 833 </Para>
 834
 835 <Para>
 836 <Filename>A.hi</Filename> should really be thought of as a compiler-readable version of
 837 <Filename>A.o</Filename>.  If you use a <Filename>.hi</Filename> file that wasn't generated by the same
 838 compilation run that generates the <Filename>.o</Filename> file the compiler may assume
 839 all sorts of incorrect things about <Literal>A</Literal>, resulting in core dumps and
 840 other unpleasant happenings.
 841 </Para>
 842
 843 </Sect2>
 844
 845 <Sect2 id="options-finding-imports">
 846 <Title>Finding interface files
 847 </Title>
 848
 849 <Para>
 850 <IndexTerm><Primary>interface files, finding them</Primary></IndexTerm>
 851 <IndexTerm><Primary>finding interface files</Primary></IndexTerm>
 852 </Para>
 853
 854 <Para>
 855 In your program, you import a module <Literal>Foo</Literal> by saying
 856 <Literal>import Foo</Literal>.  GHC goes looking for an interface file, <Filename>Foo.hi</Filename>.
 857 It has a builtin list of directories (notably including <Filename>.</Filename>) where
 858 it looks.
 859 </Para>
 860
 861 <Para>
 862 <VariableList>
 863
 864 <VarListEntry>
 865 <Term><Option>-i&lt;dirs&gt;</Option></Term>
 866 <ListItem>
 867 <Para>
 868 <IndexTerm><Primary>-i&lt;dirs&gt; option</Primary></IndexTerm>This flag
 869 prepends a colon-separated list of <Filename>dirs</Filename> to the &ldquo;import
 870 directories&rdquo; list.
 871 See also <XRef LinkEnd="recomp"> for the significance of using
 872 relative and absolute pathnames in the <Option>-i</Option> list.
 873 </Para>
 874 </ListItem>
 875 </VarListEntry>
 876
 877 <VarListEntry>
 878 <Term><Option>-i</Option></Term>
 879 <ListItem>
 880 <Para>
 881 resets the &ldquo;import directories&rdquo; list back to nothing.
 882 </Para>
 883 </ListItem>
 884 </VarListEntry>
 885
 886 <VarListEntry>
 887 <Term><Option>-fno-implicit-prelude</Option></Term>
 888 <ListItem>
 889 <Para>
 890 <IndexTerm><Primary>-fno-implicit-prelude option</Primary></IndexTerm>
 891 GHC normally imports <Filename>Prelude.hi</Filename> files for you.  If you'd rather it
 892 didn't, then give it a <Option>-fno-implicit-prelude</Option> option.
 893 The idea is that you can then import a Prelude of your own.  (But don't call it <Literal>Prelude</Literal>;
 894 the Haskell module namespace is flat, and you must not conflict with any Prelude module.)
 895 </Para>
 896 <Para>
 897 Even though you have not imported the Prelude, all the built-in syntax still refers to
 898 the built-in Haskell Prelude types and values, as specified by the Haskell Report.
 899 For example, the type <Literal>[Int]</Literal>
 900 still means <Literal>Prelude.[] Int</Literal>; tuples continue to refer to the standard Prelude
 901 tuples; the translation for list comprehensions continues to use <Literal>Prelude.map</Literal> etc.
 902 </Para>
 903 <Para> With one group of exceptions!  You may want to define your own numeric class hierarchy.
 904 It completely defeats that purpose if the literal "1" means "<Literal>Prelude.fromInteger 1</Literal>",
 905 which is what the Haskell Report specifies.  So the <Option>-fno-implicit-prelude</Option> flag causes
 906 the following pieces of built-in syntax to refer to whatever is in scope, not the Prelude versions:
 907 <ItemizedList>
 908 <ListItem>
 909 Integer and fractional literals mean "<Literal>fromInteger 1</Literal>" and "<Literal>fromRational 3.2</Literal>",
 910 not the Prelude-qualified versions; both in expressions and in patterns.
 911 </ListItem>
 912 <ListItem>
 913 Negation (e.g. "<Literal>- (f x)</Literal>") means "<Literal>negate (f x)</Literal>" (not <Literal>Prelude.negate</Literal>).
 914 </ListItem>
 915 <ListItem>
 916 In an n+k pattern, the standard Prelude <Literal>OrdK/Literal> class is used for comparison, but the
 917 necessary subtraction uses
 918 whatever "<Literal>(-)</Literal>" is in scope (not "<Literal>Prelude.(-)</Literal>").
 919 </ListItem>
 920 </ItemizedList>
 921 </Para>
 922 </ListItem>
 923 </VarListEntry>
 924
 925 <VarListEntry>
 926 <Term><Option>-I&lt;dir&gt;</Option></Term>
 927 <ListItem>
 928 <Para>
 929 <IndexTerm><Primary>-I&lt;dir&gt; option</Primary></IndexTerm>
 930 Once a Haskell module has been compiled to C (<Filename>.hc</Filename> file), you may
 931 wish to specify where GHC tells the C compiler to look for <Filename>.h</Filename> files.
 932 (Or, if you are using the <Option>-cpp</Option> option<IndexTerm><Primary>-cpp option</Primary></IndexTerm>, where
 933 it tells the C pre-processor to look&hellip;)  For this purpose, use a <Option>-I</Option>
 934 option in the usual C-ish way.
 935 </Para>
 936 </ListItem>
 937 </VarListEntry>
 938
 939 </VariableList>
 940 </Para>
 941
 942 </Sect2>
 943
 944 <Sect2 id="hi-options">
 945 <Title>Other options related to interface files
 946 </Title>
 947
 948 <Para>
 949 <IndexTerm><Primary>interface files, options</Primary></IndexTerm>
 950 The interface output may be directed to another file
 951 <Filename>bar2/Wurble.iface</Filename> with the option <Option>-ohi bar2/Wurble.iface</Option><IndexTerm><Primary>-ohi
 952 &lt;file&gt; option</Primary></IndexTerm> (not recommended).
 953 </Para>
 954
 955 <Para>
 956 To avoid generating an interface file at all, use a <Option>-nohi</Option>
 957 option.<IndexTerm><Primary>-nohi option</Primary></IndexTerm>
 958 </Para>
 959
 960 <Para>
 961 The compiler does not overwrite an existing <Filename>.hi</Filename> interface file if
 962 the new one is byte-for-byte the same as the old one; this is friendly
 963 to <Command>make</Command>.  When an interface does change, it is often enlightening to
 964 be informed.  The <Option>-hi-diffs</Option><IndexTerm><Primary>-hi-diffs option</Primary></IndexTerm> option will
 965 make GHC run <Command>diff</Command> on the old and new <Filename>.hi</Filename> files. You can also
 966 record the difference in the interface file itself, the
 967 <Option>-keep-hi-diffs</Option><IndexTerm><Primary>-keep-hi-diffs</Primary></IndexTerm> option takes care of that.
 968 </Para>
 969
 970 <Para>
 971 The <Filename>.hi</Filename> files from GHC contain &ldquo;usage&rdquo; information which changes
 972 often and uninterestingly.  If you really want to see these changes
 973 reported, you need to use the
 974 <Option>-hi-diffs-with-usages</Option><IndexTerm><Primary>-hi-diffs-with-usages option</Primary></IndexTerm>
 975 option.
 976 </Para>
 977
 978 <Para>
 979 Interface files are normally jammed full of compiler-produced
 980 <Emphasis>pragmas</Emphasis>, which record arities, strictness info, etc.  If you
 981 think these pragmas are messing you up (or you are doing some kind of
 982 weird experiment), you can tell GHC to ignore them with the
 983 <Option>-fignore-interface-pragmas</Option><IndexTerm><Primary>-fignore-interface-pragmas
 984 option</Primary></IndexTerm> option.
 985 </Para>
 986
 987 <Para>
 988 When compiling without optimisations on, the compiler is extra-careful
 989 about not slurping in data constructors and instance declarations that
 990 it will not need. If you believe it is getting it wrong and not
 991 importing stuff which you think it should, this optimisation can be
 992 turned off with <Option>-fno-prune-tydecls</Option> and <Option>-fno-prune-instdecls</Option>.
 993 <IndexTerm><Primary>-fno-prune-tydecls option</Primary></IndexTerm><IndexTerm><Primary>-fno-prune-instdecls
 994 option</Primary></IndexTerm>
 995 </Para>
 996
 997 <Para>
 998 See also <XRef LinkEnd="options-linker">, which describes how the linker finds standard
 999 Haskell libraries.
1000 </Para>
1001
1002 </Sect2>
1003
1004 <Sect2 id="recomp">
1005 <Title>The recompilation checker
1006 </Title>
1007
1008 <IndexTerm><Primary>recompilation checker</Primary></IndexTerm>
1009
1010 <Para>
1011 <variablelist>
1012 <VarListEntry>
1013 <Term><Option>-recomp</Option></Term>
1014 <IndexTerm><Primary><option>-recomp</option> option</Primary></IndexTerm>
1015 <ListItem>
1016 <Para>
1017 (On by default) Turn on recompilation checking.  This will stop
1018 compilation early, leaving an existing <filename>.o</filename> file in
1019 place, if it can be determined that the module does not need to be
1020 recompiled.
1021 </Para>
1022 </ListItem>
1023 </VarListEntry>
1024 <VarListEntry>
1025 <Term><Option>-no-recomp</Option></Term>
1026 <IndexTerm><Primary><option>-recomp</option> option</Primary></IndexTerm>
1027 <ListItem>
1028 <Para>
1029 Turn off recompilation checking.
1030 </Para>
1031 </ListItem>
1032 </VarListEntry>
1033 </VariableList>
1034 </Para>
1035
1036 <Para>
1037 In the olden days, GHC compared the newly-generated
1038 <Filename>.hi</Filename> file with the previous version; if they were
1039 identical, it left the old one alone and didn't change its
1040 modification date.  In consequence, importers of a module with an
1041 unchanged output <Filename>.hi</Filename> file were not recompiled.
1042 </Para>
1043
1044 <Para>
1045 This doesn't work any more.  In our earlier example, module
1046 <Literal>C</Literal> does not import module <Literal>A</Literal>
1047 directly, yet changes to <Filename>A.hi</Filename> should force a
1048 recompilation of <Literal>C</Literal>.  And some changes to
1049 <Literal>A</Literal> (changing the definition of a function that
1050 appears in an inlining of a function exported by <Literal>B</Literal>,
1051 say) may conceivably not change <Filename>B.hi</Filename> one jot.  So
1052 now&hellip;
1053 </Para>
1054
1055 <Para>
1056 GHC keeps a version number on each interface file, and on each type
1057 signature within the interface file.  It also keeps in every interface
1058 file a list of the version numbers of everything it used when it last
1059 compiled the file.  If the source file's modification date is earlier
1060 than the <Filename>.o</Filename> file's date (i.e. the source hasn't
1061 changed since the file was last compiled), and the
1062 <option>-recomp</option> is given on the command line, GHC will be
1063 clever.  It compares the version numbers on the things it needs this
1064 time with the version numbers on the things it needed last time
1065 (gleaned from the interface file of the module being compiled); if
1066 they are all the same it stops compiling rather early in the process
1067 saying &ldquo;Compilation IS NOT required&rdquo;.  What a beautiful
1068 sight!
1069 </Para>
1070
1071 <Para>
1072 Patrick Sansom had a workshop paper about how all this is done (though
1073 the details have changed quite a bit). <ULink URL="mailto:sansom@dcs.gla.ac.uk">Ask him</ULink> if you want a copy.
1074 </Para>
1075
1076 </Sect2>
1077
1078
1079 <Sect2 id="using-make">
1080 <Title>Using <Command>make</Command>
1081 </Title>
1082
1083 <Para>
1084 <IndexTerm><Primary><literal>make</literal></Primary></IndexTerm>
1085 </Para>
1086
1087 <Para>
1088 It is reasonably straightforward to set up a <Filename>Makefile</Filename> to use with GHC, assuming you name your source files the same as your modules.
1089 Thus:
1090 </Para>
1091
1092 <Para>
1093
1094 <ProgramListing>
1095 HC      = ghc
1096 HC_OPTS = -cpp $(EXTRA_HC_OPTS)
1097
1098 SRCS = Main.lhs Foo.lhs Bar.lhs
1099 OBJS = Main.o   Foo.o   Bar.o
1100
1101 .SUFFIXES : .o .hs .hi .lhs .hc .s
1102
1103 cool_pgm : $(OBJS)
1104         rm $@
1105         $(HC) -o $@ $(HC_OPTS) $(OBJS)
1106
1107 # Standard suffix rules
1108 .o.hi:
1109         @:
1110
1111 .lhs.o:
1112         $(HC) -c $&#60; $(HC_OPTS)
1113
1114 .hs.o:
1115         $(HC) -c $&#60; $(HC_OPTS)
1116
1117 # Inter-module dependencies
1118 Foo.o Foo.hc Foo.s    : Baz.hi          # Foo imports Baz
1119 Main.o Main.hc Main.s : Foo.hi Baz.hi   # Main imports Foo and Baz
1120 </ProgramListing>
1121
1122 </Para>
1123
1124 <Para>
1125 (Sophisticated <Command>make</Command> variants may achieve some of the above more
1126 elegantly.  Notably, <Command>gmake</Command>'s pattern rules let you write the more
1127 comprehensible:
1128 </Para>
1129
1130 <Para>
1131
1132 <ProgramListing>
1133 %.o : %.lhs
1134         $(HC) -c $&#60; $(HC_OPTS)
1135 </ProgramListing>
1136
1137 </Para>
1138
1139 <Para>
1140 What we've shown should work with any <Command>make</Command>.)
1141 </Para>
1142
1143 <Para>
1144 Note the cheesy <Literal>.o.hi</Literal> rule: It records the dependency of the
1145 interface (<Filename>.hi</Filename>) file on the source.  The rule says a <Filename>.hi</Filename> file can
1146 be made from a <Filename>.o</Filename> file by doing&hellip;nothing.  Which is true.
1147 </Para>
1148
1149 <Para>
1150 Note the inter-module dependencies at the end of the Makefile, which
1151 take the form
1152 </Para>
1153
1154 <Para>
1155
1156 <ProgramListing>
1157 Foo.o Foo.hc Foo.s    : Baz.hi          # Foo imports Baz
1158 </ProgramListing>
1159
1160 </Para>
1161
1162 <Para>
1163 They tell <Command>make</Command> that if any of <Literal>Foo.o</Literal>, <Literal>Foo.hc</Literal> or <Literal>Foo.s</Literal> have an
1164 earlier modification date than <Literal>Baz.hi</Literal>, then the out-of-date file
1165 must be brought up to date.  To bring it up to date, <Literal>make</Literal> looks for
1166 a rule to do so; one of the preceding suffix rules does the job
1167 nicely.
1168 </Para>
1169
1170     </sect2>
1171
1172     <sect2 id="sec-makefile-dependencies">
1173       <title>Dependency generation</title>
1174       <indexterm><primary>dependencies in Makefiles</primary></indexterm>
1175       <indexterm><primary>Makefile dependencies</primary></indexterm>
1176
1177       <para>Putting inter-dependencies of the form <Literal>Foo.o :
1178       Bar.hi</Literal> into your <Filename>Makefile</Filename> by hand
1179       is rather error-prone.  Don't worry, GHC has support for
1180       automatically generating the required dependencies.  Add the
1181       following to your <Filename>Makefile</Filename>:</para>
1182
1183 <ProgramListing>
1184 depend :
1185         ghc -M $(HC_OPTS) $(SRCS)
1186 </ProgramListing>
1187
1188       <para>Now, before you start compiling, and any time you change
1189       the <Literal>imports</Literal> in your program, do <Command>make
1190       depend</Command> before you do <Command>make
1191       cool&lowbar;pgm</Command>.  <Command>ghc -M</Command> will append
1192       the needed dependencies to your
1193       <Filename>Makefile</Filename>.</Para>
1194
1195       <para>In general, if module <Literal>A</Literal> contains the
1196       line
1197
1198 <programlisting>
1199 import B ...blah...
1200 </programlisting>
1201
1202        then <command>ghc -M</command> will generate a dependency
1203        line of the form:
1204
1205 <programlisting>
1206 A.o : B.hi
1207 </programlisting>
1208
1209        If module <literal>A</literal> contains the line
1210
1211 <programlisting>
1212 import {-# SOURCE #-} B ...blah...
1213 </programlisting>
1214
1215        then <command>ghc -M</command> will generate a dependency
1216        line of the form:
1217
1218 <programlisting>
1219 A.o : B.hi-boot
1220 </programlisting>
1221
1222        (See <xref linkend="hi-files"> for details of interface files.)
1223        If <literal>A</literal> imports multiple modules, then there
1224        will be multiple lines with <filename>A.o</filename> as the
1225        target.</para>
1226
1227       <para>By default, <Command>ghc -M</Command> generates all the
1228       dependencies, and then concatenates them onto the end of
1229       <Filename>makefile</Filename> (or <Filename>Makefile</Filename>
1230       if <Filename>makefile</Filename> doesn't exist) bracketed by the
1231       lines "<Literal>&num; DO NOT DELETE: Beginning of Haskell
1232       dependencies</Literal>" and "<Literal>&num; DO NOT DELETE: End
1233       of Haskell dependencies</Literal>".  If these lines already
1234       exist in the <Filename>makefile</Filename>, then the old
1235       dependencies are deleted first.</para>
1236
1237       <para>Internally, GHC uses a script to generate the
1238       dependencies, called <command>mkdependHS</command>.  This script
1239       has some options of its own, which you might find useful.
1240       Options can be passed directly to <command>mkdependHS</command>
1241       with GHC's <literal>-optdep</literal> option.  For example, to
1242       generate the dependencies into a file called
1243       <literal>.depend</literal> instead of
1244       <literal>Makefile</literal>:</para>
1245
1246 <screen>
1247 ghc -M -optdep-f optdep.depend ...
1248 </screen>
1249
1250       <para>The full list of options accepted by
1251       <command>mkdependHS</command> is:</para>
1252
1253       <variablelist>
1254
1255         <varlistentry>
1256           <term><option>-w</option></term>
1257           <listitem>
1258             <para>Turn off warnings about interface file shadowing.</para>
1259           </listitem>
1260         </varlistentry>
1261
1262         <varlistentry>
1263           <term><option>-f blah</option></term>
1264           <listitem>
1265             <para>Use <Filename>blah</Filename> as the makefile,
1266             rather than <Filename>makefile</Filename> or
1267             <Filename>Makefile</Filename>.  If
1268             <Filename>blah</Filename> doesn't exist,
1269             <Command>mkdependHS</Command> creates it.  We often use
1270             <Option>-f .depend</Option> to put the dependencies in
1271             <Filename>.depend</Filename> and then
1272             <Command>include</Command> the file
1273             <Filename>.depend</Filename> into
1274             <Filename>Makefile</Filename>.</para>
1275           </listitem>
1276         </varlistentry>
1277
1278         <varlistentry>
1279           <term><option>-o &lt;osuf&gt;</option></term>
1280           <listitem>
1281             <para>Use <Filename>.&lt;osuf&gt;</Filename> as the
1282             "target file" suffix ( default: <Literal>o</Literal>).
1283             Multiple <Option>-o</Option> flags are permitted (GHC2.05
1284             onwards).  Thus "<Option>-o hc -o o</Option>" will
1285             generate dependencies for <Filename>.hc</Filename> and
1286             <Filename>.o</Filename> files.</para>
1287           </listitem>
1288         </varlistentry>
1289
1290         <varlistentry>
1291           <term><option>-s &lt;suf&gt;</option></term>
1292           <listitem>
1293             <para>Make extra dependencies that declare that files with
1294             suffix
1295             <Filename>.&lt;suf&gt;&lowbar;&lt;osuf&gt;</Filename>
1296             depend on interface files with suffix
1297             <Filename>.&lt;suf&gt;&lowbar;hi</Filename>, or (for
1298             <Literal>&lcub;-&num; SOURCE &num;-&rcub;</Literal>
1299             imports) on <Filename>.hi-boot</Filename>.  Multiple
1300             <Option>-s</Option> flags are permitted.  For example,
1301             <Option>-o hc -s a -s b</Option> will make dependencies
1302             for <Filename>.hc</Filename> on <Filename>.hi</Filename>,
1303             <Filename>.a&lowbar;hc</Filename> on
1304             <Filename>.a&lowbar;hi</Filename>, and
1305             <Filename>.b&lowbar;hc</Filename> on
1306             <Filename>.b&lowbar;hi</Filename>.  (Useful in conjunction
1307             with NoFib "ways".)</para>
1308           </listitem>
1309         </varlistentry>
1310
1311         <varlistentry>
1312           <term><option>--exclude-module=&lt;file&gt;</option></term>
1313           <listitem>
1314             <para>Regard <Filename>&lt;file&gt;</Filename> as
1315             "stable"; i.e., exclude it from having dependencies on
1316             it.</para>
1317           </listitem>
1318         </varlistentry>
1319
1320         <varlistentry>
1321           <term><option>-x</option></term>
1322           <listitem>
1323             <para>same as <option>--exclude-module</option></para>
1324           </listitem>
1325         </varlistentry>
1326
1327         <varlistentry>
1328           <term><option>--exclude-directory=&lt;dirs&gt;</option></term>
1329           <listitem>
1330             <para>Regard the colon-separated list of directories
1331             <Filename>&lt;dirs&gt;</Filename> as containing stable,
1332             don't generate any dependencies on modules therein.</para>
1333           </listitem>
1334         </varlistentry>
1335
1336         <varlistentry>
1337           <term><option>-xdirs</option></term>
1338           <listitem>
1339             <para>same as <Option>--exclude-directory</Option>.</para>
1340           </listitem>
1341         </varlistentry>
1342
1343         <varlistentry>
1344           <term><option>--include-module=&lt;file&gt;</option></term>
1345           <listitem>
1346             <para>Regard <Filename>&lt;file&gt;</Filename> as not
1347             "stable"; i.e., generate dependencies on it (if any). This
1348             option is normally used in conjunction with the
1349             <Option>--exclude-directory</Option> option.</para>
1350           </listitem>
1351         </varlistentry>
1352
1353         <varlistentry>
1354           <term><option>--include-prelude</option></term>
1355           <listitem>
1356             <para>Regard prelude libraries as unstable, i.e., generate
1357             dependencies on the prelude modules used (including
1358             <Literal>Prelude</Literal>).  This option is normally only
1359             used by the various system libraries. If a
1360             <Option>-package</Option> option is used, dependencies will
1361             also be generated on the library's interfaces.</para>
1362           </listitem>
1363         </varlistentry>
1364       </variablelist>
1365
1366 </Sect2>
1367
1368 <Sect2 id="mutual-recursion">
1369 <Title>How to compile mutually recursive modules
1370 </Title>
1371
1372 <Para>
1373 <IndexTerm><Primary>module system, recursion</Primary></IndexTerm>
1374 <IndexTerm><Primary>recursion, between modules</Primary></IndexTerm>
1375 </Para>
1376
1377 <Para>
1378 Currently, the compiler does not have proper support for dealing with
1379 mutually recursive modules:
1380 </Para>
1381
1382 <Para>
1383
1384 <ProgramListing>
1385 module A where
1386
1387 import B
1388
1389 newtype TA = MkTA Int
1390
1391 f :: TB -&#62; TA
1392 f (MkTB x) = MkTA x
1393 --------
1394 module B where
1395
1396 import A
1397
1398 data TB = MkTB !Int
1399
1400 g :: TA -&#62; TB
1401 g (MkTA x) = MkTB x
1402 </ProgramListing>
1403
1404 </Para>
1405
1406 <Para>
1407 When compiling either module A and B, the compiler will try (in vain)
1408 to look for the interface file of the other. So, to get mutually
1409 recursive modules off the ground, you need to hand write an interface
1410 file for A or B, so as to break the loop.  These hand-written
1411 interface files are called <Literal>hi-boot</Literal> files, and are placed in a file
1412 called <Filename>&lt;module&gt;.hi-boot</Filename>.  To import from an <Literal>hi-boot</Literal> file instead
1413 of the standard <Filename>.hi</Filename> file, use the following syntax in the importing module:
1414 <IndexTerm><Primary>hi-boot files</Primary></IndexTerm>
1415 <IndexTerm><Primary>importing, hi-boot files</Primary></IndexTerm>
1416 </Para>
1417
1418 <Para>
1419
1420 <ProgramListing>
1421 import {-# SOURCE #-} A
1422 </ProgramListing>
1423
1424 </Para>
1425
1426 <Para>
1427 The hand-written interface need only contain the bare minimum of
1428 information needed to get the bootstrapping process started.  For
1429 example, it doesn't need to contain declarations for <Emphasis>everything</Emphasis>
1430 that module <Literal>A</Literal> exports, only the things required by the module that
1431 imports <Literal>A</Literal> recursively.
1432 </Para>
1433
1434 <Para>
1435 For the example at hand, the boot interface file for A would look like
1436 the following:
1437 </Para>
1438
1439 <Para>
1440
1441 <ProgramListing>
1442 __interface A 1 404 where
1443 __export A TA{MkTA} ;
1444 1 newtype TA = MkTA PrelBase.Int ;
1445 </ProgramListing>
1446
1447 </Para>
1448
1449 <Para>
1450 The syntax is essentially the same as a normal <Filename>.hi</Filename> file
1451 (unfortunately), but you can usually tailor an existing <Filename>.hi</Filename> file to
1452 make a <Filename>.hi-boot</Filename> file.
1453 </Para>
1454
1455 <Para>
1456 Notice that we only put the declaration for the newtype <Literal>TA</Literal> in the
1457 <Literal>hi-boot</Literal> file, not the signature for <Function>f</Function>, since <Function>f</Function> isn't used by
1458 <Literal>B</Literal>.
1459 </Para>
1460
1461 <Para>
1462 The number &ldquo;1&rdquo; after &ldquo;&lowbar;&lowbar;interface A&rdquo; gives the version number of module A;
1463 it is incremented whenever anything in A's interface file changes.  The &ldquo;404&rdquo; is
1464 the version number of the interface file <Emphasis>syntax</Emphasis>; we change it when
1465 we change the syntax of interface files so that you get a better error message when
1466 you try to read an old-format file with a new-format compiler.
1467 </Para>
1468
1469 <Para>
1470 The number &ldquo;1&rdquo; at the beginning of a declaration is the <Emphasis>version
1471 number</Emphasis> of that declaration: for the purposes of <Filename>.hi-boot</Filename> files
1472 these can all be set to 1.  All names must be fully qualified with the
1473 <Emphasis>original</Emphasis> module that an object comes from: for example, the
1474 reference to <Literal>Int</Literal> in the interface for <Literal>A</Literal> comes from <Literal>PrelBase</Literal>,
1475 which is a module internal to GHC's prelude.  It's a pain, but that's
1476 the way it is.
1477 </Para>
1478
1479 <Para>
1480 If you want an hi-boot file to export a data type, but you don't want to give its constructors
1481 (because the constructors aren't used by the SOURCE-importing module), you can write simply:
1482 </Para>
1483
1484 <Para>
1485
1486 <ProgramListing>
1487 __interface A 1 404 where
1488 __export A TA;
1489 1 data TA
1490 </ProgramListing>
1491
1492 </Para>
1493
1494 <Para>
1495 (You must write all the type parameters, but leave out the '=' and everything that follows it.)
1496 </Para>
1497
1498 <Para>
1499 <Emphasis>Note:</Emphasis> This is all a temporary solution, a version of the
1500 compiler that handles mutually recursive modules properly without the manual
1501 construction of interface files, is (allegedly) in the works.
1502 </Para>
1503
1504 </Sect2>
1505
1506 </Sect1>
1507
1508   <sect1 id="packages">
1509     <title>Packages</title>
1510     <indexterm><primary>packages</primary></indexterm>
1511
1512     <para>Packages are collections of libraries, conveniently grouped
1513     together as a single entity.  The package system is flexible: a
1514     package may consist of Haskell code, foreign language code (eg. C
1515     libraries), or a mixture of the two.  A package is a good way to
1516     group together related Haskell modules, and is essential if you
1517     intend to make the modules into a Windows DLL (see below).</para>
1518
1519     <para>Because packages can contain both Haskell and C libraries, they
1520     are also a good way to provide convenient access to a Haskell
1521     layer over a C library.</para>
1522
1523     <para>GHC comes with several packages (see <xref
1524     linkend="book-hslibs">), and packages can be added/removed from an
1525     existing GHC installation.</para>
1526
1527     <sect2 id="listing-packages">
1528       <title>Listing the available packages</title>
1529       <indexterm><primary>packages</primary>
1530         <secondary>listing</secondary></indexterm>
1531
1532       <para>To see what packages are currently installed, use the
1533       <literal>--list-packages</literal> option:</para>
1534       <indexterm><primary><literal>--list-packages</literal></primary>
1535       </indexterm>
1536
1537 <screen>
1538   $ ghc --list-packages
1539   gmp, rts, std, lang, concurrent, data, net, posix, text, util
1540 </screen>
1541
1542       <para>Note that your GHC installation might have a slightly
1543       different set of packages installed.</para>
1544
1545       <para>The <literal>gmp</literal> and <literal>rts</literal>
1546       packages are always present, and represent the multi-precision
1547       integer and runtime system libraries respectively.  The
1548       <literal>std</literal> package contains the Haskell prelude.
1549       The rest of the packages are optional libraries.</para>
1550
1551     </sect2>
1552
1553     <sect2 id="using-packages">
1554       <title>Using a package</title>
1555       <indexterm><primary>packages</primary>
1556         <secondary>using</secondary></indexterm>
1557
1558       <para>To use a package, add the <literal>-package</literal> flag
1559       to the command line:</para>
1560
1561       <variablelist>
1562         <varlistentry>
1563           <term><option>-package &lt;lib&gt;</option></term>
1564           <indexterm><primary>-package &lt;lib&gt; option</primary></indexterm>
1565           <listitem>
1566             <para>This option brings into scope all the modules from
1567             package <literal>&lt;lib&gt;</literal> (they still have to
1568             be imported in your Haskell source, however).  It also
1569             causes the relevant libraries to be linked when linking is
1570             being done.</para>
1571           </listitem>
1572         </varlistentry>
1573       </variablelist>
1574
1575       <para>Some packages depend on other packages, for example the
1576       <literal>text</literal> package makes use of some of the modules
1577       in the <literal>lang</literal> package.  The package system
1578       takes care of all these dependencies, so that when you say
1579       <literal>-package text</literal> on the command line, you
1580       automatically get <literal>-package lang</literal> too.</para>
1581     </sect2>
1582
1583     <sect2 id="building-packages">
1584       <title>Building a package from Haskell source</title>
1585       <indexterm><primary>packages</primary>
1586         <secondary>building</secondary></indexterm>
1587
1588       <para>It takes some special considerations to build a new
1589       package:</para>
1590
1591       <itemizedlist>
1592         <listitem>
1593           <para>A package may contain several Haskell modules. A
1594           package may span many directories, or many packages may
1595           exist in a single directory. Packages may not be mutually
1596           recursive.</para>
1597         </listitem>
1598
1599         <listitem>
1600           <para>A package has a name
1601           (e.g. <filename>std</filename>)</para>
1602         </listitem>
1603
1604         <listitem>
1605           <para>The Haskell code in a package may be built into one or
1606           more Unix libraries (e.g. <Filename>libHSfoo.a</Filename>),
1607           or a single DLL on Windows
1608           (e.g. <Filename>HSfoo.dll</Filename>).  The restriction to a
1609           single DLL on Windows is that the package system is used to
1610           tell the compiler when it should make an inter-DLL call
1611           rather than an intra-DLL call (inter-DLL calls require an
1612           extra indirection).</para>
1613         </listitem>
1614
1615         <listitem>
1616           <para>GHC does not maintain detailed cross-package
1617           dependency information.  It does remember which modules in
1618           other packages the current module depends on, but not which
1619           things within those imported things.</para>
1620         </listitem>
1621       </itemizedlist>
1622
1623       <para>To compile a module which is to be part of a new package,
1624       use the <literal>-package-name</literal> option:</para>
1625
1626       <variablelist>
1627         <varlistentry>
1628           <term><option>-package-name &lt;foo&gt;</option></term>
1629           <indexterm><primary><literal>-package-name</literal></primary>
1630             <secondary>option</secondary></indexterm>
1631           <listitem>
1632             <para>This option is added to the command line when
1633             compiling a module that is destined to be part of package
1634             <literal>foo</literal>.  If this flag is omitted then the
1635             default package <literal>Main</literal> is assumed.</para>
1636           </listitem>
1637         </varlistentry>
1638       </variablelist>
1639
1640       <para>Failure to use the <literal>-package-name</literal> option
1641       when compiling a package will result in disaster on Windows, but
1642       is relatively harmless on Unix at the moment (it will just cause
1643       a few extra dependencies in some interface files).  However,
1644       bear in mind that we might add support for Unix shared libraries
1645       at some point in the future.</para>
1646
1647       <para>It is worth noting that on Windows, because each package
1648       is built as a DLL, and a reference to a DLL costs an extra
1649       indirection, intra-package references are cheaper than
1650       inter-package references. Of course, this applies to the
1651       <Filename>Main</Filename> package as well.</para>
1652
1653     </sect2>
1654     <sect2 id="package-management">
1655       <title>Package management</title>
1656       <indexterm><primary>packages</primary>
1657         <secondary>management</secondary></indexterm>
1658
1659       <para>GHC uses a package configuration file, called
1660       <literal>packages.conf</literal>, which can be found in your GHC
1661       install directory.  This file isn't intended to be edited
1662       directly, instead GHC provides options for adding & removing
1663       packages:</para>
1664
1665       <variablelist>
1666         <varlistentry>
1667           <term><option>--add-package</option></term>
1668           <indexterm><primary><literal>--add-package</literal></primary>
1669               <secondary>option</secondary></indexterm>
1670           <listitem>
1671             <para>Reads a package specification (see below) on stdin,
1672             and adds it to the database of installed packages.  The
1673             package specification must be a package that isn't already
1674             installed.</para>
1675           </listitem>
1676         </varlistentry>
1677
1678         <varlistentry>
1679           <term><option>--delete-package &lt;foo&gt;</option></term>
1680           <indexterm><primary><literal>--delete-package</literal></primary>
1681               <secondary>option</secondary></indexterm>
1682           <listitem>
1683             <para>Removes the specified package from the installed
1684             configuration.</para>
1685           </listitem>
1686         </varlistentry>
1687       </variablelist>
1688
1689       <para>In both cases, the old package configuration file is saved
1690       in <literal>packages.conf.old</literal> in your GHC install
1691       directory, so in an emergency you can always copy this file into
1692       <literal>package.conf</literal> to restore the old
1693       settings.</para>
1694
1695       <para>A package specification looks like this:</para>
1696
1697 <screen>
1698   Package {
1699      name            = "mypkg",
1700      import_dirs     = ["/usr/local/lib/imports/mypkg"],
1701      library_dirs    = ["/usr/local/lib"],
1702      hs_libraries    = ["HSmypkg" ],
1703      extra_libraries = ["HSmypkg_cbits"],
1704      include_dirs    = [],
1705      c_includes      = ["HsMyPkg.h"],
1706      package_deps    = ["text", "data"],
1707      extra_ghc_opts  = [],
1708      extra_cc_opts   = [],
1709      extra_ld_opts   = ["-lmy_clib"]
1710   }
1711 </screen>
1712
1713       <para>Components of a package specification may be specified in
1714       any order, and are:</para>
1715
1716       <variablelist>
1717         <varlistentry>
1718           <term><literal>name</literal></term>
1719           <indexterm><primary><literal>name</literal></primary>
1720             <secondary>package specification</secondary></indexterm>
1721           <listitem>
1722             <para>The package's name, for use with
1723             the <literal>-package</literal> flag and as listed in the
1724             <literal>--list-packages</literal> list.
1725             </para>
1726           </listitem>
1727         </varlistentry>
1728
1729         <varlistentry>
1730           <term><literal>import_dirs</literal></term>
1731           <indexterm><primary><literal>import_dirs</literal></primary>
1732             <secondary>package specification</secondary></indexterm>
1733           <listitem>
1734             <para>A list of directories containing interface files
1735             (<literal>.hi</literal> files) for this package.</para>
1736           </listitem>
1737         </varlistentry>
1738
1739         <varlistentry>
1740           <term><literal>library_dirs</literal></term>
1741           <indexterm><primary><literal>library_dirs</literal></primary>
1742             <secondary>package specification</secondary></indexterm>
1743           <listitem>
1744             <para>A list of directories containing libraries for this
1745             package.</para>
1746           </listitem>
1747         </varlistentry>
1748
1749         <varlistentry>
1750           <term><literal>hs_libraries</literal></term>
1751           <indexterm><primary><literal>hs_libraries</literal></primary>
1752             <secondary>package specification</secondary></indexterm>
1753           <listitem>
1754             <para>A list of libraries containing Haskell code for this
1755             package, with the <literal>.a</literal> or
1756             <literal>.dll</literal> suffix omitted.  On Unix, the
1757             <literal>lib</literal> prefix is also omitted.</para>
1758           </listitem>
1759         </varlistentry>
1760
1761         <varlistentry>
1762           <term><literal>extra_libraries</literal></term>
1763           <indexterm><primary><literal>extra_libraries</literal></primary>
1764             <secondary>package specification</secondary></indexterm>
1765           <listitem>
1766             <para>A list of extra libraries for this package.  The
1767             difference between <literal>hs_libraries</literal> and
1768             <literal>extra_libraries</literal> is that
1769             <literal>hs_libraries</literal> normally have several
1770             versions, to support profiling, parallel and other build
1771             options.  The various versions are given different
1772             suffixes to distinguish them, for example the profiling
1773             version of the standard prelude library is named
1774             <filename>libHSstd_p.a</filename>, with the
1775             <literal>_p</literal> indicating that this is a profiling
1776             version.  The suffix is added automatically by GHC for
1777             <literal>hs_libraries</literal> only, no suffix is added
1778             for libraries in
1779             <literal>extra_libraries</literal>.</para>
1780
1781             <para>Also, <literal>extra_libraries</literal> are placed
1782             on the linker command line before the
1783             <literal>hs_libraries</literal> for the same package.  If
1784             your package has dependencies in the other direction, you
1785             might need to make two separate packages.</para>
1786           </listitem>
1787         </varlistentry>
1788
1789         <varlistentry>
1790           <term><literal>include_dirs</literal></term>
1791           <indexterm><primary><literal>include_dirs</literal></primary>
1792             <secondary>package specification</secondary></indexterm>
1793           <listitem>
1794             <para>A list of directories containing C includes for this
1795             package (maybe the empty list).</para>
1796           </listitem>
1797         </varlistentry>
1798
1799         <varlistentry>
1800           <term><literal>c_includes</literal></term>
1801           <indexterm><primary><literal>c_includes</literal></primary>
1802             <secondary>package specification</secondary></indexterm>
1803           <listitem>
1804             <para>A list of files to include for via-C compilations
1805             using this package.  Typically this include file will
1806             contain function prototypes for any C functions used in
1807             the package, in case they end up being called as a result
1808             of Haskell functions from the package being
1809             inlined.</para>
1810           </listitem>
1811         </varlistentry>
1812
1813         <varlistentry>
1814           <term><literal>package_deps</literal></term>
1815           <indexterm><primary><literal>package_deps</literal></primary>
1816             <secondary>package specification</secondary></indexterm>
1817           <listitem>
1818             <para>A list of packages which this package depends
1819             on.</para>
1820           </listitem>
1821         </varlistentry>
1822
1823         <varlistentry>
1824           <term><literal>extra_ghc_opts</literal></term>
1825           <indexterm><primary><literal>extra_ghc_opts</literal></primary>
1826             <secondary>package specification</secondary></indexterm>
1827           <listitem>
1828             <para>Extra arguments to be added to the GHC command line
1829             when this package is being used.</para>
1830           </listitem>
1831         </varlistentry>
1832
1833         <varlistentry>
1834           <term><literal>extra_cc_opts</literal></term>
1835           <indexterm><primary><literal>extra_cc_opts</literal></primary>
1836             <secondary>package specification</secondary></indexterm>
1837           <listitem>
1838             <para>Extra arguments to be added to the gcc command line
1839             when this package is being used (only for via-C
1840             compilations).</para>
1841           </listitem>
1842         </varlistentry>
1843
1844         <varlistentry>
1845           <term><literal>extra_ld_opts</literal></term>
1846           <indexterm><primary><literal>extra_ld_opts</literal></primary>
1847             <secondary>package specification</secondary></indexterm>
1848           <listitem>
1849             <para>Extra arguments to be added to the gcc command line
1850             (for linking) when this package is being used.</para>
1851           </listitem>
1852         </varlistentry>
1853       </variablelist>
1854
1855       <para>For examples of more package specifications, take a look
1856       at the <literal>package.conf</literal> in your GHC
1857       installation.</para>
1858     </sect2>
1859   </sect1>
1860
1861
1862 <Sect1 id="options-optimise">
1863 <Title>Optimisation (code improvement)
1864 </Title>
1865
1866 <Para>
1867 <IndexTerm><Primary>optimisation (GHC)</Primary></IndexTerm>
1868 <IndexTerm><Primary>improvement, code (GHC)</Primary></IndexTerm>
1869 </Para>
1870
1871 <Para>
1872 The <Option>-O*</Option> options specify convenient &ldquo;packages&rdquo; of optimisation
1873 flags; the <Option>-f*</Option> options described later on specify
1874 <Emphasis>individual</Emphasis> optimisations to be turned on/off; the <Option>-m*</Option>
1875 options specify <Emphasis>machine-specific</Emphasis> optimisations to be turned
1876 on/off.
1877 </Para>
1878
1879 <Sect2 id="optimise-pkgs">
1880 <Title><Option>-O*</Option>: convenient &ldquo;packages&rdquo; of optimisation flags.
1881 </Title>
1882
1883 <Para>
1884 <IndexTerm><Primary>-O options</Primary></IndexTerm>
1885 </Para>
1886
1887 <Para>
1888 There are <Emphasis>many</Emphasis> options that affect the quality of code
1889 produced by GHC.  Most people only have a general goal, something like
1890 &ldquo;Compile quickly&rdquo; or &ldquo;Make my program run like greased lightning.&rdquo;
1891 The following &ldquo;packages&rdquo; of optimisations (or lack thereof) should
1892 suffice.
1893 </Para>
1894
1895 <Para>
1896 Once you choose a <Option>-O*</Option> &ldquo;package,&rdquo; stick with it&mdash;don't chop and
1897 change.  Modules' interfaces <Emphasis>will</Emphasis> change with a shift to a new
1898 <Option>-O*</Option> option, and you may have to recompile a large chunk of all
1899 importing modules before your program can again be run
1900 safely (see <XRef LinkEnd="recomp">).
1901 </Para>
1902
1903 <Para>
1904 <VariableList>
1905
1906 <VarListEntry>
1907 <Term>No <Option>-O*</Option>-type option specified:</Term>
1908 <IndexTerm><Primary>-O* not specified</Primary></IndexTerm>
1909 <ListItem>
1910 <Para>
1911 This is taken to mean: &ldquo;Please compile quickly; I'm not over-bothered
1912 about compiled-code quality.&rdquo;  So, for example: <Command>ghc -c Foo.hs</Command>
1913 </Para>
1914 </ListItem>
1915 </VarListEntry>
1916 <VarListEntry>
1917 <Term><Option>-O</Option> or <Option>-O1</Option>:</Term>
1918 <IndexTerm><Primary>-O option</Primary></IndexTerm>
1919 <IndexTerm><Primary>-O1 option</Primary></IndexTerm>
1920 <IndexTerm><Primary>optimise</Primary><secondary>normally</secondary></IndexTerm>
1921 <ListItem>
1922 <Para>
1923 Means: &ldquo;Generate good-quality code without taking too long about
1924 it.&rdquo; Thus, for example: <Command>ghc -c -O Main.lhs</Command>
1925 </Para>
1926 </ListItem>
1927 </VarListEntry>
1928 <VarListEntry>
1929 <Term><Option>-O2</Option>:</Term>
1930 <IndexTerm><Primary>-O2 option</Primary></IndexTerm>
1931 <IndexTerm><Primary>optimise</Primary><secondary>aggressively</secondary></IndexTerm>
1932 <ListItem>
1933 <Para>
1934 Means: &ldquo;Apply every non-dangerous optimisation, even if it means
1935 significantly longer compile times.&rdquo;
1936 </Para>
1937
1938 <Para>
1939 The avoided &ldquo;dangerous&rdquo; optimisations are those that can make
1940 runtime or space <Emphasis>worse</Emphasis> if you're unlucky.  They are
1941 normally turned on or off individually.
1942 </Para>
1943
1944 <Para>
1945 At the moment, <Option>-O2</Option> is <Emphasis>unlikely</Emphasis> to produce
1946 better code than <Option>-O</Option>.
1947 </Para>
1948 </ListItem>
1949 </VarListEntry>
1950 <VarListEntry>
1951 <Term><Option>-O2-for-C</Option>:</Term>
1952 <IndexTerm><Primary>-O2-for-C option</Primary></IndexTerm>
1953 <IndexTerm><Primary>gcc, invoking with -O2</Primary></IndexTerm>
1954 <ListItem>
1955 <Para>
1956 Says to run GCC with <Option>-O2</Option>, which may be worth a few percent in
1957 execution speed.  Don't forget <Option>-fvia-C</Option>, lest you use the native-code
1958 generator and bypass GCC altogether!
1959 </Para>
1960 </ListItem>
1961 </VarListEntry>
1962 <VarListEntry>
1963 <Term><Option>-Onot</Option>:</Term>
1964 <IndexTerm><Primary>-Onot option</Primary></IndexTerm>
1965 <IndexTerm><Primary>optimising, reset</Primary></IndexTerm>
1966 <ListItem>
1967 <Para>
1968 This option will make GHC &ldquo;forget&rdquo; any
1969 <Option>-O</Option>ish options it has seen so far.  Sometimes useful;
1970 for example: <Command>make all
1971 EXTRA&lowbar;HC&lowbar;OPTS=-Onot</Command>.
1972 </Para>
1973 </ListItem>
1974 </VarListEntry>
1975 <VarListEntry>
1976 <Term><Option>-Ofile &lt;file&gt;</Option>:</Term>
1977 <IndexTerm><Primary>-Ofile &lt;file&gt; option</Primary></IndexTerm>
1978 <IndexTerm><Primary>optimising, customised</Primary></IndexTerm>
1979 <ListItem>
1980 <Para>
1981 For those who need <Emphasis>absolute</Emphasis> control over
1982 <Emphasis>exactly</Emphasis> what options are used (e.g., compiler
1983 writers, sometimes :-), a list of options can be put in a file and
1984 then slurped in with <Option>-Ofile</Option>.
1985 </Para>
1986
1987 <Para>
1988 In that file, comments are of the
1989 <Literal>&num;</Literal>-to-end-of-line variety; blank lines and most
1990 whitespace is ignored.
1991 </Para>
1992
1993 <Para>
1994 Please ask if you are baffled and would like an example of <Option>-Ofile</Option>!
1995 </Para>
1996 </ListItem>
1997 </VarListEntry>
1998 </VariableList>
1999 </Para>
2000
2001 <Para>
2002 At Glasgow, we don't use a <Option>-O*</Option> flag for day-to-day work.  We use
2003 <Option>-O</Option> to get respectable speed; e.g., when we want to measure
2004 something.  When we want to go for broke, we tend to use <Option>-O -fvia-C
2005 -O2-for-C</Option> (and we go for lots of coffee breaks).
2006 </Para>
2007
2008 <Para>
2009 The easiest way to see what <Option>-O</Option> (etc.) &ldquo;really mean&rdquo; is to run with
2010 <Option>-v</Option>, then stand back in amazement.  Alternatively, just look at the
2011 <Literal>HsC&lowbar;minus&lt;blah&gt;</Literal> lists in the GHC driver script.
2012 </Para>
2013
2014 </Sect2>
2015
2016 <Sect2>
2017 <Title><Option>-f*</Option>: platform-independent flags</Title>
2018
2019 <Para>
2020 <IndexTerm><Primary>-f* options (GHC)</Primary></IndexTerm>
2021 <IndexTerm><Primary>-fno-* options (GHC)</Primary></IndexTerm>
2022 </Para>
2023
2024 <Para>
2025 Flags can be turned <Emphasis>off</Emphasis> individually.  (NB: I hope you have a
2026 good reason for doing this&hellip;) To turn off the <Option>-ffoo</Option> flag, just use
2027 the <Option>-fno-foo</Option> flag.<IndexTerm><Primary>-fno-&lt;opt&gt; anti-option</Primary></IndexTerm> So, for
2028 example, you can say <Option>-O2 -fno-strictness</Option>, which will then drop out
2029 any running of the strictness analyser.
2030 </Para>
2031
2032 <Para>
2033 The options you are most likely to want to turn off are:
2034
2035 <ItemizedList>
2036 <ListItem>
2037
2038 <Para>
2039 <Option>-fno-strictness</Option><IndexTerm><Primary>-fno-strictness option</Primary></IndexTerm> (strictness
2040 analyser, because it is sometimes slow),
2041 </Para>
2042 </ListItem>
2043 <ListItem>
2044
2045 <Para>
2046 <Option>-fno-specialise</Option><IndexTerm><Primary>-fno-specialise option</Primary></IndexTerm> (automatic
2047 specialisation of overloaded functions, because it can make your code
2048 bigger) (US spelling also accepted), and
2049 </Para>
2050 </ListItem>
2051 <ListItem>
2052
2053 <Para>
2054 <Option>-fno-cpr-analyse</Option><IndexTerm><Primary>-fno-cpr-analyse option</Primary></IndexTerm> switches off the CPR (constructed product
2055 result) analyser.
2056 </Para>
2057 </ListItem>
2058
2059 </ItemizedList>
2060
2061 </Para>
2062
2063 <Para>
2064 Should you wish to turn individual flags <Emphasis>on</Emphasis>, you are advised
2065 to use the <Option>-Ofile</Option> option, described above.  Because the order in
2066 which optimisation passes are run is sometimes crucial, it's quite
2067 hard to do with command-line options.
2068 </Para>
2069
2070 <Para>
2071 Here are some &ldquo;dangerous&rdquo; optimisations you <Emphasis>might</Emphasis> want to try:
2072 <VariableList>
2073
2074 <VarListEntry>
2075 <Term><Option>-fvia-C</Option>:</Term>
2076 <ListItem>
2077 <Para>
2078 <IndexTerm><Primary>-fvia-C option</Primary></IndexTerm>
2079 <IndexTerm><Primary>native code generator, turning off</Primary></IndexTerm>
2080 </Para>
2081
2082 <Para>
2083 Compile via C, and don't use the native-code generator.  (There are many
2084 cases when GHC does this on its own.) You might pick up a little bit of
2085 speed by compiling via C (e.g. for floating-point intensive code on Intel).
2086 If you use <Function>&lowbar;casm&lowbar;</Function>s (which are utterly
2087 deprecated), you probably <Emphasis>have</Emphasis> to use
2088 <Option>-fvia-C</Option>.
2089 </Para>
2090
2091 <Para>
2092 The lower-case incantation, <Option>-fvia-c</Option>, is synonymous.
2093 </Para>
2094
2095 <Para>
2096 Compiling via C will probably be slower (in compilation time) than
2097 using GHC's native code generator.
2098 </Para>
2099 </ListItem>
2100 </VarListEntry>
2101 <VarListEntry>
2102 <Term><Option>-funfolding-interface-threshold&lt;n&gt;</Option>:</Term>
2103 <ListItem>
2104 <Para>
2105 <IndexTerm><Primary>-funfolding-interface-threshold option</Primary></IndexTerm>
2106 <IndexTerm><Primary>inlining, controlling</Primary></IndexTerm>
2107 <IndexTerm><Primary>unfolding, controlling</Primary></IndexTerm>
2108 (Default: 30) By raising or lowering this number, you can raise or
2109 lower the amount of pragmatic junk that gets spewed into interface
2110 files.  (An unfolding has a &ldquo;size&rdquo; that reflects the cost in terms
2111 of &ldquo;code bloat&rdquo; of expanding that unfolding in another module.  A
2112 bigger function would be assigned a bigger cost.)
2113 </Para>
2114 </ListItem>
2115 </VarListEntry>
2116 <VarListEntry>
2117 <Term><Option>-funfolding-creation-threshold&lt;n&gt;</Option>:</Term>
2118 <ListItem>
2119 <Para>
2120 <IndexTerm><Primary>-funfolding-creation-threshold option</Primary></IndexTerm>
2121 <IndexTerm><Primary>inlining, controlling</Primary></IndexTerm>
2122 <IndexTerm><Primary>unfolding, controlling</Primary></IndexTerm>
2123 (Default: 30) This option is similar to
2124 <Option>-funfolding-interface-threshold</Option>, except that it governs unfoldings
2125 within a single module.  Increasing this figure is more likely to
2126 result in longer compile times than faster code.  The next option is
2127 more useful:
2128 </Para>
2129 </ListItem>
2130 </VarListEntry>
2131 <VarListEntry>
2132 <Term><Option>-funfolding-use-threshold&lt;n&gt;</Option>:</Term>
2133 <ListItem>
2134 <Para>
2135 <IndexTerm><Primary>-funfolding-use-threshold option</Primary></IndexTerm>
2136 <IndexTerm><Primary>inlining, controlling</Primary></IndexTerm>
2137 <IndexTerm><Primary>unfolding, controlling</Primary></IndexTerm>
2138 (Default: 8) This is the magic cut-off figure for unfolding: below
2139 this size, a function definition will be unfolded at the call-site,
2140 any bigger and it won't.  The size computed for a function depends on
2141 two things: the actual size of the expression minus any discounts that
2142 apply (see <Option>-funfolding-con-discount</Option>).
2143 </Para>
2144 </ListItem>
2145 </VarListEntry>
2146
2147 <VarListEntry>
2148 <Term><Option>-funfolding-update-in-place&lt;n&gt;</Option>:</Term>
2149 <ListItem>
2150 Switches on an experimental "optimisation".  Switching it on makes the compiler
2151 a little keener to inline a function that returns a constructor, if the context is
2152 that of a thunk.
2153 <ProgramListing>
2154    x = plusInt a b
2155 </ProgramListing>
2156 If we inlined plusInt we might get an opportunity to use update-in-place for
2157 the thunk 'x'.
2158 </Para>
2159 </ListItem>
2160 </VarListEntry>
2161
2162 <VarListEntry>
2163 <Term><Option>-funbox-strict-fields</Option>:</Term>
2164 <ListItem>
2165 <Para>
2166 <IndexTerm><Primary>-funbox-strict-fields option</Primary></IndexTerm>
2167 <IndexTerm><Primary>strict constructor fields</Primary></IndexTerm>
2168 <IndexTerm><Primary>constructor fields, strict</Primary></IndexTerm>
2169 </Para>
2170
2171 <Para>
2172 This option causes all constructor fields which are marked strict
2173 (i.e. &ldquo;!&rdquo;) to be unboxed or unpacked if possible.  For example:
2174 </Para>
2175
2176 <Para>
2177
2178 <ProgramListing>
2179 data T = T !Float !Float
2180 </ProgramListing>
2181
2182 </Para>
2183
2184 <Para>
2185 will create a constructor <Literal>T</Literal> containing two unboxed floats if the
2186 <Option>-funbox-strict-fields</Option> flag is given.  This may not always be an
2187 optimisation: if the <Function>T</Function> constructor is scrutinised and the floats
2188 passed to a non-strict function for example, they will have to be
2189 reboxed (this is done automatically by the compiler).
2190 </Para>
2191
2192 <Para>
2193 This option should only be used in conjunction with <Option>-O</Option>, in order to
2194 expose unfoldings to the compiler so the reboxing can be removed as
2195 often as possible.  For example:
2196 </Para>
2197
2198 <Para>
2199
2200 <ProgramListing>
2201 f :: T -&#62; Float
2202 f (T f1 f2) = f1 + f2
2203 </ProgramListing>
2204
2205 </Para>
2206
2207 <Para>
2208 The compiler will avoid reboxing <Function>f1</Function> and <Function>f2</Function> by inlining <Function>+</Function> on
2209 floats, but only when <Option>-O</Option> is on.
2210 </Para>
2211
2212 <Para>
2213 Any single-constructor data is eligible for unpacking; for example
2214 </Para>
2215
2216 <Para>
2217
2218 <ProgramListing>
2219 data T = T !(Int,Int)
2220 </ProgramListing>
2221
2222 </Para>
2223
2224 <Para>
2225 will store the two <Literal>Int</Literal>s directly in the <Function>T</Function> constructor, by flattening
2226 the pair.  Multi-level unpacking is also supported:
2227 </Para>
2228
2229 <Para>
2230
2231 <ProgramListing>
2232 data T = T !S
2233 data S = S !Int !Int
2234 </ProgramListing>
2235
2236 </Para>
2237
2238 <Para>
2239 will store two unboxed <Literal>Int&num;</Literal>s directly in the <Function>T</Function> constructor.
2240 </Para>
2241 </ListItem>
2242 </VarListEntry>
2243 <VarListEntry>
2244 <Term><Option>-fsemi-tagging</Option>:</Term>
2245 <ListItem>
2246 <Para>
2247 This option (which <Emphasis>does not work</Emphasis> with the native-code generator)
2248 tells the compiler to add extra code to test for already-evaluated
2249 values.  You win if you have lots of such values during a run of your
2250 program, you lose otherwise.  (And you pay in extra code space.)
2251 </Para>
2252
2253 <Para>
2254 We have not played with <Option>-fsemi-tagging</Option> enough to recommend it.
2255 (For all we know, it doesn't even work anymore&hellip; Sigh.)
2256 </Para>
2257 </ListItem>
2258 </VarListEntry>
2259 <VarListEntry>
2260 <Term><Option>-fexcess-precision</Option>:</Term>
2261 <ListItem>
2262 <Para>
2263 When this option is given, intermediate floating point values can have
2264 a <Emphasis>greater</Emphasis> precision/range than the final type.
2265 Generally this is a good thing, but some programs may rely on the
2266 exact precision/range of <Literal>Float</Literal>/<Literal>Double</Literal>
2267 values and should not use this option for their compilation.
2268 </Para>
2269 </ListItem>
2270 </VarListEntry>
2271 </VariableList>
2272 </Para>
2273
2274 </Sect2>
2275
2276 <Sect2>
2277 <Title><Option>-m*</Option>: platform-specific flags</Title>
2278
2279 <Para>
2280 <IndexTerm><Primary>-m* options (GHC)</Primary></IndexTerm>
2281 <IndexTerm><Primary>platform-specific options</Primary></IndexTerm>
2282 <IndexTerm><Primary>machine-specific options</Primary></IndexTerm>
2283 </Para>
2284
2285 <Para>
2286 Some flags only make sense for particular target platforms.
2287 </Para>
2288
2289 <Para>
2290 <VariableList>
2291
2292 <VarListEntry>
2293 <Term><Option>-mv8</Option>:</Term>
2294 <ListItem>
2295 <Para>
2296 (SPARC machines)<IndexTerm><Primary>-mv8 option (SPARC only)</Primary></IndexTerm>
2297 Means to pass the like-named option to GCC; it says to use the
2298 Version 8 SPARC instructions, notably integer multiply and divide.
2299 The similiar <Option>-m*</Option> GCC options for SPARC also work, actually.
2300 </Para>
2301 </ListItem>
2302 </VarListEntry>
2303 <VarListEntry>
2304 <Term><Option>-mlong-calls</Option>:</Term>
2305 <ListItem>
2306 <Para>
2307 (HPPA machines)<IndexTerm><Primary>-mlong-calls option (HPPA only)</Primary></IndexTerm>
2308 Means to pass the like-named option to GCC.  Required for Very Big
2309 modules, maybe.  (Probably means you're in trouble&hellip;)
2310 </Para>
2311 </ListItem>
2312 </VarListEntry>
2313 <VarListEntry>
2314 <Term><Option>-monly-[32]-regs</Option>:</Term>
2315 <ListItem>
2316 <Para>
2317 (iX86 machines)<IndexTerm><Primary>-monly-N-regs option (iX86 only)</Primary></IndexTerm>
2318 GHC tries to &ldquo;steal&rdquo; four registers from GCC, for performance
2319 reasons; it almost always works.  However, when GCC is compiling some
2320 modules with four stolen registers, it will crash, probably saying:
2321
2322 <Screen>
2323 Foo.hc:533: fixed or forbidden register was spilled.
2324 This may be due to a compiler bug or to impossible asm
2325 statements or clauses.
2326 </Screen>
2327
2328 Just give some registers back with <Option>-monly-N-regs</Option>.  Try `3' first,
2329 then `2'.  If `2' doesn't work, please report the bug to us.
2330 </Para>
2331 </ListItem>
2332 </VarListEntry>
2333 </VariableList>
2334 </Para>
2335
2336 </Sect2>
2337
2338 <Sect2 id="optimise-C-compiler">
2339 <Title>Code improvement by the C compiler.
2340 </Title>
2341
2342 <Para>
2343 <IndexTerm><Primary>optimisation by GCC</Primary></IndexTerm>
2344 <IndexTerm><Primary>GCC optimisation</Primary></IndexTerm>
2345 </Para>
2346
2347 <Para>
2348 The C&nbsp;compiler (GCC) is run with <Option>-O</Option> turned on.  (It has
2349 to be, actually).
2350 </Para>
2351
2352 <Para>
2353 If you want to run GCC with <Option>-O2</Option>&mdash;which may be worth a few
2354 percent in execution speed&mdash;you can give a
2355 <Option>-O2-for-C</Option><IndexTerm><Primary>-O2-for-C option</Primary></IndexTerm> option.
2356 </Para>
2357
2358 </Sect2>
2359
2360 </Sect1>
2361
2362 <Sect1 id="options-phases">
2363 <Title>Options related to a particular phase
2364 </Title>
2365
2366 <Sect2 id="c-pre-processor">
2367 <Title>The C pre-processor
2368 </Title>
2369
2370 <Para>
2371 <IndexTerm><Primary>pre-processing: cpp</Primary></IndexTerm>
2372 <IndexTerm><Primary>C pre-processor options</Primary></IndexTerm>
2373 <IndexTerm><Primary>cpp, pre-processing with</Primary></IndexTerm>
2374 </Para>
2375
2376 <Para>
2377 The C pre-processor <Command>cpp</Command> is run over your Haskell code only if the
2378 <Option>-cpp</Option> option <IndexTerm><Primary>-cpp option</Primary></IndexTerm> is given.  Unless you are
2379 building a large system with significant doses of conditional
2380 compilation, you really shouldn't need it.
2381 <VariableList>
2382
2383 <VarListEntry>
2384 <Term><Option>-D&lt;foo&gt;</Option>:</Term>
2385 <ListItem>
2386 <Para>
2387 <IndexTerm><Primary>-D&lt;name&gt; option</Primary></IndexTerm>
2388 Define macro <Constant>&lt;foo&gt;</Constant> in the usual way.  NB: does <Emphasis>not</Emphasis> affect
2389 <Option>-D</Option> macros passed to the C&nbsp;compiler when compiling via C!  For those,
2390 use the <Option>-optc-Dfoo</Option> hack&hellip; (see <XRef LinkEnd="forcing-options-through">).
2391 </Para>
2392 </ListItem>
2393 </VarListEntry>
2394 <VarListEntry>
2395 <Term><Option>-U&lt;foo&gt;</Option>:</Term>
2396 <ListItem>
2397 <Para>
2398 <IndexTerm><Primary>-U&lt;name&gt; option</Primary></IndexTerm>
2399 Undefine macro <Command>&lt;foo&gt;</Command> in the usual way.
2400 </Para>
2401 </ListItem>
2402 </VarListEntry>
2403 <VarListEntry>
2404 <Term><Option>-I&lt;dir&gt;</Option>:</Term>
2405 <ListItem>
2406 <Para>
2407 <IndexTerm><Primary>-I&lt;dir&gt; option</Primary></IndexTerm>
2408 Specify a directory in which to look for <Literal>&num;include</Literal> files, in
2409 the usual C way.
2410 </Para>
2411 </ListItem>
2412 </VarListEntry>
2413 </VariableList>
2414 </Para>
2415
2416 <Para>
2417 The GHC driver pre-defines several macros when processing Haskell
2418 source code (<Filename>.hs</Filename> or <Filename>.lhs</Filename> files):
2419 </Para>
2420
2421 <Para>
2422 <VariableList>
2423
2424 <VarListEntry>
2425 <Term><Constant>&lowbar;&lowbar;HASKELL98&lowbar;&lowbar;</Constant>:</Term>
2426 <ListItem>
2427 <Para>
2428 <IndexTerm><Primary>&lowbar;&lowbar;HASKELL98&lowbar;&lowbar;</Primary></IndexTerm>
2429 If defined, this means that GHC supports the language defined by the
2430 Haskell 98 report.
2431 </Para>
2432 </ListItem>
2433 </VarListEntry>
2434 <VarListEntry>
2435 <Term><Constant>&lowbar;&lowbar;HASKELL&lowbar;&lowbar;=98</Constant>:</Term>
2436 <ListItem>
2437 <Para>
2438 <IndexTerm><Primary>&lowbar;&lowbar;HASKELL&lowbar;&lowbar;</Primary></IndexTerm>
2439 In GHC 4.04 and later, the <Constant>&lowbar;&lowbar;HASKELL&lowbar;&lowbar;</Constant> macro is defined as having
2440 the value <Constant>98</Constant>.
2441 </Para>
2442 </ListItem>
2443 </VarListEntry>
2444 <VarListEntry>
2445 <Term><Constant>&lowbar;&lowbar;HASKELL1&lowbar;&lowbar;</Constant>:</Term>
2446 <ListItem>
2447 <Para>
2448 <IndexTerm><Primary>&lowbar;&lowbar;HASKELL1&lowbar;&lowbar; macro</Primary></IndexTerm>
2449 If defined to <Emphasis>n</Emphasis>, that means GHC supports the Haskell language
2450 defined in the Haskell report version <Emphasis>1.n</Emphasis>.  Currently 5.  This
2451 macro is deprecated, and will probably disappear in future versions.
2452 </Para>
2453 </ListItem>
2454 </VarListEntry>
2455 <VarListEntry>
2456 <Term><Constant>&lowbar;&lowbar;GLASGOW&lowbar;HASKELL&lowbar;&lowbar;</Constant>:</Term>
2457 <ListItem>
2458 <Para>
2459 <IndexTerm><Primary>&lowbar;&lowbar;GLASGOW&lowbar;HASKELL&lowbar;&lowbar; macro</Primary></IndexTerm>
2460 For version <Emphasis>n</Emphasis> of the GHC system, this will be <Literal>&num;define</Literal>d to
2461 <Emphasis>100n</Emphasis>.  So, for version 4.00, it is 400.
2462 </Para>
2463
2464 <Para>
2465 With any luck, <Constant>&lowbar;&lowbar;GLASGOW&lowbar;HASKELL&lowbar;&lowbar;</Constant> will be undefined in all other
2466 implementations that support C-style pre-processing.
2467 </Para>
2468
2469 <Para>
2470 (For reference: the comparable symbols for other systems are:
2471 <Constant>&lowbar;&lowbar;HUGS&lowbar;&lowbar;</Constant> for Hugs and <Constant>&lowbar;&lowbar;HBC&lowbar;&lowbar;</Constant> for Chalmers.)
2472 </Para>
2473
2474 <Para>
2475 NB. This macro is set when pre-processing both Haskell source and C
2476 source, including the C source generated from a Haskell module
2477 (i.e. <Filename>.hs</Filename>, <Filename>.lhs</Filename>, <Filename>.c</Filename> and <Filename>.hc</Filename> files).
2478 </Para>
2479 </ListItem>
2480 </VarListEntry>
2481 <VarListEntry>
2482 <Term><Constant>&lowbar;&lowbar;CONCURRENT&lowbar;HASKELL&lowbar;&lowbar;</Constant>:</Term>
2483 <ListItem>
2484 <Para>
2485 <IndexTerm><Primary>&lowbar;&lowbar;CONCURRENT&lowbar;HASKELL&lowbar;&lowbar; macro</Primary></IndexTerm>
2486 This symbol is defined when pre-processing Haskell (input) and
2487 pre-processing C (GHC output).  Since GHC from verion 4.00 now
2488 supports concurrent haskell by default, this symbol is always defined.
2489 </Para>
2490 </ListItem>
2491 </VarListEntry>
2492 <VarListEntry>
2493 <Term><Constant>&lowbar;&lowbar;PARALLEL&lowbar;HASKELL&lowbar;&lowbar;</Constant>:</Term>
2494 <ListItem>
2495 <Para>
2496 <IndexTerm><Primary>&lowbar;&lowbar;PARALLEL&lowbar;HASKELL&lowbar;&lowbar; macro</Primary></IndexTerm>
2497 Only defined when <Option>-parallel</Option> is in use!  This symbol is defined when
2498 pre-processing Haskell (input) and pre-processing C (GHC output).
2499 </Para>
2500 </ListItem>
2501 </VarListEntry>
2502 </VariableList>
2503 </Para>
2504
2505 <Para>
2506 Options other than the above can be forced through to the C
2507 pre-processor with the <Option>-opt</Option> flags (see
2508 <XRef LinkEnd="forcing-options-through">).
2509 </Para>
2510
2511 <Para>
2512 A small word of warning: <Option>-cpp</Option> is not friendly to &ldquo;string
2513 gaps&rdquo;.<IndexTerm><Primary>-cpp vs string gaps</Primary></IndexTerm><IndexTerm><Primary>string gaps vs
2514 -cpp</Primary></IndexTerm>.  In other words, strings such as the following:
2515 </Para>
2516
2517 <Para>
2518
2519 <ProgramListing>
2520 strmod = "\
2521 \ p \
2522 \ "
2523 </ProgramListing>
2524
2525 </Para>
2526
2527 <Para>
2528 don't work with <Option>-cpp</Option>; <Filename>/usr/bin/cpp</Filename> elides the
2529 backslash-newline pairs.
2530 </Para>
2531
2532 <Para>
2533 However, it appears that if you add a space at the end of the line,
2534 then <Command>cpp</Command> (at least GNU <Command>cpp</Command> and possibly other <Command>cpp</Command>s)
2535 leaves the backslash-space pairs alone and the string gap works as
2536 expected.
2537 </Para>
2538
2539 </Sect2>
2540
2541 <Sect2 id="options-C-compiler">
2542 <Title>Options affecting the C compiler (if applicable)
2543 </Title>
2544
2545 <Para>
2546 <IndexTerm><Primary>include-file options</Primary></IndexTerm>
2547 <IndexTerm><Primary>C compiler options</Primary></IndexTerm>
2548 <IndexTerm><Primary>GCC options</Primary></IndexTerm>
2549 </Para>
2550
2551 <Para>
2552 At the moment, quite a few common C-compiler options are passed on
2553 quietly to the C compilation of Haskell-compiler-generated C files.
2554 THIS MAY CHANGE.  Meanwhile, options so sent are:
2555 </Para>
2556
2557 <Para>
2558
2559 <InformalTable>
2560 <TGroup Cols="2">
2561 <ColSpec Align="Left" Colsep="0">
2562 <ColSpec Align="Left" Colsep="0">
2563 <TBody>
2564 <Row>
2565 <Entry><Option>-ansi</Option> </Entry>
2566 <Entry> do ANSI C (not K&amp;R) </Entry>
2567 </Row>
2568 <Row>
2569 <Entry>
2570 <Option>-pedantic</Option> </Entry>
2571 <Entry> be so</Entry>
2572 </Row>
2573 <Row>
2574 <Entry>
2575 <Option>-dgcc-lint</Option> </Entry>
2576 <Entry> (hack) short for &ldquo;make GCC very paranoid&rdquo;</Entry>
2577 </Row>
2578
2579 </TBody>
2580
2581 </TGroup>
2582 </InformalTable>
2583
2584 <IndexTerm><Primary>-ansi option (for GCC)</Primary></IndexTerm>
2585 <IndexTerm><Primary>-pedantic option (for GCC)</Primary></IndexTerm>
2586 <IndexTerm><Primary>-dgcc-lint option (GCC paranoia)</Primary></IndexTerm>
2587 </Para>
2588
2589 <Para>
2590 If you are compiling with lots of foreign calls, you may need to
2591 tell the C&nbsp;compiler about some <Literal>&num;include</Literal> files.  There is no real
2592 pretty way to do this, but you can use this hack from the
2593 command-line:
2594 </Para>
2595
2596 <Para>
2597
2598 <Screen>
2599 % ghc -c '-#include &#60;X/Xlib.h&#62;' Xstuff.lhs
2600 </Screen>
2601
2602 </Para>
2603
2604 </Sect2>
2605
2606 <Sect2 id="options-linker">
2607 <Title>Linking and consistency-checking
2608 </Title>
2609
2610 <Para>
2611 <IndexTerm><Primary>linker options</Primary></IndexTerm>
2612 <IndexTerm><Primary>ld options</Primary></IndexTerm>
2613 </Para>
2614
2615 <Para>
2616 GHC has to link your code with various libraries, possibly including:
2617 user-supplied, GHC-supplied, and system-supplied (<Option>-lm</Option> math
2618 library, for example).
2619 </Para>
2620
2621 <Para>
2622 <VariableList>
2623
2624 <VarListEntry>
2625 <Term><Option>-l&lt;FOO&gt;</Option>:</Term>
2626 <ListItem>
2627 <Para>
2628 <IndexTerm><Primary>-l&lt;lib&gt; option</Primary></IndexTerm>
2629 Link in a library named <Filename>lib&lt;FOO&gt;.a</Filename> which resides somewhere on the
2630 library directories path.
2631 </Para>
2632
2633 <Para>
2634 Because of the sad state of most UNIX linkers, the order of such
2635 options does matter.  Thus: <Command>ghc -lbar *.o</Command> is almost certainly
2636 wrong, because it will search <Filename>libbar.a</Filename> <Emphasis>before</Emphasis> it has
2637 collected unresolved symbols from the <Filename>*.o</Filename> files.
2638 <Command>ghc *.o -lbar</Command> is probably better.
2639 </Para>
2640
2641 <Para>
2642 The linker will of course be informed about some GHC-supplied
2643 libraries automatically; these are:
2644 </Para>
2645
2646 <Para>
2647
2648 <InformalTable>
2649 <TGroup Cols="2">
2650 <ColSpec Align="Left" Colsep="0">
2651 <ColSpec Align="Left" Colsep="0">
2652 <TBody>
2653 <Row>
2654 <Entry><Emphasis>-l equivalent</Emphasis> </Entry>
2655 <Entry> <Emphasis>description</Emphasis> </Entry>
2656 </Row>
2657
2658 <Row>
2659 <Entry>
2660 <Option>-lHSrts,-lHSclib</Option> </Entry>
2661 <Entry> basic runtime libraries </Entry>
2662 </Row>
2663 <Row>
2664 <Entry>
2665 <Option>-lHS</Option> </Entry>
2666 <Entry> standard Prelude library </Entry>
2667 </Row>
2668 <Row>
2669 <Entry>
2670 <Option>-lHS&lowbar;cbits</Option> </Entry>
2671 <Entry> C support code for standard Prelude library </Entry>
2672 </Row>
2673 <Row>
2674 <Entry>
2675 <Option>-lgmp</Option> </Entry>
2676 <Entry> GNU multi-precision library (for Integers)</Entry>
2677 </Row>
2678
2679 </TBody>
2680
2681 </TGroup>
2682 </InformalTable>
2683
2684 </Para>
2685
2686 <Para>
2687 <IndexTerm><Primary>-lHS library</Primary></IndexTerm>
2688 <IndexTerm><Primary>-lHS&lowbar;cbits library</Primary></IndexTerm>
2689 <IndexTerm><Primary>-lHSrts library</Primary></IndexTerm>
2690 <IndexTerm><Primary>-lgmp library</Primary></IndexTerm>
2691 </Para>
2692 </ListItem>
2693 </VarListEntry>
2694 <VarListEntry>
2695 <Term><Option>-package &lt;name&gt;</Option>:</Term>
2696 <ListItem>
2697 <Para>
2698 <IndexTerm><Primary>-package &lt;name&gt; option</Primary></IndexTerm>
2699 </Para>
2700
2701 <Para>
2702 If you are using a Haskell &ldquo;package&rdquo; (e.g., the POSIX
2703 library), just use the <Option>-package posix</Option> option, and the
2704 correct code should be linked in.  See <xref linkend="packages"> for
2705 more details.
2706 </Para>
2707 </ListItem>
2708 </VarListEntry>
2709 <VarListEntry>
2710 <Term><Option>-L&lt;dir&gt;</Option>:</Term>
2711 <ListItem>
2712 <Para>
2713 <IndexTerm><Primary>-L&lt;dir&gt; option</Primary></IndexTerm>
2714 Where to find user-supplied libraries&hellip;  Prepend the directory
2715 <Filename>&lt;dir&gt;</Filename> to the library directories path.
2716 </Para>
2717 </ListItem>
2718 </VarListEntry>
2719 <VarListEntry>
2720 <Term><Option>-static</Option>:</Term>
2721 <ListItem>
2722 <Para>
2723 <IndexTerm><Primary>-static option</Primary></IndexTerm>
2724 Tell the linker to avoid shared libraries.
2725 </Para>
2726 </ListItem>
2727 </VarListEntry>
2728 <VarListEntry>
2729 <Term><Option>-no-link-chk</Option> and <Option>-link-chk</Option>:</Term>
2730 <ListItem>
2731 <Para>
2732 <IndexTerm><Primary>-no-link-chk option</Primary></IndexTerm>
2733 <IndexTerm><Primary>-link-chk option</Primary></IndexTerm>
2734 <IndexTerm><Primary>consistency checking of executables</Primary></IndexTerm>
2735 By default, immediately after linking an executable, GHC verifies that
2736 the pieces that went into it were compiled with compatible flags; a
2737 &ldquo;consistency check&rdquo;.
2738 (This is to avoid mysterious failures caused by non-meshing of
2739 incompatibly-compiled programs; e.g., if one <Filename>.o</Filename> file was compiled
2740 for a parallel machine and the others weren't.)  You may turn off this
2741 check with <Option>-no-link-chk</Option>.  You can turn it (back) on with
2742 <Option>-link-chk</Option> (the default).
2743 </Para>
2744 </ListItem>
2745 </VarListEntry>
2746 <VarListEntry>
2747 <Term><Option>-no-hs-main</Option>:</Term>
2748 <ListItem>
2749 <Para>
2750 <IndexTerm><Primary>-no-hs-main option</Primary></IndexTerm>
2751 <IndexTerm><Primary>linking Haskell libraries with foreign code</Primary></IndexTerm>
2752 </Para>
2753
2754 <Para>
2755 In the event you want to include ghc-compiled code as part of another
2756 (non-Haskell) program, the RTS will not be supplying its definition of
2757 <Function>main()</Function> at link-time, you will have to. To signal that to the
2758 driver script when linking, use <Option>-no-hs-main</Option>.
2759 </Para>
2760
2761 <Para>
2762 Notice that since the command-line passed to the linker is rather
2763 involved, you probably want to use the ghc driver script to do the
2764 final link of your `mixed-language' application. This is not a
2765 requirement though, just try linking once with <Option>-v</Option> on to see what
2766 options the driver passes through to the linker.
2767 </Para>
2768 </ListItem>
2769 </VarListEntry>
2770 </VariableList>
2771 </Para>
2772
2773 </Sect2>
2774
2775 </Sect1>
2776
2777 <Sect1 id="sec-using-concurrent">
2778 <Title>Using Concurrent Haskell</Title>
2779
2780 <Para>
2781 <IndexTerm><Primary>Concurrent Haskell&mdash;use</Primary></IndexTerm>
2782 </Para>
2783
2784 <Para>
2785 GHC (as of version 4.00) supports Concurrent Haskell by default,
2786 without requiring a special option or libraries compiled in a certain
2787 way.  To get access to the support libraries for Concurrent Haskell
2788 (i.e. <Literal>Concurrent</Literal> and friends), use the
2789 <Option>-package concurrent</Option> option.
2790 </Para>
2791
2792 <Para>
2793 Three RTS options are provided for modifying the behaviour of the
2794 threaded runtime system.  See the descriptions of
2795 <Option>-C[&lt;us&gt;]</Option>, <Option>-q</Option>, and
2796 <Option>-t&lt;num&gt;</Option> in <XRef LinkEnd="parallel-rts-opts">.
2797 </Para>
2798
2799 <Para>
2800 Concurrent Haskell is described in more detail in <XRef
2801 LinkEnd="sec-Concurrent">.
2802 </Para>
2803
2804 </Sect1>
2805
2806 <Sect1 id="sec-using-parallel">
2807 <Title>Using Parallel Haskell</Title>
2808
2809 <Para>
2810 <IndexTerm><Primary>Parallel Haskell&mdash;use</Primary></IndexTerm>
2811 </Para>
2812
2813 <Para>
2814 &lsqb;You won't be able to execute parallel Haskell programs unless PVM3
2815 (Parallel Virtual Machine, version 3) is installed at your site.]
2816 </Para>
2817
2818 <Para>
2819 To compile a Haskell program for parallel execution under PVM, use the
2820 <Option>-parallel</Option> option,<IndexTerm><Primary>-parallel
2821 option</Primary></IndexTerm> both when compiling <Emphasis>and
2822 linking</Emphasis>.  You will probably want to <Literal>import
2823 Parallel</Literal> into your Haskell modules.
2824 </Para>
2825
2826 <Para>
2827 To run your parallel program, once PVM is going, just invoke it
2828 &ldquo;as normal&rdquo;.  The main extra RTS option is
2829 <Option>-N&lt;n&gt;</Option>, to say how many PVM
2830 &ldquo;processors&rdquo; your program to run on.  (For more details of
2831 all relevant RTS options, please see <XRef
2832 LinkEnd="parallel-rts-opts">.)
2833 </Para>
2834
2835 <Para>
2836 In truth, running Parallel Haskell programs and getting information
2837 out of them (e.g., parallelism profiles) is a battle with the vagaries of
2838 PVM, detailed in the following sections.
2839 </Para>
2840
2841 <Sect2>
2842 <Title>Dummy's guide to using PVM</Title>
2843
2844 <Para>
2845 <IndexTerm><Primary>PVM, how to use</Primary></IndexTerm>
2846 <IndexTerm><Primary>Parallel Haskell&mdash;PVM use</Primary></IndexTerm>
2847 Before you can run a parallel program under PVM, you must set the
2848 required environment variables (PVM's idea, not ours); something like,
2849 probably in your <Filename>.cshrc</Filename> or equivalent:
2850
2851 <ProgramListing>
2852 setenv PVM_ROOT /wherever/you/put/it
2853 setenv PVM_ARCH `$PVM_ROOT/lib/pvmgetarch`
2854 setenv PVM_DPATH $PVM_ROOT/lib/pvmd
2855 </ProgramListing>
2856
2857 </Para>
2858
2859 <Para>
2860 Creating and/or controlling your &ldquo;parallel machine&rdquo; is a purely-PVM
2861 business; nothing specific to Parallel Haskell.
2862 </Para>
2863
2864 <Para>
2865 You use the <Command>pvm</Command><IndexTerm><Primary>pvm command</Primary></IndexTerm> command to start PVM on your
2866 machine.  You can then do various things to control/monitor your
2867 &ldquo;parallel machine;&rdquo; the most useful being:
2868 </Para>
2869
2870 <Para>
2871 <InformalTable>
2872 <TGroup Cols=2>
2873 <ColSpec Align="Left">
2874 <TBody>
2875
2876 <Row>
2877 <Entry><KeyCombo><KeyCap>Control</KeyCap><KeyCap>D</KeyCap></KeyCombo></Entry>
2878 <Entry>exit <Command>pvm</Command>, leaving it running</Entry>
2879 </Row>
2880
2881 <Row>
2882 <Entry><Command>halt</Command></Entry>
2883 <Entry>kill off this &ldquo;parallel machine&rdquo; &amp; exit</Entry>
2884 </Row>
2885
2886 <Row>
2887 <Entry><Command>add &lt;host&gt;</Command></Entry>
2888 <Entry>add <Command>&lt;host&gt;</Command> as a processor</Entry>
2889 </Row>
2890
2891 <Row>
2892 <Entry><Command>delete &lt;host&gt;</Command></Entry>
2893 <Entry>delete <Command>&lt;host&gt;</Command></Entry>
2894 </Row>
2895
2896 <Row>
2897 <Entry><Command>reset</Command></Entry>
2898 <Entry>kill what's going, but leave PVM up</Entry>
2899 </Row>
2900
2901 <Row>
2902 <Entry><Command>conf</Command></Entry>
2903 <Entry>list the current configuration</Entry>
2904 </Row>
2905
2906 <Row>
2907 <Entry><Command>ps</Command></Entry>
2908 <Entry>report processes' status</Entry>
2909 </Row>
2910
2911 <Row>
2912 <Entry><Command>pstat &lt;pid&gt;</Command></Entry>
2913 <Entry>status of a particular process</Entry>
2914 </Row>
2915
2916 </TBody>
2917 </TGroup>
2918 </InformalTable>
2919 </Para>
2920
2921 <Para>
2922 The PVM documentation can tell you much, much more about <Command>pvm</Command>!
2923 </Para>
2924
2925 </Sect2>
2926
2927 <Sect2>
2928 <Title>Parallelism profiles</Title>
2929
2930 <Para>
2931 <IndexTerm><Primary>parallelism profiles</Primary></IndexTerm>
2932 <IndexTerm><Primary>profiles, parallelism</Primary></IndexTerm>
2933 <IndexTerm><Primary>visualisation tools</Primary></IndexTerm>
2934 </Para>
2935
2936 <Para>
2937 With Parallel Haskell programs, we usually don't care about the
2938 results&mdash;only with &ldquo;how parallel&rdquo; it was!  We want pretty pictures.
2939 </Para>
2940
2941 <Para>
2942 Parallelism profiles (&agrave; la <Command>hbcpp</Command>) can be generated with the
2943 <Option>-q</Option><IndexTerm><Primary>-q RTS option (concurrent, parallel)</Primary></IndexTerm> RTS option.  The
2944 per-processor profiling info is dumped into files named
2945 <Filename>&lt;full-path&gt;&lt;program&gt;.gr</Filename>.  These are then munged into a PostScript picture,
2946 which you can then display.  For example, to run your program
2947 <Filename>a.out</Filename> on 8 processors, then view the parallelism profile, do:
2948 </Para>
2949
2950 <Para>
2951
2952 <Screen>
2953 % ./a.out +RTS -N8 -q
2954 % grs2gr *.???.gr &#62; temp.gr     # combine the 8 .gr files into one
2955 % gr2ps -O temp.gr              # cvt to .ps; output in temp.ps
2956 % ghostview -seascape temp.ps   # look at it!
2957 </Screen>
2958
2959 </Para>
2960
2961 <Para>
2962 The scripts for processing the parallelism profiles are distributed
2963 in <Filename>ghc/utils/parallel/</Filename>.
2964 </Para>
2965
2966 </Sect2>
2967
2968 <Sect2>
2969 <Title>Other useful info about running parallel programs</Title>
2970
2971 <Para>
2972 The &ldquo;garbage-collection statistics&rdquo; RTS options can be useful for
2973 seeing what parallel programs are doing.  If you do either
2974 <Option>+RTS -Sstderr</Option><IndexTerm><Primary>-Sstderr RTS option</Primary></IndexTerm> or <Option>+RTS -sstderr</Option>, then
2975 you'll get mutator, garbage-collection, etc., times on standard
2976 error. The standard error of all PE's other than the `main thread'
2977 appears in <Filename>/tmp/pvml.nnn</Filename>, courtesy of PVM.
2978 </Para>
2979
2980 <Para>
2981 Whether doing <Option>+RTS -Sstderr</Option> or not, a handy way to watch
2982 what's happening overall is: <Command>tail -f /tmp/pvml.nnn</Command>.
2983 </Para>
2984
2985 </Sect2>
2986
2987 <Sect2 id="parallel-rts-opts">
2988 <Title>RTS options for Concurrent/Parallel Haskell
2989 </Title>
2990
2991 <Para>
2992 <IndexTerm><Primary>RTS options, concurrent</Primary></IndexTerm>
2993 <IndexTerm><Primary>RTS options, parallel</Primary></IndexTerm>
2994 <IndexTerm><Primary>Concurrent Haskell&mdash;RTS options</Primary></IndexTerm>
2995 <IndexTerm><Primary>Parallel Haskell&mdash;RTS options</Primary></IndexTerm>
2996 </Para>
2997
2998 <Para>
2999 Besides the usual runtime system (RTS) options
3000 (<XRef LinkEnd="runtime-control">), there are a few options particularly
3001 for concurrent/parallel execution.
3002 </Para>
3003
3004 <Para>
3005 <VariableList>
3006
3007 <VarListEntry>
3008 <Term><Option>-N&lt;N&gt;</Option>:</Term>
3009 <ListItem>
3010 <Para>
3011 <IndexTerm><Primary>-N&lt;N&gt; RTS option (parallel)</Primary></IndexTerm>
3012 (PARALLEL ONLY) Use <Literal>&lt;N&gt;</Literal> PVM processors to run this program;
3013 the default is 2.
3014 </Para>
3015 </ListItem>
3016 </VarListEntry>
3017 <VarListEntry>
3018 <Term><Option>-C[&lt;us&gt;]</Option>:</Term>
3019 <ListItem>
3020 <Para>
3021 <IndexTerm><Primary>-C&lt;us&gt; RTS option</Primary></IndexTerm> Sets
3022 the context switch interval to <Literal>&lt;s&gt;</Literal> seconds.
3023 A context switch will occur at the next heap block allocation after
3024 the timer expires (a heap block allocation occurs every 4k of
3025 allocation).  With <Option>-C0</Option> or <Option>-C</Option>,
3026 context switches will occur as often as possible (at every heap block
3027 allocation).  By default, context switches occur every 20ms
3028 milliseconds.  Note that GHC's internal timer ticks every 20ms, and
3029 the context switch timer is always a multiple of this timer, so 20ms
3030 is the maximum granularity available for timed context switches.
3031 </Para>
3032 </ListItem>
3033 </VarListEntry>
3034 <VarListEntry>
3035 <Term><Option>-q[v]</Option>:</Term>
3036 <ListItem>
3037 <Para>
3038 <IndexTerm><Primary>-q RTS option</Primary></IndexTerm>
3039 (PARALLEL ONLY) Produce a quasi-parallel profile of thread activity,
3040 in the file <FIlename>&lt;program&gt;.qp</FIlename>.  In the style of <Command>hbcpp</Command>, this profile
3041 records the movement of threads between the green (runnable) and red
3042 (blocked) queues.  If you specify the verbose suboption (<Option>-qv</Option>), the
3043 green queue is split into green (for the currently running thread
3044 only) and amber (for other runnable threads).  We do not recommend
3045 that you use the verbose suboption if you are planning to use the
3046 <Command>hbcpp</Command> profiling tools or if you are context switching at every heap
3047 check (with <Option>-C</Option>).
3048 </Para>
3049 </ListItem>
3050 </VarListEntry>
3051 <VarListEntry>
3052 <Term><Option>-t&lt;num&gt;</Option>:</Term>
3053 <ListItem>
3054 <Para>
3055 <IndexTerm><Primary>-t&lt;num&gt; RTS option</Primary></IndexTerm>
3056 (PARALLEL ONLY) Limit the number of concurrent threads per processor
3057 to <Literal>&lt;num&gt;</Literal>.  The default is 32.  Each thread requires slightly over 1K
3058 <Emphasis>words</Emphasis> in the heap for thread state and stack objects.  (For
3059 32-bit machines, this translates to 4K bytes, and for 64-bit machines,
3060 8K bytes.)
3061 </Para>
3062 </ListItem>
3063 </VarListEntry>
3064 <VarListEntry>
3065 <Term><Option>-d</Option>:</Term>
3066 <ListItem>
3067 <Para>
3068 <IndexTerm><Primary>-d RTS option (parallel)</Primary></IndexTerm>
3069 (PARALLEL ONLY) Turn on debugging.  It pops up one xterm (or GDB, or
3070 something&hellip;) per PVM processor.  We use the standard <Command>debugger</Command>
3071 script that comes with PVM3, but we sometimes meddle with the
3072 <Command>debugger2</Command> script.  We include ours in the GHC distribution,
3073 in <Filename>ghc/utils/pvm/</Filename>.
3074 </Para>
3075 </ListItem>
3076 </VarListEntry>
3077 <VarListEntry>
3078 <Term><Option>-e&lt;num&gt;</Option>:</Term>
3079 <ListItem>
3080 <Para>
3081 <IndexTerm><Primary>-e&lt;num&gt; RTS option (parallel)</Primary></IndexTerm>
3082 (PARALLEL ONLY) Limit the number of pending sparks per processor to
3083 <Literal>&lt;num&gt;</Literal>. The default is 100. A larger number may be appropriate if
3084 your program generates large amounts of parallelism initially.
3085 </Para>
3086 </ListItem>
3087 </VarListEntry>
3088 <VarListEntry>
3089 <Term><Option>-Q&lt;num&gt;</Option>:</Term>
3090 <ListItem>
3091 <Para>
3092 <IndexTerm><Primary>-Q&lt;num&gt; RTS option (parallel)</Primary></IndexTerm>
3093 (PARALLEL ONLY) Set the size of packets transmitted between processors
3094 to <Literal>&lt;num&gt;</Literal>. The default is 1024 words. A larger number may be
3095 appropriate if your machine has a high communication cost relative to
3096 computation speed.
3097 </Para>
3098 </ListItem>
3099 </VarListEntry>
3100 </VariableList>
3101 </Para>
3102
3103 </Sect2>
3104
3105 </Sect1>
3106
3107 &runtime
3108 &debug
3109
3110 </Chapter>
3111
3112 <!-- Emacs stuff:
3113      ;;; Local Variables: ***
3114      ;;; mode: sgml ***
3115      ;;; sgml-parent-document: ("users_guide.sgml" "book" "chapter") ***
3116      ;;; End: ***
3117  -->