1 //===--- DebugInfo.cpp - Debug Information Helper Classes -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the helper classes used to build and interpret debug
11 // information in LLVM IR form.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/DebugInfo.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallPtrSet.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/Analysis/ValueTracking.h"
20 #include "llvm/IR/Constants.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/Instructions.h"
23 #include "llvm/IR/IntrinsicInst.h"
24 #include "llvm/IR/Intrinsics.h"
25 #include "llvm/IR/Module.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/ValueHandle.h"
29 #include "llvm/Support/raw_ostream.h"
31 using namespace llvm::dwarf;
33 //===----------------------------------------------------------------------===//
35 //===----------------------------------------------------------------------===//
37 DIDescriptor::DIDescriptor(const DIFile F) : DbgNode(F.DbgNode) {
40 DIDescriptor::DIDescriptor(const DISubprogram F) : DbgNode(F.DbgNode) {
43 DIDescriptor::DIDescriptor(const DILexicalBlockFile F) : DbgNode(F.DbgNode) {
46 DIDescriptor::DIDescriptor(const DILexicalBlock F) : DbgNode(F.DbgNode) {
49 DIDescriptor::DIDescriptor(const DIVariable F) : DbgNode(F.DbgNode) {
52 DIDescriptor::DIDescriptor(const DIType F) : DbgNode(F.DbgNode) {
55 bool DIDescriptor::Verify() const {
57 (DIDerivedType(DbgNode).Verify() ||
58 DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
59 DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
60 DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
61 DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
62 DILexicalBlock(DbgNode).Verify() ||
63 DILexicalBlockFile(DbgNode).Verify() ||
64 DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
65 DIObjCProperty(DbgNode).Verify() ||
66 DITemplateTypeParameter(DbgNode).Verify() ||
67 DITemplateValueParameter(DbgNode).Verify() ||
68 DIImportedEntity(DbgNode).Verify());
71 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
72 if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
74 return DbgNode->getOperand(Elt);
77 static const MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
78 if (const MDNode *R = dyn_cast_or_null<MDNode>(getField(DbgNode, Elt)))
83 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
84 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
85 return MDS->getString();
89 StringRef DIDescriptor::getStringField(unsigned Elt) const {
90 return ::getStringField(DbgNode, Elt);
93 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
97 if (Elt < DbgNode->getNumOperands())
99 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
100 return CI->getZExtValue();
105 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
109 if (Elt < DbgNode->getNumOperands())
111 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
112 return CI->getSExtValue();
117 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
119 return DIDescriptor();
121 if (Elt < DbgNode->getNumOperands())
123 DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
124 return DIDescriptor();
127 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
131 if (Elt < DbgNode->getNumOperands())
132 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
136 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
140 if (Elt < DbgNode->getNumOperands())
141 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
145 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
149 if (Elt < DbgNode->getNumOperands())
150 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
154 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
158 if (Elt < DbgNode->getNumOperands()) {
159 MDNode *Node = const_cast<MDNode*>(DbgNode);
160 Node->replaceOperandWith(Elt, F);
164 unsigned DIVariable::getNumAddrElements() const {
165 return DbgNode->getNumOperands()-8;
168 /// getInlinedAt - If this variable is inlined then return inline location.
169 MDNode *DIVariable::getInlinedAt() const {
170 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(7));
173 //===----------------------------------------------------------------------===//
175 //===----------------------------------------------------------------------===//
177 /// isBasicType - Return true if the specified tag is legal for
179 bool DIDescriptor::isBasicType() const {
180 if (!DbgNode) return false;
182 case dwarf::DW_TAG_base_type:
183 case dwarf::DW_TAG_unspecified_type:
190 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
191 bool DIDescriptor::isDerivedType() const {
192 if (!DbgNode) return false;
194 case dwarf::DW_TAG_typedef:
195 case dwarf::DW_TAG_pointer_type:
196 case dwarf::DW_TAG_ptr_to_member_type:
197 case dwarf::DW_TAG_reference_type:
198 case dwarf::DW_TAG_rvalue_reference_type:
199 case dwarf::DW_TAG_const_type:
200 case dwarf::DW_TAG_volatile_type:
201 case dwarf::DW_TAG_restrict_type:
202 case dwarf::DW_TAG_member:
203 case dwarf::DW_TAG_inheritance:
204 case dwarf::DW_TAG_friend:
207 // CompositeTypes are currently modelled as DerivedTypes.
208 return isCompositeType();
212 /// isCompositeType - Return true if the specified tag is legal for
214 bool DIDescriptor::isCompositeType() const {
215 if (!DbgNode) return false;
217 case dwarf::DW_TAG_array_type:
218 case dwarf::DW_TAG_structure_type:
219 case dwarf::DW_TAG_union_type:
220 case dwarf::DW_TAG_enumeration_type:
221 case dwarf::DW_TAG_subroutine_type:
222 case dwarf::DW_TAG_class_type:
229 /// isVariable - Return true if the specified tag is legal for DIVariable.
230 bool DIDescriptor::isVariable() const {
231 if (!DbgNode) return false;
233 case dwarf::DW_TAG_auto_variable:
234 case dwarf::DW_TAG_arg_variable:
241 /// isType - Return true if the specified tag is legal for DIType.
242 bool DIDescriptor::isType() const {
243 return isBasicType() || isCompositeType() || isDerivedType();
246 /// isSubprogram - Return true if the specified tag is legal for
248 bool DIDescriptor::isSubprogram() const {
249 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
252 /// isGlobalVariable - Return true if the specified tag is legal for
253 /// DIGlobalVariable.
254 bool DIDescriptor::isGlobalVariable() const {
255 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
256 getTag() == dwarf::DW_TAG_constant);
259 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
260 bool DIDescriptor::isGlobal() const {
261 return isGlobalVariable();
264 /// isUnspecifiedParmeter - Return true if the specified tag is
265 /// DW_TAG_unspecified_parameters.
266 bool DIDescriptor::isUnspecifiedParameter() const {
267 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
270 /// isScope - Return true if the specified tag is one of the scope
272 bool DIDescriptor::isScope() const {
273 if (!DbgNode) return false;
275 case dwarf::DW_TAG_compile_unit:
276 case dwarf::DW_TAG_lexical_block:
277 case dwarf::DW_TAG_subprogram:
278 case dwarf::DW_TAG_namespace:
286 /// isTemplateTypeParameter - Return true if the specified tag is
287 /// DW_TAG_template_type_parameter.
288 bool DIDescriptor::isTemplateTypeParameter() const {
289 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
292 /// isTemplateValueParameter - Return true if the specified tag is
293 /// DW_TAG_template_value_parameter.
294 bool DIDescriptor::isTemplateValueParameter() const {
295 return DbgNode && (getTag() == dwarf::DW_TAG_template_value_parameter ||
296 getTag() == dwarf::DW_TAG_GNU_template_template_param ||
297 getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
300 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
301 bool DIDescriptor::isCompileUnit() const {
302 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
305 /// isFile - Return true if the specified tag is DW_TAG_file_type.
306 bool DIDescriptor::isFile() const {
307 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
310 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
311 bool DIDescriptor::isNameSpace() const {
312 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
315 /// isLexicalBlockFile - Return true if the specified descriptor is a
316 /// lexical block with an extra file.
317 bool DIDescriptor::isLexicalBlockFile() const {
318 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
319 (DbgNode->getNumOperands() == 3);
322 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
323 bool DIDescriptor::isLexicalBlock() const {
324 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
325 (DbgNode->getNumOperands() > 3);
328 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
329 bool DIDescriptor::isSubrange() const {
330 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
333 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
334 bool DIDescriptor::isEnumerator() const {
335 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
338 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
339 bool DIDescriptor::isObjCProperty() const {
340 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
343 /// \brief Return true if the specified tag is DW_TAG_imported_module or
344 /// DW_TAG_imported_declaration.
345 bool DIDescriptor::isImportedEntity() const {
346 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
347 getTag() == dwarf::DW_TAG_imported_declaration);
350 //===----------------------------------------------------------------------===//
351 // Simple Descriptor Constructors and other Methods
352 //===----------------------------------------------------------------------===//
354 DIType::DIType(const MDNode *N) : DIScope(N) {
360 unsigned DIArray::getNumElements() const {
363 return DbgNode->getNumOperands();
366 /// replaceAllUsesWith - Replace all uses of debug info referenced by
368 void DIType::replaceAllUsesWith(DIDescriptor &D) {
372 // Since we use a TrackingVH for the node, its easy for clients to manufacture
373 // legitimate situations where they want to replaceAllUsesWith() on something
374 // which, due to uniquing, has merged with the source. We shield clients from
375 // this detail by allowing a value to be replaced with replaceAllUsesWith()
378 MDNode *Node = const_cast<MDNode*>(DbgNode);
379 const MDNode *DN = D;
380 const Value *V = cast_or_null<Value>(DN);
381 Node->replaceAllUsesWith(const_cast<Value*>(V));
382 MDNode::deleteTemporary(Node);
386 /// replaceAllUsesWith - Replace all uses of debug info referenced by
388 void DIType::replaceAllUsesWith(MDNode *D) {
392 // Since we use a TrackingVH for the node, its easy for clients to manufacture
393 // legitimate situations where they want to replaceAllUsesWith() on something
394 // which, due to uniquing, has merged with the source. We shield clients from
395 // this detail by allowing a value to be replaced with replaceAllUsesWith()
398 MDNode *Node = const_cast<MDNode*>(DbgNode);
399 const MDNode *DN = D;
400 const Value *V = cast_or_null<Value>(DN);
401 Node->replaceAllUsesWith(const_cast<Value*>(V));
402 MDNode::deleteTemporary(Node);
406 /// isUnsignedDIType - Return true if type encoding is unsigned.
407 bool DIType::isUnsignedDIType() {
408 DIDerivedType DTy(DbgNode);
410 return DTy.getTypeDerivedFrom().isUnsignedDIType();
412 DIBasicType BTy(DbgNode);
414 unsigned Encoding = BTy.getEncoding();
415 if (Encoding == dwarf::DW_ATE_unsigned ||
416 Encoding == dwarf::DW_ATE_unsigned_char ||
417 Encoding == dwarf::DW_ATE_boolean)
423 /// Verify - Verify that a compile unit is well formed.
424 bool DICompileUnit::Verify() const {
425 if (!isCompileUnit())
427 StringRef N = getFilename();
430 // It is possible that directory and produce string is empty.
431 return DbgNode->getNumOperands() == 13;
434 /// Verify - Verify that an ObjC property is well formed.
435 bool DIObjCProperty::Verify() const {
436 if (!isObjCProperty())
439 DIType Ty = getType();
440 if (!Ty.Verify()) return false;
442 // Don't worry about the rest of the strings for now.
443 return DbgNode->getNumOperands() == 8;
446 /// Verify - Verify that a type descriptor is well formed.
447 bool DIType::Verify() const {
450 if (getContext() && !getContext().Verify())
452 unsigned Tag = getTag();
453 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
454 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
455 Tag != dwarf::DW_TAG_ptr_to_member_type &&
456 Tag != dwarf::DW_TAG_reference_type &&
457 Tag != dwarf::DW_TAG_rvalue_reference_type &&
458 Tag != dwarf::DW_TAG_restrict_type &&
459 Tag != dwarf::DW_TAG_array_type &&
460 Tag != dwarf::DW_TAG_enumeration_type &&
461 Tag != dwarf::DW_TAG_subroutine_type &&
462 getFilename().empty())
467 /// Verify - Verify that a basic type descriptor is well formed.
468 bool DIBasicType::Verify() const {
469 return isBasicType() && DbgNode->getNumOperands() == 10;
472 /// Verify - Verify that a derived type descriptor is well formed.
473 bool DIDerivedType::Verify() const {
474 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
475 DbgNode->getNumOperands() <= 14;
478 /// Verify - Verify that a composite type descriptor is well formed.
479 bool DICompositeType::Verify() const {
480 if (!isCompositeType())
482 if (getContext() && !getContext().Verify())
485 return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
488 /// Verify - Verify that a subprogram descriptor is well formed.
489 bool DISubprogram::Verify() const {
493 if (getContext() && !getContext().Verify())
496 DICompositeType Ty = getType();
499 return DbgNode->getNumOperands() == 20;
502 /// Verify - Verify that a global variable descriptor is well formed.
503 bool DIGlobalVariable::Verify() const {
504 if (!isGlobalVariable())
507 if (getDisplayName().empty())
510 if (getContext() && !getContext().Verify())
513 DIType Ty = getType();
517 return DbgNode->getNumOperands() == 13;
520 /// Verify - Verify that a variable descriptor is well formed.
521 bool DIVariable::Verify() const {
525 if (getContext() && !getContext().Verify())
528 DIType Ty = getType();
532 return DbgNode->getNumOperands() >= 8;
535 /// Verify - Verify that a location descriptor is well formed.
536 bool DILocation::Verify() const {
540 return DbgNode->getNumOperands() == 4;
543 /// Verify - Verify that a namespace descriptor is well formed.
544 bool DINameSpace::Verify() const {
547 return DbgNode->getNumOperands() == 5;
550 /// \brief Retrieve the MDNode for the directory/file pair.
551 MDNode *DIFile::getFileNode() const {
552 return const_cast<MDNode*>(getNodeField(DbgNode, 1));
555 /// \brief Verify that the file descriptor is well formed.
556 bool DIFile::Verify() const {
557 return isFile() && DbgNode->getNumOperands() == 2;
560 /// \brief Verify that the enumerator descriptor is well formed.
561 bool DIEnumerator::Verify() const {
562 return isEnumerator() && DbgNode->getNumOperands() == 3;
565 /// \brief Verify that the subrange descriptor is well formed.
566 bool DISubrange::Verify() const {
567 return isSubrange() && DbgNode->getNumOperands() == 3;
570 /// \brief Verify that the lexical block descriptor is well formed.
571 bool DILexicalBlock::Verify() const {
572 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
575 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
576 bool DILexicalBlockFile::Verify() const {
577 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
580 /// \brief Verify that the template type parameter descriptor is well formed.
581 bool DITemplateTypeParameter::Verify() const {
582 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
585 /// \brief Verify that the template value parameter descriptor is well formed.
586 bool DITemplateValueParameter::Verify() const {
587 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
590 /// \brief Verify that the imported module descriptor is well formed.
591 bool DIImportedEntity::Verify() const {
592 return isImportedEntity() &&
593 (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
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() <= 10)
629 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
632 /// \brief Set the array of member DITypes.
633 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
634 assert((!TParams || DbgNode->getNumOperands() == 14) &&
635 "If you're setting the template parameters this should include a slot "
637 TrackingVH<MDNode> N(*this);
638 N->replaceOperandWith(10, Elements);
640 N->replaceOperandWith(13, TParams);
644 /// \brief Set the containing type.
645 void DICompositeType::setContainingType(DICompositeType ContainingType) {
646 TrackingVH<MDNode> N(*this);
647 N->replaceOperandWith(12, 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() == 15)
679 return getUnsignedField(14);
683 MDNode *DISubprogram::getVariablesNodes() const {
684 if (!DbgNode || DbgNode->getNumOperands() <= 18)
686 return dyn_cast_or_null<MDNode>(DbgNode->getOperand(18));
689 DIArray DISubprogram::getVariables() const {
690 if (!DbgNode || DbgNode->getNumOperands() <= 18)
692 if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(18)))
697 Value *DITemplateValueParameter::getValue() const {
698 return getField(DbgNode, 4);
701 void DIScope::setFilename(StringRef Name, LLVMContext &Context) {
704 MDString *MDName(MDString::get(Context, Name));
705 const_cast<MDNode*>(getNodeField(DbgNode, 1))->replaceOperandWith(0, MDName);
708 StringRef DIScope::getFilename() const {
711 return ::getStringField(getNodeField(DbgNode, 1), 0);
714 StringRef DIScope::getDirectory() const {
717 return ::getStringField(getNodeField(DbgNode, 1), 1);
720 DIArray DICompileUnit::getEnumTypes() const {
721 if (!DbgNode || DbgNode->getNumOperands() < 13)
724 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(7)))
729 DIArray DICompileUnit::getRetainedTypes() const {
730 if (!DbgNode || DbgNode->getNumOperands() < 13)
733 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(8)))
738 DIArray DICompileUnit::getSubprograms() const {
739 if (!DbgNode || DbgNode->getNumOperands() < 13)
742 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(9)))
748 DIArray DICompileUnit::getGlobalVariables() const {
749 if (!DbgNode || DbgNode->getNumOperands() < 13)
752 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
757 DIArray DICompileUnit::getImportedEntities() const {
758 if (!DbgNode || DbgNode->getNumOperands() < 13)
761 if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
766 /// fixupSubprogramName - Replace contains special characters used
767 /// in a typical Objective-C names with '.' in a given string.
768 static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
770 Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
771 FName = Function::getRealLinkageName(FName);
773 StringRef Prefix("llvm.dbg.lv.");
774 Out.reserve(FName.size() + Prefix.size());
775 Out.append(Prefix.begin(), Prefix.end());
777 bool isObjCLike = false;
778 for (size_t i = 0, e = FName.size(); i < e; ++i) {
783 if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
784 C == '+' || C == '(' || C == ')'))
791 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
792 /// suitable to hold function specific information.
793 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
794 SmallString<32> Name;
795 fixupSubprogramName(Fn, Name);
796 return M.getNamedMetadata(Name.str());
799 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
800 /// to hold function specific information.
801 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
802 SmallString<32> Name;
803 fixupSubprogramName(Fn, Name);
804 return M.getOrInsertNamedMetadata(Name.str());
807 /// createInlinedVariable - Create a new inlined variable based on current
809 /// @param DV Current Variable.
810 /// @param InlinedScope Location at current variable is inlined.
811 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
812 LLVMContext &VMContext) {
813 SmallVector<Value *, 16> Elts;
814 // Insert inlined scope as 7th element.
815 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
816 i == 7 ? Elts.push_back(InlinedScope) :
817 Elts.push_back(DV->getOperand(i));
818 return DIVariable(MDNode::get(VMContext, Elts));
821 /// cleanseInlinedVariable - Remove inlined scope from the variable.
822 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
823 SmallVector<Value *, 16> Elts;
824 // Insert inlined scope as 7th element.
825 for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
827 Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
828 Elts.push_back(DV->getOperand(i));
829 return DIVariable(MDNode::get(VMContext, Elts));
832 /// getDISubprogram - Find subprogram that is enclosing this scope.
833 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
834 DIDescriptor D(Scope);
835 if (D.isSubprogram())
836 return DISubprogram(Scope);
838 if (D.isLexicalBlockFile())
839 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
841 if (D.isLexicalBlock())
842 return getDISubprogram(DILexicalBlock(Scope).getContext());
844 return DISubprogram();
847 /// getDICompositeType - Find underlying composite type.
848 DICompositeType llvm::getDICompositeType(DIType T) {
849 if (T.isCompositeType())
850 return DICompositeType(T);
852 if (T.isDerivedType())
853 return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
855 return DICompositeType();
858 /// isSubprogramContext - Return true if Context is either a subprogram
859 /// or another context nested inside a subprogram.
860 bool llvm::isSubprogramContext(const MDNode *Context) {
863 DIDescriptor D(Context);
864 if (D.isSubprogram())
867 return isSubprogramContext(DIType(Context).getContext());
871 //===----------------------------------------------------------------------===//
872 // DebugInfoFinder implementations.
873 //===----------------------------------------------------------------------===//
875 /// processModule - Process entire module and collect debug info.
876 void DebugInfoFinder::processModule(const Module &M) {
877 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
878 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
879 DICompileUnit CU(CU_Nodes->getOperand(i));
881 DIArray GVs = CU.getGlobalVariables();
882 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
883 DIGlobalVariable DIG(GVs.getElement(i));
884 if (addGlobalVariable(DIG))
885 processType(DIG.getType());
887 DIArray SPs = CU.getSubprograms();
888 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
889 processSubprogram(DISubprogram(SPs.getElement(i)));
890 DIArray EnumTypes = CU.getEnumTypes();
891 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
892 processType(DIType(EnumTypes.getElement(i)));
893 DIArray RetainedTypes = CU.getRetainedTypes();
894 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
895 processType(DIType(RetainedTypes.getElement(i)));
896 // FIXME: We really shouldn't be bailing out after visiting just one CU
902 /// processLocation - Process DILocation.
903 void DebugInfoFinder::processLocation(DILocation Loc) {
904 if (!Loc.Verify()) return;
905 DIDescriptor S(Loc.getScope());
906 if (S.isCompileUnit())
907 addCompileUnit(DICompileUnit(S));
908 else if (S.isSubprogram())
909 processSubprogram(DISubprogram(S));
910 else if (S.isLexicalBlock())
911 processLexicalBlock(DILexicalBlock(S));
912 else if (S.isLexicalBlockFile()) {
913 DILexicalBlockFile DBF = DILexicalBlockFile(S);
914 processLexicalBlock(DILexicalBlock(DBF.getScope()));
916 processLocation(Loc.getOrigLocation());
919 /// processType - Process DIType.
920 void DebugInfoFinder::processType(DIType DT) {
923 if (DT.isCompositeType()) {
924 DICompositeType DCT(DT);
925 processType(DCT.getTypeDerivedFrom());
926 DIArray DA = DCT.getTypeArray();
927 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
928 DIDescriptor D = DA.getElement(i);
930 processType(DIType(D));
931 else if (D.isSubprogram())
932 processSubprogram(DISubprogram(D));
934 } else if (DT.isDerivedType()) {
935 DIDerivedType DDT(DT);
936 processType(DDT.getTypeDerivedFrom());
940 /// processLexicalBlock
941 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
942 DIScope Context = LB.getContext();
943 if (Context.isLexicalBlock())
944 return processLexicalBlock(DILexicalBlock(Context));
945 else if (Context.isLexicalBlockFile()) {
946 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
947 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
950 return processSubprogram(DISubprogram(Context));
953 /// processSubprogram - Process DISubprogram.
954 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
955 if (!addSubprogram(SP))
957 processType(SP.getType());
960 /// processDeclare - Process DbgDeclareInst.
961 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
962 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
966 if (!DV.isVariable())
969 if (!NodesSeen.insert(DV))
971 processType(DIVariable(N).getType());
974 /// addType - Add type into Tys.
975 bool DebugInfoFinder::addType(DIType DT) {
979 if (!NodesSeen.insert(DT))
986 /// addCompileUnit - Add compile unit into CUs.
987 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
991 if (!NodesSeen.insert(CU))
998 /// addGlobalVariable - Add global variable into GVs.
999 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1000 if (!DIDescriptor(DIG).isGlobalVariable())
1003 if (!NodesSeen.insert(DIG))
1010 // addSubprogram - Add subprgoram into SPs.
1011 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1012 if (!DIDescriptor(SP).isSubprogram())
1015 if (!NodesSeen.insert(SP))
1022 //===----------------------------------------------------------------------===//
1023 // DIDescriptor: dump routines for all descriptors.
1024 //===----------------------------------------------------------------------===//
1026 /// dump - Print descriptor to dbgs() with a newline.
1027 void DIDescriptor::dump() const {
1028 print(dbgs()); dbgs() << '\n';
1031 /// print - Print descriptor.
1032 void DIDescriptor::print(raw_ostream &OS) const {
1033 if (!DbgNode) return;
1035 if (const char *Tag = dwarf::TagString(getTag()))
1036 OS << "[ " << Tag << " ]";
1038 if (this->isSubrange()) {
1039 DISubrange(DbgNode).printInternal(OS);
1040 } else if (this->isCompileUnit()) {
1041 DICompileUnit(DbgNode).printInternal(OS);
1042 } else if (this->isFile()) {
1043 DIFile(DbgNode).printInternal(OS);
1044 } else if (this->isEnumerator()) {
1045 DIEnumerator(DbgNode).printInternal(OS);
1046 } else if (this->isBasicType()) {
1047 DIType(DbgNode).printInternal(OS);
1048 } else if (this->isDerivedType()) {
1049 DIDerivedType(DbgNode).printInternal(OS);
1050 } else if (this->isCompositeType()) {
1051 DICompositeType(DbgNode).printInternal(OS);
1052 } else if (this->isSubprogram()) {
1053 DISubprogram(DbgNode).printInternal(OS);
1054 } else if (this->isGlobalVariable()) {
1055 DIGlobalVariable(DbgNode).printInternal(OS);
1056 } else if (this->isVariable()) {
1057 DIVariable(DbgNode).printInternal(OS);
1058 } else if (this->isObjCProperty()) {
1059 DIObjCProperty(DbgNode).printInternal(OS);
1060 } else if (this->isNameSpace()) {
1061 DINameSpace(DbgNode).printInternal(OS);
1062 } else if (this->isScope()) {
1063 DIScope(DbgNode).printInternal(OS);
1067 void DISubrange::printInternal(raw_ostream &OS) const {
1068 int64_t Count = getCount();
1070 OS << " [" << getLo() << ", " << Count - 1 << ']';
1072 OS << " [unbounded]";
1075 void DIScope::printInternal(raw_ostream &OS) const {
1076 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1079 void DICompileUnit::printInternal(raw_ostream &OS) const {
1080 DIScope::printInternal(OS);
1082 unsigned Lang = getLanguage();
1083 if (const char *LangStr = dwarf::LanguageString(Lang))
1086 (OS << "lang 0x").write_hex(Lang);
1090 void DIEnumerator::printInternal(raw_ostream &OS) const {
1091 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1094 void DIType::printInternal(raw_ostream &OS) const {
1095 if (!DbgNode) return;
1097 StringRef Res = getName();
1099 OS << " [" << Res << "]";
1101 // TODO: Print context?
1103 OS << " [line " << getLineNumber()
1104 << ", size " << getSizeInBits()
1105 << ", align " << getAlignInBits()
1106 << ", offset " << getOffsetInBits();
1108 if (const char *Enc =
1109 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1110 OS << ", enc " << Enc;
1115 else if (isProtected())
1116 OS << " [protected]";
1119 OS << " [artificial]";
1121 if (isForwardDecl())
1123 else if (getTag() == dwarf::DW_TAG_structure_type ||
1124 getTag() == dwarf::DW_TAG_union_type ||
1125 getTag() == dwarf::DW_TAG_enumeration_type ||
1126 getTag() == dwarf::DW_TAG_class_type)
1130 if (isStaticMember())
1134 void DIDerivedType::printInternal(raw_ostream &OS) const {
1135 DIType::printInternal(OS);
1136 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1139 void DICompositeType::printInternal(raw_ostream &OS) const {
1140 DIType::printInternal(OS);
1141 DIArray A = getTypeArray();
1142 OS << " [" << A.getNumElements() << " elements]";
1145 void DINameSpace::printInternal(raw_ostream &OS) const {
1146 StringRef Name = getName();
1148 OS << " [" << Name << ']';
1150 OS << " [line " << getLineNumber() << ']';
1153 void DISubprogram::printInternal(raw_ostream &OS) const {
1154 // TODO : Print context
1155 OS << " [line " << getLineNumber() << ']';
1157 if (isLocalToUnit())
1163 if (getScopeLineNumber() != getLineNumber())
1164 OS << " [scope " << getScopeLineNumber() << "]";
1168 else if (isProtected())
1169 OS << " [protected]";
1171 StringRef Res = getName();
1173 OS << " [" << Res << ']';
1176 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1177 StringRef Res = getName();
1179 OS << " [" << Res << ']';
1181 OS << " [line " << getLineNumber() << ']';
1183 // TODO : Print context
1185 if (isLocalToUnit())
1192 void DIVariable::printInternal(raw_ostream &OS) const {
1193 StringRef Res = getName();
1195 OS << " [" << Res << ']';
1197 OS << " [line " << getLineNumber() << ']';
1200 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1201 StringRef Name = getObjCPropertyName();
1203 OS << " [" << Name << ']';
1205 OS << " [line " << getLineNumber()
1206 << ", properties " << getUnsignedField(6) << ']';
1209 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1210 const LLVMContext &Ctx) {
1211 if (!DL.isUnknown()) { // Print source line info.
1212 DIScope Scope(DL.getScope(Ctx));
1213 assert(Scope.isScope() &&
1214 "Scope of a DebugLoc should be a DIScope.");
1215 // Omit the directory, because it's likely to be long and uninteresting.
1216 CommentOS << Scope.getFilename();
1217 CommentOS << ':' << DL.getLine();
1218 if (DL.getCol() != 0)
1219 CommentOS << ':' << DL.getCol();
1220 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1221 if (!InlinedAtDL.isUnknown()) {
1222 CommentOS << " @[ ";
1223 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1229 void DIVariable::printExtendedName(raw_ostream &OS) const {
1230 const LLVMContext &Ctx = DbgNode->getContext();
1231 StringRef Res = getName();
1233 OS << Res << "," << getLineNumber();
1234 if (MDNode *InlinedAt = getInlinedAt()) {
1235 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1236 if (!InlinedAtDL.isUnknown()) {
1238 printDebugLoc(InlinedAtDL, OS, Ctx);