Re-organize build-dir by package + hash, rather than artifact type

[epage]

Implementation:

• feat(unstable): Added -Zbuild-dir-new-layout unstable feature #15848
• feat(build-dir): Reorganize build-dir layout #15947
• fix(layout): Remove hashes from bins in new layout  #16351

Documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#build-dir-new-layout

Resolves

• Shadowing binaries on Windows (Workspace binary artifacts are added to target/debug/deps on Windows #7919)
• Collisions between intermediate build artifacts (Output filename collision with dylib on windows release mode #8794)
• Inconsistent use of -Cextra-filename (Consider changing hashing behavior for executables. #8332)

Past efforts

• Unify build directories. #6668

Overview

• .fingerprint, deps/, build-script, and build-script-execution/ move under build/<pkgname>/<unit-id>
  • -L params to rustc were updated
  • cargo clean -p was updated
  • incremental/ is untouched
• -Cextra-filename is removed from all bins (fix(layout): Remove hashes from bins in new layout  #16351)

Known issues

• As a side effect, we pass a lot more parameters to rustc, likely making cargo -vv more annoying, similar to Reduce --verbose output of --check-cfg args #13941
• It also makes impossible to just copy paste commands into your shell if the limit is exceeded. See bjorn3's comment.
• This will break people relying on build-dir internals
  • See #t-cargo > build-dir tool compatibility @ 💬
• Increases the need for solutions for when people rely on build-dir internals
  • Access to compiler artifact notifications messages for custom --emit flags #13672
  • cargo ./target fills with outdated artifacts as toolchains are updated/changed #5026
  • Allow build scripts to stage final artifacts #13663
  • RFC: cargo-sbom rfcs#3553 (more precise determination of what is built than cargo metadata)
• cargo clean -p only cleans up files for the current layout rather than supporting both

Unresolved issues

Open questions

• Transition plan: while build-dir isn't stable, enough tools rely on the layout that we'd want to setup a transition plan so they can have time to test against the new layout and work to support both
• What do we call the directory? I said build/ as its all encompassing
  • #t-cargo > directory naming with new build layout @ 💬
• Can the old build/ and deps/ content live in the same place?
  • Seems to work
• How should we handle incremental/?
  • rustc loads incremental artifacts only for local crates. cross-crates is from rmeta. Therefore per-crate incremental artifacts should be fine.
  • Given incremental directory has its own flock mechanism, we don't need to add flock for that directory.
  • See #t-compiler > ✔ Cargo switching to one `-C incremental` directory per c...
• Under the new layout, should cargo clean -p also cleans old layout paths? See feat(build-dir): Reorganize build-dir layout #15947 (comment)
• Is the current handling of build scripts sufficient or should we explicitly split them into separate entries. We separated build script build and execution

Future extensions

• More granular locking in cargo_rustc #4282
• Per-user compiled artifact cache #5931
• cargo ./target fills with outdated artifacts as toolchains are updated/changed #5026

Deferred layout changes

• Can we remove -Cextra-filename completely as it is redundant with the build-unit's <name>/<hash>
  • It may not be possible to remove -Cextra-filename for rlibs. rustc relies on it. See feat(build-dir): Reorganize build-dir layout #15947 (comment)
• Can we remove <tuple> from the parent path?
  • In addition to reducing path length pressure on Windows, could allow sharing of host builds between platforms
  • Blocked on More granular locking in cargo_rustc #4282
• Can we remove <profile> from the parent path?
  • In addition to reducing path length pressure on Windows, could allow sharing when build units have the same settings across profiles
  • <hash> is the -C extra-filename hash and doesn't encompass all of fingerprinting, so we'd need to audit if there are cases that don't change the hash that we'd still need per-profile
  • Changing of local source is one example, so at least local packages still need to be scoped by profile
  • Blocked on More granular locking in cargo_rustc #4282
• Can we simplify how fingerprints are stored, reducing pressure on path lengths
• If Windows filesystem perf issues crop up with <pkgname>/<hash>, we can go with prefixes to reduce the number of items within a directory. See bjorn3's comment.
  • if deps/ hasn't been a problem, this is unlikely to be a problem

About tracking issues

Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.

---

Original

note: I specify build-dir to clarify which half of #14125 I'm referring to. The files and layout of build-dir does not have compatibility guarantees (source).

Currently, build-dir is laid out like

• target/
  • <target-platform>/?
    • <profile>/
      • incremental/
      • build/
        • <package>-<hash>/
          • build*script-*
      • deps/
        • <package>-<hash>*

Currently,

• cargo clean -p <package> will operate on everything for <package>

In the future, we could have

• GC will track and operate on everything for <package>-<hash> (cargo ./target fills with outdated artifacts as toolchains are updated/changed #5026)
• Change the locking so only overlapping <package>-<hash> that are being built block (More granular locking in cargo_rustc #4282)
• Centrally cache <package>-<hash> artifacts across all projects (Per-user compiled artifact cache #5931)
• Reduced overhead on systems that are slow when there are a lot of files within a directory (see also Adding tests has a high friction #15691)

These could be aided by re-arranging the build-dir to be organized around <package>-<hash>, like

• target/
  • <target-platform>/?
    • <profile>/
      • incremental/
      • build/
        • <package>-<hash>/
          • build*script-*
          • *.d

Side effects

• We'll have to change how we invoke rustc which will increase the length of the command-line
  • Currently, we blindly point rustc at deps/ and rustc finds the files it needs. We'll instead need to point to each individual artifact rustc may need.

[ranger-ross]

These could be aided by re-arranging the build-dir to be organized around <package>-<hash>, like

• target/
  • <target-platform>/?
    • <profile>/
      • incremental/
      • build/
        • <package>-<hash>/
          • build*script-*
          • *.d

I am assuming that final binary would still be located at target/<target-platform>/<profile>/<bin-name> (ie. target/debug/foo).
Is that correct?

Transition plan: while build-dir isn't stable, enough tools rely on the layout that we'd want to setup a transition plan so they can have time to test against the new layout and work to support both

I think we should check how many of the most popular tools rely on the layout. Depending the impact we can adjust how aggressive we want to be with the migration.

Regarding strategies, I have 2 ideas.

1. Simply write the files to the new and old layout directories. This of course with the additional overheads of doubling the disk writes, storage and the complexity of cleaning up multiple directories. But this provides the best backwards compatibility story.
2. Only write the files to the new layout and create symlinks in the previous layout. This would help mitigate the overhead of the disk writes/storage.

What do we call the directory? I said build/ as its all encompassing

I do not have a strong opinion on this. I was thinking perhaps packages or crates since its a list of the built packages. But I think build also makes sense here too 😄 Maybe build might be better to leave the door open for future possibilities of adding other artifacts to this directory?

[epage]

I am assuming that final binary would still be located at target/// (ie. target/debug/foo).
Is that correct?

This does not touch final artifacts. I'd recommend reading up on the following note

note: I specify build-dir to clarify which half of #14125 I'm referring to.

I think we should check how many of the most popular tools rely on the layout. Depending the impact we can adjust how aggressive we want to be with the migration.

I know there is at least

• https://crates.io/crates/cargo-cache
• https://crates.io/crates/cargo-sweep

There might be some other tools that do weirder stuff, like inspecting debug files or rlibs.

Regarding strategies, I have 2 ideas.

Writing to both or symlinks won't work for the above two tools.

A common approach we take is to have a feature be opt-in and then transition it to opt-out. A question in this is if we'd want to still support the old layout, for which we'd do this through a config, or if we'll only support the new layout, for which we use an env variable and after a sufficient time we remove the opt-out.

[ranger-ross]

Okay, I finally had some time to read up on #14125 some other related threads.

Would it would be better to focus on making progress on separating target-build-dir/target-artifact-dir out as proposed here before attempting re-organize the layout? Doing it all at once would lead to less fragmentation of "build layouts". But adding to the scope would be more work and make it harder to land #14125.

I am leaning towards doing this re-organization after separating the build/artifact dirs.

[epage]

I've wondered about doing the build-dir change first, like you said. It would make the scope of the change clear and it would help to communicate out what has compatibility guarantees.

[ranger-ross]

I did some investigating on this. I created a small (and incomplete) prototype on my fork (6a644ff) where the dep-info files are stored in target/<target-platform>/<profile>/build/<package>-<hash>.

One notable side effect of doing this is that rustc command starts to get very large for projects with many dependencies.
This is because as mentioned in the issue description we currently we only add target/<profile>/deps the library search path (-L) in the current implementation.
If we reorganize the deps dir we need to add each library to the rustc lib search path which makes the process command very large if you have many dependencies.

This does not seem like an immediate issue, but I am not sure if there limits on some operating systems that might limit the size of a process command. (I created a synthetic test on my Linux machine and was able to create a rustc process with a 60MB with no issues. I didn't both trying anything larger)

[epage]

This does not seem like an immediate issue, but I am not sure if there limits on some operating systems that might limit the size of a process command. (I created a synthetic test on my Linux machine and was able to create a rustc process with a 60MB with no issues. I didn't both trying anything larger)

Further down in the layers of calls to rustc, we automatically roll over from CLI args to an argfile.

Some potentially relevant questions

• How much more frequently are we using argfiles?
• What is the cost of switching to argfiles?
• What is the cost of making the argfiles bigger?

Unsure how much we need to answer this in depth.

[weihanglo]

On my Linux machine the limit is around 2.6MiB

$ getconf ARG_MAX
2621440

Looking at how the thresholds are calculated: https://github.com/rust-lang/rust/blob/d2eadb7a94ef8c9deb5137695df33cd1fc5aee92/compiler/rustc_codegen_ssa/src/back/command.rs#L145-L205. I feel like on Windows it is way easier to hit the limit.

What is the cost of switching to argfiles?

One failed rustc invocation + writing big argfiles + only allow UTF-8 encoding (IIRC).
The good news is that only the last few rustc calls would have such long command line arguments.