2021-08-17 01:16:29 +00:00
{ lib , config }:
stdenv :
2017-07-05 21:56:53 +00:00
check-env: don't execute check-meta.nix 15,000 times
Generated from https://github.com/NixOS/nix/pull/2761:
```
ns calls ns/call
- /home/grahamc/projects/github.com/NixOS/nixpkgs/pkgs/stdenv/generic/check-meta.nix:22:5 591200 15026 39.3451
+ /home/grahamc/projects/github.com/NixOS/nixpkgs/pkgs/stdenv/generic/check-meta.nix:22:5 8744 308 28.3896
```
more, generated by:
```
$ NIX_SHOW_STATS=1 NIX_COUNT_CALLS=1 nix-instantiate ./pkgs/top-level/release.nix -A unstable > before 2>&1
$ jq -r '.functions | map((.name + ":" + .file + ":" + (.line|tostring) + ":" + (.column|tostring) + " " + (.count|tostring))) | .[]' before | sort > before.list
```
applying this patch, then:
```
$ NIX_SHOW_STATS=1 NIX_COUNT_CALLS=1 nix-instantiate ./pkgs/top-level/release.nix -A unstable > after 2>&1
$ jq -r '.functions | map((.name + ":" + .file + ":" + (.line|tostring) + ":" + (.column|tostring) + " " + (.count|tostring))) | .[]' after | sort > after.list
```
and then diffing before.list and after.list to get:
```
calls
- :/home/grahamc/projects/github.com/NixOS/nixpkgs/pkgs/stdenv/generic/check-meta.nix:4:1 7513
+ :/home/grahamc/projects/github.com/NixOS/nixpkgs/pkgs/stdenv/generic/check-meta.nix:4:1 154
- mutuallyExclusive:/home/grahamc/projects/github.com/NixOS/nixpkgs/lib/lists.nix:658:23 7513
+ mutuallyExclusive:/home/grahamc/projects/github.com/NixOS/nixpkgs/lib/lists.nix:658:23 154
- mutuallyExclusive:/home/grahamc/projects/github.com/NixOS/nixpkgs/lib/lists.nix:658:26 7513
+ mutuallyExclusive:/home/grahamc/projects/github.com/NixOS/nixpkgs/lib/lists.nix:658:26 154
- onlyLicenses:/home/grahamc/projects/github.com/NixOS/nixpkgs/pkgs/stdenv/generic/check-meta.nix:21:18 15026
+ onlyLicenses:/home/grahamc/projects/github.com/NixOS/nixpkgs/pkgs/stdenv/generic/check-meta.nix:21:18 308
```
The following information is from `NIX_SHOW_STATS=1 GC_INITIAL_HEAP_SIZE=4g nix-env -f ./outpaths.nix -qaP --no-name --out-path --arg checkMeta true`:
| stat | before | after | Δ | Δ% |
|:---------------------------|---------------:|---------------:|:----------------|--------:|
| **cpuTime** | 179.915 | 145.543 | 🡖 34.372 | -19.10% |
| **envs-bytes** | 3,900,878,824 | 3,599,483,208 | 🡖 301,395,616 | -7.73% |
| **envs-elements** | 214,426,071 | 185,881,709 | 🡖 28,544,362 | -13.31% |
| **envs-number** | 136,591,891 | 132,026,846 | 🡖 4,565,045 | -3.34% |
| **gc-heapSize** | 11,400,048,640 | 12,314,890,240 | 🡕 914,841,600 | 8.02% |
| **gc-totalBytes** | 25,976,902,560 | 24,510,740,176 | 🡖 1,466,162,384 | -5.64% |
| **list-bytes** | 1,665,290,080 | 1,665,290,080 | 0 | |
| **list-concats** | 7,264,417 | 7,264,417 | 0 | |
| **list-elements** | 208,161,260 | 208,161,260 | 0 | |
| **nrAvoided** | 191,359,386 | 179,693,661 | 🡖 11,665,725 | -6.10% |
| **nrFunctionCalls** | 119,665,062 | 116,348,547 | 🡖 3,316,515 | -2.77% |
| **nrLookups** | 80,996,257 | 76,069,825 | 🡖 4,926,432 | -6.08% |
| **nrOpUpdateValuesCopied** | 213,930,649 | 213,930,649 | 0 | |
| **nrOpUpdates** | 12,025,937 | 12,025,937 | 0 | |
| **nrPrimOpCalls** | 88,105,604 | 86,451,598 | 🡖 1,654,006 | -1.88% |
| **nrThunks** | 196,842,044 | 175,126,701 | 🡖 21,715,343 | -11.03% |
| **sets-bytes** | 7,678,425,776 | 7,285,767,928 | 🡖 392,657,848 | -5.11% |
| **sets-elements** | 310,241,340 | 294,373,227 | 🡖 15,868,113 | -5.11% |
| **sets-number** | 29,079,202 | 27,601,310 | 🡖 1,477,892 | -5.08% |
| **sizes-Attr** | 24 | 24 | 0 | |
| **sizes-Bindings** | 8 | 8 | 0 | |
| **sizes-Env** | 16 | 16 | 0 | |
| **sizes-Value** | 24 | 24 | 0 | |
| **symbols-bytes** | 16,474,666 | 16,474,676 | 🡕 10 | 0.00% |
| **symbols-number** | 376,426 | 376,427 | 🡕 1 | 0.00% |
| **values-bytes** | 6,856,506,288 | 6,316,585,560 | 🡖 539,920,728 | -7.87% |
| **values-number** | 285,687,762 | 263,191,065 | 🡖 22,496,697 | -7.87% |
The following information is from `NIX_SHOW_STATS=1 GC_INITIAL_HEAP_SIZE=4g nix-instantiate ./nixos/release-combined.nix -A tested`:
| stat | before | after | Δ | Δ% |
|:---------------------------|---------------:|---------------:|:----------------|-------:|
| **cpuTime** | 256.071 | 237.531 | 🡖 18.54 | -7.24% |
| **envs-bytes** | 7,111,004,192 | 7,041,478,520 | 🡖 69,525,672 | -0.98% |
| **envs-elements** | 346,236,940 | 339,588,487 | 🡖 6,648,453 | -1.92% |
| **envs-number** | 271,319,292 | 270,298,164 | 🡖 1,021,128 | -0.38% |
| **gc-heapSize** | 8,995,291,136 | 10,110,009,344 | 🡕 1,114,718,208 | 12.39% |
| **gc-totalBytes** | 37,172,737,408 | 36,878,391,888 | 🡖 294,345,520 | -0.79% |
| **list-bytes** | 1,886,162,656 | 1,886,163,472 | 🡕 816 | 0.00% |
| **list-concats** | 6,898,114 | 6,898,114 | 0 | |
| **list-elements** | 235,770,332 | 235,770,434 | 🡕 102 | 0.00% |
| **nrAvoided** | 328,829,821 | 326,618,157 | 🡖 2,211,664 | -0.67% |
| **nrFunctionCalls** | 240,850,845 | 239,998,495 | 🡖 852,350 | -0.35% |
| **nrLookups** | 144,849,632 | 142,126,339 | 🡖 2,723,293 | -1.88% |
| **nrOpUpdateValuesCopied** | 251,032,504 | 251,032,504 | 0 | |
| **nrOpUpdates** | 17,903,110 | 17,903,110 | 0 | |
| **nrPrimOpCalls** | 140,674,913 | 139,485,975 | 🡖 1,188,938 | -0.85% |
| **nrThunks** | 294,643,131 | 288,678,022 | 🡖 5,965,109 | -2.02% |
| **sets-bytes** | 9,464,322,192 | 9,456,172,048 | 🡖 8,150,144 | -0.09% |
| **sets-elements** | 377,474,889 | 377,134,877 | 🡖 340,012 | -0.09% |
| **sets-number** | 50,615,607 | 50,616,875 | 🡕 1,268 | 0.00% |
| **sizes-Attr** | 24 | 24 | 0 | |
| **sizes-Bindings** | 8 | 8 | 0 | |
| **sizes-Env** | 16 | 16 | 0 | |
| **sizes-Value** | 24 | 24 | 0 | |
| **symbols-bytes** | 3,147,102 | 3,147,064 | 🡖 38 | -0.00% |
| **symbols-number** | 82,819 | 82,819 | 0 | |
| **values-bytes** | 11,147,448,768 | 10,996,111,512 | 🡖 151,337,256 | -1.36% |
| **values-number** | 464,477,032 | 458,171,313 | 🡖 6,305,719 | -1.36% |
2019-04-11 16:35:35 +00:00
let
checkMeta = import ./check-meta.nix {
inherit lib config ;
# Nix itself uses the `system` field of a derivation to decide where
# to build it. This is a bit confusing for cross compilation.
inherit ( stdenv ) hostPlatform ;
} ;
2021-04-20 11:46:53 +00:00
# Based off lib.makeExtensible, with modifications:
2022-06-05 11:36:56 +00:00
makeDerivationExtensible = rattrs :
2021-04-20 11:46:53 +00:00
let
2022-01-11 08:07:58 +00:00
# NOTE: The following is a hint that will be printed by the Nix cli when
# encountering an infinite recursion. It must not be formatted into
# separate lines, because Nix would only show the last line of the comment.
# An infinite recursion here can be caused by having the attribute names of expression `e` in `.overrideAttrs(finalAttrs: previousAttrs: e)` depend on `finalAttrs`. Only the attribute values of `e` can depend on `finalAttrs`.
2022-11-18 11:16:45 +00:00
args = rattrs ( args // { inherit finalPackage overrideAttrs ; } ) ;
2022-01-11 08:07:58 +00:00
# ^^^^
2022-11-18 11:16:45 +00:00
overrideAttrs = f0 :
let
f = self : super :
# Convert f0 to an overlay. Legacy is:
# overrideAttrs (super: {})
# We want to introduce self. We follow the convention of overlays:
# overrideAttrs (self: super: {})
# Which means the first parameter can be either self or super.
# This is surprising, but far better than the confusion that would
# arise from flipping an overlay's parameters in some cases.
let x = f0 super ;
2021-07-29 11:09:27 +00:00
in
2022-11-18 11:16:45 +00:00
if builtins . isFunction x
then
# Can't reuse `x`, because `self` comes first.
# Looks inefficient, but `f0 super` was a cheap thunk.
f0 self super
else x ;
in
makeDerivationExtensible
( self : let super = rattrs self ; in super // f self super ) ;
finalPackage =
mkDerivationSimple overrideAttrs args ;
2022-03-15 11:22:16 +00:00
in finalPackage ;
2021-04-20 11:46:53 +00:00
# makeDerivationExtensibleConst == makeDerivationExtensible (_: attrs),
# but pre-evaluated for a slight improvement in performance.
2022-06-05 11:36:56 +00:00
makeDerivationExtensibleConst = attrs :
2021-07-29 11:09:27 +00:00
mkDerivationSimple
( f0 :
let
f = self : super :
let x = f0 super ;
in
if builtins . isFunction x
then
f0 self super
else x ;
in
2022-06-05 11:36:56 +00:00
makeDerivationExtensible ( self : attrs // f self attrs ) )
2021-04-20 11:46:53 +00:00
attrs ;
2022-06-05 11:33:35 +00:00
mkDerivationSimple = overrideAttrs :
2021-04-20 11:46:53 +00:00
2021-08-18 17:19:30 +00:00
# `mkDerivation` wraps the builtin `derivation` function to
# produce derivations that use this stdenv and its shell.
#
# See also:
#
# * https://nixos.org/nixpkgs/manual/#sec-using-stdenv
# Details on how to use this mkDerivation function
#
2022-05-08 03:20:34 +00:00
# * https://nixos.org/manual/nix/stable/expressions/derivations.html#derivations
2021-08-18 17:19:30 +00:00
# Explanation about derivations in general
{
# These types of dependencies are all exhaustively documented in
# the "Specifying Dependencies" section of the "Standard
# Environment" chapter of the Nixpkgs manual.
# TODO(@Ericson2314): Stop using legacy dep attribute names
2022-12-18 12:00:00 +00:00
# host offset -> target offset
depsBuildBuild ? [ ] # -1 -> -1
, depsBuildBuildPropagated ? [ ] # -1 -> -1
, nativeBuildInputs ? [ ] # -1 -> 0 N.B. Legacy name
, propagatedNativeBuildInputs ? [ ] # -1 -> 0 N.B. Legacy name
, depsBuildTarget ? [ ] # -1 -> 1
, depsBuildTargetPropagated ? [ ] # -1 -> 1
, depsHostHost ? [ ] # 0 -> 0
, depsHostHostPropagated ? [ ] # 0 -> 0
, buildInputs ? [ ] # 0 -> 1 N.B. Legacy name
, propagatedBuildInputs ? [ ] # 0 -> 1 N.B. Legacy name
, depsTargetTarget ? [ ] # 1 -> 1
, depsTargetTargetPropagated ? [ ] # 1 -> 1
, checkInputs ? [ ]
, installCheckInputs ? [ ]
, nativeCheckInputs ? [ ]
, nativeInstallCheckInputs ? [ ]
2021-08-18 17:19:30 +00:00
# Configure Phase
, configureFlags ? [ ]
, cmakeFlags ? [ ]
, mesonFlags ? [ ]
, # Target is not included by default because most programs don't care.
# Including it then would cause needless mass rebuilds.
2017-07-05 21:56:53 +00:00
#
2022-06-21 07:14:34 +00:00
# TODO(@Ericson2314): Make [ "build" "host" ] always the default / resolve #87909
2021-08-18 17:19:30 +00:00
configurePlatforms ? lib . optionals
2022-06-21 07:14:34 +00:00
( stdenv . hostPlatform != stdenv . buildPlatform || config . configurePlatformsByDefault )
2021-08-18 17:19:30 +00:00
[ " b u i l d " " h o s t " ]
# TODO(@Ericson2314): Make unconditional / resolve #33599
# Check phase
, doCheck ? config . doCheckByDefault or false
# TODO(@Ericson2314): Make unconditional / resolve #33599
# InstallCheck phase
, doInstallCheck ? config . doCheckByDefault or false
2022-06-21 18:03:43 +00:00
, # TODO(@Ericson2314): Make always true and remove / resolve #178468
2022-04-27 14:53:08 +00:00
strictDeps ? if config . strictDepsByDefault then true else stdenv . hostPlatform != stdenv . buildPlatform
2021-04-20 11:46:53 +00:00
2022-05-11 13:41:30 +00:00
, enableParallelBuilding ? config . enableParallelBuildingByDefault
2021-08-18 17:19:30 +00:00
, meta ? { }
, passthru ? { }
, pos ? # position used in error messages and for meta.position
( if attrs . meta . description or null != null
then builtins . unsafeGetAttrPos " d e s c r i p t i o n " attrs . meta
else if attrs . version or null != null
then builtins . unsafeGetAttrPos " v e r s i o n " attrs
else builtins . unsafeGetAttrPos " n a m e " attrs )
, separateDebugInfo ? false
, outputs ? [ " o u t " ]
, __darwinAllowLocalNetworking ? false
, __impureHostDeps ? [ ]
, __propagatedImpureHostDeps ? [ ]
, sandboxProfile ? " "
, propagatedSandboxProfile ? " "
, hardeningEnable ? [ ]
, hardeningDisable ? [ ]
, patches ? [ ]
, __contentAddressed ?
( ! attrs ? outputHash ) # Fixed-output drvs can't be content addressed too
2022-04-27 20:21:32 +00:00
&& config . contentAddressedByDefault
2021-08-18 17:19:30 +00:00
2022-05-31 21:34:59 +00:00
# Experimental. For simple packages mostly just works,
# but for anything complex, be prepared to debug if enabling.
2022-11-17 16:30:58 +00:00
, __structuredAttrs ? config . structuredAttrsByDefault or false
2022-05-31 21:34:59 +00:00
, env ? { }
2021-08-18 17:19:30 +00:00
, . . . } @ attrs :
let
# TODO(@oxij, @Ericson2314): This is here to keep the old semantics, remove when
# no package has `doCheck = true`.
2021-10-02 12:02:47 +00:00
doCheck' = doCheck && stdenv . buildPlatform . canExecute stdenv . hostPlatform ;
doInstallCheck' = doInstallCheck && stdenv . buildPlatform . canExecute stdenv . hostPlatform ;
2021-08-18 17:19:30 +00:00
2023-02-25 18:18:00 +00:00
separateDebugInfo' = separateDebugInfo && stdenv . hostPlatform . isLinux ;
2021-08-18 17:19:30 +00:00
outputs' = outputs ++ lib . optional separateDebugInfo' " d e b u g " ;
2023-01-20 14:56:31 +00:00
# Turn a derivation into its outPath without a string context attached.
# See the comment at the usage site.
unsafeDerivationToUntrackedOutpath = drv :
if lib . isDerivation drv
then builtins . unsafeDiscardStringContext drv . outPath
else drv ;
2021-08-18 17:19:30 +00:00
noNonNativeDeps = builtins . length ( depsBuildTarget ++ depsBuildTargetPropagated
++ depsHostHost ++ depsHostHostPropagated
++ buildInputs ++ propagatedBuildInputs
++ depsTargetTarget ++ depsTargetTargetPropagated ) == 0 ;
dontAddHostSuffix = attrs ? outputHash && ! noNonNativeDeps || ! stdenv . hasCC ;
2023-01-21 12:37:24 +00:00
hardeningDisable' = if lib . any ( x : x == " f o r t i f y " ) hardeningDisable
# disabling fortify implies fortify3 should also be disabled
then lib . unique ( hardeningDisable ++ [ " f o r t i f y 3 " ] )
else hardeningDisable ;
supportedHardeningFlags = [ " f o r t i f y " " f o r t i f y 3 " " s t a c k p r o t e c t o r " " p i e " " p i c " " s t r i c t o v e r f l o w " " f o r m a t " " r e l r o " " b i n d n o w " ] ;
2021-08-18 17:19:30 +00:00
# Musl-based platforms will keep "pie", other platforms will not.
# If you change this, make sure to update section `{#sec-hardening-in-nixpkgs}`
# in the nixpkgs manual to inform users about the defaults.
2023-01-21 12:37:24 +00:00
defaultHardeningFlags = let
# not ready for this by default
supportedHardeningFlags' = lib . remove " f o r t i f y 3 " supportedHardeningFlags ;
in if stdenv . hostPlatform . isMusl &&
# Except when:
# - static aarch64, where compilation works, but produces segfaulting dynamically linked binaries.
# - static armv7l, where compilation fails.
! ( stdenv . hostPlatform . isAarch && stdenv . hostPlatform . isStatic )
then supportedHardeningFlags'
else lib . remove " p i e " supportedHardeningFlags' ;
2021-08-18 17:19:30 +00:00
enabledHardeningOptions =
2023-01-21 12:37:24 +00:00
if builtins . elem " a l l " hardeningDisable'
2021-08-18 17:19:30 +00:00
then [ ]
2023-01-21 12:37:24 +00:00
else lib . subtractLists hardeningDisable' ( defaultHardeningFlags ++ hardeningEnable ) ;
2021-08-18 17:19:30 +00:00
# hardeningDisable additionally supports "all".
erroneousHardeningFlags = lib . subtractLists supportedHardeningFlags ( hardeningEnable ++ lib . remove " a l l " hardeningDisable ) ;
2022-01-28 07:16:57 +00:00
2022-04-05 10:18:04 +00:00
checkDependencyList = checkDependencyList' [ ] ;
checkDependencyList' = positions : name : deps : lib . flip lib . imap1 deps ( index : dep :
2023-03-05 21:08:45 +00:00
if lib . isDerivation dep || dep == null || builtins . typeOf dep == " s t r i n g " || builtins . typeOf dep == " p a t h " then dep
2022-04-05 10:18:04 +00:00
else if lib . isList dep then checkDependencyList' ( [ index ] ++ positions ) name dep
else throw " D e p e n d e n c y i s n o t o f a v a l i d t y p e : ${ lib . concatMapStrings ( ix : " e l e m e n t ${ toString ix } o f " ) ( [ index ] ++ positions ) } ${ name } f o r ${ attrs . name or attrs . pname } " ) ;
2021-08-18 17:19:30 +00:00
in if builtins . length erroneousHardeningFlags != 0
then abort ( " m k D e r i v a t i o n w a s c a l l e d w i t h u n s u p p o r t e d h a r d e n i n g f l a g s : " + lib . generators . toPretty { } {
inherit erroneousHardeningFlags hardeningDisable hardeningEnable supportedHardeningFlags ;
} )
else let
doCheck = doCheck' ;
doInstallCheck = doInstallCheck' ;
2022-12-18 12:00:00 +00:00
buildInputs' = buildInputs
++ lib . optionals doCheck checkInputs
++ lib . optionals doInstallCheck installCheckInputs ;
nativeBuildInputs' = nativeBuildInputs
++ lib . optional separateDebugInfo' ../../build-support/setup-hooks/separate-debug-info.sh
++ lib . optional stdenv . hostPlatform . isWindows ../../build-support/setup-hooks/win-dll-link.sh
++ lib . optionals doCheck nativeCheckInputs
++ lib . optionals doInstallCheck nativeInstallCheckInputs ;
2021-08-18 17:19:30 +00:00
outputs = outputs' ;
references = nativeBuildInputs ++ buildInputs
++ propagatedNativeBuildInputs ++ propagatedBuildInputs ;
dependencies = map ( map lib . chooseDevOutputs ) [
[
2022-01-28 07:16:57 +00:00
( map ( drv : drv . __spliced . buildBuild or drv ) ( checkDependencyList " d e p s B u i l d B u i l d " depsBuildBuild ) )
2022-12-18 12:00:00 +00:00
( map ( drv : drv . __spliced . buildHost or drv ) ( checkDependencyList " n a t i v e B u i l d I n p u t s " nativeBuildInputs' ) )
2022-01-28 07:16:57 +00:00
( map ( drv : drv . __spliced . buildTarget or drv ) ( checkDependencyList " d e p s B u i l d T a r g e t " depsBuildTarget ) )
2021-08-18 17:19:30 +00:00
]
[
2022-01-28 07:16:57 +00:00
( map ( drv : drv . __spliced . hostHost or drv ) ( checkDependencyList " d e p s H o s t H o s t " depsHostHost ) )
2022-12-18 12:00:00 +00:00
( map ( drv : drv . __spliced . hostTarget or drv ) ( checkDependencyList " b u i l d I n p u t s " buildInputs' ) )
2021-08-18 17:19:30 +00:00
]
[
2022-01-28 07:16:57 +00:00
( map ( drv : drv . __spliced . targetTarget or drv ) ( checkDependencyList " d e p s T a r g e t T a r g e t " depsTargetTarget ) )
2021-08-18 17:19:30 +00:00
]
] ;
propagatedDependencies = map ( map lib . chooseDevOutputs ) [
[
2022-01-28 07:16:57 +00:00
( map ( drv : drv . __spliced . buildBuild or drv ) ( checkDependencyList " d e p s B u i l d B u i l d P r o p a g a t e d " depsBuildBuildPropagated ) )
2022-11-18 04:55:23 +00:00
( map ( drv : drv . __spliced . buildHost or drv ) ( checkDependencyList " p r o p a g a t e d N a t i v e B u i l d I n p u t s " propagatedNativeBuildInputs ) )
2022-01-28 07:16:57 +00:00
( map ( drv : drv . __spliced . buildTarget or drv ) ( checkDependencyList " d e p s B u i l d T a r g e t P r o p a g a t e d " depsBuildTargetPropagated ) )
2021-08-18 17:19:30 +00:00
]
[
2022-01-28 07:16:57 +00:00
( map ( drv : drv . __spliced . hostHost or drv ) ( checkDependencyList " d e p s H o s t H o s t P r o p a g a t e d " depsHostHostPropagated ) )
2022-11-18 04:55:23 +00:00
( map ( drv : drv . __spliced . hostTarget or drv ) ( checkDependencyList " p r o p a g a t e d B u i l d I n p u t s " propagatedBuildInputs ) )
2021-08-18 17:19:30 +00:00
]
[
2022-01-28 07:16:57 +00:00
( map ( drv : drv . __spliced . targetTarget or drv ) ( checkDependencyList " d e p s T a r g e t T a r g e t P r o p a g a t e d " depsTargetTargetPropagated ) )
2021-08-18 17:19:30 +00:00
]
] ;
computedSandboxProfile =
lib . concatMap ( input : input . __propagatedSandboxProfile or [ ] )
( stdenv . extraNativeBuildInputs
++ stdenv . extraBuildInputs
++ lib . concatLists dependencies ) ;
computedPropagatedSandboxProfile =
lib . concatMap ( input : input . __propagatedSandboxProfile or [ ] )
( lib . concatLists propagatedDependencies ) ;
computedImpureHostDeps =
lib . unique ( lib . concatMap ( input : input . __propagatedImpureHostDeps or [ ] )
( stdenv . extraNativeBuildInputs
++ stdenv . extraBuildInputs
++ lib . concatLists dependencies ) ) ;
computedPropagatedImpureHostDeps =
lib . unique ( lib . concatMap ( input : input . __propagatedImpureHostDeps or [ ] )
( lib . concatLists propagatedDependencies ) ) ;
2022-05-31 21:34:59 +00:00
envIsExportable = lib . isAttrs env && ! lib . isDerivation env ;
2021-08-18 17:19:30 +00:00
derivationArg =
( removeAttrs attrs
2022-05-31 21:34:59 +00:00
( [ " m e t a " " p a s s t h r u " " p o s "
2021-08-18 17:19:30 +00:00
" c h e c k I n p u t s " " i n s t a l l C h e c k I n p u t s "
2022-12-18 12:00:00 +00:00
" n a t i v e C h e c k I n p u t s " " n a t i v e I n s t a l l C h e c k I n p u t s "
2021-08-18 17:19:30 +00:00
" _ _ d a r w i n A l l o w L o c a l N e t w o r k i n g "
" _ _ i m p u r e H o s t D e p s " " _ _ p r o p a g a t e d I m p u r e H o s t D e p s "
2022-05-31 21:34:59 +00:00
" s a n d b o x P r o f i l e " " p r o p a g a t e d S a n d b o x P r o f i l e " ]
2022-12-13 17:12:04 +00:00
++ lib . optional ( __structuredAttrs || envIsExportable ) " e n v " ) )
2021-08-18 17:19:30 +00:00
// ( lib . optionalAttrs ( attrs ? name || ( attrs ? pname && attrs ? version ) ) {
name =
let
# Indicate the host platform of the derivation if cross compiling.
# Fixed-output derivations like source tarballs shouldn't get a host
# suffix. But we have some weird ones with run-time deps that are
# just used for their side-affects. Those might as well since the
# hash can't be the same. See #32986.
hostSuffix = lib . optionalString
( stdenv . hostPlatform != stdenv . buildPlatform && ! dontAddHostSuffix )
" - ${ stdenv . hostPlatform . config } " ;
2023-02-18 18:45:18 +00:00
2021-08-18 17:19:30 +00:00
# Disambiguate statically built packages. This was originally
# introduce as a means to prevent nix-env to get confused between
# nix and nixStatic. This should be also achieved by moving the
# hostSuffix before the version, so we could contemplate removing
# it again.
staticMarker = lib . optionalString stdenv . hostPlatform . isStatic " - s t a t i c " ;
in
2022-03-30 08:20:44 +00:00
lib . strings . sanitizeDerivationName (
2021-08-18 17:19:30 +00:00
if attrs ? name
then attrs . name + hostSuffix
2023-02-18 18:45:18 +00:00
else
# we cannot coerce null to a string below
assert lib . assertMsg ( attrs ? version && attrs . version != null ) " T h e ‘ v e r s i o n ’ a t t r i b u t e c a n n o t b e n u l l . " ;
" ${ attrs . pname } ${ staticMarker } ${ hostSuffix } - ${ attrs . version } "
2022-03-30 08:20:44 +00:00
) ;
2022-12-13 17:12:04 +00:00
} ) // lib . optionalAttrs __structuredAttrs { env = checkedEnv ; } // {
2021-08-18 17:19:30 +00:00
builder = attrs . realBuilder or stdenv . shell ;
args = attrs . args or [ " - e " ( attrs . builder or ./default-builder.sh ) ] ;
inherit stdenv ;
# The `system` attribute of a derivation has special meaning to Nix.
# Derivations set it to choose what sort of machine could be used to
# execute the build, The build platform entirely determines this,
# indeed more finely than Nix knows or cares about. The `system`
# attribute of `buildPlatfom` matches Nix's degree of specificity.
# exactly.
inherit ( stdenv . buildPlatform ) system ;
userHook = config . stdenv . userHook or null ;
__ignoreNulls = true ;
2022-05-31 21:34:59 +00:00
inherit __structuredAttrs strictDeps ;
2021-08-18 17:19:30 +00:00
depsBuildBuild = lib . elemAt ( lib . elemAt dependencies 0 ) 0 ;
nativeBuildInputs = lib . elemAt ( lib . elemAt dependencies 0 ) 1 ;
depsBuildTarget = lib . elemAt ( lib . elemAt dependencies 0 ) 2 ;
depsHostHost = lib . elemAt ( lib . elemAt dependencies 1 ) 0 ;
buildInputs = lib . elemAt ( lib . elemAt dependencies 1 ) 1 ;
depsTargetTarget = lib . elemAt ( lib . elemAt dependencies 2 ) 0 ;
depsBuildBuildPropagated = lib . elemAt ( lib . elemAt propagatedDependencies 0 ) 0 ;
propagatedNativeBuildInputs = lib . elemAt ( lib . elemAt propagatedDependencies 0 ) 1 ;
depsBuildTargetPropagated = lib . elemAt ( lib . elemAt propagatedDependencies 0 ) 2 ;
depsHostHostPropagated = lib . elemAt ( lib . elemAt propagatedDependencies 1 ) 0 ;
propagatedBuildInputs = lib . elemAt ( lib . elemAt propagatedDependencies 1 ) 1 ;
depsTargetTargetPropagated = lib . elemAt ( lib . elemAt propagatedDependencies 2 ) 0 ;
# This parameter is sometimes a string, sometimes null, and sometimes a list, yuck
configureFlags = let inherit ( lib ) optional elem ; in
2022-05-15 16:25:41 +00:00
( /* */ if lib . isString configureFlags then lib . warn " S t r i n g ' c o n f i g u r e F l a g s ' i s d e p r e c a t e d a n d w i l l b e r e m o v e d i n r e l e a s e 2 3 . 0 5 . P l e a s e u s e a l i s t o f s t r i n g s . D e r i v a t i o n n a m e : ${ derivationArg . name } , f i l e : ${ pos . file or " u n k n o w n f i l e " } " [ configureFlags ]
else if configureFlags == null then lib . warn " N u l l ' c o n f i g u r e F l a g s ' i s d e p r e c a t e d a n d w i l l b e r e m o v e d i n r e l e a s e 2 3 . 0 5 . P l e a s e u s e a e m p t y l i s t i n s t e a d ' [ ] ' . D e r i v a t i o n n a m e : ${ derivationArg . name } , f i l e : ${ pos . file or " u n k n o w n f i l e " } " [ ]
2021-08-18 17:19:30 +00:00
else configureFlags )
++ optional ( elem " b u i l d " configurePlatforms ) " - - b u i l d = ${ stdenv . buildPlatform . config } "
++ optional ( elem " h o s t " configurePlatforms ) " - - h o s t = ${ stdenv . hostPlatform . config } "
++ optional ( elem " t a r g e t " configurePlatforms ) " - - t a r g e t = ${ stdenv . targetPlatform . config } " ;
2022-07-04 01:25:04 +00:00
cmakeFlags =
let
explicitFlags =
if lib . isString cmakeFlags then lib . warn
" S t r i n g ' c m a k e F l a g s ' i s d e p r e c a t e d a n d w i l l b e r e m o v e d i n r e l e a s e 2 3 . 0 5 . P l e a s e u s e a l i s t o f s t r i n g s . D e r i v a t i o n n a m e : ${ derivationArg . name } , f i l e : ${ pos . file or " u n k n o w n f i l e " } "
[ cmakeFlags ]
else if cmakeFlags == null then
lib . warn
" N u l l ' c m a k e F l a g s ' i s d e p r e c a t e d a n d w i l l b e r e m o v e d i n r e l e a s e 2 3 . 0 5 . P l e a s e u s e a e m p t y l i s t i n s t e a d ' [ ] ' . D e r i v a t i o n n a m e : ${ derivationArg . name } , f i l e : ${ pos . file or " u n k n o w n f i l e " } "
[ ]
else
cmakeFlags ;
crossFlags = [
" - D C M A K E _ S Y S T E M _ N A M E = ${ lib . findFirst lib . isString " G e n e r i c " ( lib . optional ( ! stdenv . hostPlatform . isRedox ) stdenv . hostPlatform . uname . system ) } "
] ++ lib . optionals ( stdenv . hostPlatform . uname . processor != null ) [
" - D C M A K E _ S Y S T E M _ P R O C E S S O R = ${ stdenv . hostPlatform . uname . processor } "
] ++ lib . optionals ( stdenv . hostPlatform . uname . release != null ) [
" - D C M A K E _ S Y S T E M _ V E R S I O N = ${ stdenv . hostPlatform . uname . release } "
] ++ lib . optionals ( stdenv . hostPlatform . isDarwin ) [
" - D C M A K E _ O S X _ A R C H I T E C T U R E S = ${ stdenv . hostPlatform . darwinArch } "
] ++ lib . optionals ( stdenv . buildPlatform . uname . system != null ) [
" - D C M A K E _ H O S T _ S Y S T E M _ N A M E = ${ stdenv . buildPlatform . uname . system } "
] ++ lib . optionals ( stdenv . buildPlatform . uname . processor != null ) [
" - D C M A K E _ H O S T _ S Y S T E M _ P R O C E S S O R = ${ stdenv . buildPlatform . uname . processor } "
] ++ lib . optionals ( stdenv . buildPlatform . uname . release != null ) [
" - D C M A K E _ H O S T _ S Y S T E M _ V E R S I O N = ${ stdenv . buildPlatform . uname . release } "
] ;
in
explicitFlags ++ lib . optionals ( stdenv . hostPlatform != stdenv . buildPlatform ) crossFlags ;
2022-07-06 03:05:48 +00:00
mesonFlags =
let
explicitFlags =
if lib . isString mesonFlags then lib . warn
" S t r i n g ' m e s o n F l a g s ' i s d e p r e c a t e d a n d w i l l b e r e m o v e d i n r e l e a s e 2 3 . 0 5 . P l e a s e u s e a l i s t o f s t r i n g s . D e r i v a t i o n n a m e : ${ derivationArg . name } , f i l e : ${ pos . file or " u n k n o w n f i l e " } "
[ mesonFlags ]
else if mesonFlags == null then
lib . warn
" N u l l ' m e s o n F l a g s ' i s d e p r e c a t e d a n d w i l l b e r e m o v e d i n r e l e a s e 2 3 . 0 5 . P l e a s e u s e a e m p t y l i s t i n s t e a d ' [ ] ' . D e r i v a t i o n n a m e : ${ derivationArg . name } , f i l e : ${ pos . file or " u n k n o w n f i l e " } "
[ ]
else
mesonFlags ;
# See https://mesonbuild.com/Reference-tables.html#cpu-families
cpuFamily = platform : with platform ;
/* */ if isAarch32 then " a r m "
else if isx86_32 then " x 8 6 "
2023-01-30 18:57:37 +00:00
else platform . uname . processor ;
2022-07-06 03:05:48 +00:00
crossFile = builtins . toFile " c r o s s - f i l e . c o n f " ''
[ properties ]
2022-07-31 23:27:15 +00:00
needs_exe_wrapper = $ { lib . boolToString ( ! stdenv . buildPlatform . canExecute stdenv . hostPlatform ) }
2022-07-06 03:05:48 +00:00
[ host_machine ]
system = ' $ { stdenv . targetPlatform . parsed . kernel . name } '
cpu_family = ' $ { cpuFamily stdenv . targetPlatform } '
cpu = ' $ { stdenv . targetPlatform . parsed . cpu . name } '
endian = $ { if stdenv . targetPlatform . isLittleEndian then " ' l i t t l e ' " else " ' b i g ' " }
[ binaries ]
llvm-config = ' llvm-config-native'
'' ;
crossFlags = lib . optionals ( stdenv . hostPlatform != stdenv . buildPlatform ) [ " - - c r o s s - f i l e = ${ crossFile } " ] ;
in crossFlags ++ explicitFlags ;
2021-08-18 17:19:30 +00:00
inherit patches ;
inherit doCheck doInstallCheck ;
inherit outputs ;
} // lib . optionalAttrs ( __contentAddressed ) {
inherit __contentAddressed ;
# Provide default values for outputHashMode and outputHashAlgo because
# most people won't care about these anyways
outputHashAlgo = attrs . outputHashAlgo or " s h a 2 5 6 " ;
outputHashMode = attrs . outputHashMode or " r e c u r s i v e " ;
2022-05-11 13:41:30 +00:00
} // lib . optionalAttrs ( enableParallelBuilding ) {
2022-12-17 22:21:07 +00:00
inherit enableParallelBuilding ;
2021-08-18 17:19:30 +00:00
enableParallelChecking = attrs . enableParallelChecking or true ;
2023-02-21 19:50:48 +00:00
enableParallelInstalling = attrs . enableParallelInstalling or true ;
2021-08-18 17:19:30 +00:00
} // lib . optionalAttrs ( hardeningDisable != [ ] || hardeningEnable != [ ] || stdenv . hostPlatform . isMusl ) {
NIX_HARDENING_ENABLE = enabledHardeningOptions ;
} // lib . optionalAttrs ( stdenv . hostPlatform . isx86_64 && stdenv . hostPlatform ? gcc . arch ) {
requiredSystemFeatures = attrs . requiredSystemFeatures or [ ] ++ [ " g c c a r c h - ${ stdenv . hostPlatform . gcc . arch } " ] ;
} // lib . optionalAttrs ( stdenv . buildPlatform . isDarwin ) {
inherit __darwinAllowLocalNetworking ;
# TODO: remove lib.unique once nix has a list canonicalization primitive
__sandboxProfile =
let profiles = [ stdenv . extraSandboxProfile ] ++ computedSandboxProfile ++ computedPropagatedSandboxProfile ++ [ propagatedSandboxProfile sandboxProfile ] ;
final = lib . concatStringsSep " \n " ( lib . filter ( x : x != " " ) ( lib . unique profiles ) ) ;
in final ;
__propagatedSandboxProfile = lib . unique ( computedPropagatedSandboxProfile ++ [ propagatedSandboxProfile ] ) ;
__impureHostDeps = computedImpureHostDeps ++ computedPropagatedImpureHostDeps ++ __propagatedImpureHostDeps ++ __impureHostDeps ++ stdenv . __extraImpureHostDeps ++ [
" / d e v / z e r o "
" / d e v / r a n d o m "
" / d e v / u r a n d o m "
" / b i n / s h "
2017-07-05 21:56:53 +00:00
] ;
2021-08-18 17:19:30 +00:00
__propagatedImpureHostDeps = computedPropagatedImpureHostDeps ++ __propagatedImpureHostDeps ;
2023-01-20 14:56:31 +00:00
} //
# If we use derivations directly here, they end up as build-time dependencies.
# This is especially problematic in the case of disallowed*, since the disallowed
# derivations will be built by nix as build-time dependencies, while those
# derivations might take a very long time to build, or might not even build
# successfully on the platform used.
# We can improve on this situation by instead passing only the outPath,
# without an attached string context, to nix. The out path will be a placeholder
# which will be replaced by the actual out path if the derivation in question
# is part of the final closure (and thus needs to be built). If it is not
# part of the final closure, then the placeholder will be passed along,
# but in that case we know for a fact that the derivation is not part of the closure.
# This means that passing the out path to nix does the right thing in either
# case, both for disallowed and allowed references/requisites, and we won't
# build the derivation if it wouldn't be part of the closure, saving time and resources.
# While the problem is less severe for allowed*, since we want the derivation
# to be built eventually, we would still like to get the error early and without
# having to wait while nix builds a derivation that might not be used.
# See also https://github.com/NixOS/nix/issues/4629
lib . optionalAttrs ( attrs ? disallowedReferences ) {
disallowedReferences =
map unsafeDerivationToUntrackedOutpath attrs . disallowedReferences ;
} //
lib . optionalAttrs ( attrs ? disallowedRequisites ) {
disallowedRequisites =
map unsafeDerivationToUntrackedOutpath attrs . disallowedRequisites ;
} //
lib . optionalAttrs ( attrs ? allowedReferences ) {
allowedReferences =
lib . mapNullable unsafeDerivationToUntrackedOutpath attrs . allowedReferences ;
} //
lib . optionalAttrs ( attrs ? allowedRequisites ) {
allowedRequisites =
lib . mapNullable unsafeDerivationToUntrackedOutpath attrs . allowedRequisites ;
2021-08-18 17:19:30 +00:00
} ;
validity = checkMeta { inherit meta attrs ; } ;
# The meta attribute is passed in the resulting attribute set,
# but it's not part of the actual derivation, i.e., it's not
# passed to the builder and is not a dependency. But since we
# include it in the result, it *is* available to nix-env for queries.
meta = {
2022-03-30 08:20:44 +00:00
# `name` above includes cross-compilation cruft,
# is under assert, and is sanitized.
# Let's have a clean always accessible version here.
2021-08-18 17:19:30 +00:00
name = attrs . name or " ${ attrs . pname } - ${ attrs . version } " ;
# If the packager hasn't specified `outputsToInstall`, choose a default,
# which is the name of `p.bin or p.out or p` along with `p.man` when
# present.
#
# If the packager has specified it, it will be overridden below in
# `// meta`.
#
# Note: This default probably shouldn't be globally configurable.
# Services and users should specify outputs explicitly,
# unless they are comfortable with this default.
outputsToInstall =
let
hasOutput = out : builtins . elem out outputs ;
in [ ( lib . findFirst hasOutput null ( [ " b i n " " o u t " ] ++ outputs ) ) ]
++ lib . optional ( hasOutput " m a n " ) " m a n " ;
}
// attrs . meta or { }
# Fill `meta.position` to identify the source location of the package.
// lib . optionalAttrs ( pos != null ) {
position = pos . file + " : " + toString pos . line ;
} // {
# Expose the result of the checks for everyone to see.
inherit ( validity ) unfree broken unsupported insecure ;
2022-05-03 19:12:34 +00:00
available = validity . valid != " n o "
2021-08-18 17:19:30 +00:00
&& ( if config . checkMetaRecursively or false
then lib . all ( d : d . meta . available or true ) references
else true ) ;
} ;
2022-05-31 21:34:59 +00:00
checkedEnv =
let
2022-12-17 11:55:44 +00:00
overlappingNames = lib . attrNames ( builtins . intersectAttrs env derivationArg ) ;
2022-05-31 21:34:59 +00:00
in
2022-12-13 17:12:04 +00:00
assert lib . assertMsg envIsExportable
" W h e n u s i n g s t r u c t u r e d a t t r i b u t e s , ` e n v ` m u s t b e a n a t t r i b u t e s e t o f e n v i r o n m e n t v a r i a b l e s . " ;
2022-05-31 21:34:59 +00:00
assert lib . assertMsg ( overlappingNames == [ ] )
" T h e ‘ e n v ’ a t t r i b u t e s e t c a n n o t c o n t a i n a n y a t t r i b u t e s p a s s e d t o d e r i v a t i o n . T h e f o l l o w i n g a t t r i b u t e s a r e o v e r l a p p i n g : ${ lib . concatStringsSep " , " overlappingNames } " ;
lib . mapAttrs
2022-12-06 22:08:33 +00:00
( n : v : assert lib . assertMsg ( lib . isString v || lib . isBool v || lib . isInt v || lib . isDerivation v )
" T h e ‘ e n v ’ a t t r i b u t e s e t c a n o n l y c o n t a i n d e r i v a t i o n , s t r i n g , b o o l e a n o r i n t e g e r a t t r i b u t e s . T h e ‘ ${ n } ’ a t t r i b u t e i s o f t y p e ${ builtins . typeOf v } . " ; v )
2022-05-31 21:34:59 +00:00
env ;
2021-08-18 17:19:30 +00:00
in
2017-07-05 21:56:53 +00:00
2021-08-18 17:19:30 +00:00
lib . extendDerivation
validity . handled
( {
# A derivation that always builds successfully and whose runtime
# dependencies are the original derivations build time dependencies
# This allows easy building and distributing of all derivations
# needed to enter a nix-shell with
# nix-build shell.nix -A inputDerivation
inputDerivation = derivation ( derivationArg // {
# Add a name in case the original drv didn't have one
name = derivationArg . name or " i n p u t D e r i v a t i o n " ;
# This always only has one output
outputs = [ " o u t " ] ;
# Propagate the original builder and arguments, since we override
# them and they might contain references to build inputs
_derivation_original_builder = derivationArg . builder ;
_derivation_original_args = derivationArg . args ;
builder = stdenv . shell ;
# The bash builtin `export` dumps all current environment variables,
# which is where all build input references end up (e.g. $PATH for
# binaries). By writing this to $out, Nix can find and register
# them as runtime dependencies (since Nix greps for store paths
# through $out to find them)
args = [ " - c " " e x p o r t > $ o u t " ] ;
2023-02-07 17:57:23 +00:00
# inputDerivation produces the inputs; not the outputs, so any
# restrictions on what used to be the outputs don't serve a purpose
# anymore.
disallowedReferences = [ ] ;
disallowedRequisites = [ ] ;
2021-08-18 17:19:30 +00:00
} ) ;
2021-04-20 11:46:53 +00:00
inherit meta passthru overrideAttrs ;
2021-08-18 17:19:30 +00:00
} //
# Pass through extra attributes that are not inputs, but
# should be made available to Nix expressions using the
# derivation (e.g., in assertions).
passthru )
2022-05-31 21:34:59 +00:00
( derivation ( derivationArg // lib . optionalAttrs envIsExportable checkedEnv ) ) ;
2021-04-20 11:46:53 +00:00
2022-06-05 11:33:35 +00:00
in
2022-06-05 11:35:04 +00:00
fnOrAttrs :
if builtins . isFunction fnOrAttrs
2022-06-05 11:36:56 +00:00
then makeDerivationExtensible fnOrAttrs
else makeDerivationExtensibleConst fnOrAttrs