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