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

Document #[repr] on non-C-like enums #25651

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/doc/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1892,12 +1892,13 @@ interpreted:

On `enum`s:

- `repr` - on C-like enums, this sets the underlying type used for
representation. Takes one argument, which is the primitive
type this enum should be represented for, or `C`, which specifies that it
should be the default `enum` size of the C ABI for that platform. Note that
enum representation in C is undefined, and this may be incorrect when the C
code is compiled with certain flags.
- `repr` - this sets the underlying type used for representation of the
discriminant. Takes one argument, which is the primitive type this enum
should be represented as, or `C`, which specifies that it should be the
default `enum` size of the C ABI for that platform. Note that enum
representation in C is implementation defined, and this may be incorrect when
the C code is compiled with certain flags. The representation attribute
inhibits elision of the enum discriminant in layout optimizations.

On `struct`s:

Expand Down
107 changes: 107 additions & 0 deletions src/test/run-pass/enum-discrim-manual-sizing-2.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
// Copyright 2013 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.

// Test that explicit discriminant sizing inhibits the non-nullable pointer
// optimization in enum layout.

use std::mem::size_of;

#[repr(i8)]
enum Ei8<T> {
_None,
_Some(T),
}

#[repr(u8)]
enum Eu8<T> {
_None,
_Some(T),
}

#[repr(i16)]
enum Ei16<T> {
_None,
_Some(T),
}

#[repr(u16)]
enum Eu16<T> {
_None,
_Some(T),
}

#[repr(i32)]
enum Ei32<T> {
_None,
_Some(T),
}

#[repr(u32)]
enum Eu32<T> {
_None,
_Some(T),
}

#[repr(i64)]
enum Ei64<T> {
_None,
_Some(T),
}

#[repr(u64)]
enum Eu64<T> {
_None,
_Some(T),
}

#[repr(isize)]
enum Eint<T> {
_None,
_Some(T),
}

#[repr(usize)]
enum Euint<T> {
_None,
_Some(T),
}

#[repr(C)]
enum EC<T> {
_None,
_Some(T),
}

pub fn main() {
assert_eq!(size_of::<Ei8<()>>(), 1);
assert_eq!(size_of::<Eu8<()>>(), 1);
assert_eq!(size_of::<Ei16<()>>(), 2);
assert_eq!(size_of::<Eu16<()>>(), 2);
assert_eq!(size_of::<Ei32<()>>(), 4);
assert_eq!(size_of::<Eu32<()>>(), 4);
assert_eq!(size_of::<Ei64<()>>(), 8);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thread '<main>' panicked at 'assertion failed:(left == right)(left:4, right:8)', /Users/rustbuild/src/rust-buildbot/slave/auto-mac-32-opt/build/src/test/run-pass/enum-discrim-manual-sizing-2.rs:89

on 32-bit. Looks like there is a bug in #[repr]?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm yes, that sounds like a bug in #[repr]

assert_eq!(size_of::<Eu64<()>>(), 8);
assert_eq!(size_of::<Eint<()>>(), size_of::<isize>());
assert_eq!(size_of::<Euint<()>>(), size_of::<usize>());

let ptrsize = size_of::<&i32>();
assert!(size_of::<Ei8<&i32>>() > ptrsize);
assert!(size_of::<Eu8<&i32>>() > ptrsize);
assert!(size_of::<Ei16<&i32>>() > ptrsize);
assert!(size_of::<Eu16<&i32>>() > ptrsize);
assert!(size_of::<Ei32<&i32>>() > ptrsize);
assert!(size_of::<Eu32<&i32>>() > ptrsize);
assert!(size_of::<Ei64<&i32>>() > ptrsize);
assert!(size_of::<Eu64<&i32>>() > ptrsize);
assert!(size_of::<Eint<&i32>>() > ptrsize);
assert!(size_of::<Euint<&i32>>() > ptrsize);

assert!(size_of::<EC<&i32>>() > ptrsize);
}