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

Refactor hir::Place #17

Closed
wants to merge 1 commit into from
Closed

Refactor hir::Place #17

wants to merge 1 commit into from

Conversation

arora-aman
Copy link
Member

@arora-aman arora-aman commented Jun 18, 2020

For the following code

let c = || bar(foo.x, foo.x)

We generate two different hir::Places for both foo.x.
Handling this adds overhead for analysis we need to do for RFC 2229.

We also want to store type information at each Projection to support
analysis as part of the RFC. This resembles what we have for
mir::Place

This commit modifies the Place as follows:

  • Rename to PlaceWithHirId, where there hir_id is that of the
    expressioin.
  • Move any other information that describes the access out to another
    struct now called Place.
  • Removed Span, it can be accessed using the hir
    API
  • Modify Projection to be a strucutre of its own, that currently only
    contains the ProjectionKind.
    Adding type information to projections wil be completed as part of Store Type Information within projections rust-lang/project-rfc-2229#5

Closes rust-lang/project-rfc-2229#3

@arora-aman
Copy link
Member Author

If you want commit-by-commit split: https://github.com/sexxi-goose/rust/tree/distinguish_place_and_placewithhirid

For the following code
```rust
let c = || bar(foo.x, foo.x)
```

We generate two different `hir::Place`s for both `foo.x`.
Handling this adds overhead for analysis we need to do for RFC 2229.

We also want to store type information at each Projection to support
analysis as part of the RFC. This resembles what we have for
`mir::Place`

This commit modifies the Place as follows:
- Rename to `PlaceWithHirId`, where there `hir_id` is that of the
expressioin.
- Move any other information that describes the access out to another
struct now called `Place`.
- Removed `Span`, it can be accessed using the [hir
API](https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/hir/map/struct.Map.html#method.span)
- Modify `Projection` to be a strucutre of its own, that currently only
contains the `ProjectionKind`.

Adding type information to projections wil be completed as part of rust-lang/project-rfc-2229#5

Closes rust-lang/project-rfc-2229#3

Co-authored-by: Aman Arora <me@aman-arora.com>
Co-authored-by: Roxane Fruytier <roxane.fruytier@hotmail.com>
@sexxi-bot
Copy link
Collaborator

🏃‍♂️ Start running build job, job id: 0d9bab45-33fe-4925-bc31-0af9c2021ec2

@arora-aman arora-aman requested a review from a team June 18, 2020 23:09
@arora-aman
Copy link
Member Author

rebase made tests fail locally, looking into it

Copy link

@jenniferwills jenniferwills left a comment

Choose a reason for hiding this comment

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

So correct me if i am wrong but this is essentially adding a wrapper to Place so that you have a Place and a HirId together in the same object?

@@ -439,7 +439,10 @@ impl<'a, 'tcx> RegionCtxt<'a, 'tcx> {

/// Invoked on any adjustments that occur. Checks that if this is a region pointer being
/// dereferenced, the lifetime of the pointer includes the deref expr.
fn constrain_adjustments(&mut self, expr: &hir::Expr<'_>) -> mc::McResult<mc::Place<'tcx>> {
fn constrain_adjustments(

Choose a reason for hiding this comment

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

lol nice formatting ;)

Copy link
Member Author

Choose a reason for hiding this comment

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

./x.py fmt I don't question it :p

base: PlaceBase::Local(var_id),
projections: Vec::new(),
})
Ok(PlaceWithHirId::new(hir_id, expr_ty, PlaceBase::Local(var_id), Vec::new()))

Choose a reason for hiding this comment

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

i think i like how this was laid out previously

Choose a reason for hiding this comment

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

oh wait this is a change to a constructor from the previous syntax, okay should probably leave as is then

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah most of the parameters not go to the member place within PlaceWithHirId

@sexxi-bot
Copy link
Collaborator

✅ Job Completed, access build log here

@arora-aman
Copy link
Member Author

rebase made tests fail locally, looking into it

Looks like a local setup issue.

/// A dereference of a pointer, reference or `Box<T>` of the given type
Deref(Ty<'tcx>),
/// An index or a field
Other,
}

#[derive(Clone, Debug)]
pub struct Projection<'tcx> {
Copy link
Member

Choose a reason for hiding this comment

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

I thought we also wanted to introduce ty in the Projection structure (https://github.com/rust-lang/project-rfc-2229/blob/master/hir-place-target.md). Is that not the case anymore or will this change be introduced in a later PR?

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

If we do that here, would've have to make sure at each step the type information gets read and put in place. Keeps this PR very focused and allows us to still do more work in parallel later on.

I think after this gets merged we can parallely work on:

Copy link
Member

Choose a reason for hiding this comment

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

Sounds good, just wanted to confirm. Since I worked on this PR too, I'll let someone else approve 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.

That's why I assigned this to @ChrisPardy and @null-sleep, since they attended the meeting about the refactor but @sexxi-goose/rustaceans feel free to approve it :)

@arora-aman
Copy link
Member Author

So correct me if i am wrong but this is essentially adding a wrapper to Place so that you have a Place and a HirId together in the same object?

We only need the Place part to do most of our analysis about captures, so we want to separate that information out. PlaceWithHirId is good for error reporting because it contains the expression's id that lets us access the span.

@jenniferwills
Copy link

lol wait can sexxi-bot review and/or approve PRs? because it has been requested

@arora-aman

This comment has been minimized.

@jenniferwills

This comment has been minimized.

@arora-aman

This comment has been minimized.

@jenniferwills

This comment has been minimized.

Copy link

@Azhng Azhng left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@jenniferwills jenniferwills left a comment

Choose a reason for hiding this comment

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

looks good

@arora-aman
Copy link
Member Author

rust-lang#73489

@arora-aman arora-aman closed this Jun 20, 2020
@arora-aman arora-aman deleted the init_place_refactor branch June 21, 2020 03:37
sexxi-bot pushed a commit that referenced this pull request Oct 5, 2020
This is a combination of 18 commits.

Commit #2:

Additional examples and some small improvements.

Commit #3:

fixed mir-opt non-mir extensions and spanview title elements

Corrected a fairly recent assumption in runtest.rs that all MIR dump
files end in .mir. (It was appending .mir to the graphviz .dot and
spanview .html file names when generating blessed output files. That
also left outdated files in the baseline alongside the files with the
incorrect names, which I've now removed.)

Updated spanview HTML title elements to match their content, replacing a
hardcoded and incorrect name that was left in accidentally when
originally submitted.

Commit #4:

added more test examples

also improved Makefiles with support for non-zero exit status and to
force validation of tests unless a specific test overrides it with a
specific comment.

Commit #5:

Fixed rare issues after testing on real-world crate

Commit #6:

Addressed PR feedback, and removed temporary -Zexperimental-coverage

-Zinstrument-coverage once again supports the latest capabilities of
LLVM instrprof coverage instrumentation.

Also fixed a bug in spanview.

Commit #7:

Fix closure handling, add tests for closures and inner items

And cleaned up other tests for consistency, and to make it more clear
where spans start/end by breaking up lines.

Commit #8:

renamed "typical" test results "expected"

Now that the `llvm-cov show` tests are improved to normally expect
matching actuals, and to allow individual tests to override that
expectation.

Commit #9:

test coverage of inline generic struct function

Commit #10:

Addressed review feedback

* Removed unnecessary Unreachable filter.
* Replaced a match wildcard with remining variants.
* Added more comments to help clarify the role of successors() in the
CFG traversal

Commit #11:

refactoring based on feedback

* refactored `fn coverage_spans()`.
* changed the way I expand an empty coverage span to improve performance
* fixed a typo that I had accidently left in, in visit.rs

Commit #12:

Optimized use of SourceMap and SourceFile

Commit rust-lang#13:

Fixed a regression, and synched with upstream

Some generated test file names changed due to some new change upstream.

Commit #14:

Stripping out crate disambiguators from demangled names

These can vary depending on the test platform.

Commit #15:

Ignore llvm-cov show diff on test with generics, expand IO error message

Tests with generics produce llvm-cov show results with demangled names
that can include an unstable "crate disambiguator" (hex value). The
value changes when run in the Rust CI Windows environment. I added a sed
filter to strip them out (in a prior commit), but sed also appears to
fail in the same environment. Until I can figure out a workaround, I'm
just going to ignore this specific test result. I added a FIXME to
follow up later, but it's not that critical.

I also saw an error with Windows GNU, but the IO error did not
specify a path for the directory or file that triggered the error. I
updated the error messages to provide more info for next, time but also
noticed some other tests with similar steps did not fail. Looks
spurious.

Commit #16:

Modify rust-demangler to strip disambiguators by default

Commit #17:

Remove std::process::exit from coverage tests

Due to Issue rust-lang#77553, programs that call std::process::exit() do not
generate coverage results on Windows MSVC.

Commit #18:

fix: test file paths exceeding Windows max path len
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Distinguish Place and PlaceWithHirId
7 participants