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

data_structures: Add deterministic FxHashMap and FxHashSet wrappers #64131

Open
wants to merge 6 commits into
base: master
from

Conversation

@shivan1b
Copy link

commented Sep 3, 2019

StableMap
A wrapper for FxHashMap that allows to insert, remove, get, get_mut and convert a hashmap into a sorted vector using the method into_sorted_vector but no iteration support.

StableSet
A wrapper for FxHashSet that allows to insert, remove, get and convert a hashset into a sorted vector using the method into_sorted_vector but no iteration support.

Addresses issue #63713

data_structures: Add a deterministic FxHashMap wrapper
A wrapper for FxHashMap that allows to insert, remove, get and get_mut
but no iteration support.
@rust-highfive

This comment has been minimized.

Copy link
Collaborator

commented Sep 3, 2019

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @cramertj (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@shivan1b

This comment has been minimized.

Copy link
Author

commented Sep 3, 2019

Hi @bjorn3!
Could you please check if this meets the requirements of the corresponding issue?
Please note that this does not have the "convertion to a sorted vec." support. I learned the basics of HashMap and checked a few functions, not sure which function does this exactly, could you please point me to that?
Thank you.

@shivan1b

This comment has been minimized.

Copy link
Author

commented Sep 3, 2019

r? @bjorn3

@Mark-Simulacrum

This comment has been minimized.

Copy link
Member

commented Sep 3, 2019

Please note that the examples above are NOT a part of the commit message.

But they will be if we decide to merge this (bors includes PR message in merge commit).


I'd also like to see this called something like StableMap perhaps or DeterministicMap, since otherwise the determinism aspect is a bit lost in the naming (and since we're likely almost universally using this once we migrate the compiler, it would be good to separate it a bit).


@Mark-Simulacrum

This comment has been minimized.

Copy link
Member

commented Sep 3, 2019

We'll probably want a Set variant of the map as well.


For sorted vector support something like the following would work:

fn into_sorted_vector(self) -> Vec<(K, V)> /* or Vec<T> */
where K: PartialOrd,
           V: PartialOrd,
{
    let mut v = self.base.into_iter().collect::<Vec<_>>();
    v.unstable_sort(); // this is interesting in that it's unstable but we're not actually adding instability here since the underlying map already has an unstable iteration order
    v
}
@bjorn3
bjorn3 approved these changes Sep 3, 2019
Copy link
Contributor

left a comment

Please rustfmt dfx.rs (but not the rest of the files, so you will need to run rustfmt /path/to/dfx.rs instead of cargo fmt.)

Apart from a few nits this looks good. @Mark-Simulacrum should this PR contain a first user of the new api, or can that be done in a follow-up?

src/librustc_data_structures/dfx.rs Outdated Show resolved Hide resolved
src/librustc_data_structures/dfx.rs Outdated Show resolved Hide resolved
@shivan1b

This comment has been minimized.

Copy link
Author

commented Sep 3, 2019

Please note that the examples above are NOT a part of the commit message.

But they will be if we decide to merge this (bors includes PR message in merge commit).

Right. Forgot about it. I shall remove them before merging unless you think it makes sense to have them as a part of commit message?

I'd also like to see this called something like StableMap perhaps or DeterministicMap, since otherwise the determinism aspect is a bit lost in the naming (and since we're likely almost universally using this once we migrate the compiler, it would be good to separate it a bit).

Shall I go with DeterministickMap then? Should the module name also be changed from dfx to deterministic_map ?

@bjorn3

This comment has been minimized.

Copy link
Contributor

commented Sep 3, 2019

I prefer StableMap as it is shorter, which means it is more likely to be picked over FxHashMap.

@shivan1b

This comment has been minimized.

Copy link
Author

commented Sep 3, 2019

We'll probably want a Set variant of the map as well.

Sure. Should I be creating a separate issue for this?

For sorted vector support something like the following would work:

fn into_sorted_vector(self) -> Vec<(K, V)> /* or Vec<T> */
where K: PartialOrd,
           V: PartialOrd,
{
    let mut v = self.base.into_iter().collect::<Vec<_>>();
    v.unstable_sort(); // this is interesting in that it's unstable but we're not actually adding instability here since the underlying map already has an unstable iteration order
    v
}

Thank you very much!

@Mark-Simulacrum

This comment has been minimized.

Copy link
Member

commented Sep 3, 2019

I think adding the set in this PR makes sense; it should be minimally difficult to do so, hopefully.

Right. Forgot about it. I shall remove them before merging unless you think it makes sense to have them as a part of commit message?

Yeah, I don't think the examples are too useful.

Apart from a few nits this looks good. @Mark-Simulacrum should this PR contain a first user of the new api, or can that be done in a follow-up?

I think that moving the compiler over can be done in followup PRs. It'll likely be fairly straightforward (mostly just search and replace on FxHash{Map,Set}).

shivan1b added 2 commits Sep 4, 2019
data_structures: Clean up and add fn to StableMap
This patch addresses the following issues:
1. Name of the module should be something showing the deterministic
aspect.
2. Formatting of code using rustfmt.
3. Add `into_sorted_vector` function to convert HashMap into sorted vector.
4. Add support for `entry` function from FxHashMap.
5. Add appropriate derivable traits.
src/librustc_data_structures/stable_map.rs Outdated Show resolved Hide resolved
src/librustc_data_structures/stable_map.rs Outdated Show resolved Hide resolved
src/librustc_data_structures/stable_map.rs Outdated Show resolved Hide resolved
src/librustc_data_structures/stable_map.rs Outdated Show resolved Hide resolved
src/librustc_data_structures/stable_map.rs Outdated Show resolved Hide resolved

@shivan1b shivan1b requested a review from Mark-Simulacrum Sep 10, 2019

data_structures: Add a deterministic FxHashSet wrapper
A wrapper for FxHashSet that allows to insert, remove, get and create a
sorted vector from a hashset but no iteration support.

@shivan1b shivan1b changed the title data_structures: Add a deterministic FxHashMap wrapper data_structures: Add a deterministic FxHashMap and FxHashSet wrapper Sep 10, 2019

@shivan1b shivan1b changed the title data_structures: Add a deterministic FxHashMap and FxHashSet wrapper data_structures: Add a deterministic FxHashMap and FxHashSet wrappers Sep 10, 2019

@shivan1b shivan1b changed the title data_structures: Add a deterministic FxHashMap and FxHashSet wrappers data_structures: Add deterministic FxHashMap and FxHashSet wrappers Sep 10, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.