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() && DbgNode->getNumOperands() == 4;
597 /// getOriginalTypeSize - If this type is derived from a base type then
598 /// return base type size.
599 uint64_t DIDerivedType::getOriginalTypeSize() const {
600 unsigned Tag = getTag();
602 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
603 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
604 Tag != dwarf::DW_TAG_restrict_type)
605 return getSizeInBits();
607 DIType BaseType = getTypeDerivedFrom();
609 // If this type is not derived from any type then take conservative approach.
610 if (!BaseType.isValid())
611 return getSizeInBits();
613 // If this is a derived type, go ahead and get the base type, unless it's a
614 // reference then it's just the size of the field. Pointer types have no need
615 // of this since they're a different type of qualification on the type.
616 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
617 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
618 return getSizeInBits();
620 if (BaseType.isDerivedType())
621 return DIDerivedType(BaseType).getOriginalTypeSize();
623 return BaseType.getSizeInBits();
626 /// getObjCProperty - Return property node, if this ivar is associated with one.
627 MDNode *DIDerivedType::getObjCProperty() const {
628 if (DbgNode->getNumOperands() <= 10)
630 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
633 /// \brief Set the array of member DITypes.
634 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
635 assert((!TParams || DbgNode->getNumOperands() == 14) &&
636 "If you're setting the template parameters this should include a slot "
638 TrackingVH<MDNode> N(*this);
639 N->replaceOperandWith(10, Elements);
641 N->replaceOperandWith(13, TParams);
645 /// \brief Set the containing type.
646 void DICompositeType::setContainingType(DICompositeType ContainingType) {
647 TrackingVH<MDNode> N(*this);
648 N->replaceOperandWith(12, ContainingType);
652 /// isInlinedFnArgument - Return true if this variable provides debugging
653 /// information for an inlined function arguments.
654 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
655 assert(CurFn && "Invalid function");
656 if (!getContext().isSubprogram())
658 // This variable is not inlined function argument if its scope
659 // does not describe current function.
660 return !DISubprogram(getContext()).describes(CurFn);
663 /// describes - Return true if this subprogram provides debugging
664 /// information for the function F.
665 bool DISubprogram::describes(const Function *F) {
666 assert(F && "Invalid function");
667 if (F == getFunction())
669 StringRef Name = getLinkageName();
672 if (F->getName() == Name)
677 unsigned DISubprogram::isOptimized() const {
678 assert (DbgNode && "Invalid subprogram descriptor!");
679 if (DbgNode->getNumOperands() == 15)
680 return getUnsignedField(14);
684 MDNode *DISubprogram::getVariablesNodes() const {
685 if (!DbgNode || DbgNode->getNumOperands() <= 18)
687 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(18));
690 DIArray DISubprogram::getVariables() const {
691 if (!DbgNode || DbgNode->getNumOperands() <= 18)
693 if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(18)))
698 StringRef DIScope::getFilename() const {
701 return ::getStringField(getNodeField(DbgNode, 1), 0);
704 StringRef DIScope::getDirectory() const {
707 return ::getStringField(getNodeField(DbgNode, 1), 1);
710 DIArray DICompileUnit::getEnumTypes() const {
711 if (!DbgNode || DbgNode->getNumOperands() < 13)
714 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(7)))
719 DIArray DICompileUnit::getRetainedTypes() const {
720 if (!DbgNode || DbgNode->getNumOperands() < 13)
723 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(8)))
728 DIArray DICompileUnit::getSubprograms() const {
729 if (!DbgNode || DbgNode->getNumOperands() < 13)
732 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(9)))
738 DIArray DICompileUnit::getGlobalVariables() const {
739 if (!DbgNode || DbgNode->getNumOperands() < 13)
742 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
747 DIArray DICompileUnit::getImportedEntities() const {
748 if (!DbgNode || DbgNode->getNumOperands() < 13)
751 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
756 /// fixupObjcLikeName - Replace contains special characters used
757 /// in a typical Objective-C names with '.' in a given string.
758 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
759 bool isObjCLike = false;
760 for (size_t i = 0, e = Str.size(); i < e; ++i) {
765 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
766 C == '+' || C == '(' || C == ')'))
773 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
774 /// suitable to hold function specific information.
775 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
776 SmallString<32> Name = StringRef("llvm.dbg.lv.");
777 StringRef FName = "fn";
778 if (Fn.getFunction())
779 FName = Fn.getFunction()->getName();
781 FName = Fn.getName();
783 if (FName.startswith(StringRef(&One, 1)))
784 FName = FName.substr(1);
785 fixupObjcLikeName(FName, Name);
786 return M.getNamedMetadata(Name.str());
789 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
790 /// to hold function specific information.
791 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
792 SmallString<32> Name = StringRef("llvm.dbg.lv.");
793 StringRef FName = "fn";
794 if (Fn.getFunction())
795 FName = Fn.getFunction()->getName();
797 FName = Fn.getName();
799 if (FName.startswith(StringRef(&One, 1)))
800 FName = FName.substr(1);
801 fixupObjcLikeName(FName, Name);
803 return M.getOrInsertNamedMetadata(Name.str());
806 /// createInlinedVariable - Create a new inlined variable based on current
808 /// @param DV Current Variable.
809 /// @param InlinedScope Location at current variable is inlined.
810 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
811 LLVMContext &VMContext) {
812 SmallVector<Value *, 16> Elts;
813 // Insert inlined scope as 7th element.
814 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
815 i == 7 ? Elts.push_back(InlinedScope) :
816 Elts.push_back(DV->getOperand(i));
817 return DIVariable(MDNode::get(VMContext, Elts));
820 /// cleanseInlinedVariable - Remove inlined scope from the variable.
821 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
822 SmallVector<Value *, 16> Elts;
823 // Insert inlined scope as 7th element.
824 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
826 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
827 Elts.push_back(DV->getOperand(i));
828 return DIVariable(MDNode::get(VMContext, Elts));
831 /// getDISubprogram - Find subprogram that is enclosing this scope.
832 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
833 DIDescriptor D(Scope);
834 if (D.isSubprogram())
835 return DISubprogram(Scope);
837 if (D.isLexicalBlockFile())
838 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
840 if (D.isLexicalBlock())
841 return getDISubprogram(DILexicalBlock(Scope).getContext());
843 return DISubprogram();
846 /// getDICompositeType - Find underlying composite type.
847 DICompositeType llvm::getDICompositeType(DIType T) {
848 if (T.isCompositeType())
849 return DICompositeType(T);
851 if (T.isDerivedType())
852 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
854 return DICompositeType();
857 /// isSubprogramContext - Return true if Context is either a subprogram
858 /// or another context nested inside a subprogram.
859 bool llvm::isSubprogramContext(const MDNode *Context) {
862 DIDescriptor D(Context);
863 if (D.isSubprogram())
866 return isSubprogramContext(DIType(Context).getContext());
870 //===----------------------------------------------------------------------===//
871 // DebugInfoFinder implementations.
872 //===----------------------------------------------------------------------===//
874 /// processModule - Process entire module and collect debug info.
875 void DebugInfoFinder::processModule(const Module &M) {
876 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
877 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
878 DICompileUnit CU(CU_Nodes->getOperand(i));
880 DIArray GVs = CU.getGlobalVariables();
881 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
882 DIGlobalVariable DIG(GVs.getElement(i));
883 if (addGlobalVariable(DIG))
884 processType(DIG.getType());
886 DIArray SPs = CU.getSubprograms();
887 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
888 processSubprogram(DISubprogram(SPs.getElement(i)));
889 DIArray EnumTypes = CU.getEnumTypes();
890 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
891 processType(DIType(EnumTypes.getElement(i)));
892 DIArray RetainedTypes = CU.getRetainedTypes();
893 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
894 processType(DIType(RetainedTypes.getElement(i)));
895 // FIXME: We really shouldn't be bailing out after visiting just one CU
901 /// processLocation - Process DILocation.
902 void DebugInfoFinder::processLocation(DILocation Loc) {
903 if (!Loc.Verify()) return;
904 DIDescriptor S(Loc.getScope());
905 if (S.isCompileUnit())
906 addCompileUnit(DICompileUnit(S));
907 else if (S.isSubprogram())
908 processSubprogram(DISubprogram(S));
909 else if (S.isLexicalBlock())
910 processLexicalBlock(DILexicalBlock(S));
911 else if (S.isLexicalBlockFile()) {
912 DILexicalBlockFile DBF = DILexicalBlockFile(S);
913 processLexicalBlock(DILexicalBlock(DBF.getScope()));
915 processLocation(Loc.getOrigLocation());
918 /// processType - Process DIType.
919 void DebugInfoFinder::processType(DIType DT) {
922 if (DT.isCompositeType()) {
923 DICompositeType DCT(DT);
924 processType(DCT.getTypeDerivedFrom());
925 DIArray DA = DCT.getTypeArray();
926 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
927 DIDescriptor D = DA.getElement(i);
929 processType(DIType(D));
930 else if (D.isSubprogram())
931 processSubprogram(DISubprogram(D));
933 } else if (DT.isDerivedType()) {
934 DIDerivedType DDT(DT);
935 processType(DDT.getTypeDerivedFrom());
939 /// processLexicalBlock
940 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
941 DIScope Context = LB.getContext();
942 if (Context.isLexicalBlock())
943 return processLexicalBlock(DILexicalBlock(Context));
944 else if (Context.isLexicalBlockFile()) {
945 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
946 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
949 return processSubprogram(DISubprogram(Context));
952 /// processSubprogram - Process DISubprogram.
953 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
954 if (!addSubprogram(SP))
956 processType(SP.getType());
959 /// processDeclare - Process DbgDeclareInst.
960 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
961 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
965 if (!DV.isVariable())
968 if (!NodesSeen.insert(DV))
970 processType(DIVariable(N).getType());
973 /// addType - Add type into Tys.
974 bool DebugInfoFinder::addType(DIType DT) {
978 if (!NodesSeen.insert(DT))
985 /// addCompileUnit - Add compile unit into CUs.
986 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
990 if (!NodesSeen.insert(CU))
997 /// addGlobalVariable - Add global variable into GVs.
998 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
999 if (!DIDescriptor(DIG).isGlobalVariable())
1002 if (!NodesSeen.insert(DIG))
1009 // addSubprogram - Add subprgoram into SPs.
1010 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1011 if (!DIDescriptor(SP).isSubprogram())
1014 if (!NodesSeen.insert(SP))
1021 //===----------------------------------------------------------------------===//
1022 // DIDescriptor: dump routines for all descriptors.
1023 //===----------------------------------------------------------------------===//
1025 /// dump - Print descriptor to dbgs() with a newline.
1026 void DIDescriptor::dump() const {
1027 print(dbgs()); dbgs() << '\n';
1030 /// print - Print descriptor.
1031 void DIDescriptor::print(raw_ostream &OS) const {
1032 if (!DbgNode) return;
1034 if (const char *Tag = dwarf::TagString(getTag()))
1035 OS << "[ " << Tag << " ]";
1037 if (this->isSubrange()) {
1038 DISubrange(DbgNode).printInternal(OS);
1039 } else if (this->isCompileUnit()) {
1040 DICompileUnit(DbgNode).printInternal(OS);
1041 } else if (this->isFile()) {
1042 DIFile(DbgNode).printInternal(OS);
1043 } else if (this->isEnumerator()) {
1044 DIEnumerator(DbgNode).printInternal(OS);
1045 } else if (this->isBasicType()) {
1046 DIType(DbgNode).printInternal(OS);
1047 } else if (this->isDerivedType()) {
1048 DIDerivedType(DbgNode).printInternal(OS);
1049 } else if (this->isCompositeType()) {
1050 DICompositeType(DbgNode).printInternal(OS);
1051 } else if (this->isSubprogram()) {
1052 DISubprogram(DbgNode).printInternal(OS);
1053 } else if (this->isGlobalVariable()) {
1054 DIGlobalVariable(DbgNode).printInternal(OS);
1055 } else if (this->isVariable()) {
1056 DIVariable(DbgNode).printInternal(OS);
1057 } else if (this->isObjCProperty()) {
1058 DIObjCProperty(DbgNode).printInternal(OS);
1059 } else if (this->isNameSpace()) {
1060 DINameSpace(DbgNode).printInternal(OS);
1061 } else if (this->isScope()) {
1062 DIScope(DbgNode).printInternal(OS);
1066 void DISubrange::printInternal(raw_ostream &OS) const {
1067 int64_t Count = getCount();
1069 OS << " [" << getLo() << ", " << Count - 1 << ']';
1071 OS << " [unbounded]";
1074 void DIScope::printInternal(raw_ostream &OS) const {
1075 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1078 void DICompileUnit::printInternal(raw_ostream &OS) const {
1079 DIScope::printInternal(OS);
1081 unsigned Lang = getLanguage();
1082 if (const char *LangStr = dwarf::LanguageString(Lang))
1085 (OS << "lang 0x").write_hex(Lang);
1089 void DIEnumerator::printInternal(raw_ostream &OS) const {
1090 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1093 void DIType::printInternal(raw_ostream &OS) const {
1094 if (!DbgNode) return;
1096 StringRef Res = getName();
1098 OS << " [" << Res << "]";
1100 // TODO: Print context?
1102 OS << " [line " << getLineNumber()
1103 << ", size " << getSizeInBits()
1104 << ", align " << getAlignInBits()
1105 << ", offset " << getOffsetInBits();
1107 if (const char *Enc =
1108 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1109 OS << ", enc " << Enc;
1114 else if (isProtected())
1115 OS << " [protected]";
1118 OS << " [artificial]";
1120 if (isForwardDecl())
1124 if (isStaticMember())
1128 void DIDerivedType::printInternal(raw_ostream &OS) const {
1129 DIType::printInternal(OS);
1130 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1133 void DICompositeType::printInternal(raw_ostream &OS) const {
1134 DIType::printInternal(OS);
1135 DIArray A = getTypeArray();
1136 OS << " [" << A.getNumElements() << " elements]";
1139 void DINameSpace::printInternal(raw_ostream &OS) const {
1140 StringRef Name = getName();
1142 OS << " [" << Name << ']';
1144 OS << " [line " << getLineNumber() << ']';
1147 void DISubprogram::printInternal(raw_ostream &OS) const {
1148 // TODO : Print context
1149 OS << " [line " << getLineNumber() << ']';
1151 if (isLocalToUnit())
1157 if (getScopeLineNumber() != getLineNumber())
1158 OS << " [scope " << getScopeLineNumber() << "]";
1162 else if (isProtected())
1163 OS << " [protected]";
1165 StringRef Res = getName();
1167 OS << " [" << Res << ']';
1170 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1171 StringRef Res = getName();
1173 OS << " [" << Res << ']';
1175 OS << " [line " << getLineNumber() << ']';
1177 // TODO : Print context
1179 if (isLocalToUnit())
1186 void DIVariable::printInternal(raw_ostream &OS) const {
1187 StringRef Res = getName();
1189 OS << " [" << Res << ']';
1191 OS << " [line " << getLineNumber() << ']';
1194 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1195 StringRef Name = getObjCPropertyName();
1197 OS << " [" << Name << ']';
1199 OS << " [line " << getLineNumber()
1200 << ", properties " << getUnsignedField(6) << ']';
1203 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1204 const LLVMContext &Ctx) {
1205 if (!DL.isUnknown()) { // Print source line info.
1206 DIScope Scope(DL.getScope(Ctx));
1207 // Omit the directory, because it's likely to be long and uninteresting.
1209 CommentOS << Scope.getFilename();
1211 CommentOS << "<unknown>";
1212 CommentOS << ':' << DL.getLine();
1213 if (DL.getCol() != 0)
1214 CommentOS << ':' << DL.getCol();
1215 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1216 if (!InlinedAtDL.isUnknown()) {
1217 CommentOS << " @[ ";
1218 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1224 void DIVariable::printExtendedName(raw_ostream &OS) const {
1225 const LLVMContext &Ctx = DbgNode->getContext();
1226 StringRef Res = getName();
1228 OS << Res << "," << getLineNumber();
1229 if (MDNode *InlinedAt = getInlinedAt()) {
1230 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1231 if (!InlinedAtDL.isUnknown()) {
1233 printDebugLoc(InlinedAtDL, OS, Ctx);