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/raw_ostream.h"
30 using namespace llvm::dwarf;
32 //===----------------------------------------------------------------------===//
34 //===----------------------------------------------------------------------===//
36 DIDescriptor::DIDescriptor(const DIFile F) : DbgNode(F.DbgNode) {
39 DIDescriptor::DIDescriptor(const DISubprogram F) : DbgNode(F.DbgNode) {
42 DIDescriptor::DIDescriptor(const DILexicalBlockFile F) : DbgNode(F.DbgNode) {
45 DIDescriptor::DIDescriptor(const DILexicalBlock F) : DbgNode(F.DbgNode) {
48 DIDescriptor::DIDescriptor(const DIVariable F) : DbgNode(F.DbgNode) {
51 DIDescriptor::DIDescriptor(const DIType F) : DbgNode(F.DbgNode) {
54 bool DIDescriptor::Verify() const {
56 (DIDerivedType(DbgNode).Verify() ||
57 DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
58 DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
59 DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
60 DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
61 DILexicalBlock(DbgNode).Verify() ||
62 DILexicalBlockFile(DbgNode).Verify() ||
63 DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
64 DIObjCProperty(DbgNode).Verify() ||
65 DITemplateTypeParameter(DbgNode).Verify() ||
66 DITemplateValueParameter(DbgNode).Verify());
69 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
70 if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
72 return DbgNode->getOperand(Elt);
75 static const MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
76 if (const MDNode *R = dyn_cast_or_null<MDNode>(getField(DbgNode, Elt)))
81 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
82 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
83 return MDS->getString();
87 StringRef DIDescriptor::getStringField(unsigned Elt) const {
88 return ::getStringField(DbgNode, Elt);
91 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
95 if (Elt < DbgNode->getNumOperands())
97 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
98 return CI->getZExtValue();
103 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
107 if (Elt < DbgNode->getNumOperands())
109 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
110 return CI->getSExtValue();
115 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
117 return DIDescriptor();
119 if (Elt < DbgNode->getNumOperands())
121 DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
122 return DIDescriptor();
125 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
129 if (Elt < DbgNode->getNumOperands())
130 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
134 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
138 if (Elt < DbgNode->getNumOperands())
139 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
143 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
147 if (Elt < DbgNode->getNumOperands())
148 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
152 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
156 if (Elt < DbgNode->getNumOperands()) {
157 MDNode *Node = const_cast<MDNode*>(DbgNode);
158 Node->replaceOperandWith(Elt, F);
162 unsigned DIVariable::getNumAddrElements() const {
163 return DbgNode->getNumOperands()-8;
166 /// getInlinedAt - If this variable is inlined then return inline location.
167 MDNode *DIVariable::getInlinedAt() const {
168 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(7));
171 //===----------------------------------------------------------------------===//
173 //===----------------------------------------------------------------------===//
175 /// isBasicType - Return true if the specified tag is legal for
177 bool DIDescriptor::isBasicType() const {
178 if (!DbgNode) return false;
180 case dwarf::DW_TAG_base_type:
181 case dwarf::DW_TAG_unspecified_type:
188 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
189 bool DIDescriptor::isDerivedType() const {
190 if (!DbgNode) return false;
192 case dwarf::DW_TAG_typedef:
193 case dwarf::DW_TAG_pointer_type:
194 case dwarf::DW_TAG_ptr_to_member_type:
195 case dwarf::DW_TAG_reference_type:
196 case dwarf::DW_TAG_rvalue_reference_type:
197 case dwarf::DW_TAG_const_type:
198 case dwarf::DW_TAG_volatile_type:
199 case dwarf::DW_TAG_restrict_type:
200 case dwarf::DW_TAG_member:
201 case dwarf::DW_TAG_inheritance:
202 case dwarf::DW_TAG_friend:
205 // CompositeTypes are currently modelled as DerivedTypes.
206 return isCompositeType();
210 /// isCompositeType - Return true if the specified tag is legal for
212 bool DIDescriptor::isCompositeType() const {
213 if (!DbgNode) return false;
215 case dwarf::DW_TAG_array_type:
216 case dwarf::DW_TAG_structure_type:
217 case dwarf::DW_TAG_union_type:
218 case dwarf::DW_TAG_enumeration_type:
219 case dwarf::DW_TAG_subroutine_type:
220 case dwarf::DW_TAG_class_type:
227 /// isVariable - Return true if the specified tag is legal for DIVariable.
228 bool DIDescriptor::isVariable() const {
229 if (!DbgNode) return false;
231 case dwarf::DW_TAG_auto_variable:
232 case dwarf::DW_TAG_arg_variable:
239 /// isType - Return true if the specified tag is legal for DIType.
240 bool DIDescriptor::isType() const {
241 return isBasicType() || isCompositeType() || isDerivedType();
244 /// isSubprogram - Return true if the specified tag is legal for
246 bool DIDescriptor::isSubprogram() const {
247 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
250 /// isGlobalVariable - Return true if the specified tag is legal for
251 /// DIGlobalVariable.
252 bool DIDescriptor::isGlobalVariable() const {
253 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
254 getTag() == dwarf::DW_TAG_constant);
257 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
258 bool DIDescriptor::isGlobal() const {
259 return isGlobalVariable();
262 /// isUnspecifiedParmeter - Return true if the specified tag is
263 /// DW_TAG_unspecified_parameters.
264 bool DIDescriptor::isUnspecifiedParameter() const {
265 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
268 /// isScope - Return true if the specified tag is one of the scope
270 bool DIDescriptor::isScope() const {
271 if (!DbgNode) return false;
273 case dwarf::DW_TAG_compile_unit:
274 case dwarf::DW_TAG_lexical_block:
275 case dwarf::DW_TAG_subprogram:
276 case dwarf::DW_TAG_namespace:
284 /// isTemplateTypeParameter - Return true if the specified tag is
285 /// DW_TAG_template_type_parameter.
286 bool DIDescriptor::isTemplateTypeParameter() const {
287 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
290 /// isTemplateValueParameter - Return true if the specified tag is
291 /// DW_TAG_template_value_parameter.
292 bool DIDescriptor::isTemplateValueParameter() const {
293 return DbgNode && getTag() == dwarf::DW_TAG_template_value_parameter;
296 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
297 bool DIDescriptor::isCompileUnit() const {
298 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
301 /// isFile - Return true if the specified tag is DW_TAG_file_type.
302 bool DIDescriptor::isFile() const {
303 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
306 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
307 bool DIDescriptor::isNameSpace() const {
308 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
311 /// isLexicalBlockFile - Return true if the specified descriptor is a
312 /// lexical block with an extra file.
313 bool DIDescriptor::isLexicalBlockFile() const {
314 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
315 (DbgNode->getNumOperands() == 3);
318 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
319 bool DIDescriptor::isLexicalBlock() const {
320 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
321 (DbgNode->getNumOperands() > 3);
324 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
325 bool DIDescriptor::isSubrange() const {
326 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
329 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
330 bool DIDescriptor::isEnumerator() const {
331 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
334 /// isObjCProperty - Return true if the specified tag is DW_TAG
335 bool DIDescriptor::isObjCProperty() const {
336 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
338 //===----------------------------------------------------------------------===//
339 // Simple Descriptor Constructors and other Methods
340 //===----------------------------------------------------------------------===//
342 DIType::DIType(const MDNode *N) : DIScope(N) {
344 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
349 unsigned DIArray::getNumElements() const {
352 return DbgNode->getNumOperands();
355 /// replaceAllUsesWith - Replace all uses of debug info referenced by
357 void DIType::replaceAllUsesWith(DIDescriptor &D) {
361 // Since we use a TrackingVH for the node, its easy for clients to manufacture
362 // legitimate situations where they want to replaceAllUsesWith() on something
363 // which, due to uniquing, has merged with the source. We shield clients from
364 // this detail by allowing a value to be replaced with replaceAllUsesWith()
367 MDNode *Node = const_cast<MDNode*>(DbgNode);
368 const MDNode *DN = D;
369 const Value *V = cast_or_null<Value>(DN);
370 Node->replaceAllUsesWith(const_cast<Value*>(V));
371 MDNode::deleteTemporary(Node);
375 /// replaceAllUsesWith - Replace all uses of debug info referenced by
377 void DIType::replaceAllUsesWith(MDNode *D) {
381 // Since we use a TrackingVH for the node, its easy for clients to manufacture
382 // legitimate situations where they want to replaceAllUsesWith() on something
383 // which, due to uniquing, has merged with the source. We shield clients from
384 // this detail by allowing a value to be replaced with replaceAllUsesWith()
387 MDNode *Node = const_cast<MDNode*>(DbgNode);
388 const MDNode *DN = D;
389 const Value *V = cast_or_null<Value>(DN);
390 Node->replaceAllUsesWith(const_cast<Value*>(V));
391 MDNode::deleteTemporary(Node);
395 /// isUnsignedDIType - Return true if type encoding is unsigned.
396 bool DIType::isUnsignedDIType() {
397 DIDerivedType DTy(DbgNode);
399 return DTy.getTypeDerivedFrom().isUnsignedDIType();
401 DIBasicType BTy(DbgNode);
403 unsigned Encoding = BTy.getEncoding();
404 if (Encoding == dwarf::DW_ATE_unsigned ||
405 Encoding == dwarf::DW_ATE_unsigned_char ||
406 Encoding == dwarf::DW_ATE_boolean)
412 /// Verify - Verify that a compile unit is well formed.
413 bool DICompileUnit::Verify() const {
414 if (!isCompileUnit())
416 StringRef N = getFilename();
419 // It is possible that directory and produce string is empty.
420 return DbgNode->getNumOperands() == 13;
423 /// Verify - Verify that an ObjC property is well formed.
424 bool DIObjCProperty::Verify() const {
425 if (!isObjCProperty())
428 DIType Ty = getType();
429 if (!Ty.Verify()) return false;
431 // Don't worry about the rest of the strings for now.
432 return DbgNode->getNumOperands() == 8;
435 /// Verify - Verify that a type descriptor is well formed.
436 bool DIType::Verify() const {
439 if (getContext() && !getContext().Verify())
441 unsigned Tag = getTag();
442 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
443 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
444 Tag != dwarf::DW_TAG_ptr_to_member_type &&
445 Tag != dwarf::DW_TAG_reference_type &&
446 Tag != dwarf::DW_TAG_rvalue_reference_type &&
447 Tag != dwarf::DW_TAG_restrict_type &&
448 Tag != dwarf::DW_TAG_array_type &&
449 Tag != dwarf::DW_TAG_enumeration_type &&
450 Tag != dwarf::DW_TAG_subroutine_type &&
451 getFilename().empty())
456 /// Verify - Verify that a basic type descriptor is well formed.
457 bool DIBasicType::Verify() const {
458 return isBasicType() && DbgNode->getNumOperands() == 10;
461 /// Verify - Verify that a derived type descriptor is well formed.
462 bool DIDerivedType::Verify() const {
463 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
464 DbgNode->getNumOperands() <= 14;
467 /// Verify - Verify that a composite type descriptor is well formed.
468 bool DICompositeType::Verify() const {
469 if (!isCompositeType())
471 if (getContext() && !getContext().Verify())
474 return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
477 /// Verify - Verify that a subprogram descriptor is well formed.
478 bool DISubprogram::Verify() const {
482 if (getContext() && !getContext().Verify())
485 DICompositeType Ty = getType();
488 return DbgNode->getNumOperands() == 21;
491 /// Verify - Verify that a global variable descriptor is well formed.
492 bool DIGlobalVariable::Verify() const {
493 if (!isGlobalVariable())
496 if (getDisplayName().empty())
499 if (getContext() && !getContext().Verify())
502 DIType Ty = getType();
506 if (!getGlobal() && !getConstant())
509 return DbgNode->getNumOperands() == 13;
512 /// Verify - Verify that a variable descriptor is well formed.
513 bool DIVariable::Verify() const {
517 if (getContext() && !getContext().Verify())
520 DIType Ty = getType();
524 return DbgNode->getNumOperands() >= 8;
527 /// Verify - Verify that a location descriptor is well formed.
528 bool DILocation::Verify() const {
532 return DbgNode->getNumOperands() == 4;
535 /// Verify - Verify that a namespace descriptor is well formed.
536 bool DINameSpace::Verify() const {
539 return DbgNode->getNumOperands() == 5;
542 /// \brief Retrieve the MDNode for the directory/file pair.
543 MDNode *DIFile::getFileNode() const {
544 return const_cast<MDNode*>(getNodeField(DbgNode, 1));
547 /// \brief Verify that the file descriptor is well formed.
548 bool DIFile::Verify() const {
549 return isFile() && DbgNode->getNumOperands() == 2;
552 /// \brief Verify that the enumerator descriptor is well formed.
553 bool DIEnumerator::Verify() const {
554 return isEnumerator() && DbgNode->getNumOperands() == 3;
557 /// \brief Verify that the subrange descriptor is well formed.
558 bool DISubrange::Verify() const {
559 return isSubrange() && DbgNode->getNumOperands() == 3;
562 /// \brief Verify that the lexical block descriptor is well formed.
563 bool DILexicalBlock::Verify() const {
564 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
567 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
568 bool DILexicalBlockFile::Verify() const {
569 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
572 /// \brief Verify that the template type parameter descriptor is well formed.
573 bool DITemplateTypeParameter::Verify() const {
574 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
577 /// \brief Verify that the template value parameter descriptor is well formed.
578 bool DITemplateValueParameter::Verify() const {
579 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
582 /// getOriginalTypeSize - If this type is derived from a base type then
583 /// return base type size.
584 uint64_t DIDerivedType::getOriginalTypeSize() const {
585 unsigned Tag = getTag();
587 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
588 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
589 Tag != dwarf::DW_TAG_restrict_type)
590 return getSizeInBits();
592 DIType BaseType = getTypeDerivedFrom();
594 // If this type is not derived from any type then take conservative approach.
595 if (!BaseType.isValid())
596 return getSizeInBits();
598 // If this is a derived type, go ahead and get the base type, unless it's a
599 // reference then it's just the size of the field. Pointer types have no need
600 // of this since they're a different type of qualification on the type.
601 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
602 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
603 return getSizeInBits();
605 if (BaseType.isDerivedType())
606 return DIDerivedType(BaseType).getOriginalTypeSize();
608 return BaseType.getSizeInBits();
611 /// getObjCProperty - Return property node, if this ivar is associated with one.
612 MDNode *DIDerivedType::getObjCProperty() const {
613 if (DbgNode->getNumOperands() <= 10)
615 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
618 /// isInlinedFnArgument - Return true if this variable provides debugging
619 /// information for an inlined function arguments.
620 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
621 assert(CurFn && "Invalid function");
622 if (!getContext().isSubprogram())
624 // This variable is not inlined function argument if its scope
625 // does not describe current function.
626 return !DISubprogram(getContext()).describes(CurFn);
629 /// describes - Return true if this subprogram provides debugging
630 /// information for the function F.
631 bool DISubprogram::describes(const Function *F) {
632 assert(F && "Invalid function");
633 if (F == getFunction())
635 StringRef Name = getLinkageName();
638 if (F->getName() == Name)
643 unsigned DISubprogram::isOptimized() const {
644 assert (DbgNode && "Invalid subprogram descriptor!");
645 if (DbgNode->getNumOperands() == 16)
646 return getUnsignedField(15);
650 MDNode *DISubprogram::getVariablesNodes() const {
651 if (!DbgNode || DbgNode->getNumOperands() <= 19)
653 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(19));
656 DIArray DISubprogram::getVariables() const {
657 if (!DbgNode || DbgNode->getNumOperands() <= 19)
659 if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(19)))
664 StringRef DIScope::getFilename() const {
667 if (isLexicalBlockFile())
668 return DILexicalBlockFile(DbgNode).getFilename();
669 if (isLexicalBlock())
670 return DILexicalBlock(DbgNode).getFilename();
672 return DISubprogram(DbgNode).getFilename();
674 return DICompileUnit(DbgNode).getFilename();
675 return ::getStringField(getNodeField(DbgNode, 1), 0);
678 StringRef DIScope::getDirectory() const {
681 if (isLexicalBlockFile())
682 return DILexicalBlockFile(DbgNode).getDirectory();
683 if (isLexicalBlock())
684 return DILexicalBlock(DbgNode).getDirectory();
686 return DISubprogram(DbgNode).getDirectory();
688 return DICompileUnit(DbgNode).getDirectory();
689 return ::getStringField(getNodeField(DbgNode, 1), 1);
692 DIArray DICompileUnit::getEnumTypes() const {
693 if (!DbgNode || DbgNode->getNumOperands() < 13)
696 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(8)))
701 DIArray DICompileUnit::getRetainedTypes() const {
702 if (!DbgNode || DbgNode->getNumOperands() < 13)
705 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(9)))
710 DIArray DICompileUnit::getSubprograms() const {
711 if (!DbgNode || DbgNode->getNumOperands() < 13)
714 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
720 DIArray DICompileUnit::getGlobalVariables() const {
721 if (!DbgNode || DbgNode->getNumOperands() < 13)
724 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
729 /// fixupObjcLikeName - Replace contains special characters used
730 /// in a typical Objective-C names with '.' in a given string.
731 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
732 bool isObjCLike = false;
733 for (size_t i = 0, e = Str.size(); i < e; ++i) {
738 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
739 C == '+' || C == '(' || C == ')'))
746 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
747 /// suitable to hold function specific information.
748 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
749 SmallString<32> Name = StringRef("llvm.dbg.lv.");
750 StringRef FName = "fn";
751 if (Fn.getFunction())
752 FName = Fn.getFunction()->getName();
754 FName = Fn.getName();
756 if (FName.startswith(StringRef(&One, 1)))
757 FName = FName.substr(1);
758 fixupObjcLikeName(FName, Name);
759 return M.getNamedMetadata(Name.str());
762 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
763 /// to hold function specific information.
764 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
765 SmallString<32> Name = StringRef("llvm.dbg.lv.");
766 StringRef FName = "fn";
767 if (Fn.getFunction())
768 FName = Fn.getFunction()->getName();
770 FName = Fn.getName();
772 if (FName.startswith(StringRef(&One, 1)))
773 FName = FName.substr(1);
774 fixupObjcLikeName(FName, Name);
776 return M.getOrInsertNamedMetadata(Name.str());
779 /// createInlinedVariable - Create a new inlined variable based on current
781 /// @param DV Current Variable.
782 /// @param InlinedScope Location at current variable is inlined.
783 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
784 LLVMContext &VMContext) {
785 SmallVector<Value *, 16> Elts;
786 // Insert inlined scope as 7th element.
787 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
788 i == 7 ? Elts.push_back(InlinedScope) :
789 Elts.push_back(DV->getOperand(i));
790 return DIVariable(MDNode::get(VMContext, Elts));
793 /// cleanseInlinedVariable - Remove inlined scope from the variable.
794 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
795 SmallVector<Value *, 16> Elts;
796 // Insert inlined scope as 7th element.
797 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
799 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
800 Elts.push_back(DV->getOperand(i));
801 return DIVariable(MDNode::get(VMContext, Elts));
804 /// getDISubprogram - Find subprogram that is enclosing this scope.
805 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
806 DIDescriptor D(Scope);
807 if (D.isSubprogram())
808 return DISubprogram(Scope);
810 if (D.isLexicalBlockFile())
811 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
813 if (D.isLexicalBlock())
814 return getDISubprogram(DILexicalBlock(Scope).getContext());
816 return DISubprogram();
819 /// getDICompositeType - Find underlying composite type.
820 DICompositeType llvm::getDICompositeType(DIType T) {
821 if (T.isCompositeType())
822 return DICompositeType(T);
824 if (T.isDerivedType())
825 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
827 return DICompositeType();
830 /// isSubprogramContext - Return true if Context is either a subprogram
831 /// or another context nested inside a subprogram.
832 bool llvm::isSubprogramContext(const MDNode *Context) {
835 DIDescriptor D(Context);
836 if (D.isSubprogram())
839 return isSubprogramContext(DIType(Context).getContext());
843 //===----------------------------------------------------------------------===//
844 // DebugInfoFinder implementations.
845 //===----------------------------------------------------------------------===//
847 /// processModule - Process entire module and collect debug info.
848 void DebugInfoFinder::processModule(const Module &M) {
849 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
850 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
851 DICompileUnit CU(CU_Nodes->getOperand(i));
853 DIArray GVs = CU.getGlobalVariables();
854 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
855 DIGlobalVariable DIG(GVs.getElement(i));
856 if (addGlobalVariable(DIG))
857 processType(DIG.getType());
859 DIArray SPs = CU.getSubprograms();
860 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
861 processSubprogram(DISubprogram(SPs.getElement(i)));
862 DIArray EnumTypes = CU.getEnumTypes();
863 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
864 processType(DIType(EnumTypes.getElement(i)));
865 DIArray RetainedTypes = CU.getRetainedTypes();
866 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
867 processType(DIType(RetainedTypes.getElement(i)));
868 // FIXME: We really shouldn't be bailing out after visiting just one CU
874 /// processLocation - Process DILocation.
875 void DebugInfoFinder::processLocation(DILocation Loc) {
876 if (!Loc.Verify()) return;
877 DIDescriptor S(Loc.getScope());
878 if (S.isCompileUnit())
879 addCompileUnit(DICompileUnit(S));
880 else if (S.isSubprogram())
881 processSubprogram(DISubprogram(S));
882 else if (S.isLexicalBlock())
883 processLexicalBlock(DILexicalBlock(S));
884 else if (S.isLexicalBlockFile()) {
885 DILexicalBlockFile DBF = DILexicalBlockFile(S);
886 processLexicalBlock(DILexicalBlock(DBF.getScope()));
888 processLocation(Loc.getOrigLocation());
891 /// processType - Process DIType.
892 void DebugInfoFinder::processType(DIType DT) {
895 if (DT.isCompositeType()) {
896 DICompositeType DCT(DT);
897 processType(DCT.getTypeDerivedFrom());
898 DIArray DA = DCT.getTypeArray();
899 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
900 DIDescriptor D = DA.getElement(i);
902 processType(DIType(D));
903 else if (D.isSubprogram())
904 processSubprogram(DISubprogram(D));
906 } else if (DT.isDerivedType()) {
907 DIDerivedType DDT(DT);
908 processType(DDT.getTypeDerivedFrom());
912 /// processLexicalBlock
913 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
914 DIScope Context = LB.getContext();
915 if (Context.isLexicalBlock())
916 return processLexicalBlock(DILexicalBlock(Context));
917 else if (Context.isLexicalBlockFile()) {
918 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
919 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
922 return processSubprogram(DISubprogram(Context));
925 /// processSubprogram - Process DISubprogram.
926 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
927 if (!addSubprogram(SP))
929 processType(SP.getType());
932 /// processDeclare - Process DbgDeclareInst.
933 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
934 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
938 if (!DV.isVariable())
941 if (!NodesSeen.insert(DV))
943 processType(DIVariable(N).getType());
946 /// addType - Add type into Tys.
947 bool DebugInfoFinder::addType(DIType DT) {
951 if (!NodesSeen.insert(DT))
958 /// addCompileUnit - Add compile unit into CUs.
959 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
963 if (!NodesSeen.insert(CU))
970 /// addGlobalVariable - Add global variable into GVs.
971 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
972 if (!DIDescriptor(DIG).isGlobalVariable())
975 if (!NodesSeen.insert(DIG))
982 // addSubprogram - Add subprgoram into SPs.
983 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
984 if (!DIDescriptor(SP).isSubprogram())
987 if (!NodesSeen.insert(SP))
994 //===----------------------------------------------------------------------===//
995 // DIDescriptor: dump routines for all descriptors.
996 //===----------------------------------------------------------------------===//
998 /// dump - Print descriptor to dbgs() with a newline.
999 void DIDescriptor::dump() const {
1000 print(dbgs()); dbgs() << '\n';
1003 /// print - Print descriptor.
1004 void DIDescriptor::print(raw_ostream &OS) const {
1005 if (!DbgNode) return;
1007 if (const char *Tag = dwarf::TagString(getTag()))
1008 OS << "[ " << Tag << " ]";
1010 if (this->isSubrange()) {
1011 DISubrange(DbgNode).printInternal(OS);
1012 } else if (this->isCompileUnit()) {
1013 DICompileUnit(DbgNode).printInternal(OS);
1014 } else if (this->isFile()) {
1015 DIFile(DbgNode).printInternal(OS);
1016 } else if (this->isEnumerator()) {
1017 DIEnumerator(DbgNode).printInternal(OS);
1018 } else if (this->isBasicType()) {
1019 DIType(DbgNode).printInternal(OS);
1020 } else if (this->isDerivedType()) {
1021 DIDerivedType(DbgNode).printInternal(OS);
1022 } else if (this->isCompositeType()) {
1023 DICompositeType(DbgNode).printInternal(OS);
1024 } else if (this->isSubprogram()) {
1025 DISubprogram(DbgNode).printInternal(OS);
1026 } else if (this->isGlobalVariable()) {
1027 DIGlobalVariable(DbgNode).printInternal(OS);
1028 } else if (this->isVariable()) {
1029 DIVariable(DbgNode).printInternal(OS);
1030 } else if (this->isObjCProperty()) {
1031 DIObjCProperty(DbgNode).printInternal(OS);
1032 } else if (this->isNameSpace()) {
1033 DINameSpace(DbgNode).printInternal(OS);
1034 } else if (this->isScope()) {
1035 DIScope(DbgNode).printInternal(OS);
1039 void DISubrange::printInternal(raw_ostream &OS) const {
1040 int64_t Count = getCount();
1042 OS << " [" << getLo() << ", " << Count - 1 << ']';
1044 OS << " [unbounded]";
1047 void DIScope::printInternal(raw_ostream &OS) const {
1048 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1051 void DICompileUnit::printInternal(raw_ostream &OS) const {
1052 DIScope::printInternal(OS);
1053 if (const char *Lang = dwarf::LanguageString(getLanguage()))
1054 OS << " [" << Lang << ']';
1057 void DIEnumerator::printInternal(raw_ostream &OS) const {
1058 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1061 void DIType::printInternal(raw_ostream &OS) const {
1062 if (!DbgNode) return;
1064 StringRef Res = getName();
1066 OS << " [" << Res << "]";
1068 // TODO: Print context?
1070 OS << " [line " << getLineNumber()
1071 << ", size " << getSizeInBits()
1072 << ", align " << getAlignInBits()
1073 << ", offset " << getOffsetInBits();
1075 if (const char *Enc =
1076 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1077 OS << ", enc " << Enc;
1082 else if (isProtected())
1083 OS << " [protected]";
1086 OS << " [artificial]";
1088 if (isForwardDecl())
1092 if (isStaticMember())
1096 void DIDerivedType::printInternal(raw_ostream &OS) const {
1097 DIType::printInternal(OS);
1098 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1101 void DICompositeType::printInternal(raw_ostream &OS) const {
1102 DIType::printInternal(OS);
1103 DIArray A = getTypeArray();
1104 OS << " [" << A.getNumElements() << " elements]";
1107 void DINameSpace::printInternal(raw_ostream &OS) const {
1108 StringRef Name = getName();
1110 OS << " [" << Name << ']';
1112 OS << " [line " << getLineNumber() << ']';
1115 void DISubprogram::printInternal(raw_ostream &OS) const {
1116 // TODO : Print context
1117 OS << " [line " << getLineNumber() << ']';
1119 if (isLocalToUnit())
1125 if (getScopeLineNumber() != getLineNumber())
1126 OS << " [scope " << getScopeLineNumber() << "]";
1130 else if (isProtected())
1131 OS << " [protected]";
1133 StringRef Res = getName();
1135 OS << " [" << Res << ']';
1138 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1139 StringRef Res = getName();
1141 OS << " [" << Res << ']';
1143 OS << " [line " << getLineNumber() << ']';
1145 // TODO : Print context
1147 if (isLocalToUnit())
1154 void DIVariable::printInternal(raw_ostream &OS) const {
1155 StringRef Res = getName();
1157 OS << " [" << Res << ']';
1159 OS << " [line " << getLineNumber() << ']';
1162 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1163 StringRef Name = getObjCPropertyName();
1165 OS << " [" << Name << ']';
1167 OS << " [line " << getLineNumber()
1168 << ", properties " << getUnsignedField(6) << ']';
1171 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1172 const LLVMContext &Ctx) {
1173 if (!DL.isUnknown()) { // Print source line info.
1174 DIScope Scope(DL.getScope(Ctx));
1175 // Omit the directory, because it's likely to be long and uninteresting.
1177 CommentOS << Scope.getFilename();
1179 CommentOS << "<unknown>";
1180 CommentOS << ':' << DL.getLine();
1181 if (DL.getCol() != 0)
1182 CommentOS << ':' << DL.getCol();
1183 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1184 if (!InlinedAtDL.isUnknown()) {
1185 CommentOS << " @[ ";
1186 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1192 void DIVariable::printExtendedName(raw_ostream &OS) const {
1193 const LLVMContext &Ctx = DbgNode->getContext();
1194 StringRef Res = getName();
1196 OS << Res << "," << getLineNumber();
1197 if (MDNode *InlinedAt = getInlinedAt()) {
1198 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1199 if (!InlinedAtDL.isUnknown()) {
1201 printDebugLoc(InlinedAtDL, OS, Ctx);