3 use cranelift_codegen::ir::immediates::Offset32;
5 fn codegen_field<'tcx>(
6 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
9 layout: TyLayout<'tcx>,
11 ) -> (Pointer, TyLayout<'tcx>) {
12 let field_offset = layout.fields.offset(field.index());
13 let field_layout = layout.field(&*fx, field.index());
15 let simple = |fx: &mut FunctionCx<_>| {
17 base.offset_i64(fx, i64::try_from(field_offset.bytes()).unwrap()),
22 if let Some(extra) = extra {
23 if !field_layout.is_unsized() {
26 match field_layout.ty.kind {
27 ty::Slice(..) | ty::Str | ty::Foreign(..) => return simple(fx),
28 ty::Adt(def, _) if def.repr.packed() => {
29 assert_eq!(layout.align.abi.bytes(), 1);
33 // We have to align the offset for DST's
34 let unaligned_offset = field_offset.bytes();
35 let (_, unsized_align) = crate::unsize::size_and_align_of_dst(fx, field_layout.ty, extra);
37 let one = fx.bcx.ins().iconst(pointer_ty(fx.tcx), 1);
38 let align_sub_1 = fx.bcx.ins().isub(unsized_align, one);
39 let and_lhs = fx.bcx.ins().iadd_imm(align_sub_1, unaligned_offset as i64);
40 let zero = fx.bcx.ins().iconst(pointer_ty(fx.tcx), 0);
41 let and_rhs = fx.bcx.ins().isub(zero, unsized_align);
42 let offset = fx.bcx.ins().band(and_lhs, and_rhs);
45 base.offset_value(fx, offset),
55 fn scalar_pair_calculate_b_offset(tcx: TyCtxt<'_>, a_scalar: &Scalar, b_scalar: &Scalar) -> Offset32 {
56 let b_offset = a_scalar
59 .align_to(b_scalar.value.align(&tcx).abi);
60 Offset32::new(b_offset.bytes().try_into().unwrap())
64 #[derive(Debug, Copy, Clone)]
65 pub struct CValue<'tcx>(CValueInner, TyLayout<'tcx>);
67 #[derive(Debug, Copy, Clone)]
71 ByValPair(Value, Value),
74 impl<'tcx> CValue<'tcx> {
75 pub fn by_ref(ptr: Pointer, layout: TyLayout<'tcx>) -> CValue<'tcx> {
76 CValue(CValueInner::ByRef(ptr), layout)
79 pub fn by_val(value: Value, layout: TyLayout<'tcx>) -> CValue<'tcx> {
80 CValue(CValueInner::ByVal(value), layout)
83 pub fn by_val_pair(value: Value, extra: Value, layout: TyLayout<'tcx>) -> CValue<'tcx> {
84 CValue(CValueInner::ByValPair(value, extra), layout)
87 pub fn layout(&self) -> TyLayout<'tcx> {
91 pub fn force_stack<'a>(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> Pointer {
94 CValueInner::ByRef(ptr) => ptr,
95 CValueInner::ByVal(_) | CValueInner::ByValPair(_, _) => {
96 let cplace = CPlace::new_stack_slot(fx, layout.ty);
97 cplace.write_cvalue(fx, self);
103 pub fn try_to_addr(self) -> Option<Value> {
105 CValueInner::ByRef(ptr) => {
106 if let Some((base_addr, offset)) = ptr.try_get_addr_and_offset() {
107 if offset == Offset32::new(0) {
116 CValueInner::ByVal(_) | CValueInner::ByValPair(_, _) => None,
120 /// Load a value with layout.abi of scalar
121 pub fn load_scalar<'a>(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> Value {
124 CValueInner::ByRef(ptr) => {
125 let scalar = match layout.abi {
126 layout::Abi::Scalar(ref scalar) => scalar.clone(),
129 let clif_ty = scalar_to_clif_type(fx.tcx, scalar);
130 ptr.load(fx, clif_ty, MemFlags::new())
132 CValueInner::ByVal(value) => value,
133 CValueInner::ByValPair(_, _) => bug!("Please use load_scalar_pair for ByValPair"),
137 /// Load a value pair with layout.abi of scalar pair
138 pub fn load_scalar_pair<'a>(
140 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
141 ) -> (Value, Value) {
144 CValueInner::ByRef(ptr) => {
145 let (a_scalar, b_scalar) = match &layout.abi {
146 layout::Abi::ScalarPair(a, b) => (a, b),
147 _ => unreachable!("load_scalar_pair({:?})", self),
149 let b_offset = scalar_pair_calculate_b_offset(fx.tcx, a_scalar, b_scalar);
150 let clif_ty1 = scalar_to_clif_type(fx.tcx, a_scalar.clone());
151 let clif_ty2 = scalar_to_clif_type(fx.tcx, b_scalar.clone());
152 let val1 = ptr.load(fx, clif_ty1, MemFlags::new());
153 let val2 = ptr.offset(fx, b_offset).load(fx, clif_ty2, MemFlags::new());
156 CValueInner::ByVal(_) => bug!("Please use load_scalar for ByVal"),
157 CValueInner::ByValPair(val1, val2) => (val1, val2),
161 /// Load a value with layout.abi of vector
162 pub fn load_vector<'a>(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> Value {
165 CValueInner::ByRef(ptr) => {
166 let clif_ty = match layout.abi {
167 layout::Abi::Vector { ref element, count } => {
168 scalar_to_clif_type(fx.tcx, element.clone()).by(u16::try_from(count).unwrap()).unwrap()
172 ptr.load(fx, clif_ty, MemFlags::new())
174 CValueInner::ByVal(value) => value,
175 CValueInner::ByValPair(_, _) => bug!("Please use load_scalar_pair for ByValPair"),
179 pub fn value_field<'a>(
181 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
185 let ptr = match self.0 {
186 CValueInner::ByRef(ptr) => ptr,
187 _ => bug!("place_field for {:?}", self),
190 let (field_ptr, field_layout) = codegen_field(fx, ptr, None, layout, field);
191 CValue::by_ref(field_ptr, field_layout)
194 pub fn unsize_value<'a>(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>, dest: CPlace<'tcx>) {
195 crate::unsize::coerce_unsized_into(fx, self, dest);
198 /// If `ty` is signed, `const_val` must already be sign extended.
199 pub fn const_val<'a>(
200 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
204 let clif_ty = fx.clif_type(ty).unwrap();
205 let layout = fx.layout_of(ty);
207 let val = match ty.kind {
208 ty::TyKind::Uint(UintTy::U128) | ty::TyKind::Int(IntTy::I128) => {
209 let lsb = fx.bcx.ins().iconst(types::I64, const_val as u64 as i64);
213 .iconst(types::I64, (const_val >> 64) as u64 as i64);
214 fx.bcx.ins().iconcat(lsb, msb)
216 ty::TyKind::Bool => {
218 const_val == 0 || const_val == 1,
219 "Invalid bool 0x{:032X}",
222 fx.bcx.ins().iconst(types::I8, const_val as i64)
224 ty::TyKind::Uint(_) | ty::TyKind::Ref(..) | ty::TyKind::RawPtr(..) => fx
227 .iconst(clif_ty, u64::try_from(const_val).expect("uint") as i64),
228 ty::TyKind::Int(_) => fx.bcx.ins().iconst(clif_ty, const_val as i128 as i64),
230 "CValue::const_val for non bool/integer/pointer type {:?} is not allowed",
235 CValue::by_val(val, layout)
238 pub fn unchecked_cast_to(self, layout: TyLayout<'tcx>) -> Self {
239 CValue(self.0, layout)
243 /// A place where you can write a value to or read a value from
244 #[derive(Debug, Copy, Clone)]
245 pub struct CPlace<'tcx> {
247 layout: TyLayout<'tcx>,
250 #[derive(Debug, Copy, Clone)]
251 pub enum CPlaceInner {
253 Addr(Pointer, Option<Value>),
257 impl<'tcx> CPlace<'tcx> {
258 pub fn layout(&self) -> TyLayout<'tcx> {
262 pub fn inner(&self) -> &CPlaceInner {
266 pub fn no_place(layout: TyLayout<'tcx>) -> CPlace<'tcx> {
268 inner: CPlaceInner::NoPlace,
273 pub fn new_stack_slot(
274 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
277 let layout = fx.layout_of(ty);
278 assert!(!layout.is_unsized());
279 if layout.size.bytes() == 0 {
281 inner: CPlaceInner::NoPlace,
286 let stack_slot = fx.bcx.create_stack_slot(StackSlotData {
287 kind: StackSlotKind::ExplicitSlot,
288 size: layout.size.bytes() as u32,
292 inner: CPlaceInner::Addr(Pointer::stack_slot(stack_slot), None),
298 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
300 layout: TyLayout<'tcx>,
303 .declare_var(mir_var(local), fx.clif_type(layout.ty).unwrap());
305 inner: CPlaceInner::Var(local),
310 pub fn for_ptr(ptr: Pointer, layout: TyLayout<'tcx>) -> CPlace<'tcx> {
312 inner: CPlaceInner::Addr(ptr, None),
317 pub fn for_ptr_with_extra(ptr: Pointer, extra: Value, layout: TyLayout<'tcx>) -> CPlace<'tcx> {
319 inner: CPlaceInner::Addr(ptr, Some(extra)),
324 pub fn to_cvalue(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> CValue<'tcx> {
325 let layout = self.layout();
327 CPlaceInner::Var(var) => {
328 let val = fx.bcx.use_var(mir_var(var));
329 fx.bcx.set_val_label(val, cranelift_codegen::ir::ValueLabel::from_u32(var.as_u32()));
330 CValue::by_val(val, layout)
332 CPlaceInner::Addr(ptr, extra) => {
333 assert!(extra.is_none(), "unsized values are not yet supported");
334 CValue::by_ref(ptr, layout)
336 CPlaceInner::NoPlace => CValue::by_ref(
337 Pointer::const_addr(fx, i64::try_from(self.layout.align.pref.bytes()).unwrap()),
343 pub fn to_ptr(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> Pointer {
344 match self.to_ptr_maybe_unsized(fx) {
346 (_, Some(_)) => bug!("Expected sized cplace, found {:?}", self),
350 pub fn to_ptr_maybe_unsized(
352 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
353 ) -> (Pointer, Option<Value>) {
355 CPlaceInner::Addr(ptr, extra) => (ptr, extra),
356 CPlaceInner::NoPlace => {
358 Pointer::const_addr(fx, i64::try_from(self.layout.align.pref.bytes()).unwrap()),
362 CPlaceInner::Var(_) => bug!("Expected CPlace::Addr, found CPlace::Var"),
366 pub fn write_cvalue(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>, from: CValue<'tcx>) {
367 #[cfg(debug_assertions)]
369 use cranelift_codegen::cursor::{Cursor, CursorPosition};
370 let cur_ebb = match fx.bcx.cursor().position() {
371 CursorPosition::After(ebb) => ebb,
375 fx.bcx.func.layout.last_inst(cur_ebb).unwrap(),
376 format!("write_cvalue: {:?} <- {:?}",self, from),
380 let from_ty = from.layout().ty;
381 let to_ty = self.layout().ty;
383 fn assert_assignable<'tcx>(
384 fx: &FunctionCx<'_, 'tcx, impl Backend>,
388 match (&from_ty.kind, &to_ty.kind) {
389 (ty::Ref(_, t, Mutability::Not), ty::Ref(_, u, Mutability::Not))
390 | (ty::Ref(_, t, Mutability::Mut), ty::Ref(_, u, Mutability::Not))
391 | (ty::Ref(_, t, Mutability::Mut), ty::Ref(_, u, Mutability::Mut)) => {
392 assert_assignable(fx, t, u);
393 // &mut T -> &T is allowed
394 // &'a T -> &'b T is allowed
396 (ty::Ref(_, _, Mutability::Not), ty::Ref(_, _, Mutability::Mut)) => panic!(
397 "Cant assign value of type {} to place of type {}",
400 (ty::FnPtr(_), ty::FnPtr(_)) => {
401 let from_sig = fx.tcx.normalize_erasing_late_bound_regions(
402 ParamEnv::reveal_all(),
403 &from_ty.fn_sig(fx.tcx),
405 let to_sig = fx.tcx.normalize_erasing_late_bound_regions(
406 ParamEnv::reveal_all(),
407 &to_ty.fn_sig(fx.tcx),
411 "Can't write fn ptr with incompatible sig {:?} to place with sig {:?}\n\n{:#?}",
412 from_sig, to_sig, fx,
414 // fn(&T) -> for<'l> fn(&'l T) is allowed
416 (ty::Dynamic(from_traits, _), ty::Dynamic(to_traits, _)) => {
419 .normalize_erasing_late_bound_regions(ParamEnv::reveal_all(), from_traits);
422 .normalize_erasing_late_bound_regions(ParamEnv::reveal_all(), to_traits);
424 from_traits, to_traits,
425 "Can't write trait object of incompatible traits {:?} to place with traits {:?}\n\n{:#?}",
426 from_traits, to_traits, fx,
428 // dyn for<'r> Trait<'r> -> dyn Trait<'_> is allowed
434 "Can't write value with incompatible type {:?} to place with type {:?}\n\n{:#?}",
443 assert_assignable(fx, from_ty, to_ty);
445 let dst_layout = self.layout();
446 let to_ptr = match self.inner {
447 CPlaceInner::Var(var) => {
448 let data = from.load_scalar(fx);
449 fx.bcx.set_val_label(data, cranelift_codegen::ir::ValueLabel::from_u32(var.as_u32()));
450 fx.bcx.def_var(mir_var(var), data);
453 CPlaceInner::Addr(ptr, None) => ptr,
454 CPlaceInner::NoPlace => {
455 if dst_layout.abi != Abi::Uninhabited {
456 assert_eq!(dst_layout.size.bytes(), 0, "{:?}", dst_layout);
460 CPlaceInner::Addr(_, Some(_)) => bug!("Can't write value to unsized place {:?}", self),
464 CValueInner::ByVal(val) => {
465 to_ptr.store(fx, val, MemFlags::new());
467 CValueInner::ByValPair(value, extra) => match dst_layout.abi {
468 Abi::ScalarPair(ref a_scalar, ref b_scalar) => {
469 let b_offset = scalar_pair_calculate_b_offset(fx.tcx, a_scalar, b_scalar);
470 to_ptr.store(fx, value, MemFlags::new());
471 to_ptr.offset(fx, b_offset).store(fx, extra, MemFlags::new());
474 "Non ScalarPair abi {:?} for ByValPair CValue",
478 CValueInner::ByRef(from_ptr) => {
479 let from_addr = from_ptr.get_addr(fx);
480 let to_addr = to_ptr.get_addr(fx);
481 let src_layout = from.1;
482 let size = dst_layout.size.bytes();
483 let src_align = src_layout.align.abi.bytes() as u8;
484 let dst_align = dst_layout.align.abi.bytes() as u8;
485 fx.bcx.emit_small_memcpy(
486 fx.module.target_config(),
499 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
502 let layout = self.layout();
503 let (base, extra) = self.to_ptr_maybe_unsized(fx);
505 let (field_ptr, field_layout) = codegen_field(fx, base, extra, layout, field);
506 if field_layout.is_unsized() {
507 CPlace::for_ptr_with_extra(field_ptr, extra.unwrap(), field_layout)
509 CPlace::for_ptr(field_ptr, field_layout)
515 fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
518 let (elem_layout, ptr) = match self.layout().ty.kind {
519 ty::Array(elem_ty, _) => (fx.layout_of(elem_ty), self.to_ptr(fx)),
520 ty::Slice(elem_ty) => (fx.layout_of(elem_ty), self.to_ptr_maybe_unsized(fx).0),
521 _ => bug!("place_index({:?})", self.layout().ty),
527 .imul_imm(index, elem_layout.size.bytes() as i64);
529 CPlace::for_ptr(ptr.offset_value(fx, offset), elem_layout)
532 pub fn place_deref(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> CPlace<'tcx> {
533 let inner_layout = fx.layout_of(self.layout().ty.builtin_deref(true).unwrap().ty);
534 if has_ptr_meta(fx.tcx, inner_layout.ty) {
535 let (addr, extra) = self.to_cvalue(fx).load_scalar_pair(fx);
536 CPlace::for_ptr_with_extra(Pointer::new(addr), extra, inner_layout)
538 CPlace::for_ptr(Pointer::new(self.to_cvalue(fx).load_scalar(fx)), inner_layout)
542 pub fn write_place_ref(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>, dest: CPlace<'tcx>) {
543 if has_ptr_meta(fx.tcx, self.layout().ty) {
544 let (ptr, extra) = self.to_ptr_maybe_unsized(fx);
545 let ptr = CValue::by_val_pair(
547 extra.expect("unsized type without metadata"),
550 dest.write_cvalue(fx, ptr);
552 let ptr = CValue::by_val(self.to_ptr(fx).get_addr(fx), dest.layout());
553 dest.write_cvalue(fx, ptr);
557 pub fn unchecked_cast_to(self, layout: TyLayout<'tcx>) -> Self {
558 assert!(!self.layout().is_unsized());
560 CPlaceInner::NoPlace => {
561 assert!(layout.size.bytes() == 0);
571 pub fn downcast_variant(
573 fx: &FunctionCx<'_, 'tcx, impl Backend>,
576 let layout = self.layout().for_variant(fx, variant);
577 self.unchecked_cast_to(layout)