lint internal hashmap iteration #465
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
Proposal
When iterating over a
FxHashMap
orFxHashSet
in a query, it is easily possible for the iteration order to influence thebehavior 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 theHash
andHashStable
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 bothHashMap
andHashSet
.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:
@rustbot second
.-C flag
, then full team check-off is required.@rfcbot fcp merge
on either the MCP or the PR.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.
The text was updated successfully, but these errors were encountered: