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/Module.h"
22 #include "llvm/Analysis/ValueTracking.h"
23 #include "llvm/ADT/SmallPtrSet.h"
24 #include "llvm/ADT/SmallString.h"
25 #include "llvm/ADT/STLExtras.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/raw_ostream.h"
30 using namespace llvm::dwarf;
32 //===----------------------------------------------------------------------===//
34 //===----------------------------------------------------------------------===//
36 DIDescriptor::DIDescriptor(const DIFile F) : DbgNode(F.DbgNode) {
39 DIDescriptor::DIDescriptor(const DISubprogram F) : DbgNode(F.DbgNode) {
42 DIDescriptor::DIDescriptor(const DILexicalBlockFile F) : DbgNode(F.DbgNode) {
45 DIDescriptor::DIDescriptor(const DILexicalBlock F) : DbgNode(F.DbgNode) {
48 DIDescriptor::DIDescriptor(const DIVariable F) : DbgNode(F.DbgNode) {
51 DIDescriptor::DIDescriptor(const DIType F) : DbgNode(F.DbgNode) {
55 DIDescriptor::getStringField(unsigned Elt) const {
59 if (Elt < DbgNode->getNumOperands())
60 if (MDString *MDS = dyn_cast_or_null<MDString>(DbgNode->getOperand(Elt)))
61 return MDS->getString();
66 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
70 if (Elt < DbgNode->getNumOperands())
71 if (ConstantInt *CI = dyn_cast<ConstantInt>(DbgNode->getOperand(Elt)))
72 return CI->getZExtValue();
77 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
79 return DIDescriptor();
81 if (Elt < DbgNode->getNumOperands())
83 DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
84 return DIDescriptor();
87 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
91 if (Elt < DbgNode->getNumOperands())
92 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
96 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
100 if (Elt < DbgNode->getNumOperands())
101 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
105 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
109 if (Elt < DbgNode->getNumOperands())
110 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
114 unsigned DIVariable::getNumAddrElements() const {
115 if (getVersion() <= llvm::LLVMDebugVersion8)
116 return DbgNode->getNumOperands()-6;
117 if (getVersion() == llvm::LLVMDebugVersion9)
118 return DbgNode->getNumOperands()-7;
119 return DbgNode->getNumOperands()-8;
122 /// getInlinedAt - If this variable is inlined then return inline location.
123 MDNode *DIVariable::getInlinedAt() const {
124 if (getVersion() <= llvm::LLVMDebugVersion9)
126 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(7));
129 //===----------------------------------------------------------------------===//
131 //===----------------------------------------------------------------------===//
133 /// isBasicType - Return true if the specified tag is legal for
135 bool DIDescriptor::isBasicType() const {
136 if (!DbgNode) return false;
138 case dwarf::DW_TAG_base_type:
139 case dwarf::DW_TAG_unspecified_type:
146 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
147 bool DIDescriptor::isDerivedType() const {
148 if (!DbgNode) return false;
150 case dwarf::DW_TAG_typedef:
151 case dwarf::DW_TAG_pointer_type:
152 case dwarf::DW_TAG_reference_type:
153 case dwarf::DW_TAG_const_type:
154 case dwarf::DW_TAG_volatile_type:
155 case dwarf::DW_TAG_restrict_type:
156 case dwarf::DW_TAG_member:
157 case dwarf::DW_TAG_inheritance:
158 case dwarf::DW_TAG_friend:
161 // CompositeTypes are currently modelled as DerivedTypes.
162 return isCompositeType();
166 /// isCompositeType - Return true if the specified tag is legal for
168 bool DIDescriptor::isCompositeType() const {
169 if (!DbgNode) return false;
171 case dwarf::DW_TAG_array_type:
172 case dwarf::DW_TAG_structure_type:
173 case dwarf::DW_TAG_union_type:
174 case dwarf::DW_TAG_enumeration_type:
175 case dwarf::DW_TAG_vector_type:
176 case dwarf::DW_TAG_subroutine_type:
177 case dwarf::DW_TAG_class_type:
184 /// isVariable - Return true if the specified tag is legal for DIVariable.
185 bool DIDescriptor::isVariable() const {
186 if (!DbgNode) return false;
188 case dwarf::DW_TAG_auto_variable:
189 case dwarf::DW_TAG_arg_variable:
190 case dwarf::DW_TAG_return_variable:
197 /// isType - Return true if the specified tag is legal for DIType.
198 bool DIDescriptor::isType() const {
199 return isBasicType() || isCompositeType() || isDerivedType();
202 /// isSubprogram - Return true if the specified tag is legal for
204 bool DIDescriptor::isSubprogram() const {
205 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
208 /// isGlobalVariable - Return true if the specified tag is legal for
209 /// DIGlobalVariable.
210 bool DIDescriptor::isGlobalVariable() const {
211 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
212 getTag() == dwarf::DW_TAG_constant);
215 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
216 bool DIDescriptor::isGlobal() const {
217 return isGlobalVariable();
220 /// isUnspecifiedParmeter - Return true if the specified tag is
221 /// DW_TAG_unspecified_parameters.
222 bool DIDescriptor::isUnspecifiedParameter() const {
223 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
226 /// isScope - Return true if the specified tag is one of the scope
228 bool DIDescriptor::isScope() const {
229 if (!DbgNode) return false;
231 case dwarf::DW_TAG_compile_unit:
232 case dwarf::DW_TAG_lexical_block:
233 case dwarf::DW_TAG_subprogram:
234 case dwarf::DW_TAG_namespace:
242 /// isTemplateTypeParameter - Return true if the specified tag is
243 /// DW_TAG_template_type_parameter.
244 bool DIDescriptor::isTemplateTypeParameter() const {
245 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
248 /// isTemplateValueParameter - Return true if the specified tag is
249 /// DW_TAG_template_value_parameter.
250 bool DIDescriptor::isTemplateValueParameter() const {
251 return DbgNode && getTag() == dwarf::DW_TAG_template_value_parameter;
254 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
255 bool DIDescriptor::isCompileUnit() const {
256 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
259 /// isFile - Return true if the specified tag is DW_TAG_file_type.
260 bool DIDescriptor::isFile() const {
261 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
264 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
265 bool DIDescriptor::isNameSpace() const {
266 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
269 /// isLexicalBlockFile - Return true if the specified descriptor is a
270 /// lexical block with an extra file.
271 bool DIDescriptor::isLexicalBlockFile() const {
272 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
273 (DbgNode->getNumOperands() == 3);
276 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
277 bool DIDescriptor::isLexicalBlock() const {
278 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
279 (DbgNode->getNumOperands() > 3);
282 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
283 bool DIDescriptor::isSubrange() const {
284 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
287 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
288 bool DIDescriptor::isEnumerator() const {
289 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
292 //===----------------------------------------------------------------------===//
293 // Simple Descriptor Constructors and other Methods
294 //===----------------------------------------------------------------------===//
296 DIType::DIType(const MDNode *N) : DIScope(N) {
298 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
303 unsigned DIArray::getNumElements() const {
306 return DbgNode->getNumOperands();
309 /// replaceAllUsesWith - Replace all uses of debug info referenced by
311 void DIType::replaceAllUsesWith(DIDescriptor &D) {
315 // Since we use a TrackingVH for the node, its easy for clients to manufacture
316 // legitimate situations where they want to replaceAllUsesWith() on something
317 // which, due to uniquing, has merged with the source. We shield clients from
318 // this detail by allowing a value to be replaced with replaceAllUsesWith()
321 MDNode *Node = const_cast<MDNode*>(DbgNode);
322 const MDNode *DN = D;
323 const Value *V = cast_or_null<Value>(DN);
324 Node->replaceAllUsesWith(const_cast<Value*>(V));
325 MDNode::deleteTemporary(Node);
329 /// replaceAllUsesWith - Replace all uses of debug info referenced by
331 void DIType::replaceAllUsesWith(MDNode *D) {
335 // Since we use a TrackingVH for the node, its easy for clients to manufacture
336 // legitimate situations where they want to replaceAllUsesWith() on something
337 // which, due to uniquing, has merged with the source. We shield clients from
338 // this detail by allowing a value to be replaced with replaceAllUsesWith()
341 MDNode *Node = const_cast<MDNode*>(DbgNode);
342 const MDNode *DN = D;
343 const Value *V = cast_or_null<Value>(DN);
344 Node->replaceAllUsesWith(const_cast<Value*>(V));
345 MDNode::deleteTemporary(Node);
349 /// isUnsignedDIType - Return true if type encoding is unsigned.
350 bool DIType::isUnsignedDIType() {
351 DIDerivedType DTy(DbgNode);
353 return DTy.getTypeDerivedFrom().isUnsignedDIType();
355 DIBasicType BTy(DbgNode);
357 unsigned Encoding = BTy.getEncoding();
358 if (Encoding == dwarf::DW_ATE_unsigned ||
359 Encoding == dwarf::DW_ATE_unsigned_char)
365 /// Verify - Verify that a compile unit is well formed.
366 bool DICompileUnit::Verify() const {
369 StringRef N = getFilename();
372 // It is possible that directory and produce string is empty.
376 /// Verify - Verify that a type descriptor is well formed.
377 bool DIType::Verify() const {
380 if (getContext() && !getContext().Verify())
382 unsigned Tag = getTag();
383 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
384 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
385 Tag != dwarf::DW_TAG_reference_type && Tag != dwarf::DW_TAG_restrict_type
386 && Tag != dwarf::DW_TAG_vector_type && Tag != dwarf::DW_TAG_array_type
387 && Tag != dwarf::DW_TAG_enumeration_type
388 && Tag != dwarf::DW_TAG_subroutine_type
389 && getFilename().empty())
394 /// Verify - Verify that a basic type descriptor is well formed.
395 bool DIBasicType::Verify() const {
396 return isBasicType();
399 /// Verify - Verify that a derived type descriptor is well formed.
400 bool DIDerivedType::Verify() const {
401 return isDerivedType();
404 /// Verify - Verify that a composite type descriptor is well formed.
405 bool DICompositeType::Verify() const {
408 if (getContext() && !getContext().Verify())
414 /// Verify - Verify that a subprogram descriptor is well formed.
415 bool DISubprogram::Verify() const {
419 if (getContext() && !getContext().Verify())
422 DICompositeType Ty = getType();
428 /// Verify - Verify that a global variable descriptor is well formed.
429 bool DIGlobalVariable::Verify() const {
433 if (getDisplayName().empty())
436 if (getContext() && !getContext().Verify())
439 DIType Ty = getType();
443 if (!getGlobal() && !getConstant())
449 /// Verify - Verify that a variable descriptor is well formed.
450 bool DIVariable::Verify() const {
454 if (getContext() && !getContext().Verify())
457 DIType Ty = getType();
464 /// Verify - Verify that a location descriptor is well formed.
465 bool DILocation::Verify() const {
469 return DbgNode->getNumOperands() == 4;
472 /// Verify - Verify that a namespace descriptor is well formed.
473 bool DINameSpace::Verify() const {
476 if (getName().empty())
481 /// getOriginalTypeSize - If this type is derived from a base type then
482 /// return base type size.
483 uint64_t DIDerivedType::getOriginalTypeSize() const {
484 unsigned Tag = getTag();
485 if (Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef ||
486 Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
487 Tag == dwarf::DW_TAG_restrict_type) {
488 DIType BaseType = getTypeDerivedFrom();
489 // If this type is not derived from any type then take conservative
491 if (!BaseType.isValid())
492 return getSizeInBits();
493 if (BaseType.isDerivedType())
494 return DIDerivedType(BaseType).getOriginalTypeSize();
496 return BaseType.getSizeInBits();
499 return getSizeInBits();
502 /// isInlinedFnArgument - Return true if this variable provides debugging
503 /// information for an inlined function arguments.
504 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
505 assert(CurFn && "Invalid function");
506 if (!getContext().isSubprogram())
508 // This variable is not inlined function argument if its scope
509 // does not describe current function.
510 return !(DISubprogram(getContext()).describes(CurFn));
513 /// describes - Return true if this subprogram provides debugging
514 /// information for the function F.
515 bool DISubprogram::describes(const Function *F) {
516 assert(F && "Invalid function");
517 if (F == getFunction())
519 StringRef Name = getLinkageName();
522 if (F->getName() == Name)
527 unsigned DISubprogram::isOptimized() const {
528 assert (DbgNode && "Invalid subprogram descriptor!");
529 if (DbgNode->getNumOperands() == 16)
530 return getUnsignedField(15);
534 MDNode *DISubprogram::getVariablesNodes() const {
535 if (!DbgNode || DbgNode->getNumOperands() <= 19)
537 if (MDNode *Temp = dyn_cast_or_null<MDNode>(DbgNode->getOperand(19)))
538 return dyn_cast_or_null<MDNode>(Temp->getOperand(0));
542 DIArray DISubprogram::getVariables() const {
543 if (!DbgNode || DbgNode->getNumOperands() <= 19)
545 if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(19)))
546 if (MDNode *A = dyn_cast_or_null<MDNode>(T->getOperand(0)))
551 StringRef DIScope::getFilename() const {
554 if (isLexicalBlockFile())
555 return DILexicalBlockFile(DbgNode).getFilename();
556 if (isLexicalBlock())
557 return DILexicalBlock(DbgNode).getFilename();
559 return DISubprogram(DbgNode).getFilename();
561 return DICompileUnit(DbgNode).getFilename();
563 return DINameSpace(DbgNode).getFilename();
565 return DIType(DbgNode).getFilename();
567 return DIFile(DbgNode).getFilename();
568 assert(0 && "Invalid DIScope!");
572 StringRef DIScope::getDirectory() const {
575 if (isLexicalBlockFile())
576 return DILexicalBlockFile(DbgNode).getDirectory();
577 if (isLexicalBlock())
578 return DILexicalBlock(DbgNode).getDirectory();
580 return DISubprogram(DbgNode).getDirectory();
582 return DICompileUnit(DbgNode).getDirectory();
584 return DINameSpace(DbgNode).getDirectory();
586 return DIType(DbgNode).getDirectory();
588 return DIFile(DbgNode).getDirectory();
589 assert(0 && "Invalid DIScope!");
593 DIArray DICompileUnit::getEnumTypes() const {
594 if (!DbgNode || DbgNode->getNumOperands() < 14)
597 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
598 if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
603 DIArray DICompileUnit::getRetainedTypes() const {
604 if (!DbgNode || DbgNode->getNumOperands() < 14)
607 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
608 if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
613 DIArray DICompileUnit::getSubprograms() const {
614 if (!DbgNode || DbgNode->getNumOperands() < 14)
617 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(12)))
618 if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
624 DIArray DICompileUnit::getGlobalVariables() const {
625 if (!DbgNode || DbgNode->getNumOperands() < 14)
628 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(13)))
629 if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
634 //===----------------------------------------------------------------------===//
635 // DIDescriptor: dump routines for all descriptors.
636 //===----------------------------------------------------------------------===//
639 /// print - Print descriptor.
640 void DIDescriptor::print(raw_ostream &OS) const {
641 OS << "[" << dwarf::TagString(getTag()) << "] ";
642 OS.write_hex((intptr_t) &*DbgNode) << ']';
645 /// print - Print compile unit.
646 void DICompileUnit::print(raw_ostream &OS) const {
648 OS << " [" << dwarf::LanguageString(getLanguage()) << "] ";
650 OS << " [" << getDirectory() << "/" << getFilename() << "]";
653 /// print - Print type.
654 void DIType::print(raw_ostream &OS) const {
655 if (!DbgNode) return;
657 StringRef Res = getName();
659 OS << " [" << Res << "] ";
661 unsigned Tag = getTag();
662 OS << " [" << dwarf::TagString(Tag) << "] ";
664 // TODO : Print context
666 << "line " << getLineNumber() << ", "
667 << getSizeInBits() << " bits, "
668 << getAlignInBits() << " bit alignment, "
669 << getOffsetInBits() << " bit offset"
674 else if (isProtected())
675 OS << " [protected] ";
681 DIBasicType(DbgNode).print(OS);
682 else if (isDerivedType())
683 DIDerivedType(DbgNode).print(OS);
684 else if (isCompositeType())
685 DICompositeType(DbgNode).print(OS);
687 OS << "Invalid DIType\n";
694 /// print - Print basic type.
695 void DIBasicType::print(raw_ostream &OS) const {
696 OS << " [" << dwarf::AttributeEncodingString(getEncoding()) << "] ";
699 /// print - Print derived type.
700 void DIDerivedType::print(raw_ostream &OS) const {
701 OS << "\n\t Derived From: "; getTypeDerivedFrom().print(OS);
704 /// print - Print composite type.
705 void DICompositeType::print(raw_ostream &OS) const {
706 DIArray A = getTypeArray();
707 OS << " [" << A.getNumElements() << " elements]";
710 /// print - Print subprogram.
711 void DISubprogram::print(raw_ostream &OS) const {
712 StringRef Res = getName();
714 OS << " [" << Res << "] ";
716 unsigned Tag = getTag();
717 OS << " [" << dwarf::TagString(Tag) << "] ";
719 // TODO : Print context
720 OS << " [" << getLineNumber() << "] ";
731 /// print - Print global variable.
732 void DIGlobalVariable::print(raw_ostream &OS) const {
734 StringRef Res = getName();
736 OS << " [" << Res << "] ";
738 unsigned Tag = getTag();
739 OS << " [" << dwarf::TagString(Tag) << "] ";
741 // TODO : Print context
742 OS << " [" << getLineNumber() << "] ";
750 if (isGlobalVariable())
751 DIGlobalVariable(DbgNode).print(OS);
755 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
756 const LLVMContext &Ctx) {
757 if (!DL.isUnknown()) { // Print source line info.
758 DIScope Scope(DL.getScope(Ctx));
759 // Omit the directory, because it's likely to be long and uninteresting.
761 CommentOS << Scope.getFilename();
763 CommentOS << "<unknown>";
764 CommentOS << ':' << DL.getLine();
765 if (DL.getCol() != 0)
766 CommentOS << ':' << DL.getCol();
767 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
768 if (!InlinedAtDL.isUnknown()) {
770 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
776 void DIVariable::printExtendedName(raw_ostream &OS) const {
777 const LLVMContext &Ctx = DbgNode->getContext();
778 StringRef Res = getName();
780 OS << Res << "," << getLineNumber();
781 if (MDNode *InlinedAt = getInlinedAt()) {
782 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
783 if (!InlinedAtDL.isUnknown()) {
785 printDebugLoc(InlinedAtDL, OS, Ctx);
791 /// print - Print variable.
792 void DIVariable::print(raw_ostream &OS) const {
793 StringRef Res = getName();
795 OS << " [" << Res << "] ";
797 OS << " [" << getLineNumber() << "] ";
801 // FIXME: Dump complex addresses
804 /// dump - Print descriptor to dbgs() with a newline.
805 void DIDescriptor::dump() const {
806 print(dbgs()); dbgs() << '\n';
809 /// dump - Print compile unit to dbgs() with a newline.
810 void DICompileUnit::dump() const {
811 print(dbgs()); dbgs() << '\n';
814 /// dump - Print type to dbgs() with a newline.
815 void DIType::dump() const {
816 print(dbgs()); dbgs() << '\n';
819 /// dump - Print basic type to dbgs() with a newline.
820 void DIBasicType::dump() const {
821 print(dbgs()); dbgs() << '\n';
824 /// dump - Print derived type to dbgs() with a newline.
825 void DIDerivedType::dump() const {
826 print(dbgs()); dbgs() << '\n';
829 /// dump - Print composite type to dbgs() with a newline.
830 void DICompositeType::dump() const {
831 print(dbgs()); dbgs() << '\n';
834 /// dump - Print subprogram to dbgs() with a newline.
835 void DISubprogram::dump() const {
836 print(dbgs()); dbgs() << '\n';
839 /// dump - Print global variable.
840 void DIGlobalVariable::dump() const {
841 print(dbgs()); dbgs() << '\n';
844 /// dump - Print variable.
845 void DIVariable::dump() const {
846 print(dbgs()); dbgs() << '\n';
849 /// fixupObjcLikeName - Replace contains special characters used
850 /// in a typical Objective-C names with '.' in a given string.
851 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
852 bool isObjCLike = false;
853 for (size_t i = 0, e = Str.size(); i < e; ++i) {
858 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
859 C == '+' || C == '(' || C == ')'))
866 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
867 /// suitable to hold function specific information.
868 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
869 SmallString<32> Name = StringRef("llvm.dbg.lv.");
870 StringRef FName = "fn";
871 if (Fn.getFunction())
872 FName = Fn.getFunction()->getName();
874 FName = Fn.getName();
876 if (FName.startswith(StringRef(&One, 1)))
877 FName = FName.substr(1);
878 fixupObjcLikeName(FName, Name);
879 return M.getNamedMetadata(Name.str());
882 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
883 /// to hold function specific information.
884 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
885 SmallString<32> Name = StringRef("llvm.dbg.lv.");
886 StringRef FName = "fn";
887 if (Fn.getFunction())
888 FName = Fn.getFunction()->getName();
890 FName = Fn.getName();
892 if (FName.startswith(StringRef(&One, 1)))
893 FName = FName.substr(1);
894 fixupObjcLikeName(FName, Name);
896 return M.getOrInsertNamedMetadata(Name.str());
899 /// createInlinedVariable - Create a new inlined variable based on current
901 /// @param DV Current Variable.
902 /// @param InlinedScope Location at current variable is inlined.
903 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
904 LLVMContext &VMContext) {
905 SmallVector<Value *, 16> Elts;
906 // Insert inlined scope as 7th element.
907 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
908 i == 7 ? Elts.push_back(InlinedScope) :
909 Elts.push_back(DV->getOperand(i));
910 return DIVariable(MDNode::get(VMContext, Elts));
913 /// cleanseInlinedVariable - Remove inlined scope from the variable.
914 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
915 SmallVector<Value *, 16> Elts;
916 // Insert inlined scope as 7th element.
917 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
919 Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext))):
920 Elts.push_back(DV->getOperand(i));
921 return DIVariable(MDNode::get(VMContext, Elts));
924 //===----------------------------------------------------------------------===//
925 // DebugInfoFinder implementations.
926 //===----------------------------------------------------------------------===//
928 /// processModule - Process entire module and collect debug info.
929 void DebugInfoFinder::processModule(Module &M) {
930 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
931 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
932 DICompileUnit CU(CU_Nodes->getOperand(i));
934 if (CU.getVersion() > LLVMDebugVersion10) {
935 DIArray GVs = CU.getGlobalVariables();
936 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
937 DIGlobalVariable DIG(GVs.getElement(i));
938 if (addGlobalVariable(DIG))
939 processType(DIG.getType());
941 DIArray SPs = CU.getSubprograms();
942 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
943 processSubprogram(DISubprogram(SPs.getElement(i)));
944 DIArray EnumTypes = CU.getEnumTypes();
945 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
946 processType(DIType(EnumTypes.getElement(i)));
947 DIArray RetainedTypes = CU.getRetainedTypes();
948 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
949 processType(DIType(RetainedTypes.getElement(i)));
955 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
956 for (Function::iterator FI = (*I).begin(), FE = (*I).end(); FI != FE; ++FI)
957 for (BasicBlock::iterator BI = (*FI).begin(), BE = (*FI).end(); BI != BE;
959 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
962 DebugLoc Loc = BI->getDebugLoc();
966 LLVMContext &Ctx = BI->getContext();
967 DIDescriptor Scope(Loc.getScope(Ctx));
969 if (Scope.isCompileUnit())
970 addCompileUnit(DICompileUnit(Scope));
971 else if (Scope.isSubprogram())
972 processSubprogram(DISubprogram(Scope));
973 else if (Scope.isLexicalBlockFile()) {
974 DILexicalBlockFile DBF = DILexicalBlockFile(Scope);
975 processLexicalBlock(DILexicalBlock(DBF.getScope()));
977 else if (Scope.isLexicalBlock())
978 processLexicalBlock(DILexicalBlock(Scope));
980 if (MDNode *IA = Loc.getInlinedAt(Ctx))
981 processLocation(DILocation(IA));
984 if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv")) {
985 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
986 DIGlobalVariable DIG(cast<MDNode>(NMD->getOperand(i)));
987 if (addGlobalVariable(DIG)) {
988 if (DIG.getVersion() <= LLVMDebugVersion10)
989 addCompileUnit(DIG.getCompileUnit());
990 processType(DIG.getType());
995 if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.sp"))
996 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
997 processSubprogram(DISubprogram(NMD->getOperand(i)));
1000 /// processLocation - Process DILocation.
1001 void DebugInfoFinder::processLocation(DILocation Loc) {
1002 if (!Loc.Verify()) return;
1003 DIDescriptor S(Loc.getScope());
1004 if (S.isCompileUnit())
1005 addCompileUnit(DICompileUnit(S));
1006 else if (S.isSubprogram())
1007 processSubprogram(DISubprogram(S));
1008 else if (S.isLexicalBlock())
1009 processLexicalBlock(DILexicalBlock(S));
1010 else if (S.isLexicalBlockFile()) {
1011 DILexicalBlockFile DBF = DILexicalBlockFile(S);
1012 processLexicalBlock(DILexicalBlock(DBF.getScope()));
1014 processLocation(Loc.getOrigLocation());
1017 /// processType - Process DIType.
1018 void DebugInfoFinder::processType(DIType DT) {
1021 if (DT.getVersion() <= LLVMDebugVersion10)
1022 addCompileUnit(DT.getCompileUnit());
1023 if (DT.isCompositeType()) {
1024 DICompositeType DCT(DT);
1025 processType(DCT.getTypeDerivedFrom());
1026 DIArray DA = DCT.getTypeArray();
1027 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1028 DIDescriptor D = DA.getElement(i);
1030 processType(DIType(D));
1031 else if (D.isSubprogram())
1032 processSubprogram(DISubprogram(D));
1034 } else if (DT.isDerivedType()) {
1035 DIDerivedType DDT(DT);
1036 processType(DDT.getTypeDerivedFrom());
1040 /// processLexicalBlock
1041 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
1042 DIScope Context = LB.getContext();
1043 if (Context.isLexicalBlock())
1044 return processLexicalBlock(DILexicalBlock(Context));
1045 else if (Context.isLexicalBlockFile()) {
1046 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
1047 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
1050 return processSubprogram(DISubprogram(Context));
1053 /// processSubprogram - Process DISubprogram.
1054 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1055 if (!addSubprogram(SP))
1057 if (SP.getVersion() <= LLVMDebugVersion10)
1058 addCompileUnit(SP.getCompileUnit());
1059 processType(SP.getType());
1062 /// processDeclare - Process DbgDeclareInst.
1063 void DebugInfoFinder::processDeclare(DbgDeclareInst *DDI) {
1064 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1068 if (!DV.isVariable())
1071 if (!NodesSeen.insert(DV))
1073 if (DIVariable(N).getVersion() <= LLVMDebugVersion10)
1074 addCompileUnit(DIVariable(N).getCompileUnit());
1075 processType(DIVariable(N).getType());
1078 /// addType - Add type into Tys.
1079 bool DebugInfoFinder::addType(DIType DT) {
1083 if (!NodesSeen.insert(DT))
1090 /// addCompileUnit - Add compile unit into CUs.
1091 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1095 if (!NodesSeen.insert(CU))
1102 /// addGlobalVariable - Add global variable into GVs.
1103 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1104 if (!DIDescriptor(DIG).isGlobalVariable())
1107 if (!NodesSeen.insert(DIG))
1114 // addSubprogram - Add subprgoram into SPs.
1115 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1116 if (!DIDescriptor(SP).isSubprogram())
1119 if (!NodesSeen.insert(SP))
1126 /// getDISubprogram - Find subprogram that is enclosing this scope.
1127 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
1128 DIDescriptor D(Scope);
1129 if (D.isSubprogram())
1130 return DISubprogram(Scope);
1132 if (D.isLexicalBlockFile())
1133 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
1135 if (D.isLexicalBlock())
1136 return getDISubprogram(DILexicalBlock(Scope).getContext());
1138 return DISubprogram();
1141 /// getDICompositeType - Find underlying composite type.
1142 DICompositeType llvm::getDICompositeType(DIType T) {
1143 if (T.isCompositeType())
1144 return DICompositeType(T);
1146 if (T.isDerivedType())
1147 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
1149 return DICompositeType();
1152 /// isSubprogramContext - Return true if Context is either a subprogram
1153 /// or another context nested inside a subprogram.
1154 bool llvm::isSubprogramContext(const MDNode *Context) {
1157 DIDescriptor D(Context);
1158 if (D.isSubprogram())
1161 return isSubprogramContext(DIType(Context).getContext());