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