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/Target/TargetMachine.h" // FIXME: LAYERING VIOLATION!
17 #include "llvm/Constants.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/Intrinsics.h"
20 #include "llvm/IntrinsicInst.h"
21 #include "llvm/Instructions.h"
22 #include "llvm/Module.h"
23 #include "llvm/Analysis/ValueTracking.h"
24 #include "llvm/ADT/SmallPtrSet.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/Dwarf.h"
27 #include "llvm/Support/DebugLoc.h"
28 #include "llvm/Support/raw_ostream.h"
30 using namespace llvm::dwarf;
32 //===----------------------------------------------------------------------===//
34 //===----------------------------------------------------------------------===//
36 /// ValidDebugInfo - Return true if V represents valid debug info value.
37 /// FIXME : Add DIDescriptor.isValid()
38 bool DIDescriptor::ValidDebugInfo(MDNode *N, unsigned OptLevel) {
44 // Check current version. Allow Version6 for now.
45 unsigned Version = DI.getVersion();
46 if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
49 switch (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->getNumOperands())
87 if (MDString *MDS = dyn_cast_or_null<MDString>(DbgNode->getOperand(Elt)))
88 return MDS->getString();
93 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
97 if (Elt < DbgNode->getNumOperands())
98 if (ConstantInt *CI = dyn_cast<ConstantInt>(DbgNode->getOperand(Elt)))
99 return CI->getZExtValue();
104 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
106 return DIDescriptor();
108 if (Elt < DbgNode->getNumOperands() && DbgNode->getOperand(Elt))
109 return DIDescriptor(dyn_cast<MDNode>(DbgNode->getOperand(Elt)));
111 return DIDescriptor();
114 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
118 if (Elt < DbgNode->getNumOperands())
119 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
123 unsigned DIVariable::getNumAddrElements() const {
124 return DbgNode->getNumOperands()-6;
128 //===----------------------------------------------------------------------===//
130 //===----------------------------------------------------------------------===//
132 /// isBasicType - Return true if the specified tag is legal for
134 bool DIDescriptor::isBasicType() const {
135 assert(!isNull() && "Invalid descriptor!");
136 return getTag() == dwarf::DW_TAG_base_type;
139 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
140 bool DIDescriptor::isDerivedType() const {
141 assert(!isNull() && "Invalid descriptor!");
143 case dwarf::DW_TAG_typedef:
144 case dwarf::DW_TAG_pointer_type:
145 case dwarf::DW_TAG_reference_type:
146 case dwarf::DW_TAG_const_type:
147 case dwarf::DW_TAG_volatile_type:
148 case dwarf::DW_TAG_restrict_type:
149 case dwarf::DW_TAG_member:
150 case dwarf::DW_TAG_inheritance:
153 // CompositeTypes are currently modelled as DerivedTypes.
154 return isCompositeType();
158 /// isCompositeType - Return true if the specified tag is legal for
160 bool DIDescriptor::isCompositeType() const {
161 assert(!isNull() && "Invalid descriptor!");
163 case dwarf::DW_TAG_array_type:
164 case dwarf::DW_TAG_structure_type:
165 case dwarf::DW_TAG_union_type:
166 case dwarf::DW_TAG_enumeration_type:
167 case dwarf::DW_TAG_vector_type:
168 case dwarf::DW_TAG_subroutine_type:
169 case dwarf::DW_TAG_class_type:
176 /// isVariable - Return true if the specified tag is legal for DIVariable.
177 bool DIDescriptor::isVariable() const {
178 assert(!isNull() && "Invalid descriptor!");
180 case dwarf::DW_TAG_auto_variable:
181 case dwarf::DW_TAG_arg_variable:
182 case dwarf::DW_TAG_return_variable:
189 /// isType - Return true if the specified tag is legal for DIType.
190 bool DIDescriptor::isType() const {
191 return isBasicType() || isCompositeType() || isDerivedType();
194 /// isSubprogram - Return true if the specified tag is legal for
196 bool DIDescriptor::isSubprogram() const {
197 assert(!isNull() && "Invalid descriptor!");
198 return getTag() == dwarf::DW_TAG_subprogram;
201 /// isGlobalVariable - Return true if the specified tag is legal for
202 /// DIGlobalVariable.
203 bool DIDescriptor::isGlobalVariable() const {
204 assert(!isNull() && "Invalid descriptor!");
205 return getTag() == dwarf::DW_TAG_variable;
208 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
209 bool DIDescriptor::isGlobal() const {
210 return isGlobalVariable();
213 /// isScope - Return true if the specified tag is one of the scope
215 bool DIDescriptor::isScope() const {
216 assert(!isNull() && "Invalid descriptor!");
218 case dwarf::DW_TAG_compile_unit:
219 case dwarf::DW_TAG_lexical_block:
220 case dwarf::DW_TAG_subprogram:
221 case dwarf::DW_TAG_namespace:
229 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
230 bool DIDescriptor::isCompileUnit() const {
231 assert(!isNull() && "Invalid descriptor!");
232 return getTag() == dwarf::DW_TAG_compile_unit;
235 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
236 bool DIDescriptor::isNameSpace() const {
237 assert(!isNull() && "Invalid descriptor!");
238 return getTag() == dwarf::DW_TAG_namespace;
241 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
242 bool DIDescriptor::isLexicalBlock() const {
243 assert(!isNull() && "Invalid descriptor!");
244 return getTag() == dwarf::DW_TAG_lexical_block;
247 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
248 bool DIDescriptor::isSubrange() const {
249 assert(!isNull() && "Invalid descriptor!");
250 return getTag() == dwarf::DW_TAG_subrange_type;
253 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
254 bool DIDescriptor::isEnumerator() const {
255 assert(!isNull() && "Invalid descriptor!");
256 return getTag() == dwarf::DW_TAG_enumerator;
259 //===----------------------------------------------------------------------===//
260 // Simple Descriptor Constructors and other Methods
261 //===----------------------------------------------------------------------===//
263 DIType::DIType(MDNode *N) : DIDescriptor(N) {
265 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
270 unsigned DIArray::getNumElements() const {
271 assert(DbgNode && "Invalid DIArray");
272 return DbgNode->getNumOperands();
275 /// replaceAllUsesWith - Replace all uses of debug info referenced by
276 /// this descriptor. After this completes, the current debug info value
278 void DIDerivedType::replaceAllUsesWith(DIDescriptor &D) {
282 assert(!D.isNull() && "Can not replace with null");
284 // Since we use a TrackingVH for the node, its easy for clients to manufacture
285 // legitimate situations where they want to replaceAllUsesWith() on something
286 // which, due to uniquing, has merged with the source. We shield clients from
287 // this detail by allowing a value to be replaced with replaceAllUsesWith()
289 if (getNode() != D.getNode()) {
290 MDNode *Node = DbgNode;
291 Node->replaceAllUsesWith(D.getNode());
296 /// Verify - Verify that a compile unit is well formed.
297 bool DICompileUnit::Verify() const {
300 StringRef N = getFilename();
303 // It is possible that directory and produce string is empty.
307 /// Verify - Verify that a type descriptor is well formed.
308 bool DIType::Verify() const {
311 if (getContext().isNull())
314 DICompileUnit CU = getCompileUnit();
315 if (!CU.isNull() && !CU.Verify())
320 /// Verify - Verify that a composite type descriptor is well formed.
321 bool DICompositeType::Verify() const {
324 if (getContext().isNull())
327 DICompileUnit CU = getCompileUnit();
328 if (!CU.isNull() && !CU.Verify())
333 /// Verify - Verify that a subprogram descriptor is well formed.
334 bool DISubprogram::Verify() const {
338 if (getContext().isNull())
341 DICompileUnit CU = getCompileUnit();
345 DICompositeType Ty = getType();
346 if (!Ty.isNull() && !Ty.Verify())
351 /// Verify - Verify that a global variable descriptor is well formed.
352 bool DIGlobalVariable::Verify() const {
356 if (getDisplayName().empty())
359 if (getContext().isNull())
362 DICompileUnit CU = getCompileUnit();
363 if (!CU.isNull() && !CU.Verify())
366 DIType Ty = getType();
376 /// Verify - Verify that a variable descriptor is well formed.
377 bool DIVariable::Verify() const {
381 if (getContext().isNull())
384 DIType Ty = getType();
391 /// getOriginalTypeSize - If this type is derived from a base type then
392 /// return base type size.
393 uint64_t DIDerivedType::getOriginalTypeSize() const {
394 unsigned Tag = getTag();
395 if (Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef ||
396 Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
397 Tag == dwarf::DW_TAG_restrict_type) {
398 DIType BaseType = getTypeDerivedFrom();
399 // If this type is not derived from any type then take conservative
401 if (BaseType.isNull())
402 return getSizeInBits();
403 if (BaseType.isDerivedType())
404 return DIDerivedType(BaseType.getNode()).getOriginalTypeSize();
406 return BaseType.getSizeInBits();
409 return getSizeInBits();
412 /// describes - Return true if this subprogram provides debugging
413 /// information for the function F.
414 bool DISubprogram::describes(const Function *F) {
415 assert(F && "Invalid function");
416 StringRef Name = getLinkageName();
419 if (F->getName() == Name)
424 StringRef DIScope::getFilename() const {
425 if (isLexicalBlock())
426 return DILexicalBlock(DbgNode).getFilename();
428 return DISubprogram(DbgNode).getFilename();
430 return DICompileUnit(DbgNode).getFilename();
432 return DINameSpace(DbgNode).getFilename();
433 assert(0 && "Invalid DIScope!");
437 StringRef DIScope::getDirectory() const {
438 if (isLexicalBlock())
439 return DILexicalBlock(DbgNode).getDirectory();
441 return DISubprogram(DbgNode).getDirectory();
443 return DICompileUnit(DbgNode).getDirectory();
445 return DINameSpace(DbgNode).getDirectory();
446 assert(0 && "Invalid DIScope!");
450 //===----------------------------------------------------------------------===//
451 // DIDescriptor: dump routines for all descriptors.
452 //===----------------------------------------------------------------------===//
455 /// dump - Print descriptor.
456 void DIDescriptor::dump() const {
457 dbgs() << "[" << dwarf::TagString(getTag()) << "] ";
458 dbgs().write_hex((intptr_t) &*DbgNode) << ']';
461 /// dump - Print compile unit.
462 void DICompileUnit::dump() const {
464 dbgs() << " [" << dwarf::LanguageString(getLanguage()) << "] ";
466 dbgs() << " [" << getDirectory() << "/" << getFilename() << " ]";
469 /// dump - Print type.
470 void DIType::dump() const {
471 if (isNull()) return;
473 StringRef Res = getName();
475 dbgs() << " [" << Res << "] ";
477 unsigned Tag = getTag();
478 dbgs() << " [" << dwarf::TagString(Tag) << "] ";
480 // TODO : Print context
481 getCompileUnit().dump();
483 << getLineNumber() << ", "
484 << getSizeInBits() << ", "
485 << getAlignInBits() << ", "
490 dbgs() << " [private] ";
491 else if (isProtected())
492 dbgs() << " [protected] ";
498 DIBasicType(DbgNode).dump();
499 else if (isDerivedType())
500 DIDerivedType(DbgNode).dump();
501 else if (isCompositeType())
502 DICompositeType(DbgNode).dump();
504 dbgs() << "Invalid DIType\n";
511 /// dump - Print basic type.
512 void DIBasicType::dump() const {
513 dbgs() << " [" << dwarf::AttributeEncodingString(getEncoding()) << "] ";
516 /// dump - Print derived type.
517 void DIDerivedType::dump() const {
518 dbgs() << "\n\t Derived From: "; getTypeDerivedFrom().dump();
521 /// dump - Print composite type.
522 void DICompositeType::dump() const {
523 DIArray A = getTypeArray();
526 dbgs() << " [" << A.getNumElements() << " elements]";
529 /// dump - Print global.
530 void DIGlobal::dump() const {
531 StringRef Res = getName();
533 dbgs() << " [" << Res << "] ";
535 unsigned Tag = getTag();
536 dbgs() << " [" << dwarf::TagString(Tag) << "] ";
538 // TODO : Print context
539 getCompileUnit().dump();
540 dbgs() << " [" << getLineNumber() << "] ";
543 dbgs() << " [local] ";
548 if (isGlobalVariable())
549 DIGlobalVariable(DbgNode).dump();
554 /// dump - Print subprogram.
555 void DISubprogram::dump() const {
556 StringRef Res = getName();
558 dbgs() << " [" << Res << "] ";
560 unsigned Tag = getTag();
561 dbgs() << " [" << dwarf::TagString(Tag) << "] ";
563 // TODO : Print context
564 getCompileUnit().dump();
565 dbgs() << " [" << getLineNumber() << "] ";
568 dbgs() << " [local] ";
576 /// dump - Print global variable.
577 void DIGlobalVariable::dump() const {
583 /// dump - Print variable.
584 void DIVariable::dump() const {
585 StringRef Res = getName();
587 dbgs() << " [" << Res << "] ";
589 getCompileUnit().dump();
590 dbgs() << " [" << getLineNumber() << "] ";
594 // FIXME: Dump complex addresses
597 //===----------------------------------------------------------------------===//
598 // DIFactory: Basic Helpers
599 //===----------------------------------------------------------------------===//
601 DIFactory::DIFactory(Module &m)
602 : M(m), VMContext(M.getContext()), DeclareFn(0) {
603 EmptyStructPtr = PointerType::getUnqual(StructType::get(VMContext));
606 Constant *DIFactory::GetTagConstant(unsigned TAG) {
607 assert((TAG & LLVMDebugVersionMask) == 0 &&
608 "Tag too large for debug encoding!");
609 return ConstantInt::get(Type::getInt32Ty(VMContext), TAG | LLVMDebugVersion);
612 //===----------------------------------------------------------------------===//
613 // DIFactory: Primary Constructors
614 //===----------------------------------------------------------------------===//
616 /// GetOrCreateArray - Create an descriptor for an array of descriptors.
617 /// This implicitly uniques the arrays created.
618 DIArray DIFactory::GetOrCreateArray(DIDescriptor *Tys, unsigned NumTys) {
619 SmallVector<Value*, 16> Elts;
622 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
624 for (unsigned i = 0; i != NumTys; ++i)
625 Elts.push_back(Tys[i].getNode());
627 return DIArray(MDNode::get(VMContext,Elts.data(), Elts.size()));
630 /// GetOrCreateSubrange - Create a descriptor for a value range. This
631 /// implicitly uniques the values returned.
632 DISubrange DIFactory::GetOrCreateSubrange(int64_t Lo, int64_t Hi) {
634 GetTagConstant(dwarf::DW_TAG_subrange_type),
635 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
636 ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
639 return DISubrange(MDNode::get(VMContext, &Elts[0], 3));
644 /// CreateCompileUnit - Create a new descriptor for the specified compile
645 /// unit. Note that this does not unique compile units within the module.
646 DICompileUnit DIFactory::CreateCompileUnit(unsigned LangID,
653 unsigned RunTimeVer) {
655 GetTagConstant(dwarf::DW_TAG_compile_unit),
656 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
657 ConstantInt::get(Type::getInt32Ty(VMContext), LangID),
658 MDString::get(VMContext, Filename),
659 MDString::get(VMContext, Directory),
660 MDString::get(VMContext, Producer),
661 ConstantInt::get(Type::getInt1Ty(VMContext), isMain),
662 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
663 MDString::get(VMContext, Flags),
664 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer)
667 return DICompileUnit(MDNode::get(VMContext, &Elts[0], 10));
670 /// CreateEnumerator - Create a single enumerator value.
671 DIEnumerator DIFactory::CreateEnumerator(StringRef Name, uint64_t Val){
673 GetTagConstant(dwarf::DW_TAG_enumerator),
674 MDString::get(VMContext, Name),
675 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
677 return DIEnumerator(MDNode::get(VMContext, &Elts[0], 3));
681 /// CreateBasicType - Create a basic type like int, float, etc.
682 DIBasicType DIFactory::CreateBasicType(DIDescriptor Context,
684 DICompileUnit CompileUnit,
687 uint64_t AlignInBits,
688 uint64_t OffsetInBits, unsigned Flags,
691 GetTagConstant(dwarf::DW_TAG_base_type),
693 MDString::get(VMContext, Name),
694 CompileUnit.getNode(),
695 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
696 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
697 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
698 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
699 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
700 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
702 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
706 /// CreateBasicType - Create a basic type like int, float, etc.
707 DIBasicType DIFactory::CreateBasicTypeEx(DIDescriptor Context,
709 DICompileUnit CompileUnit,
711 Constant *SizeInBits,
712 Constant *AlignInBits,
713 Constant *OffsetInBits, unsigned Flags,
716 GetTagConstant(dwarf::DW_TAG_base_type),
718 MDString::get(VMContext, Name),
719 CompileUnit.getNode(),
720 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
724 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
725 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
727 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
731 /// CreateDerivedType - Create a derived type like const qualified type,
732 /// pointer, typedef, etc.
733 DIDerivedType DIFactory::CreateDerivedType(unsigned Tag,
734 DIDescriptor Context,
736 DICompileUnit CompileUnit,
739 uint64_t AlignInBits,
740 uint64_t OffsetInBits,
742 DIType DerivedFrom) {
746 MDString::get(VMContext, Name),
747 CompileUnit.getNode(),
748 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
749 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
750 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
751 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
752 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
753 DerivedFrom.getNode(),
755 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
759 /// CreateDerivedType - Create a derived type like const qualified type,
760 /// pointer, typedef, etc.
761 DIDerivedType DIFactory::CreateDerivedTypeEx(unsigned Tag,
762 DIDescriptor Context,
764 DICompileUnit CompileUnit,
766 Constant *SizeInBits,
767 Constant *AlignInBits,
768 Constant *OffsetInBits,
770 DIType DerivedFrom) {
774 MDString::get(VMContext, Name),
775 CompileUnit.getNode(),
776 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
780 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
781 DerivedFrom.getNode(),
783 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
787 /// CreateCompositeType - Create a composite type like array, struct, etc.
788 DICompositeType DIFactory::CreateCompositeType(unsigned Tag,
789 DIDescriptor Context,
791 DICompileUnit CompileUnit,
794 uint64_t AlignInBits,
795 uint64_t OffsetInBits,
799 unsigned RuntimeLang) {
804 MDString::get(VMContext, Name),
805 CompileUnit.getNode(),
806 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
807 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
808 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
809 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
810 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
811 DerivedFrom.getNode(),
813 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
815 return DICompositeType(MDNode::get(VMContext, &Elts[0], 12));
819 /// CreateCompositeType - Create a composite type like array, struct, etc.
820 DICompositeType DIFactory::CreateCompositeTypeEx(unsigned Tag,
821 DIDescriptor Context,
823 DICompileUnit CompileUnit,
825 Constant *SizeInBits,
826 Constant *AlignInBits,
827 Constant *OffsetInBits,
831 unsigned RuntimeLang) {
836 MDString::get(VMContext, Name),
837 CompileUnit.getNode(),
838 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
842 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
843 DerivedFrom.getNode(),
845 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
847 return DICompositeType(MDNode::get(VMContext, &Elts[0], 12));
851 /// CreateSubprogram - Create a new descriptor for the specified subprogram.
852 /// See comments in DISubprogram for descriptions of these fields. This
853 /// method does not unique the generated descriptors.
854 DISubprogram DIFactory::CreateSubprogram(DIDescriptor Context,
856 StringRef DisplayName,
857 StringRef LinkageName,
858 DICompileUnit CompileUnit,
859 unsigned LineNo, DIType Type,
862 unsigned VK, unsigned VIndex,
863 DIType ContainingType) {
866 GetTagConstant(dwarf::DW_TAG_subprogram),
867 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
869 MDString::get(VMContext, Name),
870 MDString::get(VMContext, DisplayName),
871 MDString::get(VMContext, LinkageName),
872 CompileUnit.getNode(),
873 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
875 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
876 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
877 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
878 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
879 ContainingType.getNode()
881 return DISubprogram(MDNode::get(VMContext, &Elts[0], 14));
884 /// CreateSubprogramDefinition - Create new subprogram descriptor for the
885 /// given declaration.
886 DISubprogram DIFactory::CreateSubprogramDefinition(DISubprogram &SPDeclaration) {
887 if (SPDeclaration.isDefinition())
888 return DISubprogram(SPDeclaration.getNode());
890 MDNode *DeclNode = SPDeclaration.getNode();
892 GetTagConstant(dwarf::DW_TAG_subprogram),
893 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
894 DeclNode->getOperand(2), // Context
895 DeclNode->getOperand(3), // Name
896 DeclNode->getOperand(4), // DisplayName
897 DeclNode->getOperand(5), // LinkageName
898 DeclNode->getOperand(6), // CompileUnit
899 DeclNode->getOperand(7), // LineNo
900 DeclNode->getOperand(8), // Type
901 DeclNode->getOperand(9), // isLocalToUnit
902 ConstantInt::get(Type::getInt1Ty(VMContext), true),
903 DeclNode->getOperand(11), // Virtuality
904 DeclNode->getOperand(12), // VIndex
905 DeclNode->getOperand(13) // Containting Type
907 return DISubprogram(MDNode::get(VMContext, &Elts[0], 14));
910 /// CreateGlobalVariable - Create a new descriptor for the specified global.
912 DIFactory::CreateGlobalVariable(DIDescriptor Context, StringRef Name,
913 StringRef DisplayName,
914 StringRef LinkageName,
915 DICompileUnit CompileUnit,
916 unsigned LineNo, DIType Type,bool isLocalToUnit,
917 bool isDefinition, llvm::GlobalVariable *Val) {
919 GetTagConstant(dwarf::DW_TAG_variable),
920 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
922 MDString::get(VMContext, Name),
923 MDString::get(VMContext, DisplayName),
924 MDString::get(VMContext, LinkageName),
925 CompileUnit.getNode(),
926 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
928 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
929 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
933 Value *const *Vs = &Elts[0];
934 MDNode *Node = MDNode::get(VMContext,Vs, 12);
936 // Create a named metadata so that we do not lose this mdnode.
937 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
938 NMD->addOperand(Node);
940 return DIGlobalVariable(Node);
944 /// CreateVariable - Create a new descriptor for the specified variable.
945 DIVariable DIFactory::CreateVariable(unsigned Tag, DIDescriptor Context,
947 DICompileUnit CompileUnit, unsigned LineNo,
952 MDString::get(VMContext, Name),
953 CompileUnit.getNode(),
954 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
957 return DIVariable(MDNode::get(VMContext, &Elts[0], 6));
961 /// CreateComplexVariable - Create a new descriptor for the specified variable
962 /// which has a complex address expression for its address.
963 DIVariable DIFactory::CreateComplexVariable(unsigned Tag, DIDescriptor Context,
964 const std::string &Name,
965 DICompileUnit CompileUnit,
967 DIType Type, SmallVector<Value *, 9> &addr) {
968 SmallVector<Value *, 9> Elts;
969 Elts.push_back(GetTagConstant(Tag));
970 Elts.push_back(Context.getNode());
971 Elts.push_back(MDString::get(VMContext, Name));
972 Elts.push_back(CompileUnit.getNode());
973 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext), LineNo));
974 Elts.push_back(Type.getNode());
975 Elts.insert(Elts.end(), addr.begin(), addr.end());
977 return DIVariable(MDNode::get(VMContext, &Elts[0], 6+addr.size()));
981 /// CreateBlock - This creates a descriptor for a lexical block with the
982 /// specified parent VMContext.
983 DILexicalBlock DIFactory::CreateLexicalBlock(DIDescriptor Context) {
985 GetTagConstant(dwarf::DW_TAG_lexical_block),
988 return DILexicalBlock(MDNode::get(VMContext, &Elts[0], 2));
991 /// CreateNameSpace - This creates new descriptor for a namespace
992 /// with the specified parent context.
993 DINameSpace DIFactory::CreateNameSpace(DIDescriptor Context, StringRef Name,
994 DICompileUnit CompileUnit,
997 GetTagConstant(dwarf::DW_TAG_namespace),
999 MDString::get(VMContext, Name),
1000 CompileUnit.getNode(),
1001 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1003 return DINameSpace(MDNode::get(VMContext, &Elts[0], 5));
1006 /// CreateLocation - Creates a debug info location.
1007 DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
1008 DIScope S, DILocation OrigLoc) {
1010 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1011 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
1015 return DILocation(MDNode::get(VMContext, &Elts[0], 4));
1018 /// CreateLocation - Creates a debug info location.
1019 DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
1020 DIScope S, MDNode *OrigLoc) {
1022 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1023 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
1027 return DILocation(MDNode::get(VMContext, &Elts[0], 4));
1030 //===----------------------------------------------------------------------===//
1031 // DIFactory: Routines for inserting code into a function
1032 //===----------------------------------------------------------------------===//
1034 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1035 Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
1036 Instruction *InsertBefore) {
1037 // Cast the storage to a {}* for the call to llvm.dbg.declare.
1038 Storage = new BitCastInst(Storage, EmptyStructPtr, "", InsertBefore);
1041 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1043 Value *Args[] = { Storage, D.getNode() };
1044 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertBefore);
1047 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1048 Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
1049 BasicBlock *InsertAtEnd) {
1050 // Cast the storage to a {}* for the call to llvm.dbg.declare.
1051 Storage = new BitCastInst(Storage, EmptyStructPtr, "", InsertAtEnd);
1054 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1056 Value *Args[] = { Storage, D.getNode() };
1057 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertAtEnd);
1060 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1061 Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, Value *Offset,
1063 Instruction *InsertBefore) {
1064 assert(V && "no value passed to dbg.value");
1065 assert(Offset->getType() == Type::getInt64Ty(V->getContext()) &&
1066 "offset must be i64");
1068 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1070 Value *Elts[] = { V };
1071 Value *Args[] = { MDNode::get(V->getContext(), Elts, 1), Offset,
1073 return CallInst::Create(ValueFn, Args, Args+3, "", InsertBefore);
1076 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1077 Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, Value *Offset,
1079 BasicBlock *InsertAtEnd) {
1080 assert(V && "no value passed to dbg.value");
1081 assert(Offset->getType() == Type::getInt64Ty(V->getContext()) &&
1082 "offset must be i64");
1084 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1086 Value *Elts[] = { V };
1087 Value *Args[] = { MDNode::get(V->getContext(), Elts, 1), Offset,
1089 return CallInst::Create(ValueFn, Args, Args+3, "", InsertAtEnd);
1092 //===----------------------------------------------------------------------===//
1093 // DebugInfoFinder implementations.
1094 //===----------------------------------------------------------------------===//
1096 /// processModule - Process entire module and collect debug info.
1097 void DebugInfoFinder::processModule(Module &M) {
1098 unsigned MDDbgKind = M.getMDKindID("dbg");
1100 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1101 for (Function::iterator FI = (*I).begin(), FE = (*I).end(); FI != FE; ++FI)
1102 for (BasicBlock::iterator BI = (*FI).begin(), BE = (*FI).end(); BI != BE;
1104 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
1105 processDeclare(DDI);
1106 else if (MDNode *L = BI->getMetadata(MDDbgKind))
1107 processLocation(DILocation(L));
1110 NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv");
1114 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1115 DIGlobalVariable DIG(cast<MDNode>(NMD->getOperand(i)));
1116 if (addGlobalVariable(DIG)) {
1117 addCompileUnit(DIG.getCompileUnit());
1118 processType(DIG.getType());
1123 /// processLocation - Process DILocation.
1124 void DebugInfoFinder::processLocation(DILocation Loc) {
1125 if (Loc.isNull()) return;
1126 DIScope S(Loc.getScope().getNode());
1127 if (S.isNull()) return;
1128 if (S.isCompileUnit())
1129 addCompileUnit(DICompileUnit(S.getNode()));
1130 else if (S.isSubprogram())
1131 processSubprogram(DISubprogram(S.getNode()));
1132 else if (S.isLexicalBlock())
1133 processLexicalBlock(DILexicalBlock(S.getNode()));
1134 processLocation(Loc.getOrigLocation());
1137 /// processType - Process DIType.
1138 void DebugInfoFinder::processType(DIType DT) {
1142 addCompileUnit(DT.getCompileUnit());
1143 if (DT.isCompositeType()) {
1144 DICompositeType DCT(DT.getNode());
1145 processType(DCT.getTypeDerivedFrom());
1146 DIArray DA = DCT.getTypeArray();
1148 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1149 DIDescriptor D = DA.getElement(i);
1150 DIType TypeE = DIType(D.getNode());
1151 if (!TypeE.isNull())
1154 processSubprogram(DISubprogram(D.getNode()));
1156 } else if (DT.isDerivedType()) {
1157 DIDerivedType DDT(DT.getNode());
1159 processType(DDT.getTypeDerivedFrom());
1163 /// processLexicalBlock
1164 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
1167 DIScope Context = LB.getContext();
1168 if (Context.isLexicalBlock())
1169 return processLexicalBlock(DILexicalBlock(Context.getNode()));
1171 return processSubprogram(DISubprogram(Context.getNode()));
1174 /// processSubprogram - Process DISubprogram.
1175 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1178 if (!addSubprogram(SP))
1180 addCompileUnit(SP.getCompileUnit());
1181 processType(SP.getType());
1184 /// processDeclare - Process DbgDeclareInst.
1185 void DebugInfoFinder::processDeclare(DbgDeclareInst *DDI) {
1186 DIVariable DV(cast<MDNode>(DDI->getVariable()));
1190 if (!NodesSeen.insert(DV.getNode()))
1193 addCompileUnit(DV.getCompileUnit());
1194 processType(DV.getType());
1197 /// addType - Add type into Tys.
1198 bool DebugInfoFinder::addType(DIType DT) {
1202 if (!NodesSeen.insert(DT.getNode()))
1205 TYs.push_back(DT.getNode());
1209 /// addCompileUnit - Add compile unit into CUs.
1210 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1214 if (!NodesSeen.insert(CU.getNode()))
1217 CUs.push_back(CU.getNode());
1221 /// addGlobalVariable - Add global variable into GVs.
1222 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1226 if (!NodesSeen.insert(DIG.getNode()))
1229 GVs.push_back(DIG.getNode());
1233 // addSubprogram - Add subprgoram into SPs.
1234 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1238 if (!NodesSeen.insert(SP.getNode()))
1241 SPs.push_back(SP.getNode());
1245 /// findStopPoint - Find the stoppoint coressponding to this instruction, that
1246 /// is the stoppoint that dominates this instruction.
1247 const DbgStopPointInst *llvm::findStopPoint(const Instruction *Inst) {
1248 if (const DbgStopPointInst *DSI = dyn_cast<DbgStopPointInst>(Inst))
1251 const BasicBlock *BB = Inst->getParent();
1252 BasicBlock::const_iterator I = Inst, B;
1256 // A BB consisting only of a terminator can't have a stoppoint.
1259 if (const DbgStopPointInst *DSI = dyn_cast<DbgStopPointInst>(I))
1263 // This BB didn't have a stoppoint: if there is only one predecessor, look
1264 // for a stoppoint there. We could use getIDom(), but that would require
1266 BB = I->getParent()->getUniquePredecessor();
1268 I = BB->getTerminator();
1274 /// findBBStopPoint - Find the stoppoint corresponding to first real
1275 /// (non-debug intrinsic) instruction in this Basic Block, and return the
1276 /// stoppoint for it.
1277 const DbgStopPointInst *llvm::findBBStopPoint(const BasicBlock *BB) {
1278 for(BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1279 if (const DbgStopPointInst *DSI = dyn_cast<DbgStopPointInst>(I))
1282 // Fallback to looking for stoppoint of unique predecessor. Useful if this
1283 // BB contains no stoppoints, but unique predecessor does.
1284 BB = BB->getUniquePredecessor();
1286 return findStopPoint(BB->getTerminator());
1291 Value *llvm::findDbgGlobalDeclare(GlobalVariable *V) {
1292 const Module *M = V->getParent();
1293 NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv");
1297 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1298 DIGlobalVariable DIG(cast_or_null<MDNode>(NMD->getOperand(i)));
1301 if (DIG.getGlobal() == V)
1302 return DIG.getNode();
1307 /// Finds the llvm.dbg.declare intrinsic corresponding to this value if any.
1308 /// It looks through pointer casts too.
1309 const DbgDeclareInst *llvm::findDbgDeclare(const Value *V, bool stripCasts) {
1311 V = V->stripPointerCasts();
1313 // Look for the bitcast.
1314 for (Value::use_const_iterator I = V->use_begin(), E =V->use_end();
1316 if (isa<BitCastInst>(I)) {
1317 const DbgDeclareInst *DDI = findDbgDeclare(*I, false);
1318 if (DDI) return DDI;
1323 // Find llvm.dbg.declare among uses of the instruction.
1324 for (Value::use_const_iterator I = V->use_begin(), E =V->use_end();
1326 if (const DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(I))
1332 bool llvm::getLocationInfo(const Value *V, std::string &DisplayName,
1333 std::string &Type, unsigned &LineNo,
1334 std::string &File, std::string &Dir) {
1338 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(const_cast<Value*>(V))) {
1339 Value *DIGV = findDbgGlobalDeclare(GV);
1340 if (!DIGV) return false;
1341 DIGlobalVariable Var(cast<MDNode>(DIGV));
1343 StringRef D = Var.getDisplayName();
1346 LineNo = Var.getLineNumber();
1347 Unit = Var.getCompileUnit();
1348 TypeD = Var.getType();
1350 const DbgDeclareInst *DDI = findDbgDeclare(V);
1351 if (!DDI) return false;
1352 DIVariable Var(cast<MDNode>(DDI->getVariable()));
1354 StringRef D = Var.getName();
1357 LineNo = Var.getLineNumber();
1358 Unit = Var.getCompileUnit();
1359 TypeD = Var.getType();
1362 StringRef T = TypeD.getName();
1365 StringRef F = Unit.getFilename();
1368 StringRef D = Unit.getDirectory();
1374 /// ExtractDebugLocation - Extract debug location information
1375 /// from llvm.dbg.stoppoint intrinsic.
1376 DebugLoc llvm::ExtractDebugLocation(DbgStopPointInst &SPI,
1377 DebugLocTracker &DebugLocInfo) {
1379 Value *Context = SPI.getContext();
1381 // If this location is already tracked then use it.
1382 DebugLocTuple Tuple(cast<MDNode>(Context), NULL, SPI.getLine(),
1384 DenseMap<DebugLocTuple, unsigned>::iterator II
1385 = DebugLocInfo.DebugIdMap.find(Tuple);
1386 if (II != DebugLocInfo.DebugIdMap.end())
1387 return DebugLoc::get(II->second);
1389 // Add a new location entry.
1390 unsigned Id = DebugLocInfo.DebugLocations.size();
1391 DebugLocInfo.DebugLocations.push_back(Tuple);
1392 DebugLocInfo.DebugIdMap[Tuple] = Id;
1394 return DebugLoc::get(Id);
1397 /// ExtractDebugLocation - Extract debug location information
1398 /// from DILocation.
1399 DebugLoc llvm::ExtractDebugLocation(DILocation &Loc,
1400 DebugLocTracker &DebugLocInfo) {
1402 MDNode *Context = Loc.getScope().getNode();
1403 MDNode *InlinedLoc = NULL;
1404 if (!Loc.getOrigLocation().isNull())
1405 InlinedLoc = Loc.getOrigLocation().getNode();
1406 // If this location is already tracked then use it.
1407 DebugLocTuple Tuple(Context, InlinedLoc, Loc.getLineNumber(),
1408 Loc.getColumnNumber());
1409 DenseMap<DebugLocTuple, unsigned>::iterator II
1410 = DebugLocInfo.DebugIdMap.find(Tuple);
1411 if (II != DebugLocInfo.DebugIdMap.end())
1412 return DebugLoc::get(II->second);
1414 // Add a new location entry.
1415 unsigned Id = DebugLocInfo.DebugLocations.size();
1416 DebugLocInfo.DebugLocations.push_back(Tuple);
1417 DebugLocInfo.DebugIdMap[Tuple] = Id;
1419 return DebugLoc::get(Id);
1422 /// ExtractDebugLocation - Extract debug location information
1423 /// from llvm.dbg.func_start intrinsic.
1424 DebugLoc llvm::ExtractDebugLocation(DbgFuncStartInst &FSI,
1425 DebugLocTracker &DebugLocInfo) {
1427 Value *SP = FSI.getSubprogram();
1429 DISubprogram Subprogram(cast<MDNode>(SP));
1430 unsigned Line = Subprogram.getLineNumber();
1431 DICompileUnit CU(Subprogram.getCompileUnit());
1433 // If this location is already tracked then use it.
1434 DebugLocTuple Tuple(CU.getNode(), NULL, Line, /* Column */ 0);
1435 DenseMap<DebugLocTuple, unsigned>::iterator II
1436 = DebugLocInfo.DebugIdMap.find(Tuple);
1437 if (II != DebugLocInfo.DebugIdMap.end())
1438 return DebugLoc::get(II->second);
1440 // Add a new location entry.
1441 unsigned Id = DebugLocInfo.DebugLocations.size();
1442 DebugLocInfo.DebugLocations.push_back(Tuple);
1443 DebugLocInfo.DebugIdMap[Tuple] = Id;
1445 return DebugLoc::get(Id);
1448 /// getDISubprogram - Find subprogram that is enclosing this scope.
1449 DISubprogram llvm::getDISubprogram(MDNode *Scope) {
1450 DIDescriptor D(Scope);
1452 return DISubprogram();
1454 if (D.isCompileUnit())
1455 return DISubprogram();
1457 if (D.isSubprogram())
1458 return DISubprogram(Scope);
1460 if (D.isLexicalBlock())
1461 return getDISubprogram(DILexicalBlock(Scope).getContext().getNode());
1463 return DISubprogram();
1466 /// getDICompositeType - Find underlying composite type.
1467 DICompositeType llvm::getDICompositeType(DIType T) {
1469 return DICompositeType();
1471 if (T.isCompositeType())
1472 return DICompositeType(T.getNode());
1474 if (T.isDerivedType())
1475 return getDICompositeType(DIDerivedType(T.getNode()).getTypeDerivedFrom());
1477 return DICompositeType();