src/unsize.rs

   1 //! Codegen of the [`PointerCast::Unsize`] operation.
   2 //!
   3 //! [`PointerCast::Unsize`]: `rustc_middle::ty::adjustment::PointerCast::Unsize`
   4
   5 use crate::prelude::*;
   6
   7 // Adapted from https://github.com/rust-lang/rust/blob/2a663555ddf36f6b041445894a8c175cd1bc718c/src/librustc_codegen_ssa/base.rs#L159-L307
   8
   9 /// Retrieve the information we are losing (making dynamic) in an unsizing
  10 /// adjustment.
  11 ///
  12 /// The `old_info` argument is a bit funny. It is intended for use
  13 /// in an upcast, where the new vtable for an object will be derived
  14 /// from the old one.
  15 pub(crate) fn unsized_info<'tcx>(
  16     fx: &mut FunctionCx<'_, '_, 'tcx>,
  17     source: Ty<'tcx>,
  18     target: Ty<'tcx>,
  19     old_info: Option<Value>,
  20 ) -> Value {
  21     let (source, target) =
  22         fx.tcx.struct_lockstep_tails_erasing_lifetimes(source, target, ParamEnv::reveal_all());
  23     match (&source.kind(), &target.kind()) {
  24         (&ty::Array(_, len), &ty::Slice(_)) => fx
  25             .bcx
  26             .ins()
  27             .iconst(fx.pointer_type, len.eval_usize(fx.tcx, ParamEnv::reveal_all()) as i64),
  28         (&ty::Dynamic(ref data_a, ..), &ty::Dynamic(ref data_b, ..)) => {
  29             let old_info =
  30                 old_info.expect("unsized_info: missing old info for trait upcasting coercion");
  31             if data_a.principal_def_id() == data_b.principal_def_id() {
  32                 return old_info;
  33             }
  34             // trait upcasting coercion
  35
  36             // if both of the two `principal`s are `None`, this function would have returned early above.
  37             // and if one of the two `principal`s is `None`, typechecking would have rejected this case.
  38             let principal_a = data_a
  39                 .principal()
  40                 .expect("unsized_info: missing principal trait for trait upcasting coercion");
  41             let principal_b = data_b
  42                 .principal()
  43                 .expect("unsized_info: missing principal trait for trait upcasting coercion");
  44
  45             let vptr_entry_idx = fx.tcx.vtable_trait_upcasting_coercion_new_vptr_slot((
  46                 principal_a.with_self_ty(fx.tcx, source),
  47                 principal_b.with_self_ty(fx.tcx, source),
  48             ));
  49
  50             if let Some(entry_idx) = vptr_entry_idx {
  51                 let entry_idx = u32::try_from(entry_idx).unwrap();
  52                 let entry_offset = entry_idx * fx.pointer_type.bytes();
  53                 let vptr_ptr = Pointer::new(old_info).offset_i64(fx, entry_offset.into()).load(
  54                     fx,
  55                     fx.pointer_type,
  56                     crate::vtable::vtable_memflags(),
  57                 );
  58                 vptr_ptr
  59             } else {
  60                 old_info
  61             }
  62         }
  63         (_, &ty::Dynamic(ref data, ..)) => crate::vtable::get_vtable(fx, source, data.principal()),
  64         _ => bug!("unsized_info: invalid unsizing {:?} -> {:?}", source, target),
  65     }
  66 }
  67
  68 /// Coerce `src` to `dst_ty`.
  69 fn unsize_ptr<'tcx>(
  70     fx: &mut FunctionCx<'_, '_, 'tcx>,
  71     src: Value,
  72     src_layout: TyAndLayout<'tcx>,
  73     dst_layout: TyAndLayout<'tcx>,
  74     old_info: Option<Value>,
  75 ) -> (Value, Value) {
  76     match (&src_layout.ty.kind(), &dst_layout.ty.kind()) {
  77         (&ty::Ref(_, a, _), &ty::Ref(_, b, _))
  78         | (&ty::Ref(_, a, _), &ty::RawPtr(ty::TypeAndMut { ty: b, .. }))
  79         | (&ty::RawPtr(ty::TypeAndMut { ty: a, .. }), &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) => {
  80             (src, unsized_info(fx, a, b, old_info))
  81         }
  82         (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
  83             let (a, b) = (src_layout.ty.boxed_ty(), dst_layout.ty.boxed_ty());
  84             (src, unsized_info(fx, a, b, old_info))
  85         }
  86         (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) => {
  87             assert_eq!(def_a, def_b);
  88
  89             if src_layout == dst_layout {
  90                 return (src, old_info.unwrap());
  91             }
  92
  93             let mut result = None;
  94             for i in 0..src_layout.fields.count() {
  95                 let src_f = src_layout.field(fx, i);
  96                 assert_eq!(src_layout.fields.offset(i).bytes(), 0);
  97                 assert_eq!(dst_layout.fields.offset(i).bytes(), 0);
  98                 if src_f.is_zst() {
  99                     continue;
 100                 }
 101                 assert_eq!(src_layout.size, src_f.size);
 102
 103                 let dst_f = dst_layout.field(fx, i);
 104                 assert_ne!(src_f.ty, dst_f.ty);
 105                 assert_eq!(result, None);
 106                 result = Some(unsize_ptr(fx, src, src_f, dst_f, old_info));
 107             }
 108             result.unwrap()
 109         }
 110         _ => bug!("unsize_ptr: called on bad types"),
 111     }
 112 }
 113
 114 /// Coerce `src`, which is a reference to a value of type `src_ty`,
 115 /// to a value of type `dst_ty` and store the result in `dst`
 116 pub(crate) fn coerce_unsized_into<'tcx>(
 117     fx: &mut FunctionCx<'_, '_, 'tcx>,
 118     src: CValue<'tcx>,
 119     dst: CPlace<'tcx>,
 120 ) {
 121     let src_ty = src.layout().ty;
 122     let dst_ty = dst.layout().ty;
 123     let mut coerce_ptr = || {
 124         let (base, info) =
 125             if fx.layout_of(src.layout().ty.builtin_deref(true).unwrap().ty).is_unsized() {
 126                 let (old_base, old_info) = src.load_scalar_pair(fx);
 127                 unsize_ptr(fx, old_base, src.layout(), dst.layout(), Some(old_info))
 128             } else {
 129                 let base = src.load_scalar(fx);
 130                 unsize_ptr(fx, base, src.layout(), dst.layout(), None)
 131             };
 132         dst.write_cvalue(fx, CValue::by_val_pair(base, info, dst.layout()));
 133     };
 134     match (&src_ty.kind(), &dst_ty.kind()) {
 135         (&ty::Ref(..), &ty::Ref(..))
 136         | (&ty::Ref(..), &ty::RawPtr(..))
 137         | (&ty::RawPtr(..), &ty::RawPtr(..)) => coerce_ptr(),
 138         (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) => {
 139             assert_eq!(def_a, def_b);
 140
 141             for i in 0..def_a.variants[VariantIdx::new(0)].fields.len() {
 142                 let src_f = src.value_field(fx, mir::Field::new(i));
 143                 let dst_f = dst.place_field(fx, mir::Field::new(i));
 144
 145                 if dst_f.layout().is_zst() {
 146                     continue;
 147                 }
 148
 149                 if src_f.layout().ty == dst_f.layout().ty {
 150                     dst_f.write_cvalue(fx, src_f);
 151                 } else {
 152                     coerce_unsized_into(fx, src_f, dst_f);
 153                 }
 154             }
 155         }
 156         _ => bug!("coerce_unsized_into: invalid coercion {:?} -> {:?}", src_ty, dst_ty),
 157     }
 158 }
 159
 160 // Adapted from https://github.com/rust-lang/rust/blob/2a663555ddf36f6b041445894a8c175cd1bc718c/src/librustc_codegen_ssa/glue.rs
 161
 162 pub(crate) fn size_and_align_of_dst<'tcx>(
 163     fx: &mut FunctionCx<'_, '_, 'tcx>,
 164     layout: TyAndLayout<'tcx>,
 165     info: Value,
 166 ) -> (Value, Value) {
 167     if !layout.is_unsized() {
 168         let size = fx.bcx.ins().iconst(fx.pointer_type, layout.size.bytes() as i64);
 169         let align = fx.bcx.ins().iconst(fx.pointer_type, layout.align.abi.bytes() as i64);
 170         return (size, align);
 171     }
 172     match layout.ty.kind() {
 173         ty::Dynamic(..) => {
 174             // load size/align from vtable
 175             (crate::vtable::size_of_obj(fx, info), crate::vtable::min_align_of_obj(fx, info))
 176         }
 177         ty::Slice(_) | ty::Str => {
 178             let unit = layout.field(fx, 0);
 179             // The info in this case is the length of the str, so the size is that
 180             // times the unit size.
 181             (
 182                 fx.bcx.ins().imul_imm(info, unit.size.bytes() as i64),
 183                 fx.bcx.ins().iconst(fx.pointer_type, unit.align.abi.bytes() as i64),
 184             )
 185         }
 186         _ => {
 187             // First get the size of all statically known fields.
 188             // Don't use size_of because it also rounds up to alignment, which we
 189             // want to avoid, as the unsized field's alignment could be smaller.
 190             assert!(!layout.ty.is_simd());
 191
 192             let i = layout.fields.count() - 1;
 193             let sized_size = layout.fields.offset(i).bytes();
 194             let sized_align = layout.align.abi.bytes();
 195             let sized_align = fx.bcx.ins().iconst(fx.pointer_type, sized_align as i64);
 196
 197             // Recurse to get the size of the dynamically sized field (must be
 198             // the last field).
 199             let field_layout = layout.field(fx, i);
 200             let (unsized_size, mut unsized_align) = size_and_align_of_dst(fx, field_layout, info);
 201
 202             // FIXME (#26403, #27023): We should be adding padding
 203             // to `sized_size` (to accommodate the `unsized_align`
 204             // required of the unsized field that follows) before
 205             // summing it with `sized_size`. (Note that since #26403
 206             // is unfixed, we do not yet add the necessary padding
 207             // here. But this is where the add would go.)
 208
 209             // Return the sum of sizes and max of aligns.
 210             let size = fx.bcx.ins().iadd_imm(unsized_size, sized_size as i64);
 211
 212             // Packed types ignore the alignment of their fields.
 213             if let ty::Adt(def, _) = layout.ty.kind() {
 214                 if def.repr.packed() {
 215                     unsized_align = sized_align;
 216                 }
 217             }
 218
 219             // Choose max of two known alignments (combined value must
 220             // be aligned according to more restrictive of the two).
 221             let cmp = fx.bcx.ins().icmp(IntCC::UnsignedGreaterThan, sized_align, unsized_align);
 222             let align = fx.bcx.ins().select(cmp, sized_align, unsized_align);
 223
 224             // Issue #27023: must add any necessary padding to `size`
 225             // (to make it a multiple of `align`) before returning it.
 226             //
 227             // Namely, the returned size should be, in C notation:
 228             //
 229             //   `size + ((size & (align-1)) ? align : 0)`
 230             //
 231             // emulated via the semi-standard fast bit trick:
 232             //
 233             //   `(size + (align-1)) & -align`
 234             let addend = fx.bcx.ins().iadd_imm(align, -1);
 235             let add = fx.bcx.ins().iadd(size, addend);
 236             let neg = fx.bcx.ins().ineg(align);
 237             let size = fx.bcx.ins().band(add, neg);
 238
 239             (size, align)
 240         }
 241     }
 242 }