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 ||
296 getTag() == dwarf::DW_TAG_GNU_template_template_param ||
297 getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
300 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
301 bool DIDescriptor::isCompileUnit() const {
302 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
305 /// isFile - Return true if the specified tag is DW_TAG_file_type.
306 bool DIDescriptor::isFile() const {
307 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
310 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
311 bool DIDescriptor::isNameSpace() const {
312 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
315 /// isLexicalBlockFile - Return true if the specified descriptor is a
316 /// lexical block with an extra file.
317 bool DIDescriptor::isLexicalBlockFile() const {
318 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
319 (DbgNode->getNumOperands() == 3);
322 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
323 bool DIDescriptor::isLexicalBlock() const {
324 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
325 (DbgNode->getNumOperands() > 3);
328 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
329 bool DIDescriptor::isSubrange() const {
330 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
333 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
334 bool DIDescriptor::isEnumerator() const {
335 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
338 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
339 bool DIDescriptor::isObjCProperty() const {
340 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
343 /// \brief Return true if the specified tag is DW_TAG_imported_module or
344 /// DW_TAG_imported_declaration.
345 bool DIDescriptor::isImportedEntity() const {
346 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
347 getTag() == dwarf::DW_TAG_imported_declaration);
350 //===----------------------------------------------------------------------===//
351 // Simple Descriptor Constructors and other Methods
352 //===----------------------------------------------------------------------===//
354 DIType::DIType(const MDNode *N) : DIScope(N) {
360 unsigned DIArray::getNumElements() const {
363 return DbgNode->getNumOperands();
366 /// replaceAllUsesWith - Replace all uses of debug info referenced by
368 void DIType::replaceAllUsesWith(DIDescriptor &D) {
372 // Since we use a TrackingVH for the node, its easy for clients to manufacture
373 // legitimate situations where they want to replaceAllUsesWith() on something
374 // which, due to uniquing, has merged with the source. We shield clients from
375 // this detail by allowing a value to be replaced with replaceAllUsesWith()
378 MDNode *Node = const_cast<MDNode*>(DbgNode);
379 const MDNode *DN = D;
380 const Value *V = cast_or_null<Value>(DN);
381 Node->replaceAllUsesWith(const_cast<Value*>(V));
382 MDNode::deleteTemporary(Node);
386 /// replaceAllUsesWith - Replace all uses of debug info referenced by
388 void DIType::replaceAllUsesWith(MDNode *D) {
392 // Since we use a TrackingVH for the node, its easy for clients to manufacture
393 // legitimate situations where they want to replaceAllUsesWith() on something
394 // which, due to uniquing, has merged with the source. We shield clients from
395 // this detail by allowing a value to be replaced with replaceAllUsesWith()
398 MDNode *Node = const_cast<MDNode*>(DbgNode);
399 const MDNode *DN = D;
400 const Value *V = cast_or_null<Value>(DN);
401 Node->replaceAllUsesWith(const_cast<Value*>(V));
402 MDNode::deleteTemporary(Node);
406 /// isUnsignedDIType - Return true if type encoding is unsigned.
407 bool DIType::isUnsignedDIType() {
408 DIDerivedType DTy(DbgNode);
410 return DTy.getTypeDerivedFrom().isUnsignedDIType();
412 DIBasicType BTy(DbgNode);
414 unsigned Encoding = BTy.getEncoding();
415 if (Encoding == dwarf::DW_ATE_unsigned ||
416 Encoding == dwarf::DW_ATE_unsigned_char ||
417 Encoding == dwarf::DW_ATE_boolean)
423 /// Verify - Verify that a compile unit is well formed.
424 bool DICompileUnit::Verify() const {
425 if (!isCompileUnit())
427 StringRef N = getFilename();
430 // It is possible that directory and produce string is empty.
431 return DbgNode->getNumOperands() == 13;
434 /// Verify - Verify that an ObjC property is well formed.
435 bool DIObjCProperty::Verify() const {
436 if (!isObjCProperty())
439 // Don't worry about the rest of the strings for now.
440 return DbgNode->getNumOperands() == 8;
443 /// Verify - Verify that a type descriptor is well formed.
444 bool DIType::Verify() const {
447 unsigned Tag = getTag();
448 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
449 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
450 Tag != dwarf::DW_TAG_ptr_to_member_type &&
451 Tag != dwarf::DW_TAG_reference_type &&
452 Tag != dwarf::DW_TAG_rvalue_reference_type &&
453 Tag != dwarf::DW_TAG_restrict_type &&
454 Tag != dwarf::DW_TAG_array_type &&
455 Tag != dwarf::DW_TAG_enumeration_type &&
456 Tag != dwarf::DW_TAG_subroutine_type &&
457 Tag != dwarf::DW_TAG_inheritance &&
458 Tag != dwarf::DW_TAG_friend &&
459 getFilename().empty())
464 /// Verify - Verify that a basic type descriptor is well formed.
465 bool DIBasicType::Verify() const {
466 return isBasicType() && DbgNode->getNumOperands() == 10;
469 /// Verify - Verify that a derived type descriptor is well formed.
470 bool DIDerivedType::Verify() const {
471 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
472 DbgNode->getNumOperands() <= 14;
475 /// Verify - Verify that a composite type descriptor is well formed.
476 bool DICompositeType::Verify() const {
477 if (!isCompositeType())
480 return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
483 /// Verify - Verify that a subprogram descriptor is well formed.
484 bool DISubprogram::Verify() const {
488 return DbgNode->getNumOperands() == 20;
491 /// Verify - Verify that a global variable descriptor is well formed.
492 bool DIGlobalVariable::Verify() const {
493 if (!isGlobalVariable())
496 if (getDisplayName().empty())
499 return DbgNode->getNumOperands() == 13;
502 /// Verify - Verify that a variable descriptor is well formed.
503 bool DIVariable::Verify() const {
507 return DbgNode->getNumOperands() >= 8;
510 /// Verify - Verify that a location descriptor is well formed.
511 bool DILocation::Verify() const {
515 return DbgNode->getNumOperands() == 4;
518 /// Verify - Verify that a namespace descriptor is well formed.
519 bool DINameSpace::Verify() const {
522 return DbgNode->getNumOperands() == 5;
525 /// \brief Retrieve the MDNode for the directory/file pair.
526 MDNode *DIFile::getFileNode() const {
527 return const_cast<MDNode*>(getNodeField(DbgNode, 1));
530 /// \brief Verify that the file descriptor is well formed.
531 bool DIFile::Verify() const {
532 return isFile() && DbgNode->getNumOperands() == 2;
535 /// \brief Verify that the enumerator descriptor is well formed.
536 bool DIEnumerator::Verify() const {
537 return isEnumerator() && DbgNode->getNumOperands() == 3;
540 /// \brief Verify that the subrange descriptor is well formed.
541 bool DISubrange::Verify() const {
542 return isSubrange() && DbgNode->getNumOperands() == 3;
545 /// \brief Verify that the lexical block descriptor is well formed.
546 bool DILexicalBlock::Verify() const {
547 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
550 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
551 bool DILexicalBlockFile::Verify() const {
552 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
555 /// \brief Verify that the template type parameter descriptor is well formed.
556 bool DITemplateTypeParameter::Verify() const {
557 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
560 /// \brief Verify that the template value parameter descriptor is well formed.
561 bool DITemplateValueParameter::Verify() const {
562 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
565 /// \brief Verify that the imported module descriptor is well formed.
566 bool DIImportedEntity::Verify() const {
567 return isImportedEntity() &&
568 (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
571 /// getOriginalTypeSize - If this type is derived from a base type then
572 /// return base type size.
573 uint64_t DIDerivedType::getOriginalTypeSize() const {
574 unsigned Tag = getTag();
576 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
577 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
578 Tag != dwarf::DW_TAG_restrict_type)
579 return getSizeInBits();
581 DIType BaseType = getTypeDerivedFrom();
583 // If this type is not derived from any type then take conservative approach.
584 if (!BaseType.isValid())
585 return getSizeInBits();
587 // If this is a derived type, go ahead and get the base type, unless it's a
588 // reference then it's just the size of the field. Pointer types have no need
589 // of this since they're a different type of qualification on the type.
590 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
591 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
592 return getSizeInBits();
594 if (BaseType.isDerivedType())
595 return DIDerivedType(BaseType).getOriginalTypeSize();
597 return BaseType.getSizeInBits();
600 /// getObjCProperty - Return property node, if this ivar is associated with one.
601 MDNode *DIDerivedType::getObjCProperty() const {
602 if (DbgNode->getNumOperands() <= 10)
604 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
607 /// \brief Set the array of member DITypes.
608 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
609 assert((!TParams || DbgNode->getNumOperands() == 14) &&
610 "If you're setting the template parameters this should include a slot "
612 TrackingVH<MDNode> N(*this);
613 N->replaceOperandWith(10, Elements);
615 N->replaceOperandWith(13, TParams);
619 /// \brief Set the containing type.
620 void DICompositeType::setContainingType(DICompositeType ContainingType) {
621 TrackingVH<MDNode> N(*this);
622 N->replaceOperandWith(12, ContainingType);
626 /// isInlinedFnArgument - Return true if this variable provides debugging
627 /// information for an inlined function arguments.
628 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
629 assert(CurFn && "Invalid function");
630 if (!getContext().isSubprogram())
632 // This variable is not inlined function argument if its scope
633 // does not describe current function.
634 return !DISubprogram(getContext()).describes(CurFn);
637 /// describes - Return true if this subprogram provides debugging
638 /// information for the function F.
639 bool DISubprogram::describes(const Function *F) {
640 assert(F && "Invalid function");
641 if (F == getFunction())
643 StringRef Name = getLinkageName();
646 if (F->getName() == Name)
651 unsigned DISubprogram::isOptimized() const {
652 assert (DbgNode && "Invalid subprogram descriptor!");
653 if (DbgNode->getNumOperands() == 15)
654 return getUnsignedField(14);
658 MDNode *DISubprogram::getVariablesNodes() const {
659 if (!DbgNode || DbgNode->getNumOperands() <= 18)
661 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(18));
664 DIArray DISubprogram::getVariables() const {
665 if (!DbgNode || DbgNode->getNumOperands() <= 18)
667 if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(18)))
672 Value *DITemplateValueParameter::getValue() const {
673 return getField(DbgNode, 4);
676 void DIScope::setFilename(StringRef Name, LLVMContext &Context) {
679 MDString *MDName(MDString::get(Context, Name));
680 const_cast<MDNode*>(getNodeField(DbgNode, 1))->replaceOperandWith(0, MDName);
683 StringRef DIScope::getFilename() const {
686 return ::getStringField(getNodeField(DbgNode, 1), 0);
689 StringRef DIScope::getDirectory() const {
692 return ::getStringField(getNodeField(DbgNode, 1), 1);
695 DIArray DICompileUnit::getEnumTypes() const {
696 if (!DbgNode || DbgNode->getNumOperands() < 13)
699 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(7)))
704 DIArray DICompileUnit::getRetainedTypes() const {
705 if (!DbgNode || DbgNode->getNumOperands() < 13)
708 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(8)))
713 DIArray DICompileUnit::getSubprograms() const {
714 if (!DbgNode || DbgNode->getNumOperands() < 13)
717 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(9)))
723 DIArray DICompileUnit::getGlobalVariables() const {
724 if (!DbgNode || DbgNode->getNumOperands() < 13)
727 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
732 DIArray DICompileUnit::getImportedEntities() const {
733 if (!DbgNode || DbgNode->getNumOperands() < 13)
736 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
741 /// fixupSubprogramName - Replace contains special characters used
742 /// in a typical Objective-C names with '.' in a given string.
743 static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
745 Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
746 FName = Function::getRealLinkageName(FName);
748 StringRef Prefix("llvm.dbg.lv.");
749 Out.reserve(FName.size() + Prefix.size());
750 Out.append(Prefix.begin(), Prefix.end());
752 bool isObjCLike = false;
753 for (size_t i = 0, e = FName.size(); i < e; ++i) {
758 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
759 C == '+' || C == '(' || C == ')'))
766 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
767 /// suitable to hold function specific information.
768 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
769 SmallString<32> Name;
770 fixupSubprogramName(Fn, Name);
771 return M.getNamedMetadata(Name.str());
774 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
775 /// to hold function specific information.
776 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
777 SmallString<32> Name;
778 fixupSubprogramName(Fn, Name);
779 return M.getOrInsertNamedMetadata(Name.str());
782 /// createInlinedVariable - Create a new inlined variable based on current
784 /// @param DV Current Variable.
785 /// @param InlinedScope Location at current variable is inlined.
786 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
787 LLVMContext &VMContext) {
788 SmallVector<Value *, 16> Elts;
789 // Insert inlined scope as 7th element.
790 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
791 i == 7 ? Elts.push_back(InlinedScope) :
792 Elts.push_back(DV->getOperand(i));
793 return DIVariable(MDNode::get(VMContext, Elts));
796 /// cleanseInlinedVariable - Remove inlined scope from the variable.
797 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
798 SmallVector<Value *, 16> Elts;
799 // Insert inlined scope as 7th element.
800 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
802 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
803 Elts.push_back(DV->getOperand(i));
804 return DIVariable(MDNode::get(VMContext, Elts));
807 /// getDISubprogram - Find subprogram that is enclosing this scope.
808 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
809 DIDescriptor D(Scope);
810 if (D.isSubprogram())
811 return DISubprogram(Scope);
813 if (D.isLexicalBlockFile())
814 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
816 if (D.isLexicalBlock())
817 return getDISubprogram(DILexicalBlock(Scope).getContext());
819 return DISubprogram();
822 /// getDICompositeType - Find underlying composite type.
823 DICompositeType llvm::getDICompositeType(DIType T) {
824 if (T.isCompositeType())
825 return DICompositeType(T);
827 if (T.isDerivedType())
828 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
830 return DICompositeType();
833 /// isSubprogramContext - Return true if Context is either a subprogram
834 /// or another context nested inside a subprogram.
835 bool llvm::isSubprogramContext(const MDNode *Context) {
838 DIDescriptor D(Context);
839 if (D.isSubprogram())
842 return isSubprogramContext(DIType(Context).getContext());
846 //===----------------------------------------------------------------------===//
847 // DebugInfoFinder implementations.
848 //===----------------------------------------------------------------------===//
850 /// processModule - Process entire module and collect debug info.
851 void DebugInfoFinder::processModule(const Module &M) {
852 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
853 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
854 DICompileUnit CU(CU_Nodes->getOperand(i));
856 DIArray GVs = CU.getGlobalVariables();
857 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
858 DIGlobalVariable DIG(GVs.getElement(i));
859 if (addGlobalVariable(DIG)) {
860 addScope(DIG.getContext());
861 processType(DIG.getType());
864 DIArray SPs = CU.getSubprograms();
865 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
866 processSubprogram(DISubprogram(SPs.getElement(i)));
867 DIArray EnumTypes = CU.getEnumTypes();
868 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
869 processType(DIType(EnumTypes.getElement(i)));
870 DIArray RetainedTypes = CU.getRetainedTypes();
871 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
872 processType(DIType(RetainedTypes.getElement(i)));
873 // FIXME: We really shouldn't be bailing out after visiting just one CU
879 /// processLocation - Process DILocation.
880 void DebugInfoFinder::processLocation(DILocation Loc) {
881 if (!Loc.Verify()) return;
882 DIDescriptor S(Loc.getScope());
883 if (S.isCompileUnit())
884 addCompileUnit(DICompileUnit(S));
885 else if (S.isSubprogram())
886 processSubprogram(DISubprogram(S));
887 else if (S.isLexicalBlock())
888 processLexicalBlock(DILexicalBlock(S));
889 else if (S.isLexicalBlockFile()) {
890 DILexicalBlockFile DBF = DILexicalBlockFile(S);
891 processLexicalBlock(DILexicalBlock(DBF.getScope()));
893 processLocation(Loc.getOrigLocation());
896 /// processType - Process DIType.
897 void DebugInfoFinder::processType(DIType DT) {
900 addScope(DT.getContext());
901 if (DT.isCompositeType()) {
902 DICompositeType DCT(DT);
903 processType(DCT.getTypeDerivedFrom());
904 DIArray DA = DCT.getTypeArray();
905 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
906 DIDescriptor D = DA.getElement(i);
908 processType(DIType(D));
909 else if (D.isSubprogram())
910 processSubprogram(DISubprogram(D));
912 } else if (DT.isDerivedType()) {
913 DIDerivedType DDT(DT);
914 processType(DDT.getTypeDerivedFrom());
918 /// processLexicalBlock
919 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
920 DIScope Context = LB.getContext();
921 if (Context.isLexicalBlock())
922 return processLexicalBlock(DILexicalBlock(Context));
923 else if (Context.isLexicalBlockFile()) {
924 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
925 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
928 return processSubprogram(DISubprogram(Context));
931 /// processSubprogram - Process DISubprogram.
932 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
933 if (!addSubprogram(SP))
935 addScope(SP.getContext());
936 processType(SP.getType());
939 /// processDeclare - Process DbgDeclareInst.
940 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
941 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
945 if (!DV.isVariable())
948 if (!NodesSeen.insert(DV))
950 processType(DIVariable(N).getType());
953 /// addType - Add type into Tys.
954 bool DebugInfoFinder::addType(DIType DT) {
958 if (!NodesSeen.insert(DT))
965 /// addCompileUnit - Add compile unit into CUs.
966 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
970 if (!NodesSeen.insert(CU))
977 /// addGlobalVariable - Add global variable into GVs.
978 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
979 if (!DIDescriptor(DIG).isGlobalVariable())
982 if (!NodesSeen.insert(DIG))
989 // addSubprogram - Add subprgoram into SPs.
990 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
991 if (!DIDescriptor(SP).isSubprogram())
994 if (!NodesSeen.insert(SP))
1001 bool DebugInfoFinder::addScope(DIScope Scope) {
1004 if (!NodesSeen.insert(Scope))
1006 Scopes.push_back(Scope);
1010 //===----------------------------------------------------------------------===//
1011 // DIDescriptor: dump routines for all descriptors.
1012 //===----------------------------------------------------------------------===//
1014 /// dump - Print descriptor to dbgs() with a newline.
1015 void DIDescriptor::dump() const {
1016 print(dbgs()); dbgs() << '\n';
1019 /// print - Print descriptor.
1020 void DIDescriptor::print(raw_ostream &OS) const {
1021 if (!DbgNode) return;
1023 if (const char *Tag = dwarf::TagString(getTag()))
1024 OS << "[ " << Tag << " ]";
1026 if (this->isSubrange()) {
1027 DISubrange(DbgNode).printInternal(OS);
1028 } else if (this->isCompileUnit()) {
1029 DICompileUnit(DbgNode).printInternal(OS);
1030 } else if (this->isFile()) {
1031 DIFile(DbgNode).printInternal(OS);
1032 } else if (this->isEnumerator()) {
1033 DIEnumerator(DbgNode).printInternal(OS);
1034 } else if (this->isBasicType()) {
1035 DIType(DbgNode).printInternal(OS);
1036 } else if (this->isDerivedType()) {
1037 DIDerivedType(DbgNode).printInternal(OS);
1038 } else if (this->isCompositeType()) {
1039 DICompositeType(DbgNode).printInternal(OS);
1040 } else if (this->isSubprogram()) {
1041 DISubprogram(DbgNode).printInternal(OS);
1042 } else if (this->isGlobalVariable()) {
1043 DIGlobalVariable(DbgNode).printInternal(OS);
1044 } else if (this->isVariable()) {
1045 DIVariable(DbgNode).printInternal(OS);
1046 } else if (this->isObjCProperty()) {
1047 DIObjCProperty(DbgNode).printInternal(OS);
1048 } else if (this->isNameSpace()) {
1049 DINameSpace(DbgNode).printInternal(OS);
1050 } else if (this->isScope()) {
1051 DIScope(DbgNode).printInternal(OS);
1055 void DISubrange::printInternal(raw_ostream &OS) const {
1056 int64_t Count = getCount();
1058 OS << " [" << getLo() << ", " << Count - 1 << ']';
1060 OS << " [unbounded]";
1063 void DIScope::printInternal(raw_ostream &OS) const {
1064 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1067 void DICompileUnit::printInternal(raw_ostream &OS) const {
1068 DIScope::printInternal(OS);
1070 unsigned Lang = getLanguage();
1071 if (const char *LangStr = dwarf::LanguageString(Lang))
1074 (OS << "lang 0x").write_hex(Lang);
1078 void DIEnumerator::printInternal(raw_ostream &OS) const {
1079 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1082 void DIType::printInternal(raw_ostream &OS) const {
1083 if (!DbgNode) return;
1085 StringRef Res = getName();
1087 OS << " [" << Res << "]";
1089 // TODO: Print context?
1091 OS << " [line " << getLineNumber()
1092 << ", size " << getSizeInBits()
1093 << ", align " << getAlignInBits()
1094 << ", offset " << getOffsetInBits();
1096 if (const char *Enc =
1097 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1098 OS << ", enc " << Enc;
1103 else if (isProtected())
1104 OS << " [protected]";
1107 OS << " [artificial]";
1109 if (isForwardDecl())
1111 else if (getTag() == dwarf::DW_TAG_structure_type ||
1112 getTag() == dwarf::DW_TAG_union_type ||
1113 getTag() == dwarf::DW_TAG_enumeration_type ||
1114 getTag() == dwarf::DW_TAG_class_type)
1118 if (isStaticMember())
1122 void DIDerivedType::printInternal(raw_ostream &OS) const {
1123 DIType::printInternal(OS);
1124 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1127 void DICompositeType::printInternal(raw_ostream &OS) const {
1128 DIType::printInternal(OS);
1129 DIArray A = getTypeArray();
1130 OS << " [" << A.getNumElements() << " elements]";
1133 void DINameSpace::printInternal(raw_ostream &OS) const {
1134 StringRef Name = getName();
1136 OS << " [" << Name << ']';
1138 OS << " [line " << getLineNumber() << ']';
1141 void DISubprogram::printInternal(raw_ostream &OS) const {
1142 // TODO : Print context
1143 OS << " [line " << getLineNumber() << ']';
1145 if (isLocalToUnit())
1151 if (getScopeLineNumber() != getLineNumber())
1152 OS << " [scope " << getScopeLineNumber() << "]";
1156 else if (isProtected())
1157 OS << " [protected]";
1159 StringRef Res = getName();
1161 OS << " [" << Res << ']';
1164 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1165 StringRef Res = getName();
1167 OS << " [" << Res << ']';
1169 OS << " [line " << getLineNumber() << ']';
1171 // TODO : Print context
1173 if (isLocalToUnit())
1180 void DIVariable::printInternal(raw_ostream &OS) const {
1181 StringRef Res = getName();
1183 OS << " [" << Res << ']';
1185 OS << " [line " << getLineNumber() << ']';
1188 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1189 StringRef Name = getObjCPropertyName();
1191 OS << " [" << Name << ']';
1193 OS << " [line " << getLineNumber()
1194 << ", properties " << getUnsignedField(6) << ']';
1197 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1198 const LLVMContext &Ctx) {
1199 if (!DL.isUnknown()) { // Print source line info.
1200 DIScope Scope(DL.getScope(Ctx));
1201 assert(Scope.isScope() &&
1202 "Scope of a DebugLoc should be a DIScope.");
1203 // Omit the directory, because it's likely to be long and uninteresting.
1204 CommentOS << Scope.getFilename();
1205 CommentOS << ':' << DL.getLine();
1206 if (DL.getCol() != 0)
1207 CommentOS << ':' << DL.getCol();
1208 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1209 if (!InlinedAtDL.isUnknown()) {
1210 CommentOS << " @[ ";
1211 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1217 void DIVariable::printExtendedName(raw_ostream &OS) const {
1218 const LLVMContext &Ctx = DbgNode->getContext();
1219 StringRef Res = getName();
1221 OS << Res << "," << getLineNumber();
1222 if (MDNode *InlinedAt = getInlinedAt()) {
1223 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1224 if (!InlinedAtDL.isUnknown()) {
1226 printDebugLoc(InlinedAtDL, OS, Ctx);