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

Remove Spans from HIR #294

Closed
1 of 4 tasks
cjgillot opened this issue May 19, 2020 · 3 comments
Closed
1 of 4 tasks

Remove Spans from HIR #294

cjgillot opened this issue May 19, 2020 · 3 comments
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team

Comments

@cjgillot
Copy link

What is this issue?

This is a major change proposal, which means a proposal to make a notable change to the compiler -- one that either alters the architecture of some component, affects a lot of people, or makes a small but noticeable public change (e.g., adding a compiler flag). You can read more about the MCP process on https://forge.rust-lang.org/.

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

MCP Checklist

  • MCP filed. Automatically, as a result of filing this issue:
    • The @rust-lang/wg-prioritization group will add this to the triage meeting agenda so folks see it.
    • A Zulip topic in the stream #t-compiler/major changes will be created for this issue.
  • MCP seconded. The MCP is "seconded" when a compiler team member or contributor issues the @rustbot second command. This should only be done by someone knowledgable with the area -- before seconding, it may be a good idea to cc other stakeholders as well and get their opinion.
  • Final comment period (FCP). Once the MCP is approved, the FCP begins and lasts for 10 days. This is a time for other members to review and raise concerns -- concerns that should block acceptance should be noted as comments on the thread, ideally with a link to Zulip for further discussion.
  • MCP Accepted. At the end of the FCP, a compiler team lead will review the comments and discussion and decide whether to accept the MCP.
    • At this point, the major-change-accepted label is added and the issue is closed. You can link to it for future reference.

A note on stability. If your change is proposing a new stable feature, such as a -C flag, then a full team checkoff will be required before the feature can be landed. Often it is better to start with an unstable flag, like a -Z flag, and then move to stabilize as a secondary step.

TL;DR

The HIR tree currently embeds spans copied from the AST. This makes the HIR unstable between incremental sessions. This MCP proposes to remove spans from the HIR tree, and to store them in a separate data structure.

Links and Details

At the moment, the HIR contains spans in three forms:

  1. directly associated to nodes (Item, Pat...) ;
  2. inside Indents ;
  3. to track ad-hoc semantic points (see ExprKind).

This MCP proposes to remove all those spans, and to store them in a side table.
This side table would be built during AST->HIR lowering.
The span information corresponding to a HIR node is then accessible through a query.

Preliminary work: rust-lang/rust#72015
The PR explores the easy case: removing spans for nodes which have an associated HidId.

The two other cases (ad-hoc spans & Idents) need further design work.
Some may be approached by adding a HirId.

Mentors or Reviewers

Who will review this work? If you are being mentored by someone, then list
their name here. If you are a compiler team member/contributor, and you
intend to mentor someone else, then you can put your own name here. You can
also leave it blank if you are looking for a reviewer. (Multiple names are ok
too.)

@cjgillot cjgillot added T-compiler Add this label so rfcbot knows to poll the compiler team major-change A proposal to make a major change to rustc labels May 19, 2020
@rustbot rustbot added the to-announce Announce this issue on triage meeting label May 19, 2020
@spastorino spastorino removed the to-announce Announce this issue on triage meeting label May 20, 2020
@pnkfelix
Copy link
Member

@pnkfelix
Copy link
Member

@rustbot second

@rustbot rustbot added the final-comment-period The FCP has started, most (if not all) team members are in agreement label May 22, 2020
@nikomatsakis
Copy link
Contributor

Closing, this is accepted.

@spastorino spastorino added major-change-accepted A major change proposal that was accepted and removed final-comment-period The FCP has started, most (if not all) team members are in agreement labels Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team
Projects
None yet
Development

No branches or pull requests

5 participants