2021-08-22 07:53:02 +00:00
{ lib , config }:
stdenv :
2020-04-24 23:36:52 +00:00
let
2023-11-16 04:20:00 +00:00
# Lib attributes are inherited to the lexical scope for performance reasons.
inherit ( lib )
any
assertMsg
attrNames
boolToString
concatLists
concatMap
concatMapStrings
concatStringsSep
elem
elemAt
extendDerivation
filter
findFirst
2024-04-21 15:54:59 +00:00
getDev
2023-11-16 04:20:00 +00:00
head
imap1
isAttrs
isBool
isDerivation
isInt
isList
isString
mapAttrs
mapNullable
optional
optionalAttrs
optionalString
optionals
remove
splitString
subtractLists
unique
;
2024-04-21 15:54:59 +00:00
inherit ( import ../../build-support/lib/cmake.nix { inherit lib stdenv ; } ) makeCMakeFlags ;
inherit ( import ../../build-support/lib/meson.nix { inherit lib stdenv ; } ) makeMesonFlags ;
mkDerivation =
fnOrAttrs :
if builtins . isFunction fnOrAttrs
then makeDerivationExtensible fnOrAttrs
else makeDerivationExtensibleConst fnOrAttrs ;
2020-04-24 23:36:52 +00:00
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 ;
} ;
2022-04-27 09:35:20 +00:00
# Based off lib.makeExtensible, with modifications:
2022-06-16 17:23:12 +00:00
makeDerivationExtensible = rattrs :
2022-04-27 09:35:20 +00:00
let
# 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`.
2023-03-04 12:14:45 +00:00
args = rattrs ( args // { inherit finalPackage overrideAttrs ; } ) ;
2022-04-27 09:35:20 +00:00
# ^^^^
2023-03-04 12:14: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 ;
2022-04-27 09:35:20 +00:00
in
2023-03-04 12:14: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
2023-07-15 17:15:38 +00:00
( self : let super = rattrs self ; in super // ( if builtins . isFunction f0 || f0 ? __functor then f self super else f0 ) ) ;
2023-03-04 12:14:45 +00:00
finalPackage =
mkDerivationSimple overrideAttrs args ;
2022-04-27 09:35:20 +00:00
in finalPackage ;
2023-08-10 07:59:29 +00:00
#makeDerivationExtensibleConst = attrs: makeDerivationExtensible (_: attrs);
2022-04-27 09:35:20 +00:00
# but pre-evaluated for a slight improvement in performance.
2022-06-16 17:23:12 +00:00
makeDerivationExtensibleConst = attrs :
2022-04-27 09:35:20 +00:00
mkDerivationSimple
( f0 :
let
f = self : super :
let x = f0 super ;
in
if builtins . isFunction x
then
f0 self super
else x ;
in
2023-07-15 17:15:38 +00:00
makeDerivationExtensible ( self : attrs // ( if builtins . isFunction f0 || f0 ? __functor then f self attrs else f0 ) ) )
2022-04-27 09:35:20 +00:00
attrs ;
2024-04-21 15:54:59 +00:00
knownHardeningFlags = [
" b i n d n o w "
" f o r m a t "
" f o r t i f y "
" f o r t i f y 3 "
" p i c "
" p i e "
" r e l r o "
" s t a c k p r o t e c t o r "
" s t r i c t o v e r f l o w "
" t r i v i a l a u t o v a r i n i t "
" z e r o c a l l u s e d r e g s "
] ;
2022-04-27 09:35:20 +00:00
2024-04-21 15:54:59 +00:00
removedOrReplacedAttrNames = [
" 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 "
" 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 "
" _ _ c o n t e n t A d d r e s s e d "
" _ _ 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 "
" 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-04-27 09:35:20 +00:00
2024-04-21 15:54:59 +00:00
# Turn a derivation into its outPath without a string context attached.
# See the comment at the usage site.
unsafeDerivationToUntrackedOutpath = drv :
if isDerivation drv
then builtins . unsafeDiscardStringContext drv . outPath
else drv ;
makeDerivationArgument =
# `makeDerivationArgument` is responsible for the `mkDerivation` arguments that
# affect the actual derivation, excluding a few behaviors that are not
# essential, and specific to `mkDerivation`: `env`, `cmakeFlags`, `mesonFlags`.
2021-08-22 07:53:02 +00:00
#
# See also:
#
# * https://nixos.org/nixpkgs/manual/#sec-using-stdenv
# Details on how to use this mkDerivation function
#
2022-05-18 14:49:53 +00:00
# * https://nixos.org/manual/nix/stable/expressions/derivations.html#derivations
2021-08-22 07:53:02 +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
2023-02-02 18:25:31 +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-22 07:53:02 +00:00
# Configure Phase
, configureFlags ? [ ]
, # Target is not included by default because most programs don't care.
# Including it then would cause needless mass rebuilds.
2020-04-24 23:36:52 +00:00
#
2022-06-26 10:26:21 +00:00
# TODO(@Ericson2314): Make [ "build" "host" ] always the default / resolve #87909
2023-11-16 04:20:00 +00:00
configurePlatforms ? optionals
2022-06-26 10:26:21 +00:00
( stdenv . hostPlatform != stdenv . buildPlatform || config . configurePlatformsByDefault )
2021-08-22 07:53:02 +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-26 10:26:21 +00:00
, # TODO(@Ericson2314): Make always true and remove / resolve #178468
2022-04-27 09:35:20 +00:00
strictDeps ? if config . strictDepsByDefault then true else stdenv . hostPlatform != stdenv . buildPlatform
2022-05-18 14:49:53 +00:00
, enableParallelBuilding ? config . enableParallelBuildingByDefault
2021-08-22 07:53:02 +00:00
, 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 09:35:20 +00:00
&& config . contentAddressedByDefault
2021-08-22 07:53:02 +00:00
2023-01-20 10:41:00 +00:00
# Experimental. For simple packages mostly just works,
# but for anything complex, be prepared to debug if enabling.
, __structuredAttrs ? config . structuredAttrsByDefault or false
2021-08-22 07:53:02 +00:00
, . . . } @ attrs :
2020-04-24 23:36:52 +00:00
2023-11-16 04:20:00 +00:00
# Policy on acceptable hash types in nixpkgs
assert attrs ? outputHash -> (
let algo =
attrs . outputHashAlgo or ( head ( splitString " - " attrs . outputHash ) ) ;
in
if algo == " m d 5 " then
throw " R e j e c t e d i n s e c u r e ${ algo } h a s h ' ${ attrs . outputHash } ' "
else
true
) ;
2021-08-22 07:53:02 +00:00
let
# TODO(@oxij, @Ericson2314): This is here to keep the old semantics, remove when
# no package has `doCheck = true`.
2022-06-16 17:23:12 +00:00
doCheck' = doCheck && stdenv . buildPlatform . canExecute stdenv . hostPlatform ;
doInstallCheck' = doInstallCheck && stdenv . buildPlatform . canExecute stdenv . hostPlatform ;
2021-08-22 07:53:02 +00:00
2023-03-15 16:39:30 +00:00
separateDebugInfo' = separateDebugInfo && stdenv . hostPlatform . isLinux ;
2023-11-16 04:20:00 +00:00
outputs' = outputs ++ optional separateDebugInfo' " d e b u g " ;
2021-08-22 07:53:02 +00:00
noNonNativeDeps = builtins . length ( depsBuildTarget ++ depsBuildTargetPropagated
++ depsHostHost ++ depsHostHostPropagated
++ buildInputs ++ propagatedBuildInputs
++ depsTargetTarget ++ depsTargetTargetPropagated ) == 0 ;
dontAddHostSuffix = attrs ? outputHash && ! noNonNativeDeps || ! stdenv . hasCC ;
2023-03-15 16:39:30 +00:00
2023-11-16 04:20:00 +00:00
hardeningDisable' = if any ( x : x == " f o r t i f y " ) hardeningDisable
2023-03-15 16:39:30 +00:00
# disabling fortify implies fortify3 should also be disabled
2023-11-16 04:20:00 +00:00
then unique ( hardeningDisable ++ [ " f o r t i f y 3 " ] )
2023-03-15 16:39:30 +00:00
else hardeningDisable ;
2024-01-25 14:12:00 +00:00
defaultHardeningFlags =
( if stdenv . hasCC then stdenv . cc else { } ) . defaultHardeningFlags or
# fallback safe-ish set of flags
( remove " p i e " knownHardeningFlags ) ;
2021-08-22 07:53:02 +00:00
enabledHardeningOptions =
2023-03-15 16:39:30 +00:00
if builtins . elem " a l l " hardeningDisable'
2021-08-22 07:53:02 +00:00
then [ ]
2023-11-16 04:20:00 +00:00
else subtractLists hardeningDisable' ( defaultHardeningFlags ++ hardeningEnable ) ;
2021-08-22 07:53:02 +00:00
# hardeningDisable additionally supports "all".
2024-01-13 08:15:51 +00:00
erroneousHardeningFlags = subtractLists knownHardeningFlags ( hardeningEnable ++ remove " a l l " hardeningDisable ) ;
2022-05-18 14:49:53 +00:00
checkDependencyList = checkDependencyList' [ ] ;
2024-04-21 15:54:59 +00:00
checkDependencyList' = positions : name : deps :
imap1
( index : dep :
if isDerivation dep || dep == null || builtins . isString dep || builtins . isPath dep then dep
else if 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 : ${ concatMapStrings ( ix : " e l e m e n t ${ toString ix } o f " ) ( [ index ] ++ positions ) } ${ name } f o r ${ attrs . name or attrs . pname } " )
deps ;
2021-08-22 07:53:02 +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 { } {
2024-01-13 08:15:51 +00:00
inherit erroneousHardeningFlags hardeningDisable hardeningEnable knownHardeningFlags ;
2021-08-22 07:53:02 +00:00
} )
else let
doCheck = doCheck' ;
doInstallCheck = doInstallCheck' ;
2023-02-02 18:25:31 +00:00
buildInputs' = buildInputs
2023-11-16 04:20:00 +00:00
++ optionals doCheck checkInputs
++ optionals doInstallCheck installCheckInputs ;
2023-02-02 18:25:31 +00:00
nativeBuildInputs' = nativeBuildInputs
2023-11-16 04:20:00 +00:00
++ optional separateDebugInfo' ../../build-support/setup-hooks/separate-debug-info.sh
++ optional stdenv . hostPlatform . isWindows ../../build-support/setup-hooks/win-dll-link.sh
++ optionals doCheck nativeCheckInputs
++ optionals doInstallCheck nativeInstallCheckInputs ;
2021-08-22 07:53:02 +00:00
outputs = outputs' ;
2024-04-21 15:54:59 +00:00
dependencies = [
2021-08-22 07:53:02 +00:00
[
2024-04-21 15:54:59 +00:00
( map ( drv : getDev drv . __spliced . buildBuild or drv ) ( checkDependencyList " d e p s B u i l d B u i l d " depsBuildBuild ) )
( map ( drv : getDev drv . __spliced . buildHost or drv ) ( checkDependencyList " n a t i v e B u i l d I n p u t s " nativeBuildInputs' ) )
( map ( drv : getDev drv . __spliced . buildTarget or drv ) ( checkDependencyList " d e p s B u i l d T a r g e t " depsBuildTarget ) )
2021-08-22 07:53:02 +00:00
]
[
2024-04-21 15:54:59 +00:00
( map ( drv : getDev drv . __spliced . hostHost or drv ) ( checkDependencyList " d e p s H o s t H o s t " depsHostHost ) )
( map ( drv : getDev drv . __spliced . hostTarget or drv ) ( checkDependencyList " b u i l d I n p u t s " buildInputs' ) )
2021-08-22 07:53:02 +00:00
]
[
2024-04-21 15:54:59 +00:00
( map ( drv : getDev 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-22 07:53:02 +00:00
]
] ;
2024-04-21 15:54:59 +00:00
propagatedDependencies = [
2021-08-22 07:53:02 +00:00
[
2024-04-21 15:54:59 +00:00
( map ( drv : getDev 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 ) )
( map ( drv : getDev 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 ) )
( map ( drv : getDev 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-22 07:53:02 +00:00
]
[
2024-04-21 15:54:59 +00:00
( map ( drv : getDev 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 ) )
( map ( drv : getDev 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-22 07:53:02 +00:00
]
[
2024-04-21 15:54:59 +00:00
( map ( drv : getDev 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-22 07:53:02 +00:00
]
] ;
derivationArg =
2024-04-21 15:54:59 +00:00
removeAttrs attrs removedOrReplacedAttrNames
2023-11-16 04:20:00 +00:00
// ( optionalAttrs ( attrs ? name || ( attrs ? pname && attrs ? version ) ) {
2021-08-22 07:53:02 +00:00
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.
2023-11-16 04:20:00 +00:00
hostSuffix = optionalString
2021-08-22 07:53:02 +00:00
( stdenv . hostPlatform != stdenv . buildPlatform && ! dontAddHostSuffix )
" - ${ stdenv . hostPlatform . config } " ;
2023-04-29 16:46:19 +00:00
2021-08-22 07:53:02 +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.
2023-11-16 04:20:00 +00:00
staticMarker = optionalString stdenv . hostPlatform . isStatic " - s t a t i c " ;
2021-08-22 07:53:02 +00:00
in
2022-04-15 01:41:22 +00:00
lib . strings . sanitizeDerivationName (
2021-08-22 07:53:02 +00:00
if attrs ? name
then attrs . name + hostSuffix
2023-04-29 16:46:19 +00:00
else
# we cannot coerce null to a string below
2023-11-16 04:20:00 +00:00
assert 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 . " ;
2023-04-29 16:46:19 +00:00
" ${ attrs . pname } ${ staticMarker } ${ hostSuffix } - ${ attrs . version } "
2022-04-15 01:41:22 +00:00
) ;
2024-04-21 15:54:59 +00:00
} ) // {
2021-08-22 07:53:02 +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 ;
2023-01-20 10:41:00 +00:00
inherit __structuredAttrs strictDeps ;
2021-08-22 07:53:02 +00:00
2023-11-16 04:20:00 +00:00
depsBuildBuild = elemAt ( elemAt dependencies 0 ) 0 ;
nativeBuildInputs = elemAt ( elemAt dependencies 0 ) 1 ;
depsBuildTarget = elemAt ( elemAt dependencies 0 ) 2 ;
depsHostHost = elemAt ( elemAt dependencies 1 ) 0 ;
buildInputs = elemAt ( elemAt dependencies 1 ) 1 ;
depsTargetTarget = elemAt ( elemAt dependencies 2 ) 0 ;
2021-08-22 07:53:02 +00:00
2023-11-16 04:20:00 +00:00
depsBuildBuildPropagated = elemAt ( elemAt propagatedDependencies 0 ) 0 ;
propagatedNativeBuildInputs = elemAt ( elemAt propagatedDependencies 0 ) 1 ;
depsBuildTargetPropagated = elemAt ( elemAt propagatedDependencies 0 ) 2 ;
depsHostHostPropagated = elemAt ( elemAt propagatedDependencies 1 ) 0 ;
propagatedBuildInputs = elemAt ( elemAt propagatedDependencies 1 ) 1 ;
depsTargetTargetPropagated = elemAt ( elemAt propagatedDependencies 2 ) 0 ;
2021-08-22 07:53:02 +00:00
# This parameter is sometimes a string, sometimes null, and sometimes a list, yuck
2023-11-16 04:20:00 +00:00
configureFlags =
2023-07-15 17:15:38 +00:00
configureFlags
2021-08-22 07:53:02 +00:00
++ 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 } " ;
inherit patches ;
inherit doCheck doInstallCheck ;
inherit outputs ;
2023-11-16 04:20:00 +00:00
} // optionalAttrs ( __contentAddressed ) {
2021-08-22 07:53:02 +00:00
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 " ;
2023-11-16 04:20:00 +00:00
} // optionalAttrs ( enableParallelBuilding ) {
2023-01-20 10:41:00 +00:00
inherit enableParallelBuilding ;
2021-08-22 07:53:02 +00:00
enableParallelChecking = attrs . enableParallelChecking or true ;
2023-03-27 19:17:25 +00:00
enableParallelInstalling = attrs . enableParallelInstalling or true ;
2023-11-16 04:20:00 +00:00
} // optionalAttrs ( hardeningDisable != [ ] || hardeningEnable != [ ] || stdenv . hostPlatform . isMusl ) {
2021-08-22 07:53:02 +00:00
NIX_HARDENING_ENABLE = enabledHardeningOptions ;
2023-11-16 04:20:00 +00:00
} // optionalAttrs ( stdenv . hostPlatform . isx86_64 && stdenv . hostPlatform ? gcc . arch ) {
2021-08-22 07:53:02 +00:00
requiredSystemFeatures = attrs . requiredSystemFeatures or [ ] ++ [ " g c c a r c h - ${ stdenv . hostPlatform . gcc . arch } " ] ;
2024-04-21 15:54:59 +00:00
} // optionalAttrs ( stdenv . buildPlatform . isDarwin ) (
let
2024-05-15 15:35:15 +00:00
allDependencies = concatLists ( concatLists dependencies ) ;
allPropagatedDependencies = concatLists ( concatLists propagatedDependencies ) ;
2024-04-21 15:54:59 +00:00
computedSandboxProfile =
concatMap ( input : input . __propagatedSandboxProfile or [ ] )
( stdenv . extraNativeBuildInputs
++ stdenv . extraBuildInputs
2024-05-15 15:35:15 +00:00
++ allDependencies ) ;
2024-04-21 15:54:59 +00:00
computedPropagatedSandboxProfile =
concatMap ( input : input . __propagatedSandboxProfile or [ ] )
2024-05-15 15:35:15 +00:00
allPropagatedDependencies ;
2024-04-21 15:54:59 +00:00
computedImpureHostDeps =
unique ( concatMap ( input : input . __propagatedImpureHostDeps or [ ] )
( stdenv . extraNativeBuildInputs
++ stdenv . extraBuildInputs
2024-05-15 15:35:15 +00:00
++ allDependencies ) ) ;
2024-04-21 15:54:59 +00:00
computedPropagatedImpureHostDeps =
unique ( concatMap ( input : input . __propagatedImpureHostDeps or [ ] )
2024-05-15 15:35:15 +00:00
allPropagatedDependencies ) ;
2024-04-21 15:54:59 +00:00
in {
2021-08-22 07:53:02 +00:00
inherit __darwinAllowLocalNetworking ;
2023-11-16 04:20:00 +00:00
# TODO: remove `unique` once nix has a list canonicalization primitive
2021-08-22 07:53:02 +00:00
__sandboxProfile =
let profiles = [ stdenv . extraSandboxProfile ] ++ computedSandboxProfile ++ computedPropagatedSandboxProfile ++ [ propagatedSandboxProfile sandboxProfile ] ;
2023-11-16 04:20:00 +00:00
final = concatStringsSep " \n " ( filter ( x : x != " " ) ( unique profiles ) ) ;
2021-08-22 07:53:02 +00:00
in final ;
2023-11-16 04:20:00 +00:00
__propagatedSandboxProfile = unique ( computedPropagatedSandboxProfile ++ [ propagatedSandboxProfile ] ) ;
2021-08-22 07:53:02 +00:00
__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 "
] ;
__propagatedImpureHostDeps = computedPropagatedImpureHostDeps ++ __propagatedImpureHostDeps ;
2024-04-21 15:54:59 +00:00
} ) //
2023-02-16 17:41:37 +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
2023-11-16 04:20:00 +00:00
optionalAttrs ( attrs ? disallowedReferences ) {
2023-02-16 17:41:37 +00:00
disallowedReferences =
map unsafeDerivationToUntrackedOutpath attrs . disallowedReferences ;
} //
2023-11-16 04:20:00 +00:00
optionalAttrs ( attrs ? disallowedRequisites ) {
2023-02-16 17:41:37 +00:00
disallowedRequisites =
map unsafeDerivationToUntrackedOutpath attrs . disallowedRequisites ;
} //
2023-11-16 04:20:00 +00:00
optionalAttrs ( attrs ? allowedReferences ) {
2023-02-16 17:41:37 +00:00
allowedReferences =
2023-11-16 04:20:00 +00:00
mapNullable unsafeDerivationToUntrackedOutpath attrs . allowedReferences ;
2023-02-16 17:41:37 +00:00
} //
2023-11-16 04:20:00 +00:00
optionalAttrs ( attrs ? allowedRequisites ) {
2023-02-16 17:41:37 +00:00
allowedRequisites =
2023-11-16 04:20:00 +00:00
mapNullable unsafeDerivationToUntrackedOutpath attrs . allowedRequisites ;
2021-08-22 07:53:02 +00:00
} ;
2024-04-21 15:54:59 +00:00
in
derivationArg ;
mkDerivationSimple = overrideAttrs :
# `mkDerivation` wraps the builtin `derivation` function to
# produce derivations that use this stdenv and its shell.
#
# Internally, it delegates most of its behavior to `makeDerivationArgument`,
# except for the `env`, `cmakeFlags`, and `mesonFlags` attributes, as well
# as the attributes `meta` and `passthru` that affect [package attributes],
# and not the derivation itself.
#
# See also:
#
# * https://nixos.org/nixpkgs/manual/#sec-using-stdenv
# Details on how to use this mkDerivation function
#
# * https://nixos.org/manual/nix/stable/expressions/derivations.html#derivations
# Explanation about derivations in general
#
# * [package attributes]: https://nixos.org/manual/nix/stable/glossary#package-attribute-set
{
# Configure Phase
cmakeFlags ? [ ]
, mesonFlags ? [ ]
, 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 )
# Experimental. For simple packages mostly just works,
# but for anything complex, be prepared to debug if enabling.
, __structuredAttrs ? config . structuredAttrsByDefault or false
, env ? { }
, . . . } @ attrs :
# Policy on acceptable hash types in nixpkgs
assert attrs ? outputHash -> (
let algo =
attrs . outputHashAlgo or ( head ( splitString " - " attrs . outputHash ) ) ;
in
if algo == " m d 5 " then
throw " R e j e c t e d i n s e c u r e ${ algo } h a s h ' ${ attrs . outputHash } ' "
else
true
) ;
let
envIsExportable = isAttrs env && ! isDerivation env ;
derivationArg = makeDerivationArgument
( removeAttrs
attrs
( [ " m e t a " " p a s s t h r u " " p o s " ]
++ optional ( __structuredAttrs || envIsExportable ) " e n v "
)
// optionalAttrs __structuredAttrs { env = checkedEnv ; }
// {
cmakeFlags = makeCMakeFlags attrs ;
mesonFlags = makeMesonFlags attrs ;
} ) ;
meta = checkMeta . commonMeta {
inherit validity attrs pos ;
references = attrs . nativeBuildInputs or [ ] ++ attrs . buildInputs or [ ]
++ attrs . propagatedNativeBuildInputs or [ ] ++ attrs . propagatedBuildInputs or [ ] ;
} ;
2023-05-24 13:37:59 +00:00
validity = checkMeta . assertValidity { inherit meta attrs ; } ;
2021-08-22 07:53:02 +00:00
2023-01-20 10:41:00 +00:00
checkedEnv =
let
2023-11-16 04:20:00 +00:00
overlappingNames = attrNames ( builtins . intersectAttrs env derivationArg ) ;
2023-01-20 10:41:00 +00:00
in
2023-11-16 04:20:00 +00:00
assert assertMsg envIsExportable
2023-01-20 10:41:00 +00:00
" 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 . " ;
2023-11-16 04:20:00 +00:00
assert 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 : ${ concatStringsSep " , " overlappingNames } " ;
mapAttrs
( n : v : assert assertMsg ( isString v || isBool v || isInt v || isDerivation v )
2023-01-20 10:41:00 +00:00
" 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 )
env ;
2024-04-21 15:54:59 +00:00
# Fixed-output derivations may not reference other paths, which means that
# for a fixed-output derivation, the corresponding inputDerivation should
# *not* be fixed-output. To achieve this we simply delete the attributes that
# would make it fixed-output.
deleteFixedOutputRelatedAttrs = lib . flip builtins . removeAttrs [ " o u t p u t H a s h A l g o " " o u t p u t H a s h " " o u t p u t H a s h M o d e " ] ;
2021-08-22 07:53:02 +00:00
in
2023-11-16 04:20:00 +00:00
extendDerivation
2021-08-22 07:53:02 +00:00
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
2024-04-21 15:54:59 +00:00
inputDerivation = derivation ( deleteFixedOutputRelatedAttrs derivationArg // {
2021-08-22 07:53:02 +00:00
# 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)
2023-05-24 13:37:59 +00:00
args = [ " - c " ''
export > $ out
for var in $ passAsFile ; do
pathVar = " ' ' ${ var } P a t h "
printf " % s " " $ ( < " '' ${ ! pathVar } " ) " > > $o u t
done
'' ] ;
2023-02-16 17:41:37 +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.
2023-05-24 13:37:59 +00:00
allowedReferences = null ;
allowedRequisites = null ;
2023-02-16 17:41:37 +00:00
disallowedReferences = [ ] ;
disallowedRequisites = [ ] ;
2021-08-22 07:53:02 +00:00
} ) ;
2023-05-24 13:37:59 +00:00
inherit passthru overrideAttrs ;
inherit meta ;
2021-08-22 07:53:02 +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 )
2023-11-16 04:20:00 +00:00
( derivation ( derivationArg // optionalAttrs envIsExportable checkedEnv ) ) ;
2022-04-27 09:35:20 +00:00
2022-06-16 17:23:12 +00:00
in
2024-04-21 15:54:59 +00:00
{
inherit mkDerivation ;
}