From 1216772f5da8c6d6efaecb798f92f035a8d93cf1 Mon Sep 17 00:00:00 2001 From: sternenseemann Date: Sat, 9 Apr 2022 16:23:59 +0200 Subject: [PATCH] haskell.compiler.ghc922Binary: init at 9.2.2 Since the musl / alpine bindist now uses the GMP backend, we need to learn to tell Hadrian bindists about GMP. Hadrian bindists no longer have the buildinfo files, instead we need to patch the package db before installing and recache it afterwards which is not too hard, luckily. Same goes for libiconv and base as well as libffi and rts on darwin (those bindists are all produced using hadrian). See also: https://gitlab.haskell.org/ghc/ghc/-/issues/21554#note_431000 Note that pkgsMusl.haskell.compiler.ghc922Binary still has severe issues: It can't produce shared libraries because the bindist ships none (and using the GMP backend has a hard requirement for shared objects, apparently) and ghci segfaults for unknown reasons at the moment. However, I've successfully compiled hadrian with it so far, so perhaps it's good enough. --- .../compilers/ghc/9.2.2-binary.nix | 448 ++++++++++++++++++ pkgs/top-level/haskell-packages.nix | 22 + 2 files changed, 470 insertions(+) create mode 100644 pkgs/development/compilers/ghc/9.2.2-binary.nix diff --git a/pkgs/development/compilers/ghc/9.2.2-binary.nix b/pkgs/development/compilers/ghc/9.2.2-binary.nix new file mode 100644 index 000000000000..53b56b044796 --- /dev/null +++ b/pkgs/development/compilers/ghc/9.2.2-binary.nix @@ -0,0 +1,448 @@ +{ lib, stdenv +, fetchurl, perl, gcc +, ncurses5 +, ncurses6, gmp, libiconv, numactl, libffi +, llvmPackages +, coreutils +, targetPackages + + # minimal = true; will remove files that aren't strictly necessary for + # regular builds and GHC bootstrapping. + # This is "useful" for staying within hydra's output limits for at least the + # aarch64-linux architecture. +, minimal ? false +}: + +# Prebuilt only does native +assert stdenv.targetPlatform == stdenv.hostPlatform; + +let + downloadsUrl = "https://downloads.haskell.org/ghc"; + + # Copy sha256 from https://downloads.haskell.org/~ghc/9.2.2/SHA256SUMS + version = "9.2.2"; + + # Information about available bindists that we use in the build. + # + # # Bindist library checking + # + # The field `archSpecificLibraries` also provides a way for us get notified + # early when the upstream bindist changes its dependencies (e.g. because a + # newer Debian version is used that uses a new `ncurses` version). + # + # Usage: + # + # * You can find the `fileToCheckFor` of libraries by running `readelf -d` + # on the compiler binary (`exePathForLibraryCheck`). + # * To skip library checking for an architecture, + # set `exePathForLibraryCheck = null`. + # * To skip file checking for a specific arch specfic library, + # set `fileToCheckFor = null`. + ghcBinDists = { + # Binary distributions for the default libc (e.g. glibc, or libSystem on Darwin) + # nixpkgs uses for the respective system. + defaultLibc = { + i686-linux = { + variantSuffix = ""; + src = { + url = "${downloadsUrl}/${version}/ghc-${version}-i386-deb9-linux.tar.xz"; + sha256 = "24234486ed4508161c6f88f4750a36d38b135b0c6e5fe78efe2d85c612ecaf9e"; + }; + exePathForLibraryCheck = "ghc/stage2/build/tmp/ghc-stage2"; + archSpecificLibraries = [ + { nixPackage = gmp; fileToCheckFor = null; } + # The i686-linux bindist provided by GHC HQ is currently built on Debian 9, + # which link it against `libtinfo.so.5` (ncurses 5). + # Other bindists are linked `libtinfo.so.6` (ncurses 6). + { nixPackage = ncurses5; fileToCheckFor = "libtinfo.so.5"; } + ]; + }; + x86_64-linux = { + variantSuffix = ""; + src = { + url = "${downloadsUrl}/${version}/ghc-${version}-x86_64-deb10-linux.tar.xz"; + sha256 = "fb61dea556a2023dc2d50ee61a22144bb23e4229a378e533065124c218f40cfc"; + }; + exePathForLibraryCheck = "ghc/stage2/build/tmp/ghc-stage2"; + archSpecificLibraries = [ + { nixPackage = gmp; fileToCheckFor = null; } + { nixPackage = ncurses6; fileToCheckFor = "libtinfo.so.6"; } + ]; + }; + armv7l-linux = { + variantSuffix = ""; + src = { + url = "${downloadsUrl}/${version}/ghc-${version}-armv7-deb10-linux.tar.xz"; + sha256 = "ce5a7c3beb19d8c13a9e60bd39d3ba8ef0060b954ea42eb23f1ef8d077fa9e8b"; + }; + exePathForLibraryCheck = "ghc/stage2/build/tmp/ghc-stage2"; + archSpecificLibraries = [ + { nixPackage = gmp; fileToCheckFor = null; } + { nixPackage = ncurses6; fileToCheckFor = "libtinfo.so.6"; } + ]; + }; + aarch64-linux = { + variantSuffix = ""; + src = { + url = "${downloadsUrl}/${version}/ghc-${version}-aarch64-deb10-linux.tar.xz"; + sha256 = "f3621ccba7ae48fcd67a9505f61bb5ccfb05c4cbfecd5a6ea65fe3f150af0e98"; + }; + exePathForLibraryCheck = "ghc/stage2/build/tmp/ghc-stage2"; + archSpecificLibraries = [ + { nixPackage = gmp; fileToCheckFor = null; } + { nixPackage = ncurses6; fileToCheckFor = "libtinfo.so.6"; } + { nixPackage = numactl; fileToCheckFor = null; } + ]; + }; + x86_64-darwin = { + variantSuffix = ""; + src = { + url = "${downloadsUrl}/${version}/ghc-${version}-x86_64-apple-darwin.tar.xz"; + sha256 = "934abbd6083d3aeb5ff081955682d7711d9e79db57b1613eb229c325dd06f83f"; + }; + exePathForLibraryCheck = null; # we don't have a library check for darwin yet + archSpecificLibraries = [ + { nixPackage = gmp; fileToCheckFor = null; } + { nixPackage = ncurses6; fileToCheckFor = null; } + { nixPackage = libiconv; fileToCheckFor = null; } + ]; + }; + aarch64-darwin = { + variantSuffix = ""; + src = { + url = "${downloadsUrl}/${version}/ghc-${version}-aarch64-apple-darwin.tar.xz"; + sha256 = "d1f04f7cc062ed134f863305c67dfe2c42df46ed658dd34f9dd552186f194e5c"; + }; + exePathForLibraryCheck = null; # we don't have a library check for darwin yet + archSpecificLibraries = [ + { nixPackage = gmp; fileToCheckFor = null; } + { nixPackage = ncurses6; fileToCheckFor = null; } + { nixPackage = libiconv; fileToCheckFor = null; } + ]; + }; + }; + # Binary distributions for the musl libc for the respective system. + musl = { + x86_64-linux = { + variantSuffix = "-musl"; + src = { + url = "${downloadsUrl}/${version}/ghc-${version}-x86_64-alpine3.12-linux-gmp.tar.xz"; + sha256 = "624523826e24eae33c03490267cddecc1d80c047f2a3f4b03580f1040112d5c0"; + }; + isStatic = true; + # We can't check the RPATH for statically linked executable + exePathForLibraryCheck = null; + archSpecificLibraries = [ + { nixPackage = gmp.override { withStatic = true; }; fileToCheckFor = null; } + ]; + }; + }; + }; + + distSetName = if stdenv.hostPlatform.isMusl then "musl" else "defaultLibc"; + + binDistUsed = ghcBinDists.${distSetName}.${stdenv.hostPlatform.system} + or (throw "cannot bootstrap GHC on this platform ('${stdenv.hostPlatform.system}' with libc '${distSetName}')"); + + gmpUsed = (builtins.head ( + builtins.filter ( + drv: lib.hasPrefix "gmp" (drv.nixPackage.name or "") + ) binDistUsed.archSpecificLibraries + )).nixPackage; + + # GHC has other native backends (like PowerPC), but here only the ones + # we ship bindists for matter. + useLLVM = !(stdenv.targetPlatform.isx86 + || (stdenv.targetPlatform.isAarch64 && stdenv.targetPlatform.isDarwin)); + + libPath = + lib.makeLibraryPath ( + # Add arch-specific libraries. + map ({ nixPackage, ... }: nixPackage) binDistUsed.archSpecificLibraries + ); + + libEnvVar = lib.optionalString stdenv.hostPlatform.isDarwin "DY" + + "LD_LIBRARY_PATH"; + + runtimeDeps = [ + targetPackages.stdenv.cc + targetPackages.stdenv.cc.bintools + coreutils # for cat + ] + ++ lib.optionals useLLVM [ + (lib.getBin llvmPackages.llvm) + ] + # On darwin, we need unwrapped bintools as well (for otool) + ++ lib.optionals (stdenv.targetPlatform.linker == "cctools") [ + targetPackages.stdenv.cc.bintools.bintools + ]; + +in + +stdenv.mkDerivation rec { + inherit version; + pname = "ghc-binary${binDistUsed.variantSuffix}"; + + src = fetchurl binDistUsed.src; + + nativeBuildInputs = [ perl ]; + + # Set LD_LIBRARY_PATH or equivalent so that the programs running as part + # of the bindist installer can find the libraries they expect. + # Cannot patchelf beforehand due to relative RPATHs that anticipate + # the final install location. + ${libEnvVar} = libPath; + + postUnpack = + # Verify our assumptions of which `libtinfo.so` (ncurses) version is used, + # so that we know when ghc bindists upgrade that and we need to update the + # version used in `libPath`. + lib.optionalString + (binDistUsed.exePathForLibraryCheck != null) + # Note the `*` glob because some GHCs have a suffix when unpacked, e.g. + # the musl bindist has dir `ghc-VERSION-x86_64-unknown-linux/`. + # As a result, don't shell-quote this glob when splicing the string. + (let buildExeGlob = ''ghc-${version}*/"${binDistUsed.exePathForLibraryCheck}"''; in + lib.concatStringsSep "\n" [ + ('' + echo "Checking that ghc binary exists in bindist at ${buildExeGlob}" + if ! test -e ${buildExeGlob}; then + echo >&2 "GHC binary ${binDistUsed.exePathForLibraryCheck} could not be found in the bindist build directory (at ${buildExeGlob}) for arch ${stdenv.hostPlatform.system}, please check that ghcBinDists correctly reflect the bindist dependencies!"; exit 1; + fi + '') + (lib.concatMapStringsSep + "\n" + ({ fileToCheckFor, nixPackage }: + lib.optionalString (fileToCheckFor != null) '' + echo "Checking bindist for ${fileToCheckFor} to ensure that is still used" + if ! readelf -d ${buildExeGlob} | grep "${fileToCheckFor}"; then + echo >&2 "File ${fileToCheckFor} could not be found in ${binDistUsed.exePathForLibraryCheck} for arch ${stdenv.hostPlatform.system}, please check that ghcBinDists correctly reflect the bindist dependencies!"; exit 1; + fi + + echo "Checking that the nix package ${nixPackage} contains ${fileToCheckFor}" + if ! test -e "${lib.getLib nixPackage}/lib/${fileToCheckFor}"; then + echo >&2 "Nix package ${nixPackage} did not contain ${fileToCheckFor} for arch ${stdenv.hostPlatform.system}, please check that ghcBinDists correctly reflect the bindist dependencies!"; exit 1; + fi + '' + ) + binDistUsed.archSpecificLibraries + ) + ]) + # GHC has dtrace probes, which causes ld to try to open /usr/lib/libdtrace.dylib + # during linking + + lib.optionalString stdenv.isDarwin '' + export NIX_LDFLAGS+=" -no_dtrace_dof" + # not enough room in the object files for the full path to libiconv :( + for exe in $(find . -type f -executable); do + isScript $exe && continue + ln -fs ${libiconv}/lib/libiconv.dylib $(dirname $exe)/libiconv.dylib + install_name_tool -change /usr/lib/libiconv.2.dylib @executable_path/libiconv.dylib -change /usr/local/lib/gcc/6/libgcc_s.1.dylib ${gcc.cc.lib}/lib/libgcc_s.1.dylib $exe + done + '' + + + # Some scripts used during the build need to have their shebangs patched + '' + patchShebangs ghc-${version}/utils/ + patchShebangs ghc-${version}/configure + '' + + # We have to patch the GMP paths for the integer-gmp package. + '' + find . -name ghc-bignum.buildinfo \ + -exec sed -i "s@extra-lib-dirs: @extra-lib-dirs: ${lib.getLib gmpUsed}/lib@" {} \; + + # we need to modify the package db directly for hadrian bindists + find . -name 'ghc-bignum*.conf' \ + -exec sed -e '/^[a-z-]*library-dirs/a \ ${lib.getLib gmpUsed}/lib' -i {} \; + '' + lib.optionalString stdenv.isDarwin '' + # we need to modify the package db directly for hadrian bindists + # (all darwin bindists are hadrian-based for 9.2.2) + find . -name 'base*.conf' \ + -exec sed -e '/^[a-z-]*library-dirs/a \ ${lib.getLib libiconv}/lib' -i {} \; + + # To link RTS in the end we also need libffi now + find . -name 'rts*.conf' \ + -exec sed -e '/^[a-z-]*library-dirs/a \ ${lib.getLib libffi}/lib' \ + -e 's@/Library/Developer/.*/usr/include/ffi@${lib.getDev libffi}/include@' \ + -i {} \; + '' + + # aarch64 does HAVE_NUMA so -lnuma requires it in library-dirs in rts/package.conf.in + # FFI_LIB_DIR is a good indication of places it must be needed. + lib.optionalString (stdenv.hostPlatform.isLinux && stdenv.hostPlatform.isAarch64) '' + find . -name package.conf.in \ + -exec sed -i "s@FFI_LIB_DIR@FFI_LIB_DIR ${numactl.out}/lib@g" {} \; + '' + + # Rename needed libraries and binaries, fix interpreter + lib.optionalString stdenv.isLinux '' + find . -type f -executable -exec patchelf \ + --interpreter ${stdenv.cc.bintools.dynamicLinker} {} \; + '' + + # The hadrian install Makefile uses 'xxx' as a temporary placeholder in path + # substitution. Which can break the build if the store path / prefix happens + # to contain this string. This will be fixed with 9.2.3 bindists. + # https://gitlab.haskell.org/ghc/ghc/-/issues/21402 + '' + # Detect hadrian Makefile by checking for the target that has the problem + if grep '^update_package_db' ghc-${version}*/Makefile > /dev/null; then + echo Hadrian bindist, applying workaround for xxx path substitution. + # based on https://gitlab.haskell.org/ghc/ghc/-/commit/dd5fecb0e2990b192d92f4dfd7519ecb33164fad.patch + substituteInPlace ghc-${version}*/Makefile --replace 'xxx' '\0xxx\0' + else + echo Not a hadrian bindist, not applying xxx path workaround. + fi + ''; + + # fix for `configure: error: Your linker is affected by binutils #16177` + preConfigure = lib.optionalString + stdenv.targetPlatform.isAarch32 + "LD=ld.gold"; + + configurePlatforms = [ ]; + configureFlags = [ + "--with-gmp-includes=${lib.getDev gmpUsed}/include" + # Note `--with-gmp-libraries` does nothing for GHC bindists: + # https://gitlab.haskell.org/ghc/ghc/-/merge_requests/6124 + ] ++ lib.optional stdenv.isDarwin "--with-gcc=${./gcc-clang-wrapper.sh}" + # From: https://github.com/NixOS/nixpkgs/pull/43369/commits + ++ lib.optional stdenv.hostPlatform.isMusl "--disable-ld-override"; + + # No building is necessary, but calling make without flags ironically + # calls install-strip ... + dontBuild = true; + + # Patch scripts to include runtime dependencies in $PATH. + postInstall = '' + for i in "$out/bin/"*; do + test ! -h "$i" || continue + isScript "$i" || continue + sed -i -e '2i export PATH="${lib.makeBinPath runtimeDeps}:$PATH"' "$i" + done + ''; + + # Apparently necessary for the ghc Alpine (musl) bindist: + # When we strip, and then run the + # patchelf --set-rpath "${libPath}:$(patchelf --print-rpath $p)" $p + # below, running ghc (e.g. during `installCheckPhase)` gives some apparently + # corrupted rpath or whatever makes the loader work on nonsensical strings: + # running install tests + # Error relocating /nix/store/...-ghc-8.10.2-binary/lib/ghc-8.10.5/bin/ghc: : symbol not found + # Error relocating /nix/store/...-ghc-8.10.2-binary/lib/ghc-8.10.5/bin/ghc: ir6zf6c9f86pfx8sr30n2vjy-ghc-8.10.2-binary/lib/ghc-8.10.5/bin/../lib/x86_64-linux-ghc-8.10.5/libHSexceptions-0.10.4-ghc8.10.5.so: symbol not found + # Error relocating /nix/store/...-ghc-8.10.2-binary/lib/ghc-8.10.5/bin/ghc: y/lib/ghc-8.10.5/bin/../lib/x86_64-linux-ghc-8.10.5/libHStemplate-haskell-2.16.0.0-ghc8.10.5.so: symbol not found + # Error relocating /nix/store/...-ghc-8.10.2-binary/lib/ghc-8.10.5/bin/ghc: 8.10.5/libHStemplate-haskell-2.16.0.0-ghc8.10.5.so: symbol not found + # Error relocating /nix/store/...-ghc-8.10.2-binary/lib/ghc-8.10.5/bin/ghc: �: symbol not found + # Error relocating /nix/store/...-ghc-8.10.2-binary/lib/ghc-8.10.5/bin/ghc: �?: symbol not found + # Error relocating /nix/store/...-ghc-8.10.2-binary/lib/ghc-8.10.5/bin/ghc: 64-linux-ghc-8.10.5/libHSexceptions-0.10.4-ghc8.10.5.so: symbol not found + # This is extremely bogus and should be investigated. + dontStrip = if stdenv.hostPlatform.isMusl then true else false; # `if` for explicitness + + # On Linux, use patchelf to modify the executables so that they can + # find editline/gmp. + postFixup = lib.optionalString (stdenv.isLinux && !(binDistUsed.isStatic or false)) + (if stdenv.hostPlatform.isAarch64 then + # Keep rpath as small as possible on aarch64 for patchelf#244. All Elfs + # are 2 directories deep from $out/lib, so pooling symlinks there makes + # a short rpath. + '' + (cd $out/lib; ln -s ${ncurses6.out}/lib/libtinfo.so.6) + (cd $out/lib; ln -s ${lib.getLib gmpUsed}/lib/libgmp.so.10) + (cd $out/lib; ln -s ${numactl.out}/lib/libnuma.so.1) + for p in $(find "$out/lib" -type f -name "*\.so*"); do + (cd $out/lib; ln -s $p) + done + + for p in $(find "$out/lib" -type f -executable); do + if isELF "$p"; then + echo "Patchelfing $p" + patchelf --set-rpath "\$ORIGIN:\$ORIGIN/../.." $p + fi + done + '' + else + '' + for p in $(find "$out" -type f -executable); do + if isELF "$p"; then + echo "Patchelfing $p" + patchelf --set-rpath "${libPath}:$(patchelf --print-rpath $p)" $p + fi + done + '') + lib.optionalString stdenv.isDarwin '' + # not enough room in the object files for the full path to libiconv :( + for exe in $(find "$out" -type f -executable); do + isScript $exe && continue + ln -fs ${libiconv}/lib/libiconv.dylib $(dirname $exe)/libiconv.dylib + install_name_tool -change /usr/lib/libiconv.2.dylib @executable_path/libiconv.dylib -change /usr/local/lib/gcc/6/libgcc_s.1.dylib ${gcc.cc.lib}/lib/libgcc_s.1.dylib $exe + done + + for file in $(find "$out" -name setup-config); do + substituteInPlace $file --replace /usr/bin/ranlib "$(type -P ranlib)" + done + '' + + lib.optionalString minimal '' + # Remove profiling files + find $out -type f -name '*.p_o' -delete + find $out -type f -name '*.p_hi' -delete + find $out -type f -name '*_p.a' -delete + # `-f` because e.g. musl bindist does not have this file. + rm -f $out/lib/ghc-*/bin/ghc-iserv-prof + # Hydra will redistribute this derivation, so we have to keep the docs for + # legal reasons (retaining the legal notices etc) + # As a last resort we could unpack the docs separately and symlink them in. + # They're in $out/share/{doc,man}. + '' + # Recache package db which needs to happen for Hadrian bindists + # where we modify the package db before installing + + '' + "$out/bin/ghc-pkg" --package-db="$out/lib/"ghc-*/package.conf.d recache + ''; + + # 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 + hardeningDisable = lib.optional stdenv.targetPlatform.isMusl "pie"; + + doInstallCheck = true; + installCheckPhase = '' + # Sanity check, can ghc create executables? + cd $TMP + mkdir test-ghc; cd test-ghc + cat > main.hs << EOF + {-# LANGUAGE TemplateHaskell #-} + module Main where + main = putStrLn \$([|"yes"|]) + EOF + env -i $out/bin/ghc --make main.hs || exit 1 + echo compilation ok + [ $(./main) == "yes" ] + ''; + + passthru = { + targetPrefix = ""; + enableShared = true; + + inherit llvmPackages; + + # Our Cabal compiler name + haskellCompilerName = "ghc-${version}"; + }; + + meta = rec { + homepage = "http://haskell.org/ghc"; + description = "The Glasgow Haskell Compiler"; + license = lib.licenses.bsd3; + # HACK: since we can't encode the libc / abi in platforms, we need + # to make the platform list dependent on the evaluation platform + # in order to avoid eval errors with musl which supports less + # platforms than the default libcs (i. e. glibc / libSystem). + # This is done for the benefit of Hydra, so `packagePlatforms` + # won't return any platforms that would cause an evaluation + # failure for `pkgsMusl.haskell.compiler.ghc922Binary`, as + # long as the evaluator runs on a platform that supports + # `pkgsMusl`. + platforms = builtins.attrNames ghcBinDists.${distSetName}; + hydraPlatforms = builtins.filter (p: minimal || p != "aarch64-linux") platforms; + maintainers = lib.teams.haskell.members; + }; +} diff --git a/pkgs/top-level/haskell-packages.nix b/pkgs/top-level/haskell-packages.nix index 79815b65f605..68a323099569 100644 --- a/pkgs/top-level/haskell-packages.nix +++ b/pkgs/top-level/haskell-packages.nix @@ -8,6 +8,8 @@ let "ghc8102BinaryMinimal" "ghc8107Binary" "ghc8107BinaryMinimal" + "ghc922Binary" + "ghc922BinaryMinimal" "ghcjs" "ghcjs810" "integer-simple" @@ -76,6 +78,14 @@ in { minimal = true; }; + ghc922Binary = callPackage ../development/compilers/ghc/9.2.2-binary.nix { + llvmPackages = pkgs.llvmPackages_12; + }; + ghc922BinaryMinimal = callPackage ../development/compilers/ghc/9.2.2-binary.nix { + llvmPackages = pkgs.llvmPackages_12; + minimal = true; + }; + ghc884 = callPackage ../development/compilers/ghc/8.8.4.nix { bootPkgs = # aarch64 ghc865Binary gets SEGVs due to haskell#15449 or similar @@ -212,6 +222,18 @@ in { compilerConfig = callPackage ../development/haskell-modules/configuration-ghc-8.10.x.nix { }; packageSetConfig = bootstrapPackageSet; }; + ghc922Binary = callPackage ../development/haskell-modules { + buildHaskellPackages = bh.packages.ghc922Binary; + ghc = bh.compiler.ghc922Binary; + compilerConfig = callPackage ../development/haskell-modules/configuration-ghc-9.2.x.nix { }; + packageSetConfig = bootstrapPackageSet; + }; + ghc922BinaryMinimal = callPackage ../development/haskell-modules { + buildHaskellPackages = bh.packages.ghc922BinaryMinimal; + ghc = bh.compiler.ghc922BinaryMinimal; + compilerConfig = callPackage ../development/haskell-modules/configuration-ghc-9.2.x.nix { }; + packageSetConfig = bootstrapPackageSet; + }; ghc884 = callPackage ../development/haskell-modules { buildHaskellPackages = bh.packages.ghc884; ghc = bh.compiler.ghc884;