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 <Para>
 362 FURTHER EXOTICA: If you are doing a normal <Filename>.hs</Filename>-to-<Filename>.o</Filename> compilation
 363 but would like to hang onto the intermediate <Filename>.hc</Filename> C file, just
 364 throw in a <Option>-keep-hc-file-too</Option> option<IndexTerm><Primary>-keep-hc-file-too option</Primary></IndexTerm>.
 365 If you would like to look at the assembler output, toss in a
 366 <Option>-keep-s-file-too</Option>,<IndexTerm><Primary>-keep-s-file-too option</Primary></IndexTerm> too.
 367 </Para>
 368
 369 <Sect2 id="saving-ghc-stderr">
 370 <Title>Saving GHC's standard error output
 371 </Title>
 372
 373 <Para>
 374 <IndexTerm><Primary>standard error, saving</Primary></IndexTerm>
 375 </Para>
 376
 377 <Para>
 378 Sometimes, you may cause GHC to be rather chatty on standard error;
 379 with <Option>-v</Option>, for example.  You can instruct GHC to <Emphasis>append</Emphasis> this
 380 output to a particular log file with a <Option>-odump &lt;blah&gt;</Option><IndexTerm><Primary>-odump
 381 &lt;blah&gt; option</Primary></IndexTerm> option.
 382 </Para>
 383
 384 </Sect2>
 385
 386 <Sect2 id="temp-files">
 387 <Title>Redirecting temporary files
 388 </Title>
 389
 390 <Para>
 391 <IndexTerm><Primary>temporary files, redirecting</Primary></IndexTerm>
 392 </Para>
 393
 394 <Para>
 395 If you have trouble because of running out of space in <Filename>/tmp</Filename> (or
 396 wherever your installation thinks temporary files should go), you may
 397 use the <Option>-tmpdir &lt;dir&gt;</Option><IndexTerm><Primary>-tmpdir &lt;dir&gt; option</Primary></IndexTerm> option
 398 to specify an alternate directory.  For example, <Option>-tmpdir .</Option> says to
 399 put temporary files in the current working directory.
 400 </Para>
 401
 402 <Para>
 403 Alternatively, use your <Constant>TMPDIR</Constant> environment variable.<IndexTerm><Primary>TMPDIR
 404 environment variable</Primary></IndexTerm> Set it to the name of the directory where
 405 temporary files should be put.  GCC and other programs will honour the
 406 <Constant>TMPDIR</Constant> variable as well.
 407 </Para>
 408
 409 <Para>
 410 Even better idea: Set the <Constant>TMPDIR</Constant> variable when building GHC, and
 411 never worry about <Constant>TMPDIR</Constant> again. (see the build documentation).
 412 </Para>
 413
 414 </Sect2>
 415
 416 </Sect1>
 417
 418 <Sect1 id="options-sanity">
 419 <Title>Warnings and sanity-checking
 420 </Title>
 421
 422 <Para>
 423 <IndexTerm><Primary>sanity-checking options</Primary></IndexTerm>
 424 <IndexTerm><Primary>warnings</Primary></IndexTerm>
 425 GHC has a number of options that select which types of non-fatal error
 426 messages, otherwise known as warnings, can be generated during
 427 compilation.  By default, you get a standard set of warnings which are
 428 generally likely to indicate bugs in your program.  These are:
 429 <Option>-fwarn-overlpapping-patterns</Option>, <Option>-fwarn-duplicate-exports</Option>, and
 430 <Option>-fwarn-missing-methods</Option>.  The following flags are simple ways to
 431 select standard &ldquo;packages&rdquo; of warnings:
 432 </Para>
 433
 434 <Para>
 435 <VariableList>
 436
 437 <VarListEntry>
 438 <Term><Option>-Wnot</Option>:</Term>
 439 <ListItem>
 440 <Para>
 441 <IndexTerm><Primary>-Wnot option</Primary></IndexTerm>
 442 Turns off all warnings, including the standard ones.
 443 </Para>
 444 </ListItem>
 445 </VarListEntry>
 446
 447 <VarListEntry>
 448 <Term><Option>-w</Option>:</Term>
 449 <ListItem>
 450 <Para>
 451 <IndexTerm><Primary>-w option</Primary></IndexTerm>
 452 Synonym for <Option>-Wnot</Option>.
 453 </Para>
 454 </ListItem>
 455 </VarListEntry>
 456
 457 <VarListEntry>
 458 <Term><Option>-W</Option>:</Term>
 459 <ListItem>
 460 <Para>
 461 <IndexTerm><Primary>-W option</Primary></IndexTerm>
 462 Provides the standard warnings plus <Option>-fwarn-incomplete-patterns</Option>,
 463 <Option>-fwarn-unused-imports</Option> and <Option>-fwarn-unused-binds</Option>.
 464 </Para>
 465 </ListItem>
 466 </VarListEntry>
 467
 468 <VarListEntry>
 469 <Term><Option>-Wall</Option>:</Term>
 470 <ListItem>
 471 <Para>
 472 <IndexTerm><Primary>-Wall option</Primary></IndexTerm>
 473 Turns on all warning options.
 474 </Para>
 475 </ListItem>
 476 </VarListEntry>
 477
 478 </VariableList>
 479 </Para>
 480
 481 <Para>
 482 The full set of warning options is described below.  To turn off any
 483 warning, simply give the corresponding <Option>-fno-warn-...</Option> option on
 484 the command line.
 485 </Para>
 486
 487 <Para>
 488 <VariableList>
 489
 490 <VarListEntry>
 491 <Term><Option>-fwarn-name-shadowing</Option>:</Term>
 492 <ListItem>
 493 <Para>
 494 <IndexTerm><Primary>-fwarn-name-shadowing option</Primary></IndexTerm>
 495 <IndexTerm><Primary>shadowing, warning</Primary></IndexTerm>This option causes a warning to be emitted whenever an inner-scope
 496 value has the same name as an outer-scope value, i.e. the inner value
 497 shadows the outer one.  This can catch typographical errors that turn
 498 into hard-to-find bugs, e.g., in the inadvertent cyclic definition
 499 <Literal>let x = ... x ... in</Literal>.
 500 </Para>
 501
 502 <Para>
 503 Consequently, this option does <Emphasis>not</Emphasis> allow cyclic recursive
 504 definitions.
 505 </Para>
 506 </ListItem>
 507 </VarListEntry>
 508
 509 <VarListEntry>
 510 <Term><Option>-fwarn-overlapping-patterns</Option>:</Term>
 511 <ListItem>
 512 <Para>
 513 <IndexTerm><Primary>-fwarn-overlapping-patterns option</Primary></IndexTerm>
 514 <IndexTerm><Primary>overlapping patterns, warning</Primary></IndexTerm>
 515 <IndexTerm><Primary>patterns, overlapping</Primary></IndexTerm>
 516 By default, the compiler will warn you if a set of patterns are
 517 overlapping, i.e.,
 518 </Para>
 519
 520 <Para>
 521 <ProgramListing>
 522 f :: String -&#62; Int
 523 f []     = 0
 524 f (_:xs) = 1
 525 f "2"    = 2
 526 </ProgramListing>
 527 </Para>
 528
 529 <Para>
 530 where the last pattern match in <Function>f</Function> won't ever be reached, as the
 531 second pattern overlaps it. More often than not, redundant patterns
 532 is a programmer mistake/error, so this option is enabled by default.
 533 </Para>
 534 </ListItem>
 535 </VarListEntry>
 536
 537 <VarListEntry>
 538 <Term><Option>-fwarn-incomplete-patterns</Option>:</Term>
 539 <ListItem>
 540 <Para>
 541 <IndexTerm><Primary>-fwarn-incomplete-patterns option</Primary></IndexTerm>
 542 <IndexTerm><Primary>incomplete patterns, warning</Primary></IndexTerm>
 543 <IndexTerm><Primary>patterns, incomplete</Primary></IndexTerm>
 544 Similarly for incomplete patterns, the function <Function>g</Function> below will fail
 545 when applied to non-empty lists, so the compiler will emit a warning
 546 about this when <Option>-fwarn-incomplete-patterns</Option> is enabled.
 547 </Para>
 548
 549 <Para>
 550 <ProgramListing>
 551 g [] = 2
 552 </ProgramListing>
 553 </Para>
 554
 555 <Para>
 556 This option isn't enabled be default because it can be a bit noisy,
 557 and it doesn't always indicate a bug in the program.  However, it's
 558 generally considered good practice to cover all the cases in your
 559 functions.
 560 </Para>
 561 </ListItem>
 562 </VarListEntry>
 563
 564 <VarListEntry>
 565 <Term><Option>-fwarn-missing-methods</Option>:</Term>
 566 <ListItem>
 567 <Para>
 568 <IndexTerm><Primary>-fwarn-missing-methods option</Primary></IndexTerm>
 569 <IndexTerm><Primary>missing methods, warning</Primary></IndexTerm>
 570 <IndexTerm><Primary>methods, missing</Primary></IndexTerm>
 571 This option is on by default, and warns you whenever an instance
 572 declaration is missing one or more methods, and the corresponding
 573 class declaration has no default declaration for them.
 574 </Para>
 575 </ListItem>
 576 </VarListEntry>
 577
 578 <VarListEntry>
 579 <Term><Option>-fwarn-missing-fields</Option>:</Term>
 580 <ListItem>
 581 <Para>
 582 <IndexTerm><Primary>-fwarn-missing-fields option</Primary></IndexTerm>
 583 <IndexTerm><Primary>missing fields, warning</Primary></IndexTerm>
 584 <IndexTerm><Primary>fields, missing</Primary></IndexTerm>
 585 This option is on by default, and warns you whenever the construction
 586 of a labelled field constructor isn't complete, missing initializers
 587 for one or more fields. While not an error (the missing fields are
 588 initialised with bottoms), it is often an indication of a programmer
 589 error.
 590 </Para>
 591 </ListItem>
 592 </VarListEntry>
 593
 594 <VarListEntry>
 595 <Term><Option>-fwarn-unused-imports</Option>:</Term>
 596 <ListItem>
 597 <Para>
 598 <IndexTerm><Primary>-fwarn-unused-imports option</Primary></IndexTerm>
 599 <IndexTerm><Primary>unused imports, warning</Primary></IndexTerm>
 600 <IndexTerm><Primary>imports, unused</Primary></IndexTerm>
 601 Report any objects that are explicitly imported but never used.
 602 </Para>
 603 </ListItem>
 604 </VarListEntry>
 605
 606 <VarListEntry>
 607 <Term><Option>-fwarn-unused-binds</Option>:</Term>
 608 <ListItem>
 609 <Para>
 610 <IndexTerm><Primary>-fwarn-unused-binds option</Primary></IndexTerm>
 611 <IndexTerm><Primary>unused binds, warning</Primary></IndexTerm>
 612 <IndexTerm><Primary>binds, unused</Primary></IndexTerm>
 613 Report any function definitions (and local bindings) which are unused.
 614 For top-level functions, the warning is only given if the binding is
 615 not exported.
 616 </Para>
 617 </ListItem>
 618 </VarListEntry>
 619 <VarListEntry>
 620 <Term><Option>-fwarn-unused-matches</Option>:</Term>
 621 <ListItem>
 622 <Para>
 623 <IndexTerm><Primary>-fwarn-unused-matches option</Primary></IndexTerm>
 624 <IndexTerm><Primary>unused matches, warning</Primary></IndexTerm>
 625 <IndexTerm><Primary>matches, unused</Primary></IndexTerm>
 626 Report all unused variables which arise from pattern matches,
 627 including patterns consisting of a single variable.  For instance <Literal>f x
 628 y = []</Literal> would report <VarName>x</VarName> and <VarName>y</VarName> as unused.  To eliminate the warning,
 629 all unused variables can be replaced with wildcards.
 630 </Para>
 631 </ListItem>
 632 </VarListEntry>
 633
 634 <VarListEntry>
 635 <Term><Option>-fwarn-duplicate-exports</Option>:</Term>
 636 <ListItem>
 637 <Para>
 638 <IndexTerm><Primary>-fwarn-duplicate-exports option</Primary></IndexTerm>
 639 <IndexTerm><Primary>duplicate exports, warning</Primary></IndexTerm>
 640 <IndexTerm><Primary>export lists, duplicates</Primary></IndexTerm>
 641 Have the compiler warn about duplicate entries in export lists. This
 642 is useful information if you maintain large export lists, and want to
 643 avoid the continued export of a definition after you've deleted (one)
 644 mention of it in the export list.
 645 </Para>
 646
 647 <Para>
 648 This option is on by default.
 649 </Para>
 650 </ListItem>
 651 </VarListEntry>
 652
 653 <VarListEntry>
 654 <Term><Option>-fwarn-type-defaults</Option>:</Term>
 655 <ListItem>
 656 <Para>
 657 <IndexTerm><Primary>-fwarn-type-defaults option</Primary></IndexTerm>
 658 <IndexTerm><Primary>defaulting mechanism, warning</Primary></IndexTerm>
 659 Have the compiler warn/inform you where in your source the Haskell
 660 defaulting mechanism for numeric types kicks in. This is useful
 661 information when converting code from a context that assumed one
 662 default into one with another, e.g., the `default default' for Haskell
 663 1.4 caused the otherwise unconstrained value <Constant>1</Constant> to be given
 664 the type <Literal>Int</Literal>, whereas Haskell 98 defaults it to
 665 <Literal>Integer</Literal>.  This may lead to differences in performance and
 666 behaviour, hence the usefulness of being non-silent about this.
 667 </Para>
 668
 669 <Para>
 670 This warning is off by default.
 671 </Para>
 672 </ListItem>
 673 </VarListEntry>
 674
 675 <VarListEntry>
 676 <Term><Option>-fwarn-missing-signatures</Option>:</Term>
 677 <ListItem>
 678 <Para>
 679 <IndexTerm><Primary>-fwarn-missing-signatures option</Primary></IndexTerm>
 680 <IndexTerm><Primary>type signatures, missing</Primary></IndexTerm>
 681 If you would like GHC to check that every top-level function/value has
 682 a type signature, use the <Option>-fwarn-missing-signatures</Option> option.  This
 683 option is off by default.
 684 </Para>
 685 </ListItem>
 686 </VarListEntry>
 687 </VariableList>
 688 </Para>
 689
 690 <Para>
 691 If you're feeling really paranoid, the <Option>-dcore-lint</Option>
 692 option<IndexTerm><Primary>-dcore-lint option</Primary></IndexTerm> is a good choice.  It turns on
 693 heavyweight intra-pass sanity-checking within GHC.  (It checks GHC's
 694 sanity, not yours.)
 695 </Para>
 696
 697 </Sect1>
 698
 699 <Sect1 id="separate-compilation">
 700 <Title>Separate compilation
 701 </Title>
 702
 703 <Para>
 704 <IndexTerm><Primary>separate compilation</Primary></IndexTerm>
 705 <IndexTerm><Primary>recompilation checker</Primary></IndexTerm>
 706 <IndexTerm><Primary>make and recompilation</Primary></IndexTerm>
 707 </Para>
 708
 709 <Para>
 710 This section describes how GHC supports separate compilation.
 711 </Para>
 712
 713 <Sect2 id="hi-files">
 714 <Title>Interface files
 715 </Title>
 716
 717 <Para>
 718 <IndexTerm><Primary>interface files</Primary></IndexTerm>
 719 <IndexTerm><Primary>.hi files</Primary></IndexTerm>
 720 </Para>
 721
 722 <Para>
 723 When GHC compiles a source file <Filename>F</Filename> which contains a module <Literal>A</Literal>, say,
 724 it generates an object <Filename>F.o</Filename>, <Emphasis>and</Emphasis> a companion <Emphasis>interface
 725 file</Emphasis> <Filename>A.hi</Filename>.  The interface file is not intended for human
 726 consumption, as you'll see if you take a look at one.  It's merely
 727 there to help the compiler compile other modules in the same program.
 728 </Para>
 729
 730 <Para>
 731 NOTE: Having the name of the interface file follow the module name and
 732 not the file name, means that working with tools such as <Command>make</Command>
 733 become harder. <Command>make</Command> implicitly assumes that any output files
 734 produced by processing a translation unit will have file names that
 735 can be derived from the file name of the translation unit.  For
 736 instance, pattern rules becomes unusable.  For this reason, we
 737 recommend you stick to using the same file name as the module name.
 738 </Para>
 739
 740 <Para>
 741 The interface file for <Literal>A</Literal> contains information needed by the compiler
 742 when it compiles any module <Literal>B</Literal> that imports <Literal>A</Literal>, whether directly or
 743 indirectly.  When compiling <Literal>B</Literal>, GHC will read <Filename>A.hi</Filename> to find the
 744 details that it needs to know about things defined in <Literal>A</Literal>.
 745 </Para>
 746
 747 <Para>
 748 Furthermore, when compiling module <Literal>C</Literal> which imports <Literal>B</Literal>, GHC may
 749 decide that it needs to know something about <Literal>A</Literal>&mdash;for example, <Literal>B</Literal>
 750 might export a function that involves a type defined in <Literal>A</Literal>.  In this
 751 case, GHC will go and read <Command>A.hi</Command> even though <Literal>C</Literal> does not explicitly
 752 import <Literal>A</Literal> at all.
 753 </Para>
 754
 755 <Para>
 756 The interface file may contain all sorts of things that aren't
 757 explicitly exported from <Literal>A</Literal> by the programmer.  For example, even
 758 though a data type is exported abstractly, <Filename>A.hi</Filename> will contain the
 759 full data type definition.  For small function definitions, <Filename>A.hi</Filename>
 760 will contain the complete definition of the function.  For bigger
 761 functions, <Filename>A.hi</Filename> will contain strictness information about the
 762 function.  And so on.  GHC puts much more information into <Filename>.hi</Filename> files
 763 when optimisation is turned on with the <Option>-O</Option> flag.  Without <Option>-O</Option> it
 764 puts in just the minimum; with <Option>-O</Option> it lobs in a whole pile of stuff.
 765 <IndexTerm><Primary>optimsation, effect on .hi files</Primary></IndexTerm>
 766 </Para>
 767
 768 <Para>
 769 <Filename>A.hi</Filename> should really be thought of as a compiler-readable version of
 770 <Filename>A.o</Filename>.  If you use a <Filename>.hi</Filename> file that wasn't generated by the same
 771 compilation run that generates the <Filename>.o</Filename> file the compiler may assume
 772 all sorts of incorrect things about <Literal>A</Literal>, resulting in core dumps and
 773 other unpleasant happenings.
 774 </Para>
 775
 776 </Sect2>
 777
 778 <Sect2 id="options-finding-imports">
 779 <Title>Finding interface files
 780 </Title>
 781
 782 <Para>
 783 <IndexTerm><Primary>interface files, finding them</Primary></IndexTerm>
 784 <IndexTerm><Primary>finding interface files</Primary></IndexTerm>
 785 </Para>
 786
 787 <Para>
 788 In your program, you import a module <Literal>Foo</Literal> by saying
 789 <Literal>import Foo</Literal>.  GHC goes looking for an interface file, <Filename>Foo.hi</Filename>.
 790 It has a builtin list of directories (notably including <Filename>.</Filename>) where
 791 it looks.
 792 </Para>
 793
 794 <Para>
 795 <VariableList>
 796
 797 <VarListEntry>
 798 <Term><Option>-i&lt;dirs&gt;</Option></Term>
 799 <ListItem>
 800 <Para>
 801 <IndexTerm><Primary>-i&lt;dirs&gt; option</Primary></IndexTerm>This flag
 802 prepends a colon-separated list of <Filename>dirs</Filename> to the &ldquo;import
 803 directories&rdquo; list.
 804 See also <XRef LinkEnd="recomp"> for the significance of using
 805 relative and absolute pathnames in the <Option>-i</Option> list.
 806 </Para>
 807 </ListItem>
 808 </VarListEntry>
 809
 810 <VarListEntry>
 811 <Term><Option>-i</Option></Term>
 812 <ListItem>
 813 <Para>
 814 resets the &ldquo;import directories&rdquo; list back to nothing.
 815 </Para>
 816 </ListItem>
 817 </VarListEntry>
 818
 819 <VarListEntry>
 820 <Term><Option>-fno-implicit-prelude</Option></Term>
 821 <ListItem>
 822 <Para>
 823 <IndexTerm><Primary>-fno-implicit-prelude option</Primary></IndexTerm>
 824 GHC normally imports <Filename>Prelude.hi</Filename> files for you.  If you'd rather it
 825 didn't, then give it a <Option>-fno-implicit-prelude</Option> option.  You are
 826 unlikely to get very far without a Prelude, but, hey, it's a free
 827 country.
 828 </Para>
 829 </ListItem>
 830 </VarListEntry>
 831
 832 <VarListEntry>
 833 <Term><Option>-syslib &lt;lib&gt;</Option></Term>
 834 <ListItem>
 835 <Para>
 836 <IndexTerm><Primary>-syslib &lt;lib&gt; option</Primary></IndexTerm>
 837 If you are using a system-supplied non-Prelude library (e.g., the
 838 POSIX library), just use a <Option>-syslib posix</Option> option (for example).  The
 839 right interface files should then be available.  <XRef LinkEnd="ghc-prelude"> lists the
 840 libraries available by this mechanism.
 841 </Para>
 842 </ListItem>
 843 </VarListEntry>
 844
 845 <VarListEntry>
 846 <Term><Option>-I&lt;dir&gt;</Option></Term>
 847 <ListItem>
 848 <Para>
 849 <IndexTerm><Primary>-I&lt;dir&gt; option</Primary></IndexTerm>
 850 Once a Haskell module has been compiled to C (<Filename>.hc</Filename> file), you may
 851 wish to specify where GHC tells the C compiler to look for <Filename>.h</Filename> files.
 852 (Or, if you are using the <Option>-cpp</Option> option<IndexTerm><Primary>-cpp option</Primary></IndexTerm>, where
 853 it tells the C pre-processor to look&hellip;)  For this purpose, use a <Option>-I</Option>
 854 option in the usual C-ish way.
 855 </Para>
 856 </ListItem>
 857 </VarListEntry>
 858
 859 </VariableList>
 860 </Para>
 861
 862 </Sect2>
 863
 864 <Sect2 id="hi-options">
 865 <Title>Other options related to interface files
 866 </Title>
 867
 868 <Para>
 869 <IndexTerm><Primary>interface files, options</Primary></IndexTerm>
 870 The interface output may be directed to another file
 871 <Filename>bar2/Wurble.iface</Filename> with the option <Option>-ohi bar2/Wurble.iface</Option><IndexTerm><Primary>-ohi
 872 &lt;file&gt; option</Primary></IndexTerm> (not recommended).
 873 </Para>
 874
 875 <Para>
 876 To avoid generating an interface file at all, use a <Option>-nohi</Option>
 877 option.<IndexTerm><Primary>-nohi option</Primary></IndexTerm>
 878 </Para>
 879
 880 <Para>
 881 The compiler does not overwrite an existing <Filename>.hi</Filename> interface file if
 882 the new one is byte-for-byte the same as the old one; this is friendly
 883 to <Command>make</Command>.  When an interface does change, it is often enlightening to
 884 be informed.  The <Option>-hi-diffs</Option><IndexTerm><Primary>-hi-diffs option</Primary></IndexTerm> option will
 885 make GHC run <Command>diff</Command> on the old and new <Filename>.hi</Filename> files. You can also
 886 record the difference in the interface file itself, the
 887 <Option>-keep-hi-diffs</Option><IndexTerm><Primary>-keep-hi-diffs</Primary></IndexTerm> option takes care of that.
 888 </Para>
 889
 890 <Para>
 891 The <Filename>.hi</Filename> files from GHC contain &ldquo;usage&rdquo; information which changes
 892 often and uninterestingly.  If you really want to see these changes
 893 reported, you need to use the
 894 <Option>-hi-diffs-with-usages</Option><IndexTerm><Primary>-hi-diffs-with-usages option</Primary></IndexTerm>
 895 option.
 896 </Para>
 897
 898 <Para>
 899 Interface files are normally jammed full of compiler-produced
 900 <Emphasis>pragmas</Emphasis>, which record arities, strictness info, etc.  If you
 901 think these pragmas are messing you up (or you are doing some kind of
 902 weird experiment), you can tell GHC to ignore them with the
 903 <Option>-fignore-interface-pragmas</Option><IndexTerm><Primary>-fignore-interface-pragmas
 904 option</Primary></IndexTerm> option.
 905 </Para>
 906
 907 <Para>
 908 When compiling without optimisations on, the compiler is extra-careful
 909 about not slurping in data constructors and instance declarations that
 910 it will not need. If you believe it is getting it wrong and not
 911 importing stuff which you think it should, this optimisation can be
 912 turned off with <Option>-fno-prune-tydecls</Option> and <Option>-fno-prune-instdecls</Option>.
 913 <IndexTerm><Primary>-fno-prune-tydecls option</Primary></IndexTerm><IndexTerm><Primary>-fno-prune-instdecls
 914 option</Primary></IndexTerm>
 915 </Para>
 916
 917 <Para>
 918 See also <XRef LinkEnd="options-linker">, which describes how the linker finds standard
 919 Haskell libraries.
 920 </Para>
 921
 922 </Sect2>
 923
 924 <Sect2 id="recomp">
 925 <Title>The recompilation checker
 926 </Title>
 927
 928 <Para>
 929 <IndexTerm><Primary>recompilation checker</Primary></IndexTerm>
 930 </Para>
 931
 932 <Para>
 933 In the olden days, GHC compared the newly-generated <Filename>.hi</Filename> file with
 934 the previous version; if they were identical, it left the old one
 935 alone and didn't change its modification date.  In consequence,
 936 importers of a module with an unchanged output <Filename>.hi</Filename> file were not
 937 recompiled.
 938 </Para>
 939
 940 <Para>
 941 This doesn't work any more.  In our earlier example, module <Literal>C</Literal> does
 942 not import module <Literal>A</Literal> directly, yet changes to <Filename>A.hi</Filename> should force a
 943 recompilation of <Literal>C</Literal>.  And some changes to <Literal>A</Literal> (changing the
 944 definition of a function that appears in an inlining of a function
 945 exported by <Literal>B</Literal>, say) may conceivably not change <Filename>B.hi</Filename> one jot.  So
 946 now&hellip;
 947 </Para>
 948
 949 <Para>
 950 GHC keeps a version number on each interface file, and on each type
 951 signature within the interface file.  It also keeps in every interface
 952 file a list of the version numbers of everything it used when it last
 953 compiled the file.  If the source file's modification date is earlier
 954 than the <Filename>.o</Filename> file's date (i.e. the source hasn't changed since the
 955 file was last compiled), GHC will be clever.  It compares the version
 956 numbers on the things it needs this time with the version numbers on
 957 the things it needed last time (gleaned from the interface file of the
 958 module being compiled); if they are all the same it stops compiling
 959 rather early in the process saying &ldquo;Compilation IS NOT required&rdquo;.
 960 What a beautiful sight!
 961 </Para>
 962
 963 <Para>
 964 GHC <Emphasis>only</Emphasis> keeps detailed dependency information for &ldquo;user&rdquo; modules,
 965 not for &ldquo;library&rdquo; modules.  It distinguishes the two by a hack: a module
 966 whose <Filename>.hi</Filename> file has an absolute path name is considered a library module,
 967 while a relative path name indicates a user module.  So if you have a
 968 multi-directory application, use <Emphasis>relative</Emphasis> path names in your
 969 <Option>-i</Option> path, to force GHC to record detailed dependency information.
 970 Use absolute path names only for directories containing slowly-changing
 971 library modules.
 972 </Para>
 973
 974 <Para>
 975 A path is considered &ldquo;absolute&rdquo; if it starts with &ldquo;<Filename>/</Filename>&rdquo;, or
 976 &ldquo;<Filename>A:/</Filename>&rdquo;, or &ldquo;<Filename>A:\</Filename>&rdquo; (or &ldquo;<Filename>B:/</Filename>&rdquo;, &ldquo;<Filename>B:\</Filename>&rdquo; etc).
 977 </Para>
 978
 979 <Para>
 980 Patrick Sansom had a workshop paper about how all this is done (though
 981 the details have changed quite a bit). <ULink URL="mailto:sansom@dcs.gla.ac.uk">Ask him</ULink>) if you want a copy.
 982 </Para>
 983
 984 </Sect2>
 985
 986 <Sect2 id="using-make">
 987 <Title>Using <Command>make</Command>
 988 </Title>
 989
 990 <Para>
 991 <IndexTerm><Primary><literal>make</literal></Primary></IndexTerm>
 992 </Para>
 993
 994 <Para>
 995 It is reasonably straightforward to set up a <Filename>Makefile</Filename> to use with
 996 GHC, assuming you name your source files the same as your modules.
 997 Thus:
 998 </Para>
 999
1000 <Para>
1001
1002 <ProgramListing>
1003 HC      = ghc
1004 HC_OPTS = -cpp $(EXTRA_HC_OPTS)
1005
1006 SRCS = Main.lhs Foo.lhs Bar.lhs
1007 OBJS = Main.o   Foo.o   Bar.o
1008
1009 .SUFFIXES : .o .hi .lhs .hc .s
1010
1011 cool_pgm : $(OBJS)
1012         rm $@
1013         $(HC) -o $@ $(HC_OPTS) $(OBJS)
1014
1015 # Standard suffix rules
1016 .o.hi:
1017         @:
1018
1019 .lhs.o:
1020         $(HC) -c $&#60; $(HC_OPTS)
1021
1022 .hs.o:
1023         $(HC) -c $&#60; $(HC_OPTS)
1024
1025 # Inter-module dependencies
1026 Foo.o Foo.hc Foo.s    : Baz.hi          # Foo imports Baz
1027 Main.o Main.hc Main.s : Foo.hi Baz.hi   # Main imports Foo and Baz
1028 </ProgramListing>
1029
1030 </Para>
1031
1032 <Para>
1033 (Sophisticated <Command>make</Command> variants may achieve some of the above more
1034 elegantly.  Notably, <Command>gmake</Command>'s pattern rules let you write the more
1035 comprehensible:
1036 </Para>
1037
1038 <Para>
1039
1040 <ProgramListing>
1041 %.o : %.lhs
1042         $(HC) -c $&#60; $(HC_OPTS)
1043 </ProgramListing>
1044
1045 </Para>
1046
1047 <Para>
1048 What we've shown should work with any <Command>make</Command>.)
1049 </Para>
1050
1051 <Para>
1052 Note the cheesy <Literal>.o.hi</Literal> rule: It records the dependency of the
1053 interface (<Filename>.hi</Filename>) file on the source.  The rule says a <Filename>.hi</Filename> file can
1054 be made from a <Filename>.o</Filename> file by doing&hellip;nothing.  Which is true.
1055 </Para>
1056
1057 <Para>
1058 Note the inter-module dependencies at the end of the Makefile, which
1059 take the form
1060 </Para>
1061
1062 <Para>
1063
1064 <ProgramListing>
1065 Foo.o Foo.hc Foo.s    : Baz.hi          # Foo imports Baz
1066 </ProgramListing>
1067
1068 </Para>
1069
1070 <Para>
1071 They tell <Command>make</Command> that if any of <Literal>Foo.o</Literal>, <Literal>Foo.hc</Literal> or <Literal>Foo.s</Literal> have an
1072 earlier modification date than <Literal>Baz.hi</Literal>, then the out-of-date file
1073 must be brought up to date.  To bring it up to date, <Literal>make</Literal> looks for
1074 a rule to do so; one of the preceding suffix rules does the job
1075 nicely.
1076 </Para>
1077
1078 <Para>
1079 Putting inter-dependencies of the form <Literal>Foo.o : Bar.hi</Literal> into your
1080 <Filename>Makefile</Filename> by hand is rather error-prone.  Don't worry&mdash;never fear,
1081 <Command>mkdependHS</Command> is here! (and is distributed as part of GHC) Add the
1082 following to your <Filename>Makefile</Filename>:
1083 </Para>
1084
1085 <Para>
1086
1087 <ProgramListing>
1088 depend :
1089         mkdependHS -- $(HC_OPTS) -- $(SRCS)
1090 </ProgramListing>
1091
1092 </Para>
1093
1094 <Para>
1095 Now, before you start compiling, and any time you change the <Literal>imports</Literal>
1096 in your program, do <Command>make depend</Command> before you do <Command>make cool&lowbar;pgm</Command>.
1097 <Command>mkdependHS</Command> will append the needed dependencies to your <Filename>Makefile</Filename>.
1098 <Command>mkdependHS</Command> is fully described in <XRef LinkEnd="mkdependHS">.
1099 </Para>
1100
1101 <Para>
1102 A few caveats about this simple scheme:
1103 </Para>
1104
1105 <Para>
1106
1107 <ItemizedList>
1108 <ListItem>
1109
1110 <Para>
1111  You may need to compile some modules explicitly to create their
1112 interfaces in the first place (e.g., <Command>make Bar.o</Command> to create <Filename>Bar.hi</Filename>).
1113
1114 </Para>
1115 </ListItem>
1116 <ListItem>
1117
1118 <Para>
1119  You may have to type <Command>make</Command> more than once for the dependencies
1120 to have full effect.  However, a <Command>make</Command> run that does nothing
1121 <Emphasis>does</Emphasis> mean &ldquo;everything's up-to-date.&rdquo;
1122
1123 </Para>
1124 </ListItem>
1125 <ListItem>
1126
1127 <Para>
1128  This scheme will work with mutually-recursive modules but,
1129 again, it may take multiple iterations to &ldquo;settle.&rdquo;
1130
1131 </Para>
1132 </ListItem>
1133
1134 </ItemizedList>
1135
1136 </Para>
1137
1138 </Sect2>
1139
1140 <Sect2 id="mutual-recursion">
1141 <Title>How to compile mutually recursive modules
1142 </Title>
1143
1144 <Para>
1145 <IndexTerm><Primary>module system, recursion</Primary></IndexTerm>
1146 <IndexTerm><Primary>recursion, between modules</Primary></IndexTerm>
1147 </Para>
1148
1149 <Para>
1150 Currently, the compiler does not have proper support for dealing with
1151 mutually recursive modules:
1152 </Para>
1153
1154 <Para>
1155
1156 <ProgramListing>
1157 module A where
1158
1159 import B
1160
1161 newtype TA = MkTA Int
1162
1163 f :: TB -&#62; TA
1164 f (MkTB x) = MkTA x
1165 --------
1166 module B where
1167
1168 import A
1169
1170 data TB = MkTB !Int
1171
1172 g :: TA -&#62; TB
1173 g (MkTA x) = MkTB x
1174 </ProgramListing>
1175
1176 </Para>
1177
1178 <Para>
1179 When compiling either module A and B, the compiler will try (in vain)
1180 to look for the interface file of the other. So, to get mutually
1181 recursive modules off the ground, you need to hand write an interface
1182 file for A or B, so as to break the loop.  These hand-written
1183 interface files are called <Literal>hi-boot</Literal> files, and are placed in a file
1184 called <Filename>&lt;module&gt;.hi-boot</Filename>.  To import from an <Literal>hi-boot</Literal> file instead
1185 of the standard <Filename>.hi</Filename> file, use the following syntax in the importing module:
1186 <IndexTerm><Primary>hi-boot files</Primary></IndexTerm>
1187 <IndexTerm><Primary>importing, hi-boot files</Primary></IndexTerm>
1188 </Para>
1189
1190 <Para>
1191
1192 <ProgramListing>
1193 import {-# SOURCE #-} A
1194 </ProgramListing>
1195
1196 </Para>
1197
1198 <Para>
1199 The hand-written interface need only contain the bare minimum of
1200 information needed to get the bootstrapping process started.  For
1201 example, it doesn't need to contain declarations for <Emphasis>everything</Emphasis>
1202 that module <Literal>A</Literal> exports, only the things required by the module that
1203 imports <Literal>A</Literal> recursively.
1204 </Para>
1205
1206 <Para>
1207 For the example at hand, the boot interface file for A would look like
1208 the following:
1209 </Para>
1210
1211 <Para>
1212
1213 <ProgramListing>
1214 __interface A 1 404 where
1215 __export A TA{MkTA} ;
1216 1 newtype TA = MkTA PrelBase.Int ;
1217 </ProgramListing>
1218
1219 </Para>
1220
1221 <Para>
1222 The syntax is essentially the same as a normal <Filename>.hi</Filename> file
1223 (unfortunately), but you can usually tailor an existing <Filename>.hi</Filename> file to
1224 make a <Filename>.hi-boot</Filename> file.
1225 </Para>
1226
1227 <Para>
1228 Notice that we only put the declaration for the newtype <Literal>TA</Literal> in the
1229 <Literal>hi-boot</Literal> file, not the signature for <Function>f</Function>, since <Function>f</Function> isn't used by
1230 <Literal>B</Literal>.
1231 </Para>
1232
1233 <Para>
1234 The number &ldquo;1&rdquo; after &ldquo;&lowbar;&lowbar;interface A&rdquo; gives the version number of module A;
1235 it is incremented whenever anything in A's interface file changes.  The &ldquo;404&rdquo; is
1236 the version number of the interface file <Emphasis>syntax</Emphasis>; we change it when
1237 we change the syntax of interface files so that you get a better error message when
1238 you try to read an old-format file with a new-format compiler.
1239 </Para>
1240
1241 <Para>
1242 The number &ldquo;1&rdquo; at the beginning of a declaration is the <Emphasis>version
1243 number</Emphasis> of that declaration: for the purposes of <Filename>.hi-boot</Filename> files
1244 these can all be set to 1.  All names must be fully qualified with the
1245 <Emphasis>original</Emphasis> module that an object comes from: for example, the
1246 reference to <Literal>Int</Literal> in the interface for <Literal>A</Literal> comes from <Literal>PrelBase</Literal>,
1247 which is a module internal to GHC's prelude.  It's a pain, but that's
1248 the way it is.
1249 </Para>
1250
1251 <Para>
1252 If you want an hi-boot file to export a data type, but you don't want to give its constructors
1253 (because the constructors aren't used by the SOURCE-importing module), you can write simply:
1254 </Para>
1255
1256 <Para>
1257
1258 <ProgramListing>
1259 __interface A 1 404 where
1260 __export A TA;
1261 1 data TA
1262 </ProgramListing>
1263
1264 </Para>
1265
1266 <Para>
1267 (You must write all the type parameters, but leave out the '=' and everything that follows it.)
1268 </Para>
1269
1270 <Para>
1271 <Emphasis>Note:</Emphasis> This is all a temporary solution, a version of the
1272 compiler that handles mutually recursive modules properly without the manual
1273 construction of interface files, is (allegedly) in the works.
1274 </Para>
1275
1276 </Sect2>
1277
1278 </Sect1>
1279
1280 <Sect1 id="options-optimise">
1281 <Title>Optimisation (code improvement)
1282 </Title>
1283
1284 <Para>
1285 <IndexTerm><Primary>optimisation (GHC)</Primary></IndexTerm>
1286 <IndexTerm><Primary>improvement, code (GHC)</Primary></IndexTerm>
1287 </Para>
1288
1289 <Para>
1290 The <Option>-O*</Option> options specify convenient &ldquo;packages&rdquo; of optimisation
1291 flags; the <Option>-f*</Option> options described later on specify
1292 <Emphasis>individual</Emphasis> optimisations to be turned on/off; the <Option>-m*</Option>
1293 options specify <Emphasis>machine-specific</Emphasis> optimisations to be turned
1294 on/off.
1295 </Para>
1296
1297 <Sect2 id="optimise-pkgs">
1298 <Title><Option>-O*</Option>: convenient &ldquo;packages&rdquo; of optimisation flags.
1299 </Title>
1300
1301 <Para>
1302 <IndexTerm><Primary>-O options</Primary></IndexTerm>
1303 </Para>
1304
1305 <Para>
1306 There are <Emphasis>many</Emphasis> options that affect the quality of code
1307 produced by GHC.  Most people only have a general goal, something like
1308 &ldquo;Compile quickly&rdquo; or &ldquo;Make my program run like greased lightning.&rdquo;
1309 The following &ldquo;packages&rdquo; of optimisations (or lack thereof) should
1310 suffice.
1311 </Para>
1312
1313 <Para>
1314 Once you choose a <Option>-O*</Option> &ldquo;package,&rdquo; stick with it&mdash;don't chop and
1315 change.  Modules' interfaces <Emphasis>will</Emphasis> change with a shift to a new
1316 <Option>-O*</Option> option, and you may have to recompile a large chunk of all
1317 importing modules before your program can again be run
1318 safely (see <XRef LinkEnd="recomp">).
1319 </Para>
1320
1321 <Para>
1322 <VariableList>
1323
1324 <VarListEntry>
1325 <Term>No <Option>-O*</Option>-type option specified:</Term>
1326 <ListItem>
1327 <Para>
1328 <IndexTerm><Primary>-O* not specified</Primary></IndexTerm>
1329 This is taken to mean: &ldquo;Please compile quickly; I'm not over-bothered
1330 about compiled-code quality.&rdquo;  So, for example: <Command>ghc -c Foo.hs</Command>
1331 </Para>
1332 </ListItem>
1333 </VarListEntry>
1334 <VarListEntry>
1335 <Term><Option>-O</Option> or <Option>-O1</Option>:</Term>
1336 <ListItem>
1337 <Para>
1338 <IndexTerm><Primary>-O option</Primary></IndexTerm>
1339 <IndexTerm><Primary>-O1 option</Primary></IndexTerm>
1340 <IndexTerm><Primary>optimise normally</Primary></IndexTerm>
1341 Means: &ldquo;Generate good-quality code without taking too long about it.&rdquo;
1342 Thus, for example: <Command>ghc -c -O Main.lhs</Command>
1343 </Para>
1344 </ListItem>
1345 </VarListEntry>
1346 <VarListEntry>
1347 <Term><Option>-O2</Option>:</Term>
1348 <ListItem>
1349 <Para>
1350 <IndexTerm><Primary>-O2 option</Primary></IndexTerm>
1351 <IndexTerm><Primary>optimise aggressively</Primary></IndexTerm>
1352 Means: &ldquo;Apply every non-dangerous optimisation, even if it means
1353 significantly longer compile times.&rdquo;
1354 </Para>
1355
1356 <Para>
1357 The avoided &ldquo;dangerous&rdquo; optimisations are those that can make
1358 runtime or space <Emphasis>worse</Emphasis> if you're unlucky.  They are
1359 normally turned on or off individually.
1360 </Para>
1361
1362 <Para>
1363 At the moment, <Option>-O2</Option> is <Emphasis>unlikely</Emphasis> to produce
1364 better code than <Option>-O</Option>.
1365 </Para>
1366 </ListItem>
1367 </VarListEntry>
1368 <VarListEntry>
1369 <Term><Option>-O2-for-C</Option>:</Term>
1370 <ListItem>
1371 <Para>
1372 <IndexTerm><Primary>-O2-for-C option</Primary></IndexTerm>
1373 <IndexTerm><Primary>gcc, invoking with -O2</Primary></IndexTerm>
1374 </Para>
1375
1376 <Para>
1377 Says to run GCC with <Option>-O2</Option>, which may be worth a few percent in
1378 execution speed.  Don't forget <Option>-fvia-C</Option>, lest you use the native-code
1379 generator and bypass GCC altogether!
1380 </Para>
1381 </ListItem>
1382 </VarListEntry>
1383 <VarListEntry>
1384 <Term><Option>-Onot</Option>:</Term>
1385 <ListItem>
1386 <Para>
1387 <IndexTerm><Primary>-Onot option</Primary></IndexTerm>
1388 <IndexTerm><Primary>optimising, reset</Primary></IndexTerm>
1389 </Para>
1390
1391 <Para>
1392 This option will make GHC &ldquo;forget&rdquo; any <Option>-O</Option>ish options it has seen so
1393 far.  Sometimes useful; for example: <Command>make all EXTRA&lowbar;HC&lowbar;OPTS=-Onot</Command>.
1394 </Para>
1395 </ListItem>
1396 </VarListEntry>
1397 <VarListEntry>
1398 <Term><Option>-Ofile &lt;file&gt;</Option>:</Term>
1399 <ListItem>
1400 <Para>
1401 <IndexTerm><Primary>-Ofile &lt;file&gt; option</Primary></IndexTerm>
1402 <IndexTerm><Primary>optimising, customised</Primary></IndexTerm>
1403 </Para>
1404
1405 <Para>
1406 For those who need <Emphasis>absolute</Emphasis> control over <Emphasis>exactly</Emphasis>
1407 what options are used (e.g., compiler writers, sometimes :-), a list
1408 of options can be put in a file and then slurped in with <Option>-Ofile</Option>.
1409 </Para>
1410
1411 <Para>
1412 In that file, comments are of the <Literal>&num;</Literal>-to-end-of-line variety; blank
1413 lines and most whitespace is ignored.
1414 </Para>
1415
1416 <Para>
1417 Please ask if you are baffled and would like an example of <Option>-Ofile</Option>!
1418 </Para>
1419 </ListItem>
1420 </VarListEntry>
1421 </VariableList>
1422 </Para>
1423
1424 <Para>
1425 At Glasgow, we don't use a <Option>-O*</Option> flag for day-to-day work.  We use
1426 <Option>-O</Option> to get respectable speed; e.g., when we want to measure
1427 something.  When we want to go for broke, we tend to use <Option>-O -fvia-C
1428 -O2-for-C</Option> (and we go for lots of coffee breaks).
1429 </Para>
1430
1431 <Para>
1432 The easiest way to see what <Option>-O</Option> (etc.) &ldquo;really mean&rdquo; is to run with
1433 <Option>-v</Option>, then stand back in amazement.  Alternatively, just look at the
1434 <Literal>HsC&lowbar;minus&lt;blah&gt;</Literal> lists in the GHC driver script.
1435 </Para>
1436
1437 </Sect2>
1438
1439 <Sect2>
1440 <Title><Option>-f*</Option>: platform-independent flags</Title>
1441
1442 <Para>
1443 <IndexTerm><Primary>-f* options (GHC)</Primary></IndexTerm>
1444 <IndexTerm><Primary>-fno-* options (GHC)</Primary></IndexTerm>
1445 </Para>
1446
1447 <Para>
1448 Flags can be turned <Emphasis>off</Emphasis> individually.  (NB: I hope you have a
1449 good reason for doing this&hellip;) To turn off the <Option>-ffoo</Option> flag, just use
1450 the <Option>-fno-foo</Option> flag.<IndexTerm><Primary>-fno-&lt;opt&gt; anti-option</Primary></IndexTerm> So, for
1451 example, you can say <Option>-O2 -fno-strictness</Option>, which will then drop out
1452 any running of the strictness analyser.
1453 </Para>
1454
1455 <Para>
1456 The options you are most likely to want to turn off are:
1457
1458 <ItemizedList>
1459 <ListItem>
1460
1461 <Para>
1462 <Option>-fno-strictness</Option><IndexTerm><Primary>-fno-strictness option</Primary></IndexTerm> (strictness
1463 analyser, because it is sometimes slow),
1464 </Para>
1465 </ListItem>
1466 <ListItem>
1467
1468 <Para>
1469 <Option>-fno-specialise</Option><IndexTerm><Primary>-fno-specialise option</Primary></IndexTerm> (automatic
1470 specialisation of overloaded functions, because it can make your code
1471 bigger) (US spelling also accepted), and
1472 </Para>
1473 </ListItem>
1474 <ListItem>
1475
1476 <Para>
1477 <Option>-fno-cpr-analyse</Option><IndexTerm><Primary>-fno-cpr-analyse option</Primary></IndexTerm> switches off the CPR (constructed product
1478 result) analyser.
1479 </Para>
1480 </ListItem>
1481
1482 </ItemizedList>
1483
1484 </Para>
1485
1486 <Para>
1487 Should you wish to turn individual flags <Emphasis>on</Emphasis>, you are advised
1488 to use the <Option>-Ofile</Option> option, described above.  Because the order in
1489 which optimisation passes are run is sometimes crucial, it's quite
1490 hard to do with command-line options.
1491 </Para>
1492
1493 <Para>
1494 Here are some &ldquo;dangerous&rdquo; optimisations you <Emphasis>might</Emphasis> want to try:
1495 <VariableList>
1496
1497 <VarListEntry>
1498 <Term><Option>-fvia-C</Option>:</Term>
1499 <ListItem>
1500 <Para>
1501 <IndexTerm><Primary>-fvia-C option</Primary></IndexTerm>
1502 <IndexTerm><Primary>native code generator, turning off</Primary></IndexTerm>
1503 </Para>
1504
1505 <Para>
1506 Compile via C, and don't use the native-code generator.  (There are
1507 many cases when GHC does this on its own.)  You might pick up a little
1508 bit of speed by compiling via C.  If you use <Function>&lowbar;ccall&lowbar;gc&lowbar;</Function>s or
1509 <Function>&lowbar;casm&lowbar;</Function>s, you probably <Emphasis>have</Emphasis> to use <Option>-fvia-C</Option>.
1510 </Para>
1511
1512 <Para>
1513 The lower-case incantation, <Option>-fvia-c</Option>, is synonymous.
1514 </Para>
1515
1516 <Para>
1517 Compiling via C will probably be slower (in compilation time) than
1518 using GHC's native code generator.
1519 </Para>
1520 </ListItem>
1521 </VarListEntry>
1522 <VarListEntry>
1523 <Term><Option>-funfolding-interface-threshold&lt;n&gt;</Option>:</Term>
1524 <ListItem>
1525 <Para>
1526 <IndexTerm><Primary>-funfolding-interface-threshold option</Primary></IndexTerm>
1527 <IndexTerm><Primary>inlining, controlling</Primary></IndexTerm>
1528 <IndexTerm><Primary>unfolding, controlling</Primary></IndexTerm>
1529 (Default: 30) By raising or lowering this number, you can raise or
1530 lower the amount of pragmatic junk that gets spewed into interface
1531 files.  (An unfolding has a &ldquo;size&rdquo; that reflects the cost in terms
1532 of &ldquo;code bloat&rdquo; of expanding that unfolding in another module.  A
1533 bigger function would be assigned a bigger cost.)
1534 </Para>
1535 </ListItem>
1536 </VarListEntry>
1537 <VarListEntry>
1538 <Term><Option>-funfolding-creation-threshold&lt;n&gt;</Option>:</Term>
1539 <ListItem>
1540 <Para>
1541 <IndexTerm><Primary>-funfolding-creation-threshold option</Primary></IndexTerm>
1542 <IndexTerm><Primary>inlining, controlling</Primary></IndexTerm>
1543 <IndexTerm><Primary>unfolding, controlling</Primary></IndexTerm>
1544 (Default: 30) This option is similar to
1545 <Option>-funfolding-interface-threshold</Option>, except that it governs unfoldings
1546 within a single module.  Increasing this figure is more likely to
1547 result in longer compile times than faster code.  The next option is
1548 more useful:
1549 </Para>
1550 </ListItem>
1551 </VarListEntry>
1552 <VarListEntry>
1553 <Term><Option>-funfolding-use-threshold&lt;n&gt;</Option>:</Term>
1554 <ListItem>
1555 <Para>
1556 <IndexTerm><Primary>-funfolding-use-threshold option</Primary></IndexTerm>
1557 <IndexTerm><Primary>inlining, controlling</Primary></IndexTerm>
1558 <IndexTerm><Primary>unfolding, controlling</Primary></IndexTerm>
1559 (Default: 8) This is the magic cut-off figure for unfolding: below
1560 this size, a function definition will be unfolded at the call-site,
1561 any bigger and it won't.  The size computed for a function depends on
1562 two things: the actual size of the expression minus any discounts that
1563 apply (see <Option>-funfolding-con-discount</Option>).
1564 </Para>
1565 </ListItem>
1566 </VarListEntry>
1567 <VarListEntry>
1568 <Term><Option>-funfolding-con-discount&lt;n&gt;</Option>:</Term>
1569 <ListItem>
1570 <Para>
1571 <IndexTerm><Primary>-funfolding-con-discount option</Primary></IndexTerm>
1572 <IndexTerm><Primary>inlining, controlling</Primary></IndexTerm>
1573 <IndexTerm><Primary>unfolding, controlling</Primary></IndexTerm>
1574 (Default: 2) If the compiler decides that it can eliminate some
1575 computation by performing an unfolding, then this is a discount factor
1576 that it applies to the funciton size before deciding whether to unfold
1577 it or not.
1578 </Para>
1579
1580 <Para>
1581 OK, folks, these magic numbers `30', `8', and '2' are mildly
1582 arbitrary; they are of the &ldquo;seem to be OK&rdquo; variety.  The `8' is the
1583 more critical one; it's what determines how eager GHC is about
1584 expanding unfoldings.
1585 </Para>
1586 </ListItem>
1587 </VarListEntry>
1588 <VarListEntry>
1589 <Term><Option>-funbox-strict-fields</Option>:</Term>
1590 <ListItem>
1591 <Para>
1592 <IndexTerm><Primary>-funbox-strict-fields option</Primary></IndexTerm>
1593 <IndexTerm><Primary>strict constructor fields</Primary></IndexTerm>
1594 <IndexTerm><Primary>constructor fields, strict</Primary></IndexTerm>
1595 </Para>
1596
1597 <Para>
1598 This option causes all constructor fields which are marked strict
1599 (i.e. &ldquo;!&rdquo;) to be unboxed or unpacked if possible.  For example:
1600 </Para>
1601
1602 <Para>
1603
1604 <ProgramListing>
1605 data T = T !Float !Float
1606 </ProgramListing>
1607
1608 </Para>
1609
1610 <Para>
1611 will create a constructor <Literal>T</Literal> containing two unboxed floats if the
1612 <Option>-funbox-strict-fields</Option> flag is given.  This may not always be an
1613 optimisation: if the <Function>T</Function> constructor is scrutinised and the floats
1614 passed to a non-strict function for example, they will have to be
1615 reboxed (this is done automatically by the compiler).
1616 </Para>
1617
1618 <Para>
1619 This option should only be used in conjunction with <Option>-O</Option>, in order to
1620 expose unfoldings to the compiler so the reboxing can be removed as
1621 often as possible.  For example:
1622 </Para>
1623
1624 <Para>
1625
1626 <ProgramListing>
1627 f :: T -&#62; Float
1628 f (T f1 f2) = f1 + f2
1629 </ProgramListing>
1630
1631 </Para>
1632
1633 <Para>
1634 The compiler will avoid reboxing <Function>f1</Function> and <Function>f2</Function> by inlining <Function>+</Function> on
1635 floats, but only when <Option>-O</Option> is on.
1636 </Para>
1637
1638 <Para>
1639 Any single-constructor data is eligible for unpacking; for example
1640 </Para>
1641
1642 <Para>
1643
1644 <ProgramListing>
1645 data T = T !(Int,Int)
1646 </ProgramListing>
1647
1648 </Para>
1649
1650 <Para>
1651 will store the two <Literal>Int</Literal>s directly in the <Function>T</Function> constructor, by flattening
1652 the pair.  Multi-level unpacking is also supported:
1653 </Para>
1654
1655 <Para>
1656
1657 <ProgramListing>
1658 data T = T !S
1659 data S = S !Int !Int
1660 </ProgramListing>
1661
1662 </Para>
1663
1664 <Para>
1665 will store two unboxed <Literal>Int&num;</Literal>s directly in the <Function>T</Function> constructor.
1666 </Para>
1667 </ListItem>
1668 </VarListEntry>
1669 <VarListEntry>
1670 <Term><Option>-fsemi-tagging</Option>:</Term>
1671 <ListItem>
1672 <Para>
1673 This option (which <Emphasis>does not work</Emphasis> with the native-code generator)
1674 tells the compiler to add extra code to test for already-evaluated
1675 values.  You win if you have lots of such values during a run of your
1676 program, you lose otherwise.  (And you pay in extra code space.)
1677 </Para>
1678
1679 <Para>
1680 We have not played with <Option>-fsemi-tagging</Option> enough to recommend it.
1681 (For all we know, it doesn't even work anymore&hellip; Sigh.)
1682 </Para>
1683 </ListItem>
1684 </VarListEntry>
1685 </VariableList>
1686 </Para>
1687
1688 </Sect2>
1689
1690 <Sect2>
1691 <Title><Option>-m*</Option>: platform-specific flags</Title>
1692
1693 <Para>
1694 <IndexTerm><Primary>-m* options (GHC)</Primary></IndexTerm>
1695 <IndexTerm><Primary>platform-specific options</Primary></IndexTerm>
1696 <IndexTerm><Primary>machine-specific options</Primary></IndexTerm>
1697 </Para>
1698
1699 <Para>
1700 Some flags only make sense for particular target platforms.
1701 </Para>
1702
1703 <Para>
1704 <VariableList>
1705
1706 <VarListEntry>
1707 <Term><Option>-mv8</Option>:</Term>
1708 <ListItem>
1709 <Para>
1710 (SPARC machines)<IndexTerm><Primary>-mv8 option (SPARC only)</Primary></IndexTerm>
1711 Means to pass the like-named option to GCC; it says to use the
1712 Version 8 SPARC instructions, notably integer multiply and divide.
1713 The similiar <Option>-m*</Option> GCC options for SPARC also work, actually.
1714 </Para>
1715 </ListItem>
1716 </VarListEntry>
1717 <VarListEntry>
1718 <Term><Option>-mlong-calls</Option>:</Term>
1719 <ListItem>
1720 <Para>
1721 (HPPA machines)<IndexTerm><Primary>-mlong-calls option (HPPA only)</Primary></IndexTerm>
1722 Means to pass the like-named option to GCC.  Required for Very Big
1723 modules, maybe.  (Probably means you're in trouble&hellip;)
1724 </Para>
1725 </ListItem>
1726 </VarListEntry>
1727 <VarListEntry>
1728 <Term><Option>-monly-[32]-regs</Option>:</Term>
1729 <ListItem>
1730 <Para>
1731 (iX86 machines)<IndexTerm><Primary>-monly-N-regs option (iX86 only)</Primary></IndexTerm>
1732 GHC tries to &ldquo;steal&rdquo; four registers from GCC, for performance
1733 reasons; it almost always works.  However, when GCC is compiling some
1734 modules with four stolen registers, it will crash, probably saying:
1735
1736 <Screen>
1737 Foo.hc:533: fixed or forbidden register was spilled.
1738 This may be due to a compiler bug or to impossible asm
1739 statements or clauses.
1740 </Screen>
1741
1742 Just give some registers back with <Option>-monly-N-regs</Option>.  Try `3' first,
1743 then `2'.  If `2' doesn't work, please report the bug to us.
1744 </Para>
1745 </ListItem>
1746 </VarListEntry>
1747 </VariableList>
1748 </Para>
1749
1750 </Sect2>
1751
1752 <Sect2 id="optimise-C-compiler">
1753 <Title>Code improvement by the C compiler.
1754 </Title>
1755
1756 <Para>
1757 <IndexTerm><Primary>optimisation by GCC</Primary></IndexTerm>
1758 <IndexTerm><Primary>GCC optimisation</Primary></IndexTerm>
1759 </Para>
1760
1761 <Para>
1762 The C&nbsp;compiler (GCC) is run with <Option>-O</Option> turned on.  (It has
1763 to be, actually).
1764 </Para>
1765
1766 <Para>
1767 If you want to run GCC with <Option>-O2</Option>&mdash;which may be worth a few
1768 percent in execution speed&mdash;you can give a
1769 <Option>-O2-for-C</Option><IndexTerm><Primary>-O2-for-C option</Primary></IndexTerm> option.
1770 </Para>
1771
1772 </Sect2>
1773
1774 </Sect1>
1775
1776 <Sect1 id="options-phases">
1777 <Title>Options related to a particular phase
1778 </Title>
1779
1780 <Sect2 id="c-pre-processor">
1781 <Title>The C pre-processor
1782 </Title>
1783
1784 <Para>
1785 <IndexTerm><Primary>pre-processing: cpp</Primary></IndexTerm>
1786 <IndexTerm><Primary>C pre-processor options</Primary></IndexTerm>
1787 <IndexTerm><Primary>cpp, pre-processing with</Primary></IndexTerm>
1788 </Para>
1789
1790 <Para>
1791 The C pre-processor <Command>cpp</Command> is run over your Haskell code only if the
1792 <Option>-cpp</Option> option <IndexTerm><Primary>-cpp option</Primary></IndexTerm> is given.  Unless you are
1793 building a large system with significant doses of conditional
1794 compilation, you really shouldn't need it.
1795 <VariableList>
1796
1797 <VarListEntry>
1798 <Term><Option>-D&lt;foo&gt;</Option>:</Term>
1799 <ListItem>
1800 <Para>
1801 <IndexTerm><Primary>-D&lt;name&gt; option</Primary></IndexTerm>
1802 Define macro <Constant>&lt;foo&gt;</Constant> in the usual way.  NB: does <Emphasis>not</Emphasis> affect
1803 <Option>-D</Option> macros passed to the C&nbsp;compiler when compiling via C!  For those,
1804 use the <Option>-optc-Dfoo</Option> hack&hellip; (see <XRef LinkEnd="forcing-options-through">).
1805 </Para>
1806 </ListItem>
1807 </VarListEntry>
1808 <VarListEntry>
1809 <Term><Option>-U&lt;foo&gt;</Option>:</Term>
1810 <ListItem>
1811 <Para>
1812 <IndexTerm><Primary>-U&lt;name&gt; option</Primary></IndexTerm>
1813 Undefine macro <Command>&lt;foo&gt;</Command> in the usual way.
1814 </Para>
1815 </ListItem>
1816 </VarListEntry>
1817 <VarListEntry>
1818 <Term><Option>-I&lt;dir&gt;</Option>:</Term>
1819 <ListItem>
1820 <Para>
1821 <IndexTerm><Primary>-I&lt;dir&gt; option</Primary></IndexTerm>
1822 Specify a directory in which to look for <Literal>&num;include</Literal> files, in
1823 the usual C way.
1824 </Para>
1825 </ListItem>
1826 </VarListEntry>
1827 </VariableList>
1828 </Para>
1829
1830 <Para>
1831 The GHC driver pre-defines several macros when processing Haskell
1832 source code (<Filename>.hs</Filename> or <Filename>.lhs</Filename> files):
1833 </Para>
1834
1835 <Para>
1836 <VariableList>
1837
1838 <VarListEntry>
1839 <Term><Constant>&lowbar;&lowbar;HASKELL98&lowbar;&lowbar;</Constant>:</Term>
1840 <ListItem>
1841 <Para>
1842 <IndexTerm><Primary>&lowbar;&lowbar;HASKELL98&lowbar;&lowbar;</Primary></IndexTerm>
1843 If defined, this means that GHC supports the language defined by the
1844 Haskell 98 report.
1845 </Para>
1846 </ListItem>
1847 </VarListEntry>
1848 <VarListEntry>
1849 <Term><Constant>&lowbar;&lowbar;HASKELL&lowbar;&lowbar;=98</Constant>:</Term>
1850 <ListItem>
1851 <Para>
1852 <IndexTerm><Primary>&lowbar;&lowbar;HASKELL&lowbar;&lowbar;</Primary></IndexTerm>
1853 In GHC 4.04 and later, the <Constant>&lowbar;&lowbar;HASKELL&lowbar;&lowbar;</Constant> macro is defined as having
1854 the value <Constant>98</Constant>.
1855 </Para>
1856 </ListItem>
1857 </VarListEntry>
1858 <VarListEntry>
1859 <Term><Constant>&lowbar;&lowbar;HASKELL1&lowbar;&lowbar;</Constant>:</Term>
1860 <ListItem>
1861 <Para>
1862 <IndexTerm><Primary>&lowbar;&lowbar;HASKELL1&lowbar;&lowbar; macro</Primary></IndexTerm>
1863 If defined to <Emphasis>n</Emphasis>, that means GHC supports the Haskell language
1864 defined in the Haskell report version <Emphasis>1.n</Emphasis>.  Currently 5.  This
1865 macro is deprecated, and will probably disappear in future versions.
1866 </Para>
1867 </ListItem>
1868 </VarListEntry>
1869 <VarListEntry>
1870 <Term><Constant>&lowbar;&lowbar;GLASGOW&lowbar;HASKELL&lowbar;&lowbar;</Constant>:</Term>
1871 <ListItem>
1872 <Para>
1873 <IndexTerm><Primary>&lowbar;&lowbar;GLASGOW&lowbar;HASKELL&lowbar;&lowbar; macro</Primary></IndexTerm>
1874 For version <Emphasis>n</Emphasis> of the GHC system, this will be <Literal>&num;define</Literal>d to
1875 <Emphasis>100n</Emphasis>.  So, for version 4.00, it is 400.
1876 </Para>
1877
1878 <Para>
1879 With any luck, <Constant>&lowbar;&lowbar;GLASGOW&lowbar;HASKELL&lowbar;&lowbar;</Constant> will be undefined in all other
1880 implementations that support C-style pre-processing.
1881 </Para>
1882
1883 <Para>
1884 (For reference: the comparable symbols for other systems are:
1885 <Constant>&lowbar;&lowbar;HUGS&lowbar;&lowbar;</Constant> for Hugs and <Constant>&lowbar;&lowbar;HBC&lowbar;&lowbar;</Constant> for Chalmers.)
1886 </Para>
1887
1888 <Para>
1889 NB. This macro is set when pre-processing both Haskell source and C
1890 source, including the C source generated from a Haskell module
1891 (i.e. <Filename>.hs</Filename>, <Filename>.lhs</Filename>, <Filename>.c</Filename> and <Filename>.hc</Filename> files).
1892 </Para>
1893 </ListItem>
1894 </VarListEntry>
1895 <VarListEntry>
1896 <Term><Constant>&lowbar;&lowbar;CONCURRENT&lowbar;HASKELL&lowbar;&lowbar;</Constant>:</Term>
1897 <ListItem>
1898 <Para>
1899 <IndexTerm><Primary>&lowbar;&lowbar;CONCURRENT&lowbar;HASKELL&lowbar;&lowbar; macro</Primary></IndexTerm>
1900 This symbol is defined when pre-processing Haskell (input) and
1901 pre-processing C (GHC output).  Since GHC from verion 4.00 now
1902 supports concurrent haskell by default, this symbol is always defined.
1903 </Para>
1904 </ListItem>
1905 </VarListEntry>
1906 <VarListEntry>
1907 <Term><Constant>&lowbar;&lowbar;PARALLEL&lowbar;HASKELL&lowbar;&lowbar;</Constant>:</Term>
1908 <ListItem>
1909 <Para>
1910 <IndexTerm><Primary>&lowbar;&lowbar;PARALLEL&lowbar;HASKELL&lowbar;&lowbar; macro</Primary></IndexTerm>
1911 Only defined when <Option>-parallel</Option> is in use!  This symbol is defined when
1912 pre-processing Haskell (input) and pre-processing C (GHC output).
1913 </Para>
1914 </ListItem>
1915 </VarListEntry>
1916 </VariableList>
1917 </Para>
1918
1919 <Para>
1920 Options other than the above can be forced through to the C
1921 pre-processor with the <Option>-opt</Option> flags (see
1922 <XRef LinkEnd="forcing-options-through">).
1923 </Para>
1924
1925 <Para>
1926 A small word of warning: <Option>-cpp</Option> is not friendly to &ldquo;string
1927 gaps&rdquo;.<IndexTerm><Primary>-cpp vs string gaps</Primary></IndexTerm><IndexTerm><Primary>string gaps vs
1928 -cpp</Primary></IndexTerm>.  In other words, strings such as the following:
1929 </Para>
1930
1931 <Para>
1932
1933 <ProgramListing>
1934 strmod = "\
1935 \ p \
1936 \ "
1937 </ProgramListing>
1938
1939 </Para>
1940
1941 <Para>
1942 don't work with <Option>-cpp</Option>; <Filename>/usr/bin/cpp</Filename> elides the
1943 backslash-newline pairs.
1944 </Para>
1945
1946 <Para>
1947 However, it appears that if you add a space at the end of the line,
1948 then <Command>cpp</Command> (at least GNU <Command>cpp</Command> and possibly other <Command>cpp</Command>s)
1949 leaves the backslash-space pairs alone and the string gap works as
1950 expected.
1951 </Para>
1952
1953 </Sect2>
1954
1955 <Sect2 id="options-C-compiler">
1956 <Title>Options affecting the C compiler (if applicable)
1957 </Title>
1958
1959 <Para>
1960 <IndexTerm><Primary>include-file options</Primary></IndexTerm>
1961 <IndexTerm><Primary>C compiler options</Primary></IndexTerm>
1962 <IndexTerm><Primary>GCC options</Primary></IndexTerm>
1963 </Para>
1964
1965 <Para>
1966 At the moment, quite a few common C-compiler options are passed on
1967 quietly to the C compilation of Haskell-compiler-generated C files.
1968 THIS MAY CHANGE.  Meanwhile, options so sent are:
1969 </Para>
1970
1971 <Para>
1972
1973 <InformalTable>
1974 <TGroup Cols="2">
1975 <ColSpec Align="Left" Colsep="0">
1976 <ColSpec Align="Left" Colsep="0">
1977 <TBody>
1978 <Row>
1979 <Entry><Option>-ansi</Option> </Entry>
1980 <Entry> do ANSI C (not K&amp;R) </Entry>
1981 </Row>
1982 <Row>
1983 <Entry>
1984 <Option>-pedantic</Option> </Entry>
1985 <Entry> be so</Entry>
1986 </Row>
1987 <Row>
1988 <Entry>
1989 <Option>-dgcc-lint</Option> </Entry>
1990 <Entry> (hack) short for &ldquo;make GCC very paranoid&rdquo;</Entry>
1991 </Row>
1992
1993 </TBody>
1994
1995 </TGroup>
1996 </InformalTable>
1997
1998 <IndexTerm><Primary>-ansi option (for GCC)</Primary></IndexTerm>
1999 <IndexTerm><Primary>-pedantic option (for GCC)</Primary></IndexTerm>
2000 <IndexTerm><Primary>-dgcc-lint option (GCC paranoia)</Primary></IndexTerm>
2001 </Para>
2002
2003 <Para>
2004 If you are compiling with lots of <Literal>ccalls</Literal>, etc., you may need to
2005 tell the C&nbsp;compiler about some <Literal>&num;include</Literal> files.  There is no real
2006 pretty way to do this, but you can use this hack from the
2007 command-line:
2008 </Para>
2009
2010 <Para>
2011
2012 <Screen>
2013 % ghc -c '-#include &#60;X/Xlib.h&#62;' Xstuff.lhs
2014 </Screen>
2015
2016 </Para>
2017
2018 </Sect2>
2019
2020 <Sect2 id="options-linker">
2021 <Title>Linking and consistency-checking
2022 </Title>
2023
2024 <Para>
2025 <IndexTerm><Primary>linker options</Primary></IndexTerm>
2026 <IndexTerm><Primary>ld options</Primary></IndexTerm>
2027 </Para>
2028
2029 <Para>
2030 GHC has to link your code with various libraries, possibly including:
2031 user-supplied, GHC-supplied, and system-supplied (<Option>-lm</Option> math
2032 library, for example).
2033 </Para>
2034
2035 <Para>
2036 <VariableList>
2037
2038 <VarListEntry>
2039 <Term><Option>-l&lt;FOO&gt;</Option>:</Term>
2040 <ListItem>
2041 <Para>
2042 <IndexTerm><Primary>-l&lt;lib&gt; option</Primary></IndexTerm>
2043 Link in a library named <Filename>lib&lt;FOO&gt;.a</Filename> which resides somewhere on the
2044 library directories path.
2045 </Para>
2046
2047 <Para>
2048 Because of the sad state of most UNIX linkers, the order of such
2049 options does matter.  Thus: <Command>ghc -lbar *.o</Command> is almost certainly
2050 wrong, because it will search <Filename>libbar.a</Filename> <Emphasis>before</Emphasis> it has
2051 collected unresolved symbols from the <Filename>*.o</Filename> files.
2052 <Command>ghc *.o -lbar</Command> is probably better.
2053 </Para>
2054
2055 <Para>
2056 The linker will of course be informed about some GHC-supplied
2057 libraries automatically; these are:
2058 </Para>
2059
2060 <Para>
2061
2062 <InformalTable>
2063 <TGroup Cols="2">
2064 <ColSpec Align="Left" Colsep="0">
2065 <ColSpec Align="Left" Colsep="0">
2066 <TBody>
2067 <Row>
2068 <Entry><Emphasis>-l equivalent</Emphasis> </Entry>
2069 <Entry> <Emphasis>description</Emphasis> </Entry>
2070 </Row>
2071
2072 <Row>
2073 <Entry>
2074 <Option>-lHSrts,-lHSclib</Option> </Entry>
2075 <Entry> basic runtime libraries </Entry>
2076 </Row>
2077 <Row>
2078 <Entry>
2079 <Option>-lHS</Option> </Entry>
2080 <Entry> standard Prelude library </Entry>
2081 </Row>
2082 <Row>
2083 <Entry>
2084 <Option>-lHS&lowbar;cbits</Option> </Entry>
2085 <Entry> C support code for standard Prelude library </Entry>
2086 </Row>
2087 <Row>
2088 <Entry>
2089 <Option>-lgmp</Option> </Entry>
2090 <Entry> GNU multi-precision library (for Integers)</Entry>
2091 </Row>
2092
2093 </TBody>
2094
2095 </TGroup>
2096 </InformalTable>
2097
2098 </Para>
2099
2100 <Para>
2101 <IndexTerm><Primary>-lHS library</Primary></IndexTerm>
2102 <IndexTerm><Primary>-lHS&lowbar;cbits library</Primary></IndexTerm>
2103 <IndexTerm><Primary>-lHSrts library</Primary></IndexTerm>
2104 <IndexTerm><Primary>-lgmp library</Primary></IndexTerm>
2105 </Para>
2106 </ListItem>
2107 </VarListEntry>
2108 <VarListEntry>
2109 <Term><Option>-syslib &lt;name&gt;</Option>:</Term>
2110 <ListItem>
2111 <Para>
2112 <IndexTerm><Primary>-syslib &lt;name&gt; option</Primary></IndexTerm>
2113 </Para>
2114
2115 <Para>
2116 If you are using a Haskell &ldquo;system library&rdquo; (e.g., the POSIX
2117 library), just use the <Option>-syslib posix</Option> option, and the correct code
2118 should be linked in.
2119 </Para>
2120 </ListItem>
2121 </VarListEntry>
2122 <VarListEntry>
2123 <Term><Option>-L&lt;dir&gt;</Option>:</Term>
2124 <ListItem>
2125 <Para>
2126 <IndexTerm><Primary>-L&lt;dir&gt; option</Primary></IndexTerm>
2127 Where to find user-supplied libraries&hellip;  Prepend the directory
2128 <Filename>&lt;dir&gt;</Filename> to the library directories path.
2129 </Para>
2130 </ListItem>
2131 </VarListEntry>
2132 <VarListEntry>
2133 <Term><Option>-static</Option>:</Term>
2134 <ListItem>
2135 <Para>
2136 <IndexTerm><Primary>-static option</Primary></IndexTerm>
2137 Tell the linker to avoid shared libraries.
2138 </Para>
2139 </ListItem>
2140 </VarListEntry>
2141 <VarListEntry>
2142 <Term><Option>-no-link-chk</Option> and <Option>-link-chk</Option>:</Term>
2143 <ListItem>
2144 <Para>
2145 <IndexTerm><Primary>-no-link-chk option</Primary></IndexTerm>
2146 <IndexTerm><Primary>-link-chk option</Primary></IndexTerm>
2147 <IndexTerm><Primary>consistency checking of executables</Primary></IndexTerm>
2148 By default, immediately after linking an executable, GHC verifies that
2149 the pieces that went into it were compiled with compatible flags; a
2150 &ldquo;consistency check&rdquo;.
2151 (This is to avoid mysterious failures caused by non-meshing of
2152 incompatibly-compiled programs; e.g., if one <Filename>.o</Filename> file was compiled
2153 for a parallel machine and the others weren't.)  You may turn off this
2154 check with <Option>-no-link-chk</Option>.  You can turn it (back) on with
2155 <Option>-link-chk</Option> (the default).
2156 </Para>
2157 </ListItem>
2158 </VarListEntry>
2159 <VarListEntry>
2160 <Term><Option>-no-hs-main</Option>:</Term>
2161 <ListItem>
2162 <Para>
2163 <IndexTerm><Primary>-no-hs-main option</Primary></IndexTerm>
2164 <IndexTerm><Primary>linking Haskell libraries with foreign code</Primary></IndexTerm>
2165 </Para>
2166
2167 <Para>
2168 In the event you want to include ghc-compiled code as part of another
2169 (non-Haskell) program, the RTS will not be supplying its definition of
2170 <Function>main()</Function> at link-time, you will have to. To signal that to the
2171 driver script when linking, use <Option>-no-hs-main</Option>.
2172 </Para>
2173
2174 <Para>
2175 Notice that since the command-line passed to the linker is rather
2176 involved, you probably want to use the ghc driver script to do the
2177 final link of your `mixed-language' application. This is not a
2178 requirement though, just try linking once with <Option>-v</Option> on to see what
2179 options the driver passes through to the linker.
2180 </Para>
2181 </ListItem>
2182 </VarListEntry>
2183 </VariableList>
2184 </Para>
2185
2186 </Sect2>
2187
2188 </Sect1>
2189
2190 <Sect1>
2191 <Title>Using Concurrent Haskell</Title>
2192
2193 <Para>
2194 <IndexTerm><Primary>Concurrent Haskell&mdash;use</Primary></IndexTerm>
2195 </Para>
2196
2197 <Para>
2198 GHC (as of version 4.00) supports Concurrent Haskell by default,
2199 without requiring a special option or libraries compiled in a certain
2200 way.  To get access to the support libraries for Concurrent Haskell
2201 (i.e. <Literal>Concurrent</Literal> and friends), use the <Option>-syslib concurrent</Option> option.
2202 </Para>
2203
2204 <Para>
2205 Three RTS options are provided for modifying the behaviour of the
2206 threaded runtime system.  See the descriptions of <Option>-C[&lt;us&gt;]</Option>, <Option>-q</Option>,
2207 and <Option>-t&lt;num&gt;</Option> in <XRef LinkEnd="parallel-rts-opts">.
2208 </Para>
2209
2210 <Para>
2211 Concurrent Haskell is described in more detail in <XRef LinkEnd="concurrent-and-parallel">.
2212 </Para>
2213
2214 </Sect1>
2215
2216 <Sect1>
2217 <Title>Using Parallel Haskell</Title>
2218
2219 <Para>
2220 <IndexTerm><Primary>Parallel Haskell&mdash;use</Primary></IndexTerm>
2221 </Para>
2222
2223 <Para>
2224 &lsqb;You won't be able to execute parallel Haskell programs unless PVM3
2225 (Parallel Virtual Machine, version 3) is installed at your site.]
2226 </Para>
2227
2228 <Para>
2229 To compile a Haskell program for parallel execution under PVM, use the
2230 <Option>-parallel</Option> option,<IndexTerm><Primary>-parallel option</Primary></IndexTerm> both when compiling
2231 <Emphasis>and linking</Emphasis>.  You will probably want to <Literal>import Parallel</Literal>
2232 into your Haskell modules.
2233 </Para>
2234
2235 <Para>
2236 To run your parallel program, once PVM is going, just invoke it &ldquo;as
2237 normal&rdquo;.  The main extra RTS option is <Option>-N&lt;n&gt;</Option>, to say how many
2238 PVM &ldquo;processors&rdquo; your program to run on.  (For more details of
2239 all relevant RTS options, please see <XRef LinkEnd="parallel-rts-opts">.)
2240 </Para>
2241
2242 <Para>
2243 In truth, running Parallel Haskell programs and getting information
2244 out of them (e.g., parallelism profiles) is a battle with the vagaries of
2245 PVM, detailed in the following sections.
2246 </Para>
2247
2248 <Sect2>
2249 <Title>Dummy's guide to using PVM</Title>
2250
2251 <Para>
2252 <IndexTerm><Primary>PVM, how to use</Primary></IndexTerm>
2253 <IndexTerm><Primary>Parallel Haskell&mdash;PVM use</Primary></IndexTerm>
2254 Before you can run a parallel program under PVM, you must set the
2255 required environment variables (PVM's idea, not ours); something like,
2256 probably in your <Filename>.cshrc</Filename> or equivalent:
2257
2258 <ProgramListing>
2259 setenv PVM_ROOT /wherever/you/put/it
2260 setenv PVM_ARCH `$PVM_ROOT/lib/pvmgetarch`
2261 setenv PVM_DPATH $PVM_ROOT/lib/pvmd
2262 </ProgramListing>
2263
2264 </Para>
2265
2266 <Para>
2267 Creating and/or controlling your &ldquo;parallel machine&rdquo; is a purely-PVM
2268 business; nothing specific to Parallel Haskell.
2269 </Para>
2270
2271 <Para>
2272 You use the <Command>pvm</Command><IndexTerm><Primary>pvm command</Primary></IndexTerm> command to start PVM on your
2273 machine.  You can then do various things to control/monitor your
2274 &ldquo;parallel machine;&rdquo; the most useful being:
2275 </Para>
2276
2277 <Para>
2278 <InformalTable>
2279 <TGroup Cols=2>
2280 <ColSpec Align="Left">
2281 <TBody>
2282
2283 <Row>
2284 <Entry><KeyCombo><KeyCap>Control</KeyCap><KeyCap>D</KeyCap></KeyCombo></Entry>
2285 <Entry>exit <Command>pvm</Command>, leaving it running</Entry>
2286 </Row>
2287
2288 <Row>
2289 <Entry><Command>halt</Command></Entry>
2290 <Entry>kill off this &ldquo;parallel machine&rdquo; &amp; exit</Entry>
2291 </Row>
2292
2293 <Row>
2294 <Entry><Command>add &lt;host&gt;</Command></Entry>
2295 <Entry>add <Command>&lt;host&gt;</Command> as a processor</Entry>
2296 </Row>
2297
2298 <Row>
2299 <Entry><Command>delete &lt;host&gt;</Command></Entry>
2300 <Entry>delete <Command>&lt;host&gt;</Command></Entry>
2301 </Row>
2302
2303 <Row>
2304 <Entry><Command>reset</Command></Entry>
2305 <Entry>kill what's going, but leave PVM up</Entry>
2306 </Row>
2307
2308 <Row>
2309 <Entry><Command>conf</Command></Entry>
2310 <Entry>list the current configuration</Entry>
2311 </Row>
2312
2313 <Row>
2314 <Entry><Command>ps</Command></Entry>
2315 <Entry>report processes' status</Entry>
2316 </Row>
2317
2318 <Row>
2319 <Entry><Command>pstat &lt;pid&gt;</Command></Entry>
2320 <Entry>status of a particular process</Entry>
2321 </Row>
2322
2323 </TBody>
2324 </TGroup>
2325 </InformalTable>
2326 </Para>
2327
2328 <Para>
2329 The PVM documentation can tell you much, much more about <Command>pvm</Command>!
2330 </Para>
2331
2332 </Sect2>
2333
2334 <Sect2>
2335 <Title>Parallelism profiles</Title>
2336
2337 <Para>
2338 <IndexTerm><Primary>parallelism profiles</Primary></IndexTerm>
2339 <IndexTerm><Primary>profiles, parallelism</Primary></IndexTerm>
2340 <IndexTerm><Primary>visualisation tools</Primary></IndexTerm>
2341 </Para>
2342
2343 <Para>
2344 With Parallel Haskell programs, we usually don't care about the
2345 results&mdash;only with &ldquo;how parallel&rdquo; it was!  We want pretty pictures.
2346 </Para>
2347
2348 <Para>
2349 Parallelism profiles (&agrave; la <Command>hbcpp</Command>) can be generated with the
2350 <Option>-q</Option><IndexTerm><Primary>-q RTS option (concurrent, parallel)</Primary></IndexTerm> RTS option.  The
2351 per-processor profiling info is dumped into files named
2352 <Filename>&lt;full-path&gt;&lt;program&gt;.gr</Filename>.  These are then munged into a PostScript picture,
2353 which you can then display.  For example, to run your program
2354 <Filename>a.out</Filename> on 8 processors, then view the parallelism profile, do:
2355 </Para>
2356
2357 <Para>
2358
2359 <Screen>
2360 % ./a.out +RTS -N8 -q
2361 % grs2gr *.???.gr &#62; temp.gr     # combine the 8 .gr files into one
2362 % gr2ps -O temp.gr              # cvt to .ps; output in temp.ps
2363 % ghostview -seascape temp.ps   # look at it!
2364 </Screen>
2365
2366 </Para>
2367
2368 <Para>
2369 The scripts for processing the parallelism profiles are distributed
2370 in <Filename>ghc/utils/parallel/</Filename>.
2371 </Para>
2372
2373 </Sect2>
2374
2375 <Sect2>
2376 <Title>Other useful info about running parallel programs</Title>
2377
2378 <Para>
2379 The &ldquo;garbage-collection statistics&rdquo; RTS options can be useful for
2380 seeing what parallel programs are doing.  If you do either
2381 <Option>+RTS -Sstderr</Option><IndexTerm><Primary>-Sstderr RTS option</Primary></IndexTerm> or <Option>+RTS -sstderr</Option>, then
2382 you'll get mutator, garbage-collection, etc., times on standard
2383 error. The standard error of all PE's other than the `main thread'
2384 appears in <Filename>/tmp/pvml.nnn</Filename>, courtesy of PVM.
2385 </Para>
2386
2387 <Para>
2388 Whether doing <Option>+RTS -Sstderr</Option> or not, a handy way to watch
2389 what's happening overall is: <Command>tail -f /tmp/pvml.nnn</Command>.
2390 </Para>
2391
2392 </Sect2>
2393
2394 <Sect2 id="parallel-rts-opts">
2395 <Title>RTS options for Concurrent/Parallel Haskell
2396 </Title>
2397
2398 <Para>
2399 <IndexTerm><Primary>RTS options, concurrent</Primary></IndexTerm>
2400 <IndexTerm><Primary>RTS options, parallel</Primary></IndexTerm>
2401 <IndexTerm><Primary>Concurrent Haskell&mdash;RTS options</Primary></IndexTerm>
2402 <IndexTerm><Primary>Parallel Haskell&mdash;RTS options</Primary></IndexTerm>
2403 </Para>
2404
2405 <Para>
2406 Besides the usual runtime system (RTS) options
2407 (<XRef LinkEnd="runtime-control">), there are a few options particularly
2408 for concurrent/parallel execution.
2409 </Para>
2410
2411 <Para>
2412 <VariableList>
2413
2414 <VarListEntry>
2415 <Term><Option>-N&lt;N&gt;</Option>:</Term>
2416 <ListItem>
2417 <Para>
2418 <IndexTerm><Primary>-N&lt;N&gt; RTS option (parallel)</Primary></IndexTerm>
2419 (PARALLEL ONLY) Use <Literal>&lt;N&gt;</Literal> PVM processors to run this program;
2420 the default is 2.
2421 </Para>
2422 </ListItem>
2423 </VarListEntry>
2424 <VarListEntry>
2425 <Term><Option>-C[&lt;us&gt;]</Option>:</Term>
2426 <ListItem>
2427 <Para>
2428 <IndexTerm><Primary>-C&lt;us&gt; RTS option</Primary></IndexTerm>
2429 Sets the context switch interval to <Literal>&lt;us&gt;</Literal> microseconds.  A context
2430 switch will occur at the next heap allocation after the timer expires.
2431 With <Option>-C0</Option> or <Option>-C</Option>, context switches will occur as often as
2432 possible (at every heap allocation).  By default, context switches
2433 occur every 10 milliseconds.  Note that many interval timers are only
2434 capable of 10 millisecond granularity, so the default setting may be
2435 the finest granularity possible, short of a context switch at every
2436 heap allocation.
2437 </Para>
2438
2439 <Para>
2440 &lsqb;NOTE: this option currently has no effect (version 4.00).  Context
2441 switches happen when the current heap block is full, i.e. every 4k of
2442 allocation].
2443 </Para>
2444 </ListItem>
2445 </VarListEntry>
2446 <VarListEntry>
2447 <Term><Option>-q[v]</Option>:</Term>
2448 <ListItem>
2449 <Para>
2450 <IndexTerm><Primary>-q RTS option</Primary></IndexTerm>
2451 (PARALLEL ONLY) Produce a quasi-parallel profile of thread activity,
2452 in the file <FIlename>&lt;program&gt;.qp</FIlename>.  In the style of <Command>hbcpp</Command>, this profile
2453 records the movement of threads between the green (runnable) and red
2454 (blocked) queues.  If you specify the verbose suboption (<Option>-qv</Option>), the
2455 green queue is split into green (for the currently running thread
2456 only) and amber (for other runnable threads).  We do not recommend
2457 that you use the verbose suboption if you are planning to use the
2458 <Command>hbcpp</Command> profiling tools or if you are context switching at every heap
2459 check (with <Option>-C</Option>).
2460 </Para>
2461 </ListItem>
2462 </VarListEntry>
2463 <VarListEntry>
2464 <Term><Option>-t&lt;num&gt;</Option>:</Term>
2465 <ListItem>
2466 <Para>
2467 <IndexTerm><Primary>-t&lt;num&gt; RTS option</Primary></IndexTerm>
2468 (PARALLEL ONLY) Limit the number of concurrent threads per processor
2469 to <Literal>&lt;num&gt;</Literal>.  The default is 32.  Each thread requires slightly over 1K
2470 <Emphasis>words</Emphasis> in the heap for thread state and stack objects.  (For
2471 32-bit machines, this translates to 4K bytes, and for 64-bit machines,
2472 8K bytes.)
2473 </Para>
2474 </ListItem>
2475 </VarListEntry>
2476 <VarListEntry>
2477 <Term><Option>-d</Option>:</Term>
2478 <ListItem>
2479 <Para>
2480 <IndexTerm><Primary>-d RTS option (parallel)</Primary></IndexTerm>
2481 (PARALLEL ONLY) Turn on debugging.  It pops up one xterm (or GDB, or
2482 something&hellip;) per PVM processor.  We use the standard <Command>debugger</Command>
2483 script that comes with PVM3, but we sometimes meddle with the
2484 <Command>debugger2</Command> script.  We include ours in the GHC distribution,
2485 in <Filename>ghc/utils/pvm/</Filename>.
2486 </Para>
2487 </ListItem>
2488 </VarListEntry>
2489 <VarListEntry>
2490 <Term><Option>-e&lt;num&gt;</Option>:</Term>
2491 <ListItem>
2492 <Para>
2493 <IndexTerm><Primary>-e&lt;num&gt; RTS option (parallel)</Primary></IndexTerm>
2494 (PARALLEL ONLY) Limit the number of pending sparks per processor to
2495 <Literal>&lt;num&gt;</Literal>. The default is 100. A larger number may be appropriate if
2496 your program generates large amounts of parallelism initially.
2497 </Para>
2498 </ListItem>
2499 </VarListEntry>
2500 <VarListEntry>
2501 <Term><Option>-Q&lt;num&gt;</Option>:</Term>
2502 <ListItem>
2503 <Para>
2504 <IndexTerm><Primary>-Q&lt;num&gt; RTS option (parallel)</Primary></IndexTerm>
2505 (PARALLEL ONLY) Set the size of packets transmitted between processors
2506 to <Literal>&lt;num&gt;</Literal>. The default is 1024 words. A larger number may be
2507 appropriate if your machine has a high communication cost relative to
2508 computation speed.
2509 </Para>
2510 </ListItem>
2511 </VarListEntry>
2512 </VariableList>
2513 </Para>
2514
2515 </Sect2>
2516
2517 </Sect1>
2518
2519 &runtime
2520 &debug
2521
2522 </Chapter>