stdenv: Fix overriding + `overrideAttrs` #134463

Ericson2314 · 2021-08-17T15:39:10Z

Motivation for this change

The old stdenv adapters were subtly wrong in two ways:

overrideAttrs leaked the original, unoverridden mkDerivation.
stdenv.override would throw away any manually-set mkDerivation
from a stdenv reverting to the original.

Now, mkDerivation is controlled (nearly directly) via an argument, and
always correctly closes over the final ("self") stdenv. This means the
adapters can work entirely via .override without any manual stdenv // ..., and both those issues are fixed.

Note hashes are changed, because stdenvs no previously overridden like
stdenvNoCC and crossLibcStdenv now are. I had to add some
dontDisableStatic = true accordingly. The flip side however is that
since the overrides compose, we no longer need to override anything but
the default stdenv from which all the others are created.

Things done

pkgs/stdenv/adapters.nix

pkgs/stdenv/generic/default.nix

pkgs/stdenv/generic/make-derivation.nix

Mindavi

I don't know much about the stdenv, but added some nits about typos :)

Edit: pamplemousse was faster

pkgs/stdenv/adapters.nix

Pamplemousse · 2021-08-17T18:44:25Z

pkgs/stdenv/adapters.nix

Just for reference, following a quick chat @Ericson2314 and I had:
For packages that unconditionally add --enable-shared in their configureFlags (for example: musl), this will effectively add both --enable-shared --disable-shared to the compilation command...

yes this regression has been there since the introduction of dontAddStaticConfigureFlags

I'm fixing a number of them in #133008

symphorien · 2021-08-18T12:34:04Z

This break musl somehow:

./tools/install.sh -D obj/ld.musl-clang /nix/store/v27r72r03h873j895qg9phq4j6175msq-musl-static-x86_64-unknown-linux-musl-1.2.2/bin/ld.musl-clang
Moving /nix/store/v27r72r03h873j895qg9phq4j6175msq-musl-static-x86_64-unknown-linux-musl-1.2.2/bin/musl-gcc to /nix/store/iphgzmq6c5fi5pr84lh9sbzmhz8aikwa-musl-static-x86_64-unknown-linux-musl-1.2.2-dev/bin/musl-gcc
rmdir: failed to remove '/nix/store/v27r72r03h873j895qg9phq4j6175msq-musl-static-x86_64-unknown-linux-musl-1.2.2/bin': Directory not empty
Moving /nix/store/v27r72r03h873j895qg9phq4j6175msq-musl-static-x86_64-unknown-linux-musl-1.2.2/bin/musl-clang to /nix/store/iphgzmq6c5fi5pr84lh9sbzmhz8aikwa-musl-static-x86_64-unknown-linux-musl-1.2.2-dev/bin/musl-clang
rmdir: failed to remove '/nix/store/v27r72r03h873j895qg9phq4j6175msq-musl-static-x86_64-unknown-linux-musl-1.2.2/bin': Directory not empty
Moving /nix/store/v27r72r03h873j895qg9phq4j6175msq-musl-static-x86_64-unknown-linux-musl-1.2.2/bin/ld.musl-clang to /nix/store/iphgzmq6c5fi5pr84lh9sbzmhz8aikwa-musl-static-x86_64-unknown-linux-musl-1.2.2-dev/bin/ld.musl-clang
rmdir: failed to remove '/nix/store/v27r72r03h873j895qg9phq4j6175msq-musl-static-x86_64-unknown-linux-musl-1.2.2/bin': Directory not empty
Moving /nix/store/v27r72r03h873j895qg9phq4j6175msq-musl-static-x86_64-unknown-linux-musl-1.2.2/lib/musl-gcc.specs to /nix/store/iphgzmq6c5fi5pr84lh9sbzmhz8aikwa-musl-static-x86_64-unknown-linux-musl-1.2.2-dev/lib/musl-gcc.specs
rmdir: failed to remove '/nix/store/v27r72r03h873j895qg9phq4j6175msq-musl-static-x86_64-unknown-linux-musl-1.2.2/lib': Directory not empty
/nix/store/ak7vllbyx80qz6ifhjvipxgai7axsay9-x86_64-unknown-linux-musl-binutils-2.35.1/bin/x86_64-unknown-linux-musl-ld:INSTALL: file format not recognized; treating as linker script
/nix/store/ak7vllbyx80qz6ifhjvipxgai7axsay9-x86_64-unknown-linux-musl-binutils-2.35.1/bin/x86_64-unknown-linux-musl-ld:INSTALL:2: syntax error
collect2: error: ld returned 1 exit status
builder for '/nix/store/zwppa911qs55y0pv3xs1iyn7rqfa1ydm-musl-static-x86_64-unknown-linux-musl-1.2.2.drv' failed with exit code 1

Pamplemousse · 2021-08-18T14:17:17Z

@symphorien I think pkgsStatic.musl was broken before that.
I tried fixing it yesterday, but there are many things seemingly going wrong in the postInstall script...

cc @dtzWill @thoughtpolice (maintainers of musl)

symphorien · 2021-08-18T14:29:15Z

well I rebased #133008 on this and got new failures due to that, so there must be a regression somewhere...

Pamplemousse · 2021-08-18T14:34:12Z

@symphorien When trying to locate the "regression", I checked out 20.03, and pkgsStatic.musl failed to build with similar errors...
So, unless I messed up my experiment, I would say the "regression" is not coming from this PR.

symphorien · 2021-08-18T15:52:45Z

On the parent commit of this pr, pkgsStatic.hello build, but not on this commit. The failure involves musl but maybe it's a red herring, since as you pointed out pkgsStatic.musl has not been building for a long time.

Pamplemousse · 2021-08-18T15:55:33Z

@symphorien My guess is that this PR has just made the failure of pkgsStatic.musl apparent (i.e. happen when building other pkgsStatic packages - as if musl was used before, and now pkgsStatic.musl is).

The old stdenv adapters were subtly wrong in two ways: - `overrideAttrs` leaked the original, unoverridden `mkDerivation`. - `stdenv.override` would throw away any manually-set `mkDerivation` from a stdenv reverting to the original. Now, `mkDerivation` is controlled (nearly directly) via an argument, and always correctly closes over the final ("self") stdenv. This means the adapters can work entirely via `.override` without any manual `stdenv // ...`, and both those issues are fixed. Note hashes are changed, because stdenvs no previously overridden like `stdenvNoCC` and `crossLibcStdenv` now are. I had to add some `dontDisableStatic = true` accordingly. The flip side however is that since the overrides compose, we no longer need to override anything but the default `stdenv` from which all the others are created.

We previously make it just be the function, not a single-item attrset, without deindenting to make a readable diff. No we deindent.

Ericson2314 · 2021-08-18T17:29:34Z

OK fixed the issue. The derivation to check is pkgsStatic.muslCross (which is separate for stupid reasons; hope to finally get rid of that with #132343). Comparing it with nix-diff we see that since stdenvNoCC and crossLibcStdenv now pick up the overrides from stdenv, which means that Musl no longer was building the dynamic linker, which meant that the on-the-fly compilation of iconv was failing.

No, I am not sure why we want the dynamic build of Musl, but I didn't want to make a big behavioral change like that, so I just added dontAddStaticConfigureFlags = true instead.

r-burns · 2021-08-19T01:48:33Z

I think this somehow removed pkgsStatic.stdenv.__bootPackages:

> nix-build . -A pkgsStatic.stdenv.__bootPackages 
error: attribute '__bootPackages' in selection path 'pkgsStatic.stdenv.__bootPackages' not found

r-burns · 2021-08-20T06:06:07Z

Oh, I think this is happening because __bootPackages and __hatPackages are added to each stdenv stage using //.

nixpkgs/pkgs/stdenv/booter.nix

Lines 92 to 96 in abeef13

    
           stdenv = args.stdenv // { 
        
             # For debugging 
        
             __bootPackages = prevStage; 
        
             __hatPackages = nextStage; 
        
           };

So if stdenv is overridden, these extra attributes are discarded.

Ericson2314 · 2021-08-20T06:21:05Z

Yup that's why. I feel like the cure might be worse than the disease. In any event, I hope we might finally get away from that and the way bootstrapping is done today once #132343 is done.

andir · 2021-08-23T11:03:47Z

This broke the keepDebugInfo adapter. I used to be able to build pkgs.keepDebugInfo (pkgs.nix.overrideAttrs (_: { })) but now that fails with:

called with unexpected argument 'mkDerivationFromStdenv', at lib/customisation.nix:79:63

Also seeing a case where the override attribute is now missing:

error: while evaluating 'g' at /home/andi/dev/nixos/nixpkgs/lib/attrsets.nix:298:19, called from undefined position:
while evaluating anonymous function at /home/andi/dev/nixos/nixpkgs/lib/modules.nix:140:72, called from /home/andi/dev/nixos/nixpkgs/lib/attrsets.nix:301:20:
while evaluating the attribute 'value' at /home/andi/dev/nixos/nixpkgs/lib/modules.nix:525:9:
while evaluating the option `nix.package':
while evaluating the attribute 'mergedValue' at /home/andi/dev/nixos/nixpkgs/lib/modules.nix:557:5:
while evaluating the attribute 'values' at /home/andi/dev/nixos/nixpkgs/lib/modules.nix:551:9:
while evaluating the attribute 'values' at /home/andi/dev/nixos/nixpkgs/lib/modules.nix:650:7:
while evaluating anonymous function at /home/andi/dev/nixos/nixpkgs/lib/modules.nix:537:28, called from /home/andi/dev/nixos/nixpkgs/lib/modules.nix:537:17:
while evaluating definitions from `/etc/nixos/common.nix':
while evaluating 'dischargeProperties' at /home/andi/dev/nixos/nixpkgs/lib/modules.nix:609:25, called from /home/andi/dev/nixos/nixpkgs/lib/modules.nix:538:137:
while evaluating the attribute 'value' at /home/andi/dev/nixos/nixpkgs/lib/modules.nix:392:44:
while evaluating 'enableDebugging' at /home/andi/dev/nixos/nixpkgs/pkgs/top-level/all-packages.nix:693:21, called from /etc/nixos/common.nix:35:15:
while evaluating anonymous function at /home/andi/dev/nixos/nixpkgs/lib/customisation.nix:77:32, called from /home/andi/dev/nixos/nixpkgs/pkgs/top-level/all-packages.nix:693:26:
while evaluating 'makeOverridable' at /home/andi/dev/nixos/nixpkgs/lib/customisation.nix:67:24, called from /home/andi/dev/nixos/nixpkgs/lib/customisation.nix:77:41:
while evaluating anonymous function at /home/andi/dev/nixos/nixpkgs/lib/customisation.nix:79:54, called from /home/andi/dev/nixos/nixpkgs/lib/customisation.nix:69:16:
while evaluating anonymous function at /home/andi/dev/nixos/nixpkgs/lib/customisation.nix:86:29, called from /home/andi/dev/nixos/nixpkgs/lib/customisation.nix:79:60:
while evaluating 'common' at /home/andi/dev/nixos/nixpkgs/pkgs/tools/package-management/nix/default.nix:12:3, called from /home/andi/dev/nixos/nixpkgs/lib/customisation.nix:79:63:
while evaluating 'keepDebugInfo' at /home/andi/dev/nixos/nixpkgs/pkgs/stdenv/adapters.nix:209:19, called from /home/andi/dev/nixos/nixpkgs/pkgs/top-level/all-packages.nix:693:50:
attribute 'override' missing, at /home/andi/dev/nixos/nixpkgs/pkgs/stdenv/adapters.nix:210:5

relevant nixos config:

    nix.package = pkgs.enableDebugging (pkgs.nix.overrideAttrs ({ patches, ... }: {
      patches = patches ++ [
        ./nix-segfault.patch
        ./nix-segfault-2.patch
        ./nix-remote-build.patch
        ./add-address-sanitizer.patch
      ];
      doInstallCheck = false;
      separateDebugInfo = false;
    }));

Maybe broken by NixOS/nixpkgs#134463

teto · 2021-08-25T09:06:38Z

I can confirm this ^ . Breaks enableDebugging too (since it calls keepDebugInfo).

Ericson2314 · 2021-08-25T21:47:23Z

I talked to @andir a bit in chat. keepDebugInfo was only meant to be used with stdenv. I suppose we can make another one at the top level for uses of mkDerivation (i.e. normal Nixpkgs derivations).

NixOS/nixpkgs#134463 made keepDebugInfo obsolete for generic packages. This copies what keepDebugInfo used to do.

trofi · 2021-09-05T08:09:16Z

Should enableDebugging still work? Comment says it should:

  # intended to be used like nix-build -E 'with import <nixpkgs> {}; enableDebugging fooPackage'
  enableDebugging = pkg: pkg.override { stdenv = stdenvAdapters.keepDebugInfo pkg.stdenv; };

Filed #136756

NixOS/nixpkgs#134463 made keepDebugInfo obsolete for generic packages. This copies what keepDebugInfo used to do.

roberth · 2021-09-09T08:48:07Z

We should seriously consider simplifying the problem away. #136903 (comment)
I have no confidence that we can use a redundant layer of overriding correctly.
tl;dr: we can remove the fixpoint we don't need by improving the one we do need, makingoverrideAttrs more powerful.

Ericson2314 · 2021-09-10T23:12:05Z

@bluescreen303 See #136756

NixOS/nixpkgs#134463 made keepDebugInfo obsolete for generic packages. This copies what keepDebugInfo used to do.

ghost · 2023-07-19T04:08:09Z

pkgs/stdenv/adapters.nix

-      });
-    };
+      }));
+    } // lib.optionalAttrs (stdenv0.hostPlatform.libc == "libc") {


@Ericson2314 did you mean "glibc" here instead of "libc"?

@picostove reports that changing it fixes #244232.

He did mean glibc #134923 (comment)

since that one had the typo, neither is doing anything.

Ericson2314 requested review from matthewbauer and nbp as code owners August 17, 2021 15:39

github-actions bot added the 6.topic: stdenv Standard environment label Aug 17, 2021

Ericson2314 mentioned this pull request Aug 17, 2021

Misc static improvements (mainly ocaml and a regression linked to b0b5ef7286dca098f40f5075175105c3c0dfbe05) #133008

Merged

Pamplemousse reviewed Aug 17, 2021

View reviewed changes

pkgs/stdenv/adapters.nix Outdated Show resolved Hide resolved

pkgs/stdenv/adapters.nix Outdated Show resolved Hide resolved

pkgs/stdenv/generic/default.nix Outdated Show resolved Hide resolved

pkgs/stdenv/generic/make-derivation.nix Outdated Show resolved Hide resolved

Mindavi reviewed Aug 17, 2021

View reviewed changes

Pamplemousse reviewed Aug 17, 2021

View reviewed changes

pkgs/stdenv/adapters.nix Outdated Show resolved Hide resolved

Pamplemousse reviewed Aug 17, 2021

View reviewed changes

Ericson2314 force-pushed the stdenv-adapter-latebind branch from 24da206 to 66df13b Compare August 18, 2021 17:21

Ericson2314 added 2 commits August 18, 2021 17:22

pkgs/stdenv/make-derivation: Reindent

b4cc2a2

We previously make it just be the function, not a single-item attrset, without deindenting to make a readable diff. No we deindent.

Ericson2314 force-pushed the stdenv-adapter-latebind branch from 66df13b to b4cc2a2 Compare August 18, 2021 17:22

ofborg bot requested review from dtzWill and thoughtpolice August 18, 2021 17:46

ofborg bot added 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 11-100 This PR causes between 11 and 100 packages to rebuild on Linux. labels Aug 18, 2021

Ericson2314 merged commit 221ca6f into NixOS:master Aug 18, 2021

Ericson2314 deleted the stdenv-adapter-latebind branch August 18, 2021 23:01

foldu added a commit to foldu/nixos-config that referenced this pull request Aug 24, 2021

Disable bt debugging

1447239

Maybe broken by NixOS/nixpkgs#134463

teto pushed a commit to teto/neovim that referenced this pull request Aug 29, 2021

chore(flake): fix for recent nixpkgs

bec341d

NixOS/nixpkgs#134463 made keepDebugInfo obsolete for generic packages. This copies what keepDebugInfo used to do.

teto mentioned this pull request Aug 29, 2021

chore(flake): fix for recent nixpkgs neovim/neovim#15520

Merged

teto pushed a commit to teto/neovim that referenced this pull request Aug 29, 2021

chore(flake): fix for recent nixpkgs

fb3c1a7

NixOS/nixpkgs#134463 made keepDebugInfo obsolete for generic packages. This copies what keepDebugInfo used to do.

teto added a commit to neovim/neovim that referenced this pull request Aug 30, 2021

chore(flake): fix for recent nixpkgs (#15520)

3ab73ff

NixOS/nixpkgs#134463 made keepDebugInfo obsolete for generic packages. This copies what keepDebugInfo used to do.

trofi mentioned this pull request Sep 5, 2021

enableDebugging does not work anymore: error: attribute 'override' missing #136756

Closed

r-burns mentioned this pull request Sep 5, 2021

stdenv: fix __bootPackages when overriding #136804

Closed

12 tasks

zhenyavinogradov mentioned this pull request Sep 6, 2021

Using overrideAttrs in an overlay duplicates build flags #136903

Open

muniter pushed a commit to muniter/neovim that referenced this pull request Sep 8, 2021

chore(flake): fix for recent nixpkgs (neovim#15520)

f28a4e1

NixOS/nixpkgs#134463 made keepDebugInfo obsolete for generic packages. This copies what keepDebugInfo used to do.

lewis6991 pushed a commit to lewis6991/neovim that referenced this pull request Dec 12, 2021

chore(flake): fix for recent nixpkgs (neovim#15520)

bf6a845

NixOS/nixpkgs#134463 made keepDebugInfo obsolete for generic packages. This copies what keepDebugInfo used to do.

ghost reviewed Jul 19, 2023

View reviewed changes

Uh oh!

stdenv: Fix overriding + overrideAttrs #134463

stdenv: Fix overriding + overrideAttrs #134463

Uh oh!

Conversation

Ericson2314 commented Aug 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation for this change

Things done

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mindavi left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pamplemousse Aug 17, 2021

Choose a reason for hiding this comment

Uh oh!

symphorien Aug 18, 2021

Choose a reason for hiding this comment

Uh oh!

symphorien Aug 18, 2021

Choose a reason for hiding this comment

Uh oh!

symphorien commented Aug 18, 2021

Uh oh!

Pamplemousse commented Aug 18, 2021

Uh oh!

symphorien commented Aug 18, 2021

Uh oh!

Pamplemousse commented Aug 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

symphorien commented Aug 18, 2021

Uh oh!

Pamplemousse commented Aug 18, 2021

Uh oh!

Ericson2314 commented Aug 18, 2021

Uh oh!

r-burns commented Aug 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

r-burns commented Aug 20, 2021

Uh oh!

Ericson2314 commented Aug 20, 2021

Uh oh!

andir commented Aug 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

teto commented Aug 25, 2021

Uh oh!

Ericson2314 commented Aug 25, 2021

Uh oh!

trofi commented Sep 5, 2021

Uh oh!

roberth commented Sep 9, 2021

Uh oh!

Ericson2314 commented Sep 10, 2021

Uh oh!

ghost Jul 19, 2023 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Artturin Jul 19, 2023

Choose a reason for hiding this comment

Uh oh!

Artturin Jul 19, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

stdenv: Fix overriding + `overrideAttrs` #134463

stdenv: Fix overriding + `overrideAttrs` #134463

Ericson2314 commented Aug 17, 2021 •

edited

Loading

Mindavi left a comment •

edited

Loading

Pamplemousse commented Aug 18, 2021 •

edited

Loading

r-burns commented Aug 19, 2021 •

edited

Loading

andir commented Aug 23, 2021 •

edited

Loading

ghost Jul 19, 2023 •

edited by ghost

Loading