Make some types and methods related to Polonius + Miri public #134191

willcrichton · 2024-12-12T00:56:10Z

We have a tool, Aquascope, which uses Polonius and Miri to visualize the compile-time and run-time semantics of a Rust program. Changes in the last few months to both APIs have hidden away details we depend upon. This PR re-exposes some of those details, specifically:

Polonius:

BorrowSet and BorrowData are added to rustc_borrowck::consumers, and their fields are made pub instead of pub(crate). We need this to interpret the BorrowIndexes generated by Polonius.
BorrowSet::build is now pub. We need this because the borrowck API doesn't provide access to the BorrowSet constructed during checking.
PoloniusRegionVid is added to rustc_borrowck::consumers. We need this because it's also contained in the Polonius facts.

Miri:

InterpCx::local_to_op is now a special case of local_at_frame_to_op, which allows querying locals in any frame. We need this because we walk the whole stack at each step to collect the state of memory.
InterpCx::layout_of_local is now pub. We need this because we need to know the layout of every local at each step.

If these changes go against some design goal for keeping certain types private, please let me know so we can hash out a better solution. Additionally, if there's a better way to document that it's important that certain types stay public, also let me know. For example, BorrowSet was previously public but was hidden in 6676cec, breaking our build.

cc @RalfJung @nnethercote @gavinleroy

rustbot · 2024-12-12T00:56:19Z

r? @fmease

rustbot has assigned @fmease.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2024-12-12T00:56:22Z

Some changes occurred to the CTFE / Miri interpreter

cc @rust-lang/miri

Some changes occurred to the CTFE machinery

cc @rust-lang/wg-const-eval

rustbot · 2024-12-12T01:28:58Z

Some changes occurred to the CTFE / Miri interpreter

cc @rust-lang/miri

Some changes occurred to the CTFE machinery

cc @rust-lang/wg-const-eval

compiler/rustc_const_eval/src/interpret/operand.rs

RalfJung · 2024-12-12T07:47:56Z

compiler/rustc_borrowck/src/borrow_set.rs

    /// Place to which the borrow was stored
-    pub(crate) assigned_place: mir::Place<'tcx>,
+    pub assigned_place: mir::Place<'tcx>,


Do you really need read and write access to all these fields?

If read access suffices, maybe add public getters instead?

I don't need write access. I restored the pub(crate) visibility and added getters for BorrowSet and BorrowData.

lqd · 2024-12-12T08:17:55Z

Additionally, if there's a better way to document that it's important that certain types stay public, also let me know. For example, BorrowSet was previously public

Adding a comment to each def site of interest will help: the fact that they are public is not enough, neither is the fact that they're referenced from consumers. AFAICT this code is has no stability guarantee, so things can (and will) still break but a comment explaining why things are public can help lower the chances of accidental breakage. This is already done in multiple places.

compiler/rustc_const_eval/src/interpret/operand.rs

rustbot · 2024-12-12T20:35:07Z

The Miri subtree was changed

cc @rust-lang/miri

RalfJung · 2024-12-13T16:41:45Z

r=me on the interpret and Miri parts.
It's a bit odd that reading locals now works for all frames but writing only works for the current frame... but that's crucial, Place::Local doesn't even store the frame so it would be quite dangerous to try to write to a local from a different frame. Reading is fine since we return the Op which is valid independent of what the current frame is.

lqd · 2024-12-13T16:48:31Z

r=me on the borrowck/polonius parts

RalfJung · 2024-12-13T16:53:57Z

I think that's all the parts.

@bors r=RalfJung,lqd rollup

bors · 2024-12-13T16:54:01Z

📌 Commit 4d5d470 has been approved by RalfJung,lqd

It is now in the queue for this repository.

Make some types and methods related to Polonius + Miri public We have a tool, [Aquascope](https://github.com/cognitive-engineering-lab/aquascope/), which uses Polonius and Miri to visualize the compile-time and run-time semantics of a Rust program. Changes in the last few months to both APIs have hidden away details we depend upon. This PR re-exposes some of those details, specifically: **Polonius:** - `BorrowSet` and `BorrowData` are added to `rustc_borrowck::consumers`, and their fields are made `pub` instead of `pub(crate)`. We need this to interpret the `BorrowIndex`es generated by Polonius. - `BorrowSet::build` is now `pub`. We need this because the borrowck API doesn't provide access to the `BorrowSet` constructed during checking. - `PoloniusRegionVid` is added to `rustc_borrowck::consumers`. We need this because it's also contained in the Polonius facts. **Miri:** - `InterpCx::local_to_op` is now a special case of `local_at_frame_to_op`, which allows querying locals in any frame. We need this because we walk the whole stack at each step to collect the state of memory. - `InterpCx::layout_of_local` is now `pub`. We need this because we need to know the layout of every local at each step. If these changes go against some design goal for keeping certain types private, please let me know so we can hash out a better solution. Additionally, if there's a better way to document that it's important that certain types stay public, also let me know. For example, `BorrowSet` was previously public but was hidden in 6676cec, breaking our build. cc `@RalfJung` `@nnethercote` `@gavinleroy`

Make some types and methods related to Polonius + Miri public We have a tool, [Aquascope](https://github.com/cognitive-engineering-lab/aquascope/), which uses Polonius and Miri to visualize the compile-time and run-time semantics of a Rust program. Changes in the last few months to both APIs have hidden away details we depend upon. This PR re-exposes some of those details, specifically: **Polonius:** - `BorrowSet` and `BorrowData` are added to `rustc_borrowck::consumers`, and their fields are made `pub` instead of `pub(crate)`. We need this to interpret the `BorrowIndex`es generated by Polonius. - `BorrowSet::build` is now `pub`. We need this because the borrowck API doesn't provide access to the `BorrowSet` constructed during checking. - `PoloniusRegionVid` is added to `rustc_borrowck::consumers`. We need this because it's also contained in the Polonius facts. **Miri:** - `InterpCx::local_to_op` is now a special case of `local_at_frame_to_op`, which allows querying locals in any frame. We need this because we walk the whole stack at each step to collect the state of memory. - `InterpCx::layout_of_local` is now `pub`. We need this because we need to know the layout of every local at each step. If these changes go against some design goal for keeping certain types private, please let me know so we can hash out a better solution. Additionally, if there's a better way to document that it's important that certain types stay public, also let me know. For example, `BorrowSet` was previously public but was hidden in 6676cec, breaking our build. cc ``@RalfJung`` ``@nnethercote`` ``@gavinleroy``

…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#133221 (Add external macros specific diagnostics for check-cfg) - rust-lang#133386 (Update linux_musl base to dynamically link the crt by default) - rust-lang#134191 (Make some types and methods related to Polonius + Miri public) - rust-lang#134227 (Update wasi-sdk used to build WASI targets) - rust-lang#134279 ((Re-)return adjustment target if adjust kind is never-to-any) - rust-lang#134295 (Encode coroutine-closures in SMIR) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#134191 - willcrichton:dev, r=RalfJung,lqd Make some types and methods related to Polonius + Miri public We have a tool, [Aquascope](https://github.com/cognitive-engineering-lab/aquascope/), which uses Polonius and Miri to visualize the compile-time and run-time semantics of a Rust program. Changes in the last few months to both APIs have hidden away details we depend upon. This PR re-exposes some of those details, specifically: **Polonius:** - `BorrowSet` and `BorrowData` are added to `rustc_borrowck::consumers`, and their fields are made `pub` instead of `pub(crate)`. We need this to interpret the `BorrowIndex`es generated by Polonius. - `BorrowSet::build` is now `pub`. We need this because the borrowck API doesn't provide access to the `BorrowSet` constructed during checking. - `PoloniusRegionVid` is added to `rustc_borrowck::consumers`. We need this because it's also contained in the Polonius facts. **Miri:** - `InterpCx::local_to_op` is now a special case of `local_at_frame_to_op`, which allows querying locals in any frame. We need this because we walk the whole stack at each step to collect the state of memory. - `InterpCx::layout_of_local` is now `pub`. We need this because we need to know the layout of every local at each step. If these changes go against some design goal for keeping certain types private, please let me know so we can hash out a better solution. Additionally, if there's a better way to document that it's important that certain types stay public, also let me know. For example, `BorrowSet` was previously public but was hidden in 6676cec, breaking our build. cc ```@RalfJung``` ```@nnethercote``` ```@gavinleroy```

rustbot assigned fmease Dec 12, 2024

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Dec 12, 2024

This comment has been minimized.

Sign in to view

Make some types and methods related to Polonius + Miri public.

eb10db0

willcrichton force-pushed the dev branch from f4242a6 to eb10db0 Compare December 12, 2024 01:28

RalfJung reviewed Dec 12, 2024

View reviewed changes

compiler/rustc_const_eval/src/interpret/operand.rs Show resolved Hide resolved

RalfJung reviewed Dec 12, 2024

View reviewed changes

lqd reviewed Dec 12, 2024

View reviewed changes

compiler/rustc_const_eval/src/interpret/operand.rs Outdated Show resolved Hide resolved

Make BorrowSet/BorrowData fields accessible via public getters

4d5d470

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 Dec 13, 2024

matthiaskrgr mentioned this pull request Dec 13, 2024

Rollup of 8 pull requests #134280

Closed

Zalathar mentioned this pull request Dec 14, 2024

Rollup of 10 pull requests #134289

Closed

matthiaskrgr mentioned this pull request Dec 14, 2024

Rollup of 6 pull requests #134305

Merged

bors merged commit fffdb1b into rust-lang:master Dec 14, 2024
6 checks passed

rustbot added this to the 1.85.0 milestone Dec 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make some types and methods related to Polonius + Miri public #134191

Make some types and methods related to Polonius + Miri public #134191

willcrichton commented Dec 12, 2024

rustbot commented Dec 12, 2024

rustbot commented Dec 12, 2024

This comment has been minimized.

rustbot commented Dec 12, 2024

RalfJung Dec 12, 2024

willcrichton Dec 12, 2024

lqd commented Dec 12, 2024 •

edited

Loading

rustbot commented Dec 12, 2024

RalfJung commented Dec 13, 2024 •

edited

Loading

lqd commented Dec 13, 2024

RalfJung commented Dec 13, 2024

bors commented Dec 13, 2024

Make some types and methods related to Polonius + Miri public #134191

Make some types and methods related to Polonius + Miri public #134191

Conversation

willcrichton commented Dec 12, 2024

rustbot commented Dec 12, 2024

rustbot commented Dec 12, 2024

This comment has been minimized.

rustbot commented Dec 12, 2024

RalfJung Dec 12, 2024

Choose a reason for hiding this comment

willcrichton Dec 12, 2024

Choose a reason for hiding this comment

lqd commented Dec 12, 2024 • edited Loading

rustbot commented Dec 12, 2024

RalfJung commented Dec 13, 2024 • edited Loading

lqd commented Dec 13, 2024

RalfJung commented Dec 13, 2024

bors commented Dec 13, 2024

lqd commented Dec 12, 2024 •

edited

Loading

RalfJung commented Dec 13, 2024 •

edited

Loading