1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 <Article id="building-guide">
7 <Title>Building the Glasgow Functional Programming Tools Suite</Title>
8 <Author><OtherName>The GHC Team</OtherName></Author>
9 <Address><Email>glasgow-haskell-{users,bugs}@haskell.org</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
54 <Literal>fptools</Literal> suite then the easiest thing to do is to
55 get a binary distribution. In the binary distribution everything is
56 pre-compiled for your particular machine architecture and operating
57 system, so all you should have to do is install the binaries and
58 libraries in suitable places. The user guide describes how to do this.
62 A binary distribution may not work for you for two reasons. First, we
63 may not have built the suite for the particular architecture/OS
64 platform you want. That may be due to lack of time and energy (in
65 which case you can get a source distribution and build from it; see
66 below). Alternatively, it may be because we haven't yet ported the
67 suite to your architecture, in which case you are considerably worse
72 The second reason a binary distribution may not be what you want is
73 if you want to read or modify the souce code.
75 </ListItem></VarListEntry>
77 <Term><IndexTerm><Primary>Source distribution</Primary></IndexTerm>Source distribution.</Term>
81 platform, but (a) you like the warm fuzzy feeling of compiling things
82 yourself; (b) you want to build something ``extra''—e.g., a set of
83 libraries with strictness-analysis turned off; or (c) you want to hack
88 A source distribution contains complete sources for one or more
89 projects in the <Literal>fptools</Literal> suite. Not only that, but
90 the more awkward machine-independent steps are done for you. For
91 example, if you don't have
92 <Command>happy</Command><IndexTerm><Primary>happy</Primary></IndexTerm>
93 you'll find it convenient that the source distribution contains the
94 result of running <Command>happy</Command> on the parser
95 specifications. If you don't want to alter the parser then this saves
96 you having to find and install <Command>happy</Command>. You will
97 still need a working version of GHC (preferably version 4.08+) on your
98 machine in order to compile (most of) the sources, however.
101 </ListItem></VarListEntry>
103 <Term>Build GHC from intermediate C <Filename>.hc</Filename> files<IndexTerm><Primary>hc files</Primary></IndexTerm>:</Term>
107 need a working GHC to use a source distribution. What if you don't
108 have a working GHC? Then you have no choice but to ``bootstrap'' up
109 from the intermediate C (<Filename>.hc</Filename>) files that we provide. Building GHC
110 on an unsupported platform falls into this category. Please see
111 <Xref LinkEnd="sec-booting-from-C">.
115 Once you have built GHC, you can build the other Glasgow tools with
120 In theory, you can (could?) build GHC with another Haskell compiler
121 (e.g., HBC). We haven't tried to do this for ages and it almost
122 certainly doesn't work any more (for tedious reasons).
124 </ListItem></VarListEntry>
126 <Term>The CVS repository.</Term>
129 We make releases infrequently. If you want more up-to-the minute (but
130 less tested) source code then you need to get access to our CVS
134 <para>All the <Literal>fptools</Literal> source code is held in a CVS
135 repository. CVS is a pretty good source-code control system, and best
136 of all it works over the network.</para>
138 <para>The repository holds source code only. It holds no mechanically
139 generated files at all. So if you check out a source tree from CVS
140 you will need to install every utility so that you can build all the
141 derived files from scratch.</para>
143 <para>More information about our CVS repository is available in the
144 <ULink URL="http://www.haskell.org/ghc/cvs-cheat-sheet.html">fptools
145 CVS Cheat Sheet</ULink>.</para>
147 </ListItem></VarListEntry>
151 <para>If you are going to do any building from sources (either from a
152 source distribution or the CVS repository) then you need to read all
153 of this manual in detail.</para>
157 <Sect1 id="sec-build-checks">
158 <Title>Things to check before you start</Title>
161 Here's a list of things to check before you get started.
167 <IndexTerm><Primary>Disk space needed</Primary></IndexTerm>
168 Disk space needed: About 40MB (one tenth of one hamburger's worth) of disk
169 space for the most basic binary distribution of GHC; more for some
170 platforms, e.g., Alphas. An extra ``bundle'' (e.g., concurrent Haskell
171 libraries) might take you to up to one fifth of a hamburger. You'll need
172 over 100MB (say, one fifth a hamburger's worth) if you need to build the
173 basic stuff from scratch. All of the above are
174 <Emphasis>estimates</Emphasis> of disk-space needs. (Note: our benchmark hamburger is a standard Double Whopper with Cheese, with an RRP of UKP2.99.)
180 Use an appropriate machine, compilers, and things. SPARC boxes, and
181 PCs running Linux, BSD (any variant), or Solaris are all fully
182 supported. Win32 and HP boxes are in pretty good shape. DEC Alphas
183 running OSF/1, Linux or some BSD variant, MIPS and AIX boxes will need
184 some minimal porting effort before they work (as of 4.06). <Xref
185 LinkEnd="sec-port-info"> gives the full run-down on ports or lack
192 Be sure that the ``pre-supposed'' utilities are installed.
193 <Xref LinkEnd="sec-pre-supposed"> elaborates.
200 If you have any problem when building or installing the Glasgow
201 tools, please check the ``known pitfalls'' (<Xref
202 LinkEnd="sec-build-pitfalls">). Also check the FAQ for the version
203 you're building, which should be available from the relevant download
204 page on the <ULink URL="http://www.haskell.org/ghc/" >GHC web
207 <IndexTerm><Primary>known bugs</Primary></IndexTerm>
208 <IndexTerm><Primary>bugs, known</Primary></IndexTerm>
210 If you feel there is still some shortcoming in our procedure or
211 instructions, please report it.
213 For GHC, please see the bug-reporting section of the GHC Users' Guide
214 (separate document), to maximise the usefulness of your report.
215 <IndexTerm><Primary>bugs, reporting</Primary></IndexTerm>
217 If in doubt, please send a message to
218 <Email>glasgow-haskell-bugs@haskell.org</Email>.
219 <IndexTerm><Primary>bugs, mailing list</Primary></IndexTerm>
229 <Sect1 id="sec-port-info">
230 <Title>What machines the Glasgow tools run on
234 <IndexTerm><Primary>ports, GHC</Primary></IndexTerm>
235 <IndexTerm><Primary>GHC ports</Primary></IndexTerm>
236 <IndexTerm><Primary>supported platforms</Primary></IndexTerm>
237 <IndexTerm><Primary>platforms, supported</Primary></IndexTerm>
238 The main question is whether or not the Haskell compiler (GHC) runs on
243 A ``platform'' is a architecture/manufacturer/operating-system
244 combination, such as <Literal>sparc-sun-solaris2</Literal>. Other common ones are
245 <Literal>alpha-dec-osf2</Literal>, <Literal>hppa1.1-hp-hpux9</Literal>, <Literal>i386-unknown-linux</Literal>,
246 <Literal>i386-unknown-solaris2</Literal>, <Literal>i386-unknown-freebsd</Literal>,
247 <Literal>i386-unknown-cygwin32</Literal>, <Literal>m68k-sun-sunos4</Literal>, <Literal>mips-sgi-irix5</Literal>,
248 <Literal>sparc-sun-sunos4</Literal>, <Literal>sparc-sun-solaris2</Literal>, <Literal>powerpc-ibm-aix</Literal>.
252 Bear in mind that certain ``bundles'', e.g. parallel Haskell, may not
253 work on all machines for which basic Haskell compiling is supported.
257 Some libraries may only work on a limited number of platforms; for
258 example, a sockets library is of no use unless the operating system
259 supports the underlying BSDisms.
263 <Title>What platforms the Haskell compiler (GHC) runs on</Title>
266 <IndexTerm><Primary>fully-supported platforms</Primary></IndexTerm>
267 <IndexTerm><Primary>native-code generator</Primary></IndexTerm>
268 <IndexTerm><Primary>registerised ports</Primary></IndexTerm>
269 <IndexTerm><Primary>unregisterised ports</Primary></IndexTerm>
270 The GHC hierarchy of Porting Goodness: (a) Best is a native-code
271 generator; (b) next best is a ``registerised''
272 port; (c) the bare minimum is an ``unregisterised'' port.
273 (``Unregisterised'' is so terrible that we won't say more about it).
277 We use Sparcs running Solaris 2.7 and x86 boxes running FreeBSD and
278 Linux, so those are the best supported platforms, unsurprisingly.
282 Here's everything that's known about GHC ports. We identify platforms
283 by their ``canonical'' CPU/Manufacturer/OS triple.
290 <Term>alpha-dec-{osf,linux,freebsd,openbsd,netbsd}:</Term>
291 <IndexTerm><Primary>alpha-dec-osf</Primary></IndexTerm>
292 <IndexTerm><Primary>alpha-dec-linux</Primary></IndexTerm>
293 <IndexTerm><Primary>alpha-dec-freebsd</Primary></IndexTerm>
294 <IndexTerm><Primary>alpha-dec-openbsd</Primary></IndexTerm>
295 <IndexTerm><Primary>alpha-dec-netbsd</Primary></IndexTerm>
299 Currently non-working. The last working version (osf[1-3]) is GHC
300 3.02. A small amount of porting effort will be required to get Alpha
301 support into GHC 4.xx, but we don't have easy access to machines right
302 now, and there hasn't been a massive demand for support, so Alphas
303 remain unsupported for the time being. Please get in touch if you
304 either need Alpha support and/or can provide access to boxes.
307 </ListItem></VarListEntry>
309 <Term>sparc-sun-sunos4:</Term>
310 <IndexTerm><Primary>sparc-sun-sunos4</Primary></IndexTerm>
314 Probably works with minor tweaks, hasn't been tested for a while.
317 </ListItem></VarListEntry>
319 <Term>sparc-sun-solaris2:</Term>
320 <IndexTerm><Primary>sparc-sun-solaris2</Primary></IndexTerm>
324 Fully supported, including native-code generator.
327 </ListItem></VarListEntry>
329 <Term>hppa1.1-hp-hpux (HP-PA boxes running HPUX 9.x)</Term>
330 <IndexTerm><Primary>hppa1.1-hp-hpux</Primary></IndexTerm>
334 Works registerised. No native-code generator.
337 </ListItem></VarListEntry>
339 <Term>i386-unknown-linux (PCs running Linux—ELF binary format):</Term>
340 <IndexTerm><Primary>i386-*-linux</Primary></IndexTerm>
343 <para>GHC works registerised and has a native code generator. You
344 <Emphasis>must</Emphasis> have GCC 2.7.x or later. NOTE about
345 <literal>glibc</literal> versions: GHC binaries built on a system
346 running <literal>glibc 2.0</literal> won't work on a system running
347 <literal>glibc 2.1</literal>, and vice versa. In general, don't
348 expect compatibility between <literal>glibc</literal> versions, even
349 if the shared library version hasn't changed.
352 </ListItem></VarListEntry>
354 <Term>i386-unknown-{freebsd,netbsd,openbsd) (PCs running FreeBSD 2.2
355 or higher, NetBSD, and possibly OpenBSD):</Term>
356 <IndexTerm><Primary>i386-unknown-freebsd</Primary></IndexTerm>
357 <IndexTerm><Primary>i386-unknown-netbsd</Primary></IndexTerm>
358 <IndexTerm><Primary>i386-unknown-openbsd</Primary></IndexTerm>
362 GHC works registerised. These systems provide ready-built packages of
363 GHC, so if you just need binaries you're better off just installing
367 </ListItem></VarListEntry>
369 <Term>i386-unknown-cygwin32:</Term>
370 <IndexTerm><Primary>i386-unknown-cygwin32</Primary></IndexTerm>
374 Fully supported under Win9x/NT, including a native code
375 generator. Requires the <Literal>cygwin32</Literal> compatibility
376 library and a healthy collection of GNU tools (i.e., gcc, GNU ld, bash
380 </ListItem></VarListEntry>
382 <Term>mips-sgi-irix5:</Term>
383 <IndexTerm><Primary>mips-sgi-irix[5-6]</Primary></IndexTerm>
387 Port currently doesn't work, needs some minimal porting effort. As
388 usual, we don't have access to machines and there hasn't been an
389 overwhelming demand for this port, but feel free to get in touch.
391 </ListItem></VarListEntry>
394 <Term>powerpc-ibm-aix:</Term>
397 <IndexTerm><Primary>powerpc-ibm-aix</Primary></IndexTerm>
398 Port currently doesn't work, needs some minimal porting effort. As
399 usual, we don't have access to machines and there hasn't been an
400 overwhelming demand for this port, but feel free to get in touch.
402 </ListItem></VarListEntry>
408 Various other systems have had GHC ported to them in the distant past,
409 including various Motorola 68k boxes. The 68k support still remains,
410 but porting to one of these systems will certainly be a non-trivial
417 <Title>What machines the other tools run on</Title>
420 Unless you hear otherwise, the other tools work if GHC works.
428 <Sect1 id="sec-pre-supposed">
429 <Title>Installing pre-supposed utilities
431 <IndexTerm><Primary>pre-supposed utilities</Primary></IndexTerm>
432 <IndexTerm><Primary>utilities, pre-supposed</Primary></IndexTerm></Title>
435 Here are the gory details about some utility programs you may need;
436 <Command>perl</Command>, <Command>gcc</Command> and
437 <command>happy</command> are the only important
438 ones. (PVM<IndexTerm><Primary>PVM</Primary></IndexTerm> is important
439 if you're going for Parallel Haskell.) The
440 <Command>configure</Command><IndexTerm><Primary>configure</Primary></IndexTerm>
441 script will tell you if you are missing something.
449 <IndexTerm><Primary>pre-supposed: Perl</Primary></IndexTerm>
450 <IndexTerm><Primary>Perl, pre-supposed</Primary></IndexTerm>
453 <Emphasis>You have to have Perl to proceed!</Emphasis>
454 It is pretty easy to install.
458 Perl 5 is required. For Win32 platforms, you should use the binary
459 supplied in the InstallShield (copy it to <filename>/bin</filename>).
460 The Cygwin-supplied Perl seems not to work.
464 Perl should be put somewhere so that it can be invoked by the
465 <Literal>#!</Literal> script-invoking mechanism. The full
466 pathname may need to be less than 32 characters long on some
470 </ListItem></VarListEntry>
472 <Term>GNU C (<Command>gcc</Command>):</Term>
473 <IndexTerm><Primary>pre-supposed: GCC (GNU C compiler)</Primary></IndexTerm>
474 <IndexTerm><Primary>GCC (GNU C compiler), pre-supposed</Primary></IndexTerm>
478 We recommend using GCC version 2.95.2 on all platforms. Failing that,
479 version 2.7.2 is stable on most platforms. Earlier versions of GCC
480 can be assumed not to work, and versions in between 2.7.2 and 2.95.2
481 (including <command>egcs</command>) have varying degrees of stability
482 depending on the platform.
486 If your GCC dies with ``internal error'' on some GHC source file,
487 please let us know, so we can report it and get things improved.
488 (Exception: on iX86 boxes—you may need to fiddle with GHC's
489 <Option>-monly-N-regs</Option> option; see the User's Guide)
491 </ListItem></VarListEntry>
495 <indexterm><primary>Happy</primary></indexterm>
497 <para>Happy is a parser generator tool for Haskell, and is used to
498 generate GHC's parsers. Happy is written in Haskell, and is a project
499 in the CVS repository (<literal>fptools/happy</literal>). It can be
500 built from source, but bear in mind that you'll need GHC installed in
501 order to build it. To avoid the chicken/egg problem, install a binary
502 distribtion of either Happy or GHC to get started. Happy
503 distributions are available from <ulink
504 url="http://www.haskell.org/happy/">Happy's Web Page</ulink>.
510 <Term>Autoconf:</Term>
511 <IndexTerm><Primary>pre-supposed: Autoconf</Primary></IndexTerm>
512 <IndexTerm><Primary>Autoconf, pre-supposed</Primary></IndexTerm>
515 GNU Autoconf is needed if you intend to build from the CVS sources, it
516 is <Emphasis>not</Emphasis> needed if you just intend to build a
517 standard source distribution.
521 Autoconf builds the <Command>configure</Command> script from
522 <Filename>configure.in</Filename> and <Filename>aclocal.m4</Filename>.
523 If you modify either of these files, you'll need
524 <command>autoconf</command> to rebuild <Filename>configure</Filename>.
527 </ListItem></VarListEntry>
529 <Term><Command>sed</Command></Term>
530 <IndexTerm><Primary>pre-supposed: sed</Primary></IndexTerm>
531 <IndexTerm><Primary>sed, pre-supposed</Primary></IndexTerm>
534 You need a working <Command>sed</Command> if you are going to build
535 from sources. The build-configuration stuff needs it. GNU sed
536 version 2.0.4 is no good! It has a bug in it that is tickled by the
537 build-configuration. 2.0.5 is OK. Others are probably OK too
538 (assuming we don't create too elaborate configure scripts.)
540 </ListItem></VarListEntry>
545 One <Literal>fptools</Literal> project is worth a quick note at this
546 point, because it is useful for all the others:
547 <Literal>glafp-utils</Literal> contains several utilities which aren't
548 particularly Glasgow-ish, but Occasionally Indispensable. Like
549 <Command>lndir</Command> for creating symbolic link trees.
552 <Sect2 id="pre-supposed-gph-tools">
553 <Title>Tools for building parallel GHC (GPH)
560 <Term>PVM version 3:</Term>
561 <IndexTerm><Primary>pre-supposed: PVM3 (Parallel Virtual Machine)</Primary></IndexTerm>
562 <IndexTerm><Primary>PVM3 (Parallel Virtual Machine), pre-supposed</Primary></IndexTerm>
566 PVM is the Parallel Virtual Machine on which Parallel Haskell programs
567 run. (You only need this if you plan to run Parallel Haskell.
568 Concurent Haskell, which runs concurrent threads on a uniprocessor
569 doesn't need it.) Underneath PVM, you can have (for example) a
570 network of workstations (slow) or a multiprocessor box (faster).
574 The current version of PVM is 3.3.11; we use 3.3.7. It is readily
575 available on the net; I think I got it from
576 <Literal>research.att.com</Literal>, in <Filename>netlib</Filename>.
580 A PVM installation is slightly quirky, but easy to do. Just follow
581 the <Filename>Readme</Filename> instructions.
583 </ListItem></VarListEntry>
585 <Term><Command>bash</Command>:</Term>
586 <IndexTerm><Primary>bash, presupposed (Parallel Haskell only)</Primary></IndexTerm>
589 Sadly, the <Command>gr2ps</Command> script, used to convert ``parallelism profiles''
590 to PostScript, is written in Bash (GNU's Bourne Again shell).
591 This bug will be fixed (someday).
593 </ListItem></VarListEntry>
599 <Sect2 id="pre-supposed-doc-tools">
600 <Title>Tools for building the Documentation
604 The following additional tools are required if you want to format the
605 documentation that comes with the <Literal>fptools</Literal> projects:
612 <Term>DocBook:</Term>
613 <IndexTerm><Primary>pre-supposed: DocBook</Primary></IndexTerm>
614 <IndexTerm><Primary>DocBook, pre-supposed</Primary></IndexTerm>
617 All our documentation is written in SGML, using the DocBook DTD.
618 Instructions on installing and configuring the DocBook tools are in the
619 installation guide (in the GHC user guide).
622 </ListItem></VarListEntry>
625 <IndexTerm><Primary>pre-supposed: TeX</Primary></IndexTerm>
626 <IndexTerm><Primary>TeX, pre-supposed</Primary></IndexTerm>
629 A decent TeX distribution is required if you want to produce printable
630 documentation. We recomment teTeX, which includes just about
633 </ListItem></VarListEntry>
638 In order to actually build any documentation, you need to set
639 <constant>SGMLDocWays</constant> in your
640 <filename>build.mk</filename>. Valid values to add to this
641 list are: <literal>dvi</literal>, <literal>ps</literal>,
642 <literal>pdf</literal>, <literal>html</literal>, and
643 <literal>rtf</literal>.
648 <Sect2 id="pre-supposed-other-tools">
649 <Title>Other useful tools
655 <IndexTerm><Primary>pre-supposed: flex</Primary></IndexTerm>
656 <IndexTerm><Primary>flex, pre-supposed</Primary></IndexTerm>
660 This is a quite-a-bit-better-than-Lex lexer. Used to build a couple
661 of utilities in <Literal>glafp-utils</Literal>. Depending on your
662 operating system, the supplied <Command>lex</Command> may or may not
663 work; you should get the GNU version.
665 </ListItem></VarListEntry>
672 <Sect1 id="sec-building-from-source">
673 <Title>Building from source
675 <IndexTerm><Primary>Building from source</Primary></IndexTerm>
676 <IndexTerm><Primary>Source, building from</Primary></IndexTerm></Title>
679 You've been rash enough to want to build some of
680 the Glasgow Functional Programming tools (GHC, Happy,
681 nofib, etc.) from source. You've slurped the source,
682 from the CVS repository or from a source distribution, and
683 now you're sitting looking at a huge mound of bits, wondering
688 Gingerly, you type <Command>make</Command>. Wrong already!
692 This rest of this guide is intended for duffers like me, who aren't
693 really interested in Makefiles and systems configurations, but who
694 need a mental model of the interlocking pieces so that they can make
695 them work, extend them consistently when adding new software, and lay
696 hands on them gently when they don't work.
699 <Sect2 id="sec-source-tree">
700 <Title>Your source tree
704 The source code is held in your <Emphasis>source tree</Emphasis>.
705 The root directory of your source tree <Emphasis>must</Emphasis>
706 contain the following directories and files:
715 <Filename>Makefile</Filename>: the root Makefile.
721 <Filename>mk/</Filename>: the directory that contains the
722 main Makefile code, shared by all the
723 <Literal>fptools</Literal> software.
729 <Filename>configure.in</Filename>, <Filename>config.sub</Filename>, <Filename>config.guess</Filename>:
730 these files support the configuration process.
736 <Filename>install-sh</Filename>.
745 All the other directories are individual <Emphasis>projects</Emphasis> of the
746 <Literal>fptools</Literal> system—for example, the Glasgow Haskell Compiler
747 (<Literal>ghc</Literal>), the Happy parser generator (<Literal>happy</Literal>), the <Literal>nofib</Literal> benchmark
748 suite, and so on. You can have zero or more of these. Needless to
749 say, some of them are needed to build others.
753 The important thing to remember is that even if you want only one
754 project (<Literal>happy</Literal>, say), you must have a source tree whose root
755 directory contains <Filename>Makefile</Filename>, <Filename>mk/</Filename>, <Filename>configure.in</Filename>, and the
756 project(s) you want (<Filename>happy/</Filename> in this case). You cannot get by with
757 just the <Filename>happy/</Filename> directory.
764 <IndexTerm><Primary>build trees</Primary></IndexTerm>
765 <IndexTerm><Primary>link trees, for building</Primary></IndexTerm></Title>
768 While you can build a system in the source tree, we don't recommend it.
769 We often want to build multiple versions of our software
770 for different architectures, or with different options (e.g. profiling).
771 It's very desirable to share a single copy of the source code among
776 So for every source tree we have zero or more <Emphasis>build trees</Emphasis>. Each
777 build tree is initially an exact copy of the source tree, except that
778 each file is a symbolic link to the source file, rather than being a
779 copy of the source file. There are ``standard'' Unix utilities that
780 make such copies, so standard that they go by different names:
781 <Command>lndir</Command><IndexTerm><Primary>lndir</Primary></IndexTerm>, <Command>mkshadowdir</Command><IndexTerm><Primary>mkshadowdir</Primary></IndexTerm> are two (If you
782 don't have either, the source distribution includes sources for the
783 X11 <Command>lndir</Command>—check out <Filename>fptools/glafp-utils/lndir</Filename>). See <Xref LinkEnd="sec-storysofar"> for a typical invocation.
787 The build tree does not need to be anywhere near the source tree in
788 the file system. Indeed, one advantage of separating the build tree
789 from the source is that the build tree can be placed in a
790 non-backed-up partition, saving your systems support people from
791 backing up untold megabytes of easily-regenerated, and
792 rapidly-changing, gubbins. The golden rule is that (with a single
793 exception—<XRef LinkEnd="sec-build-config">)
794 <Emphasis>absolutely everything in the build tree is either a symbolic
795 link to the source tree, or else is mechanically generated</Emphasis>.
796 It should be perfectly OK for your build tree to vanish overnight; an
797 hour or two compiling and you're on the road again.
801 You need to be a bit careful, though, that any new files you create
802 (if you do any development work) are in the source tree, not a build tree!
806 Remember, that the source files in the build tree are <Emphasis>symbolic
807 links</Emphasis> to the files in the source tree. (The build tree soon
808 accumulates lots of built files like <Filename>Foo.o</Filename>, as well.) You
809 can <Emphasis>delete</Emphasis> a source file from the build tree without affecting
810 the source tree (though it's an odd thing to do). On the other hand,
811 if you <Emphasis>edit</Emphasis> a source file from the build tree, you'll edit the
812 source-tree file directly. (You can set up Emacs so that if you edit
813 a source file from the build tree, Emacs will silently create an
814 edited copy of the source file in the build tree, leaving the source
815 file unchanged; but the danger is that you think you've edited the
816 source file whereas actually all you've done is edit the build-tree
817 copy. More commonly you do want to edit the source file.)
821 Like the source tree, the top level of your build tree must be (a
822 linked copy of) the root directory of the <Literal>fptools</Literal> suite. Inside
823 Makefiles, the root of your build tree is called
824 <Constant>$(FPTOOLS_TOP)</Constant><IndexTerm><Primary>FPTOOLS_TOP</Primary></IndexTerm>. In the rest of this document path
825 names are relative to <Constant>$(FPTOOLS_TOP)</Constant> unless otherwise stated. For
826 example, the file <Filename>ghc/mk/target.mk</Filename> is actually
827 <Filename><Constant>$(FPTOOLS_TOP)</Constant>/ghc/mk/target.mk</Filename>.
832 <Sect2 id="sec-build-config">
833 <Title>Getting the build you want
837 When you build <Literal>fptools</Literal> you will be compiling code on a particular
838 <Emphasis>host platform</Emphasis>, to run on a particular <Emphasis>target platform</Emphasis>
839 (usually the same as the host platform)<IndexTerm><Primary>platform</Primary></IndexTerm>. The
840 difficulty is that there are minor differences between different
841 platforms; minor, but enough that the code needs to be a bit different
842 for each. There are some big differences too: for a different
843 architecture we need to build GHC with a different native-code
848 There are also knobs you can turn to control how the <Literal>fptools</Literal>
849 software is built. For example, you might want to build GHC optimised
850 (so that it runs fast) or unoptimised (so that you can compile it fast
851 after you've modified it. Or, you might want to compile it with
852 debugging on (so that extra consistency-checking code gets included)
857 All of this stuff is called the <Emphasis>configuration</Emphasis> of your build.
858 You set the configuration using a three-step process.
862 <Term>Step 1: get ready for configuration.</Term>
864 <para>Change directory to
865 <Constant>$(FPTOOLS_TOP)</Constant> and
867 <Command>autoconf</Command><IndexTerm><Primary>autoconf</Primary></IndexTerm>
868 (with no arguments). This GNU program converts
869 <Filename><Constant>$(FPTOOLS_TOP)</Constant>/configure.in</Filename>
870 to a shell script called
871 <Filename><Constant>$(FPTOOLS_TOP)</Constant>/configure</Filename>.
874 <para>Some projects, including GHC, have their own
875 configure script. If there's an
876 <Constant>$(FPTOOLS_TOP)/<project>/configure.in</Constant>,
877 then you need to run <command>autoconf</command> in that
878 directory too.</para>
880 <para>Both these steps are completely
881 platform-independent; they just mean that the
882 human-written file (<Filename>configure.in</Filename>)
883 can be short, although the resulting shell script,
884 <Command>configure</Command>, and
885 <Filename>mk/config.h.in</Filename>, are long.</para>
887 <para>In case you don't have <Command>autoconf</Command>
888 we distribute the results, <Command>configure</Command>,
889 and <Filename>mk/config.h.in</Filename>, with the source
890 distribution. They aren't kept in the repository,
896 <term>Step 2: system configuration.</term>
898 <para>Runs the newly-created
899 <Command>configure</Command> script, thus:</para>
902 ./configure <optional><parameter>args</parameter></optional>
905 <para><Command>configure</Command>'s mission is to
906 scurry round your computer working out what architecture
907 it has, what operating system, whether it has the
908 <Function>vfork</Function> system call, where
909 <Command>yacc</Command> is kept, whether
910 <Command>gcc</Command> is available, where various
911 obscure <Literal>#include</Literal> files are,
912 whether it's a leap year, and what the systems manager
913 had for lunch. It communicates these snippets of
914 information in two ways:</para>
920 <Filename>mk/config.mk.in</Filename><IndexTerm><Primary>config.mk.in</Primary></IndexTerm>
922 <Filename>mk/config.mk</Filename><IndexTerm><Primary>config.mk</Primary></IndexTerm>,
923 substituting for things between
924 ``<Literal>@</Literal>'' brackets. So,
925 ``<Literal>@HaveGcc@</Literal>'' will be replaced by
926 ``<Literal>YES</Literal>'' or
927 ``<Literal>NO</Literal>'' depending on what
928 <Command>configure</Command> finds.
929 <Filename>mk/config.mk</Filename> is included by
930 every Makefile (directly or indirectly), so the
931 configuration information is thereby communicated to
932 all Makefiles.</para>
937 <Filename>mk/config.h.in</Filename><IndexTerm><Primary>config.h.in</Primary></IndexTerm>
939 <Filename>mk/config.h</Filename><IndexTerm><Primary>config.h</Primary></IndexTerm>.
940 The latter is <Literal>#include</Literal>d by
941 various C programs, which can thereby make use of
942 configuration information.</para>
946 <para><command>configure</command> takes some optional
947 arguments. Use <literal>./configure --help</literal> to
948 get a list of the available arguments. Here are some of
949 the ones you might need:</para>
953 <term><literal>--with-ghc=<parameter>path</parameter></literal></term>
954 <indexterm><primary><literal>--with-ghc</literal></primary>
957 <para>Specifies the path to an installed GHC which
958 you would like to use. This compiler will be used
959 for compiling GHC-specific code (eg. GHC itself).
960 This option <emphasis>cannot</emphasis> be
961 specified using <filename>build.mk</filename> (see
962 later), because <command>configure</command> needs
963 to auto-detect the version of GHC you're using.
964 The default is to look for a compiler named
965 <literal>ghc</literal> in your path.</para>
970 <term><literal>--with-hc=<parameter>path</parameter></literal></term>
971 <indexterm><primary><literal>--with-hc</literal></primary>
974 <para>Specifies the path to any installed Haskell
975 compiler. This compiler will be used for
976 compiling generic Haskell code. The default is to
977 use <literal>ghc</literal>.</para>
982 <term><literal>--with-gcc=<parameter>path</parameter></literal></term>
983 <indexterm><primary><literal>--with-gcc</literal></primary>
986 <para>Specifies the path to the installed
987 GCC. This compiler will be used to compile all C
988 files, <emphasis>except</emphasis> any generated
989 by the installed Haskell compiler, which will have
990 its own idea of which C compiler (if any) to use.
991 The default is to use <literal>gcc</literal>.</para>
996 <para><command>configure</command> caches the results of
997 its run in <Filename>config.cache</Filename>. Quite
998 often you don't want that; you're running
999 <Command>configure</Command> a second time because
1000 something has changed. In that case, simply delete
1001 <Filename>config.cache</Filename>.</para>
1006 <Term>Step 3: build configuration.</Term>
1009 Next, you say how this build of <Literal>fptools</Literal> is to differ from the
1010 standard defaults by creating a new file <Filename>mk/build.mk</Filename><IndexTerm><Primary>build.mk</Primary></IndexTerm>
1011 <Emphasis>in the build tree</Emphasis>. This file is the one and only file you edit
1012 in the build tree, precisely because it says how this build differs
1013 from the source. (Just in case your build tree does die, you might
1014 want to keep a private directory of <Filename>build.mk</Filename> files, and use a
1015 symbolic link in each build tree to point to the appropriate one.) So
1016 <Filename>mk/build.mk</Filename> never exists in the source tree—you create one in
1017 each build tree from the template. We'll discuss what to put in it
1020 </ListItem></VarListEntry>
1025 And that's it for configuration. Simple, eh?
1028 <para>What do you put in your build-specific configuration file
1029 <filename>mk/build.mk</filename>? <Emphasis>For almost all
1030 purposes all you will do is put make variable definitions that
1031 override those in</Emphasis>
1032 <filename>mk/config.mk.in</filename>. The whole point of
1033 <filename>mk/config.mk.in</filename>—and its derived
1034 counterpart <filename>mk/config.mk</filename>—is to define
1035 the build configuration. It is heavily commented, as you will
1036 see if you look at it. So generally, what you do is look at
1037 <filename>mk/config.mk.in</filename>, and add definitions in
1038 <filename>mk/build.mk</filename> that override any of the
1039 <filename>config.mk</filename> definitions that you want to
1040 change. (The override occurs because the main boilerplate file,
1041 <filename>mk/boilerplate.mk</filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm>,
1042 includes <filename>build.mk</filename> after
1043 <filename>config.mk</filename>.)</para>
1045 <para>For example, <filename>config.mk.in</filename> contains
1046 the definition:</para>
1049 GhcHcOpts=-O -Rghc-timing
1052 <para>The accompanying comment explains that this is the list of
1053 flags passed to GHC when building GHC itself. For doing
1054 development, it is wise to add <literal>-DDEBUG</literal>, to
1055 enable debugging code. So you would add the following to
1056 <filename>build.mk</filename>:</para>
1058 <para>or, if you prefer,</para>
1061 GhcHcOpts += -DDEBUG
1064 <para>GNU <Command>make</Command> allows existing definitions to
1065 have new text appended using the ``<Literal>+=</Literal>''
1066 operator, which is quite a convenient feature.)</para>
1068 <para>If you want to remove the <literal>-O</literal> as well (a
1069 good idea when developing, because the turn-around cycle gets a
1070 lot quicker), you can just override
1071 <literal>GhcLibHcOpts</literal> altogether:</para>
1074 GhcHcOpts=-DDEBUG -Rghc-timing
1077 <para>When reading <filename>config.mk.in</filename>, remember
1078 that anything between ``@...@'' signs is going to be substituted
1079 by <Command>configure</Command> later. You
1080 <Emphasis>can</Emphasis> override the resulting definition if
1081 you want, but you need to be a bit surer what you are doing.
1082 For example, there's a line that says:</para>
1088 <para>This defines the Make variables <Constant>YACC</Constant>
1089 to the pathname for a <Command>yacc</Command> that
1090 <Command>configure</Command> finds somewhere. If you have your
1091 own pet <Command>yacc</Command> you want to use instead, that's
1092 fine. Just add this line to <filename>mk/build.mk</filename>:</para>
1098 <para>You do not <Emphasis>have</Emphasis> to have a
1099 <filename>mk/build.mk</filename> file at all; if you don't,
1100 you'll get all the default settings from
1101 <filename>mk/config.mk.in</filename>.</para>
1103 <para>You can also use <filename>build.mk</filename> to override
1104 anything that <Command>configure</Command> got wrong. One place
1105 where this happens often is with the definition of
1106 <Constant>FPTOOLS_TOP_ABS</Constant>: this
1107 variable is supposed to be the canonical path to the top of your
1108 source tree, but if your system uses an automounter then the
1109 correct directory is hard to find automatically. If you find
1110 that <Command>configure</Command> has got it wrong, just put the
1111 correct definition in <filename>build.mk</filename>.</para>
1115 <Sect2 id="sec-storysofar">
1116 <Title>The story so far</Title>
1119 Let's summarise the steps you need to carry to get yourself
1120 a fully-configured build tree from scratch.
1129 Get your source tree from somewhere (CVS repository or source
1130 distribution). Say you call the root directory <filename>myfptools</filename> (it
1131 does not have to be called <filename>fptools</filename>). Make sure that you have
1132 the essential files (see <XRef LinkEnd="sec-source-tree">).
1139 Use <Command>lndir</Command> or <Command>mkshadowdir</Command> to create a build tree.
1143 mkshadowdir . /scratch/joe-bloggs/myfptools-sun4
1146 (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
1147 suggests its main defining characteristic (in your mind at least),
1148 in case you later add others.
1155 Change directory to the build tree. Everything is going
1156 to happen there now.
1159 cd /scratch/joe-bloggs/myfptools-sun4
1167 Prepare for system configuration:
1173 (You can skip this step if you are starting from a source distribution,
1174 and you already have <filename>configure</filename> and <filename>mk/config.h.in</filename>.)
1181 Do system configuration:
1193 Create the file <filename>mk/build.mk</filename>,
1194 adding definitions for your desired configuration options.
1205 You can make subsequent changes to <filename>mk/build.mk</filename> as often
1206 as you like. You do not have to run any further configuration programs to
1207 make these changes take effect. In theory you should, however, say
1208 <Command>gmake clean</Command>, <Command>gmake all</Command>, because
1209 configuration option changes could affect anything—but in practice you
1210 are likely to know what's affected.
1216 <Title>Making things</Title>
1218 <para>At this point you have made yourself a fully-configured
1219 build tree, so you are ready to start building real
1222 <para>The first thing you need to know is that <Emphasis>you
1223 must use GNU <Command>make</Command>, usually called
1224 <Command>gmake</Command>, not standard Unix
1225 <Command>make</Command></Emphasis>. If you use standard Unix
1226 <Command>make</Command> you will get all sorts of error messages
1227 (but no damage) because the <Literal>fptools</Literal>
1228 <Command>Makefiles</Command> use GNU <Command>make</Command>'s
1229 facilities extensively.</para>
1231 <para>To just build the whole thing, <command>cd</command> to
1232 the top of your <literal>fptools</literal> tree and type
1233 <command>gmake</command>. This will prepare the tree and build
1234 the various projects in the correct order.</para>
1238 <Sect2 id="sec-standard-targets">
1239 <Title>Standard Targets</title>
1240 <IndexTerm><Primary>targets, standard makefile</Primary></IndexTerm>
1241 <IndexTerm><Primary>makefile targets</Primary></IndexTerm>
1243 <para>In any directory you should be able to make the following:
1248 <Term><Literal>boot</Literal>:</Term>
1250 <para>does the one-off preparation required to get ready for the real
1251 work. Notably, it does <Command>gmake depend</Command> in all
1252 directories that contain programs. It also builds the necessary tools
1253 for compilation to proceed.</para>
1255 <para>Invoking the <literal>boot</literal> target explicitly is not
1256 normally necessary. From the top-level <literal>fptools</literal>
1257 directory, invoking <literal>gmake</literal> causes <literal>gmake
1258 boot all</literal> to be invoked in each of the project
1259 subdirectories, in the order specified by
1260 <literal>$(AllTargets)</literal> in
1261 <literal>config.mk</literal>.</para>
1263 <para>If you're working in a subdirectory somewhere and need to update
1264 the dependencies, <literal>gmake boot</literal> is a good way to do it.</para>
1266 </ListItem></VarListEntry>
1268 <Term><Literal>all</Literal>:</Term>
1271 makes all the final target(s) for this Makefile.
1272 Depending on which directory you are in a ``final target'' may be an
1273 executable program, a library archive, a shell script, or a Postscript
1274 file. Typing <Command>gmake</Command> alone is generally the same as typing <Command>gmake all</Command>.
1276 </ListItem></VarListEntry>
1278 <Term><Literal>install</Literal>:</Term>
1281 installs the things built by <Literal>all</Literal>. Where does it
1282 install them? That is specified by
1283 <filename>mk/config.mk.in</filename>; you can override it in
1284 <filename>mk/build.mk</filename>, or by running
1285 <command>configure</command> with command-line arguments like
1286 <literal>--bindir=/home/simonpj/bin</literal>; see <literal>./configure
1287 --help</literal> for the full details.
1289 </ListItem></VarListEntry>
1291 <Term><Literal>uninstall</Literal>:</Term>
1294 reverses the effect of <Literal>install</Literal>.
1296 </ListItem></VarListEntry>
1299 <Term><Literal>clean</Literal>:</Term>
1302 Delete all files from the current directory that are normally created
1303 by building the program. Don't delete the files that record the
1304 configuration, or files generated by <Command>gmake boot</Command>.
1305 Also preserve files that could be made by building, but normally
1306 aren't because the distribution comes with them.</para>
1307 </ListItem></VarListEntry>
1310 <term><literal>distclean</literal>:</term>
1312 <para>Delete all files from the current directory that are created by
1313 configuring or building the program. If you have unpacked the source
1314 and built the program without creating any other files, <literal>make
1315 distclean</literal> should leave only the files that were in the
1316 distribution.</para>
1321 <term><literal>mostlyclean</literal>:</term>
1323 <para>Like <literal>clean</literal>, but may refrain from deleting a
1324 few files that people normally don't want to recompile.</para>
1329 <Term><Literal>maintainer-clean</Literal>:</Term>
1332 Delete everything from the current directory that can be reconstructed
1333 with this Makefile. This typically includes everything deleted by
1334 <literal>distclean</literal>, plus more: C source files produced by
1335 Bison, tags tables, Info files, and so on.</para>
1337 <para>One exception, however: <literal>make maintainer-clean</literal>
1338 should not delete <filename>configure</filename> even if
1339 <filename>configure</filename> can be remade using a rule in the
1340 <filename>Makefile</filename>. More generally, <literal>make
1341 maintainer-clean</literal> should not delete anything that needs to
1342 exist in order to run <filename>configure</filename> and then begin to
1343 build the program.</para>
1348 <Term><Literal>check</Literal>:</Term>
1353 </ListItem></VarListEntry>
1358 All of these standard targets automatically recurse into
1359 sub-directories. Certain other standard targets do not:
1366 <Term><Literal>configure</Literal>:</Term>
1369 is only available in the root directory
1370 <Constant>$(FPTOOLS_TOP)</Constant>; it has been discussed in <XRef LinkEnd="sec-build-config">.
1372 </ListItem></VarListEntry>
1374 <Term><Literal>depend</Literal>:</Term>
1377 make a <filename>.depend</filename> file in each directory that needs
1378 it. This <filename>.depend</filename> file contains mechanically-generated dependency
1379 information; for example, suppose a directory contains a Haskell
1380 source module <filename>Foo.lhs</filename> which imports another module <Literal>Baz</Literal>.
1381 Then the generated <filename>.depend</filename> file will contain the dependency:
1393 which says that the object file <filename>Foo.o</filename> depends on the interface file
1394 <filename>Baz.hi</filename> generated by compiling module <Literal>Baz</Literal>. The <filename>.depend</filename> file is
1395 automatically included by every Makefile.
1397 </ListItem></VarListEntry>
1399 <Term><Literal>binary-dist</Literal>:</Term>
1402 make a binary distribution. This is the
1403 target we use to build the binary distributions of GHC and Happy.
1405 </ListItem></VarListEntry>
1407 <Term><Literal>dist</Literal>:</Term>
1410 make a source distribution. Note that this target does “make
1411 distclean” as part of its work; don't use it if you want to keep
1414 </ListItem></VarListEntry>
1419 Most <filename>Makefile</filename>s have targets other than these. You can discover them by looking in the <filename>Makefile</filename> itself.
1425 <title>Using a project from the build tree</title>
1427 If you want to build GHC (say) and just use it direct from the build
1428 tree without doing <literal>make install</literal> first, you can run
1429 the in-place driver script:
1430 <filename>ghc/compiler/ghc-inplace</filename>.
1433 <para> Do <emphasis>NOT</emphasis> use
1434 <filename>ghc/compiler/ghc</filename>, or
1435 <filename>ghc/compiler/ghc-5.xx</filename>, as these are the scripts
1436 intended for installation, and contain hard-wired paths to the
1437 installed libraries, rather than the libraries in the build tree.
1441 Happy can similarly be run from the build tree, using
1442 <filename>happy/src/happy-inplace</filename>.
1447 <Title>Fast Making <IndexTerm><Primary>fastmake</Primary></IndexTerm>
1448 <IndexTerm><Primary>dependencies, omitting</Primary></IndexTerm>
1449 <IndexTerm><Primary>FAST, makefile
1450 variable</Primary></IndexTerm></Title>
1453 Sometimes the dependencies get in the way: if you've made a small
1454 change to one file, and you're absolutely sure that it won't affect
1455 anything else, but you know that <Command>make</Command> is going to rebuild everything
1456 anyway, the following hack may be useful:
1468 This tells the make system to ignore dependencies and just build what
1469 you tell it to. In other words, it's equivalent to temporarily
1470 removing the <filename>.depend</filename> file in the current directory (where
1471 <Command>mkdependHS</Command> and friends store their dependency information).
1475 A bit of history: GHC used to come with a <Command>fastmake</Command> script that did
1476 the above job, but GNU make provides the features we need to do it
1477 without resorting to a script. Also, we've found that fastmaking is
1478 less useful since the advent of GHC's recompilation checker (see the
1479 User's Guide section on "Separate Compilation").
1486 <Sect1 id="sec-makefile-arch">
1487 <Title>The <filename>Makefile</filename> architecture
1488 <IndexTerm><Primary>makefile architecture</Primary></IndexTerm></Title>
1491 <Command>make</Command> is great if everything works—you type <Command>gmake install</Command> and
1492 lo! the right things get compiled and installed in the right places.
1493 Our goal is to make this happen often, but somehow it often doesn't;
1494 instead some weird error message eventually emerges from the bowels of
1495 a directory you didn't know existed.
1499 The purpose of this section is to give you a road-map to help you figure
1500 out what is going right and what is going wrong.
1504 <Title>A small project</Title>
1507 To get started, let us look at the <filename>Makefile</filename> for an imaginary small
1508 <Literal>fptools</Literal> project, <Literal>small</Literal>. Each project in <Literal>fptools</Literal> has its own
1509 directory in <Constant>FPTOOLS_TOP</Constant>, so the <Literal>small</Literal> project will have its own
1510 directory <Constant>FPOOLS_TOP/small/</Constant>. Inside the <filename>small/</filename> directory there
1511 will be a <filename>Makefile</filename>, looking something like this:
1515 <IndexTerm><Primary>Makefile, minimal</Primary></IndexTerm>
1518 # Makefile for fptools project "small"
1521 include $(TOP)/mk/boilerplate.mk
1523 SRCS = $(wildcard *.lhs) $(wildcard *.c)
1526 include $(TOP)/target.mk
1532 This <filename>Makefile</filename> has three sections:
1541 The first section includes
1545 One of the most important
1546 features of GNU <Command>make</Command> that we use is the ability for a <filename>Makefile</filename> to
1547 include another named file, very like <Command>cpp</Command>'s <Literal>#include</Literal>
1552 a file of ``boilerplate'' code from the level
1553 above (which in this case will be
1554 <filename><Constant>FPTOOLS_TOP</Constant>/mk/boilerplate.mk</filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm>). As its name
1555 suggests, <filename>boilerplate.mk</filename> consists of a large quantity of standard
1556 <filename>Makefile</filename> code. We discuss this boilerplate in more detail in
1557 <XRef LinkEnd="sec-boiler">.
1558 <IndexTerm><Primary>include, directive in Makefiles</Primary></IndexTerm>
1559 <IndexTerm><Primary>Makefile inclusion</Primary></IndexTerm>
1561 Before the <Literal>include</Literal> statement, you must define the <Command>make</Command> variable
1562 <Constant>TOP</Constant><IndexTerm><Primary>TOP</Primary></IndexTerm> to be the directory containing the <filename>mk</filename> directory in
1563 which the <filename>boilerplate.mk</filename> file is. It is <Emphasis>not</Emphasis> OK to simply say
1567 include ../mk/boilerplate.mk # NO NO NO
1571 Why? Because the <filename>boilerplate.mk</filename> file needs to know where it is, so
1572 that it can, in turn, <Literal>include</Literal> other files. (Unfortunately, when an
1573 <Literal>include</Literal>d file does an <Literal>include</Literal>, the filename is treated relative to
1574 the directory in which <Command>gmake</Command> is being run, not the directory in
1575 which the <Literal>include</Literal>d sits.) In general, <Emphasis>every file <filename>foo.mk</filename>
1576 assumes that <filename><Constant>$(TOP)</Constant>/mk/foo.mk</filename> refers to itself.</Emphasis> It is up to the
1577 <filename>Makefile</filename> doing the <Literal>include</Literal> to ensure this is the case.
1579 Files intended for inclusion in other <filename>Makefile</filename>s are written to have
1580 the following property: <Emphasis>after <filename>foo.mk</filename> is <Literal>include</Literal>d, it leaves
1581 <Constant>TOP</Constant> containing the same value as it had just before the <Literal>include</Literal>
1582 statement</Emphasis>. In our example, this invariant guarantees that the
1583 <Literal>include</Literal> for <filename>target.mk</filename> will look in the same directory as that for
1584 <filename>boilerplate.mk</filename>.
1591 The second section defines the following standard <Command>make</Command>
1592 variables: <Constant>SRCS</Constant><IndexTerm><Primary>SRCS</Primary></IndexTerm> (the source files from which is to be
1593 built), and <Constant>HS_PROG</Constant><IndexTerm><Primary>HS_PROG</Primary></IndexTerm> (the executable binary to be
1594 built). We will discuss in more detail what the ``standard
1595 variables'' are, and how they affect what happens, in <XRef LinkEnd="sec-targets">.
1597 The definition for <Constant>SRCS</Constant> uses the useful GNU <Command>make</Command> construct
1598 <Literal>$(wildcard $pat$)</Literal><IndexTerm><Primary>wildcard</Primary></IndexTerm>, which expands to a list of all
1599 the files matching the pattern <Literal>pat</Literal> in the current directory. In
1600 this example, <Constant>SRCS</Constant> is set to the list of all the <filename>.lhs</filename> and <filename>.c</filename>
1601 files in the directory. (Let's suppose there is one of each,
1602 <filename>Foo.lhs</filename> and <filename>Baz.c</filename>.)
1609 The last section includes a second file of standard code,
1610 called <filename>target.mk</filename><IndexTerm><Primary>target.mk</Primary></IndexTerm>. It contains the rules that tell
1611 <Command>gmake</Command> how to make the standard targets (<Xref LinkEnd="sec-standard-targets">). Why, you ask,
1612 can't this standard code be part of <filename>boilerplate.mk</filename>? Good question.
1613 We discuss the reason later, in <Xref LinkEnd="sec-boiler-arch">.
1615 You do not <Emphasis>have</Emphasis> to <Literal>include</Literal> the <filename>target.mk</filename> file. Instead, you
1616 can write rules of your own for all the standard targets. Usually,
1617 though, you will find quite a big payoff from using the canned rules
1618 in <filename>target.mk</filename>; the price tag is that you have to understand what
1619 canned rules get enabled, and what they do (<Xref LinkEnd="sec-targets">).
1629 In our example <filename>Makefile</filename>, most of the work is done by the two
1630 <Literal>include</Literal>d files. When you say <Command>gmake all</Command>, the following things
1640 <Command>gmake</Command> figures out that the object files are <filename>Foo.o</filename> and
1641 <filename>Baz.o</filename>.
1648 It uses a boilerplate pattern rule to compile <filename>Foo.lhs</filename> to
1649 <filename>Foo.o</filename> using a Haskell compiler. (Which one? That is set in the
1650 build configuration.)
1657 It uses another standard pattern rule to compile <filename>Baz.c</filename> to
1658 <filename>Baz.o</filename>, using a C compiler. (Ditto.)
1665 It links the resulting <filename>.o</filename> files together to make <Literal>small</Literal>,
1666 using the Haskell compiler to do the link step. (Why not use <Command>ld</Command>?
1667 Because the Haskell compiler knows what standard libraries to link in.
1668 How did <Command>gmake</Command> know to use the Haskell compiler to do the link,
1669 rather than the C compiler? Because we set the variable <Constant>HS_PROG</Constant>
1670 rather than <Constant>C_PROG</Constant>.)
1680 All <filename>Makefile</filename>s should follow the above three-section format.
1686 <Title>A larger project</Title>
1689 Larger projects are usually structured into a number of sub-directories,
1690 each of which has its own <filename>Makefile</filename>. (In very large projects, this
1691 sub-structure might be iterated recursively, though that is rare.)
1692 To give you the idea, here's part of the directory structure for
1693 the (rather large) GHC project:
1706 ...source files for documentation...
1709 ...source files for driver...
1712 parser/...source files for parser...
1713 renamer/...source files for renamer...
1720 The sub-directories <filename>docs</filename>, <filename>driver</filename>, <filename>compiler</filename>, and so on, each
1721 contains a sub-component of GHC, and each has its own <filename>Makefile</filename>.
1722 There must also be a <filename>Makefile</filename> in <filename><Constant>$(FPTOOLS_TOP)</Constant>/ghc</filename>. It does most
1723 of its work by recursively invoking <Command>gmake</Command> on the <filename>Makefile</filename>s in the
1724 sub-directories. We say that <filename>ghc/Makefile</filename> is a <Emphasis>non-leaf
1725 <filename>Makefile</filename></Emphasis>, because it does little except organise its children,
1726 while the <filename>Makefile</filename>s in the sub-directories are all <Emphasis>leaf
1727 <filename>Makefile</filename>s</Emphasis>. (In principle the sub-directories might themselves
1728 contain a non-leaf <filename>Makefile</filename> and several sub-sub-directories, but
1729 that does not happen in GHC.)
1733 The <filename>Makefile</filename> in <filename>ghc/compiler</filename> is considered a leaf <filename>Makefile</filename> even
1734 though the <filename>ghc/compiler</filename> has sub-directories, because these sub-directories
1735 do not themselves have <filename>Makefile</filename>s in them. They are just used to structure
1736 the collection of modules that make up GHC, but all are managed by the
1737 single <filename>Makefile</filename> in <filename>ghc/compiler</filename>.
1741 You will notice that <filename>ghc/</filename> also contains a directory <filename>ghc/mk/</filename>. It
1742 contains GHC-specific <filename>Makefile</filename> boilerplate code. More precisely:
1751 <filename>ghc/mk/boilerplate.mk</filename> is included at the top of
1752 <filename>ghc/Makefile</filename>, and of all the leaf <filename>Makefile</filename>s in the
1753 sub-directories. It in turn <Literal>include</Literal>s the main boilerplate file
1754 <filename>mk/boilerplate.mk</filename>.
1762 <filename>ghc/mk/target.mk</filename> is <Literal>include</Literal>d at the bottom of
1763 <filename>ghc/Makefile</filename>, and of all the leaf <filename>Makefile</filename>s in the
1764 sub-directories. It in turn <Literal>include</Literal>s the file <filename>mk/target.mk</filename>.
1774 So these two files are the place to look for GHC-wide customisation
1775 of the standard boilerplate.
1780 <Sect2 id="sec-boiler-arch">
1781 <Title>Boilerplate architecture
1782 <IndexTerm><Primary>boilerplate architecture</Primary></IndexTerm>
1786 Every <filename>Makefile</filename> includes a <filename>boilerplate.mk</filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm> file
1787 at the top, and <filename>target.mk</filename><IndexTerm><Primary>target.mk</Primary></IndexTerm> file at the bottom. In
1788 this section we discuss what is in these files, and why there have to
1789 be two of them. In general:
1798 <filename>boilerplate.mk</filename> consists of:
1804 <Emphasis>Definitions of millions of <Command>make</Command> variables</Emphasis> that
1805 collectively specify the build configuration. Examples:
1806 <Constant>HC_OPTS</Constant><IndexTerm><Primary>HC_OPTS</Primary></IndexTerm>, the options to feed to the Haskell compiler;
1807 <Constant>NoFibSubDirs</Constant><IndexTerm><Primary>NoFibSubDirs</Primary></IndexTerm>, the sub-directories to enable within the
1808 <Literal>nofib</Literal> project; <Constant>GhcWithHc</Constant><IndexTerm><Primary>GhcWithHc</Primary></IndexTerm>, the name of the Haskell
1809 compiler to use when compiling GHC in the <Literal>ghc</Literal> project.
1815 <Emphasis>Standard pattern rules</Emphasis> that tell <Command>gmake</Command> how to construct one
1823 <filename>boilerplate.mk</filename> needs to be <Literal>include</Literal>d at the <Emphasis>top</Emphasis>
1824 of each <filename>Makefile</filename>, so that the user can replace the
1825 boilerplate definitions or pattern rules by simply giving a new
1826 definition or pattern rule in the <filename>Makefile</filename>. <Command>gmake</Command>
1827 simply takes the last definition as the definitive one.
1829 Instead of <Emphasis>replacing</Emphasis> boilerplate definitions, it is also quite
1830 common to <Emphasis>augment</Emphasis> them. For example, a <filename>Makefile</filename> might say:
1838 thereby adding ``<Option>-O</Option>'' to the end of <Constant>SRC_HC_OPTS</Constant><IndexTerm><Primary>SRC_HC_OPTS</Primary></IndexTerm>.
1845 <filename>target.mk</filename> contains <Command>make</Command> rules for the standard
1846 targets described in <Xref LinkEnd="sec-standard-targets">. These rules are selectively included,
1847 depending on the setting of certain <Command>make</Command> variables. These
1848 variables are usually set in the middle section of the
1849 <filename>Makefile</filename> between the two <Literal>include</Literal>s.
1851 <filename>target.mk</filename> must be included at the end (rather than being part of
1852 <filename>boilerplate.mk</filename>) for several tiresome reasons:
1859 <Command>gmake</Command> commits target and dependency lists earlier than
1860 it should. For example, <FIlename>target.mk</FIlename> has a rule that looks like
1865 $(HS_PROG) : $(OBJS)
1866 $(HC) $(LD_OPTS) $< -o $@
1870 If this rule was in <filename>boilerplate.mk</filename> then <Constant>$(HS_PROG)</Constant><IndexTerm><Primary>HS_PROG</Primary></IndexTerm>
1871 and <Constant>$(OBJS)</Constant><IndexTerm><Primary>OBJS</Primary></IndexTerm> would not have their final values at the
1872 moment <Command>gmake</Command> encountered the rule. Alas, <Command>gmake</Command> takes a snapshot
1873 of their current values, and wires that snapshot into the rule. (In
1874 contrast, the commands executed when the rule ``fires'' are only
1875 substituted at the moment of firing.) So, the rule must follow the
1876 definitions given in the <filename>Makefile</filename> itself.
1883 Unlike pattern rules, ordinary rules cannot be overriden or
1884 replaced by subsequent rules for the same target (at least, not without an
1885 error message). Including ordinary rules in <filename>boilerplate.mk</filename> would
1886 prevent the user from writing rules for specific targets in specific cases.
1893 There are a couple of other reasons I've forgotten, but it doesn't
1909 <Sect2 id="sec-boiler">
1910 <Title>The main <filename>mk/boilerplate.mk</filename> file
1912 <IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm></Title>
1915 If you look at <filename><Constant>$(FPTOOLS_TOP)</Constant>/mk/boilerplate.mk</filename> you will find
1916 that it consists of the following sections, each held in a separate
1924 <Term><filename>config.mk</filename><IndexTerm><Primary>config.mk</Primary></IndexTerm></Term>
1927 is the build configuration file we
1928 discussed at length in <Xref LinkEnd="sec-build-config">.
1930 </ListItem></VarListEntry>
1932 <Term><filename>paths.mk</filename><IndexTerm><Primary>paths.mk</Primary></IndexTerm></Term>
1935 defines <Command>make</Command> variables for
1936 pathnames and file lists. In particular, it gives definitions for:
1943 <Term><Constant>SRCS</Constant><IndexTerm><Primary>SRCS</Primary></IndexTerm>:</Term>
1946 all source files in the current directory.
1948 </ListItem></VarListEntry>
1950 <Term><Constant>HS_SRCS</Constant><IndexTerm><Primary>HS_SRCS</Primary></IndexTerm>:</Term>
1953 all Haskell source files in the current directory.
1954 It is derived from <Constant>$(SRCS)</Constant>, so if you override <Constant>SRCS</Constant> with a new value
1955 <Constant>HS_SRCS</Constant> will follow suit.
1957 </ListItem></VarListEntry>
1959 <Term><Constant>C_SRCS</Constant><IndexTerm><Primary>C_SRCS</Primary></IndexTerm>:</Term>
1962 similarly for C source files.
1964 </ListItem></VarListEntry>
1966 <Term><Constant>HS_OBJS</Constant><IndexTerm><Primary>HS_OBJS</Primary></IndexTerm>:</Term>
1969 the <filename>.o</filename> files derived from <Constant>$(HS_SRCS)</Constant>.
1971 </ListItem></VarListEntry>
1973 <Term><Constant>C_OBJS</Constant><IndexTerm><Primary>C_OBJS</Primary></IndexTerm>:</Term>
1976 similarly for <Constant>$(C_SRCS)</Constant>.
1978 </ListItem></VarListEntry>
1980 <Term><Constant>OBJS</Constant><IndexTerm><Primary>OBJS</Primary></IndexTerm>:</Term>
1983 the concatenation of <Constant>$(HS_OBJS)</Constant> and <Constant>$(C_OBJS)</Constant>.
1985 </ListItem></VarListEntry>
1990 Any or all of these definitions can easily be overriden by giving new
1991 definitions in your <filename>Makefile</filename>. For example, if there are things in
1992 the current directory that look like source files but aren't, then
1993 you'll need to set <Constant>SRCS</Constant> manually in your <filename>Makefile</filename>. The other
1994 definitions will then work from this new definition.
1998 What, exactly, does <filename>paths.mk</filename> consider a ``source file'' to be? It's
1999 based on the file's suffix (e.g. <filename>.hs</filename>, <filename>.lhs</filename>, <filename>.c</filename>, <filename>.lc</filename>, etc), but
2000 this is the kind of detail that changes, so rather than
2001 enumerate the source suffices here the best thing to do is to look in
2002 <filename>paths.mk</filename>.
2004 </ListItem></VarListEntry>
2006 <Term><filename>opts.mk</filename><IndexTerm><Primary>opts.mk</Primary></IndexTerm></Term>
2009 defines <Command>make</Command> variables for option
2010 strings to pass to each program. For example, it defines
2011 <Constant>HC_OPTS</Constant><IndexTerm><Primary>HC_OPTS</Primary></IndexTerm>, the option strings to pass to the Haskell
2012 compiler. See <Xref LinkEnd="sec-suffix">.
2014 </ListItem></VarListEntry>
2016 <Term><filename>suffix.mk</filename><IndexTerm><Primary>suffix.mk</Primary></IndexTerm></Term>
2019 defines standard pattern rules—see <Xref LinkEnd="sec-suffix">.
2021 </ListItem></VarListEntry>
2026 Any of the variables and pattern rules defined by the boilerplate file
2027 can easily be overridden in any particular <filename>Makefile</filename>, because the
2028 boilerplate <Literal>include</Literal> comes first. Definitions after this <Literal>include</Literal>
2029 directive simply override the default ones in <filename>boilerplate.mk</filename>.
2034 <Sect2 id="sec-suffix">
2035 <Title>Pattern rules and options
2037 <IndexTerm><Primary>Pattern rules</Primary></IndexTerm></Title>
2040 The file <filename>suffix.mk</filename><IndexTerm><Primary>suffix.mk</Primary></IndexTerm> defines standard <Emphasis>pattern
2041 rules</Emphasis> that say how to build one kind of file from another, for
2042 example, how to build a <filename>.o</filename> file from a <filename>.c</filename> file. (GNU <Command>make</Command>'s
2043 <Emphasis>pattern rules</Emphasis> are more powerful and easier to use than Unix
2044 <Command>make</Command>'s <Emphasis>suffix rules</Emphasis>.)
2048 Almost all the rules look something like this:
2056 $(CC) $(CC_OPTS) -c $< -o $@
2062 Here's how to understand the rule. It says that
2063 <Emphasis>something</Emphasis><filename>.o</filename> (say <filename>Foo.o</filename>) can be built from
2064 <Emphasis>something</Emphasis><filename>.c</filename> (<filename>Foo.c</filename>), by invoking the C compiler
2065 (path name held in <Constant>$(CC)</Constant>), passing to it the options
2066 <Constant>$(CC_OPTS)</Constant> and the rule's dependent file of the rule
2067 <Literal>$<</Literal> (<filename>Foo.c</filename> in this case), and putting the result in
2068 the rule's target <Literal>$@</Literal> (<filename>Foo.o</filename> in this case).
2072 Every program is held in a <Command>make</Command> variable defined in
2073 <filename>mk/config.mk</filename>—look in <filename>mk/config.mk</filename> for the
2074 complete list. One important one is the Haskell compiler, which is
2075 called <Constant>$(HC)</Constant>.
2079 Every program's options are are held in a <Command>make</Command> variables called
2080 <Constant><prog>_OPTS</Constant>. the <Constant><prog>_OPTS</Constant> variables are defined in
2081 <filename>mk/opts.mk</filename>. Almost all of them are defined like this:
2087 CC_OPTS = $(SRC_CC_OPTS) $(WAY$(_way)_CC_OPTS) $($*_CC_OPTS) $(EXTRA_CC_OPTS)
2093 The four variables from which <Constant>CC_OPTS</Constant> is built have the following meaning:
2100 <Term><Constant>SRC_CC_OPTS</Constant><IndexTerm><Primary>SRC_CC_OPTS</Primary></IndexTerm>:</Term>
2103 options passed to all C
2106 </ListItem></VarListEntry>
2108 <Term><Constant>WAY_<way>_CC_OPTS</Constant>:</Term>
2112 compilations for way <Literal><way></Literal>. For example,
2113 <Constant>WAY_mp_CC_OPTS</Constant> gives options to pass to the C compiler when
2114 compiling way <Literal>mp</Literal>. The variable <Constant>WAY_CC_OPTS</Constant> holds
2115 options to pass to the C compiler when compiling the standard way.
2116 (<Xref LinkEnd="sec-ways"> dicusses multi-way
2119 </ListItem></VarListEntry>
2121 <Term><Constant><module>_CC_OPTS</Constant>:</Term>
2125 pass to the C compiler that are specific to module <Literal><module></Literal>. For example, <Constant>SMap_CC_OPTS</Constant> gives the specific options
2126 to pass to the C compiler when compiling <filename>SMap.c</filename>.
2128 </ListItem></VarListEntry>
2130 <Term><Constant>EXTRA_CC_OPTS</Constant><IndexTerm><Primary>EXTRA_CC_OPTS</Primary></IndexTerm>:</Term>
2133 extra options to pass to all
2134 C compilations. This is intended for command line use, thus:
2140 gmake libHS.a EXTRA_CC_OPTS="-v"
2144 </ListItem></VarListEntry>
2150 <Sect2 id="sec-targets">
2151 <Title>The main <filename>mk/target.mk</filename> file
2153 <IndexTerm><Primary>target.mk</Primary></IndexTerm></Title>
2156 <filename>target.mk</filename> contains canned rules for all the standard targets
2157 described in <Xref LinkEnd="sec-standard-targets">. It is complicated by the fact that you don't want all of
2158 these rules to be active in every <filename>Makefile</filename>. Rather than have a
2159 plethora of tiny files which you can include selectively, there is a
2160 single file, <filename>target.mk</filename>, which selectively includes rules based on
2161 whether you have defined certain variables in your <filename>Makefile</filename>. This
2162 section explains what rules you get, what variables control them, and
2163 what the rules do. Hopefully, you will also get enough of an idea of
2164 what is supposed to happen that you can read and understand any weird
2165 special cases yourself.
2172 <Term><Constant>HS_PROG</Constant><IndexTerm><Primary>HS_PROG</Primary></IndexTerm>.</Term>
2175 If <Constant>HS_PROG</Constant> is defined, you get
2176 rules with the following targets:
2180 <Term><filename>HS_PROG</filename><IndexTerm><Primary>HS_PROG</Primary></IndexTerm></Term>
2183 itself. This rule links <Constant>$(OBJS)</Constant>
2184 with the Haskell runtime system to get an executable called
2185 <Constant>$(HS_PROG)</Constant>.
2187 </ListItem></VarListEntry>
2189 <Term><Literal>install</Literal><IndexTerm><Primary>install</Primary></IndexTerm></Term>
2192 installs <Constant>$(HS_PROG)</Constant>
2193 in <Constant>$(bindir)</Constant>.
2195 </ListItem></VarListEntry>
2198 </ListItem></VarListEntry>
2200 <Term><Constant>C_PROG</Constant><IndexTerm><Primary>C_PROG</Primary></IndexTerm></Term>
2203 is similar to <Constant>HS_PROG</Constant>, except that
2204 the link step links <Constant>$(C_OBJS)</Constant> with the C runtime system.
2206 </ListItem></VarListEntry>
2208 <Term><Constant>LIBRARY</Constant><IndexTerm><Primary>LIBRARY</Primary></IndexTerm></Term>
2211 is similar to <Constant>HS_PROG</Constant>, except that
2212 it links <Constant>$(LIB_OBJS)</Constant> to make the library archive <Constant>$(LIBRARY)</Constant>, and
2213 <Literal>install</Literal> installs it in <Constant>$(libdir)</Constant>.
2215 </ListItem></VarListEntry>
2217 <Term><Constant>LIB_DATA</Constant><IndexTerm><Primary>LIB_DATA</Primary></IndexTerm></Term>
2222 </ListItem></VarListEntry>
2224 <Term><Constant>LIB_EXEC</Constant><IndexTerm><Primary>LIB_EXEC</Primary></IndexTerm></Term>
2229 </ListItem></VarListEntry>
2231 <Term><Constant>HS_SRCS</Constant><IndexTerm><Primary>HS_SRCS</Primary></IndexTerm>, <Constant>C_SRCS</Constant><IndexTerm><Primary>C_SRCS</Primary></IndexTerm>.</Term>
2234 If <Constant>HS_SRCS</Constant>
2235 is defined and non-empty, a rule for the target <Literal>depend</Literal> is included,
2236 which generates dependency information for Haskell programs.
2237 Similarly for <Constant>C_SRCS</Constant>.
2239 </ListItem></VarListEntry>
2244 All of these rules are ``double-colon'' rules, thus
2250 install :: $(HS_PROG)
2251 ...how to install it...
2257 GNU <Command>make</Command> treats double-colon rules as separate entities. If there
2258 are several double-colon rules for the same target it takes each in
2259 turn and fires it if its dependencies say to do so. This means that
2260 you can, for example, define both <Constant>HS_PROG</Constant> and <Constant>LIBRARY</Constant>, which will
2261 generate two rules for <Literal>install</Literal>. When you type <Command>gmake install</Command> both
2262 rules will be fired, and both the program and the library will be
2263 installed, just as you wanted.
2268 <Sect2 id="sec-subdirs">
2271 <IndexTerm><Primary>recursion, in makefiles</Primary></IndexTerm>
2272 <IndexTerm><Primary>Makefile, recursing into subdirectories</Primary></IndexTerm></Title>
2275 In leaf <filename>Makefile</filename>s the variable <Constant>SUBDIRS</Constant><IndexTerm><Primary>SUBDIRS</Primary></IndexTerm> is undefined.
2276 In non-leaf <filename>Makefile</filename>s, <Constant>SUBDIRS</Constant> is set to the list of
2277 sub-directories that contain subordinate <filename>Makefile</filename>s. <Emphasis>It is up to
2278 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.
2282 When <Constant>SUBDIRS</Constant> is defined, <filename>target.mk</filename> includes a rather
2283 neat rule for the standard targets (<Xref LinkEnd="sec-standard-targets"> that simply invokes
2284 <Command>make</Command> recursively in each of the sub-directories.
2288 <Emphasis>These recursive invocations are guaranteed to occur in the order
2289 in which the list of directories is specified in <Constant>SUBDIRS</Constant>. </Emphasis>This
2290 guarantee can be important. For example, when you say <Command>gmake boot</Command> it
2291 can be important that the recursive invocation of <Command>make boot</Command> is done
2292 in one sub-directory (the include files, say) before another (the
2293 source files). Generally, put the most independent sub-directory
2294 first, and the most dependent last.
2299 <Sect2 id="sec-ways">
2300 <Title>Way management
2302 <IndexTerm><Primary>way management</Primary></IndexTerm></Title>
2305 We sometimes want to build essentially the same system in several
2306 different ``ways''. For example, we want to build GHC's <Literal>Prelude</Literal>
2307 libraries with and without profiling, with and without concurrency,
2308 and so on, so that there is an appropriately-built library archive to
2309 link with when the user compiles his program. It would be possible to
2310 have a completely separate build tree for each such ``way'', but it
2311 would be horribly bureaucratic, especially since often only parts of
2312 the build tree need to be constructed in multiple ways.
2316 Instead, the <filename>target.mk</filename><IndexTerm><Primary>target.mk</Primary></IndexTerm> contains some clever magic to
2317 allow you to build several versions of a system; and to control
2318 locally how many versions are built and how they differ. This section
2323 The files for a particular way are distinguished by munging the
2324 suffix. The ``normal way'' is always built, and its files have the
2325 standard suffices <filename>.o</filename>, <filename>.hi</filename>, and so on. In addition, you can build
2326 one or more extra ways, each distinguished by a <Emphasis>way tag</Emphasis>. The
2327 object files and interface files for one of these extra ways are
2328 distinguished by their suffix. For example, way <Literal>mp</Literal> has files
2329 <filename>.mp_o</filename> and <filename>.mp_hi</filename>. Library archives have their way tag the other
2330 side of the dot, for boring reasons; thus, <filename>libHS_mp.a</filename>.
2334 A <Command>make</Command> variable called <Constant>way</Constant> holds the current way tag. <Emphasis><Constant>way</Constant>
2335 is only ever set on the command line of a recursive invocation of
2336 <Command>gmake</Command>.</Emphasis> It is never set inside a <filename>Makefile</filename>. So it is a global
2337 constant for any one invocation of <Command>gmake</Command>. Two other <Command>make</Command>
2338 variables, <Constant>way_</Constant> and <Constant>_way</Constant> are immediately derived from <Constant>$(way)</Constant> and
2339 never altered. If <Constant>way</Constant> is not set, then neither are <Constant>way_</Constant> and
2340 <Constant>_way</Constant>, and the invocation of <Command>make</Command> will build the ``normal way''.
2341 If <Constant>way</Constant> is set, then the other two variables are set in sympathy.
2342 For example, if <Constant>$(way)</Constant> is ``<Literal>mp</Literal>'', then <Constant>way_</Constant> is set to ``<Literal>mp_</Literal>''
2343 and <Constant>_way</Constant> is set to ``<Literal>_mp</Literal>''. These three variables are then used
2344 when constructing file names.
2348 So how does <Command>make</Command> ever get recursively invoked with <Constant>way</Constant> set? There
2349 are two ways in which this happens:
2358 For some (but not all) of the standard targets, when in a leaf
2359 sub-directory, <Command>make</Command> is recursively invoked for each way tag in
2360 <Constant>$(WAYS)</Constant>. You set <Constant>WAYS</Constant> to the list of way tags you want these
2361 targets built for. The mechanism here is very much like the recursive
2362 invocation of <Command>make</Command> in sub-directories (<Xref LinkEnd="sec-subdirs">).
2364 It is up to you to set <Constant>WAYS</Constant> in your <filename>Makefile</filename>; this is how you
2365 control what ways will get built.
2371 For a useful collection of
2372 targets (such as <filename>libHS_mp.a</filename>, <filename>Foo.mp_o</filename>) there is a rule which
2373 recursively invokes <Command>make</Command> to make the specified target, setting the
2374 <Constant>way</Constant> variable. So if you say <Command>gmake Foo.mp_o</Command> you should see a
2375 recursive invocation <Command>gmake Foo.mp_o way=mp</Command>, and <Emphasis>in this
2376 recursive invocation the pattern rule for compiling a Haskell file
2377 into a <filename>.o</filename> file will match</Emphasis>. The key pattern rules (in <filename>suffix.mk</filename>)
2383 $(HC) $(HC_OPTS) $< -o $@
2398 <Title>When the canned rule isn't right</Title>
2401 Sometimes the canned rule just doesn't do the right thing. For
2402 example, in the <Literal>nofib</Literal> suite we want the link step to print out
2403 timing information. The thing to do here is <Emphasis>not</Emphasis> to define
2404 <Constant>HS_PROG</Constant> or <Constant>C_PROG</Constant>, and instead define a special purpose rule in
2405 your own <filename>Makefile</filename>. By using different variable names you will avoid
2406 the canned rules being included, and conflicting with yours.
2413 <Sect1 id="sec-booting-from-C">
2414 <Title>Booting/porting from C (<filename>.hc</filename>) files
2416 <IndexTerm><Primary>building GHC from .hc files</Primary></IndexTerm>
2417 <IndexTerm><Primary>booting GHC from .hc files</Primary></IndexTerm>
2418 <IndexTerm><Primary>porting GHC</Primary></IndexTerm></Title>
2421 This section is for people trying to get GHC going by using the supplied
2422 intermediate C (<filename>.hc</filename>) files. This would probably be
2423 because no binaries have been provided, or because the machine is not ``fully
2428 The intermediate C files are normally made available together with a source
2429 release, please check the announce message for exact directions of where to
2430 find them. If we haven't made them available or you can't find them, please
2435 Assuming you've got them, unpack them on top of a fresh source tree. This
2436 will place matching <filename>.hc</filename> files next to the corresponding
2437 Haskell source in the compiler subdirectory <filename>ghc</filename> and in
2438 the language package of hslibs (i.e., in <filename>hslibs/lang</filename>).
2439 Then follow the `normal' instructions in <Xref
2440 LinkEnd="sec-building-from-source"> for setting up a build tree.
2444 The actual build process is fully automated by the
2445 <filename>hc-build</filename> script located in the
2446 <filename>distrib</filename> directory. If you eventually want to install GHC
2447 into the directory <filename>INSTALL_DIRECTORY</filename>, the following
2448 command will execute the whole build process (it won't install yet):
2451 foo% distrib/hc-build --prefix=INSTALL_DIRECTORY
2453 <IndexTerm><Primary>--hc-build</Primary></IndexTerm>
2455 By default, the installation directory is <filename>/usr/local</filename>. If
2456 that is what you want, you may omit the argument to
2457 <filename>hc-build</filename>. Generally, any option given to
2458 <filename>hc-build</filename> is passed through to the configuration script
2459 <filename>configure</filename>. If <filename>hc-build</filename>
2460 successfully completes the build process, you can install the resulting
2461 system, as normal, with
2468 That's the mechanics of the boot process, but, of course, if you're
2469 trying to boot on a platform that is not supported and significantly
2470 `different' from any of the supported ones, this is only the start of
2471 the adventure…(ToDo: porting tips—stuff to look out for, etc.)
2476 <Sect1 id="sec-build-pitfalls">
2477 <Title>Known pitfalls in building Glasgow Haskell
2479 <IndexTerm><Primary>problems, building</Primary></IndexTerm>
2480 <IndexTerm><Primary>pitfalls, in building</Primary></IndexTerm>
2481 <IndexTerm><Primary>building pitfalls</Primary></IndexTerm></Title>
2484 WARNINGS about pitfalls and known ``problems'':
2493 One difficulty that comes up from time to time is running out of space
2494 in <literal>TMPDIR</literal>. (It is impossible for the configuration stuff to
2495 compensate for the vagaries of different sysadmin approaches to temp
2497 <IndexTerm><Primary>tmp, running out of space in</Primary></IndexTerm>
2499 The quickest way around it is <Command>setenv TMPDIR /usr/tmp</Command><IndexTerm><Primary>TMPDIR</Primary></IndexTerm> or
2500 even <Command>setenv TMPDIR .</Command> (or the equivalent incantation with your shell
2503 The best way around it is to say
2506 export TMPDIR=<dir>
2509 in your <filename>build.mk</filename> file.
2510 Then GHC and the other <Literal>fptools</Literal> programs will use the appropriate directory
2519 In compiling some support-code bits, e.g., in <filename>ghc/rts/gmp</filename> and even
2520 in <filename>ghc/lib</filename>, you may get a few C-compiler warnings. We think these
2528 When compiling via C, you'll sometimes get ``warning: assignment from
2529 incompatible pointer type'' out of GCC. Harmless.
2536 Similarly, <Command>ar</Command>chiving warning messages like the following are not
2540 ar: filename GlaIOMonad__1_2s.o truncated to GlaIOMonad_
2541 ar: filename GlaIOMonad__2_2s.o truncated to GlaIOMonad_
2551 In compiling the compiler proper (in <filename>compiler/</filename>), you <Emphasis>may</Emphasis>
2552 get an ``Out of heap space'' error message. These can vary with the
2553 vagaries of different systems, it seems. The solution is simple:
2560 If you're compiling with GHC 4.00 or later, then the
2561 <Emphasis>maximum</Emphasis> heap size must have been reached. This
2562 is somewhat unlikely, since the maximum is set to 64M by default.
2563 Anyway, you can raise it with the
2564 <Option>-optCrts-M<size></Option> flag (add this flag to
2565 <Constant><module>_HC_OPTS</Constant>
2566 <Command>make</Command> variable in the appropriate
2567 <filename>Makefile</filename>).
2574 For GHC < 4.00, add a suitable <Option>-H</Option> flag to the <filename>Makefile</filename>, as
2583 and try again: <Command>gmake</Command>. (see <Xref LinkEnd="sec-suffix"> for information about
2584 <Constant><module>_HC_OPTS</Constant>.)
2586 Alternatively, just cut to the chase:
2590 % make EXTRA_HC_OPTS=-optCrts-M128M
2599 If you try to compile some Haskell, and you get errors from GCC about
2600 lots of things from <filename>/usr/include/math.h</filename>, then your GCC was
2601 mis-installed. <Command>fixincludes</Command> wasn't run when it should've been.
2603 As <Command>fixincludes</Command> is now automagically run as part of GCC installation,
2604 this bug also suggests that you have an old GCC.
2612 You <Emphasis>may</Emphasis> need to re-<Command>ranlib</Command><IndexTerm><Primary>ranlib</Primary></IndexTerm> your libraries (on Sun4s).
2616 % cd $(libdir)/ghc-x.xx/sparc-sun-sunos4
2617 % foreach i ( `find . -name '*.a' -print` ) # or other-shell equiv...
2619 ? # or, on some machines: ar s $i
2624 We'd be interested to know if this is still necessary.
2632 GHC's sources go through <Command>cpp</Command> before being compiled, and <Command>cpp</Command> varies
2633 a bit from one Unix to another. One particular gotcha is macro calls
2638 SLIT("Hello, world")
2642 Some <Command>cpp</Command>s treat the comma inside the string as separating two macro
2643 arguments, so you get
2647 :731: macro `SLIT' used with too many (2) args
2651 Alas, <Command>cpp</Command> doesn't tell you the offending file!
2653 Workaround: don't put weird things in string args to <Command>cpp</Command> macros.
2664 <Sect1 id="winbuild"><Title>Notes for building under Windows</Title>
2667 This section summarises how to get the utilities you need on your
2668 Win95/98/NT/2000 machine to use CVS and build GHC. Similar notes for
2669 installing and running GHC may be found in the user guide. In general,
2670 Win95/Win98 behave the same, and WinNT/Win2k behave the same.
2671 You should read the GHC installation guide sections on Windows (in the user
2672 guide) before continuing to read these notes.
2676 Because of various hard-wired infelicities, you need to copy
2677 <Filename>bash.exe</Filename> (from GHC's <Filename>extra-bin</Filename>
2678 directory), and <Filename>perl.exe</Filename> and
2679 <Filename>cat.exe</Filename> (from GHC's <Filename>bin</Filename> directory)
2680 to <Filename>/bin</Filename> (discover where your Cygwin root directory is
2681 by typign <Command>mount</Command>).
2685 Before you start, you need to make sure that the user environment variable
2686 <Constant>MAKE_MODE</Constant> is set to <Literal>UNIX</Literal>. If you
2687 don't do this you get very weird messages when you type
2688 <Command>make</Command>, such as:
2691 /c: /c: No such file or directory</Screen>
2693 <Sect2><Title>Configuring ssh</Title>
2699 Generate a key, by running <filename>c:/user/local/bin/ssh-keygen1</filename>.
2700 This generates a public key in <filename>.ssh/identity.pub</filename>, and a
2701 private key in <filename>.ssh/identity</filename>
2705 In response to the 'Enter passphrase' question, just hit
2706 return (i.e. use an empty passphrase). The passphrase is
2707 a password that protects your private key. But it's a pain
2708 to type this passphrase everytime you use <Command>ssh</Command>, so the best
2709 thing to do is simply to protect your <filename>.ssh</filename> directory, and
2710 <filename>.ssh/identity</filename> from access by anyone else. To do this
2711 right-click your <filename>.ssh</filename> directory, and select Properties.
2712 If you are not on the access control list, add yourself, and
2713 give yourself full permissions (the second panel).
2714 Remove everyone else from the access control list. (Don't
2715 leave them there but deny them access, because 'they' may be
2716 a list that includes you!)
2720 If you have problems running <Command>ssh-keygen1</Command>
2721 from within <Command>bash</Command>, start up <filename>cmd.exe</filename> and run it as follows:
2725 c:\tmp> set CYGWIN32=tty
2726 c:\tmp> c:/user/local/bin/ssh-keygen1
2732 If you don't have an account on <Literal>cvs.haskell.org</Literal>, send
2733 your <filename>.ssh/identity.pub</filename> to the CVS repository administrator
2734 (currently Jeff Lewis <Email>jlewis@cse.ogi.edu</Email>). He will set up
2739 If you do have an account on <Literal>cvs.haskell.org</Literal>, use TeraTerm
2740 to logon to it. Once in, copy the
2741 key that <Command>ssh-keygen1</Command> deposited in <filename>/.ssh/identity.pub</filename> into
2742 your <filename>~/.ssh/authorized_keys</filename>. Make sure that the new version
2743 of <filename>authorized_keys</filename> still has 600 file permission.
2752 <Sect2><Title>Configuring CVS</Title>
2758 From the System control panel,
2759 set the following <Emphasis>user</Emphasis> environment variables (see the GHC user guide)
2765 <Constant>HOME</Constant>: points to your home directory. This is where CVS
2766 will look for its <filename>.cvsrc</filename> file.
2772 <Constant>CVS_RSH</Constant>: <filename>c:/path_to_ghc/extra-bin/ssh</filename>
2778 <Constant>CVSROOT</Constant>: <Literal>:ext:username@cvs.haskell.org:/home/cvs/root</Literal>,
2779 where <Literal>username</Literal> is your userid
2785 <Constant>CVSEDITOR</Constant>: <filename>bin/gnuclient.exe</filename> if you want to use an Emacs buffer for typing in those long commit messages.
2791 <Constant>SHELL</Constant>: To use bash as the shell in Emacs, you need to
2792 set this to point to <Filename>bash.exe</Filename>.
2801 Put the following in <filename>$HOME/.cvsrc</filename>:
2812 These are the default options for the specified CVS commands,
2813 and represent better defaults than the usual ones. (Feel
2814 free to change them.)
2818 Filenames starting with <filename>.</filename> were illegal in
2819 the 8.3 DOS filesystem, but that restriction should have
2820 been lifted by now (i.e., you're using VFAT or later filesystems.) If
2821 you're still having problems creating it, don't worry; <filename>.cvsrc</filename> is entirely
2828 Try doing <Command>cvs co fpconfig</Command>. All being well, bytes should
2829 start to trickle through, leaving a directory <filename>fptools</filename>
2830 in your current directory. (You can <Command>rm</Command> it if you don't
2831 want to keep it.) The following messages appear to be harmless:
2835 setsockopt IPTOS_LOWDELAY: Invalid argument
2836 setsockopt IPTOS_THROUGHPUT: Invalid argument
2840 At this point I found that CVS tried to invoke a little dialogue with
2841 me (along the lines of `do you want to talk to this host?'), but
2842 for some reason bombed out. This was from a bash shell running in Emacs.
2843 I solved this by invoking a Cygnus shell, and running CVS from there.
2844 Once things are dialogue free, it seems to work OK from within Emacs.
2850 If you want to check out part of large tree, proceed as follows:
2854 cvs -f checkout -l papers
2860 This sequence checks out the <Literal>papers</Literal> module, but none
2861 of its sub-directories.
2862 The "<Option>-l</Option>" flag says not to check out sub-directories.
2863 The "<Option>-f</Option>" flag says not to read the <filename>.cvsrc</filename> file
2864 whose <Option>-P</Option> default (don't check out empty directories) is
2869 The <Command>cvs update</Command> command sucks in a named sub-directory.
2876 There is a very nice graphical front-end to CVS for Win32 platforms,
2877 with a UI that people will be familiar with, at
2878 <ULink URL="http://www.wincvs.org/">wincvs.org</ULink>.
2879 I have not tried it yet.
2885 <Sect2><Title>Building GHC</Title>
2891 You should give the option
2892 <option>--host=i386-unknown-mingw32</option> to
2893 <command>autoconf</command>, so that it doesn't try to
2894 build for Cygwin (unless that's what you really
2895 want). Since it's possible to get into trouble using the
2896 wrong C compiler, it's wise either to avoid installing
2897 Cygwin gcc, or to explicitly specify
2898 <option>--with-gcc=/mingw/bin/gcc</option>.
2904 You have to run <Command>autoconf</Command> both in <filename>fptools</filename>
2905 and in <filename>fptools/ghc</filename>. If you omit the latter step you'll
2906 get an error when you run <filename>./configure</filename>:
2911 creating mk/config.h
2912 mk/config.h is unchanged
2914 running /bin/sh ./configure --cache-file=.././config.cache --srcdir=.
2915 ./configure: ./configure: No such file or directory
2916 configure: error: ./configure failed for ghc
2922 You need <filename>ghc</filename> to be in your <Constant>PATH</Constant> before you run
2923 <Command>configure</Command>. The InstallShield tells you the path
2924 when you install it.
2933 <title>Building the Windows InstallShield® Installer</title>
2936 This section is intended for GHC developers only; no-one else
2937 should need to build an InstallShield.
2941 Having built a second-stage tree and done <command>make
2942 install</command> on it, open the InstallShield
2943 (<filename>.ism</filename>) file. Open the Project screen, and
2944 then the Project subfolder of the Path variables folder, and
2945 set <literal>SourceFiles</literal> to the top of your
2946 tree. You might also need to set <literal>GHCBITS</literal> to
2947 point to the tree of various external bits that are added into
2948 the IS mix. You should then be able to build an InstallShield.
2952 <title>Extra features of the InstallShield</title>
2955 The InstallShield has some IS-specific twiddles:
2960 Two registry entries are set under
2961 <literal>HKEY_LOCAL_MACHINE\SOFTWARE\GHC</literal>:
2962 <literal>Path</literal> and
2963 <literal>Version</literal>, which record respectively
2964 the directory in which GHC was installed, and the
2970 The InstallShield adds some entries to the Program
2971 menu, for GHCi and for the documentation. See under
2972 Setup Design and the individual components (each
2973 component can add entries to the menu).
2981 <title>External add-ins</title>
2984 The external add-ins consist of Mingwin gcc and Mingwin
2985 Perl. The layout of the add-ins tree is as follows:
2990 perl.exe (Mingwin perl)
2993 Mingwin gcc binaries, libraries and headers
2996 imports for HDirect's com library
projects / ghc-hetmet.git / blob