Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 1 | //===-- llvm/CodeGen/DwarfDebug.h - Dwarf Debug Framework ------*- C++ -*--===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file contains support for writing dwarf debug info into asm files. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
| 14 | #ifndef CODEGEN_ASMPRINTER_DWARFDEBUG_H__ |
| 15 | #define CODEGEN_ASMPRINTER_DWARFDEBUG_H__ |
| 16 | |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 17 | #include "llvm/CodeGen/AsmPrinter.h" |
Devang Patel | c3f5f78 | 2010-05-25 23:40:22 +0000 | [diff] [blame] | 18 | #include "llvm/CodeGen/MachineLocation.h" |
Chris Lattner | d2c4f19 | 2010-04-05 06:12:01 +0000 | [diff] [blame] | 19 | #include "DIE.h" |
Devang Patel | 622b026 | 2010-01-19 06:19:05 +0000 | [diff] [blame] | 20 | #include "llvm/ADT/DenseMap.h" |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 21 | #include "llvm/ADT/FoldingSet.h" |
Chris Lattner | 74e41f9 | 2010-04-05 05:24:55 +0000 | [diff] [blame] | 22 | #include "llvm/ADT/SmallPtrSet.h" |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 23 | #include "llvm/ADT/StringMap.h" |
| 24 | #include "llvm/ADT/UniqueVector.h" |
Chris Lattner | 74e41f9 | 2010-04-05 05:24:55 +0000 | [diff] [blame] | 25 | #include "llvm/Support/Allocator.h" |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 26 | |
| 27 | namespace llvm { |
| 28 | |
| 29 | class CompileUnit; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 30 | class DbgConcreteScope; |
Nick Lewycky | 381afae | 2009-11-17 09:17:08 +0000 | [diff] [blame] | 31 | class DbgScope; |
| 32 | class DbgVariable; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 33 | class MachineFrameInfo; |
| 34 | class MachineModuleInfo; |
Devang Patel | a43098d | 2010-04-28 01:03:09 +0000 | [diff] [blame] | 35 | class MachineOperand; |
Chris Lattner | af76e59 | 2009-08-22 20:48:53 +0000 | [diff] [blame] | 36 | class MCAsmInfo; |
Chris Lattner | 74e41f9 | 2010-04-05 05:24:55 +0000 | [diff] [blame] | 37 | class DIEAbbrev; |
| 38 | class DIE; |
| 39 | class DIEBlock; |
| 40 | class DIEEntry; |
| 41 | |
| 42 | class DIEnumerator; |
| 43 | class DIDescriptor; |
| 44 | class DIVariable; |
| 45 | class DIGlobal; |
| 46 | class DIGlobalVariable; |
| 47 | class DISubprogram; |
| 48 | class DIBasicType; |
| 49 | class DIDerivedType; |
| 50 | class DIType; |
| 51 | class DINameSpace; |
| 52 | class DISubrange; |
| 53 | class DICompositeType; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 54 | |
| 55 | //===----------------------------------------------------------------------===// |
| 56 | /// SrcLineInfo - This class is used to record source line correspondence. |
| 57 | /// |
Nick Lewycky | 381afae | 2009-11-17 09:17:08 +0000 | [diff] [blame] | 58 | class SrcLineInfo { |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 59 | unsigned Line; // Source line number. |
| 60 | unsigned Column; // Source column. |
| 61 | unsigned SourceID; // Source ID number. |
Chris Lattner | 25b68c6 | 2010-03-14 08:15:55 +0000 | [diff] [blame] | 62 | MCSymbol *Label; // Label in code ID number. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 63 | public: |
Chris Lattner | 25b68c6 | 2010-03-14 08:15:55 +0000 | [diff] [blame] | 64 | SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label) |
| 65 | : Line(L), Column(C), SourceID(S), Label(label) {} |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 66 | |
| 67 | // Accessors |
| 68 | unsigned getLine() const { return Line; } |
| 69 | unsigned getColumn() const { return Column; } |
| 70 | unsigned getSourceID() const { return SourceID; } |
Chris Lattner | 25b68c6 | 2010-03-14 08:15:55 +0000 | [diff] [blame] | 71 | MCSymbol *getLabel() const { return Label; } |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 72 | }; |
| 73 | |
Chris Lattner | d38fee8 | 2010-04-05 00:13:49 +0000 | [diff] [blame] | 74 | class DwarfDebug { |
| 75 | /// Asm - Target of Dwarf emission. |
| 76 | AsmPrinter *Asm; |
Chris Lattner | 105d697 | 2010-04-05 05:31:04 +0000 | [diff] [blame] | 77 | |
Chris Lattner | d38fee8 | 2010-04-05 00:13:49 +0000 | [diff] [blame] | 78 | /// MMI - Collected machine module information. |
| 79 | MachineModuleInfo *MMI; |
| 80 | |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 81 | //===--------------------------------------------------------------------===// |
| 82 | // Attributes used to construct specific Dwarf sections. |
| 83 | // |
| 84 | |
Devang Patel | 163a9f7 | 2010-05-10 22:49:55 +0000 | [diff] [blame] | 85 | CompileUnit *FirstCU; |
| 86 | DenseMap <const MDNode *, CompileUnit *> CUMap; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 87 | |
| 88 | /// AbbreviationsSet - Used to uniquely define abbreviations. |
| 89 | /// |
| 90 | FoldingSet<DIEAbbrev> AbbreviationsSet; |
| 91 | |
| 92 | /// Abbreviations - A list of all the unique abbreviations in use. |
| 93 | /// |
| 94 | std::vector<DIEAbbrev *> Abbreviations; |
| 95 | |
| 96 | /// DirectoryIdMap - Directory name to directory id map. |
| 97 | /// |
| 98 | StringMap<unsigned> DirectoryIdMap; |
| 99 | |
| 100 | /// DirectoryNames - A list of directory names. |
| 101 | SmallVector<std::string, 8> DirectoryNames; |
| 102 | |
| 103 | /// SourceFileIdMap - Source file name to source file id map. |
| 104 | /// |
| 105 | StringMap<unsigned> SourceFileIdMap; |
| 106 | |
| 107 | /// SourceFileNames - A list of source file names. |
| 108 | SmallVector<std::string, 8> SourceFileNames; |
| 109 | |
| 110 | /// SourceIdMap - Source id map, i.e. pair of directory id and source file |
| 111 | /// id mapped to a unique id. |
| 112 | DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap; |
| 113 | |
| 114 | /// SourceIds - Reverse map from source id to directory id + file id pair. |
| 115 | /// |
| 116 | SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds; |
| 117 | |
Dan Gohman | f451cb8 | 2010-02-10 16:03:48 +0000 | [diff] [blame] | 118 | /// Lines - List of source line correspondence. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 119 | std::vector<SrcLineInfo> Lines; |
| 120 | |
Benjamin Kramer | 345ef34 | 2010-03-31 19:34:01 +0000 | [diff] [blame] | 121 | /// DIEBlocks - A list of all the DIEBlocks in use. |
| 122 | std::vector<DIEBlock *> DIEBlocks; |
| 123 | |
| 124 | // DIEValueAllocator - All DIEValues are allocated through this allocator. |
| 125 | BumpPtrAllocator DIEValueAllocator; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 126 | |
Chris Lattner | bc733f5 | 2010-03-13 02:17:42 +0000 | [diff] [blame] | 127 | /// StringPool - A String->Symbol mapping of strings used by indirect |
| 128 | /// references. |
| 129 | StringMap<std::pair<MCSymbol*, unsigned> > StringPool; |
| 130 | unsigned NextStringPoolNumber; |
| 131 | |
| 132 | MCSymbol *getStringPoolEntry(StringRef Str); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 133 | |
| 134 | /// SectionMap - Provides a unique id per text section. |
| 135 | /// |
Chris Lattner | a87dea4 | 2009-07-31 18:48:30 +0000 | [diff] [blame] | 136 | UniqueVector<const MCSection*> SectionMap; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 137 | |
| 138 | /// SectionSourceLines - Tracks line numbers per text section. |
| 139 | /// |
| 140 | std::vector<std::vector<SrcLineInfo> > SectionSourceLines; |
| 141 | |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 142 | // CurrentFnDbgScope - Top level scope for the current function. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 143 | // |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 144 | DbgScope *CurrentFnDbgScope; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 145 | |
Jeffrey Yasskin | 5c213dc | 2010-03-12 17:45:06 +0000 | [diff] [blame] | 146 | /// DbgScopeMap - Tracks the scopes in the current function. Owns the |
| 147 | /// contained DbgScope*s. |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 148 | /// |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 149 | DenseMap<const MDNode *, DbgScope *> DbgScopeMap; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 150 | |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 151 | /// ConcreteScopes - Tracks the concrete scopees in the current function. |
| 152 | /// These scopes are also included in DbgScopeMap. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 153 | DenseMap<const MDNode *, DbgScope *> ConcreteScopes; |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 154 | |
| 155 | /// AbstractScopes - Tracks the abstract scopes a module. These scopes are |
Jeffrey Yasskin | 5c213dc | 2010-03-12 17:45:06 +0000 | [diff] [blame] | 156 | /// not included DbgScopeMap. AbstractScopes owns its DbgScope*s. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 157 | DenseMap<const MDNode *, DbgScope *> AbstractScopes; |
Devang Patel | 2ddefec | 2010-03-25 15:09:44 +0000 | [diff] [blame] | 158 | |
| 159 | /// AbstractScopesList - Tracks abstract scopes constructed while processing |
| 160 | /// a function. This list is cleared during endFunction(). |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 161 | SmallVector<DbgScope *, 4>AbstractScopesList; |
| 162 | |
Jeffrey Yasskin | 5c213dc | 2010-03-12 17:45:06 +0000 | [diff] [blame] | 163 | /// AbstractVariables - Collection on abstract variables. Owned by the |
| 164 | /// DbgScopes in AbstractScopes. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 165 | DenseMap<const MDNode *, DbgVariable *> AbstractVariables; |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 166 | |
Devang Patel | 26c1e56 | 2010-05-20 16:36:41 +0000 | [diff] [blame] | 167 | /// DbgVariableToFrameIndexMap - Tracks frame index used to find |
| 168 | /// variable's value. |
| 169 | DenseMap<const DbgVariable *, int> DbgVariableToFrameIndexMap; |
| 170 | |
| 171 | /// DbgVariableToDbgInstMap - Maps DbgVariable to corresponding DBG_VALUE |
| 172 | /// machine instruction. |
| 173 | DenseMap<const DbgVariable *, const MachineInstr *> DbgVariableToDbgInstMap; |
| 174 | |
| 175 | /// DbgVariableLabelsMap - Maps DbgVariable to corresponding MCSymbol. |
| 176 | DenseMap<const DbgVariable *, const MCSymbol *> DbgVariableLabelsMap; |
| 177 | |
Devang Patel | c3f5f78 | 2010-05-25 23:40:22 +0000 | [diff] [blame] | 178 | /// DotDebugLocEntry - This struct describes location entries emitted in |
| 179 | /// .debug_loc section. |
| 180 | typedef struct DotDebugLocEntry { |
| 181 | const MCSymbol *Begin; |
| 182 | const MCSymbol *End; |
| 183 | MachineLocation Loc; |
| 184 | DotDebugLocEntry() : Begin(0), End(0) {} |
| 185 | DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, |
| 186 | MachineLocation &L) : Begin(B), End(E), Loc(L) {} |
| 187 | /// Empty entries are also used as a trigger to emit temp label. Such |
| 188 | /// labels are referenced is used to find debug_loc offset for a given DIE. |
| 189 | bool isEmpty() { return Begin == 0 && End == 0; } |
| 190 | } DotDebugLocEntry; |
| 191 | |
| 192 | /// DotDebugLocEntries - Collection of DotDebugLocEntry. |
| 193 | SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries; |
| 194 | |
| 195 | /// UseDotDebugLocEntry - DW_AT_location attributes for the DIEs in this set |
| 196 | /// idetifies corresponding .debug_loc entry offset. |
| 197 | SmallPtrSet<const DIE *, 4> UseDotDebugLocEntry; |
| 198 | |
Devang Patel | 26c1e56 | 2010-05-20 16:36:41 +0000 | [diff] [blame] | 199 | /// VarToAbstractVarMap - Maps DbgVariable with corresponding Abstract |
| 200 | /// DbgVariable, if any. |
| 201 | DenseMap<const DbgVariable *, const DbgVariable *> VarToAbstractVarMap; |
| 202 | |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 203 | /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked |
| 204 | /// (at the end of the module) as DW_AT_inline. |
| 205 | SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs; |
| 206 | |
Devang Patel | f8a2e01 | 2010-04-15 00:02:49 +0000 | [diff] [blame] | 207 | /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that |
| 208 | /// need DW_AT_containing_type attribute. This attribute points to a DIE that |
| 209 | /// corresponds to the MDNode mapped with the subprogram DIE. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 210 | DenseMap<DIE *, const MDNode *> ContainingTypeMap; |
Devang Patel | 5d11eb0 | 2009-12-03 19:11:07 +0000 | [diff] [blame] | 211 | |
Devang Patel | 461a646 | 2010-05-19 21:58:28 +0000 | [diff] [blame] | 212 | typedef SmallVector<DbgScope *, 2> ScopeVector; |
| 213 | SmallPtrSet<const MachineInstr *, 8> InsnsBeginScopeSet; |
Devang Patel | 1c24635 | 2010-04-08 16:50:29 +0000 | [diff] [blame] | 214 | SmallPtrSet<const MachineInstr *, 8> InsnsEndScopeSet; |
Devang Patel | af9e847 | 2009-10-01 20:31:14 +0000 | [diff] [blame] | 215 | |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 216 | /// InlineInfo - Keep track of inlined functions and their location. This |
| 217 | /// information is used to populate debug_inlined section. |
Devang Patel | c3f5f78 | 2010-05-25 23:40:22 +0000 | [diff] [blame] | 218 | typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels; |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 219 | DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo; |
| 220 | SmallVector<const MDNode *, 4> InlinedSPNodes; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 221 | |
Devang Patel | eac9c07 | 2010-04-27 19:46:33 +0000 | [diff] [blame] | 222 | /// LabelsBeforeInsn - Maps instruction with label emitted before |
Devang Patel | 1c24635 | 2010-04-08 16:50:29 +0000 | [diff] [blame] | 223 | /// instruction. |
Devang Patel | eac9c07 | 2010-04-27 19:46:33 +0000 | [diff] [blame] | 224 | DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn; |
Devang Patel | 1c24635 | 2010-04-08 16:50:29 +0000 | [diff] [blame] | 225 | |
Devang Patel | eac9c07 | 2010-04-27 19:46:33 +0000 | [diff] [blame] | 226 | /// LabelsAfterInsn - Maps instruction with label emitted after |
Devang Patel | 1c24635 | 2010-04-08 16:50:29 +0000 | [diff] [blame] | 227 | /// instruction. |
Devang Patel | eac9c07 | 2010-04-27 19:46:33 +0000 | [diff] [blame] | 228 | DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn; |
Devang Patel | 1c24635 | 2010-04-08 16:50:29 +0000 | [diff] [blame] | 229 | |
Devang Patel | b2b31a6 | 2010-05-26 19:37:24 +0000 | [diff] [blame] | 230 | /// insnNeedsLabel - Collection of instructions that need a label to mark |
| 231 | /// a debuggging information entity. |
| 232 | SmallPtrSet<const MachineInstr *, 8> InsnNeedsLabel; |
| 233 | |
Devang Patel | f2548ca | 2010-04-16 23:33:45 +0000 | [diff] [blame] | 234 | SmallVector<const MCSymbol *, 8> DebugRangeSymbols; |
Devang Patel | c04d545 | 2010-04-22 20:56:35 +0000 | [diff] [blame] | 235 | |
Devang Patel | 553881b | 2010-03-29 17:20:31 +0000 | [diff] [blame] | 236 | /// Previous instruction's location information. This is used to determine |
| 237 | /// label location to indicate scope boundries in dwarf debug info. |
Chris Lattner | de4845c | 2010-04-02 19:42:39 +0000 | [diff] [blame] | 238 | DebugLoc PrevInstLoc; |
Devang Patel | f2548ca | 2010-04-16 23:33:45 +0000 | [diff] [blame] | 239 | MCSymbol *PrevLabel; |
Devang Patel | 553881b | 2010-03-29 17:20:31 +0000 | [diff] [blame] | 240 | |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 241 | struct FunctionDebugFrameInfo { |
| 242 | unsigned Number; |
| 243 | std::vector<MachineMove> Moves; |
| 244 | |
| 245 | FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M) |
| 246 | : Number(Num), Moves(M) {} |
| 247 | }; |
| 248 | |
| 249 | std::vector<FunctionDebugFrameInfo> DebugFrames; |
| 250 | |
Chris Lattner | 9c69e28553 | 2010-04-04 22:59:04 +0000 | [diff] [blame] | 251 | // Section Symbols: these are assembler temporary labels that are emitted at |
| 252 | // the beginning of each supported dwarf section. These are used to form |
| 253 | // section offsets and are created by EmitSectionLabels. |
| 254 | MCSymbol *DwarfFrameSectionSym, *DwarfInfoSectionSym, *DwarfAbbrevSectionSym; |
Devang Patel | f2548ca | 2010-04-16 23:33:45 +0000 | [diff] [blame] | 255 | MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym; |
Devang Patel | c3f5f78 | 2010-05-25 23:40:22 +0000 | [diff] [blame] | 256 | MCSymbol *DwarfDebugLocSectionSym; |
| 257 | MCSymbol *FunctionBeginSym, *FunctionEndSym; |
Chris Lattner | 9c69e28553 | 2010-04-04 22:59:04 +0000 | [diff] [blame] | 258 | private: |
| 259 | |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 260 | /// getSourceDirectoryAndFileIds - Return the directory and file ids that |
| 261 | /// maps to the source id. Source id starts at 1. |
| 262 | std::pair<unsigned, unsigned> |
| 263 | getSourceDirectoryAndFileIds(unsigned SId) const { |
| 264 | return SourceIds[SId-1]; |
| 265 | } |
| 266 | |
| 267 | /// getNumSourceDirectories - Return the number of source directories in the |
| 268 | /// debug info. |
| 269 | unsigned getNumSourceDirectories() const { |
| 270 | return DirectoryNames.size(); |
| 271 | } |
| 272 | |
| 273 | /// getSourceDirectoryName - Return the name of the directory corresponding |
| 274 | /// to the id. |
| 275 | const std::string &getSourceDirectoryName(unsigned Id) const { |
| 276 | return DirectoryNames[Id - 1]; |
| 277 | } |
| 278 | |
| 279 | /// getSourceFileName - Return the name of the source file corresponding |
| 280 | /// to the id. |
| 281 | const std::string &getSourceFileName(unsigned Id) const { |
| 282 | return SourceFileNames[Id - 1]; |
| 283 | } |
| 284 | |
| 285 | /// getNumSourceIds - Return the number of unique source ids. |
| 286 | unsigned getNumSourceIds() const { |
| 287 | return SourceIds.size(); |
| 288 | } |
| 289 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 290 | /// assignAbbrevNumber - Define a unique number for the abbreviation. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 291 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 292 | void assignAbbrevNumber(DIEAbbrev &Abbrev); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 293 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 294 | /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug |
Bill Wendling | 995f80a | 2009-05-20 23:24:48 +0000 | [diff] [blame] | 295 | /// information entry. |
Jeffrey Yasskin | 5c213dc | 2010-03-12 17:45:06 +0000 | [diff] [blame] | 296 | DIEEntry *createDIEEntry(DIE *Entry); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 297 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 298 | /// addUInt - Add an unsigned integer attribute data and value. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 299 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 300 | void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 301 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 302 | /// addSInt - Add an signed integer attribute data and value. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 303 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 304 | void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 305 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 306 | /// addString - Add a string attribute data and value. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 307 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 308 | void addString(DIE *Die, unsigned Attribute, unsigned Form, |
Devang Patel | e9a0597 | 2009-11-24 19:42:17 +0000 | [diff] [blame] | 309 | const StringRef Str); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 310 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 311 | /// addLabel - Add a Dwarf label attribute data and value. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 312 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 313 | void addLabel(DIE *Die, unsigned Attribute, unsigned Form, |
Chris Lattner | b98b1bf | 2010-03-08 22:23:36 +0000 | [diff] [blame] | 314 | const MCSymbol *Label); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 315 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 316 | /// addDelta - Add a label delta attribute data and value. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 317 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 318 | void addDelta(DIE *Die, unsigned Attribute, unsigned Form, |
Chris Lattner | b98b1bf | 2010-03-08 22:23:36 +0000 | [diff] [blame] | 319 | const MCSymbol *Hi, const MCSymbol *Lo); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 320 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 321 | /// addDIEEntry - Add a DIE attribute data and value. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 322 | /// |
Chris Lattner | 74e41f9 | 2010-04-05 05:24:55 +0000 | [diff] [blame] | 323 | void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry); |
| 324 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 325 | /// addBlock - Add block data. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 326 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 327 | void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 328 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 329 | /// addSourceLine - Add location information to specified debug information |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 330 | /// entry. |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 331 | void addSourceLine(DIE *Die, const DIVariable *V); |
Devang Patel | a49d877 | 2010-05-07 23:19:07 +0000 | [diff] [blame] | 332 | void addSourceLine(DIE *Die, const DIGlobalVariable *G); |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 333 | void addSourceLine(DIE *Die, const DISubprogram *SP); |
| 334 | void addSourceLine(DIE *Die, const DIType *Ty); |
Devang Patel | 6404e4e | 2009-12-15 19:16:48 +0000 | [diff] [blame] | 335 | void addSourceLine(DIE *Die, const DINameSpace *NS); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 336 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 337 | /// addAddress - Add an address attribute to a die based on the location |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 338 | /// provided. |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 339 | void addAddress(DIE *Die, unsigned Attribute, |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 340 | const MachineLocation &Location); |
| 341 | |
Devang Patel | a43098d | 2010-04-28 01:03:09 +0000 | [diff] [blame] | 342 | /// addRegisterAddress - Add register location entry in variable DIE. |
Devang Patel | 26c1e56 | 2010-05-20 16:36:41 +0000 | [diff] [blame] | 343 | bool addRegisterAddress(DIE *Die, const MCSymbol *VS, const MachineOperand &MO); |
Devang Patel | a43098d | 2010-04-28 01:03:09 +0000 | [diff] [blame] | 344 | |
| 345 | /// addConstantValue - Add constant value entry in variable DIE. |
Devang Patel | 26c1e56 | 2010-05-20 16:36:41 +0000 | [diff] [blame] | 346 | bool addConstantValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO); |
Devang Patel | a43098d | 2010-04-28 01:03:09 +0000 | [diff] [blame] | 347 | |
| 348 | /// addConstantFPValue - Add constant value entry in variable DIE. |
Devang Patel | 26c1e56 | 2010-05-20 16:36:41 +0000 | [diff] [blame] | 349 | bool addConstantFPValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO); |
Devang Patel | a43098d | 2010-04-28 01:03:09 +0000 | [diff] [blame] | 350 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 351 | /// addComplexAddress - Start with the address based on the location provided, |
Mike Stump | 3e4c9bd | 2009-09-30 00:08:22 +0000 | [diff] [blame] | 352 | /// and generate the DWARF information necessary to find the actual variable |
| 353 | /// (navigating the extra location information encoded in the type) based on |
| 354 | /// the starting location. Add the DWARF information to the die. |
| 355 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 356 | void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute, |
Mike Stump | 3e4c9bd | 2009-09-30 00:08:22 +0000 | [diff] [blame] | 357 | const MachineLocation &Location); |
| 358 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 359 | // FIXME: Should be reformulated in terms of addComplexAddress. |
| 360 | /// addBlockByrefAddress - Start with the address based on the location |
Caroline Tice | dc8f604 | 2009-08-31 21:19:37 +0000 | [diff] [blame] | 361 | /// provided, and generate the DWARF information necessary to find the |
| 362 | /// actual Block variable (navigating the Block struct) based on the |
Mike Stump | 3e4c9bd | 2009-09-30 00:08:22 +0000 | [diff] [blame] | 363 | /// starting location. Add the DWARF information to the die. Obsolete, |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 364 | /// please use addComplexAddress instead. |
Caroline Tice | dc8f604 | 2009-08-31 21:19:37 +0000 | [diff] [blame] | 365 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 366 | void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute, |
Caroline Tice | dc8f604 | 2009-08-31 21:19:37 +0000 | [diff] [blame] | 367 | const MachineLocation &Location); |
| 368 | |
Devang Patel | c366f83 | 2009-12-10 19:14:49 +0000 | [diff] [blame] | 369 | /// addToContextOwner - Add Die into the list of its context owner's children. |
| 370 | void addToContextOwner(DIE *Die, DIDescriptor Context); |
| 371 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 372 | /// addType - Add a new type attribute to the specified entity. |
Devang Patel | 8a24114 | 2009-12-09 18:24:21 +0000 | [diff] [blame] | 373 | void addType(DIE *Entity, DIType Ty); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 374 | |
Devang Patel | 6404e4e | 2009-12-15 19:16:48 +0000 | [diff] [blame] | 375 | |
| 376 | /// getOrCreateNameSpace - Create a DIE for DINameSpace. |
| 377 | DIE *getOrCreateNameSpace(DINameSpace NS); |
| 378 | |
Devang Patel | 16ced73 | 2009-12-10 18:05:33 +0000 | [diff] [blame] | 379 | /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the |
| 380 | /// given DIType. |
| 381 | DIE *getOrCreateTypeDIE(DIType Ty); |
| 382 | |
Devang Patel | 193f720 | 2009-11-24 01:14:22 +0000 | [diff] [blame] | 383 | void addPubTypes(DISubprogram SP); |
| 384 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 385 | /// constructTypeDIE - Construct basic type die from DIBasicType. |
Devang Patel | 8a24114 | 2009-12-09 18:24:21 +0000 | [diff] [blame] | 386 | void constructTypeDIE(DIE &Buffer, |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 387 | DIBasicType BTy); |
| 388 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 389 | /// constructTypeDIE - Construct derived type die from DIDerivedType. |
Devang Patel | 8a24114 | 2009-12-09 18:24:21 +0000 | [diff] [blame] | 390 | void constructTypeDIE(DIE &Buffer, |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 391 | DIDerivedType DTy); |
| 392 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 393 | /// constructTypeDIE - Construct type DIE from DICompositeType. |
Devang Patel | 8a24114 | 2009-12-09 18:24:21 +0000 | [diff] [blame] | 394 | void constructTypeDIE(DIE &Buffer, |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 395 | DICompositeType CTy); |
| 396 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 397 | /// constructSubrangeDIE - Construct subrange DIE from DISubrange. |
| 398 | void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 399 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 400 | /// constructArrayTypeDIE - Construct array type DIE from DICompositeType. |
Devang Patel | 8a24114 | 2009-12-09 18:24:21 +0000 | [diff] [blame] | 401 | void constructArrayTypeDIE(DIE &Buffer, |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 402 | DICompositeType *CTy); |
| 403 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 404 | /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator. |
Devang Patel | 3c91b05 | 2010-03-08 20:52:55 +0000 | [diff] [blame] | 405 | DIE *constructEnumTypeDIE(DIEnumerator ETy); |
Devang Patel | 4063f6b | 2009-12-07 21:41:32 +0000 | [diff] [blame] | 406 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 407 | /// createGlobalVariableDIE - Create new DIE using GV. |
Devang Patel | 8a24114 | 2009-12-09 18:24:21 +0000 | [diff] [blame] | 408 | DIE *createGlobalVariableDIE(const DIGlobalVariable &GV); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 409 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 410 | /// createMemberDIE - Create new member DIE. |
Devang Patel | 8a24114 | 2009-12-09 18:24:21 +0000 | [diff] [blame] | 411 | DIE *createMemberDIE(const DIDerivedType &DT); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 412 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 413 | /// createSubprogramDIE - Create new DIE using SP. |
Devang Patel | ffe966c | 2009-12-14 16:18:45 +0000 | [diff] [blame] | 414 | DIE *createSubprogramDIE(const DISubprogram &SP, bool MakeDecl = false); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 415 | |
Devang Patel | eac9c07 | 2010-04-27 19:46:33 +0000 | [diff] [blame] | 416 | /// getOrCreateDbgScope - Create DbgScope for the scope. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 417 | DbgScope *getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt); |
Devang Patel | 70d75ca | 2009-11-12 19:02:56 +0000 | [diff] [blame] | 418 | |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 419 | DbgScope *getOrCreateAbstractScope(const MDNode *N); |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 420 | |
| 421 | /// findAbstractVariable - Find abstract variable associated with Var. |
Devang Patel | 26c1e56 | 2010-05-20 16:36:41 +0000 | [diff] [blame] | 422 | DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc); |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 423 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 424 | /// updateSubprogramScopeDIE - Find DIE for the given subprogram and |
| 425 | /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes. |
| 426 | /// If there are global variables in this scope then create and insert |
| 427 | /// DIEs for these variables. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 428 | DIE *updateSubprogramScopeDIE(const MDNode *SPNode); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 429 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 430 | /// constructLexicalScope - Construct new DW_TAG_lexical_block |
| 431 | /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels. |
| 432 | DIE *constructLexicalScopeDIE(DbgScope *Scope); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 433 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 434 | /// constructInlinedScopeDIE - This scope represents inlined body of |
| 435 | /// a function. Construct DIE to represent this concrete inlined copy |
| 436 | /// of the function. |
| 437 | DIE *constructInlinedScopeDIE(DbgScope *Scope); |
| 438 | |
| 439 | /// constructVariableDIE - Construct a DIE for the given DbgVariable. |
Devang Patel | 8a24114 | 2009-12-09 18:24:21 +0000 | [diff] [blame] | 440 | DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S); |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 441 | |
| 442 | /// constructScopeDIE - Construct a DIE for this scope. |
| 443 | DIE *constructScopeDIE(DbgScope *Scope); |
| 444 | |
Chris Lattner | fa070b0 | 2010-04-04 22:33:59 +0000 | [diff] [blame] | 445 | /// EmitSectionLabels - Emit initial Dwarf sections with a label at |
| 446 | /// the start of each one. |
| 447 | void EmitSectionLabels(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 448 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 449 | /// emitDIE - Recusively Emits a debug information entry. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 450 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 451 | void emitDIE(DIE *Die); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 452 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 453 | /// computeSizeAndOffset - Compute the size and offset of a DIE. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 454 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 455 | unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 456 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 457 | /// computeSizeAndOffsets - Compute the size and offset of all the DIEs. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 458 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 459 | void computeSizeAndOffsets(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 460 | |
Devang Patel | 8a24114 | 2009-12-09 18:24:21 +0000 | [diff] [blame] | 461 | /// EmitDebugInfo - Emit the debug info section. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 462 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 463 | void emitDebugInfo(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 464 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 465 | /// emitAbbreviations - Emit the abbreviation section. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 466 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 467 | void emitAbbreviations() const; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 468 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 469 | /// emitEndOfLineMatrix - Emit the last address of the section and the end of |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 470 | /// the line matrix. |
| 471 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 472 | void emitEndOfLineMatrix(unsigned SectionEnd); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 473 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 474 | /// emitDebugLines - Emit source line information. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 475 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 476 | void emitDebugLines(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 477 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 478 | /// emitCommonDebugFrame - Emit common frame info into a debug frame section. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 479 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 480 | void emitCommonDebugFrame(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 481 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 482 | /// emitFunctionDebugFrame - Emit per function frame info into a debug frame |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 483 | /// section. |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 484 | void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 485 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 486 | /// emitDebugPubNames - Emit visible names into a debug pubnames section. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 487 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 488 | void emitDebugPubNames(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 489 | |
Devang Patel | 193f720 | 2009-11-24 01:14:22 +0000 | [diff] [blame] | 490 | /// emitDebugPubTypes - Emit visible types into a debug pubtypes section. |
| 491 | /// |
| 492 | void emitDebugPubTypes(); |
| 493 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 494 | /// emitDebugStr - Emit visible names into a debug str section. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 495 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 496 | void emitDebugStr(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 497 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 498 | /// emitDebugLoc - Emit visible names into a debug loc section. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 499 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 500 | void emitDebugLoc(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 501 | |
| 502 | /// EmitDebugARanges - Emit visible names into a debug aranges section. |
| 503 | /// |
| 504 | void EmitDebugARanges(); |
| 505 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 506 | /// emitDebugRanges - Emit visible names into a debug ranges section. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 507 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 508 | void emitDebugRanges(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 509 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 510 | /// emitDebugMacInfo - Emit visible names into a debug macinfo section. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 511 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 512 | void emitDebugMacInfo(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 513 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 514 | /// emitDebugInlineInfo - Emit inline info using following format. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 515 | /// Section Header: |
| 516 | /// 1. length of section |
| 517 | /// 2. Dwarf version number |
| 518 | /// 3. address size. |
| 519 | /// |
| 520 | /// Entries (one "entry" for each function that was inlined): |
| 521 | /// |
| 522 | /// 1. offset into __debug_str section for MIPS linkage name, if exists; |
| 523 | /// otherwise offset into __debug_str for regular function name. |
| 524 | /// 2. offset into __debug_str section for regular function name. |
| 525 | /// 3. an unsigned LEB128 number indicating the number of distinct inlining |
| 526 | /// instances for the function. |
| 527 | /// |
| 528 | /// The rest of the entry consists of a {die_offset, low_pc} pair for each |
| 529 | /// inlined instance; the die_offset points to the inlined_subroutine die in |
| 530 | /// the __debug_info section, and the low_pc is the starting address for the |
| 531 | /// inlining instance. |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 532 | void emitDebugInlineInfo(); |
Bill Wendling | f0fb987 | 2009-05-20 23:19:06 +0000 | [diff] [blame] | 533 | |
| 534 | /// GetOrCreateSourceID - Look up the source id with the given directory and |
| 535 | /// source file names. If none currently exists, create a new id and insert it |
Chris Lattner | 75f5072 | 2010-04-04 07:48:20 +0000 | [diff] [blame] | 536 | /// in the SourceIds map. This can update DirectoryNames and SourceFileNames |
| 537 | /// maps as well. |
Devang Patel | 65dbc90 | 2009-11-25 17:36:49 +0000 | [diff] [blame] | 538 | unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName); |
Bill Wendling | f0fb987 | 2009-05-20 23:19:06 +0000 | [diff] [blame] | 539 | |
Devang Patel | 163a9f7 | 2010-05-10 22:49:55 +0000 | [diff] [blame] | 540 | /// constructCompileUnit - Create new CompileUnit for the given |
| 541 | /// metadata node with tag DW_TAG_compile_unit. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 542 | void constructCompileUnit(const MDNode *N); |
Bill Wendling | f0fb987 | 2009-05-20 23:19:06 +0000 | [diff] [blame] | 543 | |
Devang Patel | 163a9f7 | 2010-05-10 22:49:55 +0000 | [diff] [blame] | 544 | /// getCompielUnit - Get CompileUnit DIE. |
| 545 | CompileUnit *getCompileUnit(const MDNode *N) const; |
| 546 | |
| 547 | /// constructGlobalVariableDIE - Construct global variable DIE. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 548 | void constructGlobalVariableDIE(const MDNode *N); |
Bill Wendling | f0fb987 | 2009-05-20 23:19:06 +0000 | [diff] [blame] | 549 | |
Devang Patel | 163a9f7 | 2010-05-10 22:49:55 +0000 | [diff] [blame] | 550 | /// construct SubprogramDIE - Construct subprogram DIE. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 551 | void constructSubprogramDIE(const MDNode *N); |
Bill Wendling | f0fb987 | 2009-05-20 23:19:06 +0000 | [diff] [blame] | 552 | |
Mike Stump | 3e4c9bd | 2009-09-30 00:08:22 +0000 | [diff] [blame] | 553 | // FIXME: This should go away in favor of complex addresses. |
Caroline Tice | dc8f604 | 2009-08-31 21:19:37 +0000 | [diff] [blame] | 554 | /// Find the type the programmer originally declared the variable to be |
Mike Stump | 3e4c9bd | 2009-09-30 00:08:22 +0000 | [diff] [blame] | 555 | /// and return that type. Obsolete, use GetComplexAddrType instead. |
Caroline Tice | dc8f604 | 2009-08-31 21:19:37 +0000 | [diff] [blame] | 556 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 557 | DIType getBlockByrefType(DIType Ty, std::string Name); |
Caroline Tice | dc8f604 | 2009-08-31 21:19:37 +0000 | [diff] [blame] | 558 | |
Chris Lattner | 2b1b331 | 2010-04-05 05:32:45 +0000 | [diff] [blame] | 559 | /// recordSourceLine - Register a source line with debug info. Returns the |
| 560 | /// unique label that was emitted and which provides correspondence to |
| 561 | /// the source line list. |
Devang Patel | e9f8f5e | 2010-05-07 20:54:48 +0000 | [diff] [blame] | 562 | MCSymbol *recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope); |
Chris Lattner | 2b1b331 | 2010-04-05 05:32:45 +0000 | [diff] [blame] | 563 | |
| 564 | /// getSourceLineCount - Return the number of source lines in the debug |
| 565 | /// info. |
| 566 | unsigned getSourceLineCount() const { |
| 567 | return Lines.size(); |
| 568 | } |
| 569 | |
Devang Patel | 26c1e56 | 2010-05-20 16:36:41 +0000 | [diff] [blame] | 570 | /// recordVariableFrameIndex - Record a variable's index. |
| 571 | void recordVariableFrameIndex(const DbgVariable *V, int Index); |
| 572 | |
| 573 | /// findVariableFrameIndex - Return true if frame index for the variable |
| 574 | /// is found. Update FI to hold value of the index. |
| 575 | bool findVariableFrameIndex(const DbgVariable *V, int *FI); |
| 576 | |
| 577 | /// findVariableLabel - Find MCSymbol for the variable. |
| 578 | const MCSymbol *findVariableLabel(const DbgVariable *V); |
| 579 | |
Devang Patel | ee43286 | 2010-05-20 19:57:06 +0000 | [diff] [blame] | 580 | /// findDbgScope - Find DbgScope for the debug loc attached with an |
| 581 | /// instruction. |
| 582 | DbgScope *findDbgScope(const MachineInstr *MI); |
| 583 | |
Devang Patel | e37b0c6 | 2010-04-08 18:43:56 +0000 | [diff] [blame] | 584 | /// identifyScopeMarkers() - Indentify instructions that are marking |
| 585 | /// beginning of or end of a scope. |
| 586 | void identifyScopeMarkers(); |
Devang Patel | 6122a4d | 2010-04-08 15:37:09 +0000 | [diff] [blame] | 587 | |
Chris Lattner | 2b1b331 | 2010-04-05 05:32:45 +0000 | [diff] [blame] | 588 | /// extractScopeInformation - Scan machine instructions in this function |
| 589 | /// and collect DbgScopes. Return true, if atleast one scope was found. |
| 590 | bool extractScopeInformation(); |
| 591 | |
| 592 | /// collectVariableInfo - Populate DbgScope entries with variables' info. |
Devang Patel | 78e127d | 2010-06-25 22:07:34 +0000 | [diff] [blame^] | 593 | void collectVariableInfo(const MachineFunction *, |
| 594 | SmallPtrSet<const MDNode *, 16> &ProcessedVars); |
Chris Lattner | 2b1b331 | 2010-04-05 05:32:45 +0000 | [diff] [blame] | 595 | |
Devang Patel | ee43286 | 2010-05-20 19:57:06 +0000 | [diff] [blame] | 596 | /// collectVariableInfoFromMMITable - Collect variable information from |
| 597 | /// side table maintained by MMI. |
| 598 | void collectVariableInfoFromMMITable(const MachineFunction * MF, |
| 599 | SmallPtrSet<const MDNode *, 16> &P); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 600 | public: |
| 601 | //===--------------------------------------------------------------------===// |
| 602 | // Main entry points. |
| 603 | // |
Chris Lattner | 49cd664 | 2010-04-05 05:11:15 +0000 | [diff] [blame] | 604 | DwarfDebug(AsmPrinter *A, Module *M); |
Chris Lattner | 2b1b331 | 2010-04-05 05:32:45 +0000 | [diff] [blame] | 605 | ~DwarfDebug(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 606 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 607 | /// beginModule - Emit all Dwarf sections that should come prior to the |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 608 | /// content. |
Chris Lattner | 75f5072 | 2010-04-04 07:48:20 +0000 | [diff] [blame] | 609 | void beginModule(Module *M); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 610 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 611 | /// endModule - Emit all Dwarf sections that should come after the content. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 612 | /// |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 613 | void endModule(); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 614 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 615 | /// beginFunction - Gather pre-function debug information. Assumes being |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 616 | /// emitted immediately after the function entry point. |
Chris Lattner | eec791a | 2010-01-26 23:18:02 +0000 | [diff] [blame] | 617 | void beginFunction(const MachineFunction *MF); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 618 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 619 | /// endFunction - Gather and emit post-function debug information. |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 620 | /// |
Chris Lattner | eec791a | 2010-01-26 23:18:02 +0000 | [diff] [blame] | 621 | void endFunction(const MachineFunction *MF); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 622 | |
Devang Patel | c3f5f78 | 2010-05-25 23:40:22 +0000 | [diff] [blame] | 623 | /// getLabelBeforeInsn - Return Label preceding the instruction. |
| 624 | const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI); |
| 625 | |
| 626 | /// getLabelAfterInsn - Return Label immediately following the instruction. |
| 627 | const MCSymbol *getLabelAfterInsn(const MachineInstr *MI); |
| 628 | |
Devang Patel | 553881b | 2010-03-29 17:20:31 +0000 | [diff] [blame] | 629 | /// beginScope - Process beginning of a scope. |
| 630 | void beginScope(const MachineInstr *MI); |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 631 | |
Devang Patel | 2c4ceb1 | 2009-11-21 02:48:08 +0000 | [diff] [blame] | 632 | /// endScope - Prcess end of a scope. |
| 633 | void endScope(const MachineInstr *MI); |
Devang Patel | 53bb5c9 | 2009-11-10 23:06:00 +0000 | [diff] [blame] | 634 | }; |
Bill Wendling | 0310d76 | 2009-05-15 09:23:25 +0000 | [diff] [blame] | 635 | } // End of namespace llvm |
| 636 | |
| 637 | #endif |