Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lib.systems: introduce toolchain, cc, and bintools attributes #365057

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

RossComputerGuy
Copy link
Member

@RossComputerGuy RossComputerGuy commented Dec 13, 2024

Things done

Replaces useLLVM, useArocc, and useZig with toolchain, cc, linker, and bintools attributes. This might not produce any rebuilds but we'll see. This has the advantage of preventing using${compiler} flags from colliding and not working correctly if we were to stack multiple pkgs* together.

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: python 6.topic: rust 6.topic: windows Running, or buiding, packages on Windows 6.topic: stdenv Standard environment 6.topic: systemd 6.topic: lib The Nixpkgs function library 6.topic: llvm/clang Issues related to llvmPackages, clangStdenv and related labels Dec 13, 2024
@RossComputerGuy RossComputerGuy force-pushed the feat/toolchain-attrs branch 3 times, most recently from 7a3eca0 to 2a005fa Compare December 14, 2024 00:20
@RossComputerGuy RossComputerGuy force-pushed the feat/toolchain-attrs branch 2 times, most recently from 9c8b44b to f6da63d Compare December 14, 2024 00:41
@tomberek
Copy link
Contributor

The main idea and motivation is in: pkgs/stdenv/cross/default.nix

Copy link
Contributor

@philiptaron philiptaron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the direction this is going in -- if there's an enum, make it be an enum, not a set of booleans.

I'd appreciate a "next steps" portion of this PR, where you give some guidance on how and what's going to happen next, especially if there are breaking changes.

@RossComputerGuy
Copy link
Member Author

I'd appreciate a "next steps" portion of this PR

Next step is to add exports for LD or change exports for LD to the linker explicitly set. The idea is the bintools and linker can be less connected. From there, it'll probably be more explicit defining of the CC and other tools. Maybe a setup hook inside CC wrapper or other stuff could do it. Then I'll redo my CPU model PR and make some of that optimization stuff more flexible between different compilers.

where you give some guidance on how and what's going to happen next, especially if there are breaking changes.

Probably any other things we could look into doing that makes it easier to add an LLVM bootstrap to Linux.

@wegank wegank added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Dec 15, 2024
@pwaller
Copy link
Contributor

pwaller commented Dec 15, 2024

Hmm. I like the design. But I wonder about backwards compatibility. Will users suddenly experience this not working as expected in their existing expressions?

(orthogonal) Ideas:

  1. Support the old attributes, rewriting them as the new.
  2. Put assertions in that fire if the old attributes are in use.
  3. (alternatively, emit trace deprecation warnings)
  4. Catch the case where users supply something invalid. (Currently they can put anything in there, which can be confusing if there is a typo and things don't work as intended).

I don't know what level of support users should expect of these (existing) attributes, but I can say that I would probably find things quite confusing when this lands, had I not seen this PR.

@RossComputerGuy
Copy link
Member Author

Will users suddenly experience this not working as expected in their existing expressions?

Yeah, it'll just not work lol

  1. Support the old attributes, rewriting them as the new.

Tried as a warning or throw but it was causing stdenv to fail.

  1. Put assertions in that fire if the old attributes are in use.

This could work, I can easily add in asserts to the platform stuff to make that work.

  1. (alternatively, emit trace deprecation warnings)

Mentioned earlier, tried this. We'd see like 8 warning every time stdenv is used.

  1. Catch the case where users supply something invalid. (Currently they can put anything in there, which can be confusing if there is a typo and things don't work as intended).

This is likely the simplest and best solution. Add a few asserts which check to ensure nobody is passing the deprecated attributes.

@pwaller
Copy link
Contributor

pwaller commented Dec 15, 2024

It is possible to use clang with the GCC runtimes. Is a straightforward expression available here which would be of the form f stdenv where it would return true if compiler-rt was in use and false if gcc was in use? This question is independent of whether the llvm toolchain is in use, because you can use a clang compiler with the gcc standard libraries, and there are cases where it is useful to be able to detect this situation.

Today for instance clangStdenv.hostPlatform.useLLVM returns false; would the equivalent in the new world be clangStdenv.hostPlatform.toolchain == "gcc", and is that weird?

@RossComputerGuy
Copy link
Member Author

It is possible to use clang with the GCC runtimes.

Afaict, that's already possible and the default behavior on Linux.

@pwaller
Copy link
Contributor

pwaller commented Dec 15, 2024

Afaict, that's already possible and the default behavior on Linux.

I realise, but just trying to think through the meaning of these new values (and also the old ones such as useLLVM); and whether they are clear and expressive enough.

@RossComputerGuy
Copy link
Member Author

These new values are more fine grain, useLLVM already conveyed to use the LLVM toolchain. The compiler attribute only switches out the compiler being used. Linker only will change the linker and bintools changes the binary tools. However, toolchain is a more "global" control that changes all the options. This allows for more precise control over the platform's build environment.

Copy link
Member

@Ericson2314 Ericson2314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(just glanced, this is a conceptual review)

I knee this day would come :)

@wegank wegank removed the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Dec 16, 2024
@reckenrode
Copy link
Contributor

reckenrode commented Dec 16, 2024

Darwin’s toolchain is mostly LLVM. It uses clang. It uses most LLVM bintools except for a handful of things:

  • ld64. Other linkers aren’t yet drop-in replacements. It could be changed to ld-prime if the source is ever released (which I doubt it will be) or another linker if it improves enough. The linker value is currently cctools, but that’s not really right. cctools has a linker, but it’s not built. I believe it’s ld64’s predecessor.
  • lipo and install_name_tool. LLVM has replacements, but they crash (llvm-lipo crashes in Meson’s test suite) or are missing features (llvm-install-name-tool does not support LC_REEXPORT_DYLIB).
  • llvm-ranlib is not a drop-in replacement for ranlib from cctools, though this could probably be patched around.
  • gperf is included just because, though it’s probably not needed in darwin.binutils. codesign_allocate can probably be dropped. Those who need it can get it from cctools directly.

How would Darwin be represented in this taxonomy? toolchain = apple, cc = clang, bintools = llvm, linker = ld64?

@RossComputerGuy
Copy link
Member Author

How would Darwin be represented in this taxonomy? ``

Darwin is an odd one

toolchain = apple, cc = clang, bintools = llvm, linker = ld64

That is close, the linker defaults to cctools. I don't think we'd support changing these options much outside of Linux. It's just simpler enough to support as is outside of Linux.

@reckenrode
Copy link
Contributor

That is close, the linker defaults to cctools. I don't think we'd support changing these options much outside of Linux. It's just simpler enough to support as is outside of Linux.

It’s currently cctools, but I’m suggesting it ought to be ld64 since that’s the actual linker being used. Given that there are other linkers available for Darwin (such as lld and emerald), it would be nice if changing the linker also worked for Darwin. (I assume changing cc to gcc is also expected to work? Is that potentially an alternative to using gccStdenv?)

@reckenrode
Copy link
Contributor

I’ll add that addressing Darwin support beyond the default doesn’t have to be part of this PR, but I would like to see what such support would like so it can be addressed separately.

@RossComputerGuy
Copy link
Member Author

It’s currently cctools, but I’m suggesting it ought to be ld64 since that’s the actual linker being used.

Oh gotcha

Given that there are other linkers available for Darwin (such as lld and emerald), it would be nice if changing the linker also worked for Darwin

Yeah, I can make that happen once I start making the linker attribute work separately from bintools in my follow up PR.

I assume changing cc to gcc is also expected to work?

It should, I'm not sure whether it actually does work as intended.

Is that potentially an alternative to using gccStdenv?

It can be, it applies through everything using stdenv rather than an explicit stdenv.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: lib The Nixpkgs function library 6.topic: llvm/clang Issues related to llvmPackages, clangStdenv and related 6.topic: python 6.topic: rust 6.topic: stdenv Standard environment 6.topic: systemd 6.topic: windows Running, or buiding, packages on Windows 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants