-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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
Add reftest that checks the layout of repr(int) on non-c-like enums #45688
Merged
+173
−0
Merged
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 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 |
---|---|---|
@@ -0,0 +1,173 @@ | ||
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT | ||
// file at the top-level directory of this distribution and at | ||
// http://rust-lang.org/COPYRIGHT. | ||
// | ||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or | ||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license | ||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your | ||
// option. This file may not be copied, modified, or distributed | ||
// except according to those terms. | ||
|
||
// This test deserializes an enum in-place by transmuting to a union that | ||
// should have the same layout, and manipulating the tag and payloads | ||
// independently. This verifies that `repr(some_int)` has a stable representation, | ||
// and that we don't miscompile these kinds of manipulations. | ||
|
||
use std::time::Duration; | ||
use std::mem; | ||
|
||
#[repr(u8)] | ||
#[derive(Copy, Clone, Eq, PartialEq, Debug)] | ||
enum MyEnum { | ||
A(u32), // Single primitive value | ||
B { x: u8, y: i16 }, // Composite, and the offset of `y` depends on tag being internal | ||
C, // Empty | ||
D(Option<u32>), // Contains an enum | ||
E(Duration), // Contains a struct | ||
} | ||
|
||
#[allow(non_snake_case)] | ||
#[repr(C)] | ||
union MyEnumRepr { | ||
A: MyEnumVariantA, | ||
B: MyEnumVariantB, | ||
C: MyEnumVariantC, | ||
D: MyEnumVariantD, | ||
E: MyEnumVariantE, | ||
} | ||
|
||
#[repr(u8)] #[derive(Copy, Clone)] enum MyEnumTag { A, B, C, D, E } | ||
#[repr(C)] #[derive(Copy, Clone)] struct MyEnumVariantA(MyEnumTag, u32); | ||
#[repr(C)] #[derive(Copy, Clone)] struct MyEnumVariantB { tag: MyEnumTag, x: u8, y: i16 } | ||
#[repr(C)] #[derive(Copy, Clone)] struct MyEnumVariantC(MyEnumTag); | ||
#[repr(C)] #[derive(Copy, Clone)] struct MyEnumVariantD(MyEnumTag, Option<u32>); | ||
#[repr(C)] #[derive(Copy, Clone)] struct MyEnumVariantE(MyEnumTag, Duration); | ||
|
||
fn main() { | ||
let result: Vec<Result<MyEnum, ()>> = vec![ | ||
Ok(MyEnum::A(17)), | ||
Ok(MyEnum::B { x: 206, y: 1145 }), | ||
Ok(MyEnum::C), | ||
Err(()), | ||
Ok(MyEnum::D(Some(407))), | ||
Ok(MyEnum::D(None)), | ||
Ok(MyEnum::E(Duration::from_secs(100))), | ||
Err(()), | ||
]; | ||
|
||
// Binary serialized version of the above (little-endian) | ||
let input: Vec<u8> = vec![ | ||
0, 17, 0, 0, 0, | ||
1, 206, 121, 4, | ||
2, | ||
8, /* invalid tag value */ | ||
3, 0, 151, 1, 0, 0, | ||
3, 1, | ||
4, 100, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, | ||
0, /* incomplete value */ | ||
]; | ||
|
||
let mut output = vec![]; | ||
let mut buf = &input[..]; | ||
|
||
unsafe { | ||
// This should be safe, because we don't match on it unless it's fully formed, | ||
// and it doesn't have a destructor. | ||
let mut dest: MyEnum = mem::uninitialized(); | ||
while buf.len() > 0 { | ||
match parse_my_enum(&mut dest, &mut buf) { | ||
Ok(()) => output.push(Ok(dest)), | ||
Err(()) => output.push(Err(())), | ||
} | ||
} | ||
} | ||
|
||
assert_eq!(output, result); | ||
} | ||
|
||
fn parse_my_enum<'a>(dest: &'a mut MyEnum, buf: &mut &[u8]) -> Result<(), ()> { | ||
unsafe { | ||
// Should be correct to do this transmute. | ||
let dest: &'a mut MyEnumRepr = mem::transmute(dest); | ||
let tag = read_u8(buf)?; | ||
|
||
dest.A.0 = match tag { | ||
0 => MyEnumTag::A, | ||
1 => MyEnumTag::B, | ||
2 => MyEnumTag::C, | ||
3 => MyEnumTag::D, | ||
4 => MyEnumTag::E, | ||
_ => return Err(()), | ||
}; | ||
|
||
match dest.B.tag { | ||
MyEnumTag::A => { | ||
dest.A.1 = read_u32_le(buf)?; | ||
} | ||
MyEnumTag::B => { | ||
dest.B.x = read_u8(buf)?; | ||
dest.B.y = read_u16_le(buf)? as i16; | ||
} | ||
MyEnumTag::C => { | ||
/* do nothing */ | ||
} | ||
MyEnumTag::D => { | ||
let is_some = read_u8(buf)? == 0; | ||
if is_some { | ||
dest.D.1 = Some(read_u32_le(buf)?); | ||
} else { | ||
dest.D.1 = None; | ||
} | ||
} | ||
MyEnumTag::E => { | ||
let secs = read_u64_le(buf)?; | ||
let nanos = read_u32_le(buf)?; | ||
dest.E.1 = Duration::new(secs, nanos); | ||
} | ||
} | ||
Ok(()) | ||
} | ||
} | ||
|
||
|
||
|
||
// reader helpers | ||
|
||
fn read_u64_le(buf: &mut &[u8]) -> Result<u64, ()> { | ||
if buf.len() < 8 { return Err(()) } | ||
let val = (buf[0] as u64) << 0 | ||
| (buf[1] as u64) << 8 | ||
| (buf[2] as u64) << 16 | ||
| (buf[3] as u64) << 24 | ||
| (buf[4] as u64) << 32 | ||
| (buf[5] as u64) << 40 | ||
| (buf[6] as u64) << 48 | ||
| (buf[7] as u64) << 56; | ||
*buf = &buf[8..]; | ||
Ok(val) | ||
} | ||
|
||
fn read_u32_le(buf: &mut &[u8]) -> Result<u32, ()> { | ||
if buf.len() < 4 { return Err(()) } | ||
let val = (buf[0] as u32) << 0 | ||
| (buf[1] as u32) << 8 | ||
| (buf[2] as u32) << 16 | ||
| (buf[3] as u32) << 24; | ||
*buf = &buf[4..]; | ||
Ok(val) | ||
} | ||
|
||
fn read_u16_le(buf: &mut &[u8]) -> Result<u16, ()> { | ||
if buf.len() < 2 { return Err(()) } | ||
let val = (buf[0] as u16) << 0 | ||
| (buf[1] as u16) << 8; | ||
*buf = &buf[2..]; | ||
Ok(val) | ||
} | ||
|
||
fn read_u8(buf: &mut &[u8]) -> Result<u8, ()> { | ||
if buf.len() < 1 { return Err(()) } | ||
let val = buf[0]; | ||
*buf = &buf[1..]; | ||
Ok(val) | ||
} |
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.
Would it be worth to limit this
unsafe
block only totransmute
instruction? (doesn't look like anything else in the function needs it)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.
All union accesses are unsafe, afaik
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.
@gankro Writing to a union doesn't require unsafe block, only reading does.
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 read the union at the start of the match, and if we're being honest, writing to the unions is Pretty Unsafe. It's just not
unsafe
for rules-lawyer reasons.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.
@gankro Writing to unions just puts contents into Schrodinger's state - they might or might be not corrupt until you try to read them 😄