mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-12-19 04:03:56 +00:00
17b8b5a4dc
GHC can actually accept absolute paths for its runtime tools (except for
touch) at configure time which are then saved in
`$out/lib/ghc-${version}/settings`. This allows us to drop the wrapper
entirely if we assume that a POSIX compliant touch is in PATH when we
run GHC later.
The touch problem can presumably be fixed by either patching the
configure file of GHC (although we need to take care not to change the
touch GHC uses during its compilation) or messing with the settings file
after installation.
The rationale for dropping the wrapper PATH entry completely is that
it's always possible to invoke GHC via its library which will bypass the
wrapper completely, leading to subtly different behavior.
Binary GHCs are not touched in this commit, but ideally they'll get a
similar treatment as well, so they are more robust, although we
generally don't need to use them as a library.
Note that GHC 8.8.4 doesn't care about install_name_tool or otool, so
the respective environment variables are not set.
366 lines
16 KiB
Nix
366 lines
16 KiB
Nix
{ lib, stdenv, pkgsBuildTarget, targetPackages
|
||
|
||
# build-tools
|
||
, bootPkgs
|
||
, autoconf, automake, coreutils, fetchpatch, fetchurl, perl, python3, m4, sphinx
|
||
, bash
|
||
|
||
, libiconv ? null, ncurses
|
||
|
||
, # GHC can be built with system libffi or a bundled one.
|
||
libffi ? null
|
||
|
||
, useLLVM ? !stdenv.targetPlatform.isx86
|
||
, # LLVM is conceptually a run-time-only depedendency, but for
|
||
# non-x86, we need LLVM to bootstrap later stages, so it becomes a
|
||
# build-time dependency too.
|
||
buildTargetLlvmPackages, llvmPackages
|
||
|
||
, # If enabled, GHC will be built with the GPL-free but slower integer-simple
|
||
# library instead of the faster but GPLed integer-gmp library.
|
||
enableIntegerSimple ? !(lib.meta.availableOn stdenv.hostPlatform gmp), gmp
|
||
|
||
, # If enabled, use -fPIC when compiling static libs.
|
||
enableRelocatedStaticLibs ? stdenv.targetPlatform != stdenv.hostPlatform
|
||
|
||
# aarch64 outputs otherwise exceed 2GB limit
|
||
, enableProfiledLibs ? !stdenv.targetPlatform.isAarch64
|
||
|
||
, # Whether to build dynamic libs for the standard library (on the target
|
||
# platform). Static libs are always built.
|
||
enableShared ? !stdenv.targetPlatform.isWindows && !stdenv.targetPlatform.useiOSPrebuilt
|
||
|
||
, # Whether to build terminfo.
|
||
enableTerminfo ? !stdenv.targetPlatform.isWindows
|
||
|
||
, # What flavour to build. An empty string indicates no
|
||
# specific flavour and falls back to ghc default values.
|
||
ghcFlavour ? lib.optionalString (stdenv.targetPlatform != stdenv.hostPlatform)
|
||
(if useLLVM then "perf-cross" else "perf-cross-ncg")
|
||
|
||
, # Whether to build sphinx documentation.
|
||
enableDocs ? (
|
||
# Docs disabled for musl and cross because it's a large task to keep
|
||
# all `sphinx` dependencies building in those environments.
|
||
# `sphinx` pullls in among others:
|
||
# Ruby, Python, Perl, Rust, OpenGL, Xorg, gtk, LLVM.
|
||
(stdenv.targetPlatform == stdenv.hostPlatform)
|
||
&& !stdenv.hostPlatform.isMusl
|
||
)
|
||
|
||
, enableHaddockProgram ?
|
||
# Disabled for cross; see note [HADDOCK_DOCS].
|
||
(stdenv.targetPlatform == stdenv.hostPlatform)
|
||
|
||
, # Whether to disable the large address space allocator
|
||
# necessary fix for iOS: https://www.reddit.com/r/haskell/comments/4ttdz1/building_an_osxi386_to_iosarm64_cross_compiler/d5qvd67/
|
||
disableLargeAddressSpace ? stdenv.targetPlatform.isDarwin && stdenv.targetPlatform.isAarch64
|
||
}:
|
||
|
||
assert !enableIntegerSimple -> gmp != null;
|
||
|
||
# Cross cannot currently build the `haddock` program for silly reasons,
|
||
# see note [HADDOCK_DOCS].
|
||
assert (stdenv.targetPlatform != stdenv.hostPlatform) -> !enableHaddockProgram;
|
||
|
||
let
|
||
inherit (stdenv) buildPlatform hostPlatform targetPlatform;
|
||
|
||
inherit (bootPkgs) ghc;
|
||
|
||
# TODO(@Ericson2314) Make unconditional
|
||
targetPrefix = lib.optionalString
|
||
(targetPlatform != hostPlatform)
|
||
"${targetPlatform.config}-";
|
||
|
||
buildMK = dontStrip: ''
|
||
BuildFlavour = ${ghcFlavour}
|
||
ifneq \"\$(BuildFlavour)\" \"\"
|
||
include mk/flavours/\$(BuildFlavour).mk
|
||
endif
|
||
BUILD_SPHINX_HTML = ${if enableDocs then "YES" else "NO"}
|
||
BUILD_SPHINX_PDF = NO
|
||
'' +
|
||
# Note [HADDOCK_DOCS]:
|
||
# Unfortunately currently `HADDOCK_DOCS` controls both whether the `haddock`
|
||
# program is built (which we generally always want to have a complete GHC install)
|
||
# and whether it is run on the GHC sources to generate hyperlinked source code
|
||
# (which is impossible for cross-compilation); see:
|
||
# https://gitlab.haskell.org/ghc/ghc/-/issues/20077
|
||
# This implies that currently a cross-compiled GHC will never have a `haddock`
|
||
# program, so it can never generate haddocks for any packages.
|
||
# If this is solved in the future, we'd like to unconditionally
|
||
# build the haddock program (removing the `enableHaddockProgram` option).
|
||
''
|
||
HADDOCK_DOCS = ${if enableHaddockProgram then "YES" else "NO"}
|
||
DYNAMIC_GHC_PROGRAMS = ${if enableShared then "YES" else "NO"}
|
||
INTEGER_LIBRARY = ${if enableIntegerSimple then "integer-simple" else "integer-gmp"}
|
||
''
|
||
# We only need to build stage1 on most cross-compilation because
|
||
# we will be running the compiler on the native system. In some
|
||
# situations, like native Musl compilation, we need the compiler
|
||
# to actually link to our new Libc. The iOS simulator is a special
|
||
# exception because we can’t actually run simulators binaries
|
||
# ourselves.
|
||
+ lib.optionalString (targetPlatform != hostPlatform) ''
|
||
Stage1Only = ${if (targetPlatform.system == hostPlatform.system && !targetPlatform.isiOS) then "NO" else "YES"}
|
||
CrossCompilePrefix = ${targetPrefix}
|
||
'' + lib.optionalString dontStrip ''
|
||
STRIP_CMD = :
|
||
'' + lib.optionalString (!enableProfiledLibs) ''
|
||
GhcLibWays = "v dyn"
|
||
'' + lib.optionalString enableRelocatedStaticLibs ''
|
||
GhcLibHcOpts += -fPIC
|
||
GhcRtsHcOpts += -fPIC
|
||
'' + lib.optionalString targetPlatform.useAndroidPrebuilt ''
|
||
EXTRA_CC_OPTS += -std=gnu99
|
||
''
|
||
# While split sections are now enabled by default in ghc 8.8 for windows,
|
||
# they seem to lead to `too many sections` errors when building base for
|
||
# profiling.
|
||
+ lib.optionalString targetPlatform.isWindows ''
|
||
SplitSections = NO
|
||
'';
|
||
|
||
# Splicer will pull out correct variations
|
||
libDeps = platform: lib.optional enableTerminfo ncurses
|
||
++ [libffi]
|
||
++ lib.optional (!enableIntegerSimple) gmp
|
||
++ lib.optional (platform.libc != "glibc" && !targetPlatform.isWindows) libiconv;
|
||
|
||
# TODO(@sternenseemann): is buildTarget LLVM unnecessary?
|
||
# GHC doesn't seem to have {LLC,OPT}_HOST
|
||
toolsForTarget = [
|
||
pkgsBuildTarget.targetPackages.stdenv.cc
|
||
] ++ lib.optional useLLVM buildTargetLlvmPackages.llvm;
|
||
|
||
targetCC = builtins.head toolsForTarget;
|
||
|
||
# Use gold either following the default, or to avoid the BFD linker due to some bugs / perf issues.
|
||
# But we cannot avoid BFD when using musl libc due to https://sourceware.org/bugzilla/show_bug.cgi?id=23856
|
||
# see #84670 and #49071 for more background.
|
||
useLdGold = targetPlatform.linker == "gold" ||
|
||
(targetPlatform.linker == "bfd" && (targetPackages.stdenv.cc.bintools.bintools.hasGold or false) && !targetPlatform.isMusl);
|
||
|
||
# Makes debugging easier to see which variant is at play in `nix-store -q --tree`.
|
||
variantSuffix = lib.concatStrings [
|
||
(lib.optionalString stdenv.hostPlatform.isMusl "-musl")
|
||
(lib.optionalString enableIntegerSimple "-integer-simple")
|
||
];
|
||
|
||
in
|
||
stdenv.mkDerivation (rec {
|
||
version = "8.8.4";
|
||
pname = "${targetPrefix}ghc${variantSuffix}";
|
||
|
||
src = fetchurl {
|
||
url = "https://downloads.haskell.org/ghc/${version}/ghc-${version}-src.tar.xz";
|
||
sha256 = "0bgwbxxvdn56l91bp9p5d083gzcfdi6z8l8b17qzjpr3n8w5wl7h";
|
||
};
|
||
|
||
enableParallelBuilding = true;
|
||
|
||
outputs = [ "out" "doc" ];
|
||
|
||
patches = [
|
||
# See upstream patch at
|
||
# https://gitlab.haskell.org/ghc/ghc/-/merge_requests/4885. Since we build
|
||
# from source distributions, the auto-generated configure script needs to be
|
||
# patched as well, therefore we use an in-tree patch instead of pulling the
|
||
# upstream patch. Don't forget to check backport status of the upstream patch
|
||
# when adding new GHC releases in nixpkgs.
|
||
./respect-ar-path.patch
|
||
# Fix documentation configuration which causes a syntax error with sphinx 4.*
|
||
# See also https://gitlab.haskell.org/ghc/ghc/-/issues/19962
|
||
./sphinx-4-configuration.patch
|
||
# cabal passes incorrect --host= when cross-compiling
|
||
# https://github.com/haskell/cabal/issues/5887
|
||
(fetchpatch {
|
||
url = "https://raw.githubusercontent.com/input-output-hk/haskell.nix/122bd81150386867da07fdc9ad5096db6719545a/overlays/patches/ghc/cabal-host.patch";
|
||
sha256 = "sha256:0yd0sajgi24sc1w5m55lkg2lp6kfkgpp3lgija2c8y3cmkwfpdc1";
|
||
})
|
||
|
||
# error: 'VirtualAllocExNuma' redeclared as different kind of symbol
|
||
# name conflict between rts/win32/OSMem.c and winbase.h from the mingw-w64 runtime package
|
||
# Renamed to match ghc8.8:
|
||
# https://gitlab.haskell.org/ghc/ghc/-/commit/4b431f334018eaef2cf36de3316025c68c922915#20d64c0bdc272817149d1d5cf20a73a8b5fd637f
|
||
./rename-numa-api-call.patch
|
||
];
|
||
|
||
postPatch = "patchShebangs .";
|
||
|
||
# GHC is a bit confused on its cross terminology.
|
||
# TODO(@sternenseemann): investigate coreutils dependencies and pass absolute paths
|
||
preConfigure =
|
||
# Aarch64 allow backward bootstrapping since earlier versions are unstable.
|
||
# Same for musl, as earlier versions do not provide a musl bindist for bootstrapping.
|
||
lib.optionalString (stdenv.isAarch64 || stdenv.hostPlatform.isMusl) ''
|
||
find . -name \*\.cabal\* -exec sed -i -e 's/\(base.*\)4.14/\14.16/' {} \; \
|
||
-exec sed -i -e 's/\(prim.*\)0.6/\10.8/' {} \;
|
||
''
|
||
+ ''
|
||
for env in $(env | grep '^TARGET_' | sed -E 's|\+?=.*||'); do
|
||
export "''${env#TARGET_}=''${!env}"
|
||
done
|
||
# GHC is a bit confused on its cross terminology, as these would normally be
|
||
# the *host* tools.
|
||
export CC="${targetCC}/bin/${targetCC.targetPrefix}cc"
|
||
export CXX="${targetCC}/bin/${targetCC.targetPrefix}cxx"
|
||
# Use gold to work around https://sourceware.org/bugzilla/show_bug.cgi?id=16177
|
||
export LD="${targetCC.bintools}/bin/${targetCC.bintools.targetPrefix}ld${lib.optionalString useLdGold ".gold"}"
|
||
export AS="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}as"
|
||
export AR="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}ar"
|
||
export NM="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}nm"
|
||
export RANLIB="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}ranlib"
|
||
export READELF="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}readelf"
|
||
export STRIP="${targetCC.bintools.bintools}/bin/${targetCC.bintools.targetPrefix}strip"
|
||
'' + lib.optionalString useLLVM ''
|
||
export LLC="${lib.getBin llvmPackages.llvm}/bin/llc"
|
||
export OPT="${lib.getBin llvmPackages.llvm}/bin/opt"
|
||
'' + lib.optionalString (targetCC.isClang || (useLLVM && stdenv.targetPlatform.isDarwin)) (let
|
||
# LLVM backend on Darwin needs clang, if we are already using clang, might as well set the environment variable.
|
||
# See also https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/codegens.html#llvm-code-generator-fllvm
|
||
clang = if targetCC.isClang then targetCC else llvmPackages.clang;
|
||
in ''
|
||
export CLANG="${clang}/bin/${clang.targetPrefix}clang"
|
||
'') + ''
|
||
|
||
echo -n "${buildMK dontStrip}" > mk/build.mk
|
||
sed -i -e 's|-isysroot /Developer/SDKs/MacOSX10.5.sdk||' configure
|
||
'' + lib.optionalString (!stdenv.isDarwin) ''
|
||
export NIX_LDFLAGS+=" -rpath $out/lib/ghc-${version}"
|
||
'' + lib.optionalString stdenv.isDarwin ''
|
||
export NIX_LDFLAGS+=" -no_dtrace_dof"
|
||
'' + lib.optionalString targetPlatform.useAndroidPrebuilt ''
|
||
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
|
||
'' + lib.optionalString targetPlatform.isMusl ''
|
||
echo "patching llvm-targets for musl targets..."
|
||
echo "Cloning these existing '*-linux-gnu*' targets:"
|
||
grep linux-gnu llvm-targets | sed 's/^/ /'
|
||
echo "(go go gadget sed)"
|
||
sed -i 's,\(^.*linux-\)gnu\(.*\)$,\0\n\1musl\2,' llvm-targets
|
||
echo "llvm-targets now contains these '*-linux-musl*' targets:"
|
||
grep linux-musl llvm-targets | sed 's/^/ /'
|
||
|
||
echo "And now patching to preserve '-musleabi' as done with '-gnueabi'"
|
||
# (aclocal.m4 is actual source, but patch configure as well since we don't re-gen)
|
||
for x in configure aclocal.m4; do
|
||
substituteInPlace $x \
|
||
--replace '*-android*|*-gnueabi*)' \
|
||
'*-android*|*-gnueabi*|*-musleabi*)'
|
||
done
|
||
'';
|
||
|
||
# TODO(@Ericson2314): Always pass "--target" and always prefix.
|
||
configurePlatforms = [ "build" "host" ]
|
||
++ lib.optional (targetPlatform != hostPlatform) "target";
|
||
|
||
# `--with` flags for libraries needed for RTS linker
|
||
configureFlags = [
|
||
"--datadir=$doc/share/doc/ghc"
|
||
"--with-curses-includes=${ncurses.dev}/include" "--with-curses-libraries=${ncurses.out}/lib"
|
||
] ++ lib.optionals (libffi != null) [
|
||
"--with-system-libffi"
|
||
"--with-ffi-includes=${targetPackages.libffi.dev}/include"
|
||
"--with-ffi-libraries=${targetPackages.libffi.out}/lib"
|
||
] ++ lib.optionals (targetPlatform == hostPlatform && !enableIntegerSimple) [
|
||
"--with-gmp-includes=${targetPackages.gmp.dev}/include"
|
||
"--with-gmp-libraries=${targetPackages.gmp.out}/lib"
|
||
] ++ lib.optionals (targetPlatform == hostPlatform && hostPlatform.libc != "glibc" && !targetPlatform.isWindows) [
|
||
"--with-iconv-includes=${libiconv}/include"
|
||
"--with-iconv-libraries=${libiconv}/lib"
|
||
] ++ lib.optionals (targetPlatform != hostPlatform) [
|
||
"--enable-bootstrap-with-devel-snapshot"
|
||
] ++ lib.optionals useLdGold [
|
||
"CFLAGS=-fuse-ld=gold"
|
||
"CONF_GCC_LINKER_OPTS_STAGE1=-fuse-ld=gold"
|
||
"CONF_GCC_LINKER_OPTS_STAGE2=-fuse-ld=gold"
|
||
] ++ lib.optionals (disableLargeAddressSpace) [
|
||
"--disable-large-address-space"
|
||
];
|
||
|
||
# Make sure we never relax`$PATH` and hooks support for compatibility.
|
||
strictDeps = true;
|
||
|
||
# Don’t add -liconv to LDFLAGS automatically so that GHC will add it itself.
|
||
dontAddExtraLibs = true;
|
||
|
||
nativeBuildInputs = [
|
||
perl autoconf automake m4 python3
|
||
ghc bootPkgs.alex bootPkgs.happy bootPkgs.hscolour
|
||
] ++ lib.optionals enableDocs [
|
||
sphinx
|
||
];
|
||
|
||
# For building runtime libs
|
||
depsBuildTarget = toolsForTarget;
|
||
|
||
buildInputs = [ perl bash ] ++ (libDeps hostPlatform);
|
||
|
||
depsTargetTarget = map lib.getDev (libDeps targetPlatform);
|
||
depsTargetTargetPropagated = map (lib.getOutput "out") (libDeps targetPlatform);
|
||
|
||
# required, because otherwise all symbols from HSffi.o are stripped, and
|
||
# that in turn causes GHCi to abort
|
||
stripDebugFlags = [ "-S" ] ++ lib.optional (!targetPlatform.isDarwin) "--keep-file-symbols";
|
||
|
||
checkTarget = "test";
|
||
|
||
hardeningDisable =
|
||
[ "format" ]
|
||
# In nixpkgs, musl based builds currently enable `pie` hardening by default
|
||
# (see `defaultHardeningFlags` in `make-derivation.nix`).
|
||
# But GHC cannot currently produce outputs that are ready for `-pie` linking.
|
||
# Thus, disable `pie` hardening, otherwise `recompile with -fPIE` errors appear.
|
||
# See:
|
||
# * https://github.com/NixOS/nixpkgs/issues/129247
|
||
# * https://gitlab.haskell.org/ghc/ghc/-/issues/19580
|
||
++ lib.optional stdenv.targetPlatform.isMusl "pie";
|
||
|
||
postInstall = ''
|
||
# Install the bash completion file.
|
||
install -D -m 444 utils/completion/ghc.bash $out/share/bash-completion/completions/${targetPrefix}ghc
|
||
'';
|
||
|
||
passthru = {
|
||
inherit bootPkgs targetPrefix;
|
||
|
||
inherit llvmPackages;
|
||
inherit enableShared;
|
||
|
||
# Our Cabal compiler name
|
||
haskellCompilerName = "ghc-${version}";
|
||
};
|
||
|
||
meta = {
|
||
homepage = "http://haskell.org/ghc";
|
||
description = "The Glasgow Haskell Compiler";
|
||
maintainers = with lib.maintainers; [
|
||
guibou
|
||
] ++ lib.teams.haskell.members;
|
||
timeout = 24 * 3600;
|
||
inherit (ghc.meta) license;
|
||
# hardcode platforms because the bootstrap GHC differs depending on the platform,
|
||
# with differing platforms available for each of them; See HACK comment in
|
||
# 8.10.2-binary.nix for an explanation of the musl special casing.
|
||
platforms = [
|
||
"x86_64-linux"
|
||
] ++ lib.optionals (!hostPlatform.isMusl) [
|
||
"i686-linux"
|
||
"aarch64-linux"
|
||
"x86_64-darwin"
|
||
];
|
||
# integer-simple builds are broken with musl when bootstrapping using
|
||
# GHC 8.10.2 and below, however it is not possible to reverse bootstrap
|
||
# GHC 8.8.4 with GHC 8.10.7.
|
||
# See https://github.com/NixOS/nixpkgs/pull/138523#issuecomment-927339953
|
||
broken = hostPlatform.isMusl && enableIntegerSimple;
|
||
};
|
||
|
||
dontStrip = (targetPlatform.useAndroidPrebuilt || targetPlatform.isWasm);
|
||
|
||
} // lib.optionalAttrs targetPlatform.useAndroidPrebuilt{
|
||
dontPatchELF = true;
|
||
noAuditTmpdir = true;
|
||
})
|