1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
7 <Title>Building and Installing the Glasgow Functional Programming Tools Suite</Title>
8 <Author><OtherName>The GHC Team</OtherName></Author>
9 <Address><Email>glasgow-haskell-{users,bugs}@dcs.gla.ac.uk</Email></Address>
10 <PubDate>January 2000</PubDate>
15 This guide is intended for people who want to build or modify
16 programs from the Glasgow <Literal>fptools</Literal> suite (as distinct from those
17 who merely want to <Emphasis>run</Emphasis> them). Installation instructions are now provided in the user guide.
21 The bulk of this guide applies to building on Unix systems; see <XRef LinkEnd="winbuild"> for Windows notes.
29 <Sect1 id="sec-getting">
30 <Title>Getting the Glasgow <Literal>fptools</Literal> suite
34 Building the Glasgow tools <Emphasis>can</Emphasis> be complicated, mostly because
35 there are so many permutations of what/why/how, e.g., ``Build Happy
36 with HBC, everything else with GHC, leave out profiling, and test it
37 all on the `real' NoFib programs.'' Yeeps!
41 Happily, such complications don't apply to most people. A few common
42 ``strategies'' serve most purposes. Pick one and proceed
50 <Term><IndexTerm><Primary>Binary distribution</Primary></IndexTerm>Binary distribution.</Term>
53 If your only purpose is to install some of the <Literal>fptools</Literal> suite then the easiest thing to do is to get a binary distribution. In the
54 binary distribution everything is pre-compiled for your particular
55 machine architecture and operating system, so all you should have to
56 do is install the binaries and libraries in suitable places. The user guide
57 describes how to do this.
61 A binary distribution may not work for you for two reasons. First, we
62 may not have built the suite for the particular architecture/OS
63 platform you want. That may be due to lack of time and energy (in
64 which case you can get a source distribution and build from it; see
65 below). Alternatively, it may be because we haven't yet ported the
66 suite to your architecture, in which case you are considerably worse
71 The second reason a binary distribution may not be what you want is
72 if you want to read or modify the souce code.
74 </ListItem></VarListEntry>
76 <Term><IndexTerm><Primary>Source distribution</Primary></IndexTerm>Source distribution.</Term>
80 platform, but (a) you like the warm fuzzy feeling of compiling things
81 yourself; (b) you want to build something ``extra''—e.g., a set of
82 libraries with strictness-analysis turned off; or (c) you want to hack
87 A source distribution contains complete sources for one or more
88 projects in the <Literal>fptools</Literal> suite. Not only that, but the more awkward
89 machine-independent steps are done for you. For example, if you don't
90 have <Command>flex</Command><IndexTerm><Primary>flex</Primary></IndexTerm> you'll find it convenient that the source
91 distribution contains the result of running <Command>flex</Command> on the lexical
92 analyser specification. If you don't want to alter the lexical
93 analyser then this saves you having to find and install <Command>flex</Command>. You
94 will still need a working version of GHC on your machine in order to
95 compile (most of) the sources, however.
99 We make source distributions more frequently than binary
100 distributions; a release that comes with pre-compiled binaries
101 is considered a major release, i.e., a release that we have some
102 confidence will work well by having tested it (more) thoroughly.
106 Source-only distributions are either bugfix releases or snapshots of
107 current state of development. The release has undergone some testing.
108 Source releases of 4.xx can be compiled up using 2.10 or later.
110 </ListItem></VarListEntry>
112 <Term>Build GHC from intermediate C <Filename>.hc</Filename> files<IndexTerm><Primary>hc files</Primary></IndexTerm>:</Term>
116 need a working GHC to use a source distribution. What if you don't
117 have a working GHC? Then you have no choice but to ``bootstrap'' up
118 from the intermediate C (<Filename>.hc</Filename>) files that we provide. Building GHC
119 on an unsupported platform falls into this category. Please see
120 <Xref LinkEnd="sec-booting-from-C">.
124 Once you have built GHC, you can build the other Glasgow tools with
129 In theory, you can (could?) build GHC with another Haskell compiler
130 (e.g., HBC). We haven't tried to do this for ages and it almost
131 certainly doesn't work any more (for tedious reasons).
133 </ListItem></VarListEntry>
135 <Term>The CVS repository.</Term>
138 We make source distributions slightly more often than binary
139 distributions; but still infrequently. If you want more up-to-the
140 minute (but less tested) source code then you need to get access to
145 All the <Literal>fptools</Literal> source code is held in a CVS repository. CVS is a
146 pretty good source-code control system, and best of all it works over
151 The repository holds source code only. It holds no mechanically
152 generated files at all. So if you check out a source tree from CVS
153 you will need to install every utility so that you can build all the
154 derived files from scratch.
158 More information about our CVS repository is available at <ULink
159 URL="http://www.dcs.gla.ac.uk/fp/software/ghc/cvs-cheat-sheet.html"
160 >The Fptools CVS Cheat Sheet</ULink
163 </ListItem></VarListEntry>
168 If you are going to do any building from sources (either from a source
169 distribution or the CVS repository) then you need to read all of this
176 <Title>Things to check before you start typing</Title>
179 Here's a list of things to check before you get started.
185 <IndexTerm><Primary>Disk space needed</Primary></IndexTerm>Disk space needed: About 30MB (five hamburgers' worth) of disk space
186 for the most basic binary distribution of GHC; more for some
187 platforms, e.g., Alphas. An extra ``bundle'' (e.g., concurrent
188 Haskell libraries) might take you to 8–10 hamburgers.
190 You'll need over 100MB (say, 20 hamburgers' worth) if you need to
191 build the basic stuff from scratch.
194 All of the above are <Emphasis>estimates</Emphasis> of disk-space needs. (I don't yet
195 know the disk requirements for the non-GHC tools).
202 Use an appropriate machine, compilers, and things.
204 SPARC boxes, DEC Alphas running OSF/1, and PCs running Linux, FreeBSD,
205 or Solaris are all fully supported. MIPS, AIX, Win32 and HP boxes are
206 in pretty good shape. <Xref LinkEnd="sec-port-info">
207 gives the full run-down on ports or lack thereof.
209 NOTE: as of version 4.00, we lost a few ports. All of the x86 ports
210 are working, as is the Sparc/Solaris port, but the rest will need a
211 little work. Please contact us if you can provide hardware cycles
212 and/or porting expertise.
219 Be sure that the ``pre-supposed'' utilities are installed.
220 <Xref LinkEnd="sec-pre-supposed"> elaborates.
227 If you have any problem when building or installing the Glasgow
228 tools, please check the ``known pitfalls'' (<Xref LinkEnd="sec-build-pitfalls">). Also check the <ULink
229 URL="http://www.dcs.gla.ac.uk/fp/software/ghc/ghc-bugs.html"
230 >known bugs page</ULink>.
231 <IndexTerm><Primary>known bugs</Primary></IndexTerm>
232 <IndexTerm><Primary>bugs, known</Primary></IndexTerm>
234 If you feel there is still some shortcoming in our procedure or
235 instructions, please report it.
237 For GHC, please see the bug-reporting section of the User's guide
238 (separate document), to maximise the usefulness of your report.
239 <IndexTerm><Primary>bugs, reporting</Primary></IndexTerm>
241 If in doubt, please send a message to <Email>glasgow-haskell-bugs@dcs.gla.ac.uk</Email>.
242 <IndexTerm><Primary>bugs, mailing list</Primary></IndexTerm>
252 <Sect1 id="sec-port-info">
253 <Title>What machines the Glasgow tools run on
257 <IndexTerm><Primary>ports, GHC</Primary></IndexTerm>
258 <IndexTerm><Primary>GHC ports</Primary></IndexTerm>
259 <IndexTerm><Primary>supported platforms</Primary></IndexTerm>
260 <IndexTerm><Primary>platforms, supported</Primary></IndexTerm>
261 The main question is whether or not the Haskell compiler (GHC) runs on
266 A ``platform'' is a architecture/manufacturer/operating-system
267 combination, such as <Literal>sparc-sun-solaris2</Literal>. Other common ones are
268 <Literal>alpha-dec-osf2</Literal>, <Literal>hppa1.1-hp-hpux9</Literal>, <Literal>i386-unknown-linux</Literal>,
269 <Literal>i386-unknown-solaris2</Literal>, <Literal>i386-unknown-freebsd</Literal>,
270 <Literal>i386-unknown-cygwin32</Literal>, <Literal>m68k-sun-sunos4</Literal>, <Literal>mips-sgi-irix5</Literal>,
271 <Literal>sparc-sun-sunos4</Literal>, <Literal>sparc-sun-solaris2</Literal>, <Literal>powerpc-ibm-aix</Literal>.
275 Bear in mind that certain ``bundles'', e.g. parallel Haskell, may not
276 work on all machines for which basic Haskell compiling is supported.
280 Some libraries may only work on a limited number of platforms; for
281 example, a sockets library is of no use unless the operating system
282 supports the underlying BSDisms.
286 <Title>What platforms the Haskell compiler (GHC) runs on</Title>
289 <IndexTerm><Primary>fully-supported platforms</Primary></IndexTerm>
290 <IndexTerm><Primary>native-code generator</Primary></IndexTerm>
291 <IndexTerm><Primary>registerised ports</Primary></IndexTerm>
292 <IndexTerm><Primary>unregisterised ports</Primary></IndexTerm>
293 The GHC hierarchy of Porting Goodness: (a) Best is a native-code
294 generator; (b) next best is a ``registerised''
295 port; (c) the bare minimum is an ``unregisterised'' port.
296 (``Unregisterised'' is so terrible that we won't say more about it).
300 We use Sparcs running Solaris 2.5, x86 boxes running FreeBSD and
301 Linux, and DEC Alphas running OSF/1 V2.0, so those are the
302 ``fully-supported'' platforms, unsurprisingly. All have native-code
303 generators, for quicker compilations. The native-code generator for
304 iX86 platforms (e.g., Linux ELF) is <Emphasis>nearly</Emphasis> working; but is not
305 turned on by default.
309 Here's everything that's known about GHC ports. We identify platforms
310 by their ``canonical'' CPU/Manufacturer/OS triple.
314 Note that some ports are fussy about which GCC version you use; or
315 require GAS; or…
322 <Term>alpha-dec-osf1:</Term>
325 <IndexTerm><Primary>alpha-dec-osf1: fully supported</Primary></IndexTerm>
329 (We have OSF/1 V3.0.) Fully supported, including native-code
330 generator. We recommend GCC 2.6.x or later.
332 </ListItem></VarListEntry>
334 <Term>sparc-sun-sunos4:</Term>
337 <IndexTerm><Primary>sparc-sun-sunos4: fully supported</Primary></IndexTerm>
341 Fully supported, including native-code generator.
343 </ListItem></VarListEntry>
345 <Term>sparc-sun-solaris2:</Term>
348 <IndexTerm><Primary>sparc-sun-solaris2: fully supported</Primary></IndexTerm>
352 Fully supported, including native-code generator. A couple of quirks,
353 though: (a) the profiling libraries are bizarrely huge when compiled
354 with object splitting; (b) the default <Command>xargs</Command><IndexTerm><Primary>xargs</Primary></IndexTerm> program is
355 atrociously bad for building GHC libraries (see <Xref LinkEnd="sec-pre-supposed"> for
358 </ListItem></VarListEntry>
360 <Term>HP-PA box running HP</Term>
364 <IndexTerm><Primary>hppa1.1-hp-hpux: registerised port</Primary></IndexTerm>
368 Works registerised. No native-code generator. For GCC, you're best
369 off with one of the Utah releases of GCC 2.6.3 (`u3' or later), from
370 <Literal>jaguar.cs.utah.edu</Literal>. We think a straight GCC 2.7.x works,
375 Concurrent/Parallel Haskell probably don't work (yet).
376 <IndexTerm><Primary>hppa1.1-hp-hpux: concurrent—no</Primary></IndexTerm>
377 <IndexTerm><Primary>hppa1.1-hp-hpux: parallel—no</Primary></IndexTerm>
379 </ListItem></VarListEntry>
381 <Term>i386-*-linux (PCs running Linux—ELF format):</Term>
384 <IndexTerm><Primary>i386-*-linux: registerised port</Primary></IndexTerm>
388 GHC works registerised. You <Emphasis>must</Emphasis> have GCC 2.7.x or later. The
389 iX86 native-code generator is <Emphasis>nearly</Emphasis> there, but it isn't turned
394 Profiling works, and Concurrent Haskell works.
395 <IndexTerm><Primary>i386-*-linux: profiling—yes</Primary></IndexTerm>
396 <IndexTerm><Primary>i386-*-linux: concurrent—yes</Primary></IndexTerm>
397 Parallel Haskell probably works.
398 <IndexTerm><Primary>i386-*-linux: parallel—maybe</Primary></IndexTerm>
402 On old Linux a.out systems: should be the same.
403 <IndexTerm><Primary>i386-*-linuxaout: registerised port</Primary></IndexTerm>
405 </ListItem></VarListEntry>
407 <Term>i386-*-freebsd (PCs running FreeBSD 2.2 or higher, and
408 NetBSD/OpenBSD using FreeBSD emulation):</Term>
411 <IndexTerm><Primary>i386-*-freebsd:registerised port</Primary></IndexTerm>
415 GHC works registerised. Supports same set of bundles as the above.
416 <IndexTerm><Primary>i386-*-freebsd: profiling—yes</Primary></IndexTerm>
417 <IndexTerm><Primary>i386-*-freebsd: concurrent—yes</Primary></IndexTerm>
418 <IndexTerm><Primary>i386-*-freebsd: parallel—maybe</Primary></IndexTerm>
420 </ListItem></VarListEntry>
422 <Term>i386-unknown-cygwin32:</Term>
425 <IndexTerm><Primary>i386-unknown-cygwin32: fully supported</Primary></IndexTerm>
426 Fully supported under Win95/NT, including a native code
427 generator. Requires the <Literal>cygwin32</Literal> compatibility library and a
428 healthy collection of GNU tools (i.e., gcc, GNU ld, bash etc.)
429 Profiling works, so does Concurrent Haskell.
430 <IndexTerm><Primary>i386-*-cygwin32: profiling—yes</Primary></IndexTerm>
431 <IndexTerm><Primary>i386-*-cygwin32: concurrent—yes</Primary></IndexTerm>
433 </ListItem></VarListEntry>
435 <Term>mips-sgi-irix5:</Term>
438 <IndexTerm><Primary>mips-sgi-irix5: registerised port</Primary></IndexTerm>
439 GHC works registerised (no native-code generator). I suspect any
440 GCC 2.6.x (or later) is OK. The GCC that I used was built with
441 <Option>--with-gnu-as</Option>; turns out that is important!
445 Concurrent/Parallel Haskell probably don't work (yet).
446 Profiling might work, but it is untested.
447 <IndexTerm><Primary>mips-sgi-irix5: concurrent—no</Primary></IndexTerm>
448 <IndexTerm><Primary>mips-sgi-irix5: parallel—no</Primary></IndexTerm>
449 <IndexTerm><Primary>mips-sgi-irix5: profiling—maybe</Primary></IndexTerm>
451 </ListItem></VarListEntry>
453 <Term>mips-sgi-irix6:</Term>
456 <IndexTerm><Primary>mips-sgi-irix6: registerised port</Primary></IndexTerm>
457 Thanks to the fine efforts of Tomasz Cholewo <ULink
458 URL="mailto:tjchol01@mecca.spd.louisville.edu"
459 >tjchol01@mecca.spd.louisville.edu</ULink
460 >, GHC works registerised (no
461 native code generator) under IRIX 6.2 and 6.3. Depends on having a
463 URL="http://mecca.spd.louisville.edu/~tjchol01/software/"
464 >specially tweaked version of gcc-2.7.2 around</ULink>.
465 Profiling works, Concurrent/Parallel Haskell might work (AFAIK, untested).
466 <IndexTerm><Primary>mips-sgi-irix6: concurrent—maybe</Primary></IndexTerm>
467 <IndexTerm><Primary>mips-sgi-irix6: parallel—maybe</Primary></IndexTerm>
468 <IndexTerm><Primary>mips-sgi-irix6: profiling—yes</Primary></IndexTerm>
470 </ListItem></VarListEntry>
472 <Term>powerpc-ibm-aix:</Term>
475 <IndexTerm><Primary>powerpc-ibm-aix: registerised port</Primary></IndexTerm>
476 GHC works registerised (no native-code generator…yet).
477 I suspect 2.7.x is what you need together with this.
481 Concurrent/Parallel Haskell probably don't work (yet).
482 Profiling might work, but it is untested.
483 <IndexTerm><Primary>mips-sgi-irix5: concurrent—no</Primary></IndexTerm>
484 <IndexTerm><Primary>mips-sgi-irix5: parallel—no</Primary></IndexTerm>
485 <IndexTerm><Primary>mips-sgi-irix5: profiling—maybe</Primary></IndexTerm>
487 </ListItem></VarListEntry>
489 <Term>m68k-apple-macos7 (Mac, using MPW):</Term>
492 <IndexTerm><Primary>m68k-apple-macos7: historically ported</Primary></IndexTerm>
493 Once upon a time, David Wright in Tasmania actually
494 got GHC to run on a Macintosh. Ditto James Thomson here at Glasgow.
495 You may be able to get Thomson's from here. (Not sure that it will
496 excite you to death, but…)
500 No particularly recent GHC is known to work on a Mac.
502 </ListItem></VarListEntry>
504 <Term>m68k-next-nextstep3:</Term>
507 <IndexTerm><Primary>m68k-next-nextstep3: historically ported</Primary></IndexTerm>
508 Carsten Schultz succeeded with a ``registerised'' port of GHC 0.29.
509 There's probably a little bit-rot since then, but otherwise it should
514 Concurrent/Parallel Haskell probably won't work (yet).
515 <IndexTerm><Primary>m68k-next-nextstep3: concurrent—no</Primary></IndexTerm>
516 <IndexTerm><Primary>m68k-next-nextstep3: parallel—no</Primary></IndexTerm>
518 </ListItem></VarListEntry>
520 <Term>m68k-sun-sunos4 (Sun3):</Term>
523 <IndexTerm><Primary>m68k-sun-sunos4: registerised
524 port</Primary></IndexTerm> GHC 2.0x and 3.0x haven't been tried on a Sun3. GHC 0.26
525 worked registerised. No native-code generator.
529 Concurrent/Parallel Haskell probably don't work (yet).
530 <IndexTerm><Primary>m68k-sun-sunos4: concurrent—no</Primary></IndexTerm>
531 <IndexTerm><Primary>m68k-sun-sunos4: parallel—no</Primary></IndexTerm>
533 </ListItem></VarListEntry>
540 <Title>What machines the other tools run on</Title>
543 Unless you hear otherwise, the other tools work if GHC works.
547 Haggis requires Concurrent Haskell to work.
548 <IndexTerm><Primary>Haggis, Concurrent Haskell</Primary></IndexTerm>
556 <Sect1 id="sec-pre-supposed">
557 <Title>Installing pre-supposed utilities
559 <IndexTerm><Primary>pre-supposed utilities</Primary></IndexTerm>
560 <IndexTerm><Primary>utilities, pre-supposed</Primary></IndexTerm></Title>
563 Here are the gory details about some utility programs you may need;
564 <Command>perl</Command> and <Command>gcc</Command> are the only important ones. (PVM<IndexTerm><Primary>PVM</Primary></IndexTerm> is important
565 if you're going for Parallel Haskell.) The <Command>configure</Command><IndexTerm><Primary>configure</Primary></IndexTerm>
566 script will tell you if you are missing something.
576 <IndexTerm><Primary>pre-supposed: Perl</Primary></IndexTerm>
577 <IndexTerm><Primary>Perl, pre-supposed</Primary></IndexTerm>
578 <Emphasis>You have to have Perl to proceed!</Emphasis> Perl is a language quite good
579 for doing shell-scripty tasks that involve lots of text processing.
580 It is pretty easy to install.
584 Perl 5 is required. For Win32 platforms, we strongly suggest you pick
585 up a port of Perl 5 for <Literal>cygwin32</Literal>, as the common Hip/ActiveWare port
586 of Perl is Not Cool Enough for our purposes.
590 Perl should be put somewhere so that it can be invoked by the <Literal>#!</Literal>
591 script-invoking mechanism. (I believe <Filename>/usr/bin/perl</Filename> is preferred;
592 we use <Filename>/usr/local/bin/perl</Filename> at Glasgow.) The full pathname should
593 may need to be less than 32 characters long on some systems.
595 </ListItem></VarListEntry>
597 <Term>GNU C (<Command>gcc</Command>):</Term>
600 <IndexTerm><Primary>pre-supposed: GCC (GNU C compiler)</Primary></IndexTerm>
601 <IndexTerm><Primary>GCC (GNU C compiler), pre-supposed</Primary></IndexTerm>
605 Versions 2.7.2.x, 2.8.1 and egcs 1.1.2 are known to work. Use other
606 versions at your own risk!
610 If your GCC dies with ``internal error'' on some GHC source file,
611 please let us know, so we can report it and get things improved.
612 (Exception: on iX86 boxes—you may need to fiddle with GHC's
613 <Option>-monly-N-regs</Option> option; see the User's Guide)
615 </ListItem></VarListEntry>
617 <Term><Command>xargs</Command> on Solaris2:</Term>
620 <IndexTerm><Primary>xargs, presupposed (Solaris only)</Primary></IndexTerm>
621 <IndexTerm><Primary>Solaris: alternative xargs</Primary></IndexTerm>
622 The GHC libraries are put together with something like:
625 find bunch-of-dirs -name '*.o' -print | xargs ar q ...
628 Unfortunately the Solaris <Command>xargs</Command> (the shell-script equivalent
629 of <Function>map</Function>) only ``bites off'' the <Filename>.o</Filename> files a few at a
630 time—with near-infinite rebuilding of the symbol table in
631 the <Filename>.a</Filename> file.
635 The best solution is to install a sane <Command>xargs</Command> from the GNU
636 findutils distribution. You can unpack, build, and install the GNU
637 version in the time the Solaris <Command>xargs</Command> mangles just one GHC
640 </ListItem></VarListEntry>
642 <Term>Autoconf:</Term>
645 <IndexTerm><Primary>pre-supposed: Autoconf</Primary></IndexTerm>
646 <IndexTerm><Primary>Autoconf, pre-supposed</Primary></IndexTerm>
650 GNU Autoconf is needed if you intend to build from the CVS sources, it
651 is <Emphasis>not</Emphasis> needed if you just intend to build a standard source
656 Autoconf builds the <Command>configure</Command> script from <Filename>configure.in</Filename> and
657 <Filename>aclocal.m4</Filename>. If you modify either of these files, you'll need
658 Autoconf to rebuild <Filename>configure</Filename>.
660 </ListItem></VarListEntry>
662 <Term><Command>sed</Command></Term>
665 <IndexTerm><Primary>pre-supposed: sed</Primary></IndexTerm>
666 <IndexTerm><Primary>sed, pre-supposed</Primary></IndexTerm>
667 You need a working <Command>sed</Command> if you are going to build from sources. The
668 build-configuration stuff needs it. GNU sed version 2.0.4 is no good!
669 It has a bug in it that is tickled by the build-configuration. 2.0.5
670 is OK. Others are probably OK too (assuming we don't create too
671 elaborate configure scripts.)
673 </ListItem></VarListEntry>
678 One <Literal>fptools</Literal> project is worth a quick note at this point, because it
679 is useful for all the others: <Literal>glafp-utils</Literal> contains several utilities
680 which aren't particularly Glasgow-ish, but Occasionally Indispensable.
681 Like <Command>lndir</Command> for creating symbolic link trees.
684 <Sect2 id="pre-supposed-gph-tools">
685 <Title>Tools for building parallel GHC (GPH)
692 <Term>PVM version 3:</Term>
695 <IndexTerm><Primary>pre-supposed: PVM3 (Parallel Virtual Machine)</Primary></IndexTerm>
696 <IndexTerm><Primary>PVM3 (Parallel Virtual Machine), pre-supposed</Primary></IndexTerm>
700 PVM is the Parallel Virtual Machine on which Parallel Haskell programs
701 run. (You only need this if you plan to run Parallel Haskell.
702 Concurent Haskell, which runs concurrent threads on a uniprocessor
703 doesn't need it.) Underneath PVM, you can have (for example) a
704 network of workstations (slow) or a multiprocessor box (faster).
708 The current version of PVM is 3.3.11; we use 3.3.7. It is readily
709 available on the net; I think I got it from <Literal>research.att.com</Literal>, in
710 <Filename>netlib</Filename>.
714 A PVM installation is slightly quirky, but easy to do. Just follow
715 the <Filename>Readme</Filename> instructions.
717 </ListItem></VarListEntry>
719 <Term><Command>bash</Command>:</Term>
722 <IndexTerm><Primary>bash, presupposed (Parallel Haskell only)</Primary></IndexTerm>
723 Sadly, the <Command>gr2ps</Command> script, used to convert ``parallelism profiles''
724 to PostScript, is written in Bash (GNU's Bourne Again shell).
725 This bug will be fixed (someday).
727 </ListItem></VarListEntry>
733 <Sect2 id="pre-supposed-doc-tools">
734 <Title>Tools for building the Documentation
738 The following additional tools are required if you want to format the
739 documentation that comes with the <Literal>fptools</Literal> projects:
746 <Term>DocBook:</Term>
749 <IndexTerm><Primary>pre-supposed: DocBook</Primary></IndexTerm>
750 <IndexTerm><Primary>DocBook, pre-supposed</Primary></IndexTerm>
751 All our documentation is written in SGML, using the DocBook DTD and processed using the <ULink URL="http://sourceware.cygnus.com/docbook-tools/">Cygnus DocBook tools</ULink>, which is the most shrink-wrapped SGML suite
752 that we could find. Unfortunately, it's only packaged as RPMs. You can use it to generate HTML (and
753 hence DVI, PDF and Postscript) and RTF from any
754 LinuxDoc source file (including this manual).
756 </ListItem></VarListEntry>
761 <IndexTerm><Primary>pre-supposed: TeX</Primary></IndexTerm>
762 <IndexTerm><Primary>TeX, pre-supposed</Primary></IndexTerm>
763 A decent TeX distribution is required if you want to produce printable
764 documentation. We recomment teTeX, which includes just about
767 </ListItem></VarListEntry>
773 <Sect2 id="pre-supposed-other-tools">
774 <Title>Other useful tools
784 <IndexTerm><Primary>pre-supposed: flex</Primary></IndexTerm>
785 <IndexTerm><Primary>flex, pre-supposed</Primary></IndexTerm>
789 This is a quite-a-bit-better-than-Lex lexer. Used to build a couple
790 of utilities in <Literal>glafp-utils</Literal>. Depending on your operating system,
791 the supplied <Command>lex</Command> may or may not work; you should get the GNU
794 </ListItem></VarListEntry>
802 <Sect1 id="sec-building-from-source">
803 <Title>Building from source
805 <IndexTerm><Primary>Building from source</Primary></IndexTerm>
806 <IndexTerm><Primary>Source, building from</Primary></IndexTerm></Title>
809 You've been rash enough to want to build some of
810 the Glasgow Functional Programming tools (GHC, Happy,
811 nofib, etc.) from source. You've slurped the source,
812 from the CVS repository or from a source distribution, and
813 now you're sitting looking at a huge mound of bits, wondering
818 Gingerly, you type <Command>make</Command>. Wrong already!
822 This rest of this guide is intended for duffers like me, who aren't
823 really interested in Makefiles and systems configurations, but who
824 need a mental model of the interlocking pieces so that they can make
825 them work, extend them consistently when adding new software, and lay
826 hands on them gently when they don't work.
829 <Sect2 id="sec-source-tree">
830 <Title>Your source tree
834 The source code is held in your <Emphasis>source tree</Emphasis>.
835 The root directory of your source tree <Emphasis>must</Emphasis>
836 contain the following directories and files:
845 <Filename>Makefile</Filename>: the root Makefile.
851 <Filename>mk/</Filename>: the directory that contains the
852 main Makefile code, shared by all the
853 <Literal>fptools</Literal> software.
859 <Filename>configure.in</Filename>, <Filename>config.sub</Filename>, <Filename>config.guess</Filename>:
860 these files support the configuration process.
866 <Filename>install-sh</Filename>.
875 All the other directories are individual <Emphasis>projects</Emphasis> of the
876 <Literal>fptools</Literal> system—for example, the Glasgow Haskell Compiler
877 (<Literal>ghc</Literal>), the Happy parser generator (<Literal>happy</Literal>), the <Literal>nofib</Literal> benchmark
878 suite, and so on. You can have zero or more of these. Needless to
879 say, some of them are needed to build others.
883 The important thing to remember is that even if you want only one
884 project (<Literal>happy</Literal>, say), you must have a source tree whose root
885 directory contains <Filename>Makefile</Filename>, <Filename>mk/</Filename>, <Filename>configure.in</Filename>, and the
886 project(s) you want (<Filename>happy/</Filename> in this case). You cannot get by with
887 just the <Filename>happy/</Filename> directory.
894 <IndexTerm><Primary>build trees</Primary></IndexTerm>
895 <IndexTerm><Primary>link trees, for building</Primary></IndexTerm></Title>
898 While you can build a system in the source tree, we don't recommend it.
899 We often want to build multiple versions of our software
900 for different architectures, or with different options (e.g. profiling).
901 It's very desirable to share a single copy of the source code among
906 So for every source tree we have zero or more <Emphasis>build trees</Emphasis>. Each
907 build tree is initially an exact copy of the source tree, except that
908 each file is a symbolic link to the source file, rather than being a
909 copy of the source file. There are ``standard'' Unix utilities that
910 make such copies, so standard that they go by different names:
911 <Command>lndir</Command><IndexTerm><Primary>lndir</Primary></IndexTerm>, <Command>mkshadowdir</Command><IndexTerm><Primary>mkshadowdir</Primary></IndexTerm> are two (If you
912 don't have either, the source distribution includes sources for the
913 X11 <Command>lndir</Command>—check out <Filename>fptools/glafp-utils/lndir</Filename>). See <Xref LinkEnd="sec-storysofar"> for a typical invocation.
917 The build tree does not need to be anywhere near the source tree in
918 the file system. Indeed, one advantage of separating the build tree
919 from the source is that the build tree can be placed in a
920 non-backed-up partition, saving your systems support people from
921 backing up untold megabytes of easily-regenerated, and
922 rapidly-changing, gubbins. The golden rule is that (with a single
923 exception—<XRef LinkEnd="sec-build-config"> <Emphasis>absolutely everything in the build tree is either
924 a symbolic link to the source tree, or else is mechanically
925 generated</Emphasis>. It should be perfectly OK for your build tree to vanish
926 overnight; an hour or two compiling and you're on the road again.
930 You need to be a bit careful, though, that any new files you create
931 (if you do any development work) are in the source tree, not a build tree!
935 Remember, that the source files in the build tree are <Emphasis>symbolic
936 links</Emphasis> to the files in the source tree. (The build tree soon
937 accumulates lots of built files like <Filename>Foo.o</Filename>, as well.) You
938 can <Emphasis>delete</Emphasis> a source file from the build tree without affecting
939 the source tree (though it's an odd thing to do). On the other hand,
940 if you <Emphasis>edit</Emphasis> a source file from the build tree, you'll edit the
941 source-tree file directly. (You can set up Emacs so that if you edit
942 a source file from the build tree, Emacs will silently create an
943 edited copy of the source file in the build tree, leaving the source
944 file unchanged; but the danger is that you think you've edited the
945 source file whereas actually all you've done is edit the build-tree
946 copy. More commonly you do want to edit the source file.)
950 Like the source tree, the top level of your build tree must be (a
951 linked copy of) the root directory of the <Literal>fptools</Literal> suite. Inside
952 Makefiles, the root of your build tree is called
953 <Constant>$(FPTOOLS_TOP)</Constant><IndexTerm><Primary>FPTOOLS_TOP</Primary></IndexTerm>. In the rest of this document path
954 names are relative to <Constant>$(FPTOOLS_TOP)</Constant> unless otherwise stated. For
955 example, the file <Filename>ghc/mk/target.mk</Filename> is actually
956 <Filename><Constant>$(FPTOOLS_TOP)</Constant>/ghc/mk/target.mk</Filename>.
961 <Sect2 id="sec-build-config">
962 <Title>Getting the build you want
966 When you build <Literal>fptools</Literal> you will be compiling code on a particular
967 <Emphasis>host platform</Emphasis>, to run on a particular <Emphasis>target platform</Emphasis>
968 (usually the same as the host platform)<IndexTerm><Primary>platform</Primary></IndexTerm>. The
969 difficulty is that there are minor differences between different
970 platforms; minor, but enough that the code needs to be a bit different
971 for each. There are some big differences too: for a different
972 architecture we need to build GHC with a different native-code
977 There are also knobs you can turn to control how the <Literal>fptools</Literal>
978 software is built. For example, you might want to build GHC optimised
979 (so that it runs fast) or unoptimised (so that you can compile it fast
980 after you've modified it. Or, you might want to compile it with
981 debugging on (so that extra consistency-checking code gets included)
986 All of this stuff is called the <Emphasis>configuration</Emphasis> of your build.
987 You set the configuration using a three-step process.
991 <Term>Step 1: get ready for configuration.</Term>
995 <Constant>$(FPTOOLS_TOP)</Constant> and issue the command <Command>autoconf</Command><IndexTerm><Primary>autoconf</Primary></IndexTerm> (with
996 no arguments). This GNU program converts <Filename><Constant>$(FPTOOLS_TOP)</Constant>/configure.in</Filename>
997 to a shell script called <Filename><Constant>$(FPTOOLS_TOP)</Constant>/configure</Filename>.
1001 Both these steps are completely platform-independent; they just mean
1002 that the human-written file (<Filename>configure.in</Filename>) can be short, although
1003 the resulting shell script, <Command>configure</Command>, and <Filename>mk/config.h.in</Filename>, are
1008 In case you don't have <Command>autoconf</Command> we distribute the results,
1009 <Command>configure</Command>, and <Filename>mk/config.h.in</Filename>, with the source distribution. They
1010 aren't kept in the repository, though.
1012 </ListItem></VarListEntry>
1014 <Term>Step 2: system configuration.</Term>
1017 Runs the newly-created <Command>configure</Command> script, thus:
1023 <Command>configure</Command>'s mission is to scurry round your computer working out
1024 what architecture it has, what operating system, whether it has the
1025 <Function>vfork</Function> system call, where <Command>yacc</Command> is kept, whether <Command>gcc</Command> is available,
1026 where various obscure <Literal>#include</Literal> files are, whether it's a leap year,
1027 and what the systems manager had for lunch. It communicates these
1028 snippets of information in two ways:
1037 It translates <Filename>mk/config.mk.in</Filename><IndexTerm><Primary>config.mk.in</Primary></IndexTerm> to
1038 <Filename>mk/config.mk</Filename><IndexTerm><Primary>config.mk</Primary></IndexTerm>, substituting for things between
1039 ``<Literal>@</Literal>'' brackets. So, ``<Literal>@HaveGcc@</Literal>'' will be replaced by
1040 ``<Literal>YES</Literal>'' or ``<Literal>NO</Literal>'' depending on what <Command>configure</Command> finds.
1041 <Filename>mk/config.mk</Filename> is included by every Makefile (directly or indirectly),
1042 so the configuration information is thereby communicated to all
1050 It translates <Filename>mk/config.h.in</Filename><IndexTerm><Primary>config.h.in</Primary></IndexTerm> to
1051 <Filename>mk/config.h</Filename><IndexTerm><Primary>config.h</Primary></IndexTerm>. The latter is <Literal>#include</Literal>d by various C
1052 programs, which can thereby make use of configuration information.
1062 <Command>configure</Command> caches the results of its run in <Filename>config.cache</Filename>. Quite
1063 often you don't want that; you're running <Command>configure</Command> a second time
1064 because something has changed. In that case, simply delete
1065 <Filename>config.cache</Filename>.
1067 </ListItem></VarListEntry>
1069 <Term>Step 3: build configuration.</Term>
1072 Next, you say how this build of <Literal>fptools</Literal> is to differ from the
1073 standard defaults by creating a new file <Filename>mk/build.mk</Filename><IndexTerm><Primary>build.mk</Primary></IndexTerm>
1074 <Emphasis>in the build tree</Emphasis>. This file is the one and only file you edit
1075 in the build tree, precisely because it says how this build differs
1076 from the source. (Just in case your build tree does die, you might
1077 want to keep a private directory of <Filename>build.mk</Filename> files, and use a
1078 symbolic link in each build tree to point to the appropriate one.) So
1079 <Filename>mk/build.mk</Filename> never exists in the source tree—you create one in
1080 each build tree from the template. We'll discuss what to put in it
1083 </ListItem></VarListEntry>
1088 And that's it for configuration. Simple, eh?
1092 What do you put in your build-specific configuration file
1093 <Filename>mk/build.mk</Filename>? <Emphasis>For almost all purposes all you will do is put
1094 make variable definitions that override those in</Emphasis> <Filename>mk/config.mk.in</Filename>.
1095 The whole point of <Filename>mk/config.mk.in</Filename>—and its derived counterpart
1096 <Filename>mk/config.mk</Filename>—is to define the build configuration. It is heavily
1097 commented, as you will see if you look at it. So generally, what you
1098 do is look at <Filename>mk/config.mk.in</Filename>, and add definitions in <Filename>mk/build.mk</Filename>
1099 that override any of the <Filename>config.mk</Filename> definitions that you want to
1100 change. (The override occurs because the main boilerplate file,
1101 <Filename>mk/boilerplate.mk</Filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm>, includes <Filename>build.mk</Filename> after
1102 <Filename>config.mk</Filename>.)
1106 For example, <Filename>config.mk.in</Filename> contains the definition:
1112 ProjectsToBuild = glafp-utils ghc hslibs
1118 The accompanying comment explains that this is the list of enabled
1119 projects; that is, if (after configuring) you type <Command>gmake all</Command> in
1120 <Constant>FPTOOLS_TOP</Constant> three specified projects will be made. If you want to
1121 add <Command>green-card</Command>, you can add this line to <Filename>build.mk</Filename>:
1127 ProjectsToBuild += green-card
1139 ProjectsToBuild = glafp-utils ghc green-card
1145 (GNU <Command>make</Command> allows existing definitions to have new text appended
1146 using the ``<Literal>+=</Literal>'' operator, which is quite a convenient feature.)
1150 When reading <Filename>config.mk.in</Filename>, remember that anything between
1151 ``@...@'' signs is going to be substituted by <Command>configure</Command>
1152 later. You <Emphasis>can</Emphasis> override the resulting definition if you want,
1153 but you need to be a bit surer what you are doing. For example,
1154 there's a line that says:
1166 This defines the Make variables <Constant>YACC</Constant> to the pathname for a <Command>yacc</Command> that
1167 <Command>configure</Command> finds somewhere. If you have your own pet <Command>yacc</Command> you want
1168 to use instead, that's fine. Just add this line to <Filename>mk/build.mk</Filename>:
1180 You do not <Emphasis>have</Emphasis> to have a <Filename>mk/build.mk</Filename> file at all; if you
1181 don't, you'll get all the default settings from <Filename>mk/config.mk.in</Filename>.
1185 You can also use <Filename>build.mk</Filename> to override anything that <Command>configure</Command> got
1186 wrong. One place where this happens often is with the definition of
1187 <Constant>FPTOOLS_TOP_ABS</Constant>: this variable is supposed to be the canonical path
1188 to the top of your source tree, but if your system uses an automounter
1189 then the correct directory is hard to find automatically. If you find
1190 that <Command>configure</Command> has got it wrong, just put the correct definition in
1191 <Filename>build.mk</Filename>.
1196 <Sect2 id="sec-storysofar">
1197 <Title>The story so far</Title>
1200 Let's summarise the steps you need to carry to get yourself
1201 a fully-configured build tree from scratch.
1210 Get your source tree from somewhere (CVS repository or source
1211 distribution). Say you call the root directory <Filename>myfptools</Filename> (it
1212 does not have to be called <Filename>fptools</Filename>). Make sure that you have
1213 the essential files (see <XRef LinkEnd="sec-source-tree">).
1220 Use <Command>lndir</Command> or <Command>mkshadowdir</Command> to create a build tree.
1224 mkshadowdir . /scratch/joe-bloggs/myfptools-sun4
1227 (N.B. <Command>mkshadowdir</Command>'s first argument is taken relative to its second.) You probably want to give the build tree a name that
1228 suggests its main defining characteristic (in your mind at least),
1229 in case you later add others.
1236 Change directory to the build tree. Everything is going
1237 to happen there now.
1240 cd /scratch/joe-bloggs/myfptools-sun4
1248 Prepare for system configuration:
1254 (You can skip this step if you are starting from a source distribution,
1255 and you already have <Filename>configure</Filename> and <Filename>mk/config.h.in</Filename>.)
1262 Do system configuration:
1274 Create the file <Filename>mk/build.mk</Filename>,
1275 adding definitions for your desired configuration options.
1286 You can make subsequent changes to <Filename>mk/build.mk</Filename> as often
1287 as you like. You do not have to run any further configuration
1288 programs to make these changes take effect.
1289 In theory you should, however, say <Command>gmake clean</Command>, <Command>gmake all</Command>,
1290 because configuration option changes could affect anything—but in practice you are likely to know what's affected.
1296 <Title>Making things</Title>
1299 At this point you have made yourself a fully-configured build tree,
1300 so you are ready to start building real things.
1304 The first thing you need to know is that
1305 <Emphasis>you must use GNU <Command>make</Command>, usually called <Command>gmake</Command>, not standard Unix <Command>make</Command></Emphasis>.
1306 If you use standard Unix <Command>make</Command> you will get all sorts of error messages
1307 (but no damage) because the <Literal>fptools</Literal> <Command>Makefiles</Command> use GNU <Command>make</Command>'s facilities
1313 <Sect2 id="sec-standard-targets">
1314 <Title>Standard Targets
1316 <IndexTerm><Primary>targets, standard makefile</Primary></IndexTerm>
1317 <IndexTerm><Primary>makefile targets</Primary></IndexTerm></Title>
1320 In any directory you should be able to make the following:
1324 <Term><Literal>boot</Literal>:</Term>
1327 does the one-off preparation required to get ready for the real work.
1328 Notably, it does <Command>gmake depend</Command> in all directories that contain
1329 programs. It also builds the necessary tools for compilation to proceed.
1333 You should say <Command>gmake boot</Command> right after configuring your build tree,
1334 but note that this is a one-off, i.e., there's no need to re-do
1335 <Command>gmake boot</Command> if you should re-configure your build tree at a later
1336 stage (no harm caused if you do though).
1338 </ListItem></VarListEntry>
1340 <Term><Literal>all</Literal>:</Term>
1343 makes all the final target(s) for this Makefile.
1344 Depending on which directory you are in a ``final target'' may be an
1345 executable program, a library archive, a shell script, or a Postscript
1346 file. Typing <Command>gmake</Command> alone is generally the same as typing <Command>gmake all</Command>.
1348 </ListItem></VarListEntry>
1350 <Term><Literal>install</Literal>:</Term>
1353 installs the things built by <Literal>all</Literal>. Where does it
1354 install them? That is specified by <Filename>mk/config.mk.in</Filename>; you can
1355 override it in <Filename>mk/build.mk</Filename>.
1357 </ListItem></VarListEntry>
1359 <Term><Literal>uninstall</Literal>:</Term>
1362 reverses the effect of <Literal>install</Literal>.
1364 </ListItem></VarListEntry>
1366 <Term><Literal>clean</Literal>:</Term>
1369 remove all easily-rebuilt files.
1371 </ListItem></VarListEntry>
1373 <Term><Literal>veryclean</Literal>:</Term>
1376 remove all files that can be rebuilt at all.
1377 There's a danger here that you may remove a file that needs a more
1378 obscure utility to rebuild it (especially if you started from a source
1381 </ListItem></VarListEntry>
1383 <Term><Literal>check</Literal>:</Term>
1388 </ListItem></VarListEntry>
1393 All of these standard targets automatically recurse into
1394 sub-directories. Certain other standard targets do not:
1401 <Term><Literal>configure</Literal>:</Term>
1404 is only available in the root directory
1405 <Constant>$(FPTOOLS_TOP)</Constant>; it has been discussed in <XRef LinkEnd="sec-build-config">.
1407 </ListItem></VarListEntry>
1409 <Term><Literal>depend</Literal>:</Term>
1412 make a <Filename>.depend</Filename> file in each directory that needs
1413 it. This <Filename>.depend</Filename> file contains mechanically-generated dependency
1414 information; for example, suppose a directory contains a Haskell
1415 source module <Filename>Foo.lhs</Filename> which imports another module <Literal>Baz</Literal>.
1416 Then the generated <Filename>.depend</Filename> file will contain the dependency:
1428 which says that the object file <Filename>Foo.o</Filename> depends on the interface file
1429 <Filename>Baz.hi</Filename> generated by compiling module <Literal>Baz</Literal>. The <Filename>.depend</Filename> file is
1430 automatically included by every Makefile.
1432 </ListItem></VarListEntry>
1434 <Term><Literal>binary-dist</Literal>:</Term>
1437 make a binary distribution. This is the
1438 target we use to build the binary distributions of GHC and Happy.
1440 </ListItem></VarListEntry>
1442 <Term><Literal>dist</Literal>:</Term>
1445 make a source distribution. You must be in a
1446 linked build tree to make this target.
1448 </ListItem></VarListEntry>
1453 Most <Filename>Makefile</Filename>s have targets other than these. You can discover them by looking in the <Filename>Makefile</Filename> itself.
1460 <IndexTerm><Primary>fastmake</Primary></IndexTerm>
1461 <IndexTerm><Primary>dependencies, omitting</Primary></IndexTerm>
1462 <IndexTerm><Primary>FAST, makefile variable</Primary></IndexTerm></Title>
1465 Sometimes the dependencies get in the way: if you've made a small
1466 change to one file, and you're absolutely sure that it won't affect
1467 anything else, but you know that <Command>make</Command> is going to rebuild everything
1468 anyway, the following hack may be useful:
1480 This tells the make system to ignore dependencies and just build what
1481 you tell it to. In other words, it's equivalent to temporarily
1482 removing the <Filename>.depend</Filename> file in the current directory (where
1483 <Command>mkdependHS</Command> and friends store their dependency information).
1487 A bit of history: GHC used to come with a <Command>fastmake</Command> script that did
1488 the above job, but GNU make provides the features we need to do it
1489 without resorting to a script. Also, we've found that fastmaking is
1490 less useful since the advent of GHC's recompilation checker (see the
1491 User's Guide section on "Separate Compilation").
1499 <Title>The <Filename>Makefile</Filename> architecture
1500 <IndexTerm><Primary>makefile architecture</Primary></IndexTerm></Title>
1503 <Command>make</Command> is great if everything works—you type <Command>gmake install</Command> and
1504 lo! the right things get compiled and installed in the right places.
1505 Our goal is to make this happen often, but somehow it often doesn't;
1506 instead some weird error message eventually emerges from the bowels of
1507 a directory you didn't know existed.
1511 The purpose of this section is to give you a road-map to help you figure
1512 out what is going right and what is going wrong.
1516 <Title>A small project</Title>
1519 To get started, let us look at the <Filename>Makefile</Filename> for an imaginary small
1520 <Literal>fptools</Literal> project, <Literal>small</Literal>. Each project in <Literal>fptools</Literal> has its own
1521 directory in <Constant>FPTOOLS_TOP</Constant>, so the <Literal>small</Literal> project will have its own
1522 directory <Constant>FPOOLS_TOP/small/</Constant>. Inside the <Filename>small/</Filename> directory there
1523 will be a <Filename>Makefile</Filename>, looking something like this:
1527 <IndexTerm><Primary>Makefile, minimal</Primary></IndexTerm>
1530 # Makefile for fptools project "small"
1533 include $(TOP)/mk/boilerplate.mk
1535 SRCS = $(wildcard *.lhs) $(wildcard *.c)
1538 include $(TOP)/target.mk
1544 This <Filename>Makefile</Filename> has three sections:
1553 The first section includes
1557 One of the most important
1558 features of GNU <Command>make</Command> that we use is the ability for a <Filename>Makefile</Filename> to
1559 include another named file, very like <Command>cpp</Command>'s <Literal>#include</Literal>
1564 a file of ``boilerplate'' code from the level
1565 above (which in this case will be
1566 <Filename><Constant>FPTOOLS_TOP</Constant>/mk/boilerplate.mk</Filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm>). As its name
1567 suggests, <Filename>boilerplate.mk</Filename> consists of a large quantity of standard
1568 <Filename>Makefile</Filename> code. We discuss this boilerplate in more detail in
1569 <XRef LinkEnd="sec-boiler">.
1570 <IndexTerm><Primary>include, directive in Makefiles</Primary></IndexTerm>
1571 <IndexTerm><Primary>Makefile inclusion</Primary></IndexTerm>
1573 Before the <Literal>include</Literal> statement, you must define the <Command>make</Command> variable
1574 <Constant>TOP</Constant><IndexTerm><Primary>TOP</Primary></IndexTerm> to be the directory containing the <Filename>mk</Filename> directory in
1575 which the <Filename>boilerplate.mk</Filename> file is. It is <Emphasis>not</Emphasis> OK to simply say
1579 include ../mk/boilerplate.mk # NO NO NO
1583 Why? Because the <Filename>boilerplate.mk</Filename> file needs to know where it is, so
1584 that it can, in turn, <Literal>include</Literal> other files. (Unfortunately, when an
1585 <Literal>include</Literal>d file does an <Literal>include</Literal>, the filename is treated relative to
1586 the directory in which <Command>gmake</Command> is being run, not the directory in
1587 which the <Literal>include</Literal>d sits.) In general, <Emphasis>every file <Filename>foo.mk</Filename>
1588 assumes that <Filename><Constant>$(TOP)</Constant>/mk/foo.mk</Filename> refers to itself.</Emphasis> It is up to the
1589 <Filename>Makefile</Filename> doing the <Literal>include</Literal> to ensure this is the case.
1591 Files intended for inclusion in other <Filename>Makefile</Filename>s are written to have
1592 the following property: <Emphasis>after <Filename>foo.mk</Filename> is <Literal>include</Literal>d, it leaves
1593 <Constant>TOP</Constant> containing the same value as it had just before the <Literal>include</Literal>
1594 statement</Emphasis>. In our example, this invariant guarantees that the
1595 <Literal>include</Literal> for <Filename>target.mk</Filename> will look in the same directory as that for
1596 <Filename>boilerplate.mk</Filename>.
1603 The second section defines the following standard <Command>make</Command>
1604 variables: <Constant>SRCS</Constant><IndexTerm><Primary>SRCS</Primary></IndexTerm> (the source files from which is to be
1605 built), and <Constant>HS_PROG</Constant><IndexTerm><Primary>HS_PROG</Primary></IndexTerm> (the executable binary to be
1606 built). We will discuss in more detail what the ``standard
1607 variables'' are, and how they affect what happens, in <XRef LinkEnd="sec-targets">.
1609 The definition for <Constant>SRCS</Constant> uses the useful GNU <Command>make</Command> construct
1610 <Literal>$(wildcard $pat$)</Literal><IndexTerm><Primary>wildcard</Primary></IndexTerm>, which expands to a list of all
1611 the files matching the pattern <Literal>pat</Literal> in the current directory. In
1612 this example, <Constant>SRCS</Constant> is set to the list of all the <Filename>.lhs</Filename> and <Filename>.c</Filename>
1613 files in the directory. (Let's suppose there is one of each,
1614 <Filename>Foo.lhs</Filename> and <Filename>Baz.c</Filename>.)
1621 The last section includes a second file of standard code,
1622 called <Filename>target.mk</Filename><IndexTerm><Primary>target.mk</Primary></IndexTerm>. It contains the rules that tell
1623 <Command>gmake</Command> how to make the standard targets (<Xref LinkEnd="sec-standard-targets">). Why, you ask,
1624 can't this standard code be part of <Filename>boilerplate.mk</Filename>? Good question.
1625 We discuss the reason later, in <Xref LinkEnd="sec-boiler-arch">.
1627 You do not <Emphasis>have</Emphasis> to <Literal>include</Literal> the <Filename>target.mk</Filename> file. Instead, you
1628 can write rules of your own for all the standard targets. Usually,
1629 though, you will find quite a big payoff from using the canned rules
1630 in <Filename>target.mk</Filename>; the price tag is that you have to understand what
1631 canned rules get enabled, and what they do (<Xref LinkEnd="sec-targets">).
1641 In our example <Filename>Makefile</Filename>, most of the work is done by the two
1642 <Literal>include</Literal>d files. When you say <Command>gmake all</Command>, the following things
1652 <Command>gmake</Command> figures out that the object files are <Filename>Foo.o</Filename> and
1653 <Filename>Baz.o</Filename>.
1660 It uses a boilerplate pattern rule to compile <Filename>Foo.lhs</Filename> to
1661 <Filename>Foo.o</Filename> using a Haskell compiler. (Which one? That is set in the
1662 build configuration.)
1669 It uses another standard pattern rule to compile <Filename>Baz.c</Filename> to
1670 <Filename>Baz.o</Filename>, using a C compiler. (Ditto.)
1677 It links the resulting <Filename>.o</Filename> files together to make <Literal>small</Literal>,
1678 using the Haskell compiler to do the link step. (Why not use <Command>ld</Command>?
1679 Because the Haskell compiler knows what standard libraries to link in.
1680 How did <Command>gmake</Command> know to use the Haskell compiler to do the link,
1681 rather than the C compiler? Because we set the variable <Constant>HS_PROG</Constant>
1682 rather than <Constant>C_PROG</Constant>.)
1692 All <Filename>Makefile</Filename>s should follow the above three-section format.
1698 <Title>A larger project</Title>
1701 Larger projects are usually structured into a number of sub-directories,
1702 each of which has its own <Filename>Makefile</Filename>. (In very large projects, this
1703 sub-structure might be iterated recursively, though that is rare.)
1704 To give you the idea, here's part of the directory structure for
1705 the (rather large) GHC project:
1718 ...source files for documentation...
1721 ...source files for driver...
1724 parser/...source files for parser...
1725 renamer/...source files for renamer...
1732 The sub-directories <Filename>docs</Filename>, <Filename>driver</Filename>, <Filename>compiler</Filename>, and so on, each
1733 contains a sub-component of GHC, and each has its own <Filename>Makefile</Filename>.
1734 There must also be a <Filename>Makefile</Filename> in <Filename><Constant>$(FPTOOLS_TOP)</Constant>/ghc</Filename>. It does most
1735 of its work by recursively invoking <Command>gmake</Command> on the <Filename>Makefile</Filename>s in the
1736 sub-directories. We say that <Filename>ghc/Makefile</Filename> is a <Emphasis>non-leaf
1737 <Filename>Makefile</Filename></Emphasis>, because it does little except organise its children,
1738 while the <Filename>Makefile</Filename>s in the sub-directories are all <Emphasis>leaf
1739 <Filename>Makefile</Filename>s</Emphasis>. (In principle the sub-directories might themselves
1740 contain a non-leaf <Filename>Makefile</Filename> and several sub-sub-directories, but
1741 that does not happen in GHC.)
1745 The <Filename>Makefile</Filename> in <Filename>ghc/compiler</Filename> is considered a leaf <Filename>Makefile</Filename> even
1746 though the <Filename>ghc/compiler</Filename> has sub-directories, because these sub-directories
1747 do not themselves have <Filename>Makefile</Filename>s in them. They are just used to structure
1748 the collection of modules that make up GHC, but all are managed by the
1749 single <Filename>Makefile</Filename> in <Filename>ghc/compiler</Filename>.
1753 You will notice that <Filename>ghc/</Filename> also contains a directory <Filename>ghc/mk/</Filename>. It
1754 contains GHC-specific <Filename>Makefile</Filename> boilerplate code. More precisely:
1763 <Filename>ghc/mk/boilerplate.mk</Filename> is included at the top of
1764 <Filename>ghc/Makefile</Filename>, and of all the leaf <Filename>Makefile</Filename>s in the
1765 sub-directories. It in turn <Literal>include</Literal>s the main boilerplate file
1766 <Filename>mk/boilerplate.mk</Filename>.
1774 <Filename>ghc/mk/target.mk</Filename> is <Literal>include</Literal>d at the bottom of
1775 <Filename>ghc/Makefile</Filename>, and of all the leaf <Filename>Makefile</Filename>s in the
1776 sub-directories. It in turn <Literal>include</Literal>s the file <Filename>mk/target.mk</Filename>.
1786 So these two files are the place to look for GHC-wide customisation
1787 of the standard boilerplate.
1792 <Sect2 id="sec-boiler-arch">
1793 <Title>Boilerplate architecture
1794 <IndexTerm><Primary>boilerplate architecture</Primary></IndexTerm>
1798 Every <Filename>Makefile</Filename> includes a <Filename>boilerplate.mk</Filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm> file
1799 at the top, and <Filename>target.mk</Filename><IndexTerm><Primary>target.mk</Primary></IndexTerm> file at the bottom. In
1800 this section we discuss what is in these files, and why there have to
1801 be two of them. In general:
1810 <Filename>boilerplate.mk</Filename> consists of:
1816 <Emphasis>Definitions of millions of <Command>make</Command> variables</Emphasis> that
1817 collectively specify the build configuration. Examples:
1818 <Constant>HC_OPTS</Constant><IndexTerm><Primary>HC_OPTS</Primary></IndexTerm>, the options to feed to the Haskell compiler;
1819 <Constant>NoFibSubDirs</Constant><IndexTerm><Primary>NoFibSubDirs</Primary></IndexTerm>, the sub-directories to enable within the
1820 <Literal>nofib</Literal> project; <Constant>GhcWithHc</Constant><IndexTerm><Primary>GhcWithHc</Primary></IndexTerm>, the name of the Haskell
1821 compiler to use when compiling GHC in the <Literal>ghc</Literal> project.
1827 <Emphasis>Standard pattern rules</Emphasis> that tell <Command>gmake</Command> how to construct one
1835 <Filename>boilerplate.mk</Filename> needs to be <Literal>include</Literal>d at the <Emphasis>top</Emphasis>
1836 of each <Filename>Makefile</Filename>, so that the user can replace the
1837 boilerplate definitions or pattern rules by simply giving a new
1838 definition or pattern rule in the <Filename>Makefile</Filename>. <Command>gmake</Command>
1839 simply takes the last definition as the definitive one.
1841 Instead of <Emphasis>replacing</Emphasis> boilerplate definitions, it is also quite
1842 common to <Emphasis>augment</Emphasis> them. For example, a <Filename>Makefile</Filename> might say:
1850 thereby adding ``<Option>-O</Option>'' to the end of <Constant>SRC_HC_OPTS</Constant><IndexTerm><Primary>SRC_HC_OPTS</Primary></IndexTerm>.
1857 <Filename>target.mk</Filename> contains <Command>make</Command> rules for the standard
1858 targets described in <Xref LinkEnd="sec-standard-targets">. These rules are selectively included,
1859 depending on the setting of certain <Command>make</Command> variables. These
1860 variables are usually set in the middle section of the
1861 <Filename>Makefile</Filename> between the two <Literal>include</Literal>s.
1863 <Filename>target.mk</Filename> must be included at the end (rather than being part of
1864 <Filename>boilerplate.mk</Filename>) for several tiresome reasons:
1871 <Command>gmake</Command> commits target and dependency lists earlier than
1872 it should. For example, <FIlename>target.mk</FIlename> has a rule that looks like
1877 $(HS_PROG) : $(OBJS)
1878 $(HC) $(LD_OPTS) $< -o $@
1882 If this rule was in <Filename>boilerplate.mk</Filename> then <Constant>$(HS_PROG)</Constant><IndexTerm><Primary>HS_PROG</Primary></IndexTerm>
1883 and <Constant>$(OBJS)</Constant><IndexTerm><Primary>OBJS</Primary></IndexTerm> would not have their final values at the
1884 moment <Command>gmake</Command> encountered the rule. Alas, <Command>gmake</Command> takes a snapshot
1885 of their current values, and wires that snapshot into the rule. (In
1886 contrast, the commands executed when the rule ``fires'' are only
1887 substituted at the moment of firing.) So, the rule must follow the
1888 definitions given in the <Filename>Makefile</Filename> itself.
1895 Unlike pattern rules, ordinary rules cannot be overriden or
1896 replaced by subsequent rules for the same target (at least, not without an
1897 error message). Including ordinary rules in <Filename>boilerplate.mk</Filename> would
1898 prevent the user from writing rules for specific targets in specific cases.
1905 There are a couple of other reasons I've forgotten, but it doesn't
1921 <Sect2 id="sec-boiler">
1922 <Title>The main <Filename>mk/boilerplate.mk</Filename> file
1924 <IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm></Title>
1927 If you look at <Filename><Constant>$(FPTOOLS_TOP)</Constant>/mk/boilerplate.mk</Filename> you will find
1928 that it consists of the following sections, each held in a separate
1936 <Term><Filename>config.mk</Filename><IndexTerm><Primary>config.mk</Primary></IndexTerm></Term>
1939 is the build configuration file we
1940 discussed at length in <Xref LinkEnd="sec-build-config">.
1942 </ListItem></VarListEntry>
1944 <Term><Filename>paths.mk</Filename><IndexTerm><Primary>paths.mk</Primary></IndexTerm></Term>
1947 defines <Command>make</Command> variables for
1948 pathnames and file lists. In particular, it gives definitions for:
1955 <Term><Constant>SRCS</Constant><IndexTerm><Primary>SRCS</Primary></IndexTerm>:</Term>
1958 all source files in the current directory.
1960 </ListItem></VarListEntry>
1962 <Term><Constant>HS_SRCS</Constant><IndexTerm><Primary>HS_SRCS</Primary></IndexTerm>:</Term>
1965 all Haskell source files in the current directory.
1966 It is derived from <Constant>$(SRCS)</Constant>, so if you override <Constant>SRCS</Constant> with a new value
1967 <Constant>HS_SRCS</Constant> will follow suit.
1969 </ListItem></VarListEntry>
1971 <Term><Constant>C_SRCS</Constant><IndexTerm><Primary>C_SRCS</Primary></IndexTerm>:</Term>
1974 similarly for C source files.
1976 </ListItem></VarListEntry>
1978 <Term><Constant>HS_OBJS</Constant><IndexTerm><Primary>HS_OBJS</Primary></IndexTerm>:</Term>
1981 the <Filename>.o</Filename> files derived from <Constant>$(HS_SRCS)</Constant>.
1983 </ListItem></VarListEntry>
1985 <Term><Constant>C_OBJS</Constant><IndexTerm><Primary>C_OBJS</Primary></IndexTerm>:</Term>
1988 similarly for <Constant>$(C_SRCS)</Constant>.
1990 </ListItem></VarListEntry>
1992 <Term><Constant>OBJS</Constant><IndexTerm><Primary>OBJS</Primary></IndexTerm>:</Term>
1995 the concatenation of <Constant>$(HS_OBJS)</Constant> and <Constant>$(C_OBJS)</Constant>.
1997 </ListItem></VarListEntry>
2002 Any or all of these definitions can easily be overriden by giving new
2003 definitions in your <Filename>Makefile</Filename>. For example, if there are things in
2004 the current directory that look like source files but aren't, then
2005 you'll need to set <Constant>SRCS</Constant> manually in your <Filename>Makefile</Filename>. The other
2006 definitions will then work from this new definition.
2010 What, exactly, does <Filename>paths.mk</Filename> consider a ``source file'' to be? It's
2011 based on the file's suffix (e.g. <Filename>.hs</Filename>, <Filename>.lhs</Filename>, <Filename>.c</Filename>, <Filename>.lc</Filename>, etc), but
2012 this is the kind of detail that changes, so rather than
2013 enumerate the source suffices here the best thing to do is to look in
2014 <Filename>paths.mk</Filename>.
2016 </ListItem></VarListEntry>
2018 <Term><Filename>opts.mk</Filename><IndexTerm><Primary>opts.mk</Primary></IndexTerm></Term>
2021 defines <Command>make</Command> variables for option
2022 strings to pass to each program. For example, it defines
2023 <Constant>HC_OPTS</Constant><IndexTerm><Primary>HC_OPTS</Primary></IndexTerm>, the option strings to pass to the Haskell
2024 compiler. See <Xref LinkEnd="sec-suffix">.
2026 </ListItem></VarListEntry>
2028 <Term><Filename>suffix.mk</Filename><IndexTerm><Primary>suffix.mk</Primary></IndexTerm></Term>
2031 defines standard pattern rules—see <Xref LinkEnd="sec-suffix">.
2033 </ListItem></VarListEntry>
2038 Any of the variables and pattern rules defined by the boilerplate file
2039 can easily be overridden in any particular <Filename>Makefile</Filename>, because the
2040 boilerplate <Literal>include</Literal> comes first. Definitions after this <Literal>include</Literal>
2041 directive simply override the default ones in <Filename>boilerplate.mk</Filename>.
2046 <Sect2 id="sec-suffix">
2047 <Title>Pattern rules and options
2049 <IndexTerm><Primary>Pattern rules</Primary></IndexTerm></Title>
2052 The file <Filename>suffix.mk</Filename><IndexTerm><Primary>suffix.mk</Primary></IndexTerm> defines standard <Emphasis>pattern
2053 rules</Emphasis> that say how to build one kind of file from another, for
2054 example, how to build a <Filename>.o</Filename> file from a <Filename>.c</Filename> file. (GNU <Command>make</Command>'s
2055 <Emphasis>pattern rules</Emphasis> are more powerful and easier to use than Unix
2056 <Command>make</Command>'s <Emphasis>suffix rules</Emphasis>.)
2060 Almost all the rules look something like this:
2068 $(CC) $(CC_OPTS) -c $< -o $@
2074 Here's how to understand the rule. It says that
2075 <Emphasis>something</Emphasis><Filename>.o</Filename> (say <Filename>Foo.o</Filename>) can be built from
2076 <Emphasis>something</Emphasis><Filename>.c</Filename> (<Filename>Foo.c</Filename>), by invoking the C compiler
2077 (path name held in <Constant>$(CC)</Constant>), passing to it the options
2078 <Constant>$(CC_OPTS)</Constant> and the rule's dependent file of the rule
2079 <Literal>$<</Literal> (<Filename>Foo.c</Filename> in this case), and putting the result in
2080 the rule's target <Literal>$@</Literal> (<Filename>Foo.o</Filename> in this case).
2084 Every program is held in a <Command>make</Command> variable defined in
2085 <Filename>mk/config.mk</Filename>—look in <Filename>mk/config.mk</Filename> for the
2086 complete list. One important one is the Haskell compiler, which is
2087 called <Constant>$(HC)</Constant>.
2091 Every program's options are are held in a <Command>make</Command> variables called
2092 <Constant><prog>_OPTS</Constant>. the <Constant><prog>_OPTS</Constant> variables are defined in
2093 <Filename>mk/opts.mk</Filename>. Almost all of them are defined like this:
2099 CC_OPTS = $(SRC_CC_OPTS) $(WAY$(_way)_CC_OPTS) $($*_CC_OPTS) $(EXTRA_CC_OPTS)
2105 The four variables from which <Constant>CC_OPTS</Constant> is built have the following meaning:
2112 <Term><Constant>SRC_CC_OPTS</Constant><IndexTerm><Primary>SRC_CC_OPTS</Primary></IndexTerm>:</Term>
2115 options passed to all C
2118 </ListItem></VarListEntry>
2120 <Term><Constant>WAY_<way>_CC_OPTS</Constant>:</Term>
2124 compilations for way <Literal><way></Literal>. For example,
2125 <Constant>WAY_mp_CC_OPTS</Constant> gives options to pass to the C compiler when
2126 compiling way <Literal>mp</Literal>. The variable <Constant>WAY_CC_OPTS</Constant> holds
2127 options to pass to the C compiler when compiling the standard way.
2128 (<Xref LinkEnd="sec-ways"> dicusses multi-way
2131 </ListItem></VarListEntry>
2133 <Term><Constant><module>_CC_OPTS</Constant>:</Term>
2137 pass to the C compiler that are specific to module <Literal><module></Literal>. For example, <Constant>SMap_CC_OPTS</Constant> gives the specific options
2138 to pass to the C compiler when compiling <Filename>SMap.c</Filename>.
2140 </ListItem></VarListEntry>
2142 <Term><Constant>EXTRA_CC_OPTS</Constant><IndexTerm><Primary>EXTRA_CC_OPTS</Primary></IndexTerm>:</Term>
2145 extra options to pass to all
2146 C compilations. This is intended for command line use, thus:
2152 gmake libHS.a EXTRA_CC_OPTS="-v"
2156 </ListItem></VarListEntry>
2162 <Sect2 id="sec-targets">
2163 <Title>The main <Filename>mk/target.mk</Filename> file
2165 <IndexTerm><Primary>target.mk</Primary></IndexTerm></Title>
2168 <Filename>target.mk</Filename> contains canned rules for all the standard targets
2169 described in <Xref LinkEnd="sec-standard-targets">. It is complicated by the fact that you don't want all of
2170 these rules to be active in every <Filename>Makefile</Filename>. Rather than have a
2171 plethora of tiny files which you can include selectively, there is a
2172 single file, <Filename>target.mk</Filename>, which selectively includes rules based on
2173 whether you have defined certain variables in your <Filename>Makefile</Filename>. This
2174 section explains what rules you get, what variables control them, and
2175 what the rules do. Hopefully, you will also get enough of an idea of
2176 what is supposed to happen that you can read and understand any weird
2177 special cases yourself.
2184 <Term><Constant>HS_PROG</Constant><IndexTerm><Primary>HS_PROG</Primary></IndexTerm>.</Term>
2187 If <Constant>HS_PROG</Constant> is defined, you get
2188 rules with the following targets:
2192 <Term><Filename>HS_PROG</Filename><IndexTerm><Primary>HS_PROG</Primary></IndexTerm></Term>
2195 itself. This rule links <Constant>$(OBJS)</Constant>
2196 with the Haskell runtime system to get an executable called
2197 <Constant>$(HS_PROG)</Constant>.
2199 </ListItem></VarListEntry>
2201 <Term><Literal>install</Literal><IndexTerm><Primary>install</Primary></IndexTerm></Term>
2204 installs <Constant>$(HS_PROG)</Constant>
2205 in <Constant>$(bindir)</Constant>.
2207 </ListItem></VarListEntry>
2210 </ListItem></VarListEntry>
2212 <Term><Constant>C_PROG</Constant><IndexTerm><Primary>C_PROG</Primary></IndexTerm></Term>
2215 is similar to <Constant>HS_PROG</Constant>, except that
2216 the link step links <Constant>$(C_OBJS)</Constant> with the C runtime system.
2218 </ListItem></VarListEntry>
2220 <Term><Constant>LIBRARY</Constant><IndexTerm><Primary>LIBRARY</Primary></IndexTerm></Term>
2223 is similar to <Constant>HS_PROG</Constant>, except that
2224 it links <Constant>$(LIB_OBJS)</Constant> to make the library archive <Constant>$(LIBRARY)</Constant>, and
2225 <Literal>install</Literal> installs it in <Constant>$(libdir)</Constant>.
2227 </ListItem></VarListEntry>
2229 <Term><Constant>LIB_DATA</Constant><IndexTerm><Primary>LIB_DATA</Primary></IndexTerm></Term>
2234 </ListItem></VarListEntry>
2236 <Term><Constant>LIB_EXEC</Constant><IndexTerm><Primary>LIB_EXEC</Primary></IndexTerm></Term>
2241 </ListItem></VarListEntry>
2243 <Term><Constant>HS_SRCS</Constant><IndexTerm><Primary>HS_SRCS</Primary></IndexTerm>, <Constant>C_SRCS</Constant><IndexTerm><Primary>C_SRCS</Primary></IndexTerm>.</Term>
2246 If <Constant>HS_SRCS</Constant>
2247 is defined and non-empty, a rule for the target <Literal>depend</Literal> is included,
2248 which generates dependency information for Haskell programs.
2249 Similarly for <Constant>C_SRCS</Constant>.
2251 </ListItem></VarListEntry>
2256 All of these rules are ``double-colon'' rules, thus
2262 install :: $(HS_PROG)
2263 ...how to install it...
2269 GNU <Command>make</Command> treats double-colon rules as separate entities. If there
2270 are several double-colon rules for the same target it takes each in
2271 turn and fires it if its dependencies say to do so. This means that
2272 you can, for example, define both <Constant>HS_PROG</Constant> and <Constant>LIBRARY</Constant>, which will
2273 generate two rules for <Literal>install</Literal>. When you type <Command>gmake install</Command> both
2274 rules will be fired, and both the program and the library will be
2275 installed, just as you wanted.
2280 <Sect2 id="sec-subdirs">
2283 <IndexTerm><Primary>recursion, in makefiles</Primary></IndexTerm>
2284 <IndexTerm><Primary>Makefile, recursing into subdirectories</Primary></IndexTerm></Title>
2287 In leaf <Filename>Makefile</Filename>s the variable <Constant>SUBDIRS</Constant><IndexTerm><Primary>SUBDIRS</Primary></IndexTerm> is undefined.
2288 In non-leaf <Filename>Makefile</Filename>s, <Constant>SUBDIRS</Constant> is set to the list of
2289 sub-directories that contain subordinate <Filename>Makefile</Filename>s. <Emphasis>It is up to
2290 you to set <Constant>SUBDIRS</Constant> in the <Filename>Makefile</Filename>.</Emphasis> There is no automation here—<Constant>SUBDIRS</Constant> is too important to automate.
2294 When <Constant>SUBDIRS</Constant> is defined, <Filename>target.mk</Filename> includes a rather
2295 neat rule for the standard targets (<Xref LinkEnd="sec-standard-targets"> that simply invokes
2296 <Command>make</Command> recursively in each of the sub-directories.
2300 <Emphasis>These recursive invocations are guaranteed to occur in the order
2301 in which the list of directories is specified in <Constant>SUBDIRS</Constant>. </Emphasis>This
2302 guarantee can be important. For example, when you say <Command>gmake boot</Command> it
2303 can be important that the recursive invocation of <Command>make boot</Command> is done
2304 in one sub-directory (the include files, say) before another (the
2305 source files). Generally, put the most independent sub-directory
2306 first, and the most dependent last.
2311 <Sect2 id="sec-ways">
2312 <Title>Way management
2314 <IndexTerm><Primary>way management</Primary></IndexTerm></Title>
2317 We sometimes want to build essentially the same system in several
2318 different ``ways''. For example, we want to build GHC's <Literal>Prelude</Literal>
2319 libraries with and without profiling, with and without concurrency,
2320 and so on, so that there is an appropriately-built library archive to
2321 link with when the user compiles his program. It would be possible to
2322 have a completely separate build tree for each such ``way'', but it
2323 would be horribly bureaucratic, especially since often only parts of
2324 the build tree need to be constructed in multiple ways.
2328 Instead, the <Filename>target.mk</Filename><IndexTerm><Primary>target.mk</Primary></IndexTerm> contains some clever magic to
2329 allow you to build several versions of a system; and to control
2330 locally how many versions are built and how they differ. This section
2335 The files for a particular way are distinguished by munging the
2336 suffix. The ``normal way'' is always built, and its files have the
2337 standard suffices <Filename>.o</Filename>, <Filename>.hi</Filename>, and so on. In addition, you can build
2338 one or more extra ways, each distinguished by a <Emphasis>way tag</Emphasis>. The
2339 object files and interface files for one of these extra ways are
2340 distinguished by their suffix. For example, way <Literal>mp</Literal> has files
2341 <Filename>.mp_o</Filename> and <Filename>.mp_hi</Filename>. Library archives have their way tag the other
2342 side of the dot, for boring reasons; thus, <Filename>libHS_mp.a</Filename>.
2346 A <Command>make</Command> variable called <Constant>way</Constant> holds the current way tag. <Emphasis><Constant>way</Constant>
2347 is only ever set on the command line of a recursive invocation of
2348 <Command>gmake</Command>.</Emphasis> It is never set inside a <Filename>Makefile</Filename>. So it is a global
2349 constant for any one invocation of <Command>gmake</Command>. Two other <Command>make</Command>
2350 variables, <Constant>way_</Constant> and <Constant>_way</Constant> are immediately derived from <Constant>$(way)</Constant> and
2351 never altered. If <Constant>way</Constant> is not set, then neither are <Constant>way_</Constant> and
2352 <Constant>_way</Constant>, and the invocation of <Command>make</Command> will build the ``normal way''.
2353 If <Constant>way</Constant> is set, then the other two variables are set in sympathy.
2354 For example, if <Constant>$(way)</Constant> is ``<Literal>mp</Literal>'', then <Constant>way_</Constant> is set to ``<Literal>mp_</Literal>''
2355 and <Constant>_way</Constant> is set to ``<Literal>_mp</Literal>''. These three variables are then used
2356 when constructing file names.
2360 So how does <Command>make</Command> ever get recursively invoked with <Constant>way</Constant> set? There
2361 are two ways in which this happens:
2370 For some (but not all) of the standard targets, when in a leaf
2371 sub-directory, <Command>make</Command> is recursively invoked for each way tag in
2372 <Constant>$(WAYS)</Constant>. You set <Constant>WAYS</Constant> to the list of way tags you want these
2373 targets built for. The mechanism here is very much like the recursive
2374 invocation of <Command>make</Command> in sub-directories (<Xref LinkEnd="sec-subdirs">).
2376 It is up to you to set <Constant>WAYS</Constant> in your <Filename>Makefile</Filename>; this is how you
2377 control what ways will get built.
2383 For a useful collection of
2384 targets (such as <Filename>libHS_mp.a</Filename>, <Filename>Foo.mp_o</Filename>) there is a rule which
2385 recursively invokes <Command>make</Command> to make the specified target, setting the
2386 <Constant>way</Constant> variable. So if you say <Command>gmake Foo.mp_o</Command> you should see a
2387 recursive invocation <Command>gmake Foo.mp_o way=mp</Command>, and <Emphasis>in this
2388 recursive invocation the pattern rule for compiling a Haskell file
2389 into a <Filename>.o</Filename> file will match</Emphasis>. The key pattern rules (in <Filename>suffix.mk</Filename>)
2395 $(HC) $(HC_OPTS) $< -o $@
2410 <Title>When the canned rule isn't right</Title>
2413 Sometimes the canned rule just doesn't do the right thing. For
2414 example, in the <Literal>nofib</Literal> suite we want the link step to print out
2415 timing information. The thing to do here is <Emphasis>not</Emphasis> to define
2416 <Constant>HS_PROG</Constant> or <Constant>C_PROG</Constant>, and instead define a special purpose rule in
2417 your own <Filename>Makefile</Filename>. By using different variable names you will avoid
2418 the canned rules being included, and conflicting with yours.
2425 <Sect1 id="sec-booting-from-C">
2426 <Title>Booting/porting from C (<Filename>.hc</Filename>) files
2428 <IndexTerm><Primary>building GHC from .hc files</Primary></IndexTerm>
2429 <IndexTerm><Primary>booting GHC from .hc files</Primary></IndexTerm>
2430 <IndexTerm><Primary>porting GHC</Primary></IndexTerm></Title>
2433 This section is for people trying to get GHC going by using the
2434 supplied intermediate C (<Filename>.hc</Filename>) files. This would probably be because
2435 no binaries have been provided, or because the machine is not ``fully
2440 The intermediate C files are normally made available together with a
2441 source release, please check the announce message for exact directions
2442 of where to find them. If we haven't made them available or you
2443 can't find them, please ask.
2447 Assuming you've got them, unpack them on top of a fresh source tree.
2448 Then follow the `normal' instructions in <Xref LinkEnd="sec-building-from-source"> for setting
2449 up a build tree. When you invoke the configure script, you'll have
2450 to tell the script about your intentions:
2456 foo% ./configure --enable-hc-boot
2459 <IndexTerm><Primary>--enable-hc-boot</Primary></IndexTerm>
2460 <IndexTerm><Primary>--disable-hc-boot</Primary></IndexTerm>
2464 Assuming it configures OK and you don't need to create <Filename>mk/build.mk</Filename>
2465 for any other purposes, the next step is to proceed with a <Command>make boot</Command>
2466 followed by <Command>make all</Command>. At the successful completion of <Command>make all</Command>,
2467 you should end up with a binary of the compiler proper,
2468 <Filename>ghc/compiler/hsc</Filename>, plus archives (but no <Filename>.hi</Filename> files!) of the prelude
2469 libraries. To generate the Prelude interface files (and test drive the
2470 bootstrapped compiler), re-run the <Command>configure</Command> script, but this time
2471 without the <Option>--enable-hc-boot</Option> option. After that re-create the
2472 contents of <Filename>ghc/lib</Filename>:
2489 That's the mechanics of the boot process, but, of course, if you're
2490 trying to boot on a platform that is not supported and significantly
2491 `different' from any of the supported ones, this is only the start of
2492 the adventure…(ToDo: porting tips—stuff to look out for, etc.)
2497 <Sect1 id="sec-build-pitfalls">
2498 <Title>Known pitfalls in building Glasgow Haskell
2500 <IndexTerm><Primary>problems, building</Primary></IndexTerm>
2501 <IndexTerm><Primary>pitfalls, in building</Primary></IndexTerm>
2502 <IndexTerm><Primary>building pitfalls</Primary></IndexTerm></Title>
2505 WARNINGS about pitfalls and known ``problems'':
2514 One difficulty that comes up from time to time is running out of space
2515 in <Filename>/tmp</Filename>. (It is impossible for the configuration stuff to
2516 compensate for the vagaries of different sysadmin approaches to temp
2518 <IndexTerm><Primary>tmp, running out of space in</Primary></IndexTerm>
2520 The quickest way around it is <Command>setenv TMPDIR /usr/tmp</Command><IndexTerm><Primary>TMPDIR</Primary></IndexTerm> or
2521 even <Command>setenv TMPDIR .</Command> (or the equivalent incantation with your shell
2524 The best way around it is to say
2527 export TMPDIR=<dir>
2530 in your <Filename>build.mk</Filename> file.
2531 Then GHC and the other <Literal>fptools</Literal> programs will use the appropriate directory
2540 In compiling some support-code bits, e.g., in <Filename>ghc/rts/gmp</Filename> and even
2541 in <Filename>ghc/lib</Filename>, you may get a few C-compiler warnings. We think these
2549 When compiling via C, you'll sometimes get ``warning: assignment from
2550 incompatible pointer type'' out of GCC. Harmless.
2557 Similarly, <Command>ar</Command>chiving warning messages like the following are not
2561 ar: filename GlaIOMonad__1_2s.o truncated to GlaIOMonad_
2562 ar: filename GlaIOMonad__2_2s.o truncated to GlaIOMonad_
2572 In compiling the compiler proper (in <Filename>compiler/</Filename>), you <Emphasis>may</Emphasis>
2573 get an ``Out of heap space'' error message. These can vary with the
2574 vagaries of different systems, it seems. The solution is simple:
2581 If you're compiling with GHC 4.00 or above, then the
2582 <Emphasis>maximum</Emphasis> heap size must have been reached. This is somewhat
2583 unlikely, since the maximum is set to 64M by default. Anyway, you can
2584 raise it with the <Option>-optCrts-M<size></Option> flag (add this flag to
2585 <Constant><module>_HC_OPTS</Constant> <Command>make</Command> variable in the appropriate <Filename>Makefile</Filename>).
2592 For GHC < 4.00, add a suitable <Option>-H</Option> flag to the <Filename>Makefile</Filename>, as
2601 and try again: <Command>gmake</Command>. (see <Xref LinkEnd="sec-suffix"> for information about
2602 <Constant><module>_HC_OPTS</Constant>.)
2604 Alternatively, just cut to the chase:
2608 % make EXTRA_HC_OPTS=-optCrts-M128M
2617 If you try to compile some Haskell, and you get errors from GCC about
2618 lots of things from <Filename>/usr/include/math.h</Filename>, then your GCC was
2619 mis-installed. <Command>fixincludes</Command> wasn't run when it should've been.
2621 As <Command>fixincludes</Command> is now automagically run as part of GCC installation,
2622 this bug also suggests that you have an old GCC.
2630 You <Emphasis>may</Emphasis> need to re-<Command>ranlib</Command><IndexTerm><Primary>ranlib</Primary></IndexTerm> your libraries (on Sun4s).
2634 % cd $(libdir)/ghc-x.xx/sparc-sun-sunos4
2635 % foreach i ( `find . -name '*.a' -print` ) # or other-shell equiv...
2637 ? # or, on some machines: ar s $i
2642 We'd be interested to know if this is still necessary.
2650 GHC's sources go through <Command>cpp</Command> before being compiled, and <Command>cpp</Command> varies
2651 a bit from one Unix to another. One particular gotcha is macro calls
2656 SLIT("Hello, world")
2660 Some <Command>cpp</Command>s treat the comma inside the string as separating two macro
2661 arguments, so you get
2665 :731: macro `SLIT' used with too many (2) args
2669 Alas, <Command>cpp</Command> doesn't tell you the offending file!
2671 Workaround: don't put weird things in string args to <Command>cpp</Command> macros.
2682 <Sect1 id="winbuild"><Title>Notes for building under Windows</Title>
2685 This section summarises how to get the utilities you need on your
2686 Win95/98/NT/2000 machine to use CVS and build GHC. Similar notes for installing and running GHC may be found in the user guide. In general, Win95/Win98 behave the same, and WinNT/Win2k behave the same. It is based largely on detailed advice from Sigbjørn Finne.
2690 <Sect2><Title>Installing ssh</Title>
2696 Extract the whole of <ULink URL="http://research.microsoft.com/~simonpj/ssh-1_2_26-cygwinb19.tar.gz">the ssh archive</ULink> into your <Filename>C:\</Filename> directory, and use the ``All files'' and ``User folder names'' options in WinZip extract dialogue box. This populates your <Filename>C:\usr\local</Filename> tree.
2702 Extract <ULink URL="http://research.microsoft.com/~simonpj/cygwinb19.dll.zip">cygwinb19.dll</ULink> into <Filename>/usr/local/bin</Filename>. The current version
2703 of Cywin is b20, but this version of ssh was compiled with b19.
2709 On a Win2k machine, open up a bash and do
2714 foo$ mkpasswd -l > passwd
2718 Check that your login entry is on the first line
2719 of that file. If not, move it to the top. It's OK
2720 for 'Administrator' to be the first entry, assuming you are one.
2724 However, Win9x doesn't support the calls that <Command>mkpasswd</Command> relies on
2725 (e.g., <Function>NetUserEnum</Function>). If you run <Command>mkpasswd</Command> you
2730 linked to missing export netapi32.dll:NetUserEnum
2734 The passwd file is used
2735 by ssh in a fairly rudimentary manner, so I'd simply
2736 synthesise/copy an existing Unix <Filename>/etc/passwd</Filename>, i.e., create
2737 an <Filename>/etc/passwd</Filename> file containing the line
2741 <login>::500:513:::/bin/sh
2745 where <Literal><login></Literal> is your login id.
2751 Generate a key, by running <Filename>c:/user/local/bin/ssh-keygen1</Filename>.
2752 This generates a public key in <Filename>.ssh/identity.pub</Filename>, and a
2753 private key in <Filename>.ssh/identity</Filename>
2757 In response to the 'Enter passphrase' question, just hit
2758 return (i.e. use an empty passphrase). The passphrase is
2759 a password that protects your private key. But it's a pain
2760 to type this passphrase everytime you use <Command>ssh</Command>, so the best
2761 thing to do is simply to protect your <Filename>.ssh</Filename> directory, and
2762 <Filename>.ssh/identity</Filename> from access by anyone else. To do this
2763 right-click your <Filename>.ssh</Filename> directory, and select Properties.
2764 If you are not on the access control list, add yourself, and
2765 give yourself full permissions (the second panel).
2766 Remove everyone else from the access control list. (Don't
2767 leave them there but deny them access, because 'they' may be
2768 a list that includes you!)
2772 If you have problems running <Command>ssh-keygen1</Command>
2773 from within <Command>bash</Command>, start up <Filename>cmd.exe</Filename> and run it as follows:
2777 c:\tmp> set CYGWIN32=tty
2778 c:\tmp> c:/user/local/bin/ssh-keygen1
2784 If you don't have an account on <Literal>cvs.haskell.org</Literal>, send
2785 your <Filename>.ssh/identity.pub</Filename> to the CVS repository administrator
2786 (currently Jeff Lewis <Email>jlewis@cse.ogi.edu</Email>). He will set up
2791 If you do have an account on <Literal>cvs.haskell.org</Literal>, use TeraTerm
2792 to logon to it. Once in, copy the
2793 key that <Command>ssh-keygen1</Command> deposited in <Filename>/.ssh/identity.pub</Filename> into
2794 your <Filename>~/.ssh/authorized_keys</Filename>. Make sure that the new version
2795 of <Filename>authorized_keys</Filename> still has 600 file permission.
2804 <Sect2><Title>Installing CVS</Title>
2811 <ULink URL="http://research.microsoft.com/~simonpj/cvs-1_10-win.zip">
2812 CVS</ULink> and, following the instructions in the <Filename>README</Filename>, copy the
2813 appropriate files into <Filename>/usr/local/bin</Filename>.
2819 From the System control panel,
2820 set the following <Emphasis>user</Emphasis> environment variables (see the GHC user guide)
2826 <Constant>HOME</Constant>: points to your home directory. This is where CVS
2827 will look for its <Filename>.cvsrc</Filename> file.
2833 <Constant>CVS_RSH</Constant>: <Filename>c:/usr/local/bin/ssh1</Filename>
2839 <Constant>CVSROOT</Constant>: <Literal>:ext:username@cvs.haskell.org:/home/cvs/root</Literal>,
2840 where <Literal>username</Literal> is your userid
2846 <Constant>CVSEDITOR</Constant>: <Filename>bin/gnuclient.exe</Filename> if you want to use an Emacs buffer for typing in those long commit messages.
2854 Put the following in <Filename>$HOME/.cvsrc</Filename>:
2865 These are the default options for the specified CVS commands,
2866 and represent better defaults than the usual ones. (Feel
2867 free to change them.)
2871 Filenames starting with "<Filename>.</Filename>" were illegal in
2872 the 8.3 DOS filesystem, but that restriction should have
2873 been lifted by now (i.e., you're using VFAT or later filesystems.) If
2874 you're still having problems creating it, don't worry; <Filename>.cvsrc</Filename> is entirely
2881 Try doing <Command>cvs co fpconfig</Command>. All being well, bytes should
2882 start to trickle through, leaving a directory <Filename>fptools</Filename>
2883 in your current directory. (You can <Command>rm</Command> it if you don't want to keep it.) The following messages appear to be harmless:
2887 setsockopt IPTOS_LOWDELAY: Invalid argument
2888 setsockopt IPTOS_THROUGHPUT: Invalid argument
2892 At this point I found that CVS tried to invoke a little dialogue with
2893 me (along the lines of `do you want to talk to this host'), but
2894 somehow bombed out. This was from a bash shell running in emacs.
2895 I solved this by invoking a Cygnus shell, and running CVS from there.
2896 Once things are dialogue free, it seems to work OK from within emacs.
2902 If you want to check out part of large tree, proceed as follows:
2906 cvs -f checkout -l papers
2912 This sequence checks out the <Literal>papers</Literal> module, but none
2913 of its sub-directories.
2914 The "<Option>-l</Option>" flag says not to check out sub-directories.
2915 The "<Option>-f</Option>" flag says not to read the <Filename>.cvsrc</Filename> file
2916 whose <Option>-P</Option> default (don't check out empty directories) is
2921 The <Command>cvs update</Command> command sucks in a named sub-directory.
2928 There is a very nice graphical front-end to CVS for Win32 platforms,
2929 with a UI that people will be familiar with, at
2930 <ULink URL="http://www.wincvs.org/">wincvs.org</ULink>.
2931 I have not tried it yet.
2937 <Sect2><Title>Installing autoconf</Title>
2940 Only required if you are doing builds from GHC's sources
2941 checked out from the CVS tree.
2947 Fetch the (standard, Unix) <Command>autoconf</Command> distribution from
2948 <ULink URL="ftp://ftp.gnu.org/gnu/autoconf">ftp.gnu.org</ULink>.
2953 Unpack it into an arbitrary directory.
2958 Make sure that the directory <Filename>/usr/local/bin</Filename> exists.
2963 Say "<Filename>./configure</Filename>".
2968 Now <Command>make install</Command>. This should put <Filename>autoheader</Filename>
2969 and <Filename>autoconf</Filename> in <Filename>/usr/local/bin</Filename>.
2975 <Command>autoheader</Command> doesn't seem to work, but you don't need it
2982 <Sect2><Title>Building GHC</Title>
2988 In the <Filename>./configure</Filename> output, ignore
2990 checking whether #! works in shell scripts...
2991 ./configure: ./conftest: No such file or directory</Literal>",
2992 and "<Literal>not updating unwritable cache ./config.cache</Literal>".
2993 Nobody knows why these happen, but they seem to be harmless.
2999 You have to run <Command>autoconf</Command> both in <Filename>fptools</Filename>
3000 and in <Filename>fptools/ghc</Filename>. If you omit the latter step you'll
3001 get an error when you run <Filename>./configure</Filename>:
3006 creating mk/config.h
3007 mk/config.h is unchanged
3009 running /bin/sh ./configure --cache-file=.././config.cache --srcdir=.
3010 ./configure: ./configure: No such file or directory
3011 configure: error: ./configure failed for ghc
3017 You need <Filename>ghc</Filename> to be in your <Constant>PATH</Constant> before you run
3018 <Command>configure</Command>. The default GHC InstallShield creates only
3019 <Filename>ghc-4.05</Filename>, so you may need to duplicate this file as <Filename>ghc</Filename>
3020 in the same directory, in order that <Command>configure</Command> will see it (or
3021 just rename <Filename>ghc-4.05</Filename> to <Filename>ghc</Filename>.
3022 And make sure that the directory is in your path.
3028 Compile <Command>happy</Command> and <Command>ghc</Command>
3029 with <Option>-static</Option>. To do this, set
3038 in your <Filename>build.mk</Filename> file.
3039 [Actually, I successfully compiled Happy without <Option>-static</Option> on Win2k, but not GHC.]
projects / ghc-hetmet.git / blob