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/IR/DebugInfo.h"
16 #include "LLVMContextImpl.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/ADT/SmallPtrSet.h"
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/Analysis/ValueTracking.h"
21 #include "llvm/IR/Constants.h"
22 #include "llvm/IR/DIBuilder.h"
23 #include "llvm/IR/DerivedTypes.h"
24 #include "llvm/IR/Instructions.h"
25 #include "llvm/IR/IntrinsicInst.h"
26 #include "llvm/IR/Intrinsics.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/IR/ValueHandle.h"
29 #include "llvm/Support/Debug.h"
30 #include "llvm/Support/Dwarf.h"
31 #include "llvm/Support/raw_ostream.h"
33 using namespace llvm::dwarf;
35 //===----------------------------------------------------------------------===//
37 //===----------------------------------------------------------------------===//
39 bool DIDescriptor::Verify() const {
41 (DIDerivedType(DbgNode).Verify() ||
42 DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
43 DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
44 DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
45 DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
46 DILexicalBlock(DbgNode).Verify() ||
47 DILexicalBlockFile(DbgNode).Verify() ||
48 DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
49 DIObjCProperty(DbgNode).Verify() ||
50 DITemplateTypeParameter(DbgNode).Verify() ||
51 DITemplateValueParameter(DbgNode).Verify() ||
52 DIImportedEntity(DbgNode).Verify() || DIExpression(DbgNode).Verify());
55 static Value *getField(const MDNode *DbgNode, unsigned Elt) {
56 if (!DbgNode || Elt >= DbgNode->getNumOperands())
58 return DbgNode->getOperand(Elt);
61 static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
62 return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
65 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
66 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
67 return MDS->getString();
71 StringRef DIDescriptor::getStringField(unsigned Elt) const {
72 return ::getStringField(DbgNode, Elt);
75 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
79 if (Elt < DbgNode->getNumOperands())
81 dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
82 return CI->getZExtValue();
87 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
91 if (Elt < DbgNode->getNumOperands())
93 dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
94 return CI->getSExtValue();
99 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
100 MDNode *Field = getNodeField(DbgNode, Elt);
101 return DIDescriptor(Field);
104 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
108 if (Elt < DbgNode->getNumOperands())
109 return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
113 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
117 if (Elt < DbgNode->getNumOperands())
118 return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
122 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
126 if (Elt < DbgNode->getNumOperands())
127 return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
131 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
135 if (Elt < DbgNode->getNumOperands()) {
136 MDNode *Node = const_cast<MDNode *>(DbgNode);
137 Node->replaceOperandWith(Elt, F);
141 static unsigned DIVariableInlinedAtIndex = 4;
142 MDNode *DIVariable::getInlinedAt() const {
143 return getNodeField(DbgNode, DIVariableInlinedAtIndex);
146 /// \brief Return the size reported by the variable's type.
147 unsigned DIVariable::getSizeInBits(const DITypeIdentifierMap &Map) {
148 DIType Ty = getType().resolve(Map);
149 // Follow derived types until we reach a type that
150 // reports back a size.
151 while (Ty.isDerivedType() && !Ty.getSizeInBits()) {
152 DIDerivedType DT(&*Ty);
153 Ty = DT.getTypeDerivedFrom().resolve(Map);
155 assert(Ty.getSizeInBits() && "type with size 0");
156 return Ty.getSizeInBits();
159 uint64_t DIExpression::getElement(unsigned Idx) const {
160 unsigned I = Idx + 1;
161 assert(I < getNumHeaderFields() &&
162 "non-existing complex address element requested");
163 return getHeaderFieldAs<int64_t>(I);
166 bool DIExpression::isVariablePiece() const {
167 return getNumElements() && getElement(0) == dwarf::DW_OP_piece;
170 uint64_t DIExpression::getPieceOffset() const {
171 assert(isVariablePiece());
172 return getElement(1);
175 uint64_t DIExpression::getPieceSize() const {
176 assert(isVariablePiece());
177 return getElement(2);
180 //===----------------------------------------------------------------------===//
182 //===----------------------------------------------------------------------===//
184 bool DIDescriptor::isSubroutineType() const {
185 return isCompositeType() && getTag() == dwarf::DW_TAG_subroutine_type;
188 bool DIDescriptor::isBasicType() const {
192 case dwarf::DW_TAG_base_type:
193 case dwarf::DW_TAG_unspecified_type:
200 bool DIDescriptor::isDerivedType() const {
204 case dwarf::DW_TAG_typedef:
205 case dwarf::DW_TAG_pointer_type:
206 case dwarf::DW_TAG_ptr_to_member_type:
207 case dwarf::DW_TAG_reference_type:
208 case dwarf::DW_TAG_rvalue_reference_type:
209 case dwarf::DW_TAG_const_type:
210 case dwarf::DW_TAG_volatile_type:
211 case dwarf::DW_TAG_restrict_type:
212 case dwarf::DW_TAG_member:
213 case dwarf::DW_TAG_inheritance:
214 case dwarf::DW_TAG_friend:
217 // CompositeTypes are currently modelled as DerivedTypes.
218 return isCompositeType();
222 bool DIDescriptor::isCompositeType() const {
226 case dwarf::DW_TAG_array_type:
227 case dwarf::DW_TAG_structure_type:
228 case dwarf::DW_TAG_union_type:
229 case dwarf::DW_TAG_enumeration_type:
230 case dwarf::DW_TAG_subroutine_type:
231 case dwarf::DW_TAG_class_type:
238 bool DIDescriptor::isVariable() const {
242 case dwarf::DW_TAG_auto_variable:
243 case dwarf::DW_TAG_arg_variable:
250 bool DIDescriptor::isType() const {
251 return isBasicType() || isCompositeType() || isDerivedType();
254 bool DIDescriptor::isSubprogram() const {
255 return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
258 bool DIDescriptor::isGlobalVariable() const {
259 return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
260 getTag() == dwarf::DW_TAG_constant);
263 bool DIDescriptor::isScope() const {
267 case dwarf::DW_TAG_compile_unit:
268 case dwarf::DW_TAG_lexical_block:
269 case dwarf::DW_TAG_subprogram:
270 case dwarf::DW_TAG_namespace:
271 case dwarf::DW_TAG_file_type:
279 bool DIDescriptor::isTemplateTypeParameter() const {
280 return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
283 bool DIDescriptor::isTemplateValueParameter() const {
284 return DbgNode && (getTag() == dwarf::DW_TAG_template_value_parameter ||
285 getTag() == dwarf::DW_TAG_GNU_template_template_param ||
286 getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
289 bool DIDescriptor::isCompileUnit() const {
290 return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
293 bool DIDescriptor::isFile() const {
294 return DbgNode && getTag() == dwarf::DW_TAG_file_type;
297 bool DIDescriptor::isNameSpace() const {
298 return DbgNode && getTag() == dwarf::DW_TAG_namespace;
301 bool DIDescriptor::isLexicalBlockFile() const {
302 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
303 DbgNode->getNumOperands() == 3 && getNumHeaderFields() == 2;
306 bool DIDescriptor::isLexicalBlock() const {
307 // FIXME: There are always exactly 4 header fields in DILexicalBlock, but
308 // something relies on this returning true for DILexicalBlockFile.
309 return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
310 DbgNode->getNumOperands() == 3 &&
311 (getNumHeaderFields() == 2 || getNumHeaderFields() == 4);
314 bool DIDescriptor::isSubrange() const {
315 return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
318 bool DIDescriptor::isEnumerator() const {
319 return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
322 bool DIDescriptor::isObjCProperty() const {
323 return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
326 bool DIDescriptor::isImportedEntity() const {
327 return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
328 getTag() == dwarf::DW_TAG_imported_declaration);
331 bool DIDescriptor::isExpression() const {
332 return DbgNode && (getTag() == dwarf::DW_TAG_expression);
335 //===----------------------------------------------------------------------===//
336 // Simple Descriptor Constructors and other Methods
337 //===----------------------------------------------------------------------===//
339 void DIDescriptor::replaceAllUsesWith(LLVMContext &VMContext, DIDescriptor D) {
341 assert(DbgNode && "Trying to replace an unverified type!");
343 // Since we use a TrackingVH for the node, its easy for clients to manufacture
344 // legitimate situations where they want to replaceAllUsesWith() on something
345 // which, due to uniquing, has merged with the source. We shield clients from
346 // this detail by allowing a value to be replaced with replaceAllUsesWith()
348 const MDNode *DN = D;
350 SmallVector<Value*, 10> Ops(DbgNode->getNumOperands());
351 for (size_t i = 0; i != Ops.size(); ++i)
352 Ops[i] = DbgNode->getOperand(i);
353 DN = MDNode::get(VMContext, Ops);
356 MDNode *Node = const_cast<MDNode *>(DbgNode);
357 const Value *V = cast_or_null<Value>(DN);
358 Node->replaceAllUsesWith(const_cast<Value *>(V));
359 MDNode::deleteTemporary(Node);
363 void DIDescriptor::replaceAllUsesWith(MDNode *D) {
365 assert(DbgNode && "Trying to replace an unverified type!");
366 assert(DbgNode != D && "This replacement should always happen");
367 MDNode *Node = const_cast<MDNode *>(DbgNode);
368 const MDNode *DN = D;
369 const Value *V = cast_or_null<Value>(DN);
370 Node->replaceAllUsesWith(const_cast<Value *>(V));
371 MDNode::deleteTemporary(Node);
374 bool DICompileUnit::Verify() const {
375 if (!isCompileUnit())
378 // Don't bother verifying the compilation directory or producer string
379 // as those could be empty.
380 if (getFilename().empty())
383 return DbgNode->getNumOperands() == 7 && getNumHeaderFields() == 8;
386 bool DIObjCProperty::Verify() const {
387 if (!isObjCProperty())
390 // Don't worry about the rest of the strings for now.
391 return DbgNode->getNumOperands() == 3 && getNumHeaderFields() == 6;
394 /// \brief Check if a field at position Elt of a MDNode is a MDNode.
396 /// We currently allow an empty string and an integer.
397 /// But we don't allow a non-empty string in a MDNode field.
398 static bool fieldIsMDNode(const MDNode *DbgNode, unsigned Elt) {
399 // FIXME: This function should return true, if the field is null or the field
400 // is indeed a MDNode: return !Fld || isa<MDNode>(Fld).
401 Value *Fld = getField(DbgNode, Elt);
402 if (Fld && isa<MDString>(Fld) && !cast<MDString>(Fld)->getString().empty())
407 /// \brief Check if a field at position Elt of a MDNode is a MDString.
408 static bool fieldIsMDString(const MDNode *DbgNode, unsigned Elt) {
409 Value *Fld = getField(DbgNode, Elt);
410 return !Fld || isa<MDString>(Fld);
413 /// \brief Check if a value can be a reference to a type.
414 static bool isTypeRef(const Value *Val) {
416 (isa<MDString>(Val) && !cast<MDString>(Val)->getString().empty()) ||
417 (isa<MDNode>(Val) && DIType(cast<MDNode>(Val)).isType());
420 /// \brief Check if referenced field might be a type.
421 static bool fieldIsTypeRef(const MDNode *DbgNode, unsigned Elt) {
422 Value *Fld = getField(DbgNode, Elt);
423 return isTypeRef(Fld);
426 /// \brief Check if a value can be a ScopeRef.
427 static bool isScopeRef(const Value *Val) {
429 (isa<MDString>(Val) && !cast<MDString>(Val)->getString().empty()) ||
430 // Not checking for Val->isScope() here, because it would work
431 // only for lexical scopes and not all subclasses of DIScope.
435 /// \brief Check if a field at position Elt of a MDNode can be a ScopeRef.
436 static bool fieldIsScopeRef(const MDNode *DbgNode, unsigned Elt) {
437 Value *Fld = getField(DbgNode, Elt);
438 return isScopeRef(Fld);
441 bool DIType::Verify() const {
444 // Make sure Context @ field 2 is MDNode.
445 if (!fieldIsScopeRef(DbgNode, 2))
448 // FIXME: Sink this into the various subclass verifies.
449 uint16_t 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 && Tag != dwarf::DW_TAG_array_type &&
456 Tag != dwarf::DW_TAG_enumeration_type &&
457 Tag != dwarf::DW_TAG_subroutine_type &&
458 Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
459 getFilename().empty())
462 // DIType is abstract, it should be a BasicType, a DerivedType or
465 return DIBasicType(DbgNode).Verify();
466 else if (isCompositeType())
467 return DICompositeType(DbgNode).Verify();
468 else if (isDerivedType())
469 return DIDerivedType(DbgNode).Verify();
474 bool DIBasicType::Verify() const {
475 return isBasicType() && DbgNode->getNumOperands() == 3 &&
476 getNumHeaderFields() == 8;
479 bool DIDerivedType::Verify() const {
480 // Make sure DerivedFrom @ field 3 is TypeRef.
481 if (!fieldIsTypeRef(DbgNode, 3))
483 if (getTag() == dwarf::DW_TAG_ptr_to_member_type)
484 // Make sure ClassType @ field 4 is a TypeRef.
485 if (!fieldIsTypeRef(DbgNode, 4))
488 return isDerivedType() && DbgNode->getNumOperands() >= 4 &&
489 DbgNode->getNumOperands() <= 8 && getNumHeaderFields() >= 7 &&
490 getNumHeaderFields() <= 8;
493 bool DICompositeType::Verify() const {
494 if (!isCompositeType())
497 // Make sure DerivedFrom @ field 3 and ContainingType @ field 5 are TypeRef.
498 if (!fieldIsTypeRef(DbgNode, 3))
500 if (!fieldIsTypeRef(DbgNode, 5))
503 // Make sure the type identifier at field 7 is MDString, it can be null.
504 if (!fieldIsMDString(DbgNode, 7))
507 // A subroutine type can't be both & and &&.
508 if (isLValueReference() && isRValueReference())
511 return DbgNode->getNumOperands() == 8 && getNumHeaderFields() == 8;
514 bool DISubprogram::Verify() const {
518 // Make sure context @ field 2 is a ScopeRef and type @ field 3 is a MDNode.
519 if (!fieldIsScopeRef(DbgNode, 2))
521 if (!fieldIsMDNode(DbgNode, 3))
523 // Containing type @ field 4.
524 if (!fieldIsTypeRef(DbgNode, 4))
527 // A subprogram can't be both & and &&.
528 if (isLValueReference() && isRValueReference())
531 // If a DISubprogram has an llvm::Function*, then scope chains from all
532 // instructions within the function should lead to this DISubprogram.
533 if (auto *F = getFunction()) {
534 LLVMContext &Ctxt = F->getContext();
535 for (auto &BB : *F) {
537 DebugLoc DL = I.getDebugLoc();
541 MDNode *Scope = nullptr;
542 MDNode *IA = nullptr;
543 // walk the inlined-at scopes
544 while (DL.getScopeAndInlinedAt(Scope, IA, F->getContext()), IA)
545 DL = DebugLoc::getFromDILocation(IA);
546 DL.getScopeAndInlinedAt(Scope, IA, Ctxt);
548 while (!DIDescriptor(Scope).isSubprogram()) {
549 DILexicalBlockFile D(Scope);
550 Scope = D.isLexicalBlockFile()
552 : DebugLoc::getFromDILexicalBlock(Scope).getScope(Ctxt);
554 if (!DISubprogram(Scope).describes(F))
559 return DbgNode->getNumOperands() == 9 && getNumHeaderFields() == 12;
562 bool DIGlobalVariable::Verify() const {
563 if (!isGlobalVariable())
566 if (getDisplayName().empty())
568 // Make sure context @ field 1 is an MDNode.
569 if (!fieldIsMDNode(DbgNode, 1))
571 // Make sure that type @ field 3 is a DITypeRef.
572 if (!fieldIsTypeRef(DbgNode, 3))
574 // Make sure StaticDataMemberDeclaration @ field 5 is MDNode.
575 if (!fieldIsMDNode(DbgNode, 5))
578 return DbgNode->getNumOperands() == 6 && getNumHeaderFields() == 7;
581 bool DIVariable::Verify() const {
585 // Make sure context @ field 1 is an MDNode.
586 if (!fieldIsMDNode(DbgNode, 1))
588 // Make sure that type @ field 3 is a DITypeRef.
589 if (!fieldIsTypeRef(DbgNode, 3))
592 // Check the number of header fields, which is common between complex and
594 if (getNumHeaderFields() != 4)
597 // Variable without an inline location.
598 if (DbgNode->getNumOperands() == 4)
601 // Variable with an inline location.
602 return getInlinedAt() != nullptr && DbgNode->getNumOperands() == 5;
605 bool DIExpression::Verify() const {
606 // Empty DIExpressions may be represented as a nullptr.
610 return isExpression() && DbgNode->getNumOperands() == 1;
613 bool DILocation::Verify() const {
617 return DbgNode->getNumOperands() == 4;
620 bool DINameSpace::Verify() const {
623 return DbgNode->getNumOperands() == 3 && getNumHeaderFields() == 3;
626 MDNode *DIFile::getFileNode() const { return getNodeField(DbgNode, 1); }
628 bool DIFile::Verify() const {
629 return isFile() && DbgNode->getNumOperands() == 2;
632 bool DIEnumerator::Verify() const {
633 return isEnumerator() && DbgNode->getNumOperands() == 1 &&
634 getNumHeaderFields() == 3;
637 bool DISubrange::Verify() const {
638 return isSubrange() && DbgNode->getNumOperands() == 1 &&
639 getNumHeaderFields() == 3;
642 bool DILexicalBlock::Verify() const {
643 return isLexicalBlock() && DbgNode->getNumOperands() == 3 &&
644 getNumHeaderFields() == 4;
647 bool DILexicalBlockFile::Verify() const {
648 return isLexicalBlockFile() && DbgNode->getNumOperands() == 3 &&
649 getNumHeaderFields() == 2;
652 bool DITemplateTypeParameter::Verify() const {
653 return isTemplateTypeParameter() && DbgNode->getNumOperands() == 4 &&
654 getNumHeaderFields() == 4;
657 bool DITemplateValueParameter::Verify() const {
658 return isTemplateValueParameter() && DbgNode->getNumOperands() == 5 &&
659 getNumHeaderFields() == 4;
662 bool DIImportedEntity::Verify() const {
663 return isImportedEntity() && DbgNode->getNumOperands() == 3 &&
664 getNumHeaderFields() == 3;
667 MDNode *DIDerivedType::getObjCProperty() const {
668 return getNodeField(DbgNode, 4);
671 MDString *DICompositeType::getIdentifier() const {
672 return cast_or_null<MDString>(getField(DbgNode, 7));
676 static void VerifySubsetOf(const MDNode *LHS, const MDNode *RHS) {
677 for (unsigned i = 0; i != LHS->getNumOperands(); ++i) {
678 // Skip the 'empty' list (that's a single i32 0, rather than truly empty).
679 if (i == 0 && isa<ConstantInt>(LHS->getOperand(i)))
681 const MDNode *E = cast<MDNode>(LHS->getOperand(i));
683 for (unsigned j = 0; !found && j != RHS->getNumOperands(); ++j)
684 found = E == RHS->getOperand(j);
685 assert(found && "Losing a member during member list replacement");
690 void DICompositeType::setArraysHelper(MDNode *Elements, MDNode *TParams) {
691 TrackingVH<MDNode> N(*this);
694 // Check that the new list of members contains all the old members as well.
695 if (const MDNode *El = cast_or_null<MDNode>(N->getOperand(4)))
696 VerifySubsetOf(El, Elements);
698 N->replaceOperandWith(4, Elements);
701 N->replaceOperandWith(6, TParams);
705 DIScopeRef DIScope::getRef() const {
706 if (!isCompositeType())
707 return DIScopeRef(*this);
708 DICompositeType DTy(DbgNode);
709 if (!DTy.getIdentifier())
710 return DIScopeRef(*this);
711 return DIScopeRef(DTy.getIdentifier());
714 void DICompositeType::setContainingType(DICompositeType ContainingType) {
715 TrackingVH<MDNode> N(*this);
716 N->replaceOperandWith(5, ContainingType.getRef());
720 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
721 assert(CurFn && "Invalid function");
722 if (!getContext().isSubprogram())
724 // This variable is not inlined function argument if its scope
725 // does not describe current function.
726 return !DISubprogram(getContext()).describes(CurFn);
729 bool DISubprogram::describes(const Function *F) {
730 assert(F && "Invalid function");
731 if (F == getFunction())
733 StringRef Name = getLinkageName();
736 if (F->getName() == Name)
741 MDNode *DISubprogram::getVariablesNodes() const {
742 return getNodeField(DbgNode, 8);
745 DIArray DISubprogram::getVariables() const {
746 return DIArray(getNodeField(DbgNode, 8));
749 Value *DITemplateValueParameter::getValue() const {
750 return getField(DbgNode, 3);
753 DIScopeRef DIScope::getContext() const {
756 return DIType(DbgNode).getContext();
759 return DIScopeRef(DISubprogram(DbgNode).getContext());
761 if (isLexicalBlock())
762 return DIScopeRef(DILexicalBlock(DbgNode).getContext());
764 if (isLexicalBlockFile())
765 return DIScopeRef(DILexicalBlockFile(DbgNode).getContext());
768 return DIScopeRef(DINameSpace(DbgNode).getContext());
770 assert((isFile() || isCompileUnit()) && "Unhandled type of scope.");
771 return DIScopeRef(nullptr);
774 StringRef DIScope::getName() const {
776 return DIType(DbgNode).getName();
778 return DISubprogram(DbgNode).getName();
780 return DINameSpace(DbgNode).getName();
781 assert((isLexicalBlock() || isLexicalBlockFile() || isFile() ||
783 "Unhandled type of scope.");
787 StringRef DIScope::getFilename() const {
790 return ::getStringField(getNodeField(DbgNode, 1), 0);
793 StringRef DIScope::getDirectory() const {
796 return ::getStringField(getNodeField(DbgNode, 1), 1);
799 DIArray DICompileUnit::getEnumTypes() const {
800 if (!DbgNode || DbgNode->getNumOperands() < 7)
803 return DIArray(getNodeField(DbgNode, 2));
806 DIArray DICompileUnit::getRetainedTypes() const {
807 if (!DbgNode || DbgNode->getNumOperands() < 7)
810 return DIArray(getNodeField(DbgNode, 3));
813 DIArray DICompileUnit::getSubprograms() const {
814 if (!DbgNode || DbgNode->getNumOperands() < 7)
817 return DIArray(getNodeField(DbgNode, 4));
820 DIArray DICompileUnit::getGlobalVariables() const {
821 if (!DbgNode || DbgNode->getNumOperands() < 7)
824 return DIArray(getNodeField(DbgNode, 5));
827 DIArray DICompileUnit::getImportedEntities() const {
828 if (!DbgNode || DbgNode->getNumOperands() < 7)
831 return DIArray(getNodeField(DbgNode, 6));
834 void DICompileUnit::replaceSubprograms(DIArray Subprograms) {
835 assert(Verify() && "Expected compile unit");
836 if (Subprograms == getSubprograms())
839 const_cast<MDNode *>(DbgNode)->replaceOperandWith(4, Subprograms);
842 void DICompileUnit::replaceGlobalVariables(DIArray GlobalVariables) {
843 assert(Verify() && "Expected compile unit");
844 if (GlobalVariables == getGlobalVariables())
847 const_cast<MDNode *>(DbgNode)->replaceOperandWith(5, GlobalVariables);
850 DILocation DILocation::copyWithNewScope(LLVMContext &Ctx,
851 DILexicalBlockFile NewScope) {
852 SmallVector<Value *, 10> Elts;
854 for (unsigned I = 0; I < DbgNode->getNumOperands(); ++I) {
856 Elts.push_back(DbgNode->getOperand(I));
858 Elts.push_back(NewScope);
860 MDNode *NewDIL = MDNode::get(Ctx, Elts);
861 return DILocation(NewDIL);
864 unsigned DILocation::computeNewDiscriminator(LLVMContext &Ctx) {
865 std::pair<const char *, unsigned> Key(getFilename().data(), getLineNumber());
866 return ++Ctx.pImpl->DiscriminatorTable[Key];
869 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
870 LLVMContext &VMContext) {
871 assert(DIVariable(DV).Verify() && "Expected a DIVariable");
873 return cleanseInlinedVariable(DV, VMContext);
875 // Insert inlined scope.
876 SmallVector<Value *, 8> Elts;
877 for (unsigned I = 0, E = DIVariableInlinedAtIndex; I != E; ++I)
878 Elts.push_back(DV->getOperand(I));
879 Elts.push_back(InlinedScope);
881 DIVariable Inlined(MDNode::get(VMContext, Elts));
882 assert(Inlined.Verify() && "Expected to create a DIVariable");
886 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
887 assert(DIVariable(DV).Verify() && "Expected a DIVariable");
888 if (!DIVariable(DV).getInlinedAt())
889 return DIVariable(DV);
891 // Remove inlined scope.
892 SmallVector<Value *, 8> Elts;
893 for (unsigned I = 0, E = DIVariableInlinedAtIndex; I != E; ++I)
894 Elts.push_back(DV->getOperand(I));
896 DIVariable Cleansed(MDNode::get(VMContext, Elts));
897 assert(Cleansed.Verify() && "Expected to create a DIVariable");
901 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
902 DIDescriptor D(Scope);
903 if (D.isSubprogram())
904 return DISubprogram(Scope);
906 if (D.isLexicalBlockFile())
907 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
909 if (D.isLexicalBlock())
910 return getDISubprogram(DILexicalBlock(Scope).getContext());
912 return DISubprogram();
915 DISubprogram llvm::getDISubprogram(const Function *F) {
916 // We look for the first instr that has a debug annotation leading back to F.
917 for (auto &BB : *F) {
918 auto Inst = std::find_if(BB.begin(), BB.end(), [](const Instruction &Inst) {
919 return !Inst.getDebugLoc().isUnknown();
921 if (Inst == BB.end())
923 DebugLoc DLoc = Inst->getDebugLoc();
924 const MDNode *Scope = DLoc.getScopeNode(F->getParent()->getContext());
925 DISubprogram Subprogram = getDISubprogram(Scope);
926 return Subprogram.describes(F) ? Subprogram : DISubprogram();
929 return DISubprogram();
932 DICompositeType llvm::getDICompositeType(DIType T) {
933 if (T.isCompositeType())
934 return DICompositeType(T);
936 if (T.isDerivedType()) {
937 // This function is currently used by dragonegg and dragonegg does
938 // not generate identifier for types, so using an empty map to resolve
939 // DerivedFrom should be fine.
940 DITypeIdentifierMap EmptyMap;
941 return getDICompositeType(
942 DIDerivedType(T).getTypeDerivedFrom().resolve(EmptyMap));
945 return DICompositeType();
949 llvm::generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes) {
950 DITypeIdentifierMap Map;
951 for (unsigned CUi = 0, CUe = CU_Nodes->getNumOperands(); CUi != CUe; ++CUi) {
952 DICompileUnit CU(CU_Nodes->getOperand(CUi));
953 DIArray Retain = CU.getRetainedTypes();
954 for (unsigned Ti = 0, Te = Retain.getNumElements(); Ti != Te; ++Ti) {
955 if (!Retain.getElement(Ti).isCompositeType())
957 DICompositeType Ty(Retain.getElement(Ti));
958 if (MDString *TypeId = Ty.getIdentifier()) {
959 // Definition has priority over declaration.
960 // Try to insert (TypeId, Ty) to Map.
961 std::pair<DITypeIdentifierMap::iterator, bool> P =
962 Map.insert(std::make_pair(TypeId, Ty));
963 // If TypeId already exists in Map and this is a definition, replace
964 // whatever we had (declaration or definition) with the definition.
965 if (!P.second && !Ty.isForwardDecl())
966 P.first->second = Ty;
973 //===----------------------------------------------------------------------===//
974 // DebugInfoFinder implementations.
975 //===----------------------------------------------------------------------===//
977 void DebugInfoFinder::reset() {
984 TypeIdentifierMap.clear();
985 TypeMapInitialized = false;
988 void DebugInfoFinder::InitializeTypeMap(const Module &M) {
989 if (!TypeMapInitialized)
990 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
991 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
992 TypeMapInitialized = true;
996 void DebugInfoFinder::processModule(const Module &M) {
997 InitializeTypeMap(M);
998 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
999 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
1000 DICompileUnit CU(CU_Nodes->getOperand(i));
1002 DIArray GVs = CU.getGlobalVariables();
1003 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
1004 DIGlobalVariable DIG(GVs.getElement(i));
1005 if (addGlobalVariable(DIG)) {
1006 processScope(DIG.getContext());
1007 processType(DIG.getType().resolve(TypeIdentifierMap));
1010 DIArray SPs = CU.getSubprograms();
1011 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
1012 processSubprogram(DISubprogram(SPs.getElement(i)));
1013 DIArray EnumTypes = CU.getEnumTypes();
1014 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
1015 processType(DIType(EnumTypes.getElement(i)));
1016 DIArray RetainedTypes = CU.getRetainedTypes();
1017 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
1018 processType(DIType(RetainedTypes.getElement(i)));
1019 DIArray Imports = CU.getImportedEntities();
1020 for (unsigned i = 0, e = Imports.getNumElements(); i != e; ++i) {
1021 DIImportedEntity Import = DIImportedEntity(Imports.getElement(i));
1022 DIDescriptor Entity = Import.getEntity().resolve(TypeIdentifierMap);
1023 if (Entity.isType())
1024 processType(DIType(Entity));
1025 else if (Entity.isSubprogram())
1026 processSubprogram(DISubprogram(Entity));
1027 else if (Entity.isNameSpace())
1028 processScope(DINameSpace(Entity).getContext());
1034 void DebugInfoFinder::processLocation(const Module &M, DILocation Loc) {
1037 InitializeTypeMap(M);
1038 processScope(Loc.getScope());
1039 processLocation(M, Loc.getOrigLocation());
1042 void DebugInfoFinder::processType(DIType DT) {
1045 processScope(DT.getContext().resolve(TypeIdentifierMap));
1046 if (DT.isCompositeType()) {
1047 DICompositeType DCT(DT);
1048 processType(DCT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
1049 if (DT.isSubroutineType()) {
1050 DITypeArray DTA = DISubroutineType(DT).getTypeArray();
1051 for (unsigned i = 0, e = DTA.getNumElements(); i != e; ++i)
1052 processType(DTA.getElement(i).resolve(TypeIdentifierMap));
1055 DIArray DA = DCT.getElements();
1056 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1057 DIDescriptor D = DA.getElement(i);
1059 processType(DIType(D));
1060 else if (D.isSubprogram())
1061 processSubprogram(DISubprogram(D));
1063 } else if (DT.isDerivedType()) {
1064 DIDerivedType DDT(DT);
1065 processType(DDT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
1069 void DebugInfoFinder::processScope(DIScope Scope) {
1070 if (Scope.isType()) {
1075 if (Scope.isCompileUnit()) {
1076 addCompileUnit(DICompileUnit(Scope));
1079 if (Scope.isSubprogram()) {
1080 processSubprogram(DISubprogram(Scope));
1083 if (!addScope(Scope))
1085 if (Scope.isLexicalBlock()) {
1086 DILexicalBlock LB(Scope);
1087 processScope(LB.getContext());
1088 } else if (Scope.isLexicalBlockFile()) {
1089 DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
1090 processScope(LBF.getScope());
1091 } else if (Scope.isNameSpace()) {
1092 DINameSpace NS(Scope);
1093 processScope(NS.getContext());
1097 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1098 if (!addSubprogram(SP))
1100 processScope(SP.getContext().resolve(TypeIdentifierMap));
1101 processType(SP.getType());
1102 DIArray TParams = SP.getTemplateParams();
1103 for (unsigned I = 0, E = TParams.getNumElements(); I != E; ++I) {
1104 DIDescriptor Element = TParams.getElement(I);
1105 if (Element.isTemplateTypeParameter()) {
1106 DITemplateTypeParameter TType(Element);
1107 processScope(TType.getContext().resolve(TypeIdentifierMap));
1108 processType(TType.getType().resolve(TypeIdentifierMap));
1109 } else if (Element.isTemplateValueParameter()) {
1110 DITemplateValueParameter TVal(Element);
1111 processScope(TVal.getContext().resolve(TypeIdentifierMap));
1112 processType(TVal.getType().resolve(TypeIdentifierMap));
1117 void DebugInfoFinder::processDeclare(const Module &M,
1118 const DbgDeclareInst *DDI) {
1119 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1122 InitializeTypeMap(M);
1125 if (!DV.isVariable())
1128 if (!NodesSeen.insert(DV))
1130 processScope(DIVariable(N).getContext());
1131 processType(DIVariable(N).getType().resolve(TypeIdentifierMap));
1134 void DebugInfoFinder::processValue(const Module &M, const DbgValueInst *DVI) {
1135 MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
1138 InitializeTypeMap(M);
1141 if (!DV.isVariable())
1144 if (!NodesSeen.insert(DV))
1146 processScope(DIVariable(N).getContext());
1147 processType(DIVariable(N).getType().resolve(TypeIdentifierMap));
1150 bool DebugInfoFinder::addType(DIType DT) {
1154 if (!NodesSeen.insert(DT))
1161 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1164 if (!NodesSeen.insert(CU))
1171 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1175 if (!NodesSeen.insert(DIG))
1182 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1186 if (!NodesSeen.insert(SP))
1193 bool DebugInfoFinder::addScope(DIScope Scope) {
1196 // FIXME: Ocaml binding generates a scope with no content, we treat it
1198 if (Scope->getNumOperands() == 0)
1200 if (!NodesSeen.insert(Scope))
1202 Scopes.push_back(Scope);
1206 //===----------------------------------------------------------------------===//
1207 // DIDescriptor: dump routines for all descriptors.
1208 //===----------------------------------------------------------------------===//
1210 void DIDescriptor::dump() const {
1215 void DIDescriptor::print(raw_ostream &OS) const {
1219 if (const char *Tag = dwarf::TagString(getTag()))
1220 OS << "[ " << Tag << " ]";
1222 if (this->isSubrange()) {
1223 DISubrange(DbgNode).printInternal(OS);
1224 } else if (this->isCompileUnit()) {
1225 DICompileUnit(DbgNode).printInternal(OS);
1226 } else if (this->isFile()) {
1227 DIFile(DbgNode).printInternal(OS);
1228 } else if (this->isEnumerator()) {
1229 DIEnumerator(DbgNode).printInternal(OS);
1230 } else if (this->isBasicType()) {
1231 DIType(DbgNode).printInternal(OS);
1232 } else if (this->isDerivedType()) {
1233 DIDerivedType(DbgNode).printInternal(OS);
1234 } else if (this->isCompositeType()) {
1235 DICompositeType(DbgNode).printInternal(OS);
1236 } else if (this->isSubprogram()) {
1237 DISubprogram(DbgNode).printInternal(OS);
1238 } else if (this->isGlobalVariable()) {
1239 DIGlobalVariable(DbgNode).printInternal(OS);
1240 } else if (this->isVariable()) {
1241 DIVariable(DbgNode).printInternal(OS);
1242 } else if (this->isObjCProperty()) {
1243 DIObjCProperty(DbgNode).printInternal(OS);
1244 } else if (this->isNameSpace()) {
1245 DINameSpace(DbgNode).printInternal(OS);
1246 } else if (this->isScope()) {
1247 DIScope(DbgNode).printInternal(OS);
1248 } else if (this->isExpression()) {
1249 DIExpression(DbgNode).printInternal(OS);
1253 void DISubrange::printInternal(raw_ostream &OS) const {
1254 int64_t Count = getCount();
1256 OS << " [" << getLo() << ", " << Count - 1 << ']';
1258 OS << " [unbounded]";
1261 void DIScope::printInternal(raw_ostream &OS) const {
1262 OS << " [" << getDirectory() << "/" << getFilename() << ']';
1265 void DICompileUnit::printInternal(raw_ostream &OS) const {
1266 DIScope::printInternal(OS);
1268 unsigned Lang = getLanguage();
1269 if (const char *LangStr = dwarf::LanguageString(Lang))
1272 (OS << "lang 0x").write_hex(Lang);
1276 void DIEnumerator::printInternal(raw_ostream &OS) const {
1277 OS << " [" << getName() << " :: " << getEnumValue() << ']';
1280 void DIType::printInternal(raw_ostream &OS) const {
1284 StringRef Res = getName();
1286 OS << " [" << Res << "]";
1288 // TODO: Print context?
1290 OS << " [line " << getLineNumber() << ", size " << getSizeInBits()
1291 << ", align " << getAlignInBits() << ", offset " << getOffsetInBits();
1293 if (const char *Enc =
1294 dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1295 OS << ", enc " << Enc;
1300 else if (isProtected())
1301 OS << " [protected]";
1302 else if (isPublic())
1306 OS << " [artificial]";
1308 if (isForwardDecl())
1310 else if (getTag() == dwarf::DW_TAG_structure_type ||
1311 getTag() == dwarf::DW_TAG_union_type ||
1312 getTag() == dwarf::DW_TAG_enumeration_type ||
1313 getTag() == dwarf::DW_TAG_class_type)
1317 if (isStaticMember())
1320 if (isLValueReference())
1321 OS << " [reference]";
1323 if (isRValueReference())
1324 OS << " [rvalue reference]";
1327 void DIDerivedType::printInternal(raw_ostream &OS) const {
1328 DIType::printInternal(OS);
1329 OS << " [from " << getTypeDerivedFrom().getName() << ']';
1332 void DICompositeType::printInternal(raw_ostream &OS) const {
1333 DIType::printInternal(OS);
1334 DIArray A = getElements();
1335 OS << " [" << A.getNumElements() << " elements]";
1338 void DINameSpace::printInternal(raw_ostream &OS) const {
1339 StringRef Name = getName();
1341 OS << " [" << Name << ']';
1343 OS << " [line " << getLineNumber() << ']';
1346 void DISubprogram::printInternal(raw_ostream &OS) const {
1347 // TODO : Print context
1348 OS << " [line " << getLineNumber() << ']';
1350 if (isLocalToUnit())
1356 if (getScopeLineNumber() != getLineNumber())
1357 OS << " [scope " << getScopeLineNumber() << "]";
1361 else if (isProtected())
1362 OS << " [protected]";
1363 else if (isPublic())
1366 if (isLValueReference())
1367 OS << " [reference]";
1369 if (isRValueReference())
1370 OS << " [rvalue reference]";
1372 StringRef Res = getName();
1374 OS << " [" << Res << ']';
1377 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1378 StringRef Res = getName();
1380 OS << " [" << Res << ']';
1382 OS << " [line " << getLineNumber() << ']';
1384 // TODO : Print context
1386 if (isLocalToUnit())
1393 void DIVariable::printInternal(raw_ostream &OS) const {
1394 StringRef Res = getName();
1396 OS << " [" << Res << ']';
1398 OS << " [line " << getLineNumber() << ']';
1401 void DIExpression::printInternal(raw_ostream &OS) const {
1402 for (unsigned I = 0; I < getNumElements(); ++I) {
1403 uint64_t OpCode = getElement(I);
1404 OS << " [" << OperationEncodingString(OpCode);
1407 OS << " " << getElement(++I);
1411 unsigned Offset = getElement(++I);
1412 unsigned Size = getElement(++I);
1413 OS << " offset=" << Offset << ", size=" << Size;
1417 // Else bail out early. This may be a line table entry.
1425 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1426 StringRef Name = getObjCPropertyName();
1428 OS << " [" << Name << ']';
1430 OS << " [line " << getLineNumber() << ", properties " << getUnsignedField(6)
1434 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1435 const LLVMContext &Ctx) {
1436 if (!DL.isUnknown()) { // Print source line info.
1437 DIScope Scope(DL.getScope(Ctx));
1438 assert(Scope.isScope() && "Scope of a DebugLoc should be a DIScope.");
1439 // Omit the directory, because it's likely to be long and uninteresting.
1440 CommentOS << Scope.getFilename();
1441 CommentOS << ':' << DL.getLine();
1442 if (DL.getCol() != 0)
1443 CommentOS << ':' << DL.getCol();
1444 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1445 if (!InlinedAtDL.isUnknown()) {
1446 CommentOS << " @[ ";
1447 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1453 void DIVariable::printExtendedName(raw_ostream &OS) const {
1454 const LLVMContext &Ctx = DbgNode->getContext();
1455 StringRef Res = getName();
1457 OS << Res << "," << getLineNumber();
1458 if (MDNode *InlinedAt = getInlinedAt()) {
1459 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1460 if (!InlinedAtDL.isUnknown()) {
1462 printDebugLoc(InlinedAtDL, OS, Ctx);
1468 template <> DIRef<DIScope>::DIRef(const Value *V) : Val(V) {
1469 assert(isScopeRef(V) && "DIScopeRef should be a MDString or MDNode");
1471 template <> DIRef<DIType>::DIRef(const Value *V) : Val(V) {
1472 assert(isTypeRef(V) && "DITypeRef should be a MDString or MDNode");
1476 DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const {
1477 return DIScopeRef(getField(DbgNode, Elt));
1479 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const {
1480 return DITypeRef(getField(DbgNode, Elt));
1483 bool llvm::StripDebugInfo(Module &M) {
1484 bool Changed = false;
1486 // Remove all of the calls to the debugger intrinsics, and remove them from
1488 if (Function *Declare = M.getFunction("llvm.dbg.declare")) {
1489 while (!Declare->use_empty()) {
1490 CallInst *CI = cast<CallInst>(Declare->user_back());
1491 CI->eraseFromParent();
1493 Declare->eraseFromParent();
1497 if (Function *DbgVal = M.getFunction("llvm.dbg.value")) {
1498 while (!DbgVal->use_empty()) {
1499 CallInst *CI = cast<CallInst>(DbgVal->user_back());
1500 CI->eraseFromParent();
1502 DbgVal->eraseFromParent();
1506 for (Module::named_metadata_iterator NMI = M.named_metadata_begin(),
1507 NME = M.named_metadata_end(); NMI != NME;) {
1508 NamedMDNode *NMD = NMI;
1510 if (NMD->getName().startswith("llvm.dbg.")) {
1511 NMD->eraseFromParent();
1516 for (Module::iterator MI = M.begin(), ME = M.end(); MI != ME; ++MI)
1517 for (Function::iterator FI = MI->begin(), FE = MI->end(); FI != FE;
1519 for (BasicBlock::iterator BI = FI->begin(), BE = FI->end(); BI != BE;
1521 if (!BI->getDebugLoc().isUnknown()) {
1523 BI->setDebugLoc(DebugLoc());
1530 unsigned llvm::getDebugMetadataVersionFromModule(const Module &M) {
1531 Value *Val = M.getModuleFlag("Debug Info Version");
1534 return cast<ConstantInt>(Val)->getZExtValue();
1537 llvm::DenseMap<const llvm::Function *, llvm::DISubprogram>
1538 llvm::makeSubprogramMap(const Module &M) {
1539 DenseMap<const Function *, DISubprogram> R;
1541 NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu");
1545 for (MDNode *N : CU_Nodes->operands()) {
1546 DICompileUnit CUNode(N);
1547 DIArray SPs = CUNode.getSubprograms();
1548 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
1549 DISubprogram SP(SPs.getElement(i));
1550 if (Function *F = SP.getFunction())
1551 R.insert(std::make_pair(F, SP));