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

Make create_def a side effect instead of marking the entire query as always red #115613

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

oli-obk
Copy link
Contributor

@oli-obk oli-obk commented Sep 6, 2023

Before this PR:

  • query A creates def id D
  • query A is marked as depending on the always-red node, meaning it will always get re-run
  • in the next run of rustc: query A is not loaded from the incremental cache, but rerun

After this PR:

  • query A creates def id D
  • query system registers this a side effect (just like we collect diagnostics to re-emit them without running a query)
  • in the next run of rustc: query A is loaded from the incremental cache and its side effect is run (thus re-creating def id D without running query A)

r? @cjgillot

TODO:

  • need to make feeding queries a side effect, too. At least ones that aren't written to disk.
  • need to re-feed the def_span query
  • many more tests

@rustbot rustbot added A-query-system Area: The rustc query system (https://rustc-dev-guide.rust-lang.org/query.html) A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Sep 6, 2023
@cjgillot
Copy link
Contributor

cjgillot commented Sep 6, 2023

Another tricky case:

  1. ensure() query A -> executes side-effect from the cache;
  2. fetch query A's result -> calls the provider for A -> gets to create_def -> ?

We wouldn't want to create 2 definitions where we only ask for one.

@oli-obk
Copy link
Contributor Author

oli-obk commented Sep 6, 2023

Huh... why does that happen? Shouldn't we already be getting weird diagnostics in that case?

@cjgillot
Copy link
Contributor

cjgillot commented Sep 6, 2023

This happens if we don't have the result of A in the on-disk cache, but still need it later.
IIUC, diagnostic deduplication catches it, so there is no observable effect.

@cjgillot
Copy link
Contributor

cjgillot commented Sep 6, 2023

More precisely: the first call is ensure(), so we don't attempt to compute the result, but still mark the dep-node as green and re-execute side effects. The second call is get(), so we need the result, we don't find it in the on-disk cache, and compute it the only way we know, by calling the provider function.

@cjgillot
Copy link
Contributor

cjgillot commented Sep 6, 2023

The logic is the fallback case in try_load_from_disk_and_cache_in_memory.

@oli-obk
Copy link
Contributor Author

oli-obk commented Sep 6, 2023

Thanks. I really need to dig into ensure and all its behaviours.

@oli-obk
Copy link
Contributor Author

oli-obk commented Sep 7, 2023

More precisely: the first call is ensure(), so we don't attempt to compute the result, but still mark the dep-node as green and re-execute side effects. The second call is get(), so we need the result, we don't find it in the on-disk cache, and compute it the only way we know, by calling the provider function.

I did some testing and a code dive, and I don't think that's what's happening.

ensure does not execute side effects. It checks if something is in the cache, and if not, executes that query immediately. The cache lookup itself doesn't perform any actions but set up the dep graph dependency in case of a cache hit.

@cjgillot
Copy link
Contributor

cjgillot commented Sep 7, 2023

ensure() calls get_query_incr with QueryMode::Ensure, which calls ensure_must_run, which calls try_mark_green, which calls try_mark_previous_green, which calls emit_side_effects.

@oli-obk
Copy link
Contributor Author

oli-obk commented Sep 7, 2023

yay, with this hint I was able to produce an example that actually exhibits an issue

index out of bounds: the len is 9 but the index is 9

oh wait... I even have this issue without doing any other changes to rustc. So it's not even ensure related yet

@cjgillot cjgillot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 9, 2023
@bors
Copy link
Contributor

bors commented Sep 22, 2023

☔ The latest upstream changes (presumably #115920) made this pull request unmergeable. Please resolve the merge conflicts.

@cjgillot
Copy link
Contributor

The difficulty is to know when to skip creating the DefId and reuse the one created by side-effect replay.

What about adding a new variant Replay to TaskDepsRef?
That variant would hold the list of definitions created by this query in the previous invocation. The nth call to create_def in the query would return the nth DefId in that list.

@oli-obk
Copy link
Contributor Author

oli-obk commented Sep 25, 2023

Thanks! I was thinking about doing

The nth call to create_def in the query would return the nth DefId in that list.

but didn't know how. I'll investigate the TaskDepsRef solution you hinted at.

@bors
Copy link
Contributor

bors commented Feb 16, 2024

☔ The latest upstream changes (presumably #120486) made this pull request unmergeable. Please resolve the merge conflicts.

@oli-obk oli-obk force-pushed the create_def_forever_red branch 2 times, most recently from 6d6b1eb to 6831868 Compare February 16, 2024 17:00
@oli-obk
Copy link
Contributor Author

oli-obk commented Feb 16, 2024

@cjgillot I implemented replaying, and that fixes the issues I was able to coax out of incremental tests, could you have a look? I'll keep working on it and adding more tests, but I think I could benefit from a review

@bors try @rust-timer queue

@rust-timer

This comment has been minimized.

@rustbot rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Feb 16, 2024
@rustbot rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Jun 5, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 5, 2024
Make create_def a side effect instead of marking the entire query as always red

Before this PR:

* query A creates def id D
* query A is marked as depending on the always-red node, meaning it will always get re-run
* in the next run of rustc: query A is not loaded from the incremental cache, but rerun

After this PR:

* query A creates def id D
* query system registers this a side effect (just like we collect diagnostics to re-emit them without running a query)
* in the next run of rustc: query A is loaded from the incremental cache and its side effect is run (thus re-creating def id D without running query A)

r? `@cjgillot`

TODO:

* [ ] need to make feeding queries a side effect, too. At least ones that aren't written to disk.
* [ ] need to re-feed the `def_span` query
* [ ] many more tests
@bors
Copy link
Contributor

bors commented Jun 5, 2024

⌛ Trying commit c490a96 with merge d30f6ef...

@rust-log-analyzer

This comment has been minimized.

@bors
Copy link
Contributor

bors commented Jun 5, 2024

💔 Test failed - checks-actions

@oli-obk
Copy link
Contributor Author

oli-obk commented Jun 5, 2024

@bors try @rust-timer queue

@rust-timer
Copy link
Collaborator

Awaiting bors try build completion.

@rustbot label: +S-waiting-on-perf

@bors
Copy link
Contributor

bors commented Jun 5, 2024

⌛ Trying commit c490a96 with merge 9b0899e...

bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 5, 2024
Make create_def a side effect instead of marking the entire query as always red

Before this PR:

* query A creates def id D
* query A is marked as depending on the always-red node, meaning it will always get re-run
* in the next run of rustc: query A is not loaded from the incremental cache, but rerun

After this PR:

* query A creates def id D
* query system registers this a side effect (just like we collect diagnostics to re-emit them without running a query)
* in the next run of rustc: query A is loaded from the incremental cache and its side effect is run (thus re-creating def id D without running query A)

r? `@cjgillot`

TODO:

* [ ] need to make feeding queries a side effect, too. At least ones that aren't written to disk.
* [ ] need to re-feed the `def_span` query
* [ ] many more tests
@rust-log-analyzer

This comment has been minimized.

@bors
Copy link
Contributor

bors commented Jun 5, 2024

💔 Test failed - checks-actions

fmease added a commit to fmease/rust that referenced this pull request Jun 6, 2024
Some minor query system cleanups

* Improves diagnostics on conflicting query flags
* removes unnecessary impls
* `track_caller`

pulled out of rust-lang#115613
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jun 6, 2024
Some minor query system cleanups

* Improves diagnostics on conflicting query flags
* removes unnecessary impls
* `track_caller`

pulled out of rust-lang#115613
workingjubilee added a commit to workingjubilee/rustc that referenced this pull request Jun 6, 2024
Some minor query system cleanups

* Improves diagnostics on conflicting query flags
* removes unnecessary impls
* `track_caller`

pulled out of rust-lang#115613
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jun 7, 2024
Rollup merge of rust-lang#126035 - oli-obk:query_macro_errors, r=fmease

Some minor query system cleanups

* Improves diagnostics on conflicting query flags
* removes unnecessary impls
* `track_caller`

pulled out of rust-lang#115613
@bors
Copy link
Contributor

bors commented Jun 7, 2024

☔ The latest upstream changes (presumably #126104) made this pull request unmergeable. Please resolve the merge conflicts.

@bors
Copy link
Contributor

bors commented Jun 7, 2024

☔ The latest upstream changes (presumably #125918) made this pull request unmergeable. Please resolve the merge conflicts.

let _ = tcx.eval_static_initializer(item_def_id);
}
});

Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this block necessary? The previous calls tcx.ensure().eval_static_initializer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just test code to replicate the bug I had initially, it should not land

Comment on lines 1382 to 1386
//
// This call also writes to the value of `source_span` and `expn_that_defined` queries.
// This is fine because:
// - those queries are `eval_always` so we won't miss their result changing;
// - this write will have happened before these queries are called.
Copy link
Contributor

Choose a reason for hiding this comment

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

Stale comment (pre-existing).

Comment on lines +1416 to +1428
TaskDepsRef::Replay { prev_side_effects, created_def_ids } => {
trace!(?created_def_ids, "replay side effects");
trace!("num_defs : {}", prev_side_effects.definitions.len());
let index = created_def_ids.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
let prev_info = &prev_side_effects.definitions[index];
let def_id = self.untracked.definitions.read().local_def_path_hash_to_def_id(
prev_info.hash,
&"should have already recreated def id in try_mark_green",
);
assert_eq!(prev_info.data, data);
assert_eq!(prev_info.parent, parent);
def_id
}
Copy link
Contributor

Choose a reason for hiding this comment

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

This logic is subtle, we should definitely document it somewhere. Here, or on DefIdInfo struct?

@bors
Copy link
Contributor

bors commented Jun 14, 2024

☔ The latest upstream changes (presumably #126439) made this pull request unmergeable. Please resolve the merge conflicts.

@cjgillot cjgillot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Jun 16, 2024
flip1995 pushed a commit to flip1995/rust-clippy that referenced this pull request Jun 28, 2024
Some minor query system cleanups

* Improves diagnostics on conflicting query flags
* removes unnecessary impls
* `track_caller`

pulled out of rust-lang/rust#115613
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-query-system Area: The rustc query system (https://rustc-dev-guide.rust-lang.org/query.html) A-testsuite Area: The testsuite used to check the correctness of rustc perf-regression Performance regression. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

6 participants