1 use self::RecursiveTypeDescription::*;
2 use self::MemberDescriptionFactory::*;
3 use self::EnumDiscriminantInfo::*;
5 use super::utils::{debug_context, DIB, span_start,
6 get_namespace_for_item, create_DIArray, is_node_local_to_unit};
7 use super::namespace::mangled_name_of_instance;
8 use super::type_names::compute_debuginfo_type_name;
9 use super::{CrateDebugContext};
11 use crate::value::Value;
12 use rustc_codegen_ssa::traits::*;
15 use crate::llvm::debuginfo::{DIArray, DIType, DIFile, DIScope, DIDescriptor,
16 DICompositeType, DILexicalBlock, DIFlags, DebugEmissionKind};
19 use crate::common::CodegenCx;
20 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
21 use rustc::hir::CodegenFnAttrFlags;
22 use rustc::hir::def::CtorKind;
23 use rustc::hir::def_id::{DefId, CrateNum, LOCAL_CRATE};
24 use rustc::ich::NodeIdHashingMode;
25 use rustc::mir::Field;
26 use rustc::mir::GeneratorLayout;
27 use rustc::mir::interpret::truncate;
28 use rustc_data_structures::fingerprint::Fingerprint;
29 use rustc::ty::Instance;
30 use rustc::ty::{self, AdtKind, ParamEnv, Ty, TyCtxt};
31 use rustc::ty::layout::{self, Align, Integer, IntegerExt, LayoutOf,
32 PrimitiveExt, Size, TyLayout, VariantIdx};
33 use rustc::ty::subst::UnpackedKind;
34 use rustc::session::config::{self, DebugInfo};
35 use rustc::util::nodemap::FxHashMap;
36 use rustc_fs_util::path_to_c_string;
37 use rustc_data_structures::small_c_str::SmallCStr;
38 use rustc_target::abi::HasDataLayout;
40 use libc::{c_uint, c_longlong};
41 use std::collections::hash_map::Entry;
42 use std::ffi::CString;
43 use std::fmt::{self, Write};
44 use std::hash::{Hash, Hasher};
47 use std::path::{Path, PathBuf};
49 use syntax::symbol::{Interner, InternedString};
50 use syntax_pos::{self, Span, FileName};
52 impl PartialEq for llvm::Metadata {
53 fn eq(&self, other: &Self) -> bool {
58 impl Eq for llvm::Metadata {}
60 impl Hash for llvm::Metadata {
61 fn hash<H: Hasher>(&self, hasher: &mut H) {
62 (self as *const Self).hash(hasher);
66 impl fmt::Debug for llvm::Metadata {
67 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
68 (self as *const Self).fmt(f)
73 // See http://www.dwarfstd.org/ShowIssue.php?issue=140129.1
74 const DW_LANG_RUST: c_uint = 0x1c;
75 #[allow(non_upper_case_globals)]
76 const DW_ATE_boolean: c_uint = 0x02;
77 #[allow(non_upper_case_globals)]
78 const DW_ATE_float: c_uint = 0x04;
79 #[allow(non_upper_case_globals)]
80 const DW_ATE_signed: c_uint = 0x05;
81 #[allow(non_upper_case_globals)]
82 const DW_ATE_unsigned: c_uint = 0x07;
83 #[allow(non_upper_case_globals)]
84 const DW_ATE_unsigned_char: c_uint = 0x08;
86 pub const UNKNOWN_LINE_NUMBER: c_uint = 0;
87 pub const UNKNOWN_COLUMN_NUMBER: c_uint = 0;
89 pub const NO_SCOPE_METADATA: Option<&DIScope> = None;
91 #[derive(Copy, Debug, Hash, Eq, PartialEq, Clone)]
92 pub struct UniqueTypeId(ast::Name);
94 // The TypeMap is where the CrateDebugContext holds the type metadata nodes
95 // created so far. The metadata nodes are indexed by UniqueTypeId, and, for
96 // faster lookup, also by Ty. The TypeMap is responsible for creating
99 pub struct TypeMap<'ll, 'tcx> {
100 // The UniqueTypeIds created so far
101 unique_id_interner: Interner,
102 // A map from UniqueTypeId to debuginfo metadata for that type. This is a 1:1 mapping.
103 unique_id_to_metadata: FxHashMap<UniqueTypeId, &'ll DIType>,
104 // A map from types to debuginfo metadata. This is a N:1 mapping.
105 type_to_metadata: FxHashMap<Ty<'tcx>, &'ll DIType>,
106 // A map from types to UniqueTypeId. This is a N:1 mapping.
107 type_to_unique_id: FxHashMap<Ty<'tcx>, UniqueTypeId>
110 impl TypeMap<'ll, 'tcx> {
111 // Adds a Ty to metadata mapping to the TypeMap. The method will fail if
112 // the mapping already exists.
113 fn register_type_with_metadata(
116 metadata: &'ll DIType,
118 if self.type_to_metadata.insert(type_, metadata).is_some() {
119 bug!("Type metadata for Ty '{}' is already in the TypeMap!", type_);
123 // Removes a Ty to metadata mapping
124 // This is useful when computing the metadata for a potentially
125 // recursive type (e.g. a function ptr of the form:
127 // fn foo() -> impl Copy { foo }
129 // This kind of type cannot be properly represented
130 // via LLVM debuginfo. As a workaround,
131 // we register a temporary Ty to metadata mapping
132 // for the function before we compute its actual metadata.
133 // If the metadata computation ends up recursing back to the
134 // original function, it will use the temporary mapping
135 // for the inner self-reference, preventing us from
136 // recursing forever.
138 // This function is used to remove the temporary metadata
139 // mapping after we've computed the actual metadata
144 if self.type_to_metadata.remove(type_).is_none() {
145 bug!("Type metadata Ty '{}' is not in the TypeMap!", type_);
149 // Adds a UniqueTypeId to metadata mapping to the TypeMap. The method will
150 // fail if the mapping already exists.
151 fn register_unique_id_with_metadata(
153 unique_type_id: UniqueTypeId,
154 metadata: &'ll DIType,
156 if self.unique_id_to_metadata.insert(unique_type_id, metadata).is_some() {
157 bug!("Type metadata for unique id '{}' is already in the TypeMap!",
158 self.get_unique_type_id_as_string(unique_type_id));
162 fn find_metadata_for_type(&self, type_: Ty<'tcx>) -> Option<&'ll DIType> {
163 self.type_to_metadata.get(&type_).cloned()
166 fn find_metadata_for_unique_id(&self, unique_type_id: UniqueTypeId) -> Option<&'ll DIType> {
167 self.unique_id_to_metadata.get(&unique_type_id).cloned()
170 // Get the string representation of a UniqueTypeId. This method will fail if
171 // the id is unknown.
172 fn get_unique_type_id_as_string(&self, unique_type_id: UniqueTypeId) -> &str {
173 let UniqueTypeId(interner_key) = unique_type_id;
174 self.unique_id_interner.get(interner_key)
177 // Get the UniqueTypeId for the given type. If the UniqueTypeId for the given
178 // type has been requested before, this is just a table lookup. Otherwise an
179 // ID will be generated and stored for later lookup.
180 fn get_unique_type_id_of_type<'a>(&mut self, cx: &CodegenCx<'a, 'tcx>,
181 type_: Ty<'tcx>) -> UniqueTypeId {
182 // Let's see if we already have something in the cache
183 if let Some(unique_type_id) = self.type_to_unique_id.get(&type_).cloned() {
184 return unique_type_id;
186 // if not, generate one
188 // The hasher we are using to generate the UniqueTypeId. We want
189 // something that provides more than the 64 bits of the DefaultHasher.
190 let mut hasher = StableHasher::<Fingerprint>::new();
191 let mut hcx = cx.tcx.create_stable_hashing_context();
192 let type_ = cx.tcx.erase_regions(&type_);
193 hcx.while_hashing_spans(false, |hcx| {
194 hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
195 type_.hash_stable(hcx, &mut hasher);
198 let unique_type_id = hasher.finish().to_hex();
200 let key = self.unique_id_interner.intern(&unique_type_id);
201 self.type_to_unique_id.insert(type_, UniqueTypeId(key));
203 return UniqueTypeId(key);
206 // Get the UniqueTypeId for an enum variant. Enum variants are not really
207 // types of their own, so they need special handling. We still need a
208 // UniqueTypeId for them, since to debuginfo they *are* real types.
209 fn get_unique_type_id_of_enum_variant<'a>(&mut self,
210 cx: &CodegenCx<'a, 'tcx>,
214 let enum_type_id = self.get_unique_type_id_of_type(cx, enum_type);
215 let enum_variant_type_id = format!("{}::{}",
216 self.get_unique_type_id_as_string(enum_type_id),
218 let interner_key = self.unique_id_interner.intern(&enum_variant_type_id);
219 UniqueTypeId(interner_key)
222 // Get the unique type id string for an enum variant part.
223 // Variant parts are not types and shouldn't really have their own id,
224 // but it makes set_members_of_composite_type() simpler.
225 fn get_unique_type_id_str_of_enum_variant_part<'a>(&mut self,
226 enum_type_id: UniqueTypeId) -> &str {
227 let variant_part_type_id = format!("{}_variant_part",
228 self.get_unique_type_id_as_string(enum_type_id));
229 let interner_key = self.unique_id_interner.intern(&variant_part_type_id);
230 self.unique_id_interner.get(interner_key)
234 // A description of some recursive type. It can either be already finished (as
235 // with FinalMetadata) or it is not yet finished, but contains all information
236 // needed to generate the missing parts of the description. See the
237 // documentation section on Recursive Types at the top of this file for more
239 enum RecursiveTypeDescription<'ll, 'tcx> {
241 unfinished_type: Ty<'tcx>,
242 unique_type_id: UniqueTypeId,
243 metadata_stub: &'ll DICompositeType,
244 member_holding_stub: &'ll DICompositeType,
245 member_description_factory: MemberDescriptionFactory<'ll, 'tcx>,
247 FinalMetadata(&'ll DICompositeType)
250 fn create_and_register_recursive_type_forward_declaration(
251 cx: &CodegenCx<'ll, 'tcx>,
252 unfinished_type: Ty<'tcx>,
253 unique_type_id: UniqueTypeId,
254 metadata_stub: &'ll DICompositeType,
255 member_holding_stub: &'ll DICompositeType,
256 member_description_factory: MemberDescriptionFactory<'ll, 'tcx>,
257 ) -> RecursiveTypeDescription<'ll, 'tcx> {
259 // Insert the stub into the TypeMap in order to allow for recursive references
260 let mut type_map = debug_context(cx).type_map.borrow_mut();
261 type_map.register_unique_id_with_metadata(unique_type_id, metadata_stub);
262 type_map.register_type_with_metadata(unfinished_type, metadata_stub);
269 member_description_factory,
273 impl RecursiveTypeDescription<'ll, 'tcx> {
274 // Finishes up the description of the type in question (mostly by providing
275 // descriptions of the fields of the given type) and returns the final type
277 fn finalize(&self, cx: &CodegenCx<'ll, 'tcx>) -> MetadataCreationResult<'ll> {
279 FinalMetadata(metadata) => MetadataCreationResult::new(metadata, false),
285 ref member_description_factory,
287 // Make sure that we have a forward declaration of the type in
288 // the TypeMap so that recursive references are possible. This
289 // will always be the case if the RecursiveTypeDescription has
290 // been properly created through the
291 // create_and_register_recursive_type_forward_declaration()
294 let type_map = debug_context(cx).type_map.borrow();
295 if type_map.find_metadata_for_unique_id(unique_type_id).is_none() ||
296 type_map.find_metadata_for_type(unfinished_type).is_none() {
297 bug!("Forward declaration of potentially recursive type \
298 '{:?}' was not found in TypeMap!",
303 // ... then create the member descriptions ...
304 let member_descriptions =
305 member_description_factory.create_member_descriptions(cx);
307 // ... and attach them to the stub to complete it.
308 set_members_of_composite_type(cx,
311 member_descriptions);
312 return MetadataCreationResult::new(metadata_stub, true);
318 // Returns from the enclosing function if the type metadata with the given
319 // unique id can be found in the type map
320 macro_rules! return_if_metadata_created_in_meantime {
321 ($cx: expr, $unique_type_id: expr) => (
322 if let Some(metadata) = debug_context($cx).type_map
324 .find_metadata_for_unique_id($unique_type_id)
326 return MetadataCreationResult::new(metadata, true);
331 fn fixed_vec_metadata(
332 cx: &CodegenCx<'ll, 'tcx>,
333 unique_type_id: UniqueTypeId,
334 array_or_slice_type: Ty<'tcx>,
335 element_type: Ty<'tcx>,
337 ) -> MetadataCreationResult<'ll> {
338 let element_type_metadata = type_metadata(cx, element_type, span);
340 return_if_metadata_created_in_meantime!(cx, unique_type_id);
342 let (size, align) = cx.size_and_align_of(array_or_slice_type);
344 let upper_bound = match array_or_slice_type.sty {
345 ty::Array(_, len) => {
346 len.unwrap_usize(cx.tcx) as c_longlong
351 let subrange = unsafe {
352 Some(llvm::LLVMRustDIBuilderGetOrCreateSubrange(DIB(cx), 0, upper_bound))
355 let subscripts = create_DIArray(DIB(cx), &[subrange]);
356 let metadata = unsafe {
357 llvm::LLVMRustDIBuilderCreateArrayType(
361 element_type_metadata,
365 return MetadataCreationResult::new(metadata, false);
368 fn vec_slice_metadata(
369 cx: &CodegenCx<'ll, 'tcx>,
370 slice_ptr_type: Ty<'tcx>,
371 element_type: Ty<'tcx>,
372 unique_type_id: UniqueTypeId,
374 ) -> MetadataCreationResult<'ll> {
375 let data_ptr_type = cx.tcx.mk_imm_ptr(element_type);
377 let data_ptr_metadata = type_metadata(cx, data_ptr_type, span);
379 return_if_metadata_created_in_meantime!(cx, unique_type_id);
381 let slice_type_name = compute_debuginfo_type_name(cx.tcx, slice_ptr_type, true);
383 let (pointer_size, pointer_align) = cx.size_and_align_of(data_ptr_type);
384 let (usize_size, usize_align) = cx.size_and_align_of(cx.tcx.types.usize);
386 let member_descriptions = vec![
388 name: "data_ptr".to_owned(),
389 type_metadata: data_ptr_metadata,
392 align: pointer_align,
393 flags: DIFlags::FlagZero,
397 name: "length".to_owned(),
398 type_metadata: type_metadata(cx, cx.tcx.types.usize, span),
399 offset: pointer_size,
402 flags: DIFlags::FlagZero,
407 let file_metadata = unknown_file_metadata(cx);
409 let metadata = composite_type_metadata(cx,
411 &slice_type_name[..],
417 MetadataCreationResult::new(metadata, false)
420 fn subroutine_type_metadata(
421 cx: &CodegenCx<'ll, 'tcx>,
422 unique_type_id: UniqueTypeId,
423 signature: ty::PolyFnSig<'tcx>,
425 ) -> MetadataCreationResult<'ll> {
426 let signature = cx.tcx.normalize_erasing_late_bound_regions(
427 ty::ParamEnv::reveal_all(),
431 let signature_metadata: Vec<_> = iter::once(
433 match signature.output().sty {
434 ty::Tuple(ref tys) if tys.is_empty() => None,
435 _ => Some(type_metadata(cx, signature.output(), span))
439 signature.inputs().iter().map(|argument_type| {
440 Some(type_metadata(cx, argument_type, span))
444 return_if_metadata_created_in_meantime!(cx, unique_type_id);
446 return MetadataCreationResult::new(
448 llvm::LLVMRustDIBuilderCreateSubroutineType(
450 unknown_file_metadata(cx),
451 create_DIArray(DIB(cx), &signature_metadata[..]))
456 // FIXME(1563) This is all a bit of a hack because 'trait pointer' is an ill-
457 // defined concept. For the case of an actual trait pointer (i.e., Box<Trait>,
458 // &Trait), trait_object_type should be the whole thing (e.g, Box<Trait>) and
459 // trait_type should be the actual trait (e.g., Trait). Where the trait is part
460 // of a DST struct, there is no trait_object_type and the results of this
461 // function will be a little bit weird.
462 fn trait_pointer_metadata(
463 cx: &CodegenCx<'ll, 'tcx>,
464 trait_type: Ty<'tcx>,
465 trait_object_type: Option<Ty<'tcx>>,
466 unique_type_id: UniqueTypeId,
468 // The implementation provided here is a stub. It makes sure that the trait
469 // type is assigned the correct name, size, namespace, and source location.
470 // But it does not describe the trait's methods.
472 let containing_scope = match trait_type.sty {
473 ty::Dynamic(ref data, ..) =>
474 data.principal_def_id().map(|did| get_namespace_for_item(cx, did)),
476 bug!("debuginfo: Unexpected trait-object type in \
477 trait_pointer_metadata(): {:?}",
482 let trait_object_type = trait_object_type.unwrap_or(trait_type);
483 let trait_type_name =
484 compute_debuginfo_type_name(cx.tcx, trait_object_type, false);
486 let file_metadata = unknown_file_metadata(cx);
488 let layout = cx.layout_of(cx.tcx.mk_mut_ptr(trait_type));
490 assert_eq!(abi::FAT_PTR_ADDR, 0);
491 assert_eq!(abi::FAT_PTR_EXTRA, 1);
493 let data_ptr_field = layout.field(cx, 0);
494 let vtable_field = layout.field(cx, 1);
495 let member_descriptions = vec![
497 name: "pointer".to_owned(),
498 type_metadata: type_metadata(cx,
499 cx.tcx.mk_mut_ptr(cx.tcx.types.u8),
500 syntax_pos::DUMMY_SP),
501 offset: layout.fields.offset(0),
502 size: data_ptr_field.size,
503 align: data_ptr_field.align.abi,
504 flags: DIFlags::FlagArtificial,
508 name: "vtable".to_owned(),
509 type_metadata: type_metadata(cx, vtable_field.ty, syntax_pos::DUMMY_SP),
510 offset: layout.fields.offset(1),
511 size: vtable_field.size,
512 align: vtable_field.align.abi,
513 flags: DIFlags::FlagArtificial,
518 composite_type_metadata(cx,
520 &trait_type_name[..],
525 syntax_pos::DUMMY_SP)
528 pub fn type_metadata(
529 cx: &CodegenCx<'ll, 'tcx>,
531 usage_site_span: Span,
533 // Get the unique type id of this type.
534 let unique_type_id = {
535 let mut type_map = debug_context(cx).type_map.borrow_mut();
536 // First, try to find the type in TypeMap. If we have seen it before, we
537 // can exit early here.
538 match type_map.find_metadata_for_type(t) {
543 // The Ty is not in the TypeMap but maybe we have already seen
544 // an equivalent type (e.g., only differing in region arguments).
545 // In order to find out, generate the unique type id and look
547 let unique_type_id = type_map.get_unique_type_id_of_type(cx, t);
548 match type_map.find_metadata_for_unique_id(unique_type_id) {
550 // There is already an equivalent type in the TypeMap.
551 // Register this Ty as an alias in the cache and
552 // return the cached metadata.
553 type_map.register_type_with_metadata(t, metadata);
557 // There really is no type metadata for this type, so
558 // proceed by creating it.
566 debug!("type_metadata: {:?}", t);
568 let ptr_metadata = |ty: Ty<'tcx>| {
571 Ok(vec_slice_metadata(cx, t, typ, unique_type_id, usage_site_span))
574 Ok(vec_slice_metadata(cx, t, cx.tcx.types.u8, unique_type_id, usage_site_span))
577 Ok(MetadataCreationResult::new(
578 trait_pointer_metadata(cx, ty, Some(t), unique_type_id),
582 let pointee_metadata = type_metadata(cx, ty, usage_site_span);
584 if let Some(metadata) = debug_context(cx).type_map
586 .find_metadata_for_unique_id(unique_type_id)
588 return Err(metadata);
591 Ok(MetadataCreationResult::new(pointer_type_metadata(cx, t, pointee_metadata),
597 let MetadataCreationResult { metadata, already_stored_in_typemap } = match t.sty {
604 MetadataCreationResult::new(basic_type_metadata(cx, t), false)
606 ty::Tuple(ref elements) if elements.is_empty() => {
607 MetadataCreationResult::new(basic_type_metadata(cx, t), false)
611 fixed_vec_metadata(cx, unique_type_id, t, typ, usage_site_span)
614 fixed_vec_metadata(cx, unique_type_id, t, cx.tcx.types.i8, usage_site_span)
617 MetadataCreationResult::new(
618 trait_pointer_metadata(cx, t, None, unique_type_id),
622 MetadataCreationResult::new(
623 foreign_type_metadata(cx, t, unique_type_id),
626 ty::RawPtr(ty::TypeAndMut{ty, ..}) |
627 ty::Ref(_, ty, _) => {
628 match ptr_metadata(ty) {
630 Err(metadata) => return metadata,
633 ty::Adt(def, _) if def.is_box() => {
634 match ptr_metadata(t.boxed_ty()) {
636 Err(metadata) => return metadata,
639 ty::FnDef(..) | ty::FnPtr(_) => {
641 if let Some(metadata) = debug_context(cx).type_map
643 .find_metadata_for_unique_id(unique_type_id)
648 // It's possible to create a self-referential
649 // type in Rust by using 'impl trait':
651 // fn foo() -> impl Copy { foo }
653 // See TypeMap::remove_type for more detals
654 // about the workaround
658 // The choice of type here is pretty arbitrary -
659 // anything reading the debuginfo for a recursive
660 // type is going to see *somthing* weird - the only
661 // question is what exactly it will see
662 let (size, align) = cx.size_and_align_of(t);
663 llvm::LLVMRustDIBuilderCreateBasicType(
665 SmallCStr::new("<recur_type>").as_ptr(),
672 let type_map = &debug_context(cx).type_map;
673 type_map.borrow_mut().register_type_with_metadata(t, temp_type);
675 let fn_metadata = subroutine_type_metadata(cx,
678 usage_site_span).metadata;
680 type_map.borrow_mut().remove_type(t);
683 // This is actually a function pointer, so wrap it in pointer DI
684 MetadataCreationResult::new(pointer_type_metadata(cx, t, fn_metadata), false)
687 ty::Closure(def_id, substs) => {
688 let upvar_tys : Vec<_> = substs.upvar_tys(def_id, cx.tcx).collect();
689 prepare_tuple_metadata(cx,
693 usage_site_span).finalize(cx)
695 ty::Generator(def_id, substs, _) => {
696 let upvar_tys : Vec<_> = substs.prefix_tys(def_id, cx.tcx).map(|t| {
697 cx.tcx.normalize_erasing_regions(ParamEnv::reveal_all(), t)
699 prepare_enum_metadata(cx,
704 upvar_tys).finalize(cx)
706 ty::Adt(def, ..) => match def.adt_kind() {
708 prepare_struct_metadata(cx,
711 usage_site_span).finalize(cx)
714 prepare_union_metadata(cx,
717 usage_site_span).finalize(cx)
720 prepare_enum_metadata(cx,
728 ty::Tuple(ref elements) => {
729 let tys: Vec<_> = elements.iter().map(|k| k.expect_ty()).collect();
730 prepare_tuple_metadata(cx,
734 usage_site_span).finalize(cx)
737 bug!("debuginfo: unexpected type in type_metadata: {:?}", t)
742 let mut type_map = debug_context(cx).type_map.borrow_mut();
744 if already_stored_in_typemap {
745 // Also make sure that we already have a TypeMap entry for the unique type id.
746 let metadata_for_uid = match type_map.find_metadata_for_unique_id(unique_type_id) {
747 Some(metadata) => metadata,
749 span_bug!(usage_site_span,
750 "Expected type metadata for unique \
751 type id '{}' to already be in \
752 the debuginfo::TypeMap but it \
754 type_map.get_unique_type_id_as_string(unique_type_id),
759 match type_map.find_metadata_for_type(t) {
761 if metadata != metadata_for_uid {
762 span_bug!(usage_site_span,
763 "Mismatch between Ty and \
764 UniqueTypeId maps in \
765 debuginfo::TypeMap. \
766 UniqueTypeId={}, Ty={}",
767 type_map.get_unique_type_id_as_string(unique_type_id),
772 type_map.register_type_with_metadata(t, metadata);
776 type_map.register_type_with_metadata(t, metadata);
777 type_map.register_unique_id_with_metadata(unique_type_id, metadata);
784 pub fn file_metadata(cx: &CodegenCx<'ll, '_>,
785 file_name: &FileName,
786 defining_crate: CrateNum) -> &'ll DIFile {
787 debug!("file_metadata: file_name: {}, defining_crate: {}",
791 let file_name = Some(file_name.to_string());
792 let directory = if defining_crate == LOCAL_CRATE {
793 Some(cx.sess().working_dir.0.to_string_lossy().to_string())
795 // If the path comes from an upstream crate we assume it has been made
796 // independent of the compiler's working directory one way or another.
799 file_metadata_raw(cx, file_name, directory)
802 pub fn unknown_file_metadata(cx: &CodegenCx<'ll, '_>) -> &'ll DIFile {
803 file_metadata_raw(cx, None, None)
806 fn file_metadata_raw(cx: &CodegenCx<'ll, '_>,
807 file_name: Option<String>,
808 directory: Option<String>)
810 let key = (file_name, directory);
812 match debug_context(cx).created_files.borrow_mut().entry(key) {
813 Entry::Occupied(o) => return o.get(),
814 Entry::Vacant(v) => {
815 let (file_name, directory) = v.key();
816 debug!("file_metadata: file_name: {:?}, directory: {:?}", file_name, directory);
818 let file_name = SmallCStr::new(
819 if let Some(file_name) = file_name { &file_name } else { "<unknown>" });
820 let directory = SmallCStr::new(
821 if let Some(directory) = directory { &directory } else { "" });
823 let file_metadata = unsafe {
824 llvm::LLVMRustDIBuilderCreateFile(DIB(cx),
829 v.insert(file_metadata);
835 fn basic_type_metadata(cx: &CodegenCx<'ll, 'tcx>, t: Ty<'tcx>) -> &'ll DIType {
836 debug!("basic_type_metadata: {:?}", t);
838 let (name, encoding) = match t.sty {
839 ty::Never => ("!", DW_ATE_unsigned),
840 ty::Tuple(ref elements) if elements.is_empty() =>
841 ("()", DW_ATE_unsigned),
842 ty::Bool => ("bool", DW_ATE_boolean),
843 ty::Char => ("char", DW_ATE_unsigned_char),
845 (int_ty.ty_to_string(), DW_ATE_signed)
847 ty::Uint(uint_ty) => {
848 (uint_ty.ty_to_string(), DW_ATE_unsigned)
850 ty::Float(float_ty) => {
851 (float_ty.ty_to_string(), DW_ATE_float)
853 _ => bug!("debuginfo::basic_type_metadata - t is invalid type")
856 let (size, align) = cx.size_and_align_of(t);
857 let name = SmallCStr::new(name);
858 let ty_metadata = unsafe {
859 llvm::LLVMRustDIBuilderCreateBasicType(
870 fn foreign_type_metadata(
871 cx: &CodegenCx<'ll, 'tcx>,
873 unique_type_id: UniqueTypeId,
875 debug!("foreign_type_metadata: {:?}", t);
877 let name = compute_debuginfo_type_name(cx.tcx, t, false);
878 create_struct_stub(cx, t, &name, unique_type_id, NO_SCOPE_METADATA)
881 fn pointer_type_metadata(
882 cx: &CodegenCx<'ll, 'tcx>,
883 pointer_type: Ty<'tcx>,
884 pointee_type_metadata: &'ll DIType,
886 let (pointer_size, pointer_align) = cx.size_and_align_of(pointer_type);
887 let name = compute_debuginfo_type_name(cx.tcx, pointer_type, false);
888 let name = SmallCStr::new(&name);
890 llvm::LLVMRustDIBuilderCreatePointerType(
892 pointee_type_metadata,
894 pointer_align.bits() as u32,
899 pub fn compile_unit_metadata(tcx: TyCtxt<'_, '_, '_>,
900 codegen_unit_name: &str,
901 debug_context: &CrateDebugContext<'ll, '_>)
902 -> &'ll DIDescriptor {
903 let mut name_in_debuginfo = match tcx.sess.local_crate_source_file {
904 Some(ref path) => path.clone(),
905 None => PathBuf::from(&*tcx.crate_name(LOCAL_CRATE).as_str()),
908 // The OSX linker has an idiosyncrasy where it will ignore some debuginfo
909 // if multiple object files with the same DW_AT_name are linked together.
910 // As a workaround we generate unique names for each object file. Those do
911 // not correspond to an actual source file but that should be harmless.
912 if tcx.sess.target.target.options.is_like_osx {
913 name_in_debuginfo.push("@");
914 name_in_debuginfo.push(codegen_unit_name);
917 debug!("compile_unit_metadata: {:?}", name_in_debuginfo);
918 // FIXME(#41252) Remove "clang LLVM" if we can get GDB and LLVM to play nice.
919 let producer = format!("clang LLVM (rustc version {})",
920 (option_env!("CFG_VERSION")).expect("CFG_VERSION"));
922 let name_in_debuginfo = name_in_debuginfo.to_string_lossy();
923 let name_in_debuginfo = SmallCStr::new(&name_in_debuginfo);
924 let work_dir = SmallCStr::new(&tcx.sess.working_dir.0.to_string_lossy());
925 let producer = CString::new(producer).unwrap();
927 let split_name = "\0";
931 // This should actually be
934 // let kind = DebugEmissionKind::from_generic(tcx.sess.opts.debuginfo);
937 // that is, we should set LLVM's emission kind to `LineTablesOnly` if
938 // we are compiling with "limited" debuginfo. However, some of the
939 // existing tools relied on slightly more debuginfo being generated than
940 // would be the case with `LineTablesOnly`, and we did not want to break
941 // these tools in a "drive-by fix", without a good idea or plan about
942 // what limited debuginfo should exactly look like. So for now we keep
943 // the emission kind as `FullDebug`.
945 // See https://github.com/rust-lang/rust/issues/60020 for details.
946 let kind = DebugEmissionKind::FullDebug;
947 assert!(tcx.sess.opts.debuginfo != DebugInfo::None);
950 let file_metadata = llvm::LLVMRustDIBuilderCreateFile(
951 debug_context.builder, name_in_debuginfo.as_ptr(), work_dir.as_ptr());
953 let unit_metadata = llvm::LLVMRustDIBuilderCreateCompileUnit(
954 debug_context.builder,
958 tcx.sess.opts.optimize != config::OptLevel::No,
959 flags.as_ptr() as *const _,
961 split_name.as_ptr() as *const _,
964 if tcx.sess.opts.debugging_opts.profile {
965 let cu_desc_metadata = llvm::LLVMRustMetadataAsValue(debug_context.llcontext,
969 path_to_mdstring(debug_context.llcontext,
970 &tcx.output_filenames(LOCAL_CRATE).with_extension("gcno")),
971 path_to_mdstring(debug_context.llcontext,
972 &tcx.output_filenames(LOCAL_CRATE).with_extension("gcda")),
975 let gcov_metadata = llvm::LLVMMDNodeInContext(debug_context.llcontext,
976 gcov_cu_info.as_ptr(),
977 gcov_cu_info.len() as c_uint);
979 let llvm_gcov_ident = const_cstr!("llvm.gcov");
980 llvm::LLVMAddNamedMetadataOperand(debug_context.llmod,
981 llvm_gcov_ident.as_ptr(),
985 return unit_metadata;
988 fn path_to_mdstring(llcx: &'ll llvm::Context, path: &Path) -> &'ll Value {
989 let path_str = path_to_c_string(path);
991 llvm::LLVMMDStringInContext(llcx,
993 path_str.as_bytes().len() as c_uint)
998 struct MetadataCreationResult<'ll> {
999 metadata: &'ll DIType,
1000 already_stored_in_typemap: bool
1003 impl MetadataCreationResult<'ll> {
1004 fn new(metadata: &'ll DIType, already_stored_in_typemap: bool) -> Self {
1005 MetadataCreationResult {
1007 already_stored_in_typemap,
1012 // Description of a type member, which can either be a regular field (as in
1013 // structs or tuples) or an enum variant.
1015 struct MemberDescription<'ll> {
1017 type_metadata: &'ll DIType,
1022 discriminant: Option<u64>,
1025 impl<'ll> MemberDescription<'ll> {
1026 fn into_metadata(self,
1027 cx: &CodegenCx<'ll, '_>,
1028 composite_type_metadata: &'ll DIScope) -> &'ll DIType {
1029 let member_name = CString::new(self.name).unwrap();
1031 llvm::LLVMRustDIBuilderCreateVariantMemberType(
1033 composite_type_metadata,
1034 member_name.as_ptr(),
1035 unknown_file_metadata(cx),
1036 UNKNOWN_LINE_NUMBER,
1038 self.align.bits() as u32,
1040 match self.discriminant {
1042 Some(value) => Some(cx.const_u64(value)),
1050 // A factory for MemberDescriptions. It produces a list of member descriptions
1051 // for some record-like type. MemberDescriptionFactories are used to defer the
1052 // creation of type member descriptions in order to break cycles arising from
1053 // recursive type definitions.
1054 enum MemberDescriptionFactory<'ll, 'tcx> {
1055 StructMDF(StructMemberDescriptionFactory<'tcx>),
1056 TupleMDF(TupleMemberDescriptionFactory<'tcx>),
1057 EnumMDF(EnumMemberDescriptionFactory<'ll, 'tcx>),
1058 UnionMDF(UnionMemberDescriptionFactory<'tcx>),
1059 VariantMDF(VariantMemberDescriptionFactory<'ll, 'tcx>)
1062 impl MemberDescriptionFactory<'ll, 'tcx> {
1063 fn create_member_descriptions(&self, cx: &CodegenCx<'ll, 'tcx>)
1064 -> Vec<MemberDescription<'ll>> {
1066 StructMDF(ref this) => {
1067 this.create_member_descriptions(cx)
1069 TupleMDF(ref this) => {
1070 this.create_member_descriptions(cx)
1072 EnumMDF(ref this) => {
1073 this.create_member_descriptions(cx)
1075 UnionMDF(ref this) => {
1076 this.create_member_descriptions(cx)
1078 VariantMDF(ref this) => {
1079 this.create_member_descriptions(cx)
1085 //=-----------------------------------------------------------------------------
1087 //=-----------------------------------------------------------------------------
1089 // Creates MemberDescriptions for the fields of a struct
1090 struct StructMemberDescriptionFactory<'tcx> {
1092 variant: &'tcx ty::VariantDef,
1096 impl<'tcx> StructMemberDescriptionFactory<'tcx> {
1097 fn create_member_descriptions(&self, cx: &CodegenCx<'ll, 'tcx>)
1098 -> Vec<MemberDescription<'ll>> {
1099 let layout = cx.layout_of(self.ty);
1100 self.variant.fields.iter().enumerate().map(|(i, f)| {
1101 let name = if self.variant.ctor_kind == CtorKind::Fn {
1106 let field = layout.field(cx, i);
1109 type_metadata: type_metadata(cx, field.ty, self.span),
1110 offset: layout.fields.offset(i),
1112 align: field.align.abi,
1113 flags: DIFlags::FlagZero,
1121 fn prepare_struct_metadata(
1122 cx: &CodegenCx<'ll, 'tcx>,
1123 struct_type: Ty<'tcx>,
1124 unique_type_id: UniqueTypeId,
1126 ) -> RecursiveTypeDescription<'ll, 'tcx> {
1127 let struct_name = compute_debuginfo_type_name(cx.tcx, struct_type, false);
1129 let (struct_def_id, variant) = match struct_type.sty {
1130 ty::Adt(def, _) => (def.did, def.non_enum_variant()),
1131 _ => bug!("prepare_struct_metadata on a non-ADT")
1134 let containing_scope = get_namespace_for_item(cx, struct_def_id);
1136 let struct_metadata_stub = create_struct_stub(cx,
1140 Some(containing_scope));
1142 create_and_register_recursive_type_forward_declaration(
1146 struct_metadata_stub,
1147 struct_metadata_stub,
1148 StructMDF(StructMemberDescriptionFactory {
1156 //=-----------------------------------------------------------------------------
1158 //=-----------------------------------------------------------------------------
1160 // Creates MemberDescriptions for the fields of a tuple
1161 struct TupleMemberDescriptionFactory<'tcx> {
1163 component_types: Vec<Ty<'tcx>>,
1167 impl<'tcx> TupleMemberDescriptionFactory<'tcx> {
1168 fn create_member_descriptions(&self, cx: &CodegenCx<'ll, 'tcx>)
1169 -> Vec<MemberDescription<'ll>> {
1170 let layout = cx.layout_of(self.ty);
1171 self.component_types.iter().enumerate().map(|(i, &component_type)| {
1172 let (size, align) = cx.size_and_align_of(component_type);
1174 name: format!("__{}", i),
1175 type_metadata: type_metadata(cx, component_type, self.span),
1176 offset: layout.fields.offset(i),
1179 flags: DIFlags::FlagZero,
1186 fn prepare_tuple_metadata(
1187 cx: &CodegenCx<'ll, 'tcx>,
1188 tuple_type: Ty<'tcx>,
1189 component_types: &[Ty<'tcx>],
1190 unique_type_id: UniqueTypeId,
1192 ) -> RecursiveTypeDescription<'ll, 'tcx> {
1193 let tuple_name = compute_debuginfo_type_name(cx.tcx, tuple_type, false);
1195 let struct_stub = create_struct_stub(cx,
1201 create_and_register_recursive_type_forward_declaration(
1207 TupleMDF(TupleMemberDescriptionFactory {
1209 component_types: component_types.to_vec(),
1215 //=-----------------------------------------------------------------------------
1217 //=-----------------------------------------------------------------------------
1219 struct UnionMemberDescriptionFactory<'tcx> {
1220 layout: TyLayout<'tcx>,
1221 variant: &'tcx ty::VariantDef,
1225 impl<'tcx> UnionMemberDescriptionFactory<'tcx> {
1226 fn create_member_descriptions(&self, cx: &CodegenCx<'ll, 'tcx>)
1227 -> Vec<MemberDescription<'ll>> {
1228 self.variant.fields.iter().enumerate().map(|(i, f)| {
1229 let field = self.layout.field(cx, i);
1231 name: f.ident.to_string(),
1232 type_metadata: type_metadata(cx, field.ty, self.span),
1235 align: field.align.abi,
1236 flags: DIFlags::FlagZero,
1243 fn prepare_union_metadata(
1244 cx: &CodegenCx<'ll, 'tcx>,
1245 union_type: Ty<'tcx>,
1246 unique_type_id: UniqueTypeId,
1248 ) -> RecursiveTypeDescription<'ll, 'tcx> {
1249 let union_name = compute_debuginfo_type_name(cx.tcx, union_type, false);
1251 let (union_def_id, variant) = match union_type.sty {
1252 ty::Adt(def, _) => (def.did, def.non_enum_variant()),
1253 _ => bug!("prepare_union_metadata on a non-ADT")
1256 let containing_scope = get_namespace_for_item(cx, union_def_id);
1258 let union_metadata_stub = create_union_stub(cx,
1264 create_and_register_recursive_type_forward_declaration(
1268 union_metadata_stub,
1269 union_metadata_stub,
1270 UnionMDF(UnionMemberDescriptionFactory {
1271 layout: cx.layout_of(union_type),
1278 //=-----------------------------------------------------------------------------
1280 //=-----------------------------------------------------------------------------
1282 // DWARF variant support is only available starting in LLVM 8.
1283 // Although the earlier enum debug info output did not work properly
1284 // in all situations, it is better for the time being to continue to
1285 // sometimes emit the old style rather than emit something completely
1286 // useless when rust is compiled against LLVM 6 or older. LLVM 7
1287 // contains an early version of the DWARF variant support, and will
1288 // crash when handling the new debug info format. This function
1289 // decides which representation will be emitted.
1290 fn use_enum_fallback(cx: &CodegenCx<'_, '_>) -> bool {
1291 // On MSVC we have to use the fallback mode, because LLVM doesn't
1292 // lower variant parts to PDB.
1293 return cx.sess().target.target.options.is_like_msvc
1294 // LLVM version 7 did not release with an important bug fix;
1295 // but the required patch is in the LLVM 8. Rust LLVM reports
1297 || llvm_util::get_major_version() < 8;
1300 // Describes the members of an enum value: An enum is described as a union of
1301 // structs in DWARF. This MemberDescriptionFactory provides the description for
1302 // the members of this union; so for every variant of the given enum, this
1303 // factory will produce one MemberDescription (all with no name and a fixed
1304 // offset of zero bytes).
1305 struct EnumMemberDescriptionFactory<'ll, 'tcx> {
1306 enum_type: Ty<'tcx>,
1307 layout: TyLayout<'tcx>,
1308 discriminant_type_metadata: Option<&'ll DIType>,
1309 containing_scope: &'ll DIScope,
1313 impl EnumMemberDescriptionFactory<'ll, 'tcx> {
1314 fn create_member_descriptions(&self, cx: &CodegenCx<'ll, 'tcx>)
1315 -> Vec<MemberDescription<'ll>> {
1316 let variant_info_for = |index: VariantIdx| {
1317 match &self.enum_type.sty {
1318 ty::Adt(adt, _) => VariantInfo::Adt(&adt.variants[index]),
1319 ty::Generator(def_id, substs, _) => {
1320 let generator_layout = cx.tcx.generator_layout(*def_id);
1321 VariantInfo::Generator(*substs, generator_layout, index)
1327 // This will always find the metadata in the type map.
1328 let fallback = use_enum_fallback(cx);
1329 let self_metadata = if fallback {
1330 self.containing_scope
1332 type_metadata(cx, self.enum_type, self.span)
1335 match self.layout.variants {
1336 layout::Variants::Single { index } => {
1337 if let ty::Adt(adt, _) = &self.enum_type.sty {
1338 if adt.variants.is_empty() {
1343 let variant_info = variant_info_for(index);
1344 let (variant_type_metadata, member_description_factory) =
1345 describe_enum_variant(cx,
1352 let member_descriptions =
1353 member_description_factory.create_member_descriptions(cx);
1355 set_members_of_composite_type(cx,
1357 variant_type_metadata,
1358 member_descriptions);
1364 variant_info.variant_name()
1366 type_metadata: variant_type_metadata,
1368 size: self.layout.size,
1369 align: self.layout.align.abi,
1370 flags: DIFlags::FlagZero,
1375 layout::Variants::Multiple {
1376 discr_kind: layout::DiscriminantKind::Tag,
1381 let discriminant_info = if fallback {
1382 RegularDiscriminant {
1383 discr_field: Field::from(discr_index),
1384 discr_type_metadata: self.discriminant_type_metadata.unwrap()
1387 // This doesn't matter in this case.
1390 variants.iter_enumerated().map(|(i, _)| {
1391 let variant = self.layout.for_variant(cx, i);
1392 let variant_info = variant_info_for(i);
1393 let (variant_type_metadata, member_desc_factory) =
1394 describe_enum_variant(cx,
1401 let member_descriptions = member_desc_factory
1402 .create_member_descriptions(cx);
1404 set_members_of_composite_type(cx,
1406 variant_type_metadata,
1407 member_descriptions);
1413 variant_info.variant_name()
1415 type_metadata: variant_type_metadata,
1417 size: self.layout.size,
1418 align: self.layout.align.abi,
1419 flags: DIFlags::FlagZero,
1421 self.layout.ty.discriminant_for_variant(cx.tcx, i).unwrap().val as u64
1426 layout::Variants::Multiple {
1427 discr_kind: layout::DiscriminantKind::Niche {
1437 let variant = self.layout.for_variant(cx, dataful_variant);
1438 // Create a description of the non-null variant
1439 let (variant_type_metadata, member_description_factory) =
1440 describe_enum_variant(cx,
1442 variant_info_for(dataful_variant),
1443 OptimizedDiscriminant,
1444 self.containing_scope,
1447 let variant_member_descriptions =
1448 member_description_factory.create_member_descriptions(cx);
1450 set_members_of_composite_type(cx,
1452 variant_type_metadata,
1453 variant_member_descriptions);
1455 // Encode the information about the null variant in the union
1457 let mut name = String::from("RUST$ENCODED$ENUM$");
1458 // Right now it's not even going to work for `niche_start > 0`,
1459 // and for multiple niche variants it only supports the first.
1460 fn compute_field_path<'a, 'tcx>(cx: &CodegenCx<'a, 'tcx>,
1462 layout: TyLayout<'tcx>,
1465 for i in 0..layout.fields.count() {
1466 let field_offset = layout.fields.offset(i);
1467 if field_offset > offset {
1470 let inner_offset = offset - field_offset;
1471 let field = layout.field(cx, i);
1472 if inner_offset + size <= field.size {
1473 write!(name, "{}$", i).unwrap();
1474 compute_field_path(cx, name, field, inner_offset, size);
1478 compute_field_path(cx, &mut name,
1480 self.layout.fields.offset(discr_index),
1481 self.layout.field(cx, discr_index).size);
1482 variant_info_for(*niche_variants.start()).map_struct_name(|variant_name| {
1483 name.push_str(variant_name);
1486 // Create the (singleton) list of descriptions of union members.
1490 type_metadata: variant_type_metadata,
1493 align: variant.align.abi,
1494 flags: DIFlags::FlagZero,
1499 variants.iter_enumerated().map(|(i, _)| {
1500 let variant = self.layout.for_variant(cx, i);
1501 let variant_info = variant_info_for(i);
1502 let (variant_type_metadata, member_desc_factory) =
1503 describe_enum_variant(cx,
1506 OptimizedDiscriminant,
1510 let member_descriptions = member_desc_factory
1511 .create_member_descriptions(cx);
1513 set_members_of_composite_type(cx,
1515 variant_type_metadata,
1516 member_descriptions);
1518 let niche_value = if i == dataful_variant {
1521 let value = (i.as_u32() as u128)
1522 .wrapping_sub(niche_variants.start().as_u32() as u128)
1523 .wrapping_add(niche_start);
1524 let value = truncate(value, discr.value.size(cx));
1525 // NOTE(eddyb) do *NOT* remove this assert, until
1526 // we pass the full 128-bit value to LLVM, otherwise
1527 // truncation will be silent and remain undetected.
1528 assert_eq!(value as u64 as u128, value);
1533 name: variant_info.variant_name(),
1534 type_metadata: variant_type_metadata,
1536 size: self.layout.size,
1537 align: self.layout.align.abi,
1538 flags: DIFlags::FlagZero,
1539 discriminant: niche_value,
1548 // Creates MemberDescriptions for the fields of a single enum variant.
1549 struct VariantMemberDescriptionFactory<'ll, 'tcx> {
1550 // Cloned from the layout::Struct describing the variant.
1551 offsets: Vec<layout::Size>,
1552 args: Vec<(String, Ty<'tcx>)>,
1553 discriminant_type_metadata: Option<&'ll DIType>,
1557 impl VariantMemberDescriptionFactory<'ll, 'tcx> {
1558 fn create_member_descriptions(&self, cx: &CodegenCx<'ll, 'tcx>)
1559 -> Vec<MemberDescription<'ll>> {
1560 self.args.iter().enumerate().map(|(i, &(ref name, ty))| {
1561 let (size, align) = cx.size_and_align_of(ty);
1563 name: name.to_string(),
1564 type_metadata: if use_enum_fallback(cx) {
1565 match self.discriminant_type_metadata {
1566 // Discriminant is always the first field of our variant
1567 // when using the enum fallback.
1568 Some(metadata) if i == 0 => metadata,
1569 _ => type_metadata(cx, ty, self.span)
1572 type_metadata(cx, ty, self.span)
1574 offset: self.offsets[i],
1577 flags: DIFlags::FlagZero,
1584 #[derive(Copy, Clone)]
1585 enum EnumDiscriminantInfo<'ll> {
1586 RegularDiscriminant{ discr_field: Field, discr_type_metadata: &'ll DIType },
1587 OptimizedDiscriminant,
1591 #[derive(Copy, Clone)]
1592 enum VariantInfo<'tcx> {
1593 Adt(&'tcx ty::VariantDef),
1594 Generator(ty::GeneratorSubsts<'tcx>, &'tcx GeneratorLayout<'tcx>, VariantIdx),
1597 impl<'tcx> VariantInfo<'tcx> {
1598 fn map_struct_name<R>(&self, f: impl FnOnce(&str) -> R) -> R {
1600 VariantInfo::Adt(variant) => f(&variant.ident.as_str()),
1601 VariantInfo::Generator(substs, _, variant_index) =>
1602 f(&substs.variant_name(*variant_index)),
1606 fn variant_name(&self) -> String {
1608 VariantInfo::Adt(variant) => variant.ident.to_string(),
1609 VariantInfo::Generator(_, _, variant_index) => {
1610 // Since GDB currently prints out the raw discriminant along
1611 // with every variant, make each variant name be just the value
1612 // of the discriminant. The struct name for the variant includes
1613 // the actual variant description.
1614 format!("{}", variant_index.as_usize()).to_string()
1619 fn field_name(&self, i: usize) -> String {
1620 let field_name = match self {
1621 VariantInfo::Adt(variant) if variant.ctor_kind != CtorKind::Fn =>
1622 Some(variant.fields[i].ident.to_string()),
1623 VariantInfo::Generator(_, generator_layout, variant_index) => {
1624 let field = generator_layout.variant_fields[*variant_index][i.into()];
1625 let decl = &generator_layout.__local_debuginfo_codegen_only_do_not_use[field];
1626 decl.name.map(|name| name.to_string())
1630 field_name.unwrap_or_else(|| format!("__{}", i))
1634 // Returns a tuple of (1) type_metadata_stub of the variant, (2) a
1635 // MemberDescriptionFactory for producing the descriptions of the
1636 // fields of the variant. This is a rudimentary version of a full
1637 // RecursiveTypeDescription.
1638 fn describe_enum_variant(
1639 cx: &CodegenCx<'ll, 'tcx>,
1640 layout: layout::TyLayout<'tcx>,
1641 variant: VariantInfo<'tcx>,
1642 discriminant_info: EnumDiscriminantInfo<'ll>,
1643 containing_scope: &'ll DIScope,
1645 ) -> (&'ll DICompositeType, MemberDescriptionFactory<'ll, 'tcx>) {
1646 let metadata_stub = variant.map_struct_name(|variant_name| {
1647 let unique_type_id = debug_context(cx).type_map
1649 .get_unique_type_id_of_enum_variant(
1653 create_struct_stub(cx,
1657 Some(containing_scope))
1660 // Build an array of (field name, field type) pairs to be captured in the factory closure.
1661 let (offsets, args) = if use_enum_fallback(cx) {
1662 // If this is not a univariant enum, there is also the discriminant field.
1663 let (discr_offset, discr_arg) = match discriminant_info {
1664 RegularDiscriminant { discr_field, .. } => {
1665 // We have the layout of an enum variant, we need the layout of the outer enum
1666 let enum_layout = cx.layout_of(layout.ty);
1667 let offset = enum_layout.fields.offset(discr_field.as_usize());
1669 "RUST$ENUM$DISR".to_owned(),
1670 enum_layout.field(cx, discr_field.as_usize()).ty);
1671 (Some(offset), Some(args))
1676 discr_offset.into_iter().chain((0..layout.fields.count()).map(|i| {
1677 layout.fields.offset(i)
1679 discr_arg.into_iter().chain((0..layout.fields.count()).map(|i| {
1680 (variant.field_name(i), layout.field(cx, i).ty)
1685 (0..layout.fields.count()).map(|i| {
1686 layout.fields.offset(i)
1688 (0..layout.fields.count()).map(|i| {
1689 (variant.field_name(i), layout.field(cx, i).ty)
1694 let member_description_factory =
1695 VariantMDF(VariantMemberDescriptionFactory {
1698 discriminant_type_metadata: match discriminant_info {
1699 RegularDiscriminant { discr_type_metadata, .. } => {
1700 Some(discr_type_metadata)
1707 (metadata_stub, member_description_factory)
1710 fn prepare_enum_metadata(
1711 cx: &CodegenCx<'ll, 'tcx>,
1712 enum_type: Ty<'tcx>,
1714 unique_type_id: UniqueTypeId,
1716 outer_field_tys: Vec<Ty<'tcx>>,
1717 ) -> RecursiveTypeDescription<'ll, 'tcx> {
1718 let enum_name = compute_debuginfo_type_name(cx.tcx, enum_type, false);
1720 let containing_scope = get_namespace_for_item(cx, enum_def_id);
1721 // FIXME: This should emit actual file metadata for the enum, but we
1722 // currently can't get the necessary information when it comes to types
1723 // imported from other crates. Formerly we violated the ODR when performing
1724 // LTO because we emitted debuginfo for the same type with varying file
1725 // metadata, so as a workaround we pretend that the type comes from
1727 let file_metadata = unknown_file_metadata(cx);
1729 let discriminant_type_metadata = |discr: layout::Primitive| {
1730 let enumerators_metadata: Vec<_> = match enum_type.sty {
1731 ty::Adt(def, _) => def
1732 .discriminants(cx.tcx)
1734 .map(|((_, discr), v)| {
1735 let name = SmallCStr::new(&v.ident.as_str());
1737 Some(llvm::LLVMRustDIBuilderCreateEnumerator(
1740 // FIXME: what if enumeration has i128 discriminant?
1745 ty::Generator(_, substs, _) => substs
1746 .variant_range(enum_def_id, cx.tcx)
1747 .map(|variant_index| {
1748 let name = SmallCStr::new(&substs.variant_name(variant_index));
1750 Some(llvm::LLVMRustDIBuilderCreateEnumerator(
1753 // FIXME: what if enumeration has i128 discriminant?
1754 variant_index.as_usize() as u64))
1761 let disr_type_key = (enum_def_id, discr);
1762 let cached_discriminant_type_metadata = debug_context(cx).created_enum_disr_types
1764 .get(&disr_type_key).cloned();
1765 match cached_discriminant_type_metadata {
1766 Some(discriminant_type_metadata) => discriminant_type_metadata,
1768 let (discriminant_size, discriminant_align) =
1769 (discr.size(cx), discr.align(cx));
1770 let discriminant_base_type_metadata =
1771 type_metadata(cx, discr.to_ty(cx.tcx), syntax_pos::DUMMY_SP);
1773 let discriminant_name = match enum_type.sty {
1774 ty::Adt(..) => SmallCStr::new(&cx.tcx.item_name(enum_def_id).as_str()),
1775 ty::Generator(..) => SmallCStr::new(&enum_name),
1779 let discriminant_type_metadata = unsafe {
1780 llvm::LLVMRustDIBuilderCreateEnumerationType(
1783 discriminant_name.as_ptr(),
1785 UNKNOWN_LINE_NUMBER,
1786 discriminant_size.bits(),
1787 discriminant_align.abi.bits() as u32,
1788 create_DIArray(DIB(cx), &enumerators_metadata),
1789 discriminant_base_type_metadata, true)
1792 debug_context(cx).created_enum_disr_types
1794 .insert(disr_type_key, discriminant_type_metadata);
1796 discriminant_type_metadata
1801 let layout = cx.layout_of(enum_type);
1803 match (&layout.abi, &layout.variants) {
1804 (&layout::Abi::Scalar(_), &layout::Variants::Multiple {
1805 discr_kind: layout::DiscriminantKind::Tag,
1808 }) => return FinalMetadata(discriminant_type_metadata(discr.value)),
1812 let enum_name = SmallCStr::new(&enum_name);
1813 let unique_type_id_str = SmallCStr::new(
1814 debug_context(cx).type_map.borrow().get_unique_type_id_as_string(unique_type_id)
1817 if use_enum_fallback(cx) {
1818 let discriminant_type_metadata = match layout.variants {
1819 layout::Variants::Single { .. } |
1820 layout::Variants::Multiple {
1821 discr_kind: layout::DiscriminantKind::Niche { .. },
1824 layout::Variants::Multiple {
1825 discr_kind: layout::DiscriminantKind::Tag,
1829 Some(discriminant_type_metadata(discr.value))
1833 let enum_metadata = unsafe {
1834 llvm::LLVMRustDIBuilderCreateUnionType(
1839 UNKNOWN_LINE_NUMBER,
1841 layout.align.abi.bits() as u32,
1845 unique_type_id_str.as_ptr())
1848 return create_and_register_recursive_type_forward_declaration(
1854 EnumMDF(EnumMemberDescriptionFactory {
1857 discriminant_type_metadata,
1864 let discriminator_name = match &enum_type.sty {
1865 ty::Generator(..) => Some(SmallCStr::new(&"__state")),
1868 let discriminator_name = discriminator_name.map(|n| n.as_ptr()).unwrap_or(ptr::null_mut());
1869 let discriminator_metadata = match layout.variants {
1870 // A single-variant enum has no discriminant.
1871 layout::Variants::Single { .. } => None,
1873 layout::Variants::Multiple {
1874 discr_kind: layout::DiscriminantKind::Niche { .. },
1879 // Find the integer type of the correct size.
1880 let size = discr.value.size(cx);
1881 let align = discr.value.align(cx);
1883 let discr_type = match discr.value {
1884 layout::Int(t, _) => t,
1885 layout::Float(layout::FloatTy::F32) => Integer::I32,
1886 layout::Float(layout::FloatTy::F64) => Integer::I64,
1887 layout::Pointer => cx.data_layout().ptr_sized_integer(),
1888 }.to_ty(cx.tcx, false);
1890 let discr_metadata = basic_type_metadata(cx, discr_type);
1892 Some(llvm::LLVMRustDIBuilderCreateMemberType(
1897 UNKNOWN_LINE_NUMBER,
1899 align.abi.bits() as u32,
1900 layout.fields.offset(discr_index).bits(),
1901 DIFlags::FlagArtificial,
1906 layout::Variants::Multiple {
1907 discr_kind: layout::DiscriminantKind::Tag,
1912 let discr_type = discr.value.to_ty(cx.tcx);
1913 let (size, align) = cx.size_and_align_of(discr_type);
1915 let discr_metadata = basic_type_metadata(cx, discr_type);
1917 Some(llvm::LLVMRustDIBuilderCreateMemberType(
1922 UNKNOWN_LINE_NUMBER,
1924 align.bits() as u32,
1925 layout.fields.offset(discr_index).bits(),
1926 DIFlags::FlagArtificial,
1932 let mut outer_fields = match layout.variants {
1933 layout::Variants::Single { .. } => vec![],
1934 layout::Variants::Multiple { .. } => {
1935 let tuple_mdf = TupleMemberDescriptionFactory {
1937 component_types: outer_field_tys,
1941 .create_member_descriptions(cx)
1943 .map(|desc| Some(desc.into_metadata(cx, containing_scope)))
1948 let variant_part_unique_type_id_str = SmallCStr::new(
1949 debug_context(cx).type_map
1951 .get_unique_type_id_str_of_enum_variant_part(unique_type_id)
1953 let empty_array = create_DIArray(DIB(cx), &[]);
1954 let variant_part = unsafe {
1955 llvm::LLVMRustDIBuilderCreateVariantPart(
1960 UNKNOWN_LINE_NUMBER,
1962 layout.align.abi.bits() as u32,
1964 discriminator_metadata,
1966 variant_part_unique_type_id_str.as_ptr())
1968 outer_fields.push(Some(variant_part));
1970 // The variant part must be wrapped in a struct according to DWARF.
1971 let type_array = create_DIArray(DIB(cx), &outer_fields);
1972 let struct_wrapper = unsafe {
1973 llvm::LLVMRustDIBuilderCreateStructType(
1975 Some(containing_scope),
1978 UNKNOWN_LINE_NUMBER,
1980 layout.align.abi.bits() as u32,
1986 unique_type_id_str.as_ptr())
1989 return create_and_register_recursive_type_forward_declaration(
1995 EnumMDF(EnumMemberDescriptionFactory {
1998 discriminant_type_metadata: None,
2005 /// Creates debug information for a composite type, that is, anything that
2006 /// results in a LLVM struct.
2008 /// Examples of Rust types to use this are: structs, tuples, boxes, vecs, and enums.
2009 fn composite_type_metadata(
2010 cx: &CodegenCx<'ll, 'tcx>,
2011 composite_type: Ty<'tcx>,
2012 composite_type_name: &str,
2013 composite_type_unique_id: UniqueTypeId,
2014 member_descriptions: Vec<MemberDescription<'ll>>,
2015 containing_scope: Option<&'ll DIScope>,
2017 // Ignore source location information as long as it
2018 // can't be reconstructed for non-local crates.
2019 _file_metadata: &'ll DIFile,
2020 _definition_span: Span,
2021 ) -> &'ll DICompositeType {
2022 // Create the (empty) struct metadata node ...
2023 let composite_type_metadata = create_struct_stub(cx,
2025 composite_type_name,
2026 composite_type_unique_id,
2028 // ... and immediately create and add the member descriptions.
2029 set_members_of_composite_type(cx,
2031 composite_type_metadata,
2032 member_descriptions);
2034 composite_type_metadata
2037 fn set_members_of_composite_type(cx: &CodegenCx<'ll, 'tcx>,
2038 composite_type: Ty<'tcx>,
2039 composite_type_metadata: &'ll DICompositeType,
2040 member_descriptions: Vec<MemberDescription<'ll>>) {
2041 // In some rare cases LLVM metadata uniquing would lead to an existing type
2042 // description being used instead of a new one created in
2043 // create_struct_stub. This would cause a hard to trace assertion in
2044 // DICompositeType::SetTypeArray(). The following check makes sure that we
2045 // get a better error message if this should happen again due to some
2048 let mut composite_types_completed =
2049 debug_context(cx).composite_types_completed.borrow_mut();
2050 if composite_types_completed.contains(&composite_type_metadata) {
2051 bug!("debuginfo::set_members_of_composite_type() - \
2052 Already completed forward declaration re-encountered.");
2054 composite_types_completed.insert(composite_type_metadata);
2058 let member_metadata: Vec<_> = member_descriptions
2060 .map(|desc| Some(desc.into_metadata(cx, composite_type_metadata)))
2063 let type_params = compute_type_parameters(cx, composite_type);
2065 let type_array = create_DIArray(DIB(cx), &member_metadata[..]);
2066 llvm::LLVMRustDICompositeTypeReplaceArrays(
2067 DIB(cx), composite_type_metadata, Some(type_array), type_params);
2071 // Compute the type parameters for a type, if any, for the given
2073 fn compute_type_parameters(cx: &CodegenCx<'ll, 'tcx>, ty: Ty<'tcx>) -> Option<&'ll DIArray> {
2074 if let ty::Adt(def, substs) = ty.sty {
2075 if !substs.types().next().is_none() {
2076 let generics = cx.tcx.generics_of(def.did);
2077 let names = get_parameter_names(cx, generics);
2078 let template_params: Vec<_> = substs.iter().zip(names).filter_map(|(kind, name)| {
2079 if let UnpackedKind::Type(ty) = kind.unpack() {
2080 let actual_type = cx.tcx.normalize_erasing_regions(ParamEnv::reveal_all(), ty);
2081 let actual_type_metadata =
2082 type_metadata(cx, actual_type, syntax_pos::DUMMY_SP);
2083 let name = SmallCStr::new(&name.as_str());
2086 Some(llvm::LLVMRustDIBuilderCreateTemplateTypeParameter(
2090 actual_type_metadata,
2091 unknown_file_metadata(cx),
2101 return Some(create_DIArray(DIB(cx), &template_params[..]));
2104 return Some(create_DIArray(DIB(cx), &[]));
2106 fn get_parameter_names(cx: &CodegenCx<'_, '_>,
2107 generics: &ty::Generics)
2108 -> Vec<InternedString> {
2109 let mut names = generics.parent.map_or(vec![], |def_id| {
2110 get_parameter_names(cx, cx.tcx.generics_of(def_id))
2112 names.extend(generics.params.iter().map(|param| param.name));
2117 // A convenience wrapper around LLVMRustDIBuilderCreateStructType(). Does not do
2118 // any caching, does not add any fields to the struct. This can be done later
2119 // with set_members_of_composite_type().
2120 fn create_struct_stub(
2121 cx: &CodegenCx<'ll, 'tcx>,
2122 struct_type: Ty<'tcx>,
2123 struct_type_name: &str,
2124 unique_type_id: UniqueTypeId,
2125 containing_scope: Option<&'ll DIScope>,
2126 ) -> &'ll DICompositeType {
2127 let (struct_size, struct_align) = cx.size_and_align_of(struct_type);
2129 let name = SmallCStr::new(struct_type_name);
2130 let unique_type_id = SmallCStr::new(
2131 debug_context(cx).type_map.borrow().get_unique_type_id_as_string(unique_type_id)
2133 let metadata_stub = unsafe {
2134 // LLVMRustDIBuilderCreateStructType() wants an empty array. A null
2135 // pointer will lead to hard to trace and debug LLVM assertions
2136 // later on in llvm/lib/IR/Value.cpp.
2137 let empty_array = create_DIArray(DIB(cx), &[]);
2139 llvm::LLVMRustDIBuilderCreateStructType(
2143 unknown_file_metadata(cx),
2144 UNKNOWN_LINE_NUMBER,
2146 struct_align.bits() as u32,
2152 unique_type_id.as_ptr())
2158 fn create_union_stub(
2159 cx: &CodegenCx<'ll, 'tcx>,
2160 union_type: Ty<'tcx>,
2161 union_type_name: &str,
2162 unique_type_id: UniqueTypeId,
2163 containing_scope: &'ll DIScope,
2164 ) -> &'ll DICompositeType {
2165 let (union_size, union_align) = cx.size_and_align_of(union_type);
2167 let name = SmallCStr::new(union_type_name);
2168 let unique_type_id = SmallCStr::new(
2169 debug_context(cx).type_map.borrow().get_unique_type_id_as_string(unique_type_id)
2171 let metadata_stub = unsafe {
2172 // LLVMRustDIBuilderCreateUnionType() wants an empty array. A null
2173 // pointer will lead to hard to trace and debug LLVM assertions
2174 // later on in llvm/lib/IR/Value.cpp.
2175 let empty_array = create_DIArray(DIB(cx), &[]);
2177 llvm::LLVMRustDIBuilderCreateUnionType(
2181 unknown_file_metadata(cx),
2182 UNKNOWN_LINE_NUMBER,
2184 union_align.bits() as u32,
2188 unique_type_id.as_ptr())
2194 /// Creates debug information for the given global variable.
2196 /// Adds the created metadata nodes directly to the crate's IR.
2197 pub fn create_global_var_metadata(
2198 cx: &CodegenCx<'ll, '_>,
2202 if cx.dbg_cx.is_none() {
2207 let attrs = tcx.codegen_fn_attrs(def_id);
2209 if attrs.flags.contains(CodegenFnAttrFlags::NO_DEBUG) {
2213 let no_mangle = attrs.flags.contains(CodegenFnAttrFlags::NO_MANGLE);
2214 // We may want to remove the namespace scope if we're in an extern block, see:
2215 // https://github.com/rust-lang/rust/pull/46457#issuecomment-351750952
2216 let var_scope = get_namespace_for_item(cx, def_id);
2217 let span = tcx.def_span(def_id);
2219 let (file_metadata, line_number) = if !span.is_dummy() {
2220 let loc = span_start(cx, span);
2221 (file_metadata(cx, &loc.file.name, LOCAL_CRATE), loc.line as c_uint)
2223 (unknown_file_metadata(cx), UNKNOWN_LINE_NUMBER)
2226 let is_local_to_unit = is_node_local_to_unit(cx, def_id);
2227 let variable_type = Instance::mono(cx.tcx, def_id).ty(cx.tcx);
2228 let type_metadata = type_metadata(cx, variable_type, span);
2229 let var_name = SmallCStr::new(&tcx.item_name(def_id).as_str());
2230 let linkage_name = if no_mangle {
2233 let linkage_name = mangled_name_of_instance(cx, Instance::mono(tcx, def_id));
2234 Some(SmallCStr::new(&linkage_name.as_str()))
2237 let global_align = cx.align_of(variable_type);
2240 llvm::LLVMRustDIBuilderCreateStaticVariable(DIB(cx),
2243 // If null, linkage_name field is omitted,
2244 // which is what we want for no_mangle statics
2245 linkage_name.as_ref()
2246 .map_or(ptr::null(), |name| name.as_ptr()),
2253 global_align.bytes() as u32,
2258 /// Creates debug information for the given vtable, which is for the
2261 /// Adds the created metadata nodes directly to the crate's IR.
2262 pub fn create_vtable_metadata(
2263 cx: &CodegenCx<'ll, 'tcx>,
2267 if cx.dbg_cx.is_none() {
2271 let type_metadata = type_metadata(cx, ty, syntax_pos::DUMMY_SP);
2274 // LLVMRustDIBuilderCreateStructType() wants an empty array. A null
2275 // pointer will lead to hard to trace and debug LLVM assertions
2276 // later on in llvm/lib/IR/Value.cpp.
2277 let empty_array = create_DIArray(DIB(cx), &[]);
2279 let name = const_cstr!("vtable");
2281 // Create a new one each time. We don't want metadata caching
2282 // here, because each vtable will refer to a unique containing
2284 let vtable_type = llvm::LLVMRustDIBuilderCreateStructType(
2288 unknown_file_metadata(cx),
2289 UNKNOWN_LINE_NUMBER,
2291 cx.tcx.data_layout.pointer_align.abi.bits() as u32,
2292 DIFlags::FlagArtificial,
2296 Some(type_metadata),
2300 llvm::LLVMRustDIBuilderCreateStaticVariable(DIB(cx),
2304 unknown_file_metadata(cx),
2305 UNKNOWN_LINE_NUMBER,
2314 // Creates an "extension" of an existing DIScope into another file.
2315 pub fn extend_scope_to_file(
2316 cx: &CodegenCx<'ll, '_>,
2317 scope_metadata: &'ll DIScope,
2318 file: &syntax_pos::SourceFile,
2319 defining_crate: CrateNum,
2320 ) -> &'ll DILexicalBlock {
2321 let file_metadata = file_metadata(cx, &file.name, defining_crate);
2323 llvm::LLVMRustDIBuilderCreateLexicalBlockFile(