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/ADT/StringSwitch.h"
21 #include "llvm/Analysis/ValueTracking.h"
22 #include "llvm/IR/Constants.h"
23 #include "llvm/IR/DIBuilder.h"
24 #include "llvm/IR/DerivedTypes.h"
25 #include "llvm/IR/Instructions.h"
26 #include "llvm/IR/IntrinsicInst.h"
27 #include "llvm/IR/Intrinsics.h"
28 #include "llvm/IR/Module.h"
29 #include "llvm/IR/ValueHandle.h"
30 #include "llvm/Support/Debug.h"
31 #include "llvm/Support/Dwarf.h"
32 #include "llvm/Support/raw_ostream.h"
34 using namespace llvm::dwarf;
36 //===----------------------------------------------------------------------===//
38 //===----------------------------------------------------------------------===//
40 unsigned DIDescriptor::getFlag(StringRef Flag) {
41 return StringSwitch<unsigned>(Flag)
42 #define HANDLE_DI_FLAG(ID, NAME) .Case("DIFlag" #NAME, Flag##NAME)
43 #include "llvm/IR/DebugInfoFlags.def"
47 const char *DIDescriptor::getFlagString(unsigned Flag) {
51 #define HANDLE_DI_FLAG(ID, NAME) \
53 return "DIFlag" #NAME;
54 #include "llvm/IR/DebugInfoFlags.def"
58 unsigned DIDescriptor::splitFlags(unsigned Flags,
59 SmallVectorImpl<unsigned> &SplitFlags) {
60 // Accessibility flags need to be specially handled, since they're packed
62 if (unsigned A = Flags & FlagAccessibility) {
64 SplitFlags.push_back(FlagPrivate);
65 else if (A == FlagProtected)
66 SplitFlags.push_back(FlagProtected);
68 SplitFlags.push_back(FlagPublic);
72 #define HANDLE_DI_FLAG(ID, NAME) \
73 if (unsigned Bit = Flags & ID) { \
74 SplitFlags.push_back(Bit); \
77 #include "llvm/IR/DebugInfoFlags.def"
82 bool DIDescriptor::Verify() const {
84 (DIDerivedType(DbgNode).Verify() ||
85 DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
86 DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
87 DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
88 DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
89 DILexicalBlock(DbgNode).Verify() ||
90 DILexicalBlockFile(DbgNode).Verify() ||
91 DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
92 DIObjCProperty(DbgNode).Verify() ||
93 DITemplateTypeParameter(DbgNode).Verify() ||
94 DITemplateValueParameter(DbgNode).Verify() ||
95 DIImportedEntity(DbgNode).Verify());
98 static Metadata *getField(const MDNode *DbgNode, unsigned Elt) {
99 if (!DbgNode || Elt >= DbgNode->getNumOperands())
101 return DbgNode->getOperand(Elt);
104 static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
105 return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
108 static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
109 if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
110 return MDS->getString();
114 StringRef DIDescriptor::getStringField(unsigned Elt) const {
115 return ::getStringField(DbgNode, Elt);
118 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
119 if (auto *C = getConstantField(Elt))
120 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
121 return CI->getZExtValue();
126 int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
127 if (auto *C = getConstantField(Elt))
128 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
129 return CI->getZExtValue();
134 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
135 MDNode *Field = getNodeField(DbgNode, Elt);
136 return DIDescriptor(Field);
139 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
140 return dyn_cast_or_null<GlobalVariable>(getConstantField(Elt));
143 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
147 if (Elt < DbgNode->getNumOperands())
149 dyn_cast_or_null<ConstantAsMetadata>(DbgNode->getOperand(Elt)))
150 return C->getValue();
154 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
155 return dyn_cast_or_null<Function>(getConstantField(Elt));
158 /// \brief Return the size reported by the variable's type.
159 unsigned DIVariable::getSizeInBits(const DITypeIdentifierMap &Map) {
160 DIType Ty = getType().resolve(Map);
161 // Follow derived types until we reach a type that
162 // reports back a size.
163 while (Ty.isDerivedType() && !Ty.getSizeInBits()) {
164 DIDerivedType DT(&*Ty);
165 Ty = DT.getTypeDerivedFrom().resolve(Map);
167 assert(Ty.getSizeInBits() && "type with size 0");
168 return Ty.getSizeInBits();
171 bool DIExpression::isBitPiece() const {
172 unsigned N = getNumElements();
173 return N >=3 && getElement(N-3) == dwarf::DW_OP_bit_piece;
176 uint64_t DIExpression::getBitPieceOffset() const {
177 assert(isBitPiece() && "not a piece");
178 return getElement(getNumElements()-2);
181 uint64_t DIExpression::getBitPieceSize() const {
182 assert(isBitPiece() && "not a piece");
183 return getElement(getNumElements()-1);
186 DIExpression::iterator DIExpression::Operand::getNext() const {
191 //===----------------------------------------------------------------------===//
192 // Simple Descriptor Constructors and other Methods
193 //===----------------------------------------------------------------------===//
195 void DIDescriptor::replaceAllUsesWith(LLVMContext &, DIDescriptor D) {
196 assert(DbgNode && "Trying to replace an unverified type!");
197 assert(DbgNode->isTemporary() && "Expected temporary node");
198 TempMDNode Temp(get());
200 // Since we use a TrackingVH for the node, its easy for clients to manufacture
201 // legitimate situations where they want to replaceAllUsesWith() on something
202 // which, due to uniquing, has merged with the source. We shield clients from
203 // this detail by allowing a value to be replaced with replaceAllUsesWith()
205 if (Temp.get() == D.get()) {
206 DbgNode = MDNode::replaceWithUniqued(std::move(Temp));
210 Temp->replaceAllUsesWith(D.get());
214 void DIDescriptor::replaceAllUsesWith(MDNode *D) {
215 assert(DbgNode && "Trying to replace an unverified type!");
216 assert(DbgNode != D && "This replacement should always happen");
217 assert(DbgNode->isTemporary() && "Expected temporary node");
218 TempMDNode Node(get());
219 Node->replaceAllUsesWith(D);
222 bool DICompileUnit::Verify() const {
223 if (!isCompileUnit())
226 // Don't bother verifying the compilation directory or producer string
227 // as those could be empty.
228 return !getFilename().empty();
231 bool DIObjCProperty::Verify() const { return isObjCProperty(); }
233 /// \brief Check if a value can be a reference to a type.
234 static bool isTypeRef(const Metadata *MD) {
237 if (auto *S = dyn_cast<MDString>(MD))
238 return !S->getString().empty();
239 return isa<MDType>(MD);
242 /// \brief Check if a value can be a ScopeRef.
243 static bool isScopeRef(const Metadata *MD) {
246 if (auto *S = dyn_cast<MDString>(MD))
247 return !S->getString().empty();
248 return isa<MDScope>(MD);
252 /// \brief Check if a value can be a DescriptorRef.
253 static bool isDescriptorRef(const Metadata *MD) {
256 if (auto *S = dyn_cast<MDString>(MD))
257 return !S->getString().empty();
258 return isa<MDNode>(MD);
262 bool DIType::Verify() const {
263 auto *N = dyn_cast_or_null<MDType>(DbgNode);
266 if (!isScopeRef(N->getScope()))
269 // DIType is abstract, it should be a BasicType, a DerivedType or
272 return DIBasicType(DbgNode).Verify();
274 // FIXME: Sink this into the various subclass verifies.
275 if (getFilename().empty()) {
276 // Check whether the filename is allowed to be empty.
277 uint16_t Tag = getTag();
278 if (Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
279 Tag != dwarf::DW_TAG_pointer_type &&
280 Tag != dwarf::DW_TAG_ptr_to_member_type &&
281 Tag != dwarf::DW_TAG_reference_type &&
282 Tag != dwarf::DW_TAG_rvalue_reference_type &&
283 Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
284 Tag != dwarf::DW_TAG_enumeration_type &&
285 Tag != dwarf::DW_TAG_subroutine_type &&
286 Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
287 Tag != dwarf::DW_TAG_structure_type && Tag != dwarf::DW_TAG_member &&
288 Tag != dwarf::DW_TAG_typedef)
292 if (isCompositeType())
293 return DICompositeType(DbgNode).Verify();
295 return DIDerivedType(DbgNode).Verify();
299 bool DIBasicType::Verify() const {
300 return dyn_cast_or_null<MDBasicType>(DbgNode);
303 bool DIDerivedType::Verify() const {
304 auto *N = dyn_cast_or_null<MDDerivedTypeBase>(DbgNode);
307 if (getTag() == dwarf::DW_TAG_ptr_to_member_type) {
308 auto *D = dyn_cast<MDDerivedType>(N);
311 if (!isTypeRef(D->getExtraData()))
314 return isTypeRef(N->getBaseType());
317 bool DICompositeType::Verify() const {
318 auto *N = dyn_cast_or_null<MDCompositeTypeBase>(DbgNode);
319 return N && isTypeRef(N->getBaseType()) && isTypeRef(N->getVTableHolder()) &&
320 !(isLValueReference() && isRValueReference());
323 bool DISubprogram::Verify() const {
324 auto *N = dyn_cast_or_null<MDSubprogram>(DbgNode);
328 if (!isScopeRef(N->getScope()))
331 if (auto *Op = N->getType())
332 if (!isa<MDNode>(Op))
335 if (!isTypeRef(getContainingType()))
338 if (isLValueReference() && isRValueReference())
341 // If a DISubprogram has an llvm::Function*, then scope chains from all
342 // instructions within the function should lead to this DISubprogram.
343 if (auto *F = getFunction()) {
344 for (auto &BB : *F) {
347 cast_or_null<MDLocation>(I.getDebugLoc().getAsMDNode());
351 // walk the inlined-at scopes
352 MDScope *Scope = DL->getInlinedAtScope();
355 while (!isa<MDSubprogram>(Scope)) {
356 Scope = cast<MDLexicalBlockBase>(Scope)->getScope();
360 if (!DISubprogram(Scope).describes(F))
369 bool DIGlobalVariable::Verify() const {
370 auto *N = dyn_cast_or_null<MDGlobalVariable>(DbgNode);
375 if (N->getDisplayName().empty())
378 if (auto *Op = N->getScope())
379 if (!isa<MDNode>(Op))
382 if (auto *Op = N->getStaticDataMemberDeclaration())
383 if (!isa<MDNode>(Op))
386 return isTypeRef(N->getType());
389 bool DIVariable::Verify() const {
390 auto *N = dyn_cast_or_null<MDLocalVariable>(DbgNode);
395 if (auto *Op = N->getScope())
396 if (!isa<MDNode>(Op))
399 return isTypeRef(N->getType());
402 bool DILocation::Verify() const {
403 return dyn_cast_or_null<MDLocation>(DbgNode);
405 bool DINameSpace::Verify() const {
406 return dyn_cast_or_null<MDNamespace>(DbgNode);
408 bool DIFile::Verify() const { return dyn_cast_or_null<MDFile>(DbgNode); }
409 bool DIEnumerator::Verify() const {
410 return dyn_cast_or_null<MDEnumerator>(DbgNode);
412 bool DISubrange::Verify() const {
413 return dyn_cast_or_null<MDSubrange>(DbgNode);
415 bool DILexicalBlock::Verify() const {
416 return dyn_cast_or_null<MDLexicalBlock>(DbgNode);
418 bool DILexicalBlockFile::Verify() const {
419 return dyn_cast_or_null<MDLexicalBlockFile>(DbgNode);
421 bool DITemplateTypeParameter::Verify() const {
422 return dyn_cast_or_null<MDTemplateTypeParameter>(DbgNode);
424 bool DITemplateValueParameter::Verify() const {
425 return dyn_cast_or_null<MDTemplateValueParameter>(DbgNode);
427 bool DIImportedEntity::Verify() const {
428 return dyn_cast_or_null<MDImportedEntity>(DbgNode);
431 void DICompositeType::setArraysHelper(MDNode *Elements, MDNode *TParams) {
432 TypedTrackingMDRef<MDCompositeTypeBase> N(get());
434 N->replaceElements(cast<MDTuple>(Elements));
436 N->replaceTemplateParams(cast<MDTuple>(TParams));
440 DIScopeRef DIScope::getRef() const {
441 if (!isCompositeType())
442 return DIScopeRef(*this);
443 DICompositeType DTy(DbgNode);
444 if (!DTy.getIdentifier())
445 return DIScopeRef(*this);
446 return DIScopeRef(DTy.getIdentifier());
449 void DICompositeType::setContainingType(DICompositeType ContainingType) {
450 TypedTrackingMDRef<MDCompositeTypeBase> N(get());
451 N->replaceVTableHolder(ContainingType.getRef());
455 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
456 assert(CurFn && "Invalid function");
457 if (!getContext().isSubprogram())
459 // This variable is not inlined function argument if its scope
460 // does not describe current function.
461 return !DISubprogram(getContext()).describes(CurFn);
464 Function *DISubprogram::getFunction() const {
466 if (auto *C = dyn_cast_or_null<ConstantAsMetadata>(N->getFunction()))
467 return dyn_cast<Function>(C->getValue());
471 bool DISubprogram::describes(const Function *F) {
472 assert(F && "Invalid function");
473 if (F == getFunction())
475 StringRef Name = getLinkageName();
478 if (F->getName() == Name)
483 GlobalVariable *DIGlobalVariable::getGlobal() const {
484 return dyn_cast_or_null<GlobalVariable>(getConstant());
487 DIScopeRef DIScope::getContext() const {
490 return DIType(DbgNode).getContext();
493 return DIScopeRef(DISubprogram(DbgNode).getContext());
495 if (isLexicalBlock())
496 return DIScopeRef(DILexicalBlock(DbgNode).getContext());
498 if (isLexicalBlockFile())
499 return DIScopeRef(DILexicalBlockFile(DbgNode).getContext());
502 return DIScopeRef(DINameSpace(DbgNode).getContext());
504 assert((isFile() || isCompileUnit()) && "Unhandled type of scope.");
505 return DIScopeRef(nullptr);
508 StringRef DIScope::getName() const {
510 return DIType(DbgNode).getName();
512 return DISubprogram(DbgNode).getName();
514 return DINameSpace(DbgNode).getName();
515 assert((isLexicalBlock() || isLexicalBlockFile() || isFile() ||
517 "Unhandled type of scope.");
521 StringRef DIScope::getFilename() const {
523 return ::getStringField(dyn_cast_or_null<MDNode>(N->getFile()), 0);
527 StringRef DIScope::getDirectory() const {
529 return ::getStringField(dyn_cast_or_null<MDNode>(N->getFile()), 1);
533 void DICompileUnit::replaceSubprograms(DIArray Subprograms) {
534 assert(Verify() && "Expected compile unit");
535 get()->replaceSubprograms(cast_or_null<MDTuple>(Subprograms.get()));
538 void DICompileUnit::replaceGlobalVariables(DIArray GlobalVariables) {
539 assert(Verify() && "Expected compile unit");
540 get()->replaceGlobalVariables(cast_or_null<MDTuple>(GlobalVariables.get()));
543 DILocation DILocation::copyWithNewScope(LLVMContext &Ctx,
544 DILexicalBlockFile NewScope) {
546 assert(NewScope && "Expected valid scope");
548 const auto *Old = cast<MDLocation>(DbgNode);
549 return DILocation(MDLocation::get(Ctx, Old->getLine(), Old->getColumn(),
550 NewScope, Old->getInlinedAt()));
553 unsigned DILocation::computeNewDiscriminator(LLVMContext &Ctx) {
554 std::pair<const char *, unsigned> Key(getFilename().data(), getLineNumber());
555 return ++Ctx.pImpl->DiscriminatorTable[Key];
558 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
559 LLVMContext &VMContext) {
560 assert(DIVariable(DV).Verify() && "Expected a DIVariable");
561 return cast<MDLocalVariable>(DV)
562 ->withInline(cast_or_null<MDLocation>(InlinedScope));
565 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
566 assert(DIVariable(DV).Verify() && "Expected a DIVariable");
567 return cast<MDLocalVariable>(DV)->withoutInline();
570 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
571 DIDescriptor D(Scope);
572 if (D.isSubprogram())
573 return DISubprogram(Scope);
575 if (D.isLexicalBlockFile())
576 return getDISubprogram(DILexicalBlockFile(Scope).getContext());
578 if (D.isLexicalBlock())
579 return getDISubprogram(DILexicalBlock(Scope).getContext());
581 return DISubprogram();
584 DISubprogram llvm::getDISubprogram(const Function *F) {
585 // We look for the first instr that has a debug annotation leading back to F.
586 for (auto &BB : *F) {
587 auto Inst = std::find_if(BB.begin(), BB.end(), [](const Instruction &Inst) {
588 return !Inst.getDebugLoc().isUnknown();
590 if (Inst == BB.end())
592 DebugLoc DLoc = Inst->getDebugLoc();
593 const MDNode *Scope = DLoc.getScopeNode();
594 DISubprogram Subprogram = getDISubprogram(Scope);
595 return Subprogram.describes(F) ? Subprogram : DISubprogram();
598 return DISubprogram();
601 DICompositeType llvm::getDICompositeType(DIType T) {
602 if (T.isCompositeType())
603 return DICompositeType(T);
605 if (T.isDerivedType()) {
606 // This function is currently used by dragonegg and dragonegg does
607 // not generate identifier for types, so using an empty map to resolve
608 // DerivedFrom should be fine.
609 DITypeIdentifierMap EmptyMap;
610 return getDICompositeType(
611 DIDerivedType(T).getTypeDerivedFrom().resolve(EmptyMap));
614 return DICompositeType();
618 llvm::generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes) {
619 DITypeIdentifierMap Map;
620 for (unsigned CUi = 0, CUe = CU_Nodes->getNumOperands(); CUi != CUe; ++CUi) {
621 DICompileUnit CU(CU_Nodes->getOperand(CUi));
622 DIArray Retain = CU.getRetainedTypes();
623 for (unsigned Ti = 0, Te = Retain.getNumElements(); Ti != Te; ++Ti) {
624 if (!Retain.getElement(Ti).isCompositeType())
626 DICompositeType Ty(Retain.getElement(Ti));
627 if (MDString *TypeId = Ty.getIdentifier()) {
628 // Definition has priority over declaration.
629 // Try to insert (TypeId, Ty) to Map.
630 std::pair<DITypeIdentifierMap::iterator, bool> P =
631 Map.insert(std::make_pair(TypeId, Ty));
632 // If TypeId already exists in Map and this is a definition, replace
633 // whatever we had (declaration or definition) with the definition.
634 if (!P.second && !Ty.isForwardDecl())
635 P.first->second = Ty;
642 //===----------------------------------------------------------------------===//
643 // DebugInfoFinder implementations.
644 //===----------------------------------------------------------------------===//
646 void DebugInfoFinder::reset() {
653 TypeIdentifierMap.clear();
654 TypeMapInitialized = false;
657 void DebugInfoFinder::InitializeTypeMap(const Module &M) {
658 if (!TypeMapInitialized)
659 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
660 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
661 TypeMapInitialized = true;
665 void DebugInfoFinder::processModule(const Module &M) {
666 InitializeTypeMap(M);
667 if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
668 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
669 DICompileUnit CU(CU_Nodes->getOperand(i));
671 DIArray GVs = CU.getGlobalVariables();
672 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
673 DIGlobalVariable DIG(GVs.getElement(i));
674 if (addGlobalVariable(DIG)) {
675 processScope(DIG.getContext());
676 processType(DIG.getType().resolve(TypeIdentifierMap));
679 DIArray SPs = CU.getSubprograms();
680 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
681 processSubprogram(DISubprogram(SPs.getElement(i)));
682 DIArray EnumTypes = CU.getEnumTypes();
683 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
684 processType(DIType(EnumTypes.getElement(i)));
685 DIArray RetainedTypes = CU.getRetainedTypes();
686 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
687 processType(DIType(RetainedTypes.getElement(i)));
688 DIArray Imports = CU.getImportedEntities();
689 for (unsigned i = 0, e = Imports.getNumElements(); i != e; ++i) {
690 DIImportedEntity Import = DIImportedEntity(Imports.getElement(i));
693 DIDescriptor Entity = Import.getEntity().resolve(TypeIdentifierMap);
695 processType(DIType(Entity));
696 else if (Entity.isSubprogram())
697 processSubprogram(DISubprogram(Entity));
698 else if (Entity.isNameSpace())
699 processScope(DINameSpace(Entity).getContext());
705 void DebugInfoFinder::processLocation(const Module &M, DILocation Loc) {
708 InitializeTypeMap(M);
709 processScope(Loc.getScope());
710 processLocation(M, Loc.getOrigLocation());
713 void DebugInfoFinder::processType(DIType DT) {
716 processScope(DT.getContext().resolve(TypeIdentifierMap));
717 if (DT.isCompositeType()) {
718 DICompositeType DCT(DT);
719 processType(DCT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
720 if (DT.isSubroutineType()) {
721 DITypeArray DTA = DISubroutineType(DT).getTypeArray();
722 for (unsigned i = 0, e = DTA.getNumElements(); i != e; ++i)
723 processType(DTA.getElement(i).resolve(TypeIdentifierMap));
726 DIArray DA = DCT.getElements();
727 for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
728 DIDescriptor D = DA.getElement(i);
730 processType(DIType(D));
731 else if (D.isSubprogram())
732 processSubprogram(DISubprogram(D));
734 } else if (DT.isDerivedType()) {
735 DIDerivedType DDT(DT);
736 processType(DDT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
740 void DebugInfoFinder::processScope(DIScope Scope) {
741 if (Scope.isType()) {
746 if (Scope.isCompileUnit()) {
747 addCompileUnit(DICompileUnit(Scope));
750 if (Scope.isSubprogram()) {
751 processSubprogram(DISubprogram(Scope));
754 if (!addScope(Scope))
756 if (Scope.isLexicalBlock()) {
757 DILexicalBlock LB(Scope);
758 processScope(LB.getContext());
759 } else if (Scope.isLexicalBlockFile()) {
760 DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
761 processScope(LBF.getScope());
762 } else if (Scope.isNameSpace()) {
763 DINameSpace NS(Scope);
764 processScope(NS.getContext());
768 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
769 if (!addSubprogram(SP))
771 processScope(SP.getContext().resolve(TypeIdentifierMap));
772 processType(SP.getType());
773 DIArray TParams = SP.getTemplateParams();
774 for (unsigned I = 0, E = TParams.getNumElements(); I != E; ++I) {
775 DIDescriptor Element = TParams.getElement(I);
776 if (Element.isTemplateTypeParameter()) {
777 DITemplateTypeParameter TType(Element);
778 processType(TType.getType().resolve(TypeIdentifierMap));
779 } else if (Element.isTemplateValueParameter()) {
780 DITemplateValueParameter TVal(Element);
781 processType(TVal.getType().resolve(TypeIdentifierMap));
786 void DebugInfoFinder::processDeclare(const Module &M,
787 const DbgDeclareInst *DDI) {
788 MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
791 InitializeTypeMap(M);
794 if (!DV.isVariable())
797 if (!NodesSeen.insert(DV).second)
799 processScope(DIVariable(N).getContext());
800 processType(DIVariable(N).getType().resolve(TypeIdentifierMap));
803 void DebugInfoFinder::processValue(const Module &M, const DbgValueInst *DVI) {
804 MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
807 InitializeTypeMap(M);
810 if (!DV.isVariable())
813 if (!NodesSeen.insert(DV).second)
815 processScope(DIVariable(N).getContext());
816 processType(DIVariable(N).getType().resolve(TypeIdentifierMap));
819 bool DebugInfoFinder::addType(DIType DT) {
823 if (!NodesSeen.insert(DT).second)
830 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
833 if (!NodesSeen.insert(CU).second)
840 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
844 if (!NodesSeen.insert(DIG).second)
851 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
855 if (!NodesSeen.insert(SP).second)
862 bool DebugInfoFinder::addScope(DIScope Scope) {
865 // FIXME: Ocaml binding generates a scope with no content, we treat it
867 if (Scope->getNumOperands() == 0)
869 if (!NodesSeen.insert(Scope).second)
871 Scopes.push_back(Scope);
875 //===----------------------------------------------------------------------===//
876 // DIDescriptor: dump routines for all descriptors.
877 //===----------------------------------------------------------------------===//
879 void DIDescriptor::dump() const {
884 void DIDescriptor::print(raw_ostream &OS) const {
890 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
891 const LLVMContext &Ctx) {
895 DIScope Scope(DL.getScope(Ctx));
896 assert(Scope.isScope() && "Scope of a DebugLoc should be a DIScope.");
897 // Omit the directory, because it's likely to be long and uninteresting.
898 CommentOS << Scope.getFilename();
899 CommentOS << ':' << DL.getLine();
900 if (DL.getCol() != 0)
901 CommentOS << ':' << DL.getCol();
903 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
904 if (InlinedAtDL.isUnknown())
908 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
912 void DIVariable::printExtendedName(raw_ostream &OS) const {
913 const LLVMContext &Ctx = DbgNode->getContext();
914 StringRef Res = getName();
916 OS << Res << "," << getLineNumber();
917 if (MDNode *InlinedAt = getInlinedAt()) {
918 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
919 if (!InlinedAtDL.isUnknown()) {
921 printDebugLoc(InlinedAtDL, OS, Ctx);
927 template <> DIRef<DIDescriptor>::DIRef(const Metadata *V) : Val(V) {
928 assert(isDescriptorRef(V) &&
929 "DIDescriptorRef should be a MDString or MDNode");
931 template <> DIRef<DIScope>::DIRef(const Metadata *V) : Val(V) {
932 assert(isScopeRef(V) && "DIScopeRef should be a MDString or MDNode");
934 template <> DIRef<DIType>::DIRef(const Metadata *V) : Val(V) {
935 assert(isTypeRef(V) && "DITypeRef should be a MDString or MDNode");
939 DIDescriptorRef DIDescriptor::getFieldAs<DIDescriptorRef>(unsigned Elt) const {
940 return DIDescriptorRef(cast_or_null<Metadata>(getField(DbgNode, Elt)));
943 DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const {
944 return DIScopeRef(cast_or_null<Metadata>(getField(DbgNode, Elt)));
946 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const {
947 return DITypeRef(cast_or_null<Metadata>(getField(DbgNode, Elt)));
950 bool llvm::StripDebugInfo(Module &M) {
951 bool Changed = false;
953 // Remove all of the calls to the debugger intrinsics, and remove them from
955 if (Function *Declare = M.getFunction("llvm.dbg.declare")) {
956 while (!Declare->use_empty()) {
957 CallInst *CI = cast<CallInst>(Declare->user_back());
958 CI->eraseFromParent();
960 Declare->eraseFromParent();
964 if (Function *DbgVal = M.getFunction("llvm.dbg.value")) {
965 while (!DbgVal->use_empty()) {
966 CallInst *CI = cast<CallInst>(DbgVal->user_back());
967 CI->eraseFromParent();
969 DbgVal->eraseFromParent();
973 for (Module::named_metadata_iterator NMI = M.named_metadata_begin(),
974 NME = M.named_metadata_end(); NMI != NME;) {
975 NamedMDNode *NMD = NMI;
977 if (NMD->getName().startswith("llvm.dbg.")) {
978 NMD->eraseFromParent();
983 for (Module::iterator MI = M.begin(), ME = M.end(); MI != ME; ++MI)
984 for (Function::iterator FI = MI->begin(), FE = MI->end(); FI != FE;
986 for (BasicBlock::iterator BI = FI->begin(), BE = FI->end(); BI != BE;
988 if (!BI->getDebugLoc().isUnknown()) {
990 BI->setDebugLoc(DebugLoc());
997 unsigned llvm::getDebugMetadataVersionFromModule(const Module &M) {
998 if (auto *Val = mdconst::dyn_extract_or_null<ConstantInt>(
999 M.getModuleFlag("Debug Info Version")))
1000 return Val->getZExtValue();
1004 llvm::DenseMap<const llvm::Function *, llvm::DISubprogram>
1005 llvm::makeSubprogramMap(const Module &M) {
1006 DenseMap<const Function *, DISubprogram> R;
1008 NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu");
1012 for (MDNode *N : CU_Nodes->operands()) {
1013 DICompileUnit CUNode(N);
1014 DIArray SPs = CUNode.getSubprograms();
1015 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
1016 DISubprogram SP(SPs.getElement(i));
1017 if (Function *F = SP.getFunction())
1018 R.insert(std::make_pair(F, SP));