1use std::borrow::{Borrow, Cow};
2use std::cell::{Cell, RefCell};
3use std::ffi::{CStr, c_char, c_uint};
4use std::marker::PhantomData;
5use std::ops::{Deref, DerefMut};
6use std::str;
7
8use rustc_abi::{HasDataLayout, Size, TargetDataLayout, VariantIdx};
9use rustc_codegen_ssa::back::versioned_llvm_target;
10use rustc_codegen_ssa::base::{wants_msvc_seh, wants_wasm_eh};
11use rustc_codegen_ssa::diagnostics as ssa_errors;
12use rustc_codegen_ssa::traits::*;
13use rustc_data_structures::base_n::{ALPHANUMERIC_ONLY, ToBaseN};
14use rustc_data_structures::fx::FxHashMap;
15use rustc_data_structures::small_c_str::SmallCStr;
16use rustc_hir::def_id::DefId;
17use rustc_middle::mono::CodegenUnit;
18use rustc_middle::ty::layout::{
19 FnAbiError, FnAbiOfHelpers, FnAbiRequest, HasTypingEnv, LayoutError, LayoutOfHelpers,
20};
21use rustc_middle::ty::{self, Instance, Ty, TyCtxt};
22use rustc_middle::{bug, span_bug};
23use rustc_sanitizers::ignorelist::{SanitizerIgnoreList, typename_for_ignore_list};
24use rustc_session::config::{
25 BranchProtection, CFGuard, CFProtection, DebugInfo, FunctionReturn, PAuthKey, PacRet,
26};
27use rustc_session::{PointerAuthSchema, Session};
28use rustc_span::{DUMMY_SP, Span, Spanned, Symbol, sym};
29use rustc_structures::CrateType;
30use rustc_target::spec::{
31 Arch, CfgAbi, Env, FramePointer, HasTargetSpec, Os, RelocModel, SmallDataThresholdSupport,
32 Target, TlsModel,
33};
34use smallvec::SmallVec;
35
36use crate::abi::to_llvm_calling_convention;
37use crate::back::write::to_llvm_code_model;
38use crate::builder::gpu_offload::{OffloadGlobals, OffloadKernelGlobals};
39use crate::callee::get_fn;
40use crate::debuginfo::metadata::apply_vcall_visibility_metadata;
41use crate::llvm::{self, Metadata, MetadataKindId, Module, Type, Value};
42use crate::{attributes, common, coverageinfo, debuginfo, llvm_util};
43
44pub(crate) struct SCx<'ll> {
49 pub llmod: &'ll llvm::Module,
50 pub llcx: &'ll llvm::Context,
51 pub isize_ty: &'ll Type,
52}
53
54impl<'ll> Borrow<SCx<'ll>> for FullCx<'ll, '_> {
55 fn borrow(&self) -> &SCx<'ll> {
56 &self.scx
57 }
58}
59
60impl<'ll, 'tcx> Deref for FullCx<'ll, 'tcx> {
61 type Target = SimpleCx<'ll>;
62
63 #[inline]
64 fn deref(&self) -> &Self::Target {
65 &self.scx
66 }
67}
68
69pub(crate) struct GenericCx<'ll, T: Borrow<SCx<'ll>>>(T, PhantomData<SCx<'ll>>);
70
71impl<'ll, T: Borrow<SCx<'ll>>> Deref for GenericCx<'ll, T> {
72 type Target = T;
73
74 #[inline]
75 fn deref(&self) -> &Self::Target {
76 &self.0
77 }
78}
79
80impl<'ll, T: Borrow<SCx<'ll>>> DerefMut for GenericCx<'ll, T> {
81 #[inline]
82 fn deref_mut(&mut self) -> &mut Self::Target {
83 &mut self.0
84 }
85}
86
87pub(crate) type SimpleCx<'ll> = GenericCx<'ll, SCx<'ll>>;
88
89pub(crate) type CodegenCx<'ll, 'tcx> = GenericCx<'ll, FullCx<'ll, 'tcx>>;
93
94pub(crate) struct FullCx<'ll, 'tcx> {
95 pub tcx: TyCtxt<'tcx>,
96 pub bitcode_needed: bool,
97 pub scx: SimpleCx<'ll>,
98 pub use_dll_storage_attrs: bool,
99 pub tls_model: llvm::ThreadLocalMode,
100
101 pub codegen_unit: &'tcx CodegenUnit<'tcx>,
102
103 pub instances: RefCell<FxHashMap<Instance<'tcx>, &'ll Value>>,
105 pub intrinsic_instances: RefCell<FxHashMap<Instance<'tcx>, &'ll Value>>,
107 pub vtables: RefCell<FxHashMap<(Ty<'tcx>, Option<ty::ExistentialTraitRef<'tcx>>), &'ll Value>>,
109 pub const_str_cache: RefCell<FxHashMap<String, &'ll Value>>,
111
112 pub const_globals: RefCell<FxHashMap<&'ll Value, &'ll Value>>,
114
115 pub statics_to_rauw: RefCell<Vec<(&'ll Value, &'ll Value)>>,
120
121 pub used_statics: Vec<&'ll Value>,
124
125 pub compiler_used_statics: RefCell<Vec<&'ll Value>>,
128
129 pub type_lowering: RefCell<FxHashMap<(Ty<'tcx>, Option<VariantIdx>), &'ll Type>>,
131
132 pub scalar_lltypes: RefCell<FxHashMap<Ty<'tcx>, &'ll Type>>,
134
135 pub coverage_cx: Option<coverageinfo::CguCoverageContext<'ll, 'tcx>>,
137 pub dbg_cx: Option<debuginfo::CodegenUnitDebugContext<'ll, 'tcx>>,
138 pub sanitizer_ignorelist: Option<SanitizerIgnoreList>,
139
140 eh_personality: Cell<Option<&'ll Value>>,
141 pub rust_try_fn: Cell<Option<(&'ll Type, &'ll Value)>>,
142
143 intrinsics:
144 RefCell<FxHashMap<(Cow<'static, str>, SmallVec<[&'ll Type; 2]>), (&'ll Type, &'ll Value)>>,
145
146 local_gen_sym_counter: Cell<usize>,
148
149 global_gen_sym_counter: Cell<usize>,
151
152 pub renamed_statics: RefCell<FxHashMap<DefId, &'ll Value>>,
157
158 pub objc_class_t: Cell<Option<&'ll Type>>,
160
161 pub objc_classrefs: RefCell<FxHashMap<Symbol, &'ll Value>>,
163
164 pub objc_selrefs: RefCell<FxHashMap<Symbol, &'ll Value>>,
166
167 pub offload_globals: RefCell<Option<OffloadGlobals<'ll>>>,
169
170 pub offload_kernel_cache: RefCell<FxHashMap<String, OffloadKernelGlobals<'ll>>>,
172}
173
174fn to_llvm_tls_model(tls_model: TlsModel) -> llvm::ThreadLocalMode {
175 match tls_model {
176 TlsModel::GeneralDynamic => llvm::ThreadLocalMode::GeneralDynamic,
177 TlsModel::LocalDynamic => llvm::ThreadLocalMode::LocalDynamic,
178 TlsModel::InitialExec => llvm::ThreadLocalMode::InitialExec,
179 TlsModel::LocalExec => llvm::ThreadLocalMode::LocalExec,
180 TlsModel::Emulated => llvm::ThreadLocalMode::GeneralDynamic,
181 }
182}
183
184pub(crate) unsafe fn create_module<'ll>(
185 tcx: TyCtxt<'_>,
186 llcx: &'ll llvm::Context,
187 mod_name: &str,
188) -> &'ll llvm::Module {
189 let sess = tcx.sess;
190 let mod_name = SmallCStr::new(mod_name);
191 let llmod = unsafe { llvm::LLVMModuleCreateWithNameInContext(mod_name.as_ptr(), llcx) };
192
193 let cx = SimpleCx::new(llmod, llcx, tcx.data_layout.pointer_size());
194
195 let mut target_data_layout = sess.target.data_layout.to_string();
196 let llvm_version = llvm_util::get_version();
197
198 if llvm_version < (22, 0, 0) {
199 if sess.target.arch == Arch::Avr {
200 target_data_layout = target_data_layout.replace("n8:16", "n8")
202 }
203 if sess.target.arch == Arch::Nvptx64 {
204 target_data_layout = target_data_layout.replace("-i256:256", "");
206 }
207 if sess.target.arch == Arch::PowerPC64 {
208 target_data_layout = target_data_layout.replace("-f64:32:64", "");
210
211 if sess.target.llvm_target == "powerpc64-unknown-linux-gnu" {
216 target_data_layout = target_data_layout.replace("-Fn32", "-Fi64");
217 }
218 }
219 if sess.target.arch == Arch::AmdGpu {
220 target_data_layout = target_data_layout.replace("-m:e", "");
223 }
224 }
225 if llvm_version < (23, 0, 0) {
226 if sess.target.arch == Arch::S390x {
227 target_data_layout = target_data_layout.replace("-S64", "");
229 }
230 }
231
232 {
234 let tm = crate::back::write::create_informational_target_machine(sess, false);
235 unsafe {
236 llvm::LLVMRustSetDataLayoutFromTargetMachine(llmod, tm.raw());
237 }
238
239 let llvm_data_layout = unsafe { llvm::LLVMGetDataLayoutStr(llmod) };
240 let llvm_data_layout =
241 str::from_utf8(unsafe { CStr::from_ptr(llvm_data_layout) }.to_bytes())
242 .expect("got a non-UTF8 data-layout from LLVM");
243
244 if target_data_layout != llvm_data_layout {
245 tcx.dcx().emit_err(crate::diagnostics::MismatchedDataLayout {
246 rustc_target: sess.opts.target_triple.to_string().as_str(),
247 rustc_layout: target_data_layout.as_str(),
248 llvm_target: sess.target.llvm_target.borrow(),
249 llvm_layout: llvm_data_layout,
250 });
251 }
252 }
253
254 let data_layout = SmallCStr::new(&target_data_layout);
255 unsafe {
256 llvm::LLVMSetDataLayout(llmod, data_layout.as_ptr());
257 }
258
259 let llvm_target = SmallCStr::new(&versioned_llvm_target(sess));
260 unsafe {
261 llvm::LLVMRustSetNormalizedTarget(llmod, llvm_target.as_ptr());
262 }
263
264 let reloc_model = sess.relocation_model();
265 if #[allow(non_exhaustive_omitted_patterns)] match reloc_model {
RelocModel::Pic | RelocModel::Pie => true,
_ => false,
}matches!(reloc_model, RelocModel::Pic | RelocModel::Pie) {
266 unsafe {
267 llvm::LLVMRustSetModulePICLevel(llmod);
268 }
269 if reloc_model == RelocModel::Pie
272 || tcx.crate_types().iter().all(|ty| *ty == CrateType::Executable)
273 {
274 unsafe {
275 llvm::LLVMRustSetModulePIELevel(llmod);
276 }
277 }
278 }
279
280 unsafe {
286 llvm::LLVMRustSetModuleCodeModel(llmod, to_llvm_code_model(sess.code_model()));
287 }
288
289 if let Some(large_data_threshold) = sess.opts.unstable_opts.large_data_threshold {
290 unsafe {
291 llvm::LLVMRustSetModuleLargeDataThreshold(llmod, large_data_threshold);
292 }
293 }
294
295 if !sess.needs_plt() {
298 llvm::add_module_flag_u32(llmod, llvm::ModuleFlagMergeBehavior::Warning, "RtLibUseGOT", 1);
299 }
300
301 if sess.is_sanitizer_cfi_canonical_jump_tables_enabled() && sess.is_sanitizer_cfi_enabled() {
303 llvm::add_module_flag_u32(
304 llmod,
305 llvm::ModuleFlagMergeBehavior::Override,
306 "CFI Canonical Jump Tables",
307 1,
308 );
309 }
310
311 if sess.is_sanitizer_cfi_normalize_integers_enabled() {
314 llvm::add_module_flag_u32(
315 llmod,
316 llvm::ModuleFlagMergeBehavior::Override,
317 "cfi-normalize-integers",
318 1,
319 );
320 }
321
322 if sess.is_split_lto_unit_enabled() || sess.is_sanitizer_cfi_enabled() {
325 llvm::add_module_flag_u32(
326 llmod,
327 llvm::ModuleFlagMergeBehavior::Override,
328 "EnableSplitLTOUnit",
329 1,
330 );
331 }
332
333 if sess.must_emit_unwind_tables() {
334 const {
337 if !((llvm::UWTableKind::None as u32) < (llvm::UWTableKind::Sync as u32)) {
::core::panicking::panic("assertion failed: (llvm::UWTableKind::None as u32) < (llvm::UWTableKind::Sync as u32)")
};assert!((llvm::UWTableKind::None as u32) < (llvm::UWTableKind::Sync as u32));
338 if !((llvm::UWTableKind::Sync as u32) < (llvm::UWTableKind::Async as u32)) {
::core::panicking::panic("assertion failed: (llvm::UWTableKind::Sync as u32) < (llvm::UWTableKind::Async as u32)")
};assert!((llvm::UWTableKind::Sync as u32) < (llvm::UWTableKind::Async as u32));
339 }
340
341 llvm::add_module_flag_u32(
342 llmod,
343 llvm::ModuleFlagMergeBehavior::Max,
344 "uwtable",
345 match sess.opts.unstable_opts.use_sync_unwind {
346 Some(true) => llvm::UWTableKind::Sync as u32,
347 Some(false) | None => llvm::UWTableKind::Async as u32,
348 },
349 );
350 }
351
352 if sess.is_sanitizer_kcfi_enabled() {
354 llvm::add_module_flag_u32(llmod, llvm::ModuleFlagMergeBehavior::Override, "kcfi", 1);
355
356 let patchable_prefix_nops = sess.opts.unstable_opts.patchable_function_entry.prefix();
359 if patchable_prefix_nops > 0 {
360 llvm::add_module_flag_u32(
361 llmod,
362 llvm::ModuleFlagMergeBehavior::Override,
363 "kcfi-offset",
364 patchable_prefix_nops.into(),
365 );
366 }
367
368 if sess.is_sanitizer_kcfi_arity_enabled() {
371 llvm::add_module_flag_u32(
372 llmod,
373 llvm::ModuleFlagMergeBehavior::Override,
374 "kcfi-arity",
375 1,
376 );
377 }
378 }
379
380 if sess.target.is_like_msvc
382 || (sess.target.options.os == Os::Windows
383 && sess.target.options.env == Env::Gnu
384 && sess.target.options.cfg_abi == CfgAbi::Llvm)
385 {
386 match sess.opts.cg.control_flow_guard {
387 CFGuard::Disabled => {}
388 CFGuard::NoChecks => {
389 llvm::add_module_flag_u32(
391 llmod,
392 llvm::ModuleFlagMergeBehavior::Warning,
393 "cfguard",
394 1,
395 );
396 }
397 CFGuard::Checks => {
398 llvm::add_module_flag_u32(
400 llmod,
401 llvm::ModuleFlagMergeBehavior::Warning,
402 "cfguard",
403 2,
404 );
405 }
406 }
407 }
408
409 if let Some(regparm_count) = sess.opts.unstable_opts.regparm {
410 llvm::add_module_flag_u32(
411 llmod,
412 llvm::ModuleFlagMergeBehavior::Error,
413 "NumRegisterParameters",
414 regparm_count,
415 );
416 }
417
418 if let Some(BranchProtection { bti, pac_ret, gcs }) = sess.branch_protection() {
419 if sess.target.arch == Arch::AArch64 {
420 llvm::add_module_flag_u32(
421 llmod,
422 llvm::ModuleFlagMergeBehavior::Min,
423 "branch-target-enforcement",
424 bti.into(),
425 );
426 llvm::add_module_flag_u32(
427 llmod,
428 llvm::ModuleFlagMergeBehavior::Min,
429 "sign-return-address",
430 pac_ret.is_some().into(),
431 );
432 let pac_opts = pac_ret.unwrap_or_else(|| {
433 let key = if sess.target.os == Os::Windows { PAuthKey::B } else { PAuthKey::A };
435 PacRet { leaf: false, pc: false, key }
436 });
437 llvm::add_module_flag_u32(
438 llmod,
439 llvm::ModuleFlagMergeBehavior::Min,
440 "branch-protection-pauth-lr",
441 pac_opts.pc.into(),
442 );
443 llvm::add_module_flag_u32(
444 llmod,
445 llvm::ModuleFlagMergeBehavior::Min,
446 "sign-return-address-all",
447 pac_opts.leaf.into(),
448 );
449 llvm::add_module_flag_u32(
450 llmod,
451 llvm::ModuleFlagMergeBehavior::Min,
452 "sign-return-address-with-bkey",
453 u32::from(pac_opts.key == PAuthKey::B),
454 );
455 llvm::add_module_flag_u32(
456 llmod,
457 llvm::ModuleFlagMergeBehavior::Min,
458 "guarded-control-stack",
459 gcs.into(),
460 );
461 } else {
462 ::rustc_middle::util::bug::bug_fmt(format_args!("branch-protection used on non-AArch64 target; this should be checked in rustc_session."));bug!(
463 "branch-protection used on non-AArch64 target; \
464 this should be checked in rustc_session."
465 );
466 }
467 }
468
469 if let CFProtection::Branch | CFProtection::Full = sess.opts.unstable_opts.cf_protection {
471 llvm::add_module_flag_u32(
472 llmod,
473 llvm::ModuleFlagMergeBehavior::Override,
474 "cf-protection-branch",
475 1,
476 );
477 }
478 if let CFProtection::Return | CFProtection::Full = sess.opts.unstable_opts.cf_protection {
479 llvm::add_module_flag_u32(
480 llmod,
481 llvm::ModuleFlagMergeBehavior::Override,
482 "cf-protection-return",
483 1,
484 );
485 }
486
487 if sess.opts.unstable_opts.virtual_function_elimination {
488 llvm::add_module_flag_u32(
489 llmod,
490 llvm::ModuleFlagMergeBehavior::Error,
491 "Virtual Function Elim",
492 1,
493 );
494 }
495
496 if sess.opts.unstable_opts.ehcont_guard {
498 llvm::add_module_flag_u32(llmod, llvm::ModuleFlagMergeBehavior::Warning, "ehcontguard", 1);
499 }
500
501 match sess.opts.unstable_opts.function_return {
502 FunctionReturn::Keep => {}
503 FunctionReturn::ThunkExtern => {
504 llvm::add_module_flag_u32(
505 llmod,
506 llvm::ModuleFlagMergeBehavior::Override,
507 "function_return_thunk_extern",
508 1,
509 );
510 }
511 }
512
513 let fp = attributes::frame_pointer(sess);
514 if fp != FramePointer::MayOmit {
515 llvm::add_module_flag_u32(
516 llmod,
517 llvm::ModuleFlagMergeBehavior::Max,
518 "frame-pointer",
519 match fp {
520 FramePointer::Always => llvm::FramePointerKind::All as u32,
521 FramePointer::NonLeaf => llvm::FramePointerKind::NonLeaf as u32,
522 FramePointer::MayOmit => llvm::FramePointerKind::None as u32,
523 },
524 );
525 }
526
527 if sess.opts.unstable_opts.indirect_branch_cs_prefix {
528 llvm::add_module_flag_u32(
529 llmod,
530 llvm::ModuleFlagMergeBehavior::Override,
531 "indirect_branch_cs_prefix",
532 1,
533 );
534 }
535
536 match (sess.opts.unstable_opts.small_data_threshold, sess.target.small_data_threshold_support())
537 {
538 (Some(threshold), SmallDataThresholdSupport::LlvmModuleFlag(flag)) => {
541 llvm::add_module_flag_u32(
542 llmod,
543 llvm::ModuleFlagMergeBehavior::Error,
544 &flag,
545 threshold as u32,
546 );
547 }
548 _ => (),
549 };
550
551 #[allow(clippy::option_env_unwrap)]
556 let rustc_producer =
557 ::alloc::__export::must_use({
::alloc::fmt::format(format_args!("rustc version {0}",
::core::option::Option::Some("1.100.0-nightly (cea272fa3 2026-09-07)").expect("CFG_VERSION")))
})format!("rustc version {}", option_env!("CFG_VERSION").expect("CFG_VERSION"));
558
559 let name_metadata = cx.create_metadata(rustc_producer.as_bytes());
560 cx.module_add_named_metadata_node(llmod, c"llvm.ident", &[name_metadata]);
561
562 let llvm_abiname = &sess.target.options.llvm_abiname;
567 if #[allow(non_exhaustive_omitted_patterns)] match sess.target.arch {
Arch::RiscV32 | Arch::RiscV64 => true,
_ => false,
}matches!(sess.target.arch, Arch::RiscV32 | Arch::RiscV64) {
568 llvm::add_module_flag_str(
569 llmod,
570 llvm::ModuleFlagMergeBehavior::Error,
571 "target-abi",
572 llvm_abiname.desc(),
573 );
574 }
575
576 if llvm_version >= (24, 0, 0)
577 && let Some(floatabi) = sess.target.llvm_floatabi
578 {
579 llvm::add_module_flag_str(
580 llmod,
581 llvm::ModuleFlagMergeBehavior::Error,
582 "float-abi",
583 floatabi.desc(),
584 );
585 }
586
587 for (key, value, merge_behavior) in &sess.opts.unstable_opts.llvm_module_flag {
589 let merge_behavior = match merge_behavior.as_str() {
590 "error" => llvm::ModuleFlagMergeBehavior::Error,
591 "warning" => llvm::ModuleFlagMergeBehavior::Warning,
592 "require" => llvm::ModuleFlagMergeBehavior::Require,
593 "override" => llvm::ModuleFlagMergeBehavior::Override,
594 "append" => llvm::ModuleFlagMergeBehavior::Append,
595 "appendunique" => llvm::ModuleFlagMergeBehavior::AppendUnique,
596 "max" => llvm::ModuleFlagMergeBehavior::Max,
597 "min" => llvm::ModuleFlagMergeBehavior::Min,
598 _ => ::core::panicking::panic("internal error: entered unreachable code")unreachable!(),
600 };
601 llvm::add_module_flag_u32(llmod, merge_behavior, key, *value);
602 }
603
604 llmod
605}
606
607impl<'ll, 'tcx> CodegenCx<'ll, 'tcx> {
608 pub(crate) fn new(
609 tcx: TyCtxt<'tcx>,
610 codegen_unit: &'tcx CodegenUnit<'tcx>,
611 llvm_module: &'ll crate::ModuleLlvm,
612 bitcode_needed: bool,
613 ) -> Self {
614 let use_dll_storage_attrs = tcx.sess.target.is_like_windows;
667
668 let tls_model = to_llvm_tls_model(tcx.sess.tls_model());
669
670 let (llcx, llmod) = (&*llvm_module.llcx, llvm_module.llmod());
671
672 let coverage_cx =
673 tcx.sess.instrument_coverage().then(coverageinfo::CguCoverageContext::new);
674
675 let dbg_cx = if tcx.sess.opts.debuginfo != DebugInfo::None {
676 let dctx = debuginfo::CodegenUnitDebugContext::new(llmod, tcx.sess);
677 debuginfo::metadata::build_compile_unit_di_node(
678 tcx,
679 codegen_unit.name().as_str(),
680 &dctx,
681 );
682 Some(dctx)
683 } else {
684 None
685 };
686
687 let sanitizer_ignorelist = if !tcx.sess.opts.unstable_opts.sanitizer_ignorelist.is_empty() {
692 for path in &tcx.sess.opts.unstable_opts.sanitizer_ignorelist {
693 let _ = tcx.sess.source_map().load_file(std::path::Path::new(path));
694 }
695 match SanitizerIgnoreList::new(&tcx.sess.opts.unstable_opts.sanitizer_ignorelist) {
696 Ok(list) => Some(list),
697 Err(err) => {
698 tcx.dcx().fatal(::alloc::__export::must_use({
::alloc::fmt::format(format_args!("failed to parse sanitizer ignorelist: {0}",
err))
})format!("failed to parse sanitizer ignorelist: {}", err));
699 }
700 }
701 } else {
702 None
703 };
704
705 GenericCx(
706 FullCx {
707 tcx,
708 bitcode_needed,
709 scx: SimpleCx::new(llmod, llcx, tcx.data_layout.pointer_size()),
710 use_dll_storage_attrs,
711 tls_model,
712 codegen_unit,
713 instances: Default::default(),
714 intrinsic_instances: Default::default(),
715 vtables: Default::default(),
716 const_str_cache: Default::default(),
717 const_globals: Default::default(),
718 statics_to_rauw: RefCell::new(Vec::new()),
719 used_statics: Vec::new(),
720 compiler_used_statics: Default::default(),
721 type_lowering: Default::default(),
722 scalar_lltypes: Default::default(),
723 coverage_cx,
724 dbg_cx,
725 sanitizer_ignorelist,
726 eh_personality: Cell::new(None),
727 rust_try_fn: Cell::new(None),
728 intrinsics: Default::default(),
729 local_gen_sym_counter: Cell::new(0),
730 global_gen_sym_counter: Cell::new(0),
731 renamed_statics: Default::default(),
732 objc_class_t: Cell::new(None),
733 objc_classrefs: Default::default(),
734 objc_selrefs: Default::default(),
735 offload_globals: Default::default(),
736 offload_kernel_cache: Default::default(),
737 },
738 PhantomData,
739 )
740 }
741
742 pub(crate) fn statics_to_rauw(&self) -> &RefCell<Vec<(&'ll Value, &'ll Value)>> {
743 &self.statics_to_rauw
744 }
745
746 #[inline]
748 #[track_caller]
749 pub(crate) fn coverage_cx(&self) -> &coverageinfo::CguCoverageContext<'ll, 'tcx> {
750 self.coverage_cx.as_ref().expect("only called when coverage instrumentation is enabled")
751 }
752
753 pub(crate) fn create_used_variable_impl(&self, name: &'static CStr, values: &[&'ll Value]) {
754 let array = self.const_array(self.type_ptr(), values);
755
756 let g = llvm::add_global(self.llmod, self.val_ty(array), name);
757 llvm::set_initializer(g, array);
758 llvm::set_linkage(g, llvm::Linkage::AppendingLinkage);
759 llvm::set_section(g, c"llvm.metadata");
760 }
761
762 pub(crate) fn objc_abi_version(&self) -> u32 {
766 if !self.tcx.sess.target.is_like_darwin {
::core::panicking::panic("assertion failed: self.tcx.sess.target.is_like_darwin")
};assert!(self.tcx.sess.target.is_like_darwin);
767 if self.tcx.sess.target.arch == Arch::X86 && self.tcx.sess.target.os == Os::MacOs {
768 1
770 } else {
771 2
774 }
775 }
776
777 pub(crate) fn add_ptrauth_elf_got_flag(&self) {
778 llvm::add_module_flag_u32(
779 self.llmod,
780 llvm::ModuleFlagMergeBehavior::Error,
781 "ptrauth-elf-got",
782 1,
783 );
784 }
785
786 pub(crate) fn add_ptrauth_sign_personality_flag(&self) {
787 llvm::add_module_flag_u32(
788 self.llmod,
789 llvm::ModuleFlagMergeBehavior::Error,
790 "ptrauth-sign-personality",
791 1,
792 );
793 }
794
795 pub(crate) fn add_ptrauth_pauthabi_version_and_platform_flags(
796 &self,
797 aarch64_elf_pauthabi_version: u32,
798 ) {
799 const AARCH64_PAUTH_PLATFORM_LLVM_LINUX: u32 = 0x10000002;
804 llvm::add_module_flag_u32(
805 self.llmod,
806 llvm::ModuleFlagMergeBehavior::Error,
807 "aarch64-elf-pauthabi-platform",
808 AARCH64_PAUTH_PLATFORM_LLVM_LINUX,
809 );
810 llvm::add_module_flag_u32(
811 self.llmod,
812 llvm::ModuleFlagMergeBehavior::Error,
813 "aarch64-elf-pauthabi-version",
814 aarch64_elf_pauthabi_version,
815 );
816 }
817
818 pub(crate) fn add_objc_module_flags(&self) {
822 let abi_version = self.objc_abi_version();
823
824 llvm::add_module_flag_u32(
825 self.llmod,
826 llvm::ModuleFlagMergeBehavior::Error,
827 "Objective-C Version",
828 abi_version,
829 );
830
831 llvm::add_module_flag_u32(
832 self.llmod,
833 llvm::ModuleFlagMergeBehavior::Error,
834 "Objective-C Image Info Version",
835 0,
836 );
837
838 llvm::add_module_flag_str(
839 self.llmod,
840 llvm::ModuleFlagMergeBehavior::Error,
841 "Objective-C Image Info Section",
842 match abi_version {
843 1 => "__OBJC,__image_info,regular",
844 2 => "__DATA,__objc_imageinfo,regular,no_dead_strip",
845 _ => ::core::panicking::panic("internal error: entered unreachable code")unreachable!(),
846 },
847 );
848
849 if self.tcx.sess.target.env == Env::Sim {
850 llvm::add_module_flag_u32(
851 self.llmod,
852 llvm::ModuleFlagMergeBehavior::Error,
853 "Objective-C Is Simulated",
854 1 << 5,
855 );
856 }
857
858 llvm::add_module_flag_u32(
859 self.llmod,
860 llvm::ModuleFlagMergeBehavior::Error,
861 "Objective-C Class Properties",
862 1 << 6,
863 );
864 }
865
866 pub(crate) fn is_sanitizer_type_ignored(
867 &self,
868 sanitizer: &std::ffi::CStr,
869 fn_abi: &rustc_target::callconv::FnAbi<'tcx, Ty<'tcx>>,
870 ) -> bool {
871 self.sanitizer_ignorelist.as_ref().is_some_and(|ignorelist| {
872 let type_name = typename_for_ignore_list(self.tcx, fn_abi);
873 ignorelist.contains_prefix(sanitizer, c"type", &type_name)
874 })
875 }
876}
877impl<'ll> SimpleCx<'ll> {
878 pub(crate) fn get_type_of_global(&self, val: &'ll Value) -> &'ll Type {
879 unsafe { llvm::LLVMGlobalGetValueType(val) }
880 }
881 pub(crate) fn val_ty(&self, v: &'ll Value) -> &'ll Type {
882 common::val_ty(v)
883 }
884}
885impl<'ll> SimpleCx<'ll> {
886 pub(crate) fn new(
887 llmod: &'ll llvm::Module,
888 llcx: &'ll llvm::Context,
889 pointer_size: Size,
890 ) -> Self {
891 let isize_ty = llvm::LLVMIntTypeInContext(llcx, pointer_size.bits() as c_uint);
892 Self(SCx { llmod, llcx, isize_ty }, PhantomData)
893 }
894}
895
896impl<'ll, CX: Borrow<SCx<'ll>>> GenericCx<'ll, CX> {
897 pub(crate) fn get_metadata_value(&self, metadata: &'ll Metadata) -> &'ll Value {
898 llvm::LLVMMetadataAsValue(self.llcx(), metadata)
899 }
900
901 pub(crate) fn get_const_int(&self, ty: &'ll Type, val: u64) -> &'ll Value {
902 unsafe { llvm::LLVMConstInt(ty, val, llvm::FALSE) }
903 }
904
905 pub(crate) fn get_const_i64(&self, n: u64) -> &'ll Value {
906 self.get_const_int(self.type_i64(), n)
907 }
908
909 pub(crate) fn get_const_i32(&self, n: u64) -> &'ll Value {
910 self.get_const_int(self.type_i32(), n)
911 }
912
913 pub(crate) fn get_const_i16(&self, n: u64) -> &'ll Value {
914 self.get_const_int(self.type_i16(), n)
915 }
916
917 pub(crate) fn get_const_i8(&self, n: u64) -> &'ll Value {
918 self.get_const_int(self.type_i8(), n)
919 }
920
921 pub(crate) fn get_function(&self, name: &str) -> Option<&'ll Value> {
922 let name = SmallCStr::new(name);
923 unsafe { llvm::LLVMGetNamedFunction((**self).borrow().llmod, name.as_ptr()) }
924 }
925
926 pub(crate) fn get_md_kind_id(&self, name: &str) -> llvm::MetadataKindId {
927 unsafe {
928 llvm::LLVMGetMDKindIDInContext(
929 self.llcx(),
930 name.as_ptr() as *const c_char,
931 name.len() as c_uint,
932 )
933 }
934 }
935
936 pub(crate) fn create_metadata(&self, name: &[u8]) -> &'ll Metadata {
937 unsafe {
938 llvm::LLVMMDStringInContext2(self.llcx(), name.as_ptr() as *const c_char, name.len())
939 }
940 }
941
942 pub(crate) fn get_functions(&self) -> Vec<&'ll Value> {
943 let mut functions = ::alloc::vec::Vec::new()vec![];
944 let mut func = unsafe { llvm::LLVMGetFirstFunction(self.llmod()) };
945 while let Some(f) = func {
946 functions.push(f);
947 func = unsafe { llvm::LLVMGetNextFunction(f) }
948 }
949 functions
950 }
951}
952
953impl<'ll, 'tcx> MiscCodegenMethods<'tcx> for CodegenCx<'ll, 'tcx> {
954 fn vtables(
955 &self,
956 ) -> &RefCell<FxHashMap<(Ty<'tcx>, Option<ty::ExistentialTraitRef<'tcx>>), &'ll Value>> {
957 &self.vtables
958 }
959
960 fn apply_vcall_visibility_metadata(
961 &self,
962 ty: Ty<'tcx>,
963 poly_trait_ref: Option<ty::ExistentialTraitRef<'tcx>>,
964 vtable: &'ll Value,
965 ) {
966 apply_vcall_visibility_metadata(self, ty, poly_trait_ref, vtable);
967 }
968
969 fn get_fn(&self, instance: Instance<'tcx>) -> &'ll Value {
970 get_fn(self, instance)
971 }
972
973 fn get_fn_addr(
974 &self,
975 instance: Instance<'tcx>,
976 pointer_auth_schema: Option<&PointerAuthSchema>,
977 ) -> &'ll Value {
978 let llfn = get_fn(self, instance);
991 match pointer_auth_schema {
992 Some(schema) => common::maybe_sign_fn_ptr(self, instance, llfn, schema),
993 None => llfn,
994 }
995 }
996
997 fn eh_personality(&self) -> &'ll Value {
998 if let Some(llpersonality) = self.eh_personality.get() {
1019 return llpersonality;
1020 }
1021
1022 let name = if wants_msvc_seh(self.sess()) {
1023 Some("__CxxFrameHandler3")
1024 } else if wants_wasm_eh(self.sess()) {
1025 Some("__gxx_wasm_personality_v0")
1030 } else {
1031 None
1032 };
1033
1034 let tcx = self.tcx;
1035 let llfn = match tcx.lang_items().eh_personality() {
1036 Some(def_id) if name.is_none() => self.get_fn_addr(
1037 ty::Instance::expect_resolve(
1038 tcx,
1039 self.typing_env(),
1040 def_id,
1041 ty::List::empty(),
1042 DUMMY_SP,
1043 ),
1044 tcx.sess.pointer_authentication_functions(),
1045 ),
1046 _ => {
1047 let name = name.unwrap_or("rust_eh_personality");
1048 if let Some(llfn) = self.get_declared_value(name) {
1049 llfn
1050 } else {
1051 let fty = self.type_variadic_func(&[], self.type_i32());
1052 let llfn = self.declare_cfn(name, llvm::UnnamedAddr::Global, fty);
1053 let target_cpu = attributes::target_cpu_attr(self, self.sess());
1054 attributes::apply_to_llfn(llfn, llvm::AttributePlace::Function, &[target_cpu]);
1055 llfn
1056 }
1057 }
1058 };
1059 self.eh_personality.set(Some(llfn));
1060 llfn
1061 }
1062
1063 fn sess(&self) -> &Session {
1064 self.tcx.sess
1065 }
1066
1067 fn set_frame_pointer_type(&self, llfn: &'ll Value) {
1068 if let Some(attr) = attributes::frame_pointer_type_attr(self, self.sess()) {
1069 attributes::apply_to_llfn(llfn, llvm::AttributePlace::Function, &[attr]);
1070 }
1071 }
1072
1073 fn apply_target_cpu_attr(&self, llfn: &'ll Value) {
1074 let mut attrs = SmallVec::<[_; 2]>::new();
1075 attrs.push(attributes::target_cpu_attr(self, self.sess()));
1076 attrs.extend(attributes::tune_cpu_attr(self, self.sess()));
1077 attributes::apply_to_llfn(llfn, llvm::AttributePlace::Function, &attrs);
1078 }
1079
1080 fn declare_c_main(&self, fn_type: Self::Type) -> Option<Self::Function> {
1081 let entry_name = self.sess().target.entry_name.as_ref();
1082 if self.get_declared_value(entry_name).is_none() {
1083 let llfn = self.declare_entry_fn(
1084 entry_name,
1085 to_llvm_calling_convention(self.sess(), self.sess().target.entry_abi),
1086 llvm::UnnamedAddr::Global,
1087 fn_type,
1088 );
1089 attributes::apply_to_llfn(
1090 llfn,
1091 llvm::AttributePlace::Function,
1092 attributes::target_features_attr(self, self.tcx, ::alloc::vec::Vec::new()vec![]).as_slice(),
1093 );
1094 Some(llfn)
1095 } else {
1096 None
1099 }
1100 }
1101
1102 fn intrinsic_call_expects_place_always(&self, name: Symbol) -> bool {
1103 #[allow(non_exhaustive_omitted_patterns)] match name {
sym::black_box => true,
_ => false,
}matches!(name, sym::black_box)
1104 }
1105}
1106
1107impl<'ll> CodegenCx<'ll, '_> {
1108 pub(crate) fn get_intrinsic(
1109 &self,
1110 base_name: Cow<'static, str>,
1111 type_params: &[&'ll Type],
1112 ) -> (&'ll Type, &'ll Value) {
1113 *self
1114 .intrinsics
1115 .borrow_mut()
1116 .entry((base_name, SmallVec::from_slice(type_params)))
1117 .or_insert_with_key(|(base_name, type_params)| {
1118 self.declare_intrinsic(base_name, type_params)
1119 })
1120 }
1121
1122 fn declare_intrinsic(
1123 &self,
1124 base_name: &str,
1125 type_params: &[&'ll Type],
1126 ) -> (&'ll Type, &'ll Value) {
1127 match base_name {
1128 "memcmp" => {
1132 let fn_ty = self.type_func(
1133 &[self.type_ptr(), self.type_ptr(), self.type_isize()],
1134 self.type_int(),
1135 );
1136 let f = self.declare_cfn("memcmp", llvm::UnnamedAddr::No, fn_ty);
1137
1138 (fn_ty, f)
1139 }
1140 "__rust_retag_reg" => {
1144 let fn_ty = self.type_func(type_params, self.type_ptr());
1145 let llfn = self.declare_cfn(base_name, llvm::UnnamedAddr::No, fn_ty);
1146 let nounwind = llvm::AttributeKind::NoUnwind.create_attr(self.llcx);
1147 attributes::apply_to_llfn(llfn, llvm::AttributePlace::Function, &[nounwind]);
1148 (fn_ty, llfn)
1149 }
1150 "__rust_retag_mem" => {
1155 let fn_ty = self.type_func(type_params, self.type_void());
1156 let llfn = self.declare_cfn(base_name, llvm::UnnamedAddr::No, fn_ty);
1157 let nounwind = llvm::AttributeKind::NoUnwind.create_attr(self.llcx);
1158 attributes::apply_to_llfn(llfn, llvm::AttributePlace::Function, &[nounwind]);
1159 (fn_ty, llfn)
1160 }
1161 _ => {
1162 let intrinsic = llvm::Intrinsic::lookup(base_name.as_bytes())
1163 .unwrap_or_else(|| ::rustc_middle::util::bug::bug_fmt(format_args!("Unknown intrinsic: `{0}`",
base_name))bug!("Unknown intrinsic: `{base_name}`"));
1164 let f = intrinsic.get_declaration(self.llmod, &type_params);
1165 (self.get_type_of_global(f), f)
1166 }
1167 }
1168 }
1169}
1170
1171impl CodegenCx<'_, '_> {
1172 pub(crate) fn generate_local_symbol_name(&self, prefix: &str) -> String {
1175 let idx = self.local_gen_sym_counter.get();
1176 self.local_gen_sym_counter.set(idx + 1);
1177 let mut name = String::with_capacity(prefix.len() + 6);
1180 name.push_str(prefix);
1181 name.push('.');
1182 name.push_str(&(idx as u64).to_base(ALPHANUMERIC_ONLY));
1183 name
1184 }
1185
1186 pub(crate) fn generate_global_symbol_name(&self) -> String {
1188 let idx = self.global_gen_sym_counter.get();
1189 self.global_gen_sym_counter.set(idx + 1);
1190
1191 let sym = self.codegen_unit.symbol_name();
1192 let prefix = sym.as_str();
1193 let mut name = String::with_capacity(prefix.len() + 6);
1194 name.push_str(prefix);
1195 name.push('.');
1196 name.push_str(&(idx as u64).to_base(ALPHANUMERIC_ONLY));
1197 name
1198 }
1199}
1200
1201impl<'ll, CX: Borrow<SCx<'ll>>> GenericCx<'ll, CX> {
1202 pub(crate) fn md_node_in_context(&self, md_list: &[&'ll Metadata]) -> &'ll Metadata {
1204 unsafe { llvm::LLVMMDNodeInContext2(self.llcx(), md_list.as_ptr(), md_list.len()) }
1205 }
1206
1207 pub(crate) fn set_metadata<'a>(
1209 &self,
1210 val: &'a Value,
1211 kind_id: MetadataKindId,
1212 md: &'ll Metadata,
1213 ) {
1214 let node = self.get_metadata_value(md);
1215 llvm::LLVMSetMetadata(val, kind_id, node);
1216 }
1217
1218 pub(crate) fn set_metadata_node(
1223 &self,
1224 instruction: &'ll Value,
1225 kind_id: MetadataKindId,
1226 md_list: &[&'ll Metadata],
1227 ) -> &'ll Metadata {
1228 let md = self.md_node_in_context(md_list);
1229 self.set_metadata(instruction, kind_id, md);
1230 md
1231 }
1232
1233 pub(crate) fn module_add_named_metadata_node(
1238 &self,
1239 module: &'ll Module,
1240 kind_name: &CStr,
1241 md_list: &[&'ll Metadata],
1242 ) {
1243 let md = self.md_node_in_context(md_list);
1244 let md_as_val = self.get_metadata_value(md);
1245 unsafe { llvm::LLVMAddNamedMetadataOperand(module, kind_name.as_ptr(), md_as_val) };
1246 }
1247
1248 pub(crate) fn global_add_metadata_node(
1252 &self,
1253 global: &'ll Value,
1254 kind_id: MetadataKindId,
1255 md_list: &[&'ll Metadata],
1256 ) {
1257 let md = self.md_node_in_context(md_list);
1258 unsafe { llvm::LLVMRustGlobalAddMetadata(global, kind_id, md) };
1259 }
1260
1261 pub(crate) fn global_set_metadata_node(
1265 &self,
1266 global: &'ll Value,
1267 kind_id: MetadataKindId,
1268 md_list: &[&'ll Metadata],
1269 ) {
1270 let md = self.md_node_in_context(md_list);
1271 unsafe { llvm::LLVMGlobalSetMetadata(global, kind_id, md) };
1272 }
1273}
1274
1275impl HasDataLayout for CodegenCx<'_, '_> {
1276 #[inline]
1277 fn data_layout(&self) -> &TargetDataLayout {
1278 &self.tcx.data_layout
1279 }
1280}
1281
1282impl HasTargetSpec for CodegenCx<'_, '_> {
1283 #[inline]
1284 fn target_spec(&self) -> &Target {
1285 &self.tcx.sess.target
1286 }
1287}
1288
1289impl<'tcx> ty::layout::HasTyCtxt<'tcx> for CodegenCx<'_, 'tcx> {
1290 #[inline]
1291 fn tcx(&self) -> TyCtxt<'tcx> {
1292 self.tcx
1293 }
1294}
1295
1296impl<'tcx, 'll> HasTypingEnv<'tcx> for CodegenCx<'ll, 'tcx> {
1297 fn typing_env(&self) -> ty::TypingEnv<'tcx> {
1298 ty::TypingEnv::fully_monomorphized()
1299 }
1300}
1301
1302impl<'tcx> LayoutOfHelpers<'tcx> for CodegenCx<'_, 'tcx> {
1303 #[inline]
1304 fn handle_layout_err(&self, err: LayoutError<'tcx>, span: Span, ty: Ty<'tcx>) -> ! {
1305 if let LayoutError::SizeOverflow(_)
1306 | LayoutError::ReferencesError(_)
1307 | LayoutError::InvalidSimd { .. } = err
1308 {
1309 self.tcx.dcx().span_fatal(span, err.to_string())
1310 } else {
1311 self.tcx.dcx().emit_fatal(ssa_errors::FailedToGetLayout { span, ty, err })
1312 }
1313 }
1314}
1315
1316impl<'tcx> FnAbiOfHelpers<'tcx> for CodegenCx<'_, 'tcx> {
1317 #[inline]
1318 fn handle_fn_abi_err(
1319 &self,
1320 err: FnAbiError<'tcx>,
1321 span: Span,
1322 fn_abi_request: FnAbiRequest<'tcx>,
1323 ) -> ! {
1324 match err {
1325 FnAbiError::Layout(LayoutError::SizeOverflow(_) | LayoutError::InvalidSimd { .. }) => {
1326 self.tcx.dcx().emit_fatal(Spanned { span, node: err });
1327 }
1328 _ => match fn_abi_request {
1329 FnAbiRequest::OfFnPtr { sig, extra_args } => {
1330 ::rustc_middle::util::bug::span_bug_fmt(span,
format_args!("`fn_abi_of_fn_ptr({0}, {1:?})` failed: {2:?}", sig,
extra_args, err));span_bug!(span, "`fn_abi_of_fn_ptr({sig}, {extra_args:?})` failed: {err:?}",);
1331 }
1332 FnAbiRequest::OfInstance { instance, extra_args } => {
1333 ::rustc_middle::util::bug::span_bug_fmt(span,
format_args!("`fn_abi_of_instance({0}, {1:?})` failed: {2:?}", instance,
extra_args, err));span_bug!(
1334 span,
1335 "`fn_abi_of_instance({instance}, {extra_args:?})` failed: {err:?}",
1336 );
1337 }
1338 },
1339 }
1340 }
1341}