-
Notifications
You must be signed in to change notification settings - Fork 54
Add a note about uninhabited-struct layout optimization #346
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
Open
scottmcm
wants to merge
3
commits into
rust-lang:master
Choose a base branch
from
scottmcm:scottmcm-patch-1
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -217,3 +217,47 @@ Cross-referencing to other discussions: | |||||
| * https://github.com/rust-lang/rfcs/issues/1397 | ||||||
| * https://github.com/rust-lang/rust/issues/17027 | ||||||
| * https://github.com/rust-lang/unsafe-code-guidelines/issues/176 | ||||||
|
|
||||||
| ## Uninhabited `struct`s should all be ZSTs | ||||||
|
|
||||||
| It makes conceptual sense that if something is uninhabited, it shouldn't take up any space. | ||||||
| In safe code that works great, but we tried it and ran into problems, so it's not likely to happen. | ||||||
|
|
||||||
| The biggest problem is related to field projection during initialization. Take this code: | ||||||
|
|
||||||
| ```rust | ||||||
| pub fn make_pair<T0, T1>(a0: impl Fn() -> T0, a1: impl Fn() -> T1) -> Box<(T0, T1)> { | ||||||
| let mut mu = Box::<(T0, T1)>::new_uninit(); | ||||||
| unsafe { | ||||||
| let p0 = &raw mut (*mu.as_mut_ptr()).0; | ||||||
| p0.write(a0()); | ||||||
|
|
||||||
| let p1 = &raw mut (*mu.as_mut_ptr()).1; | ||||||
| p1.write(a1()); | ||||||
|
|
||||||
| mu.assume_init() | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| Is that *sound*? It sure looks reasonable -- after all, it initialized both the fields -- but | ||||||
| it depends on exactly what the layout rules are. | ||||||
|
|
||||||
| (Aside: Note that a production-ready version of that function should also handle unwinding cleanup | ||||||
| of the first value if constructing the second panicked, but for simplicity of presentation we're | ||||||
| ignoring that part here because leaking is still *sound*.) | ||||||
|
|
||||||
| For something simple like `make_pair::<u8, i32>`, it's clearly fine. But with `make_pair::<u32, !>` | ||||||
| it's *only* sound if we *don't* let `(u32, !)` become a ZST. We need the allocation for the box | ||||||
| to be large enough to write that `u32` without being an obviously-UB out-of-bounds write. | ||||||
|
|
||||||
| Thus if we wanted to always have uninhabited product types be ZSTs, we'd need to give up on certain | ||||||
| other rules, perhaps the one that `T` and `MaybeUninit<T>` always have the same size. So far, the | ||||||
| simpler, less-error-prone experience for writing unsafe code has won out over the minimal space | ||||||
| savings possible from shrinking the types. After all, while it's not necessarily fully unreachable, | ||||||
| as something like `make_pair(|| a, || loop { … })` would still need to allocate the space despite | ||||||
| that never reaching the `assume_init` part, it's still unlikely that this occurs frequently. | ||||||
|
|
||||||
| There *is* still interest in maybe doing optimizations like this on *sum* types, however. There's more | ||||||
| to potentially be gained there since one variant of an `enum` being uninhabited doesn't | ||||||
| keep the whole *value* from being uninhabited the way an uninhabited field does in a `struct`. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this might be a typo?
Suggested change
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the name “ZST” does not capture the underlying idea very well. The real thing we want is a -∞ sized type, ZST is just one specific way of implementing it. Although I don’t have a better title yet.
Also, do you think it’s a good idea to also add the discussion of
Inhabittedtrait here? In case someone reading this come up with that idea again.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's not as clear as you'd think. Rust has unsafe, and types need a layout, so "a ZST with always-false validity invariant" actually has some important benefits. With a -∞ sized/aligned type you can't even start executing a function that has a
!variable in it because its whole stack frame would be uninhabited; yet it's easy to write such a function: justpanic!().Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Size is a natural number, so a size of -∞ doesn't even make sense. (One could define notions of size where that does make sense, but that's not the discussion we are having here. The notion of size here is the notion currently used in Rust. Given the proposed resolution for this question, it's also not useful to consider these other notions of size.)
Therefore, ZST is exactly the right term here. There's no way a type can be smaller than that.