1 //===--- DebugInfo.cpp - Debug Information Helper Classes -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the helper classes used to build and interpret debug
11 // information in LLVM IR form.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/DebugInfo.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallPtrSet.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/Analysis/ValueTracking.h"
20 #include "llvm/IR/Constants.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/Instructions.h"
23 #include "llvm/IR/IntrinsicInst.h"
24 #include "llvm/IR/Intrinsics.h"
25 #include "llvm/IR/Module.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/ValueHandle.h"
29 #include "llvm/Support/raw_ostream.h"
31 using namespace llvm::dwarf;
33 //===----------------------------------------------------------------------===//
35 //===----------------------------------------------------------------------===//
37 DIDescriptor::DIDescriptor(const DIFile F) : DbgNode(F.DbgNode) {
40 DIDescriptor::DIDescriptor(const DISubprogram F) : DbgNode(F.DbgNode) {
43 DIDescriptor::DIDescriptor(const DILexicalBlockFile F) : DbgNode(F.DbgNode) {
46 DIDescriptor::DIDescriptor(const DILexicalBlock F) : DbgNode(F.DbgNode) {
49 DIDescriptor::DIDescriptor(const DIVariable F) : DbgNode(F.DbgNode) {
52 DIDescriptor::DIDescriptor(const DIType F) : DbgNode(F.DbgNode) {
55 bool DIDescriptor::Verify() const {
57 (DIDerivedType(DbgNode).Verify() ||
58 DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
59 DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
60 DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
61 DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
62 DILexicalBlock(DbgNode).Verify() ||
63 DILexicalBlockFile(DbgNode).Verify() ||
64 DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
65 DIObjCProperty(DbgNode).Verify() ||
66 DITemplateTypeParameter(DbgNode).Verify() ||
67 DITemplateValueParameter(DbgNode).Verify() ||
68 DIImportedEntity(DbgNode).Verify());
71 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
72 if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
74 return DbgNode->getOperand(Elt);
77 static const MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
78 if (const MDNode *R = dyn_cast_or_null<MDNode>(getField(DbgNode, Elt)))
83 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
84 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
85 return MDS->getString();
89 StringRef DIDescriptor::getStringField(unsigned Elt) const {
90 return ::getStringField(DbgNode, Elt);
93 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
97 if (Elt < DbgNode->getNumOperands())
99 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
100 return CI->getZExtValue();
105 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
109 if (Elt < DbgNode->getNumOperands())
111 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
112 return CI->getSExtValue();
117 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
119 return DIDescriptor();
121 if (Elt < DbgNode->getNumOperands())
123 DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
124 return DIDescriptor();
127 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
131 if (Elt < DbgNode->getNumOperands())
132 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
136 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
140 if (Elt < DbgNode->getNumOperands())
141 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
145 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
149 if (Elt < DbgNode->getNumOperands())
150 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
154 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
158 if (Elt < DbgNode->getNumOperands()) {
159 MDNode *Node = const_cast<MDNode*>(DbgNode);
160 Node->replaceOperandWith(Elt, F);
164 unsigned DIVariable::getNumAddrElements() const {
165 return DbgNode->getNumOperands()-8;
168 /// getInlinedAt - If this variable is inlined then return inline location.
169 MDNode *DIVariable::getInlinedAt() const {
170 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(7));
173 //===----------------------------------------------------------------------===//
175 //===----------------------------------------------------------------------===//
177 /// isBasicType - Return true if the specified tag is legal for
179 bool DIDescriptor::isBasicType() const {
180 if (!DbgNode) return false;
182 case dwarf::DW_TAG_base_type:
183 case dwarf::DW_TAG_unspecified_type:
190 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
191 bool DIDescriptor::isDerivedType() const {
192 if (!DbgNode) return false;
194 case dwarf::DW_TAG_typedef:
195 case dwarf::DW_TAG_pointer_type:
196 case dwarf::DW_TAG_ptr_to_member_type:
197 case dwarf::DW_TAG_reference_type:
198 case dwarf::DW_TAG_rvalue_reference_type:
199 case dwarf::DW_TAG_const_type:
200 case dwarf::DW_TAG_volatile_type:
201 case dwarf::DW_TAG_restrict_type:
202 case dwarf::DW_TAG_member:
203 case dwarf::DW_TAG_inheritance:
204 case dwarf::DW_TAG_friend:
207 // CompositeTypes are currently modelled as DerivedTypes.
208 return isCompositeType();
212 /// isCompositeType - Return true if the specified tag is legal for
214 bool DIDescriptor::isCompositeType() const {
215 if (!DbgNode) return false;
217 case dwarf::DW_TAG_array_type:
218 case dwarf::DW_TAG_structure_type:
219 case dwarf::DW_TAG_union_type:
220 case dwarf::DW_TAG_enumeration_type:
221 case dwarf::DW_TAG_subroutine_type:
222 case dwarf::DW_TAG_class_type:
229 /// isVariable - Return true if the specified tag is legal for DIVariable.
230 bool DIDescriptor::isVariable() const {
231 if (!DbgNode) return false;
233 case dwarf::DW_TAG_auto_variable:
234 case dwarf::DW_TAG_arg_variable:
241 /// isType - Return true if the specified tag is legal for DIType.
242 bool DIDescriptor::isType() const {
243 return isBasicType() || isCompositeType() || isDerivedType();
246 /// isSubprogram - Return true if the specified tag is legal for
248 bool DIDescriptor::isSubprogram() const {
249 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
252 /// isGlobalVariable - Return true if the specified tag is legal for
253 /// DIGlobalVariable.
254 bool DIDescriptor::isGlobalVariable() const {
255 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
256 getTag() == dwarf::DW_TAG_constant);
259 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
260 bool DIDescriptor::isGlobal() const {
261 return isGlobalVariable();
264 /// isUnspecifiedParmeter - Return true if the specified tag is
265 /// DW_TAG_unspecified_parameters.
266 bool DIDescriptor::isUnspecifiedParameter() const {
267 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
270 /// isScope - Return true if the specified tag is one of the scope
272 bool DIDescriptor::isScope() const {
273 if (!DbgNode) return false;
275 case dwarf::DW_TAG_compile_unit:
276 case dwarf::DW_TAG_lexical_block:
277 case dwarf::DW_TAG_subprogram:
278 case dwarf::DW_TAG_namespace:
286 /// isTemplateTypeParameter - Return true if the specified tag is
287 /// DW_TAG_template_type_parameter.
288 bool DIDescriptor::isTemplateTypeParameter() const {
289 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
292 /// isTemplateValueParameter - Return true if the specified tag is
293 /// DW_TAG_template_value_parameter.
294 bool DIDescriptor::isTemplateValueParameter() const {
295 return DbgNode && getTag() == dwarf::DW_TAG_template_value_parameter;
298 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
299 bool DIDescriptor::isCompileUnit() const {
300 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
303 /// isFile - Return true if the specified tag is DW_TAG_file_type.
304 bool DIDescriptor::isFile() const {
305 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
308 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
309 bool DIDescriptor::isNameSpace() const {
310 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
313 /// isLexicalBlockFile - Return true if the specified descriptor is a
314 /// lexical block with an extra file.
315 bool DIDescriptor::isLexicalBlockFile() const {
316 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
317 (DbgNode->getNumOperands() == 3);
320 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
321 bool DIDescriptor::isLexicalBlock() const {
322 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
323 (DbgNode->getNumOperands() > 3);
326 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
327 bool DIDescriptor::isSubrange() const {
328 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
331 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
332 bool DIDescriptor::isEnumerator() const {
333 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
336 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
337 bool DIDescriptor::isObjCProperty() const {
338 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
341 /// \brief Return true if the specified tag is DW_TAG_imported_module or
342 /// DW_TAG_imported_declaration.
343 bool DIDescriptor::isImportedEntity() const {
344 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
345 getTag() == dwarf::DW_TAG_imported_declaration);
348 //===----------------------------------------------------------------------===//
349 // Simple Descriptor Constructors and other Methods
350 //===----------------------------------------------------------------------===//
352 DIType::DIType(const MDNode *N) : DIScope(N) {
354 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
359 unsigned DIArray::getNumElements() const {
362 return DbgNode->getNumOperands();
365 /// replaceAllUsesWith - Replace all uses of debug info referenced by
367 void DIType::replaceAllUsesWith(DIDescriptor &D) {
371 // Since we use a TrackingVH for the node, its easy for clients to manufacture
372 // legitimate situations where they want to replaceAllUsesWith() on something
373 // which, due to uniquing, has merged with the source. We shield clients from
374 // this detail by allowing a value to be replaced with replaceAllUsesWith()
377 MDNode *Node = const_cast<MDNode*>(DbgNode);
378 const MDNode *DN = D;
379 const Value *V = cast_or_null<Value>(DN);
380 Node->replaceAllUsesWith(const_cast<Value*>(V));
381 MDNode::deleteTemporary(Node);
385 /// replaceAllUsesWith - Replace all uses of debug info referenced by
387 void DIType::replaceAllUsesWith(MDNode *D) {
391 // Since we use a TrackingVH for the node, its easy for clients to manufacture
392 // legitimate situations where they want to replaceAllUsesWith() on something
393 // which, due to uniquing, has merged with the source. We shield clients from
394 // this detail by allowing a value to be replaced with replaceAllUsesWith()
397 MDNode *Node = const_cast<MDNode*>(DbgNode);
398 const MDNode *DN = D;
399 const Value *V = cast_or_null<Value>(DN);
400 Node->replaceAllUsesWith(const_cast<Value*>(V));
401 MDNode::deleteTemporary(Node);
405 /// isUnsignedDIType - Return true if type encoding is unsigned.
406 bool DIType::isUnsignedDIType() {
407 DIDerivedType DTy(DbgNode);
409 return DTy.getTypeDerivedFrom().isUnsignedDIType();
411 DIBasicType BTy(DbgNode);
413 unsigned Encoding = BTy.getEncoding();
414 if (Encoding == dwarf::DW_ATE_unsigned ||
415 Encoding == dwarf::DW_ATE_unsigned_char ||
416 Encoding == dwarf::DW_ATE_boolean)
422 /// Verify - Verify that a compile unit is well formed.
423 bool DICompileUnit::Verify() const {
424 if (!isCompileUnit())
426 StringRef N = getFilename();
429 // It is possible that directory and produce string is empty.
430 return DbgNode->getNumOperands() == 13;
433 /// Verify - Verify that an ObjC property is well formed.
434 bool DIObjCProperty::Verify() const {
435 if (!isObjCProperty())
438 DIType Ty = getType();
439 if (!Ty.Verify()) return false;
441 // Don't worry about the rest of the strings for now.
442 return DbgNode->getNumOperands() == 8;
445 /// Verify - Verify that a type descriptor is well formed.
446 bool DIType::Verify() const {
449 if (getContext() && !getContext().Verify())
451 unsigned Tag = getTag();
452 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
453 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
454 Tag != dwarf::DW_TAG_ptr_to_member_type &&
455 Tag != dwarf::DW_TAG_reference_type &&
456 Tag != dwarf::DW_TAG_rvalue_reference_type &&
457 Tag != dwarf::DW_TAG_restrict_type &&
458 Tag != dwarf::DW_TAG_array_type &&
459 Tag != dwarf::DW_TAG_enumeration_type &&
460 Tag != dwarf::DW_TAG_subroutine_type &&
461 getFilename().empty())
466 /// Verify - Verify that a basic type descriptor is well formed.
467 bool DIBasicType::Verify() const {
468 return isBasicType() && DbgNode->getNumOperands() == 10;
471 /// Verify - Verify that a derived type descriptor is well formed.
472 bool DIDerivedType::Verify() const {
473 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
474 DbgNode->getNumOperands() <= 14;
477 /// Verify - Verify that a composite type descriptor is well formed.
478 bool DICompositeType::Verify() const {
479 if (!isCompositeType())
481 if (getContext() && !getContext().Verify())
484 return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
487 /// Verify - Verify that a subprogram descriptor is well formed.
488 bool DISubprogram::Verify() const {
492 if (getContext() && !getContext().Verify())
495 DICompositeType Ty = getType();
498 return DbgNode->getNumOperands() == 20;
501 /// Verify - Verify that a global variable descriptor is well formed.
502 bool DIGlobalVariable::Verify() const {
503 if (!isGlobalVariable())
506 if (getDisplayName().empty())
509 if (getContext() && !getContext().Verify())
512 DIType Ty = getType();
516 if (!getGlobal() && !getConstant())
519 return DbgNode->getNumOperands() == 13;
522 /// Verify - Verify that a variable descriptor is well formed.
523 bool DIVariable::Verify() const {
527 if (getContext() && !getContext().Verify())
530 DIType Ty = getType();
534 return DbgNode->getNumOperands() >= 8;
537 /// Verify - Verify that a location descriptor is well formed.
538 bool DILocation::Verify() const {
542 return DbgNode->getNumOperands() == 4;
545 /// Verify - Verify that a namespace descriptor is well formed.
546 bool DINameSpace::Verify() const {
549 return DbgNode->getNumOperands() == 5;
552 /// \brief Retrieve the MDNode for the directory/file pair.
553 MDNode *DIFile::getFileNode() const {
554 return const_cast<MDNode*>(getNodeField(DbgNode, 1));
557 /// \brief Verify that the file descriptor is well formed.
558 bool DIFile::Verify() const {
559 return isFile() && DbgNode->getNumOperands() == 2;
562 /// \brief Verify that the enumerator descriptor is well formed.
563 bool DIEnumerator::Verify() const {
564 return isEnumerator() && DbgNode->getNumOperands() == 3;
567 /// \brief Verify that the subrange descriptor is well formed.
568 bool DISubrange::Verify() const {
569 return isSubrange() && DbgNode->getNumOperands() == 3;
572 /// \brief Verify that the lexical block descriptor is well formed.
573 bool DILexicalBlock::Verify() const {
574 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
577 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
578 bool DILexicalBlockFile::Verify() const {
579 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
582 /// \brief Verify that the template type parameter descriptor is well formed.
583 bool DITemplateTypeParameter::Verify() const {
584 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
587 /// \brief Verify that the template value parameter descriptor is well formed.
588 bool DITemplateValueParameter::Verify() const {
589 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
592 /// \brief Verify that the imported module descriptor is well formed.
593 bool DIImportedEntity::Verify() const {
594 return isImportedEntity() &&
595 (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
598 /// getOriginalTypeSize - If this type is derived from a base type then
599 /// return base type size.
600 uint64_t DIDerivedType::getOriginalTypeSize() const {
601 unsigned Tag = getTag();
603 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
604 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
605 Tag != dwarf::DW_TAG_restrict_type)
606 return getSizeInBits();
608 DIType BaseType = getTypeDerivedFrom();
610 // If this type is not derived from any type then take conservative approach.
611 if (!BaseType.isValid())
612 return getSizeInBits();
614 // If this is a derived type, go ahead and get the base type, unless it's a
615 // reference then it's just the size of the field. Pointer types have no need
616 // of this since they're a different type of qualification on the type.
617 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
618 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
619 return getSizeInBits();
621 if (BaseType.isDerivedType())
622 return DIDerivedType(BaseType).getOriginalTypeSize();
624 return BaseType.getSizeInBits();
627 /// getObjCProperty - Return property node, if this ivar is associated with one.
628 MDNode *DIDerivedType::getObjCProperty() const {
629 if (DbgNode->getNumOperands() <= 10)
631 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
634 /// \brief Set the array of member DITypes.
635 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
636 assert((!TParams || DbgNode->getNumOperands() == 14) &&
637 "If you're setting the template parameters this should include a slot "
639 TrackingVH<MDNode> N(*this);
640 N->replaceOperandWith(10, Elements);
642 N->replaceOperandWith(13, TParams);
646 /// \brief Set the containing type.
647 void DICompositeType::setContainingType(DICompositeType ContainingType) {
648 TrackingVH<MDNode> N(*this);
649 N->replaceOperandWith(12, ContainingType);
653 /// isInlinedFnArgument - Return true if this variable provides debugging
654 /// information for an inlined function arguments.
655 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
656 assert(CurFn && "Invalid function");
657 if (!getContext().isSubprogram())
659 // This variable is not inlined function argument if its scope
660 // does not describe current function.
661 return !DISubprogram(getContext()).describes(CurFn);
664 /// describes - Return true if this subprogram provides debugging
665 /// information for the function F.
666 bool DISubprogram::describes(const Function *F) {
667 assert(F && "Invalid function");
668 if (F == getFunction())
670 StringRef Name = getLinkageName();
673 if (F->getName() == Name)
678 unsigned DISubprogram::isOptimized() const {
679 assert (DbgNode && "Invalid subprogram descriptor!");
680 if (DbgNode->getNumOperands() == 15)
681 return getUnsignedField(14);
685 MDNode *DISubprogram::getVariablesNodes() const {
686 if (!DbgNode || DbgNode->getNumOperands() <= 18)
688 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(18));
691 DIArray DISubprogram::getVariables() const {
692 if (!DbgNode || DbgNode->getNumOperands() <= 18)
694 if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(18)))
699 Value *DITemplateValueParameter::getValue() const {
700 return getField(DbgNode, 4);
703 void DIScope::setFilename(StringRef Name, LLVMContext &Context) {
706 MDString *MDName(MDString::get(Context, Name));
707 const_cast<MDNode*>(getNodeField(DbgNode, 1))->replaceOperandWith(0, MDName);
710 StringRef DIScope::getFilename() const {
713 return ::getStringField(getNodeField(DbgNode, 1), 0);
716 StringRef DIScope::getDirectory() const {
719 return ::getStringField(getNodeField(DbgNode, 1), 1);
722 DIArray DICompileUnit::getEnumTypes() const {
723 if (!DbgNode || DbgNode->getNumOperands() < 13)
726 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(7)))
731 DIArray DICompileUnit::getRetainedTypes() const {
732 if (!DbgNode || DbgNode->getNumOperands() < 13)
735 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(8)))
740 DIArray DICompileUnit::getSubprograms() const {
741 if (!DbgNode || DbgNode->getNumOperands() < 13)
744 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(9)))
750 DIArray DICompileUnit::getGlobalVariables() const {
751 if (!DbgNode || DbgNode->getNumOperands() < 13)
754 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
759 DIArray DICompileUnit::getImportedEntities() const {
760 if (!DbgNode || DbgNode->getNumOperands() < 13)
763 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
768 /// fixupObjcLikeName - Replace contains special characters used
769 /// in a typical Objective-C names with '.' in a given string.
770 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
771 bool isObjCLike = false;
772 for (size_t i = 0, e = Str.size(); i < e; ++i) {
777 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
778 C == '+' || C == '(' || C == ')'))
785 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
786 /// suitable to hold function specific information.
787 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
788 SmallString<32> Name = StringRef("llvm.dbg.lv.");
789 StringRef FName = "fn";
790 if (Fn.getFunction())
791 FName = Fn.getFunction()->getName();
793 FName = Fn.getName();
795 if (FName.startswith(StringRef(&One, 1)))
796 FName = FName.substr(1);
797 fixupObjcLikeName(FName, Name);
798 return M.getNamedMetadata(Name.str());
801 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
802 /// to hold function specific information.
803 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
804 SmallString<32> Name = StringRef("llvm.dbg.lv.");
805 StringRef FName = "fn";
806 if (Fn.getFunction())
807 FName = Fn.getFunction()->getName();
809 FName = Fn.getName();
811 if (FName.startswith(StringRef(&One, 1)))
812 FName = FName.substr(1);
813 fixupObjcLikeName(FName, Name);
815 return M.getOrInsertNamedMetadata(Name.str());
818 /// createInlinedVariable - Create a new inlined variable based on current
820 /// @param DV Current Variable.
821 /// @param InlinedScope Location at current variable is inlined.
822 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
823 LLVMContext &VMContext) {
824 SmallVector<Value *, 16> Elts;
825 // Insert inlined scope as 7th element.
826 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
827 i == 7 ? Elts.push_back(InlinedScope) :
828 Elts.push_back(DV->getOperand(i));
829 return DIVariable(MDNode::get(VMContext, Elts));
832 /// cleanseInlinedVariable - Remove inlined scope from the variable.
833 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
834 SmallVector<Value *, 16> Elts;
835 // Insert inlined scope as 7th element.
836 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
838 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
839 Elts.push_back(DV->getOperand(i));
840 return DIVariable(MDNode::get(VMContext, Elts));
843 /// getDISubprogram - Find subprogram that is enclosing this scope.
844 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
845 DIDescriptor D(Scope);
846 if (D.isSubprogram())
847 return DISubprogram(Scope);
849 if (D.isLexicalBlockFile())
850 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
852 if (D.isLexicalBlock())
853 return getDISubprogram(DILexicalBlock(Scope).getContext());
855 return DISubprogram();
858 /// getDICompositeType - Find underlying composite type.
859 DICompositeType llvm::getDICompositeType(DIType T) {
860 if (T.isCompositeType())
861 return DICompositeType(T);
863 if (T.isDerivedType())
864 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
866 return DICompositeType();
869 /// isSubprogramContext - Return true if Context is either a subprogram
870 /// or another context nested inside a subprogram.
871 bool llvm::isSubprogramContext(const MDNode *Context) {
874 DIDescriptor D(Context);
875 if (D.isSubprogram())
878 return isSubprogramContext(DIType(Context).getContext());
882 //===----------------------------------------------------------------------===//
883 // DebugInfoFinder implementations.
884 //===----------------------------------------------------------------------===//
886 /// processModule - Process entire module and collect debug info.
887 void DebugInfoFinder::processModule(const Module &M) {
888 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
889 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
890 DICompileUnit CU(CU_Nodes->getOperand(i));
892 DIArray GVs = CU.getGlobalVariables();
893 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
894 DIGlobalVariable DIG(GVs.getElement(i));
895 if (addGlobalVariable(DIG))
896 processType(DIG.getType());
898 DIArray SPs = CU.getSubprograms();
899 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
900 processSubprogram(DISubprogram(SPs.getElement(i)));
901 DIArray EnumTypes = CU.getEnumTypes();
902 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
903 processType(DIType(EnumTypes.getElement(i)));
904 DIArray RetainedTypes = CU.getRetainedTypes();
905 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
906 processType(DIType(RetainedTypes.getElement(i)));
907 // FIXME: We really shouldn't be bailing out after visiting just one CU
913 /// processLocation - Process DILocation.
914 void DebugInfoFinder::processLocation(DILocation Loc) {
915 if (!Loc.Verify()) return;
916 DIDescriptor S(Loc.getScope());
917 if (S.isCompileUnit())
918 addCompileUnit(DICompileUnit(S));
919 else if (S.isSubprogram())
920 processSubprogram(DISubprogram(S));
921 else if (S.isLexicalBlock())
922 processLexicalBlock(DILexicalBlock(S));
923 else if (S.isLexicalBlockFile()) {
924 DILexicalBlockFile DBF = DILexicalBlockFile(S);
925 processLexicalBlock(DILexicalBlock(DBF.getScope()));
927 processLocation(Loc.getOrigLocation());
930 /// processType - Process DIType.
931 void DebugInfoFinder::processType(DIType DT) {
934 if (DT.isCompositeType()) {
935 DICompositeType DCT(DT);
936 processType(DCT.getTypeDerivedFrom());
937 DIArray DA = DCT.getTypeArray();
938 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
939 DIDescriptor D = DA.getElement(i);
941 processType(DIType(D));
942 else if (D.isSubprogram())
943 processSubprogram(DISubprogram(D));
945 } else if (DT.isDerivedType()) {
946 DIDerivedType DDT(DT);
947 processType(DDT.getTypeDerivedFrom());
951 /// processLexicalBlock
952 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
953 DIScope Context = LB.getContext();
954 if (Context.isLexicalBlock())
955 return processLexicalBlock(DILexicalBlock(Context));
956 else if (Context.isLexicalBlockFile()) {
957 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
958 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
961 return processSubprogram(DISubprogram(Context));
964 /// processSubprogram - Process DISubprogram.
965 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
966 if (!addSubprogram(SP))
968 processType(SP.getType());
971 /// processDeclare - Process DbgDeclareInst.
972 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
973 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
977 if (!DV.isVariable())
980 if (!NodesSeen.insert(DV))
982 processType(DIVariable(N).getType());
985 /// addType - Add type into Tys.
986 bool DebugInfoFinder::addType(DIType DT) {
990 if (!NodesSeen.insert(DT))
997 /// addCompileUnit - Add compile unit into CUs.
998 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1002 if (!NodesSeen.insert(CU))
1009 /// addGlobalVariable - Add global variable into GVs.
1010 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1011 if (!DIDescriptor(DIG).isGlobalVariable())
1014 if (!NodesSeen.insert(DIG))
1021 // addSubprogram - Add subprgoram into SPs.
1022 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1023 if (!DIDescriptor(SP).isSubprogram())
1026 if (!NodesSeen.insert(SP))
1033 //===----------------------------------------------------------------------===//
1034 // DIDescriptor: dump routines for all descriptors.
1035 //===----------------------------------------------------------------------===//
1037 /// dump - Print descriptor to dbgs() with a newline.
1038 void DIDescriptor::dump() const {
1039 print(dbgs()); dbgs() << '\n';
1042 /// print - Print descriptor.
1043 void DIDescriptor::print(raw_ostream &OS) const {
1044 if (!DbgNode) return;
1046 if (const char *Tag = dwarf::TagString(getTag()))
1047 OS << "[ " << Tag << " ]";
1049 if (this->isSubrange()) {
1050 DISubrange(DbgNode).printInternal(OS);
1051 } else if (this->isCompileUnit()) {
1052 DICompileUnit(DbgNode).printInternal(OS);
1053 } else if (this->isFile()) {
1054 DIFile(DbgNode).printInternal(OS);
1055 } else if (this->isEnumerator()) {
1056 DIEnumerator(DbgNode).printInternal(OS);
1057 } else if (this->isBasicType()) {
1058 DIType(DbgNode).printInternal(OS);
1059 } else if (this->isDerivedType()) {
1060 DIDerivedType(DbgNode).printInternal(OS);
1061 } else if (this->isCompositeType()) {
1062 DICompositeType(DbgNode).printInternal(OS);
1063 } else if (this->isSubprogram()) {
1064 DISubprogram(DbgNode).printInternal(OS);
1065 } else if (this->isGlobalVariable()) {
1066 DIGlobalVariable(DbgNode).printInternal(OS);
1067 } else if (this->isVariable()) {
1068 DIVariable(DbgNode).printInternal(OS);
1069 } else if (this->isObjCProperty()) {
1070 DIObjCProperty(DbgNode).printInternal(OS);
1071 } else if (this->isNameSpace()) {
1072 DINameSpace(DbgNode).printInternal(OS);
1073 } else if (this->isScope()) {
1074 DIScope(DbgNode).printInternal(OS);
1078 void DISubrange::printInternal(raw_ostream &OS) const {
1079 int64_t Count = getCount();
1081 OS << " [" << getLo() << ", " << Count - 1 << ']';
1083 OS << " [unbounded]";
1086 void DIScope::printInternal(raw_ostream &OS) const {
1087 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1090 void DICompileUnit::printInternal(raw_ostream &OS) const {
1091 DIScope::printInternal(OS);
1093 unsigned Lang = getLanguage();
1094 if (const char *LangStr = dwarf::LanguageString(Lang))
1097 (OS << "lang 0x").write_hex(Lang);
1101 void DIEnumerator::printInternal(raw_ostream &OS) const {
1102 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1105 void DIType::printInternal(raw_ostream &OS) const {
1106 if (!DbgNode) return;
1108 StringRef Res = getName();
1110 OS << " [" << Res << "]";
1112 // TODO: Print context?
1114 OS << " [line " << getLineNumber()
1115 << ", size " << getSizeInBits()
1116 << ", align " << getAlignInBits()
1117 << ", offset " << getOffsetInBits();
1119 if (const char *Enc =
1120 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1121 OS << ", enc " << Enc;
1126 else if (isProtected())
1127 OS << " [protected]";
1130 OS << " [artificial]";
1132 if (isForwardDecl())
1136 if (isStaticMember())
1140 void DIDerivedType::printInternal(raw_ostream &OS) const {
1141 DIType::printInternal(OS);
1142 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1145 void DICompositeType::printInternal(raw_ostream &OS) const {
1146 DIType::printInternal(OS);
1147 DIArray A = getTypeArray();
1148 OS << " [" << A.getNumElements() << " elements]";
1151 void DINameSpace::printInternal(raw_ostream &OS) const {
1152 StringRef Name = getName();
1154 OS << " [" << Name << ']';
1156 OS << " [line " << getLineNumber() << ']';
1159 void DISubprogram::printInternal(raw_ostream &OS) const {
1160 // TODO : Print context
1161 OS << " [line " << getLineNumber() << ']';
1163 if (isLocalToUnit())
1169 if (getScopeLineNumber() != getLineNumber())
1170 OS << " [scope " << getScopeLineNumber() << "]";
1174 else if (isProtected())
1175 OS << " [protected]";
1177 StringRef Res = getName();
1179 OS << " [" << Res << ']';
1182 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1183 StringRef Res = getName();
1185 OS << " [" << Res << ']';
1187 OS << " [line " << getLineNumber() << ']';
1189 // TODO : Print context
1191 if (isLocalToUnit())
1198 void DIVariable::printInternal(raw_ostream &OS) const {
1199 StringRef Res = getName();
1201 OS << " [" << Res << ']';
1203 OS << " [line " << getLineNumber() << ']';
1206 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1207 StringRef Name = getObjCPropertyName();
1209 OS << " [" << Name << ']';
1211 OS << " [line " << getLineNumber()
1212 << ", properties " << getUnsignedField(6) << ']';
1215 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1216 const LLVMContext &Ctx) {
1217 if (!DL.isUnknown()) { // Print source line info.
1218 DIScope Scope(DL.getScope(Ctx));
1219 // Omit the directory, because it's likely to be long and uninteresting.
1221 CommentOS << Scope.getFilename();
1223 CommentOS << "<unknown>";
1224 CommentOS << ':' << DL.getLine();
1225 if (DL.getCol() != 0)
1226 CommentOS << ':' << DL.getCol();
1227 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1228 if (!InlinedAtDL.isUnknown()) {
1229 CommentOS << " @[ ";
1230 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1236 void DIVariable::printExtendedName(raw_ostream &OS) const {
1237 const LLVMContext &Ctx = DbgNode->getContext();
1238 StringRef Res = getName();
1240 OS << Res << "," << getLineNumber();
1241 if (MDNode *InlinedAt = getInlinedAt()) {
1242 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1243 if (!InlinedAtDL.isUnknown()) {
1245 printDebugLoc(InlinedAtDL, OS, Ctx);