-
Notifications
You must be signed in to change notification settings - Fork 537
Fix incorrect pseudocode for #[repr(C)] struct alignment #766
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
Changes from all commits
5426423
bc5c540
13e415a
5d5b233
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -197,6 +197,19 @@ Here is this algorithm described in pseudocode. | |
|
||
<!-- ignore: pseudocode --> | ||
```rust,ignore | ||
/// Returns the amount of padding needed after `offset` to ensure that the | ||
/// following address will be aligned to `alignment`. | ||
fn padding_needed_for(offset: usize, alignment: usize) -> usize { | ||
let misalignment = offset % alignment; | ||
if misalignment > 0 { | ||
// round up to next multiple of `alignment` | ||
alignment - misalignment | ||
} else { | ||
// already a multiple of `alignment` | ||
0 | ||
} | ||
} | ||
|
||
struct.alignment = struct.fields().map(|field| field.alignment).max(); | ||
|
||
let current_offset = 0; | ||
|
@@ -205,16 +218,24 @@ for field in struct.fields_in_declaration_order() { | |
// Increase the current offset so that it's a multiple of the alignment | ||
// of this field. For the first field, this will always be zero. | ||
// The skipped bytes are called padding bytes. | ||
current_offset += field.alignment % current_offset; | ||
current_offset += padding_needed_for(current_offset, field.alignment); | ||
|
||
struct[field].offset = current_offset; | ||
|
||
current_offset += field.size; | ||
} | ||
|
||
struct.size = current_offset + current_offset % struct.alignment; | ||
struct.size = current_offset + padding_needed_for(current_offset, struct.alignment); | ||
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. @rkanati you didn't touch this one in your PR... do you remember why? Was that an oversight, or was the original code actually correct for some reason? 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. As far as I can tell, that was just an oversight. 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 so, too. It would just have been good to get explicit confirmation. |
||
``` | ||
|
||
<div class="warning"> | ||
|
||
Warning: This pseudocode uses a naive algorithm that ignores overflow issues for | ||
the sake of clarity. To perform memory layout computations in actual code, use | ||
[`Layout`]. | ||
|
||
</div> | ||
|
||
> Note: This algorithm can produce zero-sized structs. This differs from | ||
> C where structs without data still have a size of one byte. | ||
|
||
|
@@ -363,3 +384,4 @@ used with any other representation. | |
[`C`]: #the-c-representation | ||
[primitive representations]: #primitive-representations | ||
[`transparent`]: #the-transparent-representation | ||
[`Layout`]: ../std/alloc/struct.Layout.html |
Uh oh!
There was an error while loading. Please reload this page.