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/raw_ostream.h"
29 using namespace llvm::dwarf;
31 //===----------------------------------------------------------------------===//
33 //===----------------------------------------------------------------------===//
36 DIDescriptor::getStringField(unsigned Elt) const {
40 if (Elt < DbgNode->getNumOperands())
41 if (MDString *MDS = dyn_cast_or_null<MDString>(DbgNode->getOperand(Elt)))
42 return MDS->getString();
47 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
51 if (Elt < DbgNode->getNumOperands())
52 if (ConstantInt *CI = dyn_cast<ConstantInt>(DbgNode->getOperand(Elt)))
53 return CI->getZExtValue();
58 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
60 return DIDescriptor();
62 if (Elt < DbgNode->getNumOperands())
63 return DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
64 return DIDescriptor();
67 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
71 if (Elt < DbgNode->getNumOperands())
72 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
76 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
80 if (Elt < DbgNode->getNumOperands())
81 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
85 unsigned DIVariable::getNumAddrElements() const {
86 return DbgNode->getNumOperands()-6;
90 //===----------------------------------------------------------------------===//
92 //===----------------------------------------------------------------------===//
94 /// isBasicType - Return true if the specified tag is legal for
96 bool DIDescriptor::isBasicType() const {
97 return DbgNode && getTag() == dwarf::DW_TAG_base_type;
100 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
101 bool DIDescriptor::isDerivedType() const {
102 if (!DbgNode) return false;
104 case dwarf::DW_TAG_typedef:
105 case dwarf::DW_TAG_pointer_type:
106 case dwarf::DW_TAG_reference_type:
107 case dwarf::DW_TAG_const_type:
108 case dwarf::DW_TAG_volatile_type:
109 case dwarf::DW_TAG_restrict_type:
110 case dwarf::DW_TAG_member:
111 case dwarf::DW_TAG_inheritance:
114 // CompositeTypes are currently modelled as DerivedTypes.
115 return isCompositeType();
119 /// isCompositeType - Return true if the specified tag is legal for
121 bool DIDescriptor::isCompositeType() const {
122 if (!DbgNode) return false;
124 case dwarf::DW_TAG_array_type:
125 case dwarf::DW_TAG_structure_type:
126 case dwarf::DW_TAG_union_type:
127 case dwarf::DW_TAG_enumeration_type:
128 case dwarf::DW_TAG_vector_type:
129 case dwarf::DW_TAG_subroutine_type:
130 case dwarf::DW_TAG_class_type:
137 /// isVariable - Return true if the specified tag is legal for DIVariable.
138 bool DIDescriptor::isVariable() const {
139 if (!DbgNode) return false;
141 case dwarf::DW_TAG_auto_variable:
142 case dwarf::DW_TAG_arg_variable:
143 case dwarf::DW_TAG_return_variable:
150 /// isType - Return true if the specified tag is legal for DIType.
151 bool DIDescriptor::isType() const {
152 return isBasicType() || isCompositeType() || isDerivedType();
155 /// isSubprogram - Return true if the specified tag is legal for
157 bool DIDescriptor::isSubprogram() const {
158 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
161 /// isGlobalVariable - Return true if the specified tag is legal for
162 /// DIGlobalVariable.
163 bool DIDescriptor::isGlobalVariable() const {
164 return DbgNode && getTag() == dwarf::DW_TAG_variable;
167 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
168 bool DIDescriptor::isGlobal() const {
169 return isGlobalVariable();
172 /// isScope - Return true if the specified tag is one of the scope
174 bool DIDescriptor::isScope() const {
175 if (!DbgNode) return false;
177 case dwarf::DW_TAG_compile_unit:
178 case dwarf::DW_TAG_lexical_block:
179 case dwarf::DW_TAG_subprogram:
180 case dwarf::DW_TAG_namespace:
188 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
189 bool DIDescriptor::isCompileUnit() const {
190 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
193 /// isFile - Return true if the specified tag is DW_TAG_file_type.
194 bool DIDescriptor::isFile() const {
195 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
198 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
199 bool DIDescriptor::isNameSpace() const {
200 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
203 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
204 bool DIDescriptor::isLexicalBlock() const {
205 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block;
208 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
209 bool DIDescriptor::isSubrange() const {
210 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
213 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
214 bool DIDescriptor::isEnumerator() const {
215 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
218 //===----------------------------------------------------------------------===//
219 // Simple Descriptor Constructors and other Methods
220 //===----------------------------------------------------------------------===//
222 DIType::DIType(const MDNode *N) : DIScope(N) {
224 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
229 unsigned DIArray::getNumElements() const {
232 return DbgNode->getNumOperands();
235 /// replaceAllUsesWith - Replace all uses of debug info referenced by
236 /// this descriptor. After this completes, the current debug info value
238 void DIDerivedType::replaceAllUsesWith(DIDescriptor &D) {
242 // Since we use a TrackingVH for the node, its easy for clients to manufacture
243 // legitimate situations where they want to replaceAllUsesWith() on something
244 // which, due to uniquing, has merged with the source. We shield clients from
245 // this detail by allowing a value to be replaced with replaceAllUsesWith()
248 MDNode *Node = const_cast<MDNode*>(DbgNode);
249 const MDNode *DN = D;
250 const Value *V = cast_or_null<Value>(DN);
251 Node->replaceAllUsesWith(const_cast<Value*>(V));
256 /// Verify - Verify that a compile unit is well formed.
257 bool DICompileUnit::Verify() const {
260 StringRef N = getFilename();
263 // It is possible that directory and produce string is empty.
267 /// Verify - Verify that a type descriptor is well formed.
268 bool DIType::Verify() const {
271 if (!getContext().Verify())
274 DICompileUnit CU = getCompileUnit();
280 /// Verify - Verify that a composite type descriptor is well formed.
281 bool DICompositeType::Verify() const {
284 if (!getContext().Verify())
287 DICompileUnit CU = getCompileUnit();
293 /// Verify - Verify that a subprogram descriptor is well formed.
294 bool DISubprogram::Verify() const {
298 if (!getContext().Verify())
301 DICompileUnit CU = getCompileUnit();
305 DICompositeType Ty = getType();
311 /// Verify - Verify that a global variable descriptor is well formed.
312 bool DIGlobalVariable::Verify() const {
316 if (getDisplayName().empty())
319 if (!getContext().Verify())
322 DICompileUnit CU = getCompileUnit();
326 DIType Ty = getType();
336 /// Verify - Verify that a variable descriptor is well formed.
337 bool DIVariable::Verify() const {
341 if (!getContext().Verify())
344 if (!getCompileUnit().Verify())
347 DIType Ty = getType();
354 /// Verify - Verify that a location descriptor is well formed.
355 bool DILocation::Verify() const {
359 return DbgNode->getNumOperands() == 4;
362 /// Verify - Verify that a namespace descriptor is well formed.
363 bool DINameSpace::Verify() const {
366 if (getName().empty())
368 if (!getCompileUnit().Verify())
373 /// getOriginalTypeSize - If this type is derived from a base type then
374 /// return base type size.
375 uint64_t DIDerivedType::getOriginalTypeSize() const {
376 unsigned Tag = getTag();
377 if (Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef ||
378 Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
379 Tag == dwarf::DW_TAG_restrict_type) {
380 DIType BaseType = getTypeDerivedFrom();
381 // If this type is not derived from any type then take conservative
383 if (!BaseType.isValid())
384 return getSizeInBits();
385 if (BaseType.isDerivedType())
386 return DIDerivedType(BaseType).getOriginalTypeSize();
388 return BaseType.getSizeInBits();
391 return getSizeInBits();
394 /// isInlinedFnArgument - Return trule if this variable provides debugging
395 /// information for an inlined function arguments.
396 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
397 assert(CurFn && "Invalid function");
398 if (!getContext().isSubprogram())
400 // This variable is not inlined function argument if its scope
401 // does not describe current function.
402 return !(DISubprogram(getContext()).describes(CurFn));
405 /// describes - Return true if this subprogram provides debugging
406 /// information for the function F.
407 bool DISubprogram::describes(const Function *F) {
408 assert(F && "Invalid function");
409 if (F == getFunction())
411 StringRef Name = getLinkageName();
414 if (F->getName() == Name)
419 unsigned DISubprogram::isOptimized() const {
420 assert (DbgNode && "Invalid subprogram descriptor!");
421 if (DbgNode->getNumOperands() == 16)
422 return getUnsignedField(15);
426 StringRef DIScope::getFilename() const {
429 if (isLexicalBlock())
430 return DILexicalBlock(DbgNode).getFilename();
432 return DISubprogram(DbgNode).getFilename();
434 return DICompileUnit(DbgNode).getFilename();
436 return DINameSpace(DbgNode).getFilename();
438 return DIType(DbgNode).getFilename();
440 return DIFile(DbgNode).getFilename();
441 assert(0 && "Invalid DIScope!");
445 StringRef DIScope::getDirectory() const {
448 if (isLexicalBlock())
449 return DILexicalBlock(DbgNode).getDirectory();
451 return DISubprogram(DbgNode).getDirectory();
453 return DICompileUnit(DbgNode).getDirectory();
455 return DINameSpace(DbgNode).getDirectory();
457 return DIType(DbgNode).getDirectory();
459 return DIFile(DbgNode).getDirectory();
460 assert(0 && "Invalid DIScope!");
464 //===----------------------------------------------------------------------===//
465 // DIDescriptor: dump routines for all descriptors.
466 //===----------------------------------------------------------------------===//
469 /// print - Print descriptor.
470 void DIDescriptor::print(raw_ostream &OS) const {
471 OS << "[" << dwarf::TagString(getTag()) << "] ";
472 OS.write_hex((intptr_t) &*DbgNode) << ']';
475 /// print - Print compile unit.
476 void DICompileUnit::print(raw_ostream &OS) const {
478 OS << " [" << dwarf::LanguageString(getLanguage()) << "] ";
480 OS << " [" << getDirectory() << "/" << getFilename() << "]";
483 /// print - Print type.
484 void DIType::print(raw_ostream &OS) const {
485 if (!DbgNode) return;
487 StringRef Res = getName();
489 OS << " [" << Res << "] ";
491 unsigned Tag = getTag();
492 OS << " [" << dwarf::TagString(Tag) << "] ";
494 // TODO : Print context
495 getCompileUnit().print(OS);
497 << "line " << getLineNumber() << ", "
498 << getSizeInBits() << " bits, "
499 << getAlignInBits() << " bit alignment, "
500 << getOffsetInBits() << " bit offset"
505 else if (isProtected())
506 OS << " [protected] ";
512 DIBasicType(DbgNode).print(OS);
513 else if (isDerivedType())
514 DIDerivedType(DbgNode).print(OS);
515 else if (isCompositeType())
516 DICompositeType(DbgNode).print(OS);
518 OS << "Invalid DIType\n";
525 /// print - Print basic type.
526 void DIBasicType::print(raw_ostream &OS) const {
527 OS << " [" << dwarf::AttributeEncodingString(getEncoding()) << "] ";
530 /// print - Print derived type.
531 void DIDerivedType::print(raw_ostream &OS) const {
532 OS << "\n\t Derived From: "; getTypeDerivedFrom().print(OS);
535 /// print - Print composite type.
536 void DICompositeType::print(raw_ostream &OS) const {
537 DIArray A = getTypeArray();
538 OS << " [" << A.getNumElements() << " elements]";
541 /// print - Print subprogram.
542 void DISubprogram::print(raw_ostream &OS) const {
543 StringRef Res = getName();
545 OS << " [" << Res << "] ";
547 unsigned Tag = getTag();
548 OS << " [" << dwarf::TagString(Tag) << "] ";
550 // TODO : Print context
551 getCompileUnit().print(OS);
552 OS << " [" << getLineNumber() << "] ";
563 /// print - Print global variable.
564 void DIGlobalVariable::print(raw_ostream &OS) const {
566 StringRef Res = getName();
568 OS << " [" << Res << "] ";
570 unsigned Tag = getTag();
571 OS << " [" << dwarf::TagString(Tag) << "] ";
573 // TODO : Print context
574 getCompileUnit().print(OS);
575 OS << " [" << getLineNumber() << "] ";
583 if (isGlobalVariable())
584 DIGlobalVariable(DbgNode).print(OS);
588 /// print - Print variable.
589 void DIVariable::print(raw_ostream &OS) const {
590 StringRef Res = getName();
592 OS << " [" << Res << "] ";
594 getCompileUnit().print(OS);
595 OS << " [" << getLineNumber() << "] ";
599 // FIXME: Dump complex addresses
602 /// dump - Print descriptor to dbgs() with a newline.
603 void DIDescriptor::dump() const {
604 print(dbgs()); dbgs() << '\n';
607 /// dump - Print compile unit to dbgs() with a newline.
608 void DICompileUnit::dump() const {
609 print(dbgs()); dbgs() << '\n';
612 /// dump - Print type to dbgs() with a newline.
613 void DIType::dump() const {
614 print(dbgs()); dbgs() << '\n';
617 /// dump - Print basic type to dbgs() with a newline.
618 void DIBasicType::dump() const {
619 print(dbgs()); dbgs() << '\n';
622 /// dump - Print derived type to dbgs() with a newline.
623 void DIDerivedType::dump() const {
624 print(dbgs()); dbgs() << '\n';
627 /// dump - Print composite type to dbgs() with a newline.
628 void DICompositeType::dump() const {
629 print(dbgs()); dbgs() << '\n';
632 /// dump - Print subprogram to dbgs() with a newline.
633 void DISubprogram::dump() const {
634 print(dbgs()); dbgs() << '\n';
637 /// dump - Print global variable.
638 void DIGlobalVariable::dump() const {
639 print(dbgs()); dbgs() << '\n';
642 /// dump - Print variable.
643 void DIVariable::dump() const {
644 print(dbgs()); dbgs() << '\n';
647 //===----------------------------------------------------------------------===//
648 // DIFactory: Basic Helpers
649 //===----------------------------------------------------------------------===//
651 DIFactory::DIFactory(Module &m)
652 : M(m), VMContext(M.getContext()), DeclareFn(0), ValueFn(0) {}
654 Constant *DIFactory::GetTagConstant(unsigned TAG) {
655 assert((TAG & LLVMDebugVersionMask) == 0 &&
656 "Tag too large for debug encoding!");
657 return ConstantInt::get(Type::getInt32Ty(VMContext), TAG | LLVMDebugVersion);
660 //===----------------------------------------------------------------------===//
661 // DIFactory: Primary Constructors
662 //===----------------------------------------------------------------------===//
664 /// GetOrCreateArray - Create an descriptor for an array of descriptors.
665 /// This implicitly uniques the arrays created.
666 DIArray DIFactory::GetOrCreateArray(DIDescriptor *Tys, unsigned NumTys) {
667 SmallVector<Value*, 16> Elts;
670 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
672 for (unsigned i = 0; i != NumTys; ++i)
673 Elts.push_back(Tys[i]);
675 return DIArray(MDNode::get(VMContext,Elts.data(), Elts.size()));
678 /// GetOrCreateSubrange - Create a descriptor for a value range. This
679 /// implicitly uniques the values returned.
680 DISubrange DIFactory::GetOrCreateSubrange(int64_t Lo, int64_t Hi) {
682 GetTagConstant(dwarf::DW_TAG_subrange_type),
683 ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
684 ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
687 return DISubrange(MDNode::get(VMContext, &Elts[0], 3));
692 /// CreateCompileUnit - Create a new descriptor for the specified compile
693 /// unit. Note that this does not unique compile units within the module.
694 DICompileUnit DIFactory::CreateCompileUnit(unsigned LangID,
701 unsigned RunTimeVer) {
703 GetTagConstant(dwarf::DW_TAG_compile_unit),
704 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
705 ConstantInt::get(Type::getInt32Ty(VMContext), LangID),
706 MDString::get(VMContext, Filename),
707 MDString::get(VMContext, Directory),
708 MDString::get(VMContext, Producer),
709 ConstantInt::get(Type::getInt1Ty(VMContext), isMain),
710 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
711 MDString::get(VMContext, Flags),
712 ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer)
715 return DICompileUnit(MDNode::get(VMContext, &Elts[0], 10));
718 /// CreateFile - Create a new descriptor for the specified file.
719 DIFile DIFactory::CreateFile(StringRef Filename,
723 GetTagConstant(dwarf::DW_TAG_file_type),
724 MDString::get(VMContext, Filename),
725 MDString::get(VMContext, Directory),
729 return DIFile(MDNode::get(VMContext, &Elts[0], 4));
732 /// CreateEnumerator - Create a single enumerator value.
733 DIEnumerator DIFactory::CreateEnumerator(StringRef Name, uint64_t Val){
735 GetTagConstant(dwarf::DW_TAG_enumerator),
736 MDString::get(VMContext, Name),
737 ConstantInt::get(Type::getInt64Ty(VMContext), Val)
739 return DIEnumerator(MDNode::get(VMContext, &Elts[0], 3));
743 /// CreateBasicType - Create a basic type like int, float, etc.
744 DIBasicType DIFactory::CreateBasicType(DIDescriptor Context,
749 uint64_t AlignInBits,
750 uint64_t OffsetInBits, unsigned Flags,
753 GetTagConstant(dwarf::DW_TAG_base_type),
755 MDString::get(VMContext, Name),
757 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
758 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
759 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
760 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
761 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
762 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
764 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
768 /// CreateBasicType - Create a basic type like int, float, etc.
769 DIBasicType DIFactory::CreateBasicTypeEx(DIDescriptor Context,
773 Constant *SizeInBits,
774 Constant *AlignInBits,
775 Constant *OffsetInBits, unsigned Flags,
778 GetTagConstant(dwarf::DW_TAG_base_type),
780 MDString::get(VMContext, Name),
782 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
786 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
787 ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
789 return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
792 /// CreateArtificialType - Create a new DIType with "artificial" flag set.
793 DIType DIFactory::CreateArtificialType(DIType Ty) {
794 if (Ty.isArtificial())
797 SmallVector<Value *, 9> Elts;
799 assert (N && "Unexpected input DIType!");
800 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
801 if (Value *V = N->getOperand(i))
804 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
807 unsigned CurFlags = Ty.getFlags();
808 CurFlags = CurFlags | DIType::FlagArtificial;
810 // Flags are stored at this slot.
811 Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
813 return DIType(MDNode::get(VMContext, Elts.data(), Elts.size()));
816 /// CreateDerivedType - Create a derived type like const qualified type,
817 /// pointer, typedef, etc.
818 DIDerivedType DIFactory::CreateDerivedType(unsigned Tag,
819 DIDescriptor Context,
824 uint64_t AlignInBits,
825 uint64_t OffsetInBits,
827 DIType DerivedFrom) {
831 MDString::get(VMContext, Name),
833 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
834 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
835 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
836 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
837 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
840 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
844 /// CreateDerivedType - Create a derived type like const qualified type,
845 /// pointer, typedef, etc.
846 DIDerivedType DIFactory::CreateDerivedTypeEx(unsigned Tag,
847 DIDescriptor Context,
851 Constant *SizeInBits,
852 Constant *AlignInBits,
853 Constant *OffsetInBits,
855 DIType DerivedFrom) {
859 MDString::get(VMContext, Name),
861 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
865 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
868 return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
872 /// CreateCompositeType - Create a composite type like array, struct, etc.
873 DICompositeType DIFactory::CreateCompositeType(unsigned Tag,
874 DIDescriptor Context,
879 uint64_t AlignInBits,
880 uint64_t OffsetInBits,
884 unsigned RuntimeLang,
885 MDNode *ContainingType) {
890 MDString::get(VMContext, Name),
892 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
893 ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
894 ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
895 ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
896 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
899 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang),
902 return DICompositeType(MDNode::get(VMContext, &Elts[0], 13));
906 /// CreateCompositeType - Create a composite type like array, struct, etc.
907 DICompositeType DIFactory::CreateCompositeTypeEx(unsigned Tag,
908 DIDescriptor Context,
912 Constant *SizeInBits,
913 Constant *AlignInBits,
914 Constant *OffsetInBits,
918 unsigned RuntimeLang) {
923 MDString::get(VMContext, Name),
925 ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
929 ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
932 ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
934 return DICompositeType(MDNode::get(VMContext, &Elts[0], 12));
938 /// CreateSubprogram - Create a new descriptor for the specified subprogram.
939 /// See comments in DISubprogram for descriptions of these fields. This
940 /// method does not unique the generated descriptors.
941 DISubprogram DIFactory::CreateSubprogram(DIDescriptor Context,
943 StringRef DisplayName,
944 StringRef LinkageName,
946 unsigned LineNo, DIType Ty,
949 unsigned VK, unsigned VIndex,
950 DIType ContainingType,
956 GetTagConstant(dwarf::DW_TAG_subprogram),
957 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
959 MDString::get(VMContext, Name),
960 MDString::get(VMContext, DisplayName),
961 MDString::get(VMContext, LinkageName),
963 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
965 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
966 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
967 ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
968 ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
970 ConstantInt::get(Type::getInt1Ty(VMContext), isArtificial),
971 ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
974 MDNode *Node = MDNode::get(VMContext, &Elts[0], 17);
976 // Create a named metadata so that we do not lose this mdnode.
977 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
978 NMD->addOperand(Node);
979 return DISubprogram(Node);
982 /// CreateSubprogramDefinition - Create new subprogram descriptor for the
983 /// given declaration.
984 DISubprogram DIFactory::CreateSubprogramDefinition(DISubprogram &SPDeclaration) {
985 if (SPDeclaration.isDefinition())
986 return DISubprogram(SPDeclaration);
988 MDNode *DeclNode = SPDeclaration;
990 GetTagConstant(dwarf::DW_TAG_subprogram),
991 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
992 DeclNode->getOperand(2), // Context
993 DeclNode->getOperand(3), // Name
994 DeclNode->getOperand(4), // DisplayName
995 DeclNode->getOperand(5), // LinkageName
996 DeclNode->getOperand(6), // CompileUnit
997 DeclNode->getOperand(7), // LineNo
998 DeclNode->getOperand(8), // Type
999 DeclNode->getOperand(9), // isLocalToUnit
1000 ConstantInt::get(Type::getInt1Ty(VMContext), true),
1001 DeclNode->getOperand(11), // Virtuality
1002 DeclNode->getOperand(12), // VIndex
1003 DeclNode->getOperand(13), // Containting Type
1004 DeclNode->getOperand(14), // isArtificial
1005 DeclNode->getOperand(15), // isOptimized
1006 SPDeclaration.getFunction()
1008 MDNode *Node =MDNode::get(VMContext, &Elts[0], 16);
1010 // Create a named metadata so that we do not lose this mdnode.
1011 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
1012 NMD->addOperand(Node);
1013 return DISubprogram(Node);
1016 /// CreateGlobalVariable - Create a new descriptor for the specified global.
1018 DIFactory::CreateGlobalVariable(DIDescriptor Context, StringRef Name,
1019 StringRef DisplayName,
1020 StringRef LinkageName,
1022 unsigned LineNo, DIType Ty,bool isLocalToUnit,
1023 bool isDefinition, llvm::GlobalVariable *Val) {
1025 GetTagConstant(dwarf::DW_TAG_variable),
1026 llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
1028 MDString::get(VMContext, Name),
1029 MDString::get(VMContext, DisplayName),
1030 MDString::get(VMContext, LinkageName),
1032 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1034 ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
1035 ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
1039 Value *const *Vs = &Elts[0];
1040 MDNode *Node = MDNode::get(VMContext,Vs, 12);
1042 // Create a named metadata so that we do not lose this mdnode.
1043 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
1044 NMD->addOperand(Node);
1046 return DIGlobalVariable(Node);
1050 /// CreateVariable - Create a new descriptor for the specified variable.
1051 DIVariable DIFactory::CreateVariable(unsigned Tag, DIDescriptor Context,
1055 DIType Ty, bool AlwaysPreserve) {
1057 GetTagConstant(Tag),
1059 MDString::get(VMContext, Name),
1061 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1064 MDNode *Node = MDNode::get(VMContext, &Elts[0], 6);
1065 if (AlwaysPreserve) {
1066 // The optimizer may remove local variable. If there is an interest
1067 // to preserve variable info in such situation then stash it in a
1069 DISubprogram Fn(getDISubprogram(Context));
1070 StringRef FName = "fn";
1071 if (Fn.getFunction())
1072 FName = Fn.getFunction()->getName();
1074 if (FName.startswith(StringRef(&One, 1)))
1075 FName = FName.substr(1);
1076 NamedMDNode *FnLocals = M.getNamedMetadata(Twine("llvm.dbg.lv.", FName));
1078 FnLocals = NamedMDNode::Create(VMContext, Twine("llvm.dbg.lv.", FName),
1080 FnLocals->addOperand(Node);
1082 return DIVariable(Node);
1086 /// CreateComplexVariable - Create a new descriptor for the specified variable
1087 /// which has a complex address expression for its address.
1088 DIVariable DIFactory::CreateComplexVariable(unsigned Tag, DIDescriptor Context,
1089 const std::string &Name,
1093 SmallVector<Value *, 9> &addr) {
1094 SmallVector<Value *, 9> Elts;
1095 Elts.push_back(GetTagConstant(Tag));
1096 Elts.push_back(Context);
1097 Elts.push_back(MDString::get(VMContext, Name));
1099 Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext), LineNo));
1101 Elts.insert(Elts.end(), addr.begin(), addr.end());
1103 return DIVariable(MDNode::get(VMContext, &Elts[0], 6+addr.size()));
1107 /// CreateBlock - This creates a descriptor for a lexical block with the
1108 /// specified parent VMContext.
1109 DILexicalBlock DIFactory::CreateLexicalBlock(DIDescriptor Context,
1110 unsigned LineNo, unsigned Col) {
1112 GetTagConstant(dwarf::DW_TAG_lexical_block),
1114 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1115 ConstantInt::get(Type::getInt32Ty(VMContext), Col)
1117 return DILexicalBlock(MDNode::get(VMContext, &Elts[0], 4));
1120 /// CreateNameSpace - This creates new descriptor for a namespace
1121 /// with the specified parent context.
1122 DINameSpace DIFactory::CreateNameSpace(DIDescriptor Context, StringRef Name,
1126 GetTagConstant(dwarf::DW_TAG_namespace),
1128 MDString::get(VMContext, Name),
1130 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
1132 return DINameSpace(MDNode::get(VMContext, &Elts[0], 5));
1135 /// CreateLocation - Creates a debug info location.
1136 DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
1137 DIScope S, DILocation OrigLoc) {
1139 ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
1140 ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
1144 return DILocation(MDNode::get(VMContext, &Elts[0], 4));
1147 //===----------------------------------------------------------------------===//
1148 // DIFactory: Routines for inserting code into a function
1149 //===----------------------------------------------------------------------===//
1151 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1152 Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
1153 Instruction *InsertBefore) {
1154 assert(Storage && "no storage passed to dbg.declare");
1155 assert(D.Verify() && "empty DIVariable passed to dbg.declare");
1157 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1159 Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1),
1161 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertBefore);
1164 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
1165 Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
1166 BasicBlock *InsertAtEnd) {
1167 assert(Storage && "no storage passed to dbg.declare");
1168 assert(D.Verify() && "invalid DIVariable passed to dbg.declare");
1170 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
1172 Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1),
1175 // If this block already has a terminator then insert this intrinsic
1176 // before the terminator.
1177 if (TerminatorInst *T = InsertAtEnd->getTerminator())
1178 return CallInst::Create(DeclareFn, Args, Args+2, "", T);
1180 return CallInst::Create(DeclareFn, Args, Args+2, "", InsertAtEnd);}
1182 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1183 Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
1185 Instruction *InsertBefore) {
1186 assert(V && "no value passed to dbg.value");
1187 assert(D.Verify() && "invalid DIVariable passed to dbg.value");
1189 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1191 Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
1192 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1194 return CallInst::Create(ValueFn, Args, Args+3, "", InsertBefore);
1197 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
1198 Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
1200 BasicBlock *InsertAtEnd) {
1201 assert(V && "no value passed to dbg.value");
1202 assert(D.Verify() && "invalid DIVariable passed to dbg.value");
1204 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
1206 Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
1207 ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
1209 return CallInst::Create(ValueFn, Args, Args+3, "", InsertAtEnd);
1212 //===----------------------------------------------------------------------===//
1213 // DebugInfoFinder implementations.
1214 //===----------------------------------------------------------------------===//
1216 /// processModule - Process entire module and collect debug info.
1217 void DebugInfoFinder::processModule(Module &M) {
1218 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1219 for (Function::iterator FI = (*I).begin(), FE = (*I).end(); FI != FE; ++FI)
1220 for (BasicBlock::iterator BI = (*FI).begin(), BE = (*FI).end(); BI != BE;
1222 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
1223 processDeclare(DDI);
1225 DebugLoc Loc = BI->getDebugLoc();
1226 if (Loc.isUnknown())
1229 LLVMContext &Ctx = BI->getContext();
1230 DIDescriptor Scope(Loc.getScope(Ctx));
1232 if (Scope.isCompileUnit())
1233 addCompileUnit(DICompileUnit(Scope));
1234 else if (Scope.isSubprogram())
1235 processSubprogram(DISubprogram(Scope));
1236 else if (Scope.isLexicalBlock())
1237 processLexicalBlock(DILexicalBlock(Scope));
1239 if (MDNode *IA = Loc.getInlinedAt(Ctx))
1240 processLocation(DILocation(IA));
1243 if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv")) {
1244 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1245 DIGlobalVariable DIG(cast<MDNode>(NMD->getOperand(i)));
1246 if (addGlobalVariable(DIG)) {
1247 addCompileUnit(DIG.getCompileUnit());
1248 processType(DIG.getType());
1253 if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.sp"))
1254 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
1255 processSubprogram(DISubprogram(NMD->getOperand(i)));
1258 /// processLocation - Process DILocation.
1259 void DebugInfoFinder::processLocation(DILocation Loc) {
1260 if (!Loc.Verify()) return;
1261 DIDescriptor S(Loc.getScope());
1262 if (S.isCompileUnit())
1263 addCompileUnit(DICompileUnit(S));
1264 else if (S.isSubprogram())
1265 processSubprogram(DISubprogram(S));
1266 else if (S.isLexicalBlock())
1267 processLexicalBlock(DILexicalBlock(S));
1268 processLocation(Loc.getOrigLocation());
1271 /// processType - Process DIType.
1272 void DebugInfoFinder::processType(DIType DT) {
1276 addCompileUnit(DT.getCompileUnit());
1277 if (DT.isCompositeType()) {
1278 DICompositeType DCT(DT);
1279 processType(DCT.getTypeDerivedFrom());
1280 DIArray DA = DCT.getTypeArray();
1281 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1282 DIDescriptor D = DA.getElement(i);
1284 processType(DIType(D));
1285 else if (D.isSubprogram())
1286 processSubprogram(DISubprogram(D));
1288 } else if (DT.isDerivedType()) {
1289 DIDerivedType DDT(DT);
1290 processType(DDT.getTypeDerivedFrom());
1294 /// processLexicalBlock
1295 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
1296 DIScope Context = LB.getContext();
1297 if (Context.isLexicalBlock())
1298 return processLexicalBlock(DILexicalBlock(Context));
1300 return processSubprogram(DISubprogram(Context));
1303 /// processSubprogram - Process DISubprogram.
1304 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1305 if (!addSubprogram(SP))
1307 addCompileUnit(SP.getCompileUnit());
1308 processType(SP.getType());
1311 /// processDeclare - Process DbgDeclareInst.
1312 void DebugInfoFinder::processDeclare(DbgDeclareInst *DDI) {
1313 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1317 if (!DV.isVariable())
1320 if (!NodesSeen.insert(DV))
1323 addCompileUnit(DIVariable(N).getCompileUnit());
1324 processType(DIVariable(N).getType());
1327 /// addType - Add type into Tys.
1328 bool DebugInfoFinder::addType(DIType DT) {
1332 if (!NodesSeen.insert(DT))
1339 /// addCompileUnit - Add compile unit into CUs.
1340 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1344 if (!NodesSeen.insert(CU))
1351 /// addGlobalVariable - Add global variable into GVs.
1352 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1353 if (!DIDescriptor(DIG).isGlobalVariable())
1356 if (!NodesSeen.insert(DIG))
1363 // addSubprogram - Add subprgoram into SPs.
1364 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1365 if (!DIDescriptor(SP).isSubprogram())
1368 if (!NodesSeen.insert(SP))
1375 /// Find the debug info descriptor corresponding to this global variable.
1376 static Value *findDbgGlobalDeclare(GlobalVariable *V) {
1377 const Module *M = V->getParent();
1378 NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv");
1382 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1383 DIDescriptor DIG(cast_or_null<MDNode>(NMD->getOperand(i)));
1384 if (!DIG.isGlobalVariable())
1386 if (DIGlobalVariable(DIG).getGlobal() == V)
1392 /// Finds the llvm.dbg.declare intrinsic corresponding to this value if any.
1393 /// It looks through pointer casts too.
1394 static const DbgDeclareInst *findDbgDeclare(const Value *V) {
1395 V = V->stripPointerCasts();
1397 if (!isa<Instruction>(V) && !isa<Argument>(V))
1400 const Function *F = NULL;
1401 if (const Instruction *I = dyn_cast<Instruction>(V))
1402 F = I->getParent()->getParent();
1403 else if (const Argument *A = dyn_cast<Argument>(V))
1406 for (Function::const_iterator FI = F->begin(), FE = F->end(); FI != FE; ++FI)
1407 for (BasicBlock::const_iterator BI = (*FI).begin(), BE = (*FI).end();
1409 if (const DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
1410 if (DDI->getAddress() == V)
1416 bool llvm::getLocationInfo(const Value *V, std::string &DisplayName,
1417 std::string &Type, unsigned &LineNo,
1418 std::string &File, std::string &Dir) {
1422 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(const_cast<Value*>(V))) {
1423 Value *DIGV = findDbgGlobalDeclare(GV);
1424 if (!DIGV) return false;
1425 DIGlobalVariable Var(cast<MDNode>(DIGV));
1427 StringRef D = Var.getDisplayName();
1430 LineNo = Var.getLineNumber();
1431 Unit = Var.getCompileUnit();
1432 TypeD = Var.getType();
1434 const DbgDeclareInst *DDI = findDbgDeclare(V);
1435 if (!DDI) return false;
1436 DIVariable Var(cast<MDNode>(DDI->getVariable()));
1438 StringRef D = Var.getName();
1441 LineNo = Var.getLineNumber();
1442 Unit = Var.getCompileUnit();
1443 TypeD = Var.getType();
1446 StringRef T = TypeD.getName();
1449 StringRef F = Unit.getFilename();
1452 StringRef D = Unit.getDirectory();
1458 /// getDISubprogram - Find subprogram that is enclosing this scope.
1459 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
1460 DIDescriptor D(Scope);
1461 if (D.isSubprogram())
1462 return DISubprogram(Scope);
1464 if (D.isLexicalBlock())
1465 return getDISubprogram(DILexicalBlock(Scope).getContext());
1467 return DISubprogram();
1470 /// getDICompositeType - Find underlying composite type.
1471 DICompositeType llvm::getDICompositeType(DIType T) {
1472 if (T.isCompositeType())
1473 return DICompositeType(T);
1475 if (T.isDerivedType())
1476 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
1478 return DICompositeType();