1 //===- DebugInfo.h - Debug Information Helpers ------------------*- C++ -*-===//
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 defines a bunch of datatypes that are useful for creating and
11 // walking debug info in LLVM IR form. They essentially provide wrappers around
12 // the information in the global variables that's needed when constructing the
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_IR_DEBUGINFO_H
18 #define LLVM_IR_DEBUGINFO_H
20 #include "llvm/ADT/SmallPtrSet.h"
21 #include "llvm/ADT/SmallVector.h"
22 #include "llvm/ADT/iterator_range.h"
23 #include "llvm/IR/DebugInfoMetadata.h"
24 #include "llvm/Support/Casting.h"
25 #include "llvm/Support/Dwarf.h"
26 #include "llvm/Support/ErrorHandling.h"
33 template <typename K, typename V, typename KeyInfoT, typename BucketT>
36 /// \brief Find subprogram that is enclosing this scope.
37 DISubprogram *getDISubprogram(const MDNode *Scope);
39 /// \brief Strip debug info in the module if it exists.
41 /// To do this, we remove all calls to the debugger intrinsics and any named
42 /// metadata for debugging. We also remove debug locations for instructions.
43 /// Return true if module is modified.
44 bool StripDebugInfo(Module &M);
45 bool stripDebugInfo(Function &F);
47 /// Downgrade the debug info in a module to contain only line table information.
49 /// In order to convert debug info to what -gline-tables-only would have
50 /// created, this does the following:
51 /// 1) Delete all debug intrinsics.
52 /// 2) Delete all non-CU named metadata debug info nodes.
53 /// 3) Create new DebugLocs for each instruction.
54 /// 4) Create a new CU debug info, and similarly for every metadata node
55 /// that's reachable from the CU debug info.
56 /// All debug type metadata nodes are unreachable and garbage collected.
57 bool stripNonLineTableDebugInfo(Module &M);
59 /// \brief Return Debug Info Metadata Version by checking module flags.
60 unsigned getDebugMetadataVersionFromModule(const Module &M);
62 /// \brief Utility to find all debug info in a module.
64 /// DebugInfoFinder tries to list all debug info MDNodes used in a module. To
65 /// list debug info MDNodes used by an instruction, DebugInfoFinder uses
66 /// processDeclare, processValue and processLocation to handle DbgDeclareInst,
67 /// DbgValueInst and DbgLoc attached to instructions. processModule will go
68 /// through all DICompileUnits in llvm.dbg.cu and list debug info MDNodes
70 class DebugInfoFinder {
72 /// \brief Process entire module and collect debug info anchors.
73 void processModule(const Module &M);
75 /// \brief Process DbgDeclareInst.
76 void processDeclare(const Module &M, const DbgDeclareInst *DDI);
77 /// \brief Process DbgValueInst.
78 void processValue(const Module &M, const DbgValueInst *DVI);
79 /// \brief Process debug info location.
80 void processLocation(const Module &M, const DILocation *Loc);
82 /// \brief Clear all lists.
86 void InitializeTypeMap(const Module &M);
88 void processType(DIType *DT);
89 void processSubprogram(DISubprogram *SP);
90 void processScope(DIScope *Scope);
91 bool addCompileUnit(DICompileUnit *CU);
92 bool addGlobalVariable(DIGlobalVariableExpression *DIG);
93 bool addSubprogram(DISubprogram *SP);
94 bool addType(DIType *DT);
95 bool addScope(DIScope *Scope);
98 typedef SmallVectorImpl<DICompileUnit *>::const_iterator
99 compile_unit_iterator;
100 typedef SmallVectorImpl<DISubprogram *>::const_iterator subprogram_iterator;
101 typedef SmallVectorImpl<DIGlobalVariableExpression *>::const_iterator
102 global_variable_expression_iterator;
103 typedef SmallVectorImpl<DIType *>::const_iterator type_iterator;
104 typedef SmallVectorImpl<DIScope *>::const_iterator scope_iterator;
106 iterator_range<compile_unit_iterator> compile_units() const {
107 return make_range(CUs.begin(), CUs.end());
110 iterator_range<subprogram_iterator> subprograms() const {
111 return make_range(SPs.begin(), SPs.end());
114 iterator_range<global_variable_expression_iterator> global_variables() const {
115 return make_range(GVs.begin(), GVs.end());
118 iterator_range<type_iterator> types() const {
119 return make_range(TYs.begin(), TYs.end());
122 iterator_range<scope_iterator> scopes() const {
123 return make_range(Scopes.begin(), Scopes.end());
126 unsigned compile_unit_count() const { return CUs.size(); }
127 unsigned global_variable_count() const { return GVs.size(); }
128 unsigned subprogram_count() const { return SPs.size(); }
129 unsigned type_count() const { return TYs.size(); }
130 unsigned scope_count() const { return Scopes.size(); }
133 SmallVector<DICompileUnit *, 8> CUs;
134 SmallVector<DISubprogram *, 8> SPs;
135 SmallVector<DIGlobalVariableExpression *, 8> GVs;
136 SmallVector<DIType *, 8> TYs;
137 SmallVector<DIScope *, 8> Scopes;
138 SmallPtrSet<const MDNode *, 32> NodesSeen;
141 } // end namespace llvm