···
1
+
# DO NOT port this expression to hadrian. It is not possible to build a GHC
2
+
# cross compiler with 9.4.* and hadrian.
3
+
{ lib, stdenv, pkgsBuildTarget, pkgsHostTarget, targetPackages
7
+
, autoconf, automake, coreutils, fetchpatch, fetchurl, perl, python3, m4, sphinx
8
+
, xattr, autoSignDarwinBinariesHook
11
+
, libiconv ? null, ncurses
12
+
, glibcLocales ? null
14
+
, # GHC can be built with system libffi or a bundled one.
17
+
, useLLVM ? !(stdenv.targetPlatform.isx86
18
+
|| stdenv.targetPlatform.isPower
19
+
|| stdenv.targetPlatform.isSparc
20
+
|| (stdenv.targetPlatform.isAarch64 && stdenv.targetPlatform.isDarwin))
21
+
, # LLVM is conceptually a run-time-only depedendency, but for
22
+
# non-x86, we need LLVM to bootstrap later stages, so it becomes a
23
+
# build-time dependency too.
24
+
buildTargetLlvmPackages, llvmPackages
26
+
, # If enabled, GHC will be built with the GPL-free but slightly slower native
27
+
# bignum backend instead of the faster but GPLed gmp backend.
28
+
enableNativeBignum ? !(lib.meta.availableOn stdenv.hostPlatform gmp
29
+
&& lib.meta.availableOn stdenv.targetPlatform gmp)
32
+
, # If enabled, use -fPIC when compiling static libs.
33
+
enableRelocatedStaticLibs ? stdenv.targetPlatform != stdenv.hostPlatform
35
+
# aarch64 outputs otherwise exceed 2GB limit
36
+
, enableProfiledLibs ? !stdenv.targetPlatform.isAarch64
38
+
, # Whether to build dynamic libs for the standard library (on the target
39
+
# platform). Static libs are always built.
40
+
enableShared ? with stdenv.targetPlatform; !isWindows && !useiOSPrebuilt && !isStatic
42
+
, # Whether to build terminfo.
43
+
enableTerminfo ? !stdenv.targetPlatform.isWindows
45
+
, # What flavour to build. An empty string indicates no
46
+
# specific flavour and falls back to ghc default values.
47
+
ghcFlavour ? lib.optionalString (stdenv.targetPlatform != stdenv.hostPlatform)
48
+
(if useLLVM then "perf-cross" else "perf-cross-ncg")
50
+
, # Whether to build sphinx documentation.
52
+
# Docs disabled for musl and cross because it's a large task to keep
53
+
# all `sphinx` dependencies building in those environments.
54
+
# `sphinx` pulls in among others:
55
+
# Ruby, Python, Perl, Rust, OpenGL, Xorg, gtk, LLVM.
56
+
(stdenv.targetPlatform == stdenv.hostPlatform)
57
+
&& !stdenv.hostPlatform.isMusl
60
+
, enableHaddockProgram ?
61
+
# Disabled for cross; see note [HADDOCK_DOCS].
62
+
(stdenv.targetPlatform == stdenv.hostPlatform)
64
+
, # Whether to disable the large address space allocator
65
+
# necessary fix for iOS: https://www.reddit.com/r/haskell/comments/4ttdz1/building_an_osxi386_to_iosarm64_cross_compiler/d5qvd67/
66
+
disableLargeAddressSpace ? stdenv.targetPlatform.isiOS
69
+
assert !enableNativeBignum -> gmp != null;
71
+
# Cross cannot currently build the `haddock` program for silly reasons,
72
+
# see note [HADDOCK_DOCS].
73
+
assert (stdenv.targetPlatform != stdenv.hostPlatform) -> !enableHaddockProgram;
76
+
inherit (stdenv) buildPlatform hostPlatform targetPlatform;
78
+
inherit (bootPkgs) ghc;
80
+
# TODO(@Ericson2314) Make unconditional
81
+
targetPrefix = lib.optionalString
82
+
(targetPlatform != hostPlatform)
83
+
"${targetPlatform.config}-";
86
+
BuildFlavour = ${ghcFlavour}
87
+
ifneq \"\$(BuildFlavour)\" \"\"
88
+
include mk/flavours/\$(BuildFlavour).mk
90
+
BUILD_SPHINX_HTML = ${if enableDocs then "YES" else "NO"}
91
+
BUILD_SPHINX_PDF = NO
93
+
# Note [HADDOCK_DOCS]:
94
+
# Unfortunately currently `HADDOCK_DOCS` controls both whether the `haddock`
95
+
# program is built (which we generally always want to have a complete GHC install)
96
+
# and whether it is run on the GHC sources to generate hyperlinked source code
97
+
# (which is impossible for cross-compilation); see:
98
+
# https://gitlab.haskell.org/ghc/ghc/-/issues/20077
99
+
# This implies that currently a cross-compiled GHC will never have a `haddock`
100
+
# program, so it can never generate haddocks for any packages.
101
+
# If this is solved in the future, we'd like to unconditionally
102
+
# build the haddock program (removing the `enableHaddockProgram` option).
104
+
HADDOCK_DOCS = ${if enableHaddockProgram then "YES" else "NO"}
105
+
# Build haddocks for boot packages with hyperlinking
106
+
EXTRA_HADDOCK_OPTS += --hyperlinked-source --quickjump
108
+
DYNAMIC_GHC_PROGRAMS = ${if enableShared then "YES" else "NO"}
109
+
BIGNUM_BACKEND = ${if enableNativeBignum then "native" else "gmp"}
110
+
'' + lib.optionalString (targetPlatform != hostPlatform) ''
111
+
Stage1Only = ${if targetPlatform.system == hostPlatform.system then "NO" else "YES"}
112
+
CrossCompilePrefix = ${targetPrefix}
113
+
'' + lib.optionalString (!enableProfiledLibs) ''
114
+
GhcLibWays = "v dyn"
116
+
# -fexternal-dynamic-refs apparently (because it's not clear from the documentation)
117
+
# makes the GHC RTS able to load static libraries, which may be needed for TemplateHaskell.
118
+
# This solution was described in https://www.tweag.io/blog/2020-09-30-bazel-static-haskell
119
+
lib.optionalString enableRelocatedStaticLibs ''
120
+
GhcLibHcOpts += -fPIC -fexternal-dynamic-refs
121
+
GhcRtsHcOpts += -fPIC -fexternal-dynamic-refs
122
+
'' + lib.optionalString targetPlatform.useAndroidPrebuilt ''
123
+
EXTRA_CC_OPTS += -std=gnu99
126
+
# Splicer will pull out correct variations
127
+
libDeps = platform: lib.optional enableTerminfo ncurses
129
+
++ lib.optional (!enableNativeBignum) gmp
130
+
++ lib.optional (platform.libc != "glibc" && !targetPlatform.isWindows) libiconv;
132
+
# TODO(@sternenseemann): is buildTarget LLVM unnecessary?
133
+
# GHC doesn't seem to have {LLC,OPT}_HOST
135
+
pkgsBuildTarget.targetPackages.stdenv.cc
136
+
] ++ lib.optional useLLVM buildTargetLlvmPackages.llvm;
138
+
targetCC = builtins.head toolsForTarget;
140
+
# Sometimes we have to dispatch between the bintools wrapper and the unwrapped
141
+
# derivation for certain tools depending on the platform.
143
+
# GHC needs install_name_tool on all darwin platforms. On aarch64-darwin it is
144
+
# part of the bintools wrapper (due to codesigning requirements), but not on
146
+
install_name_tool =
147
+
if stdenv.targetPlatform.isAarch64
148
+
then targetCC.bintools
149
+
else targetCC.bintools.bintools;
150
+
# Same goes for strip.
152
+
# TODO(@sternenseemann): also use wrapper if linker == "bfd" or "gold"
153
+
if stdenv.targetPlatform.isAarch64 && stdenv.targetPlatform.isDarwin
154
+
then targetCC.bintools
155
+
else targetCC.bintools.bintools;
158
+
# Use gold either following the default, or to avoid the BFD linker due to some bugs / perf issues.
159
+
# But we cannot avoid BFD when using musl libc due to https://sourceware.org/bugzilla/show_bug.cgi?id=23856
160
+
# see #84670 and #49071 for more background.
161
+
useLdGold = targetPlatform.linker == "gold" ||
162
+
(targetPlatform.linker == "bfd" && (targetCC.bintools.bintools.hasGold or false) && !targetPlatform.isMusl);
164
+
# Makes debugging easier to see which variant is at play in `nix-store -q --tree`.
165
+
variantSuffix = lib.concatStrings [
166
+
(lib.optionalString stdenv.hostPlatform.isMusl "-musl")
167
+
(lib.optionalString enableNativeBignum "-native-bignum")
172
+
# C compiler, bintools and LLVM are used at build time, but will also leak into
173
+
# the resulting GHC's settings file and used at runtime. This means that we are
174
+
# currently only able to build GHC if hostPlatform == buildPlatform.
175
+
assert targetCC == pkgsHostTarget.targetPackages.stdenv.cc;
176
+
assert buildTargetLlvmPackages.llvm == llvmPackages.llvm;
177
+
assert stdenv.targetPlatform.isDarwin -> buildTargetLlvmPackages.clang == llvmPackages.clang;
179
+
stdenv.mkDerivation (rec {
181
+
pname = "${targetPrefix}ghc${variantSuffix}";
184
+
url = "https://downloads.haskell.org/ghc/${version}/ghc-${version}-src.tar.xz";
185
+
sha256 = "6256cf9caf6d6dc7b611dcfbb247df2d528e85aa39d22a698e870e5a590e8601";
188
+
enableParallelBuilding = true;
190
+
outputs = [ "out" "doc" ];
193
+
# Don't generate code that doesn't compile when --enable-relocatable is passed to Setup.hs
194
+
# Can be removed if the Cabal library included with ghc backports the linked fix
196
+
url = "https://github.com/haskell/cabal/commit/6c796218c92f93c95e94d5ec2d077f6956f68e98.patch";
198
+
extraPrefix = "libraries/Cabal/";
199
+
sha256 = "sha256-yRQ6YmMiwBwiYseC5BsrEtDgFbWvst+maGgDtdD0vAY=";
202
+
# Fix docs build with sphinx >= 6.0
203
+
# https://gitlab.haskell.org/ghc/ghc/-/issues/22766
205
+
name = "ghc-docs-sphinx-6.0.patch";
206
+
url = "https://gitlab.haskell.org/ghc/ghc/-/commit/10e94a556b4f90769b7fd718b9790d58ae566600.patch";
207
+
sha256 = "0kmhfamr16w8gch0lgln2912r8aryjky1hfcda3jkcwa5cdzgjdv";
211
+
postPatch = "patchShebangs .";
213
+
# GHC needs the locale configured during the Haddock phase.
214
+
LANG = "en_US.UTF-8";
216
+
# GHC is a bit confused on its cross terminology.
217
+
# TODO(@sternenseemann): investigate coreutils dependencies and pass absolute paths
219
+
for env in $(env | grep '^TARGET_' | sed -E 's|\+?=.*||'); do
220
+
export "''${env#TARGET_}=''${!env}"
222
+
# GHC is a bit confused on its cross terminology, as these would normally be
223
+
# the *host* tools.
224
+
export CC="${targetCC}/bin/${targetCC.targetPrefix}cc"
225
+
export CXX="${targetCC}/bin/${targetCC.targetPrefix}c++"
226
+
# Use gold to work around https://sourceware.org/bugzilla/show_bug.cgi?id=16177
227
+
export LD="${targetCC.bintools}/bin/${targetCC.bintools.targetPrefix}ld${lib.optionalString useLdGold ".gold"}"
228
+
export AS="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}as"
229
+
export AR="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}ar"
230
+
export NM="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}nm"
231
+
export RANLIB="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}ranlib"
232
+
export READELF="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}readelf"
233
+
export STRIP="${bintoolsFor.strip}/bin/${bintoolsFor.strip.targetPrefix}strip"
234
+
'' + lib.optionalString (stdenv.targetPlatform.linker == "cctools") ''
235
+
export OTOOL="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}otool"
236
+
export INSTALL_NAME_TOOL="${bintoolsFor.install_name_tool}/bin/${bintoolsFor.install_name_tool.targetPrefix}install_name_tool"
237
+
'' + lib.optionalString useLLVM ''
238
+
export LLC="${lib.getBin buildTargetLlvmPackages.llvm}/bin/llc"
239
+
export OPT="${lib.getBin buildTargetLlvmPackages.llvm}/bin/opt"
240
+
'' + lib.optionalString (useLLVM && stdenv.targetPlatform.isDarwin) ''
241
+
# LLVM backend on Darwin needs clang: https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/codegens.html#llvm-code-generator-fllvm
242
+
export CLANG="${buildTargetLlvmPackages.clang}/bin/${buildTargetLlvmPackages.clang.targetPrefix}clang"
245
+
echo -n "${buildMK}" > mk/build.mk
247
+
sed -i -e 's|-isysroot /Developer/SDKs/MacOSX10.5.sdk||' configure
248
+
'' + lib.optionalString (stdenv.isLinux && hostPlatform.libc == "glibc") ''
249
+
export LOCALE_ARCHIVE="${glibcLocales}/lib/locale/locale-archive"
250
+
'' + lib.optionalString (!stdenv.isDarwin) ''
251
+
export NIX_LDFLAGS+=" -rpath $out/lib/ghc-${version}"
252
+
'' + lib.optionalString stdenv.isDarwin ''
253
+
export NIX_LDFLAGS+=" -no_dtrace_dof"
255
+
# GHC tries the host xattr /usr/bin/xattr by default which fails since it expects python to be 2.7
256
+
export XATTR=${lib.getBin xattr}/bin/xattr
257
+
'' + lib.optionalString targetPlatform.useAndroidPrebuilt ''
258
+
sed -i -e '5i ,("armv7a-unknown-linux-androideabi", ("e-m:e-p:32:32-i64:64-v128:64:128-a:0:32-n32-S64", "cortex-a8", ""))' llvm-targets
259
+
'' + lib.optionalString targetPlatform.isMusl ''
260
+
echo "patching llvm-targets for musl targets..."
261
+
echo "Cloning these existing '*-linux-gnu*' targets:"
262
+
grep linux-gnu llvm-targets | sed 's/^/ /'
263
+
echo "(go go gadget sed)"
264
+
sed -i 's,\(^.*linux-\)gnu\(.*\)$,\0\n\1musl\2,' llvm-targets
265
+
echo "llvm-targets now contains these '*-linux-musl*' targets:"
266
+
grep linux-musl llvm-targets | sed 's/^/ /'
268
+
echo "And now patching to preserve '-musleabi' as done with '-gnueabi'"
269
+
# (aclocal.m4 is actual source, but patch configure as well since we don't re-gen)
270
+
for x in configure aclocal.m4; do
271
+
substituteInPlace $x \
272
+
--replace '*-android*|*-gnueabi*)' \
273
+
'*-android*|*-gnueabi*|*-musleabi*)'
276
+
# HACK: allow bootstrapping with GHC 8.10 which works fine, as we don't have
277
+
# binary 9.0 packaged. Bootstrapping with 9.2 is broken without hadrian.
279
+
substituteInPlace configure --replace \
280
+
'MinBootGhcVersion="9.0"' \
281
+
'MinBootGhcVersion="8.10"'
284
+
# TODO(@Ericson2314): Always pass "--target" and always prefix.
285
+
configurePlatforms = [ "build" "host" ]
286
+
++ lib.optional (targetPlatform != hostPlatform) "target";
288
+
# `--with` flags for libraries needed for RTS linker
290
+
"--datadir=$doc/share/doc/ghc"
291
+
"--with-curses-includes=${ncurses.dev}/include" "--with-curses-libraries=${ncurses.out}/lib"
292
+
] ++ lib.optionals (libffi != null) [
293
+
"--with-system-libffi"
294
+
"--with-ffi-includes=${targetPackages.libffi.dev}/include"
295
+
"--with-ffi-libraries=${targetPackages.libffi.out}/lib"
296
+
] ++ lib.optionals (targetPlatform == hostPlatform && !enableNativeBignum) [
297
+
"--with-gmp-includes=${targetPackages.gmp.dev}/include"
298
+
"--with-gmp-libraries=${targetPackages.gmp.out}/lib"
299
+
] ++ lib.optionals (targetPlatform == hostPlatform && hostPlatform.libc != "glibc" && !targetPlatform.isWindows) [
300
+
"--with-iconv-includes=${libiconv}/include"
301
+
"--with-iconv-libraries=${libiconv}/lib"
302
+
] ++ lib.optionals (targetPlatform != hostPlatform) [
303
+
"--enable-bootstrap-with-devel-snapshot"
304
+
] ++ lib.optionals useLdGold [
305
+
"CFLAGS=-fuse-ld=gold"
306
+
"CONF_GCC_LINKER_OPTS_STAGE1=-fuse-ld=gold"
307
+
"CONF_GCC_LINKER_OPTS_STAGE2=-fuse-ld=gold"
308
+
] ++ lib.optionals (disableLargeAddressSpace) [
309
+
"--disable-large-address-space"
312
+
# Make sure we never relax`$PATH` and hooks support for compatibility.
315
+
# Don’t add -liconv to LDFLAGS automatically so that GHC will add it itself.
316
+
dontAddExtraLibs = true;
318
+
nativeBuildInputs = [
319
+
perl autoconf automake m4 python3
320
+
ghc bootPkgs.alex bootPkgs.happy bootPkgs.hscolour
321
+
] ++ lib.optionals (stdenv.isDarwin && stdenv.isAarch64) [
322
+
autoSignDarwinBinariesHook
323
+
] ++ lib.optionals enableDocs [
327
+
# For building runtime libs
328
+
depsBuildTarget = toolsForTarget;
330
+
buildInputs = [ perl bash ] ++ (libDeps hostPlatform);
332
+
depsTargetTarget = map lib.getDev (libDeps targetPlatform);
333
+
depsTargetTargetPropagated = map (lib.getOutput "out") (libDeps targetPlatform);
335
+
# required, because otherwise all symbols from HSffi.o are stripped, and
336
+
# that in turn causes GHCi to abort
337
+
stripDebugFlags = [ "-S" ] ++ lib.optional (!targetPlatform.isDarwin) "--keep-file-symbols";
339
+
checkTarget = "test";
343
+
# In nixpkgs, musl based builds currently enable `pie` hardening by default
344
+
# (see `defaultHardeningFlags` in `make-derivation.nix`).
345
+
# But GHC cannot currently produce outputs that are ready for `-pie` linking.
346
+
# Thus, disable `pie` hardening, otherwise `recompile with -fPIE` errors appear.
348
+
# * https://github.com/NixOS/nixpkgs/issues/129247
349
+
# * https://gitlab.haskell.org/ghc/ghc/-/issues/19580
350
+
++ lib.optional stdenv.targetPlatform.isMusl "pie";
352
+
# big-parallel allows us to build with more than 2 cores on
353
+
# Hydra which already warrants a significant speedup
354
+
requiredSystemFeatures = [ "big-parallel" ];
357
+
# Install the bash completion file.
358
+
install -D -m 444 utils/completion/ghc.bash $out/share/bash-completion/completions/${targetPrefix}ghc
362
+
inherit bootPkgs targetPrefix;
364
+
inherit llvmPackages;
365
+
inherit enableShared;
367
+
# This is used by the haskell builder to query
368
+
# the presence of the haddock program.
369
+
hasHaddock = enableHaddockProgram;
371
+
# Our Cabal compiler name
372
+
haskellCompilerName = "ghc-${version}";
376
+
homepage = "http://haskell.org/ghc";
377
+
description = "The Glasgow Haskell Compiler";
378
+
maintainers = with lib.maintainers; [
380
+
] ++ lib.teams.haskell.members;
381
+
timeout = 24 * 3600;
382
+
inherit (ghc.meta) license platforms;
385
+
} // lib.optionalAttrs targetPlatform.useAndroidPrebuilt {
387
+
dontPatchELF = true;
388
+
noAuditTmpdir = true;
pyrox.dev