2009-02-10 15:48:30 +00:00
|
|
|
/* This file contains various functions that take a stdenv and return
|
|
|
|
a new stdenv with different behaviour, e.g. using a different C
|
|
|
|
compiler. */
|
|
|
|
|
2021-08-17 01:16:29 +00:00
|
|
|
{ lib, pkgs, config }:
|
|
|
|
|
|
|
|
let
|
|
|
|
# N.B. Keep in sync with default arg for stdenv/generic.
|
|
|
|
defaultMkDerivationFromStdenv = import ./generic/make-derivation.nix { inherit lib config; };
|
|
|
|
|
|
|
|
# Low level function to help with overriding `mkDerivationFromStdenv`. One
|
|
|
|
# gives it the old stdenv arguments and a "continuation" function, and
|
|
|
|
# underneath the final stdenv argument it yields to the continuation to do
|
|
|
|
# whatever it wants with old `mkDerivation` (old `mkDerivationFromStdenv`
|
|
|
|
# applied to the *new, final* stdenv) provided for convenience.
|
|
|
|
withOldMkDerivation = stdenvSuperArgs: k: stdenvSelf: let
|
|
|
|
mkDerivationFromStdenv-super = stdenvSuperArgs.mkDerivationFromStdenv or defaultMkDerivationFromStdenv;
|
|
|
|
mkDerivationSuper = mkDerivationFromStdenv-super stdenvSelf;
|
|
|
|
in
|
|
|
|
k stdenvSelf mkDerivationSuper;
|
|
|
|
|
|
|
|
# Wrap the original `mkDerivation` providing extra args to it.
|
|
|
|
extendMkDerivationArgs = old: f: withOldMkDerivation old (_: mkDerivationSuper: args:
|
|
|
|
mkDerivationSuper (args // f args));
|
|
|
|
|
|
|
|
# Wrap the original `mkDerivation` transforming the result.
|
|
|
|
overrideMkDerivationResult = old: f: withOldMkDerivation old (_: mkDerivationSuper: args:
|
|
|
|
f (mkDerivationSuper args));
|
|
|
|
in
|
2012-10-31 12:41:54 +00:00
|
|
|
|
2009-02-10 15:48:30 +00:00
|
|
|
rec {
|
|
|
|
|
|
|
|
|
|
|
|
# Override the compiler in stdenv for specific packages.
|
2015-01-09 19:22:12 +00:00
|
|
|
overrideCC = stdenv: cc: stdenv.override { allowedRequisites = null; cc = cc; };
|
2009-02-10 15:48:30 +00:00
|
|
|
|
2012-10-31 12:41:54 +00:00
|
|
|
|
2009-02-10 15:48:30 +00:00
|
|
|
# Add some arbitrary packages to buildInputs for specific packages.
|
2010-08-06 20:23:35 +00:00
|
|
|
# Used to override packages in stdenv like Make. Should not be used
|
2009-02-10 15:48:30 +00:00
|
|
|
# for other dependencies.
|
2014-02-04 16:18:38 +00:00
|
|
|
overrideInStdenv = stdenv: pkgs:
|
2020-04-28 14:51:39 +00:00
|
|
|
stdenv.override (prev: { allowedRequisites = null; extraBuildInputs = (prev.extraBuildInputs or []) ++ pkgs; });
|
2009-02-10 15:48:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
# Override the setup script of stdenv. Useful for testing new
|
|
|
|
# versions of the setup script without causing a rebuild of
|
|
|
|
# everything.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# randomPkg = import ../bla { ...
|
|
|
|
# stdenv = overrideSetup stdenv ../stdenv/generic/setup-latest.sh;
|
|
|
|
# };
|
2014-02-04 16:18:38 +00:00
|
|
|
overrideSetup = stdenv: setupScript: stdenv.override { inherit setupScript; };
|
2009-02-10 15:48:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
# Return a modified stdenv that tries to build statically linked
|
|
|
|
# binaries.
|
2021-08-17 01:16:29 +00:00
|
|
|
makeStaticBinaries = stdenv0:
|
|
|
|
stdenv0.override (old: {
|
|
|
|
mkDerivationFromStdenv = withOldMkDerivation old (stdenv: mkDerivationSuper: args:
|
|
|
|
if stdenv.hostPlatform.isDarwin
|
2018-12-05 03:12:17 +00:00
|
|
|
then throw "Cannot build fully static binaries on Darwin/macOS"
|
2021-08-17 01:16:29 +00:00
|
|
|
else mkDerivationSuper (args // {
|
2018-12-13 20:35:50 +00:00
|
|
|
NIX_CFLAGS_LINK = toString (args.NIX_CFLAGS_LINK or "") + " -static";
|
2021-08-17 01:16:29 +00:00
|
|
|
} // lib.optionalAttrs (!(args.dontAddStaticConfigureFlags or false)) {
|
2018-08-03 16:36:51 +00:00
|
|
|
configureFlags = (args.configureFlags or []) ++ [
|
|
|
|
"--disable-shared" # brrr...
|
|
|
|
];
|
2021-08-17 01:16:29 +00:00
|
|
|
}));
|
|
|
|
} // lib.optionalAttrs (stdenv0.hostPlatform.libc == "libc") {
|
|
|
|
extraBuildInputs = (old.extraBuildInputs or []) ++ [
|
|
|
|
stdenv0.glibc.static
|
|
|
|
];
|
|
|
|
});
|
2009-02-10 15:48:30 +00:00
|
|
|
|
2012-10-31 12:41:54 +00:00
|
|
|
|
2011-12-14 14:31:56 +00:00
|
|
|
# Return a modified stdenv that builds static libraries instead of
|
|
|
|
# shared libraries.
|
2021-08-17 01:16:29 +00:00
|
|
|
makeStaticLibraries = stdenv:
|
|
|
|
stdenv.override (old: {
|
|
|
|
mkDerivationFromStdenv = extendMkDerivationArgs old (args: {
|
2010-01-21 21:42:17 +00:00
|
|
|
dontDisableStatic = true;
|
2021-08-17 01:16:29 +00:00
|
|
|
} // lib.optionalAttrs (!(args.dontAddStaticConfigureFlags or false)) {
|
2018-08-03 16:36:51 +00:00
|
|
|
configureFlags = (args.configureFlags or []) ++ [
|
|
|
|
"--enable-static"
|
|
|
|
"--disable-shared"
|
|
|
|
];
|
2019-12-29 20:40:52 +00:00
|
|
|
cmakeFlags = (args.cmakeFlags or []) ++ [ "-DBUILD_SHARED_LIBS:BOOL=OFF" ];
|
2019-05-09 01:52:59 +00:00
|
|
|
mesonFlags = (args.mesonFlags or []) ++ [ "-Ddefault_library=static" ];
|
2010-01-21 21:42:17 +00:00
|
|
|
});
|
2021-08-17 01:16:29 +00:00
|
|
|
});
|
2010-01-21 21:42:17 +00:00
|
|
|
|
2021-08-19 17:56:53 +00:00
|
|
|
# Best effort static binaries. Will still be linked to libSystem,
|
|
|
|
# but more portable than Nix store binaries.
|
|
|
|
makeStaticDarwin = stdenv: stdenv.override (old: {
|
|
|
|
# extraBuildInputs are dropped in cross.nix, but darwin still needs them
|
|
|
|
extraBuildInputs = [ pkgs.buildPackages.darwin.CF ];
|
|
|
|
mkDerivationFromStdenv = extendMkDerivationArgs old (args: {
|
|
|
|
NIX_CFLAGS_LINK = toString (args.NIX_CFLAGS_LINK or "")
|
|
|
|
+ lib.optionalString (stdenv.cc.isGNU or false) " -static-libgcc";
|
|
|
|
nativeBuildInputs = (args.nativeBuildInputs or []) ++ [
|
|
|
|
(pkgs.buildPackages.makeSetupHook {
|
|
|
|
substitutions = {
|
|
|
|
libsystem = "${stdenv.cc.libc}/lib/libSystem.B.dylib";
|
|
|
|
};
|
|
|
|
} ./darwin/portable-libsystem.sh)
|
|
|
|
];
|
|
|
|
});
|
|
|
|
});
|
|
|
|
|
2019-07-24 14:04:51 +00:00
|
|
|
|
|
|
|
/* Modify a stdenv so that all buildInputs are implicitly propagated to
|
|
|
|
consuming derivations
|
|
|
|
*/
|
2021-08-17 01:16:29 +00:00
|
|
|
propagateBuildInputs = stdenv:
|
|
|
|
stdenv.override (old: {
|
|
|
|
mkDerivationFromStdenv = extendMkDerivationArgs old (args: {
|
2019-07-24 14:04:51 +00:00
|
|
|
propagatedBuildInputs = (args.propagatedBuildInputs or []) ++ (args.buildInputs or []);
|
|
|
|
buildInputs = [];
|
|
|
|
});
|
2021-08-17 01:16:29 +00:00
|
|
|
});
|
2019-07-24 14:04:51 +00:00
|
|
|
|
|
|
|
|
2009-03-30 13:22:19 +00:00
|
|
|
/* Modify a stdenv so that the specified attributes are added to
|
|
|
|
every derivation returned by its mkDerivation function.
|
|
|
|
|
|
|
|
Example:
|
|
|
|
stdenvNoOptimise =
|
|
|
|
addAttrsToDerivation
|
|
|
|
{ NIX_CFLAGS_COMPILE = "-O0"; }
|
|
|
|
stdenv;
|
|
|
|
*/
|
2021-08-17 01:16:29 +00:00
|
|
|
addAttrsToDerivation = extraAttrs: stdenv: stdenv.override (old: {
|
|
|
|
mkDerivationFromStdenv = extendMkDerivationArgs old (_: extraAttrs);
|
|
|
|
});
|
2009-03-30 13:22:19 +00:00
|
|
|
|
|
|
|
|
2009-08-28 16:45:56 +00:00
|
|
|
/* Return a modified stdenv that builds packages with GCC's coverage
|
|
|
|
instrumentation. The coverage note files (*.gcno) are stored in
|
2009-09-01 21:56:46 +00:00
|
|
|
$out/.build, along with the source code of the package, to enable
|
|
|
|
programs like lcov to produce pretty-printed reports.
|
2009-08-28 16:45:56 +00:00
|
|
|
*/
|
|
|
|
addCoverageInstrumentation = stdenv:
|
2014-03-03 12:39:30 +00:00
|
|
|
overrideInStdenv stdenv [ pkgs.enableGCOVInstrumentation pkgs.keepBuildTree ];
|
2012-10-31 12:41:54 +00:00
|
|
|
|
2009-11-16 22:23:11 +00:00
|
|
|
|
|
|
|
/* Replace the meta.maintainers field of a derivation. This is useful
|
|
|
|
when you want to fork to update some packages without disturbing other
|
|
|
|
developers.
|
|
|
|
|
|
|
|
e.g.: in all-packages.nix:
|
|
|
|
|
|
|
|
# remove all maintainers.
|
|
|
|
defaultStdenv = replaceMaintainersField allStdenvs.stdenv pkgs [];
|
|
|
|
*/
|
2021-08-17 01:16:29 +00:00
|
|
|
replaceMaintainersField = stdenv: pkgs: maintainers:
|
|
|
|
stdenv.override (old: {
|
|
|
|
mkDerivationFromStdenv = overrideMkDerivationResult (pkg:
|
|
|
|
lib.recursiveUpdate pkg { meta.maintainers = maintainers; });
|
|
|
|
});
|
2009-11-21 17:50:00 +00:00
|
|
|
|
|
|
|
|
|
|
|
/* Use the trace output to report all processed derivations with their
|
|
|
|
license name.
|
|
|
|
*/
|
2021-08-17 01:16:29 +00:00
|
|
|
traceDrvLicenses = stdenv:
|
|
|
|
stdenv.override (old: {
|
|
|
|
mkDerivationFromStdenv = overrideMkDerivationResult (pkg:
|
2009-11-21 17:50:00 +00:00
|
|
|
let
|
|
|
|
printDrvPath = val: let
|
|
|
|
drvPath = builtins.unsafeDiscardStringContext pkg.drvPath;
|
2012-12-28 18:35:35 +00:00
|
|
|
license = pkg.meta.license or null;
|
2009-11-21 17:50:00 +00:00
|
|
|
in
|
2012-12-28 18:35:35 +00:00
|
|
|
builtins.trace "@:drv:${toString drvPath}:${builtins.toString license}:@" val;
|
2009-11-21 17:50:00 +00:00
|
|
|
in pkg // {
|
|
|
|
outPath = printDrvPath pkg.outPath;
|
|
|
|
drvPath = printDrvPath pkg.drvPath;
|
2021-08-17 01:16:29 +00:00
|
|
|
});
|
|
|
|
});
|
2009-11-22 17:04:33 +00:00
|
|
|
|
2012-10-31 12:41:54 +00:00
|
|
|
|
2009-11-22 17:04:33 +00:00
|
|
|
/* Abort if the license predicate is not verified for a derivation
|
|
|
|
declared with mkDerivation.
|
|
|
|
|
|
|
|
One possible predicate to avoid all non-free packages can be achieved
|
|
|
|
with the following function:
|
|
|
|
|
|
|
|
isFree = license: with builtins;
|
2019-04-24 03:48:22 +00:00
|
|
|
if license == null then true
|
2009-11-22 17:04:33 +00:00
|
|
|
else if isList license then lib.all isFree license
|
|
|
|
else license != "non-free" && license != "unfree";
|
|
|
|
|
|
|
|
This adapter can be defined on the defaultStdenv definition. You can
|
|
|
|
use it by patching the all-packages.nix file or by using the override
|
2017-02-01 15:03:42 +00:00
|
|
|
feature of ~/.config/nixpkgs/config.nix .
|
2009-11-22 17:04:33 +00:00
|
|
|
*/
|
2021-08-17 01:16:29 +00:00
|
|
|
validateLicenses = licensePred: stdenv:
|
|
|
|
stdenv.override (old: {
|
|
|
|
mkDerivationFromStdenv = overrideMkDerivationResult (pkg:
|
2009-11-22 17:04:33 +00:00
|
|
|
let
|
2011-11-20 20:53:15 +00:00
|
|
|
drv = builtins.unsafeDiscardStringContext pkg.drvPath;
|
2009-11-22 17:04:33 +00:00
|
|
|
license =
|
2012-12-28 18:35:35 +00:00
|
|
|
pkg.meta.license or
|
2011-11-20 20:53:15 +00:00
|
|
|
# Fixed-output derivations such as source tarballs usually
|
|
|
|
# don't have licensing information, but that's OK.
|
2012-12-28 18:35:35 +00:00
|
|
|
(pkg.outputHash or
|
|
|
|
(builtins.trace
|
|
|
|
"warning: ${drv} lacks licensing information" null));
|
2009-11-22 17:04:33 +00:00
|
|
|
|
|
|
|
validate = arg:
|
|
|
|
if licensePred license then arg
|
2011-11-20 20:42:05 +00:00
|
|
|
else abort ''
|
2011-11-20 20:53:15 +00:00
|
|
|
while building ${drv}:
|
2011-11-20 20:42:05 +00:00
|
|
|
license `${builtins.toString license}' does not pass the predicate.
|
|
|
|
'';
|
2009-11-22 17:04:33 +00:00
|
|
|
|
|
|
|
in pkg // {
|
|
|
|
outPath = validate pkg.outPath;
|
|
|
|
drvPath = validate pkg.drvPath;
|
2021-08-17 01:16:29 +00:00
|
|
|
});
|
|
|
|
});
|
2012-10-31 12:41:54 +00:00
|
|
|
|
|
|
|
|
|
|
|
/* Modify a stdenv so that it produces debug builds; that is,
|
|
|
|
binaries have debug info, and compiler optimisations are
|
|
|
|
disabled. */
|
2021-08-17 01:16:29 +00:00
|
|
|
keepDebugInfo = stdenv:
|
|
|
|
stdenv.override (old: {
|
|
|
|
mkDerivationFromStdenv = extendMkDerivationArgs old (args: {
|
2012-10-31 12:41:54 +00:00
|
|
|
dontStrip = true;
|
2015-08-10 07:10:35 +00:00
|
|
|
NIX_CFLAGS_COMPILE = toString (args.NIX_CFLAGS_COMPILE or "") + " -ggdb -Og";
|
2012-10-31 12:41:54 +00:00
|
|
|
});
|
2021-08-17 01:16:29 +00:00
|
|
|
});
|
2012-10-31 12:41:54 +00:00
|
|
|
|
2014-02-04 15:58:12 +00:00
|
|
|
|
2014-10-10 12:01:38 +00:00
|
|
|
/* Modify a stdenv so that it uses the Gold linker. */
|
2021-08-17 01:16:29 +00:00
|
|
|
useGoldLinker = stdenv:
|
|
|
|
stdenv.override (old: {
|
|
|
|
mkDerivationFromStdenv = extendMkDerivationArgs old (args: {
|
2015-05-04 12:00:12 +00:00
|
|
|
NIX_CFLAGS_LINK = toString (args.NIX_CFLAGS_LINK or "") + " -fuse-ld=gold";
|
2014-10-10 12:01:38 +00:00
|
|
|
});
|
2021-08-17 01:16:29 +00:00
|
|
|
});
|
2018-03-21 22:22:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
/* Modify a stdenv so that it builds binaries optimized specifically
|
|
|
|
for the machine they are built on.
|
|
|
|
|
|
|
|
WARNING: this breaks purity! */
|
2021-08-17 01:16:29 +00:00
|
|
|
impureUseNativeOptimizations = stdenv:
|
|
|
|
stdenv.override (old: {
|
|
|
|
mkDerivationFromStdenv = extendMkDerivationArgs old (args: {
|
2018-03-21 22:22:05 +00:00
|
|
|
NIX_CFLAGS_COMPILE = toString (args.NIX_CFLAGS_COMPILE or "") + " -march=native";
|
|
|
|
NIX_ENFORCE_NO_NATIVE = false;
|
|
|
|
|
|
|
|
preferLocalBuild = true;
|
|
|
|
allowSubstitutes = false;
|
|
|
|
});
|
2021-08-17 01:16:29 +00:00
|
|
|
});
|
2009-03-30 13:22:19 +00:00
|
|
|
}
|