nixpkgs/pkgs/development/compilers/sbcl/default.nix
2024-02-23 22:26:42 -05:00

224 lines
7.2 KiB
Nix
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{ lib, stdenv, callPackage, clisp, coreutils, fetchurl, strace, texinfo, which, writeText, zstd
, threadSupport ? (stdenv.hostPlatform.isx86 || "aarch64-linux" == stdenv.hostPlatform.system || "aarch64-darwin" == stdenv.hostPlatform.system)
, linkableRuntime ? stdenv.hostPlatform.isx86
, disableImmobileSpace ? false
# Meant for sbcl used for creating binaries portable to non-NixOS via save-lisp-and-die.
# Note that the created binaries still need `patchelf --set-interpreter ...`
# to get rid of ${glibc} dependency.
, purgeNixReferences ? false
, coreCompression ? lib.versionAtLeast version "2.2.6"
, markRegionGC ? lib.versionAtLeast version "2.4.0"
, version
# Set this to a lisp binary to use a custom bootstrap lisp compiler for
# SBCL. Leave as null to use the default. This is useful for local development
# of SBCL, because you can use your existing stock SBCL as a boostrap. On Hydra
# of course we cant do that because SBCL hasnt been built yet, so we use
# CLISP, but thats much slower.
, bootstrapLisp ? null
}:
let
versionMap = {
# Only kept around for BCLM. Remove once unneeded there.
"2.1.9" = {
sha256 = "189gjqzdz10xh3ybiy4ch1r98bsmkcb4hpnrmggd4y2g5kqnyx4y";
};
"2.4.0" = {
sha256 = "sha256-g9i3TwjSJUxZuXkLwfZp4JCZRXuIRyDs7L9F9LRtF3Y=";
};
"2.4.1" = {
sha256 = "sha256-2k+UhvrUE9OversbCSaTJf20v/fnuI8hld3udDJjz34=";
};
};
# Collection of pre-built SBCL binaries for platforms that need them for
# bootstrapping. Ideally these are to be avoided. If CLISP (or any other
# non-binary-distributed Lisp) can run on any of these systems, that entry
# should be removed from this list.
bootstrapBinaries = rec {
# This build segfaults using CLISP.
x86_64-darwin = {
version = "2.2.9";
system = "x86-64-darwin";
sha256 = "sha256-b1BLkoLIOELAYBYA9eBmMgm1OxMxJewzNP96C9ADfKY=";
};
i686-linux = {
version = "1.2.7";
system = "x86-linux";
sha256 = "07f3bz4br280qvn85i088vpzj9wcz8wmwrf665ypqx181pz2ai3j";
};
armv7l-linux = {
version = "1.2.14";
system = "armhf-linux";
sha256 = "0sp5445rbvms6qvzhld0kwwvydw51vq5iaf4kdqsf2d9jvaz3yx5";
};
armv6l-linux = armv7l-linux;
x86_64-freebsd = {
version = "1.2.7";
system = "x86-64-freebsd";
sha256 = "14k42xiqd2rrim4pd5k5pjcrpkac09qnpynha8j1v4jngrvmw7y6";
};
x86_64-solaris = {
version = "1.2.7";
system = "x86-64-solaris";
sha256 = "05c12fmac4ha72k1ckl6i780rckd7jh4g5s5hiic7fjxnf1kx8d0";
};
};
sbclBootstrap = callPackage ./bootstrap.nix {
cfg = bootstrapBinaries.${stdenv.hostPlatform.system};
};
bootstrapLisp' =
if bootstrapLisp != null
then bootstrapLisp
else if (builtins.hasAttr stdenv.hostPlatform.system bootstrapBinaries)
then "${sbclBootstrap}/bin/sbcl --disable-debugger --no-userinit --no-sysinit"
else "${clisp}/bin/clisp -E UTF-8 --silent -norc";
in
stdenv.mkDerivation (self: rec {
pname = "sbcl";
inherit version;
src = fetchurl {
url = "mirror://sourceforge/project/sbcl/sbcl/${version}/${pname}-${version}-source.tar.bz2";
inherit (versionMap.${version}) sha256;
};
nativeBuildInputs = [
texinfo
] ++ lib.optionals self.doCheck (
[
which
] ++ lib.optionals (builtins.elem stdenv.system strace.meta.platforms) [
strace
]
);
buildInputs = lib.optionals coreCompression [ zstd ];
patches = lib.optionals (version == "2.4.0") [
./fix-2.4.0-aarch64-darwin.patch
];
postPatch = lib.optionalString (builtins.elem stdenv.hostPlatform.system [
"x86_64-linux"
"x86_64-darwin"
"aarch64-linux"
]) ''
rm -f tests/foreign-stack-alignment.impure.lisp
# Floating point tests are fragile
# https://sourceforge.net/p/sbcl/mailman/message/58728554/
rm -f tests/compiler.pure.lisp \
tests/float.pure.lisp
''
+ lib.optionalString purgeNixReferences ''
# This is the default location to look for the core; by default in $out/lib/sbcl
sed 's@^\(#define SBCL_HOME\) .*$@\1 "/no-such-path"@' \
-i src/runtime/runtime.c
''
+ ''
(
shopt -s nullglob
# Tests need patching regardless of purging of paths from the final
# binary. There are some tricky files in nested directories which should
# definitely NOT be patched this way, hence just a single * (and no
# globstar).
substituteInPlace ${if purgeNixReferences then "tests" else "{tests,src/code}"}/*.{lisp,sh} \
--replace-quiet /usr/bin/env "${coreutils}/bin/env" \
--replace-quiet /bin/uname "${coreutils}/bin/uname" \
--replace-quiet /bin/sh "${stdenv.shell}"
)
'';
preBuild = ''
export INSTALL_ROOT=$out
mkdir -p test-home
export HOME=$PWD/test-home
'';
enableFeatures = with lib;
optional threadSupport "sb-thread" ++
optional linkableRuntime "sb-linkable-runtime" ++
optional coreCompression "sb-core-compression" ++
optional stdenv.isAarch32 "arm" ++
optional markRegionGC "mark-region-gc";
disableFeatures = with lib;
optional (!threadSupport) "sb-thread" ++
optionals disableImmobileSpace [ "immobile-space" "immobile-code" "compact-instance-header" ];
buildArgs = [
"--prefix=$out"
"--xc-host=${lib.escapeShellArg bootstrapLisp'}"
] ++ builtins.map (x: "--with-${x}") self.enableFeatures
++ builtins.map (x: "--without-${x}") self.disableFeatures
++ lib.optionals (stdenv.hostPlatform.system == "aarch64-darwin") [
"--arch=arm64"
];
env.NIX_CFLAGS_COMPILE = toString (lib.optionals (lib.versionOlder self.version "2.1.10") [
# Workaround build failure on -fno-common toolchains like upstream
# clang-13. Without the change build fails as:
# duplicate symbol '_static_code_space_free_pointer' in: alloc.o traceroot.o
# Should be fixed past 2.1.10 release.
"-fcommon"
]
# Fails to find `O_LARGEFILE` otherwise.
++ [ "-D_GNU_SOURCE" ]);
buildPhase = ''
runHook preBuild
sh make.sh ${lib.concatStringsSep " " self.buildArgs}
(cd doc/manual ; make info)
runHook postBuild
'';
doCheck = true;
# From the INSTALL docs
checkPhase = ''
(cd tests && sh run-tests.sh)
'';
installPhase = ''
runHook preInstall
INSTALL_ROOT=$out sh install.sh
''
+ lib.optionalString (!purgeNixReferences) ''
cp -r src $out/lib/sbcl
cp -r contrib $out/lib/sbcl
cat >$out/lib/sbcl/sbclrc <<EOF
(setf (logical-pathname-translations "SYS")
'(("SYS:SRC;**;*.*.*" #P"$out/lib/sbcl/src/**/*.*")
("SYS:CONTRIB;**;*.*.*" #P"$out/lib/sbcl/contrib/**/*.*")))
EOF
'' + ''
runHook postInstall
'';
setupHook = lib.optional purgeNixReferences (writeText "setupHook.sh" ''
addEnvHooks "$targetOffset" _setSbclHome
_setSbclHome() {
export SBCL_HOME='@out@/lib/sbcl/'
}
'');
meta = with lib; {
description = "Common Lisp compiler";
homepage = "https://sbcl.org";
license = licenses.publicDomain; # and FreeBSD
maintainers = lib.teams.lisp.members;
platforms = attrNames bootstrapBinaries ++ [
# These arent bootstrapped using the binary distribution but compiled
# using a separate (lisp) host
"x86_64-linux"
"aarch64-darwin"
"aarch64-linux"
];
};
})