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 (ptr, vtable) = arg.load_value_pair(fx);
  41     let usize_size = fx.layout_of(fx.tcx.types.usize).size.bytes();
  42     let func_ref = fx.bcx.ins().load(
  43         pointer_ty(fx.tcx),
  44         MemFlags::new(),
  45         vtable,
  46         ((idx + 3) * usize_size as usize) as i32,
  47     );
  48     (ptr, func_ref)
  49 }
  50
  51 pub fn get_vtable<'a, 'tcx: 'a>(
  52     fx: &mut FunctionCx<'a, 'tcx, impl Backend>,
  53     ty: Ty<'tcx>,
  54     trait_ref: Option<ty::PolyExistentialTraitRef<'tcx>>,
  55 ) -> Value {
  56     let data_id = if let Some(data_id) = fx.caches.vtables.get(&(ty, trait_ref)) {
  57         *data_id
  58     } else {
  59         let data_id = build_vtable(fx, ty, trait_ref);
  60         fx.caches.vtables.insert((ty, trait_ref), data_id);
  61         data_id
  62     };
  63
  64     let local_data_id = fx.module.declare_data_in_func(data_id, &mut fx.bcx.func);
  65     fx.bcx.ins().global_value(fx.pointer_type, local_data_id)
  66 }
  67
  68 fn build_vtable<'a, 'tcx: 'a>(
  69     fx: &mut FunctionCx<'a, 'tcx, impl Backend>,
  70     ty: Ty<'tcx>,
  71     trait_ref: Option<ty::PolyExistentialTraitRef<'tcx>>,
  72 ) -> DataId {
  73     let tcx = fx.tcx;
  74     let usize_size = fx.layout_of(fx.tcx.types.usize).size.bytes() as usize;
  75
  76     let drop_in_place_fn = import_function(
  77         tcx,
  78         fx.module,
  79         crate::rustc_mir::monomorphize::resolve_drop_in_place(tcx, ty),
  80     );
  81
  82     let mut components: Vec<_> = vec![Some(drop_in_place_fn), None, None];
  83
  84     let methods_root;
  85     let methods = if let Some(trait_ref) = trait_ref {
  86         methods_root = tcx.vtable_methods(trait_ref.with_self_ty(tcx, ty));
  87         methods_root.iter()
  88     } else {
  89         (&[]).iter()
  90     };
  91     let methods = methods.cloned().map(|opt_mth| {
  92         opt_mth.map_or(None, |(def_id, substs)| {
  93             Some(import_function(
  94                 tcx,
  95                 fx.module,
  96                 Instance::resolve(tcx, ParamEnv::reveal_all(), def_id, substs).unwrap(),
  97             ))
  98         })
  99     });
 100     components.extend(methods);
 101
 102     let mut data_ctx = DataContext::new();
 103     let mut data = ::std::iter::repeat(0u8)
 104         .take(components.len() * usize_size)
 105         .collect::<Vec<u8>>()
 106         .into_boxed_slice();
 107
 108     let layout = tcx.layout_of(ParamEnv::reveal_all().and(ty)).unwrap();
 109     write_usize(fx.tcx, &mut data, SIZE_INDEX, layout.size.bytes());
 110     write_usize(fx.tcx, &mut data, ALIGN_INDEX, layout.align.abi.bytes());
 111     data_ctx.define(data);
 112
 113     for (i, component) in components.into_iter().enumerate() {
 114         if let Some(func_id) = component {
 115             let func_ref = fx.module.declare_func_in_data(func_id, &mut data_ctx);
 116             data_ctx.write_function_addr((i * usize_size) as u32, func_ref);
 117         }
 118     }
 119
 120     let data_id = fx
 121         .module
 122         .declare_data(
 123             &format!("vtable.{:?}.for.{:?}", trait_ref, ty),
 124             Linkage::Local,
 125             false,
 126         )
 127         .unwrap();
 128     fx.module.define_data(data_id, &data_ctx).unwrap();
 129     data_id
 130 }
 131
 132 fn write_usize(tcx: TyCtxt, buf: &mut [u8], idx: usize, num: u64) {
 133     use byteorder::{BigEndian, LittleEndian, WriteBytesExt};
 134
 135     let usize_size = tcx
 136         .layout_of(ParamEnv::reveal_all().and(tcx.types.usize))
 137         .unwrap()
 138         .size
 139         .bytes() as usize;
 140     let mut target = &mut buf[idx * usize_size..(idx + 1) * usize_size];
 141
 142     match tcx.data_layout.endian {
 143         layout::Endian::Little => target.write_uint::<LittleEndian>(num, usize_size),
 144         layout::Endian::Big => target.write_uint::<BigEndian>(num, usize_size),
 145     }
 146     .unwrap()
 147 }