src/librustc_codegen_llvm/type_of.rs

   1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use abi::{FnType, FnTypeExt};
  12 use common::*;
  13 use rustc::hir;
  14 use rustc::ty::{self, Ty, TypeFoldable};
  15 use rustc::ty::layout::{self, Align, LayoutOf, Size, TyLayout};
  16 use rustc_target::abi::FloatTy;
  17 use rustc_mir::monomorphize::item::DefPathBasedNames;
  18 use type_::Type;
  19 use value::Value;
  20
  21 use std::fmt::Write;
  22
  23 fn uncached_llvm_type<'a, 'tcx>(cx: &CodegenCx<'a, 'tcx>,
  24                                 layout: TyLayout<'tcx>,
  25                                 defer: &mut Option<(&'a Type, TyLayout<'tcx>)>)
  26                                 -> &'a Type {
  27     match layout.abi {
  28         layout::Abi::Scalar(_) => bug!("handled elsewhere"),
  29         layout::Abi::Vector { ref element, count } => {
  30             // LLVM has a separate type for 64-bit SIMD vectors on X86 called
  31             // `x86_mmx` which is needed for some SIMD operations. As a bit of a
  32             // hack (all SIMD definitions are super unstable anyway) we
  33             // recognize any one-element SIMD vector as "this should be an
  34             // x86_mmx" type. In general there shouldn't be a need for other
  35             // one-element SIMD vectors, so it's assumed this won't clash with
  36             // much else.
  37             let use_x86_mmx = count == 1 && layout.size.bits() == 64 &&
  38                 (cx.sess().target.target.arch == "x86" ||
  39                  cx.sess().target.target.arch == "x86_64");
  40             if use_x86_mmx {
  41                 return Type::x86_mmx(cx)
  42             } else {
  43                 let element = layout.scalar_llvm_type_at(cx, element, Size::ZERO);
  44                 return Type::vector::<Value>(element, count);
  45             }
  46         }
  47         layout::Abi::ScalarPair(..) => {
  48             return Type::struct_(cx, &[
  49                 layout.scalar_pair_element_llvm_type(cx, 0, false),
  50                 layout.scalar_pair_element_llvm_type(cx, 1, false),
  51             ], false);
  52         }
  53         layout::Abi::Uninhabited |
  54         layout::Abi::Aggregate { .. } => {}
  55     }
  56
  57     let name = match layout.ty.sty {
  58         ty::Closure(..) |
  59         ty::Generator(..) |
  60         ty::Adt(..) |
  61         // FIXME(eddyb) producing readable type names for trait objects can result
  62         // in problematically distinct types due to HRTB and subtyping (see #47638).
  63         // ty::Dynamic(..) |
  64         ty::Foreign(..) |
  65         ty::Str => {
  66             let mut name = String::with_capacity(32);
  67             let printer = DefPathBasedNames::new(cx.tcx, true, true);
  68             printer.push_type_name(layout.ty, &mut name);
  69             if let (&ty::Adt(def, _), &layout::Variants::Single { index })
  70                  = (&layout.ty.sty, &layout.variants)
  71             {
  72                 if def.is_enum() && !def.variants.is_empty() {
  73                     write!(&mut name, "::{}", def.variants[index].name).unwrap();
  74                 }
  75             }
  76             Some(name)
  77         }
  78         _ => None
  79     };
  80
  81     match layout.fields {
  82         layout::FieldPlacement::Union(_) => {
  83             let fill = Type::padding_filler(cx, layout.size, layout.align);
  84             let packed = false;
  85             match name {
  86                 None => {
  87                     Type::struct_(cx, &[fill], packed)
  88                 }
  89                 Some(ref name) => {
  90                     let llty = Type::named_struct(cx, name);
  91                     llty.set_struct_body(&[fill], packed);
  92                     llty
  93                 }
  94             }
  95         }
  96         layout::FieldPlacement::Array { count, .. } => {
  97             Type::array::<Value>(layout.field(cx, 0).llvm_type(cx), count)
  98         }
  99         layout::FieldPlacement::Arbitrary { .. } => {
 100             match name {
 101                 None => {
 102                     let (llfields, packed) = struct_llfields(cx, layout);
 103                     Type::struct_(cx, &llfields, packed)
 104                 }
 105                 Some(ref name) => {
 106                     let llty = Type::named_struct(cx, name);
 107                     *defer = Some((llty, layout));
 108                     llty
 109                 }
 110             }
 111         }
 112     }
 113 }
 114
 115 fn struct_llfields<'a, 'tcx>(cx: &CodegenCx<'a, 'tcx>,
 116                              layout: TyLayout<'tcx>)
 117                              -> (Vec<&'a Type>, bool) {
 118     debug!("struct_llfields: {:#?}", layout);
 119     let field_count = layout.fields.count();
 120
 121     let mut packed = false;
 122     let mut offset = Size::ZERO;
 123     let mut prev_effective_align = layout.align;
 124     let mut result: Vec<_> = Vec::with_capacity(1 + field_count * 2);
 125     for i in layout.fields.index_by_increasing_offset() {
 126         let target_offset = layout.fields.offset(i as usize);
 127         let field = layout.field(cx, i);
 128         let effective_field_align = layout.align
 129             .min(field.align)
 130             .restrict_for_offset(target_offset);
 131         packed |= effective_field_align.abi() < field.align.abi();
 132
 133         debug!("struct_llfields: {}: {:?} offset: {:?} target_offset: {:?} \
 134                 effective_field_align: {}",
 135                i, field, offset, target_offset, effective_field_align.abi());
 136         assert!(target_offset >= offset);
 137         let padding = target_offset - offset;
 138         let padding_align = prev_effective_align.min(effective_field_align);
 139         assert_eq!(offset.abi_align(padding_align) + padding, target_offset);
 140         result.push(Type::padding_filler(cx, padding, padding_align));
 141         debug!("    padding before: {:?}", padding);
 142
 143         result.push(field.llvm_type(cx));
 144         offset = target_offset + field.size;
 145         prev_effective_align = effective_field_align;
 146     }
 147     if !layout.is_unsized() && field_count > 0 {
 148         if offset > layout.size {
 149             bug!("layout: {:#?} stride: {:?} offset: {:?}",
 150                  layout, layout.size, offset);
 151         }
 152         let padding = layout.size - offset;
 153         let padding_align = prev_effective_align;
 154         assert_eq!(offset.abi_align(padding_align) + padding, layout.size);
 155         debug!("struct_llfields: pad_bytes: {:?} offset: {:?} stride: {:?}",
 156                padding, offset, layout.size);
 157         result.push(Type::padding_filler(cx, padding, padding_align));
 158         assert_eq!(result.len(), 1 + field_count * 2);
 159     } else {
 160         debug!("struct_llfields: offset: {:?} stride: {:?}",
 161                offset, layout.size);
 162     }
 163
 164     (result, packed)
 165 }
 166
 167 impl<'a, 'tcx> CodegenCx<'a, 'tcx> {
 168     pub fn align_of(&self, ty: Ty<'tcx>) -> Align {
 169         self.layout_of(ty).align
 170     }
 171
 172     pub fn size_of(&self, ty: Ty<'tcx>) -> Size {
 173         self.layout_of(ty).size
 174     }
 175
 176     pub fn size_and_align_of(&self, ty: Ty<'tcx>) -> (Size, Align) {
 177         self.layout_of(ty).size_and_align()
 178     }
 179 }
 180
 181 #[derive(Copy, Clone, PartialEq, Eq)]
 182 pub enum PointerKind {
 183     /// Most general case, we know no restrictions to tell LLVM.
 184     Shared,
 185
 186     /// `&T` where `T` contains no `UnsafeCell`, is `noalias` and `readonly`.
 187     Frozen,
 188
 189     /// `&mut T`, when we know `noalias` is safe for LLVM.
 190     UniqueBorrowed,
 191
 192     /// `Box<T>`, unlike `UniqueBorrowed`, it also has `noalias` on returns.
 193     UniqueOwned
 194 }
 195
 196 #[derive(Copy, Clone)]
 197 pub struct PointeeInfo {
 198     pub size: Size,
 199     pub align: Align,
 200     pub safe: Option<PointerKind>,
 201 }
 202
 203 pub trait LayoutLlvmExt<'tcx> {
 204     fn is_llvm_immediate(&self) -> bool;
 205     fn is_llvm_scalar_pair<'a>(&self) -> bool;
 206     fn llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>) -> &'a Type;
 207     fn immediate_llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>) -> &'a Type;
 208     fn scalar_llvm_type_at<'a>(&self, cx: &CodegenCx<'a, 'tcx>,
 209                                scalar: &layout::Scalar, offset: Size) -> &'a Type;
 210     fn scalar_pair_element_llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>,
 211                                          index: usize, immediate: bool) -> &'a Type;
 212     fn llvm_field_index(&self, index: usize) -> u64;
 213     fn pointee_info_at<'a>(&self, cx: &CodegenCx<'a, 'tcx>, offset: Size)
 214                            -> Option<PointeeInfo>;
 215 }
 216
 217 impl<'tcx> LayoutLlvmExt<'tcx> for TyLayout<'tcx> {
 218     fn is_llvm_immediate(&self) -> bool {
 219         match self.abi {
 220             layout::Abi::Scalar(_) |
 221             layout::Abi::Vector { .. } => true,
 222             layout::Abi::ScalarPair(..) => false,
 223             layout::Abi::Uninhabited |
 224             layout::Abi::Aggregate { .. } => self.is_zst()
 225         }
 226     }
 227
 228     fn is_llvm_scalar_pair<'a>(&self) -> bool {
 229         match self.abi {
 230             layout::Abi::ScalarPair(..) => true,
 231             layout::Abi::Uninhabited |
 232             layout::Abi::Scalar(_) |
 233             layout::Abi::Vector { .. } |
 234             layout::Abi::Aggregate { .. } => false
 235         }
 236     }
 237
 238     /// Get the LLVM type corresponding to a Rust type, i.e. `rustc::ty::Ty`.
 239     /// The pointee type of the pointer in `PlaceRef` is always this type.
 240     /// For sized types, it is also the right LLVM type for an `alloca`
 241     /// containing a value of that type, and most immediates (except `bool`).
 242     /// Unsized types, however, are represented by a "minimal unit", e.g.
 243     /// `[T]` becomes `T`, while `str` and `Trait` turn into `i8` - this
 244     /// is useful for indexing slices, as `&[T]`'s data pointer is `T*`.
 245     /// If the type is an unsized struct, the regular layout is generated,
 246     /// with the inner-most trailing unsized field using the "minimal unit"
 247     /// of that field's type - this is useful for taking the address of
 248     /// that field and ensuring the struct has the right alignment.
 249     fn llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>) -> &'a Type {
 250         if let layout::Abi::Scalar(ref scalar) = self.abi {
 251             // Use a different cache for scalars because pointers to DSTs
 252             // can be either fat or thin (data pointers of fat pointers).
 253             if let Some(&llty) = cx.scalar_lltypes.borrow().get(&self.ty) {
 254                 return llty;
 255             }
 256             let llty = match self.ty.sty {
 257                 ty::Ref(_, ty, _) |
 258                 ty::RawPtr(ty::TypeAndMut { ty, .. }) => {
 259                     cx.layout_of(ty).llvm_type(cx).ptr_to()
 260                 }
 261                 ty::Adt(def, _) if def.is_box() => {
 262                     cx.layout_of(self.ty.boxed_ty()).llvm_type(cx).ptr_to()
 263                 }
 264                 ty::FnPtr(sig) => {
 265                     let sig = cx.tcx.normalize_erasing_late_bound_regions(
 266                         ty::ParamEnv::reveal_all(),
 267                         &sig,
 268                     );
 269                     FnType::new(cx, sig, &[]).ptr_to_llvm_type(cx)
 270                 }
 271                 _ => self.scalar_llvm_type_at(cx, scalar, Size::ZERO)
 272             };
 273             cx.scalar_lltypes.borrow_mut().insert(self.ty, llty);
 274             return llty;
 275         }
 276
 277
 278         // Check the cache.
 279         let variant_index = match self.variants {
 280             layout::Variants::Single { index } => Some(index),
 281             _ => None
 282         };
 283         if let Some(&llty) = cx.lltypes.borrow().get(&(self.ty, variant_index)) {
 284             return llty;
 285         }
 286
 287         debug!("llvm_type({:#?})", self);
 288
 289         assert!(!self.ty.has_escaping_bound_vars(), "{:?} has escaping bound vars", self.ty);
 290
 291         // Make sure lifetimes are erased, to avoid generating distinct LLVM
 292         // types for Rust types that only differ in the choice of lifetimes.
 293         let normal_ty = cx.tcx.erase_regions(&self.ty);
 294
 295         let mut defer = None;
 296         let llty = if self.ty != normal_ty {
 297             let mut layout = cx.layout_of(normal_ty);
 298             if let Some(v) = variant_index {
 299                 layout = layout.for_variant(cx, v);
 300             }
 301             layout.llvm_type(cx)
 302         } else {
 303             uncached_llvm_type(cx, *self, &mut defer)
 304         };
 305         debug!("--> mapped {:#?} to llty={:?}", self, llty);
 306
 307         cx.lltypes.borrow_mut().insert((self.ty, variant_index), llty);
 308
 309         if let Some((llty, layout)) = defer {
 310             let (llfields, packed) = struct_llfields(cx, layout);
 311             llty.set_struct_body(&llfields, packed)
 312         }
 313
 314         llty
 315     }
 316
 317     fn immediate_llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>) -> &'a Type {
 318         if let layout::Abi::Scalar(ref scalar) = self.abi {
 319             if scalar.is_bool() {
 320                 return Type::i1(cx);
 321             }
 322         }
 323         self.llvm_type(cx)
 324     }
 325
 326     fn scalar_llvm_type_at<'a>(&self, cx: &CodegenCx<'a, 'tcx>,
 327                                scalar: &layout::Scalar, offset: Size) -> &'a Type {
 328         match scalar.value {
 329             layout::Int(i, _) => Type::from_integer(cx, i),
 330             layout::Float(FloatTy::F32) => Type::f32(cx),
 331             layout::Float(FloatTy::F64) => Type::f64(cx),
 332             layout::Pointer => {
 333                 // If we know the alignment, pick something better than i8.
 334                 let pointee = if let Some(pointee) = self.pointee_info_at(cx, offset) {
 335                     Type::pointee_for_abi_align(cx, pointee.align)
 336                 } else {
 337                     Type::i8(cx)
 338                 };
 339                 pointee.ptr_to()
 340             }
 341         }
 342     }
 343
 344     fn scalar_pair_element_llvm_type<'a>(&self, cx: &CodegenCx<'a, 'tcx>,
 345                                          index: usize, immediate: bool) -> &'a Type {
 346         // HACK(eddyb) special-case fat pointers until LLVM removes
 347         // pointee types, to avoid bitcasting every `OperandRef::deref`.
 348         match self.ty.sty {
 349             ty::Ref(..) |
 350             ty::RawPtr(_) => {
 351                 return self.field(cx, index).llvm_type(cx);
 352             }
 353             ty::Adt(def, _) if def.is_box() => {
 354                 let ptr_ty = cx.tcx.mk_mut_ptr(self.ty.boxed_ty());
 355                 return cx.layout_of(ptr_ty).scalar_pair_element_llvm_type(cx, index, immediate);
 356             }
 357             _ => {}
 358         }
 359
 360         let (a, b) = match self.abi {
 361             layout::Abi::ScalarPair(ref a, ref b) => (a, b),
 362             _ => bug!("TyLayout::scalar_pair_element_llty({:?}): not applicable", self)
 363         };
 364         let scalar = [a, b][index];
 365
 366         // Make sure to return the same type `immediate_llvm_type` would when
 367         // dealing with an immediate pair.  This means that `(bool, bool)` is
 368         // effectively represented as `{i8, i8}` in memory and two `i1`s as an
 369         // immediate, just like `bool` is typically `i8` in memory and only `i1`
 370         // when immediate.  We need to load/store `bool` as `i8` to avoid
 371         // crippling LLVM optimizations or triggering other LLVM bugs with `i1`.
 372         if immediate && scalar.is_bool() {
 373             return Type::i1(cx);
 374         }
 375
 376         let offset = if index == 0 {
 377             Size::ZERO
 378         } else {
 379             a.value.size(cx).abi_align(b.value.align(cx))
 380         };
 381         self.scalar_llvm_type_at(cx, scalar, offset)
 382     }
 383
 384     fn llvm_field_index(&self, index: usize) -> u64 {
 385         match self.abi {
 386             layout::Abi::Scalar(_) |
 387             layout::Abi::ScalarPair(..) => {
 388                 bug!("TyLayout::llvm_field_index({:?}): not applicable", self)
 389             }
 390             _ => {}
 391         }
 392         match self.fields {
 393             layout::FieldPlacement::Union(_) => {
 394                 bug!("TyLayout::llvm_field_index({:?}): not applicable", self)
 395             }
 396
 397             layout::FieldPlacement::Array { .. } => {
 398                 index as u64
 399             }
 400
 401             layout::FieldPlacement::Arbitrary { .. } => {
 402                 1 + (self.fields.memory_index(index) as u64) * 2
 403             }
 404         }
 405     }
 406
 407     fn pointee_info_at<'a>(&self, cx: &CodegenCx<'a, 'tcx>, offset: Size)
 408                            -> Option<PointeeInfo> {
 409         if let Some(&pointee) = cx.pointee_infos.borrow().get(&(self.ty, offset)) {
 410             return pointee;
 411         }
 412
 413         let mut result = None;
 414         match self.ty.sty {
 415             ty::RawPtr(mt) if offset.bytes() == 0 => {
 416                 let (size, align) = cx.size_and_align_of(mt.ty);
 417                 result = Some(PointeeInfo {
 418                     size,
 419                     align,
 420                     safe: None
 421                 });
 422             }
 423
 424             ty::Ref(_, ty, mt) if offset.bytes() == 0 => {
 425                 let (size, align) = cx.size_and_align_of(ty);
 426
 427                 let kind = match mt {
 428                     hir::MutImmutable => if cx.type_is_freeze(ty) {
 429                         PointerKind::Frozen
 430                     } else {
 431                         PointerKind::Shared
 432                     },
 433                     hir::MutMutable => {
 434                         // Previously we would only emit noalias annotations for LLVM >= 6 or in
 435                         // panic=abort mode. That was deemed right, as prior versions had many bugs
 436                         // in conjunction with unwinding, but later versions didn’t seem to have
 437                         // said issues. See issue #31681.
 438                         //
 439                         // Alas, later on we encountered a case where noalias would generate wrong
 440                         // code altogether even with recent versions of LLVM in *safe* code with no
 441                         // unwinding involved. See #54462.
 442                         //
 443                         // For now, do not enable mutable_noalias by default at all, while the
 444                         // issue is being figured out.
 445                         let mutable_noalias = cx.tcx.sess.opts.debugging_opts.mutable_noalias
 446                             .unwrap_or(false);
 447                         if mutable_noalias {
 448                             PointerKind::UniqueBorrowed
 449                         } else {
 450                             PointerKind::Shared
 451                         }
 452                     }
 453                 };
 454
 455                 result = Some(PointeeInfo {
 456                     size,
 457                     align,
 458                     safe: Some(kind)
 459                 });
 460             }
 461
 462             _ => {
 463                 let mut data_variant = match self.variants {
 464                     layout::Variants::NicheFilling { dataful_variant, .. } => {
 465                         // Only the niche itself is always initialized,
 466                         // so only check for a pointer at its offset.
 467                         //
 468                         // If the niche is a pointer, it's either valid
 469                         // (according to its type), or null (which the
 470                         // niche field's scalar validity range encodes).
 471                         // This allows using `dereferenceable_or_null`
 472                         // for e.g. `Option<&T>`, and this will continue
 473                         // to work as long as we don't start using more
 474                         // niches than just null (e.g. the first page
 475                         // of the address space, or unaligned pointers).
 476                         if self.fields.offset(0) == offset {
 477                             Some(self.for_variant(cx, dataful_variant))
 478                         } else {
 479                             None
 480                         }
 481                     }
 482                     _ => Some(*self)
 483                 };
 484
 485                 if let Some(variant) = data_variant {
 486                     // We're not interested in any unions.
 487                     if let layout::FieldPlacement::Union(_) = variant.fields {
 488                         data_variant = None;
 489                     }
 490                 }
 491
 492                 if let Some(variant) = data_variant {
 493                     let ptr_end = offset + layout::Pointer.size(cx);
 494                     for i in 0..variant.fields.count() {
 495                         let field_start = variant.fields.offset(i);
 496                         if field_start <= offset {
 497                             let field = variant.field(cx, i);
 498                             if ptr_end <= field_start + field.size {
 499                                 // We found the right field, look inside it.
 500                                 result = field.pointee_info_at(cx, offset - field_start);
 501                                 break;
 502                             }
 503                         }
 504                     }
 505                 }
 506
 507                 // FIXME(eddyb) This should be for `ptr::Unique<T>`, not `Box<T>`.
 508                 if let Some(ref mut pointee) = result {
 509                     if let ty::Adt(def, _) = self.ty.sty {
 510                         if def.is_box() && offset.bytes() == 0 {
 511                             pointee.safe = Some(PointerKind::UniqueOwned);
 512                         }
 513                     }
 514                 }
 515             }
 516         }
 517
 518         cx.pointee_infos.borrow_mut().insert((self.ty, offset), result);
 519         result
 520     }
 521 }