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/Analysis/DebugInfo.h"
16 #include "llvm/Constants.h"
17 #include "llvm/DerivedTypes.h"
18 #include "llvm/Intrinsics.h"
19 #include "llvm/IntrinsicInst.h"
20 #include "llvm/Instructions.h"
21 #include "llvm/LLVMContext.h"
22 #include "llvm/Module.h"
23 #include "llvm/Analysis/ValueTracking.h"
24 #include "llvm/ADT/SmallPtrSet.h"
25 #include "llvm/Support/Dwarf.h"
26 #include "llvm/Support/DebugLoc.h"
27 #include "llvm/Support/raw_ostream.h"
29 using namespace llvm::dwarf;
31 //===----------------------------------------------------------------------===//
33 //===----------------------------------------------------------------------===//
35 /// ValidDebugInfo - Return true if V represents valid debug info value.
36 /// FIXME : Add DIDescriptor.isValid()
37 bool DIDescriptor::ValidDebugInfo(MDNode *N, CodeGenOpt::Level OptLevel) {
43 // Check current version. Allow Version6 for now.
44 unsigned Version = DI.getVersion();
45 if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
48 unsigned Tag = DI.getTag();
51 assert(DIVariable(N).Verify() && "Invalid DebugInfo value");
53 case DW_TAG_compile_unit:
54 assert(DICompileUnit(N).Verify() && "Invalid DebugInfo value");
56 case DW_TAG_subprogram:
57 assert(DISubprogram(N).Verify() && "Invalid DebugInfo value");
59 case DW_TAG_lexical_block:
60 // FIXME: This interfers with the quality of generated code during
62 if (OptLevel != CodeGenOpt::None)
72 DIDescriptor::DIDescriptor(MDNode *N, unsigned RequiredTag) {
75 // If this is non-null, check to see if the Tag matches. If not, set to null.
76 if (N && getTag() != RequiredTag) {
82 DIDescriptor::getStringField(unsigned Elt) const {
86 if (Elt < DbgNode->getNumElements())
87 if (MDString *MDS = dyn_cast_or_null<MDString>(DbgNode->getElement(Elt)))
88 return MDS->getString();
93 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
97 if (Elt < DbgNode->getNumElements())
98 if (ConstantInt *CI = dyn_cast<ConstantInt>(DbgNode->getElement(Elt)))
99 return CI->getZExtValue();
104 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
106 return DIDescriptor();
108 if (Elt < DbgNode->getNumElements() && DbgNode->getElement(Elt))
109 return DIDescriptor(dyn_cast<MDNode>(DbgNode->getElement(Elt)));
111 return DIDescriptor();
114 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
118 if (Elt < DbgNode->getNumElements())
119 return dyn_cast_or_null<GlobalVariable>(DbgNode->getElement(Elt));
123 //===----------------------------------------------------------------------===//
125 //===----------------------------------------------------------------------===//
127 /// isBasicType - Return true if the specified tag is legal for
129 bool DIDescriptor::isBasicType() const {
130 assert (!isNull() && "Invalid descriptor!");
131 unsigned Tag = getTag();
133 return Tag == dwarf::DW_TAG_base_type;
136 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
137 bool DIDescriptor::isDerivedType() const {
138 assert (!isNull() && "Invalid descriptor!");
139 unsigned Tag = getTag();
142 case dwarf::DW_TAG_typedef:
143 case dwarf::DW_TAG_pointer_type:
144 case dwarf::DW_TAG_reference_type:
145 case dwarf::DW_TAG_const_type:
146 case dwarf::DW_TAG_volatile_type:
147 case dwarf::DW_TAG_restrict_type:
148 case dwarf::DW_TAG_member:
149 case dwarf::DW_TAG_inheritance:
152 // CompositeTypes are currently modelled as DerivedTypes.
153 return isCompositeType();
157 /// isCompositeType - Return true if the specified tag is legal for
159 bool DIDescriptor::isCompositeType() const {
160 assert (!isNull() && "Invalid descriptor!");
161 unsigned Tag = getTag();
164 case dwarf::DW_TAG_array_type:
165 case dwarf::DW_TAG_structure_type:
166 case dwarf::DW_TAG_union_type:
167 case dwarf::DW_TAG_enumeration_type:
168 case dwarf::DW_TAG_vector_type:
169 case dwarf::DW_TAG_subroutine_type:
170 case dwarf::DW_TAG_class_type:
177 /// isVariable - Return true if the specified tag is legal for DIVariable.
178 bool DIDescriptor::isVariable() const {
179 assert (!isNull() && "Invalid descriptor!");
180 unsigned Tag = getTag();
183 case dwarf::DW_TAG_auto_variable:
184 case dwarf::DW_TAG_arg_variable:
185 case dwarf::DW_TAG_return_variable:
192 /// isType - Return true if the specified tag is legal for DIType.
193 bool DIDescriptor::isType() const {
194 return isBasicType() || isCompositeType() || isDerivedType();
197 /// isSubprogram - Return true if the specified tag is legal for
199 bool DIDescriptor::isSubprogram() const {
200 assert (!isNull() && "Invalid descriptor!");
201 unsigned Tag = getTag();
203 return Tag == dwarf::DW_TAG_subprogram;
206 /// isGlobalVariable - Return true if the specified tag is legal for
207 /// DIGlobalVariable.
208 bool DIDescriptor::isGlobalVariable() const {
209 assert (!isNull() && "Invalid descriptor!");
210 unsigned Tag = getTag();
212 return Tag == dwarf::DW_TAG_variable;
215 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
216 bool DIDescriptor::isGlobal() const {
217 return isGlobalVariable();
220 /// isScope - Return true if the specified tag is one of the scope
222 bool DIDescriptor::isScope() const {
223 assert (!isNull() && "Invalid descriptor!");
224 unsigned Tag = getTag();
227 case dwarf::DW_TAG_compile_unit:
228 case dwarf::DW_TAG_lexical_block:
229 case dwarf::DW_TAG_subprogram:
230 case dwarf::DW_TAG_namespace:
238 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
239 bool DIDescriptor::isCompileUnit() const {
240 assert (!isNull() && "Invalid descriptor!");
241 unsigned Tag = getTag();
243 return Tag == dwarf::DW_TAG_compile_unit;
246 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
247 bool DIDescriptor::isNameSpace() const {
248 assert (!isNull() && "Invalid descriptor!");
249 unsigned Tag = getTag();
251 return Tag == dwarf::DW_TAG_namespace;
254 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
255 bool DIDescriptor::isLexicalBlock() const {
256 assert (!isNull() && "Invalid descriptor!");
257 unsigned Tag = getTag();
259 return Tag == dwarf::DW_TAG_lexical_block;
262 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
263 bool DIDescriptor::isSubrange() const {
264 assert (!isNull() && "Invalid descriptor!");
265 unsigned Tag = getTag();
267 return Tag == dwarf::DW_TAG_subrange_type;
270 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
271 bool DIDescriptor::isEnumerator() const {
272 assert (!isNull() && "Invalid descriptor!");
273 unsigned Tag = getTag();
275 return Tag == dwarf::DW_TAG_enumerator;
278 //===----------------------------------------------------------------------===//
279 // Simple Descriptor Constructors and other Methods
280 //===----------------------------------------------------------------------===//
282 DIType::DIType(MDNode *N) : DIDescriptor(N) {
284 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
289 unsigned DIArray::getNumElements() const {
290 assert (DbgNode && "Invalid DIArray");
291 return DbgNode->getNumElements();
294 /// replaceAllUsesWith - Replace all uses of debug info referenced by
295 /// this descriptor. After this completes, the current debug info value
297 void DIDerivedType::replaceAllUsesWith(DIDescriptor &D) {
301 assert (!D.isNull() && "Can not replace with null");
303 // Since we use a TrackingVH for the node, its easy for clients to manufacture
304 // legitimate situations where they want to replaceAllUsesWith() on something
305 // which, due to uniquing, has merged with the source. We shield clients from
306 // this detail by allowing a value to be replaced with replaceAllUsesWith()
308 if (getNode() != D.getNode()) {
309 MDNode *Node = DbgNode;
310 Node->replaceAllUsesWith(D.getNode());
315 /// Verify - Verify that a compile unit is well formed.
316 bool DICompileUnit::Verify() const {
319 StringRef N = getFilename();
322 // It is possible that directory and produce string is empty.
326 /// Verify - Verify that a type descriptor is well formed.
327 bool DIType::Verify() const {
330 if (getContext().isNull())
333 DICompileUnit CU = getCompileUnit();
334 if (!CU.isNull() && !CU.Verify())
339 /// Verify - Verify that a composite type descriptor is well formed.
340 bool DICompositeType::Verify() const {
343 if (getContext().isNull())
346 DICompileUnit CU = getCompileUnit();
347 if (!CU.isNull() && !CU.Verify())
352 /// Verify - Verify that a subprogram descriptor is well formed.
353 bool DISubprogram::Verify() const {
357 if (getContext().isNull())
360 DICompileUnit CU = getCompileUnit();
364 DICompositeType Ty = getType();
365 if (!Ty.isNull() && !Ty.Verify())
370 /// Verify - Verify that a global variable descriptor is well formed.
371 bool DIGlobalVariable::Verify() const {
375 if (getDisplayName().empty())
378 if (getContext().isNull())
381 DICompileUnit CU = getCompileUnit();
382 if (!CU.isNull() && !CU.Verify())
385 DIType Ty = getType();
395 /// Verify - Verify that a variable descriptor is well formed.
396 bool DIVariable::Verify() const {
400 if (getContext().isNull())
403 DIType Ty = getType();
410 /// getOriginalTypeSize - If this type is derived from a base type then
411 /// return base type size.
412 uint64_t DIDerivedType::getOriginalTypeSize() const {
413 unsigned Tag = getTag();
414 if (Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef ||
415 Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
416 Tag == dwarf::DW_TAG_restrict_type) {
417 DIType BaseType = getTypeDerivedFrom();
418 // If this type is not derived from any type then take conservative
420 if (BaseType.isNull())
421 return getSizeInBits();
422 if (BaseType.isDerivedType())
423 return DIDerivedType(BaseType.getNode()).getOriginalTypeSize();
425 return BaseType.getSizeInBits();
428 return getSizeInBits();
431 /// describes - Return true if this subprogram provides debugging
432 /// information for the function F.
433 bool DISubprogram::describes(const Function *F) {
434 assert (F && "Invalid function");
435 StringRef Name = getLinkageName();
438 if (F->getName() == Name)
443 StringRef DIScope::getFilename() const {
444 if (isLexicalBlock())
445 return DILexicalBlock(DbgNode).getFilename();
446 else if (isSubprogram())
447 return DISubprogram(DbgNode).getFilename();
448 else if (isCompileUnit())
449 return DICompileUnit(DbgNode).getFilename();
450 else if (isNameSpace())
451 return DINameSpace(DbgNode).getFilename();
453 assert (0 && "Invalid DIScope!");
457 StringRef DIScope::getDirectory() const {
458 if (isLexicalBlock())
459 return DILexicalBlock(DbgNode).getDirectory();
460 else if (isSubprogram())
461 return DISubprogram(DbgNode).getDirectory();
462 else if (isCompileUnit())
463 return DICompileUnit(DbgNode).getDirectory();
464 else if (isNameSpace())
465 return DINameSpace(DbgNode).getDirectory();
467 assert (0 && "Invalid DIScope!");
471 //===----------------------------------------------------------------------===//
472 // DIDescriptor: dump routines for all descriptors.
473 //===----------------------------------------------------------------------===//
476 /// dump - Print descriptor.
477 void DIDescriptor::dump() const {
478 errs() << "[" << dwarf::TagString(getTag()) << "] ";
479 errs().write_hex((intptr_t) &*DbgNode) << ']';
482 /// dump - Print compile unit.
483 void DICompileUnit::dump() const {
485 errs() << " [" << dwarf::LanguageString(getLanguage()) << "] ";
487 errs() << " [" << getDirectory() << "/" << getFilename() << " ]";
490 /// dump - Print type.
491 void DIType::dump() const {
492 if (isNull()) return;
494 StringRef Res = getName();
496 errs() << " [" << Res << "] ";
498 unsigned Tag = getTag();
499 errs() << " [" << dwarf::TagString(Tag) << "] ";
501 // TODO : Print context
502 getCompileUnit().dump();
504 << getLineNumber() << ", "
505 << getSizeInBits() << ", "
506 << getAlignInBits() << ", "
511 errs() << " [private] ";
512 else if (isProtected())
513 errs() << " [protected] ";
519 DIBasicType(DbgNode).dump();
520 else if (isDerivedType())
521 DIDerivedType(DbgNode).dump();
522 else if (isCompositeType())
523 DICompositeType(DbgNode).dump();
525 errs() << "Invalid DIType\n";
532 /// dump - Print basic type.
533 void DIBasicType::dump() const {
534 errs() << " [" << dwarf::AttributeEncodingString(getEncoding()) << "] ";
537 /// dump - Print derived type.
538 void DIDerivedType::dump() const {
539 errs() << "\n\t Derived From: "; getTypeDerivedFrom().dump();
542 /// dump - Print composite type.
543 void DICompositeType::dump() const {
544 DIArray A = getTypeArray();
547 errs() << " [" << A.getNumElements() << " elements]";
550 /// dump - Print global.
551 void DIGlobal::dump() const {
552 StringRef Res = getName();
554 errs() << " [" << Res << "] ";
556 unsigned Tag = getTag();
557 errs() << " [" << dwarf::TagString(Tag) << "] ";
559 // TODO : Print context
560 getCompileUnit().dump();
561 errs() << " [" << getLineNumber() << "] ";
564 errs() << " [local] ";
569 if (isGlobalVariable())
570 DIGlobalVariable(DbgNode).dump();
575 /// dump - Print subprogram.
576 void DISubprogram::dump() const {
577 StringRef Res = getName();
579 errs() << " [" << Res << "] ";
581 unsigned Tag = getTag();
582 errs() << " [" << dwarf::TagString(Tag) << "] ";
584 // TODO : Print context
585 getCompileUnit().dump();
586 errs() << " [" << getLineNumber() << "] ";
589 errs() << " [local] ";
597 /// dump - Print global variable.
598 void DIGlobalVariable::dump() const {
604 /// dump - Print variable.
605 void DIVariable::dump() const {
606 StringRef Res = getName();
608 errs() << " [" << Res << "] ";
610 getCompileUnit().dump();
611 errs() << " [" << getLineNumber() << "] ";
615 // FIXME: Dump complex addresses
618 //===----------------------------------------------------------------------===//
619 // DIFactory: Basic Helpers
620 //===----------------------------------------------------------------------===//
622 DIFactory::DIFactory(Module &m)
623 : M(m), VMContext(M.getContext()), DeclareFn(0) {
624 EmptyStructPtr = PointerType::getUnqual(StructType::get(VMContext));
627 Constant *DIFactory::GetTagConstant(unsigned TAG) {
628 assert((TAG & LLVMDebugVersionMask) == 0 &&
629 "Tag too large for debug encoding!");
630 return ConstantInt::get(Type::getInt32Ty(VMContext), TAG | LLVMDebugVersion);
633 //===----------------------------------------------------------------------===//
634 // DIFactory: Primary Constructors
635 //===----------------------------------------------------------------------===//
637 /// GetOrCreateArray - Create an descriptor for an array of descriptors.
638 /// This implicitly uniques the arrays created.
639 DIArray DIFactory::GetOrCreateArray(DIDescriptor *Tys, unsigned NumTys) {
640 SmallVector<Value*, 16> Elts;
643 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
645 for (unsigned i = 0; i != NumTys; ++i)
646 Elts.push_back(Tys[i].getNode());
648 return DIArray(MDNode::get(VMContext,Elts.data(), Elts.size()));
651 /// GetOrCreateSubrange - Create a descriptor for a value range. This
652 /// implicitly uniques the values returned.
653 DISubrange DIFactory::GetOrCreateSubrange(int64_t Lo, int64_t Hi) {
655 GetTagConstant(dwarf::DW_TAG_subrange_type),
656 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
657 ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
660 return DISubrange(MDNode::get(VMContext, &Elts[0], 3));
665 /// CreateCompileUnit - Create a new descriptor for the specified compile
666 /// unit. Note that this does not unique compile units within the module.
667 DICompileUnit DIFactory::CreateCompileUnit(unsigned LangID,
674 unsigned RunTimeVer) {
676 GetTagConstant(dwarf::DW_TAG_compile_unit),
677 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
678 ConstantInt::get(Type::getInt32Ty(VMContext), LangID),
679 MDString::get(VMContext, Filename),
680 MDString::get(VMContext, Directory),
681 MDString::get(VMContext, Producer),
682 ConstantInt::get(Type::getInt1Ty(VMContext), isMain),
683 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
684 MDString::get(VMContext, Flags),
685 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer)
688 return DICompileUnit(MDNode::get(VMContext, &Elts[0], 10));
691 /// CreateEnumerator - Create a single enumerator value.
692 DIEnumerator DIFactory::CreateEnumerator(StringRef Name, uint64_t Val){
694 GetTagConstant(dwarf::DW_TAG_enumerator),
695 MDString::get(VMContext, Name),
696 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
698 return DIEnumerator(MDNode::get(VMContext, &Elts[0], 3));
702 /// CreateBasicType - Create a basic type like int, float, etc.
703 DIBasicType DIFactory::CreateBasicType(DIDescriptor Context,
705 DICompileUnit CompileUnit,
708 uint64_t AlignInBits,
709 uint64_t OffsetInBits, unsigned Flags,
712 GetTagConstant(dwarf::DW_TAG_base_type),
714 MDString::get(VMContext, Name),
715 CompileUnit.getNode(),
716 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
717 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
718 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
719 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
720 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
721 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
723 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
727 /// CreateBasicType - Create a basic type like int, float, etc.
728 DIBasicType DIFactory::CreateBasicTypeEx(DIDescriptor Context,
730 DICompileUnit CompileUnit,
732 Constant *SizeInBits,
733 Constant *AlignInBits,
734 Constant *OffsetInBits, unsigned Flags,
737 GetTagConstant(dwarf::DW_TAG_base_type),
739 MDString::get(VMContext, Name),
740 CompileUnit.getNode(),
741 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
745 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
746 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
748 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
752 /// CreateDerivedType - Create a derived type like const qualified type,
753 /// pointer, typedef, etc.
754 DIDerivedType DIFactory::CreateDerivedType(unsigned Tag,
755 DIDescriptor Context,
757 DICompileUnit CompileUnit,
760 uint64_t AlignInBits,
761 uint64_t OffsetInBits,
763 DIType DerivedFrom) {
767 MDString::get(VMContext, Name),
768 CompileUnit.getNode(),
769 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
770 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
771 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
772 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
773 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
774 DerivedFrom.getNode(),
776 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
780 /// CreateDerivedType - Create a derived type like const qualified type,
781 /// pointer, typedef, etc.
782 DIDerivedType DIFactory::CreateDerivedTypeEx(unsigned Tag,
783 DIDescriptor Context,
785 DICompileUnit CompileUnit,
787 Constant *SizeInBits,
788 Constant *AlignInBits,
789 Constant *OffsetInBits,
791 DIType DerivedFrom) {
795 MDString::get(VMContext, Name),
796 CompileUnit.getNode(),
797 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
801 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
802 DerivedFrom.getNode(),
804 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
808 /// CreateCompositeType - Create a composite type like array, struct, etc.
809 DICompositeType DIFactory::CreateCompositeType(unsigned Tag,
810 DIDescriptor Context,
812 DICompileUnit CompileUnit,
815 uint64_t AlignInBits,
816 uint64_t OffsetInBits,
820 unsigned RuntimeLang) {
825 MDString::get(VMContext, Name),
826 CompileUnit.getNode(),
827 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
828 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
829 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
830 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
831 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
832 DerivedFrom.getNode(),
834 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
836 return DICompositeType(MDNode::get(VMContext, &Elts[0], 12));
840 /// CreateCompositeType - Create a composite type like array, struct, etc.
841 DICompositeType DIFactory::CreateCompositeTypeEx(unsigned Tag,
842 DIDescriptor Context,
844 DICompileUnit CompileUnit,
846 Constant *SizeInBits,
847 Constant *AlignInBits,
848 Constant *OffsetInBits,
852 unsigned RuntimeLang) {
857 MDString::get(VMContext, Name),
858 CompileUnit.getNode(),
859 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
863 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
864 DerivedFrom.getNode(),
866 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
868 return DICompositeType(MDNode::get(VMContext, &Elts[0], 12));
872 /// CreateSubprogram - Create a new descriptor for the specified subprogram.
873 /// See comments in DISubprogram for descriptions of these fields. This
874 /// method does not unique the generated descriptors.
875 DISubprogram DIFactory::CreateSubprogram(DIDescriptor Context,
877 StringRef DisplayName,
878 StringRef LinkageName,
879 DICompileUnit CompileUnit,
880 unsigned LineNo, DIType Type,
883 unsigned VK, unsigned VIndex,
884 DIType ContainingType) {
887 GetTagConstant(dwarf::DW_TAG_subprogram),
888 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
890 MDString::get(VMContext, Name),
891 MDString::get(VMContext, DisplayName),
892 MDString::get(VMContext, LinkageName),
893 CompileUnit.getNode(),
894 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
896 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
897 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
898 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
899 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
900 ContainingType.getNode()
902 return DISubprogram(MDNode::get(VMContext, &Elts[0], 14));
905 /// CreateSubprogramDefinition - Create new subprogram descriptor for the
906 /// given declaration.
907 DISubprogram DIFactory::CreateSubprogramDefinition(DISubprogram &SPDeclaration) {
908 if (SPDeclaration.isDefinition())
909 return DISubprogram(SPDeclaration.getNode());
911 MDNode *DeclNode = SPDeclaration.getNode();
913 GetTagConstant(dwarf::DW_TAG_subprogram),
914 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
915 DeclNode->getElement(2), // Context
916 DeclNode->getElement(3), // Name
917 DeclNode->getElement(4), // DisplayName
918 DeclNode->getElement(5), // LinkageName
919 DeclNode->getElement(6), // CompileUnit
920 DeclNode->getElement(7), // LineNo
921 DeclNode->getElement(8), // Type
922 DeclNode->getElement(9), // isLocalToUnit
923 ConstantInt::get(Type::getInt1Ty(VMContext), true),
924 DeclNode->getElement(11), // Virtuality
925 DeclNode->getElement(12), // VIndex
926 DeclNode->getElement(13) // Containting Type
928 return DISubprogram(MDNode::get(VMContext, &Elts[0], 14));
931 /// CreateGlobalVariable - Create a new descriptor for the specified global.
933 DIFactory::CreateGlobalVariable(DIDescriptor Context, StringRef Name,
934 StringRef DisplayName,
935 StringRef LinkageName,
936 DICompileUnit CompileUnit,
937 unsigned LineNo, DIType Type,bool isLocalToUnit,
938 bool isDefinition, llvm::GlobalVariable *Val) {
940 GetTagConstant(dwarf::DW_TAG_variable),
941 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
943 MDString::get(VMContext, Name),
944 MDString::get(VMContext, DisplayName),
945 MDString::get(VMContext, LinkageName),
946 CompileUnit.getNode(),
947 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
949 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
950 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
954 Value *const *Vs = &Elts[0];
955 MDNode *Node = MDNode::get(VMContext,Vs, 12);
957 // Create a named metadata so that we do not lose this mdnode.
958 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
959 NMD->addElement(Node);
961 return DIGlobalVariable(Node);
965 /// CreateVariable - Create a new descriptor for the specified variable.
966 DIVariable DIFactory::CreateVariable(unsigned Tag, DIDescriptor Context,
968 DICompileUnit CompileUnit, unsigned LineNo,
973 MDString::get(VMContext, Name),
974 CompileUnit.getNode(),
975 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
978 return DIVariable(MDNode::get(VMContext, &Elts[0], 6));
982 /// CreateComplexVariable - Create a new descriptor for the specified variable
983 /// which has a complex address expression for its address.
984 DIVariable DIFactory::CreateComplexVariable(unsigned Tag, DIDescriptor Context,
985 const std::string &Name,
986 DICompileUnit CompileUnit,
988 DIType Type, SmallVector<Value *, 9> &addr) {
989 SmallVector<Value *, 9> Elts;
990 Elts.push_back(GetTagConstant(Tag));
991 Elts.push_back(Context.getNode());
992 Elts.push_back(MDString::get(VMContext, Name));
993 Elts.push_back(CompileUnit.getNode());
994 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext), LineNo));
995 Elts.push_back(Type.getNode());
996 Elts.insert(Elts.end(), addr.begin(), addr.end());
998 return DIVariable(MDNode::get(VMContext, &Elts[0], 6+addr.size()));
1002 /// CreateBlock - This creates a descriptor for a lexical block with the
1003 /// specified parent VMContext.
1004 DILexicalBlock DIFactory::CreateLexicalBlock(DIDescriptor Context) {
1006 GetTagConstant(dwarf::DW_TAG_lexical_block),
1009 return DILexicalBlock(MDNode::get(VMContext, &Elts[0], 2));
1012 /// CreateNameSpace - This creates new descriptor for a namespace
1013 /// with the specified parent context.
1014 DINameSpace DIFactory::CreateNameSpace(DIDescriptor Context, StringRef Name,
1015 DICompileUnit CompileUnit,
1018 GetTagConstant(dwarf::DW_TAG_namespace),
1020 MDString::get(VMContext, Name),
1021 CompileUnit.getNode(),
1022 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1024 return DINameSpace(MDNode::get(VMContext, &Elts[0], 5));
1027 /// CreateLocation - Creates a debug info location.
1028 DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
1029 DIScope S, DILocation OrigLoc) {
1031 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1032 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
1036 return DILocation(MDNode::get(VMContext, &Elts[0], 4));
1039 /// CreateLocation - Creates a debug info location.
1040 DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
1041 DIScope S, MDNode *OrigLoc) {
1043 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1044 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
1048 return DILocation(MDNode::get(VMContext, &Elts[0], 4));
1051 //===----------------------------------------------------------------------===//
1052 // DIFactory: Routines for inserting code into a function
1053 //===----------------------------------------------------------------------===//
1055 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1056 Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
1057 Instruction *InsertBefore) {
1058 // Cast the storage to a {}* for the call to llvm.dbg.declare.
1059 Storage = new BitCastInst(Storage, EmptyStructPtr, "", InsertBefore);
1062 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1064 Value *Args[] = { Storage, D.getNode() };
1065 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertBefore);
1068 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1069 Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
1070 BasicBlock *InsertAtEnd) {
1071 // Cast the storage to a {}* for the call to llvm.dbg.declare.
1072 Storage = new BitCastInst(Storage, EmptyStructPtr, "", InsertAtEnd);
1075 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1077 Value *Args[] = { Storage, D.getNode() };
1078 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertAtEnd);
1081 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1082 Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, Value *Offset,
1084 Instruction *InsertBefore) {
1085 assert(V && "no value passed to dbg.value");
1086 assert(Offset->getType() == Type::getInt64Ty(V->getContext()) &&
1087 "offset must be i64");
1089 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1091 Value *Elts[] = { V };
1092 Value *Args[] = { MDNode::get(V->getContext(), Elts, 1), Offset,
1094 return CallInst::Create(ValueFn, Args, Args+3, "", InsertBefore);
1097 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1098 Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, Value *Offset,
1100 BasicBlock *InsertAtEnd) {
1101 assert(V && "no value passed to dbg.value");
1102 assert(Offset->getType() == Type::getInt64Ty(V->getContext()) &&
1103 "offset must be i64");
1105 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1107 Value *Elts[] = { V };
1108 Value *Args[] = { MDNode::get(V->getContext(), Elts, 1), Offset,
1110 return CallInst::Create(ValueFn, Args, Args+3, "", InsertAtEnd);
1113 //===----------------------------------------------------------------------===//
1114 // DebugInfoFinder implementations.
1115 //===----------------------------------------------------------------------===//
1117 /// processModule - Process entire module and collect debug info.
1118 void DebugInfoFinder::processModule(Module &M) {
1120 MetadataContext &TheMetadata = M.getContext().getMetadata();
1121 unsigned MDDbgKind = TheMetadata.getMDKind("dbg");
1123 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1124 for (Function::iterator FI = (*I).begin(), FE = (*I).end(); FI != FE; ++FI)
1125 for (BasicBlock::iterator BI = (*FI).begin(), BE = (*FI).end(); BI != BE;
1127 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
1128 processDeclare(DDI);
1130 if (MDNode *L = TheMetadata.getMD(MDDbgKind, BI))
1131 processLocation(DILocation(L));
1134 NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv");
1138 for (unsigned i = 0, e = NMD->getNumElements(); i != e; ++i) {
1139 DIGlobalVariable DIG(cast<MDNode>(NMD->getElement(i)));
1140 if (addGlobalVariable(DIG)) {
1141 addCompileUnit(DIG.getCompileUnit());
1142 processType(DIG.getType());
1147 /// processLocation - Process DILocation.
1148 void DebugInfoFinder::processLocation(DILocation Loc) {
1149 if (Loc.isNull()) return;
1150 DIScope S(Loc.getScope().getNode());
1151 if (S.isNull()) return;
1152 if (S.isCompileUnit())
1153 addCompileUnit(DICompileUnit(S.getNode()));
1154 else if (S.isSubprogram())
1155 processSubprogram(DISubprogram(S.getNode()));
1156 else if (S.isLexicalBlock())
1157 processLexicalBlock(DILexicalBlock(S.getNode()));
1158 processLocation(Loc.getOrigLocation());
1161 /// processType - Process DIType.
1162 void DebugInfoFinder::processType(DIType DT) {
1166 addCompileUnit(DT.getCompileUnit());
1167 if (DT.isCompositeType()) {
1168 DICompositeType DCT(DT.getNode());
1169 processType(DCT.getTypeDerivedFrom());
1170 DIArray DA = DCT.getTypeArray();
1172 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1173 DIDescriptor D = DA.getElement(i);
1174 DIType TypeE = DIType(D.getNode());
1175 if (!TypeE.isNull())
1178 processSubprogram(DISubprogram(D.getNode()));
1180 } else if (DT.isDerivedType()) {
1181 DIDerivedType DDT(DT.getNode());
1183 processType(DDT.getTypeDerivedFrom());
1187 /// processLexicalBlock
1188 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
1191 DIScope Context = LB.getContext();
1192 if (Context.isLexicalBlock())
1193 return processLexicalBlock(DILexicalBlock(Context.getNode()));
1195 return processSubprogram(DISubprogram(Context.getNode()));
1198 /// processSubprogram - Process DISubprogram.
1199 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1202 if (!addSubprogram(SP))
1204 addCompileUnit(SP.getCompileUnit());
1205 processType(SP.getType());
1208 /// processDeclare - Process DbgDeclareInst.
1209 void DebugInfoFinder::processDeclare(DbgDeclareInst *DDI) {
1210 DIVariable DV(cast<MDNode>(DDI->getVariable()));
1214 if (!NodesSeen.insert(DV.getNode()))
1217 addCompileUnit(DV.getCompileUnit());
1218 processType(DV.getType());
1221 /// addType - Add type into Tys.
1222 bool DebugInfoFinder::addType(DIType DT) {
1226 if (!NodesSeen.insert(DT.getNode()))
1229 TYs.push_back(DT.getNode());
1233 /// addCompileUnit - Add compile unit into CUs.
1234 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1238 if (!NodesSeen.insert(CU.getNode()))
1241 CUs.push_back(CU.getNode());
1245 /// addGlobalVariable - Add global variable into GVs.
1246 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1250 if (!NodesSeen.insert(DIG.getNode()))
1253 GVs.push_back(DIG.getNode());
1257 // addSubprogram - Add subprgoram into SPs.
1258 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1262 if (!NodesSeen.insert(SP.getNode()))
1265 SPs.push_back(SP.getNode());
1270 /// findStopPoint - Find the stoppoint coressponding to this instruction, that
1271 /// is the stoppoint that dominates this instruction.
1272 const DbgStopPointInst *findStopPoint(const Instruction *Inst) {
1273 if (const DbgStopPointInst *DSI = dyn_cast<DbgStopPointInst>(Inst))
1276 const BasicBlock *BB = Inst->getParent();
1277 BasicBlock::const_iterator I = Inst, B;
1281 // A BB consisting only of a terminator can't have a stoppoint.
1284 if (const DbgStopPointInst *DSI = dyn_cast<DbgStopPointInst>(I))
1288 // This BB didn't have a stoppoint: if there is only one predecessor, look
1289 // for a stoppoint there. We could use getIDom(), but that would require
1291 BB = I->getParent()->getUniquePredecessor();
1293 I = BB->getTerminator();
1299 /// findBBStopPoint - Find the stoppoint corresponding to first real
1300 /// (non-debug intrinsic) instruction in this Basic Block, and return the
1301 /// stoppoint for it.
1302 const DbgStopPointInst *findBBStopPoint(const BasicBlock *BB) {
1303 for(BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1304 if (const DbgStopPointInst *DSI = dyn_cast<DbgStopPointInst>(I))
1307 // Fallback to looking for stoppoint of unique predecessor. Useful if this
1308 // BB contains no stoppoints, but unique predecessor does.
1309 BB = BB->getUniquePredecessor();
1311 return findStopPoint(BB->getTerminator());
1316 Value *findDbgGlobalDeclare(GlobalVariable *V) {
1317 const Module *M = V->getParent();
1318 NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv");
1322 for (unsigned i = 0, e = NMD->getNumElements(); i != e; ++i) {
1323 DIGlobalVariable DIG(cast_or_null<MDNode>(NMD->getElement(i)));
1326 if (DIG.getGlobal() == V)
1327 return DIG.getNode();
1332 /// Finds the llvm.dbg.declare intrinsic corresponding to this value if any.
1333 /// It looks through pointer casts too.
1334 const DbgDeclareInst *findDbgDeclare(const Value *V, bool stripCasts) {
1336 V = V->stripPointerCasts();
1338 // Look for the bitcast.
1339 for (Value::use_const_iterator I = V->use_begin(), E =V->use_end();
1341 if (isa<BitCastInst>(I)) {
1342 const DbgDeclareInst *DDI = findDbgDeclare(*I, false);
1343 if (DDI) return DDI;
1348 // Find llvm.dbg.declare among uses of the instruction.
1349 for (Value::use_const_iterator I = V->use_begin(), E =V->use_end();
1351 if (const DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(I))
1357 bool getLocationInfo(const Value *V, std::string &DisplayName,
1358 std::string &Type, unsigned &LineNo, std::string &File,
1363 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(const_cast<Value*>(V))) {
1364 Value *DIGV = findDbgGlobalDeclare(GV);
1365 if (!DIGV) return false;
1366 DIGlobalVariable Var(cast<MDNode>(DIGV));
1368 StringRef D = Var.getDisplayName();
1371 LineNo = Var.getLineNumber();
1372 Unit = Var.getCompileUnit();
1373 TypeD = Var.getType();
1375 const DbgDeclareInst *DDI = findDbgDeclare(V);
1376 if (!DDI) return false;
1377 DIVariable Var(cast<MDNode>(DDI->getVariable()));
1379 StringRef D = Var.getName();
1382 LineNo = Var.getLineNumber();
1383 Unit = Var.getCompileUnit();
1384 TypeD = Var.getType();
1387 StringRef T = TypeD.getName();
1390 StringRef F = Unit.getFilename();
1393 StringRef D = Unit.getDirectory();
1399 /// isValidDebugInfoIntrinsic - Return true if SPI is a valid debug
1401 bool isValidDebugInfoIntrinsic(DbgStopPointInst &SPI,
1402 CodeGenOpt::Level OptLev) {
1403 return DIDescriptor::ValidDebugInfo(SPI.getContext(), OptLev);
1406 /// isValidDebugInfoIntrinsic - Return true if FSI is a valid debug
1408 bool isValidDebugInfoIntrinsic(DbgFuncStartInst &FSI,
1409 CodeGenOpt::Level OptLev) {
1410 return DIDescriptor::ValidDebugInfo(FSI.getSubprogram(), OptLev);
1413 /// isValidDebugInfoIntrinsic - Return true if RSI is a valid debug
1415 bool isValidDebugInfoIntrinsic(DbgRegionStartInst &RSI,
1416 CodeGenOpt::Level OptLev) {
1417 return DIDescriptor::ValidDebugInfo(RSI.getContext(), OptLev);
1420 /// isValidDebugInfoIntrinsic - Return true if REI is a valid debug
1422 bool isValidDebugInfoIntrinsic(DbgRegionEndInst &REI,
1423 CodeGenOpt::Level OptLev) {
1424 return DIDescriptor::ValidDebugInfo(REI.getContext(), OptLev);
1428 /// isValidDebugInfoIntrinsic - Return true if DI is a valid debug
1430 bool isValidDebugInfoIntrinsic(DbgDeclareInst &DI,
1431 CodeGenOpt::Level OptLev) {
1432 return DIDescriptor::ValidDebugInfo(DI.getVariable(), OptLev);
1435 /// ExtractDebugLocation - Extract debug location information
1436 /// from llvm.dbg.stoppoint intrinsic.
1437 DebugLoc ExtractDebugLocation(DbgStopPointInst &SPI,
1438 DebugLocTracker &DebugLocInfo) {
1440 Value *Context = SPI.getContext();
1442 // If this location is already tracked then use it.
1443 DebugLocTuple Tuple(cast<MDNode>(Context), NULL, SPI.getLine(),
1445 DenseMap<DebugLocTuple, unsigned>::iterator II
1446 = DebugLocInfo.DebugIdMap.find(Tuple);
1447 if (II != DebugLocInfo.DebugIdMap.end())
1448 return DebugLoc::get(II->second);
1450 // Add a new location entry.
1451 unsigned Id = DebugLocInfo.DebugLocations.size();
1452 DebugLocInfo.DebugLocations.push_back(Tuple);
1453 DebugLocInfo.DebugIdMap[Tuple] = Id;
1455 return DebugLoc::get(Id);
1458 /// ExtractDebugLocation - Extract debug location information
1459 /// from DILocation.
1460 DebugLoc ExtractDebugLocation(DILocation &Loc,
1461 DebugLocTracker &DebugLocInfo) {
1463 MDNode *Context = Loc.getScope().getNode();
1464 MDNode *InlinedLoc = NULL;
1465 if (!Loc.getOrigLocation().isNull())
1466 InlinedLoc = Loc.getOrigLocation().getNode();
1467 // If this location is already tracked then use it.
1468 DebugLocTuple Tuple(Context, InlinedLoc, Loc.getLineNumber(),
1469 Loc.getColumnNumber());
1470 DenseMap<DebugLocTuple, unsigned>::iterator II
1471 = DebugLocInfo.DebugIdMap.find(Tuple);
1472 if (II != DebugLocInfo.DebugIdMap.end())
1473 return DebugLoc::get(II->second);
1475 // Add a new location entry.
1476 unsigned Id = DebugLocInfo.DebugLocations.size();
1477 DebugLocInfo.DebugLocations.push_back(Tuple);
1478 DebugLocInfo.DebugIdMap[Tuple] = Id;
1480 return DebugLoc::get(Id);
1483 /// ExtractDebugLocation - Extract debug location information
1484 /// from llvm.dbg.func_start intrinsic.
1485 DebugLoc ExtractDebugLocation(DbgFuncStartInst &FSI,
1486 DebugLocTracker &DebugLocInfo) {
1488 Value *SP = FSI.getSubprogram();
1490 DISubprogram Subprogram(cast<MDNode>(SP));
1491 unsigned Line = Subprogram.getLineNumber();
1492 DICompileUnit CU(Subprogram.getCompileUnit());
1494 // If this location is already tracked then use it.
1495 DebugLocTuple Tuple(CU.getNode(), NULL, Line, /* Column */ 0);
1496 DenseMap<DebugLocTuple, unsigned>::iterator II
1497 = DebugLocInfo.DebugIdMap.find(Tuple);
1498 if (II != DebugLocInfo.DebugIdMap.end())
1499 return DebugLoc::get(II->second);
1501 // Add a new location entry.
1502 unsigned Id = DebugLocInfo.DebugLocations.size();
1503 DebugLocInfo.DebugLocations.push_back(Tuple);
1504 DebugLocInfo.DebugIdMap[Tuple] = Id;
1506 return DebugLoc::get(Id);
1509 /// getDISubprogram - Find subprogram that is enclosing this scope.
1510 DISubprogram getDISubprogram(MDNode *Scope) {
1511 DIDescriptor D(Scope);
1513 return DISubprogram();
1515 if (D.isCompileUnit())
1516 return DISubprogram();
1518 if (D.isSubprogram())
1519 return DISubprogram(Scope);
1521 if (D.isLexicalBlock())
1522 return getDISubprogram(DILexicalBlock(Scope).getContext().getNode());
1524 return DISubprogram();
1527 /// getDICompositeType - Find underlying composite type.
1528 DICompositeType getDICompositeType(DIType T) {
1530 return DICompositeType();
1532 if (T.isCompositeType())
1533 return DICompositeType(T.getNode());
1535 if (T.isDerivedType())
1536 return getDICompositeType(DIDerivedType(T.getNode()).getTypeDerivedFrom());
1538 return DICompositeType();