Elaborate on dataflow outputs for region constraints #1969

amandasystems · 2024-04-30T10:04:30Z

No description provided.

…hapter Splitting the two was confusing and meant that similar information was in wildly different parts of the guide. Combine them into a single page.

mostly this just suggests using a tracking issue instead of inlining the info from the issue template

I'm going to make a follow-up PR shortly linking from rust-lang/rust to the dev guide so this info isn't duplicated.

Co-authored-by: Yuki Okushi <[email protected]>

…ust-lang#1949)

rust-lang#1960) * compiletest: specify which special env var and which particular CI job * compiletest: fix grammar and add link to Dockerfile

Signed-off-by: needsure <[email protected]>

The `-Z verbose` option has been renamed to `-Z verbose-internals` in commit b5d83619 [1] (PR #119129 [2]). This commit updates the remaining `-Z verbose` to `-Z verbose-internals`. [1]: rust-lang/rust@b5d8361 [2]: rust-lang/rust#119129

Add a hint about unflatten and an internal link to MIR outlives graphs to advertise them better.

amandasystems · 2024-04-30T10:05:46Z

I see Zed snuck in some Markdown normalisation too while it was at it. Sorry about that, let me know if that's inexcusable and I will revert those changes.

lqd · 2024-05-01T15:16:23Z

I will revert those changes

Please do yes, if it's not too hard. It will make review easier.

I'll take a closer look when I have more time, but I noted a couple of things:

"With -Z dump-mir-graphviz=yes, you will also get Graphviz files for the outlives constraints" is that the case? Did you maybe mean -Zdump-mir=nll?
I don't think these visualizations are from MIR dataflow, so the new paragraph may need to be moved to somewhere more related to borrowck

amandasystems · 2024-05-02T09:03:51Z

Please do yes, if it's not too hard. It will make review easier.

Done!

"With -Z dump-mir-graphviz=yes, you will also get Graphviz files for the outlives constraints" is that the case? Did you maybe mean -Zdump-mir=nll?

Huh! Apparently, -Z dump-mir=fn is enough to get those. I assumed it wouldn't drop graphviz files without the Graphviz option, but apparently it does! dump-mir=nll also works and now I'm worried it will dump different graphs.

I don't think these visualizations are from MIR dataflow, so the new paragraph may need to be moved to somewhere more related to borrowck

That's probably true; this should be in the borrowck chapter, maybe? Do you have a suggestion off the top of your head or should I go digging?

lqd · 2024-05-02T20:55:40Z

Not from the top of my head but I will look for one -- but yeah I agree this should be in the borrowck chapter most likely.

lqd

(Sorry for taking so long to get back to this.)

So since these are not dataflow outputs, I agree we should add it to the borrow_check chapter.

To do so, I think we should add a dedicated borrow_check/debugging.md page, and have the "Region constraint graphs and their SCCs" section there. We would mention that these come from -Zdump-mir=nll -- and that will give us the occasion to also describe the NLL dumps there in the future.

We can link to that page from the bottom of src/borrow_check.md instead of src/compiler-debugging.md (but we can leave the unflatten paragraph there, it's a good addition next to the graphviz section).

src/mir/dataflow.md

src/compiler-debugging.md

Co-authored-by: Rémy Rakic <[email protected]>

lqd · 2024-08-01T12:49:12Z

src/borrow_check/debugging.md

+
+## See also
+
+The [general instructions on debugging dataflow]() also apply to graphs generated from


Suggested change

The [general instructions on debugging dataflow]() also apply to graphs generated from

The [general instructions on debugging dataflow](../mir/dataflow.md) also apply to graphs generated from

lqd · 2024-08-01T12:49:27Z

src/borrow_check/debugging.md

+![A graph showing a small number of strongly connected components on the region-outlives-graph above](../img/scc-graphviz.png)
+
+**Note:** There are implicit edges from `'static` to every region, but those are not rendered
+in the region graph to avoid clutter. They _do_ however show up in the SCC graph. This is why there are outgoing edges from `SCC(5)` in the SCC graph that do not seem to have corresponding edges in the region outlives graph above.


This line will need to be wrapped as well.

lqd · 2024-08-01T12:51:07Z

src/compiler-debugging.md

+This is particularly useful for complicated region outlives graphs from
+[MIR Dataflow](mir/dataflow.md).


Suggested change

This is particularly useful for complicated region outlives graphs from

[MIR Dataflow](mir/dataflow.md).

This is particularly useful for complicated region outlives graphs from

[the borrow checker](borrow_check/debugging.md).

jieyouxu · 2024-11-02T19:49:42Z

@lqd btw, you can also edit @amandasystems's branch directly for trivial things like fixing links. We can also try to get this merged so it doesn't drown from merge conflicts. And it's perfectly fine if it still has inaccuracies/omissions, we can always follow-up, it's just docs after all!

Kobzol · 2025-01-05T17:27:08Z

Sorry, due to me messing up a git operation, we sadly had to force-push the whole commit history of rustc-dev-guide :( If you'd like to update this pull request, you will have to rebase it in a special way onto the new commit history (the new master):

git fetch origin --all
git checkout <pr-branch>
git rebase --onto origin/master origin/master-old
git push --force-with-lease

More context can be found here.

Ddystopia and others added 30 commits June 26, 2023 18:34

fix_typo

17fe3e9

Define more lint terms

f8e4d5c

fix link

7fa8c55

Fix some links

dda77e0

Reword messages.ftl example.

2cbc4c1

Move "Adding a new feature gate" to the "Implementing new features" c…

dd45ecf

…hapter Splitting the two was confusing and meant that similar information was in wildly different parts of the guide. Combine them into a single page.

distinguish language and library processes more consistently

8ff4abb

move the Breaking Changes section later in the guide

5a6171c

fix broken link

855a295

cleanup the "tracking issue" section

c01a1fa

mostly this just suggests using a tracking issue instead of inlining the info from the issue template

Inline alternate x.py invocations from the rust-lang/rust readme

1690634

I'm going to make a follow-up PR shortly linking from rust-lang/rust to the dev guide so this info isn't duplicated.

Improve Windows docs

c8213e1

include rustc-dev-guide's own issues in suggested search

7267158

Change ./x.py into ./x

d3034ae

Change x.py into x, add explanation for x

50dbcba

Fix line length out of limit

37ffa30

typo

8648005

Try to avoid confusion

07f16bb

OwningRef exists no more

605c35a

typo

07c92b8

update link

49b868e

fix link

68967d7

replace dead link (rust-lang#1717)

a0f596f

tests/run-make files have moved

e592090

document .x test --rustc-args option

95ce237

ty::ConstKind has moved (rust-lang#1724)

0658909

various fixes/improvements to Contributing chapter (rust-lang#1723)

6d5b3db

improve explanation of placing tests in separate file (rust-lang#1721)

b10654a

Co-authored-by: Yuki Okushi <[email protected]>

Fix a bug in getting-started.md (rust-lang#1726)

c7d6710

fix: update link to function coverage (rust-lang#1727)

b5a12d9

notriddle and others added 10 commits April 6, 2024 22:17

Add docs for sharded descriptions

55f79b5

Explicitly mention compiletest directives are supported in rmake.rs (r…

b77a34b

…ust-lang#1949)

compiletest: specify which special env var and which particular CI job (

61c1e83

rust-lang#1960) * compiletest: specify which special env var and which particular CI job * compiletest: fix grammar and add link to Dockerfile

chore: fix some typos in conments

9fbba97

Signed-off-by: needsure <[email protected]>

compiletest: clarify that headers must be one header per line

f703523

Add a note about checks with multiple revisions (rust-lang#1963)

07425fe

typo traige->triage

e5c5fc3

Rename -Z verbose to -Z verbose-internals

4c97ad5

The `-Z verbose` option has been renamed to `-Z verbose-internals` in commit b5d83619 [1] (PR #119129 [2]). This commit updates the remaining `-Z verbose` to `-Z verbose-internals`. [1]: rust-lang/rust@b5d8361 [2]: rust-lang/rust#119129

Update compiler-debugging.md

37d8612

Add a hint about unflatten and an internal link to MIR outlives graphs to advertise them better.

Update dataflow.md to mention region graphs

b08f051

Add images of graphs

2c521d5

amandasystems force-pushed the master branch from 1dcef2a to 2c521d5 Compare May 2, 2024 08:54

camelid assigned lqd May 25, 2024

lqd reviewed Jul 31, 2024

View reviewed changes

src/mir/dataflow.md Outdated Show resolved Hide resolved

src/mir/dataflow.md Outdated Show resolved Hide resolved

src/mir/dataflow.md Outdated Show resolved Hide resolved

src/compiler-debugging.md Outdated Show resolved Hide resolved

amandasystems and others added 3 commits August 1, 2024 13:38

Accept @lqd's nit about SCC edges

dc63e54

Co-authored-by: Rémy Rakic <[email protected]>

Update src/mir/dataflow.md

782c7f3

Co-authored-by: Rémy Rakic <[email protected]>

Move Borrow checker debugging into its own chapter

5665927

lqd reviewed Aug 1, 2024

View reviewed changes

jieyouxu added the S-waiting-on-author Status: this PR is waiting for additional action by the OP label Oct 8, 2024

jieyouxu added T-compiler Relevant to compiler team A-dataflow Area: dataflow analysis A-borrow-checker Area: borrow checker A-regions Area: regions labels Nov 4, 2024

Kobzol force-pushed the master branch from 340f758 to 885fd79 Compare January 5, 2025 17:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Elaborate on dataflow outputs for region constraints #1969

Elaborate on dataflow outputs for region constraints #1969

amandasystems commented Apr 30, 2024

amandasystems commented Apr 30, 2024

lqd commented May 1, 2024

amandasystems commented May 2, 2024

lqd commented May 2, 2024

lqd left a comment

lqd Aug 1, 2024

lqd Aug 1, 2024

lqd Aug 1, 2024

jieyouxu commented Nov 2, 2024

Kobzol commented Jan 5, 2025


		## See also

		The [general instructions on debugging dataflow]() also apply to graphs generated from

		This is particularly useful for complicated region outlives graphs from
		[MIR Dataflow](mir/dataflow.md).

Elaborate on dataflow outputs for region constraints #1969

Are you sure you want to change the base?

Elaborate on dataflow outputs for region constraints #1969

Conversation

amandasystems commented Apr 30, 2024

amandasystems commented Apr 30, 2024

lqd commented May 1, 2024

amandasystems commented May 2, 2024

lqd commented May 2, 2024

lqd left a comment

Choose a reason for hiding this comment

lqd Aug 1, 2024

Choose a reason for hiding this comment

lqd Aug 1, 2024

Choose a reason for hiding this comment

lqd Aug 1, 2024

Choose a reason for hiding this comment

jieyouxu commented Nov 2, 2024

Kobzol commented Jan 5, 2025