compiler/rustc_codegen_llvm/src/type_of.rs

   1 use crate::abi::FnAbi;
   2 use crate::common::*;
   3 use crate::context::TypeLowering;
   4 use crate::type_::Type;
   5 use rustc_codegen_ssa::traits::*;
   6 use rustc_middle::bug;
   7 use rustc_middle::ty::layout::{FnAbiExt, TyAndLayout};
   8 use rustc_middle::ty::print::with_no_trimmed_paths;
   9 use rustc_middle::ty::{self, Ty, TypeFoldable};
  10 use rustc_target::abi::{Abi, AddressSpace, Align, FieldsShape};
  11 use rustc_target::abi::{Int, Pointer, F32, F64};
  12 use rustc_target::abi::{LayoutOf, PointeeInfo, Scalar, Size, TyAbiInterface, Variants};
  13 use smallvec::{smallvec, SmallVec};
  14 use tracing::debug;
  15
  16 use std::fmt::Write;
  17
  18 fn uncached_llvm_type<'a, 'tcx>(
  19     cx: &CodegenCx<'a, 'tcx>,
  20     layout: TyAndLayout<'tcx>,
  21     defer: &mut Option<(&'a Type, TyAndLayout<'tcx>)>,
  22     field_remapping: &mut Option<SmallVec<[u32; 4]>>,
  23 ) -> &'a Type {
  24     match layout.abi {
  25         Abi::Scalar(_) => bug!("handled elsewhere"),
  26         Abi::Vector { ref element, count } => {
  27             let element = layout.scalar_llvm_type_at(cx, element, Size::ZERO);
  28             return cx.type_vector(element, count);
  29         }
  30         Abi::ScalarPair(..) => {
  31             return cx.type_struct(
  32                 &[
  33                     layout.scalar_pair_element_llvm_type(cx, 0, false),
  34                     layout.scalar_pair_element_llvm_type(cx, 1, false),
  35                 ],
  36                 false,
  37             );
  38         }
  39         Abi::Uninhabited | Abi::Aggregate { .. } => {}
  40     }
  41
  42     let name = match layout.ty.kind() {
  43         // FIXME(eddyb) producing readable type names for trait objects can result
  44         // in problematically distinct types due to HRTB and subtyping (see #47638).
  45         // ty::Dynamic(..) |
  46         ty::Adt(..) | ty::Closure(..) | ty::Foreign(..) | ty::Generator(..) | ty::Str => {
  47             let mut name = with_no_trimmed_paths(|| layout.ty.to_string());
  48             if let (&ty::Adt(def, _), &Variants::Single { index }) =
  49                 (layout.ty.kind(), &layout.variants)
  50             {
  51                 if def.is_enum() && !def.variants.is_empty() {
  52                     write!(&mut name, "::{}", def.variants[index].ident).unwrap();
  53                 }
  54             }
  55             if let (&ty::Generator(_, _, _), &Variants::Single { index }) =
  56                 (layout.ty.kind(), &layout.variants)
  57             {
  58                 write!(&mut name, "::{}", ty::GeneratorSubsts::variant_name(index)).unwrap();
  59             }
  60             Some(name)
  61         }
  62         _ => None,
  63     };
  64
  65     match layout.fields {
  66         FieldsShape::Primitive | FieldsShape::Union(_) => {
  67             let fill = cx.type_padding_filler(layout.size, layout.align.abi);
  68             let packed = false;
  69             match name {
  70                 None => cx.type_struct(&[fill], packed),
  71                 Some(ref name) => {
  72                     let llty = cx.type_named_struct(name);
  73                     cx.set_struct_body(llty, &[fill], packed);
  74                     llty
  75                 }
  76             }
  77         }
  78         FieldsShape::Array { count, .. } => cx.type_array(layout.field(cx, 0).llvm_type(cx), count),
  79         FieldsShape::Arbitrary { .. } => match name {
  80             None => {
  81                 let (llfields, packed, new_field_remapping) = struct_llfields(cx, layout);
  82                 *field_remapping = new_field_remapping;
  83                 cx.type_struct(&llfields, packed)
  84             }
  85             Some(ref name) => {
  86                 let llty = cx.type_named_struct(name);
  87                 *defer = Some((llty, layout));
  88                 llty
  89             }
  90         },
  91     }
  92 }
  93
  94 fn struct_llfields<'a, 'tcx>(
  95     cx: &CodegenCx<'a, 'tcx>,
  96     layout: TyAndLayout<'tcx>,
  97 ) -> (Vec<&'a Type>, bool, Option<SmallVec<[u32; 4]>>) {
  98     debug!("struct_llfields: {:#?}", layout);
  99     let field_count = layout.fields.count();
 100
 101     let mut packed = false;
 102     let mut offset = Size::ZERO;
 103     let mut prev_effective_align = layout.align.abi;
 104     let mut result: Vec<_> = Vec::with_capacity(1 + field_count * 2);
 105     let mut field_remapping = smallvec![0; field_count];
 106     for i in layout.fields.index_by_increasing_offset() {
 107         let target_offset = layout.fields.offset(i as usize);
 108         let field = layout.field(cx, i);
 109         let effective_field_align =
 110             layout.align.abi.min(field.align.abi).restrict_for_offset(target_offset);
 111         packed |= effective_field_align < field.align.abi;
 112
 113         debug!(
 114             "struct_llfields: {}: {:?} offset: {:?} target_offset: {:?} \
 115                 effective_field_align: {}",
 116             i,
 117             field,
 118             offset,
 119             target_offset,
 120             effective_field_align.bytes()
 121         );
 122         assert!(target_offset >= offset);
 123         let padding = target_offset - offset;
 124         if padding != Size::ZERO {
 125             let padding_align = prev_effective_align.min(effective_field_align);
 126             assert_eq!(offset.align_to(padding_align) + padding, target_offset);
 127             result.push(cx.type_padding_filler(padding, padding_align));
 128             debug!("    padding before: {:?}", padding);
 129         }
 130         field_remapping[i] = result.len() as u32;
 131         result.push(field.llvm_type(cx));
 132         offset = target_offset + field.size;
 133         prev_effective_align = effective_field_align;
 134     }
 135     let padding_used = result.len() > field_count;
 136     if !layout.is_unsized() && field_count > 0 {
 137         if offset > layout.size {
 138             bug!("layout: {:#?} stride: {:?} offset: {:?}", layout, layout.size, offset);
 139         }
 140         let padding = layout.size - offset;
 141         if padding != Size::ZERO {
 142             let padding_align = prev_effective_align;
 143             assert_eq!(offset.align_to(padding_align) + padding, layout.size);
 144             debug!(
 145                 "struct_llfields: pad_bytes: {:?} offset: {:?} stride: {:?}",
 146                 padding, offset, layout.size
 147             );
 148             result.push(cx.type_padding_filler(padding, padding_align));
 149         }
 150     } else {
 151         debug!("struct_llfields: offset: {:?} stride: {:?}", offset, layout.size);
 152     }
 153     let field_remapping = if padding_used { Some(field_remapping) } else { None };
 154     (result, packed, field_remapping)
 155 }
 156
 157 impl<'a, 'tcx> CodegenCx<'a, 'tcx> {
 158     pub fn align_of(&self, ty: Ty<'tcx>) -> Align {
 159         self.layout_of(ty).align.abi
 160     }
 161
 162     pub fn size_of(&self, ty: Ty<'tcx>) -> Size {
 163         self.layout_of(ty).size
 164     }
 165
 166     pub fn size_and_align_of(&self, ty: Ty<'tcx>) -> (Size, Align) {
 167         let layout = self.layout_of(ty);
 168         (layout.size, layout.align.abi)
 169     }
 170 }
 171
 172 pub trait LayoutLlvmExt<'tcx> {
 173     fn is_llvm_immediate(&self) -> bool;
 174     fn is_llvm_scalar_pair(&self) -> bool;
 175     fn llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>) -> &'a Type;
 176     fn immediate_llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>) -> &'a Type;
 177     fn scalar_llvm_type_at<'a>(
 178         &self,
 179         cx: &CodegenCx<'a, 'tcx>,
 180         scalar: &Scalar,
 181         offset: Size,
 182     ) -> &'a Type;
 183     fn scalar_pair_element_llvm_type<'a>(
 184         &self,
 185         cx: &CodegenCx<'a, 'tcx>,
 186         index: usize,
 187         immediate: bool,
 188     ) -> &'a Type;
 189     fn llvm_field_index<'a>(&self, cx: &CodegenCx<'a, 'tcx>, index: usize) -> u64;
 190     fn pointee_info_at<'a>(&self, cx: &CodegenCx<'a, 'tcx>, offset: Size) -> Option<PointeeInfo>;
 191 }
 192
 193 impl<'tcx> LayoutLlvmExt<'tcx> for TyAndLayout<'tcx> {
 194     fn is_llvm_immediate(&self) -> bool {
 195         match self.abi {
 196             Abi::Scalar(_) | Abi::Vector { .. } => true,
 197             Abi::ScalarPair(..) => false,
 198             Abi::Uninhabited | Abi::Aggregate { .. } => self.is_zst(),
 199         }
 200     }
 201
 202     fn is_llvm_scalar_pair(&self) -> bool {
 203         match self.abi {
 204             Abi::ScalarPair(..) => true,
 205             Abi::Uninhabited | Abi::Scalar(_) | Abi::Vector { .. } | Abi::Aggregate { .. } => false,
 206         }
 207     }
 208
 209     /// Gets the LLVM type corresponding to a Rust type, i.e., `rustc_middle::ty::Ty`.
 210     /// The pointee type of the pointer in `PlaceRef` is always this type.
 211     /// For sized types, it is also the right LLVM type for an `alloca`
 212     /// containing a value of that type, and most immediates (except `bool`).
 213     /// Unsized types, however, are represented by a "minimal unit", e.g.
 214     /// `[T]` becomes `T`, while `str` and `Trait` turn into `i8` - this
 215     /// is useful for indexing slices, as `&[T]`'s data pointer is `T*`.
 216     /// If the type is an unsized struct, the regular layout is generated,
 217     /// with the inner-most trailing unsized field using the "minimal unit"
 218     /// of that field's type - this is useful for taking the address of
 219     /// that field and ensuring the struct has the right alignment.
 220     fn llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>) -> &'a Type {
 221         if let Abi::Scalar(ref scalar) = self.abi {
 222             // Use a different cache for scalars because pointers to DSTs
 223             // can be either fat or thin (data pointers of fat pointers).
 224             if let Some(&llty) = cx.scalar_lltypes.borrow().get(&self.ty) {
 225                 return llty;
 226             }
 227             let llty = match *self.ty.kind() {
 228                 ty::Ref(_, ty, _) | ty::RawPtr(ty::TypeAndMut { ty, .. }) => {
 229                     cx.type_ptr_to(cx.layout_of(ty).llvm_type(cx))
 230                 }
 231                 ty::Adt(def, _) if def.is_box() => {
 232                     cx.type_ptr_to(cx.layout_of(self.ty.boxed_ty()).llvm_type(cx))
 233                 }
 234                 ty::FnPtr(sig) => cx.fn_ptr_backend_type(&FnAbi::of_fn_ptr(cx, sig, &[])),
 235                 _ => self.scalar_llvm_type_at(cx, scalar, Size::ZERO),
 236             };
 237             cx.scalar_lltypes.borrow_mut().insert(self.ty, llty);
 238             return llty;
 239         }
 240
 241         // Check the cache.
 242         let variant_index = match self.variants {
 243             Variants::Single { index } => Some(index),
 244             _ => None,
 245         };
 246         if let Some(ref llty) = cx.type_lowering.borrow().get(&(self.ty, variant_index)) {
 247             return llty.lltype;
 248         }
 249
 250         debug!("llvm_type({:#?})", self);
 251
 252         assert!(!self.ty.has_escaping_bound_vars(), "{:?} has escaping bound vars", self.ty);
 253
 254         // Make sure lifetimes are erased, to avoid generating distinct LLVM
 255         // types for Rust types that only differ in the choice of lifetimes.
 256         let normal_ty = cx.tcx.erase_regions(self.ty);
 257
 258         let mut defer = None;
 259         let mut field_remapping = None;
 260         let llty = if self.ty != normal_ty {
 261             let mut layout = cx.layout_of(normal_ty);
 262             if let Some(v) = variant_index {
 263                 layout = layout.for_variant(cx, v);
 264             }
 265             layout.llvm_type(cx)
 266         } else {
 267             uncached_llvm_type(cx, *self, &mut defer, &mut field_remapping)
 268         };
 269         debug!("--> mapped {:#?} to llty={:?}", self, llty);
 270
 271         cx.type_lowering.borrow_mut().insert(
 272             (self.ty, variant_index),
 273             TypeLowering { lltype: llty, field_remapping: field_remapping },
 274         );
 275
 276         if let Some((llty, layout)) = defer {
 277             let (llfields, packed, new_field_remapping) = struct_llfields(cx, layout);
 278             cx.set_struct_body(llty, &llfields, packed);
 279             cx.type_lowering
 280                 .borrow_mut()
 281                 .get_mut(&(self.ty, variant_index))
 282                 .unwrap()
 283                 .field_remapping = new_field_remapping;
 284         }
 285         llty
 286     }
 287
 288     fn immediate_llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>) -> &'a Type {
 289         if let Abi::Scalar(ref scalar) = self.abi {
 290             if scalar.is_bool() {
 291                 return cx.type_i1();
 292             }
 293         }
 294         self.llvm_type(cx)
 295     }
 296
 297     fn scalar_llvm_type_at<'a>(
 298         &self,
 299         cx: &CodegenCx<'a, 'tcx>,
 300         scalar: &Scalar,
 301         offset: Size,
 302     ) -> &'a Type {
 303         match scalar.value {
 304             Int(i, _) => cx.type_from_integer(i),
 305             F32 => cx.type_f32(),
 306             F64 => cx.type_f64(),
 307             Pointer => {
 308                 // If we know the alignment, pick something better than i8.
 309                 let (pointee, address_space) =
 310                     if let Some(pointee) = self.pointee_info_at(cx, offset) {
 311                         (cx.type_pointee_for_align(pointee.align), pointee.address_space)
 312                     } else {
 313                         (cx.type_i8(), AddressSpace::DATA)
 314                     };
 315                 cx.type_ptr_to_ext(pointee, address_space)
 316             }
 317         }
 318     }
 319
 320     fn scalar_pair_element_llvm_type<'a>(
 321         &self,
 322         cx: &CodegenCx<'a, 'tcx>,
 323         index: usize,
 324         immediate: bool,
 325     ) -> &'a Type {
 326         // HACK(eddyb) special-case fat pointers until LLVM removes
 327         // pointee types, to avoid bitcasting every `OperandRef::deref`.
 328         match self.ty.kind() {
 329             ty::Ref(..) | ty::RawPtr(_) => {
 330                 return self.field(cx, index).llvm_type(cx);
 331             }
 332             ty::Adt(def, _) if def.is_box() => {
 333                 let ptr_ty = cx.tcx.mk_mut_ptr(self.ty.boxed_ty());
 334                 return cx.layout_of(ptr_ty).scalar_pair_element_llvm_type(cx, index, immediate);
 335             }
 336             _ => {}
 337         }
 338
 339         let (a, b) = match self.abi {
 340             Abi::ScalarPair(ref a, ref b) => (a, b),
 341             _ => bug!("TyAndLayout::scalar_pair_element_llty({:?}): not applicable", self),
 342         };
 343         let scalar = [a, b][index];
 344
 345         // Make sure to return the same type `immediate_llvm_type` would when
 346         // dealing with an immediate pair.  This means that `(bool, bool)` is
 347         // effectively represented as `{i8, i8}` in memory and two `i1`s as an
 348         // immediate, just like `bool` is typically `i8` in memory and only `i1`
 349         // when immediate.  We need to load/store `bool` as `i8` to avoid
 350         // crippling LLVM optimizations or triggering other LLVM bugs with `i1`.
 351         if immediate && scalar.is_bool() {
 352             return cx.type_i1();
 353         }
 354
 355         let offset =
 356             if index == 0 { Size::ZERO } else { a.value.size(cx).align_to(b.value.align(cx).abi) };
 357         self.scalar_llvm_type_at(cx, scalar, offset)
 358     }
 359
 360     fn llvm_field_index<'a>(&self, cx: &CodegenCx<'a, 'tcx>, index: usize) -> u64 {
 361         match self.abi {
 362             Abi::Scalar(_) | Abi::ScalarPair(..) => {
 363                 bug!("TyAndLayout::llvm_field_index({:?}): not applicable", self)
 364             }
 365             _ => {}
 366         }
 367         match self.fields {
 368             FieldsShape::Primitive | FieldsShape::Union(_) => {
 369                 bug!("TyAndLayout::llvm_field_index({:?}): not applicable", self)
 370             }
 371
 372             FieldsShape::Array { .. } => index as u64,
 373
 374             FieldsShape::Arbitrary { .. } => {
 375                 let variant_index = match self.variants {
 376                     Variants::Single { index } => Some(index),
 377                     _ => None,
 378                 };
 379
 380                 // Look up llvm field if indexes do not match memory order due to padding. If
 381                 // `field_remapping` is `None` no padding was used and the llvm field index
 382                 // matches the memory index.
 383                 match cx.type_lowering.borrow().get(&(self.ty, variant_index)) {
 384                     Some(TypeLowering { field_remapping: Some(ref remap), .. }) => {
 385                         remap[index] as u64
 386                     }
 387                     Some(_) => self.fields.memory_index(index) as u64,
 388                     None => {
 389                         bug!("TyAndLayout::llvm_field_index({:?}): type info not found", self)
 390                     }
 391                 }
 392             }
 393         }
 394     }
 395
 396     // FIXME(eddyb) this having the same name as `TyAndLayout::pointee_info_at`
 397     // (the inherent method, which is lacking this caching logic) can result in
 398     // the uncached version being called - not wrong, but potentially inefficient.
 399     fn pointee_info_at<'a>(&self, cx: &CodegenCx<'a, 'tcx>, offset: Size) -> Option<PointeeInfo> {
 400         if let Some(&pointee) = cx.pointee_infos.borrow().get(&(self.ty, offset)) {
 401             return pointee;
 402         }
 403
 404         let result = Ty::ty_and_layout_pointee_info_at(*self, cx, offset);
 405
 406         cx.pointee_infos.borrow_mut().insert((self.ty, offset), result);
 407         result
 408     }
 409 }