Rollup merge of #133702 - RalfJung:single-variant, r=oli-obk

Variants::Single: do not use invalid VariantIdx for uninhabited enums

~~Stacked on top of https://github.com/rust-lang/rust/pull/133681, only the last commit is new.~~

Currently, `Variants::Single` for an empty enum contains a `VariantIdx` of 0; looking that up in the enum variant list will ICE. That's quite confusing. So let's fix that by adding a new `Variants::Empty` case for types that have 0 variants.

try-job: i686-msvc
This commit is contained in:
许杰友 Jieyou Xu (Joe) 2024-12-19 16:48:07 +08:00 committed by GitHub
commit 2a43ce03fb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
33 changed files with 186 additions and 165 deletions

View file

@ -206,7 +206,7 @@ impl<'a, Ty> TyAndLayout<'a, Ty> {
let (mut result, mut total) = from_fields_at(*self, Size::ZERO)?; let (mut result, mut total) = from_fields_at(*self, Size::ZERO)?;
match &self.variants { match &self.variants {
abi::Variants::Single { .. } => {} abi::Variants::Single { .. } | abi::Variants::Empty => {}
abi::Variants::Multiple { variants, .. } => { abi::Variants::Multiple { variants, .. } => {
// Treat enum variants like union members. // Treat enum variants like union members.
// HACK(eddyb) pretend the `enum` field (discriminant) // HACK(eddyb) pretend the `enum` field (discriminant)

View file

@ -213,8 +213,9 @@ impl<Cx: HasDataLayout> LayoutCalculator<Cx> {
&self, &self,
) -> LayoutData<FieldIdx, VariantIdx> { ) -> LayoutData<FieldIdx, VariantIdx> {
let dl = self.cx.data_layout(); let dl = self.cx.data_layout();
// This is also used for uninhabited enums, so we use `Variants::Empty`.
LayoutData { LayoutData {
variants: Variants::Single { index: VariantIdx::new(0) }, variants: Variants::Empty,
fields: FieldsShape::Primitive, fields: FieldsShape::Primitive,
backend_repr: BackendRepr::Uninhabited, backend_repr: BackendRepr::Uninhabited,
largest_niche: None, largest_niche: None,
@ -1004,8 +1005,8 @@ impl<Cx: HasDataLayout> LayoutCalculator<Cx> {
Variants::Multiple { tag, tag_encoding, tag_field, .. } => { Variants::Multiple { tag, tag_encoding, tag_field, .. } => {
Variants::Multiple { tag, tag_encoding, tag_field, variants: best_layout.variants } Variants::Multiple { tag, tag_encoding, tag_field, variants: best_layout.variants }
} }
Variants::Single { .. } => { Variants::Single { .. } | Variants::Empty => {
panic!("encountered a single-variant enum during multi-variant layout") panic!("encountered a single-variant or empty enum during multi-variant layout")
} }
}; };
Ok(best_layout.layout) Ok(best_layout.layout)

View file

@ -1504,10 +1504,12 @@ impl BackendRepr {
#[derive(PartialEq, Eq, Hash, Clone, Debug)] #[derive(PartialEq, Eq, Hash, Clone, Debug)]
#[cfg_attr(feature = "nightly", derive(HashStable_Generic))] #[cfg_attr(feature = "nightly", derive(HashStable_Generic))]
pub enum Variants<FieldIdx: Idx, VariantIdx: Idx> { pub enum Variants<FieldIdx: Idx, VariantIdx: Idx> {
/// A type with no valid variants. Must be uninhabited.
Empty,
/// Single enum variants, structs/tuples, unions, and all non-ADTs. /// Single enum variants, structs/tuples, unions, and all non-ADTs.
Single { Single {
/// Always 0 for non-enums/generators. /// Always `0` for types that cannot have multiple variants.
/// For enums without a variant, this is an invalid index!
index: VariantIdx, index: VariantIdx,
}, },

View file

@ -18,6 +18,7 @@ pub(crate) fn codegen_set_discriminant<'tcx>(
return; return;
} }
match layout.variants { match layout.variants {
Variants::Empty => unreachable!("we already handled uninhabited types"),
Variants::Single { index } => { Variants::Single { index } => {
assert_eq!(index, variant_index); assert_eq!(index, variant_index);
} }
@ -85,6 +86,7 @@ pub(crate) fn codegen_get_discriminant<'tcx>(
} }
let (tag_scalar, tag_field, tag_encoding) = match &layout.variants { let (tag_scalar, tag_field, tag_encoding) = match &layout.variants {
Variants::Empty => unreachable!("we already handled uninhabited types"),
Variants::Single { index } => { Variants::Single { index } => {
let discr_val = layout let discr_val = layout
.ty .ty

View file

@ -212,21 +212,17 @@ pub(super) fn build_enum_type_di_node<'ll, 'tcx>(
), ),
|cx, enum_type_di_node| { |cx, enum_type_di_node| {
match enum_type_and_layout.variants { match enum_type_and_layout.variants {
Variants::Single { index: variant_index } => { Variants::Empty => {
if enum_adt_def.variants().is_empty() { // We don't generate any members for uninhabited types.
// Uninhabited enums have Variants::Single. We don't generate
// any members for them.
return smallvec![]; return smallvec![];
} }
Variants::Single { index: variant_index } => build_single_variant_union_fields(
build_single_variant_union_fields(
cx, cx,
enum_adt_def, enum_adt_def,
enum_type_and_layout, enum_type_and_layout,
enum_type_di_node, enum_type_di_node,
variant_index, variant_index,
) ),
}
Variants::Multiple { Variants::Multiple {
tag_encoding: TagEncoding::Direct, tag_encoding: TagEncoding::Direct,
ref variants, ref variants,
@ -303,6 +299,7 @@ pub(super) fn build_coroutine_di_node<'ll, 'tcx>(
) )
} }
Variants::Single { .. } Variants::Single { .. }
| Variants::Empty
| Variants::Multiple { tag_encoding: TagEncoding::Niche { .. }, .. } => { | Variants::Multiple { tag_encoding: TagEncoding::Niche { .. }, .. } => {
bug!( bug!(
"Encountered coroutine with non-direct-tag layout: {:?}", "Encountered coroutine with non-direct-tag layout: {:?}",

View file

@ -392,7 +392,7 @@ fn compute_discriminant_value<'ll, 'tcx>(
variant_index: VariantIdx, variant_index: VariantIdx,
) -> DiscrResult { ) -> DiscrResult {
match enum_type_and_layout.layout.variants() { match enum_type_and_layout.layout.variants() {
&Variants::Single { .. } => DiscrResult::NoDiscriminant, &Variants::Single { .. } | &Variants::Empty => DiscrResult::NoDiscriminant,
&Variants::Multiple { tag_encoding: TagEncoding::Direct, .. } => DiscrResult::Value( &Variants::Multiple { tag_encoding: TagEncoding::Direct, .. } => DiscrResult::Value(
enum_type_and_layout.ty.discriminant_for_variant(cx.tcx, variant_index).unwrap().val, enum_type_and_layout.ty.discriminant_for_variant(cx.tcx, variant_index).unwrap().val,
), ),

View file

@ -358,8 +358,8 @@ fn build_discr_member_di_node<'ll, 'tcx>(
let containing_scope = enum_or_coroutine_type_di_node; let containing_scope = enum_or_coroutine_type_di_node;
match enum_or_coroutine_type_and_layout.layout.variants() { match enum_or_coroutine_type_and_layout.layout.variants() {
// A single-variant enum has no discriminant. // A single-variant or no-variant enum has no discriminant.
&Variants::Single { .. } => None, &Variants::Single { .. } | &Variants::Empty => None,
&Variants::Multiple { tag_field, .. } => { &Variants::Multiple { tag_field, .. } => {
let tag_base_type = tag_base_type(cx.tcx, enum_or_coroutine_type_and_layout); let tag_base_type = tag_base_type(cx.tcx, enum_or_coroutine_type_and_layout);

View file

@ -38,7 +38,7 @@ fn uncached_llvm_type<'a, 'tcx>(
if let (&ty::Adt(def, _), &Variants::Single { index }) = if let (&ty::Adt(def, _), &Variants::Single { index }) =
(layout.ty.kind(), &layout.variants) (layout.ty.kind(), &layout.variants)
{ {
if def.is_enum() && !def.variants().is_empty() { if def.is_enum() {
write!(&mut name, "::{}", def.variant(index).name).unwrap(); write!(&mut name, "::{}", def.variant(index).name).unwrap();
} }
} }

View file

@ -65,8 +65,8 @@ fn tag_base_type_opt<'tcx>(
}); });
match enum_type_and_layout.layout.variants() { match enum_type_and_layout.layout.variants() {
// A single-variant enum has no discriminant. // A single-variant or no-variant enum has no discriminant.
Variants::Single { .. } => None, Variants::Single { .. } | Variants::Empty => None,
Variants::Multiple { tag_encoding: TagEncoding::Niche { .. }, tag, .. } => { Variants::Multiple { tag_encoding: TagEncoding::Niche { .. }, tag, .. } => {
// Niche tags are always normalized to unsized integers of the correct size. // Niche tags are always normalized to unsized integers of the correct size.

View file

@ -243,6 +243,7 @@ impl<'a, 'tcx, V: CodegenObject> PlaceRef<'tcx, V> {
return bx.cx().const_poison(cast_to); return bx.cx().const_poison(cast_to);
} }
let (tag_scalar, tag_encoding, tag_field) = match self.layout.variants { let (tag_scalar, tag_encoding, tag_field) = match self.layout.variants {
Variants::Empty => unreachable!("we already handled uninhabited types"),
Variants::Single { index } => { Variants::Single { index } => {
let discr_val = self let discr_val = self
.layout .layout
@ -365,9 +366,9 @@ impl<'a, 'tcx, V: CodegenObject> PlaceRef<'tcx, V> {
return; return;
} }
match self.layout.variants { match self.layout.variants {
Variants::Single { index } => { Variants::Empty => unreachable!("we already handled uninhabited types"),
assert_eq!(index, variant_index); Variants::Single { index } => assert_eq!(index, variant_index),
}
Variants::Multiple { tag_encoding: TagEncoding::Direct, tag_field, .. } => { Variants::Multiple { tag_encoding: TagEncoding::Direct, tag_field, .. } => {
let ptr = self.project_field(bx, tag_field); let ptr = self.project_field(bx, tag_field);
let to = let to =

View file

@ -44,7 +44,7 @@ impl<'tcx, M: Machine<'tcx>> InterpCx<'tcx, M> {
} }
} }
/// Read discriminant, return the runtime value as well as the variant index. /// Read discriminant, return the variant index.
/// Can also legally be called on non-enums (e.g. through the discriminant_value intrinsic)! /// Can also legally be called on non-enums (e.g. through the discriminant_value intrinsic)!
/// ///
/// Will never return an uninhabited variant. /// Will never return an uninhabited variant.
@ -65,21 +65,17 @@ impl<'tcx, M: Machine<'tcx>> InterpCx<'tcx, M> {
// We use "tag" to refer to how the discriminant is encoded in memory, which can be either // We use "tag" to refer to how the discriminant is encoded in memory, which can be either
// straight-forward (`TagEncoding::Direct`) or with a niche (`TagEncoding::Niche`). // straight-forward (`TagEncoding::Direct`) or with a niche (`TagEncoding::Niche`).
let (tag_scalar_layout, tag_encoding, tag_field) = match op.layout().variants { let (tag_scalar_layout, tag_encoding, tag_field) = match op.layout().variants {
Variants::Single { index } => { Variants::Empty => {
// Do some extra checks on enums. throw_ub!(UninhabitedEnumVariantRead(None));
if ty.is_enum() {
// Hilariously, `Single` is used even for 0-variant enums.
// (See https://github.com/rust-lang/rust/issues/89765).
if ty.ty_adt_def().unwrap().variants().is_empty() {
throw_ub!(UninhabitedEnumVariantRead(index))
} }
Variants::Single { index } => {
if op.layout().is_uninhabited() {
// For consistency with `write_discriminant`, and to make sure that // For consistency with `write_discriminant`, and to make sure that
// `project_downcast` cannot fail due to strange layouts, we declare immediate UB // `project_downcast` cannot fail due to strange layouts, we declare immediate UB
// for uninhabited variants. // for uninhabited enums.
if op.layout().for_variant(self, index).is_uninhabited() { throw_ub!(UninhabitedEnumVariantRead(Some(index)));
throw_ub!(UninhabitedEnumVariantRead(index))
}
} }
// Since the type is inhabited, there must be an index.
return interp_ok(index); return interp_ok(index);
} }
Variants::Multiple { tag, ref tag_encoding, tag_field, .. } => { Variants::Multiple { tag, ref tag_encoding, tag_field, .. } => {
@ -199,11 +195,13 @@ impl<'tcx, M: Machine<'tcx>> InterpCx<'tcx, M> {
// `uninhabited_enum_branching` MIR pass. It also ensures consistency with // `uninhabited_enum_branching` MIR pass. It also ensures consistency with
// `write_discriminant`. // `write_discriminant`.
if op.layout().for_variant(self, index).is_uninhabited() { if op.layout().for_variant(self, index).is_uninhabited() {
throw_ub!(UninhabitedEnumVariantRead(index)) throw_ub!(UninhabitedEnumVariantRead(Some(index)))
} }
interp_ok(index) interp_ok(index)
} }
/// Read discriminant, return the user-visible discriminant.
/// Can also legally be called on non-enums (e.g. through the discriminant_value intrinsic)!
pub fn discriminant_for_variant( pub fn discriminant_for_variant(
&self, &self,
ty: Ty<'tcx>, ty: Ty<'tcx>,
@ -243,6 +241,7 @@ impl<'tcx, M: Machine<'tcx>> InterpCx<'tcx, M> {
} }
match layout.variants { match layout.variants {
abi::Variants::Empty => unreachable!("we already handled uninhabited types"),
abi::Variants::Single { .. } => { abi::Variants::Single { .. } => {
// The tag of a `Single` enum is like the tag of the niched // The tag of a `Single` enum is like the tag of the niched
// variant: there's no tag as the discriminant is encoded // variant: there's no tag as the discriminant is encoded

View file

@ -302,7 +302,7 @@ impl<'rt, 'tcx, M: Machine<'tcx>> ValidityVisitor<'rt, 'tcx, M> {
}; };
} }
} }
Variants::Single { .. } => {} Variants::Single { .. } | Variants::Empty => {}
} }
// Now we know we are projecting to a field, so figure out which one. // Now we know we are projecting to a field, so figure out which one.
@ -344,6 +344,7 @@ impl<'rt, 'tcx, M: Machine<'tcx>> ValidityVisitor<'rt, 'tcx, M> {
// Inside a variant // Inside a variant
PathElem::Field(def.variant(index).fields[FieldIdx::from_usize(field)].name) PathElem::Field(def.variant(index).fields[FieldIdx::from_usize(field)].name)
} }
Variants::Empty => panic!("there is no field in Variants::Empty types"),
Variants::Multiple { .. } => bug!("we handled variants above"), Variants::Multiple { .. } => bug!("we handled variants above"),
} }
} }
@ -1010,7 +1011,7 @@ impl<'rt, 'tcx, M: Machine<'tcx>> ValidityVisitor<'rt, 'tcx, M> {
} }
// Don't forget potential other variants. // Don't forget potential other variants.
match &layout.variants { match &layout.variants {
Variants::Single { .. } => { Variants::Single { .. } | Variants::Empty => {
// Fully handled above. // Fully handled above.
} }
Variants::Multiple { variants, .. } => { Variants::Multiple { variants, .. } => {

View file

@ -218,8 +218,8 @@ pub trait ValueVisitor<'tcx, M: Machine<'tcx>>: Sized {
// recurse with the inner type // recurse with the inner type
self.visit_variant(v, idx, &inner)?; self.visit_variant(v, idx, &inner)?;
} }
// For single-variant layouts, we already did anything there is to do. // For single-variant layouts, we already did everything there is to do.
Variants::Single { .. } => {} Variants::Single { .. } | Variants::Empty => {}
} }
interp_ok(()) interp_ok(())

View file

@ -155,6 +155,7 @@ fn check_validity_requirement_lax<'tcx>(
} }
match &this.variants { match &this.variants {
Variants::Empty => return Ok(false),
Variants::Single { .. } => { Variants::Single { .. } => {
// All fields of this single variant have already been checked above, there is nothing // All fields of this single variant have already been checked above, there is nothing
// else to do. // else to do.

View file

@ -392,7 +392,7 @@ pub enum UndefinedBehaviorInfo<'tcx> {
/// A discriminant of an uninhabited enum variant is written. /// A discriminant of an uninhabited enum variant is written.
UninhabitedEnumVariantWritten(VariantIdx), UninhabitedEnumVariantWritten(VariantIdx),
/// An uninhabited enum variant is projected. /// An uninhabited enum variant is projected.
UninhabitedEnumVariantRead(VariantIdx), UninhabitedEnumVariantRead(Option<VariantIdx>),
/// Trying to set discriminant to the niched variant, but the value does not match. /// Trying to set discriminant to the niched variant, but the value does not match.
InvalidNichedEnumVariantWritten { enum_ty: Ty<'tcx> }, InvalidNichedEnumVariantWritten { enum_ty: Ty<'tcx> },
/// ABI-incompatible argument types. /// ABI-incompatible argument types.

View file

@ -734,21 +734,22 @@ where
let layout = match this.variants { let layout = match this.variants {
Variants::Single { index } Variants::Single { index }
// If all variants but one are uninhabited, the variant layout is the enum layout. // If all variants but one are uninhabited, the variant layout is the enum layout.
if index == variant_index && if index == variant_index =>
// Don't confuse variants of uninhabited enums with the enum itself.
// For more details see https://github.com/rust-lang/rust/issues/69763.
this.fields != FieldsShape::Primitive =>
{ {
this.layout this.layout
} }
Variants::Single { index } => { Variants::Single { .. } | Variants::Empty => {
// Single-variant and no-variant enums *can* have other variants, but those are
// uninhabited. Produce a layout that has the right fields for that variant, so that
// the rest of the compiler can project fields etc as usual.
let tcx = cx.tcx(); let tcx = cx.tcx();
let typing_env = cx.typing_env(); let typing_env = cx.typing_env();
// Deny calling for_variant more than once for non-Single enums. // Deny calling for_variant more than once for non-Single enums.
if let Ok(original_layout) = tcx.layout_of(typing_env.as_query_input(this.ty)) { if let Ok(original_layout) = tcx.layout_of(typing_env.as_query_input(this.ty)) {
assert_eq!(original_layout.variants, Variants::Single { index }); assert_eq!(original_layout.variants, this.variants);
} }
let fields = match this.ty.kind() { let fields = match this.ty.kind() {
@ -902,6 +903,7 @@ where
), ),
ty::Coroutine(def_id, args) => match this.variants { ty::Coroutine(def_id, args) => match this.variants {
Variants::Empty => unreachable!(),
Variants::Single { index } => TyMaybeWithLayout::Ty( Variants::Single { index } => TyMaybeWithLayout::Ty(
args.as_coroutine() args.as_coroutine()
.state_tys(def_id, tcx) .state_tys(def_id, tcx)
@ -927,6 +929,7 @@ where
let field = &def.variant(index).fields[FieldIdx::from_usize(i)]; let field = &def.variant(index).fields[FieldIdx::from_usize(i)];
TyMaybeWithLayout::Ty(field.ty(tcx, args)) TyMaybeWithLayout::Ty(field.ty(tcx, args))
} }
Variants::Empty => panic!("there is no field in Variants::Empty types"),
// Discriminant field for enums (where applicable). // Discriminant field for enums (where applicable).
Variants::Multiple { tag, .. } => { Variants::Multiple { tag, .. } => {

View file

@ -35,7 +35,6 @@
//! Likewise, applying the optimisation can create a lot of new MIR, so we bound the instruction //! Likewise, applying the optimisation can create a lot of new MIR, so we bound the instruction
//! cost by `MAX_COST`. //! cost by `MAX_COST`.
use rustc_abi::{TagEncoding, Variants};
use rustc_arena::DroplessArena; use rustc_arena::DroplessArena;
use rustc_const_eval::const_eval::DummyMachine; use rustc_const_eval::const_eval::DummyMachine;
use rustc_const_eval::interpret::{ImmTy, Immediate, InterpCx, OpTy, Projectable}; use rustc_const_eval::interpret::{ImmTy, Immediate, InterpCx, OpTy, Projectable};
@ -565,24 +564,9 @@ impl<'a, 'tcx> TOFinder<'a, 'tcx> {
StatementKind::SetDiscriminant { box place, variant_index } => { StatementKind::SetDiscriminant { box place, variant_index } => {
let Some(discr_target) = self.map.find_discr(place.as_ref()) else { return }; let Some(discr_target) = self.map.find_discr(place.as_ref()) else { return };
let enum_ty = place.ty(self.body, self.tcx).ty; let enum_ty = place.ty(self.body, self.tcx).ty;
// `SetDiscriminant` may be a no-op if the assigned variant is the untagged variant // `SetDiscriminant` guarantees that the discriminant is now `variant_index`.
// of a niche encoding. If we cannot ensure that we write to the discriminant, do // Even if the discriminant write does nothing due to niches, it is UB to set the
// nothing. // discriminant when the data does not encode the desired discriminant.
let Ok(enum_layout) = self.ecx.layout_of(enum_ty) else {
return;
};
let writes_discriminant = match enum_layout.variants {
Variants::Single { index } => {
assert_eq!(index, *variant_index);
true
}
Variants::Multiple { tag_encoding: TagEncoding::Direct, .. } => true,
Variants::Multiple {
tag_encoding: TagEncoding::Niche { untagged_variant, .. },
..
} => *variant_index != untagged_variant,
};
if writes_discriminant {
let Some(discr) = let Some(discr) =
self.ecx.discriminant_for_variant(enum_ty, *variant_index).discard_err() self.ecx.discriminant_for_variant(enum_ty, *variant_index).discard_err()
else { else {
@ -590,7 +574,6 @@ impl<'a, 'tcx> TOFinder<'a, 'tcx> {
}; };
self.process_immediate(bb, discr_target, discr, state); self.process_immediate(bb, discr_target, discr, state);
} }
}
// If we expect `lhs ?= true`, we have an opportunity if we assume `lhs == true`. // If we expect `lhs ?= true`, we have an opportunity if we assume `lhs == true`.
StatementKind::Intrinsic(box NonDivergingIntrinsic::Assume( StatementKind::Intrinsic(box NonDivergingIntrinsic::Assume(
Operand::Copy(place) | Operand::Move(place), Operand::Copy(place) | Operand::Move(place),

View file

@ -216,7 +216,7 @@ impl EnumSizeOpt {
}; };
let layout = tcx.layout_of(typing_env.as_query_input(ty)).ok()?; let layout = tcx.layout_of(typing_env.as_query_input(ty)).ok()?;
let variants = match &layout.variants { let variants = match &layout.variants {
Variants::Single { .. } => return None, Variants::Single { .. } | Variants::Empty => return None,
Variants::Multiple { tag_encoding: TagEncoding::Niche { .. }, .. } => return None, Variants::Multiple { tag_encoding: TagEncoding::Niche { .. }, .. } => return None,
Variants::Multiple { variants, .. } if variants.len() <= 1 => return None, Variants::Multiple { variants, .. } if variants.len() <= 1 => return None,

View file

@ -54,6 +54,10 @@ fn variant_discriminants<'tcx>(
tcx: TyCtxt<'tcx>, tcx: TyCtxt<'tcx>,
) -> FxHashSet<u128> { ) -> FxHashSet<u128> {
match &layout.variants { match &layout.variants {
Variants::Empty => {
// Uninhabited, no valid discriminant.
FxHashSet::default()
}
Variants::Single { index } => { Variants::Single { index } => {
let mut res = FxHashSet::default(); let mut res = FxHashSet::default();
res.insert( res.insert(

View file

@ -167,6 +167,7 @@ impl<'tcx> Stable<'tcx> for rustc_abi::Variants<rustc_abi::FieldIdx, rustc_abi::
rustc_abi::Variants::Single { index } => { rustc_abi::Variants::Single { index } => {
VariantsShape::Single { index: index.stable(tables) } VariantsShape::Single { index: index.stable(tables) }
} }
rustc_abi::Variants::Empty => VariantsShape::Empty,
rustc_abi::Variants::Multiple { tag, tag_encoding, tag_field, variants } => { rustc_abi::Variants::Multiple { tag, tag_encoding, tag_field, variants } => {
VariantsShape::Multiple { VariantsShape::Multiple {
tag: tag.stable(tables), tag: tag.stable(tables),

View file

@ -116,7 +116,7 @@ where
FieldsShape::Arbitrary { .. } => { FieldsShape::Arbitrary { .. } => {
match arg_layout.variants { match arg_layout.variants {
abi::Variants::Multiple { .. } => return Err(CannotUseFpConv), abi::Variants::Multiple { .. } => return Err(CannotUseFpConv),
abi::Variants::Single { .. } => (), abi::Variants::Single { .. } | abi::Variants::Empty => (),
} }
for i in arg_layout.fields.index_by_increasing_offset() { for i in arg_layout.fields.index_by_increasing_offset() {
let field = arg_layout.field(cx, i); let field = arg_layout.field(cx, i);

View file

@ -122,7 +122,7 @@ where
FieldsShape::Arbitrary { .. } => { FieldsShape::Arbitrary { .. } => {
match arg_layout.variants { match arg_layout.variants {
abi::Variants::Multiple { .. } => return Err(CannotUseFpConv), abi::Variants::Multiple { .. } => return Err(CannotUseFpConv),
abi::Variants::Single { .. } => (), abi::Variants::Single { .. } | abi::Variants::Empty => (),
} }
for i in arg_layout.fields.index_by_increasing_offset() { for i in arg_layout.fields.index_by_increasing_offset() {
let field = arg_layout.field(cx, i); let field = arg_layout.field(cx, i);

View file

@ -65,7 +65,7 @@ where
} }
match &layout.variants { match &layout.variants {
abi::Variants::Single { .. } => {} abi::Variants::Single { .. } | abi::Variants::Empty => {}
abi::Variants::Multiple { variants, .. } => { abi::Variants::Multiple { variants, .. } => {
// Treat enum variants like union members. // Treat enum variants like union members.
for variant_idx in variants.indices() { for variant_idx in variants.indices() {

View file

@ -338,17 +338,12 @@ pub(crate) mod rustc {
}; };
match layout.variants() { match layout.variants() {
Variants::Empty => Ok(Self::uninhabited()),
Variants::Single { index } => { Variants::Single { index } => {
// Hilariously, `Single` is used even for 0-variant enums;
// `index` is just junk in that case.
if ty.ty_adt_def().unwrap().variants().is_empty() {
Ok(Self::uninhabited())
} else {
// `Variants::Single` on enums with variants denotes that // `Variants::Single` on enums with variants denotes that
// the enum delegates its layout to the variant at `index`. // the enum delegates its layout to the variant at `index`.
layout_of_variant(*index, None) layout_of_variant(*index, None)
} }
}
Variants::Multiple { tag, tag_encoding, tag_field, .. } => { Variants::Multiple { tag, tag_encoding, tag_field, .. } => {
// `Variants::Multiple` denotes an enum with multiple // `Variants::Multiple` denotes an enum with multiple
// variants. The layout of such an enum is the disjunction // variants. The layout of such an enum is the disjunction
@ -500,6 +495,10 @@ pub(crate) mod rustc {
(ty, layout): (Ty<'tcx>, Layout<'tcx>), (ty, layout): (Ty<'tcx>, Layout<'tcx>),
i: FieldIdx, i: FieldIdx,
) -> Ty<'tcx> { ) -> Ty<'tcx> {
// We cannot use `ty_and_layout_field` to retrieve the field type, since
// `ty_and_layout_field` erases regions in the returned type. We must
// not erase regions here, since we may need to ultimately emit outlives
// obligations as a consequence of the transmutability analysis.
match ty.kind() { match ty.kind() {
ty::Adt(def, args) => { ty::Adt(def, args) => {
match layout.variants { match layout.variants {
@ -507,6 +506,7 @@ pub(crate) mod rustc {
let field = &def.variant(index).fields[i]; let field = &def.variant(index).fields[i];
field.ty(cx.tcx(), args) field.ty(cx.tcx(), args)
} }
Variants::Empty => panic!("there is no field in Variants::Empty types"),
// Discriminant field for enums (where applicable). // Discriminant field for enums (where applicable).
Variants::Multiple { tag, .. } => { Variants::Multiple { tag, .. } => {
assert_eq!(i.as_usize(), 0); assert_eq!(i.as_usize(), 0);

View file

@ -1104,15 +1104,13 @@ fn variant_info_for_adt<'tcx>(
}; };
match layout.variants { match layout.variants {
Variants::Empty => (vec![], None),
Variants::Single { index } => { Variants::Single { index } => {
if !adt_def.variants().is_empty() && layout.fields != FieldsShape::Primitive {
debug!("print-type-size `{:#?}` variant {}", layout, adt_def.variant(index).name); debug!("print-type-size `{:#?}` variant {}", layout, adt_def.variant(index).name);
let variant_def = &adt_def.variant(index); let variant_def = &adt_def.variant(index);
let fields: Vec<_> = variant_def.fields.iter().map(|f| f.name).collect(); let fields: Vec<_> = variant_def.fields.iter().map(|f| f.name).collect();
(vec![build_variant_info(Some(variant_def.name), &fields, layout)], None) (vec![build_variant_info(Some(variant_def.name), &fields, layout)], None)
} else {
(vec![], None)
}
} }
Variants::Multiple { tag, ref tag_encoding, .. } => { Variants::Multiple { tag, ref tag_encoding, .. } => {

View file

@ -241,8 +241,22 @@ pub(super) fn layout_sanity_check<'tcx>(cx: &LayoutCx<'tcx>, layout: &TyAndLayou
check_layout_abi(cx, layout); check_layout_abi(cx, layout);
if let Variants::Multiple { variants, tag, tag_encoding, .. } = &layout.variants { match &layout.variants {
if let TagEncoding::Niche { niche_start, untagged_variant, niche_variants } = tag_encoding { Variants::Empty => {
assert!(layout.is_uninhabited());
}
Variants::Single { index } => {
if let Some(variants) = layout.ty.variant_range(tcx) {
assert!(variants.contains(index));
} else {
// Types without variants use `0` as dummy variant index.
assert!(index.as_u32() == 0);
}
}
Variants::Multiple { variants, tag, tag_encoding, .. } => {
if let TagEncoding::Niche { niche_start, untagged_variant, niche_variants } =
tag_encoding
{
let niche_size = tag.size(cx); let niche_size = tag.size(cx);
assert!(*niche_start <= niche_size.unsigned_int_max()); assert!(*niche_start <= niche_size.unsigned_int_max());
for (idx, variant) in variants.iter_enumerated() { for (idx, variant) in variants.iter_enumerated() {
@ -272,7 +286,9 @@ pub(super) fn layout_sanity_check<'tcx>(cx: &LayoutCx<'tcx>, layout: &TyAndLayou
) )
} }
// Skip empty variants. // Skip empty variants.
if variant.size == Size::ZERO || variant.fields.count() == 0 || variant.is_uninhabited() if variant.size == Size::ZERO
|| variant.fields.count() == 0
|| variant.is_uninhabited()
{ {
// These are never actually accessed anyway, so we can skip the coherence check // These are never actually accessed anyway, so we can skip the coherence check
// for them. They also fail that check, since they have // for them. They also fail that check, since they have
@ -282,8 +298,9 @@ pub(super) fn layout_sanity_check<'tcx>(cx: &LayoutCx<'tcx>, layout: &TyAndLayou
continue; continue;
} }
// The top-level ABI and the ABI of the variants should be coherent. // The top-level ABI and the ABI of the variants should be coherent.
let scalar_coherent = let scalar_coherent = |s1: Scalar, s2: Scalar| {
|s1: Scalar, s2: Scalar| s1.size(cx) == s2.size(cx) && s1.align(cx) == s2.align(cx); s1.size(cx) == s2.size(cx) && s1.align(cx) == s2.align(cx)
};
let abi_coherent = match (layout.backend_repr, variant.backend_repr) { let abi_coherent = match (layout.backend_repr, variant.backend_repr) {
(BackendRepr::Scalar(s1), BackendRepr::Scalar(s2)) => scalar_coherent(s1, s2), (BackendRepr::Scalar(s1), BackendRepr::Scalar(s2)) => scalar_coherent(s1, s2),
(BackendRepr::ScalarPair(a1, b1), BackendRepr::ScalarPair(a2, b2)) => { (BackendRepr::ScalarPair(a1, b1), BackendRepr::ScalarPair(a2, b2)) => {
@ -301,4 +318,5 @@ pub(super) fn layout_sanity_check<'tcx>(cx: &LayoutCx<'tcx>, layout: &TyAndLayou
} }
} }
} }
}
} }

View file

@ -180,6 +180,9 @@ impl FieldsShape {
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)] #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub enum VariantsShape { pub enum VariantsShape {
/// A type with no valid variants. Must be uninhabited.
Empty,
/// Single enum variants, structs/tuples, unions, and all non-ADTs. /// Single enum variants, structs/tuples, unions, and all non-ADTs.
Single { index: VariantIdx }, Single { index: VariantIdx },

View file

@ -605,7 +605,7 @@ pub trait EvalContextExt<'tcx>: crate::MiriInterpCxExt<'tcx> {
// `UnsafeCell` action. // `UnsafeCell` action.
(self.unsafe_cell_action)(v) (self.unsafe_cell_action)(v)
} }
Variants::Single { .. } => { Variants::Single { .. } | Variants::Empty => {
// Proceed further, try to find where exactly that `UnsafeCell` // Proceed further, try to find where exactly that `UnsafeCell`
// is hiding. // is hiding.
self.walk_value(v) self.walk_value(v)

View file

@ -813,7 +813,7 @@ impl Evaluator<'_> {
ProjectionElem::Field(Either::Left(f)) => { ProjectionElem::Field(Either::Left(f)) => {
let layout = self.layout(&prev_ty)?; let layout = self.layout(&prev_ty)?;
let variant_layout = match &layout.variants { let variant_layout = match &layout.variants {
Variants::Single { .. } => &layout, Variants::Single { .. } | Variants::Empty => &layout,
Variants::Multiple { variants, .. } => { Variants::Multiple { variants, .. } => {
&variants[match f.parent { &variants[match f.parent {
hir_def::VariantId::EnumVariantId(it) => { hir_def::VariantId::EnumVariantId(it) => {
@ -1638,6 +1638,7 @@ impl Evaluator<'_> {
return Ok(0); return Ok(0);
}; };
match &layout.variants { match &layout.variants {
Variants::Empty => unreachable!(),
Variants::Single { index } => { Variants::Single { index } => {
let r = self.const_eval_discriminant(self.db.enum_data(e).variants[index.0].0)?; let r = self.const_eval_discriminant(self.db.enum_data(e).variants[index.0].0)?;
Ok(r) Ok(r)
@ -1800,7 +1801,7 @@ impl Evaluator<'_> {
} }
let layout = self.layout_adt(adt, subst)?; let layout = self.layout_adt(adt, subst)?;
Ok(match &layout.variants { Ok(match &layout.variants {
Variants::Single { .. } => (layout.size.bytes_usize(), layout, None), Variants::Single { .. } | Variants::Empty => (layout.size.bytes_usize(), layout, None),
Variants::Multiple { variants, tag, tag_encoding, .. } => { Variants::Multiple { variants, tag, tag_encoding, .. } => {
let enum_variant_id = match it { let enum_variant_id = match it {
VariantId::EnumVariantId(it) => it, VariantId::EnumVariantId(it) => it,

View file

@ -334,6 +334,7 @@ pub(crate) fn detect_variant_from_bytes<'a>(
e: EnumId, e: EnumId,
) -> Option<(EnumVariantId, &'a Layout)> { ) -> Option<(EnumVariantId, &'a Layout)> {
let (var_id, var_layout) = match &layout.variants { let (var_id, var_layout) = match &layout.variants {
hir_def::layout::Variants::Empty => unreachable!(),
hir_def::layout::Variants::Single { index } => { hir_def::layout::Variants::Single { index } => {
(db.enum_data(e).variants[index.0].0, layout) (db.enum_data(e).variants[index.0].0, layout)
} }

View file

@ -10,7 +10,8 @@
_2 = E::<char>::A; _2 = E::<char>::A;
discriminant(_2) = 1; discriminant(_2) = 1;
_1 = discriminant(_2); _1 = discriminant(_2);
switchInt(copy _1) -> [0: bb1, otherwise: bb2]; - switchInt(copy _1) -> [0: bb1, otherwise: bb2];
+ goto -> bb2;
} }
bb1: { bb1: {

View file

@ -10,7 +10,8 @@
_2 = E::<T>::A; _2 = E::<T>::A;
discriminant(_2) = 1; discriminant(_2) = 1;
_1 = discriminant(_2); _1 = discriminant(_2);
switchInt(copy _1) -> [0: bb1, otherwise: bb2]; - switchInt(copy _1) -> [0: bb1, otherwise: bb2];
+ goto -> bb2;
} }
bb1: { bb1: {

View file

@ -1,5 +1,6 @@
// `SetDiscriminant` does not actually write anything if the chosen variant is the untagged variant // `SetDiscriminant` does not actually write anything if the chosen variant is the untagged variant
// of a niche encoding. Verify that we do not thread over this case. // of a niche encoding. However, it is UB to call `SetDiscriminant` with the untagged variant if the
// value currently encodes a different variant. Verify that we do correctly thread in this case.
//@ test-mir-pass: JumpThreading //@ test-mir-pass: JumpThreading
#![feature(custom_mir)] #![feature(custom_mir)]
@ -16,20 +17,21 @@ enum E<T> {
#[custom_mir(dialect = "runtime")] #[custom_mir(dialect = "runtime")]
pub fn f() -> usize { pub fn f() -> usize {
// CHECK-LABEL: fn f( // CHECK-LABEL: fn f(
// CHECK-NOT: goto // CHECK-NOT: switchInt
// CHECK: switchInt( // CHECK: goto
// CHECK-NOT: goto // CHECK-NOT: switchInt
mir! { mir! {
let a: isize; let a: isize;
let e: E<char>; let e: E<char>;
{ {
e = E::A; e = E::A;
SetDiscriminant(e, 1); SetDiscriminant(e, 1); // UB!
a = Discriminant(e); a = Discriminant(e);
match a { match a {
0 => bb0, 0 => bb0,
_ => bb1, _ => bb1,
} }
} }
bb0 = { bb0 = {
RET = 0; RET = 0;
@ -46,15 +48,15 @@ pub fn f() -> usize {
#[custom_mir(dialect = "runtime")] #[custom_mir(dialect = "runtime")]
pub fn generic<T>() -> usize { pub fn generic<T>() -> usize {
// CHECK-LABEL: fn generic( // CHECK-LABEL: fn generic(
// CHECK-NOT: goto // CHECK-NOT: switchInt
// CHECK: switchInt( // CHECK: goto
// CHECK-NOT: goto // CHECK-NOT: switchInt
mir! { mir! {
let a: isize; let a: isize;
let e: E<T>; let e: E<T>;
{ {
e = E::A; e = E::A;
SetDiscriminant(e, 1); SetDiscriminant(e, 1); // UB!
a = Discriminant(e); a = Discriminant(e);
match a { match a {
0 => bb0, 0 => bb0,
@ -72,6 +74,7 @@ pub fn generic<T>() -> usize {
} }
} }
// CHECK-LABEL: fn main(
fn main() { fn main() {
assert_eq!(f(), 0); assert_eq!(f(), 0);
assert_eq!(generic::<char>(), 0); assert_eq!(generic::<char>(), 0);