rustdoc: Stop textually replacing `Self` in doc links before resolving them #93805

petrochenkov · 2022-02-09T12:42:19Z

Resolve it directly to a type / def-id instead.

Also never pass Self to Resolver, it is useless because it's guaranteed that no resolution will be found.

This is a pre-requisite for #83761.

rust-highfive · 2022-02-09T12:42:22Z

r? @GuillaumeGomez

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

GuillaumeGomez · 2022-02-09T12:45:28Z

Looks good to me, thanks! Better have @camelid take a look too.

petrochenkov · 2022-02-09T17:07:15Z

r? @camelid

camelid · 2022-02-09T19:31:56Z

Thanks for doing this! I've been wanting to fix this hack for a while. I'll review this soon.

src/librustdoc/passes/collect_intra_doc_links.rs

src/test/rustdoc/intra-doc/associated-items.rs

…g them Resolve it directly to a type / def-id instead. Also never pass `Self` to `Resolver`, it is useless because it's guaranteed that no resolution will be found.

petrochenkov · 2022-02-13T15:13:15Z

@rustbot ready

camelid

Sorry this took so long. I only have one question; other than that, this looks great!

camelid · 2022-03-03T20:15:41Z

src/librustdoc/passes/collect_intra_doc_links.rs

@@ -343,6 +346,7 @@ impl ItemFragment {

 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 struct ResolutionInfo {
+    item_id: ItemId,
    module_id: DefId,


Just wondering, could we remove module_id now that we have item_id? Not necessary to address now, but I wanted to bring it up.

Not without replacing it with some extra data, I tried it but wasn't able to do it right away.

The first issue is that rustdoc (unlike rustc) resolves paths differently in inner and outer attributes.
So item_id will be the same for inner and outer paths, but their module_ids will be different.

There are also may be nuances with how item_id and module_id are assigned for reexports, but I didn't investigate it.

I agree that ideally we would have an item_id and some additional orthogonal flags here instead of the module_id.

src/librustdoc/passes/collect_intra_doc_links.rs

camelid

Thanks again!

camelid · 2022-03-06T01:10:45Z

@bors r=camelid,GuillaumeGomez

bors · 2022-03-06T01:10:46Z

📌 Commit 25c5e39 has been approved by camelid,GuillaumeGomez

camelid · 2022-03-06T18:22:01Z

Wow, that regression is way higher than I expected. I thought this PR might improve perf. I still think this change is worth the regression, but do you know what caused the regression? Maybe the extra item_id fields?

petrochenkov · 2022-03-09T14:09:12Z

I'll try to benchmark this, but not earlier than landing the last part of #83761.

pnkfelix · 2022-03-09T22:31:32Z

It looks to me like collect_intra_doc_links got 8.8% slower on serde doc. It took 0.137 s before this PR, and 0.149 s after this PR.

If I had to guess, I would assume the slowdown is due to the extra item_id field that was added to ResolutionInfo; the latter is used as a key in a hashtable in the LinkCollector. (maybe the size of ResolutionInfo passed some threshold that causes cache line problems? Just guessing at this point.)

Its funny that the slowdown only registered on serde doc though.

If you want to look further, @petrochenkov , then that would be great. But I don't think we need to spend too much time dissecting this, and I'm going to treat it as triaged.

@rustbot label: +perf-regression-triaged

camelid · 2022-03-10T19:17:49Z

ResolutionInfo did increase from 64 bytes to 80 bytes, so the cache line theory sounds quite plausible (e.g., since it's no longer a power of two).

This issue was most likely fixed by rust-lang#93805.

Add regression test for rust-lang#93205 Closes rust-lang#93205. This issue was most likely fixed by rust-lang#93805.

The report at rust-lang/rust#93205 was closed as it has presumably been fixed in rust-lang/rust#93805 which has long trickled down into stable releases, and I cannot reproduce the issue on `1.62.1` anymore (latest stable as of writing) 🎉 This workaround was originally added in #559.

…omez rustdoc: Cleanup parent module tracking for doc links Keep ids of the documented items themselves, not their parent modules. Parent modules can be retreived from those ids when necessary. Fixes rust-lang#108501. That issue could be fixed in a more local way, but this refactoring is something that I wanted to do since rust-lang#93805 anyway.

rustdoc: Cleanup parent module tracking for doc links Keep ids of the documented items themselves, not their parent modules. Parent modules can be retreived from those ids when necessary. Fixes rust-lang/rust#108501. That issue could be fixed in a more local way, but this refactoring is something that I wanted to do since rust-lang/rust#93805 anyway.

rust-highfive assigned GuillaumeGomez Feb 9, 2022

rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Feb 9, 2022

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

GuillaumeGomez approved these changes Feb 9, 2022

View reviewed changes

This comment has been minimized.

# to view

petrochenkov force-pushed the doclinkself branch from 29017ca to 07f3429 Compare February 9, 2022 17:06

rust-highfive assigned camelid and unassigned GuillaumeGomez Feb 9, 2022

camelid reviewed Feb 11, 2022

View reviewed changes

camelid 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 Feb 11, 2022

petrochenkov added 3 commits February 13, 2022 22:59

rustdoc: Consider enum variants when resolving assoc items in doc links

482b753

rustdoc: Stop textually replacing Self in doc links before resolvin…

863216e

…g them Resolve it directly to a type / def-id instead. Also never pass `Self` to `Resolver`, it is useless because it's guaranteed that no resolution will be found.

rustdoc: Clean up fn resolve_self_ty

25c5e39

petrochenkov force-pushed the doclinkself branch from 07f3429 to 25c5e39 Compare February 13, 2022 15:12

rustbot 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 Feb 13, 2022

camelid reviewed Mar 3, 2022

View reviewed changes

camelid 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 Mar 3, 2022

petrochenkov 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 Mar 4, 2022

camelid approved these changes Mar 6, 2022

View reviewed changes

rustbot added the perf-regression Performance regression. label Mar 6, 2022

rustbot added the perf-regression-triaged The performance regression has been triaged. label Mar 9, 2022

This was referenced Aug 9, 2022

Intradoc Self:: links are "not in scope" when used in impl blocks across modules #93205

Closed

Add regression test for #93205 #100348

Merged

camelid added a commit to camelid/rust that referenced this pull request Aug 10, 2022

Add regression test for rust-lang#93205

fcbdf08

This issue was most likely fixed by rust-lang#93805.

compiler-errors added a commit to compiler-errors/rust that referenced this pull request Aug 10, 2022

Rollup merge of rust-lang#100348 - camelid:test-93205, r=jyn514

a6116b9

Add regression test for rust-lang#93205 Closes rust-lang#93205. This issue was most likely fixed by rust-lang#93805.

MarijnS95 mentioned this pull request Aug 11, 2022

vk/prelude: Drop upstream-fixed Self:: doc workaround ash-rs/ash#648

Merged

petrochenkov mentioned this pull request Mar 18, 2023

rustdoc: Cleanup parent module tracking for doc links #109312

Merged

petrochenkov deleted the doclinkself branch February 22, 2025 18:30

rustdoc: Stop textually replacing Self in doc links before resolving them #93805

rustdoc: Stop textually replacing Self in doc links before resolving them #93805

Uh oh!

Conversation

petrochenkov commented Feb 9, 2022

Uh oh!

rust-highfive commented Feb 9, 2022

Uh oh!

GuillaumeGomez commented Feb 9, 2022

Uh oh!

This comment has been minimized.

petrochenkov commented Feb 9, 2022

Uh oh!

camelid commented Feb 9, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

petrochenkov commented Feb 13, 2022

Uh oh!

camelid left a comment

Choose a reason for hiding this comment

Uh oh!

camelid Mar 3, 2022

Choose a reason for hiding this comment

Uh oh!

petrochenkov Mar 4, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

camelid left a comment

Choose a reason for hiding this comment

Uh oh!

camelid commented Mar 6, 2022

Uh oh!

bors commented Mar 6, 2022

Uh oh!

camelid commented Mar 6, 2022

Uh oh!

petrochenkov commented Mar 9, 2022

Uh oh!

pnkfelix commented Mar 9, 2022

Uh oh!

camelid commented Mar 10, 2022

Uh oh!

Uh oh!

rustdoc: Stop textually replacing `Self` in doc links before resolving them #93805

rustdoc: Stop textually replacing `Self` in doc links before resolving them #93805