1 // Copyright 2016 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.
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.
11 pub use self::Integer::*;
12 pub use self::Layout::*;
13 pub use self::Primitive::*;
18 use ty::{self, Ty, TyCtxt, TypeFoldable, ReprOptions, ReprFlags};
20 use syntax::ast::{FloatTy, IntTy, UintTy};
22 use syntax_pos::DUMMY_SP;
30 /// Parsed [Data layout](http://llvm.org/docs/LangRef.html#data-layout)
31 /// for a target, which contains everything needed to compute layouts.
32 pub struct TargetDataLayout {
39 pub i128_align: Align,
42 pub pointer_size: Size,
43 pub pointer_align: Align,
44 pub aggregate_align: Align,
46 /// Alignments for vector types.
47 pub vector_align: Vec<(Size, Align)>
50 impl Default for TargetDataLayout {
51 /// Creates an instance of `TargetDataLayout`.
52 fn default() -> TargetDataLayout {
55 i1_align: Align::from_bits(8, 8).unwrap(),
56 i8_align: Align::from_bits(8, 8).unwrap(),
57 i16_align: Align::from_bits(16, 16).unwrap(),
58 i32_align: Align::from_bits(32, 32).unwrap(),
59 i64_align: Align::from_bits(32, 64).unwrap(),
60 i128_align: Align::from_bits(32, 64).unwrap(),
61 f32_align: Align::from_bits(32, 32).unwrap(),
62 f64_align: Align::from_bits(64, 64).unwrap(),
63 pointer_size: Size::from_bits(64),
64 pointer_align: Align::from_bits(64, 64).unwrap(),
65 aggregate_align: Align::from_bits(0, 64).unwrap(),
67 (Size::from_bits(64), Align::from_bits(64, 64).unwrap()),
68 (Size::from_bits(128), Align::from_bits(128, 128).unwrap())
74 impl TargetDataLayout {
75 pub fn parse(sess: &Session) -> TargetDataLayout {
76 // Parse a bit count from a string.
77 let parse_bits = |s: &str, kind: &str, cause: &str| {
78 s.parse::<u64>().unwrap_or_else(|err| {
79 sess.err(&format!("invalid {} `{}` for `{}` in \"data-layout\": {}",
80 kind, s, cause, err));
85 // Parse a size string.
86 let size = |s: &str, cause: &str| {
87 Size::from_bits(parse_bits(s, "size", cause))
90 // Parse an alignment string.
91 let align = |s: &[&str], cause: &str| {
93 sess.err(&format!("missing alignment for `{}` in \"data-layout\"", cause));
95 let abi = parse_bits(s[0], "alignment", cause);
96 let pref = s.get(1).map_or(abi, |pref| parse_bits(pref, "alignment", cause));
97 Align::from_bits(abi, pref).unwrap_or_else(|err| {
98 sess.err(&format!("invalid alignment for `{}` in \"data-layout\": {}",
100 Align::from_bits(8, 8).unwrap()
104 let mut dl = TargetDataLayout::default();
105 let mut i128_align_src = 64;
106 for spec in sess.target.target.data_layout.split("-") {
107 match &spec.split(":").collect::<Vec<_>>()[..] {
108 &["e"] => dl.endian = Endian::Little,
109 &["E"] => dl.endian = Endian::Big,
110 &["a", ref a..] => dl.aggregate_align = align(a, "a"),
111 &["f32", ref a..] => dl.f32_align = align(a, "f32"),
112 &["f64", ref a..] => dl.f64_align = align(a, "f64"),
113 &[p @ "p", s, ref a..] | &[p @ "p0", s, ref a..] => {
114 dl.pointer_size = size(s, p);
115 dl.pointer_align = align(a, p);
117 &[s, ref a..] if s.starts_with("i") => {
118 let bits = match s[1..].parse::<u64>() {
121 size(&s[1..], "i"); // For the user error.
127 1 => dl.i1_align = a,
128 8 => dl.i8_align = a,
129 16 => dl.i16_align = a,
130 32 => dl.i32_align = a,
131 64 => dl.i64_align = a,
134 if bits >= i128_align_src && bits <= 128 {
135 // Default alignment for i128 is decided by taking the alignment of
136 // largest-sized i{64...128}.
137 i128_align_src = bits;
141 &[s, ref a..] if s.starts_with("v") => {
142 let v_size = size(&s[1..], "v");
144 if let Some(v) = dl.vector_align.iter_mut().find(|v| v.0 == v_size) {
148 // No existing entry, add a new one.
149 dl.vector_align.push((v_size, a));
151 _ => {} // Ignore everything else.
155 // Perform consistency checks against the Target information.
156 let endian_str = match dl.endian {
157 Endian::Little => "little",
160 if endian_str != sess.target.target.target_endian {
161 sess.err(&format!("inconsistent target specification: \"data-layout\" claims \
162 architecture is {}-endian, while \"target-endian\" is `{}`",
163 endian_str, sess.target.target.target_endian));
166 if dl.pointer_size.bits().to_string() != sess.target.target.target_pointer_width {
167 sess.err(&format!("inconsistent target specification: \"data-layout\" claims \
168 pointers are {}-bit, while \"target-pointer-width\" is `{}`",
169 dl.pointer_size.bits(), sess.target.target.target_pointer_width));
175 /// Return exclusive upper bound on object size.
177 /// The theoretical maximum object size is defined as the maximum positive `isize` value.
178 /// This ensures that the `offset` semantics remain well-defined by allowing it to correctly
179 /// index every address within an object along with one byte past the end, along with allowing
180 /// `isize` to store the difference between any two pointers into an object.
182 /// The upper bound on 64-bit currently needs to be lower because LLVM uses a 64-bit integer
183 /// to represent object size in bits. It would need to be 1 << 61 to account for this, but is
184 /// currently conservatively bounded to 1 << 47 as that is enough to cover the current usable
185 /// address space on 64-bit ARMv8 and x86_64.
186 pub fn obj_size_bound(&self) -> u64 {
187 match self.pointer_size.bits() {
191 bits => bug!("obj_size_bound: unknown pointer bit size {}", bits)
195 pub fn ptr_sized_integer(&self) -> Integer {
196 match self.pointer_size.bits() {
200 bits => bug!("ptr_sized_integer: unknown pointer bit size {}", bits)
205 pub trait HasDataLayout: Copy {
206 fn data_layout(&self) -> &TargetDataLayout;
209 impl<'a> HasDataLayout for &'a TargetDataLayout {
210 fn data_layout(&self) -> &TargetDataLayout {
215 /// Endianness of the target, which must match cfg(target-endian).
216 #[derive(Copy, Clone)]
222 /// Size of a type in bytes.
223 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
229 pub fn from_bits(bits: u64) -> Size {
230 Size::from_bytes((bits + 7) / 8)
233 pub fn from_bytes(bytes: u64) -> Size {
234 if bytes >= (1 << 61) {
235 bug!("Size::from_bytes: {} bytes in bits doesn't fit in u64", bytes)
242 pub fn bytes(self) -> u64 {
246 pub fn bits(self) -> u64 {
250 pub fn abi_align(self, align: Align) -> Size {
251 let mask = align.abi() - 1;
252 Size::from_bytes((self.bytes() + mask) & !mask)
255 pub fn checked_add<C: HasDataLayout>(self, offset: Size, cx: C) -> Option<Size> {
256 let dl = cx.data_layout();
258 // Each Size is less than dl.obj_size_bound(), so the sum is
259 // also less than 1 << 62 (and therefore can't overflow).
260 let bytes = self.bytes() + offset.bytes();
262 if bytes < dl.obj_size_bound() {
263 Some(Size::from_bytes(bytes))
269 pub fn checked_mul<C: HasDataLayout>(self, count: u64, cx: C) -> Option<Size> {
270 let dl = cx.data_layout();
272 // Each Size is less than dl.obj_size_bound(), so the sum is
273 // also less than 1 << 62 (and therefore can't overflow).
274 match self.bytes().checked_mul(count) {
275 Some(bytes) if bytes < dl.obj_size_bound() => {
276 Some(Size::from_bytes(bytes))
283 /// Alignment of a type in bytes, both ABI-mandated and preferred.
284 /// Since alignments are always powers of 2, we can pack both in one byte,
285 /// giving each a nibble (4 bits) for a maximum alignment of 2<sup>15</sup> = 32768.
286 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
292 pub fn from_bits(abi: u64, pref: u64) -> Result<Align, String> {
293 Align::from_bytes((abi + 7) / 8, (pref + 7) / 8)
296 pub fn from_bytes(abi: u64, pref: u64) -> Result<Align, String> {
297 let pack = |align: u64| {
298 // Treat an alignment of 0 bytes like 1-byte alignment.
303 let mut bytes = align;
305 while (bytes & 1) == 0 {
310 Err(format!("`{}` is not a power of 2", align))
311 } else if pow > 0x0f {
312 Err(format!("`{}` is too large", align))
319 raw: pack(abi)? | (pack(pref)? << 4)
323 pub fn abi(self) -> u64 {
324 1 << (self.raw & 0xf)
327 pub fn pref(self) -> u64 {
331 pub fn min(self, other: Align) -> Align {
332 let abi = cmp::min(self.raw & 0x0f, other.raw & 0x0f);
333 let pref = cmp::min(self.raw & 0xf0, other.raw & 0xf0);
339 pub fn max(self, other: Align) -> Align {
340 let abi = cmp::max(self.raw & 0x0f, other.raw & 0x0f);
341 let pref = cmp::max(self.raw & 0xf0, other.raw & 0xf0);
348 /// Integers, also used for enum discriminants.
349 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
360 pub fn size(&self) -> Size {
362 I1 => Size::from_bits(1),
363 I8 => Size::from_bytes(1),
364 I16 => Size::from_bytes(2),
365 I32 => Size::from_bytes(4),
366 I64 => Size::from_bytes(8),
367 I128 => Size::from_bytes(16),
371 pub fn align<C: HasDataLayout>(&self, cx: C) -> Align {
372 let dl = cx.data_layout();
380 I128 => dl.i128_align,
384 pub fn to_ty<'a, 'tcx>(&self, tcx: &ty::TyCtxt<'a, 'tcx, 'tcx>,
385 signed: bool) -> Ty<'tcx> {
386 match (*self, signed) {
387 (I1, false) => tcx.types.u8,
388 (I8, false) => tcx.types.u8,
389 (I16, false) => tcx.types.u16,
390 (I32, false) => tcx.types.u32,
391 (I64, false) => tcx.types.u64,
392 (I128, false) => tcx.types.u128,
393 (I1, true) => tcx.types.i8,
394 (I8, true) => tcx.types.i8,
395 (I16, true) => tcx.types.i16,
396 (I32, true) => tcx.types.i32,
397 (I64, true) => tcx.types.i64,
398 (I128, true) => tcx.types.i128,
402 /// Find the smallest Integer type which can represent the signed value.
403 pub fn fit_signed(x: i64) -> Integer {
405 -0x0000_0000_0000_0001...0x0000_0000_0000_0000 => I1,
406 -0x0000_0000_0000_0080...0x0000_0000_0000_007f => I8,
407 -0x0000_0000_0000_8000...0x0000_0000_0000_7fff => I16,
408 -0x0000_0000_8000_0000...0x0000_0000_7fff_ffff => I32,
409 -0x8000_0000_0000_0000...0x7fff_ffff_ffff_ffff => I64,
414 /// Find the smallest Integer type which can represent the unsigned value.
415 pub fn fit_unsigned(x: u64) -> Integer {
417 0...0x0000_0000_0000_0001 => I1,
418 0...0x0000_0000_0000_00ff => I8,
419 0...0x0000_0000_0000_ffff => I16,
420 0...0x0000_0000_ffff_ffff => I32,
421 0...0xffff_ffff_ffff_ffff => I64,
426 /// Find the smallest integer with the given alignment.
427 pub fn for_abi_align<C: HasDataLayout>(cx: C, align: Align) -> Option<Integer> {
428 let dl = cx.data_layout();
430 let wanted = align.abi();
431 for &candidate in &[I8, I16, I32, I64] {
432 let ty = Int(candidate);
433 if wanted == ty.align(dl).abi() && wanted == ty.size(dl).bytes() {
434 return Some(candidate);
440 /// Get the Integer type from an attr::IntType.
441 pub fn from_attr<C: HasDataLayout>(cx: C, ity: attr::IntType) -> Integer {
442 let dl = cx.data_layout();
445 attr::SignedInt(IntTy::I8) | attr::UnsignedInt(UintTy::U8) => I8,
446 attr::SignedInt(IntTy::I16) | attr::UnsignedInt(UintTy::U16) => I16,
447 attr::SignedInt(IntTy::I32) | attr::UnsignedInt(UintTy::U32) => I32,
448 attr::SignedInt(IntTy::I64) | attr::UnsignedInt(UintTy::U64) => I64,
449 attr::SignedInt(IntTy::I128) | attr::UnsignedInt(UintTy::U128) => I128,
450 attr::SignedInt(IntTy::Is) | attr::UnsignedInt(UintTy::Us) => {
451 dl.ptr_sized_integer()
456 /// Find the appropriate Integer type and signedness for the given
457 /// signed discriminant range and #[repr] attribute.
458 /// N.B.: u64 values above i64::MAX will be treated as signed, but
459 /// that shouldn't affect anything, other than maybe debuginfo.
460 fn repr_discr(tcx: TyCtxt, ty: Ty, repr: &ReprOptions, min: i64, max: i64)
462 // Theoretically, negative values could be larger in unsigned representation
463 // than the unsigned representation of the signed minimum. However, if there
464 // are any negative values, the only valid unsigned representation is u64
465 // which can fit all i64 values, so the result remains unaffected.
466 let unsigned_fit = Integer::fit_unsigned(cmp::max(min as u64, max as u64));
467 let signed_fit = cmp::max(Integer::fit_signed(min), Integer::fit_signed(max));
469 let mut min_from_extern = None;
470 let min_default = I8;
472 if let Some(ity) = repr.int {
473 let discr = Integer::from_attr(tcx, ity);
474 let fit = if ity.is_signed() { signed_fit } else { unsigned_fit };
476 bug!("Integer::repr_discr: `#[repr]` hint too small for \
477 discriminant range of enum `{}", ty)
479 return (discr, ity.is_signed());
483 match &tcx.sess.target.target.arch[..] {
484 // WARNING: the ARM EABI has two variants; the one corresponding
485 // to `at_least == I32` appears to be used on Linux and NetBSD,
486 // but some systems may use the variant corresponding to no
487 // lower bound. However, we don't run on those yet...?
488 "arm" => min_from_extern = Some(I32),
489 _ => min_from_extern = Some(I32),
493 let at_least = min_from_extern.unwrap_or(min_default);
495 // If there are no negative values, we can use the unsigned fit.
497 (cmp::max(unsigned_fit, at_least), false)
499 (cmp::max(signed_fit, at_least), true)
504 /// Fundamental unit of memory access and layout.
505 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
514 pub fn size<C: HasDataLayout>(self, cx: C) -> Size {
515 let dl = cx.data_layout();
518 Int(I1) | Int(I8) => Size::from_bits(8),
519 Int(I16) => Size::from_bits(16),
520 Int(I32) | F32 => Size::from_bits(32),
521 Int(I64) | F64 => Size::from_bits(64),
522 Int(I128) => Size::from_bits(128),
523 Pointer => dl.pointer_size
527 pub fn align<C: HasDataLayout>(self, cx: C) -> Align {
528 let dl = cx.data_layout();
531 Int(I1) => dl.i1_align,
532 Int(I8) => dl.i8_align,
533 Int(I16) => dl.i16_align,
534 Int(I32) => dl.i32_align,
535 Int(I64) => dl.i64_align,
536 Int(I128) => dl.i128_align,
539 Pointer => dl.pointer_align
544 /// Path through fields of nested structures.
545 // FIXME(eddyb) use small vector optimization for the common case.
546 pub type FieldPath = Vec<u32>;
548 /// A structure, a product type in ADT terms.
549 #[derive(PartialEq, Eq, Hash, Debug)]
553 /// If true, no alignment padding is used.
556 /// If true, the size is exact, otherwise it's only a lower bound.
559 /// Offsets for the first byte of each field, ordered to match the source definition order.
560 /// This vector does not go in increasing order.
561 /// FIXME(eddyb) use small vector optimization for the common case.
562 pub offsets: Vec<Size>,
564 /// Maps source order field indices to memory order indices, depending how fields were permuted.
565 /// FIXME (camlorn) also consider small vector optimization here.
566 pub memory_index: Vec<u32>,
571 // Info required to optimize struct layout.
572 #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug)]
574 // A tuple, closure, or univariant which cannot be coerced to unsized.
575 AlwaysSizedUnivariant,
576 // A univariant, the last field of which may be coerced to unsized.
577 MaybeUnsizedUnivariant,
578 // A univariant, but part of an enum.
582 impl<'a, 'gcx, 'tcx> Struct {
583 fn new(dl: &TargetDataLayout, fields: &Vec<&'a Layout>,
584 repr: &ReprOptions, kind: StructKind,
585 scapegoat: Ty<'gcx>) -> Result<Struct, LayoutError<'gcx>> {
586 let packed = repr.packed();
587 let mut ret = Struct {
588 align: if packed { dl.i8_align } else { dl.aggregate_align },
592 memory_index: vec![],
593 min_size: Size::from_bytes(0),
596 // Anything with repr(C) or repr(packed) doesn't optimize.
597 // Neither do 1-member and 2-member structs.
598 // In addition, code in trans assume that 2-element structs can become pairs.
599 // It's easier to just short-circuit here.
600 let can_optimize = (fields.len() > 2 || StructKind::EnumVariant == kind)
601 && (repr.flags & ReprFlags::IS_UNOPTIMISABLE).is_empty();
603 let (optimize, sort_ascending) = match kind {
604 StructKind::AlwaysSizedUnivariant => (can_optimize, false),
605 StructKind::MaybeUnsizedUnivariant => (can_optimize, false),
606 StructKind::EnumVariant => {
607 assert!(fields.len() >= 1, "Enum variants must have discriminants.");
608 (can_optimize && fields[0].size(dl).bytes() == 1, true)
612 ret.offsets = vec![Size::from_bytes(0); fields.len()];
613 let mut inverse_memory_index: Vec<u32> = (0..fields.len() as u32).collect();
616 let start = if let StructKind::EnumVariant = kind { 1 } else { 0 };
617 let end = if let StructKind::MaybeUnsizedUnivariant = kind {
623 let optimizing = &mut inverse_memory_index[start..end];
625 optimizing.sort_by_key(|&x| fields[x as usize].align(dl).abi());
627 optimizing.sort_by(| &a, &b | {
628 let a = fields[a as usize].align(dl).abi();
629 let b = fields[b as usize].align(dl).abi();
636 // inverse_memory_index holds field indices by increasing memory offset.
637 // That is, if field 5 has offset 0, the first element of inverse_memory_index is 5.
638 // We now write field offsets to the corresponding offset slot;
639 // field 5 with offset 0 puts 0 in offsets[5].
640 // At the bottom of this function, we use inverse_memory_index to produce memory_index.
642 if let StructKind::EnumVariant = kind {
643 assert_eq!(inverse_memory_index[0], 0,
644 "Enum variant discriminants must have the lowest offset.");
647 let mut offset = Size::from_bytes(0);
649 for i in inverse_memory_index.iter() {
650 let field = fields[*i as usize];
652 bug!("Struct::new: field #{} of `{}` comes after unsized field",
653 ret.offsets.len(), scapegoat);
656 if field.is_unsized() {
660 // Invariant: offset < dl.obj_size_bound() <= 1<<61
662 let align = field.align(dl);
663 ret.align = ret.align.max(align);
664 offset = offset.abi_align(align);
667 debug!("Struct::new offset: {:?} field: {:?} {:?}", offset, field, field.size(dl));
668 ret.offsets[*i as usize] = offset;
670 offset = offset.checked_add(field.size(dl), dl)
671 .map_or(Err(LayoutError::SizeOverflow(scapegoat)), Ok)?;
675 debug!("Struct::new min_size: {:?}", offset);
676 ret.min_size = offset;
678 // As stated above, inverse_memory_index holds field indices by increasing offset.
679 // This makes it an already-sorted view of the offsets vec.
680 // To invert it, consider:
681 // If field 5 has offset 0, offsets[0] is 5, and memory_index[5] should be 0.
682 // Field 5 would be the first element, so memory_index is i:
683 // Note: if we didn't optimize, it's already right.
686 ret.memory_index = vec![0; inverse_memory_index.len()];
688 for i in 0..inverse_memory_index.len() {
689 ret.memory_index[inverse_memory_index[i] as usize] = i as u32;
692 ret.memory_index = inverse_memory_index;
698 /// Get the size with trailing alignment padding.
699 pub fn stride(&self) -> Size {
700 self.min_size.abi_align(self.align)
703 /// Determine whether a structure would be zero-sized, given its fields.
704 fn would_be_zero_sized<I>(dl: &TargetDataLayout, fields: I)
705 -> Result<bool, LayoutError<'gcx>>
706 where I: Iterator<Item=Result<&'a Layout, LayoutError<'gcx>>> {
707 for field in fields {
709 if field.is_unsized() || field.size(dl).bytes() > 0 {
716 /// Get indices of the tys that made this struct by increasing offset.
718 pub fn field_index_by_increasing_offset<'b>(&'b self) -> impl iter::Iterator<Item=usize>+'b {
719 let mut inverse_small = [0u8; 64];
720 let mut inverse_big = vec![];
721 let use_small = self.memory_index.len() <= inverse_small.len();
723 // We have to write this logic twice in order to keep the array small.
725 for i in 0..self.memory_index.len() {
726 inverse_small[self.memory_index[i] as usize] = i as u8;
729 inverse_big = vec![0; self.memory_index.len()];
730 for i in 0..self.memory_index.len() {
731 inverse_big[self.memory_index[i] as usize] = i as u32;
735 (0..self.memory_index.len()).map(move |i| {
736 if use_small { inverse_small[i] as usize }
737 else { inverse_big[i] as usize }
741 /// Find the path leading to a non-zero leaf field, starting from
742 /// the given type and recursing through aggregates.
743 /// The tuple is `(path, source_path)`,
744 /// where `path` is in memory order and `source_path` in source order.
745 // FIXME(eddyb) track value ranges and traverse already optimized enums.
746 fn non_zero_field_in_type(infcx: &InferCtxt<'a, 'gcx, 'tcx>,
748 -> Result<Option<(FieldPath, FieldPath)>, LayoutError<'gcx>> {
749 let tcx = infcx.tcx.global_tcx();
750 match (ty.layout(infcx)?, &ty.sty) {
751 (&Scalar { non_zero: true, .. }, _) |
752 (&CEnum { non_zero: true, .. }, _) => Ok(Some((vec![], vec![]))),
753 (&FatPointer { non_zero: true, .. }, _) => {
754 Ok(Some((vec![FAT_PTR_ADDR as u32], vec![FAT_PTR_ADDR as u32])))
757 // Is this the NonZero lang item wrapping a pointer or integer type?
758 (&Univariant { non_zero: true, .. }, &ty::TyAdt(def, substs)) => {
759 let fields = &def.struct_variant().fields;
760 assert_eq!(fields.len(), 1);
761 match *fields[0].ty(tcx, substs).layout(infcx)? {
762 // FIXME(eddyb) also allow floating-point types here.
763 Scalar { value: Int(_), non_zero: false } |
764 Scalar { value: Pointer, non_zero: false } => {
765 Ok(Some((vec![0], vec![0])))
767 FatPointer { non_zero: false, .. } => {
768 let tmp = vec![FAT_PTR_ADDR as u32, 0];
769 Ok(Some((tmp.clone(), tmp)))
775 // Perhaps one of the fields of this struct is non-zero
776 // let's recurse and find out
777 (&Univariant { ref variant, .. }, &ty::TyAdt(def, substs)) if def.is_struct() => {
778 Struct::non_zero_field_paths(infcx, def.struct_variant().fields
779 .iter().map(|field| {
780 field.ty(tcx, substs)
782 Some(&variant.memory_index[..]))
785 // Perhaps one of the upvars of this closure is non-zero
786 (&Univariant { ref variant, .. }, &ty::TyClosure(def, substs)) => {
787 let upvar_tys = substs.upvar_tys(def, tcx);
788 Struct::non_zero_field_paths(infcx, upvar_tys,
789 Some(&variant.memory_index[..]))
791 // Can we use one of the fields in this tuple?
792 (&Univariant { ref variant, .. }, &ty::TyTuple(tys, _)) => {
793 Struct::non_zero_field_paths(infcx, tys.iter().cloned(),
794 Some(&variant.memory_index[..]))
797 // Is this a fixed-size array of something non-zero
798 // with at least one element?
799 (_, &ty::TyArray(ety, d)) if d > 0 => {
800 Struct::non_zero_field_paths(infcx, Some(ety).into_iter(), None)
803 (_, &ty::TyProjection(_)) | (_, &ty::TyAnon(..)) => {
804 let normalized = normalize_associated_type(infcx, ty);
805 if ty == normalized {
808 return Struct::non_zero_field_in_type(infcx, normalized);
811 // Anything else is not a non-zero type.
816 /// Find the path leading to a non-zero leaf field, starting from
817 /// the given set of fields and recursing through aggregates.
818 /// Returns Some((path, source_path)) on success.
819 /// `path` is translated to memory order. `source_path` is not.
820 fn non_zero_field_paths<I>(infcx: &InferCtxt<'a, 'gcx, 'tcx>,
822 permutation: Option<&[u32]>)
823 -> Result<Option<(FieldPath, FieldPath)>, LayoutError<'gcx>>
824 where I: Iterator<Item=Ty<'gcx>> {
825 for (i, ty) in fields.enumerate() {
826 if let Some((mut path, mut source_path)) = Struct::non_zero_field_in_type(infcx, ty)? {
827 source_path.push(i as u32);
828 let index = if let Some(p) = permutation {
833 path.push(index as u32);
834 return Ok(Some((path, source_path)));
841 /// An untagged union.
842 #[derive(PartialEq, Eq, Hash, Debug)]
848 /// If true, no alignment padding is used.
852 impl<'a, 'gcx, 'tcx> Union {
853 fn new(dl: &TargetDataLayout, packed: bool) -> Union {
855 align: if packed { dl.i8_align } else { dl.aggregate_align },
856 min_size: Size::from_bytes(0),
861 /// Extend the Struct with more fields.
862 fn extend<I>(&mut self, dl: &TargetDataLayout,
865 -> Result<(), LayoutError<'gcx>>
866 where I: Iterator<Item=Result<&'a Layout, LayoutError<'gcx>>> {
867 for (index, field) in fields.enumerate() {
869 if field.is_unsized() {
870 bug!("Union::extend: field #{} of `{}` is unsized",
874 debug!("Union::extend field: {:?} {:?}", field, field.size(dl));
877 self.align = self.align.max(field.align(dl));
879 self.min_size = cmp::max(self.min_size, field.size(dl));
882 debug!("Union::extend min-size: {:?}", self.min_size);
887 /// Get the size with trailing alignment padding.
888 pub fn stride(&self) -> Size {
889 self.min_size.abi_align(self.align)
893 /// The first half of a fat pointer.
894 /// - For a trait object, this is the address of the box.
895 /// - For a slice, this is the base address.
896 pub const FAT_PTR_ADDR: usize = 0;
898 /// The second half of a fat pointer.
899 /// - For a trait object, this is the address of the vtable.
900 /// - For a slice, this is the length.
901 pub const FAT_PTR_EXTRA: usize = 1;
903 /// Type layout, from which size and alignment can be cheaply computed.
904 /// For ADTs, it also includes field placement and enum optimizations.
905 /// NOTE: Because Layout is interned, redundant information should be
906 /// kept to a minimum, e.g. it includes no sub-component Ty or Layout.
907 #[derive(Debug, PartialEq, Eq, Hash)]
909 /// TyBool, TyChar, TyInt, TyUint, TyFloat, TyRawPtr, TyRef or TyFnPtr.
912 // If true, the value cannot represent a bit pattern of all zeroes.
916 /// SIMD vectors, from structs marked with #[repr(simd)].
922 /// TyArray, TySlice or TyStr.
924 /// If true, the size is exact, otherwise it's only a lower bound.
931 /// TyRawPtr or TyRef with a !Sized pointee.
934 // If true, the pointer cannot be null.
938 // Remaining variants are all ADTs such as structs, enums or tuples.
940 /// C-like enums; basically an integer.
945 // Inclusive discriminant range.
946 // If min > max, it represents min...u64::MAX followed by 0...max.
947 // FIXME(eddyb) always use the shortest range, e.g. by finding
948 // the largest space between two consecutive discriminants and
949 // taking everything else as the (shortest) discriminant range.
954 /// Single-case enums, and structs/tuples.
957 // If true, the structure is NonZero.
958 // FIXME(eddyb) use a newtype Layout kind for this.
967 /// General-case enums: for each case there is a struct, and they
968 /// all start with a field for the discriminant.
971 variants: Vec<Struct>,
976 /// Two cases distinguished by a nullable pointer: the case with discriminant
977 /// `nndiscr` must have single field which is known to be nonnull due to its type.
978 /// The other case is known to be zero sized. Hence we represent the enum
979 /// as simply a nullable pointer: if not null it indicates the `nndiscr` variant,
980 /// otherwise it indicates the other case.
982 /// For example, `std::option::Option` instantiated at a safe pointer type
983 /// is represented such that `None` is a null pointer and `Some` is the
984 /// identity function.
990 /// Two cases distinguished by a nullable pointer: the case with discriminant
991 /// `nndiscr` is represented by the struct `nonnull`, where the `discrfield`th
992 /// field is known to be nonnull due to its type; if that field is null, then
993 /// it represents the other case, which is known to be zero sized.
994 StructWrappedNullablePointer {
997 // N.B. There is a 0 at the start, for LLVM GEP through a pointer.
998 discrfield: FieldPath,
999 // Like discrfield, but in source order. For debuginfo.
1000 discrfield_source: FieldPath
1004 #[derive(Copy, Clone, Debug)]
1005 pub enum LayoutError<'tcx> {
1007 SizeOverflow(Ty<'tcx>)
1010 impl<'tcx> fmt::Display for LayoutError<'tcx> {
1011 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1013 LayoutError::Unknown(ty) => {
1014 write!(f, "the type `{:?}` has an unknown layout", ty)
1016 LayoutError::SizeOverflow(ty) => {
1017 write!(f, "the type `{:?}` is too big for the current architecture", ty)
1023 /// Helper function for normalizing associated types in an inference context.
1024 fn normalize_associated_type<'a, 'gcx, 'tcx>(infcx: &InferCtxt<'a, 'gcx, 'tcx>,
1027 if !ty.has_projection_types() {
1031 let mut selcx = traits::SelectionContext::new(infcx);
1032 let cause = traits::ObligationCause::dummy();
1033 let traits::Normalized { value: result, obligations } =
1034 traits::normalize(&mut selcx, cause, &ty);
1036 let mut fulfill_cx = traits::FulfillmentContext::new();
1038 for obligation in obligations {
1039 fulfill_cx.register_predicate_obligation(infcx, obligation);
1042 infcx.drain_fulfillment_cx_or_panic(DUMMY_SP, &mut fulfill_cx, &result)
1045 impl<'a, 'gcx, 'tcx> Layout {
1046 pub fn compute_uncached(ty: Ty<'gcx>,
1047 infcx: &InferCtxt<'a, 'gcx, 'tcx>)
1048 -> Result<&'gcx Layout, LayoutError<'gcx>> {
1049 let tcx = infcx.tcx.global_tcx();
1050 let success = |layout| Ok(tcx.intern_layout(layout));
1051 let dl = &tcx.data_layout;
1052 assert!(!ty.has_infer_types());
1054 let ptr_layout = |pointee: Ty<'gcx>| {
1055 let non_zero = !ty.is_unsafe_ptr();
1056 let pointee = normalize_associated_type(infcx, pointee);
1057 if pointee.is_sized(tcx, &infcx.parameter_environment, DUMMY_SP) {
1058 Ok(Scalar { value: Pointer, non_zero: non_zero })
1060 let unsized_part = tcx.struct_tail(pointee);
1061 let meta = match unsized_part.sty {
1062 ty::TySlice(_) | ty::TyStr => {
1063 Int(dl.ptr_sized_integer())
1065 ty::TyDynamic(..) => Pointer,
1066 _ => return Err(LayoutError::Unknown(unsized_part))
1068 Ok(FatPointer { metadata: meta, non_zero: non_zero })
1072 let layout = match ty.sty {
1074 ty::TyBool => Scalar { value: Int(I1), non_zero: false },
1075 ty::TyChar => Scalar { value: Int(I32), non_zero: false },
1078 value: Int(Integer::from_attr(dl, attr::SignedInt(ity))),
1082 ty::TyUint(ity) => {
1084 value: Int(Integer::from_attr(dl, attr::UnsignedInt(ity))),
1088 ty::TyFloat(FloatTy::F32) => Scalar { value: F32, non_zero: false },
1089 ty::TyFloat(FloatTy::F64) => Scalar { value: F64, non_zero: false },
1090 ty::TyFnPtr(_) => Scalar { value: Pointer, non_zero: true },
1093 ty::TyNever => Univariant {
1094 variant: Struct::new(dl, &vec![], &ReprOptions::default(),
1095 StructKind::AlwaysSizedUnivariant, ty)?,
1099 // Potentially-fat pointers.
1100 ty::TyRef(_, ty::TypeAndMut { ty: pointee, .. }) |
1101 ty::TyRawPtr(ty::TypeAndMut { ty: pointee, .. }) => {
1102 ptr_layout(pointee)?
1104 ty::TyAdt(def, _) if def.is_box() => {
1105 ptr_layout(ty.boxed_ty())?
1108 // Arrays and slices.
1109 ty::TyArray(element, count) => {
1110 let element = element.layout(infcx)?;
1111 let element_size = element.size(dl);
1112 // FIXME(eddyb) Don't use host `usize` for array lengths.
1113 let usize_count: usize = count;
1114 let count = usize_count as u64;
1115 if element_size.checked_mul(count, dl).is_none() {
1116 return Err(LayoutError::SizeOverflow(ty));
1120 align: element.align(dl),
1121 element_size: element_size,
1125 ty::TySlice(element) => {
1126 let element = element.layout(infcx)?;
1129 align: element.align(dl),
1130 element_size: element.size(dl),
1138 element_size: Size::from_bytes(1),
1144 ty::TyFnDef(..) => {
1146 variant: Struct::new(dl, &vec![],
1147 &ReprOptions::default(), StructKind::AlwaysSizedUnivariant, ty)?,
1151 ty::TyDynamic(..) => {
1152 let mut unit = Struct::new(dl, &vec![], &ReprOptions::default(),
1153 StructKind::AlwaysSizedUnivariant, ty)?;
1155 Univariant { variant: unit, non_zero: false }
1158 // Tuples and closures.
1159 ty::TyClosure(def_id, ref substs) => {
1160 let tys = substs.upvar_tys(def_id, tcx);
1161 let st = Struct::new(dl,
1162 &tys.map(|ty| ty.layout(infcx))
1163 .collect::<Result<Vec<_>, _>>()?,
1164 &ReprOptions::default(),
1165 StructKind::AlwaysSizedUnivariant, ty)?;
1166 Univariant { variant: st, non_zero: false }
1169 ty::TyTuple(tys, _) => {
1170 // FIXME(camlorn): if we ever allow unsized tuples, this needs to be checked.
1171 // See the univariant case below to learn how.
1172 let st = Struct::new(dl,
1173 &tys.iter().map(|ty| ty.layout(infcx))
1174 .collect::<Result<Vec<_>, _>>()?,
1175 &ReprOptions::default(), StructKind::AlwaysSizedUnivariant, ty)?;
1176 Univariant { variant: st, non_zero: false }
1179 // SIMD vector types.
1180 ty::TyAdt(def, ..) if def.repr.simd() => {
1181 let element = ty.simd_type(tcx);
1182 match *element.layout(infcx)? {
1183 Scalar { value, .. } => {
1184 return success(Vector {
1186 count: ty.simd_size(tcx) as u64
1190 tcx.sess.fatal(&format!("monomorphising SIMD type `{}` with \
1191 a non-machine element type `{}`",
1198 ty::TyAdt(def, substs) => {
1199 if def.variants.is_empty() {
1200 // Uninhabitable; represent as unit
1201 // (Typechecking will reject discriminant-sizing attrs.)
1203 return success(Univariant {
1204 variant: Struct::new(dl, &vec![],
1205 &def.repr, StructKind::AlwaysSizedUnivariant, ty)?,
1210 if def.is_enum() && def.variants.iter().all(|v| v.fields.is_empty()) {
1211 // All bodies empty -> intlike
1212 let (mut min, mut max, mut non_zero) = (i64::max_value(),
1215 for discr in def.discriminants(tcx) {
1216 let x = discr.to_u128_unchecked() as i64;
1217 if x == 0 { non_zero = false; }
1218 if x < min { min = x; }
1219 if x > max { max = x; }
1222 // FIXME: should handle i128? signed-value based impl is weird and hard to
1224 let (discr, signed) = Integer::repr_discr(tcx, ty, &def.repr, min, max);
1225 return success(CEnum {
1229 // FIXME: should be u128?
1235 if !def.is_enum() || (def.variants.len() == 1 &&
1236 !def.repr.inhibit_enum_layout_opt()) {
1237 // Struct, or union, or univariant enum equivalent to a struct.
1238 // (Typechecking will reject discriminant-sizing attrs.)
1240 let kind = if def.is_enum() || def.variants[0].fields.len() == 0{
1241 StructKind::AlwaysSizedUnivariant
1243 use middle::region::ROOT_CODE_EXTENT;
1244 let param_env = tcx.construct_parameter_environment(DUMMY_SP,
1245 def.did, ROOT_CODE_EXTENT);
1246 let fields = &def.variants[0].fields;
1247 let last_field = &fields[fields.len()-1];
1248 let always_sized = last_field.ty(tcx, param_env.free_substs)
1249 .is_sized(tcx, ¶m_env, DUMMY_SP);
1250 if !always_sized { StructKind::MaybeUnsizedUnivariant }
1251 else { StructKind::AlwaysSizedUnivariant }
1254 let fields = def.variants[0].fields.iter().map(|field| {
1255 field.ty(tcx, substs).layout(infcx)
1256 }).collect::<Result<Vec<_>, _>>()?;
1257 let layout = if def.is_union() {
1258 let mut un = Union::new(dl, def.repr.packed());
1259 un.extend(dl, fields.iter().map(|&f| Ok(f)), ty)?;
1260 UntaggedUnion { variants: un }
1262 let st = Struct::new(dl, &fields, &def.repr,
1264 let non_zero = Some(def.did) == tcx.lang_items.non_zero();
1265 Univariant { variant: st, non_zero: non_zero }
1267 return success(layout);
1270 // Since there's at least one
1271 // non-empty body, explicit discriminants should have
1272 // been rejected by a checker before this point.
1273 for (i, v) in def.variants.iter().enumerate() {
1274 if v.discr != ty::VariantDiscr::Relative(i) {
1275 bug!("non-C-like enum {} with specified discriminants",
1276 tcx.item_path_str(def.did));
1280 // Cache the substituted and normalized variant field types.
1281 let variants = def.variants.iter().map(|v| {
1282 v.fields.iter().map(|field| field.ty(tcx, substs)).collect::<Vec<_>>()
1283 }).collect::<Vec<_>>();
1285 if variants.len() == 2 && !def.repr.inhibit_enum_layout_opt() {
1286 // Nullable pointer optimization
1288 let other_fields = variants[1 - discr].iter().map(|ty| {
1291 if !Struct::would_be_zero_sized(dl, other_fields)? {
1294 let paths = Struct::non_zero_field_paths(infcx,
1295 variants[discr].iter().cloned(),
1297 let (mut path, mut path_source) = if let Some(p) = paths { p }
1300 // FIXME(eddyb) should take advantage of a newtype.
1301 if path == &[0] && variants[discr].len() == 1 {
1302 let value = match *variants[discr][0].layout(infcx)? {
1303 Scalar { value, .. } => value,
1304 CEnum { discr, .. } => Int(discr),
1305 _ => bug!("Layout::compute: `{}`'s non-zero \
1306 `{}` field not scalar?!",
1307 ty, variants[discr][0])
1309 return success(RawNullablePointer {
1310 nndiscr: discr as u64,
1315 let st = Struct::new(dl,
1316 &variants[discr].iter().map(|ty| ty.layout(infcx))
1317 .collect::<Result<Vec<_>, _>>()?,
1318 &def.repr, StructKind::AlwaysSizedUnivariant, ty)?;
1320 // We have to fix the last element of path here.
1321 let mut i = *path.last().unwrap();
1322 i = st.memory_index[i as usize];
1323 *path.last_mut().unwrap() = i;
1324 path.push(0); // For GEP through a pointer.
1326 path_source.push(0);
1327 path_source.reverse();
1329 return success(StructWrappedNullablePointer {
1330 nndiscr: discr as u64,
1333 discrfield_source: path_source
1338 // The general case.
1339 let discr_max = (variants.len() - 1) as i64;
1340 assert!(discr_max >= 0);
1341 let (min_ity, _) = Integer::repr_discr(tcx, ty, &def.repr, 0, discr_max);
1342 let mut align = dl.aggregate_align;
1343 let mut size = Size::from_bytes(0);
1345 // We're interested in the smallest alignment, so start large.
1346 let mut start_align = Align::from_bytes(256, 256).unwrap();
1348 // Create the set of structs that represent each variant
1349 // Use the minimum integer type we figured out above
1350 let discr = Scalar { value: Int(min_ity), non_zero: false };
1351 let mut variants = variants.into_iter().map(|fields| {
1352 let mut fields = fields.into_iter().map(|field| {
1354 }).collect::<Result<Vec<_>, _>>()?;
1355 fields.insert(0, &discr);
1356 let st = Struct::new(dl,
1358 &def.repr, StructKind::EnumVariant, ty)?;
1359 // Find the first field we can't move later
1360 // to make room for a larger discriminant.
1361 // It is important to skip the first field.
1362 for i in st.field_index_by_increasing_offset().skip(1) {
1363 let field = fields[i];
1364 let field_align = field.align(dl);
1365 if field.size(dl).bytes() != 0 || field_align.abi() != 1 {
1366 start_align = start_align.min(field_align);
1370 size = cmp::max(size, st.min_size);
1371 align = align.max(st.align);
1373 }).collect::<Result<Vec<_>, _>>()?;
1375 // Align the maximum variant size to the largest alignment.
1376 size = size.abi_align(align);
1378 if size.bytes() >= dl.obj_size_bound() {
1379 return Err(LayoutError::SizeOverflow(ty));
1382 let typeck_ity = Integer::from_attr(dl, def.repr.discr_type());
1383 if typeck_ity < min_ity {
1384 // It is a bug if Layout decided on a greater discriminant size than typeck for
1385 // some reason at this point (based on values discriminant can take on). Mostly
1386 // because this discriminant will be loaded, and then stored into variable of
1387 // type calculated by typeck. Consider such case (a bug): typeck decided on
1388 // byte-sized discriminant, but layout thinks we need a 16-bit to store all
1389 // discriminant values. That would be a bug, because then, in trans, in order
1390 // to store this 16-bit discriminant into 8-bit sized temporary some of the
1391 // space necessary to represent would have to be discarded (or layout is wrong
1392 // on thinking it needs 16 bits)
1393 bug!("layout decided on a larger discriminant type ({:?}) than typeck ({:?})",
1394 min_ity, typeck_ity);
1395 // However, it is fine to make discr type however large (as an optimisation)
1396 // after this point – we’ll just truncate the value we load in trans.
1399 // Check to see if we should use a different type for the
1400 // discriminant. We can safely use a type with the same size
1401 // as the alignment of the first field of each variant.
1402 // We increase the size of the discriminant to avoid LLVM copying
1403 // padding when it doesn't need to. This normally causes unaligned
1404 // load/stores and excessive memcpy/memset operations. By using a
1405 // bigger integer size, LLVM can be sure about it's contents and
1406 // won't be so conservative.
1408 // Use the initial field alignment
1409 let mut ity = Integer::for_abi_align(dl, start_align).unwrap_or(min_ity);
1411 // If the alignment is not larger than the chosen discriminant size,
1412 // don't use the alignment as the final size.
1416 // Patch up the variants' first few fields.
1417 let old_ity_size = Int(min_ity).size(dl);
1418 let new_ity_size = Int(ity).size(dl);
1419 for variant in &mut variants {
1420 for i in variant.offsets.iter_mut() {
1421 // The first field is the discrimminant, at offset 0.
1422 // These aren't in order, and we need to skip it.
1423 if *i <= old_ity_size && *i > Size::from_bytes(0) {
1427 // We might be making the struct larger.
1428 if variant.min_size <= old_ity_size {
1429 variant.min_size = new_ity_size;
1442 // Types with no meaningful known layout.
1443 ty::TyProjection(_) | ty::TyAnon(..) => {
1444 let normalized = normalize_associated_type(infcx, ty);
1445 if ty == normalized {
1446 return Err(LayoutError::Unknown(ty));
1448 return normalized.layout(infcx);
1451 return Err(LayoutError::Unknown(ty));
1453 ty::TyInfer(_) | ty::TyError => {
1454 bug!("Layout::compute: unexpected type `{}`", ty)
1461 /// Returns true if the layout corresponds to an unsized type.
1462 pub fn is_unsized(&self) -> bool {
1464 Scalar {..} | Vector {..} | FatPointer {..} |
1465 CEnum {..} | UntaggedUnion {..} | General {..} |
1466 RawNullablePointer {..} |
1467 StructWrappedNullablePointer {..} => false,
1469 Array { sized, .. } |
1470 Univariant { variant: Struct { sized, .. }, .. } => !sized
1474 pub fn size<C: HasDataLayout>(&self, cx: C) -> Size {
1475 let dl = cx.data_layout();
1478 Scalar { value, .. } | RawNullablePointer { value, .. } => {
1482 Vector { element, count } => {
1483 let element_size = element.size(dl);
1484 let vec_size = match element_size.checked_mul(count, dl) {
1486 None => bug!("Layout::size({:?}): {} * {} overflowed",
1487 self, element_size.bytes(), count)
1489 vec_size.abi_align(self.align(dl))
1492 Array { element_size, count, .. } => {
1493 match element_size.checked_mul(count, dl) {
1495 None => bug!("Layout::size({:?}): {} * {} overflowed",
1496 self, element_size.bytes(), count)
1500 FatPointer { metadata, .. } => {
1501 // Effectively a (ptr, meta) tuple.
1502 Pointer.size(dl).abi_align(metadata.align(dl))
1503 .checked_add(metadata.size(dl), dl).unwrap()
1504 .abi_align(self.align(dl))
1507 CEnum { discr, .. } => Int(discr).size(dl),
1508 General { size, .. } => size,
1509 UntaggedUnion { ref variants } => variants.stride(),
1511 Univariant { ref variant, .. } |
1512 StructWrappedNullablePointer { nonnull: ref variant, .. } => {
1518 pub fn align<C: HasDataLayout>(&self, cx: C) -> Align {
1519 let dl = cx.data_layout();
1522 Scalar { value, .. } | RawNullablePointer { value, .. } => {
1526 Vector { element, count } => {
1527 let elem_size = element.size(dl);
1528 let vec_size = match elem_size.checked_mul(count, dl) {
1530 None => bug!("Layout::align({:?}): {} * {} overflowed",
1531 self, elem_size.bytes(), count)
1533 for &(size, align) in &dl.vector_align {
1534 if size == vec_size {
1538 // Default to natural alignment, which is what LLVM does.
1539 // That is, use the size, rounded up to a power of 2.
1540 let align = vec_size.bytes().next_power_of_two();
1541 Align::from_bytes(align, align).unwrap()
1544 FatPointer { metadata, .. } => {
1545 // Effectively a (ptr, meta) tuple.
1546 Pointer.align(dl).max(metadata.align(dl))
1549 CEnum { discr, .. } => Int(discr).align(dl),
1550 Array { align, .. } | General { align, .. } => align,
1551 UntaggedUnion { ref variants } => variants.align,
1553 Univariant { ref variant, .. } |
1554 StructWrappedNullablePointer { nonnull: ref variant, .. } => {
1560 pub fn field_offset<C: HasDataLayout>(&self,
1563 variant_index: Option<usize>)
1565 let dl = cx.data_layout();
1570 UntaggedUnion { .. } |
1571 RawNullablePointer { .. } => {
1575 Vector { element, count } => {
1576 let element_size = element.size(dl);
1579 Size::from_bytes(element_size.bytes() * count)
1582 Array { element_size, count, .. } => {
1585 Size::from_bytes(element_size.bytes() * count)
1588 FatPointer { metadata, .. } => {
1589 // Effectively a (ptr, meta) tuple.
1594 Pointer.size(dl).abi_align(metadata.align(dl))
1598 Univariant { ref variant, .. } => variant.offsets[i],
1600 General { ref variants, .. } => {
1601 let v = variant_index.expect("variant index required");
1602 variants[v].offsets[i + 1]
1605 StructWrappedNullablePointer { nndiscr, ref nonnull, .. } => {
1606 if Some(nndiscr as usize) == variant_index {
1616 /// Type size "skeleton", i.e. the only information determining a type's size.
1617 /// While this is conservative, (aside from constant sizes, only pointers,
1618 /// newtypes thereof and null pointer optimized enums are allowed), it is
1619 /// enough to statically check common usecases of transmute.
1620 #[derive(Copy, Clone, Debug)]
1621 pub enum SizeSkeleton<'tcx> {
1622 /// Any statically computable Layout.
1625 /// A potentially-fat pointer.
1627 // If true, this pointer is never null.
1629 // The type which determines the unsized metadata, if any,
1630 // of this pointer. Either a type parameter or a projection
1631 // depending on one, with regions erased.
1636 impl<'a, 'gcx, 'tcx> SizeSkeleton<'gcx> {
1637 pub fn compute(ty: Ty<'gcx>, infcx: &InferCtxt<'a, 'gcx, 'tcx>)
1638 -> Result<SizeSkeleton<'gcx>, LayoutError<'gcx>> {
1639 let tcx = infcx.tcx.global_tcx();
1640 assert!(!ty.has_infer_types());
1642 // First try computing a static layout.
1643 let err = match ty.layout(infcx) {
1645 return Ok(SizeSkeleton::Known(layout.size(tcx)));
1650 let ptr_skeleton = |pointee: Ty<'gcx>| {
1651 let non_zero = !ty.is_unsafe_ptr();
1652 let tail = tcx.struct_tail(pointee);
1654 ty::TyParam(_) | ty::TyProjection(_) => {
1655 assert!(tail.has_param_types() || tail.has_self_ty());
1656 Ok(SizeSkeleton::Pointer {
1658 tail: tcx.erase_regions(&tail)
1662 bug!("SizeSkeleton::compute({}): layout errored ({}), yet \
1663 tail `{}` is not a type parameter or a projection",
1670 ty::TyRef(_, ty::TypeAndMut { ty: pointee, .. }) |
1671 ty::TyRawPtr(ty::TypeAndMut { ty: pointee, .. }) => {
1672 ptr_skeleton(pointee)
1674 ty::TyAdt(def, _) if def.is_box() => {
1675 ptr_skeleton(ty.boxed_ty())
1678 ty::TyAdt(def, substs) => {
1679 // Only newtypes and enums w/ nullable pointer optimization.
1680 if def.is_union() || def.variants.is_empty() || def.variants.len() > 2 {
1684 // Get a zero-sized variant or a pointer newtype.
1685 let zero_or_ptr_variant = |i: usize| {
1686 let fields = def.variants[i].fields.iter().map(|field| {
1687 SizeSkeleton::compute(field.ty(tcx, substs), infcx)
1690 for field in fields {
1693 SizeSkeleton::Known(size) => {
1694 if size.bytes() > 0 {
1698 SizeSkeleton::Pointer {..} => {
1709 let v0 = zero_or_ptr_variant(0)?;
1711 if def.variants.len() == 1 {
1712 if let Some(SizeSkeleton::Pointer { non_zero, tail }) = v0 {
1713 return Ok(SizeSkeleton::Pointer {
1714 non_zero: non_zero ||
1715 Some(def.did) == tcx.lang_items.non_zero(),
1723 let v1 = zero_or_ptr_variant(1)?;
1724 // Nullable pointer enum optimization.
1726 (Some(SizeSkeleton::Pointer { non_zero: true, tail }), None) |
1727 (None, Some(SizeSkeleton::Pointer { non_zero: true, tail })) => {
1728 Ok(SizeSkeleton::Pointer {
1737 ty::TyProjection(_) | ty::TyAnon(..) => {
1738 let normalized = normalize_associated_type(infcx, ty);
1739 if ty == normalized {
1742 SizeSkeleton::compute(normalized, infcx)
1750 pub fn same_size(self, other: SizeSkeleton) -> bool {
1751 match (self, other) {
1752 (SizeSkeleton::Known(a), SizeSkeleton::Known(b)) => a == b,
1753 (SizeSkeleton::Pointer { tail: a, .. },
1754 SizeSkeleton::Pointer { tail: b, .. }) => a == b,
1760 /// A pair of a type and its layout. Implements various
1761 /// type traversal APIs (e.g. recursing into fields).
1762 #[derive(Copy, Clone, Debug)]
1763 pub struct TyLayout<'tcx> {
1765 pub layout: &'tcx Layout,
1766 pub variant_index: Option<usize>,
1769 impl<'tcx> Deref for TyLayout<'tcx> {
1770 type Target = Layout;
1771 fn deref(&self) -> &Layout {
1776 pub trait HasTyCtxt<'tcx>: HasDataLayout {
1777 fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx>;
1780 impl<'a, 'gcx, 'tcx> HasDataLayout for TyCtxt<'a, 'gcx, 'tcx> {
1781 fn data_layout(&self) -> &TargetDataLayout {
1786 impl<'a, 'gcx, 'tcx> HasTyCtxt<'gcx> for TyCtxt<'a, 'gcx, 'tcx> {
1787 fn tcx<'b>(&'b self) -> TyCtxt<'b, 'gcx, 'gcx> {
1792 impl<'a, 'gcx, 'tcx> HasDataLayout for &'a InferCtxt<'a, 'gcx, 'tcx> {
1793 fn data_layout(&self) -> &TargetDataLayout {
1794 &self.tcx.data_layout
1798 impl<'a, 'gcx, 'tcx> HasTyCtxt<'gcx> for &'a InferCtxt<'a, 'gcx, 'tcx> {
1799 fn tcx<'b>(&'b self) -> TyCtxt<'b, 'gcx, 'gcx> {
1800 self.tcx.global_tcx()
1804 pub trait LayoutTyper<'tcx>: HasTyCtxt<'tcx> {
1807 fn layout_of(self, ty: Ty<'tcx>) -> Self::TyLayout;
1810 impl<'a, 'gcx, 'tcx> LayoutTyper<'gcx> for &'a InferCtxt<'a, 'gcx, 'tcx> {
1811 type TyLayout = Result<TyLayout<'gcx>, LayoutError<'gcx>>;
1813 fn layout_of(self, ty: Ty<'gcx>) -> Self::TyLayout {
1814 let ty = normalize_associated_type(self, ty);
1818 layout: ty.layout(self)?,
1824 impl<'a, 'tcx> TyLayout<'tcx> {
1825 pub fn for_variant(&self, variant_index: usize) -> Self {
1827 variant_index: Some(variant_index),
1832 pub fn field_offset<C: HasDataLayout>(&self, cx: C, i: usize) -> Size {
1833 self.layout.field_offset(cx, i, self.variant_index)
1836 pub fn field_count(&self) -> usize {
1837 // Handle enum/union through the type rather than Layout.
1838 if let ty::TyAdt(def, _) = self.ty.sty {
1839 let v = self.variant_index.unwrap_or(0);
1840 if def.variants.is_empty() {
1844 return def.variants[v].fields.len();
1848 match *self.layout {
1850 bug!("TyLayout::field_count({:?}): not applicable", self)
1853 // Handled above (the TyAdt case).
1856 UntaggedUnion { .. } |
1857 RawNullablePointer { .. } |
1858 StructWrappedNullablePointer { .. } => bug!(),
1860 FatPointer { .. } => 2,
1862 Vector { count, .. } |
1863 Array { count, .. } => {
1864 let usize_count = count as usize;
1865 assert_eq!(usize_count as u64, count);
1869 Univariant { ref variant, .. } => variant.offsets.len(),
1873 pub fn field_type<C: HasTyCtxt<'tcx>>(&self, cx: C, i: usize) -> Ty<'tcx> {
1876 let ptr_field_type = |pointee: Ty<'tcx>| {
1877 let slice = |element: Ty<'tcx>| {
1880 tcx.mk_mut_ptr(element)
1885 match tcx.struct_tail(pointee).sty {
1886 ty::TySlice(element) => slice(element),
1887 ty::TyStr => slice(tcx.types.u8),
1888 ty::TyDynamic(..) => tcx.mk_mut_ptr(tcx.mk_nil()),
1889 _ => bug!("TyLayout::field_type({:?}): not applicable", self)
1902 ty::TyDynamic(..) => {
1903 bug!("TyLayout::field_type({:?}): not applicable", self)
1906 // Potentially-fat pointers.
1907 ty::TyRef(_, ty::TypeAndMut { ty: pointee, .. }) |
1908 ty::TyRawPtr(ty::TypeAndMut { ty: pointee, .. }) => {
1909 ptr_field_type(pointee)
1911 ty::TyAdt(def, _) if def.is_box() => {
1912 ptr_field_type(self.ty.boxed_ty())
1915 // Arrays and slices.
1916 ty::TyArray(element, _) |
1917 ty::TySlice(element) => element,
1918 ty::TyStr => tcx.types.u8,
1920 // Tuples and closures.
1921 ty::TyClosure(def_id, ref substs) => {
1922 substs.upvar_tys(def_id, tcx).nth(i).unwrap()
1925 ty::TyTuple(tys, _) => tys[i],
1927 // SIMD vector types.
1928 ty::TyAdt(def, ..) if def.repr.simd() => {
1929 self.ty.simd_type(tcx)
1933 ty::TyAdt(def, substs) => {
1934 def.variants[self.variant_index.unwrap_or(0)].fields[i].ty(tcx, substs)
1937 ty::TyProjection(_) | ty::TyAnon(..) | ty::TyParam(_) |
1938 ty::TyInfer(_) | ty::TyError => {
1939 bug!("TyLayout::field_type: unexpected type `{}`", self.ty)
1944 pub fn field<C: LayoutTyper<'tcx>>(&self, cx: C, i: usize) -> C::TyLayout {
1945 cx.layout_of(self.field_type(cx, i))