Sort tests at compile time, not at startup #99939

saethlin · 2022-07-30T05:29:46Z

Recently, another Miri user was trying to run cargo miri test on the crate iced-x86 with --features=code_asm,mvex. This configuration has a startup time of ~18 minutes. That's ~18 minutes before any tests even start to run. The fact that this crate has over 26,000 tests and Miri is slow makes a lot of code which is otherwise a bit sloppy but fine into a huge runtime issue.

Sorting the tests when the test harness is created instead of at startup time knocks just under 4 minutes out of those ~18 minutes. I have ways to remove most of the rest of the startup time, but this change requires coordinating changes of both the compiler and libtest, so I'm sending it separately.

(except for doctests, because there is no compile-time harness)

rust-highfive · 2022-07-30T05:29:49Z

r? @fee1-dead

(rust-highfive has picked a reviewer for you, use r? to override)

rustbot · 2022-07-30T05:29:49Z

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

Stabilizing library features
Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
Changing public documentation in ways that create new stability guarantees
Changing observable runtime behavior of library APIs

compiler/rustc_builtin_macros/src/test_harness.rs

library/test/src/tests.rs

joshtriplett · 2022-07-30T22:37:02Z

LGTM, and good call. Any time we can move logic that runs unconditionally at startup to compile time, that's a win.

library/test/src/console.rs

compiler/rustc_builtin_macros/src/test.rs

Mark-Simulacrum · 2022-07-30T22:43:45Z

src/test/pretty/tests-are-sorted.pp

+// pretty-mode:expanded
+// pp-exact:tests-are-sorted.pp
+
+extern crate test;


Are we really generating a fresh extern crate test before every #[test]? That seems odd.

There is a lot around these changes which seems odd to me.

ehuss · 2022-07-30T23:06:00Z

This seems like it will affect all users of libtest, correct? compiletest is one example. I realize that libtest is far from a stable interface, but this could affect other projects.

saethlin · 2022-07-31T01:17:48Z

Yes, it is possible for other users of libtest to notice. Personally I feel we are well within our rights to change this, because the sorting is not documented anywhere that I can find and this is also behind an unstable feature.

But I do sympathize with users who have come to treat things under #![feature(test)] as de facto stable because the parts they use haven't changed for a long time. Is there some way we could notify maintainers?

Mark-Simulacrum · 2022-07-31T02:50:29Z

I think we should try to cover the easily known use cases (e.g., compiletest, compiletest-rs) with patches or PRs, since those affect CI & folks developing in tree immediately.

Beyond that, I think we can also consider whether keeping the sort at runtime is that costly - I think our default sort has "already sorted" detection, maybe that's fast enough to not worry here? It wouldn't be too hard to detect an unsorted input and print a warning (temporarily, we could remove that in ~4 weeks or something).

But I also don't feel we have to do this - I think so long as we fix compiletest{,-rs}, that's okay, and we can also open an issue and pin it so if folks come looking hopefully it's an easy thing to spot. Happy to pin something if you'd like to draft a short note.

saethlin · 2022-08-01T03:48:52Z

I think we should try to cover the easily known use cases (e.g., compiletest, compiletest-rs) with patches or PRs

I'm adding a commit for compiletest. compiletest-rs uses tester not the standard library component. tester claims to be a downstream fork of test. Perhaps it is worth letting them know about this situation in general but I think users of tester will not be automatically affected by this PR.

maybe that's fast enough to not worry here?

Unfortunately no. I did think of this initially, but it only brings us down from 4 minutes sorting the tests to 3 minutes. The slowness of Miri is in general super-linear; even if the already-sorted case is a fast path for Rust compiled with LLVM, it's entirely possible that the "fast path" is the slow part of the sorting algorithm under Miri. This is all wobbly and complicated, which is why I'm keen on this change to when we do the sort because it just removes the code path entirely.

fee1-dead · 2022-08-02T05:24:32Z

Can we do something with cfg(miri) and turn that part of the code off if miri is run and run a sorted check if it is not miri?

saethlin · 2022-08-02T22:39:52Z

We could. But I'm not sure that is a good idea, the whole point of Miri is to check for errors in code, so if we're running different code in Miri and outside of Miri, you could start to wonder what the point of the tool is. And new users are already sometimes suspicious of Miri's claims that their code is UB, I don't want to make understanding it any harder than it already is.

I'm willing to be convinced otherwise, but I think changing semantics of code with a #[cfg(miri)] is something we have deliberately avoided in the past.

fee1-dead · 2022-08-03T03:34:22Z

Reassigning this because I am not familiar with the code to approve.

r? rust-lang/compiler

Mark-Simulacrum · 2022-08-03T09:53:51Z

I think the next step here is probably to treat this as a change to an unstable libs API and file an ACP (https://std-dev-guide.rust-lang.org/feature-lifecycle/api-change-proposals.html), presuming that geta accepted I'd be comfortable moving ahead here with a pinned issue about this change.

michaelwoerister · 2022-08-03T12:37:28Z

@Mark-Simulacrum, do you want to take this?

saethlin · 2022-09-20T21:56:47Z

@rustbot label +I-libs-api-nominated

thomcc · 2022-10-04T15:10:55Z

From libs-api meeting: This is t-libs, because we don't intend to stabilize these APIs and only really have them as public so the compiler can use them.

@rustbot label -T-libs-api +T-libs

I can take the review after work.

r? @thomcc

saethlin · 2022-10-08T15:08:42Z

@rustbot label -I-libs-api-nominated

thomcc · 2022-10-08T18:25:01Z

Libs side looks fine to me, but it's mostly a compiler change. Can someone review those changes?

r? compiler

jackh726 · 2022-10-23T23:08:48Z

@bors r=thomcc,jackh726

bors · 2022-10-23T23:08:50Z

📌 Commit df6221a has been approved by thomcc,jackh726

It is now in the queue for this repository.

…ackh726 Sort tests at compile time, not at startup Recently, another Miri user was trying to run `cargo miri test` on the crate `iced-x86` with `--features=code_asm,mvex`. This configuration has a startup time of ~18 minutes. That's ~18 minutes before any tests even start to run. The fact that this crate has over 26,000 tests and Miri is slow makes a lot of code which is otherwise a bit sloppy but fine into a huge runtime issue. Sorting the tests when the test harness is created instead of at startup time knocks just under 4 minutes out of those ~18 minutes. I have ways to remove most of the rest of the startup time, but this change requires coordinating changes of both the compiler and libtest, so I'm sending it separately. (except for doctests, because there is no compile-time harness)

Rollup of 7 pull requests Successful merges: - rust-lang#99578 (Remove redundant lifetime bound from `impl Borrow for Cow`) - rust-lang#99939 (Sort tests at compile time, not at startup) - rust-lang#102271 (Stabilize `duration_checked_float`) - rust-lang#102766 (Don't link to `libresolv` in libstd on Darwin) - rust-lang#103277 (Update libstd's libc to 0.2.135 (to make `libstd` no longer pull in `libiconv.dylib` on Darwin)) - rust-lang#103437 (Sync rustc_codegen_cranelift) - rust-lang#103466 (Fix grammar in docs for std::io::Read) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

Do fewer passes and generally be more efficient when filtering tests Follow-on of the work I started with this PR: rust-lang#99939 Basically, the startup code for libtest is really inefficient, but that's not usually a problem because it is distributed in release and workloads are small. But under Miri which can be 100x slower than a debug build, these inefficiencies explode. Most of the diff here is making test filtering single-pass. There are a few other small optimizations as well, but they are more straightforward. With this PR, the startup time of the `iced` tests with `--features=code_asm,mvex` drops from 17 to 2 minutes (I think Miri has gotten slower under this workload since rust-lang#99939). The easiest way to try this out is to set `MIRI_LIB_SRC` to a checkout of this branch when running `cargo +nightly miri test --features=code_asm,mvex`. r? `@thomcc`

Do fewer passes and generally be more efficient when filtering tests Follow-on of the work I started with this PR: rust-lang/rust#99939 Basically, the startup code for libtest is really inefficient, but that's not usually a problem because it is distributed in release and workloads are small. But under Miri which can be 100x slower than a debug build, these inefficiencies explode. Most of the diff here is making test filtering single-pass. There are a few other small optimizations as well, but they are more straightforward. With this PR, the startup time of the `iced` tests with `--features=code_asm,mvex` drops from 17 to 2 minutes (I think Miri has gotten slower under this workload since #99939). The easiest way to try this out is to set `MIRI_LIB_SRC` to a checkout of this branch when running `cargo +nightly miri test --features=code_asm,mvex`. r? `@thomcc`

rust-highfive assigned fee1-dead Jul 30, 2022

rustbot added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jul 30, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 30, 2022

This comment has been minimized.

Sign in to view

saethlin force-pushed the pre-sort-tests branch from ad5c50d to 7b2029e Compare July 30, 2022 06:32

This comment has been minimized.

Sign in to view

klensy reviewed Jul 30, 2022

View reviewed changes

compiler/rustc_builtin_macros/src/test_harness.rs Outdated Show resolved Hide resolved

klensy reviewed Jul 30, 2022

View reviewed changes

compiler/rustc_builtin_macros/src/test_harness.rs Outdated Show resolved Hide resolved

saethlin force-pushed the pre-sort-tests branch from 7b2029e to ceeb616 Compare July 30, 2022 16:33

fee1-dead reviewed Jul 30, 2022

View reviewed changes

library/test/src/tests.rs Show resolved Hide resolved

saethlin force-pushed the pre-sort-tests branch from ceeb616 to 9b00a17 Compare July 30, 2022 19:48

Mark-Simulacrum reviewed Jul 30, 2022

View reviewed changes

rust-highfive assigned michaelwoerister and unassigned fee1-dead Aug 3, 2022

Mark-Simulacrum added the relnotes Marks issues that should be documented in the release notes of the next release. label Aug 3, 2022

Mark-Simulacrum assigned Mark-Simulacrum and unassigned michaelwoerister Aug 3, 2022

rustbot added the I-libs-api-nominated The issue / PR has been nominated for discussion during a libs-api team meeting. label Sep 20, 2022

rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Oct 4, 2022

rust-highfive assigned thomcc and unassigned Mark-Simulacrum Oct 4, 2022

rustbot removed the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label Oct 4, 2022

rustbot removed the I-libs-api-nominated The issue / PR has been nominated for discussion during a libs-api team meeting. label Oct 8, 2022

rust-highfive assigned jackh726 and unassigned thomcc Oct 8, 2022

thomcc added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 8, 2022

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 23, 2022

JohnTitor mentioned this pull request Oct 24, 2022

Rollup of 7 pull requests #103471

Merged

Dylan-DPC mentioned this pull request Oct 24, 2022

Rollup of 6 pull requests #103472

Closed

bors merged commit 779418d into rust-lang:master Oct 24, 2022

rustbot added this to the 1.66.0 milestone Oct 24, 2022

saethlin mentioned this pull request Oct 28, 2022

Do fewer passes and generally be more efficient when filtering tests #103689

Merged

saethlin deleted the pre-sort-tests branch March 15, 2023 00:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sort tests at compile time, not at startup #99939

Sort tests at compile time, not at startup #99939

saethlin commented Jul 30, 2022 •

edited

Loading

rust-highfive commented Jul 30, 2022

rustbot commented Jul 30, 2022

This comment has been minimized.

This comment has been minimized.

joshtriplett commented Jul 30, 2022

Mark-Simulacrum Jul 30, 2022

saethlin Jul 31, 2022

ehuss commented Jul 30, 2022

saethlin commented Jul 31, 2022

Mark-Simulacrum commented Jul 31, 2022

saethlin commented Aug 1, 2022

fee1-dead commented Aug 2, 2022

saethlin commented Aug 2, 2022

fee1-dead commented Aug 3, 2022

Mark-Simulacrum commented Aug 3, 2022

michaelwoerister commented Aug 3, 2022

saethlin commented Sep 20, 2022

thomcc commented Oct 4, 2022

saethlin commented Oct 8, 2022

thomcc commented Oct 8, 2022

jackh726 commented Oct 23, 2022

bors commented Oct 23, 2022

Sort tests at compile time, not at startup #99939

Sort tests at compile time, not at startup #99939

Conversation

saethlin commented Jul 30, 2022 • edited Loading

rust-highfive commented Jul 30, 2022

rustbot commented Jul 30, 2022

This comment has been minimized.

This comment has been minimized.

joshtriplett commented Jul 30, 2022

Mark-Simulacrum Jul 30, 2022

Choose a reason for hiding this comment

saethlin Jul 31, 2022

Choose a reason for hiding this comment

ehuss commented Jul 30, 2022

saethlin commented Jul 31, 2022

Mark-Simulacrum commented Jul 31, 2022

saethlin commented Aug 1, 2022

fee1-dead commented Aug 2, 2022

saethlin commented Aug 2, 2022

fee1-dead commented Aug 3, 2022

Mark-Simulacrum commented Aug 3, 2022

michaelwoerister commented Aug 3, 2022

saethlin commented Sep 20, 2022

thomcc commented Oct 4, 2022

saethlin commented Oct 8, 2022

thomcc commented Oct 8, 2022

jackh726 commented Oct 23, 2022

bors commented Oct 23, 2022

saethlin commented Jul 30, 2022 •

edited

Loading