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());
70 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
71 if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
73 return DbgNode->getOperand(Elt);
76 static const MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
77 if (const MDNode *R = dyn_cast_or_null<MDNode>(getField(DbgNode, Elt)))
82 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
83 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
84 return MDS->getString();
88 StringRef DIDescriptor::getStringField(unsigned Elt) const {
89 return ::getStringField(DbgNode, Elt);
92 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
96 if (Elt < DbgNode->getNumOperands())
98 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
99 return CI->getZExtValue();
104 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
108 if (Elt < DbgNode->getNumOperands())
110 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
111 return CI->getSExtValue();
116 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
118 return DIDescriptor();
120 if (Elt < DbgNode->getNumOperands())
122 DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
123 return DIDescriptor();
126 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
130 if (Elt < DbgNode->getNumOperands())
131 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
135 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
139 if (Elt < DbgNode->getNumOperands())
140 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
144 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
148 if (Elt < DbgNode->getNumOperands())
149 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
153 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
157 if (Elt < DbgNode->getNumOperands()) {
158 MDNode *Node = const_cast<MDNode*>(DbgNode);
159 Node->replaceOperandWith(Elt, F);
163 unsigned DIVariable::getNumAddrElements() const {
164 return DbgNode->getNumOperands()-8;
167 /// getInlinedAt - If this variable is inlined then return inline location.
168 MDNode *DIVariable::getInlinedAt() const {
169 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(7));
172 //===----------------------------------------------------------------------===//
174 //===----------------------------------------------------------------------===//
176 /// isBasicType - Return true if the specified tag is legal for
178 bool DIDescriptor::isBasicType() const {
179 if (!DbgNode) return false;
181 case dwarf::DW_TAG_base_type:
182 case dwarf::DW_TAG_unspecified_type:
189 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
190 bool DIDescriptor::isDerivedType() const {
191 if (!DbgNode) return false;
193 case dwarf::DW_TAG_typedef:
194 case dwarf::DW_TAG_pointer_type:
195 case dwarf::DW_TAG_ptr_to_member_type:
196 case dwarf::DW_TAG_reference_type:
197 case dwarf::DW_TAG_rvalue_reference_type:
198 case dwarf::DW_TAG_const_type:
199 case dwarf::DW_TAG_volatile_type:
200 case dwarf::DW_TAG_restrict_type:
201 case dwarf::DW_TAG_member:
202 case dwarf::DW_TAG_inheritance:
203 case dwarf::DW_TAG_friend:
206 // CompositeTypes are currently modelled as DerivedTypes.
207 return isCompositeType();
211 /// isCompositeType - Return true if the specified tag is legal for
213 bool DIDescriptor::isCompositeType() const {
214 if (!DbgNode) return false;
216 case dwarf::DW_TAG_array_type:
217 case dwarf::DW_TAG_structure_type:
218 case dwarf::DW_TAG_union_type:
219 case dwarf::DW_TAG_enumeration_type:
220 case dwarf::DW_TAG_subroutine_type:
221 case dwarf::DW_TAG_class_type:
228 /// isVariable - Return true if the specified tag is legal for DIVariable.
229 bool DIDescriptor::isVariable() const {
230 if (!DbgNode) return false;
232 case dwarf::DW_TAG_auto_variable:
233 case dwarf::DW_TAG_arg_variable:
240 /// isType - Return true if the specified tag is legal for DIType.
241 bool DIDescriptor::isType() const {
242 return isBasicType() || isCompositeType() || isDerivedType();
245 /// isSubprogram - Return true if the specified tag is legal for
247 bool DIDescriptor::isSubprogram() const {
248 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
251 /// isGlobalVariable - Return true if the specified tag is legal for
252 /// DIGlobalVariable.
253 bool DIDescriptor::isGlobalVariable() const {
254 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
255 getTag() == dwarf::DW_TAG_constant);
258 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
259 bool DIDescriptor::isGlobal() const {
260 return isGlobalVariable();
263 /// isUnspecifiedParmeter - Return true if the specified tag is
264 /// DW_TAG_unspecified_parameters.
265 bool DIDescriptor::isUnspecifiedParameter() const {
266 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
269 /// isScope - Return true if the specified tag is one of the scope
271 bool DIDescriptor::isScope() const {
272 if (!DbgNode) return false;
274 case dwarf::DW_TAG_compile_unit:
275 case dwarf::DW_TAG_lexical_block:
276 case dwarf::DW_TAG_subprogram:
277 case dwarf::DW_TAG_namespace:
285 /// isTemplateTypeParameter - Return true if the specified tag is
286 /// DW_TAG_template_type_parameter.
287 bool DIDescriptor::isTemplateTypeParameter() const {
288 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
291 /// isTemplateValueParameter - Return true if the specified tag is
292 /// DW_TAG_template_value_parameter.
293 bool DIDescriptor::isTemplateValueParameter() const {
294 return DbgNode && getTag() == dwarf::DW_TAG_template_value_parameter;
297 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
298 bool DIDescriptor::isCompileUnit() const {
299 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
302 /// isFile - Return true if the specified tag is DW_TAG_file_type.
303 bool DIDescriptor::isFile() const {
304 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
307 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
308 bool DIDescriptor::isNameSpace() const {
309 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
312 /// isLexicalBlockFile - Return true if the specified descriptor is a
313 /// lexical block with an extra file.
314 bool DIDescriptor::isLexicalBlockFile() const {
315 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
316 (DbgNode->getNumOperands() == 3);
319 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
320 bool DIDescriptor::isLexicalBlock() const {
321 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
322 (DbgNode->getNumOperands() > 3);
325 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
326 bool DIDescriptor::isSubrange() const {
327 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
330 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
331 bool DIDescriptor::isEnumerator() const {
332 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
335 /// isObjCProperty - Return true if the specified tag is DW_TAG
336 bool DIDescriptor::isObjCProperty() const {
337 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
339 //===----------------------------------------------------------------------===//
340 // Simple Descriptor Constructors and other Methods
341 //===----------------------------------------------------------------------===//
343 DIType::DIType(const MDNode *N) : DIScope(N) {
345 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
350 unsigned DIArray::getNumElements() const {
353 return DbgNode->getNumOperands();
356 /// replaceAllUsesWith - Replace all uses of debug info referenced by
358 void DIType::replaceAllUsesWith(DIDescriptor &D) {
362 // Since we use a TrackingVH for the node, its easy for clients to manufacture
363 // legitimate situations where they want to replaceAllUsesWith() on something
364 // which, due to uniquing, has merged with the source. We shield clients from
365 // this detail by allowing a value to be replaced with replaceAllUsesWith()
368 MDNode *Node = const_cast<MDNode*>(DbgNode);
369 const MDNode *DN = D;
370 const Value *V = cast_or_null<Value>(DN);
371 Node->replaceAllUsesWith(const_cast<Value*>(V));
372 MDNode::deleteTemporary(Node);
376 /// replaceAllUsesWith - Replace all uses of debug info referenced by
378 void DIType::replaceAllUsesWith(MDNode *D) {
382 // Since we use a TrackingVH for the node, its easy for clients to manufacture
383 // legitimate situations where they want to replaceAllUsesWith() on something
384 // which, due to uniquing, has merged with the source. We shield clients from
385 // this detail by allowing a value to be replaced with replaceAllUsesWith()
388 MDNode *Node = const_cast<MDNode*>(DbgNode);
389 const MDNode *DN = D;
390 const Value *V = cast_or_null<Value>(DN);
391 Node->replaceAllUsesWith(const_cast<Value*>(V));
392 MDNode::deleteTemporary(Node);
396 /// isUnsignedDIType - Return true if type encoding is unsigned.
397 bool DIType::isUnsignedDIType() {
398 DIDerivedType DTy(DbgNode);
400 return DTy.getTypeDerivedFrom().isUnsignedDIType();
402 DIBasicType BTy(DbgNode);
404 unsigned Encoding = BTy.getEncoding();
405 if (Encoding == dwarf::DW_ATE_unsigned ||
406 Encoding == dwarf::DW_ATE_unsigned_char ||
407 Encoding == dwarf::DW_ATE_boolean)
413 /// Verify - Verify that a compile unit is well formed.
414 bool DICompileUnit::Verify() const {
415 if (!isCompileUnit())
417 StringRef N = getFilename();
420 // It is possible that directory and produce string is empty.
421 return DbgNode->getNumOperands() == 12;
424 /// Verify - Verify that an ObjC property is well formed.
425 bool DIObjCProperty::Verify() const {
426 if (!isObjCProperty())
429 DIType Ty = getType();
430 if (!Ty.Verify()) return false;
432 // Don't worry about the rest of the strings for now.
433 return DbgNode->getNumOperands() == 8;
436 /// Verify - Verify that a type descriptor is well formed.
437 bool DIType::Verify() const {
440 if (getContext() && !getContext().Verify())
442 unsigned Tag = getTag();
443 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
444 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
445 Tag != dwarf::DW_TAG_ptr_to_member_type &&
446 Tag != dwarf::DW_TAG_reference_type &&
447 Tag != dwarf::DW_TAG_rvalue_reference_type &&
448 Tag != dwarf::DW_TAG_restrict_type &&
449 Tag != dwarf::DW_TAG_array_type &&
450 Tag != dwarf::DW_TAG_enumeration_type &&
451 Tag != dwarf::DW_TAG_subroutine_type &&
452 getFilename().empty())
457 /// Verify - Verify that a basic type descriptor is well formed.
458 bool DIBasicType::Verify() const {
459 return isBasicType() && DbgNode->getNumOperands() == 10;
462 /// Verify - Verify that a derived type descriptor is well formed.
463 bool DIDerivedType::Verify() const {
464 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
465 DbgNode->getNumOperands() <= 14;
468 /// Verify - Verify that a composite type descriptor is well formed.
469 bool DICompositeType::Verify() const {
470 if (!isCompositeType())
472 if (getContext() && !getContext().Verify())
475 return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
478 /// Verify - Verify that a subprogram descriptor is well formed.
479 bool DISubprogram::Verify() const {
483 if (getContext() && !getContext().Verify())
486 DICompositeType Ty = getType();
489 return DbgNode->getNumOperands() == 20;
492 /// Verify - Verify that a global variable descriptor is well formed.
493 bool DIGlobalVariable::Verify() const {
494 if (!isGlobalVariable())
497 if (getDisplayName().empty())
500 if (getContext() && !getContext().Verify())
503 DIType Ty = getType();
507 if (!getGlobal() && !getConstant())
510 return DbgNode->getNumOperands() == 13;
513 /// Verify - Verify that a variable descriptor is well formed.
514 bool DIVariable::Verify() const {
518 if (getContext() && !getContext().Verify())
521 DIType Ty = getType();
525 return DbgNode->getNumOperands() >= 8;
528 /// Verify - Verify that a location descriptor is well formed.
529 bool DILocation::Verify() const {
533 return DbgNode->getNumOperands() == 4;
536 /// Verify - Verify that a namespace descriptor is well formed.
537 bool DINameSpace::Verify() const {
540 return DbgNode->getNumOperands() == 5;
543 /// \brief Retrieve the MDNode for the directory/file pair.
544 MDNode *DIFile::getFileNode() const {
545 return const_cast<MDNode*>(getNodeField(DbgNode, 1));
548 /// \brief Verify that the file descriptor is well formed.
549 bool DIFile::Verify() const {
550 return isFile() && DbgNode->getNumOperands() == 2;
553 /// \brief Verify that the enumerator descriptor is well formed.
554 bool DIEnumerator::Verify() const {
555 return isEnumerator() && DbgNode->getNumOperands() == 3;
558 /// \brief Verify that the subrange descriptor is well formed.
559 bool DISubrange::Verify() const {
560 return isSubrange() && DbgNode->getNumOperands() == 3;
563 /// \brief Verify that the lexical block descriptor is well formed.
564 bool DILexicalBlock::Verify() const {
565 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
568 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
569 bool DILexicalBlockFile::Verify() const {
570 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
573 /// \brief Verify that the template type parameter descriptor is well formed.
574 bool DITemplateTypeParameter::Verify() const {
575 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
578 /// \brief Verify that the template value parameter descriptor is well formed.
579 bool DITemplateValueParameter::Verify() const {
580 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
583 /// getOriginalTypeSize - If this type is derived from a base type then
584 /// return base type size.
585 uint64_t DIDerivedType::getOriginalTypeSize() const {
586 unsigned Tag = getTag();
588 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
589 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
590 Tag != dwarf::DW_TAG_restrict_type)
591 return getSizeInBits();
593 DIType BaseType = getTypeDerivedFrom();
595 // If this type is not derived from any type then take conservative approach.
596 if (!BaseType.isValid())
597 return getSizeInBits();
599 // If this is a derived type, go ahead and get the base type, unless it's a
600 // reference then it's just the size of the field. Pointer types have no need
601 // of this since they're a different type of qualification on the type.
602 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
603 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
604 return getSizeInBits();
606 if (BaseType.isDerivedType())
607 return DIDerivedType(BaseType).getOriginalTypeSize();
609 return BaseType.getSizeInBits();
612 /// getObjCProperty - Return property node, if this ivar is associated with one.
613 MDNode *DIDerivedType::getObjCProperty() const {
614 if (DbgNode->getNumOperands() <= 10)
616 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
619 /// \brief Set the array of member DITypes.
620 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
621 assert(!TParams || DbgNode->getNumOperands() == 14 && "If you're setting the template parameters this should include a slot for that");
622 TrackingVH<MDNode> N(*this);
623 N->replaceOperandWith(10, Elements);
625 N->replaceOperandWith(13, TParams);
629 /// \brief Set the containing type.
630 void DICompositeType::setContainingType(DICompositeType ContainingType) {
631 TrackingVH<MDNode> N(*this);
632 N->replaceOperandWith(12, ContainingType);
636 /// isInlinedFnArgument - Return true if this variable provides debugging
637 /// information for an inlined function arguments.
638 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
639 assert(CurFn && "Invalid function");
640 if (!getContext().isSubprogram())
642 // This variable is not inlined function argument if its scope
643 // does not describe current function.
644 return !DISubprogram(getContext()).describes(CurFn);
647 /// describes - Return true if this subprogram provides debugging
648 /// information for the function F.
649 bool DISubprogram::describes(const Function *F) {
650 assert(F && "Invalid function");
651 if (F == getFunction())
653 StringRef Name = getLinkageName();
656 if (F->getName() == Name)
661 unsigned DISubprogram::isOptimized() const {
662 assert (DbgNode && "Invalid subprogram descriptor!");
663 if (DbgNode->getNumOperands() == 15)
664 return getUnsignedField(14);
668 MDNode *DISubprogram::getVariablesNodes() const {
669 if (!DbgNode || DbgNode->getNumOperands() <= 18)
671 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(18));
674 DIArray DISubprogram::getVariables() const {
675 if (!DbgNode || DbgNode->getNumOperands() <= 18)
677 if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(18)))
682 StringRef DIScope::getFilename() const {
685 return ::getStringField(getNodeField(DbgNode, 1), 0);
688 StringRef DIScope::getDirectory() const {
691 return ::getStringField(getNodeField(DbgNode, 1), 1);
694 DIArray DICompileUnit::getEnumTypes() const {
695 if (!DbgNode || DbgNode->getNumOperands() < 12)
698 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(7)))
703 DIArray DICompileUnit::getRetainedTypes() const {
704 if (!DbgNode || DbgNode->getNumOperands() < 12)
707 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(8)))
712 DIArray DICompileUnit::getSubprograms() const {
713 if (!DbgNode || DbgNode->getNumOperands() < 12)
716 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(9)))
722 DIArray DICompileUnit::getGlobalVariables() const {
723 if (!DbgNode || DbgNode->getNumOperands() < 12)
726 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
731 /// fixupObjcLikeName - Replace contains special characters used
732 /// in a typical Objective-C names with '.' in a given string.
733 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
734 bool isObjCLike = false;
735 for (size_t i = 0, e = Str.size(); i < e; ++i) {
740 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
741 C == '+' || C == '(' || C == ')'))
748 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
749 /// suitable to hold function specific information.
750 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
751 SmallString<32> Name = StringRef("llvm.dbg.lv.");
752 StringRef FName = "fn";
753 if (Fn.getFunction())
754 FName = Fn.getFunction()->getName();
756 FName = Fn.getName();
758 if (FName.startswith(StringRef(&One, 1)))
759 FName = FName.substr(1);
760 fixupObjcLikeName(FName, Name);
761 return M.getNamedMetadata(Name.str());
764 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
765 /// to hold function specific information.
766 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
767 SmallString<32> Name = StringRef("llvm.dbg.lv.");
768 StringRef FName = "fn";
769 if (Fn.getFunction())
770 FName = Fn.getFunction()->getName();
772 FName = Fn.getName();
774 if (FName.startswith(StringRef(&One, 1)))
775 FName = FName.substr(1);
776 fixupObjcLikeName(FName, Name);
778 return M.getOrInsertNamedMetadata(Name.str());
781 /// createInlinedVariable - Create a new inlined variable based on current
783 /// @param DV Current Variable.
784 /// @param InlinedScope Location at current variable is inlined.
785 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
786 LLVMContext &VMContext) {
787 SmallVector<Value *, 16> Elts;
788 // Insert inlined scope as 7th element.
789 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
790 i == 7 ? Elts.push_back(InlinedScope) :
791 Elts.push_back(DV->getOperand(i));
792 return DIVariable(MDNode::get(VMContext, Elts));
795 /// cleanseInlinedVariable - Remove inlined scope from the variable.
796 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
797 SmallVector<Value *, 16> Elts;
798 // Insert inlined scope as 7th element.
799 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
801 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
802 Elts.push_back(DV->getOperand(i));
803 return DIVariable(MDNode::get(VMContext, Elts));
806 /// getDISubprogram - Find subprogram that is enclosing this scope.
807 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
808 DIDescriptor D(Scope);
809 if (D.isSubprogram())
810 return DISubprogram(Scope);
812 if (D.isLexicalBlockFile())
813 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
815 if (D.isLexicalBlock())
816 return getDISubprogram(DILexicalBlock(Scope).getContext());
818 return DISubprogram();
821 /// getDICompositeType - Find underlying composite type.
822 DICompositeType llvm::getDICompositeType(DIType T) {
823 if (T.isCompositeType())
824 return DICompositeType(T);
826 if (T.isDerivedType())
827 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
829 return DICompositeType();
832 /// isSubprogramContext - Return true if Context is either a subprogram
833 /// or another context nested inside a subprogram.
834 bool llvm::isSubprogramContext(const MDNode *Context) {
837 DIDescriptor D(Context);
838 if (D.isSubprogram())
841 return isSubprogramContext(DIType(Context).getContext());
845 //===----------------------------------------------------------------------===//
846 // DebugInfoFinder implementations.
847 //===----------------------------------------------------------------------===//
849 /// processModule - Process entire module and collect debug info.
850 void DebugInfoFinder::processModule(const Module &M) {
851 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
852 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
853 DICompileUnit CU(CU_Nodes->getOperand(i));
855 DIArray GVs = CU.getGlobalVariables();
856 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
857 DIGlobalVariable DIG(GVs.getElement(i));
858 if (addGlobalVariable(DIG))
859 processType(DIG.getType());
861 DIArray SPs = CU.getSubprograms();
862 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
863 processSubprogram(DISubprogram(SPs.getElement(i)));
864 DIArray EnumTypes = CU.getEnumTypes();
865 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
866 processType(DIType(EnumTypes.getElement(i)));
867 DIArray RetainedTypes = CU.getRetainedTypes();
868 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
869 processType(DIType(RetainedTypes.getElement(i)));
870 // FIXME: We really shouldn't be bailing out after visiting just one CU
876 /// processLocation - Process DILocation.
877 void DebugInfoFinder::processLocation(DILocation Loc) {
878 if (!Loc.Verify()) return;
879 DIDescriptor S(Loc.getScope());
880 if (S.isCompileUnit())
881 addCompileUnit(DICompileUnit(S));
882 else if (S.isSubprogram())
883 processSubprogram(DISubprogram(S));
884 else if (S.isLexicalBlock())
885 processLexicalBlock(DILexicalBlock(S));
886 else if (S.isLexicalBlockFile()) {
887 DILexicalBlockFile DBF = DILexicalBlockFile(S);
888 processLexicalBlock(DILexicalBlock(DBF.getScope()));
890 processLocation(Loc.getOrigLocation());
893 /// processType - Process DIType.
894 void DebugInfoFinder::processType(DIType DT) {
897 if (DT.isCompositeType()) {
898 DICompositeType DCT(DT);
899 processType(DCT.getTypeDerivedFrom());
900 DIArray DA = DCT.getTypeArray();
901 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
902 DIDescriptor D = DA.getElement(i);
904 processType(DIType(D));
905 else if (D.isSubprogram())
906 processSubprogram(DISubprogram(D));
908 } else if (DT.isDerivedType()) {
909 DIDerivedType DDT(DT);
910 processType(DDT.getTypeDerivedFrom());
914 /// processLexicalBlock
915 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
916 DIScope Context = LB.getContext();
917 if (Context.isLexicalBlock())
918 return processLexicalBlock(DILexicalBlock(Context));
919 else if (Context.isLexicalBlockFile()) {
920 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
921 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
924 return processSubprogram(DISubprogram(Context));
927 /// processSubprogram - Process DISubprogram.
928 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
929 if (!addSubprogram(SP))
931 processType(SP.getType());
934 /// processDeclare - Process DbgDeclareInst.
935 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
936 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
940 if (!DV.isVariable())
943 if (!NodesSeen.insert(DV))
945 processType(DIVariable(N).getType());
948 /// addType - Add type into Tys.
949 bool DebugInfoFinder::addType(DIType DT) {
953 if (!NodesSeen.insert(DT))
960 /// addCompileUnit - Add compile unit into CUs.
961 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
965 if (!NodesSeen.insert(CU))
972 /// addGlobalVariable - Add global variable into GVs.
973 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
974 if (!DIDescriptor(DIG).isGlobalVariable())
977 if (!NodesSeen.insert(DIG))
984 // addSubprogram - Add subprgoram into SPs.
985 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
986 if (!DIDescriptor(SP).isSubprogram())
989 if (!NodesSeen.insert(SP))
996 //===----------------------------------------------------------------------===//
997 // DIDescriptor: dump routines for all descriptors.
998 //===----------------------------------------------------------------------===//
1000 /// dump - Print descriptor to dbgs() with a newline.
1001 void DIDescriptor::dump() const {
1002 print(dbgs()); dbgs() << '\n';
1005 /// print - Print descriptor.
1006 void DIDescriptor::print(raw_ostream &OS) const {
1007 if (!DbgNode) return;
1009 if (const char *Tag = dwarf::TagString(getTag()))
1010 OS << "[ " << Tag << " ]";
1012 if (this->isSubrange()) {
1013 DISubrange(DbgNode).printInternal(OS);
1014 } else if (this->isCompileUnit()) {
1015 DICompileUnit(DbgNode).printInternal(OS);
1016 } else if (this->isFile()) {
1017 DIFile(DbgNode).printInternal(OS);
1018 } else if (this->isEnumerator()) {
1019 DIEnumerator(DbgNode).printInternal(OS);
1020 } else if (this->isBasicType()) {
1021 DIType(DbgNode).printInternal(OS);
1022 } else if (this->isDerivedType()) {
1023 DIDerivedType(DbgNode).printInternal(OS);
1024 } else if (this->isCompositeType()) {
1025 DICompositeType(DbgNode).printInternal(OS);
1026 } else if (this->isSubprogram()) {
1027 DISubprogram(DbgNode).printInternal(OS);
1028 } else if (this->isGlobalVariable()) {
1029 DIGlobalVariable(DbgNode).printInternal(OS);
1030 } else if (this->isVariable()) {
1031 DIVariable(DbgNode).printInternal(OS);
1032 } else if (this->isObjCProperty()) {
1033 DIObjCProperty(DbgNode).printInternal(OS);
1034 } else if (this->isNameSpace()) {
1035 DINameSpace(DbgNode).printInternal(OS);
1036 } else if (this->isScope()) {
1037 DIScope(DbgNode).printInternal(OS);
1041 void DISubrange::printInternal(raw_ostream &OS) const {
1042 int64_t Count = getCount();
1044 OS << " [" << getLo() << ", " << Count - 1 << ']';
1046 OS << " [unbounded]";
1049 void DIScope::printInternal(raw_ostream &OS) const {
1050 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1053 void DICompileUnit::printInternal(raw_ostream &OS) const {
1054 DIScope::printInternal(OS);
1055 if (const char *Lang = dwarf::LanguageString(getLanguage()))
1056 OS << " [" << Lang << ']';
1059 void DIEnumerator::printInternal(raw_ostream &OS) const {
1060 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1063 void DIType::printInternal(raw_ostream &OS) const {
1064 if (!DbgNode) return;
1066 StringRef Res = getName();
1068 OS << " [" << Res << "]";
1070 // TODO: Print context?
1072 OS << " [line " << getLineNumber()
1073 << ", size " << getSizeInBits()
1074 << ", align " << getAlignInBits()
1075 << ", offset " << getOffsetInBits();
1077 if (const char *Enc =
1078 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1079 OS << ", enc " << Enc;
1084 else if (isProtected())
1085 OS << " [protected]";
1088 OS << " [artificial]";
1090 if (isForwardDecl())
1094 if (isStaticMember())
1098 void DIDerivedType::printInternal(raw_ostream &OS) const {
1099 DIType::printInternal(OS);
1100 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1103 void DICompositeType::printInternal(raw_ostream &OS) const {
1104 DIType::printInternal(OS);
1105 DIArray A = getTypeArray();
1106 OS << " [" << A.getNumElements() << " elements]";
1109 void DINameSpace::printInternal(raw_ostream &OS) const {
1110 StringRef Name = getName();
1112 OS << " [" << Name << ']';
1114 OS << " [line " << getLineNumber() << ']';
1117 void DISubprogram::printInternal(raw_ostream &OS) const {
1118 // TODO : Print context
1119 OS << " [line " << getLineNumber() << ']';
1121 if (isLocalToUnit())
1127 if (getScopeLineNumber() != getLineNumber())
1128 OS << " [scope " << getScopeLineNumber() << "]";
1132 else if (isProtected())
1133 OS << " [protected]";
1135 StringRef Res = getName();
1137 OS << " [" << Res << ']';
1140 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1141 StringRef Res = getName();
1143 OS << " [" << Res << ']';
1145 OS << " [line " << getLineNumber() << ']';
1147 // TODO : Print context
1149 if (isLocalToUnit())
1156 void DIVariable::printInternal(raw_ostream &OS) const {
1157 StringRef Res = getName();
1159 OS << " [" << Res << ']';
1161 OS << " [line " << getLineNumber() << ']';
1164 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1165 StringRef Name = getObjCPropertyName();
1167 OS << " [" << Name << ']';
1169 OS << " [line " << getLineNumber()
1170 << ", properties " << getUnsignedField(6) << ']';
1173 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1174 const LLVMContext &Ctx) {
1175 if (!DL.isUnknown()) { // Print source line info.
1176 DIScope Scope(DL.getScope(Ctx));
1177 // Omit the directory, because it's likely to be long and uninteresting.
1179 CommentOS << Scope.getFilename();
1181 CommentOS << "<unknown>";
1182 CommentOS << ':' << DL.getLine();
1183 if (DL.getCol() != 0)
1184 CommentOS << ':' << DL.getCol();
1185 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1186 if (!InlinedAtDL.isUnknown()) {
1187 CommentOS << " @[ ";
1188 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1194 void DIVariable::printExtendedName(raw_ostream &OS) const {
1195 const LLVMContext &Ctx = DbgNode->getContext();
1196 StringRef Res = getName();
1198 OS << Res << "," << getLineNumber();
1199 if (MDNode *InlinedAt = getInlinedAt()) {
1200 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1201 if (!InlinedAtDL.isUnknown()) {
1203 printDebugLoc(InlinedAtDL, OS, Ctx);