]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_codegen_cranelift/src/constant.rs
Rollup merge of #98174 - Kixunil:rename_ptr_as_mut_const_to_cast, r=scottmcm
[rust.git] / compiler / rustc_codegen_cranelift / src / constant.rs
1 //! Handling of `static`s, `const`s and promoted allocations
2
3 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
4 use rustc_middle::middle::codegen_fn_attrs::CodegenFnAttrFlags;
5 use rustc_middle::mir::interpret::{
6     read_target_uint, AllocId, ConstAllocation, ConstValue, ErrorHandled, GlobalAlloc, Scalar,
7 };
8 use rustc_middle::ty::ConstKind;
9 use rustc_span::DUMMY_SP;
10
11 use cranelift_codegen::ir::GlobalValueData;
12 use cranelift_module::*;
13
14 use crate::prelude::*;
15
16 pub(crate) struct ConstantCx {
17     todo: Vec<TodoItem>,
18     done: FxHashSet<DataId>,
19     anon_allocs: FxHashMap<AllocId, DataId>,
20 }
21
22 #[derive(Copy, Clone, Debug)]
23 enum TodoItem {
24     Alloc(AllocId),
25     Static(DefId),
26 }
27
28 impl ConstantCx {
29     pub(crate) fn new() -> Self {
30         ConstantCx { todo: vec![], done: FxHashSet::default(), anon_allocs: FxHashMap::default() }
31     }
32
33     pub(crate) fn finalize(mut self, tcx: TyCtxt<'_>, module: &mut dyn Module) {
34         //println!("todo {:?}", self.todo);
35         define_all_allocs(tcx, module, &mut self);
36         //println!("done {:?}", self.done);
37         self.done.clear();
38     }
39 }
40
41 pub(crate) fn check_constants(fx: &mut FunctionCx<'_, '_, '_>) -> bool {
42     let mut all_constants_ok = true;
43     for constant in &fx.mir.required_consts {
44         let const_ = match fx.monomorphize(constant.literal) {
45             ConstantKind::Ty(ct) => ct,
46             ConstantKind::Val(..) => continue,
47         };
48         match const_.kind() {
49             ConstKind::Value(_) => {}
50             ConstKind::Unevaluated(unevaluated) => {
51                 if let Err(err) =
52                     fx.tcx.const_eval_resolve(ParamEnv::reveal_all(), unevaluated, None)
53                 {
54                     all_constants_ok = false;
55                     match err {
56                         ErrorHandled::Reported(_) | ErrorHandled::Linted => {
57                             fx.tcx.sess.span_err(constant.span, "erroneous constant encountered");
58                         }
59                         ErrorHandled::TooGeneric => {
60                             span_bug!(
61                                 constant.span,
62                                 "codgen encountered polymorphic constant: {:?}",
63                                 err
64                             );
65                         }
66                     }
67                 }
68             }
69             ConstKind::Param(_)
70             | ConstKind::Infer(_)
71             | ConstKind::Bound(_, _)
72             | ConstKind::Placeholder(_)
73             | ConstKind::Error(_) => unreachable!("{:?}", const_),
74         }
75     }
76     all_constants_ok
77 }
78
79 pub(crate) fn codegen_static(tcx: TyCtxt<'_>, module: &mut dyn Module, def_id: DefId) {
80     let mut constants_cx = ConstantCx::new();
81     constants_cx.todo.push(TodoItem::Static(def_id));
82     constants_cx.finalize(tcx, module);
83 }
84
85 pub(crate) fn codegen_tls_ref<'tcx>(
86     fx: &mut FunctionCx<'_, '_, 'tcx>,
87     def_id: DefId,
88     layout: TyAndLayout<'tcx>,
89 ) -> CValue<'tcx> {
90     let data_id = data_id_for_static(fx.tcx, fx.module, def_id, false);
91     let local_data_id = fx.module.declare_data_in_func(data_id, &mut fx.bcx.func);
92     if fx.clif_comments.enabled() {
93         fx.add_comment(local_data_id, format!("tls {:?}", def_id));
94     }
95     let tls_ptr = fx.bcx.ins().tls_value(fx.pointer_type, local_data_id);
96     CValue::by_val(tls_ptr, layout)
97 }
98
99 fn codegen_static_ref<'tcx>(
100     fx: &mut FunctionCx<'_, '_, 'tcx>,
101     def_id: DefId,
102     layout: TyAndLayout<'tcx>,
103 ) -> CPlace<'tcx> {
104     let data_id = data_id_for_static(fx.tcx, fx.module, def_id, false);
105     let local_data_id = fx.module.declare_data_in_func(data_id, &mut fx.bcx.func);
106     if fx.clif_comments.enabled() {
107         fx.add_comment(local_data_id, format!("{:?}", def_id));
108     }
109     let global_ptr = fx.bcx.ins().global_value(fx.pointer_type, local_data_id);
110     assert!(!layout.is_unsized(), "unsized statics aren't supported");
111     assert!(
112         matches!(
113             fx.bcx.func.global_values[local_data_id],
114             GlobalValueData::Symbol { tls: false, .. }
115         ),
116         "tls static referenced without Rvalue::ThreadLocalRef"
117     );
118     CPlace::for_ptr(crate::pointer::Pointer::new(global_ptr), layout)
119 }
120
121 pub(crate) fn codegen_constant<'tcx>(
122     fx: &mut FunctionCx<'_, '_, 'tcx>,
123     constant: &Constant<'tcx>,
124 ) -> CValue<'tcx> {
125     let const_ = match fx.monomorphize(constant.literal) {
126         ConstantKind::Ty(ct) => ct,
127         ConstantKind::Val(val, ty) => return codegen_const_value(fx, val, ty),
128     };
129     let const_val = match const_.kind() {
130         ConstKind::Value(valtree) => fx.tcx.valtree_to_const_val((const_.ty(), valtree)),
131         ConstKind::Unevaluated(ty::Unevaluated { def, substs, promoted })
132             if fx.tcx.is_static(def.did) =>
133         {
134             assert!(substs.is_empty());
135             assert!(promoted.is_none());
136
137             return codegen_static_ref(fx, def.did, fx.layout_of(const_.ty())).to_cvalue(fx);
138         }
139         ConstKind::Unevaluated(unevaluated) => {
140             match fx.tcx.const_eval_resolve(ParamEnv::reveal_all(), unevaluated, None) {
141                 Ok(const_val) => const_val,
142                 Err(_) => {
143                     span_bug!(constant.span, "erroneous constant not captured by required_consts");
144                 }
145             }
146         }
147         ConstKind::Param(_)
148         | ConstKind::Infer(_)
149         | ConstKind::Bound(_, _)
150         | ConstKind::Placeholder(_)
151         | ConstKind::Error(_) => unreachable!("{:?}", const_),
152     };
153
154     codegen_const_value(fx, const_val, const_.ty())
155 }
156
157 pub(crate) fn codegen_const_value<'tcx>(
158     fx: &mut FunctionCx<'_, '_, 'tcx>,
159     const_val: ConstValue<'tcx>,
160     ty: Ty<'tcx>,
161 ) -> CValue<'tcx> {
162     let layout = fx.layout_of(ty);
163     assert!(!layout.is_unsized(), "sized const value");
164
165     if layout.is_zst() {
166         return CValue::by_ref(crate::Pointer::dangling(layout.align.pref), layout);
167     }
168
169     match const_val {
170         ConstValue::ZeroSized => unreachable!(), // we already handles ZST above
171         ConstValue::Scalar(x) => match x {
172             Scalar::Int(int) => {
173                 if fx.clif_type(layout.ty).is_some() {
174                     return CValue::const_val(fx, layout, int);
175                 } else {
176                     let raw_val = int.to_bits(int.size()).unwrap();
177                     let val = match int.size().bytes() {
178                         1 => fx.bcx.ins().iconst(types::I8, raw_val as i64),
179                         2 => fx.bcx.ins().iconst(types::I16, raw_val as i64),
180                         4 => fx.bcx.ins().iconst(types::I32, raw_val as i64),
181                         8 => fx.bcx.ins().iconst(types::I64, raw_val as i64),
182                         16 => {
183                             let lsb = fx.bcx.ins().iconst(types::I64, raw_val as u64 as i64);
184                             let msb =
185                                 fx.bcx.ins().iconst(types::I64, (raw_val >> 64) as u64 as i64);
186                             fx.bcx.ins().iconcat(lsb, msb)
187                         }
188                         _ => unreachable!(),
189                     };
190
191                     let place = CPlace::new_stack_slot(fx, layout);
192                     place.to_ptr().store(fx, val, MemFlags::trusted());
193                     place.to_cvalue(fx)
194                 }
195             }
196             Scalar::Ptr(ptr, _size) => {
197                 let (alloc_id, offset) = ptr.into_parts(); // we know the `offset` is relative
198                 let base_addr = match fx.tcx.global_alloc(alloc_id) {
199                     GlobalAlloc::Memory(alloc) => {
200                         let data_id = data_id_for_alloc_id(
201                             &mut fx.constants_cx,
202                             fx.module,
203                             alloc_id,
204                             alloc.inner().mutability,
205                         );
206                         let local_data_id =
207                             fx.module.declare_data_in_func(data_id, &mut fx.bcx.func);
208                         if fx.clif_comments.enabled() {
209                             fx.add_comment(local_data_id, format!("{:?}", alloc_id));
210                         }
211                         fx.bcx.ins().global_value(fx.pointer_type, local_data_id)
212                     }
213                     GlobalAlloc::Function(instance) => {
214                         let func_id = crate::abi::import_function(fx.tcx, fx.module, instance);
215                         let local_func_id =
216                             fx.module.declare_func_in_func(func_id, &mut fx.bcx.func);
217                         fx.bcx.ins().func_addr(fx.pointer_type, local_func_id)
218                     }
219                     GlobalAlloc::VTable(ty, trait_ref) => {
220                         let alloc_id = fx.tcx.vtable_allocation((ty, trait_ref));
221                         let alloc = fx.tcx.global_alloc(alloc_id).unwrap_memory();
222                         // FIXME: factor this common code with the `Memory` arm into a function?
223                         let data_id = data_id_for_alloc_id(
224                             &mut fx.constants_cx,
225                             fx.module,
226                             alloc_id,
227                             alloc.inner().mutability,
228                         );
229                         let local_data_id =
230                             fx.module.declare_data_in_func(data_id, &mut fx.bcx.func);
231                         fx.bcx.ins().global_value(fx.pointer_type, local_data_id)
232                     }
233                     GlobalAlloc::Static(def_id) => {
234                         assert!(fx.tcx.is_static(def_id));
235                         let data_id = data_id_for_static(fx.tcx, fx.module, def_id, false);
236                         let local_data_id =
237                             fx.module.declare_data_in_func(data_id, &mut fx.bcx.func);
238                         if fx.clif_comments.enabled() {
239                             fx.add_comment(local_data_id, format!("{:?}", def_id));
240                         }
241                         fx.bcx.ins().global_value(fx.pointer_type, local_data_id)
242                     }
243                 };
244                 let val = if offset.bytes() != 0 {
245                     fx.bcx.ins().iadd_imm(base_addr, i64::try_from(offset.bytes()).unwrap())
246                 } else {
247                     base_addr
248                 };
249                 CValue::by_val(val, layout)
250             }
251         },
252         ConstValue::ByRef { alloc, offset } => CValue::by_ref(
253             pointer_for_allocation(fx, alloc)
254                 .offset_i64(fx, i64::try_from(offset.bytes()).unwrap()),
255             layout,
256         ),
257         ConstValue::Slice { data, start, end } => {
258             let ptr = pointer_for_allocation(fx, data)
259                 .offset_i64(fx, i64::try_from(start).unwrap())
260                 .get_addr(fx);
261             let len = fx
262                 .bcx
263                 .ins()
264                 .iconst(fx.pointer_type, i64::try_from(end.checked_sub(start).unwrap()).unwrap());
265             CValue::by_val_pair(ptr, len, layout)
266         }
267     }
268 }
269
270 pub(crate) fn pointer_for_allocation<'tcx>(
271     fx: &mut FunctionCx<'_, '_, 'tcx>,
272     alloc: ConstAllocation<'tcx>,
273 ) -> crate::pointer::Pointer {
274     let alloc_id = fx.tcx.create_memory_alloc(alloc);
275     let data_id = data_id_for_alloc_id(
276         &mut fx.constants_cx,
277         &mut *fx.module,
278         alloc_id,
279         alloc.inner().mutability,
280     );
281
282     let local_data_id = fx.module.declare_data_in_func(data_id, &mut fx.bcx.func);
283     if fx.clif_comments.enabled() {
284         fx.add_comment(local_data_id, format!("{:?}", alloc_id));
285     }
286     let global_ptr = fx.bcx.ins().global_value(fx.pointer_type, local_data_id);
287     crate::pointer::Pointer::new(global_ptr)
288 }
289
290 pub(crate) fn data_id_for_alloc_id(
291     cx: &mut ConstantCx,
292     module: &mut dyn Module,
293     alloc_id: AllocId,
294     mutability: rustc_hir::Mutability,
295 ) -> DataId {
296     cx.todo.push(TodoItem::Alloc(alloc_id));
297     *cx.anon_allocs.entry(alloc_id).or_insert_with(|| {
298         module.declare_anonymous_data(mutability == rustc_hir::Mutability::Mut, false).unwrap()
299     })
300 }
301
302 fn data_id_for_static(
303     tcx: TyCtxt<'_>,
304     module: &mut dyn Module,
305     def_id: DefId,
306     definition: bool,
307 ) -> DataId {
308     let rlinkage = tcx.codegen_fn_attrs(def_id).linkage;
309     let linkage = if definition {
310         crate::linkage::get_static_linkage(tcx, def_id)
311     } else if rlinkage == Some(rustc_middle::mir::mono::Linkage::ExternalWeak)
312         || rlinkage == Some(rustc_middle::mir::mono::Linkage::WeakAny)
313     {
314         Linkage::Preemptible
315     } else {
316         Linkage::Import
317     };
318
319     let instance = Instance::mono(tcx, def_id).polymorphize(tcx);
320     let symbol_name = tcx.symbol_name(instance).name;
321     let ty = instance.ty(tcx, ParamEnv::reveal_all());
322     let is_mutable = if tcx.is_mutable_static(def_id) {
323         true
324     } else {
325         !ty.is_freeze(tcx.at(DUMMY_SP), ParamEnv::reveal_all())
326     };
327     let align = tcx.layout_of(ParamEnv::reveal_all().and(ty)).unwrap().align.pref.bytes();
328
329     let attrs = tcx.codegen_fn_attrs(def_id);
330
331     let data_id = module
332         .declare_data(
333             &*symbol_name,
334             linkage,
335             is_mutable,
336             attrs.flags.contains(CodegenFnAttrFlags::THREAD_LOCAL),
337         )
338         .unwrap();
339
340     if rlinkage.is_some() {
341         // Comment copied from https://github.com/rust-lang/rust/blob/45060c2a66dfd667f88bd8b94261b28a58d85bd5/src/librustc_codegen_llvm/consts.rs#L141
342         // Declare an internal global `extern_with_linkage_foo` which
343         // is initialized with the address of `foo`.  If `foo` is
344         // discarded during linking (for example, if `foo` has weak
345         // linkage and there are no definitions), then
346         // `extern_with_linkage_foo` will instead be initialized to
347         // zero.
348
349         let ref_name = format!("_rust_extern_with_linkage_{}", symbol_name);
350         let ref_data_id = module.declare_data(&ref_name, Linkage::Local, false, false).unwrap();
351         let mut data_ctx = DataContext::new();
352         data_ctx.set_align(align);
353         let data = module.declare_data_in_data(data_id, &mut data_ctx);
354         data_ctx.define(std::iter::repeat(0).take(pointer_ty(tcx).bytes() as usize).collect());
355         data_ctx.write_data_addr(0, data, 0);
356         match module.define_data(ref_data_id, &data_ctx) {
357             // Every time the static is referenced there will be another definition of this global,
358             // so duplicate definitions are expected and allowed.
359             Err(ModuleError::DuplicateDefinition(_)) => {}
360             res => res.unwrap(),
361         }
362         ref_data_id
363     } else {
364         data_id
365     }
366 }
367
368 fn define_all_allocs(tcx: TyCtxt<'_>, module: &mut dyn Module, cx: &mut ConstantCx) {
369     while let Some(todo_item) = cx.todo.pop() {
370         let (data_id, alloc, section_name) = match todo_item {
371             TodoItem::Alloc(alloc_id) => {
372                 let alloc = match tcx.global_alloc(alloc_id) {
373                     GlobalAlloc::Memory(alloc) => alloc,
374                     GlobalAlloc::Function(_) | GlobalAlloc::Static(_) | GlobalAlloc::VTable(..) => {
375                         unreachable!()
376                     }
377                 };
378                 let data_id = *cx.anon_allocs.entry(alloc_id).or_insert_with(|| {
379                     module
380                         .declare_anonymous_data(
381                             alloc.inner().mutability == rustc_hir::Mutability::Mut,
382                             false,
383                         )
384                         .unwrap()
385                 });
386                 (data_id, alloc, None)
387             }
388             TodoItem::Static(def_id) => {
389                 //println!("static {:?}", def_id);
390
391                 let section_name = tcx.codegen_fn_attrs(def_id).link_section;
392
393                 let alloc = tcx.eval_static_initializer(def_id).unwrap();
394
395                 let data_id = data_id_for_static(tcx, module, def_id, true);
396                 (data_id, alloc, section_name)
397             }
398         };
399
400         //("data_id {}", data_id);
401         if cx.done.contains(&data_id) {
402             continue;
403         }
404
405         let mut data_ctx = DataContext::new();
406         let alloc = alloc.inner();
407         data_ctx.set_align(alloc.align.bytes());
408
409         if let Some(section_name) = section_name {
410             let (segment_name, section_name) = if tcx.sess.target.is_like_osx {
411                 let section_name = section_name.as_str();
412                 if let Some(names) = section_name.split_once(',') {
413                     names
414                 } else {
415                     tcx.sess.fatal(&format!(
416                         "#[link_section = \"{}\"] is not valid for macos target: must be segment and section separated by comma",
417                         section_name
418                     ));
419                 }
420             } else {
421                 ("", section_name.as_str())
422             };
423             data_ctx.set_segment_section(segment_name, section_name);
424         }
425
426         let bytes = alloc.inspect_with_uninit_and_ptr_outside_interpreter(0..alloc.len()).to_vec();
427         data_ctx.define(bytes.into_boxed_slice());
428
429         for &(offset, alloc_id) in alloc.relocations().iter() {
430             let addend = {
431                 let endianness = tcx.data_layout.endian;
432                 let offset = offset.bytes() as usize;
433                 let ptr_size = tcx.data_layout.pointer_size;
434                 let bytes = &alloc.inspect_with_uninit_and_ptr_outside_interpreter(
435                     offset..offset + ptr_size.bytes() as usize,
436                 );
437                 read_target_uint(endianness, bytes).unwrap()
438             };
439
440             let reloc_target_alloc = tcx.global_alloc(alloc_id);
441             let data_id = match reloc_target_alloc {
442                 GlobalAlloc::Function(instance) => {
443                     assert_eq!(addend, 0);
444                     let func_id = crate::abi::import_function(tcx, module, instance);
445                     let local_func_id = module.declare_func_in_data(func_id, &mut data_ctx);
446                     data_ctx.write_function_addr(offset.bytes() as u32, local_func_id);
447                     continue;
448                 }
449                 GlobalAlloc::Memory(target_alloc) => {
450                     data_id_for_alloc_id(cx, module, alloc_id, target_alloc.inner().mutability)
451                 }
452                 GlobalAlloc::VTable(ty, trait_ref) => {
453                     let alloc_id = tcx.vtable_allocation((ty, trait_ref));
454                     data_id_for_alloc_id(cx, module, alloc_id, Mutability::Not)
455                 }
456                 GlobalAlloc::Static(def_id) => {
457                     if tcx.codegen_fn_attrs(def_id).flags.contains(CodegenFnAttrFlags::THREAD_LOCAL)
458                     {
459                         tcx.sess.fatal(&format!(
460                             "Allocation {:?} contains reference to TLS value {:?}",
461                             alloc, def_id
462                         ));
463                     }
464
465                     // Don't push a `TodoItem::Static` here, as it will cause statics used by
466                     // multiple crates to be duplicated between them. It isn't necessary anyway,
467                     // as it will get pushed by `codegen_static` when necessary.
468                     data_id_for_static(tcx, module, def_id, false)
469                 }
470             };
471
472             let global_value = module.declare_data_in_data(data_id, &mut data_ctx);
473             data_ctx.write_data_addr(offset.bytes() as u32, global_value, addend as i64);
474         }
475
476         module.define_data(data_id, &data_ctx).unwrap();
477         cx.done.insert(data_id);
478     }
479
480     assert!(cx.todo.is_empty(), "{:?}", cx.todo);
481 }
482
483 pub(crate) fn mir_operand_get_const_val<'tcx>(
484     fx: &FunctionCx<'_, '_, 'tcx>,
485     operand: &Operand<'tcx>,
486 ) -> Option<ConstValue<'tcx>> {
487     match operand {
488         Operand::Constant(const_) => match const_.literal {
489             ConstantKind::Ty(const_) => fx
490                 .monomorphize(const_)
491                 .eval_for_mir(fx.tcx, ParamEnv::reveal_all())
492                 .try_to_value(fx.tcx),
493             ConstantKind::Val(val, _) => Some(val),
494         },
495         // FIXME(rust-lang/rust#85105): Casts like `IMM8 as u32` result in the const being stored
496         // inside a temporary before being passed to the intrinsic requiring the const argument.
497         // This code tries to find a single constant defining definition of the referenced local.
498         Operand::Copy(place) | Operand::Move(place) => {
499             if !place.projection.is_empty() {
500                 return None;
501             }
502             let mut computed_const_val = None;
503             for bb_data in fx.mir.basic_blocks() {
504                 for stmt in &bb_data.statements {
505                     match &stmt.kind {
506                         StatementKind::Assign(local_and_rvalue) if &local_and_rvalue.0 == place => {
507                             match &local_and_rvalue.1 {
508                                 Rvalue::Cast(CastKind::Misc, operand, ty) => {
509                                     if computed_const_val.is_some() {
510                                         return None; // local assigned twice
511                                     }
512                                     if !matches!(ty.kind(), ty::Uint(_) | ty::Int(_)) {
513                                         return None;
514                                     }
515                                     let const_val = mir_operand_get_const_val(fx, operand)?;
516                                     if fx.layout_of(*ty).size
517                                         != const_val.try_to_scalar_int()?.size()
518                                     {
519                                         return None;
520                                     }
521                                     computed_const_val = Some(const_val);
522                                 }
523                                 Rvalue::Use(operand) => {
524                                     computed_const_val = mir_operand_get_const_val(fx, operand)
525                                 }
526                                 _ => return None,
527                             }
528                         }
529                         StatementKind::SetDiscriminant { place: stmt_place, variant_index: _ }
530                             if &**stmt_place == place =>
531                         {
532                             return None;
533                         }
534                         StatementKind::CopyNonOverlapping(_) => {
535                             return None;
536                         } // conservative handling
537                         StatementKind::Assign(_)
538                         | StatementKind::FakeRead(_)
539                         | StatementKind::SetDiscriminant { .. }
540                         | StatementKind::Deinit(_)
541                         | StatementKind::StorageLive(_)
542                         | StatementKind::StorageDead(_)
543                         | StatementKind::Retag(_, _)
544                         | StatementKind::AscribeUserType(_, _)
545                         | StatementKind::Coverage(_)
546                         | StatementKind::Nop => {}
547                     }
548                 }
549                 match &bb_data.terminator().kind {
550                     TerminatorKind::Goto { .. }
551                     | TerminatorKind::SwitchInt { .. }
552                     | TerminatorKind::Resume
553                     | TerminatorKind::Abort
554                     | TerminatorKind::Return
555                     | TerminatorKind::Unreachable
556                     | TerminatorKind::Drop { .. }
557                     | TerminatorKind::Assert { .. } => {}
558                     TerminatorKind::DropAndReplace { .. }
559                     | TerminatorKind::Yield { .. }
560                     | TerminatorKind::GeneratorDrop
561                     | TerminatorKind::FalseEdge { .. }
562                     | TerminatorKind::FalseUnwind { .. } => unreachable!(),
563                     TerminatorKind::InlineAsm { .. } => return None,
564                     TerminatorKind::Call { destination, target: Some(_), .. }
565                         if destination == place =>
566                     {
567                         return None;
568                     }
569                     TerminatorKind::Call { .. } => {}
570                 }
571             }
572             computed_const_val
573         }
574     }
575 }