]> git.proxmox.com Git - rustc.git/blob - compiler/rustc_codegen_llvm/src/debuginfo/mod.rs
New upstream version 1.64.0+dfsg1
[rustc.git] / compiler / rustc_codegen_llvm / src / debuginfo / mod.rs
1 #![doc = include_str!("doc.md")]
2
3 use rustc_codegen_ssa::mir::debuginfo::VariableKind::*;
4
5 use self::metadata::{file_metadata, type_di_node};
6 use self::metadata::{UNKNOWN_COLUMN_NUMBER, UNKNOWN_LINE_NUMBER};
7 use self::namespace::mangled_name_of_instance;
8 use self::utils::{create_DIArray, is_node_local_to_unit, DIB};
9
10 use crate::abi::FnAbi;
11 use crate::builder::Builder;
12 use crate::common::CodegenCx;
13 use crate::llvm;
14 use crate::llvm::debuginfo::{
15 DIArray, DIBuilder, DIFile, DIFlags, DILexicalBlock, DILocation, DISPFlags, DIScope, DIType,
16 DIVariable,
17 };
18 use crate::value::Value;
19
20 use rustc_codegen_ssa::debuginfo::type_names;
21 use rustc_codegen_ssa::mir::debuginfo::{DebugScope, FunctionDebugContext, VariableKind};
22 use rustc_codegen_ssa::traits::*;
23 use rustc_data_structures::fx::FxHashMap;
24 use rustc_data_structures::sync::Lrc;
25 use rustc_hir::def_id::{DefId, DefIdMap};
26 use rustc_index::vec::IndexVec;
27 use rustc_middle::mir;
28 use rustc_middle::ty::layout::LayoutOf;
29 use rustc_middle::ty::subst::{GenericArgKind, SubstsRef};
30 use rustc_middle::ty::{self, Instance, ParamEnv, Ty, TypeVisitable};
31 use rustc_session::config::{self, DebugInfo};
32 use rustc_session::Session;
33 use rustc_span::symbol::Symbol;
34 use rustc_span::{self, BytePos, Pos, SourceFile, SourceFileAndLine, SourceFileHash, Span};
35 use rustc_target::abi::Size;
36
37 use libc::c_uint;
38 use smallvec::SmallVec;
39 use std::cell::OnceCell;
40 use std::cell::RefCell;
41 use std::iter;
42 use tracing::debug;
43
44 mod create_scope_map;
45 pub mod gdb;
46 pub mod metadata;
47 mod namespace;
48 mod utils;
49
50 pub use self::create_scope_map::compute_mir_scopes;
51 pub use self::metadata::build_global_var_di_node;
52 pub use self::metadata::extend_scope_to_file;
53
54 #[allow(non_upper_case_globals)]
55 const DW_TAG_auto_variable: c_uint = 0x100;
56 #[allow(non_upper_case_globals)]
57 const DW_TAG_arg_variable: c_uint = 0x101;
58
59 /// A context object for maintaining all state needed by the debuginfo module.
60 pub struct CodegenUnitDebugContext<'ll, 'tcx> {
61 llcontext: &'ll llvm::Context,
62 llmod: &'ll llvm::Module,
63 builder: &'ll mut DIBuilder<'ll>,
64 created_files: RefCell<FxHashMap<Option<(u128, SourceFileHash)>, &'ll DIFile>>,
65
66 type_map: metadata::TypeMap<'ll, 'tcx>,
67 namespace_map: RefCell<DefIdMap<&'ll DIScope>>,
68 recursion_marker_type: OnceCell<&'ll DIType>,
69 }
70
71 impl Drop for CodegenUnitDebugContext<'_, '_> {
72 fn drop(&mut self) {
73 unsafe {
74 llvm::LLVMRustDIBuilderDispose(&mut *(self.builder as *mut _));
75 }
76 }
77 }
78
79 impl<'ll, 'tcx> CodegenUnitDebugContext<'ll, 'tcx> {
80 pub fn new(llmod: &'ll llvm::Module) -> Self {
81 debug!("CodegenUnitDebugContext::new");
82 let builder = unsafe { llvm::LLVMRustDIBuilderCreate(llmod) };
83 // DIBuilder inherits context from the module, so we'd better use the same one
84 let llcontext = unsafe { llvm::LLVMGetModuleContext(llmod) };
85 CodegenUnitDebugContext {
86 llcontext,
87 llmod,
88 builder,
89 created_files: Default::default(),
90 type_map: Default::default(),
91 namespace_map: RefCell::new(Default::default()),
92 recursion_marker_type: OnceCell::new(),
93 }
94 }
95
96 pub fn finalize(&self, sess: &Session) {
97 unsafe {
98 llvm::LLVMRustDIBuilderFinalize(self.builder);
99
100 if !sess.target.is_like_msvc {
101 // Debuginfo generation in LLVM by default uses a higher
102 // version of dwarf than macOS currently understands. We can
103 // instruct LLVM to emit an older version of dwarf, however,
104 // for macOS to understand. For more info see #11352
105 // This can be overridden using --llvm-opts -dwarf-version,N.
106 // Android has the same issue (#22398)
107 let dwarf_version = sess
108 .opts
109 .unstable_opts
110 .dwarf_version
111 .unwrap_or(sess.target.default_dwarf_version);
112 llvm::LLVMRustAddModuleFlag(
113 self.llmod,
114 llvm::LLVMModFlagBehavior::Warning,
115 "Dwarf Version\0".as_ptr().cast(),
116 dwarf_version,
117 );
118 } else {
119 // Indicate that we want CodeView debug information on MSVC
120 llvm::LLVMRustAddModuleFlag(
121 self.llmod,
122 llvm::LLVMModFlagBehavior::Warning,
123 "CodeView\0".as_ptr().cast(),
124 1,
125 )
126 }
127
128 // Prevent bitcode readers from deleting the debug info.
129 let ptr = "Debug Info Version\0".as_ptr();
130 llvm::LLVMRustAddModuleFlag(
131 self.llmod,
132 llvm::LLVMModFlagBehavior::Warning,
133 ptr.cast(),
134 llvm::LLVMRustDebugMetadataVersion(),
135 );
136 }
137 }
138 }
139
140 /// Creates any deferred debug metadata nodes
141 pub fn finalize(cx: &CodegenCx<'_, '_>) {
142 if let Some(dbg_cx) = &cx.dbg_cx {
143 debug!("finalize");
144
145 if gdb::needs_gdb_debug_scripts_section(cx) {
146 // Add a .debug_gdb_scripts section to this compile-unit. This will
147 // cause GDB to try and load the gdb_load_rust_pretty_printers.py file,
148 // which activates the Rust pretty printers for binary this section is
149 // contained in.
150 gdb::get_or_insert_gdb_debug_scripts_section_global(cx);
151 }
152
153 dbg_cx.finalize(cx.sess());
154 }
155 }
156
157 impl<'ll> DebugInfoBuilderMethods for Builder<'_, 'll, '_> {
158 // FIXME(eddyb) find a common convention for all of the debuginfo-related
159 // names (choose between `dbg`, `debug`, `debuginfo`, `debug_info` etc.).
160 fn dbg_var_addr(
161 &mut self,
162 dbg_var: &'ll DIVariable,
163 dbg_loc: &'ll DILocation,
164 variable_alloca: Self::Value,
165 direct_offset: Size,
166 indirect_offsets: &[Size],
167 ) {
168 // Convert the direct and indirect offsets to address ops.
169 // FIXME(eddyb) use `const`s instead of getting the values via FFI,
170 // the values should match the ones in the DWARF standard anyway.
171 let op_deref = || unsafe { llvm::LLVMRustDIBuilderCreateOpDeref() };
172 let op_plus_uconst = || unsafe { llvm::LLVMRustDIBuilderCreateOpPlusUconst() };
173 let mut addr_ops = SmallVec::<[u64; 8]>::new();
174
175 if direct_offset.bytes() > 0 {
176 addr_ops.push(op_plus_uconst());
177 addr_ops.push(direct_offset.bytes() as u64);
178 }
179 for &offset in indirect_offsets {
180 addr_ops.push(op_deref());
181 if offset.bytes() > 0 {
182 addr_ops.push(op_plus_uconst());
183 addr_ops.push(offset.bytes() as u64);
184 }
185 }
186
187 unsafe {
188 // FIXME(eddyb) replace `llvm.dbg.declare` with `llvm.dbg.addr`.
189 llvm::LLVMRustDIBuilderInsertDeclareAtEnd(
190 DIB(self.cx()),
191 variable_alloca,
192 dbg_var,
193 addr_ops.as_ptr(),
194 addr_ops.len() as c_uint,
195 dbg_loc,
196 self.llbb(),
197 );
198 }
199 }
200
201 fn set_dbg_loc(&mut self, dbg_loc: &'ll DILocation) {
202 unsafe {
203 let dbg_loc_as_llval = llvm::LLVMRustMetadataAsValue(self.cx().llcx, dbg_loc);
204 llvm::LLVMSetCurrentDebugLocation(self.llbuilder, dbg_loc_as_llval);
205 }
206 }
207
208 fn insert_reference_to_gdb_debug_scripts_section_global(&mut self) {
209 gdb::insert_reference_to_gdb_debug_scripts_section_global(self)
210 }
211
212 fn set_var_name(&mut self, value: &'ll Value, name: &str) {
213 // Avoid wasting time if LLVM value names aren't even enabled.
214 if self.sess().fewer_names() {
215 return;
216 }
217
218 // Only function parameters and instructions are local to a function,
219 // don't change the name of anything else (e.g. globals).
220 let param_or_inst = unsafe {
221 llvm::LLVMIsAArgument(value).is_some() || llvm::LLVMIsAInstruction(value).is_some()
222 };
223 if !param_or_inst {
224 return;
225 }
226
227 // Avoid replacing the name if it already exists.
228 // While we could combine the names somehow, it'd
229 // get noisy quick, and the usefulness is dubious.
230 if llvm::get_value_name(value).is_empty() {
231 llvm::set_value_name(value, name.as_bytes());
232 }
233 }
234 }
235
236 /// A source code location used to generate debug information.
237 // FIXME(eddyb) rename this to better indicate it's a duplicate of
238 // `rustc_span::Loc` rather than `DILocation`, perhaps by making
239 // `lookup_char_pos` return the right information instead.
240 pub struct DebugLoc {
241 /// Information about the original source file.
242 pub file: Lrc<SourceFile>,
243 /// The (1-based) line number.
244 pub line: u32,
245 /// The (1-based) column number.
246 pub col: u32,
247 }
248
249 impl CodegenCx<'_, '_> {
250 /// Looks up debug source information about a `BytePos`.
251 // FIXME(eddyb) rename this to better indicate it's a duplicate of
252 // `lookup_char_pos` rather than `dbg_loc`, perhaps by making
253 // `lookup_char_pos` return the right information instead.
254 pub fn lookup_debug_loc(&self, pos: BytePos) -> DebugLoc {
255 let (file, line, col) = match self.sess().source_map().lookup_line(pos) {
256 Ok(SourceFileAndLine { sf: file, line }) => {
257 let line_pos = file.line_begin_pos(pos);
258
259 // Use 1-based indexing.
260 let line = (line + 1) as u32;
261 let col = (pos - line_pos).to_u32() + 1;
262
263 (file, line, col)
264 }
265 Err(file) => (file, UNKNOWN_LINE_NUMBER, UNKNOWN_COLUMN_NUMBER),
266 };
267
268 // For MSVC, omit the column number.
269 // Otherwise, emit it. This mimics clang behaviour.
270 // See discussion in https://github.com/rust-lang/rust/issues/42921
271 if self.sess().target.is_like_msvc {
272 DebugLoc { file, line, col: UNKNOWN_COLUMN_NUMBER }
273 } else {
274 DebugLoc { file, line, col }
275 }
276 }
277 }
278
279 impl<'ll, 'tcx> DebugInfoMethods<'tcx> for CodegenCx<'ll, 'tcx> {
280 fn create_function_debug_context(
281 &self,
282 instance: Instance<'tcx>,
283 fn_abi: &FnAbi<'tcx, Ty<'tcx>>,
284 llfn: &'ll Value,
285 mir: &mir::Body<'tcx>,
286 ) -> Option<FunctionDebugContext<&'ll DIScope, &'ll DILocation>> {
287 if self.sess().opts.debuginfo == DebugInfo::None {
288 return None;
289 }
290
291 // Initialize fn debug context (including scopes).
292 let empty_scope = DebugScope {
293 dbg_scope: self.dbg_scope_fn(instance, fn_abi, Some(llfn)),
294 inlined_at: None,
295 file_start_pos: BytePos(0),
296 file_end_pos: BytePos(0),
297 };
298 let mut fn_debug_context =
299 FunctionDebugContext { scopes: IndexVec::from_elem(empty_scope, &mir.source_scopes) };
300
301 // Fill in all the scopes, with the information from the MIR body.
302 compute_mir_scopes(self, instance, mir, &mut fn_debug_context);
303
304 Some(fn_debug_context)
305 }
306
307 fn dbg_scope_fn(
308 &self,
309 instance: Instance<'tcx>,
310 fn_abi: &FnAbi<'tcx, Ty<'tcx>>,
311 maybe_definition_llfn: Option<&'ll Value>,
312 ) -> &'ll DIScope {
313 let tcx = self.tcx;
314
315 let def_id = instance.def_id();
316 let containing_scope = get_containing_scope(self, instance);
317 let span = tcx.def_span(def_id);
318 let loc = self.lookup_debug_loc(span.lo());
319 let file_metadata = file_metadata(self, &loc.file);
320
321 let function_type_metadata = unsafe {
322 let fn_signature = get_function_signature(self, fn_abi);
323 llvm::LLVMRustDIBuilderCreateSubroutineType(DIB(self), fn_signature)
324 };
325
326 let mut name = String::new();
327 type_names::push_item_name(tcx, def_id, false, &mut name);
328
329 // Find the enclosing function, in case this is a closure.
330 let enclosing_fn_def_id = tcx.typeck_root_def_id(def_id);
331
332 // We look up the generics of the enclosing function and truncate the substs
333 // to their length in order to cut off extra stuff that might be in there for
334 // closures or generators.
335 let generics = tcx.generics_of(enclosing_fn_def_id);
336 let substs = instance.substs.truncate_to(tcx, generics);
337
338 type_names::push_generic_params(
339 tcx,
340 tcx.normalize_erasing_regions(ty::ParamEnv::reveal_all(), substs),
341 &mut name,
342 );
343
344 let template_parameters = get_template_parameters(self, generics, substs);
345
346 let linkage_name = &mangled_name_of_instance(self, instance).name;
347 // Omit the linkage_name if it is the same as subprogram name.
348 let linkage_name = if &name == linkage_name { "" } else { linkage_name };
349
350 // FIXME(eddyb) does this need to be separate from `loc.line` for some reason?
351 let scope_line = loc.line;
352
353 let mut flags = DIFlags::FlagPrototyped;
354
355 if fn_abi.ret.layout.abi.is_uninhabited() {
356 flags |= DIFlags::FlagNoReturn;
357 }
358
359 let mut spflags = DISPFlags::SPFlagDefinition;
360 if is_node_local_to_unit(self, def_id) {
361 spflags |= DISPFlags::SPFlagLocalToUnit;
362 }
363 if self.sess().opts.optimize != config::OptLevel::No {
364 spflags |= DISPFlags::SPFlagOptimized;
365 }
366 if let Some((id, _)) = tcx.entry_fn(()) {
367 if id == def_id {
368 spflags |= DISPFlags::SPFlagMainSubprogram;
369 }
370 }
371
372 unsafe {
373 return llvm::LLVMRustDIBuilderCreateFunction(
374 DIB(self),
375 containing_scope,
376 name.as_ptr().cast(),
377 name.len(),
378 linkage_name.as_ptr().cast(),
379 linkage_name.len(),
380 file_metadata,
381 loc.line,
382 function_type_metadata,
383 scope_line,
384 flags,
385 spflags,
386 maybe_definition_llfn,
387 template_parameters,
388 None,
389 );
390 }
391
392 fn get_function_signature<'ll, 'tcx>(
393 cx: &CodegenCx<'ll, 'tcx>,
394 fn_abi: &FnAbi<'tcx, Ty<'tcx>>,
395 ) -> &'ll DIArray {
396 if cx.sess().opts.debuginfo == DebugInfo::Limited {
397 return create_DIArray(DIB(cx), &[]);
398 }
399
400 let mut signature = Vec::with_capacity(fn_abi.args.len() + 1);
401
402 // Return type -- llvm::DIBuilder wants this at index 0
403 signature.push(if fn_abi.ret.is_ignore() {
404 None
405 } else {
406 Some(type_di_node(cx, fn_abi.ret.layout.ty))
407 });
408
409 // Arguments types
410 if cx.sess().target.is_like_msvc {
411 // FIXME(#42800):
412 // There is a bug in MSDIA that leads to a crash when it encounters
413 // a fixed-size array of `u8` or something zero-sized in a
414 // function-type (see #40477).
415 // As a workaround, we replace those fixed-size arrays with a
416 // pointer-type. So a function `fn foo(a: u8, b: [u8; 4])` would
417 // appear as `fn foo(a: u8, b: *const u8)` in debuginfo,
418 // and a function `fn bar(x: [(); 7])` as `fn bar(x: *const ())`.
419 // This transformed type is wrong, but these function types are
420 // already inaccurate due to ABI adjustments (see #42800).
421 signature.extend(fn_abi.args.iter().map(|arg| {
422 let t = arg.layout.ty;
423 let t = match t.kind() {
424 ty::Array(ct, _)
425 if (*ct == cx.tcx.types.u8) || cx.layout_of(*ct).is_zst() =>
426 {
427 cx.tcx.mk_imm_ptr(*ct)
428 }
429 _ => t,
430 };
431 Some(type_di_node(cx, t))
432 }));
433 } else {
434 signature
435 .extend(fn_abi.args.iter().map(|arg| Some(type_di_node(cx, arg.layout.ty))));
436 }
437
438 create_DIArray(DIB(cx), &signature[..])
439 }
440
441 fn get_template_parameters<'ll, 'tcx>(
442 cx: &CodegenCx<'ll, 'tcx>,
443 generics: &ty::Generics,
444 substs: SubstsRef<'tcx>,
445 ) -> &'ll DIArray {
446 if substs.types().next().is_none() {
447 return create_DIArray(DIB(cx), &[]);
448 }
449
450 // Again, only create type information if full debuginfo is enabled
451 let template_params: Vec<_> = if cx.sess().opts.debuginfo == DebugInfo::Full {
452 let names = get_parameter_names(cx, generics);
453 iter::zip(substs, names)
454 .filter_map(|(kind, name)| {
455 if let GenericArgKind::Type(ty) = kind.unpack() {
456 let actual_type =
457 cx.tcx.normalize_erasing_regions(ParamEnv::reveal_all(), ty);
458 let actual_type_metadata = type_di_node(cx, actual_type);
459 let name = name.as_str();
460 Some(unsafe {
461 Some(llvm::LLVMRustDIBuilderCreateTemplateTypeParameter(
462 DIB(cx),
463 None,
464 name.as_ptr().cast(),
465 name.len(),
466 actual_type_metadata,
467 ))
468 })
469 } else {
470 None
471 }
472 })
473 .collect()
474 } else {
475 vec![]
476 };
477
478 create_DIArray(DIB(cx), &template_params)
479 }
480
481 fn get_parameter_names(cx: &CodegenCx<'_, '_>, generics: &ty::Generics) -> Vec<Symbol> {
482 let mut names = generics.parent.map_or_else(Vec::new, |def_id| {
483 get_parameter_names(cx, cx.tcx.generics_of(def_id))
484 });
485 names.extend(generics.params.iter().map(|param| param.name));
486 names
487 }
488
489 fn get_containing_scope<'ll, 'tcx>(
490 cx: &CodegenCx<'ll, 'tcx>,
491 instance: Instance<'tcx>,
492 ) -> &'ll DIScope {
493 // First, let's see if this is a method within an inherent impl. Because
494 // if yes, we want to make the result subroutine DIE a child of the
495 // subroutine's self-type.
496 let self_type = cx.tcx.impl_of_method(instance.def_id()).and_then(|impl_def_id| {
497 // If the method does *not* belong to a trait, proceed
498 if cx.tcx.trait_id_of_impl(impl_def_id).is_none() {
499 let impl_self_ty = cx.tcx.subst_and_normalize_erasing_regions(
500 instance.substs,
501 ty::ParamEnv::reveal_all(),
502 cx.tcx.type_of(impl_def_id),
503 );
504
505 // Only "class" methods are generally understood by LLVM,
506 // so avoid methods on other types (e.g., `<*mut T>::null`).
507 match impl_self_ty.kind() {
508 ty::Adt(def, ..) if !def.is_box() => {
509 // Again, only create type information if full debuginfo is enabled
510 if cx.sess().opts.debuginfo == DebugInfo::Full
511 && !impl_self_ty.needs_subst()
512 {
513 Some(type_di_node(cx, impl_self_ty))
514 } else {
515 Some(namespace::item_namespace(cx, def.did()))
516 }
517 }
518 _ => None,
519 }
520 } else {
521 // For trait method impls we still use the "parallel namespace"
522 // strategy
523 None
524 }
525 });
526
527 self_type.unwrap_or_else(|| {
528 namespace::item_namespace(
529 cx,
530 DefId {
531 krate: instance.def_id().krate,
532 index: cx
533 .tcx
534 .def_key(instance.def_id())
535 .parent
536 .expect("get_containing_scope: missing parent?"),
537 },
538 )
539 })
540 }
541 }
542
543 fn dbg_loc(
544 &self,
545 scope: &'ll DIScope,
546 inlined_at: Option<&'ll DILocation>,
547 span: Span,
548 ) -> &'ll DILocation {
549 let DebugLoc { line, col, .. } = self.lookup_debug_loc(span.lo());
550
551 unsafe { llvm::LLVMRustDIBuilderCreateDebugLocation(line, col, scope, inlined_at) }
552 }
553
554 fn create_vtable_debuginfo(
555 &self,
556 ty: Ty<'tcx>,
557 trait_ref: Option<ty::PolyExistentialTraitRef<'tcx>>,
558 vtable: Self::Value,
559 ) {
560 metadata::create_vtable_di_node(self, ty, trait_ref, vtable)
561 }
562
563 fn extend_scope_to_file(
564 &self,
565 scope_metadata: &'ll DIScope,
566 file: &rustc_span::SourceFile,
567 ) -> &'ll DILexicalBlock {
568 metadata::extend_scope_to_file(self, scope_metadata, file)
569 }
570
571 fn debuginfo_finalize(&self) {
572 finalize(self)
573 }
574
575 // FIXME(eddyb) find a common convention for all of the debuginfo-related
576 // names (choose between `dbg`, `debug`, `debuginfo`, `debug_info` etc.).
577 fn create_dbg_var(
578 &self,
579 variable_name: Symbol,
580 variable_type: Ty<'tcx>,
581 scope_metadata: &'ll DIScope,
582 variable_kind: VariableKind,
583 span: Span,
584 ) -> &'ll DIVariable {
585 let loc = self.lookup_debug_loc(span.lo());
586 let file_metadata = file_metadata(self, &loc.file);
587
588 let type_metadata = type_di_node(self, variable_type);
589
590 let (argument_index, dwarf_tag) = match variable_kind {
591 ArgumentVariable(index) => (index as c_uint, DW_TAG_arg_variable),
592 LocalVariable => (0, DW_TAG_auto_variable),
593 };
594 let align = self.align_of(variable_type);
595
596 let name = variable_name.as_str();
597 unsafe {
598 llvm::LLVMRustDIBuilderCreateVariable(
599 DIB(self),
600 dwarf_tag,
601 scope_metadata,
602 name.as_ptr().cast(),
603 name.len(),
604 file_metadata,
605 loc.line,
606 type_metadata,
607 true,
608 DIFlags::FlagZero,
609 argument_index,
610 align.bytes() as u32,
611 )
612 }
613 }
614 }