Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't do intra-pass validation on MIR shims #115005

Merged
merged 1 commit into from Aug 22, 2023

Conversation

compiler-errors
Copy link
Member

@compiler-errors compiler-errors commented Aug 19, 2023

Fixes #114375

In the test that was committed, we end up generating the drop shim for struct Foo that looks like:

fn std::ptr::drop_in_place(_1: *mut Foo) -> () {
    let mut _0: ();

    bb0: {
        goto -> bb5;
    }

    bb1: {
        return;
    }

    bb2 (cleanup): {
        resume;
    }

    bb3: {
        goto -> bb1;
    }

    bb4 (cleanup): {
        drop(((*_1).0: foo::WrapperWithDrop<()>)) -> [return: bb2, unwind terminate];
    }

    bb5: {
        drop(((*_1).0: foo::WrapperWithDrop<()>)) -> [return: bb3, unwind: bb2];
    }
}

In bb4 and bb5, we assert that (*_1).0 has type WrapperWithDrop<()>. However, In a user-facing param env, the type is actually WrapperWithDrop<Tait>. These types are not equal in a user-facing param-env (and can't be made equal even if we use DefiningAnchor::Bubble, since it's a non-local TAIT).

@rustbot
Copy link
Collaborator

rustbot commented Aug 19, 2023

r? @cjgillot

(rustbot has picked a reviewer for you, use r? to override)

@rustbot 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 Aug 19, 2023
@rustbot
Copy link
Collaborator

rustbot commented Aug 19, 2023

Some changes occurred to MIR optimizations

cc @rust-lang/wg-mir-opt

// only valid in a reveal-all param-env. However, since we do initial
// validation with the MirBuilt phase, which uses a user-facing param-env.
// This causes validation errors when TAITs are involved.
pm::run_passes_no_validate(
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could, perhaps, only do this for drop shims. Other shims are (probably?) alright to do validation on.

But I'm fine with ignoring all shims -- we still do final validation after passes are run since we're transitioning to MirPhase::Runtime(RuntimePhase::Optimized).

@cjgillot
Copy link
Contributor

#113124 proposes to change the MirSource for generator drops to be DropGlue. Would this solve this bug?

@compiler-errors
Copy link
Member Author

I don't think so? This doesn't have anything specifically to do with drop shims for generator types, and the changes that #113124 makes to validation don't seem relevant, unless I'm misreading something.

@compiler-errors
Copy link
Member Author

The tests in this PR are unaffected by #113124.

Copy link
Contributor

@cjgillot cjgillot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBH, I'm not super fond of removing validation. This is very useful to catch construction bugs. I'd rather find another solution, but I will ok this PR if it's the only one.

pm::run_passes(
// We don't validate MIR here because the shims may generate code that's
// only valid in a reveal-all param-env. However, since we do initial
// validation with the MirBuilt phase, which uses a user-facing param-env.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about setting body.phase to Runtime(Initial)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That probably works. I'm not sure if that breaks any other invariants of validation, let me try it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not work, because validation fails before the Derefer is run.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went down this path last week but wasn't very happy with the result as I had to run Derefer and then it seemed wise to run the other passes to actually put us in the same state as we should be when phase = Runtime(Initial) but that required either duplicating the list of passes or splitting up run_runtime_lowering_passes() since running ElaborateDrops again caused other issues. In the end, it felt pretty hacky and I think @compiler-errors's solution here is better.

@cjgillot
Copy link
Contributor

I'm out of alternate ideas.
@bors r+

@bors
Copy link
Contributor

bors commented Aug 22, 2023

📌 Commit acd3542 has been approved by cjgillot

It is now in the queue for this repository.

@bors 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 Aug 22, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 22, 2023
Don't do intra-pass validation on MIR shims

Fixes rust-lang#114375

In the test that was committed, we end up generating the drop shim for `struct Foo` that looks like:

```
fn std::ptr::drop_in_place(_1: *mut Foo) -> () {
    let mut _0: ();

    bb0: {
        goto -> bb5;
    }

    bb1: {
        return;
    }

    bb2 (cleanup): {
        resume;
    }

    bb3: {
        goto -> bb1;
    }

    bb4 (cleanup): {
        drop(((*_1).0: foo::WrapperWithDrop<()>)) -> [return: bb2, unwind terminate];
    }

    bb5: {
        drop(((*_1).0: foo::WrapperWithDrop<()>)) -> [return: bb3, unwind: bb2];
    }
}
```

In `bb4` and `bb5`, we assert that `(*_1).0` has type `WrapperWithDrop<()>`. However, In a user-facing param env, the type is actually `WrapperWithDrop<Tait>`. These types are not equal in a user-facing param-env (and can't be made equal even if we use `DefiningAnchor::Bubble`, since it's a non-local TAIT).
@bors
Copy link
Contributor

bors commented Aug 22, 2023

⌛ Testing commit acd3542 with merge c469197...

@bors
Copy link
Contributor

bors commented Aug 22, 2023

☀️ Test successful - checks-actions
Approved by: cjgillot
Pushing c469197 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Aug 22, 2023
@bors bors merged commit c469197 into rust-lang:master Aug 22, 2023
12 checks passed
@rustbot rustbot added this to the 1.74.0 milestone Aug 22, 2023
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (c469197): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)
- - 0
Regressions ❌
(secondary)
- - 0
Improvements ✅
(primary)
- - 0
Improvements ✅
(secondary)
-2.5% [-2.5%, -2.5%] 2
All ❌✅ (primary) - - 0

Cycles

This benchmark run did not return any relevant results for this metric.

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 635.404s -> 634.642s (-0.12%)
Artifact size: 347.06 MiB -> 347.07 MiB (0.00%)

@matthiaskrgr
Copy link
Member

@compiler-errors should we beta-nominate this?

@compiler-errors
Copy link
Member Author

I don't think it particularly matters, since the only way to get the ICE is with -Zvalidate-mir.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ICE: broken mir while building rustc
7 participants