1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 use self::RecursiveTypeDescription
::*;
12 use self::MemberOffset
::*;
13 use self::MemberDescriptionFactory
::*;
14 use self::EnumDiscriminantInfo
::*;
16 use super::utils
::{debug_context
, DIB
, span_start
, bytes_to_bits
, size_and_align_of
,
17 get_namespace_and_span_for_item
, create_DIArray
,
18 fn_should_be_ignored
, is_node_local_to_unit
};
19 use super::namespace
::namespace_for_item
;
20 use super::type_names
::{compute_debuginfo_type_name, push_debuginfo_type_name}
;
21 use super::{declare_local, VariableKind, VariableAccess}
;
23 use llvm
::{self, ValueRef}
;
24 use llvm
::debuginfo
::{DIType, DIFile, DIScope, DIDescriptor, DICompositeType}
;
26 use middle
::def_id
::DefId
;
30 use rustc
::front
::map
as hir_map
;
31 use rustc_front
::hir
::{self, PatKind}
;
32 use trans
::{type_of, adt, machine, monomorphize}
;
33 use trans
::common
::{self, CrateContext, FunctionContext, Block}
;
34 use trans
::_match
::{BindingInfo, TransBindingMode}
;
35 use trans
::type_
::Type
;
36 use middle
::ty
::{self, Ty}
;
37 use session
::config
::{self, FullDebugInfo}
;
38 use util
::nodemap
::FnvHashMap
;
39 use util
::common
::path2cstr
;
41 use libc
::{c_uint, c_longlong}
;
42 use std
::ffi
::CString
;
47 use syntax
::util
::interner
::Interner
;
48 use syntax
::codemap
::Span
;
49 use syntax
::{ast, codemap}
;
50 use syntax
::parse
::token
;
53 const DW_LANG_RUST
: c_uint
= 0x9000;
54 #[allow(non_upper_case_globals)]
55 const DW_ATE_boolean
: c_uint
= 0x02;
56 #[allow(non_upper_case_globals)]
57 const DW_ATE_float
: c_uint
= 0x04;
58 #[allow(non_upper_case_globals)]
59 const DW_ATE_signed
: c_uint
= 0x05;
60 #[allow(non_upper_case_globals)]
61 const DW_ATE_unsigned
: c_uint
= 0x07;
62 #[allow(non_upper_case_globals)]
63 const DW_ATE_unsigned_char
: c_uint
= 0x08;
65 pub const UNKNOWN_LINE_NUMBER
: c_uint
= 0;
66 pub const UNKNOWN_COLUMN_NUMBER
: c_uint
= 0;
68 // ptr::null() doesn't work :(
69 const NO_FILE_METADATA
: DIFile
= (0 as DIFile
);
70 const NO_SCOPE_METADATA
: DIScope
= (0 as DIScope
);
72 const FLAGS_NONE
: c_uint
= 0;
74 #[derive(Copy, Debug, Hash, Eq, PartialEq, Clone)]
75 pub struct UniqueTypeId(ast
::Name
);
77 // The TypeMap is where the CrateDebugContext holds the type metadata nodes
78 // created so far. The metadata nodes are indexed by UniqueTypeId, and, for
79 // faster lookup, also by Ty. The TypeMap is responsible for creating
81 pub struct TypeMap
<'tcx
> {
82 // The UniqueTypeIds created so far
83 unique_id_interner
: Interner
<Rc
<String
>>,
84 // A map from UniqueTypeId to debuginfo metadata for that type. This is a 1:1 mapping.
85 unique_id_to_metadata
: FnvHashMap
<UniqueTypeId
, DIType
>,
86 // A map from types to debuginfo metadata. This is a N:1 mapping.
87 type_to_metadata
: FnvHashMap
<Ty
<'tcx
>, DIType
>,
88 // A map from types to UniqueTypeId. This is a N:1 mapping.
89 type_to_unique_id
: FnvHashMap
<Ty
<'tcx
>, UniqueTypeId
>
92 impl<'tcx
> TypeMap
<'tcx
> {
93 pub fn new() -> TypeMap
<'tcx
> {
95 unique_id_interner
: Interner
::new(),
96 type_to_metadata
: FnvHashMap(),
97 unique_id_to_metadata
: FnvHashMap(),
98 type_to_unique_id
: FnvHashMap(),
102 // Adds a Ty to metadata mapping to the TypeMap. The method will fail if
103 // the mapping already exists.
104 fn register_type_with_metadata
<'a
>(&mut self,
105 cx
: &CrateContext
<'a
, 'tcx
>,
108 if self.type_to_metadata
.insert(type_
, metadata
).is_some() {
109 cx
.sess().bug(&format
!("Type metadata for Ty '{}' is already in the TypeMap!",
114 // Adds a UniqueTypeId to metadata mapping to the TypeMap. The method will
115 // fail if the mapping already exists.
116 fn register_unique_id_with_metadata(&mut self,
118 unique_type_id
: UniqueTypeId
,
120 if self.unique_id_to_metadata
.insert(unique_type_id
, metadata
).is_some() {
121 let unique_type_id_str
= self.get_unique_type_id_as_string(unique_type_id
);
122 cx
.sess().bug(&format
!("Type metadata for unique id '{}' is already in the TypeMap!",
123 &unique_type_id_str
[..]));
127 fn find_metadata_for_type(&self, type_
: Ty
<'tcx
>) -> Option
<DIType
> {
128 self.type_to_metadata
.get(&type_
).cloned()
131 fn find_metadata_for_unique_id(&self, unique_type_id
: UniqueTypeId
) -> Option
<DIType
> {
132 self.unique_id_to_metadata
.get(&unique_type_id
).cloned()
135 // Get the string representation of a UniqueTypeId. This method will fail if
136 // the id is unknown.
137 fn get_unique_type_id_as_string(&self, unique_type_id
: UniqueTypeId
) -> Rc
<String
> {
138 let UniqueTypeId(interner_key
) = unique_type_id
;
139 self.unique_id_interner
.get(interner_key
)
142 // Get the UniqueTypeId for the given type. If the UniqueTypeId for the given
143 // type has been requested before, this is just a table lookup. Otherwise an
144 // ID will be generated and stored for later lookup.
145 fn get_unique_type_id_of_type
<'a
>(&mut self, cx
: &CrateContext
<'a
, 'tcx
>,
146 type_
: Ty
<'tcx
>) -> UniqueTypeId
{
148 // basic type -> {:name of the type:}
149 // tuple -> {tuple_(:param-uid:)*}
150 // struct -> {struct_:svh: / :node-id:_<(:param-uid:),*> }
151 // enum -> {enum_:svh: / :node-id:_<(:param-uid:),*> }
152 // enum variant -> {variant_:variant-name:_:enum-uid:}
153 // reference (&) -> {& :pointee-uid:}
154 // mut reference (&mut) -> {&mut :pointee-uid:}
155 // ptr (*) -> {* :pointee-uid:}
156 // mut ptr (*mut) -> {*mut :pointee-uid:}
157 // unique ptr (box) -> {box :pointee-uid:}
158 // @-ptr (@) -> {@ :pointee-uid:}
159 // sized vec ([T; x]) -> {[:size:] :element-uid:}
160 // unsized vec ([T]) -> {[] :element-uid:}
161 // trait (T) -> {trait_:svh: / :node-id:_<(:param-uid:),*> }
162 // closure -> {<unsafe_> <once_> :store-sigil: |(:param-uid:),* <,_...>| -> \
163 // :return-type-uid: : (:bounds:)*}
164 // function -> {<unsafe_> <abi_> fn( (:param-uid:)* <,_...> ) -> \
165 // :return-type-uid:}
167 match self.type_to_unique_id
.get(&type_
).cloned() {
168 Some(unique_type_id
) => return unique_type_id
,
169 None
=> { /* generate one */}
172 let mut unique_type_id
= String
::with_capacity(256);
173 unique_type_id
.push('
{'
);
182 push_debuginfo_type_name(cx
, type_
, false, &mut unique_type_id
);
184 ty
::TyEnum(def
, substs
) => {
185 unique_type_id
.push_str("enum ");
186 from_def_id_and_substs(self, cx
, def
.did
, substs
, &mut unique_type_id
);
188 ty
::TyStruct(def
, substs
) => {
189 unique_type_id
.push_str("struct ");
190 from_def_id_and_substs(self, cx
, def
.did
, substs
, &mut unique_type_id
);
192 ty
::TyTuple(ref component_types
) if component_types
.is_empty() => {
193 push_debuginfo_type_name(cx
, type_
, false, &mut unique_type_id
);
195 ty
::TyTuple(ref component_types
) => {
196 unique_type_id
.push_str("tuple ");
197 for &component_type
in component_types
{
198 let component_type_id
=
199 self.get_unique_type_id_of_type(cx
, component_type
);
200 let component_type_id
=
201 self.get_unique_type_id_as_string(component_type_id
);
202 unique_type_id
.push_str(&component_type_id
[..]);
205 ty
::TyBox(inner_type
) => {
206 unique_type_id
.push_str("box ");
207 let inner_type_id
= self.get_unique_type_id_of_type(cx
, inner_type
);
208 let inner_type_id
= self.get_unique_type_id_as_string(inner_type_id
);
209 unique_type_id
.push_str(&inner_type_id
[..]);
211 ty
::TyRawPtr(ty
::TypeAndMut { ty: inner_type, mutbl }
) => {
212 unique_type_id
.push('
*'
);
213 if mutbl
== hir
::MutMutable
{
214 unique_type_id
.push_str("mut");
217 let inner_type_id
= self.get_unique_type_id_of_type(cx
, inner_type
);
218 let inner_type_id
= self.get_unique_type_id_as_string(inner_type_id
);
219 unique_type_id
.push_str(&inner_type_id
[..]);
221 ty
::TyRef(_
, ty
::TypeAndMut { ty: inner_type, mutbl }
) => {
222 unique_type_id
.push('
&'
);
223 if mutbl
== hir
::MutMutable
{
224 unique_type_id
.push_str("mut");
227 let inner_type_id
= self.get_unique_type_id_of_type(cx
, inner_type
);
228 let inner_type_id
= self.get_unique_type_id_as_string(inner_type_id
);
229 unique_type_id
.push_str(&inner_type_id
[..]);
231 ty
::TyArray(inner_type
, len
) => {
232 unique_type_id
.push_str(&format
!("[{}]", len
));
234 let inner_type_id
= self.get_unique_type_id_of_type(cx
, inner_type
);
235 let inner_type_id
= self.get_unique_type_id_as_string(inner_type_id
);
236 unique_type_id
.push_str(&inner_type_id
[..]);
238 ty
::TySlice(inner_type
) => {
239 unique_type_id
.push_str("[]");
241 let inner_type_id
= self.get_unique_type_id_of_type(cx
, inner_type
);
242 let inner_type_id
= self.get_unique_type_id_as_string(inner_type_id
);
243 unique_type_id
.push_str(&inner_type_id
[..]);
245 ty
::TyTrait(ref trait_data
) => {
246 unique_type_id
.push_str("trait ");
248 let principal
= cx
.tcx().erase_late_bound_regions(&trait_data
.principal
);
250 from_def_id_and_substs(self,
254 &mut unique_type_id
);
256 ty
::TyBareFn(_
, &ty
::BareFnTy{ unsafety, abi, ref sig }
) => {
257 if unsafety
== hir
::Unsafety
::Unsafe
{
258 unique_type_id
.push_str("unsafe ");
261 unique_type_id
.push_str(abi
.name());
263 unique_type_id
.push_str(" fn(");
265 let sig
= cx
.tcx().erase_late_bound_regions(sig
);
266 let sig
= infer
::normalize_associated_type(cx
.tcx(), &sig
);
268 for ¶meter_type
in &sig
.inputs
{
269 let parameter_type_id
=
270 self.get_unique_type_id_of_type(cx
, parameter_type
);
271 let parameter_type_id
=
272 self.get_unique_type_id_as_string(parameter_type_id
);
273 unique_type_id
.push_str(¶meter_type_id
[..]);
274 unique_type_id
.push('
,'
);
278 unique_type_id
.push_str("...");
281 unique_type_id
.push_str(")->");
283 ty
::FnConverging(ret_ty
) => {
284 let return_type_id
= self.get_unique_type_id_of_type(cx
, ret_ty
);
285 let return_type_id
= self.get_unique_type_id_as_string(return_type_id
);
286 unique_type_id
.push_str(&return_type_id
[..]);
289 unique_type_id
.push_str("!");
293 ty
::TyClosure(_
, ref substs
) if substs
.upvar_tys
.is_empty() => {
294 push_debuginfo_type_name(cx
, type_
, false, &mut unique_type_id
);
296 ty
::TyClosure(_
, ref substs
) => {
297 unique_type_id
.push_str("closure ");
298 for upvar_type
in &substs
.upvar_tys
{
300 self.get_unique_type_id_of_type(cx
, upvar_type
);
302 self.get_unique_type_id_as_string(upvar_type_id
);
303 unique_type_id
.push_str(&upvar_type_id
[..]);
307 cx
.sess().bug(&format
!("get_unique_type_id_of_type() - unexpected type: {:?}",
312 unique_type_id
.push('
}'
);
314 // Trim to size before storing permanently
315 unique_type_id
.shrink_to_fit();
317 let key
= self.unique_id_interner
.intern(Rc
::new(unique_type_id
));
318 self.type_to_unique_id
.insert(type_
, UniqueTypeId(key
));
320 return UniqueTypeId(key
);
322 fn from_def_id_and_substs
<'a
, 'tcx
>(type_map
: &mut TypeMap
<'tcx
>,
323 cx
: &CrateContext
<'a
, 'tcx
>,
325 substs
: &subst
::Substs
<'tcx
>,
326 output
: &mut String
) {
327 // First, find out the 'real' def_id of the type. Items inlined from
328 // other crates have to be mapped back to their source.
329 let source_def_id
= if let Some(node_id
) = cx
.tcx().map
.as_local_node_id(def_id
) {
330 match cx
.external_srcs().borrow().get(&node_id
).cloned() {
331 Some(source_def_id
) => {
332 // The given def_id identifies the inlined copy of a
333 // type definition, let's take the source of the copy.
342 // Get the crate hash as first part of the identifier.
343 let crate_hash
= if source_def_id
.is_local() {
344 cx
.link_meta().crate_hash
.clone()
346 cx
.sess().cstore
.crate_hash(source_def_id
.krate
)
349 output
.push_str(crate_hash
.as_str());
350 output
.push_str("/");
351 output
.push_str(&format
!("{:x}", def_id
.index
.as_usize()));
353 // Maybe check that there is no self type here.
355 let tps
= substs
.types
.get_slice(subst
::TypeSpace
);
359 for &type_parameter
in tps
{
361 type_map
.get_unique_type_id_of_type(cx
, type_parameter
);
363 type_map
.get_unique_type_id_as_string(param_type_id
);
364 output
.push_str(¶m_type_id
[..]);
373 // Get the UniqueTypeId for an enum variant. Enum variants are not really
374 // types of their own, so they need special handling. We still need a
375 // UniqueTypeId for them, since to debuginfo they *are* real types.
376 fn get_unique_type_id_of_enum_variant
<'a
>(&mut self,
377 cx
: &CrateContext
<'a
, 'tcx
>,
381 let enum_type_id
= self.get_unique_type_id_of_type(cx
, enum_type
);
382 let enum_variant_type_id
= format
!("{}::{}",
383 &self.get_unique_type_id_as_string(enum_type_id
),
385 let interner_key
= self.unique_id_interner
.intern(Rc
::new(enum_variant_type_id
));
386 UniqueTypeId(interner_key
)
390 // A description of some recursive type. It can either be already finished (as
391 // with FinalMetadata) or it is not yet finished, but contains all information
392 // needed to generate the missing parts of the description. See the
393 // documentation section on Recursive Types at the top of this file for more
395 enum RecursiveTypeDescription
<'tcx
> {
397 unfinished_type
: Ty
<'tcx
>,
398 unique_type_id
: UniqueTypeId
,
399 metadata_stub
: DICompositeType
,
401 member_description_factory
: MemberDescriptionFactory
<'tcx
>,
403 FinalMetadata(DICompositeType
)
406 fn create_and_register_recursive_type_forward_declaration
<'a
, 'tcx
>(
407 cx
: &CrateContext
<'a
, 'tcx
>,
408 unfinished_type
: Ty
<'tcx
>,
409 unique_type_id
: UniqueTypeId
,
410 metadata_stub
: DICompositeType
,
412 member_description_factory
: MemberDescriptionFactory
<'tcx
>)
413 -> RecursiveTypeDescription
<'tcx
> {
415 // Insert the stub into the TypeMap in order to allow for recursive references
416 let mut type_map
= debug_context(cx
).type_map
.borrow_mut();
417 type_map
.register_unique_id_with_metadata(cx
, unique_type_id
, metadata_stub
);
418 type_map
.register_type_with_metadata(cx
, unfinished_type
, metadata_stub
);
421 unfinished_type
: unfinished_type
,
422 unique_type_id
: unique_type_id
,
423 metadata_stub
: metadata_stub
,
424 llvm_type
: llvm_type
,
425 member_description_factory
: member_description_factory
,
429 impl<'tcx
> RecursiveTypeDescription
<'tcx
> {
430 // Finishes up the description of the type in question (mostly by providing
431 // descriptions of the fields of the given type) and returns the final type
433 fn finalize
<'a
>(&self, cx
: &CrateContext
<'a
, 'tcx
>) -> MetadataCreationResult
{
435 FinalMetadata(metadata
) => MetadataCreationResult
::new(metadata
, false),
441 ref member_description_factory
,
444 // Make sure that we have a forward declaration of the type in
445 // the TypeMap so that recursive references are possible. This
446 // will always be the case if the RecursiveTypeDescription has
447 // been properly created through the
448 // create_and_register_recursive_type_forward_declaration()
451 let type_map
= debug_context(cx
).type_map
.borrow();
452 if type_map
.find_metadata_for_unique_id(unique_type_id
).is_none() ||
453 type_map
.find_metadata_for_type(unfinished_type
).is_none() {
454 cx
.sess().bug(&format
!("Forward declaration of potentially recursive type \
455 '{:?}' was not found in TypeMap!",
461 // ... then create the member descriptions ...
462 let member_descriptions
=
463 member_description_factory
.create_member_descriptions(cx
);
465 // ... and attach them to the stub to complete it.
466 set_members_of_composite_type(cx
,
469 &member_descriptions
[..]);
470 return MetadataCreationResult
::new(metadata_stub
, true);
476 // Returns from the enclosing function if the type metadata with the given
477 // unique id can be found in the type map
478 macro_rules
! return_if_metadata_created_in_meantime
{
479 ($cx
: expr
, $unique_type_id
: expr
) => (
480 match debug_context($cx
).type_map
482 .find_metadata_for_unique_id($unique_type_id
) {
483 Some(metadata
) => return MetadataCreationResult
::new(metadata
, true),
484 None
=> { /* proceed normally */ }
489 fn fixed_vec_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
490 unique_type_id
: UniqueTypeId
,
491 element_type
: Ty
<'tcx
>,
494 -> MetadataCreationResult
{
495 let element_type_metadata
= type_metadata(cx
, element_type
, span
);
497 return_if_metadata_created_in_meantime
!(cx
, unique_type_id
);
499 let element_llvm_type
= type_of
::type_of(cx
, element_type
);
500 let (element_type_size
, element_type_align
) = size_and_align_of(cx
, element_llvm_type
);
502 let (array_size_in_bytes
, upper_bound
) = match len
{
503 Some(len
) => (element_type_size
* len
, len
as c_longlong
),
507 let subrange
= unsafe {
508 llvm
::LLVMDIBuilderGetOrCreateSubrange(DIB(cx
), 0, upper_bound
)
511 let subscripts
= create_DIArray(DIB(cx
), &[subrange
]);
512 let metadata
= unsafe {
513 llvm
::LLVMDIBuilderCreateArrayType(
515 bytes_to_bits(array_size_in_bytes
),
516 bytes_to_bits(element_type_align
),
517 element_type_metadata
,
521 return MetadataCreationResult
::new(metadata
, false);
524 fn vec_slice_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
526 element_type
: Ty
<'tcx
>,
527 unique_type_id
: UniqueTypeId
,
529 -> MetadataCreationResult
{
530 let data_ptr_type
= cx
.tcx().mk_ptr(ty
::TypeAndMut
{
532 mutbl
: hir
::MutImmutable
535 let element_type_metadata
= type_metadata(cx
, data_ptr_type
, span
);
537 return_if_metadata_created_in_meantime
!(cx
, unique_type_id
);
539 let slice_llvm_type
= type_of
::type_of(cx
, vec_type
);
540 let slice_type_name
= compute_debuginfo_type_name(cx
, vec_type
, true);
542 let member_llvm_types
= slice_llvm_type
.field_types();
543 assert
!(slice_layout_is_correct(cx
,
544 &member_llvm_types
[..],
546 let member_descriptions
= [
548 name
: "data_ptr".to_string(),
549 llvm_type
: member_llvm_types
[0],
550 type_metadata
: element_type_metadata
,
551 offset
: ComputedMemberOffset
,
555 name
: "length".to_string(),
556 llvm_type
: member_llvm_types
[1],
557 type_metadata
: type_metadata(cx
, cx
.tcx().types
.usize, span
),
558 offset
: ComputedMemberOffset
,
563 assert
!(member_descriptions
.len() == member_llvm_types
.len());
565 let loc
= span_start(cx
, span
);
566 let file_metadata
= file_metadata(cx
, &loc
.file
.name
);
568 let metadata
= composite_type_metadata(cx
,
570 &slice_type_name
[..],
572 &member_descriptions
,
576 return MetadataCreationResult
::new(metadata
, false);
578 fn slice_layout_is_correct
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
579 member_llvm_types
: &[Type
],
580 element_type
: Ty
<'tcx
>)
582 member_llvm_types
.len() == 2 &&
583 member_llvm_types
[0] == type_of
::type_of(cx
, element_type
).ptr_to() &&
584 member_llvm_types
[1] == cx
.int_type()
588 fn subroutine_type_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
589 unique_type_id
: UniqueTypeId
,
590 signature
: &ty
::PolyFnSig
<'tcx
>,
592 -> MetadataCreationResult
594 let signature
= cx
.tcx().erase_late_bound_regions(signature
);
596 let mut signature_metadata
: Vec
<DIType
> = Vec
::with_capacity(signature
.inputs
.len() + 1);
599 signature_metadata
.push(match signature
.output
{
600 ty
::FnConverging(ret_ty
) => match ret_ty
.sty
{
601 ty
::TyTuple(ref tys
) if tys
.is_empty() => ptr
::null_mut(),
602 _
=> type_metadata(cx
, ret_ty
, span
)
604 ty
::FnDiverging
=> diverging_type_metadata(cx
)
608 for &argument_type
in &signature
.inputs
{
609 signature_metadata
.push(type_metadata(cx
, argument_type
, span
));
612 return_if_metadata_created_in_meantime
!(cx
, unique_type_id
);
614 return MetadataCreationResult
::new(
616 llvm
::LLVMDIBuilderCreateSubroutineType(
619 create_DIArray(DIB(cx
), &signature_metadata
[..]))
624 // FIXME(1563) This is all a bit of a hack because 'trait pointer' is an ill-
625 // defined concept. For the case of an actual trait pointer (i.e., Box<Trait>,
626 // &Trait), trait_object_type should be the whole thing (e.g, Box<Trait>) and
627 // trait_type should be the actual trait (e.g., Trait). Where the trait is part
628 // of a DST struct, there is no trait_object_type and the results of this
629 // function will be a little bit weird.
630 fn trait_pointer_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
631 trait_type
: Ty
<'tcx
>,
632 trait_object_type
: Option
<Ty
<'tcx
>>,
633 unique_type_id
: UniqueTypeId
)
635 // The implementation provided here is a stub. It makes sure that the trait
636 // type is assigned the correct name, size, namespace, and source location.
637 // But it does not describe the trait's methods.
639 let def_id
= match trait_type
.sty
{
640 ty
::TyTrait(ref data
) => data
.principal_def_id(),
642 cx
.sess().bug(&format
!("debuginfo: Unexpected trait-object type in \
643 trait_pointer_metadata(): {:?}",
648 let trait_object_type
= trait_object_type
.unwrap_or(trait_type
);
649 let trait_type_name
=
650 compute_debuginfo_type_name(cx
, trait_object_type
, false);
652 let (containing_scope
, _
) = get_namespace_and_span_for_item(cx
, def_id
);
654 let trait_llvm_type
= type_of
::type_of(cx
, trait_object_type
);
656 composite_type_metadata(cx
,
658 &trait_type_name
[..],
666 pub fn type_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
668 usage_site_span
: Span
)
670 // Get the unique type id of this type.
671 let unique_type_id
= {
672 let mut type_map
= debug_context(cx
).type_map
.borrow_mut();
673 // First, try to find the type in TypeMap. If we have seen it before, we
674 // can exit early here.
675 match type_map
.find_metadata_for_type(t
) {
680 // The Ty is not in the TypeMap but maybe we have already seen
681 // an equivalent type (e.g. only differing in region arguments).
682 // In order to find out, generate the unique type id and look
684 let unique_type_id
= type_map
.get_unique_type_id_of_type(cx
, t
);
685 match type_map
.find_metadata_for_unique_id(unique_type_id
) {
687 // There is already an equivalent type in the TypeMap.
688 // Register this Ty as an alias in the cache and
689 // return the cached metadata.
690 type_map
.register_type_with_metadata(cx
, t
, metadata
);
694 // There really is no type metadata for this type, so
695 // proceed by creating it.
703 debug
!("type_metadata: {:?}", t
);
706 let MetadataCreationResult { metadata, already_stored_in_typemap }
= match *sty
{
712 MetadataCreationResult
::new(basic_type_metadata(cx
, t
), false)
714 ty
::TyTuple(ref elements
) if elements
.is_empty() => {
715 MetadataCreationResult
::new(basic_type_metadata(cx
, t
), false)
717 ty
::TyEnum(def
, _
) => {
718 prepare_enum_metadata(cx
,
722 usage_site_span
).finalize(cx
)
724 ty
::TyArray(typ
, len
) => {
725 fixed_vec_metadata(cx
, unique_type_id
, typ
, Some(len
as u64), usage_site_span
)
727 ty
::TySlice(typ
) => {
728 fixed_vec_metadata(cx
, unique_type_id
, typ
, None
, usage_site_span
)
731 fixed_vec_metadata(cx
, unique_type_id
, cx
.tcx().types
.i8, None
, usage_site_span
)
734 MetadataCreationResult
::new(
735 trait_pointer_metadata(cx
, t
, None
, unique_type_id
),
739 ty
::TyRawPtr(ty
::TypeAndMut{ty, ..}
) |
740 ty
::TyRef(_
, ty
::TypeAndMut{ty, ..}
) => {
742 ty
::TySlice(typ
) => {
743 vec_slice_metadata(cx
, t
, typ
, unique_type_id
, usage_site_span
)
746 vec_slice_metadata(cx
, t
, cx
.tcx().types
.u8, unique_type_id
, usage_site_span
)
749 MetadataCreationResult
::new(
750 trait_pointer_metadata(cx
, ty
, Some(t
), unique_type_id
),
754 let pointee_metadata
= type_metadata(cx
, ty
, usage_site_span
);
756 match debug_context(cx
).type_map
758 .find_metadata_for_unique_id(unique_type_id
) {
759 Some(metadata
) => return metadata
,
760 None
=> { /* proceed normally */ }
763 MetadataCreationResult
::new(pointer_type_metadata(cx
, t
, pointee_metadata
),
768 ty
::TyBareFn(_
, ref barefnty
) => {
769 let fn_metadata
= subroutine_type_metadata(cx
,
772 usage_site_span
).metadata
;
773 match debug_context(cx
).type_map
775 .find_metadata_for_unique_id(unique_type_id
) {
776 Some(metadata
) => return metadata
,
777 None
=> { /* proceed normally */ }
780 // This is actually a function pointer, so wrap it in pointer DI
781 MetadataCreationResult
::new(pointer_type_metadata(cx
, t
, fn_metadata
), false)
784 ty
::TyClosure(_
, ref substs
) => {
785 prepare_tuple_metadata(cx
,
789 usage_site_span
).finalize(cx
)
791 ty
::TyStruct(..) => {
792 prepare_struct_metadata(cx
,
795 usage_site_span
).finalize(cx
)
797 ty
::TyTuple(ref elements
) => {
798 prepare_tuple_metadata(cx
,
802 usage_site_span
).finalize(cx
)
805 cx
.sess().bug(&format
!("debuginfo: unexpected type in type_metadata: {:?}",
811 let mut type_map
= debug_context(cx
).type_map
.borrow_mut();
813 if already_stored_in_typemap
{
814 // Also make sure that we already have a TypeMap entry for the unique type id.
815 let metadata_for_uid
= match type_map
.find_metadata_for_unique_id(unique_type_id
) {
816 Some(metadata
) => metadata
,
818 let unique_type_id_str
=
819 type_map
.get_unique_type_id_as_string(unique_type_id
);
820 let error_message
= format
!("Expected type metadata for unique \
821 type id '{}' to already be in \
822 the debuginfo::TypeMap but it \
824 &unique_type_id_str
[..],
826 cx
.sess().span_bug(usage_site_span
, &error_message
[..]);
830 match type_map
.find_metadata_for_type(t
) {
832 if metadata
!= metadata_for_uid
{
833 let unique_type_id_str
=
834 type_map
.get_unique_type_id_as_string(unique_type_id
);
835 let error_message
= format
!("Mismatch between Ty and \
836 UniqueTypeId maps in \
837 debuginfo::TypeMap. \
838 UniqueTypeId={}, Ty={}",
839 &unique_type_id_str
[..],
841 cx
.sess().span_bug(usage_site_span
, &error_message
[..]);
845 type_map
.register_type_with_metadata(cx
, t
, metadata
);
849 type_map
.register_type_with_metadata(cx
, t
, metadata
);
850 type_map
.register_unique_id_with_metadata(cx
, unique_type_id
, metadata
);
857 pub fn file_metadata(cx
: &CrateContext
, full_path
: &str) -> DIFile
{
858 // FIXME (#9639): This needs to handle non-utf8 paths
859 let work_dir
= cx
.sess().working_dir
.to_str().unwrap();
861 if full_path
.starts_with(work_dir
) {
862 &full_path
[work_dir
.len() + 1..full_path
.len()]
867 file_metadata_(cx
, full_path
, file_name
, &work_dir
)
870 pub fn unknown_file_metadata(cx
: &CrateContext
) -> DIFile
{
871 // Regular filenames should not be empty, so we abuse an empty name as the
872 // key for the special unknown file metadata
873 file_metadata_(cx
, "", "<unknown>", "")
877 fn file_metadata_(cx
: &CrateContext
, key
: &str, file_name
: &str, work_dir
: &str) -> DIFile
{
878 match debug_context(cx
).created_files
.borrow().get(key
) {
879 Some(file_metadata
) => return *file_metadata
,
883 debug
!("file_metadata: file_name: {}, work_dir: {}", file_name
, work_dir
);
885 let file_name
= CString
::new(file_name
).unwrap();
886 let work_dir
= CString
::new(work_dir
).unwrap();
887 let file_metadata
= unsafe {
888 llvm
::LLVMDIBuilderCreateFile(DIB(cx
), file_name
.as_ptr(),
892 let mut created_files
= debug_context(cx
).created_files
.borrow_mut();
893 created_files
.insert(key
.to_string(), file_metadata
);
897 /// Finds the scope metadata node for the given AST node.
898 pub fn scope_metadata(fcx
: &FunctionContext
,
899 node_id
: ast
::NodeId
,
900 error_reporting_span
: Span
)
902 let scope_map
= &fcx
.debug_context
903 .get_ref(fcx
.ccx
, error_reporting_span
)
905 match scope_map
.borrow().get(&node_id
).cloned() {
906 Some(scope_metadata
) => scope_metadata
,
908 let node
= fcx
.ccx
.tcx().map
.get(node_id
);
910 fcx
.ccx
.sess().span_bug(error_reporting_span
,
911 &format
!("debuginfo: Could not find scope info for node {:?}",
917 pub fn diverging_type_metadata(cx
: &CrateContext
) -> DIType
{
919 llvm
::LLVMDIBuilderCreateBasicType(
921 "!\0".as_ptr() as *const _
,
928 fn basic_type_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
929 t
: Ty
<'tcx
>) -> DIType
{
931 debug
!("basic_type_metadata: {:?}", t
);
933 let (name
, encoding
) = match t
.sty
{
934 ty
::TyTuple(ref elements
) if elements
.is_empty() =>
935 ("()", DW_ATE_unsigned
),
936 ty
::TyBool
=> ("bool", DW_ATE_boolean
),
937 ty
::TyChar
=> ("char", DW_ATE_unsigned_char
),
938 ty
::TyInt(int_ty
) => {
939 (int_ty
.ty_to_string(), DW_ATE_signed
)
941 ty
::TyUint(uint_ty
) => {
942 (uint_ty
.ty_to_string(), DW_ATE_unsigned
)
944 ty
::TyFloat(float_ty
) => {
945 (float_ty
.ty_to_string(), DW_ATE_float
)
947 _
=> cx
.sess().bug("debuginfo::basic_type_metadata - t is invalid type")
950 let llvm_type
= type_of
::type_of(cx
, t
);
951 let (size
, align
) = size_and_align_of(cx
, llvm_type
);
952 let name
= CString
::new(name
).unwrap();
953 let ty_metadata
= unsafe {
954 llvm
::LLVMDIBuilderCreateBasicType(
958 bytes_to_bits(align
),
965 fn pointer_type_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
966 pointer_type
: Ty
<'tcx
>,
967 pointee_type_metadata
: DIType
)
969 let pointer_llvm_type
= type_of
::type_of(cx
, pointer_type
);
970 let (pointer_size
, pointer_align
) = size_and_align_of(cx
, pointer_llvm_type
);
971 let name
= compute_debuginfo_type_name(cx
, pointer_type
, false);
972 let name
= CString
::new(name
).unwrap();
973 let ptr_metadata
= unsafe {
974 llvm
::LLVMDIBuilderCreatePointerType(
976 pointee_type_metadata
,
977 bytes_to_bits(pointer_size
),
978 bytes_to_bits(pointer_align
),
984 pub fn compile_unit_metadata(cx
: &CrateContext
) -> DIDescriptor
{
985 let work_dir
= &cx
.sess().working_dir
;
986 let compile_unit_name
= match cx
.sess().local_crate_source_file
{
987 None
=> fallback_path(cx
),
988 Some(ref abs_path
) => {
989 if abs_path
.is_relative() {
990 cx
.sess().warn("debuginfo: Invalid path to crate's local root source file!");
993 match abs_path
.strip_prefix(work_dir
) {
994 Ok(ref p
) if p
.is_relative() => {
995 if p
.starts_with(Path
::new("./")) {
998 path2cstr(&Path
::new(".").join(p
))
1001 _
=> fallback_path(cx
)
1007 debug
!("compile_unit_metadata: {:?}", compile_unit_name
);
1008 let producer
= format
!("rustc version {}",
1009 (option_env
!("CFG_VERSION")).expect("CFG_VERSION"));
1011 let compile_unit_name
= compile_unit_name
.as_ptr();
1012 let work_dir
= path2cstr(&work_dir
);
1013 let producer
= CString
::new(producer
).unwrap();
1015 let split_name
= "\0";
1017 llvm
::LLVMDIBuilderCreateCompileUnit(
1018 debug_context(cx
).builder
,
1023 cx
.sess().opts
.optimize
!= config
::OptLevel
::No
,
1024 flags
.as_ptr() as *const _
,
1026 split_name
.as_ptr() as *const _
)
1029 fn fallback_path(cx
: &CrateContext
) -> CString
{
1030 CString
::new(cx
.link_meta().crate_name
.clone()).unwrap()
1034 struct MetadataCreationResult
{
1036 already_stored_in_typemap
: bool
1039 impl MetadataCreationResult
{
1040 fn new(metadata
: DIType
, already_stored_in_typemap
: bool
) -> MetadataCreationResult
{
1041 MetadataCreationResult
{
1043 already_stored_in_typemap
: already_stored_in_typemap
1050 FixedMemberOffset { bytes: usize }
,
1051 // For ComputedMemberOffset, the offset is read from the llvm type definition.
1052 ComputedMemberOffset
1055 // Description of a type member, which can either be a regular field (as in
1056 // structs or tuples) or an enum variant.
1058 struct MemberDescription
{
1061 type_metadata
: DIType
,
1062 offset
: MemberOffset
,
1066 // A factory for MemberDescriptions. It produces a list of member descriptions
1067 // for some record-like type. MemberDescriptionFactories are used to defer the
1068 // creation of type member descriptions in order to break cycles arising from
1069 // recursive type definitions.
1070 enum MemberDescriptionFactory
<'tcx
> {
1071 StructMDF(StructMemberDescriptionFactory
<'tcx
>),
1072 TupleMDF(TupleMemberDescriptionFactory
<'tcx
>),
1073 EnumMDF(EnumMemberDescriptionFactory
<'tcx
>),
1074 VariantMDF(VariantMemberDescriptionFactory
<'tcx
>)
1077 impl<'tcx
> MemberDescriptionFactory
<'tcx
> {
1078 fn create_member_descriptions
<'a
>(&self, cx
: &CrateContext
<'a
, 'tcx
>)
1079 -> Vec
<MemberDescription
> {
1081 StructMDF(ref this
) => {
1082 this
.create_member_descriptions(cx
)
1084 TupleMDF(ref this
) => {
1085 this
.create_member_descriptions(cx
)
1087 EnumMDF(ref this
) => {
1088 this
.create_member_descriptions(cx
)
1090 VariantMDF(ref this
) => {
1091 this
.create_member_descriptions(cx
)
1097 //=-----------------------------------------------------------------------------
1099 //=-----------------------------------------------------------------------------
1101 // Creates MemberDescriptions for the fields of a struct
1102 struct StructMemberDescriptionFactory
<'tcx
> {
1103 variant
: ty
::VariantDef
<'tcx
>,
1104 substs
: &'tcx subst
::Substs
<'tcx
>,
1109 impl<'tcx
> StructMemberDescriptionFactory
<'tcx
> {
1110 fn create_member_descriptions
<'a
>(&self, cx
: &CrateContext
<'a
, 'tcx
>)
1111 -> Vec
<MemberDescription
> {
1112 if let ty
::VariantKind
::Unit
= self.variant
.kind() {
1116 let field_size
= if self.is_simd
{
1117 let fty
= monomorphize
::field_ty(cx
.tcx(),
1119 &self.variant
.fields
[0]);
1120 Some(machine
::llsize_of_alloc(
1122 type_of
::type_of(cx
, fty
)
1128 self.variant
.fields
.iter().enumerate().map(|(i
, f
)| {
1129 let name
= if let ty
::VariantKind
::Tuple
= self.variant
.kind() {
1134 let fty
= monomorphize
::field_ty(cx
.tcx(), self.substs
, f
);
1136 let offset
= if self.is_simd
{
1137 FixedMemberOffset { bytes: i * field_size.unwrap() }
1139 ComputedMemberOffset
1144 llvm_type
: type_of
::type_of(cx
, fty
),
1145 type_metadata
: type_metadata(cx
, fty
, self.span
),
1154 fn prepare_struct_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
1155 struct_type
: Ty
<'tcx
>,
1156 unique_type_id
: UniqueTypeId
,
1158 -> RecursiveTypeDescription
<'tcx
> {
1159 let struct_name
= compute_debuginfo_type_name(cx
, struct_type
, false);
1160 let struct_llvm_type
= type_of
::in_memory_type_of(cx
, struct_type
);
1162 let (variant
, substs
) = match struct_type
.sty
{
1163 ty
::TyStruct(def
, substs
) => (def
.struct_variant(), substs
),
1164 _
=> cx
.tcx().sess
.bug("prepare_struct_metadata on a non-struct")
1167 let (containing_scope
, _
) = get_namespace_and_span_for_item(cx
, variant
.did
);
1169 let struct_metadata_stub
= create_struct_stub(cx
,
1175 create_and_register_recursive_type_forward_declaration(
1179 struct_metadata_stub
,
1181 StructMDF(StructMemberDescriptionFactory
{
1184 is_simd
: struct_type
.is_simd(),
1191 //=-----------------------------------------------------------------------------
1193 //=-----------------------------------------------------------------------------
1195 // Creates MemberDescriptions for the fields of a tuple
1196 struct TupleMemberDescriptionFactory
<'tcx
> {
1197 component_types
: Vec
<Ty
<'tcx
>>,
1201 impl<'tcx
> TupleMemberDescriptionFactory
<'tcx
> {
1202 fn create_member_descriptions
<'a
>(&self, cx
: &CrateContext
<'a
, 'tcx
>)
1203 -> Vec
<MemberDescription
> {
1204 self.component_types
1207 .map(|(i
, &component_type
)| {
1209 name
: format
!("__{}", i
),
1210 llvm_type
: type_of
::type_of(cx
, component_type
),
1211 type_metadata
: type_metadata(cx
, component_type
, self.span
),
1212 offset
: ComputedMemberOffset
,
1219 fn prepare_tuple_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
1220 tuple_type
: Ty
<'tcx
>,
1221 component_types
: &[Ty
<'tcx
>],
1222 unique_type_id
: UniqueTypeId
,
1224 -> RecursiveTypeDescription
<'tcx
> {
1225 let tuple_name
= compute_debuginfo_type_name(cx
, tuple_type
, false);
1226 let tuple_llvm_type
= type_of
::type_of(cx
, tuple_type
);
1228 create_and_register_recursive_type_forward_declaration(
1232 create_struct_stub(cx
,
1238 TupleMDF(TupleMemberDescriptionFactory
{
1239 component_types
: component_types
.to_vec(),
1246 //=-----------------------------------------------------------------------------
1248 //=-----------------------------------------------------------------------------
1250 // Describes the members of an enum value: An enum is described as a union of
1251 // structs in DWARF. This MemberDescriptionFactory provides the description for
1252 // the members of this union; so for every variant of the given enum, this
1253 // factory will produce one MemberDescription (all with no name and a fixed
1254 // offset of zero bytes).
1255 struct EnumMemberDescriptionFactory
<'tcx
> {
1256 enum_type
: Ty
<'tcx
>,
1257 type_rep
: Rc
<adt
::Repr
<'tcx
>>,
1258 discriminant_type_metadata
: Option
<DIType
>,
1259 containing_scope
: DIScope
,
1260 file_metadata
: DIFile
,
1264 impl<'tcx
> EnumMemberDescriptionFactory
<'tcx
> {
1265 fn create_member_descriptions
<'a
>(&self, cx
: &CrateContext
<'a
, 'tcx
>)
1266 -> Vec
<MemberDescription
> {
1267 let adt
= &self.enum_type
.ty_adt_def().unwrap();
1268 match *self.type_rep
{
1269 adt
::General(_
, ref struct_defs
, _
) => {
1270 let discriminant_info
= RegularDiscriminant(self.discriminant_type_metadata
1275 .map(|(i
, struct_def
)| {
1276 let (variant_type_metadata
,
1278 member_desc_factory
) =
1279 describe_enum_variant(cx
,
1284 self.containing_scope
,
1287 let member_descriptions
= member_desc_factory
1288 .create_member_descriptions(cx
);
1290 set_members_of_composite_type(cx
,
1291 variant_type_metadata
,
1293 &member_descriptions
);
1295 name
: "".to_string(),
1296 llvm_type
: variant_llvm_type
,
1297 type_metadata
: variant_type_metadata
,
1298 offset
: FixedMemberOffset { bytes: 0 }
,
1303 adt
::Univariant(ref struct_def
, _
) => {
1304 assert
!(adt
.variants
.len() <= 1);
1306 if adt
.variants
.is_empty() {
1309 let (variant_type_metadata
,
1311 member_description_factory
) =
1312 describe_enum_variant(cx
,
1317 self.containing_scope
,
1320 let member_descriptions
=
1321 member_description_factory
.create_member_descriptions(cx
);
1323 set_members_of_composite_type(cx
,
1324 variant_type_metadata
,
1326 &member_descriptions
[..]);
1329 name
: "".to_string(),
1330 llvm_type
: variant_llvm_type
,
1331 type_metadata
: variant_type_metadata
,
1332 offset
: FixedMemberOffset { bytes: 0 }
,
1338 adt
::RawNullablePointer { nndiscr: non_null_variant_index, nnty, .. }
=> {
1339 // As far as debuginfo is concerned, the pointer this enum
1340 // represents is still wrapped in a struct. This is to make the
1341 // DWARF representation of enums uniform.
1343 // First create a description of the artificial wrapper struct:
1344 let non_null_variant
= &adt
.variants
[non_null_variant_index
.0 as usize];
1345 let non_null_variant_name
= non_null_variant
.name
.as_str();
1347 // The llvm type and metadata of the pointer
1348 let non_null_llvm_type
= type_of
::type_of(cx
, nnty
);
1349 let non_null_type_metadata
= type_metadata(cx
, nnty
, self.span
);
1351 // The type of the artificial struct wrapping the pointer
1352 let artificial_struct_llvm_type
= Type
::struct_(cx
,
1353 &[non_null_llvm_type
],
1356 // For the metadata of the wrapper struct, we need to create a
1357 // MemberDescription of the struct's single field.
1358 let sole_struct_member_description
= MemberDescription
{
1359 name
: match non_null_variant
.kind() {
1360 ty
::VariantKind
::Tuple
=> "__0".to_string(),
1361 ty
::VariantKind
::Struct
=> {
1362 non_null_variant
.fields
[0].name
.to_string()
1364 ty
::VariantKind
::Unit
=> unreachable
!()
1366 llvm_type
: non_null_llvm_type
,
1367 type_metadata
: non_null_type_metadata
,
1368 offset
: FixedMemberOffset { bytes: 0 }
,
1372 let unique_type_id
= debug_context(cx
).type_map
1374 .get_unique_type_id_of_enum_variant(
1377 &non_null_variant_name
);
1379 // Now we can create the metadata of the artificial struct
1380 let artificial_struct_metadata
=
1381 composite_type_metadata(cx
,
1382 artificial_struct_llvm_type
,
1383 &non_null_variant_name
,
1385 &[sole_struct_member_description
],
1386 self.containing_scope
,
1390 // Encode the information about the null variant in the union
1392 let null_variant_index
= (1 - non_null_variant_index
.0) as usize;
1393 let null_variant_name
= adt
.variants
[null_variant_index
].name
;
1394 let union_member_name
= format
!("RUST$ENCODED$ENUM${}${}",
1398 // Finally create the (singleton) list of descriptions of union
1402 name
: union_member_name
,
1403 llvm_type
: artificial_struct_llvm_type
,
1404 type_metadata
: artificial_struct_metadata
,
1405 offset
: FixedMemberOffset { bytes: 0 }
,
1410 adt
::StructWrappedNullablePointer
{ nonnull
: ref struct_def
,
1412 ref discrfield
, ..} => {
1413 // Create a description of the non-null variant
1414 let (variant_type_metadata
, variant_llvm_type
, member_description_factory
) =
1415 describe_enum_variant(cx
,
1418 &adt
.variants
[nndiscr
.0 as usize],
1419 OptimizedDiscriminant
,
1420 self.containing_scope
,
1423 let variant_member_descriptions
=
1424 member_description_factory
.create_member_descriptions(cx
);
1426 set_members_of_composite_type(cx
,
1427 variant_type_metadata
,
1429 &variant_member_descriptions
[..]);
1431 // Encode the information about the null variant in the union
1433 let null_variant_index
= (1 - nndiscr
.0) as usize;
1434 let null_variant_name
= adt
.variants
[null_variant_index
].name
;
1435 let discrfield
= discrfield
.iter()
1437 .map(|x
| x
.to_string())
1438 .collect
::<Vec
<_
>>().join("$");
1439 let union_member_name
= format
!("RUST$ENCODED$ENUM${}${}",
1443 // Create the (singleton) list of descriptions of union members.
1446 name
: union_member_name
,
1447 llvm_type
: variant_llvm_type
,
1448 type_metadata
: variant_type_metadata
,
1449 offset
: FixedMemberOffset { bytes: 0 }
,
1454 adt
::CEnum(..) => cx
.sess().span_bug(self.span
, "This should be unreachable.")
1459 // Creates MemberDescriptions for the fields of a single enum variant.
1460 struct VariantMemberDescriptionFactory
<'tcx
> {
1461 args
: Vec
<(String
, Ty
<'tcx
>)>,
1462 discriminant_type_metadata
: Option
<DIType
>,
1466 impl<'tcx
> VariantMemberDescriptionFactory
<'tcx
> {
1467 fn create_member_descriptions
<'a
>(&self, cx
: &CrateContext
<'a
, 'tcx
>)
1468 -> Vec
<MemberDescription
> {
1469 self.args
.iter().enumerate().map(|(i
, &(ref name
, ty
))| {
1471 name
: name
.to_string(),
1472 llvm_type
: type_of
::type_of(cx
, ty
),
1473 type_metadata
: match self.discriminant_type_metadata
{
1474 Some(metadata
) if i
== 0 => metadata
,
1475 _
=> type_metadata(cx
, ty
, self.span
)
1477 offset
: ComputedMemberOffset
,
1484 #[derive(Copy, Clone)]
1485 enum EnumDiscriminantInfo
{
1486 RegularDiscriminant(DIType
),
1487 OptimizedDiscriminant
,
1491 // Returns a tuple of (1) type_metadata_stub of the variant, (2) the llvm_type
1492 // of the variant, and (3) a MemberDescriptionFactory for producing the
1493 // descriptions of the fields of the variant. This is a rudimentary version of a
1494 // full RecursiveTypeDescription.
1495 fn describe_enum_variant
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
1496 enum_type
: Ty
<'tcx
>,
1497 struct_def
: &adt
::Struct
<'tcx
>,
1498 variant
: ty
::VariantDef
<'tcx
>,
1499 discriminant_info
: EnumDiscriminantInfo
,
1500 containing_scope
: DIScope
,
1502 -> (DICompositeType
, Type
, MemberDescriptionFactory
<'tcx
>) {
1503 let variant_llvm_type
=
1504 Type
::struct_(cx
, &struct_def
.fields
1506 .map(|&t
| type_of
::type_of(cx
, t
))
1507 .collect
::<Vec
<_
>>()
1510 // Could do some consistency checks here: size, align, field count, discr type
1512 let variant_name
= variant
.name
.as_str();
1513 let unique_type_id
= debug_context(cx
).type_map
1515 .get_unique_type_id_of_enum_variant(
1520 let metadata_stub
= create_struct_stub(cx
,
1526 // Get the argument names from the enum variant info
1527 let mut arg_names
: Vec
<_
> = match variant
.kind() {
1528 ty
::VariantKind
::Unit
=> vec
![],
1529 ty
::VariantKind
::Tuple
=> {
1533 .map(|(i
, _
)| format
!("__{}", i
))
1536 ty
::VariantKind
::Struct
=> {
1539 .map(|f
| f
.name
.to_string())
1544 // If this is not a univariant enum, there is also the discriminant field.
1545 match discriminant_info
{
1546 RegularDiscriminant(_
) => arg_names
.insert(0, "RUST$ENUM$DISR".to_string()),
1547 _
=> { /* do nothing */ }
1550 // Build an array of (field name, field type) pairs to be captured in the factory closure.
1551 let args
: Vec
<(String
, Ty
)> = arg_names
.iter()
1552 .zip(&struct_def
.fields
)
1553 .map(|(s
, &t
)| (s
.to_string(), t
))
1556 let member_description_factory
=
1557 VariantMDF(VariantMemberDescriptionFactory
{
1559 discriminant_type_metadata
: match discriminant_info
{
1560 RegularDiscriminant(discriminant_type_metadata
) => {
1561 Some(discriminant_type_metadata
)
1568 (metadata_stub
, variant_llvm_type
, member_description_factory
)
1571 fn prepare_enum_metadata
<'a
, 'tcx
>(cx
: &CrateContext
<'a
, 'tcx
>,
1572 enum_type
: Ty
<'tcx
>,
1574 unique_type_id
: UniqueTypeId
,
1576 -> RecursiveTypeDescription
<'tcx
> {
1577 let enum_name
= compute_debuginfo_type_name(cx
, enum_type
, false);
1579 let (containing_scope
, _
) = get_namespace_and_span_for_item(cx
, enum_def_id
);
1580 // FIXME: This should emit actual file metadata for the enum, but we
1581 // currently can't get the necessary information when it comes to types
1582 // imported from other crates. Formerly we violated the ODR when performing
1583 // LTO because we emitted debuginfo for the same type with varying file
1584 // metadata, so as a workaround we pretend that the type comes from
1586 let file_metadata
= unknown_file_metadata(cx
);
1588 let variants
= &enum_type
.ty_adt_def().unwrap().variants
;
1590 let enumerators_metadata
: Vec
<DIDescriptor
> = variants
1593 let token
= v
.name
.as_str();
1594 let name
= CString
::new(token
.as_bytes()).unwrap();
1596 llvm
::LLVMDIBuilderCreateEnumerator(
1604 let discriminant_type_metadata
= |inttype
: syntax
::attr
::IntType
| {
1605 let disr_type_key
= (enum_def_id
, inttype
);
1606 let cached_discriminant_type_metadata
= debug_context(cx
).created_enum_disr_types
1608 .get(&disr_type_key
).cloned();
1609 match cached_discriminant_type_metadata
{
1610 Some(discriminant_type_metadata
) => discriminant_type_metadata
,
1612 let discriminant_llvm_type
= adt
::ll_inttype(cx
, inttype
);
1613 let (discriminant_size
, discriminant_align
) =
1614 size_and_align_of(cx
, discriminant_llvm_type
);
1615 let discriminant_base_type_metadata
=
1617 adt
::ty_of_inttype(cx
.tcx(), inttype
),
1619 let discriminant_name
= get_enum_discriminant_name(cx
, enum_def_id
);
1621 let name
= CString
::new(discriminant_name
.as_bytes()).unwrap();
1622 let discriminant_type_metadata
= unsafe {
1623 llvm
::LLVMDIBuilderCreateEnumerationType(
1628 UNKNOWN_LINE_NUMBER
,
1629 bytes_to_bits(discriminant_size
),
1630 bytes_to_bits(discriminant_align
),
1631 create_DIArray(DIB(cx
), &enumerators_metadata
),
1632 discriminant_base_type_metadata
)
1635 debug_context(cx
).created_enum_disr_types
1637 .insert(disr_type_key
, discriminant_type_metadata
);
1639 discriminant_type_metadata
1644 let type_rep
= adt
::represent_type(cx
, enum_type
);
1646 let discriminant_type_metadata
= match *type_rep
{
1647 adt
::CEnum(inttype
, _
, _
) => {
1648 return FinalMetadata(discriminant_type_metadata(inttype
))
1650 adt
::RawNullablePointer { .. }
|
1651 adt
::StructWrappedNullablePointer { .. }
|
1652 adt
::Univariant(..) => None
,
1653 adt
::General(inttype
, _
, _
) => Some(discriminant_type_metadata(inttype
)),
1656 let enum_llvm_type
= type_of
::type_of(cx
, enum_type
);
1657 let (enum_type_size
, enum_type_align
) = size_and_align_of(cx
, enum_llvm_type
);
1659 let unique_type_id_str
= debug_context(cx
)
1662 .get_unique_type_id_as_string(unique_type_id
);
1664 let enum_name
= CString
::new(enum_name
).unwrap();
1665 let unique_type_id_str
= CString
::new(unique_type_id_str
.as_bytes()).unwrap();
1666 let enum_metadata
= unsafe {
1667 llvm
::LLVMDIBuilderCreateUnionType(
1672 UNKNOWN_LINE_NUMBER
,
1673 bytes_to_bits(enum_type_size
),
1674 bytes_to_bits(enum_type_align
),
1678 unique_type_id_str
.as_ptr())
1681 return create_and_register_recursive_type_forward_declaration(
1687 EnumMDF(EnumMemberDescriptionFactory
{
1688 enum_type
: enum_type
,
1689 type_rep
: type_rep
.clone(),
1690 discriminant_type_metadata
: discriminant_type_metadata
,
1691 containing_scope
: containing_scope
,
1692 file_metadata
: file_metadata
,
1697 fn get_enum_discriminant_name(cx
: &CrateContext
,
1699 -> token
::InternedString
{
1700 cx
.tcx().item_name(def_id
).as_str()
1704 /// Creates debug information for a composite type, that is, anything that
1705 /// results in a LLVM struct.
1707 /// Examples of Rust types to use this are: structs, tuples, boxes, vecs, and enums.
1708 fn composite_type_metadata(cx
: &CrateContext
,
1709 composite_llvm_type
: Type
,
1710 composite_type_name
: &str,
1711 composite_type_unique_id
: UniqueTypeId
,
1712 member_descriptions
: &[MemberDescription
],
1713 containing_scope
: DIScope
,
1715 // Ignore source location information as long as it
1716 // can't be reconstructed for non-local crates.
1717 _file_metadata
: DIFile
,
1718 _definition_span
: Span
)
1719 -> DICompositeType
{
1720 // Create the (empty) struct metadata node ...
1721 let composite_type_metadata
= create_struct_stub(cx
,
1722 composite_llvm_type
,
1723 composite_type_name
,
1724 composite_type_unique_id
,
1726 // ... and immediately create and add the member descriptions.
1727 set_members_of_composite_type(cx
,
1728 composite_type_metadata
,
1729 composite_llvm_type
,
1730 member_descriptions
);
1732 return composite_type_metadata
;
1735 fn set_members_of_composite_type(cx
: &CrateContext
,
1736 composite_type_metadata
: DICompositeType
,
1737 composite_llvm_type
: Type
,
1738 member_descriptions
: &[MemberDescription
]) {
1739 // In some rare cases LLVM metadata uniquing would lead to an existing type
1740 // description being used instead of a new one created in
1741 // create_struct_stub. This would cause a hard to trace assertion in
1742 // DICompositeType::SetTypeArray(). The following check makes sure that we
1743 // get a better error message if this should happen again due to some
1746 let mut composite_types_completed
=
1747 debug_context(cx
).composite_types_completed
.borrow_mut();
1748 if composite_types_completed
.contains(&composite_type_metadata
) {
1749 cx
.sess().bug("debuginfo::set_members_of_composite_type() - \
1750 Already completed forward declaration re-encountered.");
1752 composite_types_completed
.insert(composite_type_metadata
);
1756 let member_metadata
: Vec
<DIDescriptor
> = member_descriptions
1759 .map(|(i
, member_description
)| {
1760 let (member_size
, member_align
) = size_and_align_of(cx
, member_description
.llvm_type
);
1761 let member_offset
= match member_description
.offset
{
1762 FixedMemberOffset { bytes }
=> bytes
as u64,
1763 ComputedMemberOffset
=> machine
::llelement_offset(cx
, composite_llvm_type
, i
)
1766 let member_name
= member_description
.name
.as_bytes();
1767 let member_name
= CString
::new(member_name
).unwrap();
1769 llvm
::LLVMDIBuilderCreateMemberType(
1771 composite_type_metadata
,
1772 member_name
.as_ptr(),
1774 UNKNOWN_LINE_NUMBER
,
1775 bytes_to_bits(member_size
),
1776 bytes_to_bits(member_align
),
1777 bytes_to_bits(member_offset
),
1778 member_description
.flags
,
1779 member_description
.type_metadata
)
1785 let type_array
= create_DIArray(DIB(cx
), &member_metadata
[..]);
1786 llvm
::LLVMDICompositeTypeSetTypeArray(DIB(cx
), composite_type_metadata
, type_array
);
1790 // A convenience wrapper around LLVMDIBuilderCreateStructType(). Does not do any
1791 // caching, does not add any fields to the struct. This can be done later with
1792 // set_members_of_composite_type().
1793 fn create_struct_stub(cx
: &CrateContext
,
1794 struct_llvm_type
: Type
,
1795 struct_type_name
: &str,
1796 unique_type_id
: UniqueTypeId
,
1797 containing_scope
: DIScope
)
1798 -> DICompositeType
{
1799 let (struct_size
, struct_align
) = size_and_align_of(cx
, struct_llvm_type
);
1801 let unique_type_id_str
= debug_context(cx
).type_map
1803 .get_unique_type_id_as_string(unique_type_id
);
1804 let name
= CString
::new(struct_type_name
).unwrap();
1805 let unique_type_id
= CString
::new(unique_type_id_str
.as_bytes()).unwrap();
1806 let metadata_stub
= unsafe {
1807 // LLVMDIBuilderCreateStructType() wants an empty array. A null
1808 // pointer will lead to hard to trace and debug LLVM assertions
1809 // later on in llvm/lib/IR/Value.cpp.
1810 let empty_array
= create_DIArray(DIB(cx
), &[]);
1812 llvm
::LLVMDIBuilderCreateStructType(
1817 UNKNOWN_LINE_NUMBER
,
1818 bytes_to_bits(struct_size
),
1819 bytes_to_bits(struct_align
),
1825 unique_type_id
.as_ptr())
1828 return metadata_stub
;
1831 /// Creates debug information for the given global variable.
1833 /// Adds the created metadata nodes directly to the crate's IR.
1834 pub fn create_global_var_metadata(cx
: &CrateContext
,
1835 node_id
: ast
::NodeId
,
1837 if cx
.dbg_cx().is_none() {
1841 // Don't create debuginfo for globals inlined from other crates. The other
1842 // crate should already contain debuginfo for it. More importantly, the
1843 // global might not even exist in un-inlined form anywhere which would lead
1844 // to a linker errors.
1845 if cx
.external_srcs().borrow().contains_key(&node_id
) {
1849 let var_item
= cx
.tcx().map
.get(node_id
);
1851 let (name
, span
) = match var_item
{
1852 hir_map
::NodeItem(item
) => {
1854 hir
::ItemStatic(..) => (item
.name
, item
.span
),
1855 hir
::ItemConst(..) => (item
.name
, item
.span
),
1858 .span_bug(item
.span
,
1859 &format
!("debuginfo::\
1860 create_global_var_metadata() -
1861 Captured var-id refers to \
1862 unexpected ast_item variant: {:?}",
1867 _
=> cx
.sess().bug(&format
!("debuginfo::create_global_var_metadata() \
1868 - Captured var-id refers to unexpected \
1869 hir_map variant: {:?}",
1873 let (file_metadata
, line_number
) = if span
!= codemap
::DUMMY_SP
{
1874 let loc
= span_start(cx
, span
);
1875 (file_metadata(cx
, &loc
.file
.name
), loc
.line
as c_uint
)
1877 (NO_FILE_METADATA
, UNKNOWN_LINE_NUMBER
)
1880 let is_local_to_unit
= is_node_local_to_unit(cx
, node_id
);
1881 let variable_type
= cx
.tcx().node_id_to_type(node_id
);
1882 let type_metadata
= type_metadata(cx
, variable_type
, span
);
1883 let node_def_id
= cx
.tcx().map
.local_def_id(node_id
);
1884 let namespace_node
= namespace_for_item(cx
, node_def_id
);
1885 let var_name
= name
.to_string();
1887 namespace_node
.mangled_name_of_contained_item(&var_name
[..]);
1888 let var_scope
= namespace_node
.scope
;
1890 let var_name
= CString
::new(var_name
).unwrap();
1891 let linkage_name
= CString
::new(linkage_name
).unwrap();
1893 llvm
::LLVMDIBuilderCreateStaticVariable(DIB(cx
),
1896 linkage_name
.as_ptr(),
1906 /// Creates debug information for the given local variable.
1908 /// This function assumes that there's a datum for each pattern component of the
1909 /// local in `bcx.fcx.lllocals`.
1910 /// Adds the created metadata nodes directly to the crate's IR.
1911 pub fn create_local_var_metadata(bcx
: Block
, local
: &hir
::Local
) {
1912 if bcx
.unreachable
.get() ||
1913 fn_should_be_ignored(bcx
.fcx
) ||
1914 bcx
.sess().opts
.debuginfo
!= FullDebugInfo
{
1919 let def_map
= &cx
.tcx().def_map
;
1920 let locals
= bcx
.fcx
.lllocals
.borrow();
1922 pat_util
::pat_bindings(def_map
, &local
.pat
, |_
, node_id
, span
, var_name
| {
1923 let datum
= match locals
.get(&node_id
) {
1924 Some(datum
) => datum
,
1926 bcx
.sess().span_bug(span
,
1927 &format
!("no entry in lllocals table for {}",
1932 if unsafe { llvm::LLVMIsAAllocaInst(datum.val) }
== ptr
::null_mut() {
1933 cx
.sess().span_bug(span
, "debuginfo::create_local_var_metadata() - \
1934 Referenced variable location is not an alloca!");
1937 let scope_metadata
= scope_metadata(bcx
.fcx
, node_id
, span
);
1943 VariableAccess
::DirectVariable { alloca: datum.val }
,
1944 VariableKind
::LocalVariable
,
1949 /// Creates debug information for a variable captured in a closure.
1951 /// Adds the created metadata nodes directly to the crate's IR.
1952 pub fn create_captured_var_metadata
<'blk
, 'tcx
>(bcx
: Block
<'blk
, 'tcx
>,
1953 node_id
: ast
::NodeId
,
1954 env_pointer
: ValueRef
,
1956 captured_by_ref
: bool
,
1958 if bcx
.unreachable
.get() ||
1959 fn_should_be_ignored(bcx
.fcx
) ||
1960 bcx
.sess().opts
.debuginfo
!= FullDebugInfo
{
1966 let ast_item
= cx
.tcx().map
.find(node_id
);
1968 let variable_name
= match ast_item
{
1970 cx
.sess().span_bug(span
, "debuginfo::create_captured_var_metadata: node not found");
1972 Some(hir_map
::NodeLocal(pat
)) => {
1974 PatKind
::Ident(_
, ref path1
, _
) => {
1981 "debuginfo::create_captured_var_metadata() - \
1982 Captured var-id refers to unexpected \
1983 hir_map variant: {:?}",
1991 &format
!("debuginfo::create_captured_var_metadata() - \
1992 Captured var-id refers to unexpected \
1993 hir_map variant: {:?}",
1998 let variable_type
= common
::node_id_type(bcx
, node_id
);
1999 let scope_metadata
= bcx
.fcx
.debug_context
.get_ref(cx
, span
).fn_metadata
;
2001 // env_pointer is the alloca containing the pointer to the environment,
2002 // so it's type is **EnvironmentType. In order to find out the type of
2003 // the environment we have to "dereference" two times.
2004 let llvm_env_data_type
= common
::val_ty(env_pointer
).element_type()
2006 let byte_offset_of_var_in_env
= machine
::llelement_offset(cx
,
2010 let address_operations
= unsafe {
2011 [llvm
::LLVMDIBuilderCreateOpDeref(),
2012 llvm
::LLVMDIBuilderCreateOpPlus(),
2013 byte_offset_of_var_in_env
as i64,
2014 llvm
::LLVMDIBuilderCreateOpDeref()]
2017 let address_op_count
= if captured_by_ref
{
2018 address_operations
.len()
2020 address_operations
.len() - 1
2023 let variable_access
= VariableAccess
::IndirectVariable
{
2024 alloca
: env_pointer
,
2025 address_operations
: &address_operations
[..address_op_count
]
2033 VariableKind
::CapturedVariable
,
2037 /// Creates debug information for a local variable introduced in the head of a
2038 /// match-statement arm.
2040 /// Adds the created metadata nodes directly to the crate's IR.
2041 pub fn create_match_binding_metadata
<'blk
, 'tcx
>(bcx
: Block
<'blk
, 'tcx
>,
2042 variable_name
: ast
::Name
,
2043 binding
: BindingInfo
<'tcx
>) {
2044 if bcx
.unreachable
.get() ||
2045 fn_should_be_ignored(bcx
.fcx
) ||
2046 bcx
.sess().opts
.debuginfo
!= FullDebugInfo
{
2050 let scope_metadata
= scope_metadata(bcx
.fcx
, binding
.id
, binding
.span
);
2052 [llvm
::LLVMDIBuilderCreateOpDeref()]
2054 // Regardless of the actual type (`T`) we're always passed the stack slot
2055 // (alloca) for the binding. For ByRef bindings that's a `T*` but for ByMove
2056 // bindings we actually have `T**`. So to get the actual variable we need to
2057 // dereference once more. For ByCopy we just use the stack slot we created
2059 let var_access
= match binding
.trmode
{
2060 TransBindingMode
::TrByCopy(llbinding
) |
2061 TransBindingMode
::TrByMoveIntoCopy(llbinding
) => VariableAccess
::DirectVariable
{
2064 TransBindingMode
::TrByMoveRef
=> VariableAccess
::IndirectVariable
{
2065 alloca
: binding
.llmatch
,
2066 address_operations
: &aops
2068 TransBindingMode
::TrByRef
=> VariableAccess
::DirectVariable
{
2069 alloca
: binding
.llmatch
2078 VariableKind
::LocalVariable
,
2082 /// Creates debug information for the given function argument.
2084 /// This function assumes that there's a datum for each pattern component of the
2085 /// argument in `bcx.fcx.lllocals`.
2086 /// Adds the created metadata nodes directly to the crate's IR.
2087 pub fn create_argument_metadata(bcx
: Block
, arg
: &hir
::Arg
) {
2088 if bcx
.unreachable
.get() ||
2089 fn_should_be_ignored(bcx
.fcx
) ||
2090 bcx
.sess().opts
.debuginfo
!= FullDebugInfo
{
2094 let def_map
= &bcx
.tcx().def_map
;
2095 let scope_metadata
= bcx
2098 .get_ref(bcx
.ccx(), arg
.pat
.span
)
2100 let locals
= bcx
.fcx
.lllocals
.borrow();
2102 pat_util
::pat_bindings(def_map
, &arg
.pat
, |_
, node_id
, span
, var_name
| {
2103 let datum
= match locals
.get(&node_id
) {
2106 bcx
.sess().span_bug(span
,
2107 &format
!("no entry in lllocals table for {}",
2112 if unsafe { llvm::LLVMIsAAllocaInst(datum.val) }
== ptr
::null_mut() {
2113 bcx
.sess().span_bug(span
, "debuginfo::create_argument_metadata() - \
2114 Referenced variable location is not an alloca!");
2117 let argument_index
= {
2121 .get_ref(bcx
.ccx(), span
)
2123 let argument_index
= counter
.get();
2124 counter
.set(argument_index
+ 1);
2132 VariableAccess
::DirectVariable { alloca: datum.val }
,
2133 VariableKind
::ArgumentVariable(argument_index
),