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 DIImportedModule(DbgNode).Verify());
71 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
72 if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
74 return DbgNode->getOperand(Elt);
77 static const MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
78 if (const MDNode *R = dyn_cast_or_null<MDNode>(getField(DbgNode, Elt)))
83 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
84 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
85 return MDS->getString();
89 StringRef DIDescriptor::getStringField(unsigned Elt) const {
90 return ::getStringField(DbgNode, Elt);
93 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
97 if (Elt < DbgNode->getNumOperands())
99 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
100 return CI->getZExtValue();
105 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
109 if (Elt < DbgNode->getNumOperands())
111 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
112 return CI->getSExtValue();
117 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
119 return DIDescriptor();
121 if (Elt < DbgNode->getNumOperands())
123 DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
124 return DIDescriptor();
127 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
131 if (Elt < DbgNode->getNumOperands())
132 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
136 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
140 if (Elt < DbgNode->getNumOperands())
141 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
145 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
149 if (Elt < DbgNode->getNumOperands())
150 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
154 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
158 if (Elt < DbgNode->getNumOperands()) {
159 MDNode *Node = const_cast<MDNode*>(DbgNode);
160 Node->replaceOperandWith(Elt, F);
164 unsigned DIVariable::getNumAddrElements() const {
165 return DbgNode->getNumOperands()-8;
168 /// getInlinedAt - If this variable is inlined then return inline location.
169 MDNode *DIVariable::getInlinedAt() const {
170 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(7));
173 //===----------------------------------------------------------------------===//
175 //===----------------------------------------------------------------------===//
177 /// isBasicType - Return true if the specified tag is legal for
179 bool DIDescriptor::isBasicType() const {
180 if (!DbgNode) return false;
182 case dwarf::DW_TAG_base_type:
183 case dwarf::DW_TAG_unspecified_type:
190 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
191 bool DIDescriptor::isDerivedType() const {
192 if (!DbgNode) return false;
194 case dwarf::DW_TAG_typedef:
195 case dwarf::DW_TAG_pointer_type:
196 case dwarf::DW_TAG_ptr_to_member_type:
197 case dwarf::DW_TAG_reference_type:
198 case dwarf::DW_TAG_rvalue_reference_type:
199 case dwarf::DW_TAG_const_type:
200 case dwarf::DW_TAG_volatile_type:
201 case dwarf::DW_TAG_restrict_type:
202 case dwarf::DW_TAG_member:
203 case dwarf::DW_TAG_inheritance:
204 case dwarf::DW_TAG_friend:
207 // CompositeTypes are currently modelled as DerivedTypes.
208 return isCompositeType();
212 /// isCompositeType - Return true if the specified tag is legal for
214 bool DIDescriptor::isCompositeType() const {
215 if (!DbgNode) return false;
217 case dwarf::DW_TAG_array_type:
218 case dwarf::DW_TAG_structure_type:
219 case dwarf::DW_TAG_union_type:
220 case dwarf::DW_TAG_enumeration_type:
221 case dwarf::DW_TAG_subroutine_type:
222 case dwarf::DW_TAG_class_type:
229 /// isVariable - Return true if the specified tag is legal for DIVariable.
230 bool DIDescriptor::isVariable() const {
231 if (!DbgNode) return false;
233 case dwarf::DW_TAG_auto_variable:
234 case dwarf::DW_TAG_arg_variable:
241 /// isType - Return true if the specified tag is legal for DIType.
242 bool DIDescriptor::isType() const {
243 return isBasicType() || isCompositeType() || isDerivedType();
246 /// isSubprogram - Return true if the specified tag is legal for
248 bool DIDescriptor::isSubprogram() const {
249 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
252 /// isGlobalVariable - Return true if the specified tag is legal for
253 /// DIGlobalVariable.
254 bool DIDescriptor::isGlobalVariable() const {
255 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
256 getTag() == dwarf::DW_TAG_constant);
259 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
260 bool DIDescriptor::isGlobal() const {
261 return isGlobalVariable();
264 /// isUnspecifiedParmeter - Return true if the specified tag is
265 /// DW_TAG_unspecified_parameters.
266 bool DIDescriptor::isUnspecifiedParameter() const {
267 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
270 /// isScope - Return true if the specified tag is one of the scope
272 bool DIDescriptor::isScope() const {
273 if (!DbgNode) return false;
275 case dwarf::DW_TAG_compile_unit:
276 case dwarf::DW_TAG_lexical_block:
277 case dwarf::DW_TAG_subprogram:
278 case dwarf::DW_TAG_namespace:
286 /// isTemplateTypeParameter - Return true if the specified tag is
287 /// DW_TAG_template_type_parameter.
288 bool DIDescriptor::isTemplateTypeParameter() const {
289 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
292 /// isTemplateValueParameter - Return true if the specified tag is
293 /// DW_TAG_template_value_parameter.
294 bool DIDescriptor::isTemplateValueParameter() const {
295 return DbgNode && getTag() == dwarf::DW_TAG_template_value_parameter;
298 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
299 bool DIDescriptor::isCompileUnit() const {
300 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
303 /// isFile - Return true if the specified tag is DW_TAG_file_type.
304 bool DIDescriptor::isFile() const {
305 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
308 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
309 bool DIDescriptor::isNameSpace() const {
310 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
313 /// isLexicalBlockFile - Return true if the specified descriptor is a
314 /// lexical block with an extra file.
315 bool DIDescriptor::isLexicalBlockFile() const {
316 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
317 (DbgNode->getNumOperands() == 4);
320 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
321 bool DIDescriptor::isLexicalBlock() const {
322 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
323 (DbgNode->getNumOperands() > 4);
326 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
327 bool DIDescriptor::isSubrange() const {
328 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
331 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
332 bool DIDescriptor::isEnumerator() const {
333 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
336 /// isObjCProperty - Return true if the specified tag is DW_TAG
337 bool DIDescriptor::isObjCProperty() const {
338 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
341 /// \brief Return true if the specified tag is DW_TAG_imported_module.
342 bool DIDescriptor::isImportedModule() const {
343 return DbgNode && getTag() == dwarf::DW_TAG_imported_module;
346 //===----------------------------------------------------------------------===//
347 // Simple Descriptor Constructors and other Methods
348 //===----------------------------------------------------------------------===//
350 DIType::DIType(const MDNode *N) : DIScope(N) {
352 if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
357 unsigned DIArray::getNumElements() const {
360 return DbgNode->getNumOperands();
363 /// replaceAllUsesWith - Replace all uses of debug info referenced by
365 void DIType::replaceAllUsesWith(DIDescriptor &D) {
369 // Since we use a TrackingVH for the node, its easy for clients to manufacture
370 // legitimate situations where they want to replaceAllUsesWith() on something
371 // which, due to uniquing, has merged with the source. We shield clients from
372 // this detail by allowing a value to be replaced with replaceAllUsesWith()
375 MDNode *Node = const_cast<MDNode*>(DbgNode);
376 const MDNode *DN = D;
377 const Value *V = cast_or_null<Value>(DN);
378 Node->replaceAllUsesWith(const_cast<Value*>(V));
379 MDNode::deleteTemporary(Node);
383 /// replaceAllUsesWith - Replace all uses of debug info referenced by
385 void DIType::replaceAllUsesWith(MDNode *D) {
389 // Since we use a TrackingVH for the node, its easy for clients to manufacture
390 // legitimate situations where they want to replaceAllUsesWith() on something
391 // which, due to uniquing, has merged with the source. We shield clients from
392 // this detail by allowing a value to be replaced with replaceAllUsesWith()
395 MDNode *Node = const_cast<MDNode*>(DbgNode);
396 const MDNode *DN = D;
397 const Value *V = cast_or_null<Value>(DN);
398 Node->replaceAllUsesWith(const_cast<Value*>(V));
399 MDNode::deleteTemporary(Node);
403 /// isUnsignedDIType - Return true if type encoding is unsigned.
404 bool DIType::isUnsignedDIType() {
405 DIDerivedType DTy(DbgNode);
407 return DTy.getTypeDerivedFrom().isUnsignedDIType();
409 DIBasicType BTy(DbgNode);
411 unsigned Encoding = BTy.getEncoding();
412 if (Encoding == dwarf::DW_ATE_unsigned ||
413 Encoding == dwarf::DW_ATE_unsigned_char ||
414 Encoding == dwarf::DW_ATE_boolean)
420 /// Verify - Verify that a compile unit is well formed.
421 bool DICompileUnit::Verify() const {
422 if (!isCompileUnit())
424 StringRef N = getFilename();
427 // It is possible that directory and produce string is empty.
428 return DbgNode->getNumOperands() == 13;
431 /// Verify - Verify that an ObjC property is well formed.
432 bool DIObjCProperty::Verify() const {
433 if (!isObjCProperty())
436 DIType Ty = getType();
437 if (!Ty.Verify()) return false;
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 if (getContext() && !getContext().Verify())
449 unsigned Tag = getTag();
450 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
451 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
452 Tag != dwarf::DW_TAG_ptr_to_member_type &&
453 Tag != dwarf::DW_TAG_reference_type &&
454 Tag != dwarf::DW_TAG_rvalue_reference_type &&
455 Tag != dwarf::DW_TAG_restrict_type &&
456 Tag != dwarf::DW_TAG_array_type &&
457 Tag != dwarf::DW_TAG_enumeration_type &&
458 Tag != dwarf::DW_TAG_subroutine_type &&
459 Tag != dwarf::DW_TAG_friend &&
460 getFilename().empty())
465 /// Verify - Verify that a basic type descriptor is well formed.
466 bool DIBasicType::Verify() const {
467 return isBasicType() && DbgNode->getNumOperands() == 11;
470 /// Verify - Verify that a derived type descriptor is well formed.
471 bool DIDerivedType::Verify() const {
472 return isDerivedType() && DbgNode->getNumOperands() >= 11 &&
473 DbgNode->getNumOperands() <= 15;
476 /// Verify - Verify that a composite type descriptor is well formed.
477 bool DICompositeType::Verify() const {
478 if (!isCompositeType())
480 if (getContext() && !getContext().Verify())
483 return DbgNode->getNumOperands() >= 11 && DbgNode->getNumOperands() <= 15;
486 /// Verify - Verify that a subprogram descriptor is well formed.
487 bool DISubprogram::Verify() const {
491 if (getContext() && !getContext().Verify())
494 DICompositeType Ty = getType();
497 return DbgNode->getNumOperands() == 21;
500 /// Verify - Verify that a global variable descriptor is well formed.
501 bool DIGlobalVariable::Verify() const {
502 if (!isGlobalVariable())
505 if (getDisplayName().empty())
508 if (getContext() && !getContext().Verify())
511 DIType Ty = getType();
515 if (!getGlobal() && !getConstant())
518 return DbgNode->getNumOperands() == 13;
521 /// Verify - Verify that a variable descriptor is well formed.
522 bool DIVariable::Verify() const {
526 if (getContext() && !getContext().Verify())
529 DIType Ty = getType();
533 return DbgNode->getNumOperands() >= 8;
536 /// Verify - Verify that a location descriptor is well formed.
537 bool DILocation::Verify() const {
541 return DbgNode->getNumOperands() == 4;
544 /// Verify - Verify that a namespace descriptor is well formed.
545 bool DINameSpace::Verify() const {
548 return DbgNode->getNumOperands() == 6;
551 /// \brief Retrieve the MDNode for the directory/file pair.
552 MDNode *DIFile::getFileNode() const {
553 return const_cast<MDNode*>(getNodeField(DbgNode, 1));
556 /// \brief Verify that the file descriptor is well formed.
557 bool DIFile::Verify() const {
558 return isFile() && DbgNode->getNumOperands() == 3;
561 /// \brief Verify that the enumerator descriptor is well formed.
562 bool DIEnumerator::Verify() const {
563 return isEnumerator() && DbgNode->getNumOperands() == 3;
566 /// \brief Verify that the subrange descriptor is well formed.
567 bool DISubrange::Verify() const {
568 return isSubrange() && DbgNode->getNumOperands() == 3;
571 /// \brief Verify that the lexical block descriptor is well formed.
572 bool DILexicalBlock::Verify() const {
573 return isLexicalBlock() && DbgNode->getNumOperands() == 7;
576 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
577 bool DILexicalBlockFile::Verify() const {
578 return isLexicalBlockFile() && DbgNode->getNumOperands() == 4;
581 /// \brief Verify that the template type parameter descriptor is well formed.
582 bool DITemplateTypeParameter::Verify() const {
583 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
586 /// \brief Verify that the template value parameter descriptor is well formed.
587 bool DITemplateValueParameter::Verify() const {
588 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
591 /// \brief Verify that the imported module descriptor is well formed.
592 bool DIImportedModule::Verify() const {
593 return isImportedModule() && DbgNode->getNumOperands() == 2;
596 /// getOriginalTypeSize - If this type is derived from a base type then
597 /// return base type size.
598 uint64_t DIDerivedType::getOriginalTypeSize() const {
599 unsigned Tag = getTag();
601 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
602 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
603 Tag != dwarf::DW_TAG_restrict_type)
604 return getSizeInBits();
606 DIType BaseType = getTypeDerivedFrom();
608 // If this type is not derived from any type then take conservative approach.
609 if (!BaseType.isValid())
610 return getSizeInBits();
612 // If this is a derived type, go ahead and get the base type, unless it's a
613 // reference then it's just the size of the field. Pointer types have no need
614 // of this since they're a different type of qualification on the type.
615 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
616 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
617 return getSizeInBits();
619 if (BaseType.isDerivedType())
620 return DIDerivedType(BaseType).getOriginalTypeSize();
622 return BaseType.getSizeInBits();
625 /// getObjCProperty - Return property node, if this ivar is associated with one.
626 MDNode *DIDerivedType::getObjCProperty() const {
627 if (DbgNode->getNumOperands() <= 11)
629 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(11));
632 /// \brief Set the array of member DITypes.
633 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
634 assert((!TParams || DbgNode->getNumOperands() == 15) &&
635 "If you're setting the template parameters this should include a slot "
637 TrackingVH<MDNode> N(*this);
638 N->replaceOperandWith(11, Elements);
640 N->replaceOperandWith(14, TParams);
644 /// \brief Set the containing type.
645 void DICompositeType::setContainingType(DICompositeType ContainingType) {
646 TrackingVH<MDNode> N(*this);
647 N->replaceOperandWith(13, ContainingType);
651 /// isInlinedFnArgument - Return true if this variable provides debugging
652 /// information for an inlined function arguments.
653 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
654 assert(CurFn && "Invalid function");
655 if (!getContext().isSubprogram())
657 // This variable is not inlined function argument if its scope
658 // does not describe current function.
659 return !DISubprogram(getContext()).describes(CurFn);
662 /// describes - Return true if this subprogram provides debugging
663 /// information for the function F.
664 bool DISubprogram::describes(const Function *F) {
665 assert(F && "Invalid function");
666 if (F == getFunction())
668 StringRef Name = getLinkageName();
671 if (F->getName() == Name)
676 unsigned DISubprogram::isOptimized() const {
677 assert (DbgNode && "Invalid subprogram descriptor!");
678 if (DbgNode->getNumOperands() == 16)
679 return getUnsignedField(15);
683 MDNode *DISubprogram::getVariablesNodes() const {
684 if (!DbgNode || DbgNode->getNumOperands() <= 19)
686 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(19));
689 DIArray DISubprogram::getVariables() const {
690 if (!DbgNode || DbgNode->getNumOperands() <= 19)
692 if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(19)))
697 StringRef DIScope::getFilename() const {
700 return ::getStringField(getNodeField(DbgNode, 1), 0);
703 StringRef DIScope::getDirectory() const {
706 return ::getStringField(getNodeField(DbgNode, 1), 1);
709 DIArray DICompileUnit::getEnumTypes() const {
710 if (!DbgNode || DbgNode->getNumOperands() < 13)
713 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(8)))
718 DIArray DICompileUnit::getRetainedTypes() const {
719 if (!DbgNode || DbgNode->getNumOperands() < 13)
722 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(9)))
727 DIArray DICompileUnit::getSubprograms() const {
728 if (!DbgNode || DbgNode->getNumOperands() < 13)
731 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
737 DIArray DICompileUnit::getGlobalVariables() const {
738 if (!DbgNode || DbgNode->getNumOperands() < 13)
741 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
746 /// fixupObjcLikeName - Replace contains special characters used
747 /// in a typical Objective-C names with '.' in a given string.
748 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
749 bool isObjCLike = false;
750 for (size_t i = 0, e = Str.size(); i < e; ++i) {
755 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
756 C == '+' || C == '(' || C == ')'))
763 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
764 /// suitable to hold function specific information.
765 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
766 SmallString<32> Name = StringRef("llvm.dbg.lv.");
767 StringRef FName = "fn";
768 if (Fn.getFunction())
769 FName = Fn.getFunction()->getName();
771 FName = Fn.getName();
773 if (FName.startswith(StringRef(&One, 1)))
774 FName = FName.substr(1);
775 fixupObjcLikeName(FName, Name);
776 return M.getNamedMetadata(Name.str());
779 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
780 /// to hold function specific information.
781 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
782 SmallString<32> Name = StringRef("llvm.dbg.lv.");
783 StringRef FName = "fn";
784 if (Fn.getFunction())
785 FName = Fn.getFunction()->getName();
787 FName = Fn.getName();
789 if (FName.startswith(StringRef(&One, 1)))
790 FName = FName.substr(1);
791 fixupObjcLikeName(FName, Name);
793 return M.getOrInsertNamedMetadata(Name.str());
796 /// createInlinedVariable - Create a new inlined variable based on current
798 /// @param DV Current Variable.
799 /// @param InlinedScope Location at current variable is inlined.
800 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
801 LLVMContext &VMContext) {
802 SmallVector<Value *, 16> Elts;
803 // Insert inlined scope as 7th element.
804 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
805 i == 7 ? Elts.push_back(InlinedScope) :
806 Elts.push_back(DV->getOperand(i));
807 return DIVariable(MDNode::get(VMContext, Elts));
810 /// cleanseInlinedVariable - Remove inlined scope from the variable.
811 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
812 SmallVector<Value *, 16> Elts;
813 // Insert inlined scope as 7th element.
814 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
816 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
817 Elts.push_back(DV->getOperand(i));
818 return DIVariable(MDNode::get(VMContext, Elts));
821 /// getDISubprogram - Find subprogram that is enclosing this scope.
822 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
823 DIDescriptor D(Scope);
824 if (D.isSubprogram())
825 return DISubprogram(Scope);
827 if (D.isLexicalBlockFile())
828 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
830 if (D.isLexicalBlock())
831 return getDISubprogram(DILexicalBlock(Scope).getContext());
833 return DISubprogram();
836 /// getDICompositeType - Find underlying composite type.
837 DICompositeType llvm::getDICompositeType(DIType T) {
838 if (T.isCompositeType())
839 return DICompositeType(T);
841 if (T.isDerivedType())
842 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
844 return DICompositeType();
847 /// isSubprogramContext - Return true if Context is either a subprogram
848 /// or another context nested inside a subprogram.
849 bool llvm::isSubprogramContext(const MDNode *Context) {
852 DIDescriptor D(Context);
853 if (D.isSubprogram())
856 return isSubprogramContext(DIType(Context).getContext());
860 //===----------------------------------------------------------------------===//
861 // DebugInfoFinder implementations.
862 //===----------------------------------------------------------------------===//
864 /// processModule - Process entire module and collect debug info.
865 void DebugInfoFinder::processModule(const Module &M) {
866 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
867 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
868 DICompileUnit CU(CU_Nodes->getOperand(i));
870 DIArray GVs = CU.getGlobalVariables();
871 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
872 DIGlobalVariable DIG(GVs.getElement(i));
873 if (addGlobalVariable(DIG))
874 processType(DIG.getType());
876 DIArray SPs = CU.getSubprograms();
877 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
878 processSubprogram(DISubprogram(SPs.getElement(i)));
879 DIArray EnumTypes = CU.getEnumTypes();
880 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
881 processType(DIType(EnumTypes.getElement(i)));
882 DIArray RetainedTypes = CU.getRetainedTypes();
883 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
884 processType(DIType(RetainedTypes.getElement(i)));
885 // FIXME: We really shouldn't be bailing out after visiting just one CU
891 /// processLocation - Process DILocation.
892 void DebugInfoFinder::processLocation(DILocation Loc) {
893 if (!Loc.Verify()) return;
894 DIDescriptor S(Loc.getScope());
895 if (S.isCompileUnit())
896 addCompileUnit(DICompileUnit(S));
897 else if (S.isSubprogram())
898 processSubprogram(DISubprogram(S));
899 else if (S.isLexicalBlock())
900 processLexicalBlock(DILexicalBlock(S));
901 else if (S.isLexicalBlockFile()) {
902 DILexicalBlockFile DBF = DILexicalBlockFile(S);
903 processLexicalBlock(DILexicalBlock(DBF.getScope()));
905 processLocation(Loc.getOrigLocation());
908 /// processType - Process DIType.
909 void DebugInfoFinder::processType(DIType DT) {
912 if (DT.isCompositeType()) {
913 DICompositeType DCT(DT);
914 processType(DCT.getTypeDerivedFrom());
915 DIArray DA = DCT.getTypeArray();
916 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
917 DIDescriptor D = DA.getElement(i);
919 processType(DIType(D));
920 else if (D.isSubprogram())
921 processSubprogram(DISubprogram(D));
923 } else if (DT.isDerivedType()) {
924 DIDerivedType DDT(DT);
925 processType(DDT.getTypeDerivedFrom());
929 /// processLexicalBlock
930 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
931 DIScope Context = LB.getContext();
932 if (Context.isLexicalBlock())
933 return processLexicalBlock(DILexicalBlock(Context));
934 else if (Context.isLexicalBlockFile()) {
935 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
936 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
939 return processSubprogram(DISubprogram(Context));
942 /// processSubprogram - Process DISubprogram.
943 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
944 if (!addSubprogram(SP))
946 processType(SP.getType());
949 /// processDeclare - Process DbgDeclareInst.
950 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
951 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
955 if (!DV.isVariable())
958 if (!NodesSeen.insert(DV))
960 processType(DIVariable(N).getType());
963 /// addType - Add type into Tys.
964 bool DebugInfoFinder::addType(DIType DT) {
968 if (!NodesSeen.insert(DT))
975 /// addCompileUnit - Add compile unit into CUs.
976 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
980 if (!NodesSeen.insert(CU))
987 /// addGlobalVariable - Add global variable into GVs.
988 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
989 if (!DIDescriptor(DIG).isGlobalVariable())
992 if (!NodesSeen.insert(DIG))
999 // addSubprogram - Add subprgoram into SPs.
1000 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1001 if (!DIDescriptor(SP).isSubprogram())
1004 if (!NodesSeen.insert(SP))
1011 //===----------------------------------------------------------------------===//
1012 // DIDescriptor: dump routines for all descriptors.
1013 //===----------------------------------------------------------------------===//
1015 /// dump - Print descriptor to dbgs() with a newline.
1016 void DIDescriptor::dump() const {
1017 print(dbgs()); dbgs() << '\n';
1020 /// print - Print descriptor.
1021 void DIDescriptor::print(raw_ostream &OS) const {
1022 if (!DbgNode) return;
1024 if (const char *Tag = dwarf::TagString(getTag()))
1025 OS << "[ " << Tag << " ]";
1027 if (this->isSubrange()) {
1028 DISubrange(DbgNode).printInternal(OS);
1029 } else if (this->isCompileUnit()) {
1030 DICompileUnit(DbgNode).printInternal(OS);
1031 } else if (this->isFile()) {
1032 DIFile(DbgNode).printInternal(OS);
1033 } else if (this->isEnumerator()) {
1034 DIEnumerator(DbgNode).printInternal(OS);
1035 } else if (this->isBasicType()) {
1036 DIType(DbgNode).printInternal(OS);
1037 } else if (this->isDerivedType()) {
1038 DIDerivedType(DbgNode).printInternal(OS);
1039 } else if (this->isCompositeType()) {
1040 DICompositeType(DbgNode).printInternal(OS);
1041 } else if (this->isSubprogram()) {
1042 DISubprogram(DbgNode).printInternal(OS);
1043 } else if (this->isGlobalVariable()) {
1044 DIGlobalVariable(DbgNode).printInternal(OS);
1045 } else if (this->isVariable()) {
1046 DIVariable(DbgNode).printInternal(OS);
1047 } else if (this->isObjCProperty()) {
1048 DIObjCProperty(DbgNode).printInternal(OS);
1049 } else if (this->isNameSpace()) {
1050 DINameSpace(DbgNode).printInternal(OS);
1051 } else if (this->isScope()) {
1052 DIScope(DbgNode).printInternal(OS);
1053 } else if (this->isImportedModule()) {
1054 DIImportedModule(DbgNode).printInternal(OS);
1058 void DISubrange::printInternal(raw_ostream &OS) const {
1059 int64_t Count = getCount();
1061 OS << " [" << getLo() << ", " << Count - 1 << ']';
1063 OS << " [unbounded]";
1066 void DIScope::printInternal(raw_ostream &OS) const {
1067 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1070 void DICompileUnit::printInternal(raw_ostream &OS) const {
1071 DIScope::printInternal(OS);
1072 if (const char *Lang = dwarf::LanguageString(getLanguage()))
1073 OS << " [" << Lang << ']';
1076 void DIEnumerator::printInternal(raw_ostream &OS) const {
1077 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1080 void DIType::printInternal(raw_ostream &OS) const {
1081 if (!DbgNode) return;
1083 StringRef Res = getName();
1085 OS << " [" << Res << "]";
1087 // TODO: Print context?
1089 OS << " [line " << getLineNumber()
1090 << ", size " << getSizeInBits()
1091 << ", align " << getAlignInBits()
1092 << ", offset " << getOffsetInBits();
1094 if (const char *Enc =
1095 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1096 OS << ", enc " << Enc;
1101 else if (isProtected())
1102 OS << " [protected]";
1105 OS << " [artificial]";
1107 if (isForwardDecl())
1111 if (isStaticMember())
1115 void DIDerivedType::printInternal(raw_ostream &OS) const {
1116 DIType::printInternal(OS);
1117 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1120 void DICompositeType::printInternal(raw_ostream &OS) const {
1121 DIType::printInternal(OS);
1122 DIArray A = getTypeArray();
1123 OS << " [" << A.getNumElements() << " elements]";
1126 void DINameSpace::printInternal(raw_ostream &OS) const {
1127 StringRef Name = getName();
1129 OS << " [" << Name << ']';
1131 OS << " [line " << getLineNumber() << ']';
1134 void DISubprogram::printInternal(raw_ostream &OS) const {
1135 // TODO : Print context
1136 OS << " [line " << getLineNumber() << ']';
1138 if (isLocalToUnit())
1144 if (getScopeLineNumber() != getLineNumber())
1145 OS << " [scope " << getScopeLineNumber() << "]";
1149 else if (isProtected())
1150 OS << " [protected]";
1152 StringRef Res = getName();
1154 OS << " [" << Res << ']';
1157 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1158 StringRef Res = getName();
1160 OS << " [" << Res << ']';
1162 OS << " [line " << getLineNumber() << ']';
1164 // TODO : Print context
1166 if (isLocalToUnit())
1173 void DIVariable::printInternal(raw_ostream &OS) const {
1174 StringRef Res = getName();
1176 OS << " [" << Res << ']';
1178 OS << " [line " << getLineNumber() << ']';
1181 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1182 StringRef Name = getObjCPropertyName();
1184 OS << " [" << Name << ']';
1186 OS << " [line " << getLineNumber()
1187 << ", properties " << getUnsignedField(6) << ']';
1190 void DIImportedModule::printInternal(raw_ostream &OS) const {
1191 StringRef Name = getNameSpace().getName();
1193 OS << " [" << Name << ']';
1196 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1197 const LLVMContext &Ctx) {
1198 if (!DL.isUnknown()) { // Print source line info.
1199 DIScope Scope(DL.getScope(Ctx));
1200 // Omit the directory, because it's likely to be long and uninteresting.
1202 CommentOS << Scope.getFilename();
1204 CommentOS << "<unknown>";
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);