src/value_and_place.rs

   1 use crate::prelude::*;
   2
   3 use cranelift::codegen::ir::immediates::Offset32;
   4
   5 fn codegen_field<'tcx>(
   6     fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
   7     base: Pointer,
   8     extra: Option<Value>,
   9     layout: TyLayout<'tcx>,
  10     field: mir::Field,
  11 ) -> (Pointer, TyLayout<'tcx>) {
  12     let field_offset = layout.fields.offset(field.index());
  13     let field_layout = layout.field(&*fx, field.index());
  14
  15     let simple = |fx: &mut FunctionCx<_>| {
  16         (
  17             base.offset_i64(fx, i64::try_from(field_offset.bytes()).unwrap()),
  18             field_layout,
  19         )
  20     };
  21
  22     if let Some(extra) = extra {
  23         if !field_layout.is_unsized() {
  24             return simple(fx);
  25         }
  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);
  30                 return simple(fx);
  31             }
  32             _ => {
  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);
  36
  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);
  43
  44                 (
  45                     base.offset_value(fx, offset),
  46                     field_layout,
  47                 )
  48             }
  49         }
  50     } else {
  51         simple(fx)
  52     }
  53 }
  54
  55 fn scalar_pair_calculate_b_offset(tcx: TyCtxt<'_>, a_scalar: &Scalar, b_scalar: &Scalar) -> Offset32 {
  56     let b_offset = a_scalar
  57         .value
  58         .size(&tcx)
  59         .align_to(b_scalar.value.align(&tcx).abi);
  60     Offset32::new(b_offset.bytes().try_into().unwrap())
  61 }
  62
  63 /// A read-only value
  64 #[derive(Debug, Copy, Clone)]
  65 pub struct CValue<'tcx>(CValueInner, TyLayout<'tcx>);
  66
  67 #[derive(Debug, Copy, Clone)]
  68 enum CValueInner {
  69     ByRef(Pointer),
  70     ByVal(Value),
  71     ByValPair(Value, Value),
  72 }
  73
  74 impl<'tcx> CValue<'tcx> {
  75     pub fn by_ref(ptr: Pointer, layout: TyLayout<'tcx>) -> CValue<'tcx> {
  76         CValue(CValueInner::ByRef(ptr), layout)
  77     }
  78
  79     pub fn by_val(value: Value, layout: TyLayout<'tcx>) -> CValue<'tcx> {
  80         CValue(CValueInner::ByVal(value), layout)
  81     }
  82
  83     pub fn by_val_pair(value: Value, extra: Value, layout: TyLayout<'tcx>) -> CValue<'tcx> {
  84         CValue(CValueInner::ByValPair(value, extra), layout)
  85     }
  86
  87     pub fn layout(&self) -> TyLayout<'tcx> {
  88         self.1
  89     }
  90
  91     pub fn force_stack<'a>(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> Value {
  92         let layout = self.1;
  93         match self.0 {
  94             CValueInner::ByRef(ptr) => ptr.get_addr(fx),
  95             CValueInner::ByVal(_) | CValueInner::ByValPair(_, _) => {
  96                 let cplace = CPlace::new_stack_slot(fx, layout.ty);
  97                 cplace.write_cvalue(fx, self);
  98                 cplace.to_addr(fx)
  99             }
 100         }
 101     }
 102
 103     pub fn try_to_addr(self) -> Option<Value> {
 104         match self.0 {
 105             CValueInner::ByRef(ptr) => {
 106                 let (base_addr, offset) = ptr.get_addr_and_offset();
 107                 if offset == Offset32::new(0) {
 108                     Some(base_addr)
 109                 } else {
 110                     None
 111                 }
 112             }
 113             CValueInner::ByVal(_) | CValueInner::ByValPair(_, _) => None,
 114         }
 115     }
 116
 117     /// Load a value with layout.abi of scalar
 118     pub fn load_scalar<'a>(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> Value {
 119         let layout = self.1;
 120         match self.0 {
 121             CValueInner::ByRef(ptr) => {
 122                 let scalar = match layout.abi {
 123                     layout::Abi::Scalar(ref scalar) => scalar.clone(),
 124                     _ => unreachable!(),
 125                 };
 126                 let clif_ty = scalar_to_clif_type(fx.tcx, scalar);
 127                 ptr.load(fx, clif_ty, MemFlags::new())
 128             }
 129             CValueInner::ByVal(value) => value,
 130             CValueInner::ByValPair(_, _) => bug!("Please use load_scalar_pair for ByValPair"),
 131         }
 132     }
 133
 134     /// Load a value pair with layout.abi of scalar pair
 135     pub fn load_scalar_pair<'a>(
 136         self,
 137         fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
 138     ) -> (Value, Value) {
 139         let layout = self.1;
 140         match self.0 {
 141             CValueInner::ByRef(ptr) => {
 142                 let (a_scalar, b_scalar) = match &layout.abi {
 143                     layout::Abi::ScalarPair(a, b) => (a, b),
 144                     _ => unreachable!("load_scalar_pair({:?})", self),
 145                 };
 146                 let b_offset = scalar_pair_calculate_b_offset(fx.tcx, a_scalar, b_scalar);
 147                 let clif_ty1 = scalar_to_clif_type(fx.tcx, a_scalar.clone());
 148                 let clif_ty2 = scalar_to_clif_type(fx.tcx, b_scalar.clone());
 149                 let val1 = ptr.load(fx, clif_ty1, MemFlags::new());
 150                 let val2 = ptr.offset(fx, b_offset).load(fx, clif_ty2, MemFlags::new());
 151                 (val1, val2)
 152             }
 153             CValueInner::ByVal(_) => bug!("Please use load_scalar for ByVal"),
 154             CValueInner::ByValPair(val1, val2) => (val1, val2),
 155         }
 156     }
 157
 158     pub fn value_field<'a>(
 159         self,
 160         fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
 161         field: mir::Field,
 162     ) -> CValue<'tcx> {
 163         let layout = self.1;
 164         let ptr = match self.0 {
 165             CValueInner::ByRef(ptr) => ptr,
 166             _ => bug!("place_field for {:?}", self),
 167         };
 168
 169         let (field_ptr, field_layout) = codegen_field(fx, ptr, None, layout, field);
 170         CValue::by_ref(field_ptr, field_layout)
 171     }
 172
 173     pub fn unsize_value<'a>(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>, dest: CPlace<'tcx>) {
 174         crate::unsize::coerce_unsized_into(fx, self, dest);
 175     }
 176
 177     /// If `ty` is signed, `const_val` must already be sign extended.
 178     pub fn const_val<'a>(
 179         fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
 180         ty: Ty<'tcx>,
 181         const_val: u128,
 182     ) -> CValue<'tcx> {
 183         let clif_ty = fx.clif_type(ty).unwrap();
 184         let layout = fx.layout_of(ty);
 185
 186         let val = match ty.kind {
 187             ty::TyKind::Uint(UintTy::U128) | ty::TyKind::Int(IntTy::I128) => {
 188                 let lsb = fx.bcx.ins().iconst(types::I64, const_val as u64 as i64);
 189                 let msb = fx
 190                     .bcx
 191                     .ins()
 192                     .iconst(types::I64, (const_val >> 64) as u64 as i64);
 193                 fx.bcx.ins().iconcat(lsb, msb)
 194             }
 195             ty::TyKind::Bool => {
 196                 assert!(
 197                     const_val == 0 || const_val == 1,
 198                     "Invalid bool 0x{:032X}",
 199                     const_val
 200                 );
 201                 fx.bcx.ins().iconst(types::I8, const_val as i64)
 202             }
 203             ty::TyKind::Uint(_) | ty::TyKind::Ref(..) | ty::TyKind::RawPtr(..) => fx
 204                 .bcx
 205                 .ins()
 206                 .iconst(clif_ty, u64::try_from(const_val).expect("uint") as i64),
 207             ty::TyKind::Int(_) => fx.bcx.ins().iconst(clif_ty, const_val as i128 as i64),
 208             _ => panic!(
 209                 "CValue::const_val for non bool/integer/pointer type {:?} is not allowed",
 210                 ty
 211             ),
 212         };
 213
 214         CValue::by_val(val, layout)
 215     }
 216
 217     pub fn unchecked_cast_to(self, layout: TyLayout<'tcx>) -> Self {
 218         CValue(self.0, layout)
 219     }
 220 }
 221
 222 /// A place where you can write a value to or read a value from
 223 #[derive(Debug, Copy, Clone)]
 224 pub struct CPlace<'tcx> {
 225     inner: CPlaceInner,
 226     layout: TyLayout<'tcx>,
 227 }
 228
 229 #[derive(Debug, Copy, Clone)]
 230 pub enum CPlaceInner {
 231     Var(Local),
 232     Addr(Pointer, Option<Value>),
 233     Stack(StackSlot),
 234     NoPlace,
 235 }
 236
 237 impl<'tcx> CPlace<'tcx> {
 238     pub fn layout(&self) -> TyLayout<'tcx> {
 239         self.layout
 240     }
 241
 242     pub fn inner(&self) -> &CPlaceInner {
 243         &self.inner
 244     }
 245
 246     pub fn no_place(layout: TyLayout<'tcx>) -> CPlace<'tcx> {
 247         CPlace {
 248             inner: CPlaceInner::NoPlace,
 249             layout,
 250         }
 251     }
 252
 253     pub fn new_stack_slot(
 254         fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
 255         ty: Ty<'tcx>,
 256     ) -> CPlace<'tcx> {
 257         let layout = fx.layout_of(ty);
 258         assert!(!layout.is_unsized());
 259         if layout.size.bytes() == 0 {
 260             return CPlace {
 261                 inner: CPlaceInner::NoPlace,
 262                 layout,
 263             };
 264         }
 265
 266         let stack_slot = fx.bcx.create_stack_slot(StackSlotData {
 267             kind: StackSlotKind::ExplicitSlot,
 268             size: layout.size.bytes() as u32,
 269             offset: None,
 270         });
 271         CPlace {
 272             inner: CPlaceInner::Stack(stack_slot),
 273             layout,
 274         }
 275     }
 276
 277     pub fn new_var(
 278         fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
 279         local: Local,
 280         layout: TyLayout<'tcx>,
 281     ) -> CPlace<'tcx> {
 282         fx.bcx
 283             .declare_var(mir_var(local), fx.clif_type(layout.ty).unwrap());
 284         CPlace {
 285             inner: CPlaceInner::Var(local),
 286             layout,
 287         }
 288     }
 289
 290     pub fn for_ptr(ptr: Pointer, layout: TyLayout<'tcx>) -> CPlace<'tcx> {
 291         CPlace {
 292             inner: CPlaceInner::Addr(ptr, None),
 293             layout,
 294         }
 295     }
 296
 297     pub fn for_ptr_with_extra(ptr: Pointer, extra: Value, layout: TyLayout<'tcx>) -> CPlace<'tcx> {
 298         CPlace {
 299             inner: CPlaceInner::Addr(ptr, Some(extra)),
 300             layout,
 301         }
 302     }
 303
 304     pub fn to_cvalue(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> CValue<'tcx> {
 305         let layout = self.layout();
 306         match self.inner {
 307             CPlaceInner::Var(var) => {
 308                 let val = fx.bcx.use_var(mir_var(var));
 309                 fx.bcx.set_val_label(val, cranelift::codegen::ir::ValueLabel::from_u32(var.as_u32()));
 310                 CValue::by_val(val, layout)
 311             }
 312             CPlaceInner::Addr(ptr, extra) => {
 313                 assert!(extra.is_none(), "unsized values are not yet supported");
 314                 CValue::by_ref(ptr, layout)
 315             }
 316             CPlaceInner::Stack(stack_slot) => CValue::by_ref(
 317                 Pointer::new(fx.bcx.ins().stack_addr(fx.pointer_type, stack_slot, 0)),
 318                 layout,
 319             ),
 320             CPlaceInner::NoPlace => CValue::by_ref(
 321                 Pointer::const_addr(fx, i64::try_from(self.layout.align.pref.bytes()).unwrap()),
 322                 layout,
 323             ),
 324         }
 325     }
 326
 327     pub fn to_ptr(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> Pointer {
 328         match self.to_ptr_maybe_unsized(fx) {
 329             (ptr, None) => ptr,
 330             (_, Some(_)) => bug!("Expected sized cplace, found {:?}", self),
 331         }
 332     }
 333
 334     pub fn to_addr(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> Value {
 335         self.to_ptr(fx).get_addr(fx)
 336     }
 337
 338     pub fn to_ptr_maybe_unsized(
 339         self,
 340         fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
 341     ) -> (Pointer, Option<Value>) {
 342         match self.inner {
 343             CPlaceInner::Addr(ptr, extra) => (ptr, extra),
 344             CPlaceInner::Stack(stack_slot) => (
 345                 Pointer::new(fx.bcx.ins().stack_addr(fx.pointer_type, stack_slot, 0)),
 346                 None,
 347             ),
 348             CPlaceInner::NoPlace => {
 349                 (
 350                     Pointer::const_addr(fx, i64::try_from(self.layout.align.pref.bytes()).unwrap()),
 351                     None,
 352                 )
 353             }
 354             CPlaceInner::Var(_) => bug!("Expected CPlace::Addr, found CPlace::Var"),
 355         }
 356     }
 357
 358     pub fn to_addr_maybe_unsized(
 359         self,
 360         fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
 361     ) -> (Value, Option<Value>) {
 362         let (ptr, extra) = self.to_ptr_maybe_unsized(fx);
 363         (ptr.get_addr(fx), extra)
 364     }
 365
 366     pub fn write_cvalue(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>, from: CValue<'tcx>) {
 367         use rustc::hir::Mutability::*;
 368
 369         let from_ty = from.layout().ty;
 370         let to_ty = self.layout().ty;
 371
 372         fn assert_assignable<'tcx>(
 373             fx: &FunctionCx<'_, 'tcx, impl Backend>,
 374             from_ty: Ty<'tcx>,
 375             to_ty: Ty<'tcx>,
 376         ) {
 377             match (&from_ty.kind, &to_ty.kind) {
 378                 (ty::Ref(_, t, Immutable), ty::Ref(_, u, Immutable))
 379                 | (ty::Ref(_, t, Mutable), ty::Ref(_, u, Immutable))
 380                 | (ty::Ref(_, t, Mutable), ty::Ref(_, u, Mutable)) => {
 381                     assert_assignable(fx, t, u);
 382                     // &mut T -> &T is allowed
 383                     // &'a T -> &'b T is allowed
 384                 }
 385                 (ty::Ref(_, _, Immutable), ty::Ref(_, _, Mutable)) => panic!(
 386                     "Cant assign value of type {} to place of type {}",
 387                     from_ty, to_ty
 388                 ),
 389                 (ty::FnPtr(_), ty::FnPtr(_)) => {
 390                     let from_sig = fx.tcx.normalize_erasing_late_bound_regions(
 391                         ParamEnv::reveal_all(),
 392                         &from_ty.fn_sig(fx.tcx),
 393                     );
 394                     let to_sig = fx.tcx.normalize_erasing_late_bound_regions(
 395                         ParamEnv::reveal_all(),
 396                         &to_ty.fn_sig(fx.tcx),
 397                     );
 398                     assert_eq!(
 399                         from_sig, to_sig,
 400                         "Can't write fn ptr with incompatible sig {:?} to place with sig {:?}\n\n{:#?}",
 401                         from_sig, to_sig, fx,
 402                     );
 403                     // fn(&T) -> for<'l> fn(&'l T) is allowed
 404                 }
 405                 (ty::Dynamic(from_traits, _), ty::Dynamic(to_traits, _)) => {
 406                     let from_traits = fx
 407                         .tcx
 408                         .normalize_erasing_late_bound_regions(ParamEnv::reveal_all(), from_traits);
 409                     let to_traits = fx
 410                         .tcx
 411                         .normalize_erasing_late_bound_regions(ParamEnv::reveal_all(), to_traits);
 412                     assert_eq!(
 413                         from_traits, to_traits,
 414                         "Can't write trait object of incompatible traits {:?} to place with traits {:?}\n\n{:#?}",
 415                         from_traits, to_traits, fx,
 416                     );
 417                     // dyn for<'r> Trait<'r> -> dyn Trait<'_> is allowed
 418                 }
 419                 _ => {
 420                     assert_eq!(
 421                         from_ty,
 422                         to_ty,
 423                         "Can't write value with incompatible type {:?} to place with type {:?}\n\n{:#?}",
 424                         from_ty,
 425                         to_ty,
 426                         fx,
 427                     );
 428                 }
 429             }
 430         }
 431
 432         assert_assignable(fx, from_ty, to_ty);
 433
 434         let dst_layout = self.layout();
 435         let to_ptr = match self.inner {
 436             CPlaceInner::Var(var) => {
 437                 let data = from.load_scalar(fx);
 438                 fx.bcx.set_val_label(data, cranelift::codegen::ir::ValueLabel::from_u32(var.as_u32()));
 439                 fx.bcx.def_var(mir_var(var), data);
 440                 return;
 441             }
 442             CPlaceInner::Addr(ptr, None) => ptr,
 443             CPlaceInner::Stack(stack_slot) => {
 444                 Pointer::new(fx.bcx.ins().stack_addr(fx.pointer_type, stack_slot, 0))
 445             }
 446             CPlaceInner::NoPlace => {
 447                 if dst_layout.abi != Abi::Uninhabited {
 448                     assert_eq!(dst_layout.size.bytes(), 0, "{:?}", dst_layout);
 449                 }
 450                 return;
 451             }
 452             CPlaceInner::Addr(_, Some(_)) => bug!("Can't write value to unsized place {:?}", self),
 453         };
 454
 455         match from.0 {
 456             CValueInner::ByVal(val) => {
 457                 to_ptr.store(fx, val, MemFlags::new());
 458             }
 459             CValueInner::ByValPair(value, extra) => match dst_layout.abi {
 460                 Abi::ScalarPair(ref a_scalar, ref b_scalar) => {
 461                     let b_offset = scalar_pair_calculate_b_offset(fx.tcx, a_scalar, b_scalar);
 462                     to_ptr.store(fx, value, MemFlags::new());
 463                     to_ptr.offset(fx, b_offset).store(fx, extra, MemFlags::new());
 464                 }
 465                 _ => bug!(
 466                     "Non ScalarPair abi {:?} for ByValPair CValue",
 467                     dst_layout.abi
 468                 ),
 469             },
 470             CValueInner::ByRef(from_ptr) => {
 471                 let from_addr = from_ptr.get_addr(fx);
 472                 let to_addr = to_ptr.get_addr(fx);
 473                 let src_layout = from.1;
 474                 let size = dst_layout.size.bytes();
 475                 let src_align = src_layout.align.abi.bytes() as u8;
 476                 let dst_align = dst_layout.align.abi.bytes() as u8;
 477                 fx.bcx.emit_small_memcpy(
 478                     fx.module.target_config(),
 479                     to_addr,
 480                     from_addr,
 481                     size,
 482                     dst_align,
 483                     src_align,
 484                 );
 485             }
 486         }
 487     }
 488
 489     pub fn place_field(
 490         self,
 491         fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
 492         field: mir::Field,
 493     ) -> CPlace<'tcx> {
 494         let layout = self.layout();
 495         let (base, extra) = self.to_ptr_maybe_unsized(fx);
 496
 497         let (field_ptr, field_layout) = codegen_field(fx, base, extra, layout, field);
 498         if field_layout.is_unsized() {
 499             CPlace::for_ptr_with_extra(field_ptr, extra.unwrap(), field_layout)
 500         } else {
 501             CPlace::for_ptr(field_ptr, field_layout)
 502         }
 503     }
 504
 505     pub fn place_index(
 506         self,
 507         fx: &mut FunctionCx<'_, 'tcx, impl Backend>,
 508         index: Value,
 509     ) -> CPlace<'tcx> {
 510         let (elem_layout, ptr) = match self.layout().ty.kind {
 511             ty::Array(elem_ty, _) => (fx.layout_of(elem_ty), self.to_ptr(fx)),
 512             ty::Slice(elem_ty) => (fx.layout_of(elem_ty), self.to_ptr_maybe_unsized(fx).0),
 513             _ => bug!("place_index({:?})", self.layout().ty),
 514         };
 515
 516         let offset = fx
 517             .bcx
 518             .ins()
 519             .imul_imm(index, elem_layout.size.bytes() as i64);
 520
 521         CPlace::for_ptr(ptr.offset_value(fx, offset), elem_layout)
 522     }
 523
 524     pub fn place_deref(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>) -> CPlace<'tcx> {
 525         let inner_layout = fx.layout_of(self.layout().ty.builtin_deref(true).unwrap().ty);
 526         if has_ptr_meta(fx.tcx, inner_layout.ty) {
 527             let (addr, extra) = self.to_cvalue(fx).load_scalar_pair(fx);
 528             CPlace::for_ptr_with_extra(Pointer::new(addr), extra, inner_layout)
 529         } else {
 530             CPlace::for_ptr(Pointer::new(self.to_cvalue(fx).load_scalar(fx)), inner_layout)
 531         }
 532     }
 533
 534     pub fn write_place_ref(self, fx: &mut FunctionCx<'_, 'tcx, impl Backend>, dest: CPlace<'tcx>) {
 535         if has_ptr_meta(fx.tcx, self.layout().ty) {
 536             let (value, extra) = self.to_addr_maybe_unsized(fx);
 537             let ptr = CValue::by_val_pair(
 538                 value,
 539                 extra.expect("unsized type without metadata"),
 540                 dest.layout(),
 541             );
 542             dest.write_cvalue(fx, ptr);
 543         } else {
 544             let ptr = CValue::by_val(self.to_addr(fx), dest.layout());
 545             dest.write_cvalue(fx, ptr);
 546         }
 547     }
 548
 549     pub fn unchecked_cast_to(self, layout: TyLayout<'tcx>) -> Self {
 550         assert!(!self.layout().is_unsized());
 551         match self.inner {
 552             CPlaceInner::NoPlace => {
 553                 assert!(layout.size.bytes() == 0);
 554             }
 555             _ => {}
 556         }
 557         CPlace {
 558             inner: self.inner,
 559             layout,
 560         }
 561     }
 562
 563     pub fn downcast_variant(
 564         self,
 565         fx: &FunctionCx<'_, 'tcx, impl Backend>,
 566         variant: VariantIdx,
 567     ) -> Self {
 568         let layout = self.layout().for_variant(fx, variant);
 569         self.unchecked_cast_to(layout)
 570     }
 571 }