//! Compute the binary representation of structs, unions and enums use std::{cmp, ops::Bound}; use hir_def::{ data::adt::VariantData, layout::{Integer, LayoutCalculator, ReprOptions, TargetDataLayout}, AdtId, EnumVariantId, HasModule, LocalEnumVariantId, VariantId, }; use la_arena::RawIdx; use smallvec::SmallVec; use crate::{ db::HirDatabase, lang_items::is_unsafe_cell, layout::{field_ty, Layout, LayoutError, RustcEnumVariantIdx}, Substitution, }; use super::{layout_of_ty, LayoutCx}; pub(crate) fn struct_variant_idx() -> RustcEnumVariantIdx { RustcEnumVariantIdx(LocalEnumVariantId::from_raw(RawIdx::from(0))) } pub fn layout_of_adt_query( db: &dyn HirDatabase, def: AdtId, subst: Substitution, ) -> Result { let krate = def.module(db.upcast()).krate(); let Some(target) = db.target_data_layout(krate) else { return Err(LayoutError::TargetLayoutNotAvailable) }; let cx = LayoutCx { krate, target: &target }; let dl = cx.current_data_layout(); let handle_variant = |def: VariantId, var: &VariantData| { var.fields() .iter() .map(|(fd, _)| layout_of_ty(db, &field_ty(db, def, fd, &subst), cx.krate)) .collect::, _>>() }; let (variants, is_enum, is_union, repr) = match def { AdtId::StructId(s) => { let data = db.struct_data(s); let mut r = SmallVec::<[_; 1]>::new(); r.push(handle_variant(s.into(), &data.variant_data)?); (r, false, false, data.repr.unwrap_or_default()) } AdtId::UnionId(id) => { let data = db.union_data(id); let mut r = SmallVec::new(); r.push(handle_variant(id.into(), &data.variant_data)?); (r, false, true, data.repr.unwrap_or_default()) } AdtId::EnumId(e) => { let data = db.enum_data(e); let r = data .variants .iter() .map(|(idx, v)| { handle_variant( EnumVariantId { parent: e, local_id: idx }.into(), &v.variant_data, ) }) .collect::, _>>()?; (r, true, false, data.repr.unwrap_or_default()) } }; let variants = variants.iter().map(|x| x.iter().collect::>()).collect::>(); let variants = variants.iter().map(|x| x.iter().collect()).collect(); if is_union { cx.layout_of_union(&repr, &variants).ok_or(LayoutError::Unknown) } else { cx.layout_of_struct_or_enum( &repr, &variants, is_enum, is_unsafe_cell(db, def), layout_scalar_valid_range(db, def), |min, max| repr_discr(&dl, &repr, min, max).unwrap_or((Integer::I8, false)), variants.iter_enumerated().filter_map(|(id, _)| { let AdtId::EnumId(e) = def else { return None }; let d = db.const_eval_discriminant(EnumVariantId { parent: e, local_id: id.0 }).ok()?; Some((id, d)) }), // FIXME: The current code for niche-filling relies on variant indices // instead of actual discriminants, so enums with // explicit discriminants (RFC #2363) would misbehave and we should disable // niche optimization for them. // The code that do it in rustc: // repr.inhibit_enum_layout_opt() || def // .variants() // .iter_enumerated() // .any(|(i, v)| v.discr != ty::VariantDiscr::Relative(i.as_u32())) repr.inhibit_enum_layout_opt(), !is_enum && variants .iter() .next() .and_then(|x| x.last().map(|x| x.is_unsized())) .unwrap_or(true), ) .ok_or(LayoutError::SizeOverflow) } } fn layout_scalar_valid_range(db: &dyn HirDatabase, def: AdtId) -> (Bound, Bound) { let attrs = db.attrs(def.into()); let get = |name| { let attr = attrs.by_key(name).tt_values(); for tree in attr { if let Some(x) = tree.token_trees.first() { if let Ok(x) = x.to_string().parse() { return Bound::Included(x); } } } Bound::Unbounded }; (get("rustc_layout_scalar_valid_range_start"), get("rustc_layout_scalar_valid_range_end")) } pub fn layout_of_adt_recover( _: &dyn HirDatabase, _: &[String], _: &AdtId, _: &Substitution, ) -> Result { user_error!("infinite sized recursive type"); } /// Finds the appropriate Integer type and signedness for the given /// signed discriminant range and `#[repr]` attribute. /// N.B.: `u128` values above `i128::MAX` will be treated as signed, but /// that shouldn't affect anything, other than maybe debuginfo. fn repr_discr( dl: &TargetDataLayout, repr: &ReprOptions, min: i128, max: i128, ) -> Result<(Integer, bool), LayoutError> { // Theoretically, negative values could be larger in unsigned representation // than the unsigned representation of the signed minimum. However, if there // are any negative values, the only valid unsigned representation is u128 // which can fit all i128 values, so the result remains unaffected. let unsigned_fit = Integer::fit_unsigned(cmp::max(min as u128, max as u128)); let signed_fit = cmp::max(Integer::fit_signed(min), Integer::fit_signed(max)); if let Some(ity) = repr.int { let discr = Integer::from_attr(dl, ity); let fit = if ity.is_signed() { signed_fit } else { unsigned_fit }; if discr < fit { return Err(LayoutError::UserError( "Integer::repr_discr: `#[repr]` hint too small for \ discriminant range of enum " .to_string(), )); } return Ok((discr, ity.is_signed())); } let at_least = if repr.c() { // This is usually I32, however it can be different on some platforms, // notably hexagon and arm-none/thumb-none dl.c_enum_min_size } else { // repr(Rust) enums try to be as small as possible Integer::I8 }; // If there are no negative values, we can use the unsigned fit. Ok(if min >= 0 { (cmp::max(unsigned_fit, at_least), false) } else { (cmp::max(signed_fit, at_least), true) }) }