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

lint internal hashmap iteration #465

Closed
1 of 3 tasks
lcnr opened this issue Oct 5, 2021 · 3 comments
Closed
1 of 3 tasks

lint internal hashmap iteration #465

lcnr opened this issue Oct 5, 2021 · 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

@lcnr
Copy link
Contributor

lcnr commented Oct 5, 2021

Proposal

When iterating over a FxHashMap or FxHashSet in a query, it is easily possible for the iteration order to influence the
behavior of that query. This can lead to either huge difference based on small inputs, which is mostly fine but makes ui tests annoying, if the HashMap hashes something for which the Hash and HashStable implementations differ, e.g. DefId, this can even lead to inconsistent query results, causing a few bugs in the past.

I've implemented a lint in rust-lang/rust#89558 which triggers whenever using methods marked with #[rustc_lint_query_stability] and added that attribute to "unstable" methods of both HashMap and HashSet.

I think that it probably makes sense to use this lint by default and require us to explicitly allow it in all places where the iteration order does not matter. We could also use the results of that lint to fix any issues which exist rn and try to be careful in the future without denying it by default, but that seems slightly worse to me.

It caused about 70 warnings for me locally (errors without a custom config.toml) a bunch of which did not reveal any bugs, but there were definitely a few cases which were either far from trivial or actually incorrect.

Mentors or Reviewers

🤷 someone from @rust-lang/wg-incr-comp probably

Process

The main points of the Major Change Process are as follows:

  • File an issue describing the proposal.
  • A compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.
    • Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a -C flag, then full team check-off is required.
    • Compiler team members can initiate a check-off via @rfcbot fcp merge on either the MCP or the PR.
  • Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.

You can read more about Major Change Proposals on forge.

Comments

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.

@lcnr lcnr 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 Oct 5, 2021
@rustbot
Copy link
Collaborator

rustbot commented Oct 5, 2021

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.

cc @rust-lang/compiler @rust-lang/compiler-contributors

@rustbot rustbot added the to-announce Announce this issue on triage meeting label Oct 5, 2021
@estebank
Copy link

estebank commented Oct 5, 2021

@rustbot second

@rustbot rustbot added the final-comment-period The FCP has started, most (if not all) team members are in agreement label Oct 5, 2021
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Oct 7, 2021
@apiraino
Copy link
Contributor

@rustbot label -final-comment-period +major-change-accepted

@rustbot rustbot added major-change-accepted A major change proposal that was accepted to-announce Announce this issue on triage meeting and removed final-comment-period The FCP has started, most (if not all) team members are in agreement labels Oct 21, 2021
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Oct 21, 2021
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

4 participants