X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=docs%2Fbuilding%2Fbuilding.sgml;h=bd5246c598cf56cd7461655577c95f2a0a60adcc;hp=dc6ea613cc689134cf97e565ff2df4f905b87196;hb=cab3c5cb1a0038412472172cb0b25bc81dfdde8f;hpb=eb34452a74582ab67fb88f37a8bd2f4b6547ee47 diff --git a/docs/building/building.sgml b/docs/building/building.sgml index dc6ea61..bd5246c 100644 --- a/docs/building/building.sgml +++ b/docs/building/building.sgml @@ -30,73 +30,38 @@ - Getting the Glasgow <Literal>fptools</Literal> suite + Getting the sources + + You can get your hands on the fptools + in two ways: - Building the Glasgow tools can be - complicated, mostly because there are so many permutations of - what/why/how, e.g., ``Build Happy with HBC, everything else with - GHC, leave out profiling, and test it all on the `real' NoFib - programs.'' Yeeps! - - Happily, such complications don't apply to most people. A - few common ``strategies'' serve most purposes. Pick one and - proceed as suggested: - - - - -Binary distributionBinary distribution. - - -If your only purpose is to install some of the -fptools suite then the easiest thing to do is to -get a binary distribution. In the binary distribution everything is -pre-compiled for your particular machine architecture and operating -system, so all you should have to do is install the binaries and -libraries in suitable places. The user guide describes how to do this. - - - -A binary distribution may not work for you for two reasons. First, we -may not have built the suite for the particular architecture/OS -platform you want. That may be due to lack of time and energy (in -which case you can get a source distribution and build from it; see -below). Alternatively, it may be because we haven't yet ported the -suite to your architecture, in which case you are considerably worse -off. - - - -The second reason a binary distribution may not be what you want is -if you want to read or modify the souce code. - - - -Source distributionSource distribution. - - -You have a supported -platform, but (a) you like the warm fuzzy feeling of compiling things -yourself; (b) you want to build something ``extra''—e.g., a set of -libraries with strictness-analysis turned off; or (c) you want to hack -on GHC yourself. - - - -A source distribution contains complete sources for one or more -projects in the fptools suite. Not only that, but -the more awkward machine-independent steps are done for you. For -example, if you don't have -happyhappy -you'll find it convenient that the source distribution contains the -result of running happy on the parser -specifications. If you don't want to alter the parser then this saves -you having to find and install happy. You will -still need a working version of GHC (preferably version 4.08+) on your -machine in order to compile (most of) the sources, however. - + - + + Source + distributionsSource distributions + + You have a supported platform, but (a) you like + the warm fuzzy feeling of compiling things yourself; + (b) you want to build something ``extra”—e.g., a + set of libraries with strictness-analysis turned off; or + (c) you want to hack on GHC yourself. + + A source distribution contains complete sources for + one or more projects in the fptools + suite. Not only that, but the more awkward + machine-independent steps are done for you. For example, if + you don't have + happyhappy + you'll find it convenient that the source distribution + contains the result of running happy on + the parser specifications. If you don't want to alter the + parser then this saves you having to find and install + happy. You will still need a working + version of GHC (preferably version 4.08+) on your machine in + order to compile (most of) the sources, however. + + The CVS repository. @@ -107,7 +72,7 @@ machine in order to compile (most of) the sources, however. up-to-the minute (but less tested) source code then you need to get access to our CVS repository. - All the fptools source code is held + All the fptools source code is held in a CVS repository. CVS is a pretty good source-code control system, and best of all it works over the network. @@ -120,33 +85,6 @@ machine in order to compile (most of) the sources, however. More information about our CVS repository can be found in . - - - - - - Build GHC from intermediate C .hc fileshc files: - - NOTE: GHC version 5.xx is significantly - harder to bootstrap from C than previous versions. We - recommend starting from version 4.08.2 if you need to - bootstrap in this way. - - You need a working GHC to use a source distribution. - What if you don't have a working GHC? Then you may be able - to bootstrap up from the intermediate C - (.hc) files that we provide. Building - GHC on an unsupported platform falls into this category. - Beware: this route is not for the faint hearted! Please see - . - - Once you have built GHC, you can build the other - Glasgow tools with it. - - In theory, you can (could?) build GHC with another - Haskell compiler (e.g., HBC). We haven't tried to do this - for ages and it almost certainly doesn't work any more (for - tedious reasons). @@ -302,24 +240,10 @@ machine in order to compile (most of) the sources, however. - [Windows users.] The programs ssh-keygen1, ssh1, and cvs, - seem to lock up bash entirely if they try to get user input (e.g. if - they ask for a password). To solve this, start up cmd.exe - and run it as follows: - - c:\tmp> set CYGWIN32=tty - c:\tmp> c:/user/local/bin/ssh-keygen1 - + Windows users: see the notes in about ssh wrinkles! + + - [Windows users.] To protect your - .ssh from access by anyone else, - right-click your .ssh directory, and - select Properties. If you are not on - the access control list, add yourself, and give yourself - full permissions (the second panel). Remove everyone else - from the access control list. Don't leave them there but - deny them access, because 'they' may be a list that - includes you! @@ -384,7 +308,7 @@ machine in order to compile (most of) the sources, however. $SHELL: To use bash as the shell in Emacs, you need to - set this to point to bash.exe. + set this to point to bash.exe. @@ -499,14 +423,19 @@ setsockopt IPTOS_THROUGHPUT: Invalid argument the fpconfig bit. $ cd directory - $ cvs checkout ghc hslibs + $ cvs checkout ghc hslibs libraries The second command here checks out the relevant modules you want to work on. For a GHC build, for instance, - you need at least the ghc and - hslibs modules (for a full list of the - projects available, see ). + you need at least the ghc, + hslibs and libraries + modules (for a full list of the projects available, see + ). + + Remember that if you do not have + happy installed, you need to check it out + as well. @@ -542,7 +471,14 @@ $ cvs diff you the results. - + + If you changed something in the + fptools/libraries subdirectories, also run + make html to check if the documentation can + be generated successfully, too. + + + Before checking in a change, you need to update your source tree: @@ -625,17 +561,25 @@ $ cvs commit -F commit-message directory major cause of headaches. So, to avoid a lot of hassle, follow this recipe for - updating your tree: + updating your tree: $ cd fptools -$ cvs update -Pd 2>&1 | tee log +$ cvs update -P 2>&1 | tee log Look at the log file, and fix any conflicts (denoted by a - C in the first column). If you're using multiple - build trees, then for every build tree you have pointing at this - source tree, you need to update the links in case any new files - have appeared: + C in the first column). New directories may have + appeared in the repository; CVS doesn't check these out by + default, so to get new directories you have to explicitly do + +$ cvs update -d + in each project subdirectory. Don't do this at the top level, + because then all the projects will be + checked out. + + If you're using multiple build trees, then for every build + tree you have pointing at this source tree, you need to update + the links in case any new files have appeared: $ cd build-tree @@ -797,11 +741,11 @@ $ cvs checkout nofib/spectral - green-card - green-cardproject + greencard + greencardproject The Green Card + url="http://www.haskell.org/greencard/">GreenCard system for generating Haskell foreign function interfaces. @@ -818,6 +762,16 @@ $ cvs checkout nofib/spectral + haddock + haddockproject + + The Haddock + documentation tool. + + + + happy happyproject @@ -850,7 +804,8 @@ $ cvs checkout nofib/spectral hslibs hslibsproject - GHC's libraries. Required for building GHC. + Supplemental libraries for GHC + (required for building GHC). @@ -859,7 +814,7 @@ $ cvs checkout nofib/spectral project Hierarchical Haskell library suite - (experimental). + (required for building GHC). @@ -891,9 +846,9 @@ $ cvs checkout nofib/spectral So, to build GHC you need at least the - ghc and hslibs projects (a - GHC source distribution will already include the bits you - need). + ghc, libraries and + hslibs projects (a GHC source distribution will + already include the bits you need). @@ -913,111 +868,98 @@ $ cvs checkout nofib/spectral - Use an appropriate machine, compilers, and things. - SPARC boxes, PCs running Linux or FreeBSD, and Alphas running - OSF/1 are all fully supported. Win32 and HP boxes are in - pretty good shape. PCs running Solaris, DEC Alphas running - Linux or some BSD variant, MIPS and AIX boxes will need some - minimal porting effort before they work (as of 4.06). gives the full run-down on ports or - lack thereof. + Use an appropriate machine / operating system. lists the supported platforms; if + yours isn't amongst these then you can try porting GHC (see + ). - Be sure that the ``pre-supposed'' utilities are + Be sure that the “pre-supposed” utilities are installed. elaborates. If you have any problem when building or installing the - Glasgow tools, please check the ``known pitfalls'' (). Also check the FAQ for the - version you're building, which should be available from the - relevant download page on the GHC web - site. + version you're building, which is part of the User's Guide and + available on the GHC web + site. - known bugs - bugs, known + bugsknown If you feel there is still some shortcoming in our procedure or instructions, please report it. - For GHC, please see the bug-reporting section of the GHC - Users' Guide (separate document), to maximise the usefulness - of your report. + For GHC, please see the bug-reporting + section of the GHC Users' Guide, to maximise the + usefulness of your report. bugsseporting - If in doubt, please send a message to -glasgow-haskell-bugs@haskell.org. -bugsmailing -list - + glasgow-haskell-bugs@haskell.org. + bugsmailing + list - -What machines the Glasgow tools run on - - - -ports, GHC -GHC ports -supported platforms -platforms, supported -The main question is whether or not the Haskell compiler (GHC) runs on -your platform. - - - -A ``platform'' is a architecture/manufacturer/operating-system -combination, such as sparc-sun-solaris2. Other common ones are -alpha-dec-osf2, hppa1.1-hp-hpux9, i386-unknown-linux, -i386-unknown-solaris2, i386-unknown-freebsd, -i386-unknown-cygwin32, m68k-sun-sunos4, mips-sgi-irix5, -sparc-sun-sunos4, sparc-sun-solaris2, powerpc-ibm-aix. - - - -Bear in mind that certain ``bundles'', e.g. parallel Haskell, may not -work on all machines for which basic Haskell compiling is supported. - + + What machines the Glasgow tools run on + +portsGHC +GHCports +platformssupported + + The main question is whether or not the Haskell compiler + (GHC) runs on your platform. + + A “platform” is a + architecture/manufacturer/operating-system combination, such as + sparc-sun-solaris2. Other common ones are + alpha-dec-osf2, + hppa1.1-hp-hpux9, + i386-unknown-linux, + i386-unknown-solaris2, + i386-unknown-freebsd, + i386-unknown-cygwin32, + m68k-sun-sunos4, + mips-sgi-irix5, + sparc-sun-sunos4, + sparc-sun-solaris2, + powerpc-ibm-aix. + + Some libraries may only work on a limited number of + platforms; for example, a sockets library is of no use unless the + operating system supports the underlying BSDisms. - -Some libraries may only work on a limited number of platforms; for -example, a sockets library is of no use unless the operating system -supports the underlying BSDisms. - + + What platforms the Haskell compiler (GHC) runs on - -What platforms the Haskell compiler (GHC) runs on + fully-supported platforms + native-code generator + registerised ports + unregisterised ports - -fully-supported platforms -native-code generator -registerised ports -unregisterised ports -The GHC hierarchy of Porting Goodness: (a) Best is a native-code -generator; (b) next best is a ``registerised'' -port; (c) the bare minimum is an ``unregisterised'' port. -(``Unregisterised'' is so terrible that we won't say more about it). - + The GHC hierarchy of Porting Goodness: (a) Best is a + native-code generator; (b) next best is a + “registerised” port; (c) the bare minimum is an + “unregisterised” port. + (“Unregisterised” is so terrible that we won't say + more about it). - -We use Sparcs running Solaris 2.7 and x86 boxes running FreeBSD and -Linux, so those are the best supported platforms, unsurprisingly. - + We use Sparcs running Solaris 2.7 and x86 boxes running + FreeBSD and Linux, so those are the best supported platforms, + unsurprisingly. - -Here's everything that's known about GHC ports. We identify platforms -by their ``canonical'' CPU/Manufacturer/OS triple. - + Here's everything that's known about GHC ports. We + identify platforms by their “canonical” + CPU/Manufacturer/OS triple. - alpha-dec-{osf,linux,freebsd,openbsd,netbsd}: alpha-dec-osf @@ -1047,8 +989,8 @@ by their ``canonical'' CPU/Manufacturer/OS triple. sparc-sun-solaris2 sparc-sun-solaris2 - Fully supported, including native-code - generator. + Fully supported (at least for Solaris 2.7), + including native-code generator. @@ -1056,8 +998,9 @@ by their ``canonical'' CPU/Manufacturer/OS triple. hppa1.1-hp-hpux (HP-PA boxes running HPUX 9.x) hppa1.1-hp-hpux - Works registerised. No native-code - generator. + A registerised port is available for version 4.08, + but GHC hasn't been built on that platform since (as far + as we know). No native-code generator. @@ -1078,36 +1021,56 @@ by their ``canonical'' CPU/Manufacturer/OS triple. - i386-unknown-freebsd (PCs running FreeBSD 2.2 -or higher) + i386-unknown-freebsd (PCs running FreeBSD 2.2 or + higher) i386-unknown-freebsd GHC works registerised. Pre-built packages are available in the native package format, so if you just need binaries you're better off just installing the - package. + package (it might even be on your installation + CD!). - + - i386-unknown-{netbsd,openbsd) (PCs running NetBSD - and OpenBSD) - i386-unknown-netbsd + i386-unknown-openbsd (PCs running OpenBSD) i386-unknown-openbsd + Supported, with native code generator. Packages are + available through the ports system in the native package + format. + + + + + i386-unknown-netbsd (PCs running NetBSD and + OpenBSD) + i386-unknown-netbsd + Will require some minor porting effort, but should work registerised. - i386-unknown-mingw32: + i386-unknown-mingw32 (PCs running Windows) i386-unknown-mingw32 Fully supported under Win9x, WinNT, Win2k, and WinXP. Includes a native code generator. Building from - source requires a recent cygwin32 - distribution to be installed. + source requires a recent Cygwin distribution + to be installed. + + + + + ia64-unknown-linux + ia64-unknown-linux + + GHC currently works unregisterised. A registerised + port is in progress. @@ -1115,10 +1078,11 @@ or higher) mips-sgi-irix5 mips-sgi-irix[5-6] - Port currently doesn't work, needs some minimal - porting effort. As usual, we don't have access to - machines and there hasn't been an overwhelming demand for - this port, but feel free to get in touch. + Port has worked in the past, but hasn't been tested + for some time (and will certainly have rotted in various + ways). As usual, we don't have access to machines and + there hasn't been an overwhelming demand for this port, + but feel free to get in touch. @@ -1137,7 +1101,16 @@ or higher) powerpc-apple-darwin powerpc-apple-darwin - Works, unregisterised only at the moment. + Supported registerised. No native code + generator. + + + + + powerpc-apple-linux + powerpc-apple-linux + + Not supported (yet). @@ -1157,613 +1130,589 @@ or higher) - -Installing pre-supposed utilities + <sect1 id="sec-pre-supposed"> + <title>Installing pre-supposed utilities -pre-supposed utilities -utilities, pre-supposed + pre-supposed utilities + utilities, pre-supposed - -Here are the gory details about some utility programs you may need; -perl, gcc and -happy are the only important -ones. (PVMPVM is important -if you're going for Parallel Haskell.) The -configureconfigure -script will tell you if you are missing something. - + Here are the gory details about some utility programs you + may need; perl, gcc and + happy are the only important + ones. (PVMPVM is + important if you're going for Parallel Haskell.) The + configureconfigure + script will tell you if you are missing something. - - + - -Perl: -pre-supposed: Perl -Perl, pre-supposed - - -You have to have Perl to proceed! Perl version 5 -at least is required. GHC has been known to tickle bugs in Perl, so -if you find that Perl crashes when running GHC try updating (or -downgrading) your Perl installation. Versions of Perl that we use and -are known to be fairly stable are 5.005 and 5.6.1. - + + GHC + pre-supposed: GHC + GHC, pre-supposed + + GHC is required to build many of the tools, including + GHC itself. If you need to port GHC to your platform + because there isn't a binary distribution of GHC available, + then see . + + Which version of GHC you need will depend on the + packages you intend to build. GHC itself will normally + build using one of several older versions of itself - check + the announcement or release notes for details. + + - -For Win32 platforms, you should use the binary supplied in the -InstallShield (copy it to /bin). The -Cygwin-supplied Perl seems not to work. - + + Perl + pre-supposed: Perl + Perl, pre-supposed + + You have to have Perl to proceed! + Perl version 5 at least is required. GHC has been known to + tickle bugs in Perl, so if you find that Perl crashes when + running GHC try updating (or downgrading) your Perl + installation. Versions of Perl that we use and are known to + be fairly stable are 5.005 and 5.6.1. + + For Win32 platforms, you should use the binary + supplied in the InstallShield (copy it to + /bin). The Cygwin-supplied Perl seems + not to work. + + Perl should be put somewhere so that it can be invoked + by the #! script-invoking + mechanism. The full pathname may need to be less than 32 + characters long on some systems. + + - -Perl should be put somewhere so that it can be invoked by the -#! script-invoking mechanism. The full -pathname may need to be less than 32 characters long on some -systems. - + + GNU C (gcc) + pre-supposed: GCC (GNU C + compiler) GCC (GNU C + compiler), pre-supposed + + We recommend using GCC version 2.95.2 on all + platforms. Failing that, version 2.7.2 is stable on most + platforms. Earlier versions of GCC can be assumed not to + work, and versions in between 2.7.2 and 2.95.2 (including + egcs) have varying degrees of stability + depending on the platform. + + GCC 3.2 is currently known to have problems building + GHC on Sparc, but is stable on x86. + + GCC 3.3 currently cannot be used to build GHC, due to + some problems with the new C preprocessor. + + If your GCC dies with “internal error” on + some GHC source file, please let us know, so we can report + it and get things improved. (Exception: on iX86 + boxes—you may need to fiddle with GHC's + option; see the User's + Guide) + + - - -GNU C (gcc): -pre-supposed: GCC (GNU C compiler) -GCC (GNU C compiler), pre-supposed - + + GNU Make + makeGNU + + + The fptools build system makes heavy use of features + specific to GNU make, so you must have + this installed in order to build any of the fptools + suite. + + - -We recommend using GCC version 2.95.2 on all platforms. Failing that, -version 2.7.2 is stable on most platforms. Earlier versions of GCC -can be assumed not to work, and versions in between 2.7.2 and 2.95.2 -(including egcs) have varying degrees of stability -depending on the platform. - + + Happy + Happy + + Happy is a parser generator tool for Haskell, and is + used to generate GHC's parsers. Happy is written in + Haskell, and is a project in the CVS repository + (fptools/happy). It can be built from + source, but bear in mind that you'll need GHC installed in + order to build it. To avoid the chicken/egg problem, + install a binary distribution of either Happy or GHC to get + started. Happy distributions are available from Happy's Web + Page. + + - -If your GCC dies with ``internal error'' on some GHC source file, -please let us know, so we can report it and get things improved. -(Exception: on iX86 boxes—you may need to fiddle with GHC's - option; see the User's Guide) - - + + Autoconf + pre-supposed: Autoconf + Autoconf, pre-supposed + + GNU Autoconf is needed if you intend to build from the + CVS sources, it is not needed if you + just intend to build a standard source distribution. + + Version 2.52 or later of autoconf is required. + NB. vesrion 2.13 will no longer work, as of GHC version + 6.1. + + Autoconf builds the configure + script from configure.ac and + aclocal.m4. If you modify either of + these files, you'll need autoconf to + rebuild configure. + + - -Happy: -Happy - -Happy is a parser generator tool for Haskell, and is used to -generate GHC's parsers. Happy is written in Haskell, and is a project -in the CVS repository (fptools/happy). It can be -built from source, but bear in mind that you'll need GHC installed in -order to build it. To avoid the chicken/egg problem, install a binary -distribtion of either Happy or GHC to get started. Happy -distributions are available from Happy's Web Page. - - - + + sed + pre-supposed: sed + sed, pre-supposed + + You need a working sed if you are + going to build from sources. The build-configuration stuff + needs it. GNU sed version 2.0.4 is no good! It has a bug + in it that is tickled by the build-configuration. 2.0.5 is + OK. Others are probably OK too (assuming we don't create too + elaborate configure scripts.) + + + - -Autoconf: -pre-supposed: Autoconf -Autoconf, pre-supposed - - -GNU Autoconf is needed if you intend to build from the CVS sources, it -is not needed if you just intend to build a -standard source distribution. - + One fptools project is worth a quick note + at this point, because it is useful for all the others: + glafp-utils contains several utilities which + aren't particularly Glasgow-ish, but Occasionally Indispensable. + Like lndir for creating symbolic link + trees. - -Autoconf builds the configure script from -configure.in and aclocal.m4. -If you modify either of these files, you'll need -autoconf to rebuild configure. - + + Tools for building parallel GHC (GPH) - - -sed -pre-supposed: sed -sed, pre-supposed - - -You need a working sed if you are going to build -from sources. The build-configuration stuff needs it. GNU sed -version 2.0.4 is no good! It has a bug in it that is tickled by the -build-configuration. 2.0.5 is OK. Others are probably OK too -(assuming we don't create too elaborate configure scripts.) - - - - + + + PVM version 3: + pre-supposed: PVM3 (Parallel Virtual Machine) + PVM3 (Parallel Virtual Machine), pre-supposed + + PVM is the Parallel Virtual Machine on which + Parallel Haskell programs run. (You only need this if you + plan to run Parallel Haskell. Concurrent Haskell, which + runs concurrent threads on a uniprocessor doesn't need + it.) Underneath PVM, you can have (for example) a network + of workstations (slow) or a multiprocessor box + (faster). + + The current version of PVM is 3.3.11; we use 3.3.7. + It is readily available on the net; I think I got it from + research.att.com, in + netlib. + + A PVM installation is slightly quirky, but easy to + do. Just follow the Readme + instructions. + + - -One fptools project is worth a quick note at this -point, because it is useful for all the others: -glafp-utils contains several utilities which aren't -particularly Glasgow-ish, but Occasionally Indispensable. Like -lndir for creating symbolic link trees. - + + bash: + bash, presupposed (Parallel Haskell only) + + Sadly, the gr2ps script, used to + convert “parallelism profiles” to PostScript, + is written in Bash (GNU's Bourne Again shell). This bug + will be fixed (someday). + + + + - -Tools for building parallel GHC (GPH) - + + Other useful tools - - + + + Flex + pre-supposed: flex + flex, pre-supposed + + This is a quite-a-bit-better-than-Lex lexer. Used + to build a couple of utilities in + glafp-utils. Depending on your + operating system, the supplied lex may + or may not work; you should get the GNU version. + + + - -PVM version 3: -pre-supposed: PVM3 (Parallel Virtual Machine) -PVM3 (Parallel Virtual Machine), pre-supposed - + More tools are required if you want to format the documentation + that comes with GHC and other fptools projects. See . + + - -PVM is the Parallel Virtual Machine on which Parallel Haskell programs -run. (You only need this if you plan to run Parallel Haskell. -Concurent Haskell, which runs concurrent threads on a uniprocessor -doesn't need it.) Underneath PVM, you can have (for example) a -network of workstations (slow) or a multiprocessor box (faster). - + + Building from source - -The current version of PVM is 3.3.11; we use 3.3.7. It is readily -available on the net; I think I got it from -research.att.com, in netlib. - + Building from source + Source, building from - -A PVM installation is slightly quirky, but easy to do. Just follow -the Readme instructions. - - - -bash: -bash, presupposed (Parallel Haskell only) - - -Sadly, the gr2ps script, used to convert ``parallelism profiles'' -to PostScript, is written in Bash (GNU's Bourne Again shell). -This bug will be fixed (someday). - - - - + You've been rash enough to want to build some of the Glasgow + Functional Programming tools (GHC, Happy, nofib, etc.) from + source. You've slurped the source, from the CVS repository or + from a source distribution, and now you're sitting looking at a + huge mound of bits, wondering what to do next. - + Gingerly, you type make. Wrong + already! - -Tools for building the Documentation - + This rest of this guide is intended for duffers like me, who + aren't really interested in Makefiles and systems configurations, + but who need a mental model of the interlocking pieces so that + they can make them work, extend them consistently when adding new + software, and lay hands on them gently when they don't + work. - -The following additional tools are required if you want to format the -documentation that comes with the fptools projects: - + + Quick Start - - + If you are starting from a source distribution, and just + want a completely standard build, then the following should + work: - -DocBook: -pre-supposed: DocBook -DocBook, pre-supposed - - -All our documentation is written in SGML, using the DocBook DTD. -Instructions on installing and configuring the DocBook tools are in the -installation guide (in the GHC user guide). - +$ ./configure +$ make +$ make install + - - -TeX: -pre-supposed: TeX -TeX, pre-supposed - - -A decent TeX distribution is required if you want to produce printable -documentation. We recomment teTeX, which includes just about -everything you need. - - - - + For GHC, this will do a 2-stage bootstrap build of the + compiler, with profiling libraries, and install the + results. - - In order to actually build any documentation, you need to set - SGMLDocWays in your - build.mk. Valid values to add to this - list are: dvi, ps, - pdf, html, and - rtf. - - - + If you want to do anything at all non-standard, or you + want to do some development, read on... + - -Other useful tools - + + Your source tree - - -Flex: -pre-supposed: flex -flex, pre-supposed - + The source code is held in your source + tree. The root directory of your source tree + must contain the following directories and + files: - -This is a quite-a-bit-better-than-Lex lexer. Used to build a couple -of utilities in glafp-utils. Depending on your -operating system, the supplied lex may or may not -work; you should get the GNU version. - - - + + + Makefile: the root + Makefile. + - + + mk/: the directory that contains + the main Makefile code, shared by all the + fptools software. + - + + configure.ac, + config.sub, + config.guess: these files support the + configuration process. + - -Building from source + <listitem> + <para><filename>install-sh</filename>.</para> + </listitem> + </itemizedlist> -<indexterm><primary>Building from source</primary></indexterm> -<indexterm><primary>Source, building from</primary></indexterm> + All the other directories are individual + projects of the fptools + system—for example, the Glasgow Haskell Compiler + (ghc), the Happy parser generator + (happy), the nofib + benchmark suite, and so on. You can have zero or more of these. + Needless to say, some of them are needed to build others. + + The important thing to remember is that even if you want + only one project (happy, say), you must have + a source tree whose root directory contains + Makefile, mk/, + configure.ac, and the project(s) you want + (happy/ in this case). You cannot get by + with just the happy/ directory. + - -You've been rash enough to want to build some of -the Glasgow Functional Programming tools (GHC, Happy, -nofib, etc.) from source. You've slurped the source, -from the CVS repository or from a source distribution, and -now you're sitting looking at a huge mound of bits, wondering -what to do next. - + + Build trees + build trees + link trees, for building + + If you just want to build the software once on a single + platform, then your source tree can also be your build tree, and + you can skip the rest of this section. + + We often want to build multiple versions of our software + for different architectures, or with different options + (e.g. profiling). It's very desirable to share a single copy of + the source code among all these builds. + + So for every source tree we have zero or more + build trees. Each build tree is initially + an exact copy of the source tree, except that each file is a + symbolic link to the source file, rather than being a copy of + the source file. There are “standard” Unix + utilities that make such copies, so standard that they go by + different names: + lndirlndir, + mkshadowdirmkshadowdir + are two (If you don't have either, the source distribution + includes sources for the X11 + lndir—check out + fptools/glafp-utils/lndir). See for a typical invocation. + + The build tree does not need to be anywhere near the + source tree in the file system. Indeed, one advantage of + separating the build tree from the source is that the build tree + can be placed in a non-backed-up partition, saving your systems + support people from backing up untold megabytes of + easily-regenerated, and rapidly-changing, gubbins. The golden + rule is that (with a single exception—) absolutely everything in + the build tree is either a symbolic link to the source tree, or + else is mechanically generated. It should be + perfectly OK for your build tree to vanish overnight; an hour or + two compiling and you're on the road again. + + You need to be a bit careful, though, that any new files + you create (if you do any development work) are in the source + tree, not a build tree! + + Remember, that the source files in the build tree are + symbolic links to the files in the source + tree. (The build tree soon accumulates lots of built files like + Foo.o, as well.) You can + delete a source file from the build tree + without affecting the source tree (though it's an odd thing to + do). On the other hand, if you edit a + source file from the build tree, you'll edit the source-tree + file directly. (You can set up Emacs so that if you edit a + source file from the build tree, Emacs will silently create an + edited copy of the source file in the build tree, leaving the + source file unchanged; but the danger is that you think you've + edited the source file whereas actually all you've done is edit + the build-tree copy. More commonly you do want to edit the + source file.) + + Like the source tree, the top level of your build tree + must be (a linked copy of) the root directory of the + fptools suite. Inside Makefiles, the root of + your build tree is called + $(FPTOOLS_TOP)FPTOOLS_TOP. + In the rest of this document path names are relative to + $(FPTOOLS_TOP) unless + otherwise stated. For example, the file + ghc/mk/target.mk is actually + $(FPTOOLS_TOP)/ghc/mk/target.mk. + - -Gingerly, you type make. Wrong already! - + + Getting the build you want + + When you build fptools you will be + compiling code on a particular host + platform, to run on a particular target + platform (usually the same as the host + platform)platform. + The difficulty is that there are minor differences between + different platforms; minor, but enough that the code needs to be + a bit different for each. There are some big differences too: + for a different architecture we need to build GHC with a + different native-code generator. + + There are also knobs you can turn to control how the + fptools software is built. For example, you + might want to build GHC optimised (so that it runs fast) or + unoptimised (so that you can compile it fast after you've + modified it. Or, you might want to compile it with debugging on + (so that extra consistency-checking code gets included) or off. + And so on. + + All of this stuff is called the + configuration of your build. You set the + configuration using a three-step process. - -This rest of this guide is intended for duffers like me, who aren't -really interested in Makefiles and systems configurations, but who -need a mental model of the interlocking pieces so that they can make -them work, extend them consistently when adding new software, and lay -hands on them gently when they don't work. - + + + Step 1: get ready for configuration. + + NOTE: if you're starting from a source distribution, + rather than CVS sources, you can skip this step. + + Change directory to + $(FPTOOLS_TOP) and + issue the command + autoconfautoconf + (with no arguments). This GNU program converts + $(FPTOOLS_TOP)/configure.ac + to a shell script called + $(FPTOOLS_TOP)/configure. + + + Some projects, including GHC, have their own + configure script. If there's an + $(FPTOOLS_TOP)/<project>/configure.ac, + then you need to run autoconf in that + directory too. + + Both these steps are completely + platform-independent; they just mean that the + human-written file (configure.ac) can + be short, although the resulting shell script, + configure, and + mk/config.h.in, are long. + + - -Your source tree - + + Step 2: system configuration. + + Runs the newly-created configure + script, thus: - -The source code is held in your source tree. -The root directory of your source tree must -contain the following directories and files: - + +./configure args + - + configure's mission is to scurry + round your computer working out what architecture it has, + what operating system, whether it has the + vfork system call, where + tar is kept, whether + gcc is available, where various obscure + #include files are, whether it's a + leap year, and what the systems manager had for lunch. It + communicates these snippets of information in two + ways: - - + + + + It translates + mk/config.mk.inconfig.mk.in + to + mk/config.mkconfig.mk, + substituting for things between + “@” brackets. So, + “@HaveGcc@” will be + replaced by “YES” or + “NO” depending on what + configure finds. + mk/config.mk is included by every + Makefile (directly or indirectly), so the + configuration information is thereby communicated to + all Makefiles. + - -Makefile: the root Makefile. - - - - - -mk/: the directory that contains the -main Makefile code, shared by all the -fptools software. - - - - - - configure.in, config.sub, config.guess: -these files support the configuration process. - - - - - - install-sh. - - - - - - - - -All the other directories are individual projects of the -fptools system—for example, the Glasgow Haskell Compiler -(ghc), the Happy parser generator (happy), the nofib benchmark -suite, and so on. You can have zero or more of these. Needless to -say, some of them are needed to build others. - - - -The important thing to remember is that even if you want only one -project (happy, say), you must have a source tree whose root -directory contains Makefile, mk/, configure.in, and the -project(s) you want (happy/ in this case). You cannot get by with -just the happy/ directory. - - - - - -Build trees -<indexterm><primary>build trees</primary></indexterm> -<indexterm><primary>link trees, for building</primary></indexterm> - - -While you can build a system in the source tree, we don't recommend it. -We often want to build multiple versions of our software -for different architectures, or with different options (e.g. profiling). -It's very desirable to share a single copy of the source code among -all these builds. - - - -So for every source tree we have zero or more build trees. Each -build tree is initially an exact copy of the source tree, except that -each file is a symbolic link to the source file, rather than being a -copy of the source file. There are ``standard'' Unix utilities that -make such copies, so standard that they go by different names: -lndirlndir, mkshadowdirmkshadowdir are two (If you -don't have either, the source distribution includes sources for the -X11 lndir—check out fptools/glafp-utils/lndir). See for a typical invocation. - - - -The build tree does not need to be anywhere near the source tree in -the file system. Indeed, one advantage of separating the build tree -from the source is that the build tree can be placed in a -non-backed-up partition, saving your systems support people from -backing up untold megabytes of easily-regenerated, and -rapidly-changing, gubbins. The golden rule is that (with a single -exception—) -absolutely everything in the build tree is either a symbolic -link to the source tree, or else is mechanically generated. -It should be perfectly OK for your build tree to vanish overnight; an -hour or two compiling and you're on the road again. - - - -You need to be a bit careful, though, that any new files you create -(if you do any development work) are in the source tree, not a build tree! - - - -Remember, that the source files in the build tree are symbolic -links to the files in the source tree. (The build tree soon -accumulates lots of built files like Foo.o, as well.) You -can delete a source file from the build tree without affecting -the source tree (though it's an odd thing to do). On the other hand, -if you edit a source file from the build tree, you'll edit the -source-tree file directly. (You can set up Emacs so that if you edit -a source file from the build tree, Emacs will silently create an -edited copy of the source file in the build tree, leaving the source -file unchanged; but the danger is that you think you've edited the -source file whereas actually all you've done is edit the build-tree -copy. More commonly you do want to edit the source file.) - - - -Like the source tree, the top level of your build tree must be (a -linked copy of) the root directory of the fptools suite. Inside -Makefiles, the root of your build tree is called -$(FPTOOLS_TOP)FPTOOLS_TOP. In the rest of this document path -names are relative to $(FPTOOLS_TOP) unless otherwise stated. For -example, the file ghc/mk/target.mk is actually -$(FPTOOLS_TOP)/ghc/mk/target.mk. - - - - - -Getting the build you want - - - -When you build fptools you will be compiling code on a particular -host platform, to run on a particular target platform -(usually the same as the host platform)platform. The -difficulty is that there are minor differences between different -platforms; minor, but enough that the code needs to be a bit different -for each. There are some big differences too: for a different -architecture we need to build GHC with a different native-code -generator. - - - -There are also knobs you can turn to control how the fptools -software is built. For example, you might want to build GHC optimised -(so that it runs fast) or unoptimised (so that you can compile it fast -after you've modified it. Or, you might want to compile it with -debugging on (so that extra consistency-checking code gets included) -or off. And so on. - - - -All of this stuff is called the configuration of your build. -You set the configuration using a three-step process. - - - -Step 1: get ready for configuration. - - Change directory to - $(FPTOOLS_TOP) and - issue the command - autoconfautoconf - (with no arguments). This GNU program converts - $(FPTOOLS_TOP)/configure.in - to a shell script called - $(FPTOOLS_TOP)/configure. - - - Some projects, including GHC, have their own - configure script. If there's an - $(FPTOOLS_TOP)/<project>/configure.in, - then you need to run autoconf in that - directory too. - - Both these steps are completely - platform-independent; they just mean that the - human-written file (configure.in) - can be short, although the resulting shell script, - configure, and - mk/config.h.in, are long. - - In case you don't have autoconf - we distribute the results, configure, - and mk/config.h.in, with the source - distribution. They aren't kept in the repository, - though. - - - - - Step 2: system configuration. - - Runs the newly-created - configure script, thus: + + It translates + mk/config.h.inconfig.h.in + to + mk/config.hconfig.h. + The latter is #included by + various C programs, which can thereby make use of + configuration information. + + - -./configure args - + configure takes some optional + arguments. Use ./configure --help to + get a list of the available arguments. Here are some of + the ones you might need: - configure's mission is to - scurry round your computer working out what architecture - it has, what operating system, whether it has the - vfork system call, where - yacc is kept, whether - gcc is available, where various - obscure #include files are, - whether it's a leap year, and what the systems manager - had for lunch. It communicates these snippets of - information in two ways: - - + + + --with-ghc=path + --with-ghc + - - It translates - mk/config.mk.inconfig.mk.in - to - mk/config.mkconfig.mk, - substituting for things between - ``@'' brackets. So, - ``@HaveGcc@'' will be replaced by - ``YES'' or - ``NO'' depending on what - configure finds. - mk/config.mk is included by - every Makefile (directly or indirectly), so the - configuration information is thereby communicated to - all Makefiles. + Specifies the path to an installed GHC which + you would like to use. This compiler will be used + for compiling GHC-specific code (eg. GHC itself). + This option cannot be specified + using build.mk (see later), + because configure needs to + auto-detect the version of GHC you're using. The + default is to look for a compiler named + ghc in your path. - + + + + --with-hc=path + --with-hc + - It translates - mk/config.h.inconfig.h.in - to - mk/config.hconfig.h. - The latter is #included by - various C programs, which can thereby make use of - configuration information. + Specifies the path to any installed Haskell + compiler. This compiler will be used for compiling + generic Haskell code. The default is to use + ghc. - - - configure takes some optional - arguments. Use ./configure --help to - get a list of the available arguments. Here are some of - the ones you might need: - - - - --with-ghc=path - --with-ghc - - - Specifies the path to an installed GHC which - you would like to use. This compiler will be used - for compiling GHC-specific code (eg. GHC itself). - This option cannot be - specified using build.mk (see - later), because configure needs - to auto-detect the version of GHC you're using. - The default is to look for a compiler named - ghc in your path. - - - - - --with-hc=path - --with-hc - - - Specifies the path to any installed Haskell - compiler. This compiler will be used for - compiling generic Haskell code. The default is to - use ghc. - - - - - --with-gcc=path - --with-gcc - - - Specifies the path to the installed - GCC. This compiler will be used to compile all C - files, except any generated - by the installed Haskell compiler, which will have - its own idea of which C compiler (if any) to use. - The default is to use gcc. - - - - - configure caches the results of - its run in config.cache. Quite - often you don't want that; you're running - configure a second time because - something has changed. In that case, simply delete - config.cache. - - - - -Step 3: build configuration. - - -Next, you say how this build of fptools is to differ from the -standard defaults by creating a new file mk/build.mkbuild.mk -in the build tree. This file is the one and only file you edit -in the build tree, precisely because it says how this build differs -from the source. (Just in case your build tree does die, you might -want to keep a private directory of build.mk files, and use a -symbolic link in each build tree to point to the appropriate one.) So -mk/build.mk never exists in the source tree—you create one in -each build tree from the template. We'll discuss what to put in it -shortly. - - - - + + + + --with-gcc=path + --with-gcc + + + Specifies the path to the installed GCC. This + compiler will be used to compile all C files, + except any generated by the + installed Haskell compiler, which will have its own + idea of which C compiler (if any) to use. The + default is to use gcc. + + + + + configure caches the results of + its run in config.cache. Quite often + you don't want that; you're running + configure a second time because + something has changed. In that case, simply delete + config.cache. + + + + + Step 3: build configuration. + + Next, you say how this build of + fptools is to differ from the standard + defaults by creating a new file + mk/build.mkbuild.mk + in the build tree. This file is the + one and only file you edit in the build tree, precisely + because it says how this build differs from the source. + (Just in case your build tree does die, you might want to + keep a private directory of build.mk + files, and use a symbolic link in each build tree to point + to the appropriate one.) So + mk/build.mk never exists in the + source tree—you create one in each build tree from + the template. We'll discuss what to put in it + shortly. + + + - -And that's it for configuration. Simple, eh? - + And that's it for configuration. Simple, eh? What do you put in your build-specific configuration file - mk/build.mk? For almost all + mk/build.mk? For almost all purposes all you will do is put make variable definitions that - override those in + override those in mk/config.mk.in. The whole point of mk/config.mk.in—and its derived counterpart mk/config.mk—is to define @@ -1777,6 +1726,9 @@ And that's it for configuration. Simple, eh? includes build.mk after config.mk.) + For your convenience, there's a file called build.mk.sample + that can serve as a starting point for your build.mk. + For example, config.mk.in contains the definition: @@ -1789,15 +1741,15 @@ GhcHcOpts=-O -Rghc-timing development, it is wise to add -DDEBUG, to enable debugging code. So you would add the following to build.mk: - + or, if you prefer, GhcHcOpts += -DDEBUG - GNU make allows existing definitions to - have new text appended using the ``+='' + GNU make allows existing definitions to + have new text appended using the “+=” operator, which is quite a convenient feature.) If you want to remove the -O as well (a @@ -1810,42 +1762,42 @@ GhcHcOpts=-DDEBUG -Rghc-timing When reading config.mk.in, remember - that anything between ``@...@'' signs is going to be substituted - by configure later. You - can override the resulting definition if + that anything between “@...@” signs is going to be substituted + by configure later. You + can override the resulting definition if you want, but you need to be a bit surer what you are doing. For example, there's a line that says: -YACC = @YaccCmd@ +TAR = @TarCmd@ - This defines the Make variables YACC - to the pathname for a yacc that - configure finds somewhere. If you have your - own pet yacc you want to use instead, that's + This defines the Make variables TAR + to the pathname for a tar that + configure finds somewhere. If you have your + own pet tar you want to use instead, that's fine. Just add this line to mk/build.mk: -YACC = myyacc +TAR = mytar - You do not have to have a + You do not have to have a mk/build.mk file at all; if you don't, you'll get all the default settings from mk/config.mk.in. You can also use build.mk to override - anything that configure got wrong. One place + anything that configure got wrong. One place where this happens often is with the definition of FPTOOLS_TOP_ABS: this variable is supposed to be the canonical path to the top of your source tree, but if your system uses an automounter then the correct directory is hard to find automatically. If you find - that configure has got it wrong, just put the + that configure has got it wrong, just put the correct definition in build.mk. - + The story so far @@ -1865,15 +1817,15 @@ YACC = myyacc - (Optional) Use lndir or - mkshadowdir to create a build tree. + (Optional) Use lndir or + mkshadowdir to create a build tree. $ cd myfptools $ mkshadowdir . /scratch/joe-bloggs/myfptools-sun4 - (N.B. mkshadowdir's first argument + (N.B. mkshadowdir's first argument is taken relative to its second.) You probably want to give the build tree a name that suggests its main defining characteristic (in your mind at least), in case you later @@ -1939,306 +1891,385 @@ $ emacs mk/build.mk mk/build.mk as often as you like. You do not have to run any further configuration programs to make these changes take effect. In theory you should, however, say - gmake clean, gmake all, + gmake clean, gmake all, because configuration option changes could affect anything—but in practice you are likely to know what's affected. - Making things + Making things At this point you have made yourself a fully-configured build tree, so you are ready to start building real things. - The first thing you need to know is that you - must use GNU make, usually called - gmake, not standard Unix - make. If you use standard Unix - make you will get all sorts of error messages - (but no damage) because the fptools - Makefiles use GNU make's + The first thing you need to know is that you + must use GNU make, usually called + gmake, not standard Unix + make. If you use standard Unix + make you will get all sorts of error messages + (but no damage) because the fptools + Makefiles use GNU make's facilities extensively. To just build the whole thing, cd to the top of your fptools tree and type gmake. This will prepare the tree and build the various projects in the correct order. + - - - - Standard Targets - targets, standard makefile - makefile targets - - In any directory you should be able to make the following: + + Bootstrapping GHC + + GHC requires a 2-stage bootstrap in order to provide + full functionality, including GHCi. By a 2-stage bootstrap, we + mean that the compiler is built once using the installed GHC, + and then again using the compiler built in the first stage. You + can also build a stage 3 compiler, but this normally isn't + necessary except to verify that the stage 2 compiler is working + properly. + + Note that when doing a bootstrap, the stage 1 compiler + must be built, followed by the runtime system and libraries, and + then the stage 2 compiler. The correct ordering is implemented + by the top-level fptools Makefile, so if + you want everything to work automatically it's best to start + make from the top of the tree. When building + GHC, the top-level fptools Makefile is set + up to do a 2-stage bootstrap by default (when you say + make). Some other targets it supports + are: - + + + stage1 + + Build everything as normal, including the stage 1 + compiler. + + - -boot: - -does the one-off preparation required to get ready for the real -work. Notably, it does gmake depend in all -directories that contain programs. It also builds the necessary tools -for compilation to proceed. - -Invoking the boot target explicitly is not -normally necessary. From the top-level fptools -directory, invoking gmake causes gmake -boot all to be invoked in each of the project -subdirectories, in the order specified by -$(AllTargets) in -config.mk. - -If you're working in a subdirectory somewhere and need to update -the dependencies, gmake boot is a good way to do it. - - - -all: - - -makes all the final target(s) for this Makefile. -Depending on which directory you are in a ``final target'' may be an -executable program, a library archive, a shell script, or a Postscript -file. Typing gmake alone is generally the same as typing gmake all. - - - -install: - - -installs the things built by all (except for the documentation). Where does it -install them? That is specified by -mk/config.mk.in; you can override it in -mk/build.mk, or by running -configure with command-line arguments like ---bindir=/home/simonpj/bin; see ./configure ---help for the full details. - - - -install-docs: - - -installs the documentation. Otherwise behaves just like install. - - - -uninstall: - - -reverses the effect of install. - - + + stage2 + + Build the stage 2 compiler only. + + - -clean: - - -Delete all files from the current directory that are normally created -by building the program. Don't delete the files that record the -configuration, or files generated by gmake boot. -Also preserve files that could be made by building, but normally -aren't because the distribution comes with them. - - - -distclean: - -Delete all files from the current directory that are created by -configuring or building the program. If you have unpacked the source -and built the program without creating any other files, make -distclean should leave only the files that were in the -distribution. - - + + stage3 + + Build the stage 3 compiler only. + + - -mostlyclean: - -Like clean, but may refrain from deleting a -few files that people normally don't want to recompile. - - + + bootstrap bootstrap2 + + Build stage 1 followed by stage 2. + + - -maintainer-clean: - - -Delete everything from the current directory that can be reconstructed -with this Makefile. This typically includes everything deleted by -distclean, plus more: C source files produced by -Bison, tags tables, Info files, and so on. - -One exception, however: make maintainer-clean -should not delete configure even if -configure can be remade using a rule in the -Makefile. More generally, make -maintainer-clean should not delete anything that needs to -exist in order to run configure and then begin to -build the program. - - + + bootstrap3 + + Build stages 1, 2 and 3. + + - -check: - - -run the test suite. - - - - + + install + + Install everything, including the compiler built in + stage 2. To override the stage, say make install + stage=n where + n is the stage to install. + + + - -All of these standard targets automatically recurse into -sub-directories. Certain other standard targets do not: - + The top-level Makefile also arranges + to do the appropriate make boot steps (see + below) before actually building anything. - - + The stage1, stage2 + and stage3 targets also work in the + ghc/compiler directory, but don't forget that + each stage requires its own make boot step: + for example, you must do - -configure: - - -is only available in the root directory -$(FPTOOLS_TOP); it has been discussed in . - - - -depend: - - -make a .depend file in each directory that needs -it. This .depend file contains mechanically-generated dependency -information; for example, suppose a directory contains a Haskell -source module Foo.lhs which imports another module Baz. -Then the generated .depend file will contain the dependency: - + $ make boot stage=2 - + before make stage2 in + ghc/compiler. + - -Foo.o : Baz.hi - + + Standard Targets + targets, standard makefile + makefile targets - + In any directory you should be able to make the following: - -which says that the object file Foo.o depends on the interface file -Baz.hi generated by compiling module Baz. The .depend file is -automatically included by every Makefile. - - - -binary-dist: - - -make a binary distribution. This is the -target we use to build the binary distributions of GHC and Happy. - - - -dist: - - -make a source distribution. Note that this target does “make -distclean” as part of its work; don't use it if you want to keep -what you've built. - - - - + + + boot + + does the one-off preparation required to get ready + for the real work. Notably, it does gmake + depend in all directories that contain programs. + It also builds the necessary tools for compilation to + proceed. + + Invoking the boot target + explicitly is not normally necessary. From the top-level + fptools directory, invoking + gmake causes gmake boot + all to be invoked in each of the project + subdirectories, in the order specified by + $(AllTargets) in + config.mk. + + If you're working in a subdirectory somewhere and + need to update the dependencies, gmake + boot is a good way to do it. + + - -Most Makefiles have targets other than these. You can discover them by looking in the Makefile itself. - + + all + + makes all the final target(s) for this Makefile. + Depending on which directory you are in a “final + target” may be an executable program, a library + archive, a shell script, or a Postscript file. Typing + gmake alone is generally the same as + typing gmake all. + + - + + install + + installs the things built by all + (except for the documentation). Where does it install + them? That is specified by + mk/config.mk.in; you can override it + in mk/build.mk, or by running + configure with command-line arguments + like --bindir=/home/simonpj/bin; see + ./configure --help for the full + details. + + - -Using a project from the build tree - -If you want to build GHC (say) and just use it direct from the build -tree without doing make install first, you can run -the in-place driver script: -ghc/compiler/ghc-inplace. - + + install-docs + + installs the documentation. Otherwise behaves just + like install. + + - Do NOT use -ghc/compiler/ghc, or -ghc/compiler/ghc-5.xx, as these are the scripts -intended for installation, and contain hard-wired paths to the -installed libraries, rather than the libraries in the build tree. - + + uninstall + + reverses the effect of + install. + + - -Happy can similarly be run from the build tree, using -happy/src/happy-inplace. - - + + clean + + Delete all files from the current directory that are + normally created by building the program. Don't delete + the files that record the configuration, or files + generated by gmake boot. Also preserve + files that could be made by building, but normally aren't + because the distribution comes with them. + + - -Fast Making <indexterm><primary>fastmake</primary></indexterm> -<indexterm><primary>dependencies, omitting</primary></indexterm> -<indexterm><primary>FAST, makefile -variable</primary></indexterm> + + distclean + + Delete all files from the current directory that are + created by configuring or building the program. If you + have unpacked the source and built the program without + creating any other files, make + distclean should leave only the files that were + in the distribution. + + - -Sometimes the dependencies get in the way: if you've made a small -change to one file, and you're absolutely sure that it won't affect -anything else, but you know that make is going to rebuild everything -anyway, the following hack may be useful: - + + mostlyclean + + Like clean, but may refrain from + deleting a few files that people normally don't want to + recompile. + + - + + maintainer-clean + + Delete everything from the current directory that + can be reconstructed with this Makefile. This typically + includes everything deleted by + distclean, plus more: C source files + produced by Bison, tags tables, Info files, and so + on. + + One exception, however: make + maintainer-clean should not delete + configure even if + configure can be remade using a rule + in the Makefile. More generally, + make maintainer-clean should not delete + anything that needs to exist in order to run + configure and then begin to build the + program. + + - -gmake FAST=YES - + + check + + run the test suite. + + + - + All of these standard targets automatically recurse into + sub-directories. Certain other standard targets do not: - -This tells the make system to ignore dependencies and just build what -you tell it to. In other words, it's equivalent to temporarily -removing the .depend file in the current directory (where -mkdependHS and friends store their dependency information). - + + + configure + + is only available in the root directory + $(FPTOOLS_TOP); it has + been discussed in . + + - -A bit of history: GHC used to come with a fastmake script that did -the above job, but GNU make provides the features we need to do it -without resorting to a script. Also, we've found that fastmaking is -less useful since the advent of GHC's recompilation checker (see the -User's Guide section on "Separate Compilation"). - + + depend + + make a .depend file in each + directory that needs it. This .depend + file contains mechanically-generated dependency + information; for example, suppose a directory contains a + Haskell source module Foo.lhs which + imports another module Baz. Then the + generated .depend file will contain + the dependency: - + +Foo.o : Baz.hi + - + which says that the object file + Foo.o depends on the interface file + Baz.hi generated by compiling module + Baz. The .depend + file is automatically included by every Makefile. + + - -The <filename>Makefile</filename> architecture -<indexterm><primary>makefile architecture</primary></indexterm> + + binary-dist + + make a binary distribution. This is the target we + use to build the binary distributions of GHC and + Happy. + + - -make is great if everything works—you type gmake install and -lo! the right things get compiled and installed in the right places. -Our goal is to make this happen often, but somehow it often doesn't; -instead some weird error message eventually emerges from the bowels of -a directory you didn't know existed. - + + dist + + make a source distribution. Note that this target + does “make distclean” as part of its work; + don't use it if you want to keep what you've built. + + + - -The purpose of this section is to give you a road-map to help you figure -out what is going right and what is going wrong. - + Most Makefiles have targets other + than these. You can discover them by looking in the + Makefile itself. + + + + Using a project from the build tree + + If you want to build GHC (say) and just use it direct from + the build tree without doing make install + first, you can run the in-place driver script: + ghc/compiler/ghc-inplace. + + Do NOT use + ghc/compiler/ghc, or + ghc/compiler/ghc-6.xx, as these are the + scripts intended for installation, and contain hard-wired paths + to the installed libraries, rather than the libraries in the + build tree. + + Happy can similarly be run from the build tree, using + happy/src/happy-inplace. + + + + Fast Making + + fastmake + dependencies, omitting + FAST, makefile variable + + Sometimes the dependencies get in the way: if you've made + a small change to one file, and you're absolutely sure that it + won't affect anything else, but you know that + make is going to rebuild everything anyway, + the following hack may be useful: + + +gmake FAST=YES + + + This tells the make system to ignore dependencies and just + build what you tell it to. In other words, it's equivalent to + temporarily removing the .depend file in + the current directory (where mkdependHS and + friends store their dependency information). + + A bit of history: GHC used to come with a + fastmake script that did the above job, but + GNU make provides the features we need to do it without + resorting to a script. Also, we've found that fastmaking is + less useful since the advent of GHC's recompilation checker (see + the User's Guide section on "Separate Compilation"). + + + + + The <filename>Makefile</filename> architecture + makefile architecture + + make is great if everything + works—you type gmake install and lo! the + right things get compiled and installed in the right places. Our + goal is to make this happen often, but somehow it often doesn't; + instead some weird error message eventually emerges from the + bowels of a directory you didn't know existed. + + The purpose of this section is to give you a road-map to + help you figure out what is going right and what is going + wrong. Debugging @@ -2261,18 +2292,20 @@ out what is going right and what is going wrong. recompilations. - -A small project - - -To get started, let us look at the Makefile for an imaginary small -fptools project, small. Each project in fptools has its own -directory in FPTOOLS_TOP, so the small project will have its own -directory FPOOLS_TOP/small/. Inside the small/ directory there -will be a Makefile, looking something like this: - + + A small project + + To get started, let us look at the + Makefile for an imaginary small + fptools project, small. + Each project in fptools has its own directory + in FPTOOLS_TOP, so the + small project will have its own directory + FPOOLS_TOP/small/. Inside the + small/ directory there will be a + Makefile, looking something like + this: - Makefile, minimal @@ -2287,174 +2320,169 @@ HS_PROG = small include $(TOP)/target.mk - - - -This Makefile has three sections: - - - - - - - - - The first section includes - + this Makefile has three + sections: + + + The first section includes + One of the most important -features of GNU make that we use is the ability for a Makefile to -include another named file, very like cpp's #include +features of GNU make that we use is the ability for a Makefile to +include another named file, very like cpp's #include directive. - - - a file of ``boilerplate'' code from the level -above (which in this case will be -FPTOOLS_TOP/mk/boilerplate.mkboilerplate.mk). As its name -suggests, boilerplate.mk consists of a large quantity of standard -Makefile code. We discuss this boilerplate in more detail in -. -include, directive in Makefiles -Makefile inclusion - -Before the include statement, you must define the make variable -TOPTOP to be the directory containing the mk directory in -which the boilerplate.mk file is. It is not OK to simply say - + + + a file of “boilerplate” code from the level + above (which in this case will be + FPTOOLS_TOP/mk/boilerplate.mkboilerplate.mk). + As its name suggests, boilerplate.mk + consists of a large quantity of standard + Makefile code. We discuss this + boilerplate in more detail in . + include, directive in + Makefiles Makefile + inclusion + + Before the include statement, you + must define the make variable + TOPTOP + to be the directory containing the mk + directory in which the boilerplate.mk + file is. It is not OK to simply say include ../mk/boilerplate.mk # NO NO NO -Why? Because the boilerplate.mk file needs to know where it is, so -that it can, in turn, include other files. (Unfortunately, when an -included file does an include, the filename is treated relative to -the directory in which gmake is being run, not the directory in -which the included sits.) In general, every file foo.mk -assumes that $(TOP)/mk/foo.mk refers to itself. It is up to the -Makefile doing the include to ensure this is the case. - -Files intended for inclusion in other Makefiles are written to have -the following property: after foo.mk is included, it leaves -TOP containing the same value as it had just before the include -statement. In our example, this invariant guarantees that the -include for target.mk will look in the same directory as that for -boilerplate.mk. - - - - - - - The second section defines the following standard make -variables: SRCSSRCS (the source files from which is to be -built), and HS_PROGHS_PROG (the executable binary to be -built). We will discuss in more detail what the ``standard -variables'' are, and how they affect what happens, in . - -The definition for SRCS uses the useful GNU make construct -$(wildcard $pat$)wildcard, which expands to a list of all -the files matching the pattern pat in the current directory. In -this example, SRCS is set to the list of all the .lhs and .c -files in the directory. (Let's suppose there is one of each, -Foo.lhs and Baz.c.) - - - - - - - The last section includes a second file of standard code, -called target.mktarget.mk. It contains the rules that tell -gmake how to make the standard targets (). Why, you ask, -can't this standard code be part of boilerplate.mk? Good question. -We discuss the reason later, in . - -You do not have to include the target.mk file. Instead, you -can write rules of your own for all the standard targets. Usually, -though, you will find quite a big payoff from using the canned rules -in target.mk; the price tag is that you have to understand what -canned rules get enabled, and what they do (). - - - - - - - - - -In our example Makefile, most of the work is done by the two -included files. When you say gmake all, the following things -happen: - - - - - - - - - gmake figures out that the object files are Foo.o and -Baz.o. - - - - - - - It uses a boilerplate pattern rule to compile Foo.lhs to -Foo.o using a Haskell compiler. (Which one? That is set in the -build configuration.) - - - - - - - It uses another standard pattern rule to compile Baz.c to -Baz.o, using a C compiler. (Ditto.) + Why? Because the boilerplate.mk + file needs to know where it is, so that it can, in turn, + include other files. (Unfortunately, + when an included file does an + include, the filename is treated relative + to the directory in which gmake is being + run, not the directory in which the + included sits.) In general, + every file foo.mk assumes + that + $(TOP)/mk/foo.mk + refers to itself. It is up to the + Makefile doing the + include to ensure this is the case. + + Files intended for inclusion in other + Makefiles are written to have the + following property: after + foo.mk is included, + it leaves TOP containing the same value + as it had just before the include + statement. In our example, this invariant + guarantees that the include for + target.mk will look in the same + directory as that for boilerplate.mk. + - - - + + The second section defines the following standard + make variables: + SRCSSRCS + (the source files from which is to be built), and + HS_PROGHS_PROG + (the executable binary to be built). We will discuss in + more detail what the “standard variables” are, + and how they affect what happens, in . + + The definition for SRCS uses the + useful GNU make construct + $(wildcard $pat$)wildcard, + which expands to a list of all the files matching the + pattern pat in the current directory. In + this example, SRCS is set to the list + of all the .lhs and + .c files in the directory. (Let's + suppose there is one of each, Foo.lhs + and Baz.c.) + - - It links the resulting .o files together to make small, -using the Haskell compiler to do the link step. (Why not use ld? -Because the Haskell compiler knows what standard libraries to link in. -How did gmake know to use the Haskell compiler to do the link, -rather than the C compiler? Because we set the variable HS_PROG -rather than C_PROG.) + + The last section includes a second file of standard + code, called + target.mktarget.mk. + It contains the rules that tell gmake how + to make the standard targets (). Why, you ask, can't this + standard code be part of + boilerplate.mk? Good question. We + discuss the reason later, in . + + You do not have to + include the + target.mk file. Instead, you can write + rules of your own for all the standard targets. Usually, + though, you will find quite a big payoff from using the + canned rules in target.mk; the price + tag is that you have to understand what canned rules get + enabled, and what they do (). + + - - + In our example Makefile, most of the + work is done by the two included files. When + you say gmake all, the following things + happen: - + + + gmake figures out that the object + files are Foo.o and + Baz.o. + - + + It uses a boilerplate pattern rule to compile + Foo.lhs to Foo.o + using a Haskell compiler. (Which one? That is set in the + build configuration.) + - -All Makefiles should follow the above three-section format. - + + It uses another standard pattern rule to compile + Baz.c to Baz.o, + using a C compiler. (Ditto.) + - + + It links the resulting .o files + together to make small, using the Haskell + compiler to do the link step. (Why not use + ld? Because the Haskell compiler knows + what standard libraries to link in. How did + gmake know to use the Haskell compiler to + do the link, rather than the C compiler? Because we set the + variable HS_PROG rather than + C_PROG.) + + - -A larger project + All Makefiles should follow the above + three-section format. + - -Larger projects are usually structured into a number of sub-directories, -each of which has its own Makefile. (In very large projects, this -sub-structure might be iterated recursively, though that is rare.) -To give you the idea, here's part of the directory structure for -the (rather large) GHC project: - + + A larger project - + Larger projects are usually structured into a number of + sub-directories, each of which has its own + Makefile. (In very large projects, this + sub-structure might be iterated recursively, though that is + rare.) To give you the idea, here's part of the directory + structure for the (rather large) GHC project: $(FPTOOLS_TOP)/ghc/ @@ -2475,211 +2503,194 @@ $(FPTOOLS_TOP)/ghc/ ...etc... - - - -The sub-directories docs, driver, compiler, and so on, each -contains a sub-component of GHC, and each has its own Makefile. -There must also be a Makefile in $(FPTOOLS_TOP)/ghc. It does most -of its work by recursively invoking gmake on the Makefiles in the -sub-directories. We say that ghc/Makefile is a non-leaf -Makefile, because it does little except organise its children, -while the Makefiles in the sub-directories are all leaf -Makefiles. (In principle the sub-directories might themselves -contain a non-leaf Makefile and several sub-sub-directories, but -that does not happen in GHC.) - - - -The Makefile in ghc/compiler is considered a leaf Makefile even -though the ghc/compiler has sub-directories, because these sub-directories -do not themselves have Makefiles in them. They are just used to structure -the collection of modules that make up GHC, but all are managed by the -single Makefile in ghc/compiler. - - - -You will notice that ghc/ also contains a directory ghc/mk/. It -contains GHC-specific Makefile boilerplate code. More precisely: - - - - - - - - - ghc/mk/boilerplate.mk is included at the top of -ghc/Makefile, and of all the leaf Makefiles in the -sub-directories. It in turn includes the main boilerplate file -mk/boilerplate.mk. - - - - - - - - ghc/mk/target.mk is included at the bottom of -ghc/Makefile, and of all the leaf Makefiles in the -sub-directories. It in turn includes the file mk/target.mk. - - - - - - - - - -So these two files are the place to look for GHC-wide customisation -of the standard boilerplate. - - - - - -Boilerplate architecture -<indexterm><primary>boilerplate architecture</primary></indexterm> - - - -Every Makefile includes a boilerplate.mkboilerplate.mk file -at the top, and target.mktarget.mk file at the bottom. In -this section we discuss what is in these files, and why there have to -be two of them. In general: - + The sub-directories docs, + driver, compiler, and + so on, each contains a sub-component of GHC, and each has its + own Makefile. There must also be a + Makefile in + $(FPTOOLS_TOP)/ghc. + It does most of its work by recursively invoking + gmake on the Makefiles + in the sub-directories. We say that + ghc/Makefile is a non-leaf + Makefile, because it does little + except organise its children, while the + Makefiles in the sub-directories are all + leaf Makefiles. (In + principle the sub-directories might themselves contain a + non-leaf Makefile and several + sub-sub-directories, but that does not happen in GHC.) + + The Makefile in + ghc/compiler is considered a leaf + Makefile even though the + ghc/compiler has sub-directories, because + these sub-directories do not themselves have + Makefiles in them. They are just used to + structure the collection of modules that make up GHC, but all + are managed by the single Makefile in + ghc/compiler. + + You will notice that ghc/ also + contains a directory ghc/mk/. It contains + GHC-specific Makefile boilerplate code. + More precisely: - - - - + + + ghc/mk/boilerplate.mk is included + at the top of ghc/Makefile, and of all + the leaf Makefiles in the + sub-directories. It in turn includes the + main boilerplate file + mk/boilerplate.mk. + - - boilerplate.mk consists of: + + ghc/mk/target.mk is + included at the bottom of + ghc/Makefile, and of all the leaf + Makefiles in the sub-directories. It + in turn includes the file + mk/target.mk. + + - - + So these two files are the place to look for GHC-wide + customisation of the standard boilerplate. + - - Definitions of millions of make variables that -collectively specify the build configuration. Examples: -HC_OPTSHC_OPTS, the options to feed to the Haskell compiler; -NoFibSubDirsNoFibSubDirs, the sub-directories to enable within the -nofib project; GhcWithHcGhcWithHc, the name of the Haskell -compiler to use when compiling GHC in the ghc project. - - - + + Boilerplate architecture + boilerplate architecture - -Standard pattern rules that tell gmake how to construct one -file from another. - - + Every Makefile includes a + boilerplate.mkboilerplate.mk + file at the top, and + target.mktarget.mk + file at the bottom. In this section we discuss what is in these + files, and why there have to be two of them. In general: - + + + boilerplate.mk consists of: + + + Definitions of millions of + make variables that + collectively specify the build configuration. Examples: + HC_OPTSHC_OPTS, + the options to feed to the Haskell compiler; + NoFibSubDirsNoFibSubDirs, + the sub-directories to enable within the + nofib project; + GhcWithHcGhcWithHc, + the name of the Haskell compiler to use when compiling + GHC in the ghc project. + -boilerplate.mk needs to be included at the top -of each Makefile, so that the user can replace the -boilerplate definitions or pattern rules by simply giving a new -definition or pattern rule in the Makefile. gmake -simply takes the last definition as the definitive one. + + Standard pattern rules that + tell gmake how to construct one file + from another. + + -Instead of replacing boilerplate definitions, it is also quite -common to augment them. For example, a Makefile might say: + boilerplate.mk needs to be + included at the top + of each Makefile, so that the user can + replace the boilerplate definitions or pattern rules by + simply giving a new definition or pattern rule in the + Makefile. gmake + simply takes the last definition as the definitive one. + Instead of replacing boilerplate + definitions, it is also quite common to + augment them. For example, a + Makefile might say: SRC_HC_OPTS += -O + thereby adding “” to + the end of + SRC_HC_OPTSSRC_HC_OPTS. + -thereby adding ``'' to the end of SRC_HC_OPTSSRC_HC_OPTS. - - - - - - - target.mk contains make rules for the standard -targets described in . These rules are selectively included, -depending on the setting of certain make variables. These -variables are usually set in the middle section of the -Makefile between the two includes. - -target.mk must be included at the end (rather than being part of -boilerplate.mk) for several tiresome reasons: - - - - + + target.mk contains + make rules for the standard targets + described in . These + rules are selectively included, depending on the setting of + certain make variables. These variables + are usually set in the middle section of the + Makefile between the two + includes. + + target.mk must be included at the + end (rather than being part of + boilerplate.mk) for several tiresome + reasons: - - gmake commits target and dependency lists earlier than -it should. For example, target.mk has a rule that looks like -this: + + + gmake commits target and + dependency lists earlier than it should. For example, + target.mk has a rule that looks + like this: $(HS_PROG) : $(OBJS) $(HC) $(LD_OPTS) $< -o $@ + If this rule was in + boilerplate.mk then + $(HS_PROG)HS_PROG + and + $(OBJS)OBJS + would not have their final values at the moment + gmake encountered the rule. Alas, + gmake takes a snapshot of their + current values, and wires that snapshot into the rule. + (In contrast, the commands executed when the rule + “fires” are only substituted at the moment + of firing.) So, the rule must follow the definitions + given in the Makefile itself. + -If this rule was in boilerplate.mk then $(HS_PROG)HS_PROG -and $(OBJS)OBJS would not have their final values at the -moment gmake encountered the rule. Alas, gmake takes a snapshot -of their current values, and wires that snapshot into the rule. (In -contrast, the commands executed when the rule ``fires'' are only -substituted at the moment of firing.) So, the rule must follow the -definitions given in the Makefile itself. - - - - - - - Unlike pattern rules, ordinary rules cannot be overriden or -replaced by subsequent rules for the same target (at least, not without an -error message). Including ordinary rules in boilerplate.mk would -prevent the user from writing rules for specific targets in specific cases. - - - - - - - There are a couple of other reasons I've forgotten, but it doesn't -matter too much. - - - - - - - - - - - - - + + Unlike pattern rules, ordinary rules cannot be + overriden or replaced by subsequent rules for the same + target (at least, not without an error message). + Including ordinary rules in + boilerplate.mk would prevent the + user from writing rules for specific targets in specific + cases. + - -The main <filename>mk/boilerplate.mk</filename> file + <listitem> + <para>There are a couple of other reasons I've + forgotten, but it doesn't matter too much.</para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + </sect2> -<indexterm><primary>boilerplate.mk</primary></indexterm> + + The main <filename>mk/boilerplate.mk</filename> file + boilerplate.mk - -If you look at $(FPTOOLS_TOP)/mk/boilerplate.mk you will find -that it consists of the following sections, each held in a separate -file: - + If you look at + $(FPTOOLS_TOP)/mk/boilerplate.mk + you will find that it consists of the following sections, each + held in a separate file: - config.mk config.mk @@ -2693,7 +2704,7 @@ file: paths.mk paths.mk - defines make variables for + defines make variables for pathnames and file lists. This file contains code for automatically compiling lists of source files and deriving lists of object files from those. The results can be @@ -2879,7 +2890,7 @@ file: opts.mk opts.mk - defines make variables for option + defines make variables for option strings to pass to each program. For example, it defines HC_OPTSHC_OPTS, the option strings to pass to the Haskell compiler. See @@ -2897,290 +2908,277 @@ file: - -Any of the variables and pattern rules defined by the boilerplate file -can easily be overridden in any particular Makefile, because the -boilerplate include comes first. Definitions after this include -directive simply override the default ones in boilerplate.mk. - - - - - -Pattern rules and options - -<indexterm><primary>Pattern rules</primary></indexterm> - - -The file suffix.mksuffix.mk defines standard pattern -rules that say how to build one kind of file from another, for -example, how to build a .o file from a .c file. (GNU make's -pattern rules are more powerful and easier to use than Unix -make's suffix rules.) - - - -Almost all the rules look something like this: - - - - - -%.o : %.c - $(RM) $@ - $(CC) $(CC_OPTS) -c $< -o $@ - + Any of the variables and pattern rules defined by the + boilerplate file can easily be overridden in any particular + Makefile, because the boilerplate + include comes first. Definitions after this + include directive simply override the default + ones in boilerplate.mk. + - + + Pattern rules and options + Pattern rules - -Here's how to understand the rule. It says that -something.o (say Foo.o) can be built from -something.c (Foo.c), by invoking the C compiler -(path name held in $(CC)), passing to it the options -$(CC_OPTS) and the rule's dependent file of the rule -$< (Foo.c in this case), and putting the result in -the rule's target $@ (Foo.o in this case). - + The file + suffix.mksuffix.mk + defines standard pattern rules that say how + to build one kind of file from another, for example, how to + build a .o file from a + .c file. (GNU make's + pattern rules are more powerful and easier + to use than Unix make's suffix + rules.) - -Every program is held in a make variable defined in -mk/config.mk—look in mk/config.mk for the -complete list. One important one is the Haskell compiler, which is -called $(HC). - + Almost all the rules look something like this: - -Every program's options are are held in a make variables called -<prog>_OPTS. the <prog>_OPTS variables are defined in -mk/opts.mk. Almost all of them are defined like this: - + +%.o : %.c + $(RM) $@ + $(CC) $(CC_OPTS) -c $< -o $@ + - + Here's how to understand the rule. It says that + something.o (say + Foo.o) can be built from + something.c + (Foo.c), by invoking the C compiler (path + name held in $(CC)), passing to it + the options $(CC_OPTS) and + the rule's dependent file of the rule + $< (Foo.c in + this case), and putting the result in the rule's target + $@ (Foo.o in this + case). + + Every program is held in a make + variable defined in mk/config.mk—look + in mk/config.mk for the complete list. One + important one is the Haskell compiler, which is called + $(HC). + + Every program's options are are held in a + make variables called + <prog>_OPTS. the + <prog>_OPTS variables are + defined in mk/opts.mk. Almost all of them + are defined like this: CC_OPTS = $(SRC_CC_OPTS) $(WAY$(_way)_CC_OPTS) $($*_CC_OPTS) $(EXTRA_CC_OPTS) - + The four variables from which + CC_OPTS is built have the following + meaning: - -The four variables from which CC_OPTS is built have the following meaning: - + + + SRC_CC_OPTSSRC_CC_OPTS: + + options passed to all C compilations. + + - - + + WAY_<way>_CC_OPTS: + + options passed to C compilations for way + <way>. For example, + WAY_mp_CC_OPTS + gives options to pass to the C compiler when compiling way + mp. The variable + WAY_CC_OPTS holds + options to pass to the C compiler when compiling the + standard way. ( dicusses + multi-way compilation.) + + - -SRC_CC_OPTSSRC_CC_OPTS: - - -options passed to all C -compilations. - - - -WAY_<way>_CC_OPTS: - - -options passed to C -compilations for way <way>. For example, -WAY_mp_CC_OPTS gives options to pass to the C compiler when -compiling way mp. The variable WAY_CC_OPTS holds -options to pass to the C compiler when compiling the standard way. -( dicusses multi-way -compilation.) - - - -<module>_CC_OPTS: - - -options to -pass to the C compiler that are specific to module <module>. For example, SMap_CC_OPTS gives the specific options -to pass to the C compiler when compiling SMap.c. - - - -EXTRA_CC_OPTSEXTRA_CC_OPTS: - - -extra options to pass to all -C compilations. This is intended for command line use, thus: - + + <module>_CC_OPTS: + + options to pass to the C compiler that are specific + to module <module>. For example, + SMap_CC_OPTS gives the + specific options to pass to the C compiler when compiling + SMap.c. + + - + + EXTRA_CC_OPTSEXTRA_CC_OPTS: + + extra options to pass to all C compilations. This + is intended for command line use, thus: gmake libHS.a EXTRA_CC_OPTS="-v" + + + + - - - - + + The main <filename>mk/target.mk</filename> file + target.mk + + target.mk contains canned rules for + all the standard targets described in . It is complicated by the fact + that you don't want all of these rules to be active in every + Makefile. Rather than have a plethora of + tiny files which you can include selectively, there is a single + file, target.mk, which selectively includes + rules based on whether you have defined certain variables in + your Makefile. This section explains what + rules you get, what variables control them, and what the rules + do. Hopefully, you will also get enough of an idea of what is + supposed to happen that you can read and understand any weird + special cases yourself. - + + + HS_PROGHS_PROG. + + If HS_PROG is defined, + you get rules with the following targets: - -The main <filename>mk/target.mk</filename> file + <variablelist> + <varlistentry> + <term><filename>HS_PROG</filename><indexterm><primary>HS_PROG</primary></indexterm></term> + <listitem> + <para>itself. This rule links + <constant>$(OBJS)</constant> with the Haskell + runtime system to get an executable called + <constant>$(HS_PROG)</constant>.</para> + </listitem> + </varlistentry> -<indexterm><primary>target.mk</primary></indexterm> + + installinstall + + installs + $(HS_PROG) in + $(bindir). + + + - -target.mk contains canned rules for all the standard targets -described in . It is complicated by the fact that you don't want all of -these rules to be active in every Makefile. Rather than have a -plethora of tiny files which you can include selectively, there is a -single file, target.mk, which selectively includes rules based on -whether you have defined certain variables in your Makefile. This -section explains what rules you get, what variables control them, and -what the rules do. Hopefully, you will also get enough of an idea of -what is supposed to happen that you can read and understand any weird -special cases yourself. - + + - - + + C_PROGC_PROG + + is similar to HS_PROG, + except that the link step links + $(C_OBJS) with the C + runtime system. + + - -HS_PROGHS_PROG. - - -If HS_PROG is defined, you get -rules with the following targets: - + + LIBRARYLIBRARY + + is similar to HS_PROG, + except that it links + $(LIB_OBJS) to make the + library archive $(LIBRARY), + and install installs it in + $(libdir). + + - -HS_PROGHS_PROG - - -itself. This rule links $(OBJS) -with the Haskell runtime system to get an executable called -$(HS_PROG). - - - -installinstall - - -installs $(HS_PROG) -in $(bindir). - - - - - - -C_PROGC_PROG - - -is similar to HS_PROG, except that -the link step links $(C_OBJS) with the C runtime system. - - - -LIBRARYLIBRARY - - -is similar to HS_PROG, except that -it links $(LIB_OBJS) to make the library archive $(LIBRARY), and -install installs it in $(libdir). - - - -LIB_DATALIB_DATA - - -… - - - -LIB_EXECLIB_EXEC - - -… - - - -HS_SRCSHS_SRCS, C_SRCSC_SRCS. - - -If HS_SRCS -is defined and non-empty, a rule for the target depend is included, -which generates dependency information for Haskell programs. -Similarly for C_SRCS. - - - - + + LIB_DATALIB_DATA + + … + + - -All of these rules are ``double-colon'' rules, thus - + + LIB_EXECLIB_EXEC + + … + + - + + HS_SRCSHS_SRCS, C_SRCSC_SRCS. + + If HS_SRCS is defined + and non-empty, a rule for the target + depend is included, which generates + dependency information for Haskell programs. Similarly + for C_SRCS. + + + + + All of these rules are “double-colon” rules, + thus install :: $(HS_PROG) ...how to install it... - - - -GNU make treats double-colon rules as separate entities. If there -are several double-colon rules for the same target it takes each in -turn and fires it if its dependencies say to do so. This means that -you can, for example, define both HS_PROG and LIBRARY, which will -generate two rules for install. When you type gmake install both -rules will be fired, and both the program and the library will be -installed, just as you wanted. - - - - - -Recursion - -<indexterm><primary>recursion, in makefiles</primary></indexterm> -<indexterm><primary>Makefile, recursing into subdirectories</primary></indexterm> - - -In leaf Makefiles the variable SUBDIRSSUBDIRS is undefined. -In non-leaf Makefiles, SUBDIRS is set to the list of -sub-directories that contain subordinate Makefiles. It is up to -you to set SUBDIRS in the Makefile. There is no automation here—SUBDIRS is too important to automate. - - - -When SUBDIRS is defined, target.mk includes a rather -neat rule for the standard targets ( that simply invokes -make recursively in each of the sub-directories. - - - -These recursive invocations are guaranteed to occur in the order -in which the list of directories is specified in SUBDIRS. This -guarantee can be important. For example, when you say gmake boot it -can be important that the recursive invocation of make boot is done -in one sub-directory (the include files, say) before another (the -source files). Generally, put the most independent sub-directory -first, and the most dependent last. - + GNU make treats double-colon rules as + separate entities. If there are several double-colon rules for + the same target it takes each in turn and fires it if its + dependencies say to do so. This means that you can, for + example, define both HS_PROG and + LIBRARY, which will generate two rules for + install. When you type gmake + install both rules will be fired, and both the program + and the library will be installed, just as you wanted. + - + + Recursion + recursion, in makefiles + Makefile, recursing into subdirectories + + In leaf Makefiles the variable + SUBDIRSSUBDIRS + is undefined. In non-leaf Makefiles, + SUBDIRS is set to the list of + sub-directories that contain subordinate + Makefiles. It is up to you to + set SUBDIRS in the + Makefile. There is no automation + here—SUBDIRS is too important to + automate. + + When SUBDIRS is defined, + target.mk includes a rather neat rule for + the standard targets ( that + simply invokes make recursively in each of + the sub-directories. + + These recursive invocations are guaranteed to + occur in the order in which the list of directories is specified + in SUBDIRS. This guarantee can + be important. For example, when you say gmake + boot it can be important that the recursive invocation + of make boot is done in one sub-directory + (the include files, say) before another (the source files). + Generally, put the most independent sub-directory first, and the + most dependent last. + Way management way management We sometimes want to build essentially the same system in - several different ``ways''. For example, we want to build GHC's + several different “ways”. For example, we want to build GHC's Prelude libraries with and without profiling, so that there is an appropriately-built library archive to link with when the user compiles his program. It would be possible - to have a completely separate build tree for each such ``way'', + to have a completely separate build tree for each such “way”, but it would be horribly bureaucratic, especially since often only parts of the build tree need to be constructed in multiple ways. @@ -3206,46 +3204,46 @@ first, and the most dependent last. way tag the other side of the dot, for boring reasons; thus, libHS_mp.a. - A make variable called + A make variable called way holds the current way tag. way is only ever set on the - command line of gmake (usually in + command line of gmake (usually in a recursive invocation of gmake by the system). It is never set inside a Makefile. So it is a global constant for - any one invocation of gmake. Two other - make variables, + any one invocation of gmake. Two other + make variables, way_ and _way are immediately derived from $(way) and never altered. If way is not set, then neither are way_ and _way, and the invocation of - make will build the normal + make will build the normal way. If way is set, then the other two variables are set in sympathy. For example, if - $(way) is ``mp'', + $(way) is “mp”, then way_ is set to - ``mp_'' and + “mp_” and _way is set to - ``_mp''. These three variables are + “_mp”. These three variables are then used when constructing file names. - So how does make ever get recursively + So how does make ever get recursively invoked with way set? There are two ways in which this happens: For some (but not all) of the standard targets, when - in a leaf sub-directory, make is + in a leaf sub-directory, make is recursively invoked for each way tag in $(WAYS). You set WAYS in the Makefile to the list of way tags you want these targets built for. The mechanism here is very much like the recursive invocation of - make in sub-directories (make in sub-directories (). It is up to you to set WAYS in your Makefile; this is how you control what @@ -3256,14 +3254,14 @@ first, and the most dependent last. For a useful collection of targets (such as libHS_mp.a, Foo.mp_o) there is a rule which - recursively invokes make to make the + recursively invokes make to make the specified target, setting the way - variable. So if you say gmake - Foo.mp_o you should see a recursive - invocation gmake Foo.mp_o way=mp, - and in this recursive invocation the pattern rule + variable. So if you say gmake + Foo.mp_o you should see a recursive + invocation gmake Foo.mp_o way=mp, + and in this recursive invocation the pattern rule for compiling a Haskell file into a .o - file will match. The key pattern rules (in + file will match. The key pattern rules (in suffix.mk) look like this: @@ -3271,119 +3269,638 @@ first, and the most dependent last. $(HC) $(HC_OPTS) $< -o $@ - Neat, eh? + Neat, eh? + + + + You can invoke make with a + particular way setting yourself, in order + to build files related to a particular + way in the current directory. eg. + + +$ make way=p + + + will build files for the profiling way only in the current + directory. + + + + + + When the canned rule isn't right + + Sometimes the canned rule just doesn't do the right thing. + For example, in the nofib suite we want the + link step to print out timing information. The thing to do here + is not to define + HS_PROG or + C_PROG, and instead define a special + purpose rule in your own Makefile. By + using different variable names you will avoid the canned rules + being included, and conflicting with yours. + + + + + Building the documentation + + + Tools for building the Documentation + + The following additional tools are required if you want to + format the documentation that comes with the + fptools projects: + + + + DocBook + pre-supposed: DocBook + DocBook, pre-supposed + + Much of our documentation is written in SGML, using + the DocBook DTD. Instructions on installing and + configuring the DocBook tools are below. + + + + + TeX + pre-supposed: TeX + TeX, pre-supposed + + A decent TeX distribution is required if you want to + produce printable documentation. We recomment teTeX, + which includes just about everything you need. + + + + + Haddock + Haddock + + + Haddock is a Haskell documentation tool that we use + for automatically generating documentation from the + library source code. It is an fptools + project in itself. To build documentation for the + libraries (fptools/libraries) you + should check out and build Haddock in + fptools/haddock. Haddock requires GHC + to build. + + + + + + + Installing the DocBook tools + + + Installing the DocBook tools on Linux + + If you're on a recent RedHat system (7.0+), you probably + have working DocBook tools already installed. The configure + script should detect your setup and you're away. + + If you don't have DocBook tools installed, and you are + using a system that can handle RedHat RPM packages, you can + probably use the Cygnus + DocBook tools, which is the most shrink-wrapped SGML + suite that we could find. You need all the RPMs except for + psgml (i.e. docbook, + jade, jadetex, + sgmlcommon and + stylesheets). Note that most of these + RPMs are architecture neutral, so are likely to be found in a + noarch directory. The SuSE RPMs also + work; the RedHat ones don't in RedHat 6.2 + (7.0 and later should be OK), but they are easy to fix: just + make a symlink from + /usr/lib/sgml/stylesheets/nwalsh-modular/lib/dblib.dsl + to /usr/lib/sgml/lib/dblib.dsl. + + + + Installing DocBook on FreeBSD + + On FreeBSD systems, the easiest way to get DocBook up + and running is to install it from the ports tree or a + pre-compiled package (packages are available from your local + FreeBSD mirror site). + + To use the ports tree, do this: + + $ cd /usr/ports/textproc/docproj + $ make install + + This installs the FreeBSD documentation project tools, which + includes everything needed to format the GHC + documentation. + + + + Installing from binaries on Windows + + It's a good idea to use Norman Walsh's installation + notes as a guide. You should get version 3.1 of + DocBook, and note that his file test.sgm + won't work, as it needs version 3.0. You should unpack Jade + into \Jade, along with the entities, + DocBook into \docbook, and the DocBook + stylesheets into \docbook\stylesheets (so + they actually end up in + \docbook\stylesheets\docbook). + + + + + Installing the DocBook tools from source + + + Jade + + Install OpenJade + (Windows binaries are available as well as sources). If you + want DVI, PS, or PDF then install JadeTeX from the + dsssl subdirectory. (If you get the + error: + + +! LaTeX Error: Unknown option implicit=false' for package hyperref'. + + + your version of hyperref is out of date; + download it from CTAN + (macros/latex/contrib/supported/hyperref), + and make it, ensuring that you have first removed or renamed + your old copy. If you start getting file not found errors + when making the test for hyperref, you + can abort at that point and proceed straight to + make install, or enter them as + ../filename.) + + Make links from virtex to + jadetex and + pdfvirtex to + pdfjadetex (otherwise DVI, PostScript + and PDF output will not work). Copy + dsssl/*.{dtd,dsl} and + catalog to + /usr/[local/]lib/sgml. + + + + DocBook and the DocBook stylesheets + + Get a Zip of DocBook + and install the contents in + /usr/[local/]/lib/sgml. + + Get the DocBook + stylesheets and install in + /usr/[local/]lib/sgml/stylesheets + (thereby creating a subdirectory docbook). For indexing, + copy or link collateindex.pl from the + DocBook stylesheets archive in bin into + a directory on your PATH. + + Download the ISO + entities into + /usr/[local/]lib/sgml. + + + + + + Configuring the DocBook tools + + Once the DocBook tools are installed, the configure script + will detect them and set up the build system accordingly. If you + have a system that isn't supported, let us know, and we'll try + to help. + + + + Remaining problems + + If you install from source, you'll get a pile of warnings + of the form + +DTDDECL catalog entries are not supported + + every time you build anything. These can safely be ignored, but + if you find them tedious you can get rid of them by removing all + the DTDDECL entries from + docbook.cat. + + + + Building the documentation + + To build documentation in a certain format, you can + say, for example, + + +$ make html + + + to build HTML documentation below the current directory. + The available formats are: dvi, + ps, pdf, + html, and rtf. Note that + not all documentation can be built in all of these formats: HTML + documentation is generally supported everywhere, and DocBook + documentation might support the other formats (depending on what + other tools you have installed). + + All of these targets are recursive; that is, saying + make html will make HTML docs for all the + documents recursively below the current directory. + + Because there are many different formats that the DocBook + documentation can be generated in, you have to select which ones + you want by setting the SGMLDocWays variable + to a list of them. For example, in + build.mk you might have a line: + + +SGMLDocWays = html ps + + + This will cause the documentation to be built in the requested + formats as part of the main build (the default is not to build + any documentation at all). + + + + Installing the documentation + + To install the documentation, use: + + +$ make install-docs + + + This will install the documentation into + $(datadir) (which defaults to + $(prefix)/share). The exception is HTML + documentation, which goes into + $(datadir)/html, to keep things tidy. + + Note that unless you set $(SGMLDocWays) + to a list of formats, the install-docs target + won't do anything for SGML documentation. + + + + + + + Porting GHC + + This section describes how to port GHC to a currenly + unsupported platform. There are two distinct + possibilities: + + + + The hardware architecture for your system is already + supported by GHC, but you're running an OS that isn't + supported (or perhaps has been supported in the past, but + currently isn't). This is the easiest type of porting job, + but it still requires some careful bootstrapping. Proceed to + . + + + + Your system's hardware architecture isn't supported by + GHC. This will be a more difficult port (though by comparison + perhaps not as difficult as porting gcc). Proceed to . + + + + + Booting/porting from C (<filename>.hc</filename>) files + + building GHC from .hc files + booting GHC from .hc files + porting GHC + + Bootstrapping GHC on a system without GHC already + installed is achieved by taking the intermediate C files (known + as HC files) from a GHC compilation on a supported system to the + target machine, and compiling them using gcc to get a working + GHC. + + NOTE: GHC versions 5.xx and later are + significantly harder to bootstrap from C than earlier versions. + We recommend starting from version 4.08.2 if you need to + bootstrap in this way. + + HC files are architecture-dependent (but not + OS-dependent), so you have to get a set that were generated on + similar hardware. There may be some supplied on the GHC + download page, otherwise you'll have to compile some up + yourself, or start from unregisterised HC + files - see . + + The following steps should result in a working GHC build + with full libraries: + + + + Unpack the HC files on top of a fresh source tree + (make sure the source tree version matches the version of + the HC files exactly!). This will + place matching .hc files next to the + corresponding Haskell source (.hs or + .lhs) in the compiler subdirectory + ghc/compiler and in the libraries + (subdirectories of hslibs and + libraries). + + + + The actual build process is fully automated by the + hc-build script located in the + distrib directory. If you eventually + want to install GHC into the directory + dir, the following + command will execute the whole build process (it won't + install yet): + + +foo% distrib/hc-build --prefix=dir + +--hc-build + + By default, the installation directory is + /usr/local. If that is what you want, + you may omit the argument to hc-build. + Generally, any option given to hc-build + is passed through to the configuration script + configure. If + hc-build successfully completes the + build process, you can install the resulting system, as + normal, with + + +foo% make install + + + - - You can invoke make with a - particular way setting yourself, in order - to build files related to a particular - way in the current directory. eg. + + Porting GHC to a new architecture + + The first step in porting to a new architecture is to get + an unregisterised build working. An + unregisterised build is one that compiles via vanilla C only. + By contrast, a registerised build uses the following + architecture-specific hacks for speed: - -$ make way=p - + + + Global register variables: certain abstract machine + registers are mapped to real machine + registers, depending on how many machine registers are + available (see + ghc/includes/MachRegs.h). + - will build files for the profiling way only in the current - directory. + + Assembly-mangling: when compiling via C, we feed the + assembly generated by gcc though a Perl script known as the + mangler (see + ghc/driver/mangler/ghc-asm.lprl). The + mangler rearranges the assembly to support tail-calls and + various other optimisations. - - - -When the canned rule isn't right + In an unregisterised build, neither of these hacks are + used — the idea is that the C code generated by the + compiler should compile using gcc only. The lack of these + optimisations costs about a factor of two in performance, but + since unregisterised compilation is usually just a step on the + way to a full registerised port, we don't mind too much. - -Sometimes the canned rule just doesn't do the right thing. For -example, in the nofib suite we want the link step to print out -timing information. The thing to do here is not to define -HS_PROG or C_PROG, and instead define a special purpose rule in -your own Makefile. By using different variable names you will avoid -the canned rules being included, and conflicting with yours. - + + Building an unregisterised port + + The first step is to get some unregisterised HC files. + Either (a) download them from the GHC site (if there are + some available for the right version of GHC), or + (b) build them yourself on any machine with a working + GHC. If at all possible this should be a machine with the + same word size as the target. + + There is a script available which should automate the + process of doing the 2-stage bootstrap necessary to get the + unregisterised HC files - it's available in fptools/distrib/cross-port + in CVS. + + Now take these unregisterised HC files to the target + platform and bootstrap a compiler from them as per the + instructions in . In + build.mk, you need to tell the build + system that the compiler you're building is + (a) unregisterised itself, and (b) builds + unregisterised binaries. This varies depending on the GHC + version you're bootstraping: - + +# build.mk for GHC 4.08.x +GhcWithRegisterised=NO + - + +# build.mk for GHC 5.xx and 6.x +GhcUnregisterised=YES + - -Booting/porting from C (<filename>.hc</filename>) files + <para>Versions 5.xx and 6.x only: use the option + <option>--enable-hc-boot-unregisterised</option> instead of + <option>--enable-hc-boot</option> when running + <filename>./configure</filename>.</para> + + <para>The build may not go through cleanly. We've tried to + stick to writing portable code in most parts of the compiler, + so it should compile on any POSIXish system with gcc, but in + our experience most systems differ from the standards in one + way or another. Deal with any problems as they arise - if you + get stuck, ask the experts on + <email>glasgow-haskell-users@haskell.org</email>.</para> + + <para>Once you have the unregisterised compiler up and + running, you can use it to start a registerised port. The + following sections describe the various parts of the system + that will need architecture-specific tweaks in order to get a + registerised build going.</para> + + <para>Lots of useful information about the innards of GHC is + available in the <ulink + url="http://www.cse.unsw.edu.au/~chak/haskell/ghc/comm/">GHC + Commentary</ulink>, which might be helpful if you run into + some code which needs tweaking for your system.</para> + </sect3> -<indexterm><primary>building GHC from .hc files</primary></indexterm> -<indexterm><primary>booting GHC from .hc files</primary></indexterm> -<indexterm><primary>porting GHC</primary></indexterm> + + Porting the RTS + + The following files need architecture-specific code for a + registerised build: - NOTE: GHC version 5.xx is significantly harder to - bootstrap from C than previous versions. We recommend starting - from version 4.08.2 if you need to bootstrap in this - way. + + + ghc/includes/MachRegs.h + MachRegs.h + + + Defines the STG-register to machine-register + mapping. You need to know your platform's C calling + convention, and which registers are generally available + for mapping to global register variables. There are + plenty of useful comments in this file. + + + + ghc/includes/TailCalls.h + TailCalls.h + + + Macros that cooperate with the mangler (see ) to make proper tail-calls + work. + + + + ghc/rts/Adjustor.c + Adjustor.c + + + Support for + foreign import "wrapper" + (aka + foreign export dynamic). + Not essential for getting GHC bootstrapped, so this file + can be deferred until later if necessary. + + + + ghc/rts/StgCRun.c + StgCRun.c + + + The little assembly layer between the C world and + the Haskell world. See the comments and code for the + other architectures in this file for pointers. + + + + ghc/rts/MBlock.h + ghc/rts/MBlock.c + MBlock.h + + MBlock.c + + + These files are really OS-specific rather than + architecture-specific. In MBlock.h + is specified the absolute location at which the RTS + should try to allocate memory on your platform (try to + find an area which doesn't conflict with code or dynamic + libraries). In Mblock.c you might + need to tweak the call to mmap() for + your OS. + + + + - -This section is for people trying to get GHC going by using the supplied -intermediate C (.hc) files. This would probably be -because no binaries have been provided, or because the machine is not ``fully -supported''. - + + The mangler + + The mangler is an evil Perl-script that rearranges the + assembly code output from gcc to do two main things: - -The intermediate C files are normally made available together with a source -release, please check the announce message for exact directions of where to -find them. If we haven't made them available or you can't find them, please -ask. - + + + Remove function prologues and epilogues, and all + movement of the C stack pointer. This is to support + tail-calls: every code block in Haskell code ends in an + explicit jump, so we don't want the C-stack overflowing + while we're jumping around between code blocks. + + + Move the info table for a + closure next to the entry code for that closure. In + unregisterised code, info tables contain a pointer to the + entry code, but in registerised compilation we arrange + that the info table is shoved right up against the entry + code, and addressed backwards from the entry code pointer + (this saves a word in the info table and an extra + indirection when jumping to the closure entry + code). + + - -Assuming you've got them, unpack them on top of a fresh source tree. This -will place matching .hc files next to the corresponding -Haskell source in the compiler subdirectory ghc and in -the language package of hslibs (i.e., in hslibs/lang). -Then follow the `normal' instructions in for setting up a build tree. - + The mangler is abstracted to a certain extent over some + architecture-specific things such as the particular assembler + directives used to herald symbols. Take a look at the + definitions for other architectures and use these as a + starting point. + - -The actual build process is fully automated by the -hc-build script located in the -distrib directory. If you eventually want to install GHC -into the directory INSTALL_DIRECTORY, the following -command will execute the whole build process (it won't install yet): - - -foo% distrib/hc-build --prefix=INSTALL_DIRECTORY - ---hc-build - -By default, the installation directory is /usr/local. If -that is what you want, you may omit the argument to -hc-build. Generally, any option given to -hc-build is passed through to the configuration script -configure. If hc-build -successfully completes the build process, you can install the resulting -system, as normal, with - - -foo% make install - + + The native code generator + + The native code generator isn't essential to getting a + registerised build going, but it's a desirable thing to have + because it can cut compilation times in half. The native code + generator is described in some detail in the GHC + commentary. + - -That's the mechanics of the boot process, but, of course, if you're -trying to boot on a platform that is not supported and significantly -`different' from any of the supported ones, this is only the start of -the adventure…(ToDo: porting tips—stuff to look out for, etc.) - + + GHCi + + To support GHCi, you need to port the dynamic linker + (fptools/ghc/rts/Linker.c). The linker + currently supports the ELF and PEi386 object file formats - if + your platform uses one of these then you probably don't have + to do anything except fiddle with the + #ifdefs at the top of + Linker.c to tell it about your OS. + + If your system uses a different object file format, then + you have to write a linker — good luck! + + - + - -Known pitfalls in building Glasgow Haskell +<sect1 id="sec-build-pitfalls"> +<title>Known pitfalls in building Glasgow Haskell <indexterm><primary>problems, building</primary></indexterm> <indexterm><primary>pitfalls, in building</primary></indexterm> -<indexterm><primary>building pitfalls</primary></indexterm> +building pitfalls -WARNINGS about pitfalls and known ``problems'': +WARNINGS about pitfalls and known “problems”: @@ -3398,8 +3915,8 @@ compensate for the vagaries of different sysadmin approaches to temp space.) tmp, running out of space in -The quickest way around it is setenv TMPDIR /usr/tmpTMPDIR or -even setenv TMPDIR . (or the equivalent incantation with your shell +The quickest way around it is setenv TMPDIR /usr/tmpTMPDIR or +even setenv TMPDIR . (or the equivalent incantation with your shell of choice). The best way around it is to say @@ -3409,7 +3926,7 @@ export TMPDIR=<dir> in your build.mk file. -Then GHC and the other fptools programs will use the appropriate directory +Then GHC and the other fptools programs will use the appropriate directory in all cases. @@ -3427,15 +3944,15 @@ are OK. -When compiling via C, you'll sometimes get ``warning: assignment from -incompatible pointer type'' out of GCC. Harmless. +When compiling via C, you'll sometimes get “warning: assignment from +incompatible pointer type” out of GCC. Harmless. -Similarly, archiving warning messages like the following are not +Similarly, archiving warning messages like the following are not a problem: @@ -3450,22 +3967,22 @@ ar: filename GlaIOMonad__2_2s.o truncated to GlaIOMonad_ - In compiling the compiler proper (in compiler/), you may -get an ``Out of heap space'' error message. These can vary with the + In compiling the compiler proper (in compiler/), you may +get an “Out of heap space” error message. These can vary with the vagaries of different systems, it seems. The solution is simple: - + If you're compiling with GHC 4.00 or later, then the -maximum heap size must have been reached. This +maximum heap size must have been reached. This is somewhat unlikely, since the maximum is set to 64M by default. Anyway, you can raise it with the - flag (add this flag to + flag (add this flag to <module>_HC_OPTS -make variable in the appropriate +make variable in the appropriate Makefile). @@ -3473,16 +3990,16 @@ Anyway, you can raise it with the - For GHC < 4.00, add a suitable flag to the Makefile, as + For GHC < 4.00, add a suitable flag to the Makefile, as above. - + -and try again: gmake. (see for information about +and try again: gmake. (see for information about <module>_HC_OPTS.) Alternatively, just cut to the chase: @@ -3500,9 +4017,9 @@ Alternatively, just cut to the chase: If you try to compile some Haskell, and you get errors from GCC about lots of things from /usr/include/math.h, then your GCC was -mis-installed. fixincludes wasn't run when it should've been. +mis-installed. fixincludes wasn't run when it should've been. -As fixincludes is now automagically run as part of GCC installation, +As fixincludes is now automagically run as part of GCC installation, this bug also suggests that you have an old GCC. @@ -3511,7 +4028,7 @@ this bug also suggests that you have an old GCC. -You may need to re-ranlibranlib your libraries (on Sun4s). +You may need to re-ranlibranlib your libraries (on Sun4s). @@ -3531,7 +4048,7 @@ We'd be interested to know if this is still necessary. -GHC's sources go through cpp before being compiled, and cpp varies +GHC's sources go through cpp before being compiled, and cpp varies a bit from one Unix to another. One particular gotcha is macro calls like this: @@ -3541,7 +4058,7 @@ SLIT("Hello, world") -Some cpps treat the comma inside the string as separating two macro +Some cpps treat the comma inside the string as separating two macro arguments, so you get @@ -3550,9 +4067,9 @@ arguments, so you get -Alas, cpp doesn't tell you the offending file! +Alas, cpp doesn't tell you the offending file! -Workaround: don't put weird things in string args to cpp macros. +Workaround: don't put weird things in string args to cpp macros. @@ -3560,7 +4077,7 @@ Workaround: don't put weird things in string args to cpp macr - + Notes for building under Windows @@ -3575,13 +4092,147 @@ guide) before continuing to read these notes. -Before you start +Cygwin and MinGW + + The Windows situation for building GHC is rather confusing. This section +tries to clarify, and to establish terminology. + +GHC-mingw + + MinGW (Minimalist GNU for Windows) +is a collection of header +files and import libraries that allow one to use gcc and produce +native Win32 programs that do not rely on any third-party DLLs. The +current set of tools include GNU Compiler Collection (gcc), GNU Binary +Utilities (Binutils), GNU debugger (Gdb), GNU make, and a assorted +other utilities. + +The GHC that we distribute includes, inside the distribution itself, the MinGW gcc, +as, ld, and a bunch of input/output libraries. +GHC compiles Haskell to C (or to +assembly code), and then invokes these MinGW tools to generate an executable binary. +The resulting binaries can run on any Win32 system. + + We will call a GHC that targets MinGW in this way GHC-mingw. + + The down-side of GHC-mingw is that the MinGW libraries do not support anything like the full +Posix interface. So programs compiled with GHC-mingw cannot import the (Haskell) Posix +library; they have to do +their input output using standard Haskell I/O libraries, or native Win32 bindings. + + + +GHC-cygwin + +There is a way to get the full Posix interface, which is to use Cygwin. +Cygwin is a complete Unix simulation that runs on Win32. +Cygwin comes with a shell, and all the usual Unix commands: mv, rm, +ls, plus of course gcc, ld and so on. +A C program compiled with the Cygwin gcc certainly can use all of Posix. + +So why doesn't GHC use the Cygwin gcc and libraries? Because +Cygwin comes with a DLL that must be linked with every runnable Cygwin-compiled program. +A program compiled by the Cygwin tools cannot run at all unless Cygwin is installed. +If GHC targeted Cygwin, users would have to install Cygwin just to run the Haskell programs +that GHC compiled; and the Cygwin DLL would have to be in the DLL load path. +Worse, Cygwin is a moving target. The name of the main DLL, cygwin1.dll +does not change, but the implementation certainly does. Even the interfaces to functions +it exports seem to change occasionally. So programs compiled by GHC might only run with +particular versions of Cygwin. All of this seems very undesirable. + + +Nevertheless, it is certainly possible to build a version of GHC that targets Cygwin; +we will call that GHC-cygwin. The up-side of GHC-cygwin is +that Haskell programs compiled by GHC-cygwin can import the (Haskell) Posix library. + + + +HOST_OS vs TARGET_OS + + +In the source code you'll find various ifdefs looking like: + + #ifdef mingw32_HOST_OS + ...blah blah... + #endif + +and + + #ifdef mingw32_TARGET_OS + ...blah blah... + #endif + +These macros are set by the configure script (via the file config.h). +Which is which? The criterion is this. In the ifdefs in GHC's source code: + + + The "host" system is the one on which GHC itself will be run. + + + The "target" system is the one for which the program compiled by GHC will be run. + + +For a stage-2 compiler, in which GHCi is available, the "host" and "target" systems must be the same. +So then it doesn't really matter whether you use the HOST_OS or TARGET_OS cpp macros. + + + + +Summary + +Notice that "GHC-mingw" means "GHC that targets MinGW". It says nothing about +how that GHC was built. It is entirely possible to have a GHC-mingw that was built +by compiling GHC's Haskell sources with a GHC-cygwin, or vice versa. + +We distribute only a GHC-mingw built by a GHC-mingw; supporting +GHC-cygwin too is beyond our resources. The GHC we distribute +therefore does not require Cygwin to run, nor do the programs it +compiles require Cygwin. + +The instructions that follow describe how to build GHC-mingw. It is +possible to build GHC-cygwin, but it's not a supported route, and the build system might +be flaky. + +In your build tree, you build a compiler called ghc-inplace. It +uses the gcc that you specify using the + flag when you run +configure (see below). +The makefiles are careful to use ghc-inplace (not gcc) +to compile any C files, so that it will in turn invoke the right gcc rather that +whatever one happens to be in your path. However, the makefiles do use whatever ld +and ar happen to be in your path. This is a bit naughty, but (a) they are only +used to glom together .o files into a bigger .o file, or a .a file, +so they don't ever get libraries (which would be bogus; they might be the wrong libraries), and (b) +Cygwin and Mingw use the same .o file format. So its ok. + + + + +Installing and configuring Cygwin + +You don't need Cygwin to use GHC, +but you do need it to build GHC. + + Install Cygwin from http://www.cygwin.com/. +The installation process is straightforward; we install it in c:/cygwin. +During the installation dialogue, make sure that you select: +cvs, openssh, +autoconf, +binutils (includes ld and (I think) ar), +gcc, +flex, +make. + + Now set the following user environment variables: + + Add c:/cygwin/bin and c:/cygwin/usr/bin to your +PATH + -Make sure that the user environment variable -MAKE_MODE is set to UNIX. If you +Set MAKE_MODE to UNIX. If you don't do this you get very weird messages when you type make, such as: @@ -3590,63 +4241,221 @@ don't do this you get very weird messages when you type + Set SHELL to +c:/cygwin/bin/sh. When you invoke a shell in Emacs, this +SHELL is what you get. + + + Set HOME to point to your +home directory. This is where, for example, +bash will look for your .bashrc +file. Ditto emacs looking for .emacsrc + + + + + +There are a few other things to do: + -GHC uses the mingw C compiler to -generate code, so you have to install that. Just pick up a mingw bundle at -http://www.mingw.org/. -We install it in c:/mingw. + +By default, cygwin provides the command shell ash +as sh.exe. We have often seen build-system problems that +turn out to be due to bugs in ash +(to do with quoting +and length of command lines). On the other hand bash seems +to be rock solid. +So, in cygwin/bin +remove the supplied sh.exe (or rename it as ash.exe), +and copy bash.exe to sh.exe. +You'll need to do this in Windows Explorer or the Windows cmd shell, because +you can't rename a running program! -Install a version of GHC, and put it in your -PATH (the installer tells you the path element -you need to add upon completion.) +Some script files used in the make system start with "#!/bin/perl", +(and similarly for sh). Notice the hardwired path! +So you need to ensure that your /bin directory has the following +binaries in it: + + sh + perl + cat + +All these come in Cygwin's bin directory, which you probably have +installed as c:/cygwin/bin. By default Cygwin mounts "/" as +c:/cygwin, so if you just take the defaults it'll all work ok. +(You can discover where your Cygwin +root directory / is by typing mount.) +Provided /bin points to the Cygwin bin +directory, there's no need to copy anything. If not, copy these binaries from the cygwin/bin +directory (after fixing the sh.exe stuff mentioned in the previous bullet). + + + +Finally, here are some things to be aware of when using Cygwin: + + Cygwin doesn't deal well with filenames that include +spaces. "Program Files" and "Local files" are +common gotchas. + + + Cygwin implements a symbolic link as a text file with some +magical text in it. So other programs that don't use Cygwin's +I/O libraries won't recognise such files as symlinks. +In particular, programs compiled by GHC are meant to be runnable +without having Cygwin, so they don't use the Cygwin library, so +they don't recognise symlinks. + + + +Win32 has a find command which is not the same as Cygwin's find. +You will probably discover that the Win32 find appears in your PATH +before the Cygwin one, because it's in the system PATH +environment variable, whereas you have probably modified the user PATH +variable. You can always invoke find with an absolute path, or rename it. + + + + + - - - +