1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
module Rules.BinaryDist where
import Hadrian.Haskell.Cabal
import Context
import Expression
import Oracles.Setting
import Packages
import Settings
import Target
import Utilities
{-
Note [Binary distributions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Hadrian produces binary distributions under:
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>.tar.xz
It is generated by creating an archive from:
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>/
It does so by following the steps below.
- make sure we have a complete stage 2 compiler + haddock
- copy the bin and lib directories of the compiler we built:
<build root>/stage1/{bin, lib}
to
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>/{bin, lib}
- copy the generated docs (user guide, haddocks, etc):
<build root>/docs/
to
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>/docs/
- copy haddock (built by our stage2 compiler):
<build root>/stage2/bin/haddock
to
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>/bin/haddock
- use autoreconf to generate a `configure` script from
aclocal.m4 and distrib/configure.ac, that we move to:
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>/configure
- write a (fixed) Makefile capable of supporting 'make install' to:
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>/Makefile
- write some (fixed) supporting bash code for the wrapper scripts to:
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>/wrappers/<program>
where <program> is the name of the executable that the bash file will
help wrapping.
- copy supporting configure/make related files
(see @bindistInstallFiles@) to:
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>/<file>
- create a .tar.xz archive of the directory:
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>/
at
<build root>/bindist/ghc-<X>.<Y>.<Z>-<arch>-<os>.tar.xz
Note [Wrapper scripts and binary distributions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Users of Linux, FreeBSD, Windows and OS X can unpack a
binary distribution produced by hadrian for their arch
and OS and start using @bin/ghc@, @bin/ghc-pkg@ and so on
right away, without even having to configure or install
the distribution. They would then be using the real executables
directly, not through wrapper scripts.
This works because GHCs produced by hadrian on those systems
are relocatable. This means that you can copy the @bin@ and @lib@
dirs anywhere and GHC will keep working, as long as both
directories sit next to each other. (This is achieved by having
GHC look up its $libdir relatively to where the GHC executable
resides.)
It is however still possible (and simple) to install a GHC
distribution that uses wrapper scripts. From the unpacked archive,
you can simply do:
./configure --prefix=<path> [... other configure options ...]
make install
In order to support @bin@ and @lib@ directories that don't sit next to each
other, the install script:
* installs programs into @LIBDIR/ghc-VERSION/bin@
* installs libraries into @LIBDIR/ghc-VERSION/lib@
* installs the wrappers scripts into @BINDIR@ directory
-}
bindistRules :: Rules ()
bindistRules = do
root <- buildRootRules
phony "binary-dist-dir" $ do
-- We 'need' all binaries and libraries
targets <- mapM pkgTarget =<< stagePackages Stage1
need targets
needIservBins
version <- setting ProjectVersion
targetPlatform <- setting TargetPlatformFull
distDir <- Context.distDir Stage1
rtsDir <- pkgIdentifier rts
windows <- windowsHost
let ghcBuildDir = root -/- stageString Stage1
bindistFilesDir = root -/- "bindist" -/- ghcVersionPretty
ghcVersionPretty = "ghc-" ++ version ++ "-" ++ targetPlatform
rtsIncludeDir = ghcBuildDir -/- "lib" -/- distDir -/- rtsDir
-/- "include"
-- We create the bindist directory at <root>/bindist/ghc-X.Y.Z-platform/
-- and populate it with Stage2 build results
createDirectory bindistFilesDir
copyDirectory (ghcBuildDir -/- "bin") bindistFilesDir
copyDirectory (ghcBuildDir -/- "lib") bindistFilesDir
copyDirectory (rtsIncludeDir) bindistFilesDir
need ["docs"]
-- TODO: we should only embed the docs that have been generated
-- depending on the current settings (flavours' "ghcDocs" field and
-- "--docs=.." command-line flag)
-- Currently we embed the "docs" directory if it exists but it may
-- contain outdated or even invalid data.
whenM (doesDirectoryExist (root -/- "docs")) $ do
copyDirectory (root -/- "docs") bindistFilesDir
when windows $ do
copyDirectory (root -/- "mingw") bindistFilesDir
-- we use that opportunity to delete the .stamp file that we use
-- as a proxy for the whole mingw toolchain, there's no point in
-- shipping it
removeFile (bindistFilesDir -/- mingwStamp)
-- We copy the binary (<build root>/stage1/bin/haddock) to
-- the bindist's bindir (<build root>/bindist/ghc-.../bin/).
haddockPath <- programPath (vanillaContext Stage1 haddock)
copyFile haddockPath (bindistFilesDir -/- "bin" -/- "haddock")
-- We then 'need' all the files necessary to configure and install
-- (as in, './configure [...] && make install') this build on some
-- other machine.
need $ map (bindistFilesDir -/-)
(["configure", "Makefile"] ++ bindistInstallFiles)
need $ map ((bindistFilesDir -/- "wrappers") -/-) ["check-api-annotations"
, "check-ppr", "ghc", "ghc-iserv", "ghc-pkg"
, "ghci-script", "haddock", "hpc", "hp2ps", "hsc2hs"
, "runghc"]
phony "binary-dist" $ do
need ["binary-dist-dir"]
version <- setting ProjectVersion
targetPlatform <- setting TargetPlatformFull
let ghcVersionPretty = "ghc-" ++ version ++ "-" ++ targetPlatform
-- Finally, we create the archive <root>/bindist/ghc-X.Y.Z-platform.tar.xz
tarPath <- builderPath (Tar Create)
cmd [Cwd $ root -/- "bindist"] tarPath
[ "-c", "--xz", "-f"
, ghcVersionPretty <.> "tar.xz"
, ghcVersionPretty ]
-- Prepare binary distribution configure script
-- (generated under <ghc root>/distrib/configure by 'autoreconf')
root -/- "bindist" -/- "ghc-*" -/- "configure" %> \configurePath -> do
ghcRoot <- topDirectory
copyFile (ghcRoot -/- "aclocal.m4") (ghcRoot -/- "distrib" -/- "aclocal.m4")
buildWithCmdOptions [] $
target (vanillaContext Stage1 ghc) (Autoreconf $ ghcRoot -/- "distrib") [] []
-- We clean after ourselves, moving the configure script we generated in
-- our bindist dir
removeFile (ghcRoot -/- "distrib" -/- "aclocal.m4")
moveFile (ghcRoot -/- "distrib" -/- "configure") configurePath
-- Generate the Makefile that enables the "make install" part
root -/- "bindist" -/- "ghc-*" -/- "Makefile" %> \makefilePath -> do
top <- topDirectory
copyFile (top -/- "hadrian" -/- "bindist" -/- "Makefile") makefilePath
root -/- "bindist" -/- "ghc-*" -/- "wrappers/*" %> \wrapperPath ->
writeFile' wrapperPath $ wrapper (takeFileName wrapperPath)
-- Copy various configure-related files needed for a working
-- './configure [...] && make install' workflow
-- (see the list of files needed in the 'binary-dist' rule above, before
-- creating the archive).
forM_ bindistInstallFiles $ \file ->
root -/- "bindist" -/- "ghc-*" -/- file %> \dest -> do
ghcRoot <- topDirectory
copyFile (ghcRoot -/- fixup file) dest
where
fixup f | f `elem` ["INSTALL", "README"] = "distrib" -/- f
| otherwise = f
-- | A list of files that allow us to support a simple
-- @./configure [...] && make install@ workflow.
bindistInstallFiles :: [FilePath]
bindistInstallFiles =
[ "config.sub", "config.guess", "install-sh", "mk" -/- "config.mk.in"
, "mk" -/- "install.mk.in", "mk" -/- "project.mk", "README"
, "INSTALL" ]
-- | This auxiliary function gives us a top-level 'Filepath' that we can 'need'
-- for all libraries and programs that are needed for a complete build.
-- For libraries, it returns the path to the @.conf@ file in the package
-- database. For programs, it returns the path to the compiled executable.
pkgTarget :: Package -> Action FilePath
pkgTarget pkg
| isLibrary pkg = pkgConfFile (vanillaContext Stage1 pkg)
| otherwise = programPath =<< programContext Stage1 pkg
wrapper :: FilePath -> String
wrapper "ghc" = ghcWrapper
wrapper "ghc-pkg" = ghcPkgWrapper
wrapper "ghci-script" = ghciScriptWrapper
wrapper "haddock" = haddockWrapper
wrapper "hsc2hs" = hsc2hsWrapper
wrapper "runghc" = runGhcWrapper
wrapper _ = commonWrapper
-- | Wrapper scripts for different programs. Common is default wrapper.
ghcWrapper :: String
ghcWrapper = "exec \"$executablename\" -B\"$libdir\" ${1+\"$@\"}\n"
ghcPkgWrapper :: String
ghcPkgWrapper = unlines
[ "PKGCONF=\"$libdir/package.conf.d\""
, "exec \"$executablename\" --global-package-db \"$PKGCONF\" ${1+\"$@\"}" ]
haddockWrapper :: String
haddockWrapper = "exec \"$executablename\" -B\"$libdir\" -l\"$libdir\" ${1+\"$@\"}\n"
commonWrapper :: String
commonWrapper = "exec \"$executablename\" ${1+\"$@\"}\n"
hsc2hsWrapper :: String
hsc2hsWrapper = unlines
[ "HSC2HS_EXTRA=\"--cflag=-fno-stack-protector --lflag=-fuse-ld=gold\""
, "tflag=\"--template=$libdir/template-hsc.h\""
, "Iflag=\"-I$includedir/\""
, "for arg do"
, " case \"$arg\" in"
, "# On OS X, we need to specify -m32 or -m64 in order to get gcc to"
, "# build binaries for the right target. We do that by putting it in"
, "# HSC2HS_EXTRA. When cabal runs hsc2hs, it passes a flag saying which"
, "# gcc to use, so if we set HSC2HS_EXTRA= then we don't get binaries"
, "# for the right platform. So for now we just don't set HSC2HS_EXTRA="
, "# but we probably want to revisit how this works in the future."
, "# -c*) HSC2HS_EXTRA=;;"
, "# --cc=*) HSC2HS_EXTRA=;;"
, " -t*) tflag=;;"
, " --template=*) tflag=;;"
, " --) break;;"
, " esac"
, "done"
, "exec \"$executablename\" ${tflag:+\"$tflag\"} $HSC2HS_EXTRA ${1+\"$@\"} \"$Iflag\"" ]
runGhcWrapper :: String
runGhcWrapper = "exec \"$executablename\" -f \"$exedir/ghc\" ${1+\"$@\"}\n"
-- | We need to ship ghci executable, which basically just calls ghc with
-- | --interactive flag.
ghciScriptWrapper :: String
ghciScriptWrapper = unlines
[ "DIR=`dirname \"$0\"`"
, "executable=\"$DIR/ghc\""
, "exec $executable --interactive \"$@\"" ]
-- | When not on Windows, we want to ship the 3 flavours of the iserv program
-- in binary distributions. This isn't easily achievable by just asking for
-- the package to be built, since here we're generating 3 different
-- executables out of just one package, so we need to specify all 3 contexts
-- explicitly and 'need' the result of building them.
needIservBins :: Action ()
needIservBins = do
windows <- windowsHost
when (not windows) $ do
rtsways <- interpretInContext (vanillaContext Stage1 ghc) getRtsWays
need =<< traverse programPath
[ Context Stage1 iserv w
| w <- [vanilla, profiling, dynamic]
, w `elem` rtsways
]
|
