1 //===--- DebugInfo.cpp - Debug Information Helper Classes -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the helper classes used to build and interpret debug
11 // information in LLVM IR form.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/DebugInfo.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallPtrSet.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/Analysis/ValueTracking.h"
20 #include "llvm/IR/Constants.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/Instructions.h"
23 #include "llvm/IR/IntrinsicInst.h"
24 #include "llvm/IR/Intrinsics.h"
25 #include "llvm/IR/Module.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/ValueHandle.h"
29 #include "llvm/Support/raw_ostream.h"
31 using namespace llvm::dwarf;
33 //===----------------------------------------------------------------------===//
35 //===----------------------------------------------------------------------===//
37 DIDescriptor::DIDescriptor(const DIFile F) : DbgNode(F.DbgNode) {
40 DIDescriptor::DIDescriptor(const DISubprogram F) : DbgNode(F.DbgNode) {
43 DIDescriptor::DIDescriptor(const DILexicalBlockFile F) : DbgNode(F.DbgNode) {
46 DIDescriptor::DIDescriptor(const DILexicalBlock F) : DbgNode(F.DbgNode) {
49 DIDescriptor::DIDescriptor(const DIVariable F) : DbgNode(F.DbgNode) {
52 DIDescriptor::DIDescriptor(const DIType F) : DbgNode(F.DbgNode) {
55 bool DIDescriptor::Verify() const {
57 (DIDerivedType(DbgNode).Verify() ||
58 DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
59 DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
60 DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
61 DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
62 DILexicalBlock(DbgNode).Verify() ||
63 DILexicalBlockFile(DbgNode).Verify() ||
64 DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
65 DIObjCProperty(DbgNode).Verify() ||
66 DITemplateTypeParameter(DbgNode).Verify() ||
67 DITemplateValueParameter(DbgNode).Verify() ||
68 DIImportedEntity(DbgNode).Verify());
71 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
72 if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
74 return DbgNode->getOperand(Elt);
77 static const MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
78 if (const MDNode *R = dyn_cast_or_null<MDNode>(getField(DbgNode, Elt)))
83 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
84 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
85 return MDS->getString();
89 StringRef DIDescriptor::getStringField(unsigned Elt) const {
90 return ::getStringField(DbgNode, Elt);
93 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
97 if (Elt < DbgNode->getNumOperands())
99 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
100 return CI->getZExtValue();
105 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
109 if (Elt < DbgNode->getNumOperands())
111 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
112 return CI->getSExtValue();
117 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
119 return DIDescriptor();
121 if (Elt < DbgNode->getNumOperands())
123 DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
124 return DIDescriptor();
127 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
131 if (Elt < DbgNode->getNumOperands())
132 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
136 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
140 if (Elt < DbgNode->getNumOperands())
141 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
145 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
149 if (Elt < DbgNode->getNumOperands())
150 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
154 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
158 if (Elt < DbgNode->getNumOperands()) {
159 MDNode *Node = const_cast<MDNode*>(DbgNode);
160 Node->replaceOperandWith(Elt, F);
164 unsigned DIVariable::getNumAddrElements() const {
165 return DbgNode->getNumOperands()-8;
168 /// getInlinedAt - If this variable is inlined then return inline location.
169 MDNode *DIVariable::getInlinedAt() const {
170 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(7));
173 //===----------------------------------------------------------------------===//
175 //===----------------------------------------------------------------------===//
177 /// isBasicType - Return true if the specified tag is legal for
179 bool DIDescriptor::isBasicType() const {
180 if (!DbgNode) return false;
182 case dwarf::DW_TAG_base_type:
183 case dwarf::DW_TAG_unspecified_type:
190 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
191 bool DIDescriptor::isDerivedType() const {
192 if (!DbgNode) return false;
194 case dwarf::DW_TAG_typedef:
195 case dwarf::DW_TAG_pointer_type:
196 case dwarf::DW_TAG_ptr_to_member_type:
197 case dwarf::DW_TAG_reference_type:
198 case dwarf::DW_TAG_rvalue_reference_type:
199 case dwarf::DW_TAG_const_type:
200 case dwarf::DW_TAG_volatile_type:
201 case dwarf::DW_TAG_restrict_type:
202 case dwarf::DW_TAG_member:
203 case dwarf::DW_TAG_inheritance:
204 case dwarf::DW_TAG_friend:
207 // CompositeTypes are currently modelled as DerivedTypes.
208 return isCompositeType();
212 /// isCompositeType - Return true if the specified tag is legal for
214 bool DIDescriptor::isCompositeType() const {
215 if (!DbgNode) return false;
217 case dwarf::DW_TAG_array_type:
218 case dwarf::DW_TAG_structure_type:
219 case dwarf::DW_TAG_union_type:
220 case dwarf::DW_TAG_enumeration_type:
221 case dwarf::DW_TAG_subroutine_type:
222 case dwarf::DW_TAG_class_type:
229 /// isVariable - Return true if the specified tag is legal for DIVariable.
230 bool DIDescriptor::isVariable() const {
231 if (!DbgNode) return false;
233 case dwarf::DW_TAG_auto_variable:
234 case dwarf::DW_TAG_arg_variable:
241 /// isType - Return true if the specified tag is legal for DIType.
242 bool DIDescriptor::isType() const {
243 return isBasicType() || isCompositeType() || isDerivedType();
246 /// isSubprogram - Return true if the specified tag is legal for
248 bool DIDescriptor::isSubprogram() const {
249 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
252 /// isGlobalVariable - Return true if the specified tag is legal for
253 /// DIGlobalVariable.
254 bool DIDescriptor::isGlobalVariable() const {
255 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
256 getTag() == dwarf::DW_TAG_constant);
259 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
260 bool DIDescriptor::isGlobal() const {
261 return isGlobalVariable();
264 /// isUnspecifiedParmeter - Return true if the specified tag is
265 /// DW_TAG_unspecified_parameters.
266 bool DIDescriptor::isUnspecifiedParameter() const {
267 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
270 /// isScope - Return true if the specified tag is one of the scope
272 bool DIDescriptor::isScope() const {
273 if (!DbgNode) return false;
275 case dwarf::DW_TAG_compile_unit:
276 case dwarf::DW_TAG_lexical_block:
277 case dwarf::DW_TAG_subprogram:
278 case dwarf::DW_TAG_namespace:
286 /// isTemplateTypeParameter - Return true if the specified tag is
287 /// DW_TAG_template_type_parameter.
288 bool DIDescriptor::isTemplateTypeParameter() const {
289 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
292 /// isTemplateValueParameter - Return true if the specified tag is
293 /// DW_TAG_template_value_parameter.
294 bool DIDescriptor::isTemplateValueParameter() const {
295 return DbgNode && getTag() == dwarf::DW_TAG_template_value_parameter;
298 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
299 bool DIDescriptor::isCompileUnit() const {
300 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
303 /// isFile - Return true if the specified tag is DW_TAG_file_type.
304 bool DIDescriptor::isFile() const {
305 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
308 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
309 bool DIDescriptor::isNameSpace() const {
310 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
313 /// isLexicalBlockFile - Return true if the specified descriptor is a
314 /// lexical block with an extra file.
315 bool DIDescriptor::isLexicalBlockFile() const {
316 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
317 (DbgNode->getNumOperands() == 3);
320 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
321 bool DIDescriptor::isLexicalBlock() const {
322 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
323 (DbgNode->getNumOperands() > 3);
326 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
327 bool DIDescriptor::isSubrange() const {
328 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
331 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
332 bool DIDescriptor::isEnumerator() const {
333 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
336 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
337 bool DIDescriptor::isObjCProperty() const {
338 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
341 /// \brief Return true if the specified tag is DW_TAG_imported_module or
342 /// DW_TAG_imported_declaration.
343 bool DIDescriptor::isImportedEntity() const {
344 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
345 getTag() == dwarf::DW_TAG_imported_declaration);
348 //===----------------------------------------------------------------------===//
349 // Simple Descriptor Constructors and other Methods
350 //===----------------------------------------------------------------------===//
352 DIType::DIType(const MDNode *N) : DIScope(N) {
358 unsigned DIArray::getNumElements() const {
361 return DbgNode->getNumOperands();
364 /// replaceAllUsesWith - Replace all uses of debug info referenced by
366 void DIType::replaceAllUsesWith(DIDescriptor &D) {
370 // Since we use a TrackingVH for the node, its easy for clients to manufacture
371 // legitimate situations where they want to replaceAllUsesWith() on something
372 // which, due to uniquing, has merged with the source. We shield clients from
373 // this detail by allowing a value to be replaced with replaceAllUsesWith()
376 MDNode *Node = const_cast<MDNode*>(DbgNode);
377 const MDNode *DN = D;
378 const Value *V = cast_or_null<Value>(DN);
379 Node->replaceAllUsesWith(const_cast<Value*>(V));
380 MDNode::deleteTemporary(Node);
384 /// replaceAllUsesWith - Replace all uses of debug info referenced by
386 void DIType::replaceAllUsesWith(MDNode *D) {
390 // Since we use a TrackingVH for the node, its easy for clients to manufacture
391 // legitimate situations where they want to replaceAllUsesWith() on something
392 // which, due to uniquing, has merged with the source. We shield clients from
393 // this detail by allowing a value to be replaced with replaceAllUsesWith()
396 MDNode *Node = const_cast<MDNode*>(DbgNode);
397 const MDNode *DN = D;
398 const Value *V = cast_or_null<Value>(DN);
399 Node->replaceAllUsesWith(const_cast<Value*>(V));
400 MDNode::deleteTemporary(Node);
404 /// isUnsignedDIType - Return true if type encoding is unsigned.
405 bool DIType::isUnsignedDIType() {
406 DIDerivedType DTy(DbgNode);
408 return DTy.getTypeDerivedFrom().isUnsignedDIType();
410 DIBasicType BTy(DbgNode);
412 unsigned Encoding = BTy.getEncoding();
413 if (Encoding == dwarf::DW_ATE_unsigned ||
414 Encoding == dwarf::DW_ATE_unsigned_char ||
415 Encoding == dwarf::DW_ATE_boolean)
421 /// Verify - Verify that a compile unit is well formed.
422 bool DICompileUnit::Verify() const {
423 if (!isCompileUnit())
425 StringRef N = getFilename();
428 // It is possible that directory and produce string is empty.
429 return DbgNode->getNumOperands() == 13;
432 /// Verify - Verify that an ObjC property is well formed.
433 bool DIObjCProperty::Verify() const {
434 if (!isObjCProperty())
437 DIType Ty = getType();
438 if (!Ty.Verify()) return false;
440 // Don't worry about the rest of the strings for now.
441 return DbgNode->getNumOperands() == 8;
444 /// Verify - Verify that a type descriptor is well formed.
445 bool DIType::Verify() const {
448 if (getContext() && !getContext().Verify())
450 unsigned Tag = getTag();
451 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
452 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
453 Tag != dwarf::DW_TAG_ptr_to_member_type &&
454 Tag != dwarf::DW_TAG_reference_type &&
455 Tag != dwarf::DW_TAG_rvalue_reference_type &&
456 Tag != dwarf::DW_TAG_restrict_type &&
457 Tag != dwarf::DW_TAG_array_type &&
458 Tag != dwarf::DW_TAG_enumeration_type &&
459 Tag != dwarf::DW_TAG_subroutine_type &&
460 getFilename().empty())
465 /// Verify - Verify that a basic type descriptor is well formed.
466 bool DIBasicType::Verify() const {
467 return isBasicType() && DbgNode->getNumOperands() == 10;
470 /// Verify - Verify that a derived type descriptor is well formed.
471 bool DIDerivedType::Verify() const {
472 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
473 DbgNode->getNumOperands() <= 14;
476 /// Verify - Verify that a composite type descriptor is well formed.
477 bool DICompositeType::Verify() const {
478 if (!isCompositeType())
480 if (getContext() && !getContext().Verify())
483 return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
486 /// Verify - Verify that a subprogram descriptor is well formed.
487 bool DISubprogram::Verify() const {
491 if (getContext() && !getContext().Verify())
494 DICompositeType Ty = getType();
497 return DbgNode->getNumOperands() == 20;
500 /// Verify - Verify that a global variable descriptor is well formed.
501 bool DIGlobalVariable::Verify() const {
502 if (!isGlobalVariable())
505 if (getDisplayName().empty())
508 if (getContext() && !getContext().Verify())
511 DIType Ty = getType();
515 if (!getGlobal() && !getConstant())
518 return DbgNode->getNumOperands() == 13;
521 /// Verify - Verify that a variable descriptor is well formed.
522 bool DIVariable::Verify() const {
526 if (getContext() && !getContext().Verify())
529 DIType Ty = getType();
533 return DbgNode->getNumOperands() >= 8;
536 /// Verify - Verify that a location descriptor is well formed.
537 bool DILocation::Verify() const {
541 return DbgNode->getNumOperands() == 4;
544 /// Verify - Verify that a namespace descriptor is well formed.
545 bool DINameSpace::Verify() const {
548 return DbgNode->getNumOperands() == 5;
551 /// \brief Retrieve the MDNode for the directory/file pair.
552 MDNode *DIFile::getFileNode() const {
553 return const_cast<MDNode*>(getNodeField(DbgNode, 1));
556 /// \brief Verify that the file descriptor is well formed.
557 bool DIFile::Verify() const {
558 return isFile() && DbgNode->getNumOperands() == 2;
561 /// \brief Verify that the enumerator descriptor is well formed.
562 bool DIEnumerator::Verify() const {
563 return isEnumerator() && DbgNode->getNumOperands() == 3;
566 /// \brief Verify that the subrange descriptor is well formed.
567 bool DISubrange::Verify() const {
568 return isSubrange() && DbgNode->getNumOperands() == 3;
571 /// \brief Verify that the lexical block descriptor is well formed.
572 bool DILexicalBlock::Verify() const {
573 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
576 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
577 bool DILexicalBlockFile::Verify() const {
578 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
581 /// \brief Verify that the template type parameter descriptor is well formed.
582 bool DITemplateTypeParameter::Verify() const {
583 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
586 /// \brief Verify that the template value parameter descriptor is well formed.
587 bool DITemplateValueParameter::Verify() const {
588 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
591 /// \brief Verify that the imported module descriptor is well formed.
592 bool DIImportedEntity::Verify() const {
593 return isImportedEntity() &&
594 (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
597 /// getOriginalTypeSize - If this type is derived from a base type then
598 /// return base type size.
599 uint64_t DIDerivedType::getOriginalTypeSize() const {
600 unsigned Tag = getTag();
602 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
603 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
604 Tag != dwarf::DW_TAG_restrict_type)
605 return getSizeInBits();
607 DIType BaseType = getTypeDerivedFrom();
609 // If this type is not derived from any type then take conservative approach.
610 if (!BaseType.isValid())
611 return getSizeInBits();
613 // If this is a derived type, go ahead and get the base type, unless it's a
614 // reference then it's just the size of the field. Pointer types have no need
615 // of this since they're a different type of qualification on the type.
616 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
617 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
618 return getSizeInBits();
620 if (BaseType.isDerivedType())
621 return DIDerivedType(BaseType).getOriginalTypeSize();
623 return BaseType.getSizeInBits();
626 /// getObjCProperty - Return property node, if this ivar is associated with one.
627 MDNode *DIDerivedType::getObjCProperty() const {
628 if (DbgNode->getNumOperands() <= 10)
630 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
633 /// \brief Set the array of member DITypes.
634 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
635 assert((!TParams || DbgNode->getNumOperands() == 14) &&
636 "If you're setting the template parameters this should include a slot "
638 TrackingVH<MDNode> N(*this);
639 N->replaceOperandWith(10, Elements);
641 N->replaceOperandWith(13, TParams);
645 /// \brief Set the containing type.
646 void DICompositeType::setContainingType(DICompositeType ContainingType) {
647 TrackingVH<MDNode> N(*this);
648 N->replaceOperandWith(12, ContainingType);
652 /// isInlinedFnArgument - Return true if this variable provides debugging
653 /// information for an inlined function arguments.
654 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
655 assert(CurFn && "Invalid function");
656 if (!getContext().isSubprogram())
658 // This variable is not inlined function argument if its scope
659 // does not describe current function.
660 return !DISubprogram(getContext()).describes(CurFn);
663 /// describes - Return true if this subprogram provides debugging
664 /// information for the function F.
665 bool DISubprogram::describes(const Function *F) {
666 assert(F && "Invalid function");
667 if (F == getFunction())
669 StringRef Name = getLinkageName();
672 if (F->getName() == Name)
677 unsigned DISubprogram::isOptimized() const {
678 assert (DbgNode && "Invalid subprogram descriptor!");
679 if (DbgNode->getNumOperands() == 15)
680 return getUnsignedField(14);
684 MDNode *DISubprogram::getVariablesNodes() const {
685 if (!DbgNode || DbgNode->getNumOperands() <= 18)
687 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(18));
690 DIArray DISubprogram::getVariables() const {
691 if (!DbgNode || DbgNode->getNumOperands() <= 18)
693 if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(18)))
698 Value *DITemplateValueParameter::getValue() const {
699 return getField(DbgNode, 4);
702 void DIScope::setFilename(StringRef Name, LLVMContext &Context) {
705 MDString *MDName(MDString::get(Context, Name));
706 const_cast<MDNode*>(getNodeField(DbgNode, 1))->replaceOperandWith(0, MDName);
709 StringRef DIScope::getFilename() const {
712 return ::getStringField(getNodeField(DbgNode, 1), 0);
715 StringRef DIScope::getDirectory() const {
718 return ::getStringField(getNodeField(DbgNode, 1), 1);
721 DIArray DICompileUnit::getEnumTypes() const {
722 if (!DbgNode || DbgNode->getNumOperands() < 13)
725 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(7)))
730 DIArray DICompileUnit::getRetainedTypes() const {
731 if (!DbgNode || DbgNode->getNumOperands() < 13)
734 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(8)))
739 DIArray DICompileUnit::getSubprograms() const {
740 if (!DbgNode || DbgNode->getNumOperands() < 13)
743 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(9)))
749 DIArray DICompileUnit::getGlobalVariables() const {
750 if (!DbgNode || DbgNode->getNumOperands() < 13)
753 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
758 DIArray DICompileUnit::getImportedEntities() const {
759 if (!DbgNode || DbgNode->getNumOperands() < 13)
762 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
767 /// fixupObjcLikeName - Replace contains special characters used
768 /// in a typical Objective-C names with '.' in a given string.
769 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
770 bool isObjCLike = false;
771 for (size_t i = 0, e = Str.size(); i < e; ++i) {
776 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
777 C == '+' || C == '(' || C == ')'))
784 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
785 /// suitable to hold function specific information.
786 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
787 SmallString<32> Name = StringRef("llvm.dbg.lv.");
788 StringRef FName = "fn";
789 if (Fn.getFunction())
790 FName = Fn.getFunction()->getName();
792 FName = Fn.getName();
794 if (FName.startswith(StringRef(&One, 1)))
795 FName = FName.substr(1);
796 fixupObjcLikeName(FName, Name);
797 return M.getNamedMetadata(Name.str());
800 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
801 /// to hold function specific information.
802 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
803 SmallString<32> Name = StringRef("llvm.dbg.lv.");
804 StringRef FName = "fn";
805 if (Fn.getFunction())
806 FName = Fn.getFunction()->getName();
808 FName = Fn.getName();
810 if (FName.startswith(StringRef(&One, 1)))
811 FName = FName.substr(1);
812 fixupObjcLikeName(FName, Name);
814 return M.getOrInsertNamedMetadata(Name.str());
817 /// createInlinedVariable - Create a new inlined variable based on current
819 /// @param DV Current Variable.
820 /// @param InlinedScope Location at current variable is inlined.
821 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
822 LLVMContext &VMContext) {
823 SmallVector<Value *, 16> Elts;
824 // Insert inlined scope as 7th element.
825 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
826 i == 7 ? Elts.push_back(InlinedScope) :
827 Elts.push_back(DV->getOperand(i));
828 return DIVariable(MDNode::get(VMContext, Elts));
831 /// cleanseInlinedVariable - Remove inlined scope from the variable.
832 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
833 SmallVector<Value *, 16> Elts;
834 // Insert inlined scope as 7th element.
835 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
837 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
838 Elts.push_back(DV->getOperand(i));
839 return DIVariable(MDNode::get(VMContext, Elts));
842 /// getDISubprogram - Find subprogram that is enclosing this scope.
843 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
844 DIDescriptor D(Scope);
845 if (D.isSubprogram())
846 return DISubprogram(Scope);
848 if (D.isLexicalBlockFile())
849 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
851 if (D.isLexicalBlock())
852 return getDISubprogram(DILexicalBlock(Scope).getContext());
854 return DISubprogram();
857 /// getDICompositeType - Find underlying composite type.
858 DICompositeType llvm::getDICompositeType(DIType T) {
859 if (T.isCompositeType())
860 return DICompositeType(T);
862 if (T.isDerivedType())
863 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
865 return DICompositeType();
868 /// isSubprogramContext - Return true if Context is either a subprogram
869 /// or another context nested inside a subprogram.
870 bool llvm::isSubprogramContext(const MDNode *Context) {
873 DIDescriptor D(Context);
874 if (D.isSubprogram())
877 return isSubprogramContext(DIType(Context).getContext());
881 //===----------------------------------------------------------------------===//
882 // DebugInfoFinder implementations.
883 //===----------------------------------------------------------------------===//
885 /// processModule - Process entire module and collect debug info.
886 void DebugInfoFinder::processModule(const Module &M) {
887 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
888 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
889 DICompileUnit CU(CU_Nodes->getOperand(i));
891 DIArray GVs = CU.getGlobalVariables();
892 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
893 DIGlobalVariable DIG(GVs.getElement(i));
894 if (addGlobalVariable(DIG))
895 processType(DIG.getType());
897 DIArray SPs = CU.getSubprograms();
898 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
899 processSubprogram(DISubprogram(SPs.getElement(i)));
900 DIArray EnumTypes = CU.getEnumTypes();
901 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
902 processType(DIType(EnumTypes.getElement(i)));
903 DIArray RetainedTypes = CU.getRetainedTypes();
904 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
905 processType(DIType(RetainedTypes.getElement(i)));
906 // FIXME: We really shouldn't be bailing out after visiting just one CU
912 /// processLocation - Process DILocation.
913 void DebugInfoFinder::processLocation(DILocation Loc) {
914 if (!Loc.Verify()) return;
915 DIDescriptor S(Loc.getScope());
916 if (S.isCompileUnit())
917 addCompileUnit(DICompileUnit(S));
918 else if (S.isSubprogram())
919 processSubprogram(DISubprogram(S));
920 else if (S.isLexicalBlock())
921 processLexicalBlock(DILexicalBlock(S));
922 else if (S.isLexicalBlockFile()) {
923 DILexicalBlockFile DBF = DILexicalBlockFile(S);
924 processLexicalBlock(DILexicalBlock(DBF.getScope()));
926 processLocation(Loc.getOrigLocation());
929 /// processType - Process DIType.
930 void DebugInfoFinder::processType(DIType DT) {
933 if (DT.isCompositeType()) {
934 DICompositeType DCT(DT);
935 processType(DCT.getTypeDerivedFrom());
936 DIArray DA = DCT.getTypeArray();
937 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
938 DIDescriptor D = DA.getElement(i);
940 processType(DIType(D));
941 else if (D.isSubprogram())
942 processSubprogram(DISubprogram(D));
944 } else if (DT.isDerivedType()) {
945 DIDerivedType DDT(DT);
946 processType(DDT.getTypeDerivedFrom());
950 /// processLexicalBlock
951 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
952 DIScope Context = LB.getContext();
953 if (Context.isLexicalBlock())
954 return processLexicalBlock(DILexicalBlock(Context));
955 else if (Context.isLexicalBlockFile()) {
956 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
957 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
960 return processSubprogram(DISubprogram(Context));
963 /// processSubprogram - Process DISubprogram.
964 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
965 if (!addSubprogram(SP))
967 processType(SP.getType());
970 /// processDeclare - Process DbgDeclareInst.
971 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
972 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
976 if (!DV.isVariable())
979 if (!NodesSeen.insert(DV))
981 processType(DIVariable(N).getType());
984 /// addType - Add type into Tys.
985 bool DebugInfoFinder::addType(DIType DT) {
989 if (!NodesSeen.insert(DT))
996 /// addCompileUnit - Add compile unit into CUs.
997 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1001 if (!NodesSeen.insert(CU))
1008 /// addGlobalVariable - Add global variable into GVs.
1009 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1010 if (!DIDescriptor(DIG).isGlobalVariable())
1013 if (!NodesSeen.insert(DIG))
1020 // addSubprogram - Add subprgoram into SPs.
1021 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1022 if (!DIDescriptor(SP).isSubprogram())
1025 if (!NodesSeen.insert(SP))
1032 //===----------------------------------------------------------------------===//
1033 // DIDescriptor: dump routines for all descriptors.
1034 //===----------------------------------------------------------------------===//
1036 /// dump - Print descriptor to dbgs() with a newline.
1037 void DIDescriptor::dump() const {
1038 print(dbgs()); dbgs() << '\n';
1041 /// print - Print descriptor.
1042 void DIDescriptor::print(raw_ostream &OS) const {
1043 if (!DbgNode) return;
1045 if (const char *Tag = dwarf::TagString(getTag()))
1046 OS << "[ " << Tag << " ]";
1048 if (this->isSubrange()) {
1049 DISubrange(DbgNode).printInternal(OS);
1050 } else if (this->isCompileUnit()) {
1051 DICompileUnit(DbgNode).printInternal(OS);
1052 } else if (this->isFile()) {
1053 DIFile(DbgNode).printInternal(OS);
1054 } else if (this->isEnumerator()) {
1055 DIEnumerator(DbgNode).printInternal(OS);
1056 } else if (this->isBasicType()) {
1057 DIType(DbgNode).printInternal(OS);
1058 } else if (this->isDerivedType()) {
1059 DIDerivedType(DbgNode).printInternal(OS);
1060 } else if (this->isCompositeType()) {
1061 DICompositeType(DbgNode).printInternal(OS);
1062 } else if (this->isSubprogram()) {
1063 DISubprogram(DbgNode).printInternal(OS);
1064 } else if (this->isGlobalVariable()) {
1065 DIGlobalVariable(DbgNode).printInternal(OS);
1066 } else if (this->isVariable()) {
1067 DIVariable(DbgNode).printInternal(OS);
1068 } else if (this->isObjCProperty()) {
1069 DIObjCProperty(DbgNode).printInternal(OS);
1070 } else if (this->isNameSpace()) {
1071 DINameSpace(DbgNode).printInternal(OS);
1072 } else if (this->isScope()) {
1073 DIScope(DbgNode).printInternal(OS);
1077 void DISubrange::printInternal(raw_ostream &OS) const {
1078 int64_t Count = getCount();
1080 OS << " [" << getLo() << ", " << Count - 1 << ']';
1082 OS << " [unbounded]";
1085 void DIScope::printInternal(raw_ostream &OS) const {
1086 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1089 void DICompileUnit::printInternal(raw_ostream &OS) const {
1090 DIScope::printInternal(OS);
1092 unsigned Lang = getLanguage();
1093 if (const char *LangStr = dwarf::LanguageString(Lang))
1096 (OS << "lang 0x").write_hex(Lang);
1100 void DIEnumerator::printInternal(raw_ostream &OS) const {
1101 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1104 void DIType::printInternal(raw_ostream &OS) const {
1105 if (!DbgNode) return;
1107 StringRef Res = getName();
1109 OS << " [" << Res << "]";
1111 // TODO: Print context?
1113 OS << " [line " << getLineNumber()
1114 << ", size " << getSizeInBits()
1115 << ", align " << getAlignInBits()
1116 << ", offset " << getOffsetInBits();
1118 if (const char *Enc =
1119 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1120 OS << ", enc " << Enc;
1125 else if (isProtected())
1126 OS << " [protected]";
1129 OS << " [artificial]";
1131 if (isForwardDecl())
1135 if (isStaticMember())
1139 void DIDerivedType::printInternal(raw_ostream &OS) const {
1140 DIType::printInternal(OS);
1141 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1144 void DICompositeType::printInternal(raw_ostream &OS) const {
1145 DIType::printInternal(OS);
1146 DIArray A = getTypeArray();
1147 OS << " [" << A.getNumElements() << " elements]";
1150 void DINameSpace::printInternal(raw_ostream &OS) const {
1151 StringRef Name = getName();
1153 OS << " [" << Name << ']';
1155 OS << " [line " << getLineNumber() << ']';
1158 void DISubprogram::printInternal(raw_ostream &OS) const {
1159 // TODO : Print context
1160 OS << " [line " << getLineNumber() << ']';
1162 if (isLocalToUnit())
1168 if (getScopeLineNumber() != getLineNumber())
1169 OS << " [scope " << getScopeLineNumber() << "]";
1173 else if (isProtected())
1174 OS << " [protected]";
1176 StringRef Res = getName();
1178 OS << " [" << Res << ']';
1181 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1182 StringRef Res = getName();
1184 OS << " [" << Res << ']';
1186 OS << " [line " << getLineNumber() << ']';
1188 // TODO : Print context
1190 if (isLocalToUnit())
1197 void DIVariable::printInternal(raw_ostream &OS) const {
1198 StringRef Res = getName();
1200 OS << " [" << Res << ']';
1202 OS << " [line " << getLineNumber() << ']';
1205 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1206 StringRef Name = getObjCPropertyName();
1208 OS << " [" << Name << ']';
1210 OS << " [line " << getLineNumber()
1211 << ", properties " << getUnsignedField(6) << ']';
1214 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1215 const LLVMContext &Ctx) {
1216 if (!DL.isUnknown()) { // Print source line info.
1217 DIScope Scope(DL.getScope(Ctx));
1218 // Omit the directory, because it's likely to be long and uninteresting.
1220 CommentOS << Scope.getFilename();
1222 CommentOS << "<unknown>";
1223 CommentOS << ':' << DL.getLine();
1224 if (DL.getCol() != 0)
1225 CommentOS << ':' << DL.getCol();
1226 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1227 if (!InlinedAtDL.isUnknown()) {
1228 CommentOS << " @[ ";
1229 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1235 void DIVariable::printExtendedName(raw_ostream &OS) const {
1236 const LLVMContext &Ctx = DbgNode->getContext();
1237 StringRef Res = getName();
1239 OS << Res << "," << getLineNumber();
1240 if (MDNode *InlinedAt = getInlinedAt()) {
1241 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1242 if (!InlinedAtDL.isUnknown()) {
1244 printDebugLoc(InlinedAtDL, OS, Ctx);