1 #![doc = include_str!("doc.md")]
3 use rustc_codegen_ssa
::mir
::debuginfo
::VariableKind
::*;
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}
;
10 use crate::abi
::FnAbi
;
11 use crate::builder
::Builder
;
12 use crate::common
::CodegenCx
;
14 use crate::llvm
::debuginfo
::{
15 DIArray
, DIBuilder
, DIFile
, DIFlags
, DILexicalBlock
, DILocation
, DISPFlags
, DIScope
, DIType
,
18 use crate::value
::Value
;
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
;
38 use smallvec
::SmallVec
;
39 use std
::cell
::OnceCell
;
40 use std
::cell
::RefCell
;
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
;
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;
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
>>,
66 type_map
: metadata
::TypeMap
<'ll
, 'tcx
>,
67 namespace_map
: RefCell
<DefIdMap
<&'ll DIScope
>>,
68 recursion_marker_type
: OnceCell
<&'ll DIType
>,
71 impl Drop
for CodegenUnitDebugContext
<'_
, '_
> {
74 llvm
::LLVMRustDIBuilderDispose(&mut *(self.builder
as *mut _
));
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
{
89 created_files
: Default
::default(),
90 type_map
: Default
::default(),
91 namespace_map
: RefCell
::new(Default
::default()),
92 recursion_marker_type
: OnceCell
::new(),
96 pub fn finalize(&self, sess
: &Session
) {
98 llvm
::LLVMRustDIBuilderFinalize(self.builder
);
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
111 .unwrap_or(sess
.target
.default_dwarf_version
);
112 llvm
::LLVMRustAddModuleFlag(
114 llvm
::LLVMModFlagBehavior
::Warning
,
115 "Dwarf Version\0".as_ptr().cast(),
119 // Indicate that we want CodeView debug information on MSVC
120 llvm
::LLVMRustAddModuleFlag(
122 llvm
::LLVMModFlagBehavior
::Warning
,
123 "CodeView\0".as_ptr().cast(),
128 // Prevent bitcode readers from deleting the debug info.
129 let ptr
= "Debug Info Version\0".as_ptr();
130 llvm
::LLVMRustAddModuleFlag(
132 llvm
::LLVMModFlagBehavior
::Warning
,
134 llvm
::LLVMRustDebugMetadataVersion(),
140 /// Creates any deferred debug metadata nodes
141 pub fn finalize(cx
: &CodegenCx
<'_
, '_
>) {
142 if let Some(dbg_cx
) = &cx
.dbg_cx
{
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
150 gdb
::get_or_insert_gdb_debug_scripts_section_global(cx
);
153 dbg_cx
.finalize(cx
.sess());
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.).
162 dbg_var
: &'ll DIVariable
,
163 dbg_loc
: &'ll DILocation
,
164 variable_alloca
: Self::Value
,
166 indirect_offsets
: &[Size
],
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();
175 if direct_offset
.bytes() > 0 {
176 addr_ops
.push(op_plus_uconst());
177 addr_ops
.push(direct_offset
.bytes() as u64);
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);
188 // FIXME(eddyb) replace `llvm.dbg.declare` with `llvm.dbg.addr`.
189 llvm
::LLVMRustDIBuilderInsertDeclareAtEnd(
194 addr_ops
.len() as c_uint
,
201 fn set_dbg_loc(&mut self, dbg_loc
: &'ll DILocation
) {
203 let dbg_loc_as_llval
= llvm
::LLVMRustMetadataAsValue(self.cx().llcx
, dbg_loc
);
204 llvm
::LLVMSetCurrentDebugLocation(self.llbuilder
, dbg_loc_as_llval
);
208 fn insert_reference_to_gdb_debug_scripts_section_global(&mut self) {
209 gdb
::insert_reference_to_gdb_debug_scripts_section_global(self)
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() {
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()
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());
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.
245 /// The (1-based) column number.
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
);
259 // Use 1-based indexing.
260 let line
= (line
+ 1) as u32;
261 let col
= (pos
- line_pos
).to_u32() + 1;
265 Err(file
) => (file
, UNKNOWN_LINE_NUMBER
, UNKNOWN_COLUMN_NUMBER
),
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 }
274 DebugLoc { file, line, col }
279 impl<'ll
, 'tcx
> DebugInfoMethods
<'tcx
> for CodegenCx
<'ll
, 'tcx
> {
280 fn create_function_debug_context(
282 instance
: Instance
<'tcx
>,
283 fn_abi
: &FnAbi
<'tcx
, Ty
<'tcx
>>,
285 mir
: &mir
::Body
<'tcx
>,
286 ) -> Option
<FunctionDebugContext
<&'ll DIScope
, &'ll DILocation
>> {
287 if self.sess().opts
.debuginfo
== DebugInfo
::None
{
291 // Initialize fn debug context (including scopes).
292 let empty_scope
= DebugScope
{
293 dbg_scope
: self.dbg_scope_fn(instance
, fn_abi
, Some(llfn
)),
295 file_start_pos
: BytePos(0),
296 file_end_pos
: BytePos(0),
298 let mut fn_debug_context
=
299 FunctionDebugContext { scopes: IndexVec::from_elem(empty_scope, &mir.source_scopes) }
;
301 // Fill in all the scopes, with the information from the MIR body.
302 compute_mir_scopes(self, instance
, mir
, &mut fn_debug_context
);
304 Some(fn_debug_context
)
309 instance
: Instance
<'tcx
>,
310 fn_abi
: &FnAbi
<'tcx
, Ty
<'tcx
>>,
311 maybe_definition_llfn
: Option
<&'ll Value
>,
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
);
321 let function_type_metadata
= unsafe {
322 let fn_signature
= get_function_signature(self, fn_abi
);
323 llvm
::LLVMRustDIBuilderCreateSubroutineType(DIB(self), fn_signature
)
326 let mut name
= String
::new();
327 type_names
::push_item_name(tcx
, def_id
, false, &mut name
);
329 // Find the enclosing function, in case this is a closure.
330 let enclosing_fn_def_id
= tcx
.typeck_root_def_id(def_id
);
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
);
338 type_names
::push_generic_params(
340 tcx
.normalize_erasing_regions(ty
::ParamEnv
::reveal_all(), substs
),
344 let template_parameters
= get_template_parameters(self, generics
, substs
);
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 }
;
350 // FIXME(eddyb) does this need to be separate from `loc.line` for some reason?
351 let scope_line
= loc
.line
;
353 let mut flags
= DIFlags
::FlagPrototyped
;
355 if fn_abi
.ret
.layout
.abi
.is_uninhabited() {
356 flags
|= DIFlags
::FlagNoReturn
;
359 let mut spflags
= DISPFlags
::SPFlagDefinition
;
360 if is_node_local_to_unit(self, def_id
) {
361 spflags
|= DISPFlags
::SPFlagLocalToUnit
;
363 if self.sess().opts
.optimize
!= config
::OptLevel
::No
{
364 spflags
|= DISPFlags
::SPFlagOptimized
;
366 if let Some((id
, _
)) = tcx
.entry_fn(()) {
368 spflags
|= DISPFlags
::SPFlagMainSubprogram
;
373 return llvm
::LLVMRustDIBuilderCreateFunction(
376 name
.as_ptr().cast(),
378 linkage_name
.as_ptr().cast(),
382 function_type_metadata
,
386 maybe_definition_llfn
,
392 fn get_function_signature
<'ll
, 'tcx
>(
393 cx
: &CodegenCx
<'ll
, 'tcx
>,
394 fn_abi
: &FnAbi
<'tcx
, Ty
<'tcx
>>,
396 if cx
.sess().opts
.debuginfo
== DebugInfo
::Limited
{
397 return create_DIArray(DIB(cx
), &[]);
400 let mut signature
= Vec
::with_capacity(fn_abi
.args
.len() + 1);
402 // Return type -- llvm::DIBuilder wants this at index 0
403 signature
.push(if fn_abi
.ret
.is_ignore() {
406 Some(type_di_node(cx
, fn_abi
.ret
.layout
.ty
))
410 if cx
.sess().target
.is_like_msvc
{
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() {
425 if (*ct
== cx
.tcx
.types
.u8) || cx
.layout_of(*ct
).is_zst() =>
427 cx
.tcx
.mk_imm_ptr(*ct
)
431 Some(type_di_node(cx
, t
))
435 .extend(fn_abi
.args
.iter().map(|arg
| Some(type_di_node(cx
, arg
.layout
.ty
))));
438 create_DIArray(DIB(cx
), &signature
[..])
441 fn get_template_parameters
<'ll
, 'tcx
>(
442 cx
: &CodegenCx
<'ll
, 'tcx
>,
443 generics
: &ty
::Generics
,
444 substs
: SubstsRef
<'tcx
>,
446 if substs
.types().next().is_none() {
447 return create_DIArray(DIB(cx
), &[]);
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() {
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();
461 Some(llvm
::LLVMRustDIBuilderCreateTemplateTypeParameter(
464 name
.as_ptr().cast(),
466 actual_type_metadata
,
478 create_DIArray(DIB(cx
), &template_params
)
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
))
485 names
.extend(generics
.params
.iter().map(|param
| param
.name
));
489 fn get_containing_scope
<'ll
, 'tcx
>(
490 cx
: &CodegenCx
<'ll
, 'tcx
>,
491 instance
: Instance
<'tcx
>,
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(
501 ty
::ParamEnv
::reveal_all(),
502 cx
.tcx
.type_of(impl_def_id
),
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()
513 Some(type_di_node(cx
, impl_self_ty
))
515 Some(namespace
::item_namespace(cx
, def
.did()))
521 // For trait method impls we still use the "parallel namespace"
527 self_type
.unwrap_or_else(|| {
528 namespace
::item_namespace(
531 krate
: instance
.def_id().krate
,
534 .def_key(instance
.def_id())
536 .expect("get_containing_scope: missing parent?"),
546 inlined_at
: Option
<&'ll DILocation
>,
548 ) -> &'ll DILocation
{
549 let DebugLoc { line, col, .. }
= self.lookup_debug_loc(span
.lo());
551 unsafe { llvm::LLVMRustDIBuilderCreateDebugLocation(line, col, scope, inlined_at) }
554 fn create_vtable_debuginfo(
557 trait_ref
: Option
<ty
::PolyExistentialTraitRef
<'tcx
>>,
560 metadata
::create_vtable_di_node(self, ty
, trait_ref
, vtable
)
563 fn extend_scope_to_file(
565 scope_metadata
: &'ll DIScope
,
566 file
: &rustc_span
::SourceFile
,
567 ) -> &'ll DILexicalBlock
{
568 metadata
::extend_scope_to_file(self, scope_metadata
, file
)
571 fn debuginfo_finalize(&self) {
575 // FIXME(eddyb) find a common convention for all of the debuginfo-related
576 // names (choose between `dbg`, `debug`, `debuginfo`, `debug_info` etc.).
579 variable_name
: Symbol
,
580 variable_type
: Ty
<'tcx
>,
581 scope_metadata
: &'ll DIScope
,
582 variable_kind
: VariableKind
,
584 ) -> &'ll DIVariable
{
585 let loc
= self.lookup_debug_loc(span
.lo());
586 let file_metadata
= file_metadata(self, &loc
.file
);
588 let type_metadata
= type_di_node(self, variable_type
);
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
),
594 let align
= self.align_of(variable_type
);
596 let name
= variable_name
.as_str();
598 llvm
::LLVMRustDIBuilderCreateVariable(
602 name
.as_ptr().cast(),
610 align
.bytes() as u32,