src/vtable.rs

   1 //! See librustc_codegen_llvm/meth.rs for reference
   2
   3 use crate::prelude::*;
   4
   5 const DROP_FN_INDEX: usize = 0;
   6 const SIZE_INDEX: usize = 1;
   7 const ALIGN_INDEX: usize = 2;
   8
   9 pub fn size_of_obj<'a, 'tcx: 'a>(
  10     fx: &mut FunctionCx<'a, 'tcx, impl Backend>,
  11     vtable: Value,
  12 ) -> Value {
  13     let usize_size = fx.layout_of(fx.tcx.types.usize).size.bytes() as usize;
  14     fx.bcx.ins().load(
  15         pointer_ty(fx.tcx),
  16         MemFlags::new(),
  17         vtable,
  18         (SIZE_INDEX * usize_size) as i32,
  19     )
  20 }
  21
  22 pub fn min_align_of_obj<'a, 'tcx: 'a>(
  23     fx: &mut FunctionCx<'a, 'tcx, impl Backend>,
  24     vtable: Value,
  25 ) -> Value {
  26     let usize_size = fx.layout_of(fx.tcx.types.usize).size.bytes() as usize;
  27     fx.bcx.ins().load(
  28         pointer_ty(fx.tcx),
  29         MemFlags::new(),
  30         vtable,
  31         (ALIGN_INDEX * usize_size) as i32,
  32     )
  33 }
  34
  35 pub fn get_ptr_and_method_ref<'a, 'tcx: 'a>(
  36     fx: &mut FunctionCx<'a, 'tcx, impl Backend>,
  37     arg: CValue<'tcx>,
  38     idx: usize,
  39 ) -> (Value, Value) {
  40     let arg = if arg.layout().ty.is_box() {
  41         // Cast `Box<T>` to `*mut T` so `load_value_pair` works
  42         arg.unchecked_cast_to(fx.layout_of(fx.tcx.mk_mut_ptr(arg.layout().ty.boxed_ty())))
  43     } else {
  44         arg
  45     };
  46
  47     let (ptr, vtable) = arg.load_value_pair(fx);
  48     let usize_size = fx.layout_of(fx.tcx.types.usize).size.bytes();
  49     let func_ref = fx.bcx.ins().load(
  50         pointer_ty(fx.tcx),
  51         MemFlags::new(),
  52         vtable,
  53         ((idx + 3) * usize_size as usize) as i32,
  54     );
  55     (ptr, func_ref)
  56 }
  57
  58 pub fn get_vtable<'a, 'tcx: 'a>(
  59     fx: &mut FunctionCx<'a, 'tcx, impl Backend>,
  60     ty: Ty<'tcx>,
  61     trait_ref: Option<ty::PolyExistentialTraitRef<'tcx>>,
  62 ) -> Value {
  63     let data_id = if let Some(data_id) = fx.caches.vtables.get(&(ty, trait_ref)) {
  64         *data_id
  65     } else {
  66         let data_id = build_vtable(fx, ty, trait_ref);
  67         fx.caches.vtables.insert((ty, trait_ref), data_id);
  68         data_id
  69     };
  70
  71     let local_data_id = fx.module.declare_data_in_func(data_id, &mut fx.bcx.func);
  72     fx.bcx.ins().global_value(fx.pointer_type, local_data_id)
  73 }
  74
  75 fn build_vtable<'a, 'tcx: 'a>(
  76     fx: &mut FunctionCx<'a, 'tcx, impl Backend>,
  77     ty: Ty<'tcx>,
  78     trait_ref: Option<ty::PolyExistentialTraitRef<'tcx>>,
  79 ) -> DataId {
  80     let tcx = fx.tcx;
  81     let usize_size = fx.layout_of(fx.tcx.types.usize).size.bytes() as usize;
  82
  83     let drop_in_place_fn = import_function(
  84         tcx,
  85         fx.module,
  86         crate::rustc_mir::monomorphize::resolve_drop_in_place(tcx, ty),
  87     );
  88
  89     let mut components: Vec<_> = vec![Some(drop_in_place_fn), None, None];
  90
  91     let methods_root;
  92     let methods = if let Some(trait_ref) = trait_ref {
  93         methods_root = tcx.vtable_methods(trait_ref.with_self_ty(tcx, ty));
  94         methods_root.iter()
  95     } else {
  96         (&[]).iter()
  97     };
  98     let methods = methods.cloned().map(|opt_mth| {
  99         opt_mth.map_or(None, |(def_id, substs)| {
 100             Some(import_function(
 101                 tcx,
 102                 fx.module,
 103                 Instance::resolve(tcx, ParamEnv::reveal_all(), def_id, substs).unwrap(),
 104             ))
 105         })
 106     });
 107     components.extend(methods);
 108
 109     let mut data_ctx = DataContext::new();
 110     let mut data = ::std::iter::repeat(0u8)
 111         .take(components.len() * usize_size)
 112         .collect::<Vec<u8>>()
 113         .into_boxed_slice();
 114
 115     let layout = tcx.layout_of(ParamEnv::reveal_all().and(ty)).unwrap();
 116     write_usize(fx.tcx, &mut data, SIZE_INDEX, layout.size.bytes());
 117     write_usize(fx.tcx, &mut data, ALIGN_INDEX, layout.align.abi.bytes());
 118     data_ctx.define(data);
 119
 120     for (i, component) in components.into_iter().enumerate() {
 121         if let Some(func_id) = component {
 122             let func_ref = fx.module.declare_func_in_data(func_id, &mut data_ctx);
 123             data_ctx.write_function_addr((i * usize_size) as u32, func_ref);
 124         }
 125     }
 126
 127     let data_id = fx
 128         .module
 129         .declare_data(
 130             &format!("vtable.{:?}.for.{:?}", trait_ref, ty),
 131             Linkage::Local,
 132             false,
 133         )
 134         .unwrap();
 135     fx.module.define_data(data_id, &data_ctx).unwrap();
 136     data_id
 137 }
 138
 139 fn write_usize(tcx: TyCtxt, buf: &mut [u8], idx: usize, num: u64) {
 140     use byteorder::{BigEndian, LittleEndian, WriteBytesExt};
 141
 142     let usize_size = tcx
 143         .layout_of(ParamEnv::reveal_all().and(tcx.types.usize))
 144         .unwrap()
 145         .size
 146         .bytes() as usize;
 147     let mut target = &mut buf[idx * usize_size..(idx + 1) * usize_size];
 148
 149     match tcx.data_layout.endian {
 150         layout::Endian::Little => target.write_uint::<LittleEndian>(num, usize_size),
 151         layout::Endian::Big => target.write_uint::<BigEndian>(num, usize_size),
 152     }
 153     .unwrap()
 154 }