Refinement of Providers into Providers and ExternProviders #2469
+110
−32
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
the
S-waiting-on-review
Member
Author
|
first commit for |
Noratrieb
reviewed
Jun 16, 2025
xizheyin
commented
Jun 16, 2025
BoxyUwU
reviewed
Dec 11, 2025
BoxyUwU
added
S-waiting-on-author
This comment has been minimized.
This comment has been minimized.
Signed-off-by: xizheyin <xizheyin@smail.nju.edu.cn> Co-authored-by: Boxy <rust@boxyuwu.dev>
xizheyin
force-pushed
the
rustc-query
branch
from
0997ff5 to
72110fd
Compare
xizheyin
commented
Dec 12, 2025
| #### Adding a new provider | ||
|
|
||
| Suppose you want to add a new query called `fubar`. You would: | ||
| Suppose you want to add a new query called `fubar`. This section focuses on wiring up the providers; for how to declare the query itself in the big `rustc_queries!` macro, see [Adding a new query](#adding-a-new-query) below. |
Member
Author
There was a problem hiding this comment.
Here, I add some explanations to hint that how to add a query is put below.
Comment on lines
+180
to
+187
| 1. Decide which crate "owns" the query (for example `rustc_hir_analysis`, `rustc_mir_build`, or another `rustc_*` crate). | ||
| 2. In that crate, look for an existing `provide` function: | ||
| ```rust,ignore | ||
| pub fn provide(providers: &mut query::Providers) { | ||
| // existing assignments | ||
| } | ||
| ``` | ||
| If it exists, you will extend it to set the field for your new query. If the crate does not yet have a `provide` function, add one and make sure it is included in `DEFAULT_QUERY_PROVIDERS` in the `rustc_interface` crate so that it actually gets called during initialization (see the discussion above). |
Member
Author
There was a problem hiding this comment.
Some more deatils: if there is a existing..., else ...
Member
Author
|
@rustbot ready |
rustbot
added
S-waiting-on-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refined some vague concepts and pseudo-code in Query System
In the past, we only used vague concepts like local and extern to differentiate between different queries. however the code has more detailed
ProvidersandExternProvidersto differentiate between them, so we should mention both of them in the documentation as well.It is also important to indicate that
rustc_middle::util::Providersis made up ofProvidersandExternProvidersin the query mod.This PR also updates the example of registering a new Provider to consider
ExternProviders.r? @tshepang