add note for `layout_of` when query depth overflows #101801

SparrowLii · 2022-09-14T12:48:58Z

Fixes #101747
Added try_find_layout_root function to add a note for layout_of when query depth overflows. This would make the error in #101747 look like this:

error: queries overflow the depth limit!
   |
note: Query depth increased by 66 when computing layout of `core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<alloc::boxed::Box<alloc::string::String>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>`!
  --> D:\rust-backup\parallel_rust\query_depth.rs:40:1
   |
40 | fn main() {
   | ^^^^^^^^^

error: aborting due to previous error

cc @semicoleon

rust-highfive · 2022-09-14T12:49:04Z

r? @cjgillot

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

rustbot · 2022-09-14T12:49:07Z

rustc_error_messages was changed

cc @davidtwco, @compiler-errors, @JohnTitor, @estebank, @TaKO8Ki

estebank

Can we add a test somewhere in src/test/ui for this case?

Also, it'd be amazing if we could get a better span, but this is already an improvement.

estebank · 2022-09-14T14:13:32Z

compiler/rustc_error_messages/locales/en-US/query_system.ftl

@@ -23,3 +23,5 @@ query_system_cycle_recursive_trait_alias = trait aliases cannot be recursive
 query_system_cycle_which_requires = ...which requires {$desc}...

 query_system_query_overflow = queries overflow the depth limit!
+
+query_system_layout_of_depth = Query depth increased by {$depth} when {$desc}!


Suggested change

query_system_layout_of_depth = Query depth increased by {$depth} when {$desc}!

query_system_layout_of_depth = query depth increased by {$depth} when {$desc}

It is somewhat problematic for the future to include $desc in a message, because the output might be set up for another language, which will result in embedded english text.

estebank · 2022-09-14T14:18:50Z

compiler/rustc_query_system/src/error.rs

+#[note(query_system::layout_of_depth)]
+pub struct LayoutOfDepth {
+    #[primary_span]
+    pub span: Span,


It feels like ideally this span would be part of the main message, not of the note. I'm not sure if derive(SessionDiagnostic) knows how to deal with Option<Span>, but if it doesn't, you can get away with using DUMMY_SP for the "default"/"empty" case.

We support Option<Span> :)

That makes sense!

semicoleon · 2022-09-14T16:38:45Z

Do we want the diagnostic to mention recursion_limit as the way to increase the query depth limit? If not we should make sure that's documented somewhere discoverable. Right now searching online for "rust query depth limit" doesn't seem to find anything actionable for me.

SparrowLii · 2022-09-15T07:56:15Z

Corrected the order of span. We can't get a better span now, I think this needs to optimize the span location acquisition of query calls. Currently only the layout_of query has a depth limit, but other queries may be involved in the future. I think we just added a help for increasing recursion_limit. Thanks for reviewing!

…lows

estebank · 2022-09-15T09:37:09Z

@bors r+

bors · 2022-09-15T09:37:10Z

📌 Commit 89fd6ae has been approved by estebank

It is now in the queue for this repository.

…ebank add note for `layout_of` when query depth overflows Fixes rust-lang#101747 Added `try_find_layout_root` function to add a note for `layout_of` when query depth overflows. This would make the error in rust-lang#101747 look like this: ``` error: queries overflow the depth limit! | note: Query depth increased by 66 when computing layout of `core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<core::option::Option<alloc::boxed::Box<alloc::string::String>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>`! --> D:\rust-backup\parallel_rust\query_depth.rs:40:1 | 40 | fn main() { | ^^^^^^^^^ error: aborting due to previous error ``` cc `@semicoleon`

…iaskrgr Rollup of 9 pull requests Successful merges: - rust-lang#101672 (array docs - advertise how to get array from slice) - rust-lang#101781 (Extend list of targets that support dyanmic linking for llvm tools) - rust-lang#101783 (Improve handing of env vars during bootstrap process) - rust-lang#101801 (add note for `layout_of` when query depth overflows) - rust-lang#101824 (rustdoc: add test cases for turning ``[Vec<T>]`` into ``[`Vec<T>`]``) - rust-lang#101861 (Update stdarch) - rust-lang#101873 (Allow building `rust-analyzer-proc-macro-srv` as a standalone tool) - rust-lang#101918 (rustdoc: clean up CSS for All Items and All Crates lists) - rust-lang#101934 (Continue migration of CSS themes) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rust-highfive assigned cjgillot Sep 14, 2022

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

This comment has been minimized.

Sign in to view

SparrowLii force-pushed the query_depth_note branch from 0ccdbf0 to 5b890f4 Compare September 14, 2022 13:00

estebank reviewed Sep 14, 2022

View reviewed changes

SparrowLii added 2 commits September 15, 2022 16:05

add note for layout_of when query depth overflows

44506f3

correct span, add help message and add UI test when query depth overf…

89fd6ae

…lows

SparrowLii force-pushed the query_depth_note branch from 0293cb7 to 89fd6ae Compare September 15, 2022 08:07

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 Sep 15, 2022

matthiaskrgr mentioned this pull request Sep 17, 2022

Rollup of 8 pull requests #101941

Closed

This was referenced Sep 17, 2022

Rollup of 1 pull requests #101945

Closed

Rollup of 9 pull requests #101946

Merged

bors merged commit 4757d2d into rust-lang:master Sep 17, 2022

rustbot added this to the 1.65.0 milestone Sep 17, 2022

cuviper modified the milestones: 1.65.0, 1.66.0 Oct 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add note for `layout_of` when query depth overflows #101801

add note for `layout_of` when query depth overflows #101801

SparrowLii commented Sep 14, 2022

rust-highfive commented Sep 14, 2022

rustbot commented Sep 14, 2022

This comment has been minimized.

estebank left a comment

estebank Sep 14, 2022

estebank Sep 14, 2022

davidtwco Sep 14, 2022

SparrowLii Sep 15, 2022

semicoleon commented Sep 14, 2022

SparrowLii commented Sep 15, 2022 •

edited

Loading

estebank commented Sep 15, 2022

bors commented Sep 15, 2022

	query_system_layout_of_depth = Query depth increased by {$depth} when {$desc}!
	query_system_layout_of_depth = query depth increased by {$depth} when {$desc}

add note for layout_of when query depth overflows #101801

add note for layout_of when query depth overflows #101801

Conversation

SparrowLii commented Sep 14, 2022

rust-highfive commented Sep 14, 2022

rustbot commented Sep 14, 2022

This comment has been minimized.

estebank left a comment

Choose a reason for hiding this comment

estebank Sep 14, 2022

Choose a reason for hiding this comment

estebank Sep 14, 2022

Choose a reason for hiding this comment

davidtwco Sep 14, 2022

Choose a reason for hiding this comment

SparrowLii Sep 15, 2022

Choose a reason for hiding this comment

semicoleon commented Sep 14, 2022

SparrowLii commented Sep 15, 2022 • edited Loading

estebank commented Sep 15, 2022

bors commented Sep 15, 2022

add note for `layout_of` when query depth overflows #101801

add note for `layout_of` when query depth overflows #101801

SparrowLii commented Sep 15, 2022 •

edited

Loading