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 bool DIDescriptor::Verify() const {
39 (DIDerivedType(DbgNode).Verify() ||
40 DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
41 DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
42 DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
43 DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
44 DILexicalBlock(DbgNode).Verify() ||
45 DILexicalBlockFile(DbgNode).Verify() ||
46 DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
47 DIObjCProperty(DbgNode).Verify() ||
48 DITemplateTypeParameter(DbgNode).Verify() ||
49 DITemplateValueParameter(DbgNode).Verify() ||
50 DIImportedEntity(DbgNode).Verify());
53 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
54 if (DbgNode == 0 || Elt >= DbgNode->getNumOperands())
56 return DbgNode->getOperand(Elt);
59 static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
60 return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
63 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
64 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
65 return MDS->getString();
69 StringRef DIDescriptor::getStringField(unsigned Elt) const {
70 return ::getStringField(DbgNode, Elt);
73 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
77 if (Elt < DbgNode->getNumOperands())
79 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
80 return CI->getZExtValue();
85 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
89 if (Elt < DbgNode->getNumOperands())
91 = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
92 return CI->getSExtValue();
97 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
98 MDNode *Field = getNodeField(DbgNode, Elt);
99 return DIDescriptor(Field);
102 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
106 if (Elt < DbgNode->getNumOperands())
107 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
111 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
115 if (Elt < DbgNode->getNumOperands())
116 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
120 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
124 if (Elt < DbgNode->getNumOperands())
125 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
129 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
133 if (Elt < DbgNode->getNumOperands()) {
134 MDNode *Node = const_cast<MDNode*>(DbgNode);
135 Node->replaceOperandWith(Elt, F);
139 unsigned DIVariable::getNumAddrElements() const {
140 return DbgNode->getNumOperands()-8;
143 /// getInlinedAt - If this variable is inlined then return inline location.
144 MDNode *DIVariable::getInlinedAt() const {
145 return getNodeField(DbgNode, 7);
148 //===----------------------------------------------------------------------===//
150 //===----------------------------------------------------------------------===//
152 /// isBasicType - Return true if the specified tag is legal for
154 bool DIDescriptor::isBasicType() const {
155 if (!DbgNode) return false;
157 case dwarf::DW_TAG_base_type:
158 case dwarf::DW_TAG_unspecified_type:
165 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
166 bool DIDescriptor::isDerivedType() const {
167 if (!DbgNode) return false;
169 case dwarf::DW_TAG_typedef:
170 case dwarf::DW_TAG_pointer_type:
171 case dwarf::DW_TAG_ptr_to_member_type:
172 case dwarf::DW_TAG_reference_type:
173 case dwarf::DW_TAG_rvalue_reference_type:
174 case dwarf::DW_TAG_const_type:
175 case dwarf::DW_TAG_volatile_type:
176 case dwarf::DW_TAG_restrict_type:
177 case dwarf::DW_TAG_member:
178 case dwarf::DW_TAG_inheritance:
179 case dwarf::DW_TAG_friend:
182 // CompositeTypes are currently modelled as DerivedTypes.
183 return isCompositeType();
187 /// isCompositeType - Return true if the specified tag is legal for
189 bool DIDescriptor::isCompositeType() const {
190 if (!DbgNode) return false;
192 case dwarf::DW_TAG_array_type:
193 case dwarf::DW_TAG_structure_type:
194 case dwarf::DW_TAG_union_type:
195 case dwarf::DW_TAG_enumeration_type:
196 case dwarf::DW_TAG_subroutine_type:
197 case dwarf::DW_TAG_class_type:
204 /// isVariable - Return true if the specified tag is legal for DIVariable.
205 bool DIDescriptor::isVariable() const {
206 if (!DbgNode) return false;
208 case dwarf::DW_TAG_auto_variable:
209 case dwarf::DW_TAG_arg_variable:
216 /// isType - Return true if the specified tag is legal for DIType.
217 bool DIDescriptor::isType() const {
218 return isBasicType() || isCompositeType() || isDerivedType();
221 /// isSubprogram - Return true if the specified tag is legal for
223 bool DIDescriptor::isSubprogram() const {
224 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
227 /// isGlobalVariable - Return true if the specified tag is legal for
228 /// DIGlobalVariable.
229 bool DIDescriptor::isGlobalVariable() const {
230 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
231 getTag() == dwarf::DW_TAG_constant);
234 /// isUnspecifiedParmeter - Return true if the specified tag is
235 /// DW_TAG_unspecified_parameters.
236 bool DIDescriptor::isUnspecifiedParameter() const {
237 return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
240 /// isScope - Return true if the specified tag is one of the scope
242 bool DIDescriptor::isScope() const {
243 if (!DbgNode) return false;
245 case dwarf::DW_TAG_compile_unit:
246 case dwarf::DW_TAG_lexical_block:
247 case dwarf::DW_TAG_subprogram:
248 case dwarf::DW_TAG_namespace:
256 /// isTemplateTypeParameter - Return true if the specified tag is
257 /// DW_TAG_template_type_parameter.
258 bool DIDescriptor::isTemplateTypeParameter() const {
259 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
262 /// isTemplateValueParameter - Return true if the specified tag is
263 /// DW_TAG_template_value_parameter.
264 bool DIDescriptor::isTemplateValueParameter() const {
265 return DbgNode && (getTag() == dwarf::DW_TAG_template_value_parameter ||
266 getTag() == dwarf::DW_TAG_GNU_template_template_param ||
267 getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
270 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
271 bool DIDescriptor::isCompileUnit() const {
272 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
275 /// isFile - Return true if the specified tag is DW_TAG_file_type.
276 bool DIDescriptor::isFile() const {
277 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
280 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
281 bool DIDescriptor::isNameSpace() const {
282 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
285 /// isLexicalBlockFile - Return true if the specified descriptor is a
286 /// lexical block with an extra file.
287 bool DIDescriptor::isLexicalBlockFile() const {
288 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
289 (DbgNode->getNumOperands() == 3);
292 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
293 bool DIDescriptor::isLexicalBlock() const {
294 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
295 (DbgNode->getNumOperands() > 3);
298 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
299 bool DIDescriptor::isSubrange() const {
300 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
303 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
304 bool DIDescriptor::isEnumerator() const {
305 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
308 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
309 bool DIDescriptor::isObjCProperty() const {
310 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
313 /// \brief Return true if the specified tag is DW_TAG_imported_module or
314 /// DW_TAG_imported_declaration.
315 bool DIDescriptor::isImportedEntity() const {
316 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
317 getTag() == dwarf::DW_TAG_imported_declaration);
320 //===----------------------------------------------------------------------===//
321 // Simple Descriptor Constructors and other Methods
322 //===----------------------------------------------------------------------===//
324 unsigned DIArray::getNumElements() const {
327 return DbgNode->getNumOperands();
330 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
331 /// type with the one in the passed descriptor.
332 void DIType::replaceAllUsesWith(DIDescriptor &D) {
334 assert(DbgNode && "Trying to replace an unverified type!");
336 // Since we use a TrackingVH for the node, its easy for clients to manufacture
337 // legitimate situations where they want to replaceAllUsesWith() on something
338 // which, due to uniquing, has merged with the source. We shield clients from
339 // this detail by allowing a value to be replaced with replaceAllUsesWith()
342 MDNode *Node = const_cast<MDNode*>(DbgNode);
343 const MDNode *DN = D;
344 const Value *V = cast_or_null<Value>(DN);
345 Node->replaceAllUsesWith(const_cast<Value*>(V));
346 MDNode::deleteTemporary(Node);
350 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
351 /// type with the one in D.
352 void DIType::replaceAllUsesWith(MDNode *D) {
354 assert(DbgNode && "Trying to replace an unverified type!");
356 // Since we use a TrackingVH for the node, its easy for clients to manufacture
357 // legitimate situations where they want to replaceAllUsesWith() on something
358 // which, due to uniquing, has merged with the source. We shield clients from
359 // this detail by allowing a value to be replaced with replaceAllUsesWith()
362 MDNode *Node = const_cast<MDNode*>(DbgNode);
363 const MDNode *DN = D;
364 const Value *V = cast_or_null<Value>(DN);
365 Node->replaceAllUsesWith(const_cast<Value*>(V));
366 MDNode::deleteTemporary(Node);
370 /// isUnsignedDIType - Return true if type encoding is unsigned.
371 bool DIType::isUnsignedDIType() {
372 DIDerivedType DTy(DbgNode);
374 return DTy.getTypeDerivedFrom().isUnsignedDIType();
376 DIBasicType BTy(DbgNode);
378 unsigned Encoding = BTy.getEncoding();
379 if (Encoding == dwarf::DW_ATE_unsigned ||
380 Encoding == dwarf::DW_ATE_unsigned_char ||
381 Encoding == dwarf::DW_ATE_boolean)
387 /// Verify - Verify that a compile unit is well formed.
388 bool DICompileUnit::Verify() const {
389 if (!isCompileUnit())
392 // Don't bother verifying the compilation directory or producer string
393 // as those could be empty.
394 if (getFilename().empty())
397 return DbgNode->getNumOperands() == 13;
400 /// Verify - Verify that an ObjC property is well formed.
401 bool DIObjCProperty::Verify() const {
402 if (!isObjCProperty())
405 // Don't worry about the rest of the strings for now.
406 return DbgNode->getNumOperands() == 8;
409 /// Check if a field at position Elt of a MDNode is a MDNode.
410 /// We currently allow an empty string and an integer.
411 /// But we don't allow a non-empty string in a MDNode field.
412 static bool fieldIsMDNode(const MDNode *DbgNode, unsigned Elt) {
413 // FIXME: This function should return true, if the field is null or the field
414 // is indeed a MDNode: return !Fld || isa<MDNode>(Fld).
415 Value *Fld = getField(DbgNode, Elt);
416 if (Fld && isa<MDString>(Fld) &&
417 !cast<MDString>(Fld)->getString().empty())
422 /// Verify - Verify that a type descriptor is well formed.
423 bool DIType::Verify() const {
426 // Make sure Context @ field 2 is MDNode.
427 if (!fieldIsMDNode(DbgNode, 2))
430 // FIXME: Sink this into the various subclass verifies.
431 unsigned Tag = getTag();
432 if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
433 Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
434 Tag != dwarf::DW_TAG_ptr_to_member_type &&
435 Tag != dwarf::DW_TAG_reference_type &&
436 Tag != dwarf::DW_TAG_rvalue_reference_type &&
437 Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
438 Tag != dwarf::DW_TAG_enumeration_type &&
439 Tag != dwarf::DW_TAG_subroutine_type &&
440 Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
441 getFilename().empty())
443 // DIType is abstract, it should be a BasicType, a DerivedType or
446 DIBasicType(DbgNode).Verify();
447 else if (isCompositeType())
448 DICompositeType(DbgNode).Verify();
449 else if (isDerivedType())
450 DIDerivedType(DbgNode).Verify();
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 // Make sure DerivedFrom @ field 9 is MDNode.
464 if (!fieldIsMDNode(DbgNode, 9))
466 if (getTag() == dwarf::DW_TAG_ptr_to_member_type)
467 // Make sure ClassType @ field 10 is MDNode.
468 if (!fieldIsMDNode(DbgNode, 10))
471 return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
472 DbgNode->getNumOperands() <= 14;
475 /// Verify - Verify that a composite type descriptor is well formed.
476 bool DICompositeType::Verify() const {
477 if (!isCompositeType())
480 // Make sure DerivedFrom @ field 9 and ContainingType @ field 12 are MDNodes.
481 if (!fieldIsMDNode(DbgNode, 9))
483 if (!fieldIsMDNode(DbgNode, 12))
486 return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
489 /// Verify - Verify that a subprogram descriptor is well formed.
490 bool DISubprogram::Verify() const {
494 // Make sure context @ field 2 and type @ field 7 are MDNodes.
495 if (!fieldIsMDNode(DbgNode, 2))
497 if (!fieldIsMDNode(DbgNode, 7))
499 // Containing type @ field 12.
500 if (!fieldIsMDNode(DbgNode, 12))
502 return DbgNode->getNumOperands() == 20;
505 /// Verify - Verify that a global variable descriptor is well formed.
506 bool DIGlobalVariable::Verify() const {
507 if (!isGlobalVariable())
510 if (getDisplayName().empty())
512 // Make sure context @ field 2 and type @ field 8 are MDNodes.
513 if (!fieldIsMDNode(DbgNode, 2))
515 if (!fieldIsMDNode(DbgNode, 8))
517 // Make sure StaticDataMemberDeclaration @ field 12 is MDNode.
518 if (!fieldIsMDNode(DbgNode, 12))
521 return DbgNode->getNumOperands() == 13;
524 /// Verify - Verify that a variable descriptor is well formed.
525 bool DIVariable::Verify() const {
529 // Make sure context @ field 1 and type @ field 5 are MDNodes.
530 if (!fieldIsMDNode(DbgNode, 1))
532 if (!fieldIsMDNode(DbgNode, 5))
534 return DbgNode->getNumOperands() >= 8;
537 /// Verify - Verify that a location descriptor is well formed.
538 bool DILocation::Verify() const {
542 return DbgNode->getNumOperands() == 4;
545 /// Verify - Verify that a namespace descriptor is well formed.
546 bool DINameSpace::Verify() const {
549 return DbgNode->getNumOperands() == 5;
552 /// \brief Retrieve the MDNode for the directory/file pair.
553 MDNode *DIFile::getFileNode() const {
554 return getNodeField(DbgNode, 1);
557 /// \brief Verify that the file descriptor is well formed.
558 bool DIFile::Verify() const {
559 return isFile() && DbgNode->getNumOperands() == 2;
562 /// \brief Verify that the enumerator descriptor is well formed.
563 bool DIEnumerator::Verify() const {
564 return isEnumerator() && DbgNode->getNumOperands() == 3;
567 /// \brief Verify that the subrange descriptor is well formed.
568 bool DISubrange::Verify() const {
569 return isSubrange() && DbgNode->getNumOperands() == 3;
572 /// \brief Verify that the lexical block descriptor is well formed.
573 bool DILexicalBlock::Verify() const {
574 return isLexicalBlock() && DbgNode->getNumOperands() == 6;
577 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
578 bool DILexicalBlockFile::Verify() const {
579 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
582 /// \brief Verify that the template type parameter descriptor is well formed.
583 bool DITemplateTypeParameter::Verify() const {
584 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
587 /// \brief Verify that the template value parameter descriptor is well formed.
588 bool DITemplateValueParameter::Verify() const {
589 return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
592 /// \brief Verify that the imported module descriptor is well formed.
593 bool DIImportedEntity::Verify() const {
594 return isImportedEntity() &&
595 (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
598 /// getOriginalTypeSize - If this type is derived from a base type then
599 /// return base type size.
600 uint64_t DIDerivedType::getOriginalTypeSize() const {
601 unsigned Tag = getTag();
603 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
604 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
605 Tag != dwarf::DW_TAG_restrict_type)
606 return getSizeInBits();
608 DIType BaseType = getTypeDerivedFrom();
610 // If this type is not derived from any type then take conservative approach.
611 if (!BaseType.isValid())
612 return getSizeInBits();
614 // If this is a derived type, go ahead and get the base type, unless it's a
615 // reference then it's just the size of the field. Pointer types have no need
616 // of this since they're a different type of qualification on the type.
617 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
618 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
619 return getSizeInBits();
621 if (BaseType.isDerivedType())
622 return DIDerivedType(BaseType).getOriginalTypeSize();
624 return BaseType.getSizeInBits();
627 /// getObjCProperty - Return property node, if this ivar is associated with one.
628 MDNode *DIDerivedType::getObjCProperty() const {
629 return getNodeField(DbgNode, 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 return getNodeField(DbgNode, 18);
687 DIArray DISubprogram::getVariables() const {
688 return DIArray(getNodeField(DbgNode, 18));
691 Value *DITemplateValueParameter::getValue() const {
692 return getField(DbgNode, 4);
695 // If the current node has a parent scope then return that,
696 // else return an empty scope.
697 DIScope DIScope::getContext() const {
700 return DIType(DbgNode).getContext();
703 return DISubprogram(DbgNode).getContext();
705 if (isLexicalBlock())
706 return DILexicalBlock(DbgNode).getContext();
708 if (isLexicalBlockFile())
709 return DILexicalBlockFile(DbgNode).getContext();
712 return DINameSpace(DbgNode).getContext();
714 assert((isFile() || isCompileUnit()) && "Unhandled type of scope.");
718 StringRef DIScope::getFilename() const {
721 return ::getStringField(getNodeField(DbgNode, 1), 0);
724 StringRef DIScope::getDirectory() const {
727 return ::getStringField(getNodeField(DbgNode, 1), 1);
730 DIArray DICompileUnit::getEnumTypes() const {
731 if (!DbgNode || DbgNode->getNumOperands() < 13)
734 return DIArray(getNodeField(DbgNode, 7));
737 DIArray DICompileUnit::getRetainedTypes() const {
738 if (!DbgNode || DbgNode->getNumOperands() < 13)
741 return DIArray(getNodeField(DbgNode, 8));
744 DIArray DICompileUnit::getSubprograms() const {
745 if (!DbgNode || DbgNode->getNumOperands() < 13)
748 return DIArray(getNodeField(DbgNode, 9));
752 DIArray DICompileUnit::getGlobalVariables() const {
753 if (!DbgNode || DbgNode->getNumOperands() < 13)
756 return DIArray(getNodeField(DbgNode, 10));
759 DIArray DICompileUnit::getImportedEntities() const {
760 if (!DbgNode || DbgNode->getNumOperands() < 13)
763 return DIArray(getNodeField(DbgNode, 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 void DebugInfoFinder::reset() {
884 /// processModule - Process entire module and collect debug info.
885 void DebugInfoFinder::processModule(const Module &M) {
886 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
887 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
888 DICompileUnit CU(CU_Nodes->getOperand(i));
890 DIArray GVs = CU.getGlobalVariables();
891 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
892 DIGlobalVariable DIG(GVs.getElement(i));
893 if (addGlobalVariable(DIG)) {
894 processScope(DIG.getContext());
895 processType(DIG.getType());
898 DIArray SPs = CU.getSubprograms();
899 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
900 processSubprogram(DISubprogram(SPs.getElement(i)));
901 DIArray EnumTypes = CU.getEnumTypes();
902 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
903 processType(DIType(EnumTypes.getElement(i)));
904 DIArray RetainedTypes = CU.getRetainedTypes();
905 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
906 processType(DIType(RetainedTypes.getElement(i)));
907 // FIXME: We really shouldn't be bailing out after visiting just one CU
911 if (NamedMDNode *SP_Nodes = M.getNamedMetadata("llvm.dbg.sp")) {
912 for (unsigned i = 0, e = SP_Nodes->getNumOperands(); i != e; ++i)
913 processSubprogram(DISubprogram(SP_Nodes->getOperand(i)));
917 /// processLocation - Process DILocation.
918 void DebugInfoFinder::processLocation(DILocation Loc) {
919 if (!Loc.Verify()) return;
920 DIDescriptor S(Loc.getScope());
921 if (S.isCompileUnit())
922 addCompileUnit(DICompileUnit(S));
923 else if (S.isSubprogram())
924 processSubprogram(DISubprogram(S));
925 else if (S.isLexicalBlock())
926 processLexicalBlock(DILexicalBlock(S));
927 else if (S.isLexicalBlockFile()) {
928 DILexicalBlockFile DBF = DILexicalBlockFile(S);
929 processLexicalBlock(DILexicalBlock(DBF.getScope()));
931 processLocation(Loc.getOrigLocation());
934 /// processType - Process DIType.
935 void DebugInfoFinder::processType(DIType DT) {
938 processScope(DT.getContext());
939 if (DT.isCompositeType()) {
940 DICompositeType DCT(DT);
941 processType(DCT.getTypeDerivedFrom());
942 DIArray DA = DCT.getTypeArray();
943 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
944 DIDescriptor D = DA.getElement(i);
946 processType(DIType(D));
947 else if (D.isSubprogram())
948 processSubprogram(DISubprogram(D));
950 } else if (DT.isDerivedType()) {
951 DIDerivedType DDT(DT);
952 processType(DDT.getTypeDerivedFrom());
956 void DebugInfoFinder::processScope(DIScope Scope) {
957 if (Scope.isType()) {
962 if (Scope.isCompileUnit()) {
963 addCompileUnit(DICompileUnit(Scope));
966 if (Scope.isSubprogram()) {
967 processSubprogram(DISubprogram(Scope));
970 if (!addScope(Scope))
972 if (Scope.isLexicalBlock()) {
973 DILexicalBlock LB(Scope);
974 processScope(LB.getContext());
975 } else if (Scope.isLexicalBlockFile()) {
976 DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
977 processScope(LBF.getScope());
978 } else if (Scope.isNameSpace()) {
979 DINameSpace NS(Scope);
980 processScope(NS.getContext());
984 /// processLexicalBlock
985 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
986 DIScope Context = LB.getContext();
987 if (Context.isLexicalBlock())
988 return processLexicalBlock(DILexicalBlock(Context));
989 else if (Context.isLexicalBlockFile()) {
990 DILexicalBlockFile DBF = DILexicalBlockFile(Context);
991 return processLexicalBlock(DILexicalBlock(DBF.getScope()));
994 return processSubprogram(DISubprogram(Context));
997 /// processSubprogram - Process DISubprogram.
998 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
999 if (!addSubprogram(SP))
1001 processScope(SP.getContext());
1002 processType(SP.getType());
1005 /// processDeclare - Process DbgDeclareInst.
1006 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
1007 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1011 if (!DV.isVariable())
1014 if (!NodesSeen.insert(DV))
1016 processScope(DIVariable(N).getContext());
1017 processType(DIVariable(N).getType());
1020 void DebugInfoFinder::processValue(const DbgValueInst *DVI) {
1021 MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
1025 if (!DV.isVariable())
1028 if (!NodesSeen.insert(DV))
1030 processScope(DIVariable(N).getContext());
1031 processType(DIVariable(N).getType());
1034 /// addType - Add type into Tys.
1035 bool DebugInfoFinder::addType(DIType DT) {
1039 if (!NodesSeen.insert(DT))
1046 /// addCompileUnit - Add compile unit into CUs.
1047 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1050 if (!NodesSeen.insert(CU))
1057 /// addGlobalVariable - Add global variable into GVs.
1058 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1062 if (!NodesSeen.insert(DIG))
1069 // addSubprogram - Add subprgoram into SPs.
1070 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1074 if (!NodesSeen.insert(SP))
1081 bool DebugInfoFinder::addScope(DIScope Scope) {
1084 if (!NodesSeen.insert(Scope))
1086 Scopes.push_back(Scope);
1090 //===----------------------------------------------------------------------===//
1091 // DIDescriptor: dump routines for all descriptors.
1092 //===----------------------------------------------------------------------===//
1094 /// dump - Print descriptor to dbgs() with a newline.
1095 void DIDescriptor::dump() const {
1096 print(dbgs()); dbgs() << '\n';
1099 /// print - Print descriptor.
1100 void DIDescriptor::print(raw_ostream &OS) const {
1101 if (!DbgNode) return;
1103 if (const char *Tag = dwarf::TagString(getTag()))
1104 OS << "[ " << Tag << " ]";
1106 if (this->isSubrange()) {
1107 DISubrange(DbgNode).printInternal(OS);
1108 } else if (this->isCompileUnit()) {
1109 DICompileUnit(DbgNode).printInternal(OS);
1110 } else if (this->isFile()) {
1111 DIFile(DbgNode).printInternal(OS);
1112 } else if (this->isEnumerator()) {
1113 DIEnumerator(DbgNode).printInternal(OS);
1114 } else if (this->isBasicType()) {
1115 DIType(DbgNode).printInternal(OS);
1116 } else if (this->isDerivedType()) {
1117 DIDerivedType(DbgNode).printInternal(OS);
1118 } else if (this->isCompositeType()) {
1119 DICompositeType(DbgNode).printInternal(OS);
1120 } else if (this->isSubprogram()) {
1121 DISubprogram(DbgNode).printInternal(OS);
1122 } else if (this->isGlobalVariable()) {
1123 DIGlobalVariable(DbgNode).printInternal(OS);
1124 } else if (this->isVariable()) {
1125 DIVariable(DbgNode).printInternal(OS);
1126 } else if (this->isObjCProperty()) {
1127 DIObjCProperty(DbgNode).printInternal(OS);
1128 } else if (this->isNameSpace()) {
1129 DINameSpace(DbgNode).printInternal(OS);
1130 } else if (this->isScope()) {
1131 DIScope(DbgNode).printInternal(OS);
1135 void DISubrange::printInternal(raw_ostream &OS) const {
1136 int64_t Count = getCount();
1138 OS << " [" << getLo() << ", " << Count - 1 << ']';
1140 OS << " [unbounded]";
1143 void DIScope::printInternal(raw_ostream &OS) const {
1144 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1147 void DICompileUnit::printInternal(raw_ostream &OS) const {
1148 DIScope::printInternal(OS);
1150 unsigned Lang = getLanguage();
1151 if (const char *LangStr = dwarf::LanguageString(Lang))
1154 (OS << "lang 0x").write_hex(Lang);
1158 void DIEnumerator::printInternal(raw_ostream &OS) const {
1159 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1162 void DIType::printInternal(raw_ostream &OS) const {
1163 if (!DbgNode) return;
1165 StringRef Res = getName();
1167 OS << " [" << Res << "]";
1169 // TODO: Print context?
1171 OS << " [line " << getLineNumber()
1172 << ", size " << getSizeInBits()
1173 << ", align " << getAlignInBits()
1174 << ", offset " << getOffsetInBits();
1176 if (const char *Enc =
1177 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1178 OS << ", enc " << Enc;
1183 else if (isProtected())
1184 OS << " [protected]";
1187 OS << " [artificial]";
1189 if (isForwardDecl())
1191 else if (getTag() == dwarf::DW_TAG_structure_type ||
1192 getTag() == dwarf::DW_TAG_union_type ||
1193 getTag() == dwarf::DW_TAG_enumeration_type ||
1194 getTag() == dwarf::DW_TAG_class_type)
1198 if (isStaticMember())
1202 void DIDerivedType::printInternal(raw_ostream &OS) const {
1203 DIType::printInternal(OS);
1204 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1207 void DICompositeType::printInternal(raw_ostream &OS) const {
1208 DIType::printInternal(OS);
1209 DIArray A = getTypeArray();
1210 OS << " [" << A.getNumElements() << " elements]";
1213 void DINameSpace::printInternal(raw_ostream &OS) const {
1214 StringRef Name = getName();
1216 OS << " [" << Name << ']';
1218 OS << " [line " << getLineNumber() << ']';
1221 void DISubprogram::printInternal(raw_ostream &OS) const {
1222 // TODO : Print context
1223 OS << " [line " << getLineNumber() << ']';
1225 if (isLocalToUnit())
1231 if (getScopeLineNumber() != getLineNumber())
1232 OS << " [scope " << getScopeLineNumber() << "]";
1236 else if (isProtected())
1237 OS << " [protected]";
1239 StringRef Res = getName();
1241 OS << " [" << Res << ']';
1244 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1245 StringRef Res = getName();
1247 OS << " [" << Res << ']';
1249 OS << " [line " << getLineNumber() << ']';
1251 // TODO : Print context
1253 if (isLocalToUnit())
1260 void DIVariable::printInternal(raw_ostream &OS) const {
1261 StringRef Res = getName();
1263 OS << " [" << Res << ']';
1265 OS << " [line " << getLineNumber() << ']';
1268 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1269 StringRef Name = getObjCPropertyName();
1271 OS << " [" << Name << ']';
1273 OS << " [line " << getLineNumber()
1274 << ", properties " << getUnsignedField(6) << ']';
1277 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1278 const LLVMContext &Ctx) {
1279 if (!DL.isUnknown()) { // Print source line info.
1280 DIScope Scope(DL.getScope(Ctx));
1281 assert(Scope.isScope() &&
1282 "Scope of a DebugLoc should be a DIScope.");
1283 // Omit the directory, because it's likely to be long and uninteresting.
1284 CommentOS << Scope.getFilename();
1285 CommentOS << ':' << DL.getLine();
1286 if (DL.getCol() != 0)
1287 CommentOS << ':' << DL.getCol();
1288 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1289 if (!InlinedAtDL.isUnknown()) {
1290 CommentOS << " @[ ";
1291 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1297 void DIVariable::printExtendedName(raw_ostream &OS) const {
1298 const LLVMContext &Ctx = DbgNode->getContext();
1299 StringRef Res = getName();
1301 OS << Res << "," << getLineNumber();
1302 if (MDNode *InlinedAt = getInlinedAt()) {
1303 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1304 if (!InlinedAtDL.isUnknown()) {
1306 printDebugLoc(InlinedAtDL, OS, Ctx);