ghc/docs/users_guide/debugging.sgml

   1 <Sect1 id="options-debugging">
   2 <Title>Debugging the compiler
   3 </Title>
   4
   5 <Para>
   6 <IndexTerm><Primary>debugging options (for GHC)</Primary></IndexTerm>
   7 </Para>
   8
   9 <Para>
  10 HACKER TERRITORY. HACKER TERRITORY.
  11 (You were warned.)
  12 </Para>
  13
  14 <Sect2 id="replacing-phases">
  15 <Title>Replacing the program for one or more phases.
  16 </Title>
  17
  18 <Para>
  19 <IndexTerm><Primary>GHC phases, changing</Primary></IndexTerm>
  20 <IndexTerm><Primary>phases, changing GHC</Primary></IndexTerm>
  21 You may specify that a different program be used for one of the phases
  22 of the compilation system, in place of whatever the driver <Command>ghc</Command> has
  23 wired into it.  For example, you might want to try a different
  24 assembler.  The
  25 <Option>-pgm&lt;phase-code&gt;&lt;program-name&gt;</Option><IndexTerm><Primary>-pgm&lt;phase&gt;&lt;stuff&gt;
  26 option</Primary></IndexTerm> option to <Command>ghc</Command> will cause it to use <Literal>&lt;program-name&gt;</Literal>
  27 for phase <Literal>&lt;phase-code&gt;</Literal>, where the codes to indicate the phases are:
  28 </Para>
  29
  30 <Para>
  31 <InformalTable>
  32 <TGroup Cols="2">
  33 <ColSpec Align="Left" Colsep="0">
  34 <ColSpec Align="Left" Colsep="0">
  35 <TBody>
  36 <Row>
  37 <Entry><Emphasis>code</Emphasis> </Entry>
  38 <Entry><Emphasis>phase</Emphasis> </Entry>
  39 </Row>
  40
  41 <Row>
  42 <Entry>
  43 L </Entry>
  44 <Entry> literate pre-processor </Entry>
  45 </Row>
  46 <Row>
  47 <Entry>
  48 P </Entry>
  49 <Entry> C pre-processor (if -cpp only) </Entry>
  50 </Row>
  51 <Row>
  52 <Entry>
  53 C </Entry>
  54 <Entry> Haskell compiler </Entry>
  55 </Row>
  56 <Row>
  57 <Entry>
  58 c </Entry>
  59 <Entry> C compiler</Entry>
  60 </Row>
  61 <Row>
  62 <Entry>
  63 a </Entry>
  64 <Entry> assembler </Entry>
  65 </Row>
  66 <Row>
  67 <Entry>
  68 l </Entry>
  69 <Entry> linker </Entry>
  70 </Row>
  71 <Row>
  72 <Entry>
  73 dep </Entry>
  74 <Entry> Makefile dependency generator </Entry>
  75 </Row>
  76
  77 </TBody>
  78
  79 </TGroup>
  80 </InformalTable>
  81 </Para>
  82
  83 </Sect2>
  84
  85 <Sect2 id="forcing-options-through">
  86 <Title>Forcing options to a particular phase.
  87 </Title>
  88
  89 <Para>
  90 <IndexTerm><Primary>forcing GHC-phase options</Primary></IndexTerm>
  91 </Para>
  92
  93 <Para>
  94 The preceding sections describe driver options that are mostly
  95 applicable to one particular phase.  You may also <Emphasis>force</Emphasis> a
  96 specific option <Option>&lt;option&gt;</Option> to be passed to a particular phase
  97 <Literal>&lt;phase-code&gt;</Literal> by feeding the driver the option
  98 <Option>-opt&lt;phase-code&gt;&lt;option&gt;</Option>.<IndexTerm><Primary>-opt&lt;phase&gt;&lt;stuff&gt;
  99 option</Primary></IndexTerm> The codes to indicate the phases are the same as in the
 100 previous section.
 101 </Para>
 102
 103 <Para>
 104 So, for example, to force an <Option>-Ewurble</Option> option to the assembler, you
 105 would tell the driver <Option>-opta-Ewurble</Option> (the dash before the E is
 106 required).
 107 </Para>
 108
 109 <Para>
 110 Besides getting options to the Haskell compiler with <Option>-optC&lt;blah&gt;</Option>,
 111 you can get options through to its runtime system with
 112 <Option>-optCrts&lt;blah&gt;</Option><IndexTerm><Primary>-optCrts&lt;blah&gt; option</Primary></IndexTerm>.
 113 </Para>
 114
 115 <Para>
 116 So, for example: when I want to use my normal driver but with my
 117 profiled compiler binary, I use this script:
 118
 119 <ProgramListing>
 120 #! /bin/sh
 121 exec /local/grasp_tmp3/simonpj/ghc-BUILDS/working-alpha/ghc/driver/ghc \
 122      -pgmC/local/grasp_tmp3/simonpj/ghc-BUILDS/working-hsc-prof/hsc \
 123      -optCrts-i0.5 \
 124      -optCrts-PT \
 125      "$@"
 126 </ProgramListing>
 127
 128 </Para>
 129
 130 </Sect2>
 131
 132 <Sect2 id="dumping-output">
 133 <Title>Dumping out compiler intermediate structures
 134 </Title>
 135
 136 <Para>
 137 <IndexTerm><Primary>dumping GHC intermediates</Primary></IndexTerm>
 138 <IndexTerm><Primary>intermediate passes, output</Primary></IndexTerm>
 139 </Para>
 140
 141 <Para>
 142 <VariableList>
 143
 144 <VarListEntry>
 145 <Term><Option>-noC</Option>:</Term>
 146 <ListItem>
 147 <Para>
 148 <IndexTerm><Primary>-noC option</Primary></IndexTerm>
 149 Don't bother generating C output <Emphasis>or</Emphasis> an interface file.  Usually
 150 used in conjunction with one or more of the <Option>-ddump-*</Option> options; for
 151 example: <Command>ghc -noC -ddump-simpl Foo.hs</Command>
 152 </Para>
 153 </ListItem>
 154 </VarListEntry>
 155 <VarListEntry>
 156 <Term><Option>-hi</Option>:</Term>
 157 <ListItem>
 158 <Para>
 159 <IndexTerm><Primary>-hi option</Primary></IndexTerm>
 160 <Emphasis>Do</Emphasis> generate an interface file.  This would normally be used in
 161 conjunction with <Option>-noC</Option>, which turns off interface generation;
 162 thus: <Option>-noC -hi</Option>.
 163 </Para>
 164 </ListItem>
 165 </VarListEntry>
 166 <VarListEntry>
 167 <Term><Option>-dshow-passes</Option>:</Term>
 168 <ListItem>
 169 <Para>
 170 <IndexTerm><Primary>-dshow-passes option</Primary></IndexTerm>
 171 Prints a message to stderr as each pass starts.  Gives a warm but
 172 undoubtedly misleading feeling that GHC is telling you what's
 173 happening.
 174 </Para>
 175 </ListItem>
 176 </VarListEntry>
 177 <VarListEntry>
 178 <Term><Option>-ddump-&lt;pass&gt;</Option>:</Term>
 179 <ListItem>
 180 <Para>
 181 <IndexTerm><Primary>-ddump-&lt;pass&gt; options</Primary></IndexTerm>
 182 Make a debugging dump after pass <Literal>&lt;pass&gt;</Literal> (may be common enough to
 183 need a short form&hellip;).  You can get all of these at once (<Emphasis>lots</Emphasis> of
 184 output) by using <Option>-ddump-all</Option>, or most of them with <Option>-ddump-most</Option>.
 185 Some of the most useful ones are:
 186 </Para>
 187
 188 <Para>
 189 <VariableList>
 190
 191 <VarListEntry>
 192 <Term><Option>-ddump-parsed</Option>:</Term>
 193 <ListItem>
 194 <Para>
 195 parser output
 196 </Para>
 197 </ListItem>
 198 </VarListEntry>
 199
 200 <VarListEntry>
 201 <Term><Option>-ddump-rn</Option>:</Term>
 202 <ListItem>
 203 <Para>
 204 renamer output
 205 </Para>
 206 </ListItem>
 207 </VarListEntry>
 208
 209 <VarListEntry>
 210 <Term><Option>-ddump-minimal-imports</Option>:</Term>
 211 <ListItem>
 212 <Para>
 213 Dump to the file "M.imports" (where M is the module being compiled)
 214 a "minimal" set of import declarations.  You can safely replace
 215 all the import declarations in "M.hs" with those found in "M.imports".
 216 Why would you want to do that?  Because the "minimal" imports (a) import
 217 everything explicitly, by name, and (b) import nothing that is not required.
 218 It can be quite painful to maintain this property by hand, so this flag is
 219 intended to reduce the labour.
 220 </Para>
 221 </ListItem>
 222 </VarListEntry>
 223
 224 <VarListEntry>
 225 <Term><Option>-ddump-tc</Option>:</Term>
 226 <ListItem>
 227 <Para>
 228 typechecker output
 229 </Para>
 230 </ListItem>
 231 </VarListEntry>
 232
 233 <VarListEntry>
 234 <Term><Option>-ddump-types</Option>:</Term>
 235 <ListItem>
 236 <Para>
 237 Dump a type signature for each value defined at the top level
 238 of the module.  The list is sorted alphabetically.
 239 Using <Option>-dppr-debug</Option> dumps a type signature for
 240 all the imported and system-defined things as well; useful
 241 for debugging the compiler.
 242 </Para>
 243 </ListItem>
 244 </VarListEntry>
 245
 246 <VarListEntry>
 247 <Term><Option>-ddump-deriv</Option>:</Term>
 248 <ListItem>
 249 <Para>
 250 derived instances
 251 </Para>
 252 </ListItem>
 253 </VarListEntry>
 254 <VarListEntry>
 255 <Term><Option>-ddump-ds</Option>:</Term>
 256 <ListItem>
 257 <Para>
 258 desugarer output
 259 </Para>
 260 </ListItem>
 261 </VarListEntry>
 262 <VarListEntry>
 263 <Term><Option>-ddump-spec</Option>:</Term>
 264 <ListItem>
 265 <Para>
 266 output of specialisation pass
 267 </Para>
 268 </ListItem>
 269 </VarListEntry>
 270 <VarListEntry>
 271 <Term><Option>-ddump-rules</Option>:</Term>
 272 <ListItem>
 273 <Para>
 274 dumps all rewrite rules (including those generated by the specialisation pass)
 275 </Para>
 276 </ListItem>
 277 </VarListEntry>
 278 <VarListEntry>
 279 <Term><Option>-ddump-simpl</Option>:</Term>
 280 <ListItem>
 281 <Para>
 282 simplifer output (Core-to-Core passes)
 283 </Para>
 284 </ListItem>
 285 </VarListEntry>
 286 <VarListEntry>
 287 <Term><Option>-ddump-usagesp</Option>:</Term>
 288 <ListItem>
 289 <Para>
 290 UsageSP inference pre-inf and output
 291 </Para>
 292 </ListItem>
 293 </VarListEntry>
 294 <VarListEntry>
 295 <Term><Option>-ddump-cpranal</Option>:</Term>
 296 <ListItem>
 297 <Para>
 298 CPR analyser output
 299 </Para>
 300 </ListItem>
 301 </VarListEntry>
 302 <VarListEntry>
 303 <Term><Option>-ddump-stranal</Option>:</Term>
 304 <ListItem>
 305 <Para>
 306 strictness analyser output
 307 </Para>
 308 </ListItem>
 309 </VarListEntry>
 310 <VarListEntry>
 311 <Term><Option>-ddump-workwrap</Option>:</Term>
 312 <ListItem>
 313 <Para>
 314 worker/wrapper split output
 315 </Para>
 316 </ListItem>
 317 </VarListEntry>
 318 <VarListEntry>
 319 <Term><Option>-ddump-occur-anal</Option>:</Term>
 320 <ListItem>
 321 <Para>
 322 `occurrence analysis' output
 323 </Para>
 324 </ListItem>
 325 </VarListEntry>
 326 <VarListEntry>
 327 <Term><Option>-ddump-stg</Option>:</Term>
 328 <ListItem>
 329 <Para>
 330 output of STG-to-STG passes
 331 </Para>
 332 </ListItem>
 333 </VarListEntry>
 334 <VarListEntry>
 335 <Term><Option>-ddump-absC</Option>:</Term>
 336 <ListItem>
 337 <Para>
 338 <Emphasis>un</Emphasis>flattened Abstract&nbsp;C
 339 </Para>
 340 </ListItem>
 341 </VarListEntry>
 342 <VarListEntry>
 343 <Term><Option>-ddump-flatC</Option>:</Term>
 344 <ListItem>
 345 <Para>
 346 <Emphasis>flattened</Emphasis> Abstract&nbsp;C
 347 </Para>
 348 </ListItem>
 349 </VarListEntry>
 350 <VarListEntry>
 351 <Term><Option>-ddump-realC</Option>:</Term>
 352 <ListItem>
 353 <Para>
 354 same as what goes to the C compiler
 355 </Para>
 356 </ListItem>
 357 </VarListEntry>
 358 <VarListEntry>
 359 <Term><Option>-ddump-asm</Option>:</Term>
 360 <ListItem>
 361 <Para>
 362 assembly language from the native-code generator
 363 </Para>
 364 </ListItem>
 365 </VarListEntry>
 366 </VariableList>
 367 <IndexTerm><Primary>-ddump-all option</Primary></IndexTerm>
 368 <IndexTerm><Primary>-ddump-most option</Primary></IndexTerm>
 369 <IndexTerm><Primary>-ddump-parsed option</Primary></IndexTerm>
 370 <IndexTerm><Primary>-ddump-rn option</Primary></IndexTerm>
 371 <IndexTerm><Primary>-ddump-tc option</Primary></IndexTerm>
 372 <IndexTerm><Primary>-ddump-deriv option</Primary></IndexTerm>
 373 <IndexTerm><Primary>-ddump-ds option</Primary></IndexTerm>
 374 <IndexTerm><Primary>-ddump-simpl option</Primary></IndexTerm>
 375 <IndexTerm><Primary>-ddump-cpranal option</Primary></IndexTerm>
 376 <IndexTerm><Primary>-ddump-workwrap option</Primary></IndexTerm>
 377 <IndexTerm><Primary>-ddump-rules option</Primary></IndexTerm>
 378 <IndexTerm><Primary>-ddump-usagesp option</Primary></IndexTerm>
 379 <IndexTerm><Primary>-ddump-stranal option</Primary></IndexTerm>
 380 <IndexTerm><Primary>-ddump-occur-anal option</Primary></IndexTerm>
 381 <IndexTerm><Primary>-ddump-spec option</Primary></IndexTerm>
 382 <IndexTerm><Primary>-ddump-stg option</Primary></IndexTerm>
 383 <IndexTerm><Primary>-ddump-absC option</Primary></IndexTerm>
 384 <IndexTerm><Primary>-ddump-flatC option</Primary></IndexTerm>
 385 <IndexTerm><Primary>-ddump-realC option</Primary></IndexTerm>
 386 <IndexTerm><Primary>-ddump-asm option</Primary></IndexTerm>
 387 </Para>
 388 </ListItem>
 389 </VarListEntry>
 390 <VarListEntry>
 391 <Term><Option>-dverbose-simpl</Option> and <Option>-dverbose-stg</Option>:</Term>
 392 <ListItem>
 393 <Para>
 394 <IndexTerm><Primary>-dverbose-simpl option</Primary></IndexTerm>
 395 <IndexTerm><Primary>-dverbose-stg option</Primary></IndexTerm>
 396 Show the output of the intermediate Core-to-Core and STG-to-STG
 397 passes, respectively.  (<Emphasis>Lots</Emphasis> of output!) So: when we're
 398 really desperate:
 399
 400 <Screen>
 401 % ghc -noC -O -ddump-simpl -dverbose-simpl -dcore-lint Foo.hs
 402 </Screen>
 403
 404 </Para>
 405 </ListItem>
 406 </VarListEntry>
 407 <VarListEntry>
 408 <Term><Option>-ddump-simpl-iterations</Option>:</Term>
 409 <ListItem>
 410 <Para>
 411 <IndexTerm><Primary>-ddump-simpl-iterations option</Primary></IndexTerm>
 412 Show the output of each <Emphasis>iteration</Emphasis> of the simplifier (each run of
 413 the simplifier has a maximum number of iterations, normally 4).  Used
 414 when even <Option>-dverbose-simpl</Option> doesn't cut it.
 415 </Para>
 416 </ListItem>
 417 </VarListEntry>
 418 <VarListEntry>
 419 <Term><Option>-dppr-&lcub;user,debug</Option>&rcub;:</Term>
 420 <ListItem>
 421 <Para>
 422 <IndexTerm><Primary>-dppr-user option</Primary></IndexTerm>
 423 <IndexTerm><Primary>-dppr-debug option</Primary></IndexTerm>
 424 Debugging output is in one of several &ldquo;styles.&rdquo;  Take the printing
 425 of types, for example.  In the &ldquo;user&rdquo; style, the compiler's internal
 426 ideas about types are presented in Haskell source-level syntax,
 427 insofar as possible.  In the &ldquo;debug&rdquo; style (which is the default for
 428 debugging output), the types are printed in with
 429 explicit foralls, and variables have their unique-id attached (so you
 430 can check for things that look the same but aren't).
 431 </Para>
 432 </ListItem>
 433 </VarListEntry>
 434 <VarListEntry>
 435 <Term><Option>-ddump-simpl-stats</Option>:</Term>
 436 <ListItem>
 437 <Para>
 438 <IndexTerm><Primary>-ddump-simpl-stats option</Primary></IndexTerm>
 439 Dump statistics about how many of each kind
 440 of transformation too place.  If you add <Option>-dppr-debug</Option> you get more detailed information.
 441 </Para>
 442 </ListItem>
 443 </VarListEntry>
 444 <VarListEntry>
 445 <Term><Option>-ddump-raw-asm</Option>:</Term>
 446 <ListItem>
 447 <Para>
 448 <IndexTerm><Primary>-ddump-raw-asm option</Primary></IndexTerm>
 449 Dump out the assembly-language stuff, before the &ldquo;mangler&rdquo; gets it.
 450 </Para>
 451 </ListItem>
 452 </VarListEntry>
 453 <VarListEntry>
 454 <Term><Option>-ddump-rn-trace</Option>:</Term>
 455 <ListItem>
 456 <Para>
 457 <IndexTerm><Primary>-ddump-rn-trace</Primary></IndexTerm>
 458 Make the renamer be *real* chatty about what it is upto.
 459 </Para>
 460 </ListItem>
 461 </VarListEntry>
 462 <VarListEntry>
 463 <Term><Option>-dshow-rn-stats</Option>:</Term>
 464 <ListItem>
 465 <Para>
 466 <IndexTerm><Primary>-dshow-rn-stats</Primary></IndexTerm>
 467 Print out summary of what kind of information the renamer had to bring
 468 in.
 469 </Para>
 470 </ListItem>
 471 </VarListEntry>
 472 <VarListEntry>
 473 <Term><Option>-dshow-unused-imports</Option>:</Term>
 474 <ListItem>
 475 <Para>
 476 <IndexTerm><Primary>-dshow-unused-imports</Primary></IndexTerm>
 477 Have the renamer report what imports does not contribute.
 478 </Para>
 479 </ListItem>
 480 </VarListEntry>
 481 </VariableList>
 482 </Para>
 483
 484 </Sect2>
 485
 486 <Sect2 id="checking-consistency">
 487 <Title>Checking for consistency
 488 </Title>
 489
 490 <Para>
 491 <IndexTerm><Primary>consistency checks</Primary></IndexTerm>
 492 <IndexTerm><Primary>lint</Primary></IndexTerm>
 493 </Para>
 494
 495 <Para>
 496 <VariableList>
 497
 498 <VarListEntry>
 499 <Term><Option>-dcore-lint</Option>:</Term>
 500 <ListItem>
 501 <Para>
 502 <IndexTerm><Primary>-dcore-lint option</Primary></IndexTerm>
 503 Turn on heavyweight intra-pass sanity-checking within GHC, at Core
 504 level.  (It checks GHC's sanity, not yours.)
 505 </Para>
 506 </ListItem>
 507 </VarListEntry>
 508 <VarListEntry>
 509 <Term><Option>-dstg-lint</Option>:</Term>
 510 <ListItem>
 511 <Para>
 512 <IndexTerm><Primary>-dstg-lint option</Primary></IndexTerm>
 513 Ditto for STG level.
 514 </Para>
 515 </ListItem>
 516 </VarListEntry>
 517 <VarListEntry>
 518 <Term><Option>-dusagesp-lint</Option>:</Term>
 519 <ListItem>
 520 <Para>
 521 <IndexTerm><Primary>-dstg-lint option</Primary></IndexTerm>
 522 Turn on checks around UsageSP inference (<Option>-fusagesp</Option>).  This verifies
 523 various simple properties of the results of the inference, and also
 524 warns if any identifier with a used-once annotation before the
 525 inference has a used-many annotation afterwards; this could indicate a
 526 non-worksafe transformation is being applied.
 527 </Para>
 528 </ListItem>
 529 </VarListEntry>
 530 </VariableList>
 531 </Para>
 532
 533 </Sect2>
 534
 535 <Sect2>
 536 <Title>How to read Core syntax (from some <Option>-ddump-*</Option> flags)</Title>
 537
 538 <Para>
 539 <IndexTerm><Primary>reading Core syntax</Primary></IndexTerm>
 540 <IndexTerm><Primary>Core syntax, how to read</Primary></IndexTerm>
 541 </Para>
 542
 543 <Para>
 544 Let's do this by commenting an example.  It's from doing
 545 <Option>-ddump-ds</Option> on this code:
 546
 547 <ProgramListing>
 548 skip2 m = m : skip2 (m+2)
 549 </ProgramListing>
 550
 551 </Para>
 552
 553 <Para>
 554 Before we jump in, a word about names of things.  Within GHC,
 555 variables, type constructors, etc., are identified by their
 556 &ldquo;Uniques.&rdquo;  These are of the form `letter' plus `number' (both
 557 loosely interpreted).  The `letter' gives some idea of where the
 558 Unique came from; e.g., <Literal>&lowbar;</Literal> means &ldquo;built-in type variable&rdquo;;
 559 <Literal>t</Literal> means &ldquo;from the typechecker&rdquo;; <Literal>s</Literal> means &ldquo;from the
 560 simplifier&rdquo;; and so on.  The `number' is printed fairly compactly in
 561 a `base-62' format, which everyone hates except me (WDP).
 562 </Para>
 563
 564 <Para>
 565 Remember, everything has a &ldquo;Unique&rdquo; and it is usually printed out
 566 when debugging, in some form or another.  So here we go&hellip;
 567 </Para>
 568
 569 <Para>
 570 <ProgramListing>
 571 Desugared:
 572 Main.skip2{-r1L6-} :: _forall_ a$_4 =&#62;{{Num a$_4}} -&#62; a$_4 -&#62; [a$_4]
 573
 574 --# `r1L6' is the Unique for Main.skip2;
 575 --# `_4' is the Unique for the type-variable (template) `a'
 576 --# `{{Num a$_4}}' is a dictionary argument
 577
 578 _NI_
 579
 580 --# `_NI_' means "no (pragmatic) information" yet; it will later
 581 --# evolve into the GHC_PRAGMA info that goes into interface files.
 582
 583 Main.skip2{-r1L6-} =
 584     /\ _4 -&#62; \ d.Num.t4Gt -&#62;
 585         let {
 586           {- CoRec -}
 587           +.t4Hg :: _4 -&#62; _4 -&#62; _4
 588           _NI_
 589           +.t4Hg = (+{-r3JH-} _4) d.Num.t4Gt
 590
 591           fromInt.t4GS :: Int{-2i-} -&#62; _4
 592           _NI_
 593           fromInt.t4GS = (fromInt{-r3JX-} _4) d.Num.t4Gt
 594
 595 --# The `+' class method (Unique: r3JH) selects the addition code
 596 --# from a `Num' dictionary (now an explicit lamba'd argument).
 597 --# Because Core is 2nd-order lambda-calculus, type applications
 598 --# and lambdas (/\) are explicit.  So `+' is first applied to a
 599 --# type (`_4'), then to a dictionary, yielding the actual addition
 600 --# function that we will use subsequently...
 601
 602 --# We play the exact same game with the (non-standard) class method
 603 --# `fromInt'.  Unsurprisingly, the type `Int' is wired into the
 604 --# compiler.
 605
 606           lit.t4Hb :: _4
 607           _NI_
 608           lit.t4Hb =
 609               let {
 610                 ds.d4Qz :: Int{-2i-}
 611                 _NI_
 612                 ds.d4Qz = I#! 2#
 613               } in  fromInt.t4GS ds.d4Qz
 614
 615 --# `I# 2#' is just the literal Int `2'; it reflects the fact that
 616 --# GHC defines `data Int = I# Int#', where Int# is the primitive
 617 --# unboxed type.  (see relevant info about unboxed types elsewhere...)
 618
 619 --# The `!' after `I#' indicates that this is a *saturated*
 620 --# application of the `I#' data constructor (i.e., not partially
 621 --# applied).
 622
 623           skip2.t3Ja :: _4 -&#62; [_4]
 624           _NI_
 625           skip2.t3Ja =
 626               \ m.r1H4 -&#62;
 627                   let { ds.d4QQ :: [_4]
 628                         _NI_
 629                         ds.d4QQ =
 630                     let {
 631                       ds.d4QY :: _4
 632                       _NI_
 633                       ds.d4QY = +.t4Hg m.r1H4 lit.t4Hb
 634                     } in  skip2.t3Ja ds.d4QY
 635                   } in
 636                   :! _4 m.r1H4 ds.d4QQ
 637
 638           {- end CoRec -}
 639         } in  skip2.t3Ja
 640 </ProgramListing>
 641 </Para>
 642
 643 <Para>
 644 (&ldquo;It's just a simple functional language&rdquo; is an unregisterised
 645 trademark of Peyton Jones Enterprises, plc.)
 646 </Para>
 647
 648 </Sect2>
 649
 650 <Sect2 id="source-file-options">
 651 <Title>Command line options in source files
 652 </Title>
 653
 654 <Para>
 655 <IndexTerm><Primary>source-file options</Primary></IndexTerm>
 656 </Para>
 657
 658 <Para>
 659 Sometimes it is useful to make the connection between a source file
 660 and the command-line options it requires quite tight. For instance,
 661 if a (Glasgow) Haskell source file uses <Literal>casm</Literal>s, the C back-end
 662 often needs to be told about which header files to include. Rather than
 663 maintaining the list of files the source depends on in a
 664 <Filename>Makefile</Filename> (using the <Option>-&num;include</Option> command-line option), it is
 665 possible to do this directly in the source file using the <Literal>OPTIONS</Literal>
 666 pragma <IndexTerm><Primary>OPTIONS pragma</Primary></IndexTerm>:
 667 </Para>
 668
 669 <Para>
 670 <ProgramListing>
 671 {-# OPTIONS -#include "foo.h" #-}
 672 module X where
 673
 674 ...
 675 </ProgramListing>
 676 </Para>
 677
 678 <Para>
 679 <Literal>OPTIONS</Literal> pragmas are only looked for at the top of your source
 680 files, upto the first (non-literate,non-empty) line not containing
 681 <Literal>OPTIONS</Literal>. Multiple <Literal>OPTIONS</Literal> pragmas are recognised. Note
 682 that your command shell does not get to the source file options, they
 683 are just included literally in the array of command-line arguments
 684 the compiler driver maintains internally, so you'll be desperately
 685 disappointed if you try to glob etc. inside <Literal>OPTIONS</Literal>.
 686 </Para>
 687
 688 <Para>
 689 NOTE: the contents of OPTIONS are prepended to the command-line
 690 options, so you *do* have the ability to override OPTIONS settings
 691 via the command line.
 692 </Para>
 693
 694 <Para>
 695 It is not recommended to move all the contents of your Makefiles into
 696 your source files, but in some circumstances, the <Literal>OPTIONS</Literal> pragma
 697 is the Right Thing. (If you use <Option>-keep-hc-file-too</Option> and have OPTION
 698 flags in your module, the OPTIONS will get put into the generated .hc
 699 file).
 700 </Para>
 701
 702 </Sect2>
 703
 704   <sect2 id="unreg">
 705     <title>Unregisterised compilation</title>
 706     <indexterm><primary>unregisterised compilation</primary></indexterm>
 707
 708     <para>The term "unregisterised" really means "compile via vanilla
 709     C", disabling some of the platform-specific tricks that GHC
 710     normally uses to make programs go faster.  When compiling
 711     unregisterised, GHC simply generates a C file which is compiled
 712     via gcc.</para>
 713
 714     <para>Unregisterised compilation can be useful when porting GHC to
 715     a new machine, since it reduces the prerequisite tools to
 716     <command>gcc</command>, <command>as</command>, and
 717     <command>ld</command> and nothing more, and furthermore the amount
 718     of platform-specific code that needs to be written in order to get
 719     unregisterised compilation going is usually fairly small.</para>
 720
 721     <variablelist>
 722       <varlistentry>
 723         <term><option>-unreg</option>:</term>
 724         <indexterm><primary><option>-unreg</option></primary></indexterm>
 725         <listitem>
 726           <para>Compile via vanilla ANSI C only, turning off
 727           platform-specific optimisations.  NOTE: in order to use
 728           <option>-unreg</option>, you need to have a set of libraries
 729           (including the RTS) built for unregisterised compilation.
 730           This amounts to building GHC with way "u" enabled.</para>
 731         </listitem>
 732       </varlistentry>
 733     </variablelist>
 734   </sect2>
 735
 736 </Sect1>
 737
 738 <!-- Emacs stuff:
 739      ;;; Local Variables: ***
 740      ;;; mode: sgml ***
 741      ;;; sgml-parent-document: ("users_guide.sgml" "book" "chapter" "sect1") ***
 742      ;;; End: ***
 743  -->